src/share/vm/interpreter/linkResolver.hpp

Fri, 13 Sep 2013 22:38:02 -0400

author
drchase
date
Fri, 13 Sep 2013 22:38:02 -0400
changeset 5732
b2e698d2276c
parent 4133
f6b0eb4e44cf
child 5848
ac9cb1d5a202
permissions
-rw-r--r--

8014013: CallInfo structure no longer accurately reports the result of a LinkResolver operation
Summary: Enhance method resolution and resulting data structures, plus some refactoring.
Reviewed-by: twisti, acorn, jrose

     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  */
    25 #ifndef SHARE_VM_INTERPRETER_LINKRESOLVER_HPP
    26 #define SHARE_VM_INTERPRETER_LINKRESOLVER_HPP
    28 #include "oops/method.hpp"
    29 #include "utilities/top.hpp"
    31 // All the necessary definitions for run-time link resolution.
    33 // CallInfo provides all the information gathered for a particular
    34 // linked call site after resolving it. A link is any reference
    35 // made from within the bytecodes of a method to an object outside of
    36 // that method. If the info is invalid, the link has not been resolved
    37 // successfully.
    39 class CallInfo VALUE_OBJ_CLASS_SPEC {
    40  public:
    41   // Ways that a method call might be selected (or not) based on receiver type.
    42   // Note that an invokevirtual instruction might be linked with no_dispatch,
    43   // and an invokeinterface instruction might be linked with any of the three options
    44   enum CallKind {
    45     direct_call,                        // jump into resolved_method (must be concrete)
    46     vtable_call,                        // select recv.klass.method_at_vtable(index)
    47     itable_call,                        // select recv.klass.method_at_itable(resolved_method.holder, index)
    48     unknown_kind = -1
    49   };
    50  private:
    51   KlassHandle  _resolved_klass;         // static receiver klass, resolved from a symbolic reference
    52   KlassHandle  _selected_klass;         // dynamic receiver class (same as static, or subklass)
    53   methodHandle _resolved_method;        // static target method
    54   methodHandle _selected_method;        // dynamic (actual) target method
    55   CallKind     _call_kind;              // kind of call (static(=bytecode static/special +
    56                                         //               others inferred), vtable, itable)
    57   int          _call_index;             // vtable or itable index of selected class method (if any)
    58   Handle       _resolved_appendix;      // extra argument in constant pool (if CPCE::has_appendix)
    59   Handle       _resolved_method_type;   // MethodType (for invokedynamic and invokehandle call sites)
    61   void         set_static(   KlassHandle resolved_klass,                             methodHandle resolved_method                                                       , TRAPS);
    62   void         set_interface(KlassHandle resolved_klass, KlassHandle selected_klass, methodHandle resolved_method, methodHandle selected_method, int itable_index       , TRAPS);
    63   void         set_virtual(  KlassHandle resolved_klass, KlassHandle selected_klass, methodHandle resolved_method, methodHandle selected_method, int vtable_index       , TRAPS);
    64   void         set_handle(                                                           methodHandle resolved_method, Handle resolved_appendix, Handle resolved_method_type, TRAPS);
    65   void         set_common(   KlassHandle resolved_klass, KlassHandle selected_klass, methodHandle resolved_method, methodHandle selected_method, CallKind kind, int index, TRAPS);
    67   friend class LinkResolver;
    69  public:
    70   CallInfo() {
    71 #ifndef PRODUCT
    72     _call_kind  = CallInfo::unknown_kind;
    73     _call_index = Method::garbage_vtable_index;
    74 #endif //PRODUCT
    75   }
    77   // utility to extract an effective CallInfo from a method and an optional receiver limit
    78   // does not queue the method for compilation
    79   CallInfo(Method* resolved_method, Klass* resolved_klass = NULL);
    81   KlassHandle  resolved_klass() const            { return _resolved_klass; }
    82   KlassHandle  selected_klass() const            { return _selected_klass; }
    83   methodHandle resolved_method() const           { return _resolved_method; }
    84   methodHandle selected_method() const           { return _selected_method; }
    85   Handle       resolved_appendix() const         { return _resolved_appendix; }
    86   Handle       resolved_method_type() const      { return _resolved_method_type; }
    88   BasicType    result_type() const               { return selected_method()->result_type(); }
    89   CallKind     call_kind() const                 { return _call_kind; }
    90   int          call_index() const                { return _call_index; }
    91   int          vtable_index() const {
    92     // Even for interface calls the vtable index could be non-negative.
    93     // See CallInfo::set_interface.
    94     assert(has_vtable_index() || is_statically_bound(), "");
    95     assert(call_kind() == vtable_call || call_kind() == direct_call, "");
    96     // The returned value is < 0 if the call is statically bound.
    97     // But, the returned value may be >= 0 even if the kind is direct_call.
    98     // It is up to the caller to decide which way to go.
    99     return _call_index;
   100   }
   101   int          itable_index() const {
   102     assert(call_kind() == itable_call, "");
   103     // The returned value is always >= 0, a valid itable index.
   104     return _call_index;
   105   }
   107   // debugging
   108 #ifdef ASSERT
   109   bool         has_vtable_index() const          { return _call_index >= 0 && _call_kind != CallInfo::itable_call; }
   110   bool         is_statically_bound() const       { return _call_index == Method::nonvirtual_vtable_index; }
   111 #endif //ASSERT
   112   void         verify() PRODUCT_RETURN;
   113   void         print()  PRODUCT_RETURN;
   114 };
   116 // Link information for getfield/putfield & getstatic/putstatic bytecodes
   117 // is represented using a fieldDescriptor.
   119 // The LinkResolver is used to resolve constant-pool references at run-time.
   120 // It does all necessary link-time checks & throws exceptions if necessary.
   122 class LinkResolver: AllStatic {
   123   friend class klassVtable;
   124   friend class klassItable;
   126  private:
   127   static void lookup_method_in_klasses          (methodHandle& result, KlassHandle klass, Symbol* name, Symbol* signature, TRAPS);
   128   static void lookup_instance_method_in_klasses (methodHandle& result, KlassHandle klass, Symbol* name, Symbol* signature, TRAPS);
   129   static void lookup_method_in_interfaces       (methodHandle& result, KlassHandle klass, Symbol* name, Symbol* signature, TRAPS);
   130   static void lookup_polymorphic_method         (methodHandle& result, KlassHandle klass, Symbol* name, Symbol* signature,
   131                                                  KlassHandle current_klass, Handle *appendix_result_or_null, Handle *method_type_result, TRAPS);
   133   static int vtable_index_of_miranda_method(KlassHandle klass, Symbol* name, Symbol* signature, TRAPS);
   135   static void resolve_klass           (KlassHandle& result, constantPoolHandle  pool, int index, TRAPS);
   137   static void resolve_pool  (KlassHandle& resolved_klass, Symbol*& method_name, Symbol*& method_signature, KlassHandle& current_klass, constantPoolHandle pool, int index, TRAPS);
   139   static void resolve_interface_method(methodHandle& resolved_method, KlassHandle resolved_klass, Symbol* method_name, Symbol* method_signature, KlassHandle current_klass, bool check_access, TRAPS);
   140   static void resolve_method          (methodHandle& resolved_method, KlassHandle resolved_klass, Symbol* method_name, Symbol* method_signature, KlassHandle current_klass, bool check_access, TRAPS);
   142   static void linktime_resolve_static_method    (methodHandle& resolved_method, KlassHandle resolved_klass, Symbol* method_name, Symbol* method_signature, KlassHandle current_klass, bool check_access, TRAPS);
   143   static void linktime_resolve_special_method   (methodHandle& resolved_method, KlassHandle resolved_klass, Symbol* method_name, Symbol* method_signature, KlassHandle current_klass, bool check_access, TRAPS);
   144   static void linktime_resolve_virtual_method   (methodHandle &resolved_method, KlassHandle resolved_klass, Symbol* method_name, Symbol* method_signature,KlassHandle current_klass, bool check_access, TRAPS);
   145   static void linktime_resolve_interface_method (methodHandle& resolved_method, KlassHandle resolved_klass, Symbol* method_name, Symbol* method_signature, KlassHandle current_klass, bool check_access, TRAPS);
   147   static void runtime_resolve_special_method    (CallInfo& result, methodHandle resolved_method, KlassHandle resolved_klass, KlassHandle current_klass, bool check_access, TRAPS);
   148   static void runtime_resolve_virtual_method    (CallInfo& result, methodHandle resolved_method, KlassHandle resolved_klass, Handle recv, KlassHandle recv_klass, bool check_null_and_abstract, TRAPS);
   149   static void runtime_resolve_interface_method  (CallInfo& result, methodHandle resolved_method, KlassHandle resolved_klass, Handle recv, KlassHandle recv_klass, bool check_null_and_abstract, TRAPS);
   151   static void check_field_accessability   (KlassHandle ref_klass, KlassHandle resolved_klass, KlassHandle sel_klass, fieldDescriptor& fd, TRAPS);
   152   static void check_method_accessability  (KlassHandle ref_klass, KlassHandle resolved_klass, KlassHandle sel_klass, methodHandle sel_method, TRAPS);
   154  public:
   155   // constant pool resolving
   156   static void check_klass_accessability(KlassHandle ref_klass, KlassHandle sel_klass, TRAPS);
   158   // static resolving calls (will not run any Java code); used only from Bytecode_invoke::static_target
   159   static void resolve_method_statically(methodHandle& method_result, KlassHandle& klass_result,
   160                                         Bytecodes::Code code, constantPoolHandle pool, int index, TRAPS);
   162   // runtime/static resolving for fields
   163   static void resolve_field_access(fieldDescriptor& result, constantPoolHandle pool, int index, Bytecodes::Code byte, TRAPS);
   164   static void resolve_field(fieldDescriptor& result, KlassHandle resolved_klass, Symbol* field_name, Symbol* field_signature,
   165                             KlassHandle current_klass, Bytecodes::Code access_kind, bool check_access, bool initialize_class, TRAPS);
   167   // source of access_kind codes:
   168   static Bytecodes::Code field_access_kind(bool is_static, bool is_put) {
   169     return (is_static
   170             ? (is_put ? Bytecodes::_putstatic : Bytecodes::_getstatic)
   171             : (is_put ? Bytecodes::_putfield  : Bytecodes::_getfield ));
   172   }
   174   // runtime resolving:
   175   //   resolved_klass = specified class (i.e., static receiver class)
   176   //   current_klass  = sending method holder (i.e., class containing the method containing the call being resolved)
   177   static void resolve_static_call   (CallInfo& result,              KlassHandle& resolved_klass, Symbol* method_name, Symbol* method_signature, KlassHandle current_klass, bool check_access, bool initialize_klass, TRAPS);
   178   static void resolve_special_call  (CallInfo& result,              KlassHandle resolved_klass, Symbol* method_name, Symbol* method_signature, KlassHandle current_klass, bool check_access, TRAPS);
   179   static void resolve_virtual_call  (CallInfo& result, Handle recv, KlassHandle recv_klass, KlassHandle resolved_klass, Symbol* method_name, Symbol* method_signature, KlassHandle current_klass, bool check_access, bool check_null_and_abstract, TRAPS);
   180   static void resolve_interface_call(CallInfo& result, Handle recv, KlassHandle recv_klass, KlassHandle resolved_klass, Symbol* method_name, Symbol* method_signature, KlassHandle current_klass, bool check_access, bool check_null_and_abstract, TRAPS);
   181   static void resolve_handle_call   (CallInfo& result,                                      KlassHandle resolved_klass, Symbol* method_name, Symbol* method_signature, KlassHandle current_klass, TRAPS);
   182   static void resolve_dynamic_call  (CallInfo& result,                                      Handle bootstrap_specifier, Symbol* method_name, Symbol* method_signature, KlassHandle current_klass, TRAPS);
   184   // same as above for compile-time resolution; but returns null handle instead of throwing an exception on error
   185   // also, does not initialize klass (i.e., no side effects)
   186   static methodHandle resolve_virtual_call_or_null  (KlassHandle receiver_klass, KlassHandle resolved_klass, Symbol* method_name, Symbol* method_signature, KlassHandle current_klass);
   187   static methodHandle resolve_interface_call_or_null(KlassHandle receiver_klass, KlassHandle resolved_klass, Symbol* method_name, Symbol* method_signature, KlassHandle current_klass);
   188   static methodHandle resolve_static_call_or_null   (KlassHandle resolved_klass, Symbol* method_name, Symbol* method_signature, KlassHandle current_klass);
   189   static methodHandle resolve_special_call_or_null  (KlassHandle resolved_klass, Symbol* method_name, Symbol* method_signature, KlassHandle current_klass);
   191   // same as above for compile-time resolution; returns vtable_index if current_klass if linked
   192   static int resolve_virtual_vtable_index  (KlassHandle receiver_klass, KlassHandle resolved_klass, Symbol* method_name, Symbol* method_signature, KlassHandle current_klass);
   194   // static resolving for compiler (does not throw exceptions, returns null handle if unsuccessful)
   195   static methodHandle linktime_resolve_virtual_method_or_null  (KlassHandle resolved_klass, Symbol* method_name, Symbol* method_signature, KlassHandle current_klass, bool check_access);
   196   static methodHandle linktime_resolve_interface_method_or_null(KlassHandle resolved_klass, Symbol* method_name, Symbol* method_signature, KlassHandle current_klass, bool check_access);
   198   // runtime resolving from constant pool
   199   static void resolve_invokestatic   (CallInfo& result,              constantPoolHandle pool, int index, TRAPS);
   200   static void resolve_invokespecial  (CallInfo& result,              constantPoolHandle pool, int index, TRAPS);
   201   static void resolve_invokevirtual  (CallInfo& result, Handle recv, constantPoolHandle pool, int index, TRAPS);
   202   static void resolve_invokeinterface(CallInfo& result, Handle recv, constantPoolHandle pool, int index, TRAPS);
   203   static void resolve_invokedynamic  (CallInfo& result,              constantPoolHandle pool, int index, TRAPS);
   204   static void resolve_invokehandle   (CallInfo& result,              constantPoolHandle pool, int index, TRAPS);
   206   static void resolve_invoke         (CallInfo& result, Handle recv, constantPoolHandle pool, int index, Bytecodes::Code byte, TRAPS);
   207 };
   209 #endif // SHARE_VM_INTERPRETER_LINKRESOLVER_HPP

mercurial