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