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