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