1 /*
2 * Copyright (c) 1997, 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_INTERPRETER_INTERPRETERRUNTIME_HPP
26 #define SHARE_INTERPRETER_INTERPRETERRUNTIME_HPP
27
28 #include "interpreter/bytecode.hpp"
29 #include "interpreter/linkResolver.hpp"
30 #include "oops/method.hpp"
31 #include "runtime/frame.hpp"
32 #include "runtime/javaThread.hpp"
33 #include "runtime/signature.hpp"
34 #include "utilities/macros.hpp"
35
36 class BufferBlob;
37 class CodeBuffer;
38
39 // The InterpreterRuntime is called by the interpreter for everything
40 // that cannot/should not be dealt with in assembly and needs C support.
41
42 class InterpreterRuntime: AllStatic {
43 private:
44
45 static void set_bcp_and_mdp(address bcp, JavaThread* current);
46 static void note_trap_inner(JavaThread* current, int reason,
47 const methodHandle& trap_method, int trap_bci);
48 static void note_trap(JavaThread* current, int reason);
49
50 // Inner work method for Interpreter's frequency counter overflow.
51 static nmethod* frequency_counter_overflow_inner(JavaThread* current, address branch_bcp);
52
53 public:
54 // Constants
55 static void ldc (JavaThread* current, bool wide);
56 static void resolve_ldc (JavaThread* current, Bytecodes::Code bytecode);
57
58 // Allocation
59 static void _new (JavaThread* current, ConstantPool* pool, int index);
60 static void newarray (JavaThread* current, BasicType type, jint size);
61 static void anewarray (JavaThread* threcurrentad, ConstantPool* pool, int index, jint size);
62 static void multianewarray(JavaThread* current, jint* first_size_address);
63 static void register_finalizer(JavaThread* current, oopDesc* obj);
64 static void write_heap_copy (JavaThread* current, oopDesc* value, int offset, oopDesc* rcv);
65 static void read_flat_field(JavaThread* current, oopDesc* object, ResolvedFieldEntry* entry);
66 static void read_nullable_flat_field(JavaThread* current, oopDesc* object, ResolvedFieldEntry* entry);
67 static void write_nullable_flat_field(JavaThread* current, oopDesc* object, oopDesc* value, ResolvedFieldEntry* entry);
68
69 static void flat_array_load(JavaThread* current, arrayOopDesc* array, int index);
70 static void flat_array_store(JavaThread* current, oopDesc* val, arrayOopDesc* array, int index);
71
72 static jboolean is_substitutable(JavaThread* current, oopDesc* aobj, oopDesc* bobj);
73
74 // Quicken instance-of and check-cast bytecodes
75 static void quicken_io_cc(JavaThread* current);
76
77 // Exceptions thrown by the interpreter
78 static void throw_AbstractMethodError(JavaThread* current);
79 static void throw_AbstractMethodErrorWithMethod(JavaThread* current, Method* oop);
80 static void throw_AbstractMethodErrorVerbose(JavaThread* current,
81 Klass* recvKlass,
82 Method* missingMethod);
83
84 static void throw_InstantiationError(JavaThread* current);
85 static void throw_IncompatibleClassChangeError(JavaThread* current);
86 static void throw_IncompatibleClassChangeErrorVerbose(JavaThread* current,
87 Klass* resc,
88 Klass* interfaceKlass);
89 static void throw_StackOverflowError(JavaThread* current);
90 static void throw_delayed_StackOverflowError(JavaThread* current);
91 static void throw_ArrayIndexOutOfBoundsException(JavaThread* current, arrayOopDesc* a, jint index);
92 static void throw_ClassCastException(JavaThread* current, oopDesc* obj);
93 static void throw_NullPointerException(JavaThread* current);
94 static void throw_NPE_UninitializedField_entry(JavaThread* current);
95
96 static void create_exception(JavaThread* current, char* name, char* message);
97 static void create_klass_exception(JavaThread* current, char* name, oopDesc* obj);
98 static address exception_handler_for_exception(JavaThread* current, oopDesc* exception);
99 #if INCLUDE_JVMTI
100 static void member_name_arg_or_null(JavaThread* current, address dmh, Method* m, address bcp);
101 #endif
102 static void throw_pending_exception(JavaThread* current);
103
104 static void resolve_from_cache(JavaThread* current, Bytecodes::Code bytecode);
105
106 // Used by AOTConstantPoolResolver
107 static void resolve_get_put(Bytecodes::Code bytecode, int field_index,
108 methodHandle& m, constantPoolHandle& pool, bool initialize_holder, TRAPS);
109 static void cds_resolve_invoke(Bytecodes::Code bytecode, int method_index,
110 constantPoolHandle& pool, TRAPS);
111 static void cds_resolve_invokehandle(int raw_index,
112 constantPoolHandle& pool, TRAPS);
113 static void cds_resolve_invokedynamic(int raw_index,
114 constantPoolHandle& pool, TRAPS);
115 private:
116 // Statics & fields
117 static void resolve_get_put(JavaThread* current, Bytecodes::Code bytecode);
118
119 // Calls
120 static void resolve_invoke(JavaThread* current, Bytecodes::Code bytecode);
121 static void resolve_invokehandle (JavaThread* current);
122 static void resolve_invokedynamic(JavaThread* current);
123
124 static void update_invoke_cp_cache_entry(CallInfo& info, Bytecodes::Code bytecode,
125 methodHandle& resolved_method,
126 constantPoolHandle& pool, int method_index);
127 public:
128 // Synchronization
129 static void monitorenter(JavaThread* current, BasicObjectLock* elem);
130 static void monitorenter_obj(JavaThread* current, oopDesc* obj);
131 static void monitorexit (BasicObjectLock* elem);
132
133 static void throw_illegal_monitor_state_exception(JavaThread* current);
134 static void new_illegal_monitor_state_exception(JavaThread* current);
135 static void throw_identity_exception(JavaThread* current, oopDesc* obj);
136
137 // Breakpoints
138 static void _breakpoint(JavaThread* current, Method* method, address bcp);
139 static Bytecodes::Code get_original_bytecode_at(JavaThread* current, Method* method, address bcp);
140 static void set_original_bytecode_at(JavaThread* current, Method* method, address bcp, Bytecodes::Code new_code);
141
142 // Safepoints
143 static void at_safepoint(JavaThread* current);
144 static void at_unwind(JavaThread* current);
145
146 // Debugger support
147 static void post_field_access(JavaThread* current, oopDesc* obj,
148 ResolvedFieldEntry* entry);
149 static void post_field_modification(JavaThread* current, oopDesc* obj,
150 ResolvedFieldEntry* entry, jvalue *value);
151 static void post_method_entry(JavaThread* current);
152 static void post_method_exit (JavaThread* current);
153 static int interpreter_contains(address pc);
154
155 // Native signature handlers
156 static void prepare_native_call(JavaThread* current, Method* method);
157 static address slow_signature_handler(JavaThread* current,
158 Method* method,
159 intptr_t* from, intptr_t* to);
160
161 #if defined(IA32) || defined(AMD64) || defined(ARM)
162 // Popframe support (only needed on x86, AMD64 and ARM)
163 static void popframe_move_outgoing_args(JavaThread* current, void* src_address, void* dest_address);
164 #endif
165
166 // bytecode tracing is only used by the TraceBytecodes
167 static intptr_t trace_bytecode(JavaThread* current, intptr_t preserve_this_value, intptr_t tos, intptr_t tos2) PRODUCT_RETURN0;
168
169 // Platform dependent stuff
170 #include CPU_HEADER(interpreterRT)
171
172 // optional normalization of fingerprints to reduce the number of adapters
173 static uint64_t normalize_fast_native_fingerprint(uint64_t fingerprint);
174
175 // Interpreter's frequency counter overflow
176 static nmethod* frequency_counter_overflow(JavaThread* current, address branch_bcp);
177
178 // Interpreter profiling support
179 static jint bcp_to_di(Method* method, address cur_bcp);
180 static void update_mdp_for_ret(JavaThread* current, int bci);
181 #ifdef ASSERT
182 static void verify_mdp(Method* method, address bcp, address mdp);
183 #endif // ASSERT
184 static MethodCounters* build_method_counters(JavaThread* current, Method* m);
185 };
186
187
188 class SignatureHandlerLibrary: public AllStatic {
189 public:
190 enum { buffer_size = 1*K }; // the size of the temporary code buffer
191 enum { blob_size = 32*K }; // the size of a handler code blob.
192
193 private:
194 static BufferBlob* _handler_blob; // the current buffer blob containing the generated handlers
195 static address _handler; // next available address within _handler_blob;
196 static GrowableArray<uint64_t>* _fingerprints; // the fingerprint collection
197 static GrowableArray<address>* _handlers; // the corresponding handlers
198 static address _buffer; // the temporary code buffer
199
200 static address set_handler_blob();
201 static void initialize();
202 static address set_handler(CodeBuffer* buffer);
203 static void pd_set_handler(address handler);
204
205 public:
206 static void add(const methodHandle& method);
207 };
208
209 #endif // SHARE_INTERPRETER_INTERPRETERRUNTIME_HPP