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);
161 Id getId() { return instructions.front()->getResultId(); }
163 Function& getParent() const { return parent; }
164 void addInstruction(std::unique_ptr<Instruction> inst);
165 void addPredecessor(Block* pred) { predecessors.push_back(pred); }
166 void addLocalVariable(std::unique_ptr<Instruction> inst) { localVariables.push_back(std::move(inst)); }
167 int getNumPredecessors() const { return (int)predecessors.size(); }
168 void setUnreachable() { unreachable = true; }
169 bool isUnreachable() const { return unreachable; }
171 bool isTerminated() const
173 switch (instructions.back()->getOpCode()) {
175 case OpBranchConditional:
186 void dump(std::vector<unsigned int>& out) const
188 // skip the degenerate unreachable blocks
189 // TODO: code gen: skip all unreachable blocks (transitive closure)
190 // (but, until that's done safer to keep non-degenerate unreachable blocks, in case others depend on something)
191 if (unreachable && instructions.size() <= 2)
194 instructions[0]->dump(out);
195 for (int i = 0; i < (int)localVariables.size(); ++i)
196 localVariables[i]->dump(out);
197 for (int i = 1; i < (int)instructions.size(); ++i)
198 instructions[i]->dump(out);
203 Block& operator=(Block&);
205 // To enforce keeping parent and ownership in sync:
208 std::vector<std::unique_ptr<Instruction> > instructions;
209 std::vector<Block*> predecessors;
210 std::vector<std::unique_ptr<Instruction> > localVariables;
213 // track whether this block is known to be uncreachable (not necessarily
214 // true for all unreachable blocks, but should be set at least
215 // for the extraneous ones introduced by the builder).
220 // SPIR-V IR Function.
225 Function(Id id, Id resultType, Id functionType, Id firstParam, Module& parent);
228 for (int i = 0; i < (int)parameterInstructions.size(); ++i)
229 delete parameterInstructions[i];
231 for (int i = 0; i < (int)blocks.size(); ++i)
234 Id getId() const { return functionInstruction.getResultId(); }
235 Id getParamId(int p) { return parameterInstructions[p]->getResultId(); }
237 void addBlock(Block* block) { blocks.push_back(block); }
238 void popBlock(Block*) { blocks.pop_back(); }
240 Module& getParent() const { return parent; }
241 Block* getEntryBlock() const { return blocks.front(); }
242 Block* getLastBlock() const { return blocks.back(); }
243 void addLocalVariable(std::unique_ptr<Instruction> inst);
244 Id getReturnType() const { return functionInstruction.getTypeId(); }
245 void dump(std::vector<unsigned int>& out) const
248 functionInstruction.dump(out);
250 // OpFunctionParameter
251 for (int p = 0; p < (int)parameterInstructions.size(); ++p)
252 parameterInstructions[p]->dump(out);
255 for (int b = 0; b < (int)blocks.size(); ++b)
256 blocks[b]->dump(out);
257 Instruction end(0, 0, OpFunctionEnd);
262 Function(const Function&);
263 Function& operator=(Function&);
266 Instruction functionInstruction;
267 std::vector<Instruction*> parameterInstructions;
268 std::vector<Block*> blocks;
280 // TODO delete things
283 void addFunction(Function *fun) { functions.push_back(fun); }
285 void mapInstruction(Instruction *instruction)
287 spv::Id resultId = instruction->getResultId();
288 // map the instruction's result id
289 if (resultId >= idToInstruction.size())
290 idToInstruction.resize(resultId + 16);
291 idToInstruction[resultId] = instruction;
294 Instruction* getInstruction(Id id) const { return idToInstruction[id]; }
295 spv::Id getTypeId(Id resultId) const { return idToInstruction[resultId]->getTypeId(); }
296 StorageClass getStorageClass(Id typeId) const
298 assert(idToInstruction[typeId]->getOpCode() == spv::OpTypePointer);
299 return (StorageClass)idToInstruction[typeId]->getImmediateOperand(0);
302 void dump(std::vector<unsigned int>& out) const
304 for (int f = 0; f < (int)functions.size(); ++f)
305 functions[f]->dump(out);
309 Module(const Module&);
310 std::vector<Function*> functions;
312 // map from result id to instruction having that result id
313 std::vector<Instruction*> idToInstruction;
315 // map from a result id to its type id
319 // Implementation (it's here due to circular type definitions).
323 // - the OpFunction instruction
324 // - all the OpFunctionParameter instructions
325 __inline Function::Function(Id id, Id resultType, Id functionType, Id firstParamId, Module& parent)
326 : parent(parent), functionInstruction(id, resultType, OpFunction)
329 functionInstruction.addImmediateOperand(FunctionControlMaskNone);
330 functionInstruction.addIdOperand(functionType);
331 parent.mapInstruction(&functionInstruction);
332 parent.addFunction(this);
334 // OpFunctionParameter
335 Instruction* typeInst = parent.getInstruction(functionType);
336 int numParams = typeInst->getNumOperands() - 1;
337 for (int p = 0; p < numParams; ++p) {
338 Instruction* param = new Instruction(firstParamId + p, typeInst->getIdOperand(p + 1), OpFunctionParameter);
339 parent.mapInstruction(param);
340 parameterInstructions.push_back(param);
344 __inline void Function::addLocalVariable(std::unique_ptr<Instruction> inst)
346 Instruction* raw_instruction = inst.get();
347 blocks[0]->addLocalVariable(std::move(inst));
348 parent.mapInstruction(raw_instruction);
351 __inline Block::Block(Id id, Function& parent) : parent(parent), unreachable(false)
353 instructions.push_back(std::unique_ptr<Instruction>(new Instruction(id, NoType, OpLabel)));
356 __inline void Block::addInstruction(std::unique_ptr<Instruction> inst)
358 Instruction* raw_instruction = inst.get();
359 instructions.push_back(std::move(inst));
360 if (raw_instruction->getResultId())
361 parent.getParent().mapInstruction(raw_instruction);
364 }; // end spv namespace