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