doc: update fio doc for xnvme engine
A message that is not in the archive (sent off-list or not yet received): CGME20220816054808epcas5p2295e7b76603cdd2183f9e2c2698cd90a@epcas5p2.samsung.com
cover *** Two small patches for xnvme I/O engine ***
Fix segmentation fault issue if thread=1 is not specified. Update the fio documentation.
Ankit Kumar (2):
engines/xnvme: fix segfault issue with xnvme ioengine
doc: update fio doc for xnvme engine
HOWTO.rst | 37 ++++++++++++++++++++++++++----------- engines/xnvme.c | 17 ++++++++++++++--- fio.1 | 34 +++++++++++++++++++++------------- 3 files changed, 61 insertions(+), 27 deletions(-)
Signature · 1 line
2.17.1
PATCH 1/2 engines/xnvme: fix segfault issue with xnvme ioengine
fix segfault when xnvme ioengine is called without thread=1. The segfault happens because td->io_ops_data is accessed at two locations xnvme_fioe_cleanup and xnvme_fioe_iomem_free, during the error handling call.
--- engines/xnvme.c | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-)
engines/xnvme.c +14 -3
@@ -205,9 +205,14 @@ static void _dev_close(struct thread_data *td, struct xnvme_fioe_fwrap *fwrap)static void xnvme_fioe_cleanup (struct thread_data *td) { -struct xnvme_fioe_data *xd = td->io_ops_data; +struct xnvme_fioe_data *xd =NULL ;int err; +if (!td->io_ops_data) +return ; + + xd = td->io_ops_data; + err =pthread_mutex_lock (&g_serialize);if (err)log_err ("ioeng->cleanup(): pthread_mutex_lock(), err(%d)\n" , err);
@@ -367,8 +372,14 @@ static int xnvme_fioe_iomem_alloc(struct thread_data *td, size_t total_mem)/* NOTE: using the first device for buffer-allocators) */ static void xnvme_fioe_iomem_free (struct thread_data *td) { -struct xnvme_fioe_data *xd = td->io_ops_data; -struct xnvme_fioe_fwrap *fwrap = &xd->files[0 ]; +struct xnvme_fioe_data *xd =NULL ; +struct xnvme_fioe_fwrap *fwrap =NULL ; + +if (!td->io_ops_data) +return ; + + xd = td->io_ops_data; + fwrap = &xd->files[0 ];if (!fwrap->dev) {log_err ("ioeng->iomem_free(): failed no dev-handle\n" );
Signature · 1 line
2.17.1
PATCH 2/2 doc: update fio doc for xnvme engine
In reply to Ankit Kumar- Elaborate about the various sync, async and admin interfaces.
- add missing io_uring_cmd async backend entry.
- xnvme ioengine doesn't support file stat.
--- HOWTO.rst | 37 ++++++++++++++++++++++++++----------- fio.1 | 34 +++++++++++++++++++++------------- 2 files changed, 47 insertions(+), 24 deletions(-)
HOWTO.rst +26 -11
@@ -2780,41 +2780,56 @@ with the caveat that when used on the command line, they must come after the Select the xnvme async command interface. This can take these values. **emu** - This is default and used to emulate asynchronous I/O. + This is default and use to emulate asynchronous I/O by using a + single thread to create a queue pair on top of a synchronous + I/O interface using the NVMe driver IOCTL. **thrpool** - Use thread pool for Asynchronous I/O. + Emulate an asynchronous I/O interface with a pool of userspace + threads on top of a synchronous I/O interface using the NVMe + driver IOCTL. By default four threads are used. **io_uring** - Use Linux io_uring/liburing for Asynchronous I/O. + Linux native asynchronous I/O interface which supports both + direct and buffered I/O. + **io_uring_cmd** + Fast Linux native asynchronous I/O interface for NVMe pass + through commands. This only works with NVMe character device + (/dev/ngXnY). **libaio** Use Linux aio for Asynchronous I/O. **posix** - Use POSIX aio for Asynchronous I/O. + Use the posix asynchronous I/O interface to perform one or + more I/O operations asynchronously. **nil** - Use nil-io; For introspective perf. evaluation + Do not transfer any data; just pretend to. This is mainly used + for introspective performance evaluation. .. option:: xnvme_sync=str : [xnvme] Select the xnvme synchronous command interface. This can take these values. **nvme** - This is default and uses Linux NVMe Driver ioctl() for synchronous I/O. + This is default and uses Linux NVMe Driver ioctl() for + synchronous I/O. **psync** - Use pread()/write() for synchronous I/O. + This supports regular as well as vectored pread() and pwrite() + commands. + **block** + This is the same as psync except that it also supports zone + management commands using Linux block layer IOCTLs. .. option:: xnvme_admin=str : [xnvme] Select the xnvme admin command interface. This can take these values. **nvme** - This is default and uses linux NVMe Driver ioctl() for admin commands. + This is default and uses linux NVMe Driver ioctl() for admin + commands. **block** Use Linux Block Layer ioctl() and sysfs for admin commands. - **file_as_ns** - Use file-stat to construct NVMe idfy responses. .. option:: xnvme_dev_nsid=int : [xnvme] - xnvme namespace identifier, for userspace NVMe driver. + xnvme namespace identifier for userspace NVMe driver, such as SPDK. .. option:: xnvme_iovec=int : [xnvme]
fio.1 +21 -13
@@ -2530,22 +2530,29 @@ Select the xnvme async command interface. This can take these values. .RS .TP .B emu -This is default and used to emulate asynchronous I/O +This is default and use to emulate asynchronous I/O by using a single thread to +create a queue pair on top of a synchronous I/O interface using the NVMe driver +IOCTL. .TP .BI thrpool -Use thread pool for Asynchronous I/O +Emulate an asynchronous I/O interface with a pool of userspace threads on top +of a synchronous I/O interface using the NVMe driver IOCTL. By default four +threads are used. .TP .BI io_uring -Use Linux io_uring/liburing for Asynchronous I/O +Linux native asynchronous I/O interface which supports both direct and buffered +I/O. .TP .BI libaio Use Linux aio for Asynchronous I/O .TP .BI posix -Use POSIX aio for Asynchronous I/O +Use the posix asynchronous I/O interface to perform one or more I/O operations +asynchronously. .TP .BI nil -Use nil-io; For introspective perf. evaluation +Do not transfer any data; just pretend to. This is mainly used for +introspective performance evaluation. .RE .RE .TP
@@ -2555,10 +2562,14 @@ Select the xnvme synchronous command interface. This can take these values. .RS .TP .B nvme -This is default and uses Linux NVMe Driver ioctl() for synchronous I/O +This is default and uses Linux NVMe Driver ioctl() for synchronous I/O. .TP .BI psync -Use pread()/write() for synchronous I/O +This supports regular as well as vectored pread() and pwrite() commands. +.TP +.BI block +This is the same as psync except that it also supports zone management +commands using Linux block layer IOCTLs. .RE .RE .TP
@@ -2568,18 +2579,15 @@ Select the xnvme admin command interface. This can take these values. .RS .TP .B nvme -This is default and uses Linux NVMe Driver ioctl() for admin commands +This is default and uses Linux NVMe Driver ioctl() for admin commands. .TP .BI block -Use Linux Block Layer ioctl() and sysfs for admin commands -.TP -.BI file_as_ns -Use file-stat as to construct NVMe idfy responses +Use Linux Block Layer ioctl() and sysfs for admin commands. .RE .RE .TP .BI (xnvme)xnvme_dev_nsid\fR=\fPint -xnvme namespace identifier, for userspace NVMe driver. +xnvme namespace identifier for userspace NVMe driver such as SPDK. .TP .BI (xnvme)xnvme_iovec If this option is set, xnvme will use vectored read/write commands.
Signature · 1 line
2.17.1
Jens Axboe
AppliedRe: [PATCH 0/2] *** Two small patches for xnvme I/O engine ***
In reply to Ankit KumarQuoted 8 lines · Ankit Kumar
Fix segmentation fault issue if thread=1 is not specified. Update the fio documentation.
Ankit Kumar (2):
engines/xnvme: fix segfault issue with xnvme ioengine
doc: update fio doc for xnvme engine[...]
Applied, thanks!
[1/2] engines/xnvme: fix segfault issue with xnvme ioengine
commit: fdac9c68425a7bd4008614476a27e536b0b0bf8b
[2/2] doc: update fio doc for xnvme engine
commit: 4deb92f9e1a83682143661eb3b04422bdfff5aceBest regards,
Signature · 1 line
Jens Axboe