1 /* 2 * Copyright (c) 2003, 2021, 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 assember 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 } 80 81 void restore_constant_pool_cache() { 82 ldr(rcpool, Address(rfp, frame::interpreter_frame_cache_offset * wordSize)); 83 } 84 85 void get_dispatch(); 86 87 // Helpers for runtime call arguments/results 88 89 // Helpers for runtime call arguments/results 90 void get_method(Register reg) { 91 ldr(reg, Address(rfp, frame::interpreter_frame_method_offset * wordSize)); 92 } 93 94 void get_const(Register reg) { 95 get_method(reg); 96 ldr(reg, Address(reg, in_bytes(Method::const_offset()))); 97 } 98 99 void get_constant_pool(Register reg) { 100 get_const(reg); 101 ldr(reg, Address(reg, in_bytes(ConstMethod::constants_offset()))); 102 } 103 104 void get_constant_pool_cache(Register reg) { 105 get_constant_pool(reg); 106 ldr(reg, Address(reg, ConstantPool::cache_offset_in_bytes())); 107 } 108 109 void get_cpool_and_tags(Register cpool, Register tags) { 110 get_constant_pool(cpool); 111 ldr(tags, Address(cpool, ConstantPool::tags_offset_in_bytes())); 112 } 113 114 void get_unsigned_2_byte_index_at_bcp(Register reg, int bcp_offset); 115 void get_cache_and_index_at_bcp(Register cache, Register index, int bcp_offset, size_t index_size = sizeof(u2)); 116 void get_cache_and_index_and_bytecode_at_bcp(Register cache, Register index, Register bytecode, int byte_no, int bcp_offset, size_t index_size = sizeof(u2)); 117 void get_cache_entry_pointer_at_bcp(Register cache, Register tmp, int bcp_offset, size_t index_size = sizeof(u2)); 118 void get_cache_index_at_bcp(Register index, int bcp_offset, size_t index_size = sizeof(u2)); 119 void get_method_counters(Register method, Register mcs, Label& skip); 120 121 // Kills t1 and t2, perserves klass, return allocation in new_obj 122 void allocate_instance(Register klass, Register new_obj, 123 Register t1, Register t2, 124 bool clear_fields, Label& alloc_failed); 125 126 // Allocate instance in "obj" and read in the content of the inline field 127 // NOTES: 128 // - input holder object via "obj", which must be r0, 129 // will return new instance via the same reg 130 // - assumes holder_klass and valueKlass field klass have both been resolved 131 void read_inlined_field(Register holder_klass, 132 Register field_index, Register field_offset, 133 Register temp, Register obj = r0); 134 135 // Allocate value buffer in "obj" and read in flattened element at the given index 136 // NOTES: 137 // - Return via "obj" must be r0 138 // - kills all given regs 139 void read_flattened_element(Register array, Register index, 140 Register t1, Register t2, 141 Register obj = r0); 142 143 // load cpool->resolved_references(index); 144 void load_resolved_reference_at_index(Register result, Register index, Register tmp = r5); 145 146 // load cpool->resolved_klass_at(index); 147 void load_resolved_klass_at_offset(Register cpool, Register index, Register klass, Register temp); 148 149 void load_resolved_method_at_index(int byte_no, Register method, Register cache); 150 151 void pop_ptr(Register r = r0); 152 void pop_i(Register r = r0); 153 void pop_l(Register r = r0); 154 void pop_f(FloatRegister r = v0); 155 void pop_d(FloatRegister r = v0); 156 void push_ptr(Register r = r0); 157 void push_i(Register r = r0); 158 void push_l(Register r = r0); 159 void push_f(FloatRegister r = v0); 160 void push_d(FloatRegister r = v0); 161 162 void pop(Register r ) { ((MacroAssembler*)this)->pop(r); } 163 164 void push(Register r ) { ((MacroAssembler*)this)->push(r); } 165 166 void pop(TosState state); // transition vtos -> state 167 void push(TosState state); // transition state -> vtos 168 169 void pop(RegSet regs, Register stack) { ((MacroAssembler*)this)->pop(regs, stack); } 170 void push(RegSet regs, Register stack) { ((MacroAssembler*)this)->push(regs, stack); } 171 172 void empty_expression_stack() { 173 ldr(esp, Address(rfp, frame::interpreter_frame_monitor_block_top_offset * wordSize)); 174 // NULL last_sp until next java call 175 str(zr, Address(rfp, frame::interpreter_frame_last_sp_offset * wordSize)); 176 } 177 178 // Helpers for swap and dup 179 void load_ptr(int n, Register val); 180 void store_ptr(int n, Register val); 181 182 // Load float value from 'address'. The value is loaded onto the FPU register v0. 183 void load_float(Address src); 184 void load_double(Address src); 185 186 // Generate a subtype check: branch to ok_is_subtype if sub_klass is 187 // a subtype of super_klass. 188 void gen_subtype_check( Register sub_klass, Label &ok_is_subtype, bool profile = true); 189 190 // Dispatching 191 void dispatch_prolog(TosState state, int step = 0); 192 void dispatch_epilog(TosState state, int step = 0); 193 // dispatch via rscratch1 194 void dispatch_only(TosState state, bool generate_poll = false); 195 // dispatch normal table via rscratch1 (assume rscratch1 is loaded already) 196 void dispatch_only_normal(TosState state); 197 void dispatch_only_noverify(TosState state); 198 // load rscratch1 from [rbcp + step] and dispatch via rscratch1 199 void dispatch_next(TosState state, int step = 0, bool generate_poll = false); 200 // load rscratch1 from [esi] and dispatch via rscratch1 and table 201 void dispatch_via (TosState state, address* table); 202 203 // jump to an invoked target 204 void prepare_to_jump_from_interpreted(); 205 void jump_from_interpreted(Register method, Register temp); 206 207 208 // Returning from interpreted functions 209 // 210 // Removes the current activation (incl. unlocking of monitors) 211 // and sets up the return address. This code is also used for 212 // exception unwindwing. In that case, we do not want to throw 213 // IllegalMonitorStateExceptions, since that might get us into an 214 // infinite rethrow exception loop. 215 // Additionally this code is used for popFrame and earlyReturn. 216 // In popFrame case we want to skip throwing an exception, 217 // installing an exception, and notifying jvmdi. 218 // In earlyReturn case we only want to skip throwing an exception 219 // and installing an exception. 220 void remove_activation(TosState state, 221 bool throw_monitor_exception = true, 222 bool install_monitor_exception = true, 223 bool notify_jvmdi = true); 224 225 // FIXME: Give us a valid frame at a null check. 226 virtual void null_check(Register reg, int offset = -1) { 227 // #ifdef ASSERT 228 // save_bcp(); 229 // set_last_Java_frame(esp, rfp, (address) pc()); 230 // #endif 231 MacroAssembler::null_check(reg, offset); 232 // #ifdef ASSERT 233 // reset_last_Java_frame(true); 234 // #endif 235 } 236 237 // Object locking 238 void lock_object (Register lock_reg); 239 void unlock_object(Register lock_reg); 240 241 // Interpreter profiling operations 242 void set_method_data_pointer_for_bcp(); 243 void test_method_data_pointer(Register mdp, Label& zero_continue); 244 void verify_method_data_pointer(); 245 246 void set_mdp_data_at(Register mdp_in, int constant, Register value); 247 void increment_mdp_data_at(Address data, bool decrement = false); 248 void increment_mdp_data_at(Register mdp_in, int constant, 249 bool decrement = false); 250 void increment_mdp_data_at(Register mdp_in, Register reg, int constant, 251 bool decrement = false); 252 void increment_mask_and_jump(Address counter_addr, 253 int increment, Address mask, 254 Register scratch, Register scratch2, 255 bool preloaded, Condition cond, 256 Label* where); 257 void set_mdp_flag_at(Register mdp_in, int flag_constant); 258 void test_mdp_data_at(Register mdp_in, int offset, Register value, 259 Register test_value_out, 260 Label& not_equal_continue); 261 262 void record_klass_in_profile(Register receiver, Register mdp, 263 Register reg2, bool is_virtual_call); 264 void record_klass_in_profile_helper(Register receiver, Register mdp, 265 Register reg2, int start_row, 266 Label& done, bool is_virtual_call); 267 void record_item_in_profile_helper(Register item, Register mdp, 268 Register reg2, int start_row, Label& done, int total_rows, 269 OffsetFunction item_offset_fn, OffsetFunction item_count_offset_fn, 270 int non_profiled_offset); 271 272 void update_mdp_by_offset(Register mdp_in, int offset_of_offset); 273 void update_mdp_by_offset(Register mdp_in, Register reg, int offset_of_disp); 274 void update_mdp_by_constant(Register mdp_in, int constant); 275 void update_mdp_for_ret(Register return_bci); 276 277 // narrow int return value 278 void narrow(Register result); 279 280 void profile_taken_branch(Register mdp, Register bumped_count); 281 void profile_not_taken_branch(Register mdp, bool acmp = false); 282 void profile_call(Register mdp); 283 void profile_final_call(Register mdp); 284 void profile_virtual_call(Register receiver, Register mdp, 285 Register scratch2, 286 bool receiver_can_be_null = false); 287 void profile_ret(Register return_bci, Register mdp); 288 void profile_null_seen(Register mdp); 289 void profile_typecheck(Register mdp, Register klass, Register scratch); 290 void profile_typecheck_failed(Register mdp); 291 void profile_switch_default(Register mdp); 292 void profile_switch_case(Register index_in_scratch, Register mdp, 293 Register scratch2); 294 void profile_array(Register mdp, Register array, Register tmp); 295 void profile_element(Register mdp, Register element, Register tmp); 296 void profile_acmp(Register mdp, Register left, Register right, Register tmp); 297 298 void profile_obj_type(Register obj, const Address& mdo_addr); 299 void profile_arguments_type(Register mdp, Register callee, Register tmp, bool is_virtual); 300 void profile_return_type(Register mdp, Register ret, Register tmp); 301 void profile_parameters_type(Register mdp, Register tmp1, Register tmp2); 302 303 // Debugging 304 // only if +VerifyOops && state == atos 305 void verify_oop(Register reg, TosState state = atos); 306 // only if +VerifyFPU && (state == ftos || state == dtos) 307 void verify_FPU(int stack_depth, TosState state = ftos); 308 309 typedef enum { NotifyJVMTI, SkipNotifyJVMTI } NotifyMethodExitMode; 310 311 // support for jvmti/dtrace 312 void notify_method_entry(); 313 void notify_method_exit(TosState state, NotifyMethodExitMode mode); 314 315 virtual void _call_Unimplemented(address call_site) { 316 save_bcp(); 317 set_last_Java_frame(esp, rfp, (address) pc(), rscratch1); 318 MacroAssembler::_call_Unimplemented(call_site); 319 } 320 }; 321 322 #endif // CPU_AARCH64_INTERP_MASM_AARCH64_HPP