README.md 15.5 KB
Newer Older
Nicolai Hähnle's avatar
Nicolai Hähnle committed
1 2

Piglit
3 4
======

5 6 7 8 9 10
1. [About](#1-about)
2. [Setup](#2-setup)
3. [How to run tests](#3-how-to-run-tests)
4. [Available test sets](#4-available-test-sets)
5. [How to write tests](#5-how-to-write-tests)
6. [Integration](#6-integration)
Nicolai Hähnle's avatar
Nicolai Hähnle committed
11 12


13
## 1. About
Nicolai Hähnle's avatar
Nicolai Hähnle committed
14

15 16
Piglit is a collection of automated tests for OpenGL and OpenCL
implementations.
Nicolai Hähnle's avatar
Nicolai Hähnle committed
17 18

The goal of Piglit is to help improve the quality of open source
19
OpenGL and OpenCL drivers by providing developers with a simple means to
Nicolai Hähnle's avatar
Nicolai Hähnle committed
20 21 22 23 24 25 26
perform regression tests.

The original tests have been taken from
- Glean ( http://glean.sf.net/ ) and
- Mesa ( http://www.mesa3d.org/ )


27
## 2. Setup
Nicolai Hähnle's avatar
Nicolai Hähnle committed
28 29 30

First of all, you need to make sure that the following are installed:

31
  - Python 2.7.x or >=3.4
32
  - Python Mako module
33
  - numpy (http://www.numpy.org)
34
  - six (https://pypi.python.org/pypi/six)
Nicolai Hähnle's avatar
Nicolai Hähnle committed
35
  - cmake (http://www.cmake.org)
36
  - GL, gbm, glu and glut libraries and development packages (i.e. headers)
Nicolai Hähnle's avatar
Nicolai Hähnle committed
37
  - X11 libraries and development packages (i.e. headers)
38
  - waffle (http://www.waffle-gl.org)
39
  - mako
40 41 42 43 44 45

Optionally, you can install the following:

  - lxml. An accelerated python xml library using libxml2 (http://lxml.de/)
  - simplejson. A fast C based implementation of the python json library.
    (https://simplejson.readthedocs.org/en/latest/)
46 47
  - jsonstreams. A JSON stream writer for python.
    (https://jsonstreams.readthedocs.io/en/stable/)
48 49
  - VkRunner. A shader script testing tool for Vulkan.
    (https://github.com/igalia/vkrunner)
50 51 52

For Python 2.x you can install the following to add features, these are
unnecessary for python3:
53
  - backports.lzma. A backport of python3's lzma module to python2,
54 55
    this enables fast native xz (de)compression in piglit for results files
    (https://github.com/peterjc/backports.lzma)
56 57 58
  - subprocess32. A backport of the subprocess from python3.2, which includes
    timeout support. This only works for Linux

59
For testing the python framework using `py.test unittests/framework`
60 61 62 63
  - py.test. A python test framework, used for running the python framework
    test suite.
  - tox. A tool for testing python packages against multiple configurations of
    python (https://tox.readthedocs.org/en/latest/index.html)
64 65
  - mock. A python module for mocking other python modules. Required only for
    unittests (https://github.com/testing-cabal/mock)
66 67 68 69
  - psutil. A portable process library for python
  - jsonschema. A JSON validator library for python
  - pytest-mock. A mock plugin for pytest
  - pytest-pythonpath. A plugin for pytest to do automagic with sys.path
70
  - pytest-raises. A plugin for pytest that allows decorating tests that expect
71 72 73
    failure
  - pytest-warnings. A plugin for pytest that handles python warnings
  - pytest-timeout. A plugin for pytest to timeout tests.
Nicolai Hähnle's avatar
Nicolai Hähnle committed
74 75 76

Now configure the build system:

77
    $ ccmake .
Nicolai Hähnle's avatar
Nicolai Hähnle committed
78 79 80 81

This will start cmake's configuration tool, just follow the onscreen
instructions. The default settings should be fine, but I recommend you:
 - Press 'c' once (this will also check for dependencies) and then
82
 - Set `CMAKE_BUILD_TYPE` to `Debug` Now you can press 'c' again and then 'g' to generate the build system.
Nicolai Hähnle's avatar
Nicolai Hähnle committed
83 84
Now build everything:

85
    $ make
Nicolai Hähnle's avatar
Nicolai Hähnle committed
86 87


88
### 2.1 Cross Compiling
89

90 91
On Linux, if cross-compiling a 32-bit build on a 64-bit host, first make sure
you didn't have CMakeCache.txt file left from 64-bit build (it would retain old
92 93
flags), then you must invoke cmake with options
`-DCMAKE_SYSTEM_PROCESSOR=x86 -DCMAKE_C_FLAGS=-m32 -DCMAKE_CXX_FLAGS=-m32`.
94

Nicolai Hähnle's avatar
Nicolai Hähnle committed
95

96
### 2.2 Ubuntu
97 98

Install development packages.
99

100
    $ sudo apt-get install cmake g++ mesa-common-dev libgl1-mesa-dev python-numpy python-mako freeglut3-dev x11proto-gl-dev libxrender-dev libwaffle-dev libgbm-dev
101

102
Configure and build.
103 104 105

    $ cmake .
    $ make
106 107


108
### 2.3 Mac OS X
109

110
Install CMake.
111 112 113 114 115 116 117
http://cmake.org/cmake/resources/software.html
Download and install 'Mac OSX Universal' platform.

Install Xcode.
http://developer.apple.com/xcode

Configure and build.
118 119 120

    $ cmake .
    $ make
121 122


123
### 2.4 Cygwin
124 125 126 127 128 129 130 131 132 133 134 135

Install development packages.
  - cmake
  - gcc4
  - make
  - opengl
  - libGL-devel
  - python
  - python-numpy
  - libglut-devel

Configure and build.
136 137 138

    $ cmake .
    $ make
139 140


141
### 2.5 Windows
142

143
Install Python 3.
144 145 146 147 148 149
http://www.python.org/download

Install CMake.
http://cmake.org/cmake/resources/software.html
Download and install 'Windows' platform.

150 151 152 153 154
Download and install Ninja
https://github.com/ninja-build/ninja/releases

Install MinGW-w64
https://mingw-w64.org/
155 156 157

Download OpenGL Core API and Extension Header Files.
http://www.opengl.org/registry/#headers
158
Pass `-DGLEXT_INCLUDE_DIR=/path/to/headers`
159 160

Install python mako.
161 162

    pip install mako
163 164

Install NumPy.
165 166

    pip install numpy
167

168

169
#### 2.5.1 GLUT
170

171 172
Download freeglut for Mingw.
http://www.transmissionzero.co.uk/software/freeglut-devel/
173

174 175
    cmake -H. -Bbuild -G "Ninja" -DGLEXT_INCLUDE_DIR=\path\to\glext -DGLUT_INCLUDE_DIR=\path\to\freeglut\include -DGLUT_glut_LIBRARY=\path\to\freeglut\lib\x64\libfreeglut.a -DGLEXT_INCLUDE_DIR=\path\to\glext
    ninja -C build
176 177


178
#### 2.5.2 Waffle
179

180
Download and build waffle for MinGW.
181 182 183 184 185
http://www.waffle-gl.org/

Open the Command Prompt.
CD to piglit directory.

186
    cmake -H. -Bbuild -G "Ninja" -DGLEXT_INCLUDE_DIR=\path\to\glext -DPIGLIT_USE_WAFFLE=TRUE -DWAFFLE_INCLUDE_DIRS=\path\to\waffle\include\waffle WAFFLE_LDFLAGS=\path\to\waffle\lib\libwaffle-1.a
187

188

189
## 3. How to run tests
Nicolai Hähnle's avatar
Nicolai Hähnle committed
190 191 192

Make sure that everything is set up correctly:

193
    $ ./piglit run sanity results/sanity
Nicolai Hähnle's avatar
Nicolai Hähnle committed
194

195 196
You may include '.py' on the profile, or you may exclude it (sanity vs sanity.py),
both are equally valid.
197

198 199 200
You may also preface test profiles with tests/ (or any other path you like),
which may be useful for shell tab completion.

201
You may provide multiple profiles to be run at the same time:
202

203
    $ ./piglit run quick_cl gpu deqp_gles3 results/gl-cl-combined
204

205
Use
Nicolai Hähnle's avatar
Nicolai Hähnle committed
206

207 208 209 210 211
    $ ./piglit run

or

    $ ./piglit run -h
Nicolai Hähnle's avatar
Nicolai Hähnle committed
212

213 214 215
To learn more about the command's syntax.

Have a look into the tests/ directory to see what test profiles are available:
Nicolai Hähnle's avatar
Nicolai Hähnle committed
216

217
    $ ls tests/*.py
Nicolai Hähnle's avatar
Nicolai Hähnle committed
218

219 220
See also section 4.

Nicolai Hähnle's avatar
Nicolai Hähnle committed
221 222
To create some nice formatted test summaries, run

223
    $ ./piglit summary html summary/sanity results/sanity
Nicolai Hähnle's avatar
Nicolai Hähnle committed
224 225

Hint: You can combine multiple test results into a single summary.
226
During development, you can use this to watch for regressions:
Nicolai Hähnle's avatar
Nicolai Hähnle committed
227

228
    $ ./piglit summary html summary/compare results/baseline results/current
Nicolai Hähnle's avatar
Nicolai Hähnle committed
229

230 231
You can combine as many testruns as you want this way (in theory;
the HTML layout becomes awkward when the number of testruns increases)
Nicolai Hähnle's avatar
Nicolai Hähnle committed
232 233 234

Have a look at the results with a browser:

235
    $ xdg-open summary/sanity/index.html
Nicolai Hähnle's avatar
Nicolai Hähnle committed
236 237 238

The summary shows the 'status' of a test:

239 240 241 242 243 244 245
  - **pass:**   This test has completed successfully.
  - **warn:**   The test completed successfully, but something unexpected happened.
    Look at the details for more information.
  - **fail:**   The test failed.
  - **crash:**  The test binary exited with a non-zero exit code.
  - **skip:**   The test was skipped.
  - **timeout:**  The test ran longer than its allotted time and was forcibly killed.
246

247 248 249

There are also dmesg-* statuses. These have the same meaning as above, but are
triggered by dmesg related messages.
Nicolai Hähnle's avatar
Nicolai Hähnle committed
250

251 252

### 3.1 Environment Variables
253 254 255 256

There are a number of environment variables that control the way piglit
behaves.

257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
  - `PIGLIT_COMPRESSION`

    Overrides the compression method used. The same values that piglit.conf
    allows for core:compression.

  - `PIGLIT_PLATFORM`

    Overrides the platform run on. These allow the same values as `piglit run -p`.
    This values is honored by the tests themselves, and can be used when running
    a single test.

  - `PIGLIT_FORCE_GLSLPARSER_DESKTOP`

    Force glslparser tests to be run with the desktop (non-gles) version of
    glslparsertest. This can be used to test ESX_compatability extensions
    for OpenGL

  - `PIGLIT_NO_FAST_SKIP`

    Piglit has a mechanism run in the python layer for skipping tests with
    unmet OpenGL or window system dependencies without starting a new
    process (which is expensive). Sometimes this system doesn't work or is
    undesirable, setting this environment variable to True will disable this
    system.

  - `PIGLIT_NO_TIMEOUT`

    When this variable is true in python then any timeouts given by tests
    will be ignored, and they will run until completion or they are killed.
286

287 288 289 290 291 292 293
  - `PIGLIT_VKRUNNER_BINARY`

    Can be used to override the path to the vkrunner executable for
    running Vulkan shader tests. Alternatively the config option
    vkrunner:bin can be used instead. If neither are set then vkrunner
    will be searched for in the search path.

294 295

### 3.2 Note
296

297 298 299 300 301 302
The way `piglit run` and `piglit summary` count tests are different,
`piglit run` counts the number of Test derived instance in the profile(s)
selected, while `piglit summary` counts the number of subtests a result
contains, or it's result if there are no subtests. This means that the number
shown by `piglit run` will be less than or equal to the number calculated by
`piglit summary`.
303

Nicolai Hähnle's avatar
Nicolai Hähnle committed
304

305
### 3.3 Shell Completions
306 307 308 309 310 311 312 313

Piglit has completions for bash, located in completions/bash/piglit. Once this
file is sourced into bash `piglit` and `./piglit` will have tab completion
available. For global availability place the file somewhere that bash will
source the file on startup. If piglit is installed and bash-completions are
available, then this completion file will be installed system-wide.


314
## 4. Available test sets
315 316 317 318

Test sets are specified as Python scripts in the tests directory.
The following test sets are currently available:

319

320
### 4.1 OpenGL Tests
321

322 323 324 325
  - **sanity.py** This suite contains minimal OpenGL sanity tests. These tests
    must pass, otherwise the other tests will not generate reliable results.
  - **all.py** This suite contains all OpenGL tests.
  - **quick.py** Run all tests, but cut down significantly on their runtime
Nicolai Hähnle's avatar
Nicolai Hähnle committed
326
    (and thus on the number of problems they can find).
327 328 329 330 331 332 333 334 335 336
  - **gpu.py** A further reduced set of tests from quick.py, this runs tests
    only for hardware functionality and not tests for the software stack.
  - **llvmpipe.py** A reduced set of tests from gpu.py removing tests that are
    problematic using llvmpipe
  - **cpu.py** This profile runs tests that don't touch the gpu, in other words
    all of the tests in quick.py that are not run by gpu.py
  - **glslparser.py** A subset of all.py which runs only glslparser tests
  - **shader.py** A subset of all.py which runs only shader tests
  - **no_error.py** A modified version of the test list run as khr_no_error
    variants
337

338

339
### 4.2 OpenCL Tests
340

341 342 343
  - **cl.py** This suite contains all OpenCL tests.
  - **quick_cl.py** This runs all of the tests from cl.py as well as tests from
    opencv and oclconform.
344 345


346 347 348 349 350 351 352
### 4.3 Vulkan tests

  - **vulkan.py** This suite contains all Vulkan tests. Note that
    currently all of the Vulkan tests require VkRunner. If it is not
    installed then all of the tests will be skipped.

### 4.4 External Integration
353

354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
  - **xts.py** Support for running the X Test Suite using piglit.
  - **igt.py** Support for running Intel-gpu-tools test suite using piglit.
  - **deqp_egl.py** Support for running dEQP's EGL profile with piglit.
  - **deqp_gles2.py** Support for running dEQP's gles2 profile with piglit.
  - **deqp_gles3.py** Support for running dEQP's gles3 profile with piglit.
  - **deqp_gles31.py** Support for running dEQP's gles3.1 profile with piglit.
  - **deqp_vk.py** Support for running the official Khronos Vulkan CTS profile
    with piglit.
  - **khr_gl.py** Support for running the open source Khronos OpenGL CTS tests
    with piglit.
  - **khr_gl45.py** Support for running the open source Khronos OpenGL 4.5 CTS
    tests with piglit.
  - **cts_gl.py** Support for running the closed source Khronos OpenGL CTS
    tests with piglit.
  - **cts_gl45.py** Support for running the closed source Khronos OpenGL 4.5
    CTS tests with piglit.
  - **cts_gles.py** Support for running the closed source Khronos GLES CTS
    tests with piglit.
  - **oglconform.py** Support for running sub-test of the Intel oglconform test
    suite with piglit.
374

375

376
## 5. How to write tests
Nicolai Hähnle's avatar
Nicolai Hähnle committed
377 378 379 380 381

Every test is run as a separate process. This minimizes the impact that
severe bugs like memory corruption have on the testing process.

Therefore, tests can be implemented in an arbitrary standalone language.
382
C is the preferred language for compiled tests, piglit also supports its own
383
simple formats for test shaders and glsl parser input.
Nicolai Hähnle's avatar
Nicolai Hähnle committed
384

385 386 387
All new tests must be added to the appropriate profile, all.py profile for
OpenGL and cl.py for OpenCL. There are a few basic test classes supported by the
python framework:
Nicolai Hähnle's avatar
Nicolai Hähnle committed
388

389 390
  - `PiglitBaseTest`
    A shared base class for all native piglit tests.
391

392 393
    It starts each test as a subprocess, captures stdout and stderr, and waits
    for the test to return.
394

395 396
    It provides test timeouts by setting the instances 'timeout' attribute to an
    integer > 0 which is the number of seconds the test should run.
397

398 399 400
    It interprets output by reading stdout and looking for 'PIGLIT: ' in the
    output, and then reading any trailing characters as well formed json
    returning the test result.
401

402 403
    This is a base class and should not be used directly, but provides an
    explanation of the behavior of the following classes.
404

405 406
  - `PiglitGLTest`
    A test class for native piglit OpenGL tests.
407

408 409 410
    In addition to the properties of PiglitBaseTest it provides a mechanism for
    detecting test window resizes and rerunning tests as well as keyword
    arguments for platform requirements.
411

412 413
  - `PiglitCLTest`
    A test class for native piglit OpenCL tests.
414

415
    It currently provides no special features.
416

417 418
  - `GLSLParserTest`
    A class for testing a glsl parser.
419

420 421
    It is generally unnecessary to call this class directly as it uses a helper
    function to search directories for tests.
Nicolai Hähnle's avatar
Nicolai Hähnle committed
422

423 424
  - `ShaderTest`
    A class for testing using OpenGL shaders.
Nicolai Hähnle's avatar
Nicolai Hähnle committed
425

426 427
    It is generally unnecessary to call this class directly as it uses a helper
    function to search directories for tests.
428 429


430
## 6. Integration
431 432 433 434 435 436 437 438 439 440

Piglit provides integration for other test suites as well. The rational for
this is that it provides piglit's one process per test protections (one test
crashing does not crash the whole suite), and access to piglit's reporting
tools.

Most integration is done through the use of piglit.conf, or through environment
variables, with piglit.conf being the preferred method.


441
### 6.1 dEQP
442 443 444 445 446 447 448 449

Piglit provides a generic layer for dEQP based test suites, and specific
integration for several suites.

I suggest using Chad Versace's repo of dEQP, which contains a gbm target.
https://github.com/chadversary/deqp

It should be built as follows:
450 451

    cmake . -DDEQP_TARGET=gbm -GNinja
452 453 454 455 456 457 458 459

Additional targets are available in the targets directory. gbm isn't compatible
for most (any?) blob driver, so another target might be necessary if that is a
requirement. One of the x11_* targets or drm is probably a good choice.

The use of ninja is optional.

Once dEQP is built add the following information to piglit.conf, which can
460 461
either be located in the root of the piglit repo, or in `$XDG_CONFIG_HOME`
(usually `$HOME/.config`).
462

463 464
    [deqp-gles2]
    bin=<deqp source dir>/modules/gles2/deqp-gles2
465

466 467
    [deqp-gles3]
    bin=<deqp source dir>/modules/gles3/deqp-gles3
468

469 470
    [deqp-gles31]
    bin=<deqp source dir>/modules/gles31/deqp-gles31
471 472

These platforms can be run using deqp_gles*.py as a suite in piglit.
473 474 475
For example:

    ./piglit run deqp_gles31 my_results -c
476 477

It is also possible to mix integrated suites and piglit profiles together:
478 479

    ./piglit run deqp_gles31 quick cl my_results
480 481 482 483 484

dEQP profiles generally contain all of the tests from the previous profile, so
gles31 covers gles3 and gles2.


485
### 6.2 Khronos CTS
486 487 488

Add the following to your piglit.conf file:

489 490
    [cts]
    bin=<cts source dir>/cts/glcts