1 /*
   2  * Copyright (c) 1997, 2018, 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 #include "precompiled.hpp"
  26 #include "jvm.h"
  27 #include "classfile/systemDictionary.hpp"
  28 #include "code/codeCache.hpp"
  29 #include "code/debugInfoRec.hpp"
  30 #include "code/nmethod.hpp"
  31 #include "code/pcDesc.hpp"
  32 #include "code/scopeDesc.hpp"
  33 #include "interpreter/bytecode.hpp"
  34 #include "interpreter/interpreter.hpp"
  35 #include "interpreter/oopMapCache.hpp"
  36 #include "memory/allocation.inline.hpp"
  37 #include "memory/oopFactory.hpp"
  38 #include "memory/resourceArea.hpp"
  39 #include "oops/method.hpp"
  40 #include "oops/objArrayOop.inline.hpp"
  41 #include "oops/oop.inline.hpp"
  42 #include "oops/fieldStreams.hpp"
  43 #include "oops/typeArrayOop.inline.hpp"
  44 #include "oops/valueArrayKlass.hpp"
  45 #include "oops/valueArrayOop.hpp"
  46 #include "oops/valueKlass.hpp"
  47 #include "oops/verifyOopClosure.hpp"
  48 #include "prims/jvmtiThreadState.hpp"
  49 #include "runtime/biasedLocking.hpp"
  50 #include "runtime/compilationPolicy.hpp"
  51 #include "runtime/deoptimization.hpp"
  52 #include "runtime/frame.inline.hpp"
  53 #include "runtime/interfaceSupport.inline.hpp"
  54 #include "runtime/safepointVerifiers.hpp"
  55 #include "runtime/sharedRuntime.hpp"
  56 #include "runtime/signature.hpp"
  57 #include "runtime/stubRoutines.hpp"
  58 #include "runtime/thread.hpp"
  59 #include "runtime/threadSMR.hpp"
  60 #include "runtime/vframe.hpp"
  61 #include "runtime/vframeArray.hpp"
  62 #include "runtime/vframe_hp.hpp"
  63 #include "utilities/events.hpp"
  64 #include "utilities/preserveException.hpp"
  65 #include "utilities/xmlstream.hpp"
  66 
  67 #if INCLUDE_JVMCI
  68 #include "jvmci/jvmciRuntime.hpp"
  69 #include "jvmci/jvmciJavaClasses.hpp"
  70 #endif
  71 
  72 
  73 bool DeoptimizationMarker::_is_active = false;
  74 
  75 Deoptimization::UnrollBlock::UnrollBlock(int  size_of_deoptimized_frame,
  76                                          int  caller_adjustment,
  77                                          int  caller_actual_parameters,
  78                                          int  number_of_frames,
  79                                          intptr_t* frame_sizes,
  80                                          address* frame_pcs,
  81                                          BasicType return_type,
  82                                          int exec_mode) {
  83   _size_of_deoptimized_frame = size_of_deoptimized_frame;
  84   _caller_adjustment         = caller_adjustment;
  85   _caller_actual_parameters  = caller_actual_parameters;
  86   _number_of_frames          = number_of_frames;
  87   _frame_sizes               = frame_sizes;
  88   _frame_pcs                 = frame_pcs;
  89   _register_block            = NEW_C_HEAP_ARRAY(intptr_t, RegisterMap::reg_count * 2, mtCompiler);
  90   _return_type               = return_type;
  91   _initial_info              = 0;
  92   // PD (x86 only)
  93   _counter_temp              = 0;
  94   _unpack_kind               = exec_mode;
  95   _sender_sp_temp            = 0;
  96 
  97   _total_frame_sizes         = size_of_frames();
  98   assert(exec_mode >= 0 && exec_mode < Unpack_LIMIT, "Unexpected exec_mode");
  99 }
 100 
 101 
 102 Deoptimization::UnrollBlock::~UnrollBlock() {
 103   FREE_C_HEAP_ARRAY(intptr_t, _frame_sizes);
 104   FREE_C_HEAP_ARRAY(intptr_t, _frame_pcs);
 105   FREE_C_HEAP_ARRAY(intptr_t, _register_block);
 106 }
 107 
 108 
 109 intptr_t* Deoptimization::UnrollBlock::value_addr_at(int register_number) const {
 110   assert(register_number < RegisterMap::reg_count, "checking register number");
 111   return &_register_block[register_number * 2];
 112 }
 113 
 114 
 115 
 116 int Deoptimization::UnrollBlock::size_of_frames() const {
 117   // Acount first for the adjustment of the initial frame
 118   int result = _caller_adjustment;
 119   for (int index = 0; index < number_of_frames(); index++) {
 120     result += frame_sizes()[index];
 121   }
 122   return result;
 123 }
 124 
 125 
 126 void Deoptimization::UnrollBlock::print() {
 127   ttyLocker ttyl;
 128   tty->print_cr("UnrollBlock");
 129   tty->print_cr("  size_of_deoptimized_frame = %d", _size_of_deoptimized_frame);
 130   tty->print(   "  frame_sizes: ");
 131   for (int index = 0; index < number_of_frames(); index++) {
 132     tty->print(INTX_FORMAT " ", frame_sizes()[index]);
 133   }
 134   tty->cr();
 135 }
 136 
 137 
 138 // In order to make fetch_unroll_info work properly with escape
 139 // analysis, The method was changed from JRT_LEAF to JRT_BLOCK_ENTRY and
 140 // ResetNoHandleMark and HandleMark were removed from it. The actual reallocation
 141 // of previously eliminated objects occurs in realloc_objects, which is
 142 // called from the method fetch_unroll_info_helper below.
 143 JRT_BLOCK_ENTRY(Deoptimization::UnrollBlock*, Deoptimization::fetch_unroll_info(JavaThread* thread, int exec_mode))
 144   // It is actually ok to allocate handles in a leaf method. It causes no safepoints,
 145   // but makes the entry a little slower. There is however a little dance we have to
 146   // do in debug mode to get around the NoHandleMark code in the JRT_LEAF macro
 147 
 148   // fetch_unroll_info() is called at the beginning of the deoptimization
 149   // handler. Note this fact before we start generating temporary frames
 150   // that can confuse an asynchronous stack walker. This counter is
 151   // decremented at the end of unpack_frames().
 152   if (TraceDeoptimization) {
 153     tty->print_cr("Deoptimizing thread " INTPTR_FORMAT, p2i(thread));
 154   }
 155   thread->inc_in_deopt_handler();
 156 
 157   return fetch_unroll_info_helper(thread, exec_mode);
 158 JRT_END
 159 
 160 
 161 // This is factored, since it is both called from a JRT_LEAF (deoptimization) and a JRT_ENTRY (uncommon_trap)
 162 Deoptimization::UnrollBlock* Deoptimization::fetch_unroll_info_helper(JavaThread* thread, int exec_mode) {
 163 
 164   // Note: there is a safepoint safety issue here. No matter whether we enter
 165   // via vanilla deopt or uncommon trap we MUST NOT stop at a safepoint once
 166   // the vframeArray is created.
 167   //
 168 
 169   // Allocate our special deoptimization ResourceMark
 170   DeoptResourceMark* dmark = new DeoptResourceMark(thread);
 171   assert(thread->deopt_mark() == NULL, "Pending deopt!");
 172   thread->set_deopt_mark(dmark);
 173 
 174   frame stub_frame = thread->last_frame(); // Makes stack walkable as side effect
 175   RegisterMap map(thread, true);
 176   RegisterMap dummy_map(thread, false);
 177   // Now get the deoptee with a valid map
 178   frame deoptee = stub_frame.sender(&map);
 179   // Set the deoptee nmethod
 180   assert(thread->deopt_compiled_method() == NULL, "Pending deopt!");
 181   CompiledMethod* cm = deoptee.cb()->as_compiled_method_or_null();
 182   thread->set_deopt_compiled_method(cm);
 183 
 184   if (VerifyStack) {
 185     thread->validate_frame_layout();
 186   }
 187 
 188   // Create a growable array of VFrames where each VFrame represents an inlined
 189   // Java frame.  This storage is allocated with the usual system arena.
 190   assert(deoptee.is_compiled_frame(), "Wrong frame type");
 191   GrowableArray<compiledVFrame*>* chunk = new GrowableArray<compiledVFrame*>(10);
 192   vframe* vf = vframe::new_vframe(&deoptee, &map, thread);
 193   while (!vf->is_top()) {
 194     assert(vf->is_compiled_frame(), "Wrong frame type");
 195     chunk->push(compiledVFrame::cast(vf));
 196     vf = vf->sender();
 197   }
 198   assert(vf->is_compiled_frame(), "Wrong frame type");
 199   chunk->push(compiledVFrame::cast(vf));
 200 
 201   bool realloc_failures = false;
 202 
 203 #if COMPILER2_OR_JVMCI
 204   // Reallocate the non-escaping objects and restore their fields. Then
 205   // relock objects if synchronization on them was eliminated.
 206 #if !INCLUDE_JVMCI
 207   if (DoEscapeAnalysis || EliminateNestedLocks) {
 208     if (EliminateAllocations) {
 209 #endif // INCLUDE_JVMCI
 210       assert (chunk->at(0)->scope() != NULL,"expect only compiled java frames");
 211       GrowableArray<ScopeValue*>* objects = chunk->at(0)->scope()->objects();
 212 
 213       // The flag return_oop() indicates call sites which return oop
 214       // in compiled code. Such sites include java method calls,
 215       // runtime calls (for example, used to allocate new objects/arrays
 216       // on slow code path) and any other calls generated in compiled code.
 217       // It is not guaranteed that we can get such information here only
 218       // by analyzing bytecode in deoptimized frames. This is why this flag
 219       // is set during method compilation (see Compile::Process_OopMap_Node()).
 220       // If the previous frame was popped or if we are dispatching an exception,
 221       // we don't have an oop result.
 222       ScopeDesc* scope = chunk->at(0)->scope();
 223       bool save_oop_result = scope->return_oop() && !thread->popframe_forcing_deopt_reexecution() && (exec_mode == Unpack_deopt);
 224       // In case of the return of multiple values, we must take care
 225       // of all oop return values.
 226       GrowableArray<Handle> return_oops;
 227       ValueKlass* vk = NULL;
 228       if (save_oop_result && scope->return_vt()) {
 229         vk = ValueKlass::returned_value_klass(map);
 230         if (vk != NULL) {
 231           vk->save_oop_fields(map, return_oops);
 232           save_oop_result = false;
 233         }
 234       }
 235       if (save_oop_result) {
 236         // Reallocation may trigger GC. If deoptimization happened on return from
 237         // call which returns oop we need to save it since it is not in oopmap.
 238         oop result = deoptee.saved_oop_result(&map);
 239         assert(oopDesc::is_oop_or_null(result), "must be oop");
 240         return_oops.push(Handle(thread, result));
 241         assert(Universe::heap()->is_in_or_null(result), "must be heap pointer");
 242         if (TraceDeoptimization) {
 243           ttyLocker ttyl;
 244           tty->print_cr("SAVED OOP RESULT " INTPTR_FORMAT " in thread " INTPTR_FORMAT, p2i(result), p2i(thread));
 245         }
 246       }
 247       if (objects != NULL || vk != NULL) {
 248         bool skip_internal = (cm != NULL) && !cm->is_compiled_by_jvmci();
 249         JRT_BLOCK
 250           if (vk != NULL) {
 251             realloc_failures = realloc_value_type_result(vk, map, return_oops, THREAD);
 252           }
 253           if (objects != NULL) {
 254             realloc_failures = realloc_failures || realloc_objects(thread, &deoptee, objects, THREAD);
 255             reassign_fields(&deoptee, &map, objects, realloc_failures, skip_internal, THREAD);
 256           }
 257         JRT_END
 258 #ifndef PRODUCT
 259         if (TraceDeoptimization) {
 260           ttyLocker ttyl;
 261           tty->print_cr("REALLOC OBJECTS in thread " INTPTR_FORMAT, p2i(thread));
 262           print_objects(objects, realloc_failures);
 263         }
 264 #endif
 265       }
 266       if (save_oop_result || vk != NULL) {
 267         // Restore result.
 268         assert(return_oops.length() == 1, "no value type");
 269         deoptee.set_saved_oop_result(&map, return_oops.pop()());
 270       }
 271 #if !INCLUDE_JVMCI
 272     }
 273     if (EliminateLocks) {
 274 #endif // INCLUDE_JVMCI
 275 #ifndef PRODUCT
 276       bool first = true;
 277 #endif
 278       for (int i = 0; i < chunk->length(); i++) {
 279         compiledVFrame* cvf = chunk->at(i);
 280         assert (cvf->scope() != NULL,"expect only compiled java frames");
 281         GrowableArray<MonitorInfo*>* monitors = cvf->monitors();
 282         if (monitors->is_nonempty()) {
 283           relock_objects(monitors, thread, realloc_failures);
 284 #ifndef PRODUCT
 285           if (PrintDeoptimizationDetails) {
 286             ttyLocker ttyl;
 287             for (int j = 0; j < monitors->length(); j++) {
 288               MonitorInfo* mi = monitors->at(j);
 289               if (mi->eliminated()) {
 290                 if (first) {
 291                   first = false;
 292                   tty->print_cr("RELOCK OBJECTS in thread " INTPTR_FORMAT, p2i(thread));
 293                 }
 294                 if (mi->owner_is_scalar_replaced()) {
 295                   Klass* k = java_lang_Class::as_Klass(mi->owner_klass());
 296                   tty->print_cr("     failed reallocation for klass %s", k->external_name());
 297                 } else {
 298                   tty->print_cr("     object <" INTPTR_FORMAT "> locked", p2i(mi->owner()));
 299                 }
 300               }
 301             }
 302           }
 303 #endif // !PRODUCT
 304         }
 305       }
 306 #if !INCLUDE_JVMCI
 307     }
 308   }
 309 #endif // INCLUDE_JVMCI
 310 #endif // COMPILER2_OR_JVMCI
 311 
 312   ScopeDesc* trap_scope = chunk->at(0)->scope();
 313   Handle exceptionObject;
 314   if (trap_scope->rethrow_exception()) {
 315     if (PrintDeoptimizationDetails) {
 316       tty->print_cr("Exception to be rethrown in the interpreter for method %s::%s at bci %d", trap_scope->method()->method_holder()->name()->as_C_string(), trap_scope->method()->name()->as_C_string(), trap_scope->bci());
 317     }
 318     GrowableArray<ScopeValue*>* expressions = trap_scope->expressions();
 319     guarantee(expressions != NULL && expressions->length() > 0, "must have exception to throw");
 320     ScopeValue* topOfStack = expressions->top();
 321     exceptionObject = StackValue::create_stack_value(&deoptee, &map, topOfStack)->get_obj();
 322     guarantee(exceptionObject() != NULL, "exception oop can not be null");
 323   }
 324 
 325   // Ensure that no safepoint is taken after pointers have been stored
 326   // in fields of rematerialized objects.  If a safepoint occurs from here on
 327   // out the java state residing in the vframeArray will be missed.
 328   NoSafepointVerifier no_safepoint;
 329 
 330   vframeArray* array = create_vframeArray(thread, deoptee, &map, chunk, realloc_failures);
 331 #if COMPILER2_OR_JVMCI
 332   if (realloc_failures) {
 333     pop_frames_failed_reallocs(thread, array);
 334   }
 335 #endif
 336 
 337   assert(thread->vframe_array_head() == NULL, "Pending deopt!");
 338   thread->set_vframe_array_head(array);
 339 
 340   // Now that the vframeArray has been created if we have any deferred local writes
 341   // added by jvmti then we can free up that structure as the data is now in the
 342   // vframeArray
 343 
 344   if (thread->deferred_locals() != NULL) {
 345     GrowableArray<jvmtiDeferredLocalVariableSet*>* list = thread->deferred_locals();
 346     int i = 0;
 347     do {
 348       // Because of inlining we could have multiple vframes for a single frame
 349       // and several of the vframes could have deferred writes. Find them all.
 350       if (list->at(i)->id() == array->original().id()) {
 351         jvmtiDeferredLocalVariableSet* dlv = list->at(i);
 352         list->remove_at(i);
 353         // individual jvmtiDeferredLocalVariableSet are CHeapObj's
 354         delete dlv;
 355       } else {
 356         i++;
 357       }
 358     } while ( i < list->length() );
 359     if (list->length() == 0) {
 360       thread->set_deferred_locals(NULL);
 361       // free the list and elements back to C heap.
 362       delete list;
 363     }
 364 
 365   }
 366 
 367   // Compute the caller frame based on the sender sp of stub_frame and stored frame sizes info.
 368   CodeBlob* cb = stub_frame.cb();
 369   // Verify we have the right vframeArray
 370   assert(cb->frame_size() >= 0, "Unexpected frame size");
 371   intptr_t* unpack_sp = stub_frame.sp() + cb->frame_size();
 372 
 373   // If the deopt call site is a MethodHandle invoke call site we have
 374   // to adjust the unpack_sp.
 375   nmethod* deoptee_nm = deoptee.cb()->as_nmethod_or_null();
 376   if (deoptee_nm != NULL && deoptee_nm->is_method_handle_return(deoptee.pc()))
 377     unpack_sp = deoptee.unextended_sp();
 378 
 379 #ifdef ASSERT
 380   assert(cb->is_deoptimization_stub() ||
 381          cb->is_uncommon_trap_stub() ||
 382          strcmp("Stub<DeoptimizationStub.deoptimizationHandler>", cb->name()) == 0 ||
 383          strcmp("Stub<UncommonTrapStub.uncommonTrapHandler>", cb->name()) == 0,
 384          "unexpected code blob: %s", cb->name());
 385 #endif
 386 
 387   // This is a guarantee instead of an assert because if vframe doesn't match
 388   // we will unpack the wrong deoptimized frame and wind up in strange places
 389   // where it will be very difficult to figure out what went wrong. Better
 390   // to die an early death here than some very obscure death later when the
 391   // trail is cold.
 392   // Note: on ia64 this guarantee can be fooled by frames with no memory stack
 393   // in that it will fail to detect a problem when there is one. This needs
 394   // more work in tiger timeframe.
 395   guarantee(array->unextended_sp() == unpack_sp, "vframe_array_head must contain the vframeArray to unpack");
 396 
 397   int number_of_frames = array->frames();
 398 
 399   // Compute the vframes' sizes.  Note that frame_sizes[] entries are ordered from outermost to innermost
 400   // virtual activation, which is the reverse of the elements in the vframes array.
 401   intptr_t* frame_sizes = NEW_C_HEAP_ARRAY(intptr_t, number_of_frames, mtCompiler);
 402   // +1 because we always have an interpreter return address for the final slot.
 403   address* frame_pcs = NEW_C_HEAP_ARRAY(address, number_of_frames + 1, mtCompiler);
 404   int popframe_extra_args = 0;
 405   // Create an interpreter return address for the stub to use as its return
 406   // address so the skeletal frames are perfectly walkable
 407   frame_pcs[number_of_frames] = Interpreter::deopt_entry(vtos, 0);
 408 
 409   // PopFrame requires that the preserved incoming arguments from the recently-popped topmost
 410   // activation be put back on the expression stack of the caller for reexecution
 411   if (JvmtiExport::can_pop_frame() && thread->popframe_forcing_deopt_reexecution()) {
 412     popframe_extra_args = in_words(thread->popframe_preserved_args_size_in_words());
 413   }
 414 
 415   // Find the current pc for sender of the deoptee. Since the sender may have been deoptimized
 416   // itself since the deoptee vframeArray was created we must get a fresh value of the pc rather
 417   // than simply use array->sender.pc(). This requires us to walk the current set of frames
 418   //
 419   frame deopt_sender = stub_frame.sender(&dummy_map); // First is the deoptee frame
 420   deopt_sender = deopt_sender.sender(&dummy_map);     // Now deoptee caller
 421 
 422   // It's possible that the number of parameters at the call site is
 423   // different than number of arguments in the callee when method
 424   // handles are used.  If the caller is interpreted get the real
 425   // value so that the proper amount of space can be added to it's
 426   // frame.
 427   bool caller_was_method_handle = false;
 428   if (deopt_sender.is_interpreted_frame()) {
 429     methodHandle method = deopt_sender.interpreter_frame_method();
 430     Bytecode_invoke cur = Bytecode_invoke_check(method, deopt_sender.interpreter_frame_bci());
 431     if (cur.is_invokedynamic() || cur.is_invokehandle()) {
 432       // Method handle invokes may involve fairly arbitrary chains of
 433       // calls so it's impossible to know how much actual space the
 434       // caller has for locals.
 435       caller_was_method_handle = true;
 436     }
 437   }
 438 
 439   //
 440   // frame_sizes/frame_pcs[0] oldest frame (int or c2i)
 441   // frame_sizes/frame_pcs[1] next oldest frame (int)
 442   // frame_sizes/frame_pcs[n] youngest frame (int)
 443   //
 444   // Now a pc in frame_pcs is actually the return address to the frame's caller (a frame
 445   // owns the space for the return address to it's caller).  Confusing ain't it.
 446   //
 447   // The vframe array can address vframes with indices running from
 448   // 0.._frames-1. Index  0 is the youngest frame and _frame - 1 is the oldest (root) frame.
 449   // When we create the skeletal frames we need the oldest frame to be in the zero slot
 450   // in the frame_sizes/frame_pcs so the assembly code can do a trivial walk.
 451   // so things look a little strange in this loop.
 452   //
 453   int callee_parameters = 0;
 454   int callee_locals = 0;
 455   for (int index = 0; index < array->frames(); index++ ) {
 456     // frame[number_of_frames - 1 ] = on_stack_size(youngest)
 457     // frame[number_of_frames - 2 ] = on_stack_size(sender(youngest))
 458     // frame[number_of_frames - 3 ] = on_stack_size(sender(sender(youngest)))
 459     frame_sizes[number_of_frames - 1 - index] = BytesPerWord * array->element(index)->on_stack_size(callee_parameters,
 460                                                                                                     callee_locals,
 461                                                                                                     index == 0,
 462                                                                                                     popframe_extra_args);
 463     // This pc doesn't have to be perfect just good enough to identify the frame
 464     // as interpreted so the skeleton frame will be walkable
 465     // The correct pc will be set when the skeleton frame is completely filled out
 466     // The final pc we store in the loop is wrong and will be overwritten below
 467     frame_pcs[number_of_frames - 1 - index ] = Interpreter::deopt_entry(vtos, 0) - frame::pc_return_offset;
 468 
 469     callee_parameters = array->element(index)->method()->size_of_parameters();
 470     callee_locals = array->element(index)->method()->max_locals();
 471     popframe_extra_args = 0;
 472   }
 473 
 474   // Compute whether the root vframe returns a float or double value.
 475   BasicType return_type;
 476   {
 477     methodHandle method(thread, array->element(0)->method());
 478     Bytecode_invoke invoke = Bytecode_invoke_check(method, array->element(0)->bci());
 479     return_type = invoke.is_valid() ? invoke.result_type() : T_ILLEGAL;
 480   }
 481 
 482   // Compute information for handling adapters and adjusting the frame size of the caller.
 483   int caller_adjustment = 0;
 484 
 485   // Compute the amount the oldest interpreter frame will have to adjust
 486   // its caller's stack by. If the caller is a compiled frame then
 487   // we pretend that the callee has no parameters so that the
 488   // extension counts for the full amount of locals and not just
 489   // locals-parms. This is because without a c2i adapter the parm
 490   // area as created by the compiled frame will not be usable by
 491   // the interpreter. (Depending on the calling convention there
 492   // may not even be enough space).
 493 
 494   // QQQ I'd rather see this pushed down into last_frame_adjust
 495   // and have it take the sender (aka caller).
 496 
 497   if (deopt_sender.is_compiled_frame() || caller_was_method_handle) {
 498     caller_adjustment = last_frame_adjust(0, callee_locals);
 499   } else if (callee_locals > callee_parameters) {
 500     // The caller frame may need extending to accommodate
 501     // non-parameter locals of the first unpacked interpreted frame.
 502     // Compute that adjustment.
 503     caller_adjustment = last_frame_adjust(callee_parameters, callee_locals);
 504   }
 505 
 506   // If the sender is deoptimized the we must retrieve the address of the handler
 507   // since the frame will "magically" show the original pc before the deopt
 508   // and we'd undo the deopt.
 509 
 510   frame_pcs[0] = deopt_sender.raw_pc();
 511 
 512   assert(CodeCache::find_blob_unsafe(frame_pcs[0]) != NULL, "bad pc");
 513 
 514 #if INCLUDE_JVMCI
 515   if (exceptionObject() != NULL) {
 516     thread->set_exception_oop(exceptionObject());
 517     exec_mode = Unpack_exception;
 518   }
 519 #endif
 520 
 521   if (thread->frames_to_pop_failed_realloc() > 0 && exec_mode != Unpack_uncommon_trap) {
 522     assert(thread->has_pending_exception(), "should have thrown OOME");
 523     thread->set_exception_oop(thread->pending_exception());
 524     thread->clear_pending_exception();
 525     exec_mode = Unpack_exception;
 526   }
 527 
 528 #if INCLUDE_JVMCI
 529   if (thread->frames_to_pop_failed_realloc() > 0) {
 530     thread->set_pending_monitorenter(false);
 531   }
 532 #endif
 533 
 534   UnrollBlock* info = new UnrollBlock(array->frame_size() * BytesPerWord,
 535                                       caller_adjustment * BytesPerWord,
 536                                       caller_was_method_handle ? 0 : callee_parameters,
 537                                       number_of_frames,
 538                                       frame_sizes,
 539                                       frame_pcs,
 540                                       return_type,
 541                                       exec_mode);
 542   // On some platforms, we need a way to pass some platform dependent
 543   // information to the unpacking code so the skeletal frames come out
 544   // correct (initial fp value, unextended sp, ...)
 545   info->set_initial_info((intptr_t) array->sender().initial_deoptimization_info());
 546 
 547   if (array->frames() > 1) {
 548     if (VerifyStack && TraceDeoptimization) {
 549       ttyLocker ttyl;
 550       tty->print_cr("Deoptimizing method containing inlining");
 551     }
 552   }
 553 
 554   array->set_unroll_block(info);
 555   return info;
 556 }
 557 
 558 // Called to cleanup deoptimization data structures in normal case
 559 // after unpacking to stack and when stack overflow error occurs
 560 void Deoptimization::cleanup_deopt_info(JavaThread *thread,
 561                                         vframeArray *array) {
 562 
 563   // Get array if coming from exception
 564   if (array == NULL) {
 565     array = thread->vframe_array_head();
 566   }
 567   thread->set_vframe_array_head(NULL);
 568 
 569   // Free the previous UnrollBlock
 570   vframeArray* old_array = thread->vframe_array_last();
 571   thread->set_vframe_array_last(array);
 572 
 573   if (old_array != NULL) {
 574     UnrollBlock* old_info = old_array->unroll_block();
 575     old_array->set_unroll_block(NULL);
 576     delete old_info;
 577     delete old_array;
 578   }
 579 
 580   // Deallocate any resource creating in this routine and any ResourceObjs allocated
 581   // inside the vframeArray (StackValueCollections)
 582 
 583   delete thread->deopt_mark();
 584   thread->set_deopt_mark(NULL);
 585   thread->set_deopt_compiled_method(NULL);
 586 
 587 
 588   if (JvmtiExport::can_pop_frame()) {
 589 #ifndef CC_INTERP
 590     // Regardless of whether we entered this routine with the pending
 591     // popframe condition bit set, we should always clear it now
 592     thread->clear_popframe_condition();
 593 #else
 594     // C++ interpreter will clear has_pending_popframe when it enters
 595     // with method_resume. For deopt_resume2 we clear it now.
 596     if (thread->popframe_forcing_deopt_reexecution())
 597         thread->clear_popframe_condition();
 598 #endif /* CC_INTERP */
 599   }
 600 
 601   // unpack_frames() is called at the end of the deoptimization handler
 602   // and (in C2) at the end of the uncommon trap handler. Note this fact
 603   // so that an asynchronous stack walker can work again. This counter is
 604   // incremented at the beginning of fetch_unroll_info() and (in C2) at
 605   // the beginning of uncommon_trap().
 606   thread->dec_in_deopt_handler();
 607 }
 608 
 609 // Moved from cpu directories because none of the cpus has callee save values.
 610 // If a cpu implements callee save values, move this to deoptimization_<cpu>.cpp.
 611 void Deoptimization::unwind_callee_save_values(frame* f, vframeArray* vframe_array) {
 612 
 613   // This code is sort of the equivalent of C2IAdapter::setup_stack_frame back in
 614   // the days we had adapter frames. When we deoptimize a situation where a
 615   // compiled caller calls a compiled caller will have registers it expects
 616   // to survive the call to the callee. If we deoptimize the callee the only
 617   // way we can restore these registers is to have the oldest interpreter
 618   // frame that we create restore these values. That is what this routine
 619   // will accomplish.
 620 
 621   // At the moment we have modified c2 to not have any callee save registers
 622   // so this problem does not exist and this routine is just a place holder.
 623 
 624   assert(f->is_interpreted_frame(), "must be interpreted");
 625 }
 626 
 627 // Return BasicType of value being returned
 628 JRT_LEAF(BasicType, Deoptimization::unpack_frames(JavaThread* thread, int exec_mode))
 629 
 630   // We are already active in the special DeoptResourceMark any ResourceObj's we
 631   // allocate will be freed at the end of the routine.
 632 
 633   // It is actually ok to allocate handles in a leaf method. It causes no safepoints,
 634   // but makes the entry a little slower. There is however a little dance we have to
 635   // do in debug mode to get around the NoHandleMark code in the JRT_LEAF macro
 636   ResetNoHandleMark rnhm; // No-op in release/product versions
 637   HandleMark hm;
 638 
 639   frame stub_frame = thread->last_frame();
 640 
 641   // Since the frame to unpack is the top frame of this thread, the vframe_array_head
 642   // must point to the vframeArray for the unpack frame.
 643   vframeArray* array = thread->vframe_array_head();
 644 
 645 #ifndef PRODUCT
 646   if (TraceDeoptimization) {
 647     ttyLocker ttyl;
 648     tty->print_cr("DEOPT UNPACKING thread " INTPTR_FORMAT " vframeArray " INTPTR_FORMAT " mode %d",
 649                   p2i(thread), p2i(array), exec_mode);
 650   }
 651 #endif
 652   Events::log(thread, "DEOPT UNPACKING pc=" INTPTR_FORMAT " sp=" INTPTR_FORMAT " mode %d",
 653               p2i(stub_frame.pc()), p2i(stub_frame.sp()), exec_mode);
 654 
 655   UnrollBlock* info = array->unroll_block();
 656 
 657   // Unpack the interpreter frames and any adapter frame (c2 only) we might create.
 658   array->unpack_to_stack(stub_frame, exec_mode, info->caller_actual_parameters());
 659 
 660   BasicType bt = info->return_type();
 661 
 662   // If we have an exception pending, claim that the return type is an oop
 663   // so the deopt_blob does not overwrite the exception_oop.
 664 
 665   if (exec_mode == Unpack_exception)
 666     bt = T_OBJECT;
 667 
 668   // Cleanup thread deopt data
 669   cleanup_deopt_info(thread, array);
 670 
 671 #ifndef PRODUCT
 672   if (VerifyStack) {
 673     ResourceMark res_mark;
 674     // Clear pending exception to not break verification code (restored afterwards)
 675     PRESERVE_EXCEPTION_MARK;
 676 
 677     thread->validate_frame_layout();
 678 
 679     // Verify that the just-unpacked frames match the interpreter's
 680     // notions of expression stack and locals
 681     vframeArray* cur_array = thread->vframe_array_last();
 682     RegisterMap rm(thread, false);
 683     rm.set_include_argument_oops(false);
 684     bool is_top_frame = true;
 685     int callee_size_of_parameters = 0;
 686     int callee_max_locals = 0;
 687     for (int i = 0; i < cur_array->frames(); i++) {
 688       vframeArrayElement* el = cur_array->element(i);
 689       frame* iframe = el->iframe();
 690       guarantee(iframe->is_interpreted_frame(), "Wrong frame type");
 691 
 692       // Get the oop map for this bci
 693       InterpreterOopMap mask;
 694       int cur_invoke_parameter_size = 0;
 695       bool try_next_mask = false;
 696       int next_mask_expression_stack_size = -1;
 697       int top_frame_expression_stack_adjustment = 0;
 698       methodHandle mh(thread, iframe->interpreter_frame_method());
 699       OopMapCache::compute_one_oop_map(mh, iframe->interpreter_frame_bci(), &mask);
 700       BytecodeStream str(mh);
 701       str.set_start(iframe->interpreter_frame_bci());
 702       int max_bci = mh->code_size();
 703       // Get to the next bytecode if possible
 704       assert(str.bci() < max_bci, "bci in interpreter frame out of bounds");
 705       // Check to see if we can grab the number of outgoing arguments
 706       // at an uncommon trap for an invoke (where the compiler
 707       // generates debug info before the invoke has executed)
 708       Bytecodes::Code cur_code = str.next();
 709       if (Bytecodes::is_invoke(cur_code)) {
 710         Bytecode_invoke invoke(mh, iframe->interpreter_frame_bci());
 711         cur_invoke_parameter_size = invoke.size_of_parameters();
 712         if (i != 0 && !invoke.is_invokedynamic() && MethodHandles::has_member_arg(invoke.klass(), invoke.name())) {
 713           callee_size_of_parameters++;
 714         }
 715       }
 716       if (str.bci() < max_bci) {
 717         Bytecodes::Code next_code = str.next();
 718         if (next_code >= 0) {
 719           // The interpreter oop map generator reports results before
 720           // the current bytecode has executed except in the case of
 721           // calls. It seems to be hard to tell whether the compiler
 722           // has emitted debug information matching the "state before"
 723           // a given bytecode or the state after, so we try both
 724           if (!Bytecodes::is_invoke(cur_code) && cur_code != Bytecodes::_athrow) {
 725             // Get expression stack size for the next bytecode
 726             InterpreterOopMap next_mask;
 727             OopMapCache::compute_one_oop_map(mh, str.bci(), &next_mask);
 728             next_mask_expression_stack_size = next_mask.expression_stack_size();
 729             if (Bytecodes::is_invoke(next_code)) {
 730               Bytecode_invoke invoke(mh, str.bci());
 731               next_mask_expression_stack_size += invoke.size_of_parameters();
 732             }
 733             // Need to subtract off the size of the result type of
 734             // the bytecode because this is not described in the
 735             // debug info but returned to the interpreter in the TOS
 736             // caching register
 737             BasicType bytecode_result_type = Bytecodes::result_type(cur_code);
 738             if (bytecode_result_type != T_ILLEGAL) {
 739               top_frame_expression_stack_adjustment = type2size[bytecode_result_type];
 740             }
 741             assert(top_frame_expression_stack_adjustment >= 0, "stack adjustment must be positive");
 742             try_next_mask = true;
 743           }
 744         }
 745       }
 746 
 747       // Verify stack depth and oops in frame
 748       // This assertion may be dependent on the platform we're running on and may need modification (tested on x86 and sparc)
 749       if (!(
 750             /* SPARC */
 751             (iframe->interpreter_frame_expression_stack_size() == mask.expression_stack_size() + callee_size_of_parameters) ||
 752             /* x86 */
 753             (iframe->interpreter_frame_expression_stack_size() == mask.expression_stack_size() + callee_max_locals) ||
 754             (try_next_mask &&
 755              (iframe->interpreter_frame_expression_stack_size() == (next_mask_expression_stack_size -
 756                                                                     top_frame_expression_stack_adjustment))) ||
 757             (is_top_frame && (exec_mode == Unpack_exception) && iframe->interpreter_frame_expression_stack_size() == 0) ||
 758             (is_top_frame && (exec_mode == Unpack_uncommon_trap || exec_mode == Unpack_reexecute || el->should_reexecute()) &&
 759              (iframe->interpreter_frame_expression_stack_size() == mask.expression_stack_size() + cur_invoke_parameter_size))
 760             )) {
 761         {
 762           ttyLocker ttyl;
 763 
 764           // Print out some information that will help us debug the problem
 765           tty->print_cr("Wrong number of expression stack elements during deoptimization");
 766           tty->print_cr("  Error occurred while verifying frame %d (0..%d, 0 is topmost)", i, cur_array->frames() - 1);
 767           tty->print_cr("  Fabricated interpreter frame had %d expression stack elements",
 768                         iframe->interpreter_frame_expression_stack_size());
 769           tty->print_cr("  Interpreter oop map had %d expression stack elements", mask.expression_stack_size());
 770           tty->print_cr("  try_next_mask = %d", try_next_mask);
 771           tty->print_cr("  next_mask_expression_stack_size = %d", next_mask_expression_stack_size);
 772           tty->print_cr("  callee_size_of_parameters = %d", callee_size_of_parameters);
 773           tty->print_cr("  callee_max_locals = %d", callee_max_locals);
 774           tty->print_cr("  top_frame_expression_stack_adjustment = %d", top_frame_expression_stack_adjustment);
 775           tty->print_cr("  exec_mode = %d", exec_mode);
 776           tty->print_cr("  cur_invoke_parameter_size = %d", cur_invoke_parameter_size);
 777           tty->print_cr("  Thread = " INTPTR_FORMAT ", thread ID = %d", p2i(thread), thread->osthread()->thread_id());
 778           tty->print_cr("  Interpreted frames:");
 779           for (int k = 0; k < cur_array->frames(); k++) {
 780             vframeArrayElement* el = cur_array->element(k);
 781             tty->print_cr("    %s (bci %d)", el->method()->name_and_sig_as_C_string(), el->bci());
 782           }
 783           cur_array->print_on_2(tty);
 784         } // release tty lock before calling guarantee
 785         guarantee(false, "wrong number of expression stack elements during deopt");
 786       }
 787       VerifyOopClosure verify;
 788       iframe->oops_interpreted_do(&verify, &rm, false);
 789       callee_size_of_parameters = mh->size_of_parameters();
 790       callee_max_locals = mh->max_locals();
 791       is_top_frame = false;
 792     }
 793   }
 794 #endif /* !PRODUCT */
 795 
 796 
 797   return bt;
 798 JRT_END
 799 
 800 
 801 int Deoptimization::deoptimize_dependents() {
 802   Threads::deoptimized_wrt_marked_nmethods();
 803   return 0;
 804 }
 805 
 806 Deoptimization::DeoptAction Deoptimization::_unloaded_action
 807   = Deoptimization::Action_reinterpret;
 808 
 809 #if COMPILER2_OR_JVMCI
 810 bool Deoptimization::realloc_objects(JavaThread* thread, frame* fr, GrowableArray<ScopeValue*>* objects, TRAPS) {
 811   Handle pending_exception(THREAD, thread->pending_exception());
 812   const char* exception_file = thread->exception_file();
 813   int exception_line = thread->exception_line();
 814   thread->clear_pending_exception();
 815 
 816   bool failures = false;
 817 
 818   for (int i = 0; i < objects->length(); i++) {
 819     assert(objects->at(i)->is_object(), "invalid debug information");
 820     ObjectValue* sv = (ObjectValue*) objects->at(i);
 821 
 822     Klass* k = java_lang_Class::as_Klass(sv->klass()->as_ConstantOopReadValue()->value()());
 823     oop obj = NULL;
 824 
 825     if (k->is_instance_klass()) {
 826       InstanceKlass* ik = InstanceKlass::cast(k);
 827       obj = ik->allocate_instance(THREAD);
 828     } else if (k->is_valueArray_klass()) {
 829       ValueArrayKlass* ak = ValueArrayKlass::cast(k);
 830       // Value type array must be zeroed because not all memory is reassigned
 831       obj = ak->allocate(sv->field_size(), THREAD);
 832     } else if (k->is_typeArray_klass()) {
 833       TypeArrayKlass* ak = TypeArrayKlass::cast(k);
 834       assert(sv->field_size() % type2size[ak->element_type()] == 0, "non-integral array length");
 835       int len = sv->field_size() / type2size[ak->element_type()];
 836       obj = ak->allocate(len, THREAD);
 837     } else if (k->is_objArray_klass()) {
 838       ObjArrayKlass* ak = ObjArrayKlass::cast(k);
 839       obj = ak->allocate(sv->field_size(), THREAD);
 840     }
 841 
 842     if (obj == NULL) {
 843       failures = true;
 844     }
 845 
 846     assert(sv->value().is_null(), "redundant reallocation");
 847     assert(obj != NULL || HAS_PENDING_EXCEPTION, "allocation should succeed or we should get an exception");
 848     CLEAR_PENDING_EXCEPTION;
 849     sv->set_value(obj);
 850   }
 851 
 852   if (failures) {
 853     THROW_OOP_(Universe::out_of_memory_error_realloc_objects(), failures);
 854   } else if (pending_exception.not_null()) {
 855     thread->set_pending_exception(pending_exception(), exception_file, exception_line);
 856   }
 857 
 858   return failures;
 859 }
 860 
 861 // We're deoptimizing at the return of a call, value type fields are
 862 // in registers. When we go back to the interpreter, it will expect a
 863 // reference to a value type instance. Allocate and initialize it from
 864 // the register values here.
 865 bool Deoptimization::realloc_value_type_result(ValueKlass* vk, const RegisterMap& map, GrowableArray<Handle>& return_oops, TRAPS) {
 866   oop new_vt = vk->realloc_result(map, return_oops, false, THREAD);
 867   if (new_vt == NULL) {
 868     CLEAR_PENDING_EXCEPTION;
 869     THROW_OOP_(Universe::out_of_memory_error_realloc_objects(), true);
 870   }
 871   return_oops.clear();
 872   return_oops.push(Handle(THREAD, new_vt));
 873   return false;
 874 }
 875 
 876 // restore elements of an eliminated type array
 877 void Deoptimization::reassign_type_array_elements(frame* fr, RegisterMap* reg_map, ObjectValue* sv, typeArrayOop obj, BasicType type) {
 878   int index = 0;
 879   intptr_t val;
 880 
 881   for (int i = 0; i < sv->field_size(); i++) {
 882     StackValue* value = StackValue::create_stack_value(fr, reg_map, sv->field_at(i));
 883     switch(type) {
 884     case T_LONG: case T_DOUBLE: {
 885       assert(value->type() == T_INT, "Agreement.");
 886       StackValue* low =
 887         StackValue::create_stack_value(fr, reg_map, sv->field_at(++i));
 888 #ifdef _LP64
 889       jlong res = (jlong)low->get_int();
 890 #else
 891 #ifdef SPARC
 892       // For SPARC we have to swap high and low words.
 893       jlong res = jlong_from((jint)low->get_int(), (jint)value->get_int());
 894 #else
 895       jlong res = jlong_from((jint)value->get_int(), (jint)low->get_int());
 896 #endif //SPARC
 897 #endif
 898       obj->long_at_put(index, res);
 899       break;
 900     }
 901 
 902     // Have to cast to INT (32 bits) pointer to avoid little/big-endian problem.
 903     case T_INT: case T_FLOAT: { // 4 bytes.
 904       assert(value->type() == T_INT, "Agreement.");
 905       bool big_value = false;
 906       if (i + 1 < sv->field_size() && type == T_INT) {
 907         if (sv->field_at(i)->is_location()) {
 908           Location::Type type = ((LocationValue*) sv->field_at(i))->location().type();
 909           if (type == Location::dbl || type == Location::lng) {
 910             big_value = true;
 911           }
 912         } else if (sv->field_at(i)->is_constant_int()) {
 913           ScopeValue* next_scope_field = sv->field_at(i + 1);
 914           if (next_scope_field->is_constant_long() || next_scope_field->is_constant_double()) {
 915             big_value = true;
 916           }
 917         }
 918       }
 919 
 920       if (big_value) {
 921         StackValue* low = StackValue::create_stack_value(fr, reg_map, sv->field_at(++i));
 922   #ifdef _LP64
 923         jlong res = (jlong)low->get_int();
 924   #else
 925   #ifdef SPARC
 926         // For SPARC we have to swap high and low words.
 927         jlong res = jlong_from((jint)low->get_int(), (jint)value->get_int());
 928   #else
 929         jlong res = jlong_from((jint)value->get_int(), (jint)low->get_int());
 930   #endif //SPARC
 931   #endif
 932         obj->int_at_put(index, (jint)*((jint*)&res));
 933         obj->int_at_put(++index, (jint)*(((jint*)&res) + 1));
 934       } else {
 935         val = value->get_int();
 936         obj->int_at_put(index, (jint)*((jint*)&val));
 937       }
 938       break;
 939     }
 940 
 941     case T_SHORT:
 942       assert(value->type() == T_INT, "Agreement.");
 943       val = value->get_int();
 944       obj->short_at_put(index, (jshort)*((jint*)&val));
 945       break;
 946 
 947     case T_CHAR:
 948       assert(value->type() == T_INT, "Agreement.");
 949       val = value->get_int();
 950       obj->char_at_put(index, (jchar)*((jint*)&val));
 951       break;
 952 
 953     case T_BYTE:
 954       assert(value->type() == T_INT, "Agreement.");
 955       val = value->get_int();
 956       obj->byte_at_put(index, (jbyte)*((jint*)&val));
 957       break;
 958 
 959     case T_BOOLEAN:
 960       assert(value->type() == T_INT, "Agreement.");
 961       val = value->get_int();
 962       obj->bool_at_put(index, (jboolean)*((jint*)&val));
 963       break;
 964 
 965       default:
 966         ShouldNotReachHere();
 967     }
 968     index++;
 969   }
 970 }
 971 
 972 
 973 // restore fields of an eliminated object array
 974 void Deoptimization::reassign_object_array_elements(frame* fr, RegisterMap* reg_map, ObjectValue* sv, objArrayOop obj) {
 975   for (int i = 0; i < sv->field_size(); i++) {
 976     StackValue* value = StackValue::create_stack_value(fr, reg_map, sv->field_at(i));
 977     assert(value->type() == T_OBJECT, "object element expected");
 978     obj->obj_at_put(i, value->get_obj()());
 979   }
 980 }
 981 
 982 class ReassignedField {
 983 public:
 984   int _offset;
 985   BasicType _type;
 986   InstanceKlass* _klass;
 987 public:
 988   ReassignedField() {
 989     _offset = 0;
 990     _type = T_ILLEGAL;
 991     _klass = NULL;
 992   }
 993 };
 994 
 995 int compare(ReassignedField* left, ReassignedField* right) {
 996   return left->_offset - right->_offset;
 997 }
 998 
 999 // Restore fields of an eliminated instance object using the same field order
1000 // returned by HotSpotResolvedObjectTypeImpl.getInstanceFields(true)
1001 static int reassign_fields_by_klass(InstanceKlass* klass, frame* fr, RegisterMap* reg_map, ObjectValue* sv, int svIndex, oop obj, bool skip_internal, int base_offset, TRAPS) {
1002   if (klass->superklass() != NULL) {
1003     svIndex = reassign_fields_by_klass(klass->superklass(), fr, reg_map, sv, svIndex, obj, skip_internal, 0, CHECK_0);
1004   }
1005 
1006   GrowableArray<ReassignedField>* fields = new GrowableArray<ReassignedField>();
1007   for (AllFieldStream fs(klass); !fs.done(); fs.next()) {
1008     if (!fs.access_flags().is_static() && (!skip_internal || !fs.access_flags().is_internal())) {
1009       ReassignedField field;
1010       field._offset = fs.offset();
1011       field._type = fs.is_flattened() ? T_VALUETYPE : FieldType::basic_type(fs.signature());
1012       if (field._type == T_VALUETYPE) {
1013         if (fs.is_flattened()) {
1014           // Resolve klass of flattened value type field
1015           Klass* vk = klass->get_value_field_klass(fs.index());
1016           assert(vk->is_value(), "must be a ValueKlass");
1017           field._klass = InstanceKlass::cast(vk);
1018         } else {
1019           // Non-flattened value type field
1020           field._type = T_VALUETYPEPTR;
1021         }
1022       }
1023       fields->append(field);
1024     }
1025   }
1026   fields->sort(compare);
1027   for (int i = 0; i < fields->length(); i++) {
1028     intptr_t val;
1029     ScopeValue* scope_field = sv->field_at(svIndex);
1030     StackValue* value = StackValue::create_stack_value(fr, reg_map, scope_field);
1031     int offset = base_offset + fields->at(i)._offset;
1032     BasicType type = fields->at(i)._type;
1033     switch (type) {
1034       case T_OBJECT:
1035       case T_VALUETYPEPTR:
1036       case T_ARRAY:
1037         assert(value->type() == T_OBJECT, "Agreement.");
1038         obj->obj_field_put(offset, value->get_obj()());
1039         break;
1040 
1041       case T_VALUETYPE: {
1042         // Recursively re-assign flattened value type fields
1043         InstanceKlass* vk = fields->at(i)._klass;
1044         assert(vk != NULL, "must be resolved");
1045         offset -= ValueKlass::cast(vk)->first_field_offset(); // Adjust offset to omit oop header
1046         svIndex = reassign_fields_by_klass(vk, fr, reg_map, sv, svIndex, obj, skip_internal, offset, CHECK_0);
1047         continue; // Continue because we don't need to increment svIndex
1048       }
1049 
1050       // Have to cast to INT (32 bits) pointer to avoid little/big-endian problem.
1051       case T_INT: case T_FLOAT: { // 4 bytes.
1052         assert(value->type() == T_INT, "Agreement.");
1053         bool big_value = false;
1054         if (i+1 < fields->length() && fields->at(i+1)._type == T_INT) {
1055           if (scope_field->is_location()) {
1056             Location::Type type = ((LocationValue*) scope_field)->location().type();
1057             if (type == Location::dbl || type == Location::lng) {
1058               big_value = true;
1059             }
1060           }
1061           if (scope_field->is_constant_int()) {
1062             ScopeValue* next_scope_field = sv->field_at(svIndex + 1);
1063             if (next_scope_field->is_constant_long() || next_scope_field->is_constant_double()) {
1064               big_value = true;
1065             }
1066           }
1067         }
1068 
1069         if (big_value) {
1070           i++;
1071           assert(i < fields->length(), "second T_INT field needed");
1072           assert(fields->at(i)._type == T_INT, "T_INT field needed");
1073         } else {
1074           val = value->get_int();
1075           obj->int_field_put(offset, (jint)*((jint*)&val));
1076           break;
1077         }
1078       }
1079         /* no break */
1080 
1081       case T_LONG: case T_DOUBLE: {
1082         assert(value->type() == T_INT, "Agreement.");
1083         StackValue* low = StackValue::create_stack_value(fr, reg_map, sv->field_at(++svIndex));
1084 #ifdef _LP64
1085         jlong res = (jlong)low->get_int();
1086 #else
1087 #ifdef SPARC
1088         // For SPARC we have to swap high and low words.
1089         jlong res = jlong_from((jint)low->get_int(), (jint)value->get_int());
1090 #else
1091         jlong res = jlong_from((jint)value->get_int(), (jint)low->get_int());
1092 #endif //SPARC
1093 #endif
1094         obj->long_field_put(offset, res);
1095         break;
1096       }
1097 
1098       case T_SHORT:
1099         assert(value->type() == T_INT, "Agreement.");
1100         val = value->get_int();
1101         obj->short_field_put(offset, (jshort)*((jint*)&val));
1102         break;
1103 
1104       case T_CHAR:
1105         assert(value->type() == T_INT, "Agreement.");
1106         val = value->get_int();
1107         obj->char_field_put(offset, (jchar)*((jint*)&val));
1108         break;
1109 
1110       case T_BYTE:
1111         assert(value->type() == T_INT, "Agreement.");
1112         val = value->get_int();
1113         obj->byte_field_put(offset, (jbyte)*((jint*)&val));
1114         break;
1115 
1116       case T_BOOLEAN:
1117         assert(value->type() == T_INT, "Agreement.");
1118         val = value->get_int();
1119         obj->bool_field_put(offset, (jboolean)*((jint*)&val));
1120         break;
1121 
1122       default:
1123         ShouldNotReachHere();
1124     }
1125     svIndex++;
1126   }
1127   return svIndex;
1128 }
1129 
1130 // restore fields of an eliminated value type array
1131 void Deoptimization::reassign_value_array_elements(frame* fr, RegisterMap* reg_map, ObjectValue* sv, valueArrayOop obj, ValueArrayKlass* vak, TRAPS) {
1132   ValueKlass* vk = vak->element_klass();
1133   assert(vk->flatten_array(), "should only be used for flattened value type arrays");
1134   // Adjust offset to omit oop header
1135   int base_offset = arrayOopDesc::base_offset_in_bytes(T_VALUETYPE) - ValueKlass::cast(vk)->first_field_offset();
1136   // Initialize all elements of the flattened value type array
1137   for (int i = 0; i < sv->field_size(); i++) {
1138     ScopeValue* val = sv->field_at(i);
1139     int offset = base_offset + (i << Klass::layout_helper_log2_element_size(vak->layout_helper()));
1140     reassign_fields_by_klass(vk, fr, reg_map, val->as_ObjectValue(), 0, (oop)obj, false /* skip_internal */, offset, CHECK);
1141   }
1142 }
1143 
1144 // restore fields of all eliminated objects and arrays
1145 void Deoptimization::reassign_fields(frame* fr, RegisterMap* reg_map, GrowableArray<ScopeValue*>* objects, bool realloc_failures, bool skip_internal, TRAPS) {
1146   for (int i = 0; i < objects->length(); i++) {
1147     ObjectValue* sv = (ObjectValue*) objects->at(i);
1148     Klass* k = java_lang_Class::as_Klass(sv->klass()->as_ConstantOopReadValue()->value()());
1149     Handle obj = sv->value();
1150     assert(obj.not_null() || realloc_failures, "reallocation was missed");
1151     if (PrintDeoptimizationDetails) {
1152       tty->print_cr("reassign fields for object of type %s!", k->name()->as_C_string());
1153     }
1154     if (obj.is_null()) {
1155       continue;
1156     }
1157 
1158     if (k->is_instance_klass()) {
1159       InstanceKlass* ik = InstanceKlass::cast(k);
1160       reassign_fields_by_klass(ik, fr, reg_map, sv, 0, obj(), skip_internal, 0, CHECK);
1161     } else if (k->is_valueArray_klass()) {
1162       ValueArrayKlass* vak = ValueArrayKlass::cast(k);
1163       reassign_value_array_elements(fr, reg_map, sv, (valueArrayOop) obj(), vak, CHECK);
1164     } else if (k->is_typeArray_klass()) {
1165       TypeArrayKlass* ak = TypeArrayKlass::cast(k);
1166       reassign_type_array_elements(fr, reg_map, sv, (typeArrayOop) obj(), ak->element_type());
1167     } else if (k->is_objArray_klass()) {
1168       reassign_object_array_elements(fr, reg_map, sv, (objArrayOop) obj());
1169     }
1170   }
1171 }
1172 
1173 
1174 // relock objects for which synchronization was eliminated
1175 void Deoptimization::relock_objects(GrowableArray<MonitorInfo*>* monitors, JavaThread* thread, bool realloc_failures) {
1176   for (int i = 0; i < monitors->length(); i++) {
1177     MonitorInfo* mon_info = monitors->at(i);
1178     if (mon_info->eliminated()) {
1179       assert(!mon_info->owner_is_scalar_replaced() || realloc_failures, "reallocation was missed");
1180       if (!mon_info->owner_is_scalar_replaced()) {
1181         Handle obj(thread, mon_info->owner());
1182         markOop mark = obj->mark();
1183         if (UseBiasedLocking && mark->has_bias_pattern()) {
1184           // New allocated objects may have the mark set to anonymously biased.
1185           // Also the deoptimized method may called methods with synchronization
1186           // where the thread-local object is bias locked to the current thread.
1187           assert(mark->is_biased_anonymously() ||
1188                  mark->biased_locker() == thread, "should be locked to current thread");
1189           // Reset mark word to unbiased prototype.
1190           markOop unbiased_prototype = markOopDesc::prototype()->set_age(mark->age());
1191           obj->set_mark(unbiased_prototype);
1192         }
1193         BasicLock* lock = mon_info->lock();
1194         ObjectSynchronizer::slow_enter(obj, lock, thread);
1195         assert(mon_info->owner()->is_locked(), "object must be locked now");
1196       }
1197     }
1198   }
1199 }
1200 
1201 
1202 #ifndef PRODUCT
1203 // print information about reallocated objects
1204 void Deoptimization::print_objects(GrowableArray<ScopeValue*>* objects, bool realloc_failures) {
1205   fieldDescriptor fd;
1206 
1207   for (int i = 0; i < objects->length(); i++) {
1208     ObjectValue* sv = (ObjectValue*) objects->at(i);
1209     Klass* k = java_lang_Class::as_Klass(sv->klass()->as_ConstantOopReadValue()->value()());
1210     Handle obj = sv->value();
1211 
1212     tty->print("     object <" INTPTR_FORMAT "> of type ", p2i(sv->value()()));
1213     k->print_value();
1214     assert(obj.not_null() || realloc_failures, "reallocation was missed");
1215     if (obj.is_null()) {
1216       tty->print(" allocation failed");
1217     } else {
1218       tty->print(" allocated (%d bytes)", obj->size() * HeapWordSize);
1219     }
1220     tty->cr();
1221 
1222     if (Verbose && !obj.is_null()) {
1223       k->oop_print_on(obj(), tty);
1224     }
1225   }
1226 }
1227 #endif
1228 #endif // COMPILER2_OR_JVMCI
1229 
1230 vframeArray* Deoptimization::create_vframeArray(JavaThread* thread, frame fr, RegisterMap *reg_map, GrowableArray<compiledVFrame*>* chunk, bool realloc_failures) {
1231   Events::log(thread, "DEOPT PACKING pc=" INTPTR_FORMAT " sp=" INTPTR_FORMAT, p2i(fr.pc()), p2i(fr.sp()));
1232 
1233 #ifndef PRODUCT
1234   if (PrintDeoptimizationDetails) {
1235     ttyLocker ttyl;
1236     tty->print("DEOPT PACKING thread " INTPTR_FORMAT " ", p2i(thread));
1237     fr.print_on(tty);
1238     tty->print_cr("     Virtual frames (innermost first):");
1239     for (int index = 0; index < chunk->length(); index++) {
1240       compiledVFrame* vf = chunk->at(index);
1241       tty->print("       %2d - ", index);
1242       vf->print_value();
1243       int bci = chunk->at(index)->raw_bci();
1244       const char* code_name;
1245       if (bci == SynchronizationEntryBCI) {
1246         code_name = "sync entry";
1247       } else {
1248         Bytecodes::Code code = vf->method()->code_at(bci);
1249         code_name = Bytecodes::name(code);
1250       }
1251       tty->print(" - %s", code_name);
1252       tty->print_cr(" @ bci %d ", bci);
1253       if (Verbose) {
1254         vf->print();
1255         tty->cr();
1256       }
1257     }
1258   }
1259 #endif
1260 
1261   // Register map for next frame (used for stack crawl).  We capture
1262   // the state of the deopt'ing frame's caller.  Thus if we need to
1263   // stuff a C2I adapter we can properly fill in the callee-save
1264   // register locations.
1265   frame caller = fr.sender(reg_map);
1266   int frame_size = caller.sp() - fr.sp();
1267 
1268   frame sender = caller;
1269 
1270   // Since the Java thread being deoptimized will eventually adjust it's own stack,
1271   // the vframeArray containing the unpacking information is allocated in the C heap.
1272   // For Compiler1, the caller of the deoptimized frame is saved for use by unpack_frames().
1273   vframeArray* array = vframeArray::allocate(thread, frame_size, chunk, reg_map, sender, caller, fr, realloc_failures);
1274 
1275   // Compare the vframeArray to the collected vframes
1276   assert(array->structural_compare(thread, chunk), "just checking");
1277 
1278 #ifndef PRODUCT
1279   if (PrintDeoptimizationDetails) {
1280     ttyLocker ttyl;
1281     tty->print_cr("     Created vframeArray " INTPTR_FORMAT, p2i(array));
1282   }
1283 #endif // PRODUCT
1284 
1285   return array;
1286 }
1287 
1288 #if COMPILER2_OR_JVMCI
1289 void Deoptimization::pop_frames_failed_reallocs(JavaThread* thread, vframeArray* array) {
1290   // Reallocation of some scalar replaced objects failed. Record
1291   // that we need to pop all the interpreter frames for the
1292   // deoptimized compiled frame.
1293   assert(thread->frames_to_pop_failed_realloc() == 0, "missed frames to pop?");
1294   thread->set_frames_to_pop_failed_realloc(array->frames());
1295   // Unlock all monitors here otherwise the interpreter will see a
1296   // mix of locked and unlocked monitors (because of failed
1297   // reallocations of synchronized objects) and be confused.
1298   for (int i = 0; i < array->frames(); i++) {
1299     MonitorChunk* monitors = array->element(i)->monitors();
1300     if (monitors != NULL) {
1301       for (int j = 0; j < monitors->number_of_monitors(); j++) {
1302         BasicObjectLock* src = monitors->at(j);
1303         if (src->obj() != NULL) {
1304           ObjectSynchronizer::fast_exit(src->obj(), src->lock(), thread);
1305         }
1306       }
1307       array->element(i)->free_monitors(thread);
1308 #ifdef ASSERT
1309       array->element(i)->set_removed_monitors();
1310 #endif
1311     }
1312   }
1313 }
1314 #endif
1315 
1316 static void collect_monitors(compiledVFrame* cvf, GrowableArray<Handle>* objects_to_revoke) {
1317   GrowableArray<MonitorInfo*>* monitors = cvf->monitors();
1318   Thread* thread = Thread::current();
1319   for (int i = 0; i < monitors->length(); i++) {
1320     MonitorInfo* mon_info = monitors->at(i);
1321     if (!mon_info->eliminated() && mon_info->owner() != NULL) {
1322       objects_to_revoke->append(Handle(thread, mon_info->owner()));
1323     }
1324   }
1325 }
1326 
1327 
1328 void Deoptimization::revoke_biases_of_monitors(JavaThread* thread, frame fr, RegisterMap* map) {
1329   if (!UseBiasedLocking) {
1330     return;
1331   }
1332 
1333   GrowableArray<Handle>* objects_to_revoke = new GrowableArray<Handle>();
1334 
1335   // Unfortunately we don't have a RegisterMap available in most of
1336   // the places we want to call this routine so we need to walk the
1337   // stack again to update the register map.
1338   if (map == NULL || !map->update_map()) {
1339     StackFrameStream sfs(thread, true);
1340     bool found = false;
1341     while (!found && !sfs.is_done()) {
1342       frame* cur = sfs.current();
1343       sfs.next();
1344       found = cur->id() == fr.id();
1345     }
1346     assert(found, "frame to be deoptimized not found on target thread's stack");
1347     map = sfs.register_map();
1348   }
1349 
1350   vframe* vf = vframe::new_vframe(&fr, map, thread);
1351   compiledVFrame* cvf = compiledVFrame::cast(vf);
1352   // Revoke monitors' biases in all scopes
1353   while (!cvf->is_top()) {
1354     collect_monitors(cvf, objects_to_revoke);
1355     cvf = compiledVFrame::cast(cvf->sender());
1356   }
1357   collect_monitors(cvf, objects_to_revoke);
1358 
1359   if (SafepointSynchronize::is_at_safepoint()) {
1360     BiasedLocking::revoke_at_safepoint(objects_to_revoke);
1361   } else {
1362     BiasedLocking::revoke(objects_to_revoke);
1363   }
1364 }
1365 
1366 
1367 void Deoptimization::revoke_biases_of_monitors(CodeBlob* cb) {
1368   if (!UseBiasedLocking) {
1369     return;
1370   }
1371 
1372   assert(SafepointSynchronize::is_at_safepoint(), "must only be called from safepoint");
1373   GrowableArray<Handle>* objects_to_revoke = new GrowableArray<Handle>();
1374   for (JavaThreadIteratorWithHandle jtiwh; JavaThread *jt = jtiwh.next(); ) {
1375     if (jt->has_last_Java_frame()) {
1376       StackFrameStream sfs(jt, true);
1377       while (!sfs.is_done()) {
1378         frame* cur = sfs.current();
1379         if (cb->contains(cur->pc())) {
1380           vframe* vf = vframe::new_vframe(cur, sfs.register_map(), jt);
1381           compiledVFrame* cvf = compiledVFrame::cast(vf);
1382           // Revoke monitors' biases in all scopes
1383           while (!cvf->is_top()) {
1384             collect_monitors(cvf, objects_to_revoke);
1385             cvf = compiledVFrame::cast(cvf->sender());
1386           }
1387           collect_monitors(cvf, objects_to_revoke);
1388         }
1389         sfs.next();
1390       }
1391     }
1392   }
1393   BiasedLocking::revoke_at_safepoint(objects_to_revoke);
1394 }
1395 
1396 
1397 void Deoptimization::deoptimize_single_frame(JavaThread* thread, frame fr, Deoptimization::DeoptReason reason) {
1398   assert(fr.can_be_deoptimized(), "checking frame type");
1399 
1400   gather_statistics(reason, Action_none, Bytecodes::_illegal);
1401 
1402   if (LogCompilation && xtty != NULL) {
1403     CompiledMethod* cm = fr.cb()->as_compiled_method_or_null();
1404     assert(cm != NULL, "only compiled methods can deopt");
1405 
1406     ttyLocker ttyl;
1407     xtty->begin_head("deoptimized thread='" UINTX_FORMAT "' reason='%s' pc='" INTPTR_FORMAT "'",(uintx)thread->osthread()->thread_id(), trap_reason_name(reason), p2i(fr.pc()));
1408     cm->log_identity(xtty);
1409     xtty->end_head();
1410     for (ScopeDesc* sd = cm->scope_desc_at(fr.pc()); ; sd = sd->sender()) {
1411       xtty->begin_elem("jvms bci='%d'", sd->bci());
1412       xtty->method(sd->method());
1413       xtty->end_elem();
1414       if (sd->is_top())  break;
1415     }
1416     xtty->tail("deoptimized");
1417   }
1418 
1419   // Patch the compiled method so that when execution returns to it we will
1420   // deopt the execution state and return to the interpreter.
1421   fr.deoptimize(thread);
1422 }
1423 
1424 void Deoptimization::deoptimize(JavaThread* thread, frame fr, RegisterMap *map) {
1425   deoptimize(thread, fr, map, Reason_constraint);
1426 }
1427 
1428 void Deoptimization::deoptimize(JavaThread* thread, frame fr, RegisterMap *map, DeoptReason reason) {
1429   // Deoptimize only if the frame comes from compile code.
1430   // Do not deoptimize the frame which is already patched
1431   // during the execution of the loops below.
1432   if (!fr.is_compiled_frame() || fr.is_deoptimized_frame()) {
1433     return;
1434   }
1435   ResourceMark rm;
1436   DeoptimizationMarker dm;
1437   if (UseBiasedLocking) {
1438     revoke_biases_of_monitors(thread, fr, map);
1439   }
1440   deoptimize_single_frame(thread, fr, reason);
1441 
1442 }
1443 
1444 #if INCLUDE_JVMCI
1445 address Deoptimization::deoptimize_for_missing_exception_handler(CompiledMethod* cm) {
1446   // there is no exception handler for this pc => deoptimize
1447   cm->make_not_entrant();
1448 
1449   // Use Deoptimization::deoptimize for all of its side-effects:
1450   // revoking biases of monitors, gathering traps statistics, logging...
1451   // it also patches the return pc but we do not care about that
1452   // since we return a continuation to the deopt_blob below.
1453   JavaThread* thread = JavaThread::current();
1454   RegisterMap reg_map(thread, UseBiasedLocking);
1455   frame runtime_frame = thread->last_frame();
1456   frame caller_frame = runtime_frame.sender(&reg_map);
1457   assert(caller_frame.cb()->as_compiled_method_or_null() == cm, "expect top frame compiled method");
1458   Deoptimization::deoptimize(thread, caller_frame, &reg_map, Deoptimization::Reason_not_compiled_exception_handler);
1459 
1460   MethodData* trap_mdo = get_method_data(thread, cm->method(), true);
1461   if (trap_mdo != NULL) {
1462     trap_mdo->inc_trap_count(Deoptimization::Reason_not_compiled_exception_handler);
1463   }
1464 
1465   return SharedRuntime::deopt_blob()->unpack_with_exception_in_tls();
1466 }
1467 #endif
1468 
1469 void Deoptimization::deoptimize_frame_internal(JavaThread* thread, intptr_t* id, DeoptReason reason) {
1470   assert(thread == Thread::current() || SafepointSynchronize::is_at_safepoint(),
1471          "can only deoptimize other thread at a safepoint");
1472   // Compute frame and register map based on thread and sp.
1473   RegisterMap reg_map(thread, UseBiasedLocking);
1474   frame fr = thread->last_frame();
1475   while (fr.id() != id) {
1476     fr = fr.sender(&reg_map);
1477   }
1478   deoptimize(thread, fr, &reg_map, reason);
1479 }
1480 
1481 
1482 void Deoptimization::deoptimize_frame(JavaThread* thread, intptr_t* id, DeoptReason reason) {
1483   if (thread == Thread::current()) {
1484     Deoptimization::deoptimize_frame_internal(thread, id, reason);
1485   } else {
1486     VM_DeoptimizeFrame deopt(thread, id, reason);
1487     VMThread::execute(&deopt);
1488   }
1489 }
1490 
1491 void Deoptimization::deoptimize_frame(JavaThread* thread, intptr_t* id) {
1492   deoptimize_frame(thread, id, Reason_constraint);
1493 }
1494 
1495 // JVMTI PopFrame support
1496 JRT_LEAF(void, Deoptimization::popframe_preserve_args(JavaThread* thread, int bytes_to_save, void* start_address))
1497 {
1498   thread->popframe_preserve_args(in_ByteSize(bytes_to_save), start_address);
1499 }
1500 JRT_END
1501 
1502 MethodData*
1503 Deoptimization::get_method_data(JavaThread* thread, const methodHandle& m,
1504                                 bool create_if_missing) {
1505   Thread* THREAD = thread;
1506   MethodData* mdo = m()->method_data();
1507   if (mdo == NULL && create_if_missing && !HAS_PENDING_EXCEPTION) {
1508     // Build an MDO.  Ignore errors like OutOfMemory;
1509     // that simply means we won't have an MDO to update.
1510     Method::build_interpreter_method_data(m, THREAD);
1511     if (HAS_PENDING_EXCEPTION) {
1512       assert((PENDING_EXCEPTION->is_a(SystemDictionary::OutOfMemoryError_klass())), "we expect only an OOM error here");
1513       CLEAR_PENDING_EXCEPTION;
1514     }
1515     mdo = m()->method_data();
1516   }
1517   return mdo;
1518 }
1519 
1520 #if COMPILER2_OR_JVMCI
1521 void Deoptimization::load_class_by_index(const constantPoolHandle& constant_pool, int index, TRAPS) {
1522   // in case of an unresolved klass entry, load the class.
1523   if (constant_pool->tag_at(index).is_unresolved_klass()) {
1524     Klass* tk = constant_pool->klass_at_ignore_error(index, CHECK);
1525     return;
1526   }
1527 
1528   if (!constant_pool->tag_at(index).is_symbol()) return;
1529 
1530   Handle class_loader (THREAD, constant_pool->pool_holder()->class_loader());
1531   Symbol*  symbol  = constant_pool->symbol_at(index);
1532 
1533   // class name?
1534   if (symbol->byte_at(0) != '(') {
1535     Handle protection_domain (THREAD, constant_pool->pool_holder()->protection_domain());
1536     SystemDictionary::resolve_or_null(symbol, class_loader, protection_domain, CHECK);
1537     return;
1538   }
1539 
1540   // then it must be a signature!
1541   ResourceMark rm(THREAD);
1542   for (SignatureStream ss(symbol); !ss.is_done(); ss.next()) {
1543     if (ss.is_object()) {
1544       Symbol* class_name = ss.as_symbol(CHECK);
1545       Handle protection_domain (THREAD, constant_pool->pool_holder()->protection_domain());
1546       SystemDictionary::resolve_or_null(class_name, class_loader, protection_domain, CHECK);
1547     }
1548   }
1549 }
1550 
1551 
1552 void Deoptimization::load_class_by_index(const constantPoolHandle& constant_pool, int index) {
1553   EXCEPTION_MARK;
1554   load_class_by_index(constant_pool, index, THREAD);
1555   if (HAS_PENDING_EXCEPTION) {
1556     // Exception happened during classloading. We ignore the exception here, since it
1557     // is going to be rethrown since the current activation is going to be deoptimized and
1558     // the interpreter will re-execute the bytecode.
1559     CLEAR_PENDING_EXCEPTION;
1560     // Class loading called java code which may have caused a stack
1561     // overflow. If the exception was thrown right before the return
1562     // to the runtime the stack is no longer guarded. Reguard the
1563     // stack otherwise if we return to the uncommon trap blob and the
1564     // stack bang causes a stack overflow we crash.
1565     assert(THREAD->is_Java_thread(), "only a java thread can be here");
1566     JavaThread* thread = (JavaThread*)THREAD;
1567     bool guard_pages_enabled = thread->stack_guards_enabled();
1568     if (!guard_pages_enabled) guard_pages_enabled = thread->reguard_stack();
1569     assert(guard_pages_enabled, "stack banging in uncommon trap blob may cause crash");
1570   }
1571 }
1572 
1573 JRT_ENTRY(void, Deoptimization::uncommon_trap_inner(JavaThread* thread, jint trap_request)) {
1574   HandleMark hm;
1575 
1576   // uncommon_trap() is called at the beginning of the uncommon trap
1577   // handler. Note this fact before we start generating temporary frames
1578   // that can confuse an asynchronous stack walker. This counter is
1579   // decremented at the end of unpack_frames().
1580   thread->inc_in_deopt_handler();
1581 
1582   // We need to update the map if we have biased locking.
1583 #if INCLUDE_JVMCI
1584   // JVMCI might need to get an exception from the stack, which in turn requires the register map to be valid
1585   RegisterMap reg_map(thread, true);
1586 #else
1587   RegisterMap reg_map(thread, UseBiasedLocking);
1588 #endif
1589   frame stub_frame = thread->last_frame();
1590   frame fr = stub_frame.sender(&reg_map);
1591   // Make sure the calling nmethod is not getting deoptimized and removed
1592   // before we are done with it.
1593   nmethodLocker nl(fr.pc());
1594 
1595   // Log a message
1596   Events::log(thread, "Uncommon trap: trap_request=" PTR32_FORMAT " fr.pc=" INTPTR_FORMAT " relative=" INTPTR_FORMAT,
1597               trap_request, p2i(fr.pc()), fr.pc() - fr.cb()->code_begin());
1598 
1599   {
1600     ResourceMark rm;
1601 
1602     // Revoke biases of any monitors in the frame to ensure we can migrate them
1603     revoke_biases_of_monitors(thread, fr, &reg_map);
1604 
1605     DeoptReason reason = trap_request_reason(trap_request);
1606     DeoptAction action = trap_request_action(trap_request);
1607 #if INCLUDE_JVMCI
1608     int debug_id = trap_request_debug_id(trap_request);
1609 #endif
1610     jint unloaded_class_index = trap_request_index(trap_request); // CP idx or -1
1611 
1612     vframe*  vf  = vframe::new_vframe(&fr, &reg_map, thread);
1613     compiledVFrame* cvf = compiledVFrame::cast(vf);
1614 
1615     CompiledMethod* nm = cvf->code();
1616 
1617     ScopeDesc*      trap_scope  = cvf->scope();
1618 
1619     if (TraceDeoptimization) {
1620       ttyLocker ttyl;
1621       tty->print_cr("  bci=%d pc=" INTPTR_FORMAT ", relative_pc=" INTPTR_FORMAT ", method=%s" JVMCI_ONLY(", debug_id=%d"), trap_scope->bci(), p2i(fr.pc()), fr.pc() - nm->code_begin(), trap_scope->method()->name_and_sig_as_C_string()
1622 #if INCLUDE_JVMCI
1623           , debug_id
1624 #endif
1625           );
1626     }
1627 
1628     methodHandle    trap_method = trap_scope->method();
1629     int             trap_bci    = trap_scope->bci();
1630 #if INCLUDE_JVMCI
1631     long speculation = thread->pending_failed_speculation();
1632     if (nm->is_compiled_by_jvmci()) {
1633       if (speculation != 0) {
1634         oop speculation_log = nm->as_nmethod()->speculation_log();
1635         if (speculation_log != NULL) {
1636           if (TraceDeoptimization || TraceUncollectedSpeculations) {
1637             if (HotSpotSpeculationLog::lastFailed(speculation_log) != 0) {
1638               tty->print_cr("A speculation that was not collected by the compiler is being overwritten");
1639             }
1640           }
1641           if (TraceDeoptimization) {
1642             tty->print_cr("Saving speculation to speculation log");
1643           }
1644           HotSpotSpeculationLog::set_lastFailed(speculation_log, speculation);
1645         } else {
1646           if (TraceDeoptimization) {
1647             tty->print_cr("Speculation present but no speculation log");
1648           }
1649         }
1650         thread->set_pending_failed_speculation(0);
1651       } else {
1652         if (TraceDeoptimization) {
1653           tty->print_cr("No speculation");
1654         }
1655       }
1656     } else {
1657       assert(speculation == 0, "There should not be a speculation for method compiled by non-JVMCI compilers");
1658     }
1659 
1660     if (trap_bci == SynchronizationEntryBCI) {
1661       trap_bci = 0;
1662       thread->set_pending_monitorenter(true);
1663     }
1664 
1665     if (reason == Deoptimization::Reason_transfer_to_interpreter) {
1666       thread->set_pending_transfer_to_interpreter(true);
1667     }
1668 #endif
1669 
1670     Bytecodes::Code trap_bc     = trap_method->java_code_at(trap_bci);
1671     // Record this event in the histogram.
1672     gather_statistics(reason, action, trap_bc);
1673 
1674     // Ensure that we can record deopt. history:
1675     // Need MDO to record RTM code generation state.
1676     bool create_if_missing = ProfileTraps || UseCodeAging RTM_OPT_ONLY( || UseRTMLocking );
1677 
1678     methodHandle profiled_method;
1679 #if INCLUDE_JVMCI
1680     if (nm->is_compiled_by_jvmci()) {
1681       profiled_method = nm->method();
1682     } else {
1683       profiled_method = trap_method;
1684     }
1685 #else
1686     profiled_method = trap_method;
1687 #endif
1688 
1689     MethodData* trap_mdo =
1690       get_method_data(thread, profiled_method, create_if_missing);
1691 
1692     // Log a message
1693     Events::log_deopt_message(thread, "Uncommon trap: reason=%s action=%s pc=" INTPTR_FORMAT " method=%s @ %d %s",
1694                               trap_reason_name(reason), trap_action_name(action), p2i(fr.pc()),
1695                               trap_method->name_and_sig_as_C_string(), trap_bci, nm->compiler_name());
1696 
1697     // Print a bunch of diagnostics, if requested.
1698     if (TraceDeoptimization || LogCompilation) {
1699       ResourceMark rm;
1700       ttyLocker ttyl;
1701       char buf[100];
1702       if (xtty != NULL) {
1703         xtty->begin_head("uncommon_trap thread='" UINTX_FORMAT "' %s",
1704                          os::current_thread_id(),
1705                          format_trap_request(buf, sizeof(buf), trap_request));
1706         nm->log_identity(xtty);
1707       }
1708       Symbol* class_name = NULL;
1709       bool unresolved = false;
1710       if (unloaded_class_index >= 0) {
1711         constantPoolHandle constants (THREAD, trap_method->constants());
1712         if (constants->tag_at(unloaded_class_index).is_unresolved_klass()) {
1713           class_name = constants->klass_name_at(unloaded_class_index);
1714           unresolved = true;
1715           if (xtty != NULL)
1716             xtty->print(" unresolved='1'");
1717         } else if (constants->tag_at(unloaded_class_index).is_symbol()) {
1718           class_name = constants->symbol_at(unloaded_class_index);
1719         }
1720         if (xtty != NULL)
1721           xtty->name(class_name);
1722       }
1723       if (xtty != NULL && trap_mdo != NULL && (int)reason < (int)MethodData::_trap_hist_limit) {
1724         // Dump the relevant MDO state.
1725         // This is the deopt count for the current reason, any previous
1726         // reasons or recompiles seen at this point.
1727         int dcnt = trap_mdo->trap_count(reason);
1728         if (dcnt != 0)
1729           xtty->print(" count='%d'", dcnt);
1730         ProfileData* pdata = trap_mdo->bci_to_data(trap_bci);
1731         int dos = (pdata == NULL)? 0: pdata->trap_state();
1732         if (dos != 0) {
1733           xtty->print(" state='%s'", format_trap_state(buf, sizeof(buf), dos));
1734           if (trap_state_is_recompiled(dos)) {
1735             int recnt2 = trap_mdo->overflow_recompile_count();
1736             if (recnt2 != 0)
1737               xtty->print(" recompiles2='%d'", recnt2);
1738           }
1739         }
1740       }
1741       if (xtty != NULL) {
1742         xtty->stamp();
1743         xtty->end_head();
1744       }
1745       if (TraceDeoptimization) {  // make noise on the tty
1746         tty->print("Uncommon trap occurred in");
1747         nm->method()->print_short_name(tty);
1748         tty->print(" compiler=%s compile_id=%d", nm->compiler_name(), nm->compile_id());
1749 #if INCLUDE_JVMCI
1750         if (nm->is_nmethod()) {
1751           char* installed_code_name = nm->as_nmethod()->jvmci_installed_code_name(buf, sizeof(buf));
1752           if (installed_code_name != NULL) {
1753             tty->print(" (JVMCI: installed code name=%s) ", installed_code_name);
1754           }
1755         }
1756 #endif
1757         tty->print(" (@" INTPTR_FORMAT ") thread=" UINTX_FORMAT " reason=%s action=%s unloaded_class_index=%d" JVMCI_ONLY(" debug_id=%d"),
1758                    p2i(fr.pc()),
1759                    os::current_thread_id(),
1760                    trap_reason_name(reason),
1761                    trap_action_name(action),
1762                    unloaded_class_index
1763 #if INCLUDE_JVMCI
1764                    , debug_id
1765 #endif
1766                    );
1767         if (class_name != NULL) {
1768           tty->print(unresolved ? " unresolved class: " : " symbol: ");
1769           class_name->print_symbol_on(tty);
1770         }
1771         tty->cr();
1772       }
1773       if (xtty != NULL) {
1774         // Log the precise location of the trap.
1775         for (ScopeDesc* sd = trap_scope; ; sd = sd->sender()) {
1776           xtty->begin_elem("jvms bci='%d'", sd->bci());
1777           xtty->method(sd->method());
1778           xtty->end_elem();
1779           if (sd->is_top())  break;
1780         }
1781         xtty->tail("uncommon_trap");
1782       }
1783     }
1784     // (End diagnostic printout.)
1785 
1786     // Load class if necessary
1787     if (unloaded_class_index >= 0) {
1788       constantPoolHandle constants(THREAD, trap_method->constants());
1789       load_class_by_index(constants, unloaded_class_index);
1790     }
1791 
1792     // Flush the nmethod if necessary and desirable.
1793     //
1794     // We need to avoid situations where we are re-flushing the nmethod
1795     // because of a hot deoptimization site.  Repeated flushes at the same
1796     // point need to be detected by the compiler and avoided.  If the compiler
1797     // cannot avoid them (or has a bug and "refuses" to avoid them), this
1798     // module must take measures to avoid an infinite cycle of recompilation
1799     // and deoptimization.  There are several such measures:
1800     //
1801     //   1. If a recompilation is ordered a second time at some site X
1802     //   and for the same reason R, the action is adjusted to 'reinterpret',
1803     //   to give the interpreter time to exercise the method more thoroughly.
1804     //   If this happens, the method's overflow_recompile_count is incremented.
1805     //
1806     //   2. If the compiler fails to reduce the deoptimization rate, then
1807     //   the method's overflow_recompile_count will begin to exceed the set
1808     //   limit PerBytecodeRecompilationCutoff.  If this happens, the action
1809     //   is adjusted to 'make_not_compilable', and the method is abandoned
1810     //   to the interpreter.  This is a performance hit for hot methods,
1811     //   but is better than a disastrous infinite cycle of recompilations.
1812     //   (Actually, only the method containing the site X is abandoned.)
1813     //
1814     //   3. In parallel with the previous measures, if the total number of
1815     //   recompilations of a method exceeds the much larger set limit
1816     //   PerMethodRecompilationCutoff, the method is abandoned.
1817     //   This should only happen if the method is very large and has
1818     //   many "lukewarm" deoptimizations.  The code which enforces this
1819     //   limit is elsewhere (class nmethod, class Method).
1820     //
1821     // Note that the per-BCI 'is_recompiled' bit gives the compiler one chance
1822     // to recompile at each bytecode independently of the per-BCI cutoff.
1823     //
1824     // The decision to update code is up to the compiler, and is encoded
1825     // in the Action_xxx code.  If the compiler requests Action_none
1826     // no trap state is changed, no compiled code is changed, and the
1827     // computation suffers along in the interpreter.
1828     //
1829     // The other action codes specify various tactics for decompilation
1830     // and recompilation.  Action_maybe_recompile is the loosest, and
1831     // allows the compiled code to stay around until enough traps are seen,
1832     // and until the compiler gets around to recompiling the trapping method.
1833     //
1834     // The other actions cause immediate removal of the present code.
1835 
1836     // Traps caused by injected profile shouldn't pollute trap counts.
1837     bool injected_profile_trap = trap_method->has_injected_profile() &&
1838                                  (reason == Reason_intrinsic || reason == Reason_unreached);
1839 
1840     bool update_trap_state = (reason != Reason_tenured) && !injected_profile_trap;
1841     bool make_not_entrant = false;
1842     bool make_not_compilable = false;
1843     bool reprofile = false;
1844     switch (action) {
1845     case Action_none:
1846       // Keep the old code.
1847       update_trap_state = false;
1848       break;
1849     case Action_maybe_recompile:
1850       // Do not need to invalidate the present code, but we can
1851       // initiate another
1852       // Start compiler without (necessarily) invalidating the nmethod.
1853       // The system will tolerate the old code, but new code should be
1854       // generated when possible.
1855       break;
1856     case Action_reinterpret:
1857       // Go back into the interpreter for a while, and then consider
1858       // recompiling form scratch.
1859       make_not_entrant = true;
1860       // Reset invocation counter for outer most method.
1861       // This will allow the interpreter to exercise the bytecodes
1862       // for a while before recompiling.
1863       // By contrast, Action_make_not_entrant is immediate.
1864       //
1865       // Note that the compiler will track null_check, null_assert,
1866       // range_check, and class_check events and log them as if they
1867       // had been traps taken from compiled code.  This will update
1868       // the MDO trap history so that the next compilation will
1869       // properly detect hot trap sites.
1870       reprofile = true;
1871       break;
1872     case Action_make_not_entrant:
1873       // Request immediate recompilation, and get rid of the old code.
1874       // Make them not entrant, so next time they are called they get
1875       // recompiled.  Unloaded classes are loaded now so recompile before next
1876       // time they are called.  Same for uninitialized.  The interpreter will
1877       // link the missing class, if any.
1878       make_not_entrant = true;
1879       break;
1880     case Action_make_not_compilable:
1881       // Give up on compiling this method at all.
1882       make_not_entrant = true;
1883       make_not_compilable = true;
1884       break;
1885     default:
1886       ShouldNotReachHere();
1887     }
1888 
1889     // Setting +ProfileTraps fixes the following, on all platforms:
1890     // 4852688: ProfileInterpreter is off by default for ia64.  The result is
1891     // infinite heroic-opt-uncommon-trap/deopt/recompile cycles, since the
1892     // recompile relies on a MethodData* to record heroic opt failures.
1893 
1894     // Whether the interpreter is producing MDO data or not, we also need
1895     // to use the MDO to detect hot deoptimization points and control
1896     // aggressive optimization.
1897     bool inc_recompile_count = false;
1898     ProfileData* pdata = NULL;
1899     if (ProfileTraps && !is_client_compilation_mode_vm() && update_trap_state && trap_mdo != NULL) {
1900       assert(trap_mdo == get_method_data(thread, profiled_method, false), "sanity");
1901       uint this_trap_count = 0;
1902       bool maybe_prior_trap = false;
1903       bool maybe_prior_recompile = false;
1904       pdata = query_update_method_data(trap_mdo, trap_bci, reason, true,
1905 #if INCLUDE_JVMCI
1906                                    nm->is_compiled_by_jvmci() && nm->is_osr_method(),
1907 #endif
1908                                    nm->method(),
1909                                    //outputs:
1910                                    this_trap_count,
1911                                    maybe_prior_trap,
1912                                    maybe_prior_recompile);
1913       // Because the interpreter also counts null, div0, range, and class
1914       // checks, these traps from compiled code are double-counted.
1915       // This is harmless; it just means that the PerXTrapLimit values
1916       // are in effect a little smaller than they look.
1917 
1918       DeoptReason per_bc_reason = reason_recorded_per_bytecode_if_any(reason);
1919       if (per_bc_reason != Reason_none) {
1920         // Now take action based on the partially known per-BCI history.
1921         if (maybe_prior_trap
1922             && this_trap_count >= (uint)PerBytecodeTrapLimit) {
1923           // If there are too many traps at this BCI, force a recompile.
1924           // This will allow the compiler to see the limit overflow, and
1925           // take corrective action, if possible.  The compiler generally
1926           // does not use the exact PerBytecodeTrapLimit value, but instead
1927           // changes its tactics if it sees any traps at all.  This provides
1928           // a little hysteresis, delaying a recompile until a trap happens
1929           // several times.
1930           //
1931           // Actually, since there is only one bit of counter per BCI,
1932           // the possible per-BCI counts are {0,1,(per-method count)}.
1933           // This produces accurate results if in fact there is only
1934           // one hot trap site, but begins to get fuzzy if there are
1935           // many sites.  For example, if there are ten sites each
1936           // trapping two or more times, they each get the blame for
1937           // all of their traps.
1938           make_not_entrant = true;
1939         }
1940 
1941         // Detect repeated recompilation at the same BCI, and enforce a limit.
1942         if (make_not_entrant && maybe_prior_recompile) {
1943           // More than one recompile at this point.
1944           inc_recompile_count = maybe_prior_trap;
1945         }
1946       } else {
1947         // For reasons which are not recorded per-bytecode, we simply
1948         // force recompiles unconditionally.
1949         // (Note that PerMethodRecompilationCutoff is enforced elsewhere.)
1950         make_not_entrant = true;
1951       }
1952 
1953       // Go back to the compiler if there are too many traps in this method.
1954       if (this_trap_count >= per_method_trap_limit(reason)) {
1955         // If there are too many traps in this method, force a recompile.
1956         // This will allow the compiler to see the limit overflow, and
1957         // take corrective action, if possible.
1958         // (This condition is an unlikely backstop only, because the
1959         // PerBytecodeTrapLimit is more likely to take effect first,
1960         // if it is applicable.)
1961         make_not_entrant = true;
1962       }
1963 
1964       // Here's more hysteresis:  If there has been a recompile at
1965       // this trap point already, run the method in the interpreter
1966       // for a while to exercise it more thoroughly.
1967       if (make_not_entrant && maybe_prior_recompile && maybe_prior_trap) {
1968         reprofile = true;
1969       }
1970     }
1971 
1972     // Take requested actions on the method:
1973 
1974     // Recompile
1975     if (make_not_entrant) {
1976       if (!nm->make_not_entrant()) {
1977         return; // the call did not change nmethod's state
1978       }
1979 
1980       if (pdata != NULL) {
1981         // Record the recompilation event, if any.
1982         int tstate0 = pdata->trap_state();
1983         int tstate1 = trap_state_set_recompiled(tstate0, true);
1984         if (tstate1 != tstate0)
1985           pdata->set_trap_state(tstate1);
1986       }
1987 
1988 #if INCLUDE_RTM_OPT
1989       // Restart collecting RTM locking abort statistic if the method
1990       // is recompiled for a reason other than RTM state change.
1991       // Assume that in new recompiled code the statistic could be different,
1992       // for example, due to different inlining.
1993       if ((reason != Reason_rtm_state_change) && (trap_mdo != NULL) &&
1994           UseRTMDeopt && (nm->as_nmethod()->rtm_state() != ProfileRTM)) {
1995         trap_mdo->atomic_set_rtm_state(ProfileRTM);
1996       }
1997 #endif
1998       // For code aging we count traps separately here, using make_not_entrant()
1999       // as a guard against simultaneous deopts in multiple threads.
2000       if (reason == Reason_tenured && trap_mdo != NULL) {
2001         trap_mdo->inc_tenure_traps();
2002       }
2003     }
2004 
2005     if (inc_recompile_count) {
2006       trap_mdo->inc_overflow_recompile_count();
2007       if ((uint)trap_mdo->overflow_recompile_count() >
2008           (uint)PerBytecodeRecompilationCutoff) {
2009         // Give up on the method containing the bad BCI.
2010         if (trap_method() == nm->method()) {
2011           make_not_compilable = true;
2012         } else {
2013           trap_method->set_not_compilable(CompLevel_full_optimization, true, "overflow_recompile_count > PerBytecodeRecompilationCutoff");
2014           // But give grace to the enclosing nm->method().
2015         }
2016       }
2017     }
2018 
2019     // Reprofile
2020     if (reprofile) {
2021       CompilationPolicy::policy()->reprofile(trap_scope, nm->is_osr_method());
2022     }
2023 
2024     // Give up compiling
2025     if (make_not_compilable && !nm->method()->is_not_compilable(CompLevel_full_optimization)) {
2026       assert(make_not_entrant, "consistent");
2027       nm->method()->set_not_compilable(CompLevel_full_optimization);
2028     }
2029 
2030   } // Free marked resources
2031 
2032 }
2033 JRT_END
2034 
2035 ProfileData*
2036 Deoptimization::query_update_method_data(MethodData* trap_mdo,
2037                                          int trap_bci,
2038                                          Deoptimization::DeoptReason reason,
2039                                          bool update_total_trap_count,
2040 #if INCLUDE_JVMCI
2041                                          bool is_osr,
2042 #endif
2043                                          Method* compiled_method,
2044                                          //outputs:
2045                                          uint& ret_this_trap_count,
2046                                          bool& ret_maybe_prior_trap,
2047                                          bool& ret_maybe_prior_recompile) {
2048   bool maybe_prior_trap = false;
2049   bool maybe_prior_recompile = false;
2050   uint this_trap_count = 0;
2051   if (update_total_trap_count) {
2052     uint idx = reason;
2053 #if INCLUDE_JVMCI
2054     if (is_osr) {
2055       idx += Reason_LIMIT;
2056     }
2057 #endif
2058     uint prior_trap_count = trap_mdo->trap_count(idx);
2059     this_trap_count  = trap_mdo->inc_trap_count(idx);
2060 
2061     // If the runtime cannot find a place to store trap history,
2062     // it is estimated based on the general condition of the method.
2063     // If the method has ever been recompiled, or has ever incurred
2064     // a trap with the present reason , then this BCI is assumed
2065     // (pessimistically) to be the culprit.
2066     maybe_prior_trap      = (prior_trap_count != 0);
2067     maybe_prior_recompile = (trap_mdo->decompile_count() != 0);
2068   }
2069   ProfileData* pdata = NULL;
2070 
2071 
2072   // For reasons which are recorded per bytecode, we check per-BCI data.
2073   DeoptReason per_bc_reason = reason_recorded_per_bytecode_if_any(reason);
2074   assert(per_bc_reason != Reason_none || update_total_trap_count, "must be");
2075   if (per_bc_reason != Reason_none) {
2076     // Find the profile data for this BCI.  If there isn't one,
2077     // try to allocate one from the MDO's set of spares.
2078     // This will let us detect a repeated trap at this point.
2079     pdata = trap_mdo->allocate_bci_to_data(trap_bci, reason_is_speculate(reason) ? compiled_method : NULL);
2080 
2081     if (pdata != NULL) {
2082       if (reason_is_speculate(reason) && !pdata->is_SpeculativeTrapData()) {
2083         if (LogCompilation && xtty != NULL) {
2084           ttyLocker ttyl;
2085           // no more room for speculative traps in this MDO
2086           xtty->elem("speculative_traps_oom");
2087         }
2088       }
2089       // Query the trap state of this profile datum.
2090       int tstate0 = pdata->trap_state();
2091       if (!trap_state_has_reason(tstate0, per_bc_reason))
2092         maybe_prior_trap = false;
2093       if (!trap_state_is_recompiled(tstate0))
2094         maybe_prior_recompile = false;
2095 
2096       // Update the trap state of this profile datum.
2097       int tstate1 = tstate0;
2098       // Record the reason.
2099       tstate1 = trap_state_add_reason(tstate1, per_bc_reason);
2100       // Store the updated state on the MDO, for next time.
2101       if (tstate1 != tstate0)
2102         pdata->set_trap_state(tstate1);
2103     } else {
2104       if (LogCompilation && xtty != NULL) {
2105         ttyLocker ttyl;
2106         // Missing MDP?  Leave a small complaint in the log.
2107         xtty->elem("missing_mdp bci='%d'", trap_bci);
2108       }
2109     }
2110   }
2111 
2112   // Return results:
2113   ret_this_trap_count = this_trap_count;
2114   ret_maybe_prior_trap = maybe_prior_trap;
2115   ret_maybe_prior_recompile = maybe_prior_recompile;
2116   return pdata;
2117 }
2118 
2119 void
2120 Deoptimization::update_method_data_from_interpreter(MethodData* trap_mdo, int trap_bci, int reason) {
2121   ResourceMark rm;
2122   // Ignored outputs:
2123   uint ignore_this_trap_count;
2124   bool ignore_maybe_prior_trap;
2125   bool ignore_maybe_prior_recompile;
2126   assert(!reason_is_speculate(reason), "reason speculate only used by compiler");
2127   // JVMCI uses the total counts to determine if deoptimizations are happening too frequently -> do not adjust total counts
2128   bool update_total_counts = true JVMCI_ONLY( && !UseJVMCICompiler);
2129   query_update_method_data(trap_mdo, trap_bci,
2130                            (DeoptReason)reason,
2131                            update_total_counts,
2132 #if INCLUDE_JVMCI
2133                            false,
2134 #endif
2135                            NULL,
2136                            ignore_this_trap_count,
2137                            ignore_maybe_prior_trap,
2138                            ignore_maybe_prior_recompile);
2139 }
2140 
2141 Deoptimization::UnrollBlock* Deoptimization::uncommon_trap(JavaThread* thread, jint trap_request, jint exec_mode) {
2142   if (TraceDeoptimization) {
2143     tty->print("Uncommon trap ");
2144   }
2145   // Still in Java no safepoints
2146   {
2147     // This enters VM and may safepoint
2148     uncommon_trap_inner(thread, trap_request);
2149   }
2150   return fetch_unroll_info_helper(thread, exec_mode);
2151 }
2152 
2153 // Local derived constants.
2154 // Further breakdown of DataLayout::trap_state, as promised by DataLayout.
2155 const int DS_REASON_MASK   = ((uint)DataLayout::trap_mask) >> 1;
2156 const int DS_RECOMPILE_BIT = DataLayout::trap_mask - DS_REASON_MASK;
2157 
2158 //---------------------------trap_state_reason---------------------------------
2159 Deoptimization::DeoptReason
2160 Deoptimization::trap_state_reason(int trap_state) {
2161   // This assert provides the link between the width of DataLayout::trap_bits
2162   // and the encoding of "recorded" reasons.  It ensures there are enough
2163   // bits to store all needed reasons in the per-BCI MDO profile.
2164   assert(DS_REASON_MASK >= Reason_RECORDED_LIMIT, "enough bits");
2165   int recompile_bit = (trap_state & DS_RECOMPILE_BIT);
2166   trap_state -= recompile_bit;
2167   if (trap_state == DS_REASON_MASK) {
2168     return Reason_many;
2169   } else {
2170     assert((int)Reason_none == 0, "state=0 => Reason_none");
2171     return (DeoptReason)trap_state;
2172   }
2173 }
2174 //-------------------------trap_state_has_reason-------------------------------
2175 int Deoptimization::trap_state_has_reason(int trap_state, int reason) {
2176   assert(reason_is_recorded_per_bytecode((DeoptReason)reason), "valid reason");
2177   assert(DS_REASON_MASK >= Reason_RECORDED_LIMIT, "enough bits");
2178   int recompile_bit = (trap_state & DS_RECOMPILE_BIT);
2179   trap_state -= recompile_bit;
2180   if (trap_state == DS_REASON_MASK) {
2181     return -1;  // true, unspecifically (bottom of state lattice)
2182   } else if (trap_state == reason) {
2183     return 1;   // true, definitely
2184   } else if (trap_state == 0) {
2185     return 0;   // false, definitely (top of state lattice)
2186   } else {
2187     return 0;   // false, definitely
2188   }
2189 }
2190 //-------------------------trap_state_add_reason-------------------------------
2191 int Deoptimization::trap_state_add_reason(int trap_state, int reason) {
2192   assert(reason_is_recorded_per_bytecode((DeoptReason)reason) || reason == Reason_many, "valid reason");
2193   int recompile_bit = (trap_state & DS_RECOMPILE_BIT);
2194   trap_state -= recompile_bit;
2195   if (trap_state == DS_REASON_MASK) {
2196     return trap_state + recompile_bit;     // already at state lattice bottom
2197   } else if (trap_state == reason) {
2198     return trap_state + recompile_bit;     // the condition is already true
2199   } else if (trap_state == 0) {
2200     return reason + recompile_bit;          // no condition has yet been true
2201   } else {
2202     return DS_REASON_MASK + recompile_bit;  // fall to state lattice bottom
2203   }
2204 }
2205 //-----------------------trap_state_is_recompiled------------------------------
2206 bool Deoptimization::trap_state_is_recompiled(int trap_state) {
2207   return (trap_state & DS_RECOMPILE_BIT) != 0;
2208 }
2209 //-----------------------trap_state_set_recompiled-----------------------------
2210 int Deoptimization::trap_state_set_recompiled(int trap_state, bool z) {
2211   if (z)  return trap_state |  DS_RECOMPILE_BIT;
2212   else    return trap_state & ~DS_RECOMPILE_BIT;
2213 }
2214 //---------------------------format_trap_state---------------------------------
2215 // This is used for debugging and diagnostics, including LogFile output.
2216 const char* Deoptimization::format_trap_state(char* buf, size_t buflen,
2217                                               int trap_state) {
2218   assert(buflen > 0, "sanity");
2219   DeoptReason reason      = trap_state_reason(trap_state);
2220   bool        recomp_flag = trap_state_is_recompiled(trap_state);
2221   // Re-encode the state from its decoded components.
2222   int decoded_state = 0;
2223   if (reason_is_recorded_per_bytecode(reason) || reason == Reason_many)
2224     decoded_state = trap_state_add_reason(decoded_state, reason);
2225   if (recomp_flag)
2226     decoded_state = trap_state_set_recompiled(decoded_state, recomp_flag);
2227   // If the state re-encodes properly, format it symbolically.
2228   // Because this routine is used for debugging and diagnostics,
2229   // be robust even if the state is a strange value.
2230   size_t len;
2231   if (decoded_state != trap_state) {
2232     // Random buggy state that doesn't decode??
2233     len = jio_snprintf(buf, buflen, "#%d", trap_state);
2234   } else {
2235     len = jio_snprintf(buf, buflen, "%s%s",
2236                        trap_reason_name(reason),
2237                        recomp_flag ? " recompiled" : "");
2238   }
2239   return buf;
2240 }
2241 
2242 
2243 //--------------------------------statics--------------------------------------
2244 const char* Deoptimization::_trap_reason_name[] = {
2245   // Note:  Keep this in sync. with enum DeoptReason.
2246   "none",
2247   "null_check",
2248   "null_assert" JVMCI_ONLY("_or_unreached0"),
2249   "range_check",
2250   "class_check",
2251   "array_check",
2252   "intrinsic" JVMCI_ONLY("_or_type_checked_inlining"),
2253   "bimorphic" JVMCI_ONLY("_or_optimized_type_check"),
2254   "profile_predicate",
2255   "unloaded",
2256   "uninitialized",
2257   "unreached",
2258   "unhandled",
2259   "constraint",
2260   "div0_check",
2261   "age",
2262   "predicate",
2263   "loop_limit_check",
2264   "speculate_class_check",
2265   "speculate_null_check",
2266   "speculate_null_assert",
2267   "rtm_state_change",
2268   "unstable_if",
2269   "unstable_fused_if",
2270 #if INCLUDE_JVMCI
2271   "aliasing",
2272   "transfer_to_interpreter",
2273   "not_compiled_exception_handler",
2274   "unresolved",
2275   "jsr_mismatch",
2276 #endif
2277   "tenured"
2278 };
2279 const char* Deoptimization::_trap_action_name[] = {
2280   // Note:  Keep this in sync. with enum DeoptAction.
2281   "none",
2282   "maybe_recompile",
2283   "reinterpret",
2284   "make_not_entrant",
2285   "make_not_compilable"
2286 };
2287 
2288 const char* Deoptimization::trap_reason_name(int reason) {
2289   // Check that every reason has a name
2290   STATIC_ASSERT(sizeof(_trap_reason_name)/sizeof(const char*) == Reason_LIMIT);
2291 
2292   if (reason == Reason_many)  return "many";
2293   if ((uint)reason < Reason_LIMIT)
2294     return _trap_reason_name[reason];
2295   static char buf[20];
2296   sprintf(buf, "reason%d", reason);
2297   return buf;
2298 }
2299 const char* Deoptimization::trap_action_name(int action) {
2300   // Check that every action has a name
2301   STATIC_ASSERT(sizeof(_trap_action_name)/sizeof(const char*) == Action_LIMIT);
2302 
2303   if ((uint)action < Action_LIMIT)
2304     return _trap_action_name[action];
2305   static char buf[20];
2306   sprintf(buf, "action%d", action);
2307   return buf;
2308 }
2309 
2310 // This is used for debugging and diagnostics, including LogFile output.
2311 const char* Deoptimization::format_trap_request(char* buf, size_t buflen,
2312                                                 int trap_request) {
2313   jint unloaded_class_index = trap_request_index(trap_request);
2314   const char* reason = trap_reason_name(trap_request_reason(trap_request));
2315   const char* action = trap_action_name(trap_request_action(trap_request));
2316 #if INCLUDE_JVMCI
2317   int debug_id = trap_request_debug_id(trap_request);
2318 #endif
2319   size_t len;
2320   if (unloaded_class_index < 0) {
2321     len = jio_snprintf(buf, buflen, "reason='%s' action='%s'" JVMCI_ONLY(" debug_id='%d'"),
2322                        reason, action
2323 #if INCLUDE_JVMCI
2324                        ,debug_id
2325 #endif
2326                        );
2327   } else {
2328     len = jio_snprintf(buf, buflen, "reason='%s' action='%s' index='%d'" JVMCI_ONLY(" debug_id='%d'"),
2329                        reason, action, unloaded_class_index
2330 #if INCLUDE_JVMCI
2331                        ,debug_id
2332 #endif
2333                        );
2334   }
2335   return buf;
2336 }
2337 
2338 juint Deoptimization::_deoptimization_hist
2339         [Deoptimization::Reason_LIMIT]
2340     [1 + Deoptimization::Action_LIMIT]
2341         [Deoptimization::BC_CASE_LIMIT]
2342   = {0};
2343 
2344 enum {
2345   LSB_BITS = 8,
2346   LSB_MASK = right_n_bits(LSB_BITS)
2347 };
2348 
2349 void Deoptimization::gather_statistics(DeoptReason reason, DeoptAction action,
2350                                        Bytecodes::Code bc) {
2351   assert(reason >= 0 && reason < Reason_LIMIT, "oob");
2352   assert(action >= 0 && action < Action_LIMIT, "oob");
2353   _deoptimization_hist[Reason_none][0][0] += 1;  // total
2354   _deoptimization_hist[reason][0][0]      += 1;  // per-reason total
2355   juint* cases = _deoptimization_hist[reason][1+action];
2356   juint* bc_counter_addr = NULL;
2357   juint  bc_counter      = 0;
2358   // Look for an unused counter, or an exact match to this BC.
2359   if (bc != Bytecodes::_illegal) {
2360     for (int bc_case = 0; bc_case < BC_CASE_LIMIT; bc_case++) {
2361       juint* counter_addr = &cases[bc_case];
2362       juint  counter = *counter_addr;
2363       if ((counter == 0 && bc_counter_addr == NULL)
2364           || (Bytecodes::Code)(counter & LSB_MASK) == bc) {
2365         // this counter is either free or is already devoted to this BC
2366         bc_counter_addr = counter_addr;
2367         bc_counter = counter | bc;
2368       }
2369     }
2370   }
2371   if (bc_counter_addr == NULL) {
2372     // Overflow, or no given bytecode.
2373     bc_counter_addr = &cases[BC_CASE_LIMIT-1];
2374     bc_counter = (*bc_counter_addr & ~LSB_MASK);  // clear LSB
2375   }
2376   *bc_counter_addr = bc_counter + (1 << LSB_BITS);
2377 }
2378 
2379 jint Deoptimization::total_deoptimization_count() {
2380   return _deoptimization_hist[Reason_none][0][0];
2381 }
2382 
2383 jint Deoptimization::deoptimization_count(DeoptReason reason) {
2384   assert(reason >= 0 && reason < Reason_LIMIT, "oob");
2385   return _deoptimization_hist[reason][0][0];
2386 }
2387 
2388 void Deoptimization::print_statistics() {
2389   juint total = total_deoptimization_count();
2390   juint account = total;
2391   if (total != 0) {
2392     ttyLocker ttyl;
2393     if (xtty != NULL)  xtty->head("statistics type='deoptimization'");
2394     tty->print_cr("Deoptimization traps recorded:");
2395     #define PRINT_STAT_LINE(name, r) \
2396       tty->print_cr("  %4d (%4.1f%%) %s", (int)(r), ((r) * 100.0) / total, name);
2397     PRINT_STAT_LINE("total", total);
2398     // For each non-zero entry in the histogram, print the reason,
2399     // the action, and (if specifically known) the type of bytecode.
2400     for (int reason = 0; reason < Reason_LIMIT; reason++) {
2401       for (int action = 0; action < Action_LIMIT; action++) {
2402         juint* cases = _deoptimization_hist[reason][1+action];
2403         for (int bc_case = 0; bc_case < BC_CASE_LIMIT; bc_case++) {
2404           juint counter = cases[bc_case];
2405           if (counter != 0) {
2406             char name[1*K];
2407             Bytecodes::Code bc = (Bytecodes::Code)(counter & LSB_MASK);
2408             if (bc_case == BC_CASE_LIMIT && (int)bc == 0)
2409               bc = Bytecodes::_illegal;
2410             sprintf(name, "%s/%s/%s",
2411                     trap_reason_name(reason),
2412                     trap_action_name(action),
2413                     Bytecodes::is_defined(bc)? Bytecodes::name(bc): "other");
2414             juint r = counter >> LSB_BITS;
2415             tty->print_cr("  %40s: " UINT32_FORMAT " (%.1f%%)", name, r, (r * 100.0) / total);
2416             account -= r;
2417           }
2418         }
2419       }
2420     }
2421     if (account != 0) {
2422       PRINT_STAT_LINE("unaccounted", account);
2423     }
2424     #undef PRINT_STAT_LINE
2425     if (xtty != NULL)  xtty->tail("statistics");
2426   }
2427 }
2428 #else // COMPILER2_OR_JVMCI
2429 
2430 
2431 // Stubs for C1 only system.
2432 bool Deoptimization::trap_state_is_recompiled(int trap_state) {
2433   return false;
2434 }
2435 
2436 const char* Deoptimization::trap_reason_name(int reason) {
2437   return "unknown";
2438 }
2439 
2440 void Deoptimization::print_statistics() {
2441   // no output
2442 }
2443 
2444 void
2445 Deoptimization::update_method_data_from_interpreter(MethodData* trap_mdo, int trap_bci, int reason) {
2446   // no udpate
2447 }
2448 
2449 int Deoptimization::trap_state_has_reason(int trap_state, int reason) {
2450   return 0;
2451 }
2452 
2453 void Deoptimization::gather_statistics(DeoptReason reason, DeoptAction action,
2454                                        Bytecodes::Code bc) {
2455   // no update
2456 }
2457 
2458 const char* Deoptimization::format_trap_state(char* buf, size_t buflen,
2459                                               int trap_state) {
2460   jio_snprintf(buf, buflen, "#%d", trap_state);
2461   return buf;
2462 }
2463 
2464 #endif // COMPILER2_OR_JVMCI