1 /*
   2  * Copyright (c) 2016, 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 
  26 package org.graalvm.compiler.hotspot.amd64.test;
  27 
  28 import static org.graalvm.compiler.lir.LIRInstruction.OperandFlag.REG;
  29 
  30 import org.graalvm.compiler.api.replacements.Snippet;
  31 import org.graalvm.compiler.asm.amd64.AMD64Address;
  32 import org.graalvm.compiler.asm.amd64.AMD64MacroAssembler;
  33 import org.graalvm.compiler.bytecode.BytecodeProvider;
  34 import org.graalvm.compiler.core.common.LIRKind;
  35 import org.graalvm.compiler.core.common.spi.ForeignCallDescriptor;
  36 import org.graalvm.compiler.core.common.type.DataPointerConstant;
  37 import org.graalvm.compiler.hotspot.HotSpotForeignCallLinkage;
  38 import org.graalvm.compiler.hotspot.meta.HotSpotForeignCallsProviderImpl;
  39 import org.graalvm.compiler.hotspot.meta.HotSpotProviders;
  40 import org.graalvm.compiler.hotspot.stubs.SnippetStub;
  41 import org.graalvm.compiler.lir.LIRInstructionClass;
  42 import org.graalvm.compiler.lir.Variable;
  43 import org.graalvm.compiler.lir.amd64.AMD64LIRInstruction;
  44 import org.graalvm.compiler.lir.asm.ArrayDataPointerConstant;
  45 import org.graalvm.compiler.lir.asm.CompilationResultBuilder;
  46 import org.graalvm.compiler.lir.gen.LIRGeneratorTool;
  47 import org.graalvm.compiler.lir.jtt.LIRTest;
  48 import org.graalvm.compiler.lir.jtt.LIRTestSpecification;
  49 import org.graalvm.compiler.nodes.extended.ForeignCallNode;
  50 import org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderConfiguration;
  51 import org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderContext;
  52 import org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugin;
  53 import org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugins;
  54 import org.graalvm.compiler.options.OptionValues;
  55 import org.graalvm.compiler.replacements.ReplacementsImpl;
  56 import org.graalvm.compiler.replacements.classfile.ClassfileBytecodeProvider;
  57 import org.junit.Assume;
  58 import org.junit.Before;
  59 import org.junit.Test;
  60 
  61 import jdk.vm.ci.amd64.AMD64;
  62 import jdk.vm.ci.amd64.AMD64.CPUFeature;
  63 import jdk.vm.ci.amd64.AMD64Kind;
  64 import jdk.vm.ci.code.Register;
  65 import jdk.vm.ci.code.ValueUtil;
  66 import jdk.vm.ci.meta.AllocatableValue;
  67 import jdk.vm.ci.meta.MetaAccessProvider;
  68 import jdk.vm.ci.meta.ResolvedJavaMethod;
  69 import jdk.vm.ci.meta.Value;
  70 import org.graalvm.compiler.hotspot.HotSpotBackend;
  71 
  72 public class StubAVXTest extends LIRTest {
  73 
  74     @Before
  75     public void checkAMD64() {
  76         Assume.assumeTrue("skipping AMD64 specific test", getTarget().arch instanceof AMD64);
  77         Assume.assumeTrue("skipping AVX test", ((AMD64) getTarget().arch).getFeatures().contains(CPUFeature.AVX));
  78         if (getBackend() instanceof HotSpotBackend) {
  79             HotSpotBackend backend = (HotSpotBackend) getBackend();
  80             Assume.assumeTrue("skipping because of MaxVectorSize", backend.getRuntime().getVMConfig().maxVectorSize >= 32);
  81         }
  82     }
  83 
  84     private static final DataPointerConstant avxConstant = new ArrayDataPointerConstant(new float[]{1f, 2f, 3f, 4f, 5f, 6f, 7f, 8f}, 32);
  85 
  86     private static class LoadAVXConstant extends AMD64LIRInstruction {
  87         public static final LIRInstructionClass<LoadAVXConstant> TYPE = LIRInstructionClass.create(LoadAVXConstant.class);
  88 
  89         @Def({REG}) AllocatableValue result;
  90 
  91         LoadAVXConstant(AllocatableValue result) {
  92             super(TYPE);
  93             this.result = result;
  94         }
  95 
  96         @Override
  97         public void emitCode(CompilationResultBuilder crb, AMD64MacroAssembler masm) {
  98             masm.vmovdqu(ValueUtil.asRegister(result), (AMD64Address) crb.recordDataReferenceInCode(avxConstant));
  99         }
 100     }
 101 
 102     private static final LIRTestSpecification loadAVXConstant = new LIRTestSpecification() {
 103 
 104         @Override
 105         public void generate(LIRGeneratorTool gen) {
 106             Variable ret = gen.newVariable(LIRKind.value(AMD64Kind.V256_SINGLE));
 107             gen.append(new LoadAVXConstant(ret));
 108             setResult(ret);
 109         }
 110     };
 111 
 112     @LIRIntrinsic
 113     public static Object loadAVXConstant(@SuppressWarnings("unused") LIRTestSpecification spec) {
 114         return null;
 115     }
 116 
 117     private static class CompareAVXRegister extends AMD64LIRInstruction {
 118         public static final LIRInstructionClass<CompareAVXRegister> TYPE = LIRInstructionClass.create(CompareAVXRegister.class);
 119 
 120         @Def({REG}) AllocatableValue result;
 121         @Use({REG}) AllocatableValue left;
 122         @Use({REG}) AllocatableValue right;
 123         @Temp({REG}) AllocatableValue temp;
 124 
 125         CompareAVXRegister(AllocatableValue result, AllocatableValue left, AllocatableValue right, AllocatableValue temp) {
 126             super(TYPE);
 127             this.result = result;
 128             this.left = left;
 129             this.right = right;
 130             this.temp = temp;
 131         }
 132 
 133         private static int getRXB(Register reg, Register rm) {
 134             int rxb = (reg.encoding & 0x08) >> 1;
 135             rxb |= (rm.encoding & 0x08) >> 3;
 136             return rxb;
 137         }
 138 
 139         @Override
 140         public void emitCode(CompilationResultBuilder crb, AMD64MacroAssembler masm) {
 141             Register res = ValueUtil.asRegister(result);
 142             Register x = ValueUtil.asRegister(left);
 143             Register y = ValueUtil.asRegister(right);
 144             Register tmp = ValueUtil.asRegister(temp);
 145 
 146             // VEX.NDS.256.0F.WIG C2 /r ib(0)
 147             // VCMPPS tmp, x, y, EQ
 148             masm.emitByte(0xC4);                                   // VEX 3-byte
 149             masm.emitByte((~getRXB(tmp, y) & 0x7) << 5 | 0x01);    // RXB m-mmmmm (0F)
 150             masm.emitByte(((~x.encoding & 0x0f) << 3) | 0b1_00);   // W(0) vvvv L(1) pp(0)
 151             masm.emitByte(0xC2);
 152             masm.emitByte(0xC0 | ((tmp.encoding & 0x07) << 3) | (y.encoding & 0x07));
 153             masm.emitByte(0);
 154 
 155             // VEX.256.0F.WIG 50 /r
 156             // VMOVMSKPS res, tmp
 157             masm.emitByte(0xC4);                                   // VEX 3-byte
 158             masm.emitByte((~getRXB(res, tmp) & 0x7) << 5 | 0x01);  // RXB m-mmmmm (0F)
 159             masm.emitByte(0b0_1111_1_00);                          // W(0) vvvv L(1) pp(0)
 160             masm.emitByte(0x50);
 161             masm.emitByte(0xC0 | ((res.encoding & 0x07) << 3) | (tmp.encoding & 0x07));
 162         }
 163     }
 164 
 165     private static final LIRTestSpecification compareAVXRegister = new LIRTestSpecification() {
 166 
 167         @Override
 168         public void generate(LIRGeneratorTool gen, Value arg0, Value arg1) {
 169             Variable ret = gen.newVariable(LIRKind.value(AMD64Kind.DWORD));
 170             gen.append(new CompareAVXRegister(ret, gen.asAllocatable(arg0), gen.asAllocatable(arg1), gen.newVariable(LIRKind.value(AMD64Kind.V256_QWORD))));
 171             setResult(ret);
 172         }
 173     };
 174 
 175     private static class TestStub extends SnippetStub {
 176 
 177         TestStub(OptionValues options, HotSpotProviders providers, HotSpotForeignCallLinkage linkage) {
 178             super("testStub", options, providers, linkage);
 179         }
 180 
 181         @Snippet
 182         static void testStub() {
 183         }
 184 
 185         @Override
 186         protected BytecodeProvider getReplacementsBytecodeProvider() {
 187             ReplacementsImpl d = (ReplacementsImpl) providers.getReplacements();
 188             MetaAccessProvider metaAccess = d.providers.getMetaAccess();
 189             return new ClassfileBytecodeProvider(metaAccess, d.snippetReflection, ClassLoader.getSystemClassLoader());
 190         }
 191     }
 192 
 193     public static final ForeignCallDescriptor TEST_STUB = new ForeignCallDescriptor("test_stub", void.class);
 194 
 195     @LIRIntrinsic
 196     public static int compareAVXRegister(@SuppressWarnings("unused") LIRTestSpecification spec, Object left, Object right) {
 197         return left == right ? 0xff : 0;
 198     }
 199 
 200     @Override
 201     protected GraphBuilderConfiguration editGraphBuilderConfiguration(GraphBuilderConfiguration conf) {
 202         InvocationPlugins invocationPlugins = conf.getPlugins().getInvocationPlugins();
 203         InvocationPlugins.Registration r = new InvocationPlugins.Registration(invocationPlugins, TestStub.class);
 204         r.register0("testStub", new InvocationPlugin() {
 205             @Override
 206             public boolean apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, InvocationPlugin.Receiver receiver) {
 207                 b.add(new ForeignCallNode(getProviders().getForeignCalls(), TEST_STUB));
 208                 return true;
 209             }
 210         });
 211         return super.editGraphBuilderConfiguration(conf);
 212     }
 213 
 214     public static int testStub() {
 215         Object preStub = loadAVXConstant(loadAVXConstant);
 216 
 217         // do something to potentially destroy the value
 218         TestStub.testStub();
 219 
 220         Object postStub = loadAVXConstant(loadAVXConstant);
 221         return compareAVXRegister(compareAVXRegister, preStub, postStub);
 222     }
 223 
 224     @Test
 225     public void test() {
 226         HotSpotProviders providers = (HotSpotProviders) getProviders();
 227         HotSpotForeignCallsProviderImpl foreignCalls = (HotSpotForeignCallsProviderImpl) providers.getForeignCalls();
 228         HotSpotForeignCallLinkage linkage = foreignCalls.registerStubCall(TEST_STUB, HotSpotForeignCallLinkage.Transition.LEAF_NOFP, HotSpotForeignCallLinkage.Reexecutability.REEXECUTABLE);
 229         linkage.setCompiledStub(new TestStub(getInitialOptions(), providers, linkage));
 230         runTest("testStub");
 231     }
 232 }