runtime.hpp revision 3274:0105f367a14c 
1/*
2 * Copyright (c) 1998, 2012, 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.
51class 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
58class NamedCounter : public CHeapObj {
59public:
60    enum CounterTag {
61    NoTag,
62    LockCounter,
63    EliminatedLockCounter,
64    BiasedLockingCounter
65  };
66
67private:
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
94class 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
105typedef const TypeFunc*(*TypeFunc_generator)();
106
107class 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 _new_array_nozero_Java;
118  static address _multianewarray2_Java;
119  static address _multianewarray3_Java;
120  static address _multianewarray4_Java;
121  static address _multianewarray5_Java;
122  static address _multianewarrayN_Java;
123  static address _g1_wb_pre_Java;
124  static address _g1_wb_post_Java;
125  static address _vtable_must_compile_Java;
126  static address _complete_monitor_locking_Java;
127  static address _rethrow_Java;
128
129  static address _slow_arraycopy_Java;
130  static address _register_finalizer_Java;
131
132# ifdef ENABLE_ZAP_DEAD_LOCALS
133  static address _zap_dead_Java_locals_Java;
134  static address _zap_dead_native_locals_Java;
135# endif
136
137
138  //
139  // Implementation of runtime methods
140  // =================================
141
142  // Allocate storage for a Java instance.
143  static void new_instance_C(klassOopDesc* instance_klass, JavaThread *thread);
144
145  // Allocate storage for a objArray or typeArray
146  static void new_array_C(klassOopDesc* array_klass, int len, JavaThread *thread);
147  static void new_array_nozero_C(klassOopDesc* array_klass, int len, JavaThread *thread);
148
149  // Post-slow-path-allocation, pre-initializing-stores step for
150  // implementing ReduceInitialCardMarks
151  static void new_store_pre_barrier(JavaThread* thread);
152
153  // Allocate storage for a multi-dimensional arrays
154  // Note: needs to be fixed for arbitrary number of dimensions
155  static void multianewarray2_C(klassOopDesc* klass, int len1, int len2, JavaThread *thread);
156  static void multianewarray3_C(klassOopDesc* klass, int len1, int len2, int len3, JavaThread *thread);
157  static void multianewarray4_C(klassOopDesc* klass, int len1, int len2, int len3, int len4, JavaThread *thread);
158  static void multianewarray5_C(klassOopDesc* klass, int len1, int len2, int len3, int len4, int len5, JavaThread *thread);
159  static void multianewarrayN_C(klassOopDesc* klass, arrayOopDesc* dims, JavaThread *thread);
160  static void g1_wb_pre_C(oopDesc* orig, JavaThread* thread);
161  static void g1_wb_post_C(void* card_addr, JavaThread* thread);
162
163public:
164  // Slow-path Locking and Unlocking
165  static void complete_monitor_locking_C(oopDesc* obj, BasicLock* lock, JavaThread* thread);
166  static void complete_monitor_unlocking_C(oopDesc* obj, BasicLock* lock);
167
168private:
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* thread);
175  static address handle_exception_C_helper(JavaThread* thread, nmethod*& nm);
176  static address rethrow_C                (oopDesc* exception, JavaThread *thread, address return_pc );
177  static void deoptimize_caller_frame     (JavaThread *thread, bool doit);
178  static bool is_deoptimized_caller_frame (JavaThread *thread);
179
180  // CodeBlob support
181  // ===================================================================
182
183  static ExceptionBlob*       _exception_blob;
184  static void generate_exception_blob();
185
186  static void register_finalizer(oopDesc* obj, JavaThread* thread);
187
188  // zaping dead locals, either from Java frames or from native frames
189# ifdef ENABLE_ZAP_DEAD_LOCALS
190  static void zap_dead_Java_locals_C(   JavaThread* thread);
191  static void zap_dead_native_locals_C( JavaThread* thread);
192
193  static void zap_dead_java_or_native_locals( JavaThread*, bool (*)(frame*));
194
195 public:
196   static int ZapDeadCompiledLocals_count;
197
198# endif
199
200
201 public:
202
203  static bool is_callee_saved_register(MachRegisterNumbers reg);
204
205  // One time only generate runtime code stubs
206  static void generate(ciEnv* env);
207
208  // Returns the name of a stub
209  static const char* stub_name(address entry);
210
211  // access to runtime stubs entry points for java code
212  static address new_instance_Java()                     { return _new_instance_Java; }
213  static address new_array_Java()                        { return _new_array_Java; }
214  static address new_array_nozero_Java()                 { return _new_array_nozero_Java; }
215  static address multianewarray2_Java()                  { return _multianewarray2_Java; }
216  static address multianewarray3_Java()                  { return _multianewarray3_Java; }
217  static address multianewarray4_Java()                  { return _multianewarray4_Java; }
218  static address multianewarray5_Java()                  { return _multianewarray5_Java; }
219  static address multianewarrayN_Java()                  { return _multianewarrayN_Java; }
220  static address g1_wb_pre_Java()                        { return _g1_wb_pre_Java; }
221  static address g1_wb_post_Java()                       { return _g1_wb_post_Java; }
222  static address vtable_must_compile_stub()              { return _vtable_must_compile_Java; }
223  static address complete_monitor_locking_Java()         { return _complete_monitor_locking_Java;   }
224
225  static address slow_arraycopy_Java()                   { return _slow_arraycopy_Java; }
226  static address register_finalizer_Java()               { return _register_finalizer_Java; }
227
228
229# ifdef ENABLE_ZAP_DEAD_LOCALS
230  static address zap_dead_locals_stub(bool is_native)    { return is_native
231                                                                  ? _zap_dead_native_locals_Java
232                                                                  : _zap_dead_Java_locals_Java; }
233  static MachNode* node_to_call_zap_dead_locals(Node* n, int block_num, bool is_native);
234# endif
235
236  static ExceptionBlob*    exception_blob()                      { return _exception_blob; }
237
238  // Leaf routines helping with method data update
239  static void profile_receiver_type_C(DataLayout* data, oopDesc* receiver);
240
241  // Implicit exception support
242  static void throw_div0_exception_C      (JavaThread* thread);
243  static void throw_stack_overflow_error_C(JavaThread* thread);
244
245  // Exception handling
246  static address rethrow_stub()             { return _rethrow_Java; }
247
248
249  // Type functions
250  // ======================================================
251
252  static const TypeFunc* new_instance_Type(); // object allocation (slow case)
253  static const TypeFunc* new_array_Type ();   // [a]newarray (slow case)
254  static const TypeFunc* multianewarray_Type(int ndim); // multianewarray
255  static const TypeFunc* multianewarray2_Type(); // multianewarray
256  static const TypeFunc* multianewarray3_Type(); // multianewarray
257  static const TypeFunc* multianewarray4_Type(); // multianewarray
258  static const TypeFunc* multianewarray5_Type(); // multianewarray
259  static const TypeFunc* multianewarrayN_Type(); // multianewarray
260  static const TypeFunc* g1_wb_pre_Type();
261  static const TypeFunc* g1_wb_post_Type();
262  static const TypeFunc* complete_monitor_enter_Type();
263  static const TypeFunc* complete_monitor_exit_Type();
264  static const TypeFunc* uncommon_trap_Type();
265  static const TypeFunc* athrow_Type();
266  static const TypeFunc* rethrow_Type();
267  static const TypeFunc* Math_D_D_Type();  // sin,cos & friends
268  static const TypeFunc* Math_DD_D_Type(); // mod,pow & friends
269  static const TypeFunc* modf_Type();
270  static const TypeFunc* l2f_Type();
271  static const TypeFunc* void_long_Type();
272
273  static const TypeFunc* flush_windows_Type();
274
275  // arraycopy routine types
276  static const TypeFunc* fast_arraycopy_Type(); // bit-blasters
277  static const TypeFunc* checkcast_arraycopy_Type();
278  static const TypeFunc* generic_arraycopy_Type();
279  static const TypeFunc* slow_arraycopy_Type();   // the full routine
280
281  static const TypeFunc* array_fill_Type();
282
283  // leaf on stack replacement interpreter accessor types
284  static const TypeFunc* osr_end_Type();
285
286  // leaf methodData routine types
287  static const TypeFunc* profile_receiver_type_Type();
288
289  // leaf on stack replacement interpreter accessor types
290  static const TypeFunc* fetch_int_Type();
291  static const TypeFunc* fetch_long_Type();
292  static const TypeFunc* fetch_float_Type();
293  static const TypeFunc* fetch_double_Type();
294  static const TypeFunc* fetch_oop_Type();
295  static const TypeFunc* fetch_monitor_Type();
296
297  static const TypeFunc* register_finalizer_Type();
298
299  // Dtrace support
300  static const TypeFunc* dtrace_method_entry_exit_Type();
301  static const TypeFunc* dtrace_object_alloc_Type();
302
303# ifdef ENABLE_ZAP_DEAD_LOCALS
304  static const TypeFunc* zap_dead_locals_Type();
305# endif
306
307 private:
308 static NamedCounter * volatile _named_counters;
309
310 public:
311 // helper function which creates a named counter labeled with the
312 // if they are available
313 static NamedCounter* new_named_counter(JVMState* jvms, NamedCounter::CounterTag tag);
314
315 // dumps all the named counters
316 static void          print_named_counters();
317
318};
319
320#endif // SHARE_VM_OPTO_RUNTIME_HPP
321