1 /*
2 * Copyright (c) 1999, 2024, 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 #include "runtime/stubDeclarations.hpp"
34
35 class StubAssembler;
36
37 // The Runtime1 holds all assembly stubs and VM
38 // runtime routines needed by code code generated
39 // by the Compiler1.
40
41 class StubAssemblerCodeGenClosure: public Closure {
42 public:
43 virtual OopMapSet* generate_code(StubAssembler* sasm) = 0;
44 };
45
46 // define C1StubId enum tags: unwind_exception_id etc
47
48 #define C1_STUB_ID_ENUM_DECLARE(name) STUB_ID_NAME(name),
49 enum class C1StubId :int {
50 NO_STUBID = -1,
51 C1_STUBS_DO(C1_STUB_ID_ENUM_DECLARE)
52 NUM_STUBIDS
53 };
54 #undef C1_STUB_ID_ENUM_DECLARE
55
56 class Runtime1: public AllStatic {
57 friend class VMStructs;
58 friend class ArrayCopyStub;
59
60 public:
61 // statistics
62 #ifndef PRODUCT
63 static uint _generic_arraycopystub_cnt;
64 static uint _arraycopy_slowcase_cnt;
65 static uint _arraycopy_checkcast_cnt;
66 static uint _arraycopy_checkcast_attempt_cnt;
67 static uint _new_type_array_slowcase_cnt;
68 static uint _new_object_array_slowcase_cnt;
69 static uint _new_instance_slowcase_cnt;
70 static uint _new_multi_array_slowcase_cnt;
71 static uint _monitorenter_slowcase_cnt;
72 static uint _monitorexit_slowcase_cnt;
73 static uint _patch_code_slowcase_cnt;
74 static uint _throw_range_check_exception_count;
75 static uint _throw_index_exception_count;
76 static uint _throw_div0_exception_count;
77 static uint _throw_null_pointer_exception_count;
78 static uint _throw_class_cast_exception_count;
79 static uint _throw_incompatible_class_change_error_count;
80 static uint _throw_count;
81 #endif
82
83 private:
84 static CodeBlob* _blobs[(int)C1StubId::NUM_STUBIDS];
85 static const char* _blob_names[];
86
87 // stub generation
88 public:
89 static CodeBlob* generate_blob(BufferBlob* buffer_blob, C1StubId id, const char* name, bool expect_oop_map, StubAssemblerCodeGenClosure *cl);
90 static void generate_blob_for(BufferBlob* blob, C1StubId id);
91 static OopMapSet* generate_code_for(C1StubId id, StubAssembler* sasm);
92 private:
93 static OopMapSet* generate_exception_throw(StubAssembler* sasm, address target, bool has_argument);
94 static OopMapSet* generate_handle_exception(C1StubId id, StubAssembler* sasm);
95 static void generate_unwind_exception(StubAssembler *sasm);
96 static OopMapSet* generate_patching(StubAssembler* sasm, address target);
97
98 static OopMapSet* generate_stub_call(StubAssembler* sasm, Register result, address entry,
99 Register arg1 = noreg, Register arg2 = noreg, Register arg3 = noreg);
100
101 // runtime entry points
102 static void new_instance (JavaThread* current, Klass* klass);
103 static void new_type_array (JavaThread* current, Klass* klass, jint length);
104 static void new_object_array(JavaThread* current, Klass* klass, jint length);
105 static void new_multi_array (JavaThread* current, Klass* klass, int rank, jint* dims);
106
107 static address counter_overflow(JavaThread* current, int bci, Method* method);
108
109 static void unimplemented_entry(JavaThread* current, C1StubId id);
110
111 static address exception_handler_for_pc(JavaThread* current);
112
113 static void throw_range_check_exception(JavaThread* current, int index, arrayOopDesc* a);
114 static void throw_index_exception(JavaThread* current, int index);
115 static void throw_div0_exception(JavaThread* current);
116 static void throw_null_pointer_exception(JavaThread* current);
117 static void throw_class_cast_exception(JavaThread* current, oopDesc* object);
118 static void throw_incompatible_class_change_error(JavaThread* current);
119 static void throw_array_store_exception(JavaThread* current, oopDesc* object);
120
121 static void monitorenter(JavaThread* current, oopDesc* obj, BasicObjectLock* lock);
122 static void monitorexit (JavaThread* current, BasicObjectLock* lock);
123
124 static void deoptimize(JavaThread* current, jint trap_request);
125
126 static int access_field_patching(JavaThread* current);
127 static int move_klass_patching(JavaThread* current);
128 static int move_mirror_patching(JavaThread* current);
129 static int move_appendix_patching(JavaThread* current);
130
131 static void patch_code(JavaThread* current, C1StubId stub_id);
132
133 public:
134 // initialization
135 static void initialize(BufferBlob* blob);
136 static void initialize_pd();
137
138 // return offset in words
139 static uint runtime_blob_current_thread_offset(frame f);
140
141 // stubs
142 static CodeBlob* blob_for (C1StubId id);
143 static address entry_for(C1StubId id) { return blob_for(id)->code_begin(); }
144 static const char* name_for (C1StubId id);
145 static const char* name_for_address(address entry);
146
147 // platform might add runtime names.
148 static const char* pd_name_for_address(address entry);
149
150 // method tracing
151 static void trace_block_entry(jint block_id);
152
153 #ifndef PRODUCT
154 static address throw_count_address() { return (address)&_throw_count; }
155 static address arraycopy_count_address(BasicType type);
156 #endif
157
158 // directly accessible leaf routine
159 static int is_instance_of(oopDesc* mirror, oopDesc* obj);
160
161 static void predicate_failed_trap(JavaThread* current);
162
163 static void check_abort_on_vm_exception(oopDesc* ex);
164
165 static void print_statistics() PRODUCT_RETURN;
166 };
167
168 #endif // SHARE_C1_C1_RUNTIME1_HPP