src/share/vm/runtime/frame.hpp

Fri, 30 Apr 2010 08:37:24 -0700

author
twisti
date
Fri, 30 Apr 2010 08:37:24 -0700
changeset 1861
2338d41fbd81
parent 1636
24128c2ffa87
child 1907
c18cbe5936b8
permissions
-rw-r--r--

6943304: remove tagged stack interpreter
Reviewed-by: coleenp, never, gbenson

duke@435 1 /*
twisti@1861 2 * Copyright 1997-2010 Sun Microsystems, Inc. All Rights Reserved.
duke@435 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@435 4 *
duke@435 5 * This code is free software; you can redistribute it and/or modify it
duke@435 6 * under the terms of the GNU General Public License version 2 only, as
duke@435 7 * published by the Free Software Foundation.
duke@435 8 *
duke@435 9 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@435 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@435 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@435 12 * version 2 for more details (a copy is included in the LICENSE file that
duke@435 13 * accompanied this code).
duke@435 14 *
duke@435 15 * You should have received a copy of the GNU General Public License version
duke@435 16 * 2 along with this work; if not, write to the Free Software Foundation,
duke@435 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@435 18 *
duke@435 19 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@435 20 * CA 95054 USA or visit www.sun.com if you need additional information or
duke@435 21 * have any questions.
duke@435 22 *
duke@435 23 */
duke@435 24
duke@435 25 typedef class BytecodeInterpreter* interpreterState;
duke@435 26
duke@435 27 class CodeBlob;
duke@435 28
duke@435 29
duke@435 30 // A frame represents a physical stack frame (an activation). Frames
duke@435 31 // can be C or Java frames, and the Java frames can be interpreted or
duke@435 32 // compiled. In contrast, vframes represent source-level activations,
duke@435 33 // so that one physical frame can correspond to multiple source level
duke@435 34 // frames because of inlining.
duke@435 35
duke@435 36 class frame VALUE_OBJ_CLASS_SPEC {
duke@435 37 private:
duke@435 38 // Instance variables:
duke@435 39 intptr_t* _sp; // stack pointer (from Thread::last_Java_sp)
duke@435 40 address _pc; // program counter (the next instruction after the call)
duke@435 41
duke@435 42 CodeBlob* _cb; // CodeBlob that "owns" pc
duke@435 43 enum deopt_state {
duke@435 44 not_deoptimized,
duke@435 45 is_deoptimized,
duke@435 46 unknown
duke@435 47 };
duke@435 48
duke@435 49 deopt_state _deopt_state;
duke@435 50
duke@435 51 public:
duke@435 52 // Constructors
duke@435 53 frame();
duke@435 54
duke@435 55 // Accessors
duke@435 56
duke@435 57 // pc: Returns the pc at which this frame will continue normally.
duke@435 58 // It must point at the beginning of the next instruction to execute.
duke@435 59 address pc() const { return _pc; }
duke@435 60
duke@435 61 // This returns the pc that if you were in the debugger you'd see. Not
duke@435 62 // the idealized value in the frame object. This undoes the magic conversion
duke@435 63 // that happens for deoptimized frames. In addition it makes the value the
duke@435 64 // hardware would want to see in the native frame. The only user (at this point)
duke@435 65 // is deoptimization. It likely no one else should ever use it.
duke@435 66 address raw_pc() const;
duke@435 67
duke@435 68 void set_pc( address newpc );
duke@435 69
duke@435 70 intptr_t* sp() const { return _sp; }
duke@435 71 void set_sp( intptr_t* newsp ) { _sp = newsp; }
duke@435 72
duke@435 73
duke@435 74 CodeBlob* cb() const { return _cb; }
duke@435 75
duke@435 76 // patching operations
duke@435 77 void patch_pc(Thread* thread, address pc);
duke@435 78
duke@435 79 // Every frame needs to return a unique id which distinguishes it from all other frames.
duke@435 80 // For sparc and ia32 use sp. ia64 can have memory frames that are empty so multiple frames
duke@435 81 // will have identical sp values. For ia64 the bsp (fp) value will serve. No real frame
duke@435 82 // should have an id() of NULL so it is a distinguishing value for an unmatchable frame.
duke@435 83 // We also have relationals which allow comparing a frame to anoth frame's id() allow
duke@435 84 // us to distinguish younger (more recent activation) from older (less recent activations)
duke@435 85 // A NULL id is only valid when comparing for equality.
duke@435 86
duke@435 87 intptr_t* id(void) const;
duke@435 88 bool is_younger(intptr_t* id) const;
duke@435 89 bool is_older(intptr_t* id) const;
duke@435 90
duke@435 91 // testers
duke@435 92
duke@435 93 // Compares for strict equality. Rarely used or needed.
duke@435 94 // It can return a different result than f1.id() == f2.id()
duke@435 95 bool equal(frame other) const;
duke@435 96
duke@435 97 // type testers
duke@435 98 bool is_interpreted_frame() const;
duke@435 99 bool is_java_frame() const;
duke@435 100 bool is_entry_frame() const; // Java frame called from C?
duke@435 101 bool is_native_frame() const;
duke@435 102 bool is_runtime_frame() const;
duke@435 103 bool is_compiled_frame() const;
duke@435 104 bool is_safepoint_blob_frame() const;
duke@435 105 bool is_deoptimized_frame() const;
duke@435 106
duke@435 107 // testers
duke@435 108 bool is_first_frame() const; // oldest frame? (has no sender)
duke@435 109 bool is_first_java_frame() const; // same for Java frame
duke@435 110
sgoldman@542 111 bool is_interpreted_frame_valid(JavaThread* thread) const; // performs sanity checks on interpreted frames.
duke@435 112
duke@435 113 // tells whether this frame is marked for deoptimization
duke@435 114 bool should_be_deoptimized() const;
duke@435 115
duke@435 116 // tells whether this frame can be deoptimized
duke@435 117 bool can_be_deoptimized() const;
duke@435 118
duke@435 119 // returns the frame size in stack slots
cfang@1228 120 int frame_size(RegisterMap* map) const;
duke@435 121
duke@435 122 // returns the sending frame
duke@435 123 frame sender(RegisterMap* map) const;
duke@435 124
duke@435 125 // for Profiling - acting on another frame. walks sender frames
duke@435 126 // if valid.
duke@435 127 frame profile_find_Java_sender_frame(JavaThread *thread);
duke@435 128 bool safe_for_sender(JavaThread *thread);
duke@435 129
duke@435 130 // returns the sender, but skips conversion frames
duke@435 131 frame real_sender(RegisterMap* map) const;
duke@435 132
duke@435 133 // returns the the sending Java frame, skipping any intermediate C frames
duke@435 134 // NB: receiver must not be first frame
duke@435 135 frame java_sender() const;
duke@435 136
duke@435 137 private:
duke@435 138 // Helper methods for better factored code in frame::sender
duke@435 139 frame sender_for_compiled_frame(RegisterMap* map) const;
duke@435 140 frame sender_for_entry_frame(RegisterMap* map) const;
duke@435 141 frame sender_for_interpreter_frame(RegisterMap* map) const;
duke@435 142 frame sender_for_native_frame(RegisterMap* map) const;
duke@435 143
duke@435 144 // All frames:
duke@435 145
duke@435 146 // A low-level interface for vframes:
duke@435 147
duke@435 148 public:
duke@435 149
duke@435 150 intptr_t* addr_at(int index) const { return &fp()[index]; }
duke@435 151 intptr_t at(int index) const { return *addr_at(index); }
duke@435 152
duke@435 153 // accessors for locals
duke@435 154 oop obj_at(int offset) const { return *obj_at_addr(offset); }
duke@435 155 void obj_at_put(int offset, oop value) { *obj_at_addr(offset) = value; }
duke@435 156
duke@435 157 jint int_at(int offset) const { return *int_at_addr(offset); }
duke@435 158 void int_at_put(int offset, jint value) { *int_at_addr(offset) = value; }
duke@435 159
duke@435 160 oop* obj_at_addr(int offset) const { return (oop*) addr_at(offset); }
duke@435 161
duke@435 162 oop* adjusted_obj_at_addr(methodOop method, int index) { return obj_at_addr(adjust_offset(method, index)); }
duke@435 163
duke@435 164 private:
duke@435 165 jint* int_at_addr(int offset) const { return (jint*) addr_at(offset); }
duke@435 166
duke@435 167 public:
duke@435 168 // Link (i.e., the pointer to the previous frame)
duke@435 169 intptr_t* link() const;
duke@435 170 void set_link(intptr_t* addr);
duke@435 171
duke@435 172 // Return address
duke@435 173 address sender_pc() const;
duke@435 174
duke@435 175 // Support for deoptimization
duke@435 176 void deoptimize(JavaThread* thread, bool thread_is_known_safe = false);
duke@435 177
duke@435 178 // The frame's original SP, before any extension by an interpreted callee;
duke@435 179 // used for packing debug info into vframeArray objects and vframeArray lookup.
duke@435 180 intptr_t* unextended_sp() const;
duke@435 181
duke@435 182 // returns the stack pointer of the calling frame
duke@435 183 intptr_t* sender_sp() const;
duke@435 184
duke@435 185
duke@435 186 // Interpreter frames:
duke@435 187
duke@435 188 private:
duke@435 189 intptr_t** interpreter_frame_locals_addr() const;
duke@435 190 intptr_t* interpreter_frame_bcx_addr() const;
duke@435 191 intptr_t* interpreter_frame_mdx_addr() const;
duke@435 192
duke@435 193 public:
duke@435 194 // Locals
duke@435 195
duke@435 196 // The _at version returns a pointer because the address is used for GC.
duke@435 197 intptr_t* interpreter_frame_local_at(int index) const;
duke@435 198
duke@435 199 void interpreter_frame_set_locals(intptr_t* locs);
duke@435 200
duke@435 201 // byte code index/pointer (use these functions for unchecked frame access only!)
duke@435 202 intptr_t interpreter_frame_bcx() const { return *interpreter_frame_bcx_addr(); }
duke@435 203 void interpreter_frame_set_bcx(intptr_t bcx);
duke@435 204
duke@435 205 // byte code index
duke@435 206 jint interpreter_frame_bci() const;
duke@435 207 void interpreter_frame_set_bci(jint bci);
duke@435 208
duke@435 209 // byte code pointer
duke@435 210 address interpreter_frame_bcp() const;
duke@435 211 void interpreter_frame_set_bcp(address bcp);
duke@435 212
duke@435 213 // Unchecked access to the method data index/pointer.
duke@435 214 // Only use this if you know what you are doing.
duke@435 215 intptr_t interpreter_frame_mdx() const { return *interpreter_frame_mdx_addr(); }
duke@435 216 void interpreter_frame_set_mdx(intptr_t mdx);
duke@435 217
duke@435 218 // method data pointer
duke@435 219 address interpreter_frame_mdp() const;
duke@435 220 void interpreter_frame_set_mdp(address dp);
duke@435 221
duke@435 222 // Find receiver out of caller's (compiled) argument list
duke@435 223 oop retrieve_receiver(RegisterMap *reg_map);
duke@435 224
duke@435 225 // Return the monitor owner and BasicLock for compiled synchronized
duke@435 226 // native methods so that biased locking can revoke the receiver's
duke@435 227 // bias if necessary. Takes optional nmethod for this frame as
duke@435 228 // argument to avoid performing repeated lookups in code cache.
duke@435 229 BasicLock* compiled_synchronized_native_monitor (nmethod* nm = NULL);
duke@435 230 oop compiled_synchronized_native_monitor_owner(nmethod* nm = NULL);
duke@435 231
duke@435 232 // Find receiver for an invoke when arguments are just pushed on stack (i.e., callee stack-frame is
duke@435 233 // not setup)
duke@435 234 oop interpreter_callee_receiver(symbolHandle signature) { return *interpreter_callee_receiver_addr(signature); }
duke@435 235
duke@435 236
coleenp@548 237 oop* interpreter_callee_receiver_addr(symbolHandle signature);
duke@435 238
duke@435 239
duke@435 240 // expression stack (may go up or down, direction == 1 or -1)
duke@435 241 public:
duke@435 242 intptr_t* interpreter_frame_expression_stack() const;
duke@435 243 static jint interpreter_frame_expression_stack_direction();
duke@435 244
duke@435 245 // The _at version returns a pointer because the address is used for GC.
duke@435 246 intptr_t* interpreter_frame_expression_stack_at(jint offset) const;
duke@435 247
duke@435 248 // top of expression stack
duke@435 249 intptr_t* interpreter_frame_tos_at(jint offset) const;
duke@435 250 intptr_t* interpreter_frame_tos_address() const;
duke@435 251
duke@435 252
duke@435 253 jint interpreter_frame_expression_stack_size() const;
duke@435 254
duke@435 255 intptr_t* interpreter_frame_sender_sp() const;
duke@435 256
duke@435 257 #ifndef CC_INTERP
duke@435 258 // template based interpreter deoptimization support
duke@435 259 void set_interpreter_frame_sender_sp(intptr_t* sender_sp);
duke@435 260 void interpreter_frame_set_monitor_end(BasicObjectLock* value);
duke@435 261 #endif // CC_INTERP
duke@435 262
duke@435 263 // BasicObjectLocks:
duke@435 264 //
duke@435 265 // interpreter_frame_monitor_begin is higher in memory than interpreter_frame_monitor_end
duke@435 266 // Interpreter_frame_monitor_begin points to one element beyond the oldest one,
duke@435 267 // interpreter_frame_monitor_end points to the youngest one, or if there are none,
duke@435 268 // it points to one beyond where the first element will be.
duke@435 269 // interpreter_frame_monitor_size reports the allocation size of a monitor in the interpreter stack.
duke@435 270 // this value is >= BasicObjectLock::size(), and may be rounded up
duke@435 271
duke@435 272 BasicObjectLock* interpreter_frame_monitor_begin() const;
duke@435 273 BasicObjectLock* interpreter_frame_monitor_end() const;
duke@435 274 BasicObjectLock* next_monitor_in_interpreter_frame(BasicObjectLock* current) const;
duke@435 275 BasicObjectLock* previous_monitor_in_interpreter_frame(BasicObjectLock* current) const;
duke@435 276 static int interpreter_frame_monitor_size();
duke@435 277
duke@435 278 void interpreter_frame_verify_monitor(BasicObjectLock* value) const;
duke@435 279
duke@435 280 // Tells whether the current interpreter_frame frame pointer
duke@435 281 // corresponds to the old compiled/deoptimized fp
duke@435 282 // The receiver used to be a top level frame
duke@435 283 bool interpreter_frame_equals_unpacked_fp(intptr_t* fp);
duke@435 284
duke@435 285 // Return/result value from this interpreter frame
duke@435 286 // If the method return type is T_OBJECT or T_ARRAY populates oop_result
duke@435 287 // For other (non-T_VOID) the appropriate field in the jvalue is populated
duke@435 288 // with the result value.
duke@435 289 // Should only be called when at method exit when the method is not
duke@435 290 // exiting due to an exception.
duke@435 291 BasicType interpreter_frame_result(oop* oop_result, jvalue* value_result);
duke@435 292
duke@435 293 public:
duke@435 294 // Method & constant pool cache
duke@435 295 methodOop interpreter_frame_method() const;
duke@435 296 void interpreter_frame_set_method(methodOop method);
duke@435 297 methodOop* interpreter_frame_method_addr() const;
duke@435 298 constantPoolCacheOop* interpreter_frame_cache_addr() const;
duke@435 299
duke@435 300 public:
duke@435 301 // Entry frames
duke@435 302 JavaCallWrapper* entry_frame_call_wrapper() const;
duke@435 303 intptr_t* entry_frame_argument_at(int offset) const;
duke@435 304
duke@435 305 // tells whether there is another chunk of Delta stack above
duke@435 306 bool entry_frame_is_first() const;
duke@435 307
duke@435 308 // Compiled frames:
duke@435 309
duke@435 310 public:
duke@435 311 // Given the index of a local, and the number of argument words
duke@435 312 // in this stack frame, tell which word of the stack frame to find
duke@435 313 // the local in. Arguments are stored above the ofp/rpc pair,
duke@435 314 // while other locals are stored below it.
duke@435 315 // Since monitors (BasicLock blocks) are also assigned indexes,
duke@435 316 // but may have different storage requirements, their presence
duke@435 317 // can also affect the calculation of offsets.
duke@435 318 static int local_offset_for_compiler(int local_index, int nof_args, int max_nof_locals, int max_nof_monitors);
duke@435 319
duke@435 320 // Given the index of a monitor, etc., tell which word of the
duke@435 321 // stack frame contains the start of the BasicLock block.
duke@435 322 // Note that the local index by convention is the __higher__
duke@435 323 // of the two indexes allocated to the block.
duke@435 324 static int monitor_offset_for_compiler(int local_index, int nof_args, int max_nof_locals, int max_nof_monitors);
duke@435 325
duke@435 326 // Tell the smallest value that local_offset_for_compiler will attain.
duke@435 327 // This is used to help determine how much stack frame to allocate.
duke@435 328 static int min_local_offset_for_compiler(int nof_args, int max_nof_locals, int max_nof_monitors);
duke@435 329
duke@435 330 // Tells if this register must be spilled during a call.
duke@435 331 // On Intel, all registers are smashed by calls.
duke@435 332 static bool volatile_across_calls(Register reg);
duke@435 333
duke@435 334
duke@435 335 // Safepoints
duke@435 336
duke@435 337 public:
duke@435 338 oop saved_oop_result(RegisterMap* map) const;
duke@435 339 void set_saved_oop_result(RegisterMap* map, oop obj);
duke@435 340
duke@435 341 // For debugging
duke@435 342 private:
duke@435 343 const char* print_name() const;
duke@435 344
duke@435 345 public:
duke@435 346 void print_value() const { print_value_on(tty,NULL); }
duke@435 347 void print_value_on(outputStream* st, JavaThread *thread) const;
duke@435 348 void print_on(outputStream* st) const;
duke@435 349 void interpreter_frame_print_on(outputStream* st) const;
duke@435 350 void print_on_error(outputStream* st, char* buf, int buflen, bool verbose = false) const;
duke@435 351
duke@435 352 // Conversion from an VMReg to physical stack location
duke@435 353 oop* oopmapreg_to_location(VMReg reg, const RegisterMap* regmap) const;
duke@435 354
duke@435 355 // Oops-do's
twisti@1573 356 void oops_compiled_arguments_do(symbolHandle signature, bool has_receiver, const RegisterMap* reg_map, OopClosure* f);
duke@435 357 void oops_interpreted_do(OopClosure* f, const RegisterMap* map, bool query_oop_map_cache = true);
duke@435 358
duke@435 359 private:
twisti@1573 360 void oops_interpreted_arguments_do(symbolHandle signature, bool has_receiver, OopClosure* f);
duke@435 361
duke@435 362 // Iteration of oops
jrose@1424 363 void oops_do_internal(OopClosure* f, CodeBlobClosure* cf, RegisterMap* map, bool use_interpreter_oop_map_cache);
duke@435 364 void oops_entry_do(OopClosure* f, const RegisterMap* map);
jrose@1424 365 void oops_code_blob_do(OopClosure* f, CodeBlobClosure* cf, const RegisterMap* map);
duke@435 366 int adjust_offset(methodOop method, int index); // helper for above fn
duke@435 367 public:
duke@435 368 // Memory management
jrose@1424 369 void oops_do(OopClosure* f, CodeBlobClosure* cf, RegisterMap* map) { oops_do_internal(f, cf, map, true); }
jrose@1424 370 void nmethods_do(CodeBlobClosure* cf);
duke@435 371
duke@435 372 void gc_prologue();
duke@435 373 void gc_epilogue();
duke@435 374 void pd_gc_epilog();
duke@435 375
duke@435 376 # ifdef ENABLE_ZAP_DEAD_LOCALS
duke@435 377 private:
duke@435 378 class CheckValueClosure: public OopClosure {
coleenp@548 379 public:
coleenp@548 380 void do_oop(oop* p);
coleenp@548 381 void do_oop(narrowOop* p) { ShouldNotReachHere(); }
duke@435 382 };
duke@435 383 static CheckValueClosure _check_value;
duke@435 384
duke@435 385 class CheckOopClosure: public OopClosure {
coleenp@548 386 public:
coleenp@548 387 void do_oop(oop* p);
coleenp@548 388 void do_oop(narrowOop* p) { ShouldNotReachHere(); }
duke@435 389 };
duke@435 390 static CheckOopClosure _check_oop;
duke@435 391
duke@435 392 static void check_derived_oop(oop* base, oop* derived);
duke@435 393
duke@435 394 class ZapDeadClosure: public OopClosure {
coleenp@548 395 public:
coleenp@548 396 void do_oop(oop* p);
coleenp@548 397 void do_oop(narrowOop* p) { ShouldNotReachHere(); }
duke@435 398 };
duke@435 399 static ZapDeadClosure _zap_dead;
duke@435 400
duke@435 401 public:
duke@435 402 // Zapping
duke@435 403 void zap_dead_locals (JavaThread* thread, const RegisterMap* map);
duke@435 404 void zap_dead_interpreted_locals(JavaThread* thread, const RegisterMap* map);
duke@435 405 void zap_dead_compiled_locals (JavaThread* thread, const RegisterMap* map);
duke@435 406 void zap_dead_entry_locals (JavaThread* thread, const RegisterMap* map);
duke@435 407 void zap_dead_deoptimized_locals(JavaThread* thread, const RegisterMap* map);
duke@435 408 # endif
duke@435 409 // Verification
duke@435 410 void verify(const RegisterMap* map);
duke@435 411 static bool verify_return_pc(address x);
duke@435 412 static bool is_bci(intptr_t bcx);
duke@435 413 // Usage:
duke@435 414 // assert(frame::verify_return_pc(return_address), "must be a return pc");
duke@435 415
duke@435 416 int pd_oop_map_offset_adjustment() const;
duke@435 417
duke@435 418 # include "incls/_frame_pd.hpp.incl"
duke@435 419 };
duke@435 420
duke@435 421
duke@435 422 //
duke@435 423 // StackFrameStream iterates through the frames of a thread starting from
duke@435 424 // top most frame. It automatically takes care of updating the location of
duke@435 425 // all (callee-saved) registers. Notice: If a thread is stopped at
duke@435 426 // a safepoint, all registers are saved, not only the callee-saved ones.
duke@435 427 //
duke@435 428 // Use:
duke@435 429 //
duke@435 430 // for(StackFrameStream fst(thread); !fst.is_done(); fst.next()) {
duke@435 431 // ...
duke@435 432 // }
duke@435 433 //
duke@435 434 class StackFrameStream : public StackObj {
duke@435 435 private:
duke@435 436 frame _fr;
duke@435 437 RegisterMap _reg_map;
duke@435 438 bool _is_done;
duke@435 439 public:
duke@435 440 StackFrameStream(JavaThread *thread, bool update = true);
duke@435 441
duke@435 442 // Iteration
duke@435 443 bool is_done() { return (_is_done) ? true : (_is_done = _fr.is_first_frame(), false); }
duke@435 444 void next() { if (!_is_done) _fr = _fr.sender(&_reg_map); }
duke@435 445
duke@435 446 // Query
duke@435 447 frame *current() { return &_fr; }
duke@435 448 RegisterMap* register_map() { return &_reg_map; }
duke@435 449 };

mercurial