Revert 9dff6a3bb5 to mend git merge history for SPIRV-Headers and SPIRV-Tools

https://swiftshader-review.googlesource.com/c/SwiftShader/+/50749
squashed together the changes from two `git subtree pull` commands (for
SPIRV-Headers and SPIRV-Tools), which resulted in a change with a single
parent.

`git subtree` expects a merge commit with a single set of `git-subtree-*`
metadata tags. The squash resulted in a change description with two sets
of these, confusing `git subtree` even further.

The process to fix this is probably not the easiest, but the first one I found that works:

  # Rollback to the parent change of 50749
  git checkout 43bb60e1fa119d80b449c6550dd2b72328b101b9
  # Perform the subtree pull again for SPIRV-Headers (to 104ecc356)
  git subtree pull --prefix third_party/SPIRV-Headers https://github.com/KhronosGroup/SPIRV-Headers 104ecc356c1bea4476320faca64440cd1df655a3 --squash -m "Update SPIR-V Headers"
  # Note the second parent of the merge for the SPIRV-Headers (Merge: 43bb60e1fa1 ded361b487d)
  git show -1
  # Perform the subtree pull again for SPIRV-Tools (to b0e22d28f)
  git subtree pull --prefix third_party/SPIRV-Tools https://github.com/KhronosGroup/SPIRV-Tools b0e22d28f5ec891d6b256703575d08fce4228bd9 --squash -m "Update SPIR-V Tools"
  # Note the second parent of the merge for the SPIRV-Tools (Merge: a00ce432a9d bdb9eea9049)
  git show -1
  # Jump back to master
  git checkout origin/master
  # Revert 50749
  git revert 9dff6a3bb5950edd890e5141f2d3d2f3b4ef351e
  # Re-merge the squashed update change for SPIRV-Headers
  git merge -Xsubtree="third_party/SPIRV-Headers" ded361b487d
  # Re-merge the squashed update change for SPIRV-Tools
  git merge -Xsubtree="third_party/SPIRV-Tools" bdb9eea9049

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

SwiftShader

License

Introduction

SwiftShader is a high-performance CPU-based implementation of the Vulkan graphics API12. Its goal is to provide hardware independence for advanced 3D graphics.

NOTE: SwiftShader's OpenGL ES frontend is no longer supported, and will eventually be removed. Read more about our recommendation to use ANGLE on top of SwiftShader Vulkan here.

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

Authenticate your account here: https://swiftshader-review.googlesource.com/new-password

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. To clone the repository and install the commit hook in one go:

git clone https://swiftshader.googlesource.com/SwiftShader && (cd SwiftShader && curl -Lo `git rev-parse --git-dir`/hooks/commit-msg https://gerrit-review.googlesource.com/tools/hooks/commit-msg ; chmod +x `git rev-parse --git-dir`/hooks/commit-msg)

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 10.0. Most IDEs come with clang-format support, but may require downgrading to clang-format version 10.0.

Testing

SwiftShader's OpenGL ES 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.

Disclaimer

  1. Trademarks are the property of their respective owners.
  2. This is not an official Google product.