mirror of
https://github.com/KhronosGroup/SPIRV-Tools
synced 2024-10-18 11:10:05 +00:00
Revamp the README for public release.
Reorganize the README, and update its contents to more accurately reflect the public release. Remove the incremental "Changes" section. Rename readme.md to README.md Rename license.txt to LICENSE Update the assembler tool to support -h, and make its help look more consistent with the disassembler. Change the target and library name to SPIRV-Tools. To better match the GitHub repo name. Also, it's not SHOUTING.
This commit is contained in:
David Neto
parent
3d348a8440
commit
56fb3f016b
@ -132,32 +132,33 @@ set(SPIRV_SOURCES
|
||||
${CMAKE_CURRENT_SOURCE_DIR}/source/validate.cpp
|
||||
${CMAKE_CURRENT_SOURCE_DIR}/source/validate_id.cpp)
|
||||
|
||||
add_library(SPIRV-TOOLS ${SPIRV_SOURCES})
|
||||
target_link_libraries(SPIRV-TOOLS ${SPIRV_LIBS})
|
||||
set_target_properties(SPIRV-TOOLS PROPERTIES COMPILE_FLAGS ${SPIRV_WARNINGS})
|
||||
set(SPIRV_TOOLS "SPIRV-Tools")
|
||||
add_library(${SPIRV_TOOLS} ${SPIRV_SOURCES})
|
||||
target_link_libraries(${SPIRV_TOOLS} ${SPIRV_LIBS})
|
||||
set_target_properties(${SPIRV_TOOLS} PROPERTIES COMPILE_FLAGS ${SPIRV_WARNINGS})
|
||||
|
||||
option(SPIRV_SKIP_EXECUTABLES "Skip building the executables and tests along with the library" ${SPIRV_SKIP_EXECUTABLES})
|
||||
|
||||
set(SPIRV_BUILT_TARGETS SPIRV-TOOLS)
|
||||
set(SPIRV_BUILT_TARGETS ${SPIRV_TOOLS})
|
||||
if (NOT ${SPIRV_SKIP_EXECUTABLES})
|
||||
list(APPEND SPIRV_BUILT_TARGETS spirv-as spirv-dis spirv-val)
|
||||
add_executable(spirv-as
|
||||
${CMAKE_CURRENT_SOURCE_DIR}/include/libspirv/libspirv.h
|
||||
${CMAKE_CURRENT_SOURCE_DIR}/tools/as/as.cpp)
|
||||
set_target_properties(spirv-as PROPERTIES COMPILE_FLAGS ${SPIRV_WARNINGS})
|
||||
target_link_libraries(spirv-as SPIRV-TOOLS)
|
||||
target_link_libraries(spirv-as ${SPIRV_TOOLS})
|
||||
|
||||
add_executable(spirv-dis
|
||||
${CMAKE_CURRENT_SOURCE_DIR}/include/libspirv/libspirv.h
|
||||
${CMAKE_CURRENT_SOURCE_DIR}/tools/dis/dis.cpp)
|
||||
set_target_properties(spirv-dis PROPERTIES COMPILE_FLAGS ${SPIRV_WARNINGS})
|
||||
target_link_libraries(spirv-dis SPIRV-TOOLS)
|
||||
target_link_libraries(spirv-dis ${SPIRV_TOOLS})
|
||||
|
||||
add_executable(spirv-val
|
||||
${CMAKE_CURRENT_SOURCE_DIR}/include/libspirv/libspirv.h
|
||||
${CMAKE_CURRENT_SOURCE_DIR}/tools/val/val.cpp)
|
||||
set_target_properties(spirv-val PROPERTIES COMPILE_FLAGS ${SPIRV_WARNINGS})
|
||||
target_link_libraries(spirv-val SPIRV-TOOLS)
|
||||
target_link_libraries(spirv-val ${SPIRV_TOOLS})
|
||||
|
||||
set(GMOCK_DIR ${CMAKE_CURRENT_SOURCE_DIR}/external/googletest/googlemock)
|
||||
if(EXISTS ${GMOCK_DIR})
|
||||
@ -232,7 +233,7 @@ if (NOT ${SPIRV_SKIP_EXECUTABLES})
|
||||
${CMAKE_CURRENT_SOURCE_DIR}/test/ValidateID.cpp
|
||||
${CMAKE_CURRENT_SOURCE_DIR}/test/main.cpp)
|
||||
|
||||
target_link_libraries(UnitSPIRV SPIRV-TOOLS gmock)
|
||||
target_link_libraries(UnitSPIRV ${SPIRV_TOOLS} gmock)
|
||||
else()
|
||||
message(STATUS "Did not find googletest, tests will not be built."
|
||||
"To enable tests place googletest in '<spirv-dir>/external/googletest'.")
|
||||
|
||||
225
README.md
Normal file
225
README.md
Normal file
@ -0,0 +1,225 @@
|
||||
# SPIR-V Tools
|
||||
|
||||
## Overview
|
||||
|
||||
The SPIR-V Tools provides an API and commands for processing SPIR-V modules.
|
||||
|
||||
The project includes an assembler, binary module parser, disassembler, and
|
||||
validator for SPIR-V, all 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 interfaces are still under development, and are expected to change.
|
||||
|
||||
SPIR-V is defined by the Khronos Group Inc.
|
||||
See the [SPIR-V Registry](https://www.khronos.org/registry/spir-v/) for the
|
||||
SPIR-V specification, headers, and XML registry.
|
||||
|
||||
## Supported features
|
||||
|
||||
### Assembler, binary parser, and disassembler
|
||||
|
||||
* Based on SPIR-V 1.0 Revision 2.
|
||||
* Supports GLSL std450 extended instructions.
|
||||
* Supports OpenCL extended instructions.
|
||||
* Assembler only does basic syntax checking. No cross validation of
|
||||
IDs or types is performed, except to check literal arguments to
|
||||
`OpConstant`, `OpSpecConstant`, and `OpSwitch`.
|
||||
|
||||
See [`syntax.md`](syntax.md) for the assembly language syntax.
|
||||
|
||||
### Validator
|
||||
|
||||
*Warning:* The validator is incomplete.
|
||||
|
||||
## Source code
|
||||
|
||||
The SPIR-V Tools are maintained by members of the The Khronos Group Inc.,
|
||||
at [https://github.com/KhronosGroup/SPIRV-Tools](https://github.com/KhronosGroup/SPIRV-Tools).
|
||||
|
||||
Contributions via merge request are welcome. Changes should:
|
||||
* Be provided under the [Khronos license](#license).
|
||||
* Include tests to cover updated functionality.
|
||||
* C++ code should follow the [Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html).
|
||||
* Code should be formatted with `clang-format`. Settings are defined by
|
||||
the included [.clang-format](.clang-format) file.
|
||||
|
||||
We intend to maintain a linear history on the GitHub `master` branch.
|
||||
|
||||
### Source code organization
|
||||
|
||||
* `external/headers`: Standard SPIR-V header files used by the implementation,
|
||||
from the SPIR-V Registry
|
||||
* `external/googletest`: Intended location for the
|
||||
[googletest](https://github.com/google/googletest) sources, not provided.
|
||||
* `include/libspirv/libspirv.h`: C API public interface
|
||||
* `source/`: API implementation
|
||||
* `test/`: Tests, using the [googletest](https://github.com/google/googletest)
|
||||
framework.
|
||||
* `tools/`: Command line executables
|
||||
|
||||
### Tests
|
||||
|
||||
The project contains a number of tests, used to drive development
|
||||
and ensure correctness. The tests are written using the
|
||||
[googletest](https://github.com/google/googletest) framework. The `googletest`
|
||||
source is not provided with this project. Download the `googletest` source
|
||||
into the `<spirv-dir>/external/googletest` directory before configuring
|
||||
and building the project.
|
||||
|
||||
## Build
|
||||
|
||||
The project uses [CMake](https://cmake.org/) to generate platform-specific
|
||||
build configurations. To generate these build files, issue the following
|
||||
commands:
|
||||
|
||||
```
|
||||
mkdir <spirv-dir>/build
|
||||
cd <spirv-dir>/build
|
||||
cmake [-G <platform-generator>] <spirv-dir>
|
||||
```
|
||||
|
||||
Once the build files have been generated, build using your preferred
|
||||
development environment.
|
||||
|
||||
### CMake options
|
||||
|
||||
The following CMake options are supported:
|
||||
|
||||
* `SPIRV_COLOR_TERMINAL=ON` - Enables color console output, enabled by default.
|
||||
* `SPIRV_SKIP_EXECUTABLES=ON` - Build only the library, not the command line
|
||||
tools. This will also prevent the tests from being built.
|
||||
* `SPIRV_USE_SANITIZER=<sanitizer>` - On UNIX platforms with an appropriate
|
||||
version of `clang` this option enables the use of the sanitizers documented
|
||||
[here](http://clang.llvm.org/docs/UsersManual.html#controlling-code-generation).
|
||||
This should only be used with a debug build. Disabled by default.
|
||||
* `SPIRV_WARN_EVERYTHING=OFF` - On UNIX platforms enable the `-Weverything`
|
||||
compiler front end option, disabled by default.
|
||||
* `SPIRV_WERROR=OFF` - On UNIX platforms enable the `-Werror` compiler front end
|
||||
option, disabled by default.
|
||||
|
||||
## Library
|
||||
|
||||
### Usage
|
||||
|
||||
The library provides a C API, but the internals use C++11.
|
||||
|
||||
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/libspirv/libspirv.h` then linking against the static
|
||||
library in `<spirv-build-dir>/bin/libSPIRV-Tools.a` or
|
||||
`<spirv-build-dir>/bin/SPIRV-Tools.lib`.
|
||||
|
||||
* `SPIRV-Tools` CMake target: Creates the static library:
|
||||
* `<spirv-build-dir>/lib/libSPIRV-Tools.a` on Linux and OS X.
|
||||
* `<spirv-build-dir>/lib/libSPIRV-Tools.lib` on Windows.
|
||||
|
||||
#### Entry points
|
||||
|
||||
The interfaces are still under development, and are expected to change.
|
||||
|
||||
There are three main entry points into the library.
|
||||
|
||||
* `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. *Incomplete*
|
||||
|
||||
## Command line tools
|
||||
|
||||
### Assembler tool
|
||||
|
||||
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>/bin/spirv-as`. The functionality of the assembler is
|
||||
implemented by the `spvTextToBinary` library function.
|
||||
|
||||
* `spirv-as` - the standalone assembler
|
||||
* `<spirv-dir>/bin/spirv-as`
|
||||
|
||||
Use option `-h` to print help.
|
||||
|
||||
### Disassembler tool
|
||||
|
||||
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>/bin/spirv-dis`. The functionality of the disassembler is
|
||||
implemented by the `spvBinaryToText` library function.
|
||||
|
||||
* `spirv-dis` - the standalone disassembler
|
||||
* `<spirv-dir>/bin/spirv-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.
|
||||
|
||||
### Validator tool
|
||||
|
||||
*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>/bin/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>/bin/spirv-val`
|
||||
|
||||
### UnitSPIRV tool
|
||||
|
||||
The `<spirv-build-dir>/bin/UnitSPIRV` executable runs the project tests.
|
||||
It supports the standard `googletest` command line options.
|
||||
|
||||
## Future Work
|
||||
<a name="future"></a>
|
||||
|
||||
### Assembler and disassembler
|
||||
|
||||
* Support 16-bit floating point literals.
|
||||
* The disassembler could emit helpful annotations in comments. For example:
|
||||
* Use variable name information from debug instructions to annotate
|
||||
key operations on variables.
|
||||
* Show control flow information by annotating `OpLabel` instructions with
|
||||
that basic block's predecessors.
|
||||
* Error messages could be improved.
|
||||
|
||||
### Validator
|
||||
|
||||
This is a work in progress.
|
||||
|
||||
## Licence
|
||||
<a name="license"></a>
|
||||
```
|
||||
Copyright (c) 2015 The Khronos Group Inc.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a
|
||||
copy of this software and/or associated documentation files (the
|
||||
"Materials"), to deal in the Materials without restriction, including
|
||||
without limitation the rights to use, copy, modify, merge, publish,
|
||||
distribute, sublicense, and/or sell copies of the Materials, and to
|
||||
permit persons to whom the Materials are furnished to do so, subject to
|
||||
the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included
|
||||
in all copies or substantial portions of the Materials.
|
||||
|
||||
MODIFICATIONS TO THIS FILE MAY MEAN IT NO LONGER ACCURATELY REFLECTS
|
||||
KHRONOS STANDARDS. THE UNMODIFIED, NORMATIVE VERSIONS OF KHRONOS
|
||||
SPECIFICATIONS AND HEADER INFORMATION ARE LOCATED AT
|
||||
https://www.khronos.org/registry/
|
||||
|
||||
THE MATERIALS ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
||||
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
||||
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
||||
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
||||
MATERIALS OR THE USE OR OTHER DEALINGS IN THE MATERIALS.
|
||||
```
|
||||
369
readme.md
369
readme.md
@ -1,369 +0,0 @@
|
||||
# SPIR-V Tools
|
||||
|
||||
## Overview
|
||||
|
||||
The project includes an assembler, disassembler, and validator for SPIR-V, all
|
||||
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.
|
||||
|
||||
## Supported features
|
||||
|
||||
### Assembler and disassembler
|
||||
|
||||
* Based on SPIR-V 1.0 Revision 2.
|
||||
* Supports GLSL std450 extended instructions.
|
||||
* Supports OpenCL extended instructions.
|
||||
* See [Future Work](#future) for incomplete support.
|
||||
* Assembler only does basic syntax checking. No cross validation of
|
||||
IDs or types is performed, except to check literal arguments to
|
||||
`OpConstant`, `OpSpecConstant`, and `OpSwitch`.
|
||||
|
||||
### Validator
|
||||
|
||||
The validator is incomplete. See the [Future Work](#future) section for more
|
||||
information.
|
||||
|
||||
## CHANGES (for tools hackers)
|
||||
|
||||
* Update to 1.0 Rev2 headers, syntax tables.
|
||||
* Support new capabilities `GeometryStream`, `StorageImageReadWithoutFormat`,
|
||||
and `StorageImageWriteWithoutFormat`.
|
||||
* Update some capabilities to 1.0 Rev2 rules.
|
||||
* Support `OpSpecConstantOp`.
|
||||
The opcode operand uses the opcode name, but without the `Op` prefix.
|
||||
|
||||
2015-11-10
|
||||
* Refactored the SPIR-V binary parser:
|
||||
* The binary parser issues callbacks to a parser client.
|
||||
* Disassembler is a parser client.
|
||||
* Restructured `spv_operand_type_t` into concrete, optional, and
|
||||
variable groups.
|
||||
* Support literal integers of any width up to 64 bits.
|
||||
* Support both 32-bit and 64-bit floating point literal numbers.
|
||||
* Support a single module with both OpenCL and GLSL extended
|
||||
instructions.
|
||||
* Support a module with no instructions.
|
||||
* Removed support for "canonical assembly format".
|
||||
|
||||
2015-11-02
|
||||
* Progress toward making `libspirv.h` a C API:
|
||||
* Use C header `spirv.h` instead of C++ header `spirv.hpp`
|
||||
* Fixed UTF-8 tests on Windows
|
||||
* Fixed "Generator" enums (SPIR-V module word 2)
|
||||
* Fixed CMake location of Google Mock
|
||||
* Other internal cleanups
|
||||
|
||||
2015-10-16
|
||||
* OpenCL extended instructions are supported, from version 1.0 Revision 1.
|
||||
* Capability dependencies for instructions and enums now match 0.99 Rev 32.
|
||||
* Very long instructions are supported, up to SPIR-V universal limits.
|
||||
* UTF-8 literal strings are supported.
|
||||
* Assembler support for numeric literals:
|
||||
* 32 and 64-bit floating point literals are encoded properly.
|
||||
* Signed and unsigned integers of any width up to 64 bits are supported
|
||||
and encoded properly.
|
||||
* Hexadecimal literals are supported. See `syntax.md`.
|
||||
* Numeric literal arguments to `OpConstant`, `OpSpecConstant`, and `OpSwitch`
|
||||
are type- and range-checked.
|
||||
The assembler checks that other literal numbers are non-negative integers.
|
||||
That's the grammar works, at least for now.
|
||||
|
||||
2015-10-02
|
||||
* Completed assembler support for [`!<integer>` syntax](syntax.md#immediate)
|
||||
to inject arbitrary words into the binary. This feature is used
|
||||
for testing.
|
||||
* Internal cleanups and additional tests.
|
||||
|
||||
2015-09-25
|
||||
* Updated to Rev32 headers
|
||||
* Core instructions and enumerants from Rev 32 are supported by the
|
||||
assembler.
|
||||
* Capability dependencies may be incomplete or incorrect.
|
||||
* Assembler ID syntax:
|
||||
* All IDs must use the `%` prefix before the name.
|
||||
* ID name syntax is checked: it must be made from letters, numbers or
|
||||
underscore (`_`).
|
||||
* IDs with different names always map to different ID numbers.
|
||||
Previously, a numeric ID such as `%2` could accidentally map to the
|
||||
same numeric ID as named ID `%foo`.
|
||||
* In particular, an ID with a number for a name doesn't necessarily
|
||||
map to that number. E.g. `%2` doesn't necessarily map to ID 2.
|
||||
* Disassembler emits mask expressions for mask combinations instead of
|
||||
erroring out.
|
||||
* Fixed parsing and printing of Execution Scope and Memory Semantics
|
||||
operands. They are supplied as IDs, not as literals.
|
||||
|
||||
2015-09-18
|
||||
* MILESTONE: This version of the assembler supports all of SPIR-V Rev31,
|
||||
provided you only use 32-bit values.
|
||||
* Fixes build problems with MSVC 2013.
|
||||
* Assembler supports mask expressions
|
||||
* e.g. OpStore %ptr %value Volatile|Aligned 4
|
||||
* See [`syntax.md`](syntax.md) for more.
|
||||
* Assembler supports image operands from Rev31.
|
||||
* This uses mask expression support.
|
||||
* Assembler supports enum operands:
|
||||
storage class enums, sampler addressing mode,
|
||||
sampler filter mode, dim, image format
|
||||
* More support for `!<number>` syntax. Still incomplete.
|
||||
* Disassembler will print 64-bit values correctly.
|
||||
|
||||
2015-09-15
|
||||
* Fixed spelling of Function Control "Inline" enumerated value.
|
||||
* Fixed: `Aligned` memory access flag takes a literal number operand.
|
||||
* Fixed parsing of scope ID arguments, e.g. for group operations.
|
||||
|
||||
2015-09-11
|
||||
* Assembly format must be consistent across the entire source module.
|
||||
* Add API assembler and disassembler entry points to control the format.
|
||||
* Add command line options to assembler and disassembler to force it:
|
||||
--syntax-format=assignment
|
||||
--syntax-format=canonical
|
||||
The default is "assignment".
|
||||
* Fixes decorations:
|
||||
* Names: SaturatedConversion, FuncParamAttr NoCapture
|
||||
* Values: Fixes values for some decorations: BuiltIn LocalInvocationId, and BuiltIn
|
||||
SubgroupId
|
||||
* All handling of FPFastMathMode masks.
|
||||
* LinkageAttributes now requires the literal string operand.
|
||||
* Fixes capabilities: Adds ImageMipmap, and capabilities from LiteralSampler through
|
||||
SampleRateShading.
|
||||
|
||||
2015-09-09
|
||||
* Avoid confusion about ownership of storage:
|
||||
* `spv_binary` is only used for output of the assembler, and should
|
||||
always be destroyed with `spvBinaryDestroy`.
|
||||
* `spv_text` is only used for output of the disassembler, and should
|
||||
always be destroyed with `spvTextDestroy`.
|
||||
* Inputs to the assembler and disassembler are provided as pointer
|
||||
and length arguments.
|
||||
* Fixed parsing of floating point literals.
|
||||
* Fixed the -p option for the disassembler executable.
|
||||
* Fixed a build break on MSVC when using a ternary operator with conflicting
|
||||
types.
|
||||
* More test coverage and other cleanups.
|
||||
|
||||
2015-09-04
|
||||
* The parser has been overhauled
|
||||
* We use an automatically generated table to describe the syntax of each
|
||||
core instruction. The changes to the SPIR-V spec document generator to
|
||||
create this table are still being developed.
|
||||
* The parser uses a dynamically updated list of expected operand types.
|
||||
It is expanded as needed for variable-length lists of operands, and
|
||||
consumed during the parse. See the uses of `spv_operand_pattern_t`.
|
||||
* The syntax of enum operands and their potential operands is still
|
||||
hand-coded. (That might change depending on the cost-benefit tradeoff.)
|
||||
* We are actively increasing test coverage.
|
||||
* We have tweaked the CMake build rules to make it easier to integrate
|
||||
into other packages. Google is integrating SPIR-V Tools into the Vulkan
|
||||
conformance test suite.
|
||||
* New code tends to use Google C++ style, including formatting as generated
|
||||
by `clang-format --style=google`.
|
||||
* The spvBinaryToText and spvTextToBinary interfaces have been updated to
|
||||
remove a conceptual ambiguity that arises when cleaning up `spv_binary_t`
|
||||
and `spv_text_t` objects.
|
||||
|
||||
|
||||
## Where is the code?
|
||||
|
||||
The `master` branch of the repository is maintained by
|
||||
Kenneth Benzie `k.benzie@codeplay.com`.
|
||||
|
||||
Please submit any merge requests as stated in these
|
||||
[instructions](https://cvs.khronos.org/wiki/index.php/How_to_access_and_use_the_Khronos_Gitlab_Repository).
|
||||
|
||||
|
||||
## Build
|
||||
|
||||
The project uses CMake to generate platform-specific build configurations. To
|
||||
generate these build files issue the following commands.
|
||||
|
||||
```
|
||||
mkdir <spirv-dir>/build
|
||||
cd <spirv-dir>/build
|
||||
cmake [-G<platform-generator>] ..
|
||||
```
|
||||
|
||||
Once the build files have been generated, build using your preferred
|
||||
development environment.
|
||||
|
||||
### CMake Options
|
||||
|
||||
* `SPIRV_USE_SANITIZER=<sanitizer>` - on UNIX platforms with an appropriate
|
||||
version of `clang` this option enables the use of the sanitizers documented
|
||||
[here](http://clang.llvm.org/docs/UsersManual.html#controlling-code-generation),
|
||||
this should only be used with a debug build, disabled by default
|
||||
* `SPIRV_COLOR_TERMINAL=ON` - enables color console output, enabled by default
|
||||
* `SPIRV_WARN_EVERYTHING=OFF` - on UNIX platforms enable the `-Weverything`
|
||||
compiler front end option, disabled by default
|
||||
* `SPIRV_WERROR=OFF` - on UNIX platforms enable the `-Werror` compiler front end
|
||||
option, disabled by default
|
||||
|
||||
## Library
|
||||
|
||||
### Usage
|
||||
|
||||
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/libspirv/libspirv.h` then linking against the static
|
||||
library in `<spirv-build-dir>/bin/libSPIRV.a` or
|
||||
`<spirv-build-dir>/bin/SPIRV.lib`. The intention is for this to be a C API,
|
||||
however currently it relies on the generated header `spirv.h` meaning this is
|
||||
currently a C++ API.
|
||||
|
||||
* `SPIRV` - the static library CMake target outputs `<spirv-dir>/lib/libSPIRV.a`
|
||||
on Linux/Mac or `<spirv-dir>/lib/SPIRV.lib` on Windows.
|
||||
|
||||
#### Entry Points
|
||||
|
||||
There are three main entry points into the library.
|
||||
|
||||
* `spvTextToBinary` implements the assembler functionality.
|
||||
* `spvBinaryToText` implements the disassembler functionality.
|
||||
* `spvValidate` implements the validator functionality.
|
||||
|
||||
### Source
|
||||
|
||||
In addition to the interface header `<spirv-dir>/include/libspirv/libspirv.h`
|
||||
the implementation source files reside in `<spirv-dir>/source/*`.
|
||||
|
||||
The parsers for the assembler and disassembler use a table describing the
|
||||
syntax of each core instruction. This table can be generated from the SPIR-V
|
||||
document generator:
|
||||
|
||||
1. Apply the patch in `source/core_syntax_table.patch` to the document generator.
|
||||
2. Run the document generator with the `-a` option and place the results in
|
||||
the `opcode.inc` file in the SPIR-V Tools `source` directory.
|
||||
3. Be aware of version skew: The SPIR-V document generator might target a newer
|
||||
verison of the spec than targeted by the SPIR-V tools.
|
||||
|
||||
### Assembler
|
||||
|
||||
The standalone assembler is the binary called `spirv-as` and is located in
|
||||
`<spirv-build-dir>/bin/spirv-as`. The functionality of the assembler is
|
||||
implemented by the `spvTextToBinary` library function.
|
||||
|
||||
The assembler operates on the textual form.
|
||||
|
||||
* `spirv-as` - the standalone assembler
|
||||
* `<spirv-dir>/bin/spirv-as`
|
||||
|
||||
#### Options
|
||||
|
||||
* `-o <filename>` is used to specify the output file, otherwise this is set to
|
||||
`out.spv`.
|
||||
|
||||
#### Syntax
|
||||
|
||||
See [`syntax.md`](syntax.md) for the assembly language syntax.
|
||||
|
||||
### Disassembler
|
||||
|
||||
The standalone disassembler is the binary called `spirv-dis` and is located in
|
||||
`<spirv-build-dir>/bin/spirv-dis`. The functionality of the disassembler is
|
||||
implemented by the `spvBinaryToText` library function.
|
||||
|
||||
The disassembler operates on the binary form.
|
||||
|
||||
* `spirv-dis` - the standalone disassembler
|
||||
* `<spirv-dir>/bin/spirv-dis`
|
||||
|
||||
#### Options
|
||||
|
||||
* `-o <filename>` is used to specify the output file, otherwise this is set to
|
||||
`out.spvasm`.
|
||||
* `-p` prints the assembly to the console on stdout, this includes colored
|
||||
output on Linux, Windows, and Mac.
|
||||
|
||||
### Validator
|
||||
|
||||
The standalone validator is the binary called `spirv-val` and is located in
|
||||
`<spirv-build-dir>/bin/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>/bin/spirv-val`
|
||||
|
||||
#### Options
|
||||
|
||||
* `-basic` performs basic stream validation, currently not implemented.
|
||||
* `-layout` performs logical layout validation as described in section 2.16
|
||||
Validation Rules, currently not implemented.
|
||||
* `-id` performs ID validation according to the instruction rules in sections
|
||||
3.28.1 through 3.28.22, enabled but is a work in progress.
|
||||
* `-capability` performs capability validation and or reporting, currently not
|
||||
implemented.
|
||||
|
||||
## Tests
|
||||
|
||||
The project contains a number of tests, implemented in the `UnitSPIRV`
|
||||
executable, used to drive the development and correctness of the tools, these
|
||||
use the [googletest](https://github.com/google/googletest) framework. The
|
||||
[googletest](https://github.com/google/googletest) source is not provided with
|
||||
this project, to enable the tests place the
|
||||
[googletest](https://github.com/google/googletest) source in the
|
||||
`<spirv-dir>/external/googletest` directory, rerun CMake if you have already
|
||||
done so previously, CMake will detect the existence of
|
||||
`<spirv-dir>/external/googletest` then build as normal.
|
||||
|
||||
## Future Work
|
||||
<a name="future"></a>
|
||||
|
||||
Required to complete 1.0 support:
|
||||
* Changes related to capabilities:
|
||||
* Check changes in dependencies on capabilities since 0.99 Rev32.
|
||||
* Update values related to the Generator Magic Number. Its meaning has
|
||||
changed.
|
||||
|
||||
### Assembler and disassembler
|
||||
|
||||
* Support 16-bit floating point literals.
|
||||
|
||||
### Validator
|
||||
|
||||
* Adopt the parser strategy used by the text and binary parsers.
|
||||
* Complete implementation of ID validation rules in `spirv-val`.
|
||||
* Implement section 2.16 Validation Rules in `spirv-val`.
|
||||
* Implement Capability validation and or report in `spirv-val`.
|
||||
* Improve assembly output from `spirv-dis`.
|
||||
* Improve diagnostic reports.
|
||||
|
||||
## Known Issues
|
||||
|
||||
* Header file `libspirv.h` cannot be used in C code.
|
||||
* Improve literal parsing in the assembler, currently only decimal integers and
|
||||
floating-point numbers are supported as literal operands and the parser is not
|
||||
contextually aware of the desired width of the operand.
|
||||
* Sometimes the assembler will succeed, but the disassembler will fail to
|
||||
disassemble the result. (Is this still true?)
|
||||
|
||||
## Licence
|
||||
|
||||
Copyright (c) 2015 The Khronos Group Inc.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a
|
||||
copy of this software and/or associated documentation files (the
|
||||
"Materials"), to deal in the Materials without restriction, including
|
||||
without limitation the rights to use, copy, modify, merge, publish,
|
||||
distribute, sublicense, and/or sell copies of the Materials, and to
|
||||
permit persons to whom the Materials are furnished to do so, subject to
|
||||
the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included
|
||||
in all copies or substantial portions of the Materials.
|
||||
|
||||
MODIFICATIONS TO THIS FILE MAY MEAN IT NO LONGER ACCURATELY REFLECTS
|
||||
KHRONOS STANDARDS. THE UNMODIFIED, NORMATIVE VERSIONS OF KHRONOS
|
||||
SPECIFICATIONS AND HEADER INFORMATION ARE LOCATED AT
|
||||
https://www.khronos.org/registry/
|
||||
|
||||
THE MATERIALS ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
||||
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
||||
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
||||
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
||||
MATERIALS OR THE USE OR OTHER DEALINGS IN THE MATERIALS.
|
||||
@ -32,10 +32,20 @@
|
||||
|
||||
void print_usage(char* argv0) {
|
||||
printf(
|
||||
"Assemble a *.svasm file into a *.sv binary.\n\n"
|
||||
"USAGE: %s [options] <filename>\n\n"
|
||||
" -o set the output filename\n",
|
||||
argv0);
|
||||
R"(%s - Create a SPIR-V binary module from SPIR-V assembly text
|
||||
|
||||
Usage: %s [options] <filename>
|
||||
|
||||
The SPIR-V assembly text is read from <filename>. The SPIR-V binary
|
||||
module is written to file "out.spv", unless the -o option is used.
|
||||
|
||||
Options:
|
||||
|
||||
-h Print this help.
|
||||
|
||||
-o <filename> Set the output filename.
|
||||
)",
|
||||
argv0, argv0);
|
||||
}
|
||||
|
||||
int main(int argc, char** argv) {
|
||||
@ -50,6 +60,10 @@ int main(int argc, char** argv) {
|
||||
for (int argi = 1; argi < argc; ++argi) {
|
||||
if ('-' == argv[argi][0]) {
|
||||
switch (argv[argi][1]) {
|
||||
case 'h': {
|
||||
print_usage(argv[0]);
|
||||
return 0;
|
||||
}
|
||||
case 'o': {
|
||||
if (!outFile && argi + 1 < argc) {
|
||||
outFile = argv[++argi];
|
||||
|
||||
Loading…
Reference in New Issue
Block a user