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