Merge pull request #1945 from scottlamb/mac-bind-to-device

support `--bind-dev` on macOS

Author: bmah888

configure

@@ -17228,6 +17228,49 @@ printf "%s\n" "#define HAVE_SO_BINDTODEVICE 1" >>confdefs.h
 
 fi
 
+# Check for IP_BOUND_IF sockopt (believed to be macOS only)
+{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking IP_BOUND_IF socket option" >&5
+printf %s "checking IP_BOUND_IF socket option... " >&6; }
+if test ${iperf3_cv_header_ip_bound_if+y}
+then :
+  printf %s "(cached) " >&6
+else case e in #(
+  e) cat confdefs.h - <<_ACEOF >conftest.$ac_ext
+/* end confdefs.h.  */
+#include <netinet/in.h>
+int
+main (void)
+{
+int foo = IP_BOUND_IF;
+  ;
+  return 0;
+}
+_ACEOF
+if ac_fn_c_try_compile "$LINENO"
+then :
+  iperf3_cv_header_ip_bound_if=yes
+else case e in #(
+  e) iperf3_cv_header_ip_bound_if=no ;;
+esac
+fi
+rm -f core conftest.err conftest.$ac_objext conftest.beam conftest.$ac_ext ;;
+esac
+fi
+{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: $iperf3_cv_header_ip_bound_if" >&5
+printf "%s\n" "$iperf3_cv_header_ip_bound_if" >&6; }
+if test "x$iperf3_cv_header_ip_bound_if" = "xyes"; then
+
+printf "%s\n" "#define HAVE_IP_BOUND_IF 1" >>confdefs.h
+
+fi
+
+if test "x$iperf3_cv_header_so_bindtodevice" = "xyes" -o "x$iperf3_cv_header_ip_bound_if" = "xyes"; then
+
+printf "%s\n" "#define CAN_BIND_TO_DEVICE 1" >>confdefs.h
+
+fi
+
+
 # Check for IP_MTU_DISCOVER (mostly on Linux)
 { printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking IP_MTU_DISCOVER socket option" >&5
 printf %s "checking IP_MTU_DISCOVER socket option... " >&6; }

configure.ac

@@ -289,6 +289,23 @@ if test "x$iperf3_cv_header_so_bindtodevice" = "xyes"; then
     AC_DEFINE([HAVE_SO_BINDTODEVICE], [1], [Have SO_BINDTODEVICE sockopt.])
 fi
 
+# Check for IP_BOUND_IF sockopt (believed to be macOS only)
+AC_CACHE_CHECK([IP_BOUND_IF socket option],
+[iperf3_cv_header_ip_bound_if],
+AC_COMPILE_IFELSE(
+  [AC_LANG_PROGRAM([[#include <netinet/in.h>]],
+                   [[int foo = IP_BOUND_IF;]])],
+  iperf3_cv_header_ip_bound_if=yes,
+  iperf3_cv_header_ip_bound_if=no))
+if test "x$iperf3_cv_header_ip_bound_if" = "xyes"; then
+    AC_DEFINE([HAVE_IP_BOUND_IF], [1], [Have IP_BOUND_IF sockopt.])
+fi
+
+if test "x$iperf3_cv_header_so_bindtodevice" = "xyes" -o "x$iperf3_cv_header_ip_bound_if" = "xyes"; then
+    AC_DEFINE([CAN_BIND_TO_DEVICE], [1], [Can bind to device via SO_BINDTODEVICE or IP_BOUND_IF.])
+fi
+
+
 # Check for IP_MTU_DISCOVER (mostly on Linux)
 AC_CACHE_CHECK([IP_MTU_DISCOVER socket option],
 [iperf3_cv_header_ip_mtu_discover],

docs/invoking.rst

@@ -167,9 +167,9 @@ the executable.
                  order to set the link-local scope.
    
           --bind-dev dev
-                 Bind  to  the  specified  network  interface.   This option uses
-                 SO_BINDTODEVICE, and may require root  permissions.   (Available
-                 on Linux and possibly other systems.)
+                 Bind to the  specified  network  interface.   This  option  uses
+                 SO_BINDTODEVICE or IP_BOUND_IF,  and  may require root permissions.
+                 (Available on Linux and possibly other systems.)
    
           -V, --verbose
                  Produce more detailed output.

src/iperf3.1

@@ -156,7 +156,7 @@ scope.
 .TP
 .BR --bind-dev " \fIdev\fR"
 Bind to the specified network interface.
-This option uses SO_BINDTODEVICE, and may require root permissions.
+This option uses SO_BINDTODEVICE or IP_BOUND_IF, and may require root permissions.
 (Available on Linux and possibly other systems.)
 .TP
 .BR -V ", " --verbose " "

src/iperf_api.c

@@ -60,6 +60,10 @@
 #include <sys/cpuset.h>
 #endif /* HAVE_CPUSET_SETAFFINITY */
 
+#if defined(HAVE_IP_BOUND_IF)
+#include <netinet/in.h>
+#endif
+
 #if defined(__CYGWIN__) || defined(_WIN32) || defined(_WIN64) || defined(__WINDOWS__)
 #define CPU_SETSIZE __CPU_SETSIZE
 #endif /* __CYGWIN__, _WIN32, _WIN64, __WINDOWS__ */
@@ -1125,9 +1129,9 @@ iperf_parse_arguments(struct iperf_test *test, int argc, char **argv)
         {"bidir", no_argument, NULL, OPT_BIDIRECTIONAL},
         {"window", required_argument, NULL, 'w'},
         {"bind", required_argument, NULL, 'B'},
-#if defined(HAVE_SO_BINDTODEVICE)
+#if defined(CAN_BIND_TO_DEVICE)
         {"bind-dev", required_argument, NULL, OPT_BIND_DEV},
-#endif /* HAVE_SO_BINDTODEVICE */
+#endif /* CAN_BIND_TO_DEVICE */
         {"cport", required_argument, NULL, OPT_CLIENT_PORT},
         {"set-mss", required_argument, NULL, 'M'},
         {"no-delay", no_argument, NULL, 'N'},
@@ -1301,16 +1305,16 @@ iperf_parse_arguments(struct iperf_test *test, int argc, char **argv)
 
                 char *arg = strdup(optarg);
                 if (iperf_parse_hostname(test, arg, &p, &p1)) {
-#if defined(HAVE_SO_BINDTODEVICE)
+#if defined(CAN_BIND_TO_DEVICE)
                     /* Get rid of the hostname we saved earlier. */
                     free(iperf_get_test_server_hostname(test));
                     iperf_set_test_server_hostname(test, p);
                     iperf_set_test_bind_dev(test, p1);
-#else /* HAVE_SO_BINDTODEVICE */
+#else /* CAN_BIND_TO_DEVICE */
                     free(arg);
                     i_errno = IEBINDDEVNOSUPPORT;
                     return -1;
-#endif /* HAVE_SO_BINDTODEVICE */
+#endif /* CAN_BIND_TO_DEVICE */
                 }
                 free(arg);
                 break;
@@ -1452,25 +1456,25 @@ iperf_parse_arguments(struct iperf_test *test, int argc, char **argv)
 
                 char *arg = strdup(optarg);
                 if (iperf_parse_hostname(test, arg, &p, &p1)) {
-#if defined(HAVE_SO_BINDTODEVICE)
+#if defined(CAN_BIND_TO_DEVICE)
                     /* Get rid of the hostname we saved earlier. */
                     free(iperf_get_test_bind_address(test));
                     iperf_set_test_bind_address(test, p);
                     iperf_set_test_bind_dev(test, p1);
-#else /* HAVE_SO_BINDTODEVICE */
+#else /* CAN_BIND_TO_DEVICE */
                     free(arg);
                     i_errno = IEBINDDEVNOSUPPORT;
                     return -1;
-#endif /* HAVE_SO_BINDTODEVICE */
+#endif /* CAN_BIND_TO_DEVICE */
                 }
                 free(arg);
                 break;
             }
-#if defined (HAVE_SO_BINDTODEVICE)
+#if defined(CAN_BIND_TO_DEVICE)
             case OPT_BIND_DEV:
                 iperf_set_test_bind_dev(test, optarg);
                 break;
-#endif /* HAVE_SO_BINDTODEVICE */
+#endif /* CAN_BIND_TO_DEVICE */
             case OPT_CLIENT_PORT:
 		portno = atoi(optarg);
 		if (portno < 1 || portno > 65535) {

src/iperf_config.h.in

@@ -1,5 +1,8 @@
 /* src/iperf_config.h.in.  Generated from configure.ac by autoheader.  */
 
+/* Can bind to device via SO_BINDTODEVICE or IP_BOUND_IF. */
+#undef CAN_BIND_TO_DEVICE
+
 /* Define to 1 if you have the 'clock_gettime' function. */
 #undef HAVE_CLOCK_GETTIME
 
@@ -36,6 +39,9 @@
 /* Have MPTCP protocol. */
 #undef HAVE_IPPROTO_MPTCP
 
+/* Have IP_BOUND_IF sockopt. */
+#undef HAVE_IP_BOUND_IF
+
 /* Have IP_DONTFRAG sockopt. */
 #undef HAVE_IP_DONTFRAG
 

src/iperf_locale.c

@@ -108,13 +108,13 @@ const char usage_longstr[] = "Usage: iperf3 [-s|-c host] [options]\n"
                            "  -A, --affinity n[,m]      set CPU affinity core number to n (the core the process will use)\n"
                           "                             (optional Client only m - the Server's core number for this test)\n"
 #endif /* HAVE_CPU_AFFINITY */
-#if defined(HAVE_SO_BINDTODEVICE)
+#if defined(CAN_BIND_TO_DEVICE)
                            "  -B, --bind <host>[%%<dev>] bind to the interface associated with the address <host>\n"
                            "                            (optional <dev> equivalent to `--bind-dev <dev>`)\n"
                            "  --bind-dev <dev>          bind to the network interface with SO_BINDTODEVICE\n"
-#else /* HAVE_SO_BINDTODEVICE */
+#else /* CAN_BIND_TO_DEVICE */
                            "  -B, --bind      <host>    bind to the interface associated with the address <host>\n"
-#endif /* HAVE_SO_BINDTODEVICE */
+#endif /* CAN_BIND_TO_DEVICE */
                            "  -V, --verbose             more detailed output\n"
                            "  -J, --json                output in JSON format\n"
                            "  --json-stream             output in line-delimited JSON format\n"

src/iperf_sctp.c

@@ -209,11 +209,7 @@ iperf_sctp_listen(struct iperf_test *test)
     }
 
     if (test->bind_dev) {
-#if defined(SO_BINDTODEVICE)
-        if (setsockopt(s, SOL_SOCKET, SO_BINDTODEVICE,
-                       test->bind_dev, IFNAMSIZ) < 0)
-#endif // SO_BINDTODEVICE
-        {
+        if (bind_to_device(s, res->ai_family, test->bind_dev) < 0) {
             saved_errno = errno;
             close(s);
             freeaddrinfo(res);
@@ -348,11 +344,7 @@ iperf_sctp_connect(struct iperf_test *test)
     }
 
     if (test->bind_dev) {
-#if defined(SO_BINDTODEVICE)
-        if (setsockopt(s, SOL_SOCKET, SO_BINDTODEVICE,
-                       test->bind_dev, IFNAMSIZ) < 0)
-#endif // SO_BINDTODEVICE
-        {
+        if (bind_to_device(s, server_res->ai_family, test->bind_dev) < 0) {
             saved_errno = errno;
             close(s);
             freeaddrinfo(local_res);

src/iperf_util.c

@@ -317,15 +317,15 @@ get_optional_features(void)
     numfeatures++;
 #endif /* HAVE_SSL */
 
-#if defined(HAVE_SO_BINDTODEVICE)
+#if defined(CAN_BIND_TO_DEVICE)
     if (numfeatures > 0) {
 	strncat(features, ", ",
 		sizeof(features) - strlen(features) - 1);
     }
     strncat(features, "bind to device",
 	sizeof(features) - strlen(features) - 1);
     numfeatures++;
-#endif /* HAVE_SO_BINDTODEVICE */
+#endif /* CAN_BIND_TO_DEVICE */
 
 #if defined(HAVE_DONT_FRAGMENT)
     if (numfeatures > 0) {

src/net.c

@@ -59,6 +59,10 @@
 #endif
 #endif /* HAVE_SENDFILE */
 
+#ifdef HAVE_IP_BOUND_IF
+#include <netinet/in.h>
+#endif /* HAVE_IP_BOUND_IF */
+
 #ifdef HAVE_POLL_H
 #include <poll.h>
 #endif /* HAVE_POLL_H */
@@ -125,6 +129,35 @@ timeout_connect(int s, const struct sockaddr *name, socklen_t namelen,
  * Copyright: http://swtch.com/libtask/COPYRIGHT
 */
 
+int
+bind_to_device(int s, int domain, const char *bind_dev)
+{
+#if defined(HAVE_SO_BINDTODEVICE)
+    return setsockopt(s, SOL_SOCKET, SO_BINDTODEVICE, bind_dev, IFNAMSIZ);
+#elif defined(HAVE_IP_BOUND_IF)
+    int opt;
+    switch (domain) {
+        case IPPROTO_IP:
+            opt = IP_BOUND_IF;
+            break;
+        case IPPROTO_IPV6:
+            opt = IPV6_BOUND_IF;
+            break;
+        default:
+            errno = ENOTSUP;
+            return -1;
+    }
+    int index = if_nametoindex(bind_dev);
+    if (index == 0) {
+        return -1;
+    }
+    return setsockopt(s, domain, opt, &index, sizeof(index));
+#else
+    errno = ENOTSUP;
+    return -1;
+#endif
+}
+
 /* create a socket */
 int
 create_socket(int domain, int type, int proto, const char *local, const char *bind_dev, int local_port, const char *server, int port, struct addrinfo **server_res_out)
@@ -160,11 +193,7 @@ create_socket(int domain, int type, int proto, const char *local, const char *bi
     }
 
     if (bind_dev) {
-#if defined(HAVE_SO_BINDTODEVICE)
-        if (setsockopt(s, SOL_SOCKET, SO_BINDTODEVICE,
-                       bind_dev, IFNAMSIZ) < 0)
-#endif // HAVE_SO_BINDTODEVICE
-        {
+        if (bind_to_device(s, domain, bind_dev) < 0) {
             saved_errno = errno;
             close(s);
             freeaddrinfo(local_res);