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