RPCSX/SPIRV-Tools
1
0
Fork 0
mirror of https://github.com/RPCSX/SPIRV-Tools.git synced 2024-11-30 14:50:28 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Add basic documentation about spirv-fuzz (#3016)

Browse Source 
This change provides some information about spirv-fuzz in the
top-level SPIRV-Tools README.  A typo elsewhere in the README is also
fixed.
This commit is contained in:
Alastair Donaldson 2019-11-06 16:12:01 +00:00 committed by Steven Perron
parent d9fbf02348
commit 87efe0a8b4
1 changed files with 33 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -33,7 +33,7 @@ headers, and XML registry.
See [`CHANGES`](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
an optional `-dev` suffix to indicate work in progress. For example, the
following versions are ordered from oldest to newest:
* `v2016.0`
@ -149,6 +149,24 @@ issue](https://github.com/KhronosGroup/SPIRV-Tools/issues]) with
"Reducer:" as the start of its title.
### Fuzzer
*Note:* The fuzzer is still under development.
The fuzzer applies semantics-preserving transformations to a SPIR-V binary
module, to produce an equivalent module. The original and transformed modules
should produce essentially identical results when executed on identical inputs:
their results should differ only due to floating-point round-off, if at all.
Significant differences in results can pinpoint bugs in tools that process
SPIR-V binaries, such as miscompilations. This *metamorphic testing* approach
is similar to the method used by the [GraphicsFuzz
project](https://github.com/google/graphicsfuzz) for fuzzing of GLSL shaders.
To suggest an additional capability for the fuzzer, [file an
issue](https://github.com/KhronosGroup/SPIRV-Tools/issues]) with
"Fuzzer:" as the start of its title.
### Extras
* [Utility filters](#utility-filters)
@ -324,6 +342,7 @@ 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.
@ -500,6 +519,19 @@ This is a work in progress, with initially only shrinks a module in a few ways.
Run `spirv-reduce --help` to see how to specify interestingness.
### Fuzzer tool
The fuzzer transforms a SPIR-V binary module into a semantically-equivalent
SPIR-V binary module by applying transformations in a randomized fashion.
This is a work in progress, with initially only a few semantics-preserving
transformations.
* `spirv-fuzz` - the standalone fuzzer
* `<spirv-dir>/tools/fuzz`
Run `spirv-fuzz --help` for a detailed list of options.
### Control flow dumper tool
The control flow dumper prints the control flow graph for a SPIR-V module as a