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