aoqi@0: /*
dlong@7598:  * Copyright (c) 1997, 2015, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  *
aoqi@0:  */
aoqi@0: 
aoqi@1: /*
aoqi@1:  * This file has been modified by Loongson Technology in 2015. These
aoqi@1:  * modifications are Copyright (c) 2015 Loongson Technology, and are made
aoqi@1:  * available on the same license terms set forth above.
aoqi@1:  */
aoqi@1: 
aoqi@0: #ifndef SHARE_VM_RUNTIME_FRAME_HPP
aoqi@0: #define SHARE_VM_RUNTIME_FRAME_HPP
aoqi@0: 
aoqi@0: #include "oops/method.hpp"
aoqi@0: #include "runtime/basicLock.hpp"
aoqi@0: #include "runtime/monitorChunk.hpp"
aoqi@0: #include "runtime/registerMap.hpp"
aoqi@0: #include "utilities/top.hpp"
aoqi@0: #ifdef COMPILER2
dlong@7598: #if defined ADGLOBALS_MD_HPP
dlong@7598: # include ADGLOBALS_MD_HPP
dlong@7598: #elif defined TARGET_ARCH_MODEL_x86_32
aoqi@0: # include "adfiles/adGlobals_x86_32.hpp"
dlong@7598: #elif defined TARGET_ARCH_MODEL_x86_64
aoqi@0: # include "adfiles/adGlobals_x86_64.hpp"
dlong@7598: #elif defined TARGET_ARCH_MODEL_sparc
aoqi@0: # include "adfiles/adGlobals_sparc.hpp"
dlong@7598: #elif defined TARGET_ARCH_MODEL_zero
aoqi@0: # include "adfiles/adGlobals_zero.hpp"
dlong@7598: #elif defined TARGET_ARCH_MODEL_ppc_64
aoqi@0: # include "adfiles/adGlobals_ppc_64.hpp"
aoqi@7994: #elif defined TARGET_ARCH_MODEL_mips_64
aoqi@1: # include "adfiles/adGlobals_mips_64.hpp"
aoqi@1: #endif
aoqi@0: #endif // COMPILER2
aoqi@0: #ifdef ZERO
aoqi@0: #ifdef TARGET_ARCH_zero
aoqi@0: # include "stack_zero.hpp"
aoqi@0: #endif
aoqi@0: #endif
aoqi@0: 
aoqi@0: typedef class BytecodeInterpreter* interpreterState;
aoqi@0: 
aoqi@0: class CodeBlob;
aoqi@0: class FrameValues;
aoqi@0: class vframeArray;
aoqi@0: 
aoqi@0: 
aoqi@0: // A frame represents a physical stack frame (an activation).  Frames
aoqi@0: // can be C or Java frames, and the Java frames can be interpreted or
aoqi@0: // compiled.  In contrast, vframes represent source-level activations,
aoqi@0: // so that one physical frame can correspond to multiple source level
aoqi@0: // frames because of inlining.
aoqi@0: 
aoqi@0: class frame VALUE_OBJ_CLASS_SPEC {
aoqi@0:  private:
aoqi@0:   // Instance variables:
aoqi@0:   intptr_t* _sp; // stack pointer (from Thread::last_Java_sp)
aoqi@0:   address   _pc; // program counter (the next instruction after the call)
aoqi@0: 
aoqi@0:   CodeBlob* _cb; // CodeBlob that "owns" pc
aoqi@0:   enum deopt_state {
aoqi@0:     not_deoptimized,
aoqi@0:     is_deoptimized,
aoqi@0:     unknown
aoqi@0:   };
aoqi@0: 
aoqi@0:   deopt_state _deopt_state;
aoqi@0: 
aoqi@0:  public:
aoqi@0:   // Constructors
aoqi@0:   frame();
aoqi@0: 
simonis@7553: #ifndef PRODUCT
simonis@7553:   // This is a generic constructor which is only used by pns() in debug.cpp.
simonis@7553:   // pns (i.e. print native stack) uses this constructor to create a starting
simonis@7553:   // frame for stack walking. The implementation of this constructor is platform
simonis@7553:   // dependent (i.e. SPARC doesn't need an 'fp' argument an will ignore it) but
simonis@7553:   // we want to keep the signature generic because pns() is shared code.
simonis@7553:   frame(void* sp, void* fp, void* pc);
simonis@7553: #endif
simonis@7553: 
aoqi@0:   // Accessors
aoqi@0: 
aoqi@0:   // pc: Returns the pc at which this frame will continue normally.
aoqi@0:   // It must point at the beginning of the next instruction to execute.
aoqi@0:   address pc() const             { return _pc; }
aoqi@0: 
aoqi@0:   // This returns the pc that if you were in the debugger you'd see. Not
aoqi@0:   // the idealized value in the frame object. This undoes the magic conversion
aoqi@0:   // that happens for deoptimized frames. In addition it makes the value the
aoqi@0:   // hardware would want to see in the native frame. The only user (at this point)
aoqi@0:   // is deoptimization. It likely no one else should ever use it.
aoqi@0:   address raw_pc() const;
aoqi@0: 
aoqi@0:   void set_pc( address   newpc );
aoqi@0: 
aoqi@0:   intptr_t* sp() const           { return _sp; }
aoqi@0:   void set_sp( intptr_t* newsp ) { _sp = newsp; }
aoqi@0: 
aoqi@0: 
aoqi@0:   CodeBlob* cb() const           { return _cb; }
aoqi@0: 
aoqi@0:   // patching operations
aoqi@0:   void   patch_pc(Thread* thread, address pc);
aoqi@0: 
aoqi@0:   // Every frame needs to return a unique id which distinguishes it from all other frames.
aoqi@0:   // For sparc and ia32 use sp. ia64 can have memory frames that are empty so multiple frames
aoqi@0:   // will have identical sp values. For ia64 the bsp (fp) value will serve. No real frame
aoqi@0:   // should have an id() of NULL so it is a distinguishing value for an unmatchable frame.
aoqi@0:   // We also have relationals which allow comparing a frame to anoth frame's id() allow
aoqi@0:   // us to distinguish younger (more recent activation) from older (less recent activations)
aoqi@0:   // A NULL id is only valid when comparing for equality.
aoqi@0: 
aoqi@0:   intptr_t* id(void) const;
aoqi@0:   bool is_younger(intptr_t* id) const;
aoqi@0:   bool is_older(intptr_t* id) const;
aoqi@0: 
aoqi@0:   // testers
aoqi@0: 
aoqi@0:   // Compares for strict equality. Rarely used or needed.
aoqi@0:   // It can return a different result than f1.id() == f2.id()
aoqi@0:   bool equal(frame other) const;
aoqi@0: 
aoqi@0:   // type testers
aoqi@0:   bool is_interpreted_frame()    const;
aoqi@0:   bool is_java_frame()           const;
aoqi@0:   bool is_entry_frame()          const;             // Java frame called from C?
aoqi@0:   bool is_stub_frame()           const;
aoqi@0:   bool is_ignored_frame()        const;
aoqi@0:   bool is_native_frame()         const;
aoqi@0:   bool is_runtime_frame()        const;
aoqi@0:   bool is_compiled_frame()       const;
aoqi@0:   bool is_safepoint_blob_frame() const;
aoqi@0:   bool is_deoptimized_frame()    const;
aoqi@0: 
aoqi@0:   // testers
aoqi@0:   bool is_first_frame() const; // oldest frame? (has no sender)
aoqi@0:   bool is_first_java_frame() const;              // same for Java frame
aoqi@0: 
aoqi@0:   bool is_interpreted_frame_valid(JavaThread* thread) const;       // performs sanity checks on interpreted frames.
aoqi@0: 
aoqi@0:   // tells whether this frame is marked for deoptimization
aoqi@0:   bool should_be_deoptimized() const;
aoqi@0: 
aoqi@0:   // tells whether this frame can be deoptimized
aoqi@0:   bool can_be_deoptimized() const;
aoqi@0: 
aoqi@0:   // returns the frame size in stack slots
aoqi@0:   int frame_size(RegisterMap* map) const;
aoqi@0: 
aoqi@0:   // returns the sending frame
aoqi@0:   frame sender(RegisterMap* map) const;
aoqi@0: 
aoqi@0:   // for Profiling - acting on another frame. walks sender frames
aoqi@0:   // if valid.
aoqi@0:   frame profile_find_Java_sender_frame(JavaThread *thread);
aoqi@0:   bool safe_for_sender(JavaThread *thread);
aoqi@0: 
aoqi@0:   // returns the sender, but skips conversion frames
aoqi@0:   frame real_sender(RegisterMap* map) const;
aoqi@0: 
aoqi@0:   // returns the the sending Java frame, skipping any intermediate C frames
aoqi@0:   // NB: receiver must not be first frame
aoqi@0:   frame java_sender() const;
aoqi@0: 
aoqi@0:  private:
aoqi@0:   // Helper methods for better factored code in frame::sender
aoqi@0:   frame sender_for_compiled_frame(RegisterMap* map) const;
aoqi@0:   frame sender_for_entry_frame(RegisterMap* map) const;
aoqi@0:   frame sender_for_interpreter_frame(RegisterMap* map) const;
aoqi@0:   frame sender_for_native_frame(RegisterMap* map) const;
aoqi@0: 
aoqi@0:   // All frames:
aoqi@0: 
aoqi@0:   // A low-level interface for vframes:
aoqi@0: 
aoqi@0:  public:
aoqi@0: 
aoqi@0:   intptr_t* addr_at(int index) const             { return &fp()[index];    }
aoqi@0:   intptr_t  at(int index) const                  { return *addr_at(index); }
aoqi@0: 
aoqi@0:   // accessors for locals
aoqi@0:   oop obj_at(int offset) const                   { return *obj_at_addr(offset);  }
aoqi@0:   void obj_at_put(int offset, oop value)         { *obj_at_addr(offset) = value; }
aoqi@0: 
aoqi@0:   jint int_at(int offset) const                  { return *int_at_addr(offset);  }
aoqi@0:   void int_at_put(int offset, jint value)        { *int_at_addr(offset) = value; }
aoqi@0: 
aoqi@0:   oop*      obj_at_addr(int offset) const        { return (oop*)     addr_at(offset); }
aoqi@0: 
aoqi@0:   oop*      adjusted_obj_at_addr(Method* method, int index) { return obj_at_addr(adjust_offset(method, index)); }
aoqi@0: 
aoqi@0:  private:
aoqi@0:   jint*    int_at_addr(int offset) const         { return (jint*)    addr_at(offset); }
aoqi@0: 
aoqi@0:  public:
aoqi@0:   // Link (i.e., the pointer to the previous frame)
aoqi@0:   intptr_t* link() const;
aoqi@0:   void set_link(intptr_t* addr);
aoqi@0: 
aoqi@0:   // Return address
aoqi@0:   address  sender_pc() const;
aoqi@0: 
aoqi@0:   // Support for deoptimization
aoqi@0:   void deoptimize(JavaThread* thread);
aoqi@0: 
aoqi@0:   // The frame's original SP, before any extension by an interpreted callee;
aoqi@0:   // used for packing debug info into vframeArray objects and vframeArray lookup.
aoqi@0:   intptr_t* unextended_sp() const;
aoqi@0: 
aoqi@0:   // returns the stack pointer of the calling frame
aoqi@0:   intptr_t* sender_sp() const;
aoqi@0: 
aoqi@0:   // Returns the real 'frame pointer' for the current frame.
aoqi@0:   // This is the value expected by the platform ABI when it defines a
aoqi@0:   // frame pointer register. It may differ from the effective value of
aoqi@0:   // the FP register when that register is used in the JVM for other
aoqi@0:   // purposes (like compiled frames on some platforms).
aoqi@0:   // On other platforms, it is defined so that the stack area used by
aoqi@0:   // this frame goes from real_fp() to sp().
aoqi@0:   intptr_t* real_fp() const;
aoqi@0: 
aoqi@0:   // Deoptimization info, if needed (platform dependent).
aoqi@0:   // Stored in the initial_info field of the unroll info, to be used by
aoqi@0:   // the platform dependent deoptimization blobs.
aoqi@0:   intptr_t *initial_deoptimization_info();
aoqi@0: 
aoqi@0:   // Interpreter frames:
aoqi@0: 
aoqi@0:  private:
aoqi@0:   intptr_t** interpreter_frame_locals_addr() const;
aoqi@0:   intptr_t*  interpreter_frame_bcx_addr() const;
aoqi@0:   intptr_t*  interpreter_frame_mdx_addr() const;
aoqi@0: 
aoqi@0:  public:
aoqi@0:   // Locals
aoqi@0: 
aoqi@0:   // The _at version returns a pointer because the address is used for GC.
aoqi@0:   intptr_t* interpreter_frame_local_at(int index) const;
aoqi@0: 
aoqi@0:   void interpreter_frame_set_locals(intptr_t* locs);
aoqi@0: 
aoqi@0:   // byte code index/pointer (use these functions for unchecked frame access only!)
aoqi@0:   intptr_t interpreter_frame_bcx() const                  { return *interpreter_frame_bcx_addr(); }
aoqi@0:   void interpreter_frame_set_bcx(intptr_t bcx);
aoqi@0: 
aoqi@0:   // byte code index
aoqi@0:   jint interpreter_frame_bci() const;
aoqi@0:   void interpreter_frame_set_bci(jint bci);
aoqi@0: 
aoqi@0:   // byte code pointer
aoqi@0:   address interpreter_frame_bcp() const;
aoqi@0:   void    interpreter_frame_set_bcp(address bcp);
aoqi@0: 
aoqi@0:   // Unchecked access to the method data index/pointer.
aoqi@0:   // Only use this if you know what you are doing.
aoqi@0:   intptr_t interpreter_frame_mdx() const                  { return *interpreter_frame_mdx_addr(); }
aoqi@0:   void interpreter_frame_set_mdx(intptr_t mdx);
aoqi@0: 
aoqi@0:   // method data pointer
aoqi@0:   address interpreter_frame_mdp() const;
aoqi@0:   void    interpreter_frame_set_mdp(address dp);
aoqi@0: 
aoqi@0:   // Find receiver out of caller's (compiled) argument list
aoqi@0:   oop retrieve_receiver(RegisterMap *reg_map);
aoqi@0: 
aoqi@0:   // Return the monitor owner and BasicLock for compiled synchronized
aoqi@0:   // native methods so that biased locking can revoke the receiver's
aoqi@0:   // bias if necessary.  This is also used by JVMTI's GetLocalInstance method
aoqi@0:   // (via VM_GetReceiver) to retrieve the receiver from a native wrapper frame.
aoqi@0:   BasicLock* get_native_monitor();
aoqi@0:   oop        get_native_receiver();
aoqi@0: 
aoqi@0:   // Find receiver for an invoke when arguments are just pushed on stack (i.e., callee stack-frame is
aoqi@0:   // not setup)
aoqi@0:   oop interpreter_callee_receiver(Symbol* signature)     { return *interpreter_callee_receiver_addr(signature); }
aoqi@0: 
aoqi@0: 
aoqi@0:   oop* interpreter_callee_receiver_addr(Symbol* signature);
aoqi@0: 
aoqi@0: 
aoqi@0:   // expression stack (may go up or down, direction == 1 or -1)
aoqi@0:  public:
aoqi@0:   intptr_t* interpreter_frame_expression_stack() const;
aoqi@0:   static  jint  interpreter_frame_expression_stack_direction();
aoqi@0: 
aoqi@0:   // The _at version returns a pointer because the address is used for GC.
aoqi@0:   intptr_t* interpreter_frame_expression_stack_at(jint offset) const;
aoqi@0: 
aoqi@0:   // top of expression stack
aoqi@0:   intptr_t* interpreter_frame_tos_at(jint offset) const;
aoqi@0:   intptr_t* interpreter_frame_tos_address() const;
aoqi@0: 
aoqi@0: 
aoqi@0:   jint  interpreter_frame_expression_stack_size() const;
aoqi@0: 
aoqi@0:   intptr_t* interpreter_frame_sender_sp() const;
aoqi@0: 
aoqi@0: #ifndef CC_INTERP
aoqi@0:   // template based interpreter deoptimization support
aoqi@0:   void  set_interpreter_frame_sender_sp(intptr_t* sender_sp);
aoqi@0:   void interpreter_frame_set_monitor_end(BasicObjectLock* value);
aoqi@0: #endif // CC_INTERP
aoqi@0: 
aoqi@0:   // Address of the temp oop in the frame. Needed as GC root.
aoqi@0:   oop* interpreter_frame_temp_oop_addr() const;
aoqi@0: 
aoqi@0:   // BasicObjectLocks:
aoqi@0:   //
aoqi@0:   // interpreter_frame_monitor_begin is higher in memory than interpreter_frame_monitor_end
aoqi@0:   // Interpreter_frame_monitor_begin points to one element beyond the oldest one,
aoqi@0:   // interpreter_frame_monitor_end   points to the youngest one, or if there are none,
aoqi@0:   //                                 it points to one beyond where the first element will be.
aoqi@0:   // interpreter_frame_monitor_size  reports the allocation size of a monitor in the interpreter stack.
aoqi@0:   //                                 this value is >= BasicObjectLock::size(), and may be rounded up
aoqi@0: 
aoqi@0:   BasicObjectLock* interpreter_frame_monitor_begin() const;
aoqi@0:   BasicObjectLock* interpreter_frame_monitor_end()   const;
aoqi@0:   BasicObjectLock* next_monitor_in_interpreter_frame(BasicObjectLock* current) const;
aoqi@0:   BasicObjectLock* previous_monitor_in_interpreter_frame(BasicObjectLock* current) const;
aoqi@0:   static int interpreter_frame_monitor_size();
aoqi@0: 
aoqi@0:   void interpreter_frame_verify_monitor(BasicObjectLock* value) const;
aoqi@0: 
aoqi@0:   // Tells whether the current interpreter_frame frame pointer
aoqi@0:   // corresponds to the old compiled/deoptimized fp
aoqi@0:   // The receiver used to be a top level frame
aoqi@0:   bool interpreter_frame_equals_unpacked_fp(intptr_t* fp);
aoqi@0: 
aoqi@0:   // Return/result value from this interpreter frame
aoqi@0:   // If the method return type is T_OBJECT or T_ARRAY populates oop_result
aoqi@0:   // For other (non-T_VOID) the appropriate field in the jvalue is populated
aoqi@0:   // with the result value.
aoqi@0:   // Should only be called when at method exit when the method is not
aoqi@0:   // exiting due to an exception.
aoqi@0:   BasicType interpreter_frame_result(oop* oop_result, jvalue* value_result);
aoqi@0: 
aoqi@0:  public:
aoqi@0:   // Method & constant pool cache
aoqi@0:   Method* interpreter_frame_method() const;
aoqi@0:   void interpreter_frame_set_method(Method* method);
aoqi@0:   Method** interpreter_frame_method_addr() const;
aoqi@0:   ConstantPoolCache** interpreter_frame_cache_addr() const;
aoqi@0: 
aoqi@0:  public:
aoqi@0:   // Entry frames
aoqi@0:   JavaCallWrapper* entry_frame_call_wrapper() const { return *entry_frame_call_wrapper_addr(); }
aoqi@0:   JavaCallWrapper* entry_frame_call_wrapper_if_safe(JavaThread* thread) const;
aoqi@0:   JavaCallWrapper** entry_frame_call_wrapper_addr() const;
aoqi@0:   intptr_t* entry_frame_argument_at(int offset) const;
aoqi@0: 
aoqi@0:   // tells whether there is another chunk of Delta stack above
aoqi@0:   bool entry_frame_is_first() const;
aoqi@0: 
aoqi@0:   // Compiled frames:
aoqi@0: 
aoqi@0:  public:
aoqi@0:   // Given the index of a local, and the number of argument words
aoqi@0:   // in this stack frame, tell which word of the stack frame to find
aoqi@0:   // the local in.  Arguments are stored above the ofp/rpc pair,
aoqi@0:   // while other locals are stored below it.
aoqi@0:   // Since monitors (BasicLock blocks) are also assigned indexes,
aoqi@0:   // but may have different storage requirements, their presence
aoqi@0:   // can also affect the calculation of offsets.
aoqi@0:   static int local_offset_for_compiler(int local_index, int nof_args, int max_nof_locals, int max_nof_monitors);
aoqi@0: 
aoqi@0:   // Given the index of a monitor, etc., tell which word of the
aoqi@0:   // stack frame contains the start of the BasicLock block.
aoqi@0:   // Note that the local index by convention is the __higher__
aoqi@0:   // of the two indexes allocated to the block.
aoqi@0:   static int monitor_offset_for_compiler(int local_index, int nof_args, int max_nof_locals, int max_nof_monitors);
aoqi@0: 
aoqi@0:   // Tell the smallest value that local_offset_for_compiler will attain.
aoqi@0:   // This is used to help determine how much stack frame to allocate.
aoqi@0:   static int min_local_offset_for_compiler(int nof_args, int max_nof_locals, int max_nof_monitors);
aoqi@0: 
aoqi@0:   // Tells if this register must be spilled during a call.
aoqi@0:   // On Intel, all registers are smashed by calls.
aoqi@0:   static bool volatile_across_calls(Register reg);
aoqi@0: 
aoqi@0: 
aoqi@0:   // Safepoints
aoqi@0: 
aoqi@0:  public:
aoqi@0:   oop saved_oop_result(RegisterMap* map) const;
aoqi@0:   void set_saved_oop_result(RegisterMap* map, oop obj);
aoqi@0: 
aoqi@0:   // For debugging
aoqi@0:  private:
aoqi@0:   const char* print_name() const;
aoqi@0: 
aoqi@0:   void describe_pd(FrameValues& values, int frame_no);
aoqi@0: 
aoqi@0:  public:
aoqi@0:   void print_value() const { print_value_on(tty,NULL); }
aoqi@0:   void print_value_on(outputStream* st, JavaThread *thread) const;
aoqi@0:   void print_on(outputStream* st) const;
aoqi@0:   void interpreter_frame_print_on(outputStream* st) const;
aoqi@0:   void print_on_error(outputStream* st, char* buf, int buflen, bool verbose = false) const;
aoqi@0:   static void print_C_frame(outputStream* st, char* buf, int buflen, address pc);
aoqi@0: 
aoqi@0:   // Add annotated descriptions of memory locations belonging to this frame to values
aoqi@0:   void describe(FrameValues& values, int frame_no);
aoqi@0: 
aoqi@0:   // Conversion from an VMReg to physical stack location
aoqi@0:   oop* oopmapreg_to_location(VMReg reg, const RegisterMap* regmap) const;
aoqi@0: 
aoqi@0:   // Oops-do's
aoqi@0:   void oops_compiled_arguments_do(Symbol* signature, bool has_receiver, bool has_appendix, const RegisterMap* reg_map, OopClosure* f);
stefank@6973:   void oops_interpreted_do(OopClosure* f, CLDClosure* cld_f, const RegisterMap* map, bool query_oop_map_cache = true);
aoqi@0: 
aoqi@0:  private:
aoqi@0:   void oops_interpreted_arguments_do(Symbol* signature, bool has_receiver, OopClosure* f);
aoqi@0: 
aoqi@0:   // Iteration of oops
stefank@6973:   void oops_do_internal(OopClosure* f, CLDClosure* cld_f, CodeBlobClosure* cf, RegisterMap* map, bool use_interpreter_oop_map_cache);
aoqi@0:   void oops_entry_do(OopClosure* f, const RegisterMap* map);
aoqi@0:   void oops_code_blob_do(OopClosure* f, CodeBlobClosure* cf, const RegisterMap* map);
aoqi@0:   int adjust_offset(Method* method, int index); // helper for above fn
aoqi@0:  public:
aoqi@0:   // Memory management
stefank@6973:   void oops_do(OopClosure* f, CLDClosure* cld_f, CodeBlobClosure* cf, RegisterMap* map) { oops_do_internal(f, cld_f, cf, map, true); }
aoqi@0:   void nmethods_do(CodeBlobClosure* cf);
aoqi@0: 
aoqi@0:   // RedefineClasses support for finding live interpreted methods on the stack
aoqi@0:   void metadata_do(void f(Metadata*));
aoqi@0: 
aoqi@0:   void gc_prologue();
aoqi@0:   void gc_epilogue();
aoqi@0:   void pd_gc_epilog();
aoqi@0: 
aoqi@0: # ifdef ENABLE_ZAP_DEAD_LOCALS
aoqi@0:  private:
aoqi@0:   class CheckValueClosure: public OopClosure {
aoqi@0:    public:
aoqi@0:     void do_oop(oop* p);
aoqi@0:     void do_oop(narrowOop* p) { ShouldNotReachHere(); }
aoqi@0:   };
aoqi@0:   static CheckValueClosure _check_value;
aoqi@0: 
aoqi@0:   class CheckOopClosure: public OopClosure {
aoqi@0:    public:
aoqi@0:     void do_oop(oop* p);
aoqi@0:     void do_oop(narrowOop* p) { ShouldNotReachHere(); }
aoqi@0:   };
aoqi@0:   static CheckOopClosure _check_oop;
aoqi@0: 
aoqi@0:   static void check_derived_oop(oop* base, oop* derived);
aoqi@0: 
aoqi@0:   class ZapDeadClosure: public OopClosure {
aoqi@0:    public:
aoqi@0:     void do_oop(oop* p);
aoqi@0:     void do_oop(narrowOop* p) { ShouldNotReachHere(); }
aoqi@0:   };
aoqi@0:   static ZapDeadClosure _zap_dead;
aoqi@0: 
aoqi@0:  public:
aoqi@0:   // Zapping
aoqi@0:   void zap_dead_locals            (JavaThread* thread, const RegisterMap* map);
aoqi@0:   void zap_dead_interpreted_locals(JavaThread* thread, const RegisterMap* map);
aoqi@0:   void zap_dead_compiled_locals   (JavaThread* thread, const RegisterMap* map);
aoqi@0:   void zap_dead_entry_locals      (JavaThread* thread, const RegisterMap* map);
aoqi@0:   void zap_dead_deoptimized_locals(JavaThread* thread, const RegisterMap* map);
aoqi@0: # endif
aoqi@0:   // Verification
aoqi@0:   void verify(const RegisterMap* map);
aoqi@0:   static bool verify_return_pc(address x);
aoqi@0:   static bool is_bci(intptr_t bcx);
aoqi@0:   // Usage:
aoqi@0:   // assert(frame::verify_return_pc(return_address), "must be a return pc");
aoqi@0: 
aoqi@0:   int pd_oop_map_offset_adjustment() const;
aoqi@0: 
aoqi@0: #ifdef TARGET_ARCH_x86
aoqi@0: # include "frame_x86.hpp"
aoqi@0: #endif
aoqi@1: #ifdef TARGET_ARCH_mips
aoqi@1: # include "frame_mips.hpp"
aoqi@1: #endif
aoqi@0: #ifdef TARGET_ARCH_sparc
aoqi@0: # include "frame_sparc.hpp"
aoqi@0: #endif
aoqi@0: #ifdef TARGET_ARCH_zero
aoqi@0: # include "frame_zero.hpp"
aoqi@0: #endif
aoqi@0: #ifdef TARGET_ARCH_arm
aoqi@0: # include "frame_arm.hpp"
aoqi@0: #endif
aoqi@0: #ifdef TARGET_ARCH_ppc
aoqi@0: # include "frame_ppc.hpp"
aoqi@0: #endif
aoqi@0: 
aoqi@0: };
aoqi@0: 
aoqi@0: #ifndef PRODUCT
aoqi@0: // A simple class to describe a location on the stack
aoqi@0: class FrameValue VALUE_OBJ_CLASS_SPEC {
aoqi@0:  public:
aoqi@0:   intptr_t* location;
aoqi@0:   char* description;
aoqi@0:   int owner;
aoqi@0:   int priority;
aoqi@0: };
aoqi@0: 
aoqi@0: 
aoqi@0: // A collection of described stack values that can print a symbolic
aoqi@0: // description of the stack memory.  Interpreter frame values can be
aoqi@0: // in the caller frames so all the values are collected first and then
aoqi@0: // sorted before being printed.
aoqi@0: class FrameValues {
aoqi@0:  private:
aoqi@0:   GrowableArray<FrameValue> _values;
aoqi@0: 
aoqi@0:   static int compare(FrameValue* a, FrameValue* b) {
aoqi@0:     if (a->location == b->location) {
aoqi@0:       return a->priority - b->priority;
aoqi@0:     }
aoqi@0:     return a->location - b->location;
aoqi@0:   }
aoqi@0: 
aoqi@0:  public:
aoqi@0:   // Used by frame functions to describe locations.
aoqi@0:   void describe(int owner, intptr_t* location, const char* description, int priority = 0);
aoqi@0: 
aoqi@0: #ifdef ASSERT
aoqi@0:   void validate();
aoqi@0: #endif
aoqi@0:   void print(JavaThread* thread);
aoqi@0: };
aoqi@0: 
aoqi@0: #endif
aoqi@0: 
aoqi@0: //
aoqi@0: // StackFrameStream iterates through the frames of a thread starting from
aoqi@0: // top most frame. It automatically takes care of updating the location of
aoqi@0: // all (callee-saved) registers. Notice: If a thread is stopped at
aoqi@0: // a safepoint, all registers are saved, not only the callee-saved ones.
aoqi@0: //
aoqi@0: // Use:
aoqi@0: //
aoqi@0: //   for(StackFrameStream fst(thread); !fst.is_done(); fst.next()) {
aoqi@0: //     ...
aoqi@0: //   }
aoqi@0: //
aoqi@0: class StackFrameStream : public StackObj {
aoqi@0:  private:
aoqi@0:   frame       _fr;
aoqi@0:   RegisterMap _reg_map;
aoqi@0:   bool        _is_done;
aoqi@0:  public:
aoqi@0:    StackFrameStream(JavaThread *thread, bool update = true);
aoqi@0: 
aoqi@0:   // Iteration
aoqi@0:   bool is_done()                  { return (_is_done) ? true : (_is_done = _fr.is_first_frame(), false); }
aoqi@0:   void next()                     { if (!_is_done) _fr = _fr.sender(&_reg_map); }
aoqi@0: 
aoqi@0:   // Query
aoqi@0:   frame *current()                { return &_fr; }
aoqi@0:   RegisterMap* register_map()     { return &_reg_map; }
aoqi@0: };
aoqi@0: 
aoqi@0: #endif // SHARE_VM_RUNTIME_FRAME_HPP