Unified configuration for metrics (#726)
* Show description of metrics during analysis
* Use --include-cols Description show the Description column in analyze mode (this is hidden by default)
* Remove tips field from analysis config
* Align metric names in analysis config and documentation
* Add unified config utils/unified_config.yaml
* Add python script utils/split_config.py to auto generate analysis configuration and documentation metrics description
* Add test case to ensure unified config is older than auto-generated config
* Auto generate analysis config and documentation metrics description
* Update CONTRIBUTING.md to add instructions to build documentation assets
* Add docker image and compose file to build documentation
* Update CHANGELOG and Documentation
* Use jinja template instead of hardcoding metric tables in documentation
This commit is contained in:
vedithal-amd
GitHub
@@ -71,40 +71,8 @@ Scalar L1D Speed-of-Light
|
||||
The Scalar L1D speed-of-light chart shows some key metrics of the sL1D
|
||||
cache as a comparison with the peak achievable values of those metrics:
|
||||
|
||||
.. list-table::
|
||||
:header-rows: 1
|
||||
:widths: 20 65 15
|
||||
|
||||
* - Metric
|
||||
|
||||
- Description
|
||||
|
||||
- Unit
|
||||
|
||||
* - Bandwidth
|
||||
|
||||
- The number of bytes looked up in the sL1D cache, as a percent of the peak
|
||||
theoretical bandwidth. Calculated as the ratio of sL1D requests over the
|
||||
:ref:`total sL1D cycles <total-sl1d-cycles>`.
|
||||
|
||||
- Percent
|
||||
|
||||
* - Cache Hit Rate
|
||||
|
||||
- The percent of sL1D requests that hit [#sl1d-cache]_ on a previously
|
||||
loaded line in the cache. Calculated as the ratio of the number of sL1D
|
||||
requests that hit over the number of all sL1D requests.
|
||||
|
||||
- Percent
|
||||
|
||||
* - sL1D-L2 BW
|
||||
|
||||
- The number of bytes requested by the sL1D from the L2 cache, as a percent
|
||||
of the peak theoretical sL1D → L2 cache bandwidth. Calculated as the
|
||||
ratio of the total number of requests from the sL1D to the L2 cache over
|
||||
the :ref:`total sL1D-L2 interface cycles <total-sl1d-cycles>`.
|
||||
|
||||
- Percent
|
||||
.. jinja:: desc-sl1d-sol
|
||||
:file: _templates/metrics_table.j2
|
||||
|
||||
.. _desc-sl1d-stats:
|
||||
|
||||
@@ -114,104 +82,8 @@ Scalar L1D cache accesses
|
||||
This panel gives more detail on the types of accesses made to the sL1D,
|
||||
and the hit/miss statistics.
|
||||
|
||||
.. list-table::
|
||||
:header-rows: 1
|
||||
|
||||
* - Metric
|
||||
|
||||
- Description
|
||||
|
||||
- Unit
|
||||
|
||||
* - Requests
|
||||
|
||||
- The total number of requests, of any size or type, made to the sL1D per
|
||||
:ref:`normalization unit <normalization-units>`.
|
||||
|
||||
- Requests per :ref:`normalization unit <normalization-units>`
|
||||
|
||||
* - Hits
|
||||
|
||||
- The total number of sL1D requests that hit on a previously loaded cache
|
||||
line, per :ref:`normalization unit <normalization-units>`.
|
||||
|
||||
- Requests per :ref:`normalization unit <normalization-units>`
|
||||
|
||||
* - Misses - Non Duplicated
|
||||
|
||||
- The total number of sL1D requests that missed on a cache line that *was
|
||||
not* already pending due to another request, per
|
||||
:ref:`normalization unit <normalization-units>`. See :ref:`desc-sl1d-sol`
|
||||
for more detail.
|
||||
|
||||
- Requests per :ref:`normalization unit <normalization-units>`
|
||||
|
||||
* - Misses - Duplicated
|
||||
|
||||
- The total number of sL1D requests that missed on a cache line that *was*
|
||||
already pending due to another request, per
|
||||
:ref:`normalization unit <normalization-units>`. See
|
||||
:ref:`desc-sl1d-sol` for more detail.
|
||||
|
||||
- Requests per :ref:`normalization unit <normalization-units>`
|
||||
|
||||
* - Cache Hit Rate
|
||||
|
||||
- Indicates the percent of sL1D requests that hit on a previously loaded
|
||||
line the cache. The ratio of the number of sL1D requests that hit
|
||||
[#sl1d-cache]_ over the number of all sL1D requests.
|
||||
|
||||
- Percent
|
||||
|
||||
* - Read Requests (Total)
|
||||
|
||||
- The total number of sL1D read requests of any size, per
|
||||
:ref:`normalization unit <normalization-units>`.
|
||||
|
||||
- Requests per :ref:`normalization unit <normalization-units>`
|
||||
|
||||
* - Atomic Requests
|
||||
|
||||
- The total number of sL1D atomic requests of any size, per
|
||||
:ref:`normalization unit <normalization-units>`. Typically unused on CDNA
|
||||
accelerators.
|
||||
|
||||
- Requests per :ref:`normalization unit <normalization-units>`
|
||||
|
||||
* - Read Requests (1 DWord)
|
||||
|
||||
- The total number of sL1D read requests made for a single dword of data
|
||||
(4B), per :ref:`normalization unit <normalization-units>`.
|
||||
|
||||
- Requests per :ref:`normalization unit <normalization-units>`
|
||||
|
||||
* - Read Requests (2 DWord)
|
||||
|
||||
- The total number of sL1D read requests made for a two dwords of data
|
||||
(8B), per :ref:`normalization unit <normalization-units>`.
|
||||
|
||||
- Requests per :ref:`normalization unit <normalization-units>`
|
||||
|
||||
* - Read Requests (4 DWord)
|
||||
|
||||
- The total number of sL1D read requests made for a four dwords of data
|
||||
(16B), per :ref:`normalization unit <normalization-units>`.
|
||||
|
||||
- Requests per :ref:`normalization unit <normalization-units>`
|
||||
|
||||
* - Read Requests (8 DWord)
|
||||
|
||||
- The total number of sL1D read requests made for a eight dwords of data
|
||||
(32B), per :ref:`normalization unit <normalization-units>`.
|
||||
|
||||
- Requests per :ref:`normalization unit <normalization-units>`
|
||||
|
||||
* - Read Requests (16 DWord)
|
||||
|
||||
- The total number of sL1D read requests made for a sixteen dwords of data
|
||||
(64B), per :ref:`normalization unit <normalization-units>`.
|
||||
|
||||
- Requests per :ref:`normalization unit <normalization-units>`
|
||||
.. jinja:: desc-sl1d-stats
|
||||
:file: _templates/metrics_table.j2
|
||||
|
||||
.. _desc-sl1d-l2-interface:
|
||||
|
||||
@@ -222,56 +94,8 @@ This panel gives more detail on the data requested across the
|
||||
sL1D↔
|
||||
:doc:`L2 <l2-cache>` interface.
|
||||
|
||||
.. list-table::
|
||||
:header-rows: 1
|
||||
|
||||
* - Metric
|
||||
|
||||
- Description
|
||||
|
||||
- Unit
|
||||
|
||||
* - sL1D-L2 BW
|
||||
|
||||
- The total number of bytes read from, written to, or atomically updated
|
||||
across the sL1D↔:doc:`L2 <l2-cache>` interface, per
|
||||
:ref:`normalization unit <normalization-units>`. Note that sL1D writes
|
||||
and atomics are typically unused on current CDNA accelerators, so in the
|
||||
majority of cases this can be interpreted as an sL1D→L2 read bandwidth.
|
||||
|
||||
- Bytes per :ref:`normalization unit <normalization-units>`
|
||||
|
||||
* - Read Requests
|
||||
|
||||
- The total number of read requests from sL1D to the :doc:`L2 <l2-cache>`,
|
||||
per :ref:`normalization unit <normalization-units>`.
|
||||
|
||||
- Requests per :ref:`normalization unit <normalization-units>`
|
||||
|
||||
* - Write Requests
|
||||
|
||||
- The total number of write requests from sL1D to the :doc:`L2 <l2-cache>`,
|
||||
per :ref:`normalization unit <normalization-units>`. Typically unused on
|
||||
current CDNA accelerators.
|
||||
|
||||
- Requests per :ref:`normalization unit <normalization-units>`
|
||||
|
||||
* - Atomic Requests
|
||||
|
||||
- The total number of atomic requests from sL1D to the
|
||||
:doc:`L2 <l2-cache>`, per
|
||||
:ref:`normalization unit <normalization-units>`. Typically unused on
|
||||
current CDNA accelerators.
|
||||
|
||||
- Requests per :ref:`normalization unit <normalization-units>`
|
||||
|
||||
* - Stall Cycles
|
||||
|
||||
- The total number of cycles the sL1D↔
|
||||
:doc:`L2 <l2-cache>` interface was stalled, per
|
||||
:ref:`normalization unit <normalization-units>`.
|
||||
|
||||
- Cycles per :ref:`normalization unit <normalization-units>`
|
||||
.. jinja:: desc-sl1d-l2-interface
|
||||
:file: _templates/metrics_table.j2
|
||||
|
||||
.. rubric:: Footnotes
|
||||
|
||||
@@ -318,46 +142,8 @@ The L1 Instruction Cache speed-of-light chart shows some key metrics of
|
||||
the L1I cache as a comparison with the peak achievable values of those
|
||||
metrics:
|
||||
|
||||
.. list-table::
|
||||
:header-rows: 1
|
||||
|
||||
* - Metric
|
||||
|
||||
- Description
|
||||
|
||||
- Unit
|
||||
|
||||
* - Bandwidth
|
||||
|
||||
- The number of bytes looked up in the L1I cache, as a percent of the peak
|
||||
theoretical bandwidth. Calculated as the ratio of L1I requests over the
|
||||
:ref:`total L1I cycles <total-l1i-cycles>`.
|
||||
|
||||
- Percent
|
||||
|
||||
* - Cache Hit Rate
|
||||
|
||||
- The percent of L1I requests that hit on a previously loaded line the
|
||||
cache. Calculated as the ratio of the number of L1I requests that hit
|
||||
[#l1i-cache]_ over the number of all L1I requests.
|
||||
|
||||
- Percent
|
||||
|
||||
* - L1I-L2 BW
|
||||
|
||||
- The percent of the peak theoretical L1I → L2 cache request bandwidth
|
||||
achieved. Calculated as the ratio of the total number of requests from
|
||||
the L1I to the L2 cache over the
|
||||
:ref:`total L1I-L2 interface cycles <total-l1i-cycles>`.
|
||||
|
||||
- Percent
|
||||
|
||||
* - Instruction Fetch Latency
|
||||
|
||||
- The average number of cycles spent to fetch instructions to a
|
||||
:doc:`CU <compute-unit>`.
|
||||
|
||||
- Cycles
|
||||
.. jinja:: desc-l1i-sol
|
||||
:file: _templates/metrics_table.j2
|
||||
|
||||
.. _desc-l1i-stats:
|
||||
|
||||
@@ -366,54 +152,10 @@ L1I cache accesses
|
||||
|
||||
This panel gives more detail on the hit/miss statistics of the L1I:
|
||||
|
||||
.. list-table::
|
||||
:header-rows: 1
|
||||
.. jinja:: desc-l1i-stats
|
||||
:file: _templates/metrics_table.j2
|
||||
|
||||
* - Metric
|
||||
|
||||
- Description
|
||||
|
||||
- Unit
|
||||
|
||||
* - Requests
|
||||
|
||||
- The total number of requests made to the L1I per
|
||||
:ref:`normalization-unit <normalization-units>`.
|
||||
|
||||
- Requests per :ref:`normalization unit <normalization-units>`.
|
||||
|
||||
* - Hits
|
||||
|
||||
- The total number of L1I requests that hit on a previously loaded cache
|
||||
line, per :ref:`normalization-unit <normalization-units>`.
|
||||
|
||||
- Requests per :ref:`normalization unit <normalization-units>`
|
||||
|
||||
* - Misses - Non Duplicated
|
||||
|
||||
- The total number of L1I requests that missed on a cache line that
|
||||
*were not* already pending due to another request, per
|
||||
:ref:`normalization-unit <normalization-units>`. See note in
|
||||
:ref:`desc-l1i-sol` for more detail.
|
||||
|
||||
- Requests per :ref:`normalization unit <normalization-units>`.
|
||||
|
||||
* - Misses - Duplicated
|
||||
|
||||
- The total number of L1I requests that missed on a cache line that *were*
|
||||
already pending due to another request, per
|
||||
:ref:`normalization-unit <normalization-units>`. See note in
|
||||
:ref:`desc-l1i-sol` for more detail.
|
||||
|
||||
- Requests per :ref:`normalization unit <normalization-units>`
|
||||
|
||||
* - Cache Hit Rate
|
||||
|
||||
- The percent of L1I requests that hit [#l1i-cache]_ on a previously loaded
|
||||
line the cache. Calculated as the ratio of the number of L1I requests
|
||||
that hit over the number of all L1I requests.
|
||||
|
||||
- Percent
|
||||
.. _desc-l1i-l2-interface:
|
||||
|
||||
L1I - L2 interface
|
||||
------------------
|
||||
@@ -421,21 +163,8 @@ L1I - L2 interface
|
||||
This panel gives more detail on the data requested across the
|
||||
L1I-:doc:`L2 <l2-cache>` interface.
|
||||
|
||||
.. list-table::
|
||||
:header-rows: 1
|
||||
|
||||
* - Metric
|
||||
|
||||
- Description
|
||||
|
||||
- Unit
|
||||
|
||||
* - L1I-L2 BW
|
||||
|
||||
- The total number of bytes read across the L1I-:doc:`L2 <l2-cache>`
|
||||
interface, per :ref:`normalization unit <normalization-units>`.
|
||||
|
||||
- Bytes per :ref:`normalization unit <normalization-units>`
|
||||
.. jinja:: desc-l1i-l2-interface
|
||||
:file: _templates/metrics_table.j2
|
||||
|
||||
.. rubric:: Footnotes
|
||||
|
||||
@@ -493,90 +222,18 @@ issuing concurrently).
|
||||
kernels). This means that these scheduler-pipe utilization metrics are
|
||||
expected to reach (for example) a maximum of one pipe active -- only 25%.
|
||||
|
||||
.. _spi-util:
|
||||
|
||||
Workgroup manager utilizations
|
||||
------------------------------
|
||||
|
||||
This section describes the utilization of the workgroup manager, and the
|
||||
hardware components it interacts with.
|
||||
|
||||
.. list-table::
|
||||
:header-rows: 1
|
||||
:widths: 20 65 15
|
||||
.. jinja:: spi-util
|
||||
:file: _templates/metrics_table.j2
|
||||
|
||||
* - Metric
|
||||
|
||||
- Description
|
||||
|
||||
- Unit
|
||||
|
||||
* - Accelerator utilization
|
||||
|
||||
- The percent of cycles in the kernel where the accelerator was actively
|
||||
doing any work.
|
||||
|
||||
- Percent
|
||||
|
||||
* - Scheduler-pipe utilization
|
||||
|
||||
- The percent of :ref:`total scheduler-pipe cycles <total-pipe-cycles>` in
|
||||
the kernel where the scheduler-pipes were actively doing any work. Note:
|
||||
this value is expected to range between 0% and 25%. See :ref:`desc-spi`.
|
||||
|
||||
- Percent
|
||||
|
||||
* - Workgroup manager utilization
|
||||
|
||||
- The percent of cycles in the kernel where the workgroup manager was
|
||||
actively doing any work.
|
||||
|
||||
- Percent
|
||||
|
||||
* - Shader engine utilization
|
||||
|
||||
- The percent of :ref:`total shader engine cycles <total-se-cycles>` in the
|
||||
kernel where any CU in a shader-engine was actively doing any work,
|
||||
normalized over all shader-engines. Low values (e.g., << 100%) indicate
|
||||
that the accelerator was not fully saturated by the kernel, or a
|
||||
potential load-imbalance issue.
|
||||
|
||||
- Percent
|
||||
|
||||
* - SIMD utilization
|
||||
|
||||
- The percent of :ref:`total SIMD cycles <total-simd-cycles>` in the kernel
|
||||
where any :ref:`SIMD <desc-valu>` on a CU was actively doing any work,
|
||||
summed over all CUs. Low values (less than 100%) indicate that the
|
||||
accelerator was not fully saturated by the kernel, or a potential
|
||||
load-imbalance issue.
|
||||
|
||||
- Percent
|
||||
|
||||
* - Dispatched workgroups
|
||||
|
||||
- The total number of workgroups forming this kernel launch.
|
||||
|
||||
- Workgroups
|
||||
|
||||
* - Dispatched wavefronts
|
||||
|
||||
- The total number of wavefronts, summed over all workgroups, forming this
|
||||
kernel launch.
|
||||
|
||||
- Wavefronts
|
||||
|
||||
* - VGPR writes
|
||||
|
||||
- The average number of cycles spent initializing :ref:`VGPRs <desc-valu>`
|
||||
at wave creation.
|
||||
|
||||
- Cycles/wave
|
||||
|
||||
* - SGPR Writes
|
||||
|
||||
- The average number of cycles spent initializing :ref:`SGPRs <desc-salu>`
|
||||
at wave creation.
|
||||
|
||||
- Cycles/wave
|
||||
.. _spi-resc-util:
|
||||
|
||||
Resource allocation
|
||||
-------------------
|
||||
@@ -590,117 +247,5 @@ limited by LDS usage, for example, but may still achieve high occupancy levels
|
||||
such that improving occupancy further may not improve performance. See
|
||||
:ref:`occupancy-example` for details.
|
||||
|
||||
.. list-table::
|
||||
:header-rows: 1
|
||||
|
||||
* - Metric
|
||||
|
||||
- Description
|
||||
|
||||
- Unit
|
||||
|
||||
* - Not-scheduled rate (Workgroup Manager)
|
||||
|
||||
- The percent of :ref:`total scheduler-pipe cycles <total-pipe-cycles>` in
|
||||
the kernel where a workgroup could not be scheduled to a
|
||||
:doc:`CU <compute-unit>` due to a bottleneck within the workgroup manager
|
||||
rather than a lack of a CU or :ref:`SIMD <desc-valu>` with sufficient
|
||||
resources. Note: this value is expected to range between 0-25%. See note
|
||||
in :ref:`workgroup manager <desc-spi>` description.
|
||||
|
||||
- Percent
|
||||
|
||||
* - Not-scheduled rate (Scheduler-Pipe)
|
||||
|
||||
- The percent of :ref:`total scheduler-pipe cycles <total-pipe-cycles>` in
|
||||
the kernel where a workgroup could not be scheduled to a
|
||||
:doc:`CU <compute-unit>` due to a bottleneck within the scheduler-pipes
|
||||
rather than a lack of a CU or :ref:`SIMD <desc-valu>` with sufficient
|
||||
resources. Note: this value is expected to range between 0-25%, see note
|
||||
in :ref:`workgroup manager <desc-spi>` description.
|
||||
|
||||
- Percent
|
||||
|
||||
* - Scheduler-Pipe Stall Rate
|
||||
|
||||
- The percent of :ref:`total scheduler-pipe cycles <total-pipe-cycles>` in
|
||||
the kernel where a workgroup could not be scheduled to a
|
||||
:doc:`CU <compute-unit>` due to occupancy limitations (like a lack of a
|
||||
CU or :ref:`SIMD <desc-valu>` with sufficient resources). Note: this
|
||||
value is expected to range between 0-25%, see note in
|
||||
:ref:`workgroup manager <desc-spi>` description.
|
||||
|
||||
- Percent
|
||||
|
||||
* - Scratch Stall Rate
|
||||
|
||||
- The percent of :ref:`total shader-engine cycles <total-se-cycles>` in the
|
||||
kernel where a workgroup could not be scheduled to a
|
||||
:doc:`CU <compute-unit>` due to lack of
|
||||
:ref:`private (a.k.a., scratch) memory <memory-type>` slots. While this
|
||||
can reach up to 100%, note that the actual occupancy limitations on a
|
||||
kernel using private memory are typically quite small (for example, less
|
||||
than 1% of the total number of waves that can be scheduled to an
|
||||
accelerator).
|
||||
|
||||
- Percent
|
||||
|
||||
* - Insufficient SIMD Waveslots
|
||||
|
||||
- The percent of :ref:`total SIMD cycles <total-simd-cycles>` in the kernel
|
||||
where a workgroup could not be scheduled to a :ref:`SIMD <desc-valu>`
|
||||
due to lack of available :ref:`waveslots <desc-valu>`.
|
||||
|
||||
- Percent
|
||||
|
||||
* - Insufficient SIMD VGPRs
|
||||
|
||||
- The percent of :ref:`total SIMD cycles <total-simd-cycles>` in the kernel
|
||||
where a workgroup could not be scheduled to a :ref:`SIMD <desc-valu>`
|
||||
due to lack of available :ref:`VGPRs <desc-valu>`.
|
||||
|
||||
- Percent
|
||||
|
||||
* - Insufficient SIMD SGPRs
|
||||
|
||||
- The percent of :ref:`total SIMD cycles <total-simd-cycles>` in the kernel
|
||||
where a workgroup could not be scheduled to a :ref:`SIMD <desc-valu>`
|
||||
due to lack of available :ref:`SGPRs <desc-salu>`.
|
||||
|
||||
- Percent
|
||||
|
||||
* - Insufficient CU LDS
|
||||
|
||||
- The percent of :ref:`total CU cycles <total-cu-cycles>` in the kernel
|
||||
where a workgroup could not be scheduled to a :doc:`CU <compute-unit>`
|
||||
due to lack of available :doc:`LDS <local-data-share>`.
|
||||
|
||||
- Percent
|
||||
|
||||
* - Insufficient CU Barriers
|
||||
|
||||
- The percent of :ref:`total CU cycles <total-cu-cycles>` in the kernel
|
||||
where a workgroup could not be scheduled to a :doc:`CU <compute-unit>`
|
||||
due to lack of available :ref:`barriers <desc-barrier>`.
|
||||
|
||||
- Percent
|
||||
|
||||
* - Reached CU Workgroup Limit
|
||||
|
||||
- The percent of :ref:`total CU cycles <total-cu-cycles>` in the kernel
|
||||
where a workgroup could not be scheduled to a :doc:`CU <compute-unit>`
|
||||
due to limits within the workgroup manager. This is expected to be
|
||||
always be zero on CDNA2 or newer accelerators (and small for previous
|
||||
accelerators).
|
||||
|
||||
- Percent
|
||||
|
||||
* - Reached CU Wavefront Limit
|
||||
|
||||
- The percent of :ref:`total CU cycles <total-cu-cycles>` in the kernel
|
||||
where a wavefront could not be scheduled to a :doc:`CU <compute-unit>`
|
||||
due to limits within the workgroup manager. This is expected to be
|
||||
always be zero on CDNA2 or newer accelerators (and small for previous
|
||||
accelerators).
|
||||
|
||||
- Percent
|
||||
.. jinja:: spi-resc-util
|
||||
:file: _templates/metrics_table.j2
|
||||
|
||||
Reference in New Issue
Block a user