[dpdk-dev] [PATCH v3] doc: flow bifurcation guide on Linux

[Mcnamara, John]

> -----Original Message-----
> From: Wu, Jingjing
> Sent: Thursday, July 14, 2016 9:04 AM
> To: Mcnamara, John <john.mcnamara at intel.com>
> Cc: dev at dpdk.org; Wu, Jingjing <jingjing.wu at intel.com>; Liu, Yong
> <yong.liu at intel.com>; Zhang, Helin <helin.zhang at intel.com>
> Subject: [PATCH v3] doc: flow bifurcation guide on Linux
> 
> Flow bifurcation is a mechanism which depends the advanced Ethernet device
> to split traffic between queues. It provides the capability to let the
> kernel driver and DPDK driver co-exist and take their advantages.
> It is achieved by using SRIOV and NIC's advanced filtering. This patch
> describes it and adds the user guide on ixgbe and i40 NICs.

Hi Jingjing,

Thanks for the nice clear document with clear examples and images.

Some minor comments below.

> +Other than KNI, the SW is just required to device configuration, no
> +need to take care of the packet movement during the traffic split. This
> +can get more performance with less CPU overhead.

It isn't clear here what KNIs involvement is, if any, or why it is different.
I'd suggest clarifying if it is important or just omitting otherwise.


> +.. _figure_flow_bifurcation_overview:
> +
> +.. figure:: img/flow_bifurcation_overview.*
> +
> +   Flow Bifucation Overview

s/Bifucation/Bifurcation/

Also, I'd suggest using capitalized "Flow Bifurcation" consistently throughout the doc.

> +    .. code-block:: console
> +
> +        ethtool -K eth1 ntuple on
> +        ethtool -N eth1 flow-type udp4 src-ip 192.0.2.2 dst-ip
> 198.51.100.2 \
> +		        action $queue_index_in_VF0
> +        ethtool -N eth1 flow-type udp4 src-ip 198.51.100.2 dst-ip
> 192.0.2.2 \
> +                action $queue_index_in_VF1
> +
> +    where:
> +
> +        *   $queue_index_in_PF: [queue index]

I don't see '$queue_index_in_PF' used in this example.


> +#.  Enable and set flow filters:
> +
> +    *   L3 VEB filter, route whose dest IP = 192.168.50.108 to VF 0's
> queue 2.
> +
> +    .. code-block:: console
> +
> +        ethtool -N <dev_name> flow-type ip4 dst-ip 192.168.50.108 \
> +                user-def 0xffffffff00000000 action 2 loc 8
> +


I think the code-block level is wrong in these sections.

I'll send you on some other minor grammatical changes.

Thanks,

John