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 #ifndef PRODUCT 72 // This is a generic constructor which is only used by pns() in debug.cpp. 73 // pns (i.e. print native stack) uses this constructor to create a starting 74 // frame for stack walking. The implementation of this constructor is platform 75 // dependent (i.e. SPARC doesn't need an 'fp' argument an will ignore it) but 76 // we want to keep the signature generic because pns() is shared code. 77 frame(void* sp, void* fp, void* pc); 78 #endif 79 80 // Accessors 81 82 // pc: Returns the pc at which this frame will continue normally. 83 // It must point at the beginning of the next instruction to execute. 84 address pc() const { return _pc; } 85 86 // This returns the pc that if you were in the debugger you'd see. Not 87 // the idealized value in the frame object. This undoes the magic conversion 88 // that happens for deoptimized frames. In addition it makes the value the 89 // hardware would want to see in the native frame. The only user (at this point) 90 // is deoptimization. It likely no one else should ever use it. 91 address raw_pc() const; 92 93 void set_pc( address newpc ); 94 95 intptr_t* sp() const { return _sp; } 96 void set_sp( intptr_t* newsp ) { _sp = newsp; } 97 98 99 CodeBlob* cb() const { return _cb; } 100 101 // patching operations 102 void patch_pc(Thread* thread, address pc); 103 104 // Every frame needs to return a unique id which distinguishes it from all other frames. 105 // For sparc and ia32 use sp. ia64 can have memory frames that are empty so multiple frames 106 // will have identical sp values. For ia64 the bsp (fp) value will serve. No real frame 107 // should have an id() of NULL so it is a distinguishing value for an unmatchable frame. 108 // We also have relationals which allow comparing a frame to anoth frame's id() allow 109 // us to distinguish younger (more recent activation) from older (less recent activations) 110 // A NULL id is only valid when comparing for equality. 111 112 intptr_t* id(void) const; 113 bool is_younger(intptr_t* id) const; 114 bool is_older(intptr_t* id) const; 115 116 // testers 117 118 // Compares for strict equality. Rarely used or needed. 119 // It can return a different result than f1.id() == f2.id() 120 bool equal(frame other) const; 121 122 // type testers 123 bool is_interpreted_frame() const; 124 bool is_java_frame() const; 125 bool is_entry_frame() const; // Java frame called from C? 126 bool is_stub_frame() const; 127 bool is_ignored_frame() const; 128 bool is_native_frame() const; 129 bool is_runtime_frame() const; 130 bool is_compiled_frame() const; 131 bool is_safepoint_blob_frame() const; 132 bool is_deoptimized_frame() const; 133 134 // testers 135 bool is_first_frame() const; // oldest frame? (has no sender) 136 bool is_first_java_frame() const; // same for Java frame 137 138 bool is_interpreted_frame_valid(JavaThread* thread) const; // performs sanity checks on interpreted frames. 139 140 // tells whether this frame is marked for deoptimization 141 bool should_be_deoptimized() const; 142 143 // tells whether this frame can be deoptimized 144 bool can_be_deoptimized() const; 145 146 // returns the frame size in stack slots 147 int frame_size(RegisterMap* map) const; 148 149 // returns the sending frame 150 frame sender(RegisterMap* map) const; 151 152 // for Profiling - acting on another frame. walks sender frames 153 // if valid. 154 frame profile_find_Java_sender_frame(JavaThread *thread); 155 bool safe_for_sender(JavaThread *thread); 156 157 // returns the sender, but skips conversion frames 158 frame real_sender(RegisterMap* map) const; 159 160 // returns the the sending Java frame, skipping any intermediate C frames 161 // NB: receiver must not be first frame 162 frame java_sender() const; 163 164 private: 165 // Helper methods for better factored code in frame::sender 166 frame sender_for_compiled_frame(RegisterMap* map) const; 167 frame sender_for_entry_frame(RegisterMap* map) const; 168 frame sender_for_interpreter_frame(RegisterMap* map) const; 169 frame sender_for_native_frame(RegisterMap* map) 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 // Tells whether the current interpreter_frame frame pointer 313 // corresponds to the old compiled/deoptimized fp 314 // The receiver used to be a top level frame 315 bool interpreter_frame_equals_unpacked_fp(intptr_t* fp); 316 317 // Return/result value from this interpreter frame 318 // If the method return type is T_OBJECT or T_ARRAY populates oop_result 319 // For other (non-T_VOID) the appropriate field in the jvalue is populated 320 // with the result value. 321 // Should only be called when at method exit when the method is not 322 // exiting due to an exception. 323 BasicType interpreter_frame_result(oop* oop_result, jvalue* value_result); 324 325 public: 326 // Method & constant pool cache 327 Method* interpreter_frame_method() const; 328 void interpreter_frame_set_method(Method* method); 329 Method** interpreter_frame_method_addr() const; 330 ConstantPoolCache** interpreter_frame_cache_addr() const; 331 332 public: 333 // Entry frames 334 JavaCallWrapper* entry_frame_call_wrapper() const { return *entry_frame_call_wrapper_addr(); } 335 JavaCallWrapper* entry_frame_call_wrapper_if_safe(JavaThread* thread) const; 336 JavaCallWrapper** entry_frame_call_wrapper_addr() const; 337 intptr_t* entry_frame_argument_at(int offset) const; 338 339 // tells whether there is another chunk of Delta stack above 340 bool entry_frame_is_first() const; 341 342 // Compiled frames: 343 344 public: 345 // Given the index of a local, and the number of argument words 346 // in this stack frame, tell which word of the stack frame to find 347 // the local in. Arguments are stored above the ofp/rpc pair, 348 // while other locals are stored below it. 349 // Since monitors (BasicLock blocks) are also assigned indexes, 350 // but may have different storage requirements, their presence 351 // can also affect the calculation of offsets. 352 static int local_offset_for_compiler(int local_index, int nof_args, int max_nof_locals, int max_nof_monitors); 353 354 // Given the index of a monitor, etc., tell which word of the 355 // stack frame contains the start of the BasicLock block. 356 // Note that the local index by convention is the __higher__ 357 // of the two indexes allocated to the block. 358 static int monitor_offset_for_compiler(int local_index, int nof_args, int max_nof_locals, int max_nof_monitors); 359 360 // Tell the smallest value that local_offset_for_compiler will attain. 361 // This is used to help determine how much stack frame to allocate. 362 static int min_local_offset_for_compiler(int nof_args, int max_nof_locals, int max_nof_monitors); 363 364 // Tells if this register must be spilled during a call. 365 // On Intel, all registers are smashed by calls. 366 static bool volatile_across_calls(Register reg); 367 368 369 // Safepoints 370 371 public: 372 oop saved_oop_result(RegisterMap* map) const; 373 void set_saved_oop_result(RegisterMap* map, oop obj); 374 375 // For debugging 376 private: 377 const char* print_name() const; 378 379 void describe_pd(FrameValues& values, int frame_no); 380 381 public: 382 void print_value() const { print_value_on(tty,NULL); } 383 void print_value_on(outputStream* st, JavaThread *thread) const; 384 void print_on(outputStream* st) const; 385 void interpreter_frame_print_on(outputStream* st) const; 386 void print_on_error(outputStream* st, char* buf, int buflen, bool verbose = false) const; 387 static void print_C_frame(outputStream* st, char* buf, int buflen, address pc); 388 389 // Add annotated descriptions of memory locations belonging to this frame to values 390 void describe(FrameValues& values, int frame_no); 391 392 // Conversion from an VMReg to physical stack location 393 oop* oopmapreg_to_location(VMReg reg, const RegisterMap* regmap) const; 394 395 // Oops-do's 396 void oops_compiled_arguments_do(Symbol* signature, bool has_receiver, bool has_appendix, const RegisterMap* reg_map, OopClosure* f); 397 void oops_interpreted_do(OopClosure* f, CLDClosure* cld_f, const RegisterMap* map, bool query_oop_map_cache = true); 398 399 private: 400 void oops_interpreted_arguments_do(Symbol* signature, bool has_receiver, OopClosure* f); 401 402 // Iteration of oops 403 void oops_do_internal(OopClosure* f, CLDClosure* cld_f, CodeBlobClosure* cf, RegisterMap* map, bool use_interpreter_oop_map_cache); 404 void oops_entry_do(OopClosure* f, const RegisterMap* map); 405 void oops_code_blob_do(OopClosure* f, CodeBlobClosure* cf, const RegisterMap* map); 406 int adjust_offset(Method* method, int index); // helper for above fn 407 public: 408 // Memory management 409 void oops_do(OopClosure* f, CLDClosure* cld_f, CodeBlobClosure* cf, RegisterMap* map) { oops_do_internal(f, cld_f, cf, map, true); } 410 void nmethods_do(CodeBlobClosure* cf); 411 412 // RedefineClasses support for finding live interpreted methods on the stack 413 void metadata_do(void f(Metadata*)); 414 415 # ifdef ENABLE_ZAP_DEAD_LOCALS 416 private: 417 class CheckValueClosure: public OopClosure { 418 public: 419 void do_oop(oop* p); 420 void do_oop(narrowOop* p) { ShouldNotReachHere(); } 421 }; 422 static CheckValueClosure _check_value; 423 424 class CheckOopClosure: public OopClosure { 425 public: 426 void do_oop(oop* p); 427 void do_oop(narrowOop* p) { ShouldNotReachHere(); } 428 }; 429 static CheckOopClosure _check_oop; 430 431 static void check_derived_oop(oop* base, oop* derived); 432 433 class ZapDeadClosure: public OopClosure { 434 public: 435 void do_oop(oop* p); 436 void do_oop(narrowOop* p) { ShouldNotReachHere(); } 437 }; 438 static ZapDeadClosure _zap_dead; 439 440 public: 441 // Zapping 442 void zap_dead_locals (JavaThread* thread, const RegisterMap* map); 443 void zap_dead_interpreted_locals(JavaThread* thread, const RegisterMap* map); 444 void zap_dead_compiled_locals (JavaThread* thread, const RegisterMap* map); 445 void zap_dead_entry_locals (JavaThread* thread, const RegisterMap* map); 446 void zap_dead_deoptimized_locals(JavaThread* thread, const RegisterMap* map); 447 # endif 448 // Verification 449 void verify(const RegisterMap* map); 450 static bool verify_return_pc(address x); 451 // Usage: 452 // assert(frame::verify_return_pc(return_address), "must be a return pc"); 453 454 int pd_oop_map_offset_adjustment() const; 455 456 #ifdef TARGET_ARCH_x86 457 # include "frame_x86.hpp" 458 #endif 459 #ifdef TARGET_ARCH_sparc 460 # include "frame_sparc.hpp" 461 #endif 462 #ifdef TARGET_ARCH_zero 463 # include "frame_zero.hpp" 464 #endif 465 #ifdef TARGET_ARCH_arm 466 # include "frame_arm.hpp" 467 #endif 468 #ifdef TARGET_ARCH_ppc 469 # include "frame_ppc.hpp" 470 #endif 471 #ifdef TARGET_ARCH_aarch64 472 # include "frame_aarch64.hpp" 473 #endif 474 475 }; 476 477 #ifndef PRODUCT 478 // A simple class to describe a location on the stack 479 class FrameValue VALUE_OBJ_CLASS_SPEC { 480 public: 481 intptr_t* location; 482 char* description; 483 int owner; 484 int priority; 485 }; 486 487 488 // A collection of described stack values that can print a symbolic 489 // description of the stack memory. Interpreter frame values can be 490 // in the caller frames so all the values are collected first and then 491 // sorted before being printed. 492 class FrameValues { 493 private: 494 GrowableArray<FrameValue> _values; 495 496 static int compare(FrameValue* a, FrameValue* b) { 497 if (a->location == b->location) { 498 return a->priority - b->priority; 499 } 500 return a->location - b->location; 501 } 502 503 public: 504 // Used by frame functions to describe locations. 505 void describe(int owner, intptr_t* location, const char* description, int priority = 0); 506 507 #ifdef ASSERT 508 void validate(); 509 #endif 510 void print(JavaThread* thread); 511 }; 512 513 #endif 514 515 // 516 // StackFrameStream iterates through the frames of a thread starting from 517 // top most frame. It automatically takes care of updating the location of 518 // all (callee-saved) registers. Notice: If a thread is stopped at 519 // a safepoint, all registers are saved, not only the callee-saved ones. 520 // 521 // Use: 522 // 523 // for(StackFrameStream fst(thread); !fst.is_done(); fst.next()) { 524 // ... 525 // } 526 // 527 class StackFrameStream : public StackObj { 528 private: 529 frame _fr; 530 RegisterMap _reg_map; 531 bool _is_done; 532 public: 533 StackFrameStream(JavaThread *thread, bool update = true); 534 535 // Iteration 536 bool is_done() { return (_is_done) ? true : (_is_done = _fr.is_first_frame(), false); } 537 void next() { if (!_is_done) _fr = _fr.sender(&_reg_map); } 538 539 // Query 540 frame *current() { return &_fr; } 541 RegisterMap* register_map() { return &_reg_map; } 542 }; 543 544 #endif // SHARE_VM_RUNTIME_FRAME_HPP