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