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