1 /*
2 * Copyright (c) 1998, 2010, 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_VM_OPTO_RUNTIME_HPP
26 #define SHARE_VM_OPTO_RUNTIME_HPP
27
28 #include "code/codeBlob.hpp"
29 #include "opto/machnode.hpp"
30 #include "opto/type.hpp"
31 #include "runtime/biasedLocking.hpp"
32 #include "runtime/deoptimization.hpp"
33 #include "runtime/vframe.hpp"
34
35 //------------------------------OptoRuntime------------------------------------
36 // Opto compiler runtime routines
37 //
38 // These are all generated from Ideal graphs. They are called with the
39 // Java calling convention. Internally they call C++. They are made once at
40 // startup time and Opto compiles calls to them later.
41 // Things are broken up into quads: the signature they will be called with,
42 // the address of the generated code, the corresponding C++ code and an
43 // nmethod.
44
45 // The signature (returned by "xxx_Type()") is used at startup time by the
46 // Generator to make the generated code "xxx_Java". Opto compiles calls
47 // to the generated code "xxx_Java". When the compiled code gets executed,
48 // it calls the C++ code "xxx_C". The generated nmethod is saved in the
49 // CodeCache. Exception handlers use the nmethod to get the callee-save
50 // register OopMaps.
51 class CallInfo;
52
53 //
54 // NamedCounters are tagged counters which can be used for profiling
55 // code in various ways. Currently they are used by the lock coarsening code
56 //
57
58 class NamedCounter : public CHeapObj {
59 public:
60 enum CounterTag {
61 NoTag,
62 LockCounter,
63 EliminatedLockCounter,
64 BiasedLockingCounter
65 };
66
67 private:
68 const char * _name;
69 int _count;
70 CounterTag _tag;
71 NamedCounter* _next;
72
73 public:
74 NamedCounter(const char *n, CounterTag tag = NoTag):
75 _name(n),
76 _count(0),
77 _next(NULL),
78 _tag(tag) {}
79
80 const char * name() const { return _name; }
81 int count() const { return _count; }
82 address addr() { return (address)&_count; }
83 CounterTag tag() const { return _tag; }
84 void set_tag(CounterTag tag) { _tag = tag; }
85
86 NamedCounter* next() const { return _next; }
87 void set_next(NamedCounter* next) {
88 assert(_next == NULL, "already set");
89 _next = next;
90 }
91
92 };
93
94 class BiasedLockingNamedCounter : public NamedCounter {
95 private:
96 BiasedLockingCounters _counters;
97
98 public:
99 BiasedLockingNamedCounter(const char *n) :
100 NamedCounter(n, BiasedLockingCounter), _counters() {}
101
102 BiasedLockingCounters* counters() { return &_counters; }
103 };
104
105 typedef const TypeFunc*(*TypeFunc_generator)();
106
107 class OptoRuntime : public AllStatic {
108 friend class Matcher; // allow access to stub names
109
110 private:
111 // define stubs
112 static address generate_stub(ciEnv* ci_env, TypeFunc_generator gen, address C_function, const char *name, int is_fancy_jump, bool pass_tls, bool save_arguments, bool return_pc);
113
114 // References to generated stubs
115 static address _new_instance_Java;
116 static address _new_array_Java;
117 static address _multianewarray2_Java;
118 static address _multianewarray3_Java;
119 static address _multianewarray4_Java;
120 static address _multianewarray5_Java;
121 static address _g1_wb_pre_Java;
122 static address _g1_wb_post_Java;
123 static address _vtable_must_compile_Java;
124 static address _complete_monitor_locking_Java;
125 static address _rethrow_Java;
126
127 static address _slow_arraycopy_Java;
128 static address _register_finalizer_Java;
129
130 # ifdef ENABLE_ZAP_DEAD_LOCALS
131 static address _zap_dead_Java_locals_Java;
132 static address _zap_dead_native_locals_Java;
133 # endif
134
135
136 //
137 // Implementation of runtime methods
138 // =================================
139
140 // Allocate storage for a Java instance.
141 static void new_instance_C(klassOopDesc* instance_klass, JavaThread *thread);
142
143 // Allocate storage for a objArray or typeArray
144 static void new_array_C(klassOopDesc* array_klass, int len, JavaThread *thread);
145
146 // Post-slow-path-allocation, pre-initializing-stores step for
147 // implementing ReduceInitialCardMarks
148 static void new_store_pre_barrier(JavaThread* thread);
149
150 // Allocate storage for a multi-dimensional arrays
151 // Note: needs to be fixed for arbitrary number of dimensions
152 static void multianewarray2_C(klassOopDesc* klass, int len1, int len2, JavaThread *thread);
153 static void multianewarray3_C(klassOopDesc* klass, int len1, int len2, int len3, JavaThread *thread);
154 static void multianewarray4_C(klassOopDesc* klass, int len1, int len2, int len3, int len4, JavaThread *thread);
155 static void multianewarray5_C(klassOopDesc* klass, int len1, int len2, int len3, int len4, int len5, JavaThread *thread);
156 static void g1_wb_pre_C(oopDesc* orig, JavaThread* thread);
157 static void g1_wb_post_C(void* card_addr, JavaThread* thread);
158
159 public:
160 // Slow-path Locking and Unlocking
161 static void complete_monitor_locking_C(oopDesc* obj, BasicLock* lock, JavaThread* thread);
162 static void complete_monitor_unlocking_C(oopDesc* obj, BasicLock* lock);
163
164 private:
165
166 // Implicit exception support
167 static void throw_null_exception_C(JavaThread* thread);
168
169 // Exception handling
170 static address handle_exception_C (JavaThread* thread);
171 static address handle_exception_C_helper(JavaThread* thread, nmethod*& nm);
172 static address rethrow_C (oopDesc* exception, JavaThread *thread, address return_pc );
173 static void deoptimize_caller_frame (JavaThread *thread, bool doit);
174
175 // CodeBlob support
176 // ===================================================================
177
178 static ExceptionBlob* _exception_blob;
179 static void generate_exception_blob();
180
181 static void register_finalizer(oopDesc* obj, JavaThread* thread);
182
183 // zaping dead locals, either from Java frames or from native frames
184 # ifdef ENABLE_ZAP_DEAD_LOCALS
185 static void zap_dead_Java_locals_C( JavaThread* thread);
186 static void zap_dead_native_locals_C( JavaThread* thread);
187
188 static void zap_dead_java_or_native_locals( JavaThread*, bool (*)(frame*));
189
190 public:
191 static int ZapDeadCompiledLocals_count;
192
193 # endif
194
195
196 public:
197
198 static bool is_callee_saved_register(MachRegisterNumbers reg);
199
200 // One time only generate runtime code stubs
201 static void generate(ciEnv* env);
202
203 // Returns the name of a stub
204 static const char* stub_name(address entry);
205
206 // access to runtime stubs entry points for java code
207 static address new_instance_Java() { return _new_instance_Java; }
208 static address new_array_Java() { return _new_array_Java; }
209 static address multianewarray2_Java() { return _multianewarray2_Java; }
210 static address multianewarray3_Java() { return _multianewarray3_Java; }
211 static address multianewarray4_Java() { return _multianewarray4_Java; }
212 static address multianewarray5_Java() { return _multianewarray5_Java; }
213 static address g1_wb_pre_Java() { return _g1_wb_pre_Java; }
214 static address g1_wb_post_Java() { return _g1_wb_post_Java; }
215 static address vtable_must_compile_stub() { return _vtable_must_compile_Java; }
216 static address complete_monitor_locking_Java() { return _complete_monitor_locking_Java; }
217
218 static address slow_arraycopy_Java() { return _slow_arraycopy_Java; }
219 static address register_finalizer_Java() { return _register_finalizer_Java; }
220
221
222 # ifdef ENABLE_ZAP_DEAD_LOCALS
223 static address zap_dead_locals_stub(bool is_native) { return is_native
224 ? _zap_dead_native_locals_Java
225 : _zap_dead_Java_locals_Java; }
226 static MachNode* node_to_call_zap_dead_locals(Node* n, int block_num, bool is_native);
227 # endif
228
229 static ExceptionBlob* exception_blob() { return _exception_blob; }
230
231 // Leaf routines helping with method data update
232 static void profile_receiver_type_C(DataLayout* data, oopDesc* receiver);
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* multianewarray_Type(int ndim); // multianewarray
248 static const TypeFunc* multianewarray2_Type(); // multianewarray
249 static const TypeFunc* multianewarray3_Type(); // multianewarray
250 static const TypeFunc* multianewarray4_Type(); // multianewarray
251 static const TypeFunc* multianewarray5_Type(); // multianewarray
252 static const TypeFunc* g1_wb_pre_Type();
253 static const TypeFunc* g1_wb_post_Type();
254 static const TypeFunc* complete_monitor_enter_Type();
255 static const TypeFunc* complete_monitor_exit_Type();
256 static const TypeFunc* uncommon_trap_Type();
257 static const TypeFunc* athrow_Type();
258 static const TypeFunc* rethrow_Type();
259 static const TypeFunc* Math_D_D_Type(); // sin,cos & friends
260 static const TypeFunc* Math_DD_D_Type(); // mod,pow & friends
261 static const TypeFunc* modf_Type();
262 static const TypeFunc* l2f_Type();
263 static const TypeFunc* current_time_millis_Type();
264
265 static const TypeFunc* flush_windows_Type();
266
267 // arraycopy routine types
268 static const TypeFunc* fast_arraycopy_Type(); // bit-blasters
269 static const TypeFunc* checkcast_arraycopy_Type();
270 static const TypeFunc* generic_arraycopy_Type();
271 static const TypeFunc* slow_arraycopy_Type(); // the full routine
272
273 static const TypeFunc* array_fill_Type();
274
275 // leaf on stack replacement interpreter accessor types
276 static const TypeFunc* osr_end_Type();
277
278 // leaf methodData routine types
279 static const TypeFunc* profile_receiver_type_Type();
280
281 // leaf on stack replacement interpreter accessor types
282 static const TypeFunc* fetch_int_Type();
283 static const TypeFunc* fetch_long_Type();
284 static const TypeFunc* fetch_float_Type();
285 static const TypeFunc* fetch_double_Type();
286 static const TypeFunc* fetch_oop_Type();
287 static const TypeFunc* fetch_monitor_Type();
288
289 static const TypeFunc* register_finalizer_Type();
290
291 // Dtrace support
292 static const TypeFunc* dtrace_method_entry_exit_Type();
293 static const TypeFunc* dtrace_object_alloc_Type();
294
295 # ifdef ENABLE_ZAP_DEAD_LOCALS
296 static const TypeFunc* zap_dead_locals_Type();
297 # endif
298
299 private:
300 static NamedCounter * volatile _named_counters;
301
302 public:
303 // helper function which creates a named counter labeled with the
304 // if they are available
305 static NamedCounter* new_named_counter(JVMState* jvms, NamedCounter::CounterTag tag);
306
307 // dumps all the named counters
308 static void print_named_counters();
309
310 };
311
312 #endif // SHARE_VM_OPTO_RUNTIME_HPP