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