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