1 /*
2 * Copyright (c) 2003, 2025, Oracle and/or its affiliates. All rights reserved.
3 * Copyright (c) 2014, 2015, Red Hat Inc. All rights reserved.
4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 *
6 * This code is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License version 2 only, as
8 * published by the Free Software Foundation.
9 *
10 * This code is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * version 2 for more details (a copy is included in the LICENSE file that
14 * accompanied this code).
15 *
16 * You should have received a copy of the GNU General Public License version
17 * 2 along with this work; if not, write to the Free Software Foundation,
18 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
19 *
20 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
21 * or visit www.oracle.com if you need additional information or have any
22 * questions.
23 *
24 */
25
26 #ifndef CPU_AARCH64_INTERP_MASM_AARCH64_HPP
27 #define CPU_AARCH64_INTERP_MASM_AARCH64_HPP
28
29 #include "asm/macroAssembler.hpp"
30 #include "interpreter/invocationCounter.hpp"
31 #include "runtime/frame.hpp"
32
33 // This file specializes the assembler with interpreter-specific macros
34
35 typedef ByteSize (*OffsetFunction)(uint);
36
37 class InterpreterMacroAssembler: public MacroAssembler {
38 protected:
39 // Interpreter specific version of call_VM_base
40 using MacroAssembler::call_VM_leaf_base;
41
42 virtual void call_VM_leaf_base(address entry_point,
43 int number_of_arguments);
44
45 virtual void call_VM_base(Register oop_result,
46 Register java_thread,
47 Register last_java_sp,
48 address entry_point,
49 int number_of_arguments,
50 bool check_exceptions);
51
52 // base routine for all dispatches
53 void dispatch_base(TosState state, address* table,
54 bool verifyoop = true, bool generate_poll = false);
55
56 public:
57 InterpreterMacroAssembler(CodeBuffer* code) : MacroAssembler(code) {}
58
59 void load_earlyret_value(TosState state);
60
61 void call_VM_preemptable(Register oop_result,
62 address entry_point,
63 Register arg_1);
64 void restore_after_resume(bool is_native);
65
66 void jump_to_entry(address entry);
67
68 virtual void check_and_handle_popframe(Register java_thread);
69 virtual void check_and_handle_earlyret(Register java_thread);
70
71 // Interpreter-specific registers
72 void save_bcp() {
73 str(rbcp, Address(rfp, frame::interpreter_frame_bcp_offset * wordSize));
74 }
75
76 void restore_bcp() {
77 ldr(rbcp, Address(rfp, frame::interpreter_frame_bcp_offset * wordSize));
78 }
79
80 void restore_locals() {
81 ldr(rlocals, Address(rfp, frame::interpreter_frame_locals_offset * wordSize));
82 lea(rlocals, Address(rfp, rlocals, Address::lsl(3)));
83 }
84
85 void restore_constant_pool_cache() {
86 ldr(rcpool, Address(rfp, frame::interpreter_frame_cache_offset * wordSize));
87 }
88
89 void restore_sp_after_call() {
90 Label L;
91 ldr(rscratch1, Address(rfp, frame::interpreter_frame_extended_sp_offset * wordSize));
92 lea(rscratch1, Address(rfp, rscratch1, Address::lsl(LogBytesPerWord)));
93 #ifdef ASSERT
94 cbnz(rscratch1, L);
95 stop("SP is null");
96 #endif
97 bind(L);
98 mov(sp, rscratch1);
99 }
100
101 void check_extended_sp(const char* msg = "check extended SP") {
102 #ifdef ASSERT
103 Label L;
104 ldr(rscratch1, Address(rfp, frame::interpreter_frame_extended_sp_offset * wordSize));
105 lea(rscratch1, Address(rfp, rscratch1, Address::lsl(LogBytesPerWord)));
106 cmp(sp, rscratch1);
107 br(EQ, L);
108 stop(msg);
109 bind(L);
110 #endif
111 }
112
113 #define check_extended_sp() \
114 check_extended_sp("SP does not match extended SP in frame at " __FILE__ ":" XSTR(__LINE__))
115
116 void get_dispatch();
117
118 // Helpers for runtime call arguments/results
119 void get_method(Register reg) {
120 ldr(reg, Address(rfp, frame::interpreter_frame_method_offset * wordSize));
121 }
122
123 void get_const(Register reg) {
124 get_method(reg);
125 ldr(reg, Address(reg, in_bytes(Method::const_offset())));
126 }
127
128 void get_constant_pool(Register reg) {
129 get_const(reg);
130 ldr(reg, Address(reg, in_bytes(ConstMethod::constants_offset())));
131 }
132
133 void get_constant_pool_cache(Register reg) {
134 get_constant_pool(reg);
135 ldr(reg, Address(reg, ConstantPool::cache_offset()));
136 }
137
138 void get_cpool_and_tags(Register cpool, Register tags) {
139 get_constant_pool(cpool);
140 ldr(tags, Address(cpool, ConstantPool::tags_offset()));
141 }
142
143 void get_unsigned_2_byte_index_at_bcp(Register reg, int bcp_offset);
144 void get_cache_index_at_bcp(Register index, int bcp_offset, size_t index_size = sizeof(u2));
145 void get_method_counters(Register method, Register mcs, Label& skip);
146
147 // Kills t1 and t2, perserves klass, return allocation in new_obj
148 void allocate_instance(Register klass, Register new_obj,
149 Register t1, Register t2,
150 bool clear_fields, Label& alloc_failed);
151
152 // Allocate instance in "obj" and read in the content of the inline field
153 // NOTES:
154 // - input holder object via "obj", which must be r0,
155 // will return new instance via the same reg
156 // - assumes holder_klass and valueKlass field klass have both been resolved
157 void read_flat_field(Register entry,
158 Register field_index, Register field_offset,
159 Register temp, Register obj);
160
161 void write_flat_field(Register entry, Register field_offset,
162 Register tmp1, Register tmp2,
163 Register obj);
164
165 // Allocate value buffer in "obj" and read in flat element at the given index
166 // NOTES:
167 // - Return via "obj" must be r0
168 // - kills all given regs
169 void read_flat_element(Register array, Register index,
170 Register t1, Register t2,
171 Register obj = r0);
172
173 // load cpool->resolved_references(index);
174 void load_resolved_reference_at_index(Register result, Register index, Register tmp = r5);
175
176 // load cpool->resolved_klass_at(index);
177 void load_resolved_klass_at_offset(Register cpool, Register index, Register klass, Register temp);
178
179 void pop_ptr(Register r = r0);
180 void pop_i(Register r = r0);
181 void pop_l(Register r = r0);
182 void pop_f(FloatRegister r = v0);
183 void pop_d(FloatRegister r = v0);
184 void push_ptr(Register r = r0);
185 void push_i(Register r = r0);
186 void push_l(Register r = r0);
187 void push_f(FloatRegister r = v0);
188 void push_d(FloatRegister r = v0);
189
190 void pop(Register r ) { ((MacroAssembler*)this)->pop(r); }
191
192 void push(Register r ) { ((MacroAssembler*)this)->push(r); }
193
194 void pop(TosState state); // transition vtos -> state
195 void push(TosState state); // transition state -> vtos
196
197 void pop(RegSet regs, Register stack) { ((MacroAssembler*)this)->pop(regs, stack); }
198 void push(RegSet regs, Register stack) { ((MacroAssembler*)this)->push(regs, stack); }
199
200 void empty_expression_stack() {
201 ldr(rscratch1, Address(rfp, frame::interpreter_frame_monitor_block_top_offset * wordSize));
202 lea(esp, Address(rfp, rscratch1, Address::lsl(LogBytesPerWord)));
203 // null last_sp until next java call
204 str(zr, Address(rfp, frame::interpreter_frame_last_sp_offset * wordSize));
205 }
206
207 // Helpers for swap and dup
208 void load_ptr(int n, Register val);
209 void store_ptr(int n, Register val);
210
211 // Load float value from 'address'. The value is loaded onto the FPU register v0.
212 void load_float(Address src);
213 void load_double(Address src);
214
215 // Generate a subtype check: branch to ok_is_subtype if sub_klass is
216 // a subtype of super_klass.
217 void gen_subtype_check( Register sub_klass, Label &ok_is_subtype, bool profile = true);
218
219 // Dispatching
220 void dispatch_prolog(TosState state, int step = 0);
221 void dispatch_epilog(TosState state, int step = 0);
222 // dispatch via rscratch1
223 void dispatch_only(TosState state, bool generate_poll = false);
224 // dispatch normal table via rscratch1 (assume rscratch1 is loaded already)
225 void dispatch_only_normal(TosState state);
226 void dispatch_only_noverify(TosState state);
227 // load rscratch1 from [rbcp + step] and dispatch via rscratch1
228 void dispatch_next(TosState state, int step = 0, bool generate_poll = false);
229 // load rscratch1 from [esi] and dispatch via rscratch1 and table
230 void dispatch_via (TosState state, address* table);
231
232 // jump to an invoked target
233 void prepare_to_jump_from_interpreted();
234 void jump_from_interpreted(Register method, Register temp);
235
236
237 // Returning from interpreted functions
238 //
239 // Removes the current activation (incl. unlocking of monitors)
240 // and sets up the return address. This code is also used for
241 // exception unwindwing. In that case, we do not want to throw
242 // IllegalMonitorStateExceptions, since that might get us into an
243 // infinite rethrow exception loop.
244 // Additionally this code is used for popFrame and earlyReturn.
245 // In popFrame case we want to skip throwing an exception,
246 // installing an exception, and notifying jvmdi.
247 // In earlyReturn case we only want to skip throwing an exception
248 // and installing an exception.
249 void remove_activation(TosState state,
250 bool throw_monitor_exception = true,
251 bool install_monitor_exception = true,
252 bool notify_jvmdi = true);
253
254 // FIXME: Give us a valid frame at a null check.
255 virtual void null_check(Register reg, int offset = -1) {
256 // #ifdef ASSERT
257 // save_bcp();
258 // set_last_Java_frame(esp, rfp, (address) pc());
259 // #endif
260 MacroAssembler::null_check(reg, offset);
261 // #ifdef ASSERT
262 // reset_last_Java_frame(true);
263 // #endif
264 }
265
266 // Object locking
267 void lock_object (Register lock_reg);
268 void unlock_object(Register lock_reg);
269
270 // Interpreter profiling operations
271 void set_method_data_pointer_for_bcp();
272 void test_method_data_pointer(Register mdp, Label& zero_continue);
273 void verify_method_data_pointer();
274
275 void set_mdp_data_at(Register mdp_in, int constant, Register value);
276 void increment_mdp_data_at(Register mdp_in, int constant);
277 void increment_mdp_data_at(Register mdp_in, Register index, int constant);
278 void increment_mask_and_jump(Address counter_addr,
279 int increment, Address mask,
280 Register scratch, Register scratch2,
281 bool preloaded, Condition cond,
282 Label* where);
283 void set_mdp_flag_at(Register mdp_in, int flag_constant);
284 void test_mdp_data_at(Register mdp_in, int offset, Register value,
285 Register test_value_out,
286 Label& not_equal_continue);
287
288 void record_klass_in_profile(Register receiver, Register mdp,
289 Register reg2);
290 void record_klass_in_profile_helper(Register receiver, Register mdp,
291 Register reg2, int start_row,
292 Label& done);
293 void record_item_in_profile_helper(Register item, Register mdp,
294 Register reg2, int start_row, Label& done, int total_rows,
295 OffsetFunction item_offset_fn, OffsetFunction item_count_offset_fn);
296
297 void update_mdp_by_offset(Register mdp_in, int offset_of_offset);
298 void update_mdp_by_offset(Register mdp_in, Register reg, int offset_of_disp);
299 void update_mdp_by_constant(Register mdp_in, int constant);
300 void update_mdp_for_ret(Register return_bci);
301
302 // narrow int return value
303 void narrow(Register result);
304
305 void profile_taken_branch(Register mdp);
306 void profile_not_taken_branch(Register mdp, bool acmp = false);
307 void profile_call(Register mdp);
308 void profile_final_call(Register mdp);
309 void profile_virtual_call(Register receiver, Register mdp,
310 Register scratch2,
311 bool receiver_can_be_null = false);
312 void profile_ret(Register return_bci, Register mdp);
313 void profile_null_seen(Register mdp);
314 void profile_typecheck(Register mdp, Register klass, Register scratch);
315 void profile_typecheck_failed(Register mdp);
316 void profile_switch_default(Register mdp);
317 void profile_switch_case(Register index_in_scratch, Register mdp,
318 Register scratch2);
319 template <class ArrayData> void profile_array_type(Register mdp, Register array, Register tmp);
320 void profile_multiple_element_types(Register mdp, Register element, Register tmp, Register tmp2);
321 void profile_element_type(Register mdp, Register element, Register tmp);
322 void profile_acmp(Register mdp, Register left, Register right, Register tmp);
323
324 void profile_obj_type(Register obj, const Address& mdo_addr);
325 void profile_arguments_type(Register mdp, Register callee, Register tmp, bool is_virtual);
326 void profile_return_type(Register mdp, Register ret, Register tmp);
327 void profile_parameters_type(Register mdp, Register tmp1, Register tmp2);
328
329 // Debugging
330 // only if +VerifyOops && state == atos
331 #define interp_verify_oop(reg, state) _interp_verify_oop(reg, state, __FILE__, __LINE__);
332 void _interp_verify_oop(Register reg, TosState state, const char* file, int line);
333
334 typedef enum { NotifyJVMTI, SkipNotifyJVMTI } NotifyMethodExitMode;
335
336 // support for jvmti/dtrace
337 void notify_method_entry();
338 void notify_method_exit(TosState state, NotifyMethodExitMode mode);
339
340 JFR_ONLY(void enter_jfr_critical_section();)
341 JFR_ONLY(void leave_jfr_critical_section();)
342
343 virtual void _call_Unimplemented(address call_site) {
344 save_bcp();
345 set_last_Java_frame(esp, rfp, (address) pc(), rscratch1);
346 MacroAssembler::_call_Unimplemented(call_site);
347 }
348
349 void load_resolved_indy_entry(Register cache, Register index);
350 void load_field_entry(Register cache, Register index, int bcp_offset = 1);
351 void load_method_entry(Register cache, Register index, int bcp_offset = 1);
352 };
353
354 #endif // CPU_AARCH64_INTERP_MASM_AARCH64_HPP