Thu, 17 Jul 2014 10:21:31 +0200
8050972: Concurrency problem in PcDesc cache
Summary: The entries of the PcDesc cache in nmethods are not declared as volatile, but they are accessed and modified by several threads concurrently.
Reviewed-by: kvn, dholmes, dcubed
1 /*
2 * Copyright (c) 1997, 2013, 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 */
25 #ifndef SHARE_VM_CODE_NMETHOD_HPP
26 #define SHARE_VM_CODE_NMETHOD_HPP
28 #include "code/codeBlob.hpp"
29 #include "code/pcDesc.hpp"
30 #include "oops/metadata.hpp"
32 // This class is used internally by nmethods, to cache
33 // exception/pc/handler information.
35 class ExceptionCache : public CHeapObj<mtCode> {
36 friend class VMStructs;
37 private:
38 enum { cache_size = 16 };
39 Klass* _exception_type;
40 address _pc[cache_size];
41 address _handler[cache_size];
42 int _count;
43 ExceptionCache* _next;
45 address pc_at(int index) { assert(index >= 0 && index < count(),""); return _pc[index]; }
46 void set_pc_at(int index, address a) { assert(index >= 0 && index < cache_size,""); _pc[index] = a; }
47 address handler_at(int index) { assert(index >= 0 && index < count(),""); return _handler[index]; }
48 void set_handler_at(int index, address a) { assert(index >= 0 && index < cache_size,""); _handler[index] = a; }
49 int count() { return _count; }
50 void increment_count() { _count++; }
52 public:
54 ExceptionCache(Handle exception, address pc, address handler);
56 Klass* exception_type() { return _exception_type; }
57 ExceptionCache* next() { return _next; }
58 void set_next(ExceptionCache *ec) { _next = ec; }
60 address match(Handle exception, address pc);
61 bool match_exception_with_space(Handle exception) ;
62 address test_address(address addr);
63 bool add_address_and_handler(address addr, address handler) ;
64 };
67 // cache pc descs found in earlier inquiries
68 class PcDescCache VALUE_OBJ_CLASS_SPEC {
69 friend class VMStructs;
70 private:
71 enum { cache_size = 4 };
72 // The array elements MUST be volatile! Several threads may modify
73 // and read from the cache concurrently. find_pc_desc_internal has
74 // returned wrong results. C++ compiler (namely xlC12) may duplicate
75 // C++ field accesses if the elements are not volatile.
76 typedef PcDesc* PcDescPtr;
77 volatile PcDescPtr _pc_descs[cache_size]; // last cache_size pc_descs found
78 public:
79 PcDescCache() { debug_only(_pc_descs[0] = NULL); }
80 void reset_to(PcDesc* initial_pc_desc);
81 PcDesc* find_pc_desc(int pc_offset, bool approximate);
82 void add_pc_desc(PcDesc* pc_desc);
83 PcDesc* last_pc_desc() { return _pc_descs[0]; }
84 };
87 // nmethods (native methods) are the compiled code versions of Java methods.
88 //
89 // An nmethod contains:
90 // - header (the nmethod structure)
91 // [Relocation]
92 // - relocation information
93 // - constant part (doubles, longs and floats used in nmethod)
94 // - oop table
95 // [Code]
96 // - code body
97 // - exception handler
98 // - stub code
99 // [Debugging information]
100 // - oop array
101 // - data array
102 // - pcs
103 // [Exception handler table]
104 // - handler entry point array
105 // [Implicit Null Pointer exception table]
106 // - implicit null table array
108 class Dependencies;
109 class ExceptionHandlerTable;
110 class ImplicitExceptionTable;
111 class AbstractCompiler;
112 class xmlStream;
114 class nmethod : public CodeBlob {
115 friend class VMStructs;
116 friend class NMethodSweeper;
117 friend class CodeCache; // scavengable oops
118 private:
119 // Shared fields for all nmethod's
120 Method* _method;
121 int _entry_bci; // != InvocationEntryBci if this nmethod is an on-stack replacement method
122 jmethodID _jmethod_id; // Cache of method()->jmethod_id()
124 // To support simple linked-list chaining of nmethods:
125 nmethod* _osr_link; // from InstanceKlass::osr_nmethods_head
126 nmethod* _scavenge_root_link; // from CodeCache::scavenge_root_nmethods
128 static nmethod* volatile _oops_do_mark_nmethods;
129 nmethod* volatile _oops_do_mark_link;
131 AbstractCompiler* _compiler; // The compiler which compiled this nmethod
133 // offsets for entry points
134 address _entry_point; // entry point with class check
135 address _verified_entry_point; // entry point without class check
136 address _osr_entry_point; // entry point for on stack replacement
138 // Offsets for different nmethod parts
139 int _exception_offset;
140 // All deoptee's will resume execution at this location described by
141 // this offset.
142 int _deoptimize_offset;
143 // All deoptee's at a MethodHandle call site will resume execution
144 // at this location described by this offset.
145 int _deoptimize_mh_offset;
146 // Offset of the unwind handler if it exists
147 int _unwind_handler_offset;
149 #ifdef HAVE_DTRACE_H
150 int _trap_offset;
151 #endif // def HAVE_DTRACE_H
152 int _consts_offset;
153 int _stub_offset;
154 int _oops_offset; // offset to where embedded oop table begins (inside data)
155 int _metadata_offset; // embedded meta data table
156 int _scopes_data_offset;
157 int _scopes_pcs_offset;
158 int _dependencies_offset;
159 int _handler_table_offset;
160 int _nul_chk_table_offset;
161 int _nmethod_end_offset;
163 // location in frame (offset for sp) that deopt can store the original
164 // pc during a deopt.
165 int _orig_pc_offset;
167 int _compile_id; // which compilation made this nmethod
168 int _comp_level; // compilation level
170 // protected by CodeCache_lock
171 bool _has_flushed_dependencies; // Used for maintenance of dependencies (CodeCache_lock)
173 bool _marked_for_reclamation; // Used by NMethodSweeper (set only by sweeper)
174 bool _marked_for_deoptimization; // Used for stack deoptimization
176 // used by jvmti to track if an unload event has been posted for this nmethod.
177 bool _unload_reported;
179 // set during construction
180 unsigned int _has_unsafe_access:1; // May fault due to unsafe access.
181 unsigned int _has_method_handle_invokes:1; // Has this method MethodHandle invokes?
182 unsigned int _lazy_critical_native:1; // Lazy JNI critical native
183 unsigned int _has_wide_vectors:1; // Preserve wide vectors at safepoints
185 // Protected by Patching_lock
186 volatile unsigned char _state; // {alive, not_entrant, zombie, unloaded}
188 #ifdef ASSERT
189 bool _oops_are_stale; // indicates that it's no longer safe to access oops section
190 #endif
192 enum { in_use = 0, // executable nmethod
193 not_entrant = 1, // marked for deoptimization but activations may still exist,
194 // will be transformed to zombie when all activations are gone
195 zombie = 2, // no activations exist, nmethod is ready for purge
196 unloaded = 3 }; // there should be no activations, should not be called,
197 // will be transformed to zombie immediately
199 jbyte _scavenge_root_state;
201 #if INCLUDE_RTM_OPT
202 // RTM state at compile time. Used during deoptimization to decide
203 // whether to restart collecting RTM locking abort statistic again.
204 RTMState _rtm_state;
205 #endif
207 // Nmethod Flushing lock. If non-zero, then the nmethod is not removed
208 // and is not made into a zombie. However, once the nmethod is made into
209 // a zombie, it will be locked one final time if CompiledMethodUnload
210 // event processing needs to be done.
211 jint _lock_count;
213 // not_entrant method removal. Each mark_sweep pass will update
214 // this mark to current sweep invocation count if it is seen on the
215 // stack. An not_entrant method can be removed when there are no
216 // more activations, i.e., when the _stack_traversal_mark is less than
217 // current sweep traversal index.
218 long _stack_traversal_mark;
220 // The _hotness_counter indicates the hotness of a method. The higher
221 // the value the hotter the method. The hotness counter of a nmethod is
222 // set to [(ReservedCodeCacheSize / (1024 * 1024)) * 2] each time the method
223 // is active while stack scanning (mark_active_nmethods()). The hotness
224 // counter is decreased (by 1) while sweeping.
225 int _hotness_counter;
227 ExceptionCache *_exception_cache;
228 PcDescCache _pc_desc_cache;
230 // These are used for compiled synchronized native methods to
231 // locate the owner and stack slot for the BasicLock so that we can
232 // properly revoke the bias of the owner if necessary. They are
233 // needed because there is no debug information for compiled native
234 // wrappers and the oop maps are insufficient to allow
235 // frame::retrieve_receiver() to work. Currently they are expected
236 // to be byte offsets from the Java stack pointer for maximum code
237 // sharing between platforms. Note that currently biased locking
238 // will never cause Class instances to be biased but this code
239 // handles the static synchronized case as well.
240 // JVMTI's GetLocalInstance() also uses these offsets to find the receiver
241 // for non-static native wrapper frames.
242 ByteSize _native_receiver_sp_offset;
243 ByteSize _native_basic_lock_sp_offset;
245 friend class nmethodLocker;
247 // For native wrappers
248 nmethod(Method* method,
249 int nmethod_size,
250 int compile_id,
251 CodeOffsets* offsets,
252 CodeBuffer *code_buffer,
253 int frame_size,
254 ByteSize basic_lock_owner_sp_offset, /* synchronized natives only */
255 ByteSize basic_lock_sp_offset, /* synchronized natives only */
256 OopMapSet* oop_maps);
258 #ifdef HAVE_DTRACE_H
259 // For native wrappers
260 nmethod(Method* method,
261 int nmethod_size,
262 CodeOffsets* offsets,
263 CodeBuffer *code_buffer,
264 int frame_size);
265 #endif // def HAVE_DTRACE_H
267 // Creation support
268 nmethod(Method* method,
269 int nmethod_size,
270 int compile_id,
271 int entry_bci,
272 CodeOffsets* offsets,
273 int orig_pc_offset,
274 DebugInformationRecorder *recorder,
275 Dependencies* dependencies,
276 CodeBuffer *code_buffer,
277 int frame_size,
278 OopMapSet* oop_maps,
279 ExceptionHandlerTable* handler_table,
280 ImplicitExceptionTable* nul_chk_table,
281 AbstractCompiler* compiler,
282 int comp_level);
284 // helper methods
285 void* operator new(size_t size, int nmethod_size) throw();
287 const char* reloc_string_for(u_char* begin, u_char* end);
288 // Returns true if this thread changed the state of the nmethod or
289 // false if another thread performed the transition.
290 bool make_not_entrant_or_zombie(unsigned int state);
291 void inc_decompile_count();
293 // Used to manipulate the exception cache
294 void add_exception_cache_entry(ExceptionCache* new_entry);
295 ExceptionCache* exception_cache_entry_for_exception(Handle exception);
297 // Inform external interfaces that a compiled method has been unloaded
298 void post_compiled_method_unload();
300 // Initailize fields to their default values
301 void init_defaults();
303 public:
304 // create nmethod with entry_bci
305 static nmethod* new_nmethod(methodHandle method,
306 int compile_id,
307 int entry_bci,
308 CodeOffsets* offsets,
309 int orig_pc_offset,
310 DebugInformationRecorder* recorder,
311 Dependencies* dependencies,
312 CodeBuffer *code_buffer,
313 int frame_size,
314 OopMapSet* oop_maps,
315 ExceptionHandlerTable* handler_table,
316 ImplicitExceptionTable* nul_chk_table,
317 AbstractCompiler* compiler,
318 int comp_level);
320 static nmethod* new_native_nmethod(methodHandle method,
321 int compile_id,
322 CodeBuffer *code_buffer,
323 int vep_offset,
324 int frame_complete,
325 int frame_size,
326 ByteSize receiver_sp_offset,
327 ByteSize basic_lock_sp_offset,
328 OopMapSet* oop_maps);
330 #ifdef HAVE_DTRACE_H
331 // The method we generate for a dtrace probe has to look
332 // like an nmethod as far as the rest of the system is concerned
333 // which is somewhat unfortunate.
334 static nmethod* new_dtrace_nmethod(methodHandle method,
335 CodeBuffer *code_buffer,
336 int vep_offset,
337 int trap_offset,
338 int frame_complete,
339 int frame_size);
341 int trap_offset() const { return _trap_offset; }
342 address trap_address() const { return insts_begin() + _trap_offset; }
344 #endif // def HAVE_DTRACE_H
346 // accessors
347 Method* method() const { return _method; }
348 AbstractCompiler* compiler() const { return _compiler; }
350 // type info
351 bool is_nmethod() const { return true; }
352 bool is_java_method() const { return !method()->is_native(); }
353 bool is_native_method() const { return method()->is_native(); }
354 bool is_osr_method() const { return _entry_bci != InvocationEntryBci; }
356 bool is_compiled_by_c1() const;
357 bool is_compiled_by_c2() const;
358 bool is_compiled_by_shark() const;
360 // boundaries for different parts
361 address consts_begin () const { return header_begin() + _consts_offset ; }
362 address consts_end () const { return header_begin() + code_offset() ; }
363 address insts_begin () const { return header_begin() + code_offset() ; }
364 address insts_end () const { return header_begin() + _stub_offset ; }
365 address stub_begin () const { return header_begin() + _stub_offset ; }
366 address stub_end () const { return header_begin() + _oops_offset ; }
367 address exception_begin () const { return header_begin() + _exception_offset ; }
368 address deopt_handler_begin () const { return header_begin() + _deoptimize_offset ; }
369 address deopt_mh_handler_begin() const { return header_begin() + _deoptimize_mh_offset ; }
370 address unwind_handler_begin () const { return _unwind_handler_offset != -1 ? (header_begin() + _unwind_handler_offset) : NULL; }
371 oop* oops_begin () const { return (oop*) (header_begin() + _oops_offset) ; }
372 oop* oops_end () const { return (oop*) (header_begin() + _metadata_offset) ; }
374 Metadata** metadata_begin () const { return (Metadata**) (header_begin() + _metadata_offset) ; }
375 Metadata** metadata_end () const { return (Metadata**) (header_begin() + _scopes_data_offset) ; }
377 address scopes_data_begin () const { return header_begin() + _scopes_data_offset ; }
378 address scopes_data_end () const { return header_begin() + _scopes_pcs_offset ; }
379 PcDesc* scopes_pcs_begin () const { return (PcDesc*)(header_begin() + _scopes_pcs_offset ); }
380 PcDesc* scopes_pcs_end () const { return (PcDesc*)(header_begin() + _dependencies_offset) ; }
381 address dependencies_begin () const { return header_begin() + _dependencies_offset ; }
382 address dependencies_end () const { return header_begin() + _handler_table_offset ; }
383 address handler_table_begin () const { return header_begin() + _handler_table_offset ; }
384 address handler_table_end () const { return header_begin() + _nul_chk_table_offset ; }
385 address nul_chk_table_begin () const { return header_begin() + _nul_chk_table_offset ; }
386 address nul_chk_table_end () const { return header_begin() + _nmethod_end_offset ; }
388 // Sizes
389 int consts_size () const { return consts_end () - consts_begin (); }
390 int insts_size () const { return insts_end () - insts_begin (); }
391 int stub_size () const { return stub_end () - stub_begin (); }
392 int oops_size () const { return (address) oops_end () - (address) oops_begin (); }
393 int metadata_size () const { return (address) metadata_end () - (address) metadata_begin (); }
394 int scopes_data_size () const { return scopes_data_end () - scopes_data_begin (); }
395 int scopes_pcs_size () const { return (intptr_t) scopes_pcs_end () - (intptr_t) scopes_pcs_begin (); }
396 int dependencies_size () const { return dependencies_end () - dependencies_begin (); }
397 int handler_table_size() const { return handler_table_end() - handler_table_begin(); }
398 int nul_chk_table_size() const { return nul_chk_table_end() - nul_chk_table_begin(); }
400 int total_size () const;
402 void dec_hotness_counter() { _hotness_counter--; }
403 void set_hotness_counter(int val) { _hotness_counter = val; }
404 int hotness_counter() const { return _hotness_counter; }
406 // Containment
407 bool consts_contains (address addr) const { return consts_begin () <= addr && addr < consts_end (); }
408 bool insts_contains (address addr) const { return insts_begin () <= addr && addr < insts_end (); }
409 bool stub_contains (address addr) const { return stub_begin () <= addr && addr < stub_end (); }
410 bool oops_contains (oop* addr) const { return oops_begin () <= addr && addr < oops_end (); }
411 bool metadata_contains (Metadata** addr) const { return metadata_begin () <= addr && addr < metadata_end (); }
412 bool scopes_data_contains (address addr) const { return scopes_data_begin () <= addr && addr < scopes_data_end (); }
413 bool scopes_pcs_contains (PcDesc* addr) const { return scopes_pcs_begin () <= addr && addr < scopes_pcs_end (); }
414 bool handler_table_contains(address addr) const { return handler_table_begin() <= addr && addr < handler_table_end(); }
415 bool nul_chk_table_contains(address addr) const { return nul_chk_table_begin() <= addr && addr < nul_chk_table_end(); }
417 // entry points
418 address entry_point() const { return _entry_point; } // normal entry point
419 address verified_entry_point() const { return _verified_entry_point; } // if klass is correct
421 // flag accessing and manipulation
422 bool is_in_use() const { return _state == in_use; }
423 bool is_alive() const { return _state == in_use || _state == not_entrant; }
424 bool is_not_entrant() const { return _state == not_entrant; }
425 bool is_zombie() const { return _state == zombie; }
426 bool is_unloaded() const { return _state == unloaded; }
428 #if INCLUDE_RTM_OPT
429 // rtm state accessing and manipulating
430 RTMState rtm_state() const { return _rtm_state; }
431 void set_rtm_state(RTMState state) { _rtm_state = state; }
432 #endif
434 // Make the nmethod non entrant. The nmethod will continue to be
435 // alive. It is used when an uncommon trap happens. Returns true
436 // if this thread changed the state of the nmethod or false if
437 // another thread performed the transition.
438 bool make_not_entrant() { return make_not_entrant_or_zombie(not_entrant); }
439 bool make_zombie() { return make_not_entrant_or_zombie(zombie); }
441 // used by jvmti to track if the unload event has been reported
442 bool unload_reported() { return _unload_reported; }
443 void set_unload_reported() { _unload_reported = true; }
445 bool is_marked_for_deoptimization() const { return _marked_for_deoptimization; }
446 void mark_for_deoptimization() { _marked_for_deoptimization = true; }
448 void make_unloaded(BoolObjectClosure* is_alive, oop cause);
450 bool has_dependencies() { return dependencies_size() != 0; }
451 void flush_dependencies(BoolObjectClosure* is_alive);
452 bool has_flushed_dependencies() { return _has_flushed_dependencies; }
453 void set_has_flushed_dependencies() {
454 assert(!has_flushed_dependencies(), "should only happen once");
455 _has_flushed_dependencies = 1;
456 }
458 bool is_marked_for_reclamation() const { return _marked_for_reclamation; }
459 void mark_for_reclamation() { _marked_for_reclamation = 1; }
461 bool has_unsafe_access() const { return _has_unsafe_access; }
462 void set_has_unsafe_access(bool z) { _has_unsafe_access = z; }
464 bool has_method_handle_invokes() const { return _has_method_handle_invokes; }
465 void set_has_method_handle_invokes(bool z) { _has_method_handle_invokes = z; }
467 bool is_lazy_critical_native() const { return _lazy_critical_native; }
468 void set_lazy_critical_native(bool z) { _lazy_critical_native = z; }
470 bool has_wide_vectors() const { return _has_wide_vectors; }
471 void set_has_wide_vectors(bool z) { _has_wide_vectors = z; }
473 int comp_level() const { return _comp_level; }
475 // Support for oops in scopes and relocs:
476 // Note: index 0 is reserved for null.
477 oop oop_at(int index) const { return index == 0 ? (oop) NULL: *oop_addr_at(index); }
478 oop* oop_addr_at(int index) const { // for GC
479 // relocation indexes are biased by 1 (because 0 is reserved)
480 assert(index > 0 && index <= oops_size(), "must be a valid non-zero index");
481 assert(!_oops_are_stale, "oops are stale");
482 return &oops_begin()[index - 1];
483 }
485 // Support for meta data in scopes and relocs:
486 // Note: index 0 is reserved for null.
487 Metadata* metadata_at(int index) const { return index == 0 ? NULL: *metadata_addr_at(index); }
488 Metadata** metadata_addr_at(int index) const { // for GC
489 // relocation indexes are biased by 1 (because 0 is reserved)
490 assert(index > 0 && index <= metadata_size(), "must be a valid non-zero index");
491 return &metadata_begin()[index - 1];
492 }
494 void copy_values(GrowableArray<jobject>* oops);
495 void copy_values(GrowableArray<Metadata*>* metadata);
497 // Relocation support
498 private:
499 void fix_oop_relocations(address begin, address end, bool initialize_immediates);
500 inline void initialize_immediate_oop(oop* dest, jobject handle);
502 public:
503 void fix_oop_relocations(address begin, address end) { fix_oop_relocations(begin, end, false); }
504 void fix_oop_relocations() { fix_oop_relocations(NULL, NULL, false); }
505 void verify_oop_relocations();
507 bool is_at_poll_return(address pc);
508 bool is_at_poll_or_poll_return(address pc);
510 // Scavengable oop support
511 bool on_scavenge_root_list() const { return (_scavenge_root_state & 1) != 0; }
512 protected:
513 enum { sl_on_list = 0x01, sl_marked = 0x10 };
514 void set_on_scavenge_root_list() { _scavenge_root_state = sl_on_list; }
515 void clear_on_scavenge_root_list() { _scavenge_root_state = 0; }
516 // assertion-checking and pruning logic uses the bits of _scavenge_root_state
517 #ifndef PRODUCT
518 void set_scavenge_root_marked() { _scavenge_root_state |= sl_marked; }
519 void clear_scavenge_root_marked() { _scavenge_root_state &= ~sl_marked; }
520 bool scavenge_root_not_marked() { return (_scavenge_root_state &~ sl_on_list) == 0; }
521 // N.B. there is no positive marked query, and we only use the not_marked query for asserts.
522 #endif //PRODUCT
523 nmethod* scavenge_root_link() const { return _scavenge_root_link; }
524 void set_scavenge_root_link(nmethod *n) { _scavenge_root_link = n; }
526 public:
528 // Sweeper support
529 long stack_traversal_mark() { return _stack_traversal_mark; }
530 void set_stack_traversal_mark(long l) { _stack_traversal_mark = l; }
532 // Exception cache support
533 ExceptionCache* exception_cache() const { return _exception_cache; }
534 void set_exception_cache(ExceptionCache *ec) { _exception_cache = ec; }
535 address handler_for_exception_and_pc(Handle exception, address pc);
536 void add_handler_for_exception_and_pc(Handle exception, address pc, address handler);
537 void remove_from_exception_cache(ExceptionCache* ec);
539 // implicit exceptions support
540 address continuation_for_implicit_exception(address pc);
542 // On-stack replacement support
543 int osr_entry_bci() const { assert(is_osr_method(), "wrong kind of nmethod"); return _entry_bci; }
544 address osr_entry() const { assert(is_osr_method(), "wrong kind of nmethod"); return _osr_entry_point; }
545 void invalidate_osr_method();
546 nmethod* osr_link() const { return _osr_link; }
547 void set_osr_link(nmethod *n) { _osr_link = n; }
549 // tells whether frames described by this nmethod can be deoptimized
550 // note: native wrappers cannot be deoptimized.
551 bool can_be_deoptimized() const { return is_java_method(); }
553 // Inline cache support
554 void clear_inline_caches();
555 void cleanup_inline_caches();
556 bool inlinecache_check_contains(address addr) const {
557 return (addr >= code_begin() && addr < verified_entry_point());
558 }
560 // Check that all metadata is still alive
561 void verify_metadata_loaders(address low_boundary, BoolObjectClosure* is_alive);
563 // unlink and deallocate this nmethod
564 // Only NMethodSweeper class is expected to use this. NMethodSweeper is not
565 // expected to use any other private methods/data in this class.
567 protected:
568 void flush();
570 public:
571 // When true is returned, it is unsafe to remove this nmethod even if
572 // it is a zombie, since the VM or the ServiceThread might still be
573 // using it.
574 bool is_locked_by_vm() const { return _lock_count >0; }
576 // See comment at definition of _last_seen_on_stack
577 void mark_as_seen_on_stack();
578 bool can_not_entrant_be_converted();
580 // Evolution support. We make old (discarded) compiled methods point to new Method*s.
581 void set_method(Method* method) { _method = method; }
583 // GC support
584 void do_unloading(BoolObjectClosure* is_alive, bool unloading_occurred);
585 bool can_unload(BoolObjectClosure* is_alive, oop* root, bool unloading_occurred);
587 void preserve_callee_argument_oops(frame fr, const RegisterMap *reg_map,
588 OopClosure* f);
589 void oops_do(OopClosure* f) { oops_do(f, false); }
590 void oops_do(OopClosure* f, bool allow_zombie);
591 bool detect_scavenge_root_oops();
592 void verify_scavenge_root_oops() PRODUCT_RETURN;
594 bool test_set_oops_do_mark();
595 static void oops_do_marking_prologue();
596 static void oops_do_marking_epilogue();
597 static bool oops_do_marking_is_active() { return _oops_do_mark_nmethods != NULL; }
598 bool test_oops_do_mark() { return _oops_do_mark_link != NULL; }
600 // ScopeDesc for an instruction
601 ScopeDesc* scope_desc_at(address pc);
603 private:
604 ScopeDesc* scope_desc_in(address begin, address end);
606 address* orig_pc_addr(const frame* fr) { return (address*) ((address)fr->unextended_sp() + _orig_pc_offset); }
608 PcDesc* find_pc_desc_internal(address pc, bool approximate);
610 PcDesc* find_pc_desc(address pc, bool approximate) {
611 PcDesc* desc = _pc_desc_cache.last_pc_desc();
612 if (desc != NULL && desc->pc_offset() == pc - code_begin()) {
613 return desc;
614 }
615 return find_pc_desc_internal(pc, approximate);
616 }
618 public:
619 // ScopeDesc retrieval operation
620 PcDesc* pc_desc_at(address pc) { return find_pc_desc(pc, false); }
621 // pc_desc_near returns the first PcDesc at or after the givne pc.
622 PcDesc* pc_desc_near(address pc) { return find_pc_desc(pc, true); }
624 public:
625 // copying of debugging information
626 void copy_scopes_pcs(PcDesc* pcs, int count);
627 void copy_scopes_data(address buffer, int size);
629 // Deopt
630 // Return true is the PC is one would expect if the frame is being deopted.
631 bool is_deopt_pc (address pc) { return is_deopt_entry(pc) || is_deopt_mh_entry(pc); }
632 bool is_deopt_entry (address pc) { return pc == deopt_handler_begin(); }
633 bool is_deopt_mh_entry(address pc) { return pc == deopt_mh_handler_begin(); }
634 // Accessor/mutator for the original pc of a frame before a frame was deopted.
635 address get_original_pc(const frame* fr) { return *orig_pc_addr(fr); }
636 void set_original_pc(const frame* fr, address pc) { *orig_pc_addr(fr) = pc; }
638 static address get_deopt_original_pc(const frame* fr);
640 // MethodHandle
641 bool is_method_handle_return(address return_pc);
643 // jvmti support:
644 void post_compiled_method_load_event();
645 jmethodID get_and_cache_jmethod_id();
647 // verify operations
648 void verify();
649 void verify_scopes();
650 void verify_interrupt_point(address interrupt_point);
652 // printing support
653 void print() const;
654 void print_code();
655 void print_relocations() PRODUCT_RETURN;
656 void print_pcs() PRODUCT_RETURN;
657 void print_scopes() PRODUCT_RETURN;
658 void print_dependencies() PRODUCT_RETURN;
659 void print_value_on(outputStream* st) const PRODUCT_RETURN;
660 void print_calls(outputStream* st) PRODUCT_RETURN;
661 void print_handler_table() PRODUCT_RETURN;
662 void print_nul_chk_table() PRODUCT_RETURN;
663 void print_nmethod(bool print_code);
665 // need to re-define this from CodeBlob else the overload hides it
666 virtual void print_on(outputStream* st) const { CodeBlob::print_on(st); }
667 void print_on(outputStream* st, const char* msg) const;
669 // Logging
670 void log_identity(xmlStream* log) const;
671 void log_new_nmethod() const;
672 void log_state_change() const;
674 // Prints block-level comments, including nmethod specific block labels:
675 virtual void print_block_comment(outputStream* stream, address block_begin) const {
676 print_nmethod_labels(stream, block_begin);
677 CodeBlob::print_block_comment(stream, block_begin);
678 }
679 void print_nmethod_labels(outputStream* stream, address block_begin) const;
681 // Prints a comment for one native instruction (reloc info, pc desc)
682 void print_code_comment_on(outputStream* st, int column, address begin, address end);
683 static void print_statistics() PRODUCT_RETURN;
685 // Compiler task identification. Note that all OSR methods
686 // are numbered in an independent sequence if CICountOSR is true,
687 // and native method wrappers are also numbered independently if
688 // CICountNative is true.
689 int compile_id() const { return _compile_id; }
690 const char* compile_kind() const;
692 // For debugging
693 // CompiledIC* IC_at(char* p) const;
694 // PrimitiveIC* primitiveIC_at(char* p) const;
695 oop embeddedOop_at(address p);
697 // tells if any of this method's dependencies have been invalidated
698 // (this is expensive!)
699 bool check_all_dependencies();
701 // tells if this compiled method is dependent on the given changes,
702 // and the changes have invalidated it
703 bool check_dependency_on(DepChange& changes);
705 // Evolution support. Tells if this compiled method is dependent on any of
706 // methods m() of class dependee, such that if m() in dependee is replaced,
707 // this compiled method will have to be deoptimized.
708 bool is_evol_dependent_on(Klass* dependee);
710 // Fast breakpoint support. Tells if this compiled method is
711 // dependent on the given method. Returns true if this nmethod
712 // corresponds to the given method as well.
713 bool is_dependent_on_method(Method* dependee);
715 // is it ok to patch at address?
716 bool is_patchable_at(address instr_address);
718 // UseBiasedLocking support
719 ByteSize native_receiver_sp_offset() {
720 return _native_receiver_sp_offset;
721 }
722 ByteSize native_basic_lock_sp_offset() {
723 return _native_basic_lock_sp_offset;
724 }
726 // support for code generation
727 static int verified_entry_point_offset() { return offset_of(nmethod, _verified_entry_point); }
728 static int osr_entry_point_offset() { return offset_of(nmethod, _osr_entry_point); }
729 static int entry_bci_offset() { return offset_of(nmethod, _entry_bci); }
731 // RedefineClasses support. Mark metadata in nmethods as on_stack so that
732 // redefine classes doesn't purge it.
733 static void mark_on_stack(nmethod* nm) {
734 nm->metadata_do(Metadata::mark_on_stack);
735 }
736 void metadata_do(void f(Metadata*));
737 };
739 // Locks an nmethod so its code will not get removed and it will not
740 // be made into a zombie, even if it is a not_entrant method. After the
741 // nmethod becomes a zombie, if CompiledMethodUnload event processing
742 // needs to be done, then lock_nmethod() is used directly to keep the
743 // generated code from being reused too early.
744 class nmethodLocker : public StackObj {
745 nmethod* _nm;
747 public:
749 // note: nm can be NULL
750 // Only JvmtiDeferredEvent::compiled_method_unload_event()
751 // should pass zombie_ok == true.
752 static void lock_nmethod(nmethod* nm, bool zombie_ok = false);
753 static void unlock_nmethod(nmethod* nm); // (ditto)
755 nmethodLocker(address pc); // derive nm from pc
756 nmethodLocker(nmethod *nm) { _nm = nm; lock_nmethod(_nm); }
757 nmethodLocker() { _nm = NULL; }
758 ~nmethodLocker() { unlock_nmethod(_nm); }
760 nmethod* code() { return _nm; }
761 void set_code(nmethod* new_nm) {
762 unlock_nmethod(_nm); // note: This works even if _nm==new_nm.
763 _nm = new_nm;
764 lock_nmethod(_nm);
765 }
766 };
768 #endif // SHARE_VM_CODE_NMETHOD_HPP