2 //Copyright (C) 2014 LunarG, Inc.
6 //Redistribution and use in source and binary forms, with or without
7 //modification, are permitted provided that the following conditions
10 // Redistributions of source code must retain the above copyright
11 // notice, this list of conditions and the following disclaimer.
13 // Redistributions in binary form must reproduce the above
14 // copyright notice, this list of conditions and the following
15 // disclaimer in the documentation and/or other materials provided
16 // with the distribution.
18 // Neither the name of 3Dlabs Inc. Ltd. nor the names of its
19 // contributors may be used to endorse or promote products derived
20 // from this software without specific prior written permission.
22 //THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 //"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 //LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25 //FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
26 //COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27 //INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
28 //BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29 //LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
30 //CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 //LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
32 //ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33 //POSSIBILITY OF SUCH DAMAGE.
36 // Author: John Kessenich, LunarG
41 // Simple in-memory representation (IR) of SPIRV. Just for holding
42 // Each function's CFG of blocks. Has this hierarchy:
43 // - Module, which is a list of
44 // - Function, which is a list of
45 // - Block, which is a list of
65 const Id NoResult = 0;
68 const unsigned int BadValue = 0xFFFFFFFF;
69 const Decoration NoPrecision = (Decoration)BadValue;
70 const MemorySemanticsMask MemorySemanticsAllMemory = (MemorySemanticsMask)0x3FF;
73 // SPIR-V IR instruction.
78 Instruction(Id resultId, Id typeId, Op opCode) : resultId(resultId), typeId(typeId), opCode(opCode) { }
79 explicit Instruction(Op opCode) : resultId(NoResult), typeId(NoType), opCode(opCode) { }
80 virtual ~Instruction() {}
81 void addIdOperand(Id id) { operands.push_back(id); }
82 void addImmediateOperand(unsigned int immediate) { operands.push_back(immediate); }
83 void addStringOperand(const char* str)
87 char* wordString = (char*)&word;
88 char* wordPtr = wordString;
96 addImmediateOperand(word);
102 // deal with partial last word
105 for (; charCount < 4; ++charCount)
107 addImmediateOperand(word);
110 Op getOpCode() const { return opCode; }
111 int getNumOperands() const { return (int)operands.size(); }
112 Id getResultId() const { return resultId; }
113 Id getTypeId() const { return typeId; }
114 Id getIdOperand(int op) const { return operands[op]; }
115 unsigned int getImmediateOperand(int op) const { return operands[op]; }
116 const char* getStringOperand() const { return originalString.c_str(); }
118 // Write out the binary form.
119 void dump(std::vector<unsigned int>& out) const
121 // Compute the wordCount
122 unsigned int wordCount = 1;
127 wordCount += (unsigned int)operands.size();
129 // Write out the beginning of the instruction
130 out.push_back(((wordCount) << WordCountShift) | opCode);
132 out.push_back(typeId);
134 out.push_back(resultId);
136 // Write out the operands
137 for (int op = 0; op < (int)operands.size(); ++op)
138 out.push_back(operands[op]);
142 Instruction(const Instruction&);
146 std::vector<Id> operands;
147 std::string originalString; // could be optimized away; convenience for getting string operand
156 Block(Id id, Function& parent);
159 // TODO: free instructions
162 Id getId() { return instructions.front()->getResultId(); }
164 Function& getParent() const { return parent; }
165 void addInstruction(Instruction* inst);
166 void addPredecessor(Block* pred) { predecessors.push_back(pred); }
167 void addLocalVariable(Instruction* inst) { localVariables.push_back(inst); }
168 int getNumPredecessors() const { return (int)predecessors.size(); }
169 void setUnreachable() { unreachable = true; }
170 bool isUnreachable() const { return unreachable; }
172 bool isTerminated() const
174 switch (instructions.back()->getOpCode()) {
176 case OpBranchConditional:
187 void dump(std::vector<unsigned int>& out) const
189 // skip the degenerate unreachable blocks
190 // TODO: code gen: skip all unreachable blocks (transitive closure)
191 // (but, until that's done safer to keep non-degenerate unreachable blocks, in case others depend on something)
192 if (unreachable && instructions.size() <= 2)
195 instructions[0]->dump(out);
196 for (int i = 0; i < (int)localVariables.size(); ++i)
197 localVariables[i]->dump(out);
198 for (int i = 1; i < (int)instructions.size(); ++i)
199 instructions[i]->dump(out);
204 Block& operator=(Block&);
206 // To enforce keeping parent and ownership in sync:
209 std::vector<Instruction*> instructions;
210 std::vector<Block*> predecessors;
211 std::vector<Instruction*> localVariables;
214 // track whether this block is known to be uncreachable (not necessarily
215 // true for all unreachable blocks, but should be set at least
216 // for the extraneous ones introduced by the builder).
221 // SPIR-V IR Function.
226 Function(Id id, Id resultType, Id functionType, Id firstParam, Module& parent);
229 for (int i = 0; i < (int)parameterInstructions.size(); ++i)
230 delete parameterInstructions[i];
232 for (int i = 0; i < (int)blocks.size(); ++i)
235 Id getId() const { return functionInstruction.getResultId(); }
236 Id getParamId(int p) { return parameterInstructions[p]->getResultId(); }
238 void addBlock(Block* block) { blocks.push_back(block); }
239 void removeBlock(Block* block)
241 auto found = find(blocks.begin(), blocks.end(), block);
242 assert(found != blocks.end());
247 Module& getParent() const { return parent; }
248 Block* getEntryBlock() const { return blocks.front(); }
249 Block* getLastBlock() const { return blocks.back(); }
250 void addLocalVariable(Instruction* inst);
251 Id getReturnType() const { return functionInstruction.getTypeId(); }
252 void dump(std::vector<unsigned int>& out) const
255 functionInstruction.dump(out);
257 // OpFunctionParameter
258 for (int p = 0; p < (int)parameterInstructions.size(); ++p)
259 parameterInstructions[p]->dump(out);
262 for (int b = 0; b < (int)blocks.size(); ++b)
263 blocks[b]->dump(out);
264 Instruction end(0, 0, OpFunctionEnd);
269 Function(const Function&);
270 Function& operator=(Function&);
273 Instruction functionInstruction;
274 std::vector<Instruction*> parameterInstructions;
275 std::vector<Block*> blocks;
287 // TODO delete things
290 void addFunction(Function *fun) { functions.push_back(fun); }
292 void mapInstruction(Instruction *instruction)
294 spv::Id resultId = instruction->getResultId();
295 // map the instruction's result id
296 if (resultId >= idToInstruction.size())
297 idToInstruction.resize(resultId + 16);
298 idToInstruction[resultId] = instruction;
301 Instruction* getInstruction(Id id) const { return idToInstruction[id]; }
302 spv::Id getTypeId(Id resultId) const { return idToInstruction[resultId]->getTypeId(); }
303 StorageClass getStorageClass(Id typeId) const
305 assert(idToInstruction[typeId]->getOpCode() == spv::OpTypePointer);
306 return (StorageClass)idToInstruction[typeId]->getImmediateOperand(0);
309 void dump(std::vector<unsigned int>& out) const
311 for (int f = 0; f < (int)functions.size(); ++f)
312 functions[f]->dump(out);
316 Module(const Module&);
317 std::vector<Function*> functions;
319 // map from result id to instruction having that result id
320 std::vector<Instruction*> idToInstruction;
322 // map from a result id to its type id
326 // Implementation (it's here due to circular type definitions).
330 // - the OpFunction instruction
331 // - all the OpFunctionParameter instructions
332 __inline Function::Function(Id id, Id resultType, Id functionType, Id firstParamId, Module& parent)
333 : parent(parent), functionInstruction(id, resultType, OpFunction)
336 functionInstruction.addImmediateOperand(FunctionControlMaskNone);
337 functionInstruction.addIdOperand(functionType);
338 parent.mapInstruction(&functionInstruction);
339 parent.addFunction(this);
341 // OpFunctionParameter
342 Instruction* typeInst = parent.getInstruction(functionType);
343 int numParams = typeInst->getNumOperands() - 1;
344 for (int p = 0; p < numParams; ++p) {
345 Instruction* param = new Instruction(firstParamId + p, typeInst->getIdOperand(p + 1), OpFunctionParameter);
346 parent.mapInstruction(param);
347 parameterInstructions.push_back(param);
351 __inline void Function::addLocalVariable(Instruction* inst)
353 blocks[0]->addLocalVariable(inst);
354 parent.mapInstruction(inst);
357 __inline Block::Block(Id id, Function& parent) : parent(parent), unreachable(false)
359 instructions.push_back(new Instruction(id, NoType, OpLabel));
362 __inline void Block::addInstruction(Instruction* inst)
364 instructions.push_back(inst);
365 if (inst->getResultId())
366 parent.getParent().mapInstruction(inst);
369 }; // end spv namespace