BUILD.md

   1 # Build Instructions
   2 This document contains the instructions for building this repository on Linux and Windows.
   3
   4 This repository does not contain a Vulkan-capable driver.
   5 Before proceeding, it is strongly recommended that you obtain a Vulkan driver from your graphics hardware vendor
   6 and install it.
   7
   8 Note: The sample Vulkan Intel driver for Linux (ICD) is being deprecated in favor of other driver options from Intel.
   9 This driver has been moved to the [VulkanTools repo](https://github.com/LunarG/VulkanTools).
  10 Further instructions regarding this ICD are available there.
  11
  12 ## Contributing
  13
  14 If you intend to contribute, the preferred work flow is for you to develop your contribution
  15 in a fork of this repo in your GitHub account and then submit a pull request.
  16 Please see the [CONTRIBUTING](CONTRIBUTING.md) file in this respository for more details.
  17
  18 ## Git the Bits
  19
  20 To create your local git repository:
  21 ```
  22 git clone https://github.com/KhronosGroup/Vulkan-LoaderAndValidationLayers
  23 ```
  24
  25 ## Linux Build
  26
  27 The build process uses CMake to generate makefiles for this project.
  28 The build generates the loader, layers, and tests.
  29
  30 This repo has been built and tested on Ubuntu 14.04.3 LTS, 14.10, 15.04, 15.10, and 16.04 LTS.
  31 It should be straightforward to use it on other Linux distros.
  32
  33 These packages are needed to build this repository:
  34 ```
  35 sudo apt-get install git cmake build-essential bison libx11-dev libxcb1-dev
  36 ```
  37
  38 Example debug build (Note that the update\_external\_sources script used below builds external tools into predefined locations. See **Loader and Validation Layer Dependencies** for more information and other options):
  39 ```
  40 cd Vulkan-LoaderAndValidationLayers  # cd to the root of the cloned git repository
  41 ./update_external_sources.sh
  42 cmake -H. -Bdbuild -DCMAKE_BUILD_TYPE=Debug
  43 cd dbuild
  44 make
  45 ```
  46
  47 If you have installed a Vulkan driver obtained from your graphics hardware vendor, the install process should
  48 have configured the driver so that the Vulkan loader can find and load it.
  49
  50 If you want to use the loader and layers that you have just built:
  51 ```
  52 export LD_LIBRARY_PATH=<path to your repository root>/dbuild/loader
  53 export VK_LAYER_PATH=<path to your repository root>/dbuild/layers
  54 ```
  55 You can run the `vulkaninfo` application to see which driver, loader and layers are being used.
  56
  57 The `LoaderAndLayerInterface` document in the `loader` folder in this repository is a specification that
  58 describes both how ICDs and layers should be properly
  59 packaged, and how developers can point to ICDs and layers within their builds.
  60
  61 ### Linux Install to System Directories
  62
  63 Installing the files resulting from your build to the systems directories is optional since
  64 environment variables can usually be used instead to locate the binaries.
  65 There are also risks with interfering with binaries installed by packages.
  66 If you are certain that you would like to install your binaries to system directories,
  67 you can proceed with these instructions.
  68
  69 Assuming that you've built the code as described above and the current directory is still `dbuild`,
  70 you can execute:
  71
  72 ```
  73 sudo make install
  74 ```
  75
  76 This command installs files to:
  77
  78 * `/usr/local/lib`:  Vulkan loader and layers shared objects
  79 * `/usr/local/bin`:  vulkaninfo application
  80 * `/etc/vulkan/explicit_layer.d`:  Layer JSON files
  81
  82 You may need to run `ldconfig` in order to refresh the system loader search cache on some Linux systems.
  83
  84 The list of installed files appears in the build directory in a file named `install_manifest.txt`.
  85 You can easily remove the installed files with:
  86
  87 ```
  88 cat install_manifest.txt | sudo xargs rm
  89 ```
  90
  91 See the CMake documentation for details on using `DESTDIR` and `CMAKE_INSTALL_PREFIX` to customize
  92 your installation location.
  93
  94 Note that some executables in this repository (e.g., `cube`) use the "rpath" linker directive
  95 to load the Vulkan loader from the build directory, `dbuild` in this example.
  96 This means that even after installing the loader to the system directories, these executables
  97 still use the loader from the build directory.
  98
  99 ## Validation Test
 100
 101 The test executables can be found in the dbuild/tests directory.
 102 Some of the tests that are available:
 103 - vk\_layer\_validation\_tests: Test Vulkan layers.
 104
 105 There are also a few shell and Python scripts that run test collections (eg,
 106 `run_all_tests.sh`).
 107
 108 ## Linux Demos
 109
 110 Some demos that can be found in the dbuild/demos directory are:
 111 - vulkaninfo: report GPU properties
 112 - cube: a textured spinning cube
 113 - smoke/smoke: A "smoke" test using a more complex Vulkan demo
 114
 115 ## Windows System Requirements
 116
 117 Windows 7+ with additional required software packages:
 118
 119 - Microsoft Visual Studio 2013 Professional.  Note: it is possible that lesser/older versions may work, but that has not been tested.
 120 - [CMake](http://www.cmake.org/download/).  Notes:
 121   - Tell the installer to "Add CMake to the system PATH" environment variable.
 122 - [Python 3](https://www.python.org/downloads).  Notes:
 123   - Select to install the optional sub-package to add Python to the system PATH environment variable.
 124   - Ensure the pip module is installed (it should be by default)
 125   - Need python3.3 or later to get the Windows py.exe launcher that is used to get python3 rather than python2 if both are installed on Windows
 126   - 32 bit python works
 127 - [Git](http://git-scm.com/download/win).
 128   - Note: If you use Cygwin, you can normally use Cygwin's "git.exe".  However, in order to use the "update\_external\_sources.bat" script, you must have this version.
 129   - Tell the installer to allow it to be used for "Developer Prompt" as well as "Git Bash".
 130   - Tell the installer to treat line endings "as is" (i.e. both DOS and Unix-style line endings).
 131   - Install each a 32-bit and a 64-bit version, as the 64-bit installer does not install the 32-bit libraries and tools.
 132 - glslang is required for demos and tests.
 133   - [You can download and configure it (in a peer directory) here](https://github.com/KhronosGroup/glslang/blob/master/README.md)
 134   - A windows batch file has been included that will pull and build the correct version.  Run it from Developer Command Prompt for VS2013 like so:
 135     - update\_external\_sources.bat --build-glslang (Note: see **Loader and Validation Layer Dependencies** below for other options)
 136
 137 ## Windows Build - MSVC
 138
 139 Before building on Windows, you may want to modify the customize section in loader/loader.rc to so as to
 140 set the version numbers and build description for your build. Doing so will set the information displayed
 141 for the Properites->Details tab of the loader vulkan-1.dll file that is built.
 142
 143 Build all Windows targets after installing required software and cloning the Loader and Validation Layer repo as described above by completing the following steps in a "Developer Command Prompt for VS2013" window (Note that the update\_external\_sources script used below builds external tools into predefined locations. See **Loader and Validation Layer Dependencies** for more information and other options):
 144 ```
 145 cd Vulkan-LoaderAndValidationLayers  # cd to the root of the cloned git repository
 146 update_external_sources.bat --all
 147 build_windows_targets.bat
 148 ```
 149
 150 At this point, you can use Windows Explorer to launch Visual Studio by double-clicking on the "VULKAN.sln" file in the \build folder.  Once Visual Studio comes up, you can select "Debug" or "Release" from a drop-down list.  You can start a build with either the menu (Build->Build Solution), or a keyboard shortcut (Ctrl+Shift+B).  As part of the build process, Python scripts will create additional Visual Studio files and projects, along with additional source files.  All of these auto-generated files are under the "build" folder.
 151
 152 Vulkan programs must be able to find and use the vulkan-1.dll library. Make sure it is either installed in the C:\Windows\System32 folder, or the PATH environment variable includes the folder that it is located in.
 153
 154 To run Vulkan programs you must tell the icd loader where to find the libraries.
 155 This is described in a `LoaderAndLayerInterface` document in the `loader` folder in this repository.
 156 This specification describes both how ICDs and layers should be properly
 157 packaged, and how developers can point to ICDs and layers within their builds.
 158
 159 ## Android Build
 160 Install the required tools for Linux and Windows covered above, then add the
 161 following.
 162 ### Android Studio
 163 - Install [Android Studio 2.1](http://tools.android.com/download/studio/canary), latest Preview (tested with 4):
 164 - From the "Welcome to Android Studio" splash screen, add the following components using Configure > SDK Manager:
 165   - SDK Platforms > Android N Preview
 166   - SDK Tools > Android NDK
 167
 168 #### Add NDK to path
 169
 170 On Linux:
 171 ```
 172 export PATH=$HOME/Android/sdk/ndk-bundle:$PATH
 173 ```
 174 On Windows:
 175 ```
 176 set PATH=%LOCALAPPDATA%\Android\sdk\ndk-bundle;%PATH%
 177 ```
 178 On OSX:
 179 ```
 180 export PATH=$HOME/Library/Android/sdk/ndk-bundle:$PATH
 181 ```
 182 ### Additional OSX System Requirements
 183 Tested on OSX version 10.11.4
 184
 185  Setup Homebrew and components
 186 - Follow instructions on [brew.sh](http://brew.sh) to get homebrew installed.
 187 ```
 188 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
 189 ```
 190 - Ensure Homebrew is at the beginning of your PATH:
 191 ```
 192 export PATH=/usr/local/bin:$PATH
 193 ```
 194 - Add packages with the following (may need refinement)
 195 ```
 196 brew install cmake python python3 git
 197 ```
 198 ### Build steps for Android
 199 Use the following to ensure the Android build works.
 200 #### Linux and OSX
 201 Follow the setup steps for Linux or OSX above, then from your terminal:
 202 ```
 203 cd build-android
 204 ./update_external_sources_android.sh
 205 ./android-generate.sh
 206 ndk-build -j $(sysctl -n hw.ncpu)
 207 ```
 208 #### Windows
 209 Follow the setup steps for Windows above, then from Developer Command Prompt for VS2013:
 210 ```
 211 cd build-android
 212 update_external_sources_android.bat
 213 android-generate.bat
 214 ndk-build
 215 ```
 216 #### Android demos
 217 Use the following steps to build, install, and run Cube and Tri for Android:
 218 ```
 219 cd demos/android
 220 android update project -s -p . -t "android-23"
 221 ndk-build
 222 ant -buildfile cube debug
 223 adb install ./cube/bin/NativeActivity-debug.apk
 224 adb shell am start com.example.Cube/android.app.NativeActivity
 225 ```
 226 To build, install, and run Cube with validation layers, first build layers using steps above, then run:
 227 ```
 228 cd demos/android
 229 android update project -s -p . -t "android-23"
 230 ndk-build -j
 231 ant -buildfile cube-with-layers debug
 232 adb install ./cube-with-layers/bin/NativeActivity-debug.apk
 233 adb shell am start -a android.intent.action.MAIN -c android-intent.category.LAUNCH -n com.example.CubeWithLayers/android.app.NativeActivity --es args "--validate"
 234 ```
 235
 236 To build, install, and run the Smoke demo for Android, run the following, and any
 237 prompts that come back from the script:
 238 ```
 239 ./update_external_sources.sh --glslang
 240 cd demos/smoke/android
 241 export ANDROID_SDK_HOME=<path to Android/Sdk>
 242 export ANDROID_NDK_HOME=<path to Android/Sdk/ndk-bundle>
 243 ./build-and-install
 244 adb shell am start com.example.Smoke/android.app.NativeActivity
 245 ```
 246
 247 ## Ninja Builds - All Platforms
 248 The [Qt Creator IDE](https://qt.io/download-open-source/#section-2) can open a root CMakeList.txt as a project directly, and it provides tools within Creator to configure and generate Vulkan SDK build files for one to many targets concurrently, resolving configuration issues as needed. Alternatively, when invoking CMake use the -G Codeblocks Ninja option to generate Ninja build files to be used as project files for QtCreator
 249
 250 - Follow the steps defined elsewhere for the OS using the update\_external\_sources script or as shown in **Loader and Validation Layer Dependencies** below
 251 - Open, configure, and build the gslang and spirv-tools CMakeList.txt files
 252 - Then do the same with the Vulkan-LoaderAndValidationLayers CMakeList.txt file.
 253 - In order to debug with QtCreator, a [Microsoft WDK: eg WDK 10](http://go.microsoft.com/fwlink/p/?LinkId=526733) is required. Note that installing the WDK breaks the MSVC vcvarsall.bat build scripts provided by MSVC, requiring that the LIB, INCLUDE, and PATH env variables be set to the WDK paths by some other means
 254
 255 ## Loader and Validation Layer Dependencies
 256 gslang and SPIRV-Tools repos are required to build and run Loader and Validation Layer components. They are not git sub-modules of Vulkan-LoaderAndValidationLayers but Vulkan-LoaderAndValidationLayers is linked to specific revisions of gslang and spirv-tools. These can be automatically cloned and built to predefined locations with the update\_external\_sources scripts. If a custom configuration is required, do the following steps:
 257
 258 1) clone the repos:
 259
 260     git clone https://github.com/KhronosGroup/glslang.git
 261     git clone https://github.com/KhronosGroup/SPIRV-Tools.git
 262
 263
 264 2) checkout the correct version of each tree based on the contents of the glslang\_revision and spirv-tools\_revision files at the root of the Vulkan-LoaderAndValidationLayers tree (do the same anytime that Vulkan-LoaderAndValidationLayers is updated from remote)
 265
 266 _on windows_
 267
 268     git checkout < [path to Vulkan-LoaderAndValidationLayers]\glslang_revision [in glslang repo]
 269         git checkout < [path to Vulkan-LoaderAndValidationLayers]\spirv-tools_revision[in spriv-tools repo]
 270
 271 *non windows*
 272
 273     git checkout `cat [path to Vulkan-LoaderAndValidationLayers]\glslang_revision` [in glslang repo]
 274         git checkout `cat [path to Vulkan-LoaderAndValidationLayers]\spirv-tools_revision` [in spriv-tools repo]
 275
 276 3) Configure the gslang and spirv-tools source trees with cmake and build them with your IDE of choice
 277
 278 4) Enable the CUSTOM\_GSLANG\_BIN\_PATH and CUSTOM\_SPIRV\_TOOLS\_BIN\_PATH options in the Vulkan-LoaderAndValidationLayers cmake configuration and point the GSLANG\_BINARY\_PATH and SPIRV\_TOOLS\_BINARY\_PATH variables to the correct location
 279
 280 5) If building on Windows with MSVC, set DISABLE\_BUILDTGT\_DIR\_DECORATION to _On_. If building on Windows, but without MSVC set DISABLE\_BUILD\_PATH\_DECORATION to _On_
 281
 282 ## Optional software packages:
 283
 284 - [Cygwin for windows](https://www.cygwin.com/).  Notes:
 285   - Cygwin provides some Linux-like tools, which are valuable for obtaining the source code, and running CMake.
 286     Especially valuable are the BASH shell and git packages.
 287   - If you don't want to use Cygwin, there are other shells and environments that can be used.
 288     You can also use a Git package that doesn't come from Cygwin.
 289
 290 - [Ninja on all platforms](https://github.com/ninja-build/ninja/releases). [The Ninja-build project](ninja-build.org). [Ninja Users Manual](ninja-build.org/manual.html)
 291
 292 - [QtCreator as IDE for CMake builds on all platforms](https://qt.io/download-open-source/#section-2)