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