summaryrefslogtreecommitdiff
path: root/docs/reference/intel-gpu-tools/igt_test_programs.xml
blob: ec05d53e592da8b9126a4fbc7dab3c288e92b96c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
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
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
<?xml version="1.0"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
  <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
  <!ENTITY version SYSTEM "version.xml">
]>

<chapter id="test-programs">
  <title>Test Programs</title>

  <refentry id="igt-test-programs-common-features">
    <refnamediv>
      <refname>Common Features</refname>
      <refpurpose>Features available in all test programs</refpurpose>
    </refnamediv>
    <refsect1>
      <title>Command Line Options</title>
      <para>
        All tests support the following command line options:

        <variablelist>
          <varlistentry>
            <term><option>--list-subtests</option></term>
            <listitem><para>
                list the available subtests and exit
            </para></listitem>
          </varlistentry>

          <varlistentry>
            <term><option>--run-subtest <replaceable>subtest</replaceable></option></term>
            <listitem><para>
                run the specified subtest
            </para></listitem>
          </varlistentry>

          <varlistentry>
            <term><option>--debug[=log-domain]</option></term>
            <listitem><para>
                print extra debugging information when running tests and
                optionally only show the messages from the specified log domain
                (use "application" to specify the default application domain)
            </para></listitem>
          </varlistentry>

          <varlistentry>
            <term><option>--help-description</option></term>
            <listitem><para>
                print a short description of the test and exit
            </para></listitem>
          </varlistentry>

          <varlistentry>
            <term><option>--help</option></term>
            <listitem><para>
                print help and exit
            </para></listitem>
          </varlistentry>
        </variablelist>
      </para>
    </refsect1>

    <refsect1>
      <title>Exit Status</title>
      <para>
      The following exit status codes are defined:

      <informaltable pgwide="1" frame="none">
        <tgroup cols="3" align="left">
          <thead>
            <row><entry>Name</entry><entry>Value</entry><entry>Description</entry></row>
          </thead>
          <tbody>
            <row>
              <entry>#IGT_EXIT_SUCCESS</entry>
              <entry>0</entry>
              <entry>The test was successful</entry>
            </row>
            <row>
              <entry>#IGT_EXIT_SKIP</entry>
              <entry>77</entry>
              <entry>The test was skipped</entry>
            </row>
            <row>
              <entry>#IGT_EXIT_TIMEOUT</entry>
              <entry>78</entry>
              <entry>The test took longer than expected and was stopped</entry>
            </row>
            <row>
              <entry>#IGT_EXIT_INVALID</entry>
              <entry>79</entry>
              <entry>An invalid option or subtest was specified</entry>
            </row>
          </tbody>
        </tgroup>
      </informaltable>

      Any other exit status indicates a test failure.
    </para>
    </refsect1>
  </refentry>

  <refentry id="igt-amdgpu-tests">
    <refnamediv>
      <refname>AMDGPU Tests</refname>
      <refpurpose>Tests for amdgpu driver behaviour</refpurpose>
    </refnamediv>
    <xi:include href="igt_test_programs_amdgpu_programs.xml"/>
    <xi:include href="igt_test_programs_amdgpu_description.xml"/>
  </refentry>

  <refentry id="igt-chamelium-tests">
    <refnamediv>
      <refname>Chamelium Tests</refname>
      <refpurpose>Tests using the Chamelium platform</refpurpose>
    </refnamediv>
    <xi:include href="igt_test_programs_chamelium_programs.xml"/>
    <xi:include href="igt_test_programs_chamelium_description.xml"/>
  </refentry>

  <refentry id="igt-core-tests">
    <refnamediv>
      <refname>Core Tests</refname>
      <refpurpose>Tests for core drm ioctls and behaviour</refpurpose>
    </refnamediv>
    <xi:include href="igt_test_programs_core_programs.xml"/>
    <xi:include href="igt_test_programs_core_description.xml"/>
  </refentry>

  <refentry id="igt-debugfs-tests">
    <refnamediv>
      <refname>Debugfs Tests</refname>
      <refpurpose>Tests for debugfs behaviour</refpurpose>
    </refnamediv>
    <xi:include href="igt_test_programs_debugfs_programs.xml"/>
    <xi:include href="igt_test_programs_debugfs_description.xml"/>
  </refentry>

  <refentry id="igt-drm-tests">
    <refnamediv>
      <refname>DRM Tests</refname>
      <refpurpose>Tests for libdrm behaviour</refpurpose>
    </refnamediv>
    <xi:include href="igt_test_programs_drm_programs.xml"/>
    <xi:include href="igt_test_programs_drm_description.xml"/>
  </refentry>

  <refentry id="igt-drv-tests">
    <refnamediv>
      <refname>DRV Tests</refname>
      <refpurpose>Tests for overall driver behaviour</refpurpose>
    </refnamediv>
    <xi:include href="igt_test_programs_drv_programs.xml"/>
    <xi:include href="igt_test_programs_drv_description.xml"/>
  </refentry>

  <refentry id="igt-gem-tests">
    <refnamediv>
      <refname>GEM Tests</refname>
      <refpurpose>Tests for the graphics execution manager</refpurpose>
    </refnamediv>
    <xi:include href="igt_test_programs_gem_programs.xml"/>
    <xi:include href="igt_test_programs_gem_description.xml"/>
  </refentry>

  <refentry id="igt-gen3-tests">
    <refnamediv>
      <refname>Gen 3 Tests</refname>
      <refpurpose>Tests specific to gen 3</refpurpose>
    </refnamediv>
    <xi:include href="igt_test_programs_gen3_programs.xml"/>
    <xi:include href="igt_test_programs_gen3_description.xml"/>
  </refentry>

  <refentry id="igt-gen7-tests">
    <refnamediv>
      <refname>Gen 7 Tests</refname>
      <refpurpose>Tests specific to gen 7</refpurpose>
    </refnamediv>
    <xi:include href="igt_test_programs_gen7_programs.xml"/>
    <xi:include href="igt_test_programs_gen7_description.xml"/>
  </refentry>

  <refentry id="igt-gvt-tests">
    <refnamediv>
      <refname>GVT Tests</refname>
      <refpurpose>Tests for graphics virtualization technology</refpurpose>
    </refnamediv>
    <xi:include href="igt_test_programs_gvt_programs.xml"/>
    <xi:include href="igt_test_programs_gvt_description.xml"/>
  </refentry>

  <refentry id="igt-kms-tests">
    <refnamediv>
      <refname>KMS Tests</refname>
      <refpurpose>Tests for kernel mode setting</refpurpose>
    </refnamediv>
    <xi:include href="igt_test_programs_kms_programs.xml"/>
    <xi:include href="igt_test_programs_kms_description.xml"/>
  </refentry>

  <refentry id="igt-meta-tests">
    <refnamediv>
      <refname>Meta Tests</refname>
      <refpurpose>Tests for the CI system itself</refpurpose>
    </refnamediv>
    <xi:include href="igt_test_programs_meta_programs.xml"/>
    <xi:include href="igt_test_programs_meta_description.xml"/>
  </refentry>

  <refentry id="igt-perf-tests">
    <refnamediv>
      <refname>Perf Tests</refname>
      <refpurpose>Tests for the performance metrics</refpurpose>
    </refnamediv>
    <xi:include href="igt_test_programs_perf_programs.xml"/>
    <xi:include href="igt_test_programs_perf_description.xml"/>
  </refentry>

  <refentry id="igt-pm-tests">
    <refnamediv>
      <refname>PM Tests</refname>
      <refpurpose>Tests for power management features</refpurpose>
    </refnamediv>
    <xi:include href="igt_test_programs_pm_programs.xml"/>
    <xi:include href="igt_test_programs_pm_description.xml"/>
  </refentry>

  <refentry id="igt-prime-tests">
    <refnamediv>
      <refname>Prime Tests</refname>
      <refpurpose>Tests for buffer sharding</refpurpose>
    </refnamediv>
    <xi:include href="igt_test_programs_prime_programs.xml"/>
    <xi:include href="igt_test_programs_prime_description.xml"/>
  </refentry>

  <refentry id="igt-sw-sync-tests">
    <refnamediv>
      <refname>SW Sync Tests</refname>
      <refpurpose>Tests for software sync (fencing)</refpurpose>
    </refnamediv>
    <xi:include href="igt_test_programs_sw_sync_programs.xml"/>
    <xi:include href="igt_test_programs_sw_sync_description.xml"/>
  </refentry>

  <refentry id="igt-testdisplay-tests">
    <refnamediv>
      <refname>Display Tests</refname>
      <refpurpose>Tests for display validation</refpurpose>
    </refnamediv>
    <xi:include href="igt_test_programs_testdisplay_programs.xml"/>
    <xi:include href="igt_test_programs_testdisplay_description.xml"/>
  </refentry>

  <refentry id="igt-tools-tests">
    <refnamediv>
      <refname>Tools Tests</refname>
      <refpurpose>Tests for IGT tools behaviour</refpurpose>
    </refnamediv>
    <xi:include href="igt_test_programs_tools_programs.xml"/>
    <xi:include href="igt_test_programs_tools_description.xml"/>
  </refentry>

  <refentry id="igt-vgem-tests">
    <refnamediv>
      <refname>vGEM Tests</refname>
      <refpurpose>Tests for the vitual graphics execution manager</refpurpose>
    </refnamediv>
    <xi:include href="igt_test_programs_vgem_programs.xml"/>
    <xi:include href="igt_test_programs_vgem_description.xml"/>
  </refentry>

  <glossary>
    <title>Glossary</title>

    <para>The following terms are commonly used in test names to describe
      various features of the test and can be used to filter and select
      particular tests.</para>

    <glossentry id="invalid">
      <glossterm>invalid</glossterm>
      <glossdef>
        <para>Negative tests to validate kernel interface input validation.</para>
      </glossdef>
    </glossentry>

    <glossentry id="hang">
      <glossterm>hang</glossterm>
      <glossdef>
        <para>Tests that provoke gpu hangs.</para>
      </glossdef>
    </glossentry>

    <glossentry id="swap">
      <glossterm>swap</glossterm>
      <glossdef>
        <para>Tests that force their full working sets through swap.</para>
      </glossdef>
    </glossentry>

    <glossentry id="thrash">
      <glossterm>thrash</glossterm>
      <glossdef>
        <para>Tests that tend to have really slow forward progress due to gtt/memory/.. thrashing.</para>
      </glossdef>
    </glossentry>

    <glossentry id="crc">
      <glossterm>crc</glossterm>
      <glossdef>
        <para>Tests that use the display CRC infrastructure to check the results.</para>
      </glossdef>
    </glossentry>

    <glossentry id="tiled">
      <glossterm>tiled</glossterm>
      <glossdef>
        <para>Tests that exercise behaviour on tiled buffers.</para>
      </glossdef>
    </glossentry>

    <glossentry id="tiling">
      <glossterm>tiling</glossterm>
      <glossdef>
        <para>Tests that exercise behaviour on tiled buffers.</para>
      </glossdef>
    </glossentry>

    <glossentry id="rte">
      <glossterm>rte</glossterm>
      <glossdef>
        <para>Runtime environment checks.</para>
      </glossdef>
    </glossentry>

    <glossentry id="ctx">
      <glossterm>ctx</glossterm>
      <glossdef>
        <para>Tests that exercise the hardware context support.</para>
      </glossdef>
    </glossentry>

    <glossentry id="render">
      <glossterm>render</glossterm>
      <glossdef>
        <para>Tests which apply to the render ring.</para>
      </glossdef>
    </glossentry>

    <glossentry id="blt">
      <glossterm>blt</glossterm>
      <glossdef>
        <para>Tests which apply to the blt ring.</para>
      </glossdef>
    </glossentry>

    <glossentry id="bsd">
      <glossterm>bsd</glossterm>
      <glossdef>
        <para>Tests which apply to the bsd ring.</para>
      </glossdef>
    </glossentry>

    <glossentry id="vebox">
      <glossterm>vebox</glossterm>
      <glossdef>
        <para>Tests which apply to the vebox ring.</para>
      </glossdef>
    </glossentry>

    <glossentry id="exec">
      <glossterm>exec</glossterm>
      <glossdef>
        <para>Tests that exercise the execbuf code in various ways.</para>
      </glossdef>
    </glossentry>

    <glossentry id="rpm">
      <glossterm>rpm</glossterm>
      <glossdef>
        <para>Runtime power management tests.</para>
      </glossdef>
    </glossentry>
  </glossary>
</chapter>