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