Skip to content

fio: add xnvme engine

Ankit Kumar fio 2 versions – Applied

Status from this message: Applied, thanks!

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v2 Latest3 patches 5 repliesApplied
  2. v13 patches 3 repliesSuperseded

Changes in v2 from the cover letter

- Addressed review comments from Vincent.
- Improved error-logging and debugging by replacing XNVME_DEBUG with log_err, log_info and dprintf.
- Fixed issues when enabling iovec-payloads, now using io_u->mmap_data instead of io_u->engine_data as it gets overwritten by io_u->index.

Patches in v2 Applied

#Subject and filesSizeRepliesApplied
1/3engines/xnvme: add xnvme engineMakefile configure engines/xnvme.c +2 more+1016 -10 replies
2/3docs: documentation for xnvme ioengineHOWTO.rst fio.1+121 -40 replies
3/3examples: add example job file for xnvme engine usageexamples/xnvme-compare.fio examples/xnvme-zoned.fio+159 -00 replies

Reviews trailers per patch

None of the 3 patches has a Reviewed-by or Acked-by.

PatchAnkit KumarSimon A. F. LundMads YnddalMichael BangKarl Bonde TorpGurmeet SinghPierre Labat
1/3Co-Authored-By Co-Authored-By Co-Authored-By Co-Authored-By Co-Authored-By Co-Authored-By Co-Authored-By
2/3
3/3Co-Authored-By Co-Authored-By

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes. Scroll the table sideways for all 7 reviewers.

Read the v2 thread

Cover letter [PATCH v2 0/3] fio: add xnvme engine

This patch introduces a new xnvme fio engine.

xNVMe provides an API for synchronous and asynchronous I/O.
A library backs the API, libxnvme, which provides implementations for API users to run their I/O application on Linux, FreeBSD, macOS, and Windows without changing the application code.

Implementations of sync. interfaces include:
* psync (preadv/pwritev)
* Linux NVMe driver-ioctl
* FreeBSD NVMe driver-ioctl

Implementations of async. interfaces include:
* io_uring
* io_uring_cmd (experimental)
* libaio
* POSIX aio

In addition to the OS-managed interfaces, the library also utilize user-space NVMe-drivers
e.g. the SPDK NVMe/driver. Furthermore, "async-fallbacks" provide "async-emulation" in a sequential form and using a thread pool. Finally, a "nil" implementation is available to evaluate encapsulation/library overhead.

The xNVMe C API currently supports Windows interfaces: Windows Storport, IOCP, and experimental io_ring. However, these are not functional with the engine due to a few missing dependencies.

For more info on visit
https://xnvme.io
https://github.com/OpenMPDK/xNVMe

This patch also includes two example job files for Conventinal and ZNS specific commands.
In addition, it demonstrates how to instrument the engine to use different interfaces and with a user-space NVMe driver.

Changes since v1:
- Addressed review comments from Vincent.
- Improved error-logging and debugging by replacing XNVME_DEBUG with log_err, log_info and dprintf.
- Fixed issues when enabling iovec-payloads, now using io_u->mmap_data instead of io_u->engine_data as it gets overwritten by io_u->index.

Ankit Kumar (3):
engines/xnvme: add xnvme engine
docs: documentation for xnvme ioengine
examples: add example job file for xnvme engine usage

 HOWTO.rst                  |  55 ++-
 Makefile                   |   7 +-
 configure                  |  22 +
 engines/xnvme.c            | 981 +++++++++++++++++++++++++++++++++++++
 examples/xnvme-compare.fio |  72 +++
 examples/xnvme-zoned.fio   |  87 ++++
 fio.1                      |  70 ++-
 optgroup.h                 |   2 +
 options.c                  |   5 +
 9 files changed, 1296 insertions(+), 5 deletions(-)
 create mode 100644 engines/xnvme.c
 create mode 100644 examples/xnvme-compare.fio
 create mode 100644 examples/xnvme-zoned.fio
Signature · 1 line
2.17.1