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