• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1Vulkan CTS README
2=================
3
4This document describes how to build and run Vulkan Conformance Test suite.
5
6Vulkan CTS is built on the dEQP framework.
7Up-to-date documentation for dEQP is available at:
8
9* [The VK-GL-CTS wiki for Khronos members](https://gitlab.khronos.org/Tracker/vk-gl-cts/wikis/home)
10* [The VK-GL-CTS wiki for non-Khronos members](https://github.com/KhronosGroup/VK-GL-CTS/wiki)
11
12
13Requirements
14------------
15
16### Common
17
18The following tools must be installed and present in the PATH variable:
19
20 * Git (for checking out sources)
21 * Python 3.x (for the build related scripts, some other scripts still use Python 2.7.x)
22 * CMake 3.10.2 or newer
23
24### Win32
25
26 * Visual Studio 2015 or newer (glslang uses several C++11 features)
27
28### Linux
29
30 * Standard toolchain (make, gcc/clang)
31 * If you have X11 installed, then the build assumes you also have the `GL/glx.h` header
32   file.
33    * You can get this from the `mesa-common-dev` Ubuntu package.
34
35### MacOS
36
37 * Xcode
38
39Vulkan SDK for macOS includes a MoltenVK runtime library which is recommended method for
40developing a Vulkan application.
41
42### Android
43
44 * Android NDK r17c or later.
45 * Android SDK with: SDK Tools, SDK Platform-tools, SDK Build-tools, and API 28
46 * Java Development Kit (JDK)
47 * Windows: either NMake or Ninja in PATH
48
49If you have downloaded the Android SDK command line tools package (25.2.3 or higher) then
50you can install the necessary components by running:
51
52	tools/bin/sdkmanager tools platform-tools 'build-tools;25.0.2' 'platforms;android-28'
53
54
55Building CTS
56------------
57
58To build dEQP, you need first to download sources for zlib, libpng, jsoncpp, glslang,
59vulkan-docs, spirv-headers, and spirv-tools.
60
61To download sources, run:
62
63	python3 external/fetch_sources.py
64
65You may need to re-run `fetch_sources.py` to update to the latest glslang,
66vulkan-docs and spirv-tools revisions occasionally.
67
68You also need to install lxml python module by running:
69
70	python3 -m pip install lxml
71
72With CMake out-of-source builds are always recommended. Create a build directory
73of your choosing, and in that directory generate Makefiles or IDE project
74using cmake.
75
76
77### Windows x86-32
78
79	cmake <path to vulkancts> -G"Visual Studio 14"
80	start dEQP-Core-default.sln
81
82### Windows x86-64
83
84	cmake <path to vulkancts> -G"Visual Studio 14 Win64"
85	start dEQP-Core-default.sln
86
87### Linux 32-bit Debug
88
89	cmake <path to vulkancts> -DCMAKE_BUILD_TYPE=Debug -DCMAKE_C_FLAGS=-m32 -DCMAKE_CXX_FLAGS=-m32
90	make -j
91
92Release build can be done by using -DCMAKE_BUILD_TYPE=Release
93
94If building for 32-bit x86 with GCC, you probably also want to add `-msse2
95-mfpmath=sse` to ensure that you get correct IEEE floating-point behavior.
96
97### Linux 64-bit Debug
98
99	cmake <path to vulkancts> -DCMAKE_BUILD_TYPE=Debug -DCMAKE_C_FLAGS=-m64 -DCMAKE_CXX_FLAGS=-m64
100	make -j
101
102
103### MacOS 64-bit Debug
104
105	cmake <path to vulkancts> -DCMAKE_BUILD_TYPE=Debug -DDEQP_TARGET=osx -DCMAKE_C_FLAGS=-m64 -DCMAKE_CXX_FLAGS=-m64
106	make -j
107
108### Android
109
110Following command will build dEQP.apk:
111
112	python3 scripts/android/build_apk.py --sdk <path to Android SDK> --ndk <path to Android NDK>
113
114By default the CTS package will be built for the Android API level 28.
115Another API level may be supplied using --native-api command line option.
116
117The package can be installed by either running:
118
119	python3 scripts/android/install_apk.py
120
121By default the CTS package will contain libdeqp.so built for armeabi-v7a, arm64-v8a,
122x86, and x86_64 ABIs, but that can be changed at build time by passing the --abis command line
123option to `scripts/android/build_apk.py`.
124
125To pick which ABI to use at _install time_, use the following command instead:
126
127	adb install -g --abi <ABI name> <build-root>/package/dEQP.apk
128
129
130Building Mustpass
131-----------------
132
133Current Vulkan mustpass is checked into repository and can be found at:
134
135	external/vulkancts/mustpass/main/vk-default.txt
136
137Current Vulkan SC mustpass can be found at:
138
139	external/vulkancts/mustpass/master/vksc-default.txt
140
141This file contains list of files located in vk-default or vksc-default subdirectory. Those files contain
142tests from bigest test groups and together they contain all test cases that should pass.
143
144Vulkan CTS mustpass can be re-generated by running:
145
146	python3 <vulkancts>/external/vulkancts/scripts/build_mustpass.py
147
148
149Running CTS
150-----------
151
152Following command line options MUST be used when running CTS:
153
154	--deqp-caselist-file=<vulkancts>/external/vulkancts/mustpass/main/vk-default.txt (or vksc-default.txt for Vulkan SC implementations)
155	--deqp-log-images=disable
156	--deqp-log-shader-sources=disable
157
158If an implementation ships with [implicit layers](https://github.com/KhronosGroup/Vulkan-Loader/blob/master/loader/LoaderAndLayerInterface.md#implicit-vs-explicit-layers) enabled, then such layers must be enabled
159when running CTS.
160
161In addition, on multi-device systems the device for which conformance is claimed
162can be selected with:
163
164	--deqp-vk-device-id=<value>
165
166To speed up the conformance run on some platforms the following command line
167option may be used to disable frequent fflush() calls to the output logs:
168
169	--deqp-log-flush=disable
170
171By default, the test log will be written into the path "TestResults.qpa". If the
172platform requires a different path, it can be specified with:
173
174	--deqp-log-filename=<path>
175
176By default, the CTS will expect to find its test resource files in the current
177working directory. This can be overridden with:
178
179	--deqp-archive-dir=<path>
180
181By default, the shader cache will be written into the path "shadercache.bin". If the
182platform requires a different path, it can be specified with:
183
184	--deqp-shadercache-filename=<path>
185
186If the shader cache is not desired, it can be disabled with:
187
188	--deqp-shadercache=disable
189
190CTS execution may be split into N fractions ( for the purpose of running it in parallel ) using
191
192	--deqp-fraction=I,N
193
194where I denotes index of current CTS execution ( I=[0..N-1], N=[1..8] )
195
196When collecting results for a Conformance Submission Package the number of fractions must not exceed 8,
197and a list of mandatory information tests for each fraction must be supplied:
198
199	--deqp-fraction-mandatory-caselist-file=<vulkancts>external/vulkancts/mustpass/main/vk-fraction-mandatory-tests.txt
200
201To specify file containing waived tests that are omitted only by specified vendor and renderer/device
202the following command line option may be used:
203
204	--deqp-waiver-file=<path>
205
206To make log more clear for high level shader source analysis
207output of decompiled SPIR-V shader sources can be disabled:
208
209	--deqp-log-decompiled-spirv=disable
210
211Also non-informative empty LogInfo sections can be removed
212from output into log by specifying:
213
214	--deqp-log-empty-loginfo=disable
215
216There are several additional options used only in conjunction with Vulkan SC tests
217( for Vulkan SC CTS tests deqp-vksc application should be used ).
218
219To define minimum size of the command pool use parameter:
220
221	--deqp-command-pool-min-size=<value>
222
223To define minimum size of a single command buffer use parameter:
224
225	--deqp-command-buffer-min-size=<value>
226
227If minimum size will not be defined, then the size of single command buffer will be estimated
228from number of commands multiplied by value of parameter deqp-command-default-size.
229Default size of a single command may be defined using:
230
231	--deqp-command-default-size=<value>
232
233Another group of Vulkan SC options enable use of offline pipeline compiler:
234
235	--deqp-pipeline-compiler=<value>
236	--deqp-pipeline-dir=<value>
237	--deqp-pipeline-args=<value>
238	--deqp-pipeline-file=<value>
239	--deqp-pipeline-logfile=<value>
240	--deqp-pipeline-prefix=<value>
241
242In case of offline pipeline compilers the size of the pipeline will be returned by
243pipeline compiler. If we use internal pipeline compilation then pipeline size will be
244equal to default size. This size may be modified using:
245
246	--deqp-pipeline-default-size=<value>
247
248Vulkan SC may be implemented on embedded platform that is not able to
249read from/write to files, write logs, etc. In this case you may use
250external server that will perform these tasks on another machine:
251
252	--deqp-server-address=<value>
253
254In Vulkan SC CTS tests are performed twice. You may define how many tests
255are performed on separate process in a single batch:
256
257	--deqp-subprocess-test-count=<value>
258
259Above mentioned parameter works as default value for all tests.
260You may also define how many tests are performed on a separate process
261for specific test tree branch using parameter:
262
263	--deqp-subprocess-cfg-file=<path>
264
265File should contain test pattern followed by numeric value, for example:
266dEQP-VKSC.api.copy_and_blit.core.image_to_image.dimensions.src32768x4_dst32768x4.*, 5
267dEQP-VKSC.texture.explicit_lod.2d.sizes.*, 20
268dEQP-VKSC.texture.explicit_lod.2d.sizes.128x128_*, 4
269
270There is also one option used by CTS internally and should not be used manually.
271It informs deqp-vksc application that it works as subprocess:
272
273	--deqp-subprocess=[enable|disable]
274
275No other command line options are allowed.
276
277### Win32
278
279	Vulkan:
280
281	cd <builddir>/external/vulkancts/modules/vulkan
282	Debug\deqp-vk.exe --deqp-caselist-file=...
283
284	Vulkan SC:
285
286	cd <builddir>/external/vulkancts/modules/vulkan
287	Debug\deqp-vksc.exe --deqp-caselist-file=...
288
289Test log will be written into TestResults.qpa
290
291### Linux
292
293	Vulkan:
294
295	cd <builddir>/external/vulkancts/modules/vulkan
296	./deqp-vk --deqp-caselist-file=...
297
298	Vulkan SC:
299
300	cd <builddir>/external/vulkancts/modules/vulkan
301	./deqp-vksc --deqp-caselist-file=...
302
303### MacOS
304
305	cd <builddir>/external/vulkancts/modules/vulkan
306	./deqp-vk --deqp-caselist-file=...
307
308### Android
309
310For Android build using SDK 29 or greater, it is recommended to use `/sdcard/Documents/` instead of `/sdcard/` due to scoped storage.
311
312	adb push <vulkancts>/external/vulkancts/mustpass/main/vk-default.txt /sdcard/vk-default.txt
313	adb shell
314
315In device shell:
316
317	am start -n com.drawelements.deqp/android.app.NativeActivity -e cmdLine "deqp --deqp-caselist-file=/sdcard/vk-default.txt --deqp-log-images=disable --deqp-log-shader-sources=disable --deqp-log-filename=/sdcard/TestResults.qpa"
318
319Test progress will be written to device log and can be displayed with:
320
321	adb logcat -s dEQP
322
323Test log will be written into `/sdcard/TestResults.qpa`.
324
325
326Conformance Submission Package Requirements
327-------------------------------------------
328
329The conformance submission package must contain the following:
330
3311. Full test logs (`TestResults.qpa`) from CTS runs against all driver builds and all fractions
3322. Result of `git status` and `git log` from CTS source directory
3333. Any patches used on top of release tag
3344. Conformance statement
335
336Test logs (1) should be named `<submission pkg dir>/TestResults-<driver build type>-<fraction id>-of-<total fractions>.qpa`,
337for example `TestResults-armeabi-v7a-1-of-8.qpa`. On platforms where multiple different driver
338builds (for example 64-bit and 32-bit) are present, CTS logs must be provided
339for each driver build as part of the submission package. If CTS run was split into multiple
340fractions then result files for all fractions must be provided, each file must
341contain results of the mandatory information tests.
342
343Fractions may be run on different physical devices but each device must represent
344the same Conformant Product.
345
346Test logs generated on a system which exposes more than one physical device
347in a device group can be used for products that expose one or more physical
348devices in their device group.
349
350The CTS build must always be done from clean git repository that doesn't have any
351uncommitted changes. Thus it is necessary to run and capture output of `git
352status` and `git log` (2) in the source directory:
353
354	git status > <submission pkg dir>/git-status.txt
355	git log --first-parent <release tag>^..HEAD > <submission pkg dir>/git-log.txt
356
357Any changes made to CTS must be committed to the local repository, and provided
358as part of the submission package (3). This can be done by running:
359
360	git format-patch -o <submission pkg dir> <release tag>..HEAD
361
362Changes to platform-specific code (mostly under `framework/platform`)
363are allowed. The commit message for each change must include a clear
364description of the change and why it is necessary.
365For Vulkan SC, changes are also permitted to the following:
366- vksc-pipeline-compiler (under `vkscpc/`)
367- vksc-server (under `vkscserver/`)
368- modules/vulkan/sc/vktApplicationParametersTests.cpp (to provide vendor-specific test data)
369
370Bugfixes to the tests are allowed. Before being used for a submission,
371bugfixes must be accepted and merged into the CTS repository.
372`git cherry-pick` is strongly recommended as a method of applying bug fixes.
373
374If command line parameter --deqp-subprocess-cfg-file was used then the file
375pointed by this parameter must also be added to submission package.
376
377Other changes must be accompanied by a waiver (see below).
378
379NOTE: When cherry-picking patches on top of release tag, please use `git cherry-pick -x`
380to include original commit hash in the commit message.
381
382Conformance statement (4) must be included in a file called `STATEMENT-<adopter>`
383and must contain following:
384
385	CONFORM_VERSION:         <git tag of CTS release>
386	PRODUCT:                 <string-value>
387	CPU:                     <string-value>
388	OS:                      <string-value>
389
390Note that product/cpu/os information is also captured in `dEQP-VK.info.*` tests
391if `vk::Platform::describePlatform()` is implemented.
392
393If the submission package covers multiple products, you can list them by appending
394additional `PRODUCT:` lines to the conformance statement. For example:
395
396	CONFORM_VERSION:         vulkan-cts-1.2.6.0
397	PRODUCT:                 Product A
398	PRODUCT:                 Product B
399	...
400
401The actual submission package consists of the above set of files which must
402be bundled into a gzipped tar file.
403
404For Vulkan this must be named `VK<API major><API minor>_<adopter><_info>.tgz`.
405
406For Vulkan SC this must be named `VKSC<API major><API minor>_<adopter><_info>.tgz`.
407
408`<API major>` is the major version of the Vulkan {SC} API specification.
409`<API minor>`is the minor version of the Vulkan {SC} API specification.
410
411`<adopter>` is the name of the Adopting member company, or some recognizable abbreviation.
412The `<_info>` field is optional. It may be used to uniquely identify a submission
413by OS, platform, date, or other criteria when making multiple submissions.
414For example, a company XYZ may make a submission for a Vulkan 1.1 implementation named
415`VK11_XYZ_PRODUCTA_Windows10.tgz`
416
417One way to create a suiteable gzipped tar file is to execute the command:
418
419	tar -cvzf <filename.tgz> -C <submission pkg dir> .
420
421where `<submission pkg dir>` is the directory containing the files from (1)-(4)
422from above. A submission package must contain all of the files listed above,
423and only those files.
424
425As an example submission package could contain:
426
427	STATEMENT-Khronos
428	git-log.txt
429	git-status.txt
430	0001-Remove-Waived-Filtering-Tests.patch
431	0002-Fix-Pipeline-Parameters.patch
432	TestResults-armeabi-v7a.qpa
433	TestResults-arm64-v8a.qpa
434
435
436Waivers
437-------
438
439The process for requesting a waiver is to report the issue by filing a bug
440report in the Gitlab VulkanCTS project (TODO Github?). When creating the
441submission package, include references to the waiver in the commit message of
442the relevant change. Including as much information as possible in your bug
443report (including a unified diff or a merge request of suggested file changes)
444will ensure the issue can be progressed as rapidly as possible. Issues must
445be labeled "Waiver" (TODO!) and identify the version of the CTS and affected
446tests.
447
448Conformance Criteria
449--------------------
450
451Conformance run is considered passing if all tests finish with allowed result
452codes. Test results are contained in the TestResults.qpa log. Each
453test case section contains XML tag Result, for example:
454
455	<Result StatusCode="Pass">Not validated</Result>
456
457The result code is the value of the StatusCode attribute. Following status
458codes are allowed:
459
460	Pass
461	NotSupported
462	QualityWarning
463	CompatibilityWarning
464	Waiver
465
466Submission package can be verified using `verify_submission.py`
467script located in [VK-GL-CTS-Tools](https://github.com/KhronosGroup/VK-GL-CTS-Tools).
468
469Vulkan platform port
470--------------------
471
472Vulkan support from Platform implementation requires providing
473`getVulkanPlatform()` method in `tcu::Platform` class implementation.
474
475See `framework/common/tcuPlatform.hpp` and examples in
476`framework/platform/win32/tcuWin32Platform.cpp` and
477`framework/platform/android/tcuAndroidPlatform.cpp`.
478
479If any WSI extensions are supported, platform port must also implement
480methods for creating native display (`vk::Platform::createWsiDisplay`)
481and window handles (`vk::wsi::Display::createWindow`). Otherwise tests
482under `dEQP-VK.wsi` will fail.
483
484
485Null (dummy) driver
486-------------------
487
488For testing and development purposes it might be useful to be able to run
489tests on dummy Vulkan implementation. One such implementation is provided in
490vkNullDriver.cpp. To use that, implement `vk::Platform::createLibrary()` with
491`vk::createNullDriver()`.
492
493
494Validation Layers
495-----------------
496
497Vulkan CTS framework includes first-party support for validation layers, that
498can be turned on with `--deqp-validation=enable` command line option.
499
500When validation is turned on, default instance and device will be created with
501validation layers enabled and debug callback is registered to record any
502messages. Debug messages collected during test execution will be included at
503the end of the test case log.
504
505In addition, when the `--deqp-print-validation-errors` command line option is
506used, validation errors are additionally printed to standard error in the
507moment they are generated.
508
509If any validation errors are found, test result will be set to `InternalError`.
510
511By default `VK_DEBUG_REPORT_INFORMATION_BIT_EXT` and `_DEBUG_BIT_EXT` messages
512are excluded from the log, but that can be customized by modifying
513`vk::DebugReportMessage::shouldBeLogged()` in `vkDebugReportUtil.hpp`.
514
515On the Android target, layers can be added to the APK during the build process
516by setting the `--layers-path` command line option to point into the NDK or to
517a locally-built layers tree. The layers are expected to be found under $abi/
518under the layers path.
519
520
521Cherry GUI
522----------
523
524Vulkan test module can be used with Cherry (GUI for test execution and
525analysis). Cherry is available at
526https://android.googlesource.com/platform/external/cherry. Please follow
527instructions in README to get started.
528
529Before first launch, and every time test hierarchy has been modified, test
530case list must be refreshed by running:
531
532	python scripts/build_caselists.py path/to/cherry/data
533
534Cherry must be restarted for the case list update to take effect.
535
536
537Shader Optimizer
538----------------
539
540Vulkan CTS can be optionally run with the shader optimizer enabled. This
541is an experimental feature which can be used to further stress both the
542drivers as well as the optimizer itself. The shader optimizer is disabled
543by default.
544
545The following command line options can be used to configure the shader
546optimizer:
547
548	--deqp-optimization-recipe=<number>
549
550The list of the optimization recipes can be found and customized in the
551`optimizeCompiledBinary()` function in `vkPrograms.cpp`.
552
553As of this writing, there are 2 recipes to choose from:
554
555	0. Disabled (default)
556	1. Optimize for performance
557	2. Optimize for size
558
559The performance and size optimization recipes are defined by the spir-v
560optimizer, and will change from time to time as the optimizer matures.
561
562	--deqp-optimize-spirv=enable
563
564This option is not required to run the optimizer. By default, the shader
565optimizer only optimizes shaders generated from GLSL or HLSL, and leaves
566hand-written SPIR-V shaders alone.
567
568Many of the hand-written SPIR-V tests stress specific features of the
569SPIR-V which might get optimized out. Using this option will enable the
570optimizer on the hand-written SPIR-V as well, which may be useful in
571finding new bugs in drivers or the optimizer itself, but will likely
572invalidate the tests themselves.
573
574
575Shader Cache
576------------
577
578The Vulkan CTS framework contains a shader cache for speeding up the running
579of the CTS. Skipping shader compilation can significantly reduce runtime,
580especially for repeated runs.
581
582Default behavior is to have the shader cache enabled, but truncated at the
583start of the CTS run. This still gives the benefit of skipping shader
584compilation for identical shaders in different tests (which there are many),
585while making sure that the shader cache file does not grow indefinitely.
586
587The shader cache identifies the shaders by hashing the shader source code
588along with various bits of information that may affect the shader compilation
589(such as shader stage, CTS version, possible compilation flags, etc). If a
590cached shader with matching hash is found, a byte-by-byte comparison of the
591shader sources is made to make sure that the correct shader is being
592retrieved from the cache.
593
594The behavior of the shader cache can be modified with the following command
595line options:
596
597	--deqp-shadercache=disable
598
599Disable the shader cache. All shaders will be compiled every time.
600
601	--deqp-shadercache-filename=<filename>
602
603Set the name of the file where the cached shaders will be stored. This
604option may be required for the shader cache to work at all on Android
605targets.
606
607	--deqp-shadercache-truncate=disable
608
609Do not truncate the shader cache file at startup. No shader compilation will
610occur on repeated runs of the CTS.
611
612	--deqp-shadercache-ipc=enable
613
614Enables the use of inter-process communication primitives to allow several
615instances of CTS to share a single cache file. All of the instances must
616use the same shader cache filename.
617
618Note that if one instance should crash while holding the cache file lock,
619the other instances will hang. The lock is only held while reading or
620writing to the cache, so crashes are unlikely.
621
622In case of a crash outside the cache file lock, the named shared memory
623and shared semaphore may be left behind. These will be re-used by CTS on
624subsequent runs, so additional memory leak will not occur. Shader cache
625truncate may not work in this case. On Windows, when all instances of
626CTS have terminated the shared resources get automatically cleaned up.
627
628RenderDoc
629---------
630The RenderDoc (https://renderdoc.org/) graphics debugger may be used to debug
631Vulkan tests.
632
633Following command line option should be used when launching tests from
634RenderDoc UI:
635
636	--deqp-renderdoc=enable
637
638This causes the framework to interface with the debugger and mark each dEQP
639test case as a separate 'frame', just for the purpose of capturing. The frames
640are added using RenderDoc 'In-Application API', instead of swapchain operations.
641
642Third Party Runners
643-------------------
644
645Some CTS tests use third-party runners. By default all tests are executed
646regardless of runner type (`any`). To exclude all tests using any of the
647external runners (`none`) or to only include tests using a certain runner:
648
649	--deqp-runner-type=(any|none|amber)
650
651Vulkan SC Conformance Test suite
652--------------------------------
653
654This project is also able to perform conformance tests for Vulkan SC
655implementations. For this purpose Vulkan CTS framework has been adapted
656to Vulkan SC requirements:
657
658- Vulkan SC CTS contains its own mustpass list
659
660  external/vulkancts/mustpass/master/vksc-default.txt
661
662- Vulkan SC CTS uses its own executable module to perform tests: deqp-vksc
663
664- Each test in deqp-vksc is performed twice.
665  First test run is performed in main process and its purpose is to collect
666  information about used pipelines, number of created Vulkan objects etc.
667  Second test run is done in separate process ( subprocess ) and it performs
668  the real tests.
669
670- Vulkan SC pipelines may be compiled using offline pipeline compiler
671  delivered by implementation vendor. You can use command line parameters
672  to achieve this ( see parameters: --deqp-pipeline-compiler, --deqp-pipeline-dir,
673  --deqp-pipeline-args, --deqp-pipeline-file, --deqp-pipeline-logfile,
674  --deqp-pipeline-prefix )
675
676  Reference offline pipeline compiler was created to showcase how input and output
677  should look like for such application. It uses Vulkan API to create pipeline cache.
678  The name of the executable is vksc-pipeline-compiler.
679
680- Some of the future Vulkan SC implementations may not have a possibility to use
681  filesystem, create pipeline caches or log results to file. For these implementations
682  Vulkan SC CTS contains server application that may handle such requests on external
683  host machine. Define parameter --deqp-server-address in deqp-vksc application
684  to use external server.
685  Server application's name is vksc-server and its parameters are listed below,
686  in Command Line section.
687
688Command Line
689------------
690Full list of parameters for the `deqp-vk` and `deqp-vksc` modules:
691
692OpenGL and OpenCL parameters not affecting Vulkan API were suppressed.
693
694  -h, --help
695    Show this help
696
697  -n, --deqp-case=<value>
698    Test case(s) to run, supports wildcards (e.g. dEQP-GLES2.info.*)
699
700  --deqp-caselist=<value>
701    Case list to run in trie format (e.g. {dEQP-GLES2{info{version,renderer}}})
702
703  --deqp-caselist-file=<value>
704    Read case list (in trie format) from given file
705
706  --deqp-caselist-resource=<value>
707    Read case list (in trie format) from given file located application's assets
708
709  --deqp-stdin-caselist
710    Read case list (in trie format) from stdin
711
712  --deqp-log-filename=<value>
713    Write test results to given file
714    default: 'TestResults.qpa'
715
716  --deqp-runmode=[execute|xml-caselist|txt-caselist|stdout-caselist]
717    Execute tests, or write list of test cases into a file
718    default: 'execute'
719
720  --deqp-caselist-export-file=<value>
721    Set the target file name pattern for caselist export
722    default: '${packageName}-cases.${typeExtension}'
723
724  --deqp-watchdog=[enable|disable]
725    Enable test watchdog
726    default: 'disable'
727
728  --deqp-crashhandler=[enable|disable]
729    Enable crash handling
730    default: 'disable'
731
732  --deqp-base-seed=<value>
733    Base seed for test cases that use randomization
734    default: '0'
735
736  --deqp-test-iteration-count=<value>
737    Iteration count for cases that support variable number of iterations
738    default: '0'
739
740  --deqp-visibility=[windowed|fullscreen|hidden]
741    Default test window visibility
742    default: 'windowed'
743
744  --deqp-surface-width=<value>
745    Use given surface width if possible
746    default: '-1'
747
748  --deqp-surface-height=<value>
749    Use given surface height if possible
750    default: '-1'
751
752  --deqp-surface-type=[window|pixmap|pbuffer|fbo]
753    Use given surface type
754    default: 'window'
755
756  --deqp-screen-rotation=[unspecified|0|90|180|270]
757    Screen rotation for platforms that support it
758    default: '0'
759
760  --deqp-vk-device-id=<value>
761    Vulkan device ID (IDs start from 1)
762    default: '1'
763
764  --deqp-vk-device-group-id=<value>
765    Vulkan device Group ID (IDs start from 1)
766    default: '1'
767
768  --deqp-log-images=[enable|disable]
769    Enable or disable logging of result images
770    default: 'enable'
771
772  --deqp-log-shader-sources=[enable|disable]
773    Enable or disable logging of shader sources
774    default: 'enable'
775
776  --deqp-test-oom=[enable|disable]
777    Run tests that exhaust memory on purpose
778    default: 'enable'
779
780  --deqp-archive-dir=<value>
781    Path to test resource files
782    default: '.'
783
784  --deqp-log-flush=[enable|disable]
785    Enable or disable log file fflush
786    default: 'enable'
787
788  --deqp-validation=[enable|disable]
789    Enable or disable test case validation
790    default: 'disable'
791
792  --deqp-print-validation-errors
793    Print validation errors to standard error
794
795  --deqp-optimization-recipe=<value>
796    Shader optimization recipe (0=disabled, 1=performance, 2=size)
797    default: '0'
798
799  --deqp-optimize-spirv=[enable|disable]
800    Apply optimization to spir-v shaders as well
801    default: 'disable'
802
803  --deqp-shadercache=[enable|disable]
804    Enable or disable shader cache
805    default: 'enable'
806
807  --deqp-shadercache-filename=<value>
808    Write shader cache to given file
809    default: 'shadercache.bin'
810
811  --deqp-shadercache-truncate=[enable|disable]
812    Truncate shader cache before running tests
813    default: 'enable'
814
815  --deqp-renderdoc=[enable|disable]
816    Enable RenderDoc frame markers
817    default: 'disable'
818
819  --deqp-fraction=<value>
820    Run a fraction of the test cases (e.g. N,M means run group%M==N)
821    default: ''
822
823  --deqp-fraction-mandatory-caselist-file=<value>
824    Case list file that must be run for each fraction
825    default: ''
826
827  --deqp-waiver-file=<value>
828    Read waived tests from given file
829    default: ''
830
831  --deqp-runner-type=[any|none|amber]
832    Filter test cases based on runner
833    default: 'any'
834
835  --deqp-terminate-on-fail=[enable|disable]
836    Terminate the run on first failure
837    default: 'disable'
838
839  --deqp-subprocess=[enable|disable]
840    Inform app that it works as subprocess (Vulkan SC only, do not use manually)
841    default: 'disable'
842
843  --deqp-subprocess-test-count=<value>
844    Define default number of tests performed in subprocess (Vulkan SC only)
845    default: '65536'
846
847  --deqp-subprocess-cfg-file=<path>
848	Config file defining number of tests performed in subprocess for specific test branches (Vulkan SC only)
849    default: ''
850
851  --deqp-server-address=<value>
852    Server address (host:port) responsible for shader compilation (Vulkan SC only)
853    default: ''
854
855  --deqp-command-pool-min-size=<value>
856    Define minimum size of the command pool (in bytes) to use (Vulkan SC only)
857	default: '0'
858
859  --deqp-command-buffer-min-size=<value>
860    Define minimum size of the command buffer (in bytes) to use (Vulkan SC only)
861	default: '0'
862
863  --deqp-app-params-input-file=<path>
864    File providing default application parameters (Vulkan SC only)
865    default: ''
866
867    The file should contain lines of input in the following format:
868    type ("instance" or "device"), 32-bit vendorID, 32-bit deviceID, 32-bit parameterKey, 64-bit parameterValue
869
870    `type` specifies whether the values will be used for instance or device creation.
871    All the other values should be encoded in hex. For example:
872    instance, 0x01234567, 0x76543210, 0x01234567, 0x0000000076543210
873
874  --deqp-command-default-size=<value>
875    Define default single command size (in bytes) to use (Vulkan SC only)
876	default: '256'
877
878  --deqp-pipeline-default-size=<value>
879    Define default pipeline size (in bytes) to use (Vulkan SC only)
880	default: '16384'
881
882  --deqp-pipeline-compiler=<value>
883    Path to offline pipeline compiler (Vulkan SC only)
884    default: ''
885
886  --deqp-pipeline-dir=<value>
887    Offline pipeline data directory (Vulkan SC only)
888    default: ''
889
890  --deqp-pipeline-args=<value>
891    Additional compiler parameters (Vulkan SC only)
892    default: ''
893
894  --deqp-pipeline-file=<value>
895    Output file with pipeline cache (Vulkan SC only, do not use manually)
896    default: ''
897
898  --deqp-pipeline-logfile=<value>
899    Log file for pipeline compiler (Vulkan SC only, do not use manually)
900    default: ''
901
902  --deqp-pipeline-prefix=<value>
903    Prefix for input pipeline compiler files (Vulkan SC only, do not use manually)
904    default: ''
905
906Full list of parameters for the `vksc-server` application:
907
908  --port
909    Port
910    default: '59333'
911
912  --log
913    Log filename
914    default: 'dummy.log'
915
916  --pipeline-compiler
917    Path to offline pipeline compiler
918    default: ''
919
920  --pipeline-dir
921    Offline pipeline data directory
922    default: ''
923
924  --pipeline-file
925    Output file with pipeline cache
926    default: ''
927
928  --pipeline-log
929    Compiler log file
930    default: 'compiler.log'
931
932  --pipeline-args
933    Additional compiler parameters
934    default: ''
935