Merge branch 'feature/wifi_throughput_optimization' into 'master'

jack0c · jack0c · commit 17f01eb718a2 · 2018-01-31T15:44:43.000+08:00
lwip/esp32/examples: wifi throughput optimization

See merge request idf/esp-idf!1861
diff --git a/components/esp32/ld/esp32.common.ld b/components/esp32/ld/esp32.common.ld
@@ -89,7 +89,6 @@ SECTIONS
     *libesp32.a:core_dump.o(.literal .text .literal.* .text.*)
     *libapp_trace.a:(.literal .text .literal.* .text.*)
     *libxtensa-debug-module.a:eri.o(.literal .text .literal.* .text.*)
-    *libphy.a:(.literal .text .literal.* .text.*)
     *librtc.a:(.literal .text .literal.* .text.*)
     *libsoc.a:(.literal .text .literal.* .text.*)
     *libhal.a:(.literal .text .literal.* .text.*)
@@ -116,7 +115,6 @@ SECTIONS
     *(.jcr)
     *(.dram1 .dram1.*)
     *libesp32.a:panic.o(.rodata .rodata.*)
-    *libphy.a:(.rodata .rodata.*)
     *libsoc.a:rtc_clk.o(.rodata .rodata.*)
     *libapp_trace.a:(.rodata .rodata.*)
     *libgcov.a:(.rodata .rodata.*)
diff --git a/components/esp32/lib b/components/esp32/lib
@@ -1 +1 @@
-Subproject commit b35fc86bbc5f96e8d52cc32527dbfbabaed0d6fc
+Subproject commit 32402930b3b2d28bf894cba918d08446b04a38e6
diff --git a/components/lwip/Kconfig b/components/lwip/Kconfig
@@ -16,6 +16,17 @@ config L2_TO_L3_COPY
         Please make sure you fully understand the impact of this feature before 
         enabling it.
 
+config LWIP_IRAM_OPTIMIZATION
+    bool "Enable LWIP IRAM optimization"
+    default n
+    help
+        If this feature is enabled, some functions relating to RX/TX in LWIP will be
+        put into IRAM, it can improve UDP/TCP throughput by >10% for single core mode,
+        it doesn't help too much for dual core mode. On the other hand, it needs about
+        10KB IRAM for these optimizations.
+
+        If this feature is disabled, all lwip functions will be put into FLASH.
+
 config LWIP_MAX_SOCKETS
     int "Max number of open sockets"
     range 1 32
diff --git a/components/lwip/api/api_lib.c b/components/lwip/api/api_lib.c
@@ -72,7 +72,7 @@ static err_t netconn_close_shutdown(struct netconn *conn, u8_t how);
  * @param apimsg a struct containing the function to call and its parameters
  * @return ERR_OK if the function was called, another err_t if not
  */
-static err_t
+static err_t ESP_IRAM_ATTR
 tcpip_apimsg(struct api_msg *apimsg)
 {
 #if LWIP_DEBUG
@@ -432,7 +432,7 @@ netconn_accept(struct netconn *conn, struct netconn **new_conn)
  * @return ERR_OK if data has been received, an error code otherwise (timeout,
  *                memory error or another error)
  */
-static err_t
+static err_t ESP_IRAM_ATTR
 netconn_recv_data(struct netconn *conn, void **new_buf)
 {
   void *buf = NULL;
@@ -566,7 +566,7 @@ netconn_recv_tcp_pbuf(struct netconn *conn, struct pbuf **new_buf)
  * @return ERR_OK if data has been received, an error code otherwise (timeout,
  *                memory error or another error)
  */
-err_t
+err_t ESP_IRAM_ATTR
 netconn_recv(struct netconn *conn, struct netbuf **new_buf)
 {
 #if LWIP_TCP
@@ -678,7 +678,7 @@ netconn_sendto(struct netconn *conn, struct netbuf *buf, const ip_addr_t *addr,
  * @param buf a netbuf containing the data to send
  * @return ERR_OK if data was sent, any other err_t on error
  */
-err_t
+err_t ESP_IRAM_ATTR
 netconn_send(struct netconn *conn, struct netbuf *buf)
 {
   API_MSG_VAR_DECLARE(msg);
diff --git a/components/lwip/api/api_msg.c b/components/lwip/api/api_msg.c
@@ -1440,7 +1440,7 @@ lwip_netconn_do_listen(void *m)
  *
  * @param msg the api_msg_msg pointing to the connection
  */
-void
+void ESP_IRAM_ATTR
 lwip_netconn_do_send(void *m)
 {
   struct api_msg_msg *msg = (struct api_msg_msg*)m;
diff --git a/components/lwip/api/netbuf.c b/components/lwip/api/netbuf.c
@@ -103,7 +103,7 @@ netbuf_delete(struct netbuf *buf)
  * @return pointer to the allocated memory
  *         NULL if no memory could be allocated
  */
-void *
+void * ESP_IRAM_ATTR
 netbuf_alloc(struct netbuf *buf, u16_t size)
 {
   LWIP_ERROR("netbuf_alloc: invalid buf", (buf != NULL), return NULL;);
@@ -127,7 +127,7 @@ netbuf_alloc(struct netbuf *buf, u16_t size)
  *
  * @param buf pointer to the netbuf which contains the packet buffer to free
  */
-void
+void ESP_IRAM_ATTR
 netbuf_free(struct netbuf *buf)
 {
   LWIP_ERROR("netbuf_free: invalid buf", (buf != NULL), return;);
diff --git a/components/lwip/api/sockets.c b/components/lwip/api/sockets.c
@@ -491,7 +491,7 @@ lwip_socket_thread_cleanup(void)
  * @param s externally used socket index
  * @return struct lwip_sock for the socket or NULL if not found
  */
-static struct lwip_sock *
+static struct lwip_sock * ESP_IRAM_ATTR
 get_socket(int s)
 {
   struct lwip_sock *sock;
@@ -962,7 +962,7 @@ lwip_listen(int s, int backlog)
   return 0;
 }
 
-int
+int ESP_IRAM_ATTR
 lwip_recvfrom(int s, void *mem, size_t len, int flags,
               struct sockaddr *from, socklen_t *fromlen)
 {
@@ -1340,7 +1340,7 @@ lwip_sendmsg(int s, const struct msghdr *msg, int flags)
 #endif /* LWIP_UDP || LWIP_RAW */
 }
 
-int
+int ESP_IRAM_ATTR
 lwip_sendto(int s, const void *data, size_t size, int flags,
        const struct sockaddr *to, socklen_t tolen)
 {
@@ -1817,7 +1817,7 @@ lwip_select(int maxfdp1, fd_set *readset, fd_set *writeset, fd_set *exceptset,
  * Callback registered in the netconn layer for each socket-netconn.
  * Processes recvevent (data available) and wakes up tasks waiting for select.
  */
-static void
+static void ESP_IRAM_ATTR
 event_callback(struct netconn *conn, enum netconn_evt evt, u16_t len)
 {
   int s;
@@ -3159,7 +3159,7 @@ static void lwip_socket_drop_registered_memberships(int s)
 
 #if ESP_THREAD_SAFE
 
-int
+int ESP_IRAM_ATTR
 lwip_sendto_r(int s, const void *data, size_t size, int flags,
        const struct sockaddr *to, socklen_t tolen)
 {
@@ -3176,7 +3176,7 @@ lwip_send_r(int s, const void *data, size_t size, int flags)
   LWIP_API_UNLOCK();
 }
 
-int
+int ESP_IRAM_ATTR
 lwip_recvfrom_r(int s, void *mem, size_t len, int flags,
               struct sockaddr *from, socklen_t *fromlen)
 {
diff --git a/components/lwip/api/tcpip.c b/components/lwip/api/tcpip.c
@@ -77,7 +77,7 @@ sys_mutex_t lock_tcpip_core;
  *
  * @param arg unused argument
  */
-static void
+static void ESP_IRAM_ATTR
 tcpip_thread(void *arg)
 {
 
@@ -195,7 +195,7 @@ tcpip_thread(void *arg)
  * @param inp the network interface on which the packet was received
  * @param input_fn input function to call
  */
-err_t
+err_t ESP_IRAM_ATTR
 tcpip_inpkt(struct pbuf *p, struct netif *inp, netif_input_fn input_fn)
 {
 #if LWIP_TCPIP_CORE_LOCKING_INPUT
@@ -244,7 +244,7 @@ tcpip_inpkt(struct pbuf *p, struct netif *inp, netif_input_fn input_fn)
  *          NETIF_FLAG_ETHERNET flags)
  * @param inp the network interface on which the packet was received
  */
-err_t
+err_t ESP_IRAM_ATTR
 tcpip_input(struct pbuf *p, struct netif *inp)
 {
 #if LWIP_ETHERNET
@@ -363,7 +363,7 @@ tcpip_untimeout(sys_timeout_handler h, void *arg)
  * @param sem semaphore to wait on
  * @return ERR_OK if the function was called, another err_t if not
  */
-err_t
+err_t ESP_IRAM_ATTR
 tcpip_send_api_msg(tcpip_callback_fn fn, void *apimsg, sys_sem_t* sem)
 {
   LWIP_ASSERT("semaphore not initialized", sys_sem_valid(sem));
diff --git a/components/lwip/core/inet_chksum.c b/components/lwip/core/inet_chksum.c
@@ -259,7 +259,7 @@ lwip_standard_chksum(const void *dataptr, int len)
 #endif
 
 /** Parts of the pseudo checksum which are common to IPv4 and IPv6 */
-static u16_t
+static u16_t ESP_IRAM_ATTR
 inet_cksum_pseudo_base(struct pbuf *p, u8_t proto, u16_t proto_len, u32_t acc)
 {
   struct pbuf *q;
@@ -309,7 +309,7 @@ inet_cksum_pseudo_base(struct pbuf *p, u8_t proto, u16_t proto_len, u32_t acc)
  * @param proto_len length of the ip data part (used for checksum of pseudo header)
  * @return checksum (as u16_t) to be saved directly in the protocol header
  */
-u16_t
+u16_t ESP_IRAM_ATTR
 inet_chksum_pseudo(struct pbuf *p, u8_t proto, u16_t proto_len,
        const ip4_addr_t *src, const ip4_addr_t *dest)
 {
@@ -378,7 +378,7 @@ ip6_chksum_pseudo(struct pbuf *p, u8_t proto, u16_t proto_len,
  * @param proto_len length of the ip data part (used for checksum of pseudo header)
  * @return checksum (as u16_t) to be saved directly in the protocol header
  */
-u16_t
+u16_t ESP_IRAM_ATTR
 ip_chksum_pseudo(struct pbuf *p, u8_t proto, u16_t proto_len,
        const ip_addr_t *src, const ip_addr_t *dest)
 {
diff --git a/components/lwip/core/ipv4/ip4.c b/components/lwip/core/ipv4/ip4.c
@@ -136,7 +136,7 @@ bool ip4_netif_exist(const ip4_addr_t *src, const ip4_addr_t *dest)
  * Source based IPv4 routing hook function. This function works only
  * when destination IP is broadcast IP.
  */
-struct netif *
+struct netif * ESP_IRAM_ATTR
 ip4_route_src_hook(const ip4_addr_t *dest, const ip4_addr_t *src)
 {
   struct netif *netif = NULL;
@@ -162,7 +162,7 @@ ip4_route_src_hook(const ip4_addr_t *dest, const ip4_addr_t *src)
  * Source based IPv4 routing must be fully implemented in
  * LWIP_HOOK_IP4_ROUTE_SRC(). This function only provides the parameters.
  */
-struct netif *
+struct netif * ESP_IRAM_ATTR
 ip4_route_src(const ip4_addr_t *dest, const ip4_addr_t *src)
 {
   if (src != NULL) {
@@ -189,7 +189,7 @@ ip4_route_src(const ip4_addr_t *dest, const ip4_addr_t *src)
  * @param dest the destination IP address for which to find the route
  * @return the netif on which to send to reach dest
  */
-struct netif *
+struct netif * ESP_IRAM_ATTR
 ip4_route(const ip4_addr_t *dest)
 {
   struct netif *netif;
@@ -410,7 +410,7 @@ ip4_forward(struct pbuf *p, struct ip_hdr *iphdr, struct netif *inp)
  * @return ERR_OK if the packet was processed (could return ERR_* if it wasn't
  *         processed, but currently always returns ERR_OK)
  */
-err_t
+err_t ESP_IRAM_ATTR
 ip4_input(struct pbuf *p, struct netif *inp)
 {
   struct ip_hdr *iphdr;
@@ -818,7 +818,7 @@ ip4_output_if_opt(struct pbuf *p, const ip4_addr_t *src, const ip4_addr_t *dest,
  * Same as ip_output_if() but 'src' address is not replaced by netif address
  * when it is 'any'.
  */
-err_t
+err_t ESP_IRAM_ATTR
 ip4_output_if_src(struct pbuf *p, const ip4_addr_t *src, const ip4_addr_t *dest,
              u8_t ttl, u8_t tos,
              u8_t proto, struct netif *netif)
@@ -831,7 +831,7 @@ ip4_output_if_src(struct pbuf *p, const ip4_addr_t *src, const ip4_addr_t *dest,
  * Same as ip_output_if_opt() but 'src' address is not replaced by netif address
  * when it is 'any'.
  */
-err_t
+err_t ESP_IRAM_ATTR
 ip4_output_if_opt_src(struct pbuf *p, const ip4_addr_t *src, const ip4_addr_t *dest,
        u8_t ttl, u8_t tos, u8_t proto, struct netif *netif, void *ip_options,
        u16_t optlen)
diff --git a/components/lwip/core/ipv4/ip4_addr.c b/components/lwip/core/ipv4/ip4_addr.c
@@ -55,7 +55,7 @@ const ip_addr_t ip_addr_broadcast = IPADDR4_INIT(IPADDR_BROADCAST);
  * @param netif the network interface against which the address is checked
  * @return returns non-zero if the address is a broadcast address
  */
-u8_t
+u8_t ESP_IRAM_ATTR
 ip4_addr_isbroadcast_u32(u32_t addr, const struct netif *netif)
 {
   ip4_addr_t ipaddr;
diff --git a/components/lwip/core/pbuf.c b/components/lwip/core/pbuf.c
@@ -513,7 +513,7 @@ pbuf_realloc(struct pbuf *p, u16_t new_len)
  * @return non-zero on failure, zero on success.
  *
  */
-static u8_t
+static u8_t ESP_IRAM_ATTR
 pbuf_header_impl(struct pbuf *p, s16_t header_size_increment, u8_t force)
 {
   u16_t type;
@@ -609,7 +609,7 @@ pbuf_header_impl(struct pbuf *p, s16_t header_size_increment, u8_t force)
  * @return non-zero on failure, zero on success.
  *
  */
-u8_t
+u8_t ESP_IRAM_ATTR
 pbuf_header(struct pbuf *p, s16_t header_size_increment)
 {
    return pbuf_header_impl(p, header_size_increment, 0);
diff --git a/components/lwip/core/timers.c b/components/lwip/core/timers.c
@@ -535,7 +535,7 @@ sys_timeouts_sleeptime(void)
  * @param mbox the mbox to fetch the message from
  * @param msg the place to store the message
  */
-void
+void ESP_IRAM_ATTR
 sys_timeouts_mbox_fetch(sys_mbox_t *mbox, void **msg)
 {
   u32_t time_needed;
diff --git a/components/lwip/core/udp.c b/components/lwip/core/udp.c
@@ -146,7 +146,7 @@ udp_new_port(void)
  * @param broadcast 1 if his is an IPv4 broadcast (global or subnet-only), 0 otherwise (only used for IPv4)
  * @return 1 on match, 0 otherwise
  */
-static u8_t
+static u8_t ESP_IRAM_ATTR
 udp_input_local_match(struct udp_pcb *pcb, struct netif *inp, u8_t broadcast)
 {
   LWIP_UNUSED_ARG(inp);       /* in IPv6 only case */
@@ -210,7 +210,7 @@ udp_input_local_match(struct udp_pcb *pcb, struct netif *inp, u8_t broadcast)
  * @param inp network interface on which the datagram was received.
  *
  */
-void
+void ESP_IRAM_ATTR
 udp_input(struct pbuf *p, struct netif *inp)
 {
   struct udp_hdr *udphdr;
@@ -474,7 +474,7 @@ udp_input(struct pbuf *p, struct netif *inp)
  *
  * @see udp_disconnect() udp_sendto()
  */
-err_t
+err_t ESP_IRAM_ATTR
 udp_send(struct udp_pcb *pcb, struct pbuf *p)
 {
   if ((pcb == NULL) || IP_IS_ANY_TYPE_VAL(pcb->remote_ip)) {
@@ -519,7 +519,7 @@ udp_send_chksum(struct udp_pcb *pcb, struct pbuf *p,
  *
  * @see udp_disconnect() udp_send()
  */
-err_t
+err_t ESP_IRAM_ATTR
 udp_sendto(struct udp_pcb *pcb, struct pbuf *p,
   const ip_addr_t *dst_ip, u16_t dst_port)
 {
@@ -615,7 +615,7 @@ udp_sendto_chksum(struct udp_pcb *pcb, struct pbuf *p, const ip_addr_t *dst_ip,
  *
  * @see udp_disconnect() udp_send()
  */
-err_t
+err_t ESP_IRAM_ATTR
 udp_sendto_if(struct udp_pcb *pcb, struct pbuf *p,
   const ip_addr_t *dst_ip, u16_t dst_port, struct netif *netif)
 {
@@ -681,7 +681,7 @@ udp_sendto_if_chksum(struct udp_pcb *pcb, struct pbuf *p, const ip_addr_t *dst_i
 }
 
 /** Same as udp_sendto_if(), but with source address */
-err_t
+err_t ESP_IRAM_ATTR
 udp_sendto_if_src(struct udp_pcb *pcb, struct pbuf *p,
   const ip_addr_t *dst_ip, u16_t dst_port, struct netif *netif, const ip_addr_t *src_ip)
 {
diff --git a/components/lwip/include/lwip/port/lwipopts.h b/components/lwip/include/lwip/port/lwipopts.h
@@ -727,6 +727,12 @@
 #define ESP_LWIP_LOGI(...)              ESP_LOGI("lwip", __VA_ARGS__)
 #define ESP_PING                        1
 
+#if CONFIG_LWIP_IRAM_OPTIMIZATION
+#define ESP_IRAM_ATTR                   IRAM_ATTR
+#else
+#define ESP_IRAM_ATTR                   
+#endif
+
 #define TCP_WND_DEFAULT                 CONFIG_TCP_WND_DEFAULT
 #define TCP_SND_BUF_DEFAULT             CONFIG_TCP_SND_BUF_DEFAULT
 
diff --git a/components/lwip/netif/etharp.c b/components/lwip/netif/etharp.c
diff --git a/components/lwip/netif/ethernet.c b/components/lwip/netif/ethernet.c
diff --git a/components/lwip/port/freertos/sys_arch.c b/components/lwip/port/freertos/sys_arch.c
diff --git a/components/lwip/port/netif/wlanif.c b/components/lwip/port/netif/wlanif.c
diff --git a/examples/wifi/iperf/components/iperf.c b/examples/wifi/iperf/components/iperf.c
diff --git a/examples/wifi/iperf/components/iperf.h b/examples/wifi/iperf/components/iperf.h
diff --git a/examples/wifi/iperf/sdkconfig.defaults b/examples/wifi/iperf/sdkconfig.defaults

Original file line number	Diff line number	Diff line change
`@@ -1440,7 +1440,7 @@ lwip_netconn_do_listen(void *m)`
`1440`	`1440`	`*`
`1441`	`1441`	`* @param msg the api_msg_msg pointing to the connection`
`1442`	`1442`	`*/`
`1443`		`-void`
	`1443`	`+void ESP_IRAM_ATTR`
`1444`	`1444`	`lwip_netconn_do_send(void *m)`
`1445`	`1445`	`{`
`1446`	`1446`	`struct api_msg_msg msg = (struct api_msg_msg)m;`
Original file line number	Diff line number	Diff line change
`@@ -103,7 +103,7 @@ netbuf_delete(struct netbuf *buf)`
`103`	`103`	`* @return pointer to the allocated memory`
`104`	`104`	`* NULL if no memory could be allocated`
`105`	`105`	`*/`
`106`		`-void *`
	`106`	`+void * ESP_IRAM_ATTR`
`107`	`107`	`netbuf_alloc(struct netbuf *buf, u16_t size)`
`108`	`108`	`{`
`109`	`109`	`LWIP_ERROR("netbuf_alloc: invalid buf", (buf != NULL), return NULL;);`
`@@ -127,7 +127,7 @@ netbuf_alloc(struct netbuf *buf, u16_t size)`
`127`	`127`	`*`
`128`	`128`	`* @param buf pointer to the netbuf which contains the packet buffer to free`
`129`	`129`	`*/`
`130`		`-void`
	`130`	`+void ESP_IRAM_ATTR`
`131`	`131`	`netbuf_free(struct netbuf *buf)`
`132`	`132`	`{`
`133`	`133`	`LWIP_ERROR("netbuf_free: invalid buf", (buf != NULL), return;);`
Original file line number	Diff line number	Diff line change
`@@ -491,7 +491,7 @@ lwip_socket_thread_cleanup(void)`
`491`	`491`	`* @param s externally used socket index`
`492`	`492`	`* @return struct lwip_sock for the socket or NULL if not found`
`493`	`493`	`*/`
`494`		`-static struct lwip_sock *`
	`494`	`+static struct lwip_sock * ESP_IRAM_ATTR`
`495`	`495`	`get_socket(int s)`
`496`	`496`	`{`
`497`	`497`	`struct lwip_sock *sock;`
`@@ -962,7 +962,7 @@ lwip_listen(int s, int backlog)`
`962`	`962`	`return 0;`
`963`	`963`	`}`
`964`	`964`
`965`		`-int`
	`965`	`+int ESP_IRAM_ATTR`
`966`	`966`	`lwip_recvfrom(int s, void *mem, size_t len, int flags,`
`967`	`967`	`struct sockaddr from, socklen_t fromlen)`
`968`	`968`	`{`
`@@ -1340,7 +1340,7 @@ lwip_sendmsg(int s, const struct msghdr *msg, int flags)`
`1340`	`1340`	`#endif /* LWIP_UDP \|\| LWIP_RAW */`
`1341`	`1341`	`}`
`1342`	`1342`
`1343`		`-int`
	`1343`	`+int ESP_IRAM_ATTR`
`1344`	`1344`	`lwip_sendto(int s, const void *data, size_t size, int flags,`
`1345`	`1345`	`const struct sockaddr *to, socklen_t tolen)`
`1346`	`1346`	`{`
`@@ -1817,7 +1817,7 @@ lwip_select(int maxfdp1, fd_set readset, fd_set writeset, fd_set *exceptset,`
`1817`	`1817`	`* Callback registered in the netconn layer for each socket-netconn.`
`1818`	`1818`	`* Processes recvevent (data available) and wakes up tasks waiting for select.`
`1819`	`1819`	`*/`
`1820`		`-static void`
	`1820`	`+static void ESP_IRAM_ATTR`
`1821`	`1821`	`event_callback(struct netconn *conn, enum netconn_evt evt, u16_t len)`
`1822`	`1822`	`{`
`1823`	`1823`	`int s;`
`@@ -3159,7 +3159,7 @@ static void lwip_socket_drop_registered_memberships(int s)`
`3159`	`3159`
`3160`	`3160`	`#if ESP_THREAD_SAFE`
`3161`	`3161`
`3162`		`-int`
	`3162`	`+int ESP_IRAM_ATTR`
`3163`	`3163`	`lwip_sendto_r(int s, const void *data, size_t size, int flags,`
`3164`	`3164`	`const struct sockaddr *to, socklen_t tolen)`
`3165`	`3165`	`{`
`@@ -3176,7 +3176,7 @@ lwip_send_r(int s, const void *data, size_t size, int flags)`
`3176`	`3176`	`LWIP_API_UNLOCK();`
`3177`	`3177`	`}`
`3178`	`3178`
`3179`		`-int`
	`3179`	`+int ESP_IRAM_ATTR`
`3180`	`3180`	`lwip_recvfrom_r(int s, void *mem, size_t len, int flags,`
`3181`	`3181`	`struct sockaddr from, socklen_t fromlen)`
`3182`	`3182`	`{`