NAME

       intel_gpu_top - Display a top-like summary of Intel GPU usage

SYNOPSIS

       intel_gpu_top [OPTIONS]

DESCRIPTION

       intel_gpu_top is a tool to display usage information on Intel GPU's.

       The  tool  presents  data  collected  from performance counters (PMU), exposed by i915 and
       other platform drivers like RAPL (power) and Uncore IMC (memory bandwidth).

OPTIONS

       -h     Show help text.

       -c     Output CSV formatted data.

       -J     Output JSON formatted data.

       -l     List plain text data.

       -o <file>, or -o -
              Output to the specified file instead of standard output. '-' can also be  specified
              to explicitly select standard output.

       -s <ms>
              Refresh period in milliseconds.

       -L     List available GPUs on the system.

       -d     Select a specific GPU using one of the supported filters.

       -p     Default to showing physical engines instead of aggregated classes.

       -m     Default to showing all memory regions separately.

RUNTIME CONTROL

       Supported keys:

         'q'    Exit from the tool.
         'h'    Show interactive help.
         '1'    Toggle between aggregated by engine class and physical engine mode.
         'n'    Toggle display of numeric client busyness overlay.
         's'    Toggle between sort modes (runtime, total runtime, pid, client id).
         'i'    Toggle display of clients which used no GPU time.
         'H'    Toggle between per PID aggregation and individual clients.
         'm'    Toggle between aggregated memory regions and full breakdown.

DEVICE SELECTION

       On  systems  where multiple GPUs are present it is possible to select a specific GPU to be
       monitored. A GPU can be selected by sysfs path, drm device node or using various  PCI  sub
       filters.

          ┌───────┬────────────────────────────────────────────────┬──────────────────────────┐
          │Filter │ Syntax                                         │ GPU selection criteria   │
          ├───────┼────────────────────────────────────────────────┼──────────────────────────┤
          │sys    │ sys:/sys/devices/pci0000:00/0000:00:02.0       │ Select  using  the sysfs │
          │       │                                                │ path.                    │
          ├───────┼────────────────────────────────────────────────┼──────────────────────────┤
          │drm    │ drm:/dev/dri/<node>                            │ Select     using     the │
          │       │                                                │ /dev/dri/* device node.  │
          ├───────┼────────────────────────────────────────────────┼──────────────────────────┤
          │pci    │ pci:[vendor=%04x/name][,device=%04x][,card=%d] │ Select   using  the  PCI │
          │       │                                                │ address.    Vendor    is │
          │       │                                                │ hexadecinal   number  or │
          │       │                                                │ vendor name.             │
          └───────┴────────────────────────────────────────────────┴──────────────────────────┘

JSON OUTPUT

       JSON output will be correctly terminated when the tool cleanly exits, otherwise one square
       bracket needs to be added before parsing.

LIMITATIONS

       • Not all metrics are supported on all platforms. Where a metric is unsupported it's value
         will be replaced by a dashed line.

       • Non-root access to perf counters is controlled by the perf_event_paranoid sysctl.

REPORTING BUGS

       Report bugs on fd.o GitLab:  <https://gitlab.freedesktop.org/drm/igt-gpu-tools/-/issues>

AUTHOR

       IGT Developers <igt-dev@lists.freedesktop.org>

COPYRIGHT

       2009,2011,2012,2016,2018,2019,2020,2023 Intel Corporation