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