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