sysdeps/unix/sysv/linux/bits/socket.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 __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 <sys/types.h>
  32
  33 /* Type for length arguments in socket calls.  */
  34 typedef unsigned int socklen_t;
  35
  36 /* Types of sockets.  */
  37 enum __socket_type
  38 {
  39   SOCK_STREAM = 1,              /* Sequenced, reliable, connection-based
  40                                    byte streams.  */
  41 #define SOCK_STREAM SOCK_STREAM
  42   SOCK_DGRAM = 2,               /* Connectionless, unreliable datagrams
  43                                    of fixed maximum length.  */
  44 #define SOCK_DGRAM SOCK_DGRAM
  45   SOCK_RAW = 3,                 /* Raw protocol interface.  */
  46 #define SOCK_RAW SOCK_RAW
  47   SOCK_RDM = 4,                 /* Reliably-delivered messages.  */
  48 #define SOCK_RDM SOCK_RDM
  49   SOCK_SEQPACKET = 5,           /* Sequenced, reliable, connection-based,
  50                                    datagrams of fixed maximum length.  */
  51 #define SOCK_SEQPACKET SOCK_SEQPACKET
  52   SOCK_PACKET = 10              /* Linux specific way of getting packets
  53                                    at the dev level.  For writing rarp and
  54                                    other similar things on the user level. */
  55 #define SOCK_PACKET SOCK_PACKET
  56 };
  57
  58 /* Protocol families.  */
  59 #define PF_UNSPEC       0       /* Unspecified.  */
  60 #define PF_LOCAL        1       /* Local to host (pipes and file-domain).  */
  61 #define PF_UNIX         PF_LOCAL /* Old BSD name for PF_LOCAL.  */
  62 #define PF_FILE         PF_LOCAL /* Another non-standard name for PF_LOCAL.  */
  63 #define PF_INET         2       /* IP protocol family.  */
  64 #define PF_AX25         3       /* Amateur Radio AX.25.  */
  65 #define PF_IPX          4       /* Novell Internet Protocol.  */
  66 #define PF_APPLETALK    5       /* Appletalk DDP.  */
  67 #define PF_NETROM       6       /* Amateur radio NetROM.  */
  68 #define PF_BRIDGE       7       /* Multiprotocol bridge.  */
  69 #define PF_ATMPVC       8       /* ATM PVCs.  */
  70 #define PF_X25          9       /* Reserved for X.25 project.  */
  71 #define PF_INET6        10      /* IP version 6.  */
  72 #define PF_ROSE         11      /* Amateur Radio X.25 PLP.  */
  73 #define PF_DECnet       12      /* Reserved for DECnet project.  */
  74 #define PF_NETBEUI      13      /* Reserved for 802.2LLC project.  */
  75 #define PF_SECURITY     14      /* Security callback pseudo AF.  */
  76 #define PF_KEY          15      /* PF_KEY key management API.  */
  77 #define PF_NETLINK      16
  78 #define PF_ROUTE        PF_NETLINK /* Alias to emulate 4.4BSD.  */
  79 #define PF_PACKET       17      /* Packet family.  */
  80 #define PF_ASH          18      /* Ash.  */
  81 #define PF_ECONET       19      /* Acorn Econet.  */
  82 #define PF_ATMSVC       20      /* ATM SVCs.  */
  83 #define PF_SNA          22      /* Linux SNA Project */
  84 #define PF_MAX          32      /* For now..  */
  85
  86 /* Address families.  */
  87 #define AF_UNSPEC       PF_UNSPEC
  88 #define AF_LOCAL        PF_LOCAL
  89 #define AF_UNIX         PF_UNIX
  90 #define AF_FILE         PF_FILE
  91 #define AF_INET         PF_INET
  92 #define AF_AX25         PF_AX25
  93 #define AF_IPX          PF_IPX
  94 #define AF_APPLETALK    PF_APPLETALK
  95 #define AF_NETROM       PF_NETROM
  96 #define AF_BRIDGE       PF_BRIDGE
  97 #define AF_ATMPVC       PF_ATMPVC
  98 #define AF_X25          PF_X25
  99 #define AF_INET6        PF_INET6
 100 #define AF_ROSE         PF_ROSE
 101 #define AF_DECnet       PF_DECnet
 102 #define AF_NETBEUI      PF_NETBEUI
 103 #define AF_SECURITY     PF_SECURITY
 104 #define pseudo_AF_KEY   PF_KEY
 105 #define AF_NETLINK      PF_NETLINK
 106 #define AF_ROUTE        PF_ROUTE
 107 #define AF_PACKET       PF_PACKET
 108 #define AF_ASH          PF_ASH
 109 #define AF_ECONET       PF_ECONET
 110 #define AF_ATMSVC       PF_ATMSVC
 111 #define AF_SNA          PF_SNA
 112 #define AF_MAX          PF_MAX
 113
 114 /* Socket level values.  Others are defined in the appropriate headers.
 115
 116    XXX These definitions also should go into the appropriate headers as
 117    far as they are available.  */
 118 #define SOL_IPV6        41
 119 #define SOL_ICMPV6      58
 120 #define SOL_RAW         255
 121 #define SOL_DECNET      261
 122 #define SOL_X25         262
 123
 124 /* Maximum queue length specifiable by listen.  */
 125 #define SOMAXCONN       128
 126
 127 /* Get the definition of the macro to define the common sockaddr members.  */
 128 #include <bits/sockaddr.h>
 129
 130 /* Structure describing a generic socket address.  */
 131 struct sockaddr
 132   {
 133     __SOCKADDR_COMMON (sa_);    /* Common data: address family and length.  */
 134     char sa_data[14];           /* Address data.  */
 135   };
 136
 137
 138 /* Bits in the FLAGS argument to `send', `recv', et al.  */
 139 enum
 140   {
 141     MSG_OOB             = 0x01, /* Process out-of-band data.  */
 142 #define MSG_OOB         MSG_OOB
 143     MSG_PEEK            = 0x02, /* Peek at incoming messages.  */
 144 #define MSG_PEEK        MSG_PEEK
 145     MSG_DONTROUTE       = 0x04, /* Don't use local routing.  */
 146 #define MSG_DONTROUTE   MSG_DONTROUTE
 147     MSG_CTRUNC          = 0x08, /* Control data lost before delivery.  */
 148 #define MSG_CTRUNC      MSG_CTRUNC
 149     MSG_PROXY           = 0x10  /* Supply or ask second address.  */
 150 #define MSG_PROXY       MSG_PROXY
 151   };
 152
 153
 154 /* Structure describing messages sent by
 155    `sendmsg' and received by `recvmsg'.  */
 156 struct msghdr
 157   {
 158     __ptr_t msg_name;           /* Address to send to/receive from.  */
 159     socklen_t msg_namelen;      /* Length of address data.  */
 160
 161     struct iovec *msg_iov;      /* Vector of data to send/receive into.  */
 162     size_t msg_iovlen;          /* Number of elements in the vector.  */
 163
 164     __ptr_t msg_control;        /* Ancillary data (eg BSD filedesc passing). */
 165     size_t msg_controllen;      /* Ancillary data buffer length.  */
 166
 167     int msg_flags;              /* Flags on received message.  */
 168   };
 169
 170 /* Structure used for storage of ancillary data object information.  */
 171 struct cmsghdr
 172   {
 173     size_t cmsg_len;            /* Length of data in cmsg_data plus length
 174                                    of cmsghdr structure.  */
 175     int cmsg_level;             /* Originating protocol.  */
 176     int cmsg_type;              /* Protocol specific type.  */
 177 #if !defined __STRICT_ANSI__ && defined __GNUC__ && __GNUC__ >= 2
 178     unsigned char __cmsg_data[0]; /* Ancillary data.  */
 179     /* XXX Perhaps this should be removed.  */
 180 #endif
 181   };
 182
 183 /* Ancillary data object manipulation macros.  */
 184 #if !defined __STRICT_ANSI__ && defined __GNUC__ && __GNUC__ >= 2
 185 # define CMSG_DATA(cmsg) ((cmsg)->__cmsg_data)
 186 #else
 187 # define CMSG_DATA(cmsg) ((unsigned char *) ((struct cmsghdr *) (cmsg) + 1))
 188 #endif
 189 #define CMSG_NXTHDR(mhdr, cmsg) __cmsg_nxthdr (mhdr, cmsg)
 190 #define CMSG_FIRSTHDR(mhdr) \
 191   ((size_t) (mhdr)->msg_controllen >= sizeof (struct cmsghdr)                 \
 192    ? (struct cmsghdr *) (mhdr)->msg_control : (struct cmsghdr *) NULL)
 193 #define CMSG_ALIGN(len) (((len) + sizeof (size_t) - 1) \
 194                          & ~(sizeof (size_t) - 1))
 195 #define CMSG_SPACE(len) (CMSG_ALIGN (len) \
 196                          + CMSG_ALIGN (sizeof (struct cmsghdr)))
 197 #define CMSG_LEN(len)   (CMSG_ALIGN (sizeof (struct cmsghdr)) + (len))
 198
 199 #ifndef _EXTERN_INLINE
 200 # define _EXTERN_INLINE extern __inline
 201 #endif
 202 extern struct cmsghdr *__cmsg_nxthdr __P ((struct msghdr *__mhdr,
 203                                            struct cmsghdr *__cmsg));
 204 _EXTERN_INLINE struct cmsghdr *
 205 __cmsg_nxthdr (struct msghdr *__mhdr, struct cmsghdr *__cmsg)
 206 {
 207   unsigned char *__p;
 208
 209   if ((size_t) __cmsg->cmsg_len < sizeof (struct cmsghdr))
 210     /* The kernel header does this so there may be a reason.  */
 211     return NULL;
 212
 213   __p = (((unsigned char *) __cmsg)
 214          + ((__cmsg->cmsg_len + sizeof (long int) - 1) & ~sizeof (long int)));
 215   if (__p >= (unsigned char *) __mhdr->msg_control + __mhdr->msg_controllen)
 216     /* No more entries.  */
 217     return NULL;
 218   return (struct cmsghdr *) __p;
 219 }
 220
 221 /* Socket level message types.  This must match the definitions in
 222    <linux/socket.h>.  */
 223 enum
 224   {
 225     SCM_RIGHTS = 0x01,          /* Transfer file descriptors.  */
 226 #define SCM_RIGHTS SCM_RIGHTS
 227 #ifdef __USE_BSD
 228     SCM_CREDS = 0x02,           /* BSD-compatible credentials passing.  */
 229 # define SCM_CREDS SCM_CREDS
 230 #endif
 231     __SCM_CONNECT = 0x03,       /* Data array is `struct scm_connect'.  */
 232   };
 233
 234 #ifdef __USE_BSD
 235
 236 /* User visible structure for SCM_CREDS message
 237    (chosen for BSD source compatibility) */
 238
 239 # define CMGROUP_MAX 16  /* Linux does not provide this info, so it doesn't
 240                             matter... use what bsd does. */
 241 struct cmsgcred
 242 {
 243   pid_t cmcred_pid;                     /* PID of sending process.  */
 244   uid_t cmcred_uid;                     /* Real UID of sending process.  */
 245   uid_t cmcred_euid;                    /* Effective UID of sending process. */
 246   gid_t cmcred_gid;                     /* Real GID of sending process.  */
 247   short int cmcred_ngroups;             /* Number or groups.  */
 248   gid_t cmcred_groups[CMGROUP_MAX];     /* Groups.  */
 249 };
 250 #endif
 251
 252 /* Get socket manipulation related informations from kernel headers.  */
 253 #include <asm/socket.h>
 254
 255
 256 /* Structure used to manipulate the SO_LINGER option.  */
 257 struct linger
 258   {
 259     int l_onoff;                /* Nonzero to linger on close.  */
 260     int l_linger;               /* Time to linger.  */
 261   };
 262
 263 #endif  /* bits/socket.h */