[dpdk-dev] [PATCH] doc: update softnic doc for flow and qos API support

Kovacevic, Marko marko.kovacevic at intel.com
Thu Oct 18 14:24:37 CEST 2018

> Update document with flow and qos api support in softnic PMD.
> Signed-off-by: Jasvinder Singh <jasvinder.singh at intel.com>
> Signed-off-by: Reshma Pattan <reshma.pattan at intel.com>
> ---
>  doc/guides/nics/softnic.rst | 119
> ++++++++++++++++++++++++++++++++++++
>  1 file changed, 119 insertions(+)
id 1)
> +
> +QoS API Support:
> +----------------
> +
> +SoftNIC PMD implements ethdev traffic management APIs ``rte_tm.h`` that
> +allow building and committing traffic manager hierarchy, configuring
> +hierarchy nodes of the Quality of Service (QoS) scheduler supported by
> +DPDK librte_sched library. Furthermore, APIs for run-time update to the
> +traffic manager hierarchy are supported by PMD.
> +
> +SoftNIC PMD also implements ethdev traffic metering and policing APIs
> +``rte_mtr.h`` that enables metering and marking of the packets with the
> +appropriate color (green, yellow or red), according to the traffic
> +metering algorithm. For the meter output color, policer actions can be
> +configured which include keep the same packet color (essentially a
> +no-op action), override the color the packet or drop the packet.

The one thing here I notice is the sentence 
" policer actions can be configured which include keep the same packet color "
"which include keep" sounds weird, 
Maybe one of these
" policer actions can be configured which include the same packet color "
" policer actions can be configured which keep the same packet color "

> +.. Note:
> +
> +The SoftNIC does not support the meter object shared by several flows,
> +thus only supports creating meter object private to the flow. Once
> +meter object is successfully created, it can be linked to the specific
> +flow by specifying the ``meter`` flow action in the flow rule.

Your note doesn't come out as a note because you didn't indent your text.

> +
> +The flow must have one terminating actions i.e. ``JMP or RSS or QUEUE or
> DROP``.
> +For the count and drop actions the underlying PMD doesn't support the
> +functionality yet. So it is not recommended for use.

Same here.

Reviewed-by: Marko Kovacevic <marko.kovacevic at intel.com>

More information about the dev mailing list