1 /*
  2  * Copyright (c) 1997, 2022, 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_CODE_NMETHOD_HPP
 26 #define SHARE_CODE_NMETHOD_HPP
 27 
 28 #include "code/compiledMethod.hpp"
 29 
 30 class CompileTask;
 31 class DepChange;
 32 class DirectiveSet;
 33 class DebugInformationRecorder;
 34 class JvmtiThreadState;
 35 class OopIterateClosure;
 36 
 37 // nmethods (native methods) are the compiled code versions of Java methods.
 38 //
 39 // An nmethod contains:
 40 //  - header                 (the nmethod structure)
 41 //  [Relocation]
 42 //  - relocation information
 43 //  - constant part          (doubles, longs and floats used in nmethod)
 44 //  - oop table
 45 //  [Code]
 46 //  - code body
 47 //  - exception handler
 48 //  - stub code
 49 //  [Debugging information]
 50 //  - oop array
 51 //  - data array
 52 //  - pcs
 53 //  [Exception handler table]
 54 //  - handler entry point array
 55 //  [Implicit Null Pointer exception table]
 56 //  - implicit null table array
 57 //  [Speculations]
 58 //  - encoded speculations array
 59 //  [JVMCINMethodData]
 60 //  - meta data for JVMCI compiled nmethod
 61 
 62 #if INCLUDE_JVMCI
 63 class FailedSpeculation;
 64 class JVMCINMethodData;
 65 #endif
 66 
 67 class nmethod : public CompiledMethod {
 68   friend class VMStructs;
 69   friend class JVMCIVMStructs;
 70   friend class CodeCache;  // scavengable oops
 71   friend class JVMCINMethodData;
 72 
 73  private:
 74 
 75   uint64_t  _gc_epoch;
 76 
 77   // To support simple linked-list chaining of nmethods:
 78   nmethod*  _osr_link;         // from InstanceKlass::osr_nmethods_head
 79 
 80   // STW two-phase nmethod root processing helpers.
 81   //
 82   // When determining liveness of a given nmethod to do code cache unloading,
 83   // some collectors need to do different things depending on whether the nmethods
 84   // need to absolutely be kept alive during root processing; "strong"ly reachable
 85   // nmethods are known to be kept alive at root processing, but the liveness of
 86   // "weak"ly reachable ones is to be determined later.
 87   //
 88   // We want to allow strong and weak processing of nmethods by different threads
 89   // at the same time without heavy synchronization. Additional constraints are
 90   // to make sure that every nmethod is processed a minimal amount of time, and
 91   // nmethods themselves are always iterated at most once at a particular time.
 92   //
 93   // Note that strong processing work must be a superset of weak processing work
 94   // for this code to work.
 95   //
 96   // We store state and claim information in the _oops_do_mark_link member, using
 97   // the two LSBs for the state and the remaining upper bits for linking together
 98   // nmethods that were already visited.
 99   // The last element is self-looped, i.e. points to itself to avoid some special
100   // "end-of-list" sentinel value.
101   //
102   // _oops_do_mark_link special values:
103   //
104   //   _oops_do_mark_link == NULL: the nmethod has not been visited at all yet, i.e.
105   //      is Unclaimed.
106   //
107   // For other values, its lowest two bits indicate the following states of the nmethod:
108   //
109   //   weak_request (WR): the nmethod has been claimed by a thread for weak processing
110   //   weak_done (WD): weak processing has been completed for this nmethod.
111   //   strong_request (SR): the nmethod has been found to need strong processing while
112   //       being weak processed.
113   //   strong_done (SD): strong processing has been completed for this nmethod .
114   //
115   // The following shows the _only_ possible progressions of the _oops_do_mark_link
116   // pointer.
117   //
118   // Given
119   //   N as the nmethod
120   //   X the current next value of _oops_do_mark_link
121   //
122   // Unclaimed (C)-> N|WR (C)-> X|WD: the nmethod has been processed weakly by
123   //   a single thread.
124   // Unclaimed (C)-> N|WR (C)-> X|WD (O)-> X|SD: after weak processing has been
125   //   completed (as above) another thread found that the nmethod needs strong
126   //   processing after all.
127   // Unclaimed (C)-> N|WR (O)-> N|SR (C)-> X|SD: during weak processing another
128   //   thread finds that the nmethod needs strong processing, marks it as such and
129   //   terminates. The original thread completes strong processing.
130   // Unclaimed (C)-> N|SD (C)-> X|SD: the nmethod has been processed strongly from
131   //   the beginning by a single thread.
132   //
133   // "|" describes the concatenation of bits in _oops_do_mark_link.
134   //
135   // The diagram also describes the threads responsible for changing the nmethod to
136   // the next state by marking the _transition_ with (C) and (O), which mean "current"
137   // and "other" thread respectively.
138   //
139   struct oops_do_mark_link; // Opaque data type.
140 
141   // States used for claiming nmethods during root processing.
142   static const uint claim_weak_request_tag = 0;
143   static const uint claim_weak_done_tag = 1;
144   static const uint claim_strong_request_tag = 2;
145   static const uint claim_strong_done_tag = 3;
146 
147   static oops_do_mark_link* mark_link(nmethod* nm, uint tag) {
148     assert(tag <= claim_strong_done_tag, "invalid tag %u", tag);
149     assert(is_aligned(nm, 4), "nmethod pointer must have zero lower two LSB");
150     return (oops_do_mark_link*)(((uintptr_t)nm & ~0x3) | tag);
151   }
152 
153   static uint extract_state(oops_do_mark_link* link) {
154     return (uint)((uintptr_t)link & 0x3);
155   }
156 
157   static nmethod* extract_nmethod(oops_do_mark_link* link) {
158     return (nmethod*)((uintptr_t)link & ~0x3);
159   }
160 
161   void oops_do_log_change(const char* state);
162 
163   static bool oops_do_has_weak_request(oops_do_mark_link* next) {
164     return extract_state(next) == claim_weak_request_tag;
165   }
166 
167   static bool oops_do_has_any_strong_state(oops_do_mark_link* next) {
168     return extract_state(next) >= claim_strong_request_tag;
169   }
170 
171   // Attempt Unclaimed -> N|WR transition. Returns true if successful.
172   bool oops_do_try_claim_weak_request();
173 
174   // Attempt Unclaimed -> N|SD transition. Returns the current link.
175   oops_do_mark_link* oops_do_try_claim_strong_done();
176   // Attempt N|WR -> X|WD transition. Returns NULL if successful, X otherwise.
177   nmethod* oops_do_try_add_to_list_as_weak_done();
178 
179   // Attempt X|WD -> N|SR transition. Returns the current link.
180   oops_do_mark_link* oops_do_try_add_strong_request(oops_do_mark_link* next);
181   // Attempt X|WD -> X|SD transition. Returns true if successful.
182   bool oops_do_try_claim_weak_done_as_strong_done(oops_do_mark_link* next);
183 
184   // Do the N|SD -> X|SD transition.
185   void oops_do_add_to_list_as_strong_done();
186 
187   // Sets this nmethod as strongly claimed (as part of N|SD -> X|SD and N|SR -> X|SD
188   // transitions).
189   void oops_do_set_strong_done(nmethod* old_head);
190 
191   static nmethod* volatile _oops_do_mark_nmethods;
192   oops_do_mark_link* volatile _oops_do_mark_link;
193 
194   // offsets for entry points
195   address _entry_point;                      // entry point with class check
196   address _verified_entry_point;             // entry point without class check
197   address _osr_entry_point;                  // entry point for on stack replacement
198 
199   nmethod* _unlinked_next;
200 
201   // Shared fields for all nmethod's
202   int _entry_bci;      // != InvocationEntryBci if this nmethod is an on-stack replacement method
203 
204   // Offsets for different nmethod parts
205   int  _exception_offset;
206   // Offset of the unwind handler if it exists
207   int _unwind_handler_offset;
208 
209   int _consts_offset;
210   int _stub_offset;
211   int _oops_offset;                       // offset to where embedded oop table begins (inside data)
212   int _metadata_offset;                   // embedded meta data table
213   int _scopes_data_offset;
214   int _scopes_pcs_offset;
215   int _dependencies_offset;
216   int _handler_table_offset;
217   int _nul_chk_table_offset;
218 #if INCLUDE_JVMCI
219   int _speculations_offset;
220   int _jvmci_data_offset;
221 #endif
222   int _nmethod_end_offset;
223 
224   int code_offset() const { return (address) code_begin() - header_begin(); }
225 
226   // location in frame (offset for sp) that deopt can store the original
227   // pc during a deopt.
228   int _orig_pc_offset;
229 
230   int _compile_id;                           // which compilation made this nmethod
231 
232 #if INCLUDE_RTM_OPT
233   // RTM state at compile time. Used during deoptimization to decide
234   // whether to restart collecting RTM locking abort statistic again.
235   RTMState _rtm_state;
236 #endif
237 
238   // These are used for compiled synchronized native methods to
239   // locate the owner for the lock. They are
240   // needed because there is no debug information for compiled native
241   // wrappers and the oop maps are insufficient to allow
242   // frame::retrieve_receiver() to work. Currently they are expected
243   // to be byte offsets from the Java stack pointer for maximum code
244   // sharing between platforms. JVMTI's GetLocalInstance() uses these
245   // offsets to find the receiver for non-static native wrapper frames.
246   ByteSize _native_receiver_sp_offset;
247 
248   CompLevel _comp_level;               // compilation level
249 
250   // Local state used to keep track of whether unloading is happening or not
251   volatile uint8_t _is_unloading_state;
252 
253   // protected by CodeCache_lock
254   bool _has_flushed_dependencies;      // Used for maintenance of dependencies (CodeCache_lock)
255 
256   // used by jvmti to track if an event has been posted for this nmethod.
257   bool _load_reported;
258 
259   // Protected by CompiledMethod_lock
260   volatile signed char _state;         // {not_installed, in_use, not_used, not_entrant}
261 
262   // For native wrappers
263   nmethod(Method* method,
264           CompilerType type,
265           int nmethod_size,
266           int compile_id,
267           CodeOffsets* offsets,
268           CodeBuffer *code_buffer,
269           int frame_size,
270           ByteSize basic_lock_owner_sp_offset, /* synchronized natives only */
271           OopMapSet* oop_maps);
272 
273   // Creation support
274   nmethod(Method* method,
275           CompilerType type,
276           int nmethod_size,
277           int compile_id,
278           int entry_bci,
279           CodeOffsets* offsets,
280           int orig_pc_offset,
281           DebugInformationRecorder *recorder,
282           Dependencies* dependencies,
283           CodeBuffer *code_buffer,
284           int frame_size,
285           OopMapSet* oop_maps,
286           ExceptionHandlerTable* handler_table,
287           ImplicitExceptionTable* nul_chk_table,
288           AbstractCompiler* compiler,
289           CompLevel comp_level
290 #if INCLUDE_JVMCI
291           , char* speculations,
292           int speculations_len,
293           int jvmci_data_size
294 #endif
295           );
296 
297   // helper methods
298   void* operator new(size_t size, int nmethod_size, int comp_level) throw();
299 
300   const char* reloc_string_for(u_char* begin, u_char* end);
301 
302   bool try_transition(int new_state);
303 
304   // Returns true if this thread changed the state of the nmethod or
305   // false if another thread performed the transition.
306   bool make_entrant() { Unimplemented(); return false; }
307   void inc_decompile_count();
308 
309   // Inform external interfaces that a compiled method has been unloaded
310   void post_compiled_method_unload();
311 
312   // Initialize fields to their default values
313   void init_defaults();
314 
315   // Offsets
316   int content_offset() const                  { return content_begin() - header_begin(); }
317   int data_offset() const                     { return _data_offset; }
318 
319   address header_end() const                  { return (address)    header_begin() + header_size(); }
320 
321  public:
322   // create nmethod with entry_bci
323   static nmethod* new_nmethod(const methodHandle& method,
324                               int compile_id,
325                               int entry_bci,
326                               CodeOffsets* offsets,
327                               int orig_pc_offset,
328                               DebugInformationRecorder* recorder,
329                               Dependencies* dependencies,
330                               CodeBuffer *code_buffer,
331                               int frame_size,
332                               OopMapSet* oop_maps,
333                               ExceptionHandlerTable* handler_table,
334                               ImplicitExceptionTable* nul_chk_table,
335                               AbstractCompiler* compiler,
336                               CompLevel comp_level
337 #if INCLUDE_JVMCI
338                               , char* speculations = NULL,
339                               int speculations_len = 0,
340                               int nmethod_mirror_index = -1,
341                               const char* nmethod_mirror_name = NULL,
342                               FailedSpeculation** failed_speculations = NULL
343 #endif
344   );
345 
346   // Only used for unit tests.
347   nmethod()
348     : CompiledMethod(),
349       _native_receiver_sp_offset(in_ByteSize(-1)),
350       _is_unloading_state(0) {}
351 
352 
353   static nmethod* new_native_nmethod(const methodHandle& method,
354                                      int compile_id,
355                                      CodeBuffer *code_buffer,
356                                      int vep_offset,
357                                      int frame_complete,
358                                      int frame_size,
359                                      ByteSize receiver_sp_offset,
360                                      OopMapSet* oop_maps,
361                                      int exception_handler = -1);
362 
363   // type info
364   bool is_nmethod() const                         { return true; }
365   bool is_osr_method() const                      { return _entry_bci != InvocationEntryBci; }
366 
367   // boundaries for different parts
368   address consts_begin          () const          { return           header_begin() + _consts_offset        ; }
369   address consts_end            () const          { return           code_begin()                           ; }
370   address stub_begin            () const          { return           header_begin() + _stub_offset          ; }
371   address stub_end              () const          { return           header_begin() + _oops_offset          ; }
372   address exception_begin       () const          { return           header_begin() + _exception_offset     ; }
373   address unwind_handler_begin  () const          { return _unwind_handler_offset != -1 ? (header_begin() + _unwind_handler_offset) : NULL; }
374   oop*    oops_begin            () const          { return (oop*)   (header_begin() + _oops_offset)         ; }
375   oop*    oops_end              () const          { return (oop*)   (header_begin() + _metadata_offset)     ; }
376 
377   Metadata** metadata_begin   () const            { return (Metadata**)  (header_begin() + _metadata_offset)     ; }
378   Metadata** metadata_end     () const            { return (Metadata**)  _scopes_data_begin; }
379 
380   address scopes_data_end       () const          { return           header_begin() + _scopes_pcs_offset    ; }
381   PcDesc* scopes_pcs_begin      () const          { return (PcDesc*)(header_begin() + _scopes_pcs_offset   ); }
382   PcDesc* scopes_pcs_end        () const          { return (PcDesc*)(header_begin() + _dependencies_offset) ; }
383   address dependencies_begin    () const          { return           header_begin() + _dependencies_offset  ; }
384   address dependencies_end      () const          { return           header_begin() + _handler_table_offset ; }
385   address handler_table_begin   () const          { return           header_begin() + _handler_table_offset ; }
386   address handler_table_end     () const          { return           header_begin() + _nul_chk_table_offset ; }
387   address nul_chk_table_begin   () const          { return           header_begin() + _nul_chk_table_offset ; }
388 #if INCLUDE_JVMCI
389   address nul_chk_table_end     () const          { return           header_begin() + _speculations_offset  ; }
390   address speculations_begin    () const          { return           header_begin() + _speculations_offset  ; }
391   address speculations_end      () const          { return           header_begin() + _jvmci_data_offset   ; }
392   address jvmci_data_begin      () const          { return           header_begin() + _jvmci_data_offset    ; }
393   address jvmci_data_end        () const          { return           header_begin() + _nmethod_end_offset   ; }
394 #else
395   address nul_chk_table_end     () const          { return           header_begin() + _nmethod_end_offset   ; }
396 #endif
397 
398   // Sizes
399   int oops_size         () const                  { return (address)  oops_end         () - (address)  oops_begin         (); }
400   int metadata_size     () const                  { return (address)  metadata_end     () - (address)  metadata_begin     (); }
401   int dependencies_size () const                  { return            dependencies_end () -            dependencies_begin (); }
402 #if INCLUDE_JVMCI
403   int speculations_size () const                  { return            speculations_end () -            speculations_begin (); }
404   int jvmci_data_size   () const                  { return            jvmci_data_end   () -            jvmci_data_begin   (); }
405 #endif
406 
407   int     oops_count() const { assert(oops_size() % oopSize == 0, "");  return (oops_size() / oopSize) + 1; }
408   int metadata_count() const { assert(metadata_size() % wordSize == 0, ""); return (metadata_size() / wordSize) + 1; }
409 
410   int total_size        () const;
411 
412   // Containment
413   bool oops_contains         (oop*    addr) const { return oops_begin         () <= addr && addr < oops_end         (); }
414   bool metadata_contains     (Metadata** addr) const   { return metadata_begin     () <= addr && addr < metadata_end     (); }
415   bool scopes_data_contains  (address addr) const { return scopes_data_begin  () <= addr && addr < scopes_data_end  (); }
416   bool scopes_pcs_contains   (PcDesc* addr) const { return scopes_pcs_begin   () <= addr && addr < scopes_pcs_end   (); }
417 
418   // entry points
419   address entry_point() const                     { return _entry_point;             } // normal entry point
420   address verified_entry_point() const            { return _verified_entry_point;    } // if klass is correct
421 
422   // flag accessing and manipulation
423   bool  is_not_installed() const                  { return _state == not_installed; }
424   bool  is_in_use() const                         { return _state <= in_use; }
425   bool  is_not_entrant() const                    { return _state == not_entrant; }
426 
427   void clear_unloading_state();
428   // Heuristically deduce an nmethod isn't worth keeping around
429   bool is_cold();
430   virtual bool is_unloading();
431   virtual void do_unloading(bool unloading_occurred);
432 
433   nmethod* unlinked_next() const                  { return _unlinked_next; }
434   void set_unlinked_next(nmethod* next)           { _unlinked_next = next; }
435 
436 #if INCLUDE_RTM_OPT
437   // rtm state accessing and manipulating
438   RTMState  rtm_state() const                     { return _rtm_state; }
439   void set_rtm_state(RTMState state)              { _rtm_state = state; }
440 #endif
441 
442   bool make_in_use() {
443     return try_transition(in_use);
444   }
445   // Make the nmethod non entrant. The nmethod will continue to be
446   // alive.  It is used when an uncommon trap happens.  Returns true
447   // if this thread changed the state of the nmethod or false if
448   // another thread performed the transition.
449   bool  make_not_entrant();
450   bool  make_not_used()    { return make_not_entrant(); }
451 
452   int get_state() const {
453     return _state;
454   }
455 
456   bool has_dependencies()                         { return dependencies_size() != 0; }
457   void print_dependencies()                       PRODUCT_RETURN;
458   void flush_dependencies();
459   bool has_flushed_dependencies()                 { return _has_flushed_dependencies; }
460   void set_has_flushed_dependencies()             {
461     assert(!has_flushed_dependencies(), "should only happen once");
462     _has_flushed_dependencies = 1;
463   }
464 
465   int   comp_level() const                        { return _comp_level; }
466 
467   void unlink_from_method();
468 
469   // Support for oops in scopes and relocs:
470   // Note: index 0 is reserved for null.
471   oop   oop_at(int index) const;
472   oop   oop_at_phantom(int index) const; // phantom reference
473   oop*  oop_addr_at(int index) const {  // for GC
474     // relocation indexes are biased by 1 (because 0 is reserved)
475     assert(index > 0 && index <= oops_count(), "must be a valid non-zero index");
476     return &oops_begin()[index - 1];
477   }
478 
479   // Support for meta data in scopes and relocs:
480   // Note: index 0 is reserved for null.
481   Metadata*     metadata_at(int index) const      { return index == 0 ? NULL: *metadata_addr_at(index); }
482   Metadata**  metadata_addr_at(int index) const {  // for GC
483     // relocation indexes are biased by 1 (because 0 is reserved)
484     assert(index > 0 && index <= metadata_count(), "must be a valid non-zero index");
485     return &metadata_begin()[index - 1];
486   }
487 
488   void copy_values(GrowableArray<jobject>* oops);
489   void copy_values(GrowableArray<Metadata*>* metadata);
490 
491   // Relocation support
492 private:
493   void fix_oop_relocations(address begin, address end, bool initialize_immediates);
494   inline void initialize_immediate_oop(oop* dest, jobject handle);
495 
496 public:
497   void fix_oop_relocations(address begin, address end) { fix_oop_relocations(begin, end, false); }
498   void fix_oop_relocations()                           { fix_oop_relocations(NULL, NULL, false); }
499 
500   // On-stack replacement support
501   int   osr_entry_bci() const                     { assert(is_osr_method(), "wrong kind of nmethod"); return _entry_bci; }
502   address  osr_entry() const                      { assert(is_osr_method(), "wrong kind of nmethod"); return _osr_entry_point; }
503   void  invalidate_osr_method();
504   nmethod* osr_link() const                       { return _osr_link; }
505   void     set_osr_link(nmethod *n)               { _osr_link = n; }
506 
507   // Verify calls to dead methods have been cleaned.
508   void verify_clean_inline_caches();
509 
510   // Unlink this nmethod from the system
511   void unlink();
512 
513   // Deallocate this nmethod - called by the GC
514   void flush();
515 
516   // See comment at definition of _last_seen_on_stack
517   void mark_as_maybe_on_stack();
518   bool is_maybe_on_stack();
519 
520   // Evolution support. We make old (discarded) compiled methods point to new Method*s.
521   void set_method(Method* method) { _method = method; }
522 
523 #if INCLUDE_JVMCI
524   // Gets the JVMCI name of this nmethod.
525   const char* jvmci_name();
526 
527   // Records the pending failed speculation in the
528   // JVMCI speculation log associated with this nmethod.
529   void update_speculation(JavaThread* thread);
530 
531   // Gets the data specific to a JVMCI compiled method.
532   // This returns a non-NULL value iff this nmethod was
533   // compiled by the JVMCI compiler.
534   JVMCINMethodData* jvmci_nmethod_data() const {
535     return jvmci_data_size() == 0 ? NULL : (JVMCINMethodData*) jvmci_data_begin();
536   }
537 #endif
538 
539  public:
540   void oops_do(OopClosure* f) { oops_do(f, false); }
541   void oops_do(OopClosure* f, bool allow_dead);
542 
543   // All-in-one claiming of nmethods: returns true if the caller successfully claimed that
544   // nmethod.
545   bool oops_do_try_claim();
546 
547   // Loom support for following nmethods on the stack
548   void follow_nmethod(OopIterateClosure* cl);
549 
550   // Class containing callbacks for the oops_do_process_weak/strong() methods
551   // below.
552   class OopsDoProcessor {
553   public:
554     // Process the oops of the given nmethod based on whether it has been called
555     // in a weak or strong processing context, i.e. apply either weak or strong
556     // work on it.
557     virtual void do_regular_processing(nmethod* nm) = 0;
558     // Assuming that the oops of the given nmethod has already been its weak
559     // processing applied, apply the remaining strong processing part.
560     virtual void do_remaining_strong_processing(nmethod* nm) = 0;
561   };
562 
563   // The following two methods do the work corresponding to weak/strong nmethod
564   // processing.
565   void oops_do_process_weak(OopsDoProcessor* p);
566   void oops_do_process_strong(OopsDoProcessor* p);
567 
568   static void oops_do_marking_prologue();
569   static void oops_do_marking_epilogue();
570 
571  private:
572   ScopeDesc* scope_desc_in(address begin, address end);
573 
574   address* orig_pc_addr(const frame* fr);
575 
576   // used by jvmti to track if the load events has been reported
577   bool  load_reported() const                     { return _load_reported; }
578   void  set_load_reported()                       { _load_reported = true; }
579 
580  public:
581   // copying of debugging information
582   void copy_scopes_pcs(PcDesc* pcs, int count);
583   void copy_scopes_data(address buffer, int size);
584 
585   int orig_pc_offset() { return _orig_pc_offset; }
586 
587   // Post successful compilation
588   void post_compiled_method(CompileTask* task);
589 
590   // jvmti support:
591   void post_compiled_method_load_event(JvmtiThreadState* state = NULL);
592 
593   // verify operations
594   void verify();
595   void verify_scopes();
596   void verify_interrupt_point(address interrupt_point);
597 
598   // Disassemble this nmethod with additional debug information, e.g. information about blocks.
599   void decode2(outputStream* st) const;
600   void print_constant_pool(outputStream* st);
601 
602   // Avoid hiding of parent's 'decode(outputStream*)' method.
603   void decode(outputStream* st) const { decode2(st); } // just delegate here.
604 
605   // printing support
606   void print()                          const;
607   void print(outputStream* st)          const;
608   void print_code();
609 
610 #if defined(SUPPORT_DATA_STRUCTS)
611   // print output in opt build for disassembler library
612   void print_relocations()                        PRODUCT_RETURN;
613   void print_pcs() { print_pcs_on(tty); }
614   void print_pcs_on(outputStream* st);
615   void print_scopes() { print_scopes_on(tty); }
616   void print_scopes_on(outputStream* st)          PRODUCT_RETURN;
617   void print_value_on(outputStream* st) const;
618   void print_handler_table();
619   void print_nul_chk_table();
620   void print_recorded_oop(int log_n, int index);
621   void print_recorded_oops();
622   void print_recorded_metadata();
623 
624   void print_oops(outputStream* st);     // oops from the underlying CodeBlob.
625   void print_metadata(outputStream* st); // metadata in metadata pool.
626 #else
627   // void print_pcs()                             PRODUCT_RETURN;
628   void print_pcs()                                { return; }
629 #endif
630 
631   void print_calls(outputStream* st)              PRODUCT_RETURN;
632   static void print_statistics()                  PRODUCT_RETURN;
633 
634   void maybe_print_nmethod(const DirectiveSet* directive);
635   void print_nmethod(bool print_code);
636 
637   // need to re-define this from CodeBlob else the overload hides it
638   virtual void print_on(outputStream* st) const { CodeBlob::print_on(st); }
639   void print_on(outputStream* st, const char* msg) const;
640 
641   // Logging
642   void log_identity(xmlStream* log) const;
643   void log_new_nmethod() const;
644   void log_state_change() const;
645 
646   // Prints block-level comments, including nmethod specific block labels:
647   virtual void print_block_comment(outputStream* stream, address block_begin) const {
648 #if defined(SUPPORT_ASSEMBLY) || defined(SUPPORT_ABSTRACT_ASSEMBLY)
649     print_nmethod_labels(stream, block_begin);
650     CodeBlob::print_block_comment(stream, block_begin);
651 #endif
652   }
653 
654   void print_nmethod_labels(outputStream* stream, address block_begin, bool print_section_labels=true) const;
655   const char* nmethod_section_label(address pos) const;
656 
657   // returns whether this nmethod has code comments.
658   bool has_code_comment(address begin, address end);
659   // Prints a comment for one native instruction (reloc info, pc desc)
660   void print_code_comment_on(outputStream* st, int column, address begin, address end);
661 
662   // Compiler task identification.  Note that all OSR methods
663   // are numbered in an independent sequence if CICountOSR is true,
664   // and native method wrappers are also numbered independently if
665   // CICountNative is true.
666   virtual int compile_id() const { return _compile_id; }
667   const char* compile_kind() const;
668 
669   // tells if any of this method's dependencies have been invalidated
670   // (this is expensive!)
671   static void check_all_dependencies(DepChange& changes);
672 
673   // tells if this compiled method is dependent on the given changes,
674   // and the changes have invalidated it
675   bool check_dependency_on(DepChange& changes);
676 
677   // Fast breakpoint support. Tells if this compiled method is
678   // dependent on the given method. Returns true if this nmethod
679   // corresponds to the given method as well.
680   virtual bool is_dependent_on_method(Method* dependee);
681 
682   // JVMTI's GetLocalInstance() support
683   ByteSize native_receiver_sp_offset() {
684     return _native_receiver_sp_offset;
685   }
686 
687   // support for code generation
688   static int verified_entry_point_offset()        { return offset_of(nmethod, _verified_entry_point); }
689   static int osr_entry_point_offset()             { return offset_of(nmethod, _osr_entry_point); }
690   static int state_offset()                       { return offset_of(nmethod, _state); }
691 
692   virtual void metadata_do(MetadataClosure* f);
693 
694   NativeCallWrapper* call_wrapper_at(address call) const;
695   NativeCallWrapper* call_wrapper_before(address return_pc) const;
696   address call_instruction_address(address pc) const;
697 
698   virtual CompiledStaticCall* compiledStaticCall_at(Relocation* call_site) const;
699   virtual CompiledStaticCall* compiledStaticCall_at(address addr) const;
700   virtual CompiledStaticCall* compiledStaticCall_before(address addr) const;
701 
702   virtual void  make_deoptimized();
703   void finalize_relocations();
704 };
705 
706 #endif // SHARE_CODE_NMETHOD_HPP