Re: [PATCH v3] ndctl: daxctl: Adding io option for daxctl

[Ross Zwisler]

On Wed, Aug 23, 2017 at 11:20:40AM -0700, Dave Jiang wrote:
> The daxctl io option allows I/Os to be performed between file descriptor to
> and from device dax files. It also provides a way to zero a device dax
> device.
> 
> i.e. daxctl io --input=/home/myfile --output=/dev/dax1.0
> 
> Signed-off-by: Dave Jiang 
> ---
> 
> v3:
> - Added support for size suffix suggested by Ross.
> - Fixed the checking of __do_io() return value >32bit problem.
> 
> v2:
> - Removed dependency on ndctl to match device and address other comments
> by Dan.
> 
>  Documentation/daxctl/Makefile.am   |3 
>  Documentation/daxctl/daxctl-io.txt |   70 
>  daxctl/Makefile.am |5 
>  daxctl/daxctl.c|2 
>  daxctl/io.c|  576 
> 
>  5 files changed, 654 insertions(+), 2 deletions(-)
>  create mode 100644 Documentation/daxctl/daxctl-io.txt
>  create mode 100644 daxctl/io.c
> 
> diff --git a/Documentation/daxctl/Makefile.am 
> b/Documentation/daxctl/Makefile.am
> index 5913c94..032d48c 100644
> --- a/Documentation/daxctl/Makefile.am
> +++ b/Documentation/daxctl/Makefile.am
> @@ -16,7 +16,8 @@ asciidoc.conf: ../asciidoc.conf.in
>  
>  man1_MANS = \
>   daxctl.1 \
> - daxctl-list.1
> + daxctl-list.1 \
> + daxctl-io.1
>  
>  CLEANFILES = $(man1_MANS)
>  
> diff --git a/Documentation/daxctl/daxctl-io.txt 
> b/Documentation/daxctl/daxctl-io.txt
> new file mode 100644
> index 000..a7acc9e
> --- /dev/null
> +++ b/Documentation/daxctl/daxctl-io.txt
> @@ -0,0 +1,70 @@
> +daxctl-io(1)
> +===
> +
> +NAME
> +
> +daxctl-io - Perform I/O on Device-DAX devices or zero a Device-DAX device.
> +
> +SYNOPSIS
> +
> +[verse]
> +'daxctl io' []
> +
> +There must be a Device-DAX device involved whether as the input or the output
> +device. Read from a Device-DAX device and write to a file descriptor, or
> +another Device-DAX device. Write to a Device-DAX device from a file 
> descriptor
> +or another Device-DAX device.
> +
> +No length specified will default to input file/device length. If input is
> +a special char file then length will be the output file/device length.
> +
> +No input will default to stdin. No output will default to stdout.
> +
> +For a Device-DAX device, attempts to clear badblocks within range of writes
> +will be performed.
> +
> +EXAMPLE
> +---
> +[verse]
> +# daxctl io --zero /dev/dax1.0
> +
> +# daxctl io --input=/dev/dax1.0 --output=/home/myfile --len=2097152 
> --seek=4096

Probably want to update the example above and the --len documentation below to
show usage of a suffix and to include info about what suffixes are supported.

> +
> +# cat /dev/zero | daxctl io --output=/dev/dax1.0
> +
> +# daxctl io --input=/dev/zero --output=/dev/dax1.0 --skip=4096
> +
> +OPTIONS
> +---
> +-i::
> +--input=::
> + Input device or file to read from.
> +
> +-o::
> +--output=::
> + Output device or file to write to.
> +
> +-z::
> +--zero::
> + Zero the output device for 'len' size. Or the entire device if no
> + length was provided. The output device must be a Device DAX device.
> +
> +-l::
> +--len::
> + The length in bytes to perform the I/O.
> +
> +-s::
> +--seek::
> + The number of bytes to skip over on the output before performing a
> + write.
> +
> +-k::
> +--skip::
> + The number of bytes to skip over on the input before performing a read.
> +
> +COPYRIGHT
> +-
> +Copyright (c) 2017, Intel Corporation. License GPLv2: GNU GPL
> +version 2 .  This is free software:
> +you are free to change and redistribute it.  There is NO WARRANTY, to
> +the extent permitted by law.
___
Linux-nvdimm mailing list
Linux-nvdimm@lists.01.org
https://lists.01.org/mailman/listinfo/linux-nvdimm

[PATCH v3] ndctl: daxctl: Adding io option for daxctl

[Dave Jiang]

The daxctl io option allows I/Os to be performed between file descriptor to
and from device dax files. It also provides a way to zero a device dax
device.

i.e. daxctl io --input=/home/myfile --output=/dev/dax1.0

Signed-off-by: Dave Jiang 
---

v3:
- Added support for size suffix suggested by Ross.
- Fixed the checking of __do_io() return value >32bit problem.

v2:
- Removed dependency on ndctl to match device and address other comments
by Dan.

 Documentation/daxctl/Makefile.am   |3 
 Documentation/daxctl/daxctl-io.txt |   70 
 daxctl/Makefile.am |5 
 daxctl/daxctl.c|2 
 daxctl/io.c|  576 
 5 files changed, 654 insertions(+), 2 deletions(-)
 create mode 100644 Documentation/daxctl/daxctl-io.txt
 create mode 100644 daxctl/io.c

diff --git a/Documentation/daxctl/Makefile.am b/Documentation/daxctl/Makefile.am
index 5913c94..032d48c 100644
--- a/Documentation/daxctl/Makefile.am
+++ b/Documentation/daxctl/Makefile.am
@@ -16,7 +16,8 @@ asciidoc.conf: ../asciidoc.conf.in
 
 man1_MANS = \
daxctl.1 \
-   daxctl-list.1
+   daxctl-list.1 \
+   daxctl-io.1
 
 CLEANFILES = $(man1_MANS)
 
diff --git a/Documentation/daxctl/daxctl-io.txt 
b/Documentation/daxctl/daxctl-io.txt
new file mode 100644
index 000..a7acc9e
--- /dev/null
+++ b/Documentation/daxctl/daxctl-io.txt
@@ -0,0 +1,70 @@
+daxctl-io(1)
+===
+
+NAME
+
+daxctl-io - Perform I/O on Device-DAX devices or zero a Device-DAX device.
+
+SYNOPSIS
+
+[verse]
+'daxctl io' []
+
+There must be a Device-DAX device involved whether as the input or the output
+device. Read from a Device-DAX device and write to a file descriptor, or
+another Device-DAX device. Write to a Device-DAX device from a file descriptor
+or another Device-DAX device.
+
+No length specified will default to input file/device length. If input is
+a special char file then length will be the output file/device length.
+
+No input will default to stdin. No output will default to stdout.
+
+For a Device-DAX device, attempts to clear badblocks within range of writes
+will be performed.
+
+EXAMPLE
+---
+[verse]
+# daxctl io --zero /dev/dax1.0
+
+# daxctl io --input=/dev/dax1.0 --output=/home/myfile --len=2097152 --seek=4096
+
+# cat /dev/zero | daxctl io --output=/dev/dax1.0
+
+# daxctl io --input=/dev/zero --output=/dev/dax1.0 --skip=4096
+
+OPTIONS
+---
+-i::
+--input=::
+   Input device or file to read from.
+
+-o::
+--output=::
+   Output device or file to write to.
+
+-z::
+--zero::
+   Zero the output device for 'len' size. Or the entire device if no
+   length was provided. The output device must be a Device DAX device.
+
+-l::
+--len::
+   The length in bytes to perform the I/O.
+
+-s::
+--seek::
+   The number of bytes to skip over on the output before performing a
+   write.
+
+-k::
+--skip::
+   The number of bytes to skip over on the input before performing a read.
+
+COPYRIGHT
+-
+Copyright (c) 2017, Intel Corporation. License GPLv2: GNU GPL
+version 2 .  This is free software:
+you are free to change and redistribute it.  There is NO WARRANTY, to
+the extent permitted by law.
diff --git a/daxctl/Makefile.am b/daxctl/Makefile.am
index fe467d0..1ba1f07 100644
--- a/daxctl/Makefile.am
+++ b/daxctl/Makefile.am
@@ -5,10 +5,13 @@ bin_PROGRAMS = daxctl
 daxctl_SOURCES =\
daxctl.c \
list.c \
+   io.c \
../util/json.c
 
 daxctl_LDADD =\
lib/libdaxctl.la \
+   ../ndctl/lib/libndctl.la \
../libutil.a \
$(UUID_LIBS) \
-   $(JSON_LIBS)
+   $(JSON_LIBS) \
+   -lpmem
diff --git a/daxctl/daxctl.c b/daxctl/daxctl.c
index 91a4600..db2e495 100644
--- a/daxctl/daxctl.c
+++ b/daxctl/daxctl.c
@@ -67,11 +67,13 @@ static int cmd_help(int argc, const char **argv, void *ctx)
 }
 
 int cmd_list(int argc, const char **argv, void *ctx);
+int cmd_io(int argc, const char **argv, void *ctx);
 
 static struct cmd_struct commands[] = {
{ "version", cmd_version },
{ "list", cmd_list },
{ "help", cmd_help },
+   { "io", cmd_io },
 };
 
 int main(int argc, const char **argv)
diff --git a/daxctl/io.c b/daxctl/io.c
new file mode 100644
index 000..27e7463
--- /dev/null
+++ b/daxctl/io.c
@@ -0,0 +1,576 @@
+/*
+ * Copyright(c) 2015-2017 Intel Corporation. All rights reserved.
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of version 2 of the GNU General Public License as
+ * published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ */
+#include 
+#include 
+#include 
+#include 
+#inclu