1 /*
   2  * Copyright (c) 2003, 2011, Oracle and/or its affiliates. All rights reserved.
   3  * Copyright (c) 2014, 2015, Red Hat Inc. All rights reserved.
   4  * Copyright (c) 2015, Linaro Ltd. All rights reserved.
   5  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   6  *
   7  * This code is free software; you can redistribute it and/or modify it
   8  * under the terms of the GNU General Public License version 2 only, as
   9  * published by the Free Software Foundation.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  *
  25  */
  26 
  27 #ifndef CPU_AARCH32_VM_INTERP_MASM_AARCH32_64_HPP
  28 #define CPU_AARCH32_VM_INTERP_MASM_AARCH32_64_HPP
  29 
  30 #include "asm/macroAssembler.hpp"
  31 #include "asm/macroAssembler.inline.hpp"
  32 #include "interpreter/invocationCounter.hpp"
  33 #include "runtime/frame.hpp"
  34 
  35 // This file specializes the assember with interpreter-specific macros
  36 
  37 
  38 class InterpreterMacroAssembler: public MacroAssembler {
  39 #ifndef CC_INTERP
  40  protected:
  41   // Interpreter specific version of call_VM_base
  42   using MacroAssembler::call_VM_leaf_base;
  43 
  44  public:
  45   virtual void call_VM_leaf_base(address entry_point,
  46                                  int number_of_arguments,
  47                                  Label *retaddr = NULL);
  48  protected:
  49   virtual void call_VM_base(Register oop_result,
  50                             Register java_thread,
  51                             Register last_java_sp,
  52                             address  entry_point,
  53                             int number_of_arguments,
  54                             bool check_exceptions);
  55 
  56   virtual void check_and_handle_popframe(Register java_thread);
  57   virtual void check_and_handle_earlyret(Register java_thread);
  58 
  59   // base routine for all dispatches
  60   void dispatch_base(TosState state, address* table, bool verifyoop = true);
  61 #endif // CC_INTERP
  62 
  63  public:
  64   InterpreterMacroAssembler(CodeBuffer* code) : MacroAssembler(code) {}
  65 
  66   void load_earlyret_value(TosState state);
  67 
  68 #ifdef CC_INTERP
  69   void save_bcp()                                          { /*  not needed in c++ interpreter and harmless */ }
  70   void restore_bcp()                                       { /*  not needed in c++ interpreter and harmless */ }
  71 
  72   // Helpers for runtime call arguments/results
  73   void get_method(Register reg);
  74 
  75 #else
  76 
  77   // Interpreter-specific registers
  78 
  79   void save_bcp() {
  80     str(rbcp, Address(rfp, frame::interpreter_frame_bcx_offset * wordSize));
  81   }
  82 
  83   void restore_bcp() {
  84     ldr(rbcp, Address(rfp, frame::interpreter_frame_bcx_offset * wordSize));
  85   }
  86 
  87   void restore_locals() {
  88     ldr(rlocals, Address(rfp, frame::interpreter_frame_locals_offset * wordSize));
  89   }
  90 
  91   void restore_constant_pool_cache() {
  92     ldr(rcpool, Address(rfp, frame::interpreter_frame_cache_offset * wordSize));
  93   }
  94 
  95   void get_dispatch();
  96 
  97   // Helpers for runtime call arguments/results
  98 
  99   void get_method(Register reg) {
 100     ldr(reg, Address(rfp, frame::interpreter_frame_method_offset * wordSize));
 101   }
 102 
 103   void get_const(Register reg) {
 104     get_method(reg);
 105     ldr(reg, Address(reg, in_bytes(Method::const_offset())));
 106   }
 107 
 108   void get_constant_pool(Register reg) {
 109     get_const(reg);
 110     ldr(reg, Address(reg, in_bytes(ConstMethod::constants_offset())));
 111   }
 112 
 113   void get_constant_pool_cache(Register reg) {
 114     get_constant_pool(reg);
 115     ldr(reg, Address(reg, ConstantPool::cache_offset_in_bytes()));
 116   }
 117 
 118   void get_cpool_and_tags(Register cpool, Register tags) {
 119     get_constant_pool(cpool);
 120     ldr(tags, Address(cpool, ConstantPool::tags_offset_in_bytes()));
 121   }
 122 
 123   void get_unsigned_2_byte_index_at_bcp(Register reg, int bcp_offset);
 124   void get_cache_and_index_at_bcp(Register cache, Register index, int bcp_offset, size_t index_size = sizeof(u2));
 125   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));
 126   void get_cache_entry_pointer_at_bcp(Register cache, Register tmp, int bcp_offset, size_t index_size = sizeof(u2));
 127   void get_cache_index_at_bcp(Register index, int bcp_offset, size_t index_size = sizeof(u2));
 128   void get_method_counters(Register method, Register mcs, Label& skip);
 129 
 130   // load cpool->resolved_references(index);
 131   void load_resolved_reference_at_index(Register result, Register index);
 132 
 133   void pop_ptr(Register r = r0);
 134   void pop_i(Register r = r0);
 135   void pop_l(Register rLo = r0, Register rHi = r1);
 136   void pop_f(FloatRegister r = d0);
 137   void pop_d(FloatRegister r = d0);
 138   void push_ptr(Register r = r0);
 139   void push_i(Register r = r0);
 140   void push_l(Register rLo = r0, Register rHi = r1);
 141   void push_f(FloatRegister r = d0);
 142   void push_d(FloatRegister r = d0);
 143 
 144   void pop(Register r ) { ((MacroAssembler*)this)->pop(r); }
 145 
 146   void push(Register r ) { ((MacroAssembler*)this)->push(r); }
 147 
 148   void pop(TosState state); // transition vtos -> state
 149   void push(TosState state); // transition state -> vtos
 150 
 151   void pop(RegSet regs, Register stack) { ((MacroAssembler*)this)->pop(regs, stack); }
 152   void push(RegSet regs, Register stack) { ((MacroAssembler*)this)->push(regs, stack); }
 153 
 154   void empty_expression_stack() {
 155     ldr(sp, Address(rfp, frame::interpreter_frame_monitor_block_top_offset * wordSize));
 156     // NULL last_sp until next java call
 157     mov(rscratch1, 0);
 158     str(rscratch1, Address(rfp, frame::interpreter_frame_last_sp_offset * wordSize));
 159   }
 160 
 161   // Helpers for swap and dup
 162   void load_ptr(int n, Register val);
 163   void store_ptr(int n, Register val);
 164 
 165   // Generate a subtype check: branch to ok_is_subtype if sub_klass is
 166   // a subtype of super_klass.
 167   void gen_subtype_check( Register sub_klass, Label &ok_is_subtype );
 168 
 169   // Dispatching
 170   void dispatch_prolog(TosState state, int step = 0);
 171   void dispatch_epilog(TosState state, int step = 0);
 172   // dispatch via rscratch1
 173   void dispatch_only(TosState state);
 174   // dispatch normal table via rscratch1 (assume rscratch1 is loaded already)
 175   void dispatch_only_normal(TosState state);
 176   void dispatch_only_noverify(TosState state);
 177   // load rscratch1 from [rbcp + step] and dispatch via rscratch1
 178   void dispatch_next(TosState state, int step = 0);
 179   // load rscratch1 from [esi] and dispatch via rscratch1 and table
 180   void dispatch_via (TosState state, address* table);
 181 
 182   // jump to an invoked target
 183   void prepare_to_jump_from_interpreted();
 184   void jump_from_interpreted(Register method, Register temp);
 185 
 186 
 187   // Returning from interpreted functions
 188   //
 189   // Removes the current activation (incl. unlocking of monitors)
 190   // and sets up the return address.  This code is also used for
 191   // exception unwindwing. In that case, we do not want to throw
 192   // IllegalMonitorStateExceptions, since that might get us into an
 193   // infinite rethrow exception loop.
 194   // Additionally this code is used for popFrame and earlyReturn.
 195   // In popFrame case we want to skip throwing an exception,
 196   // installing an exception, and notifying jvmdi.
 197   // In earlyReturn case we only want to skip throwing an exception
 198   // and installing an exception.
 199   void remove_activation(TosState state,
 200                          bool throw_monitor_exception = true,
 201                          bool install_monitor_exception = true,
 202                          bool notify_jvmdi = true);
 203 #endif // CC_INTERP
 204 
 205   // FIXME: Give us a valid frame at a null check.
 206   virtual void null_check(Register reg, int offset = -1) {
 207 // #ifdef ASSERT
 208 //     save_bcp();
 209 //     set_last_Java_frame(sp, rfp, (address) pc());
 210 // #endif
 211     MacroAssembler::null_check(reg, offset);
 212 // #ifdef ASSERT
 213 //     reset_last_Java_frame(true);
 214 // #endif
 215   }
 216 
 217   // Object locking
 218   void lock_object  (Register lock_reg);
 219   void unlock_object(Register lock_reg);
 220 
 221 #ifndef CC_INTERP
 222 
 223   // Interpreter profiling operations
 224   void set_method_data_pointer_for_bcp();
 225   void test_method_data_pointer(Register mdp, Label& zero_continue);
 226   void verify_method_data_pointer();
 227 
 228   void set_mdp_data_at(Register mdp_in, int constant, Register value);
 229   void increment_mdp_data_at(Address data, bool decrement = false);
 230   void increment_mdp_data_at(Register mdp_in, int constant,
 231                              bool decrement = false);
 232   void increment_mdp_data_at(Register mdp_in, Register reg, int constant,
 233                              bool decrement = false);
 234   void increment_mask_and_jump(Address counter_addr,
 235                                int increment, int mask,
 236                                Register scratch, Register scratch2, bool preloaded,
 237                                Condition cond, Label* where);
 238   void set_mdp_flag_at(Register mdp_in, int flag_constant);
 239   void test_mdp_data_at(Register mdp_in, int offset, Register value,
 240                         Register test_value_out,
 241                         Label& not_equal_continue);
 242 
 243   void record_klass_in_profile(Register receiver, Register mdp,
 244                                Register reg2, bool is_virtual_call);
 245   void record_klass_in_profile_helper(Register receiver, Register mdp,
 246                                       Register reg2, int start_row,
 247                                       Label& done, bool is_virtual_call);
 248 
 249   void update_mdp_by_offset(Register mdp_in, int offset_of_offset);
 250   void update_mdp_by_offset(Register mdp_in, Register reg, int offset_of_disp);
 251   void update_mdp_by_constant(Register mdp_in, int constant);
 252   void update_mdp_for_ret(Register return_bci);
 253 
 254   // narrow int return value
 255   void narrow(Register result);
 256 
 257   void profile_taken_branch(Register mdp, Register bumped_count);
 258   void profile_not_taken_branch(Register mdp);
 259   void profile_call(Register mdp);
 260   void profile_final_call(Register mdp);
 261   void profile_virtual_call(Register receiver, Register mdp,
 262                             Register scratch2,
 263                             bool receiver_can_be_null = false);
 264   void profile_ret(Register return_bci, Register mdp);
 265   void profile_null_seen(Register mdp);
 266   void profile_typecheck(Register mdp, Register klass, Register scratch);
 267   void profile_typecheck_failed(Register mdp);
 268   void profile_switch_default(Register mdp);
 269   void profile_switch_case(Register index_in_scratch, Register mdp,
 270                            Register scratch2);
 271 
 272   void profile_obj_type(Register obj, const Address& mdo_addr);
 273   void profile_arguments_type(Register mdp, Register callee, Register tmp, bool is_virtual);
 274   void profile_return_type(Register mdp, Register ret, Register tmp);
 275   void profile_parameters_type(Register mdp, Register tmp1, Register tmp2);
 276 
 277   // Debugging
 278   // only if +VerifyOops && state == atos
 279   void verify_oop(Register reg, TosState state = atos);
 280   // only if +VerifyFPU  && (state == ftos || state == dtos)
 281   void verify_FPU(int stack_depth, TosState state = ftos);
 282 
 283 #endif // !CC_INTERP
 284 
 285   typedef enum { NotifyJVMTI, SkipNotifyJVMTI } NotifyMethodExitMode;
 286 
 287   // support for jvmti/dtrace
 288   void notify_method_entry();
 289   void notify_method_exit(TosState state, NotifyMethodExitMode mode);
 290 
 291   virtual void _call_Unimplemented(address call_site) {
 292     save_bcp();
 293     set_last_Java_frame(sp, rfp, (address) pc(), rscratch1);
 294     MacroAssembler::_call_Unimplemented(call_site);
 295   }
 296 };
 297 
 298 #endif // CPU_AARCH32_VM_INTERP_MASM_AARCH32_64_HPP