Add more sentences to describe group concepts and define
group 0 as root group for traffic to search a hit rule.
Signed-off-by: Rongwei Liu <rongw...@nvidia.com>
---
lib/ethdev/rte_flow.h | 15 +++++++++++++++
1 file changed, 15 insertions(+)
diff --git a/lib/ethdev/rte_flow.h b/lib/ethdev/rte_flow.h
index b60987db4b..e004e41ac8 100644
--- a/lib/ethdev/rte_flow.h
+++ b/lib/ethdev/rte_flow.h
@@ -86,6 +86,21 @@ extern "C" {
* but may be valid in a few cases.
*/
struct rte_flow_attr {
+ /**
+ * Group is a superset of several rules and the user should always
+ * set the flow rules starting from group 0. Jump action is used
+ * to find the next rule set by specifying the group ID if matching
+ * criteria are met.
+ * The group ID which is to be jumped may be not contiguous with the
+ * current flow rules' group ID, then the group IDs between them will
+ * be skipped.
+ *
+ * The user should make sure no dead loop is introduced when organizing
+ * flow rules and this can be achieved by always jumping to higher group
+ * number.
+ *
+ * Note: group 0 is shared between kernel and DPDK for bifurcated
drivers.
+ */
uint32_t group; /**< Priority group. */
uint32_t priority; /**< Rule priority level within group. */
/**
--
2.27.0
