1 /*
2 * Copyright (c) 1997, 2019, 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 "precompiled.hpp"
26 #include "jvm.h"
27 #include "code/codeCache.hpp"
28 #include "code/compiledIC.hpp"
29 #include "code/compiledMethod.inline.hpp"
30 #include "code/dependencies.hpp"
31 #include "code/nativeInst.hpp"
32 #include "code/nmethod.hpp"
33 #include "code/scopeDesc.hpp"
34 #include "compiler/abstractCompiler.hpp"
35 #include "compiler/compileBroker.hpp"
36 #include "compiler/compileLog.hpp"
37 #include "compiler/compilerDirectives.hpp"
38 #include "compiler/directivesParser.hpp"
39 #include "compiler/disassembler.hpp"
40 #include "interpreter/bytecode.hpp"
41 #include "logging/log.hpp"
42 #include "logging/logStream.hpp"
43 #include "memory/allocation.inline.hpp"
44 #include "memory/resourceArea.hpp"
45 #include "oops/access.inline.hpp"
46 #include "oops/method.inline.hpp"
47 #include "oops/methodData.hpp"
48 #include "oops/oop.inline.hpp"
49 #include "prims/jvmtiImpl.hpp"
50 #include "runtime/atomic.hpp"
51 #include "runtime/flags/flagSetting.hpp"
52 #include "runtime/frame.inline.hpp"
53 #include "runtime/handles.inline.hpp"
54 #include "runtime/jniHandles.inline.hpp"
55 #include "runtime/orderAccess.hpp"
56 #include "runtime/os.hpp"
57 #include "runtime/safepointVerifiers.hpp"
58 #include "runtime/sharedRuntime.hpp"
59 #include "runtime/sweeper.hpp"
60 #include "runtime/vmThread.hpp"
61 #include "utilities/align.hpp"
62 #include "utilities/dtrace.hpp"
63 #include "utilities/events.hpp"
64 #include "utilities/resourceHash.hpp"
65 #include "utilities/xmlstream.hpp"
66 #if INCLUDE_JVMCI
67 #include "jvmci/jvmciJavaClasses.hpp"
68 #endif
69
70 #ifdef DTRACE_ENABLED
71
72 // Only bother with this argument setup if dtrace is available
73
74 #define DTRACE_METHOD_UNLOAD_PROBE(method) \
75 { \
76 Method* m = (method); \
77 if (m != NULL) { \
78 Symbol* klass_name = m->klass_name(); \
79 Symbol* name = m->name(); \
80 Symbol* signature = m->signature(); \
81 HOTSPOT_COMPILED_METHOD_UNLOAD( \
82 (char *) klass_name->bytes(), klass_name->utf8_length(), \
83 (char *) name->bytes(), name->utf8_length(), \
84 (char *) signature->bytes(), signature->utf8_length()); \
85 } \
86 }
87
88 #else // ndef DTRACE_ENABLED
89
90 #define DTRACE_METHOD_UNLOAD_PROBE(method)
91
92 #endif
93
94 //---------------------------------------------------------------------------------
95 // NMethod statistics
96 // They are printed under various flags, including:
97 // PrintC1Statistics, PrintOptoStatistics, LogVMOutput, and LogCompilation.
98 // (In the latter two cases, they like other stats are printed to the log only.)
99
100 #ifndef PRODUCT
101 // These variables are put into one block to reduce relocations
102 // and make it simpler to print from the debugger.
103 struct java_nmethod_stats_struct {
104 int nmethod_count;
105 int total_size;
106 int relocation_size;
107 int consts_size;
108 int insts_size;
109 int stub_size;
110 int scopes_data_size;
111 int scopes_pcs_size;
112 int dependencies_size;
113 int handler_table_size;
114 int nul_chk_table_size;
115 int oops_size;
116 int metadata_size;
117
118 void note_nmethod(nmethod* nm) {
119 nmethod_count += 1;
120 total_size += nm->size();
121 relocation_size += nm->relocation_size();
122 consts_size += nm->consts_size();
123 insts_size += nm->insts_size();
124 stub_size += nm->stub_size();
125 oops_size += nm->oops_size();
126 metadata_size += nm->metadata_size();
127 scopes_data_size += nm->scopes_data_size();
128 scopes_pcs_size += nm->scopes_pcs_size();
129 dependencies_size += nm->dependencies_size();
130 handler_table_size += nm->handler_table_size();
131 nul_chk_table_size += nm->nul_chk_table_size();
132 }
133 void print_nmethod_stats(const char* name) {
134 if (nmethod_count == 0) return;
135 tty->print_cr("Statistics for %d bytecoded nmethods for %s:", nmethod_count, name);
136 if (total_size != 0) tty->print_cr(" total in heap = %d", total_size);
137 if (nmethod_count != 0) tty->print_cr(" header = " SIZE_FORMAT, nmethod_count * sizeof(nmethod));
138 if (relocation_size != 0) tty->print_cr(" relocation = %d", relocation_size);
139 if (consts_size != 0) tty->print_cr(" constants = %d", consts_size);
140 if (insts_size != 0) tty->print_cr(" main code = %d", insts_size);
141 if (stub_size != 0) tty->print_cr(" stub code = %d", stub_size);
142 if (oops_size != 0) tty->print_cr(" oops = %d", oops_size);
143 if (metadata_size != 0) tty->print_cr(" metadata = %d", metadata_size);
144 if (scopes_data_size != 0) tty->print_cr(" scopes data = %d", scopes_data_size);
145 if (scopes_pcs_size != 0) tty->print_cr(" scopes pcs = %d", scopes_pcs_size);
146 if (dependencies_size != 0) tty->print_cr(" dependencies = %d", dependencies_size);
147 if (handler_table_size != 0) tty->print_cr(" handler table = %d", handler_table_size);
148 if (nul_chk_table_size != 0) tty->print_cr(" nul chk table = %d", nul_chk_table_size);
149 }
150 };
151
152 struct native_nmethod_stats_struct {
153 int native_nmethod_count;
154 int native_total_size;
155 int native_relocation_size;
156 int native_insts_size;
157 int native_oops_size;
158 int native_metadata_size;
159 void note_native_nmethod(nmethod* nm) {
160 native_nmethod_count += 1;
161 native_total_size += nm->size();
162 native_relocation_size += nm->relocation_size();
163 native_insts_size += nm->insts_size();
164 native_oops_size += nm->oops_size();
165 native_metadata_size += nm->metadata_size();
166 }
167 void print_native_nmethod_stats() {
168 if (native_nmethod_count == 0) return;
169 tty->print_cr("Statistics for %d native nmethods:", native_nmethod_count);
170 if (native_total_size != 0) tty->print_cr(" N. total size = %d", native_total_size);
171 if (native_relocation_size != 0) tty->print_cr(" N. relocation = %d", native_relocation_size);
172 if (native_insts_size != 0) tty->print_cr(" N. main code = %d", native_insts_size);
173 if (native_oops_size != 0) tty->print_cr(" N. oops = %d", native_oops_size);
174 if (native_metadata_size != 0) tty->print_cr(" N. metadata = %d", native_metadata_size);
175 }
176 };
177
178 struct pc_nmethod_stats_struct {
179 int pc_desc_resets; // number of resets (= number of caches)
180 int pc_desc_queries; // queries to nmethod::find_pc_desc
181 int pc_desc_approx; // number of those which have approximate true
182 int pc_desc_repeats; // number of _pc_descs[0] hits
183 int pc_desc_hits; // number of LRU cache hits
184 int pc_desc_tests; // total number of PcDesc examinations
185 int pc_desc_searches; // total number of quasi-binary search steps
186 int pc_desc_adds; // number of LUR cache insertions
187
188 void print_pc_stats() {
189 tty->print_cr("PcDesc Statistics: %d queries, %.2f comparisons per query",
190 pc_desc_queries,
191 (double)(pc_desc_tests + pc_desc_searches)
192 / pc_desc_queries);
193 tty->print_cr(" caches=%d queries=%d/%d, hits=%d+%d, tests=%d+%d, adds=%d",
194 pc_desc_resets,
195 pc_desc_queries, pc_desc_approx,
196 pc_desc_repeats, pc_desc_hits,
197 pc_desc_tests, pc_desc_searches, pc_desc_adds);
198 }
199 };
200
201 #ifdef COMPILER1
202 static java_nmethod_stats_struct c1_java_nmethod_stats;
203 #endif
204 #ifdef COMPILER2
205 static java_nmethod_stats_struct c2_java_nmethod_stats;
206 #endif
207 #if INCLUDE_JVMCI
208 static java_nmethod_stats_struct jvmci_java_nmethod_stats;
209 #endif
210 static java_nmethod_stats_struct unknown_java_nmethod_stats;
211
212 static native_nmethod_stats_struct native_nmethod_stats;
213 static pc_nmethod_stats_struct pc_nmethod_stats;
214
215 static void note_java_nmethod(nmethod* nm) {
216 #ifdef COMPILER1
217 if (nm->is_compiled_by_c1()) {
218 c1_java_nmethod_stats.note_nmethod(nm);
219 } else
220 #endif
221 #ifdef COMPILER2
222 if (nm->is_compiled_by_c2()) {
223 c2_java_nmethod_stats.note_nmethod(nm);
224 } else
225 #endif
226 #if INCLUDE_JVMCI
227 if (nm->is_compiled_by_jvmci()) {
228 jvmci_java_nmethod_stats.note_nmethod(nm);
229 } else
230 #endif
231 {
232 unknown_java_nmethod_stats.note_nmethod(nm);
233 }
234 }
235 #endif // !PRODUCT
236
237 //---------------------------------------------------------------------------------
238
239
240 ExceptionCache::ExceptionCache(Handle exception, address pc, address handler) {
241 assert(pc != NULL, "Must be non null");
242 assert(exception.not_null(), "Must be non null");
243 assert(handler != NULL, "Must be non null");
244
245 _count = 0;
246 _exception_type = exception->klass();
247 _next = NULL;
248 _purge_list_next = NULL;
249
250 add_address_and_handler(pc,handler);
251 }
252
253
254 address ExceptionCache::match(Handle exception, address pc) {
255 assert(pc != NULL,"Must be non null");
256 assert(exception.not_null(),"Must be non null");
257 if (exception->klass() == exception_type()) {
258 return (test_address(pc));
259 }
260
261 return NULL;
262 }
263
264
265 bool ExceptionCache::match_exception_with_space(Handle exception) {
266 assert(exception.not_null(),"Must be non null");
267 if (exception->klass() == exception_type() && count() < cache_size) {
268 return true;
269 }
270 return false;
271 }
272
273
274 address ExceptionCache::test_address(address addr) {
275 int limit = count();
276 for (int i = 0; i < limit; i++) {
277 if (pc_at(i) == addr) {
278 return handler_at(i);
279 }
280 }
281 return NULL;
282 }
283
284
285 bool ExceptionCache::add_address_and_handler(address addr, address handler) {
286 if (test_address(addr) == handler) return true;
287
288 int index = count();
289 if (index < cache_size) {
290 set_pc_at(index, addr);
291 set_handler_at(index, handler);
292 increment_count();
293 return true;
294 }
295 return false;
296 }
297
298 ExceptionCache* ExceptionCache::next() {
299 return Atomic::load(&_next);
300 }
301
302 void ExceptionCache::set_next(ExceptionCache *ec) {
303 Atomic::store(ec, &_next);
304 }
305
306 //-----------------------------------------------------------------------------
307
308
309 // Helper used by both find_pc_desc methods.
310 static inline bool match_desc(PcDesc* pc, int pc_offset, bool approximate) {
311 NOT_PRODUCT(++pc_nmethod_stats.pc_desc_tests);
312 if (!approximate)
313 return pc->pc_offset() == pc_offset;
314 else
315 return (pc-1)->pc_offset() < pc_offset && pc_offset <= pc->pc_offset();
316 }
317
318 void PcDescCache::reset_to(PcDesc* initial_pc_desc) {
319 if (initial_pc_desc == NULL) {
320 _pc_descs[0] = NULL; // native method; no PcDescs at all
321 return;
322 }
323 NOT_PRODUCT(++pc_nmethod_stats.pc_desc_resets);
324 // reset the cache by filling it with benign (non-null) values
325 assert(initial_pc_desc->pc_offset() < 0, "must be sentinel");
326 for (int i = 0; i < cache_size; i++)
327 _pc_descs[i] = initial_pc_desc;
328 }
329
330 PcDesc* PcDescCache::find_pc_desc(int pc_offset, bool approximate) {
331 NOT_PRODUCT(++pc_nmethod_stats.pc_desc_queries);
332 NOT_PRODUCT(if (approximate) ++pc_nmethod_stats.pc_desc_approx);
333
334 // Note: one might think that caching the most recently
335 // read value separately would be a win, but one would be
336 // wrong. When many threads are updating it, the cache
337 // line it's in would bounce between caches, negating
338 // any benefit.
339
340 // In order to prevent race conditions do not load cache elements
341 // repeatedly, but use a local copy:
342 PcDesc* res;
343
344 // Step one: Check the most recently added value.
345 res = _pc_descs[0];
346 if (res == NULL) return NULL; // native method; no PcDescs at all
347 if (match_desc(res, pc_offset, approximate)) {
348 NOT_PRODUCT(++pc_nmethod_stats.pc_desc_repeats);
349 return res;
350 }
351
352 // Step two: Check the rest of the LRU cache.
353 for (int i = 1; i < cache_size; ++i) {
354 res = _pc_descs[i];
355 if (res->pc_offset() < 0) break; // optimization: skip empty cache
356 if (match_desc(res, pc_offset, approximate)) {
357 NOT_PRODUCT(++pc_nmethod_stats.pc_desc_hits);
358 return res;
359 }
360 }
361
362 // Report failure.
363 return NULL;
364 }
365
366 void PcDescCache::add_pc_desc(PcDesc* pc_desc) {
367 NOT_PRODUCT(++pc_nmethod_stats.pc_desc_adds);
368 // Update the LRU cache by shifting pc_desc forward.
369 for (int i = 0; i < cache_size; i++) {
370 PcDesc* next = _pc_descs[i];
371 _pc_descs[i] = pc_desc;
372 pc_desc = next;
373 }
374 }
375
376 // adjust pcs_size so that it is a multiple of both oopSize and
377 // sizeof(PcDesc) (assumes that if sizeof(PcDesc) is not a multiple
378 // of oopSize, then 2*sizeof(PcDesc) is)
379 static int adjust_pcs_size(int pcs_size) {
380 int nsize = align_up(pcs_size, oopSize);
381 if ((nsize % sizeof(PcDesc)) != 0) {
382 nsize = pcs_size + sizeof(PcDesc);
383 }
384 assert((nsize % oopSize) == 0, "correct alignment");
385 return nsize;
386 }
387
388
389 int nmethod::total_size() const {
390 return
391 consts_size() +
392 insts_size() +
393 stub_size() +
394 scopes_data_size() +
395 scopes_pcs_size() +
396 handler_table_size() +
397 nul_chk_table_size();
398 }
399
400 address* nmethod::orig_pc_addr(const frame* fr) {
401 return (address*) ((address)fr->unextended_sp() + _orig_pc_offset);
402 }
403
404 const char* nmethod::compile_kind() const {
405 if (is_osr_method()) return "osr";
406 if (method() != NULL && is_native_method()) return "c2n";
407 return NULL;
408 }
409
410 // Fill in default values for various flag fields
411 void nmethod::init_defaults() {
412 _state = not_installed;
413 _has_flushed_dependencies = 0;
414 _lock_count = 0;
415 _stack_traversal_mark = 0;
416 _unload_reported = false; // jvmti state
417 _is_far_code = false; // nmethods are located in CodeCache
418
419 #ifdef ASSERT
420 _oops_are_stale = false;
421 #endif
422
423 _oops_do_mark_link = NULL;
424 _jmethod_id = NULL;
425 _osr_link = NULL;
426 #if INCLUDE_RTM_OPT
427 _rtm_state = NoRTM;
428 #endif
429 #if INCLUDE_JVMCI
430 _jvmci_installed_code = NULL;
431 _speculation_log = NULL;
432 _jvmci_installed_code_triggers_invalidation = false;
433 #endif
434 }
435
436 nmethod* nmethod::new_native_nmethod(const methodHandle& method,
437 int compile_id,
438 CodeBuffer *code_buffer,
439 int vep_offset,
440 int frame_complete,
441 int frame_size,
442 ByteSize basic_lock_owner_sp_offset,
443 ByteSize basic_lock_sp_offset,
444 OopMapSet* oop_maps) {
445 code_buffer->finalize_oop_references(method);
446 // create nmethod
447 nmethod* nm = NULL;
448 {
449 MutexLockerEx mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);
450 int native_nmethod_size = CodeBlob::allocation_size(code_buffer, sizeof(nmethod));
451 CodeOffsets offsets;
452 offsets.set_value(CodeOffsets::Verified_Entry, vep_offset);
453 offsets.set_value(CodeOffsets::Frame_Complete, frame_complete);
454 nm = new (native_nmethod_size, CompLevel_none) nmethod(method(), compiler_none, native_nmethod_size,
455 compile_id, &offsets,
456 code_buffer, frame_size,
457 basic_lock_owner_sp_offset,
458 basic_lock_sp_offset, oop_maps);
459 NOT_PRODUCT(if (nm != NULL) native_nmethod_stats.note_native_nmethod(nm));
460 }
461
462 if (nm != NULL) {
463 // verify nmethod
464 debug_only(nm->verify();) // might block
465
466 nm->log_new_nmethod();
467 nm->make_in_use();
468 }
469 return nm;
470 }
471
472 nmethod* nmethod::new_nmethod(const methodHandle& method,
473 int compile_id,
474 int entry_bci,
475 CodeOffsets* offsets,
476 int orig_pc_offset,
477 DebugInformationRecorder* debug_info,
478 Dependencies* dependencies,
479 CodeBuffer* code_buffer, int frame_size,
480 OopMapSet* oop_maps,
481 ExceptionHandlerTable* handler_table,
482 ImplicitExceptionTable* nul_chk_table,
483 AbstractCompiler* compiler,
484 int comp_level
485 #if INCLUDE_JVMCI
486 , jweak installed_code,
487 jweak speculationLog
488 #endif
489 )
490 {
491 assert(debug_info->oop_recorder() == code_buffer->oop_recorder(), "shared OR");
492 code_buffer->finalize_oop_references(method);
493 // create nmethod
494 nmethod* nm = NULL;
495 { MutexLockerEx mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);
496 int nmethod_size =
497 CodeBlob::allocation_size(code_buffer, sizeof(nmethod))
498 + adjust_pcs_size(debug_info->pcs_size())
499 + align_up((int)dependencies->size_in_bytes(), oopSize)
500 + align_up(handler_table->size_in_bytes() , oopSize)
501 + align_up(nul_chk_table->size_in_bytes() , oopSize)
502 + align_up(debug_info->data_size() , oopSize);
503
504 nm = new (nmethod_size, comp_level)
505 nmethod(method(), compiler->type(), nmethod_size, compile_id, entry_bci, offsets,
506 orig_pc_offset, debug_info, dependencies, code_buffer, frame_size,
507 oop_maps,
508 handler_table,
509 nul_chk_table,
510 compiler,
511 comp_level
512 #if INCLUDE_JVMCI
513 , installed_code,
514 speculationLog
515 #endif
516 );
517
518 if (nm != NULL) {
519 // To make dependency checking during class loading fast, record
520 // the nmethod dependencies in the classes it is dependent on.
521 // This allows the dependency checking code to simply walk the
522 // class hierarchy above the loaded class, checking only nmethods
523 // which are dependent on those classes. The slow way is to
524 // check every nmethod for dependencies which makes it linear in
525 // the number of methods compiled. For applications with a lot
526 // classes the slow way is too slow.
527 for (Dependencies::DepStream deps(nm); deps.next(); ) {
528 if (deps.type() == Dependencies::call_site_target_value) {
529 // CallSite dependencies are managed on per-CallSite instance basis.
530 oop call_site = deps.argument_oop(0);
531 MethodHandles::add_dependent_nmethod(call_site, nm);
532 } else {
533 Klass* klass = deps.context_type();
534 if (klass == NULL) {
535 continue; // ignore things like evol_method
536 }
537 // record this nmethod as dependent on this klass
538 InstanceKlass::cast(klass)->add_dependent_nmethod(nm);
539 }
540 }
541 NOT_PRODUCT(if (nm != NULL) note_java_nmethod(nm));
542 }
543 }
544 // Do verification and logging outside CodeCache_lock.
545 if (nm != NULL) {
546 // Safepoints in nmethod::verify aren't allowed because nm hasn't been installed yet.
547 DEBUG_ONLY(nm->verify();)
548 nm->log_new_nmethod();
549 }
550 return nm;
551 }
552
553 // For native wrappers
554 nmethod::nmethod(
555 Method* method,
556 CompilerType type,
557 int nmethod_size,
558 int compile_id,
559 CodeOffsets* offsets,
560 CodeBuffer* code_buffer,
561 int frame_size,
562 ByteSize basic_lock_owner_sp_offset,
563 ByteSize basic_lock_sp_offset,
564 OopMapSet* oop_maps )
565 : CompiledMethod(method, "native nmethod", type, nmethod_size, sizeof(nmethod), code_buffer, offsets->value(CodeOffsets::Frame_Complete), frame_size, oop_maps, false),
566 _is_unloading_state(0),
567 _native_receiver_sp_offset(basic_lock_owner_sp_offset),
568 _native_basic_lock_sp_offset(basic_lock_sp_offset)
569 {
570 {
571 int scopes_data_offset = 0;
572 int deoptimize_offset = 0;
573 int deoptimize_mh_offset = 0;
574
575 debug_only(NoSafepointVerifier nsv;)
576 assert_locked_or_safepoint(CodeCache_lock);
577
578 init_defaults();
579 _entry_bci = InvocationEntryBci;
580 // We have no exception handler or deopt handler make the
581 // values something that will never match a pc like the nmethod vtable entry
582 _exception_offset = 0;
583 _orig_pc_offset = 0;
584
585 _consts_offset = data_offset();
586 _stub_offset = data_offset();
587 _oops_offset = data_offset();
588 _metadata_offset = _oops_offset + align_up(code_buffer->total_oop_size(), oopSize);
589 scopes_data_offset = _metadata_offset + align_up(code_buffer->total_metadata_size(), wordSize);
590 _scopes_pcs_offset = scopes_data_offset;
591 _dependencies_offset = _scopes_pcs_offset;
592 _handler_table_offset = _dependencies_offset;
593 _nul_chk_table_offset = _handler_table_offset;
594 _nmethod_end_offset = _nul_chk_table_offset;
595 _compile_id = compile_id;
596 _comp_level = CompLevel_none;
597 _entry_point = code_begin() + offsets->value(CodeOffsets::Entry);
598 _verified_entry_point = code_begin() + offsets->value(CodeOffsets::Verified_Entry);
599 _osr_entry_point = NULL;
600 _exception_cache = NULL;
601 _pc_desc_container.reset_to(NULL);
602 _hotness_counter = NMethodSweeper::hotness_counter_reset_val();
603
604 _scopes_data_begin = (address) this + scopes_data_offset;
605 _deopt_handler_begin = (address) this + deoptimize_offset;
606 _deopt_mh_handler_begin = (address) this + deoptimize_mh_offset;
607
608 code_buffer->copy_code_and_locs_to(this);
609 code_buffer->copy_values_to(this);
610
611 clear_unloading_state();
612
613 Universe::heap()->register_nmethod(this);
614 debug_only(Universe::heap()->verify_nmethod(this));
615
616 CodeCache::commit(this);
617 }
618
619 if (PrintNativeNMethods || PrintDebugInfo || PrintRelocations || PrintDependencies) {
620 ttyLocker ttyl; // keep the following output all in one block
621 // This output goes directly to the tty, not the compiler log.
622 // To enable tools to match it up with the compilation activity,
623 // be sure to tag this tty output with the compile ID.
624 if (xtty != NULL) {
625 xtty->begin_head("print_native_nmethod");
626 xtty->method(_method);
627 xtty->stamp();
628 xtty->end_head(" address='" INTPTR_FORMAT "'", (intptr_t) this);
629 }
630 // print the header part first
631 print();
632 // then print the requested information
633 if (PrintNativeNMethods) {
634 print_code();
635 if (oop_maps != NULL) {
636 oop_maps->print();
637 }
638 }
639 if (PrintRelocations) {
640 print_relocations();
641 }
642 if (xtty != NULL) {
643 xtty->tail("print_native_nmethod");
644 }
645 }
646 }
647
648 void* nmethod::operator new(size_t size, int nmethod_size, int comp_level) throw () {
649 return CodeCache::allocate(nmethod_size, CodeCache::get_code_blob_type(comp_level));
650 }
651
652 nmethod::nmethod(
653 Method* method,
654 CompilerType type,
655 int nmethod_size,
656 int compile_id,
657 int entry_bci,
658 CodeOffsets* offsets,
659 int orig_pc_offset,
660 DebugInformationRecorder* debug_info,
661 Dependencies* dependencies,
662 CodeBuffer *code_buffer,
663 int frame_size,
664 OopMapSet* oop_maps,
665 ExceptionHandlerTable* handler_table,
666 ImplicitExceptionTable* nul_chk_table,
667 AbstractCompiler* compiler,
668 int comp_level
669 #if INCLUDE_JVMCI
670 , jweak installed_code,
671 jweak speculation_log
672 #endif
673 )
674 : CompiledMethod(method, "nmethod", type, nmethod_size, sizeof(nmethod), code_buffer, offsets->value(CodeOffsets::Frame_Complete), frame_size, oop_maps, false),
675 _is_unloading_state(0),
676 _native_receiver_sp_offset(in_ByteSize(-1)),
677 _native_basic_lock_sp_offset(in_ByteSize(-1))
678 {
679 assert(debug_info->oop_recorder() == code_buffer->oop_recorder(), "shared OR");
680 {
681 debug_only(NoSafepointVerifier nsv;)
682 assert_locked_or_safepoint(CodeCache_lock);
683
684 _deopt_handler_begin = (address) this;
685 _deopt_mh_handler_begin = (address) this;
686
687 init_defaults();
688 _entry_bci = entry_bci;
689 _compile_id = compile_id;
690 _comp_level = comp_level;
691 _orig_pc_offset = orig_pc_offset;
692 _hotness_counter = NMethodSweeper::hotness_counter_reset_val();
693
694 // Section offsets
695 _consts_offset = content_offset() + code_buffer->total_offset_of(code_buffer->consts());
696 _stub_offset = content_offset() + code_buffer->total_offset_of(code_buffer->stubs());
697 set_ctable_begin(header_begin() + _consts_offset);
698
699 #if INCLUDE_JVMCI
700 _jvmci_installed_code = installed_code;
701 _speculation_log = speculation_log;
702 oop obj = JNIHandles::resolve(installed_code);
703 if (obj == NULL || (obj->is_a(HotSpotNmethod::klass()) && HotSpotNmethod::isDefault(obj))) {
704 _jvmci_installed_code_triggers_invalidation = false;
705 } else {
706 _jvmci_installed_code_triggers_invalidation = true;
707 }
708
709 if (compiler->is_jvmci()) {
710 // JVMCI might not produce any stub sections
711 if (offsets->value(CodeOffsets::Exceptions) != -1) {
712 _exception_offset = code_offset() + offsets->value(CodeOffsets::Exceptions);
713 } else {
714 _exception_offset = -1;
715 }
716 if (offsets->value(CodeOffsets::Deopt) != -1) {
717 _deopt_handler_begin = (address) this + code_offset() + offsets->value(CodeOffsets::Deopt);
718 } else {
719 _deopt_handler_begin = NULL;
720 }
721 if (offsets->value(CodeOffsets::DeoptMH) != -1) {
722 _deopt_mh_handler_begin = (address) this + code_offset() + offsets->value(CodeOffsets::DeoptMH);
723 } else {
724 _deopt_mh_handler_begin = NULL;
725 }
726 } else {
727 #endif
728 // Exception handler and deopt handler are in the stub section
729 assert(offsets->value(CodeOffsets::Exceptions) != -1, "must be set");
730 assert(offsets->value(CodeOffsets::Deopt ) != -1, "must be set");
731
732 _exception_offset = _stub_offset + offsets->value(CodeOffsets::Exceptions);
733 _deopt_handler_begin = (address) this + _stub_offset + offsets->value(CodeOffsets::Deopt);
734 if (offsets->value(CodeOffsets::DeoptMH) != -1) {
735 _deopt_mh_handler_begin = (address) this + _stub_offset + offsets->value(CodeOffsets::DeoptMH);
736 } else {
737 _deopt_mh_handler_begin = NULL;
738 #if INCLUDE_JVMCI
739 }
740 #endif
741 }
742 if (offsets->value(CodeOffsets::UnwindHandler) != -1) {
743 _unwind_handler_offset = code_offset() + offsets->value(CodeOffsets::UnwindHandler);
744 } else {
745 _unwind_handler_offset = -1;
746 }
747
748 _oops_offset = data_offset();
749 _metadata_offset = _oops_offset + align_up(code_buffer->total_oop_size(), oopSize);
750 int scopes_data_offset = _metadata_offset + align_up(code_buffer->total_metadata_size(), wordSize);
751
752 _scopes_pcs_offset = scopes_data_offset + align_up(debug_info->data_size (), oopSize);
753 _dependencies_offset = _scopes_pcs_offset + adjust_pcs_size(debug_info->pcs_size());
754 _handler_table_offset = _dependencies_offset + align_up((int)dependencies->size_in_bytes (), oopSize);
755 _nul_chk_table_offset = _handler_table_offset + align_up(handler_table->size_in_bytes(), oopSize);
756 _nmethod_end_offset = _nul_chk_table_offset + align_up(nul_chk_table->size_in_bytes(), oopSize);
757 _entry_point = code_begin() + offsets->value(CodeOffsets::Entry);
758 _verified_entry_point = code_begin() + offsets->value(CodeOffsets::Verified_Entry);
759 _osr_entry_point = code_begin() + offsets->value(CodeOffsets::OSR_Entry);
760 _exception_cache = NULL;
761
762 _scopes_data_begin = (address) this + scopes_data_offset;
763
764 _pc_desc_container.reset_to(scopes_pcs_begin());
765
766 code_buffer->copy_code_and_locs_to(this);
767 // Copy contents of ScopeDescRecorder to nmethod
768 code_buffer->copy_values_to(this);
769 debug_info->copy_to(this);
770 dependencies->copy_to(this);
771 clear_unloading_state();
772
773 Universe::heap()->register_nmethod(this);
774 debug_only(Universe::heap()->verify_nmethod(this));
775
776 CodeCache::commit(this);
777
778 // Copy contents of ExceptionHandlerTable to nmethod
779 handler_table->copy_to(this);
780 nul_chk_table->copy_to(this);
781
782 // we use the information of entry points to find out if a method is
783 // static or non static
784 assert(compiler->is_c2() || compiler->is_jvmci() ||
785 _method->is_static() == (entry_point() == _verified_entry_point),
786 " entry points must be same for static methods and vice versa");
787 }
788 }
789
790 // Print a short set of xml attributes to identify this nmethod. The
791 // output should be embedded in some other element.
792 void nmethod::log_identity(xmlStream* log) const {
793 log->print(" compile_id='%d'", compile_id());
794 const char* nm_kind = compile_kind();
795 if (nm_kind != NULL) log->print(" compile_kind='%s'", nm_kind);
796 log->print(" compiler='%s'", compiler_name());
797 if (TieredCompilation) {
798 log->print(" level='%d'", comp_level());
799 }
800 #if INCLUDE_JVMCI
801 char buffer[O_BUFLEN];
802 char* jvmci_name = jvmci_installed_code_name(buffer, O_BUFLEN);
803 if (jvmci_name != NULL) {
804 log->print(" jvmci_installed_code_name='");
805 log->text("%s", jvmci_name);
806 log->print("'");
807 }
808 #endif
809 }
810
811
812 #define LOG_OFFSET(log, name) \
813 if (p2i(name##_end()) - p2i(name##_begin())) \
814 log->print(" " XSTR(name) "_offset='" INTX_FORMAT "'" , \
815 p2i(name##_begin()) - p2i(this))
816
817
818 void nmethod::log_new_nmethod() const {
819 if (LogCompilation && xtty != NULL) {
820 ttyLocker ttyl;
821 HandleMark hm;
822 xtty->begin_elem("nmethod");
823 log_identity(xtty);
824 xtty->print(" entry='" INTPTR_FORMAT "' size='%d'", p2i(code_begin()), size());
825 xtty->print(" address='" INTPTR_FORMAT "'", p2i(this));
826
827 LOG_OFFSET(xtty, relocation);
828 LOG_OFFSET(xtty, consts);
829 LOG_OFFSET(xtty, insts);
830 LOG_OFFSET(xtty, stub);
831 LOG_OFFSET(xtty, scopes_data);
832 LOG_OFFSET(xtty, scopes_pcs);
833 LOG_OFFSET(xtty, dependencies);
834 LOG_OFFSET(xtty, handler_table);
835 LOG_OFFSET(xtty, nul_chk_table);
836 LOG_OFFSET(xtty, oops);
837 LOG_OFFSET(xtty, metadata);
838
839 xtty->method(method());
840 xtty->stamp();
841 xtty->end_elem();
842 }
843 }
844
845 #undef LOG_OFFSET
846
847
848 // Print out more verbose output usually for a newly created nmethod.
849 void nmethod::print_on(outputStream* st, const char* msg) const {
850 if (st != NULL) {
851 ttyLocker ttyl;
852 if (WizardMode) {
853 CompileTask::print(st, this, msg, /*short_form:*/ true);
854 st->print_cr(" (" INTPTR_FORMAT ")", p2i(this));
855 } else {
856 CompileTask::print(st, this, msg, /*short_form:*/ false);
857 }
858 }
859 }
860
861 void nmethod::maybe_print_nmethod(DirectiveSet* directive) {
862 bool printnmethods = directive->PrintAssemblyOption || directive->PrintNMethodsOption;
863 if (printnmethods || PrintDebugInfo || PrintRelocations || PrintDependencies || PrintExceptionHandlers) {
864 print_nmethod(printnmethods);
865 }
866 }
867
868 void nmethod::print_nmethod(bool printmethod) {
869 ttyLocker ttyl; // keep the following output all in one block
870 if (xtty != NULL) {
871 xtty->begin_head("print_nmethod");
872 xtty->stamp();
873 xtty->end_head();
874 }
875 // print the header part first
876 print();
877 // then print the requested information
878 if (printmethod) {
879 print_code();
880 print_pcs();
881 if (oop_maps()) {
882 oop_maps()->print();
883 }
884 }
885 if (printmethod || PrintDebugInfo || CompilerOracle::has_option_string(_method, "PrintDebugInfo")) {
886 print_scopes();
887 }
888 if (printmethod || PrintRelocations || CompilerOracle::has_option_string(_method, "PrintRelocations")) {
889 print_relocations();
890 }
891 if (printmethod || PrintDependencies || CompilerOracle::has_option_string(_method, "PrintDependencies")) {
892 print_dependencies();
893 }
894 if (printmethod || PrintExceptionHandlers) {
895 print_handler_table();
896 print_nul_chk_table();
897 }
898 if (printmethod) {
899 print_recorded_oops();
900 print_recorded_metadata();
901 }
902 if (xtty != NULL) {
903 xtty->tail("print_nmethod");
904 }
905 }
906
907
908 // Promote one word from an assembly-time handle to a live embedded oop.
909 inline void nmethod::initialize_immediate_oop(oop* dest, jobject handle) {
910 if (handle == NULL ||
911 // As a special case, IC oops are initialized to 1 or -1.
912 handle == (jobject) Universe::non_oop_word()) {
913 (*dest) = (oop) handle;
914 } else {
915 (*dest) = JNIHandles::resolve_non_null(handle);
916 }
917 }
918
919
920 // Have to have the same name because it's called by a template
921 void nmethod::copy_values(GrowableArray<jobject>* array) {
922 int length = array->length();
923 assert((address)(oops_begin() + length) <= (address)oops_end(), "oops big enough");
924 oop* dest = oops_begin();
925 for (int index = 0 ; index < length; index++) {
926 initialize_immediate_oop(&dest[index], array->at(index));
927 }
928
929 // Now we can fix up all the oops in the code. We need to do this
930 // in the code because the assembler uses jobjects as placeholders.
931 // The code and relocations have already been initialized by the
932 // CodeBlob constructor, so it is valid even at this early point to
933 // iterate over relocations and patch the code.
934 fix_oop_relocations(NULL, NULL, /*initialize_immediates=*/ true);
935 }
936
937 void nmethod::copy_values(GrowableArray<Metadata*>* array) {
938 int length = array->length();
939 assert((address)(metadata_begin() + length) <= (address)metadata_end(), "big enough");
940 Metadata** dest = metadata_begin();
941 for (int index = 0 ; index < length; index++) {
942 dest[index] = array->at(index);
943 }
944 }
945
946 void nmethod::fix_oop_relocations(address begin, address end, bool initialize_immediates) {
947 // re-patch all oop-bearing instructions, just in case some oops moved
948 RelocIterator iter(this, begin, end);
949 while (iter.next()) {
950 if (iter.type() == relocInfo::oop_type) {
951 oop_Relocation* reloc = iter.oop_reloc();
952 if (initialize_immediates && reloc->oop_is_immediate()) {
953 oop* dest = reloc->oop_addr();
954 initialize_immediate_oop(dest, (jobject) *dest);
955 }
956 // Refresh the oop-related bits of this instruction.
957 reloc->fix_oop_relocation();
958 } else if (iter.type() == relocInfo::metadata_type) {
959 metadata_Relocation* reloc = iter.metadata_reloc();
960 reloc->fix_metadata_relocation();
961 }
962 }
963 }
964
965
966 void nmethod::verify_clean_inline_caches() {
967 assert(CompiledICLocker::is_safe(this), "mt unsafe call");
968
969 ResourceMark rm;
970 RelocIterator iter(this, oops_reloc_begin());
971 while(iter.next()) {
972 switch(iter.type()) {
973 case relocInfo::virtual_call_type:
974 case relocInfo::opt_virtual_call_type: {
975 CompiledIC *ic = CompiledIC_at(&iter);
976 // Ok, to lookup references to zombies here
977 CodeBlob *cb = CodeCache::find_blob_unsafe(ic->ic_destination());
978 assert(cb != NULL, "destination not in CodeBlob?");
979 nmethod* nm = cb->as_nmethod_or_null();
980 if( nm != NULL ) {
981 // Verify that inline caches pointing to both zombie and not_entrant methods are clean
982 if (!nm->is_in_use() || (nm->method()->code() != nm)) {
983 assert(ic->is_clean(), "IC should be clean");
984 }
985 }
986 break;
987 }
988 case relocInfo::static_call_type: {
989 CompiledStaticCall *csc = compiledStaticCall_at(iter.reloc());
990 CodeBlob *cb = CodeCache::find_blob_unsafe(csc->destination());
991 assert(cb != NULL, "destination not in CodeBlob?");
992 nmethod* nm = cb->as_nmethod_or_null();
993 if( nm != NULL ) {
994 // Verify that inline caches pointing to both zombie and not_entrant methods are clean
995 if (!nm->is_in_use() || (nm->method()->code() != nm)) {
996 assert(csc->is_clean(), "IC should be clean");
997 }
998 }
999 break;
1000 }
1001 default:
1002 break;
1003 }
1004 }
1005 }
1006
1007 // This is a private interface with the sweeper.
1008 void nmethod::mark_as_seen_on_stack() {
1009 assert(is_alive(), "Must be an alive method");
1010 // Set the traversal mark to ensure that the sweeper does 2
1011 // cleaning passes before moving to zombie.
1012 set_stack_traversal_mark(NMethodSweeper::traversal_count());
1013 }
1014
1015 // Tell if a non-entrant method can be converted to a zombie (i.e.,
1016 // there are no activations on the stack, not in use by the VM,
1017 // and not in use by the ServiceThread)
1018 bool nmethod::can_convert_to_zombie() {
1019 // Note that this is called when the sweeper has observed the nmethod to be
1020 // not_entrant. However, with concurrent code cache unloading, the state
1021 // might have moved on to unloaded if it is_unloading(), due to racing
1022 // concurrent GC threads.
1023 assert(is_not_entrant() || is_unloading(), "must be a non-entrant method");
1024
1025 // Since the nmethod sweeper only does partial sweep the sweeper's traversal
1026 // count can be greater than the stack traversal count before it hits the
1027 // nmethod for the second time.
1028 // If an is_unloading() nmethod is still not_entrant, then it is not safe to
1029 // convert it to zombie due to GC unloading interactions. However, if it
1030 // has become unloaded, then it is okay to convert such nmethods to zombie.
1031 return stack_traversal_mark() + 1 < NMethodSweeper::traversal_count() &&
1032 !is_locked_by_vm() && (!is_unloading() || is_unloaded());
1033 }
1034
1035 void nmethod::inc_decompile_count() {
1036 if (!is_compiled_by_c2() && !is_compiled_by_jvmci()) return;
1037 // Could be gated by ProfileTraps, but do not bother...
1038 Method* m = method();
1039 if (m == NULL) return;
1040 MethodData* mdo = m->method_data();
1041 if (mdo == NULL) return;
1042 // There is a benign race here. See comments in methodData.hpp.
1043 mdo->inc_decompile_count();
1044 }
1045
1046 void nmethod::make_unloaded() {
1047 post_compiled_method_unload();
1048
1049 // This nmethod is being unloaded, make sure that dependencies
1050 // recorded in instanceKlasses get flushed.
1051 // Since this work is being done during a GC, defer deleting dependencies from the
1052 // InstanceKlass.
1053 assert(Universe::heap()->is_gc_active() || Thread::current()->is_ConcurrentGC_thread(),
1054 "should only be called during gc");
1055 flush_dependencies(/*delete_immediately*/false);
1056
1057 // Break cycle between nmethod & method
1058 LogTarget(Trace, class, unload, nmethod) lt;
1059 if (lt.is_enabled()) {
1060 LogStream ls(lt);
1061 ls.print("making nmethod " INTPTR_FORMAT
1062 " unloadable, Method*(" INTPTR_FORMAT
1063 ") ",
1064 p2i(this), p2i(_method));
1065 ls.cr();
1066 }
1067 // Unlink the osr method, so we do not look this up again
1068 if (is_osr_method()) {
1069 // Invalidate the osr nmethod only once
1070 if (is_in_use()) {
1071 invalidate_osr_method();
1072 }
1073 #ifdef ASSERT
1074 if (method() != NULL) {
1075 // Make sure osr nmethod is invalidated, i.e. not on the list
1076 bool found = method()->method_holder()->remove_osr_nmethod(this);
1077 assert(!found, "osr nmethod should have been invalidated");
1078 }
1079 #endif
1080 }
1081
1082 // If _method is already NULL the Method* is about to be unloaded,
1083 // so we don't have to break the cycle. Note that it is possible to
1084 // have the Method* live here, in case we unload the nmethod because
1085 // it is pointing to some oop (other than the Method*) being unloaded.
1086 if (_method != NULL) {
1087 // OSR methods point to the Method*, but the Method* does not
1088 // point back!
1089 if (_method->code() == this) {
1090 _method->clear_code(); // Break a cycle
1091 }
1092 }
1093
1094 // Make the class unloaded - i.e., change state and notify sweeper
1095 assert(SafepointSynchronize::is_at_safepoint() || Thread::current()->is_ConcurrentGC_thread(),
1096 "must be at safepoint");
1097
1098 {
1099 // Clear ICStubs and release any CompiledICHolders.
1100 CompiledICLocker ml(this);
1101 clear_ic_callsites();
1102 }
1103
1104 // Unregister must be done before the state change
1105 {
1106 MutexLockerEx ml(SafepointSynchronize::is_at_safepoint() ? NULL : CodeCache_lock,
1107 Mutex::_no_safepoint_check_flag);
1108 Universe::heap()->unregister_nmethod(this);
1109 CodeCache::unregister_old_nmethod(this);
1110 }
1111
1112 // Clear the method of this dead nmethod
1113 set_method(NULL);
1114
1115 // Log the unloading.
1116 log_state_change();
1117
1118 #if INCLUDE_JVMCI
1119 // The method can only be unloaded after the pointer to the installed code
1120 // Java wrapper is no longer alive. Here we need to clear out this weak
1121 // reference to the dead object.
1122 maybe_invalidate_installed_code();
1123 #endif
1124
1125 // The Method* is gone at this point
1126 assert(_method == NULL, "Tautology");
1127
1128 set_osr_link(NULL);
1129 NMethodSweeper::report_state_change(this);
1130
1131 // The release is only needed for compile-time ordering, as accesses
1132 // into the nmethod after the store are not safe due to the sweeper
1133 // being allowed to free it when the store is observed, during
1134 // concurrent nmethod unloading. Therefore, there is no need for
1135 // acquire on the loader side.
1136 OrderAccess::release_store(&_state, (signed char)unloaded);
1137 }
1138
1139 void nmethod::invalidate_osr_method() {
1140 assert(_entry_bci != InvocationEntryBci, "wrong kind of nmethod");
1141 // Remove from list of active nmethods
1142 if (method() != NULL) {
1143 method()->method_holder()->remove_osr_nmethod(this);
1144 }
1145 }
1146
1147 void nmethod::log_state_change() const {
1148 if (LogCompilation) {
1149 if (xtty != NULL) {
1150 ttyLocker ttyl; // keep the following output all in one block
1151 if (_state == unloaded) {
1152 xtty->begin_elem("make_unloaded thread='" UINTX_FORMAT "'",
1153 os::current_thread_id());
1154 } else {
1155 xtty->begin_elem("make_not_entrant thread='" UINTX_FORMAT "'%s",
1156 os::current_thread_id(),
1157 (_state == zombie ? " zombie='1'" : ""));
1158 }
1159 log_identity(xtty);
1160 xtty->stamp();
1161 xtty->end_elem();
1162 }
1163 }
1164
1165 const char *state_msg = _state == zombie ? "made zombie" : "made not entrant";
1166 CompileTask::print_ul(this, state_msg);
1167 if (PrintCompilation && _state != unloaded) {
1168 print_on(tty, state_msg);
1169 }
1170 }
1171
1172 void nmethod::unlink_from_method(bool acquire_lock) {
1173 // We need to check if both the _code and _from_compiled_code_entry_point
1174 // refer to this nmethod because there is a race in setting these two fields
1175 // in Method* as seen in bugid 4947125.
1176 // If the vep() points to the zombie nmethod, the memory for the nmethod
1177 // could be flushed and the compiler and vtable stubs could still call
1178 // through it.
1179 if (method() != NULL && (method()->code() == this ||
1180 method()->from_compiled_entry() == verified_entry_point())) {
1181 method()->clear_code(acquire_lock);
1182 }
1183 }
1184
1185 /**
1186 * Common functionality for both make_not_entrant and make_zombie
1187 */
1188 bool nmethod::make_not_entrant_or_zombie(int state) {
1189 assert(state == zombie || state == not_entrant, "must be zombie or not_entrant");
1190 assert(!is_zombie(), "should not already be a zombie");
1191
1192 if (_state == state) {
1193 // Avoid taking the lock if already in required state.
1194 // This is safe from races because the state is an end-state,
1195 // which the nmethod cannot back out of once entered.
1196 // No need for fencing either.
1197 return false;
1198 }
1199
1200 // Make sure neither the nmethod nor the method is flushed in case of a safepoint in code below.
1201 nmethodLocker nml(this);
1202 methodHandle the_method(method());
1203 // This can be called while the system is already at a safepoint which is ok
1204 NoSafepointVerifier nsv(true, !SafepointSynchronize::is_at_safepoint());
1205
1206 // during patching, depending on the nmethod state we must notify the GC that
1207 // code has been unloaded, unregistering it. We cannot do this right while
1208 // holding the Patching_lock because we need to use the CodeCache_lock. This
1209 // would be prone to deadlocks.
1210 // This flag is used to remember whether we need to later lock and unregister.
1211 bool nmethod_needs_unregister = false;
1212
1213 {
1214 // invalidate osr nmethod before acquiring the patching lock since
1215 // they both acquire leaf locks and we don't want a deadlock.
1216 // This logic is equivalent to the logic below for patching the
1217 // verified entry point of regular methods. We check that the
1218 // nmethod is in use to ensure that it is invalidated only once.
1219 if (is_osr_method() && is_in_use()) {
1220 // this effectively makes the osr nmethod not entrant
1221 invalidate_osr_method();
1222 }
1223
1224 // Enter critical section. Does not block for safepoint.
1225 MutexLockerEx pl(Patching_lock, Mutex::_no_safepoint_check_flag);
1226
1227 if (_state == state) {
1228 // another thread already performed this transition so nothing
1229 // to do, but return false to indicate this.
1230 return false;
1231 }
1232
1233 // The caller can be calling the method statically or through an inline
1234 // cache call.
1235 if (!is_osr_method() && !is_not_entrant()) {
1236 NativeJump::patch_verified_entry(entry_point(), verified_entry_point(),
1237 SharedRuntime::get_handle_wrong_method_stub());
1238 }
1239
1240 if (is_in_use() && update_recompile_counts()) {
1241 // It's a true state change, so mark the method as decompiled.
1242 // Do it only for transition from alive.
1243 inc_decompile_count();
1244 }
1245
1246 // If the state is becoming a zombie, signal to unregister the nmethod with
1247 // the heap.
1248 // This nmethod may have already been unloaded during a full GC.
1249 if ((state == zombie) && !is_unloaded()) {
1250 nmethod_needs_unregister = true;
1251 }
1252
1253 // Must happen before state change. Otherwise we have a race condition in
1254 // nmethod::can_not_entrant_be_converted(). I.e., a method can immediately
1255 // transition its state from 'not_entrant' to 'zombie' without having to wait
1256 // for stack scanning.
1257 if (state == not_entrant) {
1258 mark_as_seen_on_stack();
1259 OrderAccess::storestore(); // _stack_traversal_mark and _state
1260 }
1261
1262 // Change state
1263 _state = state;
1264
1265 // Log the transition once
1266 log_state_change();
1267
1268 // Invalidate while holding the patching lock
1269 JVMCI_ONLY(maybe_invalidate_installed_code());
1270
1271 // Remove nmethod from method.
1272 unlink_from_method(false /* already owns Patching_lock */);
1273 } // leave critical region under Patching_lock
1274
1275 #ifdef ASSERT
1276 if (is_osr_method() && method() != NULL) {
1277 // Make sure osr nmethod is invalidated, i.e. not on the list
1278 bool found = method()->method_holder()->remove_osr_nmethod(this);
1279 assert(!found, "osr nmethod should have been invalidated");
1280 }
1281 #endif
1282
1283 // When the nmethod becomes zombie it is no longer alive so the
1284 // dependencies must be flushed. nmethods in the not_entrant
1285 // state will be flushed later when the transition to zombie
1286 // happens or they get unloaded.
1287 if (state == zombie) {
1288 {
1289 // Flushing dependencies must be done before any possible
1290 // safepoint can sneak in, otherwise the oops used by the
1291 // dependency logic could have become stale.
1292 MutexLockerEx mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);
1293 if (nmethod_needs_unregister) {
1294 Universe::heap()->unregister_nmethod(this);
1295 CodeCache::unregister_old_nmethod(this);
1296 }
1297 flush_dependencies(/*delete_immediately*/true);
1298 }
1299
1300 // Clear ICStubs to prevent back patching stubs of zombie or flushed
1301 // nmethods during the next safepoint (see ICStub::finalize), as well
1302 // as to free up CompiledICHolder resources.
1303 {
1304 CompiledICLocker ml(this);
1305 clear_ic_callsites();
1306 }
1307
1308 // zombie only - if a JVMTI agent has enabled the CompiledMethodUnload
1309 // event and it hasn't already been reported for this nmethod then
1310 // report it now. The event may have been reported earlier if the GC
1311 // marked it for unloading). JvmtiDeferredEventQueue support means
1312 // we no longer go to a safepoint here.
1313 post_compiled_method_unload();
1314
1315 #ifdef ASSERT
1316 // It's no longer safe to access the oops section since zombie
1317 // nmethods aren't scanned for GC.
1318 _oops_are_stale = true;
1319 #endif
1320 // the Method may be reclaimed by class unloading now that the
1321 // nmethod is in zombie state
1322 set_method(NULL);
1323 } else {
1324 assert(state == not_entrant, "other cases may need to be handled differently");
1325 }
1326
1327 if (TraceCreateZombies) {
1328 ResourceMark m;
1329 tty->print_cr("nmethod <" INTPTR_FORMAT "> %s code made %s", p2i(this), this->method() ? this->method()->name_and_sig_as_C_string() : "null", (state == not_entrant) ? "not entrant" : "zombie");
1330 }
1331
1332 NMethodSweeper::report_state_change(this);
1333 return true;
1334 }
1335
1336 void nmethod::flush() {
1337 MutexLockerEx mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);
1338 // Note that there are no valid oops in the nmethod anymore.
1339 assert(!is_osr_method() || is_unloaded() || is_zombie(),
1340 "osr nmethod must be unloaded or zombie before flushing");
1341 assert(is_zombie() || is_osr_method(), "must be a zombie method");
1342 assert (!is_locked_by_vm(), "locked methods shouldn't be flushed");
1343 assert_locked_or_safepoint(CodeCache_lock);
1344
1345 // completely deallocate this method
1346 Events::log(JavaThread::current(), "flushing nmethod " INTPTR_FORMAT, p2i(this));
1347 if (PrintMethodFlushing) {
1348 tty->print_cr("*flushing %s nmethod %3d/" INTPTR_FORMAT ". Live blobs:" UINT32_FORMAT
1349 "/Free CodeCache:" SIZE_FORMAT "Kb",
1350 is_osr_method() ? "osr" : "",_compile_id, p2i(this), CodeCache::blob_count(),
1351 CodeCache::unallocated_capacity(CodeCache::get_code_blob_type(this))/1024);
1352 }
1353
1354 // We need to deallocate any ExceptionCache data.
1355 // Note that we do not need to grab the nmethod lock for this, it
1356 // better be thread safe if we're disposing of it!
1357 ExceptionCache* ec = exception_cache();
1358 set_exception_cache(NULL);
1359 while(ec != NULL) {
1360 ExceptionCache* next = ec->next();
1361 delete ec;
1362 ec = next;
1363 }
1364
1365 #if INCLUDE_JVMCI
1366 assert(_jvmci_installed_code == NULL, "should have been nulled out when transitioned to zombie");
1367 assert(_speculation_log == NULL, "should have been nulled out when transitioned to zombie");
1368 #endif
1369
1370 Universe::heap()->flush_nmethod(this);
1371
1372 CodeBlob::flush();
1373 CodeCache::free(this);
1374 }
1375
1376 oop nmethod::oop_at(int index) const {
1377 if (index == 0) {
1378 return NULL;
1379 }
1380 return NativeAccess<AS_NO_KEEPALIVE>::oop_load(oop_addr_at(index));
1381 }
1382
1383 //
1384 // Notify all classes this nmethod is dependent on that it is no
1385 // longer dependent. This should only be called in two situations.
1386 // First, when a nmethod transitions to a zombie all dependents need
1387 // to be clear. Since zombification happens at a safepoint there's no
1388 // synchronization issues. The second place is a little more tricky.
1389 // During phase 1 of mark sweep class unloading may happen and as a
1390 // result some nmethods may get unloaded. In this case the flushing
1391 // of dependencies must happen during phase 1 since after GC any
1392 // dependencies in the unloaded nmethod won't be updated, so
1393 // traversing the dependency information in unsafe. In that case this
1394 // function is called with a boolean argument and this function only
1395 // notifies instanceKlasses that are reachable
1396
1397 void nmethod::flush_dependencies(bool delete_immediately) {
1398 DEBUG_ONLY(bool called_by_gc = Universe::heap()->is_gc_active() || Thread::current()->is_ConcurrentGC_thread();)
1399 assert(called_by_gc != delete_immediately,
1400 "delete_immediately is false if and only if we are called during GC");
1401 if (!has_flushed_dependencies()) {
1402 set_has_flushed_dependencies();
1403 for (Dependencies::DepStream deps(this); deps.next(); ) {
1404 if (deps.type() == Dependencies::call_site_target_value) {
1405 // CallSite dependencies are managed on per-CallSite instance basis.
1406 oop call_site = deps.argument_oop(0);
1407 if (delete_immediately) {
1408 assert_locked_or_safepoint(CodeCache_lock);
1409 MethodHandles::remove_dependent_nmethod(call_site, this);
1410 } else {
1411 MethodHandles::clean_dependency_context(call_site);
1412 }
1413 } else {
1414 Klass* klass = deps.context_type();
1415 if (klass == NULL) {
1416 continue; // ignore things like evol_method
1417 }
1418 // During GC delete_immediately is false, and liveness
1419 // of dependee determines class that needs to be updated.
1420 if (delete_immediately) {
1421 assert_locked_or_safepoint(CodeCache_lock);
1422 InstanceKlass::cast(klass)->remove_dependent_nmethod(this);
1423 } else if (klass->is_loader_alive()) {
1424 // The GC may clean dependency contexts concurrently and in parallel.
1425 InstanceKlass::cast(klass)->clean_dependency_context();
1426 }
1427 }
1428 }
1429 }
1430 }
1431
1432 // ------------------------------------------------------------------
1433 // post_compiled_method_load_event
1434 // new method for install_code() path
1435 // Transfer information from compilation to jvmti
1436 void nmethod::post_compiled_method_load_event() {
1437
1438 Method* moop = method();
1439 HOTSPOT_COMPILED_METHOD_LOAD(
1440 (char *) moop->klass_name()->bytes(),
1441 moop->klass_name()->utf8_length(),
1442 (char *) moop->name()->bytes(),
1443 moop->name()->utf8_length(),
1444 (char *) moop->signature()->bytes(),
1445 moop->signature()->utf8_length(),
1446 insts_begin(), insts_size());
1447
1448 if (JvmtiExport::should_post_compiled_method_load() ||
1449 JvmtiExport::should_post_compiled_method_unload()) {
1450 get_and_cache_jmethod_id();
1451 }
1452
1453 if (JvmtiExport::should_post_compiled_method_load()) {
1454 // Let the Service thread (which is a real Java thread) post the event
1455 MutexLockerEx ml(Service_lock, Mutex::_no_safepoint_check_flag);
1456 JvmtiDeferredEventQueue::enqueue(
1457 JvmtiDeferredEvent::compiled_method_load_event(this));
1458 }
1459 }
1460
1461 jmethodID nmethod::get_and_cache_jmethod_id() {
1462 if (_jmethod_id == NULL) {
1463 // Cache the jmethod_id since it can no longer be looked up once the
1464 // method itself has been marked for unloading.
1465 _jmethod_id = method()->jmethod_id();
1466 }
1467 return _jmethod_id;
1468 }
1469
1470 void nmethod::post_compiled_method_unload() {
1471 if (unload_reported()) {
1472 // During unloading we transition to unloaded and then to zombie
1473 // and the unloading is reported during the first transition.
1474 return;
1475 }
1476
1477 assert(_method != NULL && !is_unloaded(), "just checking");
1478 DTRACE_METHOD_UNLOAD_PROBE(method());
1479
1480 // If a JVMTI agent has enabled the CompiledMethodUnload event then
1481 // post the event. Sometime later this nmethod will be made a zombie
1482 // by the sweeper but the Method* will not be valid at that point.
1483 // If the _jmethod_id is null then no load event was ever requested
1484 // so don't bother posting the unload. The main reason for this is
1485 // that the jmethodID is a weak reference to the Method* so if
1486 // it's being unloaded there's no way to look it up since the weak
1487 // ref will have been cleared.
1488 if (_jmethod_id != NULL && JvmtiExport::should_post_compiled_method_unload()) {
1489 assert(!unload_reported(), "already unloaded");
1490 JvmtiDeferredEvent event =
1491 JvmtiDeferredEvent::compiled_method_unload_event(this,
1492 _jmethod_id, insts_begin());
1493 MutexLockerEx ml(Service_lock, Mutex::_no_safepoint_check_flag);
1494 JvmtiDeferredEventQueue::enqueue(event);
1495 }
1496
1497 // The JVMTI CompiledMethodUnload event can be enabled or disabled at
1498 // any time. As the nmethod is being unloaded now we mark it has
1499 // having the unload event reported - this will ensure that we don't
1500 // attempt to report the event in the unlikely scenario where the
1501 // event is enabled at the time the nmethod is made a zombie.
1502 set_unload_reported();
1503 }
1504
1505 // Iterate over metadata calling this function. Used by RedefineClasses
1506 void nmethod::metadata_do(MetadataClosure* f) {
1507 {
1508 // Visit all immediate references that are embedded in the instruction stream.
1509 RelocIterator iter(this, oops_reloc_begin());
1510 while (iter.next()) {
1511 if (iter.type() == relocInfo::metadata_type ) {
1512 metadata_Relocation* r = iter.metadata_reloc();
1513 // In this metadata, we must only follow those metadatas directly embedded in
1514 // the code. Other metadatas (oop_index>0) are seen as part of
1515 // the metadata section below.
1516 assert(1 == (r->metadata_is_immediate()) +
1517 (r->metadata_addr() >= metadata_begin() && r->metadata_addr() < metadata_end()),
1518 "metadata must be found in exactly one place");
1519 if (r->metadata_is_immediate() && r->metadata_value() != NULL) {
1520 Metadata* md = r->metadata_value();
1521 if (md != _method) f->do_metadata(md);
1522 }
1523 } else if (iter.type() == relocInfo::virtual_call_type) {
1524 // Check compiledIC holders associated with this nmethod
1525 ResourceMark rm;
1526 CompiledIC *ic = CompiledIC_at(&iter);
1527 if (ic->is_icholder_call()) {
1528 CompiledICHolder* cichk = ic->cached_icholder();
1529 f->do_metadata(cichk->holder_metadata());
1530 f->do_metadata(cichk->holder_klass());
1531 } else {
1532 Metadata* ic_oop = ic->cached_metadata();
1533 if (ic_oop != NULL) {
1534 f->do_metadata(ic_oop);
1535 }
1536 }
1537 }
1538 }
1539 }
1540
1541 // Visit the metadata section
1542 for (Metadata** p = metadata_begin(); p < metadata_end(); p++) {
1543 if (*p == Universe::non_oop_word() || *p == NULL) continue; // skip non-oops
1544 Metadata* md = *p;
1545 f->do_metadata(md);
1546 }
1547
1548 // Visit metadata not embedded in the other places.
1549 if (_method != NULL) f->do_metadata(_method);
1550 }
1551
1552 // The _is_unloading_state encodes a tuple comprising the unloading cycle
1553 // and the result of IsUnloadingBehaviour::is_unloading() fpr that cycle.
1554 // This is the bit layout of the _is_unloading_state byte: 00000CCU
1555 // CC refers to the cycle, which has 2 bits, and U refers to the result of
1556 // IsUnloadingBehaviour::is_unloading() for that unloading cycle.
1557
1558 class IsUnloadingState: public AllStatic {
1559 static const uint8_t _is_unloading_mask = 1;
1560 static const uint8_t _is_unloading_shift = 0;
1561 static const uint8_t _unloading_cycle_mask = 6;
1562 static const uint8_t _unloading_cycle_shift = 1;
1563
1564 static uint8_t set_is_unloading(uint8_t state, bool value) {
1565 state &= ~_is_unloading_mask;
1566 if (value) {
1567 state |= 1 << _is_unloading_shift;
1568 }
1569 assert(is_unloading(state) == value, "unexpected unloading cycle overflow");
1570 return state;
1571 }
1572
1573 static uint8_t set_unloading_cycle(uint8_t state, uint8_t value) {
1574 state &= ~_unloading_cycle_mask;
1575 state |= value << _unloading_cycle_shift;
1576 assert(unloading_cycle(state) == value, "unexpected unloading cycle overflow");
1577 return state;
1578 }
1579
1580 public:
1581 static bool is_unloading(uint8_t state) { return (state & _is_unloading_mask) >> _is_unloading_shift == 1; }
1582 static uint8_t unloading_cycle(uint8_t state) { return (state & _unloading_cycle_mask) >> _unloading_cycle_shift; }
1583
1584 static uint8_t create(bool is_unloading, uint8_t unloading_cycle) {
1585 uint8_t state = 0;
1586 state = set_is_unloading(state, is_unloading);
1587 state = set_unloading_cycle(state, unloading_cycle);
1588 return state;
1589 }
1590 };
1591
1592 bool nmethod::is_unloading() {
1593 uint8_t state = RawAccess<MO_RELAXED>::load(&_is_unloading_state);
1594 bool state_is_unloading = IsUnloadingState::is_unloading(state);
1595 uint8_t state_unloading_cycle = IsUnloadingState::unloading_cycle(state);
1596 if (state_is_unloading) {
1597 return true;
1598 }
1599 uint8_t current_cycle = CodeCache::unloading_cycle();
1600 if (state_unloading_cycle == current_cycle) {
1601 return false;
1602 }
1603
1604 // The IsUnloadingBehaviour is responsible for checking if there are any dead
1605 // oops in the CompiledMethod, by calling oops_do on it.
1606 state_unloading_cycle = current_cycle;
1607
1608 if (is_zombie()) {
1609 // Zombies without calculated unloading epoch are never unloading due to GC.
1610
1611 // There are no races where a previously observed is_unloading() nmethod
1612 // suddenly becomes not is_unloading() due to here being observed as zombie.
1613
1614 // With STW unloading, all is_alive() && is_unloading() nmethods are unlinked
1615 // and unloaded in the safepoint. That makes races where an nmethod is first
1616 // observed as is_alive() && is_unloading() and subsequently observed as
1617 // is_zombie() impossible.
1618
1619 // With concurrent unloading, all references to is_unloading() nmethods are
1620 // first unlinked (e.g. IC caches and dependency contexts). Then a global
1621 // handshake operation is performed with all JavaThreads before finally
1622 // unloading the nmethods. The sweeper never converts is_alive() && is_unloading()
1623 // nmethods to zombies; it waits for them to become is_unloaded(). So before
1624 // the global handshake, it is impossible for is_unloading() nmethods to
1625 // racingly become is_zombie(). And is_unloading() is calculated for all is_alive()
1626 // nmethods before taking that global handshake, meaning that it will never
1627 // be recalculated after the handshake.
1628
1629 // After that global handshake, is_unloading() nmethods are only observable
1630 // to the iterators, and they will never trigger recomputation of the cached
1631 // is_unloading_state, and hence may not suffer from such races.
1632
1633 state_is_unloading = false;
1634 } else {
1635 state_is_unloading = IsUnloadingBehaviour::current()->is_unloading(this);
1636 }
1637
1638 state = IsUnloadingState::create(state_is_unloading, state_unloading_cycle);
1639
1640 RawAccess<MO_RELAXED>::store(&_is_unloading_state, state);
1641
1642 return state_is_unloading;
1643 }
1644
1645 void nmethod::clear_unloading_state() {
1646 uint8_t state = IsUnloadingState::create(false, CodeCache::unloading_cycle());
1647 RawAccess<MO_RELAXED>::store(&_is_unloading_state, state);
1648 }
1649
1650
1651 // This is called at the end of the strong tracing/marking phase of a
1652 // GC to unload an nmethod if it contains otherwise unreachable
1653 // oops.
1654
1655 void nmethod::do_unloading(bool unloading_occurred) {
1656 // Make sure the oop's ready to receive visitors
1657 assert(!is_zombie() && !is_unloaded(),
1658 "should not call follow on zombie or unloaded nmethod");
1659
1660 if (is_unloading()) {
1661 make_unloaded();
1662 } else {
1663 #if INCLUDE_JVMCI
1664 if (_jvmci_installed_code != NULL) {
1665 if (JNIHandles::is_global_weak_cleared(_jvmci_installed_code)) {
1666 if (_jvmci_installed_code_triggers_invalidation) {
1667 make_not_entrant();
1668 }
1669 clear_jvmci_installed_code();
1670 }
1671 }
1672 #endif
1673
1674 guarantee(unload_nmethod_caches(unloading_occurred),
1675 "Should not need transition stubs");
1676 }
1677 }
1678
1679 void nmethod::oops_do(OopClosure* f, bool allow_zombie) {
1680 // make sure the oops ready to receive visitors
1681 assert(allow_zombie || !is_zombie(), "should not call follow on zombie nmethod");
1682 assert(!is_unloaded(), "should not call follow on unloaded nmethod");
1683
1684 // Prevent extra code cache walk for platforms that don't have immediate oops.
1685 if (relocInfo::mustIterateImmediateOopsInCode()) {
1686 RelocIterator iter(this, oops_reloc_begin());
1687
1688 while (iter.next()) {
1689 if (iter.type() == relocInfo::oop_type ) {
1690 oop_Relocation* r = iter.oop_reloc();
1691 // In this loop, we must only follow those oops directly embedded in
1692 // the code. Other oops (oop_index>0) are seen as part of scopes_oops.
1693 assert(1 == (r->oop_is_immediate()) +
1694 (r->oop_addr() >= oops_begin() && r->oop_addr() < oops_end()),
1695 "oop must be found in exactly one place");
1696 if (r->oop_is_immediate() && r->oop_value() != NULL) {
1697 f->do_oop(r->oop_addr());
1698 }
1699 }
1700 }
1701 }
1702
1703 // Scopes
1704 // This includes oop constants not inlined in the code stream.
1705 for (oop* p = oops_begin(); p < oops_end(); p++) {
1706 if (*p == Universe::non_oop_word()) continue; // skip non-oops
1707 f->do_oop(p);
1708 }
1709 }
1710
1711 #define NMETHOD_SENTINEL ((nmethod*)badAddress)
1712
1713 nmethod* volatile nmethod::_oops_do_mark_nmethods;
1714
1715 // An nmethod is "marked" if its _mark_link is set non-null.
1716 // Even if it is the end of the linked list, it will have a non-null link value,
1717 // as long as it is on the list.
1718 // This code must be MP safe, because it is used from parallel GC passes.
1719 bool nmethod::test_set_oops_do_mark() {
1720 assert(nmethod::oops_do_marking_is_active(), "oops_do_marking_prologue must be called");
1721 if (_oops_do_mark_link == NULL) {
1722 // Claim this nmethod for this thread to mark.
1723 if (Atomic::replace_if_null(NMETHOD_SENTINEL, &_oops_do_mark_link)) {
1724 // Atomically append this nmethod (now claimed) to the head of the list:
1725 nmethod* observed_mark_nmethods = _oops_do_mark_nmethods;
1726 for (;;) {
1727 nmethod* required_mark_nmethods = observed_mark_nmethods;
1728 _oops_do_mark_link = required_mark_nmethods;
1729 observed_mark_nmethods =
1730 Atomic::cmpxchg(this, &_oops_do_mark_nmethods, required_mark_nmethods);
1731 if (observed_mark_nmethods == required_mark_nmethods)
1732 break;
1733 }
1734 // Mark was clear when we first saw this guy.
1735 LogTarget(Trace, gc, nmethod) lt;
1736 if (lt.is_enabled()) {
1737 LogStream ls(lt);
1738 CompileTask::print(&ls, this, "oops_do, mark", /*short_form:*/ true);
1739 }
1740 return false;
1741 }
1742 }
1743 // On fall through, another racing thread marked this nmethod before we did.
1744 return true;
1745 }
1746
1747 void nmethod::oops_do_marking_prologue() {
1748 log_trace(gc, nmethod)("oops_do_marking_prologue");
1749 assert(_oops_do_mark_nmethods == NULL, "must not call oops_do_marking_prologue twice in a row");
1750 // We use cmpxchg instead of regular assignment here because the user
1751 // may fork a bunch of threads, and we need them all to see the same state.
1752 nmethod* observed = Atomic::cmpxchg(NMETHOD_SENTINEL, &_oops_do_mark_nmethods, (nmethod*)NULL);
1753 guarantee(observed == NULL, "no races in this sequential code");
1754 }
1755
1756 void nmethod::oops_do_marking_epilogue() {
1757 assert(_oops_do_mark_nmethods != NULL, "must not call oops_do_marking_epilogue twice in a row");
1758 nmethod* cur = _oops_do_mark_nmethods;
1759 while (cur != NMETHOD_SENTINEL) {
1760 assert(cur != NULL, "not NULL-terminated");
1761 nmethod* next = cur->_oops_do_mark_link;
1762 cur->_oops_do_mark_link = NULL;
1763 DEBUG_ONLY(cur->verify_oop_relocations());
1764
1765 LogTarget(Trace, gc, nmethod) lt;
1766 if (lt.is_enabled()) {
1767 LogStream ls(lt);
1768 CompileTask::print(&ls, cur, "oops_do, unmark", /*short_form:*/ true);
1769 }
1770 cur = next;
1771 }
1772 nmethod* required = _oops_do_mark_nmethods;
1773 nmethod* observed = Atomic::cmpxchg((nmethod*)NULL, &_oops_do_mark_nmethods, required);
1774 guarantee(observed == required, "no races in this sequential code");
1775 log_trace(gc, nmethod)("oops_do_marking_epilogue");
1776 }
1777
1778 inline bool includes(void* p, void* from, void* to) {
1779 return from <= p && p < to;
1780 }
1781
1782
1783 void nmethod::copy_scopes_pcs(PcDesc* pcs, int count) {
1784 assert(count >= 2, "must be sentinel values, at least");
1785
1786 #ifdef ASSERT
1787 // must be sorted and unique; we do a binary search in find_pc_desc()
1788 int prev_offset = pcs[0].pc_offset();
1789 assert(prev_offset == PcDesc::lower_offset_limit,
1790 "must start with a sentinel");
1791 for (int i = 1; i < count; i++) {
1792 int this_offset = pcs[i].pc_offset();
1793 assert(this_offset > prev_offset, "offsets must be sorted");
1794 prev_offset = this_offset;
1795 }
1796 assert(prev_offset == PcDesc::upper_offset_limit,
1797 "must end with a sentinel");
1798 #endif //ASSERT
1799
1800 // Search for MethodHandle invokes and tag the nmethod.
1801 for (int i = 0; i < count; i++) {
1802 if (pcs[i].is_method_handle_invoke()) {
1803 set_has_method_handle_invokes(true);
1804 break;
1805 }
1806 }
1807 assert(has_method_handle_invokes() == (_deopt_mh_handler_begin != NULL), "must have deopt mh handler");
1808
1809 int size = count * sizeof(PcDesc);
1810 assert(scopes_pcs_size() >= size, "oob");
1811 memcpy(scopes_pcs_begin(), pcs, size);
1812
1813 // Adjust the final sentinel downward.
1814 PcDesc* last_pc = &scopes_pcs_begin()[count-1];
1815 assert(last_pc->pc_offset() == PcDesc::upper_offset_limit, "sanity");
1816 last_pc->set_pc_offset(content_size() + 1);
1817 for (; last_pc + 1 < scopes_pcs_end(); last_pc += 1) {
1818 // Fill any rounding gaps with copies of the last record.
1819 last_pc[1] = last_pc[0];
1820 }
1821 // The following assert could fail if sizeof(PcDesc) is not
1822 // an integral multiple of oopSize (the rounding term).
1823 // If it fails, change the logic to always allocate a multiple
1824 // of sizeof(PcDesc), and fill unused words with copies of *last_pc.
1825 assert(last_pc + 1 == scopes_pcs_end(), "must match exactly");
1826 }
1827
1828 void nmethod::copy_scopes_data(u_char* buffer, int size) {
1829 assert(scopes_data_size() >= size, "oob");
1830 memcpy(scopes_data_begin(), buffer, size);
1831 }
1832
1833 #ifdef ASSERT
1834 static PcDesc* linear_search(const PcDescSearch& search, int pc_offset, bool approximate) {
1835 PcDesc* lower = search.scopes_pcs_begin();
1836 PcDesc* upper = search.scopes_pcs_end();
1837 lower += 1; // exclude initial sentinel
1838 PcDesc* res = NULL;
1839 for (PcDesc* p = lower; p < upper; p++) {
1840 NOT_PRODUCT(--pc_nmethod_stats.pc_desc_tests); // don't count this call to match_desc
1841 if (match_desc(p, pc_offset, approximate)) {
1842 if (res == NULL)
1843 res = p;
1844 else
1845 res = (PcDesc*) badAddress;
1846 }
1847 }
1848 return res;
1849 }
1850 #endif
1851
1852
1853 // Finds a PcDesc with real-pc equal to "pc"
1854 PcDesc* PcDescContainer::find_pc_desc_internal(address pc, bool approximate, const PcDescSearch& search) {
1855 address base_address = search.code_begin();
1856 if ((pc < base_address) ||
1857 (pc - base_address) >= (ptrdiff_t) PcDesc::upper_offset_limit) {
1858 return NULL; // PC is wildly out of range
1859 }
1860 int pc_offset = (int) (pc - base_address);
1861
1862 // Check the PcDesc cache if it contains the desired PcDesc
1863 // (This as an almost 100% hit rate.)
1864 PcDesc* res = _pc_desc_cache.find_pc_desc(pc_offset, approximate);
1865 if (res != NULL) {
1866 assert(res == linear_search(search, pc_offset, approximate), "cache ok");
1867 return res;
1868 }
1869
1870 // Fallback algorithm: quasi-linear search for the PcDesc
1871 // Find the last pc_offset less than the given offset.
1872 // The successor must be the required match, if there is a match at all.
1873 // (Use a fixed radix to avoid expensive affine pointer arithmetic.)
1874 PcDesc* lower = search.scopes_pcs_begin();
1875 PcDesc* upper = search.scopes_pcs_end();
1876 upper -= 1; // exclude final sentinel
1877 if (lower >= upper) return NULL; // native method; no PcDescs at all
1878
1879 #define assert_LU_OK \
1880 /* invariant on lower..upper during the following search: */ \
1881 assert(lower->pc_offset() < pc_offset, "sanity"); \
1882 assert(upper->pc_offset() >= pc_offset, "sanity")
1883 assert_LU_OK;
1884
1885 // Use the last successful return as a split point.
1886 PcDesc* mid = _pc_desc_cache.last_pc_desc();
1887 NOT_PRODUCT(++pc_nmethod_stats.pc_desc_searches);
1888 if (mid->pc_offset() < pc_offset) {
1889 lower = mid;
1890 } else {
1891 upper = mid;
1892 }
1893
1894 // Take giant steps at first (4096, then 256, then 16, then 1)
1895 const int LOG2_RADIX = 4 /*smaller steps in debug mode:*/ debug_only(-1);
1896 const int RADIX = (1 << LOG2_RADIX);
1897 for (int step = (1 << (LOG2_RADIX*3)); step > 1; step >>= LOG2_RADIX) {
1898 while ((mid = lower + step) < upper) {
1899 assert_LU_OK;
1900 NOT_PRODUCT(++pc_nmethod_stats.pc_desc_searches);
1901 if (mid->pc_offset() < pc_offset) {
1902 lower = mid;
1903 } else {
1904 upper = mid;
1905 break;
1906 }
1907 }
1908 assert_LU_OK;
1909 }
1910
1911 // Sneak up on the value with a linear search of length ~16.
1912 while (true) {
1913 assert_LU_OK;
1914 mid = lower + 1;
1915 NOT_PRODUCT(++pc_nmethod_stats.pc_desc_searches);
1916 if (mid->pc_offset() < pc_offset) {
1917 lower = mid;
1918 } else {
1919 upper = mid;
1920 break;
1921 }
1922 }
1923 #undef assert_LU_OK
1924
1925 if (match_desc(upper, pc_offset, approximate)) {
1926 assert(upper == linear_search(search, pc_offset, approximate), "search ok");
1927 _pc_desc_cache.add_pc_desc(upper);
1928 return upper;
1929 } else {
1930 assert(NULL == linear_search(search, pc_offset, approximate), "search ok");
1931 return NULL;
1932 }
1933 }
1934
1935
1936 void nmethod::check_all_dependencies(DepChange& changes) {
1937 // Checked dependencies are allocated into this ResourceMark
1938 ResourceMark rm;
1939
1940 // Turn off dependency tracing while actually testing dependencies.
1941 NOT_PRODUCT( FlagSetting fs(TraceDependencies, false) );
1942
1943 typedef ResourceHashtable<DependencySignature, int, &DependencySignature::hash,
1944 &DependencySignature::equals, 11027> DepTable;
1945
1946 DepTable* table = new DepTable();
1947
1948 // Iterate over live nmethods and check dependencies of all nmethods that are not
1949 // marked for deoptimization. A particular dependency is only checked once.
1950 NMethodIterator iter(NMethodIterator::only_alive_and_not_unloading);
1951 while(iter.next()) {
1952 nmethod* nm = iter.method();
1953 // Only notify for live nmethods
1954 if (!nm->is_marked_for_deoptimization()) {
1955 for (Dependencies::DepStream deps(nm); deps.next(); ) {
1956 // Construct abstraction of a dependency.
1957 DependencySignature* current_sig = new DependencySignature(deps);
1958
1959 // Determine if dependency is already checked. table->put(...) returns
1960 // 'true' if the dependency is added (i.e., was not in the hashtable).
1961 if (table->put(*current_sig, 1)) {
1962 if (deps.check_dependency() != NULL) {
1963 // Dependency checking failed. Print out information about the failed
1964 // dependency and finally fail with an assert. We can fail here, since
1965 // dependency checking is never done in a product build.
1966 tty->print_cr("Failed dependency:");
1967 changes.print();
1968 nm->print();
1969 nm->print_dependencies();
1970 assert(false, "Should have been marked for deoptimization");
1971 }
1972 }
1973 }
1974 }
1975 }
1976 }
1977
1978 bool nmethod::check_dependency_on(DepChange& changes) {
1979 // What has happened:
1980 // 1) a new class dependee has been added
1981 // 2) dependee and all its super classes have been marked
1982 bool found_check = false; // set true if we are upset
1983 for (Dependencies::DepStream deps(this); deps.next(); ) {
1984 // Evaluate only relevant dependencies.
1985 if (deps.spot_check_dependency_at(changes) != NULL) {
1986 found_check = true;
1987 NOT_DEBUG(break);
1988 }
1989 }
1990 return found_check;
1991 }
1992
1993 // Called from mark_for_deoptimization, when dependee is invalidated.
1994 bool nmethod::is_dependent_on_method(Method* dependee) {
1995 for (Dependencies::DepStream deps(this); deps.next(); ) {
1996 if (deps.type() != Dependencies::evol_method)
1997 continue;
1998 Method* method = deps.method_argument(0);
1999 if (method == dependee) return true;
2000 }
2001 return false;
2002 }
2003
2004
2005 bool nmethod::is_patchable_at(address instr_addr) {
2006 assert(insts_contains(instr_addr), "wrong nmethod used");
2007 if (is_zombie()) {
2008 // a zombie may never be patched
2009 return false;
2010 }
2011 return true;
2012 }
2013
2014
2015 address nmethod::continuation_for_implicit_exception(address pc) {
2016 // Exception happened outside inline-cache check code => we are inside
2017 // an active nmethod => use cpc to determine a return address
2018 int exception_offset = pc - code_begin();
2019 int cont_offset = ImplicitExceptionTable(this).at( exception_offset );
2020 #ifdef ASSERT
2021 if (cont_offset == 0) {
2022 Thread* thread = Thread::current();
2023 ResetNoHandleMark rnm; // Might be called from LEAF/QUICK ENTRY
2024 HandleMark hm(thread);
2025 ResourceMark rm(thread);
2026 CodeBlob* cb = CodeCache::find_blob(pc);
2027 assert(cb != NULL && cb == this, "");
2028 ttyLocker ttyl;
2029 tty->print_cr("implicit exception happened at " INTPTR_FORMAT, p2i(pc));
2030 print();
2031 method()->print_codes();
2032 print_code();
2033 print_pcs();
2034 }
2035 #endif
2036 if (cont_offset == 0) {
2037 // Let the normal error handling report the exception
2038 return NULL;
2039 }
2040 return code_begin() + cont_offset;
2041 }
2042
2043
2044
2045 void nmethod_init() {
2046 // make sure you didn't forget to adjust the filler fields
2047 assert(sizeof(nmethod) % oopSize == 0, "nmethod size must be multiple of a word");
2048 }
2049
2050
2051 //-------------------------------------------------------------------------------------------
2052
2053
2054 // QQQ might we make this work from a frame??
2055 nmethodLocker::nmethodLocker(address pc) {
2056 CodeBlob* cb = CodeCache::find_blob(pc);
2057 guarantee(cb != NULL && cb->is_compiled(), "bad pc for a nmethod found");
2058 _nm = cb->as_compiled_method();
2059 lock_nmethod(_nm);
2060 }
2061
2062 // Only JvmtiDeferredEvent::compiled_method_unload_event()
2063 // should pass zombie_ok == true.
2064 void nmethodLocker::lock_nmethod(CompiledMethod* cm, bool zombie_ok) {
2065 if (cm == NULL) return;
2066 if (cm->is_aot()) return; // FIXME: Revisit once _lock_count is added to aot_method
2067 nmethod* nm = cm->as_nmethod();
2068 Atomic::inc(&nm->_lock_count);
2069 assert(zombie_ok || !nm->is_zombie(), "cannot lock a zombie method");
2070 }
2071
2072 void nmethodLocker::unlock_nmethod(CompiledMethod* cm) {
2073 if (cm == NULL) return;
2074 if (cm->is_aot()) return; // FIXME: Revisit once _lock_count is added to aot_method
2075 nmethod* nm = cm->as_nmethod();
2076 Atomic::dec(&nm->_lock_count);
2077 assert(nm->_lock_count >= 0, "unmatched nmethod lock/unlock");
2078 }
2079
2080
2081 // -----------------------------------------------------------------------------
2082 // Verification
2083
2084 class VerifyOopsClosure: public OopClosure {
2085 nmethod* _nm;
2086 bool _ok;
2087 public:
2088 VerifyOopsClosure(nmethod* nm) : _nm(nm), _ok(true) { }
2089 bool ok() { return _ok; }
2090 virtual void do_oop(oop* p) {
2091 if (oopDesc::is_oop_or_null(*p)) return;
2092 if (_ok) {
2093 _nm->print_nmethod(true);
2094 _ok = false;
2095 }
2096 tty->print_cr("*** non-oop " PTR_FORMAT " found at " PTR_FORMAT " (offset %d)",
2097 p2i(*p), p2i(p), (int)((intptr_t)p - (intptr_t)_nm));
2098 }
2099 virtual void do_oop(narrowOop* p) { ShouldNotReachHere(); }
2100 };
2101
2102 void nmethod::verify() {
2103
2104 // Hmm. OSR methods can be deopted but not marked as zombie or not_entrant
2105 // seems odd.
2106
2107 if (is_zombie() || is_not_entrant() || is_unloaded())
2108 return;
2109
2110 // Make sure all the entry points are correctly aligned for patching.
2111 NativeJump::check_verified_entry_alignment(entry_point(), verified_entry_point());
2112
2113 // assert(oopDesc::is_oop(method()), "must be valid");
2114
2115 ResourceMark rm;
2116
2117 if (!CodeCache::contains(this)) {
2118 fatal("nmethod at " INTPTR_FORMAT " not in zone", p2i(this));
2119 }
2120
2121 if(is_native_method() )
2122 return;
2123
2124 nmethod* nm = CodeCache::find_nmethod(verified_entry_point());
2125 if (nm != this) {
2126 fatal("findNMethod did not find this nmethod (" INTPTR_FORMAT ")", p2i(this));
2127 }
2128
2129 for (PcDesc* p = scopes_pcs_begin(); p < scopes_pcs_end(); p++) {
2130 if (! p->verify(this)) {
2131 tty->print_cr("\t\tin nmethod at " INTPTR_FORMAT " (pcs)", p2i(this));
2132 }
2133 }
2134
2135 VerifyOopsClosure voc(this);
2136 oops_do(&voc);
2137 assert(voc.ok(), "embedded oops must be OK");
2138 Universe::heap()->verify_nmethod(this);
2139
2140 verify_scopes();
2141 }
2142
2143
2144 void nmethod::verify_interrupt_point(address call_site) {
2145 // Verify IC only when nmethod installation is finished.
2146 if (!is_not_installed()) {
2147 if (CompiledICLocker::is_safe(this)) {
2148 CompiledIC_at(this, call_site);
2149 CHECK_UNHANDLED_OOPS_ONLY(Thread::current()->clear_unhandled_oops());
2150 } else {
2151 CompiledICLocker ml_verify(this);
2152 CompiledIC_at(this, call_site);
2153 }
2154 }
2155
2156 PcDesc* pd = pc_desc_at(nativeCall_at(call_site)->return_address());
2157 assert(pd != NULL, "PcDesc must exist");
2158 for (ScopeDesc* sd = new ScopeDesc(this, pd->scope_decode_offset(),
2159 pd->obj_decode_offset(), pd->should_reexecute(), pd->rethrow_exception(),
2160 pd->return_oop());
2161 !sd->is_top(); sd = sd->sender()) {
2162 sd->verify();
2163 }
2164 }
2165
2166 void nmethod::verify_scopes() {
2167 if( !method() ) return; // Runtime stubs have no scope
2168 if (method()->is_native()) return; // Ignore stub methods.
2169 // iterate through all interrupt point
2170 // and verify the debug information is valid.
2171 RelocIterator iter((nmethod*)this);
2172 while (iter.next()) {
2173 address stub = NULL;
2174 switch (iter.type()) {
2175 case relocInfo::virtual_call_type:
2176 verify_interrupt_point(iter.addr());
2177 break;
2178 case relocInfo::opt_virtual_call_type:
2179 stub = iter.opt_virtual_call_reloc()->static_stub(false);
2180 verify_interrupt_point(iter.addr());
2181 break;
2182 case relocInfo::static_call_type:
2183 stub = iter.static_call_reloc()->static_stub(false);
2184 //verify_interrupt_point(iter.addr());
2185 break;
2186 case relocInfo::runtime_call_type:
2187 case relocInfo::runtime_call_w_cp_type: {
2188 address destination = iter.reloc()->value();
2189 // Right now there is no way to find out which entries support
2190 // an interrupt point. It would be nice if we had this
2191 // information in a table.
2192 break;
2193 }
2194 default:
2195 break;
2196 }
2197 assert(stub == NULL || stub_contains(stub), "static call stub outside stub section");
2198 }
2199 }
2200
2201
2202 // -----------------------------------------------------------------------------
2203 // Printing operations
2204
2205 void nmethod::print() const {
2206 ResourceMark rm;
2207 ttyLocker ttyl; // keep the following output all in one block
2208
2209 tty->print("Compiled method ");
2210
2211 if (is_compiled_by_c1()) {
2212 tty->print("(c1) ");
2213 } else if (is_compiled_by_c2()) {
2214 tty->print("(c2) ");
2215 } else if (is_compiled_by_jvmci()) {
2216 tty->print("(JVMCI) ");
2217 } else {
2218 tty->print("(nm) ");
2219 }
2220
2221 print_on(tty, NULL);
2222
2223 if (WizardMode) {
2224 tty->print("((nmethod*) " INTPTR_FORMAT ") ", p2i(this));
2225 tty->print(" for method " INTPTR_FORMAT , p2i(method()));
2226 tty->print(" { ");
2227 tty->print_cr("%s ", state());
2228 tty->print_cr("}:");
2229 }
2230 if (size () > 0) tty->print_cr(" total in heap [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
2231 p2i(this),
2232 p2i(this) + size(),
2233 size());
2234 if (relocation_size () > 0) tty->print_cr(" relocation [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
2235 p2i(relocation_begin()),
2236 p2i(relocation_end()),
2237 relocation_size());
2238 if (consts_size () > 0) tty->print_cr(" constants [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
2239 p2i(consts_begin()),
2240 p2i(consts_end()),
2241 consts_size());
2242 if (insts_size () > 0) tty->print_cr(" main code [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
2243 p2i(insts_begin()),
2244 p2i(insts_end()),
2245 insts_size());
2246 if (stub_size () > 0) tty->print_cr(" stub code [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
2247 p2i(stub_begin()),
2248 p2i(stub_end()),
2249 stub_size());
2250 if (oops_size () > 0) tty->print_cr(" oops [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
2251 p2i(oops_begin()),
2252 p2i(oops_end()),
2253 oops_size());
2254 if (metadata_size () > 0) tty->print_cr(" metadata [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
2255 p2i(metadata_begin()),
2256 p2i(metadata_end()),
2257 metadata_size());
2258 if (scopes_data_size () > 0) tty->print_cr(" scopes data [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
2259 p2i(scopes_data_begin()),
2260 p2i(scopes_data_end()),
2261 scopes_data_size());
2262 if (scopes_pcs_size () > 0) tty->print_cr(" scopes pcs [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
2263 p2i(scopes_pcs_begin()),
2264 p2i(scopes_pcs_end()),
2265 scopes_pcs_size());
2266 if (dependencies_size () > 0) tty->print_cr(" dependencies [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
2267 p2i(dependencies_begin()),
2268 p2i(dependencies_end()),
2269 dependencies_size());
2270 if (handler_table_size() > 0) tty->print_cr(" handler table [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
2271 p2i(handler_table_begin()),
2272 p2i(handler_table_end()),
2273 handler_table_size());
2274 if (nul_chk_table_size() > 0) tty->print_cr(" nul chk table [" INTPTR_FORMAT "," INTPTR_FORMAT "] = %d",
2275 p2i(nul_chk_table_begin()),
2276 p2i(nul_chk_table_end()),
2277 nul_chk_table_size());
2278 }
2279
2280 #ifndef PRODUCT
2281
2282 void nmethod::print_scopes() {
2283 // Find the first pc desc for all scopes in the code and print it.
2284 ResourceMark rm;
2285 for (PcDesc* p = scopes_pcs_begin(); p < scopes_pcs_end(); p++) {
2286 if (p->scope_decode_offset() == DebugInformationRecorder::serialized_null)
2287 continue;
2288
2289 ScopeDesc* sd = scope_desc_at(p->real_pc(this));
2290 while (sd != NULL) {
2291 sd->print_on(tty, p);
2292 sd = sd->sender();
2293 }
2294 }
2295 }
2296
2297 void nmethod::print_dependencies() {
2298 ResourceMark rm;
2299 ttyLocker ttyl; // keep the following output all in one block
2300 tty->print_cr("Dependencies:");
2301 for (Dependencies::DepStream deps(this); deps.next(); ) {
2302 deps.print_dependency();
2303 Klass* ctxk = deps.context_type();
2304 if (ctxk != NULL) {
2305 if (ctxk->is_instance_klass() && InstanceKlass::cast(ctxk)->is_dependent_nmethod(this)) {
2306 tty->print_cr(" [nmethod<=klass]%s", ctxk->external_name());
2307 }
2308 }
2309 deps.log_dependency(); // put it into the xml log also
2310 }
2311 }
2312
2313
2314 void nmethod::print_relocations() {
2315 ResourceMark m; // in case methods get printed via the debugger
2316 tty->print_cr("relocations:");
2317 RelocIterator iter(this);
2318 iter.print();
2319 }
2320
2321
2322 void nmethod::print_pcs() {
2323 ResourceMark m; // in case methods get printed via debugger
2324 tty->print_cr("pc-bytecode offsets:");
2325 for (PcDesc* p = scopes_pcs_begin(); p < scopes_pcs_end(); p++) {
2326 p->print(this);
2327 }
2328 }
2329
2330 void nmethod::print_recorded_oops() {
2331 tty->print_cr("Recorded oops:");
2332 for (int i = 0; i < oops_count(); i++) {
2333 oop o = oop_at(i);
2334 tty->print("#%3d: " INTPTR_FORMAT " ", i, p2i(o));
2335 if (o == Universe::non_oop_word()) {
2336 tty->print("non-oop word");
2337 } else {
2338 if (o != NULL) {
2339 o->print_value();
2340 } else {
2341 tty->print_cr("NULL");
2342 }
2343 }
2344 tty->cr();
2345 }
2346 }
2347
2348 void nmethod::print_recorded_metadata() {
2349 tty->print_cr("Recorded metadata:");
2350 for (int i = 0; i < metadata_count(); i++) {
2351 Metadata* m = metadata_at(i);
2352 tty->print("#%3d: " INTPTR_FORMAT " ", i, p2i(m));
2353 if (m == (Metadata*)Universe::non_oop_word()) {
2354 tty->print("non-metadata word");
2355 } else {
2356 Metadata::print_value_on_maybe_null(tty, m);
2357 }
2358 tty->cr();
2359 }
2360 }
2361
2362 #endif // PRODUCT
2363
2364 const char* nmethod::reloc_string_for(u_char* begin, u_char* end) {
2365 RelocIterator iter(this, begin, end);
2366 bool have_one = false;
2367 while (iter.next()) {
2368 have_one = true;
2369 switch (iter.type()) {
2370 case relocInfo::none: return "no_reloc";
2371 case relocInfo::oop_type: {
2372 stringStream st;
2373 oop_Relocation* r = iter.oop_reloc();
2374 oop obj = r->oop_value();
2375 st.print("oop(");
2376 if (obj == NULL) st.print("NULL");
2377 else obj->print_value_on(&st);
2378 st.print(")");
2379 return st.as_string();
2380 }
2381 case relocInfo::metadata_type: {
2382 stringStream st;
2383 metadata_Relocation* r = iter.metadata_reloc();
2384 Metadata* obj = r->metadata_value();
2385 st.print("metadata(");
2386 if (obj == NULL) st.print("NULL");
2387 else obj->print_value_on(&st);
2388 st.print(")");
2389 return st.as_string();
2390 }
2391 case relocInfo::runtime_call_type:
2392 case relocInfo::runtime_call_w_cp_type: {
2393 stringStream st;
2394 st.print("runtime_call");
2395 CallRelocation* r = (CallRelocation*)iter.reloc();
2396 address dest = r->destination();
2397 CodeBlob* cb = CodeCache::find_blob(dest);
2398 if (cb != NULL) {
2399 st.print(" %s", cb->name());
2400 } else {
2401 ResourceMark rm;
2402 const int buflen = 1024;
2403 char* buf = NEW_RESOURCE_ARRAY(char, buflen);
2404 int offset;
2405 if (os::dll_address_to_function_name(dest, buf, buflen, &offset)) {
2406 st.print(" %s", buf);
2407 if (offset != 0) {
2408 st.print("+%d", offset);
2409 }
2410 }
2411 }
2412 return st.as_string();
2413 }
2414 case relocInfo::virtual_call_type: {
2415 stringStream st;
2416 st.print_raw("virtual_call");
2417 virtual_call_Relocation* r = iter.virtual_call_reloc();
2418 Method* m = r->method_value();
2419 if (m != NULL) {
2420 assert(m->is_method(), "");
2421 m->print_short_name(&st);
2422 }
2423 return st.as_string();
2424 }
2425 case relocInfo::opt_virtual_call_type: {
2426 stringStream st;
2427 st.print_raw("optimized virtual_call");
2428 opt_virtual_call_Relocation* r = iter.opt_virtual_call_reloc();
2429 Method* m = r->method_value();
2430 if (m != NULL) {
2431 assert(m->is_method(), "");
2432 m->print_short_name(&st);
2433 }
2434 return st.as_string();
2435 }
2436 case relocInfo::static_call_type: {
2437 stringStream st;
2438 st.print_raw("static_call");
2439 static_call_Relocation* r = iter.static_call_reloc();
2440 Method* m = r->method_value();
2441 if (m != NULL) {
2442 assert(m->is_method(), "");
2443 m->print_short_name(&st);
2444 }
2445 return st.as_string();
2446 }
2447 case relocInfo::static_stub_type: return "static_stub";
2448 case relocInfo::external_word_type: return "external_word";
2449 case relocInfo::internal_word_type: return "internal_word";
2450 case relocInfo::section_word_type: return "section_word";
2451 case relocInfo::poll_type: return "poll";
2452 case relocInfo::poll_return_type: return "poll_return";
2453 case relocInfo::trampoline_stub_type: return "trampoline_stub";
2454 case relocInfo::type_mask: return "type_bit_mask";
2455
2456 default:
2457 break;
2458 }
2459 }
2460 return have_one ? "other" : NULL;
2461 }
2462
2463 // Return a the last scope in (begin..end]
2464 ScopeDesc* nmethod::scope_desc_in(address begin, address end) {
2465 PcDesc* p = pc_desc_near(begin+1);
2466 if (p != NULL && p->real_pc(this) <= end) {
2467 return new ScopeDesc(this, p->scope_decode_offset(),
2468 p->obj_decode_offset(), p->should_reexecute(), p->rethrow_exception(),
2469 p->return_oop());
2470 }
2471 return NULL;
2472 }
2473
2474 void nmethod::print_nmethod_labels(outputStream* stream, address block_begin) const {
2475 if (block_begin == entry_point()) stream->print_cr("[Entry Point]");
2476 if (block_begin == verified_entry_point()) stream->print_cr("[Verified Entry Point]");
2477 if (JVMCI_ONLY(_exception_offset >= 0 &&) block_begin == exception_begin()) stream->print_cr("[Exception Handler]");
2478 if (block_begin == stub_begin()) stream->print_cr("[Stub Code]");
2479 if (JVMCI_ONLY(_deopt_handler_begin != NULL &&) block_begin == deopt_handler_begin()) stream->print_cr("[Deopt Handler Code]");
2480
2481 if (has_method_handle_invokes())
2482 if (block_begin == deopt_mh_handler_begin()) stream->print_cr("[Deopt MH Handler Code]");
2483
2484 if (block_begin == consts_begin()) stream->print_cr("[Constants]");
2485
2486 if (block_begin == entry_point()) {
2487 methodHandle m = method();
2488 if (m.not_null()) {
2489 stream->print(" # ");
2490 m->print_value_on(stream);
2491 stream->cr();
2492 }
2493 if (m.not_null() && !is_osr_method()) {
2494 ResourceMark rm;
2495 int sizeargs = m->size_of_parameters();
2496 BasicType* sig_bt = NEW_RESOURCE_ARRAY(BasicType, sizeargs);
2497 VMRegPair* regs = NEW_RESOURCE_ARRAY(VMRegPair, sizeargs);
2498 {
2499 int sig_index = 0;
2500 if (!m->is_static())
2501 sig_bt[sig_index++] = T_OBJECT; // 'this'
2502 for (SignatureStream ss(m->signature()); !ss.at_return_type(); ss.next()) {
2503 BasicType t = ss.type();
2504 sig_bt[sig_index++] = t;
2505 if (type2size[t] == 2) {
2506 sig_bt[sig_index++] = T_VOID;
2507 } else {
2508 assert(type2size[t] == 1, "size is 1 or 2");
2509 }
2510 }
2511 assert(sig_index == sizeargs, "");
2512 }
2513 const char* spname = "sp"; // make arch-specific?
2514 intptr_t out_preserve = SharedRuntime::java_calling_convention(sig_bt, regs, sizeargs, false);
2515 int stack_slot_offset = this->frame_size() * wordSize;
2516 int tab1 = 14, tab2 = 24;
2517 int sig_index = 0;
2518 int arg_index = (m->is_static() ? 0 : -1);
2519 bool did_old_sp = false;
2520 for (SignatureStream ss(m->signature()); !ss.at_return_type(); ) {
2521 bool at_this = (arg_index == -1);
2522 bool at_old_sp = false;
2523 BasicType t = (at_this ? T_OBJECT : ss.type());
2524 assert(t == sig_bt[sig_index], "sigs in sync");
2525 if (at_this)
2526 stream->print(" # this: ");
2527 else
2528 stream->print(" # parm%d: ", arg_index);
2529 stream->move_to(tab1);
2530 VMReg fst = regs[sig_index].first();
2531 VMReg snd = regs[sig_index].second();
2532 if (fst->is_reg()) {
2533 stream->print("%s", fst->name());
2534 if (snd->is_valid()) {
2535 stream->print(":%s", snd->name());
2536 }
2537 } else if (fst->is_stack()) {
2538 int offset = fst->reg2stack() * VMRegImpl::stack_slot_size + stack_slot_offset;
2539 if (offset == stack_slot_offset) at_old_sp = true;
2540 stream->print("[%s+0x%x]", spname, offset);
2541 } else {
2542 stream->print("reg%d:%d??", (int)(intptr_t)fst, (int)(intptr_t)snd);
2543 }
2544 stream->print(" ");
2545 stream->move_to(tab2);
2546 stream->print("= ");
2547 if (at_this) {
2548 m->method_holder()->print_value_on(stream);
2549 } else {
2550 bool did_name = false;
2551 if (!at_this && ss.is_object()) {
2552 Symbol* name = ss.as_symbol_or_null();
2553 if (name != NULL) {
2554 name->print_value_on(stream);
2555 did_name = true;
2556 }
2557 }
2558 if (!did_name)
2559 stream->print("%s", type2name(t));
2560 }
2561 if (at_old_sp) {
2562 stream->print(" (%s of caller)", spname);
2563 did_old_sp = true;
2564 }
2565 stream->cr();
2566 sig_index += type2size[t];
2567 arg_index += 1;
2568 if (!at_this) ss.next();
2569 }
2570 if (!did_old_sp) {
2571 stream->print(" # ");
2572 stream->move_to(tab1);
2573 stream->print("[%s+0x%x]", spname, stack_slot_offset);
2574 stream->print(" (%s of caller)", spname);
2575 stream->cr();
2576 }
2577 }
2578 }
2579 }
2580
2581 void nmethod::print_code_comment_on(outputStream* st, int column, u_char* begin, u_char* end) {
2582 // First, find an oopmap in (begin, end].
2583 // We use the odd half-closed interval so that oop maps and scope descs
2584 // which are tied to the byte after a call are printed with the call itself.
2585 address base = code_begin();
2586 ImmutableOopMapSet* oms = oop_maps();
2587 if (oms != NULL) {
2588 for (int i = 0, imax = oms->count(); i < imax; i++) {
2589 const ImmutableOopMapPair* pair = oms->pair_at(i);
2590 const ImmutableOopMap* om = pair->get_from(oms);
2591 address pc = base + pair->pc_offset();
2592 if (pc > begin) {
2593 if (pc <= end) {
2594 st->move_to(column);
2595 st->print("; ");
2596 om->print_on(st);
2597 }
2598 break;
2599 }
2600 }
2601 }
2602
2603 // Print any debug info present at this pc.
2604 ScopeDesc* sd = scope_desc_in(begin, end);
2605 if (sd != NULL) {
2606 st->move_to(column);
2607 if (sd->bci() == SynchronizationEntryBCI) {
2608 st->print(";*synchronization entry");
2609 } else if (sd->bci() == AfterBci) {
2610 st->print(";* method exit (unlocked if synchronized)");
2611 } else if (sd->bci() == UnwindBci) {
2612 st->print(";* unwind (locked if synchronized)");
2613 } else if (sd->bci() == AfterExceptionBci) {
2614 st->print(";* unwind (unlocked if synchronized)");
2615 } else if (sd->bci() == UnknownBci) {
2616 st->print(";* unknown");
2617 } else if (sd->bci() == InvalidFrameStateBci) {
2618 st->print(";* invalid frame state");
2619 } else {
2620 if (sd->method() == NULL) {
2621 st->print("method is NULL");
2622 } else if (sd->method()->is_native()) {
2623 st->print("method is native");
2624 } else {
2625 Bytecodes::Code bc = sd->method()->java_code_at(sd->bci());
2626 st->print(";*%s", Bytecodes::name(bc));
2627 switch (bc) {
2628 case Bytecodes::_invokevirtual:
2629 case Bytecodes::_invokespecial:
2630 case Bytecodes::_invokestatic:
2631 case Bytecodes::_invokeinterface:
2632 {
2633 Bytecode_invoke invoke(sd->method(), sd->bci());
2634 st->print(" ");
2635 if (invoke.name() != NULL)
2636 invoke.name()->print_symbol_on(st);
2637 else
2638 st->print("<UNKNOWN>");
2639 break;
2640 }
2641 case Bytecodes::_getfield:
2642 case Bytecodes::_putfield:
2643 case Bytecodes::_getstatic:
2644 case Bytecodes::_putstatic:
2645 {
2646 Bytecode_field field(sd->method(), sd->bci());
2647 st->print(" ");
2648 if (field.name() != NULL)
2649 field.name()->print_symbol_on(st);
2650 else
2651 st->print("<UNKNOWN>");
2652 }
2653 default:
2654 break;
2655 }
2656 }
2657 st->print(" {reexecute=%d rethrow=%d return_oop=%d}", sd->should_reexecute(), sd->rethrow_exception(), sd->return_oop());
2658 }
2659
2660 // Print all scopes
2661 for (;sd != NULL; sd = sd->sender()) {
2662 st->move_to(column);
2663 st->print("; -");
2664 if (sd->method() == NULL) {
2665 st->print("method is NULL");
2666 } else {
2667 sd->method()->print_short_name(st);
2668 }
2669 int lineno = sd->method()->line_number_from_bci(sd->bci());
2670 if (lineno != -1) {
2671 st->print("@%d (line %d)", sd->bci(), lineno);
2672 } else {
2673 st->print("@%d", sd->bci());
2674 }
2675 st->cr();
2676 }
2677 }
2678
2679 // Print relocation information
2680 const char* str = reloc_string_for(begin, end);
2681 if (str != NULL) {
2682 if (sd != NULL) st->cr();
2683 st->move_to(column);
2684 st->print("; {%s}", str);
2685 }
2686 int cont_offset = ImplicitExceptionTable(this).at(begin - code_begin());
2687 if (cont_offset != 0) {
2688 st->move_to(column);
2689 st->print("; implicit exception: dispatches to " INTPTR_FORMAT, p2i(code_begin() + cont_offset));
2690 }
2691
2692 }
2693
2694 class DirectNativeCallWrapper: public NativeCallWrapper {
2695 private:
2696 NativeCall* _call;
2697
2698 public:
2699 DirectNativeCallWrapper(NativeCall* call) : _call(call) {}
2700
2701 virtual address destination() const { return _call->destination(); }
2702 virtual address instruction_address() const { return _call->instruction_address(); }
2703 virtual address next_instruction_address() const { return _call->next_instruction_address(); }
2704 virtual address return_address() const { return _call->return_address(); }
2705
2706 virtual address get_resolve_call_stub(bool is_optimized) const {
2707 if (is_optimized) {
2708 return SharedRuntime::get_resolve_opt_virtual_call_stub();
2709 }
2710 return SharedRuntime::get_resolve_virtual_call_stub();
2711 }
2712
2713 virtual void set_destination_mt_safe(address dest) {
2714 #if INCLUDE_AOT
2715 if (UseAOT) {
2716 CodeBlob* callee = CodeCache::find_blob(dest);
2717 CompiledMethod* cm = callee->as_compiled_method_or_null();
2718 if (cm != NULL && cm->is_far_code()) {
2719 // Temporary fix, see JDK-8143106
2720 CompiledDirectStaticCall* csc = CompiledDirectStaticCall::at(instruction_address());
2721 csc->set_to_far(methodHandle(cm->method()), dest);
2722 return;
2723 }
2724 }
2725 #endif
2726 _call->set_destination_mt_safe(dest);
2727 }
2728
2729 virtual void set_to_interpreted(const methodHandle& method, CompiledICInfo& info) {
2730 CompiledDirectStaticCall* csc = CompiledDirectStaticCall::at(instruction_address());
2731 #if INCLUDE_AOT
2732 if (info.to_aot()) {
2733 csc->set_to_far(method, info.entry());
2734 } else
2735 #endif
2736 {
2737 csc->set_to_interpreted(method, info.entry());
2738 }
2739 }
2740
2741 virtual void verify() const {
2742 // make sure code pattern is actually a call imm32 instruction
2743 _call->verify();
2744 _call->verify_alignment();
2745 }
2746
2747 virtual void verify_resolve_call(address dest) const {
2748 CodeBlob* db = CodeCache::find_blob_unsafe(dest);
2749 assert(db != NULL && !db->is_adapter_blob(), "must use stub!");
2750 }
2751
2752 virtual bool is_call_to_interpreted(address dest) const {
2753 CodeBlob* cb = CodeCache::find_blob(_call->instruction_address());
2754 return cb->contains(dest);
2755 }
2756
2757 virtual bool is_safe_for_patching() const { return false; }
2758
2759 virtual NativeInstruction* get_load_instruction(virtual_call_Relocation* r) const {
2760 return nativeMovConstReg_at(r->cached_value());
2761 }
2762
2763 virtual void *get_data(NativeInstruction* instruction) const {
2764 return (void*)((NativeMovConstReg*) instruction)->data();
2765 }
2766
2767 virtual void set_data(NativeInstruction* instruction, intptr_t data) {
2768 ((NativeMovConstReg*) instruction)->set_data(data);
2769 }
2770 };
2771
2772 NativeCallWrapper* nmethod::call_wrapper_at(address call) const {
2773 return new DirectNativeCallWrapper((NativeCall*) call);
2774 }
2775
2776 NativeCallWrapper* nmethod::call_wrapper_before(address return_pc) const {
2777 return new DirectNativeCallWrapper(nativeCall_before(return_pc));
2778 }
2779
2780 address nmethod::call_instruction_address(address pc) const {
2781 if (NativeCall::is_call_before(pc)) {
2782 NativeCall *ncall = nativeCall_before(pc);
2783 return ncall->instruction_address();
2784 }
2785 return NULL;
2786 }
2787
2788 CompiledStaticCall* nmethod::compiledStaticCall_at(Relocation* call_site) const {
2789 return CompiledDirectStaticCall::at(call_site);
2790 }
2791
2792 CompiledStaticCall* nmethod::compiledStaticCall_at(address call_site) const {
2793 return CompiledDirectStaticCall::at(call_site);
2794 }
2795
2796 CompiledStaticCall* nmethod::compiledStaticCall_before(address return_addr) const {
2797 return CompiledDirectStaticCall::before(return_addr);
2798 }
2799
2800 #ifndef PRODUCT
2801
2802 void nmethod::print_value_on(outputStream* st) const {
2803 st->print("nmethod");
2804 print_on(st, NULL);
2805 }
2806
2807 void nmethod::print_calls(outputStream* st) {
2808 RelocIterator iter(this);
2809 while (iter.next()) {
2810 switch (iter.type()) {
2811 case relocInfo::virtual_call_type:
2812 case relocInfo::opt_virtual_call_type: {
2813 CompiledICLocker ml_verify(this);
2814 CompiledIC_at(&iter)->print();
2815 break;
2816 }
2817 case relocInfo::static_call_type:
2818 st->print_cr("Static call at " INTPTR_FORMAT, p2i(iter.reloc()->addr()));
2819 CompiledDirectStaticCall::at(iter.reloc())->print();
2820 break;
2821 default:
2822 break;
2823 }
2824 }
2825 }
2826
2827 void nmethod::print_handler_table() {
2828 ExceptionHandlerTable(this).print();
2829 }
2830
2831 void nmethod::print_nul_chk_table() {
2832 ImplicitExceptionTable(this).print(code_begin());
2833 }
2834
2835 void nmethod::print_statistics() {
2836 ttyLocker ttyl;
2837 if (xtty != NULL) xtty->head("statistics type='nmethod'");
2838 native_nmethod_stats.print_native_nmethod_stats();
2839 #ifdef COMPILER1
2840 c1_java_nmethod_stats.print_nmethod_stats("C1");
2841 #endif
2842 #ifdef COMPILER2
2843 c2_java_nmethod_stats.print_nmethod_stats("C2");
2844 #endif
2845 #if INCLUDE_JVMCI
2846 jvmci_java_nmethod_stats.print_nmethod_stats("JVMCI");
2847 #endif
2848 unknown_java_nmethod_stats.print_nmethod_stats("Unknown");
2849 DebugInformationRecorder::print_statistics();
2850 #ifndef PRODUCT
2851 pc_nmethod_stats.print_pc_stats();
2852 #endif
2853 Dependencies::print_statistics();
2854 if (xtty != NULL) xtty->tail("statistics");
2855 }
2856
2857 #endif // !PRODUCT
2858
2859 #if INCLUDE_JVMCI
2860 void nmethod::clear_jvmci_installed_code() {
2861 assert_locked_or_safepoint(Patching_lock);
2862 if (_jvmci_installed_code != NULL) {
2863 JNIHandles::destroy_weak_global(_jvmci_installed_code);
2864 _jvmci_installed_code = NULL;
2865 }
2866 }
2867
2868 void nmethod::clear_speculation_log() {
2869 assert_locked_or_safepoint(Patching_lock);
2870 if (_speculation_log != NULL) {
2871 JNIHandles::destroy_weak_global(_speculation_log);
2872 _speculation_log = NULL;
2873 }
2874 }
2875
2876 void nmethod::maybe_invalidate_installed_code() {
2877 if (!is_compiled_by_jvmci()) {
2878 return;
2879 }
2880
2881 assert(Patching_lock->is_locked() ||
2882 SafepointSynchronize::is_at_safepoint(), "should be performed under a lock for consistency");
2883 oop installed_code = JNIHandles::resolve(_jvmci_installed_code);
2884 if (installed_code != NULL) {
2885 // Update the values in the InstalledCode instance if it still refers to this nmethod
2886 nmethod* nm = (nmethod*)InstalledCode::address(installed_code);
2887 if (nm == this) {
2888 if (!is_alive() || is_unloading()) {
2889 // Break the link between nmethod and InstalledCode such that the nmethod
2890 // can subsequently be flushed safely. The link must be maintained while
2891 // the method could have live activations since invalidateInstalledCode
2892 // might want to invalidate all existing activations.
2893 InstalledCode::set_address(installed_code, 0);
2894 InstalledCode::set_entryPoint(installed_code, 0);
2895 } else if (is_not_entrant()) {
2896 // Remove the entry point so any invocation will fail but keep
2897 // the address link around that so that existing activations can
2898 // be invalidated.
2899 InstalledCode::set_entryPoint(installed_code, 0);
2900 }
2901 }
2902 }
2903 if (!is_alive() || is_unloading()) {
2904 // Clear these out after the nmethod has been unregistered and any
2905 // updates to the InstalledCode instance have been performed.
2906 clear_jvmci_installed_code();
2907 clear_speculation_log();
2908 }
2909 }
2910
2911 void nmethod::invalidate_installed_code(Handle installedCode, TRAPS) {
2912 if (installedCode() == NULL) {
2913 THROW(vmSymbols::java_lang_NullPointerException());
2914 }
2915 jlong nativeMethod = InstalledCode::address(installedCode);
2916 nmethod* nm = (nmethod*)nativeMethod;
2917 if (nm == NULL) {
2918 // Nothing to do
2919 return;
2920 }
2921
2922 nmethodLocker nml(nm);
2923 #ifdef ASSERT
2924 {
2925 MutexLockerEx pl(Patching_lock, Mutex::_no_safepoint_check_flag);
2926 // This relationship can only be checked safely under a lock
2927 assert(!nm->is_alive() || nm->is_unloading() || nm->jvmci_installed_code() == installedCode(), "sanity check");
2928 }
2929 #endif
2930
2931 if (nm->is_alive()) {
2932 // Invalidating the InstalledCode means we want the nmethod
2933 // to be deoptimized.
2934 nm->mark_for_deoptimization();
2935 VM_Deoptimize op;
2936 VMThread::execute(&op);
2937 }
2938
2939 // Multiple threads could reach this point so we now need to
2940 // lock and re-check the link to the nmethod so that only one
2941 // thread clears it.
2942 MutexLockerEx pl(Patching_lock, Mutex::_no_safepoint_check_flag);
2943 if (InstalledCode::address(installedCode) == nativeMethod) {
2944 InstalledCode::set_address(installedCode, 0);
2945 }
2946 }
2947
2948 oop nmethod::jvmci_installed_code() {
2949 return JNIHandles::resolve(_jvmci_installed_code);
2950 }
2951
2952 oop nmethod::speculation_log() {
2953 return JNIHandles::resolve(_speculation_log);
2954 }
2955
2956 char* nmethod::jvmci_installed_code_name(char* buf, size_t buflen) const {
2957 if (!this->is_compiled_by_jvmci()) {
2958 return NULL;
2959 }
2960 oop installed_code = JNIHandles::resolve(_jvmci_installed_code);
2961 if (installed_code != NULL) {
2962 oop installed_code_name = NULL;
2963 if (installed_code->is_a(InstalledCode::klass())) {
2964 installed_code_name = InstalledCode::name(installed_code);
2965 }
2966 if (installed_code_name != NULL) {
2967 return java_lang_String::as_utf8_string(installed_code_name, buf, (int)buflen);
2968 }
2969 }
2970 return NULL;
2971 }
2972 #endif