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