1 /*
  2  * Copyright (c) 1997, 2022, 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_RUNTIME_FRAME_HPP
 26 #define SHARE_RUNTIME_FRAME_HPP
 27 
 28 #include "code/vmregTypes.hpp"
 29 #include "compiler/oopMap.hpp"
 30 #include "oops/oopsHierarchy.hpp"
 31 #include "runtime/basicLock.hpp"
 32 #include "runtime/monitorChunk.hpp"
 33 #include "utilities/growableArray.hpp"
 34 #include "utilities/macros.hpp"
 35 #ifdef ZERO
 36 # include "stack_zero.hpp"
 37 #endif
 38 
 39 typedef class BytecodeInterpreter* interpreterState;
 40 
 41 class CodeBlob;
 42 class CompiledMethod;
 43 class FrameValues;
 44 class InterpreterOopMap;
 45 class JavaCallWrapper;
 46 class Method;
 47 class methodHandle;
 48 class RegisterMap;
 49 class vframeArray;
 50 
 51 enum class DerivedPointerIterationMode {
 52   _with_table,
 53   _directly,
 54   _ignore
 55 };
 56 
 57 // A frame represents a physical stack frame (an activation).  Frames
 58 // can be C or Java frames, and the Java frames can be interpreted or
 59 // compiled.  In contrast, vframes represent source-level activations,
 60 // so that one physical frame can correspond to multiple source level
 61 // frames because of inlining.
 62 
 63 class frame {
 64  private:
 65   // Instance variables:
 66   union {
 67     intptr_t* _sp; // stack pointer (from Thread::last_Java_sp)
 68     int _offset_sp; // used by frames in stack chunks
 69   };
 70   address   _pc; // program counter (the next instruction after the call)
 71   mutable CodeBlob* _cb; // CodeBlob that "owns" pc
 72   mutable const ImmutableOopMap* _oop_map; // oop map, for compiled/stubs frames only
 73   enum deopt_state {
 74     not_deoptimized,
 75     is_deoptimized,
 76     unknown
 77   };
 78 
 79   deopt_state _deopt_state;
 80 
 81   // Do internal pointers in interpreter frames use absolute adddresses or relative (to fp)?
 82   // Frames in stack chunks are on the Java heap and use relative addressing; on the stack
 83   // they use absolute addressing
 84   bool        _on_heap;  // This frame represents a frame on the heap.
 85   DEBUG_ONLY(int _frame_index;) // the frame index in a stack chunk; -1 when on a thread stack
 86 
 87   // We use different assertions to allow for intermediate states (e.g. during thawing or relativizing the frame)
 88   void assert_on_heap() const  { assert(is_heap_frame(), "Using offset with a non-chunk frame"); }
 89   void assert_offset() const   { assert(_frame_index >= 0,  "Using offset with a non-chunk frame"); assert_on_heap(); }
 90   void assert_absolute() const { assert(_frame_index == -1, "Using absolute addresses with a chunk frame"); }
 91 
 92  public:
 93   // Constructors
 94   frame();
 95 
 96   explicit frame(bool dummy) {} // no initialization
 97 
 98   explicit frame(intptr_t* sp);
 99 
100 #ifndef PRODUCT
101   // This is a generic constructor which is only used by pns() in debug.cpp.
102   // pns (i.e. print native stack) uses this constructor to create a starting
103   // frame for stack walking. The implementation of this constructor is platform
104   // dependent (i.e. SPARC doesn't need an 'fp' argument an will ignore it) but
105   // we want to keep the signature generic because pns() is shared code.
106   frame(void* sp, void* fp, void* pc);
107 #endif
108 
109   // Accessors
110 
111   // pc: Returns the pc at which this frame will continue normally.
112   // It must point at the beginning of the next instruction to execute.
113   address pc() const             { return _pc; }
114 
115   // This returns the pc that if you were in the debugger you'd see. Not
116   // the idealized value in the frame object. This undoes the magic conversion
117   // that happens for deoptimized frames. In addition it makes the value the
118   // hardware would want to see in the native frame. The only user (at this point)
119   // is deoptimization. It likely no one else should ever use it.
120   address raw_pc() const;
121 
122   void set_pc(address newpc);
123 
124   intptr_t* sp() const           { assert_absolute(); return _sp; }
125   void set_sp( intptr_t* newsp ) { _sp = newsp; }
126 
127   int offset_sp() const           { assert_offset();  return _offset_sp; }
128   void set_offset_sp( int newsp ) { assert_on_heap(); _offset_sp = newsp; }
129 
130   int frame_index() const {
131   #ifdef ASSERT
132     return _frame_index;
133   #else
134     return -1;
135   #endif
136   }
137   void set_frame_index( int index ) {
138     #ifdef ASSERT
139       _frame_index = index;
140     #endif
141   }
142 
143   static int sender_sp_ret_address_offset();
144 
145   CodeBlob* cb() const           { return _cb; }
146   inline CodeBlob* get_cb() const;
147   // inline void set_cb(CodeBlob* cb);
148 
149   const ImmutableOopMap* oop_map() const {
150     if (_oop_map == NULL) {
151       _oop_map = get_oop_map();
152     }
153     return _oop_map;
154   }
155 
156   // patching operations
157   void   patch_pc(Thread* thread, address pc);
158 
159   // Every frame needs to return a unique id which distinguishes it from all other frames.
160   // For sparc and ia32 use sp. ia64 can have memory frames that are empty so multiple frames
161   // will have identical sp values. For ia64 the bsp (fp) value will serve. No real frame
162   // should have an id() of NULL so it is a distinguishing value for an unmatchable frame.
163   // We also have relationals which allow comparing a frame to anoth frame's id() allow
164   // us to distinguish younger (more recent activation) from older (less recent activations)
165   // A NULL id is only valid when comparing for equality.
166 
167   intptr_t* id(void) const;
168   bool is_younger(intptr_t* id) const;
169   bool is_older(intptr_t* id) const;
170 
171   // testers
172 
173   // Compares for strict equality. Rarely used or needed.
174   // It can return a different result than f1.id() == f2.id()
175   bool equal(frame other) const;
176 
177   // type testers
178   bool is_empty()                const { return _pc == NULL; }
179   bool is_interpreted_frame()    const;
180   bool is_java_frame()           const;
181   bool is_entry_frame()          const;             // Java frame called from C?
182   bool is_stub_frame()           const;
183   bool is_ignored_frame()        const;
184   bool is_native_frame()         const;
185   bool is_runtime_frame()        const;
186   bool is_compiled_frame()       const;
187   bool is_safepoint_blob_frame() const;
188   bool is_deoptimized_frame()    const;
189   bool is_upcall_stub_frame()    const;
190   bool is_heap_frame()             const { return _on_heap; }
191 
192   // testers
193   bool is_first_frame() const; // oldest frame? (has no sender)
194   bool is_first_java_frame() const;              // same for Java frame
195   bool is_first_vthread_frame(JavaThread* thread) const;
196 
197   bool is_interpreted_frame_valid(JavaThread* thread) const;       // performs sanity checks on interpreted frames.
198 
199   // is this frame doing a call using the compiled calling convention?
200   bool is_compiled_caller() const {
201     return is_compiled_frame() || is_upcall_stub_frame();
202   }
203 
204   // tells whether this frame is marked for deoptimization
205   bool should_be_deoptimized() const;
206 
207   // tells whether this frame can be deoptimized
208   bool can_be_deoptimized() const;
209 
210   // the frame size in machine words
211   inline int frame_size() const;
212 
213   // the number of oops in the frame for non-interpreted frames
214   inline int num_oops() const;
215 
216   // the size, in words, of stack-passed arguments
217   inline int compiled_frame_stack_argsize() const;
218 
219   inline void interpreted_frame_oop_map(InterpreterOopMap* mask) const;
220 
221   // returns the sending frame
222   inline frame sender(RegisterMap* map) const;
223 
224   bool safe_for_sender(JavaThread *thread);
225 
226   // returns the sender, but skips conversion frames
227   frame real_sender(RegisterMap* map) const;
228 
229   // returns the sending Java frame, skipping any intermediate C frames
230   // NB: receiver must not be first frame
231   frame java_sender() const;
232 
233  private:
234   // Helper methods for better factored code in frame::sender
235   inline frame sender_for_compiled_frame(RegisterMap* map) const;
236   frame sender_for_entry_frame(RegisterMap* map) const;
237   frame sender_for_interpreter_frame(RegisterMap* map) const;
238   frame sender_for_native_frame(RegisterMap* map) const;
239   frame sender_for_upcall_stub_frame(RegisterMap* map) const;
240 
241   bool is_entry_frame_valid(JavaThread* thread) const;
242 
243   // All frames:
244 
245   // A low-level interface for vframes:
246 
247  public:
248 
249   intptr_t* addr_at(int index) const             { return &fp()[index];    }
250   intptr_t  at_absolute(int index) const         { return *addr_at(index); }
251   // Interpreter frames in continuation stacks are on the heap, and internal addresses are relative to fp.
252   intptr_t  at_relative(int index) const         { return (intptr_t)(fp() + fp()[index]); }
253 
254   intptr_t at(int index) const                   {
255     return _on_heap ? at_relative(index) : at_absolute(index);
256   }
257 
258   // accessors for locals
259   oop obj_at(int offset) const                   { return *obj_at_addr(offset);  }
260   void obj_at_put(int offset, oop value)         { *obj_at_addr(offset) = value; }
261 
262   jint int_at(int offset) const                  { return *int_at_addr(offset);  }
263   void int_at_put(int offset, jint value)        { *int_at_addr(offset) = value; }
264 
265   oop*      obj_at_addr(int offset) const        { return (oop*)     addr_at(offset); }
266 
267   oop*      adjusted_obj_at_addr(Method* method, int index) { return obj_at_addr(adjust_offset(method, index)); }
268 
269  private:
270   jint*    int_at_addr(int offset) const         { return (jint*)    addr_at(offset); }
271 
272  public:
273   // Link (i.e., the pointer to the previous frame)
274   // might crash if the frame has no parent
275   intptr_t* link() const;
276 
277   // Link (i.e., the pointer to the previous frame) or null if the link cannot be accessed
278   intptr_t* link_or_null() const;
279 
280   // Return address
281   address  sender_pc() const;
282 
283   // Support for deoptimization
284   void deoptimize(JavaThread* thread);
285 
286   // The frame's original SP, before any extension by an interpreted callee;
287   // used for packing debug info into vframeArray objects and vframeArray lookup.
288   intptr_t* unextended_sp() const;
289   void set_unextended_sp(intptr_t* value);
290 
291   int offset_unextended_sp() const;
292   void set_offset_unextended_sp(int value);
293 
294   // returns the stack pointer of the calling frame
295   intptr_t* sender_sp() const;
296 
297   // Returns the real 'frame pointer' for the current frame.
298   // This is the value expected by the platform ABI when it defines a
299   // frame pointer register. It may differ from the effective value of
300   // the FP register when that register is used in the JVM for other
301   // purposes (like compiled frames on some platforms).
302   // On other platforms, it is defined so that the stack area used by
303   // this frame goes from real_fp() to sp().
304   intptr_t* real_fp() const;
305 
306   // Deoptimization info, if needed (platform dependent).
307   // Stored in the initial_info field of the unroll info, to be used by
308   // the platform dependent deoptimization blobs.
309   intptr_t *initial_deoptimization_info();
310 
311   // Interpreter frames:
312 
313  private:
314   intptr_t** interpreter_frame_locals_addr() const;
315   intptr_t*  interpreter_frame_bcp_addr() const;
316   intptr_t*  interpreter_frame_mdp_addr() const;
317 
318  public:
319   // Locals
320 
321   // The _at version returns a pointer because the address is used for GC.
322   intptr_t* interpreter_frame_local_at(int index) const;
323 
324   void interpreter_frame_set_locals(intptr_t* locs);
325 
326   // byte code index
327   jint interpreter_frame_bci() const;
328 
329   // byte code pointer
330   address interpreter_frame_bcp() const;
331   void    interpreter_frame_set_bcp(address bcp);
332 
333   // method data pointer
334   address interpreter_frame_mdp() const;
335   void    interpreter_frame_set_mdp(address dp);
336 
337   // Find receiver out of caller's (compiled) argument list
338   oop retrieve_receiver(RegisterMap *reg_map);
339 
340   // Return the monitor owner and BasicLock for compiled synchronized
341   // native methods. Used by JVMTI's GetLocalInstance method
342   // (via VM_GetReceiver) to retrieve the receiver from a native wrapper frame.
343   BasicLock* get_native_monitor();
344   oop        get_native_receiver();
345 
346   // Find receiver for an invoke when arguments are just pushed on stack (i.e., callee stack-frame is
347   // not setup)
348   oop interpreter_callee_receiver(Symbol* signature);
349 
350 
351   oop* interpreter_callee_receiver_addr(Symbol* signature);
352 
353 
354   // expression stack (may go up or down, direction == 1 or -1)
355  public:
356   intptr_t* interpreter_frame_expression_stack() const;
357 
358   // The _at version returns a pointer because the address is used for GC.
359   intptr_t* interpreter_frame_expression_stack_at(jint offset) const;
360 
361   // top of expression stack
362   intptr_t* interpreter_frame_tos_at(jint offset) const;
363   intptr_t* interpreter_frame_tos_address() const;
364 
365 
366   jint  interpreter_frame_expression_stack_size() const;
367 
368   intptr_t* interpreter_frame_sender_sp() const;
369 
370   // template based interpreter deoptimization support
371   void  set_interpreter_frame_sender_sp(intptr_t* sender_sp);
372   void interpreter_frame_set_monitor_end(BasicObjectLock* value);
373 
374   // Address of the temp oop in the frame. Needed as GC root.
375   oop* interpreter_frame_temp_oop_addr() const;
376 
377   // BasicObjectLocks:
378   //
379   // interpreter_frame_monitor_begin is higher in memory than interpreter_frame_monitor_end
380   // Interpreter_frame_monitor_begin points to one element beyond the oldest one,
381   // interpreter_frame_monitor_end   points to the youngest one, or if there are none,
382   //                                 it points to one beyond where the first element will be.
383   // interpreter_frame_monitor_size  reports the allocation size of a monitor in the interpreter stack.
384   //                                 this value is >= BasicObjectLock::size(), and may be rounded up
385 
386   BasicObjectLock* interpreter_frame_monitor_begin() const;
387   BasicObjectLock* interpreter_frame_monitor_end()   const;
388   BasicObjectLock* next_monitor_in_interpreter_frame(BasicObjectLock* current) const;
389   BasicObjectLock* previous_monitor_in_interpreter_frame(BasicObjectLock* current) const;
390   static int interpreter_frame_monitor_size();
391 
392   void interpreter_frame_verify_monitor(BasicObjectLock* value) const;
393 
394   // Return/result value from this interpreter frame
395   // If the method return type is T_OBJECT or T_ARRAY populates oop_result
396   // For other (non-T_VOID) the appropriate field in the jvalue is populated
397   // with the result value.
398   // Should only be called when at method exit when the method is not
399   // exiting due to an exception.
400   BasicType interpreter_frame_result(oop* oop_result, jvalue* value_result);
401 
402  public:
403   // Method & constant pool cache
404   Method* interpreter_frame_method() const;
405   void interpreter_frame_set_method(Method* method);
406   Method** interpreter_frame_method_addr() const;
407   ConstantPoolCache** interpreter_frame_cache_addr() const;
408   oop* interpreter_frame_mirror_addr() const;
409 
410   void interpreter_frame_set_mirror(oop mirror);
411 
412  public:
413   // Entry frames
414   JavaCallWrapper* entry_frame_call_wrapper() const { return *entry_frame_call_wrapper_addr(); }
415   JavaCallWrapper* entry_frame_call_wrapper_if_safe(JavaThread* thread) const;
416   JavaCallWrapper** entry_frame_call_wrapper_addr() const;
417   intptr_t* entry_frame_argument_at(int offset) const;
418 
419   // tells whether there is another chunk of Delta stack above
420   bool entry_frame_is_first() const;
421   bool upcall_stub_frame_is_first() const;
422 
423   // Safepoints
424 
425  public:
426   oop saved_oop_result(RegisterMap* map) const;
427   void set_saved_oop_result(RegisterMap* map, oop obj);
428 
429   // For debugging
430  private:
431   const char* print_name() const;
432 
433   void describe_pd(FrameValues& values, int frame_no);
434 
435  public:
436   void print_value() const { print_value_on(tty,NULL); }
437   void print_value_on(outputStream* st, JavaThread *thread) const;
438   void print_on(outputStream* st) const;
439   void interpreter_frame_print_on(outputStream* st) const;
440   void print_on_error(outputStream* st, char* buf, int buflen, bool verbose = false) const;
441   static void print_C_frame(outputStream* st, char* buf, int buflen, address pc);
442 
443   // Add annotated descriptions of memory locations belonging to this frame to values
444   void describe(FrameValues& values, int frame_no, const RegisterMap* reg_map=NULL);
445 
446   // Conversion from a VMReg to physical stack location
447   template <typename RegisterMapT>
448   address oopmapreg_to_location(VMReg reg, const RegisterMapT* reg_map) const;
449   template <typename RegisterMapT>
450   oop* oopmapreg_to_oop_location(VMReg reg, const RegisterMapT* reg_map) const;
451 
452   // Oops-do's
453   void oops_compiled_arguments_do(Symbol* signature, bool has_receiver, bool has_appendix, const RegisterMap* reg_map, OopClosure* f) const;
454   void oops_interpreted_do(OopClosure* f, const RegisterMap* map, bool query_oop_map_cache = true) const;
455 
456  private:
457   void oops_interpreted_arguments_do(Symbol* signature, bool has_receiver, OopClosure* f) const;
458 
459   // Iteration of oops
460   void oops_do_internal(OopClosure* f, CodeBlobClosure* cf,
461                         DerivedOopClosure* df, DerivedPointerIterationMode derived_mode,
462                         const RegisterMap* map, bool use_interpreter_oop_map_cache) const;
463 
464   void oops_entry_do(OopClosure* f, const RegisterMap* map) const;
465   void oops_code_blob_do(OopClosure* f, CodeBlobClosure* cf,
466                          DerivedOopClosure* df, DerivedPointerIterationMode derived_mode,
467                          const RegisterMap* map) const;
468   int adjust_offset(Method* method, int index); // helper for above fn
469  public:
470   // Memory management
471   void oops_do(OopClosure* f, CodeBlobClosure* cf, const RegisterMap* map) {
472 #if COMPILER2_OR_JVMCI
473     DerivedPointerIterationMode dpim = DerivedPointerTable::is_active() ?
474                                        DerivedPointerIterationMode::_with_table :
475                                        DerivedPointerIterationMode::_ignore;
476 #else
477     DerivedPointerIterationMode dpim = DerivedPointerIterationMode::_ignore;;
478 #endif
479     oops_do_internal(f, cf, NULL, dpim, map, true);
480   }
481 
482   void oops_do(OopClosure* f, CodeBlobClosure* cf, DerivedOopClosure* df, const RegisterMap* map) {
483     oops_do_internal(f, cf, df, DerivedPointerIterationMode::_ignore, map, true);
484   }
485 
486   void oops_do(OopClosure* f, CodeBlobClosure* cf, const RegisterMap* map,
487                DerivedPointerIterationMode derived_mode) const {
488     oops_do_internal(f, cf, NULL, derived_mode, map, true);
489   }
490 
491   void nmethods_do(CodeBlobClosure* cf) const;
492 
493   // RedefineClasses support for finding live interpreted methods on the stack
494   void metadata_do(MetadataClosure* f) const;
495 
496   // Verification
497   void verify(const RegisterMap* map) const;
498   static bool verify_return_pc(address x);
499   // Usage:
500   // assert(frame::verify_return_pc(return_address), "must be a return pc");
501 
502 #include CPU_HEADER(frame)
503 
504 };
505 
506 #ifndef PRODUCT
507 // A simple class to describe a location on the stack
508 class FrameValue {
509  public:
510   intptr_t* location;
511   char* description;
512   int owner;
513   int priority;
514 
515   FrameValue() {
516     location = NULL;
517     description = NULL;
518     owner = -1;
519     priority = 0;
520   }
521 };
522 
523 
524 // A collection of described stack values that can print a symbolic
525 // description of the stack memory.  Interpreter frame values can be
526 // in the caller frames so all the values are collected first and then
527 // sorted before being printed.
528 class FrameValues {
529  private:
530   GrowableArray<FrameValue> _values;
531 
532   static int compare(FrameValue* a, FrameValue* b) {
533     if (a->location == b->location) {
534       return a->priority - b->priority;
535     }
536     return a->location - b->location;
537   }
538 
539   void print_on(outputStream* out, int min_index, int max_index, intptr_t* v0, intptr_t* v1,
540                 bool on_heap = false);
541 
542  public:
543   // Used by frame functions to describe locations.
544   void describe(int owner, intptr_t* location, const char* description, int priority = 0);
545 
546 #ifdef ASSERT
547   void validate();
548 #endif
549   void print(JavaThread* thread) { print_on(thread, tty); }
550   void print_on(JavaThread* thread, outputStream* out);
551   void print(stackChunkOop chunk) { print_on(chunk, tty); }
552   void print_on(stackChunkOop chunk, outputStream* out);
553 };
554 
555 #endif
556 
557 
558 #endif // SHARE_RUNTIME_FRAME_HPP