1 /*
   2  * Copyright (c) 1997, 2014, 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/top.hpp"
  33 #ifdef ZERO
  34 #ifdef TARGET_ARCH_zero
  35 # include "stack_zero.hpp"
  36 #endif
  37 #endif
  38 
  39 typedef class BytecodeInterpreter* interpreterState;
  40 
  41 class CodeBlob;
  42 class FrameValues;
  43 class vframeArray;
  44 
  45 
  46 // A frame represents a physical stack frame (an activation).  Frames
  47 // can be C or Java frames, and the Java frames can be interpreted or
  48 // compiled.  In contrast, vframes represent source-level activations,
  49 // so that one physical frame can correspond to multiple source level
  50 // frames because of inlining.
  51 
  52 class frame VALUE_OBJ_CLASS_SPEC {
  53  private:
  54   // Instance variables:
  55   intptr_t* _sp; // stack pointer (from Thread::last_Java_sp)
  56   address   _pc; // program counter (the next instruction after the call)
  57 
  58   CodeBlob* _cb; // CodeBlob that "owns" pc
  59   enum deopt_state {
  60     not_deoptimized,
  61     is_deoptimized,
  62     unknown
  63   };
  64 
  65   deopt_state _deopt_state;
  66 
  67  public:
  68   // Constructors
  69   frame();
  70 
  71   // Accessors
  72 
  73   // pc: Returns the pc at which this frame will continue normally.
  74   // It must point at the beginning of the next instruction to execute.
  75   address pc() const             { return _pc; }
  76 
  77   // This returns the pc that if you were in the debugger you'd see. Not
  78   // the idealized value in the frame object. This undoes the magic conversion
  79   // that happens for deoptimized frames. In addition it makes the value the
  80   // hardware would want to see in the native frame. The only user (at this point)
  81   // is deoptimization. It likely no one else should ever use it.
  82   address raw_pc() const;
  83 
  84   void set_pc( address   newpc );
  85 
  86   intptr_t* sp() const           { return _sp; }
  87   void set_sp( intptr_t* newsp ) { _sp = newsp; }
  88 
  89 
  90   CodeBlob* cb() const           { return _cb; }
  91 
  92   // patching operations
  93   void   patch_pc(Thread* thread, address pc);
  94 
  95   // Every frame needs to return a unique id which distinguishes it from all other frames.
  96   // For sparc and ia32 use sp. ia64 can have memory frames that are empty so multiple frames
  97   // will have identical sp values. For ia64 the bsp (fp) value will serve. No real frame
  98   // should have an id() of NULL so it is a distinguishing value for an unmatchable frame.
  99   // We also have relationals which allow comparing a frame to anoth frame's id() allow
 100   // us to distinguish younger (more recent activation) from older (less recent activations)
 101   // A NULL id is only valid when comparing for equality.
 102 
 103   intptr_t* id(void) const;
 104   bool is_younger(intptr_t* id) const;
 105   bool is_older(intptr_t* id) const;
 106 
 107   // testers
 108 
 109   // Compares for strict equality. Rarely used or needed.
 110   // It can return a different result than f1.id() == f2.id()
 111   bool equal(frame other) const;
 112 
 113   // type testers
 114   bool is_interpreted_frame()    const;
 115   bool is_java_frame()           const;
 116   bool is_entry_frame()          const;             // Java frame called from C?
 117   bool is_stub_frame()           const;
 118   bool is_ignored_frame()        const;
 119   bool is_native_frame()         const;
 120   bool is_runtime_frame()        const;
 121   bool is_compiled_frame()       const;
 122   bool is_safepoint_blob_frame() const;
 123   bool is_deoptimized_frame()    const;
 124 
 125   // testers
 126   bool is_first_frame() const; // oldest frame? (has no sender)
 127   bool is_first_java_frame() const;              // same for Java frame
 128 
 129   bool is_interpreted_frame_valid(JavaThread* thread) const;       // performs sanity checks on interpreted frames.
 130 
 131   // tells whether this frame is marked for deoptimization
 132   bool should_be_deoptimized() const;
 133 
 134   // tells whether this frame can be deoptimized
 135   bool can_be_deoptimized() const;
 136 
 137   // returns the frame size in stack slots
 138   int frame_size(RegisterMap* map) const;
 139 
 140   // returns the sending frame
 141   frame sender(RegisterMap* map) const;
 142 
 143   // for Profiling - acting on another frame. walks sender frames
 144   // if valid.
 145   frame profile_find_Java_sender_frame(JavaThread *thread);
 146   bool safe_for_sender(JavaThread *thread);
 147 
 148   // returns the sender, but skips conversion frames
 149   frame real_sender(RegisterMap* map) const;
 150 
 151   // returns the the sending Java frame, skipping any intermediate C frames
 152   // NB: receiver must not be first frame
 153   frame java_sender() const;
 154 
 155  private:
 156   // Helper methods for better factored code in frame::sender
 157   frame sender_for_compiled_frame(RegisterMap* map) const;
 158   frame sender_for_entry_frame(RegisterMap* map) const;
 159   frame sender_for_interpreter_frame(RegisterMap* map) const;
 160   frame sender_for_native_frame(RegisterMap* map) const;
 161 
 162   // All frames:
 163 
 164   // A low-level interface for vframes:
 165 
 166  public:
 167 
 168   intptr_t* addr_at(int index) const             { return &fp()[index];    }
 169   intptr_t  at(int index) const                  { return *addr_at(index); }
 170 
 171   // accessors for locals
 172   oop obj_at(int offset) const                   { return *obj_at_addr(offset);  }
 173   void obj_at_put(int offset, oop value)         { *obj_at_addr(offset) = value; }
 174 
 175   jint int_at(int offset) const                  { return *int_at_addr(offset);  }
 176   void int_at_put(int offset, jint value)        { *int_at_addr(offset) = value; }
 177 
 178   oop*      obj_at_addr(int offset) const        { return (oop*)     addr_at(offset); }
 179 
 180   oop*      adjusted_obj_at_addr(Method* method, int index) { return obj_at_addr(adjust_offset(method, index)); }
 181 
 182  private:
 183   jint*    int_at_addr(int offset) const         { return (jint*)    addr_at(offset); }
 184 
 185  public:
 186   // Link (i.e., the pointer to the previous frame)
 187   intptr_t* link() const;
 188   void set_link(intptr_t* addr);
 189 
 190   // Return address
 191   address  sender_pc() const;
 192 
 193   // Support for deoptimization
 194   void deoptimize(JavaThread* thread);
 195 
 196   // The frame's original SP, before any extension by an interpreted callee;
 197   // used for packing debug info into vframeArray objects and vframeArray lookup.
 198   intptr_t* unextended_sp() const;
 199 
 200   // returns the stack pointer of the calling frame
 201   intptr_t* sender_sp() const;
 202 
 203   // Returns the real 'frame pointer' for the current frame.
 204   // This is the value expected by the platform ABI when it defines a
 205   // frame pointer register. It may differ from the effective value of
 206   // the FP register when that register is used in the JVM for other
 207   // purposes (like compiled frames on some platforms).
 208   // On other platforms, it is defined so that the stack area used by
 209   // this frame goes from real_fp() to sp().
 210   intptr_t* real_fp() const;
 211 
 212   // Deoptimization info, if needed (platform dependent).
 213   // Stored in the initial_info field of the unroll info, to be used by
 214   // the platform dependent deoptimization blobs.
 215   intptr_t *initial_deoptimization_info();
 216 
 217   // Interpreter frames:
 218 
 219  private:
 220   intptr_t** interpreter_frame_locals_addr() const;
 221   intptr_t*  interpreter_frame_bcp_addr() const;
 222   intptr_t*  interpreter_frame_mdp_addr() const;
 223 
 224  public:
 225   // Locals
 226 
 227   // The _at version returns a pointer because the address is used for GC.
 228   intptr_t* interpreter_frame_local_at(int index) const;
 229 
 230   void interpreter_frame_set_locals(intptr_t* locs);
 231 
 232   // byte code index
 233   jint interpreter_frame_bci() const;
 234 
 235   // byte code pointer
 236   address interpreter_frame_bcp() const;
 237   void    interpreter_frame_set_bcp(address bcp);
 238 
 239   // method data pointer
 240   address interpreter_frame_mdp() const;
 241   void    interpreter_frame_set_mdp(address dp);
 242 
 243   // Find receiver out of caller's (compiled) argument list
 244   oop retrieve_receiver(RegisterMap *reg_map);
 245 
 246   // Return the monitor owner and BasicLock for compiled synchronized
 247   // native methods so that biased locking can revoke the receiver's
 248   // bias if necessary.  This is also used by JVMTI's GetLocalInstance method
 249   // (via VM_GetReceiver) to retrieve the receiver from a native wrapper frame.
 250   BasicLock* get_native_monitor();
 251   oop        get_native_receiver();
 252 
 253   // Find receiver for an invoke when arguments are just pushed on stack (i.e., callee stack-frame is
 254   // not setup)
 255   oop interpreter_callee_receiver(Symbol* signature)     { return *interpreter_callee_receiver_addr(signature); }
 256 
 257 
 258   oop* interpreter_callee_receiver_addr(Symbol* signature);
 259 
 260 
 261   // expression stack (may go up or down, direction == 1 or -1)
 262  public:
 263   intptr_t* interpreter_frame_expression_stack() const;
 264   static  jint  interpreter_frame_expression_stack_direction();
 265 
 266   // The _at version returns a pointer because the address is used for GC.
 267   intptr_t* interpreter_frame_expression_stack_at(jint offset) const;
 268 
 269   // top of expression stack
 270   intptr_t* interpreter_frame_tos_at(jint offset) const;
 271   intptr_t* interpreter_frame_tos_address() const;
 272 
 273 
 274   jint  interpreter_frame_expression_stack_size() const;
 275 
 276   intptr_t* interpreter_frame_sender_sp() const;
 277 
 278 #ifndef CC_INTERP
 279   // template based interpreter deoptimization support
 280   void  set_interpreter_frame_sender_sp(intptr_t* sender_sp);
 281   void interpreter_frame_set_monitor_end(BasicObjectLock* value);
 282 #endif // CC_INTERP
 283 
 284   // Address of the temp oop in the frame. Needed as GC root.
 285   oop* interpreter_frame_temp_oop_addr() const;
 286 
 287   // BasicObjectLocks:
 288   //
 289   // interpreter_frame_monitor_begin is higher in memory than interpreter_frame_monitor_end
 290   // Interpreter_frame_monitor_begin points to one element beyond the oldest one,
 291   // interpreter_frame_monitor_end   points to the youngest one, or if there are none,
 292   //                                 it points to one beyond where the first element will be.
 293   // interpreter_frame_monitor_size  reports the allocation size of a monitor in the interpreter stack.
 294   //                                 this value is >= BasicObjectLock::size(), and may be rounded up
 295 
 296   BasicObjectLock* interpreter_frame_monitor_begin() const;
 297   BasicObjectLock* interpreter_frame_monitor_end()   const;
 298   BasicObjectLock* next_monitor_in_interpreter_frame(BasicObjectLock* current) const;
 299   BasicObjectLock* previous_monitor_in_interpreter_frame(BasicObjectLock* current) const;
 300   static int interpreter_frame_monitor_size();
 301 
 302   void interpreter_frame_verify_monitor(BasicObjectLock* value) const;
 303 
 304   // Tells whether the current interpreter_frame frame pointer
 305   // corresponds to the old compiled/deoptimized fp
 306   // The receiver used to be a top level frame
 307   bool interpreter_frame_equals_unpacked_fp(intptr_t* fp);
 308 
 309   // Return/result value from this interpreter frame
 310   // If the method return type is T_OBJECT or T_ARRAY populates oop_result
 311   // For other (non-T_VOID) the appropriate field in the jvalue is populated
 312   // with the result value.
 313   // Should only be called when at method exit when the method is not
 314   // exiting due to an exception.
 315   BasicType interpreter_frame_result(oop* oop_result, jvalue* value_result);
 316 
 317  public:
 318   // Method & constant pool cache
 319   Method* interpreter_frame_method() const;
 320   void interpreter_frame_set_method(Method* method);
 321   Method** interpreter_frame_method_addr() const;
 322   ConstantPoolCache** interpreter_frame_cache_addr() const;
 323 
 324  public:
 325   // Entry frames
 326   JavaCallWrapper* entry_frame_call_wrapper() const { return *entry_frame_call_wrapper_addr(); }
 327   JavaCallWrapper* entry_frame_call_wrapper_if_safe(JavaThread* thread) const;
 328   JavaCallWrapper** entry_frame_call_wrapper_addr() const;
 329   intptr_t* entry_frame_argument_at(int offset) const;
 330 
 331   // tells whether there is another chunk of Delta stack above
 332   bool entry_frame_is_first() const;
 333 
 334   // Compiled frames:
 335 
 336  public:
 337   // Given the index of a local, and the number of argument words
 338   // in this stack frame, tell which word of the stack frame to find
 339   // the local in.  Arguments are stored above the ofp/rpc pair,
 340   // while other locals are stored below it.
 341   // Since monitors (BasicLock blocks) are also assigned indexes,
 342   // but may have different storage requirements, their presence
 343   // can also affect the calculation of offsets.
 344   static int local_offset_for_compiler(int local_index, int nof_args, int max_nof_locals, int max_nof_monitors);
 345 
 346   // Given the index of a monitor, etc., tell which word of the
 347   // stack frame contains the start of the BasicLock block.
 348   // Note that the local index by convention is the __higher__
 349   // of the two indexes allocated to the block.
 350   static int monitor_offset_for_compiler(int local_index, int nof_args, int max_nof_locals, int max_nof_monitors);
 351 
 352   // Tell the smallest value that local_offset_for_compiler will attain.
 353   // This is used to help determine how much stack frame to allocate.
 354   static int min_local_offset_for_compiler(int nof_args, int max_nof_locals, int max_nof_monitors);
 355 
 356   // Tells if this register must be spilled during a call.
 357   // On Intel, all registers are smashed by calls.
 358   static bool volatile_across_calls(Register reg);
 359 
 360 
 361   // Safepoints
 362 
 363  public:
 364   oop saved_oop_result(RegisterMap* map) const;
 365   void set_saved_oop_result(RegisterMap* map, oop obj);
 366 
 367   // For debugging
 368  private:
 369   const char* print_name() const;
 370 
 371   void describe_pd(FrameValues& values, int frame_no);
 372 
 373  public:
 374   void print_value() const { print_value_on(tty,NULL); }
 375   void print_value_on(outputStream* st, JavaThread *thread) const;
 376   void print_on(outputStream* st) const;
 377   void interpreter_frame_print_on(outputStream* st) const;
 378   void print_on_error(outputStream* st, char* buf, int buflen, bool verbose = false) const;
 379   static void print_C_frame(outputStream* st, char* buf, int buflen, address pc);
 380 
 381   // Add annotated descriptions of memory locations belonging to this frame to values
 382   void describe(FrameValues& values, int frame_no);
 383 
 384   // Conversion from an VMReg to physical stack location
 385   oop* oopmapreg_to_location(VMReg reg, const RegisterMap* regmap) const;
 386 
 387   // Oops-do's
 388   void oops_compiled_arguments_do(Symbol* signature, bool has_receiver, bool has_appendix, const RegisterMap* reg_map, OopClosure* f);
 389   void oops_interpreted_do(OopClosure* f, CLDClosure* cld_f, const RegisterMap* map, bool query_oop_map_cache = true);
 390 
 391  private:
 392   void oops_interpreted_arguments_do(Symbol* signature, bool has_receiver, OopClosure* f);
 393 
 394   // Iteration of oops
 395   void oops_do_internal(OopClosure* f, CLDClosure* cld_f, CodeBlobClosure* cf, RegisterMap* map, bool use_interpreter_oop_map_cache);
 396   void oops_entry_do(OopClosure* f, const RegisterMap* map);
 397   void oops_code_blob_do(OopClosure* f, CodeBlobClosure* cf, const RegisterMap* map);
 398   int adjust_offset(Method* method, int index); // helper for above fn
 399  public:
 400   // Memory management
 401   void oops_do(OopClosure* f, CLDClosure* cld_f, CodeBlobClosure* cf, RegisterMap* map) { oops_do_internal(f, cld_f, cf, map, true); }
 402   void nmethods_do(CodeBlobClosure* cf);
 403 
 404   // RedefineClasses support for finding live interpreted methods on the stack
 405   void metadata_do(void f(Metadata*));
 406 
 407 # ifdef ENABLE_ZAP_DEAD_LOCALS
 408  private:
 409   class CheckValueClosure: public OopClosure {
 410    public:
 411     void do_oop(oop* p);
 412     void do_oop(narrowOop* p) { ShouldNotReachHere(); }
 413   };
 414   static CheckValueClosure _check_value;
 415 
 416   class CheckOopClosure: public OopClosure {
 417    public:
 418     void do_oop(oop* p);
 419     void do_oop(narrowOop* p) { ShouldNotReachHere(); }
 420   };
 421   static CheckOopClosure _check_oop;
 422 
 423   static void check_derived_oop(oop* base, oop* derived);
 424 
 425   class ZapDeadClosure: public OopClosure {
 426    public:
 427     void do_oop(oop* p);
 428     void do_oop(narrowOop* p) { ShouldNotReachHere(); }
 429   };
 430   static ZapDeadClosure _zap_dead;
 431 
 432  public:
 433   // Zapping
 434   void zap_dead_locals            (JavaThread* thread, const RegisterMap* map);
 435   void zap_dead_interpreted_locals(JavaThread* thread, const RegisterMap* map);
 436   void zap_dead_compiled_locals   (JavaThread* thread, const RegisterMap* map);
 437   void zap_dead_entry_locals      (JavaThread* thread, const RegisterMap* map);
 438   void zap_dead_deoptimized_locals(JavaThread* thread, const RegisterMap* map);
 439 # endif
 440   // Verification
 441   void verify(const RegisterMap* map);
 442   static bool verify_return_pc(address x);
 443   // Usage:
 444   // assert(frame::verify_return_pc(return_address), "must be a return pc");
 445 
 446   int pd_oop_map_offset_adjustment() const;
 447 
 448 #ifdef TARGET_ARCH_x86
 449 # include "frame_x86.hpp"
 450 #endif
 451 #ifdef TARGET_ARCH_sparc
 452 # include "frame_sparc.hpp"
 453 #endif
 454 #ifdef TARGET_ARCH_zero
 455 # include "frame_zero.hpp"
 456 #endif
 457 #ifdef TARGET_ARCH_arm
 458 # include "frame_arm.hpp"
 459 #endif
 460 #ifdef TARGET_ARCH_ppc
 461 # include "frame_ppc.hpp"
 462 #endif
 463 
 464 };
 465 
 466 #ifndef PRODUCT
 467 // A simple class to describe a location on the stack
 468 class FrameValue VALUE_OBJ_CLASS_SPEC {
 469  public:
 470   intptr_t* location;
 471   char* description;
 472   int owner;
 473   int priority;
 474 };
 475 
 476 
 477 // A collection of described stack values that can print a symbolic
 478 // description of the stack memory.  Interpreter frame values can be
 479 // in the caller frames so all the values are collected first and then
 480 // sorted before being printed.
 481 class FrameValues {
 482  private:
 483   GrowableArray<FrameValue> _values;
 484 
 485   static int compare(FrameValue* a, FrameValue* b) {
 486     if (a->location == b->location) {
 487       return a->priority - b->priority;
 488     }
 489     return a->location - b->location;
 490   }
 491 
 492  public:
 493   // Used by frame functions to describe locations.
 494   void describe(int owner, intptr_t* location, const char* description, int priority = 0);
 495 
 496 #ifdef ASSERT
 497   void validate();
 498 #endif
 499   void print(JavaThread* thread);
 500 };
 501 
 502 #endif
 503 
 504 //
 505 // StackFrameStream iterates through the frames of a thread starting from
 506 // top most frame. It automatically takes care of updating the location of
 507 // all (callee-saved) registers. Notice: If a thread is stopped at
 508 // a safepoint, all registers are saved, not only the callee-saved ones.
 509 //
 510 // Use:
 511 //
 512 //   for(StackFrameStream fst(thread); !fst.is_done(); fst.next()) {
 513 //     ...
 514 //   }
 515 //
 516 class StackFrameStream : public StackObj {
 517  private:
 518   frame       _fr;
 519   RegisterMap _reg_map;
 520   bool        _is_done;
 521  public:
 522    StackFrameStream(JavaThread *thread, bool update = true);
 523 
 524   // Iteration
 525   bool is_done()                  { return (_is_done) ? true : (_is_done = _fr.is_first_frame(), false); }
 526   void next()                     { if (!_is_done) _fr = _fr.sender(&_reg_map); }
 527 
 528   // Query
 529   frame *current()                { return &_fr; }
 530   RegisterMap* register_map()     { return &_reg_map; }
 531 };
 532 
 533 #endif // SHARE_VM_RUNTIME_FRAME_HPP