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