Instructions for building this repository on Linux, Windows, Android, and
MacOS.
If you intend to contribute, the preferred work flow is for you to develop
your contribution in a fork of this repository in your GitHub account and then
submit a pull request. Please see the CONTRIBUTING.md file
in this repository for more details.
This repository contains the source code necessary to build the Vulkan
validation layers and their tests.
The install
target installs the following files under the directory
indicated by install_dir:
/lib
: The Vulkan validation layer libraries/share/vulkan/explicit_layer.d
: The Vulkan validation layerThe uninstall
target can be used to remove the above files from the install
directory.
This repository does not contain a Vulkan-capable driver. You will need to
obtain and install a Vulkan driver from your graphics hardware vendor or from
some other suitable source if you intend to run Vulkan applications.
To create your local git repository:
git clone https://github.com/KhronosGroup/Vulkan-ValidationLayers.git
This repository attempts to resolve some of its dependencies by using
components found from the following places, in this order:
VULKAN_SDK
environment variableDependencies that cannot be resolved by the SDK or installed packages must be
resolved with the "install directory" override and are listed below. The
"install directory" override can also be used to force the use of a specific
version of that dependency.
This repository has a required dependency on the
Vulkan Headers repository.
You must clone the headers repository and build its install
target before
building this repository. The Vulkan-Headers repository is required because it
contains the Vulkan API definition files (registry) that are required to build
the validation layers. You must also take note of the headers' install
directory and pass it on the CMake command line for building this repository,
as described below.
This repository has a required dependency on the
glslang repository.
The glslang repository is required because it contains components that are
required to build the validation layers. You must clone the glslang repository
and build its install
target. Follow the build instructions in the glslang
README.md
file. Ensure that the update_glslang_sources.py
script has been run as part
of building glslang. You must also take note of the glslang install directory
and pass it on the CMake command line for building this repository, as
described below.
The validation layer tests depend on the
Google Test
framework and do not build unless this framework is downloaded into the
repository's external
directory.
To obtain the framework, change your current directory to the top of your
Vulkan-ValidationLayers repository and run:
git clone https://github.com/google/googletest.git external/googletest
cd external/googletest
git checkout tags/release-1.8.1
before configuring your build with CMake.
If you do not need the tests, there is no need to download this
framework.
The validation layer tests depend on the Vulkan loader when they execute and
so a loader is needed only if the tests are built and run.
A loader can be used from an installed LunarG SDK, an installed Linux package,
or from a driver installation on Windows.
If a loader is not available from any of these methods and/or it is important
to use a loader built from a repository, then you must build the
Vulkan-Loader repository
with its install target. Take note of its install directory location and pass
it on the CMake command line for building this repository, as described below.
If you do not intend to run the tests, you do not need a Vulkan loader.
A common convention is to place the build directory in the top directory of
the repository with a name of build
and place the install directory as a
child of the build directory with the name install
. The remainder of these
instructions follow this convention, although you can use any name for these
directories and place them in any location.
There is a Python utility script, scripts/update_deps.py
, that you can use
to gather and build the dependent repositories mentioned above. This program
also uses information stored in the scripts/known-good.json
file to checkout
dependent repository revisions that are known to be compatible with the
revision of this repository that you currently have checked out.
Here is a usage example for this repository:
git clone git@github.com:KhronosGroup/Vulkan-ValidationLayers.git
cd Vulkan-ValidationLayers
mkdir build
cd build
../scripts/update_deps.py
cmake -C helper.cmake ..
cmake --build .
update_deps.py
script fetches and builds the dependent repositories inbuild
directory.build
directory is also being used to build thisbuild
directory between the dependent repositories and the--dir
option for update_deps.py
can be used to relocate theupdate_deps.py
script generates a file named helper.cmake
and placesbuild
in this*_INSTALL_DIR
cmake -C
option to set these*_INSTALL_DIR
variable settings on the CMake command line.winpty update_deps.py
in order to avoid buffering all of the script'supdate_deps.py --help
to list additional options and read theupdate_deps.py
for further information.When generating native platform build files through CMake, several options can
be specified to customize the build. Some of the options are binary on/off
options, while others take a string as input. The following is a table of all
on/off options currently supported by this repository:
Option | Platform | Default | Description |
---|---|---|---|
BUILD_LAYERS | All | ON |
Controls whether or not the validation layers are built. |
BUILD_LAYER_SUPPORT_FILES | All | OFF |
Controls whether or not layer support files are built if the layers are not built. |
BUILD_TESTS | All | ??? |
Controls whether or not the validation layer tests are built. The default is ON when the Google Test repository is cloned into the external directory. Otherwise, the default is OFF . |
INSTALL_TESTS | All | OFF |
Controls whether or not the validation layer tests are installed. This option is only available when a copy of Google Test is available |
BUILD_WSI_XCB_SUPPORT | Linux | ON |
Build the components with XCB support. |
BUILD_WSI_XLIB_SUPPORT | Linux | ON |
Build the components with Xlib support. |
BUILD_WSI_WAYLAND_SUPPORT | Linux | ON |
Build the components with Wayland support. |
USE_CCACHE | Linux | OFF |
Enable caching with the CCache program. |
The following is a table of all string options currently supported by this repository:
Option | Platform | Default | Description |
---|---|---|---|
CMAKE_OSX_DEPLOYMENT_TARGET | MacOS | 10.12 |
The minimum version of MacOS for loader deployment. |
These variables should be set using the -D
option when invoking CMake to
generate the native platform files.
The general approach is to run CMake to generate the Visual Studio project
files. Then either run CMake with the --build
option to build from the
command line or use the Visual Studio IDE to open the generated solution and
work with the solution interactively.
cd Vulkan-ValidationLayers
mkdir build
cd build
cmake -A x64 -DVULKAN_HEADERS_INSTALL_DIR=absolute_path_to_install_dir \
-DGLSLANG_INSTALL_DIR=absolute_path_to_install_dir ..
cmake --build .
The above commands instruct CMake to find and use the default Visual Studio
installation to generate a Visual Studio solution and projects for the x64
architecture. The second CMake command builds the Debug (default)
configuration of the solution.
See below for the details.
CMake
to Create the Visual Studio Project FilesChange your current directory to the top of the cloned repository directory,
create a build directory and generate the Visual Studio project files:
cd Vulkan-ValidationLayers
mkdir build
cd build
cmake -A x64 -DVULKAN_HEADERS_INSTALL_DIR=absolute_path_to_install_dir \
-DGLSLANG_INSTALL_DIR=absolute_path_to_install_dir ..
Note: The
..
parameter tellscmake
the location of the top of the
repository. If you place your build directory someplace else, you'll need to
specify the location of the repository top differently.
The -A
option is used to select either the "Win32" or "x64" architecture.
If a generator for a specific version of Visual Studio is required, you can
specify it for Visual Studio 2015, for example, with:
64-bit: -G "Visual Studio 14 2015 Win64"
32-bit: -G "Visual Studio 14 2015"
See this list of other possible generators
for Visual Studio.
When generating the project files, the absolute path to a Vulkan-Headers
install directory must be provided. This can be done by setting theVULKAN_HEADERS_INSTALL_DIR
environment variable or by setting theVULKAN_HEADERS_INSTALL_DIR
CMake variable with the -D
CMake option. In
either case, the variable should point to the installation directory of a
Vulkan-Headers repository built with the install target.
When generating the project files, the absolute path to a glslang install
directory must be provided. This can be done by setting theGLSLANG_INSTALL_DIR
environment variable or by setting theGLSLANG_INSTALL_DIR
CMake variable with the -D
CMake option. In either
case, the variable should point to the installation directory of a glslang
repository built with the install target.
The above steps create a Windows solution file namedVulkan-ValidationLayers.sln
in the build directory.
At this point, you can build the solution from the command line or open the
generated solution with Visual Studio.
While still in the build directory:
cmake --build .
to build the Debug configuration (the default), or:
cmake --build . --config Release
to make a Release build.
Launch Visual Studio and open the "Vulkan-ValidationLayers.sln" solution file
in the build folder. You may select "Debug" or "Release" from the Solution
Configurations drop-down list. Start a build by selecting the Build->Build
Solution menu item.
The CMake project also generates an "install" target that you can use to copy
the primary build artifacts to a specific location using a "bin, include, lib"
style directory structure. This may be useful for collecting the artifacts and
providing them to another project that is dependent on them.
The default location is $CMAKE_BINARY_DIR\install
, but can be changed with
the CMAKE_INSTALL_PREFIX
variable when first generating the project build
files with CMake.
You can build the install target from the command line with:
cmake --build . --config Release --target install
or build the INSTALL
target from the Visual Studio solution explorer.
If you do need to build and use your own loader, build the Vulkan-Loader
repository with the install target and modify your CMake invocation to add the
location of the loader's install directory:
cmake -A x64 -DVULKAN_HEADERS_INSTALL_DIR=absolute_path_to_install_dir \
-DVULKAN_LOADER_INSTALL_DIR=absolute_path_to_install_dir \
-DGLSLANG_INSTALL_DIR=absolute_path_to_install_dir ..
After making any changes to the repository, you should perform some quick
sanity tests, including the run_all_tests Powershell script. In addition,
running sample applications such as the
vkcube demo
with validation enabled is advised.
To run the validation test script, open a Powershell Console, change to the
build/tests directory, and run:
For Release builds:
.\run_all_tests.ps1
For Debug builds:
.\run_all_tests.ps1 -Debug
This script will run the following tests:
vk_layer_validation_tests
:The chosen generator should match one of the Visual Studio versions that you
have installed. Generator strings that correspond to versions of Visual Studio
include:
Build Platform | 64-bit Generator | 32-bit Generator |
---|---|---|
Microsoft Visual Studio 2013 | "Visual Studio 12 2013 Win64" | "Visual Studio 12 2013" |
Microsoft Visual Studio 2015 | "Visual Studio 14 2015 Win64" | "Visual Studio 14 2015" |
Microsoft Visual Studio 2017 | "Visual Studio 15 2017 Win64" | "Visual Studio 15 2017" |
Vulkan programs must be able to find and use the Vulkan loader
(vulkan-1.dll
) library as well as any other libraries the program requires.
One convenient way to do this is to copy the required libraries into the same
directory as the program. If you provided a loader repository location via theVULKAN_LOADER_INSTALL_DIR
variable, the projects in this solution copy the
Vulkan loader library and the "googletest" libraries to thebuild\tests\Debug
or the build\tests\Release
directory, which is where the
test executables are found, depending on what configuration you built. (The
layer validation tests use the "googletest" testing framework.)
This repository has been built and tested on the two most recent Ubuntu LTS
versions. Currently, the oldest supported version is Ubuntu 14.04, meaning
that the minimum supported compiler versions are GCC 4.8.2 and Clang 3.4,
although earlier versions may work. It should be straightforward to adapt this
repository to other Linux distributions.
sudo apt-get install git cmake build-essential libx11-xcb-dev \
libxkbcommon-dev libwayland-dev libxrandr-dev \
libegl1-mesa-dev
The general approach is to run CMake to generate make files. Then either run
CMake with the --build
option or make
to build from the command line.
cd Vulkan-ValidationLayers
mkdir build
cd build
cmake -DVULKAN_HEADERS_INSTALL_DIR=absolute_path_to_install_dir \
-DGLSLANG_INSTALL_DIR=absolute_path_to_install_dir ..
make
See below for the details.
Change your current directory to the top of the cloned repository directory,
create a build directory and generate the make files.
cd Vulkan-ValidationLayers
mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=Debug \
-DVULKAN_HEADERS_INSTALL_DIR=absolute_path_to_install_dir \
-DGLSLANG_INSTALL_DIR=absolute_path_to_install_dir \
-DCMAKE_INSTALL_PREFIX=install ..
Note: The
..
parameter tellscmake
the location of the top of the
repository. If you place yourbuild
directory someplace else, you'll need
to specify the location of the repository top differently.
Use -DCMAKE_BUILD_TYPE
to specify a Debug or Release build.
When generating the project files, the absolute path to a Vulkan-Headers
install directory must be provided. This can be done by setting theVULKAN_HEADERS_INSTALL_DIR
environment variable or by setting theVULKAN_HEADERS_INSTALL_DIR
CMake variable with the -D
CMake option. In
either case, the variable should point to the installation directory of a
Vulkan-Headers repository built with the install target.
When generating the project files, the absolute path to a glslang install
directory must be provided. This can be done by setting theGLSLANG_INSTALL_DIR
environment variable or by setting theGLSLANG_INSTALL_DIR
CMake variable with the -D
CMake option. In either
case, the variable should point to the installation directory of a glslang
repository built with the install target.
Note: For Linux, the default value for
CMAKE_INSTALL_PREFIX
is/usr/local
, which would be used if you do not specifyCMAKE_INSTALL_PREFIX
. In this case, you may need to usesudo
to install
to system directories later when you runmake install
.
You can just run make
to begin the build.
To speed up the build on a multi-core machine, use the -j
option for make
to specify the number of cores to use for the build. For example:
make -j4
You can also use
cmake --build .
If your build system supports ccache, you can enable that via CMake option -DUSE_CCACHE=On
By default, the repository components are built with support for the
Vulkan-defined WSI display servers: Xcb, Xlib, and Wayland. It is recommended
to build the repository components with support for these display servers to
maximize their usability across Linux platforms. If it is necessary to build
these modules without support for one of the display servers, the appropriate
CMake option of the form BUILD_WSI_xxx_SUPPORT
can be set to OFF
.
Installing the files resulting from your build to the systems directories is
optional since environment variables can usually be used instead to locate the
binaries. There are also risks with interfering with binaries installed by
packages. If you are certain that you would like to install your binaries to
system directories, you can proceed with these instructions.
Assuming that you've built the code as described above and the current
directory is still build
, you can execute:
sudo make install
This command installs files to /usr/local
if no CMAKE_INSTALL_PREFIX
is
specified when creating the build files with CMake:
/usr/local/lib
: Vulkan layers shared objects/usr/local/share/vulkan/explicit_layer.d
: Layer JSON filesYou may need to run ldconfig
in order to refresh the system loader search
cache on some Linux systems.
You can further customize the installation location by setting additional
CMake variables to override their defaults. For example, if you would like to
install to /tmp/build
instead of /usr/local
, on your CMake command line
specify:
-DCMAKE_INSTALL_PREFIX=/tmp/build
Then run make install
as before. The install step places the files in/tmp/build
. This may be useful for collecting the artifacts and providing
them to another project that is dependent on them.
See the CMake documentation for more details on using these variables to
further customize your installation.
Also see the LoaderAndLayerInterface
document in the loader
folder of the
Vulkan-Loader repository for more information about loader and layer
operation.
To uninstall the files from the system directories, you can execute:
sudo make uninstall
To run the validation test script, in a terminal change to the build/tests directory and run:
VK_LAYER_PATH=../layers ./run_all_tests.sh
This script will run the following tests:
vk_layer_validation_tests
: Test Vulkan validation layersUsage of this repository's contents in 32-bit Linux environments is not
officially supported. However, since this repository is supported on 32-bit
Windows, these modules should generally work on 32-bit Linux.
Here are some notes for building 32-bit targets on a 64-bit Ubuntu "reference"
platform:
If not already installed, install the following 32-bit development libraries:
gcc-multilib g++-multilib libx11-dev:i386
This list may vary depending on your distribution and which windowing systems
you are building for.
Set up your environment for building 32-bit targets:
export ASFLAGS=--32
export CFLAGS=-m32
export CXXFLAGS=-m32
export PKG_CONFIG_LIBDIR=/usr/lib/i386-linux-gnu
Again, your PKG_CONFIG configuration may be different, depending on your distribution.
Finally, rebuild the repository using cmake
and make
, as explained above.
export VK_LAYER_PATH=<path to your repository root>/build/layers
You can run the vkcube
or vulkaninfo
applications from the Vulkan-Tools
repository to see which driver, loader and layers are being used.
Install the required tools for Linux and Windows covered above, then add the
following.
For each of the below, you may need to specify a different build-tools
version, as Android Studio will roll it forward fairly regularly.
On Linux:
export ANDROID_SDK_HOME=$HOME/Android/sdk
export ANDROID_NDK_HOME=$HOME/Android/sdk/ndk-bundle
export PATH=$ANDROID_SDK_HOME:$PATH
export PATH=$ANDROID_NDK_HOME:$PATH
export PATH=$ANDROID_SDK_HOME/build-tools/23.0.3:$PATH
On Windows:
set ANDROID_SDK_HOME=%LOCALAPPDATA%\Android\sdk
set ANDROID_NDK_HOME=%LOCALAPPDATA%\Android\sdk\ndk-bundle
set PATH=%LOCALAPPDATA%\Android\sdk\ndk-bundle;%PATH%
On OSX:
export ANDROID_SDK_HOME=$HOME/Library/Android/sdk
export ANDROID_NDK_HOME=$HOME/Library/Android/sdk/ndk-bundle
export PATH=$ANDROID_NDK_PATH:$PATH
export PATH=$ANDROID_SDK_HOME/build-tools/23.0.3:$PATH
Note: If jarsigner
is missing from your platform, you can find it in the
Android Studio install or in your Java installation. If you do not have Java,
you can get it with something like the following:
sudo apt-get install openjdk-8-jdk
Tested on OSX version 10.13.3
Setup Homebrew and components
Follow instructions on brew.sh to get Homebrew installed.
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
Ensure Homebrew is at the beginning of your PATH:
export PATH=/usr/local/bin:$PATH
Add packages with the following:
brew install cmake python
There are two options for building the Android layers. Either using the SPIRV
tools provided as part of the Android NDK, or using upstream sources. To build
with SPIRV tools from the NDK, remove the build-android/third_party directory
created by running update_external_sources_android.sh, (or avoid running
update_external_sources_android.sh). Use the following script to build
everything in the repository for Android, including validation layers, tests,
demos, and APK packaging: This script does retrieve and use the upstream SPRIV
tools.
cd build-android
./build_all.sh
Resulting validation layer binaries will be in build-android/libs. Test and
demo APKs can be installed on production devices with:
./install_all.sh [-s <serial number>]
Note that there are no equivalent scripts on Windows yet, that work needs to
be completed. The following per platform commands can be used for layer only
builds:
Follow the setup steps for Linux or OSX above, then from your terminal:
cd build-android
./update_external_sources_android.sh --no-build
./android-generate.sh
ndk-build -j4
Follow the setup steps for Windows above, then from Developer Command Prompt
for VS2013:
cd build-android
update_external_sources_android.bat
android-generate.bat
ndk-build
After making any changes to the repository you should perform some quick
sanity tests, including the layer validation tests and the vkcube
demo with validation enabled.
Use the following steps to build, install, and run the layer validation tests
for Android:
cd build-android
./build_all.sh
adb install -r bin/VulkanLayerValidationTests.apk
adb shell am start com.example.VulkanLayerValidationTests/android.app.NativeActivity
Alternatively, you can use the test_APK script to install and run the layer
validation tests:
test_APK.sh -s <serial number> -p <plaform name> -f <gtest_filter>
Tested on OSX version 10.12.6
Setup Homebrew and components
Follow instructions on brew.sh to get Homebrew installed.
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
Ensure Homebrew is at the beginning of your PATH:
export PATH=/usr/local/bin:$PATH
Add packages with the following (may need refinement)
brew install cmake python python3 git
Clone the Vulkan-ValidationLayers repository:
git clone https://github.com/KhronosGroup/Vulkan-ValidationLayers.git
This repository uses CMake to generate build or project files that are then
used to build the repository. The CMake generators explicitly supported in
this repository are:
This generator is the default generator, so all that is needed for a debug
build is:
mkdir build
cd build
cmake -DVULKAN_HEADERS_INSTALL_DIR=absolute_path_to_install_dir \
-DGLSLANG_INSTALL_DIR=absolute_path_to_install_dir \
-DCMAKE_BUILD_TYPE=Debug ..
make
To speed up the build on a multi-core machine, use the -j
option for make
to specify the number of cores to use for the build. For example:
make -j4
To create and open an Xcode project:
mkdir build-xcode
cd build-xcode
cmake -DVULKAN_HEADERS_INSTALL_DIR=absolute_path_to_install_dir \
-DGLSLANG_INSTALL_DIR=absolute_path_to_install_dir \
-GXcode ..
open VULKAN.xcodeproj
Within Xcode, you can select Debug or Release builds in the Build Settings of the project.
export VK_LAYER_PATH=<path to your repository root>/build/layers
You can run the vulkaninfo
applications from the Vulkan-Tools repository to
see which driver, loader and layers are being used.
After making any changes to the repository, you should perform the included sanity tests by running
the run_all_tests shell script.
These test require a manual path to an ICD to run properly on MacOS.
You can use:
Clone and build the MoltenVK repository.
You will have to direct the loader from Vulkan-Loader to the MoltenVK ICD:
export VK_ICD_FILENAMES=<path to MoltenVK repository>/Package/Latest/MoltenVK/macOS/MoltenVK_icd.json
Clone and build the Vulkan-Tools repository.
You will have to direct the loader from Vulkan-Loader to the Mock ICD:
export VK_ICD_FILENAMES=<path to Vulkan-Tools repository>/build/icd/VkICD_mock_icd.json
To run the validation test script, in a terminal change to the build/tests directory and run:
VK_LAYER_PATH=../layers ./run_all_tests.sh
This script will run the following tests:
vk_layer_validation_tests
: Test Vulkan validation layersFurther testing and sanity checking can be achieved by running the vkcube and
vulkaninfo applications in the
Vulkan-Tools
repository.
Note that MoltenVK is still adding Vulkan features and some tests may fail.