src/include/lwip/sockets.h

   1 /*
   2  * Copyright (c) 2001-2003 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 struct in_addr {
  38   u32_t s_addr;
  39 };
  40
  41
  42 struct sockaddr_in {
  43   u8_t sin_len;
  44   u8_t sin_family;
  45   u16_t sin_port;
  46   struct in_addr sin_addr;
  47   char sin_zero[8];
  48 };
  49
  50 struct sockaddr {
  51   u8_t sa_len;
  52   u8_t sa_family;
  53   char sa_data[14];
  54 };
  55
  56 #ifndef socklen_t
  57 #  define socklen_t int
  58 #endif
  59
  60
  61 #define SOCK_STREAM     1
  62 #define SOCK_DGRAM      2
  63 #define SOCK_RAW        3
  64
  65 /*
  66  * Option flags per-socket.
  67  */
  68 #define SO_DEBUG        0x0001          /* turn on debugging info recording */
  69 #define SO_ACCEPTCONN   0x0002          /* socket has had listen() */
  70 #define SO_REUSEADDR    0x0004          /* allow local address reuse */
  71 #define SO_KEEPALIVE    0x0008          /* keep connections alive */
  72 #define SO_DONTROUTE    0x0010          /* just use interface addresses */
  73 #define SO_BROADCAST    0x0020          /* permit sending of broadcast msgs */
  74 #define SO_USELOOPBACK  0x0040          /* bypass hardware when possible */
  75 #define SO_LINGER       0x0080          /* linger on close if data present */
  76 #define SO_OOBINLINE    0x0100          /* leave received OOB data in line */
  77
  78 #define SO_DONTLINGER   (int)(~SO_LINGER)
  79
  80 /*
  81  * Additional options, not kept in so_options.
  82  */
  83 #define SO_SNDBUF       0x1001          /* send buffer size */
  84 #define SO_RCVBUF       0x1002          /* receive buffer size */
  85 #define SO_SNDLOWAT     0x1003          /* send low-water mark */
  86 #define SO_RCVLOWAT     0x1004          /* receive low-water mark */
  87 #define SO_SNDTIMEO     0x1005          /* send timeout */
  88 #define SO_RCVTIMEO     0x1006          /* receive timeout */
  89 #define SO_ERROR        0x1007          /* get error status and clear */
  90 #define SO_TYPE         0x1008          /* get socket type */
  91
  92
  93
  94 /*
  95  * Structure used for manipulating linger option.
  96  */
  97 struct linger {
  98        int l_onoff;                /* option on/off */
  99        int l_linger;               /* linger time */
 100 };
 101
 102 /*
 103  * Level number for (get/set)sockopt() to apply to socket itself.
 104  */
 105 #define SOL_SOCKET      0xfff           /* options for socket level */
 106
 107
 108 #define AF_UNSPEC       0
 109 #define AF_INET         2
 110 #define PF_INET         AF_INET
 111
 112 #define IPPROTO_TCP     6
 113 #define IPPROTO_UDP     17
 114
 115 #define INADDR_ANY      0
 116 #define INADDR_BROADCAST 0xffffffff
 117
 118 /* Flags we can use with send and recv. */
 119 #define MSG_DONTWAIT    0x40            /* Nonblocking i/o for this operation only */
 120
 121
 122 /*
 123  * Commands for ioctlsocket(),  taken from the BSD file fcntl.h.
 124  *
 125  *
 126  * Ioctl's have the command encoded in the lower word,
 127  * and the size of any in or out parameters in the upper
 128  * word.  The high 2 bits of the upper word are used
 129  * to encode the in/out status of the parameter; for now
 130  * we restrict parameters to at most 128 bytes.
 131  */
 132 #if !defined(FIONREAD) || !defined(FIONBIO)
 133 #define IOCPARM_MASK    0x7f            /* parameters must be < 128 bytes */
 134 #define IOC_VOID        0x20000000      /* no parameters */
 135 #define IOC_OUT         0x40000000      /* copy out parameters */
 136 #define IOC_IN          0x80000000      /* copy in parameters */
 137 #define IOC_INOUT       (IOC_IN|IOC_OUT)
 138                                         /* 0x20000000 distinguishes new &
 139                                            old ioctl's */
 140 #define _IO(x,y)        (IOC_VOID|((x)<<8)|(y))
 141
 142 #define _IOR(x,y,t)     (IOC_OUT|(((long)sizeof(t)&IOCPARM_MASK)<<16)|((x)<<8)|(y))
 143
 144 #define _IOW(x,y,t)     (IOC_IN|(((long)sizeof(t)&IOCPARM_MASK)<<16)|((x)<<8)|(y))
 145 #endif
 146
 147 #ifndef FIONREAD
 148 #define FIONREAD    _IOR('f', 127, unsigned long) /* get # bytes to read */
 149 #endif
 150 #ifndef FIONBIO
 151 #define FIONBIO     _IOW('f', 126, unsigned long) /* set/clear non-blocking i/o */
 152 #endif
 153
 154 /* Socket I/O Controls */
 155 #ifndef SIOCSHIWAT
 156 #define SIOCSHIWAT  _IOW('s',  0, unsigned long)  /* set high watermark */
 157 #define SIOCGHIWAT  _IOR('s',  1, unsigned long)  /* get high watermark */
 158 #define SIOCSLOWAT  _IOW('s',  2, unsigned long)  /* set low watermark */
 159 #define SIOCGLOWAT  _IOR('s',  3, unsigned long)  /* get low watermark */
 160 #define SIOCATMARK  _IOR('s',  7, unsigned long)  /* at oob mark? */
 161 #endif
 162
 163 #ifndef O_NONBLOCK
 164 #define O_NONBLOCK    04000
 165 #endif
 166
 167 #ifndef FD_SET
 168   #undef  FD_SETSIZE
 169   #define FD_SETSIZE    16
 170   #define FD_SET(n, p)  ((p)->fd_bits[(n)/8] |=  (1 << ((n) & 7)))
 171   #define FD_CLR(n, p)  ((p)->fd_bits[(n)/8] &= ~(1 << ((n) & 7)))
 172   #define FD_ISSET(n,p) ((p)->fd_bits[(n)/8] &   (1 << ((n) & 7)))
 173   #define FD_ZERO(p)    memset((void*)(p),0,sizeof(*(p)))
 174
 175   typedef struct fd_set {
 176           unsigned char fd_bits [(FD_SETSIZE+7)/8];
 177         } fd_set;
 178
 179   struct timeval {
 180           long    tv_sec;         /* seconds */
 181           long    tv_usec;        /* and microseconds */
 182   };
 183
 184 #endif
 185
 186 int lwip_accept(int s, struct sockaddr *addr, socklen_t *addrlen);
 187 int lwip_bind(int s, struct sockaddr *name, socklen_t namelen);
 188 int lwip_shutdown(int s, int how);
 189 int lwip_getpeername (int s, struct sockaddr *name, socklen_t *namelen);
 190 int lwip_getsockname (int s, struct sockaddr *name, socklen_t *namelen);
 191 int lwip_getsockopt (int s, int level, int optname, void *optval, socklen_t *optlen);
 192 int lwip_setsockopt (int s, int level, int optname, const void *optval, socklen_t optlen);
 193 int lwip_close(int s);
 194 int lwip_connect(int s, struct sockaddr *name, socklen_t namelen);
 195 int lwip_listen(int s, int backlog);
 196 int lwip_recv(int s, void *mem, int len, unsigned int flags);
 197 int lwip_read(int s, void *mem, int len);
 198 int lwip_recvfrom(int s, void *mem, int len, unsigned int flags,
 199                   struct sockaddr *from, socklen_t *fromlen);
 200 int lwip_send(int s, void *dataptr, int size, unsigned int flags);
 201 int lwip_sendto(int s, void *dataptr, int size, unsigned int flags,
 202                 struct sockaddr *to, socklen_t tolen);
 203 int lwip_socket(int domain, int type, int protocol);
 204 int lwip_write(int s, void *dataptr, int size);
 205 int lwip_select(int maxfdp1, fd_set *readset, fd_set *writeset, fd_set *exceptset,
 206                 struct timeval *timeout);
 207 int lwip_ioctl(int s, long cmd, void *argp);
 208
 209 #if LWIP_COMPAT_SOCKETS
 210 #define accept(a,b,c)         lwip_accept(a,b,c)
 211 #define bind(a,b,c)           lwip_bind(a,b,c)
 212 #define shutdown(a,b)         lwip_shutdown(a,b)
 213 #define close(s)              lwip_close(s)
 214 #define connect(a,b,c)        lwip_connect(a,b,c)
 215 #define getsockname(a,b,c)    lwip_getsockname(a,b,c)
 216 #define getpeername(a,b,c)    lwip_getpeername(a,b,c)
 217 #define setsockopt(a,b,c,d,e) lwip_setsockopt(a,b,c,d,e)
 218 #define getsockopt(a,b,c,d,e) lwip_getsockopt(a,b,c,d,e)
 219 #define listen(a,b)           lwip_listen(a,b)
 220 #define recv(a,b,c,d)         lwip_recv(a,b,c,d)
 221 #define read(a,b,c)           lwip_read(a,b,c)
 222 #define recvfrom(a,b,c,d,e,f) lwip_recvfrom(a,b,c,d,e,f)
 223 #define send(a,b,c,d)         lwip_send(a,b,c,d)
 224 #define sendto(a,b,c,d,e,f)   lwip_sendto(a,b,c,d,e,f)
 225 #define socket(a,b,c)         lwip_socket(a,b,c)
 226 #define write(a,b,c)          lwip_write(a,b,c)
 227 #define select(a,b,c,d,e)     lwip_select(a,b,c,d,e)
 228 #define ioctlsocket(a,b,c)     lwip_ioctl(a,b,c)
 229 #endif /* LWIP_COMPAT_SOCKETS */
 230
 231 #endif /* __LWIP_SOCKETS_H__ */
 232