Return-Path: Sender: List-Post: List-Help: List-Unsubscribe: List-Subscribe: Received: from lists.oasis-open.org (oasis-open.org [10.110.1.242]) by lists.oasis-open.org (Postfix) with ESMTP id 75C92986113 for ; Wed, 1 Jun 2022 07:33:39 +0000 (UTC) From: Alvaro Karsz Date: Wed, 1 Jun 2022 10:33:30 +0300 Message-Id: <20220601073330.2468384-1-alvaro.karsz@solid-run.com> MIME-Version: 1.0 Subject: [virtio-comment] [PATCH v4] Introduction of Virtio Network device notifications coalescing feature. Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="US-ASCII" To: virtio-comment@lists.oasis-open.org, jasowang@redhat.com Cc: rabeeh@solid-run.com, Alvaro Karsz List-ID: Control a network device notifications coalescing parameters using the cont= rol virtqueue. A new control class was added: VIRTIO_NET_CTRL_NOTF_COAL. This class provides 2 commands: - VIRTIO_NET_CTRL_NOTF_COAL_TX_SET: Ask the network device to change the tx_usecs and tx_max_buffers paramete= rs. - tx_usecs: Time to delay a notification after a TX buffer is used in mic= roseconds. - tx_max_buffers: Number of TX buffers to delay a notification after a TX= buffer is used. - VIRTIO_NET_CTRL_NOTF_COAL_RX_SET: Ask the network device to change the rx_usecs and rx_max_buffers paramete= rs. - rx_usecs: Time to delay a notification after a RX buffer is used in mic= roseconds. - rx_max_buffers: Number of RX buffers to delay a notification after a RX= buffer is used. -- v2: =09- Usage of notification terminology. =09- Add a few lines on what device should do when driver asked to =09 suppress notifications. v3: =09- Remove whitespaces. =09- Explain with examples how the device should act. v4: =09- Example of a scenarion when VIRTIO_F_EVENT_IDX is negotiated. =09- Usage of separate commands for RX coalescing and TX coalescing. -- Signed-off-by: Alvaro Karsz --- content.tex | 88 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 88 insertions(+) diff --git a/content.tex b/content.tex index 7508dd1..2c75056 100644 --- a/content.tex +++ b/content.tex @@ -3084,6 +3084,8 @@ \subsection{Feature bits}\label{sec:Device Types / Ne= twork Device / Feature bits \item[VIRTIO_NET_F_CTRL_MAC_ADDR(23)] Set MAC address through control channel. =20 +\item[VIRTIO_NET_F_NOTF_COAL(55)] Device supports notifications coalescing= . + \item[VIRTIO_NET_F_HOST_USO (56)] Device can receive USO packets. Unlike U= FO (fragmenting the packet) the USO splits large UDP packet to several segments when each of these smaller packets has UDP header. @@ -3129,6 +3131,7 @@ \subsubsection{Feature bit requirements}\label{sec:De= vice Types / Network Device \item[VIRTIO_NET_F_GUEST_ANNOUNCE] Requires VIRTIO_NET_F_CTRL_VQ. \item[VIRTIO_NET_F_MQ] Requires VIRTIO_NET_F_CTRL_VQ. \item[VIRTIO_NET_F_CTRL_MAC_ADDR] Requires VIRTIO_NET_F_CTRL_VQ. +\item[VIRTIO_NET_F_NOTF_COAL] Requires VIRTIO_NET_F_CTRL_VQ. \item[VIRTIO_NET_F_RSC_EXT] Requires VIRTIO_NET_F_HOST_TSO4 or VIRTIO_NET_= F_HOST_TSO6. \item[VIRTIO_NET_F_RSS] Requires VIRTIO_NET_F_CTRL_VQ. \end{description} @@ -4464,6 +4467,91 @@ \subsubsection{Control Virtqueue}\label{sec:Device T= ypes / Network Device / Devi (necessarily when not using the legacy interface) little-endian. =20 =20 +\paragraph{Notifications Coalescing}\label{sec:Device Types / Network Devi= ce / Device Operation / Control Virtqueue / Notifications Coalescing} + +If the VIRTIO_NET_F_NOTF_COAL feature is negotiated, the driver can +send control commands for dynamically changing the coalescing parameters. + +\begin{lstlisting} +struct virtio_net_ctrl_coal_rx { + le32 rx_max_buffers; + le32 rx_usecs; +}; + +struct virtio_net_ctrl_coal_tx { + le32 tx_max_buffers; + le32 tx_usecs; +}; + +#define VIRTIO_NET_CTRL_NOTF_COAL 6 + #define VIRTIO_NET_CTRL_NOTF_COAL_TX_SET 0 + #define VIRTIO_NET_CTRL_NOTF_COAL_RX_SET 1 +\end{lstlisting} + +Coalescing parameters: +\begin{itemize} +\item rx_usecs: Time to delay a notification after a RX buffer is used in = microseconds. +\item tx_usecs: Time to delay a notification after a TX buffer is used in = microseconds. +\item rx_max_buffers: Number of RX buffers to delay a notification after a= RX buffer is used. +\item tx_max_buffers: Number of TX buffers to delay a notification after a= TX buffer is used. +\end{itemize} + +Note: A chain of buffers counts as one, just like it would if this feature= is not negotiated. + +The class VIRTIO_NET_CTRL_NOTF_COAL has 2 commands: +\begin{itemize} +\item VIRTIO_NET_CTRL_NOTF_COAL_TX_SET: set the tx_usecs and tx_max_buffer= s parameters. +\item VIRTIO_NET_CTRL_NOTF_COAL_RX_SET: set the rx_usecs and rx_max_buffer= s parameters. +\end{itemize} + +Note: rx_usecs =3D 0 or rx_max_buffers =3D 0 means that a notification sho= uld be sent for every used buffer, so if one of these values is 0, the othe= r value is meaningless. +The same is true for tx_usecs and tx_max_buffers. + +\paragraph{RX Notifications}\label{sec:Device Types / Network Device / Dev= ice Operation / Control Virtqueue / Notifications Coalescing / RX Notificat= ions} + +If, for example, rx_usecs =3D 10 and rx_buffers_max =3D 15. + +\begin{itemize} +\item The device will count used buffers from the RX virtqueue until it ac= cumulates 15, or until 10 usecs elapsed since the usage of the first one. +\item The device will send a notification to the driver, only if the drive= r hasn't suppressed notifications. +\item The device will reset its internal coalescing counters, if a notific= ation was sent. +\end{itemize} + +\paragraph{TX Notifications}\label{sec:Device Types / Network Device / Dev= ice Operation / Control Virtqueue / Notifications Coalescing / TX Notificat= ions} + +If, for example, tx_usecs =3D 10 and tx_buffers_max =3D 15. + +\begin{itemize} +\item The device will count used buffers from the TX virtqueue until it ac= cumulates 15, or until 10 usecs elapsed since the usage of the first one. +\item The device will send a notification to the driver, only if the drive= r hasn't suppressed notifications. +\item The device will reset its internal coalescing counters, if a notific= ation was sent. +\end{itemize} + +\paragraph{Coalescing and Notifications Suppression}\label{sec:Device Type= s / Network Device / Device Operation / Control Virtqueue / Notifications C= oalescing / Coalescing and Notifications Suppression} + +If the driver sets the VIRTQ_AVAIL_F_NO_INTERRUPT flag, the device should = not send notifications to the driver. \\ +In this case, the device will increase the coalescing counters until the f= lag is cleared, and only then the device will send a notification and clear= the coalescing counters. \\ \\ + +If the VIRTIO_F_EVENT_IDX feature is negotiated, and used_event field is s= et, the device will send a notification only after used_event index is reac= hed, even if the coalescing counters expired before. + +For example: \\ +rx_usecs =3D 10, rx_max_buffers =3D 7, used_event =3D 5, and current virtq= ueue location is 0: \\ +If the timer elapses before the \#5 buffer is used, the device will send a= notification only after the \#5 buffer is used. \\ +If the \#5 buffer is used before the timer elapses, the device will send a= notification after the \#7 buffer is used, or after the timer elapses, whi= chever occurs first. + +\drivernormative{\subparagraph}{Notifications Coalescing}{Device Types / N= etwork Device / Device Operation / Control Virtqueue / Notifications Coales= cing} + + +If the VIRTIO_NET_F_NOTF_COAL feature has not been negotiated, the driver = MUST NOT issue VIRTIO_NET_CTRL_NOTF_COAL commands. + +\devicenormative{\subparagraph}{Notifications Coalescing}{Device Types / N= etwork Device / Device Operation / Control Virtqueue / Notifications Coales= cing} + +A device SHOULD respond to the VIRTIO_NET_CTRL_NOTF_COAL commands with VIR= TIO_NET_ERR if was not able to change the parameters.\\ \\ +A device MUST NOT accept tx_buffers_max/rx_buffers_max values bigger than = the virtqueue size.\\ \\ +A device SHOULD NOT send notifications to the driver, if the notifications= are suppressed.\\ \\ +A device SHOULD initialize all coalescing values to 0, meaning that a noti= fication is sent after every used buffer (if events aren't suppressed). \\ = \\ + + \subsubsection{Legacy Interface: Framing Requirements}\label{sec:Device Types / Network Device / Legacy Interface: Framing Requirements} =20 --=20 2.32.0 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-lis= ts Committee: https://www.oasis-open.org/committees/virtio/ Join OASIS: https://www.oasis-open.org/join/