Undefine Bool after the headers that define them

X11/Xlib.h defines Bool as a macro, which clashes with Reactor's Bool
class. This X11 header is also included by vulkan.h, vk_icd.h, and
EGL/eglplatform.h

Previously we undefined Bool in various places. It's not possible to
just undefine it in Reactor.hpp because one can have headers following
the inclusion of Reactor.hpp which redefine it (note our convention is
to include platform headers after project headers).

Since X11 is only needed in select places related to the windowing
system, we can instead avoid the use of these headers in other headers,
and only include them in .cpp files where necessary. Note that
vulkan_core.h contains the whole plaform-independent Vulkan API, so it
should be used instead of vulkan.h for all non-WSI code.

Bug: b/127920555
Change-Id: Id11a1c58b87802fe9e530387831693e44accae2b
Reviewed-on: https://swiftshader-review.googlesource.com/c/SwiftShader/+/46368
Presubmit-Ready: Nicolas Capens <nicolascapens@google.com>
Kokoro-Result: kokoro <noreply+kokoro@google.com>
Tested-by: Nicolas Capens <nicolascapens@google.com>
Reviewed-by: Alexis H├ętu <sugoi@google.com>
21 files changed
tree: ede0b3d320de42cf508d69cbe1315cdf9ace5f2b
  1. .clang-format
  2. .dir-locals.el
  3. .gitignore
  4. .gitmodules
  5. .travis.yml
  6. .vscode/
  7. AUTHORS.txt
  8. Android.bp
  9. BUILD.gn
  10. CMakeLists.txt
  11. CMakeSettings.json
  12. CONTRIBUTING.txt
  13. CONTRIBUTORS.txt
  14. LICENSE.txt
  15. OWNERS
  16. README.md
  17. build/
  18. build_overrides/
  19. codereview.settings
  20. docs/
  21. extensions/
  22. include/
  23. src/
  24. tests/
  25. third_party/
  26. tools/
README.md

SwiftShader

License Build Status Build status

Introduction

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

Building

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

  • Visual Studio
    For building 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.

  • CMake

    Install CMake for Linux, Mac OS X, or Windows and use either the IDE or run the following terminal commands:

    cd build
    cmake ..
    make --jobs=8
    
    ./vk-unittests
    

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.

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

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 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.

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. We do not claim official conformance with the OpenGL graphics API at this moment.
  3. This is not an official Google product.