From: Tvrtko Ursulin <tvrtko.ursulin@linux.intel.com> To: igt-dev@lists.freedesktop.org, Intel-gfx@lists.freedesktop.org Subject: [Intel-gfx] [PATCH i-g-t 1/6] intel_gpu_top: Fix man page formatting Date: Fri, 27 Jan 2023 11:12:36 +0000 [thread overview] Message-ID: <20230127111241.3624629-2-tvrtko.ursulin@linux.intel.com> (raw) In-Reply-To: <20230127111241.3624629-1-tvrtko.ursulin@linux.intel.com> From: Tvrtko Ursulin <tvrtko.ursulin@intel.com> New lines are not respected when rst2man generates the page so try to work around that by followin advice from the Internet. v2: * Improve some wording. * Tidy -o option description. * Update dates. * Convert the filter list to table. Signed-off-by: Tvrtko Ursulin <tvrtko.ursulin@intel.com> Reviewed-by: Kamil Konieczny <kamil.konieczny@linux.intel.com> # v1 --- man/intel_gpu_top.rst | 55 ++++++++++++++++++++----------------------- 1 file changed, 25 insertions(+), 30 deletions(-) diff --git a/man/intel_gpu_top.rst b/man/intel_gpu_top.rst index 748c7740c800..4417bcff0d5b 100644 --- a/man/intel_gpu_top.rst +++ b/man/intel_gpu_top.rst @@ -7,9 +7,9 @@ Display a top-like summary of Intel GPU usage --------------------------------------------- .. include:: defs.rst :Author: IGT Developers <igt-dev@lists.freedesktop.org> -:Date: 2020-03-18 +:Date: 2023-01-27 :Version: |PACKAGE_STRING| -:Copyright: 2009,2011,2012,2016,2018,2019,2020 Intel Corporation +:Copyright: 2009,2011,2012,2016,2018,2019,2020,2023 Intel Corporation :Manual section: |MANUAL_SECTION| :Manual group: |MANUAL_GROUP| @@ -23,7 +23,7 @@ DESCRIPTION **intel_gpu_top** is a tool to display usage information on Intel GPU's. -The tool gathers data using perf performance counters (PMU) exposed by i915 and other platform drivers like RAPL (power) and Uncore IMC (memory bandwidth). +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 ======= @@ -37,49 +37,44 @@ OPTIONS -l List plain text data. --o <file path | -> - Output to the specified file instead of standard output. - '-' can also be specified to explicitly select standard output. +-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 platform. + List available GPUs on the system. + -d - Select a specific GPU using supported filter. + Select a specific GPU using one of the supported filters. RUNTIME CONTROL =============== Supported keys: - 'q' Exit from the tool. - 'h' Show interactive help. - '1' Toggle between aggregated 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. +| +| '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. DEVICE SELECTION ================ -User can select specific GPU for performance monitoring on platform where multiple GPUs are available. -A GPU can be selected by sysfs path, drm node or using various PCI sub filters. - -Filter types: :: - - --- - filter syntax - --- - sys sys:/sys/devices/pci0000:00/0000:00:02.0 - find device by its sysfs path - - drm drm:/dev/dri/* path - find drm device by /dev/dri/* node +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. - pci pci:[vendor=%04x/name][,device=%04x][,card=%d] - vendor is hex number or vendor name +========== ====================================================== ====================== +**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 addrress. Vendor is hexadecinal number or vendor name. +========== ====================================================== ====================== JSON OUTPUT =========== -- 2.34.1
WARNING: multiple messages have this Message-ID (diff)
From: Tvrtko Ursulin <tvrtko.ursulin@linux.intel.com> To: igt-dev@lists.freedesktop.org, Intel-gfx@lists.freedesktop.org Cc: Tvrtko Ursulin <tvrtko.ursulin@intel.com> Subject: [igt-dev] [PATCH i-g-t 1/6] intel_gpu_top: Fix man page formatting Date: Fri, 27 Jan 2023 11:12:36 +0000 [thread overview] Message-ID: <20230127111241.3624629-2-tvrtko.ursulin@linux.intel.com> (raw) In-Reply-To: <20230127111241.3624629-1-tvrtko.ursulin@linux.intel.com> From: Tvrtko Ursulin <tvrtko.ursulin@intel.com> New lines are not respected when rst2man generates the page so try to work around that by followin advice from the Internet. v2: * Improve some wording. * Tidy -o option description. * Update dates. * Convert the filter list to table. Signed-off-by: Tvrtko Ursulin <tvrtko.ursulin@intel.com> Reviewed-by: Kamil Konieczny <kamil.konieczny@linux.intel.com> # v1 --- man/intel_gpu_top.rst | 55 ++++++++++++++++++++----------------------- 1 file changed, 25 insertions(+), 30 deletions(-) diff --git a/man/intel_gpu_top.rst b/man/intel_gpu_top.rst index 748c7740c800..4417bcff0d5b 100644 --- a/man/intel_gpu_top.rst +++ b/man/intel_gpu_top.rst @@ -7,9 +7,9 @@ Display a top-like summary of Intel GPU usage --------------------------------------------- .. include:: defs.rst :Author: IGT Developers <igt-dev@lists.freedesktop.org> -:Date: 2020-03-18 +:Date: 2023-01-27 :Version: |PACKAGE_STRING| -:Copyright: 2009,2011,2012,2016,2018,2019,2020 Intel Corporation +:Copyright: 2009,2011,2012,2016,2018,2019,2020,2023 Intel Corporation :Manual section: |MANUAL_SECTION| :Manual group: |MANUAL_GROUP| @@ -23,7 +23,7 @@ DESCRIPTION **intel_gpu_top** is a tool to display usage information on Intel GPU's. -The tool gathers data using perf performance counters (PMU) exposed by i915 and other platform drivers like RAPL (power) and Uncore IMC (memory bandwidth). +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 ======= @@ -37,49 +37,44 @@ OPTIONS -l List plain text data. --o <file path | -> - Output to the specified file instead of standard output. - '-' can also be specified to explicitly select standard output. +-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 platform. + List available GPUs on the system. + -d - Select a specific GPU using supported filter. + Select a specific GPU using one of the supported filters. RUNTIME CONTROL =============== Supported keys: - 'q' Exit from the tool. - 'h' Show interactive help. - '1' Toggle between aggregated 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. +| +| '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. DEVICE SELECTION ================ -User can select specific GPU for performance monitoring on platform where multiple GPUs are available. -A GPU can be selected by sysfs path, drm node or using various PCI sub filters. - -Filter types: :: - - --- - filter syntax - --- - sys sys:/sys/devices/pci0000:00/0000:00:02.0 - find device by its sysfs path - - drm drm:/dev/dri/* path - find drm device by /dev/dri/* node +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. - pci pci:[vendor=%04x/name][,device=%04x][,card=%d] - vendor is hex number or vendor name +========== ====================================================== ====================== +**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 addrress. Vendor is hexadecinal number or vendor name. +========== ====================================================== ====================== JSON OUTPUT =========== -- 2.34.1
next prev parent reply other threads:[~2023-01-27 11:12 UTC|newest] Thread overview: 43+ messages / expand[flat|nested] mbox.gz Atom feed top 2023-01-27 11:12 [Intel-gfx] [PATCH i-g-t 0/6] Assorted intel_gpu_top improvements Tvrtko Ursulin 2023-01-27 11:12 ` [igt-dev] " Tvrtko Ursulin 2023-01-27 11:12 ` Tvrtko Ursulin [this message] 2023-01-27 11:12 ` [igt-dev] [PATCH i-g-t 1/6] intel_gpu_top: Fix man page formatting Tvrtko Ursulin 2023-01-27 17:18 ` [Intel-gfx] " Kamil Konieczny 2023-01-27 17:18 ` [igt-dev] " Kamil Konieczny 2023-01-27 11:12 ` [Intel-gfx] [PATCH i-g-t 2/6] intel_gpu_top: Automatically enclose JSON output into brackets Tvrtko Ursulin 2023-01-27 11:12 ` [igt-dev] " Tvrtko Ursulin 2023-01-27 11:12 ` [Intel-gfx] [PATCH i-g-t 3/6] intel_gpu_top: Add command line switch to start in physical engine mode Tvrtko Ursulin 2023-01-27 11:12 ` [igt-dev] " Tvrtko Ursulin 2023-01-27 11:12 ` [Intel-gfx] [PATCH i-g-t 4/6] intel_gpu_top: Aggregate engine classes in all output modes Tvrtko Ursulin 2023-01-27 11:12 ` [igt-dev] " Tvrtko Ursulin 2023-01-27 11:12 ` [Intel-gfx] [PATCH i-g-t 5/6] intel_gpu_top: Fix cleanup on old kernels / unsupported GPU Tvrtko Ursulin 2023-01-27 11:12 ` [igt-dev] " Tvrtko Ursulin 2023-01-27 16:10 ` [Intel-gfx] " Kamil Konieczny 2023-01-27 16:10 ` [igt-dev] " Kamil Konieczny 2023-01-30 10:55 ` [Intel-gfx] [igt-dev] " Tvrtko Ursulin 2023-01-30 10:55 ` [igt-dev] [Intel-gfx] " Tvrtko Ursulin 2023-01-30 10:58 ` [Intel-gfx] [igt-dev] " Das, Nirmoy 2023-01-30 10:58 ` [igt-dev] [Intel-gfx] " Das, Nirmoy 2023-01-30 16:54 ` [Intel-gfx] [igt-dev] " Kamil Konieczny 2023-01-30 16:54 ` [igt-dev] [Intel-gfx] " Kamil Konieczny 2023-01-27 11:12 ` [Intel-gfx] [PATCH i-g-t 6/6] lib/igt_device_scan: Improve Intel discrete GPU selection Tvrtko Ursulin 2023-01-27 11:12 ` [igt-dev] " Tvrtko Ursulin 2023-01-27 11:39 ` [Intel-gfx] " Petri Latvala 2023-01-27 11:39 ` Petri Latvala 2023-01-27 11:53 ` [Intel-gfx] " Tvrtko Ursulin 2023-01-27 11:53 ` Tvrtko Ursulin 2023-01-27 13:41 ` [Intel-gfx] " Petri Latvala 2023-01-27 13:41 ` Petri Latvala 2023-01-27 16:17 ` [Intel-gfx] " Kamil Konieczny 2023-01-27 16:17 ` [igt-dev] " Kamil Konieczny 2023-01-30 11:04 ` [Intel-gfx] " Tvrtko Ursulin 2023-01-30 11:04 ` Tvrtko Ursulin 2023-01-30 16:51 ` [Intel-gfx] " Kamil Konieczny 2023-01-30 16:51 ` Kamil Konieczny 2023-01-30 6:30 ` [Intel-gfx] " Zbigniew Kempczyński 2023-01-30 6:30 ` [igt-dev] " Zbigniew Kempczyński 2023-01-27 12:16 ` [igt-dev] ✓ Fi.CI.BAT: success for Assorted intel_gpu_top improvements Patchwork 2023-01-27 14:33 ` [igt-dev] ✗ Fi.CI.IGT: failure " Patchwork 2023-01-30 12:28 ` Kamil Konieczny 2023-01-30 15:02 ` Yedireswarapu, SaiX Nandan 2023-01-30 13:51 ` [igt-dev] ✓ Fi.CI.IGT: success " Patchwork
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=20230127111241.3624629-2-tvrtko.ursulin@linux.intel.com \ --to=tvrtko.ursulin@linux.intel.com \ --cc=Intel-gfx@lists.freedesktop.org \ --cc=igt-dev@lists.freedesktop.org \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.