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