[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]
Subject: Re: [virtio-comment] [PATCH v1 7/7] virtio-net: Add flow filter device and driver requirements
å 2023/10/7 äå1:14, Parav Pandit åé:
The flow filter functionality consists of the following four components. Add driver and device requirements for it. 1. Device capabilities query for commands VIRTIO_NET_CTRL_FF_CAP_GET, VIRTIO_NET_CTRL_FF_MATCH_CAP_GET. 2. Flow filter group operation commands VIRTIO_NET_CTRL_FF_GROUP_ADD and VIRTIO_NET_CTRL_FF_GROUP_DEL. 3. Flow filter transport mode set command VIRTIO_NET_CTRL_FF_TRANSPORT_MODE_SET. 4. Flow filter requests using command VIRTIO_NET_CTRL_FF_REQ and the structure virtio_net_ff_op for the flow filter virtqueue. Fixes: https://github.com/oasis-tcs/virtio-spec/issues/179 Signed-off-by: Parav Pandit <parav@nvidia.com> Signed-off-by: Heng Qi <hengqi@linux.alibaba.com> --- changelog: v0->v1: - addressed comments from Satananda - added device requirement to return non zero value in fields_bmap - added device requirement to not repeat filter type in response - added driver requirement to order filter match field as it appears in the packet - added device requirement to fail group delete command on existing flow entries --- device-types/net/description.tex | 126 +++++++++++++++++++++++++++++++ 1 file changed, 126 insertions(+) diff --git a/device-types/net/description.tex b/device-types/net/description.tex index cf2836d..1a3ce63 100644 --- a/device-types/net/description.tex +++ b/device-types/net/description.tex @@ -2364,6 +2364,132 @@ \subsubsection{Control Virtqueue}\label{sec:Device Types / Network Device / Devi \field{command-specific-result} is in format of \field{struct virtio_net_ff_req_result}.+\devicenormative{\subparagraph}{Flow Filter}{Device Types / Network Device / Device Operation / Control Virtqueue / Flow Filter}+ +When the VIRTIO_NET_F_FLOW_FILTER is negotiated, the device MUST support +VIRTIO_NET_CTRL_FF_CAP_GET, VIRTIO_NET_CTRL_FF_MATCH_CAP_GET, VIRTIO_NET_CTRL_FF_GROUP_ADD, +VIRTIO_NET_CTRL_FF_GROUP_DEL, VIRTIO_NET_CTRL_FF_TRANSPORT_MODE_SET and +VIRTIO_NET_CTRL_FF_REQ commands. + +When the VIRTIO_NET_F_FLOW_FILTER is not negotiated, the device MUST respond +with error VIRTIO_NET_ERR for +VIRTIO_NET_CTRL_FF_CAP_GET, VIRTIO_NET_CTRL_FF_MATCH_CAP_GET, VIRTIO_NET_CTRL_FF_GROUP_ADD, +VIRTIO_NET_CTRL_FF_GROUP_DEL, VIRTIO_NET_CTRL_FF_TRANSPORT_MODE_SET and +VIRTIO_NET_CTRL_FF_REQ commands. + +When the command VIRTIO_NET_CTRL_FF_CAP_GET completes successfully, the device +MUST set either \field{max_vqs} to be non zero or set +\field{cvq_supports_ff_ops} to 1; the device MUST set non zero value for fields +\field{max_groups}, \field{max_ff_per_group}, \field{max_ff}, +\field{max_match_fields} and \field{max_flow_priorities_per_group}. + +When the command VIRTIO_NET_CTRL_FF_MATCH_CAP_GET completes successfully, +\begin{itemize} +\item the device MUST set non zero value for fields \field{num_entries}, \field{fields_bmap} +and set corresponding number of valid entries. +\item the device MUST NOT repeat \field{type} in the \field{types}. +\end{itemize} + +The device MUST set VIRTIO_NET_ERROR for the command +VIRTIO_NET_CTRL_FF_GROUP_ADD if there are existing flow filters for the +supplied group \field{id} or for the supplied \field{priority}. + +The device MUST set VIRTIO_NET_ERROR for the command +VIRTIO_NET_CTRL_FF_GROUP_DEL if the group identified with \field{id} +does not exist in the device. + +The device MUST set VIRTIO_NET_ERROR for the command +VIRTIO_NET_CTRL_FF_GROUP_DEL if the group identified with \field{id} +has one or more flow filters present in the group. + +If there are active flow filters already added in the device, the device +MUST respond VIRTIO_NET_ERROR for the command +VIRTIO_NET_CTRL_FF_TRANSPORT_MODE_SET. + +The device MUST respond VIRTIO_NET_ERROR for the command +VIRTIO_NET_CTRL_FF_TRANSPORT_MODE_SET when \field{mode} is set to +VIRTIO_NET_FF_TRANSPORT_CVQ and \field{cvq_supports_ff_ops} is set to zero; +or when \field{mode} is set to VIRTIO_NET_FF_TRANSPORT_FFVQ and +\field{max_vqs} is zero. + +The device MUST fail the operation VIRTIO_NET_FF_OP_ADD if the +\field{match} contains duplicate \field{type}. + +The device MUST fail the operation VIRTIO_NET_FF_OP_DEL if the +requested flow filter of identifier \field{id} do not exist in the +the device. + +The device MUST fail the operation VIRTIO_NET_FF_OP_ADD if the +\field{vq_index} in the \field{dest} is outside of the range. + +When the flow filter forwards the packet to the \field{vq_index} and +if the receiveq is reset, the device MUST drop such packets. + +When the flow filter \field{action} is VIRTIO_NET_FF_ACTION_DROP, +the device MUST ignore fields of \field{struct virtio_net_ff_dest}. + +When the driver has added multiple flow filters with same \field{priority} +and for a packet if multiple flow filters MAY match such that it MAY result +in different \field{action} or different \field{dest}, the device +MAY apply any of the matching flow filters. + +The device MUST follow received packet processing ordering chain as following: + +The device SHOULD set \field{device_status} to DEVICE_NEEDS_RESET when +the driver has not set the flow filter transport mode to +VIRTIO_NET_FF_TRANSPORT_FFVQ and if the driver enables the flow filter +virtqueue. + +\begin{itemize} +\item Device configuration done using control virtqueue commands VIRTIO_NET_CTRL_RX, + VIRTIO_NET_CTRL_MAC and VIRTIO_NET_CTRL_VLAN. +\item Flow filters programmed using flow filters functionality. +\item Device configuration done using VIRTIO_NET_CTRL_MQ_RSS_CONFIG command. +\end{itemize} + +When the device drops the packet due to the configuration done using the control +virtqueue commands VIRTIO_NET_CTRL_RX or VIRTIO_NET_CTRL_MAC or VIRTIO_NET_CTRL_VLAN, +the device MUST stop processing this packet for flow filters processing. + +When the device matches the flow filter for the packet and if the match is successful, +the filter processing chain MUST stop, i.e. next level of processing MUST not be done. + +When the device matches the flow filter for the packet and if no match entry is found +for the packet, the receive packet processing continues to next level, i.e. to apply +configuration done using VIRTIO_NET_CTRL_MQ_RSS_CONFIG command. + +The device MUST support enabling \field{max_vqs} number of flow filters +virtqueues after device initializaton phase if VIRTIO_F_RING_DYNAMIC
s/initializaton/initialization Thanks!
+feature is negotiated.
+
+When \field{max_vqs} is non zero, the device MUST report \field{start_vq_index},
+such that it does not overlap with any other virtqueues indices.
+
+\drivernormative{\subparagraph}{Flow Filters}{Device Types / Network Device / Device Operation / Control Virtqueue / Flow Filters}
+
+The driver MUST NOT change the flow filters transport mode using
+VIRTIO_NET_CTRL_FF_TRANSPORT_MODE_SET when the device has flow filters
+added.
+
+The driver MUST NOT set transport mode of VIRTIO_NET_FF_TRANSPORT_CVQ
+if \field{cvq_supports_ff_ops} is set to zero.
+
+The driver MUST NOT set transport mode of VIRTIO_NET_FF_TRANSPORT_FFVQ
+if \field{max_vqs} is set to zero in the command response of
+VIRTIO_NET_CTRL_FF_CAP_GET.
+
+The driver MUST NOT send any flow filters specific commands having class code
+of VIRTIO_NET_CTRL_FF when VIRTIO_NET_F_FLOW_FILTER is not negotiated.
+
+The driver SHOULD NOT add multiple flow filters with same \field{priority}
+in a flow filter group, with overlapping match values.
+
+The driver SHOULD use different priority for different flow filters
+if multiple of the flow filters MAY match for a packet.
+
+The driver SHOULD set the \field{type} in \field{match_entries} as that of
+the order appears in the packet.
+
\subsubsection{Legacy Interface: Framing Requirements}\label{sec:Device
Types / Network Device / Legacy Interface: Framing Requirements}
[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]