[Nbd] [PATCH v2 1/3] NBD proto: add "Command flags" section
- To: nbd-general@lists.sourceforge.net
- Cc: "Denis V. Lunev" <den@...2317...>, w@...112..., qemu-devel@...530..., Pavel Borzenkov <pborzenkov@...2319...>
- Subject: [Nbd] [PATCH v2 1/3] NBD proto: add "Command flags" section
- From: Eric Blake <eblake@...696...>
- Date: Tue, 29 Mar 2016 17:00:58 -0600
- Message-id: <1459292460-6875-2-git-send-email-eblake@...696...>
- In-reply-to: <1459292460-6875-1-git-send-email-eblake@...696...>
- References: <1459173555-4890-1-git-send-email-eblake@...696...> <1459292460-6875-1-git-send-email-eblake@...696...>
From: Pavel Borzenkov <pborzenkov@...2319...>
Add separate "Command flags" section to make it clear which flags are
currently defined by the protocol.
Signed-off-by: Pavel Borzenkov <pborzenkov@...2319...>
Reviewed-by: Roman Kagan <rkagan@...2319...>
Signed-off-by: Denis V. Lunev <den@...2317...>
CC: Wouter Verhelst <w@...112...>
CC: Alex Bligh <alex@...872...>
Message-Id: <1459161798-32120-4-git-send-email-den@...2317...>
[rearrange subsections to parallel Handshake phase, add more details]
Signed-off-by: Eric Blake <eblake@...696...>
---
doc/proto.md | 14 ++++++++++++++
1 file changed, 14 insertions(+)
diff --git a/doc/proto.md b/doc/proto.md
index aaae0a2..3d49162 100644
--- a/doc/proto.md
+++ b/doc/proto.md
@@ -411,6 +411,20 @@ case that data is an error message suitable for display to the user.
### Transmission phase
+#### Command flags
+
+This field of 16 bits is sent by the client with every request and provides
+additional information to the server to execute the command. Refer to
+the "Request types" section below for more details about how a given flag
+affects a particular command. Clients MUST NOT set a command flag bit
+that is not documented for the particular command; and whether a flag is
+valid may depend on negotiation during the handshake phase.
+
+- bit 0, `NBD_CMD_FLAG_FUA`; valid during `NBD_CMD_WRITE`. SHOULD be
+ set to 1 if the client requires "Force Unit Access" mode of
+ operation. MUST NOT be set unless export flags included
+ `NBD_FLAG_SEND_FUA`.
+
#### Request types
The following request types exist:
--
2.5.5
Reply to: