Thu, 11 Jun 2015 14:19:40 +0300
8074551: GWT can be marked non-compilable due to deopt count pollution
Reviewed-by: kvn
1 /*
2 * Copyright (c) 1997, 2015, 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/methodCounters.hpp"
35 #include "oops/instanceKlass.hpp"
36 #include "oops/oop.hpp"
37 #include "oops/typeArrayOop.hpp"
38 #include "utilities/accessFlags.hpp"
39 #include "utilities/growableArray.hpp"
41 // A Method* represents a Java method.
42 //
43 // Memory layout (each line represents a word). Note that most applications load thousands of methods,
44 // so keeping the size of this structure small has a big impact on footprint.
45 //
46 // We put all oops and method_size first for better gc cache locality.
47 //
48 // The actual bytecodes are inlined after the end of the Method struct.
49 //
50 // There are bits in the access_flags telling whether inlined tables are present.
51 // Note that accessing the line number and local variable tables is not performance critical at all.
52 // Accessing the checked exceptions table is used by reflection, so we put that last to make access
53 // to it fast.
54 //
55 // The line number table is compressed and inlined following the byte codes. It is found as the first
56 // byte following the byte codes. The checked exceptions table and the local variable table are inlined
57 // after the line number table, and indexed from the end of the method. We do not compress the checked
58 // exceptions table since the average length is less than 2, and do not bother to compress the local
59 // variable table either since it is mostly absent.
60 //
61 // Note that native_function and signature_handler has to be at fixed offsets (required by the interpreter)
62 //
63 // |------------------------------------------------------|
64 // | header |
65 // | klass |
66 // |------------------------------------------------------|
67 // | ConstMethod* (oop) |
68 // |------------------------------------------------------|
69 // | methodData (oop) |
70 // | methodCounters |
71 // |------------------------------------------------------|
72 // | access_flags |
73 // | vtable_index |
74 // |------------------------------------------------------|
75 // | result_index (C++ interpreter only) |
76 // |------------------------------------------------------|
77 // | method_size | intrinsic_id| flags |
78 // |------------------------------------------------------|
79 // | code (pointer) |
80 // | i2i (pointer) |
81 // | adapter (pointer) |
82 // | from_compiled_entry (pointer) |
83 // | from_interpreted_entry (pointer) |
84 // |------------------------------------------------------|
85 // | native_function (present only if native) |
86 // | signature_handler (present only if native) |
87 // |------------------------------------------------------|
90 class CheckedExceptionElement;
91 class LocalVariableTableElement;
92 class AdapterHandlerEntry;
93 class MethodData;
94 class MethodCounters;
95 class ConstMethod;
96 class InlineTableSizes;
97 class KlassSizeStats;
99 class Method : public Metadata {
100 friend class VMStructs;
101 private:
102 ConstMethod* _constMethod; // Method read-only data.
103 MethodData* _method_data;
104 MethodCounters* _method_counters;
105 AccessFlags _access_flags; // Access flags
106 int _vtable_index; // vtable index of this method (see VtableIndexFlag)
107 // note: can have vtables with >2**16 elements (because of inheritance)
108 #ifdef CC_INTERP
109 int _result_index; // C++ interpreter needs for converting results to/from stack
110 #endif
111 u2 _method_size; // size of this object
112 u1 _intrinsic_id; // vmSymbols::intrinsic_id (0 == _none)
113 u1 _jfr_towrite : 1, // Flags
114 _caller_sensitive : 1,
115 _force_inline : 1,
116 _hidden : 1,
117 _dont_inline : 1,
118 _has_injected_profile : 1,
119 : 2;
121 #ifndef PRODUCT
122 int _compiled_invocation_count; // Number of nmethod invocations so far (for perf. debugging)
123 #endif
124 // Entry point for calling both from and to the interpreter.
125 address _i2i_entry; // All-args-on-stack calling convention
126 // Adapter blob (i2c/c2i) for this Method*. Set once when method is linked.
127 AdapterHandlerEntry* _adapter;
128 // Entry point for calling from compiled code, to compiled code if it exists
129 // or else the interpreter.
130 volatile address _from_compiled_entry; // Cache of: _code ? _code->entry_point() : _adapter->c2i_entry()
131 // The entry point for calling both from and to compiled code is
132 // "_code->entry_point()". Because of tiered compilation and de-opt, this
133 // field can come and go. It can transition from NULL to not-null at any
134 // time (whenever a compile completes). It can transition from not-null to
135 // NULL only at safepoints (because of a de-opt).
136 nmethod* volatile _code; // Points to the corresponding piece of native code
137 volatile address _from_interpreted_entry; // Cache of _code ? _adapter->i2c_entry() : _i2i_entry
139 // Constructor
140 Method(ConstMethod* xconst, AccessFlags access_flags, int size);
141 public:
143 static Method* allocate(ClassLoaderData* loader_data,
144 int byte_code_size,
145 AccessFlags access_flags,
146 InlineTableSizes* sizes,
147 ConstMethod::MethodType method_type,
148 TRAPS);
150 // CDS and vtbl checking can create an empty Method to get vtbl pointer.
151 Method(){}
153 // The Method vtable is restored by this call when the Method is in the
154 // shared archive. See patch_klass_vtables() in metaspaceShared.cpp for
155 // all the gory details. SA, dtrace and pstack helpers distinguish metadata
156 // by their vtable.
157 void restore_vtable() { guarantee(is_method(), "vtable restored by this call"); }
158 bool is_method() const volatile { return true; }
160 void restore_unshareable_info(TRAPS);
162 // accessors for instance variables
164 ConstMethod* constMethod() const { return _constMethod; }
165 void set_constMethod(ConstMethod* xconst) { _constMethod = xconst; }
168 static address make_adapters(methodHandle mh, TRAPS);
169 volatile address from_compiled_entry() const { return (address)OrderAccess::load_ptr_acquire(&_from_compiled_entry); }
170 volatile address from_interpreted_entry() const{ return (address)OrderAccess::load_ptr_acquire(&_from_interpreted_entry); }
172 // access flag
173 AccessFlags access_flags() const { return _access_flags; }
174 void set_access_flags(AccessFlags flags) { _access_flags = flags; }
176 // name
177 Symbol* name() const { return constants()->symbol_at(name_index()); }
178 int name_index() const { return constMethod()->name_index(); }
179 void set_name_index(int index) { constMethod()->set_name_index(index); }
181 // signature
182 Symbol* signature() const { return constants()->symbol_at(signature_index()); }
183 int signature_index() const { return constMethod()->signature_index(); }
184 void set_signature_index(int index) { constMethod()->set_signature_index(index); }
186 // generics support
187 Symbol* generic_signature() const { int idx = generic_signature_index(); return ((idx != 0) ? constants()->symbol_at(idx) : (Symbol*)NULL); }
188 int generic_signature_index() const { return constMethod()->generic_signature_index(); }
189 void set_generic_signature_index(int index) { constMethod()->set_generic_signature_index(index); }
191 // annotations support
192 AnnotationArray* annotations() const {
193 return constMethod()->method_annotations();
194 }
195 AnnotationArray* parameter_annotations() const {
196 return constMethod()->parameter_annotations();
197 }
198 AnnotationArray* annotation_default() const {
199 return constMethod()->default_annotations();
200 }
201 AnnotationArray* type_annotations() const {
202 return constMethod()->type_annotations();
203 }
205 #ifdef CC_INTERP
206 void set_result_index(BasicType type);
207 int result_index() { return _result_index; }
208 #endif
210 // Helper routine: get klass name + "." + method name + signature as
211 // C string, for the purpose of providing more useful NoSuchMethodErrors
212 // and fatal error handling. The string is allocated in resource
213 // area if a buffer is not provided by the caller.
214 char* name_and_sig_as_C_string() const;
215 char* name_and_sig_as_C_string(char* buf, int size) const;
217 // Static routine in the situations we don't have a Method*
218 static char* name_and_sig_as_C_string(Klass* klass, Symbol* method_name, Symbol* signature);
219 static char* name_and_sig_as_C_string(Klass* klass, Symbol* method_name, Symbol* signature, char* buf, int size);
221 Bytecodes::Code java_code_at(int bci) const {
222 return Bytecodes::java_code_at(this, bcp_from(bci));
223 }
224 Bytecodes::Code code_at(int bci) const {
225 return Bytecodes::code_at(this, bcp_from(bci));
226 }
228 // JVMTI breakpoints
229 Bytecodes::Code orig_bytecode_at(int bci) const;
230 void set_orig_bytecode_at(int bci, Bytecodes::Code code);
231 void set_breakpoint(int bci);
232 void clear_breakpoint(int bci);
233 void clear_all_breakpoints();
234 // Tracking number of breakpoints, for fullspeed debugging.
235 // Only mutated by VM thread.
236 u2 number_of_breakpoints() const {
237 MethodCounters* mcs = method_counters();
238 if (mcs == NULL) {
239 return 0;
240 } else {
241 return mcs->number_of_breakpoints();
242 }
243 }
244 void incr_number_of_breakpoints(TRAPS) {
245 MethodCounters* mcs = get_method_counters(CHECK);
246 if (mcs != NULL) {
247 mcs->incr_number_of_breakpoints();
248 }
249 }
250 void decr_number_of_breakpoints(TRAPS) {
251 MethodCounters* mcs = get_method_counters(CHECK);
252 if (mcs != NULL) {
253 mcs->decr_number_of_breakpoints();
254 }
255 }
256 // Initialization only
257 void clear_number_of_breakpoints() {
258 MethodCounters* mcs = method_counters();
259 if (mcs != NULL) {
260 mcs->clear_number_of_breakpoints();
261 }
262 }
264 // index into InstanceKlass methods() array
265 // note: also used by jfr
266 u2 method_idnum() const { return constMethod()->method_idnum(); }
267 void set_method_idnum(u2 idnum) { constMethod()->set_method_idnum(idnum); }
269 u2 orig_method_idnum() const { return constMethod()->orig_method_idnum(); }
270 void set_orig_method_idnum(u2 idnum) { constMethod()->set_orig_method_idnum(idnum); }
272 // code size
273 int code_size() const { return constMethod()->code_size(); }
275 // method size
276 int method_size() const { return _method_size; }
277 void set_method_size(int size) {
278 assert(0 <= size && size < (1 << 16), "invalid method size");
279 _method_size = size;
280 }
282 // constant pool for Klass* holding this method
283 ConstantPool* constants() const { return constMethod()->constants(); }
284 void set_constants(ConstantPool* c) { constMethod()->set_constants(c); }
286 // max stack
287 // return original max stack size for method verification
288 int verifier_max_stack() const { return constMethod()->max_stack(); }
289 int max_stack() const { return constMethod()->max_stack() + extra_stack_entries(); }
290 void set_max_stack(int size) { constMethod()->set_max_stack(size); }
292 // max locals
293 int max_locals() const { return constMethod()->max_locals(); }
294 void set_max_locals(int size) { constMethod()->set_max_locals(size); }
296 int highest_comp_level() const;
297 void set_highest_comp_level(int level);
298 int highest_osr_comp_level() const;
299 void set_highest_osr_comp_level(int level);
301 // Count of times method was exited via exception while interpreting
302 void interpreter_throwout_increment(TRAPS) {
303 MethodCounters* mcs = get_method_counters(CHECK);
304 if (mcs != NULL) {
305 mcs->interpreter_throwout_increment();
306 }
307 }
309 int interpreter_throwout_count() const {
310 MethodCounters* mcs = method_counters();
311 if (mcs == NULL) {
312 return 0;
313 } else {
314 return mcs->interpreter_throwout_count();
315 }
316 }
318 // size of parameters
319 int size_of_parameters() const { return constMethod()->size_of_parameters(); }
320 void set_size_of_parameters(int size) { constMethod()->set_size_of_parameters(size); }
322 bool has_stackmap_table() const {
323 return constMethod()->has_stackmap_table();
324 }
326 Array<u1>* stackmap_data() const {
327 return constMethod()->stackmap_data();
328 }
330 void set_stackmap_data(Array<u1>* sd) {
331 constMethod()->set_stackmap_data(sd);
332 }
334 // exception handler table
335 bool has_exception_handler() const
336 { return constMethod()->has_exception_handler(); }
337 int exception_table_length() const
338 { return constMethod()->exception_table_length(); }
339 ExceptionTableElement* exception_table_start() const
340 { return constMethod()->exception_table_start(); }
342 // Finds the first entry point bci of an exception handler for an
343 // exception of klass ex_klass thrown at throw_bci. A value of NULL
344 // for ex_klass indicates that the exception klass is not known; in
345 // this case it matches any constraint class. Returns -1 if the
346 // exception cannot be handled in this method. The handler
347 // constraint classes are loaded if necessary. Note that this may
348 // throw an exception if loading of the constraint classes causes
349 // an IllegalAccessError (bugid 4307310) or an OutOfMemoryError.
350 // If an exception is thrown, returns the bci of the
351 // exception handler which caused the exception to be thrown, which
352 // is needed for proper retries. See, for example,
353 // InterpreterRuntime::exception_handler_for_exception.
354 static int fast_exception_handler_bci_for(methodHandle mh, KlassHandle ex_klass, int throw_bci, TRAPS);
356 // method data access
357 MethodData* method_data() const {
358 return _method_data;
359 }
361 void set_method_data(MethodData* data) {
362 // The store into method must be released. On platforms without
363 // total store order (TSO) the reference may become visible before
364 // the initialization of data otherwise.
365 OrderAccess::release_store_ptr((volatile void *)&_method_data, data);
366 }
368 MethodCounters* method_counters() const {
369 return _method_counters;
370 }
372 void clear_method_counters() {
373 _method_counters = NULL;
374 }
376 bool init_method_counters(MethodCounters* counters) {
377 // Try to install a pointer to MethodCounters, return true on success.
378 return Atomic::cmpxchg_ptr(counters, (volatile void*)&_method_counters, NULL) == NULL;
379 }
381 #ifdef TIERED
382 // We are reusing interpreter_invocation_count as a holder for the previous event count!
383 // We can do that since interpreter_invocation_count is not used in tiered.
384 int prev_event_count() const {
385 if (method_counters() == NULL) {
386 return 0;
387 } else {
388 return method_counters()->interpreter_invocation_count();
389 }
390 }
391 void set_prev_event_count(int count) {
392 MethodCounters* mcs = method_counters();
393 if (mcs != NULL) {
394 mcs->set_interpreter_invocation_count(count);
395 }
396 }
397 jlong prev_time() const {
398 MethodCounters* mcs = method_counters();
399 return mcs == NULL ? 0 : mcs->prev_time();
400 }
401 void set_prev_time(jlong time) {
402 MethodCounters* mcs = method_counters();
403 if (mcs != NULL) {
404 mcs->set_prev_time(time);
405 }
406 }
407 float rate() const {
408 MethodCounters* mcs = method_counters();
409 return mcs == NULL ? 0 : mcs->rate();
410 }
411 void set_rate(float rate) {
412 MethodCounters* mcs = method_counters();
413 if (mcs != NULL) {
414 mcs->set_rate(rate);
415 }
416 }
417 #endif
419 int invocation_count();
420 int backedge_count();
422 bool was_executed_more_than(int n);
423 bool was_never_executed() { return !was_executed_more_than(0); }
425 static void build_interpreter_method_data(methodHandle method, TRAPS);
427 static MethodCounters* build_method_counters(Method* m, TRAPS);
429 int interpreter_invocation_count() {
430 if (TieredCompilation) {
431 return invocation_count();
432 } else {
433 MethodCounters* mcs = method_counters();
434 return (mcs == NULL) ? 0 : mcs->interpreter_invocation_count();
435 }
436 }
437 int increment_interpreter_invocation_count(TRAPS) {
438 if (TieredCompilation) ShouldNotReachHere();
439 MethodCounters* mcs = get_method_counters(CHECK_0);
440 return (mcs == NULL) ? 0 : mcs->increment_interpreter_invocation_count();
441 }
443 #ifndef PRODUCT
444 int compiled_invocation_count() const { return _compiled_invocation_count; }
445 void set_compiled_invocation_count(int count) { _compiled_invocation_count = count; }
446 #endif // not PRODUCT
448 // Clear (non-shared space) pointers which could not be relevant
449 // if this (shared) method were mapped into another JVM.
450 void remove_unshareable_info();
452 // nmethod/verified compiler entry
453 address verified_code_entry();
454 bool check_code() const; // Not inline to avoid circular ref
455 nmethod* volatile code() const { assert( check_code(), "" ); return (nmethod *)OrderAccess::load_ptr_acquire(&_code); }
456 void clear_code(); // Clear out any compiled code
457 static void set_code(methodHandle mh, nmethod* code);
458 void set_adapter_entry(AdapterHandlerEntry* adapter) { _adapter = adapter; }
459 address get_i2c_entry();
460 address get_c2i_entry();
461 address get_c2i_unverified_entry();
462 AdapterHandlerEntry* adapter() { return _adapter; }
463 // setup entry points
464 void link_method(methodHandle method, TRAPS);
465 // clear entry points. Used by sharing code
466 void unlink_method();
468 // vtable index
469 enum VtableIndexFlag {
470 // Valid vtable indexes are non-negative (>= 0).
471 // These few negative values are used as sentinels.
472 itable_index_max = -10, // first itable index, growing downward
473 pending_itable_index = -9, // itable index will be assigned
474 invalid_vtable_index = -4, // distinct from any valid vtable index
475 garbage_vtable_index = -3, // not yet linked; no vtable layout yet
476 nonvirtual_vtable_index = -2 // there is no need for vtable dispatch
477 // 6330203 Note: Do not use -1, which was overloaded with many meanings.
478 };
479 DEBUG_ONLY(bool valid_vtable_index() const { return _vtable_index >= nonvirtual_vtable_index; })
480 bool has_vtable_index() const { return _vtable_index >= 0; }
481 int vtable_index() const { return _vtable_index; }
482 void set_vtable_index(int index) { _vtable_index = index; }
483 DEBUG_ONLY(bool valid_itable_index() const { return _vtable_index <= pending_itable_index; })
484 bool has_itable_index() const { return _vtable_index <= itable_index_max; }
485 int itable_index() const { assert(valid_itable_index(), "");
486 return itable_index_max - _vtable_index; }
487 void set_itable_index(int index) { _vtable_index = itable_index_max - index; assert(valid_itable_index(), ""); }
489 // interpreter entry
490 address interpreter_entry() const { return _i2i_entry; }
491 // Only used when first initialize so we can set _i2i_entry and _from_interpreted_entry
492 void set_interpreter_entry(address entry) { _i2i_entry = entry; _from_interpreted_entry = entry; }
494 // native function (used for native methods only)
495 enum {
496 native_bind_event_is_interesting = true
497 };
498 address native_function() const { return *(native_function_addr()); }
499 address critical_native_function();
501 // Must specify a real function (not NULL).
502 // Use clear_native_function() to unregister.
503 void set_native_function(address function, bool post_event_flag);
504 bool has_native_function() const;
505 void clear_native_function();
507 // signature handler (used for native methods only)
508 address signature_handler() const { return *(signature_handler_addr()); }
509 void set_signature_handler(address handler);
511 // Interpreter oopmap support
512 void mask_for(int bci, InterpreterOopMap* mask);
514 #ifndef PRODUCT
515 // operations on invocation counter
516 void print_invocation_count();
517 #endif
519 // byte codes
520 void set_code(address code) { return constMethod()->set_code(code); }
521 address code_base() const { return constMethod()->code_base(); }
522 bool contains(address bcp) const { return constMethod()->contains(bcp); }
524 // prints byte codes
525 void print_codes() const { print_codes_on(tty); }
526 void print_codes_on(outputStream* st) const PRODUCT_RETURN;
527 void print_codes_on(int from, int to, outputStream* st) const PRODUCT_RETURN;
529 // method parameters
530 bool has_method_parameters() const
531 { return constMethod()->has_method_parameters(); }
532 int method_parameters_length() const
533 { return constMethod()->method_parameters_length(); }
534 MethodParametersElement* method_parameters_start() const
535 { return constMethod()->method_parameters_start(); }
537 // checked exceptions
538 int checked_exceptions_length() const
539 { return constMethod()->checked_exceptions_length(); }
540 CheckedExceptionElement* checked_exceptions_start() const
541 { return constMethod()->checked_exceptions_start(); }
543 // localvariable table
544 bool has_localvariable_table() const
545 { return constMethod()->has_localvariable_table(); }
546 int localvariable_table_length() const
547 { return constMethod()->localvariable_table_length(); }
548 LocalVariableTableElement* localvariable_table_start() const
549 { return constMethod()->localvariable_table_start(); }
551 bool has_linenumber_table() const
552 { return constMethod()->has_linenumber_table(); }
553 u_char* compressed_linenumber_table() const
554 { return constMethod()->compressed_linenumber_table(); }
556 // method holder (the Klass* holding this method)
557 InstanceKlass* method_holder() const { return constants()->pool_holder(); }
559 void compute_size_of_parameters(Thread *thread); // word size of parameters (receiver if any + arguments)
560 Symbol* klass_name() const; // returns the name of the method holder
561 BasicType result_type() const; // type of the method result
562 int result_type_index() const; // type index of the method result
563 bool is_returning_oop() const { BasicType r = result_type(); return (r == T_OBJECT || r == T_ARRAY); }
564 bool is_returning_fp() const { BasicType r = result_type(); return (r == T_FLOAT || r == T_DOUBLE); }
566 // Checked exceptions thrown by this method (resolved to mirrors)
567 objArrayHandle resolved_checked_exceptions(TRAPS) { return resolved_checked_exceptions_impl(this, THREAD); }
569 // Access flags
570 bool is_public() const { return access_flags().is_public(); }
571 bool is_private() const { return access_flags().is_private(); }
572 bool is_protected() const { return access_flags().is_protected(); }
573 bool is_package_private() const { return !is_public() && !is_private() && !is_protected(); }
574 bool is_static() const { return access_flags().is_static(); }
575 bool is_final() const { return access_flags().is_final(); }
576 bool is_synchronized() const { return access_flags().is_synchronized();}
577 bool is_native() const { return access_flags().is_native(); }
578 bool is_abstract() const { return access_flags().is_abstract(); }
579 bool is_strict() const { return access_flags().is_strict(); }
580 bool is_synthetic() const { return access_flags().is_synthetic(); }
582 // returns true if contains only return operation
583 bool is_empty_method() const;
585 // returns true if this is a vanilla constructor
586 bool is_vanilla_constructor() const;
588 // checks method and its method holder
589 bool is_final_method() const;
590 bool is_final_method(AccessFlags class_access_flags) const;
591 bool is_default_method() const;
593 // true if method needs no dynamic dispatch (final and/or no vtable entry)
594 bool can_be_statically_bound() const;
595 bool can_be_statically_bound(AccessFlags class_access_flags) const;
597 // returns true if the method has any backward branches.
598 bool has_loops() {
599 return access_flags().loops_flag_init() ? access_flags().has_loops() : compute_has_loops_flag();
600 };
602 bool compute_has_loops_flag();
604 bool has_jsrs() {
605 return access_flags().has_jsrs();
606 };
607 void set_has_jsrs() {
608 _access_flags.set_has_jsrs();
609 }
611 // returns true if the method has any monitors.
612 bool has_monitors() const { return is_synchronized() || access_flags().has_monitor_bytecodes(); }
613 bool has_monitor_bytecodes() const { return access_flags().has_monitor_bytecodes(); }
615 void set_has_monitor_bytecodes() { _access_flags.set_has_monitor_bytecodes(); }
617 // monitor matching. This returns a conservative estimate of whether the monitorenter/monitorexit bytecodes
618 // propererly nest in the method. It might return false, even though they actually nest properly, since the info.
619 // has not been computed yet.
620 bool guaranteed_monitor_matching() const { return access_flags().is_monitor_matching(); }
621 void set_guaranteed_monitor_matching() { _access_flags.set_monitor_matching(); }
623 // returns true if the method is an accessor function (setter/getter).
624 bool is_accessor() const;
626 // returns true if the method does nothing but return a constant of primitive type
627 bool is_constant_getter() const;
629 // returns true if the method is an initializer (<init> or <clinit>).
630 bool is_initializer() const;
632 // returns true if the method is static OR if the classfile version < 51
633 bool has_valid_initializer_flags() const;
635 // returns true if the method name is <clinit> and the method has
636 // valid static initializer flags.
637 bool is_static_initializer() const;
639 // compiled code support
640 // NOTE: code() is inherently racy as deopt can be clearing code
641 // simultaneously. Use with caution.
642 bool has_compiled_code() const { return code() != NULL; }
644 // sizing
645 static int header_size() { return sizeof(Method)/HeapWordSize; }
646 static int size(bool is_native);
647 int size() const { return method_size(); }
648 #if INCLUDE_SERVICES
649 void collect_statistics(KlassSizeStats *sz) const;
650 #endif
652 // interpreter support
653 static ByteSize const_offset() { return byte_offset_of(Method, _constMethod ); }
654 static ByteSize access_flags_offset() { return byte_offset_of(Method, _access_flags ); }
655 #ifdef CC_INTERP
656 static ByteSize result_index_offset() { return byte_offset_of(Method, _result_index ); }
657 #endif /* CC_INTERP */
658 static ByteSize from_compiled_offset() { return byte_offset_of(Method, _from_compiled_entry); }
659 static ByteSize code_offset() { return byte_offset_of(Method, _code); }
660 static ByteSize method_data_offset() {
661 return byte_offset_of(Method, _method_data);
662 }
663 static ByteSize method_counters_offset() {
664 return byte_offset_of(Method, _method_counters);
665 }
666 #ifndef PRODUCT
667 static ByteSize compiled_invocation_counter_offset() { return byte_offset_of(Method, _compiled_invocation_count); }
668 #endif // not PRODUCT
669 static ByteSize native_function_offset() { return in_ByteSize(sizeof(Method)); }
670 static ByteSize from_interpreted_offset() { return byte_offset_of(Method, _from_interpreted_entry ); }
671 static ByteSize interpreter_entry_offset() { return byte_offset_of(Method, _i2i_entry ); }
672 static ByteSize signature_handler_offset() { return in_ByteSize(sizeof(Method) + wordSize); }
674 // for code generation
675 static int method_data_offset_in_bytes() { return offset_of(Method, _method_data); }
676 static int intrinsic_id_offset_in_bytes() { return offset_of(Method, _intrinsic_id); }
677 static int intrinsic_id_size_in_bytes() { return sizeof(u1); }
679 // Static methods that are used to implement member methods where an exposed this pointer
680 // is needed due to possible GCs
681 static objArrayHandle resolved_checked_exceptions_impl(Method* this_oop, TRAPS);
683 // Returns the byte code index from the byte code pointer
684 int bci_from(address bcp) const;
685 address bcp_from(int bci) const;
686 int validate_bci_from_bcx(intptr_t bcx) const;
688 // Returns the line number for a bci if debugging information for the method is prowided,
689 // -1 is returned otherwise.
690 int line_number_from_bci(int bci) const;
692 // Reflection support
693 bool is_overridden_in(Klass* k) const;
695 // Stack walking support
696 bool is_ignored_by_security_stack_walk() const;
698 // JSR 292 support
699 bool is_method_handle_intrinsic() const; // MethodHandles::is_signature_polymorphic_intrinsic(intrinsic_id)
700 bool is_compiled_lambda_form() const; // intrinsic_id() == vmIntrinsics::_compiledLambdaForm
701 bool has_member_arg() const; // intrinsic_id() == vmIntrinsics::_linkToSpecial, etc.
702 static methodHandle make_method_handle_intrinsic(vmIntrinsics::ID iid, // _invokeBasic, _linkToVirtual
703 Symbol* signature, //anything at all
704 TRAPS);
705 static Klass* check_non_bcp_klass(Klass* klass);
707 // How many extra stack entries for invokedynamic when it's enabled
708 static const int extra_stack_entries_for_jsr292 = 1;
710 // this operates only on invoke methods:
711 // presize interpreter frames for extra interpreter stack entries, if needed
712 // Account for the extra appendix argument for invokehandle/invokedynamic
713 static int extra_stack_entries() { return EnableInvokeDynamic ? extra_stack_entries_for_jsr292 : 0; }
714 static int extra_stack_words(); // = extra_stack_entries() * Interpreter::stackElementSize
716 // RedefineClasses() support:
717 bool is_old() const { return access_flags().is_old(); }
718 void set_is_old() { _access_flags.set_is_old(); }
719 bool is_obsolete() const { return access_flags().is_obsolete(); }
720 void set_is_obsolete() { _access_flags.set_is_obsolete(); }
721 bool is_deleted() const { return access_flags().is_deleted(); }
722 void set_is_deleted() { _access_flags.set_is_deleted(); }
723 bool on_stack() const { return access_flags().on_stack(); }
724 void set_on_stack(const bool value);
726 // see the definition in Method*.cpp for the gory details
727 bool should_not_be_cached() const;
729 // JVMTI Native method prefixing support:
730 bool is_prefixed_native() const { return access_flags().is_prefixed_native(); }
731 void set_is_prefixed_native() { _access_flags.set_is_prefixed_native(); }
733 // Rewriting support
734 static methodHandle clone_with_new_data(methodHandle m, u_char* new_code, int new_code_length,
735 u_char* new_compressed_linenumber_table, int new_compressed_linenumber_size, TRAPS);
737 // jmethodID handling
738 // Because the useful life-span of a jmethodID cannot be determined,
739 // once created they are never reclaimed. The methods to which they refer,
740 // however, can be GC'ed away if the class is unloaded or if the method is
741 // made obsolete or deleted -- in these cases, the jmethodID
742 // refers to NULL (as is the case for any weak reference).
743 static jmethodID make_jmethod_id(ClassLoaderData* loader_data, Method* mh);
744 static void destroy_jmethod_id(ClassLoaderData* loader_data, jmethodID mid);
746 // Use resolve_jmethod_id() in situations where the caller is expected
747 // to provide a valid jmethodID; the only sanity checks are in asserts;
748 // result guaranteed not to be NULL.
749 inline static Method* resolve_jmethod_id(jmethodID mid) {
750 assert(mid != NULL, "JNI method id should not be null");
751 return *((Method**)mid);
752 }
754 // Use checked_resolve_jmethod_id() in situations where the caller
755 // should provide a valid jmethodID, but might not. NULL is returned
756 // when the jmethodID does not refer to a valid method.
757 static Method* checked_resolve_jmethod_id(jmethodID mid);
759 static void change_method_associated_with_jmethod_id(jmethodID old_jmid_ptr, Method* new_method);
760 static bool is_method_id(jmethodID mid);
762 // Clear methods
763 static void clear_jmethod_ids(ClassLoaderData* loader_data);
764 static void print_jmethod_ids(ClassLoaderData* loader_data, outputStream* out) PRODUCT_RETURN;
766 // Get this method's jmethodID -- allocate if it doesn't exist
767 jmethodID jmethod_id() { methodHandle this_h(this);
768 return InstanceKlass::get_jmethod_id(method_holder(), this_h); }
770 // Lookup the jmethodID for this method. Return NULL if not found.
771 // NOTE that this function can be called from a signal handler
772 // (see AsyncGetCallTrace support for Forte Analyzer) and this
773 // needs to be async-safe. No allocation should be done and
774 // so handles are not used to avoid deadlock.
775 jmethodID find_jmethod_id_or_null() { return method_holder()->jmethod_id_or_null(this); }
777 // Support for inlining of intrinsic methods
778 vmIntrinsics::ID intrinsic_id() const { return (vmIntrinsics::ID) _intrinsic_id; }
779 void set_intrinsic_id(vmIntrinsics::ID id) { _intrinsic_id = (u1) id; }
781 // Helper routines for intrinsic_id() and vmIntrinsics::method().
782 void init_intrinsic_id(); // updates from _none if a match
783 static vmSymbols::SID klass_id_for_intrinsics(Klass* holder);
785 bool jfr_towrite() { return _jfr_towrite; }
786 void set_jfr_towrite(bool x) { _jfr_towrite = x; }
787 bool caller_sensitive() { return _caller_sensitive; }
788 void set_caller_sensitive(bool x) { _caller_sensitive = x; }
789 bool force_inline() { return _force_inline; }
790 void set_force_inline(bool x) { _force_inline = x; }
791 bool dont_inline() { return _dont_inline; }
792 void set_dont_inline(bool x) { _dont_inline = x; }
793 bool is_hidden() { return _hidden; }
794 void set_hidden(bool x) { _hidden = x; }
795 bool has_injected_profile() { return _has_injected_profile; }
796 void set_has_injected_profile(bool x) { _has_injected_profile = x; }
798 ConstMethod::MethodType method_type() const {
799 return _constMethod->method_type();
800 }
801 bool is_overpass() const { return method_type() == ConstMethod::OVERPASS; }
803 // On-stack replacement support
804 bool has_osr_nmethod(int level, bool match_level) {
805 return method_holder()->lookup_osr_nmethod(this, InvocationEntryBci, level, match_level) != NULL;
806 }
808 int mark_osr_nmethods() {
809 return method_holder()->mark_osr_nmethods(this);
810 }
812 nmethod* lookup_osr_nmethod_for(int bci, int level, bool match_level) {
813 return method_holder()->lookup_osr_nmethod(this, bci, level, match_level);
814 }
816 // Inline cache support
817 void cleanup_inline_caches();
819 // Find if klass for method is loaded
820 bool is_klass_loaded_by_klass_index(int klass_index) const;
821 bool is_klass_loaded(int refinfo_index, bool must_be_resolved = false) const;
823 // Indicates whether compilation failed earlier for this method, or
824 // whether it is not compilable for another reason like having a
825 // breakpoint set in it.
826 bool is_not_compilable(int comp_level = CompLevel_any) const;
827 void set_not_compilable(int comp_level = CompLevel_all, bool report = true, const char* reason = NULL);
828 void set_not_compilable_quietly(int comp_level = CompLevel_all) {
829 set_not_compilable(comp_level, false);
830 }
831 bool is_not_osr_compilable(int comp_level = CompLevel_any) const;
832 void set_not_osr_compilable(int comp_level = CompLevel_all, bool report = true, const char* reason = NULL);
833 void set_not_osr_compilable_quietly(int comp_level = CompLevel_all) {
834 set_not_osr_compilable(comp_level, false);
835 }
836 bool is_always_compilable() const;
838 private:
839 void print_made_not_compilable(int comp_level, bool is_osr, bool report, const char* reason);
841 public:
842 MethodCounters* get_method_counters(TRAPS) {
843 if (_method_counters == NULL) {
844 build_method_counters(this, CHECK_AND_CLEAR_NULL);
845 }
846 return _method_counters;
847 }
849 bool is_not_c1_compilable() const { return access_flags().is_not_c1_compilable(); }
850 void set_not_c1_compilable() { _access_flags.set_not_c1_compilable(); }
851 void clear_not_c1_compilable() { _access_flags.clear_not_c1_compilable(); }
852 bool is_not_c2_compilable() const { return access_flags().is_not_c2_compilable(); }
853 void set_not_c2_compilable() { _access_flags.set_not_c2_compilable(); }
854 void clear_not_c2_compilable() { _access_flags.clear_not_c2_compilable(); }
856 bool is_not_c1_osr_compilable() const { return is_not_c1_compilable(); } // don't waste an accessFlags bit
857 void set_not_c1_osr_compilable() { set_not_c1_compilable(); } // don't waste an accessFlags bit
858 void clear_not_c1_osr_compilable() { clear_not_c1_compilable(); } // don't waste an accessFlags bit
859 bool is_not_c2_osr_compilable() const { return access_flags().is_not_c2_osr_compilable(); }
860 void set_not_c2_osr_compilable() { _access_flags.set_not_c2_osr_compilable(); }
861 void clear_not_c2_osr_compilable() { _access_flags.clear_not_c2_osr_compilable(); }
863 // Background compilation support
864 bool queued_for_compilation() const { return access_flags().queued_for_compilation(); }
865 void set_queued_for_compilation() { _access_flags.set_queued_for_compilation(); }
866 void clear_queued_for_compilation() { _access_flags.clear_queued_for_compilation(); }
868 // Resolve all classes in signature, return 'true' if successful
869 static bool load_signature_classes(methodHandle m, TRAPS);
871 // Return if true if not all classes references in signature, including return type, has been loaded
872 static bool has_unloaded_classes_in_signature(methodHandle m, TRAPS);
874 // Printing
875 void print_short_name(outputStream* st = tty); // prints as klassname::methodname; Exposed so field engineers can debug VM
876 #if INCLUDE_JVMTI
877 void print_name(outputStream* st = tty); // prints as "virtual void foo(int)"; exposed for TraceRedefineClasses
878 #else
879 void print_name(outputStream* st = tty) PRODUCT_RETURN; // prints as "virtual void foo(int)"
880 #endif
882 // Helper routine used for method sorting
883 static void sort_methods(Array<Method*>* methods, bool idempotent = false, bool set_idnums = true);
885 // Deallocation function for redefine classes or if an error occurs
886 void deallocate_contents(ClassLoaderData* loader_data);
888 // Printing
889 #ifndef PRODUCT
890 void print_on(outputStream* st) const;
891 #endif
892 void print_value_on(outputStream* st) const;
894 const char* internal_name() const { return "{method}"; }
896 // Check for valid method pointer
897 static bool has_method_vptr(const void* ptr);
898 bool is_valid_method() const;
900 // Verify
901 void verify() { verify_on(tty); }
902 void verify_on(outputStream* st);
904 private:
906 // Inlined elements
907 address* native_function_addr() const { assert(is_native(), "must be native"); return (address*) (this+1); }
908 address* signature_handler_addr() const { return native_function_addr() + 1; }
909 };
912 // Utility class for compressing line number tables
914 class CompressedLineNumberWriteStream: public CompressedWriteStream {
915 private:
916 int _bci;
917 int _line;
918 public:
919 // Constructor
920 CompressedLineNumberWriteStream(int initial_size) : CompressedWriteStream(initial_size), _bci(0), _line(0) {}
921 CompressedLineNumberWriteStream(u_char* buffer, int initial_size) : CompressedWriteStream(buffer, initial_size), _bci(0), _line(0) {}
923 // Write (bci, line number) pair to stream
924 void write_pair_regular(int bci_delta, int line_delta);
926 inline void write_pair_inline(int bci, int line) {
927 int bci_delta = bci - _bci;
928 int line_delta = line - _line;
929 _bci = bci;
930 _line = line;
931 // Skip (0,0) deltas - they do not add information and conflict with terminator.
932 if (bci_delta == 0 && line_delta == 0) return;
933 // Check if bci is 5-bit and line number 3-bit unsigned.
934 if (((bci_delta & ~0x1F) == 0) && ((line_delta & ~0x7) == 0)) {
935 // Compress into single byte.
936 jubyte value = ((jubyte) bci_delta << 3) | (jubyte) line_delta;
937 // Check that value doesn't match escape character.
938 if (value != 0xFF) {
939 write_byte(value);
940 return;
941 }
942 }
943 write_pair_regular(bci_delta, line_delta);
944 }
946 // Windows AMD64 + Apr 2005 PSDK with /O2 generates bad code for write_pair.
947 // Disabling optimization doesn't work for methods in header files
948 // so we force it to call through the non-optimized version in the .cpp.
949 // It's gross, but it's the only way we can ensure that all callers are
950 // fixed. _MSC_VER is defined by the windows compiler
951 #if defined(_M_AMD64) && _MSC_VER >= 1400
952 void write_pair(int bci, int line);
953 #else
954 void write_pair(int bci, int line) { write_pair_inline(bci, line); }
955 #endif
957 // Write end-of-stream marker
958 void write_terminator() { write_byte(0); }
959 };
962 // Utility class for decompressing line number tables
964 class CompressedLineNumberReadStream: public CompressedReadStream {
965 private:
966 int _bci;
967 int _line;
968 public:
969 // Constructor
970 CompressedLineNumberReadStream(u_char* buffer);
971 // Read (bci, line number) pair from stream. Returns false at end-of-stream.
972 bool read_pair();
973 // Accessing bci and line number (after calling read_pair)
974 int bci() const { return _bci; }
975 int line() const { return _line; }
976 };
979 /// Fast Breakpoints.
981 // If this structure gets more complicated (because bpts get numerous),
982 // move it into its own header.
984 // There is presently no provision for concurrent access
985 // to breakpoint lists, which is only OK for JVMTI because
986 // breakpoints are written only at safepoints, and are read
987 // concurrently only outside of safepoints.
989 class BreakpointInfo : public CHeapObj<mtClass> {
990 friend class VMStructs;
991 private:
992 Bytecodes::Code _orig_bytecode;
993 int _bci;
994 u2 _name_index; // of method
995 u2 _signature_index; // of method
996 BreakpointInfo* _next; // simple storage allocation
998 public:
999 BreakpointInfo(Method* m, int bci);
1001 // accessors
1002 Bytecodes::Code orig_bytecode() { return _orig_bytecode; }
1003 void set_orig_bytecode(Bytecodes::Code code) { _orig_bytecode = code; }
1004 int bci() { return _bci; }
1006 BreakpointInfo* next() const { return _next; }
1007 void set_next(BreakpointInfo* n) { _next = n; }
1009 // helps for searchers
1010 bool match(const Method* m, int bci) {
1011 return bci == _bci && match(m);
1012 }
1014 bool match(const Method* m) {
1015 return _name_index == m->name_index() &&
1016 _signature_index == m->signature_index();
1017 }
1019 void set(Method* method);
1020 void clear(Method* method);
1021 };
1023 // Utility class for access exception handlers
1024 class ExceptionTable : public StackObj {
1025 private:
1026 ExceptionTableElement* _table;
1027 u2 _length;
1029 public:
1030 ExceptionTable(const Method* m) {
1031 if (m->has_exception_handler()) {
1032 _table = m->exception_table_start();
1033 _length = m->exception_table_length();
1034 } else {
1035 _table = NULL;
1036 _length = 0;
1037 }
1038 }
1040 int length() const {
1041 return _length;
1042 }
1044 u2 start_pc(int idx) const {
1045 assert(idx < _length, "out of bounds");
1046 return _table[idx].start_pc;
1047 }
1049 void set_start_pc(int idx, u2 value) {
1050 assert(idx < _length, "out of bounds");
1051 _table[idx].start_pc = value;
1052 }
1054 u2 end_pc(int idx) const {
1055 assert(idx < _length, "out of bounds");
1056 return _table[idx].end_pc;
1057 }
1059 void set_end_pc(int idx, u2 value) {
1060 assert(idx < _length, "out of bounds");
1061 _table[idx].end_pc = value;
1062 }
1064 u2 handler_pc(int idx) const {
1065 assert(idx < _length, "out of bounds");
1066 return _table[idx].handler_pc;
1067 }
1069 void set_handler_pc(int idx, u2 value) {
1070 assert(idx < _length, "out of bounds");
1071 _table[idx].handler_pc = value;
1072 }
1074 u2 catch_type_index(int idx) const {
1075 assert(idx < _length, "out of bounds");
1076 return _table[idx].catch_type_index;
1077 }
1079 void set_catch_type_index(int idx, u2 value) {
1080 assert(idx < _length, "out of bounds");
1081 _table[idx].catch_type_index = value;
1082 }
1083 };
1085 #endif // SHARE_VM_OOPS_METHODOOP_HPP