src/java.base/share/classes/java/lang/invoke/ConstantBootstraps.java
changeset 48827 8772acd913e5
child 48834 19ef3f64bc10
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/java.base/share/classes/java/lang/invoke/ConstantBootstraps.java	Wed Jan 31 11:20:36 2018 -0800
@@ -0,0 +1,343 @@
+/*
+ * Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+package java.lang.invoke;
+
+import sun.invoke.util.Wrapper;
+
+import static java.lang.invoke.MethodHandleNatives.mapLookupExceptionToError;
+import static java.util.Objects.requireNonNull;
+
+/**
+ * Bootstrap methods for dynamically-computed constants.
+ *
+ * <p>The bootstrap methods in this class will throw a
+ * {@code NullPointerException} for any reference argument that is {@code null},
+ * unless the argument is specified to be unused or specified to accept a
+ * {@code null} value.
+ *
+ * @since 10
+ */
+public final class ConstantBootstraps {
+    // implements the upcall from the JVM, MethodHandleNatives.linkDynamicConstant:
+    /*non-public*/
+    static Object makeConstant(MethodHandle bootstrapMethod,
+                               // Callee information:
+                               String name, Class<?> type,
+                               // Extra arguments for BSM, if any:
+                               Object info,
+                               // Caller information:
+                               Class<?> callerClass) {
+        // BSMI.invoke handles all type checking and exception translation.
+        // If type is not a reference type, the JVM is expecting a boxed
+        // version, and will manage unboxing on the other side.
+        return BootstrapMethodInvoker.invoke(
+                type, bootstrapMethod, name, type, info, callerClass);
+    }
+
+    /**
+     * Returns a {@code null} object reference for the reference type specified
+     * by {@code type}.
+     *
+     * @param lookup unused
+     * @param name unused
+     * @param type a reference type
+     * @return a {@code null} value
+     * @throws IllegalArgumentException if {@code type} is not a reference type
+     */
+    public static Object nullConstant(MethodHandles.Lookup lookup, String name, Class<?> type) {
+        if (requireNonNull(type).isPrimitive()) {
+            throw new IllegalArgumentException(String.format("not reference: %s", type));
+        }
+
+        return null;
+    }
+
+    /**
+     * Returns a {@link Class} mirror for the primitive type whose type
+     * descriptor is specified by {@code name}.
+     *
+     * @param lookup unused
+     * @param name the descriptor (JVMS 4.3) of the desired primitive type
+     * @param type the required result type (must be {@code Class.class})
+     * @return the {@link Class} mirror
+     * @throws IllegalArgumentException if the name is not a descriptor for a
+     * primitive type or the type is not {@code Class.class}
+     */
+    public static Class<?> primitiveClass(MethodHandles.Lookup lookup, String name, Class<?> type) {
+        requireNonNull(name);
+        requireNonNull(type);
+        if (type != Class.class) {
+            throw new IllegalArgumentException();
+        }
+        if (name.length() == 0 || name.length() > 1) {
+            throw new IllegalArgumentException(String.format("not primitive: %s", name));
+        }
+
+        return Wrapper.forPrimitiveType(name.charAt(0)).primitiveType();
+    }
+
+    /**
+     * Returns an {@code enum} constant of the type specified by {@code type}
+     * with the name specified by {@code name}.
+     *
+     * @param lookup the lookup context describing the class performing the
+     * operation (normally stacked by the JVM)
+     * @param type the {@code Class} object describing the enum type for which
+     * a constant is to be returned
+     * @param name the name of the constant to return, which must exactly match
+     * an enum constant in the specified type.
+     * @param <E> The enum type for which a constant value is to be returned
+     * @return the enum constant of the specified enum type with the
+     * specified name
+     * @throws IllegalAccessError if the declaring class or the field is not
+     * accessible to the class performing the operation
+     * @throws IllegalArgumentException if the specified enum type has
+     * no constant with the specified name, or the specified
+     * class object does not represent an enum type
+     * @see Enum#valueOf(Class, String)
+     */
+    public static <E extends Enum<E>> E enumConstant(MethodHandles.Lookup lookup, String name, Class<E> type) {
+        requireNonNull(lookup);
+        requireNonNull(name);
+        requireNonNull(type);
+        validateClassAccess(lookup, type);
+
+        return Enum.valueOf(type, name);
+    }
+
+    /**
+     * Returns the value of a static final field.
+     *
+     * @param lookup the lookup context describing the class performing the
+     * operation (normally stacked by the JVM)
+     * @param name the name of the field
+     * @param type the type of the field
+     * @param declaringClass the class in which the field is declared
+     * @return the value of the field
+     * @throws IllegalAccessError if the declaring class or the field is not
+     * accessible to the class performing the operation
+     * @throws NoSuchFieldError if the specified field does not exist
+     * @throws IncompatibleClassChangeError if the specified field is not
+     * {@code final}
+     */
+    public static Object getStaticFinal(MethodHandles.Lookup lookup, String name, Class<?> type,
+                                        Class<?> declaringClass) {
+        requireNonNull(lookup);
+        requireNonNull(name);
+        requireNonNull(type);
+        requireNonNull(declaringClass);
+
+        MethodHandle mh;
+        try {
+            mh = lookup.findStaticGetter(declaringClass, name, type);
+            MemberName member = mh.internalMemberName();
+            if (!member.isFinal()) {
+                throw new IncompatibleClassChangeError("not a final field: " + name);
+            }
+        }
+        catch (ReflectiveOperationException ex) {
+            throw mapLookupExceptionToError(ex);
+        }
+
+        // Since mh is a handle to a static field only instances of
+        // VirtualMachineError are anticipated to be thrown, such as a
+        // StackOverflowError or an InternalError from the j.l.invoke code
+        try {
+            return mh.invoke();
+        }
+        catch (RuntimeException | Error e) {
+            throw e;
+        }
+        catch (Throwable e) {
+            throw new LinkageError("Unexpected throwable", e);
+        }
+    }
+
+    /**
+     * Returns the value of a static final field declared in the class which
+     * is the same as the field's type (or, for primitive-valued fields,
+     * declared in the wrapper class.)  This is a simplified form of
+     * {@link #getStaticFinal(MethodHandles.Lookup, String, Class, Class)}
+     * for the case where a class declares distinguished constant instances of
+     * itself.
+     *
+     * @param lookup the lookup context describing the class performing the
+     * operation (normally stacked by the JVM)
+     * @param name the name of the field
+     * @param type the type of the field
+     * @return the value of the field
+     * @throws IllegalAccessError if the declaring class or the field is not
+     * accessible to the class performing the operation
+     * @throws NoSuchFieldError if the specified field does not exist
+     * @throws IncompatibleClassChangeError if the specified field is not
+     * {@code final}
+     * @see #getStaticFinal(MethodHandles.Lookup, String, Class, Class)
+     */
+    public static Object getStaticFinal(MethodHandles.Lookup lookup, String name, Class<?> type) {
+        requireNonNull(type);
+
+        Class<?> declaring = type.isPrimitive()
+                             ? Wrapper.forPrimitiveType(type).wrapperType()
+                             : type;
+        return getStaticFinal(lookup, name, type, declaring);
+    }
+
+
+    /**
+     * Returns the result of invoking a method handle with the provided
+     * arguments.
+     *
+     * @param lookup the lookup context describing the class performing the
+     * operation (normally stacked by the JVM)
+     * @param name unused
+     * @param type the type of the value to be returned, which must be
+     * compatible with the return type of the method handle
+     * @param handle the method handle to be invoked
+     * @param args the arguments to pass to the method handle, as if with
+     * {@link MethodHandle#invokeWithArguments}.  Each argument may be
+     * {@code null}.
+     * @return the result of invoking the method handle
+     * @throws WrongMethodTypeException if the handle's return type cannot be
+     * adjusted to the desired type
+     * @throws ClassCastException if an argument cannot be converted by
+     * reference casting
+     * @throws Throwable anything thrown by the method handle invocation
+     */
+    public static Object invoke(MethodHandles.Lookup lookup, String name, Class<?> type,
+                                MethodHandle handle, Object... args) throws Throwable {
+        requireNonNull(type);
+        requireNonNull(handle);
+        requireNonNull(args);
+
+        if (type != handle.type().returnType()) {
+            handle = handle.asType(handle.type().changeReturnType(type));
+        }
+
+        return handle.invokeWithArguments(args);
+    }
+
+    /**
+     * Finds a {@link VarHandle} for an instance field.
+     *
+     * @param lookup the lookup context describing the class performing the
+     * operation (normally stacked by the JVM)
+     * @param name the name of the field
+     * @param type the required result type (must be {@code Class<VarHandle>})
+     * @param declaringClass the class in which the field is declared
+     * @param fieldType the type of the field
+     * @return the {@link VarHandle}
+     * @throws IllegalAccessError if the declaring class or the field is not
+     * accessible to the class performing the operation
+     * @throws NoSuchFieldError if the specified field does not exist
+     * @throws IllegalArgumentException if the type is not {@code VarHandle}
+     */
+    public static VarHandle fieldVarHandle(MethodHandles.Lookup lookup, String name, Class<VarHandle> type,
+                                           Class<?> declaringClass, Class<?> fieldType) {
+        requireNonNull(lookup);
+        requireNonNull(name);
+        requireNonNull(type);
+        requireNonNull(declaringClass);
+        requireNonNull(fieldType);
+        if (type != VarHandle.class) {
+            throw new IllegalArgumentException();
+        }
+
+        try {
+            return lookup.findVarHandle(declaringClass, name, fieldType);
+        }
+        catch (ReflectiveOperationException e) {
+            throw mapLookupExceptionToError(e);
+        }
+    }
+
+    /**
+     * Finds a {@link VarHandle} for a static field.
+     *
+     * @param lookup the lookup context describing the class performing the
+     * operation (normally stacked by the JVM)
+     * @param name the name of the field
+     * @param type the required result type (must be {@code Class<VarHandle>})
+     * @param declaringClass the class in which the field is declared
+     * @param fieldType the type of the field
+     * @return the {@link VarHandle}
+     * @throws IllegalAccessError if the declaring class or the field is not
+     * accessible to the class performing the operation
+     * @throws NoSuchFieldError if the specified field does not exist
+     * @throws IllegalArgumentException if the type is not {@code VarHandle}
+     */
+    public static VarHandle staticFieldVarHandle(MethodHandles.Lookup lookup, String name, Class<VarHandle> type,
+                                                 Class<?> declaringClass, Class<?> fieldType) {
+        requireNonNull(lookup);
+        requireNonNull(name);
+        requireNonNull(type);
+        requireNonNull(declaringClass);
+        requireNonNull(fieldType);
+        if (type != VarHandle.class) {
+            throw new IllegalArgumentException();
+        }
+
+        try {
+            return lookup.findStaticVarHandle(declaringClass, name, fieldType);
+        }
+        catch (ReflectiveOperationException e) {
+            throw mapLookupExceptionToError(e);
+        }
+    }
+
+    /**
+     * Finds a {@link VarHandle} for an array type.
+     *
+     * @param lookup the lookup context describing the class performing the
+     * operation (normally stacked by the JVM)
+     * @param name unused
+     * @param type the required result type (must be {@code Class<VarHandle>})
+     * @param arrayClass the type of the array
+     * @return the {@link VarHandle}
+     * @throws IllegalAccessError if the component type of the array is not
+     * accessible to the class performing the operation
+     * @throws IllegalArgumentException if the type is not {@code VarHandle}
+     */
+    public static VarHandle arrayVarHandle(MethodHandles.Lookup lookup, String name, Class<VarHandle> type,
+                                           Class<?> arrayClass) {
+        requireNonNull(lookup);
+        requireNonNull(type);
+        requireNonNull(arrayClass);
+        if (type != VarHandle.class) {
+            throw new IllegalArgumentException();
+        }
+
+        return MethodHandles.arrayElementVarHandle(validateClassAccess(lookup, arrayClass));
+    }
+
+    private static <T> Class<T> validateClassAccess(MethodHandles.Lookup lookup, Class<T> type) {
+        try {
+            lookup.accessClass(type);
+            return type;
+        }
+        catch (ReflectiveOperationException ex) {
+            throw mapLookupExceptionToError(ex);
+        }
+    }
+}