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