[PATCH] Document syslet-rw engine

Signed-off-by: Jens Axboe <jens.axboe@oracle.com>

diff --git a/HOWTO b/HOWTO
index 38f5dcea06670849809efb94af69ea7eebee6b1b..e5b09fd6af18b11877aeb00a51c8fc84477afad3 100644 (file)
--- a/HOWTO
+++ b/HOWTO
@@ -49,7 +49,7 @@ bottom, it contains the following basic parameters:
 
        IO engine       How do we issue io? We could be memory mapping the
                        file, we could be using regular read/write, we
 
        IO engine       How do we issue io? We could be memory mapping the
                        file, we could be using regular read/write, we

-                       could be using splice, async io, or even
+                       could be using splice, async io, syslet, or even

                        SG (SCSI generic sg).
 
        IO depth        If the io engine is async, how large a queuing
                        SG (SCSI generic sg).
 
        IO depth        If the io engine is async, how large a queuing


@@ -270,6 +270,9 @@ ioengine=str        Defines how the job issues io to the file. The following
                                vmsplice(2) to transfer data from user
                                space to the kernel.
 
                                vmsplice(2) to transfer data from user
                                space to the kernel.
 

+                       syslet-rw Use the syslet system calls to make
+                               regular read/write async.
+

                        sg      SCSI generic sg v3 io. May either be
                                synchronous using the SG_IO ioctl, or if
                                the target is an sg character device
                        sg      SCSI generic sg v3 io. May either be
                                synchronous using the SG_IO ioctl, or if
                                the target is an sg character device

diff --git a/README b/README
index f7d7457732b0a8202d15a7637d328ca58d8fba34..0d7de7eb1ca7f5d02cc8713f68325a77632a8d7e 100644 (file)
--- a/README
+++ b/README
@@ -100,7 +100,8 @@ The job file parameters are:
        size=x          Set file size to x bytes (x string can include k/m/g)
        ioengine=x      'x' may be: aio/libaio/linuxaio for Linux aio,
                        posixaio for POSIX aio, sync for regular read/write io,
        size=x          Set file size to x bytes (x string can include k/m/g)
        ioengine=x      'x' may be: aio/libaio/linuxaio for Linux aio,
                        posixaio for POSIX aio, sync for regular read/write io,

-                       mmap for mmap'ed io, splice for using splice/vmsplice,
+                       mmap for mmap'ed io, syslet-rw for syslet driven
+                       read/write, splice for using splice/vmsplice,

                        sgio for direct SG_IO io, or net for network io. sgio
                        only works on Linux on SCSI (or SCSI-like devices,
                        such as usb-storage or sata/libata driven) devices.
                        sgio for direct SG_IO io, or net for network io. sgio
                        only works on Linux on SCSI (or SCSI-like devices,
                        such as usb-storage or sata/libata driven) devices.