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_DEOPTIMIZATION_HPP
 26 #define SHARE_RUNTIME_DEOPTIMIZATION_HPP
 27 
 28 #include "interpreter/bytecodes.hpp"
 29 #include "memory/allocation.hpp"
 30 #include "runtime/frame.hpp"
 31 
 32 class ProfileData;
 33 class vframeArray;
 34 class MonitorInfo;
 35 class MonitorValue;
 36 class ObjectValue;
 37 class AutoBoxObjectValue;
 38 class ScopeValue;
 39 class compiledVFrame;
 40 
 41 template<class E> class GrowableArray;
 42 
 43 class Deoptimization : AllStatic {
 44   friend class VMStructs;
 45   friend class EscapeBarrier;
 46 
 47  public:
 48   // What condition caused the deoptimization?
 49   enum DeoptReason {
 50     Reason_many = -1,             // indicates presence of several reasons
 51     Reason_none = 0,              // indicates absence of a relevant deopt.
 52     // Next 8 reasons are recorded per bytecode in DataLayout::trap_bits.
 53     // This is more complicated for JVMCI as JVMCI may deoptimize to *some* bytecode before the
 54     // bytecode that actually caused the deopt (with inlining, JVMCI may even deoptimize to a
 55     // bytecode in another method):
 56     //  - bytecode y in method b() causes deopt
 57     //  - JVMCI deoptimizes to bytecode x in method a()
 58     // -> the deopt reason will be recorded for method a() at bytecode x
 59     Reason_null_check,            // saw unexpected null or zero divisor (@bci)
 60     Reason_null_assert,           // saw unexpected non-null or non-zero (@bci)
 61     Reason_range_check,           // saw unexpected array index (@bci)
 62     Reason_class_check,           // saw unexpected object class (@bci)
 63     Reason_array_check,           // saw unexpected array class (aastore @bci)
 64     Reason_intrinsic,             // saw unexpected operand to intrinsic (@bci)
 65     Reason_bimorphic,             // saw unexpected object class in bimorphic inlining (@bci)
 66 
 67 #if INCLUDE_JVMCI
 68     Reason_unreached0             = Reason_null_assert,
 69     Reason_type_checked_inlining  = Reason_intrinsic,
 70     Reason_optimized_type_check   = Reason_bimorphic,
 71 #endif
 72 
 73     Reason_profile_predicate,     // compiler generated predicate moved from frequent branch in a loop failed
 74 
 75     // recorded per method
 76     Reason_unloaded,              // unloaded class or constant pool entry
 77     Reason_uninitialized,         // bad class state (uninitialized)
 78     Reason_initialized,           // class has been fully initialized
 79     Reason_unreached,             // code is not reached, compiler
 80     Reason_unhandled,             // arbitrary compiler limitation
 81     Reason_constraint,            // arbitrary runtime constraint violated
 82     Reason_div0_check,            // a null_check due to division by zero
 83     Reason_age,                   // nmethod too old; tier threshold reached
 84     Reason_predicate,             // compiler generated predicate failed
 85     Reason_loop_limit_check,      // compiler generated loop limits check failed
 86     Reason_speculate_class_check, // saw unexpected object class from type speculation
 87     Reason_speculate_null_check,  // saw unexpected null from type speculation
 88     Reason_speculate_null_assert, // saw unexpected null from type speculation
 89     Reason_rtm_state_change,      // rtm state change detected
 90     Reason_unstable_if,           // a branch predicted always false was taken
 91     Reason_unstable_fused_if,     // fused two ifs that had each one untaken branch. One is now taken.
 92     Reason_receiver_constraint,   // receiver subtype check failed
 93 #if INCLUDE_JVMCI
 94     Reason_aliasing,              // optimistic assumption about aliasing failed
 95     Reason_transfer_to_interpreter, // explicit transferToInterpreter()
 96     Reason_not_compiled_exception_handler,
 97     Reason_unresolved,
 98     Reason_jsr_mismatch,
 99 #endif
100 
101     // Reason_tenured is counted separately, add normal counted Reasons above.
102     // Related to MethodData::_trap_hist_limit where Reason_tenured isn't included
103     Reason_tenured,               // age of the code has reached the limit
104     Reason_LIMIT,
105 
106     // Note:  Keep this enum in sync. with _trap_reason_name.
107     Reason_RECORDED_LIMIT = Reason_profile_predicate  // some are not recorded per bc
108     // Note:  Reason_RECORDED_LIMIT should fit into 31 bits of
109     // DataLayout::trap_bits.  This dependency is enforced indirectly
110     // via asserts, to avoid excessive direct header-to-header dependencies.
111     // See Deoptimization::trap_state_reason and class DataLayout.
112   };
113 
114   // What action must be taken by the runtime?
115   enum DeoptAction {
116     Action_none,                  // just interpret, do not invalidate nmethod
117     Action_maybe_recompile,       // recompile the nmethod; need not invalidate
118     Action_reinterpret,           // invalidate the nmethod, reset IC, maybe recompile
119     Action_make_not_entrant,      // invalidate the nmethod, recompile (probably)
120     Action_make_not_compilable,   // invalidate the nmethod and do not compile
121     Action_LIMIT
122     // Note:  Keep this enum in sync. with _trap_action_name.
123   };
124 
125   enum {
126     _action_bits = 3,
127     _reason_bits = 5,
128     _debug_id_bits = 23,
129     _action_shift = 0,
130     _reason_shift = _action_shift+_action_bits,
131     _debug_id_shift = _reason_shift+_reason_bits,
132     BC_CASE_LIMIT = PRODUCT_ONLY(1) NOT_PRODUCT(4) // for _deoptimization_hist
133   };
134 
135   enum UnpackType {
136     Unpack_deopt                = 0, // normal deoptimization, use pc computed in unpack_vframe_on_stack
137     Unpack_exception            = 1, // exception is pending
138     Unpack_uncommon_trap        = 2, // redo last byte code (C2 only)
139     Unpack_reexecute            = 3, // reexecute bytecode (C1 only)
140     Unpack_none                 = 4, // not deoptimizing the frame, just reallocating/relocking for JVMTI
141     Unpack_LIMIT                = 5
142   };
143 
144 #if INCLUDE_JVMCI
145   // Can reconstruct virtualized unsafe large accesses to byte arrays.
146   static const int _support_large_access_byte_array_virtualization = 1;
147 #endif
148 
149   // Make all nmethods that are marked_for_deoptimization not_entrant and deoptimize any live
150   // activations using those nmethods.  If an nmethod is passed as an argument then it is
151   // marked_for_deoptimization and made not_entrant.  Otherwise a scan of the code cache is done to
152   // find all marked nmethods and they are made not_entrant.
153   static void deoptimize_all_marked(nmethod* nmethod_only = NULL);
154 
155  public:
156   // Deoptimizes a frame lazily. Deopt happens on return to the frame.
157   static void deoptimize(JavaThread* thread, frame fr, DeoptReason reason = Reason_constraint);
158 
159 #if INCLUDE_JVMCI
160   static address deoptimize_for_missing_exception_handler(CompiledMethod* cm);
161 #endif
162 
163   static oop get_cached_box(AutoBoxObjectValue* bv, frame* fr, RegisterMap* reg_map, TRAPS);
164 
165   private:
166   // Does the actual work for deoptimizing a single frame
167   static void deoptimize_single_frame(JavaThread* thread, frame fr, DeoptReason reason);
168 
169 #if COMPILER2_OR_JVMCI
170   // Deoptimize objects, that is reallocate and relock them, just before they
171   // escape through JVMTI.  The given vframes cover one physical frame.
172   static bool deoptimize_objects_internal(JavaThread* thread, GrowableArray<compiledVFrame*>* chunk,
173                                           bool& realloc_failures);
174 
175  public:
176 
177   // Support for restoring non-escaping objects
178   static bool realloc_objects(JavaThread* thread, frame* fr, RegisterMap* reg_map, GrowableArray<ScopeValue*>* objects, TRAPS);
179   static bool realloc_inline_type_result(InlineKlass* vk, const RegisterMap& map, GrowableArray<Handle>& return_oops, TRAPS);
180   static void reassign_type_array_elements(frame* fr, RegisterMap* reg_map, ObjectValue* sv, typeArrayOop obj, BasicType type);
181   static void reassign_object_array_elements(frame* fr, RegisterMap* reg_map, ObjectValue* sv, objArrayOop obj);
182   static void reassign_flat_array_elements(frame* fr, RegisterMap* reg_map, ObjectValue* sv, flatArrayOop obj, FlatArrayKlass* vak, bool skip_internal, TRAPS);
183   static void reassign_fields(frame* fr, RegisterMap* reg_map, GrowableArray<ScopeValue*>* objects, bool realloc_failures, bool skip_internal, TRAPS);
184   static bool relock_objects(JavaThread* thread, GrowableArray<MonitorInfo*>* monitors,
185                              JavaThread* deoptee_thread, frame& fr, int exec_mode, bool realloc_failures);
186   static void pop_frames_failed_reallocs(JavaThread* thread, vframeArray* array);
187 #endif // COMPILER2_OR_JVMCI
188 
189   public:
190   static vframeArray* create_vframeArray(JavaThread* thread, frame fr, RegisterMap *reg_map, GrowableArray<compiledVFrame*>* chunk, bool realloc_failures);
191 
192   // Interface used for unpacking deoptimized frames
193 
194   // UnrollBlock is returned by fetch_unroll_info() to the deoptimization handler (blob).
195   // This is only a CheapObj to ease debugging after a deopt failure
196   class UnrollBlock : public CHeapObj<mtCompiler> {
197     friend class VMStructs;
198     friend class JVMCIVMStructs;
199    private:
200     int       _size_of_deoptimized_frame; // Size, in bytes, of current deoptimized frame
201     int       _caller_adjustment;         // Adjustment, in bytes, to caller's SP by initial interpreted frame
202     int       _number_of_frames;          // Number frames to unroll
203     int       _total_frame_sizes;         // Total of number*sizes frames
204     intptr_t* _frame_sizes;               // Array of frame sizes, in bytes, for unrolling the stack
205     address*  _frame_pcs;                 // Array of frame pc's, in bytes, for unrolling the stack
206     intptr_t* _register_block;            // Block for storing callee-saved registers.
207     BasicType _return_type;               // Tells if we have to restore double or long return value
208     intptr_t  _initial_info;              // Platform dependent data for the sender frame (was FP on x86)
209     int       _caller_actual_parameters;  // The number of actual arguments at the
210                                           // interpreted caller of the deoptimized frame
211     int       _unpack_kind;               // exec_mode that can be changed during fetch_unroll_info
212 
213     // The following fields are used as temps during the unpacking phase
214     // (which is tight on registers, especially on x86). They really ought
215     // to be PD variables but that involves moving this class into its own
216     // file to use the pd include mechanism. Maybe in a later cleanup ...
217     intptr_t  _counter_temp;              // SHOULD BE PD VARIABLE (x86 frame count temp)
218     intptr_t  _sender_sp_temp;            // SHOULD BE PD VARIABLE (x86 sender_sp)
219    public:
220     // Constructor
221     UnrollBlock(int  size_of_deoptimized_frame,
222                 int  caller_adjustment,
223                 int  caller_actual_parameters,
224                 int  number_of_frames,
225                 intptr_t* frame_sizes,
226                 address* frames_pcs,
227                 BasicType return_type,
228                 int unpack_kind);
229     ~UnrollBlock();
230 
231     // Returns where a register is located.
232     intptr_t* value_addr_at(int register_number) const;
233 
234     // Accessors
235     intptr_t* frame_sizes()  const { return _frame_sizes; }
236     int number_of_frames()  const { return _number_of_frames; }
237     address*  frame_pcs()   const { return _frame_pcs ; }
238     int  unpack_kind()   const { return _unpack_kind; }
239 
240     // Returns the total size of frames
241     int size_of_frames() const;
242 
243     void set_initial_info(intptr_t info) { _initial_info = info; }
244 
245     int caller_actual_parameters() const { return _caller_actual_parameters; }
246 
247     // Accessors used by the code generator for the unpack stub.
248     static int size_of_deoptimized_frame_offset_in_bytes() { return offset_of(UnrollBlock, _size_of_deoptimized_frame); }
249     static int caller_adjustment_offset_in_bytes()         { return offset_of(UnrollBlock, _caller_adjustment);         }
250     static int number_of_frames_offset_in_bytes()          { return offset_of(UnrollBlock, _number_of_frames);          }
251     static int frame_sizes_offset_in_bytes()               { return offset_of(UnrollBlock, _frame_sizes);               }
252     static int total_frame_sizes_offset_in_bytes()         { return offset_of(UnrollBlock, _total_frame_sizes);         }
253     static int frame_pcs_offset_in_bytes()                 { return offset_of(UnrollBlock, _frame_pcs);                 }
254     static int register_block_offset_in_bytes()            { return offset_of(UnrollBlock, _register_block);            }
255     static int return_type_offset_in_bytes()               { return offset_of(UnrollBlock, _return_type);               }
256     static int counter_temp_offset_in_bytes()              { return offset_of(UnrollBlock, _counter_temp);              }
257     static int initial_info_offset_in_bytes()              { return offset_of(UnrollBlock, _initial_info);              }
258     static int unpack_kind_offset_in_bytes()               { return offset_of(UnrollBlock, _unpack_kind);               }
259     static int sender_sp_temp_offset_in_bytes()            { return offset_of(UnrollBlock, _sender_sp_temp);            }
260 
261     BasicType return_type() const { return _return_type; }
262     void print();
263   };
264 
265   //** Returns an UnrollBlock continuing information
266   // how to make room for the resulting interpreter frames.
267   // Called by assembly stub after execution has returned to
268   // deoptimized frame.
269   // @argument thread.     Thread where stub_frame resides.
270   // @see OptoRuntime::deoptimization_fetch_unroll_info_C
271   static UnrollBlock* fetch_unroll_info(JavaThread* current, int exec_mode);
272 
273   //** Unpacks vframeArray onto execution stack
274   // Called by assembly stub after execution has returned to
275   // deoptimized frame and after the stack unrolling.
276   // @argument thread.     Thread where stub_frame resides.
277   // @argument exec_mode.  Determines how execution should be continued in top frame.
278   //                       0 means continue after current byte code
279   //                       1 means exception has happened, handle exception
280   //                       2 means reexecute current bytecode (for uncommon traps).
281   // @see OptoRuntime::deoptimization_unpack_frames_C
282   // Return BasicType of call return type, if any
283   static BasicType unpack_frames(JavaThread* thread, int exec_mode);
284 
285   // Cleans up deoptimization bits on thread after unpacking or in the
286   // case of an exception.
287   static void cleanup_deopt_info(JavaThread  *thread,
288                                  vframeArray * array);
289 
290   // Restores callee saved values from deoptimized frame into oldest interpreter frame
291   // so caller of the deoptimized frame will get back the values it expects.
292   static void unwind_callee_save_values(frame* f, vframeArray* vframe_array);
293 
294   //** Performs an uncommon trap for compiled code.
295   // The top most compiler frame is converted into interpreter frames
296   static UnrollBlock* uncommon_trap(JavaThread* current, jint unloaded_class_index, jint exec_mode);
297   // Helper routine that enters the VM and may block
298   static void uncommon_trap_inner(JavaThread* current, jint unloaded_class_index);
299 
300   //** Deoptimizes the frame identified by id.
301   // Only called from VMDeoptimizeFrame
302   // @argument thread.     Thread where stub_frame resides.
303   // @argument id.         id of frame that should be deoptimized.
304   static void deoptimize_frame_internal(JavaThread* thread, intptr_t* id, DeoptReason reason);
305 
306   // if thread is not the current thread then execute
307   // VM_DeoptimizeFrame otherwise deoptimize directly.
308   static void deoptimize_frame(JavaThread* thread, intptr_t* id, DeoptReason reason);
309   static void deoptimize_frame(JavaThread* thread, intptr_t* id);
310 
311   // Statistics
312   static void gather_statistics(DeoptReason reason, DeoptAction action,
313                                 Bytecodes::Code bc = Bytecodes::_illegal);
314   static void print_statistics();
315 
316   // How much room to adjust the last frame's SP by, to make space for
317   // the callee's interpreter frame (which expects locals to be next to
318   // incoming arguments)
319   static int last_frame_adjust(int callee_parameters, int callee_locals);
320 
321   // trap_request codes
322   static DeoptReason trap_request_reason(int trap_request) {
323     if (trap_request < 0)
324       return (DeoptReason)
325         ((~(trap_request) >> _reason_shift) & right_n_bits(_reason_bits));
326     else
327       // standard reason for unloaded CP entry
328       return Reason_unloaded;
329   }
330   static DeoptAction trap_request_action(int trap_request) {
331     if (trap_request < 0)
332       return (DeoptAction)
333         ((~(trap_request) >> _action_shift) & right_n_bits(_action_bits));
334     else
335       // standard action for unloaded CP entry
336       return _unloaded_action;
337   }
338   static int trap_request_debug_id(int trap_request) {
339     if (trap_request < 0) {
340       return ((~(trap_request) >> _debug_id_shift) & right_n_bits(_debug_id_bits));
341     } else {
342       // standard action for unloaded CP entry
343       return 0;
344     }
345   }
346   static int trap_request_index(int trap_request) {
347     if (trap_request < 0)
348       return -1;
349     else
350       return trap_request;
351   }
352   static int make_trap_request(DeoptReason reason, DeoptAction action,
353                                int index = -1) {
354     assert((1 << _reason_bits) >= Reason_LIMIT, "enough bits");
355     assert((1 << _action_bits) >= Action_LIMIT, "enough bits");
356     int trap_request;
357     if (index != -1)
358       trap_request = index;
359     else
360       trap_request = (~(((reason) << _reason_shift)
361                         + ((action) << _action_shift)));
362     assert(reason == trap_request_reason(trap_request), "valid reason");
363     assert(action == trap_request_action(trap_request), "valid action");
364     assert(index  == trap_request_index(trap_request),  "valid index");
365     return trap_request;
366   }
367 
368   // The trap_state stored in a MDO is decoded here.
369   // It records two items of information.
370   //  reason:  If a deoptimization happened here, what its reason was,
371   //           or if there were multiple deopts with differing reasons.
372   //  recompiled: If a deoptimization here triggered a recompilation.
373   // Note that not all reasons are recorded per-bci.
374   static DeoptReason trap_state_reason(int trap_state);
375   static int  trap_state_has_reason(int trap_state, int reason);
376   static int  trap_state_add_reason(int trap_state, int reason);
377   static bool trap_state_is_recompiled(int trap_state);
378   static int  trap_state_set_recompiled(int trap_state, bool z);
379   static const char* format_trap_state(char* buf, size_t buflen,
380                                        int trap_state);
381 
382   static bool reason_is_recorded_per_bytecode(DeoptReason reason) {
383     return reason > Reason_none && reason <= Reason_RECORDED_LIMIT;
384   }
385 
386   static DeoptReason reason_recorded_per_bytecode_if_any(DeoptReason reason) {
387     if (reason_is_recorded_per_bytecode(reason))
388       return reason;
389     else if (reason == Reason_div0_check) // null check due to divide-by-zero?
390       return Reason_null_check;           // recorded per BCI as a null check
391     else if (reason == Reason_speculate_class_check)
392       return Reason_class_check;
393     else if (reason == Reason_speculate_null_check)
394       return Reason_null_check;
395     else if (reason == Reason_speculate_null_assert)
396       return Reason_null_assert;
397     else if (reason == Reason_unstable_if)
398       return Reason_intrinsic;
399     else if (reason == Reason_unstable_fused_if)
400       return Reason_range_check;
401     else
402       return Reason_none;
403   }
404 
405   static bool reason_is_speculate(int reason) {
406     if (reason == Reason_speculate_class_check ||
407         reason == Reason_speculate_null_check ||
408         reason == Reason_speculate_null_assert) {
409       return true;
410     }
411     return false;
412   }
413 
414   static DeoptReason reason_null_check(bool speculative) {
415     return speculative ? Deoptimization::Reason_speculate_null_check : Deoptimization::Reason_null_check;
416   }
417 
418   static DeoptReason reason_class_check(bool speculative) {
419     return speculative ? Deoptimization::Reason_speculate_class_check : Deoptimization::Reason_class_check;
420   }
421 
422   static DeoptReason reason_null_assert(bool speculative) {
423     return speculative ? Deoptimization::Reason_speculate_null_assert : Deoptimization::Reason_null_assert;
424   }
425 
426   static uint per_method_trap_limit(int reason) {
427     return reason_is_speculate(reason) ? (uint)PerMethodSpecTrapLimit : (uint)PerMethodTrapLimit;
428   }
429 
430   static const char* trap_reason_name(int reason);
431   static const char* trap_action_name(int action);
432   // Format like reason='foo' action='bar' index='123'.
433   // This is suitable both for XML and for tty output.
434   static const char* format_trap_request(char* buf, size_t buflen,
435                                          int trap_request);
436 
437   static jint total_deoptimization_count();
438 
439   // JVMTI PopFrame support
440 
441   // Preserves incoming arguments to the popped frame when it is
442   // returning to a deoptimized caller
443   static void popframe_preserve_args(JavaThread* thread, int bytes_to_save, void* start_address);
444 
445   static MethodData* get_method_data(JavaThread* thread, const methodHandle& m, bool create_if_missing);
446  private:
447   // Update the mdo's count and per-BCI reason bits, returning previous state:
448   static ProfileData* query_update_method_data(MethodData* trap_mdo,
449                                                int trap_bci,
450                                                DeoptReason reason,
451                                                bool update_total_trap_count,
452 #if INCLUDE_JVMCI
453                                                bool is_osr,
454 #endif
455                                                Method* compiled_method,
456                                                //outputs:
457                                                uint& ret_this_trap_count,
458                                                bool& ret_maybe_prior_trap,
459                                                bool& ret_maybe_prior_recompile);
460   // class loading support for uncommon trap
461   static void load_class_by_index(const constantPoolHandle& constant_pool, int index, TRAPS);
462 
463   static UnrollBlock* fetch_unroll_info_helper(JavaThread* current, int exec_mode);
464 
465   static DeoptAction _unloaded_action; // == Action_reinterpret;
466   static const char* _trap_reason_name[];
467   static const char* _trap_action_name[];
468 
469   static juint _deoptimization_hist[Reason_LIMIT][1+Action_LIMIT][BC_CASE_LIMIT];
470   // Note:  Histogram array size is 1-2 Kb.
471 
472  public:
473   static void update_method_data_from_interpreter(MethodData* trap_mdo, int trap_bci, int reason);
474 };
475 
476 
477 class DeoptimizationMarker : StackObj {  // for profiling
478   static bool _is_active;
479 public:
480   DeoptimizationMarker()  { _is_active = true; }
481   ~DeoptimizationMarker() { _is_active = false; }
482   static bool is_active() { return _is_active; }
483 };
484 
485 #endif // SHARE_RUNTIME_DEOPTIMIZATION_HPP