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