Tue, 30 Apr 2013 11:56:52 -0700
8011661: Insufficient memory message says "malloc" when sometimes it should say "mmap"
Reviewed-by: coleenp, zgu, hseigel
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 // | interp_invocation_count |
71 // |------------------------------------------------------|
72 // | access_flags |
73 // | vtable_index |
74 // |------------------------------------------------------|
75 // | result_index (C++ interpreter only) |
76 // |------------------------------------------------------|
77 // | method_size | intrinsic_id| flags |
78 // |------------------------------------------------------|
79 // | throwout_count | num_breakpoints |
80 // |------------------------------------------------------|
81 // | invocation_counter |
82 // | backedge_counter |
83 // |------------------------------------------------------|
84 // | prev_time (tiered only, 64 bit wide) |
85 // | |
86 // |------------------------------------------------------|
87 // | rate (tiered) |
88 // |------------------------------------------------------|
89 // | code (pointer) |
90 // | i2i (pointer) |
91 // | adapter (pointer) |
92 // | from_compiled_entry (pointer) |
93 // | from_interpreted_entry (pointer) |
94 // |------------------------------------------------------|
95 // | native_function (present only if native) |
96 // | signature_handler (present only if native) |
97 // |------------------------------------------------------|
100 class CheckedExceptionElement;
101 class LocalVariableTableElement;
102 class AdapterHandlerEntry;
103 class MethodData;
104 class MethodCounters;
105 class ConstMethod;
106 class InlineTableSizes;
107 class KlassSizeStats;
109 class Method : public Metadata {
110 friend class VMStructs;
111 private:
112 ConstMethod* _constMethod; // Method read-only data.
113 MethodData* _method_data;
114 MethodCounters* _method_counters;
115 AccessFlags _access_flags; // Access flags
116 int _vtable_index; // vtable index of this method (see VtableIndexFlag)
117 // note: can have vtables with >2**16 elements (because of inheritance)
118 #ifdef CC_INTERP
119 int _result_index; // C++ interpreter needs for converting results to/from stack
120 #endif
121 u2 _method_size; // size of this object
122 u1 _intrinsic_id; // vmSymbols::intrinsic_id (0 == _none)
123 u1 _jfr_towrite : 1, // Flags
124 _caller_sensitive : 1,
125 _force_inline : 1,
126 _hidden : 1,
127 _dont_inline : 1,
128 : 3;
130 #ifndef PRODUCT
131 int _compiled_invocation_count; // Number of nmethod invocations so far (for perf. debugging)
132 #endif
133 // Entry point for calling both from and to the interpreter.
134 address _i2i_entry; // All-args-on-stack calling convention
135 // Adapter blob (i2c/c2i) for this Method*. Set once when method is linked.
136 AdapterHandlerEntry* _adapter;
137 // Entry point for calling from compiled code, to compiled code if it exists
138 // or else the interpreter.
139 volatile address _from_compiled_entry; // Cache of: _code ? _code->entry_point() : _adapter->c2i_entry()
140 // The entry point for calling both from and to compiled code is
141 // "_code->entry_point()". Because of tiered compilation and de-opt, this
142 // field can come and go. It can transition from NULL to not-null at any
143 // time (whenever a compile completes). It can transition from not-null to
144 // NULL only at safepoints (because of a de-opt).
145 nmethod* volatile _code; // Points to the corresponding piece of native code
146 volatile address _from_interpreted_entry; // Cache of _code ? _adapter->i2c_entry() : _i2i_entry
148 // Constructor
149 Method(ConstMethod* xconst, AccessFlags access_flags, int size);
150 public:
152 static Method* allocate(ClassLoaderData* loader_data,
153 int byte_code_size,
154 AccessFlags access_flags,
155 InlineTableSizes* sizes,
156 ConstMethod::MethodType method_type,
157 TRAPS);
159 // CDS and vtbl checking can create an empty Method to get vtbl pointer.
160 Method(){}
162 // The Method vtable is restored by this call when the Method is in the
163 // shared archive. See patch_klass_vtables() in metaspaceShared.cpp for
164 // all the gory details. SA, dtrace and pstack helpers distinguish metadata
165 // by their vtable.
166 void restore_vtable() { guarantee(is_method(), "vtable restored by this call"); }
167 bool is_method() const volatile { return true; }
169 // accessors for instance variables
171 ConstMethod* constMethod() const { return _constMethod; }
172 void set_constMethod(ConstMethod* xconst) { _constMethod = xconst; }
175 static address make_adapters(methodHandle mh, TRAPS);
176 volatile address from_compiled_entry() const { return (address)OrderAccess::load_ptr_acquire(&_from_compiled_entry); }
177 volatile address from_interpreted_entry() const{ return (address)OrderAccess::load_ptr_acquire(&_from_interpreted_entry); }
179 // access flag
180 AccessFlags access_flags() const { return _access_flags; }
181 void set_access_flags(AccessFlags flags) { _access_flags = flags; }
183 // name
184 Symbol* name() const { return constants()->symbol_at(name_index()); }
185 int name_index() const { return constMethod()->name_index(); }
186 void set_name_index(int index) { constMethod()->set_name_index(index); }
188 // signature
189 Symbol* signature() const { return constants()->symbol_at(signature_index()); }
190 int signature_index() const { return constMethod()->signature_index(); }
191 void set_signature_index(int index) { constMethod()->set_signature_index(index); }
193 // generics support
194 Symbol* generic_signature() const { int idx = generic_signature_index(); return ((idx != 0) ? constants()->symbol_at(idx) : (Symbol*)NULL); }
195 int generic_signature_index() const { return constMethod()->generic_signature_index(); }
196 void set_generic_signature_index(int index) { constMethod()->set_generic_signature_index(index); }
198 // annotations support
199 AnnotationArray* annotations() const {
200 return constMethod()->method_annotations();
201 }
202 AnnotationArray* parameter_annotations() const {
203 return constMethod()->parameter_annotations();
204 }
205 AnnotationArray* annotation_default() const {
206 return constMethod()->default_annotations();
207 }
208 AnnotationArray* type_annotations() const {
209 return constMethod()->type_annotations();
210 }
212 #ifdef CC_INTERP
213 void set_result_index(BasicType type);
214 int result_index() { return _result_index; }
215 #endif
217 // Helper routine: get klass name + "." + method name + signature as
218 // C string, for the purpose of providing more useful NoSuchMethodErrors
219 // and fatal error handling. The string is allocated in resource
220 // area if a buffer is not provided by the caller.
221 char* name_and_sig_as_C_string() const;
222 char* name_and_sig_as_C_string(char* buf, int size) const;
224 // Static routine in the situations we don't have a Method*
225 static char* name_and_sig_as_C_string(Klass* klass, Symbol* method_name, Symbol* signature);
226 static char* name_and_sig_as_C_string(Klass* klass, Symbol* method_name, Symbol* signature, char* buf, int size);
228 Bytecodes::Code java_code_at(int bci) const {
229 return Bytecodes::java_code_at(this, bcp_from(bci));
230 }
231 Bytecodes::Code code_at(int bci) const {
232 return Bytecodes::code_at(this, bcp_from(bci));
233 }
235 // JVMTI breakpoints
236 Bytecodes::Code orig_bytecode_at(int bci) const;
237 void set_orig_bytecode_at(int bci, Bytecodes::Code code);
238 void set_breakpoint(int bci);
239 void clear_breakpoint(int bci);
240 void clear_all_breakpoints();
241 // Tracking number of breakpoints, for fullspeed debugging.
242 // Only mutated by VM thread.
243 u2 number_of_breakpoints() const {
244 if (method_counters() == NULL) {
245 return 0;
246 } else {
247 return method_counters()->number_of_breakpoints();
248 }
249 }
250 void incr_number_of_breakpoints(TRAPS) {
251 MethodCounters* mcs = get_method_counters(CHECK);
252 if (mcs != NULL) {
253 mcs->incr_number_of_breakpoints();
254 }
255 }
256 void decr_number_of_breakpoints(TRAPS) {
257 MethodCounters* mcs = get_method_counters(CHECK);
258 if (mcs != NULL) {
259 mcs->decr_number_of_breakpoints();
260 }
261 }
262 // Initialization only
263 void clear_number_of_breakpoints() {
264 if (method_counters() != NULL) {
265 method_counters()->clear_number_of_breakpoints();
266 }
267 }
269 // index into InstanceKlass methods() array
270 // note: also used by jfr
271 u2 method_idnum() const { return constMethod()->method_idnum(); }
272 void set_method_idnum(u2 idnum) { constMethod()->set_method_idnum(idnum); }
274 // code size
275 int code_size() const { return constMethod()->code_size(); }
277 // method size
278 int method_size() const { return _method_size; }
279 void set_method_size(int size) {
280 assert(0 <= size && size < (1 << 16), "invalid method size");
281 _method_size = size;
282 }
284 // constant pool for Klass* holding this method
285 ConstantPool* constants() const { return constMethod()->constants(); }
286 void set_constants(ConstantPool* c) { constMethod()->set_constants(c); }
288 // max stack
289 // return original max stack size for method verification
290 int verifier_max_stack() const { return constMethod()->max_stack(); }
291 int max_stack() const { return constMethod()->max_stack() + extra_stack_entries(); }
292 void set_max_stack(int size) { constMethod()->set_max_stack(size); }
294 // max locals
295 int max_locals() const { return constMethod()->max_locals(); }
296 void set_max_locals(int size) { constMethod()->set_max_locals(size); }
298 int highest_comp_level() const;
299 void set_highest_comp_level(int level);
300 int highest_osr_comp_level() const;
301 void set_highest_osr_comp_level(int level);
303 // Count of times method was exited via exception while interpreting
304 void interpreter_throwout_increment(TRAPS) {
305 MethodCounters* mcs = get_method_counters(CHECK);
306 if (mcs != NULL) {
307 mcs->interpreter_throwout_increment();
308 }
309 }
311 int interpreter_throwout_count() const {
312 if (method_counters() == NULL) {
313 return 0;
314 } else {
315 return method_counters()->interpreter_throwout_count();
316 }
317 }
319 // size of parameters
320 int size_of_parameters() const { return constMethod()->size_of_parameters(); }
321 void set_size_of_parameters(int size) { constMethod()->set_size_of_parameters(size); }
323 bool has_stackmap_table() const {
324 return constMethod()->has_stackmap_table();
325 }
327 Array<u1>* stackmap_data() const {
328 return constMethod()->stackmap_data();
329 }
331 void set_stackmap_data(Array<u1>* sd) {
332 constMethod()->set_stackmap_data(sd);
333 }
335 // exception handler table
336 bool has_exception_handler() const
337 { return constMethod()->has_exception_handler(); }
338 int exception_table_length() const
339 { return constMethod()->exception_table_length(); }
340 ExceptionTableElement* exception_table_start() const
341 { return constMethod()->exception_table_start(); }
343 // Finds the first entry point bci of an exception handler for an
344 // exception of klass ex_klass thrown at throw_bci. A value of NULL
345 // for ex_klass indicates that the exception klass is not known; in
346 // this case it matches any constraint class. Returns -1 if the
347 // exception cannot be handled in this method. The handler
348 // constraint classes are loaded if necessary. Note that this may
349 // throw an exception if loading of the constraint classes causes
350 // an IllegalAccessError (bugid 4307310) or an OutOfMemoryError.
351 // If an exception is thrown, returns the bci of the
352 // exception handler which caused the exception to be thrown, which
353 // is needed for proper retries. See, for example,
354 // InterpreterRuntime::exception_handler_for_exception.
355 static int fast_exception_handler_bci_for(methodHandle mh, KlassHandle ex_klass, int throw_bci, TRAPS);
357 // method data access
358 MethodData* method_data() const {
359 return _method_data;
360 }
362 void set_method_data(MethodData* data) {
363 _method_data = data;
364 }
366 MethodCounters* method_counters() const {
367 return _method_counters;
368 }
371 void set_method_counters(MethodCounters* counters) {
372 _method_counters = counters;
373 }
375 #ifdef TIERED
376 // We are reusing interpreter_invocation_count as a holder for the previous event count!
377 // We can do that since interpreter_invocation_count is not used in tiered.
378 int prev_event_count() const {
379 if (method_counters() == NULL) {
380 return 0;
381 } else {
382 return method_counters()->interpreter_invocation_count();
383 }
384 }
385 void set_prev_event_count(int count, TRAPS) {
386 MethodCounters* mcs = get_method_counters(CHECK);
387 if (mcs != NULL) {
388 mcs->set_interpreter_invocation_count(count);
389 }
390 }
391 jlong prev_time() const {
392 return method_counters() == NULL ? 0 : method_counters()->prev_time();
393 }
394 void set_prev_time(jlong time, TRAPS) {
395 MethodCounters* mcs = get_method_counters(CHECK);
396 if (mcs != NULL) {
397 mcs->set_prev_time(time);
398 }
399 }
400 float rate() const {
401 return method_counters() == NULL ? 0 : method_counters()->rate();
402 }
403 void set_rate(float rate, TRAPS) {
404 MethodCounters* mcs = get_method_counters(CHECK);
405 if (mcs != NULL) {
406 mcs->set_rate(rate);
407 }
408 }
409 #endif
411 int invocation_count();
412 int backedge_count();
414 bool was_executed_more_than(int n);
415 bool was_never_executed() { return !was_executed_more_than(0); }
417 static void build_interpreter_method_data(methodHandle method, TRAPS);
419 static MethodCounters* build_method_counters(Method* m, TRAPS);
421 int interpreter_invocation_count() {
422 if (TieredCompilation) return invocation_count();
423 else return (method_counters() == NULL) ? 0 :
424 method_counters()->interpreter_invocation_count();
425 }
426 int increment_interpreter_invocation_count(TRAPS) {
427 if (TieredCompilation) ShouldNotReachHere();
428 MethodCounters* mcs = get_method_counters(CHECK_0);
429 return (mcs == NULL) ? 0 : mcs->increment_interpreter_invocation_count();
430 }
432 #ifndef PRODUCT
433 int compiled_invocation_count() const { return _compiled_invocation_count; }
434 void set_compiled_invocation_count(int count) { _compiled_invocation_count = count; }
435 #endif // not PRODUCT
437 // Clear (non-shared space) pointers which could not be relevant
438 // if this (shared) method were mapped into another JVM.
439 void remove_unshareable_info();
441 // nmethod/verified compiler entry
442 address verified_code_entry();
443 bool check_code() const; // Not inline to avoid circular ref
444 nmethod* volatile code() const { assert( check_code(), "" ); return (nmethod *)OrderAccess::load_ptr_acquire(&_code); }
445 void clear_code(); // Clear out any compiled code
446 static void set_code(methodHandle mh, nmethod* code);
447 void set_adapter_entry(AdapterHandlerEntry* adapter) { _adapter = adapter; }
448 address get_i2c_entry();
449 address get_c2i_entry();
450 address get_c2i_unverified_entry();
451 AdapterHandlerEntry* adapter() { return _adapter; }
452 // setup entry points
453 void link_method(methodHandle method, TRAPS);
454 // clear entry points. Used by sharing code
455 void unlink_method();
457 // vtable index
458 enum VtableIndexFlag {
459 // Valid vtable indexes are non-negative (>= 0).
460 // These few negative values are used as sentinels.
461 highest_unused_vtable_index_value = -5,
462 invalid_vtable_index = -4, // distinct from any valid vtable index
463 garbage_vtable_index = -3, // not yet linked; no vtable layout yet
464 nonvirtual_vtable_index = -2 // there is no need for vtable dispatch
465 // 6330203 Note: Do not use -1, which was overloaded with many meanings.
466 };
467 DEBUG_ONLY(bool valid_vtable_index() const { return _vtable_index >= nonvirtual_vtable_index; })
468 int vtable_index() const { assert(valid_vtable_index(), "");
469 return _vtable_index; }
470 void set_vtable_index(int index) { _vtable_index = index; }
472 // interpreter entry
473 address interpreter_entry() const { return _i2i_entry; }
474 // Only used when first initialize so we can set _i2i_entry and _from_interpreted_entry
475 void set_interpreter_entry(address entry) { _i2i_entry = entry; _from_interpreted_entry = entry; }
477 // native function (used for native methods only)
478 enum {
479 native_bind_event_is_interesting = true
480 };
481 address native_function() const { return *(native_function_addr()); }
482 address critical_native_function();
484 // Must specify a real function (not NULL).
485 // Use clear_native_function() to unregister.
486 void set_native_function(address function, bool post_event_flag);
487 bool has_native_function() const;
488 void clear_native_function();
490 // signature handler (used for native methods only)
491 address signature_handler() const { return *(signature_handler_addr()); }
492 void set_signature_handler(address handler);
494 // Interpreter oopmap support
495 void mask_for(int bci, InterpreterOopMap* mask);
497 #ifndef PRODUCT
498 // operations on invocation counter
499 void print_invocation_count();
500 #endif
502 // byte codes
503 void set_code(address code) { return constMethod()->set_code(code); }
504 address code_base() const { return constMethod()->code_base(); }
505 bool contains(address bcp) const { return constMethod()->contains(bcp); }
507 // prints byte codes
508 void print_codes() const { print_codes_on(tty); }
509 void print_codes_on(outputStream* st) const PRODUCT_RETURN;
510 void print_codes_on(int from, int to, outputStream* st) const PRODUCT_RETURN;
512 // method parameters
513 bool has_method_parameters() const
514 { return constMethod()->has_method_parameters(); }
515 int method_parameters_length() const
516 { return constMethod()->method_parameters_length(); }
517 MethodParametersElement* method_parameters_start() const
518 { return constMethod()->method_parameters_start(); }
520 // checked exceptions
521 int checked_exceptions_length() const
522 { return constMethod()->checked_exceptions_length(); }
523 CheckedExceptionElement* checked_exceptions_start() const
524 { return constMethod()->checked_exceptions_start(); }
526 // localvariable table
527 bool has_localvariable_table() const
528 { return constMethod()->has_localvariable_table(); }
529 int localvariable_table_length() const
530 { return constMethod()->localvariable_table_length(); }
531 LocalVariableTableElement* localvariable_table_start() const
532 { return constMethod()->localvariable_table_start(); }
534 bool has_linenumber_table() const
535 { return constMethod()->has_linenumber_table(); }
536 u_char* compressed_linenumber_table() const
537 { return constMethod()->compressed_linenumber_table(); }
539 // method holder (the Klass* holding this method)
540 InstanceKlass* method_holder() const { return constants()->pool_holder(); }
542 void compute_size_of_parameters(Thread *thread); // word size of parameters (receiver if any + arguments)
543 Symbol* klass_name() const; // returns the name of the method holder
544 BasicType result_type() const; // type of the method result
545 int result_type_index() const; // type index of the method result
546 bool is_returning_oop() const { BasicType r = result_type(); return (r == T_OBJECT || r == T_ARRAY); }
547 bool is_returning_fp() const { BasicType r = result_type(); return (r == T_FLOAT || r == T_DOUBLE); }
549 // Checked exceptions thrown by this method (resolved to mirrors)
550 objArrayHandle resolved_checked_exceptions(TRAPS) { return resolved_checked_exceptions_impl(this, THREAD); }
552 // Access flags
553 bool is_public() const { return access_flags().is_public(); }
554 bool is_private() const { return access_flags().is_private(); }
555 bool is_protected() const { return access_flags().is_protected(); }
556 bool is_package_private() const { return !is_public() && !is_private() && !is_protected(); }
557 bool is_static() const { return access_flags().is_static(); }
558 bool is_final() const { return access_flags().is_final(); }
559 bool is_synchronized() const { return access_flags().is_synchronized();}
560 bool is_native() const { return access_flags().is_native(); }
561 bool is_abstract() const { return access_flags().is_abstract(); }
562 bool is_strict() const { return access_flags().is_strict(); }
563 bool is_synthetic() const { return access_flags().is_synthetic(); }
565 // returns true if contains only return operation
566 bool is_empty_method() const;
568 // returns true if this is a vanilla constructor
569 bool is_vanilla_constructor() const;
571 // checks method and its method holder
572 bool is_final_method() const;
573 bool is_strict_method() const;
575 // true if method needs no dynamic dispatch (final and/or no vtable entry)
576 bool can_be_statically_bound() const;
578 // returns true if the method has any backward branches.
579 bool has_loops() {
580 return access_flags().loops_flag_init() ? access_flags().has_loops() : compute_has_loops_flag();
581 };
583 bool compute_has_loops_flag();
585 bool has_jsrs() {
586 return access_flags().has_jsrs();
587 };
588 void set_has_jsrs() {
589 _access_flags.set_has_jsrs();
590 }
592 // returns true if the method has any monitors.
593 bool has_monitors() const { return is_synchronized() || access_flags().has_monitor_bytecodes(); }
594 bool has_monitor_bytecodes() const { return access_flags().has_monitor_bytecodes(); }
596 void set_has_monitor_bytecodes() { _access_flags.set_has_monitor_bytecodes(); }
598 // monitor matching. This returns a conservative estimate of whether the monitorenter/monitorexit bytecodes
599 // propererly nest in the method. It might return false, even though they actually nest properly, since the info.
600 // has not been computed yet.
601 bool guaranteed_monitor_matching() const { return access_flags().is_monitor_matching(); }
602 void set_guaranteed_monitor_matching() { _access_flags.set_monitor_matching(); }
604 // returns true if the method is an accessor function (setter/getter).
605 bool is_accessor() const;
607 // returns true if the method is an initializer (<init> or <clinit>).
608 bool is_initializer() const;
610 // returns true if the method is static OR if the classfile version < 51
611 bool has_valid_initializer_flags() const;
613 // returns true if the method name is <clinit> and the method has
614 // valid static initializer flags.
615 bool is_static_initializer() const;
617 // compiled code support
618 // NOTE: code() is inherently racy as deopt can be clearing code
619 // simultaneously. Use with caution.
620 bool has_compiled_code() const { return code() != NULL; }
622 // sizing
623 static int header_size() { return sizeof(Method)/HeapWordSize; }
624 static int size(bool is_native);
625 int size() const { return method_size(); }
626 #if INCLUDE_SERVICES
627 void collect_statistics(KlassSizeStats *sz) const;
628 #endif
630 // interpreter support
631 static ByteSize const_offset() { return byte_offset_of(Method, _constMethod ); }
632 static ByteSize access_flags_offset() { return byte_offset_of(Method, _access_flags ); }
633 #ifdef CC_INTERP
634 static ByteSize result_index_offset() { return byte_offset_of(Method, _result_index ); }
635 #endif /* CC_INTERP */
636 static ByteSize from_compiled_offset() { return byte_offset_of(Method, _from_compiled_entry); }
637 static ByteSize code_offset() { return byte_offset_of(Method, _code); }
638 static ByteSize method_data_offset() {
639 return byte_offset_of(Method, _method_data);
640 }
641 static ByteSize method_counters_offset() {
642 return byte_offset_of(Method, _method_counters);
643 }
644 #ifndef PRODUCT
645 static ByteSize compiled_invocation_counter_offset() { return byte_offset_of(Method, _compiled_invocation_count); }
646 #endif // not PRODUCT
647 static ByteSize native_function_offset() { return in_ByteSize(sizeof(Method)); }
648 static ByteSize from_interpreted_offset() { return byte_offset_of(Method, _from_interpreted_entry ); }
649 static ByteSize interpreter_entry_offset() { return byte_offset_of(Method, _i2i_entry ); }
650 static ByteSize signature_handler_offset() { return in_ByteSize(sizeof(Method) + wordSize); }
652 // for code generation
653 static int method_data_offset_in_bytes() { return offset_of(Method, _method_data); }
654 static int intrinsic_id_offset_in_bytes() { return offset_of(Method, _intrinsic_id); }
655 static int intrinsic_id_size_in_bytes() { return sizeof(u1); }
657 // Static methods that are used to implement member methods where an exposed this pointer
658 // is needed due to possible GCs
659 static objArrayHandle resolved_checked_exceptions_impl(Method* this_oop, TRAPS);
661 // Returns the byte code index from the byte code pointer
662 int bci_from(address bcp) const;
663 address bcp_from(int bci) const;
664 int validate_bci_from_bcx(intptr_t bcx) const;
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;
670 // Reflection support
671 bool is_overridden_in(Klass* k) const;
673 // Stack walking support
674 bool is_ignored_by_security_stack_walk() const;
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 // these operate only on invoke methods:
685 // presize interpreter frames for extra interpreter stack entries, if needed
686 // method handles want to be able to push a few extra values (e.g., a bound receiver), and
687 // invokedynamic sometimes needs to push a bootstrap method, call site, and arglist,
688 // all without checking for a stack overflow
689 static int extra_stack_entries() { return EnableInvokeDynamic ? 2 : 0; }
690 static int extra_stack_words(); // = extra_stack_entries() * Interpreter::stackElementSize()
692 // RedefineClasses() support:
693 bool is_old() const { return access_flags().is_old(); }
694 void set_is_old() { _access_flags.set_is_old(); }
695 bool is_obsolete() const { return access_flags().is_obsolete(); }
696 void set_is_obsolete() { _access_flags.set_is_obsolete(); }
697 bool on_stack() const { return access_flags().on_stack(); }
698 void set_on_stack(const bool value);
700 // see the definition in Method*.cpp for the gory details
701 bool should_not_be_cached() const;
703 // JVMTI Native method prefixing support:
704 bool is_prefixed_native() const { return access_flags().is_prefixed_native(); }
705 void set_is_prefixed_native() { _access_flags.set_is_prefixed_native(); }
707 // Rewriting support
708 static methodHandle clone_with_new_data(methodHandle m, u_char* new_code, int new_code_length,
709 u_char* new_compressed_linenumber_table, int new_compressed_linenumber_size, TRAPS);
711 // jmethodID handling
712 // Because the useful life-span of a jmethodID cannot be determined,
713 // once created they are never reclaimed. The methods to which they refer,
714 // however, can be GC'ed away if the class is unloaded or if the method is
715 // made obsolete or deleted -- in these cases, the jmethodID
716 // refers to NULL (as is the case for any weak reference).
717 static jmethodID make_jmethod_id(ClassLoaderData* loader_data, Method* mh);
718 static void destroy_jmethod_id(ClassLoaderData* loader_data, jmethodID mid);
720 // Use resolve_jmethod_id() in situations where the caller is expected
721 // to provide a valid jmethodID; the only sanity checks are in asserts;
722 // result guaranteed not to be NULL.
723 inline static Method* resolve_jmethod_id(jmethodID mid) {
724 assert(mid != NULL, "JNI method id should not be null");
725 return *((Method**)mid);
726 }
728 // Use checked_resolve_jmethod_id() in situations where the caller
729 // should provide a valid jmethodID, but might not. NULL is returned
730 // when the jmethodID does not refer to a valid method.
731 static Method* checked_resolve_jmethod_id(jmethodID mid);
733 static void change_method_associated_with_jmethod_id(jmethodID old_jmid_ptr, Method* new_method);
734 static bool is_method_id(jmethodID mid);
736 // Clear methods
737 static void clear_jmethod_ids(ClassLoaderData* loader_data);
738 static void print_jmethod_ids(ClassLoaderData* loader_data, outputStream* out) PRODUCT_RETURN;
740 // Get this method's jmethodID -- allocate if it doesn't exist
741 jmethodID jmethod_id() { methodHandle this_h(this);
742 return InstanceKlass::get_jmethod_id(method_holder(), this_h); }
744 // Lookup the jmethodID for this method. Return NULL if not found.
745 // NOTE that this function can be called from a signal handler
746 // (see AsyncGetCallTrace support for Forte Analyzer) and this
747 // needs to be async-safe. No allocation should be done and
748 // so handles are not used to avoid deadlock.
749 jmethodID find_jmethod_id_or_null() { return method_holder()->jmethod_id_or_null(this); }
751 // JNI static invoke cached itable index accessors
752 int cached_itable_index() { return method_holder()->cached_itable_index(method_idnum()); }
753 void set_cached_itable_index(int index) { method_holder()->set_cached_itable_index(method_idnum(), index); }
755 // Support for inlining of intrinsic methods
756 vmIntrinsics::ID intrinsic_id() const { return (vmIntrinsics::ID) _intrinsic_id; }
757 void set_intrinsic_id(vmIntrinsics::ID id) { _intrinsic_id = (u1) id; }
759 // Helper routines for intrinsic_id() and vmIntrinsics::method().
760 void init_intrinsic_id(); // updates from _none if a match
761 static vmSymbols::SID klass_id_for_intrinsics(Klass* holder);
763 bool jfr_towrite() { return _jfr_towrite; }
764 void set_jfr_towrite(bool x) { _jfr_towrite = x; }
765 bool caller_sensitive() { return _caller_sensitive; }
766 void set_caller_sensitive(bool x) { _caller_sensitive = x; }
767 bool force_inline() { return _force_inline; }
768 void set_force_inline(bool x) { _force_inline = x; }
769 bool dont_inline() { return _dont_inline; }
770 void set_dont_inline(bool x) { _dont_inline = x; }
771 bool is_hidden() { return _hidden; }
772 void set_hidden(bool x) { _hidden = x; }
773 ConstMethod::MethodType method_type() const {
774 return _constMethod->method_type();
775 }
776 bool is_overpass() const { return method_type() == ConstMethod::OVERPASS; }
778 // On-stack replacement support
779 bool has_osr_nmethod(int level, bool match_level) {
780 return method_holder()->lookup_osr_nmethod(this, InvocationEntryBci, level, match_level) != NULL;
781 }
783 nmethod* lookup_osr_nmethod_for(int bci, int level, bool match_level) {
784 return method_holder()->lookup_osr_nmethod(this, bci, level, match_level);
785 }
787 // Inline cache support
788 void cleanup_inline_caches();
790 // Find if klass for method is loaded
791 bool is_klass_loaded_by_klass_index(int klass_index) const;
792 bool is_klass_loaded(int refinfo_index, bool must_be_resolved = false) const;
794 // Indicates whether compilation failed earlier for this method, or
795 // whether it is not compilable for another reason like having a
796 // breakpoint set in it.
797 bool is_not_compilable(int comp_level = CompLevel_any) const;
798 void set_not_compilable(int comp_level = CompLevel_all, bool report = true, const char* reason = NULL);
799 void set_not_compilable_quietly(int comp_level = CompLevel_all) {
800 set_not_compilable(comp_level, false);
801 }
802 bool is_not_osr_compilable(int comp_level = CompLevel_any) const;
803 void set_not_osr_compilable(int comp_level = CompLevel_all, bool report = true, const char* reason = NULL);
804 void set_not_osr_compilable_quietly(int comp_level = CompLevel_all) {
805 set_not_osr_compilable(comp_level, false);
806 }
808 private:
809 void print_made_not_compilable(int comp_level, bool is_osr, bool report, const char* reason);
811 MethodCounters* get_method_counters(TRAPS) {
812 if (_method_counters == NULL) {
813 build_method_counters(this, CHECK_AND_CLEAR_NULL);
814 }
815 return _method_counters;
816 }
818 public:
819 bool is_not_c1_compilable() const { return access_flags().is_not_c1_compilable(); }
820 void set_not_c1_compilable() { _access_flags.set_not_c1_compilable(); }
821 void clear_not_c1_compilable() { _access_flags.clear_not_c1_compilable(); }
822 bool is_not_c2_compilable() const { return access_flags().is_not_c2_compilable(); }
823 void set_not_c2_compilable() { _access_flags.set_not_c2_compilable(); }
824 void clear_not_c2_compilable() { _access_flags.clear_not_c2_compilable(); }
826 bool is_not_c1_osr_compilable() const { return is_not_c1_compilable(); } // don't waste an accessFlags bit
827 void set_not_c1_osr_compilable() { set_not_c1_compilable(); } // don't waste an accessFlags bit
828 void clear_not_c1_osr_compilable() { clear_not_c1_compilable(); } // don't waste an accessFlags bit
829 bool is_not_c2_osr_compilable() const { return access_flags().is_not_c2_osr_compilable(); }
830 void set_not_c2_osr_compilable() { _access_flags.set_not_c2_osr_compilable(); }
831 void clear_not_c2_osr_compilable() { _access_flags.clear_not_c2_osr_compilable(); }
833 // Background compilation support
834 bool queued_for_compilation() const { return access_flags().queued_for_compilation(); }
835 void set_queued_for_compilation() { _access_flags.set_queued_for_compilation(); }
836 void clear_queued_for_compilation() { _access_flags.clear_queued_for_compilation(); }
838 // Resolve all classes in signature, return 'true' if successful
839 static bool load_signature_classes(methodHandle m, TRAPS);
841 // Return if true if not all classes references in signature, including return type, has been loaded
842 static bool has_unloaded_classes_in_signature(methodHandle m, TRAPS);
844 // Printing
845 void print_short_name(outputStream* st = tty); // prints as klassname::methodname; Exposed so field engineers can debug VM
846 #if INCLUDE_JVMTI
847 void print_name(outputStream* st = tty); // prints as "virtual void foo(int)"; exposed for TraceRedefineClasses
848 #else
849 void print_name(outputStream* st = tty) PRODUCT_RETURN; // prints as "virtual void foo(int)"
850 #endif
852 // Helper routine used for method sorting
853 static void sort_methods(Array<Method*>* methods, bool idempotent = false);
855 // Deallocation function for redefine classes or if an error occurs
856 void deallocate_contents(ClassLoaderData* loader_data);
858 // Printing
859 #ifndef PRODUCT
860 void print_on(outputStream* st) const;
861 #endif
862 void print_value_on(outputStream* st) const;
864 const char* internal_name() const { return "{method}"; }
866 // Check for valid method pointer
867 bool is_valid_method() const;
869 // Verify
870 void verify() { verify_on(tty); }
871 void verify_on(outputStream* st);
873 private:
875 // Inlined elements
876 address* native_function_addr() const { assert(is_native(), "must be native"); return (address*) (this+1); }
877 address* signature_handler_addr() const { return native_function_addr() + 1; }
878 };
881 // Utility class for compressing line number tables
883 class CompressedLineNumberWriteStream: public CompressedWriteStream {
884 private:
885 int _bci;
886 int _line;
887 public:
888 // Constructor
889 CompressedLineNumberWriteStream(int initial_size) : CompressedWriteStream(initial_size), _bci(0), _line(0) {}
890 CompressedLineNumberWriteStream(u_char* buffer, int initial_size) : CompressedWriteStream(buffer, initial_size), _bci(0), _line(0) {}
892 // Write (bci, line number) pair to stream
893 void write_pair_regular(int bci_delta, int line_delta);
895 inline void write_pair_inline(int bci, int line) {
896 int bci_delta = bci - _bci;
897 int line_delta = line - _line;
898 _bci = bci;
899 _line = line;
900 // Skip (0,0) deltas - they do not add information and conflict with terminator.
901 if (bci_delta == 0 && line_delta == 0) return;
902 // Check if bci is 5-bit and line number 3-bit unsigned.
903 if (((bci_delta & ~0x1F) == 0) && ((line_delta & ~0x7) == 0)) {
904 // Compress into single byte.
905 jubyte value = ((jubyte) bci_delta << 3) | (jubyte) line_delta;
906 // Check that value doesn't match escape character.
907 if (value != 0xFF) {
908 write_byte(value);
909 return;
910 }
911 }
912 write_pair_regular(bci_delta, line_delta);
913 }
915 // Windows AMD64 + Apr 2005 PSDK with /O2 generates bad code for write_pair.
916 // Disabling optimization doesn't work for methods in header files
917 // so we force it to call through the non-optimized version in the .cpp.
918 // It's gross, but it's the only way we can ensure that all callers are
919 // fixed. _MSC_VER is defined by the windows compiler
920 #if defined(_M_AMD64) && _MSC_VER >= 1400
921 void write_pair(int bci, int line);
922 #else
923 void write_pair(int bci, int line) { write_pair_inline(bci, line); }
924 #endif
926 // Write end-of-stream marker
927 void write_terminator() { write_byte(0); }
928 };
931 // Utility class for decompressing line number tables
933 class CompressedLineNumberReadStream: public CompressedReadStream {
934 private:
935 int _bci;
936 int _line;
937 public:
938 // Constructor
939 CompressedLineNumberReadStream(u_char* buffer);
940 // Read (bci, line number) pair from stream. Returns false at end-of-stream.
941 bool read_pair();
942 // Accessing bci and line number (after calling read_pair)
943 int bci() const { return _bci; }
944 int line() const { return _line; }
945 };
948 /// Fast Breakpoints.
950 // If this structure gets more complicated (because bpts get numerous),
951 // move it into its own header.
953 // There is presently no provision for concurrent access
954 // to breakpoint lists, which is only OK for JVMTI because
955 // breakpoints are written only at safepoints, and are read
956 // concurrently only outside of safepoints.
958 class BreakpointInfo : public CHeapObj<mtClass> {
959 friend class VMStructs;
960 private:
961 Bytecodes::Code _orig_bytecode;
962 int _bci;
963 u2 _name_index; // of method
964 u2 _signature_index; // of method
965 BreakpointInfo* _next; // simple storage allocation
967 public:
968 BreakpointInfo(Method* m, int bci);
970 // accessors
971 Bytecodes::Code orig_bytecode() { return _orig_bytecode; }
972 void set_orig_bytecode(Bytecodes::Code code) { _orig_bytecode = code; }
973 int bci() { return _bci; }
975 BreakpointInfo* next() const { return _next; }
976 void set_next(BreakpointInfo* n) { _next = n; }
978 // helps for searchers
979 bool match(const Method* m, int bci) {
980 return bci == _bci && match(m);
981 }
983 bool match(const Method* m) {
984 return _name_index == m->name_index() &&
985 _signature_index == m->signature_index();
986 }
988 void set(Method* method);
989 void clear(Method* method);
990 };
992 // Utility class for access exception handlers
993 class ExceptionTable : public StackObj {
994 private:
995 ExceptionTableElement* _table;
996 u2 _length;
998 public:
999 ExceptionTable(Method* m) {
1000 if (m->has_exception_handler()) {
1001 _table = m->exception_table_start();
1002 _length = m->exception_table_length();
1003 } else {
1004 _table = NULL;
1005 _length = 0;
1006 }
1007 }
1009 int length() const {
1010 return _length;
1011 }
1013 u2 start_pc(int idx) const {
1014 assert(idx < _length, "out of bounds");
1015 return _table[idx].start_pc;
1016 }
1018 void set_start_pc(int idx, u2 value) {
1019 assert(idx < _length, "out of bounds");
1020 _table[idx].start_pc = value;
1021 }
1023 u2 end_pc(int idx) const {
1024 assert(idx < _length, "out of bounds");
1025 return _table[idx].end_pc;
1026 }
1028 void set_end_pc(int idx, u2 value) {
1029 assert(idx < _length, "out of bounds");
1030 _table[idx].end_pc = value;
1031 }
1033 u2 handler_pc(int idx) const {
1034 assert(idx < _length, "out of bounds");
1035 return _table[idx].handler_pc;
1036 }
1038 void set_handler_pc(int idx, u2 value) {
1039 assert(idx < _length, "out of bounds");
1040 _table[idx].handler_pc = value;
1041 }
1043 u2 catch_type_index(int idx) const {
1044 assert(idx < _length, "out of bounds");
1045 return _table[idx].catch_type_index;
1046 }
1048 void set_catch_type_index(int idx, u2 value) {
1049 assert(idx < _length, "out of bounds");
1050 _table[idx].catch_type_index = value;
1051 }
1052 };
1054 #endif // SHARE_VM_OOPS_METHODOOP_HPP