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