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