1 /*
   2  * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  *
  23  */
  24 
  25 #ifndef CPU_X86_VM_INTERP_MASM_X86_64_HPP
  26 #define CPU_X86_VM_INTERP_MASM_X86_64_HPP
  27 
  28 #include "asm/macroAssembler.hpp"
  29 #include "asm/macroAssembler.inline.hpp"
  30 #include "interpreter/invocationCounter.hpp"
  31 #include "runtime/frame.hpp"
  32 
  33 // This file specializes the assember with interpreter-specific macros
  34 
  35 
  36 class InterpreterMacroAssembler: public MacroAssembler {
  37 #ifndef CC_INTERP
  38  protected:
  39   // Interpreter specific version of call_VM_base
  40   virtual void call_VM_leaf_base(address entry_point,
  41                                  int number_of_arguments);
  42 
  43   virtual void call_VM_base(Register oop_result,
  44                             Register java_thread,
  45                             Register last_java_sp,
  46                             address  entry_point,
  47                             int number_of_arguments,
  48                             bool check_exceptions);
  49 
  50   virtual void check_and_handle_popframe(Register java_thread);
  51   virtual void check_and_handle_earlyret(Register java_thread);
  52 
  53   // base routine for all dispatches
  54   void dispatch_base(TosState state, address* table, bool verifyoop = true);
  55 #endif // CC_INTERP
  56 
  57  public:
  58   InterpreterMacroAssembler(CodeBuffer* code) : MacroAssembler(code) {}
  59 
  60   void load_earlyret_value(TosState state);
  61 
  62 #ifdef CC_INTERP
  63   void save_bcp()                                          { /*  not needed in c++ interpreter and harmless */ }
  64   void restore_bcp()                                       { /*  not needed in c++ interpreter and harmless */ }
  65 
  66   // Helpers for runtime call arguments/results
  67   void get_method(Register reg);
  68 
  69 #else
  70 
  71   // Interpreter-specific registers
  72   void save_bcp() {
  73     movptr(Address(rbp, frame::interpreter_frame_bcx_offset * wordSize), r13);
  74   }
  75 
  76   void restore_bcp() {
  77     movptr(r13, Address(rbp, frame::interpreter_frame_bcx_offset * wordSize));
  78   }
  79 
  80   void restore_locals() {
  81     movptr(r14, Address(rbp, frame::interpreter_frame_locals_offset * wordSize));
  82   }
  83 
  84   // Helpers for runtime call arguments/results
  85   void get_method(Register reg) {
  86     movptr(reg, Address(rbp, frame::interpreter_frame_method_offset * wordSize));
  87   }
  88 
  89   void get_const(Register reg) {
  90     get_method(reg);
  91     movptr(reg, Address(reg, Method::const_offset()));
  92   }
  93 
  94   void get_constant_pool(Register reg) {
  95     get_const(reg);
  96     movptr(reg, Address(reg, ConstMethod::constants_offset()));
  97   }
  98 
  99   void get_constant_pool_cache(Register reg) {
 100     get_constant_pool(reg);
 101     movptr(reg, Address(reg, ConstantPool::cache_offset_in_bytes()));
 102   }
 103 
 104   void get_cpool_and_tags(Register cpool, Register tags) {
 105     get_constant_pool(cpool);
 106     movptr(tags, Address(cpool, ConstantPool::tags_offset_in_bytes()));
 107   }
 108 
 109   void get_unsigned_2_byte_index_at_bcp(Register reg, int bcp_offset);
 110   void get_cache_and_index_at_bcp(Register cache, Register index, int bcp_offset, size_t index_size = sizeof(u2));
 111   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));
 112   void get_cache_entry_pointer_at_bcp(Register cache, Register tmp, int bcp_offset, size_t index_size = sizeof(u2));
 113   void get_cache_index_at_bcp(Register index, int bcp_offset, size_t index_size = sizeof(u2));
 114   void get_method_counters(Register method, Register mcs, Label& skip);
 115 
 116   // load cpool->resolved_references(index);
 117   void load_resolved_reference_at_index(Register result, Register index);
 118 
 119   void pop_ptr(Register r = rax);
 120   void pop_i(Register r = rax);
 121   void pop_l(Register r = rax);
 122   void pop_f(XMMRegister r = xmm0);
 123   void pop_d(XMMRegister r = xmm0);
 124   void push_ptr(Register r = rax);
 125   void push_i(Register r = rax);
 126   void push_l(Register r = rax);
 127   void push_f(XMMRegister r = xmm0);
 128   void push_d(XMMRegister r = xmm0);
 129 
 130   void pop(Register r ) { ((MacroAssembler*)this)->pop(r); }
 131 
 132   void push(Register r ) { ((MacroAssembler*)this)->push(r); }
 133   void push(int32_t imm ) { ((MacroAssembler*)this)->push(imm); }
 134 
 135   void pop(TosState state); // transition vtos -> state
 136   void push(TosState state); // transition state -> vtos
 137 
 138   void empty_expression_stack() {
 139     movptr(rsp, Address(rbp, frame::interpreter_frame_monitor_block_top_offset * wordSize));
 140     // NULL last_sp until next java call
 141     movptr(Address(rbp, frame::interpreter_frame_last_sp_offset * wordSize), (int32_t)NULL_WORD);
 142   }
 143 
 144   // Helpers for swap and dup
 145   void load_ptr(int n, Register val);
 146   void store_ptr(int n, Register val);
 147 
 148   // Generate a subtype check: branch to ok_is_subtype if sub_klass is
 149   // a subtype of super_klass.
 150   void gen_subtype_check( Register sub_klass, Label &ok_is_subtype );
 151 
 152   // Dispatching
 153   void dispatch_prolog(TosState state, int step = 0);
 154   void dispatch_epilog(TosState state, int step = 0);
 155   // dispatch via ebx (assume ebx is loaded already)
 156   void dispatch_only(TosState state);
 157   // dispatch normal table via ebx (assume ebx is loaded already)
 158   void dispatch_only_normal(TosState state);
 159   void dispatch_only_noverify(TosState state);
 160   // load ebx from [esi + step] and dispatch via ebx
 161   void dispatch_next(TosState state, int step = 0);
 162   // load ebx from [esi] and dispatch via ebx and table
 163   void dispatch_via (TosState state, address* table);
 164 
 165   // jump to an invoked target
 166   void prepare_to_jump_from_interpreted();
 167   void jump_from_interpreted(Register method, Register temp);
 168 
 169 
 170   // Returning from interpreted functions
 171   //
 172   // Removes the current activation (incl. unlocking of monitors)
 173   // and sets up the return address.  This code is also used for
 174   // exception unwindwing. In that case, we do not want to throw
 175   // IllegalMonitorStateExceptions, since that might get us into an
 176   // infinite rethrow exception loop.
 177   // Additionally this code is used for popFrame and earlyReturn.
 178   // In popFrame case we want to skip throwing an exception,
 179   // installing an exception, and notifying jvmdi.
 180   // In earlyReturn case we only want to skip throwing an exception
 181   // and installing an exception.
 182   void remove_activation(TosState state, Register ret_addr,
 183                          bool throw_monitor_exception = true,
 184                          bool install_monitor_exception = true,
 185                          bool notify_jvmdi = true);
 186 #endif // CC_INTERP
 187 
 188   // Object locking
 189   void lock_object  (Register lock_reg);
 190   void unlock_object(Register lock_reg);
 191 
 192 #ifndef CC_INTERP
 193 
 194   // Interpreter profiling operations
 195   void set_method_data_pointer_for_bcp();
 196   void test_method_data_pointer(Register mdp, Label& zero_continue);
 197   void verify_method_data_pointer();
 198 
 199   void set_mdp_data_at(Register mdp_in, int constant, Register value);
 200   void increment_mdp_data_at(Address data, bool decrement = false);
 201   void increment_mdp_data_at(Register mdp_in, int constant,
 202                              bool decrement = false);
 203   void increment_mdp_data_at(Register mdp_in, Register reg, int constant,
 204                              bool decrement = false);
 205   void increment_mask_and_jump(Address counter_addr,
 206                                int increment, int mask,
 207                                Register scratch, bool preloaded,
 208                                Condition cond, Label* where);
 209   void set_mdp_flag_at(Register mdp_in, int flag_constant);
 210   void test_mdp_data_at(Register mdp_in, int offset, Register value,
 211                         Register test_value_out,
 212                         Label& not_equal_continue);
 213 
 214   void record_klass_in_profile(Register receiver, Register mdp,
 215                                Register reg2, bool is_virtual_call);
 216   void record_klass_in_profile_helper(Register receiver, Register mdp,
 217                                       Register reg2, int start_row,
 218                                       Label& done, bool is_virtual_call);
 219 
 220   void update_mdp_by_offset(Register mdp_in, int offset_of_offset);
 221   void update_mdp_by_offset(Register mdp_in, Register reg, int offset_of_disp);
 222   void update_mdp_by_constant(Register mdp_in, int constant);
 223   void update_mdp_for_ret(Register return_bci);
 224 
 225   void profile_taken_branch(Register mdp, Register bumped_count);
 226   void profile_not_taken_branch(Register mdp);
 227   void profile_obj_type(Register obj, const Address& mdo_addr);
 228   void profile_arguments_type(Register mdp, Register callee, Register tmp, bool is_virtual);
 229   void profile_call(Register mdp);
 230   void profile_final_call(Register mdp);
 231   void profile_virtual_call(Register receiver, Register mdp,
 232                             Register scratch2,
 233                             bool receiver_can_be_null = false);
 234   void profile_ret(Register return_bci, Register mdp);
 235   void profile_null_seen(Register mdp);
 236   void profile_typecheck(Register mdp, Register klass, Register scratch);
 237   void profile_typecheck_failed(Register mdp);
 238   void profile_switch_default(Register mdp);
 239   void profile_switch_case(Register index_in_scratch, Register mdp,
 240                            Register scratch2);
 241 
 242   // Debugging
 243   // only if +VerifyOops && state == atos
 244   void verify_oop(Register reg, TosState state = atos);
 245   // only if +VerifyFPU  && (state == ftos || state == dtos)
 246   void verify_FPU(int stack_depth, TosState state = ftos);
 247 
 248 #endif // !CC_INTERP
 249 
 250   typedef enum { NotifyJVMTI, SkipNotifyJVMTI } NotifyMethodExitMode;
 251 
 252   // support for jvmti/dtrace
 253   void notify_method_entry();
 254   void notify_method_exit(TosState state, NotifyMethodExitMode mode);
 255 };
 256 
 257 #endif // CPU_X86_VM_INTERP_MASM_X86_64_HPP