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