8254129: IR Test Framework to support regex-based matching on the IR in JTreg compiler tests

Co-authored-by: Christian Hagedorn <chagedorn@openjdk.org>
Co-authored-by: Tobias Hartmann <thartmann@openjdk.org>
Reviewed-by: iignatyev

Author: chhagedorn

test/hotspot/jtreg/compiler/lib/ir_framework/AbstractInfo.java

@@ -0,0 +1,121 @@
+/*
+ * Copyright (c) 2021, 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 compiler.lib.ir_framework;
+
+import compiler.lib.ir_framework.shared.TestRunException;
+import compiler.lib.ir_framework.test.TestVM;
+import jdk.test.lib.Utils;
+
+import java.lang.reflect.Method;
+import java.util.Arrays;
+import java.util.Random;
+import java.util.stream.Collectors;
+
+/**
+ * Base info class which provides some useful utility methods and information about a test.
+ * <p>
+ * <b>Base tests</b> and <b>checked tests</b> use {@link TestInfo} while <b>custom run tests</b> use {@link RunInfo}.
+ *
+ * @see Test
+ * @see Check
+ * @see Run
+ */
+abstract public class AbstractInfo {
+    private static final Random RANDOM = Utils.getRandomInstance();
+
+    protected final Class<?> testClass;
+    private boolean onWarmUp = true;
+
+    AbstractInfo(Class<?> testClass) {
+        this.testClass = testClass;
+    }
+
+    /**
+     * Get the initialized {@link Random} object.
+     *
+     * @return the random object.
+     */
+    public Random getRandom() {
+        return RANDOM;
+    }
+
+    /**
+     * Returns a boolean indicating if the framework is currently warming up the associated test.
+     *
+     * @return the warm-up status of the associated test.
+     *
+     * @see Warmup
+     */
+    public boolean isWarmUp() {
+        return onWarmUp;
+    }
+
+    /**
+     * Get the method object of the method {@code name} of class {@code c} with arguments {@code args}.
+     *
+     * @param c    the class containing the method.
+     * @param name the name of the method.
+     * @param args the arguments of the method, leave empty if no arguments.
+     *
+     * @return the method object of the requested method.
+     */
+    public Method getMethod(Class<?> c, String name, Class<?>... args) {
+        try {
+            return c.getMethod(name, args);
+        } catch (NoSuchMethodException e) {
+            String parameters = args == null || args.length == 0 ? "" :
+                    " with arguments [" + Arrays.stream(args).map(Class::getName).collect(Collectors.joining(",")) + "]";
+            throw new TestRunException("Could not find method " + name + " in " + c + parameters, e);
+        }
+    }
+
+    /**
+     * Get the method object of the method {@code name} of the test class with arguments {@code args}.
+     *
+     * @param name the name of the method in the test class.
+     * @param args the arguments of the method, leave empty if no arguments.
+     *
+     * @return the method object of the requested method in the test class.
+     */
+    public Method getTestClassMethod(String name, Class<?>... args) {
+        return getMethod(testClass, name, args);
+    }
+
+    /**
+     * Returns a boolean indicating if the test VM runs with flags that allow C2 compilations.
+     *
+     * @return {@code true} if C2 compilations are allowed;
+     *         {@code false} otherwise (run with {@code -XX:TieredStopAtLevel={1,2,3}, -XX:-UseCompiler}).
+     */
+    public boolean isC2CompilationEnabled() {
+        return TestVM.USE_COMPILER && !TestVM.TEST_C1;
+    }
+
+    /**
+     * Called by {@link TestFramework} when the warm-up is finished. Should not be called by user code.
+     */
+    public void setWarmUpFinished() {
+        onWarmUp = false;
+    }
+}

test/hotspot/jtreg/compiler/lib/ir_framework/Argument.java

@@ -0,0 +1,81 @@
+/*
+ * Copyright (c) 2021, 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 compiler.lib.ir_framework;
+
+/**
+ * Well-defined argument values that can be used in the {@link Arguments} annotation at a {@link Test} method for a
+ * <b>base test</b> or a <b>checked test</b>.
+ *
+ * @see Arguments
+ * @see Test
+ * @see Check
+ */
+public enum Argument {
+    /**
+     * Provides the default value for any kind of primitive type and object type if the class provides a default constructor.
+     */
+    DEFAULT,
+    /**
+     * Provides the number 42 for any primitive number type.
+     */
+    NUMBER_42,
+    /**
+     * Provides the number -42 for any primitive number type.
+     */
+    NUMBER_MINUS_42,
+    /**
+     * Provides the minimum value of the specified primitive number type.
+     */
+    MIN,
+    /**
+     * Provides the maximum value of the specified primitive number type.
+     */
+    MAX,
+    /**
+     * Provides the boolean value false.
+     */
+    FALSE,
+    /**
+     * Provides the boolean value true.
+     */
+    TRUE,
+    /**
+     * Provides a different boolean value on each test invocation, starting with false.
+     */
+    BOOLEAN_TOGGLE_FIRST_FALSE,
+    /**
+     * Provides a different boolean value on each test invocation, starting with true.
+     */
+    BOOLEAN_TOGGLE_FIRST_TRUE,
+    /**
+     * Provides a random primitive value on the first test invocation and reuses the same value for all invocation of the test.
+     * Float and double values are restricted to the range [-10000,10000].
+     */
+    RANDOM_ONCE,
+    /**
+     * Provides a different random primitive value on each test invocation.
+     * Float and double values are restricted to the range [-10000,10000].
+     */
+    RANDOM_EACH,
+}