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