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* _last_pc_desc; // most recent pc_desc found
73 PcDesc* _pc_descs[cache_size]; // last cache_size pc_descs found
74 public:
75 PcDescCache() { debug_only(_last_pc_desc = NULL); }
76 void reset_to(PcDesc* initial_pc_desc);
77 PcDesc* find_pc_desc(int pc_offset, bool approximate);
78 void add_pc_desc(PcDesc* pc_desc);
79 PcDesc* last_pc_desc() { return _last_pc_desc; }
80 };
81
82
83 // nmethods (native methods) are the compiled code versions of Java methods.
84 //
85 // An nmethod contains:
86 // - header (the nmethod structure)
87 // [Relocation]
88 // - relocation information
89 // - constant part (doubles, longs and floats used in nmethod)
90 // - oop table
91 // [Code]
92 // - code body
93 // - exception handler
94 // - stub code
95 // [Debugging information]
96 // - oop array
97 // - data array
98 // - pcs
99 // [Exception handler table]
100 // - handler entry point array
101 // [Implicit Null Pointer exception table]
102 // - implicit null table array
103
104 class Dependencies;
105 class ExceptionHandlerTable;
106 class ImplicitExceptionTable;
107 class AbstractCompiler;
108 class xmlStream;
109
110 class nmethod : public CodeBlob {
111 friend class VMStructs;
112 friend class NMethodSweeper;
113 friend class CodeCache; // non-perm oops
114 private:
115 // Shared fields for all nmethod's
116 methodOop _method;
117 int _entry_bci; // != InvocationEntryBci if this nmethod is an on-stack replacement method
118 jmethodID _jmethod_id; // Cache of method()->jmethod_id()
119
120 // To support simple linked-list chaining of nmethods:
121 nmethod* _osr_link; // from instanceKlass::osr_nmethods_head
122 nmethod* _scavenge_root_link; // from CodeCache::scavenge_root_nmethods
123 nmethod* _saved_nmethod_link; // from CodeCache::speculatively_disconnect
124
125 static nmethod* volatile _oops_do_mark_nmethods;
126 nmethod* volatile _oops_do_mark_link;
127
128 AbstractCompiler* _compiler; // The compiler which compiled this nmethod
129
130 // offsets for entry points
131 address _entry_point; // entry point with class check
132 address _verified_entry_point; // entry point without class check
133 address _osr_entry_point; // entry point for on stack replacement
134
135 // Offsets for different nmethod parts
136 int _exception_offset;
137 // All deoptee's will resume execution at this location described by
138 // this offset.
139 int _deoptimize_offset;
140 // All deoptee's at a MethodHandle call site will resume execution
141 // at this location described by this offset.
142 int _deoptimize_mh_offset;
143 // Offset of the unwind handler if it exists
144 int _unwind_handler_offset;
145
146 #ifdef HAVE_DTRACE_H
147 int _trap_offset;
148 #endif // def HAVE_DTRACE_H
149 int _consts_offset;
150 int _stub_offset;
151 int _oops_offset; // offset to where embedded oop table begins (inside data)
152 int _scopes_data_offset;
153 int _scopes_pcs_offset;
154 int _dependencies_offset;
155 int _handler_table_offset;
156 int _nul_chk_table_offset;
157 int _nmethod_end_offset;
158
159 // location in frame (offset for sp) that deopt can store the original
160 // pc during a deopt.
161 int _orig_pc_offset;
162
163 int _compile_id; // which compilation made this nmethod
164 int _comp_level; // compilation level
165
166 // protected by CodeCache_lock
167 bool _has_flushed_dependencies; // Used for maintenance of dependencies (CodeCache_lock)
168 bool _speculatively_disconnected; // Marked for potential unload
169
170 bool _marked_for_reclamation; // Used by NMethodSweeper (set only by sweeper)
171 bool _marked_for_deoptimization; // Used for stack deoptimization
172
173 // used by jvmti to track if an unload event has been posted for this nmethod.
174 bool _unload_reported;
175
176 // set during construction
177 unsigned int _has_unsafe_access:1; // May fault due to unsafe access.
178 unsigned int _has_method_handle_invokes:1; // Has this method MethodHandle invokes?
179
180 // Protected by Patching_lock
181 unsigned char _state; // {alive, not_entrant, zombie, unloaded)
182
183 #ifdef ASSERT
184 bool _oops_are_stale; // indicates that it's no longer safe to access oops section
185 #endif
186
187 enum { alive = 0,
188 not_entrant = 1, // uncommon trap has happened but activations may still exist
189 zombie = 2,
190 unloaded = 3 };
191
192
193 jbyte _scavenge_root_state;
194
195 NOT_PRODUCT(bool _has_debug_info; )
196
197 // Nmethod Flushing lock (if non-zero, then the nmethod is not removed)
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 CodeOffsets* offsets,
231 CodeBuffer *code_buffer,
232 int frame_size,
233 ByteSize basic_lock_owner_sp_offset, /* synchronized natives only */
234 ByteSize basic_lock_sp_offset, /* synchronized natives only */
235 OopMapSet* oop_maps);
236
237 #ifdef HAVE_DTRACE_H
238 // For native wrappers
239 nmethod(methodOop method,
240 int nmethod_size,
241 CodeOffsets* offsets,
242 CodeBuffer *code_buffer,
243 int frame_size);
244 #endif // def HAVE_DTRACE_H
245
246 // Creation support
247 nmethod(methodOop method,
248 int nmethod_size,
249 int compile_id,
250 int entry_bci,
251 CodeOffsets* offsets,
252 int orig_pc_offset,
253 DebugInformationRecorder *recorder,
254 Dependencies* dependencies,
255 CodeBuffer *code_buffer,
256 int frame_size,
257 OopMapSet* oop_maps,
258 ExceptionHandlerTable* handler_table,
259 ImplicitExceptionTable* nul_chk_table,
260 AbstractCompiler* compiler,
261 int comp_level);
262
263 // helper methods
264 void* operator new(size_t size, int nmethod_size);
265
266 const char* reloc_string_for(u_char* begin, u_char* end);
267 // Returns true if this thread changed the state of the nmethod or
268 // false if another thread performed the transition.
269 bool make_not_entrant_or_zombie(unsigned int state);
270 void inc_decompile_count();
271
272 // Used to manipulate the exception cache
273 void add_exception_cache_entry(ExceptionCache* new_entry);
274 ExceptionCache* exception_cache_entry_for_exception(Handle exception);
275
276 // Inform external interfaces that a compiled method has been unloaded
277 void post_compiled_method_unload();
278
279 // Initailize fields to their default values
280 void init_defaults();
281
282 public:
283 // create nmethod with entry_bci
284 static nmethod* new_nmethod(methodHandle method,
285 int compile_id,
286 int entry_bci,
287 CodeOffsets* offsets,
288 int orig_pc_offset,
289 DebugInformationRecorder* recorder,
290 Dependencies* dependencies,
291 CodeBuffer *code_buffer,
292 int frame_size,
293 OopMapSet* oop_maps,
294 ExceptionHandlerTable* handler_table,
295 ImplicitExceptionTable* nul_chk_table,
296 AbstractCompiler* compiler,
297 int comp_level);
298
299 static nmethod* new_native_nmethod(methodHandle method,
300 CodeBuffer *code_buffer,
301 int vep_offset,
302 int frame_complete,
303 int frame_size,
304 ByteSize receiver_sp_offset,
305 ByteSize basic_lock_sp_offset,
306 OopMapSet* oop_maps);
307
308 #ifdef HAVE_DTRACE_H
309 // The method we generate for a dtrace probe has to look
310 // like an nmethod as far as the rest of the system is concerned
311 // which is somewhat unfortunate.
312 static nmethod* new_dtrace_nmethod(methodHandle method,
313 CodeBuffer *code_buffer,
314 int vep_offset,
315 int trap_offset,
316 int frame_complete,
317 int frame_size);
318
319 int trap_offset() const { return _trap_offset; }
320 address trap_address() const { return insts_begin() + _trap_offset; }
321
322 #endif // def HAVE_DTRACE_H
323
324 // accessors
325 methodOop method() const { return _method; }
326 AbstractCompiler* compiler() const { return _compiler; }
327
328 #ifndef PRODUCT
329 bool has_debug_info() const { return _has_debug_info; }
330 void set_has_debug_info(bool f) { _has_debug_info = false; }
331 #endif // NOT PRODUCT
332
333 // type info
334 bool is_nmethod() const { return true; }
335 bool is_java_method() const { return !method()->is_native(); }
336 bool is_native_method() const { return method()->is_native(); }
337 bool is_osr_method() const { return _entry_bci != InvocationEntryBci; }
338
339 bool is_compiled_by_c1() const;
340 bool is_compiled_by_c2() const;
341 bool is_compiled_by_shark() const;
342
343 // boundaries for different parts
344 address consts_begin () const { return header_begin() + _consts_offset ; }
345 address consts_end () const { return header_begin() + code_offset() ; }
346 address insts_begin () const { return header_begin() + code_offset() ; }
347 address insts_end () const { return header_begin() + _stub_offset ; }
348 address stub_begin () const { return header_begin() + _stub_offset ; }
349 address stub_end () const { return header_begin() + _oops_offset ; }
350 address exception_begin () const { return header_begin() + _exception_offset ; }
351 address deopt_handler_begin () const { return header_begin() + _deoptimize_offset ; }
352 address deopt_mh_handler_begin() const { return header_begin() + _deoptimize_mh_offset ; }
353 address unwind_handler_begin () const { return _unwind_handler_offset != -1 ? (header_begin() + _unwind_handler_offset) : NULL; }
354 oop* oops_begin () const { return (oop*) (header_begin() + _oops_offset) ; }
355 oop* oops_end () const { return (oop*) (header_begin() + _scopes_data_offset) ; }
356
357 address scopes_data_begin () const { return header_begin() + _scopes_data_offset ; }
358 address scopes_data_end () const { return header_begin() + _scopes_pcs_offset ; }
359 PcDesc* scopes_pcs_begin () const { return (PcDesc*)(header_begin() + _scopes_pcs_offset ); }
360 PcDesc* scopes_pcs_end () const { return (PcDesc*)(header_begin() + _dependencies_offset) ; }
361 address dependencies_begin () const { return header_begin() + _dependencies_offset ; }
362 address dependencies_end () const { return header_begin() + _handler_table_offset ; }
363 address handler_table_begin () const { return header_begin() + _handler_table_offset ; }
364 address handler_table_end () const { return header_begin() + _nul_chk_table_offset ; }
365 address nul_chk_table_begin () const { return header_begin() + _nul_chk_table_offset ; }
366 address nul_chk_table_end () const { return header_begin() + _nmethod_end_offset ; }
367
368 // Sizes
369 int consts_size () const { return consts_end () - consts_begin (); }
370 int insts_size () const { return insts_end () - insts_begin (); }
371 int stub_size () const { return stub_end () - stub_begin (); }
372 int oops_size () const { return (address) oops_end () - (address) oops_begin (); }
373 int scopes_data_size () const { return scopes_data_end () - scopes_data_begin (); }
374 int scopes_pcs_size () const { return (intptr_t) scopes_pcs_end () - (intptr_t) scopes_pcs_begin (); }
375 int dependencies_size () const { return dependencies_end () - dependencies_begin (); }
376 int handler_table_size() const { return handler_table_end() - handler_table_begin(); }
377 int nul_chk_table_size() const { return nul_chk_table_end() - nul_chk_table_begin(); }
378
379 int total_size () const;
380
381 // Containment
382 bool consts_contains (address addr) const { return consts_begin () <= addr && addr < consts_end (); }
383 bool insts_contains (address addr) const { return insts_begin () <= addr && addr < insts_end (); }
384 bool stub_contains (address addr) const { return stub_begin () <= addr && addr < stub_end (); }
385 bool oops_contains (oop* addr) const { return oops_begin () <= addr && addr < oops_end (); }
386 bool scopes_data_contains (address addr) const { return scopes_data_begin () <= addr && addr < scopes_data_end (); }
387 bool scopes_pcs_contains (PcDesc* addr) const { return scopes_pcs_begin () <= addr && addr < scopes_pcs_end (); }
388 bool handler_table_contains(address addr) const { return handler_table_begin() <= addr && addr < handler_table_end(); }
389 bool nul_chk_table_contains(address addr) const { return nul_chk_table_begin() <= addr && addr < nul_chk_table_end(); }
390
391 // entry points
392 address entry_point() const { return _entry_point; } // normal entry point
393 address verified_entry_point() const { return _verified_entry_point; } // if klass is correct
394
395 // flag accessing and manipulation
396 bool is_in_use() const { return _state == alive; }
397 bool is_alive() const { return _state == alive || _state == not_entrant; }
398 bool is_not_entrant() const { return _state == not_entrant; }
399 bool is_zombie() const { return _state == zombie; }
400 bool is_unloaded() const { return _state == unloaded; }
401
402 // Make the nmethod non entrant. The nmethod will continue to be
403 // alive. It is used when an uncommon trap happens. Returns true
404 // if this thread changed the state of the nmethod or false if
405 // another thread performed the transition.
406 bool make_not_entrant() { return make_not_entrant_or_zombie(not_entrant); }
407 bool make_zombie() { return make_not_entrant_or_zombie(zombie); }
408
409 // used by jvmti to track if the unload event has been reported
410 bool unload_reported() { return _unload_reported; }
411 void set_unload_reported() { _unload_reported = true; }
412
413 bool is_marked_for_deoptimization() const { return _marked_for_deoptimization; }
414 void mark_for_deoptimization() { _marked_for_deoptimization = true; }
415
416 void make_unloaded(BoolObjectClosure* is_alive, oop cause);
417
418 bool has_dependencies() { return dependencies_size() != 0; }
419 void flush_dependencies(BoolObjectClosure* is_alive);
420 bool has_flushed_dependencies() { return _has_flushed_dependencies; }
421 void set_has_flushed_dependencies() {
422 assert(!has_flushed_dependencies(), "should only happen once");
423 _has_flushed_dependencies = 1;
424 }
425
426 bool is_marked_for_reclamation() const { return _marked_for_reclamation; }
427 void mark_for_reclamation() { _marked_for_reclamation = 1; }
428
429 bool has_unsafe_access() const { return _has_unsafe_access; }
430 void set_has_unsafe_access(bool z) { _has_unsafe_access = z; }
431
432 bool has_method_handle_invokes() const { return _has_method_handle_invokes; }
433 void set_has_method_handle_invokes(bool z) { _has_method_handle_invokes = z; }
434
435 bool is_speculatively_disconnected() const { return _speculatively_disconnected; }
436 void set_speculatively_disconnected(bool z) { _speculatively_disconnected = z; }
437
438 int comp_level() const { return _comp_level; }
439
440 // Support for oops in scopes and relocs:
441 // Note: index 0 is reserved for null.
442 oop oop_at(int index) const { return index == 0 ? (oop) NULL: *oop_addr_at(index); }
443 oop* oop_addr_at(int index) const { // for GC
444 // relocation indexes are biased by 1 (because 0 is reserved)
445 assert(index > 0 && index <= oops_size(), "must be a valid non-zero index");
446 assert(!_oops_are_stale, "oops are stale");
447 return &oops_begin()[index - 1];
448 }
449
450 void copy_oops(GrowableArray<jobject>* oops);
451
452 // Relocation support
453 private:
454 void fix_oop_relocations(address begin, address end, bool initialize_immediates);
455 inline void initialize_immediate_oop(oop* dest, jobject handle);
456
457 public:
458 void fix_oop_relocations(address begin, address end) { fix_oop_relocations(begin, end, false); }
459 void fix_oop_relocations() { fix_oop_relocations(NULL, NULL, false); }
460 void verify_oop_relocations();
461
462 bool is_at_poll_return(address pc);
463 bool is_at_poll_or_poll_return(address pc);
464
465 // Non-perm oop support
466 bool on_scavenge_root_list() const { return (_scavenge_root_state & 1) != 0; }
467 protected:
468 enum { npl_on_list = 0x01, npl_marked = 0x10 };
469 void set_on_scavenge_root_list() { _scavenge_root_state = npl_on_list; }
470 void clear_on_scavenge_root_list() { _scavenge_root_state = 0; }
471 // assertion-checking and pruning logic uses the bits of _scavenge_root_state
472 #ifndef PRODUCT
473 void set_scavenge_root_marked() { _scavenge_root_state |= npl_marked; }
474 void clear_scavenge_root_marked() { _scavenge_root_state &= ~npl_marked; }
475 bool scavenge_root_not_marked() { return (_scavenge_root_state &~ npl_on_list) == 0; }
476 // N.B. there is no positive marked query, and we only use the not_marked query for asserts.
477 #endif //PRODUCT
478 nmethod* scavenge_root_link() const { return _scavenge_root_link; }
479 void set_scavenge_root_link(nmethod *n) { _scavenge_root_link = n; }
480
481 nmethod* saved_nmethod_link() const { return _saved_nmethod_link; }
482 void set_saved_nmethod_link(nmethod *n) { _saved_nmethod_link = n; }
483
484 public:
485
486 // Sweeper support
487 long stack_traversal_mark() { return _stack_traversal_mark; }
488 void set_stack_traversal_mark(long l) { _stack_traversal_mark = l; }
489
490 // Exception cache support
491 ExceptionCache* exception_cache() const { return _exception_cache; }
492 void set_exception_cache(ExceptionCache *ec) { _exception_cache = ec; }
493 address handler_for_exception_and_pc(Handle exception, address pc);
494 void add_handler_for_exception_and_pc(Handle exception, address pc, address handler);
495 void remove_from_exception_cache(ExceptionCache* ec);
496
497 // implicit exceptions support
498 address continuation_for_implicit_exception(address pc);
499
500 // On-stack replacement support
501 int osr_entry_bci() const { assert(_entry_bci != InvocationEntryBci, "wrong kind of nmethod"); return _entry_bci; }
502 address osr_entry() const { assert(_entry_bci != InvocationEntryBci, "wrong kind of nmethod"); return _osr_entry_point; }
503 void invalidate_osr_method();
504 nmethod* osr_link() const { return _osr_link; }
505 void set_osr_link(nmethod *n) { _osr_link = n; }
506
507 // tells whether frames described by this nmethod can be deoptimized
508 // note: native wrappers cannot be deoptimized.
509 bool can_be_deoptimized() const { return is_java_method(); }
510
511 // Inline cache support
512 void clear_inline_caches();
513 void cleanup_inline_caches();
514 bool inlinecache_check_contains(address addr) const {
515 return (addr >= code_begin() && addr < verified_entry_point());
516 }
517
518 // unlink and deallocate this nmethod
519 // Only NMethodSweeper class is expected to use this. NMethodSweeper is not
520 // expected to use any other private methods/data in this class.
521
522 protected:
523 void flush();
524
525 public:
526 // If returning true, it is unsafe to remove this nmethod even though it is a zombie
527 // nmethod, since the VM might have a reference to it. Should only be called from a safepoint.
528 bool is_locked_by_vm() const { return _lock_count >0; }
529
530 // See comment at definition of _last_seen_on_stack
531 void mark_as_seen_on_stack();
532 bool can_not_entrant_be_converted();
533
534 // Evolution support. We make old (discarded) compiled methods point to new methodOops.
535 void set_method(methodOop method) { _method = method; }
536
537 // GC support
538 void do_unloading(BoolObjectClosure* is_alive, OopClosure* keep_alive,
539 bool unloading_occurred);
540 bool can_unload(BoolObjectClosure* is_alive, OopClosure* keep_alive,
541 oop* root, bool unloading_occurred);
542
543 void preserve_callee_argument_oops(frame fr, const RegisterMap *reg_map,
544 OopClosure* f);
545 void oops_do(OopClosure* f) { oops_do(f, false); }
546 void oops_do(OopClosure* f, bool do_strong_roots_only);
547 bool detect_scavenge_root_oops();
548 void verify_scavenge_root_oops() PRODUCT_RETURN;
549
550 bool test_set_oops_do_mark();
551 static void oops_do_marking_prologue();
552 static void oops_do_marking_epilogue();
553 static bool oops_do_marking_is_active() { return _oops_do_mark_nmethods != NULL; }
554 DEBUG_ONLY(bool test_oops_do_mark() { return _oops_do_mark_link != NULL; })
555
556 // ScopeDesc for an instruction
557 ScopeDesc* scope_desc_at(address pc);
558
559 private:
560 ScopeDesc* scope_desc_in(address begin, address end);
561
562 address* orig_pc_addr(const frame* fr) { return (address*) ((address)fr->unextended_sp() + _orig_pc_offset); }
563
564 PcDesc* find_pc_desc_internal(address pc, bool approximate);
565
566 PcDesc* find_pc_desc(address pc, bool approximate) {
567 PcDesc* desc = _pc_desc_cache.last_pc_desc();
568 if (desc != NULL && desc->pc_offset() == pc - code_begin()) {
569 return desc;
570 }
571 return find_pc_desc_internal(pc, approximate);
572 }
573
574 public:
575 // ScopeDesc retrieval operation
576 PcDesc* pc_desc_at(address pc) { return find_pc_desc(pc, false); }
577 // pc_desc_near returns the first PcDesc at or after the givne pc.
578 PcDesc* pc_desc_near(address pc) { return find_pc_desc(pc, true); }
579
580 public:
581 // copying of debugging information
582 void copy_scopes_pcs(PcDesc* pcs, int count);
583 void copy_scopes_data(address buffer, int size);
584
585 // Deopt
586 // Return true is the PC is one would expect if the frame is being deopted.
587 bool is_deopt_pc (address pc) { return is_deopt_entry(pc) || is_deopt_mh_entry(pc); }
588 bool is_deopt_entry (address pc) { return pc == deopt_handler_begin(); }
589 bool is_deopt_mh_entry(address pc) { return pc == deopt_mh_handler_begin(); }
590 // Accessor/mutator for the original pc of a frame before a frame was deopted.
591 address get_original_pc(const frame* fr) { return *orig_pc_addr(fr); }
592 void set_original_pc(const frame* fr, address pc) { *orig_pc_addr(fr) = pc; }
593
594 static address get_deopt_original_pc(const frame* fr);
595
596 // MethodHandle
597 bool is_method_handle_return(address return_pc);
598
599 // jvmti support:
600 void post_compiled_method_load_event();
601 jmethodID get_and_cache_jmethod_id();
602
603 // verify operations
604 void verify();
605 void verify_scopes();
606 void verify_interrupt_point(address interrupt_point);
607
608 // print compilation helper
609 static void print_compilation(outputStream *st, const char *method_name, const char *title,
610 methodOop method, bool is_blocking, int compile_id, int bci, int comp_level);
611
612 // printing support
613 void print() const;
614 void print_code();
615 void print_relocations() PRODUCT_RETURN;
616 void print_pcs() PRODUCT_RETURN;
617 void print_scopes() PRODUCT_RETURN;
618 void print_dependencies() PRODUCT_RETURN;
619 void print_value_on(outputStream* st) const PRODUCT_RETURN;
620 void print_calls(outputStream* st) PRODUCT_RETURN;
621 void print_handler_table() PRODUCT_RETURN;
622 void print_nul_chk_table() PRODUCT_RETURN;
623 void print_nmethod(bool print_code);
624
625 // need to re-define this from CodeBlob else the overload hides it
626 virtual void print_on(outputStream* st) const { CodeBlob::print_on(st); }
627 void print_on(outputStream* st, const char* title) const;
628
629 // Logging
630 void log_identity(xmlStream* log) const;
631 void log_new_nmethod() const;
632 void log_state_change() const;
633
634 // Prints block-level comments, including nmethod specific block labels:
635 virtual void print_block_comment(outputStream* stream, address block_begin) {
636 print_nmethod_labels(stream, block_begin);
637 CodeBlob::print_block_comment(stream, block_begin);
638 }
639 void print_nmethod_labels(outputStream* stream, address block_begin);
640
641 // Prints a comment for one native instruction (reloc info, pc desc)
642 void print_code_comment_on(outputStream* st, int column, address begin, address end);
643 static void print_statistics() PRODUCT_RETURN;
644
645 // Compiler task identification. Note that all OSR methods
646 // are numbered in an independent sequence if CICountOSR is true,
647 // and native method wrappers are also numbered independently if
648 // CICountNative is true.
649 int compile_id() const { return _compile_id; }
650 const char* compile_kind() const;
651
652 // For debugging
653 // CompiledIC* IC_at(char* p) const;
654 // PrimitiveIC* primitiveIC_at(char* p) const;
655 oop embeddedOop_at(address p);
656
657 // tells if any of this method's dependencies have been invalidated
658 // (this is expensive!)
659 bool check_all_dependencies();
660
661 // tells if this compiled method is dependent on the given changes,
662 // and the changes have invalidated it
663 bool check_dependency_on(DepChange& changes);
664
665 // Evolution support. Tells if this compiled method is dependent on any of
666 // methods m() of class dependee, such that if m() in dependee is replaced,
667 // this compiled method will have to be deoptimized.
668 bool is_evol_dependent_on(klassOop dependee);
669
670 // Fast breakpoint support. Tells if this compiled method is
671 // dependent on the given method. Returns true if this nmethod
672 // corresponds to the given method as well.
673 bool is_dependent_on_method(methodOop dependee);
674
675 // is it ok to patch at address?
676 bool is_patchable_at(address instr_address);
677
678 // UseBiasedLocking support
679 ByteSize native_receiver_sp_offset() {
680 return _native_receiver_sp_offset;
681 }
682 ByteSize native_basic_lock_sp_offset() {
683 return _native_basic_lock_sp_offset;
684 }
685
686 // support for code generation
687 static int verified_entry_point_offset() { return offset_of(nmethod, _verified_entry_point); }
688 static int osr_entry_point_offset() { return offset_of(nmethod, _osr_entry_point); }
689 static int entry_bci_offset() { return offset_of(nmethod, _entry_bci); }
690
691 };
692
693 // Locks an nmethod so its code will not get removed, even if it is a zombie/not_entrant method
694 class nmethodLocker : public StackObj {
695 nmethod* _nm;
696
697 public:
698
699 static void lock_nmethod(nmethod* nm); // note: nm can be NULL
700 static void unlock_nmethod(nmethod* nm); // (ditto)
701
702 nmethodLocker(address pc); // derive nm from pc
703 nmethodLocker(nmethod *nm) { _nm = nm; lock_nmethod(_nm); }
704 nmethodLocker() { _nm = NULL; }
705 ~nmethodLocker() { unlock_nmethod(_nm); }
706
707 nmethod* code() { return _nm; }
708 void set_code(nmethod* new_nm) {
709 unlock_nmethod(_nm); // note: This works even if _nm==new_nm.
710 _nm = new_nm;
711 lock_nmethod(_nm);
712 }
713 };
714
715 #endif // SHARE_VM_CODE_NMETHOD_HPP