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

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