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