X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=examples%2Fflow_filtering%2Fflow_blocks.c;h=f368e6124d93cba9090a227cce5f38154a0743a8;hb=7c0c63c9a53964d40b27da618ab94303f28ea92e;hp=bae7116996de84bf5ff79fbff3e46af3869f61e9;hpb=9af4eb5657107b05b0e06141291b7c6e6162bb36;p=dpdk.git

diff --git a/examples/flow_filtering/flow_blocks.c b/examples/flow_filtering/flow_blocks.c
index bae7116996..f368e6124d 100644
--- a/examples/flow_filtering/flow_blocks.c
+++ b/examples/flow_filtering/flow_blocks.c
@@ -2,7 +2,8 @@
  * Copyright 2017 Mellanox Technologies, Ltd
  */
 
-#define MAX_PATTERN_NUM		4
+#define MAX_PATTERN_NUM		3
+#define MAX_ACTION_NUM		2
 
 struct rte_flow *
 generate_ipv4_flow(uint16_t port_id, uint16_t rx_q,
@@ -33,60 +34,58 @@ generate_ipv4_flow(uint16_t port_id, uint16_t rx_q,
  * @return
  *   A flow if the rule could be created else return NULL.
  */
+
+/* Function responsible for creating the flow rule. 8< */
 struct rte_flow *
 generate_ipv4_flow(uint16_t port_id, uint16_t rx_q,
 		uint32_t src_ip, uint32_t src_mask,
 		uint32_t dest_ip, uint32_t dest_mask,
 		struct rte_flow_error *error)
 {
+	/* Declaring structs being used. 8< */
 	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;
+	/* >8 End of declaring structs being used. */
 	int res;
 
 	memset(pattern, 0, sizeof(pattern));
 	memset(action, 0, sizeof(action));
 
-	/*
-	 * set the rule attribute.
-	 * in this case only ingress packets will be checked.
-	 */
+	/* Set the rule attribute, only ingress packets will be checked. 8< */
 	memset(&attr, 0, sizeof(struct rte_flow_attr));
 	attr.ingress = 1;
+	/* >8 End of setting the rule attribute. */
 
 	/*
 	 * 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;
+
+	/* Set this level to allow all. 8< */
 	pattern[0].type = RTE_FLOW_ITEM_TYPE_ETH;
-	pattern[0].spec = &eth_spec;
-	pattern[0].mask = &eth_mask;
+	/* >8 End of setting the first level of the pattern. */
 
 	/*
-	 * 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.
 	 */
+
+	/* Setting the second level of the pattern. 8< */
 	memset(&ip_spec, 0, sizeof(struct rte_flow_item_ipv4));
 	memset(&ip_mask, 0, sizeof(struct rte_flow_item_ipv4));
 	ip_spec.hdr.dst_addr = htonl(dest_ip);
@@ -96,14 +95,18 @@ generate_ipv4_flow(uint16_t port_id, uint16_t rx_q,
 	pattern[1].type = RTE_FLOW_ITEM_TYPE_IPV4;
 	pattern[1].spec = &ip_spec;
 	pattern[1].mask = &ip_mask;
+	/* >8 End of setting the second level of the pattern. */
 
-	/* the final level must be always type end */
+	/* The final level must be always type end. 8< */
 	pattern[2].type = RTE_FLOW_ITEM_TYPE_END;
+	/* >8 End of final level must be always type end. */
 
+	/* Validate the rule and create it. 8< */
 	res = rte_flow_validate(port_id, &attr, pattern, action, error);
 	if (!res)
 		flow = rte_flow_create(port_id, &attr, pattern, action, error);
+	/* >8 End of validation the rule and create it. */
 
 	return flow;
 }
-
+/* >8 End of function responsible for creating the flow rule. */