1 /*
2 * Copyright (c) 2014, 2018, 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.test;
26
27 import java.lang.reflect.Method;
28 import java.util.ArrayList;
29 import java.util.Arrays;
30 import java.util.Collection;
31 import java.util.Collections;
32 import java.util.Formatter;
33 import java.util.List;
34 import java.util.ServiceLoader;
35 import java.util.Set;
36 import java.util.TreeSet;
37 import java.util.stream.Collectors;
38
39 import jdk.internal.vm.compiler.collections.EconomicMap;
40 import jdk.internal.vm.compiler.collections.MapCursor;
41 import org.graalvm.compiler.api.test.Graal;
42 import org.graalvm.compiler.hotspot.GraalHotSpotVMConfig;
43 import org.graalvm.compiler.hotspot.HotSpotGraalRuntimeProvider;
44 import org.graalvm.compiler.hotspot.meta.HotSpotProviders;
45 import org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderConfiguration.Plugins;
46 import org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugin;
47 import org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugins;
48 import org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugins.Binding;
49 import org.graalvm.compiler.runtime.RuntimeProvider;
50 import org.graalvm.compiler.serviceprovider.GraalServices;
51 import org.graalvm.compiler.test.GraalTest;
52 import org.junit.Test;
53
54 import jdk.vm.ci.aarch64.AArch64;
55 import jdk.vm.ci.amd64.AMD64;
56 import jdk.vm.ci.code.Architecture;
57 import jdk.vm.ci.hotspot.HotSpotVMConfigStore;
58 import jdk.vm.ci.hotspot.VMIntrinsicMethod;
59 import jdk.vm.ci.meta.MetaAccessProvider;
60 import jdk.vm.ci.meta.MetaUtil;
61 import jdk.vm.ci.meta.MethodHandleAccessProvider.IntrinsicMethod;
62 import jdk.vm.ci.meta.ResolvedJavaMethod;
63
64 /**
65 * Checks the intrinsics implemented by Graal against the set of intrinsics declared by HotSpot. The
66 * purpose of this test is to detect when new intrinsics are added to HotSpot and process them
67 * appropriately in Graal. This will be achieved by working through {@link #toBeInvestigated} and
68 * either implementing the intrinsic or moving it to {@link #ignore} .
69 */
70 public class CheckGraalIntrinsics extends GraalTest {
71
72 public static boolean match(String type, Binding binding, VMIntrinsicMethod intrinsic) {
73 if (intrinsic.name.equals(binding.name)) {
74 if (intrinsic.descriptor.startsWith(binding.argumentsDescriptor)) {
75 if (type.equals(intrinsic.declaringClass)) {
76 return true;
77 }
78 }
79 }
80 return false;
81 }
82
83 public static InvocationPlugin findPlugin(EconomicMap<String, List<Binding>> bindings, VMIntrinsicMethod intrinsic) {
84 MapCursor<String, List<Binding>> cursor = bindings.getEntries();
85 while (cursor.advance()) {
86 // Match format of VMIntrinsicMethod.declaringClass
87 String type = MetaUtil.internalNameToJava(cursor.getKey(), true, false).replace('.', '/');
88 for (Binding binding : cursor.getValue()) {
89 if (match(type, binding, intrinsic)) {
90 return binding.plugin;
91 }
92 }
93 }
94 return null;
95 }
96
97 public static ResolvedJavaMethod resolveIntrinsic(MetaAccessProvider metaAccess, VMIntrinsicMethod intrinsic) throws ClassNotFoundException {
98 Class<?> c;
99 try {
100 c = Class.forName(intrinsic.declaringClass.replace('/', '.'), false, CheckGraalIntrinsics.class.getClassLoader());
101 } catch (ClassNotFoundException ex) {
102 try {
103 Class.forName("javax.naming.Reference");
104 } catch (ClassNotFoundException coreNamingMissing) {
105 // if core JDK classes aren't found, we are probably running in a
106 // JDK9 java.base environment and then missing class is OK
107 return null;
108 }
109 throw ex;
110 }
111 for (Method javaMethod : c.getDeclaredMethods()) {
112 if (javaMethod.getName().equals(intrinsic.name)) {
113 ResolvedJavaMethod method = metaAccess.lookupJavaMethod(javaMethod);
114 if (intrinsic.descriptor.equals("*")) {
115 // Signature polymorphic method - name match is enough
116 return method;
117 } else {
118 if (method.getSignature().toMethodDescriptor().equals(intrinsic.descriptor)) {
119 return method;
120 }
121 }
122 }
123 }
124 return null;
125 }
126
127 /**
128 * The HotSpot intrinsics that:
129 * <ul>
130 * <li>will never implemented by Graal (comments must explain why)</li>
131 * <li>are implemented without {@link InvocationPlugin}s, or</li>
132 * <li>whose {@link InvocationPlugin} registration is guarded by a condition that is false in
133 * the current VM context.</li>
134 * </ul>
135 */
136 public final Set<String> ignore = new TreeSet<>();
137
138 /**
139 * The HotSpot intrinsics whose {@link InvocationPlugin} registration is guarded by a condition
140 * too complex to duplicate here.
141 * </ul>
142 */
143 public final Set<String> complexGuard = new TreeSet<>();
144
145 /**
146 * The HotSpot intrinsics implemented downstream.
147 * </ul>
148 */
149 public final Set<String> downstream = new TreeSet<>();
150
151 /**
152 * The HotSpot intrinsics yet to be implemented or moved to {@link #ignore}.
153 */
154 public final Set<String> toBeInvestigated = new TreeSet<>();
155
156 private static Collection<String> add(Collection<String> c, String... elements) {
157 String[] sorted = elements.clone();
158 Arrays.sort(sorted);
159 for (int i = 0; i < elements.length; i++) {
160 if (!elements[i].equals(sorted[i])) {
161 // Let's keep the list sorted for easier visual inspection
162 fail("Element %d is out of order, \"%s\"", i, elements[i]);
163 }
164 }
165 c.addAll(Arrays.asList(elements));
166 return c;
167 }
168
169 public final HotSpotGraalRuntimeProvider rt = (HotSpotGraalRuntimeProvider) Graal.getRequiredCapability(RuntimeProvider.class);
170 public final Architecture arch = rt.getHostBackend().getTarget().arch;
171 public final GraalHotSpotVMConfig config = rt.getVMConfig();
172
173 public CheckGraalIntrinsics() {
174 // These are dead
175 add(ignore,
176 "java/lang/Math.atan2(DD)D",
177 "jdk/internal/misc/Unsafe.park(ZJ)V",
178 "jdk/internal/misc/Unsafe.unpark(Ljava/lang/Object;)V",
179 "sun/misc/Unsafe.park(ZJ)V",
180 "sun/misc/Unsafe.prefetchRead(Ljava/lang/Object;J)V",
181 "sun/misc/Unsafe.prefetchReadStatic(Ljava/lang/Object;J)V",
182 "sun/misc/Unsafe.prefetchWrite(Ljava/lang/Object;J)V",
183 "sun/misc/Unsafe.prefetchWriteStatic(Ljava/lang/Object;J)V",
184 "sun/misc/Unsafe.unpark(Ljava/lang/Object;)V");
185
186 // These only exist to assist escape analysis in C2
187 add(ignore,
188 "java/lang/Throwable.fillInStackTrace()Ljava/lang/Throwable;");
189
190 // These are only used for the security handling during stack walking
191 add(ignore,
192 "java/lang/reflect/Method.invoke(Ljava/lang/Object;[Ljava/lang/Object;)Ljava/lang/Object;");
193
194 // These are marker intrinsic ids only
195 add(ignore,
196 "java/lang/invoke/MethodHandle.<compiledLambdaForm>*",
197 "java/lang/invoke/MethodHandle.invoke*");
198
199 // These are implemented through lowering
200 add(ignore,
201 "java/lang/ref/Reference.get()Ljava/lang/Object;");
202
203 // These are only used by C1
204 add(ignore,
205 "java/nio/Buffer.checkIndex(I)I");
206
207 // These do general compiler optimizations and convert min/max to cmov instructions. We are
208 // ignoring them as cmovs are not necessarily beneficial.
209 add(ignore,
210 "java/lang/Math.max(II)I",
211 "java/lang/Math.min(II)I");
212
213 // These are known to be implemented down stream
214 add(downstream,
215 "java/lang/Integer.toString(I)Ljava/lang/String;",
216 "java/lang/String.<init>(Ljava/lang/String;)V",
217 "java/lang/StringBuffer.<init>()V",
218 "java/lang/StringBuffer.<init>(I)V",
219 "java/lang/StringBuffer.<init>(Ljava/lang/String;)V",
220 "java/lang/StringBuffer.append(C)Ljava/lang/StringBuffer;",
221 "java/lang/StringBuffer.append(I)Ljava/lang/StringBuffer;",
222 "java/lang/StringBuffer.append(Ljava/lang/String;)Ljava/lang/StringBuffer;",
223 "java/lang/StringBuffer.toString()Ljava/lang/String;",
224 "java/lang/StringBuilder.<init>()V",
225 "java/lang/StringBuilder.<init>(I)V",
226 "java/lang/StringBuilder.<init>(Ljava/lang/String;)V",
227 "java/lang/StringBuilder.append(C)Ljava/lang/StringBuilder;",
228 "java/lang/StringBuilder.append(I)Ljava/lang/StringBuilder;",
229 "java/lang/StringBuilder.append(Ljava/lang/String;)Ljava/lang/StringBuilder;",
230 "java/lang/StringBuilder.toString()Ljava/lang/String;",
231 "java/util/Arrays.copyOf([Ljava/lang/Object;ILjava/lang/Class;)[Ljava/lang/Object;",
232 "java/util/Arrays.copyOfRange([Ljava/lang/Object;IILjava/lang/Class;)[Ljava/lang/Object;");
233
234 add(complexGuard,
235 "java/lang/Integer.bitCount(I)I",
236 "java/lang/Integer.numberOfLeadingZeros(I)I",
237 "java/lang/Integer.numberOfTrailingZeros(I)I",
238 "java/lang/Long.bitCount(J)I",
239 "java/lang/Long.numberOfLeadingZeros(J)I",
240 "java/lang/Long.numberOfTrailingZeros(J)I");
241
242 // Relevant for Java flight recorder
243 add(toBeInvestigated,
244 "oracle/jrockit/jfr/Timing.counterTime()J",
245 "oracle/jrockit/jfr/VMJFR.classID0(Ljava/lang/Class;)J",
246 "oracle/jrockit/jfr/VMJFR.threadID()I");
247
248 add(toBeInvestigated,
249 // Similar to addExact
250 "java/lang/Math.negateExact(I)I",
251 // Similar to addExact
252 "java/lang/Math.negateExact(J)J",
253 // HotSpot MacroAssembler-based intrinsic
254 "java/lang/String.indexOf(Ljava/lang/String;)I",
255 // Can share most implementation parts with with
256 // Unsafe.allocateUninitializedArray0
257 "java/lang/reflect/Array.newArray(Ljava/lang/Class;I)Ljava/lang/Object;",
258 // HotSpot MacroAssembler-based intrinsic
259 "sun/nio/cs/ISO_8859_1$Encoder.encodeISOArray([CI[BII)I",
260 // Stub based intrinsics but implementation seems complex in C2
261 "sun/security/provider/DigestBase.implCompressMultiBlock([BII)I");
262
263 // See JDK-8207146.
264 String oopName = isJDK12OrHigher() ? "Reference" : "Object";
265
266 if (isJDK9OrHigher()) {
267 // Relevant for Java flight recorder
268 add(toBeInvestigated,
269 "jdk/jfr/internal/JVM.counterTime()J",
270 "jdk/jfr/internal/JVM.getBufferWriter()Ljava/lang/Object;",
271 "jdk/jfr/internal/JVM.getClassId(Ljava/lang/Class;)J");
272
273 add(toBeInvestigated,
274 // Some logic and a stub call
275 "com/sun/crypto/provider/CounterMode.implCrypt([BII[BI)I",
276 // Stub and very little logic
277 "com/sun/crypto/provider/GHASH.processBlocks([BII[J[J)V",
278 // HotSpot MacroAssembler-based intrinsic
279 "java/lang/Math.fma(DDD)D",
280 // HotSpot MacroAssembler-based intrinsic
281 "java/lang/Math.fma(FFF)F",
282 // Just check if the argument is a compile time constant
283 "java/lang/invoke/MethodHandleImpl.isCompileConstant(Ljava/lang/Object;)Z",
284 // Some logic and a runtime call
285 "java/util/ArraysSupport.vectorizedMismatch(Ljava/lang/Object;JLjava/lang/Object;JII)I",
286 // Only used as a marker for vectorization?
287 "java/util/stream/Streams$RangeIntSpliterator.forEachRemaining(Ljava/util/function/IntConsumer;)V",
288 // Only implemented on non-AMD64 platforms (some logic and runtime call)
289 "java/util/zip/Adler32.updateByteBuffer(IJII)I",
290 // Only implemented on non-AMD64 platforms (some logic and runtime call)
291 "java/util/zip/Adler32.updateBytes(I[BII)I",
292 // Emits a slow and a fast path and some dispatching logic
293 "jdk/internal/misc/Unsafe.allocateUninitializedArray0(Ljava/lang/Class;I)Ljava/lang/Object;",
294
295 // Control flow, deopts, and a cast
296 "jdk/internal/util/Preconditions.checkIndex(IILjava/util/function/BiFunction;)I",
297 // HotSpot MacroAssembler-based intrinsic
298 "sun/nio/cs/ISO_8859_1$Encoder.implEncodeISOArray([CI[BII)I",
299 // Runtime call and some complex compiler logic
300 "sun/security/provider/DigestBase.implCompressMultiBlock0([BII)I");
301
302 /*
303 * Per default, all these operations are mapped to some generic method for which we
304 * already have compiler intrinsics. Performance-wise it would be better to support them
305 * explicitly as the more generic method might be more restrictive and therefore slower
306 * than necessary.
307 */
308
309 add(toBeInvestigated,
310 // Mapped to compareAndExchange*
311 "jdk/internal/misc/Unsafe.compareAndExchangeByteAcquire(Ljava/lang/Object;JBB)B",
312 "jdk/internal/misc/Unsafe.compareAndExchangeByteRelease(Ljava/lang/Object;JBB)B",
313 "jdk/internal/misc/Unsafe.compareAndExchangeIntAcquire(Ljava/lang/Object;JII)I",
314 "jdk/internal/misc/Unsafe.compareAndExchangeIntRelease(Ljava/lang/Object;JII)I",
315 "jdk/internal/misc/Unsafe.compareAndExchangeLongAcquire(Ljava/lang/Object;JJJ)J",
316 "jdk/internal/misc/Unsafe.compareAndExchangeLongRelease(Ljava/lang/Object;JJJ)J",
317 "jdk/internal/misc/Unsafe.compareAndExchange" + oopName + "Acquire(Ljava/lang/Object;JLjava/lang/Object;Ljava/lang/Object;)Ljava/lang/Object;",
318 "jdk/internal/misc/Unsafe.compareAndExchange" + oopName + "Release(Ljava/lang/Object;JLjava/lang/Object;Ljava/lang/Object;)Ljava/lang/Object;",
319 "jdk/internal/misc/Unsafe.compareAndExchangeShortAcquire(Ljava/lang/Object;JSS)S",
320 "jdk/internal/misc/Unsafe.compareAndExchangeShortRelease(Ljava/lang/Object;JSS)S",
321
322 // Mapped to compareAndSet*
323 "jdk/internal/misc/Unsafe.weakCompareAndSetByte(Ljava/lang/Object;JBB)Z",
324 "jdk/internal/misc/Unsafe.weakCompareAndSetByteAcquire(Ljava/lang/Object;JBB)Z",
325 "jdk/internal/misc/Unsafe.weakCompareAndSetBytePlain(Ljava/lang/Object;JBB)Z",
326 "jdk/internal/misc/Unsafe.weakCompareAndSetByteRelease(Ljava/lang/Object;JBB)Z",
327 "jdk/internal/misc/Unsafe.weakCompareAndSetInt(Ljava/lang/Object;JII)Z",
328 "jdk/internal/misc/Unsafe.weakCompareAndSetIntAcquire(Ljava/lang/Object;JII)Z",
329 "jdk/internal/misc/Unsafe.weakCompareAndSetIntPlain(Ljava/lang/Object;JII)Z",
330 "jdk/internal/misc/Unsafe.weakCompareAndSetIntRelease(Ljava/lang/Object;JII)Z",
331 "jdk/internal/misc/Unsafe.weakCompareAndSetLong(Ljava/lang/Object;JJJ)Z",
332 "jdk/internal/misc/Unsafe.weakCompareAndSetLongAcquire(Ljava/lang/Object;JJJ)Z",
333 "jdk/internal/misc/Unsafe.weakCompareAndSetLongPlain(Ljava/lang/Object;JJJ)Z",
334 "jdk/internal/misc/Unsafe.weakCompareAndSetLongRelease(Ljava/lang/Object;JJJ)Z",
335 "jdk/internal/misc/Unsafe.weakCompareAndSet" + oopName + "(Ljava/lang/Object;JLjava/lang/Object;Ljava/lang/Object;)Z",
336 "jdk/internal/misc/Unsafe.weakCompareAndSet" + oopName + "Acquire(Ljava/lang/Object;JLjava/lang/Object;Ljava/lang/Object;)Z",
337 "jdk/internal/misc/Unsafe.weakCompareAndSet" + oopName + "Plain(Ljava/lang/Object;JLjava/lang/Object;Ljava/lang/Object;)Z",
338 "jdk/internal/misc/Unsafe.weakCompareAndSet" + oopName + "Release(Ljava/lang/Object;JLjava/lang/Object;Ljava/lang/Object;)Z",
339 "jdk/internal/misc/Unsafe.weakCompareAndSetShort(Ljava/lang/Object;JSS)Z",
340 "jdk/internal/misc/Unsafe.weakCompareAndSetShortAcquire(Ljava/lang/Object;JSS)Z",
341 "jdk/internal/misc/Unsafe.weakCompareAndSetShortPlain(Ljava/lang/Object;JSS)Z",
342 "jdk/internal/misc/Unsafe.weakCompareAndSetShortRelease(Ljava/lang/Object;JSS)Z");
343
344 // Compact string support - HotSpot MacroAssembler-based intrinsic or complex C2 logic.
345 add(toBeInvestigated,
346 "java/lang/StringCoding.hasNegatives([BII)Z",
347 "java/lang/StringCoding.implEncodeISOArray([BI[BII)I",
348 "java/lang/StringLatin1.indexOf([B[B)I",
349 "java/lang/StringUTF16.getChar([BI)C",
350 "java/lang/StringUTF16.getChars([BII[CI)V",
351 "java/lang/StringUTF16.indexOf([BI[BII)I",
352 "java/lang/StringUTF16.indexOf([B[B)I",
353 "java/lang/StringUTF16.indexOfChar([BIII)I",
354 "java/lang/StringUTF16.indexOfLatin1([BI[BII)I",
355 "java/lang/StringUTF16.indexOfLatin1([B[B)I",
356 "java/lang/StringUTF16.putChar([BII)V",
357 "java/lang/StringUTF16.toBytes([CII)[B");
358 // These are handled through an intrinsic for String.equals itself
359 add(ignore,
360 "java/lang/StringLatin1.equals([B[B)Z",
361 "java/lang/StringUTF16.equals([B[B)Z");
362 }
363
364 if (isJDK10OrHigher()) {
365 add(toBeInvestigated,
366 "java/lang/Math.multiplyHigh(JJ)J",
367 "jdk/internal/util/ArraysSupport.vectorizedMismatch(Ljava/lang/Object;JLjava/lang/Object;JII)I");
368 }
369
370 if (isJDK11OrHigher()) {
371 // Relevant for Java flight recorder
372 add(toBeInvestigated,
373 "java/util/Base64$Encoder.encodeBlock([BII[BIZ)V",
374 "jdk/jfr/internal/JVM.getEventWriter()Ljava/lang/Object;");
375 }
376
377 if (isJDK12OrHigher()) {
378 add(toBeInvestigated,
379 "java/lang/CharacterDataLatin1.isDigit(I)Z",
380 "java/lang/CharacterDataLatin1.isLowerCase(I)Z",
381 "java/lang/CharacterDataLatin1.isUpperCase(I)Z",
382 "java/lang/CharacterDataLatin1.isWhitespace(I)Z");
383 }
384
385 if (!config.inlineNotify()) {
386 add(ignore, "java/lang/Object.notify()V");
387 }
388 if (!config.inlineNotifyAll()) {
389 add(ignore, "java/lang/Object.notifyAll()V");
390 }
391
392 if (!(arch instanceof AMD64)) {
393 // Can we implement these on non-AMD64 platforms? C2 seems to.
394 add(toBeInvestigated,
395 "java/lang/String.compareTo(Ljava/lang/String;)I",
396 "java/lang/StringLatin1.inflate([BI[BII)V",
397 "java/lang/StringLatin1.inflate([BI[CII)V",
398 "java/lang/StringUTF16.compress([BI[BII)I",
399 "java/lang/StringUTF16.compress([CI[BII)I",
400 "jdk/internal/misc/Unsafe.compareAndExchangeByte(Ljava/lang/Object;JBB)B",
401 "jdk/internal/misc/Unsafe.compareAndExchangeShort(Ljava/lang/Object;JSS)S",
402 "jdk/internal/misc/Unsafe.compareAndSetByte(Ljava/lang/Object;JBB)Z",
403 "jdk/internal/misc/Unsafe.compareAndSetShort(Ljava/lang/Object;JSS)Z",
404 "jdk/internal/misc/Unsafe.getAndAddByte(Ljava/lang/Object;JB)B",
405 "jdk/internal/misc/Unsafe.getAndAddShort(Ljava/lang/Object;JS)S",
406 "jdk/internal/misc/Unsafe.getAndSetByte(Ljava/lang/Object;JB)B",
407 "jdk/internal/misc/Unsafe.getAndSetShort(Ljava/lang/Object;JS)S",
408 "sun/misc/Unsafe.getAndAddInt(Ljava/lang/Object;JI)I",
409 "sun/misc/Unsafe.getAndAddLong(Ljava/lang/Object;JJ)J",
410 "sun/misc/Unsafe.getAndSetInt(Ljava/lang/Object;JI)I",
411 "sun/misc/Unsafe.getAndSetLong(Ljava/lang/Object;JJ)J",
412 "sun/misc/Unsafe.getAndSet" + oopName + "(Ljava/lang/Object;JLjava/lang/Object;)Ljava/lang/Object;");
413
414 if (isJDK9OrHigher()) {
415 if (!(arch instanceof AArch64)) {
416 add(toBeInvestigated,
417 "java/lang/StringLatin1.compareTo([B[B)I",
418 "java/lang/StringLatin1.compareToUTF16([B[B)I",
419 "java/lang/StringUTF16.compareTo([B[B)I",
420 "java/lang/StringUTF16.compareToLatin1([B[B)I",
421 "jdk/internal/misc/Unsafe.getAndAddInt(Ljava/lang/Object;JI)I",
422 "jdk/internal/misc/Unsafe.getAndAddLong(Ljava/lang/Object;JJ)J",
423 "jdk/internal/misc/Unsafe.getAndSetInt(Ljava/lang/Object;JI)I",
424 "jdk/internal/misc/Unsafe.getAndSetLong(Ljava/lang/Object;JJ)J",
425 "jdk/internal/misc/Unsafe.getAndSet" + oopName + "(Ljava/lang/Object;JLjava/lang/Object;)Ljava/lang/Object;");
426 }
427 add(toBeInvestigated,
428 "java/lang/Thread.onSpinWait()V",
429 "jdk/internal/misc/Unsafe.getCharUnaligned(Ljava/lang/Object;J)C",
430 "jdk/internal/misc/Unsafe.getIntUnaligned(Ljava/lang/Object;J)I",
431 "jdk/internal/misc/Unsafe.getLongUnaligned(Ljava/lang/Object;J)J",
432 "jdk/internal/misc/Unsafe.getShortUnaligned(Ljava/lang/Object;J)S",
433 "jdk/internal/misc/Unsafe.putCharUnaligned(Ljava/lang/Object;JC)V",
434 "jdk/internal/misc/Unsafe.putIntUnaligned(Ljava/lang/Object;JI)V",
435 "jdk/internal/misc/Unsafe.putLongUnaligned(Ljava/lang/Object;JJ)V",
436 "jdk/internal/misc/Unsafe.putShortUnaligned(Ljava/lang/Object;JS)V");
437 }
438 }
439
440 /*
441 * The intrinsics down here are known to be implemented but they are not always enabled on
442 * the HotSpot side (e.g., because they require certain CPU features). So, we are ignoring
443 * them if the HotSpot config tells us that they can't be used.
444 */
445
446 // CRC32 intrinsics
447 if (!config.useCRC32Intrinsics) {
448 add(ignore, "java/util/zip/CRC32.update(II)I");
449 if (isJDK9OrHigher()) {
450 add(ignore,
451 "java/util/zip/CRC32.updateByteBuffer0(IJII)I",
452 "java/util/zip/CRC32.updateBytes0(I[BII)I");
453 } else {
454 add(ignore,
455 "java/util/zip/CRC32.updateByteBuffer(IJII)I",
456 "java/util/zip/CRC32.updateBytes(I[BII)I");
457 }
458 }
459
460 // CRC32C intrinsics
461 if (!config.useCRC32CIntrinsics) {
462 add(ignore,
463 "java/util/zip/CRC32C.updateBytes(I[BII)I",
464 "java/util/zip/CRC32C.updateDirectByteBuffer(IJII)I");
465 }
466
467 // AES intrinsics
468 if (!config.useAESIntrinsics) {
469 if (isJDK9OrHigher()) {
470 add(ignore,
471 "com/sun/crypto/provider/AESCrypt.implDecryptBlock([BI[BI)V",
472 "com/sun/crypto/provider/AESCrypt.implEncryptBlock([BI[BI)V",
473 "com/sun/crypto/provider/CipherBlockChaining.implDecrypt([BII[BI)I",
474 "com/sun/crypto/provider/CipherBlockChaining.implEncrypt([BII[BI)I");
475 } else {
476 add(ignore,
477 "com/sun/crypto/provider/AESCrypt.decryptBlock([BI[BI)V",
478 "com/sun/crypto/provider/AESCrypt.encryptBlock([BI[BI)V",
479 "com/sun/crypto/provider/CipherBlockChaining.decrypt([BII[BI)I",
480 "com/sun/crypto/provider/CipherBlockChaining.encrypt([BII[BI)I");
481 }
482 }
483
484 // BigInteger intrinsics
485 if (!config.useMultiplyToLenIntrinsic()) {
486 if (isJDK9OrHigher()) {
487 add(ignore, "java/math/BigInteger.implMultiplyToLen([II[II[I)[I");
488 } else {
489 add(ignore, "java/math/BigInteger.multiplyToLen([II[II[I)[I");
490 }
491 }
492 if (!config.useMulAddIntrinsic()) {
493 add(ignore, "java/math/BigInteger.implMulAdd([I[IIII)I");
494 }
495 if (!config.useMontgomeryMultiplyIntrinsic()) {
496 add(ignore, "java/math/BigInteger.implMontgomeryMultiply([I[I[IIJ[I)[I");
497 }
498 if (!config.useMontgomerySquareIntrinsic()) {
499 add(ignore, "java/math/BigInteger.implMontgomerySquare([I[IIJ[I)[I");
500 }
501 if (!config.useSquareToLenIntrinsic()) {
502 add(ignore, "java/math/BigInteger.implSquareToLen([II[II)[I");
503 }
504
505 // SHA intrinsics
506 if (!config.useSHA1Intrinsics()) {
507 if (isJDK9OrHigher()) {
508 add(ignore, "sun/security/provider/SHA.implCompress0([BI)V");
509 } else {
510 add(ignore, "sun/security/provider/SHA.implCompress([BI)V");
511 }
512 }
513 if (!config.useSHA256Intrinsics()) {
514 if (isJDK9OrHigher()) {
515 add(ignore, "sun/security/provider/SHA2.implCompress0([BI)V");
516 } else {
517 add(ignore, "sun/security/provider/SHA2.implCompress([BI)V");
518 }
519 }
520 if (!config.useSHA512Intrinsics()) {
521 if (isJDK9OrHigher()) {
522 add(ignore, "sun/security/provider/SHA5.implCompress0([BI)V");
523 } else {
524 add(ignore, "sun/security/provider/SHA5.implCompress([BI)V");
525 }
526 }
527 }
528
529 private static boolean isJDK9OrHigher() {
530 return GraalServices.JAVA_SPECIFICATION_VERSION >= 9;
531 }
532
533 private static boolean isJDK10OrHigher() {
534 return GraalServices.JAVA_SPECIFICATION_VERSION >= 10;
535 }
536
537 private static boolean isJDK11OrHigher() {
538 return GraalServices.JAVA_SPECIFICATION_VERSION >= 11;
539 }
540
541 private static boolean isJDK12OrHigher() {
542 return GraalServices.JAVA_SPECIFICATION_VERSION >= 12;
543 }
544
545 public interface Refiner {
546 void refine(CheckGraalIntrinsics checker);
547 }
548
549 @Test
550 @SuppressWarnings("try")
551 public void test() throws ClassNotFoundException {
552 HotSpotProviders providers = rt.getHostBackend().getProviders();
553 Plugins graphBuilderPlugins = providers.getGraphBuilderPlugins();
554 InvocationPlugins invocationPlugins = graphBuilderPlugins.getInvocationPlugins();
555
556 HotSpotVMConfigStore store = config.getStore();
557 List<VMIntrinsicMethod> intrinsics = store.getIntrinsics();
558
559 for (Refiner refiner : ServiceLoader.load(Refiner.class)) {
560 refiner.refine(this);
561 }
562
563 List<String> missing = new ArrayList<>();
564 List<String> mischaracterizedAsToBeInvestigated = new ArrayList<>();
565 List<String> mischaracterizedAsIgnored = new ArrayList<>();
566 EconomicMap<String, List<Binding>> bindings = invocationPlugins.getBindings(true);
567 for (VMIntrinsicMethod intrinsic : intrinsics) {
568 InvocationPlugin plugin = findPlugin(bindings, intrinsic);
569 String m = String.format("%s.%s%s", intrinsic.declaringClass, intrinsic.name, intrinsic.descriptor);
570 if (plugin == null) {
571 ResolvedJavaMethod method = resolveIntrinsic(providers.getMetaAccess(), intrinsic);
572 if (method != null) {
573 IntrinsicMethod intrinsicMethod = providers.getConstantReflection().getMethodHandleAccess().lookupMethodHandleIntrinsic(method);
574 if (intrinsicMethod != null) {
575 continue;
576 }
577 }
578 if (!toBeInvestigated.contains(m) && !ignore.contains(m) && !complexGuard.contains(m) && !downstream.contains(m)) {
579 missing.add(m);
580 }
581 } else {
582 if (toBeInvestigated.contains(m)) {
583 mischaracterizedAsToBeInvestigated.add(m);
584 } else if (ignore.contains(m)) {
585 mischaracterizedAsIgnored.add(m);
586 }
587 }
588 }
589
590 Formatter errorMsgBuf = new Formatter();
591 if (!missing.isEmpty()) {
592 Collections.sort(missing);
593 String missingString = missing.stream().collect(Collectors.joining(String.format("%n ")));
594 errorMsgBuf.format("missing Graal intrinsics for:%n %s%n", missingString);
595 }
596 if (!mischaracterizedAsToBeInvestigated.isEmpty()) {
597 Collections.sort(mischaracterizedAsToBeInvestigated);
598 String missingString = mischaracterizedAsToBeInvestigated.stream().collect(Collectors.joining(String.format("%n ")));
599 errorMsgBuf.format("found plugins for intrinsics characterized as toBeInvestigated:%n %s%n", missingString);
600 }
601 if (!mischaracterizedAsIgnored.isEmpty()) {
602 Collections.sort(mischaracterizedAsIgnored);
603 String missingString = mischaracterizedAsIgnored.stream().collect(Collectors.joining(String.format("%n ")));
604 errorMsgBuf.format("found plugins for intrinsics characterized as IGNORED:%n %s%n", missingString);
605 }
606 String errorMsg = errorMsgBuf.toString();
607 if (!errorMsg.isEmpty()) {
608 fail(errorMsg);
609 }
610 }
611 }