1 /*
2 * Copyright (c) 2003, 2023, Oracle and/or its affiliates. All rights reserved.
3 * Copyright (c) 2014, 2015, Red Hat Inc. All rights reserved.
4 * Copyright (c) 2020, 2021, Huawei Technologies Co., Ltd. All rights reserved.
5 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 *
7 * This code is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License version 2 only, as
9 * published by the Free Software Foundation.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 *
25 */
26
27 #ifndef CPU_RISCV_INTERP_MASM_RISCV_HPP
28 #define CPU_RISCV_INTERP_MASM_RISCV_HPP
29
30 #include "asm/macroAssembler.hpp"
31 #include "interpreter/invocationCounter.hpp"
32 #include "runtime/frame.hpp"
33
34 // This file specializes the assembler with interpreter-specific macros
35
36 typedef ByteSize (*OffsetFunction)(uint);
37
38 class InterpreterMacroAssembler: public MacroAssembler {
39 protected:
40 // Interpreter specific version of call_VM_base
41 using MacroAssembler::call_VM_leaf_base;
42
43 virtual void call_VM_leaf_base(address entry_point,
44 int number_of_arguments);
45
46 virtual void call_VM_base(Register oop_result,
47 Register java_thread,
48 Register last_java_sp,
49 address entry_point,
50 int number_of_arguments,
51 bool check_exceptions);
52
53 // base routine for all dispatches
54 void dispatch_base(TosState state, address* table, bool verifyoop = true,
55 bool generate_poll = false, Register Rs = t0);
56
57 public:
58 InterpreterMacroAssembler(CodeBuffer* code) : MacroAssembler(code) {}
59
60 void load_earlyret_value(TosState state);
61
62 void jump_to_entry(address entry);
63
64 virtual void check_and_handle_popframe(Register java_thread);
65 virtual void check_and_handle_earlyret(Register java_thread);
66
67 // Interpreter-specific registers
68 void save_bcp() {
69 sd(xbcp, Address(fp, frame::interpreter_frame_bcp_offset * wordSize));
70 }
71
72 void restore_bcp() {
73 ld(xbcp, Address(fp, frame::interpreter_frame_bcp_offset * wordSize));
74 }
75
76 void restore_locals() {
77 ld(xlocals, Address(fp, frame::interpreter_frame_locals_offset * wordSize));
78 shadd(xlocals, xlocals, fp, t0, LogBytesPerWord);
79 }
80
81 void restore_constant_pool_cache() {
82 ld(xcpool, Address(fp, frame::interpreter_frame_cache_offset * wordSize));
83 }
84
85 void restore_sp_after_call() {
86 Label L;
87 ld(t0, Address(fp, frame::interpreter_frame_extended_sp_offset * wordSize));
88 shadd(t0, t0, fp, t0, LogBytesPerWord);
89 #ifdef ASSERT
90 bnez(t0, L);
91 stop("SP is null");
92 #endif
93 bind(L);
94 mv(sp, t0);
95 }
96
97 void check_extended_sp(const char* msg = "check extended SP") {
98 #ifdef ASSERT
99 Label L;
100 ld(t0, Address(fp, frame::interpreter_frame_extended_sp_offset * wordSize));
101 shadd(t0, t0, fp, t0, LogBytesPerWord);
102 beq(sp, t0, 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 ld(reg, Address(fp, frame::interpreter_frame_method_offset * wordSize));
116 }
117
118 void get_const(Register reg) {
119 get_method(reg);
120 ld(reg, Address(reg, in_bytes(Method::const_offset())));
121 }
122
123 void get_constant_pool(Register reg) {
124 get_const(reg);
125 ld(reg, Address(reg, in_bytes(ConstMethod::constants_offset())));
126 }
127
128 void get_constant_pool_cache(Register reg) {
129 get_constant_pool(reg);
130 ld(reg, Address(reg, ConstantPool::cache_offset()));
131 }
132
133 void get_cpool_and_tags(Register cpool, Register tags) {
134 get_constant_pool(cpool);
135 ld(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, Register tmp, 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 = x15);
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 = x10);
149 void pop_i(Register r = x10);
150 void pop_l(Register r = x10);
151 void pop_f(FloatRegister r = f10);
152 void pop_d(FloatRegister r = f10);
153 void push_ptr(Register r = x10);
154 void push_i(Register r = x10);
155 void push_l(Register r = x10);
156 void push_f(FloatRegister r = f10);
157 void push_d(FloatRegister r = f10);
158
159 void pop(TosState state); // transition vtos -> state
160 void push(TosState state); // transition state -> vtos
161
162 void empty_expression_stack() {
163 ld(t0, Address(fp, frame::interpreter_frame_monitor_block_top_offset * wordSize));
164 shadd(esp, t0, fp, t0, LogBytesPerWord);
165 // null last_sp until next java call
166 sd(zr, Address(fp, frame::interpreter_frame_last_sp_offset * wordSize));
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 // Load float value from 'address'. The value is loaded onto the fp register f10.
174 void load_float(Address src);
175 void load_double(Address src);
176
177 // Generate a subtype check: branch to ok_is_subtype if sub_klass is
178 // a subtype of super_klass.
179 void gen_subtype_check( Register sub_klass, Label &ok_is_subtype );
180
181 // Dispatching
182 void dispatch_prolog(TosState state, int step = 0);
183 void dispatch_epilog(TosState state, int step = 0);
184 // dispatch via t0
185 void dispatch_only(TosState state, bool generate_poll = false, Register Rs = t0);
186 // dispatch normal table via t0 (assume t0 is loaded already)
187 void dispatch_only_normal(TosState state, Register Rs = t0);
188 void dispatch_only_noverify(TosState state, Register Rs = t0);
189 // load t0 from [xbcp + step] and dispatch via t0
190 void dispatch_next(TosState state, int step = 0, bool generate_poll = false);
191 // load t0 from [xbcp] and dispatch via t0 and table
192 void dispatch_via (TosState state, address* table);
193
194 // jump to an invoked target
195 void prepare_to_jump_from_interpreted();
196 void jump_from_interpreted(Register method);
197
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,
212 bool throw_monitor_exception = true,
213 bool install_monitor_exception = true,
214 bool notify_jvmdi = true);
215
216 // FIXME: Give us a valid frame at a null check.
217 virtual void null_check(Register reg, int offset = -1) {
218 MacroAssembler::null_check(reg, offset);
219 }
220
221 // Object locking
222 void lock_object (Register lock_reg);
223 void unlock_object(Register lock_reg);
224
225 // Interpreter profiling operations
226 void set_method_data_pointer_for_bcp();
227 void test_method_data_pointer(Register mdp, Label& zero_continue);
228 void verify_method_data_pointer();
229
230 void set_mdp_data_at(Register mdp_in, int constant, Register value);
231 void increment_mdp_data_at(Address data, bool decrement = false);
232 void increment_mdp_data_at(Register mdp_in, int constant,
233 bool decrement = false);
234 void increment_mdp_data_at(Register mdp_in, Register reg, int constant,
235 bool decrement = false);
236 void increment_mask_and_jump(Address counter_addr,
237 int increment, Address mask,
238 Register tmp1, Register tmp2,
239 bool preloaded, Label* where);
240
241 void set_mdp_flag_at(Register mdp_in, int flag_constant);
242 void test_mdp_data_at(Register mdp_in, int offset, Register value,
243 Register test_value_out,
244 Label& not_equal_continue);
245
246 void record_klass_in_profile(Register receiver, Register mdp,
247 Register reg2);
248 void record_klass_in_profile_helper(Register receiver, Register mdp,
249 Register reg2, Label& done);
250 void record_item_in_profile_helper(Register item, Register mdp,
251 Register reg2, int start_row, Label& done, int total_rows,
252 OffsetFunction item_offset_fn, OffsetFunction item_count_offset_fn);
253
254 void update_mdp_by_offset(Register mdp_in, int offset_of_offset);
255 void update_mdp_by_offset(Register mdp_in, Register reg, int offset_of_disp);
256 void update_mdp_by_constant(Register mdp_in, int constant);
257 void update_mdp_for_ret(Register return_bci);
258
259 // narrow int return value
260 void narrow(Register result);
261
262 void profile_taken_branch(Register mdp, Register bumped_count);
263 void profile_not_taken_branch(Register mdp);
264 void profile_call(Register mdp);
265 void profile_final_call(Register mdp);
266 void profile_virtual_call(Register receiver, Register mdp,
267 Register t1,
268 bool receiver_can_be_null = false);
269 void profile_ret(Register return_bci, Register mdp);
270 void profile_null_seen(Register mdp);
271 void profile_typecheck(Register mdp, Register klass, Register temp);
272 void profile_typecheck_failed(Register mdp);
273 void profile_switch_default(Register mdp);
274 void profile_switch_case(Register index_in_scratch, Register mdp,
275 Register temp);
276
277 void profile_obj_type(Register obj, const Address& mdo_addr, Register tmp);
278 void profile_arguments_type(Register mdp, Register callee, Register tmp, bool is_virtual);
279 void profile_return_type(Register mdp, Register ret, Register tmp);
280 void profile_parameters_type(Register mdp, Register tmp1, Register tmp2, Register tmp3);
281
282 // Debugging
283 // only if +VerifyFPU && (state == ftos || state == dtos)
284 void verify_FPU(int stack_depth, TosState state = ftos);
285
286 typedef enum { NotifyJVMTI, SkipNotifyJVMTI } NotifyMethodExitMode;
287
288 // support for jvmti/dtrace
289 void notify_method_entry();
290 void notify_method_exit(TosState state, NotifyMethodExitMode mode);
291
292 virtual void _call_Unimplemented(address call_site) {
293 save_bcp();
294 set_last_Java_frame(esp, fp, (address) pc(), t0);
295 MacroAssembler::_call_Unimplemented(call_site);
296 }
297
298 void load_resolved_indy_entry(Register cache, Register index);
299 void load_field_entry(Register cache, Register index, int bcp_offset = 1);
300 void load_method_entry(Register cache, Register index, int bcp_offset = 1);
301
302 #ifdef ASSERT
303 void verify_access_flags(Register access_flags, uint32_t flag,
304 const char* msg, bool stop_by_hit = true);
305 void verify_frame_setup();
306 #endif
307 };
308
309 #endif // CPU_RISCV_INTERP_MASM_RISCV_HPP