Google Git
Sign in
swiftshader / SwiftShader / 3e70200a08f89c84e6dadbe4a6f04e5d12efe49a
commit3e70200a08f89c84e6dadbe4a6f04e5d12efe49a[log] [tgz]
authorBen Clayton <bclayton@google.com>Mon Jan 30 14:39:28 2023 +0000
committerBen Clayton <bclayton@google.com>Mon Jan 30 14:39:28 2023 +0000
treef9153c2ecd0fb7d7d2c6b8d18a9c39d986018200
parentb87a39806281753a52398c9ae1e544826514c2b4 [diff]
parent7fcf28dc09660cfcacab9ea89c796b0cefda37f3 [diff]
Update SPIR-V Headers to aa331ab0f

Changes:
    aa331ab0ffc Merge pull request #299 from qingyuanzNV/add_nonsemantic_debugbreak
    503026592be Merge pull request #315 from bashbaug/fix-SPV_KHR_shader_clock
    36c7694279d Merge pull request #291 from broxigarchen/kernelArgProperties
    98cc580e34d decouple SPV_KHR_shader_clock from the Shader capability
    4dd2cc4d3c4 Merge branch 'master' of https://github.com/broxigarchen/SPIRV-Headers into kernelArgProperties
    a4608a6af02 remove MMHostInterfaceAlignment and added parameters
    d13b52222c3 Merge pull request #312 from alan-baker/clspv-optional-operands
    30a41a43be6 Make operands to Kernel added in v5 optional
    c16439f4268 Update ClspvReflection non-semantic instruction set (#308)
    34d04647d38 Merge pull request #311 from dneto0/issue-303
    66ebc285103 Add operator^
    355f4518799 C++ headers: Define & and ~ bitwise operators for mask enums
    88e0805c013 added extension name
    ba70a9523ae added SPRIV_INTEL_argument_interfaces
    ff67f521e3c NonSemantic.DebugBreak

Commands:
    ./third_party/update-spirvheaders.sh

Bug: b/123642959
Change-Id: I061677353e9e0ecf166d79383e443c161c8191a0
tree: f9153c2ecd0fb7d7d2c6b8d18a9c39d986018200
  1. .vscode/
  2. build/
  3. build_overrides/
  4. docs/
  5. include/
  6. infra/
  7. src/
  8. tests/
  9. third_party/
  10. tools/
  11. .clang-format
  12. .dir-locals.el
  13. .gitignore
  14. .gitmodules
  15. Android.bp
  16. AUTHORS.txt
  17. BUILD.gn
  18. CMakeLists.txt
  19. CMakeSettings.json
  20. codereview.settings
  21. CONTRIBUTING.txt
  22. CONTRIBUTORS.txt
  23. DIR_METADATA
  24. LICENSE.txt
  25. OWNERS
  26. README.md
README.md

SwiftShader

License

Introduction

SwiftShader[^1] is a high-performance CPU-based implementation[^2] of the Vulkan[^3] 1.3 graphics API. Its goal is to provide hardware independence for advanced 3D graphics.

NOTE: The ANGLE project can be used to achieve a layered implementation[^4] of OpenGL ES 3.1 (aka. “SwANGLE”).

Building

SwiftShader libraries can be built for Windows, Linux, and macOS.
Android and Chrome (OS) build environments are also supported.

  • CMake
    Install CMake for Linux, macOS, or Windows and use either the GUI or run the following terminal commands:

    cd build
cmake ..
cmake --build . --parallel

./vk-unittests

    Tip: Set the CMAKE_BUILD_PARALLEL_LEVEL environment variable to control the level of parallelism.

  • Visual Studio
    To build the Vulkan ICD library, use Visual Studio 2019 to open the project folder and wait for it to run CMake. Open the CMake Targets View in the Solution Explorer and select the vk_swiftshader project to build it.

Usage

The SwiftShader libraries act as drop-in replacements for graphics drivers.

On Windows, most applications can be made to use SwiftShader's DLLs by placing them in the same folder as the executable. On Linux, the LD_LIBRARY_PATH environment variable or -rpath linker option can be used to direct applications to search for shared libraries in the indicated directory first.

In general, Vulkan applications look for a shared library named vulkan-1.dll on Windows (vulkan-1.so on Linux). This ‘loader’ library then redirects API calls to the actual Installable Client Driver (ICD). SwiftShader's ICD is named libvk_swiftshader.dll, but it can be renamed to vulkan-1.dll to be loaded directly by the application. Alternatively, you can set the VK_ICD_FILENAMES environment variable to the path to vk_swiftshader_icd.json file that is generated under the build directory (e.g. .\SwiftShader\build\Windows\vk_swiftshader_icd.json). To learn more about how Vulkan loading works, read the official documentation here.

Contributing

See CONTRIBUTING.txt for important contributing requirements.

The canonical repository for SwiftShader is hosted at: https://swiftshader.googlesource.com/SwiftShader.

All changes must be reviewed and approved in the Gerrit review tool at: https://swiftshader-review.googlesource.com. You must sign in to this site with a Google Account before changes can be uploaded.

Next, authenticate your account here: https://swiftshader-review.googlesource.com/new-password (use the same e-mail address as the one configured as the Git commit author).

All changes require a Change-ID tag in the commit message. A commit hook may be used to add this tag automatically, and can be found at: https://gerrit-review.googlesource.com/tools/hooks/commit-msg. You can execute git clone https://swiftshader.googlesource.com/SwiftShader and manually place the commit hook in SwiftShader/.git/hooks/, or to clone the repository and install the commit hook in one go:

git clone https://swiftshader.googlesource.com/SwiftShader && (cd SwiftShader && git submodule update --init --recursive third_party/git-hooks && ./third_party/git-hooks/install_hooks.sh)

On Windows, this command line requires using the Git Bash Shell.

Changes are uploaded to Gerrit by executing:

git push origin HEAD:refs/for/master

When ready, add a project owner as a reviewer on your change.

Some tests will automatically be run against the change. Notably, presubmit.sh verifies the change has been formatted using clang-format 11.0.1. Most IDEs come with clang-format support, but may require upgrading/downgrading to the clang-format version 11.0.0 release version (notably Chromium's buildtools has a clang-format binary which can be an in-between revision which produces different formatting results).

Testing

SwiftShader's Vulkan implementation can be tested using the dEQP test suite.

See docs/dEQP.md for details.

Third-Party Dependencies

The third_party directory contains projects which originated outside of SwiftShader:

subzero contains a fork of the Subzero project. It originates from Google Chrome‘s (Portable) Native Client project. The fork was made using git-subtree to include all of Subzero’s history.

llvm-subzero contains a minimized set of LLVM dependencies of the Subzero project.

PowerVR_SDK contains a subset of the PowerVR Graphics Native SDK for running several sample applications.

googletest contains the Google Test project, as a Git submodule. It is used for running unit tests for Chromium, and Reactor unit tests. Run git submodule update --init to obtain/update the code. Any contributions should be made upstream.

Documentation

See docs/Index.md.

Contact

Public mailing list: swiftshader@googlegroups.com

General bug tracker: https://g.co/swiftshaderbugs
Chrome specific bugs: https://bugs.chromium.org/p/swiftshader

License

The SwiftShader project is licensed under the Apache License Version 2.0. You can find a copy of it in LICENSE.txt.

Files in the third_party folder are subject to their respective license.

Authors and Contributors

The legal authors for copyright purposes are listed in AUTHORS.txt.

CONTRIBUTORS.txt contains a list of names of individuals who have contributed to SwiftShader. If you‘re not on the list, but you’ve signed the Google CLA and have contributed more than a formatting change, feel free to request to be added.

Notes and Disclaimers

[^1]: This is not an official Google product.
[^2]: Vulkan 1.3 conformance: https://www.khronos.org/conformance/adopters/conformant-products#submission_717
[^3]: Trademarks are the property of their respective owners.
[^4]: OpenGL ES 3.1 conformance: https://www.khronos.org/conformance/adopters/conformant-products/opengles#submission_906