Docs: Fix a typo in BUILD.md
[platform/upstream/Vulkan-Tools.git] / 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 ## Contributing
9
10 If you intend to contribute, the preferred work flow is for you to develop your contribution
11 in a fork of this repo in your GitHub account and then submit a pull request.
12 Please see the [CONTRIBUTING](CONTRIBUTING.md) file in this repository for more details.
13
14 ## Git the Bits
15
16 To create your local git repository:
17 ```
18 git clone https://github.com/KhronosGroup/Vulkan-LoaderAndValidationLayers
19 ```
20
21 ## Linux Build
22
23 The build process uses CMake to generate makefiles for this project.
24 The build generates the loader, layers, and tests.
25
26 This repo has been built and tested on the two most recent Ubuntu LTS versions.
27 It should be straightforward to use it on other Linux distros.
28
29 These packages are needed to build this repository:
30 ```
31 sudo apt-get install git cmake build-essential bison libx11-xcb-dev libxkbcommon-dev libmirclient-dev libwayland-dev libxrandr-dev
32 ```
33
34 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):
35 ```
36 cd Vulkan-LoaderAndValidationLayers  # cd to the root of the cloned git repository
37 ./update_external_sources.sh
38 cmake -H. -Bdbuild -DCMAKE_BUILD_TYPE=Debug
39 cd dbuild
40 make
41 ```
42
43 If you have installed a Vulkan driver obtained from your graphics hardware vendor, the install process should
44 have configured the driver so that the Vulkan loader can find and load it.
45
46 If you want to use the loader and layers that you have just built:
47 ```
48 export LD_LIBRARY_PATH=<path to your repository root>/dbuild/loader
49 export VK_LAYER_PATH=<path to your repository root>/dbuild/layers
50 ```
51 You can run the `vulkaninfo` application to see which driver, loader and layers are being used.
52
53 The `LoaderAndLayerInterface` document in the `loader` folder in this repository is a specification that
54 describes both how ICDs and layers should be properly
55 packaged, and how developers can point to ICDs and layers within their builds.
56
57 ### WSI Support Build Options
58 By default, the Vulkan Loader and Validation Layers are built with support for all 4 Vulkan-defined WSI display systems, Xcb, Xlib, Wayland, and Mir.  It is recommended to build these modules with support for these
59 display systems to maximize their usability across Linux platforms.
60 If it is necessary to build these modules without support for one of the display systems, the appropriate CMake option of the form BUILD_WSI_xxx_SUPPORT can be set to OFF.   See the top-level CMakeLists.txt file for more info.
61
62 ### Linux Install to System Directories
63
64 Installing the files resulting from your build to the systems directories is optional since
65 environment variables can usually be used instead to locate the binaries.
66 There are also risks with interfering with binaries installed by packages.
67 If you are certain that you would like to install your binaries to system directories,
68 you can proceed with these instructions.
69
70 Assuming that you've built the code as described above and the current directory is still `dbuild`,
71 you can execute:
72
73 ```
74 sudo make install
75 ```
76
77 This command installs files to:
78
79 * `/usr/local/include/vulkan`:  Vulkan include files
80 * `/usr/local/lib`:  Vulkan loader and layers shared objects
81 * `/usr/local/bin`:  vulkaninfo application
82 * `/usr/local/etc/vulkan/explicit_layer.d`:  Layer JSON files
83
84 You may need to run `ldconfig` in order to refresh the system loader search cache on some Linux systems.
85
86 The list of installed files appears in the build directory in a file named `install_manifest.txt`.
87 You can easily remove the installed files with:
88
89 ```
90 cat install_manifest.txt | sudo xargs rm
91 ```
92
93 You can further customize the installation location by setting additional CMake variables
94 to override their defaults.
95 For example, if you would like to install to `/tmp/build` instead of `/usr/local`, specify:
96
97 ```
98 -DCMAKE_INSTALL_PREFIX=/tmp/build
99 -DDEST_DIR=/tmp/build
100 ```
101
102 on your CMake command line and run `make install` as before.
103 The install step places the files in `/tmp/build`.
104
105 Using the `CMAKE_INSTALL_PREFIX` to customize the install location also modifies the
106 loader search paths to include searching for layers in the specified install location.
107 In this example, setting `CMAKE_INSTALL_PREFIX` to `/tmp/build` causes the loader to
108 search `/tmp/build/etc/vulkan/explicit_layer.d` and `/tmp/build/share/vulkan/explicit_layer.d`
109 for the layer JSON files.
110 The loader also searches the "standard" system locations of `/etc/vulkan/explicit_layer.d`
111 and `/usr/share/vulkan/explicit_layer.d` after searching the two locations under `/tmp/build`.
112
113 You can further customize the installation directories by using the CMake variables
114 `CMAKE_INSTALL_SYSCONFDIR` to rename the `etc` directory and `CMAKE_INSTALL_DATADIR`
115 to rename the `share` directory.
116
117 See the CMake documentation for more details on using these variables
118 to further customize your installation.
119
120 Also see the `LoaderAndLayerInterface` document in the `loader` folder in this repository for more
121 information about loader operation.
122
123 Note that some executables in this repository (e.g., `cube`) use the "rpath" linker directive
124 to load the Vulkan loader from the build directory, `dbuild` in this example.
125 This means that even after installing the loader to the system directories, these executables
126 still use the loader from the build directory.
127
128 ### Linux 32-bit support
129
130 Usage of this repository's contents in 32-bit Linux environments is not officially supported.
131 However, since this repository is supported on 32-bit Windows, these modules should generally
132 work on 32-bit Linux.
133
134 Here are some notes for building 32-bit targets on a 64-bit Ubuntu "reference" platform:
135
136 If not already installed, install the following 32-bit development libraries:
137
138 `gcc-multilib g++-multilib libx11-dev:i386`
139
140 This list may vary depending on your distro and which windowing systems you are building for.
141
142 Set up your environment for building 32-bit targets:
143
144 ```
145 export CFLAGS=-m32
146 export CXXFLAGS=-m32
147 export PKG_CONFIG_LIBDIR=/usr/lib/i386-linux-gnu
148 ```
149
150 Again, your PKG_CONFIG configuration may be different, depending on your distro.
151
152 If the libraries in the `external` directory have already been built
153 for 64-bit targets,
154 delete or "clean" this directory and rebuild it with
155 the above settings using the `update_external_sources` shell script.
156 This is required because the libraries in `external` must be built for
157 32-bit in order to be usable by the rest of the components in the repository.
158
159 Finally, rebuild the repository using `cmake` and `make`, as explained above.
160
161 ## Validation Test
162
163 The test executables can be found in the dbuild/tests directory.
164 Some of the tests that are available:
165 - vk\_layer\_validation\_tests: Test Vulkan layers.
166
167 There are also a few shell and Python scripts that run test collections (eg,
168 `run_all_tests.sh`).
169
170 ## Linux Demos
171
172 Some demos that can be found in the dbuild/demos directory are:
173 - vulkaninfo: report GPU properties
174 - cube: a textured spinning cube
175 - smoke/smoke: A "smoke" test using a more complex Vulkan demo
176
177 You can select which WSI subsystem is used to build the demos using a cmake option called DEMOS_WSI_SELECTION.
178 Supported options are XCB (default), XLIB, WAYLAND, and MIR.  Note that you must build using the corresponding BUILD_WSI_*_SUPPORT enabled at the base repo level (all SUPPORT options are ON by default).
179 For instance, creating a build that will use Xlib to build the demos, your cmake command line might look like:
180
181 cmake -H. -Bbuild -DCMAKE_BUILD_TYPE=Debug -DDEMOS_WSI_SELECTION=XLIB
182
183 ## Windows System Requirements
184
185 Windows 7+ with additional required software packages:
186
187 - Microsoft Visual Studio 2013 Professional.  Note: it is possible that lesser/older versions may work, but that has not been tested.
188 - [CMake](http://www.cmake.org/download/).  Notes:
189   - Tell the installer to "Add CMake to the system PATH" environment variable.
190 - [Python 3](https://www.python.org/downloads).  Notes:
191   - Select to install the optional sub-package to add Python to the system PATH environment variable.
192   - Ensure the pip module is installed (it should be by default)
193   - 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
194   - 32 bit python works
195 - [Git](http://git-scm.com/download/win).
196   - 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.
197   - Tell the installer to allow it to be used for "Developer Prompt" as well as "Git Bash".
198   - Tell the installer to treat line endings "as is" (i.e. both DOS and Unix-style line endings).
199   - Install each a 32-bit and a 64-bit version, as the 64-bit installer does not install the 32-bit libraries and tools.
200 - glslang is required for demos and tests.
201   - [You can download and configure it (in a peer directory) here](https://github.com/KhronosGroup/glslang/blob/master/README.md)
202   - 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:
203     - update\_external\_sources.bat --build-glslang (Note: see **Loader and Validation Layer Dependencies** below for other options)
204
205 ## Windows Build - MSVC
206
207 Before building on Windows, you may want to modify the customize section in loader/loader.rc to so as to
208 set the version numbers and build description for your build. Doing so will set the information displayed
209 for the Properties->Details tab of the loader vulkan-1.dll file that is built.
210
211 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):
212 ```
213 cd Vulkan-LoaderAndValidationLayers  # cd to the root of the cloned git repository
214 update_external_sources.bat --all
215 build_windows_targets.bat
216 ```
217
218 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.
219
220 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.
221
222 To run Vulkan programs you must tell the icd loader where to find the libraries.
223 This is described in a `LoaderAndLayerInterface` document in the `loader` folder in this repository.
224 This specification describes both how ICDs and layers should be properly
225 packaged, and how developers can point to ICDs and layers within their builds.
226
227 ## Android Build
228 Install the required tools for Linux and Windows covered above, then add the
229 following.
230 ### Android Studio
231 - Install [Android Studio 2.1](http://tools.android.com/download/studio/canary), latest Preview (tested with 4):
232 - From the "Welcome to Android Studio" splash screen, add the following components using Configure > SDK Manager:
233   - SDK Platforms > Android N Preview
234   - SDK Tools > Android NDK
235
236 #### Add NDK to path
237
238 On Linux:
239 ```
240 export PATH=$HOME/Android/sdk/ndk-bundle:$PATH
241 ```
242 On Windows:
243 ```
244 set PATH=%LOCALAPPDATA%\Android\sdk\ndk-bundle;%PATH%
245 ```
246 On OSX:
247 ```
248 export PATH=$HOME/Library/Android/sdk/ndk-bundle:$PATH
249 ```
250 ### Additional OSX System Requirements
251 Tested on OSX version 10.11.4
252
253  Setup Homebrew and components
254 - Follow instructions on [brew.sh](http://brew.sh) to get homebrew installed.
255 ```
256 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
257 ```
258 - Ensure Homebrew is at the beginning of your PATH:
259 ```
260 export PATH=/usr/local/bin:$PATH
261 ```
262 - Add packages with the following (may need refinement)
263 ```
264 brew install cmake python python3 git
265 ```
266 ### Build steps for Android
267 Use the following to ensure the Android build works.
268 #### Linux and OSX
269 Follow the setup steps for Linux or OSX above, then from your terminal:
270 ```
271 cd build-android
272 ./update_external_sources_android.sh
273 ./android-generate.sh
274 ndk-build -j $(sysctl -n hw.ncpu)
275 ```
276 #### Windows
277 Follow the setup steps for Windows above, then from Developer Command Prompt for VS2013:
278 ```
279 cd build-android
280 update_external_sources_android.bat
281 android-generate.bat
282 ndk-build
283 ```
284 #### Android demos
285 Use the following steps to build, install, and run Cube and Tri for Android:
286 ```
287 cd demos/android
288 android update project -s -p . -t "android-23"
289 ndk-build
290 ant -buildfile cube debug
291 adb install ./cube/bin/NativeActivity-debug.apk
292 adb shell am start com.example.Cube/android.app.NativeActivity
293 ```
294 To build, install, and run Cube with validation layers, first build layers using steps above, then run:
295 ```
296 cd demos/android
297 android update project -s -p . -t "android-23"
298 ndk-build -j
299 ant -buildfile cube-with-layers debug
300 adb install ./cube-with-layers/bin/NativeActivity-debug.apk
301 adb shell am start -a android.intent.action.MAIN -c android-intent.category.LAUNCH -n com.example.CubeWithLayers/android.app.NativeActivity --es args "--validate"
302 ```
303
304 To build, install, and run the Smoke demo for Android, run the following, and any
305 prompts that come back from the script:
306 ```
307 ./update_external_sources.sh --glslang
308 cd demos/smoke/android
309 export ANDROID_SDK_HOME=<path to Android/Sdk>
310 export ANDROID_NDK_HOME=<path to Android/Sdk/ndk-bundle>
311 ./build-and-install
312 adb shell am start -a android.intent.action.MAIN -c android-intent.category.LAUNCH -n com.example.Smoke/android.app.NativeActivity --es args "--validate"
313 ```
314
315 ## Ninja Builds - All Platforms
316 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
317
318 - Follow the steps defined elsewhere for the OS using the update\_external\_sources script or as shown in **Loader and Validation Layer Dependencies** below
319 - Open, configure, and build the gslang and spirv-tools CMakeList.txt files
320 - Then do the same with the Vulkan-LoaderAndValidationLayers CMakeList.txt file.
321 - 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
322
323 ## Loader and Validation Layer Dependencies
324 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:
325
326 1) clone the repos:
327
328     git clone https://github.com/KhronosGroup/glslang.git
329     git clone https://github.com/KhronosGroup/SPIRV-Tools.git
330
331
332 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)
333
334 _on windows_
335
336     git checkout < [path to Vulkan-LoaderAndValidationLayers]\glslang_revision [in glslang repo]
337         git checkout < [path to Vulkan-LoaderAndValidationLayers]\spirv-tools_revision[in spriv-tools repo]
338
339 *non windows*
340
341     git checkout `cat [path to Vulkan-LoaderAndValidationLayers]\glslang_revision` [in glslang repo]
342         git checkout `cat [path to Vulkan-LoaderAndValidationLayers]\spirv-tools_revision` [in spriv-tools repo]
343
344 3) Configure the gslang and spirv-tools source trees with cmake and build them with your IDE of choice
345
346 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
347
348 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_
349
350 ## Optional software packages:
351
352 - [Cygwin for windows](https://www.cygwin.com/).  Notes:
353   - Cygwin provides some Linux-like tools, which are valuable for obtaining the source code, and running CMake.
354     Especially valuable are the BASH shell and git packages.
355   - If you don't want to use Cygwin, there are other shells and environments that can be used.
356     You can also use a Git package that doesn't come from Cygwin.
357
358 - [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) 
359
360 - [QtCreator as IDE for CMake builds on all platforms](https://qt.io/download-open-source/#section-2)