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