bits/socket.h

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