1 /*
2 * Copyright (c) 1997, 2018, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 *
23 */
24
25 #ifndef SHARE_VM_OOPS_METHODOOP_HPP
26 #define SHARE_VM_OOPS_METHODOOP_HPP
27
28 #include "classfile/vmSymbols.hpp"
29 #include "code/compressedStream.hpp"
30 #include "compiler/compilerDefinitions.hpp"
31 #include "compiler/oopMap.hpp"
32 #include "interpreter/invocationCounter.hpp"
33 #include "oops/annotations.hpp"
34 #include "oops/constantPool.hpp"
35 #include "oops/methodCounters.hpp"
36 #include "oops/instanceKlass.hpp"
37 #include "oops/oop.hpp"
38 #include "oops/typeArrayOop.hpp"
39 #include "utilities/accessFlags.hpp"
40 #include "utilities/align.hpp"
41 #include "utilities/growableArray.hpp"
42 #include "utilities/macros.hpp"
43 #if INCLUDE_JFR
44 #include "jfr/support/jfrTraceIdExtension.hpp"
45 #endif
46
47
48 // A Method represents a Java method.
49 //
50 // Note that most applications load thousands of methods, so keeping the size of this
51 // class small has a big impact on footprint.
52 //
53 // Note that native_function and signature_handler have to be at fixed offsets
54 // (required by the interpreter)
55 //
56 // Method embedded field layout (after declared fields):
57 // [EMBEDDED native_function (present only if native) ]
58 // [EMBEDDED signature_handler (present only if native) ]
59
60 class CheckedExceptionElement;
61 class LocalVariableTableElement;
62 class AdapterHandlerEntry;
63 class MethodData;
64 class MethodCounters;
65 class ConstMethod;
66 class InlineTableSizes;
67 class KlassSizeStats;
68 class CompiledMethod;
69
70 class Method : public Metadata {
71 friend class VMStructs;
72 friend class JVMCIVMStructs;
73 private:
74 // If you add a new field that points to any metaspace object, you
75 // must add this field to Method::metaspace_pointers_do().
76 ConstMethod* _constMethod; // Method read-only data.
77 MethodData* _method_data;
78 MethodCounters* _method_counters;
79 AccessFlags _access_flags; // Access flags
80 int _vtable_index; // vtable index of this method (see VtableIndexFlag)
81 // note: can have vtables with >2**16 elements (because of inheritance)
82 u2 _intrinsic_id; // vmSymbols::intrinsic_id (0 == _none)
83
84 // Flags
85 enum Flags {
86 _caller_sensitive = 1 << 0,
87 _force_inline = 1 << 1,
88 _dont_inline = 1 << 2,
89 _hidden = 1 << 3,
90 _has_injected_profile = 1 << 4,
91 _running_emcp = 1 << 5,
92 _intrinsic_candidate = 1 << 6,
93 _reserved_stack_access = 1 << 7,
94 _is_returning_vt = 1 << 8
95 };
96 mutable u2 _flags;
97
98 JFR_ONLY(DEFINE_TRACE_FLAG;)
99
100 #ifndef PRODUCT
101 int _compiled_invocation_count; // Number of nmethod invocations so far (for perf. debugging)
102 #endif
103 // Entry point for calling both from and to the interpreter.
104 address _i2i_entry; // All-args-on-stack calling convention
105 // Entry point for calling from compiled code, to compiled code if it exists
106 // or else the interpreter.
107 volatile address _from_compiled_entry; // Cache of: _code ? _code->entry_point() : _adapter->c2i_entry()
108 // The entry point for calling both from and to compiled code is
109 // "_code->entry_point()". Because of tiered compilation and de-opt, this
110 // field can come and go. It can transition from NULL to not-null at any
111 // time (whenever a compile completes). It can transition from not-null to
112 // NULL only at safepoints (because of a de-opt).
113 CompiledMethod* volatile _code; // Points to the corresponding piece of native code
114 volatile address _from_interpreted_entry; // Cache of _code ? _adapter->i2c_entry() : _i2i_entry
115 int _max_vt_buffer; // max number of VT buffer chunk to use before recycling
116
117 #if INCLUDE_AOT && defined(TIERED)
118 CompiledMethod* _aot_code;
119 #endif
120
121 // Constructor
122 Method(ConstMethod* xconst, AccessFlags access_flags);
123 public:
124
125 static Method* allocate(ClassLoaderData* loader_data,
126 int byte_code_size,
127 AccessFlags access_flags,
128 InlineTableSizes* sizes,
129 ConstMethod::MethodType method_type,
130 TRAPS);
131
132 // CDS and vtbl checking can create an empty Method to get vtbl pointer.
133 Method(){}
134
135 bool is_method() const volatile { return true; }
136
137 void restore_unshareable_info(TRAPS);
138
139 // accessors for instance variables
140
141 ConstMethod* constMethod() const { return _constMethod; }
142 void set_constMethod(ConstMethod* xconst) { _constMethod = xconst; }
143
144
145 static address make_adapters(const methodHandle& mh, TRAPS);
146 address from_compiled_entry() const;
147 address from_compiled_entry_no_trampoline() const;
148 address from_interpreted_entry() const;
149
150 // access flag
151 AccessFlags access_flags() const { return _access_flags; }
152 void set_access_flags(AccessFlags flags) { _access_flags = flags; }
153
154 // name
155 Symbol* name() const { return constants()->symbol_at(name_index()); }
156 int name_index() const { return constMethod()->name_index(); }
157 void set_name_index(int index) { constMethod()->set_name_index(index); }
158
159 // signature
160 Symbol* signature() const { return constants()->symbol_at(signature_index()); }
161 int signature_index() const { return constMethod()->signature_index(); }
162 void set_signature_index(int index) { constMethod()->set_signature_index(index); }
163
164 // generics support
165 Symbol* generic_signature() const { int idx = generic_signature_index(); return ((idx != 0) ? constants()->symbol_at(idx) : (Symbol*)NULL); }
166 int generic_signature_index() const { return constMethod()->generic_signature_index(); }
167 void set_generic_signature_index(int index) { constMethod()->set_generic_signature_index(index); }
168
169 // annotations support
170 AnnotationArray* annotations() const {
171 return constMethod()->method_annotations();
172 }
173 AnnotationArray* parameter_annotations() const {
174 return constMethod()->parameter_annotations();
175 }
176 AnnotationArray* annotation_default() const {
177 return constMethod()->default_annotations();
178 }
179 AnnotationArray* type_annotations() const {
180 return constMethod()->type_annotations();
181 }
182
183 // Helper routine: get klass name + "." + method name + signature as
184 // C string, for the purpose of providing more useful NoSuchMethodErrors
185 // and fatal error handling. The string is allocated in resource
186 // area if a buffer is not provided by the caller.
187 char* name_and_sig_as_C_string() const;
188 char* name_and_sig_as_C_string(char* buf, int size) const;
189
190 // Static routine in the situations we don't have a Method*
191 static char* name_and_sig_as_C_string(Klass* klass, Symbol* method_name, Symbol* signature);
192 static char* name_and_sig_as_C_string(Klass* klass, Symbol* method_name, Symbol* signature, char* buf, int size);
193
194 Bytecodes::Code java_code_at(int bci) const {
195 return Bytecodes::java_code_at(this, bcp_from(bci));
196 }
197 Bytecodes::Code code_at(int bci) const {
198 return Bytecodes::code_at(this, bcp_from(bci));
199 }
200
201 // JVMTI breakpoints
202 #if !INCLUDE_JVMTI
203 Bytecodes::Code orig_bytecode_at(int bci) const {
204 ShouldNotReachHere();
205 return Bytecodes::_shouldnotreachhere;
206 }
207 void set_orig_bytecode_at(int bci, Bytecodes::Code code) {
208 ShouldNotReachHere();
209 };
210 u2 number_of_breakpoints() const {return 0;}
211 #else // !INCLUDE_JVMTI
212 Bytecodes::Code orig_bytecode_at(int bci) const;
213 void set_orig_bytecode_at(int bci, Bytecodes::Code code);
214 void set_breakpoint(int bci);
215 void clear_breakpoint(int bci);
216 void clear_all_breakpoints();
217 // Tracking number of breakpoints, for fullspeed debugging.
218 // Only mutated by VM thread.
219 u2 number_of_breakpoints() const {
220 MethodCounters* mcs = method_counters();
221 if (mcs == NULL) {
222 return 0;
223 } else {
224 return mcs->number_of_breakpoints();
225 }
226 }
227 void incr_number_of_breakpoints(TRAPS) {
228 MethodCounters* mcs = get_method_counters(CHECK);
229 if (mcs != NULL) {
230 mcs->incr_number_of_breakpoints();
231 }
232 }
233 void decr_number_of_breakpoints(TRAPS) {
234 MethodCounters* mcs = get_method_counters(CHECK);
235 if (mcs != NULL) {
236 mcs->decr_number_of_breakpoints();
237 }
238 }
239 // Initialization only
240 void clear_number_of_breakpoints() {
241 MethodCounters* mcs = method_counters();
242 if (mcs != NULL) {
243 mcs->clear_number_of_breakpoints();
244 }
245 }
246 #endif // !INCLUDE_JVMTI
247
248 // index into InstanceKlass methods() array
249 // note: also used by jfr
250 u2 method_idnum() const { return constMethod()->method_idnum(); }
251 void set_method_idnum(u2 idnum) { constMethod()->set_method_idnum(idnum); }
252
253 u2 orig_method_idnum() const { return constMethod()->orig_method_idnum(); }
254 void set_orig_method_idnum(u2 idnum) { constMethod()->set_orig_method_idnum(idnum); }
255
256 // code size
257 int code_size() const { return constMethod()->code_size(); }
258
259 // method size in words
260 int method_size() const { return sizeof(Method)/wordSize + ( is_native() ? 2 : 0 ); }
261
262 // constant pool for Klass* holding this method
263 ConstantPool* constants() const { return constMethod()->constants(); }
264 void set_constants(ConstantPool* c) { constMethod()->set_constants(c); }
265
266 // max stack
267 // return original max stack size for method verification
268 int verifier_max_stack() const { return constMethod()->max_stack(); }
269 int max_stack() const { return constMethod()->max_stack() + extra_stack_entries(); }
270 void set_max_stack(int size) { constMethod()->set_max_stack(size); }
271
272 // max locals
273 int max_locals() const { return constMethod()->max_locals(); }
274 void set_max_locals(int size) { constMethod()->set_max_locals(size); }
275
276 // value type buffering
277 void initialize_max_vt_buffer();
278 int max_vt_buffer() const { return _max_vt_buffer; }
279 void set_max_vt_buffer(int size) { _max_vt_buffer = size; }
280
281
282 int highest_comp_level() const;
283 void set_highest_comp_level(int level);
284 int highest_osr_comp_level() const;
285 void set_highest_osr_comp_level(int level);
286
287 #if COMPILER2_OR_JVMCI
288 // Count of times method was exited via exception while interpreting
289 void interpreter_throwout_increment(TRAPS) {
290 MethodCounters* mcs = get_method_counters(CHECK);
291 if (mcs != NULL) {
292 mcs->interpreter_throwout_increment();
293 }
294 }
295 #endif
296
297 int interpreter_throwout_count() const {
298 MethodCounters* mcs = method_counters();
299 if (mcs == NULL) {
300 return 0;
301 } else {
302 return mcs->interpreter_throwout_count();
303 }
304 }
305
306 // size of parameters
307 int size_of_parameters() const { return constMethod()->size_of_parameters(); }
308 void set_size_of_parameters(int size) { constMethod()->set_size_of_parameters(size); }
309
310 bool has_stackmap_table() const {
311 return constMethod()->has_stackmap_table();
312 }
313
314 Array<u1>* stackmap_data() const {
315 return constMethod()->stackmap_data();
316 }
317
318 void set_stackmap_data(Array<u1>* sd) {
319 constMethod()->set_stackmap_data(sd);
320 }
321
322 // exception handler table
323 bool has_exception_handler() const
324 { return constMethod()->has_exception_handler(); }
325 int exception_table_length() const
326 { return constMethod()->exception_table_length(); }
327 ExceptionTableElement* exception_table_start() const
328 { return constMethod()->exception_table_start(); }
329
330 // Finds the first entry point bci of an exception handler for an
331 // exception of klass ex_klass thrown at throw_bci. A value of NULL
332 // for ex_klass indicates that the exception klass is not known; in
333 // this case it matches any constraint class. Returns -1 if the
334 // exception cannot be handled in this method. The handler
335 // constraint classes are loaded if necessary. Note that this may
336 // throw an exception if loading of the constraint classes causes
337 // an IllegalAccessError (bugid 4307310) or an OutOfMemoryError.
338 // If an exception is thrown, returns the bci of the
339 // exception handler which caused the exception to be thrown, which
340 // is needed for proper retries. See, for example,
341 // InterpreterRuntime::exception_handler_for_exception.
342 static int fast_exception_handler_bci_for(const methodHandle& mh, Klass* ex_klass, int throw_bci, TRAPS);
343
344 // method data access
345 MethodData* method_data() const {
346 return _method_data;
347 }
348
349 void set_method_data(MethodData* data);
350
351 MethodCounters* method_counters() const {
352 return _method_counters;
353 }
354
355 void clear_method_counters() {
356 _method_counters = NULL;
357 }
358
359 bool init_method_counters(MethodCounters* counters);
360
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 {
365 if (method_counters() == NULL) {
366 return 0;
367 } else {
368 return method_counters()->interpreter_invocation_count();
369 }
370 }
371 void set_prev_event_count(int count) {
372 MethodCounters* mcs = method_counters();
373 if (mcs != NULL) {
374 mcs->set_interpreter_invocation_count(count);
375 }
376 }
377 jlong prev_time() const {
378 MethodCounters* mcs = method_counters();
379 return mcs == NULL ? 0 : mcs->prev_time();
380 }
381 void set_prev_time(jlong time) {
382 MethodCounters* mcs = method_counters();
383 if (mcs != NULL) {
384 mcs->set_prev_time(time);
385 }
386 }
387 float rate() const {
388 MethodCounters* mcs = method_counters();
389 return mcs == NULL ? 0 : mcs->rate();
390 }
391 void set_rate(float rate) {
392 MethodCounters* mcs = method_counters();
393 if (mcs != NULL) {
394 mcs->set_rate(rate);
395 }
396 }
397
398 #if INCLUDE_AOT
399 void set_aot_code(CompiledMethod* aot_code) {
400 _aot_code = aot_code;
401 }
402
403 CompiledMethod* aot_code() const {
404 return _aot_code;
405 }
406 #else
407 CompiledMethod* aot_code() const { return NULL; }
408 #endif // INCLUDE_AOT
409 #endif // TIERED
410
411 int nmethod_age() const {
412 if (method_counters() == NULL) {
413 return INT_MAX;
414 } else {
415 return method_counters()->nmethod_age();
416 }
417 }
418
419 int invocation_count();
420 int backedge_count();
421
422 bool was_executed_more_than(int n);
423 bool was_never_executed() { return !was_executed_more_than(0); }
424
425 static void build_interpreter_method_data(const methodHandle& method, TRAPS);
426
427 static MethodCounters* build_method_counters(Method* m, TRAPS);
428
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 #if COMPILER2_OR_JVMCI
438 int increment_interpreter_invocation_count(TRAPS) {
439 if (TieredCompilation) ShouldNotReachHere();
440 MethodCounters* mcs = get_method_counters(CHECK_0);
441 return (mcs == NULL) ? 0 : mcs->increment_interpreter_invocation_count();
442 }
443 #endif
444
445 #ifndef PRODUCT
446 int compiled_invocation_count() const { return _compiled_invocation_count; }
447 void set_compiled_invocation_count(int count) { _compiled_invocation_count = count; }
448 #else
449 // for PrintMethodData in a product build
450 int compiled_invocation_count() const { return 0; }
451 #endif // not PRODUCT
452
453 // Clear (non-shared space) pointers which could not be relevant
454 // if this (shared) method were mapped into another JVM.
455 void remove_unshareable_info();
456
457 // nmethod/verified compiler entry
458 address verified_code_entry();
459 bool check_code() const; // Not inline to avoid circular ref
460 CompiledMethod* volatile code() const;
461 void clear_code(bool acquire_lock = true); // Clear out any compiled code
462 static void set_code(const methodHandle& mh, CompiledMethod* code);
463 void set_adapter_entry(AdapterHandlerEntry* adapter) {
464 constMethod()->set_adapter_entry(adapter);
465 }
466 void update_adapter_trampoline(AdapterHandlerEntry* adapter) {
467 constMethod()->update_adapter_trampoline(adapter);
468 }
469
470 address get_i2c_entry();
471 address get_c2i_entry();
472 address get_c2i_unverified_entry();
473 AdapterHandlerEntry* adapter() const {
474 return constMethod()->adapter();
475 }
476 // setup entry points
477 void link_method(const methodHandle& method, TRAPS);
478 // clear entry points. Used by sharing code during dump time
479 void unlink_method() NOT_CDS_RETURN;
480
481 virtual void metaspace_pointers_do(MetaspaceClosure* iter);
482 virtual MetaspaceObj::Type type() const { return MethodType; }
483
484 // vtable index
485 enum VtableIndexFlag {
486 // Valid vtable indexes are non-negative (>= 0).
487 // These few negative values are used as sentinels.
488 itable_index_max = -10, // first itable index, growing downward
489 pending_itable_index = -9, // itable index will be assigned
490 invalid_vtable_index = -4, // distinct from any valid vtable index
491 garbage_vtable_index = -3, // not yet linked; no vtable layout yet
492 nonvirtual_vtable_index = -2 // there is no need for vtable dispatch
493 // 6330203 Note: Do not use -1, which was overloaded with many meanings.
494 };
495 DEBUG_ONLY(bool valid_vtable_index() const { return _vtable_index >= nonvirtual_vtable_index; })
496 bool has_vtable_index() const { return _vtable_index >= 0; }
497 int vtable_index() const { return _vtable_index; }
498 void set_vtable_index(int index);
499 DEBUG_ONLY(bool valid_itable_index() const { return _vtable_index <= pending_itable_index; })
500 bool has_itable_index() const { return _vtable_index <= itable_index_max; }
501 int itable_index() const { assert(valid_itable_index(), "");
502 return itable_index_max - _vtable_index; }
503 void set_itable_index(int index);
504
505 // interpreter entry
506 address interpreter_entry() const { return _i2i_entry; }
507 // Only used when first initialize so we can set _i2i_entry and _from_interpreted_entry
508 void set_interpreter_entry(address entry) {
509 assert(!is_shared(), "shared method's interpreter entry should not be changed at run time");
510 if (_i2i_entry != entry) {
511 _i2i_entry = entry;
512 }
513 if (_from_interpreted_entry != entry) {
514 _from_interpreted_entry = entry;
515 }
516 }
517
518 // native function (used for native methods only)
519 enum {
520 native_bind_event_is_interesting = true
521 };
522 address native_function() const { return *(native_function_addr()); }
523 address critical_native_function();
524
525 // Must specify a real function (not NULL).
526 // Use clear_native_function() to unregister.
527 void set_native_function(address function, bool post_event_flag);
528 bool has_native_function() const;
529 void clear_native_function();
530
531 // signature handler (used for native methods only)
532 address signature_handler() const { return *(signature_handler_addr()); }
533 void set_signature_handler(address handler);
534
535 // Interpreter oopmap support
536 void mask_for(int bci, InterpreterOopMap* mask);
537
538 // operations on invocation counter
539 void print_invocation_count();
540
541 // byte codes
542 void set_code(address code) { return constMethod()->set_code(code); }
543 address code_base() const { return constMethod()->code_base(); }
544 bool contains(address bcp) const { return constMethod()->contains(bcp); }
545
546 // prints byte codes
547 void print_codes() const { print_codes_on(tty); }
548 void print_codes_on(outputStream* st) const;
549 void print_codes_on(int from, int to, outputStream* st) const;
550
551 // method parameters
552 bool has_method_parameters() const
553 { return constMethod()->has_method_parameters(); }
554 int method_parameters_length() const
555 { return constMethod()->method_parameters_length(); }
556 MethodParametersElement* method_parameters_start() const
557 { return constMethod()->method_parameters_start(); }
558
559 // checked exceptions
560 int checked_exceptions_length() const
561 { return constMethod()->checked_exceptions_length(); }
562 CheckedExceptionElement* checked_exceptions_start() const
563 { return constMethod()->checked_exceptions_start(); }
564
565 // localvariable table
566 bool has_localvariable_table() const
567 { return constMethod()->has_localvariable_table(); }
568 int localvariable_table_length() const
569 { return constMethod()->localvariable_table_length(); }
570 LocalVariableTableElement* localvariable_table_start() const
571 { return constMethod()->localvariable_table_start(); }
572
573 bool has_linenumber_table() const
574 { return constMethod()->has_linenumber_table(); }
575 u_char* compressed_linenumber_table() const
576 { return constMethod()->compressed_linenumber_table(); }
577
578 // method holder (the Klass* holding this method)
579 InstanceKlass* method_holder() const { return constants()->pool_holder(); }
580
581 void compute_size_of_parameters(Thread *thread); // word size of parameters (receiver if any + arguments)
582 Symbol* klass_name() const; // returns the name of the method holder
583 BasicType result_type() const; // type of the method result
584 bool may_return_oop() const { BasicType r = result_type(); return (r == T_OBJECT || r == T_ARRAY || r == T_VALUETYPE); }
585 #ifdef ASSERT
586 ValueKlass* returned_value_type(Thread* thread) const;
587 #endif
588
589 // Checked exceptions thrown by this method (resolved to mirrors)
590 objArrayHandle resolved_checked_exceptions(TRAPS) { return resolved_checked_exceptions_impl(this, THREAD); }
591
592 // Access flags
593 bool is_public() const { return access_flags().is_public(); }
594 bool is_private() const { return access_flags().is_private(); }
595 bool is_protected() const { return access_flags().is_protected(); }
596 bool is_package_private() const { return !is_public() && !is_private() && !is_protected(); }
597 bool is_static() const { return access_flags().is_static(); }
598 bool is_final() const { return access_flags().is_final(); }
599 bool is_synchronized() const { return access_flags().is_synchronized();}
600 bool is_native() const { return access_flags().is_native(); }
601 bool is_abstract() const { return access_flags().is_abstract(); }
602 bool is_strict() const { return access_flags().is_strict(); }
603 bool is_synthetic() const { return access_flags().is_synthetic(); }
604
605 // returns true if contains only return operation
606 bool is_empty_method() const;
607
608 // returns true if this is a vanilla constructor
609 bool is_vanilla_constructor() const;
610
611 // checks method and its method holder
612 bool is_final_method() const;
613 bool is_final_method(AccessFlags class_access_flags) const;
614 // interface method declared with 'default' - excludes private interface methods
615 bool is_default_method() const;
616
617 // true if method needs no dynamic dispatch (final and/or no vtable entry)
618 bool can_be_statically_bound() const;
619 bool can_be_statically_bound(AccessFlags class_access_flags) const;
620
621 // returns true if the method has any backward branches.
622 bool has_loops() {
623 return access_flags().loops_flag_init() ? access_flags().has_loops() : compute_has_loops_flag();
624 };
625
626 bool compute_has_loops_flag();
627
628 bool has_jsrs() {
629 return access_flags().has_jsrs();
630 };
631 void set_has_jsrs() {
632 _access_flags.set_has_jsrs();
633 }
634
635 // returns true if the method has any monitors.
636 bool has_monitors() const { return is_synchronized() || access_flags().has_monitor_bytecodes(); }
637 bool has_monitor_bytecodes() const { return access_flags().has_monitor_bytecodes(); }
638
639 void set_has_monitor_bytecodes() { _access_flags.set_has_monitor_bytecodes(); }
640
641 // monitor matching. This returns a conservative estimate of whether the monitorenter/monitorexit bytecodes
642 // propererly nest in the method. It might return false, even though they actually nest properly, since the info.
643 // has not been computed yet.
644 bool guaranteed_monitor_matching() const { return access_flags().is_monitor_matching(); }
645 void set_guaranteed_monitor_matching() { _access_flags.set_monitor_matching(); }
646
647 // returns true if the method is an accessor function (setter/getter).
648 bool is_accessor() const;
649
650 // returns true if the method is a getter
651 bool is_getter() const;
652
653 // returns true if the method is a setter
654 bool is_setter() const;
655
656 // returns true if the method does nothing but return a constant of primitive type
657 bool is_constant_getter() const;
658
659 // returns true if the method is an initializer (<init> or <clinit>).
660 bool is_initializer() const;
661
662 // returns true if the method is static OR if the classfile version < 51
663 bool has_valid_initializer_flags() const;
664
665 // returns true if the method name is <clinit> and the method has
666 // valid static initializer flags.
667 bool is_static_initializer() const;
668
669 // returns true if the method name is <init>
670 bool is_object_initializer() const;
671
672 // compiled code support
673 // NOTE: code() is inherently racy as deopt can be clearing code
674 // simultaneously. Use with caution.
675 bool has_compiled_code() const;
676
677 #ifdef TIERED
678 bool has_aot_code() const { return aot_code() != NULL; }
679 #endif
680
681 // sizing
682 static int header_size() {
683 return align_up((int)sizeof(Method), wordSize) / wordSize;
684 }
685 static int size(bool is_native);
686 int size() const { return method_size(); }
687 #if INCLUDE_SERVICES
688 void collect_statistics(KlassSizeStats *sz) const;
689 #endif
690 void log_touched(TRAPS);
691 static void print_touched_methods(outputStream* out);
692
693 // interpreter support
694 static ByteSize const_offset() { return byte_offset_of(Method, _constMethod ); }
695 static ByteSize access_flags_offset() { return byte_offset_of(Method, _access_flags ); }
696 static ByteSize from_compiled_offset() { return byte_offset_of(Method, _from_compiled_entry); }
697 static ByteSize code_offset() { return byte_offset_of(Method, _code); }
698 static ByteSize flags_offset() { return byte_offset_of(Method, _flags); }
699 static ByteSize method_data_offset() {
700 return byte_offset_of(Method, _method_data);
701 }
702 static ByteSize method_counters_offset() {
703 return byte_offset_of(Method, _method_counters);
704 }
705 #ifndef PRODUCT
706 static ByteSize compiled_invocation_counter_offset() { return byte_offset_of(Method, _compiled_invocation_count); }
707 #endif // not PRODUCT
708 static ByteSize native_function_offset() { return in_ByteSize(sizeof(Method)); }
709 static ByteSize from_interpreted_offset() { return byte_offset_of(Method, _from_interpreted_entry ); }
710 static ByteSize interpreter_entry_offset() { return byte_offset_of(Method, _i2i_entry ); }
711 static ByteSize signature_handler_offset() { return in_ByteSize(sizeof(Method) + wordSize); }
712 static ByteSize itable_index_offset() { return byte_offset_of(Method, _vtable_index ); }
713
714 // for code generation
715 static int method_data_offset_in_bytes() { return offset_of(Method, _method_data); }
716 static int intrinsic_id_offset_in_bytes() { return offset_of(Method, _intrinsic_id); }
717 static int intrinsic_id_size_in_bytes() { return sizeof(u2); }
718
719 static ByteSize max_vt_buffer_offset() { return byte_offset_of(Method, _max_vt_buffer); }
720
721 // Static methods that are used to implement member methods where an exposed this pointer
722 // is needed due to possible GCs
723 static objArrayHandle resolved_checked_exceptions_impl(Method* method, TRAPS);
724
725 // Returns the byte code index from the byte code pointer
726 int bci_from(address bcp) const;
727 address bcp_from(int bci) const;
728 address bcp_from(address bcp) const;
729 int validate_bci_from_bcp(address bcp) const;
730 int validate_bci(int bci) const;
731
732 // Returns the line number for a bci if debugging information for the method is prowided,
733 // -1 is returned otherwise.
734 int line_number_from_bci(int bci) const;
735
736 // Reflection support
737 bool is_overridden_in(Klass* k) const;
738
739 // Stack walking support
740 bool is_ignored_by_security_stack_walk() const;
741
742 // JSR 292 support
743 bool is_method_handle_intrinsic() const; // MethodHandles::is_signature_polymorphic_intrinsic(intrinsic_id)
744 bool is_compiled_lambda_form() const; // intrinsic_id() == vmIntrinsics::_compiledLambdaForm
745 bool has_member_arg() const; // intrinsic_id() == vmIntrinsics::_linkToSpecial, etc.
746 static methodHandle make_method_handle_intrinsic(vmIntrinsics::ID iid, // _invokeBasic, _linkToVirtual
747 Symbol* signature, //anything at all
748 TRAPS);
749 static Klass* check_non_bcp_klass(Klass* klass);
750
751 enum {
752 // How many extra stack entries for invokedynamic
753 extra_stack_entries_for_jsr292 = 1
754 };
755
756 // this operates only on invoke methods:
757 // presize interpreter frames for extra interpreter stack entries, if needed
758 // Account for the extra appendix argument for invokehandle/invokedynamic
759 static int extra_stack_entries() { return extra_stack_entries_for_jsr292; }
760 static int extra_stack_words(); // = extra_stack_entries() * Interpreter::stackElementSize
761
762 // RedefineClasses() support:
763 bool is_old() const { return access_flags().is_old(); }
764 void set_is_old() { _access_flags.set_is_old(); }
765 bool is_obsolete() const { return access_flags().is_obsolete(); }
766 void set_is_obsolete() { _access_flags.set_is_obsolete(); }
767 bool is_deleted() const { return access_flags().is_deleted(); }
768 void set_is_deleted() { _access_flags.set_is_deleted(); }
769
770 bool is_running_emcp() const {
771 // EMCP methods are old but not obsolete or deleted. Equivalent
772 // Modulo Constant Pool means the method is equivalent except
773 // the constant pool and instructions that access the constant
774 // pool might be different.
775 // If a breakpoint is set in a redefined method, its EMCP methods that are
776 // still running must have a breakpoint also.
777 return (_flags & _running_emcp) != 0;
778 }
779
780 void set_running_emcp(bool x) {
781 _flags = x ? (_flags | _running_emcp) : (_flags & ~_running_emcp);
782 }
783
784 bool on_stack() const { return access_flags().on_stack(); }
785 void set_on_stack(const bool value);
786
787 // see the definition in Method*.cpp for the gory details
788 bool should_not_be_cached() const;
789
790 // JVMTI Native method prefixing support:
791 bool is_prefixed_native() const { return access_flags().is_prefixed_native(); }
792 void set_is_prefixed_native() { _access_flags.set_is_prefixed_native(); }
793
794 // Rewriting support
795 static methodHandle clone_with_new_data(const methodHandle& m, u_char* new_code, int new_code_length,
796 u_char* new_compressed_linenumber_table, int new_compressed_linenumber_size, TRAPS);
797
798 // jmethodID handling
799 // Because the useful life-span of a jmethodID cannot be determined,
800 // once created they are never reclaimed. The methods to which they refer,
801 // however, can be GC'ed away if the class is unloaded or if the method is
802 // made obsolete or deleted -- in these cases, the jmethodID
803 // refers to NULL (as is the case for any weak reference).
804 static jmethodID make_jmethod_id(ClassLoaderData* loader_data, Method* mh);
805 static void destroy_jmethod_id(ClassLoaderData* loader_data, jmethodID mid);
806
807 // Ensure there is enough capacity in the internal tracking data
808 // structures to hold the number of jmethodIDs you plan to generate.
809 // This saves substantial time doing allocations.
810 static void ensure_jmethod_ids(ClassLoaderData* loader_data, int capacity);
811
812 // Use resolve_jmethod_id() in situations where the caller is expected
813 // to provide a valid jmethodID; the only sanity checks are in asserts;
814 // result guaranteed not to be NULL.
815 inline static Method* resolve_jmethod_id(jmethodID mid) {
816 assert(mid != NULL, "JNI method id should not be null");
817 return *((Method**)mid);
818 }
819
820 // Use checked_resolve_jmethod_id() in situations where the caller
821 // should provide a valid jmethodID, but might not. NULL is returned
822 // when the jmethodID does not refer to a valid method.
823 static Method* checked_resolve_jmethod_id(jmethodID mid);
824
825 static void change_method_associated_with_jmethod_id(jmethodID old_jmid_ptr, Method* new_method);
826 static bool is_method_id(jmethodID mid);
827
828 // Clear methods
829 static void clear_jmethod_ids(ClassLoaderData* loader_data);
830 static void print_jmethod_ids(const ClassLoaderData* loader_data, outputStream* out) PRODUCT_RETURN;
831
832 // Get this method's jmethodID -- allocate if it doesn't exist
833 jmethodID jmethod_id() { return method_holder()->get_jmethod_id(this); }
834
835 // Lookup the jmethodID for this method. Return NULL if not found.
836 // NOTE that this function can be called from a signal handler
837 // (see AsyncGetCallTrace support for Forte Analyzer) and this
838 // needs to be async-safe. No allocation should be done and
839 // so handles are not used to avoid deadlock.
840 jmethodID find_jmethod_id_or_null() { return method_holder()->jmethod_id_or_null(this); }
841
842 // Support for inlining of intrinsic methods
843 vmIntrinsics::ID intrinsic_id() const { return (vmIntrinsics::ID) _intrinsic_id; }
844 void set_intrinsic_id(vmIntrinsics::ID id) { _intrinsic_id = (u2) id; }
845
846 // Helper routines for intrinsic_id() and vmIntrinsics::method().
847 void init_intrinsic_id(); // updates from _none if a match
848 static vmSymbols::SID klass_id_for_intrinsics(const Klass* holder);
849
850 bool caller_sensitive() {
851 return (_flags & _caller_sensitive) != 0;
852 }
853 void set_caller_sensitive(bool x) {
854 _flags = x ? (_flags | _caller_sensitive) : (_flags & ~_caller_sensitive);
855 }
856
857 bool force_inline() {
858 return (_flags & _force_inline) != 0;
859 }
860 void set_force_inline(bool x) {
861 _flags = x ? (_flags | _force_inline) : (_flags & ~_force_inline);
862 }
863
864 bool dont_inline() {
865 return (_flags & _dont_inline) != 0;
866 }
867 void set_dont_inline(bool x) {
868 _flags = x ? (_flags | _dont_inline) : (_flags & ~_dont_inline);
869 }
870
871 bool is_hidden() {
872 return (_flags & _hidden) != 0;
873 }
874 void set_hidden(bool x) {
875 _flags = x ? (_flags | _hidden) : (_flags & ~_hidden);
876 }
877
878 bool intrinsic_candidate() {
879 return (_flags & _intrinsic_candidate) != 0;
880 }
881 void set_intrinsic_candidate(bool x) {
882 _flags = x ? (_flags | _intrinsic_candidate) : (_flags & ~_intrinsic_candidate);
883 }
884
885 bool has_injected_profile() {
886 return (_flags & _has_injected_profile) != 0;
887 }
888 void set_has_injected_profile(bool x) {
889 _flags = x ? (_flags | _has_injected_profile) : (_flags & ~_has_injected_profile);
890 }
891
892 bool has_reserved_stack_access() {
893 return (_flags & _reserved_stack_access) != 0;
894 }
895
896 void set_has_reserved_stack_access(bool x) {
897 _flags = x ? (_flags | _reserved_stack_access) : (_flags & ~_reserved_stack_access);
898 }
899
900 static int is_returning_vt_mask() {
901 return _is_returning_vt;
902 }
903
904 bool is_returning_vt() const {
905 return (_flags & _is_returning_vt) != 0;
906 }
907
908 void set_is_returning_vt() {
909 _flags |= _is_returning_vt;
910 }
911
912 JFR_ONLY(DEFINE_TRACE_FLAG_ACCESSOR;)
913
914 ConstMethod::MethodType method_type() const {
915 return _constMethod->method_type();
916 }
917 bool is_overpass() const { return method_type() == ConstMethod::OVERPASS; }
918
919 // On-stack replacement support
920 bool has_osr_nmethod(int level, bool match_level) {
921 return method_holder()->lookup_osr_nmethod(this, InvocationEntryBci, level, match_level) != NULL;
922 }
923
924 int mark_osr_nmethods() {
925 return method_holder()->mark_osr_nmethods(this);
926 }
927
928 nmethod* lookup_osr_nmethod_for(int bci, int level, bool match_level) {
929 return method_holder()->lookup_osr_nmethod(this, bci, level, match_level);
930 }
931
932 // Inline cache support
933 void cleanup_inline_caches();
934
935 // Find if klass for method is loaded
936 bool is_klass_loaded_by_klass_index(int klass_index) const;
937 bool is_klass_loaded(int refinfo_index, bool must_be_resolved = false) const;
938
939 // Indicates whether compilation failed earlier for this method, or
940 // whether it is not compilable for another reason like having a
941 // breakpoint set in it.
942 bool is_not_compilable(int comp_level = CompLevel_any) const;
943 void set_not_compilable(int comp_level = CompLevel_all, bool report = true, const char* reason = NULL);
944 void set_not_compilable_quietly(int comp_level = CompLevel_all) {
945 set_not_compilable(comp_level, false);
946 }
947 bool is_not_osr_compilable(int comp_level = CompLevel_any) const;
948 void set_not_osr_compilable(int comp_level = CompLevel_all, bool report = true, const char* reason = NULL);
949 void set_not_osr_compilable_quietly(int comp_level = CompLevel_all) {
950 set_not_osr_compilable(comp_level, false);
951 }
952 bool is_always_compilable() const;
953
954 private:
955 void print_made_not_compilable(int comp_level, bool is_osr, bool report, const char* reason);
956
957 public:
958 MethodCounters* get_method_counters(TRAPS) {
959 if (_method_counters == NULL) {
960 build_method_counters(this, CHECK_AND_CLEAR_NULL);
961 }
962 return _method_counters;
963 }
964
965 bool is_not_c1_compilable() const { return access_flags().is_not_c1_compilable(); }
966 void set_not_c1_compilable() { _access_flags.set_not_c1_compilable(); }
967 void clear_not_c1_compilable() { _access_flags.clear_not_c1_compilable(); }
968 bool is_not_c2_compilable() const { return access_flags().is_not_c2_compilable(); }
969 void set_not_c2_compilable() { _access_flags.set_not_c2_compilable(); }
970 void clear_not_c2_compilable() { _access_flags.clear_not_c2_compilable(); }
971
972 bool is_not_c1_osr_compilable() const { return is_not_c1_compilable(); } // don't waste an accessFlags bit
973 void set_not_c1_osr_compilable() { set_not_c1_compilable(); } // don't waste an accessFlags bit
974 void clear_not_c1_osr_compilable() { clear_not_c1_compilable(); } // don't waste an accessFlags bit
975 bool is_not_c2_osr_compilable() const { return access_flags().is_not_c2_osr_compilable(); }
976 void set_not_c2_osr_compilable() { _access_flags.set_not_c2_osr_compilable(); }
977 void clear_not_c2_osr_compilable() { _access_flags.clear_not_c2_osr_compilable(); }
978
979 // Background compilation support
980 bool queued_for_compilation() const { return access_flags().queued_for_compilation(); }
981 void set_queued_for_compilation() { _access_flags.set_queued_for_compilation(); }
982 void clear_queued_for_compilation() { _access_flags.clear_queued_for_compilation(); }
983
984 // Resolve all classes in signature, return 'true' if successful
985 static bool load_signature_classes(const methodHandle& m, TRAPS);
986
987 // Return if true if not all classes references in signature, including return type, has been loaded
988 static bool has_unloaded_classes_in_signature(const methodHandle& m, TRAPS);
989
990 // Printing
991 void print_short_name(outputStream* st = tty); // prints as klassname::methodname; Exposed so field engineers can debug VM
992 #if INCLUDE_JVMTI
993 void print_name(outputStream* st = tty); // prints as "virtual void foo(int)"; exposed for TraceRedefineClasses
994 #else
995 void print_name(outputStream* st = tty) PRODUCT_RETURN; // prints as "virtual void foo(int)"
996 #endif
997
998 // Helper routine used for method sorting
999 static void sort_methods(Array<Method*>* methods, bool idempotent = false, bool set_idnums = true);
1000
1001 // Deallocation function for redefine classes or if an error occurs
1002 void deallocate_contents(ClassLoaderData* loader_data);
1003
1004 // Printing
1005 #ifndef PRODUCT
1006 void print_on(outputStream* st) const;
1007 #endif
1008 void print_value_on(outputStream* st) const;
1009 void print_linkage_flags(outputStream* st) PRODUCT_RETURN;
1010
1011 const char* internal_name() const { return "{method}"; }
1012
1013 // Check for valid method pointer
1014 static bool has_method_vptr(const void* ptr);
1015 bool is_valid_method() const;
1016
1017 // Verify
1018 void verify() { verify_on(tty); }
1019 void verify_on(outputStream* st);
1020
1021 private:
1022
1023 // Inlined elements
1024 address* native_function_addr() const { assert(is_native(), "must be native"); return (address*) (this+1); }
1025 address* signature_handler_addr() const { return native_function_addr() + 1; }
1026 };
1027
1028
1029 // Utility class for compressing line number tables
1030
1031 class CompressedLineNumberWriteStream: public CompressedWriteStream {
1032 private:
1033 int _bci;
1034 int _line;
1035 public:
1036 // Constructor
1037 CompressedLineNumberWriteStream(int initial_size) : CompressedWriteStream(initial_size), _bci(0), _line(0) {}
1038 CompressedLineNumberWriteStream(u_char* buffer, int initial_size) : CompressedWriteStream(buffer, initial_size), _bci(0), _line(0) {}
1039
1040 // Write (bci, line number) pair to stream
1041 void write_pair_regular(int bci_delta, int line_delta);
1042
1043 inline void write_pair_inline(int bci, int line) {
1044 int bci_delta = bci - _bci;
1045 int line_delta = line - _line;
1046 _bci = bci;
1047 _line = line;
1048 // Skip (0,0) deltas - they do not add information and conflict with terminator.
1049 if (bci_delta == 0 && line_delta == 0) return;
1050 // Check if bci is 5-bit and line number 3-bit unsigned.
1051 if (((bci_delta & ~0x1F) == 0) && ((line_delta & ~0x7) == 0)) {
1052 // Compress into single byte.
1053 jubyte value = ((jubyte) bci_delta << 3) | (jubyte) line_delta;
1054 // Check that value doesn't match escape character.
1055 if (value != 0xFF) {
1056 write_byte(value);
1057 return;
1058 }
1059 }
1060 write_pair_regular(bci_delta, line_delta);
1061 }
1062
1063 // Windows AMD64 + Apr 2005 PSDK with /O2 generates bad code for write_pair.
1064 // Disabling optimization doesn't work for methods in header files
1065 // so we force it to call through the non-optimized version in the .cpp.
1066 // It's gross, but it's the only way we can ensure that all callers are
1067 // fixed. _MSC_VER is defined by the windows compiler
1068 #if defined(_M_AMD64) && _MSC_VER >= 1400
1069 void write_pair(int bci, int line);
1070 #else
1071 void write_pair(int bci, int line) { write_pair_inline(bci, line); }
1072 #endif
1073
1074 // Write end-of-stream marker
1075 void write_terminator() { write_byte(0); }
1076 };
1077
1078
1079 // Utility class for decompressing line number tables
1080
1081 class CompressedLineNumberReadStream: public CompressedReadStream {
1082 private:
1083 int _bci;
1084 int _line;
1085 public:
1086 // Constructor
1087 CompressedLineNumberReadStream(u_char* buffer);
1088 // Read (bci, line number) pair from stream. Returns false at end-of-stream.
1089 bool read_pair();
1090 // Accessing bci and line number (after calling read_pair)
1091 int bci() const { return _bci; }
1092 int line() const { return _line; }
1093 };
1094
1095
1096 #if INCLUDE_JVMTI
1097
1098 /// Fast Breakpoints.
1099
1100 // If this structure gets more complicated (because bpts get numerous),
1101 // move it into its own header.
1102
1103 // There is presently no provision for concurrent access
1104 // to breakpoint lists, which is only OK for JVMTI because
1105 // breakpoints are written only at safepoints, and are read
1106 // concurrently only outside of safepoints.
1107
1108 class BreakpointInfo : public CHeapObj<mtClass> {
1109 friend class VMStructs;
1110 private:
1111 Bytecodes::Code _orig_bytecode;
1112 int _bci;
1113 u2 _name_index; // of method
1114 u2 _signature_index; // of method
1115 BreakpointInfo* _next; // simple storage allocation
1116
1117 public:
1118 BreakpointInfo(Method* m, int bci);
1119
1120 // accessors
1121 Bytecodes::Code orig_bytecode() { return _orig_bytecode; }
1122 void set_orig_bytecode(Bytecodes::Code code) { _orig_bytecode = code; }
1123 int bci() { return _bci; }
1124
1125 BreakpointInfo* next() const { return _next; }
1126 void set_next(BreakpointInfo* n) { _next = n; }
1127
1128 // helps for searchers
1129 bool match(const Method* m, int bci) {
1130 return bci == _bci && match(m);
1131 }
1132
1133 bool match(const Method* m) {
1134 return _name_index == m->name_index() &&
1135 _signature_index == m->signature_index();
1136 }
1137
1138 void set(Method* method);
1139 void clear(Method* method);
1140 };
1141
1142 #endif // INCLUDE_JVMTI
1143
1144 // Utility class for access exception handlers
1145 class ExceptionTable : public StackObj {
1146 private:
1147 ExceptionTableElement* _table;
1148 u2 _length;
1149
1150 public:
1151 ExceptionTable(const Method* m) {
1152 if (m->has_exception_handler()) {
1153 _table = m->exception_table_start();
1154 _length = m->exception_table_length();
1155 } else {
1156 _table = NULL;
1157 _length = 0;
1158 }
1159 }
1160
1161 int length() const {
1162 return _length;
1163 }
1164
1165 u2 start_pc(int idx) const {
1166 assert(idx < _length, "out of bounds");
1167 return _table[idx].start_pc;
1168 }
1169
1170 void set_start_pc(int idx, u2 value) {
1171 assert(idx < _length, "out of bounds");
1172 _table[idx].start_pc = value;
1173 }
1174
1175 u2 end_pc(int idx) const {
1176 assert(idx < _length, "out of bounds");
1177 return _table[idx].end_pc;
1178 }
1179
1180 void set_end_pc(int idx, u2 value) {
1181 assert(idx < _length, "out of bounds");
1182 _table[idx].end_pc = value;
1183 }
1184
1185 u2 handler_pc(int idx) const {
1186 assert(idx < _length, "out of bounds");
1187 return _table[idx].handler_pc;
1188 }
1189
1190 void set_handler_pc(int idx, u2 value) {
1191 assert(idx < _length, "out of bounds");
1192 _table[idx].handler_pc = value;
1193 }
1194
1195 u2 catch_type_index(int idx) const {
1196 assert(idx < _length, "out of bounds");
1197 return _table[idx].catch_type_index;
1198 }
1199
1200 void set_catch_type_index(int idx, u2 value) {
1201 assert(idx < _length, "out of bounds");
1202 _table[idx].catch_type_index = value;
1203 }
1204 };
1205
1206 #endif // SHARE_VM_OOPS_METHODOOP_HPP