commit | 4d55e9f66f91a62d5493c866cfeec77891b4cf55 | [log] [tgz] |
---|---|---|
author | David Neto <dneto@google.com> | Wed Jun 14 10:40:27 2017 -0400 |
committer | David Neto <dneto@google.com> | Wed Jun 14 10:41:00 2017 -0400 |
tree | 1e37258c2741503b1f2e148d571101e59b3a7fdd | |
parent | 86c6fe001dfdbd8e8b39f40aeeab4c691ac42f04 [diff] | |
parent | 7c8da66bc27cc5c4ccb6a0fa612f56c9417518ff [diff] |
Merge remote-tracking branch 'aosp/upstream-master' into update-shaderc 7c8da66 mem2reg: Add pass to eliminate local loads and stores in single block. 1567cdd Don't install googletest and googlemock aa7e687 Mem2Reg: Add Local Access Chain Convert pass d71d976 Fix memory leak in ValidateBinaryUsingContextAndValidationState 66fc105 Bots print output from timed out tests e7aff80 Fixed misspelled ctest flag --output_on_failure ddf4de6 Support building on FreeBSD 3bea99d CFA: Move TraversalRoots and ComputeAugmentedCFG into CFA d6f2979 CFA: Pull in CalculateDominators df6537c DefUseManager: Fix ReplaceAllUsesWith() to update inst_to_used_ids_ 20fe946 Added extension SPV_VALIDATOR_ignore_type_decl_unique 3492cc6 Remove unused this in lambda capture dbc2049 Add SPIR-V 1.2 support, for OpenCL 2.2 eb720b2 Fix size_t conversion error on MinGW 51b6778 Update CHANGES: note fix of issue 629 bba812f Inline: Inline early return function if no returns in loop. 3eb716c Added bit stream utils f5facf8 Stats analyzer aggregates OpConstant usage b4cf371 Stats analyzer uses validator 01b2875 Avoid snprintf warning in GCC 7.1 b25b330 Inline: Create CFA class 3f90058 Update set_spec_const_default_value_test.cpp 87a3f65 Added Markov chain analysis to stats bad90d9 Inline: Change "--inline-entry-points-all" to "-exhaustive" d870dbe Inline: Fix inliner description in usage message to reflect exceptions. a107d34 Inline: Do not inline functions with multiple returns (for now) 144f59e Add bit pattern interface for setting default value for spec constants 1d8efb0 Update CHANGES with recent news 1e309af Added --compact-ids to /tools/opt b173d1c Added option --preserve-numeric-ids to tools/spirv-as 4f21640 Added statistical analysis tool (tool/stats) 72debb8 Test source language HLSL bf68c81 Support SPV_KHR_storage_buffer_storage_class 23af06c Validator support for Variable Pointer extension. 4895ace Update cap tests for SPV_KHR_16bit_storage 4087e89 Test asm,dis support for SPV_KHR_variable_pointers 11a867f Add FlattenDecoration transform 5c3c054 Group targets into folders dec3f5e Update spirv-opt to use spvtools::Optimizer afc60bb Fix optimizer on when to write the binary ad3b082 Add /EHs for targets for MSVC 4be6abe Fix spelling in SPV_AMD_gcn_shader support 58e7a3e Fix typo in method name Struct::AddMemberName ceb1d4f Avoid inlining calls to external functions 4fc9302 opt::Function::cbegin and cend are const Test: checkbuild.py on Linux; unit tests on Windows Change-Id: I1d8c460282840789c369769e2784db1f4684590c
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.
See projects.md
to see how we use the GitHub Project feature to organize planned and in-progress work.
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 exampe, 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 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.
Warning: The optimizer is still under development.
Currently supported optimizations:
OpSpecConstantOp
and OpSpecConstantComposite
For the latest list with detailed documentation, please refer to include/spirv-tools/optimizer.hpp
.
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 are maintained by members of the The Khronos Group Inc., at https://github.com/KhronosGroup/SPIRV-Tools.
Contributions via merge request are welcome. Changes should:
clang-format
. 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 providedinclude/
: 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: 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.
The project uses CMake to generate platform-specific build configurations. 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/googletest.git external/googletest # optional mkdir build && cd build cmake [-G <platform-generator>] <spirv-dir>
Once the build files have been generated, build using your preferred development environment.
The following CMake options are supported:
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.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 two classes, SpirvTools
and Optimizer
, both in the spvtools
namespace.
SpirvTools
provides Assemble
, Disassemble
, and Validate
methods.Optimizer
provides methods for registering and running optimization passes.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/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 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 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.