Skip to content
Permalink
Browse files
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
  • Loading branch information
chhagedorn and TobiHartmann committed Jun 7, 2021
1 parent 270ec97 commit 3396b69fc91db4a9e29806562215f92179ba4757
Showing with 13,454 additions and 0 deletions.
  1. +121 −0 test/hotspot/jtreg/compiler/lib/ir_framework/AbstractInfo.java
  2. +81 −0 test/hotspot/jtreg/compiler/lib/ir_framework/Argument.java
  3. +43 −0 test/hotspot/jtreg/compiler/lib/ir_framework/Arguments.java
  4. +114 −0 test/hotspot/jtreg/compiler/lib/ir_framework/Check.java
  5. +43 −0 test/hotspot/jtreg/compiler/lib/ir_framework/CheckAt.java
  6. +171 −0 test/hotspot/jtreg/compiler/lib/ir_framework/CompLevel.java
  7. +63 −0 test/hotspot/jtreg/compiler/lib/ir_framework/Compiler.java
  8. +49 −0 test/hotspot/jtreg/compiler/lib/ir_framework/DontCompile.java
  9. +38 −0 test/hotspot/jtreg/compiler/lib/ir_framework/DontInline.java
  10. +45 −0 test/hotspot/jtreg/compiler/lib/ir_framework/ForceCompile.java
  11. +45 −0 test/hotspot/jtreg/compiler/lib/ir_framework/ForceCompileClassInitializer.java
  12. +37 −0 test/hotspot/jtreg/compiler/lib/ir_framework/ForceInline.java
  13. +144 −0 test/hotspot/jtreg/compiler/lib/ir_framework/IR.java
  14. +167 −0 test/hotspot/jtreg/compiler/lib/ir_framework/IRNode.java
  15. +35 −0 test/hotspot/jtreg/compiler/lib/ir_framework/IRs.java
  16. +135 −0 test/hotspot/jtreg/compiler/lib/ir_framework/README.md
  17. +109 −0 test/hotspot/jtreg/compiler/lib/ir_framework/Run.java
  18. +237 −0 test/hotspot/jtreg/compiler/lib/ir_framework/RunInfo.java
  19. +43 −0 test/hotspot/jtreg/compiler/lib/ir_framework/RunMode.java
  20. +150 −0 test/hotspot/jtreg/compiler/lib/ir_framework/Scenario.java
  21. +87 −0 test/hotspot/jtreg/compiler/lib/ir_framework/Test.java
  22. +718 −0 test/hotspot/jtreg/compiler/lib/ir_framework/TestFramework.java
  23. +97 −0 test/hotspot/jtreg/compiler/lib/ir_framework/TestInfo.java
  24. +48 −0 test/hotspot/jtreg/compiler/lib/ir_framework/Warmup.java
  25. +146 −0 test/hotspot/jtreg/compiler/lib/ir_framework/driver/FlagVMProcess.java
  26. +493 −0 test/hotspot/jtreg/compiler/lib/ir_framework/driver/IRMatcher.java
  27. +117 −0 test/hotspot/jtreg/compiler/lib/ir_framework/driver/IRMethod.java
  28. +63 −0 test/hotspot/jtreg/compiler/lib/ir_framework/driver/IRViolationException.java
  29. +47 −0 test/hotspot/jtreg/compiler/lib/ir_framework/driver/TestVMException.java
  30. +236 −0 test/hotspot/jtreg/compiler/lib/ir_framework/driver/TestVMProcess.java
  31. +135 −0 test/hotspot/jtreg/compiler/lib/ir_framework/flag/FlagVM.java
  32. +33 −0 test/hotspot/jtreg/compiler/lib/ir_framework/shared/CheckedTestFrameworkException.java
  33. +42 −0 test/hotspot/jtreg/compiler/lib/ir_framework/shared/NoTestsRunException.java
  34. +104 −0 test/hotspot/jtreg/compiler/lib/ir_framework/shared/ParsedComparator.java
  35. +74 −0 test/hotspot/jtreg/compiler/lib/ir_framework/shared/TestFormat.java
  36. +33 −0 test/hotspot/jtreg/compiler/lib/ir_framework/shared/TestFormatException.java
  37. +38 −0 test/hotspot/jtreg/compiler/lib/ir_framework/shared/TestFrameworkException.java
  38. +181 −0 test/hotspot/jtreg/compiler/lib/ir_framework/shared/TestFrameworkSocket.java
  39. +35 −0 test/hotspot/jtreg/compiler/lib/ir_framework/shared/TestRun.java
  40. +38 −0 test/hotspot/jtreg/compiler/lib/ir_framework/shared/TestRunException.java
  41. +221 −0 test/hotspot/jtreg/compiler/lib/ir_framework/test/AbstractTest.java
  42. +333 −0 test/hotspot/jtreg/compiler/lib/ir_framework/test/ArgumentValue.java
  43. +105 −0 test/hotspot/jtreg/compiler/lib/ir_framework/test/BaseTest.java
  44. +93 −0 test/hotspot/jtreg/compiler/lib/ir_framework/test/CheckedTest.java
  45. +181 −0 test/hotspot/jtreg/compiler/lib/ir_framework/test/CustomRunTest.java
  46. +125 −0 test/hotspot/jtreg/compiler/lib/ir_framework/test/DeclaredTest.java
  47. +290 −0 test/hotspot/jtreg/compiler/lib/ir_framework/test/IREncodingPrinter.java
  48. +955 −0 test/hotspot/jtreg/compiler/lib/ir_framework/test/TestVM.java
  49. +89 −0 test/hotspot/jtreg/testlibrary_tests/ir_framework/examples/BaseTestExample.java
  50. +149 −0 test/hotspot/jtreg/testlibrary_tests/ir_framework/examples/CheckedTestExample.java
  51. +168 −0 test/hotspot/jtreg/testlibrary_tests/ir_framework/examples/CustomRunTestExample.java
  52. +171 −0 test/hotspot/jtreg/testlibrary_tests/ir_framework/examples/IRExample.java
  53. +5 −0 test/hotspot/jtreg/testlibrary_tests/ir_framework/tests/README.md
  54. +427 −0 test/hotspot/jtreg/testlibrary_tests/ir_framework/tests/TestAccessModifiers.java
  55. +1,003 −0 test/hotspot/jtreg/testlibrary_tests/ir_framework/tests/TestBadFormat.java
  56. +1,086 −0 test/hotspot/jtreg/testlibrary_tests/ir_framework/tests/TestBasics.java
  57. +223 −0 test/hotspot/jtreg/testlibrary_tests/ir_framework/tests/TestCompLevels.java
  58. +389 −0 test/hotspot/jtreg/testlibrary_tests/ir_framework/tests/TestControls.java
  59. +75 −0 test/hotspot/jtreg/testlibrary_tests/ir_framework/tests/TestDFlags.java
  60. +89 −0 test/hotspot/jtreg/testlibrary_tests/ir_framework/tests/TestDIgnoreCompilerControls.java
  61. +96 −0 test/hotspot/jtreg/testlibrary_tests/ir_framework/tests/TestDScenarios.java
  62. +164 −0 test/hotspot/jtreg/testlibrary_tests/ir_framework/tests/TestDTestAndExclude.java
  63. +1,628 −0 test/hotspot/jtreg/testlibrary_tests/ir_framework/tests/TestIRMatching.java
  64. +405 −0 test/hotspot/jtreg/testlibrary_tests/ir_framework/tests/TestRunTests.java
  65. +86 −0 test/hotspot/jtreg/testlibrary_tests/ir_framework/tests/TestSanity.java
  66. +106 −0 test/hotspot/jtreg/testlibrary_tests/ir_framework/tests/TestScenarios.java
  67. +157 −0 test/hotspot/jtreg/testlibrary_tests/ir_framework/tests/TestWithHelperClasses.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;
}
}
@@ -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,
}
@@ -0,0 +1,43 @@
/*
* 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 java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

/**
* This annotation is used to specify well-defined {@link Argument} values for test methods (specifying {@link Test}) when
* used as part of a <b>base test</b> or <b>checked test</b>.
*
* @see Argument
* @see Test
* @see Check
*/
@Retention(RetentionPolicy.RUNTIME)
public @interface Arguments {
/**
* Get the argument value.
*/
Argument[] value();
}
@@ -0,0 +1,114 @@
/*
* 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.TestFormatException;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

/**
* Annotation for a check method of a <b>checked test</b>.
*
* <p>
* Let {@code t} be a test method specifying the {@link Test @Test} annotation and {@code c} be a check method specifying
* the {@code @Check(test = "t")} annotation. These two methods represent a so-called <i>checked test</i>. The only
* difference to a <i>base test</i> (see {@link Test}) is that the framework will invoke the check method {@code c}
* directly after the invocation of the test method {@code t} which allows to do some additional verification,
* including the return value of {@code t}. The framework does the following, similar as for <i>base tests</i>:
* <ol>
* <li><p>The framework warms {@code t} up by invoking it for a predefined number of iterations (default: 2000)
* or any number specified by an additional {@link Warmup @Warmup} annotation at {@code t} or by using
* {@link TestFramework#setDefaultWarmup(int)} (could also be 0 which skips the warm-up completely which is
* similar to simulating {@code -Xcomp}). After each invocation of {@code t}, the framework also invokes
* {@code c} if the {@code @Check} annotation specifies {@link CheckAt#EACH_INVOCATION} at {@link #when()}.
* More information about the warm-up in general can be found at {@link Warmup}</li>
* <li><p>After the warm-up, the framework compiles {@code t} at the specified compilation level set by
* {@link Test#compLevel()} (default {@link CompLevel#ANY} will pick the highest available level which is
* usually {@link CompLevel#C2}).</li>
* <li><p>The framework invokes {@code t} one more time to run the compilation. Afterwards, the framework will
* always invoke {@code c} again to be able perform additional checks after the compilation of {@code t}.</li>
* <li><p>The framework checks any specified {@link IR @IR} constraints at the test method {@code t}.
* More information about IR matching can be found at {@link IR}.</li>
* </ol>
*
* <p>
* The test method {@code t} has the same properties and follows the same constraints as stated in {@link Test}.
* <p>
* The following additional constraints must be met for the test method {@code t} and check method {@code c}:
* <ul>
* <li><p>{@code c} must specify the method name {@code t} as property in {@code @Check(test = "t")}
* (see {@link #test()}. Specifying a non-{@code @Test} annotated method or a {@code @Test} method that
* has already been used by another {@code @Check} or {@link Run @Run} method results in a {@link TestFormatException}.
* <li><p>{@code c} can specify the following method parameter combinations:
* <ul>
* <li><p>void</li>
* <li><p>One parameter: {@link TestInfo} which provides some information about {@code t} and utility methods.</li>
* <li><p>One parameter: the <i>exact</i> same type as the return value of {@code t}. When {@code c} is
* invoked by the framework, this parameter contains the return value of {@code t}.</li>
* <li><p>1st parameter: {@link TestInfo}; 2nd parameter: the <i>exact</i> same type as the return value of
* {@code t} (see above)</li>
* <li><p> Any other combination will result in a {@link TestFormatException}.
* </ul>
* <li><p>{@code c} is not compiled nor inlined.
* <li><p>{@code c} must be part of the test class. Using {@code @Check} in nested or other classes is not allowed.</li>
* <li><p>{@code c} cannot specify any helper-method-specific compile command annotations
* ({@link ForceCompile @ForceCompile}, {@link DontCompile @DontCompile}, {@link ForceInline @ForceInline},
* {@link DontInline @DontInline}).</li>
* </ul>
*
* <p>
* If no verification is required, use a <i>base test</i> (see {@link Test}). If {@code t} must be invoked with more
* complex or varying arguments and/or the {@code t} must be invoked differently in subsequent invocations, use a
* <i>custom run test</i> (see {@link Run}).
*
* <p>
* Examples on how to write checked tests can be found in {@link jdk.test.lib.hotspot.ir_framework.examples.CheckedTestExample}
* and also as part of the internal testing in the package {@link jdk.test.lib.hotspot.ir_framework.tests}.
*
* @see Test
* @see TestInfo
* @see CheckAt
*/
@Retention(RetentionPolicy.RUNTIME)
public @interface Check {
/**
* The unique associated {@link Test} method for this {@code @Check} annotated check method. The framework will directly
* invoke the {@code @Check} method after each invocation or only after the compilation of the associated {@code @Test}
* method (depending on the value set with {@link #when()}).
* <p>
* If a non-{@code @Test} annotated method or a {@code @Test} method that has already been used by another
* {@code @Check} or {@link Run} method is specified, then a {@link TestFormatException} is thrown.
*
* @see Test
*/
String test();
/**
* When should the {@code @Check} method be invoked? By default, the check is done after each invocation which is
* encouraged if performance is not critical.
*
* @see CheckAt
*/
CheckAt when() default CheckAt.EACH_INVOCATION;
}
Loading

1 comment on commit 3396b69

@openjdk-notifier

This comment has been minimized.

Copy link

@openjdk-notifier openjdk-notifier bot commented on 3396b69 Jun 7, 2021

Please sign in to comment.