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