virtio-net: support the virtqueue coalescing moderation
PATCH v6 1/1 virtio-net: support the virtqueue coalescing moderation
Currently, coalescing parameters are grouped for all transmit and receive virtqueues. This patch supports setting or getting the parameters for a specified virtqueue, and a typical application of this function is netdim[1].
When the traffic between virtqueues is unbalanced, for example, one virtqueue is busy and another virtqueue is idle, then it will be very useful to control coalescing parameters at the virtqueue granularity.
[1] https://docs.kernel.org/networking/net_dim.html
---
This patch is on top of Alvaro's latest v7 patch: https://lists.oasis-open.org/archives/virtio-dev/202302/msg00431.html .
v5->v6:
1. Explain that the device may set a different value than the one passed in by the driver. @David Edmondson
v4->v5:
1. Add the correspondence between virtio_net_ctrl_coal and virtio_net_ctrl_coal_vq and control commands. @Michael S. Tsirkin
2. Add read and write attributes for each field. @Michael S. Tsirkin
3. A clearer description of how to set coalescing parameters for vq reset. @Michael S. Tsirkin
4. Fix some syntax errors. @Michael S. Tsirkin, @David Edmondson
v3->v4:
1. Include virtio_net_ctrl_coal in the virtio_net_ctrl_coal_vq structure. @Alvaro Karsz
2. Add consideration of vq reset. @Michael S. Tsirkin, @Parav Pandit, @Alvaro Karsz
3. Avoid too many examples by giving a comprehensive example. @Michael S. Tsirkin
4. Fix typos and streamline clarifications. @Michael S. Tsirkin, @Parav Pandit, @Alvaro Karsz
v2->v3:
1. Add the netdim link. @Parav Pandit
2. VIRTIO_NET_F_VQ_NOTF_COAL no longer depends on VIRTIO_NET_F_NOTF_COAL. @Michael S. Tsirkin, @Alvaro Karsz
3. _VQ_GET is explained more. @Michael S. Tsirkin
4. Add more examples to avoid misunderstandings. @Michael S. Tsirkin
5. Clarify some statements. @Michael S. Tsirkin, @Parav Pandit, @Alvaro Karsz
6. Adjust the virtio_net_ctrl_coal_vq structure. @Michael S. Tsirkin
7. Fix some typos. @Michael S. Tsirkin
v1->v2:
1. Rename VIRTIO_NET_F_PERQUEUE_NOTF_COAL to VIRTIO_NET_F_VQ_NOTF_COAL. @Michael S. Tsirkin
2. Use the \field{vqn} instead of the qid. @Michael S. Tsirkin
3. Unify tx and rx control structres into one structure virtio_net_ctrl_coal_vq. @Michael S. Tsirkin
4. Add a new control command VIRTIO_NET_CTRL_NOTF_COAL_VQ. @Michael S. Tsirkin, @Parav Pandit, @Alvaro Karsz
5. The special value 0xFFF is removed because VIRTIO_NET_CTRL_NOTF_COAL can be used. @Alvaro Karsz
6. Clarify some special scenarios. @Michael S. Tsirkin, @Parav Pandit, @Alvaro Karsz
device-types/net/description.tex | 100 +++++++++++++++++++++++++++++-- 1 file changed, 95 insertions(+), 5 deletions(-)
device-types/net/description.tex +95 -5
@@ -83,6 +83,8 @@ \subsection{Feature bits}\label{sec:Device Types / Network Device / Feature bits \item[VIRTIO_NET_F_CTRL_MAC_ADDR(23)] Set MAC address through control channel. +\item[VIRTIO_NET_F_VQ_NOTF_COAL(52)] Device supports virtqueue notification coalescing. + \item[VIRTIO_NET_F_NOTF_COAL(53)] Device supports notifications coalescing. \item[VIRTIO_NET_F_GUEST_USO4 (54)] Driver can receive USOv4 packets.
@@ -139,6 +141,7 @@ \subsubsection{Feature bit requirements}\label{sec:Device Types / Network Device \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. +\item[VIRTIO_NET_F_VQ_NOTF_COAL] Requires VIRTIO_NET_F_CTRL_VQ. \end{description} \subsubsection{Legacy Interface: Feature bits}\label{sec:Device Types / Network Device / Feature bits / Legacy Interface: Feature bits}
@@ -1508,6 +1511,14 @@ \subsubsection{Control Virtqueue}\label{sec:Device Types / Network Device / Devi If the VIRTIO_NET_F_NOTF_COAL feature is negotiated, the driver can send control commands for dynamically changing the coalescing parameters. +If the VIRTIO_NET_F_VQ_NOTF_COAL feature is negotiated: +\begin{itemize} +\item a driver can send a VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command to set coalescing parameters of a given + enabled transmit/receive virtqueue. +\item a driver can send a VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET command to a device, and the device responds with + coalescing parameters of a given enabled transmit/receive virtqueue. +\end{itemize} + \begin{note} The behavior of the device in response to these commands is best-effort: the device may generate notifications more or less frequently than specified.
@@ -1519,25 +1530,76 @@ \subsubsection{Control Virtqueue}\label{sec:Device Types / Network Device / Devi le32 max_usecs; }; +struct virtio_net_ctrl_coal_vq { + le16 vqn; + le16 reserved; + struct virtio_net_ctrl_coal coal; +}; + #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 + #define VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET 2 + #define VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET 3 \end{lstlisting} +The VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and VIRTIO_NET_CTRL_NOTF_COAL_RX_SET commands use the +virtio_net_ctrl_coal structure to set \field{max_usecs} and \field{max_packets} for all +transmit/receive virtqueues. + +The VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command uses the virtio_net_ctrl_coal_vq structure +to set \field{max_usecs} and \field{max_packets} for the supplied virtqueue number \field{vqn}. + +The VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET command gets the values of \field{max_usecs} and +\field{max_packets} of the specified virtqueue from the device by setting \field{vqn} +in the virtio_net_ctrl_coal_vq structure. + +# Read/Write attributes for coalescing parameters +\begin{itemize} +\item For commands VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and VIRTIO_NET_CTRL_NOTF_COAL_RX_SET, \field{max_usecs} + and \field{max_packets} are write-only for a driver. +\item For the command VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET, \field{vqn}, \field{reserved}, \field{max_usecs} + and \field{max_packets} are write-only for a driver. +\item For the command VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET, \field{vqn} and \field{reserved} are write-only + for a driver, and, \field{max_usecs} and \field{max_packets} are read-only for a driver. +\end{itemize} + Coalescing parameters: \begin{itemize} +\item \field{vqn}: The virtqueue number of an enabled transmit or receive virtqueue. \item \field{max_usecs} for RX: Maximum number of microseconds to delay a RX notification. \item \field{max_usecs} for TX: Maximum number of microseconds to delay a TX notification. \item \field{max_packets} for RX: Maximum number of packets to receive before a RX notification. \item \field{max_packets} for TX: Maximum number of packets to send before a TX notification. \end{itemize} -The class VIRTIO_NET_CTRL_NOTF_COAL has 2 commands: +\field{vqn} points to an enabled transmit/receive virtqueue, and its value satisfies $ 0 \leq vqn < max_virtqueue_pairs \ast 2 $. + +\field{reserved} is reserved and it is ignored by a device. + +The class VIRTIO_NET_CTRL_NOTF_COAL has 4 commands: \begin{enumerate} -\item VIRTIO_NET_CTRL_NOTF_COAL_TX_SET: set the \field{max_usecs} and \field{max_packets} parameters for all transmit virtqueues. -\item VIRTIO_NET_CTRL_NOTF_COAL_RX_SET: set the \field{max_usecs} and \field{max_packets} parameters for all receive virtqueues. +\item VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET: set the \field{max_usecs} and \field{max_packets} parameters for an enabled transmit/receive + virtqueue whose number is \field{vqn}. +\item VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET: the device returns the \field{max_usecs} and \field{max_packets} parameters for an enabled + transmit/receive virtqueue whose number is \field{vqn}. +\item VIRTIO_NET_CTRL_NOTF_COAL_TX_SET: have the same effect as the VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command repeated for each virtqueue of transmitq1\ldots transmitqN. +\item VIRTIO_NET_CTRL_NOTF_COAL_RX_SET: have the same effect as the VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command repeated for each virtqueue of receiveq1\ldots receiveqN. \end{enumerate} +If coalescing parameters are being set, the device applies the last coalescing parameters received for a +virtqueue, regardless of the command used to set the parameters. For example with 2 pairs of virtqueues: +# Command sequence +Each of the following commands sets \field{max_usecs} and \field{max_packets} parameters for virtqueues. +\begin{itemize} +\item Command1: VIRTIO_NET_CTRL_NOTF_COAL_RX_SET sets coalescing parameters for virtqueue0 and virtqueue2, and, virtqueue1 and virtqueue3 retain their previous parameter values. +\item Command2: VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET with \field{vqn} = 0 sets coalescing parameters for virtqueue0, and virtqueue2 retains the values from command1. +\item Command3: VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET with \field{vqn} = 0, the device responds with coalescing parameters of virtqueue0 set by command2. +\item Command4: VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET with \field{vqn} = 1 sets coalescing parameters for virtqueue1, and virtqueue3 retains its previous values. +\item Command5: VIRTIO_NET_CTRL_NOTF_COAL_TX_SET sets coalescing parameters for virtqueue1 and virtqueue3, and overrides the values set by command4. +\item Command6: VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET with \field{vqn} = 1, the device responds with coalescing parameters of virtqueue1 set by command5. +\end{itemize} + \subparagraph{Operation}\label{sec:Device Types / Network Device / Device Operation / Control Virtqueue / Notifications Coalescing / Operation} The device sends a used buffer notification once the notification conditions are met and if the notifications are not suppressed as explained in \ref{sec:Basic Facilities of a Virtio Device / Virtqueues / Used Buffer Notification Suppression}.
@@ -1549,6 +1611,16 @@ \subsubsection{Control Virtqueue}\label{sec:Device Types / Network Device / Devi When the device has \field{max_usecs} = 0 or \field{max_packets} = 0, the notification conditions are met after every packet received/sent. +When a device receives a command of the VIRTIO_NET_CTRL_NOTF_COAL class to set a coalescing parameter, +it may set the parameter to a value close to a power of 2. For example: +If the device receives \field{max_usecs} = 7 from the VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command, it may set \field{max_usecs} = 8 for a given enabled virtqueue. + +When the device receives the VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and VIRTIO_NET_CTRL_NOTF_COAL_RX_SET commands, +it saves the values of coalescing parameters as global values, and the VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command +does not change the global values. If the device is reset, the global values will be set to 0. + +When a virtqueue is reset, its coalescing parameters are set to the global values. + \subparagraph{RX Example}\label{sec:Device Types / Network Device / Device Operation / Control Virtqueue / Notifications Coalescing / RX Example} If, for example:
@@ -1585,11 +1657,29 @@ \subsubsection{Control Virtqueue}\label{sec:Device Types / Network Device / Devi \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. +If neither the VIRTIO_NET_F_NOTF_COAL nor the VIRTIO_NET_F_VQ_NOTF_COAL feature +has been negotiated, the driver MUST NOT issue VIRTIO_NET_CTRL_NOTF_COAL commands. + +A driver MUST ignore the values of coalescing parameters received from the VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET command if a device responds with VIRTIO_NET_ERR. \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 it was not able to change the parameters. +A device SHOULD respond to VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and VIRTIO_NET_CTRL_NOTF_COAL_RX_SET commands with VIRTIO_NET_ERR if it was not able to change the parameters. + +A device MUST respond to the VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command with VIRTIO_NET_ERR if it was not able to change the parameters. + +A device MUST respond to VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET and VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET commands with VIRTIO_NET_ERR if the given virtqueue is disabled. + +The VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and VIRTIO_NET_CTRL_NOTF_COAL_RX_SET commands set coalescing parameters for all transmit/receive +virtqueues respectively and values of coalescing parameters are recorded as global values by a device. +The device MUST set the global values of coalescing parameters to 0 after being reset. +The VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command sets the coalescing parameters for a given enabled virtqueue without changing the global values. + +After disabling and re-enabling a virtqueue, the device MUST revert coalescing parameters of the virtqueue to the global values. + +A device MAY set the coalescing parameter to a value close to a power of 2 value. + +A device MUST ignore \field{reserved}. A device SHOULD NOT send used buffer notifications to the driver if the notifications are suppressed, even if the notification conditions are met.
Signature · 1 line
2.19.1.6.gb485710b
Quoted 7 lines
From: Heng Qi <[email protected]>
Sent: Tuesday, February 21, 2023 10:22 PM+\item[VIRTIO_NET_F_VQ_NOTF_COAL(52)] Device supports virtqueue notification coalescing.
+
s/notification/notifications
should be plural as multiple notifications are coalesced like the below description of VIRTIO_NET_F_NOTF_COAL.
Quoted 68 lines
\item[VIRTIO_NET_F_NOTF_COAL(53)] Device supports notifications
coalescing.\item[VIRTIO_NET_F_GUEST_USO4 (54)] Driver can receive USOv4 packets.
(quoted diff) +0
-0@@ -139,6 +141,7 @@ \subsubsection{Feature bitrequirements}\label{sec:Device Types / Network Device \item[VIRTIO_NET_F_NOTF_COAL] Requires
VIRTIO_NET_F_CTRL_VQ.
\item[VIRTIO_NET_F_RSC_EXT] RequiresVIRTIO_NET_F_HOST_TSO4orVIRTIO_NET_F_HOST_TSO6.
\item[VIRTIO_NET_F_RSS] RequiresVIRTIO_NET_F_CTRL_VQ.
+\item[VIRTIO_NET_F_VQ_NOTF_COAL] RequiresVIRTIO_NET_F_CTRL_VQ.
\end{description}\subsubsection{Legacy Interface: Feature bits}\label{sec:Device Types /
Network Device / Feature bits / Legacy Interface: Feature bits} @@ -1508,6 +1511,14 @@ \subsubsection{Control Virtqueue}\label{sec:Device Types / Network Device / Devi If theVIRTIO_NET_F_NOTF_COALfeature is negotiated, the driver can send control commands for dynamically changing the coalescing parameters.+If the
VIRTIO_NET_F_VQ_NOTF_COALfeature is negotiated:
+\begin{itemize}
+\item a driver can send aVIRTIO_NET_CTRL_NOTF_COAL_VQ_SETcommand to set coalescing parameters of a given
+ enabled transmit/receive virtqueue.
+\item a driver can send aVIRTIO_NET_CTRL_NOTF_COAL_VQ_GETcommand to a device, and the device responds withdevice-types/net/description.tex +3
-0+ coalescing parameters of a given enabled transmit/receive virtqueue. +\end{itemize} + \begin{note} The behavior of the device in response to these commands is best-effort: the device may generate notifications more or less frequently than specified.@@ -1519,25 +1530,76 @@ \subsubsection{ControlVirtqueue}\label{sec:Device Types / Network Device / Devi
le32 max_usecs;};
device-types/net/description.tex +10
-0+struct virtio_net_ctrl_coal_vq { + le16 vqn; + le16 reserved; + struct virtio_net_ctrl_coal coal; +}; + #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 + #define VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET 2 #define + VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET 3 \end{lstlisting} +The VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and +VIRTIO_NET_CTRL_NOTF_COAL_RX_SET commands use the
virtio_net_ctrl_coal
+structure to set \field{max_usecs} and \field{max_packets} for all transmit/receive virtqueues.(quoted diff) +3
-0+ +The VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command uses the +virtio_net_ctrl_coal_vq structure to set \field{max_usecs} and\field{max_packets} for the supplied virtqueue number \field{vqn}.
(quoted diff) +7
-0+ +The VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET command gets the values of +\field{max_usecs} and \field{max_packets} of the specified virtqueue +from the device by setting \field{vqn} in the virtio_net_ctrl_coal_vq structure. + +# Read/Write attributes for coalescing parameters \begin{itemize} \item +For commands VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and
Quoted 3 lines
VIRTIO_NET_CTRL_NOTF_COAL_RX_SET, \field{max_usecs}
+ and \field{max_packets} are write-only for a driver.
+\item For the commandVIRTIO_NET_CTRL_NOTF_COAL_VQ_SET, \field{vqn},
Virtio spec is using vq number and vq index terminology interchangeably. For example, a new patch about admin vq, uses aq_start_index.
MMIO device has vq_index register too.
I am inclined to vq_index given current state of spec and new additions by Michael.
Michael,
Can you please suggest vqn or vq_index to use?
Quoted 8 lines
\field{reserved}, \field{max_usecs}
+ and \field{max_packets} are write-only for a driver.
+\item For the commandVIRTIO_NET_CTRL_NOTF_COAL_VQ_GET, \field{vqn} and \field{reserved} are write-only+ for a driver, and, \field{max_usecs} and \field{max_packets} are read-only
for a driver.
Remove this trailing "for a driver", it is a duplicate.
Quoted 16 lines
+\end{itemize}
+
Coalescing parameters:
\begin{itemize}
+\item \field{vqn}: The virtqueue number of an enabled transmit or receive virtqueue.
\item \field{max_usecs} for RX: Maximum number of microseconds to delay a
RX notification.
\item \field{max_usecs} for TX: Maximum number of microseconds to delay a
TX notification.
\item \field{max_packets} for RX: Maximum number of packets to receive
before a RX notification.
\item \field{max_packets} for TX: Maximum number of packets to send before
a TX notification.
\end{itemize}
Quoted 4 lines
-The class
VIRTIO_NET_CTRL_NOTF_COALhas 2 commands:
+\field{vqn} points to an enabled transmit/receive virtqueue, and its value satisfies $ 0 \leq vqn <max_virtqueue_pairs\ast 2 $.
+
This calculation description is not needed here. It is covered somewhere else.
Quoted 76 lines
+\field{reserved} is reserved and it is ignored by a device.
device-types/net/description.tex +2
-1+ +The class VIRTIO_NET_CTRL_NOTF_COAL has 4 commands: \begin{enumerate} -\item VIRTIO_NET_CTRL_NOTF_COAL_TX_SET: set the \field{max_usecs} and\field{max_packets} parameters for all transmit virtqueues. -\item
VIRTIO_NET_CTRL_NOTF_COAL_RX_SET: set the \field{max_usecs} and \field{max_packets} parameters for all receive virtqueues. +\itemVIRTIO_NET_CTRL_NOTF_COAL_VQ_SET: set the \field{max_usecs} and \field{max_packets} parameters for an enabled transmit/receive
+ virtqueue whose number is \field{vqn}.
+\itemVIRTIO_NET_CTRL_NOTF_COAL_VQ_GET: the device returns the \field{max_usecs} and \field{max_packets} parameters for an enabled
+ transmit/receive virtqueue whose number is \field{vqn}.
+\itemVIRTIO_NET_CTRL_NOTF_COAL_TX_SET: have the same effect as theVIRTIO_NET_CTRL_NOTF_COAL_VQ_SETcommand repeated for each virtqueue of transmitq1\ldots transmitqN.
+\itemVIRTIO_NET_CTRL_NOTF_COAL_RX_SET: have the same effect as theVIRTIO_NET_CTRL_NOTF_COAL_VQ_SETcommand repeated for each virtqueue of receiveq1\ldots receiveqN.
\end{enumerate}(quoted diff) +2
-0+If coalescing parameters are being set, the device applies the last +coalescing parameters received for a virtqueue, regardless of the commandused to set the parameters. For example with 2 pairs of virtqueues:
(quoted diff) +2
-0+# Command sequence +Each of the following commands sets \field{max_usecs} and\field{max_packets} parameters for virtqueues.
+\begin{itemize}
+\item Command1:VIRTIO_NET_CTRL_NOTF_COAL_RX_SETsets coalescing parameters for virtqueue0 and virtqueue2, and, virtqueue1 and virtqueue3 retain their previous parameter values.
+\item Command2:VIRTIO_NET_CTRL_NOTF_COAL_VQ_SETwith \field{vqn} = 0 sets coalescing parameters for virtqueue0, and virtqueue2 retains the values from command1.
+\item Command3:VIRTIO_NET_CTRL_NOTF_COAL_VQ_GETwith \field{vqn} = 0, the device responds with coalescing parameters of virtqueue0 set by command2.
+\item Command4:VIRTIO_NET_CTRL_NOTF_COAL_VQ_SETwith \field{vqn} = 1 sets coalescing parameters for virtqueue1, and virtqueue3 retains its previous values.
+\item Command5:VIRTIO_NET_CTRL_NOTF_COAL_TX_SETsets coalescing parameters for virtqueue1 and virtqueue3, and overrides the values set by command4.
+\item Command6:VIRTIO_NET_CTRL_NOTF_COAL_VQ_GETwith \field{vqn} = 1, the device responds with coalescing parameters of virtqueue1 set by command5.
+\end{itemize}
+
\subparagraph{Operation}\label{sec:Device Types / Network Device / Device
Operation / Control Virtqueue / Notifications Coalescing / Operation}The device sends a used buffer notification once the notification conditions are
met and if the notifications are not suppressed as explained in \ref{sec:Basic Facilities of a Virtio Device / Virtqueues / Used Buffer Notification Suppression}.(quoted diff) +0
-0@@ -1549,6 +1611,16 @@ \subsubsection{ControlVirtqueue}\label{sec:Device Types / Network Device / Devi
When the device has \field{max_usecs} = 0 or \field{max_packets} = 0, the
notification conditions are met after every packet received/sent.+When a device receives a command of the
VIRTIO_NET_CTRL_NOTF_COALclass
+to set a coalescing parameter, it may set the parameter to a value close to a power of 2. For example:
+If the device receives \field{max_usecs} = 7 from theVIRTIO_NET_CTRL_NOTF_COAL_VQ_SETcommand, it may set \field{max_usecs} = 8 for a given enabled virtqueue.(quoted diff) +4
-0+ +When the device receives the VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and +VIRTIO_NET_CTRL_NOTF_COAL_RX_SET commands, it saves the values of +coalescing parameters as global values, and the
VIRTIO_NET_CTRL_NOTF_COAL_VQ_SETcommand does not change the global values. If the device is reset, the global values will be set to 0.(quoted diff) +2
-0+ +When a virtqueue is reset, its coalescing parameters are set to the global
Quoted 2 lines
values.
+
A VQ reset operation disables (or destroys) the VQ in the device. Hence, a vq under reset doesn't have any valid parameters. Therefore, above wording should be,
When a virtqueue is enabled after it is reset, its coalescing parameters are set to global values as configured by VIRTIO_NET_CTRL_NOTF_COAL_TX_SET or VIRTIO_NET_CTRL_NOTF_COAL_RX_SET.
Quoted 61 lines
\subparagraph{RX Example}\label{sec:Device Types / Network Device / Device
Operation / Control Virtqueue / Notifications Coalescing / RX Example}If, for example:
(quoted diff) +0
-0@@ -1585,11 +1657,29 @@ \subsubsection{ControlVirtqueue}\label{sec:Device Types / Network Device / Devi
\drivernormative{\subparagraph}{Notifications Coalescing}{Device Types /
Network Device / Device Operation / Control Virtqueue / Notifications Coalescing}-If the
VIRTIO_NET_F_NOTF_COALfeature has not been negotiated, the driver MUST NOT issueVIRTIO_NET_CTRL_NOTF_COALcommands.
+If neither theVIRTIO_NET_F_NOTF_COALnor theVIRTIO_NET_F_VQ_NOTF_COAL
+feature has been negotiated, the driver MUST NOT issueVIRTIO_NET_CTRL_NOTF_COALcommands.(quoted diff) +2
-0+ +A driver MUST ignore the values of coalescing parameters received from the
VIRTIO_NET_CTRL_NOTF_COAL_VQ_GETcommand if a device responds withVIRTIO_NET_ERR.\devicenormative{\subparagraph}{Notifications Coalescing}{Device Types /
Network Device / Device Operation / Control Virtqueue / Notifications Coalescing}-A device SHOULD respond to the
VIRTIO_NET_CTRL_NOTF_COALcommands withVIRTIO_NET_ERRif it was not able to change the parameters. +A device SHOULD respond toVIRTIO_NET_CTRL_NOTF_COAL_TX_SETandVIRTIO_NET_CTRL_NOTF_COAL_RX_SETcommands withVIRTIO_NET_ERRif it was not able to change the parameters.(quoted diff) +2
-0+ +A device MUST respond to the VIRTIO_NET_CTRL_NOTF_COAL_VQ_SETcommand with
VIRTIO_NET_ERRif it was not able to change the parameters.(quoted diff) +2
-0+ +A device MUST respond to VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET and
VIRTIO_NET_CTRL_NOTF_COAL_VQ_GETcommands withVIRTIO_NET_ERRif the given virtqueue is disabled.(quoted diff) +3
-0+ +The VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and +VIRTIO_NET_CTRL_NOTF_COAL_RX_SET commands set coalescing parametersfor all transmit/receive virtqueues respectively and values of coalescing parameters are recorded as global values by a device.
+The device MUST set the global values of coalescing parameters to 0 after being reset.
+TheVIRTIO_NET_CTRL_NOTF_COAL_VQ_SETcommand sets the coalescing parameters for a given enabled virtqueue without changing the global values.(quoted diff) +2
-0+ +After disabling and re-enabling a virtqueue, the device MUST revert coalescingparameters of the virtqueue to the global values.
(quoted diff) +2
-0+ +A device MAY set the coalescing parameter to a value close to a power of 2value.
device-types/net/description.tex +2
-0+ +A device MUST ignore \field{reserved}. A device SHOULD NOT send used buffer notifications to the driver if thenotifications are suppressed, even if the notification conditions are met.
--
2.19.1.6.gb485710b
Hi, Parav.
Quoted 7 lines · Parav Pandit
Quoted 5 lines
From: Heng Qi <[email protected]>
Sent: Tuesday, February 21, 2023 10:22 PM +\item[VIRTIO_NET_F_VQ_NOTF_COAL(52)] Device supports virtqueue notification coalescing.
+s/notification/notifications
should be plural as multiple notifications are coalesced like the below description ofVIRTIO_NET_F_NOTF_COAL.
I see, but I saw the usage of "notification coalesing" on the professional technical articles exist as well. I can modify it if you want to be consistent with the following.:)
Quoted 74 lines
Quoted 68 lines
\item[VIRTIO_NET_F_NOTF_COAL(53)] Device supports notifications
coalescing.\item[VIRTIO_NET_F_GUEST_USO4 (54)] Driver can receive USOv4 packets.
(quoted diff) +0
-0@@ -139,6 +141,7 @@ \subsubsection{Feature bitrequirements}\label{sec:Device Types / Network Device \item[VIRTIO_NET_F_NOTF_COAL] Requires
VIRTIO_NET_F_CTRL_VQ.
\item[VIRTIO_NET_F_RSC_EXT] RequiresVIRTIO_NET_F_HOST_TSO4orVIRTIO_NET_F_HOST_TSO6.
\item[VIRTIO_NET_F_RSS] RequiresVIRTIO_NET_F_CTRL_VQ.
+\item[VIRTIO_NET_F_VQ_NOTF_COAL] RequiresVIRTIO_NET_F_CTRL_VQ.
\end{description}\subsubsection{Legacy Interface: Feature bits}\label{sec:Device Types /
Network Device / Feature bits / Legacy Interface: Feature bits} @@ -1508,6 +1511,14 @@ \subsubsection{Control Virtqueue}\label{sec:Device Types / Network Device / Devi If theVIRTIO_NET_F_NOTF_COALfeature is negotiated, the driver can send control commands for dynamically changing the coalescing parameters.+If the
VIRTIO_NET_F_VQ_NOTF_COALfeature is negotiated:
+\begin{itemize}
+\item a driver can send aVIRTIO_NET_CTRL_NOTF_COAL_VQ_SETcommand to set coalescing parameters of a given
+ enabled transmit/receive virtqueue.
+\item a driver can send aVIRTIO_NET_CTRL_NOTF_COAL_VQ_GETcommand to a device, and the device responds withdevice-types/net/description.tex +3
-0+ coalescing parameters of a given enabled transmit/receive virtqueue. +\end{itemize} + \begin{note} The behavior of the device in response to these commands is best-effort: the device may generate notifications more or less frequently than specified.@@ -1519,25 +1530,76 @@ \subsubsection{ControlVirtqueue}\label{sec:Device Types / Network Device / Devi
le32 max_usecs;};
device-types/net/description.tex +10
-0+struct virtio_net_ctrl_coal_vq { + le16 vqn; + le16 reserved; + struct virtio_net_ctrl_coal coal; +}; + #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 + #define VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET 2 #define + VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET 3 \end{lstlisting} +The VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and +VIRTIO_NET_CTRL_NOTF_COAL_RX_SET commands use the
virtio_net_ctrl_coal
+structure to set \field{max_usecs} and \field{max_packets} for all transmit/receive virtqueues.(quoted diff) +3
-0+ +The VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command uses the +virtio_net_ctrl_coal_vq structure to set \field{max_usecs} and\field{max_packets} for the supplied virtqueue number \field{vqn}.
(quoted diff) +7
-0+ +The VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET command gets the values of +\field{max_usecs} and \field{max_packets} of the specified virtqueue +from the device by setting \field{vqn} in the virtio_net_ctrl_coal_vq structure. + +# Read/Write attributes for coalescing parameters \begin{itemize} \item +For commands VIRTIO_NET_CTRL_NOTF_COAL_TX_SET andQuoted 3 lines
VIRTIO_NET_CTRL_NOTF_COAL_RX_SET, \field{max_usecs}
+ and \field{max_packets} are write-only for a driver.
+\item For the commandVIRTIO_NET_CTRL_NOTF_COAL_VQ_SET, \field{vqn},Virtio spec is using vq number and vq index terminology interchangeably. For example, a new patch about admin vq, uses
aq_start_index.
Quoted 2 lines
MMIO device has
vq_indexregister too.
I am inclined tovq_indexgiven current state of spec and new additions by Michael.
Yes, both vq number and vq index exist in the existing spec. For example this paragraph:
"
\begin{description}
\item [vqn] VQ number to be notified.
\item [next_off] Offset
...
\end{description}
"
Quoted 3 lines
Michael,
Can you please suggest vqn orvq_indexto use?
Let's hear Michael's opinion.
Quoted 9 lines
Quoted 8 lines
\field{reserved}, \field{max_usecs}
+ and \field{max_packets} are write-only for a driver.
+\item For the commandVIRTIO_NET_CTRL_NOTF_COAL_VQ_GET, \field{vqn} and \field{reserved} are write-only+ for a driver, and, \field{max_usecs} and \field{max_packets} are read-only
for a driver.Remove this trailing "for a driver", it is a duplicate.
Ok.
Quoted 17 lines
Quoted 17 lines
+\end{itemize}
+
Coalescing parameters:
\begin{itemize}
+\item \field{vqn}: The virtqueue number of an enabled transmit or receive virtqueue.
\item \field{max_usecs} for RX: Maximum number of microseconds to delay a
RX notification.
\item \field{max_usecs} for TX: Maximum number of microseconds to delay a
TX notification.
\item \field{max_packets} for RX: Maximum number of packets to receive
before a RX notification.
\item \field{max_packets} for TX: Maximum number of packets to send before
a TX notification.
\end{itemize}
Quoted 5 lines
Quoted 4 lines
-The class
VIRTIO_NET_CTRL_NOTF_COALhas 2 commands:
+\field{vqn} points to an enabled transmit/receive virtqueue, and its value satisfies $ 0 \leq vqn <max_virtqueue_pairs\ast 2 $.
+This calculation description is not needed here. It is covered somewhere else.
Ok, I'll drop this.
Quoted 83 lines
Quoted 77 lines
+\field{reserved} is reserved and it is ignored by a device.
device-types/net/description.tex +2
-1+ +The class VIRTIO_NET_CTRL_NOTF_COAL has 4 commands: \begin{enumerate} -\item VIRTIO_NET_CTRL_NOTF_COAL_TX_SET: set the \field{max_usecs} and\field{max_packets} parameters for all transmit virtqueues. -\item
VIRTIO_NET_CTRL_NOTF_COAL_RX_SET: set the \field{max_usecs} and \field{max_packets} parameters for all receive virtqueues. +\itemVIRTIO_NET_CTRL_NOTF_COAL_VQ_SET: set the \field{max_usecs} and \field{max_packets} parameters for an enabled transmit/receive
+ virtqueue whose number is \field{vqn}.
+\itemVIRTIO_NET_CTRL_NOTF_COAL_VQ_GET: the device returns the \field{max_usecs} and \field{max_packets} parameters for an enabled
+ transmit/receive virtqueue whose number is \field{vqn}.
+\itemVIRTIO_NET_CTRL_NOTF_COAL_TX_SET: have the same effect as theVIRTIO_NET_CTRL_NOTF_COAL_VQ_SETcommand repeated for each virtqueue of transmitq1\ldots transmitqN.
+\itemVIRTIO_NET_CTRL_NOTF_COAL_RX_SET: have the same effect as theVIRTIO_NET_CTRL_NOTF_COAL_VQ_SETcommand repeated for each virtqueue of receiveq1\ldots receiveqN.
\end{enumerate}(quoted diff) +2
-0+If coalescing parameters are being set, the device applies the last +coalescing parameters received for a virtqueue, regardless of the commandused to set the parameters. For example with 2 pairs of virtqueues:
(quoted diff) +2
-0+# Command sequence +Each of the following commands sets \field{max_usecs} and\field{max_packets} parameters for virtqueues.
+\begin{itemize}
+\item Command1:VIRTIO_NET_CTRL_NOTF_COAL_RX_SETsets coalescing parameters for virtqueue0 and virtqueue2, and, virtqueue1 and virtqueue3 retain their previous parameter values.
+\item Command2:VIRTIO_NET_CTRL_NOTF_COAL_VQ_SETwith \field{vqn} = 0 sets coalescing parameters for virtqueue0, and virtqueue2 retains the values from command1.
+\item Command3:VIRTIO_NET_CTRL_NOTF_COAL_VQ_GETwith \field{vqn} = 0, the device responds with coalescing parameters of virtqueue0 set by command2.
+\item Command4:VIRTIO_NET_CTRL_NOTF_COAL_VQ_SETwith \field{vqn} = 1 sets coalescing parameters for virtqueue1, and virtqueue3 retains its previous values.
+\item Command5:VIRTIO_NET_CTRL_NOTF_COAL_TX_SETsets coalescing parameters for virtqueue1 and virtqueue3, and overrides the values set by command4.
+\item Command6:VIRTIO_NET_CTRL_NOTF_COAL_VQ_GETwith \field{vqn} = 1, the device responds with coalescing parameters of virtqueue1 set by command5.
+\end{itemize}
+
\subparagraph{Operation}\label{sec:Device Types / Network Device / Device
Operation / Control Virtqueue / Notifications Coalescing / Operation}The device sends a used buffer notification once the notification conditions are
met and if the notifications are not suppressed as explained in \ref{sec:Basic Facilities of a Virtio Device / Virtqueues / Used Buffer Notification Suppression}.(quoted diff) +0
-0@@ -1549,6 +1611,16 @@ \subsubsection{ControlVirtqueue}\label{sec:Device Types / Network Device / Devi
When the device has \field{max_usecs} = 0 or \field{max_packets} = 0, the
notification conditions are met after every packet received/sent.+When a device receives a command of the
VIRTIO_NET_CTRL_NOTF_COALclass
+to set a coalescing parameter, it may set the parameter to a value close to a power of 2. For example:
+If the device receives \field{max_usecs} = 7 from theVIRTIO_NET_CTRL_NOTF_COAL_VQ_SETcommand, it may set \field{max_usecs} = 8 for a given enabled virtqueue.(quoted diff) +4
-0+ +When the device receives the VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and +VIRTIO_NET_CTRL_NOTF_COAL_RX_SET commands, it saves the values of +coalescing parameters as global values, and the
VIRTIO_NET_CTRL_NOTF_COAL_VQ_SETcommand does not change the global values. If the device is reset, the global values will be set to 0.(quoted diff) +2
-0+ +When a virtqueue is reset, its coalescing parameters are set to the globalQuoted 2 lines
values.
+A VQ reset operation disables (or destroys) the VQ in the device. Hence, a vq under reset doesn't have any valid parameters. Therefore, above wording should be,
Quoted 1 line
When a virtqueue is enabled after it is reset, its coalescing parameters are set to global values as configured by
VIRTIO_NET_CTRL_NOTF_COAL_TX_SETorVIRTIO_NET_CTRL_NOTF_COAL_RX_SET.
Thanks for your suggestion! I think the following description can clarify?
“When a virtqueue is enabled after it is reset, its coalescing parameters are set to global values.” Because the global values have been mentioned above:
"
+When the device receives the VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and
+VIRTIO_NET_CTRL_NOTF_COAL_RX_SET commands, it saves the values of
+coalescing parameters as global values, and the VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command does not change the global values. If the device is reset, the global values will be set to 0.
"
and it may be 0 after device reset, or it may be the values set by VIRTIO_NET_CTRL_NOTF_COAL_RX_SET or VIRTIO_NET_CTRL_NOTF_COAL_TX_SET.
Thank!
Quoted 66 lines
Quoted 60 lines
\subparagraph{RX Example}\label{sec:Device Types / Network Device / Device
Operation / Control Virtqueue / Notifications Coalescing / RX Example}If, for example:
(quoted diff) +0
-0@@ -1585,11 +1657,29 @@ \subsubsection{ControlVirtqueue}\label{sec:Device Types / Network Device / Devi
\drivernormative{\subparagraph}{Notifications Coalescing}{Device Types /
Network Device / Device Operation / Control Virtqueue / Notifications Coalescing}-If the
VIRTIO_NET_F_NOTF_COALfeature has not been negotiated, the driver MUST NOT issueVIRTIO_NET_CTRL_NOTF_COALcommands.
+If neither theVIRTIO_NET_F_NOTF_COALnor theVIRTIO_NET_F_VQ_NOTF_COAL
+feature has been negotiated, the driver MUST NOT issueVIRTIO_NET_CTRL_NOTF_COALcommands.(quoted diff) +2
-0+ +A driver MUST ignore the values of coalescing parameters received from the
VIRTIO_NET_CTRL_NOTF_COAL_VQ_GETcommand if a device responds withVIRTIO_NET_ERR.\devicenormative{\subparagraph}{Notifications Coalescing}{Device Types /
Network Device / Device Operation / Control Virtqueue / Notifications Coalescing}-A device SHOULD respond to the
VIRTIO_NET_CTRL_NOTF_COALcommands withVIRTIO_NET_ERRif it was not able to change the parameters. +A device SHOULD respond toVIRTIO_NET_CTRL_NOTF_COAL_TX_SETandVIRTIO_NET_CTRL_NOTF_COAL_RX_SETcommands withVIRTIO_NET_ERRif it was not able to change the parameters.(quoted diff) +2
-0+ +A device MUST respond to the VIRTIO_NET_CTRL_NOTF_COAL_VQ_SETcommand with
VIRTIO_NET_ERRif it was not able to change the parameters.(quoted diff) +2
-0+ +A device MUST respond to VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET and
VIRTIO_NET_CTRL_NOTF_COAL_VQ_GETcommands withVIRTIO_NET_ERRif the given virtqueue is disabled.(quoted diff) +3
-0+ +The VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and +VIRTIO_NET_CTRL_NOTF_COAL_RX_SET commands set coalescing parametersfor all transmit/receive virtqueues respectively and values of coalescing parameters are recorded as global values by a device.
+The device MUST set the global values of coalescing parameters to 0 after being reset.
+TheVIRTIO_NET_CTRL_NOTF_COAL_VQ_SETcommand sets the coalescing parameters for a given enabled virtqueue without changing the global values.(quoted diff) +2
-0+ +After disabling and re-enabling a virtqueue, the device MUST revert coalescingparameters of the virtqueue to the global values.
(quoted diff) +2
-0+ +A device MAY set the coalescing parameter to a value close to a power of 2value.
device-types/net/description.tex +2
-0+ +A device MUST ignore \field{reserved}. A device SHOULD NOT send used buffer notifications to the driver if thenotifications are suppressed, even if the notification conditions are met.
Quoted 2 lines
--
2.19.1.6.gb485710b---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
Quoted 9 lines · Parav Pandit
Quoted 7 lines
From: Heng Qi <[email protected]>
Sent: Tuesday, February 21, 2023 10:22 PM+\item[VIRTIO_NET_F_VQ_NOTF_COAL(52)] Device supports virtqueue notification coalescing.
+s/notification/notifications
should be plural as multiple notifications are coalesced like the below description ofVIRTIO_NET_F_NOTF_COAL.
Hmm nope - this is the "reduced relative" construct. It's always in a singular form. The full form would be "coalescing of notifications of virtqueues" and that indeed would use a plural form. But technical writing is usually using the reduced relative form.
Quoted 75 lines
Quoted 68 lines
\item[VIRTIO_NET_F_NOTF_COAL(53)] Device supports notifications
coalescing.\item[VIRTIO_NET_F_GUEST_USO4 (54)] Driver can receive USOv4 packets.
(quoted diff) +0
-0@@ -139,6 +141,7 @@ \subsubsection{Feature bitrequirements}\label{sec:Device Types / Network Device \item[VIRTIO_NET_F_NOTF_COAL] Requires
VIRTIO_NET_F_CTRL_VQ.
\item[VIRTIO_NET_F_RSC_EXT] RequiresVIRTIO_NET_F_HOST_TSO4orVIRTIO_NET_F_HOST_TSO6.
\item[VIRTIO_NET_F_RSS] RequiresVIRTIO_NET_F_CTRL_VQ.
+\item[VIRTIO_NET_F_VQ_NOTF_COAL] RequiresVIRTIO_NET_F_CTRL_VQ.
\end{description}\subsubsection{Legacy Interface: Feature bits}\label{sec:Device Types /
Network Device / Feature bits / Legacy Interface: Feature bits} @@ -1508,6 +1511,14 @@ \subsubsection{Control Virtqueue}\label{sec:Device Types / Network Device / Devi If theVIRTIO_NET_F_NOTF_COALfeature is negotiated, the driver can send control commands for dynamically changing the coalescing parameters.+If the
VIRTIO_NET_F_VQ_NOTF_COALfeature is negotiated:
+\begin{itemize}
+\item a driver can send aVIRTIO_NET_CTRL_NOTF_COAL_VQ_SETcommand to set coalescing parameters of a given
+ enabled transmit/receive virtqueue.
+\item a driver can send aVIRTIO_NET_CTRL_NOTF_COAL_VQ_GETcommand to a device, and the device responds withdevice-types/net/description.tex +3
-0+ coalescing parameters of a given enabled transmit/receive virtqueue. +\end{itemize} + \begin{note} The behavior of the device in response to these commands is best-effort: the device may generate notifications more or less frequently than specified.@@ -1519,25 +1530,76 @@ \subsubsection{ControlVirtqueue}\label{sec:Device Types / Network Device / Devi
le32 max_usecs;};
device-types/net/description.tex +10
-0+struct virtio_net_ctrl_coal_vq { + le16 vqn; + le16 reserved; + struct virtio_net_ctrl_coal coal; +}; + #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 + #define VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET 2 #define + VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET 3 \end{lstlisting} +The VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and +VIRTIO_NET_CTRL_NOTF_COAL_RX_SET commands use the
virtio_net_ctrl_coal
+structure to set \field{max_usecs} and \field{max_packets} for all transmit/receive virtqueues.(quoted diff) +3
-0+ +The VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command uses the +virtio_net_ctrl_coal_vq structure to set \field{max_usecs} and\field{max_packets} for the supplied virtqueue number \field{vqn}.
(quoted diff) +7
-0+ +The VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET command gets the values of +\field{max_usecs} and \field{max_packets} of the specified virtqueue +from the device by setting \field{vqn} in the virtio_net_ctrl_coal_vq structure. + +# Read/Write attributes for coalescing parameters \begin{itemize} \item +For commands VIRTIO_NET_CTRL_NOTF_COAL_TX_SET andQuoted 3 lines
VIRTIO_NET_CTRL_NOTF_COAL_RX_SET, \field{max_usecs}
+ and \field{max_packets} are write-only for a driver.
+\item For the commandVIRTIO_NET_CTRL_NOTF_COAL_VQ_SET, \field{vqn},Virtio spec is using vq number and vq index terminology interchangeably. For example, a new patch about admin vq, uses
aq_start_index.
Quoted 2 lines
MMIO device has
vq_indexregister too.
I am inclined tovq_indexgiven current state of spec
[mst@tuck virtio]$ git grep vq_index|wc -l
0
Quoted 1 line
and new additions by Michael.
admin vq? Good point, I will change that to vqn too.
Quoted 2 lines
Michael,
Can you please suggest vqn orvq_indexto use?
[mst@tuck virtio]$ git grep vqn|wc -l
5
I'd say vqn has precedent.
Quoted 9 lines
Quoted 8 lines
\field{reserved}, \field{max_usecs}
+ and \field{max_packets} are write-only for a driver.
+\item For the commandVIRTIO_NET_CTRL_NOTF_COAL_VQ_GET, \field{vqn} and \field{reserved} are write-only+ for a driver, and, \field{max_usecs} and \field{max_packets} are read-only
for a driver.Remove this trailing "for a driver", it is a duplicate.
Nope it's required, without it, it's unclear which side is doing reading and which writing. Unfortunate that it's a bit verbose but we don't have better terms in the spec right now.
Quoted 16 lines
Quoted 16 lines
+\end{itemize}
+
Coalescing parameters:
\begin{itemize}
+\item \field{vqn}: The virtqueue number of an enabled transmit or receive virtqueue.
\item \field{max_usecs} for RX: Maximum number of microseconds to delay a
RX notification.
\item \field{max_usecs} for TX: Maximum number of microseconds to delay a
TX notification.
\item \field{max_packets} for RX: Maximum number of packets to receive
before a RX notification.
\item \field{max_packets} for TX: Maximum number of packets to send before
a TX notification.
\end{itemize}
Quoted 5 lines
Quoted 4 lines
-The class
VIRTIO_NET_CTRL_NOTF_COALhas 2 commands:
+\field{vqn} points to an enabled transmit/receive virtqueue, and its value satisfies $ 0 \leq vqn <max_virtqueue_pairs\ast 2 $.
+This calculation description is not needed here. It is covered somewhere else.
I agree.
Quoted 82 lines
Quoted 76 lines
+\field{reserved} is reserved and it is ignored by a device.
device-types/net/description.tex +2
-1+ +The class VIRTIO_NET_CTRL_NOTF_COAL has 4 commands: \begin{enumerate} -\item VIRTIO_NET_CTRL_NOTF_COAL_TX_SET: set the \field{max_usecs} and\field{max_packets} parameters for all transmit virtqueues. -\item
VIRTIO_NET_CTRL_NOTF_COAL_RX_SET: set the \field{max_usecs} and \field{max_packets} parameters for all receive virtqueues. +\itemVIRTIO_NET_CTRL_NOTF_COAL_VQ_SET: set the \field{max_usecs} and \field{max_packets} parameters for an enabled transmit/receive
+ virtqueue whose number is \field{vqn}.
+\itemVIRTIO_NET_CTRL_NOTF_COAL_VQ_GET: the device returns the \field{max_usecs} and \field{max_packets} parameters for an enabled
+ transmit/receive virtqueue whose number is \field{vqn}.
+\itemVIRTIO_NET_CTRL_NOTF_COAL_TX_SET: have the same effect as theVIRTIO_NET_CTRL_NOTF_COAL_VQ_SETcommand repeated for each virtqueue of transmitq1\ldots transmitqN.
+\itemVIRTIO_NET_CTRL_NOTF_COAL_RX_SET: have the same effect as theVIRTIO_NET_CTRL_NOTF_COAL_VQ_SETcommand repeated for each virtqueue of receiveq1\ldots receiveqN.
\end{enumerate}(quoted diff) +2
-0+If coalescing parameters are being set, the device applies the last +coalescing parameters received for a virtqueue, regardless of the commandused to set the parameters. For example with 2 pairs of virtqueues:
(quoted diff) +2
-0+# Command sequence +Each of the following commands sets \field{max_usecs} and\field{max_packets} parameters for virtqueues.
+\begin{itemize}
+\item Command1:VIRTIO_NET_CTRL_NOTF_COAL_RX_SETsets coalescing parameters for virtqueue0 and virtqueue2, and, virtqueue1 and virtqueue3 retain their previous parameter values.
+\item Command2:VIRTIO_NET_CTRL_NOTF_COAL_VQ_SETwith \field{vqn} = 0 sets coalescing parameters for virtqueue0, and virtqueue2 retains the values from command1.
+\item Command3:VIRTIO_NET_CTRL_NOTF_COAL_VQ_GETwith \field{vqn} = 0, the device responds with coalescing parameters of virtqueue0 set by command2.
+\item Command4:VIRTIO_NET_CTRL_NOTF_COAL_VQ_SETwith \field{vqn} = 1 sets coalescing parameters for virtqueue1, and virtqueue3 retains its previous values.
+\item Command5:VIRTIO_NET_CTRL_NOTF_COAL_TX_SETsets coalescing parameters for virtqueue1 and virtqueue3, and overrides the values set by command4.
+\item Command6:VIRTIO_NET_CTRL_NOTF_COAL_VQ_GETwith \field{vqn} = 1, the device responds with coalescing parameters of virtqueue1 set by command5.
+\end{itemize}
+
\subparagraph{Operation}\label{sec:Device Types / Network Device / Device
Operation / Control Virtqueue / Notifications Coalescing / Operation}The device sends a used buffer notification once the notification conditions are
met and if the notifications are not suppressed as explained in \ref{sec:Basic Facilities of a Virtio Device / Virtqueues / Used Buffer Notification Suppression}.(quoted diff) +0
-0@@ -1549,6 +1611,16 @@ \subsubsection{ControlVirtqueue}\label{sec:Device Types / Network Device / Devi
When the device has \field{max_usecs} = 0 or \field{max_packets} = 0, the
notification conditions are met after every packet received/sent.+When a device receives a command of the
VIRTIO_NET_CTRL_NOTF_COALclass
+to set a coalescing parameter, it may set the parameter to a value close to a power of 2. For example:
+If the device receives \field{max_usecs} = 7 from theVIRTIO_NET_CTRL_NOTF_COAL_VQ_SETcommand, it may set \field{max_usecs} = 8 for a given enabled virtqueue.(quoted diff) +4
-0+ +When the device receives the VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and +VIRTIO_NET_CTRL_NOTF_COAL_RX_SET commands, it saves the values of +coalescing parameters as global values, and the
VIRTIO_NET_CTRL_NOTF_COAL_VQ_SETcommand does not change the global values. If the device is reset, the global values will be set to 0.(quoted diff) +2
-0+ +When a virtqueue is reset, its coalescing parameters are set to the globalQuoted 2 lines
values.
+A VQ reset operation disables (or destroys) the VQ in the device. Hence, a vq under reset doesn't have any valid parameters. Therefore, above wording should be,
Quoted 1 line
When a virtqueue is enabled after it is reset, its coalescing parameters are set to global values as configured by
VIRTIO_NET_CTRL_NOTF_COAL_TX_SETorVIRTIO_NET_CTRL_NOTF_COAL_RX_SET.
Right though this repeats "it" twice. At which point the second it becomes slightly confusing. Not too bad but ""enabled after virtqueue reset" would address this.
Quoted 61 lines
Quoted 61 lines
\subparagraph{RX Example}\label{sec:Device Types / Network Device / Device
Operation / Control Virtqueue / Notifications Coalescing / RX Example}If, for example:
(quoted diff) +0
-0@@ -1585,11 +1657,29 @@ \subsubsection{ControlVirtqueue}\label{sec:Device Types / Network Device / Devi
\drivernormative{\subparagraph}{Notifications Coalescing}{Device Types /
Network Device / Device Operation / Control Virtqueue / Notifications Coalescing}-If the
VIRTIO_NET_F_NOTF_COALfeature has not been negotiated, the driver MUST NOT issueVIRTIO_NET_CTRL_NOTF_COALcommands.
+If neither theVIRTIO_NET_F_NOTF_COALnor theVIRTIO_NET_F_VQ_NOTF_COAL
+feature has been negotiated, the driver MUST NOT issueVIRTIO_NET_CTRL_NOTF_COALcommands.(quoted diff) +2
-0+ +A driver MUST ignore the values of coalescing parameters received from the
VIRTIO_NET_CTRL_NOTF_COAL_VQ_GETcommand if a device responds withVIRTIO_NET_ERR.\devicenormative{\subparagraph}{Notifications Coalescing}{Device Types /
Network Device / Device Operation / Control Virtqueue / Notifications Coalescing}-A device SHOULD respond to the
VIRTIO_NET_CTRL_NOTF_COALcommands withVIRTIO_NET_ERRif it was not able to change the parameters. +A device SHOULD respond toVIRTIO_NET_CTRL_NOTF_COAL_TX_SETandVIRTIO_NET_CTRL_NOTF_COAL_RX_SETcommands withVIRTIO_NET_ERRif it was not able to change the parameters.(quoted diff) +2
-0+ +A device MUST respond to the VIRTIO_NET_CTRL_NOTF_COAL_VQ_SETcommand with
VIRTIO_NET_ERRif it was not able to change the parameters.(quoted diff) +2
-0+ +A device MUST respond to VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET and
VIRTIO_NET_CTRL_NOTF_COAL_VQ_GETcommands withVIRTIO_NET_ERRif the given virtqueue is disabled.(quoted diff) +3
-0+ +The VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and +VIRTIO_NET_CTRL_NOTF_COAL_RX_SET commands set coalescing parametersfor all transmit/receive virtqueues respectively and values of coalescing parameters are recorded as global values by a device.
+The device MUST set the global values of coalescing parameters to 0 after being reset.
+TheVIRTIO_NET_CTRL_NOTF_COAL_VQ_SETcommand sets the coalescing parameters for a given enabled virtqueue without changing the global values.(quoted diff) +2
-0+ +After disabling and re-enabling a virtqueue, the device MUST revert coalescingparameters of the virtqueue to the global values.
(quoted diff) +2
-0+ +A device MAY set the coalescing parameter to a value close to a power of 2value.
device-types/net/description.tex +2
-0+ +A device MUST ignore \field{reserved}. A device SHOULD NOT send used buffer notifications to the driver if thenotifications are suppressed, even if the notification conditions are met.
--
2.19.1.6.gb485710b
Quoted 220 lines · Michael S. Tsirkin
Quoted 7 lines · Parav Pandit
Quoted 5 lines
From: Heng Qi <[email protected]>
Sent: Tuesday, February 21, 2023 10:22 PM +\item[VIRTIO_NET_F_VQ_NOTF_COAL(52)] Device supports virtqueue notification coalescing.
+s/notification/notifications
should be plural as multiple notifications are coalesced like the below description ofVIRTIO_NET_F_NOTF_COAL.Hmm nope - this is the "reduced relative" construct. It's always in a singular form. The full form would be "coalescing of notifications of virtqueues" and that indeed would use a plural form. But technical writing is usually using the reduced relative form.
Quoted 73 lines
Quoted 67 lines
\item[VIRTIO_NET_F_NOTF_COAL(53)] Device supports notifications
coalescing.\item[VIRTIO_NET_F_GUEST_USO4 (54)] Driver can receive USOv4 packets.
(quoted diff) +0
-0@@ -139,6 +141,7 @@ \subsubsection{Feature bitrequirements}\label{sec:Device Types / Network Device \item[VIRTIO_NET_F_NOTF_COAL] Requires
VIRTIO_NET_F_CTRL_VQ.
\item[VIRTIO_NET_F_RSC_EXT] RequiresVIRTIO_NET_F_HOST_TSO4orVIRTIO_NET_F_HOST_TSO6.
\item[VIRTIO_NET_F_RSS] RequiresVIRTIO_NET_F_CTRL_VQ.
+\item[VIRTIO_NET_F_VQ_NOTF_COAL] RequiresVIRTIO_NET_F_CTRL_VQ.
\end{description}\subsubsection{Legacy Interface: Feature bits}\label{sec:Device Types /
Network Device / Feature bits / Legacy Interface: Feature bits} @@ -1508,6 +1511,14 @@ \subsubsection{Control Virtqueue}\label{sec:Device Types / Network Device / Devi If theVIRTIO_NET_F_NOTF_COALfeature is negotiated, the driver can send control commands for dynamically changing the coalescing parameters.+If the
VIRTIO_NET_F_VQ_NOTF_COALfeature is negotiated:
+\begin{itemize}
+\item a driver can send aVIRTIO_NET_CTRL_NOTF_COAL_VQ_SETcommand to set coalescing parameters of a given
+ enabled transmit/receive virtqueue.
+\item a driver can send aVIRTIO_NET_CTRL_NOTF_COAL_VQ_GETcommand to a device, and the device responds withdevice-types/net/description.tex +3
-0+ coalescing parameters of a given enabled transmit/receive virtqueue. +\end{itemize} + \begin{note} The behavior of the device in response to these commands is best-effort: the device may generate notifications more or less frequently than specified.@@ -1519,25 +1530,76 @@ \subsubsection{ControlVirtqueue}\label{sec:Device Types / Network Device / Devi
le32 max_usecs;};
device-types/net/description.tex +10
-0+struct virtio_net_ctrl_coal_vq { + le16 vqn; + le16 reserved; + struct virtio_net_ctrl_coal coal; +}; + #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 + #define VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET 2 #define + VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET 3 \end{lstlisting} +The VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and +VIRTIO_NET_CTRL_NOTF_COAL_RX_SET commands use the
virtio_net_ctrl_coal
+structure to set \field{max_usecs} and \field{max_packets} for all transmit/receive virtqueues.(quoted diff) +3
-0+ +The VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command uses the +virtio_net_ctrl_coal_vq structure to set \field{max_usecs} and\field{max_packets} for the supplied virtqueue number \field{vqn}.
(quoted diff) +7
-0+ +The VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET command gets the values of +\field{max_usecs} and \field{max_packets} of the specified virtqueue +from the device by setting \field{vqn} in the virtio_net_ctrl_coal_vq structure. + +# Read/Write attributes for coalescing parameters \begin{itemize} \item +For commands VIRTIO_NET_CTRL_NOTF_COAL_TX_SET andQuoted 3 lines
VIRTIO_NET_CTRL_NOTF_COAL_RX_SET, \field{max_usecs}
+ and \field{max_packets} are write-only for a driver.
+\item For the commandVIRTIO_NET_CTRL_NOTF_COAL_VQ_SET, \field{vqn},Virtio spec is using vq number and vq index terminology interchangeably. For example, a new patch about admin vq, uses
aq_start_index.Quoted 2 lines
MMIO device has
vq_indexregister too.
I am inclined tovq_indexgiven current state of spec[mst@tuck virtio]$ git grep vq_index|wc -l
0Quoted 1 line
and new additions by Michael.
admin vq? Good point, I will change that to vqn too.
Quoted 2 lines
Michael,
Can you please suggest vqn orvq_indexto use?[mst@tuck virtio]$ git grep vqn|wc -l
5I'd say vqn has precedent.
Quoted 8 lines
Quoted 7 lines
\field{reserved}, \field{max_usecs}
+ and \field{max_packets} are write-only for a driver.
+\item For the commandVIRTIO_NET_CTRL_NOTF_COAL_VQ_GET, \field{vqn} and \field{reserved} are write-only+ for a driver, and, \field{max_usecs} and \field{max_packets} are read-only
for a driver.Remove this trailing "for a driver", it is a duplicate.
Nope it's required, without it, it's unclear which side is doing reading and which writing. Unfortunate that it's a bit verbose but we don't have better terms in the spec right now.
Quoted 16 lines
Quoted 16 lines
+\end{itemize}
+
Coalescing parameters:
\begin{itemize}
+\item \field{vqn}: The virtqueue number of an enabled transmit or receive virtqueue.
\item \field{max_usecs} for RX: Maximum number of microseconds to delay a
RX notification.
\item \field{max_usecs} for TX: Maximum number of microseconds to delay a
TX notification.
\item \field{max_packets} for RX: Maximum number of packets to receive
before a RX notification.
\item \field{max_packets} for TX: Maximum number of packets to send before
a TX notification.
\end{itemize}Quoted 5 lines
Quoted 4 lines
-The class
VIRTIO_NET_CTRL_NOTF_COALhas 2 commands:
+\field{vqn} points to an enabled transmit/receive virtqueue, and its value satisfies $ 0 \leq vqn <max_virtqueue_pairs\ast 2 $.
+This calculation description is not needed here. It is covered somewhere else.
I agree.
Quoted 82 lines
Quoted 76 lines
+\field{reserved} is reserved and it is ignored by a device.
device-types/net/description.tex +2
-1+ +The class VIRTIO_NET_CTRL_NOTF_COAL has 4 commands: \begin{enumerate} -\item VIRTIO_NET_CTRL_NOTF_COAL_TX_SET: set the \field{max_usecs} and\field{max_packets} parameters for all transmit virtqueues. -\item
VIRTIO_NET_CTRL_NOTF_COAL_RX_SET: set the \field{max_usecs} and \field{max_packets} parameters for all receive virtqueues. +\itemVIRTIO_NET_CTRL_NOTF_COAL_VQ_SET: set the \field{max_usecs} and \field{max_packets} parameters for an enabled transmit/receive
+ virtqueue whose number is \field{vqn}.
+\itemVIRTIO_NET_CTRL_NOTF_COAL_VQ_GET: the device returns the \field{max_usecs} and \field{max_packets} parameters for an enabled
+ transmit/receive virtqueue whose number is \field{vqn}.
+\itemVIRTIO_NET_CTRL_NOTF_COAL_TX_SET: have the same effect as theVIRTIO_NET_CTRL_NOTF_COAL_VQ_SETcommand repeated for each virtqueue of transmitq1\ldots transmitqN.
+\itemVIRTIO_NET_CTRL_NOTF_COAL_RX_SET: have the same effect as theVIRTIO_NET_CTRL_NOTF_COAL_VQ_SETcommand repeated for each virtqueue of receiveq1\ldots receiveqN.
\end{enumerate}(quoted diff) +2
-0+If coalescing parameters are being set, the device applies the last +coalescing parameters received for a virtqueue, regardless of the commandused to set the parameters. For example with 2 pairs of virtqueues:
(quoted diff) +2
-0+# Command sequence +Each of the following commands sets \field{max_usecs} and\field{max_packets} parameters for virtqueues.
+\begin{itemize}
+\item Command1:VIRTIO_NET_CTRL_NOTF_COAL_RX_SETsets coalescing parameters for virtqueue0 and virtqueue2, and, virtqueue1 and virtqueue3 retain their previous parameter values.
+\item Command2:VIRTIO_NET_CTRL_NOTF_COAL_VQ_SETwith \field{vqn} = 0 sets coalescing parameters for virtqueue0, and virtqueue2 retains the values from command1.
+\item Command3:VIRTIO_NET_CTRL_NOTF_COAL_VQ_GETwith \field{vqn} = 0, the device responds with coalescing parameters of virtqueue0 set by command2.
+\item Command4:VIRTIO_NET_CTRL_NOTF_COAL_VQ_SETwith \field{vqn} = 1 sets coalescing parameters for virtqueue1, and virtqueue3 retains its previous values.
+\item Command5:VIRTIO_NET_CTRL_NOTF_COAL_TX_SETsets coalescing parameters for virtqueue1 and virtqueue3, and overrides the values set by command4.
+\item Command6:VIRTIO_NET_CTRL_NOTF_COAL_VQ_GETwith \field{vqn} = 1, the device responds with coalescing parameters of virtqueue1 set by command5.
+\end{itemize}
+
\subparagraph{Operation}\label{sec:Device Types / Network Device / Device
Operation / Control Virtqueue / Notifications Coalescing / Operation}The device sends a used buffer notification once the notification conditions are
met and if the notifications are not suppressed as explained in \ref{sec:Basic Facilities of a Virtio Device / Virtqueues / Used Buffer Notification Suppression}.(quoted diff) +0
-0@@ -1549,6 +1611,16 @@ \subsubsection{ControlVirtqueue}\label{sec:Device Types / Network Device / Devi
When the device has \field{max_usecs} = 0 or \field{max_packets} = 0, the
notification conditions are met after every packet received/sent.+When a device receives a command of the
VIRTIO_NET_CTRL_NOTF_COALclass
+to set a coalescing parameter, it may set the parameter to a value close to a power of 2. For example:
+If the device receives \field{max_usecs} = 7 from theVIRTIO_NET_CTRL_NOTF_COAL_VQ_SETcommand, it may set \field{max_usecs} = 8 for a given enabled virtqueue.(quoted diff) +4
-0+ +When the device receives the VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and +VIRTIO_NET_CTRL_NOTF_COAL_RX_SET commands, it saves the values of +coalescing parameters as global values, and the
VIRTIO_NET_CTRL_NOTF_COAL_VQ_SETcommand does not change the global values. If the device is reset, the global values will be set to 0.(quoted diff) +2
-0+ +When a virtqueue is reset, its coalescing parameters are set to the globalQuoted 2 lines
values.
+A VQ reset operation disables (or destroys) the VQ in the device. Hence, a vq under reset doesn't have any valid parameters. Therefore, above wording should be,
Quoted 4 lines
Quoted 1 line
When a virtqueue is enabled after it is reset, its coalescing parameters are set to global values as configured by
VIRTIO_NET_CTRL_NOTF_COAL_TX_SETorVIRTIO_NET_CTRL_NOTF_COAL_RX_SET.Right though this repeats "it" twice. At which point the second it becomes slightly confusing. Not too bad but ""enabled after virtqueue reset" would address this.
Ok, I'll modify this.
Thanks.
Quoted 79 lines
Quoted 58 lines
Quoted 58 lines
\subparagraph{RX Example}\label{sec:Device Types / Network Device / Device
Operation / Control Virtqueue / Notifications Coalescing / RX Example}If, for example:
(quoted diff) +0
-0@@ -1585,11 +1657,29 @@ \subsubsection{ControlVirtqueue}\label{sec:Device Types / Network Device / Devi
\drivernormative{\subparagraph}{Notifications Coalescing}{Device Types /
Network Device / Device Operation / Control Virtqueue / Notifications Coalescing}-If the
VIRTIO_NET_F_NOTF_COALfeature has not been negotiated, the driver MUST NOT issueVIRTIO_NET_CTRL_NOTF_COALcommands.
+If neither theVIRTIO_NET_F_NOTF_COALnor theVIRTIO_NET_F_VQ_NOTF_COAL
+feature has been negotiated, the driver MUST NOT issueVIRTIO_NET_CTRL_NOTF_COALcommands.(quoted diff) +2
-0+ +A driver MUST ignore the values of coalescing parameters received from the
VIRTIO_NET_CTRL_NOTF_COAL_VQ_GETcommand if a device responds withVIRTIO_NET_ERR.\devicenormative{\subparagraph}{Notifications Coalescing}{Device Types /
Network Device / Device Operation / Control Virtqueue / Notifications Coalescing}-A device SHOULD respond to the
VIRTIO_NET_CTRL_NOTF_COALcommands withVIRTIO_NET_ERRif it was not able to change the parameters. +A device SHOULD respond toVIRTIO_NET_CTRL_NOTF_COAL_TX_SETandVIRTIO_NET_CTRL_NOTF_COAL_RX_SETcommands withVIRTIO_NET_ERRif it was not able to change the parameters.(quoted diff) +2
-0+ +A device MUST respond to the VIRTIO_NET_CTRL_NOTF_COAL_VQ_SETcommand with
VIRTIO_NET_ERRif it was not able to change the parameters.(quoted diff) +2
-0+ +A device MUST respond to VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET and
VIRTIO_NET_CTRL_NOTF_COAL_VQ_GETcommands withVIRTIO_NET_ERRif the given virtqueue is disabled.(quoted diff) +3
-0+ +The VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and +VIRTIO_NET_CTRL_NOTF_COAL_RX_SET commands set coalescing parametersfor all transmit/receive virtqueues respectively and values of coalescing parameters are recorded as global values by a device.
+The device MUST set the global values of coalescing parameters to 0 after being reset.
+TheVIRTIO_NET_CTRL_NOTF_COAL_VQ_SETcommand sets the coalescing parameters for a given enabled virtqueue without changing the global values.(quoted diff) +2
-0+ +After disabling and re-enabling a virtqueue, the device MUST revert coalescingparameters of the virtqueue to the global values.
(quoted diff) +2
-0+ +A device MAY set the coalescing parameter to a value close to a power of 2value.
(quoted diff) +2
-0+ +A device MUST ignore \field{reserved}.Quoted 5 lines
Quoted 5 lines
A device SHOULD NOT send used buffer notifications to the driver if the
notifications are suppressed, even if the notification conditions are met.--
2.19.1.6.gb485710bThis 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 11 lines
From: Michael S. Tsirkin <[email protected]>
Sent: Wednesday, February 22, 2023 1:29 AMQuoted 2 lines
MMIO device has
vq_indexregister too.
I am inclined tovq_indexgiven current state of spec[mst@tuck virtio]$ git grep vq_index|wc -l
0
:)
Grep for "virtqueue index".
We need to change "virtqueue index" to "virtqueue number".
Quoted 3 lines
Quoted 1 line
and new additions by Michael.
admin vq? Good point, I will change that to vqn too.
Ok. sounds good.
Quoted 9 lines
Quoted 3 lines
Michael,
Can you please suggest vqn orvq_indexto use?[mst@tuck virtio]$ git grep vqn|wc -l
5I'd say vqn has precedent.
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/
Hi, Parav.
Quoted 5 lines · Parav Pandit
Quoted 5 lines
From: Michael S. Tsirkin <[email protected]>
Sent: Wednesday, February 22, 2023 1:29 AMQuoted 2 lines
MMIO device has
vq_indexregister too.
I am inclined tovq_indexgiven current state of spec
Quoted 7 lines
Quoted 3 lines
[mst@tuck virtio]$ git grep vq_index|wc -l
0:)
Grep for "virtqueue index".
We need to change "virtqueue index" to "virtqueue number".
Yes, this is more unified in the spec. :)
This version is closed, please help review the v7 version [1] if you have time.
[1] https://lists.oasis-open.org/archives/virtio-dev/202302/msg00520.html
Thanks very much for your response!
Quoted 15 lines
Quoted 3 lines
Quoted 2 lines
and new additions by Michael.
admin vq? Good point, I will change that to vqn too.
Ok. sounds good.
Quoted 7 lines
Quoted 2 lines
Michael,
Can you please suggest vqn orvq_indexto use?[mst@tuck virtio]$ git grep vqn|wc -l
5I'd say vqn has precedent.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
Quoted 8 lines · Parav Pandit
Quoted 6 lines
From: Heng Qi <[email protected]>
Sent: Tuesday, February 21, 2023 10:22 PM+\item[VIRTIO_NET_F_VQ_NOTF_COAL(52)] Device supports virtqueue notification coalescing.
+s/notification/notifications
should be plural as multiple notifications are coalesced like the below description ofVIRTIO_NET_F_NOTF_COAL.
Using the plural sounds weird, and isn't it implied by "coalescing"? If there were not multiple, there would be nothing to coalesce :-)
Quoted 260 lines
Quoted 68 lines
\item[VIRTIO_NET_F_NOTF_COAL(53)] Device supports notifications
coalescing.\item[VIRTIO_NET_F_GUEST_USO4 (54)] Driver can receive USOv4 packets.
(quoted diff) +0
-0@@ -139,6 +141,7 @@ \subsubsection{Feature bitrequirements}\label{sec:Device Types / Network Device \item[VIRTIO_NET_F_NOTF_COAL] Requires
VIRTIO_NET_F_CTRL_VQ.
\item[VIRTIO_NET_F_RSC_EXT] RequiresVIRTIO_NET_F_HOST_TSO4orVIRTIO_NET_F_HOST_TSO6.
\item[VIRTIO_NET_F_RSS] RequiresVIRTIO_NET_F_CTRL_VQ.
+\item[VIRTIO_NET_F_VQ_NOTF_COAL] RequiresVIRTIO_NET_F_CTRL_VQ.
\end{description}\subsubsection{Legacy Interface: Feature bits}\label{sec:Device Types /
Network Device / Feature bits / Legacy Interface: Feature bits} @@ -1508,6 +1511,14 @@ \subsubsection{Control Virtqueue}\label{sec:Device Types / Network Device / Devi If theVIRTIO_NET_F_NOTF_COALfeature is negotiated, the driver can send control commands for dynamically changing the coalescing parameters.+If the
VIRTIO_NET_F_VQ_NOTF_COALfeature is negotiated:
+\begin{itemize}
+\item a driver can send aVIRTIO_NET_CTRL_NOTF_COAL_VQ_SETcommand to set coalescing parameters of a given
+ enabled transmit/receive virtqueue.
+\item a driver can send aVIRTIO_NET_CTRL_NOTF_COAL_VQ_GETcommand to a device, and the device responds withdevice-types/net/description.tex +3
-0+ coalescing parameters of a given enabled transmit/receive virtqueue. +\end{itemize} + \begin{note} The behavior of the device in response to these commands is best-effort: the device may generate notifications more or less frequently than specified.@@ -1519,25 +1530,76 @@ \subsubsection{ControlVirtqueue}\label{sec:Device Types / Network Device / Devi
le32 max_usecs;};
device-types/net/description.tex +10
-0+struct virtio_net_ctrl_coal_vq { + le16 vqn; + le16 reserved; + struct virtio_net_ctrl_coal coal; +}; + #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 + #define VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET 2 #define + VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET 3 \end{lstlisting} +The VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and +VIRTIO_NET_CTRL_NOTF_COAL_RX_SET commands use the
virtio_net_ctrl_coal
+structure to set \field{max_usecs} and \field{max_packets} for all transmit/receive virtqueues.(quoted diff) +3
-0+ +The VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command uses the +virtio_net_ctrl_coal_vq structure to set \field{max_usecs} and\field{max_packets} for the supplied virtqueue number \field{vqn}.
(quoted diff) +7
-0+ +The VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET command gets the values of +\field{max_usecs} and \field{max_packets} of the specified virtqueue +from the device by setting \field{vqn} in the virtio_net_ctrl_coal_vq structure. + +# Read/Write attributes for coalescing parameters \begin{itemize} \item +For commands VIRTIO_NET_CTRL_NOTF_COAL_TX_SET andQuoted 3 lines
VIRTIO_NET_CTRL_NOTF_COAL_RX_SET, \field{max_usecs}
+ and \field{max_packets} are write-only for a driver.
+\item For the commandVIRTIO_NET_CTRL_NOTF_COAL_VQ_SET, \field{vqn},Virtio spec is using vq number and vq index terminology interchangeably. For example, a new patch about admin vq, uses
aq_start_index.MMIO device has
vq_indexregister too.
I am inclined tovq_indexgiven current state of spec and new additions by Michael.Michael,
Can you please suggest vqn orvq_indexto use?Quoted 8 lines
\field{reserved}, \field{max_usecs}
+ and \field{max_packets} are write-only for a driver.
+\item For the commandVIRTIO_NET_CTRL_NOTF_COAL_VQ_GET, \field{vqn} and \field{reserved} are write-only+ for a driver, and, \field{max_usecs} and \field{max_packets} are read-only
for a driver.Remove this trailing "for a driver", it is a duplicate.
Quoted 16 lines
+\end{itemize}
+
Coalescing parameters:
\begin{itemize}
+\item \field{vqn}: The virtqueue number of an enabled transmit or receive virtqueue.
\item \field{max_usecs} for RX: Maximum number of microseconds to delay a
RX notification.
\item \field{max_usecs} for TX: Maximum number of microseconds to delay a
TX notification.
\item \field{max_packets} for RX: Maximum number of packets to receive
before a RX notification.
\item \field{max_packets} for TX: Maximum number of packets to send before
a TX notification.
\end{itemize}Quoted 4 lines
-The class
VIRTIO_NET_CTRL_NOTF_COALhas 2 commands:
+\field{vqn} points to an enabled transmit/receive virtqueue, and its value satisfies $ 0 \leq vqn <max_virtqueue_pairs\ast 2 $.
+This calculation description is not needed here. It is covered somewhere else.
Quoted 76 lines
+\field{reserved} is reserved and it is ignored by a device.
device-types/net/description.tex +2
-1+ +The class VIRTIO_NET_CTRL_NOTF_COAL has 4 commands: \begin{enumerate} -\item VIRTIO_NET_CTRL_NOTF_COAL_TX_SET: set the \field{max_usecs} and\field{max_packets} parameters for all transmit virtqueues. -\item
VIRTIO_NET_CTRL_NOTF_COAL_RX_SET: set the \field{max_usecs} and \field{max_packets} parameters for all receive virtqueues. +\itemVIRTIO_NET_CTRL_NOTF_COAL_VQ_SET: set the \field{max_usecs} and \field{max_packets} parameters for an enabled transmit/receive
+ virtqueue whose number is \field{vqn}.
+\itemVIRTIO_NET_CTRL_NOTF_COAL_VQ_GET: the device returns the \field{max_usecs} and \field{max_packets} parameters for an enabled
+ transmit/receive virtqueue whose number is \field{vqn}.
+\itemVIRTIO_NET_CTRL_NOTF_COAL_TX_SET: have the same effect as theVIRTIO_NET_CTRL_NOTF_COAL_VQ_SETcommand repeated for each virtqueue of transmitq1\ldots transmitqN.
+\itemVIRTIO_NET_CTRL_NOTF_COAL_RX_SET: have the same effect as theVIRTIO_NET_CTRL_NOTF_COAL_VQ_SETcommand repeated for each virtqueue of receiveq1\ldots receiveqN.
\end{enumerate}(quoted diff) +2
-0+If coalescing parameters are being set, the device applies the last +coalescing parameters received for a virtqueue, regardless of the commandused to set the parameters. For example with 2 pairs of virtqueues:
(quoted diff) +2
-0+# Command sequence +Each of the following commands sets \field{max_usecs} and\field{max_packets} parameters for virtqueues.
+\begin{itemize}
+\item Command1:VIRTIO_NET_CTRL_NOTF_COAL_RX_SETsets coalescing parameters for virtqueue0 and virtqueue2, and, virtqueue1 and virtqueue3 retain their previous parameter values.
+\item Command2:VIRTIO_NET_CTRL_NOTF_COAL_VQ_SETwith \field{vqn} = 0 sets coalescing parameters for virtqueue0, and virtqueue2 retains the values from command1.
+\item Command3:VIRTIO_NET_CTRL_NOTF_COAL_VQ_GETwith \field{vqn} = 0, the device responds with coalescing parameters of virtqueue0 set by command2.
+\item Command4:VIRTIO_NET_CTRL_NOTF_COAL_VQ_SETwith \field{vqn} = 1 sets coalescing parameters for virtqueue1, and virtqueue3 retains its previous values.
+\item Command5:VIRTIO_NET_CTRL_NOTF_COAL_TX_SETsets coalescing parameters for virtqueue1 and virtqueue3, and overrides the values set by command4.
+\item Command6:VIRTIO_NET_CTRL_NOTF_COAL_VQ_GETwith \field{vqn} = 1, the device responds with coalescing parameters of virtqueue1 set by command5.
+\end{itemize}
+
\subparagraph{Operation}\label{sec:Device Types / Network Device / Device
Operation / Control Virtqueue / Notifications Coalescing / Operation}The device sends a used buffer notification once the notification conditions are
met and if the notifications are not suppressed as explained in \ref{sec:Basic Facilities of a Virtio Device / Virtqueues / Used Buffer Notification Suppression}.(quoted diff) +0
-0@@ -1549,6 +1611,16 @@ \subsubsection{ControlVirtqueue}\label{sec:Device Types / Network Device / Devi
When the device has \field{max_usecs} = 0 or \field{max_packets} = 0, the
notification conditions are met after every packet received/sent.+When a device receives a command of the
VIRTIO_NET_CTRL_NOTF_COALclass
+to set a coalescing parameter, it may set the parameter to a value close to a power of 2. For example:
+If the device receives \field{max_usecs} = 7 from theVIRTIO_NET_CTRL_NOTF_COAL_VQ_SETcommand, it may set \field{max_usecs} = 8 for a given enabled virtqueue.(quoted diff) +4
-0+ +When the device receives the VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and +VIRTIO_NET_CTRL_NOTF_COAL_RX_SET commands, it saves the values of +coalescing parameters as global values, and the
VIRTIO_NET_CTRL_NOTF_COAL_VQ_SETcommand does not change the global values. If the device is reset, the global values will be set to 0.(quoted diff) +2
-0+ +When a virtqueue is reset, its coalescing parameters are set to the globalQuoted 2 lines
values.
+A VQ reset operation disables (or destroys) the VQ in the device. Hence, a vq under reset doesn't have any valid parameters. Therefore, above wording should be,
When a virtqueue is enabled after it is reset, its coalescing parameters are set to global values as configured by
VIRTIO_NET_CTRL_NOTF_COAL_TX_SETorVIRTIO_NET_CTRL_NOTF_COAL_RX_SET.Quoted 61 lines
\subparagraph{RX Example}\label{sec:Device Types / Network Device / Device
Operation / Control Virtqueue / Notifications Coalescing / RX Example}If, for example:
(quoted diff) +0
-0@@ -1585,11 +1657,29 @@ \subsubsection{ControlVirtqueue}\label{sec:Device Types / Network Device / Devi
\drivernormative{\subparagraph}{Notifications Coalescing}{Device Types /
Network Device / Device Operation / Control Virtqueue / Notifications Coalescing}-If the
VIRTIO_NET_F_NOTF_COALfeature has not been negotiated, the driver MUST NOT issueVIRTIO_NET_CTRL_NOTF_COALcommands.
+If neither theVIRTIO_NET_F_NOTF_COALnor theVIRTIO_NET_F_VQ_NOTF_COAL
+feature has been negotiated, the driver MUST NOT issueVIRTIO_NET_CTRL_NOTF_COALcommands.(quoted diff) +2
-0+ +A driver MUST ignore the values of coalescing parameters received from the
VIRTIO_NET_CTRL_NOTF_COAL_VQ_GETcommand if a device responds withVIRTIO_NET_ERR.\devicenormative{\subparagraph}{Notifications Coalescing}{Device Types /
Network Device / Device Operation / Control Virtqueue / Notifications Coalescing}-A device SHOULD respond to the
VIRTIO_NET_CTRL_NOTF_COALcommands withVIRTIO_NET_ERRif it was not able to change the parameters. +A device SHOULD respond toVIRTIO_NET_CTRL_NOTF_COAL_TX_SETandVIRTIO_NET_CTRL_NOTF_COAL_RX_SETcommands withVIRTIO_NET_ERRif it was not able to change the parameters.(quoted diff) +2
-0+ +A device MUST respond to the VIRTIO_NET_CTRL_NOTF_COAL_VQ_SETcommand with
VIRTIO_NET_ERRif it was not able to change the parameters.(quoted diff) +2
-0+ +A device MUST respond to VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET and
VIRTIO_NET_CTRL_NOTF_COAL_VQ_GETcommands withVIRTIO_NET_ERRif the given virtqueue is disabled.(quoted diff) +3
-0+ +The VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and +VIRTIO_NET_CTRL_NOTF_COAL_RX_SET commands set coalescing parametersfor all transmit/receive virtqueues respectively and values of coalescing parameters are recorded as global values by a device.
+The device MUST set the global values of coalescing parameters to 0 after being reset.
+TheVIRTIO_NET_CTRL_NOTF_COAL_VQ_SETcommand sets the coalescing parameters for a given enabled virtqueue without changing the global values.(quoted diff) +2
-0+ +After disabling and re-enabling a virtqueue, the device MUST revert coalescingparameters of the virtqueue to the global values.
(quoted diff) +2
-0+ +A device MAY set the coalescing parameter to a value close to a power of 2value.
device-types/net/description.tex +2
-0+ +A device MUST ignore \field{reserved}. A device SHOULD NOT send used buffer notifications to the driver if thenotifications are suppressed, even if the notification conditions are met.
--
2.19.1.6.gb485710b
Signature · 17 lines
Tonight I think I'll walk alone, I'll find my soul as I go home. 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/
Hi Heng,
Quoted 138 lines
Currently, coalescing parameters are grouped for all transmit and receive virtqueues. This patch supports setting or getting the parameters for a specified virtqueue, and a typical application of this function is netdim[1].
When the traffic between virtqueues is unbalanced, for example, one virtqueue is busy and another virtqueue is idle, then it will be very useful to control coalescing parameters at the virtqueue granularity.
[1] https://docs.kernel.org/networking/net_dim.html
Signed-off-by Heng Qi <[email protected]>Reviewed-by Xuan Zhuo <[email protected]>---
This patch is on top of Alvaro's latest v7 patch: https://lists.oasis-open.org/archives/virtio-dev/202302/msg00431.html .
v5->v6:
1. Explain that the device may set a different value than the one passed in by the driver. @David Edmondson
v4->v5:
1. Add the correspondence betweenvirtio_net_ctrl_coalandvirtio_net_ctrl_coal_vqand control commands. @Michael S. Tsirkin
2. Add read and write attributes for each field. @Michael S. Tsirkin
3. A clearer description of how to set coalescing parameters for vq reset. @Michael S. Tsirkin
4. Fix some syntax errors. @Michael S. Tsirkin, @David Edmondson
v3->v4:
1. Includevirtio_net_ctrl_coalin thevirtio_net_ctrl_coal_vqstructure. @Alvaro Karsz
2. Add consideration of vq reset. @Michael S. Tsirkin, @Parav Pandit, @Alvaro Karsz
3. Avoid too many examples by giving a comprehensive example. @Michael S. Tsirkin
4. Fix typos and streamline clarifications. @Michael S. Tsirkin, @Parav Pandit, @Alvaro Karsz
v2->v3:
1. Add the netdim link. @Parav Pandit
2.VIRTIO_NET_F_VQ_NOTF_COALno longer depends onVIRTIO_NET_F_NOTF_COAL. @Michael S. Tsirkin, @Alvaro Karsz
3._VQ_GETis explained more. @Michael S. Tsirkin
4. Add more examples to avoid misunderstandings. @Michael S. Tsirkin
5. Clarify some statements. @Michael S. Tsirkin, @Parav Pandit, @Alvaro Karsz
6. Adjust thevirtio_net_ctrl_coal_vqstructure. @Michael S. Tsirkin
7. Fix some typos. @Michael S. Tsirkin
v1->v2:
1. RenameVIRTIO_NET_F_PERQUEUE_NOTF_COALtoVIRTIO_NET_F_VQ_NOTF_COAL. @Michael S. Tsirkin
2. Use the \field{vqn} instead of the qid. @Michael S. Tsirkin
3. Unify tx and rx control structres into one structurevirtio_net_ctrl_coal_vq. @Michael S. Tsirkin
4. Add a new control commandVIRTIO_NET_CTRL_NOTF_COAL_VQ. @Michael S. Tsirkin, @Parav Pandit, @Alvaro Karsz
5. The special value0xFFFis removed becauseVIRTIO_NET_CTRL_NOTF_COALcan be used. @Alvaro Karsz
6. Clarify some special scenarios. @Michael S. Tsirkin, @Parav Pandit, @Alvaro Karszdevice-types/net/description.tex | 100 +++++++++++++++++++++++++++++-- 1 file changed, 95 insertions(+), 5 deletions(-)device-types/net/description.tex +44
-1@@ -83,6 +83,8 @@ \subsection{Feature bits}\label{sec:Device Types / Network Device / Feature bits \item[VIRTIO_NET_F_CTRL_MAC_ADDR(23)] Set MAC address through control channel. +\item[VIRTIO_NET_F_VQ_NOTF_COAL(52)] Device supports virtqueue notification coalescing. + \item[VIRTIO_NET_F_NOTF_COAL(53)] Device supports notifications coalescing. \item[VIRTIO_NET_F_GUEST_USO4 (54)] Driver can receive USOv4 packets.@@ -139,6 +141,7 @@ \subsubsection{Feature bit requirements}\label{sec:Device Types / Network Device \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. +\item[VIRTIO_NET_F_VQ_NOTF_COAL] Requires VIRTIO_NET_F_CTRL_VQ. \end{description} \subsubsection{Legacy Interface: Feature bits}\label{sec:Device Types / Network Device / Feature bits / Legacy Interface: Feature bits}@@ -1508,6 +1511,14 @@ \subsubsection{Control Virtqueue}\label{sec:Device Types / Network Device / Devi If the VIRTIO_NET_F_NOTF_COAL feature is negotiated, the driver can send control commands for dynamically changing the coalescing parameters. +If the VIRTIO_NET_F_VQ_NOTF_COAL feature is negotiated: +\begin{itemize} +\item a driver can send a VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command to set coalescing parameters of a given + enabled transmit/receive virtqueue. +\item a driver can send a VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET command to a device, and the device responds with + coalescing parameters of a given enabled transmit/receive virtqueue. +\end{itemize} + \begin{note} The behavior of the device in response to these commands is best-effort: the device may generate notifications more or less frequently than specified.@@ -1519,25 +1530,76 @@ \subsubsection{Control Virtqueue}\label{sec:Device Types / Network Device / Devi le32 max_usecs; }; +struct virtio_net_ctrl_coal_vq { + le16 vqn; + le16 reserved; + struct virtio_net_ctrl_coal coal; +}; + #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 + #define VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET 2 + #define VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET 3 \end{lstlisting} +The VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and VIRTIO_NET_CTRL_NOTF_COAL_RX_SET commands use the +virtio_net_ctrl_coal structure to set \field{max_usecs} and \field{max_packets} for all +transmit/receive virtqueues. + +The VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command uses the virtio_net_ctrl_coal_vq structure +to set \field{max_usecs} and \field{max_packets} for the supplied virtqueue number \field{vqn}. + +The VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET command gets the values of \field{max_usecs} and +\field{max_packets} of the specified virtqueue from the device by setting \field{vqn} +in the virtio_net_ctrl_coal_vq structure. + +# Read/Write attributes for coalescing parameters +\begin{itemize} +\item For commands VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and VIRTIO_NET_CTRL_NOTF_COAL_RX_SET, \field{max_usecs} + and \field{max_packets} are write-only for a driver. +\item For the command VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET, \field{vqn}, \field{reserved}, \field{max_usecs} + and \field{max_packets} are write-only for a driver. +\item For the command VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET, \field{vqn} and \field{reserved} are write-only + for a driver, and, \field{max_usecs} and \field{max_packets} are read-only for a driver. +\end{itemize} + Coalescing parameters: \begin{itemize} +\item \field{vqn}: The virtqueue number of an enabled transmit or receive virtqueue. \item \field{max_usecs} for RX: Maximum number of microseconds to delay a RX notification. \item \field{max_usecs} for TX: Maximum number of microseconds to delay a TX notification. \item \field{max_packets} for RX: Maximum number of packets to receive before a RX notification. \item \field{max_packets} for TX: Maximum number of packets to send before a TX notification. \end{itemize} -The class VIRTIO_NET_CTRL_NOTF_COAL has 2 commands: +\field{vqn} points to an enabled transmit/receive virtqueue, and its value satisfies $ 0 \leq vqn < max_virtqueue_pairs \ast 2 $. + +\field{reserved} is reserved and it is ignored by a device.
device-types/net/description.tex \subsubsection{Control Virtqueue}\label{sec:Device Types / Network Device / Devi · line 1586
Quoted 10 lines
device-types/net/description.tex +7
-2+ +The class VIRTIO_NET_CTRL_NOTF_COAL has 4 commands: \begin{enumerate} -\item VIRTIO_NET_CTRL_NOTF_COAL_TX_SET: set the \field{max_usecs} and \field{max_packets} parameters for all transmit virtqueues. -\item VIRTIO_NET_CTRL_NOTF_COAL_RX_SET: set the \field{max_usecs} and \field{max_packets} parameters for all receive virtqueues. +\item VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET: set the \field{max_usecs} and \field{max_packets} parameters for an enabled transmit/receive + virtqueue whose number is \field{vqn}. +\item VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET: the device returns the \field{max_usecs} and \field{max_packets} parameters for an enabled + transmit/receive virtqueue whose number is \field{vqn}. +\item VIRTIO_NET_CTRL_NOTF_COAL_TX_SET: have the same effect as the VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command repeated for each virtqueue of transmitq1\ldots transmitqN.
You mention later that VIRTIO_NET_CTRL_NOTF_COAL_TX_SET sets the global parameters and repeating VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET for each transmitq doesn't, so it's not exactly the same effect. Same for VIRTIO_NET_CTRL_NOTF_COAL_RX_SET.
Quoted 69 lines
device-types/net/description.tex +44
-3+\item VIRTIO_NET_CTRL_NOTF_COAL_RX_SET: have the same effect as the VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command repeated for each virtqueue of receiveq1\ldots receiveqN. \end{enumerate} +If coalescing parameters are being set, the device applies the last coalescing parameters received for a +virtqueue, regardless of the command used to set the parameters. For example with 2 pairs of virtqueues: +# Command sequence +Each of the following commands sets \field{max_usecs} and \field{max_packets} parameters for virtqueues. +\begin{itemize} +\item Command1: VIRTIO_NET_CTRL_NOTF_COAL_RX_SET sets coalescing parameters for virtqueue0 and virtqueue2, and, virtqueue1 and virtqueue3 retain their previous parameter values. +\item Command2: VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET with \field{vqn} = 0 sets coalescing parameters for virtqueue0, and virtqueue2 retains the values from command1. +\item Command3: VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET with \field{vqn} = 0, the device responds with coalescing parameters of virtqueue0 set by command2. +\item Command4: VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET with \field{vqn} = 1 sets coalescing parameters for virtqueue1, and virtqueue3 retains its previous values. +\item Command5: VIRTIO_NET_CTRL_NOTF_COAL_TX_SET sets coalescing parameters for virtqueue1 and virtqueue3, and overrides the values set by command4. +\item Command6: VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET with \field{vqn} = 1, the device responds with coalescing parameters of virtqueue1 set by command5. +\end{itemize} + \subparagraph{Operation}\label{sec:Device Types / Network Device / Device Operation / Control Virtqueue / Notifications Coalescing / Operation} The device sends a used buffer notification once the notification conditions are met and if the notifications are not suppressed as explained in \ref{sec:Basic Facilities of a Virtio Device / Virtqueues / Used Buffer Notification Suppression}.@@ -1549,6 +1611,16 @@ \subsubsection{Control Virtqueue}\label{sec:Device Types / Network Device / Devi When the device has \field{max_usecs} = 0 or \field{max_packets} = 0, the notification conditions are met after every packet received/sent. +When a device receives a command of the VIRTIO_NET_CTRL_NOTF_COAL class to set a coalescing parameter, +it may set the parameter to a value close to a power of 2. For example: +If the device receives \field{max_usecs} = 7 from the VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command, it may set \field{max_usecs} = 8 for a given enabled virtqueue. + +When the device receives the VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and VIRTIO_NET_CTRL_NOTF_COAL_RX_SET commands, +it saves the values of coalescing parameters as global values, and the VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command +does not change the global values. If the device is reset, the global values will be set to 0. + +When a virtqueue is reset, its coalescing parameters are set to the global values. + \subparagraph{RX Example}\label{sec:Device Types / Network Device / Device Operation / Control Virtqueue / Notifications Coalescing / RX Example} If, for example:@@ -1585,11 +1657,29 @@ \subsubsection{Control Virtqueue}\label{sec:Device Types / Network Device / Devi \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. +If neither the VIRTIO_NET_F_NOTF_COAL nor the VIRTIO_NET_F_VQ_NOTF_COAL feature +has been negotiated, the driver MUST NOT issue VIRTIO_NET_CTRL_NOTF_COAL commands. + +A driver MUST ignore the values of coalescing parameters received from the VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET command if a device responds with VIRTIO_NET_ERR. \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 it was not able to change the parameters. +A device SHOULD respond to VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and VIRTIO_NET_CTRL_NOTF_COAL_RX_SET commands with VIRTIO_NET_ERR if it was not able to change the parameters. + +A device MUST respond to the VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command with VIRTIO_NET_ERR if it was not able to change the parameters. + +A device MUST respond to VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET and VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET commands with VIRTIO_NET_ERR if the given virtqueue is disabled. + +The VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and VIRTIO_NET_CTRL_NOTF_COAL_RX_SET commands set coalescing parameters for all transmit/receive +virtqueues respectively and values of coalescing parameters are recorded as global values by a device. +The device MUST set the global values of coalescing parameters to 0 after being reset. +The VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command sets the coalescing parameters for a given enabled virtqueue without changing the global values. + +After disabling and re-enabling a virtqueue, the device MUST revert coalescing parameters of the virtqueue to the global values. + +A device MAY set the coalescing parameter to a value close to a power of 2 value. + +A device MUST ignore \field{reserved}. A device SHOULD NOT send used buffer notifications to the driver if the notifications are suppressed, even if the notification conditions are met. --
Hi, Alvaro.
Quoted 144 lines · Alvaro Karsz
Hi Heng,
Quoted 142 lines
Currently, coalescing parameters are grouped for all transmit and receive virtqueues. This patch supports setting or getting the parameters for a specified virtqueue, and a typical application of this function is netdim[1].
When the traffic between virtqueues is unbalanced, for example, one virtqueue is busy and another virtqueue is idle, then it will be very useful to control coalescing parameters at the virtqueue granularity.
[1] https://docs.kernel.org/networking/net_dim.html
Signed-off-by Heng Qi <[email protected]>Reviewed-by Xuan Zhuo <[email protected]>---
This patch is on top of Alvaro's latest v7 patch: https://lists.oasis-open.org/archives/virtio-dev/202302/msg00431.html .
v5->v6:
1. Explain that the device may set a different value than the one passed in by the driver. @David Edmondson
v4->v5:
1. Add the correspondence betweenvirtio_net_ctrl_coalandvirtio_net_ctrl_coal_vqand control commands. @Michael S. Tsirkin
2. Add read and write attributes for each field. @Michael S. Tsirkin
3. A clearer description of how to set coalescing parameters for vq reset. @Michael S. Tsirkin
4. Fix some syntax errors. @Michael S. Tsirkin, @David Edmondson
v3->v4:
1. Includevirtio_net_ctrl_coalin thevirtio_net_ctrl_coal_vqstructure. @Alvaro Karsz
2. Add consideration of vq reset. @Michael S. Tsirkin, @Parav Pandit, @Alvaro Karsz
3. Avoid too many examples by giving a comprehensive example. @Michael S. Tsirkin
4. Fix typos and streamline clarifications. @Michael S. Tsirkin, @Parav Pandit, @Alvaro Karsz
v2->v3:
1. Add the netdim link. @Parav Pandit
2.VIRTIO_NET_F_VQ_NOTF_COALno longer depends onVIRTIO_NET_F_NOTF_COAL. @Michael S. Tsirkin, @Alvaro Karsz
3._VQ_GETis explained more. @Michael S. Tsirkin
4. Add more examples to avoid misunderstandings. @Michael S. Tsirkin
5. Clarify some statements. @Michael S. Tsirkin, @Parav Pandit, @Alvaro Karsz
6. Adjust thevirtio_net_ctrl_coal_vqstructure. @Michael S. Tsirkin
7. Fix some typos. @Michael S. Tsirkin
v1->v2:
1. RenameVIRTIO_NET_F_PERQUEUE_NOTF_COALtoVIRTIO_NET_F_VQ_NOTF_COAL. @Michael S. Tsirkin
2. Use the \field{vqn} instead of the qid. @Michael S. Tsirkin
3. Unify tx and rx control structres into one structurevirtio_net_ctrl_coal_vq. @Michael S. Tsirkin
4. Add a new control commandVIRTIO_NET_CTRL_NOTF_COAL_VQ. @Michael S. Tsirkin, @Parav Pandit, @Alvaro Karsz
5. The special value0xFFFis removed becauseVIRTIO_NET_CTRL_NOTF_COALcan be used. @Alvaro Karsz
6. Clarify some special scenarios. @Michael S. Tsirkin, @Parav Pandit, @Alvaro Karszdevice-types/net/description.tex | 100 +++++++++++++++++++++++++++++-- 1 file changed, 95 insertions(+), 5 deletions(-)device-types/net/description.tex +46
-3@@ -83,6 +83,8 @@ \subsection{Feature bits}\label{sec:Device Types / Network Device / Feature bits \item[VIRTIO_NET_F_CTRL_MAC_ADDR(23)] Set MAC address through control channel. +\item[VIRTIO_NET_F_VQ_NOTF_COAL(52)] Device supports virtqueue notification coalescing. + \item[VIRTIO_NET_F_NOTF_COAL(53)] Device supports notifications coalescing. \item[VIRTIO_NET_F_GUEST_USO4 (54)] Driver can receive USOv4 packets.@@ -139,6 +141,7 @@ \subsubsection{Feature bit requirements}\label{sec:Device Types / Network Device \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. +\item[VIRTIO_NET_F_VQ_NOTF_COAL] Requires VIRTIO_NET_F_CTRL_VQ. \end{description} \subsubsection{Legacy Interface: Feature bits}\label{sec:Device Types / Network Device / Feature bits / Legacy Interface: Feature bits}@@ -1508,6 +1511,14 @@ \subsubsection{Control Virtqueue}\label{sec:Device Types / Network Device / Devi If the VIRTIO_NET_F_NOTF_COAL feature is negotiated, the driver can send control commands for dynamically changing the coalescing parameters. +If the VIRTIO_NET_F_VQ_NOTF_COAL feature is negotiated: +\begin{itemize} +\item a driver can send a VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command to set coalescing parameters of a given + enabled transmit/receive virtqueue. +\item a driver can send a VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET command to a device, and the device responds with + coalescing parameters of a given enabled transmit/receive virtqueue. +\end{itemize} + \begin{note} The behavior of the device in response to these commands is best-effort: the device may generate notifications more or less frequently than specified.@@ -1519,25 +1530,76 @@ \subsubsection{Control Virtqueue}\label{sec:Device Types / Network Device / Devi le32 max_usecs; }; +struct virtio_net_ctrl_coal_vq { + le16 vqn; + le16 reserved; + struct virtio_net_ctrl_coal coal; +}; + #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 + #define VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET 2 + #define VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET 3 \end{lstlisting} +The VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and VIRTIO_NET_CTRL_NOTF_COAL_RX_SET commands use the +virtio_net_ctrl_coal structure to set \field{max_usecs} and \field{max_packets} for all +transmit/receive virtqueues. + +The VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command uses the virtio_net_ctrl_coal_vq structure +to set \field{max_usecs} and \field{max_packets} for the supplied virtqueue number \field{vqn}. + +The VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET command gets the values of \field{max_usecs} and +\field{max_packets} of the specified virtqueue from the device by setting \field{vqn} +in the virtio_net_ctrl_coal_vq structure. + +# Read/Write attributes for coalescing parameters +\begin{itemize} +\item For commands VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and VIRTIO_NET_CTRL_NOTF_COAL_RX_SET, \field{max_usecs} + and \field{max_packets} are write-only for a driver. +\item For the command VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET, \field{vqn}, \field{reserved}, \field{max_usecs} + and \field{max_packets} are write-only for a driver. +\item For the command VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET, \field{vqn} and \field{reserved} are write-only + for a driver, and, \field{max_usecs} and \field{max_packets} are read-only for a driver. +\end{itemize} + Coalescing parameters: \begin{itemize} +\item \field{vqn}: The virtqueue number of an enabled transmit or receive virtqueue. \item \field{max_usecs} for RX: Maximum number of microseconds to delay a RX notification. \item \field{max_usecs} for TX: Maximum number of microseconds to delay a TX notification. \item \field{max_packets} for RX: Maximum number of packets to receive before a RX notification. \item \field{max_packets} for TX: Maximum number of packets to send before a TX notification. \end{itemize} -The class VIRTIO_NET_CTRL_NOTF_COAL has 2 commands: +\field{vqn} points to an enabled transmit/receive virtqueue, and its value satisfies $ 0 \leq vqn < max_virtqueue_pairs \ast 2 $. + +\field{reserved} is reserved and it is ignored by a device. + +The class VIRTIO_NET_CTRL_NOTF_COAL has 4 commands: \begin{enumerate} -\item VIRTIO_NET_CTRL_NOTF_COAL_TX_SET: set the \field{max_usecs} and \field{max_packets} parameters for all transmit virtqueues. -\item VIRTIO_NET_CTRL_NOTF_COAL_RX_SET: set the \field{max_usecs} and \field{max_packets} parameters for all receive virtqueues.
Quoted 8 lines
device-types/net/description.tex \subsubsection{Control Virtqueue}\label{sec:Device Types / Network Device / Devi · line 1586
Quoted 5 lines
device-types/net/description.tex +5
-0+\item VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET: set the \field{max_usecs} and \field{max_packets} parameters for an enabled transmit/receive + virtqueue whose number is \field{vqn}. +\item VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET: the device returns the \field{max_usecs} and \field{max_packets} parameters for an enabled + transmit/receive virtqueue whose number is \field{vqn}. +\item VIRTIO_NET_CTRL_NOTF_COAL_TX_SET: have the same effect as the VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command repeated for each virtqueue of transmitq1\ldots transmitqN.You mention later that
VIRTIO_NET_CTRL_NOTF_COAL_TX_SETsets the global parameters and repeatingVIRTIO_NET_CTRL_NOTF_COAL_VQ_SETfor each transmitq doesn't, so it's not exactly the same effect.
I think this is mainly talking about the process of setting coalescing parameters for virtqueues, and it doesn't seem to involve the process of " recording global values".
How about this:
"When setting the coalescing parameters, the VIRTIO_NET_CTRL_NOTF_COAL_TX_SET command has the same effect as the VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command repeated for each virtqueue of transmitq1\ldots transmitqN."
But this is a bit verbose. .
Thanks.
Quoted 71 lines
Same for
VIRTIO_NET_CTRL_NOTF_COAL_RX_SET.Quoted 69 lines
device-types/net/description.tex +44
-3+\item VIRTIO_NET_CTRL_NOTF_COAL_RX_SET: have the same effect as the VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command repeated for each virtqueue of receiveq1\ldots receiveqN. \end{enumerate} +If coalescing parameters are being set, the device applies the last coalescing parameters received for a +virtqueue, regardless of the command used to set the parameters. For example with 2 pairs of virtqueues: +# Command sequence +Each of the following commands sets \field{max_usecs} and \field{max_packets} parameters for virtqueues. +\begin{itemize} +\item Command1: VIRTIO_NET_CTRL_NOTF_COAL_RX_SET sets coalescing parameters for virtqueue0 and virtqueue2, and, virtqueue1 and virtqueue3 retain their previous parameter values. +\item Command2: VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET with \field{vqn} = 0 sets coalescing parameters for virtqueue0, and virtqueue2 retains the values from command1. +\item Command3: VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET with \field{vqn} = 0, the device responds with coalescing parameters of virtqueue0 set by command2. +\item Command4: VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET with \field{vqn} = 1 sets coalescing parameters for virtqueue1, and virtqueue3 retains its previous values. +\item Command5: VIRTIO_NET_CTRL_NOTF_COAL_TX_SET sets coalescing parameters for virtqueue1 and virtqueue3, and overrides the values set by command4. +\item Command6: VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET with \field{vqn} = 1, the device responds with coalescing parameters of virtqueue1 set by command5. +\end{itemize} + \subparagraph{Operation}\label{sec:Device Types / Network Device / Device Operation / Control Virtqueue / Notifications Coalescing / Operation} The device sends a used buffer notification once the notification conditions are met and if the notifications are not suppressed as explained in \ref{sec:Basic Facilities of a Virtio Device / Virtqueues / Used Buffer Notification Suppression}.@@ -1549,6 +1611,16 @@ \subsubsection{Control Virtqueue}\label{sec:Device Types / Network Device / Devi When the device has \field{max_usecs} = 0 or \field{max_packets} = 0, the notification conditions are met after every packet received/sent. +When a device receives a command of the VIRTIO_NET_CTRL_NOTF_COAL class to set a coalescing parameter, +it may set the parameter to a value close to a power of 2. For example: +If the device receives \field{max_usecs} = 7 from the VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command, it may set \field{max_usecs} = 8 for a given enabled virtqueue. + +When the device receives the VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and VIRTIO_NET_CTRL_NOTF_COAL_RX_SET commands, +it saves the values of coalescing parameters as global values, and the VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command +does not change the global values. If the device is reset, the global values will be set to 0. + +When a virtqueue is reset, its coalescing parameters are set to the global values. + \subparagraph{RX Example}\label{sec:Device Types / Network Device / Device Operation / Control Virtqueue / Notifications Coalescing / RX Example} If, for example:@@ -1585,11 +1657,29 @@ \subsubsection{Control Virtqueue}\label{sec:Device Types / Network Device / Devi \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. +If neither the VIRTIO_NET_F_NOTF_COAL nor the VIRTIO_NET_F_VQ_NOTF_COAL feature +has been negotiated, the driver MUST NOT issue VIRTIO_NET_CTRL_NOTF_COAL commands. + +A driver MUST ignore the values of coalescing parameters received from the VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET command if a device responds with VIRTIO_NET_ERR. \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 it was not able to change the parameters. +A device SHOULD respond to VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and VIRTIO_NET_CTRL_NOTF_COAL_RX_SET commands with VIRTIO_NET_ERR if it was not able to change the parameters. + +A device MUST respond to the VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command with VIRTIO_NET_ERR if it was not able to change the parameters. + +A device MUST respond to VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET and VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET commands with VIRTIO_NET_ERR if the given virtqueue is disabled. + +The VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and VIRTIO_NET_CTRL_NOTF_COAL_RX_SET commands set coalescing parameters for all transmit/receive +virtqueues respectively and values of coalescing parameters are recorded as global values by a device. +The device MUST set the global values of coalescing parameters to 0 after being reset. +The VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command sets the coalescing parameters for a given enabled virtqueue without changing the global values. + +After disabling and re-enabling a virtqueue, the device MUST revert coalescing parameters of the virtqueue to the global values. + +A device MAY set the coalescing parameter to a value close to a power of 2 value. + +A device MUST ignore \field{reserved}. A device SHOULD NOT send used buffer notifications to the driver if the notifications are suppressed, even if the notification conditions are met. --
Quoted 167 lines · Heng Qi
Hi, Alvaro.
Quoted 144 lines · Alvaro Karsz
Hi Heng,
Quoted 142 lines
Currently, coalescing parameters are grouped for all transmit and receive virtqueues. This patch supports setting or getting the parameters for a specified virtqueue, and a typical application of this function is netdim[1].
When the traffic between virtqueues is unbalanced, for example, one virtqueue is busy and another virtqueue is idle, then it will be very useful to control coalescing parameters at the virtqueue granularity.
[1] https://docs.kernel.org/networking/net_dim.html
Signed-off-by Heng Qi <[email protected]>Reviewed-by Xuan Zhuo <[email protected]>---
This patch is on top of Alvaro's latest v7 patch: https://lists.oasis-open.org/archives/virtio-dev/202302/msg00431.html .
v5->v6:
1. Explain that the device may set a different value than the one passed in by the driver. @David Edmondson
v4->v5:
1. Add the correspondence betweenvirtio_net_ctrl_coalandvirtio_net_ctrl_coal_vqand control commands. @Michael S. Tsirkin
2. Add read and write attributes for each field. @Michael S. Tsirkin
3. A clearer description of how to set coalescing parameters for vq reset. @Michael S. Tsirkin
4. Fix some syntax errors. @Michael S. Tsirkin, @David Edmondson
v3->v4:
1. Includevirtio_net_ctrl_coalin thevirtio_net_ctrl_coal_vqstructure. @Alvaro Karsz
2. Add consideration of vq reset. @Michael S. Tsirkin, @Parav Pandit, @Alvaro Karsz
3. Avoid too many examples by giving a comprehensive example. @Michael S. Tsirkin
4. Fix typos and streamline clarifications. @Michael S. Tsirkin, @Parav Pandit, @Alvaro Karsz
v2->v3:
1. Add the netdim link. @Parav Pandit
2.VIRTIO_NET_F_VQ_NOTF_COALno longer depends onVIRTIO_NET_F_NOTF_COAL. @Michael S. Tsirkin, @Alvaro Karsz
3._VQ_GETis explained more. @Michael S. Tsirkin
4. Add more examples to avoid misunderstandings. @Michael S. Tsirkin
5. Clarify some statements. @Michael S. Tsirkin, @Parav Pandit, @Alvaro Karsz
6. Adjust thevirtio_net_ctrl_coal_vqstructure. @Michael S. Tsirkin
7. Fix some typos. @Michael S. Tsirkin
v1->v2:
1. RenameVIRTIO_NET_F_PERQUEUE_NOTF_COALtoVIRTIO_NET_F_VQ_NOTF_COAL. @Michael S. Tsirkin
2. Use the \field{vqn} instead of the qid. @Michael S. Tsirkin
3. Unify tx and rx control structres into one structurevirtio_net_ctrl_coal_vq. @Michael S. Tsirkin
4. Add a new control commandVIRTIO_NET_CTRL_NOTF_COAL_VQ. @Michael S. Tsirkin, @Parav Pandit, @Alvaro Karsz
5. The special value0xFFFis removed becauseVIRTIO_NET_CTRL_NOTF_COALcan be used. @Alvaro Karsz
6. Clarify some special scenarios. @Michael S. Tsirkin, @Parav Pandit, @Alvaro Karszdevice-types/net/description.tex | 100 +++++++++++++++++++++++++++++-- 1 file changed, 95 insertions(+), 5 deletions(-)device-types/net/description.tex +46
-3@@ -83,6 +83,8 @@ \subsection{Feature bits}\label{sec:Device Types / Network Device / Feature bits \item[VIRTIO_NET_F_CTRL_MAC_ADDR(23)] Set MAC address through control channel. +\item[VIRTIO_NET_F_VQ_NOTF_COAL(52)] Device supports virtqueue notification coalescing. + \item[VIRTIO_NET_F_NOTF_COAL(53)] Device supports notifications coalescing. \item[VIRTIO_NET_F_GUEST_USO4 (54)] Driver can receive USOv4 packets.@@ -139,6 +141,7 @@ \subsubsection{Feature bit requirements}\label{sec:Device Types / Network Device \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. +\item[VIRTIO_NET_F_VQ_NOTF_COAL] Requires VIRTIO_NET_F_CTRL_VQ. \end{description} \subsubsection{Legacy Interface: Feature bits}\label{sec:Device Types / Network Device / Feature bits / Legacy Interface: Feature bits}@@ -1508,6 +1511,14 @@ \subsubsection{Control Virtqueue}\label{sec:Device Types / Network Device / Devi If the VIRTIO_NET_F_NOTF_COAL feature is negotiated, the driver can send control commands for dynamically changing the coalescing parameters. +If the VIRTIO_NET_F_VQ_NOTF_COAL feature is negotiated: +\begin{itemize} +\item a driver can send a VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command to set coalescing parameters of a given + enabled transmit/receive virtqueue. +\item a driver can send a VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET command to a device, and the device responds with + coalescing parameters of a given enabled transmit/receive virtqueue. +\end{itemize} + \begin{note} The behavior of the device in response to these commands is best-effort: the device may generate notifications more or less frequently than specified.@@ -1519,25 +1530,76 @@ \subsubsection{Control Virtqueue}\label{sec:Device Types / Network Device / Devi le32 max_usecs; }; +struct virtio_net_ctrl_coal_vq { + le16 vqn; + le16 reserved; + struct virtio_net_ctrl_coal coal; +}; + #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 + #define VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET 2 + #define VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET 3 \end{lstlisting} +The VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and VIRTIO_NET_CTRL_NOTF_COAL_RX_SET commands use the +virtio_net_ctrl_coal structure to set \field{max_usecs} and \field{max_packets} for all +transmit/receive virtqueues. + +The VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command uses the virtio_net_ctrl_coal_vq structure +to set \field{max_usecs} and \field{max_packets} for the supplied virtqueue number \field{vqn}. + +The VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET command gets the values of \field{max_usecs} and +\field{max_packets} of the specified virtqueue from the device by setting \field{vqn} +in the virtio_net_ctrl_coal_vq structure. + +# Read/Write attributes for coalescing parameters +\begin{itemize} +\item For commands VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and VIRTIO_NET_CTRL_NOTF_COAL_RX_SET, \field{max_usecs} + and \field{max_packets} are write-only for a driver. +\item For the command VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET, \field{vqn}, \field{reserved}, \field{max_usecs} + and \field{max_packets} are write-only for a driver. +\item For the command VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET, \field{vqn} and \field{reserved} are write-only + for a driver, and, \field{max_usecs} and \field{max_packets} are read-only for a driver. +\end{itemize} + Coalescing parameters: \begin{itemize} +\item \field{vqn}: The virtqueue number of an enabled transmit or receive virtqueue. \item \field{max_usecs} for RX: Maximum number of microseconds to delay a RX notification. \item \field{max_usecs} for TX: Maximum number of microseconds to delay a TX notification. \item \field{max_packets} for RX: Maximum number of packets to receive before a RX notification. \item \field{max_packets} for TX: Maximum number of packets to send before a TX notification. \end{itemize} -The class VIRTIO_NET_CTRL_NOTF_COAL has 2 commands: +\field{vqn} points to an enabled transmit/receive virtqueue, and its value satisfies $ 0 \leq vqn < max_virtqueue_pairs \ast 2 $. + +\field{reserved} is reserved and it is ignored by a device. + +The class VIRTIO_NET_CTRL_NOTF_COAL has 4 commands: \begin{enumerate} -\item VIRTIO_NET_CTRL_NOTF_COAL_TX_SET: set the \field{max_usecs} and \field{max_packets} parameters for all transmit virtqueues. -\item VIRTIO_NET_CTRL_NOTF_COAL_RX_SET: set the \field{max_usecs} and \field{max_packets} parameters for all receive virtqueues.Quoted 8 lines
device-types/net/description.tex \subsubsection{Control Virtqueue}\label{sec:Device Types / Network Device / Devi · line 1586
Quoted 5 lines
device-types/net/description.tex +5
-0+\item VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET: set the \field{max_usecs} and \field{max_packets} parameters for an enabled transmit/receive + virtqueue whose number is \field{vqn}. +\item VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET: the device returns the \field{max_usecs} and \field{max_packets} parameters for an enabled + transmit/receive virtqueue whose number is \field{vqn}. +\item VIRTIO_NET_CTRL_NOTF_COAL_TX_SET: have the same effect as the VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command repeated for each virtqueue of transmitq1\ldots transmitqN.You mention later that
VIRTIO_NET_CTRL_NOTF_COAL_TX_SETsets the global parameters and repeatingVIRTIO_NET_CTRL_NOTF_COAL_VQ_SETfor each transmitq doesn't, so it's not exactly the same effect.I think this is mainly talking about the process of setting coalescing parameters for virtqueues, and it doesn't seem to involve the process of " recording global values".
How about this:
"When setting the coalescing parameters, theVIRTIO_NET_CTRL_NOTF_COAL_TX_SETcommand has the same effect as theVIRTIO_NET_CTRL_NOTF_COAL_VQ_SETcommand repeated for each virtqueue of transmitq1\ldots transmitqN."
Quoted 3 lines
But this is a bit verbose. .
Thanks.
It's not really clear because "when" implies time not the desired effect. Just write out what it does, it is no longer the same IMHO.
Quoted 71 lines
Quoted 71 lines
Same for
VIRTIO_NET_CTRL_NOTF_COAL_RX_SET.Quoted 69 lines
device-types/net/description.tex +44
-3+\item VIRTIO_NET_CTRL_NOTF_COAL_RX_SET: have the same effect as the VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command repeated for each virtqueue of receiveq1\ldots receiveqN. \end{enumerate} +If coalescing parameters are being set, the device applies the last coalescing parameters received for a +virtqueue, regardless of the command used to set the parameters. For example with 2 pairs of virtqueues: +# Command sequence +Each of the following commands sets \field{max_usecs} and \field{max_packets} parameters for virtqueues. +\begin{itemize} +\item Command1: VIRTIO_NET_CTRL_NOTF_COAL_RX_SET sets coalescing parameters for virtqueue0 and virtqueue2, and, virtqueue1 and virtqueue3 retain their previous parameter values. +\item Command2: VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET with \field{vqn} = 0 sets coalescing parameters for virtqueue0, and virtqueue2 retains the values from command1. +\item Command3: VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET with \field{vqn} = 0, the device responds with coalescing parameters of virtqueue0 set by command2. +\item Command4: VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET with \field{vqn} = 1 sets coalescing parameters for virtqueue1, and virtqueue3 retains its previous values. +\item Command5: VIRTIO_NET_CTRL_NOTF_COAL_TX_SET sets coalescing parameters for virtqueue1 and virtqueue3, and overrides the values set by command4. +\item Command6: VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET with \field{vqn} = 1, the device responds with coalescing parameters of virtqueue1 set by command5. +\end{itemize} + \subparagraph{Operation}\label{sec:Device Types / Network Device / Device Operation / Control Virtqueue / Notifications Coalescing / Operation} The device sends a used buffer notification once the notification conditions are met and if the notifications are not suppressed as explained in \ref{sec:Basic Facilities of a Virtio Device / Virtqueues / Used Buffer Notification Suppression}.@@ -1549,6 +1611,16 @@ \subsubsection{Control Virtqueue}\label{sec:Device Types / Network Device / Devi When the device has \field{max_usecs} = 0 or \field{max_packets} = 0, the notification conditions are met after every packet received/sent. +When a device receives a command of the VIRTIO_NET_CTRL_NOTF_COAL class to set a coalescing parameter, +it may set the parameter to a value close to a power of 2. For example: +If the device receives \field{max_usecs} = 7 from the VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command, it may set \field{max_usecs} = 8 for a given enabled virtqueue. + +When the device receives the VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and VIRTIO_NET_CTRL_NOTF_COAL_RX_SET commands, +it saves the values of coalescing parameters as global values, and the VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command +does not change the global values. If the device is reset, the global values will be set to 0. + +When a virtqueue is reset, its coalescing parameters are set to the global values. + \subparagraph{RX Example}\label{sec:Device Types / Network Device / Device Operation / Control Virtqueue / Notifications Coalescing / RX Example} If, for example:@@ -1585,11 +1657,29 @@ \subsubsection{Control Virtqueue}\label{sec:Device Types / Network Device / Devi \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. +If neither the VIRTIO_NET_F_NOTF_COAL nor the VIRTIO_NET_F_VQ_NOTF_COAL feature +has been negotiated, the driver MUST NOT issue VIRTIO_NET_CTRL_NOTF_COAL commands. + +A driver MUST ignore the values of coalescing parameters received from the VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET command if a device responds with VIRTIO_NET_ERR. \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 it was not able to change the parameters. +A device SHOULD respond to VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and VIRTIO_NET_CTRL_NOTF_COAL_RX_SET commands with VIRTIO_NET_ERR if it was not able to change the parameters. + +A device MUST respond to the VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command with VIRTIO_NET_ERR if it was not able to change the parameters. + +A device MUST respond to VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET and VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET commands with VIRTIO_NET_ERR if the given virtqueue is disabled. + +The VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and VIRTIO_NET_CTRL_NOTF_COAL_RX_SET commands set coalescing parameters for all transmit/receive +virtqueues respectively and values of coalescing parameters are recorded as global values by a device. +The device MUST set the global values of coalescing parameters to 0 after being reset. +The VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command sets the coalescing parameters for a given enabled virtqueue without changing the global values. + +After disabling and re-enabling a virtqueue, the device MUST revert coalescing parameters of the virtqueue to the global values. + +A device MAY set the coalescing parameter to a value close to a power of 2 value. + +A device MUST ignore \field{reserved}. A device SHOULD NOT send used buffer notifications to the driver if the notifications are suppressed, even if the notification conditions are met. --
Quoted 166 lines · Michael S. Tsirkin
Quoted 165 lines · Heng Qi
Hi, Alvaro.
Quoted 144 lines · Alvaro Karsz
Hi Heng,
Quoted 142 lines
Currently, coalescing parameters are grouped for all transmit and receive virtqueues. This patch supports setting or getting the parameters for a specified virtqueue, and a typical application of this function is netdim[1].
When the traffic between virtqueues is unbalanced, for example, one virtqueue is busy and another virtqueue is idle, then it will be very useful to control coalescing parameters at the virtqueue granularity.
[1] https://docs.kernel.org/networking/net_dim.html
Signed-off-by Heng Qi <[email protected]>Reviewed-by Xuan Zhuo <[email protected]>---
This patch is on top of Alvaro's latest v7 patch: https://lists.oasis-open.org/archives/virtio-dev/202302/msg00431.html .
v5->v6:
1. Explain that the device may set a different value than the one passed in by the driver. @David Edmondson
v4->v5:
1. Add the correspondence betweenvirtio_net_ctrl_coalandvirtio_net_ctrl_coal_vqand control commands. @Michael S. Tsirkin
2. Add read and write attributes for each field. @Michael S. Tsirkin
3. A clearer description of how to set coalescing parameters for vq reset. @Michael S. Tsirkin
4. Fix some syntax errors. @Michael S. Tsirkin, @David Edmondson
v3->v4:
1. Includevirtio_net_ctrl_coalin thevirtio_net_ctrl_coal_vqstructure. @Alvaro Karsz
2. Add consideration of vq reset. @Michael S. Tsirkin, @Parav Pandit, @Alvaro Karsz
3. Avoid too many examples by giving a comprehensive example. @Michael S. Tsirkin
4. Fix typos and streamline clarifications. @Michael S. Tsirkin, @Parav Pandit, @Alvaro Karsz
v2->v3:
1. Add the netdim link. @Parav Pandit
2.VIRTIO_NET_F_VQ_NOTF_COALno longer depends onVIRTIO_NET_F_NOTF_COAL. @Michael S. Tsirkin, @Alvaro Karsz
3._VQ_GETis explained more. @Michael S. Tsirkin
4. Add more examples to avoid misunderstandings. @Michael S. Tsirkin
5. Clarify some statements. @Michael S. Tsirkin, @Parav Pandit, @Alvaro Karsz
6. Adjust thevirtio_net_ctrl_coal_vqstructure. @Michael S. Tsirkin
7. Fix some typos. @Michael S. Tsirkin
v1->v2:
1. RenameVIRTIO_NET_F_PERQUEUE_NOTF_COALtoVIRTIO_NET_F_VQ_NOTF_COAL. @Michael S. Tsirkin
2. Use the \field{vqn} instead of the qid. @Michael S. Tsirkin
3. Unify tx and rx control structres into one structurevirtio_net_ctrl_coal_vq. @Michael S. Tsirkin
4. Add a new control commandVIRTIO_NET_CTRL_NOTF_COAL_VQ. @Michael S. Tsirkin, @Parav Pandit, @Alvaro Karsz
5. The special value0xFFFis removed becauseVIRTIO_NET_CTRL_NOTF_COALcan be used. @Alvaro Karsz
6. Clarify some special scenarios. @Michael S. Tsirkin, @Parav Pandit, @Alvaro Karszdevice-types/net/description.tex | 100 +++++++++++++++++++++++++++++-- 1 file changed, 95 insertions(+), 5 deletions(-)device-types/net/description.tex +46
-3@@ -83,6 +83,8 @@ \subsection{Feature bits}\label{sec:Device Types / Network Device / Feature bits \item[VIRTIO_NET_F_CTRL_MAC_ADDR(23)] Set MAC address through control channel. +\item[VIRTIO_NET_F_VQ_NOTF_COAL(52)] Device supports virtqueue notification coalescing. + \item[VIRTIO_NET_F_NOTF_COAL(53)] Device supports notifications coalescing. \item[VIRTIO_NET_F_GUEST_USO4 (54)] Driver can receive USOv4 packets.@@ -139,6 +141,7 @@ \subsubsection{Feature bit requirements}\label{sec:Device Types / Network Device \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. +\item[VIRTIO_NET_F_VQ_NOTF_COAL] Requires VIRTIO_NET_F_CTRL_VQ. \end{description} \subsubsection{Legacy Interface: Feature bits}\label{sec:Device Types / Network Device / Feature bits / Legacy Interface: Feature bits}@@ -1508,6 +1511,14 @@ \subsubsection{Control Virtqueue}\label{sec:Device Types / Network Device / Devi If the VIRTIO_NET_F_NOTF_COAL feature is negotiated, the driver can send control commands for dynamically changing the coalescing parameters. +If the VIRTIO_NET_F_VQ_NOTF_COAL feature is negotiated: +\begin{itemize} +\item a driver can send a VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command to set coalescing parameters of a given + enabled transmit/receive virtqueue. +\item a driver can send a VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET command to a device, and the device responds with + coalescing parameters of a given enabled transmit/receive virtqueue. +\end{itemize} + \begin{note} The behavior of the device in response to these commands is best-effort: the device may generate notifications more or less frequently than specified.@@ -1519,25 +1530,76 @@ \subsubsection{Control Virtqueue}\label{sec:Device Types / Network Device / Devi le32 max_usecs; }; +struct virtio_net_ctrl_coal_vq { + le16 vqn; + le16 reserved; + struct virtio_net_ctrl_coal coal; +}; + #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 + #define VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET 2 + #define VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET 3 \end{lstlisting} +The VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and VIRTIO_NET_CTRL_NOTF_COAL_RX_SET commands use the +virtio_net_ctrl_coal structure to set \field{max_usecs} and \field{max_packets} for all +transmit/receive virtqueues. + +The VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command uses the virtio_net_ctrl_coal_vq structure +to set \field{max_usecs} and \field{max_packets} for the supplied virtqueue number \field{vqn}. + +The VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET command gets the values of \field{max_usecs} and +\field{max_packets} of the specified virtqueue from the device by setting \field{vqn} +in the virtio_net_ctrl_coal_vq structure. + +# Read/Write attributes for coalescing parameters +\begin{itemize} +\item For commands VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and VIRTIO_NET_CTRL_NOTF_COAL_RX_SET, \field{max_usecs} + and \field{max_packets} are write-only for a driver. +\item For the command VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET, \field{vqn}, \field{reserved}, \field{max_usecs} + and \field{max_packets} are write-only for a driver. +\item For the command VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET, \field{vqn} and \field{reserved} are write-only + for a driver, and, \field{max_usecs} and \field{max_packets} are read-only for a driver. +\end{itemize} + Coalescing parameters: \begin{itemize} +\item \field{vqn}: The virtqueue number of an enabled transmit or receive virtqueue. \item \field{max_usecs} for RX: Maximum number of microseconds to delay a RX notification. \item \field{max_usecs} for TX: Maximum number of microseconds to delay a TX notification. \item \field{max_packets} for RX: Maximum number of packets to receive before a RX notification. \item \field{max_packets} for TX: Maximum number of packets to send before a TX notification. \end{itemize} -The class VIRTIO_NET_CTRL_NOTF_COAL has 2 commands: +\field{vqn} points to an enabled transmit/receive virtqueue, and its value satisfies $ 0 \leq vqn < max_virtqueue_pairs \ast 2 $. + +\field{reserved} is reserved and it is ignored by a device. + +The class VIRTIO_NET_CTRL_NOTF_COAL has 4 commands: \begin{enumerate} -\item VIRTIO_NET_CTRL_NOTF_COAL_TX_SET: set the \field{max_usecs} and \field{max_packets} parameters for all transmit virtqueues. -\item VIRTIO_NET_CTRL_NOTF_COAL_RX_SET: set the \field{max_usecs} and \field{max_packets} parameters for all receive virtqueues.Quoted 8 lines
device-types/net/description.tex \subsubsection{Control Virtqueue}\label{sec:Device Types / Network Device / Devi · line 1586
Quoted 5 lines
device-types/net/description.tex +5
-0+\item VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET: set the \field{max_usecs} and \field{max_packets} parameters for an enabled transmit/receive + virtqueue whose number is \field{vqn}. +\item VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET: the device returns the \field{max_usecs} and \field{max_packets} parameters for an enabled + transmit/receive virtqueue whose number is \field{vqn}. +\item VIRTIO_NET_CTRL_NOTF_COAL_TX_SET: have the same effect as the VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command repeated for each virtqueue of transmitq1\ldots transmitqN.You mention later that
VIRTIO_NET_CTRL_NOTF_COAL_TX_SETsets the global parameters and repeatingVIRTIO_NET_CTRL_NOTF_COAL_VQ_SETfor each transmitq doesn't, so it's not exactly the same effect.I think this is mainly talking about the process of setting coalescing parameters for virtqueues, and it doesn't seem to involve the process of " recording global values".
How about this:
"When setting the coalescing parameters, theVIRTIO_NET_CTRL_NOTF_COAL_TX_SETcommand has the same effect as theVIRTIO_NET_CTRL_NOTF_COAL_VQ_SETcommand repeated for each virtqueue of transmitq1\ldots transmitqN."
Quoted 6 lines
Quoted 3 lines
But this is a bit verbose. .
Thanks.
It's not really clear because "when" implies time not the desired effect. Just write out what it does, it is no longer the same IMHO.
I see. Thanks.
Quoted 72 lines
Quoted 72 lines
Quoted 72 lines
Same for
VIRTIO_NET_CTRL_NOTF_COAL_RX_SET.Quoted 69 lines
device-types/net/description.tex +44
-3+\item VIRTIO_NET_CTRL_NOTF_COAL_RX_SET: have the same effect as the VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command repeated for each virtqueue of receiveq1\ldots receiveqN. \end{enumerate} +If coalescing parameters are being set, the device applies the last coalescing parameters received for a +virtqueue, regardless of the command used to set the parameters. For example with 2 pairs of virtqueues: +# Command sequence +Each of the following commands sets \field{max_usecs} and \field{max_packets} parameters for virtqueues. +\begin{itemize} +\item Command1: VIRTIO_NET_CTRL_NOTF_COAL_RX_SET sets coalescing parameters for virtqueue0 and virtqueue2, and, virtqueue1 and virtqueue3 retain their previous parameter values. +\item Command2: VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET with \field{vqn} = 0 sets coalescing parameters for virtqueue0, and virtqueue2 retains the values from command1. +\item Command3: VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET with \field{vqn} = 0, the device responds with coalescing parameters of virtqueue0 set by command2. +\item Command4: VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET with \field{vqn} = 1 sets coalescing parameters for virtqueue1, and virtqueue3 retains its previous values. +\item Command5: VIRTIO_NET_CTRL_NOTF_COAL_TX_SET sets coalescing parameters for virtqueue1 and virtqueue3, and overrides the values set by command4. +\item Command6: VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET with \field{vqn} = 1, the device responds with coalescing parameters of virtqueue1 set by command5. +\end{itemize} + \subparagraph{Operation}\label{sec:Device Types / Network Device / Device Operation / Control Virtqueue / Notifications Coalescing / Operation} The device sends a used buffer notification once the notification conditions are met and if the notifications are not suppressed as explained in \ref{sec:Basic Facilities of a Virtio Device / Virtqueues / Used Buffer Notification Suppression}.@@ -1549,6 +1611,16 @@ \subsubsection{Control Virtqueue}\label{sec:Device Types / Network Device / Devi When the device has \field{max_usecs} = 0 or \field{max_packets} = 0, the notification conditions are met after every packet received/sent. +When a device receives a command of the VIRTIO_NET_CTRL_NOTF_COAL class to set a coalescing parameter, +it may set the parameter to a value close to a power of 2. For example: +If the device receives \field{max_usecs} = 7 from the VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command, it may set \field{max_usecs} = 8 for a given enabled virtqueue. + +When the device receives the VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and VIRTIO_NET_CTRL_NOTF_COAL_RX_SET commands, +it saves the values of coalescing parameters as global values, and the VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command +does not change the global values. If the device is reset, the global values will be set to 0. + +When a virtqueue is reset, its coalescing parameters are set to the global values. + \subparagraph{RX Example}\label{sec:Device Types / Network Device / Device Operation / Control Virtqueue / Notifications Coalescing / RX Example} If, for example:@@ -1585,11 +1657,29 @@ \subsubsection{Control Virtqueue}\label{sec:Device Types / Network Device / Devi \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. +If neither the VIRTIO_NET_F_NOTF_COAL nor the VIRTIO_NET_F_VQ_NOTF_COAL feature +has been negotiated, the driver MUST NOT issue VIRTIO_NET_CTRL_NOTF_COAL commands. + +A driver MUST ignore the values of coalescing parameters received from the VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET command if a device responds with VIRTIO_NET_ERR. \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 it was not able to change the parameters. +A device SHOULD respond to VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and VIRTIO_NET_CTRL_NOTF_COAL_RX_SET commands with VIRTIO_NET_ERR if it was not able to change the parameters. + +A device MUST respond to the VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command with VIRTIO_NET_ERR if it was not able to change the parameters. + +A device MUST respond to VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET and VIRTIO_NET_CTRL_NOTF_COAL_VQ_GET commands with VIRTIO_NET_ERR if the given virtqueue is disabled. + +The VIRTIO_NET_CTRL_NOTF_COAL_TX_SET and VIRTIO_NET_CTRL_NOTF_COAL_RX_SET commands set coalescing parameters for all transmit/receive +virtqueues respectively and values of coalescing parameters are recorded as global values by a device. +The device MUST set the global values of coalescing parameters to 0 after being reset. +The VIRTIO_NET_CTRL_NOTF_COAL_VQ_SET command sets the coalescing parameters for a given enabled virtqueue without changing the global values. + +After disabling and re-enabling a virtqueue, the device MUST revert coalescing parameters of the virtqueue to the global values. + +A device MAY set the coalescing parameter to a value close to a power of 2 value. + +A device MUST ignore \field{reserved}. A device SHOULD NOT send used buffer notifications to the driver if the notifications are suppressed, even if the notification conditions are met. --