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