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_SPARC_VM_INTERP_MASM_SPARC_HPP
  26 #define CPU_SPARC_VM_INTERP_MASM_SPARC_HPP
  27 
  28 #include "asm/macroAssembler.inline.hpp"
  29 #include "interpreter/invocationCounter.hpp"
  30 
  31 // This file specializes the assember with interpreter-specific macros
  32 
  33 REGISTER_DECLARATION(     Register, Otos_i , O0); // tos for ints, etc
  34 REGISTER_DECLARATION(     Register, Otos_l , O0); // for longs
  35 REGISTER_DECLARATION(     Register, Otos_l1, O0); // for 1st part of longs
  36 REGISTER_DECLARATION(     Register, Otos_l2, O1); // for 2nd part of longs
  37 REGISTER_DECLARATION(FloatRegister, Ftos_f , F0); // for floats
  38 REGISTER_DECLARATION(FloatRegister, Ftos_d , F0); // for doubles
  39 REGISTER_DECLARATION(FloatRegister, Ftos_d1, F0); // for 1st part of double
  40 REGISTER_DECLARATION(FloatRegister, Ftos_d2, F1); // for 2nd part of double
  41 
  42 #ifndef DONT_USE_REGISTER_DEFINES
  43 #define Otos_i  O0
  44 #define Otos_l  O0
  45 #define Otos_l1 O0
  46 #define Otos_l2 O1
  47 #define Ftos_f  F0
  48 #define Ftos_d  F0
  49 #define Ftos_d1 F0
  50 #define Ftos_d2 F1
  51 #endif // DONT_USE_REGISTER_DEFINES
  52 
  53 class InterpreterMacroAssembler: public MacroAssembler {
  54  protected:
  55 #ifndef CC_INTERP
  56   // Interpreter specific version of call_VM_base
  57     virtual void call_VM_leaf_base(
  58     Register java_thread,
  59     address  entry_point,
  60     int      number_of_arguments
  61   );
  62 
  63   virtual void call_VM_base(
  64     Register        oop_result,
  65     Register        java_thread,
  66     Register        last_java_sp,
  67     address         entry_point,
  68     int             number_of_arguments,
  69     bool            check_exception=true
  70   );
  71 
  72   virtual void check_and_handle_popframe(Register java_thread);
  73   virtual void check_and_handle_earlyret(Register java_thread);
  74 
  75   // base routine for all dispatches
  76   void dispatch_base(TosState state, address* table);
  77 #endif /* CC_INTERP */
  78 
  79  public:
  80   InterpreterMacroAssembler(CodeBuffer* c)
  81     : MacroAssembler(c) {}
  82 
  83   void jump_to_entry(address entry);
  84 
  85 #ifndef CC_INTERP
  86   virtual void load_earlyret_value(TosState state);
  87 
  88   static const Address l_tmp ;
  89   static const Address d_tmp ;
  90 #endif /* CC_INTERP */
  91 
  92   // helper routine for frame allocation/deallocation
  93   // compute the delta by which the caller's SP has to
  94   // be adjusted to accomodate for the non-argument
  95   // locals
  96   void compute_extra_locals_size_in_bytes(Register args_size, Register locals_size, Register delta);
  97 
  98 #ifndef CC_INTERP
  99 
 100   // dispatch routines
 101   void dispatch_prolog(TosState state, int step = 0);
 102   void dispatch_epilog(TosState state, int step = 0);
 103   void dispatch_only(TosState state);
 104   void dispatch_normal(TosState state);
 105   void dispatch_next(TosState state, int step = 0);
 106   void dispatch_next_noverify_oop(TosState state, int step = 0);
 107   void dispatch_via (TosState state, address* table);
 108 
 109 
 110   // Removes the current activation (incl. unlocking of monitors).
 111   // Additionally this code is used for earlyReturn in which case we
 112   // want to skip throwing an exception and installing an exception.
 113   void remove_activation(TosState state,
 114                          bool throw_monitor_exception = true,
 115                          bool install_monitor_exception = true);
 116 
 117  protected:
 118   void dispatch_Lbyte_code(TosState state, address* table, int bcp_incr = 0, bool verify = true);
 119 #endif /* CC_INTERP */
 120 
 121  public:
 122   // Super call_VM calls - correspond to MacroAssembler::call_VM(_leaf) calls
 123   void super_call_VM(Register thread_cache,
 124                      Register oop_result,
 125                      Register last_java_sp,
 126                      address entry_point,
 127                      Register arg_1,
 128                      Register arg_2,
 129                      bool check_exception = true);
 130 
 131 #ifndef CC_INTERP
 132   void super_call_VM_leaf(Register thread_cache, address entry_point, Register arg_1, Register arg_2);
 133 
 134   // Generate a subtype check: branch to ok_is_subtype if sub_klass is
 135   // a subtype of super_klass.  Blows registers tmp1, tmp2 and tmp3.
 136   void gen_subtype_check( Register sub_klass, Register super_klass, Register tmp1, Register tmp2, Register tmp3, Label &ok_is_subtype );
 137 
 138   // helpers for tossing exceptions
 139   void throw_if_not_1_icc( Condition ok_condition, Label& ok );
 140   void throw_if_not_1_xcc( Condition ok_condition, Label& ok );
 141   void throw_if_not_1_x  ( Condition ok_condition, Label& ok ); // chooses icc or xcc based on _LP64
 142 
 143   void throw_if_not_2( address throw_entry_point, Register Rscratch, Label& ok);
 144 
 145   void throw_if_not_icc( Condition ok_condition, address throw_entry_point, Register Rscratch );
 146   void throw_if_not_xcc( Condition ok_condition, address throw_entry_point, Register Rscratch );
 147   void throw_if_not_x  ( Condition ok_condition, address throw_entry_point, Register Rscratch );
 148 
 149   // helpers for expression stack
 150 
 151   void pop_i(     Register r = Otos_i);
 152   void pop_ptr(   Register r = Otos_i, Register scratch = O4);
 153   void pop_l(     Register r = Otos_l1);
 154   // G4_scratch and Lscratch are used at call sites!!
 155   void pop_f(FloatRegister f = Ftos_f,  Register scratch = G1_scratch);
 156   void pop_d(FloatRegister f = Ftos_d1, Register scratch = G1_scratch);
 157 
 158   void push_i(     Register r = Otos_i);
 159   void push_ptr(   Register r = Otos_i);
 160   void push_l(     Register r = Otos_l1);
 161   void push_f(FloatRegister f = Ftos_f);
 162   void push_d(FloatRegister f = Ftos_d1);
 163 
 164 
 165   void pop (TosState state);           // transition vtos -> state
 166   void push(TosState state);           // transition state -> vtos
 167   void empty_expression_stack();       // resets both Lesp and SP
 168 
 169 #ifdef ASSERT
 170   void verify_sp(Register Rsp, Register Rtemp);
 171   void verify_esp(Register Resp);      // verify that Lesp points to a word in the temp stack
 172 #endif // ASSERT
 173 
 174  public:
 175   void if_cmp(Condition cc, bool ptr_compare);
 176 
 177   // Load values from bytecode stream:
 178 
 179   enum signedOrNot { Signed, Unsigned };
 180   enum setCCOrNot  { set_CC,  dont_set_CC };
 181 
 182   void get_2_byte_integer_at_bcp( int         bcp_offset,
 183                                   Register    Rtmp,
 184                                   Register    Rdst,
 185                                   signedOrNot is_signed,
 186                                   setCCOrNot  should_set_CC = dont_set_CC );
 187 
 188   void get_4_byte_integer_at_bcp( int        bcp_offset,
 189                                   Register   Rtmp,
 190                                   Register   Rdst,
 191                                   setCCOrNot should_set_CC = dont_set_CC );
 192 
 193   // Note: "get_cache_and_index" really means "get the index, use it to get the cache entry, and throw away the index".
 194   void get_cache_and_index_at_bcp(Register cache, Register tmp, int bcp_offset, size_t index_size = sizeof(u2));
 195   void get_cache_and_index_and_bytecode_at_bcp(Register cache, Register temp, Register bytecode, int byte_no, int bcp_offset, size_t index_size = sizeof(u2));
 196   void get_cache_entry_pointer_at_bcp(Register cache, Register tmp, int bcp_offset, size_t index_size = sizeof(u2));
 197   // Note: This one does not fetch the cache.  The first argument is a temp which may be killed.
 198   void get_cache_index_at_bcp(Register temp, Register index, int bcp_offset, size_t index_size = sizeof(u2));
 199 
 200   // load cpool->resolved_references(index);
 201   void load_resolved_reference_at_index(Register result, Register index);
 202 
 203   // common code
 204 
 205   void field_offset_at(int n, Register tmp, Register dest, Register base);
 206   int  field_offset_at(Register object, address bcp, int offset);
 207   void fast_iaaccess(int n, address bcp);
 208   void fast_iaputfield(address bcp, bool do_store_check );
 209 
 210   void index_check(Register array, Register index, int index_shift, Register tmp, Register res);
 211   void index_check_without_pop(Register array, Register index, int index_shift, Register tmp, Register res);
 212 
 213   void get_const(Register Rdst);
 214   void get_constant_pool(Register Rdst);
 215   void get_constant_pool_cache(Register Rdst);
 216   void get_cpool_and_tags(Register Rcpool, Register Rtags);
 217   void is_a(Label& L);
 218 
 219   // Load compiled (i2c) or interpreter entry and call from interpreted
 220   void call_from_interpreter(Register target, Register scratch, Register Rret);
 221 
 222   // --------------------------------------------------
 223 
 224   void unlock_if_synchronized_method(TosState state, bool throw_monitor_exception = true, bool install_monitor_exception = true);
 225 
 226   void add_monitor_to_stack( bool stack_is_empty,
 227                              Register Rtemp,
 228                              Register Rtemp2 );
 229 
 230   // Load/store aligned in _LP64 but unaligned otherwise
 231   // These only apply to the Interpreter expression stack and locals!
 232   void  load_unaligned_double(Register r1, int offset,  FloatRegister d);
 233   void store_unaligned_double(FloatRegister d, Register r1, int offset );
 234 
 235   // Load/store aligned in _LP64 but unaligned otherwise
 236   void  load_unaligned_long(Register r1, int offset,  Register d);
 237   void store_unaligned_long(Register d, Register r1, int offset );
 238 
 239   void access_local_int( Register index, Register dst );
 240   void access_local_ptr( Register index, Register dst );
 241   void access_local_returnAddress( Register index, Register dst );
 242   void access_local_long( Register index, Register dst );
 243   void access_local_float( Register index, FloatRegister dst );
 244   void access_local_double( Register index, FloatRegister dst );
 245 #ifdef ASSERT
 246   void check_for_regarea_stomp( Register Rindex, int offset, Register Rlimit, Register Rscratch, Register Rscratch1);
 247 #endif // ASSERT
 248   void store_local_int( Register index, Register src );
 249   void store_local_ptr( Register index, Register src );
 250   void store_local_ptr( int n, Register src );
 251   void store_local_long( Register index, Register src );
 252   void store_local_float( Register index, FloatRegister src );
 253   void store_local_double( Register index, FloatRegister src );
 254 
 255   // Helpers for swap and dup
 256   void load_ptr(int n, Register val);
 257   void store_ptr(int n, Register val);
 258 
 259   // Helper for getting receiver in register.
 260   void load_receiver(Register param_count, Register recv);
 261 
 262   static int top_most_monitor_byte_offset(); // offset in bytes to top of monitor block
 263   Address top_most_monitor();
 264   void compute_stack_base( Register Rdest );
 265 
 266 #endif /* CC_INTERP */
 267   void get_method_counters(Register method, Register Rcounters, Label& skip);
 268   void increment_invocation_counter( Register Rcounters, Register Rtmp, Register Rtmp2 );
 269   void increment_backedge_counter( Register Rcounters, Register Rtmp, Register Rtmp2 );
 270 #ifndef CC_INTERP
 271   void test_backedge_count_for_osr(Register backedge_count, Register method_counters, Register branch_bcp, Register Rtmp );
 272 
 273 #endif /* CC_INTERP */
 274   // Object locking
 275   void lock_object  (Register lock_reg, Register obj_reg);
 276   void unlock_object(Register lock_reg);
 277 
 278 #ifndef CC_INTERP
 279   // Interpreter profiling operations
 280   void set_method_data_pointer();
 281   void set_method_data_pointer_for_bcp();
 282   void test_method_data_pointer(Label& zero_continue);
 283   void verify_method_data_pointer();
 284   void test_invocation_counter_for_mdp(Register invocation_count, Register method_counters, Register Rtmp, Label &profile_continue);
 285 
 286   void set_mdp_data_at(int constant, Register value);
 287   void increment_mdp_data_at(Address counter, Register bumped_count,
 288                              bool decrement = false);
 289   void increment_mdp_data_at(int constant, Register bumped_count,
 290                              bool decrement = false);
 291   void increment_mdp_data_at(Register reg, int constant,
 292                              Register bumped_count, Register scratch2,
 293                              bool decrement = false);
 294   void increment_mask_and_jump(Address counter_addr,
 295                                int increment, Address mask_addr,
 296                                Register scratch1, Register scratch2,
 297                                Condition cond, Label *where);
 298   void set_mdp_flag_at(int flag_constant, Register scratch);
 299   void test_mdp_data_at(int offset, Register value, Label& not_equal_continue,
 300                         Register scratch);
 301 
 302   void record_klass_in_profile(Register receiver, Register scratch, bool is_virtual_call);
 303   void record_klass_in_profile_helper(Register receiver, Register scratch,
 304                                       int start_row, Label& done, bool is_virtual_call);
 305 
 306   void update_mdp_by_offset(int offset_of_disp, Register scratch);
 307   void update_mdp_by_offset(Register reg, int offset_of_disp,
 308                             Register scratch);
 309   void update_mdp_by_constant(int constant);
 310   void update_mdp_for_ret(TosState state, Register return_bci);
 311 
 312   void profile_taken_branch(Register scratch, Register bumped_count);
 313   void profile_not_taken_branch(Register scratch);
 314   void profile_call(Register scratch);
 315   void profile_final_call(Register scratch);
 316   void profile_virtual_call(Register receiver, Register scratch, bool receiver_can_be_null = false);
 317   void profile_ret(TosState state, Register return_bci, Register scratch);
 318   void profile_null_seen(Register scratch);
 319   void profile_typecheck(Register klass, Register scratch);
 320   void profile_typecheck_failed(Register scratch);
 321   void profile_switch_default(Register scratch);
 322   void profile_switch_case(Register index,
 323                            Register scratch1,
 324                            Register scratch2,
 325                            Register scratch3);
 326 
 327   void profile_obj_type(Register obj, const Address& mdo_addr, Register tmp);
 328   void profile_arguments_type(Register callee, Register tmp1, Register tmp2, bool is_virtual);
 329   void profile_return_type(Register ret, Register tmp1, Register tmp2);
 330   void profile_parameters_type(Register tmp1, Register tmp2, Register tmp3, Register tmp4);
 331 
 332   // Debugging
 333   void interp_verify_oop(Register reg, TosState state, const char * file, int line);    // only if +VerifyOops && state == atos
 334   void verify_oop_or_return_address(Register reg, Register rtmp); // for astore
 335   void verify_FPU(int stack_depth, TosState state = ftos); // only if +VerifyFPU  && (state == ftos || state == dtos)
 336 
 337 #endif /* CC_INTERP */
 338   // support for JVMTI/Dtrace
 339   typedef enum { NotifyJVMTI, SkipNotifyJVMTI } NotifyMethodExitMode;
 340   void notify_method_entry();
 341   void notify_method_exit(
 342     bool save_result, TosState state, NotifyMethodExitMode mode);
 343 
 344   void save_return_value(TosState state, bool is_native_call);
 345   void restore_return_value(TosState state, bool is_native_call);
 346 
 347 };
 348 
 349 #endif // CPU_SPARC_VM_INTERP_MASM_SPARC_HPP