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