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