1 /*
   2  * Copyright (c) 2008, 2017, 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_PRIMS_METHODHANDLES_HPP
  26 #define SHARE_VM_PRIMS_METHODHANDLES_HPP
  27 
  28 #include "classfile/javaClasses.hpp"
  29 #include "classfile/vmSymbols.hpp"
  30 #include "runtime/frame.hpp"
  31 #include "runtime/globals.hpp"
  32 #include "utilities/macros.hpp"
  33 
  34 #ifdef ZERO
  35 # include "entry_zero.hpp"
  36 # include "interpreter/interpreter.hpp"
  37 #endif
  38 
  39 
  40 class MacroAssembler;
  41 class Label;
  42 
  43 class MethodHandles: AllStatic {
  44   // JVM support for MethodHandle, MethodType, and related types
  45   // in java.lang.invoke and sun.invoke.
  46   // See also  javaClasses for layouts java_lang_invoke_Method{Handle,Type,Type::Form}.
  47  public:
  48  public:
  49   static bool enabled()                         { return _enabled; }
  50   static void set_enabled(bool z);
  51 
  52  private:
  53   static bool _enabled;
  54 
  55   // Adapters.
  56   static MethodHandlesAdapterBlob* _adapter_code;
  57 
  58   // utility functions for reifying names and types
  59   static oop field_name_or_null(Symbol* s);
  60   static oop field_signature_type_or_null(Symbol* s);
  61 
  62  public:
  63   // working with member names
  64   static Handle resolve_MemberName(Handle mname, Klass* caller, TRAPS); // compute vmtarget/vmindex from name/type
  65   static void expand_MemberName(Handle mname, int suppress, TRAPS);  // expand defc/name/type if missing
  66   static oop init_MemberName(Handle mname_h, Handle target_h, TRAPS); // compute vmtarget/vmindex from target
  67   static oop init_field_MemberName(Handle mname_h, fieldDescriptor& fd, bool is_setter = false);
  68   static oop init_method_MemberName(Handle mname_h, CallInfo& info);
  69   static int method_ref_kind(Method* m, bool do_dispatch_if_possible = true);
  70   static int find_MemberNames(Klass* k, Symbol* name, Symbol* sig,
  71                               int mflags, Klass* caller,
  72                               int skip, objArrayHandle results, TRAPS);
  73   static Handle resolve_MemberName_type(Handle mname, Klass* caller, TRAPS);
  74 
  75   // bit values for suppress argument to expand_MemberName:
  76   enum { _suppress_defc = 1, _suppress_name = 2, _suppress_type = 4 };
  77 
  78   // CallSite support
  79   static void add_dependent_nmethod(oop call_site, nmethod* nm);
  80   static void remove_dependent_nmethod(oop call_site, nmethod* nm);
  81 
  82   static void flush_dependent_nmethods(Handle call_site, Handle target);
  83 
  84   // Generate MethodHandles adapters.
  85   static void generate_adapters();
  86 
  87   // Called from MethodHandlesAdapterGenerator.
  88   static address generate_method_handle_interpreter_entry(MacroAssembler* _masm, vmIntrinsics::ID iid);
  89   static void generate_method_handle_dispatch(MacroAssembler* _masm,
  90                                               vmIntrinsics::ID iid,
  91                                               Register receiver_reg,
  92                                               Register member_reg,
  93                                               bool for_compiler_entry);
  94 
  95   // Queries
  96   static bool is_signature_polymorphic(vmIntrinsics::ID iid) {
  97     return (iid >= vmIntrinsics::FIRST_MH_SIG_POLY &&
  98             iid <= vmIntrinsics::LAST_MH_SIG_POLY);
  99   }
 100 
 101   static bool is_signature_polymorphic_method(Method* m) {
 102     return is_signature_polymorphic(m->intrinsic_id());
 103   }
 104 
 105   static bool is_signature_polymorphic_intrinsic(vmIntrinsics::ID iid) {
 106     assert(is_signature_polymorphic(iid), "");
 107     // Most sig-poly methods are intrinsics which do not require an
 108     // appeal to Java for adapter code.
 109     return (iid != vmIntrinsics::_invokeGeneric);
 110   }
 111 
 112   static bool is_signature_polymorphic_static(vmIntrinsics::ID iid) {
 113     assert(is_signature_polymorphic(iid), "");
 114     return (iid >= vmIntrinsics::FIRST_MH_STATIC &&
 115             iid <= vmIntrinsics::LAST_MH_SIG_POLY);
 116   }
 117 
 118   static bool has_member_arg(vmIntrinsics::ID iid) {
 119     assert(is_signature_polymorphic(iid), "");
 120     return (iid >= vmIntrinsics::_linkToVirtual &&
 121             iid <= vmIntrinsics::_linkToInterface);
 122   }
 123   static bool has_member_arg(Symbol* klass, Symbol* name) {
 124     if ((klass == vmSymbols::java_lang_invoke_MethodHandle() ||
 125          klass == vmSymbols::java_lang_invoke_VarHandle()) &&
 126         is_signature_polymorphic_name(name)) {
 127       vmIntrinsics::ID iid = signature_polymorphic_name_id(name);
 128       return has_member_arg(iid);
 129     }
 130     return false;
 131   }
 132 
 133   static Symbol* signature_polymorphic_intrinsic_name(vmIntrinsics::ID iid);
 134   static int signature_polymorphic_intrinsic_ref_kind(vmIntrinsics::ID iid);
 135 
 136   static vmIntrinsics::ID signature_polymorphic_name_id(Klass* klass, Symbol* name);
 137   static vmIntrinsics::ID signature_polymorphic_name_id(Symbol* name);
 138   static bool is_signature_polymorphic_name(Symbol* name) {
 139     return signature_polymorphic_name_id(name) != vmIntrinsics::_none;
 140   }
 141   static bool is_method_handle_invoke_name(Klass* klass, Symbol* name);
 142   static bool is_signature_polymorphic_name(Klass* klass, Symbol* name) {
 143     return signature_polymorphic_name_id(klass, name) != vmIntrinsics::_none;
 144   }
 145 
 146   static Bytecodes::Code signature_polymorphic_intrinsic_bytecode(vmIntrinsics::ID id);
 147 
 148   static int get_named_constant(int which, Handle name_box, TRAPS);
 149 
 150 public:
 151   static Symbol* lookup_signature(oop type_str, bool polymorphic, TRAPS);  // use TempNewSymbol
 152   static Symbol* lookup_basic_type_signature(Symbol* sig, bool keep_last_arg, TRAPS);  // use TempNewSymbol
 153   static Symbol* lookup_basic_type_signature(Symbol* sig, TRAPS) {
 154     return lookup_basic_type_signature(sig, false, THREAD);
 155   }
 156   static bool is_basic_type_signature(Symbol* sig);
 157 
 158   static Symbol* lookup_method_type(Symbol* msig, Handle mtype, TRAPS);
 159 
 160   static void print_as_method_type_on(outputStream* st, Symbol* sig) {
 161     print_as_basic_type_signature_on(st, sig, true, true);
 162   }
 163   static void print_as_basic_type_signature_on(outputStream* st, Symbol* sig, bool keep_arrays = false, bool keep_basic_names = false);
 164 
 165   // decoding CONSTANT_MethodHandle constants
 166   enum { JVM_REF_MIN = JVM_REF_getField, JVM_REF_MAX = JVM_REF_invokeInterface };
 167   static bool ref_kind_is_valid(int ref_kind) {
 168     return (ref_kind >= JVM_REF_MIN && ref_kind <= JVM_REF_MAX);
 169   }
 170   static bool ref_kind_is_field(int ref_kind) {
 171     assert(ref_kind_is_valid(ref_kind), "");
 172     return (ref_kind <= JVM_REF_putStatic);
 173   }
 174   static bool ref_kind_is_getter(int ref_kind) {
 175     assert(ref_kind_is_valid(ref_kind), "");
 176     return (ref_kind <= JVM_REF_getStatic);
 177   }
 178   static bool ref_kind_is_setter(int ref_kind) {
 179     return ref_kind_is_field(ref_kind) && !ref_kind_is_getter(ref_kind);
 180   }
 181   static bool ref_kind_is_method(int ref_kind) {
 182     return !ref_kind_is_field(ref_kind) && (ref_kind != JVM_REF_newInvokeSpecial);
 183   }
 184   static bool ref_kind_has_receiver(int ref_kind) {
 185     assert(ref_kind_is_valid(ref_kind), "");
 186     return (ref_kind & 1) != 0;
 187   }
 188   static bool ref_kind_is_static(int ref_kind) {
 189     return !ref_kind_has_receiver(ref_kind) && (ref_kind != JVM_REF_newInvokeSpecial);
 190   }
 191   static bool ref_kind_does_dispatch(int ref_kind) {
 192     return (ref_kind == JVM_REF_invokeVirtual ||
 193             ref_kind == JVM_REF_invokeInterface);
 194   }
 195 
 196   static int ref_kind_to_flags(int ref_kind);
 197 
 198 #include CPU_HEADER(methodHandles)
 199 
 200   // Tracing
 201   static void trace_method_handle(MacroAssembler* _masm, const char* adaptername) PRODUCT_RETURN;
 202   static void trace_method_handle_interpreter_entry(MacroAssembler* _masm, vmIntrinsics::ID iid);
 203 };
 204 
 205 //------------------------------------------------------------------------------
 206 // MethodHandlesAdapterGenerator
 207 //
 208 class MethodHandlesAdapterGenerator : public StubCodeGenerator {
 209 public:
 210   MethodHandlesAdapterGenerator(CodeBuffer* code) : StubCodeGenerator(code, PrintMethodHandleStubs) {}
 211 
 212   void generate();
 213 };
 214 
 215 #endif // SHARE_VM_PRIMS_METHODHANDLES_HPP