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)
8 The SPIR-V Tools project provides an API and commands for processing SPIR-V
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.
18 The interfaces have stabilized:
19 We don't anticipate making a breaking change for existing features.
21 See [`projects.md`](projects.md) to see how we use the
23 feature](https://help.github.com/articles/tracking-the-progress-of-your-work-with-projects/)
24 to organize planned and in-progress work.
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.
30 ## Verisoning SPIRV-Tools
32 See [`CHANGES`](CHANGES) for a high level summary of recent changes, by version.
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:
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.
49 ### Assembler, binary parser, and disassembler
51 * Based on SPIR-V version 1.1 Rev 3
52 * Support for extended instruction sets:
53 * GLSL std450 version 1.0 Rev 3
54 * OpenCL version 1.0 Rev 2
55 * Support for SPIR-V 1.0 (with or without additional restrictions from Vulkan 1.0)
56 * Assembler only does basic syntax checking. No cross validation of
57 IDs or types is performed, except to check literal arguments to
58 `OpConstant`, `OpSpecConstant`, and `OpSwitch`.
60 See [`syntax.md`](syntax.md) for the assembly language syntax.
64 The validator checks validation rules described by the SPIR-V specification.
66 Khronos recommends that tools that create or transform SPIR-V modules use the
67 validator to ensure their outputs are valid, and that tools that consume SPIR-V
68 modules optionally use the validator to protect themselves from bad inputs.
69 This is especially encouraged for debug and development scenarios.
71 The validator has one-sided error: it will only return an error when it has
72 implemented a rule check and the module violates that rule.
74 The validator is incomplete.
75 See the [CHANGES](CHANGES) file for reports on completed work, and
77 sub-project](https://github.com/KhronosGroup/SPIRV-Tools/projects/1) for planned
80 *Note*: The validator checks some Universal Limits, from section 2.17 of the SPIR-V spec.
81 The validator will fail on a module that exceeds those minimum upper bound limits.
82 It is [future work](https://github.com/KhronosGroup/SPIRV-Tools/projects/1#card-1052403)
83 to parameterize the validator to allow larger
84 limits accepted by a more than minimally capable SPIR-V consumer.
89 *Warning:* The optimizer is still under development.
91 Currently supported optimizations:
93 * Set spec constant default value
94 * Freeze spec constant
95 * Fold `OpSpecConstantOp` and `OpSpecConstantComposite`
97 * Eliminate dead constant
99 For the latest list with detailed documentation, please refer to
100 [`include/spirv-tools/optimizer.hpp`](include/spirv-tools/optimizer.hpp).
104 * [Utility filters](#utility-filters)
105 * Build target `spirv-tools-vimsyntax` generates file `spvasm.vim`.
106 Copy that file into your `$HOME/.vim/syntax` directory to get SPIR-V assembly syntax
107 highlighting in Vim. This build target is not built by default.
111 The SPIR-V Tools are maintained by members of the The Khronos Group Inc.,
112 at https://github.com/KhronosGroup/SPIRV-Tools.
114 Contributions via merge request are welcome. Changes should:
115 * Be provided under the [Apache 2.0](#license).
116 You'll be prompted with a one-time "click-through" Contributor's License
117 Agreement (CLA) dialog as part of submitting your pull request or
118 other contribution to GitHub.
119 * Include tests to cover updated functionality.
120 * C++ code should follow the [Google C++ Style Guide][cpp-style-guide].
121 * Code should be formatted with `clang-format`. Settings are defined by
122 the included [.clang-format](.clang-format) file.
124 We intend to maintain a linear history on the GitHub `master` branch.
126 ### Source code organization
128 * `example`: demo code of using SPIRV-Tools APIs
129 * `external/googletest`: Intended location for the
130 [googletest][googletest] sources, not provided
131 * `include/`: API clients should add this directory to the include search path
132 * `external/spirv-headers`: Intended location for
133 [SPIR-V headers][spirv-headers], not provided
134 * `include/spirv-tools/libspirv.h`: C API public interface
135 * `source/`: API implementation
136 * `test/`: Tests, using the [googletest][googletest] framework
137 * `tools/`: Command line executables
141 The project contains a number of tests, used to drive development
142 and ensure correctness. The tests are written using the
143 [googletest][googletest] framework. The `googletest`
144 source is not provided with this project. There are two ways to enable
146 * If SPIR-V Tools is configured as part of an enclosing project, then the
147 enclosing project should configure `googletest` before configuring SPIR-V Tools.
148 * If SPIR-V Tools is configured as a standalone project, then download the
149 `googletest` source into the `<spirv-dir>/external/googletest` directory before
150 configuring and building the project.
152 *Note*: You must use a version of googletest that includes
153 [a fix][googletest-pull-612] for [googletest issue 610][googletest-issue-610].
154 The fix is included on the googletest master branch any time after 2015-11-10.
155 In particular, googletest must be newer than version 1.7.0.
159 The project uses [CMake][cmake] to generate platform-specific build
160 configurations. Assume that `<spirv-dir>` is the root directory of the checked
165 git clone https://github.com/KhronosGroup/SPIRV-Headers.git external/spirv-headers
166 git clone https://github.com/google/googletest.git external/googletest # optional
168 mkdir build && cd build
169 cmake [-G <platform-generator>] <spirv-dir>
172 Once the build files have been generated, build using your preferred
173 development environment.
177 The following CMake options are supported:
179 * `SPIRV_COLOR_TERMINAL={ON|OFF}`, default `ON` - Enables color console output.
180 * `SPIRV_SKIP_TESTS={ON|OFF}`, default `OFF`- Build only the library and
181 the command line tools. This will prevent the tests from being built.
182 * `SPIRV_SKIP_EXECUTABLES={ON|OFF}`, default `OFF`- Build only the library, not
183 the command line tools and tests.
184 * `SPIRV_USE_SANITIZER=<sanitizer>`, default is no sanitizing - On UNIX
185 platforms with an appropriate version of `clang` this option enables the use
186 of the sanitizers documented [here][clang-sanitizers].
187 This should only be used with a debug build.
188 * `SPIRV_WARN_EVERYTHING={ON|OFF}`, default `OFF` - On UNIX platforms enable
189 more strict warnings. The code might not compile with this option enabled.
190 For Clang, enables `-Weverything`. For GCC, enables `-Wpedantic`.
191 See [`CMakeLists.txt`](CMakeLists.txt) for details.
192 * `SPIRV_WERROR={ON|OFF}`, default `ON` - Forces a compilation error on any
193 warnings encountered by enabling the compiler-specific compiler front-end
200 The internals of the library use C++11 features, and are exposed via both a C
203 In order to use the library from an application, the include path should point
204 to `<spirv-dir>/include`, which will enable the application to include the
205 header `<spirv-dir>/include/spirv-tools/libspirv.h{|pp}` then linking against
206 the static library in `<spirv-build-dir>/source/libSPIRV-Tools.a` or
207 `<spirv-build-dir>/source/SPIRV-Tools.lib`.
208 For optimization, the header file is
209 `<spirv-dir>/include/spirv-tools/optimizer.hpp`, and the static library is
210 `<spirv-build-dir>/source/libSPIRV-Tools-opt.a` or
211 `<spirv-build-dir>/source/SPIRV-Tools-opt.lib`.
213 * `SPIRV-Tools` CMake target: Creates the static library:
214 * `<spirv-build-dir>/source/libSPIRV-Tools.a` on Linux and OS X.
215 * `<spirv-build-dir>/source/libSPIRV-Tools.lib` on Windows.
216 * `SPIRV-Tools-opt` CMake target: Creates the static library:
217 * `<spirv-build-dir>/source/libSPIRV-Tools-opt.a` on Linux and OS X.
218 * `<spirv-build-dir>/source/libSPIRV-Tools-opt.lib` on Windows.
222 The interfaces are still under development, and are expected to change.
224 There are five main entry points into the library in the C interface:
226 * `spvTextToBinary`: An assembler, translating text to a binary SPIR-V module.
227 * `spvBinaryToText`: A disassembler, translating a binary SPIR-V module to
229 * `spvBinaryParse`: The entry point to a binary parser API. It issues callbacks
230 for the header and each parsed instruction. The disassembler is implemented
231 as a client of `spvBinaryParse`.
232 * `spvValidate` implements the validator functionality. *Incomplete*
233 * `spvValidateBinary` implements the validator functionality. *Incomplete*
235 The C++ interface is comprised of two classes, `SpirvTools` and `Optimizer`,
236 both in the `spvtools` namespace.
237 * `SpirvTools` provides `Assemble`, `Disassemble`, and `Validate` methods.
238 * `Optimizer` provides methods for registering and running optimization passes.
240 ## Command line tools
242 Command line tools, which wrap the above library functions, are provided to
243 assemble or disassemble shader files. It's a convention to name SPIR-V
244 assembly and binary files with suffix `.spvasm` and `.spv`, respectively.
248 The assembler reads the assembly language text, and emits the binary form.
250 The standalone assembler is the exectuable called `spirv-as`, and is located in
251 `<spirv-build-dir>/tools/spirv-as`. The functionality of the assembler is implemented
252 by the `spvTextToBinary` library function.
254 * `spirv-as` - the standalone assembler
255 * `<spirv-dir>/tools/as`
257 Use option `-h` to print help.
259 ### Disassembler tool
261 The disassembler reads the binary form, and emits assembly language text.
263 The standalone disassembler is the executable called `spirv-dis`, and is located in
264 `<spirv-build-dir>/tools/spirv-dis`. The functionality of the disassembler is implemented
265 by the `spvBinaryToText` library function.
267 * `spirv-dis` - the standalone disassembler
268 * `<spirv-dir>/tools/dis`
270 Use option `-h` to print help.
272 The output includes syntax colouring when printing to the standard output stream,
273 on Linux, Windows, and OS X.
277 The optimizer processes a SPIR-V binary module, applying transformations
278 in the specified order.
280 This is a work in progress, with initially only few available transformations.
282 * `spirv-opt` - the standalone optimizer
283 * `<spirv-dir>/tools/opt`
287 *Warning:* This functionality is under development, and is incomplete.
289 The standalone validator is the executable called `spirv-val`, and is located in
290 `<spirv-build-dir>/tools/spirv-val`. The functionality of the validator is implemented
291 by the `spvValidate` library function.
293 The validator operates on the binary form.
295 * `spirv-val` - the standalone validator
296 * `<spirv-dir>/tools/val`
298 ### Control flow dumper tool
300 The control flow dumper prints the control flow graph for a SPIR-V module as a
301 [GraphViz](http://www.graphviz.org/) graph.
303 This is experimental.
305 * `spirv-cfg` - the control flow graph dumper
306 * `<spirv-dir>/tools/cfg`
310 * `spirv-lesspipe.sh` - Automatically disassembles `.spv` binary files for the
311 `less` program, on compatible systems. For example, set the `LESSOPEN`
312 environment variable as follows, assuming both `spirv-lesspipe.sh` and
313 `spirv-dis` are on your executable search path:
315 export LESSOPEN='| spirv-lesspipe.sh "%s"'
317 Then you page through a disassembled module as follows:
321 * The `spirv-lesspipe.sh` script will pass through any extra arguments to
322 `spirv-dis`. So, for example, you can turn off colours and friendly ID
325 export LESSOPEN='| spirv-lesspipe.sh "%s" --no-color --raw-id'
328 * [vim-spirv](https://github.com/kbenzie/vim-spirv) - A vim plugin which
329 supports automatic disassembly of `.spv` files using the `:edit` command and
330 assembly using the `:write` command. The plugin also provides additional
331 features which include; syntax highlighting; highlighting of all ID's matching
332 the ID under the cursor; and highlighting errors where the `Instruction`
333 operand of `OpExtInst` is used without an appropriate `OpExtInstImport`.
335 * `50spirv-tools.el` - Automatically disassembles '.spv' binary files when
336 loaded into the emacs text editor, and re-assembles them when saved,
337 provided any modifications to the file are valid. This functionality
338 must be explicitly requested by defining the symbol
339 SPIRV_TOOLS_INSTALL_EMACS_HELPERS as follows:
341 cmake -DSPIRV_TOOLS_INSTALL_EMACS_HELPERS=true ...
344 In addition, this helper is only installed if the directory /etc/emacs/site-start.d
345 exists, which is typically true if emacs is installed on the system.
347 Note that symbol IDs are not currently preserved through a load/edit/save operation.
348 This may change if the ability is added to spirv-as.
353 Tests are only built when googletest is found. Use `ctest` to run all the
357 <a name="future"></a>
359 _See the [projects pages](https://github.com/KhronosGroup/SPIRV-Tools/projects)
360 for more information._
362 ### Assembler and disassembler
364 * The disassembler could emit helpful annotations in comments. For example:
365 * Use variable name information from debug instructions to annotate
366 key operations on variables.
367 * Show control flow information by annotating `OpLabel` instructions with
368 that basic block's predecessors.
369 * Error messages could be improved.
373 This is a work in progress.
376 <a name="license"></a>
377 Full license terms are in [LICENSE](LICENSE)
379 Copyright (c) 2015-2016 The Khronos Group Inc.
381 Licensed under the Apache License, Version 2.0 (the "License");
382 you may not use this file except in compliance with the License.
383 You may obtain a copy of the License at
385 http://www.apache.org/licenses/LICENSE-2.0
387 Unless required by applicable law or agreed to in writing, software
388 distributed under the License is distributed on an "AS IS" BASIS,
389 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
390 See the License for the specific language governing permissions and
391 limitations under the License.
394 [spirv-registry]: https://www.khronos.org/registry/spir-v/
395 [spirv-headers]: https://github.com/KhronosGroup/SPIRV-Headers
396 [googletest]: https://github.com/google/googletest
397 [googletest-pull-612]: https://github.com/google/googletest/pull/612
398 [googletest-issue-610]: https://github.com/google/googletest/issues/610
399 [CMake]: https://cmake.org/
400 [cpp-style-guide]: https://google.github.io/styleguide/cppguide.html
401 [clang-sanitizers]: http://clang.llvm.org/docs/UsersManual.html#controlling-code-generation