1 /*
   2  * Copyright (c) 1997, 2012, 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 #ifndef SHARE_VM_CODE_NMETHOD_HPP
  26 #define SHARE_VM_CODE_NMETHOD_HPP
  27 
  28 #include "code/codeBlob.hpp"
  29 #include "code/pcDesc.hpp"
  30 #include "oops/metadata.hpp"
  31 
  32 // This class is used internally by nmethods, to cache
  33 // exception/pc/handler information.
  34 
  35 class ExceptionCache : public CHeapObj<mtCode> {
  36   friend class VMStructs;
  37  private:
  38   enum { cache_size = 16 };
  39   Klass*   _exception_type;
  40   address  _pc[cache_size];
  41   address  _handler[cache_size];
  42   int      _count;
  43   ExceptionCache* _next;
  44 
  45   address pc_at(int index)                     { assert(index >= 0 && index < count(),""); return _pc[index]; }
  46   void    set_pc_at(int index, address a)      { assert(index >= 0 && index < cache_size,""); _pc[index] = a; }
  47   address handler_at(int index)                { assert(index >= 0 && index < count(),""); return _handler[index]; }
  48   void    set_handler_at(int index, address a) { assert(index >= 0 && index < cache_size,""); _handler[index] = a; }
  49   int     count()                              { return _count; }
  50   void    increment_count()                    { _count++; }
  51 
  52  public:
  53 
  54   ExceptionCache(Handle exception, address pc, address handler);
  55 
  56   Klass*    exception_type()                { return _exception_type; }
  57   ExceptionCache* next()                    { return _next; }
  58   void      set_next(ExceptionCache *ec)    { _next = ec; }
  59 
  60   address match(Handle exception, address pc);
  61   bool    match_exception_with_space(Handle exception) ;
  62   address test_address(address addr);
  63   bool    add_address_and_handler(address addr, address handler) ;
  64 };
  65 
  66 
  67 // cache pc descs found in earlier inquiries
  68 class PcDescCache VALUE_OBJ_CLASS_SPEC {
  69   friend class VMStructs;
  70  private:
  71   enum { cache_size = 4 };
  72   PcDesc* _pc_descs[cache_size]; // last cache_size pc_descs found
  73  public:
  74   PcDescCache() { debug_only(_pc_descs[0] = NULL); }
  75   void    reset_to(PcDesc* initial_pc_desc);
  76   PcDesc* find_pc_desc(int pc_offset, bool approximate);
  77   void    add_pc_desc(PcDesc* pc_desc);
  78   PcDesc* last_pc_desc() { return _pc_descs[0]; }
  79 };
  80 
  81 
  82 // nmethods (native methods) are the compiled code versions of Java methods.
  83 //
  84 // An nmethod contains:
  85 //  - header                 (the nmethod structure)
  86 //  [Relocation]
  87 //  - relocation information
  88 //  - constant part          (doubles, longs and floats used in nmethod)
  89 //  - oop table
  90 //  [Code]
  91 //  - code body
  92 //  - exception handler
  93 //  - stub code
  94 //  [Debugging information]
  95 //  - oop array
  96 //  - data array
  97 //  - pcs
  98 //  [Exception handler table]
  99 //  - handler entry point array
 100 //  [Implicit Null Pointer exception table]
 101 //  - implicit null table array
 102 
 103 class Dependencies;
 104 class ExceptionHandlerTable;
 105 class ImplicitExceptionTable;
 106 class AbstractCompiler;
 107 class xmlStream;
 108 
 109 class nmethod : public CodeBlob {
 110   friend class VMStructs;
 111   friend class NMethodSweeper;
 112   friend class CodeCache;  // scavengable oops
 113  private:
 114   // Shared fields for all nmethod's
 115   Method*   _method;
 116   int       _entry_bci;        // != InvocationEntryBci if this nmethod is an on-stack replacement method
 117   jmethodID _jmethod_id;       // Cache of method()->jmethod_id()
 118 
 119   // To support simple linked-list chaining of nmethods:
 120   nmethod*  _osr_link;         // from InstanceKlass::osr_nmethods_head
 121   nmethod*  _scavenge_root_link; // from CodeCache::scavenge_root_nmethods
 122   nmethod*  _saved_nmethod_link; // from CodeCache::speculatively_disconnect
 123 
 124   static nmethod* volatile _oops_do_mark_nmethods;
 125   nmethod*        volatile _oops_do_mark_link;
 126 
 127   AbstractCompiler* _compiler; // The compiler which compiled this nmethod
 128 
 129   // offsets for entry points
 130   address _entry_point;                      // entry point with class check
 131   address _verified_entry_point;             // entry point without class check
 132   address _osr_entry_point;                  // entry point for on stack replacement
 133 
 134   // Offsets for different nmethod parts
 135   int _exception_offset;
 136   // All deoptee's will resume execution at this location described by
 137   // this offset.
 138   int _deoptimize_offset;
 139   // All deoptee's at a MethodHandle call site will resume execution
 140   // at this location described by this offset.
 141   int _deoptimize_mh_offset;
 142   // Offset of the unwind handler if it exists
 143   int _unwind_handler_offset;
 144 
 145 #ifdef HAVE_DTRACE_H
 146   int _trap_offset;
 147 #endif // def HAVE_DTRACE_H
 148   int _consts_offset;
 149   int _stub_offset;
 150   int _oops_offset;                       // offset to where embedded oop table begins (inside data)
 151   int _metadata_offset;                   // embedded meta data table
 152   int _scopes_data_offset;
 153   int _scopes_pcs_offset;
 154   int _dependencies_offset;
 155   int _handler_table_offset;
 156   int _nul_chk_table_offset;
 157   int _nmethod_end_offset;
 158 
 159   // location in frame (offset for sp) that deopt can store the original
 160   // pc during a deopt.
 161   int _orig_pc_offset;
 162 
 163   int _compile_id;                           // which compilation made this nmethod
 164   int _comp_level;                           // compilation level
 165 
 166   // protected by CodeCache_lock
 167   bool _has_flushed_dependencies;            // Used for maintenance of dependencies (CodeCache_lock)
 168   bool _speculatively_disconnected;          // Marked for potential unload
 169 
 170   bool _marked_for_reclamation;              // Used by NMethodSweeper (set only by sweeper)
 171   bool _marked_for_deoptimization;           // Used for stack deoptimization
 172 
 173   // used by jvmti to track if an unload event has been posted for this nmethod.
 174   bool _unload_reported;
 175 
 176   // set during construction
 177   unsigned int _has_unsafe_access:1;         // May fault due to unsafe access.
 178   unsigned int _has_method_handle_invokes:1; // Has this method MethodHandle invokes?
 179   unsigned int _lazy_critical_native:1;      // Lazy JNI critical native
 180   unsigned int _has_wide_vectors:1;          // Preserve wide vectors at safepoints
 181 
 182   // Protected by Patching_lock
 183   unsigned char _state;                      // {alive, not_entrant, zombie, unloaded}
 184 
 185 #ifdef ASSERT
 186   bool _oops_are_stale;  // indicates that it's no longer safe to access oops section
 187 #endif
 188 
 189   enum { alive        = 0,
 190          not_entrant  = 1, // uncommon trap has happened but activations may still exist
 191          zombie       = 2,
 192          unloaded     = 3 };
 193 
 194 
 195   jbyte _scavenge_root_state;
 196 
 197   // Nmethod Flushing lock. If non-zero, then the nmethod is not removed
 198   // and is not made into a zombie. However, once the nmethod is made into
 199   // a zombie, it will be locked one final time if CompiledMethodUnload
 200   // event processing needs to be done.
 201   jint  _lock_count;
 202 
 203   // not_entrant method removal. Each mark_sweep pass will update
 204   // this mark to current sweep invocation count if it is seen on the
 205   // stack.  An not_entrant method can be removed when there are no
 206   // more activations, i.e., when the _stack_traversal_mark is less than
 207   // current sweep traversal index.
 208   long _stack_traversal_mark;
 209 
 210   // The _hotness_counter indicates the hotness of a method. The higher
 211   // the value the hotter the method. The hotness counter of a nmethod is
 212   // set to 100 each time the method is active while stack scanning. The
 213   // hotness counter is decreased (by 1) while sweeping.
 214   int _hotness_counter;
 215 
 216   ExceptionCache *_exception_cache;
 217   PcDescCache     _pc_desc_cache;
 218 
 219   // These are used for compiled synchronized native methods to
 220   // locate the owner and stack slot for the BasicLock so that we can
 221   // properly revoke the bias of the owner if necessary. They are
 222   // needed because there is no debug information for compiled native
 223   // wrappers and the oop maps are insufficient to allow
 224   // frame::retrieve_receiver() to work. Currently they are expected
 225   // to be byte offsets from the Java stack pointer for maximum code
 226   // sharing between platforms. Note that currently biased locking
 227   // will never cause Class instances to be biased but this code
 228   // handles the static synchronized case as well.
 229   // JVMTI's GetLocalInstance() also uses these offsets to find the receiver
 230   // for non-static native wrapper frames.
 231   ByteSize _native_receiver_sp_offset;
 232   ByteSize _native_basic_lock_sp_offset;
 233 
 234   friend class nmethodLocker;
 235 
 236   // For native wrappers
 237   nmethod(Method* method,
 238           int nmethod_size,
 239           int compile_id,
 240           CodeOffsets* offsets,
 241           CodeBuffer *code_buffer,
 242           int frame_size,
 243           ByteSize basic_lock_owner_sp_offset, /* synchronized natives only */
 244           ByteSize basic_lock_sp_offset,       /* synchronized natives only */
 245           OopMapSet* oop_maps);
 246 
 247 #ifdef HAVE_DTRACE_H
 248   // For native wrappers
 249   nmethod(Method* method,
 250           int nmethod_size,
 251           CodeOffsets* offsets,
 252           CodeBuffer *code_buffer,
 253           int frame_size);
 254 #endif // def HAVE_DTRACE_H
 255 
 256   // Creation support
 257   nmethod(Method* method,
 258           int nmethod_size,
 259           int compile_id,
 260           int entry_bci,
 261           CodeOffsets* offsets,
 262           int orig_pc_offset,
 263           DebugInformationRecorder *recorder,
 264           Dependencies* dependencies,
 265           CodeBuffer *code_buffer,
 266           int frame_size,
 267           OopMapSet* oop_maps,
 268           ExceptionHandlerTable* handler_table,
 269           ImplicitExceptionTable* nul_chk_table,
 270           AbstractCompiler* compiler,
 271           int comp_level);
 272 
 273   // helper methods
 274   void* operator new(size_t size, int nmethod_size);
 275 
 276   const char* reloc_string_for(u_char* begin, u_char* end);
 277   // Returns true if this thread changed the state of the nmethod or
 278   // false if another thread performed the transition.
 279   bool make_not_entrant_or_zombie(unsigned int state);
 280   void inc_decompile_count();
 281 
 282   // Used to manipulate the exception cache
 283   void add_exception_cache_entry(ExceptionCache* new_entry);
 284   ExceptionCache* exception_cache_entry_for_exception(Handle exception);
 285 
 286   // Inform external interfaces that a compiled method has been unloaded
 287   void post_compiled_method_unload();
 288 
 289   // Initailize fields to their default values
 290   void init_defaults();
 291 
 292  public:
 293   // create nmethod with entry_bci
 294   static nmethod* new_nmethod(methodHandle method,
 295                               int compile_id,
 296                               int entry_bci,
 297                               CodeOffsets* offsets,
 298                               int orig_pc_offset,
 299                               DebugInformationRecorder* recorder,
 300                               Dependencies* dependencies,
 301                               CodeBuffer *code_buffer,
 302                               int frame_size,
 303                               OopMapSet* oop_maps,
 304                               ExceptionHandlerTable* handler_table,
 305                               ImplicitExceptionTable* nul_chk_table,
 306                               AbstractCompiler* compiler,
 307                               int comp_level);
 308 
 309   static nmethod* new_native_nmethod(methodHandle method,
 310                                      int compile_id,
 311                                      CodeBuffer *code_buffer,
 312                                      int vep_offset,
 313                                      int frame_complete,
 314                                      int frame_size,
 315                                      ByteSize receiver_sp_offset,
 316                                      ByteSize basic_lock_sp_offset,
 317                                      OopMapSet* oop_maps);
 318 
 319 #ifdef HAVE_DTRACE_H
 320   // The method we generate for a dtrace probe has to look
 321   // like an nmethod as far as the rest of the system is concerned
 322   // which is somewhat unfortunate.
 323   static nmethod* new_dtrace_nmethod(methodHandle method,
 324                                      CodeBuffer *code_buffer,
 325                                      int vep_offset,
 326                                      int trap_offset,
 327                                      int frame_complete,
 328                                      int frame_size);
 329 
 330   int trap_offset() const      { return _trap_offset; }
 331   address trap_address() const { return insts_begin() + _trap_offset; }
 332 
 333 #endif // def HAVE_DTRACE_H
 334 
 335   // accessors
 336   Method* method() const                          { return _method; }
 337   AbstractCompiler* compiler() const              { return _compiler; }
 338 
 339   // type info
 340   bool is_nmethod() const                         { return true; }
 341   bool is_java_method() const                     { return !method()->is_native(); }
 342   bool is_native_method() const                   { return method()->is_native(); }
 343   bool is_osr_method() const                      { return _entry_bci != InvocationEntryBci; }
 344 
 345   bool is_compiled_by_c1() const;
 346   bool is_compiled_by_c2() const;
 347   bool is_compiled_by_shark() const;
 348 
 349   // boundaries for different parts
 350   address consts_begin          () const          { return           header_begin() + _consts_offset        ; }
 351   address consts_end            () const          { return           header_begin() +  code_offset()        ; }
 352   address insts_begin           () const          { return           header_begin() +  code_offset()        ; }
 353   address insts_end             () const          { return           header_begin() + _stub_offset          ; }
 354   address stub_begin            () const          { return           header_begin() + _stub_offset          ; }
 355   address stub_end              () const          { return           header_begin() + _oops_offset          ; }
 356   address exception_begin       () const          { return           header_begin() + _exception_offset     ; }
 357   address deopt_handler_begin   () const          { return           header_begin() + _deoptimize_offset    ; }
 358   address deopt_mh_handler_begin() const          { return           header_begin() + _deoptimize_mh_offset ; }
 359   address unwind_handler_begin  () const          { return _unwind_handler_offset != -1 ? (header_begin() + _unwind_handler_offset) : NULL; }
 360   oop*    oops_begin            () const          { return (oop*)   (header_begin() + _oops_offset)         ; }
 361   oop*    oops_end              () const          { return (oop*)   (header_begin() + _metadata_offset)     ; }
 362 
 363   Metadata** metadata_begin   () const            { return (Metadata**)  (header_begin() + _metadata_offset)     ; }
 364   Metadata** metadata_end     () const            { return (Metadata**)  (header_begin() + _scopes_data_offset)  ; }
 365 
 366   address scopes_data_begin     () const          { return           header_begin() + _scopes_data_offset   ; }
 367   address scopes_data_end       () const          { return           header_begin() + _scopes_pcs_offset    ; }
 368   PcDesc* scopes_pcs_begin      () const          { return (PcDesc*)(header_begin() + _scopes_pcs_offset   ); }
 369   PcDesc* scopes_pcs_end        () const          { return (PcDesc*)(header_begin() + _dependencies_offset) ; }
 370   address dependencies_begin    () const          { return           header_begin() + _dependencies_offset  ; }
 371   address dependencies_end      () const          { return           header_begin() + _handler_table_offset ; }
 372   address handler_table_begin   () const          { return           header_begin() + _handler_table_offset ; }
 373   address handler_table_end     () const          { return           header_begin() + _nul_chk_table_offset ; }
 374   address nul_chk_table_begin   () const          { return           header_begin() + _nul_chk_table_offset ; }
 375   address nul_chk_table_end     () const          { return           header_begin() + _nmethod_end_offset   ; }
 376 
 377   // Sizes
 378   int consts_size       () const                  { return            consts_end       () -            consts_begin       (); }
 379   int insts_size        () const                  { return            insts_end        () -            insts_begin        (); }
 380   int stub_size         () const                  { return            stub_end         () -            stub_begin         (); }
 381   int oops_size         () const                  { return (address)  oops_end         () - (address)  oops_begin         (); }
 382   int metadata_size     () const                  { return (address)  metadata_end     () - (address)  metadata_begin     (); }
 383   int scopes_data_size  () const                  { return            scopes_data_end  () -            scopes_data_begin  (); }
 384   int scopes_pcs_size   () const                  { return (intptr_t) scopes_pcs_end   () - (intptr_t) scopes_pcs_begin   (); }
 385   int dependencies_size () const                  { return            dependencies_end () -            dependencies_begin (); }
 386   int handler_table_size() const                  { return            handler_table_end() -            handler_table_begin(); }
 387   int nul_chk_table_size() const                  { return            nul_chk_table_end() -            nul_chk_table_begin(); }
 388 
 389   int total_size        () const;
 390 
 391   // Hotness counter accessor methods
 392   void dec_hotness_counter(int val) { _hotness_counter-= val;  }
 393   void set_hotness_counter(int val) { _hotness_counter = val;  }
 394   int  get_hotness_counter() const  { return _hotness_counter; }
 395 
 396   // Containment
 397   bool consts_contains       (address addr) const { return consts_begin       () <= addr && addr < consts_end       (); }
 398   bool insts_contains        (address addr) const { return insts_begin        () <= addr && addr < insts_end        (); }
 399   bool stub_contains         (address addr) const { return stub_begin         () <= addr && addr < stub_end         (); }
 400   bool oops_contains         (oop*    addr) const { return oops_begin         () <= addr && addr < oops_end         (); }
 401   bool metadata_contains     (Metadata** addr) const   { return metadata_begin     () <= addr && addr < metadata_end     (); }
 402   bool scopes_data_contains  (address addr) const { return scopes_data_begin  () <= addr && addr < scopes_data_end  (); }
 403   bool scopes_pcs_contains   (PcDesc* addr) const { return scopes_pcs_begin   () <= addr && addr < scopes_pcs_end   (); }
 404   bool handler_table_contains(address addr) const { return handler_table_begin() <= addr && addr < handler_table_end(); }
 405   bool nul_chk_table_contains(address addr) const { return nul_chk_table_begin() <= addr && addr < nul_chk_table_end(); }
 406 
 407   // entry points
 408   address entry_point() const                     { return _entry_point;             } // normal entry point
 409   address verified_entry_point() const            { return _verified_entry_point;    } // if klass is correct
 410 
 411   // flag accessing and manipulation
 412   bool  is_in_use() const                         { return _state == alive; }
 413   bool  is_alive() const                          { return _state == alive || _state == not_entrant; }
 414   bool  is_not_entrant() const                    { return _state == not_entrant; }
 415   bool  is_zombie() const                         { return _state == zombie; }
 416   bool  is_unloaded() const                       { return _state == unloaded;   }
 417 
 418   // Make the nmethod non entrant. The nmethod will continue to be
 419   // alive.  It is used when an uncommon trap happens.  Returns true
 420   // if this thread changed the state of the nmethod or false if
 421   // another thread performed the transition.
 422   bool  make_not_entrant()                        { return make_not_entrant_or_zombie(not_entrant); }
 423   bool  make_zombie()                             { return make_not_entrant_or_zombie(zombie); }
 424 
 425   // used by jvmti to track if the unload event has been reported
 426   bool  unload_reported()                         { return _unload_reported; }
 427   void  set_unload_reported()                     { _unload_reported = true; }
 428 
 429   bool  is_marked_for_deoptimization() const      { return _marked_for_deoptimization; }
 430   void  mark_for_deoptimization()                 { _marked_for_deoptimization = true; }
 431 
 432   void  make_unloaded(BoolObjectClosure* is_alive, oop cause);
 433 
 434   bool has_dependencies()                         { return dependencies_size() != 0; }
 435   void flush_dependencies(BoolObjectClosure* is_alive);
 436   bool has_flushed_dependencies()                 { return _has_flushed_dependencies; }
 437   void set_has_flushed_dependencies()             {
 438     assert(!has_flushed_dependencies(), "should only happen once");
 439     _has_flushed_dependencies = 1;
 440   }
 441 
 442   bool  is_marked_for_reclamation() const         { return _marked_for_reclamation; }
 443   void  mark_for_reclamation()                    { _marked_for_reclamation = 1; }
 444 
 445   bool  has_unsafe_access() const                 { return _has_unsafe_access; }
 446   void  set_has_unsafe_access(bool z)             { _has_unsafe_access = z; }
 447 
 448   bool  has_method_handle_invokes() const         { return _has_method_handle_invokes; }
 449   void  set_has_method_handle_invokes(bool z)     { _has_method_handle_invokes = z; }
 450 
 451   bool  is_speculatively_disconnected() const     { return _speculatively_disconnected; }
 452   void  set_speculatively_disconnected(bool z)    { _speculatively_disconnected = z; }
 453 
 454   bool  is_lazy_critical_native() const           { return _lazy_critical_native; }
 455   void  set_lazy_critical_native(bool z)          { _lazy_critical_native = z; }
 456 
 457   bool  has_wide_vectors() const                  { return _has_wide_vectors; }
 458   void  set_has_wide_vectors(bool z)              { _has_wide_vectors = z; }
 459 
 460   int   comp_level() const                        { return _comp_level; }
 461 
 462   // Support for oops in scopes and relocs:
 463   // Note: index 0 is reserved for null.
 464   oop   oop_at(int index) const                   { return index == 0 ? (oop) NULL: *oop_addr_at(index); }
 465   oop*  oop_addr_at(int index) const {  // for GC
 466     // relocation indexes are biased by 1 (because 0 is reserved)
 467     assert(index > 0 && index <= oops_size(), "must be a valid non-zero index");
 468     assert(!_oops_are_stale, "oops are stale");
 469     return &oops_begin()[index - 1];
 470   }
 471 
 472   // Support for meta data in scopes and relocs:
 473   // Note: index 0 is reserved for null.
 474   Metadata*     metadata_at(int index) const      { return index == 0 ? NULL: *metadata_addr_at(index); }
 475   Metadata**  metadata_addr_at(int index) const {  // for GC
 476     // relocation indexes are biased by 1 (because 0 is reserved)
 477     assert(index > 0 && index <= metadata_size(), "must be a valid non-zero index");
 478     return &metadata_begin()[index - 1];
 479   }
 480 
 481   void copy_values(GrowableArray<jobject>* oops);
 482   void copy_values(GrowableArray<Metadata*>* metadata);
 483 
 484   // Relocation support
 485 private:
 486   void fix_oop_relocations(address begin, address end, bool initialize_immediates);
 487   inline void initialize_immediate_oop(oop* dest, jobject handle);
 488 
 489 public:
 490   void fix_oop_relocations(address begin, address end) { fix_oop_relocations(begin, end, false); }
 491   void fix_oop_relocations()                           { fix_oop_relocations(NULL, NULL, false); }
 492   void verify_oop_relocations();
 493 
 494   bool is_at_poll_return(address pc);
 495   bool is_at_poll_or_poll_return(address pc);
 496 
 497   // Scavengable oop support
 498   bool  on_scavenge_root_list() const                  { return (_scavenge_root_state & 1) != 0; }
 499  protected:
 500   enum { sl_on_list = 0x01, sl_marked = 0x10 };
 501   void  set_on_scavenge_root_list()                    { _scavenge_root_state = sl_on_list; }
 502   void  clear_on_scavenge_root_list()                  { _scavenge_root_state = 0; }
 503   // assertion-checking and pruning logic uses the bits of _scavenge_root_state
 504 #ifndef PRODUCT
 505   void  set_scavenge_root_marked()                     { _scavenge_root_state |= sl_marked; }
 506   void  clear_scavenge_root_marked()                   { _scavenge_root_state &= ~sl_marked; }
 507   bool  scavenge_root_not_marked()                     { return (_scavenge_root_state &~ sl_on_list) == 0; }
 508   // N.B. there is no positive marked query, and we only use the not_marked query for asserts.
 509 #endif //PRODUCT
 510   nmethod* scavenge_root_link() const                  { return _scavenge_root_link; }
 511   void     set_scavenge_root_link(nmethod *n)          { _scavenge_root_link = n; }
 512 
 513   nmethod* saved_nmethod_link() const                  { return _saved_nmethod_link; }
 514   void     set_saved_nmethod_link(nmethod *n)          { _saved_nmethod_link = n; }
 515 
 516  public:
 517 
 518   // Sweeper support
 519   long  stack_traversal_mark()                    { return _stack_traversal_mark; }
 520   void  set_stack_traversal_mark(long l)          { _stack_traversal_mark = l; }
 521 
 522   // Exception cache support
 523   ExceptionCache* exception_cache() const         { return _exception_cache; }
 524   void set_exception_cache(ExceptionCache *ec)    { _exception_cache = ec; }
 525   address handler_for_exception_and_pc(Handle exception, address pc);
 526   void add_handler_for_exception_and_pc(Handle exception, address pc, address handler);
 527   void remove_from_exception_cache(ExceptionCache* ec);
 528 
 529   // implicit exceptions support
 530   address continuation_for_implicit_exception(address pc);
 531 
 532   // On-stack replacement support
 533   int   osr_entry_bci() const                     { assert(is_osr_method(), "wrong kind of nmethod"); return _entry_bci; }
 534   address  osr_entry() const                      { assert(is_osr_method(), "wrong kind of nmethod"); return _osr_entry_point; }
 535   void  invalidate_osr_method();
 536   nmethod* osr_link() const                       { return _osr_link; }
 537   void     set_osr_link(nmethod *n)               { _osr_link = n; }
 538 
 539   // tells whether frames described by this nmethod can be deoptimized
 540   // note: native wrappers cannot be deoptimized.
 541   bool can_be_deoptimized() const { return is_java_method(); }
 542 
 543   // Inline cache support
 544   void clear_inline_caches();
 545   void cleanup_inline_caches();
 546   bool inlinecache_check_contains(address addr) const {
 547     return (addr >= code_begin() && addr < verified_entry_point());
 548   }
 549 
 550   // Check that all metadata is still alive
 551   void verify_metadata_loaders(address low_boundary, BoolObjectClosure* is_alive);
 552 
 553   // unlink and deallocate this nmethod
 554   // Only NMethodSweeper class is expected to use this. NMethodSweeper is not
 555   // expected to use any other private methods/data in this class.
 556 
 557  protected:
 558   void flush();
 559 
 560  public:
 561   // When true is returned, it is unsafe to remove this nmethod even if
 562   // it is a zombie, since the VM or the ServiceThread might still be
 563   // using it.
 564   bool is_locked_by_vm() const                    { return _lock_count >0; }
 565 
 566   // See comment at definition of _last_seen_on_stack
 567   void mark_as_seen_on_stack();
 568   bool can_not_entrant_be_converted();
 569 
 570   // Evolution support. We make old (discarded) compiled methods point to new Method*s.
 571   void set_method(Method* method) { _method = method; }
 572 
 573   // GC support
 574   void do_unloading(BoolObjectClosure* is_alive, bool unloading_occurred);
 575   bool can_unload(BoolObjectClosure* is_alive, oop* root, bool unloading_occurred);
 576 
 577   void preserve_callee_argument_oops(frame fr, const RegisterMap *reg_map,
 578                                      OopClosure* f);
 579   void oops_do(OopClosure* f) { oops_do(f, false); }
 580   void oops_do(OopClosure* f, bool do_strong_roots_only);
 581   bool detect_scavenge_root_oops();
 582   void verify_scavenge_root_oops() PRODUCT_RETURN;
 583 
 584   bool test_set_oops_do_mark();
 585   static void oops_do_marking_prologue();
 586   static void oops_do_marking_epilogue();
 587   static bool oops_do_marking_is_active() { return _oops_do_mark_nmethods != NULL; }
 588   bool test_oops_do_mark() { return _oops_do_mark_link != NULL; }
 589 
 590   // ScopeDesc for an instruction
 591   ScopeDesc* scope_desc_at(address pc);
 592 
 593  private:
 594   ScopeDesc* scope_desc_in(address begin, address end);
 595 
 596   address* orig_pc_addr(const frame* fr) { return (address*) ((address)fr->unextended_sp() + _orig_pc_offset); }
 597 
 598   PcDesc* find_pc_desc_internal(address pc, bool approximate);
 599 
 600   PcDesc* find_pc_desc(address pc, bool approximate) {
 601     PcDesc* desc = _pc_desc_cache.last_pc_desc();
 602     if (desc != NULL && desc->pc_offset() == pc - code_begin()) {
 603       return desc;
 604     }
 605     return find_pc_desc_internal(pc, approximate);
 606   }
 607 
 608  public:
 609   // ScopeDesc retrieval operation
 610   PcDesc* pc_desc_at(address pc)   { return find_pc_desc(pc, false); }
 611   // pc_desc_near returns the first PcDesc at or after the givne pc.
 612   PcDesc* pc_desc_near(address pc) { return find_pc_desc(pc, true); }
 613 
 614  public:
 615   // copying of debugging information
 616   void copy_scopes_pcs(PcDesc* pcs, int count);
 617   void copy_scopes_data(address buffer, int size);
 618 
 619   // Deopt
 620   // Return true is the PC is one would expect if the frame is being deopted.
 621   bool is_deopt_pc      (address pc) { return is_deopt_entry(pc) || is_deopt_mh_entry(pc); }
 622   bool is_deopt_entry   (address pc) { return pc == deopt_handler_begin(); }
 623   bool is_deopt_mh_entry(address pc) { return pc == deopt_mh_handler_begin(); }
 624   // Accessor/mutator for the original pc of a frame before a frame was deopted.
 625   address get_original_pc(const frame* fr) { return *orig_pc_addr(fr); }
 626   void    set_original_pc(const frame* fr, address pc) { *orig_pc_addr(fr) = pc; }
 627 
 628   static address get_deopt_original_pc(const frame* fr);
 629 
 630   // MethodHandle
 631   bool is_method_handle_return(address return_pc);
 632 
 633   // jvmti support:
 634   void post_compiled_method_load_event();
 635   jmethodID get_and_cache_jmethod_id();
 636 
 637   // verify operations
 638   void verify();
 639   void verify_scopes();
 640   void verify_interrupt_point(address interrupt_point);
 641 
 642   // printing support
 643   void print()                          const;
 644   void print_code();
 645   void print_relocations()                        PRODUCT_RETURN;
 646   void print_pcs()                                PRODUCT_RETURN;
 647   void print_scopes()                             PRODUCT_RETURN;
 648   void print_dependencies()                       PRODUCT_RETURN;
 649   void print_value_on(outputStream* st) const     PRODUCT_RETURN;
 650   void print_calls(outputStream* st)              PRODUCT_RETURN;
 651   void print_handler_table()                      PRODUCT_RETURN;
 652   void print_nul_chk_table()                      PRODUCT_RETURN;
 653   void print_nmethod(bool print_code);
 654 
 655   // need to re-define this from CodeBlob else the overload hides it
 656   virtual void print_on(outputStream* st) const { CodeBlob::print_on(st); }
 657   void print_on(outputStream* st, const char* msg) const;
 658 
 659   // Logging
 660   void log_identity(xmlStream* log) const;
 661   void log_new_nmethod() const;
 662   void log_state_change() const;
 663 
 664   // Prints block-level comments, including nmethod specific block labels:
 665   virtual void print_block_comment(outputStream* stream, address block_begin) const {
 666     print_nmethod_labels(stream, block_begin);
 667     CodeBlob::print_block_comment(stream, block_begin);
 668   }
 669   void print_nmethod_labels(outputStream* stream, address block_begin) const;
 670 
 671   // Prints a comment for one native instruction (reloc info, pc desc)
 672   void print_code_comment_on(outputStream* st, int column, address begin, address end);
 673   static void print_statistics()                  PRODUCT_RETURN;
 674 
 675   // Compiler task identification.  Note that all OSR methods
 676   // are numbered in an independent sequence if CICountOSR is true,
 677   // and native method wrappers are also numbered independently if
 678   // CICountNative is true.
 679   int  compile_id() const                         { return _compile_id; }
 680   const char* compile_kind() const;
 681 
 682   // For debugging
 683   // CompiledIC*    IC_at(char* p) const;
 684   // PrimitiveIC*   primitiveIC_at(char* p) const;
 685   oop embeddedOop_at(address p);
 686 
 687   // tells if any of this method's dependencies have been invalidated
 688   // (this is expensive!)
 689   bool check_all_dependencies();
 690 
 691   // tells if this compiled method is dependent on the given changes,
 692   // and the changes have invalidated it
 693   bool check_dependency_on(DepChange& changes);
 694 
 695   // Evolution support. Tells if this compiled method is dependent on any of
 696   // methods m() of class dependee, such that if m() in dependee is replaced,
 697   // this compiled method will have to be deoptimized.
 698   bool is_evol_dependent_on(Klass* dependee);
 699 
 700   // Fast breakpoint support. Tells if this compiled method is
 701   // dependent on the given method. Returns true if this nmethod
 702   // corresponds to the given method as well.
 703   bool is_dependent_on_method(Method* dependee);
 704 
 705   // is it ok to patch at address?
 706   bool is_patchable_at(address instr_address);
 707 
 708   // UseBiasedLocking support
 709   ByteSize native_receiver_sp_offset() {
 710     return _native_receiver_sp_offset;
 711   }
 712   ByteSize native_basic_lock_sp_offset() {
 713     return _native_basic_lock_sp_offset;
 714   }
 715 
 716   // support for code generation
 717   static int verified_entry_point_offset()        { return offset_of(nmethod, _verified_entry_point); }
 718   static int osr_entry_point_offset()             { return offset_of(nmethod, _osr_entry_point); }
 719   static int entry_bci_offset()                   { return offset_of(nmethod, _entry_bci); }
 720 
 721   // RedefineClasses support.   Mark metadata in nmethods as on_stack so that
 722   // redefine classes doesn't purge it.
 723   static void mark_on_stack(nmethod* nm) {
 724     nm->metadata_do(Metadata::mark_on_stack);
 725   }
 726   void metadata_do(void f(Metadata*));
 727 };
 728 
 729 // Locks an nmethod so its code will not get removed and it will not
 730 // be made into a zombie, even if it is a not_entrant method. After the
 731 // nmethod becomes a zombie, if CompiledMethodUnload event processing
 732 // needs to be done, then lock_nmethod() is used directly to keep the
 733 // generated code from being reused too early.
 734 class nmethodLocker : public StackObj {
 735   nmethod* _nm;
 736 
 737  public:
 738 
 739   // note: nm can be NULL
 740   // Only JvmtiDeferredEvent::compiled_method_unload_event()
 741   // should pass zombie_ok == true.
 742   static void lock_nmethod(nmethod* nm, bool zombie_ok = false);
 743   static void unlock_nmethod(nmethod* nm); // (ditto)
 744 
 745   nmethodLocker(address pc); // derive nm from pc
 746   nmethodLocker(nmethod *nm) { _nm = nm; lock_nmethod(_nm); }
 747   nmethodLocker() { _nm = NULL; }
 748   ~nmethodLocker() { unlock_nmethod(_nm); }
 749 
 750   nmethod* code() { return _nm; }
 751   void set_code(nmethod* new_nm) {
 752     unlock_nmethod(_nm);   // note:  This works even if _nm==new_nm.
 753     _nm = new_nm;
 754     lock_nmethod(_nm);
 755   }
 756 };
 757 
 758 #endif // SHARE_VM_CODE_NMETHOD_HPP