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