1 /*
2 * Copyright (c) 2012, 2019, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 */
23
24
25 package org.graalvm.compiler.hotspot.amd64;
26
27 import static jdk.vm.ci.common.InitTimer.timer;
28
29 import java.util.ArrayList;
30 import java.util.List;
31
32 import org.graalvm.compiler.bytecode.BytecodeProvider;
33 import org.graalvm.compiler.core.common.spi.ConstantFieldProvider;
34 import org.graalvm.compiler.hotspot.GraalHotSpotVMConfig;
35 import org.graalvm.compiler.hotspot.HotSpotBackend;
36 import org.graalvm.compiler.hotspot.HotSpotBackendFactory;
37 import org.graalvm.compiler.hotspot.HotSpotGraalRuntimeProvider;
38 import org.graalvm.compiler.hotspot.HotSpotReplacementsImpl;
39 import org.graalvm.compiler.hotspot.meta.AddressLoweringHotSpotSuitesProvider;
40 import org.graalvm.compiler.hotspot.meta.HotSpotForeignCallsProvider;
41 import org.graalvm.compiler.hotspot.meta.HotSpotGCProvider;
42 import org.graalvm.compiler.hotspot.meta.HotSpotGraalConstantFieldProvider;
43 import org.graalvm.compiler.hotspot.meta.HotSpotGraphBuilderPlugins;
44 import org.graalvm.compiler.hotspot.meta.HotSpotHostForeignCallsProvider;
45 import org.graalvm.compiler.hotspot.meta.HotSpotLoweringProvider;
46 import org.graalvm.compiler.hotspot.meta.HotSpotProviders;
47 import org.graalvm.compiler.hotspot.meta.HotSpotRegisters;
48 import org.graalvm.compiler.hotspot.meta.HotSpotRegistersProvider;
49 import org.graalvm.compiler.hotspot.meta.HotSpotSnippetReflectionProvider;
50 import org.graalvm.compiler.hotspot.meta.HotSpotStampProvider;
51 import org.graalvm.compiler.hotspot.meta.HotSpotSuitesProvider;
52 import org.graalvm.compiler.hotspot.word.HotSpotWordTypes;
53 import org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderConfiguration.Plugins;
54 import org.graalvm.compiler.nodes.spi.Replacements;
55 import org.graalvm.compiler.options.OptionValues;
56 import org.graalvm.compiler.phases.common.AddressLoweringPhase;
57 import org.graalvm.compiler.phases.tiers.CompilerConfiguration;
58 import org.graalvm.compiler.phases.util.Providers;
59 import org.graalvm.compiler.replacements.amd64.AMD64GraphBuilderPlugins;
60 import org.graalvm.compiler.serviceprovider.JavaVersionUtil;
61 import org.graalvm.compiler.serviceprovider.ServiceProvider;
62 import org.graalvm.compiler.word.WordTypes;
63
64 import jdk.vm.ci.amd64.AMD64;
65 import jdk.vm.ci.code.Architecture;
66 import jdk.vm.ci.code.Register;
67 import jdk.vm.ci.code.RegisterConfig;
68 import jdk.vm.ci.code.TargetDescription;
69 import jdk.vm.ci.common.InitTimer;
70 import jdk.vm.ci.hotspot.HotSpotCodeCacheProvider;
71 import jdk.vm.ci.hotspot.HotSpotConstantReflectionProvider;
72 import jdk.vm.ci.hotspot.HotSpotJVMCIRuntime;
73 import jdk.vm.ci.hotspot.HotSpotMetaAccessProvider;
74 import jdk.vm.ci.meta.Value;
75 import jdk.vm.ci.runtime.JVMCIBackend;
76
77 @ServiceProvider(HotSpotBackendFactory.class)
78 public class AMD64HotSpotBackendFactory extends HotSpotBackendFactory {
79
80 @Override
81 public String getName() {
82 return "community";
83 }
84
85 @Override
86 public Class<? extends Architecture> getArchitecture() {
87 return AMD64.class;
88 }
89
90 @Override
91 @SuppressWarnings("try")
92 public HotSpotBackend createBackend(HotSpotGraalRuntimeProvider graalRuntime, CompilerConfiguration compilerConfiguration, HotSpotJVMCIRuntime jvmciRuntime, HotSpotBackend host) {
93 assert host == null;
94
95 OptionValues options = graalRuntime.getOptions();
96 JVMCIBackend jvmci = jvmciRuntime.getHostJVMCIBackend();
97 GraalHotSpotVMConfig config = graalRuntime.getVMConfig();
98 HotSpotProviders providers;
99 HotSpotRegistersProvider registers;
100 HotSpotCodeCacheProvider codeCache = (HotSpotCodeCacheProvider) jvmci.getCodeCache();
101 TargetDescription target = codeCache.getTarget();
102 HotSpotHostForeignCallsProvider foreignCalls;
103 Value[] nativeABICallerSaveRegisters;
104 HotSpotMetaAccessProvider metaAccess = (HotSpotMetaAccessProvider) jvmci.getMetaAccess();
105 HotSpotConstantReflectionProvider constantReflection = (HotSpotConstantReflectionProvider) jvmci.getConstantReflection();
106 ConstantFieldProvider constantFieldProvider = new HotSpotGraalConstantFieldProvider(config, metaAccess);
107 HotSpotLoweringProvider lowerer;
108 HotSpotStampProvider stampProvider;
109 HotSpotGCProvider gc;
110 HotSpotSnippetReflectionProvider snippetReflection;
111 HotSpotReplacementsImpl replacements;
112 HotSpotSuitesProvider suites;
113 HotSpotWordTypes wordTypes;
114 Plugins plugins;
115 BytecodeProvider bytecodeProvider;
116 try (InitTimer t = timer("create providers")) {
117 try (InitTimer rt = timer("create HotSpotRegisters provider")) {
118 registers = createRegisters();
119 }
120 try (InitTimer rt = timer("create NativeABICallerSaveRegisters")) {
121 nativeABICallerSaveRegisters = createNativeABICallerSaveRegisters(config, codeCache.getRegisterConfig());
122 }
123 try (InitTimer rt = timer("create WordTypes")) {
124 wordTypes = createWordTypes(metaAccess, target);
125 }
126 try (InitTimer rt = timer("create ForeignCalls provider")) {
127 foreignCalls = createForeignCalls(jvmciRuntime, graalRuntime, metaAccess, codeCache, wordTypes, nativeABICallerSaveRegisters);
128 }
129 try (InitTimer rt = timer("create Lowerer provider")) {
130 lowerer = createLowerer(graalRuntime, metaAccess, foreignCalls, registers, constantReflection, target);
131 }
132 try (InitTimer rt = timer("create stamp provider")) {
133 stampProvider = createStampProvider();
134 }
135 try (InitTimer rt = timer("create GC provider")) {
136 gc = createGCProvider(config);
137 }
138
139 Providers p = new Providers(metaAccess, codeCache, constantReflection, constantFieldProvider, foreignCalls, lowerer, null, stampProvider, gc);
140
141 try (InitTimer rt = timer("create SnippetReflection provider")) {
142 snippetReflection = createSnippetReflection(graalRuntime, constantReflection, wordTypes);
143 }
144 try (InitTimer rt = timer("create Bytecode provider")) {
145 bytecodeProvider = createBytecodeProvider(metaAccess, snippetReflection);
146 }
147 try (InitTimer rt = timer("create Replacements provider")) {
148 replacements = createReplacements(target, p, snippetReflection, bytecodeProvider);
149 }
150 try (InitTimer rt = timer("create GraphBuilderPhase plugins")) {
151 plugins = createGraphBuilderPlugins(compilerConfiguration, config, target, constantReflection, foreignCalls, metaAccess, snippetReflection, replacements, wordTypes, options);
152 replacements.setGraphBuilderPlugins(plugins);
153 }
154 try (InitTimer rt = timer("create Suites provider")) {
155 suites = createSuites(config, graalRuntime, compilerConfiguration, plugins, registers, replacements, options);
156 }
157 providers = new HotSpotProviders(metaAccess, codeCache, constantReflection, constantFieldProvider, foreignCalls, lowerer, replacements, suites, registers,
158 snippetReflection, wordTypes, plugins, gc);
159 replacements.setProviders(providers);
160 }
161 try (InitTimer rt = timer("instantiate backend")) {
162 return createBackend(config, graalRuntime, providers);
163 }
164 }
165
166 protected Plugins createGraphBuilderPlugins(CompilerConfiguration compilerConfiguration, GraalHotSpotVMConfig config, TargetDescription target,
167 HotSpotConstantReflectionProvider constantReflection, HotSpotHostForeignCallsProvider foreignCalls, HotSpotMetaAccessProvider metaAccess,
168 HotSpotSnippetReflectionProvider snippetReflection, HotSpotReplacementsImpl replacements, HotSpotWordTypes wordTypes, OptionValues options) {
169 Plugins plugins = HotSpotGraphBuilderPlugins.create(compilerConfiguration, config, wordTypes, metaAccess, constantReflection, snippetReflection, foreignCalls, replacements, options);
170 AMD64GraphBuilderPlugins.register(plugins, replacements.getDefaultReplacementBytecodeProvider(), (AMD64) target.arch, false, JavaVersionUtil.JAVA_SPEC >= 9, config.useFMAIntrinsics);
171 return plugins;
172 }
173
174 protected AMD64HotSpotBackend createBackend(GraalHotSpotVMConfig config, HotSpotGraalRuntimeProvider runtime, HotSpotProviders providers) {
175 return new AMD64HotSpotBackend(config, runtime, providers);
176 }
177
178 protected HotSpotRegistersProvider createRegisters() {
179 return new HotSpotRegisters(AMD64.r15, AMD64.r12, AMD64.rsp);
180 }
181
182 protected AMD64HotSpotForeignCallsProvider createForeignCalls(HotSpotJVMCIRuntime jvmciRuntime, HotSpotGraalRuntimeProvider runtime, HotSpotMetaAccessProvider metaAccess,
183 HotSpotCodeCacheProvider codeCache, WordTypes wordTypes, Value[] nativeABICallerSaveRegisters) {
184 return new AMD64HotSpotForeignCallsProvider(jvmciRuntime, runtime, metaAccess, codeCache, wordTypes, nativeABICallerSaveRegisters);
185 }
186
187 /**
188 * @param replacements
189 */
190 protected HotSpotSuitesProvider createSuites(GraalHotSpotVMConfig config, HotSpotGraalRuntimeProvider runtime, CompilerConfiguration compilerConfiguration, Plugins plugins,
191 HotSpotRegistersProvider registers, Replacements replacements, OptionValues options) {
192 return new AddressLoweringHotSpotSuitesProvider(new AMD64HotSpotSuitesCreator(compilerConfiguration, plugins), config, runtime,
193 new AddressLoweringPhase(new AMD64HotSpotAddressLowering(config, registers.getHeapBaseRegister(), options)));
194 }
195
196 protected HotSpotLoweringProvider createLowerer(HotSpotGraalRuntimeProvider runtime, HotSpotMetaAccessProvider metaAccess, HotSpotForeignCallsProvider foreignCalls,
197 HotSpotRegistersProvider registers, HotSpotConstantReflectionProvider constantReflection, TargetDescription target) {
198 return new AMD64HotSpotLoweringProvider(runtime, metaAccess, foreignCalls, registers, constantReflection, target);
199 }
200
201 protected Value[] createNativeABICallerSaveRegisters(GraalHotSpotVMConfig config, RegisterConfig regConfig) {
202 List<Register> callerSave = new ArrayList<>(regConfig.getAllocatableRegisters().asList());
203 if (config.windowsOs) {
204 // http://msdn.microsoft.com/en-us/library/9z1stfyw.aspx
205 callerSave.remove(AMD64.rdi);
206 callerSave.remove(AMD64.rsi);
207 callerSave.remove(AMD64.rbx);
208 callerSave.remove(AMD64.rbp);
209 callerSave.remove(AMD64.rsp);
210 callerSave.remove(AMD64.r12);
211 callerSave.remove(AMD64.r13);
212 callerSave.remove(AMD64.r14);
213 callerSave.remove(AMD64.r15);
214 callerSave.remove(AMD64.xmm6);
215 callerSave.remove(AMD64.xmm7);
216 callerSave.remove(AMD64.xmm8);
217 callerSave.remove(AMD64.xmm9);
218 callerSave.remove(AMD64.xmm10);
219 callerSave.remove(AMD64.xmm11);
220 callerSave.remove(AMD64.xmm12);
221 callerSave.remove(AMD64.xmm13);
222 callerSave.remove(AMD64.xmm14);
223 callerSave.remove(AMD64.xmm15);
224 } else {
225 /*
226 * System V Application Binary Interface, AMD64 Architecture Processor Supplement
227 *
228 * Draft Version 0.96
229 *
230 * http://www.uclibc.org/docs/psABI-x86_64.pdf
231 *
232 * 3.2.1
233 *
234 * ...
235 *
236 * This subsection discusses usage of each register. Registers %rbp, %rbx and %r12
237 * through %r15 "belong" to the calling function and the called function is required to
238 * preserve their values. In other words, a called function must preserve these
239 * registers' values for its caller. Remaining registers "belong" to the called
240 * function. If a calling function wants to preserve such a register value across a
241 * function call, it must save the value in its local stack frame.
242 */
243 callerSave.remove(AMD64.rbp);
244 callerSave.remove(AMD64.rbx);
245 callerSave.remove(AMD64.r12);
246 callerSave.remove(AMD64.r13);
247 callerSave.remove(AMD64.r14);
248 callerSave.remove(AMD64.r15);
249 }
250 Value[] nativeABICallerSaveRegisters = new Value[callerSave.size()];
251 for (int i = 0; i < callerSave.size(); i++) {
252 nativeABICallerSaveRegisters[i] = callerSave.get(i).asValue();
253 }
254 return nativeABICallerSaveRegisters;
255 }
256
257 @Override
258 public String toString() {
259 return "AMD64";
260 }
261 }