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