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