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