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 <vector>
  56 #include <iostream>
  57 #include <memory>
  58 #include <assert.h>
  59
  60 namespace spv {
  61
  62 class Function;
  63 class Module;
  64
  65 const Id NoResult = 0;
  66 const Id NoType = 0;
  67
  68 const unsigned int BadValue = 0xFFFFFFFF;
  69 const Decoration NoPrecision = (Decoration)BadValue;
  70 const MemorySemanticsMask MemorySemanticsAllMemory = (MemorySemanticsMask)0x3FF;
  71
  72 //
  73 // SPIR-V IR instruction.
  74 //
  75
  76 class Instruction {
  77 public:
  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)
  84     {
  85         originalString = str;
  86         unsigned int word;
  87         char* wordString = (char*)&word;
  88         char* wordPtr = wordString;
  89         int charCount = 0;
  90         char c;
  91         do {
  92             c = *(str++);
  93             *(wordPtr++) = c;
  94             ++charCount;
  95             if (charCount == 4) {
  96                 addImmediateOperand(word);
  97                 wordPtr = wordString;
  98                 charCount = 0;
  99             }
 100         } while (c != 0);
 101
 102         // deal with partial last word
 103         if (charCount > 0) {
 104             // pad with 0s
 105             for (; charCount < 4; ++charCount)
 106                 *(wordPtr++) = 0;
 107             addImmediateOperand(word);
 108         }
 109     }
 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(); }
 117
 118     // Write out the binary form.
 119     void dump(std::vector<unsigned int>& out) const
 120     {
 121         // Compute the wordCount
 122         unsigned int wordCount = 1;
 123         if (typeId)
 124             ++wordCount;
 125         if (resultId)
 126             ++wordCount;
 127         wordCount += (unsigned int)operands.size();
 128
 129         // Write out the beginning of the instruction
 130         out.push_back(((wordCount) << WordCountShift) | opCode);
 131         if (typeId)
 132             out.push_back(typeId);
 133         if (resultId)
 134             out.push_back(resultId);
 135
 136         // Write out the operands
 137         for (int op = 0; op < (int)operands.size(); ++op)
 138             out.push_back(operands[op]);
 139     }
 140
 141 protected:
 142     Instruction(const Instruction&);
 143     Id resultId;
 144     Id typeId;
 145     Op opCode;
 146     std::vector<Id> operands;
 147     std::string originalString;        // could be optimized away; convenience for getting string operand
 148 };
 149
 150 //
 151 // SPIR-V IR block.
 152 //
 153
 154 class Block {
 155 public:
 156     Block(Id id, Function& parent);
 157     virtual ~Block()
 158     {
 159     }
 160
 161     Id getId() { return instructions.front()->getResultId(); }
 162
 163     Function& getParent() const { return parent; }
 164     void addInstruction(std::unique_ptr<Instruction> inst);
 165     void addPredecessor(Block* pred) { predecessors.push_back(pred); pred->successors.push_back(this);}
 166     void addLocalVariable(std::unique_ptr<Instruction> inst) { localVariables.push_back(std::move(inst)); }
 167     const std::vector<Block*> getPredecessors() const { return predecessors; }
 168     const std::vector<Block*> getSuccessors() const { return successors; }
 169     void setUnreachable() { unreachable = true; }
 170     bool isUnreachable() const { return unreachable; }
 171
 172     bool isTerminated() const
 173     {
 174         switch (instructions.back()->getOpCode()) {
 175         case OpBranch:
 176         case OpBranchConditional:
 177         case OpSwitch:
 178         case OpKill:
 179         case OpReturn:
 180         case OpReturnValue:
 181             return true;
 182         default:
 183             return false;
 184         }
 185     }
 186
 187     void dump(std::vector<unsigned int>& out) const
 188     {
 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)
 193             return;
 194
 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);
 200     }
 201
 202 protected:
 203     Block(const Block&);
 204     Block& operator=(Block&);
 205
 206     // To enforce keeping parent and ownership in sync:
 207     friend Function;
 208
 209     std::vector<std::unique_ptr<Instruction> > instructions;
 210     std::vector<Block*> predecessors, successors;
 211     std::vector<std::unique_ptr<Instruction> > localVariables;
 212     Function& parent;
 213
 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).
 217     bool unreachable;
 218 };
 219
 220 //
 221 // SPIR-V IR Function.
 222 //
 223
 224 class Function {
 225 public:
 226     Function(Id id, Id resultType, Id functionType, Id firstParam, Module& parent);
 227     virtual ~Function()
 228     {
 229         for (int i = 0; i < (int)parameterInstructions.size(); ++i)
 230             delete parameterInstructions[i];
 231
 232         for (int i = 0; i < (int)blocks.size(); ++i)
 233             delete blocks[i];
 234     }
 235     Id getId() const { return functionInstruction.getResultId(); }
 236     Id getParamId(int p) { return parameterInstructions[p]->getResultId(); }
 237
 238     void addBlock(Block* block) { blocks.push_back(block); }
 239     void popBlock(Block*) { blocks.pop_back(); }
 240
 241     Module& getParent() const { return parent; }
 242     Block* getEntryBlock() const { return blocks.front(); }
 243     Block* getLastBlock() const { return blocks.back(); }
 244     void addLocalVariable(std::unique_ptr<Instruction> inst);
 245     Id getReturnType() const { return functionInstruction.getTypeId(); }
 246     void dump(std::vector<unsigned int>& out) const
 247     {
 248         // OpFunction
 249         functionInstruction.dump(out);
 250
 251         // OpFunctionParameter
 252         for (int p = 0; p < (int)parameterInstructions.size(); ++p)
 253             parameterInstructions[p]->dump(out);
 254
 255         // Blocks
 256         for (int b = 0; b < (int)blocks.size(); ++b)
 257             blocks[b]->dump(out);
 258         Instruction end(0, 0, OpFunctionEnd);
 259         end.dump(out);
 260     }
 261
 262 protected:
 263     Function(const Function&);
 264     Function& operator=(Function&);
 265
 266     Module& parent;
 267     Instruction functionInstruction;
 268     std::vector<Instruction*> parameterInstructions;
 269     std::vector<Block*> blocks;
 270 };
 271
 272 //
 273 // SPIR-V IR Module.
 274 //
 275
 276 class Module {
 277 public:
 278     Module() {}
 279     virtual ~Module()
 280     {
 281         // TODO delete things
 282     }
 283
 284     void addFunction(Function *fun) { functions.push_back(fun); }
 285
 286     void mapInstruction(Instruction *instruction)
 287     {
 288         spv::Id resultId = instruction->getResultId();
 289         // map the instruction's result id
 290         if (resultId >= idToInstruction.size())
 291             idToInstruction.resize(resultId + 16);
 292         idToInstruction[resultId] = instruction;
 293     }
 294
 295     Instruction* getInstruction(Id id) const { return idToInstruction[id]; }
 296     spv::Id getTypeId(Id resultId) const { return idToInstruction[resultId]->getTypeId(); }
 297     StorageClass getStorageClass(Id typeId) const
 298     {
 299         assert(idToInstruction[typeId]->getOpCode() == spv::OpTypePointer);
 300         return (StorageClass)idToInstruction[typeId]->getImmediateOperand(0);
 301     }
 302
 303     void dump(std::vector<unsigned int>& out) const
 304     {
 305         for (int f = 0; f < (int)functions.size(); ++f)
 306             functions[f]->dump(out);
 307     }
 308
 309 protected:
 310     Module(const Module&);
 311     std::vector<Function*> functions;
 312
 313     // map from result id to instruction having that result id
 314     std::vector<Instruction*> idToInstruction;
 315
 316     // map from a result id to its type id
 317 };
 318
 319 //
 320 // Implementation (it's here due to circular type definitions).
 321 //
 322
 323 // Add both
 324 // - the OpFunction instruction
 325 // - all the OpFunctionParameter instructions
 326 __inline Function::Function(Id id, Id resultType, Id functionType, Id firstParamId, Module& parent)
 327     : parent(parent), functionInstruction(id, resultType, OpFunction)
 328 {
 329     // OpFunction
 330     functionInstruction.addImmediateOperand(FunctionControlMaskNone);
 331     functionInstruction.addIdOperand(functionType);
 332     parent.mapInstruction(&functionInstruction);
 333     parent.addFunction(this);
 334
 335     // OpFunctionParameter
 336     Instruction* typeInst = parent.getInstruction(functionType);
 337     int numParams = typeInst->getNumOperands() - 1;
 338     for (int p = 0; p < numParams; ++p) {
 339         Instruction* param = new Instruction(firstParamId + p, typeInst->getIdOperand(p + 1), OpFunctionParameter);
 340         parent.mapInstruction(param);
 341         parameterInstructions.push_back(param);
 342     }
 343 }
 344
 345 __inline void Function::addLocalVariable(std::unique_ptr<Instruction> inst)
 346 {
 347     Instruction* raw_instruction = inst.get();
 348     blocks[0]->addLocalVariable(std::move(inst));
 349     parent.mapInstruction(raw_instruction);
 350 }
 351
 352 __inline Block::Block(Id id, Function& parent) : parent(parent), unreachable(false)
 353 {
 354     instructions.push_back(std::unique_ptr<Instruction>(new Instruction(id, NoType, OpLabel)));
 355 }
 356
 357 __inline void Block::addInstruction(std::unique_ptr<Instruction> inst)
 358 {
 359   Instruction* raw_instruction = inst.get();
 360     instructions.push_back(std::move(inst));
 361     if (raw_instruction->getResultId())
 362         parent.getParent().mapInstruction(raw_instruction);
 363 }
 364
 365 };  // end spv namespace
 366
 367 #endif // spvIR_H