src/include/lwip/sockets.h

   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 #include "lwip/ip_addr.h"
  39 #include "lwip/inet.h"
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 /* members are in network byte order */
  46 struct sockaddr_in {
  47   u8_t sin_len;
  48   u8_t sin_family;
  49   u16_t sin_port;
  50   struct in_addr sin_addr;
  51   char sin_zero[8];
  52 };
  53
  54 struct sockaddr {
  55   u8_t sa_len;
  56   u8_t sa_family;
  57   char sa_data[14];
  58 };
  59
  60 #ifndef socklen_t
  61 #  define socklen_t u32_t
  62 #endif
  63
  64
  65 #define SOCK_STREAM     1
  66 #define SOCK_DGRAM      2
  67 #define SOCK_RAW        3
  68
  69 /*
  70  * Option flags per-socket.
  71  */
  72 #define  SO_DEBUG       0x0001 /* turn on debugging info recording */
  73 #define  SO_ACCEPTCONN  0x0002 /* socket has had listen() */
  74 #define  SO_REUSEADDR   0x0004 /* allow local address reuse */
  75 #define  SO_KEEPALIVE   0x0008 /* keep connections alive */
  76 #define  SO_DONTROUTE   0x0010 /* just use interface addresses */
  77 #define  SO_BROADCAST   0x0020 /* permit sending of broadcast msgs */
  78 #define  SO_USELOOPBACK 0x0040 /* bypass hardware when possible */
  79 #define  SO_LINGER      0x0080 /* linger on close if data present */
  80 #define  SO_OOBINLINE   0x0100 /* leave received OOB data in line */
  81 #define  SO_REUSEPORT   0x0200 /* allow local address & port reuse */
  82
  83 #define SO_DONTLINGER   (int)(~SO_LINGER)
  84
  85 /*
  86  * Additional options, not kept in so_options.
  87  */
  88 #define SO_SNDBUF    0x1001    /* send buffer size */
  89 #define SO_RCVBUF    0x1002    /* receive buffer size */
  90 #define SO_SNDLOWAT  0x1003    /* send low-water mark */
  91 #define SO_RCVLOWAT  0x1004    /* receive low-water mark */
  92 #define SO_SNDTIMEO  0x1005    /* send timeout */
  93 #define SO_RCVTIMEO  0x1006    /* receive timeout */
  94 #define SO_ERROR     0x1007    /* get error status and clear */
  95 #define SO_TYPE      0x1008    /* get socket type */
  96 #define SO_CONTIMEO  0x1009    /* connect timeout */
  97 #define SO_NO_CHECK  0x100a    /* don't create UDP checksum */
  98
  99
 100 /*
 101  * Structure used for manipulating linger option.
 102  */
 103 struct linger {
 104        int l_onoff;                /* option on/off */
 105        int l_linger;               /* linger time */
 106 };
 107
 108 /*
 109  * Level number for (get/set)sockopt() to apply to socket itself.
 110  */
 111 #define  SOL_SOCKET  0xfff    /* options for socket level */
 112
 113
 114 #define AF_UNSPEC       0
 115 #define AF_INET         2
 116 #define PF_INET         AF_INET
 117 #define PF_UNSPEC       AF_UNSPEC
 118
 119 #define IPPROTO_IP      0
 120 #define IPPROTO_TCP     6
 121 #define IPPROTO_UDP     17
 122 #define IPPROTO_UDPLITE 136
 123
 124 #define INADDR_ANY       0
 125 #define INADDR_BROADCAST 0xffffffff
 126
 127 /* Flags we can use with send and recv. */
 128 #define MSG_PEEK       0x01    /* Peeks at an incoming message */
 129 #define MSG_WAITALL    0x02    /* Requests that the function block until the full amount of data requested can be returned */
 130 #define MSG_OOB        0x04    /* Requests out-of-band data. The significance and semantics of out-of-band data are protocol-specific */
 131 #define MSG_DONTWAIT   0x08    /* Nonblocking i/o for this operation only */
 132
 133
 134 /*
 135  * Options for level IPPROTO_IP
 136  */
 137 #define IP_TOS             1
 138 #define IP_TTL             2
 139
 140 #if LWIP_TCP
 141 /*
 142  * Options for level IPPROTO_TCP
 143  */
 144 #define TCP_NODELAY    0x01    /* don't delay send to coalesce packets */
 145 #define TCP_KEEPALIVE  0x02    /* send KEEPALIVE probes when idle for pcb->keep_idle milliseconds */
 146 #define TCP_KEEPIDLE   0x03    /* set pcb->keep_idle  - Same as TCP_KEEPALIVE, but use seconds for get/setsockopt */
 147 #define TCP_KEEPINTVL  0x04    /* set pcb->keep_intvl - Use seconds for get/setsockopt */
 148 #define TCP_KEEPCNT    0x05    /* set pcb->keep_cnt   - Use number of probes sent for get/setsockopt */
 149 #endif /* LWIP_TCP */
 150
 151 #if LWIP_UDP && LWIP_UDPLITE
 152 /*
 153  * Options for level IPPROTO_UDPLITE
 154  */
 155 #define UDPLITE_SEND_CSCOV 0x01 /* sender checksum coverage */
 156 #define UDPLITE_RECV_CSCOV 0x02 /* minimal receiver checksum coverage */
 157 #endif /* LWIP_UDP && LWIP_UDPLITE*/
 158
 159
 160 #if LWIP_IGMP
 161 /*
 162  * Options and types for UDP multicast traffic handling
 163  */
 164 #define IP_ADD_MEMBERSHIP  3
 165 #define IP_DROP_MEMBERSHIP 4
 166 #define IP_MULTICAST_TTL   5
 167 #define IP_MULTICAST_IF    6
 168 #define IP_MULTICAST_LOOP  7
 169
 170 typedef struct ip_mreq {
 171     struct in_addr imr_multiaddr; /* IP multicast address of group */
 172     struct in_addr imr_interface; /* local IP address of interface */
 173 } ip_mreq;
 174 #endif /* LWIP_IGMP */
 175
 176 #define IPTOS_TOS_MASK          0x1E
 177 #define IPTOS_TOS(tos)          ((tos) & IPTOS_TOS_MASK)
 178 #define IPTOS_LOWDELAY          0x10
 179 #define IPTOS_THROUGHPUT        0x08
 180 #define IPTOS_RELIABILITY       0x04
 181 #define IPTOS_LOWCOST           0x02
 182 #define IPTOS_MINCOST           IPTOS_LOWCOST
 183
 184 /*
 185  * Definitions for IP precedence (also in ip_tos) (hopefully unused)
 186  */
 187 #define IPTOS_PREC_MASK                 0xe0
 188 #define IPTOS_PREC(tos)                ((tos) & IPTOS_PREC_MASK)
 189 #define IPTOS_PREC_NETCONTROL           0xe0
 190 #define IPTOS_PREC_INTERNETCONTROL      0xc0
 191 #define IPTOS_PREC_CRITIC_ECP           0xa0
 192 #define IPTOS_PREC_FLASHOVERRIDE        0x80
 193 #define IPTOS_PREC_FLASH                0x60
 194 #define IPTOS_PREC_IMMEDIATE            0x40
 195 #define IPTOS_PREC_PRIORITY             0x20
 196 #define IPTOS_PREC_ROUTINE              0x00
 197
 198
 199 /*
 200  * Commands for ioctlsocket(),  taken from the BSD file fcntl.h.
 201  *
 202  *
 203  * Ioctl's have the command encoded in the lower word,
 204  * and the size of any in or out parameters in the upper
 205  * word.  The high 2 bits of the upper word are used
 206  * to encode the in/out status of the parameter; for now
 207  * we restrict parameters to at most 128 bytes.
 208  */
 209 #if !defined(FIONREAD) || !defined(FIONBIO)
 210 #define IOCPARM_MASK    0x7fU           /* parameters must be < 128 bytes */
 211 #define IOC_VOID        0x20000000UL    /* no parameters */
 212 #define IOC_OUT         0x40000000UL    /* copy out parameters */
 213 #define IOC_IN          0x80000000UL    /* copy in parameters */
 214 #define IOC_INOUT       (IOC_IN|IOC_OUT)
 215                                         /* 0x20000000 distinguishes new &
 216                                            old ioctl's */
 217 #define _IO(x,y)        (IOC_VOID|((x)<<8)|(y))
 218
 219 #define _IOR(x,y,t)     (IOC_OUT|(((long)sizeof(t)&IOCPARM_MASK)<<16)|((x)<<8)|(y))
 220
 221 #define _IOW(x,y,t)     (IOC_IN|(((long)sizeof(t)&IOCPARM_MASK)<<16)|((x)<<8)|(y))
 222 #endif
 223
 224 #ifndef FIONREAD
 225 #define FIONREAD    _IOR('f', 127, unsigned long) /* get # bytes to read */
 226 #endif
 227 #ifndef FIONBIO
 228 #define FIONBIO     _IOW('f', 126, unsigned long) /* set/clear non-blocking i/o */
 229 #endif
 230
 231 /* Socket I/O Controls */
 232 #ifndef SIOCSHIWAT
 233 #define SIOCSHIWAT  _IOW('s',  0, unsigned long)  /* set high watermark */
 234 #define SIOCGHIWAT  _IOR('s',  1, unsigned long)  /* get high watermark */
 235 #define SIOCSLOWAT  _IOW('s',  2, unsigned long)  /* set low watermark */
 236 #define SIOCGLOWAT  _IOR('s',  3, unsigned long)  /* get low watermark */
 237 #define SIOCATMARK  _IOR('s',  7, unsigned long)  /* at oob mark? */
 238 #endif
 239
 240 #ifndef O_NONBLOCK
 241 #define O_NONBLOCK    04000U
 242 #endif
 243
 244 #ifndef FD_SET
 245   #undef  FD_SETSIZE
 246   /* Make FD_SETSIZE match NUM_SOCKETS in socket.c */
 247   #define FD_SETSIZE    MEMP_NUM_NETCONN
 248   #define FD_SET(n, p)  ((p)->fd_bits[(n)/8] |=  (1 << ((n) & 7)))
 249   #define FD_CLR(n, p)  ((p)->fd_bits[(n)/8] &= ~(1 << ((n) & 7)))
 250   #define FD_ISSET(n,p) ((p)->fd_bits[(n)/8] &   (1 << ((n) & 7)))
 251   #define FD_ZERO(p)    memset((void*)(p),0,sizeof(*(p)))
 252
 253   typedef struct fd_set {
 254           unsigned char fd_bits [(FD_SETSIZE+7)/8];
 255         } fd_set;
 256
 257 /*
 258  * only define this in sockets.c so it does not interfere
 259  * with other projects namespaces where timeval is present
 260  */
 261 #ifndef LWIP_TIMEVAL_PRIVATE
 262 #define LWIP_TIMEVAL_PRIVATE 1
 263 #endif
 264
 265 #if LWIP_TIMEVAL_PRIVATE
 266   struct timeval {
 267     long    tv_sec;         /* seconds */
 268     long    tv_usec;        /* and microseconds */
 269   };
 270 #endif
 271
 272 #endif
 273
 274 void lwip_socket_init(void);
 275
 276 int lwip_accept(int s, struct sockaddr *addr, socklen_t *addrlen);
 277 int lwip_bind(int s, struct sockaddr *name, socklen_t namelen);
 278 int lwip_shutdown(int s, int how);
 279 int lwip_getpeername (int s, struct sockaddr *name, socklen_t *namelen);
 280 int lwip_getsockname (int s, struct sockaddr *name, socklen_t *namelen);
 281 int lwip_getsockopt (int s, int level, int optname, void *optval, socklen_t *optlen);
 282 int lwip_setsockopt (int s, int level, int optname, const void *optval, socklen_t optlen);
 283 int lwip_close(int s);
 284 int lwip_connect(int s, const struct sockaddr *name, socklen_t namelen);
 285 int lwip_listen(int s, int backlog);
 286 int lwip_recv(int s, void *mem, int len, unsigned int flags);
 287 int lwip_read(int s, void *mem, int len);
 288 int lwip_recvfrom(int s, void *mem, int len, unsigned int flags,
 289       struct sockaddr *from, socklen_t *fromlen);
 290 int lwip_send(int s, const void *dataptr, int size, unsigned int flags);
 291 int lwip_sendto(int s, const void *dataptr, int size, unsigned int flags,
 292     struct sockaddr *to, socklen_t tolen);
 293 int lwip_socket(int domain, int type, int protocol);
 294 int lwip_write(int s, const void *dataptr, int size);
 295 int lwip_select(int maxfdp1, fd_set *readset, fd_set *writeset, fd_set *exceptset,
 296                 struct timeval *timeout);
 297 int lwip_ioctl(int s, long cmd, void *argp);
 298
 299 #if LWIP_COMPAT_SOCKETS
 300 #define accept(a,b,c)         lwip_accept(a,b,c)
 301 #define bind(a,b,c)           lwip_bind(a,b,c)
 302 #define shutdown(a,b)         lwip_shutdown(a,b)
 303 #define closesocket(s)        lwip_close(s)
 304 #define connect(a,b,c)        lwip_connect(a,b,c)
 305 #define getsockname(a,b,c)    lwip_getsockname(a,b,c)
 306 #define getpeername(a,b,c)    lwip_getpeername(a,b,c)
 307 #define setsockopt(a,b,c,d,e) lwip_setsockopt(a,b,c,d,e)
 308 #define getsockopt(a,b,c,d,e) lwip_getsockopt(a,b,c,d,e)
 309 #define listen(a,b)           lwip_listen(a,b)
 310 #define recv(a,b,c,d)         lwip_recv(a,b,c,d)
 311 #define recvfrom(a,b,c,d,e,f) lwip_recvfrom(a,b,c,d,e,f)
 312 #define send(a,b,c,d)         lwip_send(a,b,c,d)
 313 #define sendto(a,b,c,d,e,f)   lwip_sendto(a,b,c,d,e,f)
 314 #define socket(a,b,c)         lwip_socket(a,b,c)
 315 #define select(a,b,c,d,e)     lwip_select(a,b,c,d,e)
 316 #define ioctlsocket(a,b,c)    lwip_ioctl(a,b,c)
 317
 318 #if LWIP_POSIX_SOCKETS_IO_NAMES
 319 #define read(a,b,c)           lwip_read(a,b,c)
 320 #define write(a,b,c)          lwip_write(a,b,c)
 321 #define close(s)              lwip_close(s)
 322 #endif /* LWIP_POSIX_SOCKETS_IO_NAMES */
 323
 324 #endif /* LWIP_COMPAT_SOCKETS */
 325
 326 #ifdef __cplusplus
 327 }
 328 #endif
 329
 330 #endif /* __LWIP_SOCKETS_H__ */