Documentation/gpu/drm-usage-stats.rst

1 .. _drm-client-usage-stats:
8 `fops->show_fdinfo()` as part of the driver specific file operations registered
22 - File shall contain one key value pair per one line of text.
23 - Colon character (`:`) must be used to delimit keys and values.
24 - All standardised keys shall be prefixed with `drm-`.
25 - Driver-specific keys shall be prefixed with `driver_name-`, where
28 - Whitespace between the delimiter and first non-whitespace character shall be
30 - Keys are not allowed to contain whitespace characters.
31 - Numerical key value pairs can end with optional unit string.
32 - Data type of the value is fixed as defined in the specification.
35 ---------
42 ----------
44 - <uint> - Unsigned integer without defining the maximum value.
45 - <keystr> - String excluding any above defined reserved characters or whitespace.
46 - <valstr> - String.
49 ---------------------------------
51 - drm-driver: <valstr>
57 --------------------------------
62 - drm-pdev: <aaaa:bb.cc.d>
67 - drm-client-id: <uint>
74 scope of each device, in which case `drm-pdev` shall be present as well.
79 - drm-client-name: <valstr>
87 - drm-engine-<keystr>: <uint> ns
93 Value shall be in specified time units which the respective GPU engine spent
102 - drm-engine-capacity-<keystr>: <uint>
105 drm-engine-<keystr> tag and shall contain a greater than zero number in case the
111 - drm-cycles-<keystr>: <uint>
114 drm-engine-<keystr> tag and shall contain the number of busy cycles for the given
123 - drm-total-cycles-<keystr>: <uint>
126 drm-cycles-<keystr> tag and shall contain the total number cycles for the given
129 This is a timestamp in GPU unspecified unit that matches the update rate
130 of drm-cycles-<keystr>. For drivers that implement this interface, the engine
131 utilization can be calculated entirely on the GPU clock domain, without
134 A driver may implement either this key or drm-maxfreq-<keystr>, but not both.
136 - drm-maxfreq-<keystr>: <uint> [Hz|MHz|KHz]
139 drm-engine-<keystr> tag and shall contain the maximum frequency for the given
140 engine.  Taken together with drm-cycles-<keystr>, this can be used to calculate
141 percentage utilization of the engine, whereas drm-engine-<keystr> only reflects
145 A driver may implement either this key or drm-total-cycles-<keystr>, but not
151 Each possible memory type which can be used to store buffer objects by the GPU
161 indicating kibi- or mebi-bytes.
163 - drm-total-<region>: <uint> [KiB|MiB]
167 instantiated to count under this category. To avoid double-counting, if a buffer
171 - drm-shared-<region>: <uint> [KiB|MiB]
174 than one handle). The same requirement to avoid double-counting that applies to
175 drm-total-<region> also applies here.
177 - drm-resident-<region>: <uint> [KiB|MiB]
182 - drm-memory-<region>: <uint> [KiB|MiB]
185 drm-resident-<region>.
187 - drm-purgeable-<region>: <uint> [KiB|MiB]
195 - drm-active-<region>: <uint> [KiB|MiB]
212 -------------------------------
214 * :ref:`i915-usage-stats`
215 * :ref:`panfrost-usage-stats`
216 * :ref:`panthor-usage-stats`
217 * :ref:`xe-usage-stats`