deoptimization.hpp revision 2273:1d1603768966
19313Ssos/* 2230132Suqs * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved. 39313Ssos * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 49313Ssos * 59313Ssos * This code is free software; you can redistribute it and/or modify it 69313Ssos * under the terms of the GNU General Public License version 2 only, as 79313Ssos * published by the Free Software Foundation. 89313Ssos * 99313Ssos * This code is distributed in the hope that it will be useful, but WITHOUT 109313Ssos * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 119313Ssos * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 12111798Sdes * version 2 for more details (a copy is included in the LICENSE file that 139313Ssos * accompanied this code). 149313Ssos * 159313Ssos * You should have received a copy of the GNU General Public License version 169313Ssos * 2 along with this work; if not, write to the Free Software Foundation, 179313Ssos * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 1897748Sschweikh * 199313Ssos * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 209313Ssos * or visit www.oracle.com if you need additional information or have any 219313Ssos * questions. 229313Ssos * 239313Ssos */ 249313Ssos 259313Ssos#ifndef SHARE_VM_RUNTIME_DEOPTIMIZATION_HPP 269313Ssos#define SHARE_VM_RUNTIME_DEOPTIMIZATION_HPP 279313Ssos 289313Ssos#include "memory/allocation.hpp" 299313Ssos#include "runtime/frame.inline.hpp" 309313Ssos 319313Ssosclass ProfileData; 32115705Sobrienclass vframeArray; 33115705Sobrienclass MonitorValue; 34115705Sobrienclass ObjectValue; 359313Ssos 369313Ssosclass Deoptimization : AllStatic { 379313Ssos public: 389313Ssos // What condition caused the deoptimization? 399313Ssos enum DeoptReason { 409313Ssos Reason_many = -1, // indicates presence of several reasons 4131561Sbde Reason_none = 0, // indicates absence of a relevant deopt. 4276166Smarkm // Next 7 reasons are recorded per bytecode in DataLayout::trap_bits 4376166Smarkm Reason_null_check, // saw unexpected null or zero divisor (@bci) 4415494Sbde Reason_null_assert, // saw unexpected non-null or non-zero (@bci) 45220373Strasz Reason_range_check, // saw unexpected array index (@bci) 4676166Smarkm Reason_class_check, // saw unexpected object class (@bci) 4715494Sbde Reason_array_check, // saw unexpected array class (aastore @bci) 489313Ssos Reason_intrinsic, // saw unexpected operand to intrinsic (@bci) 499313Ssos Reason_bimorphic, // saw unexpected object class in bimorphic inlining (@bci) 509313Ssos 5112689Speter Reason_unloaded, // unloaded class or constant pool entry 5212689Speter Reason_uninitialized, // bad class state (uninitialized) 5312689Speter Reason_unreached, // code is not reached, compiler 5412842Sbde Reason_unhandled, // arbitrary compiler limitation 559313Ssos Reason_constraint, // arbitrary runtime constraint violated 5614331Speter Reason_div0_check, // a null_check due to division by zero 5712458Sbde Reason_age, // nmethod too old; tier threshold reached 5892765Salfred Reason_predicate, // compiler generated predicate failed 5912458Sbde Reason_LIMIT, 6033181Seivind // Note: Keep this enum in sync. with _trap_reason_name. 61105441Smarkm Reason_RECORDED_LIMIT = Reason_bimorphic // some are not recorded per bc 629313Ssos // Note: Reason_RECORDED_LIMIT should be < 8 to fit into 3 bits of 6318024Sbde // DataLayout::trap_bits. This dependency is enforced indirectly 6424848Sdyson // via asserts, to avoid excessive direct header-to-header dependencies. 6514703Sbde // See Deoptimization::trap_state_reason and class DataLayout. 6614703Sbde }; 6714703Sbde 68231885Skib // What action must be taken by the runtime? 699313Ssos enum DeoptAction { 709313Ssos Action_none, // just interpret, do not invalidate nmethod 719313Ssos Action_maybe_recompile, // recompile the nmethod; need not invalidate 729313Ssos Action_reinterpret, // invalidate the nmethod, reset IC, maybe recompile 739313Ssos Action_make_not_entrant, // invalidate the nmethod, recompile (probably) 749313Ssos Action_make_not_compilable, // invalidate the nmethod and do not compile 759313Ssos Action_LIMIT 769313Ssos // Note: Keep this enum in sync. with _trap_action_name. 779313Ssos }; 789313Ssos 799313Ssos enum { 809313Ssos _action_bits = 3, 819313Ssos _reason_bits = 4, 829313Ssos _action_shift = 0, 839313Ssos _reason_shift = _action_shift+_action_bits, 849313Ssos BC_CASE_LIMIT = PRODUCT_ONLY(1) NOT_PRODUCT(4) // for _deoptimization_hist 859313Ssos }; 869313Ssos 879313Ssos enum UnpackType { 889313Ssos Unpack_deopt = 0, // normal deoptimization, use pc computed in unpack_vframe_on_stack 899313Ssos Unpack_exception = 1, // exception is pending 9014331Speter Unpack_uncommon_trap = 2, // redo last byte code (C2 only) 9137950Sbde Unpack_reexecute = 3 // reexecute bytecode (C1 only) 9237950Sbde }; 9314331Speter 949313Ssos // Checks all compiled methods. Invalid methods are deleted and 959313Ssos // corresponding activations are deoptimized. 969313Ssos static int deoptimize_dependents(); 979313Ssos 989313Ssos // Deoptimizes a frame lazily. nmethod gets patched deopt happens on return to the frame 999313Ssos static void deoptimize(JavaThread* thread, frame fr, RegisterMap *reg_map); 10015538Sphk 1019313Ssos private: 1029313Ssos // Does the actual work for deoptimizing a single frame 1039313Ssos static void deoptimize_single_frame(JavaThread* thread, frame fr); 10412130Sdg 1059313Ssos // Helper function to revoke biases of all monitors in frame if UseBiasedLocking 1069313Ssos // is enabled 1079313Ssos static void revoke_biases_of_monitors(JavaThread* thread, frame fr, RegisterMap* map); 1089313Ssos // Helper function to revoke biases of all monitors in frames 109125454Sjhb // executing in a particular CodeBlob if UseBiasedLocking is enabled 11084783Sps static void revoke_biases_of_monitors(CodeBlob* cb); 111220373Strasz 112220373Strasz#ifdef COMPILER2 113125454Sjhb // Support for restoring non-escaping objects 1149313Ssos static bool realloc_objects(JavaThread* thread, frame* fr, GrowableArray<ScopeValue*>* objects, TRAPS); 115125454Sjhb static void reassign_type_array_elements(frame* fr, RegisterMap* reg_map, ObjectValue* sv, typeArrayOop obj, BasicType type); 116125454Sjhb static void reassign_object_array_elements(frame* fr, RegisterMap* reg_map, ObjectValue* sv, objArrayOop obj); 1179313Ssos static void reassign_fields(frame* fr, RegisterMap* reg_map, GrowableArray<ScopeValue*>* objects); 118175294Sattilio static void relock_objects(GrowableArray<MonitorInfo*>* monitors, JavaThread* thread); 119101771Sjeff NOT_PRODUCT(static void print_objects(GrowableArray<ScopeValue*>* objects);) 1209313Ssos#endif // COMPILER2 1219313Ssos 1229313Ssos public: 123173361Skib static vframeArray* create_vframeArray(JavaThread* thread, frame fr, RegisterMap *reg_map, GrowableArray<compiledVFrame*>* chunk); 124173361Skib 125173361Skib // Interface used for unpacking deoptimized frames 12624848Sdyson 1279313Ssos // UnrollBlock is returned by fetch_unroll_info() to the deoptimization handler (blob). 1289313Ssos // This is only a CheapObj to ease debugging after a deopt failure 1299313Ssos class UnrollBlock : public CHeapObj { 130166944Snetchild private: 1319313Ssos int _size_of_deoptimized_frame; // Size, in bytes, of current deoptimized frame 1329313Ssos int _caller_adjustment; // Adjustment, in bytes, to caller's SP by initial interpreted frame 13315538Sphk int _number_of_frames; // Number frames to unroll 1349313Ssos int _total_frame_sizes; // Total of number*sizes frames 13537950Sbde intptr_t* _frame_sizes; // Array of frame sizes, in bytes, for unrolling the stack 1369313Ssos address* _frame_pcs; // Array of frame pc's, in bytes, for unrolling the stack 1379313Ssos intptr_t* _register_block; // Block for storing callee-saved registers. 13814114Speter BasicType _return_type; // Tells if we have to restore double or long return value 1399313Ssos intptr_t _initial_fp; // FP of the sender frame 1409313Ssos // The following fields are used as temps during the unpacking phase 1419313Ssos // (which is tight on registers, especially on x86). They really ought 142255426Sjhb // to be PD variables but that involves moving this class into its own 143255426Sjhb // file to use the pd include mechanism. Maybe in a later cleanup ... 1449313Ssos intptr_t _counter_temp; // SHOULD BE PD VARIABLE (x86 frame count temp) 145101771Sjeff intptr_t _unpack_kind; // SHOULD BE PD VARIABLE (x86 unpack kind) 1469313Ssos intptr_t _sender_sp_temp; // SHOULD BE PD VARIABLE (x86 sender_sp) 147231885Skib public: 148231885Skib // Constructor 149231885Skib UnrollBlock(int size_of_deoptimized_frame, 150231885Skib int caller_adjustment, 151231885Skib int number_of_frames, 152231885Skib intptr_t* frame_sizes, 153231885Skib address* frames_pcs, 154231885Skib BasicType return_type); 155231885Skib ~UnrollBlock(); 1569313Ssos 1579313Ssos // Returns where a register is located. 15814114Speter intptr_t* value_addr_at(int register_number) const; 1599313Ssos 16014471Speter // Accessors 16114471Speter intptr_t* frame_sizes() const { return _frame_sizes; } 162111798Sdes int number_of_frames() const { return _number_of_frames; } 163111798Sdes address* frame_pcs() const { return _frame_pcs ; } 164111798Sdes 1659313Ssos // Returns the total size of frames 166101771Sjeff int size_of_frames() const; 1679313Ssos 1689313Ssos void set_initial_fp(intptr_t fp) { _initial_fp = fp; } 1699313Ssos 17037950Sbde // Accessors used by the code generator for the unpack stub. 1719313Ssos static int size_of_deoptimized_frame_offset_in_bytes() { return offset_of(UnrollBlock, _size_of_deoptimized_frame); } 1729313Ssos static int caller_adjustment_offset_in_bytes() { return offset_of(UnrollBlock, _caller_adjustment); } 17314114Speter static int number_of_frames_offset_in_bytes() { return offset_of(UnrollBlock, _number_of_frames); } 1749313Ssos static int frame_sizes_offset_in_bytes() { return offset_of(UnrollBlock, _frame_sizes); } 1759313Ssos static int total_frame_sizes_offset_in_bytes() { return offset_of(UnrollBlock, _total_frame_sizes); } 17614114Speter static int frame_pcs_offset_in_bytes() { return offset_of(UnrollBlock, _frame_pcs); } 17714114Speter static int register_block_offset_in_bytes() { return offset_of(UnrollBlock, _register_block); } 178111798Sdes static int return_type_offset_in_bytes() { return offset_of(UnrollBlock, _return_type); } 179111798Sdes static int counter_temp_offset_in_bytes() { return offset_of(UnrollBlock, _counter_temp); } 180111798Sdes static int initial_fp_offset_in_bytes() { return offset_of(UnrollBlock, _initial_fp); } 181144501Sjhb static int unpack_kind_offset_in_bytes() { return offset_of(UnrollBlock, _unpack_kind); } 182144501Sjhb static int sender_sp_temp_offset_in_bytes() { return offset_of(UnrollBlock, _sender_sp_temp); } 1839313Ssos 184101771Sjeff BasicType return_type() const { return _return_type; } 185111798Sdes void print(); 18614331Speter }; 18737950Sbde 188131014Sobrien //** Returns an UnrollBlock continuing information 18914331Speter // how to make room for the resulting interpreter frames. 1909313Ssos // Called by assembly stub after execution has returned to 19114114Speter // deoptimized frame. 1929313Ssos // @argument thread. Thread where stub_frame resides. 19314114Speter // @see OptoRuntime::deoptimization_fetch_unroll_info_C 19414114Speter static UnrollBlock* fetch_unroll_info(JavaThread* thread); 19514114Speter 19614114Speter //** Unpacks vframeArray onto execution stack 19714114Speter // Called by assembly stub after execution has returned to 1989313Ssos // deoptimized frame and after the stack unrolling. 199101771Sjeff // @argument thread. Thread where stub_frame resides. 200111798Sdes // @argument exec_mode. Determines how execution should be continuted in top frame. 2019313Ssos // 0 means continue after current byte code 20214114Speter // 1 means exception has happened, handle exception 2039313Ssos // 2 means reexecute current bytecode (for uncommon traps). 2049313Ssos // @see OptoRuntime::deoptimization_unpack_frames_C 2059313Ssos // Return BasicType of call return type, if any 206111798Sdes static BasicType unpack_frames(JavaThread* thread, int exec_mode); 207255426Sjhb 2089313Ssos // Cleans up deoptimization bits on thread after unpacking or in the 209101771Sjeff // case of an exception. 21014331Speter static void cleanup_deopt_info(JavaThread *thread, 21137950Sbde vframeArray * array); 21237950Sbde 21314331Speter // Restores callee saved values from deoptimized frame into oldest interpreter frame 21414331Speter // so caller of the deoptimized frame will get back the values it expects. 2159313Ssos static void unwind_callee_save_values(frame* f, vframeArray* vframe_array); 2169313Ssos 2179313Ssos //** Performs an uncommon trap for compiled code. 2189313Ssos // The top most compiler frame is converted into interpreter frames 2199313Ssos static UnrollBlock* uncommon_trap(JavaThread* thread, jint unloaded_class_index); 220119842Sbde // Helper routine that enters the VM and may block 221119842Sbde static void uncommon_trap_inner(JavaThread* thread, jint unloaded_class_index); 222119842Sbde 2239313Ssos //** Deoptimizes the frame identified by id. 2249313Ssos // Only called from VMDeoptimizeFrame 22512130Sdg // @argument thread. Thread where stub_frame resides. 22612130Sdg // @argument id. id of frame that should be deoptimized. 227111798Sdes static void deoptimize_frame_internal(JavaThread* thread, intptr_t* id); 22812130Sdg 229101771Sjeff // If thread is not the current thread then execute 230101771Sjeff // VM_DeoptimizeFrame otherwise deoptimize directly. 231175202Sattilio static void deoptimize_frame(JavaThread* thread, intptr_t* id); 232101771Sjeff 2339313Ssos // Statistics 2349313Ssos static void gather_statistics(DeoptReason reason, DeoptAction action, 2359313Ssos Bytecodes::Code bc = Bytecodes::_illegal); 2369313Ssos static void print_statistics(); 2379313Ssos 23846803Speter // How much room to adjust the last frame's SP by, to make space for 23940435Speter // the callee's interpreter frame (which expects locals to be next to 240 // incoming arguments) 241 static int last_frame_adjust(int callee_parameters, int callee_locals); 242 243 // trap_request codes 244 static DeoptReason trap_request_reason(int trap_request) { 245 if (trap_request < 0) 246 return (DeoptReason) 247 ((~(trap_request) >> _reason_shift) & right_n_bits(_reason_bits)); 248 else 249 // standard reason for unloaded CP entry 250 return Reason_unloaded; 251 } 252 static DeoptAction trap_request_action(int trap_request) { 253 if (trap_request < 0) 254 return (DeoptAction) 255 ((~(trap_request) >> _action_shift) & right_n_bits(_action_bits)); 256 else 257 // standard action for unloaded CP entry 258 return _unloaded_action; 259 } 260 static int trap_request_index(int trap_request) { 261 if (trap_request < 0) 262 return -1; 263 else 264 return trap_request; 265 } 266 static int make_trap_request(DeoptReason reason, DeoptAction action, 267 int index = -1) { 268 assert((1 << _reason_bits) >= Reason_LIMIT, "enough bits"); 269 assert((1 << _action_bits) >= Action_LIMIT, "enough bits"); 270 int trap_request; 271 if (index != -1) 272 trap_request = index; 273 else 274 trap_request = (~(((reason) << _reason_shift) 275 + ((action) << _action_shift))); 276 assert(reason == trap_request_reason(trap_request), "valid reason"); 277 assert(action == trap_request_action(trap_request), "valid action"); 278 assert(index == trap_request_index(trap_request), "valid index"); 279 return trap_request; 280 } 281 282 // The trap_state stored in a MDO is decoded here. 283 // It records two items of information. 284 // reason: If a deoptimization happened here, what its reason was, 285 // or if there were multiple deopts with differing reasons. 286 // recompiled: If a deoptimization here triggered a recompilation. 287 // Note that not all reasons are recorded per-bci. 288 static DeoptReason trap_state_reason(int trap_state); 289 static int trap_state_has_reason(int trap_state, int reason); 290 static int trap_state_add_reason(int trap_state, int reason); 291 static bool trap_state_is_recompiled(int trap_state); 292 static int trap_state_set_recompiled(int trap_state, bool z); 293 static const char* format_trap_state(char* buf, size_t buflen, 294 int trap_state); 295 296 static bool reason_is_recorded_per_bytecode(DeoptReason reason) { 297 return reason > Reason_none && reason <= Reason_RECORDED_LIMIT; 298 } 299 300 static DeoptReason reason_recorded_per_bytecode_if_any(DeoptReason reason) { 301 if (reason_is_recorded_per_bytecode(reason)) 302 return reason; 303 else if (reason == Reason_div0_check) // null check due to divide-by-zero? 304 return Reason_null_check; // recorded per BCI as a null check 305 else 306 return Reason_none; 307 } 308 309 static const char* trap_reason_name(int reason); 310 static const char* trap_action_name(int action); 311 // Format like reason='foo' action='bar' index='123'. 312 // This is suitable both for XML and for tty output. 313 static const char* format_trap_request(char* buf, size_t buflen, 314 int trap_request); 315 316 static jint total_deoptimization_count(); 317 static jint deoptimization_count(DeoptReason reason); 318 319 // JVMTI PopFrame support 320 321 // Preserves incoming arguments to the popped frame when it is 322 // returning to a deoptimized caller 323 static void popframe_preserve_args(JavaThread* thread, int bytes_to_save, void* start_address); 324 325 private: 326 static methodDataOop get_method_data(JavaThread* thread, methodHandle m, bool create_if_missing); 327 // Update the mdo's count and per-BCI reason bits, returning previous state: 328 static ProfileData* query_update_method_data(methodDataHandle trap_mdo, 329 int trap_bci, 330 DeoptReason reason, 331 //outputs: 332 uint& ret_this_trap_count, 333 bool& ret_maybe_prior_trap, 334 bool& ret_maybe_prior_recompile); 335 // class loading support for uncommon trap 336 static void load_class_by_index(constantPoolHandle constant_pool, int index, TRAPS); 337 static void load_class_by_index(constantPoolHandle constant_pool, int index); 338 339 static UnrollBlock* fetch_unroll_info_helper(JavaThread* thread); 340 341 static DeoptAction _unloaded_action; // == Action_reinterpret; 342 static const char* _trap_reason_name[Reason_LIMIT]; 343 static const char* _trap_action_name[Action_LIMIT]; 344 345 static juint _deoptimization_hist[Reason_LIMIT][1+Action_LIMIT][BC_CASE_LIMIT]; 346 // Note: Histogram array size is 1-2 Kb. 347 348 public: 349 static void update_method_data_from_interpreter(methodDataHandle trap_mdo, int trap_bci, int reason); 350}; 351 352class DeoptimizationMarker : StackObj { // for profiling 353 static bool _is_active; 354public: 355 DeoptimizationMarker() { _is_active = true; } 356 ~DeoptimizationMarker() { _is_active = false; } 357 static bool is_active() { return _is_active; } 358}; 359 360#endif // SHARE_VM_RUNTIME_DEOPTIMIZATION_HPP 361