1 /*
   2  * Copyright (c) 1997, 2025, 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 "asm/assembler.inline.hpp"
  26 #include "cds/cdsConfig.hpp"
  27 #include "code/codeCache.hpp"
  28 #include "code/compiledIC.hpp"
  29 #include "code/dependencies.hpp"
  30 #include "code/nativeInst.hpp"
  31 #include "code/nmethod.inline.hpp"
  32 #include "code/scopeDesc.hpp"
  33 #include "compiler/abstractCompiler.hpp"
  34 #include "compiler/compilationLog.hpp"
  35 #include "compiler/compileBroker.hpp"
  36 #include "compiler/compileLog.hpp"
  37 #include "compiler/compilerDirectives.hpp"
  38 #include "compiler/compilerOracle.hpp"
  39 #include "compiler/compileTask.hpp"
  40 #include "compiler/directivesParser.hpp"
  41 #include "compiler/disassembler.hpp"
  42 #include "compiler/oopMap.inline.hpp"
  43 #include "gc/shared/barrierSet.hpp"
  44 #include "gc/shared/barrierSetNMethod.hpp"
  45 #include "gc/shared/classUnloadingContext.hpp"
  46 #include "gc/shared/collectedHeap.hpp"
  47 #include "interpreter/bytecode.inline.hpp"
  48 #include "jvm.h"
  49 #include "logging/log.hpp"
  50 #include "logging/logStream.hpp"
  51 #include "memory/allocation.inline.hpp"
  52 #include "memory/resourceArea.hpp"
  53 #include "memory/universe.hpp"
  54 #include "oops/access.inline.hpp"
  55 #include "oops/klass.inline.hpp"
  56 #include "oops/method.inline.hpp"
  57 #include "oops/methodData.hpp"
  58 #include "oops/oop.inline.hpp"
  59 #include "oops/weakHandle.inline.hpp"
  60 #include "prims/jvmtiImpl.hpp"
  61 #include "prims/jvmtiThreadState.hpp"
  62 #include "prims/methodHandles.hpp"
  63 #include "runtime/atomicAccess.hpp"
  64 #include "runtime/continuation.hpp"
  65 #include "runtime/deoptimization.hpp"
  66 #include "runtime/flags/flagSetting.hpp"
  67 #include "runtime/frame.inline.hpp"
  68 #include "runtime/handles.inline.hpp"
  69 #include "runtime/jniHandles.inline.hpp"
  70 #include "runtime/orderAccess.hpp"
  71 #include "runtime/os.hpp"
  72 #include "runtime/safepointVerifiers.hpp"
  73 #include "runtime/serviceThread.hpp"
  74 #include "runtime/sharedRuntime.hpp"
  75 #include "runtime/signature.hpp"
  76 #include "runtime/threadWXSetters.inline.hpp"
  77 #include "runtime/vmThread.hpp"
  78 #include "utilities/align.hpp"
  79 #include "utilities/copy.hpp"
  80 #include "utilities/dtrace.hpp"
  81 #include "utilities/events.hpp"
  82 #include "utilities/globalDefinitions.hpp"
  83 #include "utilities/hashTable.hpp"
  84 #include "utilities/xmlstream.hpp"
  85 #if INCLUDE_JVMCI
  86 #include "jvmci/jvmciRuntime.hpp"
  87 #endif
  88 
  89 #ifdef DTRACE_ENABLED
  90 
  91 // Only bother with this argument setup if dtrace is available
  92 
  93 #define DTRACE_METHOD_UNLOAD_PROBE(method)                                \
  94   {                                                                       \
  95     Method* m = (method);                                                 \
  96     if (m != nullptr) {                                                   \
  97       Symbol* klass_name = m->klass_name();                               \
  98       Symbol* name = m->name();                                           \
  99       Symbol* signature = m->signature();                                 \
 100       HOTSPOT_COMPILED_METHOD_UNLOAD(                                     \
 101         (char *) klass_name->bytes(), klass_name->utf8_length(),          \
 102         (char *) name->bytes(), name->utf8_length(),                      \
 103         (char *) signature->bytes(), signature->utf8_length());           \
 104     }                                                                     \
 105   }
 106 
 107 #else //  ndef DTRACE_ENABLED
 108 
 109 #define DTRACE_METHOD_UNLOAD_PROBE(method)
 110 
 111 #endif
 112 
 113 // Cast from int value to narrow type
 114 #define CHECKED_CAST(result, T, thing)      \
 115   result = static_cast<T>(thing); \
 116   guarantee(static_cast<int>(result) == thing, "failed: %d != %d", static_cast<int>(result), thing);
 117 
 118 //---------------------------------------------------------------------------------
 119 // NMethod statistics
 120 // They are printed under various flags, including:
 121 //   PrintC1Statistics, PrintOptoStatistics, LogVMOutput, and LogCompilation.
 122 // (In the latter two cases, they like other stats are printed to the log only.)
 123 
 124 #ifndef PRODUCT
 125 // These variables are put into one block to reduce relocations
 126 // and make it simpler to print from the debugger.
 127 struct java_nmethod_stats_struct {
 128   uint nmethod_count;
 129   uint total_nm_size;
 130   uint total_immut_size;
 131   uint total_mut_size;
 132   uint relocation_size;
 133   uint consts_size;
 134   uint insts_size;
 135   uint stub_size;
 136   uint oops_size;
 137   uint metadata_size;
 138   uint dependencies_size;
 139   uint nul_chk_table_size;
 140   uint handler_table_size;
 141   uint scopes_pcs_size;
 142   uint scopes_data_size;
 143 #if INCLUDE_JVMCI
 144   uint speculations_size;
 145   uint jvmci_data_size;
 146 #endif
 147 
 148   void note_nmethod(nmethod* nm) {
 149     nmethod_count += 1;
 150     total_nm_size       += nm->size();
 151     total_immut_size    += nm->immutable_data_size();
 152     total_mut_size      += nm->mutable_data_size();
 153     relocation_size     += nm->relocation_size();
 154     consts_size         += nm->consts_size();
 155     insts_size          += nm->insts_size();
 156     stub_size           += nm->stub_size();
 157     oops_size           += nm->oops_size();
 158     metadata_size       += nm->metadata_size();
 159     scopes_data_size    += nm->scopes_data_size();
 160     scopes_pcs_size     += nm->scopes_pcs_size();
 161     dependencies_size   += nm->dependencies_size();
 162     handler_table_size  += nm->handler_table_size();
 163     nul_chk_table_size  += nm->nul_chk_table_size();
 164 #if INCLUDE_JVMCI
 165     speculations_size   += nm->speculations_size();
 166     jvmci_data_size     += nm->jvmci_data_size();
 167 #endif
 168   }
 169   void print_nmethod_stats(const char* name) {
 170     if (nmethod_count == 0)  return;
 171     tty->print_cr("Statistics for %u bytecoded nmethods for %s:", nmethod_count, name);
 172     uint total_size = total_nm_size + total_immut_size + total_mut_size;
 173     if (total_nm_size != 0) {
 174       tty->print_cr(" total size      = %u (100%%)", total_size);
 175       tty->print_cr(" in CodeCache    = %u (%f%%)", total_nm_size, (total_nm_size * 100.0f)/total_size);
 176     }
 177     uint header_size = (uint)(nmethod_count * sizeof(nmethod));
 178     if (nmethod_count != 0) {
 179       tty->print_cr("   header        = %u (%f%%)", header_size, (header_size * 100.0f)/total_nm_size);
 180     }
 181     if (consts_size != 0) {
 182       tty->print_cr("   constants     = %u (%f%%)", consts_size, (consts_size * 100.0f)/total_nm_size);
 183     }
 184     if (insts_size != 0) {
 185       tty->print_cr("   main code     = %u (%f%%)", insts_size, (insts_size * 100.0f)/total_nm_size);
 186     }
 187     if (stub_size != 0) {
 188       tty->print_cr("   stub code     = %u (%f%%)", stub_size, (stub_size * 100.0f)/total_nm_size);
 189     }
 190     if (oops_size != 0) {
 191       tty->print_cr("   oops          = %u (%f%%)", oops_size, (oops_size * 100.0f)/total_nm_size);
 192     }
 193     if (total_mut_size != 0) {
 194       tty->print_cr(" mutable data    = %u (%f%%)", total_mut_size, (total_mut_size * 100.0f)/total_size);
 195     }
 196     if (relocation_size != 0) {
 197       tty->print_cr("   relocation    = %u (%f%%)", relocation_size, (relocation_size * 100.0f)/total_mut_size);
 198     }
 199     if (metadata_size != 0) {
 200       tty->print_cr("   metadata      = %u (%f%%)", metadata_size, (metadata_size * 100.0f)/total_mut_size);
 201     }
 202 #if INCLUDE_JVMCI
 203     if (jvmci_data_size != 0) {
 204       tty->print_cr("   JVMCI data    = %u (%f%%)", jvmci_data_size, (jvmci_data_size * 100.0f)/total_mut_size);
 205     }
 206 #endif
 207     if (total_immut_size != 0) {
 208       tty->print_cr(" immutable data  = %u (%f%%)", total_immut_size, (total_immut_size * 100.0f)/total_size);
 209     }
 210     if (dependencies_size != 0) {
 211       tty->print_cr("   dependencies  = %u (%f%%)", dependencies_size, (dependencies_size * 100.0f)/total_immut_size);
 212     }
 213     if (nul_chk_table_size != 0) {
 214       tty->print_cr("   nul chk table = %u (%f%%)", nul_chk_table_size, (nul_chk_table_size * 100.0f)/total_immut_size);
 215     }
 216     if (handler_table_size != 0) {
 217       tty->print_cr("   handler table = %u (%f%%)", handler_table_size, (handler_table_size * 100.0f)/total_immut_size);
 218     }
 219     if (scopes_pcs_size != 0) {
 220       tty->print_cr("   scopes pcs    = %u (%f%%)", scopes_pcs_size, (scopes_pcs_size * 100.0f)/total_immut_size);
 221     }
 222     if (scopes_data_size != 0) {
 223       tty->print_cr("   scopes data   = %u (%f%%)", scopes_data_size, (scopes_data_size * 100.0f)/total_immut_size);
 224     }
 225 #if INCLUDE_JVMCI
 226     if (speculations_size != 0) {
 227       tty->print_cr("   speculations  = %u (%f%%)", speculations_size, (speculations_size * 100.0f)/total_immut_size);
 228     }
 229 #endif
 230   }
 231 };
 232 
 233 struct native_nmethod_stats_struct {
 234   uint native_nmethod_count;
 235   uint native_total_size;
 236   uint native_relocation_size;
 237   uint native_insts_size;
 238   uint native_oops_size;
 239   uint native_metadata_size;
 240   void note_native_nmethod(nmethod* nm) {
 241     native_nmethod_count += 1;
 242     native_total_size       += nm->size();
 243     native_relocation_size  += nm->relocation_size();
 244     native_insts_size       += nm->insts_size();
 245     native_oops_size        += nm->oops_size();
 246     native_metadata_size    += nm->metadata_size();
 247   }
 248   void print_native_nmethod_stats() {
 249     if (native_nmethod_count == 0)  return;
 250     tty->print_cr("Statistics for %u native nmethods:", native_nmethod_count);
 251     if (native_total_size != 0)       tty->print_cr(" N. total size  = %u", native_total_size);
 252     if (native_relocation_size != 0)  tty->print_cr(" N. relocation  = %u", native_relocation_size);
 253     if (native_insts_size != 0)       tty->print_cr(" N. main code   = %u", native_insts_size);
 254     if (native_oops_size != 0)        tty->print_cr(" N. oops        = %u", native_oops_size);
 255     if (native_metadata_size != 0)    tty->print_cr(" N. metadata    = %u", native_metadata_size);
 256   }
 257 };
 258 
 259 struct pc_nmethod_stats_struct {
 260   uint pc_desc_init;     // number of initialization of cache (= number of caches)
 261   uint pc_desc_queries;  // queries to nmethod::find_pc_desc
 262   uint pc_desc_approx;   // number of those which have approximate true
 263   uint pc_desc_repeats;  // number of _pc_descs[0] hits
 264   uint pc_desc_hits;     // number of LRU cache hits
 265   uint pc_desc_tests;    // total number of PcDesc examinations
 266   uint pc_desc_searches; // total number of quasi-binary search steps
 267   uint pc_desc_adds;     // number of LUR cache insertions
 268 
 269   void print_pc_stats() {
 270     tty->print_cr("PcDesc Statistics:  %u queries, %.2f comparisons per query",
 271                   pc_desc_queries,
 272                   (double)(pc_desc_tests + pc_desc_searches)
 273                   / pc_desc_queries);
 274     tty->print_cr("  caches=%d queries=%u/%u, hits=%u+%u, tests=%u+%u, adds=%u",
 275                   pc_desc_init,
 276                   pc_desc_queries, pc_desc_approx,
 277                   pc_desc_repeats, pc_desc_hits,
 278                   pc_desc_tests, pc_desc_searches, pc_desc_adds);
 279   }
 280 };
 281 
 282 #ifdef COMPILER1
 283 static java_nmethod_stats_struct c1_java_nmethod_stats;
 284 #endif
 285 #ifdef COMPILER2
 286 static java_nmethod_stats_struct c2_java_nmethod_stats;
 287 #endif
 288 #if INCLUDE_JVMCI
 289 static java_nmethod_stats_struct jvmci_java_nmethod_stats;
 290 #endif
 291 static java_nmethod_stats_struct unknown_java_nmethod_stats;
 292 
 293 static native_nmethod_stats_struct native_nmethod_stats;
 294 static pc_nmethod_stats_struct pc_nmethod_stats;
 295 
 296 static void note_java_nmethod(nmethod* nm) {
 297 #ifdef COMPILER1
 298   if (nm->is_compiled_by_c1()) {
 299     c1_java_nmethod_stats.note_nmethod(nm);
 300   } else
 301 #endif
 302 #ifdef COMPILER2
 303   if (nm->is_compiled_by_c2()) {
 304     c2_java_nmethod_stats.note_nmethod(nm);
 305   } else
 306 #endif
 307 #if INCLUDE_JVMCI
 308   if (nm->is_compiled_by_jvmci()) {
 309     jvmci_java_nmethod_stats.note_nmethod(nm);
 310   } else
 311 #endif
 312   {
 313     unknown_java_nmethod_stats.note_nmethod(nm);
 314   }
 315 }
 316 #endif // !PRODUCT
 317 
 318 //---------------------------------------------------------------------------------
 319 
 320 
 321 ExceptionCache::ExceptionCache(Handle exception, address pc, address handler) {
 322   assert(pc != nullptr, "Must be non null");
 323   assert(exception.not_null(), "Must be non null");
 324   assert(handler != nullptr, "Must be non null");
 325 
 326   _count = 0;
 327   _exception_type = exception->klass();
 328   _next = nullptr;
 329   _purge_list_next = nullptr;
 330 
 331   add_address_and_handler(pc,handler);
 332 }
 333 
 334 
 335 address ExceptionCache::match(Handle exception, address pc) {
 336   assert(pc != nullptr,"Must be non null");
 337   assert(exception.not_null(),"Must be non null");
 338   if (exception->klass() == exception_type()) {
 339     return (test_address(pc));
 340   }
 341 
 342   return nullptr;
 343 }
 344 
 345 
 346 bool ExceptionCache::match_exception_with_space(Handle exception) {
 347   assert(exception.not_null(),"Must be non null");
 348   if (exception->klass() == exception_type() && count() < cache_size) {
 349     return true;
 350   }
 351   return false;
 352 }
 353 
 354 
 355 address ExceptionCache::test_address(address addr) {
 356   int limit = count();
 357   for (int i = 0; i < limit; i++) {
 358     if (pc_at(i) == addr) {
 359       return handler_at(i);
 360     }
 361   }
 362   return nullptr;
 363 }
 364 
 365 
 366 bool ExceptionCache::add_address_and_handler(address addr, address handler) {
 367   if (test_address(addr) == handler) return true;
 368 
 369   int index = count();
 370   if (index < cache_size) {
 371     set_pc_at(index, addr);
 372     set_handler_at(index, handler);
 373     increment_count();
 374     return true;
 375   }
 376   return false;
 377 }
 378 
 379 ExceptionCache* ExceptionCache::next() {
 380   return AtomicAccess::load(&_next);
 381 }
 382 
 383 void ExceptionCache::set_next(ExceptionCache *ec) {
 384   AtomicAccess::store(&_next, ec);
 385 }
 386 
 387 //-----------------------------------------------------------------------------
 388 
 389 
 390 // Helper used by both find_pc_desc methods.
 391 static inline bool match_desc(PcDesc* pc, int pc_offset, bool approximate) {
 392   NOT_PRODUCT(++pc_nmethod_stats.pc_desc_tests);
 393   if (!approximate) {
 394     return pc->pc_offset() == pc_offset;
 395   } else {
 396     // Do not look before the sentinel
 397     assert(pc_offset > PcDesc::lower_offset_limit, "illegal pc_offset");
 398     return pc_offset <= pc->pc_offset() && (pc-1)->pc_offset() < pc_offset;
 399   }
 400 }
 401 
 402 void PcDescCache::init_to(PcDesc* initial_pc_desc) {
 403   NOT_PRODUCT(++pc_nmethod_stats.pc_desc_init);
 404   // initialize the cache by filling it with benign (non-null) values
 405   assert(initial_pc_desc != nullptr && initial_pc_desc->pc_offset() == PcDesc::lower_offset_limit,
 406          "must start with a sentinel");
 407   for (int i = 0; i < cache_size; i++) {
 408     _pc_descs[i] = initial_pc_desc;
 409   }
 410 }
 411 
 412 PcDesc* PcDescCache::find_pc_desc(int pc_offset, bool approximate) {
 413   // Note: one might think that caching the most recently
 414   // read value separately would be a win, but one would be
 415   // wrong.  When many threads are updating it, the cache
 416   // line it's in would bounce between caches, negating
 417   // any benefit.
 418 
 419   // In order to prevent race conditions do not load cache elements
 420   // repeatedly, but use a local copy:
 421   PcDesc* res;
 422 
 423   // Step one:  Check the most recently added value.
 424   res = _pc_descs[0];
 425   assert(res != nullptr, "PcDesc cache should be initialized already");
 426 
 427   // Approximate only here since PcDescContainer::find_pc_desc() checked for exact case.
 428   if (approximate && match_desc(res, pc_offset, approximate)) {
 429     NOT_PRODUCT(++pc_nmethod_stats.pc_desc_repeats);
 430     return res;
 431   }
 432 
 433   // Step two:  Check the rest of the LRU cache.
 434   for (int i = 1; i < cache_size; ++i) {
 435     res = _pc_descs[i];
 436     if (res->pc_offset() < 0) break;  // optimization: skip empty cache
 437     if (match_desc(res, pc_offset, approximate)) {
 438       NOT_PRODUCT(++pc_nmethod_stats.pc_desc_hits);
 439       return res;
 440     }
 441   }
 442 
 443   // Report failure.
 444   return nullptr;
 445 }
 446 
 447 void PcDescCache::add_pc_desc(PcDesc* pc_desc) {
 448   NOT_PRODUCT(++pc_nmethod_stats.pc_desc_adds);
 449   // Update the LRU cache by shifting pc_desc forward.
 450   for (int i = 0; i < cache_size; i++)  {
 451     PcDesc* next = _pc_descs[i];
 452     _pc_descs[i] = pc_desc;
 453     pc_desc = next;
 454   }
 455 }
 456 
 457 // adjust pcs_size so that it is a multiple of both oopSize and
 458 // sizeof(PcDesc) (assumes that if sizeof(PcDesc) is not a multiple
 459 // of oopSize, then 2*sizeof(PcDesc) is)
 460 static int adjust_pcs_size(int pcs_size) {
 461   int nsize = align_up(pcs_size,   oopSize);
 462   if ((nsize % sizeof(PcDesc)) != 0) {
 463     nsize = pcs_size + sizeof(PcDesc);
 464   }
 465   assert((nsize % oopSize) == 0, "correct alignment");
 466   return nsize;
 467 }
 468 
 469 // Returns a string version of the method state.
 470 const char* nmethod::state() const {
 471   int state = get_state();
 472   switch (state) {
 473   case not_installed:
 474     return "not installed";
 475   case in_use:
 476     return "in use";
 477   case not_entrant:
 478     return "not_entrant";
 479   default:
 480     fatal("unexpected method state: %d", state);
 481     return nullptr;
 482   }
 483 }
 484 
 485 void nmethod::set_deoptimized_done() {
 486   ConditionalMutexLocker ml(NMethodState_lock, !NMethodState_lock->owned_by_self(), Mutex::_no_safepoint_check_flag);
 487   if (_deoptimization_status != deoptimize_done) { // can't go backwards
 488     AtomicAccess::store(&_deoptimization_status, deoptimize_done);
 489   }
 490 }
 491 
 492 ExceptionCache* nmethod::exception_cache_acquire() const {
 493   return AtomicAccess::load_acquire(&_exception_cache);
 494 }
 495 
 496 void nmethod::add_exception_cache_entry(ExceptionCache* new_entry) {
 497   assert(ExceptionCache_lock->owned_by_self(),"Must hold the ExceptionCache_lock");
 498   assert(new_entry != nullptr,"Must be non null");
 499   assert(new_entry->next() == nullptr, "Must be null");
 500 
 501   for (;;) {
 502     ExceptionCache *ec = exception_cache();
 503     if (ec != nullptr) {
 504       Klass* ex_klass = ec->exception_type();
 505       if (!ex_klass->is_loader_alive()) {
 506         // We must guarantee that entries are not inserted with new next pointer
 507         // edges to ExceptionCache entries with dead klasses, due to bad interactions
 508         // with concurrent ExceptionCache cleanup. Therefore, the inserts roll
 509         // the head pointer forward to the first live ExceptionCache, so that the new
 510         // next pointers always point at live ExceptionCaches, that are not removed due
 511         // to concurrent ExceptionCache cleanup.
 512         ExceptionCache* next = ec->next();
 513         if (AtomicAccess::cmpxchg(&_exception_cache, ec, next) == ec) {
 514           CodeCache::release_exception_cache(ec);
 515         }
 516         continue;
 517       }
 518       ec = exception_cache();
 519       if (ec != nullptr) {
 520         new_entry->set_next(ec);
 521       }
 522     }
 523     if (AtomicAccess::cmpxchg(&_exception_cache, ec, new_entry) == ec) {
 524       return;
 525     }
 526   }
 527 }
 528 
 529 void nmethod::clean_exception_cache() {
 530   // For each nmethod, only a single thread may call this cleanup function
 531   // at the same time, whether called in STW cleanup or concurrent cleanup.
 532   // Note that if the GC is processing exception cache cleaning in a concurrent phase,
 533   // then a single writer may contend with cleaning up the head pointer to the
 534   // first ExceptionCache node that has a Klass* that is alive. That is fine,
 535   // as long as there is no concurrent cleanup of next pointers from concurrent writers.
 536   // And the concurrent writers do not clean up next pointers, only the head.
 537   // Also note that concurrent readers will walk through Klass* pointers that are not
 538   // alive. That does not cause ABA problems, because Klass* is deleted after
 539   // a handshake with all threads, after all stale ExceptionCaches have been
 540   // unlinked. That is also when the CodeCache::exception_cache_purge_list()
 541   // is deleted, with all ExceptionCache entries that were cleaned concurrently.
 542   // That similarly implies that CAS operations on ExceptionCache entries do not
 543   // suffer from ABA problems as unlinking and deletion is separated by a global
 544   // handshake operation.
 545   ExceptionCache* prev = nullptr;
 546   ExceptionCache* curr = exception_cache_acquire();
 547 
 548   while (curr != nullptr) {
 549     ExceptionCache* next = curr->next();
 550 
 551     if (!curr->exception_type()->is_loader_alive()) {
 552       if (prev == nullptr) {
 553         // Try to clean head; this is contended by concurrent inserts, that
 554         // both lazily clean the head, and insert entries at the head. If
 555         // the CAS fails, the operation is restarted.
 556         if (AtomicAccess::cmpxchg(&_exception_cache, curr, next) != curr) {
 557           prev = nullptr;
 558           curr = exception_cache_acquire();
 559           continue;
 560         }
 561       } else {
 562         // It is impossible to during cleanup connect the next pointer to
 563         // an ExceptionCache that has not been published before a safepoint
 564         // prior to the cleanup. Therefore, release is not required.
 565         prev->set_next(next);
 566       }
 567       // prev stays the same.
 568 
 569       CodeCache::release_exception_cache(curr);
 570     } else {
 571       prev = curr;
 572     }
 573 
 574     curr = next;
 575   }
 576 }
 577 
 578 // public method for accessing the exception cache
 579 // These are the public access methods.
 580 address nmethod::handler_for_exception_and_pc(Handle exception, address pc) {
 581   // We never grab a lock to read the exception cache, so we may
 582   // have false negatives. This is okay, as it can only happen during
 583   // the first few exception lookups for a given nmethod.
 584   ExceptionCache* ec = exception_cache_acquire();
 585   while (ec != nullptr) {
 586     address ret_val;
 587     if ((ret_val = ec->match(exception,pc)) != nullptr) {
 588       return ret_val;
 589     }
 590     ec = ec->next();
 591   }
 592   return nullptr;
 593 }
 594 
 595 void nmethod::add_handler_for_exception_and_pc(Handle exception, address pc, address handler) {
 596   // There are potential race conditions during exception cache updates, so we
 597   // must own the ExceptionCache_lock before doing ANY modifications. Because
 598   // we don't lock during reads, it is possible to have several threads attempt
 599   // to update the cache with the same data. We need to check for already inserted
 600   // copies of the current data before adding it.
 601 
 602   MutexLocker ml(ExceptionCache_lock);
 603   ExceptionCache* target_entry = exception_cache_entry_for_exception(exception);
 604 
 605   if (target_entry == nullptr || !target_entry->add_address_and_handler(pc,handler)) {
 606     target_entry = new ExceptionCache(exception,pc,handler);
 607     add_exception_cache_entry(target_entry);
 608   }
 609 }
 610 
 611 // private method for handling exception cache
 612 // These methods are private, and used to manipulate the exception cache
 613 // directly.
 614 ExceptionCache* nmethod::exception_cache_entry_for_exception(Handle exception) {
 615   ExceptionCache* ec = exception_cache_acquire();
 616   while (ec != nullptr) {
 617     if (ec->match_exception_with_space(exception)) {
 618       return ec;
 619     }
 620     ec = ec->next();
 621   }
 622   return nullptr;
 623 }
 624 
 625 bool nmethod::is_at_poll_return(address pc) {
 626   RelocIterator iter(this, pc, pc+1);
 627   while (iter.next()) {
 628     if (iter.type() == relocInfo::poll_return_type)
 629       return true;
 630   }
 631   return false;
 632 }
 633 
 634 
 635 bool nmethod::is_at_poll_or_poll_return(address pc) {
 636   RelocIterator iter(this, pc, pc+1);
 637   while (iter.next()) {
 638     relocInfo::relocType t = iter.type();
 639     if (t == relocInfo::poll_return_type || t == relocInfo::poll_type)
 640       return true;
 641   }
 642   return false;
 643 }
 644 
 645 void nmethod::verify_oop_relocations() {
 646   // Ensure sure that the code matches the current oop values
 647   RelocIterator iter(this, nullptr, nullptr);
 648   while (iter.next()) {
 649     if (iter.type() == relocInfo::oop_type) {
 650       oop_Relocation* reloc = iter.oop_reloc();
 651       if (!reloc->oop_is_immediate()) {
 652         reloc->verify_oop_relocation();
 653       }
 654     }
 655   }
 656 }
 657 
 658 
 659 ScopeDesc* nmethod::scope_desc_at(address pc) {
 660   PcDesc* pd = pc_desc_at(pc);
 661   guarantee(pd != nullptr, "scope must be present");
 662   return new ScopeDesc(this, pd);
 663 }
 664 
 665 ScopeDesc* nmethod::scope_desc_near(address pc) {
 666   PcDesc* pd = pc_desc_near(pc);
 667   guarantee(pd != nullptr, "scope must be present");
 668   return new ScopeDesc(this, pd);
 669 }
 670 
 671 address nmethod::oops_reloc_begin() const {
 672   // If the method is not entrant then a JMP is plastered over the
 673   // first few bytes.  If an oop in the old code was there, that oop
 674   // should not get GC'd.  Skip the first few bytes of oops on
 675   // not-entrant methods.
 676   if (frame_complete_offset() != CodeOffsets::frame_never_safe &&
 677       code_begin() + frame_complete_offset() >
 678       verified_entry_point() + NativeJump::instruction_size)
 679   {
 680     // If we have a frame_complete_offset after the native jump, then there
 681     // is no point trying to look for oops before that. This is a requirement
 682     // for being allowed to scan oops concurrently.
 683     return code_begin() + frame_complete_offset();
 684   }
 685 
 686   address low_boundary = verified_entry_point();
 687   return low_boundary;
 688 }
 689 
 690 // Method that knows how to preserve outgoing arguments at call. This method must be
 691 // called with a frame corresponding to a Java invoke
 692 void nmethod::preserve_callee_argument_oops(frame fr, const RegisterMap *reg_map, OopClosure* f) {
 693   if (method() == nullptr) {
 694     return;
 695   }
 696 
 697   // handle the case of an anchor explicitly set in continuation code that doesn't have a callee
 698   JavaThread* thread = reg_map->thread();
 699   if ((thread->has_last_Java_frame() && fr.sp() == thread->last_Java_sp())
 700       JVMTI_ONLY(|| (method()->is_continuation_enter_intrinsic() && thread->on_monitor_waited_event()))) {
 701     return;
 702   }
 703 
 704   if (!method()->is_native()) {
 705     address pc = fr.pc();
 706     bool has_receiver, has_appendix;
 707     Symbol* signature;
 708 
 709     // The method attached by JIT-compilers should be used, if present.
 710     // Bytecode can be inaccurate in such case.
 711     Method* callee = attached_method_before_pc(pc);
 712     if (callee != nullptr) {
 713       has_receiver = !(callee->access_flags().is_static());
 714       has_appendix = false;
 715       signature    = callee->signature();
 716 
 717       // If inline types are passed as fields, use the extended signature
 718       // which contains the types of all (oop) fields of the inline type.
 719       if (is_compiled_by_c2() && callee->has_scalarized_args()) {
 720         const GrowableArray<SigEntry>* sig = callee->adapter()->get_sig_cc();
 721         assert(sig != nullptr, "sig should never be null");
 722         TempNewSymbol tmp_sig = SigEntry::create_symbol(sig);
 723         has_receiver = false; // The extended signature contains the receiver type
 724         fr.oops_compiled_arguments_do(tmp_sig, has_receiver, has_appendix, reg_map, f);
 725         return;
 726       }
 727     } else {
 728       SimpleScopeDesc ssd(this, pc);
 729 
 730       Bytecode_invoke call(methodHandle(Thread::current(), ssd.method()), ssd.bci());
 731       has_receiver = call.has_receiver();
 732       has_appendix = call.has_appendix();
 733       signature    = call.signature();
 734     }
 735 
 736     fr.oops_compiled_arguments_do(signature, has_receiver, has_appendix, reg_map, f);
 737   } else if (method()->is_continuation_enter_intrinsic()) {
 738     // This method only calls Continuation.enter()
 739     Symbol* signature = vmSymbols::continuationEnter_signature();
 740     fr.oops_compiled_arguments_do(signature, false, false, reg_map, f);
 741   }
 742 }
 743 
 744 Method* nmethod::attached_method(address call_instr) {
 745   assert(code_contains(call_instr), "not part of the nmethod");
 746   RelocIterator iter(this, call_instr, call_instr + 1);
 747   while (iter.next()) {
 748     if (iter.addr() == call_instr) {
 749       switch(iter.type()) {
 750         case relocInfo::static_call_type:      return iter.static_call_reloc()->method_value();
 751         case relocInfo::opt_virtual_call_type: return iter.opt_virtual_call_reloc()->method_value();
 752         case relocInfo::virtual_call_type:     return iter.virtual_call_reloc()->method_value();
 753         default:                               break;
 754       }
 755     }
 756   }
 757   return nullptr; // not found
 758 }
 759 
 760 Method* nmethod::attached_method_before_pc(address pc) {
 761   if (NativeCall::is_call_before(pc)) {
 762     NativeCall* ncall = nativeCall_before(pc);
 763     return attached_method(ncall->instruction_address());
 764   }
 765   return nullptr; // not a call
 766 }
 767 
 768 void nmethod::clear_inline_caches() {
 769   assert(SafepointSynchronize::is_at_safepoint() || (NMethodState_lock->owned_by_self() && is_not_installed()), "clearing of IC's only allowed at safepoint or when not installed");
 770   RelocIterator iter(this);
 771   while (iter.next()) {
 772     iter.reloc()->clear_inline_cache();
 773   }
 774 }
 775 
 776 #ifdef ASSERT
 777 // Check class_loader is alive for this bit of metadata.
 778 class CheckClass : public MetadataClosure {
 779   void do_metadata(Metadata* md) {
 780     Klass* klass = nullptr;
 781     if (md->is_klass()) {
 782       klass = ((Klass*)md);
 783     } else if (md->is_method()) {
 784       klass = ((Method*)md)->method_holder();
 785     } else if (md->is_methodData()) {
 786       klass = ((MethodData*)md)->method()->method_holder();
 787     } else if (md->is_methodCounters()) {
 788       klass = ((MethodCounters*)md)->method()->method_holder();
 789     } else {
 790       md->print();
 791       ShouldNotReachHere();
 792     }
 793     assert(klass->is_loader_alive(), "must be alive");
 794   }
 795 };
 796 #endif // ASSERT
 797 
 798 // Clean references to unloaded nmethods at addr from this one, which is not unloaded.
 799 template <typename CallsiteT>
 800 static void clean_if_nmethod_is_unloaded(CallsiteT* callsite, bool clean_all) {
 801   CodeBlob* cb = CodeCache::find_blob(callsite->destination());
 802   if (!cb->is_nmethod()) {
 803     return;
 804   }
 805   nmethod* nm = cb->as_nmethod();
 806   if (clean_all || !nm->is_in_use() || nm->is_unloading() || nm->method()->code() != nm) {
 807     callsite->set_to_clean();
 808   }
 809 }
 810 
 811 // Cleans caches in nmethods that point to either classes that are unloaded
 812 // or nmethods that are unloaded.
 813 //
 814 // Can be called either in parallel by G1 currently or after all
 815 // nmethods are unloaded.  Return postponed=true in the parallel case for
 816 // inline caches found that point to nmethods that are not yet visited during
 817 // the do_unloading walk.
 818 void nmethod::unload_nmethod_caches(bool unloading_occurred) {
 819   ResourceMark rm;
 820 
 821   // Exception cache only needs to be called if unloading occurred
 822   if (unloading_occurred) {
 823     clean_exception_cache();
 824   }
 825 
 826   cleanup_inline_caches_impl(unloading_occurred, false);
 827 
 828 #ifdef ASSERT
 829   // Check that the metadata embedded in the nmethod is alive
 830   CheckClass check_class;
 831   metadata_do(&check_class);
 832 #endif
 833 }
 834 
 835 void nmethod::run_nmethod_entry_barrier() {
 836   BarrierSetNMethod* bs_nm = BarrierSet::barrier_set()->barrier_set_nmethod();
 837   if (bs_nm != nullptr) {
 838     // We want to keep an invariant that nmethods found through iterations of a Thread's
 839     // nmethods found in safepoints have gone through an entry barrier and are not armed.
 840     // By calling this nmethod entry barrier, it plays along and acts
 841     // like any other nmethod found on the stack of a thread (fewer surprises).
 842     nmethod* nm = this;
 843     bool alive = bs_nm->nmethod_entry_barrier(nm);
 844     assert(alive, "should be alive");
 845   }
 846 }
 847 
 848 // Only called by whitebox test
 849 void nmethod::cleanup_inline_caches_whitebox() {
 850   assert_locked_or_safepoint(CodeCache_lock);
 851   CompiledICLocker ic_locker(this);
 852   cleanup_inline_caches_impl(false /* unloading_occurred */, true /* clean_all */);
 853 }
 854 
 855 address* nmethod::orig_pc_addr(const frame* fr) {
 856   return (address*) ((address)fr->unextended_sp() + orig_pc_offset());
 857 }
 858 
 859 // Called to clean up after class unloading for live nmethods
 860 void nmethod::cleanup_inline_caches_impl(bool unloading_occurred, bool clean_all) {
 861   assert(CompiledICLocker::is_safe(this), "mt unsafe call");
 862   ResourceMark rm;
 863 
 864   // Find all calls in an nmethod and clear the ones that point to bad nmethods.
 865   RelocIterator iter(this, oops_reloc_begin());
 866   bool is_in_static_stub = false;
 867   while(iter.next()) {
 868 
 869     switch (iter.type()) {
 870 
 871     case relocInfo::virtual_call_type:
 872       if (unloading_occurred) {
 873         // If class unloading occurred we first clear ICs where the cached metadata
 874         // is referring to an unloaded klass or method.
 875         CompiledIC_at(&iter)->clean_metadata();
 876       }
 877 
 878       clean_if_nmethod_is_unloaded(CompiledIC_at(&iter), clean_all);
 879       break;
 880 
 881     case relocInfo::opt_virtual_call_type:
 882     case relocInfo::static_call_type:
 883       clean_if_nmethod_is_unloaded(CompiledDirectCall::at(iter.reloc()), clean_all);
 884       break;
 885 
 886     case relocInfo::static_stub_type: {
 887       is_in_static_stub = true;
 888       break;
 889     }
 890 
 891     case relocInfo::metadata_type: {
 892       // Only the metadata relocations contained in static/opt virtual call stubs
 893       // contains the Method* passed to c2i adapters. It is the only metadata
 894       // relocation that needs to be walked, as it is the one metadata relocation
 895       // that violates the invariant that all metadata relocations have an oop
 896       // in the compiled method (due to deferred resolution and code patching).
 897 
 898       // This causes dead metadata to remain in compiled methods that are not
 899       // unloading. Unless these slippery metadata relocations of the static
 900       // stubs are at least cleared, subsequent class redefinition operations
 901       // will access potentially free memory, and JavaThread execution
 902       // concurrent to class unloading may call c2i adapters with dead methods.
 903       if (!is_in_static_stub) {
 904         // The first metadata relocation after a static stub relocation is the
 905         // metadata relocation of the static stub used to pass the Method* to
 906         // c2i adapters.
 907         continue;
 908       }
 909       is_in_static_stub = false;
 910       if (is_unloading()) {
 911         // If the nmethod itself is dying, then it may point at dead metadata.
 912         // Nobody should follow that metadata; it is strictly unsafe.
 913         continue;
 914       }
 915       metadata_Relocation* r = iter.metadata_reloc();
 916       Metadata* md = r->metadata_value();
 917       if (md != nullptr && md->is_method()) {
 918         Method* method = static_cast<Method*>(md);
 919         if (!method->method_holder()->is_loader_alive()) {
 920           AtomicAccess::store(r->metadata_addr(), (Method*)nullptr);
 921 
 922           if (!r->metadata_is_immediate()) {
 923             r->fix_metadata_relocation();
 924           }
 925         }
 926       }
 927       break;
 928     }
 929 
 930     default:
 931       break;
 932     }
 933   }
 934 }
 935 
 936 address nmethod::continuation_for_implicit_exception(address pc, bool for_div0_check) {
 937   // Exception happened outside inline-cache check code => we are inside
 938   // an active nmethod => use cpc to determine a return address
 939   int exception_offset = int(pc - code_begin());
 940   int cont_offset = ImplicitExceptionTable(this).continuation_offset( exception_offset );
 941 #ifdef ASSERT
 942   if (cont_offset == 0) {
 943     Thread* thread = Thread::current();
 944     ResourceMark rm(thread);
 945     CodeBlob* cb = CodeCache::find_blob(pc);
 946     assert(cb != nullptr && cb == this, "");
 947 
 948     // Keep tty output consistent. To avoid ttyLocker, we buffer in stream, and print all at once.
 949     stringStream ss;
 950     ss.print_cr("implicit exception happened at " INTPTR_FORMAT, p2i(pc));
 951     print_on(&ss);
 952     method()->print_codes_on(&ss);
 953     print_code_on(&ss);
 954     print_pcs_on(&ss);
 955     tty->print("%s", ss.as_string()); // print all at once
 956   }
 957 #endif
 958   if (cont_offset == 0) {
 959     // Let the normal error handling report the exception
 960     return nullptr;
 961   }
 962   if (cont_offset == exception_offset) {
 963 #if INCLUDE_JVMCI
 964     Deoptimization::DeoptReason deopt_reason = for_div0_check ? Deoptimization::Reason_div0_check : Deoptimization::Reason_null_check;
 965     JavaThread *thread = JavaThread::current();
 966     thread->set_jvmci_implicit_exception_pc(pc);
 967     thread->set_pending_deoptimization(Deoptimization::make_trap_request(deopt_reason,
 968                                                                          Deoptimization::Action_reinterpret));
 969     return (SharedRuntime::deopt_blob()->implicit_exception_uncommon_trap());
 970 #else
 971     ShouldNotReachHere();
 972 #endif
 973   }
 974   return code_begin() + cont_offset;
 975 }
 976 
 977 class HasEvolDependency : public MetadataClosure {
 978   bool _has_evol_dependency;
 979  public:
 980   HasEvolDependency() : _has_evol_dependency(false) {}
 981   void do_metadata(Metadata* md) {
 982     if (md->is_method()) {
 983       Method* method = (Method*)md;
 984       if (method->is_old()) {
 985         _has_evol_dependency = true;
 986       }
 987     }
 988   }
 989   bool has_evol_dependency() const { return _has_evol_dependency; }
 990 };
 991 
 992 bool nmethod::has_evol_metadata() {
 993   // Check the metadata in relocIter and CompiledIC and also deoptimize
 994   // any nmethod that has reference to old methods.
 995   HasEvolDependency check_evol;
 996   metadata_do(&check_evol);
 997   if (check_evol.has_evol_dependency() && log_is_enabled(Debug, redefine, class, nmethod)) {
 998     ResourceMark rm;
 999     log_debug(redefine, class, nmethod)
1000             ("Found evol dependency of nmethod %s.%s(%s) compile_id=%d on in nmethod metadata",
1001              _method->method_holder()->external_name(),
1002              _method->name()->as_C_string(),
1003              _method->signature()->as_C_string(),
1004              compile_id());
1005   }
1006   return check_evol.has_evol_dependency();
1007 }
1008 
1009 int nmethod::total_size() const {
1010   return
1011     consts_size()        +
1012     insts_size()         +
1013     stub_size()          +
1014     scopes_data_size()   +
1015     scopes_pcs_size()    +
1016     handler_table_size() +
1017     nul_chk_table_size();
1018 }
1019 
1020 const char* nmethod::compile_kind() const {
1021   if (is_osr_method())     return "osr";
1022   if (method() != nullptr && is_native_method()) {
1023     if (method()->is_continuation_native_intrinsic()) {
1024       return "cnt";
1025     }
1026     return "c2n";
1027   }
1028   return nullptr;
1029 }
1030 
1031 const char* nmethod::compiler_name() const {
1032   return compilertype2name(_compiler_type);
1033 }
1034 
1035 #ifdef ASSERT
1036 class CheckForOopsClosure : public OopClosure {
1037   bool _found_oop = false;
1038  public:
1039   virtual void do_oop(oop* o) { _found_oop = true; }
1040   virtual void do_oop(narrowOop* o) { _found_oop = true; }
1041   bool found_oop() { return _found_oop; }
1042 };
1043 class CheckForMetadataClosure : public MetadataClosure {
1044   bool _found_metadata = false;
1045   Metadata* _ignore = nullptr;
1046  public:
1047   CheckForMetadataClosure(Metadata* ignore) : _ignore(ignore) {}
1048   virtual void do_metadata(Metadata* md) { if (md != _ignore) _found_metadata = true; }
1049   bool found_metadata() { return _found_metadata; }
1050 };
1051 
1052 static void assert_no_oops_or_metadata(nmethod* nm) {
1053   if (nm == nullptr) return;
1054   assert(nm->oop_maps() == nullptr, "expectation");
1055 
1056   CheckForOopsClosure cfo;
1057   nm->oops_do(&cfo);
1058   assert(!cfo.found_oop(), "no oops allowed");
1059 
1060   // We allow an exception for the own Method, but require its class to be permanent.
1061   Method* own_method = nm->method();
1062   CheckForMetadataClosure cfm(/* ignore reference to own Method */ own_method);
1063   nm->metadata_do(&cfm);
1064   assert(!cfm.found_metadata(), "no metadata allowed");
1065 
1066   assert(own_method->method_holder()->class_loader_data()->is_permanent_class_loader_data(),
1067          "Method's class needs to be permanent");
1068 }
1069 #endif
1070 
1071 static int required_mutable_data_size(CodeBuffer* code_buffer,
1072                                       int jvmci_data_size = 0) {
1073   return align_up(code_buffer->total_relocation_size(), oopSize) +
1074          align_up(code_buffer->total_metadata_size(), oopSize) +
1075          align_up(jvmci_data_size, oopSize);
1076 }
1077 
1078 nmethod* nmethod::new_native_nmethod(const methodHandle& method,
1079   int compile_id,
1080   CodeBuffer *code_buffer,
1081   int vep_offset,
1082   int frame_complete,
1083   int frame_size,
1084   ByteSize basic_lock_owner_sp_offset,
1085   ByteSize basic_lock_sp_offset,
1086   OopMapSet* oop_maps,
1087   int exception_handler) {
1088   code_buffer->finalize_oop_references(method);
1089   // create nmethod
1090   nmethod* nm = nullptr;
1091   int native_nmethod_size = CodeBlob::allocation_size(code_buffer, sizeof(nmethod));
1092   {
1093     MutexLocker mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);
1094 
1095     CodeOffsets offsets;
1096     offsets.set_value(CodeOffsets::Verified_Entry, vep_offset);
1097     offsets.set_value(CodeOffsets::Frame_Complete, frame_complete);
1098     if (exception_handler != -1) {
1099       offsets.set_value(CodeOffsets::Exceptions, exception_handler);
1100     }
1101 
1102     int mutable_data_size = required_mutable_data_size(code_buffer);
1103 
1104     // MH intrinsics are dispatch stubs which are compatible with NonNMethod space.
1105     // IsUnloadingBehaviour::is_unloading needs to handle them separately.
1106     bool allow_NonNMethod_space = method->can_be_allocated_in_NonNMethod_space();
1107     nm = new (native_nmethod_size, allow_NonNMethod_space)
1108     nmethod(method(), compiler_none, native_nmethod_size,
1109             compile_id, &offsets,
1110             code_buffer, frame_size,
1111             basic_lock_owner_sp_offset,
1112             basic_lock_sp_offset,
1113             oop_maps, mutable_data_size);
1114     DEBUG_ONLY( if (allow_NonNMethod_space) assert_no_oops_or_metadata(nm); )
1115     NOT_PRODUCT(if (nm != nullptr) native_nmethod_stats.note_native_nmethod(nm));
1116   }
1117 
1118   if (nm != nullptr) {
1119     // verify nmethod
1120     DEBUG_ONLY(nm->verify();) // might block
1121 
1122     nm->log_new_nmethod();
1123   }
1124   return nm;
1125 }
1126 
1127 nmethod* nmethod::new_nmethod(const methodHandle& method,
1128   int compile_id,
1129   int entry_bci,
1130   CodeOffsets* offsets,
1131   int orig_pc_offset,
1132   DebugInformationRecorder* debug_info,
1133   Dependencies* dependencies,
1134   CodeBuffer* code_buffer, int frame_size,
1135   OopMapSet* oop_maps,
1136   ExceptionHandlerTable* handler_table,
1137   ImplicitExceptionTable* nul_chk_table,
1138   AbstractCompiler* compiler,
1139   CompLevel comp_level
1140 #if INCLUDE_JVMCI
1141   , char* speculations,
1142   int speculations_len,
1143   JVMCINMethodData* jvmci_data
1144 #endif
1145 )
1146 {
1147   assert(debug_info->oop_recorder() == code_buffer->oop_recorder(), "shared OR");
1148   code_buffer->finalize_oop_references(method);
1149   // create nmethod
1150   nmethod* nm = nullptr;
1151   int nmethod_size = CodeBlob::allocation_size(code_buffer, sizeof(nmethod));
1152 
1153   int immutable_data_size =
1154       adjust_pcs_size(debug_info->pcs_size())
1155     + align_up((int)dependencies->size_in_bytes(), oopSize)
1156     + align_up(handler_table->size_in_bytes()    , oopSize)
1157     + align_up(nul_chk_table->size_in_bytes()    , oopSize)
1158 #if INCLUDE_JVMCI
1159     + align_up(speculations_len                  , oopSize)
1160 #endif
1161     + align_up(debug_info->data_size()           , oopSize)
1162     + ImmutableDataReferencesCounterSize;
1163 
1164   // First, allocate space for immutable data in C heap.
1165   address immutable_data = nullptr;
1166   if (immutable_data_size > 0) {
1167     immutable_data = (address)os::malloc(immutable_data_size, mtCode);
1168     if (immutable_data == nullptr) {
1169       vm_exit_out_of_memory(immutable_data_size, OOM_MALLOC_ERROR, "nmethod: no space for immutable data");
1170       return nullptr;
1171     }
1172   }
1173 
1174   int mutable_data_size = required_mutable_data_size(code_buffer
1175     JVMCI_ONLY(COMMA (compiler->is_jvmci() ? jvmci_data->size() : 0)));
1176 
1177   {
1178     MutexLocker mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);
1179 
1180     nm = new (nmethod_size, comp_level)
1181     nmethod(method(), compiler->type(), nmethod_size, immutable_data_size, mutable_data_size,
1182             compile_id, entry_bci, immutable_data, offsets, orig_pc_offset,
1183             debug_info, dependencies, code_buffer, frame_size, oop_maps,
1184             handler_table, nul_chk_table, compiler, comp_level
1185 #if INCLUDE_JVMCI
1186             , speculations,
1187             speculations_len,
1188             jvmci_data
1189 #endif
1190             );
1191 
1192     if (nm != nullptr) {
1193       // To make dependency checking during class loading fast, record
1194       // the nmethod dependencies in the classes it is dependent on.
1195       // This allows the dependency checking code to simply walk the
1196       // class hierarchy above the loaded class, checking only nmethods
1197       // which are dependent on those classes.  The slow way is to
1198       // check every nmethod for dependencies which makes it linear in
1199       // the number of methods compiled.  For applications with a lot
1200       // classes the slow way is too slow.
1201       for (Dependencies::DepStream deps(nm); deps.next(); ) {
1202         if (deps.type() == Dependencies::call_site_target_value) {
1203           // CallSite dependencies are managed on per-CallSite instance basis.
1204           oop call_site = deps.argument_oop(0);
1205           MethodHandles::add_dependent_nmethod(call_site, nm);
1206         } else {
1207           InstanceKlass* ik = deps.context_type();
1208           if (ik == nullptr) {
1209             continue;  // ignore things like evol_method
1210           }
1211           // record this nmethod as dependent on this klass
1212           ik->add_dependent_nmethod(nm);
1213         }
1214       }
1215       NOT_PRODUCT(if (nm != nullptr)  note_java_nmethod(nm));
1216     }
1217   }
1218   // Do verification and logging outside CodeCache_lock.
1219   if (nm != nullptr) {
1220     // Safepoints in nmethod::verify aren't allowed because nm hasn't been installed yet.
1221     DEBUG_ONLY(nm->verify();)
1222     nm->log_new_nmethod();
1223   }
1224   return nm;
1225 }
1226 
1227 // Fill in default values for various fields
1228 void nmethod::init_defaults(CodeBuffer *code_buffer, CodeOffsets* offsets) {
1229   // avoid uninitialized fields, even for short time periods
1230   _exception_cache            = nullptr;
1231   _gc_data                    = nullptr;
1232   _oops_do_mark_link          = nullptr;
1233   _compiled_ic_data           = nullptr;
1234 
1235   _is_unloading_state         = 0;
1236   _state                      = not_installed;
1237 
1238   _has_unsafe_access          = 0;
1239   _has_wide_vectors           = 0;
1240   _has_monitors               = 0;
1241   _has_scoped_access          = 0;
1242   _has_flushed_dependencies   = 0;
1243   _is_unlinked                = 0;
1244   _load_reported              = 0; // jvmti state
1245 
1246   _deoptimization_status      = not_marked;
1247 
1248   // SECT_CONSTS is first in code buffer so the offset should be 0.
1249   int consts_offset = code_buffer->total_offset_of(code_buffer->consts());
1250   assert(consts_offset == 0, "const_offset: %d", consts_offset);
1251 
1252   _stub_offset = content_offset() + code_buffer->total_offset_of(code_buffer->stubs());
1253 
1254   CHECKED_CAST(_entry_offset,              uint16_t, (offsets->value(CodeOffsets::Entry)));
1255   CHECKED_CAST(_verified_entry_offset,     uint16_t, (offsets->value(CodeOffsets::Verified_Entry)));
1256 
1257   _inline_entry_point             = entry_point();
1258   _verified_inline_entry_point    = verified_entry_point();
1259   _verified_inline_ro_entry_point = verified_entry_point();
1260 
1261   _skipped_instructions_size = code_buffer->total_skipped_instructions_size();
1262 }
1263 
1264 // Post initialization
1265 void nmethod::post_init() {
1266   clear_unloading_state();
1267 
1268   finalize_relocations();
1269 
1270   Universe::heap()->register_nmethod(this);
1271   DEBUG_ONLY(Universe::heap()->verify_nmethod(this));
1272 
1273   CodeCache::commit(this);
1274 }
1275 
1276 // For native wrappers
1277 nmethod::nmethod(
1278   Method* method,
1279   CompilerType type,
1280   int nmethod_size,
1281   int compile_id,
1282   CodeOffsets* offsets,
1283   CodeBuffer* code_buffer,
1284   int frame_size,
1285   ByteSize basic_lock_owner_sp_offset,
1286   ByteSize basic_lock_sp_offset,
1287   OopMapSet* oop_maps,
1288   int mutable_data_size)
1289   : CodeBlob("native nmethod", CodeBlobKind::Nmethod, code_buffer, nmethod_size, sizeof(nmethod),
1290              offsets->value(CodeOffsets::Frame_Complete), frame_size, oop_maps, false, mutable_data_size),
1291   _deoptimization_generation(0),
1292   _gc_epoch(CodeCache::gc_epoch()),
1293   _method(method),
1294   _native_receiver_sp_offset(basic_lock_owner_sp_offset),
1295   _native_basic_lock_sp_offset(basic_lock_sp_offset)
1296 {
1297   {
1298     DEBUG_ONLY(NoSafepointVerifier nsv;)
1299     assert_locked_or_safepoint(CodeCache_lock);
1300     assert(!method->has_scalarized_args(), "scalarized native wrappers not supported yet");
1301     init_defaults(code_buffer, offsets);
1302 
1303     _osr_entry_point         = nullptr;
1304     _pc_desc_container       = nullptr;
1305     _entry_bci               = InvocationEntryBci;
1306     _compile_id              = compile_id;
1307     _comp_level              = CompLevel_none;
1308     _compiler_type           = type;
1309     _orig_pc_offset          = 0;
1310     _num_stack_arg_slots     = 0;
1311 
1312     if (offsets->value(CodeOffsets::Exceptions) != -1) {
1313       // Continuation enter intrinsic
1314       _exception_offset      = code_offset() + offsets->value(CodeOffsets::Exceptions);
1315     } else {
1316       _exception_offset      = 0;
1317     }
1318     // Native wrappers do not have deopt handlers. Make the values
1319     // something that will never match a pc like the nmethod vtable entry
1320     _deopt_handler_offset    = 0;
1321     _unwind_handler_offset   = 0;
1322 
1323     CHECKED_CAST(_oops_size, uint16_t, align_up(code_buffer->total_oop_size(), oopSize));
1324     uint16_t metadata_size;
1325     CHECKED_CAST(metadata_size, uint16_t, align_up(code_buffer->total_metadata_size(), wordSize));
1326     JVMCI_ONLY( _metadata_size = metadata_size; )
1327     assert(_mutable_data_size == _relocation_size + metadata_size,
1328            "wrong mutable data size: %d != %d + %d",
1329            _mutable_data_size, _relocation_size, metadata_size);
1330 
1331     // native wrapper does not have read-only data but we need unique not null address
1332     _immutable_data          = blob_end();
1333     _immutable_data_size     = 0;
1334     _nul_chk_table_offset    = 0;
1335     _handler_table_offset    = 0;
1336     _scopes_pcs_offset       = 0;
1337     _scopes_data_offset      = 0;
1338 #if INCLUDE_JVMCI
1339     _speculations_offset     = 0;
1340 #endif
1341     _immutable_data_reference_counter_offset = 0;
1342 
1343     code_buffer->copy_code_and_locs_to(this);
1344     code_buffer->copy_values_to(this);
1345 
1346     post_init();
1347   }
1348 
1349   if (PrintNativeNMethods || PrintDebugInfo || PrintRelocations || PrintDependencies) {
1350     ttyLocker ttyl;  // keep the following output all in one block
1351     // This output goes directly to the tty, not the compiler log.
1352     // To enable tools to match it up with the compilation activity,
1353     // be sure to tag this tty output with the compile ID.
1354     if (xtty != nullptr) {
1355       xtty->begin_head("print_native_nmethod");
1356       xtty->method(_method);
1357       xtty->stamp();
1358       xtty->end_head(" address='" INTPTR_FORMAT "'", (intptr_t) this);
1359     }
1360     // Print the header part, then print the requested information.
1361     // This is both handled in decode2(), called via print_code() -> decode()
1362     if (PrintNativeNMethods) {
1363       tty->print_cr("-------------------------- Assembly (native nmethod) ---------------------------");
1364       print_code();
1365       tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
1366 #if defined(SUPPORT_DATA_STRUCTS)
1367       if (AbstractDisassembler::show_structs()) {
1368         if (oop_maps != nullptr) {
1369           tty->print("oop maps:"); // oop_maps->print_on(tty) outputs a cr() at the beginning
1370           oop_maps->print_on(tty);
1371           tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
1372         }
1373       }
1374 #endif
1375     } else {
1376       print(); // print the header part only.
1377     }
1378 #if defined(SUPPORT_DATA_STRUCTS)
1379     if (AbstractDisassembler::show_structs()) {
1380       if (PrintRelocations) {
1381         print_relocations();
1382         tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
1383       }
1384     }
1385 #endif
1386     if (xtty != nullptr) {
1387       xtty->tail("print_native_nmethod");
1388     }
1389   }
1390 }
1391 
1392 
1393 nmethod::nmethod(const nmethod &nm) : CodeBlob(nm._name, nm._kind, nm._size, nm._header_size)
1394 {
1395 
1396   if (nm._oop_maps != nullptr) {
1397     _oop_maps                   = nm._oop_maps->clone();
1398   } else {
1399     _oop_maps                   = nullptr;
1400   }
1401 
1402   _size                         = nm._size;
1403   _relocation_size              = nm._relocation_size;
1404   _content_offset               = nm._content_offset;
1405   _code_offset                  = nm._code_offset;
1406   _data_offset                  = nm._data_offset;
1407   _frame_size                   = nm._frame_size;
1408 
1409   S390_ONLY( _ctable_offset     = nm._ctable_offset; )
1410 
1411   _header_size                  = nm._header_size;
1412   _frame_complete_offset        = nm._frame_complete_offset;
1413 
1414   _kind                         = nm._kind;
1415 
1416   _caller_must_gc_arguments     = nm._caller_must_gc_arguments;
1417 
1418 #ifndef PRODUCT
1419   _asm_remarks.share(nm._asm_remarks);
1420   _dbg_strings.share(nm._dbg_strings);
1421 #endif
1422 
1423   // Allocate memory and copy mutable data to C heap
1424   _mutable_data_size            = nm._mutable_data_size;
1425   if (_mutable_data_size > 0) {
1426     _mutable_data = (address)os::malloc(_mutable_data_size, mtCode);
1427     if (_mutable_data == nullptr) {
1428       vm_exit_out_of_memory(_mutable_data_size, OOM_MALLOC_ERROR, "nmethod: no space for mutable data");
1429     }
1430     memcpy(mutable_data_begin(), nm.mutable_data_begin(), nm.mutable_data_size());
1431   } else {
1432     _mutable_data               = nullptr;
1433   }
1434 
1435   _deoptimization_generation    = 0;
1436   _gc_epoch                     = CodeCache::gc_epoch();
1437   _method                       = nm._method;
1438   _osr_link                     = nullptr;
1439 
1440   _exception_cache              = nullptr;
1441   _gc_data                      = nullptr;
1442   _oops_do_mark_nmethods        = nullptr;
1443   _oops_do_mark_link            = nullptr;
1444   _compiled_ic_data             = nullptr;
1445 
1446   if (nm._osr_entry_point != nullptr) {
1447     _osr_entry_point            = (nm._osr_entry_point - (address) &nm) + (address) this;
1448   } else {
1449     _osr_entry_point            = nullptr;
1450   }
1451 
1452   _entry_offset                 = nm._entry_offset;
1453   _verified_entry_offset        = nm._verified_entry_offset;
1454   _entry_bci                    = nm._entry_bci;
1455   _immutable_data_size          = nm._immutable_data_size;
1456 
1457   _skipped_instructions_size    = nm._skipped_instructions_size;
1458   _stub_offset                  = nm._stub_offset;
1459   _exception_offset             = nm._exception_offset;
1460   _deopt_handler_offset         = nm._deopt_handler_offset;
1461   _unwind_handler_offset        = nm._unwind_handler_offset;
1462   _num_stack_arg_slots          = nm._num_stack_arg_slots;
1463   _oops_size                    = nm._oops_size;
1464 #if INCLUDE_JVMCI
1465   _metadata_size                = nm._metadata_size;
1466 #endif
1467   _nul_chk_table_offset         = nm._nul_chk_table_offset;
1468   _handler_table_offset         = nm._handler_table_offset;
1469   _scopes_pcs_offset            = nm._scopes_pcs_offset;
1470   _scopes_data_offset           = nm._scopes_data_offset;
1471 #if INCLUDE_JVMCI
1472   _speculations_offset          = nm._speculations_offset;
1473 #endif
1474   _immutable_data_reference_counter_offset = nm._immutable_data_reference_counter_offset;
1475 
1476   // Increment number of references to immutable data to share it between nmethods
1477   if (_immutable_data_size > 0) {
1478     _immutable_data             = nm._immutable_data;
1479     set_immutable_data_references_counter(get_immutable_data_references_counter() + 1);
1480   } else {
1481     _immutable_data             = blob_end();
1482   }
1483 
1484   _orig_pc_offset               = nm._orig_pc_offset;
1485   _compile_id                   = nm._compile_id;
1486   _comp_level                   = nm._comp_level;
1487   _compiler_type                = nm._compiler_type;
1488   _is_unloading_state           = nm._is_unloading_state;
1489   _state                        = not_installed;
1490 
1491   _has_unsafe_access            = nm._has_unsafe_access;
1492   _has_wide_vectors             = nm._has_wide_vectors;
1493   _has_monitors                 = nm._has_monitors;
1494   _has_scoped_access            = nm._has_scoped_access;
1495   _has_flushed_dependencies     = nm._has_flushed_dependencies;
1496   _is_unlinked                  = nm._is_unlinked;
1497   _load_reported                = nm._load_reported;
1498 
1499   _deoptimization_status        = nm._deoptimization_status;
1500 
1501   if (nm._pc_desc_container != nullptr) {
1502     _pc_desc_container          = new PcDescContainer(scopes_pcs_begin());
1503   } else {
1504     _pc_desc_container          = nullptr;
1505   }
1506 
1507   // Copy nmethod contents excluding header
1508   // - Constant part          (doubles, longs and floats used in nmethod)
1509   // - Code part:
1510   //   - Code body
1511   //   - Exception handler
1512   //   - Stub code
1513   //   - OOP table
1514   memcpy(consts_begin(), nm.consts_begin(), nm.data_end() - nm.consts_begin());
1515 
1516   post_init();
1517 }
1518 
1519 nmethod* nmethod::relocate(CodeBlobType code_blob_type) {
1520   assert(NMethodRelocation, "must enable use of function");
1521 
1522   // Locks required to be held by caller to ensure the nmethod
1523   // is not modified or purged from code cache during relocation
1524   assert_lock_strong(CodeCache_lock);
1525   assert_lock_strong(Compile_lock);
1526   assert(CompiledICLocker::is_safe(this), "mt unsafe call");
1527 
1528   if (!is_relocatable()) {
1529     return nullptr;
1530   }
1531 
1532   run_nmethod_entry_barrier();
1533   nmethod* nm_copy = new (size(), code_blob_type) nmethod(*this);
1534 
1535   if (nm_copy == nullptr) {
1536     return nullptr;
1537   }
1538 
1539   // Fix relocation
1540   RelocIterator iter(nm_copy);
1541   CodeBuffer src(this);
1542   CodeBuffer dst(nm_copy);
1543   while (iter.next()) {
1544 #ifdef USE_TRAMPOLINE_STUB_FIX_OWNER
1545     // Direct calls may no longer be in range and the use of a trampoline may now be required.
1546     // Instead, allow trampoline relocations to update their owners and perform the necessary checks.
1547     if (iter.reloc()->is_call()) {
1548       address trampoline = trampoline_stub_Relocation::get_trampoline_for(iter.reloc()->addr(), nm_copy);
1549       if (trampoline != nullptr) {
1550         continue;
1551       }
1552     }
1553 #endif
1554 
1555     iter.reloc()->fix_relocation_after_move(&src, &dst);
1556   }
1557 
1558   // To make dependency checking during class loading fast, record
1559   // the nmethod dependencies in the classes it is dependent on.
1560   // This allows the dependency checking code to simply walk the
1561   // class hierarchy above the loaded class, checking only nmethods
1562   // which are dependent on those classes.  The slow way is to
1563   // check every nmethod for dependencies which makes it linear in
1564   // the number of methods compiled.  For applications with a lot
1565   // classes the slow way is too slow.
1566   for (Dependencies::DepStream deps(nm_copy); deps.next(); ) {
1567     if (deps.type() == Dependencies::call_site_target_value) {
1568       // CallSite dependencies are managed on per-CallSite instance basis.
1569       oop call_site = deps.argument_oop(0);
1570       MethodHandles::add_dependent_nmethod(call_site, nm_copy);
1571     } else {
1572       InstanceKlass* ik = deps.context_type();
1573       if (ik == nullptr) {
1574         continue;  // ignore things like evol_method
1575       }
1576       // record this nmethod as dependent on this klass
1577       ik->add_dependent_nmethod(nm_copy);
1578     }
1579   }
1580 
1581   MutexLocker ml_NMethodState_lock(NMethodState_lock, Mutex::_no_safepoint_check_flag);
1582 
1583   // Verify the nm we copied from is still valid
1584   if (!is_marked_for_deoptimization() && is_in_use()) {
1585     assert(method() != nullptr && method()->code() == this, "should be if is in use");
1586 
1587     nm_copy->clear_inline_caches();
1588 
1589     // Attempt to start using the copy
1590     if (nm_copy->make_in_use()) {
1591       ICache::invalidate_range(nm_copy->code_begin(), nm_copy->code_size());
1592 
1593       methodHandle mh(Thread::current(), nm_copy->method());
1594       nm_copy->method()->set_code(mh, nm_copy);
1595 
1596       make_not_used();
1597 
1598       nm_copy->post_compiled_method_load_event();
1599 
1600       nm_copy->log_relocated_nmethod(this);
1601 
1602       return nm_copy;
1603     }
1604   }
1605 
1606   nm_copy->make_not_used();
1607 
1608   return nullptr;
1609 }
1610 
1611 bool nmethod::is_relocatable() {
1612   if (!is_java_method()) {
1613     return false;
1614   }
1615 
1616   if (!is_in_use()) {
1617     return false;
1618   }
1619 
1620   if (is_osr_method()) {
1621     return false;
1622   }
1623 
1624   if (is_marked_for_deoptimization()) {
1625     return false;
1626   }
1627 
1628 #if INCLUDE_JVMCI
1629   if (jvmci_nmethod_data() != nullptr && jvmci_nmethod_data()->has_mirror()) {
1630     return false;
1631   }
1632 #endif
1633 
1634   if (is_unloading()) {
1635     return false;
1636   }
1637 
1638   if (has_evol_metadata()) {
1639     return false;
1640   }
1641 
1642   return true;
1643 }
1644 
1645 void* nmethod::operator new(size_t size, int nmethod_size, int comp_level) throw () {
1646   return CodeCache::allocate(nmethod_size, CodeCache::get_code_blob_type(comp_level));
1647 }
1648 
1649 void* nmethod::operator new(size_t size, int nmethod_size, CodeBlobType code_blob_type) throw () {
1650   return CodeCache::allocate(nmethod_size, code_blob_type);
1651 }
1652 
1653 void* nmethod::operator new(size_t size, int nmethod_size, bool allow_NonNMethod_space) throw () {
1654   // Try MethodNonProfiled and MethodProfiled.
1655   void* return_value = CodeCache::allocate(nmethod_size, CodeBlobType::MethodNonProfiled);
1656   if (return_value != nullptr || !allow_NonNMethod_space) return return_value;
1657   // Try NonNMethod or give up.
1658   return CodeCache::allocate(nmethod_size, CodeBlobType::NonNMethod);
1659 }
1660 
1661 // For normal JIT compiled code
1662 nmethod::nmethod(
1663   Method* method,
1664   CompilerType type,
1665   int nmethod_size,
1666   int immutable_data_size,
1667   int mutable_data_size,
1668   int compile_id,
1669   int entry_bci,
1670   address immutable_data,
1671   CodeOffsets* offsets,
1672   int orig_pc_offset,
1673   DebugInformationRecorder* debug_info,
1674   Dependencies* dependencies,
1675   CodeBuffer *code_buffer,
1676   int frame_size,
1677   OopMapSet* oop_maps,
1678   ExceptionHandlerTable* handler_table,
1679   ImplicitExceptionTable* nul_chk_table,
1680   AbstractCompiler* compiler,
1681   CompLevel comp_level
1682 #if INCLUDE_JVMCI
1683   , char* speculations,
1684   int speculations_len,
1685   JVMCINMethodData* jvmci_data
1686 #endif
1687   )
1688   : CodeBlob("nmethod", CodeBlobKind::Nmethod, code_buffer, nmethod_size, sizeof(nmethod),
1689              offsets->value(CodeOffsets::Frame_Complete), frame_size, oop_maps, false, mutable_data_size),
1690   _deoptimization_generation(0),
1691   _gc_epoch(CodeCache::gc_epoch()),
1692   _method(method),
1693   _osr_link(nullptr)
1694 {
1695   assert(debug_info->oop_recorder() == code_buffer->oop_recorder(), "shared OR");
1696   {
1697     DEBUG_ONLY(NoSafepointVerifier nsv;)
1698     assert_locked_or_safepoint(CodeCache_lock);
1699 
1700     init_defaults(code_buffer, offsets);
1701 
1702     _osr_entry_point = code_begin() + offsets->value(CodeOffsets::OSR_Entry);
1703     _entry_bci       = entry_bci;
1704     _compile_id      = compile_id;
1705     _comp_level      = comp_level;
1706     _compiler_type   = type;
1707     _orig_pc_offset  = orig_pc_offset;
1708 
1709     _num_stack_arg_slots = entry_bci != InvocationEntryBci ? 0 : _method->constMethod()->num_stack_arg_slots();
1710 
1711     set_ctable_begin(header_begin() + content_offset());
1712 
1713 #if INCLUDE_JVMCI
1714     if (compiler->is_jvmci()) {
1715       // JVMCI might not produce any stub sections
1716       if (offsets->value(CodeOffsets::Exceptions) != -1) {
1717         _exception_offset        = code_offset() + offsets->value(CodeOffsets::Exceptions);
1718       } else {
1719         _exception_offset        = -1;
1720       }
1721       if (offsets->value(CodeOffsets::Deopt) != -1) {
1722         _deopt_handler_offset    = code_offset() + offsets->value(CodeOffsets::Deopt);
1723       } else {
1724         _deopt_handler_offset    = -1;
1725       }
1726     } else
1727 #endif
1728     {
1729       // Exception handler and deopt handler are in the stub section
1730       assert(offsets->value(CodeOffsets::Exceptions) != -1, "must be set");
1731       assert(offsets->value(CodeOffsets::Deopt     ) != -1, "must be set");
1732 
1733       _exception_offset          = _stub_offset + offsets->value(CodeOffsets::Exceptions);
1734       _deopt_handler_offset      = _stub_offset + offsets->value(CodeOffsets::Deopt);
1735     }
1736     if (offsets->value(CodeOffsets::UnwindHandler) != -1) {
1737       // C1 generates UnwindHandler at the end of instructions section.
1738       // Calculate positive offset as distance between the start of stubs section
1739       // (which is also the end of instructions section) and the start of the handler.
1740       int unwind_handler_offset = code_offset() + offsets->value(CodeOffsets::UnwindHandler);
1741       CHECKED_CAST(_unwind_handler_offset, int16_t, (_stub_offset - unwind_handler_offset));
1742     } else {
1743       _unwind_handler_offset = -1;
1744     }
1745 
1746     CHECKED_CAST(_oops_size, uint16_t, align_up(code_buffer->total_oop_size(), oopSize));
1747     uint16_t metadata_size;
1748     CHECKED_CAST(metadata_size, uint16_t, align_up(code_buffer->total_metadata_size(), wordSize));
1749     JVMCI_ONLY( _metadata_size = metadata_size; )
1750     int jvmci_data_size = 0 JVMCI_ONLY( + align_up(compiler->is_jvmci() ? jvmci_data->size() : 0, oopSize));
1751     _inline_entry_point             = code_begin() + offsets->value(CodeOffsets::Inline_Entry);
1752     _verified_inline_entry_point    = code_begin() + offsets->value(CodeOffsets::Verified_Inline_Entry);
1753     _verified_inline_ro_entry_point = code_begin() + offsets->value(CodeOffsets::Verified_Inline_Entry_RO);
1754 
1755     assert(_mutable_data_size == _relocation_size + metadata_size + jvmci_data_size,
1756            "wrong mutable data size: %d != %d + %d + %d",
1757            _mutable_data_size, _relocation_size, metadata_size, jvmci_data_size);
1758     assert(nmethod_size == data_end() - header_begin(), "wrong nmethod size: %d != %d",
1759            nmethod_size, (int)(code_end() - header_begin()));
1760 
1761     _immutable_data_size  = immutable_data_size;
1762     if (immutable_data_size > 0) {
1763       assert(immutable_data != nullptr, "required");
1764       _immutable_data     = immutable_data;
1765     } else {
1766       // We need unique not null address
1767       _immutable_data     = blob_end();
1768     }
1769     CHECKED_CAST(_nul_chk_table_offset, uint16_t, (align_up((int)dependencies->size_in_bytes(), oopSize)));
1770     CHECKED_CAST(_handler_table_offset, uint16_t, (_nul_chk_table_offset + align_up(nul_chk_table->size_in_bytes(), oopSize)));
1771     _scopes_pcs_offset    = _handler_table_offset + align_up(handler_table->size_in_bytes(), oopSize);
1772     _scopes_data_offset   = _scopes_pcs_offset    + adjust_pcs_size(debug_info->pcs_size());
1773 
1774 #if INCLUDE_JVMCI
1775     _speculations_offset  = _scopes_data_offset   + align_up(debug_info->data_size(), oopSize);
1776     _immutable_data_reference_counter_offset = _speculations_offset + align_up(speculations_len, oopSize);
1777     DEBUG_ONLY( int immutable_data_end_offset = _immutable_data_reference_counter_offset + ImmutableDataReferencesCounterSize; )
1778 #else
1779     _immutable_data_reference_counter_offset =  _scopes_data_offset + align_up(debug_info->data_size(), oopSize);
1780     DEBUG_ONLY( int immutable_data_end_offset = _immutable_data_reference_counter_offset + ImmutableDataReferencesCounterSize; )
1781 #endif
1782     assert(immutable_data_end_offset <= immutable_data_size, "wrong read-only data size: %d > %d",
1783            immutable_data_end_offset, immutable_data_size);
1784 
1785     // Copy code and relocation info
1786     code_buffer->copy_code_and_locs_to(this);
1787     // Copy oops and metadata
1788     code_buffer->copy_values_to(this);
1789     dependencies->copy_to(this);
1790     // Copy PcDesc and ScopeDesc data
1791     debug_info->copy_to(this);
1792 
1793     // Create cache after PcDesc data is copied - it will be used to initialize cache
1794     _pc_desc_container = new PcDescContainer(scopes_pcs_begin());
1795 
1796 #if INCLUDE_JVMCI
1797     if (compiler->is_jvmci()) {
1798       // Initialize the JVMCINMethodData object inlined into nm
1799       jvmci_nmethod_data()->copy(jvmci_data);
1800     }
1801 #endif
1802 
1803     // Copy contents of ExceptionHandlerTable to nmethod
1804     handler_table->copy_to(this);
1805     nul_chk_table->copy_to(this);
1806 
1807 #if INCLUDE_JVMCI
1808     // Copy speculations to nmethod
1809     if (speculations_size() != 0) {
1810       memcpy(speculations_begin(), speculations, speculations_len);
1811     }
1812 #endif
1813     set_immutable_data_references_counter(1);
1814 
1815     post_init();
1816 
1817     // we use the information of entry points to find out if a method is
1818     // static or non static
1819     assert(compiler->is_c2() || compiler->is_jvmci() ||
1820            _method->is_static() == (entry_point() == verified_entry_point()),
1821            " entry points must be same for static methods and vice versa");
1822   }
1823 }
1824 
1825 // Print a short set of xml attributes to identify this nmethod.  The
1826 // output should be embedded in some other element.
1827 void nmethod::log_identity(xmlStream* log) const {
1828   log->print(" compile_id='%d'", compile_id());
1829   const char* nm_kind = compile_kind();
1830   if (nm_kind != nullptr)  log->print(" compile_kind='%s'", nm_kind);
1831   log->print(" compiler='%s'", compiler_name());
1832   if (TieredCompilation) {
1833     log->print(" level='%d'", comp_level());
1834   }
1835 #if INCLUDE_JVMCI
1836   if (jvmci_nmethod_data() != nullptr) {
1837     const char* jvmci_name = jvmci_nmethod_data()->name();
1838     if (jvmci_name != nullptr) {
1839       log->print(" jvmci_mirror_name='");
1840       log->text("%s", jvmci_name);
1841       log->print("'");
1842     }
1843   }
1844 #endif
1845 }
1846 
1847 
1848 #define LOG_OFFSET(log, name)                    \
1849   if (p2i(name##_end()) - p2i(name##_begin())) \
1850     log->print(" " XSTR(name) "_offset='%zd'"    , \
1851                p2i(name##_begin()) - p2i(this))
1852 
1853 
1854 void nmethod::log_new_nmethod() const {
1855   if (LogCompilation && xtty != nullptr) {
1856     ttyLocker ttyl;
1857     xtty->begin_elem("nmethod");
1858     log_identity(xtty);
1859     xtty->print(" entry='" INTPTR_FORMAT "' size='%d'", p2i(code_begin()), size());
1860     xtty->print(" address='" INTPTR_FORMAT "'", p2i(this));
1861 
1862     LOG_OFFSET(xtty, relocation);
1863     LOG_OFFSET(xtty, consts);
1864     LOG_OFFSET(xtty, insts);
1865     LOG_OFFSET(xtty, stub);
1866     LOG_OFFSET(xtty, scopes_data);
1867     LOG_OFFSET(xtty, scopes_pcs);
1868     LOG_OFFSET(xtty, dependencies);
1869     LOG_OFFSET(xtty, handler_table);
1870     LOG_OFFSET(xtty, nul_chk_table);
1871     LOG_OFFSET(xtty, oops);
1872     LOG_OFFSET(xtty, metadata);
1873 
1874     xtty->method(method());
1875     xtty->stamp();
1876     xtty->end_elem();
1877   }
1878 }
1879 
1880 
1881 void nmethod::log_relocated_nmethod(nmethod* original) const {
1882   if (LogCompilation && xtty != nullptr) {
1883     ttyLocker ttyl;
1884     xtty->begin_elem("relocated nmethod");
1885     log_identity(xtty);
1886     xtty->print(" entry='" INTPTR_FORMAT "' size='%d'", p2i(code_begin()), size());
1887 
1888     const char* original_code_heap_name = CodeCache::get_code_heap_name(CodeCache::get_code_blob_type(original));
1889     xtty->print(" original_address='" INTPTR_FORMAT "'", p2i(original));
1890     xtty->print(" original_code_heap='%s'", original_code_heap_name);
1891 
1892     const char* new_code_heap_name = CodeCache::get_code_heap_name(CodeCache::get_code_blob_type(this));
1893     xtty->print(" new_address='" INTPTR_FORMAT "'", p2i(this));
1894     xtty->print(" new_code_heap='%s'", new_code_heap_name);
1895 
1896     LOG_OFFSET(xtty, relocation);
1897     LOG_OFFSET(xtty, consts);
1898     LOG_OFFSET(xtty, insts);
1899     LOG_OFFSET(xtty, stub);
1900     LOG_OFFSET(xtty, scopes_data);
1901     LOG_OFFSET(xtty, scopes_pcs);
1902     LOG_OFFSET(xtty, dependencies);
1903     LOG_OFFSET(xtty, handler_table);
1904     LOG_OFFSET(xtty, nul_chk_table);
1905     LOG_OFFSET(xtty, oops);
1906     LOG_OFFSET(xtty, metadata);
1907 
1908     xtty->method(method());
1909     xtty->stamp();
1910     xtty->end_elem();
1911   }
1912 }
1913 
1914 #undef LOG_OFFSET
1915 
1916 
1917 // Print out more verbose output usually for a newly created nmethod.
1918 void nmethod::print_on_with_msg(outputStream* st, const char* msg) const {
1919   if (st != nullptr) {
1920     ttyLocker ttyl;
1921     if (WizardMode) {
1922       CompileTask::print(st, this, msg, /*short_form:*/ true);
1923       st->print_cr(" (" INTPTR_FORMAT ")", p2i(this));
1924     } else {
1925       CompileTask::print(st, this, msg, /*short_form:*/ false);
1926     }
1927   }
1928 }
1929 
1930 void nmethod::maybe_print_nmethod(const DirectiveSet* directive) {
1931   bool printnmethods = directive->PrintAssemblyOption || directive->PrintNMethodsOption;
1932   if (printnmethods || PrintDebugInfo || PrintRelocations || PrintDependencies || PrintExceptionHandlers) {
1933     print_nmethod(printnmethods);
1934   }
1935 }
1936 
1937 void nmethod::print_nmethod(bool printmethod) {
1938   ttyLocker ttyl;  // keep the following output all in one block
1939   if (xtty != nullptr) {
1940     xtty->begin_head("print_nmethod");
1941     log_identity(xtty);
1942     xtty->stamp();
1943     xtty->end_head();
1944   }
1945   // Print the header part, then print the requested information.
1946   // This is both handled in decode2().
1947   if (printmethod) {
1948     ResourceMark m;
1949     if (is_compiled_by_c1()) {
1950       tty->cr();
1951       tty->print_cr("============================= C1-compiled nmethod ==============================");
1952     }
1953     if (is_compiled_by_jvmci()) {
1954       tty->cr();
1955       tty->print_cr("=========================== JVMCI-compiled nmethod =============================");
1956     }
1957     tty->print_cr("----------------------------------- Assembly -----------------------------------");
1958     decode2(tty);
1959 #if defined(SUPPORT_DATA_STRUCTS)
1960     if (AbstractDisassembler::show_structs()) {
1961       // Print the oops from the underlying CodeBlob as well.
1962       tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
1963       print_oops(tty);
1964       tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
1965       print_metadata(tty);
1966       tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
1967       print_pcs_on(tty);
1968       tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
1969       if (oop_maps() != nullptr) {
1970         tty->print("oop maps:"); // oop_maps()->print_on(tty) outputs a cr() at the beginning
1971         oop_maps()->print_on(tty);
1972         tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
1973       }
1974     }
1975 #endif
1976   } else {
1977     print(); // print the header part only.
1978   }
1979 
1980 #if defined(SUPPORT_DATA_STRUCTS)
1981   if (AbstractDisassembler::show_structs()) {
1982     methodHandle mh(Thread::current(), _method);
1983     if (printmethod || PrintDebugInfo || CompilerOracle::has_option(mh, CompileCommandEnum::PrintDebugInfo)) {
1984       print_scopes();
1985       tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
1986     }
1987     if (printmethod || PrintRelocations || CompilerOracle::has_option(mh, CompileCommandEnum::PrintRelocations)) {
1988       print_relocations();
1989       tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
1990     }
1991     if (printmethod || PrintDependencies || CompilerOracle::has_option(mh, CompileCommandEnum::PrintDependencies)) {
1992       print_dependencies_on(tty);
1993       tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
1994     }
1995     if (printmethod || PrintExceptionHandlers) {
1996       print_handler_table();
1997       tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
1998       print_nul_chk_table();
1999       tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
2000     }
2001 
2002     if (printmethod) {
2003       print_recorded_oops();
2004       tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
2005       print_recorded_metadata();
2006       tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
2007     }
2008   }
2009 #endif
2010 
2011   if (xtty != nullptr) {
2012     xtty->tail("print_nmethod");
2013   }
2014 }
2015 
2016 
2017 // Promote one word from an assembly-time handle to a live embedded oop.
2018 inline void nmethod::initialize_immediate_oop(oop* dest, jobject handle) {
2019   if (handle == nullptr ||
2020       // As a special case, IC oops are initialized to 1 or -1.
2021       handle == (jobject) Universe::non_oop_word()) {
2022     *(void**)dest = handle;
2023   } else {
2024     *dest = JNIHandles::resolve_non_null(handle);
2025   }
2026 }
2027 
2028 
2029 // Have to have the same name because it's called by a template
2030 void nmethod::copy_values(GrowableArray<jobject>* array) {
2031   int length = array->length();
2032   assert((address)(oops_begin() + length) <= (address)oops_end(), "oops big enough");
2033   oop* dest = oops_begin();
2034   for (int index = 0 ; index < length; index++) {
2035     initialize_immediate_oop(&dest[index], array->at(index));
2036   }
2037 
2038   // Now we can fix up all the oops in the code.  We need to do this
2039   // in the code because the assembler uses jobjects as placeholders.
2040   // The code and relocations have already been initialized by the
2041   // CodeBlob constructor, so it is valid even at this early point to
2042   // iterate over relocations and patch the code.
2043   fix_oop_relocations(nullptr, nullptr, /*initialize_immediates=*/ true);
2044 }
2045 
2046 void nmethod::copy_values(GrowableArray<Metadata*>* array) {
2047   int length = array->length();
2048   assert((address)(metadata_begin() + length) <= (address)metadata_end(), "big enough");
2049   Metadata** dest = metadata_begin();
2050   for (int index = 0 ; index < length; index++) {
2051     dest[index] = array->at(index);
2052   }
2053 }
2054 
2055 void nmethod::fix_oop_relocations(address begin, address end, bool initialize_immediates) {
2056   // re-patch all oop-bearing instructions, just in case some oops moved
2057   RelocIterator iter(this, begin, end);
2058   while (iter.next()) {
2059     if (iter.type() == relocInfo::oop_type) {
2060       oop_Relocation* reloc = iter.oop_reloc();
2061       if (initialize_immediates && reloc->oop_is_immediate()) {
2062         oop* dest = reloc->oop_addr();
2063         jobject obj = *reinterpret_cast<jobject*>(dest);
2064         initialize_immediate_oop(dest, obj);
2065       }
2066       // Refresh the oop-related bits of this instruction.
2067       reloc->fix_oop_relocation();
2068     } else if (iter.type() == relocInfo::metadata_type) {
2069       metadata_Relocation* reloc = iter.metadata_reloc();
2070       reloc->fix_metadata_relocation();
2071     }
2072   }
2073 }
2074 
2075 static void install_post_call_nop_displacement(nmethod* nm, address pc) {
2076   NativePostCallNop* nop = nativePostCallNop_at((address) pc);
2077   intptr_t cbaddr = (intptr_t) nm;
2078   intptr_t offset = ((intptr_t) pc) - cbaddr;
2079 
2080   int oopmap_slot = nm->oop_maps()->find_slot_for_offset(int((intptr_t) pc - (intptr_t) nm->code_begin()));
2081   if (oopmap_slot < 0) { // this can happen at asynchronous (non-safepoint) stackwalks
2082     log_debug(codecache)("failed to find oopmap for cb: " INTPTR_FORMAT " offset: %d", cbaddr, (int) offset);
2083   } else if (!nop->patch(oopmap_slot, offset)) {
2084     log_debug(codecache)("failed to encode %d %d", oopmap_slot, (int) offset);
2085   }
2086 }
2087 
2088 void nmethod::finalize_relocations() {
2089   NoSafepointVerifier nsv;
2090 
2091   GrowableArray<NativeMovConstReg*> virtual_call_data;
2092 
2093   // Make sure that post call nops fill in nmethod offsets eagerly so
2094   // we don't have to race with deoptimization
2095   RelocIterator iter(this);
2096   while (iter.next()) {
2097     if (iter.type() == relocInfo::virtual_call_type) {
2098       virtual_call_Relocation* r = iter.virtual_call_reloc();
2099       NativeMovConstReg* value = nativeMovConstReg_at(r->cached_value());
2100       virtual_call_data.append(value);
2101     } else if (iter.type() == relocInfo::post_call_nop_type) {
2102       post_call_nop_Relocation* const reloc = iter.post_call_nop_reloc();
2103       address pc = reloc->addr();
2104       install_post_call_nop_displacement(this, pc);
2105     }
2106   }
2107 
2108   if (virtual_call_data.length() > 0) {
2109     // We allocate a block of CompiledICData per nmethod so the GC can purge this faster.
2110     _compiled_ic_data = new CompiledICData[virtual_call_data.length()];
2111     CompiledICData* next_data = _compiled_ic_data;
2112 
2113     for (NativeMovConstReg* value : virtual_call_data) {
2114       value->set_data((intptr_t)next_data);
2115       next_data++;
2116     }
2117   }
2118 }
2119 
2120 void nmethod::make_deoptimized() {
2121   if (!Continuations::enabled()) {
2122     // Don't deopt this again.
2123     set_deoptimized_done();
2124     return;
2125   }
2126 
2127   assert(method() == nullptr || can_be_deoptimized(), "");
2128 
2129   CompiledICLocker ml(this);
2130   assert(CompiledICLocker::is_safe(this), "mt unsafe call");
2131 
2132   // If post call nops have been already patched, we can just bail-out.
2133   if (has_been_deoptimized()) {
2134     return;
2135   }
2136 
2137   ResourceMark rm;
2138   RelocIterator iter(this, oops_reloc_begin());
2139 
2140   while (iter.next()) {
2141 
2142     switch (iter.type()) {
2143       case relocInfo::virtual_call_type: {
2144         CompiledIC *ic = CompiledIC_at(&iter);
2145         address pc = ic->end_of_call();
2146         NativePostCallNop* nop = nativePostCallNop_at(pc);
2147         if (nop != nullptr) {
2148           nop->make_deopt();
2149         }
2150         assert(NativeDeoptInstruction::is_deopt_at(pc), "check");
2151         break;
2152       }
2153       case relocInfo::static_call_type:
2154       case relocInfo::opt_virtual_call_type: {
2155         CompiledDirectCall *csc = CompiledDirectCall::at(iter.reloc());
2156         address pc = csc->end_of_call();
2157         NativePostCallNop* nop = nativePostCallNop_at(pc);
2158         //tty->print_cr(" - static pc %p", pc);
2159         if (nop != nullptr) {
2160           nop->make_deopt();
2161         }
2162         // We can't assert here, there are some calls to stubs / runtime
2163         // that have reloc data and doesn't have a post call NOP.
2164         //assert(NativeDeoptInstruction::is_deopt_at(pc), "check");
2165         break;
2166       }
2167       default:
2168         break;
2169     }
2170   }
2171   // Don't deopt this again.
2172   set_deoptimized_done();
2173 }
2174 
2175 void nmethod::verify_clean_inline_caches() {
2176   assert(CompiledICLocker::is_safe(this), "mt unsafe call");
2177 
2178   ResourceMark rm;
2179   RelocIterator iter(this, oops_reloc_begin());
2180   while(iter.next()) {
2181     switch(iter.type()) {
2182       case relocInfo::virtual_call_type: {
2183         CompiledIC *ic = CompiledIC_at(&iter);
2184         CodeBlob *cb = CodeCache::find_blob(ic->destination());
2185         assert(cb != nullptr, "destination not in CodeBlob?");
2186         nmethod* nm = cb->as_nmethod_or_null();
2187         if (nm != nullptr) {
2188           // Verify that inline caches pointing to bad nmethods are clean
2189           if (!nm->is_in_use() || nm->is_unloading()) {
2190             assert(ic->is_clean(), "IC should be clean");
2191           }
2192         }
2193         break;
2194       }
2195       case relocInfo::static_call_type:
2196       case relocInfo::opt_virtual_call_type: {
2197         CompiledDirectCall *cdc = CompiledDirectCall::at(iter.reloc());
2198         CodeBlob *cb = CodeCache::find_blob(cdc->destination());
2199         assert(cb != nullptr, "destination not in CodeBlob?");
2200         nmethod* nm = cb->as_nmethod_or_null();
2201         if (nm != nullptr) {
2202           // Verify that inline caches pointing to bad nmethods are clean
2203           if (!nm->is_in_use() || nm->is_unloading() || nm->method()->code() != nm) {
2204             assert(cdc->is_clean(), "IC should be clean");
2205           }
2206         }
2207         break;
2208       }
2209       default:
2210         break;
2211     }
2212   }
2213 }
2214 
2215 void nmethod::mark_as_maybe_on_stack() {
2216   AtomicAccess::store(&_gc_epoch, CodeCache::gc_epoch());
2217 }
2218 
2219 bool nmethod::is_maybe_on_stack() {
2220   // If the condition below is true, it means that the nmethod was found to
2221   // be alive the previous completed marking cycle.
2222   return AtomicAccess::load(&_gc_epoch) >= CodeCache::previous_completed_gc_marking_cycle();
2223 }
2224 
2225 void nmethod::inc_decompile_count() {
2226   if (!is_compiled_by_c2() && !is_compiled_by_jvmci()) return;
2227   // Could be gated by ProfileTraps, but do not bother...
2228 #if INCLUDE_JVMCI
2229   if (jvmci_skip_profile_deopt()) {
2230     return;
2231   }
2232 #endif
2233   Method* m = method();
2234   if (m == nullptr)  return;
2235   MethodData* mdo = m->method_data();
2236   if (mdo == nullptr)  return;
2237   // There is a benign race here.  See comments in methodData.hpp.
2238   mdo->inc_decompile_count();
2239 }
2240 
2241 bool nmethod::try_transition(signed char new_state_int) {
2242   signed char new_state = new_state_int;
2243   assert_lock_strong(NMethodState_lock);
2244   signed char old_state = _state;
2245   if (old_state >= new_state) {
2246     // Ensure monotonicity of transitions.
2247     return false;
2248   }
2249   AtomicAccess::store(&_state, new_state);
2250   return true;
2251 }
2252 
2253 void nmethod::invalidate_osr_method() {
2254   assert(_entry_bci != InvocationEntryBci, "wrong kind of nmethod");
2255   // Remove from list of active nmethods
2256   if (method() != nullptr) {
2257     method()->method_holder()->remove_osr_nmethod(this);
2258   }
2259 }
2260 
2261 void nmethod::log_state_change(InvalidationReason invalidation_reason) const {
2262   if (LogCompilation) {
2263     if (xtty != nullptr) {
2264       ttyLocker ttyl;  // keep the following output all in one block
2265       xtty->begin_elem("make_not_entrant thread='%zu' reason='%s'",
2266                        os::current_thread_id(), invalidation_reason_to_string(invalidation_reason));
2267       log_identity(xtty);
2268       xtty->stamp();
2269       xtty->end_elem();
2270     }
2271   }
2272 
2273   ResourceMark rm;
2274   stringStream ss(NEW_RESOURCE_ARRAY(char, 256), 256);
2275   ss.print("made not entrant: %s", invalidation_reason_to_string(invalidation_reason));
2276 
2277   CompileTask::print_ul(this, ss.freeze());
2278   if (PrintCompilation) {
2279     print_on_with_msg(tty, ss.freeze());
2280   }
2281 }
2282 
2283 void nmethod::unlink_from_method() {
2284   if (method() != nullptr) {
2285     method()->unlink_code(this);
2286   }
2287 }
2288 
2289 // Invalidate code
2290 bool nmethod::make_not_entrant(InvalidationReason invalidation_reason) {
2291   // This can be called while the system is already at a safepoint which is ok
2292   NoSafepointVerifier nsv;
2293 
2294   if (is_unloading()) {
2295     // If the nmethod is unloading, then it is already not entrant through
2296     // the nmethod entry barriers. No need to do anything; GC will unload it.
2297     return false;
2298   }
2299 
2300   if (AtomicAccess::load(&_state) == not_entrant) {
2301     // Avoid taking the lock if already in required state.
2302     // This is safe from races because the state is an end-state,
2303     // which the nmethod cannot back out of once entered.
2304     // No need for fencing either.
2305     return false;
2306   }
2307 
2308   {
2309     // Enter critical section.  Does not block for safepoint.
2310     ConditionalMutexLocker ml(NMethodState_lock, !NMethodState_lock->owned_by_self(), Mutex::_no_safepoint_check_flag);
2311 
2312     if (AtomicAccess::load(&_state) == not_entrant) {
2313       // another thread already performed this transition so nothing
2314       // to do, but return false to indicate this.
2315       return false;
2316     }
2317 
2318     if (is_osr_method()) {
2319       // This logic is equivalent to the logic below for patching the
2320       // verified entry point of regular methods.
2321       // this effectively makes the osr nmethod not entrant
2322       invalidate_osr_method();
2323     } else {
2324       // The caller can be calling the method statically or through an inline
2325       // cache call.
2326       BarrierSet::barrier_set()->barrier_set_nmethod()->make_not_entrant(this);
2327     }
2328 
2329     if (update_recompile_counts()) {
2330       // Mark the method as decompiled.
2331       inc_decompile_count();
2332     }
2333 
2334     BarrierSetNMethod* bs_nm = BarrierSet::barrier_set()->barrier_set_nmethod();
2335     if (bs_nm == nullptr || !bs_nm->supports_entry_barrier(this)) {
2336       // If nmethod entry barriers are not supported, we won't mark
2337       // nmethods as on-stack when they become on-stack. So we
2338       // degrade to a less accurate flushing strategy, for now.
2339       mark_as_maybe_on_stack();
2340     }
2341 
2342     // Change state
2343     bool success = try_transition(not_entrant);
2344     assert(success, "Transition can't fail");
2345 
2346     // Log the transition once
2347     log_state_change(invalidation_reason);
2348 
2349     // Remove nmethod from method.
2350     unlink_from_method();
2351 
2352   } // leave critical region under NMethodState_lock
2353 
2354 #if INCLUDE_JVMCI
2355   // Invalidate can't occur while holding the NMethodState_lock
2356   JVMCINMethodData* nmethod_data = jvmci_nmethod_data();
2357   if (nmethod_data != nullptr) {
2358     nmethod_data->invalidate_nmethod_mirror(this, invalidation_reason);
2359   }
2360 #endif
2361 
2362 #ifdef ASSERT
2363   if (is_osr_method() && method() != nullptr) {
2364     // Make sure osr nmethod is invalidated, i.e. not on the list
2365     bool found = method()->method_holder()->remove_osr_nmethod(this);
2366     assert(!found, "osr nmethod should have been invalidated");
2367   }
2368 #endif
2369 
2370   return true;
2371 }
2372 
2373 // For concurrent GCs, there must be a handshake between unlink and flush
2374 void nmethod::unlink() {
2375   if (is_unlinked()) {
2376     // Already unlinked.
2377     return;
2378   }
2379 
2380   flush_dependencies();
2381 
2382   // unlink_from_method will take the NMethodState_lock.
2383   // In this case we don't strictly need it when unlinking nmethods from
2384   // the Method, because it is only concurrently unlinked by
2385   // the entry barrier, which acquires the per nmethod lock.
2386   unlink_from_method();
2387 
2388   if (is_osr_method()) {
2389     invalidate_osr_method();
2390   }
2391 
2392 #if INCLUDE_JVMCI
2393   // Clear the link between this nmethod and a HotSpotNmethod mirror
2394   JVMCINMethodData* nmethod_data = jvmci_nmethod_data();
2395   if (nmethod_data != nullptr) {
2396     nmethod_data->invalidate_nmethod_mirror(this, is_cold() ?
2397             nmethod::InvalidationReason::UNLOADING_COLD :
2398             nmethod::InvalidationReason::UNLOADING);
2399   }
2400 #endif
2401 
2402   // Post before flushing as jmethodID is being used
2403   post_compiled_method_unload();
2404 
2405   // Register for flushing when it is safe. For concurrent class unloading,
2406   // that would be after the unloading handshake, and for STW class unloading
2407   // that would be when getting back to the VM thread.
2408   ClassUnloadingContext::context()->register_unlinked_nmethod(this);
2409 }
2410 
2411 void nmethod::purge(bool unregister_nmethod) {
2412 
2413   MutexLocker ml(CodeCache_lock, Mutex::_no_safepoint_check_flag);
2414 
2415   // completely deallocate this method
2416   Events::log_nmethod_flush(Thread::current(), "flushing %s nmethod " INTPTR_FORMAT, is_osr_method() ? "osr" : "", p2i(this));
2417 
2418   LogTarget(Debug, codecache) lt;
2419   if (lt.is_enabled()) {
2420     ResourceMark rm;
2421     LogStream ls(lt);
2422     const char* method_name = method()->name()->as_C_string();
2423     const size_t codecache_capacity = CodeCache::capacity()/1024;
2424     const size_t codecache_free_space = CodeCache::unallocated_capacity(CodeCache::get_code_blob_type(this))/1024;
2425     ls.print("Flushing nmethod %6d/" INTPTR_FORMAT ", level=%d, osr=%d, cold=%d, epoch=" UINT64_FORMAT ", cold_count=" UINT64_FORMAT ". "
2426               "Cache capacity: %zuKb, free space: %zuKb. method %s (%s)",
2427               _compile_id, p2i(this), _comp_level, is_osr_method(), is_cold(), _gc_epoch, CodeCache::cold_gc_count(),
2428               codecache_capacity, codecache_free_space, method_name, compiler_name());
2429   }
2430 
2431   // We need to deallocate any ExceptionCache data.
2432   // Note that we do not need to grab the nmethod lock for this, it
2433   // better be thread safe if we're disposing of it!
2434   ExceptionCache* ec = exception_cache();
2435   while(ec != nullptr) {
2436     ExceptionCache* next = ec->next();
2437     delete ec;
2438     ec = next;
2439   }
2440   if (_pc_desc_container != nullptr) {
2441     delete _pc_desc_container;
2442   }
2443   delete[] _compiled_ic_data;
2444 
2445   if (_immutable_data != blob_end()) {
2446     int reference_count = get_immutable_data_references_counter();
2447     assert(reference_count > 0, "immutable data has no references");
2448 
2449     set_immutable_data_references_counter(reference_count - 1);
2450     // Free memory if this is the last nmethod referencing immutable data
2451     if (reference_count == 0) {
2452       os::free(_immutable_data);
2453     }
2454 
2455     _immutable_data = blob_end(); // Valid not null address
2456   }
2457 
2458   if (unregister_nmethod) {
2459     Universe::heap()->unregister_nmethod(this);
2460   }
2461   CodeCache::unregister_old_nmethod(this);
2462 
2463   JVMCI_ONLY( _metadata_size = 0; )
2464   CodeBlob::purge();
2465 }
2466 
2467 oop nmethod::oop_at(int index) const {
2468   if (index == 0) {
2469     return nullptr;
2470   }
2471 
2472   BarrierSetNMethod* bs_nm = BarrierSet::barrier_set()->barrier_set_nmethod();
2473   return bs_nm->oop_load_no_keepalive(this, index);
2474 }
2475 
2476 oop nmethod::oop_at_phantom(int index) const {
2477   if (index == 0) {
2478     return nullptr;
2479   }
2480 
2481   BarrierSetNMethod* bs_nm = BarrierSet::barrier_set()->barrier_set_nmethod();
2482   return bs_nm->oop_load_phantom(this, index);
2483 }
2484 
2485 //
2486 // Notify all classes this nmethod is dependent on that it is no
2487 // longer dependent.
2488 
2489 void nmethod::flush_dependencies() {
2490   if (!has_flushed_dependencies()) {
2491     set_has_flushed_dependencies(true);
2492     for (Dependencies::DepStream deps(this); deps.next(); ) {
2493       if (deps.type() == Dependencies::call_site_target_value) {
2494         // CallSite dependencies are managed on per-CallSite instance basis.
2495         oop call_site = deps.argument_oop(0);
2496         MethodHandles::clean_dependency_context(call_site);
2497       } else {
2498         InstanceKlass* ik = deps.context_type();
2499         if (ik == nullptr) {
2500           continue;  // ignore things like evol_method
2501         }
2502         // During GC liveness of dependee determines class that needs to be updated.
2503         // The GC may clean dependency contexts concurrently and in parallel.
2504         ik->clean_dependency_context();
2505       }
2506     }
2507   }
2508 }
2509 
2510 void nmethod::post_compiled_method(CompileTask* task) {
2511   task->mark_success();
2512   task->set_nm_content_size(content_size());
2513   task->set_nm_insts_size(insts_size());
2514   task->set_nm_total_size(total_size());
2515 
2516   // JVMTI -- compiled method notification (must be done outside lock)
2517   post_compiled_method_load_event();
2518 
2519   if (CompilationLog::log() != nullptr) {
2520     CompilationLog::log()->log_nmethod(JavaThread::current(), this);
2521   }
2522 
2523   const DirectiveSet* directive = task->directive();
2524   maybe_print_nmethod(directive);
2525 }
2526 
2527 #if INCLUDE_CDS
2528 static GrowableArrayCHeap<nmethod*, mtClassShared>* _delayed_compiled_method_load_events = nullptr;
2529 
2530 void nmethod::add_delayed_compiled_method_load_event(nmethod* nm) {
2531   precond(CDSConfig::is_using_aot_linked_classes());
2532   precond(!ServiceThread::has_started());
2533 
2534   // We are still in single threaded stage of VM bootstrap. No need to lock.
2535   if (_delayed_compiled_method_load_events == nullptr) {
2536     _delayed_compiled_method_load_events = new GrowableArrayCHeap<nmethod*, mtClassShared>();
2537   }
2538   _delayed_compiled_method_load_events->append(nm);
2539 }
2540 
2541 void nmethod::post_delayed_compiled_method_load_events() {
2542   precond(ServiceThread::has_started());
2543   if (_delayed_compiled_method_load_events != nullptr) {
2544     for (int i = 0; i < _delayed_compiled_method_load_events->length(); i++) {
2545       nmethod* nm = _delayed_compiled_method_load_events->at(i);
2546       nm->post_compiled_method_load_event();
2547     }
2548     delete _delayed_compiled_method_load_events;
2549     _delayed_compiled_method_load_events = nullptr;
2550   }
2551 }
2552 #endif
2553 
2554 // ------------------------------------------------------------------
2555 // post_compiled_method_load_event
2556 // new method for install_code() path
2557 // Transfer information from compilation to jvmti
2558 void nmethod::post_compiled_method_load_event(JvmtiThreadState* state) {
2559 #if INCLUDE_CDS
2560   if (!ServiceThread::has_started()) {
2561     // With AOT-linked classes, we could compile wrappers for native methods before the
2562     // ServiceThread has been started, so we must delay the events to be posted later.
2563     assert(state == nullptr, "must be");
2564     add_delayed_compiled_method_load_event(this);
2565     return;
2566   }
2567 #endif
2568 
2569   // This is a bad time for a safepoint.  We don't want
2570   // this nmethod to get unloaded while we're queueing the event.
2571   NoSafepointVerifier nsv;
2572 
2573   Method* m = method();
2574   HOTSPOT_COMPILED_METHOD_LOAD(
2575       (char *) m->klass_name()->bytes(),
2576       m->klass_name()->utf8_length(),
2577       (char *) m->name()->bytes(),
2578       m->name()->utf8_length(),
2579       (char *) m->signature()->bytes(),
2580       m->signature()->utf8_length(),
2581       insts_begin(), insts_size());
2582 
2583 
2584   if (JvmtiExport::should_post_compiled_method_load()) {
2585     // Only post unload events if load events are found.
2586     set_load_reported();
2587     // If a JavaThread hasn't been passed in, let the Service thread
2588     // (which is a real Java thread) post the event
2589     JvmtiDeferredEvent event = JvmtiDeferredEvent::compiled_method_load_event(this);
2590     if (state == nullptr) {
2591       // Execute any barrier code for this nmethod as if it's called, since
2592       // keeping it alive looks like stack walking.
2593       run_nmethod_entry_barrier();
2594       ServiceThread::enqueue_deferred_event(&event);
2595     } else {
2596       // This enters the nmethod barrier outside in the caller.
2597       state->enqueue_event(&event);
2598     }
2599   }
2600 }
2601 
2602 void nmethod::post_compiled_method_unload() {
2603   assert(_method != nullptr, "just checking");
2604   DTRACE_METHOD_UNLOAD_PROBE(method());
2605 
2606   // If a JVMTI agent has enabled the CompiledMethodUnload event then
2607   // post the event. The Method* will not be valid when this is freed.
2608 
2609   // Don't bother posting the unload if the load event wasn't posted.
2610   if (load_reported() && JvmtiExport::should_post_compiled_method_unload()) {
2611     JvmtiDeferredEvent event =
2612       JvmtiDeferredEvent::compiled_method_unload_event(
2613           method()->jmethod_id(), insts_begin());
2614     ServiceThread::enqueue_deferred_event(&event);
2615   }
2616 }
2617 
2618 // Iterate over metadata calling this function.   Used by RedefineClasses
2619 void nmethod::metadata_do(MetadataClosure* f) {
2620   {
2621     // Visit all immediate references that are embedded in the instruction stream.
2622     RelocIterator iter(this, oops_reloc_begin());
2623     while (iter.next()) {
2624       if (iter.type() == relocInfo::metadata_type) {
2625         metadata_Relocation* r = iter.metadata_reloc();
2626         // In this metadata, we must only follow those metadatas directly embedded in
2627         // the code.  Other metadatas (oop_index>0) are seen as part of
2628         // the metadata section below.
2629         assert(1 == (r->metadata_is_immediate()) +
2630                (r->metadata_addr() >= metadata_begin() && r->metadata_addr() < metadata_end()),
2631                "metadata must be found in exactly one place");
2632         if (r->metadata_is_immediate() && r->metadata_value() != nullptr) {
2633           Metadata* md = r->metadata_value();
2634           if (md != _method) f->do_metadata(md);
2635         }
2636       } else if (iter.type() == relocInfo::virtual_call_type) {
2637         // Check compiledIC holders associated with this nmethod
2638         ResourceMark rm;
2639         CompiledIC *ic = CompiledIC_at(&iter);
2640         ic->metadata_do(f);
2641       }
2642     }
2643   }
2644 
2645   // Visit the metadata section
2646   for (Metadata** p = metadata_begin(); p < metadata_end(); p++) {
2647     if (*p == Universe::non_oop_word() || *p == nullptr)  continue;  // skip non-oops
2648     Metadata* md = *p;
2649     f->do_metadata(md);
2650   }
2651 
2652   // Visit metadata not embedded in the other places.
2653   if (_method != nullptr) f->do_metadata(_method);
2654 }
2655 
2656 // Heuristic for nuking nmethods even though their oops are live.
2657 // Main purpose is to reduce code cache pressure and get rid of
2658 // nmethods that don't seem to be all that relevant any longer.
2659 bool nmethod::is_cold() {
2660   if (!MethodFlushing || is_native_method() || is_not_installed()) {
2661     // No heuristic unloading at all
2662     return false;
2663   }
2664 
2665   if (!is_maybe_on_stack() && is_not_entrant()) {
2666     // Not entrant nmethods that are not on any stack can just
2667     // be removed
2668     return true;
2669   }
2670 
2671   BarrierSetNMethod* bs_nm = BarrierSet::barrier_set()->barrier_set_nmethod();
2672   if (bs_nm == nullptr || !bs_nm->supports_entry_barrier(this)) {
2673     // On platforms that don't support nmethod entry barriers, we can't
2674     // trust the temporal aspect of the gc epochs. So we can't detect
2675     // cold nmethods on such platforms.
2676     return false;
2677   }
2678 
2679   if (!UseCodeCacheFlushing) {
2680     // Bail out if we don't heuristically remove nmethods
2681     return false;
2682   }
2683 
2684   // Other code can be phased out more gradually after N GCs
2685   return CodeCache::previous_completed_gc_marking_cycle() > _gc_epoch + 2 * CodeCache::cold_gc_count();
2686 }
2687 
2688 // The _is_unloading_state encodes a tuple comprising the unloading cycle
2689 // and the result of IsUnloadingBehaviour::is_unloading() for that cycle.
2690 // This is the bit layout of the _is_unloading_state byte: 00000CCU
2691 // CC refers to the cycle, which has 2 bits, and U refers to the result of
2692 // IsUnloadingBehaviour::is_unloading() for that unloading cycle.
2693 
2694 class IsUnloadingState: public AllStatic {
2695   static const uint8_t _is_unloading_mask = 1;
2696   static const uint8_t _is_unloading_shift = 0;
2697   static const uint8_t _unloading_cycle_mask = 6;
2698   static const uint8_t _unloading_cycle_shift = 1;
2699 
2700   static uint8_t set_is_unloading(uint8_t state, bool value) {
2701     state &= (uint8_t)~_is_unloading_mask;
2702     if (value) {
2703       state |= 1 << _is_unloading_shift;
2704     }
2705     assert(is_unloading(state) == value, "unexpected unloading cycle overflow");
2706     return state;
2707   }
2708 
2709   static uint8_t set_unloading_cycle(uint8_t state, uint8_t value) {
2710     state &= (uint8_t)~_unloading_cycle_mask;
2711     state |= (uint8_t)(value << _unloading_cycle_shift);
2712     assert(unloading_cycle(state) == value, "unexpected unloading cycle overflow");
2713     return state;
2714   }
2715 
2716 public:
2717   static bool is_unloading(uint8_t state) { return (state & _is_unloading_mask) >> _is_unloading_shift == 1; }
2718   static uint8_t unloading_cycle(uint8_t state) { return (state & _unloading_cycle_mask) >> _unloading_cycle_shift; }
2719 
2720   static uint8_t create(bool is_unloading, uint8_t unloading_cycle) {
2721     uint8_t state = 0;
2722     state = set_is_unloading(state, is_unloading);
2723     state = set_unloading_cycle(state, unloading_cycle);
2724     return state;
2725   }
2726 };
2727 
2728 bool nmethod::is_unloading() {
2729   uint8_t state = AtomicAccess::load(&_is_unloading_state);
2730   bool state_is_unloading = IsUnloadingState::is_unloading(state);
2731   if (state_is_unloading) {
2732     return true;
2733   }
2734   uint8_t state_unloading_cycle = IsUnloadingState::unloading_cycle(state);
2735   uint8_t current_cycle = CodeCache::unloading_cycle();
2736   if (state_unloading_cycle == current_cycle) {
2737     return false;
2738   }
2739 
2740   // The IsUnloadingBehaviour is responsible for calculating if the nmethod
2741   // should be unloaded. This can be either because there is a dead oop,
2742   // or because is_cold() heuristically determines it is time to unload.
2743   state_unloading_cycle = current_cycle;
2744   state_is_unloading = IsUnloadingBehaviour::is_unloading(this);
2745   uint8_t new_state = IsUnloadingState::create(state_is_unloading, state_unloading_cycle);
2746 
2747   // Note that if an nmethod has dead oops, everyone will agree that the
2748   // nmethod is_unloading. However, the is_cold heuristics can yield
2749   // different outcomes, so we guard the computed result with a CAS
2750   // to ensure all threads have a shared view of whether an nmethod
2751   // is_unloading or not.
2752   uint8_t found_state = AtomicAccess::cmpxchg(&_is_unloading_state, state, new_state, memory_order_relaxed);
2753 
2754   if (found_state == state) {
2755     // First to change state, we win
2756     return state_is_unloading;
2757   } else {
2758     // State already set, so use it
2759     return IsUnloadingState::is_unloading(found_state);
2760   }
2761 }
2762 
2763 void nmethod::clear_unloading_state() {
2764   uint8_t state = IsUnloadingState::create(false, CodeCache::unloading_cycle());
2765   AtomicAccess::store(&_is_unloading_state, state);
2766 }
2767 
2768 
2769 // This is called at the end of the strong tracing/marking phase of a
2770 // GC to unload an nmethod if it contains otherwise unreachable
2771 // oops or is heuristically found to be not important.
2772 void nmethod::do_unloading(bool unloading_occurred) {
2773   // Make sure the oop's ready to receive visitors
2774   if (is_unloading()) {
2775     unlink();
2776   } else {
2777     unload_nmethod_caches(unloading_occurred);
2778     BarrierSetNMethod* bs_nm = BarrierSet::barrier_set()->barrier_set_nmethod();
2779     if (bs_nm != nullptr) {
2780       bs_nm->disarm(this);
2781     }
2782   }
2783 }
2784 
2785 void nmethod::oops_do(OopClosure* f) {
2786   // Prevent extra code cache walk for platforms that don't have immediate oops.
2787   if (relocInfo::mustIterateImmediateOopsInCode()) {
2788     RelocIterator iter(this, oops_reloc_begin());
2789 
2790     while (iter.next()) {
2791       if (iter.type() == relocInfo::oop_type ) {
2792         oop_Relocation* r = iter.oop_reloc();
2793         // In this loop, we must only follow those oops directly embedded in
2794         // the code.  Other oops (oop_index>0) are seen as part of scopes_oops.
2795         assert(1 == (r->oop_is_immediate()) +
2796                (r->oop_addr() >= oops_begin() && r->oop_addr() < oops_end()),
2797                "oop must be found in exactly one place");
2798         if (r->oop_is_immediate() && r->oop_value() != nullptr) {
2799           f->do_oop(r->oop_addr());
2800         }
2801       }
2802     }
2803   }
2804 
2805   // Scopes
2806   // This includes oop constants not inlined in the code stream.
2807   for (oop* p = oops_begin(); p < oops_end(); p++) {
2808     if (*p == Universe::non_oop_word())  continue;  // skip non-oops
2809     f->do_oop(p);
2810   }
2811 }
2812 
2813 void nmethod::follow_nmethod(OopIterateClosure* cl) {
2814   // Process oops in the nmethod
2815   oops_do(cl);
2816 
2817   // CodeCache unloading support
2818   mark_as_maybe_on_stack();
2819 
2820   BarrierSetNMethod* bs_nm = BarrierSet::barrier_set()->barrier_set_nmethod();
2821   bs_nm->disarm(this);
2822 
2823   // There's an assumption made that this function is not used by GCs that
2824   // relocate objects, and therefore we don't call fix_oop_relocations.
2825 }
2826 
2827 nmethod* volatile nmethod::_oops_do_mark_nmethods;
2828 
2829 void nmethod::oops_do_log_change(const char* state) {
2830   LogTarget(Trace, gc, nmethod) lt;
2831   if (lt.is_enabled()) {
2832     LogStream ls(lt);
2833     CompileTask::print(&ls, this, state, true /* short_form */);
2834   }
2835 }
2836 
2837 bool nmethod::oops_do_try_claim() {
2838   if (oops_do_try_claim_weak_request()) {
2839     nmethod* result = oops_do_try_add_to_list_as_weak_done();
2840     assert(result == nullptr, "adding to global list as weak done must always succeed.");
2841     return true;
2842   }
2843   return false;
2844 }
2845 
2846 bool nmethod::oops_do_try_claim_weak_request() {
2847   assert(SafepointSynchronize::is_at_safepoint(), "only at safepoint");
2848 
2849   if ((_oops_do_mark_link == nullptr) &&
2850       (AtomicAccess::replace_if_null(&_oops_do_mark_link, mark_link(this, claim_weak_request_tag)))) {
2851     oops_do_log_change("oops_do, mark weak request");
2852     return true;
2853   }
2854   return false;
2855 }
2856 
2857 void nmethod::oops_do_set_strong_done(nmethod* old_head) {
2858   _oops_do_mark_link = mark_link(old_head, claim_strong_done_tag);
2859 }
2860 
2861 nmethod::oops_do_mark_link* nmethod::oops_do_try_claim_strong_done() {
2862   assert(SafepointSynchronize::is_at_safepoint(), "only at safepoint");
2863 
2864   oops_do_mark_link* old_next = AtomicAccess::cmpxchg(&_oops_do_mark_link, mark_link(nullptr, claim_weak_request_tag), mark_link(this, claim_strong_done_tag));
2865   if (old_next == nullptr) {
2866     oops_do_log_change("oops_do, mark strong done");
2867   }
2868   return old_next;
2869 }
2870 
2871 nmethod::oops_do_mark_link* nmethod::oops_do_try_add_strong_request(nmethod::oops_do_mark_link* next) {
2872   assert(SafepointSynchronize::is_at_safepoint(), "only at safepoint");
2873   assert(next == mark_link(this, claim_weak_request_tag), "Should be claimed as weak");
2874 
2875   oops_do_mark_link* old_next = AtomicAccess::cmpxchg(&_oops_do_mark_link, next, mark_link(this, claim_strong_request_tag));
2876   if (old_next == next) {
2877     oops_do_log_change("oops_do, mark strong request");
2878   }
2879   return old_next;
2880 }
2881 
2882 bool nmethod::oops_do_try_claim_weak_done_as_strong_done(nmethod::oops_do_mark_link* next) {
2883   assert(SafepointSynchronize::is_at_safepoint(), "only at safepoint");
2884   assert(extract_state(next) == claim_weak_done_tag, "Should be claimed as weak done");
2885 
2886   oops_do_mark_link* old_next = AtomicAccess::cmpxchg(&_oops_do_mark_link, next, mark_link(extract_nmethod(next), claim_strong_done_tag));
2887   if (old_next == next) {
2888     oops_do_log_change("oops_do, mark weak done -> mark strong done");
2889     return true;
2890   }
2891   return false;
2892 }
2893 
2894 nmethod* nmethod::oops_do_try_add_to_list_as_weak_done() {
2895   assert(SafepointSynchronize::is_at_safepoint(), "only at safepoint");
2896 
2897   assert(extract_state(_oops_do_mark_link) == claim_weak_request_tag ||
2898          extract_state(_oops_do_mark_link) == claim_strong_request_tag,
2899          "must be but is nmethod " PTR_FORMAT " %u", p2i(extract_nmethod(_oops_do_mark_link)), extract_state(_oops_do_mark_link));
2900 
2901   nmethod* old_head = AtomicAccess::xchg(&_oops_do_mark_nmethods, this);
2902   // Self-loop if needed.
2903   if (old_head == nullptr) {
2904     old_head = this;
2905   }
2906   // Try to install end of list and weak done tag.
2907   if (AtomicAccess::cmpxchg(&_oops_do_mark_link, mark_link(this, claim_weak_request_tag), mark_link(old_head, claim_weak_done_tag)) == mark_link(this, claim_weak_request_tag)) {
2908     oops_do_log_change("oops_do, mark weak done");
2909     return nullptr;
2910   } else {
2911     return old_head;
2912   }
2913 }
2914 
2915 void nmethod::oops_do_add_to_list_as_strong_done() {
2916   assert(SafepointSynchronize::is_at_safepoint(), "only at safepoint");
2917 
2918   nmethod* old_head = AtomicAccess::xchg(&_oops_do_mark_nmethods, this);
2919   // Self-loop if needed.
2920   if (old_head == nullptr) {
2921     old_head = this;
2922   }
2923   assert(_oops_do_mark_link == mark_link(this, claim_strong_done_tag), "must be but is nmethod " PTR_FORMAT " state %u",
2924          p2i(extract_nmethod(_oops_do_mark_link)), extract_state(_oops_do_mark_link));
2925 
2926   oops_do_set_strong_done(old_head);
2927 }
2928 
2929 void nmethod::oops_do_process_weak(OopsDoProcessor* p) {
2930   if (!oops_do_try_claim_weak_request()) {
2931     // Failed to claim for weak processing.
2932     oops_do_log_change("oops_do, mark weak request fail");
2933     return;
2934   }
2935 
2936   p->do_regular_processing(this);
2937 
2938   nmethod* old_head = oops_do_try_add_to_list_as_weak_done();
2939   if (old_head == nullptr) {
2940     return;
2941   }
2942   oops_do_log_change("oops_do, mark weak done fail");
2943   // Adding to global list failed, another thread added a strong request.
2944   assert(extract_state(_oops_do_mark_link) == claim_strong_request_tag,
2945          "must be but is %u", extract_state(_oops_do_mark_link));
2946 
2947   oops_do_log_change("oops_do, mark weak request -> mark strong done");
2948 
2949   oops_do_set_strong_done(old_head);
2950   // Do missing strong processing.
2951   p->do_remaining_strong_processing(this);
2952 }
2953 
2954 void nmethod::oops_do_process_strong(OopsDoProcessor* p) {
2955   oops_do_mark_link* next_raw = oops_do_try_claim_strong_done();
2956   if (next_raw == nullptr) {
2957     p->do_regular_processing(this);
2958     oops_do_add_to_list_as_strong_done();
2959     return;
2960   }
2961   // Claim failed. Figure out why and handle it.
2962   if (oops_do_has_weak_request(next_raw)) {
2963     oops_do_mark_link* old = next_raw;
2964     // Claim failed because being weak processed (state == "weak request").
2965     // Try to request deferred strong processing.
2966     next_raw = oops_do_try_add_strong_request(old);
2967     if (next_raw == old) {
2968       // Successfully requested deferred strong processing.
2969       return;
2970     }
2971     // Failed because of a concurrent transition. No longer in "weak request" state.
2972   }
2973   if (oops_do_has_any_strong_state(next_raw)) {
2974     // Already claimed for strong processing or requested for such.
2975     return;
2976   }
2977   if (oops_do_try_claim_weak_done_as_strong_done(next_raw)) {
2978     // Successfully claimed "weak done" as "strong done". Do the missing marking.
2979     p->do_remaining_strong_processing(this);
2980     return;
2981   }
2982   // Claim failed, some other thread got it.
2983 }
2984 
2985 void nmethod::oops_do_marking_prologue() {
2986   assert_at_safepoint();
2987 
2988   log_trace(gc, nmethod)("oops_do_marking_prologue");
2989   assert(_oops_do_mark_nmethods == nullptr, "must be empty");
2990 }
2991 
2992 void nmethod::oops_do_marking_epilogue() {
2993   assert_at_safepoint();
2994 
2995   nmethod* next = _oops_do_mark_nmethods;
2996   _oops_do_mark_nmethods = nullptr;
2997   if (next != nullptr) {
2998     nmethod* cur;
2999     do {
3000       cur = next;
3001       next = extract_nmethod(cur->_oops_do_mark_link);
3002       cur->_oops_do_mark_link = nullptr;
3003       DEBUG_ONLY(cur->verify_oop_relocations());
3004 
3005       LogTarget(Trace, gc, nmethod) lt;
3006       if (lt.is_enabled()) {
3007         LogStream ls(lt);
3008         CompileTask::print(&ls, cur, "oops_do, unmark", /*short_form:*/ true);
3009       }
3010       // End if self-loop has been detected.
3011     } while (cur != next);
3012   }
3013   log_trace(gc, nmethod)("oops_do_marking_epilogue");
3014 }
3015 
3016 inline bool includes(void* p, void* from, void* to) {
3017   return from <= p && p < to;
3018 }
3019 
3020 
3021 void nmethod::copy_scopes_pcs(PcDesc* pcs, int count) {
3022   assert(count >= 2, "must be sentinel values, at least");
3023 
3024 #ifdef ASSERT
3025   // must be sorted and unique; we do a binary search in find_pc_desc()
3026   int prev_offset = pcs[0].pc_offset();
3027   assert(prev_offset == PcDesc::lower_offset_limit,
3028          "must start with a sentinel");
3029   for (int i = 1; i < count; i++) {
3030     int this_offset = pcs[i].pc_offset();
3031     assert(this_offset > prev_offset, "offsets must be sorted");
3032     prev_offset = this_offset;
3033   }
3034   assert(prev_offset == PcDesc::upper_offset_limit,
3035          "must end with a sentinel");
3036 #endif //ASSERT
3037 
3038   int size = count * sizeof(PcDesc);
3039   assert(scopes_pcs_size() >= size, "oob");
3040   memcpy(scopes_pcs_begin(), pcs, size);
3041 
3042   // Adjust the final sentinel downward.
3043   PcDesc* last_pc = &scopes_pcs_begin()[count-1];
3044   assert(last_pc->pc_offset() == PcDesc::upper_offset_limit, "sanity");
3045   last_pc->set_pc_offset(content_size() + 1);
3046   for (; last_pc + 1 < scopes_pcs_end(); last_pc += 1) {
3047     // Fill any rounding gaps with copies of the last record.
3048     last_pc[1] = last_pc[0];
3049   }
3050   // The following assert could fail if sizeof(PcDesc) is not
3051   // an integral multiple of oopSize (the rounding term).
3052   // If it fails, change the logic to always allocate a multiple
3053   // of sizeof(PcDesc), and fill unused words with copies of *last_pc.
3054   assert(last_pc + 1 == scopes_pcs_end(), "must match exactly");
3055 }
3056 
3057 void nmethod::copy_scopes_data(u_char* buffer, int size) {
3058   assert(scopes_data_size() >= size, "oob");
3059   memcpy(scopes_data_begin(), buffer, size);
3060 }
3061 
3062 #ifdef ASSERT
3063 static PcDesc* linear_search(int pc_offset, bool approximate, PcDesc* lower, PcDesc* upper) {
3064   PcDesc* res = nullptr;
3065   assert(lower != nullptr && lower->pc_offset() == PcDesc::lower_offset_limit,
3066          "must start with a sentinel");
3067   // lower + 1 to exclude initial sentinel
3068   for (PcDesc* p = lower + 1; p < upper; p++) {
3069     NOT_PRODUCT(--pc_nmethod_stats.pc_desc_tests);  // don't count this call to match_desc
3070     if (match_desc(p, pc_offset, approximate)) {
3071       if (res == nullptr) {
3072         res = p;
3073       } else {
3074         res = (PcDesc*) badAddress;
3075       }
3076     }
3077   }
3078   return res;
3079 }
3080 #endif
3081 
3082 
3083 #ifndef PRODUCT
3084 // Version of method to collect statistic
3085 PcDesc* PcDescContainer::find_pc_desc(address pc, bool approximate, address code_begin,
3086                                       PcDesc* lower, PcDesc* upper) {
3087   ++pc_nmethod_stats.pc_desc_queries;
3088   if (approximate) ++pc_nmethod_stats.pc_desc_approx;
3089 
3090   PcDesc* desc = _pc_desc_cache.last_pc_desc();
3091   assert(desc != nullptr, "PcDesc cache should be initialized already");
3092   if (desc->pc_offset() == (pc - code_begin)) {
3093     // Cached value matched
3094     ++pc_nmethod_stats.pc_desc_tests;
3095     ++pc_nmethod_stats.pc_desc_repeats;
3096     return desc;
3097   }
3098   return find_pc_desc_internal(pc, approximate, code_begin, lower, upper);
3099 }
3100 #endif
3101 
3102 // Finds a PcDesc with real-pc equal to "pc"
3103 PcDesc* PcDescContainer::find_pc_desc_internal(address pc, bool approximate, address code_begin,
3104                                                PcDesc* lower_incl, PcDesc* upper_incl) {
3105   if ((pc < code_begin) ||
3106       (pc - code_begin) >= (ptrdiff_t) PcDesc::upper_offset_limit) {
3107     return nullptr;  // PC is wildly out of range
3108   }
3109   int pc_offset = (int) (pc - code_begin);
3110 
3111   // Check the PcDesc cache if it contains the desired PcDesc
3112   // (This as an almost 100% hit rate.)
3113   PcDesc* res = _pc_desc_cache.find_pc_desc(pc_offset, approximate);
3114   if (res != nullptr) {
3115     assert(res == linear_search(pc_offset, approximate, lower_incl, upper_incl), "cache ok");
3116     return res;
3117   }
3118 
3119   // Fallback algorithm: quasi-linear search for the PcDesc
3120   // Find the last pc_offset less than the given offset.
3121   // The successor must be the required match, if there is a match at all.
3122   // (Use a fixed radix to avoid expensive affine pointer arithmetic.)
3123   PcDesc* lower = lower_incl;     // this is initial sentinel
3124   PcDesc* upper = upper_incl - 1; // exclude final sentinel
3125   if (lower >= upper)  return nullptr;  // no PcDescs at all
3126 
3127 #define assert_LU_OK \
3128   /* invariant on lower..upper during the following search: */ \
3129   assert(lower->pc_offset() <  pc_offset, "sanity"); \
3130   assert(upper->pc_offset() >= pc_offset, "sanity")
3131   assert_LU_OK;
3132 
3133   // Use the last successful return as a split point.
3134   PcDesc* mid = _pc_desc_cache.last_pc_desc();
3135   NOT_PRODUCT(++pc_nmethod_stats.pc_desc_searches);
3136   if (mid->pc_offset() < pc_offset) {
3137     lower = mid;
3138   } else {
3139     upper = mid;
3140   }
3141 
3142   // Take giant steps at first (4096, then 256, then 16, then 1)
3143   const int LOG2_RADIX = 4 /*smaller steps in debug mode:*/ DEBUG_ONLY(-1);
3144   const int RADIX = (1 << LOG2_RADIX);
3145   for (int step = (1 << (LOG2_RADIX*3)); step > 1; step >>= LOG2_RADIX) {
3146     while ((mid = lower + step) < upper) {
3147       assert_LU_OK;
3148       NOT_PRODUCT(++pc_nmethod_stats.pc_desc_searches);
3149       if (mid->pc_offset() < pc_offset) {
3150         lower = mid;
3151       } else {
3152         upper = mid;
3153         break;
3154       }
3155     }
3156     assert_LU_OK;
3157   }
3158 
3159   // Sneak up on the value with a linear search of length ~16.
3160   while (true) {
3161     assert_LU_OK;
3162     mid = lower + 1;
3163     NOT_PRODUCT(++pc_nmethod_stats.pc_desc_searches);
3164     if (mid->pc_offset() < pc_offset) {
3165       lower = mid;
3166     } else {
3167       upper = mid;
3168       break;
3169     }
3170   }
3171 #undef assert_LU_OK
3172 
3173   if (match_desc(upper, pc_offset, approximate)) {
3174     assert(upper == linear_search(pc_offset, approximate, lower_incl, upper_incl), "search mismatch");
3175     if (!Thread::current_in_asgct()) {
3176       // we don't want to modify the cache if we're in ASGCT
3177       // which is typically called in a signal handler
3178       _pc_desc_cache.add_pc_desc(upper);
3179     }
3180     return upper;
3181   } else {
3182     assert(nullptr == linear_search(pc_offset, approximate, lower_incl, upper_incl), "search mismatch");
3183     return nullptr;
3184   }
3185 }
3186 
3187 bool nmethod::check_dependency_on(DepChange& changes) {
3188   // What has happened:
3189   // 1) a new class dependee has been added
3190   // 2) dependee and all its super classes have been marked
3191   bool found_check = false;  // set true if we are upset
3192   for (Dependencies::DepStream deps(this); deps.next(); ) {
3193     // Evaluate only relevant dependencies.
3194     if (deps.spot_check_dependency_at(changes) != nullptr) {
3195       found_check = true;
3196       NOT_DEBUG(break);
3197     }
3198   }
3199   return found_check;
3200 }
3201 
3202 // Called from mark_for_deoptimization, when dependee is invalidated.
3203 bool nmethod::is_dependent_on_method(Method* dependee) {
3204   for (Dependencies::DepStream deps(this); deps.next(); ) {
3205     if (Dependencies::has_method_dep(deps.type())) {
3206       Method* method = deps.method_argument(0);
3207       if (method == dependee) return true;
3208     }
3209   }
3210   return false;
3211 }
3212 
3213 void nmethod_init() {
3214   // make sure you didn't forget to adjust the filler fields
3215   assert(sizeof(nmethod) % oopSize == 0, "nmethod size must be multiple of a word");
3216 }
3217 
3218 // -----------------------------------------------------------------------------
3219 // Verification
3220 
3221 class VerifyOopsClosure: public OopClosure {
3222   nmethod* _nm;
3223   bool     _ok;
3224 public:
3225   VerifyOopsClosure(nmethod* nm) : _nm(nm), _ok(true) { }
3226   bool ok() { return _ok; }
3227   virtual void do_oop(oop* p) {
3228     if (oopDesc::is_oop_or_null(*p)) return;
3229     // Print diagnostic information before calling print_nmethod().
3230     // Assertions therein might prevent call from returning.
3231     tty->print_cr("*** non-oop " PTR_FORMAT " found at " PTR_FORMAT " (offset %d)",
3232                   p2i(*p), p2i(p), (int)((intptr_t)p - (intptr_t)_nm));
3233     if (_ok) {
3234       _nm->print_nmethod(true);
3235       _ok = false;
3236     }
3237   }
3238   virtual void do_oop(narrowOop* p) { ShouldNotReachHere(); }
3239 };
3240 
3241 class VerifyMetadataClosure: public MetadataClosure {
3242  public:
3243   void do_metadata(Metadata* md) {
3244     if (md->is_method()) {
3245       Method* method = (Method*)md;
3246       assert(!method->is_old(), "Should not be installing old methods");
3247     }
3248   }
3249 };
3250 
3251 
3252 void nmethod::verify() {
3253   if (is_not_entrant())
3254     return;
3255 
3256   // assert(oopDesc::is_oop(method()), "must be valid");
3257 
3258   ResourceMark rm;
3259 
3260   if (!CodeCache::contains(this)) {
3261     fatal("nmethod at " INTPTR_FORMAT " not in zone", p2i(this));
3262   }
3263 
3264   if(is_native_method() )
3265     return;
3266 
3267   nmethod* nm = CodeCache::find_nmethod(verified_entry_point());
3268   if (nm != this) {
3269     fatal("find_nmethod did not find this nmethod (" INTPTR_FORMAT ")", p2i(this));
3270   }
3271 
3272   for (PcDesc* p = scopes_pcs_begin(); p < scopes_pcs_end(); p++) {
3273     if (! p->verify(this)) {
3274       tty->print_cr("\t\tin nmethod at " INTPTR_FORMAT " (pcs)", p2i(this));
3275     }
3276   }
3277 
3278 #ifdef ASSERT
3279 #if INCLUDE_JVMCI
3280   {
3281     // Verify that implicit exceptions that deoptimize have a PcDesc and OopMap
3282     ImmutableOopMapSet* oms = oop_maps();
3283     ImplicitExceptionTable implicit_table(this);
3284     for (uint i = 0; i < implicit_table.len(); i++) {
3285       int exec_offset = (int) implicit_table.get_exec_offset(i);
3286       if (implicit_table.get_exec_offset(i) == implicit_table.get_cont_offset(i)) {
3287         assert(pc_desc_at(code_begin() + exec_offset) != nullptr, "missing PcDesc");
3288         bool found = false;
3289         for (int i = 0, imax = oms->count(); i < imax; i++) {
3290           if (oms->pair_at(i)->pc_offset() == exec_offset) {
3291             found = true;
3292             break;
3293           }
3294         }
3295         assert(found, "missing oopmap");
3296       }
3297     }
3298   }
3299 #endif
3300 #endif
3301 
3302   VerifyOopsClosure voc(this);
3303   oops_do(&voc);
3304   assert(voc.ok(), "embedded oops must be OK");
3305   Universe::heap()->verify_nmethod(this);
3306 
3307   assert(_oops_do_mark_link == nullptr, "_oops_do_mark_link for %s should be nullptr but is " PTR_FORMAT,
3308          nm->method()->external_name(), p2i(_oops_do_mark_link));
3309   verify_scopes();
3310 
3311   CompiledICLocker nm_verify(this);
3312   VerifyMetadataClosure vmc;
3313   metadata_do(&vmc);
3314 }
3315 
3316 
3317 void nmethod::verify_interrupt_point(address call_site, bool is_inline_cache) {
3318 
3319   // Verify IC only when nmethod installation is finished.
3320   if (!is_not_installed()) {
3321     if (CompiledICLocker::is_safe(this)) {
3322       if (is_inline_cache) {
3323         CompiledIC_at(this, call_site);
3324       } else {
3325         CompiledDirectCall::at(call_site);
3326       }
3327     } else {
3328       CompiledICLocker ml_verify(this);
3329       if (is_inline_cache) {
3330         CompiledIC_at(this, call_site);
3331       } else {
3332         CompiledDirectCall::at(call_site);
3333       }
3334     }
3335   }
3336 
3337   HandleMark hm(Thread::current());
3338 
3339   PcDesc* pd = pc_desc_at(nativeCall_at(call_site)->return_address());
3340   assert(pd != nullptr, "PcDesc must exist");
3341   for (ScopeDesc* sd = new ScopeDesc(this, pd);
3342        !sd->is_top(); sd = sd->sender()) {
3343     sd->verify();
3344   }
3345 }
3346 
3347 void nmethod::verify_scopes() {
3348   if( !method() ) return;       // Runtime stubs have no scope
3349   if (method()->is_native()) return; // Ignore stub methods.
3350   // iterate through all interrupt point
3351   // and verify the debug information is valid.
3352   RelocIterator iter(this);
3353   while (iter.next()) {
3354     address stub = nullptr;
3355     switch (iter.type()) {
3356       case relocInfo::virtual_call_type:
3357         verify_interrupt_point(iter.addr(), true /* is_inline_cache */);
3358         break;
3359       case relocInfo::opt_virtual_call_type:
3360         stub = iter.opt_virtual_call_reloc()->static_stub();
3361         verify_interrupt_point(iter.addr(), false /* is_inline_cache */);
3362         break;
3363       case relocInfo::static_call_type:
3364         stub = iter.static_call_reloc()->static_stub();
3365         verify_interrupt_point(iter.addr(), false /* is_inline_cache */);
3366         break;
3367       case relocInfo::runtime_call_type:
3368       case relocInfo::runtime_call_w_cp_type: {
3369         address destination = iter.reloc()->value();
3370         // Right now there is no way to find out which entries support
3371         // an interrupt point.  It would be nice if we had this
3372         // information in a table.
3373         break;
3374       }
3375       default:
3376         break;
3377     }
3378     assert(stub == nullptr || stub_contains(stub), "static call stub outside stub section");
3379   }
3380 }
3381 
3382 
3383 // -----------------------------------------------------------------------------
3384 // Printing operations
3385 
3386 void nmethod::print_on_impl(outputStream* st) const {
3387   ResourceMark rm;
3388 
3389   st->print("Compiled method ");
3390 
3391   if (is_compiled_by_c1()) {
3392     st->print("(c1) ");
3393   } else if (is_compiled_by_c2()) {
3394     st->print("(c2) ");
3395   } else if (is_compiled_by_jvmci()) {
3396     st->print("(JVMCI) ");
3397   } else {
3398     st->print("(n/a) ");
3399   }
3400 
3401   print_on_with_msg(st, nullptr);
3402 
3403   if (WizardMode) {
3404     st->print("((nmethod*) " INTPTR_FORMAT ") ", p2i(this));
3405     st->print(" for method " INTPTR_FORMAT , p2i(method()));
3406     st->print(" { ");
3407     st->print_cr("%s ", state());
3408     st->print_cr("}:");
3409   }
3410   if (size              () > 0) st->print_cr(" total in heap  [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
3411                                              p2i(this),
3412                                              p2i(this) + size(),
3413                                              size());
3414   if (consts_size       () > 0) st->print_cr(" constants      [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
3415                                              p2i(consts_begin()),
3416                                              p2i(consts_end()),
3417                                              consts_size());
3418   if (insts_size        () > 0) st->print_cr(" main code      [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
3419                                              p2i(insts_begin()),
3420                                              p2i(insts_end()),
3421                                              insts_size());
3422   if (stub_size         () > 0) st->print_cr(" stub code      [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
3423                                              p2i(stub_begin()),
3424                                              p2i(stub_end()),
3425                                              stub_size());
3426   if (oops_size         () > 0) st->print_cr(" oops           [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
3427                                              p2i(oops_begin()),
3428                                              p2i(oops_end()),
3429                                              oops_size());
3430   if (mutable_data_size() > 0) st->print_cr(" mutable data [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
3431                                              p2i(mutable_data_begin()),
3432                                              p2i(mutable_data_end()),
3433                                              mutable_data_size());
3434   if (relocation_size() > 0)   st->print_cr(" relocation     [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
3435                                              p2i(relocation_begin()),
3436                                              p2i(relocation_end()),
3437                                              relocation_size());
3438   if (metadata_size     () > 0) st->print_cr(" metadata       [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
3439                                              p2i(metadata_begin()),
3440                                              p2i(metadata_end()),
3441                                              metadata_size());
3442 #if INCLUDE_JVMCI
3443   if (jvmci_data_size   () > 0) st->print_cr(" JVMCI data     [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
3444                                              p2i(jvmci_data_begin()),
3445                                              p2i(jvmci_data_end()),
3446                                              jvmci_data_size());
3447 #endif
3448   if (immutable_data_size() > 0) st->print_cr(" immutable data [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
3449                                              p2i(immutable_data_begin()),
3450                                              p2i(immutable_data_end()),
3451                                              immutable_data_size());
3452   if (dependencies_size () > 0) st->print_cr(" dependencies   [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
3453                                              p2i(dependencies_begin()),
3454                                              p2i(dependencies_end()),
3455                                              dependencies_size());
3456   if (nul_chk_table_size() > 0) st->print_cr(" nul chk table  [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
3457                                              p2i(nul_chk_table_begin()),
3458                                              p2i(nul_chk_table_end()),
3459                                              nul_chk_table_size());
3460   if (handler_table_size() > 0) st->print_cr(" handler table  [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
3461                                              p2i(handler_table_begin()),
3462                                              p2i(handler_table_end()),
3463                                              handler_table_size());
3464   if (scopes_pcs_size   () > 0) st->print_cr(" scopes pcs     [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
3465                                              p2i(scopes_pcs_begin()),
3466                                              p2i(scopes_pcs_end()),
3467                                              scopes_pcs_size());
3468   if (scopes_data_size  () > 0) st->print_cr(" scopes data    [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
3469                                              p2i(scopes_data_begin()),
3470                                              p2i(scopes_data_end()),
3471                                              scopes_data_size());
3472 #if INCLUDE_JVMCI
3473   if (speculations_size () > 0) st->print_cr(" speculations   [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
3474                                              p2i(speculations_begin()),
3475                                              p2i(speculations_end()),
3476                                              speculations_size());
3477 #endif
3478 }
3479 
3480 void nmethod::print_code() {
3481   ResourceMark m;
3482   ttyLocker ttyl;
3483   // Call the specialized decode method of this class.
3484   decode(tty);
3485 }
3486 
3487 #ifndef PRODUCT  // called InstanceKlass methods are available only then. Declared as PRODUCT_RETURN
3488 
3489 void nmethod::print_dependencies_on(outputStream* out) {
3490   ResourceMark rm;
3491   stringStream st;
3492   st.print_cr("Dependencies:");
3493   for (Dependencies::DepStream deps(this); deps.next(); ) {
3494     deps.print_dependency(&st);
3495     InstanceKlass* ctxk = deps.context_type();
3496     if (ctxk != nullptr) {
3497       if (ctxk->is_dependent_nmethod(this)) {
3498         st.print_cr("   [nmethod<=klass]%s", ctxk->external_name());
3499       }
3500     }
3501     deps.log_dependency();  // put it into the xml log also
3502   }
3503   out->print_raw(st.as_string());
3504 }
3505 #endif
3506 
3507 #if defined(SUPPORT_DATA_STRUCTS)
3508 
3509 // Print the oops from the underlying CodeBlob.
3510 void nmethod::print_oops(outputStream* st) {
3511   ResourceMark m;
3512   st->print("Oops:");
3513   if (oops_begin() < oops_end()) {
3514     st->cr();
3515     for (oop* p = oops_begin(); p < oops_end(); p++) {
3516       Disassembler::print_location((unsigned char*)p, (unsigned char*)oops_begin(), (unsigned char*)oops_end(), st, true, false);
3517       st->print(PTR_FORMAT " ", *((uintptr_t*)p));
3518       if (Universe::contains_non_oop_word(p)) {
3519         st->print_cr("NON_OOP");
3520         continue;  // skip non-oops
3521       }
3522       if (*p == nullptr) {
3523         st->print_cr("nullptr-oop");
3524         continue;  // skip non-oops
3525       }
3526       (*p)->print_value_on(st);
3527       st->cr();
3528     }
3529   } else {
3530     st->print_cr(" <list empty>");
3531   }
3532 }
3533 
3534 // Print metadata pool.
3535 void nmethod::print_metadata(outputStream* st) {
3536   ResourceMark m;
3537   st->print("Metadata:");
3538   if (metadata_begin() < metadata_end()) {
3539     st->cr();
3540     for (Metadata** p = metadata_begin(); p < metadata_end(); p++) {
3541       Disassembler::print_location((unsigned char*)p, (unsigned char*)metadata_begin(), (unsigned char*)metadata_end(), st, true, false);
3542       st->print(PTR_FORMAT " ", *((uintptr_t*)p));
3543       if (*p && *p != Universe::non_oop_word()) {
3544         (*p)->print_value_on(st);
3545       }
3546       st->cr();
3547     }
3548   } else {
3549     st->print_cr(" <list empty>");
3550   }
3551 }
3552 
3553 #ifndef PRODUCT  // ScopeDesc::print_on() is available only then. Declared as PRODUCT_RETURN
3554 void nmethod::print_scopes_on(outputStream* st) {
3555   // Find the first pc desc for all scopes in the code and print it.
3556   ResourceMark rm;
3557   st->print("scopes:");
3558   if (scopes_pcs_begin() < scopes_pcs_end()) {
3559     st->cr();
3560     for (PcDesc* p = scopes_pcs_begin(); p < scopes_pcs_end(); p++) {
3561       if (p->scope_decode_offset() == DebugInformationRecorder::serialized_null)
3562         continue;
3563 
3564       ScopeDesc* sd = scope_desc_at(p->real_pc(this));
3565       while (sd != nullptr) {
3566         sd->print_on(st, p);  // print output ends with a newline
3567         sd = sd->sender();
3568       }
3569     }
3570   } else {
3571     st->print_cr(" <list empty>");
3572   }
3573 }
3574 #endif
3575 
3576 #ifndef PRODUCT  // RelocIterator does support printing only then.
3577 void nmethod::print_relocations() {
3578   ResourceMark m;       // in case methods get printed via the debugger
3579   tty->print_cr("relocations:");
3580   RelocIterator iter(this);
3581   iter.print_on(tty);
3582 }
3583 #endif
3584 
3585 void nmethod::print_pcs_on(outputStream* st) {
3586   ResourceMark m;       // in case methods get printed via debugger
3587   st->print("pc-bytecode offsets:");
3588   if (scopes_pcs_begin() < scopes_pcs_end()) {
3589     st->cr();
3590     for (PcDesc* p = scopes_pcs_begin(); p < scopes_pcs_end(); p++) {
3591       p->print_on(st, this);  // print output ends with a newline
3592     }
3593   } else {
3594     st->print_cr(" <list empty>");
3595   }
3596 }
3597 
3598 void nmethod::print_handler_table() {
3599   ExceptionHandlerTable(this).print(code_begin());
3600 }
3601 
3602 void nmethod::print_nul_chk_table() {
3603   ImplicitExceptionTable(this).print(code_begin());
3604 }
3605 
3606 void nmethod::print_recorded_oop(int log_n, int i) {
3607   void* value;
3608 
3609   if (i == 0) {
3610     value = nullptr;
3611   } else {
3612     // Be careful around non-oop words. Don't create an oop
3613     // with that value, or it will assert in verification code.
3614     if (Universe::contains_non_oop_word(oop_addr_at(i))) {
3615       value = Universe::non_oop_word();
3616     } else {
3617       value = oop_at(i);
3618     }
3619   }
3620 
3621   tty->print("#%*d: " INTPTR_FORMAT " ", log_n, i, p2i(value));
3622 
3623   if (value == Universe::non_oop_word()) {
3624     tty->print("non-oop word");
3625   } else {
3626     if (value == nullptr) {
3627       tty->print("nullptr-oop");
3628     } else {
3629       oop_at(i)->print_value_on(tty);
3630     }
3631   }
3632 
3633   tty->cr();
3634 }
3635 
3636 void nmethod::print_recorded_oops() {
3637   const int n = oops_count();
3638   const int log_n = (n<10) ? 1 : (n<100) ? 2 : (n<1000) ? 3 : (n<10000) ? 4 : 6;
3639   tty->print("Recorded oops:");
3640   if (n > 0) {
3641     tty->cr();
3642     for (int i = 0; i < n; i++) {
3643       print_recorded_oop(log_n, i);
3644     }
3645   } else {
3646     tty->print_cr(" <list empty>");
3647   }
3648 }
3649 
3650 void nmethod::print_recorded_metadata() {
3651   const int n = metadata_count();
3652   const int log_n = (n<10) ? 1 : (n<100) ? 2 : (n<1000) ? 3 : (n<10000) ? 4 : 6;
3653   tty->print("Recorded metadata:");
3654   if (n > 0) {
3655     tty->cr();
3656     for (int i = 0; i < n; i++) {
3657       Metadata* m = metadata_at(i);
3658       tty->print("#%*d: " INTPTR_FORMAT " ", log_n, i, p2i(m));
3659       if (m == (Metadata*)Universe::non_oop_word()) {
3660         tty->print("non-metadata word");
3661       } else if (m == nullptr) {
3662         tty->print("nullptr-oop");
3663       } else {
3664         Metadata::print_value_on_maybe_null(tty, m);
3665       }
3666       tty->cr();
3667     }
3668   } else {
3669     tty->print_cr(" <list empty>");
3670   }
3671 }
3672 #endif
3673 
3674 #if defined(SUPPORT_ASSEMBLY) || defined(SUPPORT_ABSTRACT_ASSEMBLY)
3675 
3676 void nmethod::print_constant_pool(outputStream* st) {
3677   //-----------------------------------
3678   //---<  Print the constant pool  >---
3679   //-----------------------------------
3680   int consts_size = this->consts_size();
3681   if ( consts_size > 0 ) {
3682     unsigned char* cstart = this->consts_begin();
3683     unsigned char* cp     = cstart;
3684     unsigned char* cend   = cp + consts_size;
3685     unsigned int   bytes_per_line = 4;
3686     unsigned int   CP_alignment   = 8;
3687     unsigned int   n;
3688 
3689     st->cr();
3690 
3691     //---<  print CP header to make clear what's printed  >---
3692     if( ((uintptr_t)cp&(CP_alignment-1)) == 0 ) {
3693       n = bytes_per_line;
3694       st->print_cr("[Constant Pool]");
3695       Disassembler::print_location(cp, cstart, cend, st, true, true);
3696       Disassembler::print_hexdata(cp, n, st, true);
3697       st->cr();
3698     } else {
3699       n = (int)((uintptr_t)cp & (bytes_per_line-1));
3700       st->print_cr("[Constant Pool (unaligned)]");
3701     }
3702 
3703     //---<  print CP contents, bytes_per_line at a time  >---
3704     while (cp < cend) {
3705       Disassembler::print_location(cp, cstart, cend, st, true, false);
3706       Disassembler::print_hexdata(cp, n, st, false);
3707       cp += n;
3708       n   = bytes_per_line;
3709       st->cr();
3710     }
3711 
3712     //---<  Show potential alignment gap between constant pool and code  >---
3713     cend = code_begin();
3714     if( cp < cend ) {
3715       n = 4;
3716       st->print_cr("[Code entry alignment]");
3717       while (cp < cend) {
3718         Disassembler::print_location(cp, cstart, cend, st, false, false);
3719         cp += n;
3720         st->cr();
3721       }
3722     }
3723   } else {
3724     st->print_cr("[Constant Pool (empty)]");
3725   }
3726   st->cr();
3727 }
3728 
3729 #endif
3730 
3731 // Disassemble this nmethod.
3732 // Print additional debug information, if requested. This could be code
3733 // comments, block comments, profiling counters, etc.
3734 // The undisassembled format is useful no disassembler library is available.
3735 // The resulting hex dump (with markers) can be disassembled later, or on
3736 // another system, when/where a disassembler library is available.
3737 void nmethod::decode2(outputStream* ost) const {
3738 
3739   // Called from frame::back_trace_with_decode without ResourceMark.
3740   ResourceMark rm;
3741 
3742   // Make sure we have a valid stream to print on.
3743   outputStream* st = ost ? ost : tty;
3744 
3745 #if defined(SUPPORT_ABSTRACT_ASSEMBLY) && ! defined(SUPPORT_ASSEMBLY)
3746   const bool use_compressed_format    = true;
3747   const bool compressed_with_comments = use_compressed_format && (AbstractDisassembler::show_comment() ||
3748                                                                   AbstractDisassembler::show_block_comment());
3749 #else
3750   const bool use_compressed_format    = Disassembler::is_abstract();
3751   const bool compressed_with_comments = use_compressed_format && (AbstractDisassembler::show_comment() ||
3752                                                                   AbstractDisassembler::show_block_comment());
3753 #endif
3754 
3755   st->cr();
3756   this->print_on(st);
3757   st->cr();
3758 
3759 #if defined(SUPPORT_ASSEMBLY)
3760   //----------------------------------
3761   //---<  Print real disassembly  >---
3762   //----------------------------------
3763   if (! use_compressed_format) {
3764     st->print_cr("[Disassembly]");
3765     Disassembler::decode(const_cast<nmethod*>(this), st);
3766     st->bol();
3767     st->print_cr("[/Disassembly]");
3768     return;
3769   }
3770 #endif
3771 
3772 #if defined(SUPPORT_ABSTRACT_ASSEMBLY)
3773 
3774   // Compressed undisassembled disassembly format.
3775   // The following status values are defined/supported:
3776   //   = 0 - currently at bol() position, nothing printed yet on current line.
3777   //   = 1 - currently at position after print_location().
3778   //   > 1 - in the midst of printing instruction stream bytes.
3779   int        compressed_format_idx    = 0;
3780   int        code_comment_column      = 0;
3781   const int  instr_maxlen             = Assembler::instr_maxlen();
3782   const uint tabspacing               = 8;
3783   unsigned char* start = this->code_begin();
3784   unsigned char* p     = this->code_begin();
3785   unsigned char* end   = this->code_end();
3786   unsigned char* pss   = p; // start of a code section (used for offsets)
3787 
3788   if ((start == nullptr) || (end == nullptr)) {
3789     st->print_cr("PrintAssembly not possible due to uninitialized section pointers");
3790     return;
3791   }
3792 #endif
3793 
3794 #if defined(SUPPORT_ABSTRACT_ASSEMBLY)
3795   //---<  plain abstract disassembly, no comments or anything, just section headers  >---
3796   if (use_compressed_format && ! compressed_with_comments) {
3797     const_cast<nmethod*>(this)->print_constant_pool(st);
3798 
3799     st->bol();
3800     st->cr();
3801     st->print_cr("Loading hsdis library failed, undisassembled code is shown in MachCode section");
3802     //---<  Open the output (Marker for post-mortem disassembler)  >---
3803     st->print_cr("[MachCode]");
3804     const char* header = nullptr;
3805     address p0 = p;
3806     while (p < end) {
3807       address pp = p;
3808       while ((p < end) && (header == nullptr)) {
3809         header = nmethod_section_label(p);
3810         pp  = p;
3811         p  += Assembler::instr_len(p);
3812       }
3813       if (pp > p0) {
3814         AbstractDisassembler::decode_range_abstract(p0, pp, start, end, st, Assembler::instr_maxlen());
3815         p0 = pp;
3816         p  = pp;
3817         header = nullptr;
3818       } else if (header != nullptr) {
3819         st->bol();
3820         st->print_cr("%s", header);
3821         header = nullptr;
3822       }
3823     }
3824     //---<  Close the output (Marker for post-mortem disassembler)  >---
3825     st->bol();
3826     st->print_cr("[/MachCode]");
3827     return;
3828   }
3829 #endif
3830 
3831 #if defined(SUPPORT_ABSTRACT_ASSEMBLY)
3832   //---<  abstract disassembly with comments and section headers merged in  >---
3833   if (compressed_with_comments) {
3834     const_cast<nmethod*>(this)->print_constant_pool(st);
3835 
3836     st->bol();
3837     st->cr();
3838     st->print_cr("Loading hsdis library failed, undisassembled code is shown in MachCode section");
3839     //---<  Open the output (Marker for post-mortem disassembler)  >---
3840     st->print_cr("[MachCode]");
3841     while ((p < end) && (p != nullptr)) {
3842       const int instruction_size_in_bytes = Assembler::instr_len(p);
3843 
3844       //---<  Block comments for nmethod. Interrupts instruction stream, if any.  >---
3845       // Outputs a bol() before and a cr() after, but only if a comment is printed.
3846       // Prints nmethod_section_label as well.
3847       if (AbstractDisassembler::show_block_comment()) {
3848         print_block_comment(st, p);
3849         if (st->position() == 0) {
3850           compressed_format_idx = 0;
3851         }
3852       }
3853 
3854       //---<  New location information after line break  >---
3855       if (compressed_format_idx == 0) {
3856         code_comment_column   = Disassembler::print_location(p, pss, end, st, false, false);
3857         compressed_format_idx = 1;
3858       }
3859 
3860       //---<  Code comment for current instruction. Address range [p..(p+len))  >---
3861       unsigned char* p_end = p + (ssize_t)instruction_size_in_bytes;
3862       S390_ONLY(if (p_end > end) p_end = end;) // avoid getting past the end
3863 
3864       if (AbstractDisassembler::show_comment() && const_cast<nmethod*>(this)->has_code_comment(p, p_end)) {
3865         //---<  interrupt instruction byte stream for code comment  >---
3866         if (compressed_format_idx > 1) {
3867           st->cr();  // interrupt byte stream
3868           st->cr();  // add an empty line
3869           code_comment_column = Disassembler::print_location(p, pss, end, st, false, false);
3870         }
3871         const_cast<nmethod*>(this)->print_code_comment_on(st, code_comment_column, p, p_end );
3872         st->bol();
3873         compressed_format_idx = 0;
3874       }
3875 
3876       //---<  New location information after line break  >---
3877       if (compressed_format_idx == 0) {
3878         code_comment_column   = Disassembler::print_location(p, pss, end, st, false, false);
3879         compressed_format_idx = 1;
3880       }
3881 
3882       //---<  Nicely align instructions for readability  >---
3883       if (compressed_format_idx > 1) {
3884         Disassembler::print_delimiter(st);
3885       }
3886 
3887       //---<  Now, finally, print the actual instruction bytes  >---
3888       unsigned char* p0 = p;
3889       p = Disassembler::decode_instruction_abstract(p, st, instruction_size_in_bytes, instr_maxlen);
3890       compressed_format_idx += (int)(p - p0);
3891 
3892       if (Disassembler::start_newline(compressed_format_idx-1)) {
3893         st->cr();
3894         compressed_format_idx = 0;
3895       }
3896     }
3897     //---<  Close the output (Marker for post-mortem disassembler)  >---
3898     st->bol();
3899     st->print_cr("[/MachCode]");
3900     return;
3901   }
3902 #endif
3903 }
3904 
3905 #if defined(SUPPORT_ASSEMBLY) || defined(SUPPORT_ABSTRACT_ASSEMBLY)
3906 
3907 const char* nmethod::reloc_string_for(u_char* begin, u_char* end) {
3908   RelocIterator iter(this, begin, end);
3909   bool have_one = false;
3910   while (iter.next()) {
3911     have_one = true;
3912     switch (iter.type()) {
3913         case relocInfo::none: {
3914           // Skip it and check next
3915           break;
3916         }
3917         case relocInfo::oop_type: {
3918           // Get a non-resizable resource-allocated stringStream.
3919           // Our callees make use of (nested) ResourceMarks.
3920           stringStream st(NEW_RESOURCE_ARRAY(char, 1024), 1024);
3921           oop_Relocation* r = iter.oop_reloc();
3922           oop obj = r->oop_value();
3923           st.print("oop(");
3924           if (obj == nullptr) st.print("nullptr");
3925           else obj->print_value_on(&st);
3926           st.print(")");
3927           return st.as_string();
3928         }
3929         case relocInfo::metadata_type: {
3930           stringStream st;
3931           metadata_Relocation* r = iter.metadata_reloc();
3932           Metadata* obj = r->metadata_value();
3933           st.print("metadata(");
3934           if (obj == nullptr) st.print("nullptr");
3935           else obj->print_value_on(&st);
3936           st.print(")");
3937           return st.as_string();
3938         }
3939         case relocInfo::runtime_call_type:
3940         case relocInfo::runtime_call_w_cp_type: {
3941           stringStream st;
3942           st.print("runtime_call");
3943           CallRelocation* r = (CallRelocation*)iter.reloc();
3944           address dest = r->destination();
3945           if (StubRoutines::contains(dest)) {
3946             StubCodeDesc* desc = StubCodeDesc::desc_for(dest);
3947             if (desc == nullptr) {
3948               desc = StubCodeDesc::desc_for(dest + frame::pc_return_offset);
3949             }
3950             if (desc != nullptr) {
3951               st.print(" Stub::%s", desc->name());
3952               return st.as_string();
3953             }
3954           }
3955           CodeBlob* cb = CodeCache::find_blob(dest);
3956           if (cb != nullptr) {
3957             st.print(" %s", cb->name());
3958           } else {
3959             ResourceMark rm;
3960             const int buflen = 1024;
3961             char* buf = NEW_RESOURCE_ARRAY(char, buflen);
3962             int offset;
3963             if (os::dll_address_to_function_name(dest, buf, buflen, &offset)) {
3964               st.print(" %s", buf);
3965               if (offset != 0) {
3966                 st.print("+%d", offset);
3967               }
3968             }
3969           }
3970           return st.as_string();
3971         }
3972         case relocInfo::virtual_call_type: {
3973           stringStream st;
3974           st.print_raw("virtual_call");
3975           virtual_call_Relocation* r = iter.virtual_call_reloc();
3976           Method* m = r->method_value();
3977           if (m != nullptr) {
3978             assert(m->is_method(), "");
3979             m->print_short_name(&st);
3980           }
3981           return st.as_string();
3982         }
3983         case relocInfo::opt_virtual_call_type: {
3984           stringStream st;
3985           st.print_raw("optimized virtual_call");
3986           opt_virtual_call_Relocation* r = iter.opt_virtual_call_reloc();
3987           Method* m = r->method_value();
3988           if (m != nullptr) {
3989             assert(m->is_method(), "");
3990             m->print_short_name(&st);
3991           }
3992           return st.as_string();
3993         }
3994         case relocInfo::static_call_type: {
3995           stringStream st;
3996           st.print_raw("static_call");
3997           static_call_Relocation* r = iter.static_call_reloc();
3998           Method* m = r->method_value();
3999           if (m != nullptr) {
4000             assert(m->is_method(), "");
4001             m->print_short_name(&st);
4002           }
4003           return st.as_string();
4004         }
4005         case relocInfo::static_stub_type:      return "static_stub";
4006         case relocInfo::external_word_type:    return "external_word";
4007         case relocInfo::internal_word_type:    return "internal_word";
4008         case relocInfo::section_word_type:     return "section_word";
4009         case relocInfo::poll_type:             return "poll";
4010         case relocInfo::poll_return_type:      return "poll_return";
4011         case relocInfo::trampoline_stub_type:  return "trampoline_stub";
4012         case relocInfo::entry_guard_type:      return "entry_guard";
4013         case relocInfo::post_call_nop_type:    return "post_call_nop";
4014         case relocInfo::barrier_type: {
4015           barrier_Relocation* const reloc = iter.barrier_reloc();
4016           stringStream st;
4017           st.print("barrier format=%d", reloc->format());
4018           return st.as_string();
4019         }
4020 
4021         case relocInfo::type_mask:             return "type_bit_mask";
4022 
4023         default: {
4024           stringStream st;
4025           st.print("unknown relocInfo=%d", (int) iter.type());
4026           return st.as_string();
4027         }
4028     }
4029   }
4030   return have_one ? "other" : nullptr;
4031 }
4032 
4033 // Return the last scope in (begin..end]
4034 ScopeDesc* nmethod::scope_desc_in(address begin, address end) {
4035   PcDesc* p = pc_desc_near(begin+1);
4036   if (p != nullptr && p->real_pc(this) <= end) {
4037     return new ScopeDesc(this, p);
4038   }
4039   return nullptr;
4040 }
4041 
4042 const char* nmethod::nmethod_section_label(address pos) const {
4043   const char* label = nullptr;
4044   if (pos == code_begin())                                              label = "[Instructions begin]";
4045   if (pos == entry_point())                                             label = "[Entry Point]";
4046   if (pos == inline_entry_point())                                      label = "[Inline Entry Point]";
4047   if (pos == verified_entry_point())                                    label = "[Verified Entry Point]";
4048   if (pos == verified_inline_entry_point())                             label = "[Verified Inline Entry Point]";
4049   if (pos == verified_inline_ro_entry_point())                          label = "[Verified Inline Entry Point (RO)]";
4050   if (pos == consts_begin() && pos != insts_begin())                    label = "[Constants]";
4051   // Check stub_code before checking exception_handler or deopt_handler.
4052   if (pos == this->stub_begin())                                        label = "[Stub Code]";
4053   if (JVMCI_ONLY(_exception_offset >= 0 &&) pos == exception_begin())          label = "[Exception Handler]";
4054   if (JVMCI_ONLY(_deopt_handler_offset != -1 &&) pos == deopt_handler_begin()) label = "[Deopt Handler Code]";
4055   return label;
4056 }
4057 
4058 static int maybe_print_entry_label(outputStream* stream, address pos, address entry, const char* label) {
4059   if (pos == entry) {
4060     stream->bol();
4061     stream->print_cr("%s", label);
4062     return 1;
4063   } else {
4064     return 0;
4065   }
4066 }
4067 
4068 void nmethod::print_nmethod_labels(outputStream* stream, address block_begin, bool print_section_labels) const {
4069   if (print_section_labels) {
4070     int n = 0;
4071     // Multiple entry points may be at the same position. Print them all.
4072     n += maybe_print_entry_label(stream, block_begin, entry_point(),                    "[Entry Point]");
4073     n += maybe_print_entry_label(stream, block_begin, inline_entry_point(),             "[Inline Entry Point]");
4074     n += maybe_print_entry_label(stream, block_begin, verified_entry_point(),           "[Verified Entry Point]");
4075     n += maybe_print_entry_label(stream, block_begin, verified_inline_entry_point(),    "[Verified Inline Entry Point]");
4076     n += maybe_print_entry_label(stream, block_begin, verified_inline_ro_entry_point(), "[Verified Inline Entry Point (RO)]");
4077     if (n == 0) {
4078       const char* label = nmethod_section_label(block_begin);
4079       if (label != nullptr) {
4080         stream->bol();
4081         stream->print_cr("%s", label);
4082       }
4083     }
4084   }
4085 
4086   Method* m = method();
4087   if (m == nullptr || is_osr_method()) {
4088     return;
4089   }
4090 
4091   // Print the name of the method (only once)
4092   address low = MIN3(entry_point(),
4093                      verified_entry_point(),
4094                      inline_entry_point());
4095   // The verified inline entry point and verified inline RO entry point are not always
4096   // used. When they are unused. CodeOffsets::Verified_Inline_Entry(_RO) is -1. Hence,
4097   // the calculated entry point is smaller than the block they are offsetting into.
4098   if (verified_inline_entry_point() >= block_begin) {
4099     low = MIN2(low, verified_inline_entry_point());
4100   }
4101   if (verified_inline_ro_entry_point() >= block_begin) {
4102     low = MIN2(low, verified_inline_ro_entry_point());
4103   }
4104   assert(low != 0, "sanity");
4105   if (block_begin == low) {
4106     stream->print("  # ");
4107     m->print_value_on(stream);
4108     stream->cr();
4109   }
4110 
4111   // Print the arguments for the 3 types of verified entry points
4112   CompiledEntrySignature ces(m);
4113   ces.compute_calling_conventions(false);
4114   const GrowableArray<SigEntry>* sig_cc;
4115   const VMRegPair* regs;
4116   if (block_begin == verified_entry_point()) {
4117     sig_cc = ces.sig_cc();
4118     regs = ces.regs_cc();
4119   } else if (block_begin == verified_inline_entry_point()) {
4120     sig_cc = ces.sig();
4121     regs = ces.regs();
4122   } else if (block_begin == verified_inline_ro_entry_point()) {
4123     sig_cc = ces.sig_cc_ro();
4124     regs = ces.regs_cc_ro();
4125   } else {
4126     return;
4127   }
4128 
4129   bool has_this = !m->is_static();
4130   if (ces.has_inline_recv() && block_begin == verified_entry_point()) {
4131     // <this> argument is scalarized for verified_entry_point()
4132     has_this = false;
4133   }
4134   const char* spname = "sp"; // make arch-specific?
4135   int stack_slot_offset = this->frame_size() * wordSize;
4136   int tab1 = 14, tab2 = 24;
4137   int sig_index = 0;
4138   int arg_index = has_this ? -1 : 0;
4139   bool did_old_sp = false;
4140   for (ExtendedSignature sig = ExtendedSignature(sig_cc, SigEntryFilter()); !sig.at_end(); ++sig) {
4141     bool at_this = (arg_index == -1);
4142     bool at_old_sp = false;
4143     BasicType t = (*sig)._bt;
4144     if (at_this) {
4145       stream->print("  # this: ");
4146     } else {
4147       stream->print("  # parm%d: ", arg_index);
4148     }
4149     stream->move_to(tab1);
4150     VMReg fst = regs[sig_index].first();
4151     VMReg snd = regs[sig_index].second();
4152     if (fst->is_reg()) {
4153       stream->print("%s", fst->name());
4154       if (snd->is_valid())  {
4155         stream->print(":%s", snd->name());
4156       }
4157     } else if (fst->is_stack()) {
4158       int offset = fst->reg2stack() * VMRegImpl::stack_slot_size + stack_slot_offset;
4159       if (offset == stack_slot_offset)  at_old_sp = true;
4160       stream->print("[%s+0x%x]", spname, offset);
4161     } else {
4162       stream->print("reg%d:%d??", (int)(intptr_t)fst, (int)(intptr_t)snd);
4163     }
4164     stream->print(" ");
4165     stream->move_to(tab2);
4166     stream->print("= ");
4167     if (at_this) {
4168       m->method_holder()->print_value_on(stream);
4169     } else {
4170       bool did_name = false;
4171       if (is_reference_type(t)) {
4172         Symbol* name = (*sig)._name;
4173         name->print_value_on(stream);
4174         did_name = true;
4175       }
4176       if (!did_name)
4177         stream->print("%s", type2name(t));
4178       if ((*sig)._null_marker) {
4179         stream->print(" (null marker)");
4180       }
4181     }
4182     if (at_old_sp) {
4183       stream->print("  (%s of caller)", spname);
4184       did_old_sp = true;
4185     }
4186     stream->cr();
4187     sig_index += type2size[t];
4188     arg_index += 1;
4189   }
4190   if (!did_old_sp) {
4191     stream->print("  # ");
4192     stream->move_to(tab1);
4193     stream->print("[%s+0x%x]", spname, stack_slot_offset);
4194     stream->print("  (%s of caller)", spname);
4195     stream->cr();
4196   }
4197 }
4198 
4199 // Returns whether this nmethod has code comments.
4200 bool nmethod::has_code_comment(address begin, address end) {
4201   // scopes?
4202   ScopeDesc* sd  = scope_desc_in(begin, end);
4203   if (sd != nullptr) return true;
4204 
4205   // relocations?
4206   const char* str = reloc_string_for(begin, end);
4207   if (str != nullptr) return true;
4208 
4209   // implicit exceptions?
4210   int cont_offset = ImplicitExceptionTable(this).continuation_offset((uint)(begin - code_begin()));
4211   if (cont_offset != 0) return true;
4212 
4213   return false;
4214 }
4215 
4216 void nmethod::print_code_comment_on(outputStream* st, int column, address begin, address end) {
4217   ImplicitExceptionTable implicit_table(this);
4218   int pc_offset = (int)(begin - code_begin());
4219   int cont_offset = implicit_table.continuation_offset(pc_offset);
4220   bool oop_map_required = false;
4221   if (cont_offset != 0) {
4222     st->move_to(column, 6, 0);
4223     if (pc_offset == cont_offset) {
4224       st->print("; implicit exception: deoptimizes");
4225       oop_map_required = true;
4226     } else {
4227       st->print("; implicit exception: dispatches to " INTPTR_FORMAT, p2i(code_begin() + cont_offset));
4228     }
4229   }
4230 
4231   // Find an oopmap in (begin, end].  We use the odd half-closed
4232   // interval so that oop maps and scope descs which are tied to the
4233   // byte after a call are printed with the call itself.  OopMaps
4234   // associated with implicit exceptions are printed with the implicit
4235   // instruction.
4236   address base = code_begin();
4237   ImmutableOopMapSet* oms = oop_maps();
4238   if (oms != nullptr) {
4239     for (int i = 0, imax = oms->count(); i < imax; i++) {
4240       const ImmutableOopMapPair* pair = oms->pair_at(i);
4241       const ImmutableOopMap* om = pair->get_from(oms);
4242       address pc = base + pair->pc_offset();
4243       if (pc >= begin) {
4244 #if INCLUDE_JVMCI
4245         bool is_implicit_deopt = implicit_table.continuation_offset(pair->pc_offset()) == (uint) pair->pc_offset();
4246 #else
4247         bool is_implicit_deopt = false;
4248 #endif
4249         if (is_implicit_deopt ? pc == begin : pc > begin && pc <= end) {
4250           st->move_to(column, 6, 0);
4251           st->print("; ");
4252           om->print_on(st);
4253           oop_map_required = false;
4254         }
4255       }
4256       if (pc > end) {
4257         break;
4258       }
4259     }
4260   }
4261   assert(!oop_map_required, "missed oopmap");
4262 
4263   Thread* thread = Thread::current();
4264 
4265   // Print any debug info present at this pc.
4266   ScopeDesc* sd  = scope_desc_in(begin, end);
4267   if (sd != nullptr) {
4268     st->move_to(column, 6, 0);
4269     if (sd->bci() == SynchronizationEntryBCI) {
4270       st->print(";*synchronization entry");
4271     } else if (sd->bci() == AfterBci) {
4272       st->print(";* method exit (unlocked if synchronized)");
4273     } else if (sd->bci() == UnwindBci) {
4274       st->print(";* unwind (locked if synchronized)");
4275     } else if (sd->bci() == AfterExceptionBci) {
4276       st->print(";* unwind (unlocked if synchronized)");
4277     } else if (sd->bci() == UnknownBci) {
4278       st->print(";* unknown");
4279     } else if (sd->bci() == InvalidFrameStateBci) {
4280       st->print(";* invalid frame state");
4281     } else {
4282       if (sd->method() == nullptr) {
4283         st->print("method is nullptr");
4284       } else if (sd->method()->is_native()) {
4285         st->print("method is native");
4286       } else {
4287         Bytecodes::Code bc = sd->method()->java_code_at(sd->bci());
4288         st->print(";*%s", Bytecodes::name(bc));
4289         switch (bc) {
4290         case Bytecodes::_invokevirtual:
4291         case Bytecodes::_invokespecial:
4292         case Bytecodes::_invokestatic:
4293         case Bytecodes::_invokeinterface:
4294           {
4295             Bytecode_invoke invoke(methodHandle(thread, sd->method()), sd->bci());
4296             st->print(" ");
4297             if (invoke.name() != nullptr)
4298               invoke.name()->print_symbol_on(st);
4299             else
4300               st->print("<UNKNOWN>");
4301             break;
4302           }
4303         case Bytecodes::_getfield:
4304         case Bytecodes::_putfield:
4305         case Bytecodes::_getstatic:
4306         case Bytecodes::_putstatic:
4307           {
4308             Bytecode_field field(methodHandle(thread, sd->method()), sd->bci());
4309             st->print(" ");
4310             if (field.name() != nullptr)
4311               field.name()->print_symbol_on(st);
4312             else
4313               st->print("<UNKNOWN>");
4314           }
4315         default:
4316           break;
4317         }
4318       }
4319       st->print(" {reexecute=%d rethrow=%d return_oop=%d return_scalarized=%d}", sd->should_reexecute(), sd->rethrow_exception(), sd->return_oop(), sd->return_scalarized());
4320     }
4321 
4322     // Print all scopes
4323     for (;sd != nullptr; sd = sd->sender()) {
4324       st->move_to(column, 6, 0);
4325       st->print("; -");
4326       if (sd->should_reexecute()) {
4327         st->print(" (reexecute)");
4328       }
4329       if (sd->method() == nullptr) {
4330         st->print("method is nullptr");
4331       } else {
4332         sd->method()->print_short_name(st);
4333       }
4334       int lineno = sd->method()->line_number_from_bci(sd->bci());
4335       if (lineno != -1) {
4336         st->print("@%d (line %d)", sd->bci(), lineno);
4337       } else {
4338         st->print("@%d", sd->bci());
4339       }
4340       st->cr();
4341     }
4342   }
4343 
4344   // Print relocation information
4345   // Prevent memory leak: allocating without ResourceMark.
4346   ResourceMark rm;
4347   const char* str = reloc_string_for(begin, end);
4348   if (str != nullptr) {
4349     if (sd != nullptr) st->cr();
4350     st->move_to(column, 6, 0);
4351     st->print(";   {%s}", str);
4352   }
4353 }
4354 
4355 #endif
4356 
4357 address nmethod::call_instruction_address(address pc) const {
4358   if (NativeCall::is_call_before(pc)) {
4359     NativeCall *ncall = nativeCall_before(pc);
4360     return ncall->instruction_address();
4361   }
4362   return nullptr;
4363 }
4364 
4365 void nmethod::print_value_on_impl(outputStream* st) const {
4366   st->print_cr("nmethod");
4367 #if defined(SUPPORT_DATA_STRUCTS)
4368   print_on_with_msg(st, nullptr);
4369 #endif
4370 }
4371 
4372 #ifndef PRODUCT
4373 
4374 void nmethod::print_calls(outputStream* st) {
4375   RelocIterator iter(this);
4376   while (iter.next()) {
4377     switch (iter.type()) {
4378     case relocInfo::virtual_call_type: {
4379       CompiledICLocker ml_verify(this);
4380       CompiledIC_at(&iter)->print();
4381       break;
4382     }
4383     case relocInfo::static_call_type:
4384     case relocInfo::opt_virtual_call_type:
4385       st->print_cr("Direct call at " INTPTR_FORMAT, p2i(iter.reloc()->addr()));
4386       CompiledDirectCall::at(iter.reloc())->print();
4387       break;
4388     default:
4389       break;
4390     }
4391   }
4392 }
4393 
4394 void nmethod::print_statistics() {
4395   ttyLocker ttyl;
4396   if (xtty != nullptr)  xtty->head("statistics type='nmethod'");
4397   native_nmethod_stats.print_native_nmethod_stats();
4398 #ifdef COMPILER1
4399   c1_java_nmethod_stats.print_nmethod_stats("C1");
4400 #endif
4401 #ifdef COMPILER2
4402   c2_java_nmethod_stats.print_nmethod_stats("C2");
4403 #endif
4404 #if INCLUDE_JVMCI
4405   jvmci_java_nmethod_stats.print_nmethod_stats("JVMCI");
4406 #endif
4407   unknown_java_nmethod_stats.print_nmethod_stats("Unknown");
4408   DebugInformationRecorder::print_statistics();
4409   pc_nmethod_stats.print_pc_stats();
4410   Dependencies::print_statistics();
4411   ExternalsRecorder::print_statistics();
4412   if (xtty != nullptr)  xtty->tail("statistics");
4413 }
4414 
4415 #endif // !PRODUCT
4416 
4417 #if INCLUDE_JVMCI
4418 void nmethod::update_speculation(JavaThread* thread) {
4419   jlong speculation = thread->pending_failed_speculation();
4420   if (speculation != 0) {
4421     guarantee(jvmci_nmethod_data() != nullptr, "failed speculation in nmethod without failed speculation list");
4422     jvmci_nmethod_data()->add_failed_speculation(this, speculation);
4423     thread->set_pending_failed_speculation(0);
4424   }
4425 }
4426 
4427 const char* nmethod::jvmci_name() {
4428   if (jvmci_nmethod_data() != nullptr) {
4429     return jvmci_nmethod_data()->name();
4430   }
4431   return nullptr;
4432 }
4433 
4434 bool nmethod::jvmci_skip_profile_deopt() const {
4435   return jvmci_nmethod_data() != nullptr && !jvmci_nmethod_data()->profile_deopt();
4436 }
4437 #endif