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