1 /*
   2  * Copyright (c) 1999, 2019, 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_C1_C1_RUNTIME1_HPP
  26 #define SHARE_C1_C1_RUNTIME1_HPP
  27 
  28 #include "c1/c1_FrameMap.hpp"
  29 #include "code/stubs.hpp"
  30 #include "interpreter/interpreter.hpp"
  31 #include "memory/allocation.hpp"
  32 #include "runtime/deoptimization.hpp"
  33 
  34 class StubAssembler;
  35 
  36 // The Runtime1 holds all assembly stubs and VM
  37 // runtime routines needed by code code generated
  38 // by the Compiler1.
  39 
  40 #define RUNTIME1_STUBS(stub, last_entry) \
  41   stub(dtrace_object_alloc)          \
  42   stub(unwind_exception)             \
  43   stub(forward_exception)            \
  44   stub(throw_range_check_failed)       /* throws ArrayIndexOutOfBoundsException */ \
  45   stub(throw_index_exception)          /* throws IndexOutOfBoundsException */ \
  46   stub(throw_div0_exception)         \
  47   stub(throw_null_pointer_exception) \
  48   stub(register_finalizer)           \
  49   stub(new_instance)                 \
  50   stub(fast_new_instance)            \
  51   stub(fast_new_instance_init_check) \
  52   stub(new_type_array)               \
  53   stub(new_object_array)             \
  54   stub(new_value_array)              \
  55   stub(new_multi_array)              \
  56   stub(load_flattened_array)         \
  57   stub(store_flattened_array)        \
  58   stub(substitutability_check)       \
  59   stub(buffer_value_args)            \
  60   stub(buffer_value_args_no_receiver)\
  61   stub(handle_exception_nofpu)         /* optimized version that does not preserve fpu registers */ \
  62   stub(handle_exception)             \
  63   stub(handle_exception_from_callee) \
  64   stub(throw_array_store_exception)  \
  65   stub(throw_class_cast_exception)   \
  66   stub(throw_incompatible_class_change_error)   \
  67   stub(throw_illegal_monitor_state_exception)   \
  68   stub(slow_subtype_check)           \
  69   stub(monitorenter)                 \
  70   stub(monitorenter_nofpu)             /* optimized version that does not preserve fpu registers */ \
  71   stub(monitorexit)                  \
  72   stub(monitorexit_nofpu)              /* optimized version that does not preserve fpu registers */ \
  73   stub(deoptimize)                   \
  74   stub(access_field_patching)        \
  75   stub(load_klass_patching)          \
  76   stub(load_mirror_patching)         \
  77   stub(load_appendix_patching)       \
  78   stub(fpu2long_stub)                \
  79   stub(counter_overflow)             \
  80   stub(predicate_failed_trap)        \
  81   last_entry(number_of_ids)
  82 
  83 #define DECLARE_STUB_ID(x)       x ## _id ,
  84 #define DECLARE_LAST_STUB_ID(x)  x
  85 #define STUB_NAME(x)             #x " Runtime1 stub",
  86 #define LAST_STUB_NAME(x)        #x " Runtime1 stub"
  87 
  88 class StubAssemblerCodeGenClosure: public Closure {
  89  public:
  90   virtual OopMapSet* generate_code(StubAssembler* sasm) = 0;
  91 };
  92 
  93 class Runtime1: public AllStatic {
  94   friend class VMStructs;
  95   friend class ArrayCopyStub;
  96 
  97  public:
  98   enum StubID {
  99     RUNTIME1_STUBS(DECLARE_STUB_ID, DECLARE_LAST_STUB_ID)
 100   };
 101 
 102   // statistics
 103 #ifndef PRODUCT
 104   static int _resolve_invoke_cnt;
 105   static int _handle_wrong_method_cnt;
 106   static int _ic_miss_cnt;
 107   static int _generic_arraycopy_cnt;
 108   static int _generic_arraycopystub_cnt;
 109   static int _arraycopy_slowcase_cnt;
 110   static int _arraycopy_checkcast_cnt;
 111   static int _arraycopy_checkcast_attempt_cnt;
 112   static int _new_type_array_slowcase_cnt;
 113   static int _new_object_array_slowcase_cnt;
 114   static int _new_value_array_slowcase_cnt;
 115   static int _new_instance_slowcase_cnt;
 116   static int _new_multi_array_slowcase_cnt;
 117   static int _load_flattened_array_slowcase_cnt;
 118   static int _store_flattened_array_slowcase_cnt;
 119   static int _substitutability_check_slowcase_cnt;
 120   static int _buffer_value_args_slowcase_cnt;
 121   static int _buffer_value_args_no_receiver_slowcase_cnt;
 122   static int _monitorenter_slowcase_cnt;
 123   static int _monitorexit_slowcase_cnt;
 124   static int _patch_code_slowcase_cnt;
 125   static int _throw_range_check_exception_count;
 126   static int _throw_index_exception_count;
 127   static int _throw_div0_exception_count;
 128   static int _throw_null_pointer_exception_count;
 129   static int _throw_class_cast_exception_count;
 130   static int _throw_incompatible_class_change_error_count;
 131   static int _throw_illegal_monitor_state_exception_count;
 132   static int _throw_array_store_exception_count;
 133   static int _throw_count;
 134 #endif
 135 
 136  private:
 137   static CodeBlob* _blobs[number_of_ids];
 138   static const char* _blob_names[];
 139   static void buffer_value_args_impl(JavaThread* thread, Method* m, bool allocate_receiver);
 140 
 141   // stub generation
 142  public:
 143   static CodeBlob*  generate_blob(BufferBlob* buffer_blob, int stub_id, const char* name, bool expect_oop_map, StubAssemblerCodeGenClosure *cl);
 144   static void       generate_blob_for(BufferBlob* blob, StubID id);
 145   static OopMapSet* generate_code_for(StubID id, StubAssembler* sasm);
 146  private:
 147   static OopMapSet* generate_exception_throw(StubAssembler* sasm, address target, bool has_argument);
 148   static OopMapSet* generate_handle_exception(StubID id, StubAssembler* sasm);
 149   static void       generate_unwind_exception(StubAssembler *sasm);
 150   static OopMapSet* generate_patching(StubAssembler* sasm, address target);
 151 
 152   static OopMapSet* generate_stub_call(StubAssembler* sasm, Register result, address entry,
 153                                        Register arg1 = noreg, Register arg2 = noreg, Register arg3 = noreg);
 154 
 155   // runtime entry points
 156   static void new_instance    (JavaThread* thread, Klass* klass);
 157   static void new_type_array  (JavaThread* thread, Klass* klass, jint length);
 158   static void new_object_array(JavaThread* thread, Klass* klass, jint length);
 159   static void new_value_array (JavaThread* thread, Klass* klass, jint length);
 160   static void new_multi_array (JavaThread* thread, Klass* klass, int rank, jint* dims);
 161   static void load_flattened_array(JavaThread* thread, valueArrayOopDesc* array, int index);
 162   static void store_flattened_array(JavaThread* thread, valueArrayOopDesc* array, int index, oopDesc* value);
 163   static int  substitutability_check(JavaThread* thread, oopDesc* left, oopDesc* right);
 164   static void buffer_value_args(JavaThread* thread, Method* method);
 165   static void buffer_value_args_no_receiver(JavaThread* thread, Method* method);
 166 
 167   static address counter_overflow(JavaThread* thread, int bci, Method* method);
 168 
 169   static void unimplemented_entry   (JavaThread* thread, StubID id);
 170 
 171   static address exception_handler_for_pc(JavaThread* thread);
 172 
 173   static void throw_range_check_exception(JavaThread* thread, int index, arrayOopDesc* a);
 174   static void throw_index_exception(JavaThread* thread, int index);
 175   static void throw_div0_exception(JavaThread* thread);
 176   static void throw_null_pointer_exception(JavaThread* thread);
 177   static void throw_class_cast_exception(JavaThread* thread, oopDesc* object);
 178   static void throw_incompatible_class_change_error(JavaThread* thread);
 179   static void throw_illegal_monitor_state_exception(JavaThread* thread);
 180   static void throw_array_store_exception(JavaThread* thread, oopDesc* object);
 181 
 182   static void monitorenter(JavaThread* thread, oopDesc* obj, BasicObjectLock* lock);
 183   static void monitorexit (JavaThread* thread, BasicObjectLock* lock);
 184 
 185   static void deoptimize(JavaThread* thread, jint trap_request);
 186 
 187   static int access_field_patching(JavaThread* thread);
 188   static int move_klass_patching(JavaThread* thread);
 189   static int move_mirror_patching(JavaThread* thread);
 190   static int move_appendix_patching(JavaThread* thread);
 191 
 192   static void patch_code(JavaThread* thread, StubID stub_id);
 193 
 194  public:
 195   // initialization
 196   static void initialize(BufferBlob* blob);
 197   static void initialize_pd();
 198 
 199   // stubs
 200   static CodeBlob* blob_for (StubID id);
 201   static address   entry_for(StubID id)          { return blob_for(id)->code_begin(); }
 202   static const char* name_for (StubID id);
 203   static const char* name_for_address(address entry);
 204 
 205   // platform might add runtime names.
 206   static const char* pd_name_for_address(address entry);
 207 
 208   // method tracing
 209   static void trace_block_entry(jint block_id);
 210 
 211 #ifndef PRODUCT
 212   static address throw_count_address()               { return (address)&_throw_count;             }
 213   static address arraycopy_count_address(BasicType type);
 214 #endif
 215 
 216   // directly accessible leaf routine
 217   static int  is_instance_of(oopDesc* mirror, oopDesc* obj);
 218 
 219   static void predicate_failed_trap(JavaThread* thread);
 220 
 221   static void print_statistics()                 PRODUCT_RETURN;
 222 };
 223 
 224 #endif // SHARE_C1_C1_RUNTIME1_HPP