Google Git
Sign in
android / platform / external / shaderc / spirv-tools / refs/tags/ndk-r22
tag7319c0fb7b7885568f966d790c79c0f1d8750e2e
taggerThe Android Open Source Project <initial-contribution@android.com>Fri Jan 08 11:40:14 2021 -0800
object59c2b3935ce57a20a9cc0cc5e0a2f5b0075ba9fe 
Android NDK r22 (7026061)
commit59c2b3935ce57a20a9cc0cc5e0a2f5b0075ba9fe[log] [tgz]
authorDavid Neto <dneto@google.com>Mon Sep 28 10:29:14 2020 -0400
committerDavid Neto <dneto@google.com>Mon Sep 28 10:29:14 2020 -0400
tree9a4b3ff0c457ea62961e72c112586bfe347e10ff
parenta38c7b3dd8657c6fc3fe0a19f1973a7f7813606b [diff]
parentb27e039c68dd9eb959bb9249fcb2c9a54841474b [diff]
Merge commit 'aosp v2020.5' into update-shaderc

Includes:
b27e039c Finalize SPIRV-Tools v2020.5
a5903a96 Update CHANGES
330c7254 spirv-fuzz: Support dead blocks in TransformationAddSynonym (#3832)
36185f8b spirv-fuzz: Move IRContext parameter into constructor (#3837)
0e7fe4d3 Add missing backticks around <result-id> (#3840)
d1bb98fd Validate SPIRV Version number when parsing binary header (#3834)
67525bde spirv-fuzz: Create synonym of int constant using a loop (#3790)
7cc4b4d2 Fix compiler error on macOS with XCode12 (#3836)
5a5b750a spirv-fuzz: Handle OpPhis in TransformationInlineFunction (#3833)
0a1fb588 Update CHANGES
125b6424 spirv-fuzz: Refactor fuzzer, replayer and shrinker (#3818)
60ce96e2 spirv-fuzz: Add pass recommendations (#3757)
2945963c spirv-fuzz: Consider all ids from dead blocks irrelevant (#3795)
50ae4c5f Fix header guard macros (#3811)
296e9c7b spirv-fuzz: Fix TransformationDuplicateRegionWithSelection (#3815)
937a757f spirv-val: Add DeviceIndex (#3812)
34ef0c3f Fix missed modification flagging (#3814)
748edbf8 spirv-fuzz: Use an irrelevant id for the unused components (#3810)
8d49fb2f spirv-fuzz: Improvements to random number generation (#3809)
7e28d809 Add buffer oob check to bindless instrumentation (#3800)
8fc50411 spirv-fuzz: Remove CanFindOrCreateZeroConstant (#3807)
e8ce4355 spirv-fuzz: Add bit instruction synonym transformation (#3775)
e7c84fed spirv-fuzz: Skip unreachable blocks (#3729)
f20b523c Fix build errors (#3804)
3131686d spirv-fuzz: Handle invalid ids in fact manager (#3742)
4c239bd8 spirv-fuzz: Support memory instructions MoveInstructionDown (#3700)
1e1c308d spirv-fuzz: Pass submanagers to other submanagers when necessary (#3796)
f62357e7 spirv-fuzz: Transformation to flatten conditional branch (#3667)
5df93005 spirv-val: Add BaseInstance, BaseVertex, DrawIndex, and ViewIndex (#3782)
286b3095 Properly mark IR changed if instruction folder creates more than one constant. (#3799)
726af6f7 Add missing file to BUILD.gn (#3798)
244e6c1b spirv-fuzz: Add TransformationDuplicateRegionWithSelection (#3773)
5dcb576b spirv-reduce: Support reducing a specific function (#3774)
de7d5798 spirv-reduce: Refactoring (#3793)
ed9863e4 Favour 'integrity' over 'coherence' as a replacement for 'sanity'. (#3619)
8743d385 spirv-fuzz: Fix header guards in transformations/fuzzer passes (#3784)
2de7d3af spirv-fuzz: Add SPIRV_FUZZ_PROTOC_COMMAND (#3789)
e589d0d5 Add missing include (#3788)
a715b1b4 Improve spirv-fuzz CMake code (#3781)
a187dd58 Allow SPV_KHR_8bit_storage extension. (#3780)
1ab52e54 spirv-opt: Add function to compute nesting depth of a block (#3771)
fd05605b spirv-fuzz: Transformation to convert OpSelect to conditional branch (#3681)
2c60d16a spirv-val: Add Vulkan VUID labels to BuiltIn (#3756)
c341f7a6 spirv-fuzz: Add support for BuiltIn decoration (#3736)
c278dada spirv-fuzz: Fix GetIdEquivalenceClasses (#3767)
78846840 spirv-fuzz: Replace id in OpPhi coming from a dead predecessor (#3744)
3daabd32 spirv-fuzz: Transformation to replace the use of an irrelevant id (#3697)
d7f078f2 spirv-fuzz: TransformationMutatePointer (#3737)
43a51860 spirv-fuzz: Compute interprocedural loop nesting depth of blocks (#3753)
8a0ebd40 Correctly replace debug lexical scope of instruction (#3718)
f428aa39 spirv-fuzz: Remove opaque pointer design pattern (#3755)
08291a3a spirv-fuzz: Create synonym via OpPhi and existing synonyms (#3701)
7e4948b2 Add LoopNestingDepth function to StructuredCFGAnalysis (#3754)
50cf38b8 spirv-fuzz: Do not make synonyms of void result ids (#3747)
bceab9fa Do not register DebugFunction for functions optimized away. (#3749)
e02f178a Handle DebugScope in compact-ids pass (#3724)
9e26ae04 spirv-fuzz: Overflow ids (#3734)
2205254c Fix DebugNoScope to not output InlinedAt operand. (#3748)
230f363e spirv-fuzz: Split the fact manager into multiple files (#3699)
5adc5ae6 spirv-fuzz: Add inline function transformation (#3517)
1341b58a spirv-fuzz: Fix MaybeGetZeroConstant (#3740)
12df3caf Fix SSA-rewrite to remove DebugDeclare for variables without loads (#3719)
3f8501de Add undef for inlined void function (#3720)
4dd12239 spirv-fuzz: Add words instead of logical operands (#3728)
b79773a3 CCP should mark IR changed if it created new constants. (#3732)
a711c594 spirv-fuzz: add FuzzerPassAddCompositeInserts (#3606)
582c276d spirv-fuzz: Support pointer types in FuzzerPassAddParameters (#3627)
3434cb0b Let ADCE pass check DebugScope (#3703)
ee7f0c88 spirv-opt: Implement opt::Function::HasEarlyReturn function (#3711)
e28436f2 spirv-fuzz: Check termination instructions when donating modules (#3710)
1023dd7a Fix -Wrange-loop-analysis warning (#3712)
82f4bf12 spirv-fuzz: Check header dominance when adding dead block (#3694)
b8de4f57 Allow DebugTypeTemplate for Type operand (#3702)
c20995ef spirv-fuzz: Improve code coverage of tests (#3686)
eade36db spirv-fuzz: Fuzzer pass to randomly apply loop preheaders (#3668)
72ea7bec spirv-fuzz: Support identical predecessors in TransformationPropagateInstructionUp (#3689)
b4c4da3e Improve non-semantic instruction handling in the optimizer (#3693)
948577c5 Fix the bug (#3680)
df859f77 spirv-fuzz: Check integer and float width capabilities (#3670)
2641d335 spirv-fuzz: consider additional access chain instructions (#3672)
5e592945 spirv-fuzz: Ignore specialization constants (#3664)
1435e427 Fix the bug (#3683)
be099cde spirv-fuzz: Fix width in FuzzerPassAddEquationInstructions (#3685)
f0ca96d1 Preserve debug info in dead-insert-elim pass (#3652)
0d629b90 Validate more OpenCL.DebugInfo.100 instructions (#3684)
13a65b1a Only validation locations for appropriate execution models (#3656)
fd3cabd8 spirv-fuzz: Fix in operand type assertion (#3666)
f5055386 spirv-opt: Add spvOpcodeIsAccessChain (#3682)
b7056e7e spirv-fuzz: FuzzerPassPropagateInstructionsUp (#3478)
8e138099 Handle no index access chain in local access chain convert (#3678)
bdeeae78 Roll 2 dependencies (#3677)
2990a219 Avoid using /MP4 for clang on windows. (#3662)
7b2dd11d spirv-fuzz: TransformationReplaceAddSubMulWithCarryingExtended (#3598)
6d7f34fb spirv-fuzz: Add TransformationMakeVectorOperationDynamic (#3597)
d29eac95 spirv-fuzz: iterate over blocks in replace linear algebra pass (#3654)
efc85ff6 spirv-fuzz: make outliner pass use additional transformations (#3604)
5fd92a7e OpenCL.DebugInfo.100 DebugTypeArray with variable size (#3549)
3f33a9aa spirv-opt: Improve the code of the Instruction class (#3610)
0419751b spirv-fuzz: Handle OpPhis in livesafe functions (#3642)
a10e7605 spirv-fuzz: Handle OpPhi during constant obfuscation (#3640)
28f32ca5 spirv-fuzz: Fix FuzzerPassCopyObjects (#3638)
8bc27a1c spirv-fuzz: Remove OpFunctionCall operands in correct order (#3630)
d9c73ebd spirv-fuzz: Handle capabilities during module donation (#3651)
9f222360 spirv-fuzz: Refactor boilerplate in TransformationAddParameter (#3625)
92a71657 spirv-fuzz: TransformationMoveInstructionDown (#3477)
b78f4b15 Remove DebugDeclare only for target variables in ssa-rewrite (#3511)
91cea06a Fix typo in ASAN CI build (#3623)
2aaa8653 spirv-fuzz: Transformation to add loop preheader (#3599)
96bcc827 spirv-fuzz: Pass to replace int operands with ints of opposite signedness (#3612)
ebaefda6 Debug info preservation in loop-unroll pass (#3548)
50300450 Validator support for non-semantic clspv reflection (#3618)
ab4fe12a spirv-fuzz: Fix memory bugs (#3622)
c6e6597c spirv-fuzz: Implement the OpOuterProduct linear algebra case (#3617)
054f034e spirv-fuzz: Compute corollary facts from OpBitcast (#3538)
a1ea15c9 Update some language usage. (#3611)
863b8e3d spirv-fuzz: Relax type constraints in DataSynonym facts (#3602)
7e75fea9 spirv-fuzz: Remove non-deterministic behaviour (#3608)
f9b088fe Avoid use of 'sanity' and 'sanity check' in the code base (#3585)
150be20d spirv-fuzz: Add condition to make functions livesafe (#3587)
ce16ccf3 Rolling 4 dependencies (#3601)
1dfc6fc7 spirv-fuzz: Implement the OpTranspose linear algebra case (#3589)
b63f0e5e Fix SyntaxWarning in Python 3.8 (#3388)
6aed7ffb CMake: Enable building with BUILD_SHARED_LIBS=1 (#3490)
31c82139 Avoid operand type range checks (#3379)
6a3eb679 Preserve debug info in scalar replacement pass (#3461)
2796840d Update OpenCL capabilities validation (#3149)
b25ee93c build(deps): bump lodash from 4.17.15 to 4.17.19 in /tools/sva (#3596)
8a550065 spirv-fuzz: adds TransformationReplaceLoadStoreWithCopyMemory (#3586)
7c901a49 Preserve OpenCL.DebugInfo.100 through private-to-local pass (#3571)
767518e8 spirv-fuzz: Relax type checking for int contants (#3573)
f8920bcf spirv-fuzz: Generalise transformation access chain (#3546)
98ac9fd6 spirv-fuzz: Split blocks starting with OpPhi before trying to outline (#3581)
059ab081 spirv-fuzz: Set message consumer in replayer when shrinking (#3591)
d6306537 spirv-fuzz: Don't use default parameters (#3583)
969f0286 Change DEPS rolling script to point at external/ (#3584)
1aaf5c61 spirv-fuzz: Create a helper in fuzzerutil to reuse function type (#3572)
89b3bc5a spirv-fuzz: Test usages of IdIsIrrelevant fact (#3578)
9dc1bfa3 spirv-fuzz: adds TransformationReplaceCopyMemoryWithLoadStore (#3575)
586a12b9 spirv-fuzz: adds TransformationReplaceCopyObjectWithStoreLoad (#3567)
0b84727f Start SPIRV-Tools v2020.5

Testing: checkbuild.py on Linux; unit tests on Windows
Change-Id: I64fbe29fd1e9b05d10ae358a25a207bbdebb715c
tree: 9a4b3ff0c457ea62961e72c112586bfe347e10ff
  1. android_test/
  2. build_overrides/
  3. cmake/
  4. docs/
  5. examples/
  6. external/
  7. include/
  8. kokoro/
  9. source/
  10. test/
  11. tools/
  12. utils/
  13. .appveyor.yml
  14. .clang-format
  15. .gitignore
  16. .gn
  17. Android.mk
  18. BUILD.bazel
  19. BUILD.gn
  20. build_defs.bzl
  21. CHANGES
  22. CMakeLists.txt
  23. CODE_OF_CONDUCT.md
  24. codereview.settings
  25. CONTRIBUTING.md
  26. DEPS
  27. LICENSE
  28. PRESUBMIT.py
  29. README.md
  30. WORKSPACE
README.md

SPIR-V Tools

Overview

The SPIR-V Tools project provides an API and commands for processing SPIR-V modules.

The project includes an assembler, binary module parser, disassembler, validator, and optimizer for SPIR-V. Except for the optimizer, all are based on a common static library. The library contains all of the implementation details, and is used in the standalone tools whilst also enabling integration into other code bases directly. The optimizer implementation resides in its own library, which depends on the core library.

The interfaces have stabilized: We don't anticipate making a breaking change for existing features.

SPIR-V is defined by the Khronos Group Inc. See the SPIR-V Registry for the SPIR-V specification, headers, and XML registry.

Downloads

Build status Linux Build Status MacOS Build Status Windows Build Status

More downloads

Versioning SPIRV-Tools

See CHANGES for a high level summary of recent changes, by version.

SPIRV-Tools project version numbers are of the form vyear.index and with an optional -dev suffix to indicate work in progress. For example, the following versions are ordered from oldest to newest:

  • v2016.0
  • v2016.1-dev
  • v2016.1
  • v2016.2-dev
  • v2016.2

Use the --version option on each command line tool to see the software version. An API call reports the software version as a C-style string.

Supported features

Assembler, binary parser, and disassembler

  • Support for SPIR-V 1.0, through 1.5
    • Based on SPIR-V syntax described by JSON grammar files in the SPIRV-Headers repository.
    • Usually, support for a new version of SPIR-V is ready within days after publication.
  • Support for extended instruction sets:
    • GLSL std450 version 1.0 Rev 3
    • OpenCL version 1.0 Rev 2
  • Assembler only does basic syntax checking. No cross validation of IDs or types is performed, except to check literal arguments to OpConstant, OpSpecConstant, and OpSwitch.

See docs/syntax.md for the assembly language syntax.

Validator

The validator checks validation rules described by the SPIR-V specification.

Khronos recommends that tools that create or transform SPIR-V modules use the validator to ensure their outputs are valid, and that tools that consume SPIR-V modules optionally use the validator to protect themselves from bad inputs. This is especially encouraged for debug and development scenarios.

The validator has one-sided error: it will only return an error when it has implemented a rule check and the module violates that rule.

The validator is incomplete. See the CHANGES file for reports on completed work, and the Validator sub-project for planned and in-progress work.

Note: The validator checks some Universal Limits, from section 2.17 of the SPIR-V spec. The validator will fail on a module that exceeds those minimum upper bound limits. It is future work to parameterize the validator to allow larger limits accepted by a more than minimally capable SPIR-V consumer.

Optimizer

The optimizer is a collection of code transforms, or “passes”. Transforms are written for a diverse set of reasons:

  • To restructure, simplify, or normalize the code for further processing.
  • To eliminate undesirable code.
  • To improve code quality in some metric such as size or performance. Note: These transforms are not guaranteed to actually improve any given metric. Users should always measure results for their own situation.

As of this writing, there are 67 transforms including examples such as:

  • Simplification
    • Strip debug info
    • Strip reflection info
  • Specialization Constants
    • Set spec constant default value
    • Freeze spec constant to default value
    • Fold OpSpecConstantOp and OpSpecConstantComposite
    • Unify constants
    • Eliminate dead constant
  • Code Reduction
    • Inline all function calls exhaustively
    • Convert local access chains to inserts/extracts
    • Eliminate local load/store in single block
    • Eliminate local load/store with single store
    • Eliminate local load/store with multiple stores
    • Eliminate local extract from insert
    • Eliminate dead instructions (aggressive)
    • Eliminate dead branches
    • Merge single successor / single predecessor block pairs
    • Eliminate common uniform loads
    • Remove duplicates: Capabilities, extended instruction imports, types, and decorations.
  • Normalization
    • Compact IDs
    • CFG cleanup
    • Flatten decorations
    • Merge returns
    • Convert AMD-specific instructions to KHR instructions
  • Code improvement
    • Conditional constant propagation
    • If-conversion
    • Loop fission
    • Loop fusion
    • Loop-invariant code motion
    • Loop unroll
  • Other
    • Generate WebGPU initializers
    • Graphics robust access
    • Upgrade memory model to VulkanKHR

Additionally, certain sets of transformations have been packaged into higher-level recipes. These include:

  • Optimization for size (spirv-opt -Os)
  • Optimization for performance (spirv-opt -O)

For the latest list with detailed documentation, please refer to include/spirv-tools/optimizer.hpp.

For suggestions on using the code reduction options, please refer to this white paper.

Linker

Note: The linker is still under development.

Current features:

  • Combine multiple SPIR-V binary modules together.
  • Combine into a library (exports are retained) or an executable (no symbols are exported).

See the CHANGES file for reports on completed work, and the General sub-project for planned and in-progress work.

Reducer

Note: The reducer is still under development.

The reducer simplifies and shrinks a SPIR-V module with respect to a user-supplied interestingness function. For example, given a large SPIR-V module that cause some SPIR-V compiler to fail with a given fatal error message, the reducer could be used to look for a smaller version of the module that causes the compiler to fail with the same fatal error message.

To suggest an additional capability for the reducer, file an issue with “Reducer:” as the start of its title.

Fuzzer

Note: The fuzzer is still under development.

The fuzzer applies semantics-preserving transformations to a SPIR-V binary module, to produce an equivalent module. The original and transformed modules should produce essentially identical results when executed on identical inputs: their results should differ only due to floating-point round-off, if at all. Significant differences in results can pinpoint bugs in tools that process SPIR-V binaries, such as miscompilations. This metamorphic testing approach is similar to the method used by the GraphicsFuzz project for fuzzing of GLSL shaders.

To suggest an additional capability for the fuzzer, file an issue with “Fuzzer:” as the start of its title.

Extras

  • Utility filters
  • Build target spirv-tools-vimsyntax generates file spvasm.vim. Copy that file into your $HOME/.vim/syntax directory to get SPIR-V assembly syntax highlighting in Vim. This build target is not built by default.

Contributing

The SPIR-V Tools project is maintained by members of the The Khronos Group Inc., and is hosted at https://github.com/KhronosGroup/SPIRV-Tools.

Consider joining the public_spirv_tools_dev@khronos.org mailing list, via https://www.khronos.org/spir/spirv-tools-mailing-list/. The mailing list is used to discuss development plans for the SPIRV-Tools as an open source project. Once discussion is resolved, specific work is tracked via issues and sometimes in one of the projects.

(To provide feedback on the SPIR-V specification, file an issue on the SPIRV-Headers GitHub repository.)

See docs/projects.md to see how we use the GitHub Project feature to organize planned and in-progress work.

Contributions via merge request are welcome. Changes should:

We intend to maintain a linear history on the GitHub master branch.

Source code organization

  • example: demo code of using SPIRV-Tools APIs
  • external/googletest: Intended location for the googletest sources, not provided
  • external/effcee: Location of Effcee sources, if the effcee library is not already configured by an enclosing project.
  • external/re2: Location of RE2 sources, if the re2 library is not already configured by an enclosing project. (The Effcee project already requires RE2.)
  • include/: API clients should add this directory to the include search path
  • external/spirv-headers: Intended location for SPIR-V headers, not provided
  • include/spirv-tools/libspirv.h: C API public interface
  • source/: API implementation
  • test/: Tests, using the googletest framework
  • tools/: Command line executables

Example of getting sources, assuming SPIRV-Tools is configured as a standalone project:

git clone https://github.com/KhronosGroup/SPIRV-Tools.git   spirv-tools
git clone https://github.com/KhronosGroup/SPIRV-Headers.git spirv-tools/external/spirv-headers
git clone https://github.com/google/googletest.git          spirv-tools/external/googletest
git clone https://github.com/google/effcee.git              spirv-tools/external/effcee
git clone https://github.com/google/re2.git                 spirv-tools/external/re2

Tests

The project contains a number of tests, used to drive development and ensure correctness. The tests are written using the googletest framework. The googletest source is not provided with this project. There are two ways to enable tests:

  • If SPIR-V Tools is configured as part of an enclosing project, then the enclosing project should configure googletest before configuring SPIR-V Tools.
  • If SPIR-V Tools is configured as a standalone project, then download the googletest source into the <spirv-dir>/external/googletest directory before configuring and building the project.

Note: You must use a version of googletest that includes a fix for googletest issue 610. The fix is included on the googletest master branch any time after 2015-11-10. In particular, googletest must be newer than version 1.7.0.

Dependency on Effcee

Some tests depend on the Effcee library for stateful matching. Effcee itself depends on RE2.

  • If SPIRV-Tools is configured as part of a larger project that already uses Effcee, then that project should include Effcee before SPIRV-Tools.
  • Otherwise, SPIRV-Tools expects Effcee sources to appear in external/effcee and RE2 sources to appear in external/re2.

Build

Instead of building manually, you can also download the binaries for your platform directly from the master-tot release on GitHub. Those binaries are automatically uploaded by the buildbots after successful testing and they always reflect the current top of the tree of the master branch.

In order to build the code, you first need to sync the external repositories that it depends on. Assume that <spirv-dir> is the root directory of the checked out code:

cd <spirv-dir>
git clone https://github.com/KhronosGroup/SPIRV-Headers.git external/spirv-headers
git clone https://github.com/google/effcee.git external/effcee
git clone https://github.com/google/re2.git external/re2
git clone https://github.com/google/googletest.git external/googletest # optional

Note: The script utils/git-sync-deps can be used to checkout and/or update the contents of the repos under external/ instead of manually maintaining them.

Build using CMake

You can build the project using CMake:

cd <spirv-dir>
mkdir build && cd build
cmake [-G <platform-generator>] <spirv-dir>

Once the build files have been generated, build using the appropriate build command (e.g. ninja, make, msbuild, etc.; this depends on the platform generator used above), or use your IDE, or use CMake to run the appropriate build command for you:

cmake --build . [--config Debug]  # runs `make` or `ninja` or `msbuild` etc.

Note about the fuzzer

The SPIR-V fuzzer, spirv-fuzz, can only be built via CMake, and is disabled by default. To build it, clone protobuf and use the SPIRV_BUILD_FUZZER CMake option, like so:

# In <spirv-dir> (the SPIRV-Tools repo root):
git clone --depth=1 --branch v3.13.0 https://github.com/protocolbuffers/protobuf external/protobuf

# In your build directory:
cmake [-G <platform-generator>] <spirv-dir> -DSPIRV_BUILD_FUZZER=ON
cmake --build . --config Debug

You can also add -DSPIRV_ENABLE_LONG_FUZZER_TESTS=ON to build additional fuzzer tests.

Build using Bazel

You can also use Bazel to build the project.

cd <spirv-dir>
bazel build :all

Tools you'll need

For building and testing SPIRV-Tools, the following tools should be installed regardless of your OS:

  • CMake: if using CMake for generating compilation targets, you need to install CMake Version 2.8.12 or later.
  • Python 3: for utility scripts and running the test suite.
  • Bazel (optional): if building the source with Bazel, you need to install Bazel Version 0.29.1 on your machine. Other versions may also work, but are not verified.

SPIRV-Tools is regularly tested with the following compilers:

On Linux

  • GCC version 4.8.5
  • Clang version 3.8

On MacOS

  • AppleClang 10.0

On Windows

  • Visual Studio 2015
  • Visual Studio 2017

Other compilers or later versions may work, but they are not tested.

CMake options

The following CMake options are supported:

  • SPIRV_BUILD_FUZZER={ON|OFF}, default OFF - Build the spirv-fuzz tool.
  • SPIRV_COLOR_TERMINAL={ON|OFF}, default ON - Enables color console output.
  • SPIRV_SKIP_TESTS={ON|OFF}, default OFF- Build only the library and the command line tools. This will prevent the tests from being built.
  • SPIRV_SKIP_EXECUTABLES={ON|OFF}, default OFF- Build only the library, not the command line tools and tests.
  • SPIRV_USE_SANITIZER=<sanitizer>, default is no sanitizing - On UNIX platforms with an appropriate version of clang this option enables the use of the sanitizers documented here. This should only be used with a debug build.
  • SPIRV_WARN_EVERYTHING={ON|OFF}, default OFF - On UNIX platforms enable more strict warnings. The code might not compile with this option enabled. For Clang, enables -Weverything. For GCC, enables -Wpedantic. See CMakeLists.txt for details.
  • SPIRV_WERROR={ON|OFF}, default ON - Forces a compilation error on any warnings encountered by enabling the compiler-specific compiler front-end option. No compiler front-end options are enabled when this option is OFF.

Additionally, you can pass additional C preprocessor definitions to SPIRV-Tools via setting SPIRV_TOOLS_EXTRA_DEFINITIONS. For example, by setting it to /D_ITERATOR_DEBUG_LEVEL=0 on Windows, you can disable checked iterators and iterator debugging.

Android

SPIR-V Tools supports building static libraries libSPIRV-Tools.a and libSPIRV-Tools-opt.a for Android:

cd <spirv-dir>

export ANDROID_NDK=/path/to/your/ndk

mkdir build && cd build
mkdir libs
mkdir app

$ANDROID_NDK/ndk-build -C ../android_test     \
                      NDK_PROJECT_PATH=.      \
                      NDK_LIBS_OUT=`pwd`/libs \
                      NDK_APP_OUT=`pwd`/app

Updating DEPS

Occasionally the entries in DEPS will need to be updated. This is done on demand when there is a request to do this, often due to downstream breakages. There is a script utils/roll_deps.sh provided, which will generate a patch with the updated DEPS values. This will still need to be tested in your checkout to confirm that there are no integration issues that need to be resolved.

Library

Usage

The internals of the library use C++11 features, and are exposed via both a C and C++ API.

In order to use the library from an application, the include path should point to <spirv-dir>/include, which will enable the application to include the header <spirv-dir>/include/spirv-tools/libspirv.h{|pp} then linking against the static library in <spirv-build-dir>/source/libSPIRV-Tools.a or <spirv-build-dir>/source/SPIRV-Tools.lib. For optimization, the header file is <spirv-dir>/include/spirv-tools/optimizer.hpp, and the static library is <spirv-build-dir>/source/libSPIRV-Tools-opt.a or <spirv-build-dir>/source/SPIRV-Tools-opt.lib.

  • SPIRV-Tools CMake target: Creates the static library:
    • <spirv-build-dir>/source/libSPIRV-Tools.a on Linux and OS X.
    • <spirv-build-dir>/source/libSPIRV-Tools.lib on Windows.
  • SPIRV-Tools-opt CMake target: Creates the static library:
    • <spirv-build-dir>/source/libSPIRV-Tools-opt.a on Linux and OS X.
    • <spirv-build-dir>/source/libSPIRV-Tools-opt.lib on Windows.

Entry points

The interfaces are still under development, and are expected to change.

There are five main entry points into the library in the C interface:

  • spvTextToBinary: An assembler, translating text to a binary SPIR-V module.
  • spvBinaryToText: A disassembler, translating a binary SPIR-V module to text.
  • spvBinaryParse: The entry point to a binary parser API. It issues callbacks for the header and each parsed instruction. The disassembler is implemented as a client of spvBinaryParse.
  • spvValidate implements the validator functionality. Incomplete
  • spvValidateBinary implements the validator functionality. Incomplete

The C++ interface is comprised of three classes, SpirvTools, Optimizer and Linker, all in the spvtools namespace.

  • SpirvTools provides Assemble, Disassemble, and Validate methods.
  • Optimizer provides methods for registering and running optimization passes.
  • Linker provides methods for combining together multiple binaries.

Command line tools

Command line tools, which wrap the above library functions, are provided to assemble or disassemble shader files. It's a convention to name SPIR-V assembly and binary files with suffix .spvasm and .spv, respectively.

Assembler tool

The assembler reads the assembly language text, and emits the binary form.

The standalone assembler is the executable called spirv-as, and is located in <spirv-build-dir>/tools/spirv-as. The functionality of the assembler is implemented by the spvTextToBinary library function.

  • spirv-as - the standalone assembler
    • <spirv-dir>/tools/as

Use option -h to print help.

Disassembler tool

The disassembler reads the binary form, and emits assembly language text.

The standalone disassembler is the executable called spirv-dis, and is located in <spirv-build-dir>/tools/spirv-dis. The functionality of the disassembler is implemented by the spvBinaryToText library function.

  • spirv-dis - the standalone disassembler
    • <spirv-dir>/tools/dis

Use option -h to print help.

The output includes syntax colouring when printing to the standard output stream, on Linux, Windows, and OS X.

Linker tool

The linker combines multiple SPIR-V binary modules together, resulting in a single binary module as output.

This is a work in progress. The linker does not support OpenCL program linking options related to math flags. (See section 5.6.5.2 in OpenCL 1.2)

  • spirv-link - the standalone linker
    • <spirv-dir>/tools/link

Optimizer tool

The optimizer processes a SPIR-V binary module, applying transformations in the specified order.

This is a work in progress, with initially only few available transformations.

  • spirv-opt - the standalone optimizer
    • <spirv-dir>/tools/opt

Validator tool

Warning: This functionality is under development, and is incomplete.

The standalone validator is the executable called spirv-val, and is located in <spirv-build-dir>/tools/spirv-val. The functionality of the validator is implemented by the spvValidate library function.

The validator operates on the binary form.

  • spirv-val - the standalone validator
    • <spirv-dir>/tools/val

Reducer tool

The reducer shrinks a SPIR-V binary module, guided by a user-supplied interestingness test.

This is a work in progress, with initially only shrinks a module in a few ways.

  • spirv-reduce - the standalone reducer
    • <spirv-dir>/tools/reduce

Run spirv-reduce --help to see how to specify interestingness.

Fuzzer tool

The fuzzer transforms a SPIR-V binary module into a semantically-equivalent SPIR-V binary module by applying transformations in a randomized fashion.

This is a work in progress, with initially only a few semantics-preserving transformations.

  • spirv-fuzz - the standalone fuzzer
    • <spirv-dir>/tools/fuzz

Run spirv-fuzz --help for a detailed list of options.

Control flow dumper tool

The control flow dumper prints the control flow graph for a SPIR-V module as a GraphViz graph.

This is experimental.

  • spirv-cfg - the control flow graph dumper
    • <spirv-dir>/tools/cfg

Utility filters

  • spirv-lesspipe.sh - Automatically disassembles .spv binary files for the less program, on compatible systems. For example, set the LESSOPEN environment variable as follows, assuming both spirv-lesspipe.sh and spirv-dis are on your executable search path:

     export LESSOPEN='| spirv-lesspipe.sh "%s"'

    Then you page through a disassembled module as follows:

    less foo.spv
    • The spirv-lesspipe.sh script will pass through any extra arguments to spirv-dis. So, for example, you can turn off colours and friendly ID naming as follows:
      export LESSOPEN='| spirv-lesspipe.sh "%s" --no-color --raw-id'

  • vim-spirv - A vim plugin which supports automatic disassembly of .spv files using the :edit command and assembly using the :write command. The plugin also provides additional features which include; syntax highlighting; highlighting of all ID's matching the ID under the cursor; and highlighting errors where the Instruction operand of OpExtInst is used without an appropriate OpExtInstImport.

  • 50spirv-tools.el - Automatically disassembles ‘.spv’ binary files when loaded into the emacs text editor, and re-assembles them when saved, provided any modifications to the file are valid. This functionality must be explicitly requested by defining the symbol SPIRV_TOOLS_INSTALL_EMACS_HELPERS as follows:

    cmake -DSPIRV_TOOLS_INSTALL_EMACS_HELPERS=true ...

    In addition, this helper is only installed if the directory /etc/emacs/site-start.d exists, which is typically true if emacs is installed on the system.

    Note that symbol IDs are not currently preserved through a load/edit/save operation. This may change if the ability is added to spirv-as.

Tests

Tests are only built when googletest is found. Use ctest to run all the tests.

Future Work

See the projects pages for more information.

Assembler and disassembler

  • The disassembler could emit helpful annotations in comments. For example:
    • Use variable name information from debug instructions to annotate key operations on variables.
    • Show control flow information by annotating OpLabel instructions with that basic block's predecessors.
  • Error messages could be improved.

Validator

This is a work in progress.

Linker

  • The linker could accept math transformations such as allowing MADs, or other math flags passed at linking-time in OpenCL.
  • Linkage attributes can not be applied through a group.
  • Check decorations of linked functions attributes.
  • Remove dead instructions, such as OpName targeting imported symbols.

Licence

Full license terms are in LICENSE

Copyright (c) 2015-2016 The Khronos Group Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.