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