1 /*
2 * Copyright (c) 2003, 2024, 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 // Use for vthread preemption
62 void call_VM_preemptable(Register oop_result,
63 address entry_point,
64 Register arg_1,
65 bool check_exceptions = true);
66 void call_VM_preemptable(Register oop_result,
67 address entry_point,
68 Register arg_1,
69 Register arg_2,
70 bool check_exceptions = true);
71
72 void call_VM_preemptable_helper(Register oop_result,
73 address entry_point,
74 int number_of_arguments,
75 bool check_exceptions);
76 void restore_after_resume(bool is_native);
77
78 void jump_to_entry(address entry);
79
80 virtual void check_and_handle_popframe(Register java_thread);
81 virtual void check_and_handle_earlyret(Register java_thread);
82
83 // Interpreter-specific registers
84 void save_bcp() {
85 str(rbcp, Address(rfp, frame::interpreter_frame_bcp_offset * wordSize));
86 }
87
88 void restore_bcp() {
89 ldr(rbcp, Address(rfp, frame::interpreter_frame_bcp_offset * wordSize));
90 }
91
92 void restore_locals() {
93 ldr(rlocals, Address(rfp, frame::interpreter_frame_locals_offset * wordSize));
94 lea(rlocals, Address(rfp, rlocals, Address::lsl(3)));
95 }
96
97 void restore_constant_pool_cache() {
98 ldr(rcpool, Address(rfp, frame::interpreter_frame_cache_offset * wordSize));
99 }
100
101 void restore_sp_after_call() {
102 Label L;
103 ldr(rscratch1, Address(rfp, frame::interpreter_frame_extended_sp_offset * wordSize));
104 lea(rscratch1, Address(rfp, rscratch1, Address::lsl(LogBytesPerWord)));
105 #ifdef ASSERT
106 cbnz(rscratch1, L);
107 stop("SP is null");
108 #endif
109 bind(L);
110 mov(sp, rscratch1);
111 }
112
113 void check_extended_sp(const char* msg = "check extended SP") {
114 #ifdef ASSERT
115 Label L;
116 ldr(rscratch1, Address(rfp, frame::interpreter_frame_extended_sp_offset * wordSize));
117 lea(rscratch1, Address(rfp, rscratch1, Address::lsl(LogBytesPerWord)));
118 cmp(sp, rscratch1);
119 br(EQ, L);
120 stop(msg);
121 bind(L);
122 #endif
123 }
124
125 #define check_extended_sp() \
126 check_extended_sp("SP does not match extended SP in frame at " __FILE__ ":" XSTR(__LINE__))
127
128 void get_dispatch();
129
130 // Helpers for runtime call arguments/results
131 void get_method(Register reg) {
132 ldr(reg, Address(rfp, frame::interpreter_frame_method_offset * wordSize));
133 }
134
135 void get_const(Register reg) {
136 get_method(reg);
137 ldr(reg, Address(reg, in_bytes(Method::const_offset())));
138 }
139
140 void get_constant_pool(Register reg) {
141 get_const(reg);
142 ldr(reg, Address(reg, in_bytes(ConstMethod::constants_offset())));
143 }
144
145 void get_constant_pool_cache(Register reg) {
146 get_constant_pool(reg);
147 ldr(reg, Address(reg, ConstantPool::cache_offset()));
148 }
149
150 void get_cpool_and_tags(Register cpool, Register tags) {
151 get_constant_pool(cpool);
152 ldr(tags, Address(cpool, ConstantPool::tags_offset()));
153 }
154
155 void get_unsigned_2_byte_index_at_bcp(Register reg, int bcp_offset);
156 void get_cache_index_at_bcp(Register index, int bcp_offset, size_t index_size = sizeof(u2));
157 void get_method_counters(Register method, Register mcs, Label& skip);
158
159 // load cpool->resolved_references(index);
160 void load_resolved_reference_at_index(Register result, Register index, Register tmp = r5);
161
162 // load cpool->resolved_klass_at(index);
163 void load_resolved_klass_at_offset(Register cpool, Register index, Register klass, Register temp);
164
165 void pop_ptr(Register r = r0);
166 void pop_i(Register r = r0);
167 void pop_l(Register r = r0);
168 void pop_f(FloatRegister r = v0);
169 void pop_d(FloatRegister r = v0);
170 void push_ptr(Register r = r0);
171 void push_i(Register r = r0);
172 void push_l(Register r = r0);
173 void push_f(FloatRegister r = v0);
174 void push_d(FloatRegister r = v0);
175
176 void pop(Register r ) { ((MacroAssembler*)this)->pop(r); }
177
178 void push(Register r ) { ((MacroAssembler*)this)->push(r); }
179
180 void pop(TosState state); // transition vtos -> state
181 void push(TosState state); // transition state -> vtos
182
183 void pop(RegSet regs, Register stack) { ((MacroAssembler*)this)->pop(regs, stack); }
184 void push(RegSet regs, Register stack) { ((MacroAssembler*)this)->push(regs, stack); }
185
186 void empty_expression_stack() {
187 ldr(rscratch1, Address(rfp, frame::interpreter_frame_monitor_block_top_offset * wordSize));
188 lea(esp, Address(rfp, rscratch1, Address::lsl(LogBytesPerWord)));
189 // null last_sp until next java call
190 str(zr, Address(rfp, frame::interpreter_frame_last_sp_offset * wordSize));
191 }
192
193 // Helpers for swap and dup
194 void load_ptr(int n, Register val);
195 void store_ptr(int n, Register val);
196
197 // Load float value from 'address'. The value is loaded onto the FPU register v0.
198 void load_float(Address src);
199 void load_double(Address src);
200
201 // Generate a subtype check: branch to ok_is_subtype if sub_klass is
202 // a subtype of super_klass.
203 void gen_subtype_check( Register sub_klass, Label &ok_is_subtype );
204
205 // Dispatching
206 void dispatch_prolog(TosState state, int step = 0);
207 void dispatch_epilog(TosState state, int step = 0);
208 // dispatch via rscratch1
209 void dispatch_only(TosState state, bool generate_poll = false);
210 // dispatch normal table via rscratch1 (assume rscratch1 is loaded already)
211 void dispatch_only_normal(TosState state);
212 void dispatch_only_noverify(TosState state);
213 // load rscratch1 from [rbcp + step] and dispatch via rscratch1
214 void dispatch_next(TosState state, int step = 0, bool generate_poll = false);
215 // load rscratch1 from [esi] and dispatch via rscratch1 and table
216 void dispatch_via (TosState state, address* table);
217
218 // jump to an invoked target
219 void prepare_to_jump_from_interpreted();
220 void jump_from_interpreted(Register method, Register temp);
221
222
223 // Returning from interpreted functions
224 //
225 // Removes the current activation (incl. unlocking of monitors)
226 // and sets up the return address. This code is also used for
227 // exception unwindwing. In that case, we do not want to throw
228 // IllegalMonitorStateExceptions, since that might get us into an
229 // infinite rethrow exception loop.
230 // Additionally this code is used for popFrame and earlyReturn.
231 // In popFrame case we want to skip throwing an exception,
232 // installing an exception, and notifying jvmdi.
233 // In earlyReturn case we only want to skip throwing an exception
234 // and installing an exception.
235 void remove_activation(TosState state,
236 bool throw_monitor_exception = true,
237 bool install_monitor_exception = true,
238 bool notify_jvmdi = true);
239
240 // FIXME: Give us a valid frame at a null check.
241 virtual void null_check(Register reg, int offset = -1) {
242 // #ifdef ASSERT
243 // save_bcp();
244 // set_last_Java_frame(esp, rfp, (address) pc());
245 // #endif
246 MacroAssembler::null_check(reg, offset);
247 // #ifdef ASSERT
248 // reset_last_Java_frame(true);
249 // #endif
250 }
251
252 // Object locking
253 void lock_object (Register lock_reg);
254 void unlock_object(Register lock_reg);
255
256 // Interpreter profiling operations
257 void set_method_data_pointer_for_bcp();
258 void test_method_data_pointer(Register mdp, Label& zero_continue);
259 void verify_method_data_pointer();
260
261 void set_mdp_data_at(Register mdp_in, int constant, Register value);
262 void increment_mdp_data_at(Address data, bool decrement = false);
263 void increment_mdp_data_at(Register mdp_in, int constant,
264 bool decrement = false);
265 void increment_mdp_data_at(Register mdp_in, Register reg, int constant,
266 bool decrement = false);
267 void increment_mask_and_jump(Address counter_addr,
268 int increment, Address mask,
269 Register scratch, Register scratch2,
270 bool preloaded, Condition cond,
271 Label* where);
272 void set_mdp_flag_at(Register mdp_in, int flag_constant);
273 void test_mdp_data_at(Register mdp_in, int offset, Register value,
274 Register test_value_out,
275 Label& not_equal_continue);
276
277 void record_klass_in_profile(Register receiver, Register mdp,
278 Register reg2);
279 void record_klass_in_profile_helper(Register receiver, Register mdp,
280 Register reg2, int start_row,
281 Label& done);
282 void record_item_in_profile_helper(Register item, Register mdp,
283 Register reg2, int start_row, Label& done, int total_rows,
284 OffsetFunction item_offset_fn, OffsetFunction item_count_offset_fn);
285
286 void update_mdp_by_offset(Register mdp_in, int offset_of_offset);
287 void update_mdp_by_offset(Register mdp_in, Register reg, int offset_of_disp);
288 void update_mdp_by_constant(Register mdp_in, int constant);
289 void update_mdp_for_ret(Register return_bci);
290
291 // narrow int return value
292 void narrow(Register result);
293
294 void profile_taken_branch(Register mdp, Register bumped_count);
295 void profile_not_taken_branch(Register mdp);
296 void profile_call(Register mdp);
297 void profile_final_call(Register mdp);
298 void profile_virtual_call(Register receiver, Register mdp,
299 Register scratch2,
300 bool receiver_can_be_null = false);
301 void profile_ret(Register return_bci, Register mdp);
302 void profile_null_seen(Register mdp);
303 void profile_typecheck(Register mdp, Register klass, Register scratch);
304 void profile_typecheck_failed(Register mdp);
305 void profile_switch_default(Register mdp);
306 void profile_switch_case(Register index_in_scratch, Register mdp,
307 Register scratch2);
308
309 void profile_obj_type(Register obj, const Address& mdo_addr);
310 void profile_arguments_type(Register mdp, Register callee, Register tmp, bool is_virtual);
311 void profile_return_type(Register mdp, Register ret, Register tmp);
312 void profile_parameters_type(Register mdp, Register tmp1, Register tmp2);
313
314 // Debugging
315 // only if +VerifyOops && state == atos
316 #define interp_verify_oop(reg, state) _interp_verify_oop(reg, state, __FILE__, __LINE__);
317 void _interp_verify_oop(Register reg, TosState state, const char* file, int line);
318
319 typedef enum { NotifyJVMTI, SkipNotifyJVMTI } NotifyMethodExitMode;
320
321 // support for jvmti/dtrace
322 void notify_method_entry();
323 void notify_method_exit(TosState state, NotifyMethodExitMode mode);
324
325 virtual void _call_Unimplemented(address call_site) {
326 save_bcp();
327 set_last_Java_frame(esp, rfp, (address) pc(), rscratch1);
328 MacroAssembler::_call_Unimplemented(call_site);
329 }
330
331 void load_resolved_indy_entry(Register cache, Register index);
332 void load_field_entry(Register cache, Register index, int bcp_offset = 1);
333 void load_method_entry(Register cache, Register index, int bcp_offset = 1);
334 };
335
336 #endif // CPU_AARCH64_INTERP_MASM_AARCH64_HPP