docs/u_trace: Add documentation for *_GPU_TRACEPOINT envvars
authorDanylo Piliaiev <dpiliaiev@igalia.com>
Tue, 31 May 2022 11:04:27 +0000 (14:04 +0300)
committerMarge Bot <emma+marge@anholt.net>
Tue, 12 Jul 2022 22:24:19 +0000 (22:24 +0000)
Signed-off-by: Danylo Piliaiev <dpiliaiev@igalia.com>
Reviewed-by: Emma Anholt <emma@anholt.net>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/16781>

docs/u_trace.rst

index 088bd10..0b66ca3 100644 (file)
@@ -41,3 +41,22 @@ u_trace is controlled by environment variables:
 :envvar:`GPU_TRACE_INSTRUMENT`
    Meaningful only for Perfetto tracing. If set to ``1`` enables
    instrumentation of GPU commands before the tracing is enabled.
+
+:envvar:`*_GPU_TRACEPOINT`
+   tracepoints can be enabled or disabled using driver specific environment
+   variable. Most tracepoints are enabled by default. For instance
+   ``TU_GPU_TRACEPOINT=-blit,+render_pass`` will disable the
+   ``blit`` tracepoints and enable the ``render_pass`` tracepoints.
+
+.. list-table::
+   :header-rows: 1
+
+   * - Driver
+     - Environment Variable
+     - Tracepoint Definitions
+   * - Freedreno
+     - :envvar:`FD_GPU_TRACEPOINT`
+     - ``src/gallium/drivers/freedreno/freedreno_tracepoints.py``
+   * - Turnip
+     - :envvar:`TU_GPU_TRACEPOINT`
+     - ``src/freedreno/vulkan/tu_tracepoints.py``