1 /*
   2  * Copyright (c) 1997, 2015, 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_HPP
  26 #define CPU_X86_VM_INTERP_MASM_X86_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 typedef ByteSize (*OffsetFunction)(uint);
  36 
  37 class InterpreterMacroAssembler: public MacroAssembler {
  38 
  39 #ifndef CC_INTERP
  40  protected:
  41   // Interpreter specific version of call_VM_base
  42   virtual void call_VM_leaf_base(address entry_point,
  43                                  int number_of_arguments);
  44 
  45   virtual void call_VM_base(Register oop_result,
  46                             Register java_thread,
  47                             Register last_java_sp,
  48                             address  entry_point,
  49                             int number_of_arguments,
  50                             bool check_exceptions);
  51 
  52   virtual void check_and_handle_popframe(Register java_thread);
  53   virtual void check_and_handle_earlyret(Register java_thread);
  54 
  55   // base routine for all dispatches
  56   void dispatch_base(TosState state, address* table, bool verifyoop = true);
  57 #endif // CC_INTERP
  58 
  59  public:
  60   InterpreterMacroAssembler(CodeBuffer* code) : MacroAssembler(code),
  61     _locals_register(LP64_ONLY(r14) NOT_LP64(rdi)),
  62     _bcp_register(LP64_ONLY(r13) NOT_LP64(rsi)) {}
  63 
  64   void load_earlyret_value(TosState state);
  65 
  66 #ifdef CC_INTERP
  67   void save_bcp()                                          { /*  not needed in c++ interpreter and harmless */ }
  68   void restore_bcp()                                       { /*  not needed in c++ interpreter and harmless */ }
  69 
  70   // Helpers for runtime call arguments/results
  71   void get_method(Register reg);
  72 
  73 #else
  74 
  75   // Interpreter-specific registers
  76   void save_bcp() {
  77     movptr(Address(rbp, frame::interpreter_frame_bcp_offset * wordSize), _bcp_register);
  78   }
  79 
  80   void restore_bcp() {
  81     movptr(_bcp_register, Address(rbp, frame::interpreter_frame_bcp_offset * wordSize));
  82   }
  83 
  84   void restore_locals() {
  85     movptr(_locals_register, Address(rbp, frame::interpreter_frame_locals_offset * wordSize));
  86   }
  87 
  88   // Helpers for runtime call arguments/results
  89   void get_method(Register reg) {
  90     movptr(reg, Address(rbp, frame::interpreter_frame_method_offset * wordSize));
  91   }
  92 
  93   void get_const(Register reg) {
  94     get_method(reg);
  95     movptr(reg, Address(reg, Method::const_offset()));
  96   }
  97 
  98   void get_constant_pool(Register reg) {
  99     get_const(reg);
 100     movptr(reg, Address(reg, ConstMethod::constants_offset()));
 101   }
 102 
 103   void get_constant_pool_cache(Register reg) {
 104     get_constant_pool(reg);
 105     movptr(reg, Address(reg, ConstantPool::cache_offset_in_bytes()));
 106   }
 107 
 108   void get_cpool_and_tags(Register cpool, Register tags) {
 109     get_constant_pool(cpool);
 110     movptr(tags, Address(cpool, ConstantPool::tags_offset_in_bytes()));
 111   }
 112 
 113   void get_unsigned_2_byte_index_at_bcp(Register reg, int bcp_offset);
 114   void get_cache_and_index_at_bcp(Register cache,
 115                                   Register index,
 116                                   int bcp_offset,
 117                                   size_t index_size = sizeof(u2));
 118   void get_cache_and_index_and_bytecode_at_bcp(Register cache,
 119                                                Register index,
 120                                                Register bytecode,
 121                                                int byte_no,
 122                                                int bcp_offset,
 123                                                size_t index_size = sizeof(u2));
 124   void get_cache_entry_pointer_at_bcp(Register cache,
 125                                       Register tmp,
 126                                       int bcp_offset,
 127                                       size_t index_size = sizeof(u2));
 128   void get_cache_index_at_bcp(Register index,
 129                               int bcp_offset,
 130                               size_t index_size = sizeof(u2));
 131 
 132   // load cpool->resolved_references(index);
 133   void load_resolved_reference_at_index(Register result, Register index);
 134 
 135   NOT_LP64(void f2ieee();)        // truncate ftos to 32bits
 136   NOT_LP64(void d2ieee();)        // truncate dtos to 64bits
 137 
 138   // Expression stack
 139   void pop_ptr(Register r = rax);
 140   void pop_i(Register r = rax);
 141   void push_ptr(Register r = rax);
 142   void push_i(Register r = rax);
 143 
 144   void push_f(XMMRegister r);
 145   void pop_f(XMMRegister r);
 146   void pop_d(XMMRegister r);
 147   void push_d(XMMRegister r);
 148 #ifdef _LP64
 149   void pop_l(Register r = rax);
 150   void push_l(Register r = rax);
 151 #else
 152   void pop_l(Register lo = rax, Register hi = rdx);
 153   void pop_f();
 154   void pop_d();
 155 
 156   void push_l(Register lo = rax, Register hi = rdx);
 157   void push_d();
 158   void push_f();
 159 #endif // _LP64
 160 
 161   void pop(Register r) { ((MacroAssembler*)this)->pop(r); }
 162   void push(Register r) { ((MacroAssembler*)this)->push(r); }
 163   void push(int32_t imm ) { ((MacroAssembler*)this)->push(imm); }
 164 
 165   void pop(TosState state);        // transition vtos -> state
 166   void push(TosState state);       // transition state -> vtos
 167 
 168   // These are dummies to prevent surprise implicit conversions to Register
 169   void pop(void* v); // Add unimplemented ambiguous method
 170   void push(void* v);   // Add unimplemented ambiguous method
 171 
 172   void empty_expression_stack() {
 173     movptr(rsp, Address(rbp, frame::interpreter_frame_monitor_block_top_offset * wordSize));
 174     // NULL last_sp until next java call
 175     movptr(Address(rbp, frame::interpreter_frame_last_sp_offset * wordSize), (int32_t)NULL_WORD);
 176   }
 177 
 178   // Helpers for swap and dup
 179   void load_ptr(int n, Register val);
 180   void store_ptr(int n, Register val);
 181 
 182   // Generate a subtype check: branch to ok_is_subtype if sub_klass is
 183   // a subtype of super_klass.
 184   void gen_subtype_check( Register sub_klass, Label &ok_is_subtype );
 185 
 186   // Dispatching
 187   void dispatch_prolog(TosState state, int step = 0);
 188   void dispatch_epilog(TosState state, int step = 0);
 189   // dispatch via rbx (assume rbx is loaded already)
 190   void dispatch_only(TosState state);
 191   // dispatch normal table via rbx (assume rbx is loaded already)
 192   void dispatch_only_normal(TosState state);
 193   void dispatch_only_noverify(TosState state);
 194   // load rbx from [_bcp_register + step] and dispatch via rbx
 195   void dispatch_next(TosState state, int step = 0);
 196   // load rbx from [_bcp_register] and dispatch via rbx and table
 197   void dispatch_via (TosState state, address* table);
 198 
 199   // jump to an invoked target
 200   void prepare_to_jump_from_interpreted();
 201   void jump_from_interpreted(Register method, Register temp);
 202 
 203   // Returning from interpreted functions
 204   //
 205   // Removes the current activation (incl. unlocking of monitors)
 206   // and sets up the return address.  This code is also used for
 207   // exception unwindwing. In that case, we do not want to throw
 208   // IllegalMonitorStateExceptions, since that might get us into an
 209   // infinite rethrow exception loop.
 210   // Additionally this code is used for popFrame and earlyReturn.
 211   // In popFrame case we want to skip throwing an exception,
 212   // installing an exception, and notifying jvmdi.
 213   // In earlyReturn case we only want to skip throwing an exception
 214   // and installing an exception.
 215   void remove_activation(TosState state, Register ret_addr,
 216                          bool throw_monitor_exception = true,
 217                          bool install_monitor_exception = true,
 218                          bool notify_jvmdi = true);
 219 #endif // CC_INTERP
 220   void get_method_counters(Register method, Register mcs, Label& skip);
 221 
 222   // Object locking
 223   void lock_object  (Register lock_reg);
 224   void unlock_object(Register lock_reg);
 225 
 226 #ifndef CC_INTERP
 227 
 228   // Interpreter profiling operations
 229   void set_method_data_pointer_for_bcp();
 230   void test_method_data_pointer(Register mdp, Label& zero_continue);
 231   void verify_method_data_pointer();
 232 
 233   void set_mdp_data_at(Register mdp_in, int constant, Register value);
 234   void increment_mdp_data_at(Address data, bool decrement = false);
 235   void increment_mdp_data_at(Register mdp_in, int constant,
 236                              bool decrement = false);
 237   void increment_mdp_data_at(Register mdp_in, Register reg, int constant,
 238                              bool decrement = false);
 239   void increment_mask_and_jump(Address counter_addr,
 240                                int increment, Address mask,
 241                                Register scratch, bool preloaded,
 242                                Condition cond, Label* where);
 243   void set_mdp_flag_at(Register mdp_in, int flag_constant);
 244   void test_mdp_data_at(Register mdp_in, int offset, Register value,
 245                         Register test_value_out,
 246                         Label& not_equal_continue);
 247 
 248   void record_klass_in_profile(Register receiver, Register mdp,
 249                                Register reg2, bool is_virtual_call);
 250   void record_klass_in_profile_helper(Register receiver, Register mdp,
 251                                       Register reg2, int start_row,
 252                                       Label& done, bool is_virtual_call);
 253   void record_item_in_profile_helper(Register item, Register mdp,
 254                                      Register reg2, int start_row, Label& done, int total_rows,
 255                                      OffsetFunction item_offset_fn, OffsetFunction item_count_offset_fn,
 256                                      int non_profiled_offset);
 257 
 258   void update_mdp_by_offset(Register mdp_in, int offset_of_offset);
 259   void update_mdp_by_offset(Register mdp_in, Register reg, int offset_of_disp);
 260   void update_mdp_by_constant(Register mdp_in, int constant);
 261   void update_mdp_for_ret(Register return_bci);
 262 
 263   void profile_taken_branch(Register mdp, Register bumped_count);
 264   void profile_not_taken_branch(Register mdp);
 265   void profile_call(Register mdp);
 266   void profile_final_call(Register mdp);
 267   void profile_virtual_call(Register receiver, Register mdp,
 268                             Register scratch2,
 269                             bool receiver_can_be_null = false);
 270 #if INCLUDE_JVMCI
 271   void profile_called_method(Register method, Register mdp, Register reg2);
 272 #endif
 273   void profile_ret(Register return_bci, Register mdp);
 274   void profile_null_seen(Register mdp);
 275   void profile_typecheck(Register mdp, Register klass, Register scratch);
 276   void profile_typecheck_failed(Register mdp);
 277   void profile_switch_default(Register mdp);
 278   void profile_switch_case(Register index_in_scratch, Register mdp,
 279                            Register scratch2);
 280 
 281   // Debugging
 282   // only if +VerifyOops && state == atos
 283   void verify_oop(Register reg, TosState state = atos);
 284   // only if +VerifyFPU  && (state == ftos || state == dtos)
 285   void verify_FPU(int stack_depth, TosState state = ftos);
 286 
 287 #endif // !CC_INTERP
 288 
 289   typedef enum { NotifyJVMTI, SkipNotifyJVMTI } NotifyMethodExitMode;
 290 
 291   // support for jvmti/dtrace
 292   void notify_method_entry();
 293   void notify_method_exit(TosState state, NotifyMethodExitMode mode);
 294 
 295  private:
 296 
 297   Register _locals_register; // register that contains the pointer to the locals
 298   Register _bcp_register; // register that contains the bcp
 299 
 300  public:
 301 #ifndef CC_INTERP
 302   void profile_obj_type(Register obj, const Address& mdo_addr);
 303   void profile_arguments_type(Register mdp, Register callee, Register tmp, bool is_virtual);
 304   void profile_return_type(Register mdp, Register ret, Register tmp);
 305   void profile_parameters_type(Register mdp, Register tmp1, Register tmp2);
 306 #endif /* !CC_INTERP */
 307 
 308 };
 309 
 310 #endif // CPU_X86_VM_INTERP_MASM_X86_HPP