duke@435: /*
jrose@1145:  * Copyright 2003-2009 Sun Microsystems, Inc.  All Rights Reserved.
duke@435:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@435:  *
duke@435:  * This code is free software; you can redistribute it and/or modify it
duke@435:  * under the terms of the GNU General Public License version 2 only, as
duke@435:  * published by the Free Software Foundation.
duke@435:  *
duke@435:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@435:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@435:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@435:  * version 2 for more details (a copy is included in the LICENSE file that
duke@435:  * accompanied this code).
duke@435:  *
duke@435:  * You should have received a copy of the GNU General Public License version
duke@435:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@435:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@435:  *
duke@435:  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@435:  * CA 95054 USA or visit www.sun.com if you need additional information or
duke@435:  * have any questions.
duke@435:  *
duke@435:  */
duke@435: 
duke@435: // This file specializes the assember with interpreter-specific macros
duke@435: 
duke@435: 
never@739: class InterpreterMacroAssembler: public MacroAssembler {
never@739: #ifndef CC_INTERP
duke@435:  protected:
duke@435:   // Interpreter specific version of call_VM_base
duke@435:   virtual void call_VM_leaf_base(address entry_point,
duke@435:                                  int number_of_arguments);
duke@435: 
duke@435:   virtual void call_VM_base(Register oop_result,
duke@435:                             Register java_thread,
duke@435:                             Register last_java_sp,
duke@435:                             address  entry_point,
duke@435:                             int number_of_arguments,
duke@435:                             bool check_exceptions);
duke@435: 
duke@435:   virtual void check_and_handle_popframe(Register java_thread);
duke@435:   virtual void check_and_handle_earlyret(Register java_thread);
duke@435: 
duke@435:   // base routine for all dispatches
duke@435:   void dispatch_base(TosState state, address* table, bool verifyoop = true);
never@739: #endif // CC_INTERP
duke@435: 
duke@435:  public:
never@739:   InterpreterMacroAssembler(CodeBuffer* code) : MacroAssembler(code) {}
duke@435: 
duke@435:   void load_earlyret_value(TosState state);
duke@435: 
never@739: #ifdef CC_INTERP
never@739:   void save_bcp()                                          { /*  not needed in c++ interpreter and harmless */ }
never@739:   void restore_bcp()                                       { /*  not needed in c++ interpreter and harmless */ }
never@739: 
never@739:   // Helpers for runtime call arguments/results
never@739:   void get_method(Register reg);
never@739: 
never@739: #else
never@739: 
duke@435:   // Interpreter-specific registers
never@739:   void save_bcp() {
never@739:     movptr(Address(rbp, frame::interpreter_frame_bcx_offset * wordSize), r13);
duke@435:   }
duke@435: 
never@739:   void restore_bcp() {
never@739:     movptr(r13, Address(rbp, frame::interpreter_frame_bcx_offset * wordSize));
duke@435:   }
duke@435: 
never@739:   void restore_locals() {
never@739:     movptr(r14, Address(rbp, frame::interpreter_frame_locals_offset * wordSize));
duke@435:   }
duke@435: 
duke@435:   // Helpers for runtime call arguments/results
never@739:   void get_method(Register reg) {
never@739:     movptr(reg, Address(rbp, frame::interpreter_frame_method_offset * wordSize));
duke@435:   }
duke@435: 
never@739:   void get_constant_pool(Register reg) {
duke@435:     get_method(reg);
never@739:     movptr(reg, Address(reg, methodOopDesc::constants_offset()));
duke@435:   }
duke@435: 
never@739:   void get_constant_pool_cache(Register reg) {
duke@435:     get_constant_pool(reg);
never@739:     movptr(reg, Address(reg, constantPoolOopDesc::cache_offset_in_bytes()));
duke@435:   }
duke@435: 
never@739:   void get_cpool_and_tags(Register cpool, Register tags) {
duke@435:     get_constant_pool(cpool);
never@739:     movptr(tags, Address(cpool, constantPoolOopDesc::tags_offset_in_bytes()));
duke@435:   }
duke@435: 
duke@435:   void get_unsigned_2_byte_index_at_bcp(Register reg, int bcp_offset);
duke@435:   void get_cache_and_index_at_bcp(Register cache, Register index,
duke@435:                                   int bcp_offset);
duke@435:   void get_cache_entry_pointer_at_bcp(Register cache, Register tmp,
duke@435:                                       int bcp_offset);
duke@435: 
never@739: 
duke@435:   void pop_ptr(Register r = rax);
duke@435:   void pop_i(Register r = rax);
duke@435:   void pop_l(Register r = rax);
duke@435:   void pop_f(XMMRegister r = xmm0);
duke@435:   void pop_d(XMMRegister r = xmm0);
duke@435:   void push_ptr(Register r = rax);
duke@435:   void push_i(Register r = rax);
duke@435:   void push_l(Register r = rax);
duke@435:   void push_f(XMMRegister r = xmm0);
duke@435:   void push_d(XMMRegister r = xmm0);
duke@435: 
never@739:   void pop(Register r ) { ((MacroAssembler*)this)->pop(r); }
never@739: 
never@739:   void push(Register r ) { ((MacroAssembler*)this)->push(r); }
never@739:   void push(int32_t imm ) { ((MacroAssembler*)this)->push(imm); }
never@739: 
duke@435:   void pop(TosState state); // transition vtos -> state
duke@435:   void push(TosState state); // transition state -> vtos
duke@435: 
duke@435:   // Tagged stack support, pop and push both tag and value.
duke@435:   void pop_ptr(Register r, Register tag);
duke@435:   void push_ptr(Register r, Register tag);
never@739: #endif // CC_INTERP
duke@435: 
duke@435:   DEBUG_ONLY(void verify_stack_tag(frame::Tag t);)
duke@435: 
never@739: #ifndef CC_INTERP
never@739: 
duke@435:   // Tagged stack helpers for swap and dup
duke@435:   void load_ptr_and_tag(int n, Register val, Register tag);
duke@435:   void store_ptr_and_tag(int n, Register val, Register tag);
duke@435: 
duke@435:   // Tagged Local support
duke@435:   void tag_local(frame::Tag tag, int n);
duke@435:   void tag_local(Register tag, int n);
duke@435:   void tag_local(frame::Tag tag, Register idx);
duke@435:   void tag_local(Register tag, Register idx);
duke@435: 
duke@435: #ifdef ASSERT
duke@435:   void verify_local_tag(frame::Tag tag, int n);
duke@435:   void verify_local_tag(frame::Tag tag, Register idx);
duke@435: #endif // ASSERT
duke@435: 
never@739: 
duke@435:   void empty_expression_stack()
duke@435:   {
never@739:     movptr(rsp, Address(rbp, frame::interpreter_frame_monitor_block_top_offset * wordSize));
duke@435:     // NULL last_sp until next java call
never@739:     movptr(Address(rbp, frame::interpreter_frame_last_sp_offset * wordSize), (int32_t)NULL_WORD);
duke@435:   }
duke@435: 
duke@435:   // Super call_VM calls - correspond to MacroAssembler::call_VM(_leaf) calls
duke@435:   void super_call_VM_leaf(address entry_point);
duke@435:   void super_call_VM_leaf(address entry_point, Register arg_1);
duke@435:   void super_call_VM_leaf(address entry_point, Register arg_1, Register arg_2);
duke@435:   void super_call_VM_leaf(address entry_point,
duke@435:                           Register arg_1, Register arg_2, Register arg_3);
duke@435: 
duke@435:   // Generate a subtype check: branch to ok_is_subtype if sub_klass is
duke@435:   // a subtype of super_klass.
duke@435:   void gen_subtype_check( Register sub_klass, Label &ok_is_subtype );
duke@435: 
duke@435:   // Dispatching
duke@435:   void dispatch_prolog(TosState state, int step = 0);
duke@435:   void dispatch_epilog(TosState state, int step = 0);
duke@435:   // dispatch via ebx (assume ebx is loaded already)
duke@435:   void dispatch_only(TosState state);
duke@435:   // dispatch normal table via ebx (assume ebx is loaded already)
duke@435:   void dispatch_only_normal(TosState state);
duke@435:   void dispatch_only_noverify(TosState state);
duke@435:   // load ebx from [esi + step] and dispatch via ebx
duke@435:   void dispatch_next(TosState state, int step = 0);
duke@435:   // load ebx from [esi] and dispatch via ebx and table
duke@435:   void dispatch_via (TosState state, address* table);
duke@435: 
duke@435:   // jump to an invoked target
jrose@1145:   void prepare_to_jump_from_interpreted();
duke@435:   void jump_from_interpreted(Register method, Register temp);
duke@435: 
duke@435: 
duke@435:   // Returning from interpreted functions
duke@435:   //
duke@435:   // Removes the current activation (incl. unlocking of monitors)
duke@435:   // and sets up the return address.  This code is also used for
duke@435:   // exception unwindwing. In that case, we do not want to throw
duke@435:   // IllegalMonitorStateExceptions, since that might get us into an
duke@435:   // infinite rethrow exception loop.
duke@435:   // Additionally this code is used for popFrame and earlyReturn.
duke@435:   // In popFrame case we want to skip throwing an exception,
duke@435:   // installing an exception, and notifying jvmdi.
duke@435:   // In earlyReturn case we only want to skip throwing an exception
duke@435:   // and installing an exception.
duke@435:   void remove_activation(TosState state, Register ret_addr,
duke@435:                          bool throw_monitor_exception = true,
duke@435:                          bool install_monitor_exception = true,
duke@435:                          bool notify_jvmdi = true);
never@739: #endif // CC_INTERP
duke@435: 
duke@435:   // Object locking
duke@435:   void lock_object  (Register lock_reg);
duke@435:   void unlock_object(Register lock_reg);
duke@435: 
never@739: #ifndef CC_INTERP
never@739: 
duke@435:   // Interpreter profiling operations
duke@435:   void set_method_data_pointer_for_bcp();
duke@435:   void test_method_data_pointer(Register mdp, Label& zero_continue);
duke@435:   void verify_method_data_pointer();
duke@435: 
duke@435:   void set_mdp_data_at(Register mdp_in, int constant, Register value);
duke@435:   void increment_mdp_data_at(Address data, bool decrement = false);
duke@435:   void increment_mdp_data_at(Register mdp_in, int constant,
duke@435:                              bool decrement = false);
duke@435:   void increment_mdp_data_at(Register mdp_in, Register reg, int constant,
duke@435:                              bool decrement = false);
duke@435:   void set_mdp_flag_at(Register mdp_in, int flag_constant);
duke@435:   void test_mdp_data_at(Register mdp_in, int offset, Register value,
duke@435:                         Register test_value_out,
duke@435:                         Label& not_equal_continue);
duke@435: 
duke@435:   void record_klass_in_profile(Register receiver, Register mdp,
duke@435:                                Register reg2);
duke@435:   void record_klass_in_profile_helper(Register receiver, Register mdp,
duke@435:                                       Register reg2,
duke@435:                                       int start_row, Label& done);
duke@435: 
duke@435:   void update_mdp_by_offset(Register mdp_in, int offset_of_offset);
duke@435:   void update_mdp_by_offset(Register mdp_in, Register reg, int offset_of_disp);
duke@435:   void update_mdp_by_constant(Register mdp_in, int constant);
duke@435:   void update_mdp_for_ret(Register return_bci);
duke@435: 
duke@435:   void profile_taken_branch(Register mdp, Register bumped_count);
duke@435:   void profile_not_taken_branch(Register mdp);
duke@435:   void profile_call(Register mdp);
duke@435:   void profile_final_call(Register mdp);
duke@435:   void profile_virtual_call(Register receiver, Register mdp,
duke@435:                             Register scratch2);
duke@435:   void profile_ret(Register return_bci, Register mdp);
duke@435:   void profile_null_seen(Register mdp);
duke@435:   void profile_typecheck(Register mdp, Register klass, Register scratch);
duke@435:   void profile_typecheck_failed(Register mdp);
duke@435:   void profile_switch_default(Register mdp);
duke@435:   void profile_switch_case(Register index_in_scratch, Register mdp,
duke@435:                            Register scratch2);
duke@435: 
duke@435:   // Debugging
duke@435:   // only if +VerifyOops && state == atos
duke@435:   void verify_oop(Register reg, TosState state = atos);
duke@435:   // only if +VerifyFPU  && (state == ftos || state == dtos)
duke@435:   void verify_FPU(int stack_depth, TosState state = ftos);
duke@435: 
never@739: #endif // !CC_INTERP
never@739: 
duke@435:   typedef enum { NotifyJVMTI, SkipNotifyJVMTI } NotifyMethodExitMode;
duke@435: 
duke@435:   // support for jvmti/dtrace
duke@435:   void notify_method_entry();
duke@435:   void notify_method_exit(TosState state, NotifyMethodExitMode mode);
duke@435: };