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
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
|
//===- SPIRVModule.h - Class to represent a SPIR-V module -------*- C++ -*-===//
//
// 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.
//
//===----------------------------------------------------------------------===//
/// \file
///
/// This file defines Module class for SPIR-V.
///
//===----------------------------------------------------------------------===//
#ifndef SPIRV_LIBSPIRV_SPIRVMODULE_H
#define SPIRV_LIBSPIRV_SPIRVMODULE_H
#include "SPIRVEntry.h"
#include <iostream>
#include <set>
#include <string>
#include <unordered_map>
#include <unordered_set>
#include <vector>
namespace SPIRV {
class SPIRVBasicBlock;
class SPIRVConstant;
class SPIRVEntry;
class SPIRVFunction;
class SPIRVInstruction;
class SPIRVType;
class SPIRVTypeArray;
class SPIRVTypeBool;
class SPIRVTypeFloat;
class SPIRVTypeFunction;
class SPIRVTypeInt;
class SPIRVTypeOpaque;
class SPIRVTypePointer;
class SPIRVTypeImage;
class SPIRVTypeSampler;
class SPIRVTypeSampledImage;
class SPIRVTypePipeStorage;
class SPIRVTypeStruct;
class SPIRVTypeVector;
class SPIRVTypeVoid;
class SPIRVTypeDeviceEvent;
class SPIRVTypeQueue;
class SPIRVTypePipe;
class SPIRVValue;
class SPIRVVariable;
class SPIRVDecorateGeneric;
class SPIRVDecorationGroup;
class SPIRVGroupDecorate;
class SPIRVGroupMemberDecorate;
class SPIRVGroupDecorateGeneric;
class SPIRVInstTemplateBase;
typedef SPIRVBasicBlock SPIRVLabel;
struct SPIRVTypeImageDescriptor;
class SPIRVModule {
public:
typedef std::map<SPIRVCapabilityKind, SPIRVCapability *> SPIRVCapMap;
static SPIRVModule *createSPIRVModule();
SPIRVModule();
virtual ~SPIRVModule();
// Object query functions
virtual bool exist(SPIRVId) const = 0;
virtual bool exist(SPIRVId, SPIRVEntry **) const = 0;
template <class T> T *get(SPIRVId Id) const {
return static_cast<T *>(getEntry(Id));
}
virtual SPIRVEntry *getEntry(SPIRVId) const = 0;
virtual bool hasDebugInfo() const = 0;
// Error handling functions
virtual SPIRVErrorLog &getErrorLog() = 0;
virtual SPIRVErrorCode getError(std::string &) = 0;
// Module query functions
virtual SPIRVAddressingModelKind getAddressingModel() = 0;
virtual const SPIRVCapMap &getCapability() const = 0;
virtual bool hasCapability(SPIRVCapabilityKind) const = 0;
virtual SPIRVExtInstSetKind getBuiltinSet(SPIRVId) const = 0;
virtual SPIRVFunction *getEntryPoint(SPIRVExecutionModelKind,
unsigned) const = 0;
virtual std::set<std::string> &getExtension() = 0;
virtual SPIRVFunction *getFunction(unsigned) const = 0;
virtual SPIRVVariable *getVariable(unsigned) const = 0;
virtual SPIRVMemoryModelKind getMemoryModel() const = 0;
virtual unsigned getNumFunctions() const = 0;
virtual unsigned getNumEntryPoints(SPIRVExecutionModelKind) const = 0;
virtual unsigned getNumVariables() const = 0;
virtual SourceLanguage getSourceLanguage(SPIRVWord *) const = 0;
virtual std::set<std::string> &getSourceExtension() = 0;
virtual SPIRVValue *getValue(SPIRVId TheId) const = 0;
virtual std::vector<SPIRVValue *>
getValues(const std::vector<SPIRVId> &) const = 0;
virtual std::vector<SPIRVId>
getIds(const std::vector<SPIRVEntry *> &) const = 0;
virtual std::vector<SPIRVId>
getIds(const std::vector<SPIRVValue *> &) const = 0;
virtual SPIRVType *getValueType(SPIRVId TheId) const = 0;
virtual std::vector<SPIRVType *>
getValueTypes(const std::vector<SPIRVId> &) const = 0;
virtual SPIRVConstant *getLiteralAsConstant(unsigned Literal) = 0;
virtual bool isEntryPoint(SPIRVExecutionModelKind, SPIRVId) const = 0;
virtual unsigned short getGeneratorId() const = 0;
virtual unsigned short getGeneratorVer() const = 0;
virtual SPIRVWord getSPIRVVersion() const = 0;
// Module changing functions
virtual bool importBuiltinSet(const std::string &, SPIRVId *) = 0;
virtual bool importBuiltinSetWithId(const std::string &, SPIRVId) = 0;
virtual void setAddressingModel(SPIRVAddressingModelKind) = 0;
virtual void setAlignment(SPIRVValue *, SPIRVWord) = 0;
virtual void setMemoryModel(SPIRVMemoryModelKind) = 0;
virtual void setName(SPIRVEntry *, const std::string &) = 0;
virtual void setSourceLanguage(SourceLanguage, SPIRVWord) = 0;
virtual void optimizeDecorates() = 0;
virtual void setAutoAddCapability(bool E) { AutoAddCapability = E; }
virtual void setValidateCapability(bool E) { ValidateCapability = E; }
virtual void setGeneratorId(unsigned short) = 0;
virtual void setGeneratorVer(unsigned short) = 0;
virtual void resolveUnknownStructFields() = 0;
virtual void setSPIRVVersion(SPIRVWord) = 0;
void setMinSPIRVVersion(SPIRVWord Ver) {
setSPIRVVersion(std::max(Ver, getSPIRVVersion()));
}
// Object creation functions
template <class T> T *add(T *Entry) {
addEntry(Entry);
return Entry;
}
virtual SPIRVEntry *addEntry(SPIRVEntry *) = 0;
virtual SPIRVBasicBlock *addBasicBlock(SPIRVFunction *,
SPIRVId Id = SPIRVID_INVALID) = 0;
virtual SPIRVString *getString(const std::string &Str) = 0;
virtual SPIRVMemberName *addMemberName(SPIRVTypeStruct *ST,
SPIRVWord MemberNumber,
const std::string &Name) = 0;
virtual void addUnknownStructField(SPIRVTypeStruct *, unsigned idx,
SPIRVId id) = 0;
virtual void addLine(SPIRVEntry *E, SPIRVId FileNameId, SPIRVWord Line,
SPIRVWord Column) = 0;
virtual const std::shared_ptr<const SPIRVLine> &getCurrentLine() const = 0;
virtual void setCurrentLine(const std::shared_ptr<const SPIRVLine> &) = 0;
virtual const SPIRVDecorateGeneric *addDecorate(SPIRVDecorateGeneric *) = 0;
virtual SPIRVDecorationGroup *addDecorationGroup() = 0;
virtual SPIRVDecorationGroup *
addDecorationGroup(SPIRVDecorationGroup *Group) = 0;
virtual SPIRVGroupDecorate *
addGroupDecorate(SPIRVDecorationGroup *Group,
const std::vector<SPIRVEntry *> &Targets) = 0;
virtual SPIRVGroupMemberDecorate *
addGroupMemberDecorate(SPIRVDecorationGroup *Group,
const std::vector<SPIRVEntry *> &Targets) = 0;
virtual SPIRVGroupDecorateGeneric *
addGroupDecorateGeneric(SPIRVGroupDecorateGeneric *GDec) = 0;
virtual void addEntryPoint(SPIRVExecutionModelKind, SPIRVId) = 0;
virtual SPIRVForward *addForward(SPIRVType *Ty) = 0;
virtual SPIRVForward *addForward(SPIRVId, SPIRVType *Ty) = 0;
virtual SPIRVFunction *addFunction(SPIRVFunction *) = 0;
virtual SPIRVFunction *addFunction(SPIRVTypeFunction *,
SPIRVId Id = SPIRVID_INVALID) = 0;
virtual SPIRVEntry *replaceForward(SPIRVForward *, SPIRVEntry *) = 0;
virtual void eraseInstruction(SPIRVInstruction *, SPIRVBasicBlock *) = 0;
// Type creation functions
virtual SPIRVTypeArray *addArrayType(SPIRVType *, SPIRVConstant *) = 0;
virtual SPIRVTypeBool *addBoolType() = 0;
virtual SPIRVTypeFloat *addFloatType(unsigned) = 0;
virtual SPIRVTypeFunction *
addFunctionType(SPIRVType *, const std::vector<SPIRVType *> &) = 0;
virtual SPIRVTypeImage *addImageType(SPIRVType *,
const SPIRVTypeImageDescriptor &) = 0;
virtual SPIRVTypeImage *addImageType(SPIRVType *,
const SPIRVTypeImageDescriptor &,
SPIRVAccessQualifierKind) = 0;
virtual SPIRVTypeSampler *addSamplerType() = 0;
virtual SPIRVTypePipeStorage *addPipeStorageType() = 0;
virtual SPIRVTypeSampledImage *addSampledImageType(SPIRVTypeImage *T) = 0;
virtual SPIRVTypeInt *addIntegerType(unsigned) = 0;
virtual SPIRVTypeOpaque *addOpaqueType(const std::string &) = 0;
virtual SPIRVTypePointer *addPointerType(SPIRVStorageClassKind,
SPIRVType *) = 0;
virtual SPIRVTypeStruct *openStructType(unsigned, const std::string &) = 0;
virtual void closeStructType(SPIRVTypeStruct *, bool) = 0;
virtual SPIRVTypeVector *addVectorType(SPIRVType *, SPIRVWord) = 0;
virtual SPIRVTypeVoid *addVoidType() = 0;
virtual SPIRVType *addOpaqueGenericType(Op) = 0;
virtual SPIRVTypeDeviceEvent *addDeviceEventType() = 0;
virtual SPIRVTypeQueue *addQueueType() = 0;
virtual SPIRVTypePipe *addPipeType() = 0;
virtual void createForwardPointers() = 0;
// Constants creation functions
virtual SPIRVValue *
addCompositeConstant(SPIRVType *, const std::vector<SPIRVValue *> &) = 0;
virtual SPIRVValue *addConstant(SPIRVValue *) = 0;
virtual SPIRVValue *addConstant(SPIRVType *, uint64_t) = 0;
virtual SPIRVValue *addDoubleConstant(SPIRVTypeFloat *, double) = 0;
virtual SPIRVValue *addFloatConstant(SPIRVTypeFloat *, float) = 0;
virtual SPIRVValue *addIntegerConstant(SPIRVTypeInt *, uint64_t) = 0;
virtual SPIRVValue *addNullConstant(SPIRVType *) = 0;
virtual SPIRVValue *addUndef(SPIRVType *TheType) = 0;
virtual SPIRVValue *addSamplerConstant(SPIRVType *TheType, SPIRVWord AddrMode,
SPIRVWord ParametricMode,
SPIRVWord FilterMode) = 0;
virtual SPIRVValue *addPipeStorageConstant(SPIRVType *TheType,
SPIRVWord PacketSize,
SPIRVWord PacketAlign,
SPIRVWord Capacity) = 0;
// Instruction creation functions
virtual SPIRVInstruction *addPtrAccessChainInst(SPIRVType *, SPIRVValue *,
std::vector<SPIRVValue *>,
SPIRVBasicBlock *, bool) = 0;
virtual SPIRVInstruction *
addAsyncGroupCopy(SPIRVValue *Scope, SPIRVValue *Dest, SPIRVValue *Src,
SPIRVValue *NumElems, SPIRVValue *Stride, SPIRVValue *Event,
SPIRVBasicBlock *BB) = 0;
virtual SPIRVInstruction *addBinaryInst(Op, SPIRVType *, SPIRVValue *,
SPIRVValue *, SPIRVBasicBlock *) = 0;
virtual SPIRVInstruction *addBranchConditionalInst(SPIRVValue *, SPIRVLabel *,
SPIRVLabel *,
SPIRVBasicBlock *) = 0;
virtual SPIRVInstruction *addBranchInst(SPIRVLabel *, SPIRVBasicBlock *) = 0;
virtual SPIRVInstruction *addExtInst(SPIRVType *, SPIRVWord, SPIRVWord,
const std::vector<SPIRVWord> &,
SPIRVBasicBlock *) = 0;
virtual SPIRVInstruction *addExtInst(SPIRVType *, SPIRVWord, SPIRVWord,
const std::vector<SPIRVValue *> &,
SPIRVBasicBlock *) = 0;
virtual void addCapability(SPIRVCapabilityKind) = 0;
template <typename T> void addCapabilities(const T &Caps) {
for (auto I : Caps)
addCapability(I);
}
/// Used by SPIRV entries to add required capability internally.
/// Should not be used by users directly.
virtual void addCapabilityInternal(SPIRVCapabilityKind) = 0;
virtual SPIRVInstruction *addCallInst(SPIRVFunction *,
const std::vector<SPIRVWord> &,
SPIRVBasicBlock *) = 0;
virtual SPIRVInstruction *
addCompositeConstructInst(SPIRVType *, const std::vector<SPIRVId> &,
SPIRVBasicBlock *) = 0;
virtual SPIRVInstruction *
addCompositeExtractInst(SPIRVType *, SPIRVValue *,
const std::vector<SPIRVWord> &,
SPIRVBasicBlock *) = 0;
virtual SPIRVInstruction *
addCompositeInsertInst(SPIRVValue *, SPIRVValue *,
const std::vector<SPIRVWord> &, SPIRVBasicBlock *) = 0;
virtual SPIRVInstruction *addCopyObjectInst(SPIRVType *, SPIRVValue *,
SPIRVBasicBlock *) = 0;
virtual SPIRVInstruction *addCopyMemoryInst(SPIRVValue *, SPIRVValue *,
const std::vector<SPIRVWord> &,
SPIRVBasicBlock *) = 0;
virtual SPIRVInstruction *
addCopyMemorySizedInst(SPIRVValue *, SPIRVValue *, SPIRVValue *,
const std::vector<SPIRVWord> &, SPIRVBasicBlock *) = 0;
virtual SPIRVInstruction *addCmpInst(Op, SPIRVType *, SPIRVValue *,
SPIRVValue *, SPIRVBasicBlock *) = 0;
virtual SPIRVInstruction *addControlBarrierInst(SPIRVValue *ExecKind,
SPIRVValue *MemKind,
SPIRVValue *MemSema,
SPIRVBasicBlock *BB) = 0;
virtual SPIRVInstruction *addGroupInst(Op OpCode, SPIRVType *Type,
Scope Scope,
const std::vector<SPIRVValue *> &Ops,
SPIRVBasicBlock *BB) = 0;
virtual SPIRVInstTemplateBase *addInstTemplate(Op OC, SPIRVBasicBlock *BB,
SPIRVType *Ty) = 0;
virtual SPIRVInstTemplateBase *
addInstTemplate(Op OC, const std::vector<SPIRVWord> &Ops, SPIRVBasicBlock *BB,
SPIRVType *Ty) = 0;
virtual SPIRVInstruction *addLoadInst(SPIRVValue *,
const std::vector<SPIRVWord> &,
SPIRVBasicBlock *) = 0;
virtual SPIRVInstruction *addLifetimeInst(Op OC, SPIRVValue *Object,
SPIRVWord Size,
SPIRVBasicBlock *BB) = 0;
virtual SPIRVInstruction *addMemoryBarrierInst(Scope ScopeKind,
SPIRVWord MemFlag,
SPIRVBasicBlock *BB) = 0;
virtual SPIRVInstruction *addPhiInst(SPIRVType *, std::vector<SPIRVValue *>,
SPIRVBasicBlock *) = 0;
virtual SPIRVInstruction *addUnreachableInst(SPIRVBasicBlock *) = 0;
virtual SPIRVInstruction *addReturnInst(SPIRVBasicBlock *) = 0;
virtual SPIRVInstruction *addReturnValueInst(SPIRVValue *,
SPIRVBasicBlock *) = 0;
virtual SPIRVInstruction *addSelectInst(SPIRVValue *, SPIRVValue *,
SPIRVValue *, SPIRVBasicBlock *) = 0;
virtual SPIRVInstruction *addSelectionMergeInst(SPIRVId MergeBlock,
SPIRVWord SelectionControl,
SPIRVBasicBlock *BB) = 0;
virtual SPIRVInstruction *addLoopMergeInst(SPIRVId MergeBlock,
SPIRVId ContinueTarget,
SPIRVWord LoopControl,
SPIRVBasicBlock *BB) = 0;
virtual SPIRVInstruction *addStoreInst(SPIRVValue *, SPIRVValue *,
const std::vector<SPIRVWord> &,
SPIRVBasicBlock *) = 0;
virtual SPIRVInstruction *addSwitchInst(
SPIRVValue *, SPIRVBasicBlock *,
const std::vector<std::pair<std::vector<SPIRVWord>, SPIRVBasicBlock *>> &,
SPIRVBasicBlock *) = 0;
virtual SPIRVInstruction *addFModInst(SPIRVType *TheType, SPIRVId TheDividend,
SPIRVId TheDivisor,
SPIRVBasicBlock *BB) = 0;
virtual SPIRVInstruction *addVectorTimesScalarInst(SPIRVType *TheType,
SPIRVId TheVector,
SPIRVId TheScalar,
SPIRVBasicBlock *BB) = 0;
virtual SPIRVInstruction *addUnaryInst(Op, SPIRVType *, SPIRVValue *,
SPIRVBasicBlock *) = 0;
virtual SPIRVInstruction *addVariable(SPIRVType *, bool, SPIRVLinkageTypeKind,
SPIRVValue *, const std::string &,
SPIRVStorageClassKind,
SPIRVBasicBlock *) = 0;
virtual SPIRVValue *
addVectorShuffleInst(SPIRVType *Type, SPIRVValue *Vec1, SPIRVValue *Vec2,
const std::vector<SPIRVWord> &Components,
SPIRVBasicBlock *BB) = 0;
virtual SPIRVInstruction *addVectorExtractDynamicInst(SPIRVValue *,
SPIRVValue *,
SPIRVBasicBlock *) = 0;
virtual SPIRVInstruction *addVectorInsertDynamicInst(SPIRVValue *,
SPIRVValue *,
SPIRVValue *,
SPIRVBasicBlock *) = 0;
// I/O functions
friend spv_ostream &operator<<(spv_ostream &O, SPIRVModule &M);
friend std::istream &operator>>(std::istream &I, SPIRVModule &M);
protected:
bool AutoAddCapability;
bool ValidateCapability;
};
class SPIRVDbgInfo {
public:
SPIRVDbgInfo(SPIRVModule *TM);
std::string getEntryPointFileStr(SPIRVExecutionModelKind, unsigned);
std::string getFunctionFileStr(SPIRVFunction *);
unsigned getFunctionLineNo(SPIRVFunction *);
private:
std::unordered_map<SPIRVFunction *, SPIRVLine *> FuncMap;
const std::string ModuleFileStr;
SPIRVModule *M;
};
#ifdef _SPIRV_SUPPORT_TEXT_FMT
/// Convert SPIR-V between binary and internel text formats.
/// This function is not thread safe and should not be used in multi-thread
/// applications unless guarded by a critical section.
bool ConvertSPIRV(std::istream &IS, spv_ostream &OS, std::string &ErrMsg,
bool FromText, bool ToText);
/// Convert SPIR-V between binary and internel text formats.
/// This function is not thread safe and should not be used in multi-thread
/// applications unless guarded by a critical section.
bool ConvertSPIRV(std::string &Input, std::string &Out, std::string &ErrMsg,
bool ToText);
#endif
} // namespace SPIRV
#endif // SPIRV_LIBSPIRV_SPIRVMODULE_H
|
