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 (Entry Point Functions)
 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 ### Extras
 116
 117 * [Utility filters](#utility-filters)
 118 * Build target `spirv-tools-vimsyntax` generates file `spvasm.vim`.
 119   Copy that file into your `$HOME/.vim/syntax` directory to get SPIR-V assembly syntax
 120   highlighting in Vim.  This build target is not built by default.
 121
 122 ## Source code
 123
 124 The SPIR-V Tools are maintained by members of the The Khronos Group Inc.,
 125 at https://github.com/KhronosGroup/SPIRV-Tools.
 126
 127 Contributions via merge request are welcome. Changes should:
 128 * Be provided under the [Apache 2.0](#license).
 129   You'll be prompted with a one-time "click-through" Contributor's License
 130   Agreement (CLA) dialog as part of submitting your pull request or
 131   other contribution to GitHub.
 132 * Include tests to cover updated functionality.
 133 * C++ code should follow the [Google C++ Style Guide][cpp-style-guide].
 134 * Code should be formatted with `clang-format`.  Settings are defined by
 135   the included [.clang-format](.clang-format) file.
 136
 137 We intend to maintain a linear history on the GitHub `master` branch.
 138
 139 ### Source code organization
 140
 141 * `example`: demo code of using SPIRV-Tools APIs
 142 * `external/googletest`: Intended location for the
 143   [googletest][googletest] sources, not provided
 144 * `include/`: API clients should add this directory to the include search path
 145 * `external/spirv-headers`: Intended location for
 146   [SPIR-V headers][spirv-headers], not provided
 147 * `include/spirv-tools/libspirv.h`: C API public interface
 148 * `source/`: API implementation
 149 * `test/`: Tests, using the [googletest][googletest] framework
 150 * `tools/`: Command line executables
 151
 152 ### Tests
 153
 154 The project contains a number of tests, used to drive development
 155 and ensure correctness.  The tests are written using the
 156 [googletest][googletest] framework.  The `googletest`
 157 source is not provided with this project.  There are two ways to enable
 158 tests:
 159 * If SPIR-V Tools is configured as part of an enclosing project, then the
 160   enclosing project should configure `googletest` before configuring SPIR-V Tools.
 161 * If SPIR-V Tools is configured as a standalone project, then download the
 162   `googletest` source into the `<spirv-dir>/external/googletest` directory before
 163   configuring and building the project.
 164
 165 *Note*: You must use a version of googletest that includes
 166 [a fix][googletest-pull-612] for [googletest issue 610][googletest-issue-610].
 167 The fix is included on the googletest master branch any time after 2015-11-10.
 168 In particular, googletest must be newer than version 1.7.0.
 169
 170 ## Build
 171
 172 The project uses [CMake][cmake] to generate platform-specific build
 173 configurations. Assume that `<spirv-dir>` is the root directory of the checked
 174 out code:
 175
 176 ```sh
 177 cd <spirv-dir>
 178 git clone https://github.com/KhronosGroup/SPIRV-Headers.git external/spirv-headers
 179 git clone https://github.com/google/googletest.git external/googletest # optional
 180
 181 mkdir build && cd build
 182 cmake [-G <platform-generator>] <spirv-dir>
 183 ```
 184
 185 Once the build files have been generated, build using your preferred
 186 development environment.
 187
 188 ### CMake options
 189
 190 The following CMake options are supported:
 191
 192 * `SPIRV_COLOR_TERMINAL={ON|OFF}`, default `ON` - Enables color console output.
 193 * `SPIRV_SKIP_TESTS={ON|OFF}`, default `OFF`- Build only the library and
 194   the command line tools.  This will prevent the tests from being built.
 195 * `SPIRV_SKIP_EXECUTABLES={ON|OFF}`, default `OFF`- Build only the library, not
 196   the command line tools and tests.
 197 * `SPIRV_USE_SANITIZER=<sanitizer>`, default is no sanitizing - On UNIX
 198   platforms with an appropriate version of `clang` this option enables the use
 199   of the sanitizers documented [here][clang-sanitizers].
 200   This should only be used with a debug build.
 201 * `SPIRV_WARN_EVERYTHING={ON|OFF}`, default `OFF` - On UNIX platforms enable
 202   more strict warnings.  The code might not compile with this option enabled.
 203   For Clang, enables `-Weverything`.  For GCC, enables `-Wpedantic`.
 204   See [`CMakeLists.txt`](CMakeLists.txt) for details.
 205 * `SPIRV_WERROR={ON|OFF}`, default `ON` - Forces a compilation error on any
 206   warnings encountered by enabling the compiler-specific compiler front-end
 207   option.
 208
 209 Additionally, you can pass additional C preprocessor definitions to SPIRV-Tools
 210 via setting `SPIRV_TOOLS_EXTRA_DEFINITIONS`. For example, by setting it to
 211 `/D_ITERATOR_DEBUG_LEVEL=0` on Windows, you can disable checked iterators and
 212 iterator debugging.
 213
 214 ## Library
 215
 216 ### Usage
 217
 218 The internals of the library use C++11 features, and are exposed via both a C
 219 and C++ API.
 220
 221 In order to use the library from an application, the include path should point
 222 to `<spirv-dir>/include`, which will enable the application to include the
 223 header `<spirv-dir>/include/spirv-tools/libspirv.h{|pp}` then linking against
 224 the static library in `<spirv-build-dir>/source/libSPIRV-Tools.a` or
 225 `<spirv-build-dir>/source/SPIRV-Tools.lib`.
 226 For optimization, the header file is
 227 `<spirv-dir>/include/spirv-tools/optimizer.hpp`, and the static library is
 228 `<spirv-build-dir>/source/libSPIRV-Tools-opt.a` or
 229 `<spirv-build-dir>/source/SPIRV-Tools-opt.lib`.
 230
 231 * `SPIRV-Tools` CMake target: Creates the static library:
 232   * `<spirv-build-dir>/source/libSPIRV-Tools.a` on Linux and OS X.
 233   * `<spirv-build-dir>/source/libSPIRV-Tools.lib` on Windows.
 234 * `SPIRV-Tools-opt` CMake target: Creates the static library:
 235   * `<spirv-build-dir>/source/libSPIRV-Tools-opt.a` on Linux and OS X.
 236   * `<spirv-build-dir>/source/libSPIRV-Tools-opt.lib` on Windows.
 237
 238 #### Entry points
 239
 240 The interfaces are still under development, and are expected to change.
 241
 242 There are five main entry points into the library in the C interface:
 243
 244 * `spvTextToBinary`: An assembler, translating text to a binary SPIR-V module.
 245 * `spvBinaryToText`: A disassembler, translating a binary SPIR-V module to
 246   text.
 247 * `spvBinaryParse`: The entry point to a binary parser API.  It issues callbacks
 248   for the header and each parsed instruction.  The disassembler is implemented
 249   as a client of `spvBinaryParse`.
 250 * `spvValidate` implements the validator functionality. *Incomplete*
 251 * `spvValidateBinary` implements the validator functionality. *Incomplete*
 252
 253 The C++ interface is comprised of two classes, `SpirvTools` and `Optimizer`,
 254 both in the `spvtools` namespace.
 255 * `SpirvTools` provides `Assemble`, `Disassemble`, and `Validate` methods.
 256 * `Optimizer` provides methods for registering and running optimization passes.
 257
 258 ## Command line tools
 259
 260 Command line tools, which wrap the above library functions, are provided to
 261 assemble or disassemble shader files.  It's a convention to name SPIR-V
 262 assembly and binary files with suffix `.spvasm` and `.spv`, respectively.
 263
 264 ### Assembler tool
 265
 266 The assembler reads the assembly language text, and emits the binary form.
 267
 268 The standalone assembler is the exectuable called `spirv-as`, and is located in
 269 `<spirv-build-dir>/tools/spirv-as`.  The functionality of the assembler is implemented
 270 by the `spvTextToBinary` library function.
 271
 272 * `spirv-as` - the standalone assembler
 273   * `<spirv-dir>/tools/as`
 274
 275 Use option `-h` to print help.
 276
 277 ### Disassembler tool
 278
 279 The disassembler reads the binary form, and emits assembly language text.
 280
 281 The standalone disassembler is the executable called `spirv-dis`, and is located in
 282 `<spirv-build-dir>/tools/spirv-dis`. The functionality of the disassembler is implemented
 283 by the `spvBinaryToText` library function.
 284
 285 * `spirv-dis` - the standalone disassembler
 286   * `<spirv-dir>/tools/dis`
 287
 288 Use option `-h` to print help.
 289
 290 The output includes syntax colouring when printing to the standard output stream,
 291 on Linux, Windows, and OS X.
 292
 293 ### Optimizer tool
 294
 295 The optimizer processes a SPIR-V binary module, applying transformations
 296 in the specified order.
 297
 298 This is a work in progress, with initially only few available transformations.
 299
 300 * `spirv-opt` - the standalone optimizer
 301   * `<spirv-dir>/tools/opt`
 302
 303 ### Validator tool
 304
 305 *Warning:* This functionality is under development, and is incomplete.
 306
 307 The standalone validator is the executable called `spirv-val`, and is located in
 308 `<spirv-build-dir>/tools/spirv-val`. The functionality of the validator is implemented
 309 by the `spvValidate` library function.
 310
 311 The validator operates on the binary form.
 312
 313 * `spirv-val` - the standalone validator
 314   * `<spirv-dir>/tools/val`
 315
 316 ### Control flow dumper tool
 317
 318 The control flow dumper prints the control flow graph for a SPIR-V module as a
 319 [GraphViz](http://www.graphviz.org/) graph.
 320
 321 This is experimental.
 322
 323 * `spirv-cfg` - the control flow graph dumper
 324   * `<spirv-dir>/tools/cfg`
 325
 326 ### Utility filters
 327
 328 * `spirv-lesspipe.sh` - Automatically disassembles `.spv` binary files for the
 329   `less` program, on compatible systems.  For example, set the `LESSOPEN`
 330   environment variable as follows, assuming both `spirv-lesspipe.sh` and
 331   `spirv-dis` are on your executable search path:
 332   ```
 333    export LESSOPEN='| spirv-lesspipe.sh "%s"'
 334   ```
 335   Then you page through a disassembled module as follows:
 336   ```
 337   less foo.spv
 338   ```
 339   * The `spirv-lesspipe.sh` script will pass through any extra arguments to
 340     `spirv-dis`.  So, for example, you can turn off colours and friendly ID
 341     naming as follows:
 342     ```
 343     export LESSOPEN='| spirv-lesspipe.sh "%s" --no-color --raw-id'
 344     ```
 345
 346 * [vim-spirv](https://github.com/kbenzie/vim-spirv) - A vim plugin which
 347   supports automatic disassembly of `.spv` files using the `:edit` command and
 348   assembly using the `:write` command. The plugin also provides additional
 349   features which include; syntax highlighting; highlighting of all ID's matching
 350   the ID under the cursor; and highlighting errors where the `Instruction`
 351   operand of `OpExtInst` is used without an appropriate `OpExtInstImport`.
 352
 353 * `50spirv-tools.el` - Automatically disassembles '.spv' binary files when
 354   loaded into the emacs text editor, and re-assembles them when saved,
 355   provided any modifications to the file are valid.  This functionality
 356   must be explicitly requested by defining the symbol
 357   SPIRV_TOOLS_INSTALL_EMACS_HELPERS as follows:
 358   ```
 359   cmake -DSPIRV_TOOLS_INSTALL_EMACS_HELPERS=true ...
 360   ```
 361
 362   In addition, this helper is only installed if the directory /etc/emacs/site-start.d
 363   exists, which is typically true if emacs is installed on the system.
 364
 365   Note that symbol IDs are not currently preserved through a load/edit/save operation.
 366   This may change if the ability is added to spirv-as.
 367
 368
 369 ### Tests
 370
 371 Tests are only built when googletest is found. Use `ctest` to run all the
 372 tests.
 373
 374 ## Future Work
 375 <a name="future"></a>
 376
 377 _See the [projects pages](https://github.com/KhronosGroup/SPIRV-Tools/projects)
 378 for more information._
 379
 380 ### Assembler and disassembler
 381
 382 * The disassembler could emit helpful annotations in comments.  For example:
 383   * Use variable name information from debug instructions to annotate
 384     key operations on variables.
 385   * Show control flow information by annotating `OpLabel` instructions with
 386     that basic block's predecessors.
 387 * Error messages could be improved.
 388
 389 ### Validator
 390
 391 This is a work in progress.
 392
 393 ## Licence
 394 <a name="license"></a>
 395 Full license terms are in [LICENSE](LICENSE)
 396 ```
 397 Copyright (c) 2015-2016 The Khronos Group Inc.
 398
 399 Licensed under the Apache License, Version 2.0 (the "License");
 400 you may not use this file except in compliance with the License.
 401 You may obtain a copy of the License at
 402
 403     http://www.apache.org/licenses/LICENSE-2.0
 404
 405 Unless required by applicable law or agreed to in writing, software
 406 distributed under the License is distributed on an "AS IS" BASIS,
 407 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 408 See the License for the specific language governing permissions and
 409 limitations under the License.
 410 ```
 411
 412 [spirv-registry]: https://www.khronos.org/registry/spir-v/
 413 [spirv-headers]: https://github.com/KhronosGroup/SPIRV-Headers
 414 [googletest]: https://github.com/google/googletest
 415 [googletest-pull-612]: https://github.com/google/googletest/pull/612
 416 [googletest-issue-610]: https://github.com/google/googletest/issues/610
 417 [CMake]: https://cmake.org/
 418 [cpp-style-guide]: https://google.github.io/styleguide/cppguide.html
 419 [clang-sanitizers]: http://clang.llvm.org/docs/UsersManual.html#controlling-code-generation