tag | 504fa3820c43e981e3abdd01c99be65f1fc67e46 | |
---|---|---|
tagger | The Android Open Source Project <initial-contribution@android.com> | Tue Apr 26 23:34:45 2022 -0700 |
object | 3fb7f0dbd5fb2598f62820dcb5e7b035d982a4be |
Android NDK r25 Beta 3 (8355429)
commit | 3fb7f0dbd5fb2598f62820dcb5e7b035d982a4be | [log] [tgz] |
---|---|---|
author | David Neto <dneto@google.com> | Thu Nov 11 12:16:38 2021 -0500 |
committer | David Neto <dneto@google.com> | Thu Nov 11 12:18:15 2021 -0500 |
tree | 91e55dcba56d758debfaff55f88b4558e6655143 | |
parent | 18d866c00b2f28fc562f2a085c3714d839463f82 [diff] | |
parent | ab8eb607750208066e2d57eff6a34dbaf05f5ada [diff] |
Merge commit 'ab8eb607750208066e2d57eff6a34dbaf05f5ada' (v2021.4) into update-shaderc Includes: ab8eb607 Finalize SPIRV-Tools v2021.4 21e3f681 Update SPIRV-Headers (#4628) b014238e Allow WorkgroupSize on variables for Kernels (#4627) 352a4112 Fix handling of OpPhi in convert-relaxed-to-half (#4618) c72c4542 Clarify how to update DEPS (#4626) 6f9fa480 Update DEPS (#4625) 2bd46c5c Update CHANGES 339d4475 Improve decoration validation (#4490) 1589720e spirv-opt: create OpDecorate for OpMemberDecorate in desc-sroa (#4617) 6b073f89 Run the wasm build on push and pull_request (#4614) 66ef7cb6 Remove publish-to-npm step for Wasm build (#4610) d645ea27 Update CHANGES, README for WebAssembly build (#4609) 0d001300 Add Wasm build (#3752) 1082de6b Handle overflowing id in merge return (#4606) 97d44956 Avoid bitwise and in boolean expression (#4603) e3c70981 In generated cmake config file for SPIRV-Tools only access cmake target, if present (#4590) e3a373f2 Make cxx exceptions controllable (#4591) c194bb2a spirv-val Update LocalSizeId VUID (#4602) 6c7885db Change branch handling in ADCE to fix errors (#4596) bd5bf754 Fix Linker generator ID (#4601) 791f5b46 Only validate workgroup layout for explicit workgroup memory (#4542) 2feb7074 Avoid confusing short-circuiting (#3404) 7c5b17d3 Update passes to handle function declarations (#4599) b2ba019b Delete decorations before replaces uses in dead branch elim (#4598) 3291b695 Do not fold snegate feeding sdiv. (#4600) d997c83b Add spirv-opt pass to replace descriptor accesses based on variable indices (#4574) d78c1c4c Make IsLocalVar in ADCE work at any time. (NFC) (#4595) 8c91f14a Add libFuzzer target for spirv-fuzz (#4434) 17a5bacf Handle missing execution modes for limitation check (#4594) 7326b494 opt: set upper bits of spec constant according to spec (#4589) f3fbd98f opt/spec_constants: fix bit pattern width checks. (#4588) 0f3bc1d9 Fix i386 build issues related to random generation (#4586) 001604bd Generate constants directly in CreateDebugInlinedAt (#4572) 7a7a6903 README: Remove appveyor build badge. (#4584) 4578db3c README: Update tested versions of compilers (#4579) 387cae47 Opt passes should apply to the exported functions (#4554) 35fd0e17 Consider 0xffffffff offset as missing (#4564) 06ebc480 Account for strided components in arrays (#4575) 10343e53 Remove Appveyor CI, update README (#4578) 3e6a8530 Mark DebugInfoNone as live in ADCE when DebugInfo present (#4568) e6e77dbd Enable OpConstFunctionPointerINTEL outside function (#4576) 5ed637ca Fix output of SPIR-V version in diagnostic (#4562) d31218c5 Use max enum instead of static array of legal values (#4571) 0292d6b1 Update SPIRV-Headers (#4573) 6dd73728 Fix merge-block assertions with debugInfo (#4563) e4349dd8 Fix CI failure (#4570) b4699574 Avoid bugprone-move-forwarding-reference warning in Clang (#4560) 0c4deebc Include a maximum value for spv_target_env (#4559) 63a39123 Fix ConstantManager to not run AnalyzeInstDefUse if DefUse not valid (#4557) 2d12367c Stop consuming input in fuzzers to select target environment (#4544) eeb973f5 More ADCE refactoring (#4548) 9529d3c2 Avoid implicit fallthrough, by duplicating code (#4556) 24476c2e spirv-opt: Don't eliminate dead members from StructuredBuffer (#4553) 3234daad Do not assume there are execution modes (#4555) ba4b390c Suppress protobuf warning (#4551) c3adcb03 Adce refactor (NFC) (#4547) 19dc86c4 Handle NonSemantic.Shader Debug[No]Line (#4530) f125452c Fix inst_buff_addr_check to handle struct loads (#4489) 134d763f GN: Fix build for debuginfo codegen. (#4536) 1d48824b Update SPIRV-Headers (#4543) a6c5056d Fix checks for offset in nested structs (#4531) 0f450875 Fix UBSan error in spirv-dis fuzzer (#4517) 59f51bb4 Fix extract with out-of-bounds index (#4529) 1454c95d spirv-opt: Switch from Vulkan.DebugInfo to Shader.DebugInfo (#4493) 4ac8e5e5 Add preserve_interface mode to aggressive_dead_code_elim (#4520) 9e65f054 spirv-fuzz: Account for differing signedness in WrapVectorSynonym (#4414) 36ff1353 spirv-opt: Avoid integer overflow during constant folding (#4511) cb6c6691 Roll external/googletest/ b7d472f12..955c7f837 (111 commits) (#4521) 846b032b Fix infinite loop in validation (#4523) bf463fe3 Fix UBSan kokoro config (#4522) 5efeaad3 Fix bad order of checks in atomic validation (#4524) 8865b202 Handle out-of-bounds accesses in VDCE (#4518) 4f4f7603 Change validator boolean tests to avoid asserts (#4503) 912460e4 Fix infinite loop in GetBlockDepth (#4519) 013b1f3d Fix validation message for cooperative matrix column type (#4502) 2a938fcf Add UBSan kokoro configuration (#4512) c16224c6 Add some missing switch validation (#4507) 92868b8f spirv-val: Fix ubsan error (#4505) 4db6b8dc Remove environment features that are never used (#4491) 7e860e38 fix parsing of bad binary exponents in hex floats (#4501) 789de0dc Adjust build for fuzzer targets to support OSS-Fuzz (#4498) 0c09258e Set threshold for reduce-load-size pass (#4499) bd3a271c Handle exported functions in ADCE (#4495) 702e6af3 Only add `-DSPIRV_CHECK_CONTEXT` for Debug builds (#4496) b8fce5f9 spirv-lint: Add lint based on divergence analysis (#4488) ee307736 Add a feature for allowing LocalSizeId (#4492) 2a5cc342 Start SPIRV-Tools v2021.4 Testing: checkbuild.py on Linux Change-Id: I77625ccdd970e7a44530215d1dc2e5fb9502dd3b
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.
Some versions of SPIRV-Tools are tagged as stable releases (see tags on github). These versions undergo extra testing. Releases are not directly related to releases (or versions) of SPIRV-Headers. Releases of SPIRV-Tools are tested against the version of SPIRV-Headers listed in the DEPS file. The release generally uses the most recent compatible version of SPIRV-Headers available at the time of release. No version of SPIRV-Headers other than the one listed in the DEPS file is guaranteed to work with the SPIRV-Tools release.
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 of getting sources, assuming SPIRV-Tools is configured as a standalone project:
git clone https://github.com/KhronosGroup/SPIRV-Tools.git spirv-tools cd spirv-tools # Check out sources for dependencies, at versions known to work together, # as listed in the DEPS file. python3 utils/git-sync-deps
For some kinds of development, you may need the latest sources from the third-party projects:
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
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
.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 executablesThe 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: Prebuilt binaries are available from the downloads page.
First get the sources. Then build using CMake, Bazel, Android ndk-build, or the Emscripten SDK.
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.1 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
The SPIRV-Tools core library can be built to a WebAssembly node.js module. The resulting SpirvTools
WebAssembly module only exports methods to assemble and disassemble SPIR-V modules.
First, make sure you have the Emscripten SDK. Then:
cd <spirv-dir> ./source/wasm/build.sh
The resulting node package, with JavaScript and TypeScript bindings, is written to <spirv-dir>/out/web
.
Note: This builds the package locally. It does not publish it to npm.
To test the result:
node ./test/wasm/test.js
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. To update DEPS
, run utils/roll_deps.sh
and confirm that tests pass. The script requires Chromium's depot_tools
.
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 -j <num threads>
to run all the tests. To run tests using all threads:
ctest -j$(nproc)
To run a single test target, use ctest [-j <N>] -R <test regex>
. For example, you can run all opt
tests with:
ctest -R 'spirv-tools-test_opt'
Use bazel test :all
to run all tests. This will run tests in parallel by default.
To run a single test target, specify :my_test_target
instead of :all
. Test target names get printed when you run bazel test :all
. For example, you can run opt_def_use_test
with:
bazel test :opt_def_use_test
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.