src/share/vm/oops/method.hpp

Thu, 20 Dec 2012 10:22:19 +0100

author
stefank
date
Thu, 20 Dec 2012 10:22:19 +0100
changeset 4393
35431a769282
parent 4303
5505fbbae3d3
child 4394
4daebd4cc1dd
permissions
-rw-r--r--

8004823: Add VM support for type annotation reflection
Reviewed-by: dholmes, coleenp
Contributed-by: joel.franck@oracle.com

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

mercurial