1 /*
2 * Copyright (c) 1998, 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 #ifndef SHARE_OPTO_RUNTIME_HPP
26 #define SHARE_OPTO_RUNTIME_HPP
27
28 #include "code/codeBlob.hpp"
29 #include "opto/machnode.hpp"
30 #include "opto/optoreg.hpp"
31 #include "runtime/stubDeclarations.hpp"
32 #include "runtime/vframe.hpp"
33
34 //------------------------------OptoRuntime------------------------------------
35 // Opto compiler runtime routines
36 //
37 // These are all generated from Ideal graphs. They are called with the
38 // Java calling convention. Internally they call C++. They are made once at
39 // startup time and Opto compiles calls to them later.
40 // Things are broken up into quads: the signature they will be called with,
41 // the address of the generated code, the corresponding C++ code and an
42 // nmethod.
43
44 // The signature (returned by "xxx_Type()") is used at startup time by the
45 // Generator to make the generated code "xxx_Java". Opto compiles calls
46 // to the generated code "xxx_Java". When the compiled code gets executed,
47 // it calls the C++ code "xxx_C". The generated nmethod is saved in the
48 // CodeCache. Exception handlers use the nmethod to get the callee-save
49 // register OopMaps.
50 class CallInfo;
51
52 //
53 // NamedCounters are tagged counters which can be used for profiling
54 // code in various ways. Currently they are used by the lock coarsening code
55 //
56
57 class NamedCounter : public CHeapObj<mtCompiler> {
58 public:
59 enum CounterTag {
60 NoTag,
61 LockCounter,
62 EliminatedLockCounter
63 };
64
65 private:
66 const char * _name;
67 int _count;
68 CounterTag _tag;
69 NamedCounter* _next;
70
71 public:
72 NamedCounter(const char *n, CounterTag tag = NoTag):
73 _name(n == nullptr ? nullptr : os::strdup(n)),
74 _count(0),
75 _tag(tag),
76 _next(nullptr) {}
77
78 ~NamedCounter() {
79 if (_name != nullptr) {
80 os::free((void*)_name);
81 }
82 }
83
84 const char * name() const { return _name; }
85 int count() const { return _count; }
86 address addr() { return (address)&_count; }
87 CounterTag tag() const { return _tag; }
88 void set_tag(CounterTag tag) { _tag = tag; }
89
90 NamedCounter* next() const { return _next; }
91 void set_next(NamedCounter* next) {
92 assert(_next == nullptr || next == nullptr, "already set");
93 _next = next;
94 }
95
96 };
97
98 typedef const TypeFunc*(*TypeFunc_generator)();
99
100 // define OptoStubId enum tags: uncommon_trap_id etc
101
102 #define C2_BLOB_ID_ENUM_DECLARE(name, type) STUB_ID_NAME(name),
103 #define C2_STUB_ID_ENUM_DECLARE(name, f, t, r) STUB_ID_NAME(name),
104 #define C2_JVMTI_STUB_ID_ENUM_DECLARE(name) STUB_ID_NAME(name),
105 enum class OptoStubId :int {
106 NO_STUBID = -1,
107 C2_STUBS_DO(C2_BLOB_ID_ENUM_DECLARE, C2_STUB_ID_ENUM_DECLARE, C2_JVMTI_STUB_ID_ENUM_DECLARE)
108 NUM_STUBIDS
109 };
110 #undef C2_BLOB_ID_ENUM_DECLARE
111 #undef C2_STUB_ID_ENUM_DECLARE
112 #undef C2_JVMTI_STUB_ID_ENUM_DECLARE
113
114 class OptoRuntime : public AllStatic {
115 friend class Matcher; // allow access to stub names
116
117 private:
118 // declare opto stub address/blob holder static fields
119 #define C2_BLOB_FIELD_DECLARE(name, type) \
120 static type BLOB_FIELD_NAME(name);
121 #define C2_STUB_FIELD_NAME(name) _ ## name ## _Java
122 #define C2_STUB_FIELD_DECLARE(name, f, t, r) \
123 static address C2_STUB_FIELD_NAME(name) ;
124 #define C2_JVMTI_STUB_FIELD_DECLARE(name) \
125 static address STUB_FIELD_NAME(name);
126
127 C2_STUBS_DO(C2_BLOB_FIELD_DECLARE, C2_STUB_FIELD_DECLARE, C2_JVMTI_STUB_FIELD_DECLARE)
128
129 #undef C2_BLOB_FIELD_DECLARE
130 #undef C2_STUB_FIELD_NAME
131 #undef C2_STUB_FIELD_DECLARE
132 #undef C2_JVMTI_STUB_FIELD_DECLARE
133
134 // Stub names indexed by sharedStubId
135 static const char *_stub_names[];
136
137 // define stubs
138 static address generate_stub(ciEnv* ci_env, TypeFunc_generator gen, address C_function, const char* name, int is_fancy_jump, bool pass_tls, bool return_pc);
139
140 //
141 // Implementation of runtime methods
142 // =================================
143
144 // Allocate storage for a Java instance.
145 static void new_instance_C(Klass* instance_klass, JavaThread* current);
146
147 // Allocate storage for a objArray or typeArray
148 static void new_array_C(Klass* array_klass, int len, JavaThread* current);
149 static void new_array_nozero_C(Klass* array_klass, int len, JavaThread* current);
150
151 // Allocate storage for a multi-dimensional arrays
152 // Note: needs to be fixed for arbitrary number of dimensions
153 static void multianewarray2_C(Klass* klass, int len1, int len2, JavaThread* current);
154 static void multianewarray3_C(Klass* klass, int len1, int len2, int len3, JavaThread* current);
155 static void multianewarray4_C(Klass* klass, int len1, int len2, int len3, int len4, JavaThread* current);
156 static void multianewarray5_C(Klass* klass, int len1, int len2, int len3, int len4, int len5, JavaThread* current);
157 static void multianewarrayN_C(Klass* klass, arrayOopDesc* dims, JavaThread* current);
158
159 // local methods passed as arguments to stub generator that forward
160 // control to corresponding JRT methods of SharedRuntime
161 static void slow_arraycopy_C(oopDesc* src, jint src_pos,
162 oopDesc* dest, jint dest_pos,
163 jint length, JavaThread* thread);
164 static void complete_monitor_locking_C(oopDesc* obj, BasicLock* lock, JavaThread* current);
165
166 public:
167 static void monitor_notify_C(oopDesc* obj, JavaThread* current);
168 static void monitor_notifyAll_C(oopDesc* obj, JavaThread* current);
169
170 private:
171
172 // Implicit exception support
173 static void throw_null_exception_C(JavaThread* thread);
174
175 // Exception handling
176 static address handle_exception_C (JavaThread* current);
177 static address handle_exception_C_helper(JavaThread* current, nmethod*& nm);
178 static address rethrow_C (oopDesc* exception, JavaThread *thread, address return_pc );
179 static void deoptimize_caller_frame (JavaThread *thread);
180 static void deoptimize_caller_frame (JavaThread *thread, bool doit);
181 static bool is_deoptimized_caller_frame (JavaThread *thread);
182
183 // CodeBlob support
184 // ===================================================================
185
186 static void generate_uncommon_trap_blob(void);
187 static void generate_exception_blob();
188
189 static void register_finalizer_C(oopDesc* obj, JavaThread* current);
190
191 public:
192
193 static bool is_callee_saved_register(MachRegisterNumbers reg);
194
195 // One time only generate runtime code stubs. Returns true
196 // when runtime stubs have been generated successfully and
197 // false otherwise.
198 static bool generate(ciEnv* env);
199
200 // Returns the name of a stub
201 static const char* stub_name(address entry);
202
203 // Returns the name associated with a given stub id
204 static const char* stub_name(OptoStubId id) {
205 assert(id > OptoStubId::NO_STUBID && id < OptoStubId::NUM_STUBIDS, "stub id out of range");
206 return _stub_names[(int)id];
207 }
208
209 // access to runtime stubs entry points for java code
210 static address new_instance_Java() { return _new_instance_Java; }
211 static address new_array_Java() { return _new_array_Java; }
212 static address new_array_nozero_Java() { return _new_array_nozero_Java; }
213 static address multianewarray2_Java() { return _multianewarray2_Java; }
214 static address multianewarray3_Java() { return _multianewarray3_Java; }
215 static address multianewarray4_Java() { return _multianewarray4_Java; }
216 static address multianewarray5_Java() { return _multianewarray5_Java; }
217 static address multianewarrayN_Java() { return _multianewarrayN_Java; }
218 static address complete_monitor_locking_Java() { return _complete_monitor_locking_Java; }
219 static address monitor_notify_Java() { return _monitor_notify_Java; }
220 static address monitor_notifyAll_Java() { return _monitor_notifyAll_Java; }
221
222 static address slow_arraycopy_Java() { return _slow_arraycopy_Java; }
223 static address register_finalizer_Java() { return _register_finalizer_Java; }
224 #if INCLUDE_JVMTI
225 static address notify_jvmti_vthread_start() { return _notify_jvmti_vthread_start; }
226 static address notify_jvmti_vthread_end() { return _notify_jvmti_vthread_end; }
227 static address notify_jvmti_vthread_mount() { return _notify_jvmti_vthread_mount; }
228 static address notify_jvmti_vthread_unmount() { return _notify_jvmti_vthread_unmount; }
229 #endif
230
231 static UncommonTrapBlob* uncommon_trap_blob() { return _uncommon_trap_blob; }
232 static ExceptionBlob* exception_blob() { return _exception_blob; }
233
234 // Implicit exception support
235 static void throw_div0_exception_C (JavaThread* thread);
236 static void throw_stack_overflow_error_C(JavaThread* thread);
237
238 // Exception handling
239 static address rethrow_stub() { return _rethrow_Java; }
240
241
242 // Type functions
243 // ======================================================
244
245 static const TypeFunc* new_instance_Type(); // object allocation (slow case)
246 static const TypeFunc* new_array_Type (); // [a]newarray (slow case)
247 static const TypeFunc* new_array_nozero_Type (); // [a]newarray (slow case)
248 static const TypeFunc* multianewarray_Type(int ndim); // multianewarray
249 static const TypeFunc* multianewarray2_Type(); // multianewarray
250 static const TypeFunc* multianewarray3_Type(); // multianewarray
251 static const TypeFunc* multianewarray4_Type(); // multianewarray
252 static const TypeFunc* multianewarray5_Type(); // multianewarray
253 static const TypeFunc* multianewarrayN_Type(); // multianewarray
254 static const TypeFunc* complete_monitor_enter_Type();
255 static const TypeFunc* complete_monitor_locking_Type();
256 static const TypeFunc* complete_monitor_exit_Type();
257 static const TypeFunc* monitor_notify_Type();
258 static const TypeFunc* monitor_notifyAll_Type();
259 static const TypeFunc* uncommon_trap_Type();
260 static const TypeFunc* athrow_Type();
261 static const TypeFunc* rethrow_Type();
262 static const TypeFunc* Math_D_D_Type(); // sin,cos & friends
263 static const TypeFunc* Math_DD_D_Type(); // mod,pow & friends
264 static const TypeFunc* Math_Vector_Vector_Type(uint num_arg, const TypeVect* in_type, const TypeVect* out_type);
265 static const TypeFunc* modf_Type();
266 static const TypeFunc* l2f_Type();
267 static const TypeFunc* void_long_Type();
268 static const TypeFunc* void_void_Type();
269
270 static const TypeFunc* jfr_write_checkpoint_Type();
271
272 static const TypeFunc* flush_windows_Type();
273
274 // arraycopy routine types
275 static const TypeFunc* fast_arraycopy_Type(); // bit-blasters
276 static const TypeFunc* checkcast_arraycopy_Type();
277 static const TypeFunc* generic_arraycopy_Type();
278 static const TypeFunc* slow_arraycopy_Type(); // the full routine
279
280 static const TypeFunc* make_setmemory_Type();
281
282 static const TypeFunc* array_fill_Type();
283
284 static const TypeFunc* array_sort_Type();
285 static const TypeFunc* array_partition_Type();
286 static const TypeFunc* aescrypt_block_Type();
287 static const TypeFunc* cipherBlockChaining_aescrypt_Type();
288 static const TypeFunc* electronicCodeBook_aescrypt_Type();
289 static const TypeFunc* counterMode_aescrypt_Type();
290 static const TypeFunc* galoisCounterMode_aescrypt_Type();
291
292 static const TypeFunc* digestBase_implCompress_Type(bool is_sha3);
293 static const TypeFunc* digestBase_implCompressMB_Type(bool is_sha3);
294
295 static const TypeFunc* multiplyToLen_Type();
296 static const TypeFunc* montgomeryMultiply_Type();
297 static const TypeFunc* montgomerySquare_Type();
298
299 static const TypeFunc* squareToLen_Type();
300
301 static const TypeFunc* mulAdd_Type();
302
303 static const TypeFunc* bigIntegerShift_Type();
304
305 static const TypeFunc* vectorizedMismatch_Type();
306
307 static const TypeFunc* ghash_processBlocks_Type();
308 static const TypeFunc* chacha20Block_Type();
309 static const TypeFunc* base64_encodeBlock_Type();
310 static const TypeFunc* base64_decodeBlock_Type();
311 static const TypeFunc* string_IndexOf_Type();
312 static const TypeFunc* poly1305_processBlocks_Type();
313 static const TypeFunc* intpoly_montgomeryMult_P256_Type();
314 static const TypeFunc* intpoly_assign_Type();
315
316 static const TypeFunc* updateBytesCRC32_Type();
317 static const TypeFunc* updateBytesCRC32C_Type();
318
319 static const TypeFunc* updateBytesAdler32_Type();
320
321 // leaf on stack replacement interpreter accessor types
322 static const TypeFunc* osr_end_Type();
323
324 static const TypeFunc* register_finalizer_Type();
325
326 JFR_ONLY(static const TypeFunc* class_id_load_barrier_Type();)
327 #if INCLUDE_JVMTI
328 static const TypeFunc* notify_jvmti_vthread_Type();
329 #endif
330
331 // Dtrace support
332 static const TypeFunc* dtrace_method_entry_exit_Type();
333 static const TypeFunc* dtrace_object_alloc_Type();
334
335 private:
336 static NamedCounter * volatile _named_counters;
337
338 public:
339 // helper function which creates a named counter labeled with the
340 // if they are available
341 static NamedCounter* new_named_counter(JVMState* jvms, NamedCounter::CounterTag tag);
342
343 // dumps all the named counters
344 static void print_named_counters();
345
346 };
347
348 #endif // SHARE_OPTO_RUNTIME_HPP