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