| commit | 4804ac8724ff42f0750def99a17ff929cff92d7f | [log] [tgz] |
|---|---|---|
| author | Nicolas Capens <capn@google.com> | Mon Nov 02 22:06:55 2020 -0500 |
| committer | Nicolas Capens <nicolascapens@google.com> | Thu Nov 12 06:04:00 2020 +0000 |
| tree | 3279b7d12650245548868989cee4c30c032d7a0a | |
| parent | b638dfe160a17f288c774fd98f725f212f843c2b [diff] |
Implement MemorySanitizer instrumentation of Reactor routines MemorySanitizer checks for uninitialized memory and variable usage. It instruments each instruction to update 'shadow' memory which indicates which bits are 'poisoned', and inserts tests for dereferencing pointers and conditional branching which makes use of not fully initialized data. The instrumentation is done by the llvm::MemorySanitizerLegacyPass. Functions must opt-in to the instrumentation with the 'SanitizeMemory' attribute. MemorySanitizer relies on several TLS variables for storing the shadow value of function parameters and return values. The JIT makes calls to __emutls_get_address() to obtain the address off these variables, passing it the address of a __emutls_v.* control structure unique to the TLS variable. We replace the former with our own function through the symbol resolver, and the latter are represented by enum values, to allow obtaining the real TLS variable's address in C++ code. This is enabled behind a REACTOR_ENABLE_MEMORY_SANITIZER_INSTRUMENTATION flag. For now, only enable CMake builds. Bug: b/155148722 Change-Id: I6d755244589c9b0de19a283f9dff5d8a3bf6f24b Reviewed-on: https://swiftshader-review.googlesource.com/c/SwiftShader/+/49829 Kokoro-Result: kokoro <noreply+kokoro@google.com> Tested-by: Nicolas Capens <nicolascapens@google.com> Reviewed-by: Antonio Maiorano <amaiorano@google.com>
SwiftShader is a high-performance CPU-based implementation of the Vulkan graphics APIs12. 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.
SwiftShader libraries can be built for Windows, Linux, and Mac OS X.
Android and Chrome (OS) build environments are also supported.
CMake
Install CMake for Linux, Mac OS X, or Windows and use either the GUI or run the following terminal commands:
cd build cmake .. cmake --build . --parallel ./vk-unittests
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.
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.
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.
SwiftShader's OpenGL ES implementation can be tested using the dEQP test suite.
See docs/dEQP.md for details.
The third_party directory contains projects which originated outside of SwiftShader:
subzero contains a fork of the Subzero project. It is part of Google Chrome‘s (Portable) Native Client project. Its authoritative source is at https://chromium.googlesource.com/native_client/pnacl-subzero/. The fork was made using git-subtree to include all of Subzero’s history, and until further notice it should not diverge from the upstream project. Contributions must be tested using the README instructions, reviewed at https://chromium-review.googlesource.com, and then pulled into the SwiftShader repository.
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.
See docs/Index.md.
Public mailing list: swiftshader@googlegroups.com
General bug tracker: https://g.co/swiftshaderbugs
Chrome specific bugs: https://bugs.chromium.org/p/swiftshader
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.
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.