fc250841ca
This patch only includes the basic framework for batching and the ability to batch one type of command, copy. Follow-on patches will add the ability to batch other commands and include an example of how to do so via the accel perf tool. SW engine support for batching will also come in a future patch. Documentation will also be coming. Batching allows the application to submit a list of independent descriptors to DSA with one single "batch" descriptor. This is beneficial when the application is in a position to have several operations ready at once; batching saves the overhead of submitting each one separately. The way batching works in SPDK is as follows: 1) The app gets a handle to a new batch with spdk_accel_batch_create() 2) The app uses that handle to prepare a command to be included in the batch. For copy the command is spdk_accel_batch_prep_copy(). The app many continue to prep commands for the batch up to the max via calling spdk_accel_batch_get_max() 3) The app then submits the batch with spdk_accel_batch_submit() 4) The callback provided for each command in the batch will be called as they complete, the callback provided to the batch submit itself will be called then the entire batch is done. Signed-off-by: paul luse <paul.e.luse@intel.com> Change-Id: I4102e9291fe59a245cedde6888f42a923b6dbafd Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/2248 Community-CI: Mellanox Build Bot Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> |
||
---|---|---|
.. | ||
img | ||
.gitignore | ||
about.md | ||
applications.md | ||
bdev_module.md | ||
bdev_pg.md | ||
bdev.md | ||
blob.md | ||
blobfs.md | ||
compression.md | ||
concepts.md | ||
concurrency.md | ||
containers.md | ||
Doxyfile | ||
driver_modules.md | ||
event.md | ||
footer.html | ||
ftl.md | ||
gdb_macros.md | ||
general.md | ||
getting_started.md | ||
header.html | ||
idxd.md | ||
index.md | ||
intro.md | ||
ioat.md | ||
iscsi.md | ||
jsonrpc_proxy.md | ||
jsonrpc.md | ||
libraries.md | ||
lvol.md | ||
Makefile | ||
memory.md | ||
misc.md | ||
notify.md | ||
nvme_spec.md | ||
nvme-cli.md | ||
nvme.md | ||
nvmf_tgt_pg.md | ||
nvmf_tracing.md | ||
nvmf.md | ||
overview.md | ||
peer_2_peer.md | ||
performance_reports.md | ||
porting.md | ||
prog_guides.md | ||
README.md | ||
spdkcli.md | ||
ssd_internals.md | ||
stylesheet.css | ||
system_configuration.md | ||
template_pg.md | ||
tools.md | ||
two.min.js | ||
user_guides.md | ||
userspace.md | ||
vagrant.md | ||
vhost_processing.md | ||
vhost.md | ||
virtio.md | ||
vmd.md | ||
vpp_integration.md |
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.