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