rev 55090 : secret-sfac
1 /*
2 * Copyright (c) 1997, 2019, 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_OOPS_METHOD_HPP
26 #define SHARE_OOPS_METHOD_HPP
27
28 #include "classfile/vmSymbols.hpp"
29 #include "code/compressedStream.hpp"
30 #include "compiler/compilerDefinitions.hpp"
31 #include "compiler/oopMap.hpp"
32 #include "interpreter/invocationCounter.hpp"
33 #include "oops/annotations.hpp"
34 #include "oops/constantPool.hpp"
35 #include "oops/methodCounters.hpp"
36 #include "oops/instanceKlass.hpp"
37 #include "oops/oop.hpp"
38 #include "oops/typeArrayOop.hpp"
39 #include "utilities/accessFlags.hpp"
40 #include "utilities/align.hpp"
41 #include "utilities/growableArray.hpp"
42 #include "utilities/macros.hpp"
43 #if INCLUDE_JFR
44 #include "jfr/support/jfrTraceIdExtension.hpp"
45 #endif
46
47
48 // A Method represents a Java method.
49 //
50 // Note that most applications load thousands of methods, so keeping the size of this
51 // class small has a big impact on footprint.
52 //
53 // Note that native_function and signature_handler have to be at fixed offsets
54 // (required by the interpreter)
55 //
56 // Method embedded field layout (after declared fields):
57 // [EMBEDDED native_function (present only if native) ]
58 // [EMBEDDED signature_handler (present only if native) ]
59
60 class CheckedExceptionElement;
61 class LocalVariableTableElement;
62 class AdapterHandlerEntry;
63 class MethodData;
64 class MethodCounters;
65 class ConstMethod;
66 class InlineTableSizes;
67 class KlassSizeStats;
68 class CompiledMethod;
69 class InterpreterOopMap;
70
71 class Method : public Metadata {
72 friend class VMStructs;
73 friend class JVMCIVMStructs;
74 private:
75 // If you add a new field that points to any metaspace object, you
76 // must add this field to Method::metaspace_pointers_do().
77 ConstMethod* _constMethod; // Method read-only data.
78 MethodData* _method_data;
79 MethodCounters* _method_counters;
80 AccessFlags _access_flags; // Access flags
81 int _vtable_index; // vtable index of this method (see VtableIndexFlag)
82 // note: can have vtables with >2**16 elements (because of inheritance)
83 u2 _intrinsic_id; // vmSymbols::intrinsic_id (0 == _none)
84
85 // Flags
86 enum Flags {
87 _caller_sensitive = 1 << 0,
88 _force_inline = 1 << 1,
89 _dont_inline = 1 << 2,
90 _hidden = 1 << 3,
91 _has_injected_profile = 1 << 4,
92 _running_emcp = 1 << 5,
93 _intrinsic_candidate = 1 << 6,
94 _reserved_stack_access = 1 << 7,
95 _scalarized_args = 1 << 8,
96 _needs_stack_repair = 1 << 9
97 };
98 mutable u2 _flags;
99
100 JFR_ONLY(DEFINE_TRACE_FLAG;)
101
102 #ifndef PRODUCT
103 int _compiled_invocation_count; // Number of nmethod invocations so far (for perf. debugging)
104 #endif
105 // Entry point for calling both from and to the interpreter.
106 address _i2i_entry; // All-args-on-stack calling convention
107 // Entry point for calling from compiled code, to compiled code if it exists
108 // or else the interpreter.
109 volatile address _from_compiled_entry; // Cache of: _code ? _code->verified_entry_point() : _adapter->c2i_entry()
110 volatile address _from_compiled_value_ro_entry; // Cache of: _code ? _code->verified_value_ro_entry_point() : _adapter->c2i_value_ro_entry()
111 volatile address _from_compiled_value_entry; // Cache of: _code ? _code->verified_value_entry_point() : _adapter->c2i_value_entry()
112 // The entry point for calling both from and to compiled code is
113 // "_code->entry_point()". Because of tiered compilation and de-opt, this
114 // field can come and go. It can transition from NULL to not-null at any
115 // time (whenever a compile completes). It can transition from not-null to
116 // NULL only at safepoints (because of a de-opt).
117 CompiledMethod* volatile _code; // Points to the corresponding piece of native code
118 volatile address _from_interpreted_entry; // Cache of _code ? _adapter->i2c_entry() : _i2i_entry
119 int _max_vt_buffer; // max number of VT buffer chunk to use before recycling
120
121 #if INCLUDE_AOT && defined(TIERED)
122 CompiledMethod* _aot_code;
123 #endif
124
125 // Constructor
126 Method(ConstMethod* xconst, AccessFlags access_flags);
127 public:
128
129 static Method* allocate(ClassLoaderData* loader_data,
130 int byte_code_size,
131 AccessFlags access_flags,
132 InlineTableSizes* sizes,
133 ConstMethod::MethodType method_type,
134 TRAPS);
135
136 // CDS and vtbl checking can create an empty Method to get vtbl pointer.
137 Method(){}
138
139 bool is_method() const volatile { return true; }
140
141 void restore_unshareable_info(TRAPS);
142
143 // accessors for instance variables
144
145 ConstMethod* constMethod() const { return _constMethod; }
146 void set_constMethod(ConstMethod* xconst) { _constMethod = xconst; }
147
148
149 static address make_adapters(const methodHandle& mh, TRAPS);
150 address from_compiled_entry() const;
151 address from_compiled_entry_no_trampoline() const;
152 address from_interpreted_entry() const;
153
154 // access flag
155 AccessFlags access_flags() const { return _access_flags; }
156 void set_access_flags(AccessFlags flags) { _access_flags = flags; }
157
158 // name
159 Symbol* name() const { return constants()->symbol_at(name_index()); }
160 int name_index() const { return constMethod()->name_index(); }
161 void set_name_index(int index) { constMethod()->set_name_index(index); }
162
163 // signature
164 Symbol* signature() const { return constants()->symbol_at(signature_index()); }
165 int signature_index() const { return constMethod()->signature_index(); }
166 void set_signature_index(int index) { constMethod()->set_signature_index(index); }
167
168 // generics support
169 Symbol* generic_signature() const { int idx = generic_signature_index(); return ((idx != 0) ? constants()->symbol_at(idx) : (Symbol*)NULL); }
170 int generic_signature_index() const { return constMethod()->generic_signature_index(); }
171 void set_generic_signature_index(int index) { constMethod()->set_generic_signature_index(index); }
172
173 // annotations support
174 AnnotationArray* annotations() const {
175 return constMethod()->method_annotations();
176 }
177 AnnotationArray* parameter_annotations() const {
178 return constMethod()->parameter_annotations();
179 }
180 AnnotationArray* annotation_default() const {
181 return constMethod()->default_annotations();
182 }
183 AnnotationArray* type_annotations() const {
184 return constMethod()->type_annotations();
185 }
186
187 // Helper routine: get klass name + "." + method name + signature as
188 // C string, for the purpose of providing more useful
189 // fatal error handling. The string is allocated in resource
190 // area if a buffer is not provided by the caller.
191 char* name_and_sig_as_C_string() const;
192 char* name_and_sig_as_C_string(char* buf, int size) const;
193
194 // Static routine in the situations we don't have a Method*
195 static char* name_and_sig_as_C_string(Klass* klass, Symbol* method_name, Symbol* signature);
196 static char* name_and_sig_as_C_string(Klass* klass, Symbol* method_name, Symbol* signature, char* buf, int size);
197
198 // Get return type + klass name + "." + method name + ( parameters types )
199 // as a C string or print it to an outputStream.
200 // This is to be used to assemble strings passed to Java, so that
201 // the text more resembles Java code. Used in exception messages.
202 // Memory is allocated in the resource area; the caller needs
203 // a ResourceMark.
204 const char* external_name() const;
205 void print_external_name(outputStream *os) const;
206
207 static const char* external_name( Klass* klass, Symbol* method_name, Symbol* signature);
208 static void print_external_name(outputStream *os, Klass* klass, Symbol* method_name, Symbol* signature);
209
210 Bytecodes::Code java_code_at(int bci) const {
211 return Bytecodes::java_code_at(this, bcp_from(bci));
212 }
213 Bytecodes::Code code_at(int bci) const {
214 return Bytecodes::code_at(this, bcp_from(bci));
215 }
216
217 // JVMTI breakpoints
218 #if !INCLUDE_JVMTI
219 Bytecodes::Code orig_bytecode_at(int bci) const {
220 ShouldNotReachHere();
221 return Bytecodes::_shouldnotreachhere;
222 }
223 void set_orig_bytecode_at(int bci, Bytecodes::Code code) {
224 ShouldNotReachHere();
225 };
226 u2 number_of_breakpoints() const {return 0;}
227 #else // !INCLUDE_JVMTI
228 Bytecodes::Code orig_bytecode_at(int bci) const;
229 void set_orig_bytecode_at(int bci, Bytecodes::Code code);
230 void set_breakpoint(int bci);
231 void clear_breakpoint(int bci);
232 void clear_all_breakpoints();
233 // Tracking number of breakpoints, for fullspeed debugging.
234 // Only mutated by VM thread.
235 u2 number_of_breakpoints() const {
236 MethodCounters* mcs = method_counters();
237 if (mcs == NULL) {
238 return 0;
239 } else {
240 return mcs->number_of_breakpoints();
241 }
242 }
243 void incr_number_of_breakpoints(TRAPS) {
244 MethodCounters* mcs = get_method_counters(CHECK);
245 if (mcs != NULL) {
246 mcs->incr_number_of_breakpoints();
247 }
248 }
249 void decr_number_of_breakpoints(TRAPS) {
250 MethodCounters* mcs = get_method_counters(CHECK);
251 if (mcs != NULL) {
252 mcs->decr_number_of_breakpoints();
253 }
254 }
255 // Initialization only
256 void clear_number_of_breakpoints() {
257 MethodCounters* mcs = method_counters();
258 if (mcs != NULL) {
259 mcs->clear_number_of_breakpoints();
260 }
261 }
262 #endif // !INCLUDE_JVMTI
263
264 // index into InstanceKlass methods() array
265 // note: also used by jfr
266 u2 method_idnum() const { return constMethod()->method_idnum(); }
267 void set_method_idnum(u2 idnum) { constMethod()->set_method_idnum(idnum); }
268
269 u2 orig_method_idnum() const { return constMethod()->orig_method_idnum(); }
270 void set_orig_method_idnum(u2 idnum) { constMethod()->set_orig_method_idnum(idnum); }
271
272 // code size
273 int code_size() const { return constMethod()->code_size(); }
274
275 // method size in words
276 int method_size() const { return sizeof(Method)/wordSize + ( is_native() ? 2 : 0 ); }
277
278 // constant pool for Klass* holding this method
279 ConstantPool* constants() const { return constMethod()->constants(); }
280 void set_constants(ConstantPool* c) { constMethod()->set_constants(c); }
281
282 // max stack
283 // return original max stack size for method verification
284 int verifier_max_stack() const { return constMethod()->max_stack(); }
285 int max_stack() const { return constMethod()->max_stack() + extra_stack_entries(); }
286 void set_max_stack(int size) { constMethod()->set_max_stack(size); }
287
288 // max locals
289 int max_locals() const { return constMethod()->max_locals(); }
290 void set_max_locals(int size) { constMethod()->set_max_locals(size); }
291
292 int highest_comp_level() const;
293 void set_highest_comp_level(int level);
294 int highest_osr_comp_level() const;
295 void set_highest_osr_comp_level(int level);
296
297 #if COMPILER2_OR_JVMCI
298 // Count of times method was exited via exception while interpreting
299 void interpreter_throwout_increment(TRAPS) {
300 MethodCounters* mcs = get_method_counters(CHECK);
301 if (mcs != NULL) {
302 mcs->interpreter_throwout_increment();
303 }
304 }
305 #endif
306
307 int interpreter_throwout_count() const {
308 MethodCounters* mcs = method_counters();
309 if (mcs == NULL) {
310 return 0;
311 } else {
312 return mcs->interpreter_throwout_count();
313 }
314 }
315
316 // size of parameters
317 int size_of_parameters() const { return constMethod()->size_of_parameters(); }
318 void set_size_of_parameters(int size) { constMethod()->set_size_of_parameters(size); }
319
320 bool has_stackmap_table() const {
321 return constMethod()->has_stackmap_table();
322 }
323
324 Array<u1>* stackmap_data() const {
325 return constMethod()->stackmap_data();
326 }
327
328 void set_stackmap_data(Array<u1>* sd) {
329 constMethod()->set_stackmap_data(sd);
330 }
331
332 // exception handler table
333 bool has_exception_handler() const
334 { return constMethod()->has_exception_handler(); }
335 int exception_table_length() const
336 { return constMethod()->exception_table_length(); }
337 ExceptionTableElement* exception_table_start() const
338 { return constMethod()->exception_table_start(); }
339
340 // Finds the first entry point bci of an exception handler for an
341 // exception of klass ex_klass thrown at throw_bci. A value of NULL
342 // for ex_klass indicates that the exception klass is not known; in
343 // this case it matches any constraint class. Returns -1 if the
344 // exception cannot be handled in this method. The handler
345 // constraint classes are loaded if necessary. Note that this may
346 // throw an exception if loading of the constraint classes causes
347 // an IllegalAccessError (bugid 4307310) or an OutOfMemoryError.
348 // If an exception is thrown, returns the bci of the
349 // exception handler which caused the exception to be thrown, which
350 // is needed for proper retries. See, for example,
351 // InterpreterRuntime::exception_handler_for_exception.
352 static int fast_exception_handler_bci_for(const methodHandle& mh, Klass* ex_klass, int throw_bci, TRAPS);
353
354 // method data access
355 MethodData* method_data() const {
356 return _method_data;
357 }
358
359 void set_method_data(MethodData* data);
360
361 MethodCounters* method_counters() const {
362 return _method_counters;
363 }
364
365 void clear_method_counters() {
366 _method_counters = NULL;
367 }
368
369 bool init_method_counters(MethodCounters* counters);
370
371 #ifdef TIERED
372 // We are reusing interpreter_invocation_count as a holder for the previous event count!
373 // We can do that since interpreter_invocation_count is not used in tiered.
374 int prev_event_count() const {
375 if (method_counters() == NULL) {
376 return 0;
377 } else {
378 return method_counters()->interpreter_invocation_count();
379 }
380 }
381 void set_prev_event_count(int count) {
382 MethodCounters* mcs = method_counters();
383 if (mcs != NULL) {
384 mcs->set_interpreter_invocation_count(count);
385 }
386 }
387 jlong prev_time() const {
388 MethodCounters* mcs = method_counters();
389 return mcs == NULL ? 0 : mcs->prev_time();
390 }
391 void set_prev_time(jlong time) {
392 MethodCounters* mcs = method_counters();
393 if (mcs != NULL) {
394 mcs->set_prev_time(time);
395 }
396 }
397 float rate() const {
398 MethodCounters* mcs = method_counters();
399 return mcs == NULL ? 0 : mcs->rate();
400 }
401 void set_rate(float rate) {
402 MethodCounters* mcs = method_counters();
403 if (mcs != NULL) {
404 mcs->set_rate(rate);
405 }
406 }
407
408 #if INCLUDE_AOT
409 void set_aot_code(CompiledMethod* aot_code) {
410 _aot_code = aot_code;
411 }
412
413 CompiledMethod* aot_code() const {
414 return _aot_code;
415 }
416 #else
417 CompiledMethod* aot_code() const { return NULL; }
418 #endif // INCLUDE_AOT
419 #endif // TIERED
420
421 int nmethod_age() const {
422 if (method_counters() == NULL) {
423 return INT_MAX;
424 } else {
425 return method_counters()->nmethod_age();
426 }
427 }
428
429 int invocation_count();
430 int backedge_count();
431
432 bool was_executed_more_than(int n);
433 bool was_never_executed() { return !was_executed_more_than(0); }
434
435 static void build_interpreter_method_data(const methodHandle& method, TRAPS);
436
437 static MethodCounters* build_method_counters(Method* m, TRAPS);
438
439 int interpreter_invocation_count() {
440 if (TieredCompilation) {
441 return invocation_count();
442 } else {
443 MethodCounters* mcs = method_counters();
444 return (mcs == NULL) ? 0 : mcs->interpreter_invocation_count();
445 }
446 }
447 #if COMPILER2_OR_JVMCI
448 int increment_interpreter_invocation_count(TRAPS) {
449 if (TieredCompilation) ShouldNotReachHere();
450 MethodCounters* mcs = get_method_counters(CHECK_0);
451 return (mcs == NULL) ? 0 : mcs->increment_interpreter_invocation_count();
452 }
453 #endif
454
455 #ifndef PRODUCT
456 int compiled_invocation_count() const { return _compiled_invocation_count; }
457 void set_compiled_invocation_count(int count) { _compiled_invocation_count = count; }
458 #else
459 // for PrintMethodData in a product build
460 int compiled_invocation_count() const { return 0; }
461 #endif // not PRODUCT
462
463 // Clear (non-shared space) pointers which could not be relevant
464 // if this (shared) method were mapped into another JVM.
465 void remove_unshareable_info();
466
467 // nmethod/verified compiler entry
468 address verified_code_entry();
469 address verified_value_code_entry();
470 address verified_value_ro_code_entry();
471 bool check_code() const; // Not inline to avoid circular ref
472 CompiledMethod* volatile code() const;
473 void clear_code(bool acquire_lock = true); // Clear out any compiled code
474 static void set_code(const methodHandle& mh, CompiledMethod* code);
475 void set_adapter_entry(AdapterHandlerEntry* adapter) {
476 constMethod()->set_adapter_entry(adapter);
477 }
478 void update_adapter_trampoline(AdapterHandlerEntry* adapter) {
479 constMethod()->update_adapter_trampoline(adapter);
480 }
481
482 address get_i2c_entry();
483 address get_c2i_entry();
484 address get_c2i_value_entry();
485 address get_c2i_unverified_entry();
486 AdapterHandlerEntry* adapter() const {
487 return constMethod()->adapter();
488 }
489 // setup entry points
490 void link_method(const methodHandle& method, TRAPS);
491 // clear entry points. Used by sharing code during dump time
492 void unlink_method() NOT_CDS_RETURN;
493
494 virtual void metaspace_pointers_do(MetaspaceClosure* iter);
495 virtual MetaspaceObj::Type type() const { return MethodType; }
496
497 // vtable index
498 enum VtableIndexFlag {
499 // Valid vtable indexes are non-negative (>= 0).
500 // These few negative values are used as sentinels.
501 itable_index_max = -10, // first itable index, growing downward
502 pending_itable_index = -9, // itable index will be assigned
503 invalid_vtable_index = -4, // distinct from any valid vtable index
504 garbage_vtable_index = -3, // not yet linked; no vtable layout yet
505 nonvirtual_vtable_index = -2 // there is no need for vtable dispatch
506 // 6330203 Note: Do not use -1, which was overloaded with many meanings.
507 };
508 DEBUG_ONLY(bool valid_vtable_index() const { return _vtable_index >= nonvirtual_vtable_index; })
509 bool has_vtable_index() const { return _vtable_index >= 0; }
510 int vtable_index() const { return _vtable_index; }
511 void set_vtable_index(int index);
512 DEBUG_ONLY(bool valid_itable_index() const { return _vtable_index <= pending_itable_index; })
513 bool has_itable_index() const { return _vtable_index <= itable_index_max; }
514 int itable_index() const { assert(valid_itable_index(), "");
515 return itable_index_max - _vtable_index; }
516 void set_itable_index(int index);
517
518 // interpreter entry
519 address interpreter_entry() const { return _i2i_entry; }
520 // Only used when first initialize so we can set _i2i_entry and _from_interpreted_entry
521 void set_interpreter_entry(address entry) {
522 assert(!is_shared(), "shared method's interpreter entry should not be changed at run time");
523 if (_i2i_entry != entry) {
524 _i2i_entry = entry;
525 }
526 if (_from_interpreted_entry != entry) {
527 _from_interpreted_entry = entry;
528 }
529 }
530
531 // native function (used for native methods only)
532 enum {
533 native_bind_event_is_interesting = true
534 };
535 address native_function() const { return *(native_function_addr()); }
536 address critical_native_function();
537
538 // Must specify a real function (not NULL).
539 // Use clear_native_function() to unregister.
540 void set_native_function(address function, bool post_event_flag);
541 bool has_native_function() const;
542 void clear_native_function();
543
544 // signature handler (used for native methods only)
545 address signature_handler() const { return *(signature_handler_addr()); }
546 void set_signature_handler(address handler);
547
548 // Interpreter oopmap support
549 void mask_for(int bci, InterpreterOopMap* mask);
550
551 // operations on invocation counter
552 void print_invocation_count();
553
554 // byte codes
555 void set_code(address code) { return constMethod()->set_code(code); }
556 address code_base() const { return constMethod()->code_base(); }
557 bool contains(address bcp) const { return constMethod()->contains(bcp); }
558
559 // prints byte codes
560 void print_codes() const { print_codes_on(tty); }
561 void print_codes_on(outputStream* st) const;
562 void print_codes_on(int from, int to, outputStream* st) const;
563
564 // method parameters
565 bool has_method_parameters() const
566 { return constMethod()->has_method_parameters(); }
567 int method_parameters_length() const
568 { return constMethod()->method_parameters_length(); }
569 MethodParametersElement* method_parameters_start() const
570 { return constMethod()->method_parameters_start(); }
571
572 // checked exceptions
573 int checked_exceptions_length() const
574 { return constMethod()->checked_exceptions_length(); }
575 CheckedExceptionElement* checked_exceptions_start() const
576 { return constMethod()->checked_exceptions_start(); }
577
578 // localvariable table
579 bool has_localvariable_table() const
580 { return constMethod()->has_localvariable_table(); }
581 int localvariable_table_length() const
582 { return constMethod()->localvariable_table_length(); }
583 LocalVariableTableElement* localvariable_table_start() const
584 { return constMethod()->localvariable_table_start(); }
585
586 bool has_linenumber_table() const
587 { return constMethod()->has_linenumber_table(); }
588 u_char* compressed_linenumber_table() const
589 { return constMethod()->compressed_linenumber_table(); }
590
591 // method holder (the Klass* holding this method)
592 InstanceKlass* method_holder() const { return constants()->pool_holder(); }
593
594 void compute_size_of_parameters(Thread *thread); // word size of parameters (receiver if any + arguments)
595 Symbol* klass_name() const; // returns the name of the method holder
596 BasicType result_type() const; // type of the method result
597 bool may_return_oop() const { BasicType r = result_type(); return (r == T_OBJECT || r == T_ARRAY || r == T_VALUETYPE); }
598 #ifdef ASSERT
599 ValueKlass* returned_value_type(Thread* thread) const;
600 #endif
601
602 // Checked exceptions thrown by this method (resolved to mirrors)
603 objArrayHandle resolved_checked_exceptions(TRAPS) { return resolved_checked_exceptions_impl(this, THREAD); }
604
605 // Access flags
606 bool is_public() const { return access_flags().is_public(); }
607 bool is_private() const { return access_flags().is_private(); }
608 bool is_protected() const { return access_flags().is_protected(); }
609 bool is_package_private() const { return !is_public() && !is_private() && !is_protected(); }
610 bool is_static() const { return access_flags().is_static(); }
611 bool is_final() const { return access_flags().is_final(); }
612 bool is_synchronized() const { return access_flags().is_synchronized();}
613 bool is_native() const { return access_flags().is_native(); }
614 bool is_abstract() const { return access_flags().is_abstract(); }
615 bool is_strict() const { return access_flags().is_strict(); }
616 bool is_synthetic() const { return access_flags().is_synthetic(); }
617
618 // returns true if contains only return operation
619 bool is_empty_method() const;
620
621 // returns true if this is a vanilla constructor
622 bool is_vanilla_constructor() const;
623
624 // checks method and its method holder
625 bool is_final_method() const;
626 bool is_final_method(AccessFlags class_access_flags) const;
627 // interface method declared with 'default' - excludes private interface methods
628 bool is_default_method() const;
629
630 // true if method needs no dynamic dispatch (final and/or no vtable entry)
631 bool can_be_statically_bound() const;
632 bool can_be_statically_bound(AccessFlags class_access_flags) const;
633
634 // returns true if the method has any backward branches.
635 bool has_loops() {
636 return access_flags().loops_flag_init() ? access_flags().has_loops() : compute_has_loops_flag();
637 };
638
639 bool compute_has_loops_flag();
640
641 bool has_jsrs() {
642 return access_flags().has_jsrs();
643 };
644 void set_has_jsrs() {
645 _access_flags.set_has_jsrs();
646 }
647
648 // returns true if the method has any monitors.
649 bool has_monitors() const { return is_synchronized() || access_flags().has_monitor_bytecodes(); }
650 bool has_monitor_bytecodes() const { return access_flags().has_monitor_bytecodes(); }
651
652 void set_has_monitor_bytecodes() { _access_flags.set_has_monitor_bytecodes(); }
653
654 // monitor matching. This returns a conservative estimate of whether the monitorenter/monitorexit bytecodes
655 // propererly nest in the method. It might return false, even though they actually nest properly, since the info.
656 // has not been computed yet.
657 bool guaranteed_monitor_matching() const { return access_flags().is_monitor_matching(); }
658 void set_guaranteed_monitor_matching() { _access_flags.set_monitor_matching(); }
659
660 // returns true if the method is an accessor function (setter/getter).
661 bool is_accessor() const;
662
663 // returns true if the method is a getter
664 bool is_getter() const;
665
666 // returns true if the method is a setter
667 bool is_setter() const;
668
669 // returns true if the method does nothing but return a constant of primitive type
670 bool is_constant_getter() const;
671
672 // returns true if the method name is <clinit> and the method has
673 // valid static initializer flags.
674 bool is_class_initializer() const;
675
676 // returns true if the method name is <init> and the method is not a static factory
677 bool is_object_constructor() const;
678
679 // returns true if the method is an object constructor or class initializer
680 // (non-static <init> or <clinit>), but false for factories (static <init>).
681 bool is_object_constructor_or_class_initializer() const;
682
683 // returns true if the method name is <init> and the method is static
684 bool is_static_init_factory() const;
685
686 // compiled code support
687 // NOTE: code() is inherently racy as deopt can be clearing code
688 // simultaneously. Use with caution.
689 bool has_compiled_code() const;
690
691 #ifdef TIERED
692 bool has_aot_code() const { return aot_code() != NULL; }
693 #endif
694
695 // sizing
696 static int header_size() {
697 return align_up((int)sizeof(Method), wordSize) / wordSize;
698 }
699 static int size(bool is_native);
700 int size() const { return method_size(); }
701 #if INCLUDE_SERVICES
702 void collect_statistics(KlassSizeStats *sz) const;
703 #endif
704 void log_touched(TRAPS);
705 static void print_touched_methods(outputStream* out);
706
707 // interpreter support
708 static ByteSize const_offset() { return byte_offset_of(Method, _constMethod ); }
709 static ByteSize access_flags_offset() { return byte_offset_of(Method, _access_flags ); }
710 static ByteSize from_compiled_offset() { return byte_offset_of(Method, _from_compiled_entry); }
711 static ByteSize from_compiled_value_offset() { return byte_offset_of(Method, _from_compiled_value_entry); }
712 static ByteSize from_compiled_value_ro_offset(){ return byte_offset_of(Method, _from_compiled_value_ro_entry); }
713 static ByteSize code_offset() { return byte_offset_of(Method, _code); }
714 static ByteSize flags_offset() { return byte_offset_of(Method, _flags); }
715 static ByteSize method_data_offset() {
716 return byte_offset_of(Method, _method_data);
717 }
718 static ByteSize method_counters_offset() {
719 return byte_offset_of(Method, _method_counters);
720 }
721 #ifndef PRODUCT
722 static ByteSize compiled_invocation_counter_offset() { return byte_offset_of(Method, _compiled_invocation_count); }
723 #endif // not PRODUCT
724 static ByteSize native_function_offset() { return in_ByteSize(sizeof(Method)); }
725 static ByteSize from_interpreted_offset() { return byte_offset_of(Method, _from_interpreted_entry ); }
726 static ByteSize interpreter_entry_offset() { return byte_offset_of(Method, _i2i_entry ); }
727 static ByteSize signature_handler_offset() { return in_ByteSize(sizeof(Method) + wordSize); }
728 static ByteSize itable_index_offset() { return byte_offset_of(Method, _vtable_index ); }
729
730 // for code generation
731 static int method_data_offset_in_bytes() { return offset_of(Method, _method_data); }
732 static int intrinsic_id_offset_in_bytes() { return offset_of(Method, _intrinsic_id); }
733 static int intrinsic_id_size_in_bytes() { return sizeof(u2); }
734
735 static ByteSize max_vt_buffer_offset() { return byte_offset_of(Method, _max_vt_buffer); }
736
737 // Static methods that are used to implement member methods where an exposed this pointer
738 // is needed due to possible GCs
739 static objArrayHandle resolved_checked_exceptions_impl(Method* method, TRAPS);
740
741 // Returns the byte code index from the byte code pointer
742 int bci_from(address bcp) const;
743 address bcp_from(int bci) const;
744 address bcp_from(address bcp) const;
745 int validate_bci_from_bcp(address bcp) const;
746 int validate_bci(int bci) const;
747
748 // Returns the line number for a bci if debugging information for the method is prowided,
749 // -1 is returned otherwise.
750 int line_number_from_bci(int bci) const;
751
752 // Reflection support
753 bool is_overridden_in(Klass* k) const;
754
755 // Stack walking support
756 bool is_ignored_by_security_stack_walk() const;
757
758 // JSR 292 support
759 bool is_method_handle_intrinsic() const; // MethodHandles::is_signature_polymorphic_intrinsic(intrinsic_id)
760 bool is_compiled_lambda_form() const; // intrinsic_id() == vmIntrinsics::_compiledLambdaForm
761 bool has_member_arg() const; // intrinsic_id() == vmIntrinsics::_linkToSpecial, etc.
762 static methodHandle make_method_handle_intrinsic(vmIntrinsics::ID iid, // _invokeBasic, _linkToVirtual
763 Symbol* signature, //anything at all
764 TRAPS);
765 static Klass* check_non_bcp_klass(Klass* klass);
766
767 enum {
768 // How many extra stack entries for invokedynamic
769 extra_stack_entries_for_jsr292 = 1
770 };
771
772 // this operates only on invoke methods:
773 // presize interpreter frames for extra interpreter stack entries, if needed
774 // Account for the extra appendix argument for invokehandle/invokedynamic
775 static int extra_stack_entries() { return extra_stack_entries_for_jsr292; }
776 static int extra_stack_words(); // = extra_stack_entries() * Interpreter::stackElementSize
777
778 // RedefineClasses() support:
779 bool is_old() const { return access_flags().is_old(); }
780 void set_is_old() { _access_flags.set_is_old(); }
781 bool is_obsolete() const { return access_flags().is_obsolete(); }
782 void set_is_obsolete() { _access_flags.set_is_obsolete(); }
783 bool is_deleted() const { return access_flags().is_deleted(); }
784 void set_is_deleted() { _access_flags.set_is_deleted(); }
785
786 bool is_running_emcp() const {
787 // EMCP methods are old but not obsolete or deleted. Equivalent
788 // Modulo Constant Pool means the method is equivalent except
789 // the constant pool and instructions that access the constant
790 // pool might be different.
791 // If a breakpoint is set in a redefined method, its EMCP methods that are
792 // still running must have a breakpoint also.
793 return (_flags & _running_emcp) != 0;
794 }
795
796 void set_running_emcp(bool x) {
797 _flags = x ? (_flags | _running_emcp) : (_flags & ~_running_emcp);
798 }
799
800 bool on_stack() const { return access_flags().on_stack(); }
801 void set_on_stack(const bool value);
802
803 // see the definition in Method*.cpp for the gory details
804 bool should_not_be_cached() const;
805
806 // JVMTI Native method prefixing support:
807 bool is_prefixed_native() const { return access_flags().is_prefixed_native(); }
808 void set_is_prefixed_native() { _access_flags.set_is_prefixed_native(); }
809
810 // Rewriting support
811 static methodHandle clone_with_new_data(const methodHandle& m, u_char* new_code, int new_code_length,
812 u_char* new_compressed_linenumber_table, int new_compressed_linenumber_size, TRAPS);
813
814 // jmethodID handling
815 // Because the useful life-span of a jmethodID cannot be determined,
816 // once created they are never reclaimed. The methods to which they refer,
817 // however, can be GC'ed away if the class is unloaded or if the method is
818 // made obsolete or deleted -- in these cases, the jmethodID
819 // refers to NULL (as is the case for any weak reference).
820 static jmethodID make_jmethod_id(ClassLoaderData* loader_data, Method* mh);
821 static void destroy_jmethod_id(ClassLoaderData* loader_data, jmethodID mid);
822
823 // Ensure there is enough capacity in the internal tracking data
824 // structures to hold the number of jmethodIDs you plan to generate.
825 // This saves substantial time doing allocations.
826 static void ensure_jmethod_ids(ClassLoaderData* loader_data, int capacity);
827
828 // Use resolve_jmethod_id() in situations where the caller is expected
829 // to provide a valid jmethodID; the only sanity checks are in asserts;
830 // result guaranteed not to be NULL.
831 inline static Method* resolve_jmethod_id(jmethodID mid) {
832 assert(mid != NULL, "JNI method id should not be null");
833 return *((Method**)mid);
834 }
835
836 // Use checked_resolve_jmethod_id() in situations where the caller
837 // should provide a valid jmethodID, but might not. NULL is returned
838 // when the jmethodID does not refer to a valid method.
839 static Method* checked_resolve_jmethod_id(jmethodID mid);
840
841 static void change_method_associated_with_jmethod_id(jmethodID old_jmid_ptr, Method* new_method);
842 static bool is_method_id(jmethodID mid);
843
844 // Clear methods
845 static void clear_jmethod_ids(ClassLoaderData* loader_data);
846 static void print_jmethod_ids(const ClassLoaderData* loader_data, outputStream* out) PRODUCT_RETURN;
847
848 // Get this method's jmethodID -- allocate if it doesn't exist
849 jmethodID jmethod_id() { return method_holder()->get_jmethod_id(this); }
850
851 // Lookup the jmethodID for this method. Return NULL if not found.
852 // NOTE that this function can be called from a signal handler
853 // (see AsyncGetCallTrace support for Forte Analyzer) and this
854 // needs to be async-safe. No allocation should be done and
855 // so handles are not used to avoid deadlock.
856 jmethodID find_jmethod_id_or_null() { return method_holder()->jmethod_id_or_null(this); }
857
858 // Support for inlining of intrinsic methods
859 vmIntrinsics::ID intrinsic_id() const { return (vmIntrinsics::ID) _intrinsic_id; }
860 void set_intrinsic_id(vmIntrinsics::ID id) { _intrinsic_id = (u2) id; }
861
862 // Helper routines for intrinsic_id() and vmIntrinsics::method().
863 void init_intrinsic_id(); // updates from _none if a match
864 static vmSymbols::SID klass_id_for_intrinsics(const Klass* holder);
865
866 bool caller_sensitive() {
867 return (_flags & _caller_sensitive) != 0;
868 }
869 void set_caller_sensitive(bool x) {
870 _flags = x ? (_flags | _caller_sensitive) : (_flags & ~_caller_sensitive);
871 }
872
873 bool force_inline() {
874 return (_flags & _force_inline) != 0;
875 }
876 void set_force_inline(bool x) {
877 _flags = x ? (_flags | _force_inline) : (_flags & ~_force_inline);
878 }
879
880 bool dont_inline() {
881 return (_flags & _dont_inline) != 0;
882 }
883 void set_dont_inline(bool x) {
884 _flags = x ? (_flags | _dont_inline) : (_flags & ~_dont_inline);
885 }
886
887 bool is_hidden() {
888 return (_flags & _hidden) != 0;
889 }
890 void set_hidden(bool x) {
891 _flags = x ? (_flags | _hidden) : (_flags & ~_hidden);
892 }
893
894 bool intrinsic_candidate() {
895 return (_flags & _intrinsic_candidate) != 0;
896 }
897 void set_intrinsic_candidate(bool x) {
898 _flags = x ? (_flags | _intrinsic_candidate) : (_flags & ~_intrinsic_candidate);
899 }
900
901 bool has_injected_profile() {
902 return (_flags & _has_injected_profile) != 0;
903 }
904 void set_has_injected_profile(bool x) {
905 _flags = x ? (_flags | _has_injected_profile) : (_flags & ~_has_injected_profile);
906 }
907
908 bool has_reserved_stack_access() {
909 return (_flags & _reserved_stack_access) != 0;
910 }
911
912 void set_has_reserved_stack_access(bool x) {
913 _flags = x ? (_flags | _reserved_stack_access) : (_flags & ~_reserved_stack_access);
914 }
915
916 bool has_scalarized_args() {
917 return (_flags & _scalarized_args) != 0;
918 }
919
920 void set_has_scalarized_args(bool x) {
921 _flags = x ? (_flags | _scalarized_args) : (_flags & ~_scalarized_args);
922 }
923
924 bool needs_stack_repair() {
925 return (_flags & _needs_stack_repair) != 0;
926 }
927
928 void set_needs_stack_repair(bool x) {
929 _flags = x ? (_flags | _needs_stack_repair) : (_flags & ~_needs_stack_repair);
930 }
931
932 JFR_ONLY(DEFINE_TRACE_FLAG_ACCESSOR;)
933
934 ConstMethod::MethodType method_type() const {
935 return _constMethod->method_type();
936 }
937 bool is_overpass() const { return method_type() == ConstMethod::OVERPASS; }
938
939 // On-stack replacement support
940 bool has_osr_nmethod(int level, bool match_level) {
941 return method_holder()->lookup_osr_nmethod(this, InvocationEntryBci, level, match_level) != NULL;
942 }
943
944 int mark_osr_nmethods() {
945 return method_holder()->mark_osr_nmethods(this);
946 }
947
948 nmethod* lookup_osr_nmethod_for(int bci, int level, bool match_level) {
949 return method_holder()->lookup_osr_nmethod(this, bci, level, match_level);
950 }
951
952 // Find if klass for method is loaded
953 bool is_klass_loaded_by_klass_index(int klass_index) const;
954 bool is_klass_loaded(int refinfo_index, bool must_be_resolved = false) const;
955
956 // Indicates whether compilation failed earlier for this method, or
957 // whether it is not compilable for another reason like having a
958 // breakpoint set in it.
959 bool is_not_compilable(int comp_level = CompLevel_any) const;
960 void set_not_compilable(int comp_level = CompLevel_all, bool report = true, const char* reason = NULL);
961 void set_not_compilable_quietly(int comp_level = CompLevel_all) {
962 set_not_compilable(comp_level, false);
963 }
964 bool is_not_osr_compilable(int comp_level = CompLevel_any) const;
965 void set_not_osr_compilable(int comp_level = CompLevel_all, bool report = true, const char* reason = NULL);
966 void set_not_osr_compilable_quietly(int comp_level = CompLevel_all) {
967 set_not_osr_compilable(comp_level, false);
968 }
969 bool is_always_compilable() const;
970
971 private:
972 void print_made_not_compilable(int comp_level, bool is_osr, bool report, const char* reason);
973
974 public:
975 MethodCounters* get_method_counters(TRAPS) {
976 if (_method_counters == NULL) {
977 build_method_counters(this, CHECK_AND_CLEAR_NULL);
978 }
979 return _method_counters;
980 }
981
982 bool is_not_c1_compilable() const { return access_flags().is_not_c1_compilable(); }
983 void set_not_c1_compilable() { _access_flags.set_not_c1_compilable(); }
984 void clear_not_c1_compilable() { _access_flags.clear_not_c1_compilable(); }
985 bool is_not_c2_compilable() const { return access_flags().is_not_c2_compilable(); }
986 void set_not_c2_compilable() { _access_flags.set_not_c2_compilable(); }
987 void clear_not_c2_compilable() { _access_flags.clear_not_c2_compilable(); }
988
989 bool is_not_c1_osr_compilable() const { return is_not_c1_compilable(); } // don't waste an accessFlags bit
990 void set_not_c1_osr_compilable() { set_not_c1_compilable(); } // don't waste an accessFlags bit
991 void clear_not_c1_osr_compilable() { clear_not_c1_compilable(); } // don't waste an accessFlags bit
992 bool is_not_c2_osr_compilable() const { return access_flags().is_not_c2_osr_compilable(); }
993 void set_not_c2_osr_compilable() { _access_flags.set_not_c2_osr_compilable(); }
994 void clear_not_c2_osr_compilable() { _access_flags.clear_not_c2_osr_compilable(); }
995
996 // Background compilation support
997 bool queued_for_compilation() const { return access_flags().queued_for_compilation(); }
998 void set_queued_for_compilation() { _access_flags.set_queued_for_compilation(); }
999 void clear_queued_for_compilation() { _access_flags.clear_queued_for_compilation(); }
1000
1001 // Resolve all classes in signature, return 'true' if successful
1002 static bool load_signature_classes(const methodHandle& m, TRAPS);
1003
1004 // Return if true if not all classes references in signature, including return type, has been loaded
1005 static bool has_unloaded_classes_in_signature(const methodHandle& m, TRAPS);
1006
1007 // Printing
1008 void print_short_name(outputStream* st = tty); // prints as klassname::methodname; Exposed so field engineers can debug VM
1009 #if INCLUDE_JVMTI
1010 void print_name(outputStream* st = tty); // prints as "virtual void foo(int)"; exposed for TraceRedefineClasses
1011 #else
1012 void print_name(outputStream* st = tty) PRODUCT_RETURN; // prints as "virtual void foo(int)"
1013 #endif
1014
1015 // Helper routine used for method sorting
1016 static void sort_methods(Array<Method*>* methods, bool set_idnums = true);
1017
1018 // Deallocation function for redefine classes or if an error occurs
1019 void deallocate_contents(ClassLoaderData* loader_data);
1020
1021 Method* get_new_method() const {
1022 InstanceKlass* holder = method_holder();
1023 Method* new_method = holder->method_with_idnum(orig_method_idnum());
1024
1025 assert(new_method != NULL, "method_with_idnum() should not be NULL");
1026 assert(this != new_method, "sanity check");
1027 return new_method;
1028 }
1029
1030 // Printing
1031 #ifndef PRODUCT
1032 void print_on(outputStream* st) const;
1033 #endif
1034 void print_value_on(outputStream* st) const;
1035 void print_linkage_flags(outputStream* st) PRODUCT_RETURN;
1036
1037 const char* internal_name() const { return "{method}"; }
1038
1039 // Check for valid method pointer
1040 static bool has_method_vptr(const void* ptr);
1041 static bool is_valid_method(const Method* m);
1042
1043 // Verify
1044 void verify() { verify_on(tty); }
1045 void verify_on(outputStream* st);
1046
1047 private:
1048
1049 // Inlined elements
1050 address* native_function_addr() const { assert(is_native(), "must be native"); return (address*) (this+1); }
1051 address* signature_handler_addr() const { return native_function_addr() + 1; }
1052 };
1053
1054
1055 // Utility class for compressing line number tables
1056
1057 class CompressedLineNumberWriteStream: public CompressedWriteStream {
1058 private:
1059 int _bci;
1060 int _line;
1061 public:
1062 // Constructor
1063 CompressedLineNumberWriteStream(int initial_size) : CompressedWriteStream(initial_size), _bci(0), _line(0) {}
1064 CompressedLineNumberWriteStream(u_char* buffer, int initial_size) : CompressedWriteStream(buffer, initial_size), _bci(0), _line(0) {}
1065
1066 // Write (bci, line number) pair to stream
1067 void write_pair_regular(int bci_delta, int line_delta);
1068
1069 // If (bci delta, line delta) fits in (5-bit unsigned, 3-bit unsigned)
1070 // we save it as one byte, otherwise we write a 0xFF escape character
1071 // and use regular compression. 0x0 is used as end-of-stream terminator.
1072 void write_pair_inline(int bci, int line);
1073
1074 void write_pair(int bci, int line);
1075
1076 // Write end-of-stream marker
1077 void write_terminator() { write_byte(0); }
1078 };
1079
1080
1081 // Utility class for decompressing line number tables
1082
1083 class CompressedLineNumberReadStream: public CompressedReadStream {
1084 private:
1085 int _bci;
1086 int _line;
1087 public:
1088 // Constructor
1089 CompressedLineNumberReadStream(u_char* buffer);
1090 // Read (bci, line number) pair from stream. Returns false at end-of-stream.
1091 bool read_pair();
1092 // Accessing bci and line number (after calling read_pair)
1093 int bci() const { return _bci; }
1094 int line() const { return _line; }
1095 };
1096
1097
1098 #if INCLUDE_JVMTI
1099
1100 /// Fast Breakpoints.
1101
1102 // If this structure gets more complicated (because bpts get numerous),
1103 // move it into its own header.
1104
1105 // There is presently no provision for concurrent access
1106 // to breakpoint lists, which is only OK for JVMTI because
1107 // breakpoints are written only at safepoints, and are read
1108 // concurrently only outside of safepoints.
1109
1110 class BreakpointInfo : public CHeapObj<mtClass> {
1111 friend class VMStructs;
1112 private:
1113 Bytecodes::Code _orig_bytecode;
1114 int _bci;
1115 u2 _name_index; // of method
1116 u2 _signature_index; // of method
1117 BreakpointInfo* _next; // simple storage allocation
1118
1119 public:
1120 BreakpointInfo(Method* m, int bci);
1121
1122 // accessors
1123 Bytecodes::Code orig_bytecode() { return _orig_bytecode; }
1124 void set_orig_bytecode(Bytecodes::Code code) { _orig_bytecode = code; }
1125 int bci() { return _bci; }
1126
1127 BreakpointInfo* next() const { return _next; }
1128 void set_next(BreakpointInfo* n) { _next = n; }
1129
1130 // helps for searchers
1131 bool match(const Method* m, int bci) {
1132 return bci == _bci && match(m);
1133 }
1134
1135 bool match(const Method* m) {
1136 return _name_index == m->name_index() &&
1137 _signature_index == m->signature_index();
1138 }
1139
1140 void set(Method* method);
1141 void clear(Method* method);
1142 };
1143
1144 #endif // INCLUDE_JVMTI
1145
1146 // Utility class for access exception handlers
1147 class ExceptionTable : public StackObj {
1148 private:
1149 ExceptionTableElement* _table;
1150 u2 _length;
1151
1152 public:
1153 ExceptionTable(const Method* m) {
1154 if (m->has_exception_handler()) {
1155 _table = m->exception_table_start();
1156 _length = m->exception_table_length();
1157 } else {
1158 _table = NULL;
1159 _length = 0;
1160 }
1161 }
1162
1163 int length() const {
1164 return _length;
1165 }
1166
1167 u2 start_pc(int idx) const {
1168 assert(idx < _length, "out of bounds");
1169 return _table[idx].start_pc;
1170 }
1171
1172 void set_start_pc(int idx, u2 value) {
1173 assert(idx < _length, "out of bounds");
1174 _table[idx].start_pc = value;
1175 }
1176
1177 u2 end_pc(int idx) const {
1178 assert(idx < _length, "out of bounds");
1179 return _table[idx].end_pc;
1180 }
1181
1182 void set_end_pc(int idx, u2 value) {
1183 assert(idx < _length, "out of bounds");
1184 _table[idx].end_pc = value;
1185 }
1186
1187 u2 handler_pc(int idx) const {
1188 assert(idx < _length, "out of bounds");
1189 return _table[idx].handler_pc;
1190 }
1191
1192 void set_handler_pc(int idx, u2 value) {
1193 assert(idx < _length, "out of bounds");
1194 _table[idx].handler_pc = value;
1195 }
1196
1197 u2 catch_type_index(int idx) const {
1198 assert(idx < _length, "out of bounds");
1199 return _table[idx].catch_type_index;
1200 }
1201
1202 void set_catch_type_index(int idx, u2 value) {
1203 assert(idx < _length, "out of bounds");
1204 _table[idx].catch_type_index = value;
1205 }
1206 };
1207
1208 #endif // SHARE_OOPS_METHOD_HPP
--- EOF ---