[virtio-comment] Re: [PATCH RFC v7 7/8] admin: document that structures can be shorter or longer

[Max Gurtovoy <mgurtovoy@nvidia.com>]

On 8/12/2022 8:19 PM, Michael S. Tsirkin wrote:
> ensures forward and backward compatibility as long as
> we tuck new structures at the end.
>
> Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
> ---
>   admin.tex | 6 ++++++
>   1 file changed, 6 insertions(+)
>
> diff --git a/admin.tex b/admin.tex
> index a0008c7..99b6c2a 100644
> --- a/admin.tex
> +++ b/admin.tex
> @@ -136,6 +136,12 @@ \subsection{Group administration commands}\label{sec:Basic Facilities of a Virti
>   holds the command specific error. If \field{status} is not set to VIRTIO_ADMIN_STATUS_CS_ERR, the
>   \field{command_specific_error} value is undefined and should be ignored by the driver.
>   
> +It is legal for the driver to submit commands with device-writeable and
> +device-readable structures both shorter and longer than what
> +is described in this specification. Device silently truncates the
> +structures to the shorter of the two (submitted by driver and
> +described in this specification).
> +

Why not limit this to only allow submitting longer structure provided by 
the driver ?

If the structures are shorter, return some error code that we will 
define (VIRTIO_ADMIN_STATUS_READABLE_DATA_SHORT, 
VIRTIO_ADMIN_STATUS_WRITABLE_DATA_SHORT).

Shorter data buffers can provide partial description to the device.

I'm trying not to restrict ourselves with this definition.

Driver that will start getting weird errors will not know what to do and 
why something went wrong.

>   \section{Administration Virtqueue}\label{sec:Basic Facilities of a Virtio Device / Group Administration Virtqueues}
>   
>   An administration virtqueue of a parent device is used to submit

This publicly archived list offers a means to provide input to the
OASIS Virtual I/O Device (VIRTIO) TC.

In order to verify user consent to the Feedback License terms and
to minimize spam in the list archive, subscription is required
before posting.

Subscribe: virtio-comment-subscribe@lists.oasis-open.org
Unsubscribe: virtio-comment-unsubscribe@lists.oasis-open.org
List help: virtio-comment-help@lists.oasis-open.org
List archive: https://lists.oasis-open.org/archives/virtio-comment/
Feedback License: https://www.oasis-open.org/who/ipr/feedback_license.pdf
List Guidelines: https://www.oasis-open.org/policies-guidelines/mailing-lists
Committee: https://www.oasis-open.org/committees/virtio/
Join OASIS: https://www.oasis-open.org/join/