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