1 /*
2 * Copyright (c) 1997, 2026, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 *
23 */
24
25 #include "asm/assembler.inline.hpp"
26 #include "cds/cdsConfig.hpp"
27 #include "code/codeCache.hpp"
28 #include "code/compiledIC.hpp"
29 #include "code/dependencies.hpp"
30 #include "code/nativeInst.hpp"
31 #include "code/nmethod.inline.hpp"
32 #include "code/scopeDesc.hpp"
33 #include "compiler/abstractCompiler.hpp"
34 #include "compiler/compilationLog.hpp"
35 #include "compiler/compileBroker.hpp"
36 #include "compiler/compileLog.hpp"
37 #include "compiler/compilerDirectives.hpp"
38 #include "compiler/compilerOracle.hpp"
39 #include "compiler/compileTask.hpp"
40 #include "compiler/directivesParser.hpp"
41 #include "compiler/disassembler.hpp"
42 #include "compiler/oopMap.inline.hpp"
43 #include "gc/shared/barrierSet.hpp"
44 #include "gc/shared/barrierSetNMethod.hpp"
45 #include "gc/shared/classUnloadingContext.hpp"
46 #include "gc/shared/collectedHeap.hpp"
47 #include "interpreter/bytecode.inline.hpp"
48 #include "jvm.h"
49 #include "logging/log.hpp"
50 #include "logging/logStream.hpp"
51 #include "memory/allocation.inline.hpp"
52 #include "memory/resourceArea.hpp"
53 #include "memory/universe.hpp"
54 #include "oops/access.inline.hpp"
55 #include "oops/klass.inline.hpp"
56 #include "oops/method.inline.hpp"
57 #include "oops/methodData.hpp"
58 #include "oops/oop.inline.hpp"
59 #include "oops/weakHandle.inline.hpp"
60 #include "prims/jvmtiImpl.hpp"
61 #include "prims/jvmtiThreadState.hpp"
62 #include "prims/methodHandles.hpp"
63 #include "runtime/atomicAccess.hpp"
64 #include "runtime/continuation.hpp"
65 #include "runtime/deoptimization.hpp"
66 #include "runtime/flags/flagSetting.hpp"
67 #include "runtime/frame.inline.hpp"
68 #include "runtime/handles.inline.hpp"
69 #include "runtime/jniHandles.inline.hpp"
70 #include "runtime/orderAccess.hpp"
71 #include "runtime/os.hpp"
72 #include "runtime/safepointVerifiers.hpp"
73 #include "runtime/serviceThread.hpp"
74 #include "runtime/sharedRuntime.hpp"
75 #include "runtime/signature.hpp"
76 #include "runtime/threadWXSetters.inline.hpp"
77 #include "runtime/vmThread.hpp"
78 #include "utilities/align.hpp"
79 #include "utilities/copy.hpp"
80 #include "utilities/dtrace.hpp"
81 #include "utilities/events.hpp"
82 #include "utilities/globalDefinitions.hpp"
83 #include "utilities/hashTable.hpp"
84 #include "utilities/xmlstream.hpp"
85 #if INCLUDE_JVMCI
86 #include "jvmci/jvmciRuntime.hpp"
87 #endif
88
89 #ifdef DTRACE_ENABLED
90
91 // Only bother with this argument setup if dtrace is available
92
93 #define DTRACE_METHOD_UNLOAD_PROBE(method) \
94 { \
95 Method* m = (method); \
96 if (m != nullptr) { \
97 Symbol* klass_name = m->klass_name(); \
98 Symbol* name = m->name(); \
99 Symbol* signature = m->signature(); \
100 HOTSPOT_COMPILED_METHOD_UNLOAD( \
101 (char *) klass_name->bytes(), klass_name->utf8_length(), \
102 (char *) name->bytes(), name->utf8_length(), \
103 (char *) signature->bytes(), signature->utf8_length()); \
104 } \
105 }
106
107 #else // ndef DTRACE_ENABLED
108
109 #define DTRACE_METHOD_UNLOAD_PROBE(method)
110
111 #endif
112
113 // Cast from int value to narrow type
114 #define CHECKED_CAST(result, T, thing) \
115 result = static_cast<T>(thing); \
116 guarantee(static_cast<int>(result) == thing, "failed: %d != %d", static_cast<int>(result), thing);
117
118 //---------------------------------------------------------------------------------
119 // NMethod statistics
120 // They are printed under various flags, including:
121 // PrintC1Statistics, PrintOptoStatistics, LogVMOutput, and LogCompilation.
122 // (In the latter two cases, they like other stats are printed to the log only.)
123
124 #ifndef PRODUCT
125 // These variables are put into one block to reduce relocations
126 // and make it simpler to print from the debugger.
127 struct java_nmethod_stats_struct {
128 uint nmethod_count;
129 uint total_nm_size;
130 uint total_immut_size;
131 uint total_mut_size;
132 uint relocation_size;
133 uint consts_size;
134 uint insts_size;
135 uint stub_size;
136 uint oops_size;
137 uint metadata_size;
138 uint dependencies_size;
139 uint nul_chk_table_size;
140 uint handler_table_size;
141 uint scopes_pcs_size;
142 uint scopes_data_size;
143 #if INCLUDE_JVMCI
144 uint speculations_size;
145 uint jvmci_data_size;
146 #endif
147
148 void note_nmethod(nmethod* nm) {
149 nmethod_count += 1;
150 total_nm_size += nm->size();
151 total_immut_size += nm->immutable_data_size();
152 total_mut_size += nm->mutable_data_size();
153 relocation_size += nm->relocation_size();
154 consts_size += nm->consts_size();
155 insts_size += nm->insts_size();
156 stub_size += nm->stub_size();
157 oops_size += nm->oops_size();
158 metadata_size += nm->metadata_size();
159 scopes_data_size += nm->scopes_data_size();
160 scopes_pcs_size += nm->scopes_pcs_size();
161 dependencies_size += nm->dependencies_size();
162 handler_table_size += nm->handler_table_size();
163 nul_chk_table_size += nm->nul_chk_table_size();
164 #if INCLUDE_JVMCI
165 speculations_size += nm->speculations_size();
166 jvmci_data_size += nm->jvmci_data_size();
167 #endif
168 }
169 void print_nmethod_stats(const char* name) {
170 if (nmethod_count == 0) return;
171 tty->print_cr("Statistics for %u bytecoded nmethods for %s:", nmethod_count, name);
172 uint total_size = total_nm_size + total_immut_size + total_mut_size;
173 if (total_nm_size != 0) {
174 tty->print_cr(" total size = %u (100%%)", total_size);
175 tty->print_cr(" in CodeCache = %u (%f%%)", total_nm_size, (total_nm_size * 100.0f)/total_size);
176 }
177 uint header_size = (uint)(nmethod_count * sizeof(nmethod));
178 if (nmethod_count != 0) {
179 tty->print_cr(" header = %u (%f%%)", header_size, (header_size * 100.0f)/total_nm_size);
180 }
181 if (consts_size != 0) {
182 tty->print_cr(" constants = %u (%f%%)", consts_size, (consts_size * 100.0f)/total_nm_size);
183 }
184 if (insts_size != 0) {
185 tty->print_cr(" main code = %u (%f%%)", insts_size, (insts_size * 100.0f)/total_nm_size);
186 }
187 if (stub_size != 0) {
188 tty->print_cr(" stub code = %u (%f%%)", stub_size, (stub_size * 100.0f)/total_nm_size);
189 }
190 if (oops_size != 0) {
191 tty->print_cr(" oops = %u (%f%%)", oops_size, (oops_size * 100.0f)/total_nm_size);
192 }
193 if (total_mut_size != 0) {
194 tty->print_cr(" mutable data = %u (%f%%)", total_mut_size, (total_mut_size * 100.0f)/total_size);
195 }
196 if (relocation_size != 0) {
197 tty->print_cr(" relocation = %u (%f%%)", relocation_size, (relocation_size * 100.0f)/total_mut_size);
198 }
199 if (metadata_size != 0) {
200 tty->print_cr(" metadata = %u (%f%%)", metadata_size, (metadata_size * 100.0f)/total_mut_size);
201 }
202 #if INCLUDE_JVMCI
203 if (jvmci_data_size != 0) {
204 tty->print_cr(" JVMCI data = %u (%f%%)", jvmci_data_size, (jvmci_data_size * 100.0f)/total_mut_size);
205 }
206 #endif
207 if (total_immut_size != 0) {
208 tty->print_cr(" immutable data = %u (%f%%)", total_immut_size, (total_immut_size * 100.0f)/total_size);
209 }
210 if (dependencies_size != 0) {
211 tty->print_cr(" dependencies = %u (%f%%)", dependencies_size, (dependencies_size * 100.0f)/total_immut_size);
212 }
213 if (nul_chk_table_size != 0) {
214 tty->print_cr(" nul chk table = %u (%f%%)", nul_chk_table_size, (nul_chk_table_size * 100.0f)/total_immut_size);
215 }
216 if (handler_table_size != 0) {
217 tty->print_cr(" handler table = %u (%f%%)", handler_table_size, (handler_table_size * 100.0f)/total_immut_size);
218 }
219 if (scopes_pcs_size != 0) {
220 tty->print_cr(" scopes pcs = %u (%f%%)", scopes_pcs_size, (scopes_pcs_size * 100.0f)/total_immut_size);
221 }
222 if (scopes_data_size != 0) {
223 tty->print_cr(" scopes data = %u (%f%%)", scopes_data_size, (scopes_data_size * 100.0f)/total_immut_size);
224 }
225 #if INCLUDE_JVMCI
226 if (speculations_size != 0) {
227 tty->print_cr(" speculations = %u (%f%%)", speculations_size, (speculations_size * 100.0f)/total_immut_size);
228 }
229 #endif
230 }
231 };
232
233 struct native_nmethod_stats_struct {
234 uint native_nmethod_count;
235 uint native_total_size;
236 uint native_relocation_size;
237 uint native_insts_size;
238 uint native_oops_size;
239 uint native_metadata_size;
240 void note_native_nmethod(nmethod* nm) {
241 native_nmethod_count += 1;
242 native_total_size += nm->size();
243 native_relocation_size += nm->relocation_size();
244 native_insts_size += nm->insts_size();
245 native_oops_size += nm->oops_size();
246 native_metadata_size += nm->metadata_size();
247 }
248 void print_native_nmethod_stats() {
249 if (native_nmethod_count == 0) return;
250 tty->print_cr("Statistics for %u native nmethods:", native_nmethod_count);
251 if (native_total_size != 0) tty->print_cr(" N. total size = %u", native_total_size);
252 if (native_relocation_size != 0) tty->print_cr(" N. relocation = %u", native_relocation_size);
253 if (native_insts_size != 0) tty->print_cr(" N. main code = %u", native_insts_size);
254 if (native_oops_size != 0) tty->print_cr(" N. oops = %u", native_oops_size);
255 if (native_metadata_size != 0) tty->print_cr(" N. metadata = %u", native_metadata_size);
256 }
257 };
258
259 struct pc_nmethod_stats_struct {
260 uint pc_desc_init; // number of initialization of cache (= number of caches)
261 uint pc_desc_queries; // queries to nmethod::find_pc_desc
262 uint pc_desc_approx; // number of those which have approximate true
263 uint pc_desc_repeats; // number of _pc_descs[0] hits
264 uint pc_desc_hits; // number of LRU cache hits
265 uint pc_desc_tests; // total number of PcDesc examinations
266 uint pc_desc_searches; // total number of quasi-binary search steps
267 uint pc_desc_adds; // number of LUR cache insertions
268
269 void print_pc_stats() {
270 tty->print_cr("PcDesc Statistics: %u queries, %.2f comparisons per query",
271 pc_desc_queries,
272 (double)(pc_desc_tests + pc_desc_searches)
273 / pc_desc_queries);
274 tty->print_cr(" caches=%d queries=%u/%u, hits=%u+%u, tests=%u+%u, adds=%u",
275 pc_desc_init,
276 pc_desc_queries, pc_desc_approx,
277 pc_desc_repeats, pc_desc_hits,
278 pc_desc_tests, pc_desc_searches, pc_desc_adds);
279 }
280 };
281
282 #ifdef COMPILER1
283 static java_nmethod_stats_struct c1_java_nmethod_stats;
284 #endif
285 #ifdef COMPILER2
286 static java_nmethod_stats_struct c2_java_nmethod_stats;
287 #endif
288 #if INCLUDE_JVMCI
289 static java_nmethod_stats_struct jvmci_java_nmethod_stats;
290 #endif
291 static java_nmethod_stats_struct unknown_java_nmethod_stats;
292
293 static native_nmethod_stats_struct native_nmethod_stats;
294 static pc_nmethod_stats_struct pc_nmethod_stats;
295
296 static void note_java_nmethod(nmethod* nm) {
297 #ifdef COMPILER1
298 if (nm->is_compiled_by_c1()) {
299 c1_java_nmethod_stats.note_nmethod(nm);
300 } else
301 #endif
302 #ifdef COMPILER2
303 if (nm->is_compiled_by_c2()) {
304 c2_java_nmethod_stats.note_nmethod(nm);
305 } else
306 #endif
307 #if INCLUDE_JVMCI
308 if (nm->is_compiled_by_jvmci()) {
309 jvmci_java_nmethod_stats.note_nmethod(nm);
310 } else
311 #endif
312 {
313 unknown_java_nmethod_stats.note_nmethod(nm);
314 }
315 }
316 #endif // !PRODUCT
317
318 //---------------------------------------------------------------------------------
319
320
321 ExceptionCache::ExceptionCache(Handle exception, address pc, address handler) {
322 assert(pc != nullptr, "Must be non null");
323 assert(exception.not_null(), "Must be non null");
324 assert(handler != nullptr, "Must be non null");
325
326 _count = 0;
327 _exception_type = exception->klass();
328 _next = nullptr;
329 _purge_list_next = nullptr;
330
331 add_address_and_handler(pc,handler);
332 }
333
334
335 address ExceptionCache::match(Handle exception, address pc) {
336 assert(pc != nullptr,"Must be non null");
337 assert(exception.not_null(),"Must be non null");
338 if (exception->klass() == exception_type()) {
339 return (test_address(pc));
340 }
341
342 return nullptr;
343 }
344
345
346 bool ExceptionCache::match_exception_with_space(Handle exception) {
347 assert(exception.not_null(),"Must be non null");
348 if (exception->klass() == exception_type() && count() < cache_size) {
349 return true;
350 }
351 return false;
352 }
353
354
355 address ExceptionCache::test_address(address addr) {
356 int limit = count();
357 for (int i = 0; i < limit; i++) {
358 if (pc_at(i) == addr) {
359 return handler_at(i);
360 }
361 }
362 return nullptr;
363 }
364
365
366 bool ExceptionCache::add_address_and_handler(address addr, address handler) {
367 if (test_address(addr) == handler) return true;
368
369 int index = count();
370 if (index < cache_size) {
371 set_pc_at(index, addr);
372 set_handler_at(index, handler);
373 increment_count();
374 return true;
375 }
376 return false;
377 }
378
379 ExceptionCache* ExceptionCache::next() {
380 return AtomicAccess::load(&_next);
381 }
382
383 void ExceptionCache::set_next(ExceptionCache *ec) {
384 AtomicAccess::store(&_next, ec);
385 }
386
387 //-----------------------------------------------------------------------------
388
389
390 // Helper used by both find_pc_desc methods.
391 static inline bool match_desc(PcDesc* pc, int pc_offset, bool approximate) {
392 NOT_PRODUCT(++pc_nmethod_stats.pc_desc_tests);
393 if (!approximate) {
394 return pc->pc_offset() == pc_offset;
395 } else {
396 // Do not look before the sentinel
397 assert(pc_offset > PcDesc::lower_offset_limit, "illegal pc_offset");
398 return pc_offset <= pc->pc_offset() && (pc-1)->pc_offset() < pc_offset;
399 }
400 }
401
402 void PcDescCache::init_to(PcDesc* initial_pc_desc) {
403 NOT_PRODUCT(++pc_nmethod_stats.pc_desc_init);
404 // initialize the cache by filling it with benign (non-null) values
405 assert(initial_pc_desc != nullptr && initial_pc_desc->pc_offset() == PcDesc::lower_offset_limit,
406 "must start with a sentinel");
407 for (int i = 0; i < cache_size; i++) {
408 _pc_descs[i] = initial_pc_desc;
409 }
410 }
411
412 PcDesc* PcDescCache::find_pc_desc(int pc_offset, bool approximate) {
413 // Note: one might think that caching the most recently
414 // read value separately would be a win, but one would be
415 // wrong. When many threads are updating it, the cache
416 // line it's in would bounce between caches, negating
417 // any benefit.
418
419 // In order to prevent race conditions do not load cache elements
420 // repeatedly, but use a local copy:
421 PcDesc* res;
422
423 // Step one: Check the most recently added value.
424 res = _pc_descs[0];
425 assert(res != nullptr, "PcDesc cache should be initialized already");
426
427 // Approximate only here since PcDescContainer::find_pc_desc() checked for exact case.
428 if (approximate && match_desc(res, pc_offset, approximate)) {
429 NOT_PRODUCT(++pc_nmethod_stats.pc_desc_repeats);
430 return res;
431 }
432
433 // Step two: Check the rest of the LRU cache.
434 for (int i = 1; i < cache_size; ++i) {
435 res = _pc_descs[i];
436 if (res->pc_offset() < 0) break; // optimization: skip empty cache
437 if (match_desc(res, pc_offset, approximate)) {
438 NOT_PRODUCT(++pc_nmethod_stats.pc_desc_hits);
439 return res;
440 }
441 }
442
443 // Report failure.
444 return nullptr;
445 }
446
447 void PcDescCache::add_pc_desc(PcDesc* pc_desc) {
448 NOT_PRODUCT(++pc_nmethod_stats.pc_desc_adds);
449 // Update the LRU cache by shifting pc_desc forward.
450 for (int i = 0; i < cache_size; i++) {
451 PcDesc* next = _pc_descs[i];
452 _pc_descs[i] = pc_desc;
453 pc_desc = next;
454 }
455 }
456
457 // adjust pcs_size so that it is a multiple of both oopSize and
458 // sizeof(PcDesc) (assumes that if sizeof(PcDesc) is not a multiple
459 // of oopSize, then 2*sizeof(PcDesc) is)
460 static int adjust_pcs_size(int pcs_size) {
461 int nsize = align_up(pcs_size, oopSize);
462 if ((nsize % sizeof(PcDesc)) != 0) {
463 nsize = pcs_size + sizeof(PcDesc);
464 }
465 assert((nsize % oopSize) == 0, "correct alignment");
466 return nsize;
467 }
468
469 // Returns a string version of the method state.
470 const char* nmethod::state() const {
471 int state = get_state();
472 switch (state) {
473 case not_installed:
474 return "not installed";
475 case in_use:
476 return "in use";
477 case not_entrant:
478 return "not_entrant";
479 default:
480 fatal("unexpected method state: %d", state);
481 return nullptr;
482 }
483 }
484
485 void nmethod::set_deoptimized_done() {
486 ConditionalMutexLocker ml(NMethodState_lock, !NMethodState_lock->owned_by_self(), Mutex::_no_safepoint_check_flag);
487 if (_deoptimization_status != deoptimize_done) { // can't go backwards
488 AtomicAccess::store(&_deoptimization_status, deoptimize_done);
489 }
490 }
491
492 ExceptionCache* nmethod::exception_cache_acquire() const {
493 return AtomicAccess::load_acquire(&_exception_cache);
494 }
495
496 void nmethod::add_exception_cache_entry(ExceptionCache* new_entry) {
497 assert(ExceptionCache_lock->owned_by_self(),"Must hold the ExceptionCache_lock");
498 assert(new_entry != nullptr,"Must be non null");
499 assert(new_entry->next() == nullptr, "Must be null");
500
501 for (;;) {
502 ExceptionCache *ec = exception_cache();
503 if (ec != nullptr) {
504 Klass* ex_klass = ec->exception_type();
505 if (!ex_klass->is_loader_alive()) {
506 // We must guarantee that entries are not inserted with new next pointer
507 // edges to ExceptionCache entries with dead klasses, due to bad interactions
508 // with concurrent ExceptionCache cleanup. Therefore, the inserts roll
509 // the head pointer forward to the first live ExceptionCache, so that the new
510 // next pointers always point at live ExceptionCaches, that are not removed due
511 // to concurrent ExceptionCache cleanup.
512 ExceptionCache* next = ec->next();
513 if (AtomicAccess::cmpxchg(&_exception_cache, ec, next) == ec) {
514 CodeCache::release_exception_cache(ec);
515 }
516 continue;
517 }
518 ec = exception_cache();
519 if (ec != nullptr) {
520 new_entry->set_next(ec);
521 }
522 }
523 if (AtomicAccess::cmpxchg(&_exception_cache, ec, new_entry) == ec) {
524 return;
525 }
526 }
527 }
528
529 void nmethod::clean_exception_cache() {
530 // For each nmethod, only a single thread may call this cleanup function
531 // at the same time, whether called in STW cleanup or concurrent cleanup.
532 // Note that if the GC is processing exception cache cleaning in a concurrent phase,
533 // then a single writer may contend with cleaning up the head pointer to the
534 // first ExceptionCache node that has a Klass* that is alive. That is fine,
535 // as long as there is no concurrent cleanup of next pointers from concurrent writers.
536 // And the concurrent writers do not clean up next pointers, only the head.
537 // Also note that concurrent readers will walk through Klass* pointers that are not
538 // alive. That does not cause ABA problems, because Klass* is deleted after
539 // a handshake with all threads, after all stale ExceptionCaches have been
540 // unlinked. That is also when the CodeCache::exception_cache_purge_list()
541 // is deleted, with all ExceptionCache entries that were cleaned concurrently.
542 // That similarly implies that CAS operations on ExceptionCache entries do not
543 // suffer from ABA problems as unlinking and deletion is separated by a global
544 // handshake operation.
545 ExceptionCache* prev = nullptr;
546 ExceptionCache* curr = exception_cache_acquire();
547
548 while (curr != nullptr) {
549 ExceptionCache* next = curr->next();
550
551 if (!curr->exception_type()->is_loader_alive()) {
552 if (prev == nullptr) {
553 // Try to clean head; this is contended by concurrent inserts, that
554 // both lazily clean the head, and insert entries at the head. If
555 // the CAS fails, the operation is restarted.
556 if (AtomicAccess::cmpxchg(&_exception_cache, curr, next) != curr) {
557 prev = nullptr;
558 curr = exception_cache_acquire();
559 continue;
560 }
561 } else {
562 // It is impossible to during cleanup connect the next pointer to
563 // an ExceptionCache that has not been published before a safepoint
564 // prior to the cleanup. Therefore, release is not required.
565 prev->set_next(next);
566 }
567 // prev stays the same.
568
569 CodeCache::release_exception_cache(curr);
570 } else {
571 prev = curr;
572 }
573
574 curr = next;
575 }
576 }
577
578 // public method for accessing the exception cache
579 // These are the public access methods.
580 address nmethod::handler_for_exception_and_pc(Handle exception, address pc) {
581 // We never grab a lock to read the exception cache, so we may
582 // have false negatives. This is okay, as it can only happen during
583 // the first few exception lookups for a given nmethod.
584 ExceptionCache* ec = exception_cache_acquire();
585 while (ec != nullptr) {
586 address ret_val;
587 if ((ret_val = ec->match(exception,pc)) != nullptr) {
588 return ret_val;
589 }
590 ec = ec->next();
591 }
592 return nullptr;
593 }
594
595 void nmethod::add_handler_for_exception_and_pc(Handle exception, address pc, address handler) {
596 // There are potential race conditions during exception cache updates, so we
597 // must own the ExceptionCache_lock before doing ANY modifications. Because
598 // we don't lock during reads, it is possible to have several threads attempt
599 // to update the cache with the same data. We need to check for already inserted
600 // copies of the current data before adding it.
601
602 MutexLocker ml(ExceptionCache_lock);
603 ExceptionCache* target_entry = exception_cache_entry_for_exception(exception);
604
605 if (target_entry == nullptr || !target_entry->add_address_and_handler(pc,handler)) {
606 target_entry = new ExceptionCache(exception,pc,handler);
607 add_exception_cache_entry(target_entry);
608 }
609 }
610
611 // private method for handling exception cache
612 // These methods are private, and used to manipulate the exception cache
613 // directly.
614 ExceptionCache* nmethod::exception_cache_entry_for_exception(Handle exception) {
615 ExceptionCache* ec = exception_cache_acquire();
616 while (ec != nullptr) {
617 if (ec->match_exception_with_space(exception)) {
618 return ec;
619 }
620 ec = ec->next();
621 }
622 return nullptr;
623 }
624
625 bool nmethod::is_at_poll_return(address pc) {
626 RelocIterator iter(this, pc, pc+1);
627 while (iter.next()) {
628 if (iter.type() == relocInfo::poll_return_type)
629 return true;
630 }
631 return false;
632 }
633
634
635 bool nmethod::is_at_poll_or_poll_return(address pc) {
636 RelocIterator iter(this, pc, pc+1);
637 while (iter.next()) {
638 relocInfo::relocType t = iter.type();
639 if (t == relocInfo::poll_return_type || t == relocInfo::poll_type)
640 return true;
641 }
642 return false;
643 }
644
645 void nmethod::verify_oop_relocations() {
646 // Ensure sure that the code matches the current oop values
647 RelocIterator iter(this, nullptr, nullptr);
648 while (iter.next()) {
649 if (iter.type() == relocInfo::oop_type) {
650 oop_Relocation* reloc = iter.oop_reloc();
651 if (!reloc->oop_is_immediate()) {
652 reloc->verify_oop_relocation();
653 }
654 }
655 }
656 }
657
658
659 ScopeDesc* nmethod::scope_desc_at(address pc) {
660 PcDesc* pd = pc_desc_at(pc);
661 guarantee(pd != nullptr, "scope must be present");
662 return new ScopeDesc(this, pd);
663 }
664
665 ScopeDesc* nmethod::scope_desc_near(address pc) {
666 PcDesc* pd = pc_desc_near(pc);
667 guarantee(pd != nullptr, "scope must be present");
668 return new ScopeDesc(this, pd);
669 }
670
671 address nmethod::oops_reloc_begin() const {
672 // If the method is not entrant then a JMP is plastered over the
673 // first few bytes. If an oop in the old code was there, that oop
674 // should not get GC'd. Skip the first few bytes of oops on
675 // not-entrant methods.
676 if (frame_complete_offset() != CodeOffsets::frame_never_safe &&
677 code_begin() + frame_complete_offset() >
678 verified_entry_point() + NativeJump::instruction_size)
679 {
680 // If we have a frame_complete_offset after the native jump, then there
681 // is no point trying to look for oops before that. This is a requirement
682 // for being allowed to scan oops concurrently.
683 return code_begin() + frame_complete_offset();
684 }
685
686 address low_boundary = verified_entry_point();
687 return low_boundary;
688 }
689
690 // Method that knows how to preserve outgoing arguments at call. This method must be
691 // called with a frame corresponding to a Java invoke
692 void nmethod::preserve_callee_argument_oops(frame fr, const RegisterMap *reg_map, OopClosure* f) {
693 if (method() == nullptr) {
694 return;
695 }
696
697 // handle the case of an anchor explicitly set in continuation code that doesn't have a callee
698 JavaThread* thread = reg_map->thread();
699 if ((thread->has_last_Java_frame() && fr.sp() == thread->last_Java_sp())
700 JVMTI_ONLY(|| (method()->is_continuation_enter_intrinsic() && thread->on_monitor_waited_event()))) {
701 return;
702 }
703
704 if (!method()->is_native()) {
705 address pc = fr.pc();
706 bool has_receiver, has_appendix;
707 Symbol* signature;
708
709 // The method attached by JIT-compilers should be used, if present.
710 // Bytecode can be inaccurate in such case.
711 Method* callee = attached_method_before_pc(pc);
712 if (callee != nullptr) {
713 has_receiver = !(callee->access_flags().is_static());
714 has_appendix = false;
715 signature = callee->signature();
716
717 // If inline types are passed as fields, use the extended signature
718 // which contains the types of all (oop) fields of the inline type.
719 if (is_compiled_by_c2() && callee->has_scalarized_args()) {
720 const GrowableArray<SigEntry>* sig = callee->adapter()->get_sig_cc();
721 assert(sig != nullptr, "sig should never be null");
722 TempNewSymbol tmp_sig = SigEntry::create_symbol(sig);
723 has_receiver = false; // The extended signature contains the receiver type
724 fr.oops_compiled_arguments_do(tmp_sig, has_receiver, has_appendix, reg_map, f);
725 return;
726 }
727 } else {
728 SimpleScopeDesc ssd(this, pc);
729
730 Bytecode_invoke call(methodHandle(Thread::current(), ssd.method()), ssd.bci());
731 has_receiver = call.has_receiver();
732 has_appendix = call.has_appendix();
733 signature = call.signature();
734 }
735
736 fr.oops_compiled_arguments_do(signature, has_receiver, has_appendix, reg_map, f);
737 } else if (method()->is_continuation_enter_intrinsic()) {
738 // This method only calls Continuation.enter()
739 Symbol* signature = vmSymbols::continuationEnter_signature();
740 fr.oops_compiled_arguments_do(signature, false, false, reg_map, f);
741 }
742 }
743
744 Method* nmethod::attached_method(address call_instr) {
745 assert(code_contains(call_instr), "not part of the nmethod");
746 RelocIterator iter(this, call_instr, call_instr + 1);
747 while (iter.next()) {
748 if (iter.addr() == call_instr) {
749 switch(iter.type()) {
750 case relocInfo::static_call_type: return iter.static_call_reloc()->method_value();
751 case relocInfo::opt_virtual_call_type: return iter.opt_virtual_call_reloc()->method_value();
752 case relocInfo::virtual_call_type: return iter.virtual_call_reloc()->method_value();
753 default: break;
754 }
755 }
756 }
757 return nullptr; // not found
758 }
759
760 Method* nmethod::attached_method_before_pc(address pc) {
761 if (NativeCall::is_call_before(pc)) {
762 NativeCall* ncall = nativeCall_before(pc);
763 return attached_method(ncall->instruction_address());
764 }
765 return nullptr; // not a call
766 }
767
768 void nmethod::clear_inline_caches() {
769 assert(SafepointSynchronize::is_at_safepoint() || (NMethodState_lock->owned_by_self() && is_not_installed()), "clearing of IC's only allowed at safepoint or when not installed");
770 RelocIterator iter(this);
771 while (iter.next()) {
772 iter.reloc()->clear_inline_cache();
773 }
774 }
775
776 #ifdef ASSERT
777 // Check class_loader is alive for this bit of metadata.
778 class CheckClass : public MetadataClosure {
779 void do_metadata(Metadata* md) {
780 Klass* klass = nullptr;
781 if (md->is_klass()) {
782 klass = ((Klass*)md);
783 } else if (md->is_method()) {
784 klass = ((Method*)md)->method_holder();
785 } else if (md->is_methodData()) {
786 klass = ((MethodData*)md)->method()->method_holder();
787 } else if (md->is_methodCounters()) {
788 klass = ((MethodCounters*)md)->method()->method_holder();
789 } else {
790 md->print();
791 ShouldNotReachHere();
792 }
793 assert(klass->is_loader_alive(), "must be alive");
794 }
795 };
796 #endif // ASSERT
797
798 // Clean references to unloaded nmethods at addr from this one, which is not unloaded.
799 template <typename CallsiteT>
800 static void clean_if_nmethod_is_unloaded(CallsiteT* callsite, bool clean_all) {
801 CodeBlob* cb = CodeCache::find_blob(callsite->destination());
802 if (!cb->is_nmethod()) {
803 return;
804 }
805 nmethod* nm = cb->as_nmethod();
806 if (clean_all || !nm->is_in_use() || nm->is_unloading() || nm->method()->code() != nm) {
807 callsite->set_to_clean();
808 }
809 }
810
811 // Cleans caches in nmethods that point to either classes that are unloaded
812 // or nmethods that are unloaded.
813 //
814 // Can be called either in parallel by G1 currently or after all
815 // nmethods are unloaded. Return postponed=true in the parallel case for
816 // inline caches found that point to nmethods that are not yet visited during
817 // the do_unloading walk.
818 void nmethod::unload_nmethod_caches(bool unloading_occurred) {
819 ResourceMark rm;
820
821 // Exception cache only needs to be called if unloading occurred
822 if (unloading_occurred) {
823 clean_exception_cache();
824 }
825
826 cleanup_inline_caches_impl(unloading_occurred, false);
827
828 #ifdef ASSERT
829 // Check that the metadata embedded in the nmethod is alive
830 CheckClass check_class;
831 metadata_do(&check_class);
832 #endif
833 }
834
835 void nmethod::run_nmethod_entry_barrier() {
836 BarrierSetNMethod* bs_nm = BarrierSet::barrier_set()->barrier_set_nmethod();
837 if (bs_nm != nullptr) {
838 // We want to keep an invariant that nmethods found through iterations of a Thread's
839 // nmethods found in safepoints have gone through an entry barrier and are not armed.
840 // By calling this nmethod entry barrier, it plays along and acts
841 // like any other nmethod found on the stack of a thread (fewer surprises).
842 nmethod* nm = this;
843 bool alive = bs_nm->nmethod_entry_barrier(nm);
844 assert(alive, "should be alive");
845 }
846 }
847
848 // Only called by whitebox test
849 void nmethod::cleanup_inline_caches_whitebox() {
850 assert_locked_or_safepoint(CodeCache_lock);
851 CompiledICLocker ic_locker(this);
852 cleanup_inline_caches_impl(false /* unloading_occurred */, true /* clean_all */);
853 }
854
855 address* nmethod::orig_pc_addr(const frame* fr) {
856 return (address*) ((address)fr->unextended_sp() + orig_pc_offset());
857 }
858
859 // Called to clean up after class unloading for live nmethods
860 void nmethod::cleanup_inline_caches_impl(bool unloading_occurred, bool clean_all) {
861 assert(CompiledICLocker::is_safe(this), "mt unsafe call");
862 ResourceMark rm;
863
864 // Find all calls in an nmethod and clear the ones that point to bad nmethods.
865 RelocIterator iter(this, oops_reloc_begin());
866 bool is_in_static_stub = false;
867 while(iter.next()) {
868
869 switch (iter.type()) {
870
871 case relocInfo::virtual_call_type:
872 if (unloading_occurred) {
873 // If class unloading occurred we first clear ICs where the cached metadata
874 // is referring to an unloaded klass or method.
875 CompiledIC_at(&iter)->clean_metadata();
876 }
877
878 clean_if_nmethod_is_unloaded(CompiledIC_at(&iter), clean_all);
879 break;
880
881 case relocInfo::opt_virtual_call_type:
882 case relocInfo::static_call_type:
883 clean_if_nmethod_is_unloaded(CompiledDirectCall::at(iter.reloc()), clean_all);
884 break;
885
886 case relocInfo::static_stub_type: {
887 is_in_static_stub = true;
888 break;
889 }
890
891 case relocInfo::metadata_type: {
892 // Only the metadata relocations contained in static/opt virtual call stubs
893 // contains the Method* passed to c2i adapters. It is the only metadata
894 // relocation that needs to be walked, as it is the one metadata relocation
895 // that violates the invariant that all metadata relocations have an oop
896 // in the compiled method (due to deferred resolution and code patching).
897
898 // This causes dead metadata to remain in compiled methods that are not
899 // unloading. Unless these slippery metadata relocations of the static
900 // stubs are at least cleared, subsequent class redefinition operations
901 // will access potentially free memory, and JavaThread execution
902 // concurrent to class unloading may call c2i adapters with dead methods.
903 if (!is_in_static_stub) {
904 // The first metadata relocation after a static stub relocation is the
905 // metadata relocation of the static stub used to pass the Method* to
906 // c2i adapters.
907 continue;
908 }
909 is_in_static_stub = false;
910 if (is_unloading()) {
911 // If the nmethod itself is dying, then it may point at dead metadata.
912 // Nobody should follow that metadata; it is strictly unsafe.
913 continue;
914 }
915 metadata_Relocation* r = iter.metadata_reloc();
916 Metadata* md = r->metadata_value();
917 if (md != nullptr && md->is_method()) {
918 Method* method = static_cast<Method*>(md);
919 if (!method->method_holder()->is_loader_alive()) {
920 AtomicAccess::store(r->metadata_addr(), (Method*)nullptr);
921
922 if (!r->metadata_is_immediate()) {
923 r->fix_metadata_relocation();
924 }
925 }
926 }
927 break;
928 }
929
930 default:
931 break;
932 }
933 }
934 }
935
936 address nmethod::continuation_for_implicit_exception(address pc, bool for_div0_check) {
937 // Exception happened outside inline-cache check code => we are inside
938 // an active nmethod => use cpc to determine a return address
939 int exception_offset = int(pc - code_begin());
940 int cont_offset = ImplicitExceptionTable(this).continuation_offset( exception_offset );
941 #ifdef ASSERT
942 if (cont_offset == 0) {
943 Thread* thread = Thread::current();
944 ResourceMark rm(thread);
945 CodeBlob* cb = CodeCache::find_blob(pc);
946 assert(cb != nullptr && cb == this, "");
947
948 // Keep tty output consistent. To avoid ttyLocker, we buffer in stream, and print all at once.
949 stringStream ss;
950 ss.print_cr("implicit exception happened at " INTPTR_FORMAT, p2i(pc));
951 print_on(&ss);
952 method()->print_codes_on(&ss);
953 print_code_on(&ss);
954 print_pcs_on(&ss);
955 tty->print("%s", ss.as_string()); // print all at once
956 }
957 #endif
958 if (cont_offset == 0) {
959 // Let the normal error handling report the exception
960 return nullptr;
961 }
962 if (cont_offset == exception_offset) {
963 #if INCLUDE_JVMCI
964 Deoptimization::DeoptReason deopt_reason = for_div0_check ? Deoptimization::Reason_div0_check : Deoptimization::Reason_null_check;
965 JavaThread *thread = JavaThread::current();
966 thread->set_jvmci_implicit_exception_pc(pc);
967 thread->set_pending_deoptimization(Deoptimization::make_trap_request(deopt_reason,
968 Deoptimization::Action_reinterpret));
969 return (SharedRuntime::deopt_blob()->implicit_exception_uncommon_trap());
970 #else
971 ShouldNotReachHere();
972 #endif
973 }
974 return code_begin() + cont_offset;
975 }
976
977 class HasEvolDependency : public MetadataClosure {
978 bool _has_evol_dependency;
979 public:
980 HasEvolDependency() : _has_evol_dependency(false) {}
981 void do_metadata(Metadata* md) {
982 if (md->is_method()) {
983 Method* method = (Method*)md;
984 if (method->is_old()) {
985 _has_evol_dependency = true;
986 }
987 }
988 }
989 bool has_evol_dependency() const { return _has_evol_dependency; }
990 };
991
992 bool nmethod::has_evol_metadata() {
993 // Check the metadata in relocIter and CompiledIC and also deoptimize
994 // any nmethod that has reference to old methods.
995 HasEvolDependency check_evol;
996 metadata_do(&check_evol);
997 if (check_evol.has_evol_dependency() && log_is_enabled(Debug, redefine, class, nmethod)) {
998 ResourceMark rm;
999 log_debug(redefine, class, nmethod)
1000 ("Found evol dependency of nmethod %s.%s(%s) compile_id=%d on in nmethod metadata",
1001 _method->method_holder()->external_name(),
1002 _method->name()->as_C_string(),
1003 _method->signature()->as_C_string(),
1004 compile_id());
1005 }
1006 return check_evol.has_evol_dependency();
1007 }
1008
1009 int nmethod::total_size() const {
1010 return
1011 consts_size() +
1012 insts_size() +
1013 stub_size() +
1014 scopes_data_size() +
1015 scopes_pcs_size() +
1016 handler_table_size() +
1017 nul_chk_table_size();
1018 }
1019
1020 const char* nmethod::compile_kind() const {
1021 if (is_osr_method()) return "osr";
1022 if (method() != nullptr && is_native_method()) {
1023 if (method()->is_continuation_native_intrinsic()) {
1024 return "cnt";
1025 }
1026 return "c2n";
1027 }
1028 return nullptr;
1029 }
1030
1031 const char* nmethod::compiler_name() const {
1032 return compilertype2name(_compiler_type);
1033 }
1034
1035 #ifdef ASSERT
1036 class CheckForOopsClosure : public OopClosure {
1037 bool _found_oop = false;
1038 public:
1039 virtual void do_oop(oop* o) { _found_oop = true; }
1040 virtual void do_oop(narrowOop* o) { _found_oop = true; }
1041 bool found_oop() { return _found_oop; }
1042 };
1043 class CheckForMetadataClosure : public MetadataClosure {
1044 bool _found_metadata = false;
1045 Metadata* _ignore = nullptr;
1046 public:
1047 CheckForMetadataClosure(Metadata* ignore) : _ignore(ignore) {}
1048 virtual void do_metadata(Metadata* md) { if (md != _ignore) _found_metadata = true; }
1049 bool found_metadata() { return _found_metadata; }
1050 };
1051
1052 static void assert_no_oops_or_metadata(nmethod* nm) {
1053 if (nm == nullptr) return;
1054 assert(nm->oop_maps() == nullptr, "expectation");
1055
1056 CheckForOopsClosure cfo;
1057 nm->oops_do(&cfo);
1058 assert(!cfo.found_oop(), "no oops allowed");
1059
1060 // We allow an exception for the own Method, but require its class to be permanent.
1061 Method* own_method = nm->method();
1062 CheckForMetadataClosure cfm(/* ignore reference to own Method */ own_method);
1063 nm->metadata_do(&cfm);
1064 assert(!cfm.found_metadata(), "no metadata allowed");
1065
1066 assert(own_method->method_holder()->class_loader_data()->is_permanent_class_loader_data(),
1067 "Method's class needs to be permanent");
1068 }
1069 #endif
1070
1071 static int required_mutable_data_size(CodeBuffer* code_buffer,
1072 int jvmci_data_size = 0) {
1073 return align_up(code_buffer->total_relocation_size(), oopSize) +
1074 align_up(code_buffer->total_metadata_size(), oopSize) +
1075 align_up(jvmci_data_size, oopSize);
1076 }
1077
1078 nmethod* nmethod::new_native_nmethod(const methodHandle& method,
1079 int compile_id,
1080 CodeBuffer *code_buffer,
1081 int vep_offset,
1082 int frame_complete,
1083 int frame_size,
1084 ByteSize basic_lock_owner_sp_offset,
1085 ByteSize basic_lock_sp_offset,
1086 OopMapSet* oop_maps,
1087 int exception_handler) {
1088 code_buffer->finalize_oop_references(method);
1089 // create nmethod
1090 nmethod* nm = nullptr;
1091 int native_nmethod_size = CodeBlob::allocation_size(code_buffer, sizeof(nmethod));
1092 {
1093 MutexLocker mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);
1094
1095 CodeOffsets offsets;
1096 offsets.set_value(CodeOffsets::Verified_Entry, vep_offset);
1097 offsets.set_value(CodeOffsets::Frame_Complete, frame_complete);
1098 if (exception_handler != -1) {
1099 offsets.set_value(CodeOffsets::Exceptions, exception_handler);
1100 }
1101
1102 int mutable_data_size = required_mutable_data_size(code_buffer);
1103
1104 // MH intrinsics are dispatch stubs which are compatible with NonNMethod space.
1105 // IsUnloadingBehaviour::is_unloading needs to handle them separately.
1106 bool allow_NonNMethod_space = method->can_be_allocated_in_NonNMethod_space();
1107 nm = new (native_nmethod_size, allow_NonNMethod_space)
1108 nmethod(method(), compiler_none, native_nmethod_size,
1109 compile_id, &offsets,
1110 code_buffer, frame_size,
1111 basic_lock_owner_sp_offset,
1112 basic_lock_sp_offset,
1113 oop_maps, mutable_data_size);
1114 DEBUG_ONLY( if (allow_NonNMethod_space) assert_no_oops_or_metadata(nm); )
1115 NOT_PRODUCT(if (nm != nullptr) native_nmethod_stats.note_native_nmethod(nm));
1116 }
1117
1118 if (nm != nullptr) {
1119 // verify nmethod
1120 DEBUG_ONLY(nm->verify();) // might block
1121
1122 nm->log_new_nmethod();
1123 }
1124 return nm;
1125 }
1126
1127 nmethod* nmethod::new_nmethod(const methodHandle& method,
1128 int compile_id,
1129 int entry_bci,
1130 CodeOffsets* offsets,
1131 int orig_pc_offset,
1132 DebugInformationRecorder* debug_info,
1133 Dependencies* dependencies,
1134 CodeBuffer* code_buffer, int frame_size,
1135 OopMapSet* oop_maps,
1136 ExceptionHandlerTable* handler_table,
1137 ImplicitExceptionTable* nul_chk_table,
1138 AbstractCompiler* compiler,
1139 CompLevel comp_level
1140 #if INCLUDE_JVMCI
1141 , char* speculations,
1142 int speculations_len,
1143 JVMCINMethodData* jvmci_data
1144 #endif
1145 )
1146 {
1147 assert(debug_info->oop_recorder() == code_buffer->oop_recorder(), "shared OR");
1148 code_buffer->finalize_oop_references(method);
1149 // create nmethod
1150 nmethod* nm = nullptr;
1151 int nmethod_size = CodeBlob::allocation_size(code_buffer, sizeof(nmethod));
1152
1153 int immutable_data_size =
1154 adjust_pcs_size(debug_info->pcs_size())
1155 + align_up((int)dependencies->size_in_bytes(), oopSize)
1156 + align_up(handler_table->size_in_bytes() , oopSize)
1157 + align_up(nul_chk_table->size_in_bytes() , oopSize)
1158 #if INCLUDE_JVMCI
1159 + align_up(speculations_len , oopSize)
1160 #endif
1161 + align_up(debug_info->data_size() , oopSize);
1162
1163 // First, allocate space for immutable data in C heap.
1164 address immutable_data = nullptr;
1165 if (immutable_data_size > 0) {
1166 immutable_data_size += ImmutableDataRefCountSize;
1167 immutable_data = (address)os::malloc(immutable_data_size, mtCode);
1168 if (immutable_data == nullptr) {
1169 vm_exit_out_of_memory(immutable_data_size, OOM_MALLOC_ERROR, "nmethod: no space for immutable data");
1170 return nullptr;
1171 }
1172 }
1173
1174 int mutable_data_size = required_mutable_data_size(code_buffer
1175 JVMCI_ONLY(COMMA (compiler->is_jvmci() ? jvmci_data->size() : 0)));
1176
1177 {
1178 MutexLocker mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);
1179
1180 nm = new (nmethod_size, comp_level)
1181 nmethod(method(), compiler->type(), nmethod_size, immutable_data_size, mutable_data_size,
1182 compile_id, entry_bci, immutable_data, offsets, orig_pc_offset,
1183 debug_info, dependencies, code_buffer, frame_size, oop_maps,
1184 handler_table, nul_chk_table, compiler, comp_level
1185 #if INCLUDE_JVMCI
1186 , speculations,
1187 speculations_len,
1188 jvmci_data
1189 #endif
1190 );
1191
1192 if (nm != nullptr) {
1193 // To make dependency checking during class loading fast, record
1194 // the nmethod dependencies in the classes it is dependent on.
1195 // This allows the dependency checking code to simply walk the
1196 // class hierarchy above the loaded class, checking only nmethods
1197 // which are dependent on those classes. The slow way is to
1198 // check every nmethod for dependencies which makes it linear in
1199 // the number of methods compiled. For applications with a lot
1200 // classes the slow way is too slow.
1201 for (Dependencies::DepStream deps(nm); deps.next(); ) {
1202 if (deps.type() == Dependencies::call_site_target_value) {
1203 // CallSite dependencies are managed on per-CallSite instance basis.
1204 oop call_site = deps.argument_oop(0);
1205 MethodHandles::add_dependent_nmethod(call_site, nm);
1206 } else {
1207 InstanceKlass* ik = deps.context_type();
1208 if (ik == nullptr) {
1209 continue; // ignore things like evol_method
1210 }
1211 // record this nmethod as dependent on this klass
1212 ik->add_dependent_nmethod(nm);
1213 }
1214 }
1215 NOT_PRODUCT(if (nm != nullptr) note_java_nmethod(nm));
1216 }
1217 }
1218 // Do verification and logging outside CodeCache_lock.
1219 if (nm != nullptr) {
1220 // Safepoints in nmethod::verify aren't allowed because nm hasn't been installed yet.
1221 DEBUG_ONLY(nm->verify();)
1222 nm->log_new_nmethod();
1223 }
1224 return nm;
1225 }
1226
1227 // Fill in default values for various fields
1228 void nmethod::init_defaults(CodeBuffer *code_buffer, CodeOffsets* offsets) {
1229 // avoid uninitialized fields, even for short time periods
1230 _exception_cache = nullptr;
1231 _gc_data = nullptr;
1232 _oops_do_mark_link = nullptr;
1233 _compiled_ic_data = nullptr;
1234
1235 _is_unloading_state = 0;
1236 _state = not_installed;
1237
1238 _has_unsafe_access = 0;
1239 _has_wide_vectors = 0;
1240 _has_monitors = 0;
1241 _has_scoped_access = 0;
1242 _has_flushed_dependencies = 0;
1243 _is_unlinked = 0;
1244 _load_reported = 0; // jvmti state
1245
1246 _deoptimization_status = not_marked;
1247
1248 // SECT_CONSTS is first in code buffer so the offset should be 0.
1249 int consts_offset = code_buffer->total_offset_of(code_buffer->consts());
1250 assert(consts_offset == 0, "const_offset: %d", consts_offset);
1251
1252 _stub_offset = content_offset() + code_buffer->total_offset_of(code_buffer->stubs());
1253
1254 CHECKED_CAST(_entry_offset, uint16_t, (offsets->value(CodeOffsets::Entry)));
1255 CHECKED_CAST(_verified_entry_offset, uint16_t, (offsets->value(CodeOffsets::Verified_Entry)));
1256
1257 _inline_entry_offset = _entry_offset;
1258 _verified_inline_entry_offset = _verified_entry_offset;
1259 _verified_inline_ro_entry_offset = _verified_entry_offset;
1260
1261 _skipped_instructions_size = code_buffer->total_skipped_instructions_size();
1262 }
1263
1264 // Post initialization
1265 void nmethod::post_init() {
1266 clear_unloading_state();
1267
1268 finalize_relocations();
1269
1270 Universe::heap()->register_nmethod(this);
1271 DEBUG_ONLY(Universe::heap()->verify_nmethod(this));
1272
1273 CodeCache::commit(this);
1274 }
1275
1276 // For native wrappers
1277 nmethod::nmethod(
1278 Method* method,
1279 CompilerType type,
1280 int nmethod_size,
1281 int compile_id,
1282 CodeOffsets* offsets,
1283 CodeBuffer* code_buffer,
1284 int frame_size,
1285 ByteSize basic_lock_owner_sp_offset,
1286 ByteSize basic_lock_sp_offset,
1287 OopMapSet* oop_maps,
1288 int mutable_data_size)
1289 : CodeBlob("native nmethod", CodeBlobKind::Nmethod, code_buffer, nmethod_size, sizeof(nmethod),
1290 offsets->value(CodeOffsets::Frame_Complete), frame_size, oop_maps, false, mutable_data_size),
1291 _deoptimization_generation(0),
1292 _gc_epoch(CodeCache::gc_epoch()),
1293 _method(method),
1294 _native_receiver_sp_offset(basic_lock_owner_sp_offset),
1295 _native_basic_lock_sp_offset(basic_lock_sp_offset)
1296 {
1297 {
1298 DEBUG_ONLY(NoSafepointVerifier nsv;)
1299 assert_locked_or_safepoint(CodeCache_lock);
1300 assert(!method->has_scalarized_args(), "scalarized native wrappers not supported yet");
1301 init_defaults(code_buffer, offsets);
1302
1303 _osr_entry_point = nullptr;
1304 _pc_desc_container = nullptr;
1305 _entry_bci = InvocationEntryBci;
1306 _compile_id = compile_id;
1307 _comp_level = CompLevel_none;
1308 _compiler_type = type;
1309 _orig_pc_offset = 0;
1310 _num_stack_arg_slots = 0;
1311
1312 if (offsets->value(CodeOffsets::Exceptions) != -1) {
1313 // Continuation enter intrinsic
1314 _exception_offset = code_offset() + offsets->value(CodeOffsets::Exceptions);
1315 } else {
1316 _exception_offset = 0;
1317 }
1318 // Native wrappers do not have deopt handlers. Make the values
1319 // something that will never match a pc like the nmethod vtable entry
1320 _deopt_handler_entry_offset = 0;
1321 _unwind_handler_offset = 0;
1322
1323 CHECKED_CAST(_oops_size, uint16_t, align_up(code_buffer->total_oop_size(), oopSize));
1324 uint16_t metadata_size;
1325 CHECKED_CAST(metadata_size, uint16_t, align_up(code_buffer->total_metadata_size(), wordSize));
1326 JVMCI_ONLY( _metadata_size = metadata_size; )
1327 assert(_mutable_data_size == _relocation_size + metadata_size,
1328 "wrong mutable data size: %d != %d + %d",
1329 _mutable_data_size, _relocation_size, metadata_size);
1330
1331 // native wrapper does not have read-only data but we need unique not null address
1332 _immutable_data = blob_end();
1333 _immutable_data_size = 0;
1334 _nul_chk_table_offset = 0;
1335 _handler_table_offset = 0;
1336 _scopes_pcs_offset = 0;
1337 _scopes_data_offset = 0;
1338 #if INCLUDE_JVMCI
1339 _speculations_offset = 0;
1340 #endif
1341 _immutable_data_ref_count_offset = 0;
1342
1343 code_buffer->copy_code_and_locs_to(this);
1344 code_buffer->copy_values_to(this);
1345
1346 post_init();
1347 }
1348
1349 if (PrintNativeNMethods || PrintDebugInfo || PrintRelocations || PrintDependencies) {
1350 ttyLocker ttyl; // keep the following output all in one block
1351 // This output goes directly to the tty, not the compiler log.
1352 // To enable tools to match it up with the compilation activity,
1353 // be sure to tag this tty output with the compile ID.
1354 if (xtty != nullptr) {
1355 xtty->begin_head("print_native_nmethod");
1356 xtty->method(_method);
1357 xtty->stamp();
1358 xtty->end_head(" address='" INTPTR_FORMAT "'", (intptr_t) this);
1359 }
1360 // Print the header part, then print the requested information.
1361 // This is both handled in decode2(), called via print_code() -> decode()
1362 if (PrintNativeNMethods) {
1363 tty->print_cr("-------------------------- Assembly (native nmethod) ---------------------------");
1364 print_code();
1365 tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
1366 #if defined(SUPPORT_DATA_STRUCTS)
1367 if (AbstractDisassembler::show_structs()) {
1368 if (oop_maps != nullptr) {
1369 tty->print("oop maps:"); // oop_maps->print_on(tty) outputs a cr() at the beginning
1370 oop_maps->print_on(tty);
1371 tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
1372 }
1373 }
1374 #endif
1375 } else {
1376 print(); // print the header part only.
1377 }
1378 #if defined(SUPPORT_DATA_STRUCTS)
1379 if (AbstractDisassembler::show_structs()) {
1380 if (PrintRelocations) {
1381 print_relocations();
1382 tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
1383 }
1384 }
1385 #endif
1386 if (xtty != nullptr) {
1387 xtty->tail("print_native_nmethod");
1388 }
1389 }
1390 }
1391
1392
1393 nmethod::nmethod(const nmethod &nm) : CodeBlob(nm._name, nm._kind, nm._size, nm._header_size)
1394 {
1395
1396 if (nm._oop_maps != nullptr) {
1397 _oop_maps = nm._oop_maps->clone();
1398 } else {
1399 _oop_maps = nullptr;
1400 }
1401
1402 _size = nm._size;
1403 _relocation_size = nm._relocation_size;
1404 _content_offset = nm._content_offset;
1405 _code_offset = nm._code_offset;
1406 _data_offset = nm._data_offset;
1407 _frame_size = nm._frame_size;
1408
1409 S390_ONLY( _ctable_offset = nm._ctable_offset; )
1410
1411 _header_size = nm._header_size;
1412 _frame_complete_offset = nm._frame_complete_offset;
1413
1414 _kind = nm._kind;
1415
1416 _caller_must_gc_arguments = nm._caller_must_gc_arguments;
1417
1418 #ifndef PRODUCT
1419 _asm_remarks.share(nm._asm_remarks);
1420 _dbg_strings.share(nm._dbg_strings);
1421 #endif
1422
1423 // Allocate memory and copy mutable data to C heap
1424 _mutable_data_size = nm._mutable_data_size;
1425 if (_mutable_data_size > 0) {
1426 _mutable_data = (address)os::malloc(_mutable_data_size, mtCode);
1427 if (_mutable_data == nullptr) {
1428 vm_exit_out_of_memory(_mutable_data_size, OOM_MALLOC_ERROR, "nmethod: no space for mutable data");
1429 }
1430 memcpy(mutable_data_begin(), nm.mutable_data_begin(), nm.mutable_data_size());
1431 } else {
1432 _mutable_data = nullptr;
1433 }
1434
1435 _deoptimization_generation = 0;
1436 _gc_epoch = CodeCache::gc_epoch();
1437 _method = nm._method;
1438 _osr_link = nullptr;
1439
1440 _exception_cache = nullptr;
1441 _gc_data = nullptr;
1442 _oops_do_mark_nmethods = nullptr;
1443 _oops_do_mark_link = nullptr;
1444 _compiled_ic_data = nullptr;
1445
1446 // Relocate the OSR entry point from nm to the new nmethod.
1447 if (nm._osr_entry_point == nullptr) {
1448 _osr_entry_point = nullptr;
1449 } else {
1450 address new_addr = nm._osr_entry_point - (address) &nm + (address) this;
1451 assert(new_addr >= code_begin() && new_addr < code_end(),
1452 "relocated address must be within code bounds");
1453 _osr_entry_point = new_addr;
1454 }
1455 _entry_offset = nm._entry_offset;
1456 _verified_entry_offset = nm._verified_entry_offset;
1457 _inline_entry_offset = nm._inline_entry_offset;
1458 _verified_inline_entry_offset = nm._verified_inline_entry_offset;
1459 _verified_inline_ro_entry_offset = nm._verified_inline_ro_entry_offset;
1460
1461 _entry_bci = nm._entry_bci;
1462 _immutable_data_size = nm._immutable_data_size;
1463
1464 _skipped_instructions_size = nm._skipped_instructions_size;
1465 _stub_offset = nm._stub_offset;
1466 _exception_offset = nm._exception_offset;
1467 _deopt_handler_entry_offset = nm._deopt_handler_entry_offset;
1468 _unwind_handler_offset = nm._unwind_handler_offset;
1469 _num_stack_arg_slots = nm._num_stack_arg_slots;
1470 _oops_size = nm._oops_size;
1471 #if INCLUDE_JVMCI
1472 _metadata_size = nm._metadata_size;
1473 #endif
1474 _nul_chk_table_offset = nm._nul_chk_table_offset;
1475 _handler_table_offset = nm._handler_table_offset;
1476 _scopes_pcs_offset = nm._scopes_pcs_offset;
1477 _scopes_data_offset = nm._scopes_data_offset;
1478 #if INCLUDE_JVMCI
1479 _speculations_offset = nm._speculations_offset;
1480 #endif
1481 _immutable_data_ref_count_offset = nm._immutable_data_ref_count_offset;
1482
1483 // Increment number of references to immutable data to share it between nmethods
1484 if (_immutable_data_size > 0) {
1485 _immutable_data = nm._immutable_data;
1486 inc_immutable_data_ref_count();
1487 } else {
1488 _immutable_data = blob_end();
1489 }
1490
1491 _orig_pc_offset = nm._orig_pc_offset;
1492 _compile_id = nm._compile_id;
1493 _comp_level = nm._comp_level;
1494 _compiler_type = nm._compiler_type;
1495 _is_unloading_state = nm._is_unloading_state;
1496 _state = not_installed;
1497
1498 _has_unsafe_access = nm._has_unsafe_access;
1499 _has_wide_vectors = nm._has_wide_vectors;
1500 _has_monitors = nm._has_monitors;
1501 _has_scoped_access = nm._has_scoped_access;
1502 _has_flushed_dependencies = nm._has_flushed_dependencies;
1503 _is_unlinked = nm._is_unlinked;
1504 _load_reported = nm._load_reported;
1505
1506 _deoptimization_status = nm._deoptimization_status;
1507
1508 if (nm._pc_desc_container != nullptr) {
1509 _pc_desc_container = new PcDescContainer(scopes_pcs_begin());
1510 } else {
1511 _pc_desc_container = nullptr;
1512 }
1513
1514 // Copy nmethod contents excluding header
1515 // - Constant part (doubles, longs and floats used in nmethod)
1516 // - Code part:
1517 // - Code body
1518 // - Exception handler
1519 // - Stub code
1520 // - OOP table
1521 memcpy(consts_begin(), nm.consts_begin(), nm.data_end() - nm.consts_begin());
1522
1523 // Fix relocation
1524 RelocIterator iter(this);
1525 CodeBuffer src(&nm);
1526 CodeBuffer dst(this);
1527 while (iter.next()) {
1528 #ifdef USE_TRAMPOLINE_STUB_FIX_OWNER
1529 // After an nmethod is moved, some direct call sites may end up out of range.
1530 // CallRelocation::fix_relocation_after_move() assumes the target is always
1531 // reachable and does not check branch range. Calling it without range checks
1532 // could cause us to write an offset too large for the instruction.
1533 //
1534 // If a call site has a trampoline, we skip the normal call relocation. The
1535 // associated trampoline_stub_Relocation will handle the call and the
1536 // trampoline, including range checks and updating the branch as needed.
1537 //
1538 // If no trampoline exists, we can assume the call target is always
1539 // reachable and therefore within direct branch range, so calling
1540 // CallRelocation::fix_relocation_after_move() is safe.
1541 if (iter.reloc()->is_call()) {
1542 address trampoline = trampoline_stub_Relocation::get_trampoline_for(iter.reloc()->addr(), this);
1543 if (trampoline != nullptr) {
1544 continue;
1545 }
1546 }
1547 #endif
1548
1549 iter.reloc()->fix_relocation_after_move(&src, &dst);
1550 }
1551
1552 {
1553 MutexLocker ml(NMethodState_lock, Mutex::_no_safepoint_check_flag);
1554 clear_inline_caches();
1555 }
1556
1557 post_init();
1558 }
1559
1560 nmethod* nmethod::relocate(CodeBlobType code_blob_type) {
1561 assert(NMethodRelocation, "must enable use of function");
1562
1563 // Locks required to be held by caller to ensure the nmethod
1564 // is not modified or purged from code cache during relocation
1565 assert_lock_strong(CodeCache_lock);
1566 assert_lock_strong(Compile_lock);
1567 assert(CompiledICLocker::is_safe(this), "mt unsafe call");
1568
1569 if (!is_relocatable()) {
1570 return nullptr;
1571 }
1572
1573 run_nmethod_entry_barrier();
1574 nmethod* nm_copy = new (size(), code_blob_type) nmethod(*this);
1575
1576 if (nm_copy == nullptr) {
1577 return nullptr;
1578 }
1579
1580 // To make dependency checking during class loading fast, record
1581 // the nmethod dependencies in the classes it is dependent on.
1582 // This allows the dependency checking code to simply walk the
1583 // class hierarchy above the loaded class, checking only nmethods
1584 // which are dependent on those classes. The slow way is to
1585 // check every nmethod for dependencies which makes it linear in
1586 // the number of methods compiled. For applications with a lot
1587 // classes the slow way is too slow.
1588 for (Dependencies::DepStream deps(nm_copy); deps.next(); ) {
1589 if (deps.type() == Dependencies::call_site_target_value) {
1590 // CallSite dependencies are managed on per-CallSite instance basis.
1591 oop call_site = deps.argument_oop(0);
1592 MethodHandles::add_dependent_nmethod(call_site, nm_copy);
1593 } else {
1594 InstanceKlass* ik = deps.context_type();
1595 if (ik == nullptr) {
1596 continue; // ignore things like evol_method
1597 }
1598 // record this nmethod as dependent on this klass
1599 ik->add_dependent_nmethod(nm_copy);
1600 }
1601 }
1602
1603 MutexLocker ml_NMethodState_lock(NMethodState_lock, Mutex::_no_safepoint_check_flag);
1604
1605 // Verify the nm we copied from is still valid
1606 if (!is_marked_for_deoptimization() && is_in_use()) {
1607 assert(method() != nullptr && method()->code() == this, "should be if is in use");
1608
1609 // Attempt to start using the copy
1610 if (nm_copy->make_in_use()) {
1611 ICache::invalidate_range(nm_copy->code_begin(), nm_copy->code_size());
1612
1613 methodHandle mh(Thread::current(), nm_copy->method());
1614 nm_copy->method()->set_code(mh, nm_copy);
1615
1616 make_not_entrant(InvalidationReason::RELOCATED);
1617
1618 nm_copy->post_compiled_method_load_event();
1619
1620 nm_copy->log_relocated_nmethod(this);
1621
1622 return nm_copy;
1623 }
1624 }
1625
1626 nm_copy->make_not_used();
1627
1628 return nullptr;
1629 }
1630
1631 bool nmethod::is_relocatable() {
1632 if (!is_java_method()) {
1633 return false;
1634 }
1635
1636 if (!is_in_use()) {
1637 return false;
1638 }
1639
1640 if (is_osr_method()) {
1641 return false;
1642 }
1643
1644 if (is_marked_for_deoptimization()) {
1645 return false;
1646 }
1647
1648 #if INCLUDE_JVMCI
1649 if (jvmci_nmethod_data() != nullptr && jvmci_nmethod_data()->has_mirror()) {
1650 return false;
1651 }
1652 #endif
1653
1654 if (is_unloading()) {
1655 return false;
1656 }
1657
1658 if (has_evol_metadata()) {
1659 return false;
1660 }
1661
1662 return true;
1663 }
1664
1665 void* nmethod::operator new(size_t size, int nmethod_size, int comp_level) throw () {
1666 return CodeCache::allocate(nmethod_size, CodeCache::get_code_blob_type(comp_level));
1667 }
1668
1669 void* nmethod::operator new(size_t size, int nmethod_size, CodeBlobType code_blob_type) throw () {
1670 return CodeCache::allocate(nmethod_size, code_blob_type);
1671 }
1672
1673 void* nmethod::operator new(size_t size, int nmethod_size, bool allow_NonNMethod_space) throw () {
1674 // Try MethodNonProfiled and MethodProfiled.
1675 void* return_value = CodeCache::allocate(nmethod_size, CodeBlobType::MethodNonProfiled);
1676 if (return_value != nullptr || !allow_NonNMethod_space) return return_value;
1677 // Try NonNMethod or give up.
1678 return CodeCache::allocate(nmethod_size, CodeBlobType::NonNMethod);
1679 }
1680
1681 // For normal JIT compiled code
1682 nmethod::nmethod(
1683 Method* method,
1684 CompilerType type,
1685 int nmethod_size,
1686 int immutable_data_size,
1687 int mutable_data_size,
1688 int compile_id,
1689 int entry_bci,
1690 address immutable_data,
1691 CodeOffsets* offsets,
1692 int orig_pc_offset,
1693 DebugInformationRecorder* debug_info,
1694 Dependencies* dependencies,
1695 CodeBuffer *code_buffer,
1696 int frame_size,
1697 OopMapSet* oop_maps,
1698 ExceptionHandlerTable* handler_table,
1699 ImplicitExceptionTable* nul_chk_table,
1700 AbstractCompiler* compiler,
1701 CompLevel comp_level
1702 #if INCLUDE_JVMCI
1703 , char* speculations,
1704 int speculations_len,
1705 JVMCINMethodData* jvmci_data
1706 #endif
1707 )
1708 : CodeBlob("nmethod", CodeBlobKind::Nmethod, code_buffer, nmethod_size, sizeof(nmethod),
1709 offsets->value(CodeOffsets::Frame_Complete), frame_size, oop_maps, false, mutable_data_size),
1710 _deoptimization_generation(0),
1711 _gc_epoch(CodeCache::gc_epoch()),
1712 _method(method),
1713 _osr_link(nullptr)
1714 {
1715 assert(debug_info->oop_recorder() == code_buffer->oop_recorder(), "shared OR");
1716 {
1717 DEBUG_ONLY(NoSafepointVerifier nsv;)
1718 assert_locked_or_safepoint(CodeCache_lock);
1719
1720 init_defaults(code_buffer, offsets);
1721
1722 _osr_entry_point = code_begin() + offsets->value(CodeOffsets::OSR_Entry);
1723 _entry_bci = entry_bci;
1724 _compile_id = compile_id;
1725 _comp_level = comp_level;
1726 _compiler_type = type;
1727 _orig_pc_offset = orig_pc_offset;
1728
1729 _num_stack_arg_slots = entry_bci != InvocationEntryBci ? 0 : _method->constMethod()->num_stack_arg_slots();
1730
1731 set_ctable_begin(header_begin() + content_offset());
1732
1733 #if INCLUDE_JVMCI
1734 if (compiler->is_jvmci()) {
1735 // JVMCI might not produce any stub sections
1736 if (offsets->value(CodeOffsets::Exceptions) != -1) {
1737 _exception_offset = code_offset() + offsets->value(CodeOffsets::Exceptions);
1738 } else {
1739 _exception_offset = -1;
1740 }
1741 if (offsets->value(CodeOffsets::Deopt) != -1) {
1742 _deopt_handler_entry_offset = code_offset() + offsets->value(CodeOffsets::Deopt);
1743 } else {
1744 _deopt_handler_entry_offset = -1;
1745 }
1746 } else
1747 #endif
1748 {
1749 // Exception handler and deopt handler are in the stub section
1750 assert(offsets->value(CodeOffsets::Deopt ) != -1, "must be set");
1751
1752 bool has_exception_handler = (offsets->value(CodeOffsets::Exceptions) != -1);
1753 assert(has_exception_handler == (compiler->type() != compiler_c2),
1754 "C2 compiler doesn't provide exception handler stub code.");
1755 if (has_exception_handler) {
1756 _exception_offset = _stub_offset + offsets->value(CodeOffsets::Exceptions);
1757 } else {
1758 _exception_offset = -1;
1759 }
1760
1761 _deopt_handler_entry_offset = _stub_offset + offsets->value(CodeOffsets::Deopt);
1762 }
1763 if (offsets->value(CodeOffsets::UnwindHandler) != -1) {
1764 // C1 generates UnwindHandler at the end of instructions section.
1765 // Calculate positive offset as distance between the start of stubs section
1766 // (which is also the end of instructions section) and the start of the handler.
1767 int unwind_handler_offset = code_offset() + offsets->value(CodeOffsets::UnwindHandler);
1768 CHECKED_CAST(_unwind_handler_offset, int16_t, (_stub_offset - unwind_handler_offset));
1769 } else {
1770 _unwind_handler_offset = -1;
1771 }
1772
1773 CHECKED_CAST(_oops_size, uint16_t, align_up(code_buffer->total_oop_size(), oopSize));
1774 uint16_t metadata_size;
1775 CHECKED_CAST(metadata_size, uint16_t, align_up(code_buffer->total_metadata_size(), wordSize));
1776 JVMCI_ONLY( _metadata_size = metadata_size; )
1777 int jvmci_data_size = 0 JVMCI_ONLY( + align_up(compiler->is_jvmci() ? jvmci_data->size() : 0, oopSize));
1778 if (offsets->value(CodeOffsets::Inline_Entry) != CodeOffsets::no_such_entry_point) {
1779 CHECKED_CAST(_inline_entry_offset , uint16_t, offsets->value(CodeOffsets::Inline_Entry));
1780 }
1781 if (offsets->value(CodeOffsets::Verified_Inline_Entry) != CodeOffsets::no_such_entry_point) {
1782 CHECKED_CAST(_verified_inline_entry_offset , uint16_t, offsets->value(CodeOffsets::Verified_Inline_Entry));
1783 }
1784 if (offsets->value(CodeOffsets::Verified_Inline_Entry_RO) != CodeOffsets::no_such_entry_point) {
1785 CHECKED_CAST(_verified_inline_ro_entry_offset, uint16_t, offsets->value(CodeOffsets::Verified_Inline_Entry_RO));
1786 }
1787
1788 assert(_mutable_data_size == _relocation_size + metadata_size + jvmci_data_size,
1789 "wrong mutable data size: %d != %d + %d + %d",
1790 _mutable_data_size, _relocation_size, metadata_size, jvmci_data_size);
1791 assert(nmethod_size == data_end() - header_begin(), "wrong nmethod size: %d != %d",
1792 nmethod_size, (int)(code_end() - header_begin()));
1793
1794 _immutable_data_size = immutable_data_size;
1795 if (immutable_data_size > 0) {
1796 assert(immutable_data != nullptr, "required");
1797 _immutable_data = immutable_data;
1798 } else {
1799 // We need unique not null address
1800 _immutable_data = blob_end();
1801 }
1802 CHECKED_CAST(_nul_chk_table_offset, uint16_t, (align_up((int)dependencies->size_in_bytes(), oopSize)));
1803 CHECKED_CAST(_handler_table_offset, uint16_t, (_nul_chk_table_offset + align_up(nul_chk_table->size_in_bytes(), oopSize)));
1804 _scopes_pcs_offset = _handler_table_offset + align_up(handler_table->size_in_bytes(), oopSize);
1805 _scopes_data_offset = _scopes_pcs_offset + adjust_pcs_size(debug_info->pcs_size());
1806
1807 #if INCLUDE_JVMCI
1808 _speculations_offset = _scopes_data_offset + align_up(debug_info->data_size(), oopSize);
1809 _immutable_data_ref_count_offset = _speculations_offset + align_up(speculations_len, oopSize);
1810 #else
1811 _immutable_data_ref_count_offset = _scopes_data_offset + align_up(debug_info->data_size(), oopSize);
1812 #endif
1813 DEBUG_ONLY( int immutable_data_end_offset = _immutable_data_ref_count_offset + ImmutableDataRefCountSize; )
1814 assert(immutable_data_end_offset <= immutable_data_size, "wrong read-only data size: %d > %d",
1815 immutable_data_end_offset, immutable_data_size);
1816
1817 // Copy code and relocation info
1818 code_buffer->copy_code_and_locs_to(this);
1819 // Copy oops and metadata
1820 code_buffer->copy_values_to(this);
1821 dependencies->copy_to(this);
1822 // Copy PcDesc and ScopeDesc data
1823 debug_info->copy_to(this);
1824
1825 // Create cache after PcDesc data is copied - it will be used to initialize cache
1826 _pc_desc_container = new PcDescContainer(scopes_pcs_begin());
1827
1828 #if INCLUDE_JVMCI
1829 if (compiler->is_jvmci()) {
1830 // Initialize the JVMCINMethodData object inlined into nm
1831 jvmci_nmethod_data()->copy(jvmci_data);
1832 }
1833 #endif
1834
1835 // Copy contents of ExceptionHandlerTable to nmethod
1836 handler_table->copy_to(this);
1837 nul_chk_table->copy_to(this);
1838
1839 #if INCLUDE_JVMCI
1840 // Copy speculations to nmethod
1841 if (speculations_size() != 0) {
1842 memcpy(speculations_begin(), speculations, speculations_len);
1843 }
1844 #endif
1845 init_immutable_data_ref_count();
1846
1847 post_init();
1848
1849 // we use the information of entry points to find out if a method is
1850 // static or non static
1851 assert(compiler->is_c2() || compiler->is_jvmci() ||
1852 _method->is_static() == (entry_point() == verified_entry_point()),
1853 " entry points must be same for static methods and vice versa");
1854 }
1855 }
1856
1857 // Print a short set of xml attributes to identify this nmethod. The
1858 // output should be embedded in some other element.
1859 void nmethod::log_identity(xmlStream* log) const {
1860 log->print(" compile_id='%d'", compile_id());
1861 const char* nm_kind = compile_kind();
1862 if (nm_kind != nullptr) log->print(" compile_kind='%s'", nm_kind);
1863 log->print(" compiler='%s'", compiler_name());
1864 if (TieredCompilation) {
1865 log->print(" level='%d'", comp_level());
1866 }
1867 #if INCLUDE_JVMCI
1868 if (jvmci_nmethod_data() != nullptr) {
1869 const char* jvmci_name = jvmci_nmethod_data()->name();
1870 if (jvmci_name != nullptr) {
1871 log->print(" jvmci_mirror_name='");
1872 log->text("%s", jvmci_name);
1873 log->print("'");
1874 }
1875 }
1876 #endif
1877 }
1878
1879
1880 #define LOG_OFFSET(log, name) \
1881 if (p2i(name##_end()) - p2i(name##_begin())) \
1882 log->print(" " XSTR(name) "_offset='%zd'" , \
1883 p2i(name##_begin()) - p2i(this))
1884
1885
1886 void nmethod::log_new_nmethod() const {
1887 if (LogCompilation && xtty != nullptr) {
1888 ttyLocker ttyl;
1889 xtty->begin_elem("nmethod");
1890 log_identity(xtty);
1891 xtty->print(" entry='" INTPTR_FORMAT "' size='%d'", p2i(code_begin()), size());
1892 xtty->print(" address='" INTPTR_FORMAT "'", p2i(this));
1893
1894 LOG_OFFSET(xtty, relocation);
1895 LOG_OFFSET(xtty, consts);
1896 LOG_OFFSET(xtty, insts);
1897 LOG_OFFSET(xtty, stub);
1898 LOG_OFFSET(xtty, scopes_data);
1899 LOG_OFFSET(xtty, scopes_pcs);
1900 LOG_OFFSET(xtty, dependencies);
1901 LOG_OFFSET(xtty, handler_table);
1902 LOG_OFFSET(xtty, nul_chk_table);
1903 LOG_OFFSET(xtty, oops);
1904 LOG_OFFSET(xtty, metadata);
1905
1906 xtty->method(method());
1907 xtty->stamp();
1908 xtty->end_elem();
1909 }
1910 }
1911
1912
1913 void nmethod::log_relocated_nmethod(nmethod* original) const {
1914 if (LogCompilation && xtty != nullptr) {
1915 ttyLocker ttyl;
1916 xtty->begin_elem("relocated nmethod");
1917 log_identity(xtty);
1918 xtty->print(" entry='" INTPTR_FORMAT "' size='%d'", p2i(code_begin()), size());
1919
1920 const char* original_code_heap_name = CodeCache::get_code_heap_name(CodeCache::get_code_blob_type(original));
1921 xtty->print(" original_address='" INTPTR_FORMAT "'", p2i(original));
1922 xtty->print(" original_code_heap='%s'", original_code_heap_name);
1923
1924 const char* new_code_heap_name = CodeCache::get_code_heap_name(CodeCache::get_code_blob_type(this));
1925 xtty->print(" new_address='" INTPTR_FORMAT "'", p2i(this));
1926 xtty->print(" new_code_heap='%s'", new_code_heap_name);
1927
1928 LOG_OFFSET(xtty, relocation);
1929 LOG_OFFSET(xtty, consts);
1930 LOG_OFFSET(xtty, insts);
1931 LOG_OFFSET(xtty, stub);
1932 LOG_OFFSET(xtty, scopes_data);
1933 LOG_OFFSET(xtty, scopes_pcs);
1934 LOG_OFFSET(xtty, dependencies);
1935 LOG_OFFSET(xtty, handler_table);
1936 LOG_OFFSET(xtty, nul_chk_table);
1937 LOG_OFFSET(xtty, oops);
1938 LOG_OFFSET(xtty, metadata);
1939
1940 xtty->method(method());
1941 xtty->stamp();
1942 xtty->end_elem();
1943 }
1944 }
1945
1946 #undef LOG_OFFSET
1947
1948
1949 // Print out more verbose output usually for a newly created nmethod.
1950 void nmethod::print_on_with_msg(outputStream* st, const char* msg) const {
1951 if (st != nullptr) {
1952 ttyLocker ttyl;
1953 if (WizardMode) {
1954 CompileTask::print(st, this, msg, /*short_form:*/ true);
1955 st->print_cr(" (" INTPTR_FORMAT ")", p2i(this));
1956 } else {
1957 CompileTask::print(st, this, msg, /*short_form:*/ false);
1958 }
1959 }
1960 }
1961
1962 void nmethod::maybe_print_nmethod(const DirectiveSet* directive) {
1963 bool printnmethods = directive->PrintAssemblyOption || directive->PrintNMethodsOption;
1964 if (printnmethods || PrintDebugInfo || PrintRelocations || PrintDependencies || PrintExceptionHandlers) {
1965 print_nmethod(printnmethods);
1966 }
1967 }
1968
1969 void nmethod::print_nmethod(bool printmethod) {
1970 ttyLocker ttyl; // keep the following output all in one block
1971 if (xtty != nullptr) {
1972 xtty->begin_head("print_nmethod");
1973 log_identity(xtty);
1974 xtty->stamp();
1975 xtty->end_head();
1976 }
1977 // Print the header part, then print the requested information.
1978 // This is both handled in decode2().
1979 if (printmethod) {
1980 ResourceMark m;
1981 if (is_compiled_by_c1()) {
1982 tty->cr();
1983 tty->print_cr("============================= C1-compiled nmethod ==============================");
1984 }
1985 if (is_compiled_by_jvmci()) {
1986 tty->cr();
1987 tty->print_cr("=========================== JVMCI-compiled nmethod =============================");
1988 }
1989 tty->print_cr("----------------------------------- Assembly -----------------------------------");
1990 decode2(tty);
1991 #if defined(SUPPORT_DATA_STRUCTS)
1992 if (AbstractDisassembler::show_structs()) {
1993 // Print the oops from the underlying CodeBlob as well.
1994 tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
1995 print_oops(tty);
1996 tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
1997 print_metadata(tty);
1998 tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
1999 print_pcs_on(tty);
2000 tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
2001 if (oop_maps() != nullptr) {
2002 tty->print("oop maps:"); // oop_maps()->print_on(tty) outputs a cr() at the beginning
2003 oop_maps()->print_on(tty);
2004 tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
2005 }
2006 }
2007 #endif
2008 } else {
2009 print(); // print the header part only.
2010 }
2011
2012 #if defined(SUPPORT_DATA_STRUCTS)
2013 if (AbstractDisassembler::show_structs()) {
2014 methodHandle mh(Thread::current(), _method);
2015 if (printmethod || PrintDebugInfo || CompilerOracle::has_option(mh, CompileCommandEnum::PrintDebugInfo)) {
2016 print_scopes();
2017 tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
2018 }
2019 if (printmethod || PrintRelocations || CompilerOracle::has_option(mh, CompileCommandEnum::PrintRelocations)) {
2020 print_relocations();
2021 tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
2022 }
2023 if (printmethod || PrintDependencies || CompilerOracle::has_option(mh, CompileCommandEnum::PrintDependencies)) {
2024 print_dependencies_on(tty);
2025 tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
2026 }
2027 if (printmethod || PrintExceptionHandlers) {
2028 print_handler_table();
2029 tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
2030 print_nul_chk_table();
2031 tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
2032 }
2033
2034 if (printmethod) {
2035 print_recorded_oops();
2036 tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
2037 print_recorded_metadata();
2038 tty->print_cr("- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ");
2039 }
2040 }
2041 #endif
2042
2043 if (xtty != nullptr) {
2044 xtty->tail("print_nmethod");
2045 }
2046 }
2047
2048
2049 // Promote one word from an assembly-time handle to a live embedded oop.
2050 inline void nmethod::initialize_immediate_oop(oop* dest, jobject handle) {
2051 if (handle == nullptr ||
2052 // As a special case, IC oops are initialized to 1 or -1.
2053 handle == (jobject) Universe::non_oop_word()) {
2054 *(void**)dest = handle;
2055 } else {
2056 *dest = JNIHandles::resolve_non_null(handle);
2057 }
2058 }
2059
2060
2061 // Have to have the same name because it's called by a template
2062 void nmethod::copy_values(GrowableArray<jobject>* array) {
2063 int length = array->length();
2064 assert((address)(oops_begin() + length) <= (address)oops_end(), "oops big enough");
2065 oop* dest = oops_begin();
2066 for (int index = 0 ; index < length; index++) {
2067 initialize_immediate_oop(&dest[index], array->at(index));
2068 }
2069
2070 // Now we can fix up all the oops in the code. We need to do this
2071 // in the code because the assembler uses jobjects as placeholders.
2072 // The code and relocations have already been initialized by the
2073 // CodeBlob constructor, so it is valid even at this early point to
2074 // iterate over relocations and patch the code.
2075 fix_oop_relocations(nullptr, nullptr, /*initialize_immediates=*/ true);
2076 }
2077
2078 void nmethod::copy_values(GrowableArray<Metadata*>* array) {
2079 int length = array->length();
2080 assert((address)(metadata_begin() + length) <= (address)metadata_end(), "big enough");
2081 Metadata** dest = metadata_begin();
2082 for (int index = 0 ; index < length; index++) {
2083 dest[index] = array->at(index);
2084 }
2085 }
2086
2087 void nmethod::fix_oop_relocations(address begin, address end, bool initialize_immediates) {
2088 // re-patch all oop-bearing instructions, just in case some oops moved
2089 RelocIterator iter(this, begin, end);
2090 while (iter.next()) {
2091 if (iter.type() == relocInfo::oop_type) {
2092 oop_Relocation* reloc = iter.oop_reloc();
2093 if (initialize_immediates && reloc->oop_is_immediate()) {
2094 oop* dest = reloc->oop_addr();
2095 jobject obj = *reinterpret_cast<jobject*>(dest);
2096 initialize_immediate_oop(dest, obj);
2097 }
2098 // Refresh the oop-related bits of this instruction.
2099 reloc->fix_oop_relocation();
2100 } else if (iter.type() == relocInfo::metadata_type) {
2101 metadata_Relocation* reloc = iter.metadata_reloc();
2102 reloc->fix_metadata_relocation();
2103 }
2104 }
2105 }
2106
2107 static void install_post_call_nop_displacement(nmethod* nm, address pc) {
2108 NativePostCallNop* nop = nativePostCallNop_at((address) pc);
2109 intptr_t cbaddr = (intptr_t) nm;
2110 intptr_t offset = ((intptr_t) pc) - cbaddr;
2111
2112 int oopmap_slot = nm->oop_maps()->find_slot_for_offset(int((intptr_t) pc - (intptr_t) nm->code_begin()));
2113 if (oopmap_slot < 0) { // this can happen at asynchronous (non-safepoint) stackwalks
2114 log_debug(codecache)("failed to find oopmap for cb: " INTPTR_FORMAT " offset: %d", cbaddr, (int) offset);
2115 } else if (!nop->patch(oopmap_slot, offset)) {
2116 log_debug(codecache)("failed to encode %d %d", oopmap_slot, (int) offset);
2117 }
2118 }
2119
2120 void nmethod::finalize_relocations() {
2121 NoSafepointVerifier nsv;
2122
2123 GrowableArray<NativeMovConstReg*> virtual_call_data;
2124
2125 // Make sure that post call nops fill in nmethod offsets eagerly so
2126 // we don't have to race with deoptimization
2127 RelocIterator iter(this);
2128 while (iter.next()) {
2129 if (iter.type() == relocInfo::virtual_call_type) {
2130 virtual_call_Relocation* r = iter.virtual_call_reloc();
2131 NativeMovConstReg* value = nativeMovConstReg_at(r->cached_value());
2132 virtual_call_data.append(value);
2133 } else if (iter.type() == relocInfo::post_call_nop_type) {
2134 post_call_nop_Relocation* const reloc = iter.post_call_nop_reloc();
2135 address pc = reloc->addr();
2136 install_post_call_nop_displacement(this, pc);
2137 }
2138 }
2139
2140 if (virtual_call_data.length() > 0) {
2141 // We allocate a block of CompiledICData per nmethod so the GC can purge this faster.
2142 _compiled_ic_data = new CompiledICData[virtual_call_data.length()];
2143 CompiledICData* next_data = _compiled_ic_data;
2144
2145 for (NativeMovConstReg* value : virtual_call_data) {
2146 value->set_data((intptr_t)next_data);
2147 next_data++;
2148 }
2149 }
2150 }
2151
2152 void nmethod::make_deoptimized() {
2153 if (!Continuations::enabled()) {
2154 // Don't deopt this again.
2155 set_deoptimized_done();
2156 return;
2157 }
2158
2159 assert(method() == nullptr || can_be_deoptimized(), "");
2160
2161 CompiledICLocker ml(this);
2162 assert(CompiledICLocker::is_safe(this), "mt unsafe call");
2163
2164 // If post call nops have been already patched, we can just bail-out.
2165 if (has_been_deoptimized()) {
2166 return;
2167 }
2168
2169 ResourceMark rm;
2170 RelocIterator iter(this, oops_reloc_begin());
2171
2172 while (iter.next()) {
2173
2174 switch (iter.type()) {
2175 case relocInfo::virtual_call_type: {
2176 CompiledIC *ic = CompiledIC_at(&iter);
2177 address pc = ic->end_of_call();
2178 NativePostCallNop* nop = nativePostCallNop_at(pc);
2179 if (nop != nullptr) {
2180 nop->make_deopt();
2181 }
2182 assert(NativeDeoptInstruction::is_deopt_at(pc), "check");
2183 break;
2184 }
2185 case relocInfo::static_call_type:
2186 case relocInfo::opt_virtual_call_type: {
2187 CompiledDirectCall *csc = CompiledDirectCall::at(iter.reloc());
2188 address pc = csc->end_of_call();
2189 NativePostCallNop* nop = nativePostCallNop_at(pc);
2190 //tty->print_cr(" - static pc %p", pc);
2191 if (nop != nullptr) {
2192 nop->make_deopt();
2193 }
2194 // We can't assert here, there are some calls to stubs / runtime
2195 // that have reloc data and doesn't have a post call NOP.
2196 //assert(NativeDeoptInstruction::is_deopt_at(pc), "check");
2197 break;
2198 }
2199 default:
2200 break;
2201 }
2202 }
2203 // Don't deopt this again.
2204 set_deoptimized_done();
2205 }
2206
2207 void nmethod::verify_clean_inline_caches() {
2208 assert(CompiledICLocker::is_safe(this), "mt unsafe call");
2209
2210 ResourceMark rm;
2211 RelocIterator iter(this, oops_reloc_begin());
2212 while(iter.next()) {
2213 switch(iter.type()) {
2214 case relocInfo::virtual_call_type: {
2215 CompiledIC *ic = CompiledIC_at(&iter);
2216 CodeBlob *cb = CodeCache::find_blob(ic->destination());
2217 assert(cb != nullptr, "destination not in CodeBlob?");
2218 nmethod* nm = cb->as_nmethod_or_null();
2219 if (nm != nullptr) {
2220 // Verify that inline caches pointing to bad nmethods are clean
2221 if (!nm->is_in_use() || nm->is_unloading()) {
2222 assert(ic->is_clean(), "IC should be clean");
2223 }
2224 }
2225 break;
2226 }
2227 case relocInfo::static_call_type:
2228 case relocInfo::opt_virtual_call_type: {
2229 CompiledDirectCall *cdc = CompiledDirectCall::at(iter.reloc());
2230 CodeBlob *cb = CodeCache::find_blob(cdc->destination());
2231 assert(cb != nullptr, "destination not in CodeBlob?");
2232 nmethod* nm = cb->as_nmethod_or_null();
2233 if (nm != nullptr) {
2234 // Verify that inline caches pointing to bad nmethods are clean
2235 if (!nm->is_in_use() || nm->is_unloading() || nm->method()->code() != nm) {
2236 assert(cdc->is_clean(), "IC should be clean");
2237 }
2238 }
2239 break;
2240 }
2241 default:
2242 break;
2243 }
2244 }
2245 }
2246
2247 void nmethod::mark_as_maybe_on_stack() {
2248 AtomicAccess::store(&_gc_epoch, CodeCache::gc_epoch());
2249 }
2250
2251 bool nmethod::is_maybe_on_stack() {
2252 // If the condition below is true, it means that the nmethod was found to
2253 // be alive the previous completed marking cycle.
2254 return AtomicAccess::load(&_gc_epoch) >= CodeCache::previous_completed_gc_marking_cycle();
2255 }
2256
2257 void nmethod::inc_decompile_count() {
2258 if (!is_compiled_by_c2() && !is_compiled_by_jvmci()) return;
2259 // Could be gated by ProfileTraps, but do not bother...
2260 #if INCLUDE_JVMCI
2261 if (jvmci_skip_profile_deopt()) {
2262 return;
2263 }
2264 #endif
2265 Method* m = method();
2266 if (m == nullptr) return;
2267 MethodData* mdo = m->method_data();
2268 if (mdo == nullptr) return;
2269 // There is a benign race here. See comments in methodData.hpp.
2270 mdo->inc_decompile_count();
2271 }
2272
2273 bool nmethod::try_transition(signed char new_state_int) {
2274 signed char new_state = new_state_int;
2275 assert_lock_strong(NMethodState_lock);
2276 signed char old_state = _state;
2277 if (old_state >= new_state) {
2278 // Ensure monotonicity of transitions.
2279 return false;
2280 }
2281 AtomicAccess::store(&_state, new_state);
2282 return true;
2283 }
2284
2285 void nmethod::invalidate_osr_method() {
2286 assert(_entry_bci != InvocationEntryBci, "wrong kind of nmethod");
2287 // Remove from list of active nmethods
2288 if (method() != nullptr) {
2289 method()->method_holder()->remove_osr_nmethod(this);
2290 }
2291 }
2292
2293 void nmethod::log_state_change(InvalidationReason invalidation_reason) const {
2294 if (LogCompilation) {
2295 if (xtty != nullptr) {
2296 ttyLocker ttyl; // keep the following output all in one block
2297 xtty->begin_elem("make_not_entrant thread='%zu' reason='%s'",
2298 os::current_thread_id(), invalidation_reason_to_string(invalidation_reason));
2299 log_identity(xtty);
2300 xtty->stamp();
2301 xtty->end_elem();
2302 }
2303 }
2304
2305 ResourceMark rm;
2306 stringStream ss(NEW_RESOURCE_ARRAY(char, 256), 256);
2307 ss.print("made not entrant: %s", invalidation_reason_to_string(invalidation_reason));
2308
2309 CompileTask::print_ul(this, ss.freeze());
2310 if (PrintCompilation) {
2311 print_on_with_msg(tty, ss.freeze());
2312 }
2313 }
2314
2315 void nmethod::unlink_from_method() {
2316 if (method() != nullptr) {
2317 method()->unlink_code(this);
2318 }
2319 }
2320
2321 // Invalidate code
2322 bool nmethod::make_not_entrant(InvalidationReason invalidation_reason) {
2323 // This can be called while the system is already at a safepoint which is ok
2324 NoSafepointVerifier nsv;
2325
2326 if (is_unloading()) {
2327 // If the nmethod is unloading, then it is already not entrant through
2328 // the nmethod entry barriers. No need to do anything; GC will unload it.
2329 return false;
2330 }
2331
2332 if (AtomicAccess::load(&_state) == not_entrant) {
2333 // Avoid taking the lock if already in required state.
2334 // This is safe from races because the state is an end-state,
2335 // which the nmethod cannot back out of once entered.
2336 // No need for fencing either.
2337 return false;
2338 }
2339
2340 {
2341 // Enter critical section. Does not block for safepoint.
2342 ConditionalMutexLocker ml(NMethodState_lock, !NMethodState_lock->owned_by_self(), Mutex::_no_safepoint_check_flag);
2343
2344 if (AtomicAccess::load(&_state) == not_entrant) {
2345 // another thread already performed this transition so nothing
2346 // to do, but return false to indicate this.
2347 return false;
2348 }
2349
2350 if (is_osr_method()) {
2351 // This logic is equivalent to the logic below for patching the
2352 // verified entry point of regular methods.
2353 // this effectively makes the osr nmethod not entrant
2354 invalidate_osr_method();
2355 } else {
2356 // The caller can be calling the method statically or through an inline
2357 // cache call.
2358 BarrierSet::barrier_set()->barrier_set_nmethod()->make_not_entrant(this);
2359 }
2360
2361 if (update_recompile_counts()) {
2362 // Mark the method as decompiled.
2363 inc_decompile_count();
2364 }
2365
2366 BarrierSetNMethod* bs_nm = BarrierSet::barrier_set()->barrier_set_nmethod();
2367 if (bs_nm == nullptr || !bs_nm->supports_entry_barrier(this)) {
2368 // If nmethod entry barriers are not supported, we won't mark
2369 // nmethods as on-stack when they become on-stack. So we
2370 // degrade to a less accurate flushing strategy, for now.
2371 mark_as_maybe_on_stack();
2372 }
2373
2374 // Change state
2375 bool success = try_transition(not_entrant);
2376 assert(success, "Transition can't fail");
2377
2378 // Log the transition once
2379 log_state_change(invalidation_reason);
2380
2381 // Remove nmethod from method.
2382 unlink_from_method();
2383
2384 } // leave critical region under NMethodState_lock
2385
2386 #if INCLUDE_JVMCI
2387 // Invalidate can't occur while holding the NMethodState_lock
2388 JVMCINMethodData* nmethod_data = jvmci_nmethod_data();
2389 if (nmethod_data != nullptr) {
2390 nmethod_data->invalidate_nmethod_mirror(this, invalidation_reason);
2391 }
2392 #endif
2393
2394 #ifdef ASSERT
2395 if (is_osr_method() && method() != nullptr) {
2396 // Make sure osr nmethod is invalidated, i.e. not on the list
2397 bool found = method()->method_holder()->remove_osr_nmethod(this);
2398 assert(!found, "osr nmethod should have been invalidated");
2399 }
2400 #endif
2401
2402 return true;
2403 }
2404
2405 // For concurrent GCs, there must be a handshake between unlink and flush
2406 void nmethod::unlink() {
2407 if (is_unlinked()) {
2408 // Already unlinked.
2409 return;
2410 }
2411
2412 flush_dependencies();
2413
2414 // unlink_from_method will take the NMethodState_lock.
2415 // In this case we don't strictly need it when unlinking nmethods from
2416 // the Method, because it is only concurrently unlinked by
2417 // the entry barrier, which acquires the per nmethod lock.
2418 unlink_from_method();
2419
2420 if (is_osr_method()) {
2421 invalidate_osr_method();
2422 }
2423
2424 #if INCLUDE_JVMCI
2425 // Clear the link between this nmethod and a HotSpotNmethod mirror
2426 JVMCINMethodData* nmethod_data = jvmci_nmethod_data();
2427 if (nmethod_data != nullptr) {
2428 nmethod_data->invalidate_nmethod_mirror(this, is_cold() ?
2429 nmethod::InvalidationReason::UNLOADING_COLD :
2430 nmethod::InvalidationReason::UNLOADING);
2431 }
2432 #endif
2433
2434 // Post before flushing as jmethodID is being used
2435 post_compiled_method_unload();
2436
2437 // Register for flushing when it is safe. For concurrent class unloading,
2438 // that would be after the unloading handshake, and for STW class unloading
2439 // that would be when getting back to the VM thread.
2440 ClassUnloadingContext::context()->register_unlinked_nmethod(this);
2441 }
2442
2443 void nmethod::purge(bool unregister_nmethod) {
2444
2445 MutexLocker ml(CodeCache_lock, Mutex::_no_safepoint_check_flag);
2446
2447 // completely deallocate this method
2448 Events::log_nmethod_flush(Thread::current(), "flushing %s nmethod " INTPTR_FORMAT, is_osr_method() ? "osr" : "", p2i(this));
2449
2450 LogTarget(Debug, codecache) lt;
2451 if (lt.is_enabled()) {
2452 ResourceMark rm;
2453 LogStream ls(lt);
2454 const char* method_name = method()->name()->as_C_string();
2455 const size_t codecache_capacity = CodeCache::capacity()/1024;
2456 const size_t codecache_free_space = CodeCache::unallocated_capacity(CodeCache::get_code_blob_type(this))/1024;
2457 ls.print("Flushing nmethod %6d/" INTPTR_FORMAT ", level=%d, osr=%d, cold=%d, epoch=" UINT64_FORMAT ", cold_count=" UINT64_FORMAT ". "
2458 "Cache capacity: %zuKb, free space: %zuKb. method %s (%s)",
2459 _compile_id, p2i(this), _comp_level, is_osr_method(), is_cold(), _gc_epoch, CodeCache::cold_gc_count(),
2460 codecache_capacity, codecache_free_space, method_name, compiler_name());
2461 }
2462
2463 // We need to deallocate any ExceptionCache data.
2464 // Note that we do not need to grab the nmethod lock for this, it
2465 // better be thread safe if we're disposing of it!
2466 ExceptionCache* ec = exception_cache();
2467 while(ec != nullptr) {
2468 ExceptionCache* next = ec->next();
2469 delete ec;
2470 ec = next;
2471 }
2472 if (_pc_desc_container != nullptr) {
2473 delete _pc_desc_container;
2474 }
2475 delete[] _compiled_ic_data;
2476
2477 if (_immutable_data != blob_end()) {
2478 // Free memory if this was the last nmethod referencing immutable data
2479 if (dec_immutable_data_ref_count() == 0) {
2480 os::free(_immutable_data);
2481 }
2482
2483 _immutable_data = blob_end(); // Valid not null address
2484 }
2485
2486 if (unregister_nmethod) {
2487 Universe::heap()->unregister_nmethod(this);
2488 }
2489 CodeCache::unregister_old_nmethod(this);
2490
2491 JVMCI_ONLY( _metadata_size = 0; )
2492 CodeBlob::purge();
2493 }
2494
2495 oop nmethod::oop_at(int index) const {
2496 if (index == 0) {
2497 return nullptr;
2498 }
2499
2500 BarrierSetNMethod* bs_nm = BarrierSet::barrier_set()->barrier_set_nmethod();
2501 return bs_nm->oop_load_no_keepalive(this, index);
2502 }
2503
2504 oop nmethod::oop_at_phantom(int index) const {
2505 if (index == 0) {
2506 return nullptr;
2507 }
2508
2509 BarrierSetNMethod* bs_nm = BarrierSet::barrier_set()->barrier_set_nmethod();
2510 return bs_nm->oop_load_phantom(this, index);
2511 }
2512
2513 //
2514 // Notify all classes this nmethod is dependent on that it is no
2515 // longer dependent.
2516
2517 void nmethod::flush_dependencies() {
2518 if (!has_flushed_dependencies()) {
2519 set_has_flushed_dependencies(true);
2520 for (Dependencies::DepStream deps(this); deps.next(); ) {
2521 if (deps.type() == Dependencies::call_site_target_value) {
2522 // CallSite dependencies are managed on per-CallSite instance basis.
2523 oop call_site = deps.argument_oop(0);
2524 MethodHandles::clean_dependency_context(call_site);
2525 } else {
2526 InstanceKlass* ik = deps.context_type();
2527 if (ik == nullptr) {
2528 continue; // ignore things like evol_method
2529 }
2530 // During GC liveness of dependee determines class that needs to be updated.
2531 // The GC may clean dependency contexts concurrently and in parallel.
2532 ik->clean_dependency_context();
2533 }
2534 }
2535 }
2536 }
2537
2538 void nmethod::post_compiled_method(CompileTask* task) {
2539 task->mark_success();
2540 task->set_nm_content_size(content_size());
2541 task->set_nm_insts_size(insts_size());
2542 task->set_nm_total_size(total_size());
2543
2544 // JVMTI -- compiled method notification (must be done outside lock)
2545 post_compiled_method_load_event();
2546
2547 if (CompilationLog::log() != nullptr) {
2548 CompilationLog::log()->log_nmethod(JavaThread::current(), this);
2549 }
2550
2551 const DirectiveSet* directive = task->directive();
2552 maybe_print_nmethod(directive);
2553 }
2554
2555 #if INCLUDE_CDS
2556 static GrowableArrayCHeap<nmethod*, mtClassShared>* _delayed_compiled_method_load_events = nullptr;
2557
2558 void nmethod::add_delayed_compiled_method_load_event(nmethod* nm) {
2559 precond(CDSConfig::is_using_aot_linked_classes());
2560 precond(!ServiceThread::has_started());
2561
2562 // We are still in single threaded stage of VM bootstrap. No need to lock.
2563 if (_delayed_compiled_method_load_events == nullptr) {
2564 _delayed_compiled_method_load_events = new GrowableArrayCHeap<nmethod*, mtClassShared>();
2565 }
2566 _delayed_compiled_method_load_events->append(nm);
2567 }
2568
2569 void nmethod::post_delayed_compiled_method_load_events() {
2570 precond(ServiceThread::has_started());
2571 if (_delayed_compiled_method_load_events != nullptr) {
2572 for (int i = 0; i < _delayed_compiled_method_load_events->length(); i++) {
2573 nmethod* nm = _delayed_compiled_method_load_events->at(i);
2574 nm->post_compiled_method_load_event();
2575 }
2576 delete _delayed_compiled_method_load_events;
2577 _delayed_compiled_method_load_events = nullptr;
2578 }
2579 }
2580 #endif
2581
2582 // ------------------------------------------------------------------
2583 // post_compiled_method_load_event
2584 // new method for install_code() path
2585 // Transfer information from compilation to jvmti
2586 void nmethod::post_compiled_method_load_event(JvmtiThreadState* state) {
2587 #if INCLUDE_CDS
2588 if (!ServiceThread::has_started()) {
2589 // With AOT-linked classes, we could compile wrappers for native methods before the
2590 // ServiceThread has been started, so we must delay the events to be posted later.
2591 assert(state == nullptr, "must be");
2592 add_delayed_compiled_method_load_event(this);
2593 return;
2594 }
2595 #endif
2596
2597 // This is a bad time for a safepoint. We don't want
2598 // this nmethod to get unloaded while we're queueing the event.
2599 NoSafepointVerifier nsv;
2600
2601 Method* m = method();
2602 HOTSPOT_COMPILED_METHOD_LOAD(
2603 (char *) m->klass_name()->bytes(),
2604 m->klass_name()->utf8_length(),
2605 (char *) m->name()->bytes(),
2606 m->name()->utf8_length(),
2607 (char *) m->signature()->bytes(),
2608 m->signature()->utf8_length(),
2609 insts_begin(), insts_size());
2610
2611
2612 if (JvmtiExport::should_post_compiled_method_load()) {
2613 // Only post unload events if load events are found.
2614 set_load_reported();
2615 // If a JavaThread hasn't been passed in, let the Service thread
2616 // (which is a real Java thread) post the event
2617 JvmtiDeferredEvent event = JvmtiDeferredEvent::compiled_method_load_event(this);
2618 if (state == nullptr) {
2619 // Execute any barrier code for this nmethod as if it's called, since
2620 // keeping it alive looks like stack walking.
2621 run_nmethod_entry_barrier();
2622 ServiceThread::enqueue_deferred_event(&event);
2623 } else {
2624 // This enters the nmethod barrier outside in the caller.
2625 state->enqueue_event(&event);
2626 }
2627 }
2628 }
2629
2630 void nmethod::post_compiled_method_unload() {
2631 assert(_method != nullptr, "just checking");
2632 DTRACE_METHOD_UNLOAD_PROBE(method());
2633
2634 // If a JVMTI agent has enabled the CompiledMethodUnload event then
2635 // post the event. The Method* will not be valid when this is freed.
2636
2637 // Don't bother posting the unload if the load event wasn't posted.
2638 if (load_reported() && JvmtiExport::should_post_compiled_method_unload()) {
2639 JvmtiDeferredEvent event =
2640 JvmtiDeferredEvent::compiled_method_unload_event(
2641 method()->jmethod_id(), insts_begin());
2642 ServiceThread::enqueue_deferred_event(&event);
2643 }
2644 }
2645
2646 // Iterate over metadata calling this function. Used by RedefineClasses
2647 void nmethod::metadata_do(MetadataClosure* f) {
2648 {
2649 // Visit all immediate references that are embedded in the instruction stream.
2650 RelocIterator iter(this, oops_reloc_begin());
2651 while (iter.next()) {
2652 if (iter.type() == relocInfo::metadata_type) {
2653 metadata_Relocation* r = iter.metadata_reloc();
2654 // In this metadata, we must only follow those metadatas directly embedded in
2655 // the code. Other metadatas (oop_index>0) are seen as part of
2656 // the metadata section below.
2657 assert(1 == (r->metadata_is_immediate()) +
2658 (r->metadata_addr() >= metadata_begin() && r->metadata_addr() < metadata_end()),
2659 "metadata must be found in exactly one place");
2660 if (r->metadata_is_immediate() && r->metadata_value() != nullptr) {
2661 Metadata* md = r->metadata_value();
2662 if (md != _method) f->do_metadata(md);
2663 }
2664 } else if (iter.type() == relocInfo::virtual_call_type) {
2665 // Check compiledIC holders associated with this nmethod
2666 ResourceMark rm;
2667 CompiledIC *ic = CompiledIC_at(&iter);
2668 ic->metadata_do(f);
2669 }
2670 }
2671 }
2672
2673 // Visit the metadata section
2674 for (Metadata** p = metadata_begin(); p < metadata_end(); p++) {
2675 if (*p == Universe::non_oop_word() || *p == nullptr) continue; // skip non-oops
2676 Metadata* md = *p;
2677 f->do_metadata(md);
2678 }
2679
2680 // Visit metadata not embedded in the other places.
2681 if (_method != nullptr) f->do_metadata(_method);
2682 }
2683
2684 // Heuristic for nuking nmethods even though their oops are live.
2685 // Main purpose is to reduce code cache pressure and get rid of
2686 // nmethods that don't seem to be all that relevant any longer.
2687 bool nmethod::is_cold() {
2688 if (!MethodFlushing || is_not_installed()) {
2689 // No heuristic unloading at all
2690 return false;
2691 }
2692
2693 if (!is_maybe_on_stack() && is_not_entrant()) {
2694 // Not entrant nmethods that are not on any stack can just
2695 // be removed
2696 return true;
2697 }
2698
2699 BarrierSetNMethod* bs_nm = BarrierSet::barrier_set()->barrier_set_nmethod();
2700 if (bs_nm == nullptr || !bs_nm->supports_entry_barrier(this)) {
2701 // On platforms that don't support nmethod entry barriers, we can't
2702 // trust the temporal aspect of the gc epochs. So we can't detect
2703 // cold nmethods on such platforms.
2704 return false;
2705 }
2706
2707 if (!UseCodeCacheFlushing) {
2708 // Bail out if we don't heuristically remove nmethods
2709 return false;
2710 }
2711
2712 // Other code can be phased out more gradually after N GCs
2713 return CodeCache::previous_completed_gc_marking_cycle() > _gc_epoch + 2 * CodeCache::cold_gc_count();
2714 }
2715
2716 // The _is_unloading_state encodes a tuple comprising the unloading cycle
2717 // and the result of IsUnloadingBehaviour::is_unloading() for that cycle.
2718 // This is the bit layout of the _is_unloading_state byte: 00000CCU
2719 // CC refers to the cycle, which has 2 bits, and U refers to the result of
2720 // IsUnloadingBehaviour::is_unloading() for that unloading cycle.
2721
2722 class IsUnloadingState: public AllStatic {
2723 static const uint8_t _is_unloading_mask = 1;
2724 static const uint8_t _is_unloading_shift = 0;
2725 static const uint8_t _unloading_cycle_mask = 6;
2726 static const uint8_t _unloading_cycle_shift = 1;
2727
2728 static uint8_t set_is_unloading(uint8_t state, bool value) {
2729 state &= (uint8_t)~_is_unloading_mask;
2730 if (value) {
2731 state |= 1 << _is_unloading_shift;
2732 }
2733 assert(is_unloading(state) == value, "unexpected unloading cycle overflow");
2734 return state;
2735 }
2736
2737 static uint8_t set_unloading_cycle(uint8_t state, uint8_t value) {
2738 state &= (uint8_t)~_unloading_cycle_mask;
2739 state |= (uint8_t)(value << _unloading_cycle_shift);
2740 assert(unloading_cycle(state) == value, "unexpected unloading cycle overflow");
2741 return state;
2742 }
2743
2744 public:
2745 static bool is_unloading(uint8_t state) { return (state & _is_unloading_mask) >> _is_unloading_shift == 1; }
2746 static uint8_t unloading_cycle(uint8_t state) { return (state & _unloading_cycle_mask) >> _unloading_cycle_shift; }
2747
2748 static uint8_t create(bool is_unloading, uint8_t unloading_cycle) {
2749 uint8_t state = 0;
2750 state = set_is_unloading(state, is_unloading);
2751 state = set_unloading_cycle(state, unloading_cycle);
2752 return state;
2753 }
2754 };
2755
2756 bool nmethod::is_unloading() {
2757 uint8_t state = AtomicAccess::load(&_is_unloading_state);
2758 bool state_is_unloading = IsUnloadingState::is_unloading(state);
2759 if (state_is_unloading) {
2760 return true;
2761 }
2762 uint8_t state_unloading_cycle = IsUnloadingState::unloading_cycle(state);
2763 uint8_t current_cycle = CodeCache::unloading_cycle();
2764 if (state_unloading_cycle == current_cycle) {
2765 return false;
2766 }
2767
2768 // The IsUnloadingBehaviour is responsible for calculating if the nmethod
2769 // should be unloaded. This can be either because there is a dead oop,
2770 // or because is_cold() heuristically determines it is time to unload.
2771 state_unloading_cycle = current_cycle;
2772 state_is_unloading = IsUnloadingBehaviour::is_unloading(this);
2773 uint8_t new_state = IsUnloadingState::create(state_is_unloading, state_unloading_cycle);
2774
2775 // Note that if an nmethod has dead oops, everyone will agree that the
2776 // nmethod is_unloading. However, the is_cold heuristics can yield
2777 // different outcomes, so we guard the computed result with a CAS
2778 // to ensure all threads have a shared view of whether an nmethod
2779 // is_unloading or not.
2780 uint8_t found_state = AtomicAccess::cmpxchg(&_is_unloading_state, state, new_state, memory_order_relaxed);
2781
2782 if (found_state == state) {
2783 // First to change state, we win
2784 return state_is_unloading;
2785 } else {
2786 // State already set, so use it
2787 return IsUnloadingState::is_unloading(found_state);
2788 }
2789 }
2790
2791 void nmethod::clear_unloading_state() {
2792 uint8_t state = IsUnloadingState::create(false, CodeCache::unloading_cycle());
2793 AtomicAccess::store(&_is_unloading_state, state);
2794 }
2795
2796
2797 // This is called at the end of the strong tracing/marking phase of a
2798 // GC to unload an nmethod if it contains otherwise unreachable
2799 // oops or is heuristically found to be not important.
2800 void nmethod::do_unloading(bool unloading_occurred) {
2801 // Make sure the oop's ready to receive visitors
2802 if (is_unloading()) {
2803 unlink();
2804 } else {
2805 unload_nmethod_caches(unloading_occurred);
2806 BarrierSetNMethod* bs_nm = BarrierSet::barrier_set()->barrier_set_nmethod();
2807 if (bs_nm != nullptr) {
2808 bs_nm->disarm(this);
2809 }
2810 }
2811 }
2812
2813 void nmethod::oops_do(OopClosure* f) {
2814 // Prevent extra code cache walk for platforms that don't have immediate oops.
2815 if (relocInfo::mustIterateImmediateOopsInCode()) {
2816 RelocIterator iter(this, oops_reloc_begin());
2817
2818 while (iter.next()) {
2819 if (iter.type() == relocInfo::oop_type ) {
2820 oop_Relocation* r = iter.oop_reloc();
2821 // In this loop, we must only follow those oops directly embedded in
2822 // the code. Other oops (oop_index>0) are seen as part of scopes_oops.
2823 assert(1 == (r->oop_is_immediate()) +
2824 (r->oop_addr() >= oops_begin() && r->oop_addr() < oops_end()),
2825 "oop must be found in exactly one place");
2826 if (r->oop_is_immediate() && r->oop_value() != nullptr) {
2827 f->do_oop(r->oop_addr());
2828 }
2829 }
2830 }
2831 }
2832
2833 // Scopes
2834 // This includes oop constants not inlined in the code stream.
2835 for (oop* p = oops_begin(); p < oops_end(); p++) {
2836 if (*p == Universe::non_oop_word()) continue; // skip non-oops
2837 f->do_oop(p);
2838 }
2839 }
2840
2841 void nmethod::follow_nmethod(OopIterateClosure* cl) {
2842 // Process oops in the nmethod
2843 oops_do(cl);
2844
2845 // CodeCache unloading support
2846 mark_as_maybe_on_stack();
2847
2848 BarrierSetNMethod* bs_nm = BarrierSet::barrier_set()->barrier_set_nmethod();
2849 bs_nm->disarm(this);
2850
2851 // There's an assumption made that this function is not used by GCs that
2852 // relocate objects, and therefore we don't call fix_oop_relocations.
2853 }
2854
2855 nmethod* volatile nmethod::_oops_do_mark_nmethods;
2856
2857 void nmethod::oops_do_log_change(const char* state) {
2858 LogTarget(Trace, gc, nmethod) lt;
2859 if (lt.is_enabled()) {
2860 LogStream ls(lt);
2861 CompileTask::print(&ls, this, state, true /* short_form */);
2862 }
2863 }
2864
2865 bool nmethod::oops_do_try_claim() {
2866 if (oops_do_try_claim_weak_request()) {
2867 nmethod* result = oops_do_try_add_to_list_as_weak_done();
2868 assert(result == nullptr, "adding to global list as weak done must always succeed.");
2869 return true;
2870 }
2871 return false;
2872 }
2873
2874 bool nmethod::oops_do_try_claim_weak_request() {
2875 assert(SafepointSynchronize::is_at_safepoint(), "only at safepoint");
2876
2877 if ((_oops_do_mark_link == nullptr) &&
2878 (AtomicAccess::replace_if_null(&_oops_do_mark_link, mark_link(this, claim_weak_request_tag)))) {
2879 oops_do_log_change("oops_do, mark weak request");
2880 return true;
2881 }
2882 return false;
2883 }
2884
2885 void nmethod::oops_do_set_strong_done(nmethod* old_head) {
2886 _oops_do_mark_link = mark_link(old_head, claim_strong_done_tag);
2887 }
2888
2889 nmethod::oops_do_mark_link* nmethod::oops_do_try_claim_strong_done() {
2890 assert(SafepointSynchronize::is_at_safepoint(), "only at safepoint");
2891
2892 oops_do_mark_link* old_next = AtomicAccess::cmpxchg(&_oops_do_mark_link, mark_link(nullptr, claim_weak_request_tag), mark_link(this, claim_strong_done_tag));
2893 if (old_next == nullptr) {
2894 oops_do_log_change("oops_do, mark strong done");
2895 }
2896 return old_next;
2897 }
2898
2899 nmethod::oops_do_mark_link* nmethod::oops_do_try_add_strong_request(nmethod::oops_do_mark_link* next) {
2900 assert(SafepointSynchronize::is_at_safepoint(), "only at safepoint");
2901 assert(next == mark_link(this, claim_weak_request_tag), "Should be claimed as weak");
2902
2903 oops_do_mark_link* old_next = AtomicAccess::cmpxchg(&_oops_do_mark_link, next, mark_link(this, claim_strong_request_tag));
2904 if (old_next == next) {
2905 oops_do_log_change("oops_do, mark strong request");
2906 }
2907 return old_next;
2908 }
2909
2910 bool nmethod::oops_do_try_claim_weak_done_as_strong_done(nmethod::oops_do_mark_link* next) {
2911 assert(SafepointSynchronize::is_at_safepoint(), "only at safepoint");
2912 assert(extract_state(next) == claim_weak_done_tag, "Should be claimed as weak done");
2913
2914 oops_do_mark_link* old_next = AtomicAccess::cmpxchg(&_oops_do_mark_link, next, mark_link(extract_nmethod(next), claim_strong_done_tag));
2915 if (old_next == next) {
2916 oops_do_log_change("oops_do, mark weak done -> mark strong done");
2917 return true;
2918 }
2919 return false;
2920 }
2921
2922 nmethod* nmethod::oops_do_try_add_to_list_as_weak_done() {
2923 assert(SafepointSynchronize::is_at_safepoint(), "only at safepoint");
2924
2925 assert(extract_state(_oops_do_mark_link) == claim_weak_request_tag ||
2926 extract_state(_oops_do_mark_link) == claim_strong_request_tag,
2927 "must be but is nmethod " PTR_FORMAT " %u", p2i(extract_nmethod(_oops_do_mark_link)), extract_state(_oops_do_mark_link));
2928
2929 nmethod* old_head = AtomicAccess::xchg(&_oops_do_mark_nmethods, this);
2930 // Self-loop if needed.
2931 if (old_head == nullptr) {
2932 old_head = this;
2933 }
2934 // Try to install end of list and weak done tag.
2935 if (AtomicAccess::cmpxchg(&_oops_do_mark_link, mark_link(this, claim_weak_request_tag), mark_link(old_head, claim_weak_done_tag)) == mark_link(this, claim_weak_request_tag)) {
2936 oops_do_log_change("oops_do, mark weak done");
2937 return nullptr;
2938 } else {
2939 return old_head;
2940 }
2941 }
2942
2943 void nmethod::oops_do_add_to_list_as_strong_done() {
2944 assert(SafepointSynchronize::is_at_safepoint(), "only at safepoint");
2945
2946 nmethod* old_head = AtomicAccess::xchg(&_oops_do_mark_nmethods, this);
2947 // Self-loop if needed.
2948 if (old_head == nullptr) {
2949 old_head = this;
2950 }
2951 assert(_oops_do_mark_link == mark_link(this, claim_strong_done_tag), "must be but is nmethod " PTR_FORMAT " state %u",
2952 p2i(extract_nmethod(_oops_do_mark_link)), extract_state(_oops_do_mark_link));
2953
2954 oops_do_set_strong_done(old_head);
2955 }
2956
2957 void nmethod::oops_do_process_weak(OopsDoProcessor* p) {
2958 if (!oops_do_try_claim_weak_request()) {
2959 // Failed to claim for weak processing.
2960 oops_do_log_change("oops_do, mark weak request fail");
2961 return;
2962 }
2963
2964 p->do_regular_processing(this);
2965
2966 nmethod* old_head = oops_do_try_add_to_list_as_weak_done();
2967 if (old_head == nullptr) {
2968 return;
2969 }
2970 oops_do_log_change("oops_do, mark weak done fail");
2971 // Adding to global list failed, another thread added a strong request.
2972 assert(extract_state(_oops_do_mark_link) == claim_strong_request_tag,
2973 "must be but is %u", extract_state(_oops_do_mark_link));
2974
2975 oops_do_log_change("oops_do, mark weak request -> mark strong done");
2976
2977 oops_do_set_strong_done(old_head);
2978 // Do missing strong processing.
2979 p->do_remaining_strong_processing(this);
2980 }
2981
2982 void nmethod::oops_do_process_strong(OopsDoProcessor* p) {
2983 oops_do_mark_link* next_raw = oops_do_try_claim_strong_done();
2984 if (next_raw == nullptr) {
2985 p->do_regular_processing(this);
2986 oops_do_add_to_list_as_strong_done();
2987 return;
2988 }
2989 // Claim failed. Figure out why and handle it.
2990 if (oops_do_has_weak_request(next_raw)) {
2991 oops_do_mark_link* old = next_raw;
2992 // Claim failed because being weak processed (state == "weak request").
2993 // Try to request deferred strong processing.
2994 next_raw = oops_do_try_add_strong_request(old);
2995 if (next_raw == old) {
2996 // Successfully requested deferred strong processing.
2997 return;
2998 }
2999 // Failed because of a concurrent transition. No longer in "weak request" state.
3000 }
3001 if (oops_do_has_any_strong_state(next_raw)) {
3002 // Already claimed for strong processing or requested for such.
3003 return;
3004 }
3005 if (oops_do_try_claim_weak_done_as_strong_done(next_raw)) {
3006 // Successfully claimed "weak done" as "strong done". Do the missing marking.
3007 p->do_remaining_strong_processing(this);
3008 return;
3009 }
3010 // Claim failed, some other thread got it.
3011 }
3012
3013 void nmethod::oops_do_marking_prologue() {
3014 assert_at_safepoint();
3015
3016 log_trace(gc, nmethod)("oops_do_marking_prologue");
3017 assert(_oops_do_mark_nmethods == nullptr, "must be empty");
3018 }
3019
3020 void nmethod::oops_do_marking_epilogue() {
3021 assert_at_safepoint();
3022
3023 nmethod* next = _oops_do_mark_nmethods;
3024 _oops_do_mark_nmethods = nullptr;
3025 if (next != nullptr) {
3026 nmethod* cur;
3027 do {
3028 cur = next;
3029 next = extract_nmethod(cur->_oops_do_mark_link);
3030 cur->_oops_do_mark_link = nullptr;
3031 DEBUG_ONLY(cur->verify_oop_relocations());
3032
3033 LogTarget(Trace, gc, nmethod) lt;
3034 if (lt.is_enabled()) {
3035 LogStream ls(lt);
3036 CompileTask::print(&ls, cur, "oops_do, unmark", /*short_form:*/ true);
3037 }
3038 // End if self-loop has been detected.
3039 } while (cur != next);
3040 }
3041 log_trace(gc, nmethod)("oops_do_marking_epilogue");
3042 }
3043
3044 inline bool includes(void* p, void* from, void* to) {
3045 return from <= p && p < to;
3046 }
3047
3048
3049 void nmethod::copy_scopes_pcs(PcDesc* pcs, int count) {
3050 assert(count >= 2, "must be sentinel values, at least");
3051
3052 #ifdef ASSERT
3053 // must be sorted and unique; we do a binary search in find_pc_desc()
3054 int prev_offset = pcs[0].pc_offset();
3055 assert(prev_offset == PcDesc::lower_offset_limit,
3056 "must start with a sentinel");
3057 for (int i = 1; i < count; i++) {
3058 int this_offset = pcs[i].pc_offset();
3059 assert(this_offset > prev_offset, "offsets must be sorted");
3060 prev_offset = this_offset;
3061 }
3062 assert(prev_offset == PcDesc::upper_offset_limit,
3063 "must end with a sentinel");
3064 #endif //ASSERT
3065
3066 int size = count * sizeof(PcDesc);
3067 assert(scopes_pcs_size() >= size, "oob");
3068 memcpy(scopes_pcs_begin(), pcs, size);
3069
3070 // Adjust the final sentinel downward.
3071 PcDesc* last_pc = &scopes_pcs_begin()[count-1];
3072 assert(last_pc->pc_offset() == PcDesc::upper_offset_limit, "sanity");
3073 last_pc->set_pc_offset(content_size() + 1);
3074 for (; last_pc + 1 < scopes_pcs_end(); last_pc += 1) {
3075 // Fill any rounding gaps with copies of the last record.
3076 last_pc[1] = last_pc[0];
3077 }
3078 // The following assert could fail if sizeof(PcDesc) is not
3079 // an integral multiple of oopSize (the rounding term).
3080 // If it fails, change the logic to always allocate a multiple
3081 // of sizeof(PcDesc), and fill unused words with copies of *last_pc.
3082 assert(last_pc + 1 == scopes_pcs_end(), "must match exactly");
3083 }
3084
3085 void nmethod::copy_scopes_data(u_char* buffer, int size) {
3086 assert(scopes_data_size() >= size, "oob");
3087 memcpy(scopes_data_begin(), buffer, size);
3088 }
3089
3090 #ifdef ASSERT
3091 static PcDesc* linear_search(int pc_offset, bool approximate, PcDesc* lower, PcDesc* upper) {
3092 PcDesc* res = nullptr;
3093 assert(lower != nullptr && lower->pc_offset() == PcDesc::lower_offset_limit,
3094 "must start with a sentinel");
3095 // lower + 1 to exclude initial sentinel
3096 for (PcDesc* p = lower + 1; p < upper; p++) {
3097 NOT_PRODUCT(--pc_nmethod_stats.pc_desc_tests); // don't count this call to match_desc
3098 if (match_desc(p, pc_offset, approximate)) {
3099 if (res == nullptr) {
3100 res = p;
3101 } else {
3102 res = (PcDesc*) badAddress;
3103 }
3104 }
3105 }
3106 return res;
3107 }
3108 #endif
3109
3110
3111 #ifndef PRODUCT
3112 // Version of method to collect statistic
3113 PcDesc* PcDescContainer::find_pc_desc(address pc, bool approximate, address code_begin,
3114 PcDesc* lower, PcDesc* upper) {
3115 ++pc_nmethod_stats.pc_desc_queries;
3116 if (approximate) ++pc_nmethod_stats.pc_desc_approx;
3117
3118 PcDesc* desc = _pc_desc_cache.last_pc_desc();
3119 assert(desc != nullptr, "PcDesc cache should be initialized already");
3120 if (desc->pc_offset() == (pc - code_begin)) {
3121 // Cached value matched
3122 ++pc_nmethod_stats.pc_desc_tests;
3123 ++pc_nmethod_stats.pc_desc_repeats;
3124 return desc;
3125 }
3126 return find_pc_desc_internal(pc, approximate, code_begin, lower, upper);
3127 }
3128 #endif
3129
3130 // Finds a PcDesc with real-pc equal to "pc"
3131 PcDesc* PcDescContainer::find_pc_desc_internal(address pc, bool approximate, address code_begin,
3132 PcDesc* lower_incl, PcDesc* upper_incl) {
3133 if ((pc < code_begin) ||
3134 (pc - code_begin) >= (ptrdiff_t) PcDesc::upper_offset_limit) {
3135 return nullptr; // PC is wildly out of range
3136 }
3137 int pc_offset = (int) (pc - code_begin);
3138
3139 // Check the PcDesc cache if it contains the desired PcDesc
3140 // (This as an almost 100% hit rate.)
3141 PcDesc* res = _pc_desc_cache.find_pc_desc(pc_offset, approximate);
3142 if (res != nullptr) {
3143 assert(res == linear_search(pc_offset, approximate, lower_incl, upper_incl), "cache ok");
3144 return res;
3145 }
3146
3147 // Fallback algorithm: quasi-linear search for the PcDesc
3148 // Find the last pc_offset less than the given offset.
3149 // The successor must be the required match, if there is a match at all.
3150 // (Use a fixed radix to avoid expensive affine pointer arithmetic.)
3151 PcDesc* lower = lower_incl; // this is initial sentinel
3152 PcDesc* upper = upper_incl - 1; // exclude final sentinel
3153 if (lower >= upper) return nullptr; // no PcDescs at all
3154
3155 #define assert_LU_OK \
3156 /* invariant on lower..upper during the following search: */ \
3157 assert(lower->pc_offset() < pc_offset, "sanity"); \
3158 assert(upper->pc_offset() >= pc_offset, "sanity")
3159 assert_LU_OK;
3160
3161 // Use the last successful return as a split point.
3162 PcDesc* mid = _pc_desc_cache.last_pc_desc();
3163 NOT_PRODUCT(++pc_nmethod_stats.pc_desc_searches);
3164 if (mid->pc_offset() < pc_offset) {
3165 lower = mid;
3166 } else {
3167 upper = mid;
3168 }
3169
3170 // Take giant steps at first (4096, then 256, then 16, then 1)
3171 const int LOG2_RADIX = 4 /*smaller steps in debug mode:*/ DEBUG_ONLY(-1);
3172 const int RADIX = (1 << LOG2_RADIX);
3173 for (int step = (1 << (LOG2_RADIX*3)); step > 1; step >>= LOG2_RADIX) {
3174 while ((mid = lower + step) < upper) {
3175 assert_LU_OK;
3176 NOT_PRODUCT(++pc_nmethod_stats.pc_desc_searches);
3177 if (mid->pc_offset() < pc_offset) {
3178 lower = mid;
3179 } else {
3180 upper = mid;
3181 break;
3182 }
3183 }
3184 assert_LU_OK;
3185 }
3186
3187 // Sneak up on the value with a linear search of length ~16.
3188 while (true) {
3189 assert_LU_OK;
3190 mid = lower + 1;
3191 NOT_PRODUCT(++pc_nmethod_stats.pc_desc_searches);
3192 if (mid->pc_offset() < pc_offset) {
3193 lower = mid;
3194 } else {
3195 upper = mid;
3196 break;
3197 }
3198 }
3199 #undef assert_LU_OK
3200
3201 if (match_desc(upper, pc_offset, approximate)) {
3202 assert(upper == linear_search(pc_offset, approximate, lower_incl, upper_incl), "search mismatch");
3203 if (!Thread::current_in_asgct()) {
3204 // we don't want to modify the cache if we're in ASGCT
3205 // which is typically called in a signal handler
3206 _pc_desc_cache.add_pc_desc(upper);
3207 }
3208 return upper;
3209 } else {
3210 assert(nullptr == linear_search(pc_offset, approximate, lower_incl, upper_incl), "search mismatch");
3211 return nullptr;
3212 }
3213 }
3214
3215 bool nmethod::check_dependency_on(DepChange& changes) {
3216 // What has happened:
3217 // 1) a new class dependee has been added
3218 // 2) dependee and all its super classes have been marked
3219 bool found_check = false; // set true if we are upset
3220 for (Dependencies::DepStream deps(this); deps.next(); ) {
3221 // Evaluate only relevant dependencies.
3222 if (deps.spot_check_dependency_at(changes) != nullptr) {
3223 found_check = true;
3224 NOT_DEBUG(break);
3225 }
3226 }
3227 return found_check;
3228 }
3229
3230 // Called from mark_for_deoptimization, when dependee is invalidated.
3231 bool nmethod::is_dependent_on_method(Method* dependee) {
3232 for (Dependencies::DepStream deps(this); deps.next(); ) {
3233 if (Dependencies::has_method_dep(deps.type())) {
3234 Method* method = deps.method_argument(0);
3235 if (method == dependee) return true;
3236 }
3237 }
3238 return false;
3239 }
3240
3241 void nmethod_init() {
3242 // make sure you didn't forget to adjust the filler fields
3243 assert(sizeof(nmethod) % oopSize == 0, "nmethod size must be multiple of a word");
3244 }
3245
3246 // -----------------------------------------------------------------------------
3247 // Verification
3248
3249 class VerifyOopsClosure: public OopClosure {
3250 nmethod* _nm;
3251 bool _ok;
3252 public:
3253 VerifyOopsClosure(nmethod* nm) : _nm(nm), _ok(true) { }
3254 bool ok() { return _ok; }
3255 virtual void do_oop(oop* p) {
3256 if (oopDesc::is_oop_or_null(*p)) return;
3257 // Print diagnostic information before calling print_nmethod().
3258 // Assertions therein might prevent call from returning.
3259 tty->print_cr("*** non-oop " PTR_FORMAT " found at " PTR_FORMAT " (offset %d)",
3260 p2i(*p), p2i(p), (int)((intptr_t)p - (intptr_t)_nm));
3261 if (_ok) {
3262 _nm->print_nmethod(true);
3263 _ok = false;
3264 }
3265 }
3266 virtual void do_oop(narrowOop* p) { ShouldNotReachHere(); }
3267 };
3268
3269 class VerifyMetadataClosure: public MetadataClosure {
3270 public:
3271 void do_metadata(Metadata* md) {
3272 if (md->is_method()) {
3273 Method* method = (Method*)md;
3274 assert(!method->is_old(), "Should not be installing old methods");
3275 }
3276 }
3277 };
3278
3279
3280 void nmethod::verify() {
3281 if (is_not_entrant())
3282 return;
3283
3284 // assert(oopDesc::is_oop(method()), "must be valid");
3285
3286 ResourceMark rm;
3287
3288 if (!CodeCache::contains(this)) {
3289 fatal("nmethod at " INTPTR_FORMAT " not in zone", p2i(this));
3290 }
3291
3292 if(is_native_method() )
3293 return;
3294
3295 nmethod* nm = CodeCache::find_nmethod(verified_entry_point());
3296 if (nm != this) {
3297 fatal("find_nmethod did not find this nmethod (" INTPTR_FORMAT ")", p2i(this));
3298 }
3299
3300 for (PcDesc* p = scopes_pcs_begin(); p < scopes_pcs_end(); p++) {
3301 if (! p->verify(this)) {
3302 tty->print_cr("\t\tin nmethod at " INTPTR_FORMAT " (pcs)", p2i(this));
3303 }
3304 }
3305
3306 #ifdef ASSERT
3307 #if INCLUDE_JVMCI
3308 {
3309 // Verify that implicit exceptions that deoptimize have a PcDesc and OopMap
3310 ImmutableOopMapSet* oms = oop_maps();
3311 ImplicitExceptionTable implicit_table(this);
3312 for (uint i = 0; i < implicit_table.len(); i++) {
3313 int exec_offset = (int) implicit_table.get_exec_offset(i);
3314 if (implicit_table.get_exec_offset(i) == implicit_table.get_cont_offset(i)) {
3315 assert(pc_desc_at(code_begin() + exec_offset) != nullptr, "missing PcDesc");
3316 bool found = false;
3317 for (int i = 0, imax = oms->count(); i < imax; i++) {
3318 if (oms->pair_at(i)->pc_offset() == exec_offset) {
3319 found = true;
3320 break;
3321 }
3322 }
3323 assert(found, "missing oopmap");
3324 }
3325 }
3326 }
3327 #endif
3328 #endif
3329
3330 VerifyOopsClosure voc(this);
3331 oops_do(&voc);
3332 assert(voc.ok(), "embedded oops must be OK");
3333 Universe::heap()->verify_nmethod(this);
3334
3335 assert(_oops_do_mark_link == nullptr, "_oops_do_mark_link for %s should be nullptr but is " PTR_FORMAT,
3336 nm->method()->external_name(), p2i(_oops_do_mark_link));
3337 verify_scopes();
3338
3339 CompiledICLocker nm_verify(this);
3340 VerifyMetadataClosure vmc;
3341 metadata_do(&vmc);
3342 }
3343
3344
3345 void nmethod::verify_interrupt_point(address call_site, bool is_inline_cache) {
3346
3347 // Verify IC only when nmethod installation is finished.
3348 if (!is_not_installed()) {
3349 if (CompiledICLocker::is_safe(this)) {
3350 if (is_inline_cache) {
3351 CompiledIC_at(this, call_site);
3352 } else {
3353 CompiledDirectCall::at(call_site);
3354 }
3355 } else {
3356 CompiledICLocker ml_verify(this);
3357 if (is_inline_cache) {
3358 CompiledIC_at(this, call_site);
3359 } else {
3360 CompiledDirectCall::at(call_site);
3361 }
3362 }
3363 }
3364
3365 HandleMark hm(Thread::current());
3366
3367 PcDesc* pd = pc_desc_at(nativeCall_at(call_site)->return_address());
3368 assert(pd != nullptr, "PcDesc must exist");
3369 for (ScopeDesc* sd = new ScopeDesc(this, pd);
3370 !sd->is_top(); sd = sd->sender()) {
3371 sd->verify();
3372 }
3373 }
3374
3375 void nmethod::verify_scopes() {
3376 if( !method() ) return; // Runtime stubs have no scope
3377 if (method()->is_native()) return; // Ignore stub methods.
3378 // iterate through all interrupt point
3379 // and verify the debug information is valid.
3380 RelocIterator iter(this);
3381 while (iter.next()) {
3382 address stub = nullptr;
3383 switch (iter.type()) {
3384 case relocInfo::virtual_call_type:
3385 verify_interrupt_point(iter.addr(), true /* is_inline_cache */);
3386 break;
3387 case relocInfo::opt_virtual_call_type:
3388 stub = iter.opt_virtual_call_reloc()->static_stub();
3389 verify_interrupt_point(iter.addr(), false /* is_inline_cache */);
3390 break;
3391 case relocInfo::static_call_type:
3392 stub = iter.static_call_reloc()->static_stub();
3393 verify_interrupt_point(iter.addr(), false /* is_inline_cache */);
3394 break;
3395 case relocInfo::runtime_call_type:
3396 case relocInfo::runtime_call_w_cp_type: {
3397 address destination = iter.reloc()->value();
3398 // Right now there is no way to find out which entries support
3399 // an interrupt point. It would be nice if we had this
3400 // information in a table.
3401 break;
3402 }
3403 default:
3404 break;
3405 }
3406 assert(stub == nullptr || stub_contains(stub), "static call stub outside stub section");
3407 }
3408 }
3409
3410
3411 // -----------------------------------------------------------------------------
3412 // Printing operations
3413
3414 void nmethod::print_on_impl(outputStream* st) const {
3415 ResourceMark rm;
3416
3417 st->print("Compiled method ");
3418
3419 if (is_compiled_by_c1()) {
3420 st->print("(c1) ");
3421 } else if (is_compiled_by_c2()) {
3422 st->print("(c2) ");
3423 } else if (is_compiled_by_jvmci()) {
3424 st->print("(JVMCI) ");
3425 } else {
3426 st->print("(n/a) ");
3427 }
3428
3429 print_on_with_msg(st, nullptr);
3430
3431 if (WizardMode) {
3432 st->print("((nmethod*) " INTPTR_FORMAT ") ", p2i(this));
3433 st->print(" for method " INTPTR_FORMAT , p2i(method()));
3434 st->print(" { ");
3435 st->print_cr("%s ", state());
3436 st->print_cr("}:");
3437 }
3438 if (size () > 0) st->print_cr(" total in heap [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
3439 p2i(this),
3440 p2i(this) + size(),
3441 size());
3442 if (consts_size () > 0) st->print_cr(" constants [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
3443 p2i(consts_begin()),
3444 p2i(consts_end()),
3445 consts_size());
3446 if (insts_size () > 0) st->print_cr(" main code [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
3447 p2i(insts_begin()),
3448 p2i(insts_end()),
3449 insts_size());
3450 if (stub_size () > 0) st->print_cr(" stub code [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
3451 p2i(stub_begin()),
3452 p2i(stub_end()),
3453 stub_size());
3454 if (oops_size () > 0) st->print_cr(" oops [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
3455 p2i(oops_begin()),
3456 p2i(oops_end()),
3457 oops_size());
3458 if (mutable_data_size() > 0) st->print_cr(" mutable data [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
3459 p2i(mutable_data_begin()),
3460 p2i(mutable_data_end()),
3461 mutable_data_size());
3462 if (relocation_size() > 0) st->print_cr(" relocation [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
3463 p2i(relocation_begin()),
3464 p2i(relocation_end()),
3465 relocation_size());
3466 if (metadata_size () > 0) st->print_cr(" metadata [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
3467 p2i(metadata_begin()),
3468 p2i(metadata_end()),
3469 metadata_size());
3470 #if INCLUDE_JVMCI
3471 if (jvmci_data_size () > 0) st->print_cr(" JVMCI data [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
3472 p2i(jvmci_data_begin()),
3473 p2i(jvmci_data_end()),
3474 jvmci_data_size());
3475 #endif
3476 if (immutable_data_size() > 0) st->print_cr(" immutable data [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
3477 p2i(immutable_data_begin()),
3478 p2i(immutable_data_end()),
3479 immutable_data_size());
3480 if (dependencies_size () > 0) st->print_cr(" dependencies [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
3481 p2i(dependencies_begin()),
3482 p2i(dependencies_end()),
3483 dependencies_size());
3484 if (nul_chk_table_size() > 0) st->print_cr(" nul chk table [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
3485 p2i(nul_chk_table_begin()),
3486 p2i(nul_chk_table_end()),
3487 nul_chk_table_size());
3488 if (handler_table_size() > 0) st->print_cr(" handler table [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
3489 p2i(handler_table_begin()),
3490 p2i(handler_table_end()),
3491 handler_table_size());
3492 if (scopes_pcs_size () > 0) st->print_cr(" scopes pcs [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
3493 p2i(scopes_pcs_begin()),
3494 p2i(scopes_pcs_end()),
3495 scopes_pcs_size());
3496 if (scopes_data_size () > 0) st->print_cr(" scopes data [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
3497 p2i(scopes_data_begin()),
3498 p2i(scopes_data_end()),
3499 scopes_data_size());
3500 #if INCLUDE_JVMCI
3501 if (speculations_size () > 0) st->print_cr(" speculations [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
3502 p2i(speculations_begin()),
3503 p2i(speculations_end()),
3504 speculations_size());
3505 #endif
3506 }
3507
3508 void nmethod::print_code() {
3509 ResourceMark m;
3510 ttyLocker ttyl;
3511 // Call the specialized decode method of this class.
3512 decode(tty);
3513 }
3514
3515 #ifndef PRODUCT // called InstanceKlass methods are available only then. Declared as PRODUCT_RETURN
3516
3517 void nmethod::print_dependencies_on(outputStream* out) {
3518 ResourceMark rm;
3519 stringStream st;
3520 st.print_cr("Dependencies:");
3521 for (Dependencies::DepStream deps(this); deps.next(); ) {
3522 deps.print_dependency(&st);
3523 InstanceKlass* ctxk = deps.context_type();
3524 if (ctxk != nullptr) {
3525 if (ctxk->is_dependent_nmethod(this)) {
3526 st.print_cr(" [nmethod<=klass]%s", ctxk->external_name());
3527 }
3528 }
3529 deps.log_dependency(); // put it into the xml log also
3530 }
3531 out->print_raw(st.as_string());
3532 }
3533 #endif
3534
3535 #if defined(SUPPORT_DATA_STRUCTS)
3536
3537 // Print the oops from the underlying CodeBlob.
3538 void nmethod::print_oops(outputStream* st) {
3539 ResourceMark m;
3540 st->print("Oops:");
3541 if (oops_begin() < oops_end()) {
3542 st->cr();
3543 for (oop* p = oops_begin(); p < oops_end(); p++) {
3544 Disassembler::print_location((unsigned char*)p, (unsigned char*)oops_begin(), (unsigned char*)oops_end(), st, true, false);
3545 st->print(PTR_FORMAT " ", *((uintptr_t*)p));
3546 if (Universe::contains_non_oop_word(p)) {
3547 st->print_cr("NON_OOP");
3548 continue; // skip non-oops
3549 }
3550 if (*p == nullptr) {
3551 st->print_cr("nullptr-oop");
3552 continue; // skip non-oops
3553 }
3554 (*p)->print_value_on(st);
3555 st->cr();
3556 }
3557 } else {
3558 st->print_cr(" <list empty>");
3559 }
3560 }
3561
3562 // Print metadata pool.
3563 void nmethod::print_metadata(outputStream* st) {
3564 ResourceMark m;
3565 st->print("Metadata:");
3566 if (metadata_begin() < metadata_end()) {
3567 st->cr();
3568 for (Metadata** p = metadata_begin(); p < metadata_end(); p++) {
3569 Disassembler::print_location((unsigned char*)p, (unsigned char*)metadata_begin(), (unsigned char*)metadata_end(), st, true, false);
3570 st->print(PTR_FORMAT " ", *((uintptr_t*)p));
3571 if (*p && *p != Universe::non_oop_word()) {
3572 (*p)->print_value_on(st);
3573 }
3574 st->cr();
3575 }
3576 } else {
3577 st->print_cr(" <list empty>");
3578 }
3579 }
3580
3581 #ifndef PRODUCT // ScopeDesc::print_on() is available only then. Declared as PRODUCT_RETURN
3582 void nmethod::print_scopes_on(outputStream* st) {
3583 // Find the first pc desc for all scopes in the code and print it.
3584 ResourceMark rm;
3585 st->print("scopes:");
3586 if (scopes_pcs_begin() < scopes_pcs_end()) {
3587 st->cr();
3588 for (PcDesc* p = scopes_pcs_begin(); p < scopes_pcs_end(); p++) {
3589 if (p->scope_decode_offset() == DebugInformationRecorder::serialized_null)
3590 continue;
3591
3592 ScopeDesc* sd = scope_desc_at(p->real_pc(this));
3593 while (sd != nullptr) {
3594 sd->print_on(st, p); // print output ends with a newline
3595 sd = sd->sender();
3596 }
3597 }
3598 } else {
3599 st->print_cr(" <list empty>");
3600 }
3601 }
3602 #endif
3603
3604 #ifndef PRODUCT // RelocIterator does support printing only then.
3605 void nmethod::print_relocations() {
3606 ResourceMark m; // in case methods get printed via the debugger
3607 tty->print_cr("relocations:");
3608 RelocIterator iter(this);
3609 iter.print_on(tty);
3610 }
3611 #endif
3612
3613 void nmethod::print_pcs_on(outputStream* st) {
3614 ResourceMark m; // in case methods get printed via debugger
3615 st->print("pc-bytecode offsets:");
3616 if (scopes_pcs_begin() < scopes_pcs_end()) {
3617 st->cr();
3618 for (PcDesc* p = scopes_pcs_begin(); p < scopes_pcs_end(); p++) {
3619 p->print_on(st, this); // print output ends with a newline
3620 }
3621 } else {
3622 st->print_cr(" <list empty>");
3623 }
3624 }
3625
3626 void nmethod::print_handler_table() {
3627 ExceptionHandlerTable(this).print(code_begin());
3628 }
3629
3630 void nmethod::print_nul_chk_table() {
3631 ImplicitExceptionTable(this).print(code_begin());
3632 }
3633
3634 void nmethod::print_recorded_oop(int log_n, int i) {
3635 void* value;
3636
3637 if (i == 0) {
3638 value = nullptr;
3639 } else {
3640 // Be careful around non-oop words. Don't create an oop
3641 // with that value, or it will assert in verification code.
3642 if (Universe::contains_non_oop_word(oop_addr_at(i))) {
3643 value = Universe::non_oop_word();
3644 } else {
3645 value = oop_at(i);
3646 }
3647 }
3648
3649 tty->print("#%*d: " INTPTR_FORMAT " ", log_n, i, p2i(value));
3650
3651 if (value == Universe::non_oop_word()) {
3652 tty->print("non-oop word");
3653 } else {
3654 if (value == nullptr) {
3655 tty->print("nullptr-oop");
3656 } else {
3657 oop_at(i)->print_value_on(tty);
3658 }
3659 }
3660
3661 tty->cr();
3662 }
3663
3664 void nmethod::print_recorded_oops() {
3665 const int n = oops_count();
3666 const int log_n = (n<10) ? 1 : (n<100) ? 2 : (n<1000) ? 3 : (n<10000) ? 4 : 6;
3667 tty->print("Recorded oops:");
3668 if (n > 0) {
3669 tty->cr();
3670 for (int i = 0; i < n; i++) {
3671 print_recorded_oop(log_n, i);
3672 }
3673 } else {
3674 tty->print_cr(" <list empty>");
3675 }
3676 }
3677
3678 void nmethod::print_recorded_metadata() {
3679 const int n = metadata_count();
3680 const int log_n = (n<10) ? 1 : (n<100) ? 2 : (n<1000) ? 3 : (n<10000) ? 4 : 6;
3681 tty->print("Recorded metadata:");
3682 if (n > 0) {
3683 tty->cr();
3684 for (int i = 0; i < n; i++) {
3685 Metadata* m = metadata_at(i);
3686 tty->print("#%*d: " INTPTR_FORMAT " ", log_n, i, p2i(m));
3687 if (m == (Metadata*)Universe::non_oop_word()) {
3688 tty->print("non-metadata word");
3689 } else if (m == nullptr) {
3690 tty->print("nullptr-oop");
3691 } else {
3692 Metadata::print_value_on_maybe_null(tty, m);
3693 }
3694 tty->cr();
3695 }
3696 } else {
3697 tty->print_cr(" <list empty>");
3698 }
3699 }
3700 #endif
3701
3702 #if defined(SUPPORT_ASSEMBLY) || defined(SUPPORT_ABSTRACT_ASSEMBLY)
3703
3704 void nmethod::print_constant_pool(outputStream* st) {
3705 //-----------------------------------
3706 //---< Print the constant pool >---
3707 //-----------------------------------
3708 int consts_size = this->consts_size();
3709 if ( consts_size > 0 ) {
3710 unsigned char* cstart = this->consts_begin();
3711 unsigned char* cp = cstart;
3712 unsigned char* cend = cp + consts_size;
3713 unsigned int bytes_per_line = 4;
3714 unsigned int CP_alignment = 8;
3715 unsigned int n;
3716
3717 st->cr();
3718
3719 //---< print CP header to make clear what's printed >---
3720 if( ((uintptr_t)cp&(CP_alignment-1)) == 0 ) {
3721 n = bytes_per_line;
3722 st->print_cr("[Constant Pool]");
3723 Disassembler::print_location(cp, cstart, cend, st, true, true);
3724 Disassembler::print_hexdata(cp, n, st, true);
3725 st->cr();
3726 } else {
3727 n = (int)((uintptr_t)cp & (bytes_per_line-1));
3728 st->print_cr("[Constant Pool (unaligned)]");
3729 }
3730
3731 //---< print CP contents, bytes_per_line at a time >---
3732 while (cp < cend) {
3733 Disassembler::print_location(cp, cstart, cend, st, true, false);
3734 Disassembler::print_hexdata(cp, n, st, false);
3735 cp += n;
3736 n = bytes_per_line;
3737 st->cr();
3738 }
3739
3740 //---< Show potential alignment gap between constant pool and code >---
3741 cend = code_begin();
3742 if( cp < cend ) {
3743 n = 4;
3744 st->print_cr("[Code entry alignment]");
3745 while (cp < cend) {
3746 Disassembler::print_location(cp, cstart, cend, st, false, false);
3747 cp += n;
3748 st->cr();
3749 }
3750 }
3751 } else {
3752 st->print_cr("[Constant Pool (empty)]");
3753 }
3754 st->cr();
3755 }
3756
3757 #endif
3758
3759 // Disassemble this nmethod.
3760 // Print additional debug information, if requested. This could be code
3761 // comments, block comments, profiling counters, etc.
3762 // The undisassembled format is useful no disassembler library is available.
3763 // The resulting hex dump (with markers) can be disassembled later, or on
3764 // another system, when/where a disassembler library is available.
3765 void nmethod::decode2(outputStream* ost) const {
3766
3767 // Called from frame::back_trace_with_decode without ResourceMark.
3768 ResourceMark rm;
3769
3770 // Make sure we have a valid stream to print on.
3771 outputStream* st = ost ? ost : tty;
3772
3773 #if defined(SUPPORT_ABSTRACT_ASSEMBLY) && ! defined(SUPPORT_ASSEMBLY)
3774 const bool use_compressed_format = true;
3775 const bool compressed_with_comments = use_compressed_format && (AbstractDisassembler::show_comment() ||
3776 AbstractDisassembler::show_block_comment());
3777 #else
3778 const bool use_compressed_format = Disassembler::is_abstract();
3779 const bool compressed_with_comments = use_compressed_format && (AbstractDisassembler::show_comment() ||
3780 AbstractDisassembler::show_block_comment());
3781 #endif
3782
3783 st->cr();
3784 this->print_on(st);
3785 st->cr();
3786
3787 #if defined(SUPPORT_ASSEMBLY)
3788 //----------------------------------
3789 //---< Print real disassembly >---
3790 //----------------------------------
3791 if (! use_compressed_format) {
3792 st->print_cr("[Disassembly]");
3793 Disassembler::decode(const_cast<nmethod*>(this), st);
3794 st->bol();
3795 st->print_cr("[/Disassembly]");
3796 return;
3797 }
3798 #endif
3799
3800 #if defined(SUPPORT_ABSTRACT_ASSEMBLY)
3801
3802 // Compressed undisassembled disassembly format.
3803 // The following status values are defined/supported:
3804 // = 0 - currently at bol() position, nothing printed yet on current line.
3805 // = 1 - currently at position after print_location().
3806 // > 1 - in the midst of printing instruction stream bytes.
3807 int compressed_format_idx = 0;
3808 int code_comment_column = 0;
3809 const int instr_maxlen = Assembler::instr_maxlen();
3810 const uint tabspacing = 8;
3811 unsigned char* start = this->code_begin();
3812 unsigned char* p = this->code_begin();
3813 unsigned char* end = this->code_end();
3814 unsigned char* pss = p; // start of a code section (used for offsets)
3815
3816 if ((start == nullptr) || (end == nullptr)) {
3817 st->print_cr("PrintAssembly not possible due to uninitialized section pointers");
3818 return;
3819 }
3820 #endif
3821
3822 #if defined(SUPPORT_ABSTRACT_ASSEMBLY)
3823 //---< plain abstract disassembly, no comments or anything, just section headers >---
3824 if (use_compressed_format && ! compressed_with_comments) {
3825 const_cast<nmethod*>(this)->print_constant_pool(st);
3826
3827 st->bol();
3828 st->cr();
3829 st->print_cr("Loading hsdis library failed, undisassembled code is shown in MachCode section");
3830 //---< Open the output (Marker for post-mortem disassembler) >---
3831 st->print_cr("[MachCode]");
3832 const char* header = nullptr;
3833 address p0 = p;
3834 while (p < end) {
3835 address pp = p;
3836 while ((p < end) && (header == nullptr)) {
3837 header = nmethod_section_label(p);
3838 pp = p;
3839 p += Assembler::instr_len(p);
3840 }
3841 if (pp > p0) {
3842 AbstractDisassembler::decode_range_abstract(p0, pp, start, end, st, Assembler::instr_maxlen());
3843 p0 = pp;
3844 p = pp;
3845 header = nullptr;
3846 } else if (header != nullptr) {
3847 st->bol();
3848 st->print_cr("%s", header);
3849 header = nullptr;
3850 }
3851 }
3852 //---< Close the output (Marker for post-mortem disassembler) >---
3853 st->bol();
3854 st->print_cr("[/MachCode]");
3855 return;
3856 }
3857 #endif
3858
3859 #if defined(SUPPORT_ABSTRACT_ASSEMBLY)
3860 //---< abstract disassembly with comments and section headers merged in >---
3861 if (compressed_with_comments) {
3862 const_cast<nmethod*>(this)->print_constant_pool(st);
3863
3864 st->bol();
3865 st->cr();
3866 st->print_cr("Loading hsdis library failed, undisassembled code is shown in MachCode section");
3867 //---< Open the output (Marker for post-mortem disassembler) >---
3868 st->print_cr("[MachCode]");
3869 while ((p < end) && (p != nullptr)) {
3870 const int instruction_size_in_bytes = Assembler::instr_len(p);
3871
3872 //---< Block comments for nmethod. Interrupts instruction stream, if any. >---
3873 // Outputs a bol() before and a cr() after, but only if a comment is printed.
3874 // Prints nmethod_section_label as well.
3875 if (AbstractDisassembler::show_block_comment()) {
3876 print_block_comment(st, p);
3877 if (st->position() == 0) {
3878 compressed_format_idx = 0;
3879 }
3880 }
3881
3882 //---< New location information after line break >---
3883 if (compressed_format_idx == 0) {
3884 code_comment_column = Disassembler::print_location(p, pss, end, st, false, false);
3885 compressed_format_idx = 1;
3886 }
3887
3888 //---< Code comment for current instruction. Address range [p..(p+len)) >---
3889 unsigned char* p_end = p + (ssize_t)instruction_size_in_bytes;
3890 S390_ONLY(if (p_end > end) p_end = end;) // avoid getting past the end
3891
3892 if (AbstractDisassembler::show_comment() && const_cast<nmethod*>(this)->has_code_comment(p, p_end)) {
3893 //---< interrupt instruction byte stream for code comment >---
3894 if (compressed_format_idx > 1) {
3895 st->cr(); // interrupt byte stream
3896 st->cr(); // add an empty line
3897 code_comment_column = Disassembler::print_location(p, pss, end, st, false, false);
3898 }
3899 const_cast<nmethod*>(this)->print_code_comment_on(st, code_comment_column, p, p_end );
3900 st->bol();
3901 compressed_format_idx = 0;
3902 }
3903
3904 //---< New location information after line break >---
3905 if (compressed_format_idx == 0) {
3906 code_comment_column = Disassembler::print_location(p, pss, end, st, false, false);
3907 compressed_format_idx = 1;
3908 }
3909
3910 //---< Nicely align instructions for readability >---
3911 if (compressed_format_idx > 1) {
3912 Disassembler::print_delimiter(st);
3913 }
3914
3915 //---< Now, finally, print the actual instruction bytes >---
3916 unsigned char* p0 = p;
3917 p = Disassembler::decode_instruction_abstract(p, st, instruction_size_in_bytes, instr_maxlen);
3918 compressed_format_idx += (int)(p - p0);
3919
3920 if (Disassembler::start_newline(compressed_format_idx-1)) {
3921 st->cr();
3922 compressed_format_idx = 0;
3923 }
3924 }
3925 //---< Close the output (Marker for post-mortem disassembler) >---
3926 st->bol();
3927 st->print_cr("[/MachCode]");
3928 return;
3929 }
3930 #endif
3931 }
3932
3933 #if defined(SUPPORT_ASSEMBLY) || defined(SUPPORT_ABSTRACT_ASSEMBLY)
3934
3935 const char* nmethod::reloc_string_for(u_char* begin, u_char* end) {
3936 RelocIterator iter(this, begin, end);
3937 bool have_one = false;
3938 while (iter.next()) {
3939 have_one = true;
3940 switch (iter.type()) {
3941 case relocInfo::none: {
3942 // Skip it and check next
3943 break;
3944 }
3945 case relocInfo::oop_type: {
3946 // Get a non-resizable resource-allocated stringStream.
3947 // Our callees make use of (nested) ResourceMarks.
3948 stringStream st(NEW_RESOURCE_ARRAY(char, 1024), 1024);
3949 oop_Relocation* r = iter.oop_reloc();
3950 oop obj = r->oop_value();
3951 st.print("oop(");
3952 if (obj == nullptr) st.print("nullptr");
3953 else obj->print_value_on(&st);
3954 st.print(")");
3955 return st.as_string();
3956 }
3957 case relocInfo::metadata_type: {
3958 stringStream st;
3959 metadata_Relocation* r = iter.metadata_reloc();
3960 Metadata* obj = r->metadata_value();
3961 st.print("metadata(");
3962 if (obj == nullptr) st.print("nullptr");
3963 else obj->print_value_on(&st);
3964 st.print(")");
3965 return st.as_string();
3966 }
3967 case relocInfo::runtime_call_type:
3968 case relocInfo::runtime_call_w_cp_type: {
3969 stringStream st;
3970 st.print("runtime_call");
3971 CallRelocation* r = (CallRelocation*)iter.reloc();
3972 address dest = r->destination();
3973 if (StubRoutines::contains(dest)) {
3974 StubCodeDesc* desc = StubCodeDesc::desc_for(dest);
3975 if (desc == nullptr) {
3976 desc = StubCodeDesc::desc_for(dest + frame::pc_return_offset);
3977 }
3978 if (desc != nullptr) {
3979 st.print(" Stub::%s", desc->name());
3980 return st.as_string();
3981 }
3982 }
3983 CodeBlob* cb = CodeCache::find_blob(dest);
3984 if (cb != nullptr) {
3985 st.print(" %s", cb->name());
3986 } else {
3987 ResourceMark rm;
3988 const int buflen = 1024;
3989 char* buf = NEW_RESOURCE_ARRAY(char, buflen);
3990 int offset;
3991 if (os::dll_address_to_function_name(dest, buf, buflen, &offset)) {
3992 st.print(" %s", buf);
3993 if (offset != 0) {
3994 st.print("+%d", offset);
3995 }
3996 }
3997 }
3998 return st.as_string();
3999 }
4000 case relocInfo::virtual_call_type: {
4001 stringStream st;
4002 st.print_raw("virtual_call");
4003 virtual_call_Relocation* r = iter.virtual_call_reloc();
4004 Method* m = r->method_value();
4005 if (m != nullptr) {
4006 assert(m->is_method(), "");
4007 m->print_short_name(&st);
4008 }
4009 return st.as_string();
4010 }
4011 case relocInfo::opt_virtual_call_type: {
4012 stringStream st;
4013 st.print_raw("optimized virtual_call");
4014 opt_virtual_call_Relocation* r = iter.opt_virtual_call_reloc();
4015 Method* m = r->method_value();
4016 if (m != nullptr) {
4017 assert(m->is_method(), "");
4018 m->print_short_name(&st);
4019 }
4020 return st.as_string();
4021 }
4022 case relocInfo::static_call_type: {
4023 stringStream st;
4024 st.print_raw("static_call");
4025 static_call_Relocation* r = iter.static_call_reloc();
4026 Method* m = r->method_value();
4027 if (m != nullptr) {
4028 assert(m->is_method(), "");
4029 m->print_short_name(&st);
4030 }
4031 return st.as_string();
4032 }
4033 case relocInfo::static_stub_type: return "static_stub";
4034 case relocInfo::external_word_type: return "external_word";
4035 case relocInfo::internal_word_type: return "internal_word";
4036 case relocInfo::section_word_type: return "section_word";
4037 case relocInfo::poll_type: return "poll";
4038 case relocInfo::poll_return_type: return "poll_return";
4039 case relocInfo::trampoline_stub_type: return "trampoline_stub";
4040 case relocInfo::entry_guard_type: return "entry_guard";
4041 case relocInfo::post_call_nop_type: return "post_call_nop";
4042 case relocInfo::barrier_type: {
4043 barrier_Relocation* const reloc = iter.barrier_reloc();
4044 stringStream st;
4045 st.print("barrier format=%d", reloc->format());
4046 return st.as_string();
4047 }
4048
4049 case relocInfo::type_mask: return "type_bit_mask";
4050
4051 default: {
4052 stringStream st;
4053 st.print("unknown relocInfo=%d", (int) iter.type());
4054 return st.as_string();
4055 }
4056 }
4057 }
4058 return have_one ? "other" : nullptr;
4059 }
4060
4061 // Return the last scope in (begin..end]
4062 ScopeDesc* nmethod::scope_desc_in(address begin, address end) {
4063 PcDesc* p = pc_desc_near(begin+1);
4064 if (p != nullptr && p->real_pc(this) <= end) {
4065 return new ScopeDesc(this, p);
4066 }
4067 return nullptr;
4068 }
4069
4070 const char* nmethod::nmethod_section_label(address pos) const {
4071 const char* label = nullptr;
4072 if (pos == code_begin()) label = "[Instructions begin]";
4073 if (pos == entry_point()) label = "[Entry Point]";
4074 if (pos == inline_entry_point()) label = "[Inline Entry Point]";
4075 if (pos == verified_entry_point()) label = "[Verified Entry Point]";
4076 if (pos == verified_inline_entry_point()) label = "[Verified Inline Entry Point]";
4077 if (pos == verified_inline_ro_entry_point()) label = "[Verified Inline Entry Point (RO)]";
4078 if (pos == consts_begin() && pos != insts_begin()) label = "[Constants]";
4079 // Check stub_code before checking exception_handler or deopt_handler.
4080 if (pos == this->stub_begin()) label = "[Stub Code]";
4081 if (JVMCI_ONLY(_exception_offset >= 0 &&) pos == exception_begin()) label = "[Exception Handler]";
4082 if (JVMCI_ONLY(_deopt_handler_entry_offset != -1 &&) pos == deopt_handler_entry()) label = "[Deopt Handler Entry Point]";
4083 return label;
4084 }
4085
4086 static int maybe_print_entry_label(outputStream* stream, address pos, address entry, const char* label) {
4087 if (pos == entry) {
4088 stream->bol();
4089 stream->print_cr("%s", label);
4090 return 1;
4091 } else {
4092 return 0;
4093 }
4094 }
4095
4096 void nmethod::print_nmethod_labels(outputStream* stream, address block_begin, bool print_section_labels) const {
4097 if (print_section_labels) {
4098 int n = 0;
4099 // Multiple entry points may be at the same position. Print them all.
4100 n += maybe_print_entry_label(stream, block_begin, entry_point(), "[Entry Point]");
4101 n += maybe_print_entry_label(stream, block_begin, inline_entry_point(), "[Inline Entry Point]");
4102 n += maybe_print_entry_label(stream, block_begin, verified_entry_point(), "[Verified Entry Point]");
4103 n += maybe_print_entry_label(stream, block_begin, verified_inline_entry_point(), "[Verified Inline Entry Point]");
4104 n += maybe_print_entry_label(stream, block_begin, verified_inline_ro_entry_point(), "[Verified Inline Entry Point (RO)]");
4105 if (n == 0) {
4106 const char* label = nmethod_section_label(block_begin);
4107 if (label != nullptr) {
4108 stream->bol();
4109 stream->print_cr("%s", label);
4110 }
4111 }
4112 }
4113
4114 Method* m = method();
4115 if (m == nullptr || is_osr_method()) {
4116 return;
4117 }
4118
4119 // Print the name of the method (only once)
4120 address low = MIN3(entry_point(),
4121 verified_entry_point(),
4122 inline_entry_point());
4123 // The verified inline entry point and verified inline RO entry point are not always
4124 // used. When they are unused. CodeOffsets::Verified_Inline_Entry(_RO) is -1. Hence,
4125 // the calculated entry point is smaller than the block they are offsetting into.
4126 if (verified_inline_entry_point() >= block_begin) {
4127 low = MIN2(low, verified_inline_entry_point());
4128 }
4129 if (verified_inline_ro_entry_point() >= block_begin) {
4130 low = MIN2(low, verified_inline_ro_entry_point());
4131 }
4132 assert(low != 0, "sanity");
4133 if (block_begin == low) {
4134 stream->print(" # ");
4135 m->print_value_on(stream);
4136 stream->cr();
4137 }
4138
4139 // Print the arguments for the 3 types of verified entry points
4140 CompiledEntrySignature ces(m);
4141 ces.compute_calling_conventions(false);
4142 const GrowableArray<SigEntry>* sig_cc;
4143 const VMRegPair* regs;
4144 if (block_begin == verified_entry_point()) {
4145 sig_cc = ces.sig_cc();
4146 regs = ces.regs_cc();
4147 } else if (block_begin == verified_inline_entry_point()) {
4148 sig_cc = ces.sig();
4149 regs = ces.regs();
4150 } else if (block_begin == verified_inline_ro_entry_point()) {
4151 sig_cc = ces.sig_cc_ro();
4152 regs = ces.regs_cc_ro();
4153 } else {
4154 return;
4155 }
4156
4157 bool has_this = !m->is_static();
4158 if (ces.has_inline_recv() && block_begin == verified_entry_point()) {
4159 // <this> argument is scalarized for verified_entry_point()
4160 has_this = false;
4161 }
4162 const char* spname = "sp"; // make arch-specific?
4163 int stack_slot_offset = this->frame_size() * wordSize;
4164 int tab1 = 14, tab2 = 24;
4165 int sig_index = 0;
4166 int arg_index = has_this ? -1 : 0;
4167 bool did_old_sp = false;
4168 for (ExtendedSignature sig = ExtendedSignature(sig_cc, SigEntryFilter()); !sig.at_end(); ++sig) {
4169 bool at_this = (arg_index == -1);
4170 bool at_old_sp = false;
4171 BasicType t = (*sig)._bt;
4172 if (at_this) {
4173 stream->print(" # this: ");
4174 } else {
4175 stream->print(" # parm%d: ", arg_index);
4176 }
4177 stream->move_to(tab1);
4178 VMReg fst = regs[sig_index].first();
4179 VMReg snd = regs[sig_index].second();
4180 if (fst->is_reg()) {
4181 stream->print("%s", fst->name());
4182 if (snd->is_valid()) {
4183 stream->print(":%s", snd->name());
4184 }
4185 } else if (fst->is_stack()) {
4186 int offset = fst->reg2stack() * VMRegImpl::stack_slot_size + stack_slot_offset;
4187 if (offset == stack_slot_offset) at_old_sp = true;
4188 stream->print("[%s+0x%x]", spname, offset);
4189 } else {
4190 stream->print("reg%d:%d??", (int)(intptr_t)fst, (int)(intptr_t)snd);
4191 }
4192 stream->print(" ");
4193 stream->move_to(tab2);
4194 stream->print("= ");
4195 if (at_this) {
4196 m->method_holder()->print_value_on(stream);
4197 } else {
4198 bool did_name = false;
4199 if (is_reference_type(t)) {
4200 Symbol* name = (*sig)._name;
4201 name->print_value_on(stream);
4202 did_name = true;
4203 }
4204 if (!did_name)
4205 stream->print("%s", type2name(t));
4206 if ((*sig)._null_marker) {
4207 stream->print(" (null marker)");
4208 }
4209 }
4210 if (at_old_sp) {
4211 stream->print(" (%s of caller)", spname);
4212 did_old_sp = true;
4213 }
4214 stream->cr();
4215 sig_index += type2size[t];
4216 arg_index += 1;
4217 }
4218 if (!did_old_sp) {
4219 stream->print(" # ");
4220 stream->move_to(tab1);
4221 stream->print("[%s+0x%x]", spname, stack_slot_offset);
4222 stream->print(" (%s of caller)", spname);
4223 stream->cr();
4224 }
4225 }
4226
4227 // Returns whether this nmethod has code comments.
4228 bool nmethod::has_code_comment(address begin, address end) {
4229 // scopes?
4230 ScopeDesc* sd = scope_desc_in(begin, end);
4231 if (sd != nullptr) return true;
4232
4233 // relocations?
4234 const char* str = reloc_string_for(begin, end);
4235 if (str != nullptr) return true;
4236
4237 // implicit exceptions?
4238 int cont_offset = ImplicitExceptionTable(this).continuation_offset((uint)(begin - code_begin()));
4239 if (cont_offset != 0) return true;
4240
4241 return false;
4242 }
4243
4244 void nmethod::print_code_comment_on(outputStream* st, int column, address begin, address end) {
4245 ImplicitExceptionTable implicit_table(this);
4246 int pc_offset = (int)(begin - code_begin());
4247 int cont_offset = implicit_table.continuation_offset(pc_offset);
4248 bool oop_map_required = false;
4249 if (cont_offset != 0) {
4250 st->move_to(column, 6, 0);
4251 if (pc_offset == cont_offset) {
4252 st->print("; implicit exception: deoptimizes");
4253 oop_map_required = true;
4254 } else {
4255 st->print("; implicit exception: dispatches to " INTPTR_FORMAT, p2i(code_begin() + cont_offset));
4256 }
4257 }
4258
4259 // Find an oopmap in (begin, end]. We use the odd half-closed
4260 // interval so that oop maps and scope descs which are tied to the
4261 // byte after a call are printed with the call itself. OopMaps
4262 // associated with implicit exceptions are printed with the implicit
4263 // instruction.
4264 address base = code_begin();
4265 ImmutableOopMapSet* oms = oop_maps();
4266 if (oms != nullptr) {
4267 for (int i = 0, imax = oms->count(); i < imax; i++) {
4268 const ImmutableOopMapPair* pair = oms->pair_at(i);
4269 const ImmutableOopMap* om = pair->get_from(oms);
4270 address pc = base + pair->pc_offset();
4271 if (pc >= begin) {
4272 #if INCLUDE_JVMCI
4273 bool is_implicit_deopt = implicit_table.continuation_offset(pair->pc_offset()) == (uint) pair->pc_offset();
4274 #else
4275 bool is_implicit_deopt = false;
4276 #endif
4277 if (is_implicit_deopt ? pc == begin : pc > begin && pc <= end) {
4278 st->move_to(column, 6, 0);
4279 st->print("; ");
4280 om->print_on(st);
4281 oop_map_required = false;
4282 }
4283 }
4284 if (pc > end) {
4285 break;
4286 }
4287 }
4288 }
4289 assert(!oop_map_required, "missed oopmap");
4290
4291 Thread* thread = Thread::current();
4292
4293 // Print any debug info present at this pc.
4294 ScopeDesc* sd = scope_desc_in(begin, end);
4295 if (sd != nullptr) {
4296 st->move_to(column, 6, 0);
4297 if (sd->bci() == SynchronizationEntryBCI) {
4298 st->print(";*synchronization entry");
4299 } else if (sd->bci() == AfterBci) {
4300 st->print(";* method exit (unlocked if synchronized)");
4301 } else if (sd->bci() == UnwindBci) {
4302 st->print(";* unwind (locked if synchronized)");
4303 } else if (sd->bci() == AfterExceptionBci) {
4304 st->print(";* unwind (unlocked if synchronized)");
4305 } else if (sd->bci() == UnknownBci) {
4306 st->print(";* unknown");
4307 } else if (sd->bci() == InvalidFrameStateBci) {
4308 st->print(";* invalid frame state");
4309 } else {
4310 if (sd->method() == nullptr) {
4311 st->print("method is nullptr");
4312 } else if (sd->method()->is_native()) {
4313 st->print("method is native");
4314 } else {
4315 Bytecodes::Code bc = sd->method()->java_code_at(sd->bci());
4316 st->print(";*%s", Bytecodes::name(bc));
4317 switch (bc) {
4318 case Bytecodes::_invokevirtual:
4319 case Bytecodes::_invokespecial:
4320 case Bytecodes::_invokestatic:
4321 case Bytecodes::_invokeinterface:
4322 {
4323 Bytecode_invoke invoke(methodHandle(thread, sd->method()), sd->bci());
4324 st->print(" ");
4325 if (invoke.name() != nullptr)
4326 invoke.name()->print_symbol_on(st);
4327 else
4328 st->print("<UNKNOWN>");
4329 break;
4330 }
4331 case Bytecodes::_getfield:
4332 case Bytecodes::_putfield:
4333 case Bytecodes::_getstatic:
4334 case Bytecodes::_putstatic:
4335 {
4336 Bytecode_field field(methodHandle(thread, sd->method()), sd->bci());
4337 st->print(" ");
4338 if (field.name() != nullptr)
4339 field.name()->print_symbol_on(st);
4340 else
4341 st->print("<UNKNOWN>");
4342 }
4343 default:
4344 break;
4345 }
4346 }
4347 st->print(" {reexecute=%d rethrow=%d return_oop=%d return_scalarized=%d}", sd->should_reexecute(), sd->rethrow_exception(), sd->return_oop(), sd->return_scalarized());
4348 }
4349
4350 // Print all scopes
4351 for (;sd != nullptr; sd = sd->sender()) {
4352 st->move_to(column, 6, 0);
4353 st->print("; -");
4354 if (sd->should_reexecute()) {
4355 st->print(" (reexecute)");
4356 }
4357 if (sd->method() == nullptr) {
4358 st->print("method is nullptr");
4359 } else {
4360 sd->method()->print_short_name(st);
4361 }
4362 int lineno = sd->method()->line_number_from_bci(sd->bci());
4363 if (lineno != -1) {
4364 st->print("@%d (line %d)", sd->bci(), lineno);
4365 } else {
4366 st->print("@%d", sd->bci());
4367 }
4368 st->cr();
4369 }
4370 }
4371
4372 // Print relocation information
4373 // Prevent memory leak: allocating without ResourceMark.
4374 ResourceMark rm;
4375 const char* str = reloc_string_for(begin, end);
4376 if (str != nullptr) {
4377 if (sd != nullptr) st->cr();
4378 st->move_to(column, 6, 0);
4379 st->print("; {%s}", str);
4380 }
4381 }
4382
4383 #endif
4384
4385 address nmethod::call_instruction_address(address pc) const {
4386 if (NativeCall::is_call_before(pc)) {
4387 NativeCall *ncall = nativeCall_before(pc);
4388 return ncall->instruction_address();
4389 }
4390 return nullptr;
4391 }
4392
4393 void nmethod::print_value_on_impl(outputStream* st) const {
4394 st->print_cr("nmethod");
4395 #if defined(SUPPORT_DATA_STRUCTS)
4396 print_on_with_msg(st, nullptr);
4397 #endif
4398 }
4399
4400 void nmethod::print_code_snippet(outputStream* st, address addr) const {
4401 if (entry_point() <= addr && addr < code_end()) {
4402 // Pointing into the nmethod's code. Try to disassemble some instructions around addr.
4403 // Determine conservative start and end points.
4404 address start;
4405 if (frame_complete_offset() != CodeOffsets::frame_never_safe &&
4406 addr >= code_begin() + frame_complete_offset()) {
4407 start = code_begin() + frame_complete_offset();
4408 } else {
4409 start = (addr < verified_entry_point()) ? entry_point() : verified_entry_point();
4410 }
4411 address start_for_hex_dump = start; // We can choose a different starting point for hex dump, below.
4412 address end = code_end();
4413
4414 // Try using relocations to find closer instruction start and end points.
4415 // (Some platforms have variable length instructions and can only
4416 // disassemble correctly at instruction start addresses.)
4417 RelocIterator iter((nmethod*)this, start);
4418 while (iter.next() && iter.addr() < addr) { // find relocation before addr
4419 // Note: There's a relocation which doesn't point to an instruction start:
4420 // ZBarrierRelocationFormatStoreGoodAfterMov with ZGC on x86_64
4421 // We could detect and skip it, but hex dump is still usable when
4422 // disassembler produces garbage in such a very rare case.
4423 start = iter.addr();
4424 // We want at least 64 Bytes ahead in hex dump.
4425 if (iter.addr() <= (addr - 64)) start_for_hex_dump = iter.addr();
4426 }
4427 if (iter.has_current()) {
4428 if (iter.addr() == addr) iter.next(); // find relocation after addr
4429 if (iter.has_current()) end = iter.addr();
4430 }
4431
4432 // Always print hex. Disassembler may still have problems when hitting an incorrect instruction start.
4433 os::print_hex_dump(st, start_for_hex_dump, end, 1, /* print_ascii=*/false);
4434 if (!Disassembler::is_abstract()) {
4435 Disassembler::decode(start, end, st);
4436 }
4437 }
4438 }
4439
4440 #ifndef PRODUCT
4441
4442 void nmethod::print_calls(outputStream* st) {
4443 RelocIterator iter(this);
4444 while (iter.next()) {
4445 switch (iter.type()) {
4446 case relocInfo::virtual_call_type: {
4447 CompiledICLocker ml_verify(this);
4448 CompiledIC_at(&iter)->print();
4449 break;
4450 }
4451 case relocInfo::static_call_type:
4452 case relocInfo::opt_virtual_call_type:
4453 st->print_cr("Direct call at " INTPTR_FORMAT, p2i(iter.reloc()->addr()));
4454 CompiledDirectCall::at(iter.reloc())->print();
4455 break;
4456 default:
4457 break;
4458 }
4459 }
4460 }
4461
4462 void nmethod::print_statistics() {
4463 ttyLocker ttyl;
4464 if (xtty != nullptr) xtty->head("statistics type='nmethod'");
4465 native_nmethod_stats.print_native_nmethod_stats();
4466 #ifdef COMPILER1
4467 c1_java_nmethod_stats.print_nmethod_stats("C1");
4468 #endif
4469 #ifdef COMPILER2
4470 c2_java_nmethod_stats.print_nmethod_stats("C2");
4471 #endif
4472 #if INCLUDE_JVMCI
4473 jvmci_java_nmethod_stats.print_nmethod_stats("JVMCI");
4474 #endif
4475 unknown_java_nmethod_stats.print_nmethod_stats("Unknown");
4476 DebugInformationRecorder::print_statistics();
4477 pc_nmethod_stats.print_pc_stats();
4478 Dependencies::print_statistics();
4479 ExternalsRecorder::print_statistics();
4480 if (xtty != nullptr) xtty->tail("statistics");
4481 }
4482
4483 #endif // !PRODUCT
4484
4485 #if INCLUDE_JVMCI
4486 void nmethod::update_speculation(JavaThread* thread) {
4487 jlong speculation = thread->pending_failed_speculation();
4488 if (speculation != 0) {
4489 guarantee(jvmci_nmethod_data() != nullptr, "failed speculation in nmethod without failed speculation list");
4490 jvmci_nmethod_data()->add_failed_speculation(this, speculation);
4491 thread->set_pending_failed_speculation(0);
4492 }
4493 }
4494
4495 const char* nmethod::jvmci_name() {
4496 if (jvmci_nmethod_data() != nullptr) {
4497 return jvmci_nmethod_data()->name();
4498 }
4499 return nullptr;
4500 }
4501
4502 bool nmethod::jvmci_skip_profile_deopt() const {
4503 return jvmci_nmethod_data() != nullptr && !jvmci_nmethod_data()->profile_deopt();
4504 }
4505 #endif