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