virtio-net: Improve introductory description
PATCH v4 1/1 virtio-net: Improve introductory description
The control VQ of the virtio network device is used beyond advance steering control. The control VQ dynamically changes multiple features of the initialized device.
Hence, update this area of control VQ introductory description at few places and also place the link to its description.
Also update the introduction section to better describe receive and transmit virtqueues.
---
This patch is on top of [1].
[1] https://lists.oasis-open.org/archives/virtio-dev/202301/msg00280.html
---
changelog:v3->v4:
- write buffer add/remove, instead of enqueue/dequeue, post v2->v3:
- further improve introductionv1->v2:
- corrected/added article before transmit and receive virtqueue
- replaced listed with described
- updated set to negotiated for CTRL_VQ
- improved introduction wordingsv0->v1:
- replaced command queue to control virtqueue to reflect current state
- added link of control vq to its detailed section
- removed reference of cvq from more places that limits it to steering
- Addressed Cornelia's review comments:
- updated introduction section to better describe rq, sq, cvq.
- explicitly wrote that cvq is optional along with its feature bit related description
- dropped few items from Cornelia's review as they do not exactly fit with latest 1.2 specification as below.
- avoided listing number of queues in introduction as its linked to q reset which can disable all queues
- avoid mentioning cvq as optional as there is better section for it
- avoid talking about queue pairs as spec and use cases allows not operate in pairs mode
--- device-types/net/description.tex | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-)
device-types/net/description.tex +13 -10
@@ -2,13 +2,15 @@ \section{Network Device}\label{sec:Device Types / Network Device} The virtio network device is a virtual network interface controller. It consists of a virtual Ethernet link which connects the device -to the Ethernet network. It is the most complex of the devices -supported so far by virtio. It has enhanced rapidly and demonstrates -clearly how support for new features are added to an existing -device. Empty buffers are placed in one virtqueue for receiving -packets, and outgoing packets are enqueued into another for -transmission in that order. A third command queue is used to -control advanced filtering features. +to the Ethernet network. The device has transmit and receive +queues. The driver adds empty buffers to the receive virtqueue. +The device receives incoming packets from the link; the device +places these incoming packets in the receive virtqueue buffers. +The driver adds outgoing packets to the transmit virtqueue. The device +removes these packets from the transmit virtqueue and sends them to +the link. The device may have a control virtuqueue. The driver +uses the control virtqueue to dynamically manipulate various +features of the initialized device. \subsection{Device ID}\label{sec:Device Types / Network Device / Device ID}
@@ -28,7 +30,8 @@ \subsection{Virtqueues}\label{sec:Device Types / Network Device / Virtqueues} N=1 if neither VIRTIO_NET_F_MQ nor VIRTIO_NET_F_RSS are negotiated, otherwise N is set by \field{max_virtqueue_pairs}. - controlq only exists if VIRTIO_NET_F_CTRL_VQ set. +controlq is optional; it only exists if VIRTIO_NET_F_CTRL_VQ is +negotiated. \subsection{Feature bits}\label{sec:Device Types / Network Device / Feature bits}
@@ -389,8 +392,8 @@ \subsection{Device Operation}\label{sec:Device Types / Network Device / Device O }; \end{lstlisting} -The controlq is used to control device features such as -filtering. +The controlq is used to control many device features described further in +section \ref{sec:Device Types / Network Device / Device Operation / Control Virtqueue}. \subsubsection{Legacy Interface: Device Operation}\label{sec:Device Types / Network Device / Device Operation / Legacy Interface: Device Operation} When using the legacy interface, transitional devices and drivers
Signature · 1 line
2.26.2
Quoted 4 lines · Parav Pandit
The control VQ of the virtio network device is used beyond advance steering control. The control VQ dynamically changes multiple features of the initialized device.
Quoted 8 lines
Hence, update this area of control VQ introductory description at few places and also place the link to its description.
Also update the introduction section to better describe receive and transmit virtqueues.
One typo below, otherwise:
Quoted 46 lines
---
This patch is on top of [1].[1] https://lists.oasis-open.org/archives/virtio-dev/202301/msg00280.html
---
changelog:v3->v4:
- write buffer add/remove, instead of enqueue/dequeue, postv2->v3:
- further improve introductionv1->v2:
- corrected/added article before transmit and receive virtqueue
- replaced listed with described
- updated set to negotiated forCTRL_VQ
- improved introduction wordingsv0->v1:
- replaced command queue to control virtqueue to reflect current state
- added link of control vq to its detailed section
- removed reference of cvq from more places that limits it to steering
- Addressed Cornelia's review comments:
- updated introduction section to better describe rq, sq, cvq.
- explicitly wrote that cvq is optional along with its feature bit related description
- dropped few items from Cornelia's review as they do not exactly fit with latest 1.2 specification as below.
- avoided listing number of queues in introduction as its linked to q reset which can disable all queues
- avoid mentioning cvq as optional as there is better section for it
- avoid talking about queue pairs as spec and use cases allows not operate in pairs mode--- device-types/net/description.tex | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-)device-types/net/description.tex +0
-4@@ -2,13 +2,15 @@ \section{Network Device}\label{sec:Device Types / Network Device} The virtio network device is a virtual network interface controller. It consists of a virtual Ethernet link which connects the device -to the Ethernet network. It is the most complex of the devices -supported so far by virtio. It has enhanced rapidly and demonstrates -clearly how support for new features are added to an existing -device. Empty buffers are placed in one virtqueue for receiving
device-types/net/description.tex \section{Network Device}\label{sec:Device Types / Network Device} · line 11
Quoted 10 lines
device-types/net/description.tex +7
-3-packets, and outgoing packets are enqueued into another for -transmission in that order. A third command queue is used to -control advanced filtering features. +to the Ethernet network. The device has transmit and receive +queues. The driver adds empty buffers to the receive virtqueue. +The device receives incoming packets from the link; the device +places these incoming packets in the receive virtqueue buffers. +The driver adds outgoing packets to the transmit virtqueue. The device +removes these packets from the transmit virtqueue and sends them to +the link. The device may have a control virtuqueue. The driver
"virtuqueue" typo, previously mentioned by Cornelia.
Quoted 26 lines
device-types/net/description.tex +6
-3+uses the control virtqueue to dynamically manipulate various +features of the initialized device. \subsection{Device ID}\label{sec:Device Types / Network Device / Device ID}@@ -28,7 +30,8 @@ \subsection{Virtqueues}\label{sec:Device Types / Network Device / Virtqueues} N=1 if neither VIRTIO_NET_F_MQ nor VIRTIO_NET_F_RSS are negotiated, otherwise N is set by \field{max_virtqueue_pairs}. - controlq only exists if VIRTIO_NET_F_CTRL_VQ set. +controlq is optional; it only exists if VIRTIO_NET_F_CTRL_VQ is +negotiated. \subsection{Feature bits}\label{sec:Device Types / Network Device / Feature bits}@@ -389,8 +392,8 @@ \subsection{Device Operation}\label{sec:Device Types / Network Device / Device O }; \end{lstlisting} -The controlq is used to control device features such as -filtering. +The controlq is used to control many device features described further in +section \ref{sec:Device Types / Network Device / Device Operation / Control Virtqueue}. \subsubsection{Legacy Interface: Device Operation}\label{sec:Device Types / Network Device / Device Operation / Legacy Interface: Device Operation} When using the legacy interface, transitional devices and drivers
Signature · 21 lines
I've always been mad, I know I've been mad, like the most of us are. -- She looks like Eve Marie Saint in "On the Waterfront". -- And now I know what every step is for. This publicly archived list offers a means to provide input to the OASIS Virtual I/O Device (VIRTIO) TC. In order to verify user consent to the Feedback License terms and to minimize spam in the list archive, subscription is required before posting. Subscribe: [email protected] Unsubscribe: [email protected] List help: [email protected] List archive: https://lists.oasis-open.org/archives/virtio-comment/ Feedback License: https://www.oasis-open.org/who/ipr/feedback_license.pdf List Guidelines: https://www.oasis-open.org/policies-guidelines/mailing-lists Committee: https://www.oasis-open.org/committees/virtio/ Join OASIS: https://www.oasis-open.org/join/
Quoted 3 lines
From: David Edmondson <[email protected]>
Sent: Monday, February 13, 2023 5:03 AM
[..]
Quoted 5 lines
Quoted 2 lines
One typo below, otherwise:
Oops. Missed before.
Fixed now in v5 at [1].
Cornelia,
I fixed the typo.
Can you please review [1] and merge if its good?
It is only editorial, it doesn't need github issue. Let me know if I should open one.
Quoted 1 line
Reviewed-by David Edmondson <[email protected]>
[1] https://lists.oasis-open.org/archives/virtio-dev/202302/msg00303.html
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/