Spdk/spdk_top at 2d629511f569e7dfb52071db161d68d0c09f0094 - Spdk

History

Krzysztof Karas a40a081d20 spdk_top: reduce number of core structures and refactor core functions Merge core_info into rpc_core_info to increase readability. Delete g_cores_history to reduce number of cores structures in spdk_top. Add temporary cores structure to get_cores_data() to fill with data from RPC call. This is to allow fields last_busy and last_idle in g_cores_stats.cores.core_info structure to retain their values and assign new ones with each data_thread_routine() loop. Change core display across spdk_top accordingly (change places where g_cores_history was used to use g_cores_stats instead) Delete get_core_last_stats(), because it is called only in one place and can be replaced with direct assignment of two values. Delete last_page variable from refresh_cores_tab. That variable was used to decide which core entries to update, and since we collect and update data for all entries elsewhere, this is not needed anymore. Signed-off-by: Krzysztof Karas <krzysztof.karas@intel.com> Change-Id: I4a5a4c90098401876b214068725a8fce29766a12 Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/6449 Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com> Community-CI: Mellanox Build Bot Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com> Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>		2021-07-21 07:27:32 +00:00
..
.gitignore	app: Initial patch for spdk_top application	2020-04-22 09:17:14 +00:00
Makefile	ARM64: Cross-Compilation Support	2021-07-13 08:58:42 +00:00
README	spdk_top: Add README file	2020-04-22 19:03:18 +00:00
spdk_top.c	spdk_top: reduce number of core structures and refactor core functions	2021-07-21 07:27:32 +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.