1 /*
   2  * Copyright (c) 2013, Red Hat Inc.
   3  * Copyright (c) 2003, 2011, Oracle and/or its affiliates.
   4  * 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_AARCH64_VM_INTERP_MASM_AARCH64_64_HPP
  28 #define CPU_AARCH64_VM_INTERP_MASM_AARCH64_64_HPP
  29 
  30 #include "asm/macroAssembler.hpp"
  31 #include "asm/macroAssembler.inline.hpp"
  32 #include "interpreter/invocationCounter.hpp"
  33 #include "runtime/frame.hpp"
  34 
  35 // This file specializes the assember with interpreter-specific macros
  36 
  37 
  38 class InterpreterMacroAssembler: public MacroAssembler {
  39 #ifndef CC_INTERP
  40  protected:
  41 
  42  protected:
  43   using MacroAssembler::call_VM_leaf_base;
  44 
  45   // Interpreter specific version of call_VM_base
  46   using MacroAssembler::call_VM_leaf_base;
  47 
  48   virtual void call_VM_leaf_base(address entry_point,
  49                                  int number_of_arguments);
  50 
  51   virtual void call_VM_base(Register oop_result,
  52                             Register java_thread,
  53                             Register last_java_sp,
  54                             address  entry_point,
  55                             int number_of_arguments,
  56                             bool check_exceptions);
  57 
  58   virtual void check_and_handle_popframe(Register java_thread);
  59   virtual void check_and_handle_earlyret(Register java_thread);
  60 
  61   // base routine for all dispatches
  62   void dispatch_base(TosState state, address* table, bool verifyoop = true);
  63 #endif // CC_INTERP
  64 
  65  public:
  66   InterpreterMacroAssembler(CodeBuffer* code) : MacroAssembler(code) {}
  67 
  68   void load_earlyret_value(TosState state);
  69 
  70 #ifdef CC_INTERP
  71   void save_bcp()                                          { /*  not needed in c++ interpreter and harmless */ }
  72   void restore_bcp()                                       { /*  not needed in c++ interpreter and harmless */ }
  73 
  74   // Helpers for runtime call arguments/results
  75   void get_method(Register reg);
  76 
  77 #else
  78 
  79   // Interpreter-specific registers
  80   void save_bcp() {
  81     str(rbcp, Address(rfp, frame::interpreter_frame_bcx_offset * wordSize));
  82   }
  83 
  84   void restore_bcp() {
  85     ldr(rbcp, Address(rfp, frame::interpreter_frame_bcx_offset * wordSize));
  86   }
  87 
  88   void restore_locals() {
  89     ldr(rlocals, Address(rfp, frame::interpreter_frame_locals_offset * wordSize));
  90   }
  91 
  92   void restore_constant_pool_cache() {
  93     ldr(rcpool, Address(rfp, frame::interpreter_frame_cache_offset * wordSize));
  94   }
  95 
  96   void get_dispatch();
  97 
  98   // Helpers for runtime call arguments/results
  99 
 100   // Helpers for runtime call arguments/results
 101   void get_method(Register reg) {
 102     ldr(reg, Address(rfp, frame::interpreter_frame_method_offset * wordSize));
 103   }
 104 
 105   void get_const(Register reg) {
 106     get_method(reg);
 107     ldr(reg, Address(reg, in_bytes(Method::const_offset())));
 108   }
 109 
 110   void get_constant_pool(Register reg) {
 111     get_const(reg);
 112     ldr(reg, Address(reg, in_bytes(ConstMethod::constants_offset())));
 113   }
 114 
 115   void get_constant_pool_cache(Register reg) {
 116     get_constant_pool(reg);
 117     ldr(reg, Address(reg, ConstantPool::cache_offset_in_bytes()));
 118   }
 119 
 120   void get_cpool_and_tags(Register cpool, Register tags) {
 121     get_constant_pool(cpool);
 122     ldr(tags, Address(cpool, ConstantPool::tags_offset_in_bytes()));
 123   }
 124 
 125   void get_unsigned_2_byte_index_at_bcp(Register reg, int bcp_offset);
 126   void get_cache_and_index_at_bcp(Register cache, Register index, int bcp_offset, size_t index_size = sizeof(u2));
 127   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));
 128   void get_cache_entry_pointer_at_bcp(Register cache, Register tmp, int bcp_offset, size_t index_size = sizeof(u2));
 129   void get_cache_index_at_bcp(Register index, int bcp_offset, size_t index_size = sizeof(u2));
 130   void get_method_counters(Register method, Register mcs, Label& skip);
 131 
 132   // load cpool->resolved_references(index);
 133   void load_resolved_reference_at_index(Register result, Register index);
 134 
 135   void pop_ptr(Register r = r0);
 136   void pop_i(Register r = r0);
 137   void pop_l(Register r = r0);
 138   void pop_f(FloatRegister r = v0);
 139   void pop_d(FloatRegister r = v0);
 140   void push_ptr(Register r = r0);
 141   void push_i(Register r = r0);
 142   void push_l(Register r = r0);
 143   void push_f(FloatRegister r = v0);
 144   void push_d(FloatRegister r = v0);
 145 
 146   void pop(Register r ) { ((MacroAssembler*)this)->pop(r); }
 147 
 148   void push(Register r ) { ((MacroAssembler*)this)->push(r); }
 149 
 150   void pop(TosState state); // transition vtos -> state
 151   void push(TosState state); // transition state -> vtos
 152 
 153   void pop(RegSet regs, Register stack) { ((MacroAssembler*)this)->pop(regs, stack); }
 154   void push(RegSet regs, Register stack) { ((MacroAssembler*)this)->push(regs, stack); }
 155 
 156   void empty_expression_stack() {
 157     ldr(esp, Address(rfp, frame::interpreter_frame_monitor_block_top_offset * wordSize));
 158     // NULL last_sp until next java call
 159     str(zr, Address(rfp, frame::interpreter_frame_last_sp_offset * wordSize));
 160   }
 161 
 162   // Helpers for swap and dup
 163   void load_ptr(int n, Register val);
 164   void store_ptr(int n, Register val);
 165 
 166   // Generate a subtype check: branch to ok_is_subtype if sub_klass is
 167   // a subtype of super_klass.
 168   void gen_subtype_check( Register sub_klass, Label &ok_is_subtype );
 169 
 170   // Dispatching
 171   void dispatch_prolog(TosState state, int step = 0);
 172   void dispatch_epilog(TosState state, int step = 0);
 173   // dispatch via rscratch1
 174   void dispatch_only(TosState state);
 175   // dispatch normal table via rscratch1 (assume rscratch1 is loaded already)
 176   void dispatch_only_normal(TosState state);
 177   void dispatch_only_noverify(TosState state);
 178   // load rscratch1 from [rbcp + step] and dispatch via rscratch1
 179   void dispatch_next(TosState state, int step = 0);
 180   // load rscratch1 from [esi] and dispatch via rscratch1 and table
 181   void dispatch_via (TosState state, address* table);
 182 
 183   // jump to an invoked target
 184   void prepare_to_jump_from_interpreted();
 185   void jump_from_interpreted(Register method, Register temp);
 186 
 187 
 188   // Returning from interpreted functions
 189   //
 190   // Removes the current activation (incl. unlocking of monitors)
 191   // and sets up the return address.  This code is also used for
 192   // exception unwindwing. In that case, we do not want to throw
 193   // IllegalMonitorStateExceptions, since that might get us into an
 194   // infinite rethrow exception loop.
 195   // Additionally this code is used for popFrame and earlyReturn.
 196   // In popFrame case we want to skip throwing an exception,
 197   // installing an exception, and notifying jvmdi.
 198   // In earlyReturn case we only want to skip throwing an exception
 199   // and installing an exception.
 200   void remove_activation(TosState state,
 201                          bool throw_monitor_exception = true,
 202                          bool install_monitor_exception = true,
 203                          bool notify_jvmdi = true);
 204 #endif // CC_INTERP
 205 
 206   // FIXME: Give us a valid frame at a null check.
 207   virtual void null_check(Register reg, int offset = -1) {
 208 // #ifdef ASSERT
 209 //     save_bcp();
 210 //     set_last_Java_frame(esp, rfp, (address) pc());
 211 // #endif
 212     MacroAssembler::null_check(reg, offset);
 213 // #ifdef ASSERT
 214 //     reset_last_Java_frame(true);
 215 // #endif
 216   }
 217 
 218   // Object locking
 219   void lock_object  (Register lock_reg);
 220   void unlock_object(Register lock_reg);
 221 
 222 #ifndef CC_INTERP
 223 
 224   // Interpreter profiling operations
 225   void set_method_data_pointer_for_bcp();
 226   void test_method_data_pointer(Register mdp, Label& zero_continue);
 227   void verify_method_data_pointer();
 228 
 229   void set_mdp_data_at(Register mdp_in, int constant, Register value);
 230   void increment_mdp_data_at(Address data, bool decrement = false);
 231   void increment_mdp_data_at(Register mdp_in, int constant,
 232                              bool decrement = false);
 233   void increment_mdp_data_at(Register mdp_in, Register reg, int constant,
 234                              bool decrement = false);
 235   void increment_mask_and_jump(Address counter_addr,
 236                                int increment, int mask,
 237                                Register scratch, Register scratch2,
 238                                bool preloaded,
 239                                Condition cond, Label* where);
 240   void set_mdp_flag_at(Register mdp_in, int flag_constant);
 241   void test_mdp_data_at(Register mdp_in, int offset, Register value,
 242                         Register test_value_out,
 243                         Label& not_equal_continue);
 244 
 245   void record_klass_in_profile(Register receiver, Register mdp,
 246                                Register reg2, bool is_virtual_call);
 247   void record_klass_in_profile_helper(Register receiver, Register mdp,
 248                                       Register reg2, int start_row,
 249                                       Label& done, bool is_virtual_call);
 250 
 251   void update_mdp_by_offset(Register mdp_in, int offset_of_offset);
 252   void update_mdp_by_offset(Register mdp_in, Register reg, int offset_of_disp);
 253   void update_mdp_by_constant(Register mdp_in, int constant);
 254   void update_mdp_for_ret(Register return_bci);
 255 
 256   // narrow int return value
 257   void narrow(Register result);
 258 
 259   void profile_taken_branch(Register mdp, Register bumped_count);
 260   void profile_not_taken_branch(Register mdp);
 261   void profile_call(Register mdp);
 262   void profile_final_call(Register mdp);
 263   void profile_virtual_call(Register receiver, Register mdp,
 264                             Register scratch2,
 265                             bool receiver_can_be_null = false);
 266   void profile_ret(Register return_bci, Register mdp);
 267   void profile_null_seen(Register mdp);
 268   void profile_typecheck(Register mdp, Register klass, Register scratch);
 269   void profile_typecheck_failed(Register mdp);
 270   void profile_switch_default(Register mdp);
 271   void profile_switch_case(Register index_in_scratch, Register mdp,
 272                            Register scratch2);
 273 
 274   void profile_obj_type(Register obj, const Address& mdo_addr);
 275   void profile_arguments_type(Register mdp, Register callee, Register tmp, bool is_virtual);
 276   void profile_return_type(Register mdp, Register ret, Register tmp);
 277   void profile_parameters_type(Register mdp, Register tmp1, Register tmp2);
 278 
 279   // Debugging
 280   // only if +VerifyOops && state == atos
 281   void verify_oop(Register reg, TosState state = atos);
 282   // only if +VerifyFPU  && (state == ftos || state == dtos)
 283   void verify_FPU(int stack_depth, TosState state = ftos);
 284 
 285 #endif // !CC_INTERP
 286 
 287   typedef enum { NotifyJVMTI, SkipNotifyJVMTI } NotifyMethodExitMode;
 288 
 289   // support for jvmti/dtrace
 290   void notify_method_entry();
 291   void notify_method_exit(TosState state, NotifyMethodExitMode mode);
 292 
 293   virtual void _call_Unimplemented(address call_site) {
 294     save_bcp();
 295     set_last_Java_frame(esp, rfp, (address) pc(), rscratch1);
 296     MacroAssembler::_call_Unimplemented(call_site);
 297   }
 298 };
 299 
 300 #endif // CPU_AARCH64_VM_INTERP_MASM_AARCH64_64_HPP