[dpdk-stable] patch 'examples/flow_filtering: fix example documentation' has been queued to LTS release 17.11.6

[Yongseok Koh <yskoh@mellanox.com>]

Hi,

FYI, your patch has been queued to LTS release 17.11.6

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objection by 03/13/19. So please
shout if anyone has objection.

Also note that after the patch there's a diff of the upstream commit vs the patch applied
to the branch. If the code is different (ie: not only metadata diffs), due for example to
a change in context or macro names, please double check it.

Thanks.

Yongseok

---
>From 1efd83c353c23d516d19ca460e4b4046ee78033a Mon Sep 17 00:00:00 2001
From: Dekel Peled <dekelp@mellanox.com>
Date: Tue, 25 Dec 2018 09:42:18 +0200
Subject: [PATCH] examples/flow_filtering: fix example documentation

[ upstream commit d67b3f11d352544063fbdf2a8232563d88870d6a ]

Previous patch removed the VLAN item from example code.
This patch fixes the code and documentation accordingly.

Code update includes fix of comments, and removal of redundant
variables and their initialization.
Documentation update reflects the code changes done in previous
patch and in this patch.

Fixes: 9af4eb565710 ("examples/flow_filtering: remove VLAN item")

Signed-off-by: Dekel Peled <dekelp@mellanox.com>
Acked-by: Ori Kam <orika@mellanox.com>
---
 doc/guides/sample_app_ug/flow_filtering.rst | 74 +++++++----------------------
 examples/flow_filtering/flow_blocks.c       | 18 ++-----
 2 files changed, 21 insertions(+), 71 deletions(-)

diff --git a/doc/guides/sample_app_ug/flow_filtering.rst b/doc/guides/sample_app_ug/flow_filtering.rst
index 725dcb445..608663229 100644
--- a/doc/guides/sample_app_ug/flow_filtering.rst
+++ b/doc/guides/sample_app_ug/flow_filtering.rst
@@ -81,7 +81,7 @@ applications and the Environment Abstraction Layer (EAL) options.
 Explanation
 -----------
 
-The example is build from 2 main files,
+The example is built from 2 files,
 ``main.c`` which holds the example logic and ``flow_blocks.c`` that holds the
 implementation for building the flow rule.
 
@@ -378,13 +378,9 @@ This function is located in the ``flow_blocks.c`` file.
    {
            struct rte_flow_attr attr;
            struct rte_flow_item pattern[MAX_PATTERN_NUM];
-           struct rte_flow_action action[MAX_PATTERN_NUM];
+           struct rte_flow_action action[MAX_ACTION_NUM];
            struct rte_flow *flow = NULL;
            struct rte_flow_action_queue queue = { .index = rx_q };
-           struct rte_flow_item_eth eth_spec;
-           struct rte_flow_item_eth eth_mask;
-           struct rte_flow_item_vlan vlan_spec;
-           struct rte_flow_item_vlan vlan_mask;
            struct rte_flow_item_ipv4 ip_spec;
            struct rte_flow_item_ipv4 ip_mask;
 
@@ -402,37 +398,19 @@ This function is located in the ``flow_blocks.c`` file.
             * create the action sequence.
             * one action only,  move packet to queue
             */
-
            action[0].type = RTE_FLOW_ACTION_TYPE_QUEUE;
            action[0].conf = &queue;
            action[1].type = RTE_FLOW_ACTION_TYPE_END;
 
            /*
-            * set the first level of the pattern (eth).
+            * set the first level of the pattern (ETH).
             * since in this example we just want to get the
             * ipv4 we set this level to allow all.
             */
-           memset(&eth_spec, 0, sizeof(struct rte_flow_item_eth));
-           memset(&eth_mask, 0, sizeof(struct rte_flow_item_eth));
-           eth_spec.type = 0;
-           eth_mask.type = 0;
            pattern[0].type = RTE_FLOW_ITEM_TYPE_ETH;
-           pattern[0].spec = &eth_spec;
-           pattern[0].mask = &eth_mask;
-
-           /*
-            * setting the second level of the pattern (vlan).
-            * since in this example we just want to get the
-            * ipv4 we also set this level to allow all.
-            */
-           memset(&vlan_spec, 0, sizeof(struct rte_flow_item_vlan));
-           memset(&vlan_mask, 0, sizeof(struct rte_flow_item_vlan));
-           pattern[1].type = RTE_FLOW_ITEM_TYPE_VLAN;
-           pattern[1].spec = &vlan_spec;
-           pattern[1].mask = &vlan_mask;
 
            /*
-            * setting the third level of the pattern (ip).
+            * setting the second level of the pattern (IP).
             * in this example this is the level we care about
             * so we set it according to the parameters.
             */
@@ -442,12 +420,12 @@ This function is located in the ``flow_blocks.c`` file.
            ip_mask.hdr.dst_addr = dest_mask;
            ip_spec.hdr.src_addr = htonl(src_ip);
            ip_mask.hdr.src_addr = src_mask;
-           pattern[2].type = RTE_FLOW_ITEM_TYPE_IPV4;
-           pattern[2].spec = &ip_spec;
-           pattern[2].mask = &ip_mask;
+           pattern[1].type = RTE_FLOW_ITEM_TYPE_IPV4;
+           pattern[1].spec = &ip_spec;
+           pattern[1].mask = &ip_mask;
 
            /* the final level must be always type end */
-           pattern[3].type = RTE_FLOW_ITEM_TYPE_END;
+           pattern[2].type = RTE_FLOW_ITEM_TYPE_END;
 
            int res = rte_flow_validate(port_id, &attr, pattern, action, error);
            if(!res)
@@ -462,14 +440,10 @@ The first part of the function is declaring the structures that will be used.
 
    struct rte_flow_attr attr;
    struct rte_flow_item pattern[MAX_PATTERN_NUM];
-   struct rte_flow_action action[MAX_PATTERN_NUM];
+   struct rte_flow_action action[MAX_ACTION_NUM];
    struct rte_flow *flow;
    struct rte_flow_error error;
    struct rte_flow_action_queue queue = { .index = rx_q };
-   struct rte_flow_item_eth eth_spec;
-   struct rte_flow_item_eth eth_mask;
-   struct rte_flow_item_vlan vlan_spec;
-   struct rte_flow_item_vlan vlan_mask;
    struct rte_flow_item_ipv4 ip_spec;
    struct rte_flow_item_ipv4 ip_mask;
 
@@ -489,33 +463,17 @@ the rule. In this case send the packet to queue.
    action[0].conf = &queue;
    action[1].type = RTE_FLOW_ACTION_TYPE_END;
 
-The forth part is responsible for creating the pattern and is build from
-number of step. In each step we build one level of the pattern starting with
+The fourth part is responsible for creating the pattern and is built from
+number of steps. In each step we build one level of the pattern starting with
 the lowest one.
 
 Setting the first level of the pattern ETH:
 
 .. code-block:: c
 
-   memset(&eth_spec, 0, sizeof(struct rte_flow_item_eth));
-   memset(&eth_mask, 0, sizeof(struct rte_flow_item_eth));
-   eth_spec.type = 0;
-   eth_mask.type = 0;
    pattern[0].type = RTE_FLOW_ITEM_TYPE_ETH;
-   pattern[0].spec = &eth_spec;
-   pattern[0].mask = &eth_mask;
-
-Setting the second level of the pattern VLAN:
-
-.. code-block:: c
-
-   memset(&vlan_spec, 0, sizeof(struct rte_flow_item_vlan));
-   memset(&vlan_mask, 0, sizeof(struct rte_flow_item_vlan));
-   pattern[1].type = RTE_FLOW_ITEM_TYPE_VLAN;
-   pattern[1].spec = &vlan_spec;
-   pattern[1].mask = &vlan_mask;
 
-Setting the third level ip:
+Setting the second level of the pattern IP:
 
 .. code-block:: c
 
@@ -525,15 +483,15 @@ Setting the third level ip:
    ip_mask.hdr.dst_addr = dest_mask;
    ip_spec.hdr.src_addr = htonl(src_ip);
    ip_mask.hdr.src_addr = src_mask;
-   pattern[2].type = RTE_FLOW_ITEM_TYPE_IPV4;
-   pattern[2].spec = &ip_spec;
-   pattern[2].mask = &ip_mask;
+   pattern[1].type = RTE_FLOW_ITEM_TYPE_IPV4;
+   pattern[1].spec = &ip_spec;
+   pattern[1].mask = &ip_mask;
 
 Closing the pattern part.
 
 .. code-block:: c
 
-   pattern[3].type = RTE_FLOW_ITEM_TYPE_END;
+   pattern[2].type = RTE_FLOW_ITEM_TYPE_END;
 
 The last part of the function is to validate the rule and create it.
 
diff --git a/examples/flow_filtering/flow_blocks.c b/examples/flow_filtering/flow_blocks.c
index b71a42ff0..c1e482f04 100644
--- a/examples/flow_filtering/flow_blocks.c
+++ b/examples/flow_filtering/flow_blocks.c
@@ -30,7 +30,8 @@
  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-#define MAX_PATTERN_NUM		4
+#define MAX_PATTERN_NUM		3
+#define MAX_ACTION_NUM		2
 
 struct rte_flow *
 generate_ipv4_flow(uint8_t port_id, uint16_t rx_q,
@@ -69,11 +70,9 @@ generate_ipv4_flow(uint8_t port_id, uint16_t rx_q,
 {
 	struct rte_flow_attr attr;
 	struct rte_flow_item pattern[MAX_PATTERN_NUM];
-	struct rte_flow_action action[MAX_PATTERN_NUM];
+	struct rte_flow_action action[MAX_ACTION_NUM];
 	struct rte_flow *flow = NULL;
 	struct rte_flow_action_queue queue = { .index = rx_q };
-	struct rte_flow_item_eth eth_spec;
-	struct rte_flow_item_eth eth_mask;
 	struct rte_flow_item_ipv4 ip_spec;
 	struct rte_flow_item_ipv4 ip_mask;
 	int res;
@@ -92,26 +91,19 @@ generate_ipv4_flow(uint8_t port_id, uint16_t rx_q,
 	 * create the action sequence.
 	 * one action only,  move packet to queue
 	 */
-
 	action[0].type = RTE_FLOW_ACTION_TYPE_QUEUE;
 	action[0].conf = &queue;
 	action[1].type = RTE_FLOW_ACTION_TYPE_END;
 
 	/*
-	 * set the first level of the pattern (eth).
+	 * set the first level of the pattern (ETH).
 	 * since in this example we just want to get the
 	 * ipv4 we set this level to allow all.
 	 */
-	memset(&eth_spec, 0, sizeof(struct rte_flow_item_eth));
-	memset(&eth_mask, 0, sizeof(struct rte_flow_item_eth));
-	eth_spec.type = 0;
-	eth_mask.type = 0;
 	pattern[0].type = RTE_FLOW_ITEM_TYPE_ETH;
-	pattern[0].spec = &eth_spec;
-	pattern[0].mask = &eth_mask;
 
 	/*
-	 * setting the third level of the pattern (ip).
+	 * setting the second level of the pattern (IP).
 	 * in this example this is the level we care about
 	 * so we set it according to the parameters.
 	 */
-- 
2.11.0

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2019-03-08 09:46:42.117692049 -0800
+++ 0037-examples-flow_filtering-fix-example-documentation.patch	2019-03-08 09:46:40.170404000 -0800
@@ -1,8 +1,10 @@
-From d67b3f11d352544063fbdf2a8232563d88870d6a Mon Sep 17 00:00:00 2001
+From 1efd83c353c23d516d19ca460e4b4046ee78033a Mon Sep 17 00:00:00 2001
 From: Dekel Peled <dekelp@mellanox.com>
 Date: Tue, 25 Dec 2018 09:42:18 +0200
 Subject: [PATCH] examples/flow_filtering: fix example documentation
 
+[ upstream commit d67b3f11d352544063fbdf2a8232563d88870d6a ]
+
 Previous patch removed the VLAN item from example code.
 This patch fixes the code and documentation accordingly.
 
@@ -12,7 +14,6 @@
 patch and in this patch.
 
 Fixes: 9af4eb565710 ("examples/flow_filtering: remove VLAN item")
-Cc: stable@dpdk.org
 
 Signed-off-by: Dekel Peled <dekelp@mellanox.com>
 Acked-by: Ori Kam <orika@mellanox.com>
@@ -22,10 +23,10 @@
  2 files changed, 21 insertions(+), 71 deletions(-)
 
 diff --git a/doc/guides/sample_app_ug/flow_filtering.rst b/doc/guides/sample_app_ug/flow_filtering.rst
-index 840d557c5..9dba85acf 100644
+index 725dcb445..608663229 100644
 --- a/doc/guides/sample_app_ug/flow_filtering.rst
 +++ b/doc/guides/sample_app_ug/flow_filtering.rst
-@@ -53,7 +53,7 @@ applications and the Environment Abstraction Layer (EAL) options.
+@@ -81,7 +81,7 @@ applications and the Environment Abstraction Layer (EAL) options.
  Explanation
  -----------
  
@@ -34,7 +35,7 @@
  ``main.c`` which holds the example logic and ``flow_blocks.c`` that holds the
  implementation for building the flow rule.
  
-@@ -380,13 +380,9 @@ This function is located in the ``flow_blocks.c`` file.
+@@ -378,13 +378,9 @@ This function is located in the ``flow_blocks.c`` file.
     {
             struct rte_flow_attr attr;
             struct rte_flow_item pattern[MAX_PATTERN_NUM];
@@ -49,7 +50,7 @@
             struct rte_flow_item_ipv4 ip_spec;
             struct rte_flow_item_ipv4 ip_mask;
  
-@@ -404,37 +400,19 @@ This function is located in the ``flow_blocks.c`` file.
+@@ -402,37 +398,19 @@ This function is located in the ``flow_blocks.c`` file.
              * create the action sequence.
              * one action only,  move packet to queue
              */
@@ -89,7 +90,7 @@
              * in this example this is the level we care about
              * so we set it according to the parameters.
              */
-@@ -444,12 +422,12 @@ This function is located in the ``flow_blocks.c`` file.
+@@ -442,12 +420,12 @@ This function is located in the ``flow_blocks.c`` file.
             ip_mask.hdr.dst_addr = dest_mask;
             ip_spec.hdr.src_addr = htonl(src_ip);
             ip_mask.hdr.src_addr = src_mask;
@@ -106,7 +107,7 @@
  
             int res = rte_flow_validate(port_id, &attr, pattern, action, error);
             if(!res)
-@@ -464,14 +442,10 @@ The first part of the function is declaring the structures that will be used.
+@@ -462,14 +440,10 @@ The first part of the function is declaring the structures that will be used.
  
     struct rte_flow_attr attr;
     struct rte_flow_item pattern[MAX_PATTERN_NUM];
@@ -122,7 +123,7 @@
     struct rte_flow_item_ipv4 ip_spec;
     struct rte_flow_item_ipv4 ip_mask;
  
-@@ -491,33 +465,17 @@ the rule. In this case send the packet to queue.
+@@ -489,33 +463,17 @@ the rule. In this case send the packet to queue.
     action[0].conf = &queue;
     action[1].type = RTE_FLOW_ACTION_TYPE_END;
  
@@ -159,7 +160,7 @@
  
  .. code-block:: c
  
-@@ -527,15 +485,15 @@ Setting the third level ip:
+@@ -525,15 +483,15 @@ Setting the third level ip:
     ip_mask.hdr.dst_addr = dest_mask;
     ip_spec.hdr.src_addr = htonl(src_ip);
     ip_mask.hdr.src_addr = src_mask;
@@ -180,11 +181,11 @@
  The last part of the function is to validate the rule and create it.
  
 diff --git a/examples/flow_filtering/flow_blocks.c b/examples/flow_filtering/flow_blocks.c
-index bae711699..1edf6f9c6 100644
+index b71a42ff0..c1e482f04 100644
 --- a/examples/flow_filtering/flow_blocks.c
 +++ b/examples/flow_filtering/flow_blocks.c
-@@ -2,7 +2,8 @@
-  * Copyright 2017 Mellanox Technologies, Ltd
+@@ -30,7 +30,8 @@
+  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   */
  
 -#define MAX_PATTERN_NUM		4
@@ -192,8 +193,8 @@
 +#define MAX_ACTION_NUM		2
  
  struct rte_flow *
- generate_ipv4_flow(uint16_t port_id, uint16_t rx_q,
-@@ -41,11 +42,9 @@ generate_ipv4_flow(uint16_t port_id, uint16_t rx_q,
+ generate_ipv4_flow(uint8_t port_id, uint16_t rx_q,
+@@ -69,11 +70,9 @@ generate_ipv4_flow(uint8_t port_id, uint16_t rx_q,
  {
  	struct rte_flow_attr attr;
  	struct rte_flow_item pattern[MAX_PATTERN_NUM];
@@ -206,7 +207,7 @@
  	struct rte_flow_item_ipv4 ip_spec;
  	struct rte_flow_item_ipv4 ip_mask;
  	int res;
-@@ -64,26 +63,19 @@ generate_ipv4_flow(uint16_t port_id, uint16_t rx_q,
+@@ -92,26 +91,19 @@ generate_ipv4_flow(uint8_t port_id, uint16_t rx_q,
  	 * create the action sequence.
  	 * one action only,  move packet to queue
  	 */