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