[2/2] net/sfc: improve logging in MAE backend of RTE flow support

Message ID 20210707105628.16705-2-ivan.malov@oktetlabs.ru (mailing list archive)
State Superseded, archived
Delegated to: David Marchand
Headers
Series [1/2] net/sfc: extend logging in MAE backend of RTE flow support |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/github-robot success github build: passed
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS

Commit Message

Ivan Malov July 7, 2021, 10:56 a.m. UTC
  Errors detected during parsing of pattern items and actions
are reflected by setting RTE error, but the name of the bad
element is not disclosed, thus leaving the user to join the
dots themselves. Adjust the code to log missing information.

Signed-off-by: Ivan Malov <ivan.malov@oktetlabs.ru>
Reviewed-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
Reviewed-by: Andy Moreton <amoreton@xilinx.com>
---
 drivers/net/sfc/sfc_flow.c | 34 +++++++++++++----------
 drivers/net/sfc/sfc_flow.h | 12 ++++++--
 drivers/net/sfc/sfc_mae.c  | 57 ++++++++++++++++++++++++++++----------
 3 files changed, 71 insertions(+), 32 deletions(-)
  

Comments

David Marchand July 15, 2021, 12:55 p.m. UTC | #1
On Wed, Jul 7, 2021 at 12:56 PM Ivan Malov <ivan.malov@oktetlabs.ru> wrote:
> diff --git a/drivers/net/sfc/sfc_flow.h b/drivers/net/sfc/sfc_flow.h
> index bd3b374d68..5b1f34aa7a 100644
> --- a/drivers/net/sfc/sfc_flow.h
> +++ b/drivers/net/sfc/sfc_flow.h
> @@ -136,13 +136,21 @@ typedef int (sfc_flow_item_parse)(const struct rte_flow_item *item,
>
>  struct sfc_flow_item {
>         enum rte_flow_item_type type;           /* Type of item */
> +       const char *name;                       /* Item name */
>         enum sfc_flow_item_layers layer;        /* Layer of item */
>         enum sfc_flow_item_layers prev_layer;   /* Previous layer of item */
>         enum sfc_flow_parse_ctx_type ctx_type;  /* Parse context type */
>         sfc_flow_item_parse *parse;             /* Parsing function */
>  };
>
> -int sfc_flow_parse_pattern(const struct sfc_flow_item *flow_items,
> +#define SFC_FLOW_ITEM(_name) \
> +       .type = RTE_FLOW_ITEM_TYPE_##_name,     \
> +       .name = #_name

Using this concatenation (same for SFC_FLOW_ACTION) confuses
devtools/parse-flow-support.sh script.

$ ./devtools/check-doc-vs-code.sh
rte_flow doc out of sync for sfc
    item
    item pf
    item phy_port
    item port_id
    item pppoes
    item tcp
    item vf
    action

Either net/sfc keeps full RTE_FLOW_x_TYPE_y form like other drivers,
or the check script must be updated (see exclude/include helpers).
  
Thomas Monjalon July 15, 2021, 1:43 p.m. UTC | #2
15/07/2021 14:55, David Marchand:
> On Wed, Jul 7, 2021 at 12:56 PM Ivan Malov <ivan.malov@oktetlabs.ru> wrote:
> > diff --git a/drivers/net/sfc/sfc_flow.h b/drivers/net/sfc/sfc_flow.h
> > index bd3b374d68..5b1f34aa7a 100644
> > --- a/drivers/net/sfc/sfc_flow.h
> > +++ b/drivers/net/sfc/sfc_flow.h
> > @@ -136,13 +136,21 @@ typedef int (sfc_flow_item_parse)(const struct rte_flow_item *item,
> >
> >  struct sfc_flow_item {
> >         enum rte_flow_item_type type;           /* Type of item */
> > +       const char *name;                       /* Item name */
> >         enum sfc_flow_item_layers layer;        /* Layer of item */
> >         enum sfc_flow_item_layers prev_layer;   /* Previous layer of item */
> >         enum sfc_flow_parse_ctx_type ctx_type;  /* Parse context type */
> >         sfc_flow_item_parse *parse;             /* Parsing function */
> >  };
> >
> > -int sfc_flow_parse_pattern(const struct sfc_flow_item *flow_items,
> > +#define SFC_FLOW_ITEM(_name) \
> > +       .type = RTE_FLOW_ITEM_TYPE_##_name,     \
> > +       .name = #_name
> 
> Using this concatenation (same for SFC_FLOW_ACTION) confuses
> devtools/parse-flow-support.sh script.
> 
> $ ./devtools/check-doc-vs-code.sh
> rte_flow doc out of sync for sfc
>     item
>     item pf
>     item phy_port
>     item port_id
>     item pppoes
>     item tcp
>     item vf
>     action
> 
> Either net/sfc keeps full RTE_FLOW_x_TYPE_y form like other drivers,
> or the check script must be updated (see exclude/include helpers).

Generating code with macros is also counter-intuitive for grep.
I think it should be avoided and keep full form RTE_FLOW_x_TYPE_y.
  

Patch

diff --git a/drivers/net/sfc/sfc_flow.c b/drivers/net/sfc/sfc_flow.c
index 0bfd284c9e..c8dc8222dc 100644
--- a/drivers/net/sfc/sfc_flow.c
+++ b/drivers/net/sfc/sfc_flow.c
@@ -1123,84 +1123,84 @@  sfc_flow_parse_pppoex(const struct rte_flow_item *item,
 
 static const struct sfc_flow_item sfc_flow_items[] = {
 	{
-		.type = RTE_FLOW_ITEM_TYPE_VOID,
+		SFC_FLOW_ITEM(VOID),
 		.prev_layer = SFC_FLOW_ITEM_ANY_LAYER,
 		.layer = SFC_FLOW_ITEM_ANY_LAYER,
 		.ctx_type = SFC_FLOW_PARSE_CTX_FILTER,
 		.parse = sfc_flow_parse_void,
 	},
 	{
-		.type = RTE_FLOW_ITEM_TYPE_ETH,
+		SFC_FLOW_ITEM(ETH),
 		.prev_layer = SFC_FLOW_ITEM_START_LAYER,
 		.layer = SFC_FLOW_ITEM_L2,
 		.ctx_type = SFC_FLOW_PARSE_CTX_FILTER,
 		.parse = sfc_flow_parse_eth,
 	},
 	{
-		.type = RTE_FLOW_ITEM_TYPE_VLAN,
+		SFC_FLOW_ITEM(VLAN),
 		.prev_layer = SFC_FLOW_ITEM_L2,
 		.layer = SFC_FLOW_ITEM_L2,
 		.ctx_type = SFC_FLOW_PARSE_CTX_FILTER,
 		.parse = sfc_flow_parse_vlan,
 	},
 	{
-		.type = RTE_FLOW_ITEM_TYPE_PPPOED,
+		SFC_FLOW_ITEM(PPPOED),
 		.prev_layer = SFC_FLOW_ITEM_L2,
 		.layer = SFC_FLOW_ITEM_L2,
 		.ctx_type = SFC_FLOW_PARSE_CTX_FILTER,
 		.parse = sfc_flow_parse_pppoex,
 	},
 	{
-		.type = RTE_FLOW_ITEM_TYPE_PPPOES,
+		SFC_FLOW_ITEM(PPPOES),
 		.prev_layer = SFC_FLOW_ITEM_L2,
 		.layer = SFC_FLOW_ITEM_L2,
 		.ctx_type = SFC_FLOW_PARSE_CTX_FILTER,
 		.parse = sfc_flow_parse_pppoex,
 	},
 	{
-		.type = RTE_FLOW_ITEM_TYPE_IPV4,
+		SFC_FLOW_ITEM(IPV4),
 		.prev_layer = SFC_FLOW_ITEM_L2,
 		.layer = SFC_FLOW_ITEM_L3,
 		.ctx_type = SFC_FLOW_PARSE_CTX_FILTER,
 		.parse = sfc_flow_parse_ipv4,
 	},
 	{
-		.type = RTE_FLOW_ITEM_TYPE_IPV6,
+		SFC_FLOW_ITEM(IPV6),
 		.prev_layer = SFC_FLOW_ITEM_L2,
 		.layer = SFC_FLOW_ITEM_L3,
 		.ctx_type = SFC_FLOW_PARSE_CTX_FILTER,
 		.parse = sfc_flow_parse_ipv6,
 	},
 	{
-		.type = RTE_FLOW_ITEM_TYPE_TCP,
+		SFC_FLOW_ITEM(TCP),
 		.prev_layer = SFC_FLOW_ITEM_L3,
 		.layer = SFC_FLOW_ITEM_L4,
 		.ctx_type = SFC_FLOW_PARSE_CTX_FILTER,
 		.parse = sfc_flow_parse_tcp,
 	},
 	{
-		.type = RTE_FLOW_ITEM_TYPE_UDP,
+		SFC_FLOW_ITEM(UDP),
 		.prev_layer = SFC_FLOW_ITEM_L3,
 		.layer = SFC_FLOW_ITEM_L4,
 		.ctx_type = SFC_FLOW_PARSE_CTX_FILTER,
 		.parse = sfc_flow_parse_udp,
 	},
 	{
-		.type = RTE_FLOW_ITEM_TYPE_VXLAN,
+		SFC_FLOW_ITEM(VXLAN),
 		.prev_layer = SFC_FLOW_ITEM_L4,
 		.layer = SFC_FLOW_ITEM_START_LAYER,
 		.ctx_type = SFC_FLOW_PARSE_CTX_FILTER,
 		.parse = sfc_flow_parse_vxlan,
 	},
 	{
-		.type = RTE_FLOW_ITEM_TYPE_GENEVE,
+		SFC_FLOW_ITEM(GENEVE),
 		.prev_layer = SFC_FLOW_ITEM_L4,
 		.layer = SFC_FLOW_ITEM_START_LAYER,
 		.ctx_type = SFC_FLOW_PARSE_CTX_FILTER,
 		.parse = sfc_flow_parse_geneve,
 	},
 	{
-		.type = RTE_FLOW_ITEM_TYPE_NVGRE,
+		SFC_FLOW_ITEM(NVGRE),
 		.prev_layer = SFC_FLOW_ITEM_L3,
 		.layer = SFC_FLOW_ITEM_START_LAYER,
 		.ctx_type = SFC_FLOW_PARSE_CTX_FILTER,
@@ -1296,7 +1296,8 @@  sfc_flow_get_item(const struct sfc_flow_item *items,
 }
 
 int
-sfc_flow_parse_pattern(const struct sfc_flow_item *flow_items,
+sfc_flow_parse_pattern(struct sfc_adapter *sa,
+		       const struct sfc_flow_item *flow_items,
 		       unsigned int nb_flow_items,
 		       const struct rte_flow_item pattern[],
 		       struct sfc_flow_parse_ctx *parse_ctx,
@@ -1380,8 +1381,11 @@  sfc_flow_parse_pattern(const struct sfc_flow_item *flow_items,
 		}
 
 		rc = item->parse(pattern, parse_ctx, error);
-		if (rc != 0)
+		if (rc != 0) {
+			sfc_err(sa, "failed to parse item %s: %s",
+				item->name, strerror(-rc));
 			return rc;
+		}
 
 		if (item->layer != SFC_FLOW_ITEM_ANY_LAYER)
 			prev_layer = item->layer;
@@ -2477,7 +2481,7 @@  sfc_flow_parse_rte_to_filter(struct rte_eth_dev *dev,
 	ctx.type = SFC_FLOW_PARSE_CTX_FILTER;
 	ctx.filter = &spec_filter->template;
 
-	rc = sfc_flow_parse_pattern(sfc_flow_items, RTE_DIM(sfc_flow_items),
+	rc = sfc_flow_parse_pattern(sa, sfc_flow_items, RTE_DIM(sfc_flow_items),
 				    pattern, &ctx, error);
 	if (rc != 0)
 		goto fail_bad_value;
diff --git a/drivers/net/sfc/sfc_flow.h b/drivers/net/sfc/sfc_flow.h
index bd3b374d68..5b1f34aa7a 100644
--- a/drivers/net/sfc/sfc_flow.h
+++ b/drivers/net/sfc/sfc_flow.h
@@ -136,13 +136,21 @@  typedef int (sfc_flow_item_parse)(const struct rte_flow_item *item,
 
 struct sfc_flow_item {
 	enum rte_flow_item_type type;		/* Type of item */
+	const char *name;			/* Item name */
 	enum sfc_flow_item_layers layer;	/* Layer of item */
 	enum sfc_flow_item_layers prev_layer;	/* Previous layer of item */
 	enum sfc_flow_parse_ctx_type ctx_type;	/* Parse context type */
 	sfc_flow_item_parse *parse;		/* Parsing function */
 };
 
-int sfc_flow_parse_pattern(const struct sfc_flow_item *flow_items,
+#define SFC_FLOW_ITEM(_name) \
+	.type = RTE_FLOW_ITEM_TYPE_##_name,	\
+	.name = #_name
+
+struct sfc_adapter;
+
+int sfc_flow_parse_pattern(struct sfc_adapter *sa,
+			   const struct sfc_flow_item *flow_items,
 			   unsigned int nb_flow_items,
 			   const struct rte_flow_item pattern[],
 			   struct sfc_flow_parse_ctx *parse_ctx,
@@ -156,8 +164,6 @@  int sfc_flow_parse_init(const struct rte_flow_item *item,
 			unsigned int size,
 			struct rte_flow_error *error);
 
-struct sfc_adapter;
-
 void sfc_flow_init(struct sfc_adapter *sa);
 void sfc_flow_fini(struct sfc_adapter *sa);
 int sfc_flow_start(struct sfc_adapter *sa);
diff --git a/drivers/net/sfc/sfc_mae.c b/drivers/net/sfc/sfc_mae.c
index 56b949ddf7..a005d9b1a4 100644
--- a/drivers/net/sfc/sfc_mae.c
+++ b/drivers/net/sfc/sfc_mae.c
@@ -1828,7 +1828,7 @@  sfc_mae_rule_parse_item_tunnel(const struct rte_flow_item *item,
 
 static const struct sfc_flow_item sfc_flow_items[] = {
 	{
-		.type = RTE_FLOW_ITEM_TYPE_PORT_ID,
+		SFC_FLOW_ITEM(PORT_ID),
 		/*
 		 * In terms of RTE flow, this item is a META one,
 		 * and its position in the pattern is don't care.
@@ -1839,7 +1839,7 @@  static const struct sfc_flow_item sfc_flow_items[] = {
 		.parse = sfc_mae_rule_parse_item_port_id,
 	},
 	{
-		.type = RTE_FLOW_ITEM_TYPE_PHY_PORT,
+		SFC_FLOW_ITEM(PHY_PORT),
 		/*
 		 * In terms of RTE flow, this item is a META one,
 		 * and its position in the pattern is don't care.
@@ -1850,7 +1850,7 @@  static const struct sfc_flow_item sfc_flow_items[] = {
 		.parse = sfc_mae_rule_parse_item_phy_port,
 	},
 	{
-		.type = RTE_FLOW_ITEM_TYPE_PF,
+		SFC_FLOW_ITEM(PF),
 		/*
 		 * In terms of RTE flow, this item is a META one,
 		 * and its position in the pattern is don't care.
@@ -1861,7 +1861,7 @@  static const struct sfc_flow_item sfc_flow_items[] = {
 		.parse = sfc_mae_rule_parse_item_pf,
 	},
 	{
-		.type = RTE_FLOW_ITEM_TYPE_VF,
+		SFC_FLOW_ITEM(VF),
 		/*
 		 * In terms of RTE flow, this item is a META one,
 		 * and its position in the pattern is don't care.
@@ -1872,63 +1872,63 @@  static const struct sfc_flow_item sfc_flow_items[] = {
 		.parse = sfc_mae_rule_parse_item_vf,
 	},
 	{
-		.type = RTE_FLOW_ITEM_TYPE_ETH,
+		SFC_FLOW_ITEM(ETH),
 		.prev_layer = SFC_FLOW_ITEM_START_LAYER,
 		.layer = SFC_FLOW_ITEM_L2,
 		.ctx_type = SFC_FLOW_PARSE_CTX_MAE,
 		.parse = sfc_mae_rule_parse_item_eth,
 	},
 	{
-		.type = RTE_FLOW_ITEM_TYPE_VLAN,
+		SFC_FLOW_ITEM(VLAN),
 		.prev_layer = SFC_FLOW_ITEM_L2,
 		.layer = SFC_FLOW_ITEM_L2,
 		.ctx_type = SFC_FLOW_PARSE_CTX_MAE,
 		.parse = sfc_mae_rule_parse_item_vlan,
 	},
 	{
-		.type = RTE_FLOW_ITEM_TYPE_IPV4,
+		SFC_FLOW_ITEM(IPV4),
 		.prev_layer = SFC_FLOW_ITEM_L2,
 		.layer = SFC_FLOW_ITEM_L3,
 		.ctx_type = SFC_FLOW_PARSE_CTX_MAE,
 		.parse = sfc_mae_rule_parse_item_ipv4,
 	},
 	{
-		.type = RTE_FLOW_ITEM_TYPE_IPV6,
+		SFC_FLOW_ITEM(IPV6),
 		.prev_layer = SFC_FLOW_ITEM_L2,
 		.layer = SFC_FLOW_ITEM_L3,
 		.ctx_type = SFC_FLOW_PARSE_CTX_MAE,
 		.parse = sfc_mae_rule_parse_item_ipv6,
 	},
 	{
-		.type = RTE_FLOW_ITEM_TYPE_TCP,
+		SFC_FLOW_ITEM(TCP),
 		.prev_layer = SFC_FLOW_ITEM_L3,
 		.layer = SFC_FLOW_ITEM_L4,
 		.ctx_type = SFC_FLOW_PARSE_CTX_MAE,
 		.parse = sfc_mae_rule_parse_item_tcp,
 	},
 	{
-		.type = RTE_FLOW_ITEM_TYPE_UDP,
+		SFC_FLOW_ITEM(UDP),
 		.prev_layer = SFC_FLOW_ITEM_L3,
 		.layer = SFC_FLOW_ITEM_L4,
 		.ctx_type = SFC_FLOW_PARSE_CTX_MAE,
 		.parse = sfc_mae_rule_parse_item_udp,
 	},
 	{
-		.type = RTE_FLOW_ITEM_TYPE_VXLAN,
+		SFC_FLOW_ITEM(VXLAN),
 		.prev_layer = SFC_FLOW_ITEM_L4,
 		.layer = SFC_FLOW_ITEM_START_LAYER,
 		.ctx_type = SFC_FLOW_PARSE_CTX_MAE,
 		.parse = sfc_mae_rule_parse_item_tunnel,
 	},
 	{
-		.type = RTE_FLOW_ITEM_TYPE_GENEVE,
+		SFC_FLOW_ITEM(GENEVE),
 		.prev_layer = SFC_FLOW_ITEM_L4,
 		.layer = SFC_FLOW_ITEM_START_LAYER,
 		.ctx_type = SFC_FLOW_PARSE_CTX_MAE,
 		.parse = sfc_mae_rule_parse_item_tunnel,
 	},
 	{
-		.type = RTE_FLOW_ITEM_TYPE_NVGRE,
+		SFC_FLOW_ITEM(NVGRE),
 		.prev_layer = SFC_FLOW_ITEM_L3,
 		.layer = SFC_FLOW_ITEM_START_LAYER,
 		.ctx_type = SFC_FLOW_PARSE_CTX_MAE,
@@ -2137,7 +2137,7 @@  sfc_mae_rule_parse_pattern(struct sfc_adapter *sa,
 	if (rc != 0)
 		goto fail_encap_parse_init;
 
-	rc = sfc_flow_parse_pattern(sfc_flow_items, RTE_DIM(sfc_flow_items),
+	rc = sfc_flow_parse_pattern(sa, sfc_flow_items, RTE_DIM(sfc_flow_items),
 				    pattern, &ctx, error);
 	if (rc != 0)
 		goto fail_parse_pattern;
@@ -2728,6 +2728,27 @@  sfc_mae_rule_parse_action_port_id(struct sfc_adapter *sa,
 	return rc;
 }
 
+static const char * const action_names[] = {
+#define SFC_FLOW_ACTION(_name) \
+	[RTE_FLOW_ACTION_TYPE_##_name] = #_name
+
+	SFC_FLOW_ACTION(VXLAN_DECAP),
+	SFC_FLOW_ACTION(OF_POP_VLAN),
+	SFC_FLOW_ACTION(OF_PUSH_VLAN),
+	SFC_FLOW_ACTION(OF_SET_VLAN_VID),
+	SFC_FLOW_ACTION(OF_SET_VLAN_PCP),
+	SFC_FLOW_ACTION(VXLAN_ENCAP),
+	SFC_FLOW_ACTION(FLAG),
+	SFC_FLOW_ACTION(MARK),
+	SFC_FLOW_ACTION(PHY_PORT),
+	SFC_FLOW_ACTION(PF),
+	SFC_FLOW_ACTION(VF),
+	SFC_FLOW_ACTION(PORT_ID),
+	SFC_FLOW_ACTION(DROP),
+
+#undef SFC_FLOW_ACTION
+};
+
 static int
 sfc_mae_rule_parse_action(struct sfc_adapter *sa,
 			  const struct rte_flow_action *action,
@@ -2821,6 +2842,14 @@  sfc_mae_rule_parse_action(struct sfc_adapter *sa,
 	if (rc == 0) {
 		bundle->actions_mask |= (1ULL << action->type);
 	} else if (!custom_error) {
+		if (action->type < RTE_DIM(action_names)) {
+			const char *action_name = action_names[action->type];
+
+			if (action_name != NULL) {
+				sfc_err(sa, "action %s was rejected: %s",
+					action_name, strerror(rc));
+			}
+		}
 		rc = rte_flow_error_set(error, rc, RTE_FLOW_ERROR_TYPE_ACTION,
 				NULL, "Failed to request the action");
 	}