Fri, 16 Nov 2012 09:19:12 -0500
Merge
1 /*
2 * Copyright (c) 1997, 2012, 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_OOPS_METHODOOP_HPP
26 #define SHARE_VM_OOPS_METHODOOP_HPP
28 #include "classfile/vmSymbols.hpp"
29 #include "code/compressedStream.hpp"
30 #include "compiler/oopMap.hpp"
31 #include "interpreter/invocationCounter.hpp"
32 #include "oops/annotations.hpp"
33 #include "oops/constantPool.hpp"
34 #include "oops/instanceKlass.hpp"
35 #include "oops/oop.hpp"
36 #include "oops/typeArrayOop.hpp"
37 #include "utilities/accessFlags.hpp"
38 #include "utilities/growableArray.hpp"
40 // A Method* represents a Java method.
41 //
42 // Memory layout (each line represents a word). Note that most applications load thousands of methods,
43 // so keeping the size of this structure small has a big impact on footprint.
44 //
45 // We put all oops and method_size first for better gc cache locality.
46 //
47 // The actual bytecodes are inlined after the end of the Method struct.
48 //
49 // There are bits in the access_flags telling whether inlined tables are present.
50 // Note that accessing the line number and local variable tables is not performance critical at all.
51 // Accessing the checked exceptions table is used by reflection, so we put that last to make access
52 // to it fast.
53 //
54 // The line number table is compressed and inlined following the byte codes. It is found as the first
55 // byte following the byte codes. The checked exceptions table and the local variable table are inlined
56 // after the line number table, and indexed from the end of the method. We do not compress the checked
57 // exceptions table since the average length is less than 2, and do not bother to compress the local
58 // variable table either since it is mostly absent.
59 //
60 // Note that native_function and signature_handler has to be at fixed offsets (required by the interpreter)
61 //
62 // |------------------------------------------------------|
63 // | header |
64 // | klass |
65 // |------------------------------------------------------|
66 // | ConstMethod* (oop) |
67 // |------------------------------------------------------|
68 // | methodData (oop) |
69 // | interp_invocation_count |
70 // |------------------------------------------------------|
71 // | access_flags |
72 // | vtable_index |
73 // |------------------------------------------------------|
74 // | result_index (C++ interpreter only) |
75 // |------------------------------------------------------|
76 // | method_size | max_stack |
77 // | max_locals | size_of_parameters |
78 // |------------------------------------------------------|
79 // |intrinsic_id| flags | throwout_count |
80 // |------------------------------------------------------|
81 // | num_breakpoints | (unused) |
82 // |------------------------------------------------------|
83 // | invocation_counter |
84 // | backedge_counter |
85 // |------------------------------------------------------|
86 // | prev_time (tiered only, 64 bit wide) |
87 // | |
88 // |------------------------------------------------------|
89 // | rate (tiered) |
90 // |------------------------------------------------------|
91 // | code (pointer) |
92 // | i2i (pointer) |
93 // | adapter (pointer) |
94 // | from_compiled_entry (pointer) |
95 // | from_interpreted_entry (pointer) |
96 // |------------------------------------------------------|
97 // | native_function (present only if native) |
98 // | signature_handler (present only if native) |
99 // |------------------------------------------------------|
102 class CheckedExceptionElement;
103 class LocalVariableTableElement;
104 class AdapterHandlerEntry;
105 class MethodData;
106 class ConstMethod;
108 class Method : public Metadata {
109 friend class VMStructs;
110 private:
111 ConstMethod* _constMethod; // Method read-only data.
112 MethodData* _method_data;
113 int _interpreter_invocation_count; // Count of times invoked (reused as prev_event_count in tiered)
114 AccessFlags _access_flags; // Access flags
115 int _vtable_index; // vtable index of this method (see VtableIndexFlag)
116 // note: can have vtables with >2**16 elements (because of inheritance)
117 #ifdef CC_INTERP
118 int _result_index; // C++ interpreter needs for converting results to/from stack
119 #endif
120 u2 _method_size; // size of this object
121 u2 _max_stack; // Maximum number of entries on the expression stack
122 u2 _max_locals; // Number of local variables used by this method
123 u2 _size_of_parameters; // size of the parameter block (receiver + arguments) in words
124 u1 _intrinsic_id; // vmSymbols::intrinsic_id (0 == _none)
125 u1 _jfr_towrite : 1, // Flags
126 _force_inline : 1,
127 _hidden : 1,
128 _dont_inline : 1,
129 : 4;
130 u2 _interpreter_throwout_count; // Count of times method was exited via exception while interpreting
131 u2 _number_of_breakpoints; // fullspeed debugging support
132 InvocationCounter _invocation_counter; // Incremented before each activation of the method - used to trigger frequency-based optimizations
133 InvocationCounter _backedge_counter; // Incremented before each backedge taken - used to trigger frequencey-based optimizations
135 #ifdef TIERED
136 jlong _prev_time; // Previous time the rate was acquired
137 float _rate; // Events (invocation and backedge counter increments) per millisecond
138 #endif
140 #ifndef PRODUCT
141 int _compiled_invocation_count; // Number of nmethod invocations so far (for perf. debugging)
142 #endif
143 // Entry point for calling both from and to the interpreter.
144 address _i2i_entry; // All-args-on-stack calling convention
145 // Adapter blob (i2c/c2i) for this Method*. Set once when method is linked.
146 AdapterHandlerEntry* _adapter;
147 // Entry point for calling from compiled code, to compiled code if it exists
148 // or else the interpreter.
149 volatile address _from_compiled_entry; // Cache of: _code ? _code->entry_point() : _adapter->c2i_entry()
150 // The entry point for calling both from and to compiled code is
151 // "_code->entry_point()". Because of tiered compilation and de-opt, this
152 // field can come and go. It can transition from NULL to not-null at any
153 // time (whenever a compile completes). It can transition from not-null to
154 // NULL only at safepoints (because of a de-opt).
155 nmethod* volatile _code; // Points to the corresponding piece of native code
156 volatile address _from_interpreted_entry; // Cache of _code ? _adapter->i2c_entry() : _i2i_entry
158 // Constructor
159 Method(ConstMethod* xconst, AccessFlags access_flags, int size);
160 public:
162 static Method* allocate(ClassLoaderData* loader_data,
163 int byte_code_size,
164 AccessFlags access_flags,
165 int compressed_line_number_size,
166 int localvariable_table_length,
167 int exception_table_length,
168 int checked_exceptions_length,
169 ConstMethod::MethodType method_type,
170 TRAPS);
172 Method() { assert(DumpSharedSpaces || UseSharedSpaces, "only for CDS"); }
174 // The Method vtable is restored by this call when the Method is in the
175 // shared archive. See patch_klass_vtables() in metaspaceShared.cpp for
176 // all the gory details. SA, dtrace and pstack helpers distinguish metadata
177 // by their vtable.
178 void restore_vtable() { guarantee(is_method(), "vtable restored by this call"); }
179 bool is_method() const volatile { return true; }
181 // accessors for instance variables
183 ConstMethod* constMethod() const { return _constMethod; }
184 void set_constMethod(ConstMethod* xconst) { _constMethod = xconst; }
187 static address make_adapters(methodHandle mh, TRAPS);
188 volatile address from_compiled_entry() const { return (address)OrderAccess::load_ptr_acquire(&_from_compiled_entry); }
189 volatile address from_interpreted_entry() const{ return (address)OrderAccess::load_ptr_acquire(&_from_interpreted_entry); }
191 // access flag
192 AccessFlags access_flags() const { return _access_flags; }
193 void set_access_flags(AccessFlags flags) { _access_flags = flags; }
195 // name
196 Symbol* name() const { return constants()->symbol_at(name_index()); }
197 int name_index() const { return constMethod()->name_index(); }
198 void set_name_index(int index) { constMethod()->set_name_index(index); }
200 // signature
201 Symbol* signature() const { return constants()->symbol_at(signature_index()); }
202 int signature_index() const { return constMethod()->signature_index(); }
203 void set_signature_index(int index) { constMethod()->set_signature_index(index); }
205 // generics support
206 Symbol* generic_signature() const { int idx = generic_signature_index(); return ((idx != 0) ? constants()->symbol_at(idx) : (Symbol*)NULL); }
207 int generic_signature_index() const { return constMethod()->generic_signature_index(); }
208 void set_generic_signature_index(int index) { constMethod()->set_generic_signature_index(index); }
210 // annotations support
211 AnnotationArray* annotations() const {
212 InstanceKlass* ik = method_holder();
213 if (ik->annotations() == NULL) {
214 return NULL;
215 }
216 return ik->annotations()->get_method_annotations_of(method_idnum());
217 }
218 AnnotationArray* parameter_annotations() const {
219 InstanceKlass* ik = method_holder();
220 if (ik->annotations() == NULL) {
221 return NULL;
222 }
223 return ik->annotations()->get_method_parameter_annotations_of(method_idnum());
224 }
225 AnnotationArray* annotation_default() const {
226 InstanceKlass* ik = method_holder();
227 if (ik->annotations() == NULL) {
228 return NULL;
229 }
230 return ik->annotations()->get_method_default_annotations_of(method_idnum());
231 }
233 #ifdef CC_INTERP
234 void set_result_index(BasicType type);
235 int result_index() { return _result_index; }
236 #endif
238 // Helper routine: get klass name + "." + method name + signature as
239 // C string, for the purpose of providing more useful NoSuchMethodErrors
240 // and fatal error handling. The string is allocated in resource
241 // area if a buffer is not provided by the caller.
242 char* name_and_sig_as_C_string() const;
243 char* name_and_sig_as_C_string(char* buf, int size) const;
245 // Static routine in the situations we don't have a Method*
246 static char* name_and_sig_as_C_string(Klass* klass, Symbol* method_name, Symbol* signature);
247 static char* name_and_sig_as_C_string(Klass* klass, Symbol* method_name, Symbol* signature, char* buf, int size);
249 Bytecodes::Code java_code_at(int bci) const {
250 return Bytecodes::java_code_at(this, bcp_from(bci));
251 }
252 Bytecodes::Code code_at(int bci) const {
253 return Bytecodes::code_at(this, bcp_from(bci));
254 }
256 // JVMTI breakpoints
257 Bytecodes::Code orig_bytecode_at(int bci) const;
258 void set_orig_bytecode_at(int bci, Bytecodes::Code code);
259 void set_breakpoint(int bci);
260 void clear_breakpoint(int bci);
261 void clear_all_breakpoints();
262 // Tracking number of breakpoints, for fullspeed debugging.
263 // Only mutated by VM thread.
264 u2 number_of_breakpoints() const { return _number_of_breakpoints; }
265 void incr_number_of_breakpoints() { ++_number_of_breakpoints; }
266 void decr_number_of_breakpoints() { --_number_of_breakpoints; }
267 // Initialization only
268 void clear_number_of_breakpoints() { _number_of_breakpoints = 0; }
270 // index into InstanceKlass methods() array
271 // note: also used by jfr
272 u2 method_idnum() const { return constMethod()->method_idnum(); }
273 void set_method_idnum(u2 idnum) { constMethod()->set_method_idnum(idnum); }
275 // code size
276 int code_size() const { return constMethod()->code_size(); }
278 // method size
279 int method_size() const { return _method_size; }
280 void set_method_size(int size) {
281 assert(0 <= size && size < (1 << 16), "invalid method size");
282 _method_size = size;
283 }
285 // constant pool for Klass* holding this method
286 ConstantPool* constants() const { return constMethod()->constants(); }
287 void set_constants(ConstantPool* c) { constMethod()->set_constants(c); }
289 // max stack
290 // return original max stack size for method verification
291 int verifier_max_stack() const { return _max_stack; }
292 int max_stack() const { return _max_stack + extra_stack_entries(); }
293 void set_max_stack(int size) { _max_stack = size; }
295 // max locals
296 int max_locals() const { return _max_locals; }
297 void set_max_locals(int size) { _max_locals = size; }
299 int highest_comp_level() const;
300 void set_highest_comp_level(int level);
301 int highest_osr_comp_level() const;
302 void set_highest_osr_comp_level(int level);
304 // Count of times method was exited via exception while interpreting
305 void interpreter_throwout_increment() {
306 if (_interpreter_throwout_count < 65534) {
307 _interpreter_throwout_count++;
308 }
309 }
311 int interpreter_throwout_count() const { return _interpreter_throwout_count; }
312 void set_interpreter_throwout_count(int count) { _interpreter_throwout_count = count; }
314 // size of parameters
315 int size_of_parameters() const { return _size_of_parameters; }
317 bool has_stackmap_table() const {
318 return constMethod()->has_stackmap_table();
319 }
321 Array<u1>* stackmap_data() const {
322 return constMethod()->stackmap_data();
323 }
325 void set_stackmap_data(Array<u1>* sd) {
326 constMethod()->set_stackmap_data(sd);
327 }
329 // exception handler table
330 bool has_exception_handler() const
331 { return constMethod()->has_exception_handler(); }
332 int exception_table_length() const
333 { return constMethod()->exception_table_length(); }
334 ExceptionTableElement* exception_table_start() const
335 { return constMethod()->exception_table_start(); }
337 // Finds the first entry point bci of an exception handler for an
338 // exception of klass ex_klass thrown at throw_bci. A value of NULL
339 // for ex_klass indicates that the exception klass is not known; in
340 // this case it matches any constraint class. Returns -1 if the
341 // exception cannot be handled in this method. The handler
342 // constraint classes are loaded if necessary. Note that this may
343 // throw an exception if loading of the constraint classes causes
344 // an IllegalAccessError (bugid 4307310) or an OutOfMemoryError.
345 // If an exception is thrown, returns the bci of the
346 // exception handler which caused the exception to be thrown, which
347 // is needed for proper retries. See, for example,
348 // InterpreterRuntime::exception_handler_for_exception.
349 int fast_exception_handler_bci_for(KlassHandle ex_klass, int throw_bci, TRAPS);
351 // method data access
352 MethodData* method_data() const {
353 return _method_data;
354 }
355 void set_method_data(MethodData* data) {
356 _method_data = data;
357 }
359 // invocation counter
360 InvocationCounter* invocation_counter() { return &_invocation_counter; }
361 InvocationCounter* backedge_counter() { return &_backedge_counter; }
363 #ifdef TIERED
364 // We are reusing interpreter_invocation_count as a holder for the previous event count!
365 // We can do that since interpreter_invocation_count is not used in tiered.
366 int prev_event_count() const { return _interpreter_invocation_count; }
367 void set_prev_event_count(int count) { _interpreter_invocation_count = count; }
368 jlong prev_time() const { return _prev_time; }
369 void set_prev_time(jlong time) { _prev_time = time; }
370 float rate() const { return _rate; }
371 void set_rate(float rate) { _rate = rate; }
372 #endif
374 int invocation_count();
375 int backedge_count();
377 bool was_executed_more_than(int n);
378 bool was_never_executed() { return !was_executed_more_than(0); }
380 static void build_interpreter_method_data(methodHandle method, TRAPS);
382 int interpreter_invocation_count() {
383 if (TieredCompilation) return invocation_count();
384 else return _interpreter_invocation_count;
385 }
386 void set_interpreter_invocation_count(int count) { _interpreter_invocation_count = count; }
387 int increment_interpreter_invocation_count() {
388 if (TieredCompilation) ShouldNotReachHere();
389 return ++_interpreter_invocation_count;
390 }
392 #ifndef PRODUCT
393 int compiled_invocation_count() const { return _compiled_invocation_count; }
394 void set_compiled_invocation_count(int count) { _compiled_invocation_count = count; }
395 #endif // not PRODUCT
397 // Clear (non-shared space) pointers which could not be relevant
398 // if this (shared) method were mapped into another JVM.
399 void remove_unshareable_info();
401 // nmethod/verified compiler entry
402 address verified_code_entry();
403 bool check_code() const; // Not inline to avoid circular ref
404 nmethod* volatile code() const { assert( check_code(), "" ); return (nmethod *)OrderAccess::load_ptr_acquire(&_code); }
405 void clear_code(); // Clear out any compiled code
406 static void set_code(methodHandle mh, nmethod* code);
407 void set_adapter_entry(AdapterHandlerEntry* adapter) { _adapter = adapter; }
408 address get_i2c_entry();
409 address get_c2i_entry();
410 address get_c2i_unverified_entry();
411 AdapterHandlerEntry* adapter() { return _adapter; }
412 // setup entry points
413 void link_method(methodHandle method, TRAPS);
414 // clear entry points. Used by sharing code
415 void unlink_method();
417 // vtable index
418 enum VtableIndexFlag {
419 // Valid vtable indexes are non-negative (>= 0).
420 // These few negative values are used as sentinels.
421 highest_unused_vtable_index_value = -5,
422 invalid_vtable_index = -4, // distinct from any valid vtable index
423 garbage_vtable_index = -3, // not yet linked; no vtable layout yet
424 nonvirtual_vtable_index = -2 // there is no need for vtable dispatch
425 // 6330203 Note: Do not use -1, which was overloaded with many meanings.
426 };
427 DEBUG_ONLY(bool valid_vtable_index() const { return _vtable_index >= nonvirtual_vtable_index; })
428 int vtable_index() const { assert(valid_vtable_index(), "");
429 return _vtable_index; }
430 void set_vtable_index(int index) { _vtable_index = index; }
432 // interpreter entry
433 address interpreter_entry() const { return _i2i_entry; }
434 // Only used when first initialize so we can set _i2i_entry and _from_interpreted_entry
435 void set_interpreter_entry(address entry) { _i2i_entry = entry; _from_interpreted_entry = entry; }
436 int interpreter_kind(void) {
437 return constMethod()->interpreter_kind();
438 }
439 void set_interpreter_kind();
440 void set_interpreter_kind(int kind) {
441 constMethod()->set_interpreter_kind(kind);
442 }
444 // native function (used for native methods only)
445 enum {
446 native_bind_event_is_interesting = true
447 };
448 address native_function() const { return *(native_function_addr()); }
449 address critical_native_function();
451 // Must specify a real function (not NULL).
452 // Use clear_native_function() to unregister.
453 void set_native_function(address function, bool post_event_flag);
454 bool has_native_function() const;
455 void clear_native_function();
457 // signature handler (used for native methods only)
458 address signature_handler() const { return *(signature_handler_addr()); }
459 void set_signature_handler(address handler);
461 // Interpreter oopmap support
462 void mask_for(int bci, InterpreterOopMap* mask);
464 #ifndef PRODUCT
465 // operations on invocation counter
466 void print_invocation_count();
467 #endif
469 // byte codes
470 void set_code(address code) { return constMethod()->set_code(code); }
471 address code_base() const { return constMethod()->code_base(); }
472 bool contains(address bcp) const { return constMethod()->contains(bcp); }
474 // prints byte codes
475 void print_codes() const { print_codes_on(tty); }
476 void print_codes_on(outputStream* st) const PRODUCT_RETURN;
477 void print_codes_on(int from, int to, outputStream* st) const PRODUCT_RETURN;
479 // checked exceptions
480 int checked_exceptions_length() const
481 { return constMethod()->checked_exceptions_length(); }
482 CheckedExceptionElement* checked_exceptions_start() const
483 { return constMethod()->checked_exceptions_start(); }
485 // localvariable table
486 bool has_localvariable_table() const
487 { return constMethod()->has_localvariable_table(); }
488 int localvariable_table_length() const
489 { return constMethod()->localvariable_table_length(); }
490 LocalVariableTableElement* localvariable_table_start() const
491 { return constMethod()->localvariable_table_start(); }
493 bool has_linenumber_table() const
494 { return constMethod()->has_linenumber_table(); }
495 u_char* compressed_linenumber_table() const
496 { return constMethod()->compressed_linenumber_table(); }
498 // method holder (the Klass* holding this method)
499 InstanceKlass* method_holder() const { return constants()->pool_holder(); }
501 void compute_size_of_parameters(Thread *thread); // word size of parameters (receiver if any + arguments)
502 Symbol* klass_name() const; // returns the name of the method holder
503 BasicType result_type() const; // type of the method result
504 int result_type_index() const; // type index of the method result
505 bool is_returning_oop() const { BasicType r = result_type(); return (r == T_OBJECT || r == T_ARRAY); }
506 bool is_returning_fp() const { BasicType r = result_type(); return (r == T_FLOAT || r == T_DOUBLE); }
508 // Checked exceptions thrown by this method (resolved to mirrors)
509 objArrayHandle resolved_checked_exceptions(TRAPS) { return resolved_checked_exceptions_impl(this, THREAD); }
511 // Access flags
512 bool is_public() const { return access_flags().is_public(); }
513 bool is_private() const { return access_flags().is_private(); }
514 bool is_protected() const { return access_flags().is_protected(); }
515 bool is_package_private() const { return !is_public() && !is_private() && !is_protected(); }
516 bool is_static() const { return access_flags().is_static(); }
517 bool is_final() const { return access_flags().is_final(); }
518 bool is_synchronized() const { return access_flags().is_synchronized();}
519 bool is_native() const { return access_flags().is_native(); }
520 bool is_abstract() const { return access_flags().is_abstract(); }
521 bool is_strict() const { return access_flags().is_strict(); }
522 bool is_synthetic() const { return access_flags().is_synthetic(); }
524 // returns true if contains only return operation
525 bool is_empty_method() const;
527 // returns true if this is a vanilla constructor
528 bool is_vanilla_constructor() const;
530 // checks method and its method holder
531 bool is_final_method() const;
532 bool is_strict_method() const;
534 // true if method needs no dynamic dispatch (final and/or no vtable entry)
535 bool can_be_statically_bound() const;
537 // returns true if the method has any backward branches.
538 bool has_loops() {
539 return access_flags().loops_flag_init() ? access_flags().has_loops() : compute_has_loops_flag();
540 };
542 bool compute_has_loops_flag();
544 bool has_jsrs() {
545 return access_flags().has_jsrs();
546 };
547 void set_has_jsrs() {
548 _access_flags.set_has_jsrs();
549 }
551 // returns true if the method has any monitors.
552 bool has_monitors() const { return is_synchronized() || access_flags().has_monitor_bytecodes(); }
553 bool has_monitor_bytecodes() const { return access_flags().has_monitor_bytecodes(); }
555 void set_has_monitor_bytecodes() { _access_flags.set_has_monitor_bytecodes(); }
557 // monitor matching. This returns a conservative estimate of whether the monitorenter/monitorexit bytecodes
558 // propererly nest in the method. It might return false, even though they actually nest properly, since the info.
559 // has not been computed yet.
560 bool guaranteed_monitor_matching() const { return access_flags().is_monitor_matching(); }
561 void set_guaranteed_monitor_matching() { _access_flags.set_monitor_matching(); }
563 // returns true if the method is an accessor function (setter/getter).
564 bool is_accessor() const;
566 // returns true if the method is an initializer (<init> or <clinit>).
567 bool is_initializer() const;
569 // returns true if the method is static OR if the classfile version < 51
570 bool has_valid_initializer_flags() const;
572 // returns true if the method name is <clinit> and the method has
573 // valid static initializer flags.
574 bool is_static_initializer() const;
576 // compiled code support
577 // NOTE: code() is inherently racy as deopt can be clearing code
578 // simultaneously. Use with caution.
579 bool has_compiled_code() const { return code() != NULL; }
581 // sizing
582 static int header_size() { return sizeof(Method)/HeapWordSize; }
583 static int size(bool is_native);
584 int size() const { return method_size(); }
586 // interpreter support
587 static ByteSize const_offset() { return byte_offset_of(Method, _constMethod ); }
588 static ByteSize access_flags_offset() { return byte_offset_of(Method, _access_flags ); }
589 #ifdef CC_INTERP
590 static ByteSize result_index_offset() { return byte_offset_of(Method, _result_index ); }
591 #endif /* CC_INTERP */
592 static ByteSize size_of_locals_offset() { return byte_offset_of(Method, _max_locals ); }
593 static ByteSize size_of_parameters_offset() { return byte_offset_of(Method, _size_of_parameters); }
594 static ByteSize from_compiled_offset() { return byte_offset_of(Method, _from_compiled_entry); }
595 static ByteSize code_offset() { return byte_offset_of(Method, _code); }
596 static ByteSize invocation_counter_offset() { return byte_offset_of(Method, _invocation_counter); }
597 static ByteSize backedge_counter_offset() { return byte_offset_of(Method, _backedge_counter); }
598 static ByteSize method_data_offset() {
599 return byte_offset_of(Method, _method_data);
600 }
601 static ByteSize interpreter_invocation_counter_offset() { return byte_offset_of(Method, _interpreter_invocation_count); }
602 #ifndef PRODUCT
603 static ByteSize compiled_invocation_counter_offset() { return byte_offset_of(Method, _compiled_invocation_count); }
604 #endif // not PRODUCT
605 static ByteSize native_function_offset() { return in_ByteSize(sizeof(Method)); }
606 static ByteSize from_interpreted_offset() { return byte_offset_of(Method, _from_interpreted_entry ); }
607 static ByteSize interpreter_entry_offset() { return byte_offset_of(Method, _i2i_entry ); }
608 static ByteSize signature_handler_offset() { return in_ByteSize(sizeof(Method) + wordSize); }
609 static ByteSize max_stack_offset() { return byte_offset_of(Method, _max_stack ); }
611 // for code generation
612 static int method_data_offset_in_bytes() { return offset_of(Method, _method_data); }
613 static int interpreter_invocation_counter_offset_in_bytes()
614 { return offset_of(Method, _interpreter_invocation_count); }
615 static int intrinsic_id_offset_in_bytes() { return offset_of(Method, _intrinsic_id); }
616 static int intrinsic_id_size_in_bytes() { return sizeof(u1); }
618 // Static methods that are used to implement member methods where an exposed this pointer
619 // is needed due to possible GCs
620 static objArrayHandle resolved_checked_exceptions_impl(Method* this_oop, TRAPS);
622 // Returns the byte code index from the byte code pointer
623 int bci_from(address bcp) const;
624 address bcp_from(int bci) const;
625 int validate_bci_from_bcx(intptr_t bcx) const;
627 // Returns the line number for a bci if debugging information for the method is prowided,
628 // -1 is returned otherwise.
629 int line_number_from_bci(int bci) const;
631 // Reflection support
632 bool is_overridden_in(Klass* k) const;
634 // JSR 292 support
635 bool is_method_handle_intrinsic() const; // MethodHandles::is_signature_polymorphic_intrinsic(intrinsic_id)
636 bool is_compiled_lambda_form() const; // intrinsic_id() == vmIntrinsics::_compiledLambdaForm
637 bool has_member_arg() const; // intrinsic_id() == vmIntrinsics::_linkToSpecial, etc.
638 static methodHandle make_method_handle_intrinsic(vmIntrinsics::ID iid, // _invokeBasic, _linkToVirtual
639 Symbol* signature, //anything at all
640 TRAPS);
641 static Klass* check_non_bcp_klass(Klass* klass);
642 // these operate only on invoke methods:
643 // presize interpreter frames for extra interpreter stack entries, if needed
644 // method handles want to be able to push a few extra values (e.g., a bound receiver), and
645 // invokedynamic sometimes needs to push a bootstrap method, call site, and arglist,
646 // all without checking for a stack overflow
647 static int extra_stack_entries() { return EnableInvokeDynamic ? 2 : 0; }
648 static int extra_stack_words(); // = extra_stack_entries() * Interpreter::stackElementSize()
650 // RedefineClasses() support:
651 bool is_old() const { return access_flags().is_old(); }
652 void set_is_old() { _access_flags.set_is_old(); }
653 bool is_obsolete() const { return access_flags().is_obsolete(); }
654 void set_is_obsolete() { _access_flags.set_is_obsolete(); }
655 bool on_stack() const { return access_flags().on_stack(); }
656 void set_on_stack(const bool value);
658 // see the definition in Method*.cpp for the gory details
659 bool should_not_be_cached() const;
661 // JVMTI Native method prefixing support:
662 bool is_prefixed_native() const { return access_flags().is_prefixed_native(); }
663 void set_is_prefixed_native() { _access_flags.set_is_prefixed_native(); }
665 // Rewriting support
666 static methodHandle clone_with_new_data(methodHandle m, u_char* new_code, int new_code_length,
667 u_char* new_compressed_linenumber_table, int new_compressed_linenumber_size, TRAPS);
669 // jmethodID handling
670 // Because the useful life-span of a jmethodID cannot be determined,
671 // once created they are never reclaimed. The methods to which they refer,
672 // however, can be GC'ed away if the class is unloaded or if the method is
673 // made obsolete or deleted -- in these cases, the jmethodID
674 // refers to NULL (as is the case for any weak reference).
675 static jmethodID make_jmethod_id(ClassLoaderData* loader_data, Method* mh);
676 static void destroy_jmethod_id(ClassLoaderData* loader_data, jmethodID mid);
678 // Use resolve_jmethod_id() in situations where the caller is expected
679 // to provide a valid jmethodID; the only sanity checks are in asserts;
680 // result guaranteed not to be NULL.
681 inline static Method* resolve_jmethod_id(jmethodID mid) {
682 assert(mid != NULL, "JNI method id should not be null");
683 return *((Method**)mid);
684 }
686 // Use checked_resolve_jmethod_id() in situations where the caller
687 // should provide a valid jmethodID, but might not. NULL is returned
688 // when the jmethodID does not refer to a valid method.
689 static Method* checked_resolve_jmethod_id(jmethodID mid);
691 static void change_method_associated_with_jmethod_id(jmethodID old_jmid_ptr, Method* new_method);
692 static bool is_method_id(jmethodID mid);
694 // Clear methods
695 static void clear_jmethod_ids(ClassLoaderData* loader_data);
696 static void print_jmethod_ids(ClassLoaderData* loader_data, outputStream* out) PRODUCT_RETURN;
698 // Get this method's jmethodID -- allocate if it doesn't exist
699 jmethodID jmethod_id() { methodHandle this_h(this);
700 return InstanceKlass::get_jmethod_id(method_holder(), this_h); }
702 // Lookup the jmethodID for this method. Return NULL if not found.
703 // NOTE that this function can be called from a signal handler
704 // (see AsyncGetCallTrace support for Forte Analyzer) and this
705 // needs to be async-safe. No allocation should be done and
706 // so handles are not used to avoid deadlock.
707 jmethodID find_jmethod_id_or_null() { return method_holder()->jmethod_id_or_null(this); }
709 // JNI static invoke cached itable index accessors
710 int cached_itable_index() { return method_holder()->cached_itable_index(method_idnum()); }
711 void set_cached_itable_index(int index) { method_holder()->set_cached_itable_index(method_idnum(), index); }
713 // Support for inlining of intrinsic methods
714 vmIntrinsics::ID intrinsic_id() const { return (vmIntrinsics::ID) _intrinsic_id; }
715 void set_intrinsic_id(vmIntrinsics::ID id) { _intrinsic_id = (u1) id; }
717 // Helper routines for intrinsic_id() and vmIntrinsics::method().
718 void init_intrinsic_id(); // updates from _none if a match
719 static vmSymbols::SID klass_id_for_intrinsics(Klass* holder);
721 bool jfr_towrite() { return _jfr_towrite; }
722 void set_jfr_towrite(bool towrite) { _jfr_towrite = towrite; }
724 bool force_inline() { return _force_inline; }
725 void set_force_inline(bool x) { _force_inline = x; }
726 bool dont_inline() { return _dont_inline; }
727 void set_dont_inline(bool x) { _dont_inline = x; }
728 bool is_hidden() { return _hidden; }
729 void set_hidden(bool x) { _hidden = x; }
730 ConstMethod::MethodType method_type() const {
731 return _constMethod->method_type();
732 }
733 bool is_overpass() const { return method_type() == ConstMethod::OVERPASS; }
735 // On-stack replacement support
736 bool has_osr_nmethod(int level, bool match_level) {
737 return method_holder()->lookup_osr_nmethod(this, InvocationEntryBci, level, match_level) != NULL;
738 }
740 nmethod* lookup_osr_nmethod_for(int bci, int level, bool match_level) {
741 return method_holder()->lookup_osr_nmethod(this, bci, level, match_level);
742 }
744 // Inline cache support
745 void cleanup_inline_caches();
747 // Find if klass for method is loaded
748 bool is_klass_loaded_by_klass_index(int klass_index) const;
749 bool is_klass_loaded(int refinfo_index, bool must_be_resolved = false) const;
751 // Indicates whether compilation failed earlier for this method, or
752 // whether it is not compilable for another reason like having a
753 // breakpoint set in it.
754 bool is_not_compilable(int comp_level = CompLevel_any) const;
755 void set_not_compilable(int comp_level = CompLevel_all, bool report = true);
756 void set_not_compilable_quietly(int comp_level = CompLevel_all) {
757 set_not_compilable(comp_level, false);
758 }
759 bool is_not_osr_compilable(int comp_level = CompLevel_any) const;
760 void set_not_osr_compilable(int comp_level = CompLevel_all, bool report = true);
761 void set_not_osr_compilable_quietly(int comp_level = CompLevel_all) {
762 set_not_osr_compilable(comp_level, false);
763 }
765 private:
766 void print_made_not_compilable(int comp_level, bool is_osr, bool report);
768 public:
769 bool is_not_c1_compilable() const { return access_flags().is_not_c1_compilable(); }
770 void set_not_c1_compilable() { _access_flags.set_not_c1_compilable(); }
771 bool is_not_c2_compilable() const { return access_flags().is_not_c2_compilable(); }
772 void set_not_c2_compilable() { _access_flags.set_not_c2_compilable(); }
774 bool is_not_c1_osr_compilable() const { return is_not_c1_compilable(); } // don't waste an accessFlags bit
775 void set_not_c1_osr_compilable() { set_not_c1_compilable(); } // don't waste an accessFlags bit
776 bool is_not_c2_osr_compilable() const { return access_flags().is_not_c2_osr_compilable(); }
777 void set_not_c2_osr_compilable() { _access_flags.set_not_c2_osr_compilable(); }
779 // Background compilation support
780 bool queued_for_compilation() const { return access_flags().queued_for_compilation(); }
781 void set_queued_for_compilation() { _access_flags.set_queued_for_compilation(); }
782 void clear_queued_for_compilation() { _access_flags.clear_queued_for_compilation(); }
784 // Resolve all classes in signature, return 'true' if successful
785 static bool load_signature_classes(methodHandle m, TRAPS);
787 // Return if true if not all classes references in signature, including return type, has been loaded
788 static bool has_unloaded_classes_in_signature(methodHandle m, TRAPS);
790 // Printing
791 void print_short_name(outputStream* st = tty) /*PRODUCT_RETURN*/; // prints as klassname::methodname; Exposed so field engineers can debug VM
792 void print_name(outputStream* st = tty) PRODUCT_RETURN; // prints as "virtual void foo(int)"
794 // Helper routine used for method sorting
795 static void sort_methods(Array<Method*>* methods,
796 Array<AnnotationArray*>* methods_annotations,
797 Array<AnnotationArray*>* methods_parameter_annotations,
798 Array<AnnotationArray*>* methods_default_annotations,
799 bool idempotent = false);
801 // size of parameters
802 void set_size_of_parameters(int size) { _size_of_parameters = size; }
804 // Deallocation function for redefine classes or if an error occurs
805 void deallocate_contents(ClassLoaderData* loader_data);
807 // Printing
808 #ifndef PRODUCT
809 void print_on(outputStream* st) const;
810 #endif
811 void print_value_on(outputStream* st) const;
813 const char* internal_name() const { return "{method}"; }
815 // Verify
816 void verify() { verify_on(tty); }
817 void verify_on(outputStream* st);
819 private:
821 // Inlined elements
822 address* native_function_addr() const { assert(is_native(), "must be native"); return (address*) (this+1); }
823 address* signature_handler_addr() const { return native_function_addr() + 1; }
824 };
827 // Utility class for compressing line number tables
829 class CompressedLineNumberWriteStream: public CompressedWriteStream {
830 private:
831 int _bci;
832 int _line;
833 public:
834 // Constructor
835 CompressedLineNumberWriteStream(int initial_size) : CompressedWriteStream(initial_size), _bci(0), _line(0) {}
836 CompressedLineNumberWriteStream(u_char* buffer, int initial_size) : CompressedWriteStream(buffer, initial_size), _bci(0), _line(0) {}
838 // Write (bci, line number) pair to stream
839 void write_pair_regular(int bci_delta, int line_delta);
841 inline void write_pair_inline(int bci, int line) {
842 int bci_delta = bci - _bci;
843 int line_delta = line - _line;
844 _bci = bci;
845 _line = line;
846 // Skip (0,0) deltas - they do not add information and conflict with terminator.
847 if (bci_delta == 0 && line_delta == 0) return;
848 // Check if bci is 5-bit and line number 3-bit unsigned.
849 if (((bci_delta & ~0x1F) == 0) && ((line_delta & ~0x7) == 0)) {
850 // Compress into single byte.
851 jubyte value = ((jubyte) bci_delta << 3) | (jubyte) line_delta;
852 // Check that value doesn't match escape character.
853 if (value != 0xFF) {
854 write_byte(value);
855 return;
856 }
857 }
858 write_pair_regular(bci_delta, line_delta);
859 }
861 // Windows AMD64 + Apr 2005 PSDK with /O2 generates bad code for write_pair.
862 // Disabling optimization doesn't work for methods in header files
863 // so we force it to call through the non-optimized version in the .cpp.
864 // It's gross, but it's the only way we can ensure that all callers are
865 // fixed. _MSC_VER is defined by the windows compiler
866 #if defined(_M_AMD64) && _MSC_VER >= 1400
867 void write_pair(int bci, int line);
868 #else
869 void write_pair(int bci, int line) { write_pair_inline(bci, line); }
870 #endif
872 // Write end-of-stream marker
873 void write_terminator() { write_byte(0); }
874 };
877 // Utility class for decompressing line number tables
879 class CompressedLineNumberReadStream: public CompressedReadStream {
880 private:
881 int _bci;
882 int _line;
883 public:
884 // Constructor
885 CompressedLineNumberReadStream(u_char* buffer);
886 // Read (bci, line number) pair from stream. Returns false at end-of-stream.
887 bool read_pair();
888 // Accessing bci and line number (after calling read_pair)
889 int bci() const { return _bci; }
890 int line() const { return _line; }
891 };
894 /// Fast Breakpoints.
896 // If this structure gets more complicated (because bpts get numerous),
897 // move it into its own header.
899 // There is presently no provision for concurrent access
900 // to breakpoint lists, which is only OK for JVMTI because
901 // breakpoints are written only at safepoints, and are read
902 // concurrently only outside of safepoints.
904 class BreakpointInfo : public CHeapObj<mtClass> {
905 friend class VMStructs;
906 private:
907 Bytecodes::Code _orig_bytecode;
908 int _bci;
909 u2 _name_index; // of method
910 u2 _signature_index; // of method
911 BreakpointInfo* _next; // simple storage allocation
913 public:
914 BreakpointInfo(Method* m, int bci);
916 // accessors
917 Bytecodes::Code orig_bytecode() { return _orig_bytecode; }
918 void set_orig_bytecode(Bytecodes::Code code) { _orig_bytecode = code; }
919 int bci() { return _bci; }
921 BreakpointInfo* next() const { return _next; }
922 void set_next(BreakpointInfo* n) { _next = n; }
924 // helps for searchers
925 bool match(const Method* m, int bci) {
926 return bci == _bci && match(m);
927 }
929 bool match(const Method* m) {
930 return _name_index == m->name_index() &&
931 _signature_index == m->signature_index();
932 }
934 void set(Method* method);
935 void clear(Method* method);
936 };
938 // Utility class for access exception handlers
939 class ExceptionTable : public StackObj {
940 private:
941 ExceptionTableElement* _table;
942 u2 _length;
944 public:
945 ExceptionTable(Method* m) {
946 if (m->has_exception_handler()) {
947 _table = m->exception_table_start();
948 _length = m->exception_table_length();
949 } else {
950 _table = NULL;
951 _length = 0;
952 }
953 }
955 int length() const {
956 return _length;
957 }
959 u2 start_pc(int idx) const {
960 assert(idx < _length, "out of bounds");
961 return _table[idx].start_pc;
962 }
964 void set_start_pc(int idx, u2 value) {
965 assert(idx < _length, "out of bounds");
966 _table[idx].start_pc = value;
967 }
969 u2 end_pc(int idx) const {
970 assert(idx < _length, "out of bounds");
971 return _table[idx].end_pc;
972 }
974 void set_end_pc(int idx, u2 value) {
975 assert(idx < _length, "out of bounds");
976 _table[idx].end_pc = value;
977 }
979 u2 handler_pc(int idx) const {
980 assert(idx < _length, "out of bounds");
981 return _table[idx].handler_pc;
982 }
984 void set_handler_pc(int idx, u2 value) {
985 assert(idx < _length, "out of bounds");
986 _table[idx].handler_pc = value;
987 }
989 u2 catch_type_index(int idx) const {
990 assert(idx < _length, "out of bounds");
991 return _table[idx].catch_type_index;
992 }
994 void set_catch_type_index(int idx, u2 value) {
995 assert(idx < _length, "out of bounds");
996 _table[idx].catch_type_index = value;
997 }
998 };
1000 #endif // SHARE_VM_OOPS_METHODOOP_HPP