1 /** 2 * @file 3 * netconn API lwIP internal implementations (do not use in application code) 4 */ 5 6 /* 7 * Copyright (c) 2001-2004 Swedish Institute of Computer Science. 8 * All rights reserved. 9 * 10 * Redistribution and use in source and binary forms, with or without modification, 11 * are permitted provided that the following conditions are met: 12 * 13 * 1. Redistributions of source code must retain the above copyright notice, 14 * this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright notice, 16 * this list of conditions and the following disclaimer in the documentation 17 * and/or other materials provided with the distribution. 18 * 3. The name of the author may not be used to endorse or promote products 19 * derived from this software without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 22 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 23 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 24 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 26 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 29 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 30 * OF SUCH DAMAGE. 31 * 32 * This file is part of the lwIP TCP/IP stack. 33 * 34 * Author: Adam Dunkels <adam@sics.se> 35 * 36 */ 37 #ifndef LWIP_HDR_API_MSG_H 38 #define LWIP_HDR_API_MSG_H 39 40 #include "lwip/opt.h" 41 42 #if LWIP_NETCONN || LWIP_SOCKET /* don't build if not configured for use in lwipopts.h */ 43 /* Note: Netconn API is always available when sockets are enabled - 44 * sockets are implemented on top of them */ 45 46 #include "lwip/arch.h" 47 #include "lwip/ip_addr.h" 48 #include "lwip/err.h" 49 #include "lwip/sys.h" 50 #include "lwip/igmp.h" 51 #include "lwip/api.h" 52 #include "lwip/priv/tcpip_priv.h" 53 54 #ifdef __cplusplus 55 extern "C" { 56 #endif 57 58 #if LWIP_MPU_COMPATIBLE 59 #if LWIP_NETCONN_SEM_PER_THREAD 60 #define API_MSG_M_DEF_SEM(m) *m 61 #else 62 #define API_MSG_M_DEF_SEM(m) API_MSG_M_DEF(m) 63 #endif 64 #else /* LWIP_MPU_COMPATIBLE */ 65 #define API_MSG_M_DEF_SEM(m) API_MSG_M_DEF(m) 66 #endif /* LWIP_MPU_COMPATIBLE */ 67 68 /* For the netconn API, these values are use as a bitmask! */ 69 #define NETCONN_SHUT_RD 1 70 #define NETCONN_SHUT_WR 2 71 #define NETCONN_SHUT_RDWR (NETCONN_SHUT_RD | NETCONN_SHUT_WR) 72 73 /* IP addresses and port numbers are expected to be in 74 * the same byte order as in the corresponding pcb. 75 */ 76 /** This struct includes everything that is necessary to execute a function 77 for a netconn in another thread context (mainly used to process netconns 78 in the tcpip_thread context to be thread safe). */ 79 struct api_msg { 80 /** The netconn which to process - always needed: it includes the semaphore 81 which is used to block the application thread until the function finished. */ 82 struct netconn *conn; 83 /** The return value of the function executed in tcpip_thread. */ 84 err_t err; 85 /** Depending on the executed function, one of these union members is used */ 86 union { 87 /** used for lwip_netconn_do_send */ 88 struct netbuf *b; 89 /** used for lwip_netconn_do_newconn */ 90 struct { 91 u8_t proto; 92 } n; 93 /** used for lwip_netconn_do_bind and lwip_netconn_do_connect */ 94 struct { 95 API_MSG_M_DEF_C(ip_addr_t, ipaddr); 96 u16_t port; 97 } bc; 98 /** used for lwip_netconn_do_getaddr */ 99 struct { 100 ip_addr_t API_MSG_M_DEF(ipaddr); 101 u16_t API_MSG_M_DEF(port); 102 u8_t local; 103 } ad; 104 /** used for lwip_netconn_do_write */ 105 struct { 106 /** current vector to write */ 107 const struct netvector *vector; 108 /** number of unwritten vectors */ 109 u16_t vector_cnt; 110 /** offset into current vector */ 111 size_t vector_off; 112 /** total length across vectors */ 113 size_t len; 114 /** offset into total length/output of bytes written when err == ERR_OK */ 115 size_t offset; 116 u8_t apiflags; 117 #if LWIP_SO_SNDTIMEO 118 u32_t time_started; 119 #endif /* LWIP_SO_SNDTIMEO */ 120 } w; 121 /** used for lwip_netconn_do_recv */ 122 struct { 123 u32_t len; 124 } r; 125 #if LWIP_TCP 126 /** used for lwip_netconn_do_close (/shutdown) */ 127 struct { 128 u8_t shut; 129 #if LWIP_SO_SNDTIMEO || LWIP_SO_LINGER 130 u32_t time_started; 131 #else /* LWIP_SO_SNDTIMEO || LWIP_SO_LINGER */ 132 u8_t polls_left; 133 #endif /* LWIP_SO_SNDTIMEO || LWIP_SO_LINGER */ 134 } sd; 135 #endif /* LWIP_TCP */ 136 #if LWIP_IGMP || (LWIP_IPV6 && LWIP_IPV6_MLD) 137 /** used for lwip_netconn_do_join_leave_group */ 138 struct { 139 API_MSG_M_DEF_C(ip_addr_t, multiaddr); 140 API_MSG_M_DEF_C(ip_addr_t, netif_addr); 141 enum netconn_igmp join_or_leave; 142 } jl; 143 #endif /* LWIP_IGMP || (LWIP_IPV6 && LWIP_IPV6_MLD) */ 144 #if TCP_LISTEN_BACKLOG 145 struct { 146 u8_t backlog; 147 } lb; 148 #endif /* TCP_LISTEN_BACKLOG */ 149 } msg; 150 #if LWIP_NETCONN_SEM_PER_THREAD 151 sys_sem_t* op_completed_sem; 152 #endif /* LWIP_NETCONN_SEM_PER_THREAD */ 153 }; 154 155 #if LWIP_NETCONN_SEM_PER_THREAD 156 #define LWIP_API_MSG_SEM(msg) ((msg)->op_completed_sem) 157 #else /* LWIP_NETCONN_SEM_PER_THREAD */ 158 #define LWIP_API_MSG_SEM(msg) (&(msg)->conn->op_completed) 159 #endif /* LWIP_NETCONN_SEM_PER_THREAD */ 160 161 162 #if LWIP_DNS 163 /** As lwip_netconn_do_gethostbyname requires more arguments but doesn't require a netconn, 164 it has its own struct (to avoid struct api_msg getting bigger than necessary). 165 lwip_netconn_do_gethostbyname must be called using tcpip_callback instead of tcpip_apimsg 166 (see netconn_gethostbyname). */ 167 struct dns_api_msg { 168 /** Hostname to query or dotted IP address string */ 169 #if LWIP_MPU_COMPATIBLE 170 char name[DNS_MAX_NAME_LENGTH]; 171 #else /* LWIP_MPU_COMPATIBLE */ 172 const char *name; 173 #endif /* LWIP_MPU_COMPATIBLE */ 174 /** The resolved address is stored here */ 175 ip_addr_t API_MSG_M_DEF(addr); 176 #if LWIP_IPV4 && LWIP_IPV6 177 /** Type of resolve call */ 178 u8_t dns_addrtype; 179 #endif /* LWIP_IPV4 && LWIP_IPV6 */ 180 /** This semaphore is posted when the name is resolved, the application thread 181 should wait on it. */ 182 sys_sem_t API_MSG_M_DEF_SEM(sem); 183 /** Errors are given back here */ 184 err_t API_MSG_M_DEF(err); 185 }; 186 #endif /* LWIP_DNS */ 187 188 #if LWIP_TCP 189 extern u8_t netconn_aborted; 190 #endif /* LWIP_TCP */ 191 192 void lwip_netconn_do_newconn (void *m); 193 void lwip_netconn_do_delconn (void *m); 194 void lwip_netconn_do_bind (void *m); 195 void lwip_netconn_do_connect (void *m); 196 void lwip_netconn_do_disconnect (void *m); 197 void lwip_netconn_do_listen (void *m); 198 void lwip_netconn_do_send (void *m); 199 void lwip_netconn_do_recv (void *m); 200 #if TCP_LISTEN_BACKLOG 201 void lwip_netconn_do_accepted (void *m); 202 #endif /* TCP_LISTEN_BACKLOG */ 203 void lwip_netconn_do_write (void *m); 204 void lwip_netconn_do_getaddr (void *m); 205 void lwip_netconn_do_close (void *m); 206 void lwip_netconn_do_shutdown (void *m); 207 #if LWIP_IGMP || (LWIP_IPV6 && LWIP_IPV6_MLD) 208 void lwip_netconn_do_join_leave_group(void *m); 209 #endif /* LWIP_IGMP || (LWIP_IPV6 && LWIP_IPV6_MLD) */ 210 211 #if LWIP_DNS 212 void lwip_netconn_do_gethostbyname(void *arg); 213 #endif /* LWIP_DNS */ 214 215 struct netconn* netconn_alloc(enum netconn_type t, netconn_callback callback); 216 void netconn_free(struct netconn *conn); 217 218 #ifdef __cplusplus 219 } 220 #endif 221 222 #endif /* LWIP_NETCONN || LWIP_SOCKET */ 223 224 #endif /* LWIP_HDR_API_MSG_H */ 225