include-glibc/socketbits.h

   1 /* System-specific socket constants and types.  Linux version.
   2    Copyright (C) 1991, 92, 94, 95, 96, 97, 98 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 Library General Public License as
   7    published by the Free Software Foundation; either version 2 of the
   8    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    Library General Public License for more details.
  14
  15    You should have received a copy of the GNU Library General Public
  16    License along with the GNU C Library; see the file COPYING.LIB.  If not,
  17    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18    Boston, MA 02111-1307, USA.  */
  19
  20 #ifndef _SOCKETBITS_H
  21
  22 #define _SOCKETBITS_H   1
  23 #include <features.h>
  24
  25 #define __need_size_t
  26 #define __need_NULL
  27 #include <stddef.h>
  28
  29
  30 __BEGIN_DECLS
  31
  32 /* Type for length arguments in socket calls.  */
  33 #ifndef __socklen_t_defined
  34 typedef unsigned int socklen_t;
  35 # define __socklen_t_defined
  36 #endif
  37
  38 /* Types of sockets.  */
  39 enum __socket_type
  40 {
  41   SOCK_STREAM = 1,              /* Sequenced, reliable, connection-based
  42                                    byte streams.  */
  43 #define SOCK_STREAM SOCK_STREAM
  44   SOCK_DGRAM = 2,               /* Connectionless, unreliable datagrams
  45                                    of fixed maximum length.  */
  46 #define SOCK_DGRAM SOCK_DGRAM
  47   SOCK_RAW = 3,                 /* Raw protocol interface.  */
  48 #define SOCK_RAW SOCK_RAW
  49   SOCK_RDM = 4,                 /* Reliably-delivered messages.  */
  50 #define SOCK_RDM SOCK_RDM
  51   SOCK_SEQPACKET = 5,           /* Sequenced, reliable, connection-based,
  52                                    datagrams of fixed maximum length.  */
  53 #define SOCK_SEQPACKET SOCK_SEQPACKET
  54   SOCK_PACKET = 10              /* Linux specific way of getting packets
  55                                    at the dev level.  For writing rarp and
  56                                    other similar things on the user level. */
  57 #define SOCK_PACKET SOCK_PACKET
  58 };
  59
  60 /* Protocol families.  */
  61 #define PF_UNSPEC       0       /* Unspecified.  */
  62 #define PF_LOCAL        1       /* Local to host (pipes and file-domain).  */
  63 #define PF_UNIX         PF_LOCAL /* Old BSD name for PF_LOCAL.  */
  64 #define PF_FILE         PF_LOCAL /* POSIX name for PF_LOCAL.  */
  65 #define PF_INET         2       /* IP protocol family.  */
  66 #define PF_AX25         3       /* Amateur Radio AX.25.  */
  67 #define PF_IPX          4       /* Novell Internet Protocol.  */
  68 #define PF_APPLETALK    5       /* Don't use this.  */
  69 #define PF_NETROM       6       /* Amateur radio NetROM.  */
  70 #define PF_BRIDGE       7       /* Multiprotocol bridge.  */
  71 #define PF_AAL5         8       /* Reserved for Werner's ATM.  */
  72 #define PF_X25          9       /* Reserved for X.25 project.  */
  73 #define PF_INET6        10      /* IP version 6.  */
  74 #define PF_ROSE         11      /* Amateur Radio X.25 PLP       */
  75 #define PF_DECnet       12      /* Reserved for DECnet project  */
  76 #define PF_NETBEUI      13      /* Reserved for 802.2LLC project*/
  77 #define PF_SECURITY     14      /* Security callback pseudo AF */
  78 #define PF_KEY          15      /* PF_KEY key management API */
  79 #define PF_NETLINK      16
  80 #define PF_ROUTE        PF_NETLINK /* Alias to emulate 4.4BSD */
  81 #define PF_PACKET       17      /* Packet family                */
  82 #define PF_MAX          32      /* For now.. */
  83
  84 /* Address families.  */
  85 #define AF_UNSPEC       PF_UNSPEC
  86 #define AF_LOCAL        PF_LOCAL
  87 #define AF_UNIX         PF_UNIX
  88 #define AF_FILE         PF_FILE
  89 #define AF_INET         PF_INET
  90 #define AF_AX25         PF_AX25
  91 #define AF_IPX          PF_IPX
  92 #define AF_APPLETALK    PF_APPLETALK
  93 #define AF_NETROM       PF_NETROM
  94 #define AF_BRIDGE       PF_BRIDGE
  95 #define AF_AAL5         PF_AAL5
  96 #define AF_X25          PF_X25
  97 #define AF_INET6        PF_INET6
  98 #define AF_ROSE         PF_ROSE
  99 #define AF_DECnet       PF_DECnet
 100 #define AF_NETBEUI      PF_NETBEUI
 101 #define AF_SECURITY     PF_SECURITY
 102 #define pseudo_AF_KEY   pseudo_PF_KEY
 103 #define AF_NETLINK      PF_NETLINK
 104 #define AF_ROUTE        PF_ROUTE
 105 #define AF_PACKET       PF_PACKET
 106 #define AF_MAX          PF_MAX
 107
 108 /* Socket level values.  Others are defined in the appropriate headers.
 109
 110    XXX These definitions also should go into the appropriate headers as
 111    far as they are available.  */
 112 #define SOL_IPV6        41
 113 #define SOL_ICMPV6      58
 114 #define SOL_RAW         255
 115 #define SOL_AX25        257
 116 #define SOL_ATALK       258
 117 #define SOL_NETROM      259
 118 #define SOL_ROSE        260
 119 #define SOL_DECNET      261
 120 #define SOL_X25         262
 121
 122 /* Maximum queue length specifiable by listen.  */
 123 #define SOMAXCONN       128
 124
 125 /* Get the definition of the macro to define the common sockaddr members.  */
 126 #if __GLIBC_MINOR__  >= 1
 127 #include <bits/sockaddr.h>
 128 #else
 129 #include <sockaddrcom.h>
 130 #endif
 131
 132 /* Structure describing a generic socket address.  */
 133 struct sockaddr
 134   {
 135     __SOCKADDR_COMMON (sa_);    /* Common data: address family and length.  */
 136     char sa_data[14];           /* Address data.  */
 137   };
 138
 139
 140 /* Bits in the FLAGS argument to `send', `recv', et al.  */
 141 enum
 142   {
 143     MSG_OOB             = 0x01, /* Process out-of-band data.  */
 144 #define MSG_OOB         MSG_OOB
 145     MSG_PEEK            = 0x02, /* Peek at incoming messages.  */
 146 #define MSG_PEEK        MSG_PEEK
 147     MSG_DONTROUTE       = 0x04, /* Don't use local routing.  */
 148 #define MSG_DONTROUTE   MSG_DONTROUTE
 149     MSG_CTRUNC          = 0x08, /* Control data lost before delivery.  */
 150 #define MSG_CTRUNC      MSG_CTRUNC
 151     MSG_PROXY           = 0x10, /* Supply or ask second address.  */
 152 #define MSG_PROXY       MSG_PROXY
 153     MSG_TRUNC           = 0x20,
 154 #define MSG_TRUNC       MSG_TRUNC
 155     MSG_DONTWAIT        = 0x40,
 156 #define MSG_DONTWAIT    MSG_DONTWAIT
 157     MSG_WAITALL         = 0x100,
 158 #define MSG_WAITALL     MSG_WAITALL
 159     MSG_ERRQUEUE        = 0x2000,
 160 #define MSG_ERRQUEUE    MSG_ERRQUEUE
 161     MSG_NOSIGNAL        = 0x4000,
 162 #define MSG_NOSIGNAL    MSG_NOSIGNAL
 163   };
 164
 165
 166 /* Structure describing messages sent by
 167    `sendmsg' and received by `recvmsg'.  */
 168 struct msghdr
 169   {
 170     __ptr_t msg_name;           /* Address to send to/receive from.  */
 171     socklen_t msg_namelen;      /* Length of address data.  */
 172
 173     struct iovec *msg_iov;      /* Vector of data to send/receive into.  */
 174     size_t msg_iovlen;          /* Number of elements in the vector.  */
 175
 176     __ptr_t msg_control;        /* Ancillary data (eg BSD filedesc passing). */
 177     size_t msg_controllen;      /* Ancillary data buffer length.  */
 178
 179     int msg_flags;              /* Flags on received message.  */
 180   };
 181
 182 /* Structure used for storage of ancillary data object information.  */
 183 struct cmsghdr
 184   {
 185     size_t cmsg_len;            /* Length of data in cmsg_data plus length
 186                                    of cmsghdr structure.  */
 187     int cmsg_level;             /* Originating protocol.  */
 188     int cmsg_type;              /* Protocol specific type.  */
 189 #if !defined __STRICT_ANSI__ && defined __GNUC__ && __GNUC__ >= 2
 190     unsigned char __cmsg_data[0]; /* Ancillary data.  */
 191 #endif
 192   };
 193
 194 /* Ancillary data object manipulation macros.  */
 195 #if !defined __STRICT_ANSI__ && defined __GNUC__ && __GNUC__ >= 2
 196 # define CMSG_DATA(cmsg) ((cmsg)->__cmsg_data)
 197 #else
 198 # define CMSG_DATA(cmsg) ((unsigned char *) ((struct cmsghdr *) (cmsg) + 1))
 199 #endif
 200 #define CMSG_NXTHDR(mhdr, cmsg) __cmsg_nxthdr (mhdr, cmsg)
 201 #define CMSG_FIRSTHDR(mhdr) \
 202   ((size_t) (mhdr)->msg_controllen >= sizeof (struct cmsghdr)                 \
 203    ? (struct cmsghdr *) (mhdr)->msg_control : (struct cmsghdr *) NULL)
 204 #define CMSG_ALIGN(len) ( ((len)+sizeof(long)-1) & ~(sizeof(long)-1) )
 205 #define CMSG_SPACE(len) (CMSG_ALIGN(sizeof(struct cmsghdr)) + CMSG_ALIGN(len))
 206 #define CMSG_LEN(len) (CMSG_ALIGN(sizeof(struct cmsghdr)) + (len))
 207
 208
 209 #ifndef _EXTERN_INLINE
 210 # define _EXTERN_INLINE extern __inline
 211 #endif
 212 extern struct cmsghdr *__cmsg_nxthdr __P ((struct msghdr *__mhdr,
 213                                            struct cmsghdr *__cmsg));
 214 _EXTERN_INLINE struct cmsghdr *
 215 __cmsg_nxthdr (struct msghdr *__mhdr, struct cmsghdr *__cmsg)
 216 {
 217   if ((size_t) __cmsg->cmsg_len < sizeof (struct cmsghdr))
 218           /* The kernel header does this so there may be a reason.  */
 219           return NULL;
 220
 221   __cmsg = (struct cmsghdr *)
 222           ((unsigned char *) __cmsg + CMSG_ALIGN(__cmsg->cmsg_len));
 223
 224   if ( (unsigned char *) (__cmsg + 1) >=
 225            (unsigned char *) __mhdr->msg_control + __mhdr->msg_controllen)
 226           /* No more entries.  */
 227           return NULL;
 228   return __cmsg;
 229 }
 230
 231 /* Socket level message types.  This must match the definitions in
 232    <linux/socket.h>.  */
 233 enum
 234   {
 235     SCM_RIGHTS = 0x01,         /* Data array contains access rights.  */
 236 #define SCM_RIGHTS SCM_RIGHTS
 237     SCM_CREDENTIALS = 0x02,  /* Data array is `struct ucred'.  */
 238 #define SCM_CREDENTIALS SCM_CREDENTIALS
 239   };
 240
 241
 242
 243 /* Get socket manipulation related informations from kernel headers.  */
 244 #ifdef THIS_IS_CRAP
 245 #ifndef _LINUX_TYPES_H
 246 # define _LINUX_TYPES_H
 247 #endif
 248 #endif
 249
 250 #include <asm/socket.h>
 251 #include <asm/types.h>
 252
 253 struct ucred
 254 {
 255         __u32   pid;
 256         __u32   uid;
 257         __u32   gid;
 258 };
 259
 260
 261 /* Structure used to manipulate the SO_LINGER option.  */
 262 struct linger
 263   {
 264     int l_onoff;                /* Nonzero to linger on close.  */
 265     int l_linger;               /* Time to linger.  */
 266   };
 267
 268 __END_DECLS
 269
 270 #endif /* socketbits.h */