src/java.base/share/classes/jdk/internal/misc/JavaLangInvokeAccess.java
author mchung
Fri, 29 Sep 2017 11:33:08 -0700
changeset 47294 7d67bb6b0599
parent 47216 71c04702a3d5
child 47818 2f6ab27efb60
permissions -rw-r--r--
8186050: StackFrame should provide the method signature Reviewed-by: alanb, bchristi, forax, plevart
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
34362
3396ae214e7d 8140450: Implement JEP 259: Stack-Walking API
mchung
parents:
diff changeset
     1
/*
3396ae214e7d 8140450: Implement JEP 259: Stack-Walking API
mchung
parents:
diff changeset
     2
 * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
3396ae214e7d 8140450: Implement JEP 259: Stack-Walking API
mchung
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3396ae214e7d 8140450: Implement JEP 259: Stack-Walking API
mchung
parents:
diff changeset
     4
 *
3396ae214e7d 8140450: Implement JEP 259: Stack-Walking API
mchung
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
3396ae214e7d 8140450: Implement JEP 259: Stack-Walking API
mchung
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
3396ae214e7d 8140450: Implement JEP 259: Stack-Walking API
mchung
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
3396ae214e7d 8140450: Implement JEP 259: Stack-Walking API
mchung
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
3396ae214e7d 8140450: Implement JEP 259: Stack-Walking API
mchung
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
3396ae214e7d 8140450: Implement JEP 259: Stack-Walking API
mchung
parents:
diff changeset
    10
 *
3396ae214e7d 8140450: Implement JEP 259: Stack-Walking API
mchung
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
3396ae214e7d 8140450: Implement JEP 259: Stack-Walking API
mchung
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
3396ae214e7d 8140450: Implement JEP 259: Stack-Walking API
mchung
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
3396ae214e7d 8140450: Implement JEP 259: Stack-Walking API
mchung
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
3396ae214e7d 8140450: Implement JEP 259: Stack-Walking API
mchung
parents:
diff changeset
    15
 * accompanied this code).
3396ae214e7d 8140450: Implement JEP 259: Stack-Walking API
mchung
parents:
diff changeset
    16
 *
3396ae214e7d 8140450: Implement JEP 259: Stack-Walking API
mchung
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
3396ae214e7d 8140450: Implement JEP 259: Stack-Walking API
mchung
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
3396ae214e7d 8140450: Implement JEP 259: Stack-Walking API
mchung
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
3396ae214e7d 8140450: Implement JEP 259: Stack-Walking API
mchung
parents:
diff changeset
    20
 *
3396ae214e7d 8140450: Implement JEP 259: Stack-Walking API
mchung
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
3396ae214e7d 8140450: Implement JEP 259: Stack-Walking API
mchung
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
3396ae214e7d 8140450: Implement JEP 259: Stack-Walking API
mchung
parents:
diff changeset
    23
 * questions.
3396ae214e7d 8140450: Implement JEP 259: Stack-Walking API
mchung
parents:
diff changeset
    24
 */
3396ae214e7d 8140450: Implement JEP 259: Stack-Walking API
mchung
parents:
diff changeset
    25
3396ae214e7d 8140450: Implement JEP 259: Stack-Walking API
mchung
parents:
diff changeset
    26
package jdk.internal.misc;
3396ae214e7d 8140450: Implement JEP 259: Stack-Walking API
mchung
parents:
diff changeset
    27
40258
e6ba2e5c7a29 8163373: Rewrite GenerateJLIClassesPlugin to avoid reflective calls into java.lang.invoke
redestad
parents: 37819
diff changeset
    28
import java.lang.invoke.MethodType;
e6ba2e5c7a29 8163373: Rewrite GenerateJLIClassesPlugin to avoid reflective calls into java.lang.invoke
redestad
parents: 37819
diff changeset
    29
import java.util.Map;
e6ba2e5c7a29 8163373: Rewrite GenerateJLIClassesPlugin to avoid reflective calls into java.lang.invoke
redestad
parents: 37819
diff changeset
    30
34362
3396ae214e7d 8140450: Implement JEP 259: Stack-Walking API
mchung
parents:
diff changeset
    31
public interface JavaLangInvokeAccess {
3396ae214e7d 8140450: Implement JEP 259: Stack-Walking API
mchung
parents:
diff changeset
    32
    /**
40258
e6ba2e5c7a29 8163373: Rewrite GenerateJLIClassesPlugin to avoid reflective calls into java.lang.invoke
redestad
parents: 37819
diff changeset
    33
     * Create a new MemberName instance. Used by {@see StackFrameInfo}.
34362
3396ae214e7d 8140450: Implement JEP 259: Stack-Walking API
mchung
parents:
diff changeset
    34
     */
3396ae214e7d 8140450: Implement JEP 259: Stack-Walking API
mchung
parents:
diff changeset
    35
    Object newMemberName();
37526
dc4669f222ab 8153123: Streamline StackWalker code
bchristi
parents: 34362
diff changeset
    36
dc4669f222ab 8153123: Streamline StackWalker code
bchristi
parents: 34362
diff changeset
    37
    /**
40258
e6ba2e5c7a29 8163373: Rewrite GenerateJLIClassesPlugin to avoid reflective calls into java.lang.invoke
redestad
parents: 37819
diff changeset
    38
     * Returns the name for the given MemberName. Used by {@see StackFrameInfo}.
37526
dc4669f222ab 8153123: Streamline StackWalker code
bchristi
parents: 34362
diff changeset
    39
     */
dc4669f222ab 8153123: Streamline StackWalker code
bchristi
parents: 34362
diff changeset
    40
    String getName(Object mname);
37819
8a2559d6fe5b 8153912: Reconsider StackFrame::getFileName and StackFrame::getLineNumber
mchung
parents: 37526
diff changeset
    41
8a2559d6fe5b 8153912: Reconsider StackFrame::getFileName and StackFrame::getLineNumber
mchung
parents: 37526
diff changeset
    42
    /**
47294
7d67bb6b0599 8186050: StackFrame should provide the method signature
mchung
parents: 47216
diff changeset
    43
     * Returns the {@code MethodType} for the given MemberName.
7d67bb6b0599 8186050: StackFrame should provide the method signature
mchung
parents: 47216
diff changeset
    44
     * Used by {@see StackFrameInfo}.
7d67bb6b0599 8186050: StackFrame should provide the method signature
mchung
parents: 47216
diff changeset
    45
     */
7d67bb6b0599 8186050: StackFrame should provide the method signature
mchung
parents: 47216
diff changeset
    46
    MethodType getMethodType(Object mname);
7d67bb6b0599 8186050: StackFrame should provide the method signature
mchung
parents: 47216
diff changeset
    47
7d67bb6b0599 8186050: StackFrame should provide the method signature
mchung
parents: 47216
diff changeset
    48
    /**
7d67bb6b0599 8186050: StackFrame should provide the method signature
mchung
parents: 47216
diff changeset
    49
     * Returns the descriptor for the given MemberName.
7d67bb6b0599 8186050: StackFrame should provide the method signature
mchung
parents: 47216
diff changeset
    50
     * Used by {@see StackFrameInfo}.
7d67bb6b0599 8186050: StackFrame should provide the method signature
mchung
parents: 47216
diff changeset
    51
     */
7d67bb6b0599 8186050: StackFrame should provide the method signature
mchung
parents: 47216
diff changeset
    52
    String getMethodDescriptor(Object mname);
7d67bb6b0599 8186050: StackFrame should provide the method signature
mchung
parents: 47216
diff changeset
    53
7d67bb6b0599 8186050: StackFrame should provide the method signature
mchung
parents: 47216
diff changeset
    54
    /**
40258
e6ba2e5c7a29 8163373: Rewrite GenerateJLIClassesPlugin to avoid reflective calls into java.lang.invoke
redestad
parents: 37819
diff changeset
    55
     * Returns {@code true} if the given MemberName is a native method. Used by
e6ba2e5c7a29 8163373: Rewrite GenerateJLIClassesPlugin to avoid reflective calls into java.lang.invoke
redestad
parents: 37819
diff changeset
    56
     * {@see StackFrameInfo}.
37819
8a2559d6fe5b 8153912: Reconsider StackFrame::getFileName and StackFrame::getLineNumber
mchung
parents: 37526
diff changeset
    57
     */
8a2559d6fe5b 8153912: Reconsider StackFrame::getFileName and StackFrame::getLineNumber
mchung
parents: 37526
diff changeset
    58
    boolean isNative(Object mname);
40258
e6ba2e5c7a29 8163373: Rewrite GenerateJLIClassesPlugin to avoid reflective calls into java.lang.invoke
redestad
parents: 37819
diff changeset
    59
e6ba2e5c7a29 8163373: Rewrite GenerateJLIClassesPlugin to avoid reflective calls into java.lang.invoke
redestad
parents: 37819
diff changeset
    60
    /**
40543
629f1f599595 8164569: Generate non-customized invoker forms at link time
redestad
parents: 40419
diff changeset
    61
     * Returns a {@code byte[]} representation of a class implementing
40258
e6ba2e5c7a29 8163373: Rewrite GenerateJLIClassesPlugin to avoid reflective calls into java.lang.invoke
redestad
parents: 37819
diff changeset
    62
     * DirectMethodHandle of each pairwise combination of {@code MethodType} and
e6ba2e5c7a29 8163373: Rewrite GenerateJLIClassesPlugin to avoid reflective calls into java.lang.invoke
redestad
parents: 37819
diff changeset
    63
     * an {@code int} representing method type.  Used by
e6ba2e5c7a29 8163373: Rewrite GenerateJLIClassesPlugin to avoid reflective calls into java.lang.invoke
redestad
parents: 37819
diff changeset
    64
     * GenerateJLIClassesPlugin to generate such a class during the jlink phase.
e6ba2e5c7a29 8163373: Rewrite GenerateJLIClassesPlugin to avoid reflective calls into java.lang.invoke
redestad
parents: 37819
diff changeset
    65
     */
40408
cf7e826d4d63 8164044: Generate corresponding simple DelegatingMethodHandles when generating a DirectMethodHandle at link time
redestad
parents: 40258
diff changeset
    66
    byte[] generateDirectMethodHandleHolderClassBytes(String className,
cf7e826d4d63 8164044: Generate corresponding simple DelegatingMethodHandles when generating a DirectMethodHandle at link time
redestad
parents: 40258
diff changeset
    67
            MethodType[] methodTypes, int[] types);
cf7e826d4d63 8164044: Generate corresponding simple DelegatingMethodHandles when generating a DirectMethodHandle at link time
redestad
parents: 40258
diff changeset
    68
cf7e826d4d63 8164044: Generate corresponding simple DelegatingMethodHandles when generating a DirectMethodHandle at link time
redestad
parents: 40258
diff changeset
    69
    /**
40543
629f1f599595 8164569: Generate non-customized invoker forms at link time
redestad
parents: 40419
diff changeset
    70
     * Returns a {@code byte[]} representation of a class implementing
40408
cf7e826d4d63 8164044: Generate corresponding simple DelegatingMethodHandles when generating a DirectMethodHandle at link time
redestad
parents: 40258
diff changeset
    71
     * DelegatingMethodHandles of each {@code MethodType} kind in the
cf7e826d4d63 8164044: Generate corresponding simple DelegatingMethodHandles when generating a DirectMethodHandle at link time
redestad
parents: 40258
diff changeset
    72
     * {@code methodTypes} argument.  Used by GenerateJLIClassesPlugin to
cf7e826d4d63 8164044: Generate corresponding simple DelegatingMethodHandles when generating a DirectMethodHandle at link time
redestad
parents: 40258
diff changeset
    73
     * generate such a class during the jlink phase.
cf7e826d4d63 8164044: Generate corresponding simple DelegatingMethodHandles when generating a DirectMethodHandle at link time
redestad
parents: 40258
diff changeset
    74
     */
cf7e826d4d63 8164044: Generate corresponding simple DelegatingMethodHandles when generating a DirectMethodHandle at link time
redestad
parents: 40258
diff changeset
    75
    byte[] generateDelegatingMethodHandleHolderClassBytes(String className,
cf7e826d4d63 8164044: Generate corresponding simple DelegatingMethodHandles when generating a DirectMethodHandle at link time
redestad
parents: 40258
diff changeset
    76
            MethodType[] methodTypes);
40258
e6ba2e5c7a29 8163373: Rewrite GenerateJLIClassesPlugin to avoid reflective calls into java.lang.invoke
redestad
parents: 37819
diff changeset
    77
e6ba2e5c7a29 8163373: Rewrite GenerateJLIClassesPlugin to avoid reflective calls into java.lang.invoke
redestad
parents: 37819
diff changeset
    78
    /**
40543
629f1f599595 8164569: Generate non-customized invoker forms at link time
redestad
parents: 40419
diff changeset
    79
     * Returns a {@code byte[]} representation of {@code BoundMethodHandle}
40258
e6ba2e5c7a29 8163373: Rewrite GenerateJLIClassesPlugin to avoid reflective calls into java.lang.invoke
redestad
parents: 37819
diff changeset
    80
     * species class implementing the signature defined by {@code types}. Used
e6ba2e5c7a29 8163373: Rewrite GenerateJLIClassesPlugin to avoid reflective calls into java.lang.invoke
redestad
parents: 37819
diff changeset
    81
     * by GenerateBMHClassesPlugin to enable generation of such classes during
e6ba2e5c7a29 8163373: Rewrite GenerateJLIClassesPlugin to avoid reflective calls into java.lang.invoke
redestad
parents: 37819
diff changeset
    82
     * the jlink phase. Should do some added validation since this string may be
e6ba2e5c7a29 8163373: Rewrite GenerateJLIClassesPlugin to avoid reflective calls into java.lang.invoke
redestad
parents: 37819
diff changeset
    83
     * user provided.
e6ba2e5c7a29 8163373: Rewrite GenerateJLIClassesPlugin to avoid reflective calls into java.lang.invoke
redestad
parents: 37819
diff changeset
    84
     */
e6ba2e5c7a29 8163373: Rewrite GenerateJLIClassesPlugin to avoid reflective calls into java.lang.invoke
redestad
parents: 37819
diff changeset
    85
    Map.Entry<String, byte[]> generateConcreteBMHClassBytes(
e6ba2e5c7a29 8163373: Rewrite GenerateJLIClassesPlugin to avoid reflective calls into java.lang.invoke
redestad
parents: 37819
diff changeset
    86
            final String types);
40419
20e2e4b25a40 8164451: Generate all zero and identity forms at link time
redestad
parents: 40408
diff changeset
    87
20e2e4b25a40 8164451: Generate all zero and identity forms at link time
redestad
parents: 40408
diff changeset
    88
    /**
40543
629f1f599595 8164569: Generate non-customized invoker forms at link time
redestad
parents: 40419
diff changeset
    89
     * Returns a {@code byte[]} representation of a class implementing
40419
20e2e4b25a40 8164451: Generate all zero and identity forms at link time
redestad
parents: 40408
diff changeset
    90
     * the zero and identity forms of all {@code LambdaForm.BasicType}s.
20e2e4b25a40 8164451: Generate all zero and identity forms at link time
redestad
parents: 40408
diff changeset
    91
     */
20e2e4b25a40 8164451: Generate all zero and identity forms at link time
redestad
parents: 40408
diff changeset
    92
    byte[] generateBasicFormsClassBytes(final String className);
40543
629f1f599595 8164569: Generate non-customized invoker forms at link time
redestad
parents: 40419
diff changeset
    93
629f1f599595 8164569: Generate non-customized invoker forms at link time
redestad
parents: 40419
diff changeset
    94
    /**
629f1f599595 8164569: Generate non-customized invoker forms at link time
redestad
parents: 40419
diff changeset
    95
     * Returns a {@code byte[]} representation of a class implementing
629f1f599595 8164569: Generate non-customized invoker forms at link time
redestad
parents: 40419
diff changeset
    96
     * the invoker forms for the set of supplied {@code methodTypes}.
629f1f599595 8164569: Generate non-customized invoker forms at link time
redestad
parents: 40419
diff changeset
    97
     */
629f1f599595 8164569: Generate non-customized invoker forms at link time
redestad
parents: 40419
diff changeset
    98
    byte[] generateInvokersHolderClassBytes(String className,
629f1f599595 8164569: Generate non-customized invoker forms at link time
redestad
parents: 40419
diff changeset
    99
            MethodType[] methodTypes);
34362
3396ae214e7d 8140450: Implement JEP 259: Stack-Walking API
mchung
parents:
diff changeset
   100
}