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