From 0e71a325de309400b68f018da7df52f1890c57ba Mon Sep 17 00:00:00 2001 From: David Cermak Date: Mon, 30 May 2022 08:56:14 +0200 Subject: [PATCH] lwip/wifi: Improve Rx throughput on the wifi defaults (sta+ap) --- components/esp_wifi/src/wifi_netif.c | 35 +-- components/lwip/linker.lf | 6 +- components/lwip/port/esp32/netif/wlanif.c | 266 +++++++++++++++------- tools/ci/check_copyright_ignore.txt | 1 - 4 files changed, 195 insertions(+), 113 deletions(-) diff --git a/components/esp_wifi/src/wifi_netif.c b/components/esp_wifi/src/wifi_netif.c index 54900b8f01..7683dfa62f 100644 --- a/components/esp_wifi/src/wifi_netif.c +++ b/components/esp_wifi/src/wifi_netif.c @@ -5,6 +5,7 @@ */ #include "esp_wifi.h" #include "esp_netif.h" +#include "esp_netif_net_stack.h" #include "esp_log.h" #include "esp_private/wifi.h" #include "esp_wifi_netif.h" @@ -24,28 +25,6 @@ typedef struct wifi_netif_driver { static const char* TAG = "wifi_netif"; -/** - * @brief Local storage for netif handles and callbacks for specific wifi interfaces - */ -static esp_netif_receive_t s_wifi_rxcbs[MAX_WIFI_IFS] = { NULL }; -static esp_netif_t *s_wifi_netifs[MAX_WIFI_IFS] = { NULL }; - -/** - * @brief WiFi netif driver IO functions, a thin glue layer - * to the original wifi interface API - */ -static esp_err_t wifi_sta_receive(void *buffer, uint16_t len, void *eb) -{ - return s_wifi_rxcbs[WIFI_IF_STA](s_wifi_netifs[WIFI_IF_STA], buffer, len, eb); -} - -#ifdef CONFIG_ESP_WIFI_SOFTAP_SUPPORT -static esp_err_t wifi_ap_receive(void *buffer, uint16_t len, void *eb) -{ - return s_wifi_rxcbs[WIFI_IF_AP](s_wifi_netifs[WIFI_IF_AP], buffer, len, eb); -} -#endif - static void wifi_free(void *h, void* buffer) { if (buffer) { @@ -88,7 +67,6 @@ void esp_wifi_destroy_if_driver(wifi_netif_driver_t h) if (h) { esp_wifi_internal_reg_rxcb(h->wifi_if, NULL); // ignore the potential error // as the wifi might have been already uninitialized - s_wifi_netifs[h->wifi_if] = NULL; } free(h); } @@ -122,6 +100,10 @@ bool esp_wifi_is_if_ready_when_started(wifi_netif_driver_t ifx) #endif } +void set_wifi_netif(int wifi_inx, void* netif); +esp_err_t wifi_rxcb_sta(void *buffer, uint16_t len, void *eb); +esp_err_t wifi_rxcb_ap(void *buffer, uint16_t len, void *eb); + esp_err_t esp_wifi_register_if_rxcb(wifi_netif_driver_t ifx, esp_netif_receive_t fn, void * arg) { if (ifx->base.netif != arg) { @@ -129,7 +111,6 @@ esp_err_t esp_wifi_register_if_rxcb(wifi_netif_driver_t ifx, esp_netif_receive_t return ESP_ERR_INVALID_ARG; } wifi_interface_t wifi_interface = ifx->wifi_if; - s_wifi_rxcbs[wifi_interface] = fn; wifi_rxcb_t rxcb = NULL; esp_err_t ret; @@ -137,12 +118,12 @@ esp_err_t esp_wifi_register_if_rxcb(wifi_netif_driver_t ifx, esp_netif_receive_t { case WIFI_IF_STA: - rxcb = wifi_sta_receive; + rxcb = wifi_rxcb_sta; break; #ifdef CONFIG_ESP_WIFI_SOFTAP_SUPPORT case WIFI_IF_AP: - rxcb = wifi_ap_receive; + rxcb = wifi_rxcb_ap; break; #endif @@ -155,10 +136,10 @@ esp_err_t esp_wifi_register_if_rxcb(wifi_netif_driver_t ifx, esp_netif_receive_t return ESP_ERR_NOT_SUPPORTED; } - s_wifi_netifs[wifi_interface] = ifx->base.netif; if ((ret = esp_wifi_internal_reg_rxcb(wifi_interface, rxcb)) != ESP_OK) { ESP_LOGE(TAG, "esp_wifi_internal_reg_rxcb for if=%d failed with %d", wifi_interface, ret); return ESP_ERR_INVALID_STATE; } + set_wifi_netif(wifi_interface, esp_netif_get_netif_impl(arg)); return ESP_OK; } diff --git a/components/lwip/linker.lf b/components/lwip/linker.lf index 74c8c76412..8263efd5b5 100644 --- a/components/lwip/linker.lf +++ b/components/lwip/linker.lf @@ -78,8 +78,10 @@ entries: sys_arch:sys_arch_mbox_fetch (noflash_text) ethernetif:ethernet_low_level_output (noflash_text) ethernetif:ethernetif_input (noflash_text) - wlanif:low_level_output (noflash_text) - wlanif:wlanif_input (noflash_text) + wlanif:sta_output (noflash_text) + wlanif:ap_output (noflash_text) + wlanif:wifi_rxcb_sta (noflash_text) + wlanif:wifi_rxcb_ap (noflash_text) lwip_default_hooks:ip4_route_src_hook (noflash_text) if ESP_ALLOW_BSS_SEG_EXTERNAL_MEMORY = y: diff --git a/components/lwip/port/esp32/netif/wlanif.c b/components/lwip/port/esp32/netif/wlanif.c index 51301fb934..6268bedc3c 100644 --- a/components/lwip/port/esp32/netif/wlanif.c +++ b/components/lwip/port/esp32/netif/wlanif.c @@ -1,51 +1,27 @@ +/* + * SPDX-FileCopyrightText: 2001-2004 Swedish Institute of Computer Science + * + * SPDX-License-Identifier: BSD-3-Clause + * + * SPDX-FileContributor: 2015-2022 Espressif Systems (Shanghai) CO LTD + */ /** * @file * Ethernet Interface Skeleton used for WiFi * */ -/* - * Copyright (c) 2001-2004 Swedish Institute of Computer Science. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without modification, - * are permitted provided that the following conditions are met: - * - * 1. Redistributions of source code must retain the above copyright notice, - * this list of conditions and the following disclaimer. - * 2. Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following disclaimer in the documentation - * and/or other materials provided with the distribution. - * 3. The name of the author may not be used to endorse or promote products - * derived from this software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED - * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF - * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT - * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, - * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT - * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING - * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY - * OF SUCH DAMAGE. - * - * This file is part of the lwIP TCP/IP stack. - * - * Author: Adam Dunkels - * - */ - #include "lwip/opt.h" #include "lwip/def.h" -#include "lwip/mem.h" +#include "lwip/memp.h" #include "lwip/pbuf.h" #include "lwip/stats.h" #include "lwip/snmp.h" #include "lwip/ethip6.h" #include "netif/etharp.h" #include "netif/wlanif.h" +#include "esp_private/wifi.h" #include #include @@ -55,6 +31,19 @@ #include "esp_compiler.h" #include "netif/esp_pbuf_ref.h" + +typedef struct wifi_custom_pbuf +{ + struct pbuf_custom p; + void* l2_buf; +} wifi_custom_pbuf_t; + +#define ESP_PBUF_POOL_SIZE 16 +LWIP_MEMPOOL_DECLARE(ESP_PBUF_POOL, ESP_PBUF_POOL_SIZE, sizeof(wifi_custom_pbuf_t), "WIFI_CUSTOM_PBUF"); + +static struct netif *s_wifi_netifs[2] = { NULL }; + + /** * In this function, the hardware should be initialized. * Called from wlanif_input(). @@ -91,59 +80,91 @@ low_level_init(struct netif *netif) } -/** - * This function should do the actual transmission of the packet. The packet is - * contained in the pbuf that is passed to the function. This pbuf - * might be chained. - * - * @param netif the lwip network interface structure for this wlanif - * @param p the MAC packet to send (e.g. IP packet including MAC addresses and type) - * @return ERR_OK if the packet could be sent - * an err_t value if the packet couldn't be sent - * - * @note Returning ERR_MEM here if a DMA queue of your MAC is full can lead to - * strange results. You might consider waiting for space in the DMA queue - * to become available since the stack doesn't retry to send a packet - * dropped because of memory failure (except for the TCP timers). - */ -static err_t -low_level_output(struct netif *netif, struct pbuf *p) +void set_wifi_netif(int wifi_inx, void* netif) { - esp_netif_t *esp_netif = esp_netif_get_handle_from_netif_impl(netif); - if (esp_netif == NULL) { - return ERR_IF; - } - - struct pbuf *q = p; - esp_err_t ret; - - if(q->next == NULL) { - ret = esp_netif_transmit_wrap(esp_netif, q->payload, q->len, q); - - } else { - LWIP_DEBUGF(PBUF_DEBUG, ("low_level_output: pbuf is a list, application may has bug")); - q = pbuf_alloc(PBUF_RAW_TX, p->tot_len, PBUF_RAM); - if (q != NULL) { - pbuf_copy(q, p); - } else { - return ERR_MEM; - } - ret = esp_netif_transmit_wrap(esp_netif, q->payload, q->len, q); - - pbuf_free(q); - } - - if (ret == ESP_OK) { - return ERR_OK; - } else if (ret == ESP_ERR_NO_MEM) { - return ERR_MEM; - } else if (ret == ESP_ERR_INVALID_ARG) { - return ERR_ARG; - } else { - return ERR_IF; + if (wifi_inx < 2) { + s_wifi_netifs[wifi_inx] = netif; } } + +static void esp_pbuf_free_l2_buff(struct pbuf *p) +{ + wifi_custom_pbuf_t* wifi_pbuf = (wifi_custom_pbuf_t*)p; + esp_wifi_internal_free_rx_buffer(wifi_pbuf->l2_buf); + LWIP_MEMPOOL_FREE(ESP_PBUF_POOL, wifi_pbuf); +} + +static inline struct pbuf* pbuf_allocate(struct netif *netif, void *buffer, size_t len, void *l2_buff) +{ + struct pbuf *p; + + wifi_custom_pbuf_t* esp_pbuf = (wifi_custom_pbuf_t*)LWIP_MEMPOOL_ALLOC(ESP_PBUF_POOL); + + if (esp_pbuf == NULL) { + return NULL; + } + esp_pbuf->p.custom_free_function = esp_pbuf_free_l2_buff; + esp_pbuf->l2_buf = l2_buff; + p = pbuf_alloced_custom(PBUF_RAW, len, PBUF_REF, &esp_pbuf->p, buffer, len); + if (p == NULL) { + LWIP_MEMPOOL_FREE(ESP_PBUF_POOL, esp_pbuf); + return NULL; + } + return p; +} + +esp_err_t wifi_rxcb_sta(void *buffer, uint16_t len, void *l2_buff) +{ + struct netif * netif = s_wifi_netifs[0]; + struct pbuf *p; + + if(unlikely(!buffer || !netif_is_up(netif))) { + if (l2_buff) { + esp_wifi_internal_free_rx_buffer(l2_buff); + } + return ESP_FAIL; + } + + p = pbuf_allocate(netif, buffer, len, l2_buff); + if (p == NULL) { + esp_wifi_internal_free_rx_buffer(l2_buff); + return ESP_FAIL; + } + + /* full packet send to tcpip_thread to process */ + if (unlikely(netif->input(p, netif) != ERR_OK)) { + LWIP_DEBUGF(NETIF_DEBUG, ("wlanif_input: IP input error\n")); + pbuf_free(p); + } + return ESP_OK; +} + +esp_err_t wifi_rxcb_ap(void *buffer, uint16_t len, void *l2_buff) +{ + struct netif * netif = s_wifi_netifs[1]; + struct pbuf *p; + + if(unlikely(!buffer || !netif_is_up(netif))) { + if (l2_buff) { + esp_wifi_internal_free_rx_buffer(l2_buff); + } + return ESP_FAIL; + } + + p = pbuf_allocate(netif, buffer, len, l2_buff); + if (p == NULL) { + esp_wifi_internal_free_rx_buffer(l2_buff); + return ESP_FAIL; + } + + /* full packet send to tcpip_thread to process */ + if (unlikely(netif->input(p, netif) != ERR_OK)) { + LWIP_DEBUGF(NETIF_DEBUG, ("wlanif_input: IP input error\n")); + pbuf_free(p); + } + return ESP_OK; +} /** * This function should be called when a packet is ready to be read * from the interface. It uses the function low_level_input() that @@ -192,7 +213,85 @@ wlanif_input(void *h, void *buffer, size_t len, void* l2_buff) LWIP_DEBUGF(NETIF_DEBUG, ("wlanif_input: IP input error\n")); pbuf_free(p); } +} +/** + * This function should do the actual transmission of the packet. The packet is + * contained in the pbuf that is passed to the function. This pbuf + * might be chained. + * + * @param netif the lwip network interface structure for this wlanif + * @param p the MAC packet to send (e.g. IP packet including MAC addresses and type) + * @return ERR_OK if the packet could be sent + * an err_t value if the packet couldn't be sent + * + * @note Returning ERR_MEM here if a DMA queue of your MAC is full can lead to + * strange results. You might consider waiting for space in the DMA queue + * to become available since the stack doesn't retry to send a packet + * dropped because of memory failure (except for the TCP timers). + */ +static err_t +sta_output(struct netif *netif, struct pbuf *p) +{ + struct pbuf *q = p; + esp_err_t ret; + + if(q->next == NULL) { + ret = esp_wifi_internal_tx(WIFI_IF_STA, q->payload, q->len); + + } else { + LWIP_DEBUGF(PBUF_DEBUG, ("low_level_output: pbuf is a list, application may has bug")); + q = pbuf_alloc(PBUF_RAW_TX, p->tot_len, PBUF_RAM); + if (q != NULL) { + pbuf_copy(q, p); + } else { + return ERR_MEM; + } + ret = esp_wifi_internal_tx(WIFI_IF_STA, q->payload, q->len); + pbuf_free(q); + } + + if (ret == ESP_OK) { + return ERR_OK; + } else if (ret == ESP_ERR_NO_MEM) { + return ERR_MEM; + } else if (ret == ESP_ERR_INVALID_ARG) { + return ERR_ARG; + } else { + return ERR_IF; + } +} + +static err_t +ap_output(struct netif *netif, struct pbuf *p) +{ + struct pbuf *q = p; + esp_err_t ret; + + if(q->next == NULL) { + ret = esp_wifi_internal_tx(WIFI_IF_AP, q->payload, q->len); + + } else { + LWIP_DEBUGF(PBUF_DEBUG, ("low_level_output: pbuf is a list, application may has bug")); + q = pbuf_alloc(PBUF_RAW_TX, p->tot_len, PBUF_RAM); + if (q != NULL) { + pbuf_copy(q, p); + } else { + return ERR_MEM; + } + ret = esp_wifi_internal_tx(WIFI_IF_AP, q->payload, q->len); + pbuf_free(q); + } + + if (ret == ESP_OK) { + return ERR_OK; + } else if (ret == ESP_ERR_NO_MEM) { + return ERR_MEM; + } else if (ret == ESP_ERR_INVALID_ARG) { + return ERR_ARG; + } else { + return ERR_IF; + } } /** @@ -240,7 +339,6 @@ wlanif_init(struct netif *netif) #if LWIP_IPV6 netif->output_ip6 = ethip6_output; #endif /* LWIP_IPV6 */ - netif->linkoutput = low_level_output; /* initialize the hardware */ low_level_init(netif); @@ -251,11 +349,13 @@ wlanif_init(struct netif *netif) err_t wlanif_init_sta(struct netif *netif) { netif->name[0] = 's'; netif->name[1] = 't'; + netif->linkoutput = sta_output; return wlanif_init(netif); } err_t wlanif_init_ap(struct netif *netif) { netif->name[0] = 'a'; netif->name[1] = 'p'; + netif->linkoutput = ap_output; return wlanif_init(netif); } diff --git a/tools/ci/check_copyright_ignore.txt b/tools/ci/check_copyright_ignore.txt index d4b3dfeb1b..5993d748d3 100644 --- a/tools/ci/check_copyright_ignore.txt +++ b/tools/ci/check_copyright_ignore.txt @@ -980,7 +980,6 @@ components/lwip/port/esp32/include/netinet/tcp.h components/lwip/port/esp32/include/sntp/sntp_get_set_time.h components/lwip/port/esp32/include/sys/socket.h components/lwip/port/esp32/netif/ethernetif.c -components/lwip/port/esp32/netif/wlanif.c components/lwip/port/esp32/no_vfs_syscalls.c components/lwip/test_afl_host/dhcp_di.h components/lwip/test_afl_host/dhcpserver_di.h