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

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