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/netif.h" 48*10465441SEvalZero #include "lwip/err.h" 49*10465441SEvalZero #include "lwip/inet.h" 50*10465441SEvalZero #include "lwip/errno.h" 51*10465441SEvalZero 52*10465441SEvalZero #include <string.h> 53*10465441SEvalZero 54*10465441SEvalZero #ifdef __cplusplus 55*10465441SEvalZero extern "C" { 56*10465441SEvalZero #endif 57*10465441SEvalZero 58*10465441SEvalZero /* If your port already typedef's sa_family_t, define SA_FAMILY_T_DEFINED 59*10465441SEvalZero to prevent this code from redefining it. */ 60*10465441SEvalZero #if !defined(sa_family_t) && !defined(SA_FAMILY_T_DEFINED) 61*10465441SEvalZero typedef u8_t sa_family_t; 62*10465441SEvalZero #endif 63*10465441SEvalZero /* If your port already typedef's in_port_t, define IN_PORT_T_DEFINED 64*10465441SEvalZero to prevent this code from redefining it. */ 65*10465441SEvalZero #if !defined(in_port_t) && !defined(IN_PORT_T_DEFINED) 66*10465441SEvalZero typedef u16_t in_port_t; 67*10465441SEvalZero #endif 68*10465441SEvalZero 69*10465441SEvalZero #if LWIP_IPV4 70*10465441SEvalZero /* members are in network byte order */ 71*10465441SEvalZero struct sockaddr_in { 72*10465441SEvalZero u8_t sin_len; 73*10465441SEvalZero sa_family_t sin_family; 74*10465441SEvalZero in_port_t sin_port; 75*10465441SEvalZero struct in_addr sin_addr; 76*10465441SEvalZero #define SIN_ZERO_LEN 8 77*10465441SEvalZero char sin_zero[SIN_ZERO_LEN]; 78*10465441SEvalZero }; 79*10465441SEvalZero #endif /* LWIP_IPV4 */ 80*10465441SEvalZero 81*10465441SEvalZero #if LWIP_IPV6 82*10465441SEvalZero struct sockaddr_in6 { 83*10465441SEvalZero u8_t sin6_len; /* length of this structure */ 84*10465441SEvalZero sa_family_t sin6_family; /* AF_INET6 */ 85*10465441SEvalZero in_port_t sin6_port; /* Transport layer port # */ 86*10465441SEvalZero u32_t sin6_flowinfo; /* IPv6 flow information */ 87*10465441SEvalZero struct in6_addr sin6_addr; /* IPv6 address */ 88*10465441SEvalZero u32_t sin6_scope_id; /* Set of interfaces for scope */ 89*10465441SEvalZero }; 90*10465441SEvalZero #endif /* LWIP_IPV6 */ 91*10465441SEvalZero 92*10465441SEvalZero struct sockaddr { 93*10465441SEvalZero u8_t sa_len; 94*10465441SEvalZero sa_family_t sa_family; 95*10465441SEvalZero char sa_data[14]; 96*10465441SEvalZero }; 97*10465441SEvalZero 98*10465441SEvalZero struct sockaddr_storage { 99*10465441SEvalZero u8_t s2_len; 100*10465441SEvalZero sa_family_t ss_family; 101*10465441SEvalZero char s2_data1[2]; 102*10465441SEvalZero u32_t s2_data2[3]; 103*10465441SEvalZero #if LWIP_IPV6 104*10465441SEvalZero u32_t s2_data3[3]; 105*10465441SEvalZero #endif /* LWIP_IPV6 */ 106*10465441SEvalZero }; 107*10465441SEvalZero 108*10465441SEvalZero /* If your port already typedef's socklen_t, define SOCKLEN_T_DEFINED 109*10465441SEvalZero to prevent this code from redefining it. */ 110*10465441SEvalZero #if !defined(socklen_t) && !defined(SOCKLEN_T_DEFINED) 111*10465441SEvalZero typedef u32_t socklen_t; 112*10465441SEvalZero #endif 113*10465441SEvalZero 114*10465441SEvalZero #if !defined IOV_MAX 115*10465441SEvalZero #define IOV_MAX 0xFFFF 116*10465441SEvalZero #elif IOV_MAX > 0xFFFF 117*10465441SEvalZero #error "IOV_MAX larger than supported by LwIP" 118*10465441SEvalZero #endif /* IOV_MAX */ 119*10465441SEvalZero 120*10465441SEvalZero #if !defined(iovec) 121*10465441SEvalZero struct iovec { 122*10465441SEvalZero void *iov_base; 123*10465441SEvalZero size_t iov_len; 124*10465441SEvalZero }; 125*10465441SEvalZero #endif 126*10465441SEvalZero 127*10465441SEvalZero struct msghdr { 128*10465441SEvalZero void *msg_name; 129*10465441SEvalZero socklen_t msg_namelen; 130*10465441SEvalZero struct iovec *msg_iov; 131*10465441SEvalZero int msg_iovlen; 132*10465441SEvalZero void *msg_control; 133*10465441SEvalZero socklen_t msg_controllen; 134*10465441SEvalZero int msg_flags; 135*10465441SEvalZero }; 136*10465441SEvalZero 137*10465441SEvalZero /* struct msghdr->msg_flags bit field values */ 138*10465441SEvalZero #define MSG_TRUNC 0x04 139*10465441SEvalZero #define MSG_CTRUNC 0x08 140*10465441SEvalZero 141*10465441SEvalZero /* RFC 3542, Section 20: Ancillary Data */ 142*10465441SEvalZero struct cmsghdr { 143*10465441SEvalZero socklen_t cmsg_len; /* number of bytes, including header */ 144*10465441SEvalZero int cmsg_level; /* originating protocol */ 145*10465441SEvalZero int cmsg_type; /* protocol-specific type */ 146*10465441SEvalZero }; 147*10465441SEvalZero /* Data section follows header and possible padding, typically referred to as 148*10465441SEvalZero unsigned char cmsg_data[]; */ 149*10465441SEvalZero 150*10465441SEvalZero /* cmsg header/data alignment. NOTE: we align to native word size (double word 151*10465441SEvalZero size on 16-bit arch) so structures are not placed at an unaligned address. 152*10465441SEvalZero 16-bit arch needs double word to ensure 32-bit alignment because socklen_t 153*10465441SEvalZero could be 32 bits. If we ever have cmsg data with a 64-bit variable, alignment 154*10465441SEvalZero will need to increase long long */ 155*10465441SEvalZero #define ALIGN_H(size) (((size) + sizeof(long) - 1U) & ~(sizeof(long)-1U)) 156*10465441SEvalZero #define ALIGN_D(size) ALIGN_H(size) 157*10465441SEvalZero 158*10465441SEvalZero #define CMSG_FIRSTHDR(mhdr) \ 159*10465441SEvalZero ((mhdr)->msg_controllen >= sizeof(struct cmsghdr) ? \ 160*10465441SEvalZero (struct cmsghdr *)(mhdr)->msg_control : \ 161*10465441SEvalZero (struct cmsghdr *)NULL) 162*10465441SEvalZero 163*10465441SEvalZero #define CMSG_NXTHDR(mhdr, cmsg) \ 164*10465441SEvalZero (((cmsg) == NULL) ? CMSG_FIRSTHDR(mhdr) : \ 165*10465441SEvalZero (((u8_t *)(cmsg) + ALIGN_H((cmsg)->cmsg_len) \ 166*10465441SEvalZero + ALIGN_D(sizeof(struct cmsghdr)) > \ 167*10465441SEvalZero (u8_t *)((mhdr)->msg_control) + (mhdr)->msg_controllen) ? \ 168*10465441SEvalZero (struct cmsghdr *)NULL : \ 169*10465441SEvalZero (struct cmsghdr *)((void*)((u8_t *)(cmsg) + \ 170*10465441SEvalZero ALIGN_H((cmsg)->cmsg_len))))) 171*10465441SEvalZero 172*10465441SEvalZero #define CMSG_DATA(cmsg) ((void*)((u8_t *)(cmsg) + \ 173*10465441SEvalZero ALIGN_D(sizeof(struct cmsghdr)))) 174*10465441SEvalZero 175*10465441SEvalZero #define CMSG_SPACE(length) (ALIGN_D(sizeof(struct cmsghdr)) + \ 176*10465441SEvalZero ALIGN_H(length)) 177*10465441SEvalZero 178*10465441SEvalZero #define CMSG_LEN(length) (ALIGN_D(sizeof(struct cmsghdr)) + \ 179*10465441SEvalZero length) 180*10465441SEvalZero 181*10465441SEvalZero /* Set socket options argument */ 182*10465441SEvalZero #define IFNAMSIZ NETIF_NAMESIZE 183*10465441SEvalZero struct ifreq { 184*10465441SEvalZero char ifr_name[IFNAMSIZ]; /* Interface name */ 185*10465441SEvalZero }; 186*10465441SEvalZero 187*10465441SEvalZero /* Socket protocol types (TCP/UDP/RAW) */ 188*10465441SEvalZero #define SOCK_STREAM 1 189*10465441SEvalZero #define SOCK_DGRAM 2 190*10465441SEvalZero #define SOCK_RAW 3 191*10465441SEvalZero 192*10465441SEvalZero /* 193*10465441SEvalZero * Option flags per-socket. These must match the SOF_ flags in ip.h (checked in init.c) 194*10465441SEvalZero */ 195*10465441SEvalZero #define SO_REUSEADDR 0x0004 /* Allow local address reuse */ 196*10465441SEvalZero #define SO_KEEPALIVE 0x0008 /* keep connections alive */ 197*10465441SEvalZero #define SO_BROADCAST 0x0020 /* permit to send and to receive broadcast messages (see IP_SOF_BROADCAST option) */ 198*10465441SEvalZero 199*10465441SEvalZero 200*10465441SEvalZero /* 201*10465441SEvalZero * Additional options, not kept in so_options. 202*10465441SEvalZero */ 203*10465441SEvalZero #define SO_DEBUG 0x0001 /* Unimplemented: turn on debugging info recording */ 204*10465441SEvalZero #define SO_ACCEPTCONN 0x0002 /* socket has had listen() */ 205*10465441SEvalZero #define SO_DONTROUTE 0x0010 /* Unimplemented: just use interface addresses */ 206*10465441SEvalZero #define SO_USELOOPBACK 0x0040 /* Unimplemented: bypass hardware when possible */ 207*10465441SEvalZero #define SO_LINGER 0x0080 /* linger on close if data present */ 208*10465441SEvalZero #define SO_DONTLINGER ((int)(~SO_LINGER)) 209*10465441SEvalZero #define SO_OOBINLINE 0x0100 /* Unimplemented: leave received OOB data in line */ 210*10465441SEvalZero #define SO_REUSEPORT 0x0200 /* Unimplemented: allow local address & port reuse */ 211*10465441SEvalZero #define SO_SNDBUF 0x1001 /* Unimplemented: send buffer size */ 212*10465441SEvalZero #define SO_RCVBUF 0x1002 /* receive buffer size */ 213*10465441SEvalZero #define SO_SNDLOWAT 0x1003 /* Unimplemented: send low-water mark */ 214*10465441SEvalZero #define SO_RCVLOWAT 0x1004 /* Unimplemented: receive low-water mark */ 215*10465441SEvalZero #define SO_SNDTIMEO 0x1005 /* send timeout */ 216*10465441SEvalZero #define SO_RCVTIMEO 0x1006 /* receive timeout */ 217*10465441SEvalZero #define SO_ERROR 0x1007 /* get error status and clear */ 218*10465441SEvalZero #define SO_TYPE 0x1008 /* get socket type */ 219*10465441SEvalZero #define SO_CONTIMEO 0x1009 /* Unimplemented: connect timeout */ 220*10465441SEvalZero #define SO_NO_CHECK 0x100a /* don't create UDP checksum */ 221*10465441SEvalZero #define SO_BINDTODEVICE 0x100b /* bind to device */ 222*10465441SEvalZero 223*10465441SEvalZero /* 224*10465441SEvalZero * Structure used for manipulating linger option. 225*10465441SEvalZero */ 226*10465441SEvalZero struct linger { 227*10465441SEvalZero int l_onoff; /* option on/off */ 228*10465441SEvalZero int l_linger; /* linger time in seconds */ 229*10465441SEvalZero }; 230*10465441SEvalZero 231*10465441SEvalZero /* 232*10465441SEvalZero * Level number for (get/set)sockopt() to apply to socket itself. 233*10465441SEvalZero */ 234*10465441SEvalZero #define SOL_SOCKET 0xfff /* options for socket level */ 235*10465441SEvalZero 236*10465441SEvalZero 237*10465441SEvalZero #define AF_UNSPEC 0 238*10465441SEvalZero #define AF_INET 2 239*10465441SEvalZero #if LWIP_IPV6 240*10465441SEvalZero #define AF_INET6 10 241*10465441SEvalZero #else /* LWIP_IPV6 */ 242*10465441SEvalZero #define AF_INET6 AF_UNSPEC 243*10465441SEvalZero #endif /* LWIP_IPV6 */ 244*10465441SEvalZero #define PF_INET AF_INET 245*10465441SEvalZero #define PF_INET6 AF_INET6 246*10465441SEvalZero #define PF_UNSPEC AF_UNSPEC 247*10465441SEvalZero 248*10465441SEvalZero #define IPPROTO_IP 0 249*10465441SEvalZero #define IPPROTO_ICMP 1 250*10465441SEvalZero #define IPPROTO_TCP 6 251*10465441SEvalZero #define IPPROTO_UDP 17 252*10465441SEvalZero #if LWIP_IPV6 253*10465441SEvalZero #define IPPROTO_IPV6 41 254*10465441SEvalZero #define IPPROTO_ICMPV6 58 255*10465441SEvalZero #endif /* LWIP_IPV6 */ 256*10465441SEvalZero #define IPPROTO_UDPLITE 136 257*10465441SEvalZero #define IPPROTO_RAW 255 258*10465441SEvalZero 259*10465441SEvalZero /* Flags we can use with send and recv. */ 260*10465441SEvalZero #define MSG_PEEK 0x01 /* Peeks at an incoming message */ 261*10465441SEvalZero #define MSG_WAITALL 0x02 /* Unimplemented: Requests that the function block until the full amount of data requested can be returned */ 262*10465441SEvalZero #define MSG_OOB 0x04 /* Unimplemented: Requests out-of-band data. The significance and semantics of out-of-band data are protocol-specific */ 263*10465441SEvalZero #define MSG_DONTWAIT 0x08 /* Nonblocking i/o for this operation only */ 264*10465441SEvalZero #define MSG_MORE 0x10 /* Sender will send more */ 265*10465441SEvalZero #define MSG_NOSIGNAL 0x20 /* Uninmplemented: Requests not to send the SIGPIPE signal if an attempt to send is made on a stream-oriented socket that is no longer connected. */ 266*10465441SEvalZero 267*10465441SEvalZero 268*10465441SEvalZero /* 269*10465441SEvalZero * Options for level IPPROTO_IP 270*10465441SEvalZero */ 271*10465441SEvalZero #define IP_TOS 1 272*10465441SEvalZero #define IP_TTL 2 273*10465441SEvalZero #define IP_PKTINFO 8 274*10465441SEvalZero 275*10465441SEvalZero #if LWIP_TCP 276*10465441SEvalZero /* 277*10465441SEvalZero * Options for level IPPROTO_TCP 278*10465441SEvalZero */ 279*10465441SEvalZero #define TCP_NODELAY 0x01 /* don't delay send to coalesce packets */ 280*10465441SEvalZero #define TCP_KEEPALIVE 0x02 /* send KEEPALIVE probes when idle for pcb->keep_idle milliseconds */ 281*10465441SEvalZero #define TCP_KEEPIDLE 0x03 /* set pcb->keep_idle - Same as TCP_KEEPALIVE, but use seconds for get/setsockopt */ 282*10465441SEvalZero #define TCP_KEEPINTVL 0x04 /* set pcb->keep_intvl - Use seconds for get/setsockopt */ 283*10465441SEvalZero #define TCP_KEEPCNT 0x05 /* set pcb->keep_cnt - Use number of probes sent for get/setsockopt */ 284*10465441SEvalZero #endif /* LWIP_TCP */ 285*10465441SEvalZero 286*10465441SEvalZero #if LWIP_IPV6 287*10465441SEvalZero /* 288*10465441SEvalZero * Options for level IPPROTO_IPV6 289*10465441SEvalZero */ 290*10465441SEvalZero #define IPV6_CHECKSUM 7 /* RFC3542: calculate and insert the ICMPv6 checksum for raw sockets. */ 291*10465441SEvalZero #define IPV6_V6ONLY 27 /* RFC3493: boolean control to restrict AF_INET6 sockets to IPv6 communications only. */ 292*10465441SEvalZero #endif /* LWIP_IPV6 */ 293*10465441SEvalZero 294*10465441SEvalZero #if LWIP_UDP && LWIP_UDPLITE 295*10465441SEvalZero /* 296*10465441SEvalZero * Options for level IPPROTO_UDPLITE 297*10465441SEvalZero */ 298*10465441SEvalZero #define UDPLITE_SEND_CSCOV 0x01 /* sender checksum coverage */ 299*10465441SEvalZero #define UDPLITE_RECV_CSCOV 0x02 /* minimal receiver checksum coverage */ 300*10465441SEvalZero #endif /* LWIP_UDP && LWIP_UDPLITE*/ 301*10465441SEvalZero 302*10465441SEvalZero 303*10465441SEvalZero #if LWIP_MULTICAST_TX_OPTIONS 304*10465441SEvalZero /* 305*10465441SEvalZero * Options and types for UDP multicast traffic handling 306*10465441SEvalZero */ 307*10465441SEvalZero #define IP_MULTICAST_TTL 5 308*10465441SEvalZero #define IP_MULTICAST_IF 6 309*10465441SEvalZero #define IP_MULTICAST_LOOP 7 310*10465441SEvalZero #endif /* LWIP_MULTICAST_TX_OPTIONS */ 311*10465441SEvalZero 312*10465441SEvalZero #if LWIP_IGMP 313*10465441SEvalZero /* 314*10465441SEvalZero * Options and types related to multicast membership 315*10465441SEvalZero */ 316*10465441SEvalZero #define IP_ADD_MEMBERSHIP 3 317*10465441SEvalZero #define IP_DROP_MEMBERSHIP 4 318*10465441SEvalZero 319*10465441SEvalZero typedef struct ip_mreq { 320*10465441SEvalZero struct in_addr imr_multiaddr; /* IP multicast address of group */ 321*10465441SEvalZero struct in_addr imr_interface; /* local IP address of interface */ 322*10465441SEvalZero } ip_mreq; 323*10465441SEvalZero #endif /* LWIP_IGMP */ 324*10465441SEvalZero 325*10465441SEvalZero #if LWIP_IPV4 326*10465441SEvalZero struct in_pktinfo { 327*10465441SEvalZero unsigned int ipi_ifindex; /* Interface index */ 328*10465441SEvalZero struct in_addr ipi_addr; /* Destination (from header) address */ 329*10465441SEvalZero }; 330*10465441SEvalZero #endif /* LWIP_IPV4 */ 331*10465441SEvalZero 332*10465441SEvalZero #if LWIP_IPV6_MLD 333*10465441SEvalZero /* 334*10465441SEvalZero * Options and types related to IPv6 multicast membership 335*10465441SEvalZero */ 336*10465441SEvalZero #define IPV6_JOIN_GROUP 12 337*10465441SEvalZero #define IPV6_ADD_MEMBERSHIP IPV6_JOIN_GROUP 338*10465441SEvalZero #define IPV6_LEAVE_GROUP 13 339*10465441SEvalZero #define IPV6_DROP_MEMBERSHIP IPV6_LEAVE_GROUP 340*10465441SEvalZero 341*10465441SEvalZero typedef struct ipv6_mreq { 342*10465441SEvalZero struct in6_addr ipv6mr_multiaddr; /* IPv6 multicast addr */ 343*10465441SEvalZero unsigned int ipv6mr_interface; /* interface index, or 0 */ 344*10465441SEvalZero } ipv6_mreq; 345*10465441SEvalZero #endif /* LWIP_IPV6_MLD */ 346*10465441SEvalZero 347*10465441SEvalZero /* 348*10465441SEvalZero * The Type of Service provides an indication of the abstract 349*10465441SEvalZero * parameters of the quality of service desired. These parameters are 350*10465441SEvalZero * to be used to guide the selection of the actual service parameters 351*10465441SEvalZero * when transmitting a datagram through a particular network. Several 352*10465441SEvalZero * networks offer service precedence, which somehow treats high 353*10465441SEvalZero * precedence traffic as more important than other traffic (generally 354*10465441SEvalZero * by accepting only traffic above a certain precedence at time of high 355*10465441SEvalZero * load). The major choice is a three way tradeoff between low-delay, 356*10465441SEvalZero * high-reliability, and high-throughput. 357*10465441SEvalZero * The use of the Delay, Throughput, and Reliability indications may 358*10465441SEvalZero * increase the cost (in some sense) of the service. In many networks 359*10465441SEvalZero * better performance for one of these parameters is coupled with worse 360*10465441SEvalZero * performance on another. Except for very unusual cases at most two 361*10465441SEvalZero * of these three indications should be set. 362*10465441SEvalZero */ 363*10465441SEvalZero #define IPTOS_TOS_MASK 0x1E 364*10465441SEvalZero #define IPTOS_TOS(tos) ((tos) & IPTOS_TOS_MASK) 365*10465441SEvalZero #define IPTOS_LOWDELAY 0x10 366*10465441SEvalZero #define IPTOS_THROUGHPUT 0x08 367*10465441SEvalZero #define IPTOS_RELIABILITY 0x04 368*10465441SEvalZero #define IPTOS_LOWCOST 0x02 369*10465441SEvalZero #define IPTOS_MINCOST IPTOS_LOWCOST 370*10465441SEvalZero 371*10465441SEvalZero /* 372*10465441SEvalZero * The Network Control precedence designation is intended to be used 373*10465441SEvalZero * within a network only. The actual use and control of that 374*10465441SEvalZero * designation is up to each network. The Internetwork Control 375*10465441SEvalZero * designation is intended for use by gateway control originators only. 376*10465441SEvalZero * If the actual use of these precedence designations is of concern to 377*10465441SEvalZero * a particular network, it is the responsibility of that network to 378*10465441SEvalZero * control the access to, and use of, those precedence designations. 379*10465441SEvalZero */ 380*10465441SEvalZero #define IPTOS_PREC_MASK 0xe0 381*10465441SEvalZero #define IPTOS_PREC(tos) ((tos) & IPTOS_PREC_MASK) 382*10465441SEvalZero #define IPTOS_PREC_NETCONTROL 0xe0 383*10465441SEvalZero #define IPTOS_PREC_INTERNETCONTROL 0xc0 384*10465441SEvalZero #define IPTOS_PREC_CRITIC_ECP 0xa0 385*10465441SEvalZero #define IPTOS_PREC_FLASHOVERRIDE 0x80 386*10465441SEvalZero #define IPTOS_PREC_FLASH 0x60 387*10465441SEvalZero #define IPTOS_PREC_IMMEDIATE 0x40 388*10465441SEvalZero #define IPTOS_PREC_PRIORITY 0x20 389*10465441SEvalZero #define IPTOS_PREC_ROUTINE 0x00 390*10465441SEvalZero 391*10465441SEvalZero 392*10465441SEvalZero /* 393*10465441SEvalZero * Commands for ioctlsocket(), taken from the BSD file fcntl.h. 394*10465441SEvalZero * lwip_ioctl only supports FIONREAD and FIONBIO, for now 395*10465441SEvalZero * 396*10465441SEvalZero * Ioctl's have the command encoded in the lower word, 397*10465441SEvalZero * and the size of any in or out parameters in the upper 398*10465441SEvalZero * word. The high 2 bits of the upper word are used 399*10465441SEvalZero * to encode the in/out status of the parameter; for now 400*10465441SEvalZero * we restrict parameters to at most 128 bytes. 401*10465441SEvalZero */ 402*10465441SEvalZero #if !defined(FIONREAD) || !defined(FIONBIO) 403*10465441SEvalZero #define IOCPARM_MASK 0x7fU /* parameters must be < 128 bytes */ 404*10465441SEvalZero #define IOC_VOID 0x20000000UL /* no parameters */ 405*10465441SEvalZero #define IOC_OUT 0x40000000UL /* copy out parameters */ 406*10465441SEvalZero #define IOC_IN 0x80000000UL /* copy in parameters */ 407*10465441SEvalZero #define IOC_INOUT (IOC_IN|IOC_OUT) 408*10465441SEvalZero /* 0x20000000 distinguishes new & 409*10465441SEvalZero old ioctl's */ 410*10465441SEvalZero #define _IO(x,y) ((long)(IOC_VOID|((x)<<8)|(y))) 411*10465441SEvalZero 412*10465441SEvalZero #define _IOR(x,y,t) ((long)(IOC_OUT|((sizeof(t)&IOCPARM_MASK)<<16)|((x)<<8)|(y))) 413*10465441SEvalZero 414*10465441SEvalZero #define _IOW(x,y,t) ((long)(IOC_IN|((sizeof(t)&IOCPARM_MASK)<<16)|((x)<<8)|(y))) 415*10465441SEvalZero #endif /* !defined(FIONREAD) || !defined(FIONBIO) */ 416*10465441SEvalZero 417*10465441SEvalZero #ifndef FIONREAD 418*10465441SEvalZero #define FIONREAD _IOR('f', 127, unsigned long) /* get # bytes to read */ 419*10465441SEvalZero #endif 420*10465441SEvalZero #ifndef FIONBIO 421*10465441SEvalZero #define FIONBIO _IOW('f', 126, unsigned long) /* set/clear non-blocking i/o */ 422*10465441SEvalZero #endif 423*10465441SEvalZero 424*10465441SEvalZero /* Socket I/O Controls: unimplemented */ 425*10465441SEvalZero #ifndef SIOCSHIWAT 426*10465441SEvalZero #define SIOCSHIWAT _IOW('s', 0, unsigned long) /* set high watermark */ 427*10465441SEvalZero #define SIOCGHIWAT _IOR('s', 1, unsigned long) /* get high watermark */ 428*10465441SEvalZero #define SIOCSLOWAT _IOW('s', 2, unsigned long) /* set low watermark */ 429*10465441SEvalZero #define SIOCGLOWAT _IOR('s', 3, unsigned long) /* get low watermark */ 430*10465441SEvalZero #define SIOCATMARK _IOR('s', 7, unsigned long) /* at oob mark? */ 431*10465441SEvalZero #endif 432*10465441SEvalZero 433*10465441SEvalZero /* commands for fnctl */ 434*10465441SEvalZero #ifndef F_GETFL 435*10465441SEvalZero #define F_GETFL 3 436*10465441SEvalZero #endif 437*10465441SEvalZero #ifndef F_SETFL 438*10465441SEvalZero #define F_SETFL 4 439*10465441SEvalZero #endif 440*10465441SEvalZero 441*10465441SEvalZero /* File status flags and file access modes for fnctl, 442*10465441SEvalZero these are bits in an int. */ 443*10465441SEvalZero #ifndef O_NONBLOCK 444*10465441SEvalZero #define O_NONBLOCK 1 /* nonblocking I/O */ 445*10465441SEvalZero #endif 446*10465441SEvalZero #ifndef O_NDELAY 447*10465441SEvalZero #define O_NDELAY O_NONBLOCK /* same as O_NONBLOCK, for compatibility */ 448*10465441SEvalZero #endif 449*10465441SEvalZero #ifndef O_RDONLY 450*10465441SEvalZero #define O_RDONLY 2 451*10465441SEvalZero #endif 452*10465441SEvalZero #ifndef O_WRONLY 453*10465441SEvalZero #define O_WRONLY 4 454*10465441SEvalZero #endif 455*10465441SEvalZero #ifndef O_RDWR 456*10465441SEvalZero #define O_RDWR (O_RDONLY|O_WRONLY) 457*10465441SEvalZero #endif 458*10465441SEvalZero 459*10465441SEvalZero #ifndef SHUT_RD 460*10465441SEvalZero #define SHUT_RD 0 461*10465441SEvalZero #define SHUT_WR 1 462*10465441SEvalZero #define SHUT_RDWR 2 463*10465441SEvalZero #endif 464*10465441SEvalZero 465*10465441SEvalZero /* FD_SET used for lwip_select */ 466*10465441SEvalZero #ifndef FD_SET 467*10465441SEvalZero #undef FD_SETSIZE 468*10465441SEvalZero /* Make FD_SETSIZE match NUM_SOCKETS in socket.c */ 469*10465441SEvalZero #define FD_SETSIZE MEMP_NUM_NETCONN 470*10465441SEvalZero #define LWIP_SELECT_MAXNFDS (FD_SETSIZE + LWIP_SOCKET_OFFSET) 471*10465441SEvalZero #define FDSETSAFESET(n, code) do { \ 472*10465441SEvalZero if (((n) - LWIP_SOCKET_OFFSET < MEMP_NUM_NETCONN) && (((int)(n) - LWIP_SOCKET_OFFSET) >= 0)) { \ 473*10465441SEvalZero code; }} while(0) 474*10465441SEvalZero #define FDSETSAFEGET(n, code) (((n) - LWIP_SOCKET_OFFSET < MEMP_NUM_NETCONN) && (((int)(n) - LWIP_SOCKET_OFFSET) >= 0) ?\ 475*10465441SEvalZero (code) : 0) 476*10465441SEvalZero #define FD_SET(n, p) FDSETSAFESET(n, (p)->fd_bits[((n)-LWIP_SOCKET_OFFSET)/8] = (u8_t)((p)->fd_bits[((n)-LWIP_SOCKET_OFFSET)/8] | (1 << (((n)-LWIP_SOCKET_OFFSET) & 7)))) 477*10465441SEvalZero #define FD_CLR(n, p) FDSETSAFESET(n, (p)->fd_bits[((n)-LWIP_SOCKET_OFFSET)/8] = (u8_t)((p)->fd_bits[((n)-LWIP_SOCKET_OFFSET)/8] & ~(1 << (((n)-LWIP_SOCKET_OFFSET) & 7)))) 478*10465441SEvalZero #define FD_ISSET(n,p) FDSETSAFEGET(n, (p)->fd_bits[((n)-LWIP_SOCKET_OFFSET)/8] & (1 << (((n)-LWIP_SOCKET_OFFSET) & 7))) 479*10465441SEvalZero #define FD_ZERO(p) memset((void*)(p), 0, sizeof(*(p))) 480*10465441SEvalZero 481*10465441SEvalZero typedef struct fd_set 482*10465441SEvalZero { 483*10465441SEvalZero unsigned char fd_bits [(FD_SETSIZE+7)/8]; 484*10465441SEvalZero } fd_set; 485*10465441SEvalZero 486*10465441SEvalZero #elif FD_SETSIZE < (LWIP_SOCKET_OFFSET + MEMP_NUM_NETCONN) 487*10465441SEvalZero #error "external FD_SETSIZE too small for number of sockets" 488*10465441SEvalZero #else 489*10465441SEvalZero #define LWIP_SELECT_MAXNFDS FD_SETSIZE 490*10465441SEvalZero #endif /* FD_SET */ 491*10465441SEvalZero 492*10465441SEvalZero #if LWIP_SOCKET_SELECT 493*10465441SEvalZero /* poll-related defines and types */ 494*10465441SEvalZero /* @todo: find a better way to guard the definition of these defines and types if already defined */ 495*10465441SEvalZero #if !defined(POLLIN) && !defined(POLLOUT) 496*10465441SEvalZero #define POLLIN 0x1 497*10465441SEvalZero #define POLLOUT 0x2 498*10465441SEvalZero #define POLLERR 0x4 499*10465441SEvalZero #define POLLNVAL 0x8 500*10465441SEvalZero /* Below values are unimplemented */ 501*10465441SEvalZero #define POLLRDNORM 0x10 502*10465441SEvalZero #define POLLRDBAND 0x20 503*10465441SEvalZero #define POLLPRI 0x40 504*10465441SEvalZero #define POLLWRNORM 0x80 505*10465441SEvalZero #define POLLWRBAND 0x100 506*10465441SEvalZero #define POLLHUP 0x200 507*10465441SEvalZero typedef unsigned int nfds_t; 508*10465441SEvalZero struct pollfd 509*10465441SEvalZero { 510*10465441SEvalZero int fd; 511*10465441SEvalZero short events; 512*10465441SEvalZero short revents; 513*10465441SEvalZero }; 514*10465441SEvalZero #endif 515*10465441SEvalZero #endif 516*10465441SEvalZero 517*10465441SEvalZero /** LWIP_TIMEVAL_PRIVATE: if you want to use the struct timeval provided 518*10465441SEvalZero * by your system, set this to 0 and include <sys/time.h> in cc.h */ 519*10465441SEvalZero #ifndef LWIP_TIMEVAL_PRIVATE 520*10465441SEvalZero #define LWIP_TIMEVAL_PRIVATE 1 521*10465441SEvalZero #endif 522*10465441SEvalZero 523*10465441SEvalZero #if LWIP_TIMEVAL_PRIVATE 524*10465441SEvalZero struct timeval { 525*10465441SEvalZero long tv_sec; /* seconds */ 526*10465441SEvalZero long tv_usec; /* and microseconds */ 527*10465441SEvalZero }; 528*10465441SEvalZero #endif /* LWIP_TIMEVAL_PRIVATE */ 529*10465441SEvalZero 530*10465441SEvalZero #define lwip_socket_init() /* Compatibility define, no init needed. */ 531*10465441SEvalZero void lwip_socket_thread_init(void); /* LWIP_NETCONN_SEM_PER_THREAD==1: initialize thread-local semaphore */ 532*10465441SEvalZero void lwip_socket_thread_cleanup(void); /* LWIP_NETCONN_SEM_PER_THREAD==1: destroy thread-local semaphore */ 533*10465441SEvalZero 534*10465441SEvalZero #if LWIP_COMPAT_SOCKETS == 2 535*10465441SEvalZero /* This helps code parsers/code completion by not having the COMPAT functions as defines */ 536*10465441SEvalZero #define lwip_accept accept 537*10465441SEvalZero #define lwip_bind bind 538*10465441SEvalZero #define lwip_shutdown shutdown 539*10465441SEvalZero #define lwip_getpeername getpeername 540*10465441SEvalZero #define lwip_getsockname getsockname 541*10465441SEvalZero #define lwip_setsockopt setsockopt 542*10465441SEvalZero #define lwip_getsockopt getsockopt 543*10465441SEvalZero #define lwip_close closesocket 544*10465441SEvalZero #define lwip_connect connect 545*10465441SEvalZero #define lwip_listen listen 546*10465441SEvalZero #define lwip_recv recv 547*10465441SEvalZero #define lwip_recvmsg recvmsg 548*10465441SEvalZero #define lwip_recvfrom recvfrom 549*10465441SEvalZero #define lwip_send send 550*10465441SEvalZero #define lwip_sendmsg sendmsg 551*10465441SEvalZero #define lwip_sendto sendto 552*10465441SEvalZero #define lwip_socket socket 553*10465441SEvalZero #if LWIP_SOCKET_SELECT 554*10465441SEvalZero #define lwip_select select 555*10465441SEvalZero #endif 556*10465441SEvalZero #if LWIP_SOCKET_POLL 557*10465441SEvalZero #define lwip_poll poll 558*10465441SEvalZero #endif 559*10465441SEvalZero #define lwip_ioctl ioctlsocket 560*10465441SEvalZero #define lwip_inet_ntop inet_ntop 561*10465441SEvalZero #define lwip_inet_pton inet_pton 562*10465441SEvalZero 563*10465441SEvalZero #if LWIP_POSIX_SOCKETS_IO_NAMES 564*10465441SEvalZero #define lwip_read read 565*10465441SEvalZero #define lwip_readv readv 566*10465441SEvalZero #define lwip_write write 567*10465441SEvalZero #define lwip_writev writev 568*10465441SEvalZero #undef lwip_close 569*10465441SEvalZero #define lwip_close close 570*10465441SEvalZero #define closesocket(s) close(s) 571*10465441SEvalZero int fcntl(int s, int cmd, ...); 572*10465441SEvalZero #undef lwip_ioctl 573*10465441SEvalZero #define lwip_ioctl ioctl 574*10465441SEvalZero #define ioctlsocket ioctl 575*10465441SEvalZero #endif /* LWIP_POSIX_SOCKETS_IO_NAMES */ 576*10465441SEvalZero #endif /* LWIP_COMPAT_SOCKETS == 2 */ 577*10465441SEvalZero 578*10465441SEvalZero int lwip_accept(int s, struct sockaddr *addr, socklen_t *addrlen); 579*10465441SEvalZero int lwip_bind(int s, const struct sockaddr *name, socklen_t namelen); 580*10465441SEvalZero int lwip_shutdown(int s, int how); 581*10465441SEvalZero int lwip_getpeername (int s, struct sockaddr *name, socklen_t *namelen); 582*10465441SEvalZero int lwip_getsockname (int s, struct sockaddr *name, socklen_t *namelen); 583*10465441SEvalZero int lwip_getsockopt (int s, int level, int optname, void *optval, socklen_t *optlen); 584*10465441SEvalZero int lwip_setsockopt (int s, int level, int optname, const void *optval, socklen_t optlen); 585*10465441SEvalZero int lwip_close(int s); 586*10465441SEvalZero int lwip_connect(int s, const struct sockaddr *name, socklen_t namelen); 587*10465441SEvalZero int lwip_listen(int s, int backlog); 588*10465441SEvalZero ssize_t lwip_recv(int s, void *mem, size_t len, int flags); 589*10465441SEvalZero ssize_t lwip_read(int s, void *mem, size_t len); 590*10465441SEvalZero ssize_t lwip_readv(int s, const struct iovec *iov, int iovcnt); 591*10465441SEvalZero ssize_t lwip_recvfrom(int s, void *mem, size_t len, int flags, 592*10465441SEvalZero struct sockaddr *from, socklen_t *fromlen); 593*10465441SEvalZero ssize_t lwip_recvmsg(int s, struct msghdr *message, int flags); 594*10465441SEvalZero ssize_t lwip_send(int s, const void *dataptr, size_t size, int flags); 595*10465441SEvalZero ssize_t lwip_sendmsg(int s, const struct msghdr *message, int flags); 596*10465441SEvalZero ssize_t lwip_sendto(int s, const void *dataptr, size_t size, int flags, 597*10465441SEvalZero const struct sockaddr *to, socklen_t tolen); 598*10465441SEvalZero int lwip_socket(int domain, int type, int protocol); 599*10465441SEvalZero ssize_t lwip_write(int s, const void *dataptr, size_t size); 600*10465441SEvalZero ssize_t lwip_writev(int s, const struct iovec *iov, int iovcnt); 601*10465441SEvalZero #if LWIP_SOCKET_SELECT 602*10465441SEvalZero int lwip_select(int maxfdp1, fd_set *readset, fd_set *writeset, fd_set *exceptset, 603*10465441SEvalZero struct timeval *timeout); 604*10465441SEvalZero #endif 605*10465441SEvalZero #if LWIP_SOCKET_POLL 606*10465441SEvalZero int lwip_poll(struct pollfd *fds, nfds_t nfds, int timeout); 607*10465441SEvalZero #endif 608*10465441SEvalZero int lwip_ioctl(int s, long cmd, void *argp); 609*10465441SEvalZero int lwip_fcntl(int s, int cmd, int val); 610*10465441SEvalZero const char *lwip_inet_ntop(int af, const void *src, char *dst, socklen_t size); 611*10465441SEvalZero int lwip_inet_pton(int af, const char *src, void *dst); 612*10465441SEvalZero 613*10465441SEvalZero #if LWIP_COMPAT_SOCKETS 614*10465441SEvalZero #if LWIP_COMPAT_SOCKETS != 2 615*10465441SEvalZero /** @ingroup socket */ 616*10465441SEvalZero #define accept(s,addr,addrlen) lwip_accept(s,addr,addrlen) 617*10465441SEvalZero /** @ingroup socket */ 618*10465441SEvalZero #define bind(s,name,namelen) lwip_bind(s,name,namelen) 619*10465441SEvalZero /** @ingroup socket */ 620*10465441SEvalZero #define shutdown(s,how) lwip_shutdown(s,how) 621*10465441SEvalZero /** @ingroup socket */ 622*10465441SEvalZero #define getpeername(s,name,namelen) lwip_getpeername(s,name,namelen) 623*10465441SEvalZero /** @ingroup socket */ 624*10465441SEvalZero #define getsockname(s,name,namelen) lwip_getsockname(s,name,namelen) 625*10465441SEvalZero /** @ingroup socket */ 626*10465441SEvalZero #define setsockopt(s,level,optname,opval,optlen) lwip_setsockopt(s,level,optname,opval,optlen) 627*10465441SEvalZero /** @ingroup socket */ 628*10465441SEvalZero #define getsockopt(s,level,optname,opval,optlen) lwip_getsockopt(s,level,optname,opval,optlen) 629*10465441SEvalZero /** @ingroup socket */ 630*10465441SEvalZero #define closesocket(s) lwip_close(s) 631*10465441SEvalZero /** @ingroup socket */ 632*10465441SEvalZero #define connect(s,name,namelen) lwip_connect(s,name,namelen) 633*10465441SEvalZero /** @ingroup socket */ 634*10465441SEvalZero #define listen(s,backlog) lwip_listen(s,backlog) 635*10465441SEvalZero /** @ingroup socket */ 636*10465441SEvalZero #define recv(s,mem,len,flags) lwip_recv(s,mem,len,flags) 637*10465441SEvalZero /** @ingroup socket */ 638*10465441SEvalZero #define recvmsg(s,message,flags) lwip_recvmsg(s,message,flags) 639*10465441SEvalZero /** @ingroup socket */ 640*10465441SEvalZero #define recvfrom(s,mem,len,flags,from,fromlen) lwip_recvfrom(s,mem,len,flags,from,fromlen) 641*10465441SEvalZero /** @ingroup socket */ 642*10465441SEvalZero #define send(s,dataptr,size,flags) lwip_send(s,dataptr,size,flags) 643*10465441SEvalZero /** @ingroup socket */ 644*10465441SEvalZero #define sendmsg(s,message,flags) lwip_sendmsg(s,message,flags) 645*10465441SEvalZero /** @ingroup socket */ 646*10465441SEvalZero #define sendto(s,dataptr,size,flags,to,tolen) lwip_sendto(s,dataptr,size,flags,to,tolen) 647*10465441SEvalZero /** @ingroup socket */ 648*10465441SEvalZero #define socket(domain,type,protocol) lwip_socket(domain,type,protocol) 649*10465441SEvalZero #if LWIP_SOCKET_SELECT 650*10465441SEvalZero /** @ingroup socket */ 651*10465441SEvalZero #define select(maxfdp1,readset,writeset,exceptset,timeout) lwip_select(maxfdp1,readset,writeset,exceptset,timeout) 652*10465441SEvalZero #endif 653*10465441SEvalZero #if LWIP_SOCKET_POLL 654*10465441SEvalZero /** @ingroup socket */ 655*10465441SEvalZero #define poll(fds,nfds,timeout) lwip_poll(fds,nfds,timeout) 656*10465441SEvalZero #endif 657*10465441SEvalZero /** @ingroup socket */ 658*10465441SEvalZero #define ioctlsocket(s,cmd,argp) lwip_ioctl(s,cmd,argp) 659*10465441SEvalZero /** @ingroup socket */ 660*10465441SEvalZero #define inet_ntop(af,src,dst,size) lwip_inet_ntop(af,src,dst,size) 661*10465441SEvalZero /** @ingroup socket */ 662*10465441SEvalZero #define inet_pton(af,src,dst) lwip_inet_pton(af,src,dst) 663*10465441SEvalZero 664*10465441SEvalZero #if LWIP_POSIX_SOCKETS_IO_NAMES 665*10465441SEvalZero /** @ingroup socket */ 666*10465441SEvalZero #define read(s,mem,len) lwip_read(s,mem,len) 667*10465441SEvalZero /** @ingroup socket */ 668*10465441SEvalZero #define readv(s,iov,iovcnt) lwip_readv(s,iov,iovcnt) 669*10465441SEvalZero /** @ingroup socket */ 670*10465441SEvalZero #define write(s,dataptr,len) lwip_write(s,dataptr,len) 671*10465441SEvalZero /** @ingroup socket */ 672*10465441SEvalZero #define writev(s,iov,iovcnt) lwip_writev(s,iov,iovcnt) 673*10465441SEvalZero /** @ingroup socket */ 674*10465441SEvalZero #define close(s) lwip_close(s) 675*10465441SEvalZero /** @ingroup socket */ 676*10465441SEvalZero #define fcntl(s,cmd,val) lwip_fcntl(s,cmd,val) 677*10465441SEvalZero /** @ingroup socket */ 678*10465441SEvalZero #define ioctl(s,cmd,argp) lwip_ioctl(s,cmd,argp) 679*10465441SEvalZero #endif /* LWIP_POSIX_SOCKETS_IO_NAMES */ 680*10465441SEvalZero #endif /* LWIP_COMPAT_SOCKETS != 2 */ 681*10465441SEvalZero 682*10465441SEvalZero #endif /* LWIP_COMPAT_SOCKETS */ 683*10465441SEvalZero 684*10465441SEvalZero #ifdef __cplusplus 685*10465441SEvalZero } 686*10465441SEvalZero #endif 687*10465441SEvalZero 688*10465441SEvalZero #endif /* LWIP_SOCKET */ 689*10465441SEvalZero 690*10465441SEvalZero #endif /* LWIP_HDR_SOCKETS_H */ 691