bits/socket.h

   1 /* System-specific socket constants and types.  Generic/4.3 BSD version.
   2    Copyright (C) 1991,92,1994-1999,2000,2001 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 Lesser General Public
   7    License as published by the Free Software Foundation; either
   8    version 2.1 of the 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    Lesser General Public License for more details.
  14
  15    You should have received a copy of the GNU Lesser General Public
  16    License along with the GNU C Library; if not, see
  17    <http://www.gnu.org/licenses/>.  */
  18
  19 #ifndef __BITS_SOCKET_H
  20 #define __BITS_SOCKET_H 1
  21
  22 #if !defined _SYS_SOCKET_H && !defined _NETINET_IN_H
  23 # error "Never include <bits/socket.h> directly; use <sys/socket.h> instead."
  24 #endif
  25
  26 #include <limits.h>
  27 #include <bits/types.h>
  28
  29 #define __need_size_t
  30 #include <stddef.h>
  31
  32 /* Type for length arguments in socket calls.  */
  33 #ifndef __socklen_t_defined
  34 typedef __socklen_t socklen_t;
  35 # define __socklen_t_defined
  36 #endif
  37
  38
  39 /* Types of sockets.  */
  40 enum __socket_type
  41 {
  42   SOCK_STREAM = 1,              /* Sequenced, reliable, connection-based
  43                                    byte streams.  */
  44 #define SOCK_STREAM SOCK_STREAM
  45   SOCK_DGRAM = 2,               /* Connectionless, unreliable datagrams
  46                                    of fixed maximum length.  */
  47 #define SOCK_DGRAM SOCK_DGRAM
  48   SOCK_RAW = 3,                 /* Raw protocol interface.  */
  49 #define SOCK_RAW SOCK_RAW
  50   SOCK_RDM = 4,                 /* Reliably-delivered messages.  */
  51 #define SOCK_RDM SOCK_RDM
  52   SOCK_SEQPACKET = 5            /* Sequenced, reliable, connection-based,
  53                                    datagrams of fixed maximum length.  */
  54 #define SOCK_SEQPACKET SOCK_SEQPACKET
  55 };
  56
  57 /* Protocol families.  */
  58 #define PF_UNSPEC       0       /* Unspecified.  */
  59 #define PF_LOCAL        1       /* Local to host (pipes and file-domain).  */
  60 #define PF_UNIX         PF_LOCAL /* Old BSD name for PF_LOCAL.  */
  61 #define PF_FILE         PF_LOCAL /* POSIX name for PF_LOCAL.  */
  62 #define PF_INET         2       /* IP protocol family.  */
  63 #define PF_IMPLINK      3       /* ARPAnet IMP protocol.  */
  64 #define PF_PUP          4       /* PUP protocols.  */
  65 #define PF_CHAOS        5       /* MIT Chaos protocols.  */
  66 #define PF_NS           6       /* Xerox NS protocols.  */
  67 #define PF_ISO          7       /* ISO protocols.  */
  68 #define PF_OSI          PF_ISO
  69 #define PF_ECMA         8       /* ECMA protocols.  */
  70 #define PF_DATAKIT      9       /* AT&T Datakit protocols.  */
  71 #define PF_CCITT        10      /* CCITT protocols (X.25 et al).  */
  72 #define PF_SNA          11      /* IBM SNA protocol.  */
  73 #define PF_DECnet       12      /* DECnet protocols.  */
  74 #define PF_DLI          13      /* Direct data link interface.  */
  75 #define PF_LAT          14      /* DEC Local Area Transport protocol.  */
  76 #define PF_HYLINK       15      /* NSC Hyperchannel protocol.  */
  77 #define PF_APPLETALK    16      /* Don't use this.  */
  78 #define PF_ROUTE        17      /* Internal Routing Protocol.  */
  79 #define PF_LINK         18      /* Link layer interface.  */
  80 #define PF_XTP          19      /* eXpress Transfer Protocol (no AF).  */
  81 #define PF_COIP         20      /* Connection-oriented IP, aka ST II.  */
  82 #define PF_CNT          21      /* Computer Network Technology.  */
  83 #define PF_RTIP         22      /* Help Identify RTIP packets.  **/
  84 #define PF_IPX          23      /* Novell Internet Protocol.  */
  85 #define PF_SIP          24      /* Simple Internet Protocol.  */
  86 #define PF_PIP          25      /* Help Identify PIP packets.  */
  87 #define PF_INET6        26      /* IP version 6.  */
  88 #define PF_MAX          27
  89
  90 /* Address families.  */
  91 #define AF_UNSPEC       PF_UNSPEC
  92 #define AF_LOCAL        PF_LOCAL
  93 #define AF_UNIX         PF_UNIX
  94 #define AF_FILE         PF_FILE
  95 #define AF_INET         PF_INET
  96 #define AF_IMPLINK      PF_IMPLINK
  97 #define AF_PUP          PF_PUP
  98 #define AF_CHAOS        PF_CHAOS
  99 #define AF_NS           PF_NS
 100 #define AF_ISO          PF_ISO
 101 #define AF_OSI          PF_OSI
 102 #define AF_ECMA         PF_ECMA
 103 #define AF_DATAKIT      PF_DATAKIT
 104 #define AF_CCITT        PF_CCITT
 105 #define AF_SNA          PF_SNA
 106 #define AF_DECnet       PF_DECnet
 107 #define AF_DLI          PF_DLI
 108 #define AF_LAT          PF_LAT
 109 #define AF_HYLINK       PF_HYLINK
 110 #define AF_APPLETALK    PF_APPLETALK
 111 #define AF_ROUTE        PF_ROUTE
 112 #define AF_LINK         PF_LINK
 113 #define pseudo_AF_XTP   PF_XTP
 114 #define AF_COIP         PF_COIP
 115 #define AF_CNT          PF_CNT
 116 #define pseudo_AF_RTIP  PF_RTIP
 117 #define AF_IPX          PF_IPX
 118 #define AF_SIP          PF_SIP
 119 #define pseudo_AF_PIP   PF_PIP
 120 #define AF_INET6        PF_INET6
 121 #define AF_MAX          PF_MAX
 122
 123
 124 /* Get the definition of the macro to define the common sockaddr members.  */
 125 #include <bits/sockaddr.h>
 126
 127 /* Structure describing a generic socket address.  */
 128 struct sockaddr
 129   {
 130     __SOCKADDR_COMMON (sa_);    /* Common data: address family and length.  */
 131     char sa_data[14];           /* Address data.  */
 132   };
 133
 134
 135 /* Structure large enough to hold any socket address (with the historical
 136    exception of AF_UNIX).  We reserve 128 bytes.  */
 137 #if ULONG_MAX > 0xffffffff
 138 # define __ss_aligntype __uint64_t
 139 #else
 140 # define __ss_aligntype __uint32_t
 141 #endif
 142 #define _SS_SIZE        128
 143 #define _SS_PADSIZE     (_SS_SIZE - (2 * sizeof (__ss_aligntype)))
 144
 145 struct sockaddr_storage
 146   {
 147     __SOCKADDR_COMMON (ss_);    /* Address family, etc.  */
 148     __ss_aligntype __ss_align;  /* Force desired alignment.  */
 149     char __ss_padding[_SS_PADSIZE];
 150   };
 151
 152
 153 /* Bits in the FLAGS argument to `send', `recv', et al.  */
 154 enum
 155   {
 156     MSG_OOB             = 0x01, /* Process out-of-band data.  */
 157 #define MSG_OOB MSG_OOB
 158     MSG_PEEK            = 0x02, /* Peek at incoming messages.  */
 159 #define MSG_PEEK MSG_PEEK
 160     MSG_DONTROUTE       = 0x04, /* Don't use local routing.  */
 161 #define MSG_DONTROUTE MSG_DONTROUTE
 162     MSG_EOR             = 0x08, /* Data completes record.  */
 163 #define MSG_EOR MSG_EOR
 164     MSG_TRUNC           = 0x10, /* Data discarded before delivery.  */
 165 #define MSG_TRUNC MSG_TRUNC
 166     MSG_CTRUNC          = 0x20, /* Control data lost before delivery.  */
 167 #define MSG_CTRUNC MSG_CTRUNC
 168     MSG_WAITALL         = 0x40, /* Wait for full request or error.  */
 169 #define MSG_WAITALL MSG_WAITALL
 170     MSG_DONTWAIT        = 0x80  /* This message should be nonblocking.  */
 171 #define MSG_DONTWAIT MSG_DONTWAIT
 172   };
 173
 174
 175 /* Structure describing messages sent by
 176    `sendmsg' and received by `recvmsg'.  */
 177 struct msghdr
 178   {
 179     __ptr_t msg_name;           /* Address to send to/receive from.  */
 180     socklen_t msg_namelen;      /* Length of address data.  */
 181
 182     struct iovec *msg_iov;      /* Vector of data to send/receive into.  */
 183     int msg_iovlen;             /* Number of elements in the vector.  */
 184
 185     __ptr_t msg_accrights;      /* Access rights information.  */
 186     socklen_t msg_accrightslen; /* Length of access rights information.  */
 187
 188     int msg_flags;              /* Flags in received message.  */
 189   };
 190
 191
 192 /* Protocol number used to manipulate socket-level options
 193    with `getsockopt' and `setsockopt'.  */
 194 #define SOL_SOCKET      0xffff
 195
 196 /* Socket-level options for `getsockopt' and `setsockopt'.  */
 197 enum
 198   {
 199     SO_DEBUG = 0x0001,          /* Record debugging information.  */
 200 #define SO_DEBUG SO_DEBUG
 201     SO_ACCEPTCONN = 0x0002,     /* Accept connections on socket.  */
 202 #define SO_ACCEPTCONN SO_ACCEPTCONN
 203     SO_REUSEADDR = 0x0004,      /* Allow reuse of local addresses.  */
 204 #define SO_REUSEADDR SO_REUSEADDR
 205     SO_KEEPALIVE = 0x0008,      /* Keep connections alive and send
 206                                    SIGPIPE when they die.  */
 207 #define SO_KEEPALIVE SO_KEEPALIVE
 208     SO_DONTROUTE = 0x0010,      /* Don't do local routing.  */
 209 #define SO_DONTROUTE SO_DONTROUTE
 210     SO_BROADCAST = 0x0020,      /* Allow transmission of
 211                                    broadcast messages.  */
 212 #define SO_BROADCAST SO_BROADCAST
 213     SO_USELOOPBACK = 0x0040,    /* Use the software loopback to avoid
 214                                    hardware use when possible.  */
 215 #define SO_USELOOPBACK SO_USELOOPBACK
 216     SO_LINGER = 0x0080,         /* Block on close of a reliable
 217                                    socket to transmit pending data.  */
 218 #define SO_LINGER SO_LINGER
 219     SO_OOBINLINE = 0x0100,      /* Receive out-of-band data in-band.  */
 220 #define SO_OOBINLINE SO_OOBINLINE
 221     SO_REUSEPORT = 0x0200,      /* Allow local address and port reuse.  */
 222 #define SO_REUSEPORT SO_REUSEPORT
 223     SO_SNDBUF = 0x1001,         /* Send buffer size.  */
 224 #define SO_SNDBUF SO_SNDBUF
 225     SO_RCVBUF = 0x1002,         /* Receive buffer.  */
 226 #define SO_RCVBUF SO_RCVBUF
 227     SO_SNDLOWAT = 0x1003,       /* Send low-water mark.  */
 228 #define SO_SNDLOWAT SO_SNDLOWAT
 229     SO_RCVLOWAT = 0x1004,       /* Receive low-water mark.  */
 230 #define SO_RCVLOWAT SO_RCVLOWAT
 231     SO_SNDTIMEO = 0x1005,       /* Send timeout.  */
 232 #define SO_SNDTIMEO SO_SNDTIMEO
 233     SO_RCVTIMEO = 0x1006,       /* Receive timeout.  */
 234 #define SO_RCVTIMEO SO_RCVTIMEO
 235     SO_ERROR = 0x1007,          /* Get and clear error status.  */
 236 #define SO_ERROR SO_ERROR
 237     SO_STYLE = 0x1008,          /* Get socket connection style.  */
 238 #define SO_STYLE SO_STYLE
 239     SO_TYPE = SO_STYLE          /* Compatible name for SO_STYLE.  */
 240 #define SO_TYPE SO_TYPE
 241   };
 242
 243 /* Structure used to manipulate the SO_LINGER option.  */
 244 struct linger
 245   {
 246     int l_onoff;                /* Nonzero to linger on close.  */
 247     int l_linger;               /* Time to linger.  */
 248   };
 249
 250 #endif  /* bits/socket.h */