forked from KhronosGroup/SPIRV-LLVM-Translator
-
Notifications
You must be signed in to change notification settings - Fork 0
/
SPIRVToOCL20.cpp
364 lines (322 loc) · 13.6 KB
/
SPIRVToOCL20.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
//===- SPIRVToOCL20.cpp - Transform SPIR-V builtins to OCL20 builtins------===//
//
// The LLVM/SPIRV Translator
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
// Copyright (c) 2014 Advanced Micro Devices, Inc. All rights reserved.
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal with the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimers.
// Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimers in the documentation
// and/or other materials provided with the distribution.
// Neither the names of Advanced Micro Devices, Inc., nor the names of its
// contributors may be used to endorse or promote products derived from this
// Software without specific prior written permission.
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS WITH
// THE SOFTWARE.
//
//===----------------------------------------------------------------------===//
//
// This file implements transform SPIR-V builtins to OCL 2.0 builtins.
//
//===----------------------------------------------------------------------===//
#define DEBUG_TYPE "spvtocl20"
#include "OCLUtil.h"
#include "SPIRVToOCL.h"
#include "llvm/IR/Verifier.h"
namespace SPIRV {
char SPIRVToOCL20Legacy::ID = 0;
bool SPIRVToOCL20Legacy::runOnModule(Module &Module) {
return SPIRVToOCL20Base::runSPIRVToOCL(Module);
}
bool SPIRVToOCL20Base::runSPIRVToOCL(Module &Module) {
M = &Module;
Ctx = &M->getContext();
// Lower builtin variables to builtin calls first.
lowerBuiltinVariablesToCalls(M);
translateOpaqueTypes();
visit(*M);
postProcessBuiltinsReturningStruct(M);
postProcessBuiltinsWithArrayArguments(M);
eraseUselessFunctions(&Module);
LLVM_DEBUG(dbgs() << "After SPIRVToOCL20:\n" << *M);
std::string Err;
raw_string_ostream ErrorOS(Err);
if (verifyModule(*M, &ErrorOS)) {
LLVM_DEBUG(errs() << "Fails to verify module: " << ErrorOS.str());
}
return true;
}
void SPIRVToOCL20Base::visitCallSPIRVMemoryBarrier(CallInst *CI) {
AttributeList Attrs = CI->getCalledFunction()->getAttributes();
mutateCallInstOCL(
M, CI,
[=](CallInst *, std::vector<Value *> &Args) {
Value *MemScope =
SPIRV::transSPIRVMemoryScopeIntoOCLMemoryScope(Args[0], CI);
Value *MemFenceFlags =
SPIRV::transSPIRVMemorySemanticsIntoOCLMemFenceFlags(Args[1], CI);
Value *MemOrder =
SPIRV::transSPIRVMemorySemanticsIntoOCLMemoryOrder(Args[1], CI);
Args.resize(3);
Args[0] = MemFenceFlags;
Args[1] = MemOrder;
Args[2] = MemScope;
return kOCLBuiltinName::AtomicWorkItemFence;
},
&Attrs);
}
void SPIRVToOCL20Base::visitCallSPIRVControlBarrier(CallInst *CI) {
AttributeList Attrs = CI->getCalledFunction()->getAttributes();
SmallVector<AttributeSet, 2> ArgAttrs = {Attrs.getParamAttrs(1),
Attrs.getParamAttrs(2)};
AttributeList NewAttrs = AttributeList::get(*Ctx, Attrs.getFnAttrs(),
Attrs.getRetAttrs(), ArgAttrs);
mutateCallInstOCL(
M, CI,
[=](CallInst *, std::vector<Value *> &Args) {
auto GetArg = [=](unsigned I) {
return cast<ConstantInt>(Args[I])->getZExtValue();
};
auto ExecScope = static_cast<Scope>(GetArg(0));
Value *MemScope =
getInt32(M, rmap<OCLScopeKind>(static_cast<Scope>(GetArg(1))));
Value *MemFenceFlags =
SPIRV::transSPIRVMemorySemanticsIntoOCLMemFenceFlags(Args[2], CI);
Args.resize(2);
Args[0] = MemFenceFlags;
Args[1] = MemScope;
return (ExecScope == ScopeWorkgroup) ? kOCLBuiltinName::WorkGroupBarrier
: kOCLBuiltinName::SubGroupBarrier;
},
&NewAttrs);
}
std::string SPIRVToOCL20Base::mapFPAtomicName(Op OC) {
assert(isFPAtomicOpCode(OC) && "Not intended to handle other opcodes than "
"AtomicF{Add/Min/Max}EXT!");
switch (OC) {
case OpAtomicFAddEXT:
return "atomic_fetch_add_explicit";
case OpAtomicFMinEXT:
return "atomic_fetch_min_explicit";
case OpAtomicFMaxEXT:
return "atomic_fetch_max_explicit";
default:
llvm_unreachable("Unsupported opcode!");
}
}
Instruction *SPIRVToOCL20Base::mutateAtomicName(CallInst *CI, Op OC) {
AttributeList Attrs = CI->getCalledFunction()->getAttributes();
return mutateCallInstOCL(
M, CI,
[=](CallInst *, std::vector<Value *> &Args) {
// Map fp atomic instructions to regular OpenCL built-ins.
if (isFPAtomicOpCode(OC))
return mapFPAtomicName(OC);
return OCLSPIRVBuiltinMap::rmap(OC);
},
&Attrs);
}
Instruction *SPIRVToOCL20Base::visitCallSPIRVAtomicBuiltin(CallInst *CI,
Op OC) {
CallInst *CIG = mutateCommonAtomicArguments(CI, OC);
Instruction *NewCI = nullptr;
switch (OC) {
case OpAtomicIIncrement:
case OpAtomicIDecrement:
NewCI = visitCallSPIRVAtomicIncDec(CIG, OC);
break;
case OpAtomicCompareExchange:
case OpAtomicCompareExchangeWeak:
NewCI = visitCallSPIRVAtomicCmpExchg(CIG);
break;
default:
NewCI = mutateAtomicName(CIG, OC);
}
return NewCI;
}
Instruction *SPIRVToOCL20Base::visitCallSPIRVAtomicIncDec(CallInst *CI, Op OC) {
AttributeList Attrs = CI->getCalledFunction()->getAttributes();
return mutateCallInstOCL(
M, CI,
[=](CallInst *, std::vector<Value *> &Args) {
// Since OpenCL 2.0 doesn't have atomic_inc and atomic_dec builtins,
// we translate these instructions to atomic_fetch_add_explicit and
// atomic_fetch_sub_explicit OpenCL 2.0 builtins with "operand" argument
// = 1.
auto Name = OCLSPIRVBuiltinMap::rmap(
OC == OpAtomicIIncrement ? OpAtomicIAdd : OpAtomicISub);
Type *ValueTy = CI->getType();
assert(ValueTy->isIntegerTy());
Args.insert(Args.begin() + 1, llvm::ConstantInt::get(ValueTy, 1));
return Name;
},
&Attrs);
}
CallInst *SPIRVToOCL20Base::mutateCommonAtomicArguments(CallInst *CI, Op OC) {
assert(CI->getCalledFunction() && "Unexpected indirect call");
AttributeList Attrs = CI->getCalledFunction()->getAttributes();
return mutateCallInstOCL(
M, CI,
[=](CallInst *, std::vector<Value *> &Args) {
for (size_t I = 0; I < Args.size(); ++I) {
Value *PtrArg = Args[I];
Type *PtrArgTy = PtrArg->getType();
if (PtrArgTy->isPointerTy()) {
if (PtrArgTy->getPointerAddressSpace() != SPIRAS_Generic) {
Type *FixedPtr = PointerType::getWithSamePointeeType(
cast<PointerType>(PtrArgTy), SPIRAS_Generic);
Args[I] = CastInst::CreatePointerBitCastOrAddrSpaceCast(
PtrArg, FixedPtr, PtrArg->getName() + ".as", CI);
}
}
}
auto Ptr = findFirstPtr(Args);
std::string Name;
// Map fp atomic instructions to regular OpenCL built-ins.
if (isFPAtomicOpCode(OC))
Name = mapFPAtomicName(OC);
else
Name = OCLSPIRVBuiltinMap::rmap(OC);
auto NumOrder = getSPIRVAtomicBuiltinNumMemoryOrderArgs(OC);
auto ScopeIdx = Ptr + 1;
auto OrderIdx = Ptr + 2;
Args[ScopeIdx] =
SPIRV::transSPIRVMemoryScopeIntoOCLMemoryScope(Args[ScopeIdx], CI);
for (size_t I = 0; I < NumOrder; ++I) {
Args[OrderIdx + I] =
SPIRV::transSPIRVMemorySemanticsIntoOCLMemoryOrder(
Args[OrderIdx + I], CI);
}
std::swap(Args[ScopeIdx], Args.back());
return Name;
},
&Attrs);
}
Instruction *SPIRVToOCL20Base::visitCallSPIRVAtomicCmpExchg(CallInst *CI) {
assert(CI->getCalledFunction() && "Unexpected indirect call");
AttributeList Attrs = CI->getCalledFunction()->getAttributes();
Instruction *PInsertBefore = CI;
Type *MemTy = CI->getType();
return mutateCallInstOCL(
M, CI,
[=](CallInst *, std::vector<Value *> &Args, Type *&RetTy) {
// OpAtomicCompareExchange[Weak] semantics is different from
// atomic_compare_exchange_strong semantics as well as
// arguments order.
// OCL built-ins returns boolean value and stores a new/original
// value by pointer passed as 2nd argument (aka expected) while SPIR-V
// instructions returns this new/original value as a resulting value.
AllocaInst *PExpected = new AllocaInst(MemTy, 0, "expected",
&(*PInsertBefore->getParent()
->getParent()
->getEntryBlock()
.getFirstInsertionPt()));
PExpected->setAlignment(Align(MemTy->getScalarSizeInBits() / 8));
new StoreInst(Args[1], PExpected, PInsertBefore);
unsigned AddrSpc = SPIRAS_Generic;
Type *PtrTyAS = PointerType::getWithSamePointeeType(
cast<PointerType>(PExpected->getType()), AddrSpc);
Args[1] = CastInst::CreatePointerBitCastOrAddrSpaceCast(
PExpected, PtrTyAS, PExpected->getName() + ".as", PInsertBefore);
std::swap(Args[3], Args[4]);
std::swap(Args[2], Args[3]);
RetTy = Type::getInt1Ty(*Ctx);
// OpAtomicCompareExchangeWeak is not "weak" at all, but instead has
// the same semantics as OpAtomicCompareExchange.
return "atomic_compare_exchange_strong_explicit";
},
[=](CallInst *CI) -> Instruction * {
// OCL built-ins atomic_compare_exchange_[strong|weak] return boolean
// value. So, to obtain the same value as SPIR-V instruction is
// returning it has to be loaded from the memory where 'expected'
// value is stored. This memory must contain the needed value after a
// call to OCL built-in is completed.
return new LoadInst(MemTy, CI->getArgOperand(1), "original",
PInsertBefore);
},
&Attrs);
}
void SPIRVToOCL20Base::visitCallSPIRVEnqueueKernel(CallInst *CI, Op OC) {
assert(CI->getCalledFunction() && "Unexpected indirect call");
AttributeList Attrs = CI->getCalledFunction()->getAttributes();
Instruction *PInsertBefore = CI;
mutateCallInstOCL(
M, CI,
[=](CallInst *, std::vector<Value *> &Args) {
bool HasVaargs = Args.size() > 10;
bool HasEvents = true;
Value *EventRet = Args[5];
if (isa<ConstantPointerNull>(EventRet)) {
Value *NumEvents = Args[3];
if (isa<ConstantInt>(NumEvents)) {
ConstantInt *NE = cast<ConstantInt>(NumEvents);
HasEvents = NE->getZExtValue() != 0;
}
}
Value *Invoke = Args[6];
auto *Int8PtrTyGen = Type::getInt8PtrTy(*Ctx, SPIRAS_Generic);
Args[6] = CastInst::CreatePointerBitCastOrAddrSpaceCast(
Invoke, Int8PtrTyGen, "", PInsertBefore);
// Don't remove arguments immediately, just mark them as removed with
// nullptr, and remove them at the end of processing. It allows for
// easier understanding of which argument is going to be removed.
auto MarkAsRemoved = [&Args](size_t Start, size_t End) {
assert(Start <= End);
for (size_t I = Start; I < End; I++)
Args[I] = nullptr;
};
if (!HasEvents) {
// Mark arguments at indices 3 (Num Events), 4 (Wait Events), 5 (Ret
// Event) as removed.
MarkAsRemoved(3, 6);
}
if (!HasVaargs) {
// Mark arguments at indices 8 (Param Size), 9 (Param Align) as
// removed.
MarkAsRemoved(8, 10);
} else {
// GEP to array of sizes of local arguments
Value *GEP = Args[10];
size_t NumLocalArgs = Args.size() - 10;
// Mark all SPIRV-specific arguments as removed
MarkAsRemoved(8, Args.size());
Type *Int32Ty = Type::getInt32Ty(*Ctx);
Args[8] = ConstantInt::get(Int32Ty, NumLocalArgs);
Args[9] = GEP;
}
Args.erase(std::remove(Args.begin(), Args.end(), nullptr), Args.end());
std::string FName = "";
if (!HasVaargs && !HasEvents)
FName = "__enqueue_kernel_basic";
else if (!HasVaargs && HasEvents)
FName = "__enqueue_kernel_basic_events";
else if (HasVaargs && !HasEvents)
FName = "__enqueue_kernel_varargs";
else
FName = "__enqueue_kernel_events_varargs";
return FName;
},
&Attrs);
}
} // namespace SPIRV
INITIALIZE_PASS(SPIRVToOCL20Legacy, "spvtoocl20",
"Translate SPIR-V builtins to OCL 2.0 builtins", false, false)
ModulePass *llvm::createSPIRVToOCL20Legacy() {
return new SPIRVToOCL20Legacy();
}