All of lore.kernel.org
 help / color / mirror / Atom feed
From: Vincent Fu <vincent.fu@samsung.com>
To: "axboe@kernel.dk" <axboe@kernel.dk>,
	"fio@vger.kernel.org" <fio@vger.kernel.org>
Cc: Vincent Fu <vincent.fu@samsung.com>
Subject: [PATCH 3/6] sg: improve sg_write_mode option names
Date: Mon, 15 Nov 2021 20:07:17 +0000	[thread overview]
Message-ID: <20211115200807.117138-4-vincent.fu@samsung.com> (raw)
In-Reply-To: <20211115200807.117138-1-vincent.fu@samsung.com>

There is a name collision for the sg_write_mode options for the WRITE AND
VERIFY and VERIFY commands. Deprecate the 'verify' option and use
'write_and_verify' instead. Do the same thing for 'same' and 'write_same' to
have a consistent naming scheme. The original option names are still supported
for backward compatibility but list them as deprecated.

Here are the new sg_write_mode options:

Option			SCSI command
write			WRITE (default)
write_and_verify	WRITE AND VERIFY
verify (deprecated)	WRITE AND VERIFY
write_same		WRITE SAME
same (deprecated)	WRITE SAME
write_same_ndob         WRITE SAME with NDOB flag set
verify_bytchk_00	VERIFY with BYTCHK set to 00
verify_bytchk_01	VERIFY with BYTCHK set to 01
verify_bytchk_11	VERIFY with BYTCHK set to 11

Signed-off-by: Vincent Fu <vincent.fu@samsung.com>
---
 HOWTO        |  8 ++++++--
 engines/sg.c | 14 ++++++++++++--
 fio.1        | 10 ++++++++--
 3 files changed, 26 insertions(+), 6 deletions(-)

diff --git a/HOWTO b/HOWTO
index 3c507d50..0f204afa 100644
--- a/HOWTO
+++ b/HOWTO
@@ -2486,11 +2486,13 @@ with the caveat that when used on the command line, they must come after the
 
 	**write**
 		This is the default where write opcodes are issued as usual.
-	**verify**
+	**write_and_verify**
 		Issue WRITE AND VERIFY commands. The BYTCHK bit is set to 0. This
 		directs the device to carry out a medium verification with no data
 		comparison. The writefua option is ignored with this selection.
-	**same**
+	**verify**
+		This option is deprecated. Use write_and_verify instead.
+	**write_same**
 		Issue WRITE SAME commands. This transfers a single block to the device
 		and writes this same block of data to a contiguous sequence of LBAs
 		beginning at the specified offset. fio's block size parameter specifies
@@ -2501,6 +2503,8 @@ with the caveat that when used on the command line, they must come after the
 		for each command but only the first 512 bytes will be used and
 		transferred to the device. The writefua option is ignored with this
 		selection.
+	**same**
+		This option is deprecated. Use write_same instead.
 	**write_same_ndob**
 		Issue WRITE SAME(16) commands as above but with the No Data Output
 		Buffer (NDOB) bit set. No data will be transferred to the device with
diff --git a/engines/sg.c b/engines/sg.c
index 3c4e986d..d15b438f 100644
--- a/engines/sg.c
+++ b/engines/sg.c
@@ -124,14 +124,24 @@ static struct fio_option options[] = {
 			    .oval = FIO_SG_WRITE,
 			    .help = "Issue standard SCSI WRITE commands",
 			  },
-			  { .ival = "verify",
+			  { .ival = "write_and_verify",
 			    .oval = FIO_SG_WRITE_VERIFY,
 			    .help = "Issue SCSI WRITE AND VERIFY commands",
 			  },
-			  { .ival = "same",
+			  { .ival = "verify",
+			    .oval = FIO_SG_WRITE_VERIFY,
+			    .help = "Issue SCSI WRITE AND VERIFY commands. This "
+				    "option is deprecated. Use write_and_verify instead.",
+			  },
+			  { .ival = "write_same",
 			    .oval = FIO_SG_WRITE_SAME,
 			    .help = "Issue SCSI WRITE SAME commands",
 			  },
+			  { .ival = "same",
+			    .oval = FIO_SG_WRITE_SAME,
+			    .help = "Issue SCSI WRITE SAME commands. This "
+				    "option is deprecated. Use write_same instead.",
+			  },
 			  { .ival = "write_same_ndob",
 			    .oval = FIO_SG_WRITE_SAME_NDOB,
 			    .help = "Issue SCSI WRITE SAME(16) commands with NDOB flag set",
diff --git a/fio.1 b/fio.1
index b1af6e8f..71f98135 100644
--- a/fio.1
+++ b/fio.1
@@ -2289,12 +2289,15 @@ values:
 .B write (default)
 Write opcodes are issued as usual
 .TP
-.B verify
+.B write_and_verify
 Issue WRITE AND VERIFY commands. The BYTCHK bit is set to 00b. This directs the
 device to carry out a medium verification with no data comparison for the data
 that was written. The writefua option is ignored with this selection.
 .TP
-.B same
+.B verify
+This option is deprecated. Use write_and_verify instead.
+.TP
+.B write_same
 Issue WRITE SAME commands. This transfers a single block to the device
 and writes this same block of data to a contiguous sequence of LBAs
 beginning at the specified offset. fio's block size parameter
@@ -2306,6 +2309,9 @@ generate 8k of data for each command butonly the first 512 bytes will
 be used and transferred to the device. The writefua option is ignored
 with this selection.
 .TP
+.B same
+This option is deprecated. Use write_same instead.
+.TP
 .B write_same_ndob
 Issue WRITE SAME(16) commands as above but with the No Data Output
 Buffer (NDOB) bit set. No data will be transferred to the device with
-- 
2.25.1

  parent reply	other threads:[~2021-11-15 21:14 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <CGME20211115200821uscas1p12939025b77aaf0ec414bf1427cf1b72a@uscas1p1.samsung.com>
2021-11-15 20:07 ` [PATCH 0/6] additional sg ionegine commands Vincent Fu
     [not found]   ` <CGME20211115200821uscas1p1319ea93782358999fb69feb0f2f2c087@uscas1p1.samsung.com>
2021-11-15 20:07     ` [PATCH 2/6] sg: add support for WRITE SAME(16) commands with NDOB flag set Vincent Fu
     [not found]   ` <CGME20211115200821uscas1p2e7dc56386571a492e3379b718ca2770c@uscas1p2.samsung.com>
2021-11-15 20:07     ` [PATCH 1/6] sg: add support for VERIFY command using write modes Vincent Fu
     [not found]   ` <CGME20211115200821uscas1p28671af8f28d8326c7dd2dc2ff1204d4b@uscas1p2.samsung.com>
2021-11-15 20:07     ` [PATCH 4/6] sg: add support for WRITE STREAM(16) commands Vincent Fu
     [not found]   ` <CGME20211115200822uscas1p2795a33fbed15d3f1b6029116a8123d05@uscas1p2.samsung.com>
2021-11-15 20:07     ` [PATCH 6/6] docs: documentation for sg WRITE STREAM(16) Vincent Fu
     [not found]   ` <CGME20211115200822uscas1p16f41fc3283e4f36e668ff9ea189f16c5@uscas1p1.samsung.com>
2021-11-15 20:07     ` [PATCH 5/6] sg: allow fio to open and close streams for WRITE STREAM(16) commands Vincent Fu
     [not found]   ` <CGME20211115200821uscas1p209c5e40580f1e5a6328f1a725f887f0f@uscas1p2.samsung.com>
2021-11-15 20:07     ` Vincent Fu [this message]
     [not found]   ` <CGME20211129152026uscas1p1c9f4f5b6d00f3b0eea2d2b6d9868fcc6@uscas1p1.samsung.com>
2021-11-29 15:19     ` [PATCH 0/6] additional sg ionegine commands Vincent Fu
     [not found]   ` <CGME20220118130352uscas1p1a51e58ff20951777a16d2d201d63cbdb@uscas1p1.samsung.com>
2022-01-18 13:02     ` Vincent Fu
2022-01-18 13:37   ` Jens Axboe

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20211115200807.117138-4-vincent.fu@samsung.com \
    --to=vincent.fu@samsung.com \
    --cc=axboe@kernel.dk \
    --cc=fio@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.