/*
* Copyright (c) 2013, 2015, 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 org.graalvm.compiler.truffle.test;
import static org.graalvm.compiler.core.common.CompilationIdentifier.INVALID_COMPILATION_ID;
import static org.graalvm.compiler.core.common.CompilationRequestIdentifier.asCompilationRequest;
import org.graalvm.compiler.api.replacements.SnippetReflectionProvider;
import org.graalvm.compiler.core.common.CompilationIdentifier;
import org.graalvm.compiler.core.test.GraalCompilerTest;
import org.graalvm.compiler.debug.Debug;
import org.graalvm.compiler.debug.Debug.Scope;
import org.graalvm.compiler.debug.DebugDumpScope;
import org.graalvm.compiler.debug.DebugEnvironment;
import org.graalvm.compiler.nodes.FrameState;
import org.graalvm.compiler.nodes.StructuredGraph;
import org.graalvm.compiler.nodes.StructuredGraph.AllowAssumptions;
import org.graalvm.compiler.nodes.java.MethodCallTargetNode;
import org.graalvm.compiler.phases.common.CanonicalizerPhase;
import org.graalvm.compiler.phases.common.DeadCodeEliminationPhase;
import org.graalvm.compiler.phases.tiers.PhaseContext;
import org.graalvm.compiler.truffle.DefaultInliningPolicy;
import org.graalvm.compiler.truffle.DefaultTruffleCompiler;
import org.graalvm.compiler.truffle.GraalTruffleRuntime;
import org.graalvm.compiler.truffle.OptimizedCallTarget;
import org.graalvm.compiler.truffle.TruffleCompiler;
import org.graalvm.compiler.truffle.TruffleDebugJavaMethod;
import org.graalvm.compiler.truffle.TruffleInlining;
import org.junit.Assert;
import com.oracle.truffle.api.Truffle;
import com.oracle.truffle.api.nodes.RootNode;
public class PartialEvaluationTest extends GraalCompilerTest {
private final TruffleCompiler truffleCompiler;
public PartialEvaluationTest() {
beforeInitialization();
GraalTruffleRuntime runtime = (GraalTruffleRuntime) Truffle.getRuntime();
this.truffleCompiler = DefaultTruffleCompiler.create(runtime);
DebugEnvironment.ensureInitialized(getInitialOptions(), runtime.getRequiredGraalCapability(SnippetReflectionProvider.class));
}
/**
* Executed before initialization. This hook can be used to override specific flags.
*/
protected void beforeInitialization() {
}
protected OptimizedCallTarget assertPartialEvalEquals(String methodName, RootNode root) {
return assertPartialEvalEquals(methodName, root, new Object[0]);
}
private CompilationIdentifier getCompilationId(final OptimizedCallTarget compilable) {
return ((GraalTruffleRuntime) Truffle.getRuntime()).getCompilationIdentifier(compilable, truffleCompiler.getPartialEvaluator().getCompilationRootMethods()[0], getBackend());
}
protected OptimizedCallTarget compileHelper(String methodName, RootNode root, Object[] arguments) {
final OptimizedCallTarget compilable = (OptimizedCallTarget) (Truffle.getRuntime()).createCallTarget(root);
CompilationIdentifier compilationId = getCompilationId(compilable);
StructuredGraph actual = partialEval(compilable, arguments, AllowAssumptions.YES, compilationId);
truffleCompiler.compileMethodHelper(actual, methodName, null, compilable, asCompilationRequest(compilationId), null);
return compilable;
}
protected OptimizedCallTarget assertPartialEvalEquals(String methodName, RootNode root, Object[] arguments) {
final OptimizedCallTarget compilable = (OptimizedCallTarget) Truffle.getRuntime().createCallTarget(root);
CompilationIdentifier compilationId = getCompilationId(compilable);
StructuredGraph actual = partialEval(compilable, arguments, AllowAssumptions.YES, compilationId);
truffleCompiler.compileMethodHelper(actual, methodName, null, compilable, asCompilationRequest(compilationId), null);
removeFrameStates(actual);
StructuredGraph expected = parseForComparison(methodName);
Assert.assertEquals(getCanonicalGraphString(expected, true, true), getCanonicalGraphString(actual, true, true));
return compilable;
}
protected void assertPartialEvalNoInvokes(RootNode root) {
assertPartialEvalNoInvokes(root, new Object[0]);
}
protected void assertPartialEvalNoInvokes(RootNode root, Object[] arguments) {
final OptimizedCallTarget compilable = (OptimizedCallTarget) Truffle.getRuntime().createCallTarget(root);
StructuredGraph actual = partialEval(compilable, arguments, AllowAssumptions.YES, INVALID_COMPILATION_ID);
removeFrameStates(actual);
for (MethodCallTargetNode node : actual.getNodes(MethodCallTargetNode.TYPE)) {
Assert.fail("Found invalid method call target node: " + node);
}
}
@SuppressWarnings("try")
protected StructuredGraph partialEval(OptimizedCallTarget compilable, Object[] arguments, AllowAssumptions allowAssumptions, CompilationIdentifier compilationId) {
// Executed AST so that all classes are loaded and initialized.
compilable.call(arguments);
compilable.call(arguments);
compilable.call(arguments);
try (Scope s = Debug.scope("TruffleCompilation", new TruffleDebugJavaMethod(compilable))) {
return truffleCompiler.getPartialEvaluator().createGraph(compilable, new TruffleInlining(compilable, new DefaultInliningPolicy()), allowAssumptions, compilationId, null);
} catch (Throwable e) {
throw Debug.handle(e);
}
}
protected void removeFrameStates(StructuredGraph graph) {
for (FrameState frameState : graph.getNodes(FrameState.TYPE)) {
frameState.replaceAtUsages(null);
frameState.safeDelete();
}
new CanonicalizerPhase().apply(graph, new PhaseContext(getProviders()));
new DeadCodeEliminationPhase().apply(graph);
}
@SuppressWarnings("try")
protected StructuredGraph parseForComparison(final String methodName) {
try (Scope s = Debug.scope("Truffle", new DebugDumpScope("Comparison: " + methodName))) {
StructuredGraph graph = parseEager(methodName, AllowAssumptions.YES);
compile(graph.method(), graph);
return graph;
} catch (Throwable e) {
throw Debug.handle(e);
}
}
}