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