ethdev: add API to dump device internal flow info

Introduce an API which dump the device's internal representation information of rte flows in hardware.

Signed-off-by Xiaoyu Min <[email protected]>

---
 lib/librte_ethdev/rte_ethdev_version.map |  3 +++
 lib/librte_ethdev/rte_flow.c             | 16 ++++++++++++++++
 lib/librte_ethdev/rte_flow.h             | 21 +++++++++++++++++++++
 lib/librte_ethdev/rte_flow_driver.h      |  5 +++++
 4 files changed, 45 insertions(+)

lib/librte_ethdev/rte_ethdev_version.map +3 -0

index a7dacf2cf2..3f32fdecf7 100644
@@ -227,4 +227,7 @@ EXPERIMENTAL {
        rte_flow_dynf_metadata_mask;
        rte_flow_dynf_metadata_register;
        rte_eth_dev_set_ptypes;
+
+       # added in 20.02
+       rte_flow_dev_dump;
 };

lib/librte_ethdev/rte_flow.c +16 -0

index 87a3e8c4c6..751ce721b2 100644
@@ -1212,3 +1212,19 @@ rte_flow_expand_rss(struct rte_flow_expand_rss *buf, size_t size,
        }
        return lsize;
 }
+
+int
+rte_flow_dev_dump(uint16_t port_id, FILE *file, struct rte_flow_error *error)
+{
+       struct rte_eth_dev *dev = &rte_eth_devices[port_id];
+       const struct rte_flow_ops *ops = rte_flow_ops_get(port_id, error);
+
+       if (unlikely(!ops))
+               return -rte_errno;
+       if (likely(!!ops->dev_dump))
+               return flow_err(port_id, ops->dev_dump(dev, file, error),
+                               error);
+       return rte_flow_error_set(error, ENOSYS,
+                                 RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
+                                 NULL, rte_strerror(ENOSYS));
+}

lib/librte_ethdev/rte_flow.h +21 -0

index 58b50265d2..cf7cf61ae8 100644
@@ -2790,6 +2790,27 @@ enum rte_flow_conv_op {
        RTE_FLOW_CONV_OP_ACTION_NAME_PTR,
 };
 
+/**
+ * @warning
+ * @b EXPERIMENTAL: this API may change without prior notice.
+ *
+ * Dump hardware internal representation information of
+ * rte flow to file.
+ *
+ * @param[in] port_id
+ *    The port identifier of the Ethernet device.
+ * @param[in] file
+ *   A pointer to a file for output.
+ * @param[out] error
+ *   Perform verbose error reporting if not NULL. PMDs initialize this
+ *   structure in case of error only.
+ * @return
+ *   0 on success, a nagative value otherwise.
+ */
+__rte_experimental
+int
+rte_flow_dev_dump(uint16_t port_id, FILE *file, struct rte_flow_error *error);
+
 /**
  * Check if mbuf dynamic field for metadata is registered.
  *

lib/librte_ethdev/rte_flow_driver.h +5 -1

index a0359853e6..51a9a57a0f 100644
@@ -96,6 +96,11 @@ struct rte_flow_ops {
                (struct rte_eth_dev *,
                 int,
                 struct rte_flow_error *);
+       /** See rte_flow_dev_dump(). */
+       int (*dev_dump)
+               (struct rte_eth_dev *dev,
+                FILE *file,
+                struct rte_flow_error *error);
 };
 
 /**
--

2.24.1

-----Original Message-----
<[email protected]>; dpdk-dev <[email protected]>
Subject: Re: [PATCH 1/5] ethdev: add API to dump device internal flow info

Quoted 5 lines · Xiaoyu Min

Introduce an API which dump the device's internal representation information of rte flows in hardware.

Signed-off-by Xiaoyu Min <[email protected]>

Looks good to me.

Review

Quoted 9 lines

---
 lib/librte_ethdev/rte_ethdev_version.map |  3 +++
 lib/librte_ethdev/rte_flow.c             | 16 ++++++++++++++++
 lib/librte_ethdev/rte_flow.h             | 21 +++++++++++++++++++++
 lib/librte_ethdev/rte_flow_driver.h      |  5 +++++
 4 files changed, 45 insertions(+)

(quoted diff) +0 -0

b/lib/librte_ethdev/rte_ethdev_version.map

lib/librte_ethdev/rte_flow.c rte_flow_expand_rss(struct

Quoted 16 lines

index a7dacf2cf2..3f32fdecf7 100644

lib/librte_ethdev/rte_ethdev_version.map +3 -0

@@ -227,4 +227,7 @@ EXPERIMENTAL {
        rte_flow_dynf_metadata_mask;
        rte_flow_dynf_metadata_register;
        rte_eth_dev_set_ptypes;
+
+       # added in 20.02
+       rte_flow_dev_dump;
 };

lib/librte_ethdev/rte_flow.c +0 -0

index 87a3e8c4c6..751ce721b2 100644
@@ -1212,3 +1212,19 @@ rte_flow_expand_rss(struct

rte_flow_expand_rss *buf, size_t size,

lib/librte_ethdev/rte_flow.c rte_flow_expand_rss(struct rte_flow_expand_rss *buf, size_t size,

Quoted 6 lines

lib/librte_ethdev/rte_flow.c +3 -0

        }
        return lsize;
 }
+
+int
+rte_flow_dev_dump(uint16_t port_id, FILE *file, struct rte_flow_error

*error)

Quoted 31 lines

lib/librte_ethdev/rte_flow.c +13 -0

+{
+       struct rte_eth_dev *dev = &rte_eth_devices[port_id];
+       const struct rte_flow_ops *ops = rte_flow_ops_get(port_id, error);
+
+       if (unlikely(!ops))
+               return -rte_errno;
+       if (likely(!!ops->dev_dump))
+               return flow_err(port_id, ops->dev_dump(dev, file, error),
+                               error);
+       return rte_flow_error_set(error, ENOSYS,
+                                 RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
+                                 NULL, rte_strerror(ENOSYS));
+}

lib/librte_ethdev/rte_flow.h +10 -0

index 58b50265d2..cf7cf61ae8 100644
@@ -2790,6 +2790,27 @@ enum rte_flow_conv_op {
        RTE_FLOW_CONV_OP_ACTION_NAME_PTR,
 };
 
+/**
+ * @warning
+ * @b EXPERIMENTAL: this API may change without prior notice.
+ *
+ * Dump hardware internal representation information of
+ * rte flow to file.
+ *
+ * @param[in] port_id
+ *    The port identifier of the Ethernet device.
+ * @param[in] file

lib/librte_ethdev/rte_flow.h enum rte_flow_conv_op { · line 2812

Quoted 10 lines

lib/librte_ethdev/rte_flow.h +10 -0

+ *   A pointer to a file for output.
+ * @param[out] error
+ *   Perform verbose error reporting if not NULL. PMDs initialize this
+ *   structure in case of error only.
+ * @return
+ *   0 on success, a nagative value otherwise.
+ */
+__rte_experimental
+int
+rte_flow_dev_dump(uint16_t port_id, FILE *file, struct rte_flow_error

*error);

Review

Quoted 5 lines

lib/librte_ethdev/rte_flow.h +1 -0

+
 /**
  * Check if mbuf dynamic field for metadata is registered.
  *

(quoted diff) +0 -0

b/lib/librte_ethdev/rte_flow_driver.h

Quoted 18 lines

index a0359853e6..51a9a57a0f 100644

lib/librte_ethdev/rte_flow_driver.h +5 -1

@@ -96,6 +96,11 @@ struct rte_flow_ops {
                (struct rte_eth_dev *,
                 int,
                 struct rte_flow_error *);
+       /** See rte_flow_dev_dump(). */
+       int (*dev_dump)
+               (struct rte_eth_dev *dev,
+                FILE *file,
+                struct rte_flow_error *error);
 };
 
 /**
--

2.24.1

Introduce an API which dump the device's internal representation information of rte flows in hardware.

Signed-off-by Xiaoyu Min <[email protected]>

lib/librte_ethdev/rte_flow.c +6 -0

@@ -1212,3 +1212,19 @@ rte_flow_expand_rss(struct rte_flow_expand_rss *buf, size_t size,
 	}
 	return lsize;
 }
+
+int
+rte_flow_dev_dump(uint16_t port_id, FILE *file, struct rte_flow_error *error)
+{
+	struct rte_eth_dev *dev = &rte_eth_devices[port_id];
+	const struct rte_flow_ops *ops = rte_flow_ops_get(port_id, error);

Quoted 4 lines · Xiaoyu Min

Introduce an API which dump the device's internal representation information of rte flows in hardware.

Signed-off-by Xiaoyu Min <[email protected]>

<...>

Quoted 14 lines

lib/librte_ethdev/rte_flow.c +10 -0

@@ -1212,3 +1212,19 @@ rte_flow_expand_rss(struct rte_flow_expand_rss *buf, size_t size,
 	}
 	return lsize;
 }
+
+int
+rte_flow_dev_dump(uint16_t port_id, FILE *file, struct rte_flow_error *error)
+{
+	struct rte_eth_dev *dev = &rte_eth_devices[port_id];
+	const struct rte_flow_ops *ops = rte_flow_ops_get(port_id, error);
+
+	if (unlikely(!ops))
+		return -rte_errno;
+	if (likely(!!ops->dev_dump))

lib/librte_ethdev/rte_flow.c rte_flow_expand_rss(struct rte_flow_expand_rss *buf, size_t size, · line 1230

Quoted 6 lines

lib/librte_ethdev/rte_flow.c +6 -0

+		return flow_err(port_id, ops->dev_dump(dev, file, error),
+				error);
+	return rte_flow_error_set(error, ENOSYS,
+				  RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
+				  NULL, rte_strerror(ENOSYS));
+}  

Should API validate user provided input "FILE *file" ?

Quoted 22 lines · On Thu, 16 Jan 2020 20:37:36 +0000 Ferruh Yigit <[email protected]> wrote:

Quoted 4 lines · Xiaoyu Min

Introduce an API which dump the device's internal representation information of rte flows in hardware.

Signed-off-by Xiaoyu Min <[email protected]>

<...>

Quoted 14 lines

lib/librte_ethdev/rte_flow.c +10 -0

@@ -1212,3 +1212,19 @@ rte_flow_expand_rss(struct rte_flow_expand_rss *buf, size_t size,
 	}
 	return lsize;
 }
+
+int
+rte_flow_dev_dump(uint16_t port_id, FILE *file, struct rte_flow_error *error)
+{
+	struct rte_eth_dev *dev = &rte_eth_devices[port_id];
+	const struct rte_flow_ops *ops = rte_flow_ops_get(port_id, error);
+
+	if (unlikely(!ops))
+		return -rte_errno;
+	if (likely(!!ops->dev_dump))

Quoted 8 lines

lib/librte_ethdev/rte_flow.c rte_flow_expand_rss(struct rte_flow_expand_rss *buf, size_t size, · line 1230

Quoted 6 lines

lib/librte_ethdev/rte_flow.c +6 -0

+		return flow_err(port_id, ops->dev_dump(dev, file, error),
+				error);
+	return rte_flow_error_set(error, ENOSYS,
+				  RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
+				  NULL, rte_strerror(ENOSYS));
+}  

Should API validate user provided input "FILE *file" ?

None of the other DPDK dump routines do.

-----Original Message-----
Subject: [PATCH 3/5] app/testpmd: new flow dump CLI

From: Xueming Li <[email protected]>

New flow dump CLI to dump device internal representation information of flows into screen.

Signed-off-by Xueming Li <[email protected]>

Signed-off-by Xiaoyu Min <[email protected]>

---

 app/test-pmd/cmdline_flow.c | 91
+++++++++++++++++++++++++++++++++++++
 app/test-pmd/config.c       | 27 +++++++++++
 app/test-pmd/testpmd.h      |  1 +
 3 files changed, 119 insertions(+)

app/test-pmd/cmdline_flow.c +14 -0

index 99dade7d8c..19336e5d42 100644
@@ -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,

app/test-pmd/cmdline_flow.c +3 -0

 		       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,

app/test-pmd/cmdline_flow.c +42 -0

 			  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,

app/test-pmd/cmdline_flow.c +29 -0

@@ -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.
*

app/test-pmd/cmdline_flow.c +3 -0

@@ -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);

app/test-pmd/config.c +27 -0

index 9da1ffb034..1b4bdf7bf3 100644
@@ -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,

app/test-pmd/testpmd.h +1 -1

index 857a11f8de..e1b9aba360 100644
@@ -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

-----Original Message-----
From: Xiaoyu Min <[email protected]>
Sent: Thursday, January 16, 2020 12:14
To: [email protected]; Ori Kam <[email protected]>; Slava Ovsiienko <[email protected]>; Matan Azrad <[email protected]>; Raslan Darawsheh <[email protected]>; Shahaf Shuler <[email protected]>; Anatoly Burakov <[email protected]>
Cc: [email protected]; Xueming(Steven) Li <[email protected]>
Subject: [PATCH 4/5] net/mlx5: add socket server for external tools

From: Xueming Li <[email protected]>

Add pmd unix socket server to enable external tool applications to trigger flow dump.

Socket path:

	/var/tmp/dpdk_mlx5_<pid>

Socket format:
io_raw: port_id of uint16
file: file descriptor of int

Signed-off-by Xueming Li <[email protected]>

Signed-off-by Xiaoyu Min <[email protected]>

---
 drivers/net/mlx5/Makefile      |   1 +
 drivers/net/mlx5/meson.build   |   1 +
 drivers/net/mlx5/mlx5.c        |   2 +
 drivers/net/mlx5/mlx5.h        |   5 +
 drivers/net/mlx5/mlx5_socket.c | 227 +++++++++++++++++++++++++++++++++
 5 files changed, 236 insertions(+)
 create mode 100644 drivers/net/mlx5/mlx5_socket.c

drivers/net/mlx5/Makefile index renamed from drivers/net/mlx5/Makefile +0 -0

6e5921b292..397e29dcbb 100644

drivers/net/mlx5/Makefile +1 -0

@@ -39,6 +39,7 @@ SRCS-$(CONFIG_RTE_LIBRTE_MLX5_PMD) += mlx5_mp.c
 SRCS-$(CONFIG_RTE_LIBRTE_MLX5_PMD) += mlx5_nl.c
 SRCS-$(CONFIG_RTE_LIBRTE_MLX5_PMD) += mlx5_devx_cmds.c
 SRCS-$(CONFIG_RTE_LIBRTE_MLX5_PMD) += mlx5_utils.c
+SRCS-$(CONFIG_RTE_LIBRTE_MLX5_PMD) += mlx5_socket.c
 
 ifeq ($(CONFIG_RTE_IBVERBS_LINK_DLOPEN),y)
 INSTALL-$(CONFIG_RTE_LIBRTE_MLX5_PMD)-lib += $(LIB_GLUE) diff --git

a/drivers/net/mlx5/meson.build b/drivers/net/mlx5/meson.build index d7ef032afb..cb2fb90495 100644

drivers/net/mlx5/meson.build +1 -0

@@ -61,6 +61,7 @@ if build
 		'mlx5_vlan.c',
 		'mlx5_devx_cmds.c',
 		'mlx5_utils.c',
+		'mlx5_socket.c',
 	)
 	if (dpdk_conf.has('RTE_ARCH_X86_64')
 		or dpdk_conf.has('RTE_ARCH_ARM64')

drivers/net/mlx5/mlx5.c index renamed from drivers/net/mlx5/mlx5.c +0 -0

50960c91ce..ffee39c1a0 100644

drivers/net/mlx5/mlx5.c +2 -0

@@ -2954,6 +2954,8 @@ mlx5_pci_probe(struct rte_pci_driver *pci_drv
 __rte_unused,
 	struct mlx5_dev_config dev_config;
 	int ret;
 
+	if (rte_eal_process_type() == RTE_PROC_PRIMARY)
+		mlx5_pmd_socket_init();
 	ret = mlx5_init_once();
 	if (ret) {

DRV_LOG(ERR, "unable to init PMD global data: %s", diff --git
a/drivers/net/mlx5/mlx5.h b/drivers/net/mlx5/mlx5.h index 047181b32e..ceb6de821e 100644

drivers/net/mlx5/mlx5.h +5 -0

@@ -990,6 +990,11 @@ void mlx5_mp_uninit_primary(void);  int
 mlx5_mp_init_secondary(void);  void mlx5_mp_uninit_secondary(void);
 
+/* mlx5_socket.c */
+
+int mlx5_pmd_socket_init(void);
+void mlx5_pmd_socket_uninit(void);
+
 /* mlx5_nl.c */
 
 int mlx5_nl_init(int protocol);

drivers/net/mlx5/mlx5_socket.c new file +27 -0

new file mode 100644 index 0000000000..e4c93c4312
@@ -0,0 +1,227 @@
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright 2019 Mellanox Technologies, Ltd  */
+
+#ifndef _GNU_SOURCE
+#define _GNU_SOURCE
+#endif
+
+#include <sys/types.h>
+#include <sys/socket.h>
+#include <sys/un.h>
+#include <fcntl.h>
+#include <stdio.h>
+#include <unistd.h>
+#include <sys/stat.h>
+
+#include "rte_eal.h"
+#include "mlx5_utils.h"
+#include "mlx5.h"
+
+/* PMD socket service for tools. */
+
+int server_socket; /* Unix socket for primary process. */ struct
+rte_intr_handle server_intr_handle; /* Interrupt handler. */
+
+static void
+mlx5_pmd_make_path(struct sockaddr_un *addr, int pid) {
+	snprintf(addr->sun_path, sizeof(addr->sun_path),

"/var/tmp/dpdk_%s_%d",

drivers/net/mlx5/mlx5_socket.c new file +49 -0

+		 MLX5_DRIVER_NAME, pid);
+}
+
+/**
+ * Handle server pmd socket interrupts.
+ */
+static void
+mlx5_pmd_socket_handle(void *cb __rte_unused) {
+	int conn_sock;
+	int ret = -1;
+	struct cmsghdr *cmsg = NULL;
+	int data;
+	char buf[CMSG_SPACE(sizeof(int))] = { 0 };
+	struct iovec io = {
+		.iov_base = &data,
+		.iov_len = sizeof(data),
+	};
+	struct msghdr msg = {
+		.msg_iov = &io,
+		.msg_iovlen = 1,
+		.msg_control = buf,
+		.msg_controllen = sizeof(buf),
+	};
+	uint16_t port_id;
+	int fd;
+	FILE *file = NULL;
+	struct rte_eth_dev *dev;
+
+	/* Accept the connection from the client. */
+	conn_sock = accept(server_socket, NULL, NULL);
+	if (conn_sock < 0) {
+		DRV_LOG(WARNING, "connection failed: %s", strerror(errno));
+		return;
+	}
+	ret = recvmsg(conn_sock, &msg, MSG_WAITALL);
+	if (ret < 0) {
+		DRV_LOG(WARNING, "wrong message received: %s",
+			strerror(errno));
+		goto error;
+	}
+	/* Receive file descriptor. */
+	cmsg = CMSG_FIRSTHDR(&msg);
+	if (cmsg == NULL || cmsg->cmsg_type != SCM_RIGHTS ||
+	    cmsg->cmsg_len < sizeof(int)) {
+		DRV_LOG(WARNING, "invalid file descriptor message");
+		goto error;
+	}
+	memcpy(&fd, CMSG_DATA(cmsg), sizeof(fd));
+	file = fdopen(fd, "w");

drivers/net/mlx5/mlx5_socket.c new file +110 -0

+	/* Dump flow. */
+	dev = &rte_eth_devices[port_id];
+	ret = mlx5_flow_dev_dump(dev, file, NULL);
+	/* Set-up the ancillary data and reply. */
+	msg.msg_controllen = 0;
+	msg.msg_control = NULL;
+	msg.msg_iovlen = 1;
+	msg.msg_iov = &io;
+	data = -ret;
+	io.iov_len = sizeof(data);
+	io.iov_base = &data;
+	do {
+		ret = sendmsg(conn_sock, &msg, 0);
+	} while (ret < 0 && errno == EINTR);
+	if (ret < 0)
+		DRV_LOG(WARNING, "failed to send response %s",
+			strerror(errno));
+error:
+	if (conn_sock > 0)
+		close(conn_sock);
+	if (file)
+		fclose(file);
+}
+
+/**
+ * Install interrupt handler.
+ *
+ * @param dev
+ *   Pointer to Ethernet device.
+ * @return
+ *   0 on success, a negative errno value otherwise.
+ */
+static int
+mlx5_pmd_interrupt_handler_install(void)
+{
+	assert(server_socket);
+	server_intr_handle.fd = server_socket;
+	server_intr_handle.type = RTE_INTR_HANDLE_EXT;
+	return rte_intr_callback_register(&server_intr_handle,
+					  mlx5_pmd_socket_handle, NULL);
+}
+
+/**
+ * Uninstall interrupt handler.
+ */
+static void
+mlx5_pmd_interrupt_handler_uninstall(void)
+{
+	if (server_socket) {
+		mlx5_intr_callback_unregister(&server_intr_handle,
+					      mlx5_pmd_socket_handle,
+					      NULL);
+	}
+	server_intr_handle.fd = 0;
+	server_intr_handle.type = RTE_INTR_HANDLE_UNKNOWN; }
+
+/**
+ * Initialise the socket to communicate with the secondary process
+ *
+ * @param[in] dev
+ *   Pointer to Ethernet device.
+ *
+ * @return
+ *   0 on success, a negative value otherwise.
+ */
+int
+mlx5_pmd_socket_init(void)
+{
+	struct sockaddr_un sun = {
+		.sun_family = AF_UNIX,
+	};
+	int ret = -1;
+	int flags;
+
+	assert(rte_eal_process_type() == RTE_PROC_PRIMARY);
+	if (server_socket)
+		return 0;
+	/*
+	 * Initialize the socket to communicate with the secondary
+	 * process.
+	 */
+	ret = socket(AF_UNIX, SOCK_STREAM, 0);
+	if (ret < 0) {
+		DRV_LOG(WARNING, "Failed to open mlx5 socket: %s",
+			strerror(errno));
+		goto error;
+	}
+	server_socket = ret;
+	flags = fcntl(server_socket, F_GETFL, 0);
+	if (flags == -1)
+		goto error;
+	ret = fcntl(server_socket, F_SETFL, flags | O_NONBLOCK);
+	if (ret < 0)
+		goto error;
+	mlx5_pmd_make_path(&sun, getpid());
+	remove(sun.sun_path);
+	ret = bind(server_socket, (const struct sockaddr *)&sun, sizeof(sun));
+	if (ret < 0) {
+		DRV_LOG(WARNING,
+			"cannot bind mlx5 socket: %s", strerror(errno));
+		goto close;
+	}
+	ret = listen(server_socket, 0);
+	if (ret < 0) {
+		DRV_LOG(WARNING, "cannot listen on mlx5 socket: %s",
+			strerror(errno));
+		goto close;
+	}
+	if (mlx5_pmd_interrupt_handler_install()) {
+		DRV_LOG(WARNING, "cannot register interrupt handler for

mlx5 socket: %s",

drivers/net/mlx5/mlx5_socket.c new file +23 -0

+			strerror(errno));
+		goto close;
+	}
+	return 0;
+close:
+	remove(sun.sun_path);
+error:
+	claim_zero(close(server_socket));
+	server_socket = 0;
+	DRV_LOG(ERR, "Cannot initialize socket: %s", strerror(errno));
+	return -errno;
+}
+
+/**
+ * Un-Initialize the pmd socket
+ */
+void __attribute__((destructor))
+mlx5_pmd_socket_uninit(void)
+{
+	if (!server_socket)
+		return;
+	mlx5_pmd_interrupt_handler_uninstall();
+	MKSTR(path, "/var/tmp/dpdk_%s_%d", MLX5_DRIVER_NAME,

getpid());

drivers/net/mlx5/mlx5_socket.c new file +4 -1

+	claim_zero(close(server_socket));
+	server_socket = 0;
+	claim_zero(remove(path));
+}
--

2.24.1

Hi, Jack

Quoted 171 lines

-----Original Message-----
From: Xiaoyu Min <[email protected]>
Sent: Thursday, January 16, 2020 12:14
To: [email protected]; Ori Kam <[email protected]>; Slava Ovsiienko <[email protected]>; Matan Azrad <[email protected]>; Raslan Darawsheh <[email protected]>; Shahaf Shuler <[email protected]>; Anatoly Burakov <[email protected]>
Cc: [email protected]; Xueming(Steven) Li <[email protected]>
Subject: [PATCH 4/5] net/mlx5: add socket server for external tools

From: Xueming Li <[email protected]>

Add pmd unix socket server to enable external tool applications to trigger flow dump.

Socket path:

	/var/tmp/dpdk_mlx5_<pid>

Socket format:
io_raw: port_id of uint16
file: file descriptor of int

Signed-off-by Xueming Li <[email protected]>

Signed-off-by Xiaoyu Min <[email protected]>

---
 drivers/net/mlx5/Makefile      |   1 +
 drivers/net/mlx5/meson.build   |   1 +
 drivers/net/mlx5/mlx5.c        |   2 +
 drivers/net/mlx5/mlx5.h        |   5 +
 drivers/net/mlx5/mlx5_socket.c | 227 +++++++++++++++++++++++++++++++++
 5 files changed, 236 insertions(+)
 create mode 100644 drivers/net/mlx5/mlx5_socket.c

drivers/net/mlx5/Makefile index renamed from drivers/net/mlx5/Makefile +0 -0

6e5921b292..397e29dcbb 100644

drivers/net/mlx5/Makefile +1 -0

@@ -39,6 +39,7 @@ SRCS-$(CONFIG_RTE_LIBRTE_MLX5_PMD) += mlx5_mp.c
 SRCS-$(CONFIG_RTE_LIBRTE_MLX5_PMD) += mlx5_nl.c
 SRCS-$(CONFIG_RTE_LIBRTE_MLX5_PMD) += mlx5_devx_cmds.c
 SRCS-$(CONFIG_RTE_LIBRTE_MLX5_PMD) += mlx5_utils.c
+SRCS-$(CONFIG_RTE_LIBRTE_MLX5_PMD) += mlx5_socket.c
 
 ifeq ($(CONFIG_RTE_IBVERBS_LINK_DLOPEN),y)
 INSTALL-$(CONFIG_RTE_LIBRTE_MLX5_PMD)-lib += $(LIB_GLUE) diff --git

a/drivers/net/mlx5/meson.build b/drivers/net/mlx5/meson.build index d7ef032afb..cb2fb90495 100644

drivers/net/mlx5/meson.build +1 -0

@@ -61,6 +61,7 @@ if build
 		'mlx5_vlan.c',
 		'mlx5_devx_cmds.c',
 		'mlx5_utils.c',
+		'mlx5_socket.c',
 	)
 	if (dpdk_conf.has('RTE_ARCH_X86_64')
 		or dpdk_conf.has('RTE_ARCH_ARM64')

drivers/net/mlx5/mlx5.c index renamed from drivers/net/mlx5/mlx5.c +0 -0

50960c91ce..ffee39c1a0 100644

drivers/net/mlx5/mlx5.c +2 -0

@@ -2954,6 +2954,8 @@ mlx5_pci_probe(struct rte_pci_driver *pci_drv
 __rte_unused,
 	struct mlx5_dev_config dev_config;
 	int ret;
 
+	if (rte_eal_process_type() == RTE_PROC_PRIMARY)
+		mlx5_pmd_socket_init();
 	ret = mlx5_init_once();
 	if (ret) {

DRV_LOG(ERR, "unable to init PMD global data: %s", diff --git
a/drivers/net/mlx5/mlx5.h b/drivers/net/mlx5/mlx5.h index 047181b32e..ceb6de821e 100644

drivers/net/mlx5/mlx5.h +5 -0

@@ -990,6 +990,11 @@ void mlx5_mp_uninit_primary(void);  int
 mlx5_mp_init_secondary(void);  void mlx5_mp_uninit_secondary(void);
 
+/* mlx5_socket.c */
+
+int mlx5_pmd_socket_init(void);
+void mlx5_pmd_socket_uninit(void);
+
 /* mlx5_nl.c */
 
 int mlx5_nl_init(int protocol);

drivers/net/mlx5/mlx5_socket.c new file +27 -0

new file mode 100644 index 0000000000..e4c93c4312
@@ -0,0 +1,227 @@
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright 2019 Mellanox Technologies, Ltd  */
+
+#ifndef _GNU_SOURCE
+#define _GNU_SOURCE
+#endif
+
+#include <sys/types.h>
+#include <sys/socket.h>
+#include <sys/un.h>
+#include <fcntl.h>
+#include <stdio.h>
+#include <unistd.h>
+#include <sys/stat.h>
+
+#include "rte_eal.h"
+#include "mlx5_utils.h"
+#include "mlx5.h"
+
+/* PMD socket service for tools. */
+
+int server_socket; /* Unix socket for primary process. */ struct
+rte_intr_handle server_intr_handle; /* Interrupt handler. */
+
+static void
+mlx5_pmd_make_path(struct sockaddr_un *addr, int pid) {
+	snprintf(addr->sun_path, sizeof(addr->sun_path),

"/var/tmp/dpdk_%s_%d",

drivers/net/mlx5/mlx5_socket.c new file +53 -0

+		 MLX5_DRIVER_NAME, pid);
+}
+
+/**
+ * Handle server pmd socket interrupts.
+ */
+static void
+mlx5_pmd_socket_handle(void *cb __rte_unused) {
+	int conn_sock;
+	int ret = -1;
+	struct cmsghdr *cmsg = NULL;
+	int data;
+	char buf[CMSG_SPACE(sizeof(int))] = { 0 };
+	struct iovec io = {
+		.iov_base = &data,
+		.iov_len = sizeof(data),
+	};
+	struct msghdr msg = {
+		.msg_iov = &io,
+		.msg_iovlen = 1,
+		.msg_control = buf,
+		.msg_controllen = sizeof(buf),
+	};
+	uint16_t port_id;
+	int fd;
+	FILE *file = NULL;
+	struct rte_eth_dev *dev;
+
+	/* Accept the connection from the client. */
+	conn_sock = accept(server_socket, NULL, NULL);
+	if (conn_sock < 0) {
+		DRV_LOG(WARNING, "connection failed: %s", strerror(errno));
+		return;
+	}
+	ret = recvmsg(conn_sock, &msg, MSG_WAITALL);
+	if (ret < 0) {
+		DRV_LOG(WARNING, "wrong message received: %s",
+			strerror(errno));
+		goto error;
+	}
+	/* Receive file descriptor. */
+	cmsg = CMSG_FIRSTHDR(&msg);
+	if (cmsg == NULL || cmsg->cmsg_type != SCM_RIGHTS ||
+	    cmsg->cmsg_len < sizeof(int)) {
+		DRV_LOG(WARNING, "invalid file descriptor message");
+		goto error;
+	}
+	memcpy(&fd, CMSG_DATA(cmsg), sizeof(fd));
+	file = fdopen(fd, "w");
+	if (!file) {
+		DRV_LOG(WARNING, "Failed to open file");
+		goto error;
+	}

drivers/net/mlx5/mlx5_socket.c line 89

Quoted 6 lines

drivers/net/mlx5/mlx5_socket.c new file +6 -0

+	/* Receive port number. */
+	if (msg.msg_iovlen != 1 || msg.msg_iov->iov_len < sizeof(uint16_t)) {
+		DRV_LOG(WARNING, "wrong port number message");
+		goto error;
+	}
+	memcpy(&port_id, msg.msg_iov->iov_base, sizeof(port_id));

I would add the port_id check here.
The message with wrong port_id may crash the server.

Quoted 130 lines

drivers/net/mlx5/mlx5_socket.c new file +110 -0

+	/* Dump flow. */
+	dev = &rte_eth_devices[port_id];
+	ret = mlx5_flow_dev_dump(dev, file, NULL);
+	/* Set-up the ancillary data and reply. */
+	msg.msg_controllen = 0;
+	msg.msg_control = NULL;
+	msg.msg_iovlen = 1;
+	msg.msg_iov = &io;
+	data = -ret;
+	io.iov_len = sizeof(data);
+	io.iov_base = &data;
+	do {
+		ret = sendmsg(conn_sock, &msg, 0);
+	} while (ret < 0 && errno == EINTR);
+	if (ret < 0)
+		DRV_LOG(WARNING, "failed to send response %s",
+			strerror(errno));
+error:
+	if (conn_sock > 0)
+		close(conn_sock);
+	if (file)
+		fclose(file);
+}
+
+/**
+ * Install interrupt handler.
+ *
+ * @param dev
+ *   Pointer to Ethernet device.
+ * @return
+ *   0 on success, a negative errno value otherwise.
+ */
+static int
+mlx5_pmd_interrupt_handler_install(void)
+{
+	assert(server_socket);
+	server_intr_handle.fd = server_socket;
+	server_intr_handle.type = RTE_INTR_HANDLE_EXT;
+	return rte_intr_callback_register(&server_intr_handle,
+					  mlx5_pmd_socket_handle, NULL);
+}
+
+/**
+ * Uninstall interrupt handler.
+ */
+static void
+mlx5_pmd_interrupt_handler_uninstall(void)
+{
+	if (server_socket) {
+		mlx5_intr_callback_unregister(&server_intr_handle,
+					      mlx5_pmd_socket_handle,
+					      NULL);
+	}
+	server_intr_handle.fd = 0;
+	server_intr_handle.type = RTE_INTR_HANDLE_UNKNOWN; }
+
+/**
+ * Initialise the socket to communicate with the secondary process
+ *
+ * @param[in] dev
+ *   Pointer to Ethernet device.
+ *
+ * @return
+ *   0 on success, a negative value otherwise.
+ */
+int
+mlx5_pmd_socket_init(void)
+{
+	struct sockaddr_un sun = {
+		.sun_family = AF_UNIX,
+	};
+	int ret = -1;
+	int flags;
+
+	assert(rte_eal_process_type() == RTE_PROC_PRIMARY);
+	if (server_socket)
+		return 0;
+	/*
+	 * Initialize the socket to communicate with the secondary
+	 * process.
+	 */
+	ret = socket(AF_UNIX, SOCK_STREAM, 0);
+	if (ret < 0) {
+		DRV_LOG(WARNING, "Failed to open mlx5 socket: %s",
+			strerror(errno));
+		goto error;
+	}
+	server_socket = ret;
+	flags = fcntl(server_socket, F_GETFL, 0);
+	if (flags == -1)
+		goto error;
+	ret = fcntl(server_socket, F_SETFL, flags | O_NONBLOCK);
+	if (ret < 0)
+		goto error;
+	mlx5_pmd_make_path(&sun, getpid());
+	remove(sun.sun_path);
+	ret = bind(server_socket, (const struct sockaddr *)&sun, sizeof(sun));
+	if (ret < 0) {
+		DRV_LOG(WARNING,
+			"cannot bind mlx5 socket: %s", strerror(errno));
+		goto close;
+	}
+	ret = listen(server_socket, 0);
+	if (ret < 0) {
+		DRV_LOG(WARNING, "cannot listen on mlx5 socket: %s",
+			strerror(errno));
+		goto close;
+	}
+	if (mlx5_pmd_interrupt_handler_install()) {
+		DRV_LOG(WARNING, "cannot register interrupt handler for

mlx5 socket: %s",

drivers/net/mlx5/mlx5_socket.c new file +17 -0

+			strerror(errno));
+		goto close;
+	}
+	return 0;
+close:
+	remove(sun.sun_path);
+error:
+	claim_zero(close(server_socket));
+	server_socket = 0;
+	DRV_LOG(ERR, "Cannot initialize socket: %s", strerror(errno));
+	return -errno;
+}
+
+/**
+ * Un-Initialize the pmd socket
+ */
+void __attribute__((destructor))

Quoted 7 lines

drivers/net/mlx5/mlx5_socket.c new file +6 -0

+mlx5_pmd_socket_uninit(void)
+{
+	if (!server_socket)
+		return;
+	mlx5_pmd_interrupt_handler_uninstall();
+	MKSTR(path, "/var/tmp/dpdk_%s_%d", MLX5_DRIVER_NAME,

getpid());

I would move the MKSTR a couple lines below, after the close() call.

Quoted 7 lines

drivers/net/mlx5/mlx5_socket.c new file +4 -1

+	claim_zero(close(server_socket));
+	server_socket = 0;
+	claim_zero(remove(path));
+}
--

2.24.1

With best regards, Slava

Introduce an API which dump the device's internal representation information of rte flows in hardware.

Signed-off-by Xiaoyu Min <[email protected]>

Acked-by Ori Kam <[email protected]>

This serial patchs is based on RFC [1] and the comments on it.

A new rte flow API is added to dump device internal representation information for the offloaded rte flows.

This is very helpful for user and developer to debug flow offloading stuff, i.e, to check whether PMD offloads the rte flow in a correct way from HW perspective.

The output file is in vendor specific format. An external vendor provided tool may be needed in order to get human readable info.

[1]: https://patches.dpdk.org/cover/64597/

v2:
* Bump MLX5 PMD glue version to 20.02.0
* MLX5 PMD validate port id
* Code improvement per review comments

Xiaoyu Min (2):
ethdev: add API to dump device internal flow info net/mlx5: support flow dump API

Xueming Li (3):
app/testpmd: new flow dump CLI
net/mlx5: add socket server for external tools
doc: update mlx5 document for flow dump feature

Quoted 8 lines

Xiaoyu Min (2):
ethdev: add API to dump device internal flow info net/mlx5: support flow dump API

Xueming Li (3):
app/testpmd: new flow dump CLI
net/mlx5: add socket server for external tools
doc: update mlx5 document for flow dump feature

Series applied to dpdk-next-net/master, thanks.

17/01/2020 20:26, Ferruh Yigit:

Quoted 5 lines · Xiaoyu Min

Quoted 4 lines

Xiaoyu Min (2):
ethdev: add API to dump device internal flow info net/mlx5: support flow dump API

Quoted 6 lines

Quoted 4 lines

Xueming Li (3):
app/testpmd: new flow dump CLI
net/mlx5: add socket server for external tools
doc: update mlx5 document for flow dump feature

Series applied to dpdk-next-net/master, thanks.

I think we are missing an update of the testpmd doc.