Introduction of Virtio Network device notifications coalescing feature.
PATCH v5 1/1 Introduction of Virtio Network device notifications coalescing feature.
Control a network device notifications coalescing parameters using the control 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 parameters.
- tx_usecs: Time to delay a notification after a TX buffer is used in microseconds.
- 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 parameters.
- rx_usecs: Time to delay a notification after a RX buffer is used in microseconds.
- rx_max_buffers: Number of RX buffers to delay a notification after a RX buffer is used.
--
v2:
- Usage of notification terminology.
- Add a few lines on what device should do when driver asked to suppress notifications.
v3:
- Remove whitespaces.
- Explain with examples how the device should act.
v4:
- Example of a scenarion when VIRTIO_F_EVENT_IDX is negotiated.
- Usage of separate commands for RX coalescing and TX coalescing.
v5:
- Usage of subparagraphs.
- Add driver requirements and device requirements references in conformance.tex.
--
--- conformance.tex | 2 ++ content.tex | 88 +++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 90 insertions(+)
conformance.tex +2 -0
@@ -149,6 +149,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets} \item \ref{drivernormative:Device Types / Network Device / Device Operation / Control Virtqueue / Automatic receive steering in multiqueue mode} \item \ref{drivernormative:Device Types / Network Device / Device Operation / Control Virtqueue / Offloads State Configuration / Setting Offloads State} \item \ref{drivernormative:Device Types / Network Device / Device Operation / Control Virtqueue / Receive-side scaling (RSS) } +\item \ref{drivernormative:Device Types / Network Device / Device Operation / Control Virtqueue / Notifications Coalescing} \end{itemize} \conformance{\subsection}{Block Driver Conformance}\label{sec:Conformance / Driver Conformance / Block Driver Conformance}
@@ -411,6 +412,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets} \item \ref{devicenormative:Device Types / Network Device / Device Operation / Control Virtqueue / Gratuitous Packet Sending} \item \ref{devicenormative:Device Types / Network Device / Device Operation / Control Virtqueue / Automatic receive steering in multiqueue mode} \item \ref{devicenormative:Device Types / Network Device / Device Operation / Control Virtqueue / Receive-side scaling (RSS) / RSS processing} +\item \ref{devicenormative:Device Types / Network Device / Device Operation / Control Virtqueue / Notifications Coalescing} \end{itemize} \conformance{\subsection}{Block Device Conformance}\label{sec:Conformance / Device Conformance / Block Device Conformance}
content.tex +88 -0
106 lines not on this page · raw message
Signature · 18 lines
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: [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/
If there are no comments, I'd like to vote.
https://github.com/oasis-tcs/virtio-spec/issues/141
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/
Quoted 38 lines · Alvaro Karsz
Control a network device notifications coalescing parameters using the control 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 thetx_usecsandtx_max_buffersparameters.
-tx_usecs: Time to delay a notification after a TX buffer is used in microseconds.
-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 therx_usecsandrx_max_buffersparameters.
-rx_usecs: Time to delay a notification after a RX buffer is used in microseconds.
-rx_max_buffers: Number of RX buffers to delay a notification after a RX buffer is used.
--
v2:
- Usage of notification terminology.
- Add a few lines on what device should do when driver asked to suppress notifications.v3:
- Remove whitespaces.
- Explain with examples how the device should act.v4:
- Example of a scenarion whenVIRTIO_F_EVENT_IDXis negotiated.
- Usage of separate commands for RX coalescing and TX coalescing.v5:
- Usage of subparagraphs.
- Add driver requirements and device requirements references in conformance.tex.
--Signed-off-by Alvaro Karsz <[email protected]>--- conformance.tex | 2 ++ content.tex | 88 +++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 90 insertions(+)
(...)
Quoted 3 lines
+Coalescing parameters:
+\begin{itemize}
+\itemrx_usecs: Time to delay a notification after a RX buffer is used in microseconds.
Can you please use \field{...} for the various structure fields? (here and in the rest of the patch)
Quoted 4 lines
+\item
tx_usecs: Time to delay a notification after a TX buffer is used in microseconds. +\itemrx_max_buffers: Number of RX buffers to delay a notification after a RX buffer is used. +\itemtx_max_buffers: Number of TX buffers to delay a notification after a TX buffer is used. +\end{itemize}
(...)
content.tex \subsubsection{Control Virtqueue}\label{sec:Device Types / Network Device / Devi · line 4533
Quoted 4 lines
+\subparagraph{Coalescing and Notifications Suppression}\label{sec:Device Types / Network Device / Device Operation / Control Virtqueue / Notifications Coalescing / Coalescing and Notifications Suppression}
content.tex +3
-0+ +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 flag is cleared, and only then the device will send a notification and clear the coalescing counters. \\ \\
Can you please drop the "\\"? Just let the paragraphs be formatted naturally.
content.tex \subsubsection{Control Virtqueue}\label{sec:Device Types / Network Device / Devi · line 4540
Quoted 7 lines
content.tex +7
-0+ +If the VIRTIO_F_EVENT_IDX feature is negotiated, and used_event field is set, the device will send a notification only after used_event index is reached, even if the coalescing counters expired before. + +For example: \\ +rx_usecs = 10, rx_max_buffers = 7, used_event = 5, and current virtqueue 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, whichever occurs first.
Can you please put that into an itemize, as for the other examples?
content.tex \subsubsection{Control Virtqueue}\label{sec:Device Types / Network Device / Devi · line 4549
Quoted 9 lines
content.tex +9
-0+ +\drivernormative{\subparagraph}{Notifications Coalescing}{Device Types / Network Device / Device Operation / Control Virtqueue / Notifications Coalescing} + + +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 / Network Device / Device Operation / Control Virtqueue / Notifications Coalescing} + +A device SHOULD respond to the VIRTIO_NET_CTRL_NOTF_COAL commands with VIRTIO_NET_ERR if was not able to change the parameters.\\ \\
s/if/if it/
content.tex \subsubsection{Control Virtqueue}\label{sec:Device Types / Network Device / Devi · line 4552
Quoted 3 lines
content.tex +3
-0+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 notification is sent after every used buffer (if events aren't suppressed). \\ \\
I think we prefer the non-contracted forms (i.e. "are not").
I would also like an ack from someone more familiar with virtio-net than me (nothing seemed wrong to me).
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/
Thanks for the reply.
Quoted 1 line
s/if/if it/
I'm not sure I understand what you mean here.
Quoted 5 lines · Alvaro Karsz
Thanks for the reply.
Quoted 1 line
s/if/if it/
I'm not sure I understand what you mean here.
The sentence was missing an "it": "...if it was not able to..."
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/