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