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