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