1 /*
   2  * Copyright (c) 2013, 2016, 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 package org.graalvm.compiler.asm.test;
  24 
  25 import static org.graalvm.compiler.core.common.CompilationRequestIdentifier.asCompilationRequest;
  26 
  27 import java.lang.reflect.Method;
  28 
  29 import org.junit.Assert;
  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.target.Backend;
  36 import org.graalvm.compiler.debug.Debug;
  37 import org.graalvm.compiler.debug.Debug.Scope;
  38 import org.graalvm.compiler.nodes.StructuredGraph;
  39 import org.graalvm.compiler.nodes.StructuredGraph.AllowAssumptions;
  40 import org.graalvm.compiler.runtime.RuntimeProvider;
  41 import org.graalvm.compiler.serviceprovider.GraalServices;
  42 import org.graalvm.compiler.test.GraalTest;
  43 
  44 import jdk.vm.ci.code.CallingConvention;
  45 import jdk.vm.ci.code.CodeCacheProvider;
  46 import jdk.vm.ci.code.InstalledCode;
  47 import jdk.vm.ci.code.InvalidInstalledCodeException;
  48 import jdk.vm.ci.code.RegisterConfig;
  49 import jdk.vm.ci.code.TargetDescription;
  50 import jdk.vm.ci.meta.MetaAccessProvider;
  51 import jdk.vm.ci.meta.ResolvedJavaMethod;
  52 import jdk.vm.ci.runtime.JVMCI;
  53 import jdk.vm.ci.runtime.JVMCIBackend;
  54 
  55 public abstract class AssemblerTest extends GraalTest {
  56 
  57     private final MetaAccessProvider metaAccess;
  58     protected final CodeCacheProvider codeCache;
  59     private final Backend backend;
  60 
  61     public interface CodeGenTest {
  62         byte[] generateCode(CompilationResult compResult, TargetDescription target, RegisterConfig registerConfig, CallingConvention cc);
  63     }
  64 
  65     public AssemblerTest() {
  66         JVMCIBackend providers = JVMCI.getRuntime().getHostJVMCIBackend();
  67         this.metaAccess = providers.getMetaAccess();
  68         this.codeCache = providers.getCodeCache();
  69         this.backend = Graal.getRequiredCapability(RuntimeProvider.class).getHostBackend();
  70     }
  71 
  72     public MetaAccessProvider getMetaAccess() {
  73         return metaAccess;
  74     }
  75 
  76     @SuppressWarnings("try")
  77     protected InstalledCode assembleMethod(Method m, CodeGenTest test) {
  78         ResolvedJavaMethod method = getMetaAccess().lookupJavaMethod(m);
  79         try (Scope s = Debug.scope("assembleMethod", method, codeCache)) {
  80             RegisterConfig registerConfig = codeCache.getRegisterConfig();
  81             CompilationIdentifier compilationId = backend.getCompilationIdentifier(method);
  82             CallingConvention cc = backend.newLIRGenerationResult(compilationId, null, null, new StructuredGraph(method, AllowAssumptions.NO, compilationId), null).getCallingConvention();
  83 
  84             CompilationResult compResult = new CompilationResult();
  85             byte[] targetCode = test.generateCode(compResult, codeCache.getTarget(), registerConfig, cc);
  86             compResult.setTargetCode(targetCode, targetCode.length);
  87             compResult.setTotalFrameSize(0);
  88             compResult.close();
  89 
  90             InstalledCode code = backend.addInstalledCode(method, asCompilationRequest(compilationId), compResult);
  91 
  92             for (DisassemblerProvider dis : GraalServices.load(DisassemblerProvider.class)) {
  93                 String disasm1 = dis.disassembleCompiledCode(codeCache, compResult);
  94                 Assert.assertTrue(compResult.toString(), disasm1 == null || disasm1.length() > 0);
  95                 String disasm2 = dis.disassembleInstalledCode(codeCache, compResult, code);
  96                 Assert.assertTrue(code.toString(), disasm2 == null || disasm2.length() > 0);
  97             }
  98             return code;
  99         } catch (Throwable e) {
 100             throw Debug.handle(e);
 101         }
 102     }
 103 
 104     protected Object runTest(String methodName, CodeGenTest test, Object... args) {
 105         Method method = getMethod(methodName);
 106         InstalledCode code = assembleMethod(method, test);
 107         try {
 108             return code.executeVarargs(args);
 109         } catch (InvalidInstalledCodeException e) {
 110             throw new RuntimeException(e);
 111         }
 112     }
 113 
 114     protected void assertReturn(String methodName, CodeGenTest test, Object expected, Object... args) {
 115         Object actual = runTest(methodName, test, args);
 116         Assert.assertEquals("unexpected return value", expected, actual);
 117     }
 118 }