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;
24
25 import static org.graalvm.compiler.hotspot.stubs.StubUtil.newDescriptor;
26
27 import java.util.EnumSet;
28 import java.util.HashSet;
29 import java.util.Map;
30 import java.util.Set;
31
32 import org.graalvm.compiler.code.CompilationResult;
33 import org.graalvm.compiler.core.common.CompilationIdentifier;
34 import org.graalvm.compiler.core.common.cfg.AbstractBlockBase;
35 import org.graalvm.compiler.core.common.spi.ForeignCallDescriptor;
36 import org.graalvm.compiler.core.common.spi.ForeignCallLinkage;
37 import org.graalvm.compiler.core.target.Backend;
38 import org.graalvm.compiler.graph.Node.ConstantNodeParameter;
39 import org.graalvm.compiler.graph.Node.NodeIntrinsic;
40 import org.graalvm.compiler.hotspot.meta.HotSpotProviders;
41 import org.graalvm.compiler.hotspot.nodes.DeoptimizationFetchUnrollInfoCallNode;
42 import org.graalvm.compiler.hotspot.nodes.UncommonTrapCallNode;
43 import org.graalvm.compiler.hotspot.nodes.VMErrorNode;
44 import org.graalvm.compiler.hotspot.nodes.aot.ResolveConstantStubCall;
45 import org.graalvm.compiler.hotspot.replacements.AESCryptSubstitutions;
46 import org.graalvm.compiler.hotspot.replacements.BigIntegerSubstitutions;
47 import org.graalvm.compiler.hotspot.replacements.CipherBlockChainingSubstitutions;
48 import org.graalvm.compiler.hotspot.replacements.SHA2Substitutions;
49 import org.graalvm.compiler.hotspot.replacements.SHA5Substitutions;
50 import org.graalvm.compiler.hotspot.replacements.SHASubstitutions;
51 import org.graalvm.compiler.hotspot.stubs.DeoptimizationStub;
52 import org.graalvm.compiler.hotspot.stubs.ExceptionHandlerStub;
53 import org.graalvm.compiler.hotspot.stubs.Stub;
54 import org.graalvm.compiler.hotspot.stubs.UnwindExceptionToCallerStub;
55 import org.graalvm.compiler.hotspot.word.KlassPointer;
56 import org.graalvm.compiler.hotspot.word.MethodCountersPointer;
57 import org.graalvm.compiler.lir.LIR;
58 import org.graalvm.compiler.lir.LIRFrameState;
59 import org.graalvm.compiler.lir.LIRInstruction;
60 import org.graalvm.compiler.lir.LIRInstruction.OperandFlag;
61 import org.graalvm.compiler.lir.LIRInstruction.OperandMode;
62 import org.graalvm.compiler.lir.StandardOp.LabelOp;
63 import org.graalvm.compiler.lir.StandardOp.SaveRegistersOp;
64 import org.graalvm.compiler.lir.ValueConsumer;
65 import org.graalvm.compiler.lir.asm.CompilationResultBuilder;
66 import org.graalvm.compiler.lir.framemap.FrameMap;
67 import org.graalvm.compiler.nodes.UnwindNode;
68 import org.graalvm.compiler.nodes.extended.ForeignCallNode;
69 import org.graalvm.compiler.options.Option;
70 import org.graalvm.compiler.options.OptionType;
71 import org.graalvm.compiler.options.OptionValue;
72 import org.graalvm.compiler.phases.tiers.SuitesProvider;
73 import org.graalvm.compiler.word.Pointer;
74 import org.graalvm.compiler.word.Word;
75
76 import jdk.vm.ci.code.CompilationRequest;
77 import jdk.vm.ci.code.CompiledCode;
78 import jdk.vm.ci.code.DebugInfo;
79 import jdk.vm.ci.code.Register;
80 import jdk.vm.ci.code.RegisterSaveLayout;
81 import jdk.vm.ci.code.StackSlot;
82 import jdk.vm.ci.code.ValueUtil;
83 import jdk.vm.ci.hotspot.HotSpotCompilationRequest;
84 import jdk.vm.ci.hotspot.HotSpotJVMCIRuntime;
85 import jdk.vm.ci.hotspot.HotSpotResolvedJavaMethod;
86 import jdk.vm.ci.meta.ResolvedJavaMethod;
87 import jdk.vm.ci.meta.Value;
88 import jdk.vm.ci.runtime.JVMCICompiler;
89
90 /**
91 * HotSpot specific backend.
92 */
93 public abstract class HotSpotBackend extends Backend implements FrameMap.ReferenceMapBuilderFactory {
94
95 public static class Options {
96 // @formatter:off
97 @Option(help = "Use Graal stubs instead of HotSpot stubs where possible")
98 public static final OptionValue<Boolean> PreferGraalStubs = new OptionValue<>(false);
99 @Option(help = "Use Graal arithmetic stubs instead of HotSpot stubs where possible")
100 public static final OptionValue<Boolean> GraalArithmeticStubs = new OptionValue<>(true);
101 @Option(help = "Enables instruction profiling on assembler level. Valid values are a comma separated list of supported instructions." +
102 " Compare with subclasses of Assembler.InstructionCounter.", type = OptionType.Debug)
103 public static final OptionValue<String> ASMInstructionProfiling = new OptionValue<>(null);
104 // @formatter:on
105 }
106
107 /**
108 * Descriptor for {@link ExceptionHandlerStub}. This stub is called by the
109 * {@linkplain GraalHotSpotVMConfig#MARKID_EXCEPTION_HANDLER_ENTRY exception handler} in a
110 * compiled method.
111 */
112 public static final ForeignCallDescriptor EXCEPTION_HANDLER = new ForeignCallDescriptor("exceptionHandler", void.class, Object.class, Word.class);
113
114 /**
115 * Descriptor for SharedRuntime::get_ic_miss_stub().
116 */
117 public static final ForeignCallDescriptor IC_MISS_HANDLER = new ForeignCallDescriptor("icMissHandler", void.class);
118
119 /**
120 * Descriptor for SharedRuntime::get_handle_wrong_method_stub().
121 */
122 public static final ForeignCallDescriptor WRONG_METHOD_HANDLER = new ForeignCallDescriptor("wrongMethodHandler", void.class);
123
124 /**
125 * Descriptor for {@link UnwindExceptionToCallerStub}. This stub is called by code generated
126 * from {@link UnwindNode}.
127 */
128 public static final ForeignCallDescriptor UNWIND_EXCEPTION_TO_CALLER = new ForeignCallDescriptor("unwindExceptionToCaller", void.class, Object.class, Word.class);
129
130 /**
131 * Descriptor for the arguments when unwinding to an exception handler in a caller.
132 */
133 public static final ForeignCallDescriptor EXCEPTION_HANDLER_IN_CALLER = new ForeignCallDescriptor("exceptionHandlerInCaller", void.class, Object.class, Word.class);
134
135 private final HotSpotGraalRuntimeProvider runtime;
136
137 /**
138 * @see DeoptimizationFetchUnrollInfoCallNode
139 */
140 public static final ForeignCallDescriptor FETCH_UNROLL_INFO = new ForeignCallDescriptor("fetchUnrollInfo", Word.class, long.class, int.class);
141
142 /**
143 * @see DeoptimizationStub#unpackFrames(ForeignCallDescriptor, Word, int)
144 */
145 public static final ForeignCallDescriptor UNPACK_FRAMES = newDescriptor(DeoptimizationStub.class, "unpackFrames", int.class, Word.class, int.class);
146
147 /**
148 * @see AESCryptSubstitutions#encryptBlockStub(ForeignCallDescriptor, Word, Word, Pointer)
149 */
150 public static final ForeignCallDescriptor ENCRYPT_BLOCK = new ForeignCallDescriptor("encrypt_block", void.class, Word.class, Word.class, Pointer.class);
151
152 /**
153 * @see AESCryptSubstitutions#decryptBlockStub(ForeignCallDescriptor, Word, Word, Pointer)
154 */
155 public static final ForeignCallDescriptor DECRYPT_BLOCK = new ForeignCallDescriptor("decrypt_block", void.class, Word.class, Word.class, Pointer.class);
156
157 /**
158 * @see AESCryptSubstitutions#decryptBlockStub(ForeignCallDescriptor, Word, Word, Pointer)
159 */
160 public static final ForeignCallDescriptor DECRYPT_BLOCK_WITH_ORIGINAL_KEY = new ForeignCallDescriptor("decrypt_block_with_original_key", void.class, Word.class, Word.class, Pointer.class,
161 Pointer.class);
162
163 /**
164 * @see CipherBlockChainingSubstitutions#crypt
165 */
166 public static final ForeignCallDescriptor ENCRYPT = new ForeignCallDescriptor("encrypt", void.class, Word.class, Word.class, Pointer.class, Pointer.class, int.class);
167
168 /**
169 * @see CipherBlockChainingSubstitutions#crypt
170 */
171 public static final ForeignCallDescriptor DECRYPT = new ForeignCallDescriptor("decrypt", void.class, Word.class, Word.class, Pointer.class, Pointer.class, int.class);
172
173 /**
174 * @see CipherBlockChainingSubstitutions#crypt
175 */
176 public static final ForeignCallDescriptor DECRYPT_WITH_ORIGINAL_KEY = new ForeignCallDescriptor("decrypt_with_original_key", void.class, Word.class, Word.class, Pointer.class, Pointer.class,
177 int.class, Pointer.class);
178
179 /**
180 * @see BigIntegerSubstitutions#multiplyToLen
181 */
182 public static final ForeignCallDescriptor MULTIPLY_TO_LEN = new ForeignCallDescriptor("multiplyToLen", void.class, Word.class, int.class, Word.class, int.class, Word.class, int.class);
183
184 public static void multiplyToLenStub(Word xAddr, int xlen, Word yAddr, int ylen, Word zAddr, int zLen) {
185 multiplyToLenStub(HotSpotBackend.MULTIPLY_TO_LEN, xAddr, xlen, yAddr, ylen, zAddr, zLen);
186 }
187
188 @NodeIntrinsic(ForeignCallNode.class)
189 private static native void multiplyToLenStub(@ConstantNodeParameter ForeignCallDescriptor descriptor, Word xIn, int xLen, Word yIn, int yLen, Word zIn, int zLen);
190
191 /**
192 * @see BigIntegerSubstitutions#mulAdd
193 */
194 public static final ForeignCallDescriptor MUL_ADD = new ForeignCallDescriptor("mulAdd", int.class, Word.class, Word.class, int.class, int.class, int.class);
195
196 public static int mulAddStub(Word inAddr, Word outAddr, int newOffset, int len, int k) {
197 return mulAddStub(HotSpotBackend.MUL_ADD, inAddr, outAddr, newOffset, len, k);
198 }
199
200 @NodeIntrinsic(ForeignCallNode.class)
201 private static native int mulAddStub(@ConstantNodeParameter ForeignCallDescriptor descriptor, Word inAddr, Word outAddr, int newOffset, int len, int k);
202
203 /**
204 * @see BigIntegerSubstitutions#implMontgomeryMultiply
205 */
206 public static final ForeignCallDescriptor MONTGOMERY_MULTIPLY = new ForeignCallDescriptor("implMontgomeryMultiply", void.class, Word.class, Word.class, Word.class, int.class, long.class,
207 Word.class);
208
209 public static void implMontgomeryMultiply(Word aAddr, Word bAddr, Word nAddr, int len, long inv, Word productAddr) {
210 implMontgomeryMultiply(HotSpotBackend.MONTGOMERY_MULTIPLY, aAddr, bAddr, nAddr, len, inv, productAddr);
211 }
212
213 @NodeIntrinsic(ForeignCallNode.class)
214 private static native void implMontgomeryMultiply(@ConstantNodeParameter ForeignCallDescriptor descriptor, Word aAddr, Word bAddr, Word nAddr, int len, long inv, Word productAddr);
215
216 /**
217 * @see BigIntegerSubstitutions#implMontgomerySquare
218 */
219 public static final ForeignCallDescriptor MONTGOMERY_SQUARE = new ForeignCallDescriptor("implMontgomerySquare", void.class, Word.class, Word.class, int.class, long.class, Word.class);
220
221 public static void implMontgomerySquare(Word aAddr, Word nAddr, int len, long inv, Word productAddr) {
222 implMontgomerySquare(HotSpotBackend.MONTGOMERY_SQUARE, aAddr, nAddr, len, inv, productAddr);
223 }
224
225 @NodeIntrinsic(ForeignCallNode.class)
226 private static native void implMontgomerySquare(@ConstantNodeParameter ForeignCallDescriptor descriptor, Word aAddr, Word nAddr, int len, long inv, Word productAddr);
227
228 /**
229 * @see BigIntegerSubstitutions#implSquareToLen
230 */
231 public static final ForeignCallDescriptor SQUARE_TO_LEN = new ForeignCallDescriptor("implSquareToLen", void.class, Word.class, int.class, Word.class, int.class);
232
233 public static void implSquareToLen(Word xAddr, int len, Word zAddr, int zLen) {
234 implSquareToLen(SQUARE_TO_LEN, xAddr, len, zAddr, zLen);
235 }
236
237 @NodeIntrinsic(ForeignCallNode.class)
238 private static native void implSquareToLen(@ConstantNodeParameter ForeignCallDescriptor descriptor, Word xAddr, int len, Word zAddr, int zLen);
239
240 /**
241 * @see SHASubstitutions#implCompress0
242 */
243 public static final ForeignCallDescriptor SHA_IMPL_COMPRESS = new ForeignCallDescriptor("shaImplCompress", void.class, Word.class, Object.class);
244
245 public static void shaImplCompressStub(Word bufAddr, Object state) {
246 shaImplCompressStub(HotSpotBackend.SHA_IMPL_COMPRESS, bufAddr, state);
247 }
248
249 @NodeIntrinsic(ForeignCallNode.class)
250 private static native void shaImplCompressStub(@ConstantNodeParameter ForeignCallDescriptor descriptor, Word bufAddr, Object state);
251
252 /**
253 * @see SHA2Substitutions#implCompress0
254 */
255 public static final ForeignCallDescriptor SHA2_IMPL_COMPRESS = new ForeignCallDescriptor("sha2ImplCompress", void.class, Word.class, Object.class);
256
257 public static void sha2ImplCompressStub(Word bufAddr, Object state) {
258 sha2ImplCompressStub(HotSpotBackend.SHA2_IMPL_COMPRESS, bufAddr, state);
259 }
260
261 @NodeIntrinsic(ForeignCallNode.class)
262 private static native void sha2ImplCompressStub(@ConstantNodeParameter ForeignCallDescriptor descriptor, Word bufAddr, Object state);
263
264 /**
265 * @see SHA5Substitutions#implCompress0
266 */
267 public static final ForeignCallDescriptor SHA5_IMPL_COMPRESS = new ForeignCallDescriptor("sha5ImplCompress", void.class, Word.class, Object.class);
268
269 public static void sha5ImplCompressStub(Word bufAddr, Object state) {
270 sha5ImplCompressStub(HotSpotBackend.SHA5_IMPL_COMPRESS, bufAddr, state);
271 }
272
273 @NodeIntrinsic(ForeignCallNode.class)
274 private static native void sha5ImplCompressStub(@ConstantNodeParameter ForeignCallDescriptor descriptor, Word bufAddr, Object state);
275
276 /**
277 * @see VMErrorNode
278 */
279 public static final ForeignCallDescriptor VM_ERROR = new ForeignCallDescriptor("vm_error", void.class, Object.class, Object.class, long.class);
280
281 /**
282 * New multi array stub call.
283 */
284 public static final ForeignCallDescriptor NEW_MULTI_ARRAY = new ForeignCallDescriptor("new_multi_array", Object.class, KlassPointer.class, int.class, Word.class);
285
286 /**
287 * New array stub.
288 */
289 public static final ForeignCallDescriptor NEW_ARRAY = new ForeignCallDescriptor("new_array", Object.class, KlassPointer.class, int.class, boolean.class);
290
291 /**
292 * New instance stub.
293 */
294 public static final ForeignCallDescriptor NEW_INSTANCE = new ForeignCallDescriptor("new_instance", Object.class, KlassPointer.class);
295
296 /**
297 * @see ResolveConstantStubCall
298 */
299 public static final ForeignCallDescriptor RESOLVE_STRING_BY_SYMBOL = new ForeignCallDescriptor("resolve_string_by_symbol", Object.class, Word.class, Word.class);
300
301 /**
302 * @see ResolveConstantStubCall
303 */
304 public static final ForeignCallDescriptor RESOLVE_KLASS_BY_SYMBOL = new ForeignCallDescriptor("resolve_klass_by_symbol", Word.class, Word.class, Word.class);
305
306 /**
307 * @see ResolveConstantStubCall
308 */
309 public static final ForeignCallDescriptor INITIALIZE_KLASS_BY_SYMBOL = new ForeignCallDescriptor("initialize_klass_by_symbol", Word.class, Word.class, Word.class);
310
311 /**
312 * @see ResolveConstantStubCall
313 */
314 public static final ForeignCallDescriptor RESOLVE_METHOD_BY_SYMBOL_AND_LOAD_COUNTERS = new ForeignCallDescriptor("resolve_method_by_symbol_and_load_counters", Word.class, Word.class, Word.class,
315 Word.class);
316
317 /**
318 * Tiered support.
319 */
320 public static final ForeignCallDescriptor INVOCATION_EVENT = new ForeignCallDescriptor("invocation_event", void.class, MethodCountersPointer.class);
321 public static final ForeignCallDescriptor BACKEDGE_EVENT = new ForeignCallDescriptor("backedge_event", void.class, MethodCountersPointer.class, int.class, int.class);
322
323 /**
324 * @see UncommonTrapCallNode
325 */
326 public static final ForeignCallDescriptor UNCOMMON_TRAP = new ForeignCallDescriptor("uncommonTrap", Word.class, Word.class, int.class, int.class);
327
328 public HotSpotBackend(HotSpotGraalRuntimeProvider runtime, HotSpotProviders providers) {
329 super(providers);
330 this.runtime = runtime;
331 }
332
333 public HotSpotGraalRuntimeProvider getRuntime() {
334 return runtime;
335 }
336
337 /**
338 * Performs any remaining initialization that was deferred until the {@linkplain #getRuntime()
339 * runtime} object was initialized and this backend was registered with it.
340 *
341 * @param jvmciRuntime
342 */
343 public void completeInitialization(HotSpotJVMCIRuntime jvmciRuntime) {
344 }
345
346 /**
347 * Finds all the registers that are defined by some given LIR.
348 *
349 * @param lir the LIR to examine
350 * @return the registers that are defined by or used as temps for any instruction in {@code lir}
351 */
352 protected final Set<Register> gatherDestroyedCallerRegisters(LIR lir) {
353 final Set<Register> destroyedRegisters = new HashSet<>();
354 ValueConsumer defConsumer = new ValueConsumer() {
355
356 @Override
357 public void visitValue(Value value, OperandMode mode, EnumSet<OperandFlag> flags) {
358 if (ValueUtil.isRegister(value)) {
359 final Register reg = ValueUtil.asRegister(value);
360 destroyedRegisters.add(reg);
361 }
362 }
363 };
364 for (AbstractBlockBase<?> block : lir.codeEmittingOrder()) {
365 if (block == null) {
366 continue;
367 }
368 for (LIRInstruction op : lir.getLIRforBlock(block)) {
369 if (op instanceof LabelOp) {
370 // Don't consider this as a definition
371 } else {
372 op.visitEachTemp(defConsumer);
373 op.visitEachOutput(defConsumer);
374 }
375 }
376 }
377 return translateToCallerRegisters(destroyedRegisters);
378 }
379
380 /**
381 * Updates a given stub with respect to the registers it destroys.
382 * <p>
383 * Any entry in {@code calleeSaveInfo} that {@linkplain SaveRegistersOp#supportsRemove()
384 * supports} pruning will have {@code destroyedRegisters}
385 * {@linkplain SaveRegistersOp#remove(Set) removed} as these registers are declared as
386 * temporaries in the stub's {@linkplain ForeignCallLinkage linkage} (and thus will be saved by
387 * the stub's caller).
388 *
389 * @param stub the stub to update
390 * @param destroyedRegisters the registers destroyed by the stub
391 * @param calleeSaveInfo a map from debug infos to the operations that provide their
392 * {@linkplain RegisterSaveLayout callee-save information}
393 * @param frameMap used to {@linkplain FrameMap#offsetForStackSlot(StackSlot) convert} a virtual
394 * slot to a frame slot index
395 */
396 protected void updateStub(Stub stub, Set<Register> destroyedRegisters, Map<LIRFrameState, SaveRegistersOp> calleeSaveInfo, FrameMap frameMap) {
397 stub.initDestroyedCallerRegisters(destroyedRegisters);
398
399 for (Map.Entry<LIRFrameState, SaveRegistersOp> e : calleeSaveInfo.entrySet()) {
400 SaveRegistersOp save = e.getValue();
401 if (save.supportsRemove()) {
402 save.remove(destroyedRegisters);
403 }
404 DebugInfo info = e.getKey() == null ? null : e.getKey().debugInfo();
405 if (info != null) {
406 info.setCalleeSaveInfo(save.getMap(frameMap));
407 }
408 }
409 }
410
411 @Override
412 public HotSpotProviders getProviders() {
413 return (HotSpotProviders) super.getProviders();
414 }
415
416 @Override
417 public SuitesProvider getSuites() {
418 return getProviders().getSuites();
419 }
420
421 protected void profileInstructions(LIR lir, CompilationResultBuilder crb) {
422 if (HotSpotBackend.Options.ASMInstructionProfiling.getValue() != null) {
423 HotSpotInstructionProfiling.countInstructions(lir, crb.asm);
424 }
425 }
426
427 @Override
428 public CompiledCode createCompiledCode(ResolvedJavaMethod method, CompilationRequest compilationRequest, CompilationResult compResult) {
429 HotSpotCompilationRequest compRequest = compilationRequest instanceof HotSpotCompilationRequest ? (HotSpotCompilationRequest) compilationRequest : null;
430 return HotSpotCompiledCodeBuilder.createCompiledCode(method, compRequest, compResult);
431 }
432
433 @Override
434 public CompilationIdentifier getCompilationIdentifier(ResolvedJavaMethod resolvedJavaMethod) {
435 if (resolvedJavaMethod instanceof HotSpotResolvedJavaMethod) {
436 HotSpotCompilationRequest request = new HotSpotCompilationRequest((HotSpotResolvedJavaMethod) resolvedJavaMethod, JVMCICompiler.INVOCATION_ENTRY_BCI, 0L);
437 return new HotSpotCompilationIdentifier(request);
438 }
439 return super.getCompilationIdentifier(resolvedJavaMethod);
440 }
441 }