commit | 6f12baac0b877d2d3ca91035d645507310466410 | [log] [tgz] |
---|---|---|
author | David Neto <dneto@google.com> | Wed Dec 02 20:16:11 2020 -0500 |
committer | David Neto <dneto@google.com> | Wed Dec 02 20:37:54 2020 -0500 |
tree | 2245dadd6adf526032b1f12e5a85c967d67b898a | |
parent | 59c2b3935ce57a20a9cc0cc5e0a2f5b0075ba9fe [diff] | |
parent | c9c1f54330d13a0bec1aa3f08d436249d8e35596 [diff] |
Merge remote-tracking branch 'aosp/upstream-master' into update-shaderc Supports non-provisional Vulkan raytracing extensions Includes: c9c1f543 Update CHANGES 10e0ae79 Do run DCE if SPV_KHR_ray_query is used. (#4047) 84546647 Update CHANGES c1d5a045 Change ref_analysis to RefAnalysis to follow coding standards. (#4045) c502a15f Handle 8-bit index in elim dead member (#4043) 32573bb2 Add validation support for the ray tracing built-in variables (#4041) 7046c05d Add texel buffer out-of-bounds checking instrumentation (#4038) cf2d1e7a Update spirv-header deps (#4040) 1299436c Reject SPIR-V that applies void to OpUndef, OpCopyObject, OpPhi (#4036) 2c458414 BuildModule: optionally avoid adding new OpLine instructions (#4033) a79aa038 Remove prototype for unimplemented method (#4031) b0e22d28 spirv-fuzz: Fix facts arising from CompositeConstruct (#4034) 5ffa320f spirv-fuzz: Do not flatten conditionals that create synonyms (#4030) cd590fa3 Update MeshShadingNV dependencies (and land Ray tracing updates) (#4028) 671914c2 Fix buffer oob instrumentation for matrix refs (#4025) 1f2fcddd spirv-opt: Set parent when adding basic block (#4021) f686518c spirv-opt: properly preserve DebugValue indexes operand (#4022) 1cda4952 Use less stack space when validating Vulkan builtins (#4019) a61d07a7 spirv-val: Fix SPV_KHR_fragment_shading_rate VUID label (#4014) 650acb57 spirv-val: Label Layer and ViewportIndex VUIDs (#4013) 0c036df2 Add dead function elimination to -O (#4015) c2b2b578 Add DebugValue for invisible store in single_store_elim (#4002) c74d5523 Fix SSA re-writing in the presence of variable pointers. (#4010) 02195a02 spirv-fuzz: Fixes to pass management (#4011) bcf5b211 spirv-fuzz: Add support for reining in rogue fuzzer passes (#3987) 7d250ed5 spirv-fuzz: Fix assertion failure in FuzzerPassAddCompositeExtract (#3995) f9937bcc spirv-fuzz: Fix invalid equation facts (#4009) aa6035f1 spirv-fuzz: Fix bugs in TransformationFlattenConditionalBranch (#4006) 5735576f spirv-fuzz: Fix bug related to transformation applicability (#3990) f7da5277 Temporarily add EmptyPass to prevent glslang from failing (#4004) 82b378d6 spirv-opt: Add support to prevent functions from being inlined if they have DontInline flag (#3858) 56d0f503 Propagate OpLine to all applied instructions in spirv-opt (#3951) 7403dfaf CMake: Add SPIRV_TOOLS_BUILD_STATIC flag (#3910) 25ee2757 Avoid copying a ref in a loop (#4000) 5edb328e spirv-val: Allow the ViewportIndex and Layer built-ins on SPIR-V 1.5 (#3986) cbd1fa6c Simplify logic to decide whether CCP modified the IR (#3997) df4198e5 Add DebugValue for DebugDecl invisible to value assignment (#3973) 34ae8a47 Fix bounds check instrumentation to handle 16-bit values (#3983) abe2eff3 spirv-fuzz: Add expand vector reduction transformation (#3869) 99ad4f1e spirv-fuzz: Don't replace irrelevant indices in OpAccessChain (#3988) 895dafcc spirv-fuzz: Add FuzzerPassAddCompositeExtract (#3904) 69f07da4 spirv-fuzz: Fix mismatch with shrinker step limit (#3985) 9223493f spirv-fuzz: Fix off-by-one error in replayer (#3982) 4f542318 spirv-fuzz: Get order right for OpSelect arguments (#3974) 88f7bcb6 spirv-fuzz: Do not add synonym-creating loops in dead blocks (#3975) 64eaa983 spirv-fuzz: Skip OpTypeSampledImage when propagating up (#3976) 53f2a69c spirv-fuzz: Pass OpUndef in function call if needed (#3978) de2c0ba2 spirv-fuzz: Fix off-by-one in TransformationCompositeConstruct (#3979) dc4a1822 spirv-fuzz: Tolerate absent ids in data synonym fact management (#3966) 8496780f spirv-fuzz: Fix to id availability (#3971) 3b7aebca spirv-fuzz: Fix operand types (#3962) 6fe34cdf Update SPIRV-Headers revision in DEPS file (#3961) a8d7062f spirv-fuzz: Don't flatten conditional if condition is irrelevant (#3944) a3d5378d spirv-fuzz: Do not produce OpPhis of type OpTypeSampledImage (#3964) 7edd0525 spirv-fuzz: Restrict fuzzer pass to reachable blocks (#3970) f03779a1 spirv-fuzz: Handle more types when extending OpPhi instructions (#3969) c794b704 spirv-fuzz: Skip early terminator wrappers when merging returns (#3968) dc9c6407 spirv-fuzz: Avoid irrelevant constants in synonym-creating loops (#3967) 26954c28 spirv-fuzz: Skip dead blocks in FuzzerPassAddOpPhiSynonyms (#3965) 5600fb85 spirv-fuzz: Avoid the type manager when looking for struct types (#3963) ba15b588 spirv-fuzz: Fix to TransformationDuplicateRegionWithSelection (#3941) 59843500 spirv-fuzz: Skip OpFunction when replacing irrelevant ids (#3932) 8362eae5 spirv-fuzz: Use component-wise selectors when flattening conditional branches (#3921) ebe0ea09 Add SPV_EXT_shader_image_int64 (#3852) a1d38174 Support SPV_KHR_fragment_shading_rate (#3943) 6fac705e spirv-val: Fix validation of OpPhi instructions (#3919) b1350659 spirv-fuzz: Avoid void struct member when outlining functions (#3936) fd0f295d spirv-fuzz: Do not allow Block-decorated structs when adding parameters (#3931) 5d7893b3 spirv-fuzz: Fix to operand id type (#3937) cd1d3b6e spirv-fuzz: Handle dead blocks in TransformationEquationInstruction (#3933) 6cdae9da spirv-fuzz: Do not allow sampled image load when flattening conditionals (#3930) 7e1825a5 spirv-fuzz: Take care of OpPhi instructions when inlining (#3939) 502e9829 spirv-fuzz: Fix to TransformationInlineFunction (#3913) bf1a11da spirv-fuzz: Wrap early terminators before merging returns (#3925) fd3948e1 Add DebugValue for function param regardless of scope (#3923) 663d050a Temporary fix to make GoogleTest compile. (#3922) dd534e87 spirv-fuzz: Lower probability of adding bit instruction synonyms (#3917) 53aeba10 spirv-fuzz: Fix handling of OpPhi in FlattenConditionalBranch (#3916) 5c64374d spirv-fuzz: Avoid creating blocks without parents (#3908) 57b3723c spirv-fuzz: Do not allow creation of constants of block-decorated structs (#3903) 12ca825a spirv-fuzz: Fixes related to irrelevant ids (#3901) 2e6cf706 spirv-fuzz: Fix to transformation that adds a synonym via a loop (#3898) 4b884928 spirv-fuzz: Fix to duplicate region with selection (#3896) c2553a31 spirv-fuzz: Do not expose synonym facts for non-existent ids (#3891) 36022878 spirv-fuzz: Do not add synonyms involving irrelevant ids (#3890) d52f7912 spirv-fuzz: Do not replace irrelevant ids that are not in blocks (#3892) e0226599 spirv-fuzz: Wrap OpKill and similar in function calls (#3884) 11d59242 Update val to handle reversed instruction sections. (#3887) fc826485 spirv-fuzz: Replace dead-block terminators with OpKill etc. (#3882) 63cc22d6 spirv-fuzz: TransformationPropagateInstructionDown (#3692) 65b2a9e8 spirv-fuzz: Transformation to add wrappers for OpKill and similar (#3881) 624b16cd spirv-fuzz: Use overflow ids when duplicating regions (#3878) bd0dd9ce spirv-fuzz: Fix rvalue references (#3883) f1513378 spirv-fuzz: Avoid using block-decorated structs in transformations (#3877) 0e855307 spirv-fuzz: Use overflow ids when inlining functions (#3880) 67f8e2ed Debug info preservation in convert-local-access-chains pass (#3835) d91afd8d spirv-fuzz: Refactor fact manager tests (#3879) b920b620 spirv-fuzz: Integrate spirv-reduce with shrinker (#3849) 74a711a7 spirv-fuzz: Only recommend passes when a pass had an effect (#3863) fc7860e2 spirv-fuzz: Merge the return instructions in a function (#3838) 57abfd88 Debug info preservation in redundancy-elimination pass (#3839) e2460383 Debug info preservation in if-conversion pass (#3861) 16cc197c spirv-fuzz: Refactor conditions in the fact manager (#3867) 615fbe6c spirv-fuzz: TransformationWrapRegionInSelection (#3674) f2b8a4ee spirv-fuzz: Enable some passes with high probability (#3860) 50e04f61 spirv-fuzz: Do not add constants for Block-decorated structs (#3862) 8edd79dd spirv-fuzz: Fix to FuzzerPassFlattenConditionalBranches (#3865) 719bade4 spirv-fuzz: Fix TransformationRecordSynonymousConstants (#3868) 009facc9 spirv-fuzz: Fix flatten conditional branch transformation (#3859) fcb22ecf spirv-fuzz: Report fresh ids in transformations (#3856) c6ca885c [spirv-dis] Add some context comments to disassembly. (#3847) 446adb05 Fix use-after-move in val/validate.cpp (#3848) 4b07d50c spirv-fuzz: Fix bug in TransformationDuplicateRegionWithSelection (#3819) fec56146 spirv-fuzz: Support OpNot bit instruction case (#3841) 9e17b9d0 spirv-fuzz: Return IR and transformation context after replay (#3846) e12087d6 spirv-fuzz: fix test (#3845) 9edeeafd spirv-fuzz: Use unique_ptr<FactManager> in TransformationContext (#3844) 50dacda5 Start SPIRV-Tools v2020.6 Testing: checkbuild.py on Linux; unit tests on Windows Change-Id: Ic38249d042605173944e82e74f1448d3e8ed781c
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.
See CHANGES
for a high level summary of recent changes, by version.
SPIRV-Tools project version numbers are of the form v
year.
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.
OpConstant
, OpSpecConstant
, and OpSwitch
.See docs/syntax.md
for the assembly language syntax.
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.
The optimizer is a collection of code transforms, or “passes”. Transforms are written for a diverse set of reasons:
As of this writing, there are 67 transforms including examples such as:
OpSpecConstantOp
and OpSpecConstantComposite
Additionally, certain sets of transformations have been packaged into higher-level recipes. These include:
spirv-opt -Os
)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.
Note: The linker is still under development.
Current features:
See the CHANGES file for reports on completed work, and the General sub-project for planned and in-progress work.
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.
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.
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.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:
clang-format
. kokoro/check-format/build.sh shows how to download it. Note that we currently use clang-format version 5.0.0
for SPIRV-Tools. Settings are defined by the included .clang-format file.We intend to maintain a linear history on the GitHub master
branch.
example
: demo code of using SPIRV-Tools APIsexternal/googletest
: Intended location for the googletest sources, not providedexternal/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 pathexternal/spirv-headers
: Intended location for SPIR-V headers, not providedinclude/spirv-tools/libspirv.h
: C API public interfacesource/
: API implementationtest/
: Tests, using the googletest frameworktools/
: Command line executablesExample 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
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:
googletest
before configuring SPIR-V Tools.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.
Some tests depend on the Effcee library for stateful matching. Effcee itself depends on RE2.
external/effcee
and RE2 sources to appear in external/re2
.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.
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.
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.
You can also use Bazel to build the project.
cd <spirv-dir> bazel build :all
For building and testing SPIRV-Tools, the following tools should be installed regardless of your OS:
SPIRV-Tools is regularly tested with the following compilers:
On Linux
On MacOS
On Windows
Other compilers or later versions may work, but they are not tested.
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.
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
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.
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.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. IncompletespvValidateBinary
implements the validator functionality. IncompleteThe 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, 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.
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.
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.
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
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
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
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.
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.
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
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
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 are only built when googletest is found. Use ctest
to run all the tests.
See the projects pages for more information.
OpLabel
instructions with that basic block's predecessors.This is a work in progress.
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.