1 /*
2 * Copyright (c) 1999, 2023, 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/allStatic.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_null_free_array) \
55 stub(new_multi_array) \
56 stub(load_flat_array) \
57 stub(store_flat_array) \
58 stub(substitutability_check) \
59 stub(buffer_inline_args) \
60 stub(buffer_inline_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(throw_identity_exception) \
69 stub(slow_subtype_check) \
70 stub(monitorenter) \
71 stub(monitorenter_nofpu) /* optimized version that does not preserve fpu registers */ \
72 stub(monitorexit) \
73 stub(monitorexit_nofpu) /* optimized version that does not preserve fpu registers */ \
74 stub(deoptimize) \
75 stub(access_field_patching) \
76 stub(load_klass_patching) \
77 stub(load_mirror_patching) \
78 stub(load_appendix_patching) \
79 stub(fpu2long_stub) \
80 stub(counter_overflow) \
81 stub(predicate_failed_trap) \
82 last_entry(number_of_ids)
83
84 #define DECLARE_STUB_ID(x) x ## _id ,
85 #define DECLARE_LAST_STUB_ID(x) x
86 #define STUB_NAME(x) #x " Runtime1 stub",
87 #define LAST_STUB_NAME(x) #x " Runtime1 stub"
88
89 class StubAssemblerCodeGenClosure: public Closure {
90 public:
91 virtual OopMapSet* generate_code(StubAssembler* sasm) = 0;
92 };
93
94 class Runtime1: public AllStatic {
95 friend class VMStructs;
96 friend class ArrayCopyStub;
97
98 public:
99 enum StubID {
100 RUNTIME1_STUBS(DECLARE_STUB_ID, DECLARE_LAST_STUB_ID)
101 };
102
103 // statistics
104 #ifndef PRODUCT
105 static uint _generic_arraycopystub_cnt;
106 static uint _arraycopy_slowcase_cnt;
107 static uint _arraycopy_checkcast_cnt;
108 static uint _arraycopy_checkcast_attempt_cnt;
109 static uint _new_type_array_slowcase_cnt;
110 static uint _new_object_array_slowcase_cnt;
111 static uint _new_null_free_array_slowcase_cnt;
112 static uint _new_instance_slowcase_cnt;
113 static uint _new_multi_array_slowcase_cnt;
114 static uint _load_flat_array_slowcase_cnt;
115 static uint _store_flat_array_slowcase_cnt;
116 static uint _substitutability_check_slowcase_cnt;
117 static uint _buffer_inline_args_slowcase_cnt;
118 static uint _buffer_inline_args_no_receiver_slowcase_cnt;
119 static uint _monitorenter_slowcase_cnt;
120 static uint _monitorexit_slowcase_cnt;
121 static uint _patch_code_slowcase_cnt;
122 static uint _throw_range_check_exception_count;
123 static uint _throw_index_exception_count;
124 static uint _throw_div0_exception_count;
125 static uint _throw_null_pointer_exception_count;
126 static uint _throw_class_cast_exception_count;
127 static uint _throw_incompatible_class_change_error_count;
128 static uint _throw_illegal_monitor_state_exception_count;
129 static uint _throw_identity_exception_count;
130 static uint _throw_count;
131 #endif
132
133 private:
134 static CodeBlob* _blobs[number_of_ids];
135 static const char* _blob_names[];
136 static void buffer_inline_args_impl(JavaThread* current, Method* m, bool allocate_receiver);
137
138 // stub generation
139 public:
140 static CodeBlob* generate_blob(BufferBlob* buffer_blob, int stub_id, const char* name, bool expect_oop_map, StubAssemblerCodeGenClosure *cl);
141 static void generate_blob_for(BufferBlob* blob, StubID id);
142 static OopMapSet* generate_code_for(StubID id, StubAssembler* sasm);
143 private:
144 static OopMapSet* generate_exception_throw(StubAssembler* sasm, address target, bool has_argument);
145 static OopMapSet* generate_handle_exception(StubID id, StubAssembler* sasm);
146 static void generate_unwind_exception(StubAssembler *sasm);
147 static OopMapSet* generate_patching(StubAssembler* sasm, address target);
148
149 static OopMapSet* generate_stub_call(StubAssembler* sasm, Register result, address entry,
150 Register arg1 = noreg, Register arg2 = noreg, Register arg3 = noreg);
151
152 // runtime entry points
153 static void new_instance (JavaThread* current, Klass* klass);
154 static void new_instance_no_inline(JavaThread* current, Klass* klass);
155 static void new_type_array (JavaThread* current, Klass* klass, jint length);
156 static void new_object_array(JavaThread* current, Klass* klass, jint length);
157 static void new_null_free_array(JavaThread* current, Klass* klass, jint length);
158 static void new_multi_array (JavaThread* current, Klass* klass, int rank, jint* dims);
159 static void load_flat_array(JavaThread* current, flatArrayOopDesc* array, int index);
160 static void store_flat_array(JavaThread* current, flatArrayOopDesc* array, int index, oopDesc* value);
161 static int substitutability_check(JavaThread* current, oopDesc* left, oopDesc* right);
162 static void buffer_inline_args(JavaThread* current, Method* method);
163 static void buffer_inline_args_no_receiver(JavaThread* current, Method* method);
164
165 static address counter_overflow(JavaThread* current, int bci, Method* method);
166
167 static void unimplemented_entry(JavaThread* current, StubID id);
168
169 static address exception_handler_for_pc(JavaThread* current);
170
171 static void throw_range_check_exception(JavaThread* current, int index, arrayOopDesc* a);
172 static void throw_index_exception(JavaThread* current, int index);
173 static void throw_div0_exception(JavaThread* current);
174 static void throw_null_pointer_exception(JavaThread* current);
175 static void throw_class_cast_exception(JavaThread* current, oopDesc* object);
176 static void throw_incompatible_class_change_error(JavaThread* current);
177 static void throw_illegal_monitor_state_exception(JavaThread* current);
178 static void throw_identity_exception(JavaThread* current, oopDesc* object);
179 static void throw_array_store_exception(JavaThread* current, oopDesc* object);
180
181 static void monitorenter(JavaThread* current, oopDesc* obj, BasicObjectLock* lock);
182 static void monitorexit (JavaThread* current, BasicObjectLock* lock);
183
184 static void deoptimize(JavaThread* current, jint trap_request);
185
186 static int access_field_patching(JavaThread* current);
187 static int move_klass_patching(JavaThread* current);
188 static int move_mirror_patching(JavaThread* current);
189 static int move_appendix_patching(JavaThread* current);
190
191 static void patch_code(JavaThread* current, StubID stub_id);
192
193 public:
194 // initialization
195 static void initialize(BufferBlob* blob);
196 static void initialize_pd();
197
198 // stubs
199 static CodeBlob* blob_for (StubID id);
200 static address entry_for(StubID id) { return blob_for(id)->code_begin(); }
201 static const char* name_for (StubID id);
202 static const char* name_for_address(address entry);
203
204 // platform might add runtime names.
205 static const char* pd_name_for_address(address entry);
206
207 // method tracing
208 static void trace_block_entry(jint block_id);
209
210 #ifndef PRODUCT
211 static address throw_count_address() { return (address)&_throw_count; }
212 static address arraycopy_count_address(BasicType type);
213 #endif
214
215 // directly accessible leaf routine
216 static int is_instance_of(oopDesc* mirror, oopDesc* obj);
217
218 static void predicate_failed_trap(JavaThread* current);
219
220 static void check_abort_on_vm_exception(oopDesc* ex);
221
222 static void print_statistics() PRODUCT_RETURN;
223 };
224
225 #endif // SHARE_C1_C1_RUNTIME1_HPP