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 MethodTrainingData; 64 class ConstMethod; 65 class InlineTableSizes; 66 class nmethod; 67 class InterpreterOopMap; 68 class SCCEntry; 69 70 class Method : public Metadata { 71 friend class VMStructs; 72 friend class JVMCIVMStructs; 73 friend class MethodTest; 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 AdapterHandlerEntry* _adapter; 81 AccessFlags _access_flags; // Access flags 82 int _vtable_index; // vtable index of this method (see VtableIndexFlag) 83 MethodFlags _flags; 84 85 u2 _intrinsic_id; // vmSymbols::intrinsic_id (0 == _none) 86 87 JFR_ONLY(DEFINE_TRACE_FLAG;) 88 89 #ifndef PRODUCT 90 int64_t _compiled_invocation_count; 91 92 Symbol* _name; 93 #endif 94 // Entry point for calling both from and to the interpreter. 95 address _i2i_entry; // All-args-on-stack calling convention 96 // Entry point for calling from compiled code, to compiled code if it exists 97 // or else the interpreter. 98 volatile address _from_compiled_entry; // Cache of: _code ? _code->entry_point() : _adapter->c2i_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 nmethod* _preload_code; // preloaded SCCache code 108 SCCEntry* _scc_entry; // SCCache entry for pre-loading code 109 110 // Constructor 111 Method(ConstMethod* xconst, AccessFlags access_flags, Symbol* name); 112 public: 113 114 static Method* allocate(ClassLoaderData* loader_data, 115 int byte_code_size, 116 AccessFlags access_flags, 117 InlineTableSizes* sizes, 118 ConstMethod::MethodType method_type, 119 Symbol* name, 120 TRAPS); 121 122 // CDS and vtbl checking can create an empty Method to get vtbl pointer. 123 Method(){} 124 125 virtual bool is_method() const { return true; } 126 127 #if INCLUDE_CDS 128 void remove_unshareable_info(); 129 void restore_unshareable_info(TRAPS); 130 static void restore_archived_method_handle_intrinsic(methodHandle m, TRAPS); 131 #endif 132 133 // accessors for instance variables 134 135 ConstMethod* constMethod() const { return _constMethod; } 136 void set_constMethod(ConstMethod* xconst) { _constMethod = xconst; } 137 138 139 static address make_adapters(const methodHandle& mh, TRAPS); 140 address from_compiled_entry() const; 141 address from_interpreted_entry() const; 142 143 // access flag 144 AccessFlags access_flags() const { return _access_flags; } 145 void set_access_flags(AccessFlags flags) { _access_flags = flags; } 146 147 // name 148 Symbol* name() const { return constants()->symbol_at(name_index()); } 149 u2 name_index() const { return constMethod()->name_index(); } 150 void set_name_index(int index) { constMethod()->set_name_index(index); } 151 152 // signature 153 Symbol* signature() const { return constants()->symbol_at(signature_index()); } 154 u2 signature_index() const { return constMethod()->signature_index(); } 155 void set_signature_index(int index) { constMethod()->set_signature_index(index); } 156 157 // generics support 158 Symbol* generic_signature() const { int idx = generic_signature_index(); return ((idx != 0) ? constants()->symbol_at(idx) : nullptr); } 159 u2 generic_signature_index() const { return constMethod()->generic_signature_index(); } 160 161 // annotations support 162 AnnotationArray* annotations() const { 163 return constMethod()->method_annotations(); 164 } 165 AnnotationArray* parameter_annotations() const { 166 return constMethod()->parameter_annotations(); 167 } 168 AnnotationArray* annotation_default() const { 169 return constMethod()->default_annotations(); 170 } 171 AnnotationArray* type_annotations() const { 172 return constMethod()->type_annotations(); 173 } 174 175 // Helper routine: get klass name + "." + method name + signature as 176 // C string, for the purpose of providing more useful 177 // fatal error handling. The string is allocated in resource 178 // area if a buffer is not provided by the caller. 179 char* name_and_sig_as_C_string() const; 180 char* name_and_sig_as_C_string(char* buf, int size) const; 181 182 // Static routine in the situations we don't have a Method* 183 static char* name_and_sig_as_C_string(Klass* klass, Symbol* method_name, Symbol* signature); 184 static char* name_and_sig_as_C_string(Klass* klass, Symbol* method_name, Symbol* signature, char* buf, int size); 185 186 // Get return type + klass name + "." + method name + ( parameters types ) 187 // as a C string or print it to an outputStream. 188 // This is to be used to assemble strings passed to Java, so that 189 // the text more resembles Java code. Used in exception messages. 190 // Memory is allocated in the resource area; the caller needs 191 // a ResourceMark. 192 const char* external_name() const; 193 void print_external_name(outputStream *os) const; 194 195 static const char* external_name( Klass* klass, Symbol* method_name, Symbol* signature); 196 static void print_external_name(outputStream *os, Klass* klass, Symbol* method_name, Symbol* signature); 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 inline u2 number_of_breakpoints() const; 224 inline void incr_number_of_breakpoints(Thread* current); 225 inline void decr_number_of_breakpoints(Thread* current); 226 // Initialization only 227 inline void clear_number_of_breakpoints(); 228 #endif // !INCLUDE_JVMTI 229 230 // index into InstanceKlass methods() array 231 // note: also used by jfr 232 u2 method_idnum() const { return constMethod()->method_idnum(); } 233 void set_method_idnum(u2 idnum) { constMethod()->set_method_idnum(idnum); } 234 235 u2 orig_method_idnum() const { return constMethod()->orig_method_idnum(); } 236 void set_orig_method_idnum(u2 idnum) { constMethod()->set_orig_method_idnum(idnum); } 237 238 // code size 239 u2 code_size() const { return constMethod()->code_size(); } 240 241 // method size in words 242 int method_size() const { return sizeof(Method)/wordSize + ( is_native() ? 2 : 0 ); } 243 244 // constant pool for Klass* holding this method 245 ConstantPool* constants() const { return constMethod()->constants(); } 246 void set_constants(ConstantPool* c) { constMethod()->set_constants(c); } 247 248 // max stack 249 // return original max stack size for method verification 250 u2 verifier_max_stack() const { return constMethod()->max_stack(); } 251 int max_stack() const { return constMethod()->max_stack() + extra_stack_entries(); } 252 void set_max_stack(int size) { constMethod()->set_max_stack(size); } 253 254 // max locals 255 u2 max_locals() const { return constMethod()->max_locals(); } 256 void set_max_locals(int size) { constMethod()->set_max_locals(size); } 257 258 void set_deprecated() { constMethod()->set_deprecated(); } 259 bool deprecated() const { return constMethod()->deprecated(); } 260 261 void set_deprecated_for_removal() { constMethod()->set_deprecated_for_removal(); } 262 bool deprecated_for_removal() const { return constMethod()->deprecated_for_removal(); } 263 264 int highest_comp_level() const; 265 void set_highest_comp_level(int level); 266 int highest_osr_comp_level() const; 267 void set_highest_osr_comp_level(int level); 268 269 #if COMPILER2_OR_JVMCI 270 // Count of times method was exited via exception while interpreting 271 inline void interpreter_throwout_increment(Thread* current); 272 #endif 273 274 inline int interpreter_throwout_count() const; 275 276 u2 size_of_parameters() const { return constMethod()->size_of_parameters(); } 277 278 bool has_stackmap_table() const { 279 return constMethod()->has_stackmap_table(); 280 } 281 282 Array<u1>* stackmap_data() const { 283 return constMethod()->stackmap_data(); 284 } 285 286 void set_stackmap_data(Array<u1>* sd) { 287 constMethod()->set_stackmap_data(sd); 288 } 289 290 // exception handler table 291 bool has_exception_handler() const 292 { return constMethod()->has_exception_table(); } 293 u2 exception_table_length() const 294 { return constMethod()->exception_table_length(); } 295 ExceptionTableElement* exception_table_start() const 296 { return constMethod()->exception_table_start(); } 297 298 // Finds the first entry point bci of an exception handler for an 299 // exception of klass ex_klass thrown at throw_bci. A value of null 300 // for ex_klass indicates that the exception klass is not known; in 301 // this case it matches any constraint class. Returns -1 if the 302 // exception cannot be handled in this method. The handler 303 // constraint classes are loaded if necessary. Note that this may 304 // throw an exception if loading of the constraint classes causes 305 // an IllegalAccessError (bugid 4307310) or an OutOfMemoryError. 306 // If an exception is thrown, returns the bci of the 307 // exception handler which caused the exception to be thrown, which 308 // is needed for proper retries. See, for example, 309 // InterpreterRuntime::exception_handler_for_exception. 310 static int fast_exception_handler_bci_for(const methodHandle& mh, Klass* ex_klass, int throw_bci, TRAPS); 311 312 static bool register_native(Klass* k, 313 Symbol* name, 314 Symbol* signature, 315 address entry, 316 TRAPS); 317 318 // method data access 319 MethodData* method_data() const { 320 return _method_data; 321 } 322 323 void set_method_data(MethodData* data); 324 325 MethodTrainingData* training_data_or_null() const; 326 bool init_training_data(MethodTrainingData* tdata); 327 328 // mark an exception handler as entered (used to prune dead catch blocks in C2) 329 void set_exception_handler_entered(int handler_bci); 330 331 MethodCounters* method_counters() const { 332 return _method_counters; 333 } 334 335 void clear_method_counters() { 336 _method_counters = nullptr; 337 } 338 339 bool init_method_counters(MethodCounters* counters); 340 341 inline int prev_event_count() const; 342 inline void set_prev_event_count(int count); 343 inline jlong prev_time() const; 344 inline void set_prev_time(jlong time); 345 inline float rate() const; 346 inline void set_rate(float rate); 347 348 int invocation_count() const; 349 int backedge_count() const; 350 351 bool was_executed_more_than(int n); 352 bool was_never_executed() { return !was_executed_more_than(0); } 353 354 static void build_profiling_method_data(const methodHandle& method, TRAPS); 355 static bool install_training_method_data(const methodHandle& method); 356 static MethodCounters* build_method_counters(Thread* current, Method* m); 357 358 int interpreter_invocation_count() { return invocation_count(); } 359 360 #ifndef PRODUCT 361 int64_t compiled_invocation_count() const { return _compiled_invocation_count;} 362 void set_compiled_invocation_count(int count) { _compiled_invocation_count = (int64_t)count; } 363 #else 364 // for PrintMethodData in a product build 365 int64_t compiled_invocation_count() const { return 0; } 366 #endif // not PRODUCT 367 368 // nmethod/verified compiler entry 369 address verified_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 395 void set_preload_code(nmethod* code) { 396 _preload_code = code; 397 } 398 void set_scc_entry(SCCEntry* entry) { 399 _scc_entry = entry; 400 } 401 SCCEntry* scc_entry() const { 402 return _scc_entry; 403 } 404 405 address get_i2c_entry(); 406 address get_c2i_entry(); 407 address get_c2i_unverified_entry(); 408 address get_c2i_no_clinit_check_entry(); 409 AdapterHandlerEntry* adapter() const { 410 return _adapter; 411 } 412 // setup entry points 413 void link_method(const methodHandle& method, TRAPS); 414 // clear entry points. Used by sharing code during dump time 415 void unlink_method() NOT_CDS_RETURN; 416 void remove_unshareable_flags() NOT_CDS_RETURN; 417 418 virtual void metaspace_pointers_do(MetaspaceClosure* iter); 419 virtual MetaspaceObj::Type type() const { return MethodType; } 420 421 // vtable index 422 enum VtableIndexFlag { 423 // Valid vtable indexes are non-negative (>= 0). 424 // These few negative values are used as sentinels. 425 itable_index_max = -10, // first itable index, growing downward 426 pending_itable_index = -9, // itable index will be assigned 427 invalid_vtable_index = -4, // distinct from any valid vtable index 428 garbage_vtable_index = -3, // not yet linked; no vtable layout yet 429 nonvirtual_vtable_index = -2 // there is no need for vtable dispatch 430 // 6330203 Note: Do not use -1, which was overloaded with many meanings. 431 }; 432 DEBUG_ONLY(bool valid_vtable_index() const { return _vtable_index >= nonvirtual_vtable_index; }) 433 bool has_vtable_index() const { return _vtable_index >= 0; } 434 int vtable_index() const { return _vtable_index; } 435 void set_vtable_index(int index); 436 DEBUG_ONLY(bool valid_itable_index() const { return _vtable_index <= pending_itable_index; }) 437 bool has_itable_index() const { return _vtable_index <= itable_index_max; } 438 int itable_index() const { assert(valid_itable_index(), ""); 439 return itable_index_max - _vtable_index; } 440 void set_itable_index(int index); 441 442 // interpreter entry 443 address interpreter_entry() const { return _i2i_entry; } 444 // Only used when first initialize so we can set _i2i_entry and _from_interpreted_entry 445 void set_interpreter_entry(address entry) { 446 if (_i2i_entry != entry) { 447 _i2i_entry = entry; 448 } 449 if (_from_interpreted_entry != entry) { 450 _from_interpreted_entry = entry; 451 } 452 } 453 454 // native function (used for native methods only) 455 enum { 456 native_bind_event_is_interesting = true 457 }; 458 address native_function() const { return *(native_function_addr()); } 459 460 // Must specify a real function (not null). 461 // Use clear_native_function() to unregister. 462 void set_native_function(address function, bool post_event_flag); 463 bool has_native_function() const; 464 void clear_native_function(); 465 466 // signature handler (used for native methods only) 467 address signature_handler() const { return *(signature_handler_addr()); } 468 void set_signature_handler(address handler); 469 470 // Interpreter oopmap support 471 void mask_for(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 bool is_returning_fp() const { BasicType r = result_type(); return (r == T_FLOAT || r == T_DOUBLE); } 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 is an initializer (<init> or <clinit>). 599 bool is_initializer() const; 600 601 // returns true if the method is static OR if the classfile version < 51 602 bool has_valid_initializer_flags() const; 603 604 // returns true if the method name is <clinit> and the method has 605 // valid static initializer flags. 606 bool is_static_initializer() const; 607 608 // returns true if the method name is <init> 609 bool is_object_initializer() const; 610 611 // compiled code support 612 // NOTE: code() is inherently racy as deopt can be clearing code 613 // simultaneously. Use with caution. 614 bool has_compiled_code() const; 615 616 bool needs_clinit_barrier() const; 617 bool code_has_clinit_barriers() const; 618 619 // sizing 620 static int header_size() { 621 return align_up((int)sizeof(Method), wordSize) / wordSize; 622 } 623 static int size(bool is_native); 624 int size() const { return method_size(); } 625 void log_touched(Thread* current); 626 static void print_touched_methods(outputStream* out); 627 628 // interpreter support 629 static ByteSize const_offset() { return byte_offset_of(Method, _constMethod ); } 630 static ByteSize access_flags_offset() { return byte_offset_of(Method, _access_flags ); } 631 static ByteSize from_compiled_offset() { return byte_offset_of(Method, _from_compiled_entry); } 632 static ByteSize code_offset() { return byte_offset_of(Method, _code); } 633 634 static ByteSize method_counters_offset() { 635 return byte_offset_of(Method, _method_counters); 636 } 637 #ifndef PRODUCT 638 static ByteSize compiled_invocation_counter_offset() { return byte_offset_of(Method, _compiled_invocation_count); } 639 #endif // not PRODUCT 640 static ByteSize native_function_offset() { return in_ByteSize(sizeof(Method)); } 641 static ByteSize from_interpreted_offset() { return byte_offset_of(Method, _from_interpreted_entry ); } 642 static ByteSize interpreter_entry_offset() { return byte_offset_of(Method, _i2i_entry ); } 643 static ByteSize signature_handler_offset() { return in_ByteSize(sizeof(Method) + wordSize); } 644 static ByteSize itable_index_offset() { return byte_offset_of(Method, _vtable_index ); } 645 646 // for code generation 647 static ByteSize method_data_offset() { return byte_offset_of(Method, _method_data); } 648 static ByteSize intrinsic_id_offset() { return byte_offset_of(Method, _intrinsic_id); } 649 static int intrinsic_id_size_in_bytes() { return sizeof(u2); } 650 651 // Static methods that are used to implement member methods where an exposed this pointer 652 // is needed due to possible GCs 653 static objArrayHandle resolved_checked_exceptions_impl(Method* method, TRAPS); 654 655 // Returns the byte code index from the byte code pointer 656 int bci_from(address bcp) const; 657 address bcp_from(int bci) const; 658 address bcp_from(address bcp) const; 659 int validate_bci_from_bcp(address bcp) const; 660 int validate_bci(int bci) const; 661 662 // Returns the line number for a bci if debugging information for the method is prowided, 663 // -1 is returned otherwise. 664 int line_number_from_bci(int bci) const; 665 666 // Reflection support 667 bool is_overridden_in(Klass* k) const; 668 669 // Stack walking support 670 bool is_ignored_by_security_stack_walk() const; 671 672 // JSR 292 support 673 bool is_method_handle_intrinsic() const; // MethodHandles::is_signature_polymorphic_intrinsic(intrinsic_id) 674 bool is_compiled_lambda_form() const; // intrinsic_id() == vmIntrinsics::_compiledLambdaForm 675 bool has_member_arg() const; // intrinsic_id() == vmIntrinsics::_linkToSpecial, etc. 676 static methodHandle make_method_handle_intrinsic(vmIntrinsicID iid, // _invokeBasic, _linkToVirtual 677 Symbol* signature, //anything at all 678 TRAPS); 679 // Some special methods don't need to be findable by nmethod iterators and are permanent. 680 bool can_be_allocated_in_NonNMethod_space() const { return is_method_handle_intrinsic(); } 681 682 // Continuation 683 inline bool is_continuation_enter_intrinsic() const; 684 inline bool is_continuation_yield_intrinsic() const; 685 inline bool is_continuation_native_intrinsic() const; 686 inline bool is_special_native_intrinsic() const; 687 688 static Klass* check_non_bcp_klass(Klass* klass); 689 690 enum { 691 // How many extra stack entries for invokedynamic 692 extra_stack_entries_for_jsr292 = 1 693 }; 694 695 // this operates only on invoke methods: 696 // presize interpreter frames for extra interpreter stack entries, if needed 697 // Account for the extra appendix argument for invokehandle/invokedynamic 698 static int extra_stack_entries() { return extra_stack_entries_for_jsr292; } 699 static int extra_stack_words(); // = extra_stack_entries() * Interpreter::stackElementSize 700 701 // RedefineClasses() support: 702 bool on_stack() const { return on_stack_flag(); } 703 void set_on_stack(const bool value); 704 705 void record_gc_epoch(); 706 707 // see the definition in Method*.cpp for the gory details 708 bool should_not_be_cached() const; 709 710 // Rewriting support 711 static methodHandle clone_with_new_data(const methodHandle& m, u_char* new_code, int new_code_length, 712 u_char* new_compressed_linenumber_table, int new_compressed_linenumber_size, TRAPS); 713 714 // jmethodID handling 715 // Because the useful life-span of a jmethodID cannot be determined, 716 // once created they are never reclaimed. The methods to which they refer, 717 // however, can be GC'ed away if the class is unloaded or if the method is 718 // made obsolete or deleted -- in these cases, the jmethodID 719 // refers to null (as is the case for any weak reference). 720 static jmethodID make_jmethod_id(ClassLoaderData* cld, Method* mh); 721 722 // Ensure there is enough capacity in the internal tracking data 723 // structures to hold the number of jmethodIDs you plan to generate. 724 // This saves substantial time doing allocations. 725 static void ensure_jmethod_ids(ClassLoaderData* cld, int capacity); 726 727 // Use resolve_jmethod_id() in situations where the caller is expected 728 // to provide a valid jmethodID; the only sanity checks are in asserts; 729 // result guaranteed not to be null. 730 inline static Method* resolve_jmethod_id(jmethodID mid) { 731 assert(mid != nullptr, "JNI method id should not be null"); 732 return *((Method**)mid); 733 } 734 735 // Use checked_resolve_jmethod_id() in situations where the caller 736 // should provide a valid jmethodID, but might not. Null is returned 737 // when the jmethodID does not refer to a valid method. 738 static Method* checked_resolve_jmethod_id(jmethodID mid); 739 740 static void change_method_associated_with_jmethod_id(jmethodID old_jmid_ptr, Method* new_method); 741 static bool is_method_id(jmethodID mid); 742 743 // Clear methods 744 static void clear_jmethod_ids(ClassLoaderData* loader_data); 745 void clear_jmethod_id(); 746 static void print_jmethod_ids_count(const ClassLoaderData* loader_data, outputStream* out) PRODUCT_RETURN; 747 748 // Get this method's jmethodID -- allocate if it doesn't exist 749 jmethodID jmethod_id(); 750 751 // Lookup the jmethodID for this method. Return null if not found. 752 // NOTE that this function can be called from a signal handler 753 // (see AsyncGetCallTrace support for Forte Analyzer) and this 754 // needs to be async-safe. No allocation should be done and 755 // so handles are not used to avoid deadlock. 756 jmethodID find_jmethod_id_or_null() { return method_holder()->jmethod_id_or_null(this); } 757 758 // Support for inlining of intrinsic methods 759 vmIntrinsicID intrinsic_id() const { return (vmIntrinsicID) _intrinsic_id; } 760 void set_intrinsic_id(vmIntrinsicID id) { _intrinsic_id = (u2) id; } 761 762 // Helper routines for intrinsic_id() and vmIntrinsics::method(). 763 void init_intrinsic_id(vmSymbolID klass_id); // updates from _none if a match 764 static vmSymbolID klass_id_for_intrinsics(const Klass* holder); 765 766 bool caller_sensitive() const { return constMethod()->caller_sensitive(); } 767 void set_caller_sensitive() { constMethod()->set_caller_sensitive(); } 768 769 bool changes_current_thread() const { return constMethod()->changes_current_thread(); } 770 void set_changes_current_thread() { constMethod()->set_changes_current_thread(); } 771 772 bool jvmti_mount_transition() const { return constMethod()->jvmti_mount_transition(); } 773 void set_jvmti_mount_transition() { constMethod()->set_jvmti_mount_transition(); } 774 775 bool is_hidden() const { return constMethod()->is_hidden(); } 776 void set_is_hidden() { constMethod()->set_is_hidden(); } 777 778 bool is_scoped() const { return constMethod()->is_scoped(); } 779 void set_scoped() { constMethod()->set_is_scoped(); } 780 781 bool intrinsic_candidate() const { return constMethod()->intrinsic_candidate(); } 782 void set_intrinsic_candidate() { constMethod()->set_intrinsic_candidate(); } 783 784 bool has_injected_profile() const { return constMethod()->has_injected_profile(); } 785 void set_has_injected_profile() { constMethod()->set_has_injected_profile(); } 786 787 bool has_reserved_stack_access() const { return constMethod()->reserved_stack_access(); } 788 void set_has_reserved_stack_access() { constMethod()->set_reserved_stack_access(); } 789 790 JFR_ONLY(DEFINE_TRACE_FLAG_ACCESSOR;) 791 792 ConstMethod::MethodType method_type() const { 793 return _constMethod->method_type(); 794 } 795 bool is_overpass() const { return method_type() == ConstMethod::OVERPASS; } 796 797 // On-stack replacement support 798 bool has_osr_nmethod(int level, bool match_level) { 799 return method_holder()->lookup_osr_nmethod(this, InvocationEntryBci, level, match_level) != nullptr; 800 } 801 802 nmethod* lookup_osr_nmethod_for(int bci, int level, bool match_level) { 803 return method_holder()->lookup_osr_nmethod(this, bci, level, match_level); 804 } 805 806 // Find if klass for method is loaded 807 bool is_klass_loaded_by_klass_index(int klass_index) const; 808 bool is_klass_loaded(int refinfo_index, Bytecodes::Code bc, bool must_be_resolved = false) const; 809 810 // Indicates whether compilation failed earlier for this method, or 811 // whether it is not compilable for another reason like having a 812 // breakpoint set in it. 813 bool is_not_compilable(int comp_level = CompLevel_any) const; 814 void set_not_compilable(const char* reason, int comp_level = CompLevel_all, bool report = true); 815 void set_not_compilable_quietly(const char* reason, int comp_level = CompLevel_all) { 816 set_not_compilable(reason, comp_level, false); 817 } 818 bool is_not_osr_compilable(int comp_level = CompLevel_any) const; 819 void set_not_osr_compilable(const char* reason, int comp_level = CompLevel_all, bool report = true); 820 void set_not_osr_compilable_quietly(const char* reason, int comp_level = CompLevel_all) { 821 set_not_osr_compilable(reason, comp_level, false); 822 } 823 bool is_always_compilable() const; 824 825 private: 826 void print_made_not_compilable(int comp_level, bool is_osr, bool report, const char* reason); 827 828 public: 829 MethodCounters* get_method_counters(Thread* current) { 830 if (_method_counters == nullptr) { 831 build_method_counters(current, this); 832 } 833 return _method_counters; 834 } 835 836 void clear_is_not_c1_compilable() { set_is_not_c1_compilable(false); } 837 void clear_is_not_c2_compilable() { set_is_not_c2_compilable(false); } 838 void clear_is_not_c2_osr_compilable() { set_is_not_c2_osr_compilable(false); } 839 840 // not_c1_osr_compilable == not_c1_compilable 841 bool is_not_c1_osr_compilable() const { return is_not_c1_compilable(); } 842 void set_is_not_c1_osr_compilable() { set_is_not_c1_compilable(); } 843 void clear_is_not_c1_osr_compilable() { clear_is_not_c1_compilable(); } 844 845 // Background compilation support 846 void clear_queued_for_compilation() { set_queued_for_compilation(false); } 847 848 // Resolve all classes in signature, return 'true' if successful 849 static bool load_signature_classes(const methodHandle& m, TRAPS); 850 851 // Printing 852 void print_short_name(outputStream* st = tty) const; // prints as klassname::methodname; Exposed so field engineers can debug VM 853 #if INCLUDE_JVMTI 854 void print_name(outputStream* st = tty) const; // prints as "virtual void foo(int)"; exposed for -Xlog:redefine+class 855 #else 856 void print_name(outputStream* st = tty) const PRODUCT_RETURN; // prints as "virtual void foo(int)" 857 #endif 858 859 typedef int (*method_comparator_func)(Method* a, Method* b); 860 861 // Helper routine used for method sorting 862 static void sort_methods(Array<Method*>* methods, bool set_idnums = true, method_comparator_func func = nullptr); 863 864 // Deallocation function for redefine classes or if an error occurs 865 void deallocate_contents(ClassLoaderData* loader_data); 866 867 void release_C_heap_structures(); 868 869 Method* get_new_method() const { 870 InstanceKlass* holder = method_holder(); 871 Method* new_method = holder->method_with_idnum(orig_method_idnum()); 872 873 assert(new_method != nullptr, "method_with_idnum() should not be null"); 874 assert(this != new_method, "sanity check"); 875 return new_method; 876 } 877 878 // Printing 879 #ifndef PRODUCT 880 void print_on(outputStream* st) const; 881 #endif 882 void print_value_on(outputStream* st) const; 883 void print_linkage_flags(outputStream* st) PRODUCT_RETURN; 884 885 const char* internal_name() const { return "{method}"; } 886 887 // Check for valid method pointer 888 static bool has_method_vptr(const void* ptr); 889 static bool is_valid_method(const Method* m); 890 891 // Verify 892 void verify() { verify_on(tty); } 893 void verify_on(outputStream* st); 894 895 private: 896 897 // Inlined elements 898 address* native_function_addr() const { assert(is_native(), "must be native"); return (address*) (this+1); } 899 address* signature_handler_addr() const { return native_function_addr() + 1; } 900 }; 901 902 903 // Utility class for compressing line number tables 904 905 class CompressedLineNumberWriteStream: public CompressedWriteStream { 906 private: 907 int _bci; 908 int _line; 909 public: 910 // Constructor 911 CompressedLineNumberWriteStream(int initial_size) : CompressedWriteStream(initial_size), _bci(0), _line(0) {} 912 CompressedLineNumberWriteStream(u_char* buffer, int initial_size) : CompressedWriteStream(buffer, initial_size), _bci(0), _line(0) {} 913 914 // Write (bci, line number) pair to stream 915 void write_pair_regular(int bci_delta, int line_delta); 916 917 // If (bci delta, line delta) fits in (5-bit unsigned, 3-bit unsigned) 918 // we save it as one byte, otherwise we write a 0xFF escape character 919 // and use regular compression. 0x0 is used as end-of-stream terminator. 920 void write_pair_inline(int bci, int line); 921 922 void write_pair(int bci, int line); 923 924 // Write end-of-stream marker 925 void write_terminator() { write_byte(0); } 926 }; 927 928 929 // Utility class for decompressing line number tables 930 931 class CompressedLineNumberReadStream: public CompressedReadStream { 932 private: 933 int _bci; 934 int _line; 935 public: 936 // Constructor 937 CompressedLineNumberReadStream(u_char* buffer); 938 // Read (bci, line number) pair from stream. Returns false at end-of-stream. 939 bool read_pair(); 940 // Accessing bci and line number (after calling read_pair) 941 int bci() const { return _bci; } 942 int line() const { return _line; } 943 }; 944 945 946 #if INCLUDE_JVMTI 947 948 /// Fast Breakpoints. 949 950 // If this structure gets more complicated (because bpts get numerous), 951 // move it into its own header. 952 953 // There is presently no provision for concurrent access 954 // to breakpoint lists, which is only OK for JVMTI because 955 // breakpoints are written only at safepoints, and are read 956 // concurrently only outside of safepoints. 957 958 class BreakpointInfo : public CHeapObj<mtClass> { 959 friend class VMStructs; 960 private: 961 Bytecodes::Code _orig_bytecode; 962 int _bci; 963 u2 _name_index; // of method 964 u2 _signature_index; // of method 965 BreakpointInfo* _next; // simple storage allocation 966 967 public: 968 BreakpointInfo(Method* m, int bci); 969 970 // accessors 971 Bytecodes::Code orig_bytecode() { return _orig_bytecode; } 972 void set_orig_bytecode(Bytecodes::Code code) { _orig_bytecode = code; } 973 int bci() { return _bci; } 974 975 BreakpointInfo* next() const { return _next; } 976 void set_next(BreakpointInfo* n) { _next = n; } 977 978 // helps for searchers 979 bool match(const Method* m, int bci) { 980 return bci == _bci && match(m); 981 } 982 983 bool match(const Method* m) { 984 return _name_index == m->name_index() && 985 _signature_index == m->signature_index(); 986 } 987 988 void set(Method* method); 989 void clear(Method* method); 990 }; 991 992 #endif // INCLUDE_JVMTI 993 994 // Utility class for access exception handlers 995 class ExceptionTable : public StackObj { 996 private: 997 ExceptionTableElement* _table; 998 u2 _length; 999 1000 public: 1001 ExceptionTable(const Method* m) { 1002 if (m->has_exception_handler()) { 1003 _table = m->exception_table_start(); 1004 _length = m->exception_table_length(); 1005 } else { 1006 _table = nullptr; 1007 _length = 0; 1008 } 1009 } 1010 1011 u2 length() const { 1012 return _length; 1013 } 1014 1015 u2 start_pc(int idx) const { 1016 assert(idx < _length, "out of bounds"); 1017 return _table[idx].start_pc; 1018 } 1019 1020 void set_start_pc(int idx, u2 value) { 1021 assert(idx < _length, "out of bounds"); 1022 _table[idx].start_pc = value; 1023 } 1024 1025 u2 end_pc(int idx) const { 1026 assert(idx < _length, "out of bounds"); 1027 return _table[idx].end_pc; 1028 } 1029 1030 void set_end_pc(int idx, u2 value) { 1031 assert(idx < _length, "out of bounds"); 1032 _table[idx].end_pc = value; 1033 } 1034 1035 u2 handler_pc(int idx) const { 1036 assert(idx < _length, "out of bounds"); 1037 return _table[idx].handler_pc; 1038 } 1039 1040 void set_handler_pc(int idx, u2 value) { 1041 assert(idx < _length, "out of bounds"); 1042 _table[idx].handler_pc = value; 1043 } 1044 1045 u2 catch_type_index(int idx) const { 1046 assert(idx < _length, "out of bounds"); 1047 return _table[idx].catch_type_index; 1048 } 1049 1050 void set_catch_type_index(int idx, u2 value) { 1051 assert(idx < _length, "out of bounds"); 1052 _table[idx].catch_type_index = value; 1053 } 1054 }; 1055 1056 #endif // SHARE_OOPS_METHOD_HPP