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