1 /*
  2  * Copyright (c) 1998, 2021, 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 == NULL ? NULL : os::strdup(n)),
 77     _count(0),
 78     _tag(tag),
 79     _next(NULL) {}
 80 
 81   ~NamedCounter() {
 82     if (_name != NULL) {
 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 == NULL || next == NULL, "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 
139   //
140   // Implementation of runtime methods
141   // =================================
142 
143   // Allocate storage for a Java instance.
144   static void new_instance_C(Klass* instance_klass, JavaThread* current);
145 
146   // Allocate storage for a objArray or typeArray
147   static void new_array_C(Klass* array_klass, int len, JavaThread* current);
148   static void new_array_nozero_C(Klass* array_klass, int len, JavaThread* current);
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(Klass* klass, int len1, int len2, JavaThread* current);
153   static void multianewarray3_C(Klass* klass, int len1, int len2, int len3, JavaThread* current);
154   static void multianewarray4_C(Klass* klass, int len1, int len2, int len3, int len4, JavaThread* current);
155   static void multianewarray5_C(Klass* klass, int len1, int len2, int len3, int len4, int len5, JavaThread* current);
156   static void multianewarrayN_C(Klass* klass, arrayOopDesc* dims, JavaThread* current);
157 
158 public:
159   static void monitor_notify_C(oopDesc* obj, JavaThread* current);
160   static void monitor_notifyAll_C(oopDesc* obj, JavaThread* current);
161 
162 private:
163 
164   // Implicit exception support
165   static void throw_null_exception_C(JavaThread* thread);
166 
167   // Exception handling
168   static address handle_exception_C       (JavaThread* current);
169   static address handle_exception_C_helper(JavaThread* current, nmethod*& nm);
170   static address rethrow_C                (oopDesc* exception, JavaThread *thread, address return_pc );
171   static void deoptimize_caller_frame     (JavaThread *thread);
172   static void deoptimize_caller_frame     (JavaThread *thread, bool doit);
173   static bool is_deoptimized_caller_frame (JavaThread *thread);
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* current);
182 
183  public:
184 
185   static bool is_callee_saved_register(MachRegisterNumbers reg);
186 
187   // One time only generate runtime code stubs. Returns true
188   // when runtime stubs have been generated successfully and
189   // false otherwise.
190   static bool generate(ciEnv* env);
191 
192   // Returns the name of a stub
193   static const char* stub_name(address entry);
194 
195   // access to runtime stubs entry points for java code
196   static address new_instance_Java()                     { return _new_instance_Java; }
197   static address new_array_Java()                        { return _new_array_Java; }
198   static address new_array_nozero_Java()                 { return _new_array_nozero_Java; }
199   static address multianewarray2_Java()                  { return _multianewarray2_Java; }
200   static address multianewarray3_Java()                  { return _multianewarray3_Java; }
201   static address multianewarray4_Java()                  { return _multianewarray4_Java; }
202   static address multianewarray5_Java()                  { return _multianewarray5_Java; }
203   static address multianewarrayN_Java()                  { return _multianewarrayN_Java; }
204   static address vtable_must_compile_stub()              { return _vtable_must_compile_Java; }
205   static address complete_monitor_locking_Java()         { return _complete_monitor_locking_Java; }
206   static address monitor_notify_Java()                   { return _monitor_notify_Java; }
207   static address monitor_notifyAll_Java()                { return _monitor_notifyAll_Java; }
208 
209   static address slow_arraycopy_Java()                   { return _slow_arraycopy_Java; }
210   static address register_finalizer_Java()               { return _register_finalizer_Java; }
211 
212   static ExceptionBlob*    exception_blob()                      { return _exception_blob; }
213 
214   // Implicit exception support
215   static void throw_div0_exception_C      (JavaThread* thread);
216   static void throw_stack_overflow_error_C(JavaThread* thread);
217 
218   // Exception handling
219   static address rethrow_stub()             { return _rethrow_Java; }
220 
221 
222   // Type functions
223   // ======================================================
224 
225   static const TypeFunc* new_instance_Type(); // object allocation (slow case)
226   static const TypeFunc* new_array_Type ();   // [a]newarray (slow case)
227   static const TypeFunc* multianewarray_Type(int ndim); // multianewarray
228   static const TypeFunc* multianewarray2_Type(); // multianewarray
229   static const TypeFunc* multianewarray3_Type(); // multianewarray
230   static const TypeFunc* multianewarray4_Type(); // multianewarray
231   static const TypeFunc* multianewarray5_Type(); // multianewarray
232   static const TypeFunc* multianewarrayN_Type(); // multianewarray
233   static const TypeFunc* complete_monitor_enter_Type();
234   static const TypeFunc* complete_monitor_exit_Type();
235   static const TypeFunc* monitor_notify_Type();
236   static const TypeFunc* uncommon_trap_Type();
237   static const TypeFunc* athrow_Type();
238   static const TypeFunc* rethrow_Type();
239   static const TypeFunc* Math_D_D_Type();  // sin,cos & friends
240   static const TypeFunc* Math_DD_D_Type(); // mod,pow & friends
241   static const TypeFunc* Math_Vector_Vector_Type(uint num_arg, const TypeVect* in_type, const TypeVect* out_type);
242   static const TypeFunc* modf_Type();
243   static const TypeFunc* l2f_Type();
244   static const TypeFunc* void_long_Type();
245 
246   static const TypeFunc* flush_windows_Type();
247 
248   // arraycopy routine types
249   static const TypeFunc* fast_arraycopy_Type(); // bit-blasters
250   static const TypeFunc* checkcast_arraycopy_Type();
251   static const TypeFunc* generic_arraycopy_Type();
252   static const TypeFunc* slow_arraycopy_Type();   // the full routine
253 
254   static const TypeFunc* array_fill_Type();
255 
256   static const TypeFunc* aescrypt_block_Type();
257   static const TypeFunc* cipherBlockChaining_aescrypt_Type();
258   static const TypeFunc* electronicCodeBook_aescrypt_Type();
259   static const TypeFunc* counterMode_aescrypt_Type();
260   static const TypeFunc* galoisCounterMode_aescrypt_Type();
261 
262   static const TypeFunc* digestBase_implCompress_Type(bool is_sha3);
263   static const TypeFunc* digestBase_implCompressMB_Type(bool is_sha3);
264 
265   static const TypeFunc* multiplyToLen_Type();
266   static const TypeFunc* montgomeryMultiply_Type();
267   static const TypeFunc* montgomerySquare_Type();
268 
269   static const TypeFunc* squareToLen_Type();
270 
271   static const TypeFunc* mulAdd_Type();
272 
273   static const TypeFunc* bigIntegerShift_Type();
274 
275   static const TypeFunc* vectorizedMismatch_Type();
276 
277   static const TypeFunc* ghash_processBlocks_Type();
278   static const TypeFunc* base64_encodeBlock_Type();
279   static const TypeFunc* base64_decodeBlock_Type();
280 
281   static const TypeFunc* updateBytesCRC32_Type();
282   static const TypeFunc* updateBytesCRC32C_Type();
283 
284   static const TypeFunc* updateBytesAdler32_Type();
285 
286   // leaf on stack replacement interpreter accessor types
287   static const TypeFunc* osr_end_Type();
288 
289   static const TypeFunc* register_finalizer_Type();
290 
291   JFR_ONLY(static const TypeFunc* get_class_id_intrinsic_Type();)
292 
293   // Dtrace support
294   static const TypeFunc* dtrace_method_entry_exit_Type();
295   static const TypeFunc* dtrace_object_alloc_Type();
296 
297  private:
298  static NamedCounter * volatile _named_counters;
299 
300  public:
301  // helper function which creates a named counter labeled with the
302  // if they are available
303  static NamedCounter* new_named_counter(JVMState* jvms, NamedCounter::CounterTag tag);
304 
305  // dumps all the named counters
306  static void          print_named_counters();
307 
308 };
309 
310 #endif // SHARE_OPTO_RUNTIME_HPP