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/p5d60n0mhfimm6i5/branch/master?svg=true)](https://ci.appveyor.com/project/antiagainst/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, and
  12 validator for SPIR-V, all based on a common static library. The library contains
  13 all of the implementation details, and is used in the standalone tools whilst
  14 also enabling integration into other code bases directly.
  15
  16 The interfaces are still under development, and are expected to change.
  17
  18 SPIR-V is defined by the Khronos Group Inc.
  19 See the [SPIR-V Registry][spirv-registry] for the SPIR-V specification,
  20 headers, and XML registry.
  21
  22 ## Verisoning SPIRV-Tools
  23
  24 See [`CHANGES`](CHANGES) for a high level summary of recent changes, by version.
  25
  26 SPIRV-Tools project version numbers are of the form `v`*year*`.`*index* and with
  27 an optional `-dev` suffix to indicate work in progress.  For exampe, the
  28 following versions are ordered from oldest to newest:
  29
  30 * `v2016.0`
  31 * `v2016.1-dev`
  32 * `v2016.1`
  33 * `v2016.2-dev`
  34 * `v2016.2`
  35
  36 Use the `--version` option on each command line tool to see the software
  37 version.  An API call reports the software version as a C-style string.
  38
  39 ## Supported features
  40
  41 ### Assembler, binary parser, and disassembler
  42
  43 * Based on SPIR-V version 1.1 Rev 1
  44 * Support for extended instruction sets:
  45   * GLSL std450 version 1.0 Rev 3
  46   * OpenCL version 1.0 Rev 2
  47 * Support for SPIR-V 1.0 (with or without additional restrictions from Vulkan 1.0)
  48 * Assembler only does basic syntax checking.  No cross validation of
  49   IDs or types is performed, except to check literal arguments to
  50   `OpConstant`, `OpSpecConstant`, and `OpSwitch`.
  51
  52 See [`syntax.md`](syntax.md) for the assembly language syntax.
  53
  54 ### Validator
  55
  56 *Warning:* The validator is incomplete.
  57
  58 ## Source code
  59
  60 The SPIR-V Tools are maintained by members of the The Khronos Group Inc.,
  61 at https://github.com/KhronosGroup/SPIRV-Tools.
  62
  63 Contributions via merge request are welcome. Changes should:
  64 * Be provided under the [Khronos license](#license).
  65 * Include tests to cover updated functionality.
  66 * C++ code should follow the [Google C++ Style Guide][cpp-style-guide].
  67 * Code should be formatted with `clang-format`.  Settings are defined by
  68   the included [.clang-format](.clang-format) file.
  69
  70 We intend to maintain a linear history on the GitHub `master` branch.
  71
  72 ### Source code organization
  73
  74 * `external/googletest`: Intended location for the
  75   [googletest][googletest] sources, not provided
  76 * `include/`: API clients should add this directory to the include search path
  77 * `external/spirv-headers`: Intended location for
  78   [SPIR-V headers][spirv-headers], not provided
  79 * `include/spirv-tools/libspirv.h`: C API public interface
  80 * `source/`: API implementation
  81 * `test/`: Tests, using the [googletest][googletest] framework
  82 * `tools/`: Command line executables
  83
  84 ### Tests
  85
  86 The project contains a number of tests, used to drive development
  87 and ensure correctness.  The tests are written using the
  88 [googletest][googletest] framework.  The `googletest`
  89 source is not provided with this project.  There are two ways to enable
  90 tests:
  91 * If SPIR-V Tools is configured as part of an enclosing project, then the
  92   enclosing project should configure `googletest` before configuring SPIR-V Tools.
  93 * If SPIR-V Tools is configured as a standalone project, then download the
  94   `googletest` source into the `<spirv-dir>/external/googletest` directory before
  95   configuring and building the project.
  96
  97 *Note*: You must use a version of googletest that includes
  98 [a fix][googletest-pull-612] for [googletest issue 610][googletest-issue-610].
  99 The fix is included on the googletest master branch any time after 2015-11-10.
 100 In particular, googletest must be newer than version 1.7.0.
 101
 102 ## Build
 103
 104 The project uses [CMake][cmake] to generate platform-specific build
 105 configurations. After checking out [SPIR-V headers][spirv-headers] and
 106 [googletest][googletest] into `external/`. issue the following commands:
 107
 108 ```
 109 mkdir <spirv-dir>/build
 110 cd <spirv-dir>/build
 111 cmake [-G <platform-generator>] <spirv-dir>
 112 ```
 113
 114 Once the build files have been generated, build using your preferred
 115 development environment.
 116
 117 ### CMake options
 118
 119 The following CMake options are supported:
 120
 121 * `SPIRV_COLOR_TERMINAL={ON|OFF}`, default `ON` - Enables color console output.
 122 * `SPIRV_SKIP_EXECUTABLES={ON|OFF}`, default `OFF`- Build only the library, not
 123   the command line tools.  This will also prevent the tests from being built.
 124 * `SPIRV_USE_SANITIZER=<sanitizer>`, default is no sanitizing - On UNIX
 125   platforms with an appropriate version of `clang` this option enables the use
 126   of the sanitizers documented [here][clang-sanitizers].
 127   This should only be used with a debug build.
 128 * `SPIRV_WARN_EVERYTHING={ON|OFF}`, default `OFF` - On UNIX platforms enable
 129   more strict warnings.  The code might not compile with this option enabled.
 130   For Clang, enables `-Weverything`.  For GCC, enables `-Wpedantic`.
 131   See [`CMakeLists.txt`](CMakeLists.txt) for details.
 132 * `SPIRV_WERROR={ON|OFF}`, default `ON` - Forces a compilation error on any
 133   warnings encountered by enabling the compiler-specific compiler front-end
 134   option.
 135
 136 ## Library
 137
 138 ### Usage
 139
 140 The library provides a C API, but the internals use C++11.
 141
 142 In order to use the library from an application, the include path should point
 143 to `<spirv-dir>/include`, which will enable the application to include the
 144 header `<spirv-dir>/include/libspirv/libspirv.h` then linking against the
 145 static library in `<spirv-build-dir>/libSPIRV-Tools.a` or
 146 `<spirv-build-dir>/SPIRV-Tools.lib`.
 147
 148 * `SPIRV-Tools` CMake target: Creates the static library:
 149   * `<spirv-build-dir>/libSPIRV-Tools.a` on Linux and OS X.
 150   * `<spirv-build-dir>/libSPIRV-Tools.lib` on Windows.
 151
 152 #### Entry points
 153
 154 The interfaces are still under development, and are expected to change.
 155
 156 There are three main entry points into the library.
 157
 158 * `spvTextToBinary`: An assembler, translating text to a binary SPIR-V module.
 159 * `spvBinaryToText`: A disassembler, translating a binary SPIR-V module to
 160   text.
 161 * `spvBinaryParse`: The entry point to a binary parser API.  It issues callbacks
 162   for the header and each parsed instruction.  The disassembler is implemented
 163   as a client of `spvBinaryParse`.
 164 * `spvValidate` implements the validator functionality. *Incomplete*
 165
 166 ## Command line tools
 167
 168 Command line tools, which wrap the above library functions, are provided to
 169 assemble or disassemble shader files.  It's a convention to name SPIR-V
 170 assembly and binary files with suffix `.spvasm` and `.spv`, respectively.
 171
 172 ### Assembler tool
 173
 174 The assembler reads the assembly language text, and emits the binary form.
 175
 176 The standalone assembler is the exectuable called `spirv-as`, and is located in
 177 `<spirv-build-dir>/spirv-as`.  The functionality of the assembler is implemented
 178 by the `spvTextToBinary` library function.
 179
 180 * `spirv-as` - the standalone assembler
 181   * `<spirv-dir>/spirv-as`
 182
 183 Use option `-h` to print help.
 184
 185 ### Disassembler tool
 186
 187 The disassembler reads the binary form, and emits assembly language text.
 188
 189 The standalone disassembler is the executable called `spirv-dis`, and is located in
 190 `<spirv-build-dir>/spirv-dis`. The functionality of the disassembler is implemented
 191 by the `spvBinaryToText` library function.
 192
 193 * `spirv-dis` - the standalone disassembler
 194   * `<spirv-dir>/spirv-dis`
 195
 196 Use option `-h` to print help.
 197
 198 The output includes syntax colouring when printing to the standard output stream,
 199 on Linux, Windows, and OS X.
 200
 201 ### Validator tool
 202
 203 *Warning:* This functionality is under development, and is incomplete.
 204
 205 The standalone validator is the executable called `spirv-val`, and is located in
 206 `<spirv-build-dir>/spirv-val`. The functionality of the validator is implemented
 207 by the `spvValidate` library function.
 208
 209 The validator operates on the binary form.
 210
 211 * `spirv-val` - the standalone validator
 212   * `<spirv-dir>/spirv-val`
 213
 214 ### Tests
 215
 216 Tests are only built when googletest is found.
 217
 218 The `<spirv-build-dir>/UnitSPIRV` executable runs the project tests.
 219 It supports the standard `googletest` command line options.
 220
 221 The project also adds a CMake test `spirv-tools-testsuite`, which executes
 222 `UnitSPIRV`.  That way it's possible to run the tests using `ctest`.
 223
 224 ## Future Work
 225 <a name="future"></a>
 226
 227 ### Assembler and disassembler
 228
 229 * The disassembler could emit helpful annotations in comments.  For example:
 230   * Use variable name information from debug instructions to annotate
 231     key operations on variables.
 232   * Show control flow information by annotating `OpLabel` instructions with
 233     that basic block's predecessors.
 234 * Error messages could be improved.
 235
 236 ### Validator
 237
 238 This is a work in progress.
 239
 240 ## Licence
 241 <a name="license"></a>
 242 ```
 243 Copyright (c) 2015-2016 The Khronos Group Inc.
 244
 245 Permission is hereby granted, free of charge, to any person obtaining a
 246 copy of this software and/or associated documentation files (the
 247 "Materials"), to deal in the Materials without restriction, including
 248 without limitation the rights to use, copy, modify, merge, publish,
 249 distribute, sublicense, and/or sell copies of the Materials, and to
 250 permit persons to whom the Materials are furnished to do so, subject to
 251 the following conditions:
 252
 253 The above copyright notice and this permission notice shall be included
 254 in all copies or substantial portions of the Materials.
 255
 256 MODIFICATIONS TO THIS FILE MAY MEAN IT NO LONGER ACCURATELY REFLECTS
 257 KHRONOS STANDARDS. THE UNMODIFIED, NORMATIVE VERSIONS OF KHRONOS
 258 SPECIFICATIONS AND HEADER INFORMATION ARE LOCATED AT
 259    https://www.khronos.org/registry/
 260
 261 THE MATERIALS ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 262 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 263 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 264 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 265 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 266 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 267 MATERIALS OR THE USE OR OTHER DEALINGS IN THE MATERIALS.
 268 ```
 269
 270 [spirv-registry]: https://www.khronos.org/registry/spir-v/
 271 [spirv-headers]: https://github.com/KhronosGroup/SPIRV-Headers
 272 [googletest]: https://github.com/google/googletest
 273 [googletest-pull-612]: https://github.com/google/googletest/pull/612
 274 [googletest-issue-610]: https://github.com/google/googletest/issues/610
 275 [CMake]: https://cmake.org/
 276 [cpp-style-guide]: https://google.github.io/styleguide/cppguide.html
 277 [clang-sanitizers]: http://clang.llvm.org/docs/UsersManual.html#controlling-code-generation