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