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