com.oracle.graal.compiler.test

Class GraalCompilerTest

java.lang.Object

com.oracle.graal.test.GraalTest

com.oracle.graal.compiler.test.GraalCompilerTest

Direct Known Subclasses:

AbstractObjectStampTest, AheadOfTimeCompilationTest, AMD64HotSpotFrameOmissionTest, ArrayCopyIntrinsificationTest, BackendTest, BitOpNodesTest, BlackholeDirectiveTest, BoxingEliminationTest, BoxingTest, ClassSubstitutionsTests, CommonedConstantsTest, CompareCanonicalizerTest, CompiledExceptionHandlerTest, CompiledMethodTest, CompileTheWorldTest, CompressedNullCheckTest, CompressedOopTest, ConditionalEliminationTestBase, ConditionAnchoringTest, ConstantPoolSubstitutionsTests, ControlFlowAnchorDirectiveTest, CopyOfVirtualizationTest, CountedLoopTest, CRC32SubstitutionsTest, DataPatchTest, DegeneratedLoopsTest, DeoptimizeDirectiveTest, DeoptimizeOnExceptionTest, DerivedOopTest, DynamicNewArrayTest, EarlyReadEliminationTest, EATestBase, EdgesTest, EliminateNestedCheckCastsTest, ExactMathTest, ExplicitExceptionTest, FinalizableSubclassTest, FindUniqueConcreteMethodBugTest, FloatOptimizationTest, ForeignCallDeoptimizeTest, GraalCompilerAssumptionsTest, GraphEncoderTest, GraphScheduleTest, GuardEliminationCornerCasesTest, HotSpotGraalCompilerTest, HotSpotMonitorValueTest, HotSpotNmethodTest, IfCanonicalizerTest, IfReorderTest, InfopointReasonTest, InliningTest, InstalledCodeExecuteHelperTest, InstanceOfDynamicTest, IntegerEqualsCanonicalizerTest, InvokeExceptionTest, InvokeHintsTest, InvokeTest, IterationDirectiveTest, JTTTest, LambdaEagerTest, LoadJavaMirrorWithKlassTest, LockEliminationTest, LongNodeChainTest, LoopPhiCanonicalizerTest, LoopUnswitchTest, MarkUnsafeAccessTest, MemoryArithmeticTest, MergeCanonicalizerTest, MethodHandleEagerResolution, MethodSubstitutionTest, MonitorDeoptTest, MonitorGraphTest, MonitorTest, NestedLoopTest, NewArrayTest, NewInstanceTest, NewMultiArrayTest, NodePosIteratorTest, ObjectAccessTest, OnStackReplacementTest, OpaqueDirectiveTest, PartialEvaluationTest, PEAAssertionsTest, PEGraphDecoderTest, PhiCreationTests, PointerTest, PoorMansEATest, ProbabilityDirectiveTest, ProfilingInfoTest, PushNodesThroughPiTest, PushThroughIfTest, ReassociateAndCanonicalTest, ReplacementsParseTest, ScalarTypeSystemTest, ShortCircuitNodeTest, SimpleCFGTest, StampCanonicalizerTest, StraighteningTest, SubstitutionsTest, SynchronizedMethodDeoptimizationTest, TypeCheckTest, TypeSystemTest, TypeWriterTest, UnsignedIntegerTest, UnsignedMathTest, UnwindExceptionToCallerTest, WordTest, WriteBarrierAdditionTest, WriteBarrierVerificationTest

public abstract class GraalCompilerTest
extends GraalTest

Base class for Graal compiler unit tests.

White box tests for Graal compiler transformations use this pattern:

1. Create a graph by parsing a method.
2. Manually modify the graph (e.g. replace a parameter node with a constant).
3. Apply a transformation to the graph.
4. Assert that the transformed graph is equal to an expected graph.

See InvokeHintsTest as an example of a white box test.

Black box tests use the test(String, Object...) or testN(int, String, Object...) to execute some method in the interpreter and compare its result against that produced by a Graal compiled version of the method.

These tests will be run by the mx unittest command.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GraalCompilerTest.ArgSupplier Type denoting a lambda that supplies a fresh value each time it is called.
protected static class	GraalCompilerTest.Result

Nested classes/interfaces inherited from class com.oracle.graal.test.GraalTest

GraalTest.MultiCauseAssertionError

Field Summary

Fields

Modifier and Type	Field and Description
private Backend	backend
private Map<ResolvedJavaMethod,InstalledCode>	cache
private static AtomicInteger	compilationId
private Debug.Scope	debugScope
protected StructuredGraph	lastCompiledGraph
private DerivedOptionValue<LIRSuites>	lirSuites
private Map<ResolvedJavaMethod,Method>	methodMap
private Providers	providers
private DerivedOptionValue<Suites>	suites

Constructor Summary

Constructors

Constructor and Description
GraalCompilerTest()
GraalCompilerTest(Class<? extends Architecture> arch) Set up a test for a non-default backend.

Method Summary

Modifier and Type	Method and Description
protected InstalledCode	addMethod(ResolvedJavaMethod method, CompilationResult compResult)
protected void	after() Called after a test is executed.
void	afterTest()
protected Object[]	applyArgSuppliers(Object... args) Process a given set of arguments, converting any GraalCompilerTest.ArgSupplier argument to the argument it supplies.
protected Object[]	argsWithReceiver(Object receiver, Object... args) Prepends a non-null receiver argument to a given list or args.
protected ResolvedJavaMethod	asResolvedJavaMethod(Method method) Converts a reflection Method to a ResolvedJavaMethod.
protected void	assertConstantReturn(StructuredGraph graph, int value)
protected void	assertEquals(GraalCompilerTest.Result expect, GraalCompilerTest.Result actual)
protected void	assertEquals(StructuredGraph expected, StructuredGraph graph)
protected void	assertEquals(StructuredGraph expected, StructuredGraph graph, boolean excludeVirtual, boolean checkConstants)
protected void	before(ResolvedJavaMethod method) Called before a test is executed.
void	beforeTest()
protected static boolean	branchProbability(double p, boolean cond) Inject a probability for a branch condition into the profiling information of this test case.
protected static void	breakpoint()
protected static void	breakpoint(int arg0)
protected void	checkArgs(ResolvedJavaMethod method, Object[] args)
protected boolean	checkHighTierGraph(StructuredGraph graph) Can be overridden by unit tests to verify properties of the graph.
protected boolean	checkLowTierGraph(StructuredGraph graph) Can be overridden by unit tests to verify properties of the graph.
protected boolean	checkMidTierGraph(StructuredGraph graph) Can be overridden by unit tests to verify properties of the graph.
private static String	compareGraphStrings(StructuredGraph expectedGraph, String expectedString, StructuredGraph actualGraph, String actualString)
protected CompilationResult	compile(ResolvedJavaMethod installedCodeOwner, StructuredGraph graph) Compiles a given method.
protected int	countUnusedConstants(StructuredGraph graph)
protected LIRSuites	createLIRSuites()
protected Suites	createSuites()
protected GraphBuilderConfiguration	editGraphBuilderConfiguration(GraphBuilderConfiguration conf)
protected GraalCompilerTest.Result	executeActual(ResolvedJavaMethod method, Object receiver, Object... args)
protected GraalCompilerTest.Result	executeActualCheckDeopt(ResolvedJavaMethod method, Set<DeoptimizationReason> shouldNotDeopt, Object receiver, Object... args)
protected GraalCompilerTest.Result	executeExpected(ResolvedJavaMethod method, Object receiver, Object... args)
protected Backend	getBackend()
protected static String	getCanonicalGraphString(StructuredGraph graph, boolean excludeVirtual, boolean checkConstants)
protected InstalledCode	getCode(ResolvedJavaMethod method) Gets installed code for a given method, compiling it first if necessary.
protected InstalledCode	getCode(ResolvedJavaMethod installedCodeOwner, StructuredGraph graph) Gets installed code for a given method, compiling it first if necessary.
protected InstalledCode	getCode(ResolvedJavaMethod installedCodeOwner, StructuredGraph graph, boolean forceCompile) Gets installed code for a given method and graph, compiling it first if necessary.
protected CodeCacheProvider	getCodeCache()
protected ConstantReflectionProvider	getConstantReflection()
protected PhaseSuite<HighTierContext>	getCustomGraphBuilderSuite(GraphBuilderConfiguration gbConf)
protected GraphBuilderConfiguration.Plugins	getDefaultGraphBuilderPlugins()
protected PhaseSuite<HighTierContext>	getDefaultGraphBuilderSuite()
protected HighTierContext	getDefaultHighTierContext()
protected LIRSuites	getLIRSuites()
protected LoweringProvider	getLowerer()
protected MetaAccessProvider	getMetaAccess()
protected int	getNodeCountExcludingUnusedConstants(StructuredGraph graph)
protected Providers	getProviders()
protected Replacements	getReplacements()
protected ResolvedJavaMethod	getResolvedJavaMethod(Class<?> clazz, String methodName)
protected ResolvedJavaMethod	getResolvedJavaMethod(Class<?> clazz, String methodName, Class<?>... parameterTypes)
protected ResolvedJavaMethod	getResolvedJavaMethod(String methodName)
protected SnippetReflectionProvider	getSnippetReflection()
protected SpeculationLog	getSpeculationLog()
protected Suites	getSuites()
protected TargetDescription	getTarget()
static void	initializeDebugging()
protected Object	invoke(ResolvedJavaMethod javaMethod, Object receiver, Object... args)
protected boolean	isArchitecture(String name) Test if the current test runs on the given platform.
protected static boolean	iterationCount(double i, boolean cond) Inject an iteration count for a loop condition into the profiling information of this test case.
protected Method	lookupMethod(ResolvedJavaMethod javaMethod) Gets the reflection Method from which a given ResolvedJavaMethod was created or null if javaMethod does not correspond to a reflection method.
private StructuredGraph	parse1(ResolvedJavaMethod javaMethod, PhaseSuite<HighTierContext> graphBuilderSuite, StructuredGraph.AllowAssumptions allowAssumptions)
protected StructuredGraph	parseDebug(ResolvedJavaMethod m, StructuredGraph.AllowAssumptions allowAssumptions) Parses a Java method in full debug mode to produce a graph.
protected StructuredGraph	parseEager(ResolvedJavaMethod m, StructuredGraph.AllowAssumptions allowAssumptions) Parses a Java method in eager mode to produce a graph.
protected StructuredGraph	parseEager(String methodName, StructuredGraph.AllowAssumptions allowAssumptions) Parses a Java method in eager mode to produce a graph.
protected StructuredGraph	parseForCompile(ResolvedJavaMethod method) Used to produce a graph for a method about to be compiled by compile(ResolvedJavaMethod, StructuredGraph) if the second parameter to that method is null.
protected StructuredGraph	parseProfiled(ResolvedJavaMethod m, StructuredGraph.AllowAssumptions allowAssumptions) Parses a Java method in default mode to produce a graph.
protected StructuredGraph	parseProfiled(String methodName, StructuredGraph.AllowAssumptions allowAssumptions) Parses a Java method in default mode to produce a graph.
protected Object	referenceInvoke(ResolvedJavaMethod method, Object receiver, Object... args)
static Object	supply(GraalCompilerTest.ArgSupplier supplier) Convenience method for using an GraalCompilerTest.ArgSupplier lambda in a varargs list.
protected void	test(ResolvedJavaMethod method, Object receiver, Object... args)
protected void	test(String name, Object... args)
protected void	testAgainstExpected(ResolvedJavaMethod method, GraalCompilerTest.Result expect, Object receiver, Object... args)
protected void	testAgainstExpected(ResolvedJavaMethod method, GraalCompilerTest.Result expect, Set<DeoptimizationReason> shouldNotDeopt, Object receiver, Object... args)
protected void	testN(int n, String name, Object... args)

Methods inherited from class com.oracle.graal.test.GraalTest

assertDeepEquals, assertDeepEquals, assertDeepEquals, assertDeepEquals, assertFalse, assertFalse, assertFalse, assertTrue, assertTrue, assertTrue, equalFloatsOrDoublesDelta, fail, getMethod, getMethod, getMethod, ulpsDelta

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

providers

private final Providers providers

backend

private final Backend backend

suites

private final DerivedOptionValue<Suites> suites

lirSuites

private final DerivedOptionValue<LIRSuites> lirSuites

debugScope

private Debug.Scope debugScope

compilationId

private static AtomicInteger compilationId

cache

private Map<ResolvedJavaMethod,InstalledCode> cache

lastCompiledGraph

protected StructuredGraph lastCompiledGraph

methodMap

private final Map<ResolvedJavaMethod,Method> methodMap

Constructor Detail

GraalCompilerTest

public GraalCompilerTest()

GraalCompilerTest

public GraalCompilerTest(Class<? extends Architecture> arch)

Set up a test for a non-default backend. The test should check (via getBackend() ) whether the desired backend is available.

Parameters:

arch - the name of the desired backend architecture

Method Detail

checkHighTierGraph

protected boolean checkHighTierGraph(StructuredGraph graph)

Can be overridden by unit tests to verify properties of the graph.

Parameters:

graph - the graph at the end of HighTier

checkMidTierGraph

protected boolean checkMidTierGraph(StructuredGraph graph)

Can be overridden by unit tests to verify properties of the graph.

Parameters:

graph - the graph at the end of MidTier

checkLowTierGraph

protected boolean checkLowTierGraph(StructuredGraph graph)

Can be overridden by unit tests to verify properties of the graph.

Parameters:

graph - the graph at the end of LowTier

breakpoint

protected static void breakpoint()

breakpoint

protected static void breakpoint(int arg0)

createSuites

protected Suites createSuites()

createLIRSuites

protected LIRSuites createLIRSuites()

initializeDebugging

public static void initializeDebugging()

beforeTest

public void beforeTest()

afterTest

public void afterTest()

assertEquals

protected void assertEquals(StructuredGraph expected,
                            StructuredGraph graph)

countUnusedConstants

protected int countUnusedConstants(StructuredGraph graph)

getNodeCountExcludingUnusedConstants

protected int getNodeCountExcludingUnusedConstants(StructuredGraph graph)

assertEquals

protected void assertEquals(StructuredGraph expected,
                            StructuredGraph graph,
                            boolean excludeVirtual,
                            boolean checkConstants)

compareGraphStrings

private static String compareGraphStrings(StructuredGraph expectedGraph,
                                          String expectedString,
                                          StructuredGraph actualGraph,
                                          String actualString)

assertConstantReturn

protected void assertConstantReturn(StructuredGraph graph,
                                    int value)

getCanonicalGraphString

protected static String getCanonicalGraphString(StructuredGraph graph,
                                                boolean excludeVirtual,
                                                boolean checkConstants)

getBackend

protected Backend getBackend()

getSuites

protected Suites getSuites()

getLIRSuites

protected LIRSuites getLIRSuites()

getProviders

protected Providers getProviders()

getDefaultHighTierContext

protected HighTierContext getDefaultHighTierContext()

getSnippetReflection

protected SnippetReflectionProvider getSnippetReflection()

getTarget

protected TargetDescription getTarget()

getCodeCache

protected CodeCacheProvider getCodeCache()

getConstantReflection

protected ConstantReflectionProvider getConstantReflection()

getMetaAccess

protected MetaAccessProvider getMetaAccess()

getLowerer

protected LoweringProvider getLowerer()

testN

protected void testN(int n,
                     String name,
                     Object... args)

referenceInvoke

protected Object referenceInvoke(ResolvedJavaMethod method,
                                 Object receiver,
                                 Object... args)
                          throws IllegalAccessException,
                                 IllegalArgumentException,
                                 InvocationTargetException

Throws:

IllegalAccessException

IllegalArgumentException

InvocationTargetException

before

protected void before(ResolvedJavaMethod method)

Called before a test is executed.

after

protected void after()

Called after a test is executed.

executeExpected

protected GraalCompilerTest.Result executeExpected(ResolvedJavaMethod method,
                                                   Object receiver,
                                                   Object... args)

executeActual

protected GraalCompilerTest.Result executeActual(ResolvedJavaMethod method,
                                                 Object receiver,
                                                 Object... args)

checkArgs

protected void checkArgs(ResolvedJavaMethod method,
                         Object[] args)

argsWithReceiver

protected Object[] argsWithReceiver(Object receiver,
                                    Object... args)

Prepends a non-null receiver argument to a given list or args.

Parameters:

receiver - the receiver argument to prepend if it is non-null

test

protected void test(String name,
                    Object... args)

supply

public static Object supply(GraalCompilerTest.ArgSupplier supplier)

Convenience method for using an GraalCompilerTest.ArgSupplier lambda in a varargs list.

test

protected void test(ResolvedJavaMethod method,
                    Object receiver,
                    Object... args)

applyArgSuppliers

protected Object[] applyArgSuppliers(Object... args)

Process a given set of arguments, converting any GraalCompilerTest.ArgSupplier argument to the argument it supplies.

testAgainstExpected

protected void testAgainstExpected(ResolvedJavaMethod method,
                                   GraalCompilerTest.Result expect,
                                   Object receiver,
                                   Object... args)

executeActualCheckDeopt

protected GraalCompilerTest.Result executeActualCheckDeopt(ResolvedJavaMethod method,
                                                           Set<DeoptimizationReason> shouldNotDeopt,
                                                           Object receiver,
                                                           Object... args)

assertEquals

protected void assertEquals(GraalCompilerTest.Result expect,
                            GraalCompilerTest.Result actual)

testAgainstExpected

protected void testAgainstExpected(ResolvedJavaMethod method,
                                   GraalCompilerTest.Result expect,
                                   Set<DeoptimizationReason> shouldNotDeopt,
                                   Object receiver,
                                   Object... args)

getCode

protected InstalledCode getCode(ResolvedJavaMethod method)

Gets installed code for a given method, compiling it first if necessary. The graph is parsed eagerly.

getCode

protected InstalledCode getCode(ResolvedJavaMethod installedCodeOwner,
                                StructuredGraph graph)

Gets installed code for a given method, compiling it first if necessary.

Parameters:

installedCodeOwner - the method the compiled code will be associated with when installed

graph - the graph to be compiled. If null, a graph will be obtained from installedCodeOwner via parseForCompile(ResolvedJavaMethod).

getCode

protected InstalledCode getCode(ResolvedJavaMethod installedCodeOwner,
                                StructuredGraph graph,
                                boolean forceCompile)

Gets installed code for a given method and graph, compiling it first if necessary.

Parameters:

installedCodeOwner - the method the compiled code will be associated with when installed

graph - the graph to be compiled. If null, a graph will be obtained from installedCodeOwner via parseForCompile(ResolvedJavaMethod).

forceCompile - specifies whether to ignore any previous code cached for the (method, key) pair

parseForCompile

protected StructuredGraph parseForCompile(ResolvedJavaMethod method)

Used to produce a graph for a method about to be compiled by compile(ResolvedJavaMethod, StructuredGraph) if the second parameter to that method is null. The default implementation in GraalCompilerTest is to call #parseEager(ResolvedJavaMethod, AllowAssumptions).

compile

protected CompilationResult compile(ResolvedJavaMethod installedCodeOwner,
                                    StructuredGraph graph)

Compiles a given method.

Parameters:

installedCodeOwner - the method the compiled code will be associated with when installed

graph - the graph to be compiled for installedCodeOwner. If null, a graph will be obtained from installedCodeOwner via parseForCompile(ResolvedJavaMethod).

getSpeculationLog

protected SpeculationLog getSpeculationLog()

addMethod

protected InstalledCode addMethod(ResolvedJavaMethod method,
                                  CompilationResult compResult)

asResolvedJavaMethod

protected ResolvedJavaMethod asResolvedJavaMethod(Method method)

Converts a reflection Method to a ResolvedJavaMethod.

getResolvedJavaMethod

protected ResolvedJavaMethod getResolvedJavaMethod(String methodName)

getResolvedJavaMethod

protected ResolvedJavaMethod getResolvedJavaMethod(Class<?> clazz,
                                                   String methodName)

getResolvedJavaMethod

protected ResolvedJavaMethod getResolvedJavaMethod(Class<?> clazz,
                                                   String methodName,
                                                   Class<?>... parameterTypes)

lookupMethod

protected Method lookupMethod(ResolvedJavaMethod javaMethod)

Gets the reflection Method from which a given ResolvedJavaMethod was created or null if javaMethod does not correspond to a reflection method.

invoke

protected Object invoke(ResolvedJavaMethod javaMethod,
                        Object receiver,
                        Object... args)
                 throws IllegalAccessException,
                        IllegalArgumentException,
                        InvocationTargetException

Throws:

IllegalAccessException

IllegalArgumentException

InvocationTargetException

parseProfiled

protected StructuredGraph parseProfiled(String methodName,
                                        StructuredGraph.AllowAssumptions allowAssumptions)

Parses a Java method in default mode to produce a graph.

Parameters:

methodName - the name of the method in this.getClass() to be parsed

parseProfiled

protected StructuredGraph parseProfiled(ResolvedJavaMethod m,
                                        StructuredGraph.AllowAssumptions allowAssumptions)

Parses a Java method in default mode to produce a graph.

parseEager

protected StructuredGraph parseEager(String methodName,
                                     StructuredGraph.AllowAssumptions allowAssumptions)

Parses a Java method in eager mode to produce a graph.

Parameters:

methodName - the name of the method in this.getClass() to be parsed

parseEager

protected StructuredGraph parseEager(ResolvedJavaMethod m,
                                     StructuredGraph.AllowAssumptions allowAssumptions)

Parses a Java method in eager mode to produce a graph.

parseDebug

protected StructuredGraph parseDebug(ResolvedJavaMethod m,
                                     StructuredGraph.AllowAssumptions allowAssumptions)

Parses a Java method in full debug mode to produce a graph.

parse1

private StructuredGraph parse1(ResolvedJavaMethod javaMethod,
                               PhaseSuite<HighTierContext> graphBuilderSuite,
                               StructuredGraph.AllowAssumptions allowAssumptions)

getDefaultGraphBuilderPlugins

protected GraphBuilderConfiguration.Plugins getDefaultGraphBuilderPlugins()

getDefaultGraphBuilderSuite

protected PhaseSuite<HighTierContext> getDefaultGraphBuilderSuite()

getCustomGraphBuilderSuite

protected PhaseSuite<HighTierContext> getCustomGraphBuilderSuite(GraphBuilderConfiguration gbConf)

editGraphBuilderConfiguration

protected GraphBuilderConfiguration editGraphBuilderConfiguration(GraphBuilderConfiguration conf)

getReplacements

protected Replacements getReplacements()

branchProbability

protected static boolean branchProbability(double p,
                                           boolean cond)

Inject a probability for a branch condition into the profiling information of this test case.

Parameters:

p - the probability that cond is true

cond - the condition of the branch

Returns:

cond

iterationCount

protected static boolean iterationCount(double i,
                                        boolean cond)

Inject an iteration count for a loop condition into the profiling information of this test case.

Parameters:

i - the iteration count of the loop

cond - the condition of the loop

Returns:

cond

isArchitecture

protected boolean isArchitecture(String name)

Test if the current test runs on the given platform. The name must match the name given in the Architecture.getName().

Parameters:

name - The name to test

Returns:

true if we run on the architecture given by name