1 /*
   2  * Copyright (c) 1997, 2019, 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 "asm/assembler.inline.hpp"
  28 #include "code/codeCache.hpp"
  29 #include "code/compiledIC.hpp"
  30 #include "code/compiledMethod.inline.hpp"
  31 #include "code/dependencies.hpp"
  32 #include "code/nativeInst.hpp"
  33 #include "code/nmethod.hpp"
  34 #include "code/scopeDesc.hpp"
  35 #include "compiler/abstractCompiler.hpp"
  36 #include "compiler/compileBroker.hpp"
  37 #include "compiler/compileLog.hpp"
  38 #include "compiler/compilerDirectives.hpp"
  39 #include "compiler/directivesParser.hpp"
  40 #include "compiler/disassembler.hpp"
  41 #include "interpreter/bytecode.hpp"
  42 #include "logging/log.hpp"
  43 #include "logging/logStream.hpp"
  44 #include "memory/allocation.inline.hpp"
  45 #include "memory/resourceArea.hpp"
  46 #include "memory/universe.hpp"
  47 #include "oops/access.inline.hpp"
  48 #include "oops/method.inline.hpp"
  49 #include "oops/methodData.hpp"
  50 #include "oops/oop.inline.hpp"
  51 #include "prims/jvmtiImpl.hpp"
  52 #include "runtime/atomic.hpp"
  53 #include "runtime/flags/flagSetting.hpp"
  54 #include "runtime/frame.inline.hpp"
  55 #include "runtime/handles.inline.hpp"
  56 #include "runtime/jniHandles.inline.hpp"
  57 #include "runtime/orderAccess.hpp"
  58 #include "runtime/os.hpp"
  59 #include "runtime/safepointVerifiers.hpp"
  60 #include "runtime/sharedRuntime.hpp"
  61 #include "runtime/sweeper.hpp"
  62 #include "runtime/vmThread.hpp"
  63 #include "utilities/align.hpp"
  64 #include "utilities/dtrace.hpp"
  65 #include "utilities/events.hpp"
  66 #include "utilities/resourceHash.hpp"
  67 #include "utilities/xmlstream.hpp"
  68 #if INCLUDE_JVMCI
  69 #include "jvmci/jvmciRuntime.hpp"
  70 #endif
  71 
  72 #ifdef DTRACE_ENABLED
  73 
  74 // Only bother with this argument setup if dtrace is available
  75 
  76 #define DTRACE_METHOD_UNLOAD_PROBE(method)                                \
  77   {                                                                       \
  78     Method* m = (method);                                                 \
  79     if (m != NULL) {                                                      \
  80       Symbol* klass_name = m->klass_name();                               \
  81       Symbol* name = m->name();                                           \
  82       Symbol* signature = m->signature();                                 \
  83       HOTSPOT_COMPILED_METHOD_UNLOAD(                                     \
  84         (char *) klass_name->bytes(), klass_name->utf8_length(),                   \
  85         (char *) name->bytes(), name->utf8_length(),                               \
  86         (char *) signature->bytes(), signature->utf8_length());                    \
  87     }                                                                     \
  88   }
  89 
  90 #else //  ndef DTRACE_ENABLED
  91 
  92 #define DTRACE_METHOD_UNLOAD_PROBE(method)
  93 
  94 #endif
  95 
  96 //---------------------------------------------------------------------------------
  97 // NMethod statistics
  98 // They are printed under various flags, including:
  99 //   PrintC1Statistics, PrintOptoStatistics, LogVMOutput, and LogCompilation.
 100 // (In the latter two cases, they like other stats are printed to the log only.)
 101 
 102 #ifndef PRODUCT
 103 // These variables are put into one block to reduce relocations
 104 // and make it simpler to print from the debugger.
 105 struct java_nmethod_stats_struct {
 106   int nmethod_count;
 107   int total_size;
 108   int relocation_size;
 109   int consts_size;
 110   int insts_size;
 111   int stub_size;
 112   int scopes_data_size;
 113   int scopes_pcs_size;
 114   int dependencies_size;
 115   int handler_table_size;
 116   int nul_chk_table_size;
 117 #if INCLUDE_JVMCI
 118   int speculations_size;
 119   int jvmci_data_size;
 120 #endif
 121   int oops_size;
 122   int metadata_size;
 123 
 124   void note_nmethod(nmethod* nm) {
 125     nmethod_count += 1;
 126     total_size          += nm->size();
 127     relocation_size     += nm->relocation_size();
 128     consts_size         += nm->consts_size();
 129     insts_size          += nm->insts_size();
 130     stub_size           += nm->stub_size();
 131     oops_size           += nm->oops_size();
 132     metadata_size       += nm->metadata_size();
 133     scopes_data_size    += nm->scopes_data_size();
 134     scopes_pcs_size     += nm->scopes_pcs_size();
 135     dependencies_size   += nm->dependencies_size();
 136     handler_table_size  += nm->handler_table_size();
 137     nul_chk_table_size  += nm->nul_chk_table_size();
 138 #if INCLUDE_JVMCI
 139     speculations_size   += nm->speculations_size();
 140     jvmci_data_size     += nm->jvmci_data_size();
 141 #endif
 142   }
 143   void print_nmethod_stats(const char* name) {
 144     if (nmethod_count == 0)  return;
 145     tty->print_cr("Statistics for %d bytecoded nmethods for %s:", nmethod_count, name);
 146     if (total_size != 0)          tty->print_cr(" total in heap  = %d", total_size);
 147     if (nmethod_count != 0)       tty->print_cr(" header         = " SIZE_FORMAT, nmethod_count * sizeof(nmethod));
 148     if (relocation_size != 0)     tty->print_cr(" relocation     = %d", relocation_size);
 149     if (consts_size != 0)         tty->print_cr(" constants      = %d", consts_size);
 150     if (insts_size != 0)          tty->print_cr(" main code      = %d", insts_size);
 151     if (stub_size != 0)           tty->print_cr(" stub code      = %d", stub_size);
 152     if (oops_size != 0)           tty->print_cr(" oops           = %d", oops_size);
 153     if (metadata_size != 0)       tty->print_cr(" metadata       = %d", metadata_size);
 154     if (scopes_data_size != 0)    tty->print_cr(" scopes data    = %d", scopes_data_size);
 155     if (scopes_pcs_size != 0)     tty->print_cr(" scopes pcs     = %d", scopes_pcs_size);
 156     if (dependencies_size != 0)   tty->print_cr(" dependencies   = %d", dependencies_size);
 157     if (handler_table_size != 0)  tty->print_cr(" handler table  = %d", handler_table_size);
 158     if (nul_chk_table_size != 0)  tty->print_cr(" nul chk table  = %d", nul_chk_table_size);
 159 #if INCLUDE_JVMCI
 160     if (speculations_size != 0)   tty->print_cr(" speculations   = %d", speculations_size);
 161     if (jvmci_data_size != 0)     tty->print_cr(" JVMCI data     = %d", jvmci_data_size);
 162 #endif
 163   }
 164 };
 165 
 166 struct native_nmethod_stats_struct {
 167   int native_nmethod_count;
 168   int native_total_size;
 169   int native_relocation_size;
 170   int native_insts_size;
 171   int native_oops_size;
 172   int native_metadata_size;
 173   void note_native_nmethod(nmethod* nm) {
 174     native_nmethod_count += 1;
 175     native_total_size       += nm->size();
 176     native_relocation_size  += nm->relocation_size();
 177     native_insts_size       += nm->insts_size();
 178     native_oops_size        += nm->oops_size();
 179     native_metadata_size    += nm->metadata_size();
 180   }
 181   void print_native_nmethod_stats() {
 182     if (native_nmethod_count == 0)  return;
 183     tty->print_cr("Statistics for %d native nmethods:", native_nmethod_count);
 184     if (native_total_size != 0)       tty->print_cr(" N. total size  = %d", native_total_size);
 185     if (native_relocation_size != 0)  tty->print_cr(" N. relocation  = %d", native_relocation_size);
 186     if (native_insts_size != 0)       tty->print_cr(" N. main code   = %d", native_insts_size);
 187     if (native_oops_size != 0)        tty->print_cr(" N. oops        = %d", native_oops_size);
 188     if (native_metadata_size != 0)    tty->print_cr(" N. metadata    = %d", native_metadata_size);
 189   }
 190 };
 191 
 192 struct pc_nmethod_stats_struct {
 193   int pc_desc_resets;   // number of resets (= number of caches)
 194   int pc_desc_queries;  // queries to nmethod::find_pc_desc
 195   int pc_desc_approx;   // number of those which have approximate true
 196   int pc_desc_repeats;  // number of _pc_descs[0] hits
 197   int pc_desc_hits;     // number of LRU cache hits
 198   int pc_desc_tests;    // total number of PcDesc examinations
 199   int pc_desc_searches; // total number of quasi-binary search steps
 200   int pc_desc_adds;     // number of LUR cache insertions
 201 
 202   void print_pc_stats() {
 203     tty->print_cr("PcDesc Statistics:  %d queries, %.2f comparisons per query",
 204                   pc_desc_queries,
 205                   (double)(pc_desc_tests + pc_desc_searches)
 206                   / pc_desc_queries);
 207     tty->print_cr("  caches=%d queries=%d/%d, hits=%d+%d, tests=%d+%d, adds=%d",
 208                   pc_desc_resets,
 209                   pc_desc_queries, pc_desc_approx,
 210                   pc_desc_repeats, pc_desc_hits,
 211                   pc_desc_tests, pc_desc_searches, pc_desc_adds);
 212   }
 213 };
 214 
 215 #ifdef COMPILER1
 216 static java_nmethod_stats_struct c1_java_nmethod_stats;
 217 #endif
 218 #ifdef COMPILER2
 219 static java_nmethod_stats_struct c2_java_nmethod_stats;
 220 #endif
 221 #if INCLUDE_JVMCI
 222 static java_nmethod_stats_struct jvmci_java_nmethod_stats;
 223 #endif
 224 static java_nmethod_stats_struct unknown_java_nmethod_stats;
 225 
 226 static native_nmethod_stats_struct native_nmethod_stats;
 227 static pc_nmethod_stats_struct pc_nmethod_stats;
 228 
 229 static void note_java_nmethod(nmethod* nm) {
 230 #ifdef COMPILER1
 231   if (nm->is_compiled_by_c1()) {
 232     c1_java_nmethod_stats.note_nmethod(nm);
 233   } else
 234 #endif
 235 #ifdef COMPILER2
 236   if (nm->is_compiled_by_c2()) {
 237     c2_java_nmethod_stats.note_nmethod(nm);
 238   } else
 239 #endif
 240 #if INCLUDE_JVMCI
 241   if (nm->is_compiled_by_jvmci()) {
 242     jvmci_java_nmethod_stats.note_nmethod(nm);
 243   } else
 244 #endif
 245   {
 246     unknown_java_nmethod_stats.note_nmethod(nm);
 247   }
 248 }
 249 #endif // !PRODUCT
 250 
 251 //---------------------------------------------------------------------------------
 252 
 253 
 254 ExceptionCache::ExceptionCache(Handle exception, address pc, address handler) {
 255   assert(pc != NULL, "Must be non null");
 256   assert(exception.not_null(), "Must be non null");
 257   assert(handler != NULL, "Must be non null");
 258 
 259   _count = 0;
 260   _exception_type = exception->klass();
 261   _next = NULL;
 262   _purge_list_next = NULL;
 263 
 264   add_address_and_handler(pc,handler);
 265 }
 266 
 267 
 268 address ExceptionCache::match(Handle exception, address pc) {
 269   assert(pc != NULL,"Must be non null");
 270   assert(exception.not_null(),"Must be non null");
 271   if (exception->klass() == exception_type()) {
 272     return (test_address(pc));
 273   }
 274 
 275   return NULL;
 276 }
 277 
 278 
 279 bool ExceptionCache::match_exception_with_space(Handle exception) {
 280   assert(exception.not_null(),"Must be non null");
 281   if (exception->klass() == exception_type() && count() < cache_size) {
 282     return true;
 283   }
 284   return false;
 285 }
 286 
 287 
 288 address ExceptionCache::test_address(address addr) {
 289   int limit = count();
 290   for (int i = 0; i < limit; i++) {
 291     if (pc_at(i) == addr) {
 292       return handler_at(i);
 293     }
 294   }
 295   return NULL;
 296 }
 297 
 298 
 299 bool ExceptionCache::add_address_and_handler(address addr, address handler) {
 300   if (test_address(addr) == handler) return true;
 301 
 302   int index = count();
 303   if (index < cache_size) {
 304     set_pc_at(index, addr);
 305     set_handler_at(index, handler);
 306     increment_count();
 307     return true;
 308   }
 309   return false;
 310 }
 311 
 312 ExceptionCache* ExceptionCache::next() {
 313   return Atomic::load(&_next);
 314 }
 315 
 316 void ExceptionCache::set_next(ExceptionCache *ec) {
 317   Atomic::store(ec, &_next);
 318 }
 319 
 320 //-----------------------------------------------------------------------------
 321 
 322 
 323 // Helper used by both find_pc_desc methods.
 324 static inline bool match_desc(PcDesc* pc, int pc_offset, bool approximate) {
 325   NOT_PRODUCT(++pc_nmethod_stats.pc_desc_tests);
 326   if (!approximate)
 327     return pc->pc_offset() == pc_offset;
 328   else
 329     return (pc-1)->pc_offset() < pc_offset && pc_offset <= pc->pc_offset();
 330 }
 331 
 332 void PcDescCache::reset_to(PcDesc* initial_pc_desc) {
 333   if (initial_pc_desc == NULL) {
 334     _pc_descs[0] = NULL; // native method; no PcDescs at all
 335     return;
 336   }
 337   NOT_PRODUCT(++pc_nmethod_stats.pc_desc_resets);
 338   // reset the cache by filling it with benign (non-null) values
 339   assert(initial_pc_desc->pc_offset() < 0, "must be sentinel");
 340   for (int i = 0; i < cache_size; i++)
 341     _pc_descs[i] = initial_pc_desc;
 342 }
 343 
 344 PcDesc* PcDescCache::find_pc_desc(int pc_offset, bool approximate) {
 345   NOT_PRODUCT(++pc_nmethod_stats.pc_desc_queries);
 346   NOT_PRODUCT(if (approximate) ++pc_nmethod_stats.pc_desc_approx);
 347 
 348   // Note: one might think that caching the most recently
 349   // read value separately would be a win, but one would be
 350   // wrong.  When many threads are updating it, the cache
 351   // line it's in would bounce between caches, negating
 352   // any benefit.
 353 
 354   // In order to prevent race conditions do not load cache elements
 355   // repeatedly, but use a local copy:
 356   PcDesc* res;
 357 
 358   // Step one:  Check the most recently added value.
 359   res = _pc_descs[0];
 360   if (res == NULL) return NULL;  // native method; no PcDescs at all
 361   if (match_desc(res, pc_offset, approximate)) {
 362     NOT_PRODUCT(++pc_nmethod_stats.pc_desc_repeats);
 363     return res;
 364   }
 365 
 366   // Step two:  Check the rest of the LRU cache.
 367   for (int i = 1; i < cache_size; ++i) {
 368     res = _pc_descs[i];
 369     if (res->pc_offset() < 0) break;  // optimization: skip empty cache
 370     if (match_desc(res, pc_offset, approximate)) {
 371       NOT_PRODUCT(++pc_nmethod_stats.pc_desc_hits);
 372       return res;
 373     }
 374   }
 375 
 376   // Report failure.
 377   return NULL;
 378 }
 379 
 380 void PcDescCache::add_pc_desc(PcDesc* pc_desc) {
 381   NOT_PRODUCT(++pc_nmethod_stats.pc_desc_adds);
 382   // Update the LRU cache by shifting pc_desc forward.
 383   for (int i = 0; i < cache_size; i++)  {
 384     PcDesc* next = _pc_descs[i];
 385     _pc_descs[i] = pc_desc;
 386     pc_desc = next;
 387   }
 388 }
 389 
 390 // adjust pcs_size so that it is a multiple of both oopSize and
 391 // sizeof(PcDesc) (assumes that if sizeof(PcDesc) is not a multiple
 392 // of oopSize, then 2*sizeof(PcDesc) is)
 393 static int adjust_pcs_size(int pcs_size) {
 394   int nsize = align_up(pcs_size,   oopSize);
 395   if ((nsize % sizeof(PcDesc)) != 0) {
 396     nsize = pcs_size + sizeof(PcDesc);
 397   }
 398   assert((nsize % oopSize) == 0, "correct alignment");
 399   return nsize;
 400 }
 401 
 402 
 403 int nmethod::total_size() const {
 404   return
 405     consts_size()        +
 406     insts_size()         +
 407     stub_size()          +
 408     scopes_data_size()   +
 409     scopes_pcs_size()    +
 410     handler_table_size() +
 411     nul_chk_table_size();
 412 }
 413 
 414 address* nmethod::orig_pc_addr(const frame* fr) {
 415   return (address*) ((address)fr->unextended_sp() + _orig_pc_offset);
 416 }
 417 
 418 const char* nmethod::compile_kind() const {
 419   if (is_osr_method())     return "osr";
 420   if (method() != NULL && is_native_method())  return "c2n";
 421   return NULL;
 422 }
 423 
 424 // Fill in default values for various flag fields
 425 void nmethod::init_defaults() {
 426   _state                      = not_installed;
 427   _has_flushed_dependencies   = 0;
 428   _lock_count                 = 0;
 429   _stack_traversal_mark       = 0;
 430   _unload_reported            = false; // jvmti state
 431   _is_far_code                = false; // nmethods are located in CodeCache
 432 
 433 #ifdef ASSERT
 434   _oops_are_stale             = false;
 435 #endif
 436 
 437   _oops_do_mark_link       = NULL;
 438   _jmethod_id              = NULL;
 439   _osr_link                = NULL;
 440 #if INCLUDE_RTM_OPT
 441   _rtm_state               = NoRTM;
 442 #endif
 443 }
 444 
 445 nmethod* nmethod::new_native_nmethod(const methodHandle& method,
 446   int compile_id,
 447   CodeBuffer *code_buffer,
 448   int vep_offset,
 449   int frame_complete,
 450   int frame_size,
 451   ByteSize basic_lock_owner_sp_offset,
 452   ByteSize basic_lock_sp_offset,
 453   OopMapSet* oop_maps) {
 454   code_buffer->finalize_oop_references(method);
 455   // create nmethod
 456   nmethod* nm = NULL;
 457   {
 458     MutexLocker mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);
 459     int native_nmethod_size = CodeBlob::allocation_size(code_buffer, sizeof(nmethod));
 460 
 461     CodeOffsets offsets;
 462     offsets.set_value(CodeOffsets::Verified_Entry, vep_offset);
 463     offsets.set_value(CodeOffsets::Frame_Complete, frame_complete);
 464     nm = new (native_nmethod_size, CompLevel_none)
 465     nmethod(method(), compiler_none, native_nmethod_size,
 466             compile_id, &offsets,
 467             code_buffer, frame_size,
 468             basic_lock_owner_sp_offset,
 469             basic_lock_sp_offset,
 470             oop_maps);
 471     NOT_PRODUCT(if (nm != NULL)  native_nmethod_stats.note_native_nmethod(nm));
 472   }
 473 
 474   if (nm != NULL) {
 475     // verify nmethod
 476     debug_only(nm->verify();) // might block
 477 
 478     nm->log_new_nmethod();
 479     nm->make_in_use();
 480   }
 481   return nm;
 482 }
 483 
 484 nmethod* nmethod::new_nmethod(const methodHandle& method,
 485   int compile_id,
 486   int entry_bci,
 487   CodeOffsets* offsets,
 488   int orig_pc_offset,
 489   DebugInformationRecorder* debug_info,
 490   Dependencies* dependencies,
 491   CodeBuffer* code_buffer, int frame_size,
 492   OopMapSet* oop_maps,
 493   ExceptionHandlerTable* handler_table,
 494   ImplicitExceptionTable* nul_chk_table,
 495   AbstractCompiler* compiler,
 496   int comp_level
 497 #if INCLUDE_JVMCI
 498   , char* speculations,
 499   int speculations_len,
 500   int nmethod_mirror_index,
 501   const char* nmethod_mirror_name,
 502   FailedSpeculation** failed_speculations
 503 #endif
 504 )
 505 {
 506   assert(debug_info->oop_recorder() == code_buffer->oop_recorder(), "shared OR");
 507   code_buffer->finalize_oop_references(method);
 508   // create nmethod
 509   nmethod* nm = NULL;
 510   { MutexLocker mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);
 511 #if INCLUDE_JVMCI
 512     int jvmci_data_size = !compiler->is_jvmci() ? 0 : JVMCINMethodData::compute_size(nmethod_mirror_name);
 513 #endif
 514     int nmethod_size =
 515       CodeBlob::allocation_size(code_buffer, sizeof(nmethod))
 516       + adjust_pcs_size(debug_info->pcs_size())
 517       + align_up((int)dependencies->size_in_bytes(), oopSize)
 518       + align_up(handler_table->size_in_bytes()    , oopSize)
 519       + align_up(nul_chk_table->size_in_bytes()    , oopSize)
 520 #if INCLUDE_JVMCI
 521       + align_up(speculations_len                  , oopSize)
 522       + align_up(jvmci_data_size                   , oopSize)
 523 #endif
 524       + align_up(debug_info->data_size()           , oopSize);
 525 
 526     nm = new (nmethod_size, comp_level)
 527     nmethod(method(), compiler->type(), nmethod_size, compile_id, entry_bci, offsets,
 528             orig_pc_offset, debug_info, dependencies, code_buffer, frame_size,
 529             oop_maps,
 530             handler_table,
 531             nul_chk_table,
 532             compiler,
 533             comp_level
 534 #if INCLUDE_JVMCI
 535             , speculations,
 536             speculations_len,
 537             jvmci_data_size
 538 #endif
 539             );
 540 
 541     if (nm != NULL) {
 542 #if INCLUDE_JVMCI
 543       if (compiler->is_jvmci()) {
 544         // Initialize the JVMCINMethodData object inlined into nm
 545         nm->jvmci_nmethod_data()->initialize(nmethod_mirror_index, nmethod_mirror_name, failed_speculations);
 546       }
 547 #endif
 548       // To make dependency checking during class loading fast, record
 549       // the nmethod dependencies in the classes it is dependent on.
 550       // This allows the dependency checking code to simply walk the
 551       // class hierarchy above the loaded class, checking only nmethods
 552       // which are dependent on those classes.  The slow way is to
 553       // check every nmethod for dependencies which makes it linear in
 554       // the number of methods compiled.  For applications with a lot
 555       // classes the slow way is too slow.
 556       for (Dependencies::DepStream deps(nm); deps.next(); ) {
 557         if (deps.type() == Dependencies::call_site_target_value) {
 558           // CallSite dependencies are managed on per-CallSite instance basis.
 559           oop call_site = deps.argument_oop(0);
 560           MethodHandles::add_dependent_nmethod(call_site, nm);
 561         } else {
 562           Klass* klass = deps.context_type();
 563           if (klass == NULL) {
 564             continue;  // ignore things like evol_method
 565           }
 566           // record this nmethod as dependent on this klass
 567           InstanceKlass::cast(klass)->add_dependent_nmethod(nm);
 568         }
 569       }
 570       NOT_PRODUCT(if (nm != NULL)  note_java_nmethod(nm));
 571     }
 572   }
 573   // Do verification and logging outside CodeCache_lock.
 574   if (nm != NULL) {
 575     // Safepoints in nmethod::verify aren't allowed because nm hasn't been installed yet.
 576     DEBUG_ONLY(nm->verify();)
 577     nm->log_new_nmethod();
 578   }
 579   return nm;
 580 }
 581 
 582 // For native wrappers
 583 nmethod::nmethod(
 584   Method* method,
 585   CompilerType type,
 586   int nmethod_size,
 587   int compile_id,
 588   CodeOffsets* offsets,
 589   CodeBuffer* code_buffer,
 590   int frame_size,
 591   ByteSize basic_lock_owner_sp_offset,
 592   ByteSize basic_lock_sp_offset,
 593   OopMapSet* oop_maps )
 594   : CompiledMethod(method, "native nmethod", type, nmethod_size, sizeof(nmethod), code_buffer, offsets->value(CodeOffsets::Frame_Complete), frame_size, oop_maps, false),
 595   _is_unloading_state(0),
 596   _native_receiver_sp_offset(basic_lock_owner_sp_offset),
 597   _native_basic_lock_sp_offset(basic_lock_sp_offset)
 598 {
 599   {
 600     int scopes_data_offset   = 0;
 601     int deoptimize_offset    = 0;
 602     int deoptimize_mh_offset = 0;
 603 
 604     debug_only(NoSafepointVerifier nsv;)
 605     assert_locked_or_safepoint(CodeCache_lock);
 606 
 607     init_defaults();
 608     _entry_bci               = InvocationEntryBci;
 609     // We have no exception handler or deopt handler make the
 610     // values something that will never match a pc like the nmethod vtable entry
 611     _exception_offset        = 0;
 612     _orig_pc_offset          = 0;
 613 
 614     _consts_offset           = data_offset();
 615     _stub_offset             = data_offset();
 616     _oops_offset             = data_offset();
 617     _metadata_offset         = _oops_offset         + align_up(code_buffer->total_oop_size(), oopSize);
 618     scopes_data_offset       = _metadata_offset     + align_up(code_buffer->total_metadata_size(), wordSize);
 619     _scopes_pcs_offset       = scopes_data_offset;
 620     _dependencies_offset     = _scopes_pcs_offset;
 621     _handler_table_offset    = _dependencies_offset;
 622     _nul_chk_table_offset    = _handler_table_offset;
 623 #if INCLUDE_JVMCI
 624     _speculations_offset     = _nul_chk_table_offset;
 625     _jvmci_data_offset       = _speculations_offset;
 626     _nmethod_end_offset      = _jvmci_data_offset;
 627 #else
 628     _nmethod_end_offset      = _nul_chk_table_offset;
 629 #endif
 630     _compile_id              = compile_id;
 631     _comp_level              = CompLevel_none;
 632     _entry_point             = code_begin()          + offsets->value(CodeOffsets::Entry);
 633     _verified_entry_point    = code_begin()          + offsets->value(CodeOffsets::Verified_Entry);
 634     _osr_entry_point         = NULL;
 635     _exception_cache         = NULL;
 636     _pc_desc_container.reset_to(NULL);
 637     _hotness_counter         = NMethodSweeper::hotness_counter_reset_val();
 638 
 639     _scopes_data_begin = (address) this + scopes_data_offset;
 640     _deopt_handler_begin = (address) this + deoptimize_offset;
 641     _deopt_mh_handler_begin = (address) this + deoptimize_mh_offset;
 642 
 643     code_buffer->copy_code_and_locs_to(this);
 644     code_buffer->copy_values_to(this);
 645 
 646     clear_unloading_state();
 647 
 648     Universe::heap()->register_nmethod(this);
 649     debug_only(Universe::heap()->verify_nmethod(this));
 650 
 651     CodeCache::commit(this);
 652   }
 653 
 654   if (PrintNativeNMethods || PrintDebugInfo || PrintRelocations || PrintDependencies) {
 655     ttyLocker ttyl;  // keep the following output all in one block
 656     // This output goes directly to the tty, not the compiler log.
 657     // To enable tools to match it up with the compilation activity,
 658     // be sure to tag this tty output with the compile ID.
 659     if (xtty != NULL) {
 660       xtty->begin_head("print_native_nmethod");
 661       xtty->method(_method);
 662       xtty->stamp();
 663       xtty->end_head(" address='" INTPTR_FORMAT "'", (intptr_t) this);
 664     }
 665     // Print the header part, then print the requested information.
 666     // This is both handled in decode2(), called via print_code() -> decode()
 667     if (PrintNativeNMethods) {
 668       tty->print_cr("-------------------------- Assembly (native nmethod) ---------------------------");
 669       print_code();
 670       tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
 671 #if defined(SUPPORT_DATA_STRUCTS)
 672       if (AbstractDisassembler::show_structs()) {
 673         if (oop_maps != NULL) {
 674           tty->print("oop maps:"); // oop_maps->print_on(tty) outputs a cr() at the beginning
 675           oop_maps->print_on(tty);
 676           tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
 677         }
 678       }
 679 #endif
 680     } else {
 681       print(); // print the header part only.
 682     }
 683 #if defined(SUPPORT_DATA_STRUCTS)
 684     if (AbstractDisassembler::show_structs()) {
 685       if (PrintRelocations) {
 686         print_relocations();
 687         tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
 688       }
 689     }
 690 #endif
 691     if (xtty != NULL) {
 692       xtty->tail("print_native_nmethod");
 693     }
 694   }
 695 }
 696 
 697 void* nmethod::operator new(size_t size, int nmethod_size, int comp_level) throw () {
 698   return CodeCache::allocate(nmethod_size, CodeCache::get_code_blob_type(comp_level));
 699 }
 700 
 701 nmethod::nmethod(
 702   Method* method,
 703   CompilerType type,
 704   int nmethod_size,
 705   int compile_id,
 706   int entry_bci,
 707   CodeOffsets* offsets,
 708   int orig_pc_offset,
 709   DebugInformationRecorder* debug_info,
 710   Dependencies* dependencies,
 711   CodeBuffer *code_buffer,
 712   int frame_size,
 713   OopMapSet* oop_maps,
 714   ExceptionHandlerTable* handler_table,
 715   ImplicitExceptionTable* nul_chk_table,
 716   AbstractCompiler* compiler,
 717   int comp_level
 718 #if INCLUDE_JVMCI
 719   , char* speculations,
 720   int speculations_len,
 721   int jvmci_data_size
 722 #endif
 723   )
 724   : CompiledMethod(method, "nmethod", type, nmethod_size, sizeof(nmethod), code_buffer, offsets->value(CodeOffsets::Frame_Complete), frame_size, oop_maps, false),
 725   _is_unloading_state(0),
 726   _native_receiver_sp_offset(in_ByteSize(-1)),
 727   _native_basic_lock_sp_offset(in_ByteSize(-1))
 728 {
 729   assert(debug_info->oop_recorder() == code_buffer->oop_recorder(), "shared OR");
 730   {
 731     debug_only(NoSafepointVerifier nsv;)
 732     assert_locked_or_safepoint(CodeCache_lock);
 733 
 734     _deopt_handler_begin = (address) this;
 735     _deopt_mh_handler_begin = (address) this;
 736 
 737     init_defaults();
 738     _entry_bci               = entry_bci;
 739     _compile_id              = compile_id;
 740     _comp_level              = comp_level;
 741     _orig_pc_offset          = orig_pc_offset;
 742     _hotness_counter         = NMethodSweeper::hotness_counter_reset_val();
 743 
 744     // Section offsets
 745     _consts_offset           = content_offset()      + code_buffer->total_offset_of(code_buffer->consts());
 746     _stub_offset             = content_offset()      + code_buffer->total_offset_of(code_buffer->stubs());
 747     set_ctable_begin(header_begin() + _consts_offset);
 748 
 749 #if INCLUDE_JVMCI
 750     if (compiler->is_jvmci()) {
 751       // JVMCI might not produce any stub sections
 752       if (offsets->value(CodeOffsets::Exceptions) != -1) {
 753         _exception_offset        = code_offset()          + offsets->value(CodeOffsets::Exceptions);
 754       } else {
 755         _exception_offset = -1;
 756       }
 757       if (offsets->value(CodeOffsets::Deopt) != -1) {
 758         _deopt_handler_begin       = (address) this + code_offset()          + offsets->value(CodeOffsets::Deopt);
 759       } else {
 760         _deopt_handler_begin = NULL;
 761       }
 762       if (offsets->value(CodeOffsets::DeoptMH) != -1) {
 763         _deopt_mh_handler_begin  = (address) this + code_offset()          + offsets->value(CodeOffsets::DeoptMH);
 764       } else {
 765         _deopt_mh_handler_begin = NULL;
 766       }
 767     } else
 768 #endif
 769     {
 770       // Exception handler and deopt handler are in the stub section
 771       assert(offsets->value(CodeOffsets::Exceptions) != -1, "must be set");
 772       assert(offsets->value(CodeOffsets::Deopt     ) != -1, "must be set");
 773 
 774       _exception_offset       = _stub_offset          + offsets->value(CodeOffsets::Exceptions);
 775       _deopt_handler_begin    = (address) this + _stub_offset          + offsets->value(CodeOffsets::Deopt);
 776       if (offsets->value(CodeOffsets::DeoptMH) != -1) {
 777         _deopt_mh_handler_begin  = (address) this + _stub_offset          + offsets->value(CodeOffsets::DeoptMH);
 778       } else {
 779         _deopt_mh_handler_begin  = NULL;
 780       }
 781     }
 782     if (offsets->value(CodeOffsets::UnwindHandler) != -1) {
 783       _unwind_handler_offset = code_offset()         + offsets->value(CodeOffsets::UnwindHandler);
 784     } else {
 785       _unwind_handler_offset = -1;
 786     }
 787 
 788     _oops_offset             = data_offset();
 789     _metadata_offset         = _oops_offset          + align_up(code_buffer->total_oop_size(), oopSize);
 790     int scopes_data_offset   = _metadata_offset      + align_up(code_buffer->total_metadata_size(), wordSize);
 791 
 792     _scopes_pcs_offset       = scopes_data_offset    + align_up(debug_info->data_size       (), oopSize);
 793     _dependencies_offset     = _scopes_pcs_offset    + adjust_pcs_size(debug_info->pcs_size());
 794     _handler_table_offset    = _dependencies_offset  + align_up((int)dependencies->size_in_bytes (), oopSize);
 795     _nul_chk_table_offset    = _handler_table_offset + align_up(handler_table->size_in_bytes(), oopSize);
 796 #if INCLUDE_JVMCI
 797     _speculations_offset     = _nul_chk_table_offset + align_up(nul_chk_table->size_in_bytes(), oopSize);
 798     _jvmci_data_offset       = _speculations_offset  + align_up(speculations_len, oopSize);
 799     _nmethod_end_offset      = _jvmci_data_offset    + align_up(jvmci_data_size, oopSize);
 800 #else
 801     _nmethod_end_offset      = _nul_chk_table_offset + align_up(nul_chk_table->size_in_bytes(), oopSize);
 802 #endif
 803     _entry_point             = code_begin()          + offsets->value(CodeOffsets::Entry);
 804     _verified_entry_point    = code_begin()          + offsets->value(CodeOffsets::Verified_Entry);
 805     _osr_entry_point         = code_begin()          + offsets->value(CodeOffsets::OSR_Entry);
 806     _exception_cache         = NULL;
 807     _scopes_data_begin       = (address) this + scopes_data_offset;
 808 
 809     _pc_desc_container.reset_to(scopes_pcs_begin());
 810 
 811     code_buffer->copy_code_and_locs_to(this);
 812     // Copy contents of ScopeDescRecorder to nmethod
 813     code_buffer->copy_values_to(this);
 814     debug_info->copy_to(this);
 815     dependencies->copy_to(this);
 816     clear_unloading_state();
 817 
 818     Universe::heap()->register_nmethod(this);
 819     debug_only(Universe::heap()->verify_nmethod(this));
 820 
 821     CodeCache::commit(this);
 822 
 823     // Copy contents of ExceptionHandlerTable to nmethod
 824     handler_table->copy_to(this);
 825     nul_chk_table->copy_to(this);
 826 
 827 #if INCLUDE_JVMCI
 828     // Copy speculations to nmethod
 829     if (speculations_size() != 0) {
 830       memcpy(speculations_begin(), speculations, speculations_len);
 831     }
 832 #endif
 833 
 834     // we use the information of entry points to find out if a method is
 835     // static or non static
 836     assert(compiler->is_c2() || compiler->is_jvmci() ||
 837            _method->is_static() == (entry_point() == _verified_entry_point),
 838            " entry points must be same for static methods and vice versa");
 839   }
 840 }
 841 
 842 // Print a short set of xml attributes to identify this nmethod.  The
 843 // output should be embedded in some other element.
 844 void nmethod::log_identity(xmlStream* log) const {
 845   log->print(" compile_id='%d'", compile_id());
 846   const char* nm_kind = compile_kind();
 847   if (nm_kind != NULL)  log->print(" compile_kind='%s'", nm_kind);
 848   log->print(" compiler='%s'", compiler_name());
 849   if (TieredCompilation) {
 850     log->print(" level='%d'", comp_level());
 851   }
 852 #if INCLUDE_JVMCI
 853   if (jvmci_nmethod_data() != NULL) {
 854     const char* jvmci_name = jvmci_nmethod_data()->name();
 855     if (jvmci_name != NULL) {
 856       log->print(" jvmci_mirror_name='");
 857       log->text("%s", jvmci_name);
 858       log->print("'");
 859     }
 860   }
 861 #endif
 862 }
 863 
 864 
 865 #define LOG_OFFSET(log, name)                    \
 866   if (p2i(name##_end()) - p2i(name##_begin())) \
 867     log->print(" " XSTR(name) "_offset='" INTX_FORMAT "'"    , \
 868                p2i(name##_begin()) - p2i(this))
 869 
 870 
 871 void nmethod::log_new_nmethod() const {
 872   if (LogCompilation && xtty != NULL) {
 873     ttyLocker ttyl;
 874     HandleMark hm;
 875     xtty->begin_elem("nmethod");
 876     log_identity(xtty);
 877     xtty->print(" entry='" INTPTR_FORMAT "' size='%d'", p2i(code_begin()), size());
 878     xtty->print(" address='" INTPTR_FORMAT "'", p2i(this));
 879 
 880     LOG_OFFSET(xtty, relocation);
 881     LOG_OFFSET(xtty, consts);
 882     LOG_OFFSET(xtty, insts);
 883     LOG_OFFSET(xtty, stub);
 884     LOG_OFFSET(xtty, scopes_data);
 885     LOG_OFFSET(xtty, scopes_pcs);
 886     LOG_OFFSET(xtty, dependencies);
 887     LOG_OFFSET(xtty, handler_table);
 888     LOG_OFFSET(xtty, nul_chk_table);
 889     LOG_OFFSET(xtty, oops);
 890     LOG_OFFSET(xtty, metadata);
 891 
 892     xtty->method(method());
 893     xtty->stamp();
 894     xtty->end_elem();
 895   }
 896 }
 897 
 898 #undef LOG_OFFSET
 899 
 900 
 901 // Print out more verbose output usually for a newly created nmethod.
 902 void nmethod::print_on(outputStream* st, const char* msg) const {
 903   if (st != NULL) {
 904     ttyLocker ttyl;
 905     if (WizardMode) {
 906       CompileTask::print(st, this, msg, /*short_form:*/ true);
 907       st->print_cr(" (" INTPTR_FORMAT ")", p2i(this));
 908     } else {
 909       CompileTask::print(st, this, msg, /*short_form:*/ false);
 910     }
 911   }
 912 }
 913 
 914 void nmethod::maybe_print_nmethod(DirectiveSet* directive) {
 915   bool printnmethods = directive->PrintAssemblyOption || directive->PrintNMethodsOption;
 916   if (printnmethods || PrintDebugInfo || PrintRelocations || PrintDependencies || PrintExceptionHandlers) {
 917     print_nmethod(printnmethods);
 918   }
 919 }
 920 
 921 void nmethod::print_nmethod(bool printmethod) {
 922   ttyLocker ttyl;  // keep the following output all in one block
 923   if (xtty != NULL) {
 924     xtty->begin_head("print_nmethod");
 925     log_identity(xtty);
 926     xtty->stamp();
 927     xtty->end_head();
 928   }
 929   // Print the header part, then print the requested information.
 930   // This is both handled in decode2().
 931   if (printmethod) {
 932     HandleMark hm;
 933     ResourceMark m;
 934     if (is_compiled_by_c1()) {
 935       tty->cr();
 936       tty->print_cr("============================= C1-compiled nmethod ==============================");
 937     }
 938     if (is_compiled_by_jvmci()) {
 939       tty->cr();
 940       tty->print_cr("=========================== JVMCI-compiled nmethod =============================");
 941     }
 942     tty->print_cr("----------------------------------- Assembly -----------------------------------");
 943     decode2(tty);
 944 #if defined(SUPPORT_DATA_STRUCTS)
 945     if (AbstractDisassembler::show_structs()) {
 946       // Print the oops from the underlying CodeBlob as well.
 947       tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
 948       print_oops(tty);
 949       tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
 950       print_metadata(tty);
 951       tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
 952       print_pcs();
 953       tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
 954       if (oop_maps() != NULL) {
 955         tty->print("oop maps:"); // oop_maps()->print_on(tty) outputs a cr() at the beginning
 956         oop_maps()->print_on(tty);
 957         tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
 958       }
 959     }
 960 #endif
 961   } else {
 962     print(); // print the header part only.
 963   }
 964 
 965 #if defined(SUPPORT_DATA_STRUCTS)
 966   if (AbstractDisassembler::show_structs()) {
 967     if (printmethod || PrintDebugInfo || CompilerOracle::has_option_string(_method, "PrintDebugInfo")) {
 968       print_scopes();
 969       tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
 970     }
 971     if (printmethod || PrintRelocations || CompilerOracle::has_option_string(_method, "PrintRelocations")) {
 972       print_relocations();
 973       tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
 974     }
 975     if (printmethod || PrintDependencies || CompilerOracle::has_option_string(_method, "PrintDependencies")) {
 976       print_dependencies();
 977       tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
 978     }
 979     if (printmethod || PrintExceptionHandlers) {
 980       print_handler_table();
 981       tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
 982       print_nul_chk_table();
 983       tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
 984     }
 985 
 986     if (printmethod) {
 987       print_recorded_oops();
 988       tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
 989       print_recorded_metadata();
 990       tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
 991     }
 992   }
 993 #endif
 994 
 995   if (xtty != NULL) {
 996     xtty->tail("print_nmethod");
 997   }
 998 }
 999 
1000 
1001 // Promote one word from an assembly-time handle to a live embedded oop.
1002 inline void nmethod::initialize_immediate_oop(oop* dest, jobject handle) {
1003   if (handle == NULL ||
1004       // As a special case, IC oops are initialized to 1 or -1.
1005       handle == (jobject) Universe::non_oop_word()) {
1006     (*dest) = (oop) handle;
1007   } else {
1008     (*dest) = JNIHandles::resolve_non_null(handle);
1009   }
1010 }
1011 
1012 
1013 // Have to have the same name because it's called by a template
1014 void nmethod::copy_values(GrowableArray<jobject>* array) {
1015   int length = array->length();
1016   assert((address)(oops_begin() + length) <= (address)oops_end(), "oops big enough");
1017   oop* dest = oops_begin();
1018   for (int index = 0 ; index < length; index++) {
1019     initialize_immediate_oop(&dest[index], array->at(index));
1020   }
1021 
1022   // Now we can fix up all the oops in the code.  We need to do this
1023   // in the code because the assembler uses jobjects as placeholders.
1024   // The code and relocations have already been initialized by the
1025   // CodeBlob constructor, so it is valid even at this early point to
1026   // iterate over relocations and patch the code.
1027   fix_oop_relocations(NULL, NULL, /*initialize_immediates=*/ true);
1028 }
1029 
1030 void nmethod::copy_values(GrowableArray<Metadata*>* array) {
1031   int length = array->length();
1032   assert((address)(metadata_begin() + length) <= (address)metadata_end(), "big enough");
1033   Metadata** dest = metadata_begin();
1034   for (int index = 0 ; index < length; index++) {
1035     dest[index] = array->at(index);
1036   }
1037 }
1038 
1039 void nmethod::fix_oop_relocations(address begin, address end, bool initialize_immediates) {
1040   // re-patch all oop-bearing instructions, just in case some oops moved
1041   RelocIterator iter(this, begin, end);
1042   while (iter.next()) {
1043     if (iter.type() == relocInfo::oop_type) {
1044       oop_Relocation* reloc = iter.oop_reloc();
1045       if (initialize_immediates && reloc->oop_is_immediate()) {
1046         oop* dest = reloc->oop_addr();
1047         initialize_immediate_oop(dest, (jobject) *dest);
1048       }
1049       // Refresh the oop-related bits of this instruction.
1050       reloc->fix_oop_relocation();
1051     } else if (iter.type() == relocInfo::metadata_type) {
1052       metadata_Relocation* reloc = iter.metadata_reloc();
1053       reloc->fix_metadata_relocation();
1054     }
1055   }
1056 }
1057 
1058 
1059 void nmethod::verify_clean_inline_caches() {
1060   assert(CompiledICLocker::is_safe(this), "mt unsafe call");
1061 
1062   ResourceMark rm;
1063   RelocIterator iter(this, oops_reloc_begin());
1064   while(iter.next()) {
1065     switch(iter.type()) {
1066       case relocInfo::virtual_call_type:
1067       case relocInfo::opt_virtual_call_type: {
1068         CompiledIC *ic = CompiledIC_at(&iter);
1069         // Ok, to lookup references to zombies here
1070         CodeBlob *cb = CodeCache::find_blob_unsafe(ic->ic_destination());
1071         assert(cb != NULL, "destination not in CodeBlob?");
1072         nmethod* nm = cb->as_nmethod_or_null();
1073         if( nm != NULL ) {
1074           // Verify that inline caches pointing to both zombie and not_entrant methods are clean
1075           if (!nm->is_in_use() || (nm->method()->code() != nm)) {
1076             assert(ic->is_clean(), "IC should be clean");
1077           }
1078         }
1079         break;
1080       }
1081       case relocInfo::static_call_type: {
1082         CompiledStaticCall *csc = compiledStaticCall_at(iter.reloc());
1083         CodeBlob *cb = CodeCache::find_blob_unsafe(csc->destination());
1084         assert(cb != NULL, "destination not in CodeBlob?");
1085         nmethod* nm = cb->as_nmethod_or_null();
1086         if( nm != NULL ) {
1087           // Verify that inline caches pointing to both zombie and not_entrant methods are clean
1088           if (!nm->is_in_use() || (nm->method()->code() != nm)) {
1089             assert(csc->is_clean(), "IC should be clean");
1090           }
1091         }
1092         break;
1093       }
1094       default:
1095         break;
1096     }
1097   }
1098 }
1099 
1100 // This is a private interface with the sweeper.
1101 void nmethod::mark_as_seen_on_stack() {
1102   assert(is_alive(), "Must be an alive method");
1103   // Set the traversal mark to ensure that the sweeper does 2
1104   // cleaning passes before moving to zombie.
1105   set_stack_traversal_mark(NMethodSweeper::traversal_count());
1106 }
1107 
1108 // Tell if a non-entrant method can be converted to a zombie (i.e.,
1109 // there are no activations on the stack, not in use by the VM,
1110 // and not in use by the ServiceThread)
1111 bool nmethod::can_convert_to_zombie() {
1112   // Note that this is called when the sweeper has observed the nmethod to be
1113   // not_entrant. However, with concurrent code cache unloading, the state
1114   // might have moved on to unloaded if it is_unloading(), due to racing
1115   // concurrent GC threads.
1116   assert(is_not_entrant() || is_unloading(), "must be a non-entrant method");
1117 
1118   // Since the nmethod sweeper only does partial sweep the sweeper's traversal
1119   // count can be greater than the stack traversal count before it hits the
1120   // nmethod for the second time.
1121   // If an is_unloading() nmethod is still not_entrant, then it is not safe to
1122   // convert it to zombie due to GC unloading interactions. However, if it
1123   // has become unloaded, then it is okay to convert such nmethods to zombie.
1124   return stack_traversal_mark() + 1 < NMethodSweeper::traversal_count() &&
1125          !is_locked_by_vm() && (!is_unloading() || is_unloaded());
1126 }
1127 
1128 void nmethod::inc_decompile_count() {
1129   if (!is_compiled_by_c2() && !is_compiled_by_jvmci()) return;
1130   // Could be gated by ProfileTraps, but do not bother...
1131   Method* m = method();
1132   if (m == NULL)  return;
1133   MethodData* mdo = m->method_data();
1134   if (mdo == NULL)  return;
1135   // There is a benign race here.  See comments in methodData.hpp.
1136   mdo->inc_decompile_count();
1137 }
1138 
1139 bool nmethod::try_transition(int new_state_int) {
1140   signed char new_state = new_state_int;
1141   for (;;) {
1142     signed char old_state = Atomic::load(&_state);
1143     if (old_state >= new_state) {
1144       // Ensure monotonicity of transitions.
1145       return false;
1146     }
1147     if (Atomic::cmpxchg(new_state, &_state, old_state) == old_state) {
1148       return true;
1149     }
1150   }
1151 }
1152 
1153 void nmethod::make_unloaded() {
1154   post_compiled_method_unload();
1155 
1156   // This nmethod is being unloaded, make sure that dependencies
1157   // recorded in instanceKlasses get flushed.
1158   // Since this work is being done during a GC, defer deleting dependencies from the
1159   // InstanceKlass.
1160   assert(Universe::heap()->is_gc_active() || Thread::current()->is_ConcurrentGC_thread(),
1161          "should only be called during gc");
1162   flush_dependencies(/*delete_immediately*/false);
1163 
1164   // Break cycle between nmethod & method
1165   LogTarget(Trace, class, unload, nmethod) lt;
1166   if (lt.is_enabled()) {
1167     LogStream ls(lt);
1168     ls.print("making nmethod " INTPTR_FORMAT
1169              " unloadable, Method*(" INTPTR_FORMAT
1170              ") ",
1171              p2i(this), p2i(_method));
1172      ls.cr();
1173   }
1174   // Unlink the osr method, so we do not look this up again
1175   if (is_osr_method()) {
1176     // Invalidate the osr nmethod only once. Note that with concurrent
1177     // code cache unloading, OSR nmethods are invalidated before they
1178     // are made unloaded. Therefore, this becomes a no-op then.
1179     if (is_in_use()) {
1180       invalidate_osr_method();
1181     }
1182 #ifdef ASSERT
1183     if (method() != NULL) {
1184       // Make sure osr nmethod is invalidated, i.e. not on the list
1185       bool found = method()->method_holder()->remove_osr_nmethod(this);
1186       assert(!found, "osr nmethod should have been invalidated");
1187     }
1188 #endif
1189   }
1190 
1191   // If _method is already NULL the Method* is about to be unloaded,
1192   // so we don't have to break the cycle. Note that it is possible to
1193   // have the Method* live here, in case we unload the nmethod because
1194   // it is pointing to some oop (other than the Method*) being unloaded.
1195   if (_method != NULL) {
1196     // OSR methods point to the Method*, but the Method* does not
1197     // point back!
1198     if (_method->code() == this) {
1199       _method->clear_code(); // Break a cycle
1200     }
1201   }
1202 
1203   // Make the class unloaded - i.e., change state and notify sweeper
1204   assert(SafepointSynchronize::is_at_safepoint() || Thread::current()->is_ConcurrentGC_thread(),
1205          "must be at safepoint");
1206 
1207   {
1208     // Clear ICStubs and release any CompiledICHolders.
1209     CompiledICLocker ml(this);
1210     clear_ic_callsites();
1211   }
1212 
1213   // Unregister must be done before the state change
1214   {
1215     MutexLocker ml(SafepointSynchronize::is_at_safepoint() ? NULL : CodeCache_lock,
1216                      Mutex::_no_safepoint_check_flag);
1217     Universe::heap()->unregister_nmethod(this);
1218   }
1219 
1220   // Clear the method of this dead nmethod
1221   set_method(NULL);
1222 
1223   // Log the unloading.
1224   log_state_change();
1225 
1226   // The Method* is gone at this point
1227   assert(_method == NULL, "Tautology");
1228 
1229   set_osr_link(NULL);
1230   NMethodSweeper::report_state_change(this);
1231 
1232   bool transition_success = try_transition(unloaded);
1233 
1234   // It is an important invariant that there exists no race between
1235   // the sweeper and GC thread competing for making the same nmethod
1236   // zombie and unloaded respectively. This is ensured by
1237   // can_convert_to_zombie() returning false for any is_unloading()
1238   // nmethod, informing the sweeper not to step on any GC toes.
1239   assert(transition_success, "Invalid nmethod transition to unloaded");
1240 
1241 #if INCLUDE_JVMCI
1242   // Clear the link between this nmethod and a HotSpotNmethod mirror
1243   JVMCINMethodData* nmethod_data = jvmci_nmethod_data();
1244   if (nmethod_data != NULL) {
1245     nmethod_data->invalidate_nmethod_mirror(this);
1246     nmethod_data->clear_nmethod_mirror(this);
1247   }
1248 #endif
1249 }
1250 
1251 void nmethod::invalidate_osr_method() {
1252   assert(_entry_bci != InvocationEntryBci, "wrong kind of nmethod");
1253   // Remove from list of active nmethods
1254   if (method() != NULL) {
1255     method()->method_holder()->remove_osr_nmethod(this);
1256   }
1257 }
1258 
1259 void nmethod::log_state_change() const {
1260   if (LogCompilation) {
1261     if (xtty != NULL) {
1262       ttyLocker ttyl;  // keep the following output all in one block
1263       if (_state == unloaded) {
1264         xtty->begin_elem("make_unloaded thread='" UINTX_FORMAT "'",
1265                          os::current_thread_id());
1266       } else {
1267         xtty->begin_elem("make_not_entrant thread='" UINTX_FORMAT "'%s",
1268                          os::current_thread_id(),
1269                          (_state == zombie ? " zombie='1'" : ""));
1270       }
1271       log_identity(xtty);
1272       xtty->stamp();
1273       xtty->end_elem();
1274     }
1275   }
1276 
1277   const char *state_msg = _state == zombie ? "made zombie" : "made not entrant";
1278   CompileTask::print_ul(this, state_msg);
1279   if (PrintCompilation && _state != unloaded) {
1280     print_on(tty, state_msg);
1281   }
1282 }
1283 
1284 void nmethod::unlink_from_method(bool acquire_lock) {
1285   // We need to check if both the _code and _from_compiled_code_entry_point
1286   // refer to this nmethod because there is a race in setting these two fields
1287   // in Method* as seen in bugid 4947125.
1288   // If the vep() points to the zombie nmethod, the memory for the nmethod
1289   // could be flushed and the compiler and vtable stubs could still call
1290   // through it.
1291   if (method() != NULL && (method()->code() == this ||
1292                            method()->from_compiled_entry() == verified_entry_point())) {
1293     method()->clear_code(acquire_lock);
1294   }
1295 }
1296 
1297 /**
1298  * Common functionality for both make_not_entrant and make_zombie
1299  */
1300 bool nmethod::make_not_entrant_or_zombie(int state) {
1301   assert(state == zombie || state == not_entrant, "must be zombie or not_entrant");
1302   assert(!is_zombie(), "should not already be a zombie");
1303 
1304   if (Atomic::load(&_state) >= state) {
1305     // Avoid taking the lock if already in required state.
1306     // This is safe from races because the state is an end-state,
1307     // which the nmethod cannot back out of once entered.
1308     // No need for fencing either.
1309     return false;
1310   }
1311 
1312   // Make sure neither the nmethod nor the method is flushed in case of a safepoint in code below.
1313   nmethodLocker nml(this);
1314   methodHandle the_method(method());
1315   // This can be called while the system is already at a safepoint which is ok
1316   NoSafepointVerifier nsv;
1317 
1318   // during patching, depending on the nmethod state we must notify the GC that
1319   // code has been unloaded, unregistering it. We cannot do this right while
1320   // holding the Patching_lock because we need to use the CodeCache_lock. This
1321   // would be prone to deadlocks.
1322   // This flag is used to remember whether we need to later lock and unregister.
1323   bool nmethod_needs_unregister = false;
1324 
1325   {
1326     // invalidate osr nmethod before acquiring the patching lock since
1327     // they both acquire leaf locks and we don't want a deadlock.
1328     // This logic is equivalent to the logic below for patching the
1329     // verified entry point of regular methods. We check that the
1330     // nmethod is in use to ensure that it is invalidated only once.
1331     if (is_osr_method() && is_in_use()) {
1332       // this effectively makes the osr nmethod not entrant
1333       invalidate_osr_method();
1334     }
1335 
1336     // Enter critical section.  Does not block for safepoint.
1337     MutexLocker pl(Patching_lock, Mutex::_no_safepoint_check_flag);
1338 
1339     if (Atomic::load(&_state) >= state) {
1340       // another thread already performed this transition so nothing
1341       // to do, but return false to indicate this.
1342       return false;
1343     }
1344 
1345     // The caller can be calling the method statically or through an inline
1346     // cache call.
1347     if (!is_osr_method() && !is_not_entrant()) {
1348       NativeJump::patch_verified_entry(entry_point(), verified_entry_point(),
1349                   SharedRuntime::get_handle_wrong_method_stub());
1350     }
1351 
1352     if (is_in_use() && update_recompile_counts()) {
1353       // It's a true state change, so mark the method as decompiled.
1354       // Do it only for transition from alive.
1355       inc_decompile_count();
1356     }
1357 
1358     // If the state is becoming a zombie, signal to unregister the nmethod with
1359     // the heap.
1360     // This nmethod may have already been unloaded during a full GC.
1361     if ((state == zombie) && !is_unloaded()) {
1362       nmethod_needs_unregister = true;
1363     }
1364 
1365     // Must happen before state change. Otherwise we have a race condition in
1366     // nmethod::can_not_entrant_be_converted(). I.e., a method can immediately
1367     // transition its state from 'not_entrant' to 'zombie' without having to wait
1368     // for stack scanning.
1369     if (state == not_entrant) {
1370       mark_as_seen_on_stack();
1371       OrderAccess::storestore(); // _stack_traversal_mark and _state
1372     }
1373 
1374     // Change state
1375     if (!try_transition(state)) {
1376       // If the transition fails, it is due to another thread making the nmethod more
1377       // dead. In particular, one thread might be making the nmethod unloaded concurrently.
1378       // If so, having patched in the jump in the verified entry unnecessarily is fine.
1379       // The nmethod is no longer possible to call by Java threads.
1380       // Incrementing the decompile count is also fine as the caller of make_not_entrant()
1381       // had a valid reason to deoptimize the nmethod.
1382       // Marking the nmethod as seen on stack also has no effect, as the nmethod is now
1383       // !is_alive(), and the seen on stack value is only used to convert not_entrant
1384       // nmethods to zombie in can_convert_to_zombie().
1385       return false;
1386     }
1387 
1388     // Log the transition once
1389     log_state_change();
1390 
1391     // Remove nmethod from method.
1392     unlink_from_method(false /* already owns Patching_lock */);
1393   } // leave critical region under Patching_lock
1394 
1395 #if INCLUDE_JVMCI
1396   // Invalidate can't occur while holding the Patching lock
1397   JVMCINMethodData* nmethod_data = jvmci_nmethod_data();
1398   if (nmethod_data != NULL) {
1399     nmethod_data->invalidate_nmethod_mirror(this);
1400   }
1401 #endif
1402 
1403 #ifdef ASSERT
1404   if (is_osr_method() && method() != NULL) {
1405     // Make sure osr nmethod is invalidated, i.e. not on the list
1406     bool found = method()->method_holder()->remove_osr_nmethod(this);
1407     assert(!found, "osr nmethod should have been invalidated");
1408   }
1409 #endif
1410 
1411   // When the nmethod becomes zombie it is no longer alive so the
1412   // dependencies must be flushed.  nmethods in the not_entrant
1413   // state will be flushed later when the transition to zombie
1414   // happens or they get unloaded.
1415   if (state == zombie) {
1416     {
1417       // Flushing dependencies must be done before any possible
1418       // safepoint can sneak in, otherwise the oops used by the
1419       // dependency logic could have become stale.
1420       MutexLocker mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);
1421       if (nmethod_needs_unregister) {
1422         Universe::heap()->unregister_nmethod(this);
1423       }
1424       flush_dependencies(/*delete_immediately*/true);
1425     }
1426 
1427 #if INCLUDE_JVMCI
1428     // Now that the nmethod has been unregistered, it's
1429     // safe to clear the HotSpotNmethod mirror oop.
1430     if (nmethod_data != NULL) {
1431       nmethod_data->clear_nmethod_mirror(this);
1432     }
1433 #endif
1434 
1435     // Clear ICStubs to prevent back patching stubs of zombie or flushed
1436     // nmethods during the next safepoint (see ICStub::finalize), as well
1437     // as to free up CompiledICHolder resources.
1438     {
1439       CompiledICLocker ml(this);
1440       clear_ic_callsites();
1441     }
1442 
1443     // zombie only - if a JVMTI agent has enabled the CompiledMethodUnload
1444     // event and it hasn't already been reported for this nmethod then
1445     // report it now. The event may have been reported earlier if the GC
1446     // marked it for unloading). JvmtiDeferredEventQueue support means
1447     // we no longer go to a safepoint here.
1448     post_compiled_method_unload();
1449 
1450 #ifdef ASSERT
1451     // It's no longer safe to access the oops section since zombie
1452     // nmethods aren't scanned for GC.
1453     _oops_are_stale = true;
1454 #endif
1455      // the Method may be reclaimed by class unloading now that the
1456      // nmethod is in zombie state
1457     set_method(NULL);
1458   } else {
1459     assert(state == not_entrant, "other cases may need to be handled differently");
1460   }
1461 
1462   if (TraceCreateZombies && state == zombie) {
1463     ResourceMark m;
1464     tty->print_cr("nmethod <" INTPTR_FORMAT "> %s code made %s", p2i(this), this->method() ? this->method()->name_and_sig_as_C_string() : "null", (state == not_entrant) ? "not entrant" : "zombie");
1465   }
1466 
1467   NMethodSweeper::report_state_change(this);
1468   return true;
1469 }
1470 
1471 void nmethod::flush() {
1472   MutexLocker mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);
1473   // Note that there are no valid oops in the nmethod anymore.
1474   assert(!is_osr_method() || is_unloaded() || is_zombie(),
1475          "osr nmethod must be unloaded or zombie before flushing");
1476   assert(is_zombie() || is_osr_method(), "must be a zombie method");
1477   assert (!is_locked_by_vm(), "locked methods shouldn't be flushed");
1478   assert_locked_or_safepoint(CodeCache_lock);
1479 
1480   // completely deallocate this method
1481   Events::log(JavaThread::current(), "flushing nmethod " INTPTR_FORMAT, p2i(this));
1482   if (PrintMethodFlushing) {
1483     tty->print_cr("*flushing %s nmethod %3d/" INTPTR_FORMAT ". Live blobs:" UINT32_FORMAT
1484                   "/Free CodeCache:" SIZE_FORMAT "Kb",
1485                   is_osr_method() ? "osr" : "",_compile_id, p2i(this), CodeCache::blob_count(),
1486                   CodeCache::unallocated_capacity(CodeCache::get_code_blob_type(this))/1024);
1487   }
1488 
1489   // We need to deallocate any ExceptionCache data.
1490   // Note that we do not need to grab the nmethod lock for this, it
1491   // better be thread safe if we're disposing of it!
1492   ExceptionCache* ec = exception_cache();
1493   set_exception_cache(NULL);
1494   while(ec != NULL) {
1495     ExceptionCache* next = ec->next();
1496     delete ec;
1497     ec = next;
1498   }
1499 
1500   Universe::heap()->flush_nmethod(this);
1501   CodeCache::unregister_old_nmethod(this);
1502 
1503   CodeBlob::flush();
1504   CodeCache::free(this);
1505 }
1506 
1507 oop nmethod::oop_at(int index) const {
1508   if (index == 0) {
1509     return NULL;
1510   }
1511   return NativeAccess<AS_NO_KEEPALIVE>::oop_load(oop_addr_at(index));
1512 }
1513 
1514 oop nmethod::oop_at_phantom(int index) const {
1515   if (index == 0) {
1516     return NULL;
1517   }
1518   return NativeAccess<ON_PHANTOM_OOP_REF>::oop_load(oop_addr_at(index));
1519 }
1520 
1521 //
1522 // Notify all classes this nmethod is dependent on that it is no
1523 // longer dependent. This should only be called in two situations.
1524 // First, when a nmethod transitions to a zombie all dependents need
1525 // to be clear.  Since zombification happens at a safepoint there's no
1526 // synchronization issues.  The second place is a little more tricky.
1527 // During phase 1 of mark sweep class unloading may happen and as a
1528 // result some nmethods may get unloaded.  In this case the flushing
1529 // of dependencies must happen during phase 1 since after GC any
1530 // dependencies in the unloaded nmethod won't be updated, so
1531 // traversing the dependency information in unsafe.  In that case this
1532 // function is called with a boolean argument and this function only
1533 // notifies instanceKlasses that are reachable
1534 
1535 void nmethod::flush_dependencies(bool delete_immediately) {
1536   DEBUG_ONLY(bool called_by_gc = Universe::heap()->is_gc_active() || Thread::current()->is_ConcurrentGC_thread();)
1537   assert(called_by_gc != delete_immediately,
1538   "delete_immediately is false if and only if we are called during GC");
1539   if (!has_flushed_dependencies()) {
1540     set_has_flushed_dependencies();
1541     for (Dependencies::DepStream deps(this); deps.next(); ) {
1542       if (deps.type() == Dependencies::call_site_target_value) {
1543         // CallSite dependencies are managed on per-CallSite instance basis.
1544         oop call_site = deps.argument_oop(0);
1545         if (delete_immediately) {
1546           assert_locked_or_safepoint(CodeCache_lock);
1547           MethodHandles::remove_dependent_nmethod(call_site, this);
1548         } else {
1549           MethodHandles::clean_dependency_context(call_site);
1550         }
1551       } else {
1552         Klass* klass = deps.context_type();
1553         if (klass == NULL) {
1554           continue;  // ignore things like evol_method
1555         }
1556         // During GC delete_immediately is false, and liveness
1557         // of dependee determines class that needs to be updated.
1558         if (delete_immediately) {
1559           assert_locked_or_safepoint(CodeCache_lock);
1560           InstanceKlass::cast(klass)->remove_dependent_nmethod(this);
1561         } else if (klass->is_loader_alive()) {
1562           // The GC may clean dependency contexts concurrently and in parallel.
1563           InstanceKlass::cast(klass)->clean_dependency_context();
1564         }
1565       }
1566     }
1567   }
1568 }
1569 
1570 // ------------------------------------------------------------------
1571 // post_compiled_method_load_event
1572 // new method for install_code() path
1573 // Transfer information from compilation to jvmti
1574 void nmethod::post_compiled_method_load_event() {
1575 
1576   Method* moop = method();
1577   HOTSPOT_COMPILED_METHOD_LOAD(
1578       (char *) moop->klass_name()->bytes(),
1579       moop->klass_name()->utf8_length(),
1580       (char *) moop->name()->bytes(),
1581       moop->name()->utf8_length(),
1582       (char *) moop->signature()->bytes(),
1583       moop->signature()->utf8_length(),
1584       insts_begin(), insts_size());
1585 
1586   if (JvmtiExport::should_post_compiled_method_load() ||
1587       JvmtiExport::should_post_compiled_method_unload()) {
1588     get_and_cache_jmethod_id();
1589   }
1590 
1591   if (JvmtiExport::should_post_compiled_method_load()) {
1592     // Let the Service thread (which is a real Java thread) post the event
1593     MutexLocker ml(Service_lock, Mutex::_no_safepoint_check_flag);
1594     JvmtiDeferredEventQueue::enqueue(
1595       JvmtiDeferredEvent::compiled_method_load_event(this));
1596   }
1597 }
1598 
1599 jmethodID nmethod::get_and_cache_jmethod_id() {
1600   if (_jmethod_id == NULL) {
1601     // Cache the jmethod_id since it can no longer be looked up once the
1602     // method itself has been marked for unloading.
1603     _jmethod_id = method()->jmethod_id();
1604   }
1605   return _jmethod_id;
1606 }
1607 
1608 void nmethod::post_compiled_method_unload() {
1609   if (unload_reported()) {
1610     // During unloading we transition to unloaded and then to zombie
1611     // and the unloading is reported during the first transition.
1612     return;
1613   }
1614 
1615   assert(_method != NULL && !is_unloaded(), "just checking");
1616   DTRACE_METHOD_UNLOAD_PROBE(method());
1617 
1618   // If a JVMTI agent has enabled the CompiledMethodUnload event then
1619   // post the event. Sometime later this nmethod will be made a zombie
1620   // by the sweeper but the Method* will not be valid at that point.
1621   // If the _jmethod_id is null then no load event was ever requested
1622   // so don't bother posting the unload.  The main reason for this is
1623   // that the jmethodID is a weak reference to the Method* so if
1624   // it's being unloaded there's no way to look it up since the weak
1625   // ref will have been cleared.
1626   if (_jmethod_id != NULL && JvmtiExport::should_post_compiled_method_unload()) {
1627     assert(!unload_reported(), "already unloaded");
1628     JvmtiDeferredEvent event =
1629       JvmtiDeferredEvent::compiled_method_unload_event(this,
1630           _jmethod_id, insts_begin());
1631     MutexLocker ml(Service_lock, Mutex::_no_safepoint_check_flag);
1632     JvmtiDeferredEventQueue::enqueue(event);
1633   }
1634 
1635   // The JVMTI CompiledMethodUnload event can be enabled or disabled at
1636   // any time. As the nmethod is being unloaded now we mark it has
1637   // having the unload event reported - this will ensure that we don't
1638   // attempt to report the event in the unlikely scenario where the
1639   // event is enabled at the time the nmethod is made a zombie.
1640   set_unload_reported();
1641 }
1642 
1643 // Iterate over metadata calling this function.   Used by RedefineClasses
1644 void nmethod::metadata_do(MetadataClosure* f) {
1645   {
1646     // Visit all immediate references that are embedded in the instruction stream.
1647     RelocIterator iter(this, oops_reloc_begin());
1648     while (iter.next()) {
1649       if (iter.type() == relocInfo::metadata_type) {
1650         metadata_Relocation* r = iter.metadata_reloc();
1651         // In this metadata, we must only follow those metadatas directly embedded in
1652         // the code.  Other metadatas (oop_index>0) are seen as part of
1653         // the metadata section below.
1654         assert(1 == (r->metadata_is_immediate()) +
1655                (r->metadata_addr() >= metadata_begin() && r->metadata_addr() < metadata_end()),
1656                "metadata must be found in exactly one place");
1657         if (r->metadata_is_immediate() && r->metadata_value() != NULL) {
1658           Metadata* md = r->metadata_value();
1659           if (md != _method) f->do_metadata(md);
1660         }
1661       } else if (iter.type() == relocInfo::virtual_call_type) {
1662         // Check compiledIC holders associated with this nmethod
1663         ResourceMark rm;
1664         CompiledIC *ic = CompiledIC_at(&iter);
1665         if (ic->is_icholder_call()) {
1666           CompiledICHolder* cichk = ic->cached_icholder();
1667           f->do_metadata(cichk->holder_metadata());
1668           f->do_metadata(cichk->holder_klass());
1669         } else {
1670           Metadata* ic_oop = ic->cached_metadata();
1671           if (ic_oop != NULL) {
1672             f->do_metadata(ic_oop);
1673           }
1674         }
1675       }
1676     }
1677   }
1678 
1679   // Visit the metadata section
1680   for (Metadata** p = metadata_begin(); p < metadata_end(); p++) {
1681     if (*p == Universe::non_oop_word() || *p == NULL)  continue;  // skip non-oops
1682     Metadata* md = *p;
1683     f->do_metadata(md);
1684   }
1685 
1686   // Visit metadata not embedded in the other places.
1687   if (_method != NULL) f->do_metadata(_method);
1688 }
1689 
1690 // The _is_unloading_state encodes a tuple comprising the unloading cycle
1691 // and the result of IsUnloadingBehaviour::is_unloading() fpr that cycle.
1692 // This is the bit layout of the _is_unloading_state byte: 00000CCU
1693 // CC refers to the cycle, which has 2 bits, and U refers to the result of
1694 // IsUnloadingBehaviour::is_unloading() for that unloading cycle.
1695 
1696 class IsUnloadingState: public AllStatic {
1697   static const uint8_t _is_unloading_mask = 1;
1698   static const uint8_t _is_unloading_shift = 0;
1699   static const uint8_t _unloading_cycle_mask = 6;
1700   static const uint8_t _unloading_cycle_shift = 1;
1701 
1702   static uint8_t set_is_unloading(uint8_t state, bool value) {
1703     state &= ~_is_unloading_mask;
1704     if (value) {
1705       state |= 1 << _is_unloading_shift;
1706     }
1707     assert(is_unloading(state) == value, "unexpected unloading cycle overflow");
1708     return state;
1709   }
1710 
1711   static uint8_t set_unloading_cycle(uint8_t state, uint8_t value) {
1712     state &= ~_unloading_cycle_mask;
1713     state |= value << _unloading_cycle_shift;
1714     assert(unloading_cycle(state) == value, "unexpected unloading cycle overflow");
1715     return state;
1716   }
1717 
1718 public:
1719   static bool is_unloading(uint8_t state) { return (state & _is_unloading_mask) >> _is_unloading_shift == 1; }
1720   static uint8_t unloading_cycle(uint8_t state) { return (state & _unloading_cycle_mask) >> _unloading_cycle_shift; }
1721 
1722   static uint8_t create(bool is_unloading, uint8_t unloading_cycle) {
1723     uint8_t state = 0;
1724     state = set_is_unloading(state, is_unloading);
1725     state = set_unloading_cycle(state, unloading_cycle);
1726     return state;
1727   }
1728 };
1729 
1730 bool nmethod::is_unloading() {
1731   uint8_t state = RawAccess<MO_RELAXED>::load(&_is_unloading_state);
1732   bool state_is_unloading = IsUnloadingState::is_unloading(state);
1733   uint8_t state_unloading_cycle = IsUnloadingState::unloading_cycle(state);
1734   if (state_is_unloading) {
1735     return true;
1736   }
1737   uint8_t current_cycle = CodeCache::unloading_cycle();
1738   if (state_unloading_cycle == current_cycle) {
1739     return false;
1740   }
1741 
1742   // The IsUnloadingBehaviour is responsible for checking if there are any dead
1743   // oops in the CompiledMethod, by calling oops_do on it.
1744   state_unloading_cycle = current_cycle;
1745 
1746   if (is_zombie()) {
1747     // Zombies without calculated unloading epoch are never unloading due to GC.
1748 
1749     // There are no races where a previously observed is_unloading() nmethod
1750     // suddenly becomes not is_unloading() due to here being observed as zombie.
1751 
1752     // With STW unloading, all is_alive() && is_unloading() nmethods are unlinked
1753     // and unloaded in the safepoint. That makes races where an nmethod is first
1754     // observed as is_alive() && is_unloading() and subsequently observed as
1755     // is_zombie() impossible.
1756 
1757     // With concurrent unloading, all references to is_unloading() nmethods are
1758     // first unlinked (e.g. IC caches and dependency contexts). Then a global
1759     // handshake operation is performed with all JavaThreads before finally
1760     // unloading the nmethods. The sweeper never converts is_alive() && is_unloading()
1761     // nmethods to zombies; it waits for them to become is_unloaded(). So before
1762     // the global handshake, it is impossible for is_unloading() nmethods to
1763     // racingly become is_zombie(). And is_unloading() is calculated for all is_alive()
1764     // nmethods before taking that global handshake, meaning that it will never
1765     // be recalculated after the handshake.
1766 
1767     // After that global handshake, is_unloading() nmethods are only observable
1768     // to the iterators, and they will never trigger recomputation of the cached
1769     // is_unloading_state, and hence may not suffer from such races.
1770 
1771     state_is_unloading = false;
1772   } else {
1773     state_is_unloading = IsUnloadingBehaviour::current()->is_unloading(this);
1774   }
1775 
1776   state = IsUnloadingState::create(state_is_unloading, state_unloading_cycle);
1777 
1778   RawAccess<MO_RELAXED>::store(&_is_unloading_state, state);
1779 
1780   return state_is_unloading;
1781 }
1782 
1783 void nmethod::clear_unloading_state() {
1784   uint8_t state = IsUnloadingState::create(false, CodeCache::unloading_cycle());
1785   RawAccess<MO_RELAXED>::store(&_is_unloading_state, state);
1786 }
1787 
1788 
1789 // This is called at the end of the strong tracing/marking phase of a
1790 // GC to unload an nmethod if it contains otherwise unreachable
1791 // oops.
1792 
1793 void nmethod::do_unloading(bool unloading_occurred) {
1794   // Make sure the oop's ready to receive visitors
1795   assert(!is_zombie() && !is_unloaded(),
1796          "should not call follow on zombie or unloaded nmethod");
1797 
1798   if (is_unloading()) {
1799     make_unloaded();
1800   } else {
1801     guarantee(unload_nmethod_caches(unloading_occurred),
1802               "Should not need transition stubs");
1803   }
1804 }
1805 
1806 void nmethod::oops_do(OopClosure* f, bool allow_dead) {
1807   // make sure the oops ready to receive visitors
1808   assert(allow_dead || is_alive(), "should not call follow on dead nmethod");
1809 
1810   // Prevent extra code cache walk for platforms that don't have immediate oops.
1811   if (relocInfo::mustIterateImmediateOopsInCode()) {
1812     RelocIterator iter(this, oops_reloc_begin());
1813 
1814     while (iter.next()) {
1815       if (iter.type() == relocInfo::oop_type ) {
1816         oop_Relocation* r = iter.oop_reloc();
1817         // In this loop, we must only follow those oops directly embedded in
1818         // the code.  Other oops (oop_index>0) are seen as part of scopes_oops.
1819         assert(1 == (r->oop_is_immediate()) +
1820                (r->oop_addr() >= oops_begin() && r->oop_addr() < oops_end()),
1821                "oop must be found in exactly one place");
1822         if (r->oop_is_immediate() && r->oop_value() != NULL) {
1823           f->do_oop(r->oop_addr());
1824         }
1825       }
1826     }
1827   }
1828 
1829   // Scopes
1830   // This includes oop constants not inlined in the code stream.
1831   for (oop* p = oops_begin(); p < oops_end(); p++) {
1832     if (*p == Universe::non_oop_word())  continue;  // skip non-oops
1833     f->do_oop(p);
1834   }
1835 }
1836 
1837 #define NMETHOD_SENTINEL ((nmethod*)badAddress)
1838 
1839 nmethod* volatile nmethod::_oops_do_mark_nmethods;
1840 
1841 // An nmethod is "marked" if its _mark_link is set non-null.
1842 // Even if it is the end of the linked list, it will have a non-null link value,
1843 // as long as it is on the list.
1844 // This code must be MP safe, because it is used from parallel GC passes.
1845 bool nmethod::test_set_oops_do_mark() {
1846   assert(nmethod::oops_do_marking_is_active(), "oops_do_marking_prologue must be called");
1847   if (_oops_do_mark_link == NULL) {
1848     // Claim this nmethod for this thread to mark.
1849     if (Atomic::replace_if_null(NMETHOD_SENTINEL, &_oops_do_mark_link)) {
1850       // Atomically append this nmethod (now claimed) to the head of the list:
1851       nmethod* observed_mark_nmethods = _oops_do_mark_nmethods;
1852       for (;;) {
1853         nmethod* required_mark_nmethods = observed_mark_nmethods;
1854         _oops_do_mark_link = required_mark_nmethods;
1855         observed_mark_nmethods =
1856           Atomic::cmpxchg(this, &_oops_do_mark_nmethods, required_mark_nmethods);
1857         if (observed_mark_nmethods == required_mark_nmethods)
1858           break;
1859       }
1860       // Mark was clear when we first saw this guy.
1861       LogTarget(Trace, gc, nmethod) lt;
1862       if (lt.is_enabled()) {
1863         LogStream ls(lt);
1864         CompileTask::print(&ls, this, "oops_do, mark", /*short_form:*/ true);
1865       }
1866       return false;
1867     }
1868   }
1869   // On fall through, another racing thread marked this nmethod before we did.
1870   return true;
1871 }
1872 
1873 void nmethod::oops_do_marking_prologue() {
1874   log_trace(gc, nmethod)("oops_do_marking_prologue");
1875   assert(_oops_do_mark_nmethods == NULL, "must not call oops_do_marking_prologue twice in a row");
1876   // We use cmpxchg instead of regular assignment here because the user
1877   // may fork a bunch of threads, and we need them all to see the same state.
1878   nmethod* observed = Atomic::cmpxchg(NMETHOD_SENTINEL, &_oops_do_mark_nmethods, (nmethod*)NULL);
1879   guarantee(observed == NULL, "no races in this sequential code");
1880 }
1881 
1882 void nmethod::oops_do_marking_epilogue() {
1883   assert(_oops_do_mark_nmethods != NULL, "must not call oops_do_marking_epilogue twice in a row");
1884   nmethod* cur = _oops_do_mark_nmethods;
1885   while (cur != NMETHOD_SENTINEL) {
1886     assert(cur != NULL, "not NULL-terminated");
1887     nmethod* next = cur->_oops_do_mark_link;
1888     cur->_oops_do_mark_link = NULL;
1889     DEBUG_ONLY(cur->verify_oop_relocations());
1890 
1891     LogTarget(Trace, gc, nmethod) lt;
1892     if (lt.is_enabled()) {
1893       LogStream ls(lt);
1894       CompileTask::print(&ls, cur, "oops_do, unmark", /*short_form:*/ true);
1895     }
1896     cur = next;
1897   }
1898   nmethod* required = _oops_do_mark_nmethods;
1899   nmethod* observed = Atomic::cmpxchg((nmethod*)NULL, &_oops_do_mark_nmethods, required);
1900   guarantee(observed == required, "no races in this sequential code");
1901   log_trace(gc, nmethod)("oops_do_marking_epilogue");
1902 }
1903 
1904 inline bool includes(void* p, void* from, void* to) {
1905   return from <= p && p < to;
1906 }
1907 
1908 
1909 void nmethod::copy_scopes_pcs(PcDesc* pcs, int count) {
1910   assert(count >= 2, "must be sentinel values, at least");
1911 
1912 #ifdef ASSERT
1913   // must be sorted and unique; we do a binary search in find_pc_desc()
1914   int prev_offset = pcs[0].pc_offset();
1915   assert(prev_offset == PcDesc::lower_offset_limit,
1916          "must start with a sentinel");
1917   for (int i = 1; i < count; i++) {
1918     int this_offset = pcs[i].pc_offset();
1919     assert(this_offset > prev_offset, "offsets must be sorted");
1920     prev_offset = this_offset;
1921   }
1922   assert(prev_offset == PcDesc::upper_offset_limit,
1923          "must end with a sentinel");
1924 #endif //ASSERT
1925 
1926   // Search for MethodHandle invokes and tag the nmethod.
1927   for (int i = 0; i < count; i++) {
1928     if (pcs[i].is_method_handle_invoke()) {
1929       set_has_method_handle_invokes(true);
1930       break;
1931     }
1932   }
1933   assert(has_method_handle_invokes() == (_deopt_mh_handler_begin != NULL), "must have deopt mh handler");
1934 
1935   int size = count * sizeof(PcDesc);
1936   assert(scopes_pcs_size() >= size, "oob");
1937   memcpy(scopes_pcs_begin(), pcs, size);
1938 
1939   // Adjust the final sentinel downward.
1940   PcDesc* last_pc = &scopes_pcs_begin()[count-1];
1941   assert(last_pc->pc_offset() == PcDesc::upper_offset_limit, "sanity");
1942   last_pc->set_pc_offset(content_size() + 1);
1943   for (; last_pc + 1 < scopes_pcs_end(); last_pc += 1) {
1944     // Fill any rounding gaps with copies of the last record.
1945     last_pc[1] = last_pc[0];
1946   }
1947   // The following assert could fail if sizeof(PcDesc) is not
1948   // an integral multiple of oopSize (the rounding term).
1949   // If it fails, change the logic to always allocate a multiple
1950   // of sizeof(PcDesc), and fill unused words with copies of *last_pc.
1951   assert(last_pc + 1 == scopes_pcs_end(), "must match exactly");
1952 }
1953 
1954 void nmethod::copy_scopes_data(u_char* buffer, int size) {
1955   assert(scopes_data_size() >= size, "oob");
1956   memcpy(scopes_data_begin(), buffer, size);
1957 }
1958 
1959 #ifdef ASSERT
1960 static PcDesc* linear_search(const PcDescSearch& search, int pc_offset, bool approximate) {
1961   PcDesc* lower = search.scopes_pcs_begin();
1962   PcDesc* upper = search.scopes_pcs_end();
1963   lower += 1; // exclude initial sentinel
1964   PcDesc* res = NULL;
1965   for (PcDesc* p = lower; p < upper; p++) {
1966     NOT_PRODUCT(--pc_nmethod_stats.pc_desc_tests);  // don't count this call to match_desc
1967     if (match_desc(p, pc_offset, approximate)) {
1968       if (res == NULL)
1969         res = p;
1970       else
1971         res = (PcDesc*) badAddress;
1972     }
1973   }
1974   return res;
1975 }
1976 #endif
1977 
1978 
1979 // Finds a PcDesc with real-pc equal to "pc"
1980 PcDesc* PcDescContainer::find_pc_desc_internal(address pc, bool approximate, const PcDescSearch& search) {
1981   address base_address = search.code_begin();
1982   if ((pc < base_address) ||
1983       (pc - base_address) >= (ptrdiff_t) PcDesc::upper_offset_limit) {
1984     return NULL;  // PC is wildly out of range
1985   }
1986   int pc_offset = (int) (pc - base_address);
1987 
1988   // Check the PcDesc cache if it contains the desired PcDesc
1989   // (This as an almost 100% hit rate.)
1990   PcDesc* res = _pc_desc_cache.find_pc_desc(pc_offset, approximate);
1991   if (res != NULL) {
1992     assert(res == linear_search(search, pc_offset, approximate), "cache ok");
1993     return res;
1994   }
1995 
1996   // Fallback algorithm: quasi-linear search for the PcDesc
1997   // Find the last pc_offset less than the given offset.
1998   // The successor must be the required match, if there is a match at all.
1999   // (Use a fixed radix to avoid expensive affine pointer arithmetic.)
2000   PcDesc* lower = search.scopes_pcs_begin();
2001   PcDesc* upper = search.scopes_pcs_end();
2002   upper -= 1; // exclude final sentinel
2003   if (lower >= upper)  return NULL;  // native method; no PcDescs at all
2004 
2005 #define assert_LU_OK \
2006   /* invariant on lower..upper during the following search: */ \
2007   assert(lower->pc_offset() <  pc_offset, "sanity"); \
2008   assert(upper->pc_offset() >= pc_offset, "sanity")
2009   assert_LU_OK;
2010 
2011   // Use the last successful return as a split point.
2012   PcDesc* mid = _pc_desc_cache.last_pc_desc();
2013   NOT_PRODUCT(++pc_nmethod_stats.pc_desc_searches);
2014   if (mid->pc_offset() < pc_offset) {
2015     lower = mid;
2016   } else {
2017     upper = mid;
2018   }
2019 
2020   // Take giant steps at first (4096, then 256, then 16, then 1)
2021   const int LOG2_RADIX = 4 /*smaller steps in debug mode:*/ debug_only(-1);
2022   const int RADIX = (1 << LOG2_RADIX);
2023   for (int step = (1 << (LOG2_RADIX*3)); step > 1; step >>= LOG2_RADIX) {
2024     while ((mid = lower + step) < upper) {
2025       assert_LU_OK;
2026       NOT_PRODUCT(++pc_nmethod_stats.pc_desc_searches);
2027       if (mid->pc_offset() < pc_offset) {
2028         lower = mid;
2029       } else {
2030         upper = mid;
2031         break;
2032       }
2033     }
2034     assert_LU_OK;
2035   }
2036 
2037   // Sneak up on the value with a linear search of length ~16.
2038   while (true) {
2039     assert_LU_OK;
2040     mid = lower + 1;
2041     NOT_PRODUCT(++pc_nmethod_stats.pc_desc_searches);
2042     if (mid->pc_offset() < pc_offset) {
2043       lower = mid;
2044     } else {
2045       upper = mid;
2046       break;
2047     }
2048   }
2049 #undef assert_LU_OK
2050 
2051   if (match_desc(upper, pc_offset, approximate)) {
2052     assert(upper == linear_search(search, pc_offset, approximate), "search ok");
2053     _pc_desc_cache.add_pc_desc(upper);
2054     return upper;
2055   } else {
2056     assert(NULL == linear_search(search, pc_offset, approximate), "search ok");
2057     return NULL;
2058   }
2059 }
2060 
2061 
2062 void nmethod::check_all_dependencies(DepChange& changes) {
2063   // Checked dependencies are allocated into this ResourceMark
2064   ResourceMark rm;
2065 
2066   // Turn off dependency tracing while actually testing dependencies.
2067   NOT_PRODUCT( FlagSetting fs(TraceDependencies, false) );
2068 
2069   typedef ResourceHashtable<DependencySignature, int, &DependencySignature::hash,
2070                             &DependencySignature::equals, 11027> DepTable;
2071 
2072   DepTable* table = new DepTable();
2073 
2074   // Iterate over live nmethods and check dependencies of all nmethods that are not
2075   // marked for deoptimization. A particular dependency is only checked once.
2076   NMethodIterator iter(NMethodIterator::only_alive_and_not_unloading);
2077   while(iter.next()) {
2078     nmethod* nm = iter.method();
2079     // Only notify for live nmethods
2080     if (!nm->is_marked_for_deoptimization()) {
2081       for (Dependencies::DepStream deps(nm); deps.next(); ) {
2082         // Construct abstraction of a dependency.
2083         DependencySignature* current_sig = new DependencySignature(deps);
2084 
2085         // Determine if dependency is already checked. table->put(...) returns
2086         // 'true' if the dependency is added (i.e., was not in the hashtable).
2087         if (table->put(*current_sig, 1)) {
2088           if (deps.check_dependency() != NULL) {
2089             // Dependency checking failed. Print out information about the failed
2090             // dependency and finally fail with an assert. We can fail here, since
2091             // dependency checking is never done in a product build.
2092             tty->print_cr("Failed dependency:");
2093             changes.print();
2094             nm->print();
2095             nm->print_dependencies();
2096             assert(false, "Should have been marked for deoptimization");
2097           }
2098         }
2099       }
2100     }
2101   }
2102 }
2103 
2104 bool nmethod::check_dependency_on(DepChange& changes) {
2105   // What has happened:
2106   // 1) a new class dependee has been added
2107   // 2) dependee and all its super classes have been marked
2108   bool found_check = false;  // set true if we are upset
2109   for (Dependencies::DepStream deps(this); deps.next(); ) {
2110     // Evaluate only relevant dependencies.
2111     if (deps.spot_check_dependency_at(changes) != NULL) {
2112       found_check = true;
2113       NOT_DEBUG(break);
2114     }
2115   }
2116   return found_check;
2117 }
2118 
2119 // Called from mark_for_deoptimization, when dependee is invalidated.
2120 bool nmethod::is_dependent_on_method(Method* dependee) {
2121   for (Dependencies::DepStream deps(this); deps.next(); ) {
2122     if (deps.type() != Dependencies::evol_method)
2123       continue;
2124     Method* method = deps.method_argument(0);
2125     if (method == dependee) return true;
2126   }
2127   return false;
2128 }
2129 
2130 
2131 bool nmethod::is_patchable_at(address instr_addr) {
2132   assert(insts_contains(instr_addr), "wrong nmethod used");
2133   if (is_zombie()) {
2134     // a zombie may never be patched
2135     return false;
2136   }
2137   return true;
2138 }
2139 
2140 
2141 void nmethod_init() {
2142   // make sure you didn't forget to adjust the filler fields
2143   assert(sizeof(nmethod) % oopSize == 0, "nmethod size must be multiple of a word");
2144 }
2145 
2146 
2147 //-------------------------------------------------------------------------------------------
2148 
2149 
2150 // QQQ might we make this work from a frame??
2151 nmethodLocker::nmethodLocker(address pc) {
2152   CodeBlob* cb = CodeCache::find_blob(pc);
2153   guarantee(cb != NULL && cb->is_compiled(), "bad pc for a nmethod found");
2154   _nm = cb->as_compiled_method();
2155   lock_nmethod(_nm);
2156 }
2157 
2158 // Only JvmtiDeferredEvent::compiled_method_unload_event()
2159 // should pass zombie_ok == true.
2160 void nmethodLocker::lock_nmethod(CompiledMethod* cm, bool zombie_ok) {
2161   if (cm == NULL)  return;
2162   if (cm->is_aot()) return;  // FIXME: Revisit once _lock_count is added to aot_method
2163   nmethod* nm = cm->as_nmethod();
2164   Atomic::inc(&nm->_lock_count);
2165   assert(zombie_ok || !nm->is_zombie(), "cannot lock a zombie method: %p", nm);
2166 }
2167 
2168 void nmethodLocker::unlock_nmethod(CompiledMethod* cm) {
2169   if (cm == NULL)  return;
2170   if (cm->is_aot()) return;  // FIXME: Revisit once _lock_count is added to aot_method
2171   nmethod* nm = cm->as_nmethod();
2172   Atomic::dec(&nm->_lock_count);
2173   assert(nm->_lock_count >= 0, "unmatched nmethod lock/unlock");
2174 }
2175 
2176 
2177 // -----------------------------------------------------------------------------
2178 // Verification
2179 
2180 class VerifyOopsClosure: public OopClosure {
2181   nmethod* _nm;
2182   bool     _ok;
2183 public:
2184   VerifyOopsClosure(nmethod* nm) : _nm(nm), _ok(true) { }
2185   bool ok() { return _ok; }
2186   virtual void do_oop(oop* p) {
2187     if (oopDesc::is_oop_or_null(*p)) return;
2188     // Print diagnostic information before calling print_nmethod().
2189     // Assertions therein might prevent call from returning.
2190     tty->print_cr("*** non-oop " PTR_FORMAT " found at " PTR_FORMAT " (offset %d)",
2191                   p2i(*p), p2i(p), (int)((intptr_t)p - (intptr_t)_nm));
2192     if (_ok) {
2193       _nm->print_nmethod(true);
2194       _ok = false;
2195     }
2196   }
2197   virtual void do_oop(narrowOop* p) { ShouldNotReachHere(); }
2198 };
2199 
2200 void nmethod::verify() {
2201 
2202   // Hmm. OSR methods can be deopted but not marked as zombie or not_entrant
2203   // seems odd.
2204 
2205   if (is_zombie() || is_not_entrant() || is_unloaded())
2206     return;
2207 
2208   // Make sure all the entry points are correctly aligned for patching.
2209   NativeJump::check_verified_entry_alignment(entry_point(), verified_entry_point());
2210 
2211   // assert(oopDesc::is_oop(method()), "must be valid");
2212 
2213   ResourceMark rm;
2214 
2215   if (!CodeCache::contains(this)) {
2216     fatal("nmethod at " INTPTR_FORMAT " not in zone", p2i(this));
2217   }
2218 
2219   if(is_native_method() )
2220     return;
2221 
2222   nmethod* nm = CodeCache::find_nmethod(verified_entry_point());
2223   if (nm != this) {
2224     fatal("findNMethod did not find this nmethod (" INTPTR_FORMAT ")", p2i(this));
2225   }
2226 
2227   for (PcDesc* p = scopes_pcs_begin(); p < scopes_pcs_end(); p++) {
2228     if (! p->verify(this)) {
2229       tty->print_cr("\t\tin nmethod at " INTPTR_FORMAT " (pcs)", p2i(this));
2230     }
2231   }
2232 
2233 #ifdef ASSERT
2234 #if INCLUDE_JVMCI
2235   {
2236     // Verify that implicit exceptions that deoptimize have a PcDesc and OopMap
2237     ImmutableOopMapSet* oms = oop_maps();
2238     ImplicitExceptionTable implicit_table(this);
2239     for (uint i = 0; i < implicit_table.len(); i++) {
2240       int exec_offset = (int) implicit_table.get_exec_offset(i);
2241       if (implicit_table.get_exec_offset(i) == implicit_table.get_cont_offset(i)) {
2242         assert(pc_desc_at(code_begin() + exec_offset) != NULL, "missing PcDesc");
2243         bool found = false;
2244         for (int i = 0, imax = oms->count(); i < imax; i++) {
2245           if (oms->pair_at(i)->pc_offset() == exec_offset) {
2246             found = true;
2247             break;
2248           }
2249         }
2250         assert(found, "missing oopmap");
2251       }
2252     }
2253   }
2254 #endif
2255 #endif
2256 
2257   VerifyOopsClosure voc(this);
2258   oops_do(&voc);
2259   assert(voc.ok(), "embedded oops must be OK");
2260   Universe::heap()->verify_nmethod(this);
2261 
2262   verify_scopes();
2263 }
2264 
2265 
2266 void nmethod::verify_interrupt_point(address call_site) {
2267   // Verify IC only when nmethod installation is finished.
2268   if (!is_not_installed()) {
2269     if (CompiledICLocker::is_safe(this)) {
2270       CompiledIC_at(this, call_site);
2271     } else {
2272       CompiledICLocker ml_verify(this);
2273       CompiledIC_at(this, call_site);
2274     }
2275   }
2276 
2277   PcDesc* pd = pc_desc_at(nativeCall_at(call_site)->return_address());
2278   assert(pd != NULL, "PcDesc must exist");
2279   for (ScopeDesc* sd = new ScopeDesc(this, pd->scope_decode_offset(),
2280                                      pd->obj_decode_offset(), pd->should_reexecute(), pd->rethrow_exception(),
2281                                      pd->return_oop());
2282        !sd->is_top(); sd = sd->sender()) {
2283     sd->verify();
2284   }
2285 }
2286 
2287 void nmethod::verify_scopes() {
2288   if( !method() ) return;       // Runtime stubs have no scope
2289   if (method()->is_native()) return; // Ignore stub methods.
2290   // iterate through all interrupt point
2291   // and verify the debug information is valid.
2292   RelocIterator iter((nmethod*)this);
2293   while (iter.next()) {
2294     address stub = NULL;
2295     switch (iter.type()) {
2296       case relocInfo::virtual_call_type:
2297         verify_interrupt_point(iter.addr());
2298         break;
2299       case relocInfo::opt_virtual_call_type:
2300         stub = iter.opt_virtual_call_reloc()->static_stub(false);
2301         verify_interrupt_point(iter.addr());
2302         break;
2303       case relocInfo::static_call_type:
2304         stub = iter.static_call_reloc()->static_stub(false);
2305         //verify_interrupt_point(iter.addr());
2306         break;
2307       case relocInfo::runtime_call_type:
2308       case relocInfo::runtime_call_w_cp_type: {
2309         address destination = iter.reloc()->value();
2310         // Right now there is no way to find out which entries support
2311         // an interrupt point.  It would be nice if we had this
2312         // information in a table.
2313         break;
2314       }
2315       default:
2316         break;
2317     }
2318     assert(stub == NULL || stub_contains(stub), "static call stub outside stub section");
2319   }
2320 }
2321 
2322 
2323 // -----------------------------------------------------------------------------
2324 // Printing operations
2325 
2326 void nmethod::print() const {
2327   ttyLocker ttyl;   // keep the following output all in one block
2328   print(tty);
2329 }
2330 
2331 void nmethod::print(outputStream* st) const {
2332   ResourceMark rm;
2333 
2334   st->print("Compiled method ");
2335 
2336   if (is_compiled_by_c1()) {
2337     st->print("(c1) ");
2338   } else if (is_compiled_by_c2()) {
2339     st->print("(c2) ");
2340   } else if (is_compiled_by_jvmci()) {
2341     st->print("(JVMCI) ");
2342   } else {
2343     st->print("(n/a) ");
2344   }
2345 
2346   print_on(tty, NULL);
2347 
2348   if (WizardMode) {
2349     st->print("((nmethod*) " INTPTR_FORMAT ") ", p2i(this));
2350     st->print(" for method " INTPTR_FORMAT , p2i(method()));
2351     st->print(" { ");
2352     st->print_cr("%s ", state());
2353     st->print_cr("}:");
2354   }
2355   if (size              () > 0) st->print_cr(" total in heap  [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
2356                                              p2i(this),
2357                                              p2i(this) + size(),
2358                                              size());
2359   if (relocation_size   () > 0) st->print_cr(" relocation     [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
2360                                              p2i(relocation_begin()),
2361                                              p2i(relocation_end()),
2362                                              relocation_size());
2363   if (consts_size       () > 0) st->print_cr(" constants      [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
2364                                              p2i(consts_begin()),
2365                                              p2i(consts_end()),
2366                                              consts_size());
2367   if (insts_size        () > 0) st->print_cr(" main code      [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
2368                                              p2i(insts_begin()),
2369                                              p2i(insts_end()),
2370                                              insts_size());
2371   if (stub_size         () > 0) st->print_cr(" stub code      [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
2372                                              p2i(stub_begin()),
2373                                              p2i(stub_end()),
2374                                              stub_size());
2375   if (oops_size         () > 0) st->print_cr(" oops           [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
2376                                              p2i(oops_begin()),
2377                                              p2i(oops_end()),
2378                                              oops_size());
2379   if (metadata_size     () > 0) st->print_cr(" metadata       [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
2380                                              p2i(metadata_begin()),
2381                                              p2i(metadata_end()),
2382                                              metadata_size());
2383   if (scopes_data_size  () > 0) st->print_cr(" scopes data    [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
2384                                              p2i(scopes_data_begin()),
2385                                              p2i(scopes_data_end()),
2386                                              scopes_data_size());
2387   if (scopes_pcs_size   () > 0) st->print_cr(" scopes pcs     [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
2388                                              p2i(scopes_pcs_begin()),
2389                                              p2i(scopes_pcs_end()),
2390                                              scopes_pcs_size());
2391   if (dependencies_size () > 0) st->print_cr(" dependencies   [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
2392                                              p2i(dependencies_begin()),
2393                                              p2i(dependencies_end()),
2394                                              dependencies_size());
2395   if (handler_table_size() > 0) st->print_cr(" handler table  [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
2396                                              p2i(handler_table_begin()),
2397                                              p2i(handler_table_end()),
2398                                              handler_table_size());
2399   if (nul_chk_table_size() > 0) st->print_cr(" nul chk table  [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
2400                                              p2i(nul_chk_table_begin()),
2401                                              p2i(nul_chk_table_end()),
2402                                              nul_chk_table_size());
2403 #if INCLUDE_JVMCI
2404   if (speculations_size () > 0) st->print_cr(" speculations   [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
2405                                              p2i(speculations_begin()),
2406                                              p2i(speculations_end()),
2407                                              speculations_size());
2408   if (jvmci_data_size   () > 0) st->print_cr(" JVMCI data     [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
2409                                              p2i(jvmci_data_begin()),
2410                                              p2i(jvmci_data_end()),
2411                                              jvmci_data_size());
2412 #endif
2413 }
2414 
2415 void nmethod::print_code() {
2416   HandleMark hm;
2417   ResourceMark m;
2418   ttyLocker ttyl;
2419   // Call the specialized decode method of this class.
2420   decode(tty);
2421 }
2422 
2423 #ifndef PRODUCT  // called InstanceKlass methods are available only then. Declared as PRODUCT_RETURN
2424 
2425 void nmethod::print_dependencies() {
2426   ResourceMark rm;
2427   ttyLocker ttyl;   // keep the following output all in one block
2428   tty->print_cr("Dependencies:");
2429   for (Dependencies::DepStream deps(this); deps.next(); ) {
2430     deps.print_dependency();
2431     Klass* ctxk = deps.context_type();
2432     if (ctxk != NULL) {
2433       if (ctxk->is_instance_klass() && InstanceKlass::cast(ctxk)->is_dependent_nmethod(this)) {
2434         tty->print_cr("   [nmethod<=klass]%s", ctxk->external_name());
2435       }
2436     }
2437     deps.log_dependency();  // put it into the xml log also
2438   }
2439 }
2440 #endif
2441 
2442 #if defined(SUPPORT_DATA_STRUCTS)
2443 
2444 // Print the oops from the underlying CodeBlob.
2445 void nmethod::print_oops(outputStream* st) {
2446   HandleMark hm;
2447   ResourceMark m;
2448   st->print("Oops:");
2449   if (oops_begin() < oops_end()) {
2450     st->cr();
2451     for (oop* p = oops_begin(); p < oops_end(); p++) {
2452       Disassembler::print_location((unsigned char*)p, (unsigned char*)oops_begin(), (unsigned char*)oops_end(), st, true, false);
2453       st->print(PTR_FORMAT " ", *((uintptr_t*)p));
2454       if (*p == Universe::non_oop_word()) {
2455         st->print_cr("NON_OOP");
2456         continue;  // skip non-oops
2457       }
2458       if (*p == NULL) {
2459         st->print_cr("NULL-oop");
2460         continue;  // skip non-oops
2461       }
2462       (*p)->print_value_on(st);
2463       st->cr();
2464     }
2465   } else {
2466     st->print_cr(" <list empty>");
2467   }
2468 }
2469 
2470 // Print metadata pool.
2471 void nmethod::print_metadata(outputStream* st) {
2472   HandleMark hm;
2473   ResourceMark m;
2474   st->print("Metadata:");
2475   if (metadata_begin() < metadata_end()) {
2476     st->cr();
2477     for (Metadata** p = metadata_begin(); p < metadata_end(); p++) {
2478       Disassembler::print_location((unsigned char*)p, (unsigned char*)metadata_begin(), (unsigned char*)metadata_end(), st, true, false);
2479       st->print(PTR_FORMAT " ", *((uintptr_t*)p));
2480       if (*p && *p != Universe::non_oop_word()) {
2481         (*p)->print_value_on(st);
2482       }
2483       st->cr();
2484     }
2485   } else {
2486     st->print_cr(" <list empty>");
2487   }
2488 }
2489 
2490 #ifndef PRODUCT  // ScopeDesc::print_on() is available only then. Declared as PRODUCT_RETURN
2491 void nmethod::print_scopes_on(outputStream* st) {
2492   // Find the first pc desc for all scopes in the code and print it.
2493   ResourceMark rm;
2494   st->print("scopes:");
2495   if (scopes_pcs_begin() < scopes_pcs_end()) {
2496     st->cr();
2497     for (PcDesc* p = scopes_pcs_begin(); p < scopes_pcs_end(); p++) {
2498       if (p->scope_decode_offset() == DebugInformationRecorder::serialized_null)
2499         continue;
2500 
2501       ScopeDesc* sd = scope_desc_at(p->real_pc(this));
2502       while (sd != NULL) {
2503         sd->print_on(st, p);  // print output ends with a newline
2504         sd = sd->sender();
2505       }
2506     }
2507   } else {
2508     st->print_cr(" <list empty>");
2509   }
2510 }
2511 #endif
2512 
2513 #ifndef PRODUCT  // RelocIterator does support printing only then.
2514 void nmethod::print_relocations() {
2515   ResourceMark m;       // in case methods get printed via the debugger
2516   tty->print_cr("relocations:");
2517   RelocIterator iter(this);
2518   iter.print();
2519 }
2520 #endif
2521 
2522 void nmethod::print_pcs_on(outputStream* st) {
2523   ResourceMark m;       // in case methods get printed via debugger
2524   st->print("pc-bytecode offsets:");
2525   if (scopes_pcs_begin() < scopes_pcs_end()) {
2526     st->cr();
2527     for (PcDesc* p = scopes_pcs_begin(); p < scopes_pcs_end(); p++) {
2528       p->print_on(st, this);  // print output ends with a newline
2529     }
2530   } else {
2531     st->print_cr(" <list empty>");
2532   }
2533 }
2534 
2535 void nmethod::print_handler_table() {
2536   ExceptionHandlerTable(this).print();
2537 }
2538 
2539 void nmethod::print_nul_chk_table() {
2540   ImplicitExceptionTable(this).print(code_begin());
2541 }
2542 
2543 void nmethod::print_recorded_oops() {
2544   const int n = oops_count();
2545   const int log_n = (n<10) ? 1 : (n<100) ? 2 : (n<1000) ? 3 : (n<10000) ? 4 : 6;
2546   tty->print("Recorded oops:");
2547   if (n > 0) {
2548     tty->cr();
2549     for (int i = 0; i < n; i++) {
2550       oop o = oop_at(i);
2551       tty->print("#%*d: " INTPTR_FORMAT " ", log_n, i, p2i(o));
2552       if (o == (oop)Universe::non_oop_word()) {
2553         tty->print("non-oop word");
2554       } else if (o == NULL) {
2555         tty->print("NULL-oop");
2556       } else {
2557         o->print_value_on(tty);
2558       }
2559       tty->cr();
2560     }
2561   } else {
2562     tty->print_cr(" <list empty>");
2563   }
2564 }
2565 
2566 void nmethod::print_recorded_metadata() {
2567   const int n = metadata_count();
2568   const int log_n = (n<10) ? 1 : (n<100) ? 2 : (n<1000) ? 3 : (n<10000) ? 4 : 6;
2569   tty->print("Recorded metadata:");
2570   if (n > 0) {
2571     tty->cr();
2572     for (int i = 0; i < n; i++) {
2573       Metadata* m = metadata_at(i);
2574       tty->print("#%*d: " INTPTR_FORMAT " ", log_n, i, p2i(m));
2575       if (m == (Metadata*)Universe::non_oop_word()) {
2576         tty->print("non-metadata word");
2577       } else if (m == NULL) {
2578         tty->print("NULL-oop");
2579       } else {
2580         Metadata::print_value_on_maybe_null(tty, m);
2581       }
2582       tty->cr();
2583     }
2584   } else {
2585     tty->print_cr(" <list empty>");
2586   }
2587 }
2588 #endif
2589 
2590 #if defined(SUPPORT_ASSEMBLY) || defined(SUPPORT_ABSTRACT_ASSEMBLY)
2591 
2592 void nmethod::print_constant_pool(outputStream* st) {
2593   //-----------------------------------
2594   //---<  Print the constant pool  >---
2595   //-----------------------------------
2596   int consts_size = this->consts_size();
2597   if ( consts_size > 0 ) {
2598     unsigned char* cstart = this->consts_begin();
2599     unsigned char* cp     = cstart;
2600     unsigned char* cend   = cp + consts_size;
2601     unsigned int   bytes_per_line = 4;
2602     unsigned int   CP_alignment   = 8;
2603     unsigned int   n;
2604 
2605     st->cr();
2606 
2607     //---<  print CP header to make clear what's printed  >---
2608     if( ((uintptr_t)cp&(CP_alignment-1)) == 0 ) {
2609       n = bytes_per_line;
2610       st->print_cr("[Constant Pool]");
2611       Disassembler::print_location(cp, cstart, cend, st, true, true);
2612       Disassembler::print_hexdata(cp, n, st, true);
2613       st->cr();
2614     } else {
2615       n = (uintptr_t)cp&(bytes_per_line-1);
2616       st->print_cr("[Constant Pool (unaligned)]");
2617     }
2618 
2619     //---<  print CP contents, bytes_per_line at a time  >---
2620     while (cp < cend) {
2621       Disassembler::print_location(cp, cstart, cend, st, true, false);
2622       Disassembler::print_hexdata(cp, n, st, false);
2623       cp += n;
2624       n   = bytes_per_line;
2625       st->cr();
2626     }
2627 
2628     //---<  Show potential alignment gap between constant pool and code  >---
2629     cend = code_begin();
2630     if( cp < cend ) {
2631       n = 4;
2632       st->print_cr("[Code entry alignment]");
2633       while (cp < cend) {
2634         Disassembler::print_location(cp, cstart, cend, st, false, false);
2635         cp += n;
2636         st->cr();
2637       }
2638     }
2639   } else {
2640     st->print_cr("[Constant Pool (empty)]");
2641   }
2642   st->cr();
2643 }
2644 
2645 #endif
2646 
2647 // Disassemble this nmethod.
2648 // Print additional debug information, if requested. This could be code
2649 // comments, block comments, profiling counters, etc.
2650 // The undisassembled format is useful no disassembler library is available.
2651 // The resulting hex dump (with markers) can be disassembled later, or on
2652 // another system, when/where a disassembler library is available.
2653 void nmethod::decode2(outputStream* ost) const {
2654 
2655   // Called from frame::back_trace_with_decode without ResourceMark.
2656   ResourceMark rm;
2657 
2658   // Make sure we have a valid stream to print on.
2659   outputStream* st = ost ? ost : tty;
2660 
2661 #if defined(SUPPORT_ABSTRACT_ASSEMBLY) && ! defined(SUPPORT_ASSEMBLY)
2662   const bool use_compressed_format    = true;
2663   const bool compressed_with_comments = use_compressed_format && (AbstractDisassembler::show_comment() ||
2664                                                                   AbstractDisassembler::show_block_comment());
2665 #else
2666   const bool use_compressed_format    = Disassembler::is_abstract();
2667   const bool compressed_with_comments = use_compressed_format && (AbstractDisassembler::show_comment() ||
2668                                                                   AbstractDisassembler::show_block_comment());
2669 #endif
2670 
2671   st->cr();
2672   this->print(st);
2673   st->cr();
2674 
2675 #if defined(SUPPORT_ASSEMBLY)
2676   //----------------------------------
2677   //---<  Print real disassembly  >---
2678   //----------------------------------
2679   if (! use_compressed_format) {
2680     Disassembler::decode(const_cast<nmethod*>(this), st);
2681     return;
2682   }
2683 #endif
2684 
2685 #if defined(SUPPORT_ABSTRACT_ASSEMBLY)
2686 
2687   // Compressed undisassembled disassembly format.
2688   // The following stati are defined/supported:
2689   //   = 0 - currently at bol() position, nothing printed yet on current line.
2690   //   = 1 - currently at position after print_location().
2691   //   > 1 - in the midst of printing instruction stream bytes.
2692   int        compressed_format_idx    = 0;
2693   int        code_comment_column      = 0;
2694   const int  instr_maxlen             = Assembler::instr_maxlen();
2695   const uint tabspacing               = 8;
2696   unsigned char* start = this->code_begin();
2697   unsigned char* p     = this->code_begin();
2698   unsigned char* end   = this->code_end();
2699   unsigned char* pss   = p; // start of a code section (used for offsets)
2700 
2701   if ((start == NULL) || (end == NULL)) {
2702     st->print_cr("PrintAssembly not possible due to uninitialized section pointers");
2703     return;
2704   }
2705 #endif
2706 
2707 #if defined(SUPPORT_ABSTRACT_ASSEMBLY)
2708   //---<  plain abstract disassembly, no comments or anything, just section headers  >---
2709   if (use_compressed_format && ! compressed_with_comments) {
2710     const_cast<nmethod*>(this)->print_constant_pool(st);
2711 
2712     //---<  Open the output (Marker for post-mortem disassembler)  >---
2713     st->print_cr("[MachCode]");
2714     const char* header = NULL;
2715     address p0 = p;
2716     while (p < end) {
2717       address pp = p;
2718       while ((p < end) && (header == NULL)) {
2719         header = nmethod_section_label(p);
2720         pp  = p;
2721         p  += Assembler::instr_len(p);
2722       }
2723       if (pp > p0) {
2724         AbstractDisassembler::decode_range_abstract(p0, pp, start, end, st, Assembler::instr_maxlen());
2725         p0 = pp;
2726         p  = pp;
2727         header = NULL;
2728       } else if (header != NULL) {
2729         st->bol();
2730         st->print_cr("%s", header);
2731         header = NULL;
2732       }
2733     }
2734     //---<  Close the output (Marker for post-mortem disassembler)  >---
2735     st->bol();
2736     st->print_cr("[/MachCode]");
2737     return;
2738   }
2739 #endif
2740 
2741 #if defined(SUPPORT_ABSTRACT_ASSEMBLY)
2742   //---<  abstract disassembly with comments and section headers merged in  >---
2743   if (compressed_with_comments) {
2744     const_cast<nmethod*>(this)->print_constant_pool(st);
2745 
2746     //---<  Open the output (Marker for post-mortem disassembler)  >---
2747     st->print_cr("[MachCode]");
2748     while ((p < end) && (p != NULL)) {
2749       const int instruction_size_in_bytes = Assembler::instr_len(p);
2750 
2751       //---<  Block comments for nmethod. Interrupts instruction stream, if any.  >---
2752       // Outputs a bol() before and a cr() after, but only if a comment is printed.
2753       // Prints nmethod_section_label as well.
2754       if (AbstractDisassembler::show_block_comment()) {
2755         print_block_comment(st, p);
2756         if (st->position() == 0) {
2757           compressed_format_idx = 0;
2758         }
2759       }
2760 
2761       //---<  New location information after line break  >---
2762       if (compressed_format_idx == 0) {
2763         code_comment_column   = Disassembler::print_location(p, pss, end, st, false, false);
2764         compressed_format_idx = 1;
2765       }
2766 
2767       //---<  Code comment for current instruction. Address range [p..(p+len))  >---
2768       unsigned char* p_end = p + (ssize_t)instruction_size_in_bytes;
2769       S390_ONLY(if (p_end > end) p_end = end;) // avoid getting past the end
2770 
2771       if (AbstractDisassembler::show_comment() && const_cast<nmethod*>(this)->has_code_comment(p, p_end)) {
2772         //---<  interrupt instruction byte stream for code comment  >---
2773         if (compressed_format_idx > 1) {
2774           st->cr();  // interrupt byte stream
2775           st->cr();  // add an empty line
2776           code_comment_column = Disassembler::print_location(p, pss, end, st, false, false);
2777         }
2778         const_cast<nmethod*>(this)->print_code_comment_on(st, code_comment_column, p, p_end );
2779         st->bol();
2780         compressed_format_idx = 0;
2781       }
2782 
2783       //---<  New location information after line break  >---
2784       if (compressed_format_idx == 0) {
2785         code_comment_column   = Disassembler::print_location(p, pss, end, st, false, false);
2786         compressed_format_idx = 1;
2787       }
2788 
2789       //---<  Nicely align instructions for readability  >---
2790       if (compressed_format_idx > 1) {
2791         Disassembler::print_delimiter(st);
2792       }
2793 
2794       //---<  Now, finally, print the actual instruction bytes  >---
2795       unsigned char* p0 = p;
2796       p = Disassembler::decode_instruction_abstract(p, st, instruction_size_in_bytes, instr_maxlen);
2797       compressed_format_idx += p - p0;
2798 
2799       if (Disassembler::start_newline(compressed_format_idx-1)) {
2800         st->cr();
2801         compressed_format_idx = 0;
2802       }
2803     }
2804     //---<  Close the output (Marker for post-mortem disassembler)  >---
2805     st->bol();
2806     st->print_cr("[/MachCode]");
2807     return;
2808   }
2809 #endif
2810 }
2811 
2812 #if defined(SUPPORT_ASSEMBLY) || defined(SUPPORT_ABSTRACT_ASSEMBLY)
2813 
2814 const char* nmethod::reloc_string_for(u_char* begin, u_char* end) {
2815   RelocIterator iter(this, begin, end);
2816   bool have_one = false;
2817   while (iter.next()) {
2818     have_one = true;
2819     switch (iter.type()) {
2820         case relocInfo::none:                  return "no_reloc";
2821         case relocInfo::oop_type: {
2822           // Get a non-resizable resource-allocated stringStream.
2823           // Our callees make use of (nested) ResourceMarks.
2824           stringStream st(NEW_RESOURCE_ARRAY(char, 1024), 1024);
2825           oop_Relocation* r = iter.oop_reloc();
2826           oop obj = r->oop_value();
2827           st.print("oop(");
2828           if (obj == NULL) st.print("NULL");
2829           else obj->print_value_on(&st);
2830           st.print(")");
2831           return st.as_string();
2832         }
2833         case relocInfo::metadata_type: {
2834           stringStream st;
2835           metadata_Relocation* r = iter.metadata_reloc();
2836           Metadata* obj = r->metadata_value();
2837           st.print("metadata(");
2838           if (obj == NULL) st.print("NULL");
2839           else obj->print_value_on(&st);
2840           st.print(")");
2841           return st.as_string();
2842         }
2843         case relocInfo::runtime_call_type:
2844         case relocInfo::runtime_call_w_cp_type: {
2845           stringStream st;
2846           st.print("runtime_call");
2847           CallRelocation* r = (CallRelocation*)iter.reloc();
2848           address dest = r->destination();
2849           CodeBlob* cb = CodeCache::find_blob(dest);
2850           if (cb != NULL) {
2851             st.print(" %s", cb->name());
2852           } else {
2853             ResourceMark rm;
2854             const int buflen = 1024;
2855             char* buf = NEW_RESOURCE_ARRAY(char, buflen);
2856             int offset;
2857             if (os::dll_address_to_function_name(dest, buf, buflen, &offset)) {
2858               st.print(" %s", buf);
2859               if (offset != 0) {
2860                 st.print("+%d", offset);
2861               }
2862             }
2863           }
2864           return st.as_string();
2865         }
2866         case relocInfo::virtual_call_type: {
2867           stringStream st;
2868           st.print_raw("virtual_call");
2869           virtual_call_Relocation* r = iter.virtual_call_reloc();
2870           Method* m = r->method_value();
2871           if (m != NULL) {
2872             assert(m->is_method(), "");
2873             m->print_short_name(&st);
2874           }
2875           return st.as_string();
2876         }
2877         case relocInfo::opt_virtual_call_type: {
2878           stringStream st;
2879           st.print_raw("optimized virtual_call");
2880           opt_virtual_call_Relocation* r = iter.opt_virtual_call_reloc();
2881           Method* m = r->method_value();
2882           if (m != NULL) {
2883             assert(m->is_method(), "");
2884             m->print_short_name(&st);
2885           }
2886           return st.as_string();
2887         }
2888         case relocInfo::static_call_type: {
2889           stringStream st;
2890           st.print_raw("static_call");
2891           static_call_Relocation* r = iter.static_call_reloc();
2892           Method* m = r->method_value();
2893           if (m != NULL) {
2894             assert(m->is_method(), "");
2895             m->print_short_name(&st);
2896           }
2897           return st.as_string();
2898         }
2899         case relocInfo::static_stub_type:      return "static_stub";
2900         case relocInfo::external_word_type:    return "external_word";
2901         case relocInfo::internal_word_type:    return "internal_word";
2902         case relocInfo::section_word_type:     return "section_word";
2903         case relocInfo::poll_type:             return "poll";
2904         case relocInfo::poll_return_type:      return "poll_return";
2905         case relocInfo::trampoline_stub_type:  return "trampoline_stub";
2906         case relocInfo::type_mask:             return "type_bit_mask";
2907 
2908         default:
2909           break;
2910     }
2911   }
2912   return have_one ? "other" : NULL;
2913 }
2914 
2915 // Return a the last scope in (begin..end]
2916 ScopeDesc* nmethod::scope_desc_in(address begin, address end) {
2917   PcDesc* p = pc_desc_near(begin+1);
2918   if (p != NULL && p->real_pc(this) <= end) {
2919     return new ScopeDesc(this, p->scope_decode_offset(),
2920                          p->obj_decode_offset(), p->should_reexecute(), p->rethrow_exception(),
2921                          p->return_oop());
2922   }
2923   return NULL;
2924 }
2925 
2926 const char* nmethod::nmethod_section_label(address pos) const {
2927   const char* label = NULL;
2928   if (pos == code_begin())                                              label = "[Instructions begin]";
2929   if (pos == entry_point())                                             label = "[Entry Point]";
2930   if (pos == verified_entry_point())                                    label = "[Verified Entry Point]";
2931   if (has_method_handle_invokes() && (pos == deopt_mh_handler_begin())) label = "[Deopt MH Handler Code]";
2932   if (pos == consts_begin() && pos != insts_begin())                    label = "[Constants]";
2933   // Check stub_code before checking exception_handler or deopt_handler.
2934   if (pos == this->stub_begin())                                        label = "[Stub Code]";
2935   if (JVMCI_ONLY(_exception_offset >= 0 &&) pos == exception_begin())           label = "[Exception Handler]";
2936   if (JVMCI_ONLY(_deopt_handler_begin != NULL &&) pos == deopt_handler_begin()) label = "[Deopt Handler Code]";
2937   return label;
2938 }
2939 
2940 void nmethod::print_nmethod_labels(outputStream* stream, address block_begin, bool print_section_labels) const {
2941   if (print_section_labels) {
2942     const char* label = nmethod_section_label(block_begin);
2943     if (label != NULL) {
2944       stream->bol();
2945       stream->print_cr("%s", label);
2946     }
2947   }
2948 
2949   if (block_begin == entry_point()) {
2950     methodHandle m = method();
2951     if (m.not_null()) {
2952       stream->print("  # ");
2953       m->print_value_on(stream);
2954       stream->cr();
2955     }
2956     if (m.not_null() && !is_osr_method()) {
2957       ResourceMark rm;
2958       int sizeargs = m->size_of_parameters();
2959       BasicType* sig_bt = NEW_RESOURCE_ARRAY(BasicType, sizeargs);
2960       VMRegPair* regs   = NEW_RESOURCE_ARRAY(VMRegPair, sizeargs);
2961       {
2962         int sig_index = 0;
2963         if (!m->is_static())
2964           sig_bt[sig_index++] = T_OBJECT; // 'this'
2965         for (SignatureStream ss(m->signature()); !ss.at_return_type(); ss.next()) {
2966           BasicType t = ss.type();
2967           sig_bt[sig_index++] = t;
2968           if (type2size[t] == 2) {
2969             sig_bt[sig_index++] = T_VOID;
2970           } else {
2971             assert(type2size[t] == 1, "size is 1 or 2");
2972           }
2973         }
2974         assert(sig_index == sizeargs, "");
2975       }
2976       const char* spname = "sp"; // make arch-specific?
2977       intptr_t out_preserve = SharedRuntime::java_calling_convention(sig_bt, regs, sizeargs, false);
2978       int stack_slot_offset = this->frame_size() * wordSize;
2979       int tab1 = 14, tab2 = 24;
2980       int sig_index = 0;
2981       int arg_index = (m->is_static() ? 0 : -1);
2982       bool did_old_sp = false;
2983       for (SignatureStream ss(m->signature()); !ss.at_return_type(); ) {
2984         bool at_this = (arg_index == -1);
2985         bool at_old_sp = false;
2986         BasicType t = (at_this ? T_OBJECT : ss.type());
2987         assert(t == sig_bt[sig_index], "sigs in sync");
2988         if (at_this)
2989           stream->print("  # this: ");
2990         else
2991           stream->print("  # parm%d: ", arg_index);
2992         stream->move_to(tab1);
2993         VMReg fst = regs[sig_index].first();
2994         VMReg snd = regs[sig_index].second();
2995         if (fst->is_reg()) {
2996           stream->print("%s", fst->name());
2997           if (snd->is_valid())  {
2998             stream->print(":%s", snd->name());
2999           }
3000         } else if (fst->is_stack()) {
3001           int offset = fst->reg2stack() * VMRegImpl::stack_slot_size + stack_slot_offset;
3002           if (offset == stack_slot_offset)  at_old_sp = true;
3003           stream->print("[%s+0x%x]", spname, offset);
3004         } else {
3005           stream->print("reg%d:%d??", (int)(intptr_t)fst, (int)(intptr_t)snd);
3006         }
3007         stream->print(" ");
3008         stream->move_to(tab2);
3009         stream->print("= ");
3010         if (at_this) {
3011           m->method_holder()->print_value_on(stream);
3012         } else {
3013           bool did_name = false;
3014           if (!at_this && ss.is_object()) {
3015             Symbol* name = ss.as_symbol_or_null();
3016             if (name != NULL) {
3017               name->print_value_on(stream);
3018               did_name = true;
3019             }
3020           }
3021           if (!did_name)
3022             stream->print("%s", type2name(t));
3023         }
3024         if (at_old_sp) {
3025           stream->print("  (%s of caller)", spname);
3026           did_old_sp = true;
3027         }
3028         stream->cr();
3029         sig_index += type2size[t];
3030         arg_index += 1;
3031         if (!at_this)  ss.next();
3032       }
3033       if (!did_old_sp) {
3034         stream->print("  # ");
3035         stream->move_to(tab1);
3036         stream->print("[%s+0x%x]", spname, stack_slot_offset);
3037         stream->print("  (%s of caller)", spname);
3038         stream->cr();
3039       }
3040     }
3041   }
3042 }
3043 
3044 // Returns whether this nmethod has code comments.
3045 bool nmethod::has_code_comment(address begin, address end) {
3046   // scopes?
3047   ScopeDesc* sd  = scope_desc_in(begin, end);
3048   if (sd != NULL) return true;
3049 
3050   // relocations?
3051   const char* str = reloc_string_for(begin, end);
3052   if (str != NULL) return true;
3053 
3054   // implicit exceptions?
3055   int cont_offset = ImplicitExceptionTable(this).continuation_offset(begin - code_begin());
3056   if (cont_offset != 0) return true;
3057 
3058   return false;
3059 }
3060 
3061 void nmethod::print_code_comment_on(outputStream* st, int column, address begin, address end) {
3062   ImplicitExceptionTable implicit_table(this);
3063   int pc_offset = begin - code_begin();
3064   int cont_offset = implicit_table.continuation_offset(pc_offset);
3065   bool oop_map_required = false;
3066   if (cont_offset != 0) {
3067     st->move_to(column, 6, 0);
3068     if (pc_offset == cont_offset) {
3069       st->print("; implicit exception: deoptimizes");
3070       oop_map_required = true;
3071     } else {
3072       st->print("; implicit exception: dispatches to " INTPTR_FORMAT, p2i(code_begin() + cont_offset));
3073     }
3074   }
3075 
3076   // Find an oopmap in (begin, end].  We use the odd half-closed
3077   // interval so that oop maps and scope descs which are tied to the
3078   // byte after a call are printed with the call itself.  OopMaps
3079   // associated with implicit exceptions are printed with the implicit
3080   // instruction.
3081   address base = code_begin();
3082   ImmutableOopMapSet* oms = oop_maps();
3083   if (oms != NULL) {
3084     for (int i = 0, imax = oms->count(); i < imax; i++) {
3085       const ImmutableOopMapPair* pair = oms->pair_at(i);
3086       const ImmutableOopMap* om = pair->get_from(oms);
3087       address pc = base + pair->pc_offset();
3088       if (pc >= begin) {
3089 #if INCLUDE_JVMCI
3090         bool is_implicit_deopt = implicit_table.continuation_offset(pair->pc_offset()) == (uint) pair->pc_offset();
3091 #else
3092         bool is_implicit_deopt = false;
3093 #endif
3094         if (is_implicit_deopt ? pc == begin : pc > begin && pc <= end) {
3095           st->move_to(column, 6, 0);
3096           st->print("; ");
3097           om->print_on(st);
3098           oop_map_required = false;
3099         }
3100       }
3101       if (pc > end) {
3102         break;
3103       }
3104     }
3105   }
3106   assert(!oop_map_required, "missed oopmap");
3107 
3108   // Print any debug info present at this pc.
3109   ScopeDesc* sd  = scope_desc_in(begin, end);
3110   if (sd != NULL) {
3111     st->move_to(column, 6, 0);
3112     if (sd->bci() == SynchronizationEntryBCI) {
3113       st->print(";*synchronization entry");
3114     } else if (sd->bci() == AfterBci) {
3115       st->print(";* method exit (unlocked if synchronized)");
3116     } else if (sd->bci() == UnwindBci) {
3117       st->print(";* unwind (locked if synchronized)");
3118     } else if (sd->bci() == AfterExceptionBci) {
3119       st->print(";* unwind (unlocked if synchronized)");
3120     } else if (sd->bci() == UnknownBci) {
3121       st->print(";* unknown");
3122     } else if (sd->bci() == InvalidFrameStateBci) {
3123       st->print(";* invalid frame state");
3124     } else {
3125       if (sd->method() == NULL) {
3126         st->print("method is NULL");
3127       } else if (sd->method()->is_native()) {
3128         st->print("method is native");
3129       } else {
3130         Bytecodes::Code bc = sd->method()->java_code_at(sd->bci());
3131         st->print(";*%s", Bytecodes::name(bc));
3132         switch (bc) {
3133         case Bytecodes::_invokevirtual:
3134         case Bytecodes::_invokespecial:
3135         case Bytecodes::_invokestatic:
3136         case Bytecodes::_invokeinterface:
3137           {
3138             Bytecode_invoke invoke(sd->method(), sd->bci());
3139             st->print(" ");
3140             if (invoke.name() != NULL)
3141               invoke.name()->print_symbol_on(st);
3142             else
3143               st->print("<UNKNOWN>");
3144             break;
3145           }
3146         case Bytecodes::_getfield:
3147         case Bytecodes::_putfield:
3148         case Bytecodes::_getstatic:
3149         case Bytecodes::_putstatic:
3150           {
3151             Bytecode_field field(sd->method(), sd->bci());
3152             st->print(" ");
3153             if (field.name() != NULL)
3154               field.name()->print_symbol_on(st);
3155             else
3156               st->print("<UNKNOWN>");
3157           }
3158         default:
3159           break;
3160         }
3161       }
3162       st->print(" {reexecute=%d rethrow=%d return_oop=%d}", sd->should_reexecute(), sd->rethrow_exception(), sd->return_oop());
3163     }
3164 
3165     // Print all scopes
3166     for (;sd != NULL; sd = sd->sender()) {
3167       st->move_to(column, 6, 0);
3168       st->print("; -");
3169       if (sd->should_reexecute()) {
3170         st->print(" (reexecute)");
3171       }
3172       if (sd->method() == NULL) {
3173         st->print("method is NULL");
3174       } else {
3175         sd->method()->print_short_name(st);
3176       }
3177       int lineno = sd->method()->line_number_from_bci(sd->bci());
3178       if (lineno != -1) {
3179         st->print("@%d (line %d)", sd->bci(), lineno);
3180       } else {
3181         st->print("@%d", sd->bci());
3182       }
3183       st->cr();
3184     }
3185   }
3186 
3187   // Print relocation information
3188   // Prevent memory leak: allocating without ResourceMark.
3189   ResourceMark rm;
3190   const char* str = reloc_string_for(begin, end);
3191   if (str != NULL) {
3192     if (sd != NULL) st->cr();
3193     st->move_to(column, 6, 0);
3194     st->print(";   {%s}", str);
3195   }
3196 }
3197 
3198 #endif
3199 
3200 class DirectNativeCallWrapper: public NativeCallWrapper {
3201 private:
3202   NativeCall* _call;
3203 
3204 public:
3205   DirectNativeCallWrapper(NativeCall* call) : _call(call) {}
3206 
3207   virtual address destination() const { return _call->destination(); }
3208   virtual address instruction_address() const { return _call->instruction_address(); }
3209   virtual address next_instruction_address() const { return _call->next_instruction_address(); }
3210   virtual address return_address() const { return _call->return_address(); }
3211 
3212   virtual address get_resolve_call_stub(bool is_optimized) const {
3213     if (is_optimized) {
3214       return SharedRuntime::get_resolve_opt_virtual_call_stub();
3215     }
3216     return SharedRuntime::get_resolve_virtual_call_stub();
3217   }
3218 
3219   virtual void set_destination_mt_safe(address dest) {
3220 #if INCLUDE_AOT
3221     if (UseAOT) {
3222       CodeBlob* callee = CodeCache::find_blob(dest);
3223       CompiledMethod* cm = callee->as_compiled_method_or_null();
3224       if (cm != NULL && cm->is_far_code()) {
3225         // Temporary fix, see JDK-8143106
3226         CompiledDirectStaticCall* csc = CompiledDirectStaticCall::at(instruction_address());
3227         csc->set_to_far(methodHandle(cm->method()), dest);
3228         return;
3229       }
3230     }
3231 #endif
3232     _call->set_destination_mt_safe(dest);
3233   }
3234 
3235   virtual void set_to_interpreted(const methodHandle& method, CompiledICInfo& info) {
3236     CompiledDirectStaticCall* csc = CompiledDirectStaticCall::at(instruction_address());
3237 #if INCLUDE_AOT
3238     if (info.to_aot()) {
3239       csc->set_to_far(method, info.entry());
3240     } else
3241 #endif
3242     {
3243       csc->set_to_interpreted(method, info.entry());
3244     }
3245   }
3246 
3247   virtual void verify() const {
3248     // make sure code pattern is actually a call imm32 instruction
3249     _call->verify();
3250     _call->verify_alignment();
3251   }
3252 
3253   virtual void verify_resolve_call(address dest) const {
3254     CodeBlob* db = CodeCache::find_blob_unsafe(dest);
3255     assert(db != NULL && !db->is_adapter_blob(), "must use stub!");
3256   }
3257 
3258   virtual bool is_call_to_interpreted(address dest) const {
3259     CodeBlob* cb = CodeCache::find_blob(_call->instruction_address());
3260     return cb->contains(dest);
3261   }
3262 
3263   virtual bool is_safe_for_patching() const { return false; }
3264 
3265   virtual NativeInstruction* get_load_instruction(virtual_call_Relocation* r) const {
3266     return nativeMovConstReg_at(r->cached_value());
3267   }
3268 
3269   virtual void *get_data(NativeInstruction* instruction) const {
3270     return (void*)((NativeMovConstReg*) instruction)->data();
3271   }
3272 
3273   virtual void set_data(NativeInstruction* instruction, intptr_t data) {
3274     ((NativeMovConstReg*) instruction)->set_data(data);
3275   }
3276 };
3277 
3278 NativeCallWrapper* nmethod::call_wrapper_at(address call) const {
3279   return new DirectNativeCallWrapper((NativeCall*) call);
3280 }
3281 
3282 NativeCallWrapper* nmethod::call_wrapper_before(address return_pc) const {
3283   return new DirectNativeCallWrapper(nativeCall_before(return_pc));
3284 }
3285 
3286 address nmethod::call_instruction_address(address pc) const {
3287   if (NativeCall::is_call_before(pc)) {
3288     NativeCall *ncall = nativeCall_before(pc);
3289     return ncall->instruction_address();
3290   }
3291   return NULL;
3292 }
3293 
3294 CompiledStaticCall* nmethod::compiledStaticCall_at(Relocation* call_site) const {
3295   return CompiledDirectStaticCall::at(call_site);
3296 }
3297 
3298 CompiledStaticCall* nmethod::compiledStaticCall_at(address call_site) const {
3299   return CompiledDirectStaticCall::at(call_site);
3300 }
3301 
3302 CompiledStaticCall* nmethod::compiledStaticCall_before(address return_addr) const {
3303   return CompiledDirectStaticCall::before(return_addr);
3304 }
3305 
3306 #if defined(SUPPORT_DATA_STRUCTS)
3307 void nmethod::print_value_on(outputStream* st) const {
3308   st->print("nmethod");
3309   print_on(st, NULL);
3310 }
3311 #endif
3312 
3313 #ifndef PRODUCT
3314 
3315 void nmethod::print_calls(outputStream* st) {
3316   RelocIterator iter(this);
3317   while (iter.next()) {
3318     switch (iter.type()) {
3319     case relocInfo::virtual_call_type:
3320     case relocInfo::opt_virtual_call_type: {
3321       CompiledICLocker ml_verify(this);
3322       CompiledIC_at(&iter)->print();
3323       break;
3324     }
3325     case relocInfo::static_call_type:
3326       st->print_cr("Static call at " INTPTR_FORMAT, p2i(iter.reloc()->addr()));
3327       CompiledDirectStaticCall::at(iter.reloc())->print();
3328       break;
3329     default:
3330       break;
3331     }
3332   }
3333 }
3334 
3335 void nmethod::print_statistics() {
3336   ttyLocker ttyl;
3337   if (xtty != NULL)  xtty->head("statistics type='nmethod'");
3338   native_nmethod_stats.print_native_nmethod_stats();
3339 #ifdef COMPILER1
3340   c1_java_nmethod_stats.print_nmethod_stats("C1");
3341 #endif
3342 #ifdef COMPILER2
3343   c2_java_nmethod_stats.print_nmethod_stats("C2");
3344 #endif
3345 #if INCLUDE_JVMCI
3346   jvmci_java_nmethod_stats.print_nmethod_stats("JVMCI");
3347 #endif
3348   unknown_java_nmethod_stats.print_nmethod_stats("Unknown");
3349   DebugInformationRecorder::print_statistics();
3350 #ifndef PRODUCT
3351   pc_nmethod_stats.print_pc_stats();
3352 #endif
3353   Dependencies::print_statistics();
3354   if (xtty != NULL)  xtty->tail("statistics");
3355 }
3356 
3357 #endif // !PRODUCT
3358 
3359 #if INCLUDE_JVMCI
3360 void nmethod::update_speculation(JavaThread* thread) {
3361   jlong speculation = thread->pending_failed_speculation();
3362   if (speculation != 0) {
3363     guarantee(jvmci_nmethod_data() != NULL, "failed speculation in nmethod without failed speculation list");
3364     jvmci_nmethod_data()->add_failed_speculation(this, speculation);
3365     thread->set_pending_failed_speculation(0);
3366   }
3367 }
3368 
3369 const char* nmethod::jvmci_name() {
3370   if (jvmci_nmethod_data() != NULL) {
3371     return jvmci_nmethod_data()->name();
3372   }
3373   return NULL;
3374 }
3375 #endif