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/macros.hpp"
33 #ifdef 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 {
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 bool is_entry_frame_valid(JavaThread* thread) 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
198 // Return address
199 address sender_pc() const;
200
201 // Support for deoptimization
202 void deoptimize(JavaThread* thread);
203
204 // The frame's original SP, before any extension by an interpreted callee;
205 // used for packing debug info into vframeArray objects and vframeArray lookup.
206 intptr_t* unextended_sp() const;
207
208 // returns the stack pointer of the calling frame
209 intptr_t* sender_sp() const;
210
211 // Returns the real 'frame pointer' for the current frame.
212 // This is the value expected by the platform ABI when it defines a
213 // frame pointer register. It may differ from the effective value of
214 // the FP register when that register is used in the JVM for other
215 // purposes (like compiled frames on some platforms).
216 // On other platforms, it is defined so that the stack area used by
217 // this frame goes from real_fp() to sp().
218 intptr_t* real_fp() const;
219
220 // Deoptimization info, if needed (platform dependent).
221 // Stored in the initial_info field of the unroll info, to be used by
222 // the platform dependent deoptimization blobs.
223 intptr_t *initial_deoptimization_info();
224
225 // Interpreter frames:
226
227 private:
228 intptr_t** interpreter_frame_locals_addr() const;
229 intptr_t* interpreter_frame_bcp_addr() const;
230 intptr_t* interpreter_frame_mdp_addr() const;
231
232 public:
233 // Locals
234
235 // The _at version returns a pointer because the address is used for GC.
236 intptr_t* interpreter_frame_local_at(int index) const;
237
238 void interpreter_frame_set_locals(intptr_t* locs);
239
240 // byte code index
241 jint interpreter_frame_bci() const;
242
243 // byte code pointer
244 address interpreter_frame_bcp() const;
245 void interpreter_frame_set_bcp(address bcp);
246
247 // method data pointer
248 address interpreter_frame_mdp() const;
249 void interpreter_frame_set_mdp(address dp);
250
251 // Find receiver out of caller's (compiled) argument list
252 oop retrieve_receiver(RegisterMap *reg_map);
253
254 // Return the monitor owner and BasicLock for compiled synchronized
255 // native methods so that biased locking can revoke the receiver's
256 // bias if necessary. This is also used by JVMTI's GetLocalInstance method
257 // (via VM_GetReceiver) to retrieve the receiver from a native wrapper frame.
258 BasicLock* get_native_monitor();
259 oop get_native_receiver();
260
261 // Find receiver for an invoke when arguments are just pushed on stack (i.e., callee stack-frame is
262 // not setup)
263 oop interpreter_callee_receiver(Symbol* signature) { return *interpreter_callee_receiver_addr(signature); }
264
265
266 oop* interpreter_callee_receiver_addr(Symbol* signature);
267
268
269 // expression stack (may go up or down, direction == 1 or -1)
270 public:
271 intptr_t* interpreter_frame_expression_stack() const;
272
273 // The _at version returns a pointer because the address is used for GC.
274 intptr_t* interpreter_frame_expression_stack_at(jint offset) const;
275
276 // top of expression stack
277 intptr_t* interpreter_frame_tos_at(jint offset) const;
278 intptr_t* interpreter_frame_tos_address() const;
279
280
281 jint interpreter_frame_expression_stack_size() const;
282
283 intptr_t* interpreter_frame_sender_sp() const;
284
285 #ifndef CC_INTERP
286 // template based interpreter deoptimization support
287 void set_interpreter_frame_sender_sp(intptr_t* sender_sp);
288 void interpreter_frame_set_monitor_end(BasicObjectLock* value);
289 #endif // CC_INTERP
290
291 // Address of the temp oop in the frame. Needed as GC root.
292 oop* interpreter_frame_temp_oop_addr() const;
293
294 // BasicObjectLocks:
295 //
296 // interpreter_frame_monitor_begin is higher in memory than interpreter_frame_monitor_end
297 // Interpreter_frame_monitor_begin points to one element beyond the oldest one,
298 // interpreter_frame_monitor_end points to the youngest one, or if there are none,
299 // it points to one beyond where the first element will be.
300 // interpreter_frame_monitor_size reports the allocation size of a monitor in the interpreter stack.
301 // this value is >= BasicObjectLock::size(), and may be rounded up
302
303 BasicObjectLock* interpreter_frame_monitor_begin() const;
304 BasicObjectLock* interpreter_frame_monitor_end() const;
305 BasicObjectLock* next_monitor_in_interpreter_frame(BasicObjectLock* current) const;
306 BasicObjectLock* previous_monitor_in_interpreter_frame(BasicObjectLock* current) const;
307 static int interpreter_frame_monitor_size();
308
309 void interpreter_frame_verify_monitor(BasicObjectLock* value) const;
310
311 // Return/result value from this interpreter frame
312 // If the method return type is T_OBJECT or T_ARRAY populates oop_result
313 // For other (non-T_VOID) the appropriate field in the jvalue is populated
314 // with the result value.
315 // Should only be called when at method exit when the method is not
316 // exiting due to an exception.
317 BasicType interpreter_frame_result(oop* oop_result, jvalue* value_result);
318
319 public:
320 // Method & constant pool cache
321 Method* interpreter_frame_method() const;
322 void interpreter_frame_set_method(Method* method);
323 Method** interpreter_frame_method_addr() const;
324 ConstantPoolCache** interpreter_frame_cache_addr() const;
325 oop* interpreter_frame_mirror_addr() const;
326
327 void interpreter_frame_set_mirror(oop mirror);
328
329 public:
330 // Entry frames
331 JavaCallWrapper* entry_frame_call_wrapper() const { return *entry_frame_call_wrapper_addr(); }
332 JavaCallWrapper* entry_frame_call_wrapper_if_safe(JavaThread* thread) const;
333 JavaCallWrapper** entry_frame_call_wrapper_addr() const;
334 intptr_t* entry_frame_argument_at(int offset) const;
335
336 // tells whether there is another chunk of Delta stack above
337 bool entry_frame_is_first() const;
338
339 // Safepoints
340
341 public:
342 oop saved_oop_result(RegisterMap* map) const;
343 void set_saved_oop_result(RegisterMap* map, oop obj);
344
345 // For debugging
346 private:
347 const char* print_name() const;
348
349 void describe_pd(FrameValues& values, int frame_no);
350
351 public:
352 void print_value() const { print_value_on(tty,NULL); }
353 void print_value_on(outputStream* st, JavaThread *thread) const;
354 void print_on(outputStream* st) const;
355 void interpreter_frame_print_on(outputStream* st) const;
356 void print_on_error(outputStream* st, char* buf, int buflen, bool verbose = false) const;
357 static void print_C_frame(outputStream* st, char* buf, int buflen, address pc);
358
359 // Add annotated descriptions of memory locations belonging to this frame to values
360 void describe(FrameValues& values, int frame_no);
361
362 // Conversion from a VMReg to physical stack location
363 oop* oopmapreg_to_location(VMReg reg, const RegisterMap* reg_map) const;
364
365 // Oops-do's
366 void oops_compiled_arguments_do(Symbol* signature, bool has_receiver, bool has_appendix, const RegisterMap* reg_map, OopClosure* f);
367 void oops_interpreted_do(OopClosure* f, const RegisterMap* map, bool query_oop_map_cache = true);
368
369 private:
370 void oops_interpreted_arguments_do(Symbol* signature, bool has_receiver, OopClosure* f);
371
372 // Iteration of oops
373 void oops_do_internal(OopClosure* f, CodeBlobClosure* cf, RegisterMap* map, bool use_interpreter_oop_map_cache);
374 void oops_entry_do(OopClosure* f, const RegisterMap* map);
375 void oops_code_blob_do(OopClosure* f, CodeBlobClosure* cf, const RegisterMap* map);
376 int adjust_offset(Method* method, int index); // helper for above fn
377 public:
378 // Memory management
379 void oops_do(OopClosure* f, CodeBlobClosure* cf, RegisterMap* map) { oops_do_internal(f, cf, map, true); }
380 void nmethods_do(CodeBlobClosure* cf);
381
382 // RedefineClasses support for finding live interpreted methods on the stack
383 void metadata_do(void f(Metadata*));
384
385 // Verification
386 void verify(const RegisterMap* map);
387 static bool verify_return_pc(address x);
388 // Usage:
389 // assert(frame::verify_return_pc(return_address), "must be a return pc");
390
391 NOT_PRODUCT(void pd_ps();) // platform dependent frame printing
392
393 #include CPU_HEADER(frame)
394
395 };
396
397 #ifndef PRODUCT
398 // A simple class to describe a location on the stack
399 class FrameValue {
400 public:
401 intptr_t* location;
402 char* description;
403 int owner;
404 int priority;
405
406 FrameValue() {
407 location = NULL;
408 description = NULL;
409 owner = -1;
410 priority = 0;
411 }
412
413 };
414
415
416 // A collection of described stack values that can print a symbolic
417 // description of the stack memory. Interpreter frame values can be
418 // in the caller frames so all the values are collected first and then
419 // sorted before being printed.
420 class FrameValues {
421 private:
422 GrowableArray<FrameValue> _values;
423
424 static int compare(FrameValue* a, FrameValue* b) {
425 if (a->location == b->location) {
426 return a->priority - b->priority;
427 }
428 return a->location - b->location;
429 }
430
431 public:
432 // Used by frame functions to describe locations.
433 void describe(int owner, intptr_t* location, const char* description, int priority = 0);
434
435 #ifdef ASSERT
436 void validate();
437 #endif
438 void print(JavaThread* thread);
439 };
440
441 #endif
442
443 //
444 // StackFrameStream iterates through the frames of a thread starting from
445 // top most frame. It automatically takes care of updating the location of
446 // all (callee-saved) registers. Notice: If a thread is stopped at
447 // a safepoint, all registers are saved, not only the callee-saved ones.
448 //
449 // Use:
450 //
451 // for(StackFrameStream fst(thread); !fst.is_done(); fst.next()) {
452 // ...
453 // }
454 //
455 class StackFrameStream : public StackObj {
456 private:
457 frame _fr;
458 RegisterMap _reg_map;
459 bool _is_done;
460 public:
461 StackFrameStream(JavaThread *thread, bool update = true);
462
463 // Iteration
464 inline bool is_done();
465 void next() { if (!_is_done) _fr = _fr.sender(&_reg_map); }
466
467 // Query
468 frame *current() { return &_fr; }
469 RegisterMap* register_map() { return &_reg_map; }
470 };
471
472 #endif // SHARE_VM_RUNTIME_FRAME_HPP