1 /* 2 * Copyright (c) 2002, 2023, Oracle and/or its affiliates. All rights reserved. 3 * Copyright (c) 2012, 2023 SAP SE. 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_PPC_INTERP_MASM_PPC_HPP 27 #define CPU_PPC_INTERP_MASM_PPC_HPP 28 29 #include "asm/macroAssembler.hpp" 30 #include "interpreter/invocationCounter.hpp" 31 32 // This file specializes the assembler with interpreter-specific macros. 33 34 35 class InterpreterMacroAssembler: public MacroAssembler { 36 37 public: 38 InterpreterMacroAssembler(CodeBuffer* code) : MacroAssembler(code) {} 39 40 void null_check_throw(Register a, int offset, Register temp_reg); 41 void load_klass_check_null_throw(Register dst, Register src, Register temp_reg); 42 43 void jump_to_entry(address entry, Register Rscratch); 44 45 // Handy address generation macros. 46 #define thread_(field_name) in_bytes(JavaThread::field_name ## _offset()), R16_thread 47 #define method_(field_name) in_bytes(Method::field_name ## _offset()), R19_method 48 49 virtual void check_and_handle_popframe(Register scratch_reg); 50 virtual void check_and_handle_earlyret(Register scratch_reg); 51 52 void call_VM_preemptable(Register oop_result, address entry_point, Register arg_1, bool check_exceptions = true); 53 void restore_after_resume(Register fp); 54 // R22 and R31 are preserved when a vthread gets preempted in the interpreter. 55 // The interpreter already assumes that these registers are nonvolatile across native calls. 56 bool nonvolatile_accross_vthread_preemtion(Register r) const { 57 return r->is_nonvolatile() && ((r == R22) || (r == R31)); 58 } 59 60 // Base routine for all dispatches. 61 void dispatch_base(TosState state, address* table); 62 63 void load_earlyret_value(TosState state, Register Rscratch1); 64 65 static const Address l_tmp; 66 static const Address d_tmp; 67 68 // dispatch routines 69 void dispatch_next(TosState state, int step = 0, bool generate_poll = false); 70 void dispatch_via (TosState state, address* table); 71 void load_dispatch_table(Register dst, address* table); 72 void dispatch_Lbyte_code(TosState state, Register bytecode, address* table, bool generate_poll = false); 73 74 // Called by shared interpreter generator. 75 void dispatch_prolog(TosState state, int step = 0); 76 void dispatch_epilog(TosState state, int step = 0); 77 78 // Super call_VM calls - correspond to MacroAssembler::call_VM(_leaf) calls. 79 void super_call_VM_leaf(Register thread_cache, address entry_point, Register arg_1); 80 void super_call_VM(Register thread_cache, Register oop_result, Register last_java_sp, 81 address entry_point, Register arg_1, Register arg_2, bool check_exception = true); 82 83 // Generate a subtype check: branch to ok_is_subtype if sub_klass is 84 // a subtype of super_klass. Blows registers tmp1, tmp2 and tmp3. 85 void gen_subtype_check(Register sub_klass, Register super_klass, 86 Register tmp1, Register tmp2, Register tmp3, Label &ok_is_subtype); 87 88 // Load object from cpool->resolved_references(index). 89 void load_resolved_reference_at_index(Register result, Register index, Register tmp1, Register tmp2, 90 Label *L_handle_null = nullptr); 91 92 // load cpool->resolved_klass_at(index) 93 void load_resolved_klass_at_offset(Register Rcpool, Register Roffset, Register Rklass); 94 95 void load_receiver(Register Rparam_count, Register Rrecv_dst); 96 97 // helpers for expression stack 98 void pop_i( Register r = R17_tos); 99 void pop_ptr( Register r = R17_tos); 100 void pop_l( Register r = R17_tos); 101 void pop_f(FloatRegister f = F15_ftos); 102 void pop_d(FloatRegister f = F15_ftos ); 103 104 void push_i( Register r = R17_tos); 105 void push_ptr( Register r = R17_tos); 106 void push_l( Register r = R17_tos); 107 void push_f(FloatRegister f = F15_ftos ); 108 void push_d(FloatRegister f = F15_ftos); 109 110 void push_2ptrs(Register first, Register second); 111 112 void move_l_to_d(Register l = R17_tos, FloatRegister d = F15_ftos); 113 void move_d_to_l(FloatRegister d = F15_ftos, Register l = R17_tos); 114 115 void pop (TosState state); // transition vtos -> state 116 void push(TosState state); // transition state -> vtos 117 void empty_expression_stack(); // Resets both Lesp and SP. 118 119 public: 120 // Load values from bytecode stream: 121 122 enum signedOrNot { Signed, Unsigned }; 123 enum setCCOrNot { set_CC, dont_set_CC }; 124 125 void get_2_byte_integer_at_bcp(int bcp_offset, 126 Register Rdst, 127 signedOrNot is_signed); 128 129 void get_4_byte_integer_at_bcp(int bcp_offset, 130 Register Rdst, 131 signedOrNot is_signed = Unsigned); 132 133 void get_cache_index_at_bcp(Register Rdst, int bcp_offset, size_t index_size); 134 135 void load_resolved_indy_entry(Register cache, Register index); 136 void load_field_entry(Register cache, Register index, int bcp_offset = 1); 137 void load_method_entry(Register cache, Register index, int bcp_offset = 1); 138 139 void get_u4(Register Rdst, Register Rsrc, int offset, signedOrNot is_signed); 140 141 // common code 142 143 void field_offset_at(int n, Register tmp, Register dest, Register base); 144 int field_offset_at(Register object, address bcp, int offset); 145 void fast_iaaccess(int n, address bcp); 146 void fast_iaputfield(address bcp, bool do_store_check); 147 148 void index_check(Register array, Register index, int index_shift, Register tmp, Register res); 149 void index_check_without_pop(Register array, Register index, int index_shift, Register tmp, Register res); 150 151 void get_const(Register Rdst); 152 void get_constant_pool(Register Rdst); 153 void get_constant_pool_cache(Register Rdst); 154 void get_cpool_and_tags(Register Rcpool, Register Rtags); 155 void is_a(Label& L); 156 157 void narrow(Register result); 158 159 // Java Call Helpers 160 void call_from_interpreter(Register Rtarget_method, Register Rret_addr, Register Rscratch1, Register Rscratch2); 161 162 // -------------------------------------------------- 163 164 void unlock_if_synchronized_method(TosState state, bool throw_monitor_exception = true, 165 bool install_monitor_exception = true); 166 167 // Removes the current activation (incl. unlocking of monitors). 168 // Additionally this code is used for earlyReturn in which case we 169 // want to skip throwing an exception and installing an exception. 170 void remove_activation(TosState state, 171 bool throw_monitor_exception = true, 172 bool install_monitor_exception = true); 173 void merge_frames(Register Rtop_frame_sp, Register return_pc, Register Rscratch1, Register Rscratch2); // merge top frames 174 175 void add_monitor_to_stack(bool stack_is_empty, Register Rtemp1, Register Rtemp2); 176 177 // Local variable access helpers 178 void load_local_int(Register Rdst_value, Register Rdst_address, Register Rindex); 179 void load_local_long(Register Rdst_value, Register Rdst_address, Register Rindex); 180 void load_local_ptr(Register Rdst_value, Register Rdst_address, Register Rindex); 181 void load_local_float(FloatRegister Rdst_value, Register Rdst_address, Register Rindex); 182 void load_local_double(FloatRegister Rdst_value, Register Rdst_address, Register Rindex); 183 void store_local_int(Register Rvalue, Register Rindex); 184 void store_local_long(Register Rvalue, Register Rindex); 185 void store_local_ptr(Register Rvalue, Register Rindex); 186 void store_local_float(FloatRegister Rvalue, Register Rindex); 187 void store_local_double(FloatRegister Rvalue, Register Rindex); 188 189 // Call VM for std frames 190 // Special call VM versions that check for exceptions and forward exception 191 // via short cut (not via expensive forward exception stub). 192 void check_and_forward_exception(Register Rscratch1, Register Rscratch2); 193 void call_VM(Register oop_result, address entry_point, bool check_exceptions = true, Label* last_java_pc = nullptr); 194 void call_VM(Register oop_result, address entry_point, Register arg_1, bool check_exceptions = true); 195 void call_VM(Register oop_result, address entry_point, Register arg_1, Register arg_2, bool check_exceptions = true); 196 void call_VM(Register oop_result, address entry_point, Register arg_1, Register arg_2, Register arg_3, bool check_exceptions = true); 197 // Should not be used: 198 void call_VM(Register oop_result, Register last_java_sp, address entry_point, bool check_exceptions = true) {ShouldNotReachHere();} 199 void call_VM(Register oop_result, Register last_java_sp, address entry_point, Register arg_1, bool check_exceptions = true) {ShouldNotReachHere();} 200 void call_VM(Register oop_result, Register last_java_sp, address entry_point, Register arg_1, Register arg_2, bool check_exceptions = true) {ShouldNotReachHere();} 201 void call_VM(Register oop_result, Register last_java_sp, address entry_point, Register arg_1, Register arg_2, Register arg_3, bool check_exceptions = true) {ShouldNotReachHere();} 202 203 Address first_local_in_stack(); 204 205 enum LoadOrStore { load, store }; 206 void static_iload_or_store(int which_local, LoadOrStore direction, Register Rtmp); 207 void static_aload_or_store(int which_local, LoadOrStore direction, Register Rtmp); 208 void static_dload_or_store(int which_local, LoadOrStore direction); 209 210 void save_interpreter_state(Register scratch); 211 void restore_interpreter_state(Register scratch, bool bcp_and_mdx_only = false, bool restore_top_frame_sp = false); 212 213 void increment_backedge_counter(const Register Rcounters, Register Rtmp, Register Rtmp2, Register Rscratch); 214 215 void record_static_call_in_profile(Register Rentry, Register Rtmp); 216 void record_receiver_call_in_profile(Register Rklass, Register Rentry, Register Rtmp); 217 218 void get_method_counters(Register method, Register Rcounters, Label& skip); 219 void increment_invocation_counter(Register iv_be_count, Register Rtmp1, Register Rtmp2_r0); 220 221 // Object locking 222 void lock_object (Register lock_reg, Register obj_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(Label& zero_continue); 228 void verify_method_data_pointer(); 229 230 void set_mdp_data_at(int constant, Register value); 231 232 void increment_mdp_data_at(int constant, Register counter_addr, Register Rbumped_count, bool decrement = false); 233 234 void increment_mdp_data_at(Register counter_addr, Register Rbumped_count, bool decrement = false); 235 void increment_mdp_data_at(Register reg, int constant, Register scratch, Register Rbumped_count, bool decrement = false); 236 237 void set_mdp_flag_at(int flag_constant, Register scratch); 238 void test_mdp_data_at(int offset, Register value, Label& not_equal_continue, Register test_out); 239 240 void update_mdp_by_offset(int offset_of_disp, Register scratch); 241 void update_mdp_by_offset(Register reg, int offset_of_disp, 242 Register scratch); 243 void update_mdp_by_constant(int constant); 244 void update_mdp_for_ret(TosState state, Register return_bci); 245 246 void profile_taken_branch(Register scratch, Register bumped_count); 247 void profile_not_taken_branch(Register scratch1, Register scratch2); 248 void profile_call(Register scratch1, Register scratch2); 249 void profile_final_call(Register scratch1, Register scratch2); 250 void profile_virtual_call(Register Rreceiver, Register Rscratch1, Register Rscratch2, bool receiver_can_be_null); 251 void profile_typecheck(Register Rklass, Register Rscratch1, Register Rscratch2); 252 void profile_ret(TosState state, Register return_bci, Register scratch1, Register scratch2); 253 void profile_switch_default(Register scratch1, Register scratch2); 254 void profile_switch_case(Register index, Register scratch1,Register scratch2, Register scratch3); 255 void profile_null_seen(Register Rscratch1, Register Rscratch2); 256 void record_klass_in_profile(Register receiver, Register scratch1, Register scratch2); 257 void record_klass_in_profile_helper(Register receiver, Register scratch1, Register scratch2, int start_row, Label& done); 258 259 // Argument and return type profiling. 260 void profile_obj_type(Register obj, Register mdo_addr_base, RegisterOrConstant mdo_addr_offs, Register tmp, Register tmp2); 261 void profile_arguments_type(Register callee, Register tmp1, Register tmp2, bool is_virtual); 262 void profile_return_type(Register ret, Register tmp1, Register tmp2); 263 void profile_parameters_type(Register tmp1, Register tmp2, Register tmp3, Register tmp4); 264 265 // Debugging 266 void verify_oop(Register reg, TosState state = atos); // only if +VerifyOops && state == atos 267 void verify_oop_or_return_address(Register reg, Register rtmp); // for astore 268 void verify_FPU(int stack_depth, TosState state = ftos); 269 270 typedef enum { NotifyJVMTI, SkipNotifyJVMTI } NotifyMethodExitMode; 271 272 // Support for jvmdi/jvmpi. 273 void notify_method_entry(); 274 void notify_method_exit(bool is_native_method, TosState state, 275 NotifyMethodExitMode mode, bool check_exceptions); 276 }; 277 278 #endif // CPU_PPC_INTERP_MASM_PPC_HPP