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