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