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