1 /*
2 * Copyright (c) 1997, 2025, 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/codeBlob.hpp"
29 #include "code/pcDesc.hpp"
30 #include "oops/metadata.hpp"
31 #include "oops/method.hpp"
32
33 class AbstractCompiler;
34 class CompiledDirectCall;
35 class CompiledIC;
36 class CompiledICData;
37 class CompileTask;
38 class DepChange;
39 class Dependencies;
40 class DirectiveSet;
41 class DebugInformationRecorder;
42 class ExceptionHandlerTable;
43 class ImplicitExceptionTable;
44 class JvmtiThreadState;
45 class MetadataClosure;
46 class NativeCallWrapper;
47 class OopIterateClosure;
48 class AOTCodeReader;
49 class AOTCodeEntry;
50 class ScopeDesc;
51 class xmlStream;
52
53 // This class is used internally by nmethods, to cache
54 // exception/pc/handler information.
55
56 class ExceptionCache : public CHeapObj<mtCode> {
57 friend class VMStructs;
58 private:
59 enum { cache_size = 16 };
60 Klass* _exception_type;
61 address _pc[cache_size];
62 address _handler[cache_size];
63 volatile int _count;
64 ExceptionCache* volatile _next;
65 ExceptionCache* _purge_list_next;
66
67 inline address pc_at(int index);
68 void set_pc_at(int index, address a) { assert(index >= 0 && index < cache_size,""); _pc[index] = a; }
69
70 inline address handler_at(int index);
71 void set_handler_at(int index, address a) { assert(index >= 0 && index < cache_size,""); _handler[index] = a; }
72
73 inline int count();
74 // increment_count is only called under lock, but there may be concurrent readers.
75 void increment_count();
76
77 public:
78
79 ExceptionCache(Handle exception, address pc, address handler);
80
81 Klass* exception_type() { return _exception_type; }
82 ExceptionCache* next();
83 void set_next(ExceptionCache *ec);
84 ExceptionCache* purge_list_next() { return _purge_list_next; }
85 void set_purge_list_next(ExceptionCache *ec) { _purge_list_next = ec; }
86
87 address match(Handle exception, address pc);
88 bool match_exception_with_space(Handle exception) ;
89 address test_address(address addr);
90 bool add_address_and_handler(address addr, address handler) ;
91 };
92
93 // cache pc descs found in earlier inquiries
94 class PcDescCache {
95 friend class VMStructs;
96 private:
97 enum { cache_size = 4 };
98 // The array elements MUST be volatile! Several threads may modify
99 // and read from the cache concurrently. find_pc_desc_internal has
100 // returned wrong results. C++ compiler (namely xlC12) may duplicate
101 // C++ field accesses if the elements are not volatile.
102 typedef PcDesc* PcDescPtr;
103 volatile PcDescPtr _pc_descs[cache_size]; // last cache_size pc_descs found
104 public:
105 PcDescCache() { DEBUG_ONLY(_pc_descs[0] = nullptr); }
106 void init_to(PcDesc* initial_pc_desc);
107 PcDesc* find_pc_desc(int pc_offset, bool approximate);
108 void add_pc_desc(PcDesc* pc_desc);
109 PcDesc* last_pc_desc() { return _pc_descs[0]; }
110 };
111
112 class PcDescContainer : public CHeapObj<mtCode> {
113 private:
114 PcDescCache _pc_desc_cache;
115 public:
116 PcDescContainer(PcDesc* initial_pc_desc) { _pc_desc_cache.init_to(initial_pc_desc); }
117
118 PcDesc* find_pc_desc_internal(address pc, bool approximate, address code_begin,
119 PcDesc* lower, PcDesc* upper);
120
121 PcDesc* find_pc_desc(address pc, bool approximate, address code_begin, PcDesc* lower, PcDesc* upper)
122 #ifdef PRODUCT
123 {
124 PcDesc* desc = _pc_desc_cache.last_pc_desc();
125 assert(desc != nullptr, "PcDesc cache should be initialized already");
126 if (desc->pc_offset() == (pc - code_begin)) {
127 // Cached value matched
128 return desc;
129 }
130 return find_pc_desc_internal(pc, approximate, code_begin, lower, upper);
131 }
132 #endif
133 ;
134 };
135
136 // nmethods (native methods) are the compiled code versions of Java methods.
137 //
138 // An nmethod contains:
139 // - Header (the nmethod structure)
140 // - Constant part (doubles, longs and floats used in nmethod)
141 // - Code part:
142 // - Code body
143 // - Exception handler
144 // - Stub code
145 // - OOP table
146 //
147 // As a CodeBlob, an nmethod references [mutable data] allocated on the C heap:
148 // - CodeBlob relocation data
149 // - Metainfo
150 // - JVMCI data
151 //
152 // An nmethod references [immutable data] allocated on C heap:
153 // - Dependency assertions data
154 // - Implicit null table array
155 // - Handler entry point array
156 // - Debugging information:
157 // - Scopes data array
158 // - Scopes pcs array
159 // - JVMCI speculations array
160
161 #if INCLUDE_JVMCI
162 class FailedSpeculation;
163 class JVMCINMethodData;
164 #endif
165
166 class nmethod : public CodeBlob {
167 friend class VMStructs;
168 friend class JVMCIVMStructs;
169 friend class CodeCache; // scavengable oops
170 friend class JVMCINMethodData;
171 friend class DeoptimizationScope;
172
173 private:
174
175 // Used to track in which deoptimize handshake this method will be deoptimized.
176 uint64_t _deoptimization_generation;
177
178 uint64_t _gc_epoch;
179
180 // Profiling counter used to figure out the hottest nmethods to record into CDS
181 volatile uint64_t _method_profiling_count;
182
183 Method* _method;
184
185 // To reduce header size union fields which usages do not overlap.
186 union {
187 // To support simple linked-list chaining of nmethods:
188 nmethod* _osr_link; // from InstanceKlass::osr_nmethods_head
189 struct {
190 // These are used for compiled synchronized native methods to
191 // locate the owner and stack slot for the BasicLock. They are
192 // needed because there is no debug information for compiled native
193 // wrappers and the oop maps are insufficient to allow
194 // frame::retrieve_receiver() to work. Currently they are expected
195 // to be byte offsets from the Java stack pointer for maximum code
196 // sharing between platforms. JVMTI's GetLocalInstance() uses these
197 // offsets to find the receiver for non-static native wrapper frames.
198 ByteSize _native_receiver_sp_offset;
199 ByteSize _native_basic_lock_sp_offset;
200 };
201 };
202
203 // nmethod's read-only data
204 address _immutable_data;
205
206 PcDescContainer* _pc_desc_container;
207 ExceptionCache* volatile _exception_cache;
208
209 void* _gc_data;
210
211 struct oops_do_mark_link; // Opaque data type.
212 static nmethod* volatile _oops_do_mark_nmethods;
213 oops_do_mark_link* volatile _oops_do_mark_link;
214
215 CompiledICData* _compiled_ic_data;
216
217 // offsets for entry points
218 address _osr_entry_point; // entry point for on stack replacement
219 uint16_t _entry_offset; // entry point with class check
220 uint16_t _verified_entry_offset; // entry point without class check
221 int _entry_bci; // != InvocationEntryBci if this nmethod is an on-stack replacement method
222 int _immutable_data_size;
223
224 // _consts_offset == _content_offset because SECT_CONSTS is first in code buffer
225
226 int _skipped_instructions_size;
227
228 int _stub_offset;
229
230 // Offsets for different stubs section parts
231 int _exception_offset;
232 // All deoptee's will resume execution at this location described by
233 // this offset.
234 int _deopt_handler_offset;
235 // All deoptee's at a MethodHandle call site will resume execution
236 // at this location described by this offset.
237 int _deopt_mh_handler_offset;
238 // Offset (from insts_end) of the unwind handler if it exists
239 int16_t _unwind_handler_offset;
240 // Number of arguments passed on the stack
241 uint16_t _num_stack_arg_slots;
242
243 uint16_t _oops_size;
244 #if INCLUDE_JVMCI
245 // _metadata_size is not specific to JVMCI. In the non-JVMCI case, it can be derived as:
246 // _metadata_size = mutable_data_size - relocation_size
247 uint16_t _metadata_size;
248 #endif
249
250 // Offset in immutable data section
251 // _dependencies_offset == 0
252 uint16_t _nul_chk_table_offset;
253 uint16_t _handler_table_offset; // This table could be big in C1 code
254 int _scopes_pcs_offset;
255 int _scopes_data_offset;
256 #if INCLUDE_JVMCI
257 int _speculations_offset;
258 #endif
259
260 // location in frame (offset for sp) that deopt can store the original
261 // pc during a deopt.
262 int _orig_pc_offset;
263
264 int _compile_id; // which compilation made this nmethod
265 CompLevel _comp_level; // compilation level (s1)
266 CompilerType _compiler_type; // which compiler made this nmethod (u1)
267
268 AOTCodeEntry* _aot_code_entry;
269
270 bool _used; // has this nmethod ever been invoked?
271
272 // Local state used to keep track of whether unloading is happening or not
273 volatile uint8_t _is_unloading_state;
274
275 // Protected by NMethodState_lock
276 volatile signed char _state; // {not_installed, in_use, not_entrant}
277
278 // set during construction
279 uint8_t _has_unsafe_access:1, // May fault due to unsafe access.
280 _has_method_handle_invokes:1,// Has this method MethodHandle invokes?
281 _has_wide_vectors:1, // Preserve wide vectors at safepoints
282 _has_monitors:1, // Fastpath monitor detection for continuations
283 _has_scoped_access:1, // used by for shared scope closure (scopedMemoryAccess.cpp)
284 _has_flushed_dependencies:1, // Used for maintenance of dependencies (under CodeCache_lock)
285 _is_unlinked:1, // mark during class unloading
286 _load_reported:1, // used by jvmti to track if an event has been posted for this nmethod
287 _preloaded:1,
288 _has_clinit_barriers:1;
289
290 enum DeoptimizationStatus : u1 {
291 not_marked,
292 deoptimize,
293 deoptimize_noupdate,
294 deoptimize_done
295 };
296
297 volatile DeoptimizationStatus _deoptimization_status; // Used for stack deoptimization
298
299 DeoptimizationStatus deoptimization_status() const {
300 return Atomic::load(&_deoptimization_status);
301 }
302
303 // Initialize fields to their default values
304 void init_defaults(CodeBuffer *code_buffer, CodeOffsets* offsets);
305
306 // Post initialization
307 void post_init();
308
309 // For native wrappers
310 nmethod(Method* method,
311 CompilerType type,
312 int nmethod_size,
313 int compile_id,
314 CodeOffsets* offsets,
315 CodeBuffer *code_buffer,
316 int frame_size,
317 ByteSize basic_lock_owner_sp_offset, /* synchronized natives only */
318 ByteSize basic_lock_sp_offset, /* synchronized natives only */
319 OopMapSet* oop_maps,
320 int mutable_data_size);
321
322 // For normal JIT compiled code
323 nmethod(Method* method,
324 CompilerType type,
325 int nmethod_size,
326 int immutable_data_size,
327 int mutable_data_size,
328 int compile_id,
329 int entry_bci,
330 address immutable_data,
331 CodeOffsets* offsets,
332 int orig_pc_offset,
333 DebugInformationRecorder *recorder,
334 Dependencies* dependencies,
335 CodeBuffer *code_buffer,
336 int frame_size,
337 OopMapSet* oop_maps,
338 ExceptionHandlerTable* handler_table,
339 ImplicitExceptionTable* nul_chk_table,
340 AbstractCompiler* compiler,
341 CompLevel comp_level
342 , AOTCodeEntry* aot_code_entry
343 #if INCLUDE_JVMCI
344 , char* speculations = nullptr,
345 int speculations_len = 0,
346 JVMCINMethodData* jvmci_data = nullptr
347 #endif
348 );
349
350 // helper methods
351 void* operator new(size_t size, int nmethod_size, int comp_level) throw();
352
353 // For method handle intrinsics: Try MethodNonProfiled, MethodProfiled and NonNMethod.
354 // Attention: Only allow NonNMethod space for special nmethods which don't need to be
355 // findable by nmethod iterators! In particular, they must not contain oops!
356 void* operator new(size_t size, int nmethod_size, bool allow_NonNMethod_space) throw();
357
358 const char* reloc_string_for(u_char* begin, u_char* end);
359
360 bool try_transition(signed char new_state);
361
362 // Returns true if this thread changed the state of the nmethod or
363 // false if another thread performed the transition.
364 bool make_entrant() { Unimplemented(); return false; }
365 void inc_decompile_count();
366
367 // Inform external interfaces that a compiled method has been unloaded
368 void post_compiled_method_unload();
369
370 PcDesc* find_pc_desc(address pc, bool approximate) {
371 if (_pc_desc_container == nullptr) return nullptr; // native method
372 return _pc_desc_container->find_pc_desc(pc, approximate, code_begin(), scopes_pcs_begin(), scopes_pcs_end());
373 }
374
375 // STW two-phase nmethod root processing helpers.
376 //
377 // When determining liveness of a given nmethod to do code cache unloading,
378 // some collectors need to do different things depending on whether the nmethods
379 // need to absolutely be kept alive during root processing; "strong"ly reachable
380 // nmethods are known to be kept alive at root processing, but the liveness of
381 // "weak"ly reachable ones is to be determined later.
382 //
383 // We want to allow strong and weak processing of nmethods by different threads
384 // at the same time without heavy synchronization. Additional constraints are
385 // to make sure that every nmethod is processed a minimal amount of time, and
386 // nmethods themselves are always iterated at most once at a particular time.
387 //
388 // Note that strong processing work must be a superset of weak processing work
389 // for this code to work.
390 //
391 // We store state and claim information in the _oops_do_mark_link member, using
392 // the two LSBs for the state and the remaining upper bits for linking together
393 // nmethods that were already visited.
394 // The last element is self-looped, i.e. points to itself to avoid some special
395 // "end-of-list" sentinel value.
396 //
397 // _oops_do_mark_link special values:
398 //
399 // _oops_do_mark_link == nullptr: the nmethod has not been visited at all yet, i.e.
400 // is Unclaimed.
401 //
402 // For other values, its lowest two bits indicate the following states of the nmethod:
403 //
404 // weak_request (WR): the nmethod has been claimed by a thread for weak processing
405 // weak_done (WD): weak processing has been completed for this nmethod.
406 // strong_request (SR): the nmethod has been found to need strong processing while
407 // being weak processed.
408 // strong_done (SD): strong processing has been completed for this nmethod .
409 //
410 // The following shows the _only_ possible progressions of the _oops_do_mark_link
411 // pointer.
412 //
413 // Given
414 // N as the nmethod
415 // X the current next value of _oops_do_mark_link
416 //
417 // Unclaimed (C)-> N|WR (C)-> X|WD: the nmethod has been processed weakly by
418 // a single thread.
419 // Unclaimed (C)-> N|WR (C)-> X|WD (O)-> X|SD: after weak processing has been
420 // completed (as above) another thread found that the nmethod needs strong
421 // processing after all.
422 // Unclaimed (C)-> N|WR (O)-> N|SR (C)-> X|SD: during weak processing another
423 // thread finds that the nmethod needs strong processing, marks it as such and
424 // terminates. The original thread completes strong processing.
425 // Unclaimed (C)-> N|SD (C)-> X|SD: the nmethod has been processed strongly from
426 // the beginning by a single thread.
427 //
428 // "|" describes the concatenation of bits in _oops_do_mark_link.
429 //
430 // The diagram also describes the threads responsible for changing the nmethod to
431 // the next state by marking the _transition_ with (C) and (O), which mean "current"
432 // and "other" thread respectively.
433 //
434
435 // States used for claiming nmethods during root processing.
436 static const uint claim_weak_request_tag = 0;
437 static const uint claim_weak_done_tag = 1;
438 static const uint claim_strong_request_tag = 2;
439 static const uint claim_strong_done_tag = 3;
440
441 static oops_do_mark_link* mark_link(nmethod* nm, uint tag) {
442 assert(tag <= claim_strong_done_tag, "invalid tag %u", tag);
443 assert(is_aligned(nm, 4), "nmethod pointer must have zero lower two LSB");
444 return (oops_do_mark_link*)(((uintptr_t)nm & ~0x3) | tag);
445 }
446
447 static uint extract_state(oops_do_mark_link* link) {
448 return (uint)((uintptr_t)link & 0x3);
449 }
450
451 static nmethod* extract_nmethod(oops_do_mark_link* link) {
452 return (nmethod*)((uintptr_t)link & ~0x3);
453 }
454
455 void oops_do_log_change(const char* state);
456
457 static bool oops_do_has_weak_request(oops_do_mark_link* next) {
458 return extract_state(next) == claim_weak_request_tag;
459 }
460
461 static bool oops_do_has_any_strong_state(oops_do_mark_link* next) {
462 return extract_state(next) >= claim_strong_request_tag;
463 }
464
465 // Attempt Unclaimed -> N|WR transition. Returns true if successful.
466 bool oops_do_try_claim_weak_request();
467
468 // Attempt Unclaimed -> N|SD transition. Returns the current link.
469 oops_do_mark_link* oops_do_try_claim_strong_done();
470 // Attempt N|WR -> X|WD transition. Returns nullptr if successful, X otherwise.
471 nmethod* oops_do_try_add_to_list_as_weak_done();
472
473 // Attempt X|WD -> N|SR transition. Returns the current link.
474 oops_do_mark_link* oops_do_try_add_strong_request(oops_do_mark_link* next);
475 // Attempt X|WD -> X|SD transition. Returns true if successful.
476 bool oops_do_try_claim_weak_done_as_strong_done(oops_do_mark_link* next);
477
478 // Do the N|SD -> X|SD transition.
479 void oops_do_add_to_list_as_strong_done();
480
481 // Sets this nmethod as strongly claimed (as part of N|SD -> X|SD and N|SR -> X|SD
482 // transitions).
483 void oops_do_set_strong_done(nmethod* old_head);
484
485 void record_nmethod_dependency();
486
487 nmethod* restore(address code_cache_buffer,
488 const methodHandle& method,
489 int compile_id,
490 address reloc_data,
491 GrowableArray<Handle>& oop_list,
492 GrowableArray<Metadata*>& metadata_list,
493 ImmutableOopMapSet* oop_maps,
494 address immutable_data,
495 GrowableArray<Handle>& reloc_imm_oop_list,
496 GrowableArray<Metadata*>& reloc_imm_metadata_list,
497 AOTCodeReader* aot_code_reader);
498
499 public:
500 // create nmethod using archived nmethod from AOT code cache
501 static nmethod* new_nmethod(nmethod* archived_nm,
502 const methodHandle& method,
503 AbstractCompiler* compiler,
504 int compile_id,
505 address reloc_data,
506 GrowableArray<Handle>& oop_list,
507 GrowableArray<Metadata*>& metadata_list,
508 ImmutableOopMapSet* oop_maps,
509 address immutable_data,
510 GrowableArray<Handle>& reloc_imm_oop_list,
511 GrowableArray<Metadata*>& reloc_imm_metadata_list,
512 AOTCodeReader* aot_code_reader);
513
514 // If you change anything in this enum please patch
515 // vmStructs_jvmci.cpp accordingly.
516 enum class InvalidationReason : s1 {
517 NOT_INVALIDATED = -1,
518 C1_CODEPATCH,
519 C1_DEOPTIMIZE,
520 C1_DEOPTIMIZE_FOR_PATCHING,
521 C1_PREDICATE_FAILED_TRAP,
522 CI_REPLAY,
523 UNLOADING,
524 UNLOADING_COLD,
525 JVMCI_INVALIDATE,
526 JVMCI_MATERIALIZE_VIRTUAL_OBJECT,
527 JVMCI_REPLACED_WITH_NEW_CODE,
528 JVMCI_REPROFILE,
529 MARKED_FOR_DEOPTIMIZATION,
530 MISSING_EXCEPTION_HANDLER,
531 NOT_USED,
532 OSR_INVALIDATION_BACK_BRANCH,
533 OSR_INVALIDATION_FOR_COMPILING_WITH_C1,
534 OSR_INVALIDATION_OF_LOWER_LEVEL,
535 SET_NATIVE_FUNCTION,
536 UNCOMMON_TRAP,
537 WHITEBOX_DEOPTIMIZATION,
538 ZOMBIE,
539 INVALIDATION_REASONS_COUNT
540 };
541
542
543 static const char* invalidation_reason_to_string(InvalidationReason invalidation_reason) {
544 switch (invalidation_reason) {
545 case InvalidationReason::C1_CODEPATCH:
546 return "C1 code patch";
547 case InvalidationReason::C1_DEOPTIMIZE:
548 return "C1 deoptimized";
549 case InvalidationReason::C1_DEOPTIMIZE_FOR_PATCHING:
550 return "C1 deoptimize for patching";
551 case InvalidationReason::C1_PREDICATE_FAILED_TRAP:
552 return "C1 predicate failed trap";
553 case InvalidationReason::CI_REPLAY:
554 return "CI replay";
555 case InvalidationReason::JVMCI_INVALIDATE:
556 return "JVMCI invalidate";
557 case InvalidationReason::JVMCI_MATERIALIZE_VIRTUAL_OBJECT:
558 return "JVMCI materialize virtual object";
559 case InvalidationReason::JVMCI_REPLACED_WITH_NEW_CODE:
560 return "JVMCI replaced with new code";
561 case InvalidationReason::JVMCI_REPROFILE:
562 return "JVMCI reprofile";
563 case InvalidationReason::MARKED_FOR_DEOPTIMIZATION:
564 return "marked for deoptimization";
565 case InvalidationReason::MISSING_EXCEPTION_HANDLER:
566 return "missing exception handler";
567 case InvalidationReason::NOT_USED:
568 return "not used";
569 case InvalidationReason::OSR_INVALIDATION_BACK_BRANCH:
570 return "OSR invalidation back branch";
571 case InvalidationReason::OSR_INVALIDATION_FOR_COMPILING_WITH_C1:
572 return "OSR invalidation for compiling with C1";
573 case InvalidationReason::OSR_INVALIDATION_OF_LOWER_LEVEL:
574 return "OSR invalidation of lower level";
575 case InvalidationReason::SET_NATIVE_FUNCTION:
576 return "set native function";
577 case InvalidationReason::UNCOMMON_TRAP:
578 return "uncommon trap";
579 case InvalidationReason::WHITEBOX_DEOPTIMIZATION:
580 return "whitebox deoptimization";
581 case InvalidationReason::ZOMBIE:
582 return "zombie";
583 default: {
584 assert(false, "Unhandled reason");
585 return "Unknown";
586 }
587 }
588 }
589
590 // create nmethod with entry_bci
591 static nmethod* new_nmethod(const methodHandle& method,
592 int compile_id,
593 int entry_bci,
594 CodeOffsets* offsets,
595 int orig_pc_offset,
596 DebugInformationRecorder* recorder,
597 Dependencies* dependencies,
598 CodeBuffer *code_buffer,
599 int frame_size,
600 OopMapSet* oop_maps,
601 ExceptionHandlerTable* handler_table,
602 ImplicitExceptionTable* nul_chk_table,
603 AbstractCompiler* compiler,
604 CompLevel comp_level
605 , AOTCodeEntry* aot_code_entry
606 #if INCLUDE_JVMCI
607 , char* speculations = nullptr,
608 int speculations_len = 0,
609 JVMCINMethodData* jvmci_data = nullptr
610 #endif
611 );
612
613 static nmethod* new_native_nmethod(const methodHandle& method,
614 int compile_id,
615 CodeBuffer *code_buffer,
616 int vep_offset,
617 int frame_complete,
618 int frame_size,
619 ByteSize receiver_sp_offset,
620 ByteSize basic_lock_sp_offset,
621 OopMapSet* oop_maps,
622 int exception_handler = -1);
623
624 Method* method () const { return _method; }
625 uint16_t entry_bci () const { return _entry_bci; }
626 bool is_native_method() const { return _method != nullptr && _method->is_native(); }
627 bool is_java_method () const { return _method != nullptr && !_method->is_native(); }
628 bool is_osr_method () const { return _entry_bci != InvocationEntryBci; }
629
630 int orig_pc_offset() { return _orig_pc_offset; }
631
632 // Compiler task identification. Note that all OSR methods
633 // are numbered in an independent sequence if CICountOSR is true,
634 // and native method wrappers are also numbered independently if
635 // CICountNative is true.
636 int compile_id() const { return _compile_id; }
637 int comp_level() const { return _comp_level; }
638 const char* compile_kind() const;
639
640 inline bool is_compiled_by_c1 () const { return _compiler_type == compiler_c1; }
641 inline bool is_compiled_by_c2 () const { return _compiler_type == compiler_c2; }
642 inline bool is_compiled_by_jvmci() const { return _compiler_type == compiler_jvmci; }
643 CompilerType compiler_type () const { return _compiler_type; }
644 const char* compiler_name () const;
645
646 // boundaries for different parts
647 address consts_begin () const { return content_begin(); }
648 address consts_end () const { return code_begin() ; }
649 address insts_begin () const { return code_begin() ; }
650 address insts_end () const { return header_begin() + _stub_offset ; }
651 address stub_begin () const { return header_begin() + _stub_offset ; }
652 address stub_end () const { return code_end() ; }
653 address exception_begin () const { return header_begin() + _exception_offset ; }
654 address deopt_handler_begin () const { return header_begin() + _deopt_handler_offset ; }
655 address deopt_mh_handler_begin() const { return _deopt_mh_handler_offset != -1 ? (header_begin() + _deopt_mh_handler_offset) : nullptr; }
656 address unwind_handler_begin () const { return _unwind_handler_offset != -1 ? (insts_end() - _unwind_handler_offset) : nullptr; }
657 oop* oops_begin () const { return (oop*) data_begin(); }
658 oop* oops_end () const { return (oop*) data_end(); }
659
660 // mutable data
661 Metadata** metadata_begin () const { return (Metadata**) (mutable_data_begin() + _relocation_size); }
662 #if INCLUDE_JVMCI
663 Metadata** metadata_end () const { return (Metadata**) (mutable_data_begin() + _relocation_size + _metadata_size); }
664 address jvmci_data_begin () const { return mutable_data_begin() + _relocation_size + _metadata_size; }
665 address jvmci_data_end () const { return mutable_data_end(); }
666 #else
667 Metadata** metadata_end () const { return (Metadata**) mutable_data_end(); }
668 #endif
669
670 // immutable data
671 void set_immutable_data(address data) { _immutable_data = data; }
672 address immutable_data_begin () const { return _immutable_data; }
673 address immutable_data_end () const { return _immutable_data + _immutable_data_size ; }
674 address dependencies_begin () const { return _immutable_data; }
675 address dependencies_end () const { return _immutable_data + _nul_chk_table_offset; }
676 address nul_chk_table_begin () const { return _immutable_data + _nul_chk_table_offset; }
677 address nul_chk_table_end () const { return _immutable_data + _handler_table_offset; }
678 address handler_table_begin () const { return _immutable_data + _handler_table_offset; }
679 address handler_table_end () const { return _immutable_data + _scopes_pcs_offset ; }
680 PcDesc* scopes_pcs_begin () const { return (PcDesc*)(_immutable_data + _scopes_pcs_offset) ; }
681 PcDesc* scopes_pcs_end () const { return (PcDesc*)(_immutable_data + _scopes_data_offset) ; }
682 address scopes_data_begin () const { return _immutable_data + _scopes_data_offset ; }
683
684 #if INCLUDE_JVMCI
685 address scopes_data_end () const { return _immutable_data + _speculations_offset ; }
686 address speculations_begin () const { return _immutable_data + _speculations_offset ; }
687 address speculations_end () const { return immutable_data_end(); }
688 #else
689 address scopes_data_end () const { return immutable_data_end(); }
690 #endif
691
692 // Sizes
693 int immutable_data_size() const { return _immutable_data_size; }
694 int consts_size () const { return int( consts_end () - consts_begin ()); }
695 int insts_size () const { return int( insts_end () - insts_begin ()); }
696 int stub_size () const { return int( stub_end () - stub_begin ()); }
697 int oops_size () const { return int((address) oops_end () - (address) oops_begin ()); }
698 int metadata_size () const { return int((address) metadata_end () - (address) metadata_begin ()); }
699 int scopes_data_size () const { return int( scopes_data_end () - scopes_data_begin ()); }
700 int scopes_pcs_size () const { return int((intptr_t)scopes_pcs_end () - (intptr_t)scopes_pcs_begin ()); }
701 int dependencies_size () const { return int( dependencies_end () - dependencies_begin ()); }
702 int handler_table_size () const { return int( handler_table_end() - handler_table_begin()); }
703 int nul_chk_table_size () const { return int( nul_chk_table_end() - nul_chk_table_begin()); }
704 #if INCLUDE_JVMCI
705 int speculations_size () const { return int( speculations_end () - speculations_begin ()); }
706 int jvmci_data_size () const { return int( jvmci_data_end () - jvmci_data_begin ()); }
707 #endif
708
709 int oops_count() const { assert(oops_size() % oopSize == 0, ""); return (oops_size() / oopSize) + 1; }
710 int metadata_count() const { assert(metadata_size() % wordSize == 0, ""); return (metadata_size() / wordSize) + 1; }
711
712 int skipped_instructions_size () const { return _skipped_instructions_size; }
713 int total_size() const;
714
715 // Containment
716 bool consts_contains (address addr) const { return consts_begin () <= addr && addr < consts_end (); }
717 // Returns true if a given address is in the 'insts' section. The method
718 // insts_contains_inclusive() is end-inclusive.
719 bool insts_contains (address addr) const { return insts_begin () <= addr && addr < insts_end (); }
720 bool insts_contains_inclusive(address addr) const { return insts_begin () <= addr && addr <= insts_end (); }
721 bool stub_contains (address addr) const { return stub_begin () <= addr && addr < stub_end (); }
722 bool oops_contains (oop* addr) const { return oops_begin () <= addr && addr < oops_end (); }
723 bool metadata_contains (Metadata** addr) const { return metadata_begin () <= addr && addr < metadata_end (); }
724 bool scopes_data_contains (address addr) const { return scopes_data_begin () <= addr && addr < scopes_data_end (); }
725 bool scopes_pcs_contains (PcDesc* addr) const { return scopes_pcs_begin () <= addr && addr < scopes_pcs_end (); }
726 bool handler_table_contains (address addr) const { return handler_table_begin() <= addr && addr < handler_table_end(); }
727 bool nul_chk_table_contains (address addr) const { return nul_chk_table_begin() <= addr && addr < nul_chk_table_end(); }
728
729 // entry points
730 address entry_point() const { return code_begin() + _entry_offset; } // normal entry point
731 address verified_entry_point() const { return code_begin() + _verified_entry_offset; } // if klass is correct
732
733 enum : signed char { not_installed = -1, // in construction, only the owner doing the construction is
734 // allowed to advance state
735 in_use = 0, // executable nmethod
736 not_entrant = 1 // marked for deoptimization but activations may still exist
737 };
738
739 // flag accessing and manipulation
740 bool is_not_installed() const { return _state == not_installed; }
741 bool is_in_use() const { return _state <= in_use; }
742 bool is_not_entrant() const { return _state == not_entrant; }
743 int get_state() const { return _state; }
744
745 void clear_unloading_state();
746 // Heuristically deduce an nmethod isn't worth keeping around
747 bool is_cold();
748 bool is_unloading();
749 void do_unloading(bool unloading_occurred);
750
751 void inc_method_profiling_count();
752 uint64_t method_profiling_count();
753
754 bool make_in_use() {
755 return try_transition(in_use);
756 }
757 // Make the nmethod non entrant. The nmethod will continue to be
758 // alive. It is used when an uncommon trap happens. Returns true
759 // if this thread changed the state of the nmethod or false if
760 // another thread performed the transition.
761 bool make_not_entrant(InvalidationReason invalidation_reason, bool keep_aot_entry = false);
762 bool make_not_used() { return make_not_entrant(InvalidationReason::NOT_USED, true /* keep AOT entry */); }
763
764 bool is_marked_for_deoptimization() const { return deoptimization_status() != not_marked; }
765 bool has_been_deoptimized() const { return deoptimization_status() == deoptimize_done; }
766 void set_deoptimized_done();
767
768 bool update_recompile_counts() const {
769 // Update recompile counts when either the update is explicitly requested (deoptimize)
770 // or the nmethod is not marked for deoptimization at all (not_marked).
771 // The latter happens during uncommon traps when deoptimized nmethod is made not entrant.
772 DeoptimizationStatus status = deoptimization_status();
773 return status != deoptimize_noupdate && status != deoptimize_done;
774 }
775
776 // tells whether frames described by this nmethod can be deoptimized
777 // note: native wrappers cannot be deoptimized.
778 bool can_be_deoptimized() const { return is_java_method(); }
779
780 bool has_dependencies() { return dependencies_size() != 0; }
781 void print_dependencies_on(outputStream* out) PRODUCT_RETURN;
782 void flush_dependencies();
783
784 template<typename T>
785 T* gc_data() const { return reinterpret_cast<T*>(_gc_data); }
786 template<typename T>
787 void set_gc_data(T* gc_data) { _gc_data = reinterpret_cast<void*>(gc_data); }
788
789 bool has_unsafe_access() const { return _has_unsafe_access; }
790 void set_has_unsafe_access(bool z) { _has_unsafe_access = z; }
791
792 bool has_monitors() const { return _has_monitors; }
793 void set_has_monitors(bool z) { _has_monitors = z; }
794
795 bool has_scoped_access() const { return _has_scoped_access; }
796 void set_has_scoped_access(bool z) { _has_scoped_access = z; }
797
798 bool has_method_handle_invokes() const { return _has_method_handle_invokes; }
799 void set_has_method_handle_invokes(bool z) { _has_method_handle_invokes = z; }
800
801 bool has_wide_vectors() const { return _has_wide_vectors; }
802 void set_has_wide_vectors(bool z) { _has_wide_vectors = z; }
803
804 bool has_clinit_barriers() const { return _has_clinit_barriers; }
805 void set_has_clinit_barriers(bool z) { _has_clinit_barriers = z; }
806
807 bool preloaded() const { return _preloaded; }
808 void set_preloaded(bool z) { _preloaded = z; }
809
810 bool has_flushed_dependencies() const { return _has_flushed_dependencies; }
811 void set_has_flushed_dependencies(bool z) {
812 assert(!has_flushed_dependencies(), "should only happen once");
813 _has_flushed_dependencies = z;
814 }
815
816 bool is_unlinked() const { return _is_unlinked; }
817 void set_is_unlinked() {
818 assert(!_is_unlinked, "already unlinked");
819 _is_unlinked = true;
820 }
821
822 bool used() const { return _used; }
823 void set_used() { _used = true; }
824
825 bool is_aot() const { return _aot_code_entry != nullptr; }
826 void set_aot_code_entry(AOTCodeEntry* entry) { _aot_code_entry = entry; }
827 AOTCodeEntry* aot_code_entry() const { return _aot_code_entry; }
828
829 // Support for oops in scopes and relocs:
830 // Note: index 0 is reserved for null.
831 oop oop_at(int index) const;
832 oop oop_at_phantom(int index) const; // phantom reference
833 oop* oop_addr_at(int index) const { // for GC
834 // relocation indexes are biased by 1 (because 0 is reserved)
835 assert(index > 0 && index <= oops_count(), "must be a valid non-zero index");
836 return &oops_begin()[index - 1];
837 }
838
839 // Support for meta data in scopes and relocs:
840 // Note: index 0 is reserved for null.
841 Metadata* metadata_at(int index) const { return index == 0 ? nullptr: *metadata_addr_at(index); }
842 Metadata** metadata_addr_at(int index) const { // for GC
843 // relocation indexes are biased by 1 (because 0 is reserved)
844 assert(index > 0 && index <= metadata_count(), "must be a valid non-zero index");
845 return &metadata_begin()[index - 1];
846 }
847
848 void copy_values(GrowableArray<Handle>* array);
849 void copy_values(GrowableArray<jobject>* oops);
850 void copy_values(GrowableArray<Metadata*>* metadata);
851 void copy_values(GrowableArray<address>* metadata) {} // Nothing to do
852
853 // Relocation support
854 private:
855 void fix_oop_relocations(address begin, address end, bool initialize_immediates);
856 inline void initialize_immediate_oop(oop* dest, jobject handle);
857
858 protected:
859 address oops_reloc_begin() const;
860
861 public:
862 void fix_oop_relocations(address begin, address end) { fix_oop_relocations(begin, end, false); }
863 void fix_oop_relocations() { fix_oop_relocations(nullptr, nullptr, false); }
864
865 void create_reloc_immediates_list(JavaThread* thread, GrowableArray<Handle>& oop_list, GrowableArray<Metadata*>& metadata_list);
866
867 bool is_at_poll_return(address pc);
868 bool is_at_poll_or_poll_return(address pc);
869
870 protected:
871 // Exception cache support
872 // Note: _exception_cache may be read and cleaned concurrently.
873 ExceptionCache* exception_cache() const { return _exception_cache; }
874 ExceptionCache* exception_cache_acquire() const;
875
876 public:
877 address handler_for_exception_and_pc(Handle exception, address pc);
878 void add_handler_for_exception_and_pc(Handle exception, address pc, address handler);
879 void clean_exception_cache();
880
881 void add_exception_cache_entry(ExceptionCache* new_entry);
882 ExceptionCache* exception_cache_entry_for_exception(Handle exception);
883
884
885 // MethodHandle
886 bool is_method_handle_return(address return_pc);
887 // Deopt
888 // Return true is the PC is one would expect if the frame is being deopted.
889 inline bool is_deopt_pc(address pc);
890 inline bool is_deopt_mh_entry(address pc);
891 inline bool is_deopt_entry(address pc);
892
893 // Accessor/mutator for the original pc of a frame before a frame was deopted.
894 address get_original_pc(const frame* fr) { return *orig_pc_addr(fr); }
895 void set_original_pc(const frame* fr, address pc) { *orig_pc_addr(fr) = pc; }
896
897 const char* state() const;
898
899 bool inlinecache_check_contains(address addr) const {
900 return (addr >= code_begin() && addr < verified_entry_point());
901 }
902
903 void preserve_callee_argument_oops(frame fr, const RegisterMap *reg_map, OopClosure* f);
904
905 // implicit exceptions support
906 address continuation_for_implicit_div0_exception(address pc) { return continuation_for_implicit_exception(pc, true); }
907 address continuation_for_implicit_null_exception(address pc) { return continuation_for_implicit_exception(pc, false); }
908
909 // Inline cache support for class unloading and nmethod unloading
910 private:
911 void cleanup_inline_caches_impl(bool unloading_occurred, bool clean_all);
912
913 address continuation_for_implicit_exception(address pc, bool for_div0_check);
914
915 public:
916 // Serial version used by whitebox test
917 void cleanup_inline_caches_whitebox();
918
919 void clear_inline_caches();
920
921 // Execute nmethod barrier code, as if entering through nmethod call.
922 void run_nmethod_entry_barrier();
923
924 void verify_oop_relocations();
925
926 bool has_evol_metadata();
927
928 Method* attached_method(address call_pc);
929 Method* attached_method_before_pc(address pc);
930
931 // GC unloading support
932 // Cleans unloaded klasses and unloaded nmethods in inline caches
933
934 void unload_nmethod_caches(bool class_unloading_occurred);
935
936 void unlink_from_method();
937
938 // On-stack replacement support
939 int osr_entry_bci() const { assert(is_osr_method(), "wrong kind of nmethod"); return _entry_bci; }
940 address osr_entry() const { assert(is_osr_method(), "wrong kind of nmethod"); return _osr_entry_point; }
941 nmethod* osr_link() const { return _osr_link; }
942 void set_osr_link(nmethod *n) { _osr_link = n; }
943 void invalidate_osr_method();
944
945 int num_stack_arg_slots(bool rounded = true) const {
946 return rounded ? align_up(_num_stack_arg_slots, 2) : _num_stack_arg_slots;
947 }
948
949 // Verify calls to dead methods have been cleaned.
950 void verify_clean_inline_caches();
951
952 // Unlink this nmethod from the system
953 void unlink();
954
955 // Deallocate this nmethod - called by the GC
956 void purge(bool unregister_nmethod);
957
958 // See comment at definition of _last_seen_on_stack
959 void mark_as_maybe_on_stack();
960 bool is_maybe_on_stack();
961
962 // Evolution support. We make old (discarded) compiled methods point to new Method*s.
963 void set_method(Method* method) { _method = method; }
964
965 #if INCLUDE_JVMCI
966 // Gets the JVMCI name of this nmethod.
967 const char* jvmci_name();
968
969 // Records the pending failed speculation in the
970 // JVMCI speculation log associated with this nmethod.
971 void update_speculation(JavaThread* thread);
972
973 // Gets the data specific to a JVMCI compiled method.
974 // This returns a non-nullptr value iff this nmethod was
975 // compiled by the JVMCI compiler.
976 JVMCINMethodData* jvmci_nmethod_data() const {
977 return jvmci_data_size() == 0 ? nullptr : (JVMCINMethodData*) jvmci_data_begin();
978 }
979
980 // Returns true if the runtime should NOT collect deoptimization profile for a JVMCI
981 // compiled method
982 bool jvmci_skip_profile_deopt() const;
983 #endif
984
985 void oops_do(OopClosure* f);
986
987 // All-in-one claiming of nmethods: returns true if the caller successfully claimed that
988 // nmethod.
989 bool oops_do_try_claim();
990
991 // Loom support for following nmethods on the stack
992 void follow_nmethod(OopIterateClosure* cl);
993
994 // Class containing callbacks for the oops_do_process_weak/strong() methods
995 // below.
996 class OopsDoProcessor {
997 public:
998 // Process the oops of the given nmethod based on whether it has been called
999 // in a weak or strong processing context, i.e. apply either weak or strong
1000 // work on it.
1001 virtual void do_regular_processing(nmethod* nm) = 0;
1002 // Assuming that the oops of the given nmethod has already been its weak
1003 // processing applied, apply the remaining strong processing part.
1004 virtual void do_remaining_strong_processing(nmethod* nm) = 0;
1005 };
1006
1007 // The following two methods do the work corresponding to weak/strong nmethod
1008 // processing.
1009 void oops_do_process_weak(OopsDoProcessor* p);
1010 void oops_do_process_strong(OopsDoProcessor* p);
1011
1012 static void oops_do_marking_prologue();
1013 static void oops_do_marking_epilogue();
1014
1015 private:
1016 ScopeDesc* scope_desc_in(address begin, address end);
1017
1018 address* orig_pc_addr(const frame* fr);
1019
1020 // used by jvmti to track if the load events has been reported
1021 bool load_reported() const { return _load_reported; }
1022 void set_load_reported() { _load_reported = true; }
1023
1024 public:
1025 // ScopeDesc retrieval operation
1026 PcDesc* pc_desc_at(address pc) { return find_pc_desc(pc, false); }
1027 // pc_desc_near returns the first PcDesc at or after the given pc.
1028 PcDesc* pc_desc_near(address pc) { return find_pc_desc(pc, true); }
1029
1030 // ScopeDesc for an instruction
1031 ScopeDesc* scope_desc_at(address pc);
1032 ScopeDesc* scope_desc_near(address pc);
1033
1034 // copying of debugging information
1035 void copy_scopes_pcs(PcDesc* pcs, int count);
1036 void copy_scopes_data(address buffer, int size);
1037
1038 // Post successful compilation
1039 void post_compiled_method(CompileTask* task);
1040
1041 // jvmti support:
1042 void post_compiled_method_load_event(JvmtiThreadState* state = nullptr);
1043
1044 // verify operations
1045 void verify();
1046 void verify_scopes();
1047 void verify_interrupt_point(address interrupt_point, bool is_inline_cache);
1048
1049 // Disassemble this nmethod with additional debug information, e.g. information about blocks.
1050 void decode2(outputStream* st) const;
1051 void print_constant_pool(outputStream* st);
1052
1053 // Avoid hiding of parent's 'decode(outputStream*)' method.
1054 void decode(outputStream* st) const { decode2(st); } // just delegate here.
1055
1056 // printing support
1057 void print_on_impl(outputStream* st) const;
1058 void print_code();
1059 void print_value_on_impl(outputStream* st) const;
1060
1061 #if defined(SUPPORT_DATA_STRUCTS)
1062 // print output in opt build for disassembler library
1063 void print_relocations_on(outputStream* st) PRODUCT_RETURN;
1064 void print_pcs_on(outputStream* st);
1065 void print_scopes() { print_scopes_on(tty); }
1066 void print_scopes_on(outputStream* st) PRODUCT_RETURN;
1067 void print_handler_table();
1068 void print_nul_chk_table();
1069 void print_recorded_oop(int log_n, int index);
1070 void print_recorded_oops();
1071 void print_recorded_metadata();
1072
1073 void print_oops(outputStream* st); // oops from the underlying CodeBlob.
1074 void print_metadata(outputStream* st); // metadata in metadata pool.
1075 #else
1076 void print_pcs_on(outputStream* st) { return; }
1077 #endif
1078
1079 void print_calls(outputStream* st) PRODUCT_RETURN;
1080 static void print_statistics() PRODUCT_RETURN;
1081
1082 void maybe_print_nmethod(const DirectiveSet* directive);
1083 void print_nmethod(bool print_code);
1084
1085 void print_on_with_msg(outputStream* st, const char* msg) const;
1086
1087 // Logging
1088 void log_identity(xmlStream* log) const;
1089 void log_new_nmethod() const;
1090 void log_state_change(InvalidationReason invalidation_reason) const;
1091
1092 // Prints block-level comments, including nmethod specific block labels:
1093 void print_nmethod_labels(outputStream* stream, address block_begin, bool print_section_labels=true) const;
1094 const char* nmethod_section_label(address pos) const;
1095
1096 // returns whether this nmethod has code comments.
1097 bool has_code_comment(address begin, address end);
1098 // Prints a comment for one native instruction (reloc info, pc desc)
1099 void print_code_comment_on(outputStream* st, int column, address begin, address end);
1100
1101 // tells if this compiled method is dependent on the given changes,
1102 // and the changes have invalidated it
1103 bool check_dependency_on(DepChange& changes);
1104
1105 // Fast breakpoint support. Tells if this compiled method is
1106 // dependent on the given method. Returns true if this nmethod
1107 // corresponds to the given method as well.
1108 bool is_dependent_on_method(Method* dependee);
1109
1110 // JVMTI's GetLocalInstance() support
1111 ByteSize native_receiver_sp_offset() {
1112 assert(is_native_method(), "sanity");
1113 return _native_receiver_sp_offset;
1114 }
1115 ByteSize native_basic_lock_sp_offset() {
1116 assert(is_native_method(), "sanity");
1117 return _native_basic_lock_sp_offset;
1118 }
1119
1120 // support for code generation
1121 static ByteSize osr_entry_point_offset() { return byte_offset_of(nmethod, _osr_entry_point); }
1122 static ByteSize state_offset() { return byte_offset_of(nmethod, _state); }
1123
1124 void metadata_do(MetadataClosure* f);
1125
1126 address call_instruction_address(address pc) const;
1127
1128 void make_deoptimized();
1129 void finalize_relocations();
1130
1131 void prepare_for_archiving_impl();
1132
1133 class Vptr : public CodeBlob::Vptr {
1134 void print_on(const CodeBlob* instance, outputStream* st) const override {
1135 ttyLocker ttyl;
1136 instance->as_nmethod()->print_on_impl(st);
1137 }
1138 void print_value_on(const CodeBlob* instance, outputStream* st) const override {
1139 instance->as_nmethod()->print_value_on_impl(st);
1140 }
1141 void prepare_for_archiving(CodeBlob* instance) const override {
1142 ((nmethod*)instance)->prepare_for_archiving_impl();
1143 };
1144 };
1145
1146 static const Vptr _vpntr;
1147 };
1148
1149 #endif // SHARE_CODE_NMETHOD_HPP