1 /* System-specific socket constants and types. Linux version. 2 Copyright (C) 1991, 1992, 1994-2001, 2004, 2006, 2007 3 Free Software Foundation, Inc. 4 This file is part of the GNU C Library. 5 6 The GNU C Library is free software; you can redistribute it and/or 7 modify it under the terms of the GNU Lesser General Public 8 License as published by the Free Software Foundation; either 9 version 2.1 of the License, or (at your option) any later version. 10 11 The GNU C Library is distributed in the hope that it will be useful, 12 but WITHOUT ANY WARRANTY; without even the implied warranty of 13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 14 Lesser General Public License for more details. 15 16 You should have received a copy of the GNU Lesser General Public 17 License along with the GNU C Library; if not, write to the Free 18 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 19 02111-1307 USA. */ 20 21 #ifndef __BITS_SOCKET_H 22 #define __BITS_SOCKET_H 23 24 #ifndef _SYS_SOCKET_H 25 # error "Never include <bits/socket.h> directly; use <sys/socket.h> instead." 26 #endif 27 28 #define __need_size_t 29 #define __need_NULL 30 #include <stddef.h> 31 32 #include <limits.h> 33 #include <sys/types.h> 34 35 /* Type for length arguments in socket calls. */ 36 #ifndef __socklen_t_defined 37 typedef __socklen_t socklen_t; 38 # define __socklen_t_defined 39 #endif 40 41 /* Types of sockets. */ 42 enum __socket_type 43 { 44 SOCK_STREAM = 1, /* Sequenced, reliable, connection-based 45 byte streams. */ 46 #define SOCK_STREAM SOCK_STREAM 47 SOCK_DGRAM = 2, /* Connectionless, unreliable datagrams 48 of fixed maximum length. */ 49 #define SOCK_DGRAM SOCK_DGRAM 50 SOCK_RAW = 3, /* Raw protocol interface. */ 51 #define SOCK_RAW SOCK_RAW 52 SOCK_RDM = 4, /* Reliably-delivered messages. */ 53 #define SOCK_RDM SOCK_RDM 54 SOCK_SEQPACKET = 5, /* Sequenced, reliable, connection-based, 55 datagrams of fixed maximum length. */ 56 #define SOCK_SEQPACKET SOCK_SEQPACKET 57 SOCK_PACKET = 10 /* Linux specific way of getting packets 58 at the dev level. For writing rarp and 59 other similar things on the user level. */ 60 #define SOCK_PACKET SOCK_PACKET 61 }; 62 63 /* Protocol families. */ 64 #define PF_UNSPEC 0 /* Unspecified. */ 65 #define PF_LOCAL 1 /* Local to host (pipes and file-domain). */ 66 #define PF_UNIX PF_LOCAL /* POSIX name for PF_LOCAL. */ 67 #define PF_FILE PF_LOCAL /* Another non-standard name for PF_LOCAL. */ 68 #define PF_INET 2 /* IP protocol family. */ 69 #define PF_AX25 3 /* Amateur Radio AX.25. */ 70 #define PF_IPX 4 /* Novell Internet Protocol. */ 71 #define PF_APPLETALK 5 /* Appletalk DDP. */ 72 #define PF_NETROM 6 /* Amateur radio NetROM. */ 73 #define PF_BRIDGE 7 /* Multiprotocol bridge. */ 74 #define PF_ATMPVC 8 /* ATM PVCs. */ 75 #define PF_X25 9 /* Reserved for X.25 project. */ 76 #define PF_INET6 10 /* IP version 6. */ 77 #define PF_ROSE 11 /* Amateur Radio X.25 PLP. */ 78 #define PF_DECnet 12 /* Reserved for DECnet project. */ 79 #define PF_NETBEUI 13 /* Reserved for 802.2LLC project. */ 80 #define PF_SECURITY 14 /* Security callback pseudo AF. */ 81 #define PF_KEY 15 /* PF_KEY key management API. */ 82 #define PF_NETLINK 16 83 #define PF_ROUTE PF_NETLINK /* Alias to emulate 4.4BSD. */ 84 #define PF_PACKET 17 /* Packet family. */ 85 #define PF_ASH 18 /* Ash. */ 86 #define PF_ECONET 19 /* Acorn Econet. */ 87 #define PF_ATMSVC 20 /* ATM SVCs. */ 88 #define PF_SNA 22 /* Linux SNA Project */ 89 #define PF_IRDA 23 /* IRDA sockets. */ 90 #define PF_PPPOX 24 /* PPPoX sockets. */ 91 #define PF_WANPIPE 25 /* Wanpipe API sockets. */ 92 #define PF_BLUETOOTH 31 /* Bluetooth sockets. */ 93 #define PF_IUCV 32 /* IUCV sockets. */ 94 #define PF_RXRPC 33 /* RxRPC sockets. */ 95 #define PF_MAX 34 /* For now.. */ 96 97 /* Address families. */ 98 #define AF_UNSPEC PF_UNSPEC 99 #define AF_LOCAL PF_LOCAL 100 #define AF_UNIX PF_UNIX 101 #define AF_FILE PF_FILE 102 #define AF_INET PF_INET 103 #define AF_AX25 PF_AX25 104 #define AF_IPX PF_IPX 105 #define AF_APPLETALK PF_APPLETALK 106 #define AF_NETROM PF_NETROM 107 #define AF_BRIDGE PF_BRIDGE 108 #define AF_ATMPVC PF_ATMPVC 109 #define AF_X25 PF_X25 110 #define AF_INET6 PF_INET6 111 #define AF_ROSE PF_ROSE 112 #define AF_DECnet PF_DECnet 113 #define AF_NETBEUI PF_NETBEUI 114 #define AF_SECURITY PF_SECURITY 115 #define AF_KEY PF_KEY 116 #define AF_NETLINK PF_NETLINK 117 #define AF_ROUTE PF_ROUTE 118 #define AF_PACKET PF_PACKET 119 #define AF_ASH PF_ASH 120 #define AF_ECONET PF_ECONET 121 #define AF_ATMSVC PF_ATMSVC 122 #define AF_SNA PF_SNA 123 #define AF_IRDA PF_IRDA 124 #define AF_PPPOX PF_PPPOX 125 #define AF_WANPIPE PF_WANPIPE 126 #define AF_BLUETOOTH PF_BLUETOOTH 127 #define AF_IUCV PF_IUCV 128 #define AF_RXRPC PF_RXRPC 129 #define AF_MAX PF_MAX 130 131 /* Socket level values. Others are defined in the appropriate headers. 132 133 XXX These definitions also should go into the appropriate headers as 134 far as they are available. */ 135 #define SOL_RAW 255 136 #define SOL_DECNET 261 137 #define SOL_X25 262 138 #define SOL_PACKET 263 139 #define SOL_ATM 264 /* ATM layer (cell level). */ 140 #define SOL_AAL 265 /* ATM Adaption Layer (packet level). */ 141 #define SOL_IRDA 266 142 143 /* Maximum queue length specifiable by listen. */ 144 #define SOMAXCONN 128 145 146 /* Get the definition of the macro to define the common sockaddr members. */ 147 #include <bits/sockaddr.h> 148 149 /* Structure describing a generic socket address. */ 150 struct sockaddr 151 { 152 __SOCKADDR_COMMON (sa_); /* Common data: address family and length. */ 153 char sa_data[14]; /* Address data. */ 154 }; 155 156 157 /* Structure large enough to hold any socket address (with the historical 158 exception of AF_UNIX). We reserve 128 bytes. */ 159 #if ULONG_MAX > 0xffffffff 160 # define __ss_aligntype __uint64_t 161 #else 162 # define __ss_aligntype __uint32_t 163 #endif 164 #define _SS_SIZE 128 165 #define _SS_PADSIZE (_SS_SIZE - (2 * sizeof (__ss_aligntype))) 166 167 struct sockaddr_storage 168 { 169 __SOCKADDR_COMMON (ss_); /* Address family, etc. */ 170 __ss_aligntype __ss_align; /* Force desired alignment. */ 171 char __ss_padding[_SS_PADSIZE]; 172 }; 173 174 175 /* Bits in the FLAGS argument to `send', `recv', et al. */ 176 enum 177 { 178 MSG_OOB = 0x01, /* Process out-of-band data. */ 179 #define MSG_OOB MSG_OOB 180 MSG_PEEK = 0x02, /* Peek at incoming messages. */ 181 #define MSG_PEEK MSG_PEEK 182 MSG_DONTROUTE = 0x04, /* Don't use local routing. */ 183 #define MSG_DONTROUTE MSG_DONTROUTE 184 #ifdef __USE_GNU 185 /* DECnet uses a different name. */ 186 MSG_TRYHARD = MSG_DONTROUTE, 187 # define MSG_TRYHARD MSG_DONTROUTE 188 #endif 189 MSG_CTRUNC = 0x08, /* Control data lost before delivery. */ 190 #define MSG_CTRUNC MSG_CTRUNC 191 MSG_PROXY = 0x10, /* Supply or ask second address. */ 192 #define MSG_PROXY MSG_PROXY 193 MSG_TRUNC = 0x20, 194 #define MSG_TRUNC MSG_TRUNC 195 MSG_DONTWAIT = 0x40, /* Nonblocking IO. */ 196 #define MSG_DONTWAIT MSG_DONTWAIT 197 MSG_EOR = 0x80, /* End of record. */ 198 #define MSG_EOR MSG_EOR 199 MSG_WAITALL = 0x100, /* Wait for a full request. */ 200 #define MSG_WAITALL MSG_WAITALL 201 MSG_FIN = 0x200, 202 #define MSG_FIN MSG_FIN 203 MSG_SYN = 0x400, 204 #define MSG_SYN MSG_SYN 205 MSG_CONFIRM = 0x800, /* Confirm path validity. */ 206 #define MSG_CONFIRM MSG_CONFIRM 207 MSG_RST = 0x1000, 208 #define MSG_RST MSG_RST 209 MSG_ERRQUEUE = 0x2000, /* Fetch message from error queue. */ 210 #define MSG_ERRQUEUE MSG_ERRQUEUE 211 MSG_NOSIGNAL = 0x4000, /* Do not generate SIGPIPE. */ 212 #define MSG_NOSIGNAL MSG_NOSIGNAL 213 MSG_MORE = 0x8000, /* Sender will send more. */ 214 #define MSG_MORE MSG_MORE 215 216 MSG_CMSG_CLOEXEC = 0x40000000 /* Set close_on_exit for file 217 descriptor received through 218 SCM_RIGHTS. */ 219 #define MSG_CMSG_CLOEXEC MSG_CMSG_CLOEXEC 220 }; 221 222 223 /* Structure describing messages sent by 224 `sendmsg' and received by `recvmsg'. */ 225 struct msghdr 226 { 227 void *msg_name; /* Address to send to/receive from. */ 228 socklen_t msg_namelen; /* Length of address data. */ 229 230 struct iovec *msg_iov; /* Vector of data to send/receive into. */ 231 size_t msg_iovlen; /* Number of elements in the vector. */ 232 233 void *msg_control; /* Ancillary data (eg BSD filedesc passing). */ 234 size_t msg_controllen; /* Ancillary data buffer length. 235 !! The type should be socklen_t but the 236 definition of the kernel is incompatible 237 with this. */ 238 239 int msg_flags; /* Flags on received message. */ 240 }; 241 242 /* Structure used for storage of ancillary data object information. */ 243 struct cmsghdr 244 { 245 size_t cmsg_len; /* Length of data in cmsg_data plus length 246 of cmsghdr structure. 247 !! The type should be socklen_t but the 248 definition of the kernel is incompatible 249 with this. */ 250 int cmsg_level; /* Originating protocol. */ 251 int cmsg_type; /* Protocol specific type. */ 252 #if (!defined __STRICT_ANSI__ && __GNUC__ >= 2) || __STDC_VERSION__ >= 199901L 253 __extension__ unsigned char __cmsg_data __flexarr; /* Ancillary data. */ 254 #endif 255 }; 256 257 /* Ancillary data object manipulation macros. */ 258 #if (!defined __STRICT_ANSI__ && __GNUC__ >= 2) || __STDC_VERSION__ >= 199901L 259 # define CMSG_DATA(cmsg) ((cmsg)->__cmsg_data) 260 #else 261 # define CMSG_DATA(cmsg) ((unsigned char *) ((struct cmsghdr *) (cmsg) + 1)) 262 #endif 263 #define CMSG_NXTHDR(mhdr, cmsg) __cmsg_nxthdr (mhdr, cmsg) 264 #define CMSG_FIRSTHDR(mhdr) \ 265 ((size_t) (mhdr)->msg_controllen >= sizeof (struct cmsghdr) \ 266 ? (struct cmsghdr *) (mhdr)->msg_control : (struct cmsghdr *) NULL) 267 #define CMSG_ALIGN(len) (((len) + sizeof (size_t) - 1) \ 268 & (size_t) ~(sizeof (size_t) - 1)) 269 #define CMSG_SPACE(len) (CMSG_ALIGN (len) \ 270 + CMSG_ALIGN (sizeof (struct cmsghdr))) 271 #define CMSG_LEN(len) (CMSG_ALIGN (sizeof (struct cmsghdr)) + (len)) 272 273 extern struct cmsghdr *__cmsg_nxthdr (struct msghdr *__mhdr, 274 struct cmsghdr *__cmsg) __THROW; 275 #ifdef __USE_EXTERN_INLINES 276 # ifndef _EXTERN_INLINE 277 # define _EXTERN_INLINE __extern_inline 278 # endif 279 _EXTERN_INLINE struct cmsghdr * 280 __NTH (__cmsg_nxthdr (struct msghdr *__mhdr, struct cmsghdr *__cmsg)) 281 { 282 if ((size_t) __cmsg->cmsg_len < sizeof (struct cmsghdr)) 283 /* The kernel header does this so there may be a reason. */ 284 return 0; 285 286 __cmsg = (struct cmsghdr *) ((unsigned char *) __cmsg 287 + CMSG_ALIGN (__cmsg->cmsg_len)); 288 if ((unsigned char *) (__cmsg + 1) > ((unsigned char *) __mhdr->msg_control 289 + __mhdr->msg_controllen) 290 || ((unsigned char *) __cmsg + CMSG_ALIGN (__cmsg->cmsg_len) 291 > ((unsigned char *) __mhdr->msg_control + __mhdr->msg_controllen))) 292 /* No more entries. */ 293 return 0; 294 return __cmsg; 295 } 296 #endif /* Use `extern inline'. */ 297 298 /* Socket level message types. This must match the definitions in 299 <linux/socket.h>. */ 300 enum 301 { 302 SCM_RIGHTS = 0x01 /* Transfer file descriptors. */ 303 #define SCM_RIGHTS SCM_RIGHTS 304 #ifdef __USE_BSD 305 , SCM_CREDENTIALS = 0x02 /* Credentials passing. */ 306 # define SCM_CREDENTIALS SCM_CREDENTIALS 307 #endif 308 }; 309 310 /* User visible structure for SCM_CREDENTIALS message */ 311 312 struct ucred 313 { 314 pid_t pid; /* PID of sending process. */ 315 uid_t uid; /* UID of sending process. */ 316 gid_t gid; /* GID of sending process. */ 317 }; 318 319 /* Get socket manipulation related informations from kernel headers. */ 320 #include <asm/socket.h> 321 322 323 /* Structure used to manipulate the SO_LINGER option. */ 324 struct linger 325 { 326 int l_onoff; /* Nonzero to linger on close. */ 327 int l_linger; /* Time to linger. */ 328 }; 329 330 #endif /* bits/socket.h */ 331
