SPIRV/spvIR.h

   1 //
   2 //Copyright (C) 2014 LunarG, Inc.
   3 //
   4 //All rights reserved.
   5 //
   6 //Redistribution and use in source and binary forms, with or without
   7 //modification, are permitted provided that the following conditions
   8 //are met:
   9 //
  10 //    Redistributions of source code must retain the above copyright
  11 //    notice, this list of conditions and the following disclaimer.
  12 //
  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.
  17 //
  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.
  21 //
  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.
  34
  35 //
  36 // Author: John Kessenich, LunarG
  37 //
  38
  39 // SPIRV-IR
  40 //
  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
  46 //        - Instruction
  47 //
  48
  49 #pragma once
  50 #ifndef spvIR_H
  51 #define spvIR_H
  52
  53 #include "spirv.hpp"
  54
  55 #include <algorithm>
  56 #include <cassert>
  57 #include <functional>
  58 #include <iostream>
  59 #include <memory>
  60 #include <vector>
  61
  62 namespace spv {
  63
  64 class Block;
  65 class Function;
  66 class Module;
  67
  68 const Id NoResult = 0;
  69 const Id NoType = 0;
  70
  71 const unsigned int BadValue = 0xFFFFFFFF;
  72 const Decoration NoPrecision = (Decoration)BadValue;
  73 const MemorySemanticsMask MemorySemanticsAllMemory =
  74                 (MemorySemanticsMask)(MemorySemanticsAcquireMask |
  75                                       MemorySemanticsReleaseMask |
  76                                       MemorySemanticsAcquireReleaseMask |
  77                                       MemorySemanticsSequentiallyConsistentMask |
  78                                       MemorySemanticsUniformMemoryMask |
  79                                       MemorySemanticsSubgroupMemoryMask |
  80                                       MemorySemanticsWorkgroupMemoryMask |
  81                                       MemorySemanticsCrossWorkgroupMemoryMask |
  82                                       MemorySemanticsAtomicCounterMemoryMask |
  83                                       MemorySemanticsImageMemoryMask);
  84
  85 //
  86 // SPIR-V IR instruction.
  87 //
  88
  89 class Instruction {
  90 public:
  91     Instruction(Id resultId, Id typeId, Op opCode) : resultId(resultId), typeId(typeId), opCode(opCode), block(nullptr) { }
  92     explicit Instruction(Op opCode) : resultId(NoResult), typeId(NoType), opCode(opCode), block(nullptr) { }
  93     virtual ~Instruction() {}
  94     void addIdOperand(Id id) { operands.push_back(id); }
  95     void addImmediateOperand(unsigned int immediate) { operands.push_back(immediate); }
  96     void addStringOperand(const char* str)
  97     {
  98         originalString = str;
  99         unsigned int word;
 100         char* wordString = (char*)&word;
 101         char* wordPtr = wordString;
 102         int charCount = 0;
 103         char c;
 104         do {
 105             c = *(str++);
 106             *(wordPtr++) = c;
 107             ++charCount;
 108             if (charCount == 4) {
 109                 addImmediateOperand(word);
 110                 wordPtr = wordString;
 111                 charCount = 0;
 112             }
 113         } while (c != 0);
 114
 115         // deal with partial last word
 116         if (charCount > 0) {
 117             // pad with 0s
 118             for (; charCount < 4; ++charCount)
 119                 *(wordPtr++) = 0;
 120             addImmediateOperand(word);
 121         }
 122     }
 123     void setBlock(Block* b) { block = b; }
 124     Block* getBlock() const { return block; }
 125     Op getOpCode() const { return opCode; }
 126     int getNumOperands() const { return (int)operands.size(); }
 127     Id getResultId() const { return resultId; }
 128     Id getTypeId() const { return typeId; }
 129     Id getIdOperand(int op) const { return operands[op]; }
 130     unsigned int getImmediateOperand(int op) const { return operands[op]; }
 131     const char* getStringOperand() const { return originalString.c_str(); }
 132
 133     // Write out the binary form.
 134     void dump(std::vector<unsigned int>& out) const
 135     {
 136         // Compute the wordCount
 137         unsigned int wordCount = 1;
 138         if (typeId)
 139             ++wordCount;
 140         if (resultId)
 141             ++wordCount;
 142         wordCount += (unsigned int)operands.size();
 143
 144         // Write out the beginning of the instruction
 145         out.push_back(((wordCount) << WordCountShift) | opCode);
 146         if (typeId)
 147             out.push_back(typeId);
 148         if (resultId)
 149             out.push_back(resultId);
 150
 151         // Write out the operands
 152         for (int op = 0; op < (int)operands.size(); ++op)
 153             out.push_back(operands[op]);
 154     }
 155
 156 protected:
 157     Instruction(const Instruction&);
 158     Id resultId;
 159     Id typeId;
 160     Op opCode;
 161     std::vector<Id> operands;
 162     std::string originalString;        // could be optimized away; convenience for getting string operand
 163     Block* block;
 164 };
 165
 166 //
 167 // SPIR-V IR block.
 168 //
 169
 170 class Block {
 171 public:
 172     Block(Id id, Function& parent);
 173     virtual ~Block()
 174     {
 175     }
 176
 177     Id getId() { return instructions.front()->getResultId(); }
 178
 179     Function& getParent() const { return parent; }
 180     void addInstruction(std::unique_ptr<Instruction> inst);
 181     void addPredecessor(Block* pred) { predecessors.push_back(pred); pred->successors.push_back(this);}
 182     void addLocalVariable(std::unique_ptr<Instruction> inst) { localVariables.push_back(std::move(inst)); }
 183     const std::vector<Block*>& getPredecessors() const { return predecessors; }
 184     const std::vector<Block*>& getSuccessors() const { return successors; }
 185     void setUnreachable() { unreachable = true; }
 186     bool isUnreachable() const { return unreachable; }
 187     // Returns the block's merge instruction, if one exists (otherwise null).
 188     const Instruction* getMergeInstruction() const {
 189         if (instructions.size() < 2) return nullptr;
 190         const Instruction* nextToLast = (instructions.cend() - 2)->get();
 191         switch (nextToLast->getOpCode()) {
 192             case OpSelectionMerge:
 193             case OpLoopMerge:
 194                 return nextToLast;
 195             default:
 196                 return nullptr;
 197         }
 198         return nullptr;
 199     }
 200
 201     bool isTerminated() const
 202     {
 203         switch (instructions.back()->getOpCode()) {
 204         case OpBranch:
 205         case OpBranchConditional:
 206         case OpSwitch:
 207         case OpKill:
 208         case OpReturn:
 209         case OpReturnValue:
 210             return true;
 211         default:
 212             return false;
 213         }
 214     }
 215
 216     void dump(std::vector<unsigned int>& out) const
 217     {
 218         instructions[0]->dump(out);
 219         for (int i = 0; i < (int)localVariables.size(); ++i)
 220             localVariables[i]->dump(out);
 221         for (int i = 1; i < (int)instructions.size(); ++i)
 222             instructions[i]->dump(out);
 223     }
 224
 225 protected:
 226     Block(const Block&);
 227     Block& operator=(Block&);
 228
 229     // To enforce keeping parent and ownership in sync:
 230     friend Function;
 231
 232     std::vector<std::unique_ptr<Instruction> > instructions;
 233     std::vector<Block*> predecessors, successors;
 234     std::vector<std::unique_ptr<Instruction> > localVariables;
 235     Function& parent;
 236
 237     // track whether this block is known to be uncreachable (not necessarily
 238     // true for all unreachable blocks, but should be set at least
 239     // for the extraneous ones introduced by the builder).
 240     bool unreachable;
 241 };
 242
 243 // Traverses the control-flow graph rooted at root in an order suited for
 244 // readable code generation.  Invokes callback at every node in the traversal
 245 // order.
 246 void inReadableOrder(Block* root, std::function<void(Block*)> callback);
 247
 248 //
 249 // SPIR-V IR Function.
 250 //
 251
 252 class Function {
 253 public:
 254     Function(Id id, Id resultType, Id functionType, Id firstParam, Module& parent);
 255     virtual ~Function()
 256     {
 257         for (int i = 0; i < (int)parameterInstructions.size(); ++i)
 258             delete parameterInstructions[i];
 259
 260         for (int i = 0; i < (int)blocks.size(); ++i)
 261             delete blocks[i];
 262     }
 263     Id getId() const { return functionInstruction.getResultId(); }
 264     Id getParamId(int p) { return parameterInstructions[p]->getResultId(); }
 265
 266     void addBlock(Block* block) { blocks.push_back(block); }
 267     void removeBlock(Block* block)
 268     {
 269         auto found = find(blocks.begin(), blocks.end(), block);
 270         assert(found != blocks.end());
 271         blocks.erase(found);
 272         delete block;
 273     }
 274
 275     Module& getParent() const { return parent; }
 276     Block* getEntryBlock() const { return blocks.front(); }
 277     Block* getLastBlock() const { return blocks.back(); }
 278     void addLocalVariable(std::unique_ptr<Instruction> inst);
 279     Id getReturnType() const { return functionInstruction.getTypeId(); }
 280     void dump(std::vector<unsigned int>& out) const
 281     {
 282         // OpFunction
 283         functionInstruction.dump(out);
 284
 285         // OpFunctionParameter
 286         for (int p = 0; p < (int)parameterInstructions.size(); ++p)
 287             parameterInstructions[p]->dump(out);
 288
 289         // Blocks
 290         inReadableOrder(blocks[0], [&out](const Block* b) { b->dump(out); });
 291         Instruction end(0, 0, OpFunctionEnd);
 292         end.dump(out);
 293     }
 294
 295 protected:
 296     Function(const Function&);
 297     Function& operator=(Function&);
 298
 299     Module& parent;
 300     Instruction functionInstruction;
 301     std::vector<Instruction*> parameterInstructions;
 302     std::vector<Block*> blocks;
 303 };
 304
 305 //
 306 // SPIR-V IR Module.
 307 //
 308
 309 class Module {
 310 public:
 311     Module() {}
 312     virtual ~Module()
 313     {
 314         // TODO delete things
 315     }
 316
 317     void addFunction(Function *fun) { functions.push_back(fun); }
 318
 319     void mapInstruction(Instruction *instruction)
 320     {
 321         spv::Id resultId = instruction->getResultId();
 322         // map the instruction's result id
 323         if (resultId >= idToInstruction.size())
 324             idToInstruction.resize(resultId + 16);
 325         idToInstruction[resultId] = instruction;
 326     }
 327
 328     Instruction* getInstruction(Id id) const { return idToInstruction[id]; }
 329     spv::Id getTypeId(Id resultId) const { return idToInstruction[resultId]->getTypeId(); }
 330     StorageClass getStorageClass(Id typeId) const
 331     {
 332         assert(idToInstruction[typeId]->getOpCode() == spv::OpTypePointer);
 333         return (StorageClass)idToInstruction[typeId]->getImmediateOperand(0);
 334     }
 335
 336     void dump(std::vector<unsigned int>& out) const
 337     {
 338         for (int f = 0; f < (int)functions.size(); ++f)
 339             functions[f]->dump(out);
 340     }
 341
 342 protected:
 343     Module(const Module&);
 344     std::vector<Function*> functions;
 345
 346     // map from result id to instruction having that result id
 347     std::vector<Instruction*> idToInstruction;
 348
 349     // map from a result id to its type id
 350 };
 351
 352 //
 353 // Implementation (it's here due to circular type definitions).
 354 //
 355
 356 // Add both
 357 // - the OpFunction instruction
 358 // - all the OpFunctionParameter instructions
 359 __inline Function::Function(Id id, Id resultType, Id functionType, Id firstParamId, Module& parent)
 360     : parent(parent), functionInstruction(id, resultType, OpFunction)
 361 {
 362     // OpFunction
 363     functionInstruction.addImmediateOperand(FunctionControlMaskNone);
 364     functionInstruction.addIdOperand(functionType);
 365     parent.mapInstruction(&functionInstruction);
 366     parent.addFunction(this);
 367
 368     // OpFunctionParameter
 369     Instruction* typeInst = parent.getInstruction(functionType);
 370     int numParams = typeInst->getNumOperands() - 1;
 371     for (int p = 0; p < numParams; ++p) {
 372         Instruction* param = new Instruction(firstParamId + p, typeInst->getIdOperand(p + 1), OpFunctionParameter);
 373         parent.mapInstruction(param);
 374         parameterInstructions.push_back(param);
 375     }
 376 }
 377
 378 __inline void Function::addLocalVariable(std::unique_ptr<Instruction> inst)
 379 {
 380     Instruction* raw_instruction = inst.get();
 381     blocks[0]->addLocalVariable(std::move(inst));
 382     parent.mapInstruction(raw_instruction);
 383 }
 384
 385 __inline Block::Block(Id id, Function& parent) : parent(parent), unreachable(false)
 386 {
 387     instructions.push_back(std::unique_ptr<Instruction>(new Instruction(id, NoType, OpLabel)));
 388     instructions.back()->setBlock(this);
 389     parent.getParent().mapInstruction(instructions.back().get());
 390 }
 391
 392 __inline void Block::addInstruction(std::unique_ptr<Instruction> inst)
 393 {
 394     Instruction* raw_instruction = inst.get();
 395     instructions.push_back(std::move(inst));
 396     raw_instruction->setBlock(this);
 397     if (raw_instruction->getResultId())
 398         parent.getParent().mapInstruction(raw_instruction);
 399 }
 400
 401 };  // end spv namespace
 402
 403 #endif // spvIR_H