xref: /btstack/3rd-party/lwip/core/src/include/lwip/sockets.h (revision 97dc5e692c7d94a280158af58036a0efee5b0e56)
1 /**
2  * @file
3  * Socket 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 <[email protected]>
35  *
36  */
37 
38 
39 #ifndef LWIP_HDR_SOCKETS_H
40 #define LWIP_HDR_SOCKETS_H
41 
42 #include "lwip/opt.h"
43 
44 #if LWIP_SOCKET_EXTERNAL_HEADERS
45 #include LWIP_SOCKET_EXTERNAL_HEADER_SOCKETS_H
46 #else /* LWIP_SOCKET_EXTERNAL_HEADERS */
47 
48 #if LWIP_SOCKET /* don't build if not configured for use in lwipopts.h */
49 
50 #include "lwip/ip_addr.h"
51 #include "lwip/netif.h"
52 #include "lwip/err.h"
53 #include "lwip/inet.h"
54 #include "lwip/errno.h"
55 
56 #include <string.h>
57 
58 #ifdef __cplusplus
59 extern "C" {
60 #endif
61 
62 /* If your port already typedef's sa_family_t, define SA_FAMILY_T_DEFINED
63    to prevent this code from redefining it. */
64 #if !defined(sa_family_t) && !defined(SA_FAMILY_T_DEFINED)
65 typedef u8_t sa_family_t;
66 #endif
67 /* If your port already typedef's in_port_t, define IN_PORT_T_DEFINED
68    to prevent this code from redefining it. */
69 #if !defined(in_port_t) && !defined(IN_PORT_T_DEFINED)
70 typedef u16_t in_port_t;
71 #endif
72 
73 #if LWIP_IPV4
74 /* members are in network byte order */
75 struct sockaddr_in {
76   u8_t            sin_len;
77   sa_family_t     sin_family;
78   in_port_t       sin_port;
79   struct in_addr  sin_addr;
80 #define SIN_ZERO_LEN 8
81   char            sin_zero[SIN_ZERO_LEN];
82 };
83 #endif /* LWIP_IPV4 */
84 
85 #if LWIP_IPV6
86 struct sockaddr_in6 {
87   u8_t            sin6_len;      /* length of this structure    */
88   sa_family_t     sin6_family;   /* AF_INET6                    */
89   in_port_t       sin6_port;     /* Transport layer port #      */
90   u32_t           sin6_flowinfo; /* IPv6 flow information       */
91   struct in6_addr sin6_addr;     /* IPv6 address                */
92   u32_t           sin6_scope_id; /* Set of interfaces for scope */
93 };
94 #endif /* LWIP_IPV6 */
95 
96 struct sockaddr {
97   u8_t        sa_len;
98   sa_family_t sa_family;
99   char        sa_data[14];
100 };
101 
102 struct sockaddr_storage {
103   u8_t        s2_len;
104   sa_family_t ss_family;
105   char        s2_data1[2];
106   u32_t       s2_data2[3];
107 #if LWIP_IPV6
108   u32_t       s2_data3[3];
109 #endif /* LWIP_IPV6 */
110 };
111 
112 /* If your port already typedef's socklen_t, define SOCKLEN_T_DEFINED
113    to prevent this code from redefining it. */
114 #if !defined(socklen_t) && !defined(SOCKLEN_T_DEFINED)
115 typedef u32_t socklen_t;
116 #endif
117 
118 #if !defined IOV_MAX
119 #define IOV_MAX 0xFFFF
120 #elif IOV_MAX > 0xFFFF
121 #error "IOV_MAX larger than supported by LwIP"
122 #endif /* IOV_MAX */
123 
124 #if !defined(iovec)
125 struct iovec {
126   void  *iov_base;
127   size_t iov_len;
128 };
129 #endif
130 
131 struct msghdr {
132   void         *msg_name;
133   socklen_t     msg_namelen;
134   struct iovec *msg_iov;
135   int           msg_iovlen;
136   void         *msg_control;
137   socklen_t     msg_controllen;
138   int           msg_flags;
139 };
140 
141 /* struct msghdr->msg_flags bit field values */
142 #define MSG_TRUNC   0x04
143 #define MSG_CTRUNC  0x08
144 
145 /* RFC 3542, Section 20: Ancillary Data */
146 struct cmsghdr {
147   socklen_t  cmsg_len;   /* number of bytes, including header */
148   int        cmsg_level; /* originating protocol */
149   int        cmsg_type;  /* protocol-specific type */
150 };
151 /* Data section follows header and possible padding, typically referred to as
152       unsigned char cmsg_data[]; */
153 
154 /* cmsg header/data alignment. NOTE: we align to native word size (double word
155 size on 16-bit arch) so structures are not placed at an unaligned address.
156 16-bit arch needs double word to ensure 32-bit alignment because socklen_t
157 could be 32 bits. If we ever have cmsg data with a 64-bit variable, alignment
158 will need to increase long long */
159 #define ALIGN_H(size) (((size) + sizeof(long) - 1U) & ~(sizeof(long)-1U))
160 #define ALIGN_D(size) ALIGN_H(size)
161 
162 #define CMSG_FIRSTHDR(mhdr) \
163           ((mhdr)->msg_controllen >= sizeof(struct cmsghdr) ? \
164            (struct cmsghdr *)(mhdr)->msg_control : \
165            (struct cmsghdr *)NULL)
166 
167 #define CMSG_NXTHDR(mhdr, cmsg) \
168         (((cmsg) == NULL) ? CMSG_FIRSTHDR(mhdr) : \
169          (((u8_t *)(cmsg) + ALIGN_H((cmsg)->cmsg_len) \
170                             + ALIGN_D(sizeof(struct cmsghdr)) > \
171            (u8_t *)((mhdr)->msg_control) + (mhdr)->msg_controllen) ? \
172           (struct cmsghdr *)NULL : \
173           (struct cmsghdr *)((void*)((u8_t *)(cmsg) + \
174                                       ALIGN_H((cmsg)->cmsg_len)))))
175 
176 #define CMSG_DATA(cmsg) ((void*)((u8_t *)(cmsg) + \
177                          ALIGN_D(sizeof(struct cmsghdr))))
178 
179 #define CMSG_SPACE(length) (ALIGN_D(sizeof(struct cmsghdr)) + \
180                             ALIGN_H(length))
181 
182 #define CMSG_LEN(length) (ALIGN_D(sizeof(struct cmsghdr)) + \
183                            length)
184 
185 /* Set socket options argument */
186 #define IFNAMSIZ NETIF_NAMESIZE
187 struct ifreq {
188   char ifr_name[IFNAMSIZ]; /* Interface name */
189 };
190 
191 /* Socket protocol types (TCP/UDP/RAW) */
192 #define SOCK_STREAM     1
193 #define SOCK_DGRAM      2
194 #define SOCK_RAW        3
195 
196 /*
197  * Option flags per-socket. These must match the SOF_ flags in ip.h (checked in init.c)
198  */
199 #define SO_REUSEADDR   0x0004 /* Allow local address reuse */
200 #define SO_KEEPALIVE   0x0008 /* keep connections alive */
201 #define SO_BROADCAST   0x0020 /* permit to send and to receive broadcast messages (see IP_SOF_BROADCAST option) */
202 
203 
204 /*
205  * Additional options, not kept in so_options.
206  */
207 #define SO_DEBUG        0x0001 /* Unimplemented: turn on debugging info recording */
208 #define SO_ACCEPTCONN   0x0002 /* socket has had listen() */
209 #define SO_DONTROUTE    0x0010 /* Unimplemented: just use interface addresses */
210 #define SO_USELOOPBACK  0x0040 /* Unimplemented: bypass hardware when possible */
211 #define SO_LINGER       0x0080 /* linger on close if data present */
212 #define SO_DONTLINGER   ((int)(~SO_LINGER))
213 #define SO_OOBINLINE    0x0100 /* Unimplemented: leave received OOB data in line */
214 #define SO_REUSEPORT    0x0200 /* Unimplemented: allow local address & port reuse */
215 #define SO_SNDBUF       0x1001 /* Unimplemented: send buffer size */
216 #define SO_RCVBUF       0x1002 /* receive buffer size */
217 #define SO_SNDLOWAT     0x1003 /* Unimplemented: send low-water mark */
218 #define SO_RCVLOWAT     0x1004 /* Unimplemented: receive low-water mark */
219 #define SO_SNDTIMEO     0x1005 /* send timeout */
220 #define SO_RCVTIMEO     0x1006 /* receive timeout */
221 #define SO_ERROR        0x1007 /* get error status and clear */
222 #define SO_TYPE         0x1008 /* get socket type */
223 #define SO_CONTIMEO     0x1009 /* Unimplemented: connect timeout */
224 #define SO_NO_CHECK     0x100a /* don't create UDP checksum */
225 #define SO_BINDTODEVICE 0x100b /* bind to device */
226 
227 /*
228  * Structure used for manipulating linger option.
229  */
230 struct linger {
231   int l_onoff;                /* option on/off */
232   int l_linger;               /* linger time in seconds */
233 };
234 
235 /*
236  * Level number for (get/set)sockopt() to apply to socket itself.
237  */
238 #define  SOL_SOCKET  0xfff    /* options for socket level */
239 
240 
241 #define AF_UNSPEC       0
242 #define AF_INET         2
243 #if LWIP_IPV6
244 #define AF_INET6        10
245 #else /* LWIP_IPV6 */
246 #define AF_INET6        AF_UNSPEC
247 #endif /* LWIP_IPV6 */
248 #define PF_INET         AF_INET
249 #define PF_INET6        AF_INET6
250 #define PF_UNSPEC       AF_UNSPEC
251 
252 #define IPPROTO_IP      0
253 #define IPPROTO_ICMP    1
254 #define IPPROTO_TCP     6
255 #define IPPROTO_UDP     17
256 #if LWIP_IPV6
257 #define IPPROTO_IPV6    41
258 #define IPPROTO_ICMPV6  58
259 #endif /* LWIP_IPV6 */
260 #define IPPROTO_UDPLITE 136
261 #define IPPROTO_RAW     255
262 
263 /* Flags we can use with send and recv. */
264 #define MSG_PEEK       0x01    /* Peeks at an incoming message */
265 #define MSG_WAITALL    0x02    /* Unimplemented: Requests that the function block until the full amount of data requested can be returned */
266 #define MSG_OOB        0x04    /* Unimplemented: Requests out-of-band data. The significance and semantics of out-of-band data are protocol-specific */
267 #define MSG_DONTWAIT   0x08    /* Nonblocking i/o for this operation only */
268 #define MSG_MORE       0x10    /* Sender will send more */
269 #define MSG_NOSIGNAL   0x20    /* Uninmplemented: Requests not to send the SIGPIPE signal if an attempt to send is made on a stream-oriented socket that is no longer connected. */
270 
271 
272 /*
273  * Options for level IPPROTO_IP
274  */
275 #define IP_TOS             1
276 #define IP_TTL             2
277 #define IP_PKTINFO         8
278 
279 #if LWIP_TCP
280 /*
281  * Options for level IPPROTO_TCP
282  */
283 #define TCP_NODELAY    0x01    /* don't delay send to coalesce packets */
284 #define TCP_KEEPALIVE  0x02    /* send KEEPALIVE probes when idle for pcb->keep_idle milliseconds */
285 #define TCP_KEEPIDLE   0x03    /* set pcb->keep_idle  - Same as TCP_KEEPALIVE, but use seconds for get/setsockopt */
286 #define TCP_KEEPINTVL  0x04    /* set pcb->keep_intvl - Use seconds for get/setsockopt */
287 #define TCP_KEEPCNT    0x05    /* set pcb->keep_cnt   - Use number of probes sent for get/setsockopt */
288 #endif /* LWIP_TCP */
289 
290 #if LWIP_IPV6
291 /*
292  * Options for level IPPROTO_IPV6
293  */
294 #define IPV6_CHECKSUM       7  /* RFC3542: calculate and insert the ICMPv6 checksum for raw sockets. */
295 #define IPV6_V6ONLY         27 /* RFC3493: boolean control to restrict AF_INET6 sockets to IPv6 communications only. */
296 #endif /* LWIP_IPV6 */
297 
298 #if LWIP_UDP && LWIP_UDPLITE
299 /*
300  * Options for level IPPROTO_UDPLITE
301  */
302 #define UDPLITE_SEND_CSCOV 0x01 /* sender checksum coverage */
303 #define UDPLITE_RECV_CSCOV 0x02 /* minimal receiver checksum coverage */
304 #endif /* LWIP_UDP && LWIP_UDPLITE*/
305 
306 
307 #if LWIP_MULTICAST_TX_OPTIONS
308 /*
309  * Options and types for UDP multicast traffic handling
310  */
311 #define IP_MULTICAST_TTL   5
312 #define IP_MULTICAST_IF    6
313 #define IP_MULTICAST_LOOP  7
314 #endif /* LWIP_MULTICAST_TX_OPTIONS */
315 
316 #if LWIP_IGMP
317 /*
318  * Options and types related to multicast membership
319  */
320 #define IP_ADD_MEMBERSHIP  3
321 #define IP_DROP_MEMBERSHIP 4
322 
323 typedef struct ip_mreq {
324     struct in_addr imr_multiaddr; /* IP multicast address of group */
325     struct in_addr imr_interface; /* local IP address of interface */
326 } ip_mreq;
327 #endif /* LWIP_IGMP */
328 
329 #if LWIP_IPV4
330 struct in_pktinfo {
331   unsigned int   ipi_ifindex;  /* Interface index */
332   struct in_addr ipi_addr;     /* Destination (from header) address */
333 };
334 #endif /* LWIP_IPV4 */
335 
336 #if LWIP_IPV6_MLD
337 /*
338  * Options and types related to IPv6 multicast membership
339  */
340 #define IPV6_JOIN_GROUP      12
341 #define IPV6_ADD_MEMBERSHIP  IPV6_JOIN_GROUP
342 #define IPV6_LEAVE_GROUP     13
343 #define IPV6_DROP_MEMBERSHIP IPV6_LEAVE_GROUP
344 
345 typedef struct ipv6_mreq {
346   struct in6_addr ipv6mr_multiaddr; /*  IPv6 multicast addr */
347   unsigned int    ipv6mr_interface; /*  interface index, or 0 */
348 } ipv6_mreq;
349 #endif /* LWIP_IPV6_MLD */
350 
351 /*
352  * The Type of Service provides an indication of the abstract
353  * parameters of the quality of service desired.  These parameters are
354  * to be used to guide the selection of the actual service parameters
355  * when transmitting a datagram through a particular network.  Several
356  * networks offer service precedence, which somehow treats high
357  * precedence traffic as more important than other traffic (generally
358  * by accepting only traffic above a certain precedence at time of high
359  * load).  The major choice is a three way tradeoff between low-delay,
360  * high-reliability, and high-throughput.
361  * The use of the Delay, Throughput, and Reliability indications may
362  * increase the cost (in some sense) of the service.  In many networks
363  * better performance for one of these parameters is coupled with worse
364  * performance on another.  Except for very unusual cases at most two
365  * of these three indications should be set.
366  */
367 #define IPTOS_TOS_MASK          0x1E
368 #define IPTOS_TOS(tos)          ((tos) & IPTOS_TOS_MASK)
369 #define IPTOS_LOWDELAY          0x10
370 #define IPTOS_THROUGHPUT        0x08
371 #define IPTOS_RELIABILITY       0x04
372 #define IPTOS_LOWCOST           0x02
373 #define IPTOS_MINCOST           IPTOS_LOWCOST
374 
375 /*
376  * The Network Control precedence designation is intended to be used
377  * within a network only.  The actual use and control of that
378  * designation is up to each network. The Internetwork Control
379  * designation is intended for use by gateway control originators only.
380  * If the actual use of these precedence designations is of concern to
381  * a particular network, it is the responsibility of that network to
382  * control the access to, and use of, those precedence designations.
383  */
384 #define IPTOS_PREC_MASK                 0xe0
385 #define IPTOS_PREC(tos)                ((tos) & IPTOS_PREC_MASK)
386 #define IPTOS_PREC_NETCONTROL           0xe0
387 #define IPTOS_PREC_INTERNETCONTROL      0xc0
388 #define IPTOS_PREC_CRITIC_ECP           0xa0
389 #define IPTOS_PREC_FLASHOVERRIDE        0x80
390 #define IPTOS_PREC_FLASH                0x60
391 #define IPTOS_PREC_IMMEDIATE            0x40
392 #define IPTOS_PREC_PRIORITY             0x20
393 #define IPTOS_PREC_ROUTINE              0x00
394 
395 
396 /*
397  * Commands for ioctlsocket(),  taken from the BSD file fcntl.h.
398  * lwip_ioctl only supports FIONREAD and FIONBIO, for now
399  *
400  * Ioctl's have the command encoded in the lower word,
401  * and the size of any in or out parameters in the upper
402  * word.  The high 2 bits of the upper word are used
403  * to encode the in/out status of the parameter; for now
404  * we restrict parameters to at most 128 bytes.
405  */
406 #if !defined(FIONREAD) || !defined(FIONBIO)
407 #define IOCPARM_MASK    0x7fU           /* parameters must be < 128 bytes */
408 #define IOC_VOID        0x20000000UL    /* no parameters */
409 #define IOC_OUT         0x40000000UL    /* copy out parameters */
410 #define IOC_IN          0x80000000UL    /* copy in parameters */
411 #define IOC_INOUT       (IOC_IN|IOC_OUT)
412                                         /* 0x20000000 distinguishes new &
413                                            old ioctl's */
414 #define _IO(x,y)        ((long)(IOC_VOID|((x)<<8)|(y)))
415 
416 #define _IOR(x,y,t)     ((long)(IOC_OUT|((sizeof(t)&IOCPARM_MASK)<<16)|((x)<<8)|(y)))
417 
418 #define _IOW(x,y,t)     ((long)(IOC_IN|((sizeof(t)&IOCPARM_MASK)<<16)|((x)<<8)|(y)))
419 #endif /* !defined(FIONREAD) || !defined(FIONBIO) */
420 
421 #ifndef FIONREAD
422 #define FIONREAD    _IOR('f', 127, unsigned long) /* get # bytes to read */
423 #endif
424 #ifndef FIONBIO
425 #define FIONBIO     _IOW('f', 126, unsigned long) /* set/clear non-blocking i/o */
426 #endif
427 
428 /* Socket I/O Controls: unimplemented */
429 #ifndef SIOCSHIWAT
430 #define SIOCSHIWAT  _IOW('s',  0, unsigned long)  /* set high watermark */
431 #define SIOCGHIWAT  _IOR('s',  1, unsigned long)  /* get high watermark */
432 #define SIOCSLOWAT  _IOW('s',  2, unsigned long)  /* set low watermark */
433 #define SIOCGLOWAT  _IOR('s',  3, unsigned long)  /* get low watermark */
434 #define SIOCATMARK  _IOR('s',  7, unsigned long)  /* at oob mark? */
435 #endif
436 
437 /* commands for fnctl */
438 #ifndef F_GETFL
439 #define F_GETFL 3
440 #endif
441 #ifndef F_SETFL
442 #define F_SETFL 4
443 #endif
444 
445 /* File status flags and file access modes for fnctl,
446    these are bits in an int. */
447 #ifndef O_NONBLOCK
448 #define O_NONBLOCK  1 /* nonblocking I/O */
449 #endif
450 #ifndef O_NDELAY
451 #define O_NDELAY    O_NONBLOCK /* same as O_NONBLOCK, for compatibility */
452 #endif
453 #ifndef O_RDONLY
454 #define O_RDONLY    2
455 #endif
456 #ifndef O_WRONLY
457 #define O_WRONLY    4
458 #endif
459 #ifndef O_RDWR
460 #define O_RDWR      (O_RDONLY|O_WRONLY)
461 #endif
462 
463 #ifndef SHUT_RD
464   #define SHUT_RD   0
465   #define SHUT_WR   1
466   #define SHUT_RDWR 2
467 #endif
468 
469 /* FD_SET used for lwip_select */
470 #ifndef FD_SET
471 #undef  FD_SETSIZE
472 /* Make FD_SETSIZE match NUM_SOCKETS in socket.c */
473 #define FD_SETSIZE    MEMP_NUM_NETCONN
474 #define LWIP_SELECT_MAXNFDS (FD_SETSIZE + LWIP_SOCKET_OFFSET)
475 #define FDSETSAFESET(n, code) do { \
476   if (((n) - LWIP_SOCKET_OFFSET < MEMP_NUM_NETCONN) && (((int)(n) - LWIP_SOCKET_OFFSET) >= 0)) { \
477   code; }} while(0)
478 #define FDSETSAFEGET(n, code) (((n) - LWIP_SOCKET_OFFSET < MEMP_NUM_NETCONN) && (((int)(n) - LWIP_SOCKET_OFFSET) >= 0) ?\
479   (code) : 0)
480 #define FD_SET(n, p)  FDSETSAFESET(n, (p)->fd_bits[((n)-LWIP_SOCKET_OFFSET)/8] = (u8_t)((p)->fd_bits[((n)-LWIP_SOCKET_OFFSET)/8] |  (1 << (((n)-LWIP_SOCKET_OFFSET) & 7))))
481 #define FD_CLR(n, p)  FDSETSAFESET(n, (p)->fd_bits[((n)-LWIP_SOCKET_OFFSET)/8] = (u8_t)((p)->fd_bits[((n)-LWIP_SOCKET_OFFSET)/8] & ~(1 << (((n)-LWIP_SOCKET_OFFSET) & 7))))
482 #define FD_ISSET(n,p) FDSETSAFEGET(n, (p)->fd_bits[((n)-LWIP_SOCKET_OFFSET)/8] &   (1 << (((n)-LWIP_SOCKET_OFFSET) & 7)))
483 #define FD_ZERO(p)    memset((void*)(p), 0, sizeof(*(p)))
484 
485 typedef struct fd_set
486 {
487   unsigned char fd_bits [(FD_SETSIZE+7)/8];
488 } fd_set;
489 
490 #elif FD_SETSIZE < (LWIP_SOCKET_OFFSET + MEMP_NUM_NETCONN)
491 #error "external FD_SETSIZE too small for number of sockets"
492 #else
493 #define LWIP_SELECT_MAXNFDS FD_SETSIZE
494 #endif /* FD_SET */
495 
496 /* poll-related defines and types */
497 /* @todo: find a better way to guard the definition of these defines and types if already defined */
498 #if !defined(POLLIN) && !defined(POLLOUT)
499 #define POLLIN     0x1
500 #define POLLOUT    0x2
501 #define POLLERR    0x4
502 #define POLLNVAL   0x8
503 /* Below values are unimplemented */
504 #define POLLRDNORM 0x10
505 #define POLLRDBAND 0x20
506 #define POLLPRI    0x40
507 #define POLLWRNORM 0x80
508 #define POLLWRBAND 0x100
509 #define POLLHUP    0x200
510 typedef unsigned int nfds_t;
511 struct pollfd
512 {
513   int fd;
514   short events;
515   short revents;
516 };
517 #endif
518 
519 /** LWIP_TIMEVAL_PRIVATE: if you want to use the struct timeval provided
520  * by your system, set this to 0 and include <sys/time.h> in cc.h */
521 #ifndef LWIP_TIMEVAL_PRIVATE
522 #define LWIP_TIMEVAL_PRIVATE 1
523 #endif
524 
525 #if LWIP_TIMEVAL_PRIVATE
526 struct timeval {
527   long    tv_sec;         /* seconds */
528   long    tv_usec;        /* and microseconds */
529 };
530 #endif /* LWIP_TIMEVAL_PRIVATE */
531 
532 #define lwip_socket_init() /* Compatibility define, no init needed. */
533 void lwip_socket_thread_init(void); /* LWIP_NETCONN_SEM_PER_THREAD==1: initialize thread-local semaphore */
534 void lwip_socket_thread_cleanup(void); /* LWIP_NETCONN_SEM_PER_THREAD==1: destroy thread-local semaphore */
535 
536 #if LWIP_COMPAT_SOCKETS == 2
537 /* This helps code parsers/code completion by not having the COMPAT functions as defines */
538 #define lwip_accept       accept
539 #define lwip_bind         bind
540 #define lwip_shutdown     shutdown
541 #define lwip_getpeername  getpeername
542 #define lwip_getsockname  getsockname
543 #define lwip_setsockopt   setsockopt
544 #define lwip_getsockopt   getsockopt
545 #define lwip_close        closesocket
546 #define lwip_connect      connect
547 #define lwip_listen       listen
548 #define lwip_recv         recv
549 #define lwip_recvmsg      recvmsg
550 #define lwip_recvfrom     recvfrom
551 #define lwip_send         send
552 #define lwip_sendmsg      sendmsg
553 #define lwip_sendto       sendto
554 #define lwip_socket       socket
555 #if LWIP_SOCKET_SELECT
556 #define lwip_select       select
557 #endif
558 #if LWIP_SOCKET_POLL
559 #define lwip_poll         poll
560 #endif
561 #define lwip_ioctl        ioctlsocket
562 #define lwip_inet_ntop    inet_ntop
563 #define lwip_inet_pton    inet_pton
564 
565 #if LWIP_POSIX_SOCKETS_IO_NAMES
566 #define lwip_read         read
567 #define lwip_readv        readv
568 #define lwip_write        write
569 #define lwip_writev       writev
570 #undef lwip_close
571 #define lwip_close        close
572 #define closesocket(s)    close(s)
573 int fcntl(int s, int cmd, ...);
574 #undef lwip_ioctl
575 #define lwip_ioctl        ioctl
576 #define ioctlsocket       ioctl
577 #endif /* LWIP_POSIX_SOCKETS_IO_NAMES */
578 #endif /* LWIP_COMPAT_SOCKETS == 2 */
579 
580 int lwip_accept(int s, struct sockaddr *addr, socklen_t *addrlen);
581 int lwip_bind(int s, const struct sockaddr *name, socklen_t namelen);
582 int lwip_shutdown(int s, int how);
583 int lwip_getpeername (int s, struct sockaddr *name, socklen_t *namelen);
584 int lwip_getsockname (int s, struct sockaddr *name, socklen_t *namelen);
585 int lwip_getsockopt (int s, int level, int optname, void *optval, socklen_t *optlen);
586 int lwip_setsockopt (int s, int level, int optname, const void *optval, socklen_t optlen);
587  int lwip_close(int s);
588 int lwip_connect(int s, const struct sockaddr *name, socklen_t namelen);
589 int lwip_listen(int s, int backlog);
590 ssize_t lwip_recv(int s, void *mem, size_t len, int flags);
591 ssize_t lwip_read(int s, void *mem, size_t len);
592 ssize_t lwip_readv(int s, const struct iovec *iov, int iovcnt);
593 ssize_t lwip_recvfrom(int s, void *mem, size_t len, int flags,
594       struct sockaddr *from, socklen_t *fromlen);
595 ssize_t lwip_recvmsg(int s, struct msghdr *message, int flags);
596 ssize_t lwip_send(int s, const void *dataptr, size_t size, int flags);
597 ssize_t lwip_sendmsg(int s, const struct msghdr *message, int flags);
598 ssize_t lwip_sendto(int s, const void *dataptr, size_t size, int flags,
599     const struct sockaddr *to, socklen_t tolen);
600 int lwip_socket(int domain, int type, int protocol);
601 ssize_t lwip_write(int s, const void *dataptr, size_t size);
602 ssize_t lwip_writev(int s, const struct iovec *iov, int iovcnt);
603 #if LWIP_SOCKET_SELECT
604 int lwip_select(int maxfdp1, fd_set *readset, fd_set *writeset, fd_set *exceptset,
605                 struct timeval *timeout);
606 #endif
607 #if LWIP_SOCKET_POLL
608 int lwip_poll(struct pollfd *fds, nfds_t nfds, int timeout);
609 #endif
610 int lwip_ioctl(int s, long cmd, void *argp);
611 int lwip_fcntl(int s, int cmd, int val);
612 const char *lwip_inet_ntop(int af, const void *src, char *dst, socklen_t size);
613 int lwip_inet_pton(int af, const char *src, void *dst);
614 
615 #if LWIP_COMPAT_SOCKETS
616 #if LWIP_COMPAT_SOCKETS != 2
617 /** @ingroup socket */
618 #define accept(s,addr,addrlen)                    lwip_accept(s,addr,addrlen)
619 /** @ingroup socket */
620 #define bind(s,name,namelen)                      lwip_bind(s,name,namelen)
621 /** @ingroup socket */
622 #define shutdown(s,how)                           lwip_shutdown(s,how)
623 /** @ingroup socket */
624 #define getpeername(s,name,namelen)               lwip_getpeername(s,name,namelen)
625 /** @ingroup socket */
626 #define getsockname(s,name,namelen)               lwip_getsockname(s,name,namelen)
627 /** @ingroup socket */
628 #define setsockopt(s,level,optname,opval,optlen)  lwip_setsockopt(s,level,optname,opval,optlen)
629 /** @ingroup socket */
630 #define getsockopt(s,level,optname,opval,optlen)  lwip_getsockopt(s,level,optname,opval,optlen)
631 /** @ingroup socket */
632 #define closesocket(s)                            lwip_close(s)
633 /** @ingroup socket */
634 #define connect(s,name,namelen)                   lwip_connect(s,name,namelen)
635 /** @ingroup socket */
636 #define listen(s,backlog)                         lwip_listen(s,backlog)
637 /** @ingroup socket */
638 #define recv(s,mem,len,flags)                     lwip_recv(s,mem,len,flags)
639 /** @ingroup socket */
640 #define recvmsg(s,message,flags)                  lwip_recvmsg(s,message,flags)
641 /** @ingroup socket */
642 #define recvfrom(s,mem,len,flags,from,fromlen)    lwip_recvfrom(s,mem,len,flags,from,fromlen)
643 /** @ingroup socket */
644 #define send(s,dataptr,size,flags)                lwip_send(s,dataptr,size,flags)
645 /** @ingroup socket */
646 #define sendmsg(s,message,flags)                  lwip_sendmsg(s,message,flags)
647 /** @ingroup socket */
648 #define sendto(s,dataptr,size,flags,to,tolen)     lwip_sendto(s,dataptr,size,flags,to,tolen)
649 /** @ingroup socket */
650 #define socket(domain,type,protocol)              lwip_socket(domain,type,protocol)
651 #if LWIP_SOCKET_SELECT
652 /** @ingroup socket */
653 #define select(maxfdp1,readset,writeset,exceptset,timeout)     lwip_select(maxfdp1,readset,writeset,exceptset,timeout)
654 #endif
655 #if LWIP_SOCKET_POLL
656 /** @ingroup socket */
657 #define poll(fds,nfds,timeout)                    lwip_poll(fds,nfds,timeout)
658 #endif
659 /** @ingroup socket */
660 #define ioctlsocket(s,cmd,argp)                   lwip_ioctl(s,cmd,argp)
661 /** @ingroup socket */
662 #define inet_ntop(af,src,dst,size)                lwip_inet_ntop(af,src,dst,size)
663 /** @ingroup socket */
664 #define inet_pton(af,src,dst)                     lwip_inet_pton(af,src,dst)
665 
666 #if LWIP_POSIX_SOCKETS_IO_NAMES
667 /** @ingroup socket */
668 #define read(s,mem,len)                           lwip_read(s,mem,len)
669 /** @ingroup socket */
670 #define readv(s,iov,iovcnt)                       lwip_readv(s,iov,iovcnt)
671 /** @ingroup socket */
672 #define write(s,dataptr,len)                      lwip_write(s,dataptr,len)
673 /** @ingroup socket */
674 #define writev(s,iov,iovcnt)                      lwip_writev(s,iov,iovcnt)
675 /** @ingroup socket */
676 #define close(s)                                  lwip_close(s)
677 /** @ingroup socket */
678 #define fcntl(s,cmd,val)                          lwip_fcntl(s,cmd,val)
679 /** @ingroup socket */
680 #define ioctl(s,cmd,argp)                         lwip_ioctl(s,cmd,argp)
681 #endif /* LWIP_POSIX_SOCKETS_IO_NAMES */
682 #endif /* LWIP_COMPAT_SOCKETS != 2 */
683 
684 #endif /* LWIP_COMPAT_SOCKETS */
685 
686 #ifdef __cplusplus
687 }
688 #endif
689 
690 #endif /* LWIP_SOCKET */
691 
692 #endif /* LWIP_SOCKET_EXTERNAL_HEADERS */
693 
694 #endif /* LWIP_HDR_SOCKETS_H */
695