Spdk/doc/index.md
Stephen Bates b94155c853 docs: Add documentation for peer-2-peer
In 35a331a9 we added a new API that enables peer-2-peer (P2P) copies
between NVMe SSDs using Controller Memory Buffers (CMBs) that support
DMA operations. Add documentation for the API, the example application
(cmb_copy) and for P2P setup and operation.

Note that this new API is currently marked experimental.

Change-Id: Ifeedb86d5b72b3aa7a6803b87c4d4709c54108f8
Signed-off-by: Stephen Bates <sbates@raithlin.com>
Reviewed-on: https://review.gerrithub.io/401961
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
2018-03-02 13:47:46 -05:00

55 lines
921 B
Markdown

# Storage Performance Development Kit {#index}
# Introduction {#intro}
- @ref about
- @ref getting_started
- @ref vagrant
- @ref changelog
- [Source Code (GitHub)](https://github.com/spdk/spdk/)
# Concepts {#concepts}
- @ref userspace
- @ref memory
- @ref concurrency
- @ref ssd_internals
- @ref porting
# User Guides {#user_guides}
- @ref iscsi
- @ref nvmf
- @ref vhost
- @ref bdev
- @ref blobfs
- @ref jsonrpc
# Programmer Guides {#general}
- @ref bdev_pg
- @ref bdev_module
- @ref directory_structure
- [Public API header files](files.html)
- @ref nvmf_tgt_pg
- @ref event
- @ref blob
# Miscellaneous {#misc}
- @ref peer_2_peer
# Modules {#modules}
- @ref nvme
- @ref ioat
- @ref virtio
# Tools {#tools}
- @ref nvme-cli
# Performance Reports {#performancereports}
- [SPDK 17.07 vhost-scsi Performance Report](https://ci.spdk.io/download/performance-reports/SPDK17_07_vhost_scsi_performance_report.pdf)