1 /*
  2  * Copyright (c) 2020, 2023, 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 #include "precompiled.hpp"
 26 #include "classfile/vmIntrinsics.hpp"
 27 #include "classfile/vmSymbols.hpp"
 28 #include "compiler/compilerDirectives.hpp"
 29 #include "jvm_constants.h"
 30 #include "jvm_io.h"
 31 #include "runtime/vm_version.hpp"
 32 #include "utilities/xmlstream.hpp"
 33 
 34 // These are flag-matching functions:
 35 inline bool match_F_R(jshort flags) {
 36   const int req = 0;
 37   const int neg = JVM_ACC_STATIC | JVM_ACC_SYNCHRONIZED | JVM_ACC_NATIVE;
 38   return (flags & (req | neg)) == req;
 39 }
 40 
 41 inline bool match_F_Y(jshort flags) {
 42   const int req = JVM_ACC_SYNCHRONIZED;
 43   const int neg = JVM_ACC_STATIC | JVM_ACC_NATIVE;
 44   return (flags & (req | neg)) == req;
 45 }
 46 
 47 inline bool match_F_RN(jshort flags) {
 48   const int req = JVM_ACC_NATIVE;
 49   const int neg = JVM_ACC_STATIC | JVM_ACC_SYNCHRONIZED;
 50   return (flags & (req | neg)) == req;
 51 }
 52 
 53 inline bool match_F_S(jshort flags) {
 54   const int req = JVM_ACC_STATIC;
 55   const int neg = JVM_ACC_SYNCHRONIZED | JVM_ACC_NATIVE;
 56   return (flags & (req | neg)) == req;
 57 }
 58 
 59 inline bool match_F_SN(jshort flags) {
 60   const int req = JVM_ACC_STATIC | JVM_ACC_NATIVE;
 61   const int neg = JVM_ACC_SYNCHRONIZED;
 62   return (flags & (req | neg)) == req;
 63 }
 64 
 65 bool vmIntrinsics::preserves_state(vmIntrinsics::ID id) {
 66   assert(id != vmIntrinsics::_none, "must be a VM intrinsic");
 67   switch(id) {
 68 #ifdef JFR_HAVE_INTRINSICS
 69   case vmIntrinsics::_counterTime:
 70 #endif
 71   case vmIntrinsics::_currentTimeMillis:
 72   case vmIntrinsics::_nanoTime:
 73   case vmIntrinsics::_floatToRawIntBits:
 74   case vmIntrinsics::_intBitsToFloat:
 75   case vmIntrinsics::_doubleToRawLongBits:
 76   case vmIntrinsics::_longBitsToDouble:
 77   case vmIntrinsics::_getClass:
 78   case vmIntrinsics::_isInstance:
 79   case vmIntrinsics::_currentCarrierThread:
 80   case vmIntrinsics::_currentThread:
 81   case vmIntrinsics::_scopedValueCache:
 82   case vmIntrinsics::_dabs:
 83   case vmIntrinsics::_fabs:
 84   case vmIntrinsics::_iabs:
 85   case vmIntrinsics::_labs:
 86   case vmIntrinsics::_dsqrt:
 87   case vmIntrinsics::_dsqrt_strict:
 88   case vmIntrinsics::_dsin:
 89   case vmIntrinsics::_dcos:
 90   case vmIntrinsics::_dtan:
 91   case vmIntrinsics::_dlog:
 92   case vmIntrinsics::_dlog10:
 93   case vmIntrinsics::_dexp:
 94   case vmIntrinsics::_dpow:
 95   case vmIntrinsics::_Preconditions_checkIndex:
 96   case vmIntrinsics::_Preconditions_checkLongIndex:
 97   case vmIntrinsics::_Reference_get:
 98   case vmIntrinsics::_Continuation_doYield:
 99   case vmIntrinsics::_updateCRC32:
100   case vmIntrinsics::_updateBytesCRC32:
101   case vmIntrinsics::_updateByteBufferCRC32:
102   case vmIntrinsics::_updateBytesAdler32:
103   case vmIntrinsics::_vectorizedMismatch:
104   case vmIntrinsics::_fmaD:
105   case vmIntrinsics::_fmaF:
106   case vmIntrinsics::_isDigit:
107   case vmIntrinsics::_isLowerCase:
108   case vmIntrinsics::_isUpperCase:
109   case vmIntrinsics::_isWhitespace:
110     return true;
111   default:
112     return false;
113   }
114 }
115 
116 bool vmIntrinsics::can_trap(vmIntrinsics::ID id) {
117   assert(id != vmIntrinsics::_none, "must be a VM intrinsic");
118   switch(id) {
119 #ifdef JFR_HAVE_INTRINSICS
120   case vmIntrinsics::_counterTime:
121 #endif
122   case vmIntrinsics::_currentTimeMillis:
123   case vmIntrinsics::_nanoTime:
124   case vmIntrinsics::_floatToRawIntBits:
125   case vmIntrinsics::_intBitsToFloat:
126   case vmIntrinsics::_doubleToRawLongBits:
127   case vmIntrinsics::_longBitsToDouble:
128   case vmIntrinsics::_currentCarrierThread:
129   case vmIntrinsics::_currentThread:
130   case vmIntrinsics::_setCurrentThread:
131   case vmIntrinsics::_scopedValueCache:
132   case vmIntrinsics::_setScopedValueCache:
133   case vmIntrinsics::_dabs:
134   case vmIntrinsics::_fabs:
135   case vmIntrinsics::_iabs:
136   case vmIntrinsics::_labs:
137   case vmIntrinsics::_dsqrt:
138   case vmIntrinsics::_dsqrt_strict:
139   case vmIntrinsics::_dsin:
140   case vmIntrinsics::_dcos:
141   case vmIntrinsics::_dtan:
142   case vmIntrinsics::_dlog:
143   case vmIntrinsics::_dlog10:
144   case vmIntrinsics::_dexp:
145   case vmIntrinsics::_dpow:
146   case vmIntrinsics::_updateCRC32:
147   case vmIntrinsics::_updateBytesCRC32:
148   case vmIntrinsics::_updateByteBufferCRC32:
149   case vmIntrinsics::_vectorizedMismatch:
150   case vmIntrinsics::_fmaD:
151   case vmIntrinsics::_fmaF:
152     return false;
153   default:
154     return true;
155   }
156 }
157 
158 // Some intrinsics produce different results if they are not pinned
159 bool vmIntrinsics::should_be_pinned(vmIntrinsics::ID id) {
160   assert(id != vmIntrinsics::_none, "must be a VM intrinsic");
161   switch(id) {
162 #ifdef JFR_HAVE_INTRINSICS
163   case vmIntrinsics::_counterTime:
164 #endif
165   case vmIntrinsics::_currentTimeMillis:
166   case vmIntrinsics::_nanoTime:
167   case vmIntrinsics::_blackhole:
168     return true;
169   default:
170     return false;
171   }
172 }
173 
174 bool vmIntrinsics::does_virtual_dispatch(vmIntrinsics::ID id) {
175   assert(id != vmIntrinsics::_none, "must be a VM intrinsic");
176   switch(id) {
177   case vmIntrinsics::_hashCode:
178   case vmIntrinsics::_clone:
179     return true;
180     break;
181   default:
182     return false;
183   }
184 }
185 
186 int vmIntrinsics::predicates_needed(vmIntrinsics::ID id) {
187   assert(id != vmIntrinsics::_none, "must be a VM intrinsic");
188   switch (id) {
189   case vmIntrinsics::_cipherBlockChaining_encryptAESCrypt:
190   case vmIntrinsics::_cipherBlockChaining_decryptAESCrypt:
191   case vmIntrinsics::_electronicCodeBook_encryptAESCrypt:
192   case vmIntrinsics::_electronicCodeBook_decryptAESCrypt:
193   case vmIntrinsics::_counterMode_AESCrypt:
194   case vmIntrinsics::_galoisCounterMode_AESCrypt:
195     return 1;
196   case vmIntrinsics::_digestBase_implCompressMB:
197     return 5;
198   default:
199     return 0;
200   }
201 }
202 
203 bool vmIntrinsics::disabled_by_jvm_flags(vmIntrinsics::ID id) {
204   assert(id != vmIntrinsics::_none, "must be a VM intrinsic");
205 
206   // -XX:-InlineNatives disables nearly all intrinsics except the ones listed in
207   // the following switch statement.
208   if (!InlineNatives) {
209     switch (id) {
210     case vmIntrinsics::_indexOfL:
211     case vmIntrinsics::_indexOfU:
212     case vmIntrinsics::_indexOfUL:
213     case vmIntrinsics::_indexOfIL:
214     case vmIntrinsics::_indexOfIU:
215     case vmIntrinsics::_indexOfIUL:
216     case vmIntrinsics::_indexOfU_char:
217     case vmIntrinsics::_indexOfL_char:
218     case vmIntrinsics::_compareToL:
219     case vmIntrinsics::_compareToU:
220     case vmIntrinsics::_compareToLU:
221     case vmIntrinsics::_compareToUL:
222     case vmIntrinsics::_equalsL:
223     case vmIntrinsics::_equalsU:
224     case vmIntrinsics::_equalsC:
225     case vmIntrinsics::_vectorizedHashCode:
226     case vmIntrinsics::_getCharStringU:
227     case vmIntrinsics::_putCharStringU:
228     case vmIntrinsics::_compressStringC:
229     case vmIntrinsics::_compressStringB:
230     case vmIntrinsics::_inflateStringC:
231     case vmIntrinsics::_inflateStringB:
232     case vmIntrinsics::_getAndAddInt:
233     case vmIntrinsics::_getAndAddLong:
234     case vmIntrinsics::_getAndSetInt:
235     case vmIntrinsics::_getAndSetLong:
236     case vmIntrinsics::_getAndSetReference:
237     case vmIntrinsics::_loadFence:
238     case vmIntrinsics::_storeFence:
239     case vmIntrinsics::_fullFence:
240     case vmIntrinsics::_countPositives:
241     case vmIntrinsics::_Reference_get:
242     case vmIntrinsics::_Continuation_doYield:
243     case vmIntrinsics::_Continuation_enterSpecial:
244       break;
245     default:
246       return true;
247     }
248   }
249 
250   switch (id) {
251   case vmIntrinsics::_asPrimaryType:
252   case vmIntrinsics::_asPrimaryTypeArg:
253   case vmIntrinsics::_asValueType:
254   case vmIntrinsics::_asValueTypeArg:
255   case vmIntrinsics::_isInstance:
256   case vmIntrinsics::_isAssignableFrom:
257   case vmIntrinsics::_getModifiers:
258   case vmIntrinsics::_isInterface:
259   case vmIntrinsics::_isArray:
260   case vmIntrinsics::_isPrimitive:
261   case vmIntrinsics::_isHidden:
262   case vmIntrinsics::_getSuperclass:
263   case vmIntrinsics::_Class_cast:
264   case vmIntrinsics::_getLength:
265   case vmIntrinsics::_newArray:
266   case vmIntrinsics::_getClass:
267     if (!InlineClassNatives) return true;
268     break;
269   case vmIntrinsics::_currentCarrierThread:
270   case vmIntrinsics::_currentThread:
271     if (!InlineThreadNatives) return true;
272     break;
273   case vmIntrinsics::_setCurrentThread:
274   case vmIntrinsics::_scopedValueCache:
275   case vmIntrinsics::_setScopedValueCache:
276   case vmIntrinsics::_floatToRawIntBits:
277   case vmIntrinsics::_intBitsToFloat:
278   case vmIntrinsics::_doubleToRawLongBits:
279   case vmIntrinsics::_longBitsToDouble:
280   case vmIntrinsics::_ceil:
281   case vmIntrinsics::_floor:
282   case vmIntrinsics::_rint:
283   case vmIntrinsics::_dabs:
284   case vmIntrinsics::_fabs:
285   case vmIntrinsics::_iabs:
286   case vmIntrinsics::_labs:
287   case vmIntrinsics::_dsqrt:
288   case vmIntrinsics::_dsqrt_strict:
289   case vmIntrinsics::_dsin:
290   case vmIntrinsics::_dcos:
291   case vmIntrinsics::_dtan:
292   case vmIntrinsics::_dlog:
293   case vmIntrinsics::_dexp:
294   case vmIntrinsics::_dpow:
295   case vmIntrinsics::_dlog10:
296   case vmIntrinsics::_datan2:
297   case vmIntrinsics::_floatToIntBits:
298   case vmIntrinsics::_doubleToLongBits:
299   case vmIntrinsics::_min:
300   case vmIntrinsics::_max:
301   case vmIntrinsics::_maxF:
302   case vmIntrinsics::_minF:
303   case vmIntrinsics::_maxD:
304   case vmIntrinsics::_minD:
305   case vmIntrinsics::_min_strict:
306   case vmIntrinsics::_max_strict:
307   case vmIntrinsics::_maxF_strict:
308   case vmIntrinsics::_minF_strict:
309   case vmIntrinsics::_maxD_strict:
310   case vmIntrinsics::_minD_strict:
311     if (!InlineMathNatives) return true;
312     break;
313   case vmIntrinsics::_fmaD:
314   case vmIntrinsics::_fmaF:
315     if (!InlineMathNatives || !UseFMA) return true;
316     break;
317   case vmIntrinsics::_floatToFloat16:
318   case vmIntrinsics::_float16ToFloat:
319     if (!InlineIntrinsics) return true;
320     break;
321   case vmIntrinsics::_arraycopy:
322     if (!InlineArrayCopy) return true;
323     break;
324   case vmIntrinsics::_updateCRC32:
325   case vmIntrinsics::_updateBytesCRC32:
326   case vmIntrinsics::_updateByteBufferCRC32:
327     if (!UseCRC32Intrinsics) return true;
328     break;
329   case vmIntrinsics::_makePrivateBuffer:
330   case vmIntrinsics::_finishPrivateBuffer:
331   case vmIntrinsics::_getReference:
332   case vmIntrinsics::_getBoolean:
333   case vmIntrinsics::_getByte:
334   case vmIntrinsics::_getShort:
335   case vmIntrinsics::_getChar:
336   case vmIntrinsics::_getInt:
337   case vmIntrinsics::_getLong:
338   case vmIntrinsics::_getFloat:
339   case vmIntrinsics::_getDouble:
340   case vmIntrinsics::_getValue:
341   case vmIntrinsics::_putReference:
342   case vmIntrinsics::_putBoolean:
343   case vmIntrinsics::_putByte:
344   case vmIntrinsics::_putShort:
345   case vmIntrinsics::_putChar:
346   case vmIntrinsics::_putInt:
347   case vmIntrinsics::_putLong:
348   case vmIntrinsics::_putFloat:
349   case vmIntrinsics::_putDouble:
350   case vmIntrinsics::_putValue:
351   case vmIntrinsics::_getReferenceVolatile:
352   case vmIntrinsics::_getBooleanVolatile:
353   case vmIntrinsics::_getByteVolatile:
354   case vmIntrinsics::_getShortVolatile:
355   case vmIntrinsics::_getCharVolatile:
356   case vmIntrinsics::_getIntVolatile:
357   case vmIntrinsics::_getLongVolatile:
358   case vmIntrinsics::_getFloatVolatile:
359   case vmIntrinsics::_getDoubleVolatile:
360   case vmIntrinsics::_putReferenceVolatile:
361   case vmIntrinsics::_putBooleanVolatile:
362   case vmIntrinsics::_putByteVolatile:
363   case vmIntrinsics::_putShortVolatile:
364   case vmIntrinsics::_putCharVolatile:
365   case vmIntrinsics::_putIntVolatile:
366   case vmIntrinsics::_putLongVolatile:
367   case vmIntrinsics::_putFloatVolatile:
368   case vmIntrinsics::_putDoubleVolatile:
369   case vmIntrinsics::_getReferenceAcquire:
370   case vmIntrinsics::_getBooleanAcquire:
371   case vmIntrinsics::_getByteAcquire:
372   case vmIntrinsics::_getShortAcquire:
373   case vmIntrinsics::_getCharAcquire:
374   case vmIntrinsics::_getIntAcquire:
375   case vmIntrinsics::_getLongAcquire:
376   case vmIntrinsics::_getFloatAcquire:
377   case vmIntrinsics::_getDoubleAcquire:
378   case vmIntrinsics::_putReferenceRelease:
379   case vmIntrinsics::_putBooleanRelease:
380   case vmIntrinsics::_putByteRelease:
381   case vmIntrinsics::_putShortRelease:
382   case vmIntrinsics::_putCharRelease:
383   case vmIntrinsics::_putIntRelease:
384   case vmIntrinsics::_putLongRelease:
385   case vmIntrinsics::_putFloatRelease:
386   case vmIntrinsics::_putDoubleRelease:
387   case vmIntrinsics::_getReferenceOpaque:
388   case vmIntrinsics::_getBooleanOpaque:
389   case vmIntrinsics::_getByteOpaque:
390   case vmIntrinsics::_getShortOpaque:
391   case vmIntrinsics::_getCharOpaque:
392   case vmIntrinsics::_getIntOpaque:
393   case vmIntrinsics::_getLongOpaque:
394   case vmIntrinsics::_getFloatOpaque:
395   case vmIntrinsics::_getDoubleOpaque:
396   case vmIntrinsics::_putReferenceOpaque:
397   case vmIntrinsics::_putBooleanOpaque:
398   case vmIntrinsics::_putByteOpaque:
399   case vmIntrinsics::_putShortOpaque:
400   case vmIntrinsics::_putCharOpaque:
401   case vmIntrinsics::_putIntOpaque:
402   case vmIntrinsics::_putLongOpaque:
403   case vmIntrinsics::_putFloatOpaque:
404   case vmIntrinsics::_putDoubleOpaque:
405   case vmIntrinsics::_getAndAddInt:
406   case vmIntrinsics::_getAndAddLong:
407   case vmIntrinsics::_getAndSetInt:
408   case vmIntrinsics::_getAndSetLong:
409   case vmIntrinsics::_getAndSetReference:
410   case vmIntrinsics::_loadFence:
411   case vmIntrinsics::_storeFence:
412   case vmIntrinsics::_fullFence:
413   case vmIntrinsics::_compareAndSetLong:
414   case vmIntrinsics::_weakCompareAndSetLong:
415   case vmIntrinsics::_weakCompareAndSetLongPlain:
416   case vmIntrinsics::_weakCompareAndSetLongAcquire:
417   case vmIntrinsics::_weakCompareAndSetLongRelease:
418   case vmIntrinsics::_compareAndSetInt:
419   case vmIntrinsics::_weakCompareAndSetInt:
420   case vmIntrinsics::_weakCompareAndSetIntPlain:
421   case vmIntrinsics::_weakCompareAndSetIntAcquire:
422   case vmIntrinsics::_weakCompareAndSetIntRelease:
423   case vmIntrinsics::_compareAndSetReference:
424   case vmIntrinsics::_weakCompareAndSetReference:
425   case vmIntrinsics::_weakCompareAndSetReferencePlain:
426   case vmIntrinsics::_weakCompareAndSetReferenceAcquire:
427   case vmIntrinsics::_weakCompareAndSetReferenceRelease:
428   case vmIntrinsics::_compareAndExchangeInt:
429   case vmIntrinsics::_compareAndExchangeIntAcquire:
430   case vmIntrinsics::_compareAndExchangeIntRelease:
431   case vmIntrinsics::_compareAndExchangeLong:
432   case vmIntrinsics::_compareAndExchangeLongAcquire:
433   case vmIntrinsics::_compareAndExchangeLongRelease:
434   case vmIntrinsics::_compareAndExchangeReference:
435   case vmIntrinsics::_compareAndExchangeReferenceAcquire:
436   case vmIntrinsics::_compareAndExchangeReferenceRelease:
437   case vmIntrinsics::_allocateInstance:
438     if (!InlineUnsafeOps) return true;
439     break;
440   case vmIntrinsics::_getShortUnaligned:
441   case vmIntrinsics::_getCharUnaligned:
442   case vmIntrinsics::_getIntUnaligned:
443   case vmIntrinsics::_getLongUnaligned:
444   case vmIntrinsics::_putShortUnaligned:
445   case vmIntrinsics::_putCharUnaligned:
446   case vmIntrinsics::_putIntUnaligned:
447   case vmIntrinsics::_putLongUnaligned:
448     if (!InlineUnsafeOps || !UseUnalignedAccesses) return true;
449     break;
450   case vmIntrinsics::_hashCode:
451     if (!InlineObjectHash) return true;
452     break;
453   case vmIntrinsics::_aescrypt_encryptBlock:
454   case vmIntrinsics::_aescrypt_decryptBlock:
455     if (!UseAESIntrinsics) return true;
456     break;
457   case vmIntrinsics::_cipherBlockChaining_encryptAESCrypt:
458   case vmIntrinsics::_cipherBlockChaining_decryptAESCrypt:
459     if (!UseAESIntrinsics) return true;
460     break;
461   case vmIntrinsics::_electronicCodeBook_encryptAESCrypt:
462   case vmIntrinsics::_electronicCodeBook_decryptAESCrypt:
463     if (!UseAESIntrinsics) return true;
464     break;
465   case vmIntrinsics::_counterMode_AESCrypt:
466     if (!UseAESCTRIntrinsics) return true;
467     break;
468   case vmIntrinsics::_galoisCounterMode_AESCrypt:
469     if (!UseAESIntrinsics) return true;
470     break;
471   case vmIntrinsics::_md5_implCompress:
472     if (!UseMD5Intrinsics) return true;
473     break;
474   case vmIntrinsics::_sha_implCompress:
475     if (!UseSHA1Intrinsics) return true;
476     break;
477   case vmIntrinsics::_sha2_implCompress:
478     if (!UseSHA256Intrinsics) return true;
479     break;
480   case vmIntrinsics::_sha5_implCompress:
481     if (!UseSHA512Intrinsics) return true;
482     break;
483   case vmIntrinsics::_sha3_implCompress:
484     if (!UseSHA3Intrinsics) return true;
485     break;
486   case vmIntrinsics::_digestBase_implCompressMB:
487     if (!(UseMD5Intrinsics || UseSHA1Intrinsics || UseSHA256Intrinsics || UseSHA512Intrinsics || UseSHA3Intrinsics)) return true;
488     break;
489   case vmIntrinsics::_ghash_processBlocks:
490     if (!UseGHASHIntrinsics) return true;
491     break;
492   case vmIntrinsics::_chacha20Block:
493     if (!UseChaCha20Intrinsics) return true;
494     break;
495   case vmIntrinsics::_base64_encodeBlock:
496   case vmIntrinsics::_base64_decodeBlock:
497     if (!UseBASE64Intrinsics) return true;
498     break;
499   case vmIntrinsics::_poly1305_processBlocks:
500     if (!UsePoly1305Intrinsics) return true;
501     break;
502   case vmIntrinsics::_updateBytesCRC32C:
503   case vmIntrinsics::_updateDirectByteBufferCRC32C:
504     if (!UseCRC32CIntrinsics) return true;
505     break;
506   case vmIntrinsics::_vectorizedMismatch:
507     if (!UseVectorizedMismatchIntrinsic) return true;
508     break;
509   case vmIntrinsics::_updateBytesAdler32:
510   case vmIntrinsics::_updateByteBufferAdler32:
511     if (!UseAdler32Intrinsics) return true;
512     break;
513   case vmIntrinsics::_copyMemory:
514     if (!InlineArrayCopy || !InlineUnsafeOps) return true;
515     break;
516 #ifdef COMPILER2
517   case vmIntrinsics::_clone:
518   case vmIntrinsics::_copyOf:
519   case vmIntrinsics::_copyOfRange:
520     // These intrinsics use both the objectcopy and the arraycopy
521     // intrinsic mechanism.
522     if (!InlineObjectCopy || !InlineArrayCopy) return true;
523     break;
524   case vmIntrinsics::_compareToL:
525   case vmIntrinsics::_compareToU:
526   case vmIntrinsics::_compareToLU:
527   case vmIntrinsics::_compareToUL:
528     if (!SpecialStringCompareTo) return true;
529     break;
530   case vmIntrinsics::_indexOfL:
531   case vmIntrinsics::_indexOfU:
532   case vmIntrinsics::_indexOfUL:
533   case vmIntrinsics::_indexOfIL:
534   case vmIntrinsics::_indexOfIU:
535   case vmIntrinsics::_indexOfIUL:
536   case vmIntrinsics::_indexOfU_char:
537   case vmIntrinsics::_indexOfL_char:
538     if (!SpecialStringIndexOf) return true;
539     break;
540   case vmIntrinsics::_equalsL:
541   case vmIntrinsics::_equalsU:
542     if (!SpecialStringEquals) return true;
543     break;
544   case vmIntrinsics::_vectorizedHashCode:
545     if (!UseVectorizedHashCodeIntrinsic) return true;
546     break;
547   case vmIntrinsics::_equalsB:
548   case vmIntrinsics::_equalsC:
549     if (!SpecialArraysEquals) return true;
550     break;
551   case vmIntrinsics::_encodeISOArray:
552   case vmIntrinsics::_encodeAsciiArray:
553   case vmIntrinsics::_encodeByteISOArray:
554     if (!SpecialEncodeISOArray) return true;
555     break;
556   case vmIntrinsics::_getCallerClass:
557     if (!InlineReflectionGetCallerClass) return true;
558     break;
559   case vmIntrinsics::_multiplyToLen:
560     if (!UseMultiplyToLenIntrinsic) return true;
561     break;
562   case vmIntrinsics::_squareToLen:
563     if (!UseSquareToLenIntrinsic) return true;
564     break;
565   case vmIntrinsics::_mulAdd:
566     if (!UseMulAddIntrinsic) return true;
567     break;
568   case vmIntrinsics::_montgomeryMultiply:
569     if (!UseMontgomeryMultiplyIntrinsic) return true;
570     break;
571   case vmIntrinsics::_montgomerySquare:
572     if (!UseMontgomerySquareIntrinsic) return true;
573     break;
574   case vmIntrinsics::_bigIntegerRightShiftWorker:
575   case vmIntrinsics::_bigIntegerLeftShiftWorker:
576     break;
577   case vmIntrinsics::_addExactI:
578   case vmIntrinsics::_addExactL:
579   case vmIntrinsics::_decrementExactI:
580   case vmIntrinsics::_decrementExactL:
581   case vmIntrinsics::_incrementExactI:
582   case vmIntrinsics::_incrementExactL:
583   case vmIntrinsics::_multiplyExactI:
584   case vmIntrinsics::_multiplyExactL:
585   case vmIntrinsics::_negateExactI:
586   case vmIntrinsics::_negateExactL:
587   case vmIntrinsics::_subtractExactI:
588   case vmIntrinsics::_subtractExactL:
589     if (!UseMathExactIntrinsics || !InlineMathNatives) return true;
590     break;
591   case vmIntrinsics::_isDigit:
592   case vmIntrinsics::_isLowerCase:
593   case vmIntrinsics::_isUpperCase:
594   case vmIntrinsics::_isWhitespace:
595     if (!UseCharacterCompareIntrinsics) return true;
596     break;
597   case vmIntrinsics::_dcopySign:
598   case vmIntrinsics::_fcopySign:
599     if (!InlineMathNatives || !UseCopySignIntrinsic) return true;
600     break;
601   case vmIntrinsics::_dsignum:
602   case vmIntrinsics::_fsignum:
603     if (!InlineMathNatives || !UseSignumIntrinsic) return true;
604     break;
605 #endif // COMPILER2
606   default:
607     return false;
608   }
609 
610   return false;
611 }
612 
613 #define VM_INTRINSIC_INITIALIZE(id, klass, name, sig, flags) #id "\0"
614 static const char* vm_intrinsic_name_bodies =
615   VM_INTRINSICS_DO(VM_INTRINSIC_INITIALIZE,
616                    VM_SYMBOL_IGNORE, VM_SYMBOL_IGNORE, VM_SYMBOL_IGNORE, VM_ALIAS_IGNORE);
617 
618 static const char* vm_intrinsic_name_table[vmIntrinsics::number_of_intrinsics()];
619 static TriBoolArray<(size_t)vmIntrinsics::number_of_intrinsics(), int> vm_intrinsic_control_words;
620 
621 void vmIntrinsics::init_vm_intrinsic_name_table() {
622   const char** nt = &vm_intrinsic_name_table[0];
623   char* string = (char*) &vm_intrinsic_name_bodies[0];
624 
625   for (auto index : EnumRange<vmIntrinsicID>{}) {
626     nt[as_int(index)] = string;
627     string += strlen(string); // skip string body
628     string += 1;              // skip trailing null
629   }
630   assert(!strcmp(nt[as_int(vmIntrinsics::_hashCode)], "_hashCode"), "lined up");
631   nt[as_int(vmIntrinsics::_none)] = "_none";
632 }
633 
634 const char* vmIntrinsics::name_at(vmIntrinsics::ID id) {
635   const char** nt = &vm_intrinsic_name_table[0];
636   if (nt[as_int(_none)] == nullptr) {
637     init_vm_intrinsic_name_table();
638   }
639 
640   if (id < ID_LIMIT)
641     return vm_intrinsic_name_table[as_int(id)];
642   else
643     return "(unknown intrinsic)";
644 }
645 
646 vmIntrinsics::ID vmIntrinsics::find_id(const char* name) {
647   const char** nt = &vm_intrinsic_name_table[0];
648   if (nt[as_int(_none)] == nullptr) {
649     init_vm_intrinsic_name_table();
650   }
651 
652   for (auto index : EnumRange<vmIntrinsicID>{}) {
653     if (0 == strcmp(name, nt[as_int(index)])) {
654       return index;
655     }
656   }
657 
658   return _none;
659 }
660 
661 bool vmIntrinsics::is_intrinsic_available(vmIntrinsics::ID id) {
662   return VM_Version::is_intrinsic_supported(id) && !is_disabled_by_flags(id);
663 }
664 
665 bool vmIntrinsics::is_disabled_by_flags(vmIntrinsics::ID id) {
666   assert(id > _none && id < ID_LIMIT, "must be a VM intrinsic");
667 
668   // not initialized yet, process Control/DisableIntrinsic
669   if (vm_intrinsic_control_words[as_int(_none)].is_default()) {
670     for (ControlIntrinsicIter iter(ControlIntrinsic); *iter != nullptr; ++iter) {
671       vmIntrinsics::ID id = vmIntrinsics::find_id(*iter);
672 
673       if (id != vmIntrinsics::_none) {
674         vm_intrinsic_control_words[as_int(id)] = iter.is_enabled() && !disabled_by_jvm_flags(id);
675       }
676     }
677 
678     // Order matters, DisableIntrinsic can overwrite ControlIntrinsic
679     for (ControlIntrinsicIter iter(DisableIntrinsic, true/*disable_all*/); *iter != nullptr; ++iter) {
680       vmIntrinsics::ID id = vmIntrinsics::find_id(*iter);
681 
682       if (id != vmIntrinsics::_none) {
683         vm_intrinsic_control_words[as_int(id)] = false;
684       }
685     }
686 
687     vm_intrinsic_control_words[as_int(_none)] = true;
688   }
689 
690   TriBool b = vm_intrinsic_control_words[as_int(id)];
691   if (b.is_default()) {
692     // unknown yet, query and cache it
693     b = vm_intrinsic_control_words[as_int(id)] = !disabled_by_jvm_flags(id);
694   }
695 
696   return !b;
697 }
698 
699 // These are for forming case labels:
700 #define ID3(x, y, z) (( jlong)(z) +                                  \
701                       ((jlong)(y) <<    vmSymbols::log2_SID_LIMIT) + \
702                       ((jlong)(x) << (2*vmSymbols::log2_SID_LIMIT))  )
703 #define SID_ENUM(n) VM_SYMBOL_ENUM_NAME(n)
704 
705 vmIntrinsics::ID vmIntrinsics::find_id_impl(vmSymbolID holder,
706                                             vmSymbolID name,
707                                             vmSymbolID sig,
708                                             jshort flags) {
709   assert((int)vmSymbolID::SID_LIMIT <= (1<<vmSymbols::log2_SID_LIMIT), "must fit");
710 
711   // Let the C compiler build the decision tree.
712 
713 #define VM_INTRINSIC_CASE(id, klass, name, sig, fcode) \
714   case ID3(SID_ENUM(klass), SID_ENUM(name), SID_ENUM(sig)): \
715     if (!match_##fcode(flags))  break; \
716     return id;
717 
718   switch (ID3(holder, name, sig)) {
719     VM_INTRINSICS_DO(VM_INTRINSIC_CASE,
720                      VM_SYMBOL_IGNORE, VM_SYMBOL_IGNORE, VM_SYMBOL_IGNORE, VM_ALIAS_IGNORE);
721   }
722   return vmIntrinsics::_none;
723 
724 #undef VM_INTRINSIC_CASE
725 }
726 
727 class vmIntrinsicsLookup {
728   bool _class_map[vmSymbols::number_of_symbols()];
729 
730   constexpr int as_index(vmSymbolID id) const {
731     int index = vmSymbols::as_int(id);
732     assert(0 <= index && index < int(sizeof(_class_map)), "must be");
733     return index;
734   }
735 
736   constexpr void set_class_map(vmSymbolID id) {
737     _class_map[as_index(id)] = true;
738   }
739 
740 public:
741   constexpr vmIntrinsicsLookup() : _class_map() {
742 
743 #define VM_INTRINSIC_CLASS_MAP(id, klass, name, sig, fcode) \
744     set_class_map(SID_ENUM(klass));
745 
746     VM_INTRINSICS_DO(VM_INTRINSIC_CLASS_MAP,
747                      VM_SYMBOL_IGNORE, VM_SYMBOL_IGNORE, VM_SYMBOL_IGNORE, VM_ALIAS_IGNORE);
748 #undef VM_INTRINSIC_CLASS_MAP
749 
750 
751     // A few slightly irregular cases. See Method::init_intrinsic_id
752     set_class_map(SID_ENUM(java_lang_StrictMath));
753     set_class_map(SID_ENUM(java_lang_invoke_MethodHandle));
754     set_class_map(SID_ENUM(java_lang_invoke_VarHandle));
755   }
756 
757   bool class_has_intrinsics(vmSymbolID holder) const {
758     return _class_map[as_index(holder)];
759   }
760 };
761 
762 constexpr vmIntrinsicsLookup _intrinsics_lookup;
763 
764 bool vmIntrinsics::class_has_intrinsics(vmSymbolID holder) {
765   return _intrinsics_lookup.class_has_intrinsics(holder);
766 }
767 
768 const char* vmIntrinsics::short_name_as_C_string(vmIntrinsics::ID id, char* buf, int buflen) {
769   const char* str = name_at(id);
770 #ifndef PRODUCT
771   const char* kname = vmSymbols::name_for(class_for(id));
772   const char* mname = vmSymbols::name_for(name_for(id));
773   const char* sname = vmSymbols::name_for(signature_for(id));
774   const char* fname = "";
775   switch (flags_for(id)) {
776   case F_Y:  fname = "synchronized ";  break;
777   case F_RN: fname = "native ";        break;
778   case F_SN: fname = "native static "; break;
779   case F_S:  fname = "static ";        break;
780   default:   break;
781   }
782   const char* kptr = strrchr(kname, JVM_SIGNATURE_SLASH);
783   if (kptr != nullptr)  kname = kptr + 1;
784   int len = jio_snprintf(buf, buflen, "%s: %s%s.%s%s",
785                          str, fname, kname, mname, sname);
786   if (len < buflen)
787     str = buf;
788 #endif //PRODUCT
789   return str;
790 }
791 
792 
793 // These are to get information about intrinsics.
794 
795 #define ID4(x, y, z, f) ((ID3(x, y, z) << vmIntrinsics::log2_FLAG_LIMIT) | (jlong) (f))
796 
797 #ifndef PRODUCT
798 static const jlong intrinsic_info_array[vmIntrinsics::number_of_intrinsics()+1] = {
799 #define VM_INTRINSIC_INFO(ignore_id, klass, name, sig, fcode) \
800   ID4(SID_ENUM(klass), SID_ENUM(name), SID_ENUM(sig), vmIntrinsics::fcode),
801 
802   0, VM_INTRINSICS_DO(VM_INTRINSIC_INFO,
803                      VM_SYMBOL_IGNORE, VM_SYMBOL_IGNORE, VM_SYMBOL_IGNORE, VM_ALIAS_IGNORE)
804   0
805 #undef VM_INTRINSIC_INFO
806 };
807 
808 inline jlong intrinsic_info(vmIntrinsics::ID id) {
809   return intrinsic_info_array[vmIntrinsics::as_int(id)];
810 }
811 
812 vmSymbolID vmIntrinsics::class_for(vmIntrinsics::ID id) {
813   jlong info = intrinsic_info(id);
814   int shift = 2*vmSymbols::log2_SID_LIMIT + log2_FLAG_LIMIT, mask = right_n_bits(vmSymbols::log2_SID_LIMIT);
815   assert(((ID4(1021,1022,1023,7) >> shift) & mask) == 1021, "");
816   return vmSymbols::as_SID( (info >> shift) & mask );
817 }
818 
819 vmSymbolID vmIntrinsics::name_for(vmIntrinsics::ID id) {
820   jlong info = intrinsic_info(id);
821   int shift = vmSymbols::log2_SID_LIMIT + log2_FLAG_LIMIT, mask = right_n_bits(vmSymbols::log2_SID_LIMIT);
822   assert(((ID4(1021,1022,1023,7) >> shift) & mask) == 1022, "");
823   return vmSymbols::as_SID( (info >> shift) & mask );
824 }
825 
826 vmSymbolID vmIntrinsics::signature_for(vmIntrinsics::ID id) {
827   jlong info = intrinsic_info(id);
828   int shift = log2_FLAG_LIMIT, mask = right_n_bits(vmSymbols::log2_SID_LIMIT);
829   assert(((ID4(1021,1022,1023,7) >> shift) & mask) == 1023, "");
830   return vmSymbols::as_SID( (info >> shift) & mask );
831 }
832 
833 vmIntrinsics::Flags vmIntrinsics::flags_for(vmIntrinsics::ID id) {
834   jlong info = intrinsic_info(id);
835   int shift = 0, mask = right_n_bits(log2_FLAG_LIMIT);
836   assert(((ID4(1021,1022,1023,7) >> shift) & mask) == 7, "");
837   return Flags( (info >> shift) & mask );
838 }
839 #endif // !PRODUCT