d/numam-spdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
1b837766f0
numam-spdk/doc/spdk_top.md

66 lines
4.6 KiB
Markdown
Raw Normal View History

doc/spdk_top: add spdk_top documentation Add documentation for the new spdk_top application Change-Id: I49a2ab3b354a1da6583f1b2aea4901cb38dd2363 Signed-off-by: John Kariuki <John.K.Kariuki@intel.com> Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/3254 Community-CI: Mellanox Build Bot Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com> Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com> Reviewed-by: Paul Luse <paul.e.luse@intel.com>
2016-06-23 05:43:48 +00:00
# spdk_top {#spdk_top}
The spdk_top application is designed to resemble the standard top in that it provides a real-time insights into CPU cores usage by SPDK lightweight threads and pollers. Have you ever wondered which CPU core is used most by your SPDK instance? Are you building your own bdev or library and want to know if your code is running efficiently? Are your new pollers busy most of the time? The spdk_top application uses RPC calls to collect performance metrics and displays them in a report that you can analyze and determine if your code is running efficiently so that you can tune your implementation and get more from SPDK.
Why doesn't the classic top utility work for SPDK? SPDK uses a polled-mode design; a reactor thread running on each CPU core assigned to an SPDK application schedules SPDK lightweight threads and pollers to run on the CPU core. Therefore, the standard Linux top utility is not effective for analyzing the CPU usage for polled-mode applications like SPDK because it just reports that they are using 100% of the CPU resources assigned to them. The spdk_top utility was developed to analyze and report the CPU cycles used to do real work vs just polling for work. The utility relies on instrumentation added to pollers to track when they are doing work vs. polling for work. The spdk_top utility gets the fine grained metrics from the pollers, analyzes and report the metrics on a per poller, thread and core basis. This information enables users to identify CPU cores that are busy doing real work so that they can determine if the application needs more or less CPU resources.
# Run spdk_top
spdk_top: update spdk_top docs for spdk.io Updates spdk_top documentation page to explain and present new features. Images are being deleted to make versioning easier. Signed-off-by: Krzysztof Karas <krzysztof.karas@intel.com> Change-Id: I6c3c172ed54423afc3afa4566b71ed19f0bc2e3e Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/6095 Community-CI: Mellanox Build Bot 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>
2021-01-26 10:19:53 +00:00
Before running spdk_top you need to run the SPDK application whose performance you want to analyze using spdk_top.
doc/spdk_top: add spdk_top documentation Add documentation for the new spdk_top application Change-Id: I49a2ab3b354a1da6583f1b2aea4901cb38dd2363 Signed-off-by: John Kariuki <John.K.Kariuki@intel.com> Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/3254 Community-CI: Mellanox Build Bot Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com> Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com> Reviewed-by: Paul Luse <paul.e.luse@intel.com>
2016-06-23 05:43:48 +00:00
Run the spdk_top application
~~~{.sh}
./build/bin/spdk_top
~~~
spdk_top: update spdk_top docs for spdk.io Updates spdk_top documentation page to explain and present new features. Images are being deleted to make versioning easier. Signed-off-by: Krzysztof Karas <krzysztof.karas@intel.com> Change-Id: I6c3c172ed54423afc3afa4566b71ed19f0bc2e3e Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/6095 Community-CI: Mellanox Build Bot 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>
2021-01-26 10:19:53 +00:00
# Bottom menu
Menu at the bottom of SPDK top window shows many options for changing displayed data. Each menu item has a key associated with it in square brackets.
* Quit - quits the SPDK top application.
* TAB selection - allows to select THREADS/POLLERS/CORES tabs.
* Previous page/Next page - scrolls up/down to the next set of rows displayed. Indicator in the bottom-left corner shows current page and number of all available pages.
* Columns - enables/disables chosen columns in a column pop-up window.
* Sorting - allows to sort displayed data by column in a sorting pop-up.
* Refresh rate - takes user input from 0 to 255 and changes refresh rate to that value in seconds.
* Item details - displays details pop-up window for highlighted data row. Selection is changed by pressing UP and DOWN arrow keys.
* Total/Interval - changes displayed values in all tabs to either Total time (measured since start of SPDK application) or Interval time (measured since last refresh).
doc/spdk_top: add spdk_top documentation Add documentation for the new spdk_top application Change-Id: I49a2ab3b354a1da6583f1b2aea4901cb38dd2363 Signed-off-by: John Kariuki <John.K.Kariuki@intel.com> Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/3254 Community-CI: Mellanox Build Bot Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com> Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com> Reviewed-by: Paul Luse <paul.e.luse@intel.com>
2016-06-23 05:43:48 +00:00
# Threads Tab
spdk_top: update spdk_top docs for spdk.io Updates spdk_top documentation page to explain and present new features. Images are being deleted to make versioning easier. Signed-off-by: Krzysztof Karas <krzysztof.karas@intel.com> Change-Id: I6c3c172ed54423afc3afa4566b71ed19f0bc2e3e Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/6095 Community-CI: Mellanox Build Bot 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>
2021-01-26 10:19:53 +00:00
The threads tab displays a line item for each spdk thread. The information displayed shows:
doc/spdk_top: add spdk_top documentation Add documentation for the new spdk_top application Change-Id: I49a2ab3b354a1da6583f1b2aea4901cb38dd2363 Signed-off-by: John Kariuki <John.K.Kariuki@intel.com> Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/3254 Community-CI: Mellanox Build Bot Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com> Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com> Reviewed-by: Paul Luse <paul.e.luse@intel.com>
2016-06-23 05:43:48 +00:00
spdk_top: update spdk_top docs for spdk.io Updates spdk_top documentation page to explain and present new features. Images are being deleted to make versioning easier. Signed-off-by: Krzysztof Karas <krzysztof.karas@intel.com> Change-Id: I6c3c172ed54423afc3afa4566b71ed19f0bc2e3e Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/6095 Community-CI: Mellanox Build Bot 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>
2021-01-26 10:19:53 +00:00
* Thread name - name of SPDK thread.
* Core - core on which the thread is currently running.
* Active/Timed/Paused pollers - number of pollers grouped by type on this thread.
* Idle/Busy - how many microseconds the thread was idle/busy.
doc/spdk_top: add spdk_top documentation Add documentation for the new spdk_top application Change-Id: I49a2ab3b354a1da6583f1b2aea4901cb38dd2363 Signed-off-by: John Kariuki <John.K.Kariuki@intel.com> Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/3254 Community-CI: Mellanox Build Bot Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com> Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com> Reviewed-by: Paul Luse <paul.e.luse@intel.com>
2016-06-23 05:43:48 +00:00
spdk_top: update spdk_top docs for spdk.io Updates spdk_top documentation page to explain and present new features. Images are being deleted to make versioning easier. Signed-off-by: Krzysztof Karas <krzysztof.karas@intel.com> Change-Id: I6c3c172ed54423afc3afa4566b71ed19f0bc2e3e Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/6095 Community-CI: Mellanox Build Bot 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>
2021-01-26 10:19:53 +00:00
\n
By pressing ENTER key a pop-up window appears, showing above and a list of pollers running on selected thread (with poller name, type, run count and period).
Pop-up then can be closed by pressing ESC key.
doc/spdk_top: add spdk_top documentation Add documentation for the new spdk_top application Change-Id: I49a2ab3b354a1da6583f1b2aea4901cb38dd2363 Signed-off-by: John Kariuki <John.K.Kariuki@intel.com> Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/3254 Community-CI: Mellanox Build Bot Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com> Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com> Reviewed-by: Paul Luse <paul.e.luse@intel.com>
2016-06-23 05:43:48 +00:00
spdk_top: update spdk_top docs for spdk.io Updates spdk_top documentation page to explain and present new features. Images are being deleted to make versioning easier. Signed-off-by: Krzysztof Karas <krzysztof.karas@intel.com> Change-Id: I6c3c172ed54423afc3afa4566b71ed19f0bc2e3e Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/6095 Community-CI: Mellanox Build Bot 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>
2021-01-26 10:19:53 +00:00
To learn more about spdk threads see @ref concurrency.
doc/spdk_top: add spdk_top documentation Add documentation for the new spdk_top application Change-Id: I49a2ab3b354a1da6583f1b2aea4901cb38dd2363 Signed-off-by: John Kariuki <John.K.Kariuki@intel.com> Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/3254 Community-CI: Mellanox Build Bot Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com> Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com> Reviewed-by: Paul Luse <paul.e.luse@intel.com>
2016-06-23 05:43:48 +00:00
spdk_top: update spdk_top docs for spdk.io Updates spdk_top documentation page to explain and present new features. Images are being deleted to make versioning easier. Signed-off-by: Krzysztof Karas <krzysztof.karas@intel.com> Change-Id: I6c3c172ed54423afc3afa4566b71ed19f0bc2e3e Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/6095 Community-CI: Mellanox Build Bot 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>
2021-01-26 10:19:53 +00:00
# Pollers Tab
The pollers tab displays a line item for each poller. The information displayed shows:
* Poller name - name of currently selected poller.
* Type - type of poller (Active/Paused/Timed).
* On thread - thread on which the poller is running.
* Run count - how many times poller was run.
* Period - poller period in microseconds. If period equals 0 then it is not displayed.
* Status - whether poller is currently Busy (red color) or Idle (blue color).
doc/spdk_top: add spdk_top documentation Add documentation for the new spdk_top application Change-Id: I49a2ab3b354a1da6583f1b2aea4901cb38dd2363 Signed-off-by: John Kariuki <John.K.Kariuki@intel.com> Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/3254 Community-CI: Mellanox Build Bot Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com> Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com> Reviewed-by: Paul Luse <paul.e.luse@intel.com>
2016-06-23 05:43:48 +00:00
spdk_top: update spdk_top docs for spdk.io Updates spdk_top documentation page to explain and present new features. Images are being deleted to make versioning easier. Signed-off-by: Krzysztof Karas <krzysztof.karas@intel.com> Change-Id: I6c3c172ed54423afc3afa4566b71ed19f0bc2e3e Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/6095 Community-CI: Mellanox Build Bot 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>
2021-01-26 10:19:53 +00:00
\n
Poller pop-up window can be displayed by pressing ENTER on a selected data row and displays above information.
Pop-up can be closed by pressing ESC key.
doc/spdk_top: add spdk_top documentation Add documentation for the new spdk_top application Change-Id: I49a2ab3b354a1da6583f1b2aea4901cb38dd2363 Signed-off-by: John Kariuki <John.K.Kariuki@intel.com> Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/3254 Community-CI: Mellanox Build Bot Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com> Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com> Reviewed-by: Paul Luse <paul.e.luse@intel.com>
2016-06-23 05:43:48 +00:00
spdk_top: update spdk_top docs for spdk.io Updates spdk_top documentation page to explain and present new features. Images are being deleted to make versioning easier. Signed-off-by: Krzysztof Karas <krzysztof.karas@intel.com> Change-Id: I6c3c172ed54423afc3afa4566b71ed19f0bc2e3e Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/6095 Community-CI: Mellanox Build Bot 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>
2021-01-26 10:19:53 +00:00
# Cores Tab
The cores tab provides insights into how the application is using the CPU cores assigned to it. The information displayed for each core shows:
doc/spdk_top: add spdk_top documentation Add documentation for the new spdk_top application Change-Id: I49a2ab3b354a1da6583f1b2aea4901cb38dd2363 Signed-off-by: John Kariuki <John.K.Kariuki@intel.com> Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/3254 Community-CI: Mellanox Build Bot Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com> Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com> Reviewed-by: Paul Luse <paul.e.luse@intel.com>
2016-06-23 05:43:48 +00:00
spdk_top: update spdk_top docs for spdk.io Updates spdk_top documentation page to explain and present new features. Images are being deleted to make versioning easier. Signed-off-by: Krzysztof Karas <krzysztof.karas@intel.com> Change-Id: I6c3c172ed54423afc3afa4566b71ed19f0bc2e3e Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/6095 Community-CI: Mellanox Build Bot 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>
2021-01-26 10:19:53 +00:00
* Core - core number.
* Thread count - number of threads currently running on core.
* Poller count - total number of pollers running on core.
* Idle/Busy - how many microseconds core was idle (including time when core ran pollers but did not find any work) or doing actual work.
doc/spdk_top: add spdk_top documentation Add documentation for the new spdk_top application Change-Id: I49a2ab3b354a1da6583f1b2aea4901cb38dd2363 Signed-off-by: John Kariuki <John.K.Kariuki@intel.com> Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/3254 Community-CI: Mellanox Build Bot Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com> Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com> Reviewed-by: Paul Luse <paul.e.luse@intel.com>
2016-06-23 05:43:48 +00:00
spdk_top: update spdk_top docs for spdk.io Updates spdk_top documentation page to explain and present new features. Images are being deleted to make versioning easier. Signed-off-by: Krzysztof Karas <krzysztof.karas@intel.com> Change-Id: I6c3c172ed54423afc3afa4566b71ed19f0bc2e3e Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/6095 Community-CI: Mellanox Build Bot 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>
2021-01-26 10:19:53 +00:00
\n
Pressing ENTER key makes a pop-up window appear, showing above information, along with a list of threads running on selected core. Cores details window allows to select a thread and display thread details pop-up on top of it. To close both pop-ups use ESC key.
Reference in New Issue Copy Permalink