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