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