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 "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 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 == nullptr, "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 = nullptr);
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* current_thread_helper(Node* &tls_output, ByteSize handle_offset,
147 bool is_immutable);
148 Node* generate_current_thread(Node* &tls_output);
149 Node* generate_virtual_thread(Node* threadObj);
150 Node* load_klass_from_mirror_common(Node* mirror, bool never_see_null,
151 RegionNode* region, int null_path,
152 int offset);
153 Node* load_klass_from_mirror(Node* mirror, bool never_see_null,
154 RegionNode* region, int null_path) {
155 int offset = java_lang_Class::klass_offset();
156 return load_klass_from_mirror_common(mirror, never_see_null,
157 region, null_path,
158 offset);
159 }
160 Node* load_array_klass_from_mirror(Node* mirror, bool never_see_null,
161 RegionNode* region, int null_path) {
162 int offset = java_lang_Class::array_klass_offset();
163 return load_klass_from_mirror_common(mirror, never_see_null,
164 region, null_path,
165 offset);
166 }
167 Node* generate_klass_flags_guard(Node* kls, int modifier_mask, int modifier_bits, RegionNode* region,
168 ByteSize offset, const Type* type, BasicType bt);
169 Node* generate_misc_flags_guard(Node* kls,
170 int modifier_mask, int modifier_bits,
171 RegionNode* region);
172 Node* generate_interface_guard(Node* kls, RegionNode* region);
173
174 enum ArrayKind {
175 AnyArray,
176 NonArray,
177 ObjectArray,
178 NonObjectArray,
179 TypeArray
180 };
181
182 Node* generate_hidden_class_guard(Node* kls, RegionNode* region);
183
184 Node* generate_array_guard(Node* kls, RegionNode* region) {
185 return generate_array_guard_common(kls, region, AnyArray);
186 }
187 Node* generate_non_array_guard(Node* kls, RegionNode* region) {
188 return generate_array_guard_common(kls, region, NonArray);
189 }
190 Node* generate_objArray_guard(Node* kls, RegionNode* region) {
191 return generate_array_guard_common(kls, region, ObjectArray);
192 }
193 Node* generate_non_objArray_guard(Node* kls, RegionNode* region) {
194 return generate_array_guard_common(kls, region, NonObjectArray);
195 }
196 Node* generate_typeArray_guard(Node* kls, RegionNode* region) {
197 return generate_array_guard_common(kls, region, TypeArray);
198 }
199 Node* generate_array_guard_common(Node* kls, RegionNode* region, ArrayKind kind);
200 Node* generate_virtual_guard(Node* obj_klass, RegionNode* slow_region);
201 CallJavaNode* generate_method_call(vmIntrinsicID method_id, bool is_virtual, bool is_static, bool res_not_null);
202 CallJavaNode* generate_method_call_static(vmIntrinsicID method_id, bool res_not_null) {
203 return generate_method_call(method_id, false, true, res_not_null);
204 }
205 Node* load_field_from_object(Node* fromObj, const char* fieldName, const char* fieldTypeString, DecoratorSet decorators = IN_HEAP, bool is_static = false, ciInstanceKlass* fromKls = nullptr);
206 Node* field_address_from_object(Node* fromObj, const char* fieldName, const char* fieldTypeString, bool is_exact = true, bool is_static = false, ciInstanceKlass* fromKls = nullptr);
207
208 Node* make_string_method_node(int opcode, Node* str1_start, Node* cnt1, Node* str2_start, Node* cnt2, StrIntrinsicNode::ArgEnc ae);
209 bool inline_string_compareTo(StrIntrinsicNode::ArgEnc ae);
210 bool inline_string_indexOf(StrIntrinsicNode::ArgEnc ae);
211 bool inline_string_indexOfI(StrIntrinsicNode::ArgEnc ae);
212 Node* make_indexOf_node(Node* src_start, Node* src_count, Node* tgt_start, Node* tgt_count,
213 RegionNode* region, Node* phi, StrIntrinsicNode::ArgEnc ae);
214 bool inline_string_indexOfChar(StrIntrinsicNode::ArgEnc ae);
215 bool inline_string_equals(StrIntrinsicNode::ArgEnc ae);
216 bool inline_vectorizedHashCode();
217 bool inline_string_toBytesU();
218 bool inline_string_getCharsU();
219 bool inline_string_copy(bool compress);
220 bool inline_string_char_access(bool is_store);
221 Node* round_double_node(Node* n);
222 bool runtime_math(const TypeFunc* call_type, address funcAddr, const char* funcName);
223 bool inline_math_native(vmIntrinsics::ID id);
224 bool inline_math(vmIntrinsics::ID id);
225 bool inline_double_math(vmIntrinsics::ID id);
226 bool inline_math_pow();
227 template <typename OverflowOp>
228 bool inline_math_overflow(Node* arg1, Node* arg2);
229 void inline_math_mathExact(Node* math, Node* test);
230 bool inline_math_addExactI(bool is_increment);
231 bool inline_math_addExactL(bool is_increment);
232 bool inline_math_multiplyExactI();
233 bool inline_math_multiplyExactL();
234 bool inline_math_multiplyHigh();
235 bool inline_math_unsignedMultiplyHigh();
236 bool inline_math_negateExactI();
237 bool inline_math_negateExactL();
238 bool inline_math_subtractExactI(bool is_decrement);
239 bool inline_math_subtractExactL(bool is_decrement);
240 bool inline_min_max(vmIntrinsics::ID id);
241 bool inline_notify(vmIntrinsics::ID id);
242 Node* generate_min_max(vmIntrinsics::ID id, Node* x, Node* y);
243 // This returns Type::AnyPtr, RawPtr, or OopPtr.
244 int classify_unsafe_addr(Node* &base, Node* &offset, BasicType type);
245 Node* make_unsafe_address(Node*& base, Node* offset, BasicType type = T_ILLEGAL, bool can_cast = false);
246
247 typedef enum { Relaxed, Opaque, Volatile, Acquire, Release } AccessKind;
248 DecoratorSet mo_decorator_for_access_kind(AccessKind kind);
249 bool inline_unsafe_access(bool is_store, BasicType type, AccessKind kind, bool is_unaligned, bool is_flat = false);
250 static bool klass_needs_init_guard(Node* kls);
251 bool inline_unsafe_allocate();
252 bool inline_unsafe_newArray(bool uninitialized);
253 bool inline_newNullRestrictedArray();
254 bool inline_unsafe_writeback0();
255 bool inline_unsafe_writebackSync0(bool is_pre);
256 bool inline_unsafe_copyMemory();
257 bool inline_unsafe_isFlatArray();
258 bool inline_unsafe_make_private_buffer();
259 bool inline_unsafe_finish_private_buffer();
260 bool inline_unsafe_setMemory();
261
262 bool inline_native_currentCarrierThread();
263 bool inline_native_currentThread();
264 bool inline_native_setCurrentThread();
265
266 bool inline_native_scopedValueCache();
267 const Type* scopedValueCache_type();
268 Node* scopedValueCache_helper();
269 bool inline_native_setScopedValueCache();
270 bool inline_native_Continuation_pinning(bool unpin);
271
272 bool inline_native_time_funcs(address method, const char* funcName);
273 #if INCLUDE_JVMTI
274 bool inline_native_notify_jvmti_funcs(address funcAddr, const char* funcName, bool is_start, bool is_end);
275 bool inline_native_notify_jvmti_hide();
276 bool inline_native_notify_jvmti_sync();
277 #endif
278
279 #ifdef JFR_HAVE_INTRINSICS
280 bool inline_native_classID();
281 bool inline_native_getEventWriter();
282 bool inline_native_jvm_commit();
283 void extend_setCurrentThread(Node* jt, Node* thread);
284 #endif
285 bool inline_native_Class_query(vmIntrinsics::ID id);
286 bool inline_primitive_Class_conversion(vmIntrinsics::ID id);
287 bool inline_native_subtype_check();
288 bool inline_native_getLength();
289 bool inline_array_copyOf(bool is_copyOfRange);
290 bool inline_array_equals(StrIntrinsicNode::ArgEnc ae);
291 bool inline_preconditions_checkIndex(BasicType bt);
292 void copy_to_clone(Node* obj, Node* alloc_obj, Node* obj_size, bool is_array);
293 bool inline_native_clone(bool is_virtual);
294 bool inline_native_Reflection_getCallerClass();
295 // Helper function for inlining native object hash method
296 bool inline_native_hashcode(bool is_virtual, bool is_static);
297 bool inline_native_getClass();
298
299 // Helper functions for inlining arraycopy
300 bool inline_arraycopy();
301 AllocateArrayNode* tightly_coupled_allocation(Node* ptr);
302 static CallStaticJavaNode* get_uncommon_trap_from_success_proj(Node* node);
303 SafePointNode* create_safepoint_with_state_before_array_allocation(const AllocateArrayNode* alloc) const;
304 void replace_unrelated_uncommon_traps_with_alloc_state(AllocateArrayNode* alloc, JVMState* saved_jvms_before_guards);
305 void replace_unrelated_uncommon_traps_with_alloc_state(JVMState* saved_jvms_before_guards);
306 void create_new_uncommon_trap(CallStaticJavaNode* uncommon_trap_call);
307 JVMState* arraycopy_restore_alloc_state(AllocateArrayNode* alloc, int& saved_reexecute_sp);
308 void arraycopy_move_allocation_here(AllocateArrayNode* alloc, Node* dest, JVMState* saved_jvms_before_guards, int saved_reexecute_sp,
309 uint new_idx);
310 bool check_array_sort_arguments(Node* elementType, Node* obj, BasicType& bt);
311 bool inline_array_sort();
312 bool inline_array_partition();
313 typedef enum { LS_get_add, LS_get_set, LS_cmp_swap, LS_cmp_swap_weak, LS_cmp_exchange } LoadStoreKind;
314 bool inline_unsafe_load_store(BasicType type, LoadStoreKind kind, AccessKind access_kind);
315 bool inline_unsafe_fence(vmIntrinsics::ID id);
316 bool inline_onspinwait();
317 bool inline_fp_conversions(vmIntrinsics::ID id);
318 bool inline_fp_range_check(vmIntrinsics::ID id);
319 bool inline_number_methods(vmIntrinsics::ID id);
320 bool inline_bitshuffle_methods(vmIntrinsics::ID id);
321 bool inline_compare_unsigned(vmIntrinsics::ID id);
322 bool inline_divmod_methods(vmIntrinsics::ID id);
323 bool inline_reference_get();
324 bool inline_reference_refersTo0(bool is_phantom);
325 bool inline_Class_cast();
326 bool inline_aescrypt_Block(vmIntrinsics::ID id);
327 bool inline_cipherBlockChaining_AESCrypt(vmIntrinsics::ID id);
328 bool inline_electronicCodeBook_AESCrypt(vmIntrinsics::ID id);
329 bool inline_counterMode_AESCrypt(vmIntrinsics::ID id);
330 Node* inline_cipherBlockChaining_AESCrypt_predicate(bool decrypting);
331 Node* inline_electronicCodeBook_AESCrypt_predicate(bool decrypting);
332 Node* inline_counterMode_AESCrypt_predicate();
333 Node* get_key_start_from_aescrypt_object(Node* aescrypt_object);
334 bool inline_ghash_processBlocks();
335 bool inline_chacha20Block();
336 bool inline_base64_encodeBlock();
337 bool inline_base64_decodeBlock();
338 bool inline_poly1305_processBlocks();
339 bool inline_intpoly_montgomeryMult_P256();
340 bool inline_intpoly_assign();
341 bool inline_digestBase_implCompress(vmIntrinsics::ID id);
342 bool inline_digestBase_implCompressMB(int predicate);
343 bool inline_digestBase_implCompressMB(Node* digestBaseObj, ciInstanceKlass* instklass,
344 BasicType elem_type, address stubAddr, const char *stubName,
345 Node* src_start, Node* ofs, Node* limit);
346 Node* get_state_from_digest_object(Node *digestBase_object, BasicType elem_type);
347 Node* get_block_size_from_digest_object(Node *digestBase_object);
348 Node* inline_digestBase_implCompressMB_predicate(int predicate);
349 bool inline_encodeISOArray(bool ascii);
350 bool inline_updateCRC32();
351 bool inline_updateBytesCRC32();
352 bool inline_updateByteBufferCRC32();
353 Node* get_table_from_crc32c_class(ciInstanceKlass *crc32c_class);
354 bool inline_updateBytesCRC32C();
355 bool inline_updateDirectByteBufferCRC32C();
356 bool inline_updateBytesAdler32();
357 bool inline_updateByteBufferAdler32();
358 bool inline_multiplyToLen();
359 bool inline_countPositives();
360 bool inline_squareToLen();
361 bool inline_mulAdd();
362 bool inline_montgomeryMultiply();
363 bool inline_montgomerySquare();
364 bool inline_bigIntegerShift(bool isRightShift);
365 bool inline_vectorizedMismatch();
366 bool inline_fma(vmIntrinsics::ID id);
367 bool inline_character_compare(vmIntrinsics::ID id);
368 bool inline_fp_min_max(vmIntrinsics::ID id);
369 bool inline_galoisCounterMode_AESCrypt();
370 Node* inline_galoisCounterMode_AESCrypt_predicate();
371
372 bool inline_profileBoolean();
373 bool inline_isCompileConstant();
374
375 bool inline_continuation_do_yield();
376
377 // Vector API support
378 bool inline_vector_nary_operation(int n);
379 bool inline_vector_frombits_coerced();
380 bool inline_vector_shuffle_to_vector();
381 bool inline_vector_shuffle_iota();
382 Node* partially_wrap_indexes(Node* index_vec, int num_elem, BasicType type_bt);
383 bool inline_vector_mask_operation();
384 bool inline_vector_mem_operation(bool is_store);
385 bool inline_vector_mem_masked_operation(bool is_store);
386 bool inline_vector_gather_scatter(bool is_scatter);
387 bool inline_vector_reduction();
388 bool inline_vector_test();
389 bool inline_vector_blend();
390 bool inline_vector_rearrange();
391 bool inline_vector_compare();
392 bool inline_vector_broadcast_int();
393 bool inline_vector_convert();
394 bool inline_vector_extract();
395 bool inline_vector_insert();
396 bool inline_vector_compress_expand();
397 bool inline_index_vector();
398 bool inline_index_partially_in_upper_range();
399
400 Node* gen_call_to_svml(int vector_api_op_id, BasicType bt, int num_elem, Node* opd1, Node* opd2);
401
402 enum VectorMaskUseType {
403 VecMaskUseLoad = 1 << 0,
404 VecMaskUseStore = 1 << 1,
405 VecMaskUseAll = VecMaskUseLoad | VecMaskUseStore,
406 VecMaskUsePred = 1 << 2,
407 VecMaskNotUsed = 1 << 3
408 };
409
410 bool arch_supports_vector(int op, int num_elem, BasicType type, VectorMaskUseType mask_use_type, bool has_scalar_args = false);
411 bool arch_supports_vector_rotate(int opc, int num_elem, BasicType elem_bt, VectorMaskUseType mask_use_type, bool has_scalar_args = false);
412
413 void clear_upper_avx() {
414 #ifdef X86
415 if (UseAVX >= 2) {
416 C->set_clear_upper_avx(true);
417 }
418 #endif
419 }
420
421 bool inline_getObjectSize();
422
423 bool inline_blackhole();
424 };
425