1/* System-specific socket constants and types. Linux version. 2 Copyright (C) 1991, 1992, 1994-2001, 2004, 2006, 2007, 2008, 2009 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#include <stddef.h> 30 31#include <sys/types.h> 32 33/* Type for length arguments in socket calls. */ 34#ifndef __socklen_t_defined 35typedef __socklen_t socklen_t; 36# define __socklen_t_defined 37#endif 38 39/* Types of sockets. */ 40enum __socket_type 41{ 42 SOCK_STREAM = 1, /* Sequenced, reliable, connection-based 43 byte streams. */ 44#define SOCK_STREAM SOCK_STREAM 45 SOCK_DGRAM = 2, /* Connectionless, unreliable datagrams 46 of fixed maximum length. */ 47#define SOCK_DGRAM SOCK_DGRAM 48 SOCK_RAW = 3, /* Raw protocol interface. */ 49#define SOCK_RAW SOCK_RAW 50 SOCK_RDM = 4, /* Reliably-delivered messages. */ 51#define SOCK_RDM SOCK_RDM 52 SOCK_SEQPACKET = 5, /* Sequenced, reliable, connection-based, 53 datagrams of fixed maximum length. */ 54#define SOCK_SEQPACKET SOCK_SEQPACKET 55 SOCK_DCCP = 6, /* Datagram Congestion Control Protocol. */ 56#define SOCK_DCCP SOCK_DCCP 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 /* Flags to be ORed into the type parameter of socket and socketpair and 63 used for the flags parameter of paccept. */ 64 65 SOCK_CLOEXEC = 02000000, /* Atomically set close-on-exec flag for the 66 new descriptor(s). */ 67#define SOCK_CLOEXEC SOCK_CLOEXEC 68 SOCK_NONBLOCK = 04000 /* Atomically mark descriptor(s) as 69 non-blocking. */ 70#define SOCK_NONBLOCK SOCK_NONBLOCK 71}; 72 73/* Protocol families. */ 74#define PF_UNSPEC 0 /* Unspecified. */ 75#define PF_LOCAL 1 /* Local to host (pipes and file-domain). */ 76#define PF_UNIX PF_LOCAL /* POSIX name for PF_LOCAL. */ 77#define PF_FILE PF_LOCAL /* Another non-standard name for PF_LOCAL. */ 78#define PF_INET 2 /* IP protocol family. */ 79#define PF_AX25 3 /* Amateur Radio AX.25. */ 80#define PF_IPX 4 /* Novell Internet Protocol. */ 81#define PF_APPLETALK 5 /* Appletalk DDP. */ 82#define PF_NETROM 6 /* Amateur radio NetROM. */ 83#define PF_BRIDGE 7 /* Multiprotocol bridge. */ 84#define PF_ATMPVC 8 /* ATM PVCs. */ 85#define PF_X25 9 /* Reserved for X.25 project. */ 86#define PF_INET6 10 /* IP version 6. */ 87#define PF_ROSE 11 /* Amateur Radio X.25 PLP. */ 88#define PF_DECnet 12 /* Reserved for DECnet project. */ 89#define PF_NETBEUI 13 /* Reserved for 802.2LLC project. */ 90#define PF_SECURITY 14 /* Security callback pseudo AF. */ 91#define PF_KEY 15 /* PF_KEY key management API. */ 92#define PF_NETLINK 16 93#define PF_ROUTE PF_NETLINK /* Alias to emulate 4.4BSD. */ 94#define PF_PACKET 17 /* Packet family. */ 95#define PF_ASH 18 /* Ash. */ 96#define PF_ECONET 19 /* Acorn Econet. */ 97#define PF_ATMSVC 20 /* ATM SVCs. */ 98#define PF_RDS 21 /* RDS sockets. */ 99#define PF_SNA 22 /* Linux SNA Project */ 100#define PF_IRDA 23 /* IRDA sockets. */ 101#define PF_PPPOX 24 /* PPPoX sockets. */ 102#define PF_WANPIPE 25 /* Wanpipe API sockets. */ 103#define PF_LLC 26 /* Linux LLC. */ 104#define PF_CAN 29 /* Controller Area Network. */ 105#define PF_TIPC 30 /* TIPC sockets. */ 106#define PF_BLUETOOTH 31 /* Bluetooth sockets. */ 107#define PF_IUCV 32 /* IUCV sockets. */ 108#define PF_RXRPC 33 /* RxRPC sockets. */ 109#define PF_ISDN 34 /* mISDN sockets. */ 110#define PF_PHONET 35 /* Phonet sockets. */ 111#define PF_IEEE802154 36 /* IEEE 802.15.4 sockets. */ 112#define PF_MAX 37 /* 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_RDS PF_RDS 140#define AF_SNA PF_SNA 141#define AF_IRDA PF_IRDA 142#define AF_PPPOX PF_PPPOX 143#define AF_WANPIPE PF_WANPIPE 144#define AF_LLC PF_LLC 145#define AF_CAN PF_CAN 146#define AF_TIPC PF_TIPC 147#define AF_BLUETOOTH PF_BLUETOOTH 148#define AF_IUCV PF_IUCV 149#define AF_RXRPC PF_RXRPC 150#define AF_ISDN PF_ISDN 151#define AF_PHONET PF_PHONET 152#define AF_IEEE802154 PF_IEEE802154 153#define AF_MAX PF_MAX 154 155/* Socket level values. Others are defined in the appropriate headers. 156 157 XXX These definitions also should go into the appropriate headers as 158 far as they are available. */ 159#define SOL_RAW 255 160#define SOL_DECNET 261 161#define SOL_X25 262 162#define SOL_PACKET 263 163#define SOL_ATM 264 /* ATM layer (cell level). */ 164#define SOL_AAL 265 /* ATM Adaption Layer (packet level). */ 165#define SOL_IRDA 266 166 167/* Maximum queue length specifiable by listen. */ 168#define SOMAXCONN 128 169 170/* Get the definition of the macro to define the common sockaddr members. */ 171#include <bits/sockaddr.h> 172 173/* Structure describing a generic socket address. */ 174struct sockaddr 175 { 176 __SOCKADDR_COMMON (sa_); /* Common data: address family and length. */ 177 char sa_data[14]; /* Address data. */ 178 }; 179 180 181/* Structure large enough to hold any socket address (with the historical 182 exception of AF_UNIX). We reserve 128 bytes. */ 183#define __ss_aligntype unsigned long int 184#define _SS_SIZE 128 185#define _SS_PADSIZE (_SS_SIZE - (2 * sizeof (__ss_aligntype))) 186 187struct sockaddr_storage 188 { 189 __SOCKADDR_COMMON (ss_); /* Address family, etc. */ 190 __ss_aligntype __ss_align; /* Force desired alignment. */ 191 char __ss_padding[_SS_PADSIZE]; 192 }; 193 194 195/* Bits in the FLAGS argument to `send', `recv', et al. */ 196enum 197 { 198 MSG_OOB = 0x01, /* Process out-of-band data. */ 199#define MSG_OOB MSG_OOB 200 MSG_PEEK = 0x02, /* Peek at incoming messages. */ 201#define MSG_PEEK MSG_PEEK 202 MSG_DONTROUTE = 0x04, /* Don't use local routing. */ 203#define MSG_DONTROUTE MSG_DONTROUTE 204#ifdef __USE_GNU 205 /* DECnet uses a different name. */ 206 MSG_TRYHARD = MSG_DONTROUTE, 207# define MSG_TRYHARD MSG_DONTROUTE 208#endif 209 MSG_CTRUNC = 0x08, /* Control data lost before delivery. */ 210#define MSG_CTRUNC MSG_CTRUNC 211 MSG_PROXY = 0x10, /* Supply or ask second address. */ 212#define MSG_PROXY MSG_PROXY 213 MSG_TRUNC = 0x20, 214#define MSG_TRUNC MSG_TRUNC 215 MSG_DONTWAIT = 0x40, /* Nonblocking IO. */ 216#define MSG_DONTWAIT MSG_DONTWAIT 217 MSG_EOR = 0x80, /* End of record. */ 218#define MSG_EOR MSG_EOR 219 MSG_WAITALL = 0x100, /* Wait for a full request. */ 220#define MSG_WAITALL MSG_WAITALL 221 MSG_FIN = 0x200, 222#define MSG_FIN MSG_FIN 223 MSG_SYN = 0x400, 224#define MSG_SYN MSG_SYN 225 MSG_CONFIRM = 0x800, /* Confirm path validity. */ 226#define MSG_CONFIRM MSG_CONFIRM 227 MSG_RST = 0x1000, 228#define MSG_RST MSG_RST 229 MSG_ERRQUEUE = 0x2000, /* Fetch message from error queue. */ 230#define MSG_ERRQUEUE MSG_ERRQUEUE 231 MSG_NOSIGNAL = 0x4000, /* Do not generate SIGPIPE. */ 232#define MSG_NOSIGNAL MSG_NOSIGNAL 233 MSG_MORE = 0x8000, /* Sender will send more. */ 234#define MSG_MORE MSG_MORE 235 236 MSG_CMSG_CLOEXEC = 0x40000000 /* Set close_on_exit for file 237 descriptor received through 238 SCM_RIGHTS. */ 239#define MSG_CMSG_CLOEXEC MSG_CMSG_CLOEXEC 240 }; 241 242 243/* Structure describing messages sent by 244 `sendmsg' and received by `recvmsg'. */ 245struct msghdr 246 { 247 void *msg_name; /* Address to send to/receive from. */ 248 socklen_t msg_namelen; /* Length of address data. */ 249 250 struct iovec *msg_iov; /* Vector of data to send/receive into. */ 251 size_t msg_iovlen; /* Number of elements in the vector. */ 252 253 void *msg_control; /* Ancillary data (eg BSD filedesc passing). */ 254 size_t msg_controllen; /* Ancillary data buffer length. 255 !! The type should be socklen_t but the 256 definition of the kernel is incompatible 257 with this. */ 258 259 int msg_flags; /* Flags on received message. */ 260 }; 261 262/* Structure used for storage of ancillary data object information. */ 263struct cmsghdr 264 { 265 size_t cmsg_len; /* Length of data in cmsg_data plus length 266 of cmsghdr structure. 267 !! The type should be socklen_t but the 268 definition of the kernel is incompatible 269 with this. */ 270 int cmsg_level; /* Originating protocol. */ 271 int cmsg_type; /* Protocol specific type. */ 272#if (!defined __STRICT_ANSI__ && __GNUC__ >= 2) || __STDC_VERSION__ >= 199901L 273 __extension__ unsigned char __cmsg_data __flexarr; /* Ancillary data. */ 274#endif 275 }; 276 277/* Ancillary data object manipulation macros. */ 278#if (!defined __STRICT_ANSI__ && __GNUC__ >= 2) || __STDC_VERSION__ >= 199901L 279# define CMSG_DATA(cmsg) ((cmsg)->__cmsg_data) 280#else 281# define CMSG_DATA(cmsg) ((unsigned char *) ((struct cmsghdr *) (cmsg) + 1)) 282#endif 283#define CMSG_NXTHDR(mhdr, cmsg) __cmsg_nxthdr (mhdr, cmsg) 284#define CMSG_FIRSTHDR(mhdr) \ 285 ((size_t) (mhdr)->msg_controllen >= sizeof (struct cmsghdr) \ 286 ? (struct cmsghdr *) (mhdr)->msg_control : (struct cmsghdr *) 0) 287#define CMSG_ALIGN(len) (((len) + sizeof (size_t) - 1) \ 288 & (size_t) ~(sizeof (size_t) - 1)) 289#define CMSG_SPACE(len) (CMSG_ALIGN (len) \ 290 + CMSG_ALIGN (sizeof (struct cmsghdr))) 291#define CMSG_LEN(len) (CMSG_ALIGN (sizeof (struct cmsghdr)) + (len)) 292 293extern struct cmsghdr *__cmsg_nxthdr (struct msghdr *__mhdr, 294 struct cmsghdr *__cmsg) __THROW; 295#ifdef __USE_EXTERN_INLINES 296# ifndef _EXTERN_INLINE 297# define _EXTERN_INLINE __extern_inline 298# endif 299_EXTERN_INLINE struct cmsghdr * 300__NTH (__cmsg_nxthdr (struct msghdr *__mhdr, struct cmsghdr *__cmsg)) 301{ 302 if ((size_t) __cmsg->cmsg_len < sizeof (struct cmsghdr)) 303 /* The kernel header does this so there may be a reason. */ 304 return 0; 305 306 __cmsg = (struct cmsghdr *) ((unsigned char *) __cmsg 307 + CMSG_ALIGN (__cmsg->cmsg_len)); 308 if ((unsigned char *) (__cmsg + 1) > ((unsigned char *) __mhdr->msg_control 309 + __mhdr->msg_controllen) 310 || ((unsigned char *) __cmsg + CMSG_ALIGN (__cmsg->cmsg_len) 311 > ((unsigned char *) __mhdr->msg_control + __mhdr->msg_controllen))) 312 /* No more entries. */ 313 return 0; 314 return __cmsg; 315} 316#endif /* Use `extern inline'. */ 317 318/* Socket level message types. This must match the definitions in 319 <linux/socket.h>. */ 320enum 321 { 322 SCM_RIGHTS = 0x01 /* Transfer file descriptors. */ 323#define SCM_RIGHTS SCM_RIGHTS 324#ifdef __USE_GNU 325 , SCM_CREDENTIALS = 0x02 /* Credentials passing. */ 326# define SCM_CREDENTIALS SCM_CREDENTIALS 327#endif 328 }; 329 330#ifdef __USE_GNU 331/* User visible structure for SCM_CREDENTIALS message */ 332struct ucred 333{ 334 pid_t pid; /* PID of sending process. */ 335 uid_t uid; /* UID of sending process. */ 336 gid_t gid; /* GID of sending process. */ 337}; 338#endif 339 340/* Ugly workaround for unclean kernel headers. */ 341#if !defined __USE_MISC && !defined __USE_GNU 342# ifndef FIOGETOWN 343# define __SYS_SOCKET_H_undef_FIOGETOWN 344# endif 345# ifndef FIOSETOWN 346# define __SYS_SOCKET_H_undef_FIOSETOWN 347# endif 348# ifndef SIOCATMARK 349# define __SYS_SOCKET_H_undef_SIOCATMARK 350# endif 351# ifndef SIOCGPGRP 352# define __SYS_SOCKET_H_undef_SIOCGPGRP 353# endif 354# ifndef SIOCGSTAMP 355# define __SYS_SOCKET_H_undef_SIOCGSTAMP 356# endif 357# ifndef SIOCGSTAMPNS 358# define __SYS_SOCKET_H_undef_SIOCGSTAMPNS 359# endif 360# ifndef SIOCSPGRP 361# define __SYS_SOCKET_H_undef_SIOCSPGRP 362# endif 363#endif 364 365/* Get socket manipulation related informations from kernel headers. */ 366#include <asm/socket.h> 367 368#if !defined __USE_MISC && !defined __USE_GNU 369# ifdef __SYS_SOCKET_H_undef_FIOGETOWN 370# undef __SYS_SOCKET_H_undef_FIOGETOWN 371# undef FIOGETOWN 372# endif 373# ifdef __SYS_SOCKET_H_undef_FIOSETOWN 374# undef __SYS_SOCKET_H_undef_FIOSETOWN 375# undef FIOSETOWN 376# endif 377# ifdef __SYS_SOCKET_H_undef_SIOCATMARK 378# undef __SYS_SOCKET_H_undef_SIOCATMARK 379# undef SIOCATMARK 380# endif 381# ifdef __SYS_SOCKET_H_undef_SIOCGPGRP 382# undef __SYS_SOCKET_H_undef_SIOCGPGRP 383# undef SIOCGPGRP 384# endif 385# ifdef __SYS_SOCKET_H_undef_SIOCGSTAMP 386# undef __SYS_SOCKET_H_undef_SIOCGSTAMP 387# undef SIOCGSTAMP 388# endif 389# ifdef __SYS_SOCKET_H_undef_SIOCGSTAMPNS 390# undef __SYS_SOCKET_H_undef_SIOCGSTAMPNS 391# undef SIOCGSTAMPNS 392# endif 393# ifdef __SYS_SOCKET_H_undef_SIOCSPGRP 394# undef __SYS_SOCKET_H_undef_SIOCSPGRP 395# undef SIOCSPGRP 396# endif 397#endif 398 399/* Structure used to manipulate the SO_LINGER option. */ 400struct linger 401 { 402 int l_onoff; /* Nonzero to linger on close. */ 403 int l_linger; /* Time to linger. */ 404 }; 405 406#endif /* bits/socket.h */ 407