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