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