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