numam-spdk/doc
Yanbo Zhou 64ccd4b95b bdev: a new public function to get the I/O statistics of bdev
Add a new function and its RPC caller. By using it, we can
get the statistics of all the bdevs or the specified bdev.

Meanwhile, with this patch, the open source tool 'sysstat/iostat'
can support for SPDK. The 'iostat' tool can call this function to
get the statistics of all the SPDK managed devices via the rpc
interface.

Change-Id: I135a7bbd49d923014bdf93720f78dd5a588d7afa
Signed-off-by: Yanbo Zhou <yanbo.zhou@intel.com>
Reviewed-on: https://review.gerrithub.io/393130
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: Dariusz Stojaczyk <dariuszx.stojaczyk@intel.com>
Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
2018-05-23 17:49:21 +00:00
..
.gitignore doc: include changelog in documentation 2017-08-28 13:44:13 -04:00
about.md doc: Add an overview page for the project 2018-01-05 12:47:01 -05:00
bdev_module.md bdev: rename spdk_bdev_module_if -> spdk_bdev_module 2018-03-13 00:55:12 -04:00
bdev_pg.md doc: Programming guide for block device abstraction layer 2018-02-02 17:37:30 -05:00
bdev.md doc/virtio: add Virtio Block doc 2018-04-25 17:25:49 +00:00
blob.md doc: Programmer's guide template and example for blobstore 2018-03-19 11:40:08 -04:00
blobfs.md test: move test/lib/blobfs under test/blobfs 2018-03-23 19:45:09 -04:00
concurrency.md doc: Integrate concurrency and event framework docs 2018-02-02 17:41:20 -05:00
directory_structure.md vhost: Getting Started for SPDK vhost 2017-03-29 13:09:57 -07:00
Doxyfile spdkcli: initial version with bdev management 2018-04-20 13:25:21 -04:00
event.md lib: Return instead of exit in event 2018-03-08 11:47:01 -05:00
footer.html doc: simplify HTML header and stylesheet 2017-04-28 13:13:48 -07:00
getting_started.md test/unit: move unittest.sh and dependencies here. 2018-03-13 18:44:34 -04:00
header.html doc: simplify HTML header and stylesheet 2017-04-28 13:13:48 -07:00
index.md spdkcli: initial version with bdev management 2018-04-20 13:25:21 -04:00
ioat.md doc: flatten Markdown docs into chapter-per-file 2017-04-30 07:58:26 -07:00
iscsi.md test/config: add install VPP in vm_setup.sh 2018-04-09 17:45:31 -04:00
jsonrpc.md bdev: a new public function to get the I/O statistics of bdev 2018-05-23 17:49:21 +00:00
lvol.md lvol: add destroy_lvol_bdev RPC method 2018-04-24 21:33:56 +00:00
Makefile build/doc: add dependencies to 'output' rule 2018-02-15 11:10:55 -05:00
memory.md Add documentation explaining memory management 2017-06-15 14:11:58 -04:00
nvme-cli.md doc: update the nvme-cli user guide 2018-01-17 17:28:31 -05:00
nvme.md doc/nvme: fix typo in NVMe index page 2018-02-14 17:45:53 -05:00
nvmf_tgt_pg.md doc: Add the SPDK NVMe-oF Target Programming Guide 2018-02-02 17:41:20 -05:00
nvmf.md doc/nvmf: update readme to include nqn definition 2018-04-23 16:17:09 +00:00
peer_2_peer.md docs: Add documentation for peer-2-peer 2018-03-02 13:47:46 -05:00
porting.md doc: move porting guide into doc/ and add to index 2017-01-17 16:25:04 -07:00
README.md doc: Fix the verbage concerning prereqs 2018-02-14 17:38:48 -05:00
spdkcli.md spdkcli: initial version with bdev management 2018-04-20 13:25:21 -04:00
ssd_internals.md doc: Add some documentation about SSD internals 2018-01-30 19:26:29 -05:00
stylesheet.css doc: enable Doxygen tree view navigation 2017-10-31 18:00:12 -04:00
template_pg.md doc: Programmer's guide template and example for blobstore 2018-03-19 11:40:08 -04:00
userspace.md doc: Add an overview of user space drivers 2018-01-17 15:11:22 -05:00
vagrant.md test: move lib/nvme up one directory 2018-03-27 00:46:52 -04:00
vhost.md doc/vhost: add vhost-nvme target description 2018-04-20 15:24:50 -04:00
virtio.md doc/virtio: mention 2MB hugepage support 2018-04-25 17:25:49 +00:00

SPDK Documentation

The current version of the SPDK documentation can be found online at http://www.spdk.io/doc/

Building the Documentation

To convert the documentation into HTML run make in the doc directory. The output will be located in doc/output/html. Before running make ensure all pre-requisites are installed. See Installing Prerequisites for more details.