[virtio-comment] [PATCH] vsock: add documentation about len header field

[virtio-comment] [PATCH] vsock: add documentation about len header field

[Laura Loghin]

Signed-off-by: Laura Loghin <lauralg@amazon.com>
---
 virtio-vsock.tex | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/virtio-vsock.tex b/virtio-vsock.tex
index d79984d..e32cad8 100644
--- a/virtio-vsock.tex
+++ b/virtio-vsock.tex
@@ -107,6 +107,11 @@ \subsection{Device Operation}\label{sec:Device Types / Socket Device / Device Op
 #define VIRTIO_VSOCK_OP_CREDIT_REQUEST 7
 \end{lstlisting}
 
+\field{len} is the size of the payload, in bytes. However, the driver may
+provide buffer(s) for the payload that have a total size longer than
+\field{len}. If that is the case, only the first \field{len} bytes MUST be
+used for the actual data.
+
 \subsubsection{Virtqueue Flow Control}\label{sec:Device Types / Socket Device / Device Operation / Virtqueue Flow Control}
 
 The tx virtqueue carries packets initiated by applications and replies to
-- 
2.17.1




Amazon Development Center (Romania) S.R.L. registered office: 27A Sf. Lazar Street, UBC5, floor 2, Iasi, Iasi County, 700045, Romania. Registered in Romania. Registration number J22/2621/2005.


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/

Re: [virtio-comment] [PATCH] vsock: add documentation about len header field

[Stefano Garzarella]

Hi Laura,

On Tue, Mar 22, 2022 at 10:50 AM Laura Loghin <lauralg@amazon.com> wrote:
>
> Signed-off-by: Laura Loghin <lauralg@amazon.com>
> ---
>  virtio-vsock.tex | 5 +++++
>  1 file changed, 5 insertions(+)
>
> diff --git a/virtio-vsock.tex b/virtio-vsock.tex
> index d79984d..e32cad8 100644
> --- a/virtio-vsock.tex
> +++ b/virtio-vsock.tex
> @@ -107,6 +107,11 @@ \subsection{Device Operation}\label{sec:Device Types / Socket Device / Device Op
>  #define VIRTIO_VSOCK_OP_CREDIT_REQUEST 7
>  \end{lstlisting}
>
> +\field{len} is the size of the payload, in bytes. However, the driver may
> +provide buffer(s) for the payload that have a total size longer than
> +\field{len}. If that is the case, only the first \field{len} bytes MUST be
> +used for the actual data.
> +

IIUC MUST and friends are for normative sections, so I would remove
the last sentence.


Thanks,
Stefano


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/

Re: [virtio-comment] [PATCH] vsock: add documentation about len header field

[Laura Loghin]

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

On 3/28/22 14:09, Stefano Garzarella wrote:
> CAUTION: This email originated from outside of the organization. Do not click links or open attachments unless you can confirm the sender and know the content is safe.
>
>
>
> Hi Laura,
>
> On Tue, Mar 22, 2022 at 10:50 AM Laura Loghin<lauralg@amazon.com>  wrote:
>> Signed-off-by: Laura Loghin<lauralg@amazon.com>
>> ---
>>   virtio-vsock.tex | 5 +++++
>>   1 file changed, 5 insertions(+)
>>
>> diff --git a/virtio-vsock.tex b/virtio-vsock.tex
>> index d79984d..e32cad8 100644
>> --- a/virtio-vsock.tex
>> +++ b/virtio-vsock.tex
>> @@ -107,6 +107,11 @@ \subsection{Device Operation}\label{sec:Device Types / Socket Device / Device Op
>>   #define VIRTIO_VSOCK_OP_CREDIT_REQUEST 7
>>   \end{lstlisting}
>>
>> +\field{len} is the size of the payload, in bytes. However, the driver may
>> +provide buffer(s) for the payload that have a total size longer than
>> +\field{len}. If that is the case, only the first \field{len} bytes MUST be
>> +used for the actual data.
>> +
> IIUC MUST and friends are for normative sections, so I would remove
> the last sentence.

You're right, I'll remove it. It should already be clear enough only the
first len bytes need to be used for the payload.

Thanks,
Laura

>
>
> Thanks,
> Stefano
>



Amazon Development Center (Romania) S.R.L. registered office: 27A Sf. Lazar Street, UBC5, floor 2, Iasi, Iasi County, 700045, Romania. Registered in Romania. Registration number J22/2621/2005.

[-- Attachment #2: Type: text/html, Size: 2293 bytes --]

Re: [virtio-comment] [PATCH] vsock: add documentation about len header field

[Cornelia Huck]

On Tue, Mar 29 2022, Laura Loghin <lauralg@amazon.com> wrote:

> On 3/28/22 14:09, Stefano Garzarella wrote:
>> CAUTION: This email originated from outside of the organization. Do not click links or open attachments unless you can confirm the sender and know the content is safe.
>>
>>
>>
>> Hi Laura,
>>
>> On Tue, Mar 22, 2022 at 10:50 AM Laura Loghin<lauralg@amazon.com>  wrote:
>>> Signed-off-by: Laura Loghin<lauralg@amazon.com>
>>> ---
>>>   virtio-vsock.tex | 5 +++++
>>>   1 file changed, 5 insertions(+)
>>>
>>> diff --git a/virtio-vsock.tex b/virtio-vsock.tex
>>> index d79984d..e32cad8 100644
>>> --- a/virtio-vsock.tex
>>> +++ b/virtio-vsock.tex
>>> @@ -107,6 +107,11 @@ \subsection{Device Operation}\label{sec:Device Types / Socket Device / Device Op
>>>   #define VIRTIO_VSOCK_OP_CREDIT_REQUEST 7
>>>   \end{lstlisting}
>>>
>>> +\field{len} is the size of the payload, in bytes. However, the driver may
>>> +provide buffer(s) for the payload that have a total size longer than
>>> +\field{len}. If that is the case, only the first \field{len} bytes MUST be
>>> +used for the actual data.
>>> +
>> IIUC MUST and friends are for normative sections, so I would remove
>> the last sentence.
>
> You're right, I'll remove it. It should already be clear enough only the
> first len bytes need to be used for the payload.

Another option would be

"However, the driver may provide buffer(s) for the payload that have a
total size longer than \field{len}, in which case only the first
\field{len} bytes will be used for the actual data."


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/

Re: [virtio-comment] [PATCH] vsock: add documentation about len header field

[Laura Loghin]

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

On 4/6/22 11:32, Cornelia Huck wrote:
> CAUTION: This email originated from outside of the organization. Do not click links or open attachments unless you can confirm the sender and know the content is safe.
>
>
>
> On Tue, Mar 29 2022, Laura Loghin<lauralg@amazon.com>  wrote:
>
>> On 3/28/22 14:09, Stefano Garzarella wrote:
>>> CAUTION: This email originated from outside of the organization. Do not click links or open attachments unless you can confirm the sender and know the content is safe.
>>>
>>>
>>>
>>> Hi Laura,
>>>
>>> On Tue, Mar 22, 2022 at 10:50 AM Laura Loghin<lauralg@amazon.com>   wrote:
>>>> Signed-off-by: Laura Loghin<lauralg@amazon.com>
>>>> ---
>>>>    virtio-vsock.tex | 5 +++++
>>>>    1 file changed, 5 insertions(+)
>>>>
>>>> diff --git a/virtio-vsock.tex b/virtio-vsock.tex
>>>> index d79984d..e32cad8 100644
>>>> --- a/virtio-vsock.tex
>>>> +++ b/virtio-vsock.tex
>>>> @@ -107,6 +107,11 @@ \subsection{Device Operation}\label{sec:Device Types / Socket Device / Device Op
>>>>    #define VIRTIO_VSOCK_OP_CREDIT_REQUEST 7
>>>>    \end{lstlisting}
>>>>
>>>> +\field{len} is the size of the payload, in bytes. However, the driver may
>>>> +provide buffer(s) for the payload that have a total size longer than
>>>> +\field{len}. If that is the case, only the first \field{len} bytes MUST be
>>>> +used for the actual data.
>>>> +
>>> IIUC MUST and friends are for normative sections, so I would remove
>>> the last sentence.
>> You're right, I'll remove it. It should already be clear enough only the
>> first len bytes need to be used for the payload.
> Another option would be
>
> "However, the driver may provide buffer(s) for the payload that have a
> total size longer than \field{len}, in which case only the first
> \field{len} bytes will be used for the actual data."
>
Sounds better, thanks for the suggestion! Just sent a new version.

Laura



Amazon Development Center (Romania) S.R.L. registered office: 27A Sf. Lazar Street, UBC5, floor 2, Iasi, Iasi County, 700045, Romania. Registered in Romania. Registration number J22/2621/2005.

[-- Attachment #2: Type: text/html, Size: 2962 bytes --]