Mon, 27 Jun 2016 16:08:34 +0800
[Code Reorganization] Removed compilation policy related modifications made by Loongson.
1 /*
2 * Copyright (c) 1997, 2013, 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 */
25 #ifndef SHARE_VM_OOPS_METHODOOP_HPP
26 #define SHARE_VM_OOPS_METHODOOP_HPP
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"
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 // |------------------------------------------------------|
90 class CheckedExceptionElement;
91 class LocalVariableTableElement;
92 class AdapterHandlerEntry;
93 class MethodData;
94 class MethodCounters;
95 class ConstMethod;
96 class InlineTableSizes;
97 class KlassSizeStats;
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 #ifdef CC_INTERP
109 int _result_index; // C++ interpreter needs for converting results to/from stack
110 #endif
111 u2 _method_size; // size of this object
112 u1 _intrinsic_id; // vmSymbols::intrinsic_id (0 == _none)
113 u1 _jfr_towrite : 1, // Flags
114 _caller_sensitive : 1,
115 _force_inline : 1,
116 _hidden : 1,
117 _dont_inline : 1,
118 : 3;
120 #ifndef PRODUCT
121 int _compiled_invocation_count; // Number of nmethod invocations so far (for perf. debugging)
122 #endif
123 // Entry point for calling both from and to the interpreter.
124 address _i2i_entry; // All-args-on-stack calling convention
125 // Adapter blob (i2c/c2i) for this Method*. Set once when method is linked.
126 AdapterHandlerEntry* _adapter;
127 // Entry point for calling from compiled code, to compiled code if it exists
128 // or else the interpreter.
129 volatile address _from_compiled_entry; // Cache of: _code ? _code->entry_point() : _adapter->c2i_entry()
130 // The entry point for calling both from and to compiled code is
131 // "_code->entry_point()". Because of tiered compilation and de-opt, this
132 // field can come and go. It can transition from NULL to not-null at any
133 // time (whenever a compile completes). It can transition from not-null to
134 // NULL only at safepoints (because of a de-opt).
135 nmethod* volatile _code; // Points to the corresponding piece of native code
136 volatile address _from_interpreted_entry; // Cache of _code ? _adapter->i2c_entry() : _i2i_entry
138 // Constructor
139 Method(ConstMethod* xconst, AccessFlags access_flags, int size);
140 public:
142 static Method* allocate(ClassLoaderData* loader_data,
143 int byte_code_size,
144 AccessFlags access_flags,
145 InlineTableSizes* sizes,
146 ConstMethod::MethodType method_type,
147 TRAPS);
149 // CDS and vtbl checking can create an empty Method to get vtbl pointer.
150 Method(){}
152 // The Method vtable is restored by this call when the Method is in the
153 // shared archive. See patch_klass_vtables() in metaspaceShared.cpp for
154 // all the gory details. SA, dtrace and pstack helpers distinguish metadata
155 // by their vtable.
156 void restore_vtable() { guarantee(is_method(), "vtable restored by this call"); }
157 bool is_method() const volatile { return true; }
159 void restore_unshareable_info(TRAPS);
161 // accessors for instance variables
163 ConstMethod* constMethod() const { return _constMethod; }
164 void set_constMethod(ConstMethod* xconst) { _constMethod = xconst; }
167 static address make_adapters(methodHandle mh, TRAPS);
168 volatile address from_compiled_entry() const { return (address)OrderAccess::load_ptr_acquire(&_from_compiled_entry); }
169 volatile address from_interpreted_entry() const{ return (address)OrderAccess::load_ptr_acquire(&_from_interpreted_entry); }
171 // access flag
172 AccessFlags access_flags() const { return _access_flags; }
173 void set_access_flags(AccessFlags flags) { _access_flags = flags; }
175 // name
176 Symbol* name() const { return constants()->symbol_at(name_index()); }
177 int name_index() const { return constMethod()->name_index(); }
178 void set_name_index(int index) { constMethod()->set_name_index(index); }
180 // signature
181 Symbol* signature() const { return constants()->symbol_at(signature_index()); }
182 int signature_index() const { return constMethod()->signature_index(); }
183 void set_signature_index(int index) { constMethod()->set_signature_index(index); }
185 // generics support
186 Symbol* generic_signature() const { int idx = generic_signature_index(); return ((idx != 0) ? constants()->symbol_at(idx) : (Symbol*)NULL); }
187 int generic_signature_index() const { return constMethod()->generic_signature_index(); }
188 void set_generic_signature_index(int index) { constMethod()->set_generic_signature_index(index); }
190 // annotations support
191 AnnotationArray* annotations() const {
192 return constMethod()->method_annotations();
193 }
194 AnnotationArray* parameter_annotations() const {
195 return constMethod()->parameter_annotations();
196 }
197 AnnotationArray* annotation_default() const {
198 return constMethod()->default_annotations();
199 }
200 AnnotationArray* type_annotations() const {
201 return constMethod()->type_annotations();
202 }
204 #ifdef CC_INTERP
205 void set_result_index(BasicType type);
206 int result_index() { return _result_index; }
207 #endif
209 // Helper routine: get klass name + "." + method name + signature as
210 // C string, for the purpose of providing more useful NoSuchMethodErrors
211 // and fatal error handling. The string is allocated in resource
212 // area if a buffer is not provided by the caller.
213 char* name_and_sig_as_C_string() const;
214 char* name_and_sig_as_C_string(char* buf, int size) const;
216 // Static routine in the situations we don't have a Method*
217 static char* name_and_sig_as_C_string(Klass* klass, Symbol* method_name, Symbol* signature);
218 static char* name_and_sig_as_C_string(Klass* klass, Symbol* method_name, Symbol* signature, char* buf, int size);
220 Bytecodes::Code java_code_at(int bci) const {
221 return Bytecodes::java_code_at(this, bcp_from(bci));
222 }
223 Bytecodes::Code code_at(int bci) const {
224 return Bytecodes::code_at(this, bcp_from(bci));
225 }
227 // JVMTI breakpoints
228 Bytecodes::Code orig_bytecode_at(int bci) const;
229 void set_orig_bytecode_at(int bci, Bytecodes::Code code);
230 void set_breakpoint(int bci);
231 void clear_breakpoint(int bci);
232 void clear_all_breakpoints();
233 // Tracking number of breakpoints, for fullspeed debugging.
234 // Only mutated by VM thread.
235 u2 number_of_breakpoints() const {
236 if (method_counters() == NULL) {
237 return 0;
238 } else {
239 return method_counters()->number_of_breakpoints();
240 }
241 }
242 void incr_number_of_breakpoints(TRAPS) {
243 MethodCounters* mcs = get_method_counters(CHECK);
244 if (mcs != NULL) {
245 mcs->incr_number_of_breakpoints();
246 }
247 }
248 void decr_number_of_breakpoints(TRAPS) {
249 MethodCounters* mcs = get_method_counters(CHECK);
250 if (mcs != NULL) {
251 mcs->decr_number_of_breakpoints();
252 }
253 }
254 // Initialization only
255 void clear_number_of_breakpoints() {
256 if (method_counters() != NULL) {
257 method_counters()->clear_number_of_breakpoints();
258 }
259 }
261 // index into InstanceKlass methods() array
262 // note: also used by jfr
263 u2 method_idnum() const { return constMethod()->method_idnum(); }
264 void set_method_idnum(u2 idnum) { constMethod()->set_method_idnum(idnum); }
266 // code size
267 int code_size() const { return constMethod()->code_size(); }
269 // method size
270 int method_size() const { return _method_size; }
271 void set_method_size(int size) {
272 assert(0 <= size && size < (1 << 16), "invalid method size");
273 _method_size = size;
274 }
276 // constant pool for Klass* holding this method
277 ConstantPool* constants() const { return constMethod()->constants(); }
278 void set_constants(ConstantPool* c) { constMethod()->set_constants(c); }
280 // max stack
281 // return original max stack size for method verification
282 int verifier_max_stack() const { return constMethod()->max_stack(); }
283 int max_stack() const { return constMethod()->max_stack() + extra_stack_entries(); }
284 void set_max_stack(int size) { constMethod()->set_max_stack(size); }
286 // max locals
287 int max_locals() const { return constMethod()->max_locals(); }
288 void set_max_locals(int size) { constMethod()->set_max_locals(size); }
290 int highest_comp_level() const;
291 void set_highest_comp_level(int level);
292 int highest_osr_comp_level() const;
293 void set_highest_osr_comp_level(int level);
295 // Count of times method was exited via exception while interpreting
296 void interpreter_throwout_increment(TRAPS) {
297 MethodCounters* mcs = get_method_counters(CHECK);
298 if (mcs != NULL) {
299 mcs->interpreter_throwout_increment();
300 }
301 }
303 int interpreter_throwout_count() const {
304 if (method_counters() == NULL) {
305 return 0;
306 } else {
307 return method_counters()->interpreter_throwout_count();
308 }
309 }
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); }
315 bool has_stackmap_table() const {
316 return constMethod()->has_stackmap_table();
317 }
319 Array<u1>* stackmap_data() const {
320 return constMethod()->stackmap_data();
321 }
323 void set_stackmap_data(Array<u1>* sd) {
324 constMethod()->set_stackmap_data(sd);
325 }
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(); }
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);
349 // method data access
350 MethodData* method_data() const {
351 return _method_data;
352 }
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 }
361 MethodCounters* method_counters() const {
362 return _method_counters;
363 }
365 void set_method_counters(MethodCounters* counters) {
366 // The store into method must be released. On platforms without
367 // total store order (TSO) the reference may become visible before
368 // the initialization of data otherwise.
369 OrderAccess::release_store_ptr((volatile void *)&_method_counters, counters);
370 }
372 #ifdef TIERED
373 // We are reusing interpreter_invocation_count as a holder for the previous event count!
374 // We can do that since interpreter_invocation_count is not used in tiered.
375 int prev_event_count() const {
376 if (method_counters() == NULL) {
377 return 0;
378 } else {
379 return method_counters()->interpreter_invocation_count();
380 }
381 }
382 void set_prev_event_count(int count, TRAPS) {
383 MethodCounters* mcs = get_method_counters(CHECK);
384 if (mcs != NULL) {
385 mcs->set_interpreter_invocation_count(count);
386 }
387 }
388 jlong prev_time() const {
389 return method_counters() == NULL ? 0 : method_counters()->prev_time();
390 }
391 void set_prev_time(jlong time, TRAPS) {
392 MethodCounters* mcs = get_method_counters(CHECK);
393 if (mcs != NULL) {
394 mcs->set_prev_time(time);
395 }
396 }
397 float rate() const {
398 return method_counters() == NULL ? 0 : method_counters()->rate();
399 }
400 void set_rate(float rate, TRAPS) {
401 MethodCounters* mcs = get_method_counters(CHECK);
402 if (mcs != NULL) {
403 mcs->set_rate(rate);
404 }
405 }
406 #endif
408 int invocation_count();
409 int backedge_count();
411 bool was_executed_more_than(int n);
412 bool was_never_executed() { return !was_executed_more_than(0); }
414 static void build_interpreter_method_data(methodHandle method, TRAPS);
416 static MethodCounters* build_method_counters(Method* m, TRAPS);
418 int interpreter_invocation_count() {
419 if (TieredCompilation) return invocation_count();
420 else return (method_counters() == NULL) ? 0 :
421 method_counters()->interpreter_invocation_count();
422 }
423 int increment_interpreter_invocation_count(TRAPS) {
424 if (TieredCompilation) ShouldNotReachHere();
425 MethodCounters* mcs = get_method_counters(CHECK_0);
426 return (mcs == NULL) ? 0 : mcs->increment_interpreter_invocation_count();
427 }
429 #ifndef PRODUCT
430 int compiled_invocation_count() const { return _compiled_invocation_count; }
431 void set_compiled_invocation_count(int count) { _compiled_invocation_count = count; }
432 #endif // not PRODUCT
434 // Clear (non-shared space) pointers which could not be relevant
435 // if this (shared) method were mapped into another JVM.
436 void remove_unshareable_info();
438 // nmethod/verified compiler entry
439 address verified_code_entry();
440 bool check_code() const; // Not inline to avoid circular ref
441 nmethod* volatile code() const { assert( check_code(), "" ); return (nmethod *)OrderAccess::load_ptr_acquire(&_code); }
442 void clear_code(); // Clear out any compiled code
443 static void set_code(methodHandle mh, nmethod* code);
444 void set_adapter_entry(AdapterHandlerEntry* adapter) { _adapter = adapter; }
445 address get_i2c_entry();
446 address get_c2i_entry();
447 address get_c2i_unverified_entry();
448 AdapterHandlerEntry* adapter() { return _adapter; }
449 // setup entry points
450 void link_method(methodHandle method, TRAPS);
451 // clear entry points. Used by sharing code
452 void unlink_method();
454 // vtable index
455 enum VtableIndexFlag {
456 // Valid vtable indexes are non-negative (>= 0).
457 // These few negative values are used as sentinels.
458 itable_index_max = -10, // first itable index, growing downward
459 pending_itable_index = -9, // itable index will be assigned
460 invalid_vtable_index = -4, // distinct from any valid vtable index
461 garbage_vtable_index = -3, // not yet linked; no vtable layout yet
462 nonvirtual_vtable_index = -2 // there is no need for vtable dispatch
463 // 6330203 Note: Do not use -1, which was overloaded with many meanings.
464 };
465 DEBUG_ONLY(bool valid_vtable_index() const { return _vtable_index >= nonvirtual_vtable_index; })
466 bool has_vtable_index() const { return _vtable_index >= 0; }
467 int vtable_index() const { return _vtable_index; }
468 void set_vtable_index(int index) { _vtable_index = index; }
469 DEBUG_ONLY(bool valid_itable_index() const { return _vtable_index <= pending_itable_index; })
470 bool has_itable_index() const { return _vtable_index <= itable_index_max; }
471 int itable_index() const { assert(valid_itable_index(), "");
472 return itable_index_max - _vtable_index; }
473 void set_itable_index(int index) { _vtable_index = itable_index_max - index; assert(valid_itable_index(), ""); }
475 // interpreter entry
476 address interpreter_entry() const { return _i2i_entry; }
477 // Only used when first initialize so we can set _i2i_entry and _from_interpreted_entry
478 void set_interpreter_entry(address entry) { _i2i_entry = entry; _from_interpreted_entry = entry; }
480 // native function (used for native methods only)
481 enum {
482 native_bind_event_is_interesting = true
483 };
484 address native_function() const { return *(native_function_addr()); }
485 address critical_native_function();
487 // Must specify a real function (not NULL).
488 // Use clear_native_function() to unregister.
489 void set_native_function(address function, bool post_event_flag);
490 bool has_native_function() const;
491 void clear_native_function();
493 // signature handler (used for native methods only)
494 address signature_handler() const { return *(signature_handler_addr()); }
495 void set_signature_handler(address handler);
497 // Interpreter oopmap support
498 void mask_for(int bci, InterpreterOopMap* mask);
500 #ifndef PRODUCT
501 // operations on invocation counter
502 void print_invocation_count();
503 #endif
505 // byte codes
506 void set_code(address code) { return constMethod()->set_code(code); }
507 address code_base() const { return constMethod()->code_base(); }
508 bool contains(address bcp) const { return constMethod()->contains(bcp); }
510 // prints byte codes
511 void print_codes() const { print_codes_on(tty); }
512 void print_codes_on(outputStream* st) const PRODUCT_RETURN;
513 void print_codes_on(int from, int to, outputStream* st) const PRODUCT_RETURN;
515 // method parameters
516 bool has_method_parameters() const
517 { return constMethod()->has_method_parameters(); }
518 int method_parameters_length() const
519 { return constMethod()->method_parameters_length(); }
520 MethodParametersElement* method_parameters_start() const
521 { return constMethod()->method_parameters_start(); }
523 // checked exceptions
524 int checked_exceptions_length() const
525 { return constMethod()->checked_exceptions_length(); }
526 CheckedExceptionElement* checked_exceptions_start() const
527 { return constMethod()->checked_exceptions_start(); }
529 // localvariable table
530 bool has_localvariable_table() const
531 { return constMethod()->has_localvariable_table(); }
532 int localvariable_table_length() const
533 { return constMethod()->localvariable_table_length(); }
534 LocalVariableTableElement* localvariable_table_start() const
535 { return constMethod()->localvariable_table_start(); }
537 bool has_linenumber_table() const
538 { return constMethod()->has_linenumber_table(); }
539 u_char* compressed_linenumber_table() const
540 { return constMethod()->compressed_linenumber_table(); }
542 // method holder (the Klass* holding this method)
543 InstanceKlass* method_holder() const { return constants()->pool_holder(); }
545 void compute_size_of_parameters(Thread *thread); // word size of parameters (receiver if any + arguments)
546 Symbol* klass_name() const; // returns the name of the method holder
547 BasicType result_type() const; // type of the method result
548 int result_type_index() const; // type index of the method result
549 bool is_returning_oop() const { BasicType r = result_type(); return (r == T_OBJECT || r == T_ARRAY); }
550 bool is_returning_fp() const { BasicType r = result_type(); return (r == T_FLOAT || r == T_DOUBLE); }
552 // Checked exceptions thrown by this method (resolved to mirrors)
553 objArrayHandle resolved_checked_exceptions(TRAPS) { return resolved_checked_exceptions_impl(this, THREAD); }
555 // Access flags
556 bool is_public() const { return access_flags().is_public(); }
557 bool is_private() const { return access_flags().is_private(); }
558 bool is_protected() const { return access_flags().is_protected(); }
559 bool is_package_private() const { return !is_public() && !is_private() && !is_protected(); }
560 bool is_static() const { return access_flags().is_static(); }
561 bool is_final() const { return access_flags().is_final(); }
562 bool is_synchronized() const { return access_flags().is_synchronized();}
563 bool is_native() const { return access_flags().is_native(); }
564 bool is_abstract() const { return access_flags().is_abstract(); }
565 bool is_strict() const { return access_flags().is_strict(); }
566 bool is_synthetic() const { return access_flags().is_synthetic(); }
568 // returns true if contains only return operation
569 bool is_empty_method() const;
571 // returns true if this is a vanilla constructor
572 bool is_vanilla_constructor() const;
574 // checks method and its method holder
575 bool is_final_method() const;
576 bool is_final_method(AccessFlags class_access_flags) const;
577 bool is_default_method() const;
579 // true if method needs no dynamic dispatch (final and/or no vtable entry)
580 bool can_be_statically_bound() const;
581 bool can_be_statically_bound(AccessFlags class_access_flags) const;
583 // returns true if the method has any backward branches.
584 bool has_loops() {
585 return access_flags().loops_flag_init() ? access_flags().has_loops() : compute_has_loops_flag();
586 };
588 bool compute_has_loops_flag();
590 bool has_jsrs() {
591 return access_flags().has_jsrs();
592 };
593 void set_has_jsrs() {
594 _access_flags.set_has_jsrs();
595 }
597 // returns true if the method has any monitors.
598 bool has_monitors() const { return is_synchronized() || access_flags().has_monitor_bytecodes(); }
599 bool has_monitor_bytecodes() const { return access_flags().has_monitor_bytecodes(); }
601 void set_has_monitor_bytecodes() { _access_flags.set_has_monitor_bytecodes(); }
603 // monitor matching. This returns a conservative estimate of whether the monitorenter/monitorexit bytecodes
604 // propererly nest in the method. It might return false, even though they actually nest properly, since the info.
605 // has not been computed yet.
606 bool guaranteed_monitor_matching() const { return access_flags().is_monitor_matching(); }
607 void set_guaranteed_monitor_matching() { _access_flags.set_monitor_matching(); }
609 // returns true if the method is an accessor function (setter/getter).
610 bool is_accessor() const;
612 // returns true if the method is an initializer (<init> or <clinit>).
613 bool is_initializer() const;
615 // returns true if the method is static OR if the classfile version < 51
616 bool has_valid_initializer_flags() const;
618 // returns true if the method name is <clinit> and the method has
619 // valid static initializer flags.
620 bool is_static_initializer() const;
622 // compiled code support
623 // NOTE: code() is inherently racy as deopt can be clearing code
624 // simultaneously. Use with caution.
625 bool has_compiled_code() const { return code() != NULL; }
627 // sizing
628 static int header_size() { return sizeof(Method)/HeapWordSize; }
629 static int size(bool is_native);
630 int size() const { return method_size(); }
631 #if INCLUDE_SERVICES
632 void collect_statistics(KlassSizeStats *sz) const;
633 #endif
635 // interpreter support
636 static ByteSize const_offset() { return byte_offset_of(Method, _constMethod ); }
637 static ByteSize access_flags_offset() { return byte_offset_of(Method, _access_flags ); }
638 #ifdef CC_INTERP
639 static ByteSize result_index_offset() { return byte_offset_of(Method, _result_index ); }
640 #endif /* CC_INTERP */
641 static ByteSize from_compiled_offset() { return byte_offset_of(Method, _from_compiled_entry); }
642 static ByteSize code_offset() { return byte_offset_of(Method, _code); }
643 static ByteSize method_data_offset() {
644 return byte_offset_of(Method, _method_data);
645 }
646 static ByteSize method_counters_offset() {
647 return byte_offset_of(Method, _method_counters);
648 }
649 #ifndef PRODUCT
650 static ByteSize compiled_invocation_counter_offset() { return byte_offset_of(Method, _compiled_invocation_count); }
651 #endif // not PRODUCT
652 static ByteSize native_function_offset() { return in_ByteSize(sizeof(Method)); }
653 static ByteSize from_interpreted_offset() { return byte_offset_of(Method, _from_interpreted_entry ); }
654 static ByteSize interpreter_entry_offset() { return byte_offset_of(Method, _i2i_entry ); }
655 static ByteSize signature_handler_offset() { return in_ByteSize(sizeof(Method) + wordSize); }
657 // for code generation
658 static int method_data_offset_in_bytes() { return offset_of(Method, _method_data); }
659 static int intrinsic_id_offset_in_bytes() { return offset_of(Method, _intrinsic_id); }
660 static int intrinsic_id_size_in_bytes() { return sizeof(u1); }
662 // Static methods that are used to implement member methods where an exposed this pointer
663 // is needed due to possible GCs
664 static objArrayHandle resolved_checked_exceptions_impl(Method* this_oop, TRAPS);
666 // Returns the byte code index from the byte code pointer
667 int bci_from(address bcp) const;
668 address bcp_from(int bci) const;
669 int validate_bci_from_bcx(intptr_t bcx) const;
671 // Returns the line number for a bci if debugging information for the method is prowided,
672 // -1 is returned otherwise.
673 int line_number_from_bci(int bci) const;
675 // Reflection support
676 bool is_overridden_in(Klass* k) const;
678 // Stack walking support
679 bool is_ignored_by_security_stack_walk() const;
681 // JSR 292 support
682 bool is_method_handle_intrinsic() const; // MethodHandles::is_signature_polymorphic_intrinsic(intrinsic_id)
683 bool is_compiled_lambda_form() const; // intrinsic_id() == vmIntrinsics::_compiledLambdaForm
684 bool has_member_arg() const; // intrinsic_id() == vmIntrinsics::_linkToSpecial, etc.
685 static methodHandle make_method_handle_intrinsic(vmIntrinsics::ID iid, // _invokeBasic, _linkToVirtual
686 Symbol* signature, //anything at all
687 TRAPS);
688 static Klass* check_non_bcp_klass(Klass* klass);
690 // How many extra stack entries for invokedynamic when it's enabled
691 static const int extra_stack_entries_for_jsr292 = 1;
693 // this operates only on invoke methods:
694 // presize interpreter frames for extra interpreter stack entries, if needed
695 // Account for the extra appendix argument for invokehandle/invokedynamic
696 static int extra_stack_entries() { return EnableInvokeDynamic ? extra_stack_entries_for_jsr292 : 0; }
697 static int extra_stack_words(); // = extra_stack_entries() * Interpreter::stackElementSize
699 // RedefineClasses() support:
700 bool is_old() const { return access_flags().is_old(); }
701 void set_is_old() { _access_flags.set_is_old(); }
702 bool is_obsolete() const { return access_flags().is_obsolete(); }
703 void set_is_obsolete() { _access_flags.set_is_obsolete(); }
704 bool on_stack() const { return access_flags().on_stack(); }
705 void set_on_stack(const bool value);
707 // see the definition in Method*.cpp for the gory details
708 bool should_not_be_cached() const;
710 // JVMTI Native method prefixing support:
711 bool is_prefixed_native() const { return access_flags().is_prefixed_native(); }
712 void set_is_prefixed_native() { _access_flags.set_is_prefixed_native(); }
714 // Rewriting support
715 static methodHandle clone_with_new_data(methodHandle m, u_char* new_code, int new_code_length,
716 u_char* new_compressed_linenumber_table, int new_compressed_linenumber_size, TRAPS);
718 // jmethodID handling
719 // Because the useful life-span of a jmethodID cannot be determined,
720 // once created they are never reclaimed. The methods to which they refer,
721 // however, can be GC'ed away if the class is unloaded or if the method is
722 // made obsolete or deleted -- in these cases, the jmethodID
723 // refers to NULL (as is the case for any weak reference).
724 static jmethodID make_jmethod_id(ClassLoaderData* loader_data, Method* mh);
725 static void destroy_jmethod_id(ClassLoaderData* loader_data, jmethodID mid);
727 // Use resolve_jmethod_id() in situations where the caller is expected
728 // to provide a valid jmethodID; the only sanity checks are in asserts;
729 // result guaranteed not to be NULL.
730 inline static Method* resolve_jmethod_id(jmethodID mid) {
731 assert(mid != NULL, "JNI method id should not be null");
732 return *((Method**)mid);
733 }
735 // Use checked_resolve_jmethod_id() in situations where the caller
736 // should provide a valid jmethodID, but might not. NULL is returned
737 // when the jmethodID does not refer to a valid method.
738 static Method* checked_resolve_jmethod_id(jmethodID mid);
740 static void change_method_associated_with_jmethod_id(jmethodID old_jmid_ptr, Method* new_method);
741 static bool is_method_id(jmethodID mid);
743 // Clear methods
744 static void clear_jmethod_ids(ClassLoaderData* loader_data);
745 static void print_jmethod_ids(ClassLoaderData* loader_data, outputStream* out) PRODUCT_RETURN;
747 // Get this method's jmethodID -- allocate if it doesn't exist
748 jmethodID jmethod_id() { methodHandle this_h(this);
749 return InstanceKlass::get_jmethod_id(method_holder(), this_h); }
751 // Lookup the jmethodID for this method. Return NULL if not found.
752 // NOTE that this function can be called from a signal handler
753 // (see AsyncGetCallTrace support for Forte Analyzer) and this
754 // needs to be async-safe. No allocation should be done and
755 // so handles are not used to avoid deadlock.
756 jmethodID find_jmethod_id_or_null() { return method_holder()->jmethod_id_or_null(this); }
758 // Support for inlining of intrinsic methods
759 vmIntrinsics::ID intrinsic_id() const { return (vmIntrinsics::ID) _intrinsic_id; }
760 void set_intrinsic_id(vmIntrinsics::ID id) { _intrinsic_id = (u1) id; }
762 // Helper routines for intrinsic_id() and vmIntrinsics::method().
763 void init_intrinsic_id(); // updates from _none if a match
764 static vmSymbols::SID klass_id_for_intrinsics(Klass* holder);
766 bool jfr_towrite() { return _jfr_towrite; }
767 void set_jfr_towrite(bool x) { _jfr_towrite = x; }
768 bool caller_sensitive() { return _caller_sensitive; }
769 void set_caller_sensitive(bool x) { _caller_sensitive = x; }
770 bool force_inline() { return _force_inline; }
771 void set_force_inline(bool x) { _force_inline = x; }
772 bool dont_inline() { return _dont_inline; }
773 void set_dont_inline(bool x) { _dont_inline = x; }
774 bool is_hidden() { return _hidden; }
775 void set_hidden(bool x) { _hidden = x; }
776 ConstMethod::MethodType method_type() const {
777 return _constMethod->method_type();
778 }
779 bool is_overpass() const { return method_type() == ConstMethod::OVERPASS; }
781 // On-stack replacement support
782 bool has_osr_nmethod(int level, bool match_level) {
783 return method_holder()->lookup_osr_nmethod(this, InvocationEntryBci, level, match_level) != NULL;
784 }
786 nmethod* lookup_osr_nmethod_for(int bci, int level, bool match_level) {
787 return method_holder()->lookup_osr_nmethod(this, bci, level, match_level);
788 }
790 // Inline cache support
791 void cleanup_inline_caches();
793 // Find if klass for method is loaded
794 bool is_klass_loaded_by_klass_index(int klass_index) const;
795 bool is_klass_loaded(int refinfo_index, bool must_be_resolved = false) const;
797 // Indicates whether compilation failed earlier for this method, or
798 // whether it is not compilable for another reason like having a
799 // breakpoint set in it.
800 bool is_not_compilable(int comp_level = CompLevel_any) const;
801 void set_not_compilable(int comp_level = CompLevel_all, bool report = true, const char* reason = NULL);
802 void set_not_compilable_quietly(int comp_level = CompLevel_all) {
803 set_not_compilable(comp_level, false);
804 }
805 bool is_not_osr_compilable(int comp_level = CompLevel_any) const;
806 void set_not_osr_compilable(int comp_level = CompLevel_all, bool report = true, const char* reason = NULL);
807 void set_not_osr_compilable_quietly(int comp_level = CompLevel_all) {
808 set_not_osr_compilable(comp_level, false);
809 }
810 bool is_always_compilable() const;
812 private:
813 void print_made_not_compilable(int comp_level, bool is_osr, bool report, const char* reason);
815 public:
816 MethodCounters* get_method_counters(TRAPS) {
817 if (_method_counters == NULL) {
818 build_method_counters(this, CHECK_AND_CLEAR_NULL);
819 }
820 return _method_counters;
821 }
823 bool is_not_c1_compilable() const { return access_flags().is_not_c1_compilable(); }
824 void set_not_c1_compilable() { _access_flags.set_not_c1_compilable(); }
825 void clear_not_c1_compilable() { _access_flags.clear_not_c1_compilable(); }
826 bool is_not_c2_compilable() const { return access_flags().is_not_c2_compilable(); }
827 void set_not_c2_compilable() { _access_flags.set_not_c2_compilable(); }
828 void clear_not_c2_compilable() { _access_flags.clear_not_c2_compilable(); }
830 bool is_not_c1_osr_compilable() const { return is_not_c1_compilable(); } // don't waste an accessFlags bit
831 void set_not_c1_osr_compilable() { set_not_c1_compilable(); } // don't waste an accessFlags bit
832 void clear_not_c1_osr_compilable() { clear_not_c1_compilable(); } // don't waste an accessFlags bit
833 bool is_not_c2_osr_compilable() const { return access_flags().is_not_c2_osr_compilable(); }
834 void set_not_c2_osr_compilable() { _access_flags.set_not_c2_osr_compilable(); }
835 void clear_not_c2_osr_compilable() { _access_flags.clear_not_c2_osr_compilable(); }
837 // Background compilation support
838 bool queued_for_compilation() const { return access_flags().queued_for_compilation(); }
839 void set_queued_for_compilation() { _access_flags.set_queued_for_compilation(); }
840 void clear_queued_for_compilation() { _access_flags.clear_queued_for_compilation(); }
842 // Resolve all classes in signature, return 'true' if successful
843 static bool load_signature_classes(methodHandle m, TRAPS);
845 // Return if true if not all classes references in signature, including return type, has been loaded
846 static bool has_unloaded_classes_in_signature(methodHandle m, TRAPS);
848 // Printing
849 void print_short_name(outputStream* st = tty); // prints as klassname::methodname; Exposed so field engineers can debug VM
850 #if INCLUDE_JVMTI
851 void print_name(outputStream* st = tty); // prints as "virtual void foo(int)"; exposed for TraceRedefineClasses
852 #else
853 void print_name(outputStream* st = tty) PRODUCT_RETURN; // prints as "virtual void foo(int)"
854 #endif
856 // Helper routine used for method sorting
857 static void sort_methods(Array<Method*>* methods, bool idempotent = false, bool set_idnums = true);
859 // Deallocation function for redefine classes or if an error occurs
860 void deallocate_contents(ClassLoaderData* loader_data);
862 // Printing
863 #ifndef PRODUCT
864 void print_on(outputStream* st) const;
865 #endif
866 void print_value_on(outputStream* st) const;
868 const char* internal_name() const { return "{method}"; }
870 // Check for valid method pointer
871 static bool has_method_vptr(const void* ptr);
872 bool is_valid_method() const;
874 // Verify
875 void verify() { verify_on(tty); }
876 void verify_on(outputStream* st);
878 private:
880 // Inlined elements
881 address* native_function_addr() const { assert(is_native(), "must be native"); return (address*) (this+1); }
882 address* signature_handler_addr() const { return native_function_addr() + 1; }
883 };
886 // Utility class for compressing line number tables
888 class CompressedLineNumberWriteStream: public CompressedWriteStream {
889 private:
890 int _bci;
891 int _line;
892 public:
893 // Constructor
894 CompressedLineNumberWriteStream(int initial_size) : CompressedWriteStream(initial_size), _bci(0), _line(0) {}
895 CompressedLineNumberWriteStream(u_char* buffer, int initial_size) : CompressedWriteStream(buffer, initial_size), _bci(0), _line(0) {}
897 // Write (bci, line number) pair to stream
898 void write_pair_regular(int bci_delta, int line_delta);
900 inline void write_pair_inline(int bci, int line) {
901 int bci_delta = bci - _bci;
902 int line_delta = line - _line;
903 _bci = bci;
904 _line = line;
905 // Skip (0,0) deltas - they do not add information and conflict with terminator.
906 if (bci_delta == 0 && line_delta == 0) return;
907 // Check if bci is 5-bit and line number 3-bit unsigned.
908 if (((bci_delta & ~0x1F) == 0) && ((line_delta & ~0x7) == 0)) {
909 // Compress into single byte.
910 jubyte value = ((jubyte) bci_delta << 3) | (jubyte) line_delta;
911 // Check that value doesn't match escape character.
912 if (value != 0xFF) {
913 write_byte(value);
914 return;
915 }
916 }
917 write_pair_regular(bci_delta, line_delta);
918 }
920 // Windows AMD64 + Apr 2005 PSDK with /O2 generates bad code for write_pair.
921 // Disabling optimization doesn't work for methods in header files
922 // so we force it to call through the non-optimized version in the .cpp.
923 // It's gross, but it's the only way we can ensure that all callers are
924 // fixed. _MSC_VER is defined by the windows compiler
925 #if defined(_M_AMD64) && _MSC_VER >= 1400
926 void write_pair(int bci, int line);
927 #else
928 void write_pair(int bci, int line) { write_pair_inline(bci, line); }
929 #endif
931 // Write end-of-stream marker
932 void write_terminator() { write_byte(0); }
933 };
936 // Utility class for decompressing line number tables
938 class CompressedLineNumberReadStream: public CompressedReadStream {
939 private:
940 int _bci;
941 int _line;
942 public:
943 // Constructor
944 CompressedLineNumberReadStream(u_char* buffer);
945 // Read (bci, line number) pair from stream. Returns false at end-of-stream.
946 bool read_pair();
947 // Accessing bci and line number (after calling read_pair)
948 int bci() const { return _bci; }
949 int line() const { return _line; }
950 };
953 /// Fast Breakpoints.
955 // If this structure gets more complicated (because bpts get numerous),
956 // move it into its own header.
958 // There is presently no provision for concurrent access
959 // to breakpoint lists, which is only OK for JVMTI because
960 // breakpoints are written only at safepoints, and are read
961 // concurrently only outside of safepoints.
963 class BreakpointInfo : public CHeapObj<mtClass> {
964 friend class VMStructs;
965 private:
966 Bytecodes::Code _orig_bytecode;
967 int _bci;
968 u2 _name_index; // of method
969 u2 _signature_index; // of method
970 BreakpointInfo* _next; // simple storage allocation
972 public:
973 BreakpointInfo(Method* m, int bci);
975 // accessors
976 Bytecodes::Code orig_bytecode() { return _orig_bytecode; }
977 void set_orig_bytecode(Bytecodes::Code code) { _orig_bytecode = code; }
978 int bci() { return _bci; }
980 BreakpointInfo* next() const { return _next; }
981 void set_next(BreakpointInfo* n) { _next = n; }
983 // helps for searchers
984 bool match(const Method* m, int bci) {
985 return bci == _bci && match(m);
986 }
988 bool match(const Method* m) {
989 return _name_index == m->name_index() &&
990 _signature_index == m->signature_index();
991 }
993 void set(Method* method);
994 void clear(Method* method);
995 };
997 // Utility class for access exception handlers
998 class ExceptionTable : public StackObj {
999 private:
1000 ExceptionTableElement* _table;
1001 u2 _length;
1003 public:
1004 ExceptionTable(const Method* m) {
1005 if (m->has_exception_handler()) {
1006 _table = m->exception_table_start();
1007 _length = m->exception_table_length();
1008 } else {
1009 _table = NULL;
1010 _length = 0;
1011 }
1012 }
1014 int length() const {
1015 return _length;
1016 }
1018 u2 start_pc(int idx) const {
1019 assert(idx < _length, "out of bounds");
1020 return _table[idx].start_pc;
1021 }
1023 void set_start_pc(int idx, u2 value) {
1024 assert(idx < _length, "out of bounds");
1025 _table[idx].start_pc = value;
1026 }
1028 u2 end_pc(int idx) const {
1029 assert(idx < _length, "out of bounds");
1030 return _table[idx].end_pc;
1031 }
1033 void set_end_pc(int idx, u2 value) {
1034 assert(idx < _length, "out of bounds");
1035 _table[idx].end_pc = value;
1036 }
1038 u2 handler_pc(int idx) const {
1039 assert(idx < _length, "out of bounds");
1040 return _table[idx].handler_pc;
1041 }
1043 void set_handler_pc(int idx, u2 value) {
1044 assert(idx < _length, "out of bounds");
1045 _table[idx].handler_pc = value;
1046 }
1048 u2 catch_type_index(int idx) const {
1049 assert(idx < _length, "out of bounds");
1050 return _table[idx].catch_type_index;
1051 }
1053 void set_catch_type_index(int idx, u2 value) {
1054 assert(idx < _length, "out of bounds");
1055 _table[idx].catch_type_index = value;
1056 }
1057 };
1059 #endif // SHARE_VM_OOPS_METHODOOP_HPP