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