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