1 /*
   2  * Copyright (c) 1997, 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_32_HPP
  26 #define CPU_X86_VM_INTERP_MASM_X86_32_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(
  41     address entry_point,
  42     int     number_of_arguments
  43   );
  44 
  45   virtual void call_VM_base(
  46     Register oop_result,
  47     Register java_thread,
  48     Register last_java_sp,
  49     address  entry_point,
  50     int      number_of_arguments,
  51     bool     check_exceptions
  52   );
  53 
  54   virtual void check_and_handle_popframe(Register java_thread);
  55   virtual void check_and_handle_earlyret(Register java_thread);
  56 
  57   // base routine for all dispatches
  58   void dispatch_base(TosState state, address* table, bool verifyoop = true);
  59 #endif /* CC_INTERP */
  60 
  61  public:
  62   InterpreterMacroAssembler(CodeBuffer* code) : MacroAssembler(code) {}
  63 
  64   void load_earlyret_value(TosState state);
  65 
  66   // Interpreter-specific registers
  67 #ifdef CC_INTERP
  68   void save_bcp()                                          { /*  not needed in c++ interpreter and harmless */ }
  69   void restore_bcp()                                       { /*  not needed in c++ interpreter and harmless */ }
  70 
  71   // Helpers for runtime call arguments/results
  72   void get_method(Register reg);
  73 
  74 #else
  75 
  76   void save_bcp()                                          { movptr(Address(rbp, frame::interpreter_frame_bcx_offset * wordSize), rsi); }
  77   void restore_bcp()                                       { movptr(rsi, Address(rbp, frame::interpreter_frame_bcx_offset * wordSize)); }
  78   void restore_locals()                                    { movptr(rdi, Address(rbp, frame::interpreter_frame_locals_offset * wordSize)); }
  79 
  80   // Helpers for runtime call arguments/results
  81   void get_method(Register reg)                            { movptr(reg, Address(rbp, frame::interpreter_frame_method_offset * wordSize)); }
  82   void get_const(Register reg)                             { get_method(reg); movptr(reg, Address(reg, Method::const_offset())); }
  83   void get_constant_pool(Register reg)                     { get_const(reg); movptr(reg, Address(reg, ConstMethod::constants_offset())); }
  84   void get_constant_pool_cache(Register reg)               { get_constant_pool(reg); movptr(reg, Address(reg, ConstantPool::cache_offset_in_bytes())); }
  85   void get_cpool_and_tags(Register cpool, Register tags)   { get_constant_pool(cpool); movptr(tags, Address(cpool, ConstantPool::tags_offset_in_bytes()));
  86   }
  87   void get_unsigned_2_byte_index_at_bcp(Register reg, int bcp_offset);
  88   void get_cache_and_index_at_bcp(Register cache, Register index, int bcp_offset, size_t index_size = sizeof(u2));
  89   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));
  90   void get_cache_entry_pointer_at_bcp(Register cache, Register tmp, int bcp_offset, size_t index_size = sizeof(u2));
  91   void get_cache_index_at_bcp(Register index, int bcp_offset, size_t index_size = sizeof(u2));
  92   void get_method_counters(Register method, Register mcs, Label& skip);
  93 
  94   // load cpool->resolved_references(index);
  95   void load_resolved_reference_at_index(Register result, Register index);
  96 
  97   // Expression stack
  98   void f2ieee();                                           // truncate ftos to 32bits
  99   void d2ieee();                                           // truncate dtos to 64bits
 100 
 101   void pop_ptr(Register r = rax);
 102   void pop_i(Register r = rax);
 103   void pop_l(Register lo = rax, Register hi = rdx);
 104   void pop_f();
 105   void pop_d();
 106 
 107   void push_ptr(Register r = rax);
 108   void push_i(Register r = rax);
 109   void push_l(Register lo = rax, Register hi = rdx);
 110   void push_d(Register r = rax);
 111   void push_f();
 112 
 113   void pop(TosState state);        // transition vtos -> state
 114   void push(TosState state);       // transition state -> vtos
 115 
 116   void pop(Register r ) { ((MacroAssembler*)this)->pop(r); }
 117 
 118   void push(Register r ) { ((MacroAssembler*)this)->push(r); }
 119   void push(int32_t imm ) { ((MacroAssembler*)this)->push(imm); }
 120 
 121   // These are dummies to prevent surprise implicit conversions to Register
 122   void pop(void* v ); // Add unimplemented ambiguous method
 123   void push(void* v );   // Add unimplemented ambiguous method
 124 
 125   void empty_expression_stack() {
 126     movptr(rsp, Address(rbp, frame::interpreter_frame_monitor_block_top_offset * wordSize));
 127     // NULL last_sp until next java call
 128     movptr(Address(rbp, frame::interpreter_frame_last_sp_offset * wordSize), NULL_WORD);
 129   }
 130 
 131   // Helpers for swap and dup
 132   void load_ptr(int n, Register val);
 133   void store_ptr(int n, Register val);
 134 
 135   // Generate a subtype check: branch to ok_is_subtype if sub_klass is
 136   // a subtype of super_klass.  EAX holds the super_klass.  Blows ECX
 137   // and EDI.  Register sub_klass cannot be any of the above.
 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   void dispatch_only(TosState state);                      // dispatch via rbx, (assume rbx, is loaded already)
 144   void dispatch_only_normal(TosState state);               // dispatch normal table via rbx, (assume rbx, is loaded already)
 145   void dispatch_only_noverify(TosState state);
 146   void dispatch_next(TosState state, int step = 0);        // load rbx, from [esi + step] and dispatch via rbx,
 147   void dispatch_via (TosState state, address* table);      // load rbx, from [esi] and dispatch via rbx, and table
 148 
 149 
 150   // jump to an invoked target
 151   void prepare_to_jump_from_interpreted();
 152   void jump_from_interpreted(Register method, Register temp);
 153 
 154   // Returning from interpreted functions
 155   //
 156   // Removes the current activation (incl. unlocking of monitors)
 157   // and sets up the return address.  This code is also used for
 158   // exception unwindwing. In that case, we do not want to throw
 159   // IllegalMonitorStateExceptions, since that might get us into an
 160   // infinite rethrow exception loop.
 161   // Additionally this code is used for popFrame and earlyReturn.
 162   // In popFrame case we want to skip throwing an exception,
 163   // installing an exception, and notifying jvmdi.
 164   // In earlyReturn case we only want to skip throwing an exception
 165   // and installing an exception.
 166   void remove_activation(TosState state, Register ret_addr,
 167                          bool throw_monitor_exception = true,
 168                          bool install_monitor_exception = true,
 169                          bool notify_jvmdi = true);
 170 #endif /* !CC_INTERP */
 171 
 172   // Debugging
 173   void verify_oop(Register reg, TosState state = atos);    // only if +VerifyOops && state == atos
 174 #ifndef CC_INTERP
 175   void verify_FPU(int stack_depth, TosState state = ftos); // only if +VerifyFPU  && (state == ftos || state == dtos)
 176 
 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_obj_type(Register obj, const Address& mdo_addr);
 219   void profile_arguments_type(Register mdp, Register callee, Register tmp, bool is_virtual);
 220   void profile_return_type(Register mdp, Register ret, Register tmp);
 221   void profile_parameters_type(Register mdp, Register tmp1, Register tmp2);
 222   void profile_call(Register mdp);
 223   void profile_final_call(Register mdp);
 224   void profile_virtual_call(Register receiver, Register mdp, Register scratch2,
 225                             bool receiver_can_be_null = false);
 226   void profile_ret(Register return_bci, Register mdp);
 227   void profile_null_seen(Register mdp);
 228   void profile_typecheck(Register mdp, Register klass, Register scratch);
 229   void profile_typecheck_failed(Register mdp);
 230   void profile_switch_default(Register mdp);
 231   void profile_switch_case(Register index_in_scratch, Register mdp, Register scratch2);
 232 
 233 #endif /* !CC_INTERP */
 234 
 235   typedef enum { NotifyJVMTI, SkipNotifyJVMTI } NotifyMethodExitMode;
 236 
 237   // support for jvmti
 238   void notify_method_entry();
 239   void notify_method_exit(TosState state, NotifyMethodExitMode mode);
 240 
 241 };
 242 
 243 #endif // CPU_X86_VM_INTERP_MASM_X86_32_HPP