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