[PATCH] [PATCH RFC v1] Implements the Backend Program conventions for vhost-user-scsi

[PATCH] [PATCH RFC v1] Implements the Backend Program conventions for vhost-user-scsi

[Sakshi Kaushik]

Signed-off-by: Sakshi Kaushik <sakshikaushik717@gmail.com>
---
 docs/interop/vhost-user.json | 31 +++++++++++++++++++++++++++++++
 docs/interop/vhost-user.rst  | 17 +++++++++++++++++
 2 files changed, 48 insertions(+)

diff --git a/docs/interop/vhost-user.json b/docs/interop/vhost-user.json
index b6ade9e493..daf6a7c48e 100644
--- a/docs/interop/vhost-user.json
+++ b/docs/interop/vhost-user.json
@@ -88,6 +88,37 @@
   }
 }
 
+##
+# @VHostUserBackendSCSIFeature:
+#
+# List of vhost user "scsi" features.
+#
+# @read-only: The --read-only command line option is supported.
+# @scsi-file: The --scsi-file command line option is supported.
+#
+# Since: 5.0
+##
+{
+  'enum': 'VHostUserBackendSCSIFeature',
+  'data': [ 'read-only', 'scsi-file' ]
+}
+
+##
+# @VHostUserBackendCapabilitiesSCSI:
+#
+# Capabilities reported by vhost user "scsi" backends
+#
+# @features: list of supported features.
+#
+# Since: 5.0
+##
+{
+  'struct': 'VHostUserBackendCapabilitiesSCSI',
+  'data': {
+    'features': [ 'VHostUserBackendSCSIFeature' ]
+  }
+}
+
 ##
 # @VHostUserBackendInputFeature:
 #
diff --git a/docs/interop/vhost-user.rst b/docs/interop/vhost-user.rst
index 4dbc84fd00..6f6467ede8 100644
--- a/docs/interop/vhost-user.rst
+++ b/docs/interop/vhost-user.rst
@@ -1603,3 +1603,20 @@ Command line options:
   Enable read-only.
 
   (optional)
+
+vhost-user-scsi
+--------------
+
+Command line options:
+
+--scsi-file=PATH
+
+  Specify block device or file path.
+
+  (optional)
+
+--read-only
+
+  Enable read-only.
+
+  (optional)
-- 
2.17.1

Re: [PATCH] [PATCH RFC v1] Implements the Backend Program conventions for vhost-user-scsi

[Stefan Hajnoczi]

[-- Attachment #1: Type: text/plain, Size: 1471 bytes --]

On Thu, Mar 31, 2022 at 12:55:36AM -0500, Sakshi Kaushik wrote:
> Signed-off-by: Sakshi Kaushik <sakshikaushik717@gmail.com>
> ---
>  docs/interop/vhost-user.json | 31 +++++++++++++++++++++++++++++++
>  docs/interop/vhost-user.rst  | 17 +++++++++++++++++
>  2 files changed, 48 insertions(+)

Hi Sakshi,
Thanks for looking into this.

qemu-devel is a high-traffic list and maintainers rely on you to CC them
to get their attention so they don't have to read all emails. You can
use `scripts/get_maintainer.pl -f path/to/source/file.c` to find out who
to CC. Give it a try next time and that will help your patch get
reviews.

This patch defines features for some of the command-line options that
the contrib/vhost-user-scsi program has. It is likely that different
vhost-user-scsi implementations will have different command-line options
because they work in different ways (e.g. connecting to a distributed
storage system instead of a local file like --scsi-file). Therefore
standardizing these options is probably not necessary for
vhost-user-scsi.

(The reason why standard features are important is that some vhost-user
devices may have feature sets that are common across device
implementations. Unfortunately that's not the case here.)

It would be helpful to change
contrib/vhost-user-scsi/vhost-user-scsi.c:main()'s command-line
arguments to follow the vhost-user backend program conventions though.
If you have time to do that it would be great!

Thanks,
Stefan

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]