1 /*
2 * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 *
23 */
24
25 #ifndef SHARE_VM_CODE_NMETHOD_HPP
26 #define SHARE_VM_CODE_NMETHOD_HPP
27
28 #include "code/codeBlob.hpp"
29 #include "code/pcDesc.hpp"
30
31 // This class is used internally by nmethods, to cache
32 // exception/pc/handler information.
33
34 class ExceptionCache : public CHeapObj {
35 friend class VMStructs;
36 private:
37 enum { cache_size = 16 };
38 klassOop _exception_type;
39 address _pc[cache_size];
40 address _handler[cache_size];
41 int _count;
42 ExceptionCache* _next;
43
44 address pc_at(int index) { assert(index >= 0 && index < count(),""); return _pc[index]; }
45 void set_pc_at(int index, address a) { assert(index >= 0 && index < cache_size,""); _pc[index] = a; }
46 address handler_at(int index) { assert(index >= 0 && index < count(),""); return _handler[index]; }
47 void set_handler_at(int index, address a) { assert(index >= 0 && index < cache_size,""); _handler[index] = a; }
48 int count() { return _count; }
49 void increment_count() { _count++; }
50
51 public:
52
53 ExceptionCache(Handle exception, address pc, address handler);
54
55 klassOop exception_type() { return _exception_type; }
56 klassOop* exception_type_addr() { return &_exception_type; }
57 ExceptionCache* next() { return _next; }
58 void set_next(ExceptionCache *ec) { _next = ec; }
59
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 };
65
66
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 };
80
81
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
102
103 class Dependencies;
104 class ExceptionHandlerTable;
105 class ImplicitExceptionTable;
106 class AbstractCompiler;
107 class xmlStream;
108
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 methodOop _method;
116 int _entry_bci; // != InvocationEntryBci if this nmethod is an on-stack replacement method
117 jmethodID _jmethod_id; // Cache of method()->jmethod_id()
118
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
122 nmethod* _saved_nmethod_link; // from CodeCache::speculatively_disconnect
123
124 static nmethod* volatile _oops_do_mark_nmethods;
125 nmethod* volatile _oops_do_mark_link;
126
127 AbstractCompiler* _compiler; // The compiler which compiled this nmethod
128
129 // offsets for entry points
130 address _entry_point; // entry point with class check
131 address _verified_entry_point; // entry point without class check
132 address _osr_entry_point; // entry point for on stack replacement
133
134 // Offsets for different nmethod parts
135 int _exception_offset;
136 // All deoptee's will resume execution at this location described by
137 // this offset.
138 int _deoptimize_offset;
139 // All deoptee's at a MethodHandle call site will resume execution
140 // at this location described by this offset.
141 int _deoptimize_mh_offset;
142 // Offset of the unwind handler if it exists
143 int _unwind_handler_offset;
144
145 #ifdef HAVE_DTRACE_H
146 int _trap_offset;
147 #endif // def HAVE_DTRACE_H
148 int _consts_offset;
149 int _stub_offset;
150 int _oops_offset; // offset to where embedded oop table begins (inside data)
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;
157
158 // location in frame (offset for sp) that deopt can store the original
159 // pc during a deopt.
160 int _orig_pc_offset;
161
162 int _compile_id; // which compilation made this nmethod
163 int _comp_level; // compilation level
164
165 // protected by CodeCache_lock
166 bool _has_flushed_dependencies; // Used for maintenance of dependencies (CodeCache_lock)
167 bool _speculatively_disconnected; // Marked for potential unload
168
169 bool _marked_for_reclamation; // Used by NMethodSweeper (set only by sweeper)
170 bool _marked_for_deoptimization; // Used for stack deoptimization
171
172 // used by jvmti to track if an unload event has been posted for this nmethod.
173 bool _unload_reported;
174
175 // set during construction
176 unsigned int _has_unsafe_access:1; // May fault due to unsafe access.
177 unsigned int _has_method_handle_invokes:1; // Has this method MethodHandle invokes?
178
179 // Protected by Patching_lock
180 unsigned char _state; // {alive, not_entrant, zombie, unloaded}
181
182 #ifdef ASSERT
183 bool _oops_are_stale; // indicates that it's no longer safe to access oops section
184 #endif
185
186 enum { alive = 0,
187 not_entrant = 1, // uncommon trap has happened but activations may still exist
188 zombie = 2,
189 unloaded = 3 };
190
191
192 jbyte _scavenge_root_state;
193
194 // Nmethod Flushing lock. If non-zero, then the nmethod is not removed
195 // and is not made into a zombie. However, once the nmethod is made into
196 // a zombie, it will be locked one final time if CompiledMethodUnload
197 // event processing needs to be done.
198 jint _lock_count;
199
200 // not_entrant method removal. Each mark_sweep pass will update
201 // this mark to current sweep invocation count if it is seen on the
202 // stack. An not_entrant method can be removed when there is no
203 // more activations, i.e., when the _stack_traversal_mark is less than
204 // current sweep traversal index.
205 long _stack_traversal_mark;
206
207 ExceptionCache *_exception_cache;
208 PcDescCache _pc_desc_cache;
209
210 // These are used for compiled synchronized native methods to
211 // locate the owner and stack slot for the BasicLock so that we can
212 // properly revoke the bias of the owner if necessary. They are
213 // needed because there is no debug information for compiled native
214 // wrappers and the oop maps are insufficient to allow
215 // frame::retrieve_receiver() to work. Currently they are expected
216 // to be byte offsets from the Java stack pointer for maximum code
217 // sharing between platforms. Note that currently biased locking
218 // will never cause Class instances to be biased but this code
219 // handles the static synchronized case as well.
220 // JVMTI's GetLocalInstance() also uses these offsets to find the receiver
221 // for non-static native wrapper frames.
222 ByteSize _native_receiver_sp_offset;
223 ByteSize _native_basic_lock_sp_offset;
224
225 friend class nmethodLocker;
226
227 // For native wrappers
228 nmethod(methodOop method,
229 int nmethod_size,
230 int compile_id,
231 CodeOffsets* offsets,
232 CodeBuffer *code_buffer,
233 int frame_size,
234 ByteSize basic_lock_owner_sp_offset, /* synchronized natives only */
235 ByteSize basic_lock_sp_offset, /* synchronized natives only */
236 OopMapSet* oop_maps);
237
238 #ifdef HAVE_DTRACE_H
239 // For native wrappers
240 nmethod(methodOop method,
241 int nmethod_size,
242 CodeOffsets* offsets,
243 CodeBuffer *code_buffer,
244 int frame_size);
245 #endif // def HAVE_DTRACE_H
246
247 // Creation support
248 nmethod(methodOop method,
249 int nmethod_size,
250 int compile_id,
251 int entry_bci,
252 CodeOffsets* offsets,
253 int orig_pc_offset,
254 DebugInformationRecorder *recorder,
255 Dependencies* dependencies,
256 CodeBuffer *code_buffer,
257 int frame_size,
258 OopMapSet* oop_maps,
259 ExceptionHandlerTable* handler_table,
260 ImplicitExceptionTable* nul_chk_table,
261 AbstractCompiler* compiler,
262 int comp_level);
263
264 // helper methods
265 void* operator new(size_t size, int nmethod_size);
266
267 const char* reloc_string_for(u_char* begin, u_char* end);
268 // Returns true if this thread changed the state of the nmethod or
269 // false if another thread performed the transition.
270 bool make_not_entrant_or_zombie(unsigned int state);
271 void inc_decompile_count();
272
273 // Used to manipulate the exception cache
274 void add_exception_cache_entry(ExceptionCache* new_entry);
275 ExceptionCache* exception_cache_entry_for_exception(Handle exception);
276
277 // Inform external interfaces that a compiled method has been unloaded
278 void post_compiled_method_unload();
279
280 // Initailize fields to their default values
281 void init_defaults();
282
283 public:
284 // create nmethod with entry_bci
285 static nmethod* new_nmethod(methodHandle method,
286 int compile_id,
287 int entry_bci,
288 CodeOffsets* offsets,
289 int orig_pc_offset,
290 DebugInformationRecorder* recorder,
291 Dependencies* dependencies,
292 CodeBuffer *code_buffer,
293 int frame_size,
294 OopMapSet* oop_maps,
295 ExceptionHandlerTable* handler_table,
296 ImplicitExceptionTable* nul_chk_table,
297 AbstractCompiler* compiler,
298 int comp_level);
299
300 static nmethod* new_native_nmethod(methodHandle method,
301 int compile_id,
302 CodeBuffer *code_buffer,
303 int vep_offset,
304 int frame_complete,
305 int frame_size,
306 ByteSize receiver_sp_offset,
307 ByteSize basic_lock_sp_offset,
308 OopMapSet* oop_maps);
309
310 #ifdef HAVE_DTRACE_H
311 // The method we generate for a dtrace probe has to look
312 // like an nmethod as far as the rest of the system is concerned
313 // which is somewhat unfortunate.
314 static nmethod* new_dtrace_nmethod(methodHandle method,
315 CodeBuffer *code_buffer,
316 int vep_offset,
317 int trap_offset,
318 int frame_complete,
319 int frame_size);
320
321 int trap_offset() const { return _trap_offset; }
322 address trap_address() const { return insts_begin() + _trap_offset; }
323
324 #endif // def HAVE_DTRACE_H
325
326 // accessors
327 methodOop method() const { return _method; }
328 AbstractCompiler* compiler() const { return _compiler; }
329
330 // type info
331 bool is_nmethod() const { return true; }
332 bool is_java_method() const { return !method()->is_native(); }
333 bool is_native_method() const { return method()->is_native(); }
334 bool is_osr_method() const { return _entry_bci != InvocationEntryBci; }
335
336 bool is_compiled_by_c1() const;
337 bool is_compiled_by_c2() const;
338 bool is_compiled_by_shark() const;
339
340 // boundaries for different parts
341 address consts_begin () const { return header_begin() + _consts_offset ; }
342 address consts_end () const { return header_begin() + code_offset() ; }
343 address insts_begin () const { return header_begin() + code_offset() ; }
344 address insts_end () const { return header_begin() + _stub_offset ; }
345 address stub_begin () const { return header_begin() + _stub_offset ; }
346 address stub_end () const { return header_begin() + _oops_offset ; }
347 address exception_begin () const { return header_begin() + _exception_offset ; }
348 address deopt_handler_begin () const { return header_begin() + _deoptimize_offset ; }
349 address deopt_mh_handler_begin() const { return header_begin() + _deoptimize_mh_offset ; }
350 address unwind_handler_begin () const { return _unwind_handler_offset != -1 ? (header_begin() + _unwind_handler_offset) : NULL; }
351 oop* oops_begin () const { return (oop*) (header_begin() + _oops_offset) ; }
352 oop* oops_end () const { return (oop*) (header_begin() + _scopes_data_offset) ; }
353
354 address scopes_data_begin () const { return header_begin() + _scopes_data_offset ; }
355 address scopes_data_end () const { return header_begin() + _scopes_pcs_offset ; }
356 PcDesc* scopes_pcs_begin () const { return (PcDesc*)(header_begin() + _scopes_pcs_offset ); }
357 PcDesc* scopes_pcs_end () const { return (PcDesc*)(header_begin() + _dependencies_offset) ; }
358 address dependencies_begin () const { return header_begin() + _dependencies_offset ; }
359 address dependencies_end () const { return header_begin() + _handler_table_offset ; }
360 address handler_table_begin () const { return header_begin() + _handler_table_offset ; }
361 address handler_table_end () const { return header_begin() + _nul_chk_table_offset ; }
362 address nul_chk_table_begin () const { return header_begin() + _nul_chk_table_offset ; }
363 address nul_chk_table_end () const { return header_begin() + _nmethod_end_offset ; }
364
365 // Sizes
366 int consts_size () const { return consts_end () - consts_begin (); }
367 int insts_size () const { return insts_end () - insts_begin (); }
368 int stub_size () const { return stub_end () - stub_begin (); }
369 int oops_size () const { return (address) oops_end () - (address) oops_begin (); }
370 int scopes_data_size () const { return scopes_data_end () - scopes_data_begin (); }
371 int scopes_pcs_size () const { return (intptr_t) scopes_pcs_end () - (intptr_t) scopes_pcs_begin (); }
372 int dependencies_size () const { return dependencies_end () - dependencies_begin (); }
373 int handler_table_size() const { return handler_table_end() - handler_table_begin(); }
374 int nul_chk_table_size() const { return nul_chk_table_end() - nul_chk_table_begin(); }
375
376 int total_size () const;
377
378 // Containment
379 bool consts_contains (address addr) const { return consts_begin () <= addr && addr < consts_end (); }
380 bool insts_contains (address addr) const { return insts_begin () <= addr && addr < insts_end (); }
381 bool stub_contains (address addr) const { return stub_begin () <= addr && addr < stub_end (); }
382 bool oops_contains (oop* addr) const { return oops_begin () <= addr && addr < oops_end (); }
383 bool scopes_data_contains (address addr) const { return scopes_data_begin () <= addr && addr < scopes_data_end (); }
384 bool scopes_pcs_contains (PcDesc* addr) const { return scopes_pcs_begin () <= addr && addr < scopes_pcs_end (); }
385 bool handler_table_contains(address addr) const { return handler_table_begin() <= addr && addr < handler_table_end(); }
386 bool nul_chk_table_contains(address addr) const { return nul_chk_table_begin() <= addr && addr < nul_chk_table_end(); }
387
388 // entry points
389 address entry_point() const { return _entry_point; } // normal entry point
390 address verified_entry_point() const { return _verified_entry_point; } // if klass is correct
391
392 // flag accessing and manipulation
393 bool is_in_use() const { return _state == alive; }
394 bool is_alive() const { return _state == alive || _state == not_entrant; }
395 bool is_not_entrant() const { return _state == not_entrant; }
396 bool is_zombie() const { return _state == zombie; }
397 bool is_unloaded() const { return _state == unloaded; }
398
399 // Make the nmethod non entrant. The nmethod will continue to be
400 // alive. It is used when an uncommon trap happens. Returns true
401 // if this thread changed the state of the nmethod or false if
402 // another thread performed the transition.
403 bool make_not_entrant() { return make_not_entrant_or_zombie(not_entrant); }
404 bool make_zombie() { return make_not_entrant_or_zombie(zombie); }
405
406 // used by jvmti to track if the unload event has been reported
407 bool unload_reported() { return _unload_reported; }
408 void set_unload_reported() { _unload_reported = true; }
409
410 bool is_marked_for_deoptimization() const { return _marked_for_deoptimization; }
411 void mark_for_deoptimization() { _marked_for_deoptimization = true; }
412
413 void make_unloaded(BoolObjectClosure* is_alive, oop cause);
414
415 bool has_dependencies() { return dependencies_size() != 0; }
416 void flush_dependencies(BoolObjectClosure* is_alive);
417 bool has_flushed_dependencies() { return _has_flushed_dependencies; }
418 void set_has_flushed_dependencies() {
419 assert(!has_flushed_dependencies(), "should only happen once");
420 _has_flushed_dependencies = 1;
421 }
422
423 bool is_marked_for_reclamation() const { return _marked_for_reclamation; }
424 void mark_for_reclamation() { _marked_for_reclamation = 1; }
425
426 bool has_unsafe_access() const { return _has_unsafe_access; }
427 void set_has_unsafe_access(bool z) { _has_unsafe_access = z; }
428
429 bool has_method_handle_invokes() const { return _has_method_handle_invokes; }
430 void set_has_method_handle_invokes(bool z) { _has_method_handle_invokes = z; }
431
432 bool is_speculatively_disconnected() const { return _speculatively_disconnected; }
433 void set_speculatively_disconnected(bool z) { _speculatively_disconnected = z; }
434
435 int comp_level() const { return _comp_level; }
436
437 // Support for oops in scopes and relocs:
438 // Note: index 0 is reserved for null.
439 oop oop_at(int index) const { return index == 0 ? (oop) NULL: *oop_addr_at(index); }
440 oop* oop_addr_at(int index) const { // for GC
441 // relocation indexes are biased by 1 (because 0 is reserved)
442 assert(index > 0 && index <= oops_size(), "must be a valid non-zero index");
443 assert(!_oops_are_stale, "oops are stale");
444 return &oops_begin()[index - 1];
445 }
446
447 void copy_oops(GrowableArray<jobject>* oops);
448
449 // Relocation support
450 private:
451 void fix_oop_relocations(address begin, address end, bool initialize_immediates);
452 inline void initialize_immediate_oop(oop* dest, jobject handle);
453
454 public:
455 void fix_oop_relocations(address begin, address end) { fix_oop_relocations(begin, end, false); }
456 void fix_oop_relocations() { fix_oop_relocations(NULL, NULL, false); }
457 void verify_oop_relocations();
458
459 bool is_at_poll_return(address pc);
460 bool is_at_poll_or_poll_return(address pc);
461
462 // Scavengable oop support
463 bool on_scavenge_root_list() const { return (_scavenge_root_state & 1) != 0; }
464 protected:
465 enum { sl_on_list = 0x01, sl_marked = 0x10 };
466 void set_on_scavenge_root_list() { _scavenge_root_state = sl_on_list; }
467 void clear_on_scavenge_root_list() { _scavenge_root_state = 0; }
468 // assertion-checking and pruning logic uses the bits of _scavenge_root_state
469 #ifndef PRODUCT
470 void set_scavenge_root_marked() { _scavenge_root_state |= sl_marked; }
471 void clear_scavenge_root_marked() { _scavenge_root_state &= ~sl_marked; }
472 bool scavenge_root_not_marked() { return (_scavenge_root_state &~ sl_on_list) == 0; }
473 // N.B. there is no positive marked query, and we only use the not_marked query for asserts.
474 #endif //PRODUCT
475 nmethod* scavenge_root_link() const { return _scavenge_root_link; }
476 void set_scavenge_root_link(nmethod *n) { _scavenge_root_link = n; }
477
478 nmethod* saved_nmethod_link() const { return _saved_nmethod_link; }
479 void set_saved_nmethod_link(nmethod *n) { _saved_nmethod_link = n; }
480
481 public:
482
483 // Sweeper support
484 long stack_traversal_mark() { return _stack_traversal_mark; }
485 void set_stack_traversal_mark(long l) { _stack_traversal_mark = l; }
486
487 // Exception cache support
488 ExceptionCache* exception_cache() const { return _exception_cache; }
489 void set_exception_cache(ExceptionCache *ec) { _exception_cache = ec; }
490 address handler_for_exception_and_pc(Handle exception, address pc);
491 void add_handler_for_exception_and_pc(Handle exception, address pc, address handler);
492 void remove_from_exception_cache(ExceptionCache* ec);
493
494 // implicit exceptions support
495 address continuation_for_implicit_exception(address pc);
496
497 // On-stack replacement support
498 int osr_entry_bci() const { assert(is_osr_method(), "wrong kind of nmethod"); return _entry_bci; }
499 address osr_entry() const { assert(is_osr_method(), "wrong kind of nmethod"); return _osr_entry_point; }
500 void invalidate_osr_method();
501 nmethod* osr_link() const { return _osr_link; }
502 void set_osr_link(nmethod *n) { _osr_link = n; }
503
504 // tells whether frames described by this nmethod can be deoptimized
505 // note: native wrappers cannot be deoptimized.
506 bool can_be_deoptimized() const { return is_java_method(); }
507
508 // Inline cache support
509 void clear_inline_caches();
510 void cleanup_inline_caches();
511 bool inlinecache_check_contains(address addr) const {
512 return (addr >= code_begin() && addr < verified_entry_point());
513 }
514
515 // unlink and deallocate this nmethod
516 // Only NMethodSweeper class is expected to use this. NMethodSweeper is not
517 // expected to use any other private methods/data in this class.
518
519 protected:
520 void flush();
521
522 public:
523 // When true is returned, it is unsafe to remove this nmethod even if
524 // it is a zombie, since the VM or the ServiceThread might still be
525 // using it.
526 bool is_locked_by_vm() const { return _lock_count >0; }
527
528 // See comment at definition of _last_seen_on_stack
529 void mark_as_seen_on_stack();
530 bool can_not_entrant_be_converted();
531
532 // Evolution support. We make old (discarded) compiled methods point to new methodOops.
533 void set_method(methodOop method) { _method = method; }
534
535 // GC support
536 void do_unloading(BoolObjectClosure* is_alive, OopClosure* keep_alive,
537 bool unloading_occurred);
538 bool can_unload(BoolObjectClosure* is_alive, OopClosure* keep_alive,
539 oop* root, bool unloading_occurred);
540
541 void preserve_callee_argument_oops(frame fr, const RegisterMap *reg_map,
542 OopClosure* f);
543 void oops_do(OopClosure* f) { oops_do(f, false); }
544 void oops_do(OopClosure* f, bool do_strong_roots_only);
545 bool detect_scavenge_root_oops();
546 void verify_scavenge_root_oops() PRODUCT_RETURN;
547
548 bool test_set_oops_do_mark();
549 static void oops_do_marking_prologue();
550 static void oops_do_marking_epilogue();
551 static bool oops_do_marking_is_active() { return _oops_do_mark_nmethods != NULL; }
552 DEBUG_ONLY(bool test_oops_do_mark() { return _oops_do_mark_link != NULL; })
553
554 // ScopeDesc for an instruction
555 ScopeDesc* scope_desc_at(address pc);
556
557 private:
558 ScopeDesc* scope_desc_in(address begin, address end);
559
560 address* orig_pc_addr(const frame* fr) { return (address*) ((address)fr->unextended_sp() + _orig_pc_offset); }
561
562 PcDesc* find_pc_desc_internal(address pc, bool approximate);
563
564 PcDesc* find_pc_desc(address pc, bool approximate) {
565 PcDesc* desc = _pc_desc_cache.last_pc_desc();
566 if (desc != NULL && desc->pc_offset() == pc - code_begin()) {
567 return desc;
568 }
569 return find_pc_desc_internal(pc, approximate);
570 }
571
572 public:
573 // ScopeDesc retrieval operation
574 PcDesc* pc_desc_at(address pc) { return find_pc_desc(pc, false); }
575 // pc_desc_near returns the first PcDesc at or after the givne pc.
576 PcDesc* pc_desc_near(address pc) { return find_pc_desc(pc, true); }
577
578 public:
579 // copying of debugging information
580 void copy_scopes_pcs(PcDesc* pcs, int count);
581 void copy_scopes_data(address buffer, int size);
582
583 // Deopt
584 // Return true is the PC is one would expect if the frame is being deopted.
585 bool is_deopt_pc (address pc) { return is_deopt_entry(pc) || is_deopt_mh_entry(pc); }
586 bool is_deopt_entry (address pc) { return pc == deopt_handler_begin(); }
587 bool is_deopt_mh_entry(address pc) { return pc == deopt_mh_handler_begin(); }
588 // Accessor/mutator for the original pc of a frame before a frame was deopted.
589 address get_original_pc(const frame* fr) { return *orig_pc_addr(fr); }
590 void set_original_pc(const frame* fr, address pc) { *orig_pc_addr(fr) = pc; }
591
592 static address get_deopt_original_pc(const frame* fr);
593
594 // MethodHandle
595 bool is_method_handle_return(address return_pc);
596
597 // jvmti support:
598 void post_compiled_method_load_event();
599 jmethodID get_and_cache_jmethod_id();
600
601 // verify operations
602 void verify();
603 void verify_scopes();
604 void verify_interrupt_point(address interrupt_point);
605
606 // printing support
607 void print() const;
608 void print_code();
609 void print_relocations() PRODUCT_RETURN;
610 void print_pcs() PRODUCT_RETURN;
611 void print_scopes() PRODUCT_RETURN;
612 void print_dependencies() PRODUCT_RETURN;
613 void print_value_on(outputStream* st) const PRODUCT_RETURN;
614 void print_calls(outputStream* st) PRODUCT_RETURN;
615 void print_handler_table() PRODUCT_RETURN;
616 void print_nul_chk_table() PRODUCT_RETURN;
617 void print_nmethod(bool print_code);
618
619 // need to re-define this from CodeBlob else the overload hides it
620 virtual void print_on(outputStream* st) const { CodeBlob::print_on(st); }
621 void print_on(outputStream* st, const char* msg) const;
622
623 // Logging
624 void log_identity(xmlStream* log) const;
625 void log_new_nmethod() const;
626 void log_state_change() const;
627
628 // Prints block-level comments, including nmethod specific block labels:
629 virtual void print_block_comment(outputStream* stream, address block_begin) {
630 print_nmethod_labels(stream, block_begin);
631 CodeBlob::print_block_comment(stream, block_begin);
632 }
633 void print_nmethod_labels(outputStream* stream, address block_begin);
634
635 // Prints a comment for one native instruction (reloc info, pc desc)
636 void print_code_comment_on(outputStream* st, int column, address begin, address end);
637 static void print_statistics() PRODUCT_RETURN;
638
639 // Compiler task identification. Note that all OSR methods
640 // are numbered in an independent sequence if CICountOSR is true,
641 // and native method wrappers are also numbered independently if
642 // CICountNative is true.
643 int compile_id() const { return _compile_id; }
644 const char* compile_kind() const;
645
646 // For debugging
647 // CompiledIC* IC_at(char* p) const;
648 // PrimitiveIC* primitiveIC_at(char* p) const;
649 oop embeddedOop_at(address p);
650
651 // tells if any of this method's dependencies have been invalidated
652 // (this is expensive!)
653 bool check_all_dependencies();
654
655 // tells if this compiled method is dependent on the given changes,
656 // and the changes have invalidated it
657 bool check_dependency_on(DepChange& changes);
658
659 // Evolution support. Tells if this compiled method is dependent on any of
660 // methods m() of class dependee, such that if m() in dependee is replaced,
661 // this compiled method will have to be deoptimized.
662 bool is_evol_dependent_on(klassOop dependee);
663
664 // Fast breakpoint support. Tells if this compiled method is
665 // dependent on the given method. Returns true if this nmethod
666 // corresponds to the given method as well.
667 bool is_dependent_on_method(methodOop dependee);
668
669 // is it ok to patch at address?
670 bool is_patchable_at(address instr_address);
671
672 // UseBiasedLocking support
673 ByteSize native_receiver_sp_offset() {
674 return _native_receiver_sp_offset;
675 }
676 ByteSize native_basic_lock_sp_offset() {
677 return _native_basic_lock_sp_offset;
678 }
679
680 // support for code generation
681 static int verified_entry_point_offset() { return offset_of(nmethod, _verified_entry_point); }
682 static int osr_entry_point_offset() { return offset_of(nmethod, _osr_entry_point); }
683 static int entry_bci_offset() { return offset_of(nmethod, _entry_bci); }
684
685 };
686
687 // Locks an nmethod so its code will not get removed and it will not
688 // be made into a zombie, even if it is a not_entrant method. After the
689 // nmethod becomes a zombie, if CompiledMethodUnload event processing
690 // needs to be done, then lock_nmethod() is used directly to keep the
691 // generated code from being reused too early.
692 class nmethodLocker : public StackObj {
693 nmethod* _nm;
694
695 public:
696
697 // note: nm can be NULL
698 // Only JvmtiDeferredEvent::compiled_method_unload_event()
699 // should pass zombie_ok == true.
700 static void lock_nmethod(nmethod* nm, bool zombie_ok = false);
701 static void unlock_nmethod(nmethod* nm); // (ditto)
702
703 nmethodLocker(address pc); // derive nm from pc
704 nmethodLocker(nmethod *nm) { _nm = nm; lock_nmethod(_nm); }
705 nmethodLocker() { _nm = NULL; }
706 ~nmethodLocker() { unlock_nmethod(_nm); }
707
708 nmethod* code() { return _nm; }
709 void set_code(nmethod* new_nm) {
710 unlock_nmethod(_nm); // note: This works even if _nm==new_nm.
711 _nm = new_nm;
712 lock_nmethod(_nm);
713 }
714 };
715
716 #endif // SHARE_VM_CODE_NMETHOD_HPP