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