Skip to contentSkip to conversation

virtio-vsock: add max payload size config field

PATCH Superseded Laura Loghin 2 participants 4 messages Apr 13, 2022 – Apr 21, 2022

v2 of 5 Superseded Latest is v5 →

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 virtio-vsock: add max payload size config field

Added a new field to the vsock device config space that is limiting the size of the packet payload. This way the driver is not allowed to allocate huge buffers, and potentially fill up the entire memory.
Also defined a new feature bit for this, VIRTIO_VSOCK_F_SIZE_MAX, in order to keep backwards compatibility.

---
 virtio-vsock.tex | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
virtio-vsock.tex +27 -0
index d79984d..e6903bd 100644
@@ -23,6 +23,10 @@ \subsection{Feature bits}\label{sec:Device Types / Socket Device / Feature bits}
 \begin{description}
 \item[VIRTIO_VSOCK_F_STREAM (0)] stream socket type is supported.
 \item[VIRTIO_VSOCK_F_SEQPACKET (1)] seqpacket socket type is supported.
+\item[VIRTIO_VSOCK_F_SIZE_MAX (2)] Maximum size of the packet payload is in
+	\field{data_max_size}. If offered by the device, device advises driver
+	about the value of its maximum payload size. If negotiated, the driver uses
+	\field{data_max_size} as the maximum packet payload size value.
 \end{description}
 
 \subsection{Device configuration layout}\label{sec:Device Types / Socket Device / Device configuration layout}
@@ -32,6 +36,7 @@ \subsection{Device configuration layout}\label{sec:Device Types / Socket Device
 \begin{lstlisting}
 struct virtio_vsock_config {
 	le64 guest_cid;
+	le32 data_max_size;
 };
 \end{lstlisting}
 
@@ -57,6 +62,28 @@ \subsection{Device configuration layout}\label{sec:Device Types / Socket Device
 \hline
 \end{tabular}
 
+The following driver-read-only field, \field{data_max_size} only exists if
+VIRTIO_VSOCK_F_SIZE_MAX is set. This field specifies the maximum packet payload
+size for the driver to use.
+
+\devicenormative{\subsubsection}{Device configuration layout}{Device Types / Socket Device / Device configuration layout}
+
+The device MUST NOT change the value exposed through \field{data_max_size}.
+
+The device MUST forward transmitted packets of up to \field{data_max_size}
+(plus header length) size after VIRTIO_VSOCK_F_SIZE_MAX has been successfully
+negotiated.
+
+\drivernormative{\subsubsection}{Device configuration layout}{Device Types / Socket Device / Device configuration layout}
+
+A driver SHOULD negotiate VIRTIO_VSOCK_F_SIZE_MAX if the device offers it.
+
+If the driver negotiates VIRTIO_VSOCK_F_SIZE_MAX, it MUST supply receive
+buffers that don't exceed the size \field{data_max_size} (plus header length).
+
+If the driver negotiates VIRTIO_VSOCK_F_SIZE_MAX, it MUST  NOT transmit packets
+of size exceeding the value of \field{data_max_size} (plus header length).
+
 \subsection{Device Initialization}\label{sec:Device Types / Socket Device / Device Initialization}
 
 \begin{enumerate}
Signature · 23 lines
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: [email protected]
Unsubscribe: [email protected]
List help: [email protected]
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/
#1 lore raw
Quoted 40 lines · Laura Loghin

Added a new field to the vsock device config space that is limiting the size of the packet payload. This way the driver is not allowed to allocate huge buffers, and potentially fill up the entire memory.
Also defined a new feature bit for this, VIRTIO_VSOCK_F_SIZE_MAX, in order to keep backwards compatibility.

---
virtio-vsock.tex | 27 +++++++++++++++++++++++++++

1 file changed, 27 insertions(+)
virtio-vsock.tex +0 -0
index d79984d..e6903bd 100644
@@ -23,6 +23,10 @@ \subsection{Feature bits}\label{sec:Device Types / Socket Device / Feature bits}
 \begin{description}

\item[VIRTIO_VSOCK_F_STREAM (0)] stream socket type is supported. \item[VIRTIO_VSOCK_F_SEQPACKET (1)] seqpacket socket type is supported. +\item[VIRTIO_VSOCK_F_SIZE_MAX (2)] Maximum size of the packet payload is in

virtio-vsock.tex +3 -0
+	\field{data_max_size}. If offered by the device, device advises driver
+	about the value of its maximum payload size. If negotiated, the driver uses
+	\field{data_max_size} as the maximum packet payload size value.

\end{description}

\subsection{Device configuration layout}\label{sec:Device Types / Socket Device / Device configuration layout}

virtio-vsock.tex +1 -0
@@ -32,6 +36,7 @@ \subsection{Device configuration layout}\label{sec:Device Types / Socket Device
 \begin{lstlisting}
 struct virtio_vsock_config {
 	le64 guest_cid;
+	le32 data_max_size;
 };
 \end{lstlisting}
 
@@ -57,6 +62,28 @@ \subsection{Device configuration layout}\label{sec:Device Types / Socket Device

\hline
\end{tabular}

virtio-vsock.tex +1 -0
+The following driver-read-only field, \field{data_max_size} only exists if

virtio-vsock.tex \subsection{Device configuration layout}\label{sec:Device Types / Socket Device · line 75

Quoted 10 lines
virtio-vsock.tex +10 -0
+VIRTIO_VSOCK_F_SIZE_MAX is set. This field specifies the maximum packet payload
+size for the driver to use.
+
+\devicenormative{\subsubsection}{Device configuration layout}{Device Types / Socket Device / Device configuration layout}
+
+The device MUST NOT change the value exposed through \field{data_max_size}.
+
+The device MUST forward transmitted packets of up to \field{data_max_size}
+(plus header length) size after VIRTIO_VSOCK_F_SIZE_MAX has been successfully
+negotiated.

Sorry, I thought we were going to delete this sentence like we did the one above, maybe I didn't get the meaning right though.

What do you mean here by "forward"?

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: [email protected]
Unsubscribe: [email protected]
List help: [email protected]
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/

#2 lore raw
Quoted 71 lines · Stefano Garzarella

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.

Quoted 58 lines · Laura Loghin

Added a new field to the vsock device config space that is limiting the size of the packet payload. This way the driver is not allowed to allocate huge buffers, and potentially fill up the entire memory.
Also defined a new feature bit for this, VIRTIO_VSOCK_F_SIZE_MAX, in order to keep backwards compatibility.

---
virtio-vsock.tex | 27 +++++++++++++++++++++++++++

1 file changed, 27 insertions(+)
virtio-vsock.tex +0 -0
index d79984d..e6903bd 100644
@@ -23,6 +23,10 @@ \subsection{Feature bits}\label{sec:Device Types / 
 Socket Device / Feature bits}
 \begin{description}

\item[VIRTIO_VSOCK_F_STREAM (0)] stream socket type is supported. \item[VIRTIO_VSOCK_F_SEQPACKET (1)] seqpacket socket type is supported. +\item[VIRTIO_VSOCK_F_SIZE_MAX (2)] Maximum size of the packet payload is in
+      \field{data_max_size}. If offered by the device, device advises driver
+      about the value of its maximum payload size. If negotiated, the driver uses
+      \field{data_max_size} as the maximum packet payload size value. \end{description}

\subsection{Device configuration layout}\label{sec:Device Types / Socket Device / Device configuration layout}

virtio-vsock.tex +0 -0
@@ -32,6 +36,7 @@ \subsection{Device configuration 

layout}\label{sec:Device Types / Socket Device
\begin{lstlisting}
struct virtio_vsock_config {
      le64 guest_cid;
+      le32 data_max_size;
};
\end{lstlisting}

virtio-vsock.tex +0 -0
@@ -57,6 +62,28 @@ \subsection{Device configuration 

layout}\label{sec:Device Types / Socket Device
\hline
\end{tabular}

+The following driver-read-only field, \field{data_max_size} only exists if
+VIRTIO_VSOCK_F_SIZE_MAX is set. This field specifies the maximum packet payload

virtio-vsock.tex +3 -0
+size for the driver to use.
+
+\devicenormative{\subsubsection}{Device configuration layout}{Device 

Types / Socket Device / Device configuration layout}

virtio-vsock.tex +2 -0
+
+The device MUST NOT change the value exposed through 

\field{data_max_size}.

virtio-vsock.tex +2 -0
+
+The device MUST forward transmitted packets of up to 
Quoted 4 lines

\field{data_max_size}
+(plus header length) size after VIRTIO_VSOCK_F_SIZE_MAX has been successfully
+negotiated.

Sorry, I thought we were going to delete this sentence like we did the one above, maybe I didn't get the meaning right though.

Quoted 5 lines

What do you mean here by "forward"?

Thanks,
Stefano

Sorry for the confusion. Now I got super confused as well :D. So actually "MUST NOT pass received packets" was about the packets received from the driver, and "MUST forward transmitted packets" about the packets transmitted from the backend to the driver. The "receive/transmit" terminology was from the device perspective here. So your initial comment applied to this sentence actually, not the initial one, but I forgot then that I wrote this section from the device perspective. Both sentences are already implied by their corresponding ones from the driver section, so I think I can delete both actually.
Thanks for raising this!

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.

#3 lore raw
Quoted 88 lines · Laura Loghin
Quoted 71 lines · Stefano Garzarella

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.

Quoted 58 lines · Laura Loghin

Added a new field to the vsock device config space that is limiting the size of the packet payload. This way the driver is not allowed to allocate huge buffers, and potentially fill up the entire memory.
Also defined a new feature bit for this, VIRTIO_VSOCK_F_SIZE_MAX, in order to keep backwards compatibility.

---
virtio-vsock.tex | 27 +++++++++++++++++++++++++++

1 file changed, 27 insertions(+)
virtio-vsock.tex +0 -0
index d79984d..e6903bd 100644
@@ -23,6 +23,10 @@ \subsection{Feature bits}\label{sec:Device Types 
 / Socket Device / Feature bits}
 \begin{description}

\item[VIRTIO_VSOCK_F_STREAM (0)] stream socket type is supported. \item[VIRTIO_VSOCK_F_SEQPACKET (1)] seqpacket socket type is supported. +\item[VIRTIO_VSOCK_F_SIZE_MAX (2)] Maximum size of the packet payload is in
+      \field{data_max_size}. If offered by the device, device advises driver
+      about the value of its maximum payload size. If negotiated, the driver uses
+      \field{data_max_size} as the maximum packet payload size value. \end{description}

\subsection{Device configuration layout}\label{sec:Device Types / Socket Device / Device configuration layout}

virtio-vsock.tex +0 -0
@@ -32,6 +36,7 @@ \subsection{Device configuration 

layout}\label{sec:Device Types / Socket Device
\begin{lstlisting}
struct virtio_vsock_config {
      le64 guest_cid;
+      le32 data_max_size;
};
\end{lstlisting}

virtio-vsock.tex +0 -0
@@ -57,6 +62,28 @@ \subsection{Device configuration 

layout}\label{sec:Device Types / Socket Device
\hline
\end{tabular}

+The following driver-read-only field, \field{data_max_size} only exists if
+VIRTIO_VSOCK_F_SIZE_MAX is set. This field specifies the maximum packet payload

virtio-vsock.tex +3 -0
+size for the driver to use.
+
+\devicenormative{\subsubsection}{Device configuration 

layout}{Device Types / Socket Device / Device configuration layout}

virtio-vsock.tex +2 -0
+
+The device MUST NOT change the value exposed through 

\field{data_max_size}.

virtio-vsock.tex +2 -0
+
+The device MUST forward transmitted packets of up to 
Quoted 4 lines

\field{data_max_size}
+(plus header length) size after VIRTIO_VSOCK_F_SIZE_MAX has been successfully
+negotiated.

Sorry, I thought we were going to delete this sentence like we did the one above, maybe I didn't get the meaning right though.

Quoted 5 lines

What do you mean here by "forward"?

Thanks,
Stefano

Sorry for the confusion. Now I got super confused as well :D. So actually "MUST NOT pass received packets" was about the packets received from the driver, and "MUST forward transmitted packets" about the packets transmitted from the backend to the driver. The "receive/transmit" terminology was from the device perspective here. So your initial comment applied to this sentence actually, not the initial one, but I forgot then that I wrote this section from the device perspective. Both sentences are already implied by their corresponding ones from the driver section, so I think I can delete both actually.
Thanks for raising this!

Quoted 1 line

Laura

Hi,

Both sentences are removed now, and I also updated a bit the second requirement from the driver section. Before it was a bit unclear if data_max_size is the limit for each buffer or for their sum (for implementations that allow more than 2 buffers for a single packet). I (hopefully) made it clearer in
https://lists.oasis-open.org/archives/virtio-comment/202204/msg00089.html.
Please, have a look!

Thanks,
Laura

Quoted 4 lines

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.

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.