third_party/lwip/repo/lwip/src/include/lwip/api.h

   1 /**
   2  * @file
   3  * netconn API (to be used from non-TCPIP threads)
   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_H
  38 #define LWIP_HDR_API_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/netbuf.h"
  48 #include "lwip/sys.h"
  49 #include "lwip/ip_addr.h"
  50 #include "lwip/err.h"
  51
  52 #ifdef __cplusplus
  53 extern "C" {
  54 #endif
  55
  56 /* Throughout this file, IP addresses and port numbers are expected to be in
  57  * the same byte order as in the corresponding pcb.
  58  */
  59
  60 /* Flags for netconn_write (u8_t) */
  61 #define NETCONN_NOFLAG    0x00
  62 #define NETCONN_NOCOPY    0x00 /* Only for source code compatibility */
  63 #define NETCONN_COPY      0x01
  64 #define NETCONN_MORE      0x02
  65 #define NETCONN_DONTBLOCK 0x04
  66
  67 /* Flags for struct netconn.flags (u8_t) */
  68 /** Should this netconn avoid blocking? */
  69 #define NETCONN_FLAG_NON_BLOCKING             0x02
  70 /** Was the last connect action a non-blocking one? */
  71 #define NETCONN_FLAG_IN_NONBLOCKING_CONNECT   0x04
  72 /** If a nonblocking write has been rejected before, poll_tcp needs to
  73     check if the netconn is writable again */
  74 #define NETCONN_FLAG_CHECK_WRITESPACE         0x10
  75 #if LWIP_IPV6
  76 /** If this flag is set then only IPv6 communication is allowed on the
  77     netconn. As per RFC#3493 this features defaults to OFF allowing
  78     dual-stack usage by default. */
  79 #define NETCONN_FLAG_IPV6_V6ONLY              0x20
  80 #endif /* LWIP_IPV6 */
  81
  82
  83 /* Helpers to process several netconn_types by the same code */
  84 #define NETCONNTYPE_GROUP(t)         ((t)&0xF0)
  85 #define NETCONNTYPE_DATAGRAM(t)      ((t)&0xE0)
  86 #if LWIP_IPV6
  87 #define NETCONN_TYPE_IPV6            0x08
  88 #define NETCONNTYPE_ISIPV6(t)        (((t)&NETCONN_TYPE_IPV6) != 0)
  89 #define NETCONNTYPE_ISUDPLITE(t)     (((t)&0xF3) == NETCONN_UDPLITE)
  90 #define NETCONNTYPE_ISUDPNOCHKSUM(t) (((t)&0xF3) == NETCONN_UDPNOCHKSUM)
  91 #else /* LWIP_IPV6 */
  92 #define NETCONNTYPE_ISIPV6(t)        (0)
  93 #define NETCONNTYPE_ISUDPLITE(t)     ((t) == NETCONN_UDPLITE)
  94 #define NETCONNTYPE_ISUDPNOCHKSUM(t) ((t) == NETCONN_UDPNOCHKSUM)
  95 #endif /* LWIP_IPV6 */
  96
  97 /** @ingroup netconn_common
  98  * Protocol family and type of the netconn
  99  */
 100 enum netconn_type {
 101   NETCONN_INVALID     = 0,
 102   /** TCP IPv4 */
 103   NETCONN_TCP         = 0x10,
 104 #if LWIP_IPV6
 105   /** TCP IPv6 */
 106   NETCONN_TCP_IPV6    = NETCONN_TCP | NETCONN_TYPE_IPV6 /* 0x18 */,
 107 #endif /* LWIP_IPV6 */
 108   /** UDP IPv4 */
 109   NETCONN_UDP         = 0x20,
 110   /** UDP IPv4 lite */
 111   NETCONN_UDPLITE     = 0x21,
 112   /** UDP IPv4 no checksum */
 113   NETCONN_UDPNOCHKSUM = 0x22,
 114
 115 #if LWIP_IPV6
 116   /** UDP IPv6 (dual-stack by default, unless you call @ref netconn_set_ipv6only) */
 117   NETCONN_UDP_IPV6         = NETCONN_UDP | NETCONN_TYPE_IPV6 /* 0x28 */,
 118   /** UDP IPv6 lite (dual-stack by default, unless you call @ref netconn_set_ipv6only) */
 119   NETCONN_UDPLITE_IPV6     = NETCONN_UDPLITE | NETCONN_TYPE_IPV6 /* 0x29 */,
 120   /** UDP IPv6 no checksum (dual-stack by default, unless you call @ref netconn_set_ipv6only) */
 121   NETCONN_UDPNOCHKSUM_IPV6 = NETCONN_UDPNOCHKSUM | NETCONN_TYPE_IPV6 /* 0x2a */,
 122 #endif /* LWIP_IPV6 */
 123
 124   /** Raw connection IPv4 */
 125   NETCONN_RAW         = 0x40
 126 #if LWIP_IPV6
 127   /** Raw connection IPv6 (dual-stack by default, unless you call @ref netconn_set_ipv6only) */
 128   , NETCONN_RAW_IPV6    = NETCONN_RAW | NETCONN_TYPE_IPV6 /* 0x48 */
 129 #endif /* LWIP_IPV6 */
 130 };
 131
 132 /** Current state of the netconn. Non-TCP netconns are always
 133  * in state NETCONN_NONE! */
 134 enum netconn_state {
 135   NETCONN_NONE,
 136   NETCONN_WRITE,
 137   NETCONN_LISTEN,
 138   NETCONN_CONNECT,
 139   NETCONN_CLOSE
 140 };
 141
 142 /** Used to inform the callback function about changes
 143  *
 144  * Event explanation:
 145  *
 146  * In the netconn implementation, there are three ways to block a client:
 147  *
 148  * - accept mbox (sys_arch_mbox_fetch(&conn->acceptmbox, &accept_ptr, 0); in netconn_accept())
 149  * - receive mbox (sys_arch_mbox_fetch(&conn->recvmbox, &buf, 0); in netconn_recv_data())
 150  * - send queue is full (sys_arch_sem_wait(LWIP_API_MSG_SEM(msg), 0); in lwip_netconn_do_write())
 151  *
 152  * The events have to be seen as events signaling the state of these mboxes/semaphores. For non-blocking
 153  * connections, you need to know in advance whether a call to a netconn function call would block or not,
 154  * and these events tell you about that.
 155  *
 156  * RCVPLUS events say: Safe to perform a potentially blocking call call once more.
 157  * They are counted in sockets - three RCVPLUS events for accept mbox means you are safe
 158  * to call netconn_accept 3 times without being blocked.
 159  * Same thing for receive mbox.
 160  *
 161  * RCVMINUS events say: Your call to to a possibly blocking function is "acknowledged".
 162  * Socket implementation decrements the counter.
 163  *
 164  * For TX, there is no need to count, its merely a flag. SENDPLUS means you may send something.
 165  * SENDPLUS occurs when enough data was delivered to peer so netconn_send() can be called again.
 166  * A SENDMINUS event occurs when the next call to a netconn_send() would be blocking.
 167  */
 168 enum netconn_evt {
 169   NETCONN_EVT_RCVPLUS,
 170   NETCONN_EVT_RCVMINUS,
 171   NETCONN_EVT_SENDPLUS,
 172   NETCONN_EVT_SENDMINUS,
 173   NETCONN_EVT_ERROR
 174 };
 175
 176 #if LWIP_IGMP || (LWIP_IPV6 && LWIP_IPV6_MLD)
 177 /** Used for netconn_join_leave_group() */
 178 enum netconn_igmp {
 179   NETCONN_JOIN,
 180   NETCONN_LEAVE
 181 };
 182 #endif /* LWIP_IGMP || (LWIP_IPV6 && LWIP_IPV6_MLD) */
 183
 184 #if LWIP_DNS
 185 /* Used for netconn_gethostbyname_addrtype(), these should match the DNS_ADDRTYPE defines in dns.h */
 186 #define NETCONN_DNS_DEFAULT   NETCONN_DNS_IPV4_IPV6
 187 #define NETCONN_DNS_IPV4      0
 188 #define NETCONN_DNS_IPV6      1
 189 #define NETCONN_DNS_IPV4_IPV6 2 /* try to resolve IPv4 first, try IPv6 if IPv4 fails only */
 190 #define NETCONN_DNS_IPV6_IPV4 3 /* try to resolve IPv6 first, try IPv4 if IPv6 fails only */
 191 #endif /* LWIP_DNS */
 192
 193 /* forward-declare some structs to avoid to include their headers */
 194 struct ip_pcb;
 195 struct tcp_pcb;
 196 struct udp_pcb;
 197 struct raw_pcb;
 198 struct netconn;
 199 struct api_msg;
 200
 201 /** A callback prototype to inform about events for a netconn */
 202 typedef void (* netconn_callback)(struct netconn *, enum netconn_evt, u16_t len);
 203
 204 /** A netconn descriptor */
 205 struct netconn {
 206   /** type of the netconn (TCP, UDP or RAW) */
 207   enum netconn_type type;
 208   /** current state of the netconn */
 209   enum netconn_state state;
 210   /** the lwIP internal protocol control block */
 211   union {
 212     struct ip_pcb  *ip;
 213     struct tcp_pcb *tcp;
 214     struct udp_pcb *udp;
 215     struct raw_pcb *raw;
 216   } pcb;
 217   /** the last error this netconn had */
 218   err_t last_err;
 219 #if !LWIP_NETCONN_SEM_PER_THREAD
 220   /** sem that is used to synchronously execute functions in the core context */
 221   sys_sem_t op_completed;
 222 #endif
 223   /** mbox where received packets are stored until they are fetched
 224       by the netconn application thread (can grow quite big) */
 225   sys_mbox_t recvmbox;
 226 #if LWIP_TCP
 227   /** mbox where new connections are stored until processed
 228       by the application thread */
 229   sys_mbox_t acceptmbox;
 230 #endif /* LWIP_TCP */
 231   /** only used for socket layer */
 232 #if LWIP_SOCKET
 233   int socket;
 234 #endif /* LWIP_SOCKET */
 235 #if LWIP_SO_SNDTIMEO
 236   /** timeout to wait for sending data (which means enqueueing data for sending
 237       in internal buffers) in milliseconds */
 238   s32_t send_timeout;
 239 #endif /* LWIP_SO_RCVTIMEO */
 240 #if LWIP_SO_RCVTIMEO
 241   /** timeout in milliseconds to wait for new data to be received
 242       (or connections to arrive for listening netconns) */
 243   int recv_timeout;
 244 #endif /* LWIP_SO_RCVTIMEO */
 245 #if LWIP_SO_RCVBUF
 246   /** maximum amount of bytes queued in recvmbox
 247       not used for TCP: adjust TCP_WND instead! */
 248   int recv_bufsize;
 249   /** number of bytes currently in recvmbox to be received,
 250       tested against recv_bufsize to limit bytes on recvmbox
 251       for UDP and RAW, used for FIONREAD */
 252   int recv_avail;
 253 #endif /* LWIP_SO_RCVBUF */
 254 #if LWIP_SO_LINGER
 255    /** values <0 mean linger is disabled, values > 0 are seconds to linger */
 256   s16_t linger;
 257 #endif /* LWIP_SO_LINGER */
 258   /** flags holding more netconn-internal state, see NETCONN_FLAG_* defines */
 259   u8_t flags;
 260 #if LWIP_TCP
 261   /** TCP: when data passed to netconn_write doesn't fit into the send buffer,
 262       this temporarily stores how much is already sent. */
 263   size_t write_offset;
 264   /** TCP: when data passed to netconn_write doesn't fit into the send buffer,
 265       this temporarily stores the message.
 266       Also used during connect and close. */
 267   struct api_msg *current_msg;
 268 #endif /* LWIP_TCP */
 269   /** A callback function that is informed about events for this netconn */
 270   netconn_callback callback;
 271 };
 272
 273 /** Register an Network connection event */
 274 #define API_EVENT(c,e,l) if (c->callback) {         \
 275                            (*c->callback)(c, e, l); \
 276                          }
 277
 278 /** Set conn->last_err to err but don't overwrite fatal errors */
 279 #define NETCONN_SET_SAFE_ERR(conn, err) do { if ((conn) != NULL) { \
 280   SYS_ARCH_DECL_PROTECT(netconn_set_safe_err_lev); \
 281   SYS_ARCH_PROTECT(netconn_set_safe_err_lev); \
 282   if (!ERR_IS_FATAL((conn)->last_err)) { \
 283     (conn)->last_err = err; \
 284   } \
 285   SYS_ARCH_UNPROTECT(netconn_set_safe_err_lev); \
 286 }} while(0);
 287
 288 /* Network connection functions: */
 289
 290 /** @ingroup netconn_common
 291  * Create new netconn connection
 292  * @param t @ref netconn_type */
 293 #define netconn_new(t)                  netconn_new_with_proto_and_callback(t, 0, NULL)
 294 #define netconn_new_with_callback(t, c) netconn_new_with_proto_and_callback(t, 0, c)
 295 struct netconn *netconn_new_with_proto_and_callback(enum netconn_type t, u8_t proto,
 296                                              netconn_callback callback);
 297 err_t   netconn_delete(struct netconn *conn);
 298 /** Get the type of a netconn (as enum netconn_type). */
 299 #define netconn_type(conn) (conn->type)
 300
 301 err_t   netconn_getaddr(struct netconn *conn, ip_addr_t *addr,
 302                         u16_t *port, u8_t local);
 303 /** @ingroup netconn_common */
 304 #define netconn_peer(c,i,p) netconn_getaddr(c,i,p,0)
 305 /** @ingroup netconn_common */
 306 #define netconn_addr(c,i,p) netconn_getaddr(c,i,p,1)
 307
 308 err_t   netconn_bind(struct netconn *conn, const ip_addr_t *addr, u16_t port);
 309 err_t   netconn_connect(struct netconn *conn, const ip_addr_t *addr, u16_t port);
 310 err_t   netconn_disconnect (struct netconn *conn);
 311 err_t   netconn_listen_with_backlog(struct netconn *conn, u8_t backlog);
 312 /** @ingroup netconn_tcp */
 313 #define netconn_listen(conn) netconn_listen_with_backlog(conn, TCP_DEFAULT_LISTEN_BACKLOG)
 314 err_t   netconn_accept(struct netconn *conn, struct netconn **new_conn);
 315 err_t   netconn_recv(struct netconn *conn, struct netbuf **new_buf);
 316 err_t   netconn_recv_tcp_pbuf(struct netconn *conn, struct pbuf **new_buf);
 317 err_t   netconn_sendto(struct netconn *conn, struct netbuf *buf,
 318                              const ip_addr_t *addr, u16_t port);
 319 err_t   netconn_send(struct netconn *conn, struct netbuf *buf);
 320 err_t   netconn_write_partly(struct netconn *conn, const void *dataptr, size_t size,
 321                              u8_t apiflags, size_t *bytes_written);
 322 /** @ingroup netconn_tcp */
 323 #define netconn_write(conn, dataptr, size, apiflags) \
 324           netconn_write_partly(conn, dataptr, size, apiflags, NULL)
 325 err_t   netconn_close(struct netconn *conn);
 326 err_t   netconn_shutdown(struct netconn *conn, u8_t shut_rx, u8_t shut_tx);
 327
 328 #if LWIP_IGMP || (LWIP_IPV6 && LWIP_IPV6_MLD)
 329 err_t   netconn_join_leave_group(struct netconn *conn, const ip_addr_t *multiaddr,
 330                              const ip_addr_t *netif_addr, enum netconn_igmp join_or_leave);
 331 #endif /* LWIP_IGMP || (LWIP_IPV6 && LWIP_IPV6_MLD) */
 332 #if LWIP_DNS
 333 #if LWIP_IPV4 && LWIP_IPV6
 334 err_t   netconn_gethostbyname_addrtype(const char *name, ip_addr_t *addr, u8_t dns_addrtype);
 335 #define netconn_gethostbyname(name, addr) netconn_gethostbyname_addrtype(name, addr, NETCONN_DNS_DEFAULT)
 336 #else /* LWIP_IPV4 && LWIP_IPV6 */
 337 err_t   netconn_gethostbyname(const char *name, ip_addr_t *addr);
 338 #define netconn_gethostbyname_addrtype(name, addr, dns_addrtype) netconn_gethostbyname(name, addr)
 339 #endif /* LWIP_IPV4 && LWIP_IPV6 */
 340 #endif /* LWIP_DNS */
 341
 342 #define netconn_err(conn)               ((conn)->last_err)
 343 #define netconn_recv_bufsize(conn)      ((conn)->recv_bufsize)
 344
 345 /** Set the blocking status of netconn calls (@todo: write/send is missing) */
 346 #define netconn_set_nonblocking(conn, val)  do { if(val) { \
 347   (conn)->flags |= NETCONN_FLAG_NON_BLOCKING; \
 348 } else { \
 349   (conn)->flags &= ~ NETCONN_FLAG_NON_BLOCKING; }} while(0)
 350 /** Get the blocking status of netconn calls (@todo: write/send is missing) */
 351 #define netconn_is_nonblocking(conn)        (((conn)->flags & NETCONN_FLAG_NON_BLOCKING) != 0)
 352
 353 #if LWIP_IPV6
 354 /** @ingroup netconn_common
 355  * TCP: Set the IPv6 ONLY status of netconn calls (see NETCONN_FLAG_IPV6_V6ONLY)
 356  */
 357 #define netconn_set_ipv6only(conn, val)  do { if(val) { \
 358   (conn)->flags |= NETCONN_FLAG_IPV6_V6ONLY; \
 359 } else { \
 360   (conn)->flags &= ~ NETCONN_FLAG_IPV6_V6ONLY; }} while(0)
 361 /** @ingroup netconn_common
 362  * TCP: Get the IPv6 ONLY status of netconn calls (see NETCONN_FLAG_IPV6_V6ONLY)
 363  */
 364 #define netconn_get_ipv6only(conn)        (((conn)->flags & NETCONN_FLAG_IPV6_V6ONLY) != 0)
 365 #endif /* LWIP_IPV6 */
 366
 367 #if LWIP_SO_SNDTIMEO
 368 /** Set the send timeout in milliseconds */
 369 #define netconn_set_sendtimeout(conn, timeout)      ((conn)->send_timeout = (timeout))
 370 /** Get the send timeout in milliseconds */
 371 #define netconn_get_sendtimeout(conn)               ((conn)->send_timeout)
 372 #endif /* LWIP_SO_SNDTIMEO */
 373 #if LWIP_SO_RCVTIMEO
 374 /** Set the receive timeout in milliseconds */
 375 #define netconn_set_recvtimeout(conn, timeout)      ((conn)->recv_timeout = (timeout))
 376 /** Get the receive timeout in milliseconds */
 377 #define netconn_get_recvtimeout(conn)               ((conn)->recv_timeout)
 378 #endif /* LWIP_SO_RCVTIMEO */
 379 #if LWIP_SO_RCVBUF
 380 /** Set the receive buffer in bytes */
 381 #define netconn_set_recvbufsize(conn, recvbufsize)  ((conn)->recv_bufsize = (recvbufsize))
 382 /** Get the receive buffer in bytes */
 383 #define netconn_get_recvbufsize(conn)               ((conn)->recv_bufsize)
 384 #endif /* LWIP_SO_RCVBUF*/
 385
 386 #if LWIP_NETCONN_SEM_PER_THREAD
 387 void netconn_thread_init(void);
 388 void netconn_thread_cleanup(void);
 389 #else /* LWIP_NETCONN_SEM_PER_THREAD */
 390 #define netconn_thread_init()
 391 #define netconn_thread_cleanup()
 392 #endif /* LWIP_NETCONN_SEM_PER_THREAD */
 393
 394 #ifdef __cplusplus
 395 }
 396 #endif
 397
 398 #endif /* LWIP_NETCONN || LWIP_SOCKET */
 399
 400 #endif /* LWIP_HDR_API_H */