1 /*
2 * Copyright (c) 2013, 2018, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 */
23
24
25 package org.graalvm.compiler.asm.test;
26
27 import static org.graalvm.compiler.core.common.CompilationRequestIdentifier.asCompilationRequest;
28
29 import java.lang.reflect.Method;
30
31 import org.graalvm.compiler.api.test.Graal;
32 import org.graalvm.compiler.code.CompilationResult;
33 import org.graalvm.compiler.code.DisassemblerProvider;
34 import org.graalvm.compiler.core.common.CompilationIdentifier;
35 import org.graalvm.compiler.core.gen.LIRGenerationProvider;
36 import org.graalvm.compiler.core.target.Backend;
37 import org.graalvm.compiler.debug.DebugContext;
38 import org.graalvm.compiler.nodes.StructuredGraph;
39 import org.graalvm.compiler.options.OptionValues;
40 import org.graalvm.compiler.runtime.RuntimeProvider;
41 import org.graalvm.compiler.serviceprovider.GraalServices;
42 import org.graalvm.compiler.test.GraalTest;
43 import org.junit.Assert;
44
45 import jdk.vm.ci.code.CallingConvention;
46 import jdk.vm.ci.code.CodeCacheProvider;
47 import jdk.vm.ci.code.InstalledCode;
48 import jdk.vm.ci.code.InvalidInstalledCodeException;
49 import jdk.vm.ci.code.RegisterConfig;
50 import jdk.vm.ci.code.TargetDescription;
51 import jdk.vm.ci.meta.MetaAccessProvider;
52 import jdk.vm.ci.meta.ResolvedJavaMethod;
53 import jdk.vm.ci.runtime.JVMCI;
54 import jdk.vm.ci.runtime.JVMCIBackend;
55
56 public abstract class AssemblerTest extends GraalTest {
57
58 private final MetaAccessProvider metaAccess;
59 protected final CodeCacheProvider codeCache;
60 private final Backend backend;
61
62 public interface CodeGenTest {
63 byte[] generateCode(CompilationResult compResult, TargetDescription target, RegisterConfig registerConfig, CallingConvention cc);
64 }
65
66 /**
67 * Gets the initial option values provided by the Graal runtime. These are option values
68 * typically parsed from the command line.
69 */
70 public static OptionValues getInitialOptions() {
71 return Graal.getRequiredCapability(OptionValues.class);
72 }
73
74 public AssemblerTest() {
75 JVMCIBackend providers = JVMCI.getRuntime().getHostJVMCIBackend();
76 this.metaAccess = providers.getMetaAccess();
77 this.codeCache = providers.getCodeCache();
78 this.backend = Graal.getRequiredCapability(RuntimeProvider.class).getHostBackend();
79 }
80
81 public MetaAccessProvider getMetaAccess() {
82 return metaAccess;
83 }
84
85 @SuppressWarnings("try")
86 protected InstalledCode assembleMethod(Method m, CodeGenTest test) {
87 ResolvedJavaMethod method = getMetaAccess().lookupJavaMethod(m);
88 OptionValues options = getInitialOptions();
89 DebugContext debug = getDebugContext(options);
90 try (DebugContext.Scope s = debug.scope("assembleMethod", method, codeCache)) {
91 RegisterConfig registerConfig = codeCache.getRegisterConfig();
92 CompilationIdentifier compilationId = backend.getCompilationIdentifier(method);
93 StructuredGraph graph = new StructuredGraph.Builder(options, debug).method(method).compilationId(compilationId).build();
94 CallingConvention cc = ((LIRGenerationProvider) backend).newLIRGenerationResult(compilationId, null, null, graph, null).getCallingConvention();
95
96 CompilationResult compResult = new CompilationResult(graph.compilationId());
97 byte[] targetCode = test.generateCode(compResult, codeCache.getTarget(), registerConfig, cc);
98 compResult.setTargetCode(targetCode, targetCode.length);
99 compResult.setTotalFrameSize(0);
100 compResult.close();
101
102 InstalledCode code = backend.addInstalledCode(debug, method, asCompilationRequest(compilationId), compResult);
103
104 for (DisassemblerProvider dis : GraalServices.load(DisassemblerProvider.class)) {
105 String disasm1 = dis.disassembleCompiledCode(codeCache, compResult);
106 Assert.assertTrue(compResult.toString(), disasm1 == null || disasm1.length() > 0);
107 String disasm2 = dis.disassembleInstalledCode(codeCache, compResult, code);
108 Assert.assertTrue(code.toString(), disasm2 == null || disasm2.length() > 0);
109 }
110 return code;
111 } catch (Throwable e) {
112 throw debug.handle(e);
113 }
114 }
115
116 protected Object runTest(String methodName, CodeGenTest test, Object... args) {
117 Method method = getMethod(methodName);
118 InstalledCode code = assembleMethod(method, test);
119 try {
120 return code.executeVarargs(args);
121 } catch (InvalidInstalledCodeException e) {
122 throw new RuntimeException(e);
123 }
124 }
125
126 protected void assertReturn(String methodName, CodeGenTest test, Object expected, Object... args) {
127 Object actual = runTest(methodName, test, args);
128 Assert.assertEquals("unexpected return value", expected, actual);
129 }
130 }