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