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