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