README.md

   1 # SPIR-V Tools
   2
   3 [![Build Status](https://travis-ci.org/KhronosGroup/SPIRV-Tools.svg?branch=master)](https://travis-ci.org/KhronosGroup/SPIRV-Tools)
   4 [![Build status](https://ci.appveyor.com/api/projects/status/gpue87cesrx3pi0d/branch/master?svg=true)](https://ci.appveyor.com/project/Khronoswebmaster/spirv-tools/branch/master)
   5
   6 ## Overview
   7
   8 The SPIR-V Tools project provides an API and commands for processing SPIR-V
   9 modules.
  10
  11 The project includes an assembler, binary module parser, disassembler,
  12 validator, and optimizer for SPIR-V. Except for the optimizer, all are based
  13 on a common static library.  The library contains all of the implementation
  14 details, and is used in the standalone tools whilst also enabling integration
  15 into other code bases directly. The optimizer implementation resides in its
  16 own library, which depends on the core library.
  17
  18 The interfaces have stabilized:
  19 We don't anticipate making a breaking change for existing features.
  20
  21 See [`projects.md`](projects.md) to see how we use the
  22 [GitHub Project
  23 feature](https://help.github.com/articles/tracking-the-progress-of-your-work-with-projects/)
  24 to organize planned and in-progress work.
  25
  26 SPIR-V is defined by the Khronos Group Inc.
  27 See the [SPIR-V Registry][spirv-registry] for the SPIR-V specification,
  28 headers, and XML registry.
  29
  30 ## Verisoning SPIRV-Tools
  31
  32 See [`CHANGES`](CHANGES) for a high level summary of recent changes, by version.
  33
  34 SPIRV-Tools project version numbers are of the form `v`*year*`.`*index* and with
  35 an optional `-dev` suffix to indicate work in progress.  For exampe, the
  36 following versions are ordered from oldest to newest:
  37
  38 * `v2016.0`
  39 * `v2016.1-dev`
  40 * `v2016.1`
  41 * `v2016.2-dev`
  42 * `v2016.2`
  43
  44 Use the `--version` option on each command line tool to see the software
  45 version.  An API call reports the software version as a C-style string.
  46
  47 ## Supported features
  48
  49 ### Assembler, binary parser, and disassembler
  50
  51 * Based on SPIR-V version 1.1 Rev 3
  52 * Support for extended instruction sets:
  53   * GLSL std450 version 1.0 Rev 3
  54   * OpenCL version 1.0 Rev 2
  55 * Support for SPIR-V 1.0 (with or without additional restrictions from Vulkan 1.0)
  56 * Assembler only does basic syntax checking.  No cross validation of
  57   IDs or types is performed, except to check literal arguments to
  58   `OpConstant`, `OpSpecConstant`, and `OpSwitch`.
  59
  60 See [`syntax.md`](syntax.md) for the assembly language syntax.
  61
  62 ### Validator
  63
  64 The validator checks validation rules described by the SPIR-V specification.
  65
  66 Khronos recommends that tools that create or transform SPIR-V modules use the
  67 validator to ensure their outputs are valid, and that tools that consume SPIR-V
  68 modules optionally use the validator to protect themselves from bad inputs.
  69 This is especially encouraged for debug and development scenarios.
  70
  71 The validator has one-sided error: it will only return an error when it has
  72 implemented a rule check and the module violates that rule.
  73
  74 The validator is incomplete.
  75 See the [CHANGES](CHANGES) file for reports on completed work, and
  76 the [Validator
  77 sub-project](https://github.com/KhronosGroup/SPIRV-Tools/projects/1) for planned
  78 and in-progress work.
  79
  80 *Note*: The validator checks some Universal Limits, from section 2.17 of the SPIR-V spec.
  81 The validator will fail on a module that exceeds those minimum upper bound limits.
  82 It is [future work](https://github.com/KhronosGroup/SPIRV-Tools/projects/1#card-1052403)
  83 to parameterize the validator to allow larger
  84 limits accepted by a more than minimally capable SPIR-V consumer.
  85
  86
  87 ### Optimizer
  88
  89 *Note:* The optimizer is still under development.
  90
  91 Currently supported optimizations:
  92 * General
  93   * Strip debug info
  94 * Specialization Constants
  95   * Set spec constant default value
  96   * Freeze spec constant
  97   * Fold `OpSpecConstantOp` and `OpSpecConstantComposite`
  98   * Unify constants
  99   * Eliminate dead constant
 100 * Code Reduction
 101   * Inline all function calls exhaustively
 102   * Convert local access chains to inserts/extracts
 103   * Eliminate local load/store in single block
 104   * Eliminate local load/store with single store
 105   * Eliminate local load/store with multiple stores
 106   * Eliminate local extract from insert
 107   * Eliminate dead instructions (aggressive)
 108   * Eliminate dead branches
 109   * Merge single successor / single predecessor block pairs
 110   * Eliminate common uniform loads
 111
 112 For the latest list with detailed documentation, please refer to
 113 [`include/spirv-tools/optimizer.hpp`](include/spirv-tools/optimizer.hpp).
 114
 115 For suggestions on using the code reduction options, please refer to this [white paper](https://www.lunarg.com/shader-compiler-technologies/white-paper-spirv-opt/).
 116
 117 ### Extras
 118
 119 * [Utility filters](#utility-filters)
 120 * Build target `spirv-tools-vimsyntax` generates file `spvasm.vim`.
 121   Copy that file into your `$HOME/.vim/syntax` directory to get SPIR-V assembly syntax
 122   highlighting in Vim.  This build target is not built by default.
 123
 124 ## Source code
 125
 126 The SPIR-V Tools are maintained by members of the The Khronos Group Inc.,
 127 at https://github.com/KhronosGroup/SPIRV-Tools.
 128
 129 Contributions via merge request are welcome. Changes should:
 130 * Be provided under the [Apache 2.0](#license).
 131   You'll be prompted with a one-time "click-through" Contributor's License
 132   Agreement (CLA) dialog as part of submitting your pull request or
 133   other contribution to GitHub.
 134 * Include tests to cover updated functionality.
 135 * C++ code should follow the [Google C++ Style Guide][cpp-style-guide].
 136 * Code should be formatted with `clang-format`.  Settings are defined by
 137   the included [.clang-format](.clang-format) file.
 138
 139 We intend to maintain a linear history on the GitHub `master` branch.
 140
 141 ### Source code organization
 142
 143 * `example`: demo code of using SPIRV-Tools APIs
 144 * `external/googletest`: Intended location for the
 145   [googletest][googletest] sources, not provided
 146 * `include/`: API clients should add this directory to the include search path
 147 * `external/spirv-headers`: Intended location for
 148   [SPIR-V headers][spirv-headers], not provided
 149 * `include/spirv-tools/libspirv.h`: C API public interface
 150 * `source/`: API implementation
 151 * `test/`: Tests, using the [googletest][googletest] framework
 152 * `tools/`: Command line executables
 153
 154 ### Tests
 155
 156 The project contains a number of tests, used to drive development
 157 and ensure correctness.  The tests are written using the
 158 [googletest][googletest] framework.  The `googletest`
 159 source is not provided with this project.  There are two ways to enable
 160 tests:
 161 * If SPIR-V Tools is configured as part of an enclosing project, then the
 162   enclosing project should configure `googletest` before configuring SPIR-V Tools.
 163 * If SPIR-V Tools is configured as a standalone project, then download the
 164   `googletest` source into the `<spirv-dir>/external/googletest` directory before
 165   configuring and building the project.
 166
 167 *Note*: You must use a version of googletest that includes
 168 [a fix][googletest-pull-612] for [googletest issue 610][googletest-issue-610].
 169 The fix is included on the googletest master branch any time after 2015-11-10.
 170 In particular, googletest must be newer than version 1.7.0.
 171
 172 ## Build
 173
 174 The project uses [CMake][cmake] to generate platform-specific build
 175 configurations. Assume that `<spirv-dir>` is the root directory of the checked
 176 out code:
 177
 178 ```sh
 179 cd <spirv-dir>
 180 git clone https://github.com/KhronosGroup/SPIRV-Headers.git external/spirv-headers
 181 git clone https://github.com/google/googletest.git external/googletest # optional
 182
 183 mkdir build && cd build
 184 cmake [-G <platform-generator>] <spirv-dir>
 185 ```
 186
 187 Once the build files have been generated, build using your preferred
 188 development environment.
 189
 190 ### CMake options
 191
 192 The following CMake options are supported:
 193
 194 * `SPIRV_COLOR_TERMINAL={ON|OFF}`, default `ON` - Enables color console output.
 195 * `SPIRV_SKIP_TESTS={ON|OFF}`, default `OFF`- Build only the library and
 196   the command line tools.  This will prevent the tests from being built.
 197 * `SPIRV_SKIP_EXECUTABLES={ON|OFF}`, default `OFF`- Build only the library, not
 198   the command line tools and tests.
 199 * `SPIRV_USE_SANITIZER=<sanitizer>`, default is no sanitizing - On UNIX
 200   platforms with an appropriate version of `clang` this option enables the use
 201   of the sanitizers documented [here][clang-sanitizers].
 202   This should only be used with a debug build.
 203 * `SPIRV_WARN_EVERYTHING={ON|OFF}`, default `OFF` - On UNIX platforms enable
 204   more strict warnings.  The code might not compile with this option enabled.
 205   For Clang, enables `-Weverything`.  For GCC, enables `-Wpedantic`.
 206   See [`CMakeLists.txt`](CMakeLists.txt) for details.
 207 * `SPIRV_WERROR={ON|OFF}`, default `ON` - Forces a compilation error on any
 208   warnings encountered by enabling the compiler-specific compiler front-end
 209   option.
 210
 211 Additionally, you can pass additional C preprocessor definitions to SPIRV-Tools
 212 via setting `SPIRV_TOOLS_EXTRA_DEFINITIONS`. For example, by setting it to
 213 `/D_ITERATOR_DEBUG_LEVEL=0` on Windows, you can disable checked iterators and
 214 iterator debugging.
 215
 216 ## Library
 217
 218 ### Usage
 219
 220 The internals of the library use C++11 features, and are exposed via both a C
 221 and C++ API.
 222
 223 In order to use the library from an application, the include path should point
 224 to `<spirv-dir>/include`, which will enable the application to include the
 225 header `<spirv-dir>/include/spirv-tools/libspirv.h{|pp}` then linking against
 226 the static library in `<spirv-build-dir>/source/libSPIRV-Tools.a` or
 227 `<spirv-build-dir>/source/SPIRV-Tools.lib`.
 228 For optimization, the header file is
 229 `<spirv-dir>/include/spirv-tools/optimizer.hpp`, and the static library is
 230 `<spirv-build-dir>/source/libSPIRV-Tools-opt.a` or
 231 `<spirv-build-dir>/source/SPIRV-Tools-opt.lib`.
 232
 233 * `SPIRV-Tools` CMake target: Creates the static library:
 234   * `<spirv-build-dir>/source/libSPIRV-Tools.a` on Linux and OS X.
 235   * `<spirv-build-dir>/source/libSPIRV-Tools.lib` on Windows.
 236 * `SPIRV-Tools-opt` CMake target: Creates the static library:
 237   * `<spirv-build-dir>/source/libSPIRV-Tools-opt.a` on Linux and OS X.
 238   * `<spirv-build-dir>/source/libSPIRV-Tools-opt.lib` on Windows.
 239
 240 #### Entry points
 241
 242 The interfaces are still under development, and are expected to change.
 243
 244 There are five main entry points into the library in the C interface:
 245
 246 * `spvTextToBinary`: An assembler, translating text to a binary SPIR-V module.
 247 * `spvBinaryToText`: A disassembler, translating a binary SPIR-V module to
 248   text.
 249 * `spvBinaryParse`: The entry point to a binary parser API.  It issues callbacks
 250   for the header and each parsed instruction.  The disassembler is implemented
 251   as a client of `spvBinaryParse`.
 252 * `spvValidate` implements the validator functionality. *Incomplete*
 253 * `spvValidateBinary` implements the validator functionality. *Incomplete*
 254
 255 The C++ interface is comprised of two classes, `SpirvTools` and `Optimizer`,
 256 both in the `spvtools` namespace.
 257 * `SpirvTools` provides `Assemble`, `Disassemble`, and `Validate` methods.
 258 * `Optimizer` provides methods for registering and running optimization passes.
 259
 260 ## Command line tools
 261
 262 Command line tools, which wrap the above library functions, are provided to
 263 assemble or disassemble shader files.  It's a convention to name SPIR-V
 264 assembly and binary files with suffix `.spvasm` and `.spv`, respectively.
 265
 266 ### Assembler tool
 267
 268 The assembler reads the assembly language text, and emits the binary form.
 269
 270 The standalone assembler is the exectuable called `spirv-as`, and is located in
 271 `<spirv-build-dir>/tools/spirv-as`.  The functionality of the assembler is implemented
 272 by the `spvTextToBinary` library function.
 273
 274 * `spirv-as` - the standalone assembler
 275   * `<spirv-dir>/tools/as`
 276
 277 Use option `-h` to print help.
 278
 279 ### Disassembler tool
 280
 281 The disassembler reads the binary form, and emits assembly language text.
 282
 283 The standalone disassembler is the executable called `spirv-dis`, and is located in
 284 `<spirv-build-dir>/tools/spirv-dis`. The functionality of the disassembler is implemented
 285 by the `spvBinaryToText` library function.
 286
 287 * `spirv-dis` - the standalone disassembler
 288   * `<spirv-dir>/tools/dis`
 289
 290 Use option `-h` to print help.
 291
 292 The output includes syntax colouring when printing to the standard output stream,
 293 on Linux, Windows, and OS X.
 294
 295 ### Optimizer tool
 296
 297 The optimizer processes a SPIR-V binary module, applying transformations
 298 in the specified order.
 299
 300 This is a work in progress, with initially only few available transformations.
 301
 302 * `spirv-opt` - the standalone optimizer
 303   * `<spirv-dir>/tools/opt`
 304
 305 ### Validator tool
 306
 307 *Warning:* This functionality is under development, and is incomplete.
 308
 309 The standalone validator is the executable called `spirv-val`, and is located in
 310 `<spirv-build-dir>/tools/spirv-val`. The functionality of the validator is implemented
 311 by the `spvValidate` library function.
 312
 313 The validator operates on the binary form.
 314
 315 * `spirv-val` - the standalone validator
 316   * `<spirv-dir>/tools/val`
 317
 318 ### Control flow dumper tool
 319
 320 The control flow dumper prints the control flow graph for a SPIR-V module as a
 321 [GraphViz](http://www.graphviz.org/) graph.
 322
 323 This is experimental.
 324
 325 * `spirv-cfg` - the control flow graph dumper
 326   * `<spirv-dir>/tools/cfg`
 327
 328 ### Utility filters
 329
 330 * `spirv-lesspipe.sh` - Automatically disassembles `.spv` binary files for the
 331   `less` program, on compatible systems.  For example, set the `LESSOPEN`
 332   environment variable as follows, assuming both `spirv-lesspipe.sh` and
 333   `spirv-dis` are on your executable search path:
 334   ```
 335    export LESSOPEN='| spirv-lesspipe.sh "%s"'
 336   ```
 337   Then you page through a disassembled module as follows:
 338   ```
 339   less foo.spv
 340   ```
 341   * The `spirv-lesspipe.sh` script will pass through any extra arguments to
 342     `spirv-dis`.  So, for example, you can turn off colours and friendly ID
 343     naming as follows:
 344     ```
 345     export LESSOPEN='| spirv-lesspipe.sh "%s" --no-color --raw-id'
 346     ```
 347
 348 * [vim-spirv](https://github.com/kbenzie/vim-spirv) - A vim plugin which
 349   supports automatic disassembly of `.spv` files using the `:edit` command and
 350   assembly using the `:write` command. The plugin also provides additional
 351   features which include; syntax highlighting; highlighting of all ID's matching
 352   the ID under the cursor; and highlighting errors where the `Instruction`
 353   operand of `OpExtInst` is used without an appropriate `OpExtInstImport`.
 354
 355 * `50spirv-tools.el` - Automatically disassembles '.spv' binary files when
 356   loaded into the emacs text editor, and re-assembles them when saved,
 357   provided any modifications to the file are valid.  This functionality
 358   must be explicitly requested by defining the symbol
 359   SPIRV_TOOLS_INSTALL_EMACS_HELPERS as follows:
 360   ```
 361   cmake -DSPIRV_TOOLS_INSTALL_EMACS_HELPERS=true ...
 362   ```
 363
 364   In addition, this helper is only installed if the directory /etc/emacs/site-start.d
 365   exists, which is typically true if emacs is installed on the system.
 366
 367   Note that symbol IDs are not currently preserved through a load/edit/save operation.
 368   This may change if the ability is added to spirv-as.
 369
 370
 371 ### Tests
 372
 373 Tests are only built when googletest is found. Use `ctest` to run all the
 374 tests.
 375
 376 ## Future Work
 377 <a name="future"></a>
 378
 379 _See the [projects pages](https://github.com/KhronosGroup/SPIRV-Tools/projects)
 380 for more information._
 381
 382 ### Assembler and disassembler
 383
 384 * The disassembler could emit helpful annotations in comments.  For example:
 385   * Use variable name information from debug instructions to annotate
 386     key operations on variables.
 387   * Show control flow information by annotating `OpLabel` instructions with
 388     that basic block's predecessors.
 389 * Error messages could be improved.
 390
 391 ### Validator
 392
 393 This is a work in progress.
 394
 395 ## Licence
 396 <a name="license"></a>
 397 Full license terms are in [LICENSE](LICENSE)
 398 ```
 399 Copyright (c) 2015-2016 The Khronos Group Inc.
 400
 401 Licensed under the Apache License, Version 2.0 (the "License");
 402 you may not use this file except in compliance with the License.
 403 You may obtain a copy of the License at
 404
 405     http://www.apache.org/licenses/LICENSE-2.0
 406
 407 Unless required by applicable law or agreed to in writing, software
 408 distributed under the License is distributed on an "AS IS" BASIS,
 409 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 410 See the License for the specific language governing permissions and
 411 limitations under the License.
 412 ```
 413
 414 [spirv-registry]: https://www.khronos.org/registry/spir-v/
 415 [spirv-headers]: https://github.com/KhronosGroup/SPIRV-Headers
 416 [googletest]: https://github.com/google/googletest
 417 [googletest-pull-612]: https://github.com/google/googletest/pull/612
 418 [googletest-issue-610]: https://github.com/google/googletest/issues/610
 419 [CMake]: https://cmake.org/
 420 [cpp-style-guide]: https://google.github.io/styleguide/cppguide.html
 421 [clang-sanitizers]: http://clang.llvm.org/docs/UsersManual.html#controlling-code-generation