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