[dpdk-dev] [PATCH 3/5] app/testpmd: new flow dump CLI

[Ori Kam]

> -----Original Message-----
> Subject: [PATCH 3/5] app/testpmd: new flow dump CLI
> 
> From: Xueming Li <xuemingl at mellanox.com>
> 
> New flow dump CLI to dump device internal representation information
> of flows into screen.
> 
> Signed-off-by: Xueming Li <xuemingl at mellanox.com>
> Signed-off-by: Xiaoyu Min <jackmin at mellanox.com>
> ---

Acked-by: Ori Kam <orika at mellanox.com>
Thanks,
Ori


>  app/test-pmd/cmdline_flow.c | 91
> +++++++++++++++++++++++++++++++++++++
>  app/test-pmd/config.c       | 27 +++++++++++
>  app/test-pmd/testpmd.h      |  1 +
>  3 files changed, 119 insertions(+)
> 
> diff --git a/app/test-pmd/cmdline_flow.c b/app/test-pmd/cmdline_flow.c
> index 99dade7d8c..19336e5d42 100644
> --- a/app/test-pmd/cmdline_flow.c
> +++ b/app/test-pmd/cmdline_flow.c
> @@ -41,6 +41,7 @@ enum index {
>  	BOOLEAN,
>  	STRING,
>  	HEX,
> +	FILE_PATH,
>  	MAC_ADDR,
>  	IPV4_ADDR,
>  	IPV6_ADDR,
> @@ -63,6 +64,7 @@ enum index {
>  	CREATE,
>  	DESTROY,
>  	FLUSH,
> +	DUMP,
>  	QUERY,
>  	LIST,
>  	ISOLATE,
> @@ -631,6 +633,9 @@ struct buffer {
>  			uint32_t *rule;
>  			uint32_t rule_n;
>  		} destroy; /**< Destroy arguments. */
> +		struct {
> +			char file[128];
> +		} dump; /**< Dump arguments. */
>  		struct {
>  			uint32_t rule;
>  			struct rte_flow_action action;
> @@ -685,6 +690,12 @@ static const enum index next_destroy_attr[] = {
>  	ZERO,
>  };
> 
> +static const enum index next_dump_attr[] = {
> +	FILE_PATH,
> +	END,
> +	ZERO,
> +};
> +
>  static const enum index next_list_attr[] = {
>  	LIST_GROUP,
>  	END,
> @@ -1374,6 +1385,9 @@ static int parse_destroy(struct context *, const
> struct token *,
>  static int parse_flush(struct context *, const struct token *,
>  		       const char *, unsigned int,
>  		       void *, unsigned int);
> +static int parse_dump(struct context *, const struct token *,
> +		      const char *, unsigned int,
> +		      void *, unsigned int);
>  static int parse_query(struct context *, const struct token *,
>  		       const char *, unsigned int,
>  		       void *, unsigned int);
> @@ -1401,6 +1415,9 @@ static int parse_string(struct context *, const struct
> token *,
>  static int parse_hex(struct context *ctx, const struct token *token,
>  			const char *str, unsigned int len,
>  			void *buf, unsigned int size);
> +static int parse_string0(struct context *, const struct token *,
> +			const char *, unsigned int,
> +			void *, unsigned int);
>  static int parse_mac_addr(struct context *, const struct token *,
>  			  const char *, unsigned int,
>  			  void *, unsigned int);
> @@ -1494,6 +1511,12 @@ static const struct token token_list[] = {
>  		.type = "HEX",
>  		.help = "fixed string",
>  		.call = parse_hex,
> +	},
> +	[FILE_PATH] = {
> +		.name = "{file path}",
> +		.type = "STRING",
> +		.help = "file path",
> +		.call = parse_string0,
>  		.comp = comp_none,
>  	},
>  	[MAC_ADDR] = {
> @@ -1555,6 +1578,7 @@ static const struct token token_list[] = {
>  			      CREATE,
>  			      DESTROY,
>  			      FLUSH,
> +			      DUMP,
>  			      LIST,
>  			      QUERY,
>  			      ISOLATE)),
> @@ -1589,6 +1613,14 @@ static const struct token token_list[] = {
>  		.args = ARGS(ARGS_ENTRY(struct buffer, port)),
>  		.call = parse_flush,
>  	},
> +	[DUMP] = {
> +		.name = "dump",
> +		.help = "dump all flow rules to file",
> +		.next = NEXT(next_dump_attr, NEXT_ENTRY(PORT_ID)),
> +		.args = ARGS(ARGS_ENTRY(struct buffer, args.dump.file),
> +			     ARGS_ENTRY(struct buffer, port)),
> +		.call = parse_dump,
> +	},
>  	[QUERY] = {
>  		.name = "query",
>  		.help = "query an existing flow rule",
> @@ -5012,6 +5044,33 @@ parse_flush(struct context *ctx, const struct token
> *token,
>  	return len;
>  }
> 
> +/** Parse tokens for dump command. */
> +static int
> +parse_dump(struct context *ctx, const struct token *token,
> +	    const char *str, unsigned int len,
> +	    void *buf, unsigned int size)
> +{
> +	struct buffer *out = buf;
> +
> +	/* Token name must match. */
> +	if (parse_default(ctx, token, str, len, NULL, 0) < 0)
> +		return -1;
> +	/* Nothing else to do if there is no buffer. */
> +	if (!out)
> +		return len;
> +	if (!out->command) {
> +		if (ctx->curr != DUMP)
> +			return -1;
> +		if (sizeof(*out) > size)
> +			return -1;
> +		out->command = ctx->curr;
> +		ctx->objdata = 0;
> +		ctx->object = out;
> +		ctx->objmask = NULL;
> +	}
> +	return len;
> +}
> +
>  /** Parse tokens for query command. */
>  static int
>  parse_query(struct context *ctx, const struct token *token,
> @@ -5409,6 +5468,35 @@ parse_hex(struct context *ctx, const struct token
> *token,
> 
>  }
> 
> +/**
> + * Parse a zero-ended string.
> + */
> +static int
> +parse_string0(struct context *ctx, const struct token *token __rte_unused,
> +	     const char *str, unsigned int len,
> +	     void *buf, unsigned int size)
> +{
> +	const struct arg *arg_data = pop_args(ctx);
> +
> +	/* Arguments are expected. */
> +	if (!arg_data)
> +		return -1;
> +	size = arg_data->size;
> +	/* Bit-mask fill is not supported. */
> +	if (arg_data->mask || size < len + 1)
> +		goto error;
> +	if (!ctx->object)
> +		return len;
> +	buf = (uint8_t *)ctx->object + arg_data->offset;
> +	strncpy(buf, str, len);
> +	if (ctx->objmask)
> +		memset((uint8_t *)ctx->objmask + arg_data->offset, 0xff,
> len);
> +	return len;
> +error:
> +	push_args(ctx, arg_data);
> +	return -1;
> +}
> +
>  /**
>   * Parse a MAC address.
>   *
> @@ -6068,6 +6156,9 @@ cmd_flow_parsed(const struct buffer *in)
>  	case FLUSH:
>  		port_flow_flush(in->port);
>  		break;
> +	case DUMP:
> +		port_flow_dump(in->port, in->args.dump.file);
> +		break;
>  	case QUERY:
>  		port_flow_query(in->port, in->args.query.rule,
>  				&in->args.query.action);
> diff --git a/app/test-pmd/config.c b/app/test-pmd/config.c
> index 9da1ffb034..1b4bdf7bf3 100644
> --- a/app/test-pmd/config.c
> +++ b/app/test-pmd/config.c
> @@ -1441,6 +1441,33 @@ port_flow_flush(portid_t port_id)
>  	return ret;
>  }
> 
> +/** Dump all flow rules. */
> +int
> +port_flow_dump(portid_t port_id, const char *file_name)
> +{
> +	int ret = 0;
> +	FILE *file = stdout;
> +	struct rte_flow_error error;
> +
> +	if (file_name && strlen(file_name)) {
> +		file = fopen(file_name, "w");
> +		if (!file) {
> +			printf("Failed to create file %s: %s\n", file_name,
> +			       strerror(errno));
> +			return -errno;
> +		}
> +	}
> +	ret = rte_flow_dev_dump(port_id, file, &error);
> +	if (ret) {
> +		port_flow_complain(&error);
> +		printf("Failed to dump flow: %s\n", strerror(-ret));
> +	} else
> +		printf("Flow dump finished\n");
> +	if (file_name && strlen(file_name))
> +		fclose(file);
> +	return ret;
> +}
> +
>  /** Query a flow rule. */
>  int
>  port_flow_query(portid_t port_id, uint32_t rule,
> diff --git a/app/test-pmd/testpmd.h b/app/test-pmd/testpmd.h
> index 857a11f8de..e1b9aba360 100644
> --- a/app/test-pmd/testpmd.h
> +++ b/app/test-pmd/testpmd.h
> @@ -734,6 +734,7 @@ int port_flow_create(portid_t port_id,
>  		     const struct rte_flow_action *actions);
>  int port_flow_destroy(portid_t port_id, uint32_t n, const uint32_t *rule);
>  int port_flow_flush(portid_t port_id);
> +int port_flow_dump(portid_t port_id, const char *file_name);
>  int port_flow_query(portid_t port_id, uint32_t rule,
>  		    const struct rte_flow_action *action);
>  void port_flow_list(portid_t port_id, uint32_t n, const uint32_t *group);
> --
> 2.24.1