[GR-60112] Pull the verifier from espresso to the shared project.

PullRequest: graal/19692

Author: rakachan

espresso/src/com.oracle.truffle.espresso.shared/src/com/oracle/truffle/espresso/shared/meta/ClassLoadingException.java

@@ -0,0 +1,57 @@
+/*
+ * Copyright (c) 2024, 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.
+ *
+ * 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 com.oracle.truffle.espresso.shared.meta;
+
+import java.io.Serial;
+
+/**
+ * Indicates that an exception was thrown during class loading.
+ */
+public class ClassLoadingException extends Exception {
+    @Serial private static final long serialVersionUID = -6396583822642157602L;
+
+    private final boolean isClassNotFoundException;
+    private final RuntimeException exception;
+
+    public ClassLoadingException(RuntimeException e, boolean isClassNotFoundException) {
+        this.isClassNotFoundException = isClassNotFoundException;
+        this.exception = e;
+    }
+
+    /**
+     * Whether {@link #getException()} represents this runtime's equivalent of
+     * {@link ClassNotFoundException}.
+     */
+    public boolean isClassNotFoundException() {
+        return isClassNotFoundException;
+    }
+
+    /**
+     * The original exception thrown.
+     */
+    public RuntimeException getException() {
+        return exception;
+
+    }
+}

espresso/src/com.oracle.truffle.espresso.shared/src/com/oracle/truffle/espresso/shared/meta/KnownTypes.java

@@ -0,0 +1,60 @@
+/*
+ * Copyright (c) 2024, 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.
+ *
+ * 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 com.oracle.truffle.espresso.shared.meta;
+
+/**
+ * Provides access to certain known classes.
+ */
+public interface KnownTypes<C extends TypeAccess<C, M, F>, M extends MethodAccess<C, M, F>, F extends FieldAccess<C, M, F>> {
+    // Checkstyle: stop method name check
+    /**
+     * @return The runtime's representation of {@link java.lang.Object}
+     */
+    C java_lang_Object();
+
+    /**
+     * @return The runtime's representation of {@link java.lang.Throwable}
+     */
+    C java_lang_Throwable();
+
+    /**
+     * @return The runtime's representation of {@link java.lang.Class}
+     */
+    C java_lang_Class();
+
+    /**
+     * @return The runtime's representation of {@link java.lang.String}
+     */
+    C java_lang_String();
+
+    /**
+     * @return The runtime's representation of {@link java.lang.invoke.MethodType}
+     */
+    C java_lang_invoke_MethodType();
+
+    /**
+     * @return The runtime's representation of {@link java.lang.invoke.MethodHandle}
+     */
+    C java_lang_invoke_MethodHandle();
+}

espresso/src/com.oracle.truffle.espresso.shared/src/com/oracle/truffle/espresso/shared/meta/MethodAccess.java

@@ -23,8 +23,11 @@
 
 package com.oracle.truffle.espresso.shared.meta;
 
+import com.oracle.truffle.espresso.classfile.ExceptionHandler;
+import com.oracle.truffle.espresso.classfile.attributes.CodeAttribute;
 import com.oracle.truffle.espresso.classfile.descriptors.Symbol;
 import com.oracle.truffle.espresso.classfile.descriptors.Symbol.Signature;
+import com.oracle.truffle.espresso.classfile.descriptors.Symbol.Type;
 
 /**
  * Represents a {@link java.lang.reflect.Method}, and provides access to various runtime metadata.
@@ -39,6 +42,20 @@ public interface MethodAccess<C extends TypeAccess<C, M, F>, M extends MethodAcc
      */
     Symbol<Signature> getSymbolicSignature();
 
+    /**
+     * Obtains the parsed signature for this method.
+     * <p>
+     * A default implementation is provided, but it is encouraged to override this method if the
+     * representation of methods allows for a simpler computation (for example, if the method caches
+     * its parsed signature).
+     *
+     * @param symbolPool The symbol pool from which this method draws its symbols.
+     * @return The parsed signature of this method.
+     */
+    default Symbol<Type>[] getParsedSymbolicSignature(SymbolPool symbolPool) {
+        return symbolPool.getSignatures().parsed(getSymbolicSignature());
+    }
+
     /**
      * @return {@code true} if this method represents an instance initialization method (its
      *         {@link #getSymbolicName() name} is {@code "<init>"}), {@code false} otherwise.
@@ -57,4 +74,14 @@ public interface MethodAccess<C extends TypeAccess<C, M, F>, M extends MethodAcc
      * which should skip loading constraints are the polymorphic signature methods.
      */
     boolean shouldSkipLoadingConstraints();
+
+    /**
+     * The {@link CodeAttribute} associated with this method.
+     */
+    CodeAttribute getCodeAttribute();
+
+    /**
+     * The {@link ExceptionHandler exception handlers} associated with this method.
+     */
+    ExceptionHandler[] getExceptionHandlers();
 }

espresso/src/com.oracle.truffle.espresso.shared/src/com/oracle/truffle/espresso/shared/meta/RuntimeAccess.java

@@ -24,6 +24,8 @@
 package com.oracle.truffle.espresso.shared.meta;
 
 import com.oracle.truffle.espresso.classfile.JavaVersion;
+import com.oracle.truffle.espresso.classfile.descriptors.Symbol;
+import com.oracle.truffle.espresso.classfile.descriptors.Symbol.Type;
 
 /**
  * Provides access to some VM-specific capabilities, such as throwing exceptions, or obtaining the
@@ -48,6 +50,31 @@ public interface RuntimeAccess<C extends TypeAccess<C, M, F>, M extends MethodAc
      */
     RuntimeException throwError(ErrorType error, String messageFormat, Object... args);
 
+    /**
+     * Performs class loading on behalf of the given accessing class.
+     * <p>
+     * Its defining class loader is the one to be used for loading.
+     * <p>
+     * Any exception that arises during class loading must be wrapped into a
+     * {@link ClassLoadingException}, correctly specifying if the original exception is this
+     * runtime's equivalent of {@link ClassNotFoundException}.
+     *
+     * @return The loaded class.
+     *
+     * @throws ClassLoadingException If any exception is thrown during loading
+     */
+    C lookupOrLoadType(Symbol<Type> type, C accessingClass) throws ClassLoadingException;
+
+    /**
+     * Obtains and returns an object containing certain VM-known classes.
+     */
+    KnownTypes<C, M, F> getKnownTypes();
+
+    /**
+     * Obtains and returns an object containing the various symbol pools for this runtime.
+     */
+    SymbolPool getSymbolPool();
+
     /**
      * Signals that an unexpected state has been reached and that the current operation must be
      * aborted.

espresso/src/com.oracle.truffle.espresso.shared/src/com/oracle/truffle/espresso/shared/meta/SymbolPool.java

@@ -0,0 +1,50 @@
+/*
+ * Copyright (c) 2024, 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.
+ *
+ * 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 com.oracle.truffle.espresso.shared.meta;
+
+import com.oracle.truffle.espresso.classfile.descriptors.Names;
+import com.oracle.truffle.espresso.classfile.descriptors.Signatures;
+import com.oracle.truffle.espresso.classfile.descriptors.Symbol.Signature;
+import com.oracle.truffle.espresso.classfile.descriptors.Symbol.Type;
+import com.oracle.truffle.espresso.classfile.descriptors.Types;
+
+/**
+ * Provides access to various Symbol pools.
+ */
+public interface SymbolPool {
+    /**
+     * @return The {@link Names} pool.
+     */
+    Names getNames();
+
+    /**
+     * @return The {@link Type} pool.
+     */
+    Types getTypes();
+
+    /**
+     * @return The {@link Signature} pool.
+     */
+    Signatures getSignatures();
+}

espresso/src/com.oracle.truffle.espresso.shared/src/com/oracle/truffle/espresso/shared/meta/TypeAccess.java

@@ -23,6 +23,7 @@
 
 package com.oracle.truffle.espresso.shared.meta;
 
+import com.oracle.truffle.espresso.classfile.ConstantPool;
 import com.oracle.truffle.espresso.classfile.descriptors.Symbol;
 import com.oracle.truffle.espresso.classfile.descriptors.Symbol.Name;
 import com.oracle.truffle.espresso.classfile.descriptors.Symbol.Signature;
@@ -42,11 +43,44 @@ public interface TypeAccess<C extends TypeAccess<C, M, F>, M extends MethodAcces
      */
     String getJavaName();
 
+    /**
+     * Returns the symbolic reference of this class.
+     */
+    Symbol<Type> getSymbolicType();
+
+    /**
+     * Returns whether this class and the other class share the same defining class loader.
+     */
+    boolean hasSameDefiningClassLoader(C other);
+
+    /**
+     * Finds the least common ancestor between this class and the other class.
+     */
+    C findLeastCommonAncestor(C other);
+
     /**
      * Returns the superclass of this class, or {@code null} if this class is {@link Object}.
      */
     C getSuperClass();
 
+    /**
+     * Returns the host class of this VM-anonymous class, or {@code null} if this class is not a
+     * VM-anonymous class.
+     *
+     * @apiNote A VM-anonymous class is a class defined through
+     *          {@code Unsafe.defineAnonymousClass()} and is unrelated to the
+     *          {@link Class#isAnonymousClass() Java concept of anonymous classes}.
+     * @implNote The concept of VM-anonymous classes was removed from Java 17 onwards, and this
+     *           method should therefore always return {@code null} for implementations of Java 17
+     *           or later.
+     */
+    C getHostType();
+
+    /**
+     * Returns the name of the runtime package in which this class is defined.
+     */
+    Symbol<Name> getSymbolicRuntimePackage();
+
     /**
      * Performs field lookup on this class for the given field name and field type, according to
      * JVMS-5.4.3.2.
@@ -145,4 +179,25 @@ public interface TypeAccess<C extends TypeAccess<C, M, F>, M extends MethodAcces
     default boolean isJavaLangObject() {
         return getSuperClass() == null;
     }
+
+    /**
+     * Whether this class extends the "magic accessor".
+     */
+    boolean isMagicAccessor();
+
+    /**
+     * The {@link ConstantPool} associated with this class.
+     */
+    ConstantPool getConstantPool();
+
+    /**
+     * Resolves a class in the runtime constant pool of this type, then returns it. Further calls to
+     * this method with the same cpi should not trigger class loading.
+     *
+     * @param cpi The constant pool index in which to find the class constant
+     * @throws IllegalArgumentException If there is no
+     *             {@link com.oracle.truffle.espresso.classfile.constantpool.ClassConstant} in the
+     *             constant pool at index {@code cpi}.
+     */
+    C resolveClassConstantInPool(int cpi);
 }