1 /* 2 * Copyright (c) 2020, 2025, 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 #ifndef SHARE_OPTO_LIBRARY_CALL_HPP 26 #define SHARE_OPTO_LIBRARY_CALL_HPP 27 28 #include "ci/ciMethod.hpp" 29 #include "classfile/javaClasses.hpp" 30 #include "opto/callGenerator.hpp" 31 #include "opto/castnode.hpp" 32 #include "opto/convertnode.hpp" 33 #include "opto/graphKit.hpp" 34 #include "opto/intrinsicnode.hpp" 35 #include "opto/movenode.hpp" 36 37 class LibraryIntrinsic : public InlineCallGenerator { 38 // Extend the set of intrinsics known to the runtime: 39 public: 40 private: 41 bool _is_virtual; 42 bool _does_virtual_dispatch; 43 int8_t _predicates_count; // Intrinsic is predicated by several conditions 44 int8_t _last_predicate; // Last generated predicate 45 vmIntrinsics::ID _intrinsic_id; 46 47 public: 48 LibraryIntrinsic(ciMethod* m, bool is_virtual, int predicates_count, bool does_virtual_dispatch, vmIntrinsics::ID id) 49 : InlineCallGenerator(m), 50 _is_virtual(is_virtual), 51 _does_virtual_dispatch(does_virtual_dispatch), 52 _predicates_count((int8_t)predicates_count), 53 _last_predicate((int8_t)-1), 54 _intrinsic_id(id) 55 { 56 } 57 virtual bool is_intrinsic() const { return true; } 58 virtual bool is_virtual() const { return _is_virtual; } 59 virtual bool is_predicated() const { return _predicates_count > 0; } 60 virtual int predicates_count() const { return _predicates_count; } 61 virtual bool does_virtual_dispatch() const { return _does_virtual_dispatch; } 62 virtual JVMState* generate(JVMState* jvms); 63 virtual Node* generate_predicate(JVMState* jvms, int predicate); 64 vmIntrinsics::ID intrinsic_id() const { return _intrinsic_id; } 65 }; 66 67 68 // Local helper class for LibraryIntrinsic: 69 class LibraryCallKit : public GraphKit { 70 private: 71 LibraryIntrinsic* _intrinsic; // the library intrinsic being called 72 Node* _result; // the result node, if any 73 int _reexecute_sp; // the stack pointer when bytecode needs to be reexecuted 74 75 const TypeOopPtr* sharpen_unsafe_type(Compile::AliasType* alias_type, const TypePtr *adr_type); 76 77 public: 78 LibraryCallKit(JVMState* jvms, LibraryIntrinsic* intrinsic) 79 : GraphKit(jvms), 80 _intrinsic(intrinsic), 81 _result(nullptr) 82 { 83 // Check if this is a root compile. In that case we don't have a caller. 84 if (!jvms->has_method()) { 85 _reexecute_sp = sp(); 86 } else { 87 // Find out how many arguments the interpreter needs when deoptimizing 88 // and save the stack pointer value so it can used by uncommon_trap. 89 // We find the argument count by looking at the declared signature. 90 bool ignored_will_link; 91 ciSignature* declared_signature = nullptr; 92 ciMethod* ignored_callee = caller()->get_method_at_bci(bci(), ignored_will_link, &declared_signature); 93 const int nargs = declared_signature->arg_size_for_bc(caller()->java_code_at_bci(bci())); 94 _reexecute_sp = sp() + nargs; // "push" arguments back on stack 95 } 96 } 97 98 virtual LibraryCallKit* is_LibraryCallKit() const { return (LibraryCallKit*)this; } 99 100 ciMethod* caller() const { return jvms()->method(); } 101 int bci() const { return jvms()->bci(); } 102 LibraryIntrinsic* intrinsic() const { return _intrinsic; } 103 vmIntrinsics::ID intrinsic_id() const { return _intrinsic->intrinsic_id(); } 104 ciMethod* callee() const { return _intrinsic->method(); } 105 106 bool try_to_inline(int predicate); 107 Node* try_to_predicate(int predicate); 108 109 void push_result() { 110 // Push the result onto the stack. 111 if (!stopped() && result() != nullptr) { 112 if (result()->is_top()) { 113 assert(false, "Can't determine return value."); 114 C->record_method_not_compilable("Can't determine return value."); 115 } 116 BasicType bt = result()->bottom_type()->basic_type(); 117 push_node(bt, result()); 118 } 119 } 120 121 private: 122 void fatal_unexpected_iid(vmIntrinsics::ID iid) { 123 fatal("unexpected intrinsic %d: %s", vmIntrinsics::as_int(iid), vmIntrinsics::name_at(iid)); 124 } 125 126 void set_result(Node* n) { assert(_result == nullptr, "only set once"); _result = n; } 127 void set_result(RegionNode* region, PhiNode* value); 128 Node* result() { return _result; } 129 130 virtual int reexecute_sp() { return _reexecute_sp; } 131 132 // Helper functions to inline natives 133 Node* generate_guard(Node* test, RegionNode* region, float true_prob); 134 Node* generate_slow_guard(Node* test, RegionNode* region); 135 Node* generate_fair_guard(Node* test, RegionNode* region); 136 Node* generate_negative_guard(Node* index, RegionNode* region, 137 // resulting CastII of index: 138 Node* *pos_index = nullptr); 139 Node* generate_limit_guard(Node* offset, Node* subseq_length, 140 Node* array_length, 141 RegionNode* region); 142 void generate_string_range_check(Node* array, Node* offset, 143 Node* length, bool char_count); 144 Node* current_thread_helper(Node* &tls_output, ByteSize handle_offset, 145 bool is_immutable); 146 Node* generate_current_thread(Node* &tls_output); 147 Node* generate_virtual_thread(Node* threadObj); 148 Node* load_mirror_from_klass(Node* klass); 149 Node* load_klass_from_mirror_common(Node* mirror, bool never_see_null, 150 RegionNode* region, int null_path, 151 int offset); 152 Node* load_klass_from_mirror(Node* mirror, bool never_see_null, 153 RegionNode* region, int null_path) { 154 int offset = java_lang_Class::klass_offset(); 155 return load_klass_from_mirror_common(mirror, never_see_null, 156 region, null_path, 157 offset); 158 } 159 Node* load_array_klass_from_mirror(Node* mirror, bool never_see_null, 160 RegionNode* region, int null_path) { 161 int offset = java_lang_Class::array_klass_offset(); 162 return load_klass_from_mirror_common(mirror, never_see_null, 163 region, null_path, 164 offset); 165 } 166 Node* generate_klass_flags_guard(Node* kls, int modifier_mask, int modifier_bits, RegionNode* region, 167 ByteSize offset, const Type* type, BasicType bt); 168 Node* generate_misc_flags_guard(Node* kls, 169 int modifier_mask, int modifier_bits, 170 RegionNode* region); 171 Node* generate_interface_guard(Node* kls, RegionNode* region); 172 Node* generate_hidden_class_guard(Node* kls, RegionNode* region); 173 Node* generate_array_guard(Node* kls, RegionNode* region, Node** obj = nullptr) { 174 return generate_array_guard_common(kls, region, false, false, obj); 175 } 176 Node* generate_non_array_guard(Node* kls, RegionNode* region, Node** obj = nullptr) { 177 return generate_array_guard_common(kls, region, false, true, obj); 178 } 179 Node* generate_objArray_guard(Node* kls, RegionNode* region, Node** obj = nullptr) { 180 return generate_array_guard_common(kls, region, true, false, obj); 181 } 182 Node* generate_non_objArray_guard(Node* kls, RegionNode* region, Node** obj = nullptr) { 183 return generate_array_guard_common(kls, region, true, true, obj); 184 } 185 Node* generate_array_guard_common(Node* kls, RegionNode* region, 186 bool obj_array, bool not_array, Node** obj = nullptr); 187 Node* generate_virtual_guard(Node* obj_klass, RegionNode* slow_region); 188 CallJavaNode* generate_method_call(vmIntrinsicID method_id, bool is_virtual, bool is_static, bool res_not_null); 189 CallJavaNode* generate_method_call_static(vmIntrinsicID method_id, bool res_not_null) { 190 return generate_method_call(method_id, false, true, res_not_null); 191 } 192 Node* load_field_from_object(Node* fromObj, const char* fieldName, const char* fieldTypeString, DecoratorSet decorators = IN_HEAP, bool is_static = false, ciInstanceKlass* fromKls = nullptr); 193 Node* field_address_from_object(Node* fromObj, const char* fieldName, const char* fieldTypeString, bool is_exact = true, bool is_static = false, ciInstanceKlass* fromKls = nullptr); 194 195 Node* make_string_method_node(int opcode, Node* str1_start, Node* cnt1, Node* str2_start, Node* cnt2, StrIntrinsicNode::ArgEnc ae); 196 bool inline_string_compareTo(StrIntrinsicNode::ArgEnc ae); 197 bool inline_string_indexOf(StrIntrinsicNode::ArgEnc ae); 198 bool inline_string_indexOfI(StrIntrinsicNode::ArgEnc ae); 199 Node* make_indexOf_node(Node* src_start, Node* src_count, Node* tgt_start, Node* tgt_count, 200 RegionNode* region, Node* phi, StrIntrinsicNode::ArgEnc ae); 201 bool inline_string_indexOfChar(StrIntrinsicNode::ArgEnc ae); 202 bool inline_string_equals(StrIntrinsicNode::ArgEnc ae); 203 bool inline_vectorizedHashCode(); 204 bool inline_string_toBytesU(); 205 bool inline_string_getCharsU(); 206 bool inline_string_copy(bool compress); 207 bool inline_string_char_access(bool is_store); 208 bool runtime_math(const TypeFunc* call_type, address funcAddr, const char* funcName); 209 bool inline_math_native(vmIntrinsics::ID id); 210 bool inline_math(vmIntrinsics::ID id); 211 bool inline_double_math(vmIntrinsics::ID id); 212 bool inline_math_pow(); 213 template <typename OverflowOp> 214 bool inline_math_overflow(Node* arg1, Node* arg2); 215 bool inline_math_mathExact(Node* math, Node* test); 216 bool inline_math_addExactI(bool is_increment); 217 bool inline_math_addExactL(bool is_increment); 218 bool inline_math_multiplyExactI(); 219 bool inline_math_multiplyExactL(); 220 bool inline_math_multiplyHigh(); 221 bool inline_math_unsignedMultiplyHigh(); 222 bool inline_math_negateExactI(); 223 bool inline_math_negateExactL(); 224 bool inline_math_subtractExactI(bool is_decrement); 225 bool inline_math_subtractExactL(bool is_decrement); 226 bool inline_min_max(vmIntrinsics::ID id); 227 bool inline_notify(vmIntrinsics::ID id); 228 // This returns Type::AnyPtr, RawPtr, or OopPtr. 229 int classify_unsafe_addr(Node* &base, Node* &offset, BasicType type); 230 Node* make_unsafe_address(Node*& base, Node* offset, BasicType type = T_ILLEGAL, bool can_cast = false); 231 232 typedef enum { Relaxed, Opaque, Volatile, Acquire, Release } AccessKind; 233 DecoratorSet mo_decorator_for_access_kind(AccessKind kind); 234 bool inline_unsafe_access(bool is_store, BasicType type, AccessKind kind, bool is_unaligned); 235 static bool klass_needs_init_guard(Node* kls); 236 bool inline_unsafe_allocate(); 237 bool inline_unsafe_newArray(bool uninitialized); 238 bool inline_unsafe_writeback0(); 239 bool inline_unsafe_writebackSync0(bool is_pre); 240 bool inline_unsafe_copyMemory(); 241 bool inline_unsafe_setMemory(); 242 243 bool inline_native_currentCarrierThread(); 244 bool inline_native_currentThread(); 245 bool inline_native_setCurrentThread(); 246 247 bool inline_native_scopedValueCache(); 248 const Type* scopedValueCache_type(); 249 Node* scopedValueCache_helper(); 250 bool inline_native_setScopedValueCache(); 251 bool inline_native_Continuation_pinning(bool unpin); 252 253 bool inline_native_time_funcs(address method, const char* funcName); 254 #if INCLUDE_JVMTI 255 bool inline_native_notify_jvmti_funcs(address funcAddr, const char* funcName, bool is_start, bool is_end); 256 bool inline_native_notify_jvmti_hide(); 257 bool inline_native_notify_jvmti_sync(); 258 #endif 259 260 #ifdef JFR_HAVE_INTRINSICS 261 bool inline_native_classID(); 262 bool inline_native_getEventWriter(); 263 bool inline_native_jvm_commit(); 264 void extend_setCurrentThread(Node* jt, Node* thread); 265 #endif 266 bool inline_native_Class_query(vmIntrinsics::ID id); 267 bool inline_native_subtype_check(); 268 bool inline_native_getLength(); 269 bool inline_array_copyOf(bool is_copyOfRange); 270 bool inline_array_equals(StrIntrinsicNode::ArgEnc ae); 271 bool inline_preconditions_checkIndex(BasicType bt); 272 void copy_to_clone(Node* obj, Node* alloc_obj, Node* obj_size, bool is_array); 273 bool inline_native_clone(bool is_virtual); 274 bool inline_native_Reflection_getCallerClass(); 275 // Helper function for inlining native object hash method 276 bool inline_native_hashcode(bool is_virtual, bool is_static); 277 bool inline_native_getClass(); 278 279 // Helper functions for inlining arraycopy 280 bool inline_arraycopy(); 281 AllocateArrayNode* tightly_coupled_allocation(Node* ptr); 282 static CallStaticJavaNode* get_uncommon_trap_from_success_proj(Node* node); 283 SafePointNode* create_safepoint_with_state_before_array_allocation(const AllocateArrayNode* alloc) const; 284 void replace_unrelated_uncommon_traps_with_alloc_state(AllocateArrayNode* alloc, JVMState* saved_jvms_before_guards); 285 void replace_unrelated_uncommon_traps_with_alloc_state(JVMState* saved_jvms_before_guards); 286 void create_new_uncommon_trap(CallStaticJavaNode* uncommon_trap_call); 287 JVMState* arraycopy_restore_alloc_state(AllocateArrayNode* alloc, int& saved_reexecute_sp); 288 void arraycopy_move_allocation_here(AllocateArrayNode* alloc, Node* dest, JVMState* saved_jvms_before_guards, int saved_reexecute_sp, 289 uint new_idx); 290 bool check_array_sort_arguments(Node* elementType, Node* obj, BasicType& bt); 291 bool inline_array_sort(); 292 bool inline_array_partition(); 293 typedef enum { LS_get_add, LS_get_set, LS_cmp_swap, LS_cmp_swap_weak, LS_cmp_exchange } LoadStoreKind; 294 bool inline_unsafe_load_store(BasicType type, LoadStoreKind kind, AccessKind access_kind); 295 bool inline_unsafe_fence(vmIntrinsics::ID id); 296 bool inline_onspinwait(); 297 bool inline_fp_conversions(vmIntrinsics::ID id); 298 bool inline_fp_range_check(vmIntrinsics::ID id); 299 bool inline_fp16_operations(vmIntrinsics::ID id, int num_args); 300 Node* unbox_fp16_value(const TypeInstPtr* box_class, ciField* field, Node* box); 301 Node* box_fp16_value(const TypeInstPtr* box_class, ciField* field, Node* value); 302 bool inline_number_methods(vmIntrinsics::ID id); 303 bool inline_bitshuffle_methods(vmIntrinsics::ID id); 304 bool inline_compare_unsigned(vmIntrinsics::ID id); 305 bool inline_divmod_methods(vmIntrinsics::ID id); 306 bool inline_reference_get0(); 307 bool inline_reference_refersTo0(bool is_phantom); 308 bool inline_reference_clear0(bool is_phantom); 309 bool inline_Class_cast(); 310 bool inline_aescrypt_Block(vmIntrinsics::ID id); 311 bool inline_cipherBlockChaining_AESCrypt(vmIntrinsics::ID id); 312 bool inline_electronicCodeBook_AESCrypt(vmIntrinsics::ID id); 313 bool inline_counterMode_AESCrypt(vmIntrinsics::ID id); 314 Node* inline_cipherBlockChaining_AESCrypt_predicate(bool decrypting); 315 Node* inline_electronicCodeBook_AESCrypt_predicate(bool decrypting); 316 Node* inline_counterMode_AESCrypt_predicate(); 317 Node* get_key_start_from_aescrypt_object(Node* aescrypt_object); 318 bool inline_ghash_processBlocks(); 319 bool inline_chacha20Block(); 320 bool inline_kyberNtt(); 321 bool inline_kyberInverseNtt(); 322 bool inline_kyberNttMult(); 323 bool inline_kyberAddPoly_2(); 324 bool inline_kyberAddPoly_3(); 325 bool inline_kyber12To16(); 326 bool inline_kyberBarrettReduce(); 327 bool inline_dilithiumAlmostNtt(); 328 bool inline_dilithiumAlmostInverseNtt(); 329 bool inline_dilithiumNttMult(); 330 bool inline_dilithiumMontMulByConstant(); 331 bool inline_dilithiumDecomposePoly(); 332 bool inline_base64_encodeBlock(); 333 bool inline_base64_decodeBlock(); 334 bool inline_poly1305_processBlocks(); 335 bool inline_intpoly_montgomeryMult_P256(); 336 bool inline_intpoly_assign(); 337 bool inline_digestBase_implCompress(vmIntrinsics::ID id); 338 bool inline_double_keccak(); 339 bool inline_digestBase_implCompressMB(int predicate); 340 bool inline_digestBase_implCompressMB(Node* digestBaseObj, ciInstanceKlass* instklass, 341 BasicType elem_type, address stubAddr, const char *stubName, 342 Node* src_start, Node* ofs, Node* limit); 343 Node* get_state_from_digest_object(Node *digestBase_object, BasicType elem_type); 344 Node* get_block_size_from_digest_object(Node *digestBase_object); 345 Node* inline_digestBase_implCompressMB_predicate(int predicate); 346 bool inline_encodeISOArray(bool ascii); 347 bool inline_updateCRC32(); 348 bool inline_updateBytesCRC32(); 349 bool inline_updateByteBufferCRC32(); 350 Node* get_table_from_crc32c_class(ciInstanceKlass *crc32c_class); 351 bool inline_updateBytesCRC32C(); 352 bool inline_updateDirectByteBufferCRC32C(); 353 bool inline_updateBytesAdler32(); 354 bool inline_updateByteBufferAdler32(); 355 bool inline_multiplyToLen(); 356 bool inline_countPositives(); 357 bool inline_squareToLen(); 358 bool inline_mulAdd(); 359 bool inline_montgomeryMultiply(); 360 bool inline_montgomerySquare(); 361 bool inline_bigIntegerShift(bool isRightShift); 362 bool inline_vectorizedMismatch(); 363 bool inline_fma(vmIntrinsics::ID id); 364 bool inline_character_compare(vmIntrinsics::ID id); 365 bool inline_galoisCounterMode_AESCrypt(); 366 Node* inline_galoisCounterMode_AESCrypt_predicate(); 367 368 bool inline_profileBoolean(); 369 bool inline_isCompileConstant(); 370 371 bool inline_continuation_do_yield(); 372 373 // Vector API support 374 bool inline_vector_nary_operation(int n); 375 bool inline_vector_call(int arity); 376 bool inline_vector_frombits_coerced(); 377 bool inline_vector_mask_operation(); 378 bool inline_vector_mem_operation(bool is_store); 379 bool inline_vector_mem_masked_operation(bool is_store); 380 bool inline_vector_gather_scatter(bool is_scatter); 381 bool inline_vector_reduction(); 382 bool inline_vector_test(); 383 bool inline_vector_blend(); 384 bool inline_vector_rearrange(); 385 bool inline_vector_select_from(); 386 bool inline_vector_compare(); 387 bool inline_vector_broadcast_int(); 388 bool inline_vector_convert(); 389 bool inline_vector_extract(); 390 bool inline_vector_insert(); 391 bool inline_vector_compress_expand(); 392 bool inline_index_vector(); 393 bool inline_index_partially_in_upper_range(); 394 bool inline_vector_select_from_two_vectors(); 395 396 Node* gen_call_to_vector_math(int vector_api_op_id, BasicType bt, int num_elem, Node* opd1, Node* opd2); 397 398 enum VectorMaskUseType { 399 VecMaskUseLoad = 1 << 0, 400 VecMaskUseStore = 1 << 1, 401 VecMaskUseAll = VecMaskUseLoad | VecMaskUseStore, 402 VecMaskUsePred = 1 << 2, 403 VecMaskNotUsed = 1 << 3 404 }; 405 406 bool arch_supports_vector(int op, int num_elem, BasicType type, VectorMaskUseType mask_use_type, bool has_scalar_args = false); 407 bool arch_supports_vector_rotate(int opc, int num_elem, BasicType elem_bt, VectorMaskUseType mask_use_type, bool has_scalar_args = false); 408 409 void clear_upper_avx() { 410 #ifdef X86 411 if (UseAVX >= 2) { 412 C->set_clear_upper_avx(true); 413 } 414 #endif 415 } 416 417 bool inline_getObjectSize(); 418 419 bool inline_blackhole(); 420 }; 421 422 #endif // SHARE_OPTO_LIBRARY_CALL_HPP