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