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