| commit | d552f632f96490d04f1955f5106a716eb71556f2 | [log] [tgz] |
|---|---|---|
| author | Ben Clayton <bclayton@google.com> | Mon Nov 18 11:18:41 2019 +0000 |
| committer | Ben Clayton <bclayton@google.com> | Mon Nov 18 11:18:41 2019 +0000 |
| tree | 465db655879ab0bf7e19604eb348392ad3aabeaa | |
| parent | d0f684e34edc1c0d3ed881de07597487777ff9f5 [diff] |
Squashed 'third_party/SPIRV-Tools/' changes from 65e362b7a..c3f22f7cb c3f22f7cb Update README (#3047) 1f2af55f2 Update README (#3048) 3da910d55 Avoid uninit warning in GCC (#3044) cdd6829a3 utils/vscode: Add SPIR-V language server support b96c9a057 utils/vscode: Add go language server packages. ab3cdcaef Fix operand access of composite in upgrade memory model (#3021) 1a18d491f Validate array stride does not cause overlap (#3028) 12e54dae1 Update Offset to ConstOffset bitmask if operand is constant. (#3024) 3e4abc9ac Try to fix go linter: exported constant comment (#3026) c5e6761ac spirv-fuzz: Eliminate spurious semicolons (#3025) 041f0a024 spirv-fuzz: simplify transformation for replacing an id with a synonym (#3020) 528c00c01 Re-enable OpReadClockKHR validation (#3013) 8a35bf030 Python 3: remove deprecated U qualifier on 'open' (#3019) 989f62fb9 Remove semicolon (#3022) dc59b4b07 spirv-fuzz: vector shuffle transformation (#3015) 87efe0a8b Add basic documentation about spirv-fuzz (#3016) d9fbf0234 Fix Go lint issues: comment exported symbols (#3014) 3724cfbea spirv-fuzz: better computation of data synonym facts (#3010) fb6bac889 spirv-fuzz: make equivalence classes deterministic (#3011) e0d5544c9 Add missing headers to GN. (#3009) 178c4ddea Correct "environment" typo (#3007) f1e5cd73f spirv-fuzz: improvements to representation of data synonym facts (#3006) cdee051e2 Add iOS as a supported platform (#3001) 5f6fb2f34 Reset pointers before iterating in fuzzer to avoid double free (#3003) 618ee5094 Fix some clang-tidy issues in graphics_robust_access_pass (#2998) 466908b50 Add description of wrap-opkill. (#3000) f893d4d41 [opt] Do not compare optimized binary with an invalidated buffer (#2999) 7e2cba6a5 utils/vscode: Change assembly file ext to .spvasm (#2995) 42f885238 utils: Add a vscode extension for SPIR-V disassembly files (#2987) 5ea709937 Add two new simplifications. (#2984) fac166162 spirv-fuzz: Transformation to extract from a composite object (#2991) ec12de913 spirv-fuzz: rename class, and fix bug related to dominance (#2990) 0dbd4e358 spirv-fuzz: Rework management of data synonyms (#2989) b34fa7319 spirv-fuzz: add class to represent equivalence relation (#2988) 4517c7b88 Update DEPS (#2986) 570582d8d spirv-fuzz: fuzzer pass to adjust memory access operands (#2968) 02910ffdf Instrument: Add missing def-use analysis. (#2985) 8357b878d spirv-fuzz: add missing functionality for matrix composites (#2974) 615918c91 Update CHANGES e8c3f9b0b Ensure timestamp does not vary with timezone. (#2982) 6a9be627c Keep NOPs when comparing with original binary (#2931) 2a3cbe7c3 Check that derivatives operate on 32-bit values (#2983) 3cdd6444c Check text->str before destroying (#2981) e3da3143b Disallow use of OpCompositeExtract/OpCompositeInsert with no indices (#2980) 2ca4fcfdc Add fuzzer for spirv-dis call path (#2977) 024417d83 Check binary->code existence before destroying (#2979) 9c0ae6bb8 Improved CMake install step. (#2963) e99b91822 Support constant-folding UConvert and SConvert (#2960) 8e8977853 Add fuzzer for spirv-as call path (#2976) 00170cc5e spirv-fuzz: Refactor 'copy object' and 'construct composite' transformations (#2966) 964dc52df Update SPIR-V binary header test for SPIR-V 1.5 (#2967) 1b6fd37fa spirv-fuzz: Refactor 'split blocks' to identify instructions differently (#2961) 2276e5978 Validate that selections are structured (#2962) 3eda1b9ff spirv-fuzz: Rework id descriptors (#2959) eba98c4eb spirv-fuzz: Add fuzzer pass to add NoContraction decorations (#2950) 91232f7f7 spirv-fuzz: Add fuzzer pass to change function controls (#2951) feb154921 reduce: add large tests and fix (#2947) 253806adc spirv-fuzz: Add fuzzer pass to change loop controls (#2949) 1cea3b785 Fixed include paths and order according to Google style. (#2957) 82f84c4b8 Use a longer timeout for Bazel tests. (#2956) c705032b2 Remove non-existent files from BUILD.gn (#2955) c1d42038f Disable scope validation for OpReadClockKHR (#2953) df15a4a3c CMake: Add support for building with emscripten (#2948) c3ca04741 Update CHANGES 32f76efa6 Link cfg and dominator analysis in the context (#2946) 5910bb8e9 spirv-fuzz: add transformation and pass to construct composites (#2941) 2f6a87f61 reduce: improve remove unref instr pass (#2945) 81d227f36 spirv-fuzz: add disabled test to document known issue (#2942) 26dba32c4 spirv-fuzz: Add fuzzer pass to change selection controls (#2944) 3c7ff8d4f Enable OpTypeCooperativeMatrix specialization (#2927) c18c9ff6b Handle OpKill better (#2933) ad3d23f47 Generate null pointer by converting uint64 zero to pointer. (#2935) 8fa0f1a65 spirv-fuzz: option to convert shader into a form that renders red (#2934) bc37fd585 Add SPV_KHR_shader_clock validation (#2879) bd839ca6b reduce/fuzz: improve command line args (#2932) 9d7428b05 Validate physical storage buffer restrictions (#2930) 44b32176e fuzz: add shrinker-temp-file-prefix (#2928) 9eb1c9a4c Add continue construct analysis to struct cfg analysis (#2922) 85c67b5e0 Record trailing line dbg instructions (#2926) 4075b921f Add removing references to debug instructions when removing them (#2923) ef4679a58 spirv-fuzz: allow interestingness script arguments (#2925) bc84daff2 Add Kokoro bots for building with Bazel. (#2914) 10951a7c9 Refactor the InstructionPass (#2924) 84b197606 spirv-fuzz: do not allow a dead break to target an unreachable block (#2917) 27238bcca spirv-fuzz: preserve some analyses when permuting blocks (#2918) 510ca9d61 Only allow previously declared forward refs in structs (#2920) 2a11f365b Handle id overflow in wrap-opkill (#2916) 70097c776 spirv-fuzz: do not replace struct indices with synonyms (#2915) c1e03834e spirv-fuzz: Fixes to preconditions for adding dead break/continue edges (#2904) 7bc114ba2 spirv-fuzz: do not replace a pointer argument to a function call with a synonym (#2901) 290f6a820 spirv-fuzz: do not replace boolean constant argument to OpPhi instruction (#2903) 527a68930 Remove validate_datarules.cpp (#2911) 55ea57a78 Handle extract with no indexes (#2910) a03cd1f3e Add Bazel build configuration. (#2891) 6f26d9ad8 Handle id overflow in convert local access chains (#2908) 71e0ba606 Add OpCopyMemory test to SVA. (#2885) 3a762d54f Add missing GN dependency (#2899) 958f7e72a Employ the "swarm testing" idea in spirv-fuzz (#2890) b83535da5 Fix operand index in spirv-fuzz (#2895) f62ee4a4a Update DEPS: effcee, re2, googletest (#2881) 8d0ca43da Add method comment for opt::Function::WhileEachInst (#2867) 6b0721265 Use OpReturn* in wrap-opkill (#2886) 465312726 Fix to CMakeLists for spirv-fuzz tests (#2888) 7275a7165 Allow validation during spirv-fuzz replay (#2873) 4eee71e78 Disable long-running fuzzer tests by default (#2887) 61edde52a Revert "Use OpReturn* in wrap-opkill" 87f0fa432 Use OpReturn* in wrap-opkill 08fcf8a4a Fix header include syntax. (#2882) 248c80b04 Handle OpConstantNull in copy-prop-arrays. (#2870) d06fe0848 Fix comment typo found by protobufs linter (#2884) 47e354b0c Move docs into docs/ folder (#2872) 605c2e3c0 Add WebGPU SPIR-V Assembler in JavaScript. (#2876) acf20302c Android.mk: Add dependency from optimizer file to amd-shader-ballot-insts.inc (#2883) c02a6191a Update SPIRV-Headers in DEPS (#2880) e59b60de0 Fix detection of blocks bypassed by new edge (#2874) ccd7bf167 Fix CMake issue related to spirv-fuzz (#2877) 0a07cd1c9 Add fuzzer pass to replace ids with synonyms (#2857) bbb29870b Relaxed bitcast with pointers (#2878) 36c1c0e22 Fix Fuchsia build. (#2868) 99793fa67 Adding valilidation checks for OpEntryPoint duplicate names and execution mode (#2862) 932561935 Extra resource interface validation (#2864) 1e146e8a3 Split capability tests (#2866) 5a48c0da1 SPIRV-Tools support for SPIR-V 1.5 (#2865) ad7f2c5c4 Add fuzzer pass to copy objects (#2853) 67b87f22c Handle another case where creating a constant can fail (#2854) c7a39bc40 Don't inline function containing OpKill (#2842) 4f9256db3 Handle id overflow in wrap op kill. (#2851) 9f188e337 Assembler: Can't set an ID in instruction without result ID (#2852) c0e980709 Handle creating a new constant failing gracefully (#2848) e2e95172d Rework management of probabilities in spirv-fuzz (#2839) 7ee8f443e Fix add-dead-break and add-dead-continue passes to respect dominance (#2838) 35c9518c4 Handle id overflow in the ssa rewriter. (#2845) 7f7236f1e Handle id overflow in the constant manager. (#2844) a464ac1a2 Add generic builtin validation of target (#2843) 6797173cf Don't register duplicate decoration in validator. (#2841) 76261e2a7 Replace CubeFaceCoord and CubeFaceIndexAMD (#2840) b218ad199 Fold Min, Max, and Clamp instructions. (#2836) a41520eaa Replace uses of SPV_AMD_shader_trinary_minmax extension (#2835) 19b256616 For WebGPU<->Vulkan optimization, set correct execution environment (#2834) 1dfb5fc12 Export SPIRV-Tools targets on installation (#2785) 635b583cf GN: Add Chromium GoogleTest deps. (#2832) 9b3cc3e05 Upadate CHANGES c77045b4a Instrument: Be sure Float16 capability on when generating float16 null (#2831) d11725b1d Add --relax-float-ops and --convert-relaxed-to-half (#2808) 1c9ca422d GN: Make SPIRV-Tools target use public_deps. (#2828) b54d95029 Fold Fmix should accept vector operands. (#2826) 2c5ed16ba Fix end comments in header files (#2829) git-subtree-dir: third_party/SPIRV-Tools git-subtree-split: c3f22f7cba60e55d178b8184851d17697a996143
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 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.0v2016.1-devv2016.1v2016.2-devv2016.2Use 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 OpSpecConstantCompositeAdditionally, 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 to generate platform-specific build configurations.
cd <spirv-dir> mkdir build && cd build cmake [-G <platform-generator>] <spirv-dir>
Once the build files have been generated, build using your preferred development environment.
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 exectuable 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/asUse 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/disUse 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/linkThe 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/optWarning: 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/valThe 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/reduceRun 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/fuzzRun 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/cfgspirv-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.