Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / mesa3d / 2a77c3cc0b5ea126e9e15d9a928f3dc944e3668f / . / src / gallium / docs / source / debugging.rst
blob: e081cbf74e1d435c112bff064730b8fdba61a2f6 [file] [log] [blame]
Jakob Bornecrantzd62b29f2010-08-15 00:59:57 +0100[diff] [blame]1Debugging
2=========
3
4Debugging utilities in gallium.
5
6Debug Variables
7^^^^^^^^^^^^^^^
8
Corbin Simpson2d53dc82010-08-15 03:26:58 -0700[diff] [blame]9All drivers respond to a set of common debug environment variables, as well as
10some driver-specific variables. Set them as normal environment variables for
11the platform or operating system you are running. For example, for Linux this
12can be done by typing "export var=value" into a console and then running the
Jakob Bornecrantzd62b29f2010-08-15 00:59:57 +0100[diff] [blame]13program from that console.
14
15Common
16""""""
17
Corbin Simpsonbf357ae2010-08-15 03:05:18 -0700[diff] [blame]18.. envvar:: GALLIUM_PRINT_OPTIONS <bool> (false)
Jakob Bornecrantzd62b29f2010-08-15 00:59:57 +0100[diff] [blame]19
Corbin Simpson2d53dc82010-08-15 03:26:58 -0700[diff] [blame]20This option controls if the debug variables should be printed to stderr. This
21is probably the most useful variable, since it allows you to find which
22variables a driver uses.
Jakob Bornecrantzd62b29f2010-08-15 00:59:57 +0100[diff] [blame]23
Jakob Bornecrantzd377abd2010-08-20 02:28:36 +0100[diff] [blame]24.. envvar:: GALLIUM_GALAHAD <bool> (false)
25
26Controls if the :ref:`galahad` sanity checker module should be used.
27
Corbin Simpsonbf357ae2010-08-15 03:05:18 -0700[diff] [blame]28.. envvar:: GALLIUM_RBUG <bool> (false)
Jakob Bornecrantzd62b29f2010-08-15 00:59:57 +0100[diff] [blame]29
30Controls if the :ref:`rbug` should be used.
31
Corbin Simpsonbf357ae2010-08-15 03:05:18 -0700[diff] [blame]32.. envvar:: GALLIUM_TRACE <string> ("")
Jakob Bornecrantzd62b29f2010-08-15 00:59:57 +0100[diff] [blame]33
Corbin Simpson2d53dc82010-08-15 03:26:58 -0700[diff] [blame]34If set, this variable will cause the :ref:`Trace` output to be written to the
35specified file. Paths may be relative or absolute; relative paths are relative
36to the working directory. For example, setting it to "trace.xml" will cause
37the trace to be written to a file of the same name in the working directory.
Jakob Bornecrantzd62b29f2010-08-15 00:59:57 +0100[diff] [blame]38
Corbin Simpsonbf357ae2010-08-15 03:05:18 -0700[diff] [blame]39.. envvar:: GALLIUM_DUMP_CPU <bool> (false)
Jakob Bornecrantzd62b29f2010-08-15 00:59:57 +0100[diff] [blame]40
Corbin Simpson2d53dc82010-08-15 03:26:58 -0700[diff] [blame]41Dump information about the current CPU that the driver is running on.
Jakob Bornecrantzd62b29f2010-08-15 00:59:57 +0100[diff] [blame]42
Corbin Simpsonbf357ae2010-08-15 03:05:18 -0700[diff] [blame]43.. envvar:: TGSI_PRINT_SANITY <bool> (false)
Jakob Bornecrantzd62b29f2010-08-15 00:59:57 +0100[diff] [blame]44
Corbin Simpson2d53dc82010-08-15 03:26:58 -0700[diff] [blame]45Gallium has a built-in shader sanity checker. This option controls whether
46the shader sanity checker prints its warnings and errors to stderr.
Jakob Bornecrantzd62b29f2010-08-15 00:59:57 +0100[diff] [blame]47
Corbin Simpsonbf357ae2010-08-15 03:05:18 -0700[diff] [blame]48.. envvar:: DRAW_USE_LLVM <bool> (false)
Jakob Bornecrantzd62b29f2010-08-15 00:59:57 +0100[diff] [blame]49
Corbin Simpson2d53dc82010-08-15 03:26:58 -0700[diff] [blame]50Whether the :ref:`Draw` module will attempt to use LLVM for vertex and geometry shaders.
51
52
53State tracker-specific
54""""""""""""""""""""""
Jakob Bornecrantzd62b29f2010-08-15 00:59:57 +0100[diff] [blame]55
Corbin Simpsonbf357ae2010-08-15 03:05:18 -0700[diff] [blame]56.. envvar:: ST_DEBUG <flags> (0x0)
Jakob Bornecrantzd62b29f2010-08-15 00:59:57 +0100[diff] [blame]57
58Debug :ref:`flags` for the GL state tracker.
59
60
Corbin Simpson2d53dc82010-08-15 03:26:58 -0700[diff] [blame]61Driver-specific
Jakob Bornecrantzd62b29f2010-08-15 00:59:57 +0100[diff] [blame]62"""""""""""""""
63
Corbin Simpsonbf357ae2010-08-15 03:05:18 -0700[diff] [blame]64.. envvar:: I915_DEBUG <flags> (0x0)
Jakob Bornecrantzd62b29f2010-08-15 00:59:57 +0100[diff] [blame]65
66Debug :ref:`flags` for the i915 driver.
67
Corbin Simpsonbf357ae2010-08-15 03:05:18 -0700[diff] [blame]68.. envvar:: I915_NO_HW <bool> (false)
Jakob Bornecrantzd62b29f2010-08-15 00:59:57 +0100[diff] [blame]69
70Stop the i915 driver from submitting commands to the hardware.
71
Corbin Simpsonbf357ae2010-08-15 03:05:18 -0700[diff] [blame]72.. envvar:: I915_DUMP_CMD <bool> (false)
Jakob Bornecrantzd62b29f2010-08-15 00:59:57 +0100[diff] [blame]73
74Dump all commands going to the hardware.
75
Corbin Simpsonbf357ae2010-08-15 03:05:18 -0700[diff] [blame]76.. envvar:: LP_DEBUG <flags> (0x0)
Jakob Bornecrantzd62b29f2010-08-15 00:59:57 +0100[diff] [blame]77
78Debug :ref:`flags` for the llvmpipe driver.
79
Corbin Simpson2d53dc82010-08-15 03:26:58 -0700[diff] [blame]80.. envvar:: LP_NUM_THREADS <int> (number of CPUs)
Jakob Bornecrantzd62b29f2010-08-15 00:59:57 +0100[diff] [blame]81
82Number of threads that the llvmpipe driver should use.
83
84
85.. _flags:
86
87Flags
88"""""
89
Corbin Simpson2d53dc82010-08-15 03:26:58 -0700[diff] [blame]90The variables of type "flags" all take a string with comma-separated flags to
91enable different debugging for different parts of the drivers or state
92tracker. If set to "help", the driver will print a list of flags which the
93variable accepts. Order does not matter.
Jakob Bornecrantzd62b29f2010-08-15 00:59:57 +0100[diff] [blame]94
95
96.. _rbug:
97
98Remote Debugger
99^^^^^^^^^^^^^^^
100
Corbin Simpson2d53dc82010-08-15 03:26:58 -0700[diff] [blame]101The remote debugger, commonly known as rbug, allows for runtime inspections of
102:ref:`Context`, :ref:`Screen`, :ref:`Resource` and :ref:`Shader` objects; and
103pausing and stepping of :ref:`Draw` calls. Is used with rbug-gui which is
104hosted outside of the main mesa repository. rbug is can be used over a network
105connection, so the debugger does not need to be on the same machine.