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