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