1 /*
   2  * Copyright (c) 2015, 2018, 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.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package jdk.internal.access;
  27 
  28 import java.foreign.layout.LayoutPath;
  29 import java.lang.invoke.MethodType;
  30 import java.lang.invoke.VarHandle;
  31 import java.util.Map;
  32 
  33 public interface JavaLangInvokeAccess {
  34     /**
  35      * Create a new MemberName instance. Used by {@code StackFrameInfo}.
  36      */
  37     Object newMemberName();
  38 
  39     /**
  40      * Returns the name for the given MemberName. Used by {@code StackFrameInfo}.
  41      */
  42     String getName(Object mname);
  43 
  44     /**
  45      * Returns the {@code MethodType} for the given MemberName.
  46      * Used by {@code StackFrameInfo}.
  47      */
  48     MethodType getMethodType(Object mname);
  49 
  50     /**
  51      * Returns the descriptor for the given MemberName.
  52      * Used by {@code StackFrameInfo}.
  53      */
  54     String getMethodDescriptor(Object mname);
  55 
  56     /**
  57      * Returns {@code true} if the given MemberName is a native method.
  58      * Used by {@code StackFrameInfo}.
  59      */
  60     boolean isNative(Object mname);
  61 
  62     /**
  63      * Returns the declaring class for the given MemberName.
  64      * Used by {@code StackFrameInfo}.
  65      */
  66     Class<?> getDeclaringClass(Object mname);
  67 
  68     /**
  69      * Returns a {@code byte[]} representation of a class implementing
  70      * DirectMethodHandle of each pairwise combination of {@code MethodType} and
  71      * an {@code int} representing method type.  Used by
  72      * GenerateJLIClassesPlugin to generate such a class during the jlink phase.
  73      */
  74     byte[] generateDirectMethodHandleHolderClassBytes(String className,
  75             MethodType[] methodTypes, int[] types);
  76 
  77     /**
  78      * Returns a {@code byte[]} representation of a class implementing
  79      * DelegatingMethodHandles of each {@code MethodType} kind in the
  80      * {@code methodTypes} argument.  Used by GenerateJLIClassesPlugin to
  81      * generate such a class during the jlink phase.
  82      */
  83     byte[] generateDelegatingMethodHandleHolderClassBytes(String className,
  84             MethodType[] methodTypes);
  85 
  86     /**
  87      * Returns a {@code byte[]} representation of {@code BoundMethodHandle}
  88      * species class implementing the signature defined by {@code types}. Used
  89      * by GenerateJLIClassesPlugin to enable generation of such classes during
  90      * the jlink phase. Should do some added validation since this string may be
  91      * user provided.
  92      */
  93     Map.Entry<String, byte[]> generateConcreteBMHClassBytes(
  94             final String types);
  95 
  96     /**
  97      * Returns a {@code byte[]} representation of a class implementing
  98      * the zero and identity forms of all {@code LambdaForm.BasicType}s.
  99      */
 100     byte[] generateBasicFormsClassBytes(final String className);
 101 
 102     /**
 103      * Returns a {@code byte[]} representation of a class implementing
 104      * the invoker forms for the set of supplied {@code invokerMethodTypes}
 105      * and {@code callSiteMethodTypes}.
 106      */
 107     byte[] generateInvokersHolderClassBytes(String className,
 108             MethodType[] invokerMethodTypes,
 109             MethodType[] callSiteMethodTypes);
 110 
 111     /**
 112      * Returns a var handle view of a given memory address.
 113      */
 114     VarHandle memoryAddressViewVarHandle(Class<?> carrier, LayoutPath layout);
 115 }