Merge branch 'feat/support_ipv6_only' into 'main'

ydhub · ydhub · commit 7816f89d4b12 · 2024-05-15T16:39:51.000+08:00
feat: support ipv4-only and ipv6-only

See merge request qa/idf-components/iperf-cmd!10
diff --git a/.gitignore b/.gitignore
@@ -2,6 +2,7 @@ dist/
 build/
 build*/
 sdkconfig
+sdkconfig.old
 dependencies.lock
 managed_components/
 .mypy_cache/
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -46,9 +46,15 @@ build_iperf:
       - ESP_IMG: espressif/idf:release-v5.1
       - ESP_IMG: espressif/idf:release-v5.2
       - ESP_IMG: espressif/idf:latest
+  artifacts:
+    paths:
+      - "**/build*/build_log.txt"
+      - "**/build*/config/sdkconfig.json"
+    when: always
+    expire_in: 5 days
   script:
     - pip install idf-build-apps
-    - idf-build-apps build -p apps/iperf --target=all --manifest-file=apps/.build-rules.yml --build-dir build_@t_@w --config 'sdkconfig.ci.*='
+    - idf-build-apps build
   after_script:
     - ls apps/iperf
   tags:
@@ -63,9 +69,15 @@ build_iperf_v43:
     - when: on_success
   variables:
     LC_ALL: C.UTF-8
+  artifacts:
+    paths:
+      - "**/build*/build_log.txt"
+      - "**/build*/config/sdkconfig.json"
+    when: always
+    expire_in: 5 days
   script:
     - pip install idf-build-apps\<2 packaging\<22 idf-component-manager==1.4
-    - idf-build-apps build -p apps/iperf --target all --build-dir build_@t_@w --config 'sdkconfig.ci.*='
+    - idf-build-apps build
   after_script:
     - ls apps/iperf
   tags:
diff --git a/.idf_build_apps.toml b/.idf_build_apps.toml
@@ -0,0 +1,22 @@
+paths = [
+    "apps",
+]
+recursive = true
+target = "all"
+
+manifest_file = [
+    "apps/.build-rules.yml",
+]
+check_manifest_rules = true
+
+config = [
+    "sdkconfig.ci=default",
+    "sdkconfig.ci.*=",
+    "=default",
+]
+
+build_dir = "build_@t_@w"
+build_log = "build_log.txt"
+verbose = 1
+
+check_warnings = true
diff --git a/apps/.build-rules.yml b/apps/.build-rules.yml
@@ -1,4 +1,12 @@
 apps/iperf:
   disable:
     - if: SOC_WIFI_SUPPORTED != 1
-    - if: IDF_TARGET != "esp32" and CONFIG_NAME != "default"
+      reason: This example app is using wifi connections
+    # ipv6-only
+    - if: CONFIG_NAME == "ipv6_only" and IDF_VERSION_MAJOR < 5
+      reason: IDF do not support ipv6-only
+    - if: CONFIG_NAME == "ipv6_only" and (IDF_VERSION_MAJOR == 5 and IDF_VERSION_MINOR < 1)
+      reason: IDF do not support ipv6-only
+    # build specific configuration for only one target
+    - if: IDF_TARGET != "esp32" and CONFIG_NAME == "ipv4_only"
+    - if: IDF_TARGET != "esp32c3" and CONFIG_NAME == "ipv6_only"
diff --git a/apps/iperf/main/iperf_main.c b/apps/iperf/main/iperf_main.c
@@ -5,6 +5,13 @@
  */
 #include <errno.h>
 #include <string.h>
+#include <sys/socket.h>
+
+/* Build check: LWIP_IPV4/LWIP_IPV6 should be defined after include sys/socket.h */
+#if !(defined LWIP_IPV4) || !(defined LWIP_IPV6)
+#error "Both LWIP_IPV4 and LWIP_IPV6 should be defined!"
+#endif
+
 #include "esp_wifi.h"
 #include "esp_log.h"
 #include "esp_err.h"
diff --git a/apps/iperf/sdkconfig.ci.default b/apps/iperf/sdkconfig.ci.default
diff --git a/apps/iperf/sdkconfig.ci.ipv4_ipv6 b/apps/iperf/sdkconfig.ci.ipv4_ipv6
@@ -0,0 +1,3 @@
+CONFIG_LWIP_IPV4=y
+CONFIG_LWIP_IPV6=y
+CONFIG_LWIP_IPV6_AUTOCONFIG=y
diff --git a/apps/iperf/sdkconfig.ci.ipv4_only b/apps/iperf/sdkconfig.ci.ipv4_only
@@ -1 +1,2 @@
+CONFIG_LWIP_IPV4=y
 CONFIG_LWIP_IPV6=n
diff --git a/apps/iperf/sdkconfig.ci.ipv6_only b/apps/iperf/sdkconfig.ci.ipv6_only
@@ -0,0 +1,3 @@
+CONFIG_LWIP_IPV4=n
+CONFIG_LWIP_IPV6=y
+CONFIG_LWIP_IPV6_AUTOCONFIG=y
diff --git a/apps/iperf/sdkconfig.defaults b/apps/iperf/sdkconfig.defaults
diff --git a/iperf-cmd/README.md b/iperf-cmd/README.md
@@ -15,6 +15,7 @@ This repository contains `iperf` command based esp-idf console.
     -c, --client=<host>  run in client mode, connecting to <host>
     -s, --server  run in server mode
       -u, --udp  use UDP rather than TCP
+    -V, --ipv6_domain  Set the domain to IPv6 (send packets over IPv6)
     -p, --port=<port>  server port to listen on/connect to
     -l, --len=<length>  Set read/write buffer size
     -i, --interval=<interval>  seconds between periodic bandwidth reports
diff --git a/iperf-cmd/iperf_cmd.c b/iperf-cmd/iperf_cmd.c
@@ -6,13 +6,15 @@
 #include <stdio.h>
 #include <string.h>
 #include <inttypes.h>
+#include <sys/socket.h>
 // #include "esp_idf_version.h"
 #include "esp_log.h"
 #include "esp_console.h"
 #include "argtable3/argtable3.h"
+#include "esp_netif.h"
+
 #include "iperf.h"
 
-#include "esp_netif.h"
 
 #ifndef APP_TAG
 #define APP_TAG "IPERF"
@@ -22,7 +24,9 @@ typedef struct {
     struct arg_str *ip;
     struct arg_lit *server;
     struct arg_lit *udp;
-    // struct arg_lit *version6;
+#if IPERF_IPV6_ENABLED
+    struct arg_lit *ipv6_domain;
+#endif
     struct arg_int *port;
     struct arg_int *length;
     struct arg_int *interval;
@@ -55,8 +59,13 @@ static int cmd_do_iperf(int argc, char **argv)
     }
 
     memset(&cfg, 0, sizeof(cfg));
-    // now iperf-cmd only support IPV4 address
+
     cfg.type = IPERF_IP_TYPE_IPV4;
+#if IPERF_IPV6_ENABLED
+    if (iperf_args.ipv6_domain->count > 0) {
+        cfg.type = IPERF_IP_TYPE_IPV6;
+    }
+#endif
 
     if (((iperf_args.ip->count == 0) && (iperf_args.server->count == 0)) ||
             ((iperf_args.ip->count != 0) && (iperf_args.server->count != 0))) {
@@ -67,12 +76,20 @@ static int cmd_do_iperf(int argc, char **argv)
     if (iperf_args.ip->count == 0) {
         cfg.flag |= IPERF_FLAG_SERVER;
     } else {
-        cfg.destination_ip4 = esp_ip4addr_aton(iperf_args.ip->sval[0]);
         cfg.flag |= IPERF_FLAG_CLIENT;
+#if IPERF_IPV6_ENABLED
+        if (cfg.type == IPERF_IP_TYPE_IPV6) {
+            /* TODO: Refactor iperf config structure in v1.0 */
+            cfg.destination_ip6 = (char*)(iperf_args.ip->sval[0]);
+        }
+#endif
+#if IPERF_IPV4_ENABLED
+        if (cfg.type == IPERF_IP_TYPE_IPV4) {
+            cfg.destination_ip4 = esp_ip4addr_aton(iperf_args.ip->sval[0]);
+        }
+#endif
     }
 
-    // NOTE: Do not bind local ip now
-
     if (iperf_args.udp->count == 0) {
         cfg.flag |= IPERF_FLAG_TCP;
     } else {
@@ -137,15 +154,15 @@ static int cmd_do_iperf(int argc, char **argv)
         }
     }
 
-    ESP_LOGI(APP_TAG, "mode=%s-%s sip=%" PRId32 ".%" PRId32 ".%" PRId32 ".%" PRId32 ":%d,\
-             dip=%" PRId32 ".%" PRId32 ".%" PRId32 ".%" PRId32 ":%d,\
-             interval=%" PRId32 ", time=%" PRId32 "",
+    ESP_LOGI(APP_TAG, "mode=%s-%s sip=%s:%" PRId32 ", dip=%s:%" PRId32 ", interval=%" PRId32 ", time=%" PRId32,
              cfg.flag & IPERF_FLAG_TCP ? "tcp" : "udp",
              cfg.flag & IPERF_FLAG_SERVER ? "server" : "client",
-             cfg.source_ip4 & 0xFF, (cfg.source_ip4 >> 8) & 0xFF, (cfg.source_ip4 >> 16) & 0xFF,
-             (cfg.source_ip4 >> 24) & 0xFF, cfg.sport,
-             cfg.destination_ip4 & 0xFF, (cfg.destination_ip4 >> 8) & 0xFF,
-             (cfg.destination_ip4 >> 16) & 0xFF, (cfg.destination_ip4 >> 24) & 0xFF, cfg.dport,
+             "localhost", cfg.sport,
+#if IPERF_IPV4_ENABLED
+             cfg.type == IPERF_IP_TYPE_IPV6? cfg.destination_ip6 : inet_ntoa(cfg.destination_ip4), cfg.dport,
+#else
+             cfg.type == IPERF_IP_TYPE_IPV6? cfg.destination_ip6 : "0.0.0.0", cfg.dport,
+#endif
              cfg.interval, cfg.time);
 
     iperf_start(&cfg);
@@ -159,9 +176,14 @@ esp_err_t app_register_iperf_commands(void)
     iperf_args.ip = arg_str0("c", "client", "<host>", "run in client mode, connecting to <host>");
     iperf_args.server = arg_lit0("s", "server", "run in server mode");
     iperf_args.udp = arg_lit0("u", "udp", "use UDP rather than TCP");
-// #ifdef CONFIG_LWIP_IPV6
-//     iperf_args.version6 = arg_lit0("6", "version6", "Use IPv6 addresses");
-// #endif
+#if IPERF_IPV6_ENABLED
+    /*
+     * NOTE: iperf2 uses -V(--ipv6_domain or --IPv6Version) for ipv6
+     * iperf3 uses -6(--version6)
+     * May add a new command "iperf3" in the future
+     */
+    iperf_args.ipv6_domain = arg_lit0("V", "ipv6_domain", "Set the domain to IPv6 (send packets over IPv6)");
+#endif
     iperf_args.port = arg_int0("p", "port", "<port>", "server port to listen on/connect to");
     iperf_args.length = arg_int0("l", "len", "<length>", "Set read/write buffer size");
     iperf_args.interval = arg_int0("i", "interval", "<interval>", "seconds between periodic bandwidth reports");
diff --git a/iperf/api.md b/iperf/api.md
@@ -47,6 +47,8 @@
 | define  | [**IPERF\_FLAG\_SET**](#define-iperf_flag_set) (cfg, flag) ((cfg) |= (flag))<br> |
 | define  | [**IPERF\_FLAG\_TCP**](#define-iperf_flag_tcp)  (1 &lt;&lt; 2)<br> |
 | define  | [**IPERF\_FLAG\_UDP**](#define-iperf_flag_udp)  (1 &lt;&lt; 3)<br> |
+| define  | [**IPERF\_IPV4\_ENABLED**](#define-iperf_ipv4_enabled)  LWIP\_IPV4<br> |
+| define  | [**IPERF\_IPV6\_ENABLED**](#define-iperf_ipv6_enabled)  LWIP\_IPV6<br> |
 | define  | [**IPERF\_IP\_TYPE\_IPV4**](#define-iperf_ip_type_ipv4)  0<br> |
 | define  | [**IPERF\_IP\_TYPE\_IPV6**](#define-iperf_ip_type_ipv6)  1<br> |
 | define  | [**IPERF\_MAX\_DELAY**](#define-iperf_max_delay)  64<br> |
@@ -281,6 +283,18 @@ ESP\_OK on success
 #define IPERF_FLAG_UDP (1 << 3)
 ```
 
+### define `IPERF_IPV4_ENABLED`
+
+```c
+#define IPERF_IPV4_ENABLED LWIP_IPV4
+```
+
+### define `IPERF_IPV6_ENABLED`
+
+```c
+#define IPERF_IPV6_ENABLED LWIP_IPV6
+```
+
 ### define `IPERF_IP_TYPE_IPV4`
 
 ```c
diff --git a/iperf/include/iperf.h b/iperf/include/iperf.h
@@ -5,13 +5,30 @@
  */
 #pragma once
 
+#include <sys/socket.h>
 #include "esp_err.h"
 #include "esp_types.h"
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
+/*
+ * There's no CONFIG_LWIP_IPV4 in idf<5.1
+ * use LWIP_IPV4 from lwipopts.h (sys/socket.h)
+ * LWIP_IPV4 should always be defined (0/1).
+ */
+#ifndef LWIP_IPV4
+#error "LWIP_IPV4 should be defined from lwipopts.h (sys/socket.h)."
+#endif
+
+/*
+ * We only use lwip stack for now, but we may support different IP stack in the future.
+ */
+#define IPERF_IPV4_ENABLED LWIP_IPV4
+#define IPERF_IPV6_ENABLED LWIP_IPV6
+
+
 #define IPERF_IP_TYPE_IPV4 0
 #define IPERF_IP_TYPE_IPV6 1
 #define IPERF_TRANS_TYPE_TCP 0
diff --git a/iperf/iperf.c b/iperf/iperf.c

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+CONFIG_LWIP_IPV4=y`
	`2`	`+CONFIG_LWIP_IPV6=y`
	`3`	`+CONFIG_LWIP_IPV6_AUTOCONFIG=y`
Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
	`1`	`+CONFIG_LWIP_IPV4=y`
`1`	`2`	`CONFIG_LWIP_IPV6=n`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+CONFIG_LWIP_IPV4=n`
	`2`	`+CONFIG_LWIP_IPV6=y`
	`3`	`+CONFIG_LWIP_IPV6_AUTOCONFIG=y`