1 /* 2 * Copyright (c) 2020, 2021, 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(NULL) 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 = NULL; 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 != NULL) { 111 BasicType bt = res->bottom_type()->basic_type(); 112 if (C->inlining_incrementally() && res->is_InlineType()) { 113 // The caller expects an oop when incrementally inlining an intrinsic that returns an 114 // inline type. Make sure the call is re-executed if the allocation triggers a deoptimization. 115 PreserveReexecuteState preexecs(this); 116 jvms()->set_should_reexecute(true); 117 res = res->as_InlineType()->buffer(this); 118 } 119 push_node(bt, res); 120 } 121 } 122 123 private: 124 void fatal_unexpected_iid(vmIntrinsics::ID iid) { 125 fatal("unexpected intrinsic %d: %s", vmIntrinsics::as_int(iid), vmIntrinsics::name_at(iid)); 126 } 127 128 void set_result(Node* n) { assert(_result == NULL, "only set once"); _result = n; } 129 void set_result(RegionNode* region, PhiNode* value); 130 Node* result() { return _result; } 131 132 virtual int reexecute_sp() { return _reexecute_sp; } 133 134 // Helper functions to inline natives 135 Node* generate_guard(Node* test, RegionNode* region, float true_prob); 136 Node* generate_slow_guard(Node* test, RegionNode* region); 137 Node* generate_fair_guard(Node* test, RegionNode* region); 138 Node* generate_negative_guard(Node* index, RegionNode* region, 139 // resulting CastII of index: 140 Node* *pos_index = NULL); 141 Node* generate_limit_guard(Node* offset, Node* subseq_length, 142 Node* array_length, 143 RegionNode* region); 144 void generate_string_range_check(Node* array, Node* offset, 145 Node* length, bool char_count); 146 Node* generate_current_thread(Node* &tls_output); 147 Node* load_klass_from_mirror_common(Node* mirror, bool never_see_null, 148 RegionNode* region, int null_path, 149 int offset); 150 Node* load_klass_from_mirror(Node* mirror, bool never_see_null, 151 RegionNode* region, int null_path) { 152 int offset = java_lang_Class::klass_offset(); 153 return load_klass_from_mirror_common(mirror, never_see_null, 154 region, null_path, 155 offset); 156 } 157 Node* load_array_klass_from_mirror(Node* mirror, bool never_see_null, 158 RegionNode* region, int null_path) { 159 int offset = java_lang_Class::array_klass_offset(); 160 return load_klass_from_mirror_common(mirror, never_see_null, 161 region, null_path, 162 offset); 163 } 164 Node* generate_access_flags_guard(Node* kls, 165 int modifier_mask, int modifier_bits, 166 RegionNode* region); 167 Node* generate_interface_guard(Node* kls, RegionNode* region); 168 169 enum ArrayKind { 170 AnyArray, 171 NonArray, 172 ObjectArray, 173 NonObjectArray, 174 TypeArray 175 }; 176 177 Node* generate_hidden_class_guard(Node* kls, RegionNode* region); 178 179 Node* generate_array_guard(Node* kls, RegionNode* region) { 180 return generate_array_guard_common(kls, region, AnyArray); 181 } 182 Node* generate_non_array_guard(Node* kls, RegionNode* region) { 183 return generate_array_guard_common(kls, region, NonArray); 184 } 185 Node* generate_objArray_guard(Node* kls, RegionNode* region) { 186 return generate_array_guard_common(kls, region, ObjectArray); 187 } 188 Node* generate_non_objArray_guard(Node* kls, RegionNode* region) { 189 return generate_array_guard_common(kls, region, NonObjectArray); 190 } 191 Node* generate_typeArray_guard(Node* kls, RegionNode* region) { 192 return generate_array_guard_common(kls, region, TypeArray); 193 } 194 Node* generate_array_guard_common(Node* kls, RegionNode* region, ArrayKind kind); 195 Node* generate_virtual_guard(Node* obj_klass, RegionNode* slow_region); 196 CallJavaNode* generate_method_call(vmIntrinsics::ID method_id, 197 bool is_virtual = false, bool is_static = false); 198 CallJavaNode* generate_method_call_static(vmIntrinsics::ID method_id) { 199 return generate_method_call(method_id, false, true); 200 } 201 CallJavaNode* generate_method_call_virtual(vmIntrinsics::ID method_id) { 202 return generate_method_call(method_id, true, false); 203 } 204 Node* load_field_from_object(Node* fromObj, const char* fieldName, const char* fieldTypeString, DecoratorSet decorators, bool is_static, ciInstanceKlass* fromKls); 205 Node* field_address_from_object(Node* fromObj, const char* fieldName, const char* fieldTypeString, bool is_exact, bool is_static, ciInstanceKlass* fromKls); 206 207 Node* make_string_method_node(int opcode, Node* str1_start, Node* cnt1, Node* str2_start, Node* cnt2, StrIntrinsicNode::ArgEnc ae); 208 bool inline_string_compareTo(StrIntrinsicNode::ArgEnc ae); 209 bool inline_string_indexOf(StrIntrinsicNode::ArgEnc ae); 210 bool inline_string_indexOfI(StrIntrinsicNode::ArgEnc ae); 211 Node* make_indexOf_node(Node* src_start, Node* src_count, Node* tgt_start, Node* tgt_count, 212 RegionNode* region, Node* phi, StrIntrinsicNode::ArgEnc ae); 213 bool inline_string_indexOfChar(StrIntrinsicNode::ArgEnc ae); 214 bool inline_string_equals(StrIntrinsicNode::ArgEnc ae); 215 bool inline_string_toBytesU(); 216 bool inline_string_getCharsU(); 217 bool inline_string_copy(bool compress); 218 bool inline_string_char_access(bool is_store); 219 Node* round_double_node(Node* n); 220 bool runtime_math(const TypeFunc* call_type, address funcAddr, const char* funcName); 221 bool inline_math_native(vmIntrinsics::ID id); 222 bool inline_math(vmIntrinsics::ID id); 223 bool inline_double_math(vmIntrinsics::ID id); 224 bool inline_math_pow(); 225 template <typename OverflowOp> 226 bool inline_math_overflow(Node* arg1, Node* arg2); 227 void inline_math_mathExact(Node* math, Node* test); 228 bool inline_math_addExactI(bool is_increment); 229 bool inline_math_addExactL(bool is_increment); 230 bool inline_math_multiplyExactI(); 231 bool inline_math_multiplyExactL(); 232 bool inline_math_multiplyHigh(); 233 bool inline_math_unsignedMultiplyHigh(); 234 bool inline_math_negateExactI(); 235 bool inline_math_negateExactL(); 236 bool inline_math_subtractExactI(bool is_decrement); 237 bool inline_math_subtractExactL(bool is_decrement); 238 bool inline_min_max(vmIntrinsics::ID id); 239 bool inline_notify(vmIntrinsics::ID id); 240 Node* generate_min_max(vmIntrinsics::ID id, Node* x, Node* y); 241 // This returns Type::AnyPtr, RawPtr, or OopPtr. 242 int classify_unsafe_addr(Node* &base, Node* &offset, BasicType type); 243 Node* make_unsafe_address(Node*& base, Node* offset, BasicType type = T_ILLEGAL, bool can_cast = false); 244 245 typedef enum { Relaxed, Opaque, Volatile, Acquire, Release } AccessKind; 246 DecoratorSet mo_decorator_for_access_kind(AccessKind kind); 247 bool inline_unsafe_access(bool is_store, BasicType type, AccessKind kind, bool is_unaligned); 248 static bool klass_needs_init_guard(Node* kls); 249 bool inline_unsafe_allocate(); 250 bool inline_unsafe_newArray(bool uninitialized); 251 bool inline_unsafe_writeback0(); 252 bool inline_unsafe_writebackSync0(bool is_pre); 253 bool inline_unsafe_copyMemory(); 254 bool inline_unsafe_make_private_buffer(); 255 bool inline_unsafe_finish_private_buffer(); 256 bool inline_native_currentThread(); 257 258 bool inline_native_time_funcs(address method, const char* funcName); 259 #ifdef JFR_HAVE_INTRINSICS 260 bool inline_native_classID(); 261 bool inline_native_getEventWriter(); 262 #endif 263 bool inline_native_Class_query(vmIntrinsics::ID id); 264 bool inline_primitive_Class_conversion(vmIntrinsics::ID id); 265 bool inline_native_subtype_check(); 266 bool inline_native_getLength(); 267 bool inline_array_copyOf(bool is_copyOfRange); 268 bool inline_array_equals(StrIntrinsicNode::ArgEnc ae); 269 bool inline_preconditions_checkIndex(BasicType bt); 270 void copy_to_clone(Node* obj, Node* alloc_obj, Node* obj_size, bool is_array); 271 bool inline_native_clone(bool is_virtual); 272 bool inline_native_Reflection_getCallerClass(); 273 // Helper function for inlining native object hash method 274 bool inline_native_hashcode(bool is_virtual, bool is_static); 275 bool inline_native_getClass(); 276 277 // Helper functions for inlining arraycopy 278 bool inline_arraycopy(); 279 AllocateArrayNode* tightly_coupled_allocation(Node* ptr); 280 JVMState* arraycopy_restore_alloc_state(AllocateArrayNode* alloc, int& saved_reexecute_sp); 281 void arraycopy_move_allocation_here(AllocateArrayNode* alloc, Node* dest, JVMState* saved_jvms, int saved_reexecute_sp, 282 uint new_idx); 283 284 typedef enum { LS_get_add, LS_get_set, LS_cmp_swap, LS_cmp_swap_weak, LS_cmp_exchange } LoadStoreKind; 285 bool inline_unsafe_load_store(BasicType type, LoadStoreKind kind, AccessKind access_kind); 286 bool inline_unsafe_fence(vmIntrinsics::ID id); 287 bool inline_onspinwait(); 288 bool inline_fp_conversions(vmIntrinsics::ID id); 289 bool inline_number_methods(vmIntrinsics::ID id); 290 bool inline_reference_get(); 291 bool inline_reference_refersTo0(bool is_phantom); 292 bool inline_Class_cast(); 293 bool inline_aescrypt_Block(vmIntrinsics::ID id); 294 bool inline_cipherBlockChaining_AESCrypt(vmIntrinsics::ID id); 295 bool inline_electronicCodeBook_AESCrypt(vmIntrinsics::ID id); 296 bool inline_counterMode_AESCrypt(vmIntrinsics::ID id); 297 Node* inline_cipherBlockChaining_AESCrypt_predicate(bool decrypting); 298 Node* inline_electronicCodeBook_AESCrypt_predicate(bool decrypting); 299 Node* inline_counterMode_AESCrypt_predicate(); 300 Node* get_key_start_from_aescrypt_object(Node* aescrypt_object); 301 bool inline_ghash_processBlocks(); 302 bool inline_base64_encodeBlock(); 303 bool inline_base64_decodeBlock(); 304 bool inline_digestBase_implCompress(vmIntrinsics::ID id); 305 bool inline_digestBase_implCompressMB(int predicate); 306 bool inline_digestBase_implCompressMB(Node* digestBaseObj, ciInstanceKlass* instklass, 307 const char* state_type, address stubAddr, const char *stubName, 308 Node* src_start, Node* ofs, Node* limit); 309 Node* get_state_from_digest_object(Node *digestBase_object, const char* state_type); 310 Node* get_digest_length_from_digest_object(Node *digestBase_object); 311 Node* inline_digestBase_implCompressMB_predicate(int predicate); 312 bool inline_encodeISOArray(bool ascii); 313 bool inline_updateCRC32(); 314 bool inline_updateBytesCRC32(); 315 bool inline_updateByteBufferCRC32(); 316 Node* get_table_from_crc32c_class(ciInstanceKlass *crc32c_class); 317 bool inline_updateBytesCRC32C(); 318 bool inline_updateDirectByteBufferCRC32C(); 319 bool inline_updateBytesAdler32(); 320 bool inline_updateByteBufferAdler32(); 321 bool inline_multiplyToLen(); 322 bool inline_countPositives(); 323 bool inline_squareToLen(); 324 bool inline_mulAdd(); 325 bool inline_montgomeryMultiply(); 326 bool inline_montgomerySquare(); 327 bool inline_bigIntegerShift(bool isRightShift); 328 bool inline_vectorizedMismatch(); 329 bool inline_fma(vmIntrinsics::ID id); 330 bool inline_character_compare(vmIntrinsics::ID id); 331 bool inline_fp_min_max(vmIntrinsics::ID id); 332 bool inline_galoisCounterMode_AESCrypt(); 333 Node* inline_galoisCounterMode_AESCrypt_predicate(); 334 335 bool inline_profileBoolean(); 336 bool inline_isCompileConstant(); 337 338 // Vector API support 339 bool inline_vector_nary_operation(int n); 340 bool inline_vector_frombits_coerced(); 341 bool inline_vector_shuffle_to_vector(); 342 bool inline_vector_shuffle_iota(); 343 bool inline_vector_mask_operation(); 344 bool inline_vector_mem_operation(bool is_store); 345 bool inline_vector_mem_masked_operation(bool is_store); 346 bool inline_vector_gather_scatter(bool is_scatter); 347 bool inline_vector_reduction(); 348 bool inline_vector_test(); 349 bool inline_vector_blend(); 350 bool inline_vector_rearrange(); 351 bool inline_vector_compare(); 352 bool inline_vector_broadcast_int(); 353 bool inline_vector_convert(); 354 bool inline_vector_extract(); 355 bool inline_vector_insert(); 356 Node* gen_call_to_svml(int vector_api_op_id, BasicType bt, int num_elem, Node* opd1, Node* opd2); 357 358 enum VectorMaskUseType { 359 VecMaskUseLoad = 1 << 0, 360 VecMaskUseStore = 1 << 1, 361 VecMaskUseAll = VecMaskUseLoad | VecMaskUseStore, 362 VecMaskUsePred = 1 << 2, 363 VecMaskNotUsed = 1 << 3 364 }; 365 366 bool arch_supports_vector(int op, int num_elem, BasicType type, VectorMaskUseType mask_use_type, bool has_scalar_args = false); 367 bool arch_supports_vector_rotate(int opc, int num_elem, BasicType elem_bt, VectorMaskUseType mask_use_type, bool has_scalar_args = false); 368 369 void clear_upper_avx() { 370 #ifdef X86 371 if (UseAVX >= 2) { 372 C->set_clear_upper_avx(true); 373 } 374 #endif 375 } 376 377 bool inline_getObjectSize(); 378 379 bool inline_blackhole(); 380 }; 381