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