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