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