1 // 2 // Copyright (C) 2015 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 #ifndef SPIRVREMAPPER_H 37 #define SPIRVREMAPPER_H 38 39 #include <string> 40 #include <vector> 41 #include <cstdlib> 42 #include <exception> 43 44 namespace spv { 45 46 // MSVC defines __cplusplus as an older value, even when it supports almost all of 11. 47 // We handle that here by making our own symbol. 48 #if __cplusplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1700) 49 # define use_cpp11 1 50 #endif 51 52 class spirvbin_base_t 53 { 54 public: 55 enum Options { 56 NONE = 0, 57 STRIP = (1<<0), 58 MAP_TYPES = (1<<1), 59 MAP_NAMES = (1<<2), 60 MAP_FUNCS = (1<<3), 61 DCE_FUNCS = (1<<4), 62 DCE_VARS = (1<<5), 63 DCE_TYPES = (1<<6), 64 OPT_LOADSTORE = (1<<7), 65 OPT_FWD_LS = (1<<8), // EXPERIMENTAL: PRODUCES INVALID SCHEMA-0 SPIRV 66 MAP_ALL = (MAP_TYPES | MAP_NAMES | MAP_FUNCS), 67 DCE_ALL = (DCE_FUNCS | DCE_VARS | DCE_TYPES), 68 OPT_ALL = (OPT_LOADSTORE), 69 70 ALL_BUT_STRIP = (MAP_ALL | DCE_ALL | OPT_ALL), 71 DO_EVERYTHING = (STRIP | ALL_BUT_STRIP) 72 }; 73 }; 74 75 } // namespace SPV 76 77 #if !defined (use_cpp11) 78 #include <cstdio> 79 #include <cstdint> 80 81 namespace spv { 82 class spirvbin_t : public spirvbin_base_t 83 { 84 public: spirvbin_t(int)85 spirvbin_t(int /*verbose = 0*/) { } 86 remap(std::vector<std::uint32_t> &,unsigned int)87 void remap(std::vector<std::uint32_t>& /*spv*/, unsigned int /*opts = 0*/) 88 { 89 printf("Tool not compiled for C++11, which is required for SPIR-V remapping.\n"); 90 exit(5); 91 } 92 }; 93 94 } // namespace SPV 95 96 #else // defined (use_cpp11) 97 98 #include <functional> 99 #include <cstdint> 100 #include <unordered_map> 101 #include <unordered_set> 102 #include <map> 103 #include <set> 104 #include <cassert> 105 106 #include "spirv.hpp" 107 #include "spvIR.h" 108 109 namespace spv { 110 111 // class to hold SPIR-V binary data for remapping, DCE, and debug stripping 112 class spirvbin_t : public spirvbin_base_t 113 { 114 public: entryPoint(spv::NoResult)115 spirvbin_t(int verbose = 0) : entryPoint(spv::NoResult), largestNewId(0), verbose(verbose), errorLatch(false) 116 { } 117 ~spirvbin_t()118 virtual ~spirvbin_t() { } 119 120 // remap on an existing binary in memory 121 void remap(std::vector<std::uint32_t>& spv, const std::vector<std::string>& whiteListStrings, 122 std::uint32_t opts = DO_EVERYTHING); 123 124 // remap on an existing binary in memory - legacy interface without white list 125 void remap(std::vector<std::uint32_t>& spv, std::uint32_t opts = DO_EVERYTHING); 126 127 // Type for error/log handler functions 128 typedef std::function<void(const std::string&)> errorfn_t; 129 typedef std::function<void(const std::string&)> logfn_t; 130 131 // Register error/log handling functions (can be lambda fn / functor / etc) registerErrorHandler(errorfn_t handler)132 static void registerErrorHandler(errorfn_t handler) { errorHandler = handler; } registerLogHandler(logfn_t handler)133 static void registerLogHandler(logfn_t handler) { logHandler = handler; } 134 135 protected: 136 // This can be overridden to provide other message behavior if needed 137 virtual void msg(int minVerbosity, int indent, const std::string& txt) const; 138 139 private: 140 // Local to global, or global to local ID map 141 typedef std::unordered_map<spv::Id, spv::Id> idmap_t; 142 typedef std::unordered_set<spv::Id> idset_t; 143 typedef std::unordered_map<spv::Id, int> blockmap_t; 144 145 void remap(std::uint32_t opts = DO_EVERYTHING); 146 147 // Map of names to IDs 148 typedef std::unordered_map<std::string, spv::Id> namemap_t; 149 150 typedef std::uint32_t spirword_t; 151 152 typedef std::pair<unsigned, unsigned> range_t; 153 typedef std::function<void(spv::Id&)> idfn_t; 154 typedef std::function<bool(spv::Op, unsigned start)> instfn_t; 155 156 // Special Values for ID map: 157 static const spv::Id unmapped; // unchanged from default value 158 static const spv::Id unused; // unused ID 159 static const int header_size; // SPIR header = 5 words 160 161 class id_iterator_t; 162 163 // For mapping type entries between different shaders 164 typedef std::vector<spirword_t> typeentry_t; 165 typedef std::map<spv::Id, typeentry_t> globaltypes_t; 166 167 // A set that preserves position order, and a reverse map 168 typedef std::set<int> posmap_t; 169 typedef std::unordered_map<spv::Id, int> posmap_rev_t; 170 171 // Maps and ID to the size of its base type, if known. 172 typedef std::unordered_map<spv::Id, unsigned> typesize_map_t; 173 174 // handle error error(const std::string & txt)175 void error(const std::string& txt) const { errorLatch = true; errorHandler(txt); } 176 177 bool isConstOp(spv::Op opCode) const; 178 bool isTypeOp(spv::Op opCode) const; 179 bool isStripOp(spv::Op opCode) const; 180 bool isFlowCtrl(spv::Op opCode) const; 181 range_t literalRange(spv::Op opCode) const; 182 range_t typeRange(spv::Op opCode) const; 183 range_t constRange(spv::Op opCode) const; 184 unsigned typeSizeInWords(spv::Id id) const; 185 unsigned idTypeSizeInWords(spv::Id id) const; 186 187 bool isStripOp(spv::Op opCode, unsigned start) const; 188 asId(unsigned word)189 spv::Id& asId(unsigned word) { return spv[word]; } asId(unsigned word)190 const spv::Id& asId(unsigned word) const { return spv[word]; } asOpCode(unsigned word)191 spv::Op asOpCode(unsigned word) const { return opOpCode(spv[word]); } 192 std::uint32_t asOpCodeHash(unsigned word); asDecoration(unsigned word)193 spv::Decoration asDecoration(unsigned word) const { return spv::Decoration(spv[word]); } asWordCount(unsigned word)194 unsigned asWordCount(unsigned word) const { return opWordCount(spv[word]); } asTypeConstId(unsigned word)195 spv::Id asTypeConstId(unsigned word) const { return asId(word + (isTypeOp(asOpCode(word)) ? 1 : 2)); } 196 unsigned idPos(spv::Id id) const; 197 opWordCount(spirword_t data)198 static unsigned opWordCount(spirword_t data) { return data >> spv::WordCountShift; } opOpCode(spirword_t data)199 static spv::Op opOpCode(spirword_t data) { return spv::Op(data & spv::OpCodeMask); } 200 201 // Header access & set methods magic()202 spirword_t magic() const { return spv[0]; } // return magic number bound()203 spirword_t bound() const { return spv[3]; } // return Id bound from header bound(spirword_t b)204 spirword_t bound(spirword_t b) { return spv[3] = b; } genmagic()205 spirword_t genmagic() const { return spv[2]; } // generator magic genmagic(spirword_t m)206 spirword_t genmagic(spirword_t m) { return spv[2] = m; } schemaNum()207 spirword_t schemaNum() const { return spv[4]; } // schema number from header 208 209 // Mapping fns: get localId(spv::Id id)210 spv::Id localId(spv::Id id) const { return idMapL[id]; } 211 212 // Mapping fns: set 213 inline spv::Id localId(spv::Id id, spv::Id newId); 214 void countIds(spv::Id id); 215 216 // Return next unused new local ID. 217 // NOTE: boost::dynamic_bitset would be more efficient due to find_next(), 218 // which std::vector<bool> doens't have. 219 inline spv::Id nextUnusedId(spv::Id id); 220 221 void buildLocalMaps(); 222 std::string literalString(unsigned word) const; // Return literal as a std::string literalStringWords(const std::string & str)223 int literalStringWords(const std::string& str) const { return (int(str.size())+4)/4; } 224 isNewIdMapped(spv::Id newId)225 bool isNewIdMapped(spv::Id newId) const { return isMapped(newId); } isOldIdUnmapped(spv::Id oldId)226 bool isOldIdUnmapped(spv::Id oldId) const { return localId(oldId) == unmapped; } isOldIdUnused(spv::Id oldId)227 bool isOldIdUnused(spv::Id oldId) const { return localId(oldId) == unused; } isOldIdMapped(spv::Id oldId)228 bool isOldIdMapped(spv::Id oldId) const { return !isOldIdUnused(oldId) && !isOldIdUnmapped(oldId); } isFunction(spv::Id oldId)229 bool isFunction(spv::Id oldId) const { return fnPos.find(oldId) != fnPos.end(); } 230 231 // bool matchType(const globaltypes_t& globalTypes, spv::Id lt, spv::Id gt) const; 232 // spv::Id findType(const globaltypes_t& globalTypes, spv::Id lt) const; 233 std::uint32_t hashType(unsigned typeStart) const; 234 235 spirvbin_t& process(instfn_t, idfn_t, unsigned begin = 0, unsigned end = 0); 236 int processInstruction(unsigned word, instfn_t, idfn_t); 237 238 void validate() const; 239 void mapTypeConst(); 240 void mapFnBodies(); 241 void optLoadStore(); 242 void dceFuncs(); 243 void dceVars(); 244 void dceTypes(); 245 void mapNames(); 246 void foldIds(); // fold IDs to smallest space 247 void forwardLoadStores(); // load store forwarding (EXPERIMENTAL) 248 void offsetIds(); // create relative offset IDs 249 250 void applyMap(); // remap per local name map 251 void mapRemainder(); // map any IDs we haven't touched yet 252 void stripDebug(); // strip all debug info 253 void stripDeadRefs(); // strips debug info for now-dead references after DCE 254 void strip(); // remove debug symbols 255 256 std::vector<spirword_t> spv; // SPIR words 257 258 std::vector<std::string> stripWhiteList; 259 260 namemap_t nameMap; // ID names from OpName 261 262 // Since we want to also do binary ops, we can't use std::vector<bool>. we could use 263 // boost::dynamic_bitset, but we're trying to avoid a boost dependency. 264 typedef std::uint64_t bits_t; 265 std::vector<bits_t> mapped; // which new IDs have been mapped 266 static const int mBits = sizeof(bits_t) * 4; 267 isMapped(spv::Id id)268 bool isMapped(spv::Id id) const { return id < maxMappedId() && ((mapped[id/mBits] & (1LL<<(id%mBits))) != 0); } setMapped(spv::Id id)269 void setMapped(spv::Id id) { resizeMapped(id); mapped[id/mBits] |= (1LL<<(id%mBits)); } resizeMapped(spv::Id id)270 void resizeMapped(spv::Id id) { if (id >= maxMappedId()) mapped.resize(id/mBits+1, 0); } maxMappedId()271 size_t maxMappedId() const { return mapped.size() * mBits; } 272 273 // Add a strip range for a given instruction starting at 'start' 274 // Note: avoiding brace initializers to please older versions os MSVC. stripInst(unsigned start)275 void stripInst(unsigned start) { stripRange.push_back(range_t(start, start + asWordCount(start))); } 276 277 // Function start and end. use unordered_map because we'll have 278 // many fewer functions than IDs. 279 std::unordered_map<spv::Id, range_t> fnPos; 280 281 // Which functions are called, anywhere in the module, with a call count 282 std::unordered_map<spv::Id, int> fnCalls; 283 284 posmap_t typeConstPos; // word positions that define types & consts (ordered) 285 posmap_rev_t idPosR; // reverse map from IDs to positions 286 typesize_map_t idTypeSizeMap; // maps each ID to its type size, if known. 287 288 std::vector<spv::Id> idMapL; // ID {M}ap from {L}ocal to {G}lobal IDs 289 290 spv::Id entryPoint; // module entry point 291 spv::Id largestNewId; // biggest new ID we have mapped anything to 292 293 // Sections of the binary to strip, given as [begin,end) 294 std::vector<range_t> stripRange; 295 296 // processing options: 297 std::uint32_t options; 298 int verbose; // verbosity level 299 300 // Error latch: this is set if the error handler is ever executed. It would be better to 301 // use a try/catch block and throw, but that's not desired for certain environments, so 302 // this is the alternative. 303 mutable bool errorLatch; 304 305 static errorfn_t errorHandler; 306 static logfn_t logHandler; 307 }; 308 309 } // namespace SPV 310 311 #endif // defined (use_cpp11) 312 #endif // SPIRVREMAPPER_H 313