1 /*
2 * Copyright (c) 2012, 2016, 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 package org.graalvm.compiler.hotspot.amd64;
24
25 import static org.graalvm.compiler.hotspot.HotSpotBackend.Options.GraalArithmeticStubs;
26 import static jdk.vm.ci.common.InitTimer.timer;
27
28 import java.util.ArrayList;
29 import java.util.List;
30
31 import org.graalvm.compiler.api.replacements.SnippetReflectionProvider;
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.HotSpotForeignCallsProvider;
40 import org.graalvm.compiler.hotspot.meta.HotSpotGraalConstantFieldProvider;
41 import org.graalvm.compiler.hotspot.meta.HotSpotGraphBuilderPlugins;
42 import org.graalvm.compiler.hotspot.meta.HotSpotHostForeignCallsProvider;
43 import org.graalvm.compiler.hotspot.meta.HotSpotLoweringProvider;
44 import org.graalvm.compiler.hotspot.meta.HotSpotProviders;
45 import org.graalvm.compiler.hotspot.meta.HotSpotRegisters;
46 import org.graalvm.compiler.hotspot.meta.HotSpotRegistersProvider;
47 import org.graalvm.compiler.hotspot.meta.HotSpotSnippetReflectionProvider;
48 import org.graalvm.compiler.hotspot.meta.HotSpotStampProvider;
49 import org.graalvm.compiler.hotspot.meta.HotSpotSuitesProvider;
50 import org.graalvm.compiler.hotspot.nodes.HotSpotNodeCostProvider;
51 import org.graalvm.compiler.hotspot.word.HotSpotWordTypes;
52 import org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderConfiguration.Plugins;
53 import org.graalvm.compiler.nodes.spi.NodeCostProvider;
54 import org.graalvm.compiler.nodes.spi.Replacements;
55 import org.graalvm.compiler.phases.tiers.CompilerConfiguration;
56 import org.graalvm.compiler.phases.util.Providers;
57 import org.graalvm.compiler.replacements.amd64.AMD64GraphBuilderPlugins;
58 import org.graalvm.compiler.replacements.classfile.ClassfileBytecodeProvider;
59 import org.graalvm.compiler.serviceprovider.ServiceProvider;
60 import org.graalvm.compiler.word.WordTypes;
61
62 import jdk.vm.ci.amd64.AMD64;
63 import jdk.vm.ci.code.Architecture;
64 import jdk.vm.ci.code.Register;
65 import jdk.vm.ci.code.RegisterConfig;
66 import jdk.vm.ci.code.TargetDescription;
67 import jdk.vm.ci.common.InitTimer;
68 import jdk.vm.ci.hotspot.HotSpotCodeCacheProvider;
69 import jdk.vm.ci.hotspot.HotSpotConstantReflectionProvider;
70 import jdk.vm.ci.hotspot.HotSpotJVMCIRuntimeProvider;
71 import jdk.vm.ci.hotspot.HotSpotMetaAccessProvider;
72 import jdk.vm.ci.meta.Value;
73 import jdk.vm.ci.runtime.JVMCIBackend;
74
75 @ServiceProvider(HotSpotBackendFactory.class)
76 public class AMD64HotSpotBackendFactory implements HotSpotBackendFactory {
77
78 @Override
79 public String getName() {
80 return "core";
81 }
82
83 @Override
84 public Class<? extends Architecture> getArchitecture() {
85 return AMD64.class;
86 }
87
88 @Override
89 @SuppressWarnings("try")
90 public HotSpotBackend createBackend(HotSpotGraalRuntimeProvider graalRuntime, CompilerConfiguration compilerConfiguration, HotSpotJVMCIRuntimeProvider jvmciRuntime, HotSpotBackend host) {
91 assert host == null;
92
93 JVMCIBackend jvmci = jvmciRuntime.getHostJVMCIBackend();
94 GraalHotSpotVMConfig config = graalRuntime.getVMConfig();
95 HotSpotProviders providers;
96 HotSpotRegistersProvider registers;
97 HotSpotCodeCacheProvider codeCache = (HotSpotCodeCacheProvider) jvmci.getCodeCache();
98 TargetDescription target = codeCache.getTarget();
99 HotSpotHostForeignCallsProvider foreignCalls;
100 Value[] nativeABICallerSaveRegisters;
101 HotSpotMetaAccessProvider metaAccess = (HotSpotMetaAccessProvider) jvmci.getMetaAccess();
102 HotSpotConstantReflectionProvider constantReflection = (HotSpotConstantReflectionProvider) jvmci.getConstantReflection();
103 ConstantFieldProvider constantFieldProvider = new HotSpotGraalConstantFieldProvider(config, metaAccess);
104 HotSpotLoweringProvider lowerer;
105 HotSpotSnippetReflectionProvider snippetReflection;
106 HotSpotReplacementsImpl replacements;
107 HotSpotSuitesProvider suites;
108 HotSpotWordTypes wordTypes;
109 Plugins plugins;
110 NodeCostProvider nodeCostProvider;
111 BytecodeProvider bytecodeProvider;
112 try (InitTimer t = timer("create providers")) {
113 try (InitTimer rt = timer("create HotSpotRegisters provider")) {
114 registers = createRegisters();
115 }
116 try (InitTimer rt = timer("create NativeABICallerSaveRegisters")) {
117 nativeABICallerSaveRegisters = createNativeABICallerSaveRegisters(config, codeCache.getRegisterConfig());
118 }
119 try (InitTimer rt = timer("create WordTypes")) {
120 wordTypes = new HotSpotWordTypes(metaAccess, target.wordJavaKind);
121 }
122 try (InitTimer rt = timer("create ForeignCalls provider")) {
123 foreignCalls = createForeignCalls(jvmciRuntime, graalRuntime, metaAccess, codeCache, wordTypes, nativeABICallerSaveRegisters);
124 }
125 try (InitTimer rt = timer("create Lowerer provider")) {
126 lowerer = createLowerer(graalRuntime, metaAccess, foreignCalls, registers, constantReflection, target);
127 }
128 try (InitTimer rt = timer("create NodeCost provider")) {
129 nodeCostProvider = createNodeCostProvider(target);
130 }
131 HotSpotStampProvider stampProvider = new HotSpotStampProvider();
132 Providers p = new Providers(metaAccess, codeCache, constantReflection, constantFieldProvider, foreignCalls, lowerer, null, stampProvider, nodeCostProvider);
133
134 try (InitTimer rt = timer("create SnippetReflection provider")) {
135 snippetReflection = createSnippetReflection(graalRuntime, constantReflection, wordTypes);
136 }
137 try (InitTimer rt = timer("create Bytecode provider")) {
138 bytecodeProvider = new ClassfileBytecodeProvider(metaAccess, snippetReflection);
139 }
140 try (InitTimer rt = timer("create Replacements provider")) {
141 replacements = createReplacements(p, snippetReflection, bytecodeProvider);
142 }
143 try (InitTimer rt = timer("create GraphBuilderPhase plugins")) {
144 plugins = createGraphBuilderPlugins(config, target, constantReflection, foreignCalls, metaAccess, snippetReflection, replacements, wordTypes, stampProvider);
145 replacements.setGraphBuilderPlugins(plugins);
146 }
147 try (InitTimer rt = timer("create Suites provider")) {
148 suites = createSuites(config, graalRuntime, compilerConfiguration, plugins, registers, replacements);
149 }
150 providers = new HotSpotProviders(metaAccess, codeCache, constantReflection, constantFieldProvider, foreignCalls, lowerer, replacements, nodeCostProvider, suites, registers,
151 snippetReflection, wordTypes,
152 plugins);
153 }
154 try (InitTimer rt = timer("instantiate backend")) {
155 return createBackend(config, graalRuntime, providers);
156 }
157 }
158
159 protected Plugins createGraphBuilderPlugins(GraalHotSpotVMConfig config, TargetDescription target, HotSpotConstantReflectionProvider constantReflection,
160 HotSpotHostForeignCallsProvider foreignCalls,
161 HotSpotMetaAccessProvider metaAccess, HotSpotSnippetReflectionProvider snippetReflection, HotSpotReplacementsImpl replacements, HotSpotWordTypes wordTypes,
162 HotSpotStampProvider stampProvider) {
163 Plugins plugins = HotSpotGraphBuilderPlugins.create(config, wordTypes, metaAccess, constantReflection, snippetReflection, foreignCalls, stampProvider, replacements);
164 AMD64GraphBuilderPlugins.register(plugins, replacements.getReplacementBytecodeProvider(), (AMD64) target.arch, GraalArithmeticStubs.getValue());
165 return plugins;
166 }
167
168 protected AMD64HotSpotBackend createBackend(GraalHotSpotVMConfig config, HotSpotGraalRuntimeProvider runtime, HotSpotProviders providers) {
169 return new AMD64HotSpotBackend(config, runtime, providers);
170 }
171
172 protected HotSpotRegistersProvider createRegisters() {
173 return new HotSpotRegisters(AMD64.r15, AMD64.r12, AMD64.rsp);
174 }
175
176 protected HotSpotReplacementsImpl createReplacements(Providers p, SnippetReflectionProvider snippetReflection, BytecodeProvider bytecodeProvider) {
177 return new HotSpotReplacementsImpl(p, snippetReflection, bytecodeProvider, p.getCodeCache().getTarget());
178 }
179
180 protected AMD64HotSpotForeignCallsProvider createForeignCalls(HotSpotJVMCIRuntimeProvider jvmciRuntime, HotSpotGraalRuntimeProvider runtime, HotSpotMetaAccessProvider metaAccess,
181 HotSpotCodeCacheProvider codeCache, WordTypes wordTypes, Value[] nativeABICallerSaveRegisters) {
182 return new AMD64HotSpotForeignCallsProvider(jvmciRuntime, runtime, metaAccess, codeCache, wordTypes, nativeABICallerSaveRegisters);
183 }
184
185 /**
186 * @param replacements
187 */
188 protected HotSpotSuitesProvider createSuites(GraalHotSpotVMConfig config, HotSpotGraalRuntimeProvider runtime, CompilerConfiguration compilerConfiguration, Plugins plugins,
189 HotSpotRegistersProvider registers, Replacements replacements) {
190 return new HotSpotSuitesProvider(new AMD64HotSpotSuitesProvider(compilerConfiguration, plugins), config, runtime, new AMD64HotSpotAddressLowering(config, registers.getHeapBaseRegister()));
191 }
192
193 protected HotSpotSnippetReflectionProvider createSnippetReflection(HotSpotGraalRuntimeProvider runtime, HotSpotConstantReflectionProvider constantReflection, WordTypes wordTypes) {
194 return new HotSpotSnippetReflectionProvider(runtime, constantReflection, wordTypes);
195 }
196
197 protected HotSpotLoweringProvider createLowerer(HotSpotGraalRuntimeProvider runtime, HotSpotMetaAccessProvider metaAccess, HotSpotForeignCallsProvider foreignCalls,
198 HotSpotRegistersProvider registers, HotSpotConstantReflectionProvider constantReflection, TargetDescription target) {
199 return new AMD64HotSpotLoweringProvider(runtime, metaAccess, foreignCalls, registers, constantReflection, target);
200 }
201
202 protected HotSpotNodeCostProvider createNodeCostProvider(TargetDescription target) {
203 return new AMD64HotSpotNodeCostProvider(target);
204 }
205
206 protected Value[] createNativeABICallerSaveRegisters(GraalHotSpotVMConfig config, RegisterConfig regConfig) {
207 List<Register> callerSave = new ArrayList<>(regConfig.getAllocatableRegisters().asList());
208 if (config.windowsOs) {
209 // http://msdn.microsoft.com/en-us/library/9z1stfyw.aspx
210 callerSave.remove(AMD64.rdi);
211 callerSave.remove(AMD64.rsi);
212 callerSave.remove(AMD64.rbx);
213 callerSave.remove(AMD64.rbp);
214 callerSave.remove(AMD64.rsp);
215 callerSave.remove(AMD64.r12);
216 callerSave.remove(AMD64.r13);
217 callerSave.remove(AMD64.r14);
218 callerSave.remove(AMD64.r15);
219 callerSave.remove(AMD64.xmm6);
220 callerSave.remove(AMD64.xmm7);
221 callerSave.remove(AMD64.xmm8);
222 callerSave.remove(AMD64.xmm9);
223 callerSave.remove(AMD64.xmm10);
224 callerSave.remove(AMD64.xmm11);
225 callerSave.remove(AMD64.xmm12);
226 callerSave.remove(AMD64.xmm13);
227 callerSave.remove(AMD64.xmm14);
228 callerSave.remove(AMD64.xmm15);
229 } else {
230 /*
231 * System V Application Binary Interface, AMD64 Architecture Processor Supplement
232 *
233 * Draft Version 0.96
234 *
235 * http://www.uclibc.org/docs/psABI-x86_64.pdf
236 *
237 * 3.2.1
238 *
239 * ...
240 *
241 * This subsection discusses usage of each register. Registers %rbp, %rbx and %r12
242 * through %r15 "belong" to the calling function and the called function is required to
243 * preserve their values. In other words, a called function must preserve these
244 * registers' values for its caller. Remaining registers "belong" to the called
245 * function. If a calling function wants to preserve such a register value across a
246 * function call, it must save the value in its local stack frame.
247 */
248 callerSave.remove(AMD64.rbp);
249 callerSave.remove(AMD64.rbx);
250 callerSave.remove(AMD64.r12);
251 callerSave.remove(AMD64.r13);
252 callerSave.remove(AMD64.r14);
253 callerSave.remove(AMD64.r15);
254 }
255 Value[] nativeABICallerSaveRegisters = new Value[callerSave.size()];
256 for (int i = 0; i < callerSave.size(); i++) {
257 nativeABICallerSaveRegisters[i] = callerSave.get(i).asValue();
258 }
259 return nativeABICallerSaveRegisters;
260 }
261
262 @Override
263 public String toString() {
264 return "AMD64";
265 }
266 }