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