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 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
  25 #include <features.h>
  26
  27 #define __need_size_t
  28 #define __need_NULL
  29 #include <stddef.h>
  30
  31 #include <sys/types.h>
  32
  33 __BEGIN_DECLS
  34
  35 /* Type for length arguments in socket calls.  */
  36 typedef unsigned int socklen_t;
  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_MAX          12      /* For now.. */
  75
  76 /* Address families.  */
  77 #define AF_UNSPEC       PF_UNSPEC
  78 #define AF_LOCAL        PF_LOCAL
  79 #define AF_UNIX         PF_UNIX
  80 #define AF_FILE         PF_FILE
  81 #define AF_INET         PF_INET
  82 #define AF_AX25         PF_AX25
  83 #define AF_IPX          PF_IPX
  84 #define AF_APPLETALK    PF_APPLETALK
  85 #define AF_NETROM       PF_NETROM
  86 #define AF_BRIDGE       PF_BRIDGE
  87 #define AF_AAL5         PF_AAL5
  88 #define AF_X25          PF_X25
  89 #define AF_INET6        PF_INET6
  90 #define AF_MAX          PF_MAX
  91
  92 /* Socket level values.  Others are defined in the appropriate headers.
  93
  94    XXX These definitions also should go into the appropriate headers as
  95    far as they are available.  */
  96 #define SOL_IPV6        41
  97 #define SOL_ICMPV6      58
  98 #define SOL_RAW         255
  99 #define SOL_AX25        257
 100 #define SOL_ATALK       258
 101 #define SOL_NETROM      259
 102 #define SOL_ROSE        260
 103 #define SOL_DECNET      261
 104 #define SOL_X25         262
 105
 106 /* Maximum queue length specifiable by listen.  */
 107 #define SOMAXCONN       128
 108
 109 /* Get the definition of the macro to define the common sockaddr members.  */
 110 #include <bits/sockaddr.h>
 111
 112 /* Structure describing a generic socket address.  */
 113 struct sockaddr
 114   {
 115     __SOCKADDR_COMMON (sa_);    /* Common data: address family and length.  */
 116     char sa_data[14];           /* Address data.  */
 117   };
 118
 119
 120 /* Bits in the FLAGS argument to `send', `recv', et al.  */
 121 enum
 122   {
 123     MSG_OOB             = 0x01, /* Process out-of-band data.  */
 124     MSG_PEEK            = 0x02, /* Peek at incoming messages.  */
 125     MSG_DONTROUTE       = 0x04, /* Don't use local routing.  */
 126     MSG_CTRUNC          = 0x08, /* Control data lost before delivery.  */
 127     MSG_PROXY           = 0x10  /* Supply or ask second address.  */
 128   };
 129
 130
 131 /* Structure describing messages sent by
 132    `sendmsg' and received by `recvmsg'.  */
 133 struct msghdr
 134   {
 135     __ptr_t msg_name;           /* Address to send to/receive from.  */
 136     socklen_t msg_namelen;      /* Length of address data.  */
 137
 138     struct iovec *msg_iov;      /* Vector of data to send/receive into.  */
 139     int msg_iovlen;             /* Number of elements in the vector.  */
 140
 141     __ptr_t msg_control;        /* Ancillary data (eg BSD filedesc passing). */
 142     socklen_t msg_controllen;   /* Ancillary data buffer length.  */
 143
 144     int msg_flags;              /* Flags on received message.  */
 145   };
 146
 147 /* Structure used for storage of ancillary data object information.  */
 148 struct cmsghdr
 149   {
 150     socklen_t cmsg_len;         /* Length of data in cmsg_data plus length
 151                                    of cmsghdr structure.  */
 152     int cmsg_level;             /* Originating protocol.  */
 153     int cmsg_type;              /* Protocol specific type.  */
 154 #if !defined __STRICT_ANSI__ && defined __GNUC__ && __GNUC__ >= 2
 155     unsigned char __cmsg_data[0]; /* Ancillary data.  */
 156     /* XXX Perhaps this should be removed.  */
 157 #endif
 158   };
 159
 160 /* Ancillary data object manipulation macros.  */
 161 #if !defined __STRICT_ANSI__ && defined __GNUC__ && __GNUC__ >= 2
 162 # define CMSG_DATA(cmsg) ((cmsg)->__cmsg_data)
 163 #else
 164 # define CMSG_DATA(cmsg) ((unsigned char *) ((struct cmsghdr *) (cmsg) + 1))
 165 #endif
 166 #define CMSG_NXTHDR(mhdr, cmsg) __cmsg_nxthdr (mhdr, cmsg)
 167 #define CMSG_FIRSTHDR(mhdr) \
 168   ((size_t) (mhdr)->msg_controllen >= sizeof (struct cmsghdr)                 \
 169    ? (struct cmsghdr *) (mhdr)->msg_control : (struct cmsghdr *) NULL)
 170 #define CMSG_ALIGN(len) (((len) + sizeof (size_t) - 1) \
 171                          & ~(sizeof (size_t) - 1))
 172 #define CMSG_SPACE(len) (CMSG_ALIGN (len) \
 173                          + CMSG_ALIGN (sizeof (struct cmsghdr)))
 174 #define CMSG_LEN(len)   (CMSG_ALIGN (sizeof (struct cmsghdr)) + (len))
 175
 176 #ifndef _EXTERN_INLINE
 177 # define _EXTERN_INLINE extern __inline
 178 #endif
 179 extern struct cmsghdr *__cmsg_nxthdr __P ((struct msghdr *__mhdr,
 180                                            struct cmsghdr *__cmsg));
 181 _EXTERN_INLINE struct cmsghdr *
 182 __cmsg_nxthdr (struct msghdr *__mhdr, struct cmsghdr *__cmsg)
 183 {
 184   unsigned char *__p;
 185
 186   if ((size_t) __cmsg->cmsg_len < sizeof (struct cmsghdr))
 187     /* The kernel header does this so there may be a reason.  */
 188     return NULL;
 189
 190   __p = (((unsigned char *) __cmsg)
 191          + ((__cmsg->cmsg_len + sizeof (long int) - 1) & ~sizeof (long int)));
 192   if (__p >= (unsigned char *) __mhdr->msg_control + __mhdr->msg_controllen)
 193     /* No more entries.  */
 194     return NULL;
 195   return (struct cmsghdr *) __p;
 196 }
 197
 198
 199 /* Get socket manipulation related informations from kernel headers.  */
 200 #include <asm/socket.h>
 201
 202
 203 /* Structure used to manipulate the SO_LINGER option.  */
 204 struct linger
 205   {
 206     int l_onoff;                /* Nonzero to linger on close.  */
 207     int l_linger;               /* Time to linger.  */
 208   };
 209
 210 __END_DECLS