1 /* 2 * Copyright (c) 1997, 2018, 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 { 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 void set_pc_preserve_deopt( address newpc ); 93 94 intptr_t* sp() const { return _sp; } 95 void set_sp( intptr_t* newsp ) { _sp = newsp; } 96 97 98 CodeBlob* cb() const { return _cb; } 99 100 // patching operations 101 void patch_pc(Thread* thread, address pc); 102 103 // Every frame needs to return a unique id which distinguishes it from all other frames. 104 // For sparc and ia32 use sp. ia64 can have memory frames that are empty so multiple frames 105 // will have identical sp values. For ia64 the bsp (fp) value will serve. No real frame 106 // should have an id() of NULL so it is a distinguishing value for an unmatchable frame. 107 // We also have relationals which allow comparing a frame to anoth frame's id() allow 108 // us to distinguish younger (more recent activation) from older (less recent activations) 109 // A NULL id is only valid when comparing for equality. 110 111 intptr_t* id(void) const; 112 bool is_younger(intptr_t* id) const; 113 bool is_older(intptr_t* id) const; 114 115 // testers 116 117 // Compares for strict equality. Rarely used or needed. 118 // It can return a different result than f1.id() == f2.id() 119 bool equal(frame other) const; 120 121 // type testers 122 bool is_interpreted_frame() const; 123 bool is_java_frame() const; 124 bool is_entry_frame() const; // Java frame called from C? 125 bool is_stub_frame() const; 126 bool is_ignored_frame() const; 127 bool is_native_frame() const; 128 bool is_runtime_frame() const; 129 bool is_compiled_frame() const; 130 bool is_safepoint_blob_frame() const; 131 bool is_deoptimized_frame() const; 132 133 // testers 134 bool is_first_frame() const; // oldest frame? (has no sender) 135 bool is_first_java_frame() const; // same for Java frame 136 137 bool is_interpreted_frame_valid(JavaThread* thread) const; // performs sanity checks on interpreted frames. 138 139 // tells whether this frame is marked for deoptimization 140 bool should_be_deoptimized() const; 141 142 // tells whether this frame can be deoptimized 143 bool can_be_deoptimized() const; 144 145 // returns the frame size in stack slots 146 int frame_size(RegisterMap* map) const; 147 148 // returns the sending frame 149 frame sender(RegisterMap* map) const; 150 151 // for Profiling - acting on another frame. walks sender frames 152 // if valid. 153 frame profile_find_Java_sender_frame(JavaThread *thread); 154 bool safe_for_sender(JavaThread *thread); 155 156 // returns the sender, but skips conversion frames 157 frame real_sender(RegisterMap* map) const; 158 159 // returns the the sending Java frame, skipping any intermediate C frames 160 // NB: receiver must not be first frame 161 frame java_sender() const; 162 163 private: 164 // Helper methods for better factored code in frame::sender 165 frame sender_for_compiled_frame(RegisterMap* map) const; 166 frame sender_for_entry_frame(RegisterMap* map) const; 167 frame sender_for_interpreter_frame(RegisterMap* map) const; 168 frame sender_for_native_frame(RegisterMap* map) const; 169 170 bool is_entry_frame_valid(JavaThread* thread) const; 171 172 // All frames: 173 174 // A low-level interface for vframes: 175 176 public: 177 178 intptr_t* addr_at(int index) const { return &fp()[index]; } 179 intptr_t at(int index) const { return *addr_at(index); } 180 181 // accessors for locals 182 oop obj_at(int offset) const { return *obj_at_addr(offset); } 183 void obj_at_put(int offset, oop value) { *obj_at_addr(offset) = value; } 184 185 jint int_at(int offset) const { return *int_at_addr(offset); } 186 void int_at_put(int offset, jint value) { *int_at_addr(offset) = value; } 187 188 oop* obj_at_addr(int offset) const { return (oop*) addr_at(offset); } 189 190 oop* adjusted_obj_at_addr(Method* method, int index) { return obj_at_addr(adjust_offset(method, index)); } 191 192 private: 193 jint* int_at_addr(int offset) const { return (jint*) addr_at(offset); } 194 195 public: 196 // Link (i.e., the pointer to the previous frame) 197 intptr_t* link() const; 198 199 // Return address 200 address sender_pc() const; 201 202 // Support for deoptimization 203 void deoptimize(JavaThread* thread); 204 205 // The frame's original SP, before any extension by an interpreted callee; 206 // used for packing debug info into vframeArray objects and vframeArray lookup. 207 intptr_t* unextended_sp() const; 208 209 // returns the stack pointer of the calling frame 210 intptr_t* sender_sp() const; 211 212 // Returns the real 'frame pointer' for the current frame. 213 // This is the value expected by the platform ABI when it defines a 214 // frame pointer register. It may differ from the effective value of 215 // the FP register when that register is used in the JVM for other 216 // purposes (like compiled frames on some platforms). 217 // On other platforms, it is defined so that the stack area used by 218 // this frame goes from real_fp() to sp(). 219 intptr_t* real_fp() const; 220 221 // Deoptimization info, if needed (platform dependent). 222 // Stored in the initial_info field of the unroll info, to be used by 223 // the platform dependent deoptimization blobs. 224 intptr_t *initial_deoptimization_info(); 225 226 // Interpreter frames: 227 228 private: 229 intptr_t** interpreter_frame_locals_addr() const; 230 intptr_t* interpreter_frame_bcp_addr() const; 231 intptr_t* interpreter_frame_mdp_addr() const; 232 233 public: 234 // Locals 235 236 // The _at version returns a pointer because the address is used for GC. 237 intptr_t* interpreter_frame_local_at(int index) const; 238 239 void interpreter_frame_set_locals(intptr_t* locs); 240 241 // byte code index 242 jint interpreter_frame_bci() const; 243 244 // byte code pointer 245 address interpreter_frame_bcp() const; 246 void interpreter_frame_set_bcp(address bcp); 247 248 // method data pointer 249 address interpreter_frame_mdp() const; 250 void interpreter_frame_set_mdp(address dp); 251 252 // Find receiver out of caller's (compiled) argument list 253 oop retrieve_receiver(RegisterMap *reg_map); 254 255 // Return the monitor owner and BasicLock for compiled synchronized 256 // native methods so that biased locking can revoke the receiver's 257 // bias if necessary. This is also used by JVMTI's GetLocalInstance method 258 // (via VM_GetReceiver) to retrieve the receiver from a native wrapper frame. 259 BasicLock* get_native_monitor(); 260 oop get_native_receiver(); 261 262 // Find receiver for an invoke when arguments are just pushed on stack (i.e., callee stack-frame is 263 // not setup) 264 oop interpreter_callee_receiver(Symbol* signature) { return *interpreter_callee_receiver_addr(signature); } 265 266 267 oop* interpreter_callee_receiver_addr(Symbol* signature); 268 269 270 // expression stack (may go up or down, direction == 1 or -1) 271 public: 272 intptr_t* interpreter_frame_expression_stack() const; 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 // Safepoints 341 342 public: 343 oop saved_oop_result(RegisterMap* map) const; 344 void set_saved_oop_result(RegisterMap* map, oop obj); 345 346 // For debugging 347 private: 348 const char* print_name() const; 349 350 void describe_pd(FrameValues& values, int frame_no); 351 352 public: 353 void print_value() const { print_value_on(tty,NULL); } 354 void print_value_on(outputStream* st, JavaThread *thread) const; 355 void print_on(outputStream* st) const; 356 void interpreter_frame_print_on(outputStream* st) const; 357 void print_on_error(outputStream* st, char* buf, int buflen, bool verbose = false) const; 358 static void print_C_frame(outputStream* st, char* buf, int buflen, address pc); 359 360 // Add annotated descriptions of memory locations belonging to this frame to values 361 void describe(FrameValues& values, int frame_no); 362 363 // Conversion from a VMReg to physical stack location 364 oop* oopmapreg_to_location(VMReg reg, const RegisterMap* reg_map) const; 365 366 // Oops-do's 367 void oops_compiled_arguments_do(Symbol* signature, bool has_receiver, bool has_appendix, const RegisterMap* reg_map, OopClosure* f); 368 void oops_interpreted_do(OopClosure* f, const RegisterMap* map, bool query_oop_map_cache = true); 369 370 private: 371 void oops_interpreted_arguments_do(Symbol* signature, bool has_receiver, OopClosure* f); 372 373 // Iteration of oops 374 void oops_do_internal(OopClosure* f, CodeBlobClosure* cf, DerivedOopClosure* df, RegisterMap* map, bool use_interpreter_oop_map_cache); 375 void oops_entry_do(OopClosure* f, const RegisterMap* map); 376 void oops_code_blob_do(OopClosure* f, CodeBlobClosure* cf, DerivedOopClosure* df, const RegisterMap* map); 377 int adjust_offset(Method* method, int index); // helper for above fn 378 public: 379 // Memory management 380 void oops_do(OopClosure* f, CodeBlobClosure* cf, RegisterMap* map) { oops_do_internal(f, cf, NULL, map, true); } 381 void oops_do(OopClosure* f, CodeBlobClosure* cf, DerivedOopClosure* df, RegisterMap* map) { oops_do_internal(f, cf, df, map, true); } 382 void nmethods_do(CodeBlobClosure* cf); 383 384 // RedefineClasses support for finding live interpreted methods on the stack 385 void metadata_do(void f(Metadata*)); 386 387 // Verification 388 void verify(const RegisterMap* map); 389 static bool verify_return_pc(address x); 390 // Usage: 391 // assert(frame::verify_return_pc(return_address), "must be a return pc"); 392 393 NOT_PRODUCT(void pd_ps();) // platform dependent frame printing 394 395 #include CPU_HEADER(frame) 396 397 }; 398 399 #ifndef PRODUCT 400 // A simple class to describe a location on the stack 401 class FrameValue { 402 public: 403 intptr_t* location; 404 char* description; 405 int owner; 406 int priority; 407 408 FrameValue() { 409 location = NULL; 410 description = NULL; 411 owner = -1; 412 priority = 0; 413 } 414 415 }; 416 417 418 // A collection of described stack values that can print a symbolic 419 // description of the stack memory. Interpreter frame values can be 420 // in the caller frames so all the values are collected first and then 421 // sorted before being printed. 422 class FrameValues { 423 private: 424 GrowableArray<FrameValue> _values; 425 426 static int compare(FrameValue* a, FrameValue* b) { 427 if (a->location == b->location) { 428 return a->priority - b->priority; 429 } 430 return a->location - b->location; 431 } 432 433 public: 434 // Used by frame functions to describe locations. 435 void describe(int owner, intptr_t* location, const char* description, int priority = 0); 436 437 #ifdef ASSERT 438 void validate(); 439 #endif 440 void print(JavaThread* thread); 441 }; 442 443 #endif 444 445 // 446 // StackFrameStream iterates through the frames of a thread starting from 447 // top most frame. It automatically takes care of updating the location of 448 // all (callee-saved) registers. Notice: If a thread is stopped at 449 // a safepoint, all registers are saved, not only the callee-saved ones. 450 // 451 // Use: 452 // 453 // for(StackFrameStream fst(thread); !fst.is_done(); fst.next()) { 454 // ... 455 // } 456 // 457 class StackFrameStream : public StackObj { 458 private: 459 frame _fr; 460 RegisterMap _reg_map; 461 bool _is_done; 462 public: 463 StackFrameStream(JavaThread *thread, bool update = true); 464 465 // Iteration 466 inline bool is_done(); 467 void next() { if (!_is_done) _fr = _fr.sender(&_reg_map); } 468 469 // Query 470 frame *current() { return &_fr; } 471 RegisterMap* register_map() { return &_reg_map; } 472 }; 473 474 #endif // SHARE_VM_RUNTIME_FRAME_HPP