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