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