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