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