sysdeps/unix/sysv/linux/bits/socket.h

   1 /* System-specific socket constants and types.  Linux version.
   2    Copyright (C) 1991, 1992, 1994-2001, 2004, 2006, 2007, 2008
   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
  35 typedef __socklen_t socklen_t;
  36 # define __socklen_t_defined
  37 #endif
  38
  39 /* Types of sockets.  */
  40 enum __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_SNA          22      /* Linux SNA Project */
  99 #define PF_IRDA         23      /* IRDA sockets.  */
 100 #define PF_PPPOX        24      /* PPPoX sockets.  */
 101 #define PF_WANPIPE      25      /* Wanpipe API sockets.  */
 102 #define PF_BLUETOOTH    31      /* Bluetooth sockets.  */
 103 #define PF_IUCV         32      /* IUCV sockets.  */
 104 #define PF_RXRPC        33      /* RxRPC sockets.  */
 105 #define PF_MAX          34      /* For now..  */
 106
 107 /* Address families.  */
 108 #define AF_UNSPEC       PF_UNSPEC
 109 #define AF_LOCAL        PF_LOCAL
 110 #define AF_UNIX         PF_UNIX
 111 #define AF_FILE         PF_FILE
 112 #define AF_INET         PF_INET
 113 #define AF_AX25         PF_AX25
 114 #define AF_IPX          PF_IPX
 115 #define AF_APPLETALK    PF_APPLETALK
 116 #define AF_NETROM       PF_NETROM
 117 #define AF_BRIDGE       PF_BRIDGE
 118 #define AF_ATMPVC       PF_ATMPVC
 119 #define AF_X25          PF_X25
 120 #define AF_INET6        PF_INET6
 121 #define AF_ROSE         PF_ROSE
 122 #define AF_DECnet       PF_DECnet
 123 #define AF_NETBEUI      PF_NETBEUI
 124 #define AF_SECURITY     PF_SECURITY
 125 #define AF_KEY          PF_KEY
 126 #define AF_NETLINK      PF_NETLINK
 127 #define AF_ROUTE        PF_ROUTE
 128 #define AF_PACKET       PF_PACKET
 129 #define AF_ASH          PF_ASH
 130 #define AF_ECONET       PF_ECONET
 131 #define AF_ATMSVC       PF_ATMSVC
 132 #define AF_SNA          PF_SNA
 133 #define AF_IRDA         PF_IRDA
 134 #define AF_PPPOX        PF_PPPOX
 135 #define AF_WANPIPE      PF_WANPIPE
 136 #define AF_BLUETOOTH    PF_BLUETOOTH
 137 #define AF_IUCV         PF_IUCV
 138 #define AF_RXRPC        PF_RXRPC
 139 #define AF_MAX          PF_MAX
 140
 141 /* Socket level values.  Others are defined in the appropriate headers.
 142
 143    XXX These definitions also should go into the appropriate headers as
 144    far as they are available.  */
 145 #define SOL_RAW         255
 146 #define SOL_DECNET      261
 147 #define SOL_X25         262
 148 #define SOL_PACKET      263
 149 #define SOL_ATM         264     /* ATM layer (cell level).  */
 150 #define SOL_AAL         265     /* ATM Adaption Layer (packet level).  */
 151 #define SOL_IRDA        266
 152
 153 /* Maximum queue length specifiable by listen.  */
 154 #define SOMAXCONN       128
 155
 156 /* Get the definition of the macro to define the common sockaddr members.  */
 157 #include <bits/sockaddr.h>
 158
 159 /* Structure describing a generic socket address.  */
 160 struct sockaddr
 161   {
 162     __SOCKADDR_COMMON (sa_);    /* Common data: address family and length.  */
 163     char sa_data[14];           /* Address data.  */
 164   };
 165
 166
 167 /* Structure large enough to hold any socket address (with the historical
 168    exception of AF_UNIX).  We reserve 128 bytes.  */
 169 #define __ss_aligntype  unsigned long int
 170 #define _SS_SIZE        128
 171 #define _SS_PADSIZE     (_SS_SIZE - (2 * sizeof (__ss_aligntype)))
 172
 173 struct sockaddr_storage
 174   {
 175     __SOCKADDR_COMMON (ss_);    /* Address family, etc.  */
 176     __ss_aligntype __ss_align;  /* Force desired alignment.  */
 177     char __ss_padding[_SS_PADSIZE];
 178   };
 179
 180
 181 /* Bits in the FLAGS argument to `send', `recv', et al.  */
 182 enum
 183   {
 184     MSG_OOB             = 0x01, /* Process out-of-band data.  */
 185 #define MSG_OOB         MSG_OOB
 186     MSG_PEEK            = 0x02, /* Peek at incoming messages.  */
 187 #define MSG_PEEK        MSG_PEEK
 188     MSG_DONTROUTE       = 0x04, /* Don't use local routing.  */
 189 #define MSG_DONTROUTE   MSG_DONTROUTE
 190 #ifdef __USE_GNU
 191     /* DECnet uses a different name.  */
 192     MSG_TRYHARD         = MSG_DONTROUTE,
 193 # define MSG_TRYHARD    MSG_DONTROUTE
 194 #endif
 195     MSG_CTRUNC          = 0x08, /* Control data lost before delivery.  */
 196 #define MSG_CTRUNC      MSG_CTRUNC
 197     MSG_PROXY           = 0x10, /* Supply or ask second address.  */
 198 #define MSG_PROXY       MSG_PROXY
 199     MSG_TRUNC           = 0x20,
 200 #define MSG_TRUNC       MSG_TRUNC
 201     MSG_DONTWAIT        = 0x40, /* Nonblocking IO.  */
 202 #define MSG_DONTWAIT    MSG_DONTWAIT
 203     MSG_EOR             = 0x80, /* End of record.  */
 204 #define MSG_EOR         MSG_EOR
 205     MSG_WAITALL         = 0x100, /* Wait for a full request.  */
 206 #define MSG_WAITALL     MSG_WAITALL
 207     MSG_FIN             = 0x200,
 208 #define MSG_FIN         MSG_FIN
 209     MSG_SYN             = 0x400,
 210 #define MSG_SYN         MSG_SYN
 211     MSG_CONFIRM         = 0x800, /* Confirm path validity.  */
 212 #define MSG_CONFIRM     MSG_CONFIRM
 213     MSG_RST             = 0x1000,
 214 #define MSG_RST         MSG_RST
 215     MSG_ERRQUEUE        = 0x2000, /* Fetch message from error queue.  */
 216 #define MSG_ERRQUEUE    MSG_ERRQUEUE
 217     MSG_NOSIGNAL        = 0x4000, /* Do not generate SIGPIPE.  */
 218 #define MSG_NOSIGNAL    MSG_NOSIGNAL
 219     MSG_MORE            = 0x8000,  /* Sender will send more.  */
 220 #define MSG_MORE        MSG_MORE
 221
 222     MSG_CMSG_CLOEXEC    = 0x40000000    /* Set close_on_exit for file
 223                                            descriptor received through
 224                                            SCM_RIGHTS.  */
 225 #define MSG_CMSG_CLOEXEC MSG_CMSG_CLOEXEC
 226   };
 227
 228
 229 /* Structure describing messages sent by
 230    `sendmsg' and received by `recvmsg'.  */
 231 struct msghdr
 232   {
 233     void *msg_name;             /* Address to send to/receive from.  */
 234     socklen_t msg_namelen;      /* Length of address data.  */
 235
 236     struct iovec *msg_iov;      /* Vector of data to send/receive into.  */
 237     size_t msg_iovlen;          /* Number of elements in the vector.  */
 238
 239     void *msg_control;          /* Ancillary data (eg BSD filedesc passing). */
 240     size_t msg_controllen;      /* Ancillary data buffer length.
 241                                    !! The type should be socklen_t but the
 242                                    definition of the kernel is incompatible
 243                                    with this.  */
 244
 245     int msg_flags;              /* Flags on received message.  */
 246   };
 247
 248 /* Structure used for storage of ancillary data object information.  */
 249 struct cmsghdr
 250   {
 251     size_t cmsg_len;            /* Length of data in cmsg_data plus length
 252                                    of cmsghdr structure.
 253                                    !! The type should be socklen_t but the
 254                                    definition of the kernel is incompatible
 255                                    with this.  */
 256     int cmsg_level;             /* Originating protocol.  */
 257     int cmsg_type;              /* Protocol specific type.  */
 258 #if (!defined __STRICT_ANSI__ && __GNUC__ >= 2) || __STDC_VERSION__ >= 199901L
 259     __extension__ unsigned char __cmsg_data __flexarr; /* Ancillary data.  */
 260 #endif
 261   };
 262
 263 /* Ancillary data object manipulation macros.  */
 264 #if (!defined __STRICT_ANSI__ && __GNUC__ >= 2) || __STDC_VERSION__ >= 199901L
 265 # define CMSG_DATA(cmsg) ((cmsg)->__cmsg_data)
 266 #else
 267 # define CMSG_DATA(cmsg) ((unsigned char *) ((struct cmsghdr *) (cmsg) + 1))
 268 #endif
 269 #define CMSG_NXTHDR(mhdr, cmsg) __cmsg_nxthdr (mhdr, cmsg)
 270 #define CMSG_FIRSTHDR(mhdr) \
 271   ((size_t) (mhdr)->msg_controllen >= sizeof (struct cmsghdr)                 \
 272    ? (struct cmsghdr *) (mhdr)->msg_control : (struct cmsghdr *) 0)
 273 #define CMSG_ALIGN(len) (((len) + sizeof (size_t) - 1) \
 274                          & (size_t) ~(sizeof (size_t) - 1))
 275 #define CMSG_SPACE(len) (CMSG_ALIGN (len) \
 276                          + CMSG_ALIGN (sizeof (struct cmsghdr)))
 277 #define CMSG_LEN(len)   (CMSG_ALIGN (sizeof (struct cmsghdr)) + (len))
 278
 279 extern struct cmsghdr *__cmsg_nxthdr (struct msghdr *__mhdr,
 280                                       struct cmsghdr *__cmsg) __THROW;
 281 #ifdef __USE_EXTERN_INLINES
 282 # ifndef _EXTERN_INLINE
 283 #  define _EXTERN_INLINE __extern_inline
 284 # endif
 285 _EXTERN_INLINE struct cmsghdr *
 286 __NTH (__cmsg_nxthdr (struct msghdr *__mhdr, struct cmsghdr *__cmsg))
 287 {
 288   if ((size_t) __cmsg->cmsg_len < sizeof (struct cmsghdr))
 289     /* The kernel header does this so there may be a reason.  */
 290     return 0;
 291
 292   __cmsg = (struct cmsghdr *) ((unsigned char *) __cmsg
 293                                + CMSG_ALIGN (__cmsg->cmsg_len));
 294   if ((unsigned char *) (__cmsg + 1) > ((unsigned char *) __mhdr->msg_control
 295                                         + __mhdr->msg_controllen)
 296       || ((unsigned char *) __cmsg + CMSG_ALIGN (__cmsg->cmsg_len)
 297           > ((unsigned char *) __mhdr->msg_control + __mhdr->msg_controllen)))
 298     /* No more entries.  */
 299     return 0;
 300   return __cmsg;
 301 }
 302 #endif  /* Use `extern inline'.  */
 303
 304 /* Socket level message types.  This must match the definitions in
 305    <linux/socket.h>.  */
 306 enum
 307   {
 308     SCM_RIGHTS = 0x01           /* Transfer file descriptors.  */
 309 #define SCM_RIGHTS SCM_RIGHTS
 310 #ifdef __USE_BSD
 311     , SCM_CREDENTIALS = 0x02    /* Credentials passing.  */
 312 # define SCM_CREDENTIALS SCM_CREDENTIALS
 313 #endif
 314   };
 315
 316 #ifdef __USE_GNU
 317 /* User visible structure for SCM_CREDENTIALS message */
 318 struct ucred
 319 {
 320   pid_t pid;                    /* PID of sending process.  */
 321   uid_t uid;                    /* UID of sending process.  */
 322   gid_t gid;                    /* GID of sending process.  */
 323 };
 324 #endif
 325
 326 /* Ugly workaround for unclean kernel headers.  */
 327 #if !defined __USE_MISC && !defined __USE_GNU
 328 # ifndef FIOGETOWN
 329 #  define __SYS_SOCKET_H_undef_FIOGETOWN
 330 # endif
 331 # ifndef FIOSETOWN
 332 #  define __SYS_SOCKET_H_undef_FIOSETOWN
 333 # endif
 334 # ifndef SIOCATMARK
 335 #  define __SYS_SOCKET_H_undef_SIOCATMARK
 336 # endif
 337 # ifndef SIOCGPGRP
 338 #  define __SYS_SOCKET_H_undef_SIOCGPGRP
 339 # endif
 340 # ifndef SIOCGSTAMP
 341 #  define __SYS_SOCKET_H_undef_SIOCGSTAMP
 342 # endif
 343 # ifndef SIOCGSTAMPNS
 344 #  define __SYS_SOCKET_H_undef_SIOCGSTAMPNS
 345 # endif
 346 # ifndef SIOCSPGRP
 347 #  define __SYS_SOCKET_H_undef_SIOCSPGRP
 348 # endif
 349 #endif
 350
 351 /* Get socket manipulation related informations from kernel headers.  */
 352 #include <asm/socket.h>
 353
 354 #if !defined __USE_MISC && !defined __USE_GNU
 355 # ifdef __SYS_SOCKET_H_undef_FIOGETOWN
 356 #  undef __SYS_SOCKET_H_undef_FIOGETOWN
 357 #  undef FIOGETOWN
 358 # endif
 359 # ifdef __SYS_SOCKET_H_undef_FIOSETOWN
 360 #  undef __SYS_SOCKET_H_undef_FIOSETOWN
 361 #  undef FIOSETOWN
 362 # endif
 363 # ifdef __SYS_SOCKET_H_undef_SIOCATMARK
 364 #  undef __SYS_SOCKET_H_undef_SIOCATMARK
 365 #  undef SIOCATMARK
 366 # endif
 367 # ifdef __SYS_SOCKET_H_undef_SIOCGPGRP
 368 #  undef __SYS_SOCKET_H_undef_SIOCGPGRP
 369 #  undef SIOCGPGRP
 370 # endif
 371 # ifdef __SYS_SOCKET_H_undef_SIOCGSTAMP
 372 #  undef __SYS_SOCKET_H_undef_SIOCGSTAMP
 373 #  undef SIOCGSTAMP
 374 # endif
 375 # ifdef __SYS_SOCKET_H_undef_SIOCGSTAMPNS
 376 #  undef __SYS_SOCKET_H_undef_SIOCGSTAMPNS
 377 #  undef SIOCGSTAMPNS
 378 # endif
 379 # ifdef __SYS_SOCKET_H_undef_SIOCSPGRP
 380 #  undef __SYS_SOCKET_H_undef_SIOCSPGRP
 381 #  undef SIOCSPGRP
 382 # endif
 383 #endif
 384
 385 /* Structure used to manipulate the SO_LINGER option.  */
 386 struct linger
 387   {
 388     int l_onoff;                /* Nonzero to linger on close.  */
 389     int l_linger;               /* Time to linger.  */
 390   };
 391
 392 #endif  /* bits/socket.h */