frame.hpp revision 196:d1605aabd0a1
1274955Ssvnmir/* 2274955Ssvnmir * Copyright 1997-2008 Sun Microsystems, Inc. All Rights Reserved. 3274955Ssvnmir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4274955Ssvnmir * 5274955Ssvnmir * This code is free software; you can redistribute it and/or modify it 6274955Ssvnmir * under the terms of the GNU General Public License version 2 only, as 7274955Ssvnmir * published by the Free Software Foundation. 8274955Ssvnmir * 9274955Ssvnmir * This code is distributed in the hope that it will be useful, but WITHOUT 10274955Ssvnmir * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 11274955Ssvnmir * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 12274955Ssvnmir * version 2 for more details (a copy is included in the LICENSE file that 13274955Ssvnmir * accompanied this code). 14274955Ssvnmir * 15274955Ssvnmir * You should have received a copy of the GNU General Public License version 16274955Ssvnmir * 2 along with this work; if not, write to the Free Software Foundation, 17274955Ssvnmir * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 18274955Ssvnmir * 19274955Ssvnmir * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, 20274955Ssvnmir * CA 95054 USA or visit www.sun.com if you need additional information or 21274955Ssvnmir * have any questions. 22288943Sdim * 23288943Sdim */ 24288943Sdim 25274955Ssvnmirtypedef class BytecodeInterpreter* interpreterState; 26274955Ssvnmir 27274955Ssvnmirclass CodeBlob; 28274955Ssvnmir 29296417Sdim 30296417Sdim// A frame represents a physical stack frame (an activation). Frames 31296417Sdim// can be C or Java frames, and the Java frames can be interpreted or 32274955Ssvnmir// compiled. In contrast, vframes represent source-level activations, 33296417Sdim// so that one physical frame can correspond to multiple source level 34296417Sdim// frames because of inlining. 35296417Sdim 36274955Ssvnmirclass frame VALUE_OBJ_CLASS_SPEC { 37274955Ssvnmir private: 38296417Sdim // Instance variables: 39274955Ssvnmir intptr_t* _sp; // stack pointer (from Thread::last_Java_sp) 40280031Sdim address _pc; // program counter (the next instruction after the call) 41274955Ssvnmir 42274955Ssvnmir CodeBlob* _cb; // CodeBlob that "owns" pc 43274955Ssvnmir enum deopt_state { 44274955Ssvnmir not_deoptimized, 45274955Ssvnmir is_deoptimized, 46274955Ssvnmir unknown 47274955Ssvnmir }; 48274955Ssvnmir 49274955Ssvnmir deopt_state _deopt_state; 50296417Sdim 51296417Sdim public: 52296417Sdim // Constructors 53296417Sdim frame(); 54296417Sdim 55296417Sdim // Accessors 56296417Sdim 57296417Sdim // pc: Returns the pc at which this frame will continue normally. 58296417Sdim // It must point at the beginning of the next instruction to execute. 59296417Sdim address pc() const { return _pc; } 60296417Sdim 61296417Sdim // This returns the pc that if you were in the debugger you'd see. Not 62296417Sdim // the idealized value in the frame object. This undoes the magic conversion 63296417Sdim // that happens for deoptimized frames. In addition it makes the value the 64296417Sdim // hardware would want to see in the native frame. The only user (at this point) 65296417Sdim // is deoptimization. It likely no one else should ever use it. 66296417Sdim address raw_pc() const; 67296417Sdim 68296417Sdim void set_pc( address newpc ); 69296417Sdim 70296417Sdim intptr_t* sp() const { return _sp; } 71296417Sdim void set_sp( intptr_t* newsp ) { _sp = newsp; } 72274955Ssvnmir 73274955Ssvnmir 74274955Ssvnmir CodeBlob* cb() const { return _cb; } 75274955Ssvnmir 76296417Sdim // patching operations 77274955Ssvnmir void patch_pc(Thread* thread, address pc); 78296417Sdim 79296417Sdim // Every frame needs to return a unique id which distinguishes it from all other frames. 80296417Sdim // For sparc and ia32 use sp. ia64 can have memory frames that are empty so multiple frames 81274955Ssvnmir // will have identical sp values. For ia64 the bsp (fp) value will serve. No real frame 82296417Sdim // should have an id() of NULL so it is a distinguishing value for an unmatchable frame. 83274955Ssvnmir // We also have relationals which allow comparing a frame to anoth frame's id() allow 84296417Sdim // us to distinguish younger (more recent activation) from older (less recent activations) 85296417Sdim // A NULL id is only valid when comparing for equality. 86274955Ssvnmir 87274955Ssvnmir intptr_t* id(void) const; 88274955Ssvnmir bool is_younger(intptr_t* id) const; 89274955Ssvnmir bool is_older(intptr_t* id) const; 90274955Ssvnmir 91274955Ssvnmir // testers 92274955Ssvnmir 93274955Ssvnmir // Compares for strict equality. Rarely used or needed. 94274955Ssvnmir // It can return a different result than f1.id() == f2.id() 95274955Ssvnmir bool equal(frame other) const; 96274955Ssvnmir 97274955Ssvnmir // type testers 98274955Ssvnmir bool is_interpreted_frame() const; 99274955Ssvnmir bool is_java_frame() const; 100274955Ssvnmir bool is_entry_frame() const; // Java frame called from C? 101274955Ssvnmir bool is_native_frame() const; 102274955Ssvnmir bool is_runtime_frame() const; 103274955Ssvnmir bool is_compiled_frame() const; 104274955Ssvnmir bool is_safepoint_blob_frame() const; 105274955Ssvnmir bool is_deoptimized_frame() const; 106274955Ssvnmir 107274955Ssvnmir // testers 108274955Ssvnmir bool is_first_frame() const; // oldest frame? (has no sender) 109274955Ssvnmir bool is_first_java_frame() const; // same for Java frame 110274955Ssvnmir 111274955Ssvnmir bool is_interpreted_frame_valid(JavaThread* thread) const; // performs sanity checks on interpreted frames. 112274955Ssvnmir 113274955Ssvnmir // tells whether this frame is marked for deoptimization 114274955Ssvnmir bool should_be_deoptimized() const; 115274955Ssvnmir 116274955Ssvnmir // tells whether this frame can be deoptimized 117274955Ssvnmir bool can_be_deoptimized() const; 118274955Ssvnmir 119274955Ssvnmir // returns the frame size in stack slots 120274955Ssvnmir int frame_size() const; 121274955Ssvnmir 122274955Ssvnmir // returns the sending frame 123274955Ssvnmir frame sender(RegisterMap* map) const; 124288943Sdim 125274955Ssvnmir // for Profiling - acting on another frame. walks sender frames 126274955Ssvnmir // if valid. 127274955Ssvnmir frame profile_find_Java_sender_frame(JavaThread *thread); 128274955Ssvnmir bool safe_for_sender(JavaThread *thread); 129274955Ssvnmir 130274955Ssvnmir // returns the sender, but skips conversion frames 131274955Ssvnmir frame real_sender(RegisterMap* map) const; 132274955Ssvnmir 133274955Ssvnmir // returns the the sending Java frame, skipping any intermediate C frames 134274955Ssvnmir // NB: receiver must not be first frame 135274955Ssvnmir frame java_sender() const; 136274955Ssvnmir 137274955Ssvnmir private: 138274955Ssvnmir // Helper methods for better factored code in frame::sender 139274955Ssvnmir frame sender_for_compiled_frame(RegisterMap* map) const; 140274955Ssvnmir frame sender_for_entry_frame(RegisterMap* map) const; 141274955Ssvnmir frame sender_for_interpreter_frame(RegisterMap* map) const; 142274955Ssvnmir frame sender_for_native_frame(RegisterMap* map) const; 143274955Ssvnmir 144274955Ssvnmir // All frames: 145274955Ssvnmir 146274955Ssvnmir // A low-level interface for vframes: 147274955Ssvnmir 148274955Ssvnmir public: 149274955Ssvnmir 150274955Ssvnmir intptr_t* addr_at(int index) const { return &fp()[index]; } 151274955Ssvnmir intptr_t at(int index) const { return *addr_at(index); } 152274955Ssvnmir 153274955Ssvnmir // accessors for locals 154274955Ssvnmir oop obj_at(int offset) const { return *obj_at_addr(offset); } 155274955Ssvnmir void obj_at_put(int offset, oop value) { *obj_at_addr(offset) = value; } 156274955Ssvnmir 157274955Ssvnmir jint int_at(int offset) const { return *int_at_addr(offset); } 158274955Ssvnmir void int_at_put(int offset, jint value) { *int_at_addr(offset) = value; } 159274955Ssvnmir 160274955Ssvnmir oop* obj_at_addr(int offset) const { return (oop*) addr_at(offset); } 161274955Ssvnmir 162274955Ssvnmir oop* adjusted_obj_at_addr(methodOop method, int index) { return obj_at_addr(adjust_offset(method, index)); } 163274955Ssvnmir 164274955Ssvnmir private: 165274955Ssvnmir jint* int_at_addr(int offset) const { return (jint*) addr_at(offset); } 166274955Ssvnmir 167274955Ssvnmir public: 168274955Ssvnmir // Link (i.e., the pointer to the previous frame) 169274955Ssvnmir intptr_t* link() const; 170274955Ssvnmir void set_link(intptr_t* addr); 171274955Ssvnmir 172274955Ssvnmir // Return address 173274955Ssvnmir address sender_pc() const; 174274955Ssvnmir 175274955Ssvnmir // Support for deoptimization 176274955Ssvnmir void deoptimize(JavaThread* thread, bool thread_is_known_safe = false); 177274955Ssvnmir 178274955Ssvnmir // The frame's original SP, before any extension by an interpreted callee; 179274955Ssvnmir // used for packing debug info into vframeArray objects and vframeArray lookup. 180274955Ssvnmir intptr_t* unextended_sp() const; 181274955Ssvnmir 182274955Ssvnmir // returns the stack pointer of the calling frame 183274955Ssvnmir intptr_t* sender_sp() const; 184274955Ssvnmir 185274955Ssvnmir 186274955Ssvnmir // Interpreter frames: 187274955Ssvnmir 188274955Ssvnmir private: 189274955Ssvnmir intptr_t** interpreter_frame_locals_addr() const; 190274955Ssvnmir intptr_t* interpreter_frame_bcx_addr() const; 191274955Ssvnmir intptr_t* interpreter_frame_mdx_addr() const; 192274955Ssvnmir 193274955Ssvnmir public: 194274955Ssvnmir // Tags for TaggedStackInterpreter 195274955Ssvnmir enum Tag { 196274955Ssvnmir TagValue = 0, // Important: must be zero to use G0 on sparc. 197274955Ssvnmir TagReference = 0x555, // Reference type - is an oop that needs gc. 198280031Sdim TagCategory2 = 0x666 // Only used internally by interpreter 199280031Sdim // and not written to the java stack. 200280031Sdim // The values above are chosen so that misuse causes a crash 201280031Sdim // with a recognizable value. 202280031Sdim }; 203274955Ssvnmir 204274955Ssvnmir static Tag tag_for_basic_type(BasicType typ) { 205274955Ssvnmir return (typ == T_OBJECT ? TagReference : TagValue); 206274955Ssvnmir } 207280031Sdim 208280031Sdim // Locals 209280031Sdim 210274955Ssvnmir // The _at version returns a pointer because the address is used for GC. 211274955Ssvnmir intptr_t* interpreter_frame_local_at(int index) const; 212274955Ssvnmir Tag interpreter_frame_local_tag(int index) const; 213288943Sdim void interpreter_frame_set_local_tag(int index, Tag tag) const; 214288943Sdim 215 void interpreter_frame_set_locals(intptr_t* locs); 216 217 // byte code index/pointer (use these functions for unchecked frame access only!) 218 intptr_t interpreter_frame_bcx() const { return *interpreter_frame_bcx_addr(); } 219 void interpreter_frame_set_bcx(intptr_t bcx); 220 221 // byte code index 222 jint interpreter_frame_bci() const; 223 void interpreter_frame_set_bci(jint bci); 224 225 // byte code pointer 226 address interpreter_frame_bcp() const; 227 void interpreter_frame_set_bcp(address bcp); 228 229 // Unchecked access to the method data index/pointer. 230 // Only use this if you know what you are doing. 231 intptr_t interpreter_frame_mdx() const { return *interpreter_frame_mdx_addr(); } 232 void interpreter_frame_set_mdx(intptr_t mdx); 233 234 // method data pointer 235 address interpreter_frame_mdp() const; 236 void interpreter_frame_set_mdp(address dp); 237 238 // Find receiver out of caller's (compiled) argument list 239 oop retrieve_receiver(RegisterMap *reg_map); 240 241 // Return the monitor owner and BasicLock for compiled synchronized 242 // native methods so that biased locking can revoke the receiver's 243 // bias if necessary. Takes optional nmethod for this frame as 244 // argument to avoid performing repeated lookups in code cache. 245 BasicLock* compiled_synchronized_native_monitor (nmethod* nm = NULL); 246 oop compiled_synchronized_native_monitor_owner(nmethod* nm = NULL); 247 248 // Find receiver for an invoke when arguments are just pushed on stack (i.e., callee stack-frame is 249 // not setup) 250 oop interpreter_callee_receiver(symbolHandle signature) { return *interpreter_callee_receiver_addr(signature); } 251 252 253 oop* interpreter_callee_receiver_addr(symbolHandle signature); 254 255 256 // expression stack (may go up or down, direction == 1 or -1) 257 public: 258 intptr_t* interpreter_frame_expression_stack() const; 259 static jint interpreter_frame_expression_stack_direction(); 260 261 // The _at version returns a pointer because the address is used for GC. 262 intptr_t* interpreter_frame_expression_stack_at(jint offset) const; 263 Tag interpreter_frame_expression_stack_tag(jint offset) const; 264 void interpreter_frame_set_expression_stack_tag(jint offset, Tag tag) const; 265 266 // top of expression stack 267 intptr_t* interpreter_frame_tos_at(jint offset) const; 268 intptr_t* interpreter_frame_tos_address() const; 269 270 271 jint interpreter_frame_expression_stack_size() const; 272 273 intptr_t* interpreter_frame_sender_sp() const; 274 275#ifndef CC_INTERP 276 // template based interpreter deoptimization support 277 void set_interpreter_frame_sender_sp(intptr_t* sender_sp); 278 void interpreter_frame_set_monitor_end(BasicObjectLock* value); 279#endif // CC_INTERP 280 281 // BasicObjectLocks: 282 // 283 // interpreter_frame_monitor_begin is higher in memory than interpreter_frame_monitor_end 284 // Interpreter_frame_monitor_begin points to one element beyond the oldest one, 285 // interpreter_frame_monitor_end points to the youngest one, or if there are none, 286 // it points to one beyond where the first element will be. 287 // interpreter_frame_monitor_size reports the allocation size of a monitor in the interpreter stack. 288 // this value is >= BasicObjectLock::size(), and may be rounded up 289 290 BasicObjectLock* interpreter_frame_monitor_begin() const; 291 BasicObjectLock* interpreter_frame_monitor_end() const; 292 BasicObjectLock* next_monitor_in_interpreter_frame(BasicObjectLock* current) const; 293 BasicObjectLock* previous_monitor_in_interpreter_frame(BasicObjectLock* current) const; 294 static int interpreter_frame_monitor_size(); 295 296 void interpreter_frame_verify_monitor(BasicObjectLock* value) const; 297 298 // Tells whether the current interpreter_frame frame pointer 299 // corresponds to the old compiled/deoptimized fp 300 // The receiver used to be a top level frame 301 bool interpreter_frame_equals_unpacked_fp(intptr_t* fp); 302 303 // Return/result value from this interpreter frame 304 // If the method return type is T_OBJECT or T_ARRAY populates oop_result 305 // For other (non-T_VOID) the appropriate field in the jvalue is populated 306 // with the result value. 307 // Should only be called when at method exit when the method is not 308 // exiting due to an exception. 309 BasicType interpreter_frame_result(oop* oop_result, jvalue* value_result); 310 311 public: 312 // Method & constant pool cache 313 methodOop interpreter_frame_method() const; 314 void interpreter_frame_set_method(methodOop method); 315 methodOop* interpreter_frame_method_addr() const; 316 constantPoolCacheOop* interpreter_frame_cache_addr() const; 317 318 public: 319 // Entry frames 320 JavaCallWrapper* entry_frame_call_wrapper() const; 321 intptr_t* entry_frame_argument_at(int offset) const; 322 323 // tells whether there is another chunk of Delta stack above 324 bool entry_frame_is_first() const; 325 326 // Compiled frames: 327 328 public: 329 // Given the index of a local, and the number of argument words 330 // in this stack frame, tell which word of the stack frame to find 331 // the local in. Arguments are stored above the ofp/rpc pair, 332 // while other locals are stored below it. 333 // Since monitors (BasicLock blocks) are also assigned indexes, 334 // but may have different storage requirements, their presence 335 // can also affect the calculation of offsets. 336 static int local_offset_for_compiler(int local_index, int nof_args, int max_nof_locals, int max_nof_monitors); 337 338 // Given the index of a monitor, etc., tell which word of the 339 // stack frame contains the start of the BasicLock block. 340 // Note that the local index by convention is the __higher__ 341 // of the two indexes allocated to the block. 342 static int monitor_offset_for_compiler(int local_index, int nof_args, int max_nof_locals, int max_nof_monitors); 343 344 // Tell the smallest value that local_offset_for_compiler will attain. 345 // This is used to help determine how much stack frame to allocate. 346 static int min_local_offset_for_compiler(int nof_args, int max_nof_locals, int max_nof_monitors); 347 348 // Tells if this register must be spilled during a call. 349 // On Intel, all registers are smashed by calls. 350 static bool volatile_across_calls(Register reg); 351 352 353 // Safepoints 354 355 public: 356 oop saved_oop_result(RegisterMap* map) const; 357 void set_saved_oop_result(RegisterMap* map, oop obj); 358 359 // For debugging 360 private: 361 const char* print_name() const; 362 363 public: 364 void print_value() const { print_value_on(tty,NULL); } 365 void print_value_on(outputStream* st, JavaThread *thread) const; 366 void print_on(outputStream* st) const; 367 void interpreter_frame_print_on(outputStream* st) const; 368 void print_on_error(outputStream* st, char* buf, int buflen, bool verbose = false) const; 369 370 // Conversion from an VMReg to physical stack location 371 oop* oopmapreg_to_location(VMReg reg, const RegisterMap* regmap) const; 372 373 // Oops-do's 374 void oops_compiled_arguments_do(symbolHandle signature, bool is_static, const RegisterMap* reg_map, OopClosure* f); 375 void oops_interpreted_do(OopClosure* f, const RegisterMap* map, bool query_oop_map_cache = true); 376 377 private: 378 void oops_interpreted_locals_do(OopClosure *f, 379 int max_locals, 380 InterpreterOopMap *mask); 381 void oops_interpreted_expressions_do(OopClosure *f, symbolHandle signature, 382 bool is_static, int max_stack, int max_locals, 383 InterpreterOopMap *mask); 384 void oops_interpreted_arguments_do(symbolHandle signature, bool is_static, OopClosure* f); 385 386 // Iteration of oops 387 void oops_do_internal(OopClosure* f, RegisterMap* map, bool use_interpreter_oop_map_cache); 388 void oops_entry_do(OopClosure* f, const RegisterMap* map); 389 void oops_code_blob_do(OopClosure* f, const RegisterMap* map); 390 int adjust_offset(methodOop method, int index); // helper for above fn 391 // Iteration of nmethods 392 void nmethods_code_blob_do(); 393 public: 394 // Memory management 395 void oops_do(OopClosure* f, RegisterMap* map) { oops_do_internal(f, map, true); } 396 void nmethods_do(); 397 398 void gc_prologue(); 399 void gc_epilogue(); 400 void pd_gc_epilog(); 401 402# ifdef ENABLE_ZAP_DEAD_LOCALS 403 private: 404 class CheckValueClosure: public OopClosure { 405 public: 406 void do_oop(oop* p); 407 void do_oop(narrowOop* p) { ShouldNotReachHere(); } 408 }; 409 static CheckValueClosure _check_value; 410 411 class CheckOopClosure: public OopClosure { 412 public: 413 void do_oop(oop* p); 414 void do_oop(narrowOop* p) { ShouldNotReachHere(); } 415 }; 416 static CheckOopClosure _check_oop; 417 418 static void check_derived_oop(oop* base, oop* derived); 419 420 class ZapDeadClosure: public OopClosure { 421 public: 422 void do_oop(oop* p); 423 void do_oop(narrowOop* p) { ShouldNotReachHere(); } 424 }; 425 static ZapDeadClosure _zap_dead; 426 427 public: 428 // Zapping 429 void zap_dead_locals (JavaThread* thread, const RegisterMap* map); 430 void zap_dead_interpreted_locals(JavaThread* thread, const RegisterMap* map); 431 void zap_dead_compiled_locals (JavaThread* thread, const RegisterMap* map); 432 void zap_dead_entry_locals (JavaThread* thread, const RegisterMap* map); 433 void zap_dead_deoptimized_locals(JavaThread* thread, const RegisterMap* map); 434# endif 435 // Verification 436 void verify(const RegisterMap* map); 437 static bool verify_return_pc(address x); 438 static bool is_bci(intptr_t bcx); 439 // Usage: 440 // assert(frame::verify_return_pc(return_address), "must be a return pc"); 441 442 int pd_oop_map_offset_adjustment() const; 443 444# include "incls/_frame_pd.hpp.incl" 445}; 446 447 448// 449// StackFrameStream iterates through the frames of a thread starting from 450// top most frame. It automatically takes care of updating the location of 451// all (callee-saved) registers. Notice: If a thread is stopped at 452// a safepoint, all registers are saved, not only the callee-saved ones. 453// 454// Use: 455// 456// for(StackFrameStream fst(thread); !fst.is_done(); fst.next()) { 457// ... 458// } 459// 460class StackFrameStream : public StackObj { 461 private: 462 frame _fr; 463 RegisterMap _reg_map; 464 bool _is_done; 465 public: 466 StackFrameStream(JavaThread *thread, bool update = true); 467 468 // Iteration 469 bool is_done() { return (_is_done) ? true : (_is_done = _fr.is_first_frame(), false); } 470 void next() { if (!_is_done) _fr = _fr.sender(&_reg_map); } 471 472 // Query 473 frame *current() { return &_fr; } 474 RegisterMap* register_map() { return &_reg_map; } 475}; 476