Greg Hartman | 76d05dc | 2016-11-23 15:51:27 -0800 | [diff] [blame] | 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; |
| 53 | u8_t sin_family; |
| 54 | u16_t sin_port; |
| 55 | struct in_addr sin_addr; |
| 56 | char sin_zero[8]; |
| 57 | }; |
| 58 | |
| 59 | struct sockaddr { |
| 60 | u8_t sa_len; |
| 61 | u8_t sa_family; |
| 62 | char sa_data[14]; |
| 63 | }; |
| 64 | |
| 65 | #ifndef socklen_t |
| 66 | # define socklen_t u32_t |
| 67 | #endif |
| 68 | |
| 69 | /* Socket protocol types (TCP/UDP/RAW) */ |
| 70 | #define SOCK_STREAM 1 |
| 71 | #define SOCK_DGRAM 2 |
| 72 | #define SOCK_RAW 3 |
| 73 | |
| 74 | /* |
| 75 | * Option flags per-socket. These must match the SOF_ flags in ip.h (checked in init.c) |
| 76 | */ |
| 77 | #define SO_DEBUG 0x0001 /* Unimplemented: turn on debugging info recording */ |
| 78 | #define SO_ACCEPTCONN 0x0002 /* socket has had listen() */ |
| 79 | #define SO_REUSEADDR 0x0004 /* Allow local address reuse */ |
| 80 | #define SO_KEEPALIVE 0x0008 /* keep connections alive */ |
| 81 | #define SO_DONTROUTE 0x0010 /* Unimplemented: just use interface addresses */ |
| 82 | #define SO_BROADCAST 0x0020 /* permit to send and to receive broadcast messages (see IP_SOF_BROADCAST option) */ |
| 83 | #define SO_USELOOPBACK 0x0040 /* Unimplemented: bypass hardware when possible */ |
| 84 | #define SO_LINGER 0x0080 /* linger on close if data present */ |
| 85 | #define SO_OOBINLINE 0x0100 /* Unimplemented: leave received OOB data in line */ |
| 86 | #define SO_REUSEPORT 0x0200 /* Unimplemented: allow local address & port reuse */ |
| 87 | |
| 88 | #define SO_DONTLINGER ((int)(~SO_LINGER)) |
| 89 | |
| 90 | /* |
| 91 | * Additional options, not kept in so_options. |
| 92 | */ |
| 93 | #define SO_SNDBUF 0x1001 /* Unimplemented: send buffer size */ |
| 94 | #define SO_RCVBUF 0x1002 /* receive buffer size */ |
| 95 | #define SO_SNDLOWAT 0x1003 /* Unimplemented: send low-water mark */ |
| 96 | #define SO_RCVLOWAT 0x1004 /* Unimplemented: receive low-water mark */ |
| 97 | #define SO_SNDTIMEO 0x1005 /* Unimplemented: send timeout */ |
| 98 | #define SO_RCVTIMEO 0x1006 /* receive timeout */ |
| 99 | #define SO_ERROR 0x1007 /* get error status and clear */ |
| 100 | #define SO_TYPE 0x1008 /* get socket type */ |
| 101 | #define SO_CONTIMEO 0x1009 /* Unimplemented: connect timeout */ |
| 102 | #define SO_NO_CHECK 0x100a /* don't create UDP checksum */ |
| 103 | |
| 104 | |
| 105 | /* |
| 106 | * Structure used for manipulating linger option. |
| 107 | */ |
| 108 | struct linger { |
| 109 | int l_onoff; /* option on/off */ |
| 110 | int l_linger; /* linger time */ |
| 111 | }; |
| 112 | |
| 113 | /* |
| 114 | * Level number for (get/set)sockopt() to apply to socket itself. |
| 115 | */ |
| 116 | #define SOL_SOCKET 0xfff /* options for socket level */ |
| 117 | |
| 118 | |
| 119 | #define AF_UNSPEC 0 |
| 120 | #define AF_INET 2 |
| 121 | #define PF_INET AF_INET |
| 122 | #define PF_UNSPEC AF_UNSPEC |
| 123 | |
| 124 | #define IPPROTO_IP 0 |
| 125 | #define IPPROTO_TCP 6 |
| 126 | #define IPPROTO_UDP 17 |
| 127 | #define IPPROTO_UDPLITE 136 |
| 128 | |
| 129 | /* Flags we can use with send and recv. */ |
| 130 | #define MSG_PEEK 0x01 /* Peeks at an incoming message */ |
| 131 | #define MSG_WAITALL 0x02 /* Unimplemented: Requests that the function block until the full amount of data requested can be returned */ |
| 132 | #define MSG_OOB 0x04 /* Unimplemented: Requests out-of-band data. The significance and semantics of out-of-band data are protocol-specific */ |
| 133 | #define MSG_DONTWAIT 0x08 /* Nonblocking i/o for this operation only */ |
| 134 | #define MSG_MORE 0x10 /* Sender will send more */ |
| 135 | |
| 136 | |
| 137 | /* |
| 138 | * Options for level IPPROTO_IP |
| 139 | */ |
| 140 | #define IP_TOS 1 |
| 141 | #define IP_TTL 2 |
| 142 | |
| 143 | #if LWIP_TCP |
| 144 | /* |
| 145 | * Options for level IPPROTO_TCP |
| 146 | */ |
| 147 | #define TCP_NODELAY 0x01 /* don't delay send to coalesce packets */ |
| 148 | #define TCP_KEEPALIVE 0x02 /* send KEEPALIVE probes when idle for pcb->keep_idle milliseconds */ |
| 149 | #define TCP_KEEPIDLE 0x03 /* set pcb->keep_idle - Same as TCP_KEEPALIVE, but use seconds for get/setsockopt */ |
| 150 | #define TCP_KEEPINTVL 0x04 /* set pcb->keep_intvl - Use seconds for get/setsockopt */ |
| 151 | #define TCP_KEEPCNT 0x05 /* set pcb->keep_cnt - Use number of probes sent for get/setsockopt */ |
| 152 | #endif /* LWIP_TCP */ |
| 153 | |
| 154 | #if LWIP_UDP && LWIP_UDPLITE |
| 155 | /* |
| 156 | * Options for level IPPROTO_UDPLITE |
| 157 | */ |
| 158 | #define UDPLITE_SEND_CSCOV 0x01 /* sender checksum coverage */ |
| 159 | #define UDPLITE_RECV_CSCOV 0x02 /* minimal receiver checksum coverage */ |
| 160 | #endif /* LWIP_UDP && LWIP_UDPLITE*/ |
| 161 | |
| 162 | |
| 163 | #if LWIP_IGMP |
| 164 | /* |
| 165 | * Options and types for UDP multicast traffic handling |
| 166 | */ |
| 167 | #define IP_ADD_MEMBERSHIP 3 |
| 168 | #define IP_DROP_MEMBERSHIP 4 |
| 169 | #define IP_MULTICAST_TTL 5 |
| 170 | #define IP_MULTICAST_IF 6 |
| 171 | #define IP_MULTICAST_LOOP 7 |
| 172 | |
| 173 | typedef struct ip_mreq { |
| 174 | struct in_addr imr_multiaddr; /* IP multicast address of group */ |
| 175 | struct in_addr imr_interface; /* local IP address of interface */ |
| 176 | } ip_mreq; |
| 177 | #endif /* LWIP_IGMP */ |
| 178 | |
| 179 | /* |
| 180 | * The Type of Service provides an indication of the abstract |
| 181 | * parameters of the quality of service desired. These parameters are |
| 182 | * to be used to guide the selection of the actual service parameters |
| 183 | * when transmitting a datagram through a particular network. Several |
| 184 | * networks offer service precedence, which somehow treats high |
| 185 | * precedence traffic as more important than other traffic (generally |
| 186 | * by accepting only traffic above a certain precedence at time of high |
| 187 | * load). The major choice is a three way tradeoff between low-delay, |
| 188 | * high-reliability, and high-throughput. |
| 189 | * The use of the Delay, Throughput, and Reliability indications may |
| 190 | * increase the cost (in some sense) of the service. In many networks |
| 191 | * better performance for one of these parameters is coupled with worse |
| 192 | * performance on another. Except for very unusual cases at most two |
| 193 | * of these three indications should be set. |
| 194 | */ |
| 195 | #define IPTOS_TOS_MASK 0x1E |
| 196 | #define IPTOS_TOS(tos) ((tos) & IPTOS_TOS_MASK) |
| 197 | #define IPTOS_LOWDELAY 0x10 |
| 198 | #define IPTOS_THROUGHPUT 0x08 |
| 199 | #define IPTOS_RELIABILITY 0x04 |
| 200 | #define IPTOS_LOWCOST 0x02 |
| 201 | #define IPTOS_MINCOST IPTOS_LOWCOST |
| 202 | |
| 203 | /* |
| 204 | * The Network Control precedence designation is intended to be used |
| 205 | * within a network only. The actual use and control of that |
| 206 | * designation is up to each network. The Internetwork Control |
| 207 | * designation is intended for use by gateway control originators only. |
| 208 | * If the actual use of these precedence designations is of concern to |
| 209 | * a particular network, it is the responsibility of that network to |
| 210 | * control the access to, and use of, those precedence designations. |
| 211 | */ |
| 212 | #define IPTOS_PREC_MASK 0xe0 |
| 213 | #define IPTOS_PREC(tos) ((tos) & IPTOS_PREC_MASK) |
| 214 | #define IPTOS_PREC_NETCONTROL 0xe0 |
| 215 | #define IPTOS_PREC_INTERNETCONTROL 0xc0 |
| 216 | #define IPTOS_PREC_CRITIC_ECP 0xa0 |
| 217 | #define IPTOS_PREC_FLASHOVERRIDE 0x80 |
| 218 | #define IPTOS_PREC_FLASH 0x60 |
| 219 | #define IPTOS_PREC_IMMEDIATE 0x40 |
| 220 | #define IPTOS_PREC_PRIORITY 0x20 |
| 221 | #define IPTOS_PREC_ROUTINE 0x00 |
| 222 | |
| 223 | |
| 224 | /* |
| 225 | * Commands for ioctlsocket(), taken from the BSD file fcntl.h. |
| 226 | * lwip_ioctl only supports FIONREAD and FIONBIO, for now |
| 227 | * |
| 228 | * Ioctl's have the command encoded in the lower word, |
| 229 | * and the size of any in or out parameters in the upper |
| 230 | * word. The high 2 bits of the upper word are used |
| 231 | * to encode the in/out status of the parameter; for now |
| 232 | * we restrict parameters to at most 128 bytes. |
| 233 | */ |
| 234 | #if !defined(FIONREAD) || !defined(FIONBIO) |
| 235 | #define IOCPARM_MASK 0x7fU /* parameters must be < 128 bytes */ |
| 236 | #define IOC_VOID 0x20000000UL /* no parameters */ |
| 237 | #define IOC_OUT 0x40000000UL /* copy out parameters */ |
| 238 | #define IOC_IN 0x80000000UL /* copy in parameters */ |
| 239 | #define IOC_INOUT (IOC_IN|IOC_OUT) |
| 240 | /* 0x20000000 distinguishes new & |
| 241 | old ioctl's */ |
| 242 | #define _IO(x,y) (IOC_VOID|((x)<<8)|(y)) |
| 243 | |
| 244 | #define _IOR(x,y,t) (IOC_OUT|(((long)sizeof(t)&IOCPARM_MASK)<<16)|((x)<<8)|(y)) |
| 245 | |
| 246 | #define _IOW(x,y,t) (IOC_IN|(((long)sizeof(t)&IOCPARM_MASK)<<16)|((x)<<8)|(y)) |
| 247 | #endif /* !defined(FIONREAD) || !defined(FIONBIO) */ |
| 248 | |
| 249 | #ifndef FIONREAD |
| 250 | #define FIONREAD _IOR('f', 127, unsigned long) /* get # bytes to read */ |
| 251 | #endif |
| 252 | #ifndef FIONBIO |
| 253 | #define FIONBIO _IOW('f', 126, unsigned long) /* set/clear non-blocking i/o */ |
| 254 | #endif |
| 255 | |
| 256 | /* Socket I/O Controls: unimplemented */ |
| 257 | #ifndef SIOCSHIWAT |
| 258 | #define SIOCSHIWAT _IOW('s', 0, unsigned long) /* set high watermark */ |
| 259 | #define SIOCGHIWAT _IOR('s', 1, unsigned long) /* get high watermark */ |
| 260 | #define SIOCSLOWAT _IOW('s', 2, unsigned long) /* set low watermark */ |
| 261 | #define SIOCGLOWAT _IOR('s', 3, unsigned long) /* get low watermark */ |
| 262 | #define SIOCATMARK _IOR('s', 7, unsigned long) /* at oob mark? */ |
| 263 | #endif |
| 264 | |
| 265 | /* commands for fnctl */ |
| 266 | #ifndef F_GETFL |
| 267 | #define F_GETFL 3 |
| 268 | #endif |
| 269 | #ifndef F_SETFL |
| 270 | #define F_SETFL 4 |
| 271 | #endif |
| 272 | |
| 273 | /* File status flags and file access modes for fnctl, |
| 274 | these are bits in an int. */ |
| 275 | #ifndef O_NONBLOCK |
| 276 | #define O_NONBLOCK 1 /* nonblocking I/O */ |
| 277 | #endif |
| 278 | #ifndef O_NDELAY |
| 279 | #define O_NDELAY 1 /* same as O_NONBLOCK, for compatibility */ |
| 280 | #endif |
| 281 | |
| 282 | #ifndef SHUT_RD |
| 283 | #define SHUT_RD 0 |
| 284 | #define SHUT_WR 1 |
| 285 | #define SHUT_RDWR 2 |
| 286 | #endif |
| 287 | |
| 288 | /* FD_SET used for lwip_select */ |
| 289 | #ifndef FD_SET |
| 290 | #undef FD_SETSIZE |
| 291 | /* Make FD_SETSIZE match NUM_SOCKETS in socket.c */ |
| 292 | #define FD_SETSIZE MEMP_NUM_NETCONN |
| 293 | #define FD_SET(n, p) ((p)->fd_bits[(n)/8] |= (1 << ((n) & 7))) |
| 294 | #define FD_CLR(n, p) ((p)->fd_bits[(n)/8] &= ~(1 << ((n) & 7))) |
| 295 | #define FD_ISSET(n,p) ((p)->fd_bits[(n)/8] & (1 << ((n) & 7))) |
| 296 | #define FD_ZERO(p) memset((void*)(p),0,sizeof(*(p))) |
| 297 | |
| 298 | typedef struct fd_set { |
| 299 | unsigned char fd_bits [(FD_SETSIZE+7)/8]; |
| 300 | } fd_set; |
| 301 | |
| 302 | #endif /* FD_SET */ |
| 303 | |
| 304 | /** LWIP_TIMEVAL_PRIVATE: if you want to use the struct timeval provided |
| 305 | * by your system, set this to 0 and include <sys/time.h> in cc.h */ |
| 306 | #ifndef LWIP_TIMEVAL_PRIVATE |
| 307 | #define LWIP_TIMEVAL_PRIVATE 1 |
| 308 | #endif |
| 309 | |
| 310 | #if LWIP_TIMEVAL_PRIVATE |
| 311 | struct timeval { |
| 312 | long tv_sec; /* seconds */ |
| 313 | long tv_usec; /* and microseconds */ |
| 314 | }; |
| 315 | #endif /* LWIP_TIMEVAL_PRIVATE */ |
| 316 | |
| 317 | void lwip_socket_init(void); |
| 318 | |
| 319 | int lwip_accept(int s, struct sockaddr *addr, socklen_t *addrlen); |
| 320 | int lwip_bind(int s, const struct sockaddr *name, socklen_t namelen); |
| 321 | int lwip_shutdown(int s, int how); |
| 322 | int lwip_getpeername (int s, struct sockaddr *name, socklen_t *namelen); |
| 323 | int lwip_getsockname (int s, struct sockaddr *name, socklen_t *namelen); |
| 324 | int lwip_getsockopt (int s, int level, int optname, void *optval, socklen_t *optlen); |
| 325 | int lwip_setsockopt (int s, int level, int optname, const void *optval, socklen_t optlen); |
| 326 | int lwip_close(int s); |
| 327 | int lwip_connect(int s, const struct sockaddr *name, socklen_t namelen); |
| 328 | int lwip_listen(int s, int backlog); |
| 329 | int lwip_recv(int s, void *mem, size_t len, int flags); |
| 330 | int lwip_read(int s, void *mem, size_t len); |
| 331 | int lwip_recvfrom(int s, void *mem, size_t len, int flags, |
| 332 | struct sockaddr *from, socklen_t *fromlen); |
| 333 | int lwip_send(int s, const void *dataptr, size_t size, int flags); |
| 334 | int lwip_sendto(int s, const void *dataptr, size_t size, int flags, |
| 335 | const struct sockaddr *to, socklen_t tolen); |
| 336 | int lwip_socket(int domain, int type, int protocol); |
| 337 | int lwip_write(int s, const void *dataptr, size_t size); |
| 338 | int lwip_select(int maxfdp1, fd_set *readset, fd_set *writeset, fd_set *exceptset, |
| 339 | struct timeval *timeout); |
| 340 | int lwip_ioctl(int s, long cmd, void *argp); |
| 341 | int lwip_fcntl(int s, int cmd, int val); |
| 342 | |
| 343 | #if LWIP_COMPAT_SOCKETS |
| 344 | #define accept(a,b,c) lwip_accept(a,b,c) |
| 345 | #define bind(a,b,c) lwip_bind(a,b,c) |
| 346 | #define shutdown(a,b) lwip_shutdown(a,b) |
| 347 | #define closesocket(s) lwip_close(s) |
| 348 | #define connect(a,b,c) lwip_connect(a,b,c) |
| 349 | #define getsockname(a,b,c) lwip_getsockname(a,b,c) |
| 350 | #define getpeername(a,b,c) lwip_getpeername(a,b,c) |
| 351 | #define setsockopt(a,b,c,d,e) lwip_setsockopt(a,b,c,d,e) |
| 352 | #define getsockopt(a,b,c,d,e) lwip_getsockopt(a,b,c,d,e) |
| 353 | #define listen(a,b) lwip_listen(a,b) |
| 354 | #define recv(a,b,c,d) lwip_recv(a,b,c,d) |
| 355 | #define recvfrom(a,b,c,d,e,f) lwip_recvfrom(a,b,c,d,e,f) |
| 356 | #define send(a,b,c,d) lwip_send(a,b,c,d) |
| 357 | #define sendto(a,b,c,d,e,f) lwip_sendto(a,b,c,d,e,f) |
| 358 | #define socket(a,b,c) lwip_socket(a,b,c) |
| 359 | #define select(a,b,c,d,e) lwip_select(a,b,c,d,e) |
| 360 | #define ioctlsocket(a,b,c) lwip_ioctl(a,b,c) |
| 361 | |
| 362 | #if LWIP_POSIX_SOCKETS_IO_NAMES |
| 363 | #define read(a,b,c) lwip_read(a,b,c) |
| 364 | #define write(a,b,c) lwip_write(a,b,c) |
| 365 | #define close(s) lwip_close(s) |
| 366 | #endif /* LWIP_POSIX_SOCKETS_IO_NAMES */ |
| 367 | |
| 368 | #endif /* LWIP_COMPAT_SOCKETS */ |
| 369 | |
| 370 | #ifdef __cplusplus |
| 371 | } |
| 372 | #endif |
| 373 | |
| 374 | #endif /* LWIP_SOCKET */ |
| 375 | |
| 376 | #endif /* __LWIP_SOCKETS_H__ */ |