1 /*

     2  * Copyright (c) 1997, 2017, 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 SHARE_VM_RUNTIME_FRAME_HPP

    26 #define SHARE_VM_RUNTIME_FRAME_HPP

    27 

    28 #include "oops/method.hpp"

    29 #include "runtime/basicLock.hpp"

    30 #include "runtime/monitorChunk.hpp"

    31 #include "runtime/registerMap.hpp"

    32 #include "utilities/macros.hpp"

    33 #ifdef ZERO

    34 # include "stack_zero.hpp"

    35 #endif

    36 

    37 typedef class BytecodeInterpreter* interpreterState;

    38 

    39 class CodeBlob;

    40 class FrameValues;

    41 class vframeArray;

    42 

    43 

    44 // A frame represents a physical stack frame (an activation).  Frames

    45 // can be C or Java frames, and the Java frames can be interpreted or

    46 // compiled.  In contrast, vframes represent source-level activations,

    47 // so that one physical frame can correspond to multiple source level

    48 // frames because of inlining.

    49 

    50 class frame VALUE_OBJ_CLASS_SPEC {

    51  private:

    52   // Instance variables:

    53   intptr_t* _sp; // stack pointer (from Thread::last_Java_sp)

    54   address   _pc; // program counter (the next instruction after the call)

    55 

    56   CodeBlob* _cb; // CodeBlob that "owns" pc

    57   enum deopt_state {

    58     not_deoptimized,

    59     is_deoptimized,

    60     unknown

    61   };

    62 

    63   deopt_state _deopt_state;

    64 

    65  public:

    66   // Constructors

    67   frame();

    68 

    69 #ifndef PRODUCT

    70   // This is a generic constructor which is only used by pns() in debug.cpp.

    71   // pns (i.e. print native stack) uses this constructor to create a starting

    72   // frame for stack walking. The implementation of this constructor is platform

    73   // dependent (i.e. SPARC doesn't need an 'fp' argument an will ignore it) but

    74   // we want to keep the signature generic because pns() is shared code.

    75   frame(void* sp, void* fp, void* pc);

    76 #endif

    77 

    78   // Accessors

    79 

    80   // pc: Returns the pc at which this frame will continue normally.

    81   // It must point at the beginning of the next instruction to execute.

    82   address pc() const             { return _pc; }

    83 

    84   // This returns the pc that if you were in the debugger you'd see. Not

    85   // the idealized value in the frame object. This undoes the magic conversion

    86   // that happens for deoptimized frames. In addition it makes the value the

    87   // hardware would want to see in the native frame. The only user (at this point)

    88   // is deoptimization. It likely no one else should ever use it.

    89   address raw_pc() const;

    90 

    91   void set_pc( address   newpc );

    92 

    93   intptr_t* sp() const           { return _sp; }

    94   void set_sp( intptr_t* newsp ) { _sp = newsp; }

    95 

    96 

    97   CodeBlob* cb() const           { return _cb; }

    98 

    99   // patching operations

   100   void   patch_pc(Thread* thread, address pc);

   101 

   102   // Every frame needs to return a unique id which distinguishes it from all other frames.

   103   // For sparc and ia32 use sp. ia64 can have memory frames that are empty so multiple frames

   104   // will have identical sp values. For ia64 the bsp (fp) value will serve. No real frame

   105   // should have an id() of NULL so it is a distinguishing value for an unmatchable frame.

   106   // We also have relationals which allow comparing a frame to anoth frame's id() allow

   107   // us to distinguish younger (more recent activation) from older (less recent activations)

   108   // A NULL id is only valid when comparing for equality.

   109 

   110   intptr_t* id(void) const;

   111   bool is_younger(intptr_t* id) const;

   112   bool is_older(intptr_t* id) const;

   113 

   114   // testers

   115 

   116   // Compares for strict equality. Rarely used or needed.

   117   // It can return a different result than f1.id() == f2.id()

   118   bool equal(frame other) const;

   119 

   120   // type testers

   121   bool is_interpreted_frame()    const;

   122   bool is_java_frame()           const;

   123   bool is_entry_frame()          const;             // Java frame called from C?

   124   bool is_stub_frame()           const;

   125   bool is_ignored_frame()        const;

   126   bool is_native_frame()         const;

   127   bool is_runtime_frame()        const;

   128   bool is_compiled_frame()       const;

   129   bool is_safepoint_blob_frame() const;

   130   bool is_deoptimized_frame()    const;

   131 

   132   // testers

   133   bool is_first_frame() const; // oldest frame? (has no sender)

   134   bool is_first_java_frame() const;              // same for Java frame

   135 

   136   bool is_interpreted_frame_valid(JavaThread* thread) const;       // performs sanity checks on interpreted frames.

   137 

   138   // tells whether this frame is marked for deoptimization

   139   bool should_be_deoptimized() const;

   140 

   141   // tells whether this frame can be deoptimized

   142   bool can_be_deoptimized() const;

   143 

   144   // returns the frame size in stack slots

   145   int frame_size(RegisterMap* map) const;

   146 

   147   // returns the sending frame

   148   frame sender(RegisterMap* map) const;

   149 

   150   // for Profiling - acting on another frame. walks sender frames

   151   // if valid.

   152   frame profile_find_Java_sender_frame(JavaThread *thread);

   153   bool safe_for_sender(JavaThread *thread);

   154 

   155   // returns the sender, but skips conversion frames

   156   frame real_sender(RegisterMap* map) const;

   157 

   158   // returns the the sending Java frame, skipping any intermediate C frames

   159   // NB: receiver must not be first frame

   160   frame java_sender() const;

   161 

   162  private:

   163   // Helper methods for better factored code in frame::sender

   164   frame sender_for_compiled_frame(RegisterMap* map) const;

   165   frame sender_for_entry_frame(RegisterMap* map) const;

   166   frame sender_for_interpreter_frame(RegisterMap* map) const;

   167   frame sender_for_native_frame(RegisterMap* map) const;

   168 

   169   bool is_entry_frame_valid(JavaThread* thread) const;

   170 

   171   // All frames:

   172 

   173   // A low-level interface for vframes:

   174 

   175  public:

   176 

   177   intptr_t* addr_at(int index) const             { return &fp()[index];    }

   178   intptr_t  at(int index) const                  { return *addr_at(index); }

   179 

   180   // accessors for locals

   181   oop obj_at(int offset) const                   { return *obj_at_addr(offset);  }

   182   void obj_at_put(int offset, oop value)         { *obj_at_addr(offset) = value; }

   183 

   184   jint int_at(int offset) const                  { return *int_at_addr(offset);  }

   185   void int_at_put(int offset, jint value)        { *int_at_addr(offset) = value; }

   186 

   187   oop*      obj_at_addr(int offset) const        { return (oop*)     addr_at(offset); }

   188 

   189   oop*      adjusted_obj_at_addr(Method* method, int index) { return obj_at_addr(adjust_offset(method, index)); }

   190 

   191  private:

   192   jint*    int_at_addr(int offset) const         { return (jint*)    addr_at(offset); }

   193 

   194  public:

   195   // Link (i.e., the pointer to the previous frame)

   196   intptr_t* link() const;

   197 

   198   // Return address

   199   address  sender_pc() const;

   200 

   201   // Support for deoptimization

   202   void deoptimize(JavaThread* thread);

   203 

   204   // The frame's original SP, before any extension by an interpreted callee;

   205   // used for packing debug info into vframeArray objects and vframeArray lookup.

   206   intptr_t* unextended_sp() const;

   207 

   208   // returns the stack pointer of the calling frame

   209   intptr_t* sender_sp() const;

   210 

   211   // Returns the real 'frame pointer' for the current frame.

   212   // This is the value expected by the platform ABI when it defines a

   213   // frame pointer register. It may differ from the effective value of

   214   // the FP register when that register is used in the JVM for other

   215   // purposes (like compiled frames on some platforms).

   216   // On other platforms, it is defined so that the stack area used by

   217   // this frame goes from real_fp() to sp().

   218   intptr_t* real_fp() const;

   219 

   220   // Deoptimization info, if needed (platform dependent).

   221   // Stored in the initial_info field of the unroll info, to be used by

   222   // the platform dependent deoptimization blobs.

   223   intptr_t *initial_deoptimization_info();

   224 

   225   // Interpreter frames:

   226 

   227  private:

   228   intptr_t** interpreter_frame_locals_addr() const;

   229   intptr_t*  interpreter_frame_bcp_addr() const;

   230   intptr_t*  interpreter_frame_mdp_addr() const;

   231 

   232  public:

   233   // Locals

   234 

   235   // The _at version returns a pointer because the address is used for GC.

   236   intptr_t* interpreter_frame_local_at(int index) const;

   237 

   238   void interpreter_frame_set_locals(intptr_t* locs);

   239 

   240   // byte code index

   241   jint interpreter_frame_bci() const;

   242 

   243   // byte code pointer

   244   address interpreter_frame_bcp() const;

   245   void    interpreter_frame_set_bcp(address bcp);

   246 

   247   // method data pointer

   248   address interpreter_frame_mdp() const;

   249   void    interpreter_frame_set_mdp(address dp);

   250 

   251   // Find receiver out of caller's (compiled) argument list

   252   oop retrieve_receiver(RegisterMap *reg_map);

   253 

   254   // Return the monitor owner and BasicLock for compiled synchronized

   255   // native methods so that biased locking can revoke the receiver's

   256   // bias if necessary.  This is also used by JVMTI's GetLocalInstance method

   257   // (via VM_GetReceiver) to retrieve the receiver from a native wrapper frame.

   258   BasicLock* get_native_monitor();

   259   oop        get_native_receiver();

   260 

   261   // Find receiver for an invoke when arguments are just pushed on stack (i.e., callee stack-frame is

   262   // not setup)

   263   oop interpreter_callee_receiver(Symbol* signature)     { return *interpreter_callee_receiver_addr(signature); }

   264 

   265 

   266   oop* interpreter_callee_receiver_addr(Symbol* signature);

   267 

   268 

   269   // expression stack (may go up or down, direction == 1 or -1)

   270  public:

   271   intptr_t* interpreter_frame_expression_stack() const;

   272   static  jint  interpreter_frame_expression_stack_direction();

   273 

   274   // The _at version returns a pointer because the address is used for GC.

   275   intptr_t* interpreter_frame_expression_stack_at(jint offset) const;

   276 

   277   // top of expression stack

   278   intptr_t* interpreter_frame_tos_at(jint offset) const;

   279   intptr_t* interpreter_frame_tos_address() const;

   280 

   281 

   282   jint  interpreter_frame_expression_stack_size() const;

   283 

   284   intptr_t* interpreter_frame_sender_sp() const;

   285 

   286 #ifndef CC_INTERP

   287   // template based interpreter deoptimization support

   288   void  set_interpreter_frame_sender_sp(intptr_t* sender_sp);

   289   void interpreter_frame_set_monitor_end(BasicObjectLock* value);

   290 #endif // CC_INTERP

   291 

   292   // Address of the temp oop in the frame. Needed as GC root.

   293   oop* interpreter_frame_temp_oop_addr() const;

   294 

   295   // BasicObjectLocks:

   296   //

   297   // interpreter_frame_monitor_begin is higher in memory than interpreter_frame_monitor_end

   298   // Interpreter_frame_monitor_begin points to one element beyond the oldest one,

   299   // interpreter_frame_monitor_end   points to the youngest one, or if there are none,

   300   //                                 it points to one beyond where the first element will be.

   301   // interpreter_frame_monitor_size  reports the allocation size of a monitor in the interpreter stack.

   302   //                                 this value is >= BasicObjectLock::size(), and may be rounded up

   303 

   304   BasicObjectLock* interpreter_frame_monitor_begin() const;

   305   BasicObjectLock* interpreter_frame_monitor_end()   const;

   306   BasicObjectLock* next_monitor_in_interpreter_frame(BasicObjectLock* current) const;

   307   BasicObjectLock* previous_monitor_in_interpreter_frame(BasicObjectLock* current) const;

   308   static int interpreter_frame_monitor_size();

   309 

   310   void interpreter_frame_verify_monitor(BasicObjectLock* value) const;

   311 

   312   // Return/result value from this interpreter frame

   313   // If the method return type is T_OBJECT or T_ARRAY populates oop_result

   314   // For other (non-T_VOID) the appropriate field in the jvalue is populated

   315   // with the result value.

   316   // Should only be called when at method exit when the method is not

   317   // exiting due to an exception.

   318   BasicType interpreter_frame_result(oop* oop_result, jvalue* value_result);

   319 

   320  public:

   321   // Method & constant pool cache

   322   Method* interpreter_frame_method() const;

   323   void interpreter_frame_set_method(Method* method);

   324   Method** interpreter_frame_method_addr() const;

   325   ConstantPoolCache** interpreter_frame_cache_addr() const;

   326   oop* interpreter_frame_mirror_addr() const;

   327 

   328   void interpreter_frame_set_mirror(oop mirror);

   329 

   330  public:

   331   // Entry frames

   332   JavaCallWrapper* entry_frame_call_wrapper() const { return *entry_frame_call_wrapper_addr(); }

   333   JavaCallWrapper* entry_frame_call_wrapper_if_safe(JavaThread* thread) const;

   334   JavaCallWrapper** entry_frame_call_wrapper_addr() const;

   335   intptr_t* entry_frame_argument_at(int offset) const;

   336 

   337   // tells whether there is another chunk of Delta stack above

   338   bool entry_frame_is_first() const;

   339 

   340   // Compiled frames:

   341 

   342  public:

   343   // Given the index of a local, and the number of argument words

   344   // in this stack frame, tell which word of the stack frame to find

   345   // the local in.  Arguments are stored above the ofp/rpc pair,

   346   // while other locals are stored below it.

   347   // Since monitors (BasicLock blocks) are also assigned indexes,

   348   // but may have different storage requirements, their presence

   349   // can also affect the calculation of offsets.

   350   static int local_offset_for_compiler(int local_index, int nof_args, int max_nof_locals, int max_nof_monitors);

   351 

   352   // Given the index of a monitor, etc., tell which word of the

   353   // stack frame contains the start of the BasicLock block.

   354   // Note that the local index by convention is the __higher__

   355   // of the two indexes allocated to the block.

   356   static int monitor_offset_for_compiler(int local_index, int nof_args, int max_nof_locals, int max_nof_monitors);

   357 

   358   // Tell the smallest value that local_offset_for_compiler will attain.

   359   // This is used to help determine how much stack frame to allocate.

   360   static int min_local_offset_for_compiler(int nof_args, int max_nof_locals, int max_nof_monitors);

   361 

   362   // Tells if this register must be spilled during a call.

   363   // On Intel, all registers are smashed by calls.

   364   static bool volatile_across_calls(Register reg);

   365 

   366 

   367   // Safepoints

   368 

   369  public:

   370   oop saved_oop_result(RegisterMap* map) const;

   371   void set_saved_oop_result(RegisterMap* map, oop obj);

   372 

   373   // For debugging

   374  private:

   375   const char* print_name() const;

   376 

   377   void describe_pd(FrameValues& values, int frame_no);

   378 

   379  public:

   380   void print_value() const { print_value_on(tty,NULL); }

   381   void print_value_on(outputStream* st, JavaThread *thread) const;

   382   void print_on(outputStream* st) const;

   383   void interpreter_frame_print_on(outputStream* st) const;

   384   void print_on_error(outputStream* st, char* buf, int buflen, bool verbose = false) const;

   385   static void print_C_frame(outputStream* st, char* buf, int buflen, address pc);

   386 

   387   // Add annotated descriptions of memory locations belonging to this frame to values

   388   void describe(FrameValues& values, int frame_no);

   389 

   390   // Conversion from a VMReg to physical stack location

   391   oop* oopmapreg_to_location(VMReg reg, const RegisterMap* reg_map) const;

   392 

   393   // Oops-do's

   394   void oops_compiled_arguments_do(Symbol* signature, bool has_receiver, bool has_appendix, const RegisterMap* reg_map, OopClosure* f);

   395   void oops_interpreted_do(OopClosure* f, const RegisterMap* map, bool query_oop_map_cache = true);

   396 

   397  private:

   398   void oops_interpreted_arguments_do(Symbol* signature, bool has_receiver, OopClosure* f);

   399 

   400   // Iteration of oops

   401   void oops_do_internal(OopClosure* f, CodeBlobClosure* cf, RegisterMap* map, bool use_interpreter_oop_map_cache);

   402   void oops_entry_do(OopClosure* f, const RegisterMap* map);

   403   void oops_code_blob_do(OopClosure* f, CodeBlobClosure* cf, const RegisterMap* map);

   404   int adjust_offset(Method* method, int index); // helper for above fn

   405  public:

   406   // Memory management

   407   void oops_do(OopClosure* f, CodeBlobClosure* cf, RegisterMap* map) { oops_do_internal(f, cf, map, true); }

   408   void nmethods_do(CodeBlobClosure* cf);

   409 

   410   // RedefineClasses support for finding live interpreted methods on the stack

   411   void metadata_do(void f(Metadata*));

   412 

   413   // Verification

   414   void verify(const RegisterMap* map);

   415   static bool verify_return_pc(address x);

   416   // Usage:

   417   // assert(frame::verify_return_pc(return_address), "must be a return pc");

   418 

   419   int pd_oop_map_offset_adjustment() const;

   420 

   421   NOT_PRODUCT(void pd_ps();)  // platform dependent frame printing

   422 

   423 #include CPU_HEADER(frame)

   424 

   425 };

   426 

   427 #ifndef PRODUCT

   428 // A simple class to describe a location on the stack

   429 class FrameValue VALUE_OBJ_CLASS_SPEC {

   430  public:

   431   intptr_t* location;

   432   char* description;

   433   int owner;

   434   int priority;

   435 

   436   FrameValue() {

   437     location = NULL;

   438     description = NULL;

   439     owner = -1;

   440     priority = 0;

   441   }

   442 

   443 };

   444 

   445 

   446 // A collection of described stack values that can print a symbolic

   447 // description of the stack memory.  Interpreter frame values can be

   448 // in the caller frames so all the values are collected first and then

   449 // sorted before being printed.

   450 class FrameValues {

   451  private:

   452   GrowableArray<FrameValue> _values;

   453 

   454   static int compare(FrameValue* a, FrameValue* b) {

   455     if (a->location == b->location) {

   456       return a->priority - b->priority;

   457     }

   458     return a->location - b->location;

   459   }

   460 

   461  public:

   462   // Used by frame functions to describe locations.

   463   void describe(int owner, intptr_t* location, const char* description, int priority = 0);

   464 

   465 #ifdef ASSERT

   466   void validate();

   467 #endif

   468   void print(JavaThread* thread);

   469 };

   470 

   471 #endif

   472 

   473 //

   474 // StackFrameStream iterates through the frames of a thread starting from

   475 // top most frame. It automatically takes care of updating the location of

   476 // all (callee-saved) registers. Notice: If a thread is stopped at

   477 // a safepoint, all registers are saved, not only the callee-saved ones.

   478 //

   479 // Use:

   480 //

   481 //   for(StackFrameStream fst(thread); !fst.is_done(); fst.next()) {

   482 //     ...

   483 //   }

   484 //

   485 class StackFrameStream : public StackObj {

   486  private:

   487   frame       _fr;

   488   RegisterMap _reg_map;

   489   bool        _is_done;

   490  public:

   491    StackFrameStream(JavaThread *thread, bool update = true);

   492 

   493   // Iteration

   494   bool is_done()                  { return (_is_done) ? true : (_is_done = _fr.is_first_frame(), false); }

   495   void next()                     { if (!_is_done) _fr = _fr.sender(&_reg_map); }

   496 

   497   // Query

   498   frame *current()                { return &_fr; }

   499   RegisterMap* register_map()     { return &_reg_map; }

   500 };

   501 

   502 #endif // SHARE_VM_RUNTIME_FRAME_HPP