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