Skip to contentSkip to conversation

virtio-net: Improve control vq introductory description

PATCH In review Parav Pandit 2 participants 3 messages Jan 23, 2023

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 virtio-net: Improve control vq introductory description

The control VQ of the virtio network device is used for controlling multiple features, not just advanced steering control. The control VQ dynamically changes multiple features of the initialized device.

Hence, update this area of control VQ introductory description.

This patch is on top of [1].

[1] https://lists.oasis-open.org/archives/virtio-dev/202301/msg00272.html

---
 device-types/net/description.tex | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
device-types/net/description.tex +1 -1
index 41ae7f5..56bd672 100644
@@ -8,7 +8,7 @@ \section{Network Device}\label{sec:Device Types / Network Device}
 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.
+dynamically manipulate various features of the initialized device.
 
 \subsection{Device ID}\label{sec:Device Types / Network Device / Device ID}
 
Signature · 1 line
2.26.2
#1 lore raw
Quoted 9 lines · Parav Pandit

The control VQ of the virtio network device is used for controlling multiple features, not just advanced steering control. The control VQ dynamically changes multiple features of the initialized device.

Hence, update this area of control VQ introductory description.

This patch is on top of [1].

[1] https://lists.oasis-open.org/archives/virtio-dev/202301/msg00272.html

[Side note: better put notes like that beneath the "---" delimiter, so that they don't end up in the changelog, where they won't be of much interest anymore.]

Quoted 12 lines
---
 device-types/net/description.tex | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
device-types/net/description.tex +0 -0
index 41ae7f5..56bd672 100644

device-types/net/description.tex \section{Network Device}\label{sec:Device Types / Network Device} · line 11

Quoted 5 lines
device-types/net/description.tex +1 -1
@@ -8,7 +8,7 @@ \section{Network Device}\label{sec:Device Types / Network Device}
 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.
+dynamically manipulate various features of the initialized device.

I think that whole paragraph needs some editing; apart from your card/device terminology change, it hasn't seem updates in ages.

- the "most complex device supported so far" half sentence, while not untrue, doesn't really add much to the understanding of what the net device does
- same for the "It has enhanced rapidly..." statement
- more importantly, it still talks about single receive/transmit queues, while multiqueue has been specified for ages; this also makes the "A third command queue" statement a bit confusing

What about generalizing this change to a "virtio-net: Improve introductory description" update to something like the following, copying the purpose of the control queue from the description further below:

"The virtio network device is a virtual ethernet device with a complex and configurable set of features. One or more pairs of virtqueues are used for receiving and transmitting packets: Empty buffers are placed in the first virtqueue of the pair for receiving packets, and outgoing packets are enqueued into the other for transmission. An optional command queue is used to dynamically manipulate various features of the initialized device which would not easily map into the configuration space."

This publicly archived list offers a means to provide input to the OASIS Virtual I/O Device (VIRTIO) TC.

In order to verify user consent to the Feedback License terms and to minimize spam in the list archive, subscription is required before posting.

Subscribe: [email protected]
Unsubscribe: [email protected]
List help: [email protected]
List archive: https://lists.oasis-open.org/archives/virtio-comment/
Feedback License: https://www.oasis-open.org/who/ipr/feedback_license.pdf
List Guidelines: https://www.oasis-open.org/policies-guidelines/mailing-lists
Committee: https://www.oasis-open.org/committees/virtio/
Join OASIS: https://www.oasis-open.org/join/

#2 lore raw
Quoted 13 lines

From: Cornelia Huck <[email protected]>
Sent: Monday, January 23, 2023 6:49 AM

Quoted 6 lines · Parav Pandit

The control VQ of the virtio network device is used for controlling multiple features, not just advanced steering control. The control VQ dynamically changes multiple features of the initialized device.

Hence, update this area of control VQ introductory description.

Quoted 8 lines
Quoted 4 lines

This patch is on top of [1].

[1]
https://lists.oasis-open.org/archives/virtio-dev/202301/msg00272.html

[Side note: better put notes like that beneath the "---" delimiter, so that they don't end up in the changelog, where they won't be of much interest anymore.]

Yes. will do in v1.

[..]

Quoted 16 lines

I think that whole paragraph needs some editing; apart from your card/device terminology change, it hasn't seem updates in ages.

- the "most complex device supported so far" half sentence, while not untrue, doesn't really add much to the understanding of what the net device does
- same for the "It has enhanced rapidly..." statement
- more importantly, it still talks about single receive/transmit queues, while multiqueue has been specified for ages; this also makes the "A third command queue" statement a bit confusing

What about generalizing this change to a "virtio-net: Improve introductory description" update to something like the following, copying the purpose of the control queue from the description further
below:

Quoted 7 lines

"The virtio network device is a virtual ethernet device with a complex and configurable set of features. One or more pairs of virtqueues are used for receiving and transmitting packets: Empty buffers are placed in the first virtqueue of the pair for receiving packets, and outgoing packets are enqueued into the other for transmission. An optional command queue is used to dynamically manipulate various features of the initialized device which would not easily map into the configuration space."

Yes, even better.
Will send v1 with proposed changes and on top of previous patch.