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