fdo-mirrors/mesa
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/mesa/mesa.git synced 2025-12-20 09:30:13 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
mesa/docs/gallium/debugging.rst

67 lines
2 KiB
ReStructuredText
Raw Normal View History

gallium/docs: Add a debugging section
2010-08-15 00:59:57 +01:00
Debugging
=========
Debugging utilities in gallium.
Debug Variables
^^^^^^^^^^^^^^^
gallium/docs: Cleanup debugging. Spelling, grammar, organization.
2010-08-15 03:26:58 -07:00
All drivers respond to a set of common debug environment variables, as well as
some driver-specific variables. Set them as normal environment variables for
the platform or operating system you are running. For example, for Linux this
can be done by typing "export var=value" into a console and then running the
gallium/docs: Add a debugging section
2010-08-15 00:59:57 +01:00
program from that console.
Common
""""""
docs: drop custom envvar directive The custom envvar directive is strange. It overloads the global namespace, where there's already a well-known envvar directive, but the envvar role won't resolve to envvars defined using the custom directive. It's not really critical to declare the type and default value here, and many descriptions already include this. Let's just use the plain one, and let the description take care of the details where needed. Reviewed-by: Yonggang Luo <luoyonggang@gmail.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19593>
2022-11-08 10:24:07 +01:00
.. envvar:: GALLIUM_TRACE
gallium/docs: Add a debugging section
2010-08-15 00:59:57 +01:00
docs: properly nest envvar descriptions These were not nested properly, making the definitions not part of the definition lists. Reviewed-by: Yonggang Luo <luoyonggang@gmail.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19593>
2022-11-08 10:18:02 +01:00
If set, this variable will cause the :ref:`trace` output to be written to the
specified file. Paths may be relative or absolute; relative paths are relative
to the working directory. For example, setting it to "trace.xml" will cause
the trace to be written to a file of the same name in the working directory.
gallium/docs: Add a debugging section
2010-08-15 00:59:57 +01:00
docs: drop custom envvar directive The custom envvar directive is strange. It overloads the global namespace, where there's already a well-known envvar directive, but the envvar role won't resolve to envvars defined using the custom directive. It's not really critical to declare the type and default value here, and many descriptions already include this. Let's just use the plain one, and let the description take care of the details where needed. Reviewed-by: Yonggang Luo <luoyonggang@gmail.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19593>
2022-11-08 10:24:07 +01:00
.. envvar:: GALLIUM_TRACE_TC
gallium: when tracing is enabled for threaded drivers, trace the driver thread generally speaking, if I'm tracing an app, I want to see what's happening to my driver, not what's happening to tc, as tc does rewriting of command streams which can affect the operation of the driver use GALLIUM_TRACE_TC for previous behavior Acked-by: Marek Olšák <marek.olsak@amd.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/10362>
2021-04-12 12:55:33 -04:00
docs: properly nest envvar descriptions These were not nested properly, making the definitions not part of the definition lists. Reviewed-by: Yonggang Luo <luoyonggang@gmail.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19593>
2022-11-08 10:18:02 +01:00
If enabled while :ref:`trace` is active, this variable specifies that the threaded context
should be traced for drivers which implement it. By default, the driver thread is traced,
which will include any reordering of the command stream from threaded context.
gallium: when tracing is enabled for threaded drivers, trace the driver thread generally speaking, if I'm tracing an app, I want to see what's happening to my driver, not what's happening to tc, as tc does rewriting of command streams which can affect the operation of the driver use GALLIUM_TRACE_TC for previous behavior Acked-by: Marek Olšák <marek.olsak@amd.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/10362>
2021-04-12 12:55:33 -04:00
docs: drop custom envvar directive The custom envvar directive is strange. It overloads the global namespace, where there's already a well-known envvar directive, but the envvar role won't resolve to envvars defined using the custom directive. It's not really critical to declare the type and default value here, and many descriptions already include this. Let's just use the plain one, and let the description take care of the details where needed. Reviewed-by: Yonggang Luo <luoyonggang@gmail.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19593>
2022-11-08 10:24:07 +01:00
.. envvar:: GALLIUM_TRACE_TRIGGER
aux/trace: add GALLIUM_TRACE_TRIGGER mode similar to amd/radv driver debug modes for sqtt, this specifies a filename which is checked on every flush(PIPE_FLUSH_END_OF_FRAME); when it exists, the next frame (and only that frame) is captured into the trace to use, specify a file with the env var, run your app, and 'touch /path/to/file' when you want to capture a trace Reviewed-by: Adam Jackson <ajax@redhat.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/10058>
2021-04-06 09:40:21 -04:00
docs: properly nest envvar descriptions These were not nested properly, making the definitions not part of the definition lists. Reviewed-by: Yonggang Luo <luoyonggang@gmail.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19593>
2022-11-08 10:18:02 +01:00
If set while :ref:`trace` is active, this variable specifies a filename to monitor.
Once the file exists (e.g., from the user running 'touch /path/to/file'), a single
frame will be recorded into the trace output.
Paths may be relative or absolute; relative paths are relative to the working directory.
aux/trace: add GALLIUM_TRACE_TRIGGER mode similar to amd/radv driver debug modes for sqtt, this specifies a filename which is checked on every flush(PIPE_FLUSH_END_OF_FRAME); when it exists, the next frame (and only that frame) is captured into the trace to use, specify a file with the env var, run your app, and 'touch /path/to/file' when you want to capture a trace Reviewed-by: Adam Jackson <ajax@redhat.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/10058>
2021-04-06 09:40:21 -04:00
gallium/docs: Cleanup debugging. Spelling, grammar, organization.
2010-08-15 03:26:58 -07:00
Driver-specific
gallium/docs: Add a debugging section
2010-08-15 00:59:57 +01:00
"""""""""""""""
docs: drop custom envvar directive The custom envvar directive is strange. It overloads the global namespace, where there's already a well-known envvar directive, but the envvar role won't resolve to envvars defined using the custom directive. It's not really critical to declare the type and default value here, and many descriptions already include this. Let's just use the plain one, and let the description take care of the details where needed. Reviewed-by: Yonggang Luo <luoyonggang@gmail.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19593>
2022-11-08 10:24:07 +01:00
.. envvar:: I915_DEBUG
gallium/docs: Add a debugging section
2010-08-15 00:59:57 +01:00
docs: properly nest envvar descriptions These were not nested properly, making the definitions not part of the definition lists. Reviewed-by: Yonggang Luo <luoyonggang@gmail.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19593>
2022-11-08 10:18:02 +01:00
Debug :ref:`flags` for the i915 driver.
gallium/docs: Add a debugging section
2010-08-15 00:59:57 +01:00
docs: drop custom envvar directive The custom envvar directive is strange. It overloads the global namespace, where there's already a well-known envvar directive, but the envvar role won't resolve to envvars defined using the custom directive. It's not really critical to declare the type and default value here, and many descriptions already include this. Let's just use the plain one, and let the description take care of the details where needed. Reviewed-by: Yonggang Luo <luoyonggang@gmail.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19593>
2022-11-08 10:24:07 +01:00
.. envvar:: I915_NO_HW
gallium/docs: Add a debugging section
2010-08-15 00:59:57 +01:00
docs: properly nest envvar descriptions These were not nested properly, making the definitions not part of the definition lists. Reviewed-by: Yonggang Luo <luoyonggang@gmail.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19593>
2022-11-08 10:18:02 +01:00
Stop the i915 driver from submitting commands to the hardware.
gallium/docs: Add a debugging section
2010-08-15 00:59:57 +01:00
docs: drop custom envvar directive The custom envvar directive is strange. It overloads the global namespace, where there's already a well-known envvar directive, but the envvar role won't resolve to envvars defined using the custom directive. It's not really critical to declare the type and default value here, and many descriptions already include this. Let's just use the plain one, and let the description take care of the details where needed. Reviewed-by: Yonggang Luo <luoyonggang@gmail.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19593>
2022-11-08 10:24:07 +01:00
.. envvar:: I915_DUMP_CMD
gallium/docs: Add a debugging section
2010-08-15 00:59:57 +01:00
docs: properly nest envvar descriptions These were not nested properly, making the definitions not part of the definition lists. Reviewed-by: Yonggang Luo <luoyonggang@gmail.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19593>
2022-11-08 10:18:02 +01:00
Dump all commands going to the hardware.
gallium/docs: Add a debugging section
2010-08-15 00:59:57 +01:00
docs: drop custom envvar directive The custom envvar directive is strange. It overloads the global namespace, where there's already a well-known envvar directive, but the envvar role won't resolve to envvars defined using the custom directive. It's not really critical to declare the type and default value here, and many descriptions already include this. Let's just use the plain one, and let the description take care of the details where needed. Reviewed-by: Yonggang Luo <luoyonggang@gmail.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19593>
2022-11-08 10:24:07 +01:00
.. envvar:: FD_MESA_DEBUG
freedreno: document debug flag Signed-off-by: Erik Faye-Lund <kusmabite@gmail.com> Signed-off-by: Brian Paul <brianp@vmware.com>
2013-03-26 14:48:45 +01:00
docs: properly nest envvar descriptions These were not nested properly, making the definitions not part of the definition lists. Reviewed-by: Yonggang Luo <luoyonggang@gmail.com> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19593>
2022-11-08 10:18:02 +01:00
Debug :ref:`flags` for the Freedreno driver.
freedreno: document debug flag Signed-off-by: Erik Faye-Lund <kusmabite@gmail.com> Signed-off-by: Brian Paul <brianp@vmware.com>
2013-03-26 14:48:45 +01:00
gallium/docs: Add a debugging section
2010-08-15 00:59:57 +01:00
.. _flags:
Flags
"""""
gallium/docs: Cleanup debugging. Spelling, grammar, organization.
2010-08-15 03:26:58 -07:00
The variables of type "flags" all take a string with comma-separated flags to
enable different debugging for different parts of the drivers or state
tracker. If set to "help", the driver will print a list of flags which the
variable accepts. Order does not matter.
Reference in a new issue Copy permalink