ReactOS  0.4.14-dev-854-gb9426a3
sockets.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without modification,
6  * are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice,
9  * this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright notice,
11  * this list of conditions and the following disclaimer in the documentation
12  * and/or other materials provided with the distribution.
13  * 3. The name of the author may not be used to endorse or promote products
14  * derived from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
17  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
18  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
19  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
21  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
24  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
25  * OF SUCH DAMAGE.
26  *
27  * This file is part of the lwIP TCP/IP stack.
28  *
29  * Author: Adam Dunkels <adam@sics.se>
30  *
31  */
32 
33 
34 #ifndef __LWIP_SOCKETS_H__
35 #define __LWIP_SOCKETS_H__
36 
37 #include "lwip/opt.h"
38 
39 #if LWIP_SOCKET /* don't build if not configured for use in lwipopts.h */
40 
41 #include <stddef.h> /* for size_t */
42 
43 #include "lwip/ip_addr.h"
44 #include "lwip/inet.h"
45 
46 #ifdef __cplusplus
47 extern "C" {
48 #endif
49 
50 /* members are in network byte order */
51 struct sockaddr_in {
52  u8_t sin_len;
55  struct in_addr sin_addr;
56  char sin_zero[8];
57 };
58 
59 struct sockaddr {
60  u8_t sa_len;
62  char sa_data[14];
63 };
64 
65 /* If your port already typedef's socklen_t, define SOCKLEN_T_DEFINED
66  to prevent this code from redefining it. */
67 #if !defined(socklen_t) && !defined(SOCKLEN_T_DEFINED)
68 typedef u32_t socklen_t;
69 #endif
70 
71 /* Socket protocol types (TCP/UDP/RAW) */
72 #define SOCK_STREAM 1
73 #define SOCK_DGRAM 2
74 #define SOCK_RAW 3
75 
76 /*
77  * Option flags per-socket. These must match the SOF_ flags in ip.h (checked in init.c)
78  */
79 #define SO_DEBUG 0x0001 /* Unimplemented: turn on debugging info recording */
80 #define SO_ACCEPTCONN 0x0002 /* socket has had listen() */
81 #define SO_REUSEADDR 0x0004 /* Allow local address reuse */
82 #define SO_KEEPALIVE 0x0008 /* keep connections alive */
83 #define SO_DONTROUTE 0x0010 /* Unimplemented: just use interface addresses */
84 #define SO_BROADCAST 0x0020 /* permit to send and to receive broadcast messages (see IP_SOF_BROADCAST option) */
85 #define SO_USELOOPBACK 0x0040 /* Unimplemented: bypass hardware when possible */
86 #define SO_LINGER 0x0080 /* linger on close if data present */
87 #define SO_OOBINLINE 0x0100 /* Unimplemented: leave received OOB data in line */
88 #define SO_REUSEPORT 0x0200 /* Unimplemented: allow local address & port reuse */
89 
90 #define SO_DONTLINGER ((int)(~SO_LINGER))
91 
92 /*
93  * Additional options, not kept in so_options.
94  */
95 #define SO_SNDBUF 0x1001 /* Unimplemented: send buffer size */
96 #define SO_RCVBUF 0x1002 /* receive buffer size */
97 #define SO_SNDLOWAT 0x1003 /* Unimplemented: send low-water mark */
98 #define SO_RCVLOWAT 0x1004 /* Unimplemented: receive low-water mark */
99 #define SO_SNDTIMEO 0x1005 /* Unimplemented: send timeout */
100 #define SO_RCVTIMEO 0x1006 /* receive timeout */
101 #define SO_ERROR 0x1007 /* get error status and clear */
102 #define SO_TYPE 0x1008 /* get socket type */
103 #define SO_CONTIMEO 0x1009 /* Unimplemented: connect timeout */
104 #define SO_NO_CHECK 0x100a /* don't create UDP checksum */
105 
106 
107 /*
108  * Structure used for manipulating linger option.
109  */
110 struct linger {
111  int l_onoff; /* option on/off */
112  int l_linger; /* linger time */
113 };
114 
115 /*
116  * Level number for (get/set)sockopt() to apply to socket itself.
117  */
118 #define SOL_SOCKET 0xfff /* options for socket level */
119 
120 
121 #define AF_UNSPEC 0
122 #define AF_INET 2
123 #define PF_INET AF_INET
124 #define PF_UNSPEC AF_UNSPEC
125 
126 #define IPPROTO_IP 0
127 #define IPPROTO_TCP 6
128 #define IPPROTO_UDP 17
129 #define IPPROTO_UDPLITE 136
130 
131 /* Flags we can use with send and recv. */
132 #define MSG_PEEK 0x01 /* Peeks at an incoming message */
133 #define MSG_WAITALL 0x02 /* Unimplemented: Requests that the function block until the full amount of data requested can be returned */
134 #define MSG_OOB 0x04 /* Unimplemented: Requests out-of-band data. The significance and semantics of out-of-band data are protocol-specific */
135 #define MSG_DONTWAIT 0x08 /* Nonblocking i/o for this operation only */
136 #define MSG_MORE 0x10 /* Sender will send more */
137 
138 
139 /*
140  * Options for level IPPROTO_IP
141  */
142 #define IP_TOS 1
143 #define IP_TTL 2
144 
145 #if LWIP_TCP
146 /*
147  * Options for level IPPROTO_TCP
148  */
149 #define TCP_NODELAY 0x01 /* don't delay send to coalesce packets */
150 #define TCP_KEEPALIVE 0x02 /* send KEEPALIVE probes when idle for pcb->keep_idle milliseconds */
151 #define TCP_KEEPIDLE 0x03 /* set pcb->keep_idle - Same as TCP_KEEPALIVE, but use seconds for get/setsockopt */
152 #define TCP_KEEPINTVL 0x04 /* set pcb->keep_intvl - Use seconds for get/setsockopt */
153 #define TCP_KEEPCNT 0x05 /* set pcb->keep_cnt - Use number of probes sent for get/setsockopt */
154 #endif /* LWIP_TCP */
155 
156 #if LWIP_UDP && LWIP_UDPLITE
157 /*
158  * Options for level IPPROTO_UDPLITE
159  */
160 #define UDPLITE_SEND_CSCOV 0x01 /* sender checksum coverage */
161 #define UDPLITE_RECV_CSCOV 0x02 /* minimal receiver checksum coverage */
162 #endif /* LWIP_UDP && LWIP_UDPLITE*/
163 
164 
165 #if LWIP_IGMP
166 /*
167  * Options and types for UDP multicast traffic handling
168  */
169 #define IP_ADD_MEMBERSHIP 3
170 #define IP_DROP_MEMBERSHIP 4
171 #define IP_MULTICAST_TTL 5
172 #define IP_MULTICAST_IF 6
173 #define IP_MULTICAST_LOOP 7
174 
175 typedef struct ip_mreq {
176  struct in_addr imr_multiaddr; /* IP multicast address of group */
177  struct in_addr imr_interface; /* local IP address of interface */
178 } ip_mreq;
179 #endif /* LWIP_IGMP */
180 
181 /*
182  * The Type of Service provides an indication of the abstract
183  * parameters of the quality of service desired. These parameters are
184  * to be used to guide the selection of the actual service parameters
185  * when transmitting a datagram through a particular network. Several
186  * networks offer service precedence, which somehow treats high
187  * precedence traffic as more important than other traffic (generally
188  * by accepting only traffic above a certain precedence at time of high
189  * load). The major choice is a three way tradeoff between low-delay,
190  * high-reliability, and high-throughput.
191  * The use of the Delay, Throughput, and Reliability indications may
192  * increase the cost (in some sense) of the service. In many networks
193  * better performance for one of these parameters is coupled with worse
194  * performance on another. Except for very unusual cases at most two
195  * of these three indications should be set.
196  */
197 #define IPTOS_TOS_MASK 0x1E
198 #define IPTOS_TOS(tos) ((tos) & IPTOS_TOS_MASK)
199 #define IPTOS_LOWDELAY 0x10
200 #define IPTOS_THROUGHPUT 0x08
201 #define IPTOS_RELIABILITY 0x04
202 #define IPTOS_LOWCOST 0x02
203 #define IPTOS_MINCOST IPTOS_LOWCOST
204 
205 /*
206  * The Network Control precedence designation is intended to be used
207  * within a network only. The actual use and control of that
208  * designation is up to each network. The Internetwork Control
209  * designation is intended for use by gateway control originators only.
210  * If the actual use of these precedence designations is of concern to
211  * a particular network, it is the responsibility of that network to
212  * control the access to, and use of, those precedence designations.
213  */
214 #define IPTOS_PREC_MASK 0xe0
215 #define IPTOS_PREC(tos) ((tos) & IPTOS_PREC_MASK)
216 #define IPTOS_PREC_NETCONTROL 0xe0
217 #define IPTOS_PREC_INTERNETCONTROL 0xc0
218 #define IPTOS_PREC_CRITIC_ECP 0xa0
219 #define IPTOS_PREC_FLASHOVERRIDE 0x80
220 #define IPTOS_PREC_FLASH 0x60
221 #define IPTOS_PREC_IMMEDIATE 0x40
222 #define IPTOS_PREC_PRIORITY 0x20
223 #define IPTOS_PREC_ROUTINE 0x00
224 
225 
226 /*
227  * Commands for ioctlsocket(), taken from the BSD file fcntl.h.
228  * lwip_ioctl only supports FIONREAD and FIONBIO, for now
229  *
230  * Ioctl's have the command encoded in the lower word,
231  * and the size of any in or out parameters in the upper
232  * word. The high 2 bits of the upper word are used
233  * to encode the in/out status of the parameter; for now
234  * we restrict parameters to at most 128 bytes.
235  */
236 #if !defined(FIONREAD) || !defined(FIONBIO)
237 #define IOCPARM_MASK 0x7fU /* parameters must be < 128 bytes */
238 #define IOC_VOID 0x20000000UL /* no parameters */
239 #define IOC_OUT 0x40000000UL /* copy out parameters */
240 #define IOC_IN 0x80000000UL /* copy in parameters */
241 #define IOC_INOUT (IOC_IN|IOC_OUT)
242  /* 0x20000000 distinguishes new &
243  old ioctl's */
244 #define _IO(x,y) (IOC_VOID|((x)<<8)|(y))
245 
246 #define _IOR(x,y,t) (IOC_OUT|(((long)sizeof(t)&IOCPARM_MASK)<<16)|((x)<<8)|(y))
247 
248 #define _IOW(x,y,t) (IOC_IN|(((long)sizeof(t)&IOCPARM_MASK)<<16)|((x)<<8)|(y))
249 #endif /* !defined(FIONREAD) || !defined(FIONBIO) */
250 
251 #ifndef FIONREAD
252 #define FIONREAD _IOR('f', 127, unsigned long) /* get # bytes to read */
253 #endif
254 #ifndef FIONBIO
255 #define FIONBIO _IOW('f', 126, unsigned long) /* set/clear non-blocking i/o */
256 #endif
257 
258 /* Socket I/O Controls: unimplemented */
259 #ifndef SIOCSHIWAT
260 #define SIOCSHIWAT _IOW('s', 0, unsigned long) /* set high watermark */
261 #define SIOCGHIWAT _IOR('s', 1, unsigned long) /* get high watermark */
262 #define SIOCSLOWAT _IOW('s', 2, unsigned long) /* set low watermark */
263 #define SIOCGLOWAT _IOR('s', 3, unsigned long) /* get low watermark */
264 #define SIOCATMARK _IOR('s', 7, unsigned long) /* at oob mark? */
265 #endif
266 
267 /* commands for fnctl */
268 #ifndef F_GETFL
269 #define F_GETFL 3
270 #endif
271 #ifndef F_SETFL
272 #define F_SETFL 4
273 #endif
274 
275 /* File status flags and file access modes for fnctl,
276  these are bits in an int. */
277 #ifndef O_NONBLOCK
278 #define O_NONBLOCK 1 /* nonblocking I/O */
279 #endif
280 #ifndef O_NDELAY
281 #define O_NDELAY 1 /* same as O_NONBLOCK, for compatibility */
282 #endif
283 
284 #ifndef SHUT_RD
285  #define SHUT_RD 0
286  #define SHUT_WR 1
287  #define SHUT_RDWR 2
288 #endif
289 
290 /* FD_SET used for lwip_select */
291 #ifndef FD_SET
292  #undef FD_SETSIZE
293  /* Make FD_SETSIZE match NUM_SOCKETS in socket.c */
294  #define FD_SETSIZE MEMP_NUM_NETCONN
295  #define FD_SET(n, p) ((p)->fd_bits[(n)/8] |= (1 << ((n) & 7)))
296  #define FD_CLR(n, p) ((p)->fd_bits[(n)/8] &= ~(1 << ((n) & 7)))
297  #define FD_ISSET(n,p) ((p)->fd_bits[(n)/8] & (1 << ((n) & 7)))
298  #define FD_ZERO(p) memset((void*)(p),0,sizeof(*(p)))
299 
300  typedef struct fd_set {
301  unsigned char fd_bits [(FD_SETSIZE+7)/8];
302  } fd_set;
303 
304 #endif /* FD_SET */
305 
308 #ifndef LWIP_TIMEVAL_PRIVATE
309 #define LWIP_TIMEVAL_PRIVATE 1
310 #endif
311 
312 #if LWIP_TIMEVAL_PRIVATE
313 struct timeval {
314  long tv_sec; /* seconds */
315  long tv_usec; /* and microseconds */
316 };
317 #endif /* LWIP_TIMEVAL_PRIVATE */
318 
319 void lwip_socket_init(void);
320 
321 int lwip_accept(int s, struct sockaddr *addr, socklen_t *addrlen);
322 int lwip_bind(int s, const struct sockaddr *name, socklen_t namelen);
323 int lwip_shutdown(int s, int how);
324 int lwip_getpeername (int s, struct sockaddr *name, socklen_t *namelen);
325 int lwip_getsockname (int s, struct sockaddr *name, socklen_t *namelen);
326 int lwip_getsockopt (int s, int level, int optname, void *optval, socklen_t *optlen);
327 int lwip_setsockopt (int s, int level, int optname, const void *optval, socklen_t optlen);
328 int lwip_close(int s);
329 int lwip_connect(int s, const struct sockaddr *name, socklen_t namelen);
330 int lwip_listen(int s, int backlog);
331 int lwip_recv(int s, void *mem, size_t len, int flags);
332 int lwip_read(int s, void *mem, size_t len);
333 int lwip_recvfrom(int s, void *mem, size_t len, int flags,
334  struct sockaddr *from, socklen_t *fromlen);
335 int lwip_send(int s, const void *dataptr, size_t size, int flags);
336 int lwip_sendto(int s, const void *dataptr, size_t size, int flags,
337  const struct sockaddr *to, socklen_t tolen);
338 int lwip_socket(int domain, int type, int protocol);
339 int lwip_write(int s, const void *dataptr, size_t size);
340 int lwip_select(int maxfdp1, fd_set *readset, fd_set *writeset, fd_set *exceptset,
341  struct timeval *timeout);
342 int lwip_ioctl(int s, long cmd, void *argp);
343 int lwip_fcntl(int s, int cmd, int val);
344 
345 #if LWIP_COMPAT_SOCKETS
346 #define accept(a,b,c) lwip_accept(a,b,c)
347 #define bind(a,b,c) lwip_bind(a,b,c)
348 #define shutdown(a,b) lwip_shutdown(a,b)
349 #define closesocket(s) lwip_close(s)
350 #define connect(a,b,c) lwip_connect(a,b,c)
351 #define getsockname(a,b,c) lwip_getsockname(a,b,c)
352 #define getpeername(a,b,c) lwip_getpeername(a,b,c)
353 #define setsockopt(a,b,c,d,e) lwip_setsockopt(a,b,c,d,e)
354 #define getsockopt(a,b,c,d,e) lwip_getsockopt(a,b,c,d,e)
355 #define listen(a,b) lwip_listen(a,b)
356 #define recv(a,b,c,d) lwip_recv(a,b,c,d)
357 #define recvfrom(a,b,c,d,e,f) lwip_recvfrom(a,b,c,d,e,f)
358 #define send(a,b,c,d) lwip_send(a,b,c,d)
359 #define sendto(a,b,c,d,e,f) lwip_sendto(a,b,c,d,e,f)
360 #define socket(a,b,c) lwip_socket(a,b,c)
361 #define select(a,b,c,d,e) lwip_select(a,b,c,d,e)
362 #define ioctlsocket(a,b,c) lwip_ioctl(a,b,c)
363 
364 #if LWIP_POSIX_SOCKETS_IO_NAMES
365 #define read(a,b,c) lwip_read(a,b,c)
366 #define write(a,b,c) lwip_write(a,b,c)
367 #define close(s) lwip_close(s)
368 #define fcntl(a,b,c) lwip_fcntl(a,b,c)
369 #endif /* LWIP_POSIX_SOCKETS_IO_NAMES */
370 
371 #endif /* LWIP_COMPAT_SOCKETS */
372 
373 #ifdef __cplusplus
374 }
375 #endif
376 
377 #endif /* LWIP_SOCKET */
378 
379 #endif /* __LWIP_SOCKETS_H__ */
Definition: winsock.h:66
GLint level
Definition: gl.h:1546
struct in_addr imr_interface
Definition: winsock.h:536
__kernel_fd_set fd_set
Definition: linux.h:196
u_short sin_port
Definition: winsock.h:511
Definition: ftp_var.h:139
u_short l_linger
Definition: winsock.h:143
unsigned long tv_sec
Definition: linux.h:1738
GLuint GLuint GLsizei GLenum type
Definition: gl.h:1545
Definition: dhcpd.h:245
GLint namelen
Definition: glext.h:7232
char sa_data[14]
Definition: winsock.h:218
struct in_addr imr_multiaddr
Definition: winsock.h:535
Definition: cookie.c:41
unsigned long tv_usec
Definition: linux.h:1739
u_short l_onoff
Definition: winsock.h:142
GLuint GLfloat * val
Definition: glext.h:7180
#define FD_SETSIZE
Definition: winsock.h:50
GLsizeiptr size
Definition: glext.h:5919
unsigned long u32_t
Definition: cc.h:25
Definition: tcpip.h:125
int socklen_t
Definition: tcp.c:35
GLbitfield flags
Definition: glext.h:7161
char sin_zero[8]
Definition: winsock.h:513
GLenum const GLvoid * addr
Definition: glext.h:9621
GLenum GLsizei len
Definition: glext.h:6722
GLdouble s
Definition: gl.h:2039
struct in_addr sin_addr
Definition: winsock.h:512
u_short sa_family
Definition: winsock.h:217
unsigned char u8_t
Definition: cc.h:23
Definition: mem.c:156
Definition: name.c:38
int const JOCTET * dataptr
Definition: jpeglib.h:1027
unsigned short u16_t
Definition: cc.h:24
CardRegion * from
Definition: spigame.cpp:19
short sin_family
Definition: winsock.h:510