net: zperf: multicast support on multi interfaces

Zperf upload multicast always use default interface.
Zperf download multicast cannot receive packets from other than
224.0.0.1 which is default multicast group.

Add zperf upload/download option -I <interface name> for multicast.
So that user can select interface for multicast.
Add join multicast group for zperf download.

Use the "device list" command to get the interface name as
follows:
 "- ua (READY)"  #uAP interface name
 "- ml (READY)"  #STA interface name

Multicast traffic commands:
zperf udp upload -a -I ua 224.0.0.2 5001 10 1470 1M
zperf udp download -I ua 5001 224.0.0.3

Signed-off-by: Fengming Ye <[email protected]>

Author: fengming-ye

include/zephyr/net/zperf.h

@@ -18,6 +18,7 @@
 #define ZEPHYR_INCLUDE_NET_ZPERF_H_
 
 #include <zephyr/net/net_ip.h>
+#include <zephyr/net/socket.h>
 
 #ifdef __cplusplus
 extern "C" {
@@ -34,6 +35,7 @@ struct zperf_upload_params {
 	uint32_t duration_ms;
 	uint32_t rate_kbps;
 	uint16_t packet_size;
+	char if_name[IFNAMSIZ];
 	struct {
 		uint8_t tos;
 		int tcp_nodelay;
@@ -44,6 +46,7 @@ struct zperf_upload_params {
 struct zperf_download_params {
 	uint16_t port;
 	struct sockaddr addr;
+	char if_name[IFNAMSIZ];
 };
 
 struct zperf_results {

subsys/net/lib/zperf/zperf_shell.c

@@ -368,6 +368,53 @@ static void udp_session_cb(enum zperf_status status,
 	}
 }
 
+/*
+ * parse download options with '-'
+ * return < 0 if parse error
+ * return 0 if no '-' options
+ * return > 0 num of argc we parsed
+ * and following parse starts from this num
+ */
+static int shell_cmd_download(const struct shell *sh, size_t argc,
+			      char *argv[],
+			      struct zperf_download_params *param)
+{
+	int opt_cnt = 0;
+	size_t i;
+
+	for (i = 1; i < argc; ++i) {
+		if (*argv[i] != '-') {
+			break;
+		}
+
+		switch (argv[i][1]) {
+		case 'I':
+			/*
+			 * IFNAMSIZ by default CONFIG_NET_INTERFACE_NAME_LEN
+			 * is at least 1 so no overflow risk here
+			 */
+			i++;
+			if (i >= argc) {
+				shell_fprintf(sh, SHELL_WARNING,
+					      "-I <interface name>\n");
+				return -ENOEXEC;
+			}
+			(void)memset(param->if_name, 0x0, IFNAMSIZ);
+			strncpy(param->if_name, argv[i], IFNAMSIZ - 1);
+
+			opt_cnt += 2;
+			break;
+
+		default:
+			shell_fprintf(sh, SHELL_WARNING,
+				      "Unrecognized argument: %s\n", argv[i]);
+			return -ENOEXEC;
+		}
+	}
+
+	return opt_cnt;
+}
+
 static int cmd_udp_download_stop(const struct shell *sh, size_t argc,
 				 char *argv[])
 {
@@ -390,8 +437,16 @@ static int cmd_udp_download(const struct shell *sh, size_t argc,
 	if (IS_ENABLED(CONFIG_NET_UDP)) {
 		struct zperf_download_params param = { 0 };
 		int ret;
+		int start;
+
+		start = shell_cmd_download(sh, argc, argv, &param);
+		if (start < 0) {
+			shell_fprintf(sh, SHELL_WARNING,
+				      "Unable to parse option.\n");
+			return -ENOEXEC;
+		}
 
-		ret = zperf_bind_host(sh, argc, argv, &param);
+		ret = zperf_bind_host(sh, argc - start, &argv[start], &param);
 		if (ret < 0) {
 			shell_fprintf(sh, SHELL_WARNING,
 				      "Unable to bind host.\n");
@@ -801,6 +856,19 @@ static int shell_cmd_upload(const struct shell *sh, size_t argc,
 			break;
 #endif /* CONFIG_NET_CONTEXT_PRIORITY */
 
+		case 'I':
+			i++;
+			if (i >= argc) {
+				shell_fprintf(sh, SHELL_WARNING,
+					      "-I <interface name>\n");
+				return -ENOEXEC;
+			}
+			(void)memset(param.if_name, 0x0, IFNAMSIZ);
+			strncpy(param.if_name, argv[i], IFNAMSIZ - 1);
+
+			opt_cnt += 2;
+			break;
+
 		default:
 			shell_fprintf(sh, SHELL_WARNING,
 				      "Unrecognized argument: %s\n", argv[i]);
@@ -987,6 +1055,19 @@ static int shell_cmd_upload2(const struct shell *sh, size_t argc,
 			break;
 #endif /* CONFIG_NET_CONTEXT_PRIORITY */
 
+		case 'I':
+			i++;
+			if (i >= argc) {
+				shell_fprintf(sh, SHELL_WARNING,
+					      "-I <interface name>\n");
+				return -ENOEXEC;
+			}
+			(void)memset(param.if_name, 0x0, IFNAMSIZ);
+			strncpy(param.if_name, argv[i], IFNAMSIZ - 1);
+
+			opt_cnt += 2;
+			break;
+
 		default:
 			shell_fprintf(sh, SHELL_WARNING,
 				      "Unrecognized argument: %s\n", argv[i]);
@@ -1177,8 +1258,16 @@ static int cmd_tcp_download(const struct shell *sh, size_t argc,
 	if (IS_ENABLED(CONFIG_NET_TCP)) {
 		struct zperf_download_params param = { 0 };
 		int ret;
+		int start;
+
+		start = shell_cmd_download(sh, argc, argv, &param);
+		if (start < 0) {
+			shell_fprintf(sh, SHELL_WARNING,
+				      "Unable to parse option.\n");
+			return -ENOEXEC;
+		}
 
-		ret = zperf_bind_host(sh, argc, argv, &param);
+		ret = zperf_bind_host(sh, argc - start, &argv[start], &param);
 		if (ret < 0) {
 			shell_fprintf(sh, SHELL_WARNING,
 				      "Unable to bind host.\n");
@@ -1345,6 +1434,7 @@ SHELL_STATIC_SUBCMD_SET_CREATE(zperf_cmd_udp,
 #ifdef CONFIG_NET_CONTEXT_PRIORITY
 		  "-p: Specify custom packet priority\n"
 #endif /* CONFIG_NET_CONTEXT_PRIORITY */
+		  "-I: Specify host interface name\n"
 		  "Example: udp upload 192.0.2.2 1111 1 1K 1M\n"
 		  "Example: udp upload 2001:db8::2\n",
 		  cmd_udp_upload),
@@ -1362,6 +1452,7 @@ SHELL_STATIC_SUBCMD_SET_CREATE(zperf_cmd_udp,
 #ifdef CONFIG_NET_CONTEXT_PRIORITY
 		  "-p: Specify custom packet priority\n"
 #endif /* CONFIG_NET_CONTEXT_PRIORITY */
+		  "-I: Specify host interface name\n"
 		  "Example: udp upload2 v4 1 1K 1M\n"
 		  "Example: udp upload2 v6\n"
 #if defined(CONFIG_NET_IPV6) && defined(MY_IP6ADDR_SET)
@@ -1375,8 +1466,11 @@ SHELL_STATIC_SUBCMD_SET_CREATE(zperf_cmd_udp,
 		  ,
 		  cmd_udp_upload2),
 	SHELL_CMD(download, &zperf_cmd_udp_download,
+		  "[<options>] command options (optional): [-I eth0]\n"
 		  "[<port>]:  Server port to listen on/connect to\n"
 		  "[<host>]:  Bind to <host>, an interface address\n"
+		  "Available options:\n"
+		  "-I <interface name>: Specify host interface name\n"
 		  "Example: udp download 5001 192.168.0.1\n",
 		  cmd_udp_download),
 	SHELL_SUBCMD_SET_END

subsys/net/lib/zperf/zperf_udp_receiver.c

@@ -23,6 +23,10 @@ LOG_MODULE_DECLARE(net_zperf, CONFIG_NET_ZPERF_LOG_LEVEL);
 #define NET_LOG_ENABLED 1
 #include "net_private.h"
 
+/* To support multicast */
+#include "ipv6.h"
+#include "zephyr/net/igmp.h"
+
 static struct sockaddr_in6 *in6_addr_my;
 static struct sockaddr_in *in4_addr_my;
 
@@ -45,6 +49,7 @@ static void udp_svc_handler(struct k_work *work);
 
 NET_SOCKET_SERVICE_SYNC_DEFINE_STATIC(svc_udp, NULL, udp_svc_handler,
 				      SOCK_ID_MAX);
+static char udp_server_iface_name[IFNAMSIZ];
 
 static inline void build_reply(struct zperf_udp_datagram *hdr,
 			       struct zperf_server_hdr *stat,
@@ -225,6 +230,63 @@ static void udp_received(int sock, const struct sockaddr *addr, uint8_t *data,
 	}
 }
 
+static void zperf_udp_join_mcast_ipv4(char *if_name, struct in_addr *addr)
+{
+	struct net_if *iface = NULL;
+
+	if (if_name[0]) {
+		iface = net_if_get_by_index(net_if_get_by_name(if_name));
+		if (iface == NULL)
+			iface = net_if_get_default();
+	} else {
+		iface = net_if_get_default();
+	}
+
+	if (iface != NULL) {
+		net_ipv4_igmp_join(iface, addr, NULL);
+	}
+}
+
+static void zperf_udp_join_mcast_ipv6(char *if_name, struct in6_addr *addr)
+{
+	struct net_if *iface = NULL;
+
+	if (if_name[0]) {
+		iface = net_if_get_by_index(net_if_get_by_name(if_name));
+		if (iface == NULL)
+			iface = net_if_get_default();
+	} else {
+		iface = net_if_get_default();
+	}
+
+	if (iface != NULL) {
+		net_ipv6_mld_join(iface, addr);
+	}
+}
+
+static void zperf_udp_leave_mcast(int sock)
+{
+	struct net_if *iface = NULL;
+	struct sockaddr addr = {0};
+	socklen_t addr_len = NET_IPV6_ADDR_SIZE;
+
+	zsock_getsockname(sock, &addr, &addr_len);
+
+	if (IS_ENABLED(CONFIG_NET_IPV4) && addr.sa_family == AF_INET) {
+		struct sockaddr_in *addr4 = (struct sockaddr_in *)&addr;
+
+		if (net_ipv4_is_addr_mcast(&addr4->sin_addr))
+			net_ipv4_igmp_leave(iface, &addr4->sin_addr);
+	}
+
+	if (IS_ENABLED(CONFIG_NET_IPV6) && addr.sa_family == AF_INET6) {
+		struct sockaddr_in6 *addr6 = (struct sockaddr_in6 *)&addr;
+
+		if (net_ipv6_is_addr_mcast(&addr6->sin6_addr))
+			net_ipv6_mld_leave(iface, &addr6->sin6_addr);
+	}
+}
+
 static void udp_receiver_cleanup(void)
 {
 	int i;
@@ -233,6 +295,7 @@ static void udp_receiver_cleanup(void)
 
 	for (i = 0; i < ARRAY_SIZE(fds); i++) {
 		if (fds[i].fd >= 0) {
+			zperf_udp_leave_mcast(fds[i].fd);
 			zsock_close(fds[i].fd);
 			fds[i].fd = -1;
 		}
@@ -350,6 +413,11 @@ static int zperf_udp_receiver_init(void)
 			in4_addr_my->sin_addr.s_addr = INADDR_ANY;
 		}
 
+		if (net_ipv4_is_addr_mcast(&in4_addr_my->sin_addr)) {
+			zperf_udp_join_mcast_ipv4(udp_server_iface_name,
+						  &in4_addr_my->sin_addr);
+		}
+
 		NET_INFO("Binding to %s",
 			 net_sprint_ipv4_addr(&in4_addr_my->sin_addr));
 
@@ -402,6 +470,11 @@ static int zperf_udp_receiver_init(void)
 			       sizeof(struct in6_addr));
 		}
 
+		if (net_ipv6_is_addr_mcast(&in6_addr_my->sin6_addr)) {
+			zperf_udp_join_mcast_ipv6(udp_server_iface_name,
+						  &in6_addr_my->sin6_addr);
+		}
+
 		NET_INFO("Binding to %s",
 			 net_sprint_ipv6_addr(&in6_addr_my->sin6_addr));
 
@@ -451,6 +524,18 @@ int zperf_udp_download(const struct zperf_download_params *param,
 	udp_server_port = param->port;
 	memcpy(&udp_server_addr, &param->addr, sizeof(struct sockaddr));
 
+	if (param->if_name[0]) {
+		/*
+		 * IFNAMSIZ by default CONFIG_NET_INTERFACE_NAME_LEN
+		 * is at least 1 so no overflow risk here
+		 */
+		(void)memset(udp_server_iface_name, 0, IFNAMSIZ);
+		strncpy(udp_server_iface_name, param->if_name, IFNAMSIZ);
+		udp_server_iface_name[IFNAMSIZ - 1] = 0;
+	} else {
+		udp_server_iface_name[0] = 0;
+	}
+
 	ret = zperf_udp_receiver_init();
 	if (ret < 0) {
 		udp_receiver_cleanup();

subsys/net/lib/zperf/zperf_udp_uploader.c

@@ -288,6 +288,7 @@ int zperf_udp_upload(const struct zperf_upload_params *param,
 	int port = 0;
 	int sock;
 	int ret;
+	struct ifreq req;
 
 	if (param == NULL || result == NULL) {
 		return -EINVAL;
@@ -309,6 +310,17 @@ int zperf_udp_upload(const struct zperf_upload_params *param,
 		return sock;
 	}
 
+	if (param->if_name[0]) {
+		(void)memset(req.ifr_name, 0, sizeof(req.ifr_name));
+		strncpy(req.ifr_name, param->if_name, IFNAMSIZ);
+		req.ifr_name[IFNAMSIZ - 1] = 0;
+
+		if (zsock_setsockopt(sock, SOL_SOCKET, SO_BINDTODEVICE, &req,
+				     sizeof(struct ifreq)) != 0) {
+			NET_WARN("setsockopt SO_BINDTODEVICE error (%d)", -errno);
+		}
+	}
+
 	ret = udp_upload(sock, port, param, result);
 
 	zsock_close(sock);