xref: /nrf52832-nimble/rt-thread/components/net/lwip-2.0.2/src/include/lwip/sockets.h (revision 104654410c56c573564690304ae786df310c91fc)
1*10465441SEvalZero /**
2*10465441SEvalZero  * @file
3*10465441SEvalZero  * Socket API (to be used from non-TCPIP threads)
4*10465441SEvalZero  */
5*10465441SEvalZero 
6*10465441SEvalZero /*
7*10465441SEvalZero  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
8*10465441SEvalZero  * All rights reserved.
9*10465441SEvalZero  *
10*10465441SEvalZero  * Redistribution and use in source and binary forms, with or without modification,
11*10465441SEvalZero  * are permitted provided that the following conditions are met:
12*10465441SEvalZero  *
13*10465441SEvalZero  * 1. Redistributions of source code must retain the above copyright notice,
14*10465441SEvalZero  *    this list of conditions and the following disclaimer.
15*10465441SEvalZero  * 2. Redistributions in binary form must reproduce the above copyright notice,
16*10465441SEvalZero  *    this list of conditions and the following disclaimer in the documentation
17*10465441SEvalZero  *    and/or other materials provided with the distribution.
18*10465441SEvalZero  * 3. The name of the author may not be used to endorse or promote products
19*10465441SEvalZero  *    derived from this software without specific prior written permission.
20*10465441SEvalZero  *
21*10465441SEvalZero  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
22*10465441SEvalZero  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
23*10465441SEvalZero  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
24*10465441SEvalZero  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25*10465441SEvalZero  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
26*10465441SEvalZero  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27*10465441SEvalZero  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28*10465441SEvalZero  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
29*10465441SEvalZero  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
30*10465441SEvalZero  * OF SUCH DAMAGE.
31*10465441SEvalZero  *
32*10465441SEvalZero  * This file is part of the lwIP TCP/IP stack.
33*10465441SEvalZero  *
34*10465441SEvalZero  * Author: Adam Dunkels <[email protected]>
35*10465441SEvalZero  *
36*10465441SEvalZero  */
37*10465441SEvalZero 
38*10465441SEvalZero 
39*10465441SEvalZero #ifndef LWIP_HDR_SOCKETS_H
40*10465441SEvalZero #define LWIP_HDR_SOCKETS_H
41*10465441SEvalZero 
42*10465441SEvalZero #include "lwip/opt.h"
43*10465441SEvalZero 
44*10465441SEvalZero #if LWIP_SOCKET /* don't build if not configured for use in lwipopts.h */
45*10465441SEvalZero 
46*10465441SEvalZero #include "lwip/ip_addr.h"
47*10465441SEvalZero #include "lwip/err.h"
48*10465441SEvalZero #include "lwip/inet.h"
49*10465441SEvalZero #include "lwip/errno.h"
50*10465441SEvalZero 
51*10465441SEvalZero #ifdef __cplusplus
52*10465441SEvalZero extern "C" {
53*10465441SEvalZero #endif
54*10465441SEvalZero 
55*10465441SEvalZero /* If your port already typedef's sa_family_t, define SA_FAMILY_T_DEFINED
56*10465441SEvalZero    to prevent this code from redefining it. */
57*10465441SEvalZero #if !defined(sa_family_t) && !defined(SA_FAMILY_T_DEFINED)
58*10465441SEvalZero typedef u8_t sa_family_t;
59*10465441SEvalZero #endif
60*10465441SEvalZero /* If your port already typedef's in_port_t, define IN_PORT_T_DEFINED
61*10465441SEvalZero    to prevent this code from redefining it. */
62*10465441SEvalZero #if !defined(in_port_t) && !defined(IN_PORT_T_DEFINED)
63*10465441SEvalZero typedef u16_t in_port_t;
64*10465441SEvalZero #endif
65*10465441SEvalZero 
66*10465441SEvalZero #if LWIP_IPV4
67*10465441SEvalZero /* members are in network byte order */
68*10465441SEvalZero struct sockaddr_in {
69*10465441SEvalZero   u8_t            sin_len;
70*10465441SEvalZero   sa_family_t     sin_family;
71*10465441SEvalZero   in_port_t       sin_port;
72*10465441SEvalZero   struct in_addr  sin_addr;
73*10465441SEvalZero #define SIN_ZERO_LEN 8
74*10465441SEvalZero   char            sin_zero[SIN_ZERO_LEN];
75*10465441SEvalZero };
76*10465441SEvalZero #endif /* LWIP_IPV4 */
77*10465441SEvalZero 
78*10465441SEvalZero #if LWIP_IPV6
79*10465441SEvalZero struct sockaddr_in6 {
80*10465441SEvalZero   u8_t            sin6_len;      /* length of this structure    */
81*10465441SEvalZero   sa_family_t     sin6_family;   /* AF_INET6                    */
82*10465441SEvalZero   in_port_t       sin6_port;     /* Transport layer port #      */
83*10465441SEvalZero   u32_t           sin6_flowinfo; /* IPv6 flow information       */
84*10465441SEvalZero   struct in6_addr sin6_addr;     /* IPv6 address                */
85*10465441SEvalZero   u32_t           sin6_scope_id; /* Set of interfaces for scope */
86*10465441SEvalZero };
87*10465441SEvalZero #endif /* LWIP_IPV6 */
88*10465441SEvalZero 
89*10465441SEvalZero struct sockaddr {
90*10465441SEvalZero   u8_t        sa_len;
91*10465441SEvalZero   sa_family_t sa_family;
92*10465441SEvalZero   char        sa_data[14];
93*10465441SEvalZero };
94*10465441SEvalZero 
95*10465441SEvalZero struct sockaddr_storage {
96*10465441SEvalZero   u8_t        s2_len;
97*10465441SEvalZero   sa_family_t ss_family;
98*10465441SEvalZero   char        s2_data1[2];
99*10465441SEvalZero   u32_t       s2_data2[3];
100*10465441SEvalZero #if LWIP_IPV6
101*10465441SEvalZero   u32_t       s2_data3[3];
102*10465441SEvalZero #endif /* LWIP_IPV6 */
103*10465441SEvalZero };
104*10465441SEvalZero 
105*10465441SEvalZero /* If your port already typedef's socklen_t, define SOCKLEN_T_DEFINED
106*10465441SEvalZero    to prevent this code from redefining it. */
107*10465441SEvalZero #if !defined(socklen_t) && !defined(SOCKLEN_T_DEFINED)
108*10465441SEvalZero typedef u32_t socklen_t;
109*10465441SEvalZero #endif
110*10465441SEvalZero 
111*10465441SEvalZero struct lwip_sock;
112*10465441SEvalZero 
113*10465441SEvalZero #if !LWIP_TCPIP_CORE_LOCKING
114*10465441SEvalZero /** Maximum optlen used by setsockopt/getsockopt */
115*10465441SEvalZero #define LWIP_SETGETSOCKOPT_MAXOPTLEN 16
116*10465441SEvalZero 
117*10465441SEvalZero /** This struct is used to pass data to the set/getsockopt_internal
118*10465441SEvalZero  * functions running in tcpip_thread context (only a void* is allowed) */
119*10465441SEvalZero struct lwip_setgetsockopt_data {
120*10465441SEvalZero   /** socket index for which to change options */
121*10465441SEvalZero   int s;
122*10465441SEvalZero   /** level of the option to process */
123*10465441SEvalZero   int level;
124*10465441SEvalZero   /** name of the option to process */
125*10465441SEvalZero   int optname;
126*10465441SEvalZero   /** set: value to set the option to
127*10465441SEvalZero     * get: value of the option is stored here */
128*10465441SEvalZero #if LWIP_MPU_COMPATIBLE
129*10465441SEvalZero   u8_t optval[LWIP_SETGETSOCKOPT_MAXOPTLEN];
130*10465441SEvalZero #else
131*10465441SEvalZero   union {
132*10465441SEvalZero      void *p;
133*10465441SEvalZero      const void *pc;
134*10465441SEvalZero   } optval;
135*10465441SEvalZero #endif
136*10465441SEvalZero   /** size of *optval */
137*10465441SEvalZero   socklen_t optlen;
138*10465441SEvalZero   /** if an error occurs, it is temporarily stored here */
139*10465441SEvalZero   err_t err;
140*10465441SEvalZero   /** semaphore to wake up the calling task */
141*10465441SEvalZero   void* completed_sem;
142*10465441SEvalZero };
143*10465441SEvalZero #endif /* !LWIP_TCPIP_CORE_LOCKING */
144*10465441SEvalZero 
145*10465441SEvalZero #if !defined(iovec)
146*10465441SEvalZero struct iovec {
147*10465441SEvalZero   void  *iov_base;
148*10465441SEvalZero   size_t iov_len;
149*10465441SEvalZero };
150*10465441SEvalZero #endif
151*10465441SEvalZero 
152*10465441SEvalZero struct msghdr {
153*10465441SEvalZero   void         *msg_name;
154*10465441SEvalZero   socklen_t     msg_namelen;
155*10465441SEvalZero   struct iovec *msg_iov;
156*10465441SEvalZero   int           msg_iovlen;
157*10465441SEvalZero   void         *msg_control;
158*10465441SEvalZero   socklen_t     msg_controllen;
159*10465441SEvalZero   int           msg_flags;
160*10465441SEvalZero };
161*10465441SEvalZero 
162*10465441SEvalZero /* Socket protocol types (TCP/UDP/RAW) */
163*10465441SEvalZero #define SOCK_STREAM     1
164*10465441SEvalZero #define SOCK_DGRAM      2
165*10465441SEvalZero #define SOCK_RAW        3
166*10465441SEvalZero 
167*10465441SEvalZero /*
168*10465441SEvalZero  * Option flags per-socket. These must match the SOF_ flags in ip.h (checked in init.c)
169*10465441SEvalZero  */
170*10465441SEvalZero #define SO_REUSEADDR   0x0004 /* Allow local address reuse */
171*10465441SEvalZero #define SO_KEEPALIVE   0x0008 /* keep connections alive */
172*10465441SEvalZero #define SO_BROADCAST   0x0020 /* permit to send and to receive broadcast messages (see IP_SOF_BROADCAST option) */
173*10465441SEvalZero 
174*10465441SEvalZero 
175*10465441SEvalZero /*
176*10465441SEvalZero  * Additional options, not kept in so_options.
177*10465441SEvalZero  */
178*10465441SEvalZero #define SO_DEBUG       0x0001 /* Unimplemented: turn on debugging info recording */
179*10465441SEvalZero #define SO_ACCEPTCONN  0x0002 /* socket has had listen() */
180*10465441SEvalZero #define SO_DONTROUTE   0x0010 /* Unimplemented: just use interface addresses */
181*10465441SEvalZero #define SO_USELOOPBACK 0x0040 /* Unimplemented: bypass hardware when possible */
182*10465441SEvalZero #define SO_LINGER      0x0080 /* linger on close if data present */
183*10465441SEvalZero #define SO_DONTLINGER  ((int)(~SO_LINGER))
184*10465441SEvalZero #define SO_OOBINLINE   0x0100 /* Unimplemented: leave received OOB data in line */
185*10465441SEvalZero #define SO_REUSEPORT   0x0200 /* Unimplemented: allow local address & port reuse */
186*10465441SEvalZero #define SO_SNDBUF      0x1001 /* Unimplemented: send buffer size */
187*10465441SEvalZero #define SO_RCVBUF      0x1002 /* receive buffer size */
188*10465441SEvalZero #define SO_SNDLOWAT    0x1003 /* Unimplemented: send low-water mark */
189*10465441SEvalZero #define SO_RCVLOWAT    0x1004 /* Unimplemented: receive low-water mark */
190*10465441SEvalZero #define SO_SNDTIMEO    0x1005 /* send timeout */
191*10465441SEvalZero #define SO_RCVTIMEO    0x1006 /* receive timeout */
192*10465441SEvalZero #define SO_ERROR       0x1007 /* get error status and clear */
193*10465441SEvalZero #define SO_TYPE        0x1008 /* get socket type */
194*10465441SEvalZero #define SO_CONTIMEO    0x1009 /* Unimplemented: connect timeout */
195*10465441SEvalZero #define SO_NO_CHECK    0x100a /* don't create UDP checksum */
196*10465441SEvalZero 
197*10465441SEvalZero 
198*10465441SEvalZero /*
199*10465441SEvalZero  * Structure used for manipulating linger option.
200*10465441SEvalZero  */
201*10465441SEvalZero struct linger {
202*10465441SEvalZero        int l_onoff;                /* option on/off */
203*10465441SEvalZero        int l_linger;               /* linger time in seconds */
204*10465441SEvalZero };
205*10465441SEvalZero 
206*10465441SEvalZero /*
207*10465441SEvalZero  * Level number for (get/set)sockopt() to apply to socket itself.
208*10465441SEvalZero  */
209*10465441SEvalZero #define  SOL_SOCKET  0xfff    /* options for socket level */
210*10465441SEvalZero 
211*10465441SEvalZero 
212*10465441SEvalZero #define AF_UNSPEC       0
213*10465441SEvalZero #define AF_INET         2
214*10465441SEvalZero #if LWIP_IPV6
215*10465441SEvalZero #define AF_INET6        10
216*10465441SEvalZero #else /* LWIP_IPV6 */
217*10465441SEvalZero #define AF_INET6        AF_UNSPEC
218*10465441SEvalZero #endif /* LWIP_IPV6 */
219*10465441SEvalZero #define PF_INET         AF_INET
220*10465441SEvalZero #define PF_INET6        AF_INET6
221*10465441SEvalZero #define PF_UNSPEC       AF_UNSPEC
222*10465441SEvalZero 
223*10465441SEvalZero #define IPPROTO_IP      0
224*10465441SEvalZero #define IPPROTO_ICMP    1
225*10465441SEvalZero #define IPPROTO_TCP     6
226*10465441SEvalZero #define IPPROTO_UDP     17
227*10465441SEvalZero #if LWIP_IPV6
228*10465441SEvalZero #define IPPROTO_IPV6    41
229*10465441SEvalZero #define IPPROTO_ICMPV6  58
230*10465441SEvalZero #endif /* LWIP_IPV6 */
231*10465441SEvalZero #define IPPROTO_UDPLITE 136
232*10465441SEvalZero #define IPPROTO_RAW     255
233*10465441SEvalZero 
234*10465441SEvalZero /* Flags we can use with send and recv. */
235*10465441SEvalZero #define MSG_PEEK       0x01    /* Peeks at an incoming message */
236*10465441SEvalZero #define MSG_WAITALL    0x02    /* Unimplemented: Requests that the function block until the full amount of data requested can be returned */
237*10465441SEvalZero #define MSG_OOB        0x04    /* Unimplemented: Requests out-of-band data. The significance and semantics of out-of-band data are protocol-specific */
238*10465441SEvalZero #define MSG_DONTWAIT   0x08    /* Nonblocking i/o for this operation only */
239*10465441SEvalZero #define MSG_MORE       0x10    /* Sender will send more */
240*10465441SEvalZero 
241*10465441SEvalZero 
242*10465441SEvalZero /*
243*10465441SEvalZero  * Options for level IPPROTO_IP
244*10465441SEvalZero  */
245*10465441SEvalZero #define IP_TOS             1
246*10465441SEvalZero #define IP_TTL             2
247*10465441SEvalZero 
248*10465441SEvalZero #if LWIP_TCP
249*10465441SEvalZero /*
250*10465441SEvalZero  * Options for level IPPROTO_TCP
251*10465441SEvalZero  */
252*10465441SEvalZero #define TCP_NODELAY    0x01    /* don't delay send to coalesce packets */
253*10465441SEvalZero #define TCP_KEEPALIVE  0x02    /* send KEEPALIVE probes when idle for pcb->keep_idle milliseconds */
254*10465441SEvalZero #define TCP_KEEPIDLE   0x03    /* set pcb->keep_idle  - Same as TCP_KEEPALIVE, but use seconds for get/setsockopt */
255*10465441SEvalZero #define TCP_KEEPINTVL  0x04    /* set pcb->keep_intvl - Use seconds for get/setsockopt */
256*10465441SEvalZero #define TCP_KEEPCNT    0x05    /* set pcb->keep_cnt   - Use number of probes sent for get/setsockopt */
257*10465441SEvalZero #endif /* LWIP_TCP */
258*10465441SEvalZero 
259*10465441SEvalZero #if LWIP_IPV6
260*10465441SEvalZero /*
261*10465441SEvalZero  * Options for level IPPROTO_IPV6
262*10465441SEvalZero  */
263*10465441SEvalZero #define IPV6_CHECKSUM       7  /* RFC3542: calculate and insert the ICMPv6 checksum for raw sockets. */
264*10465441SEvalZero #define IPV6_V6ONLY         27 /* RFC3493: boolean control to restrict AF_INET6 sockets to IPv6 communications only. */
265*10465441SEvalZero #endif /* LWIP_IPV6 */
266*10465441SEvalZero 
267*10465441SEvalZero #if LWIP_UDP && LWIP_UDPLITE
268*10465441SEvalZero /*
269*10465441SEvalZero  * Options for level IPPROTO_UDPLITE
270*10465441SEvalZero  */
271*10465441SEvalZero #define UDPLITE_SEND_CSCOV 0x01 /* sender checksum coverage */
272*10465441SEvalZero #define UDPLITE_RECV_CSCOV 0x02 /* minimal receiver checksum coverage */
273*10465441SEvalZero #endif /* LWIP_UDP && LWIP_UDPLITE*/
274*10465441SEvalZero 
275*10465441SEvalZero 
276*10465441SEvalZero #if LWIP_MULTICAST_TX_OPTIONS
277*10465441SEvalZero /*
278*10465441SEvalZero  * Options and types for UDP multicast traffic handling
279*10465441SEvalZero  */
280*10465441SEvalZero #define IP_MULTICAST_TTL   5
281*10465441SEvalZero #define IP_MULTICAST_IF    6
282*10465441SEvalZero #define IP_MULTICAST_LOOP  7
283*10465441SEvalZero #endif /* LWIP_MULTICAST_TX_OPTIONS */
284*10465441SEvalZero 
285*10465441SEvalZero #if LWIP_IGMP
286*10465441SEvalZero /*
287*10465441SEvalZero  * Options and types related to multicast membership
288*10465441SEvalZero  */
289*10465441SEvalZero #define IP_ADD_MEMBERSHIP  3
290*10465441SEvalZero #define IP_DROP_MEMBERSHIP 4
291*10465441SEvalZero 
292*10465441SEvalZero typedef struct ip_mreq {
293*10465441SEvalZero     struct in_addr imr_multiaddr; /* IP multicast address of group */
294*10465441SEvalZero     struct in_addr imr_interface; /* local IP address of interface */
295*10465441SEvalZero } ip_mreq;
296*10465441SEvalZero #endif /* LWIP_IGMP */
297*10465441SEvalZero 
298*10465441SEvalZero /*
299*10465441SEvalZero  * The Type of Service provides an indication of the abstract
300*10465441SEvalZero  * parameters of the quality of service desired.  These parameters are
301*10465441SEvalZero  * to be used to guide the selection of the actual service parameters
302*10465441SEvalZero  * when transmitting a datagram through a particular network.  Several
303*10465441SEvalZero  * networks offer service precedence, which somehow treats high
304*10465441SEvalZero  * precedence traffic as more important than other traffic (generally
305*10465441SEvalZero  * by accepting only traffic above a certain precedence at time of high
306*10465441SEvalZero  * load).  The major choice is a three way tradeoff between low-delay,
307*10465441SEvalZero  * high-reliability, and high-throughput.
308*10465441SEvalZero  * The use of the Delay, Throughput, and Reliability indications may
309*10465441SEvalZero  * increase the cost (in some sense) of the service.  In many networks
310*10465441SEvalZero  * better performance for one of these parameters is coupled with worse
311*10465441SEvalZero  * performance on another.  Except for very unusual cases at most two
312*10465441SEvalZero  * of these three indications should be set.
313*10465441SEvalZero  */
314*10465441SEvalZero #define IPTOS_TOS_MASK          0x1E
315*10465441SEvalZero #define IPTOS_TOS(tos)          ((tos) & IPTOS_TOS_MASK)
316*10465441SEvalZero #define IPTOS_LOWDELAY          0x10
317*10465441SEvalZero #define IPTOS_THROUGHPUT        0x08
318*10465441SEvalZero #define IPTOS_RELIABILITY       0x04
319*10465441SEvalZero #define IPTOS_LOWCOST           0x02
320*10465441SEvalZero #define IPTOS_MINCOST           IPTOS_LOWCOST
321*10465441SEvalZero 
322*10465441SEvalZero /*
323*10465441SEvalZero  * The Network Control precedence designation is intended to be used
324*10465441SEvalZero  * within a network only.  The actual use and control of that
325*10465441SEvalZero  * designation is up to each network. The Internetwork Control
326*10465441SEvalZero  * designation is intended for use by gateway control originators only.
327*10465441SEvalZero  * If the actual use of these precedence designations is of concern to
328*10465441SEvalZero  * a particular network, it is the responsibility of that network to
329*10465441SEvalZero  * control the access to, and use of, those precedence designations.
330*10465441SEvalZero  */
331*10465441SEvalZero #define IPTOS_PREC_MASK                 0xe0
332*10465441SEvalZero #define IPTOS_PREC(tos)                ((tos) & IPTOS_PREC_MASK)
333*10465441SEvalZero #define IPTOS_PREC_NETCONTROL           0xe0
334*10465441SEvalZero #define IPTOS_PREC_INTERNETCONTROL      0xc0
335*10465441SEvalZero #define IPTOS_PREC_CRITIC_ECP           0xa0
336*10465441SEvalZero #define IPTOS_PREC_FLASHOVERRIDE        0x80
337*10465441SEvalZero #define IPTOS_PREC_FLASH                0x60
338*10465441SEvalZero #define IPTOS_PREC_IMMEDIATE            0x40
339*10465441SEvalZero #define IPTOS_PREC_PRIORITY             0x20
340*10465441SEvalZero #define IPTOS_PREC_ROUTINE              0x00
341*10465441SEvalZero 
342*10465441SEvalZero 
343*10465441SEvalZero /*
344*10465441SEvalZero  * Commands for ioctlsocket(),  taken from the BSD file fcntl.h.
345*10465441SEvalZero  * lwip_ioctl only supports FIONREAD and FIONBIO, for now
346*10465441SEvalZero  *
347*10465441SEvalZero  * Ioctl's have the command encoded in the lower word,
348*10465441SEvalZero  * and the size of any in or out parameters in the upper
349*10465441SEvalZero  * word.  The high 2 bits of the upper word are used
350*10465441SEvalZero  * to encode the in/out status of the parameter; for now
351*10465441SEvalZero  * we restrict parameters to at most 128 bytes.
352*10465441SEvalZero  */
353*10465441SEvalZero #if !defined(FIONREAD) || !defined(FIONBIO)
354*10465441SEvalZero #define IOCPARM_MASK    0x7fU           /* parameters must be < 128 bytes */
355*10465441SEvalZero #define IOC_VOID        0x20000000UL    /* no parameters */
356*10465441SEvalZero #define IOC_OUT         0x40000000UL    /* copy out parameters */
357*10465441SEvalZero #define IOC_IN          0x80000000UL    /* copy in parameters */
358*10465441SEvalZero #define IOC_INOUT       (IOC_IN|IOC_OUT)
359*10465441SEvalZero                                         /* 0x20000000 distinguishes new &
360*10465441SEvalZero                                            old ioctl's */
361*10465441SEvalZero #define _IO(x,y)        (IOC_VOID|((x)<<8)|(y))
362*10465441SEvalZero 
363*10465441SEvalZero #define _IOR(x,y,t)     (IOC_OUT|(((long)sizeof(t)&IOCPARM_MASK)<<16)|((x)<<8)|(y))
364*10465441SEvalZero 
365*10465441SEvalZero #define _IOW(x,y,t)     (IOC_IN|(((long)sizeof(t)&IOCPARM_MASK)<<16)|((x)<<8)|(y))
366*10465441SEvalZero #endif /* !defined(FIONREAD) || !defined(FIONBIO) */
367*10465441SEvalZero 
368*10465441SEvalZero #ifndef FIONREAD
369*10465441SEvalZero #define FIONREAD    _IOR('f', 127, unsigned long) /* get # bytes to read */
370*10465441SEvalZero #endif
371*10465441SEvalZero #ifndef FIONBIO
372*10465441SEvalZero #define FIONBIO     _IOW('f', 126, unsigned long) /* set/clear non-blocking i/o */
373*10465441SEvalZero #endif
374*10465441SEvalZero 
375*10465441SEvalZero /* Socket I/O Controls: unimplemented */
376*10465441SEvalZero #ifndef SIOCSHIWAT
377*10465441SEvalZero #define SIOCSHIWAT  _IOW('s',  0, unsigned long)  /* set high watermark */
378*10465441SEvalZero #define SIOCGHIWAT  _IOR('s',  1, unsigned long)  /* get high watermark */
379*10465441SEvalZero #define SIOCSLOWAT  _IOW('s',  2, unsigned long)  /* set low watermark */
380*10465441SEvalZero #define SIOCGLOWAT  _IOR('s',  3, unsigned long)  /* get low watermark */
381*10465441SEvalZero #define SIOCATMARK  _IOR('s',  7, unsigned long)  /* at oob mark? */
382*10465441SEvalZero #endif
383*10465441SEvalZero 
384*10465441SEvalZero /* commands for fnctl */
385*10465441SEvalZero #ifndef F_GETFL
386*10465441SEvalZero #define F_GETFL 3
387*10465441SEvalZero #endif
388*10465441SEvalZero #ifndef F_SETFL
389*10465441SEvalZero #define F_SETFL 4
390*10465441SEvalZero #endif
391*10465441SEvalZero 
392*10465441SEvalZero /* File status flags and file access modes for fnctl,
393*10465441SEvalZero    these are bits in an int. */
394*10465441SEvalZero #ifndef O_NONBLOCK
395*10465441SEvalZero #define O_NONBLOCK  1 /* nonblocking I/O */
396*10465441SEvalZero #endif
397*10465441SEvalZero #ifndef O_NDELAY
398*10465441SEvalZero #define O_NDELAY    1 /* same as O_NONBLOCK, for compatibility */
399*10465441SEvalZero #endif
400*10465441SEvalZero 
401*10465441SEvalZero #ifndef SHUT_RD
402*10465441SEvalZero   #define SHUT_RD   0
403*10465441SEvalZero   #define SHUT_WR   1
404*10465441SEvalZero   #define SHUT_RDWR 2
405*10465441SEvalZero #endif
406*10465441SEvalZero 
407*10465441SEvalZero /* FD_SET used for lwip_select */
408*10465441SEvalZero #ifndef FD_SET
409*10465441SEvalZero #undef  FD_SETSIZE
410*10465441SEvalZero /* Make FD_SETSIZE match NUM_SOCKETS in socket.c */
411*10465441SEvalZero #define FD_SETSIZE    MEMP_NUM_NETCONN
412*10465441SEvalZero #define FDSETSAFESET(n, code) do { \
413*10465441SEvalZero   if (((n) - LWIP_SOCKET_OFFSET < MEMP_NUM_NETCONN) && (((int)(n) - LWIP_SOCKET_OFFSET) >= 0)) { \
414*10465441SEvalZero   code; }} while(0)
415*10465441SEvalZero #define FDSETSAFEGET(n, code) (((n) - LWIP_SOCKET_OFFSET < MEMP_NUM_NETCONN) && (((int)(n) - LWIP_SOCKET_OFFSET) >= 0) ?\
416*10465441SEvalZero   (code) : 0)
417*10465441SEvalZero #define FD_SET(n, p)  FDSETSAFESET(n, (p)->fd_bits[((n)-LWIP_SOCKET_OFFSET)/8] |=  (1 << (((n)-LWIP_SOCKET_OFFSET) & 7)))
418*10465441SEvalZero #define FD_CLR(n, p)  FDSETSAFESET(n, (p)->fd_bits[((n)-LWIP_SOCKET_OFFSET)/8] &= ~(1 << (((n)-LWIP_SOCKET_OFFSET) & 7)))
419*10465441SEvalZero #define FD_ISSET(n,p) FDSETSAFEGET(n, (p)->fd_bits[((n)-LWIP_SOCKET_OFFSET)/8] &   (1 << (((n)-LWIP_SOCKET_OFFSET) & 7)))
420*10465441SEvalZero #define FD_ZERO(p)    memset((void*)(p), 0, sizeof(*(p)))
421*10465441SEvalZero 
422*10465441SEvalZero typedef struct fd_set
423*10465441SEvalZero {
424*10465441SEvalZero   unsigned char fd_bits [(FD_SETSIZE+7)/8];
425*10465441SEvalZero } fd_set;
426*10465441SEvalZero 
427*10465441SEvalZero #elif LWIP_SOCKET_OFFSET
428*10465441SEvalZero #error LWIP_SOCKET_OFFSET does not work with external FD_SET!
429*10465441SEvalZero #elif FD_SETSIZE < MEMP_NUM_NETCONN
430*10465441SEvalZero #error "external FD_SETSIZE too small for number of sockets"
431*10465441SEvalZero #endif /* FD_SET */
432*10465441SEvalZero 
433*10465441SEvalZero /** LWIP_TIMEVAL_PRIVATE: if you want to use the struct timeval provided
434*10465441SEvalZero  * by your system, set this to 0 and include <sys/time.h> in cc.h */
435*10465441SEvalZero #ifndef LWIP_TIMEVAL_PRIVATE
436*10465441SEvalZero #define LWIP_TIMEVAL_PRIVATE 1
437*10465441SEvalZero #endif
438*10465441SEvalZero 
439*10465441SEvalZero #if LWIP_TIMEVAL_PRIVATE
440*10465441SEvalZero struct timeval {
441*10465441SEvalZero   long    tv_sec;         /* seconds */
442*10465441SEvalZero   long    tv_usec;        /* and microseconds */
443*10465441SEvalZero };
444*10465441SEvalZero #endif /* LWIP_TIMEVAL_PRIVATE */
445*10465441SEvalZero 
446*10465441SEvalZero #define lwip_socket_init() /* Compatibility define, no init needed. */
447*10465441SEvalZero void lwip_socket_thread_init(void); /* LWIP_NETCONN_SEM_PER_THREAD==1: initialize thread-local semaphore */
448*10465441SEvalZero void lwip_socket_thread_cleanup(void); /* LWIP_NETCONN_SEM_PER_THREAD==1: destroy thread-local semaphore */
449*10465441SEvalZero 
450*10465441SEvalZero #if LWIP_COMPAT_SOCKETS == 2
451*10465441SEvalZero /* This helps code parsers/code completion by not having the COMPAT functions as defines */
452*10465441SEvalZero #define lwip_accept       accept
453*10465441SEvalZero #define lwip_bind         bind
454*10465441SEvalZero #define lwip_shutdown     shutdown
455*10465441SEvalZero #define lwip_getpeername  getpeername
456*10465441SEvalZero #define lwip_getsockname  getsockname
457*10465441SEvalZero #define lwip_setsockopt   setsockopt
458*10465441SEvalZero #define lwip_getsockopt   getsockopt
459*10465441SEvalZero #define lwip_close        closesocket
460*10465441SEvalZero #define lwip_connect      connect
461*10465441SEvalZero #define lwip_listen       listen
462*10465441SEvalZero #define lwip_recv         recv
463*10465441SEvalZero #define lwip_recvfrom     recvfrom
464*10465441SEvalZero #define lwip_send         send
465*10465441SEvalZero #define lwip_sendmsg      sendmsg
466*10465441SEvalZero #define lwip_sendto       sendto
467*10465441SEvalZero #define lwip_socket       socket
468*10465441SEvalZero #define lwip_select       select
469*10465441SEvalZero #define lwip_ioctlsocket  ioctl
470*10465441SEvalZero 
471*10465441SEvalZero #if LWIP_POSIX_SOCKETS_IO_NAMES
472*10465441SEvalZero #define lwip_read         read
473*10465441SEvalZero #define lwip_write        write
474*10465441SEvalZero #define lwip_writev       writev
475*10465441SEvalZero #undef lwip_close
476*10465441SEvalZero #define lwip_close        close
477*10465441SEvalZero #define closesocket(s)    close(s)
478*10465441SEvalZero #define lwip_fcntl        fcntl
479*10465441SEvalZero #define lwip_ioctl        ioctl
480*10465441SEvalZero #endif /* LWIP_POSIX_SOCKETS_IO_NAMES */
481*10465441SEvalZero #endif /* LWIP_COMPAT_SOCKETS == 2 */
482*10465441SEvalZero 
483*10465441SEvalZero int lwip_accept(int s, struct sockaddr *addr, socklen_t *addrlen);
484*10465441SEvalZero int lwip_bind(int s, const struct sockaddr *name, socklen_t namelen);
485*10465441SEvalZero int lwip_shutdown(int s, int how);
486*10465441SEvalZero int lwip_getpeername (int s, struct sockaddr *name, socklen_t *namelen);
487*10465441SEvalZero int lwip_getsockname (int s, struct sockaddr *name, socklen_t *namelen);
488*10465441SEvalZero int lwip_getsockopt (int s, int level, int optname, void *optval, socklen_t *optlen);
489*10465441SEvalZero int lwip_setsockopt (int s, int level, int optname, const void *optval, socklen_t optlen);
490*10465441SEvalZero int lwip_close(int s);
491*10465441SEvalZero int lwip_connect(int s, const struct sockaddr *name, socklen_t namelen);
492*10465441SEvalZero int lwip_listen(int s, int backlog);
493*10465441SEvalZero int lwip_recv(int s, void *mem, size_t len, int flags);
494*10465441SEvalZero int lwip_read(int s, void *mem, size_t len);
495*10465441SEvalZero int lwip_recvfrom(int s, void *mem, size_t len, int flags,
496*10465441SEvalZero       struct sockaddr *from, socklen_t *fromlen);
497*10465441SEvalZero int lwip_send(int s, const void *dataptr, size_t size, int flags);
498*10465441SEvalZero int lwip_sendmsg(int s, const struct msghdr *message, int flags);
499*10465441SEvalZero int lwip_sendto(int s, const void *dataptr, size_t size, int flags,
500*10465441SEvalZero     const struct sockaddr *to, socklen_t tolen);
501*10465441SEvalZero int lwip_socket(int domain, int type, int protocol);
502*10465441SEvalZero int lwip_write(int s, const void *dataptr, size_t size);
503*10465441SEvalZero int lwip_writev(int s, const struct iovec *iov, int iovcnt);
504*10465441SEvalZero int lwip_select(int maxfdp1, fd_set *readset, fd_set *writeset, fd_set *exceptset,
505*10465441SEvalZero                 struct timeval *timeout);
506*10465441SEvalZero int lwip_ioctl(int s, long cmd, void *argp);
507*10465441SEvalZero int lwip_fcntl(int s, int cmd, int val);
508*10465441SEvalZero 
509*10465441SEvalZero #if LWIP_COMPAT_SOCKETS
510*10465441SEvalZero #if LWIP_COMPAT_SOCKETS != 2
511*10465441SEvalZero /** @ingroup socket */
512*10465441SEvalZero #define accept(s,addr,addrlen)                    lwip_accept(s,addr,addrlen)
513*10465441SEvalZero /** @ingroup socket */
514*10465441SEvalZero #define bind(s,name,namelen)                      lwip_bind(s,name,namelen)
515*10465441SEvalZero /** @ingroup socket */
516*10465441SEvalZero #define shutdown(s,how)                           lwip_shutdown(s,how)
517*10465441SEvalZero /** @ingroup socket */
518*10465441SEvalZero #define getpeername(s,name,namelen)               lwip_getpeername(s,name,namelen)
519*10465441SEvalZero /** @ingroup socket */
520*10465441SEvalZero #define getsockname(s,name,namelen)               lwip_getsockname(s,name,namelen)
521*10465441SEvalZero /** @ingroup socket */
522*10465441SEvalZero #define setsockopt(s,level,optname,opval,optlen)  lwip_setsockopt(s,level,optname,opval,optlen)
523*10465441SEvalZero /** @ingroup socket */
524*10465441SEvalZero #define getsockopt(s,level,optname,opval,optlen)  lwip_getsockopt(s,level,optname,opval,optlen)
525*10465441SEvalZero /** @ingroup socket */
526*10465441SEvalZero #define closesocket(s)                            lwip_close(s)
527*10465441SEvalZero /** @ingroup socket */
528*10465441SEvalZero #define connect(s,name,namelen)                   lwip_connect(s,name,namelen)
529*10465441SEvalZero /** @ingroup socket */
530*10465441SEvalZero #define listen(s,backlog)                         lwip_listen(s,backlog)
531*10465441SEvalZero /** @ingroup socket */
532*10465441SEvalZero #define recv(s,mem,len,flags)                     lwip_recv(s,mem,len,flags)
533*10465441SEvalZero /** @ingroup socket */
534*10465441SEvalZero #define recvfrom(s,mem,len,flags,from,fromlen)    lwip_recvfrom(s,mem,len,flags,from,fromlen)
535*10465441SEvalZero /** @ingroup socket */
536*10465441SEvalZero #define send(s,dataptr,size,flags)                lwip_send(s,dataptr,size,flags)
537*10465441SEvalZero /** @ingroup socket */
538*10465441SEvalZero #define sendmsg(s,message,flags)                  lwip_sendmsg(s,message,flags)
539*10465441SEvalZero /** @ingroup socket */
540*10465441SEvalZero #define sendto(s,dataptr,size,flags,to,tolen)     lwip_sendto(s,dataptr,size,flags,to,tolen)
541*10465441SEvalZero /** @ingroup socket */
542*10465441SEvalZero #define socket(domain,type,protocol)              lwip_socket(domain,type,protocol)
543*10465441SEvalZero /** @ingroup socket */
544*10465441SEvalZero #define select(maxfdp1,readset,writeset,exceptset,timeout)     lwip_select(maxfdp1,readset,writeset,exceptset,timeout)
545*10465441SEvalZero /** @ingroup socket */
546*10465441SEvalZero #define ioctlsocket(s,cmd,argp)                   lwip_ioctl(s,cmd,argp)
547*10465441SEvalZero 
548*10465441SEvalZero #if LWIP_POSIX_SOCKETS_IO_NAMES
549*10465441SEvalZero /** @ingroup socket */
550*10465441SEvalZero #define read(s,mem,len)                           lwip_read(s,mem,len)
551*10465441SEvalZero /** @ingroup socket */
552*10465441SEvalZero #define write(s,dataptr,len)                      lwip_write(s,dataptr,len)
553*10465441SEvalZero /** @ingroup socket */
554*10465441SEvalZero #define writev(s,iov,iovcnt)                      lwip_writev(s,iov,iovcnt)
555*10465441SEvalZero /** @ingroup socket */
556*10465441SEvalZero #define close(s)                                  lwip_close(s)
557*10465441SEvalZero /** @ingroup socket */
558*10465441SEvalZero #define fcntl(s,cmd,val)                          lwip_fcntl(s,cmd,val)
559*10465441SEvalZero /** @ingroup socket */
560*10465441SEvalZero #define ioctl(s,cmd,argp)                         lwip_ioctl(s,cmd,argp)
561*10465441SEvalZero #endif /* LWIP_POSIX_SOCKETS_IO_NAMES */
562*10465441SEvalZero #endif /* LWIP_COMPAT_SOCKETS != 2 */
563*10465441SEvalZero 
564*10465441SEvalZero #if LWIP_IPV4 && LWIP_IPV6
565*10465441SEvalZero /** @ingroup socket */
566*10465441SEvalZero #define inet_ntop(af,src,dst,size) \
567*10465441SEvalZero     (((af) == AF_INET6) ? ip6addr_ntoa_r((const ip6_addr_t*)(src),(dst),(size)) \
568*10465441SEvalZero      : (((af) == AF_INET) ? ip4addr_ntoa_r((const ip4_addr_t*)(src),(dst),(size)) : NULL))
569*10465441SEvalZero /** @ingroup socket */
570*10465441SEvalZero #define inet_pton(af,src,dst) \
571*10465441SEvalZero     (((af) == AF_INET6) ? ip6addr_aton((src),(ip6_addr_t*)(dst)) \
572*10465441SEvalZero      : (((af) == AF_INET) ? ip4addr_aton((src),(ip4_addr_t*)(dst)) : 0))
573*10465441SEvalZero #elif LWIP_IPV4 /* LWIP_IPV4 && LWIP_IPV6 */
574*10465441SEvalZero #define inet_ntop(af,src,dst,size) \
575*10465441SEvalZero     (((af) == AF_INET) ? ip4addr_ntoa_r((const ip4_addr_t*)(src),(dst),(size)) : NULL)
576*10465441SEvalZero #define inet_pton(af,src,dst) \
577*10465441SEvalZero     (((af) == AF_INET) ? ip4addr_aton((src),(ip4_addr_t*)(dst)) : 0)
578*10465441SEvalZero #else /* LWIP_IPV4 && LWIP_IPV6 */
579*10465441SEvalZero #define inet_ntop(af,src,dst,size) \
580*10465441SEvalZero     (((af) == AF_INET6) ? ip6addr_ntoa_r((const ip6_addr_t*)(src),(dst),(size)) : NULL)
581*10465441SEvalZero #define inet_pton(af,src,dst) \
582*10465441SEvalZero     (((af) == AF_INET6) ? ip6addr_aton((src),(ip6_addr_t*)(dst)) : 0)
583*10465441SEvalZero #endif /* LWIP_IPV4 && LWIP_IPV6 */
584*10465441SEvalZero 
585*10465441SEvalZero #endif /* LWIP_COMPAT_SOCKETS */
586*10465441SEvalZero 
587*10465441SEvalZero #ifdef __cplusplus
588*10465441SEvalZero }
589*10465441SEvalZero #endif
590*10465441SEvalZero 
591*10465441SEvalZero #endif /* LWIP_SOCKET */
592*10465441SEvalZero 
593*10465441SEvalZero #endif /* LWIP_HDR_SOCKETS_H */
594