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