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