Add new commands to enable testing of port mirror functionality.
Signed-off-by: Stephen Hemminger <step...@networkplumber.org>
---
app/test-pmd/cmdline.c | 13 ++
app/test-pmd/cmdline_mirror.c | 194 ++++++++++++++++++++
app/test-pmd/cmdline_mirror.h | 13 ++
app/test-pmd/meson.build | 1 +
doc/guides/testpmd_app_ug/testpmd_funcs.rst | 15 ++
5 files changed, 236 insertions(+)
create mode 100644 app/test-pmd/cmdline_mirror.c
create mode 100644 app/test-pmd/cmdline_mirror.h
diff --git a/app/test-pmd/cmdline.c b/app/test-pmd/cmdline.c
index 7b4e27eddf..1d94e29ea7 100644
--- a/app/test-pmd/cmdline.c
+++ b/app/test-pmd/cmdline.c
@@ -66,6 +66,7 @@
#include "testpmd.h"
#include "cmdline_cman.h"
#include "cmdline_mtr.h"
+#include "cmdline_mirror.h"
#include "cmdline_tm.h"
#include "bpf_cmd.h"
@@ -212,6 +213,9 @@ static void cmd_help_long_parsed(void *parsed_result,
"show port meter stats (port_id) (meter_id) (clear)\n"
" Get meter stats on a port\n\n"
+ "show port mirror stats (port_id) (target_id)\n"
+ " Get port mirror stats.\n\n"
+
"show fwd stats all\n"
" Display statistics for all fwd engines.\n\n"
@@ -661,6 +665,12 @@ static void cmd_help_long_parsed(void *parsed_result,
"set port meter stats mask (port_id) (mtr_id)
(stats_mask)\n"
" meter update stats\n\n"
+ "create port mirror (port_id) (target_id)\n"
+ " create mirror from port_id to target_id\n\n"
+
+ "delete port mirror (port_id) (target_id)\n"
+ " delete mirror from port_id to target_id\n\n"
+
"set port (port_id) fec_mode auto|off|rs|baser\n"
" set fec mode for a specific port\n\n"
@@ -14011,6 +14021,9 @@ static cmdline_parse_ctx_t builtin_ctx[] = {
&cmd_get_port_meter_in_proto_prio,
&cmd_set_port_meter_stats_mask,
&cmd_show_port_meter_stats,
+ &cmd_create_port_mirror,
+ &cmd_delete_port_mirror,
+ &cmd_show_port_mirror_stats,
&cmd_mcast_addr,
&cmd_mcast_addr_flush,
&cmd_set_vf_vlan_anti_spoof,
diff --git a/app/test-pmd/cmdline_mirror.c b/app/test-pmd/cmdline_mirror.c
new file mode 100644
index 0000000000..3b20094c7e
--- /dev/null
+++ b/app/test-pmd/cmdline_mirror.c
@@ -0,0 +1,194 @@
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2025 Stephen Hemminger <step...@networkplumber.org>
+ */
+
+#include <stdlib.h>
+
+#include <cmdline_parse.h>
+#include <cmdline_parse_num.h>
+#include <cmdline_parse_string.h>
+
+#include <rte_ethdev.h>
+
+#include "testpmd.h"
+#include "cmdline_mirror.h"
+
+/* *** Create MIRROR port Object *** */
+struct cmd_create_port_mirror_result {
+ cmdline_fixed_string_t create;
+ cmdline_fixed_string_t port;
+ cmdline_fixed_string_t mirror;
+ uint16_t port_id;
+ uint16_t target_id;
+};
+
+static cmdline_parse_token_string_t cmd_create_port_mirror_create =
+ TOKEN_STRING_INITIALIZER(struct cmd_create_port_mirror_result, create,
"create");
+static cmdline_parse_token_string_t cmd_create_port_mirror_port =
+ TOKEN_STRING_INITIALIZER(struct cmd_create_port_mirror_result, port,
"port");
+static cmdline_parse_token_string_t cmd_create_port_mirror_mirror =
+ TOKEN_STRING_INITIALIZER(struct cmd_create_port_mirror_result, mirror,
"mirror");
+static cmdline_parse_token_num_t cmd_create_port_mirror_port_id =
+ TOKEN_NUM_INITIALIZER(struct cmd_create_port_mirror_result, port_id,
RTE_UINT16);
+static cmdline_parse_token_num_t cmd_create_port_mirror_target_id =
+ TOKEN_NUM_INITIALIZER(struct cmd_create_port_mirror_result, target_id,
RTE_UINT16);
+
+static void cmd_create_port_mirror_parsed(void *parsed_result,
+ __rte_unused struct cmdline *cl,
+ __rte_unused void *data)
+{
+ const struct cmd_create_port_mirror_result *res = parsed_result;
+ /* TODO these should be set by command */
+ struct rte_eth_mirror_conf mirror_conf = {
+ .direction = RTE_ETH_MIRROR_DIRECTION_INGRESS |
RTE_ETH_MIRROR_DIRECTION_EGRESS
+ };
+ int ret;
+
+ if (port_id_is_invalid(res->port_id, ENABLED_WARN))
+ return;
+
+ if (port_id_is_invalid(res->target_id, ENABLED_WARN))
+ return;
+
+ mirror_conf.target = res->target_id;
+
+ ret = rte_eth_add_mirror(res->port_id, &mirror_conf);
+ if (ret != 0)
+ fprintf(stderr, "%s\n", rte_strerror(-ret));
+}
+
+cmdline_parse_inst_t cmd_create_port_mirror = {
+ .f = cmd_create_port_mirror_parsed,
+ .data = NULL,
+ .help_str = "create port mirror <port_id> <target_id>",
+ .tokens = {
+ (void *)&cmd_create_port_mirror_create,
+ (void *)&cmd_create_port_mirror_port,
+ (void *)&cmd_create_port_mirror_mirror,
+ (void *)&cmd_create_port_mirror_port_id,
+ (void *)&cmd_create_port_mirror_target_id,
+ NULL
+ },
+};
+
+/* *** Delete Port Mirror Object *** */
+struct cmd_delete_port_mirror_result {
+ cmdline_fixed_string_t delete;
+ cmdline_fixed_string_t port;
+ cmdline_fixed_string_t mirror;
+ uint16_t port_id;
+ uint16_t target_id;
+};
+
+static void cmd_delete_port_mirror_parsed(void *parsed_result,
+ __rte_unused struct cmdline *cl,
+ __rte_unused void *data)
+{
+ const struct cmd_delete_port_mirror_result *res = parsed_result;
+ int ret;
+
+ if (port_id_is_invalid(res->port_id, ENABLED_WARN))
+ return;
+
+ ret = rte_eth_remove_mirror(res->port_id, res->target_id);
+ if (ret != 0)
+ fprintf(stderr, "%s\n", rte_strerror(-ret));
+}
+
+static cmdline_parse_token_string_t cmd_delete_port_mirror_delete =
+ TOKEN_STRING_INITIALIZER(struct cmd_delete_port_mirror_result, delete,
"delete");
+static cmdline_parse_token_string_t cmd_delete_port_mirror_port =
+ TOKEN_STRING_INITIALIZER(struct cmd_delete_port_mirror_result, port,
"port");
+static cmdline_parse_token_string_t cmd_delete_port_mirror_mirror =
+ TOKEN_STRING_INITIALIZER(struct cmd_delete_port_mirror_result, mirror,
"mirror");
+static cmdline_parse_token_num_t cmd_delete_port_mirror_port_id =
+ TOKEN_NUM_INITIALIZER(struct cmd_delete_port_mirror_result, port_id,
RTE_UINT16);
+static cmdline_parse_token_num_t cmd_delete_port_mirror_target_id =
+ TOKEN_NUM_INITIALIZER(struct cmd_delete_port_mirror_result, target_id,
RTE_UINT16);
+
+cmdline_parse_inst_t cmd_delete_port_mirror = {
+ .f = cmd_delete_port_mirror_parsed,
+ .data = NULL,
+ .help_str = "delete port mirror <port_id> <target_id>",
+ .tokens = {
+ (void *)&cmd_delete_port_mirror_delete,
+ (void *)&cmd_delete_port_mirror_port,
+ (void *)&cmd_delete_port_mirror_mirror,
+ (void *)&cmd_delete_port_mirror_port_id,
+ (void *)&cmd_delete_port_mirror_target_id,
+ NULL
+ },
+};
+
+/* *** Show Port Mirror Stats *** */
+struct cmd_show_port_mirror_stats_result {
+ cmdline_fixed_string_t show;
+ cmdline_fixed_string_t port;
+ cmdline_fixed_string_t mirror;
+ cmdline_fixed_string_t stats;
+ uint16_t port_id;
+ uint32_t target_id;
+};
+
+static cmdline_parse_token_string_t cmd_show_port_mirror_stats_show =
+ TOKEN_STRING_INITIALIZER(
+ struct cmd_show_port_mirror_stats_result, show, "show");
+static cmdline_parse_token_string_t cmd_show_port_mirror_stats_port =
+ TOKEN_STRING_INITIALIZER(
+ struct cmd_show_port_mirror_stats_result, port, "port");
+static cmdline_parse_token_string_t cmd_show_port_mirror_stats_mirror =
+ TOKEN_STRING_INITIALIZER(
+ struct cmd_show_port_mirror_stats_result, mirror, "mirror");
+static cmdline_parse_token_string_t cmd_show_port_mirror_stats_stats =
+ TOKEN_STRING_INITIALIZER(
+ struct cmd_show_port_mirror_stats_result, stats, "stats");
+static cmdline_parse_token_num_t cmd_show_port_mirror_stats_port_id =
+ TOKEN_NUM_INITIALIZER(
+ struct cmd_show_port_mirror_stats_result, port_id, RTE_UINT16);
+static cmdline_parse_token_num_t cmd_show_port_mirror_stats_target_id =
+ TOKEN_NUM_INITIALIZER(
+ struct cmd_show_port_mirror_stats_result, target_id,
RTE_UINT32);
+
+static void cmd_show_port_mirror_stats_parsed(void *parsed_result,
+ __rte_unused struct cmdline *cl,
+ __rte_unused void *data)
+{
+ struct cmd_show_port_mirror_stats_result *res = parsed_result;
+ struct rte_eth_mirror_stats stats;
+ uint32_t target_id = res->target_id;
+ uint16_t port_id = res->port_id;
+ int ret;
+
+ if (port_id_is_invalid(port_id, ENABLED_WARN))
+ return;
+
+ if (port_id_is_invalid(target_id, ENABLED_WARN))
+ return;
+
+ ret = rte_eth_mirror_stats_get(port_id, target_id, &stats);
+ if (ret != 0) {
+ fprintf(stderr,
+ "%s: Error failed to get stats for mirror from %u to
%u: %d\n",
+ __func__, port_id, target_id, ret);
+ return;
+ }
+
+ printf("Packets: %" PRIu64 "\n", stats.packets);
+ printf("No mbuf: %" PRIu64 "\n", stats.nombuf);
+ printf("Tx Full: %" PRIu64 "\n", stats.full);
+}
+
+cmdline_parse_inst_t cmd_show_port_mirror_stats = {
+ .f = cmd_show_port_mirror_stats_parsed,
+ .data = NULL,
+ .help_str = "show port mirror stats <port_id> <target_id>",
+ .tokens = {
+ (void *)&cmd_show_port_mirror_stats_show,
+ (void *)&cmd_show_port_mirror_stats_port,
+ (void *)&cmd_show_port_mirror_stats_mirror,
+ (void *)&cmd_show_port_mirror_stats_stats,
+ (void *)&cmd_show_port_mirror_stats_port_id,
+ (void *)&cmd_show_port_mirror_stats_target_id,
+ NULL
+ },
+};
diff --git a/app/test-pmd/cmdline_mirror.h b/app/test-pmd/cmdline_mirror.h
new file mode 100644
index 0000000000..b7143a9c3f
--- /dev/null
+++ b/app/test-pmd/cmdline_mirror.h
@@ -0,0 +1,13 @@
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2025 Stephen Hemminger <step...@networkplumber.org>
+ */
+
+#ifndef _CMDLINE_MIRROR_H_
+#define _CMDLINE_MIRROR_H_
+
+/* Port MIRROR commands */
+extern cmdline_parse_inst_t cmd_create_port_mirror;
+extern cmdline_parse_inst_t cmd_delete_port_mirror;
+extern cmdline_parse_inst_t cmd_show_port_mirror_stats;
+
+#endif /* _CMDLINE_MIRROR_H_ */
diff --git a/app/test-pmd/meson.build b/app/test-pmd/meson.build
index 000548c261..e67665028f 100644
--- a/app/test-pmd/meson.build
+++ b/app/test-pmd/meson.build
@@ -8,6 +8,7 @@ sources = files(
'cmdline.c',
'cmdline_cman.c',
'cmdline_flow.c',
+ 'cmdline_mirror.c',
'cmdline_mtr.c',
'cmdline_tm.c',
'cmd_flex_item.c',
diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index 6ad83ae50d..603468a70d 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -2570,6 +2570,21 @@ where:
* ``clear``: Flag that indicates whether the statistics counters should
be cleared (i.e. set to zero) immediately after they have been read or not.
+create mirror
+-------------
+
+Create a new MIRROR port for an ethernet device::
+
+ testpmd> create port mirror (port_id) destination (port_id)
+
+delete mirror
+-------------
+
+Delete an existing MIRROR port on ethernet device::
+
+ testpmd> delete port mirror (port_id)
+
+
Traffic Management
------------------
--
2.47.2
