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