1 /*
2 * Copyright (c) 1997, 2023, 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 == nullptr: 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 nullptr 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 bool _is_unlinked;
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 int(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 and stack slot for the BasicLock. 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 ByteSize _native_basic_lock_sp_offset;
248
249 CompLevel _comp_level; // compilation level
250
251 // Local state used to keep track of whether unloading is happening or not
252 volatile uint8_t _is_unloading_state;
253
254 // protected by CodeCache_lock
255 bool _has_flushed_dependencies; // Used for maintenance of dependencies (CodeCache_lock)
256
257 // used by jvmti to track if an event has been posted for this nmethod.
258 bool _load_reported;
259
260 // Protected by CompiledMethod_lock
261 volatile signed char _state; // {not_installed, in_use, not_used, not_entrant}
262
263 int _skipped_instructions_size;
264
265 // For native wrappers
266 nmethod(Method* method,
267 CompilerType type,
268 int nmethod_size,
269 int compile_id,
270 CodeOffsets* offsets,
271 CodeBuffer *code_buffer,
272 int frame_size,
273 ByteSize basic_lock_owner_sp_offset, /* synchronized natives only */
274 ByteSize basic_lock_sp_offset, /* synchronized natives only */
275 OopMapSet* oop_maps);
276
277 // Creation support
278 nmethod(Method* method,
279 CompilerType type,
280 int nmethod_size,
281 int compile_id,
282 int entry_bci,
283 CodeOffsets* offsets,
284 int orig_pc_offset,
285 DebugInformationRecorder *recorder,
286 Dependencies* dependencies,
287 CodeBuffer *code_buffer,
288 int frame_size,
289 OopMapSet* oop_maps,
290 ExceptionHandlerTable* handler_table,
291 ImplicitExceptionTable* nul_chk_table,
292 AbstractCompiler* compiler,
293 CompLevel comp_level
294 #if INCLUDE_JVMCI
295 , char* speculations = nullptr,
296 int speculations_len = 0,
297 JVMCINMethodData* jvmci_data = nullptr
298 #endif
299 );
300
301 // helper methods
302 void* operator new(size_t size, int nmethod_size, int comp_level) throw();
303 // For method handle intrinsics: Try MethodNonProfiled, MethodProfiled and NonNMethod.
304 // Attention: Only allow NonNMethod space for special nmethods which don't need to be
305 // findable by nmethod iterators! In particular, they must not contain oops!
306 void* operator new(size_t size, int nmethod_size, bool allow_NonNMethod_space) throw();
307
308 const char* reloc_string_for(u_char* begin, u_char* end);
309
310 bool try_transition(signed char new_state);
311
312 // Returns true if this thread changed the state of the nmethod or
313 // false if another thread performed the transition.
314 bool make_entrant() { Unimplemented(); return false; }
315 void inc_decompile_count();
316
317 // Inform external interfaces that a compiled method has been unloaded
318 void post_compiled_method_unload();
319
320 // Initialize fields to their default values
321 void init_defaults();
322
323 // Offsets
324 int content_offset() const { return int(content_begin() - header_begin()); }
325 int data_offset() const { return _data_offset; }
326
327 address header_end() const { return (address) header_begin() + header_size(); }
328
329 public:
330 // create nmethod with entry_bci
331 static nmethod* new_nmethod(const methodHandle& method,
332 int compile_id,
333 int entry_bci,
334 CodeOffsets* offsets,
335 int orig_pc_offset,
336 DebugInformationRecorder* recorder,
337 Dependencies* dependencies,
338 CodeBuffer *code_buffer,
339 int frame_size,
340 OopMapSet* oop_maps,
341 ExceptionHandlerTable* handler_table,
342 ImplicitExceptionTable* nul_chk_table,
343 AbstractCompiler* compiler,
344 CompLevel comp_level
345 #if INCLUDE_JVMCI
346 , char* speculations = nullptr,
347 int speculations_len = 0,
348 JVMCINMethodData* jvmci_data = nullptr
349 #endif
350 );
351
352 // Only used for unit tests.
353 nmethod()
354 : CompiledMethod(),
355 _native_receiver_sp_offset(in_ByteSize(-1)),
356 _native_basic_lock_sp_offset(in_ByteSize(-1)),
357 _is_unloading_state(0) {}
358
359
360 static nmethod* new_native_nmethod(const methodHandle& method,
361 int compile_id,
362 CodeBuffer *code_buffer,
363 int vep_offset,
364 int frame_complete,
365 int frame_size,
366 ByteSize receiver_sp_offset,
367 ByteSize basic_lock_sp_offset,
368 OopMapSet* oop_maps,
369 int exception_handler = -1);
370
371 // type info
372 bool is_nmethod() const { return true; }
373 bool is_osr_method() const { return _entry_bci != InvocationEntryBci; }
374
375 // boundaries for different parts
376 address consts_begin () const { return header_begin() + _consts_offset ; }
377 address consts_end () const { return code_begin() ; }
378 address stub_begin () const { return header_begin() + _stub_offset ; }
379 address stub_end () const { return header_begin() + _oops_offset ; }
380 address exception_begin () const { return header_begin() + _exception_offset ; }
381 address unwind_handler_begin () const { return _unwind_handler_offset != -1 ? (header_begin() + _unwind_handler_offset) : nullptr; }
382 oop* oops_begin () const { return (oop*) (header_begin() + _oops_offset) ; }
383 oop* oops_end () const { return (oop*) (header_begin() + _metadata_offset) ; }
384
385 Metadata** metadata_begin () const { return (Metadata**) (header_begin() + _metadata_offset) ; }
386 Metadata** metadata_end () const { return (Metadata**) _scopes_data_begin; }
387
388 address scopes_data_end () const { return header_begin() + _scopes_pcs_offset ; }
389 PcDesc* scopes_pcs_begin () const { return (PcDesc*)(header_begin() + _scopes_pcs_offset ); }
390 PcDesc* scopes_pcs_end () const { return (PcDesc*)(header_begin() + _dependencies_offset) ; }
391 address dependencies_begin () const { return header_begin() + _dependencies_offset ; }
392 address dependencies_end () const { return header_begin() + _handler_table_offset ; }
393 address handler_table_begin () const { return header_begin() + _handler_table_offset ; }
394 address handler_table_end () const { return header_begin() + _nul_chk_table_offset ; }
395 address nul_chk_table_begin () const { return header_begin() + _nul_chk_table_offset ; }
396
397 int skipped_instructions_size () const { return _skipped_instructions_size ; }
398
399 #if INCLUDE_JVMCI
400 address nul_chk_table_end () const { return header_begin() + _speculations_offset ; }
401 address speculations_begin () const { return header_begin() + _speculations_offset ; }
402 address speculations_end () const { return header_begin() + _jvmci_data_offset ; }
403 address jvmci_data_begin () const { return header_begin() + _jvmci_data_offset ; }
404 address jvmci_data_end () const { return header_begin() + _nmethod_end_offset ; }
405 #else
406 address nul_chk_table_end () const { return header_begin() + _nmethod_end_offset ; }
407 #endif
408
409 // Sizes
410 int oops_size () const { return int((address) oops_end () - (address) oops_begin ()); }
411 int metadata_size () const { return int((address) metadata_end () - (address) metadata_begin ()); }
412 int dependencies_size () const { return int( dependencies_end () - dependencies_begin ()); }
413 #if INCLUDE_JVMCI
414 int speculations_size () const { return int( speculations_end () - speculations_begin ()); }
415 int jvmci_data_size () const { return int( jvmci_data_end () - jvmci_data_begin ()); }
416 #endif
417
418 int oops_count() const { assert(oops_size() % oopSize == 0, ""); return (oops_size() / oopSize) + 1; }
419 int metadata_count() const { assert(metadata_size() % wordSize == 0, ""); return (metadata_size() / wordSize) + 1; }
420
421 int total_size () const;
422
423 // Containment
424 bool oops_contains (oop* addr) const { return oops_begin () <= addr && addr < oops_end (); }
425 bool metadata_contains (Metadata** addr) const { return metadata_begin () <= addr && addr < metadata_end (); }
426 bool scopes_data_contains (address addr) const { return scopes_data_begin () <= addr && addr < scopes_data_end (); }
427 bool scopes_pcs_contains (PcDesc* addr) const { return scopes_pcs_begin () <= addr && addr < scopes_pcs_end (); }
428
429 // entry points
430 address entry_point() const { return _entry_point; } // normal entry point
431 address verified_entry_point() const { return _verified_entry_point; } // if klass is correct
432
433 // flag accessing and manipulation
434 bool is_not_installed() const { return _state == not_installed; }
435 bool is_in_use() const { return _state <= in_use; }
436 bool is_not_entrant() const { return _state == not_entrant; }
437
438 void clear_unloading_state();
439 // Heuristically deduce an nmethod isn't worth keeping around
440 bool is_cold();
441 virtual bool is_unloading();
442 virtual void do_unloading(bool unloading_occurred);
443
444 bool is_unlinked() const { return _is_unlinked; }
445 void set_is_unlinked() { assert(!_is_unlinked, "already unlinked"); _is_unlinked = true; }
446
447 #if INCLUDE_RTM_OPT
448 // rtm state accessing and manipulating
449 RTMState rtm_state() const { return _rtm_state; }
450 void set_rtm_state(RTMState state) { _rtm_state = state; }
451 #endif
452
453 bool make_in_use() {
454 return try_transition(in_use);
455 }
456 // Make the nmethod non entrant. The nmethod will continue to be
457 // alive. It is used when an uncommon trap happens. Returns true
458 // if this thread changed the state of the nmethod or false if
459 // another thread performed the transition.
460 bool make_not_entrant();
461 bool make_not_used() { return make_not_entrant(); }
462
463 int get_state() const {
464 return _state;
465 }
466
467 bool has_dependencies() { return dependencies_size() != 0; }
468 void print_dependencies_on(outputStream* out) PRODUCT_RETURN;
469 void flush_dependencies();
470 bool has_flushed_dependencies() { return _has_flushed_dependencies; }
471 void set_has_flushed_dependencies() {
472 assert(!has_flushed_dependencies(), "should only happen once");
473 _has_flushed_dependencies = 1;
474 }
475
476 int comp_level() const { return _comp_level; }
477
478 void unlink_from_method();
479
480 // Support for oops in scopes and relocs:
481 // Note: index 0 is reserved for null.
482 oop oop_at(int index) const;
483 oop oop_at_phantom(int index) const; // phantom reference
484 oop* oop_addr_at(int index) const { // for GC
485 // relocation indexes are biased by 1 (because 0 is reserved)
486 assert(index > 0 && index <= oops_count(), "must be a valid non-zero index");
487 return &oops_begin()[index - 1];
488 }
489
490 // Support for meta data in scopes and relocs:
491 // Note: index 0 is reserved for null.
492 Metadata* metadata_at(int index) const { return index == 0 ? nullptr: *metadata_addr_at(index); }
493 Metadata** metadata_addr_at(int index) const { // for GC
494 // relocation indexes are biased by 1 (because 0 is reserved)
495 assert(index > 0 && index <= metadata_count(), "must be a valid non-zero index");
496 return &metadata_begin()[index - 1];
497 }
498
499 void copy_values(GrowableArray<jobject>* oops);
500 void copy_values(GrowableArray<Metadata*>* metadata);
501
502 // Relocation support
503 private:
504 void fix_oop_relocations(address begin, address end, bool initialize_immediates);
505 inline void initialize_immediate_oop(oop* dest, jobject handle);
506
507 public:
508 void fix_oop_relocations(address begin, address end) { fix_oop_relocations(begin, end, false); }
509 void fix_oop_relocations() { fix_oop_relocations(nullptr, nullptr, false); }
510
511 // On-stack replacement support
512 int osr_entry_bci() const { assert(is_osr_method(), "wrong kind of nmethod"); return _entry_bci; }
513 address osr_entry() const { assert(is_osr_method(), "wrong kind of nmethod"); return _osr_entry_point; }
514 void invalidate_osr_method();
515 nmethod* osr_link() const { return _osr_link; }
516 void set_osr_link(nmethod *n) { _osr_link = n; }
517
518 // Verify calls to dead methods have been cleaned.
519 void verify_clean_inline_caches();
520
521 // Unlink this nmethod from the system
522 void unlink();
523
524 // Deallocate this nmethod - called by the GC
525 void purge(bool free_code_cache_data = true);
526
527 // See comment at definition of _last_seen_on_stack
528 void mark_as_maybe_on_stack();
529 bool is_maybe_on_stack();
530
531 // Evolution support. We make old (discarded) compiled methods point to new Method*s.
532 void set_method(Method* method) { _method = method; }
533
534 #if INCLUDE_JVMCI
535 // Gets the JVMCI name of this nmethod.
536 const char* jvmci_name();
537
538 // Records the pending failed speculation in the
539 // JVMCI speculation log associated with this nmethod.
540 void update_speculation(JavaThread* thread);
541
542 // Gets the data specific to a JVMCI compiled method.
543 // This returns a non-nullptr value iff this nmethod was
544 // compiled by the JVMCI compiler.
545 JVMCINMethodData* jvmci_nmethod_data() const {
546 return jvmci_data_size() == 0 ? nullptr : (JVMCINMethodData*) jvmci_data_begin();
547 }
548 #endif
549
550 public:
551 void oops_do(OopClosure* f) { oops_do(f, false); }
552 void oops_do(OopClosure* f, bool allow_dead);
553
554 // All-in-one claiming of nmethods: returns true if the caller successfully claimed that
555 // nmethod.
556 bool oops_do_try_claim();
557
558 // Loom support for following nmethods on the stack
559 void follow_nmethod(OopIterateClosure* cl);
560
561 // Class containing callbacks for the oops_do_process_weak/strong() methods
562 // below.
563 class OopsDoProcessor {
564 public:
565 // Process the oops of the given nmethod based on whether it has been called
566 // in a weak or strong processing context, i.e. apply either weak or strong
567 // work on it.
568 virtual void do_regular_processing(nmethod* nm) = 0;
569 // Assuming that the oops of the given nmethod has already been its weak
570 // processing applied, apply the remaining strong processing part.
571 virtual void do_remaining_strong_processing(nmethod* nm) = 0;
572 };
573
574 // The following two methods do the work corresponding to weak/strong nmethod
575 // processing.
576 void oops_do_process_weak(OopsDoProcessor* p);
577 void oops_do_process_strong(OopsDoProcessor* p);
578
579 static void oops_do_marking_prologue();
580 static void oops_do_marking_epilogue();
581
582 private:
583 ScopeDesc* scope_desc_in(address begin, address end);
584
585 address* orig_pc_addr(const frame* fr);
586
587 // used by jvmti to track if the load events has been reported
588 bool load_reported() const { return _load_reported; }
589 void set_load_reported() { _load_reported = true; }
590
591 public:
592 // copying of debugging information
593 void copy_scopes_pcs(PcDesc* pcs, int count);
594 void copy_scopes_data(address buffer, int size);
595
596 int orig_pc_offset() { return _orig_pc_offset; }
597
598 // Post successful compilation
599 void post_compiled_method(CompileTask* task);
600
601 // jvmti support:
602 void post_compiled_method_load_event(JvmtiThreadState* state = nullptr);
603
604 // verify operations
605 void verify();
606 void verify_scopes();
607 void verify_interrupt_point(address interrupt_point);
608
609 // Disassemble this nmethod with additional debug information, e.g. information about blocks.
610 void decode2(outputStream* st) const;
611 void print_constant_pool(outputStream* st);
612
613 // Avoid hiding of parent's 'decode(outputStream*)' method.
614 void decode(outputStream* st) const { decode2(st); } // just delegate here.
615
616 // printing support
617 void print() const;
618 void print(outputStream* st) const;
619 void print_code();
620
621 #if defined(SUPPORT_DATA_STRUCTS)
622 // print output in opt build for disassembler library
623 void print_relocations() PRODUCT_RETURN;
624 void print_pcs() { print_pcs_on(tty); }
625 void print_pcs_on(outputStream* st);
626 void print_scopes() { print_scopes_on(tty); }
627 void print_scopes_on(outputStream* st) PRODUCT_RETURN;
628 void print_value_on(outputStream* st) const;
629 void print_handler_table();
630 void print_nul_chk_table();
631 void print_recorded_oop(int log_n, int index);
632 void print_recorded_oops();
633 void print_recorded_metadata();
634
635 void print_oops(outputStream* st); // oops from the underlying CodeBlob.
636 void print_metadata(outputStream* st); // metadata in metadata pool.
637 #else
638 // void print_pcs() PRODUCT_RETURN;
639 void print_pcs() { return; }
640 #endif
641
642 void print_calls(outputStream* st) PRODUCT_RETURN;
643 static void print_statistics() PRODUCT_RETURN;
644
645 void maybe_print_nmethod(const DirectiveSet* directive);
646 void print_nmethod(bool print_code);
647
648 // need to re-define this from CodeBlob else the overload hides it
649 virtual void print_on(outputStream* st) const { CodeBlob::print_on(st); }
650 void print_on(outputStream* st, const char* msg) const;
651
652 // Logging
653 void log_identity(xmlStream* log) const;
654 void log_new_nmethod() const;
655 void log_state_change() const;
656
657 // Prints block-level comments, including nmethod specific block labels:
658 virtual void print_block_comment(outputStream* stream, address block_begin) const {
659 #if defined(SUPPORT_ASSEMBLY) || defined(SUPPORT_ABSTRACT_ASSEMBLY)
660 print_nmethod_labels(stream, block_begin);
661 CodeBlob::print_block_comment(stream, block_begin);
662 #endif
663 }
664
665 void print_nmethod_labels(outputStream* stream, address block_begin, bool print_section_labels=true) const;
666 const char* nmethod_section_label(address pos) const;
667
668 // returns whether this nmethod has code comments.
669 bool has_code_comment(address begin, address end);
670 // Prints a comment for one native instruction (reloc info, pc desc)
671 void print_code_comment_on(outputStream* st, int column, address begin, address end);
672
673 // Compiler task identification. Note that all OSR methods
674 // are numbered in an independent sequence if CICountOSR is true,
675 // and native method wrappers are also numbered independently if
676 // CICountNative is true.
677 virtual int compile_id() const { return _compile_id; }
678 const char* compile_kind() const;
679
680 // tells if this compiled method is dependent on the given changes,
681 // and the changes have invalidated it
682 bool check_dependency_on(DepChange& changes);
683
684 // Fast breakpoint support. Tells if this compiled method is
685 // dependent on the given method. Returns true if this nmethod
686 // corresponds to the given method as well.
687 virtual bool is_dependent_on_method(Method* dependee);
688
689 // JVMTI's GetLocalInstance() support
690 ByteSize native_receiver_sp_offset() {
691 return _native_receiver_sp_offset;
692 }
693 ByteSize native_basic_lock_sp_offset() {
694 return _native_basic_lock_sp_offset;
695 }
696
697 // support for code generation
698 static ByteSize verified_entry_point_offset() { return byte_offset_of(nmethod, _verified_entry_point); }
699 static ByteSize osr_entry_point_offset() { return byte_offset_of(nmethod, _osr_entry_point); }
700 static ByteSize state_offset() { return byte_offset_of(nmethod, _state); }
701
702 virtual void metadata_do(MetadataClosure* f);
703
704 NativeCallWrapper* call_wrapper_at(address call) const;
705 NativeCallWrapper* call_wrapper_before(address return_pc) const;
706 address call_instruction_address(address pc) const;
707
708 virtual CompiledStaticCall* compiledStaticCall_at(Relocation* call_site) const;
709 virtual CompiledStaticCall* compiledStaticCall_at(address addr) const;
710 virtual CompiledStaticCall* compiledStaticCall_before(address addr) const;
711
712 virtual void make_deoptimized();
713 void finalize_relocations();
714 };
715
716 #endif // SHARE_CODE_NMETHOD_HPP