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 CPU_X86_INTERP_MASM_X86_HPP
26 #define CPU_X86_INTERP_MASM_X86_HPP
27
28 #include "asm/macroAssembler.hpp"
29 #include "oops/method.hpp"
30 #include "runtime/frame.hpp"
31
32 // This file specializes the assembler with interpreter-specific macros
33
34 typedef ByteSize (*OffsetFunction)(uint);
35
36 class InterpreterMacroAssembler: public MacroAssembler {
37 public:
38 // Interpreter specific version of call_VM_base
39 virtual void call_VM_leaf_base(address entry_point,
40 int number_of_arguments);
41
42 protected:
43
44 virtual void call_VM_base(Register oop_result,
45 Register last_java_sp,
46 address entry_point,
47 int number_of_arguments,
48 bool check_exceptions);
49
50 // base routine for all dispatches
51 void dispatch_base(TosState state, address* table, bool verifyoop = true, bool generate_poll = false);
52
53 public:
54 InterpreterMacroAssembler(CodeBuffer* code) : MacroAssembler(code),
55 _locals_register(r14),
56 _bcp_register(r13) {}
57
58 void jump_to_entry(address entry);
59
60 virtual void check_and_handle_popframe();
61 virtual void check_and_handle_earlyret();
62
63 void load_earlyret_value(TosState state);
64
65 // Use for vthread preemption
66 void call_VM_preemptable(Register oop_result,
67 address entry_point,
68 Register arg_1,
69 bool check_exceptions = true);
70 void call_VM_preemptable(Register oop_result,
71 address entry_point,
72 Register arg_1,
73 Register arg_2,
74 bool check_exceptions = true);
75 void restore_after_resume(bool is_native);
76 private:
77 void call_VM_preemptable_helper(Register oop_result,
78 address entry_point,
79 int number_of_arguments,
80 bool check_exceptions);
81
82 public:
83 // Interpreter-specific registers
84 void save_bcp() {
85 movptr(Address(rbp, frame::interpreter_frame_bcp_offset * wordSize), _bcp_register);
86 }
87
88 void restore_bcp() {
89 movptr(_bcp_register, Address(rbp, frame::interpreter_frame_bcp_offset * wordSize));
90 }
91
92 void restore_locals() {
93 movptr(_locals_register, Address(rbp, frame::interpreter_frame_locals_offset * wordSize));
94 lea(_locals_register, Address(rbp, _locals_register, Address::times_ptr));
95 }
96
97 // Helpers for runtime call arguments/results
98 void get_method(Register reg) {
99 movptr(reg, Address(rbp, frame::interpreter_frame_method_offset * wordSize));
100 }
101
102 void get_const(Register reg) {
103 get_method(reg);
104 movptr(reg, Address(reg, Method::const_offset()));
105 }
106
107 void get_constant_pool(Register reg) {
108 get_const(reg);
109 movptr(reg, Address(reg, ConstMethod::constants_offset()));
110 }
111
112 void get_constant_pool_cache(Register reg) {
113 get_constant_pool(reg);
114 movptr(reg, Address(reg, ConstantPool::cache_offset()));
115 }
116
117 void get_cpool_and_tags(Register cpool, Register tags) {
118 get_constant_pool(cpool);
119 movptr(tags, Address(cpool, ConstantPool::tags_offset()));
120 }
121
122 void get_unsigned_2_byte_index_at_bcp(Register reg, int bcp_offset);
123
124 void get_cache_index_at_bcp(Register index,
125 int bcp_offset,
126 size_t index_size = sizeof(u2));
127
128 // load cpool->resolved_references(index);
129 void load_resolved_reference_at_index(Register result, Register index, Register tmp = rscratch2);
130
131 // load cpool->resolved_klass_at(index)
132 void load_resolved_klass_at_index(Register klass, // contains the Klass on return
133 Register cpool, // the constant pool (corrupted on return)
134 Register index); // the constant pool index (corrupted on return)
135
136 // Expression stack
137 void pop_ptr(Register r = rax);
138 void pop_i(Register r = rax);
139
140 // On x86, pushing a ptr or an int is semantically identical, but we
141 // maintain a distinction for clarity and for making it easier to change
142 // semantics in the future
143 void push_ptr(Register r = rax);
144 void push_i(Register r = rax);
145
146 // push_i_or_ptr is provided for when explicitly allowing either a ptr or
147 // an int might have some advantage, while still documenting the fact that a
148 // ptr might be pushed to the stack.
149 void push_i_or_ptr(Register r = rax);
150
151 void push_f(XMMRegister r);
152 void pop_f(XMMRegister r);
153 void pop_d(XMMRegister r);
154 void push_d(XMMRegister r);
155 void pop_l(Register r = rax);
156 void push_l(Register r = rax);
157
158 void pop(Register r) { ((MacroAssembler*)this)->pop(r); }
159 void push(Register r) { ((MacroAssembler*)this)->push(r); }
160 void push(int32_t imm ) { ((MacroAssembler*)this)->push(imm); }
161
162 void pop(TosState state); // transition vtos -> state
163 void push(TosState state); // transition state -> vtos
164
165 void empty_expression_stack() {
166 movptr(rcx, Address(rbp, frame::interpreter_frame_monitor_block_top_offset * wordSize));
167 lea(rsp, Address(rbp, rcx, Address::times_ptr));
168 // null last_sp until next java call
169 movptr(Address(rbp, frame::interpreter_frame_last_sp_offset * wordSize), NULL_WORD);
170 }
171
172 // Helpers for swap and dup
173 void load_ptr(int n, Register val);
174 void store_ptr(int n, Register val);
175
176 // Generate a subtype check: branch to ok_is_subtype if sub_klass is
177 // a subtype of super_klass.
178 void gen_subtype_check( Register sub_klass, Label &ok_is_subtype );
179
180 // Dispatching
181 void dispatch_prolog(TosState state, int step = 0);
182 void dispatch_epilog(TosState state, int step = 0);
183 // dispatch via rbx (assume rbx is loaded already)
184 void dispatch_only(TosState state, bool generate_poll = false);
185 // dispatch normal table via rbx (assume rbx is loaded already)
186 void dispatch_only_normal(TosState state);
187 void dispatch_only_noverify(TosState state);
188 // load rbx from [_bcp_register + step] and dispatch via rbx
189 void dispatch_next(TosState state, int step = 0, bool generate_poll = false);
190 // load rbx from [_bcp_register] and dispatch via rbx and table
191 void dispatch_via (TosState state, address* table);
192
193 // jump to an invoked target
194 void prepare_to_jump_from_interpreted();
195 void jump_from_interpreted(Register method, Register temp);
196
197 // narrow int return value
198 void narrow(Register result);
199
200 // Returning from interpreted functions
201 //
202 // Removes the current activation (incl. unlocking of monitors)
203 // and sets up the return address. This code is also used for
204 // exception unwindwing. In that case, we do not want to throw
205 // IllegalMonitorStateExceptions, since that might get us into an
206 // infinite rethrow exception loop.
207 // Additionally this code is used for popFrame and earlyReturn.
208 // In popFrame case we want to skip throwing an exception,
209 // installing an exception, and notifying jvmdi.
210 // In earlyReturn case we only want to skip throwing an exception
211 // and installing an exception.
212 void remove_activation(TosState state, Register ret_addr,
213 bool throw_monitor_exception = true,
214 bool install_monitor_exception = true,
215 bool notify_jvmdi = true);
216 void get_method_counters(Register method, Register mcs, Label& skip);
217
218 // Object locking
219 void lock_object (Register lock_reg);
220 void unlock_object(Register lock_reg);
221
222 // Interpreter profiling operations
223 void set_method_data_pointer_for_bcp();
224 void test_method_data_pointer(Register mdp, Label& zero_continue);
225 void verify_method_data_pointer();
226
227 void set_mdp_data_at(Register mdp_in, int constant, Register value);
228 void increment_mdp_data_at(Register mdp_in, int constant);
229 void increment_mdp_data_at(Register mdp_in, Register index, int constant);
230 void increment_mask_and_jump(Address counter_addr, Address mask,
231 Register scratch, Label* where);
232 void set_mdp_flag_at(Register mdp_in, int flag_constant);
233 void test_mdp_data_at(Register mdp_in, int offset, Register value,
234 Register test_value_out,
235 Label& not_equal_continue);
236
237 void record_klass_in_profile(Register receiver, Register mdp,
238 Register reg2, bool is_virtual_call);
239 void record_klass_in_profile_helper(Register receiver, Register mdp,
240 Register reg2, int start_row,
241 Label& done, bool is_virtual_call);
242 void record_item_in_profile_helper(Register item, Register mdp, Register reg2, int start_row,
243 Label& done, int total_rows,
244 OffsetFunction item_offset_fn,
245 OffsetFunction item_count_offset_fn);
246
247 void update_mdp_by_offset(Register mdp_in, int offset_of_offset);
248 void update_mdp_by_offset(Register mdp_in, Register reg, int offset_of_disp);
249 void update_mdp_by_constant(Register mdp_in, int constant);
250 void update_mdp_for_ret(Register return_bci);
251
252 void profile_taken_branch(Register mdp);
253 void profile_not_taken_branch(Register mdp);
254 void profile_call(Register mdp);
255 void profile_final_call(Register mdp);
256 void profile_virtual_call(Register receiver, Register mdp,
257 Register scratch2,
258 bool receiver_can_be_null = false);
259 void profile_ret(Register return_bci, Register mdp);
260 void profile_null_seen(Register mdp);
261 void profile_typecheck(Register mdp, Register klass, Register scratch);
262
263 void profile_switch_default(Register mdp);
264 void profile_switch_case(Register index_in_scratch, Register mdp,
265 Register scratch2);
266
267 // Debugging
268 // only if +VerifyOops && state == atos
269 #define interp_verify_oop(reg, state) _interp_verify_oop(reg, state, __FILE__, __LINE__);
270 void _interp_verify_oop(Register reg, TosState state, const char* file, int line);
271
272 typedef enum { NotifyJVMTI, SkipNotifyJVMTI } NotifyMethodExitMode;
273
274 // support for jvmti/dtrace
275 void notify_method_entry();
276 void notify_method_exit(TosState state, NotifyMethodExitMode mode);
277
278 JFR_ONLY(void enter_jfr_critical_section();)
279 JFR_ONLY(void leave_jfr_critical_section();)
280
281 private:
282
283 Register _locals_register; // register that contains the pointer to the locals
284 Register _bcp_register; // register that contains the bcp
285
286 public:
287 void profile_obj_type(Register obj, const Address& mdo_addr);
288 void profile_arguments_type(Register mdp, Register callee, Register tmp, bool is_virtual);
289 void profile_return_type(Register mdp, Register ret, Register tmp);
290 void profile_parameters_type(Register mdp, Register tmp1, Register tmp2);
291
292 void load_resolved_indy_entry(Register cache, Register index);
293 void load_field_entry(Register cache, Register index, int bcp_offset = 1);
294 void load_method_entry(Register cache, Register index, int bcp_offset = 1);
295 };
296
297 #endif // CPU_X86_INTERP_MASM_X86_HPP