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