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