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