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