Spdk/spdk_top at f869197b76ff6981e901b6d9a05789e1b993494a - Spdk

History

Krzysztof Karas 9494e8f54c spdk_top: allocate a copy of strings during thread display routine The display_thread() function is the only one that needs to use a copy of thread data, as threads might be moved between the cores during SPDK application lifetime. To avoid problems with using freed memory in the copied thread structures, make sure the data is always present, by allocating a copy of necessary strings. This will ensure that even after we have already freed the globals holding data from RPC, the pointers used to display the names and cpumasks will still have something to point to. Fixes #2635 Change-Id: If9228ee199a774d208ddd6ff846532be3ef2012d Signed-off-by: Krzysztof Karas <krzysztof.karas@intel.com> Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/14141 Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Dong Yi <dongx.yi@intel.com>		2022-08-25 07:31:06 +00:00
..
.gitignore	app: Initial patch for spdk_top application	2020-04-22 09:17:14 +00:00
Makefile	app: every app should have an (un)install target	2022-06-21 07:54:12 +00:00
README	spdk_top: Add README file	2020-04-22 19:03:18 +00:00
spdk_top.c	spdk_top: allocate a copy of strings during thread display routine	2022-08-25 07:31:06 +00:00

README

Contents
========

- Overview
- Installation
- Usage


Overview
========

This application provides SPDK live statistics regarding usage of cores,
threads, pollers, execution times, and relations between those. All data
is being gathered from SPDK by calling appropriate RPC calls. Application
consists of three selectable tabs providing statistics related to three
main topics:

- Threads
- Pollers
- Cores


Installation
============

spdk_top requires Ncurses library (can by installed by running
spdk/scripts/pkgdep.sh) and is compiled by default when SPDK compiles.



Usage
=====

To run spdk_top:

sudo spdk_top [options]

options:
 -r <path>  RPC listen address (optional, default: /var/tmp/spdk.sock)
 -h         show help message

Application consists of:
- Tabs list (on top)
- Statistics window (main windows in the middle)
- Options window (below statistics window)
- Page indicator / Error status

Tabs list shows available tabs and highlights currently selected tab.
Statistics window displays current statistics. Available statistics
depend on which tab is currently selected. All time and run counter
related statistics are relative - show elapsed time / number of runs
since previous data refresh. Options windows provide hotkeys list
to change application settings. Available options are:

- [q] Quit - quit the application
- [1-3] TAB selection - select tab to be displayed
- [PgUp] Previous page - go to previous page
- [PgDown] Next page - go to next page
- [c] Columns - select which columns should be visible / hidden:
  Use arrow up / down and space / enter keys to select which columns
  should be visible. Select 'CLOSE' to confirm changes and close
  the window.
- [s] Sorting - change data sorting:
  Use arrow up / down to select based on which column data should be
  sorted. Use enter key to confirm or esc key to exit without
  changing current sorting scheme.
- [r]  Refresh rate - change data refresh rate:
  Enter new data refresh rate value. Refresh rate accepts value
  between 0 and 255 seconds. Use enter key to apply or escape key
  to cancel.

Page indicator show current data page. Error status can be displayed
on bottom right side of the screen when the application encountered
an error.