Back to index

glibc  2.9
socket.h
Go to the documentation of this file.
00001 /* System-specific socket constants and types.  4.4 BSD version.
00002    Copyright (C) 1991,92,1994-2002,2004,2007 Free Software Foundation, Inc.
00003    This file is part of the GNU C Library.
00004 
00005    The GNU C Library is free software; you can redistribute it and/or
00006    modify it under the terms of the GNU Lesser General Public License as
00007    published by the Free Software Foundation; either version 2.1 of the
00008    License, or (at your option) any later version.
00009 
00010    The GNU C Library is distributed in the hope that it will be useful,
00011    but WITHOUT ANY WARRANTY; without even the implied warranty of
00012    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00013    Lesser General Public License for more details.
00014 
00015    You should have received a copy of the GNU Lesser General Public
00016    License along with the GNU C Library; see the file COPYING.LIB.  If not,
00017    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
00018    Boston, MA 02111-1307, USA.  */
00019 
00020 #ifndef __BITS_SOCKET_H
00021 #define __BITS_SOCKET_H     1
00022 
00023 #ifndef _SYS_SOCKET_H
00024 # error "Never include <bits/socket.h> directly; use <sys/socket.h> instead."
00025 #endif
00026 
00027 #define       __need_size_t
00028 #define __need_NULL
00029 #include <stddef.h>
00030 
00031 #include <limits.h>         /* XXX Is this allowed?  */
00032 #include <bits/types.h>
00033 
00034 /* Type for length arguments in socket calls.  */
00035 #ifndef __socklen_t_defined
00036 typedef __socklen_t socklen_t;
00037 # define __socklen_t_defined
00038 #endif
00039 
00040 
00041 /* Types of sockets.  */
00042 enum __socket_type
00043 {
00044   SOCK_STREAM = 1,          /* Sequenced, reliable, connection-based
00045                                byte streams.  */
00046 #define SOCK_STREAM SOCK_STREAM
00047   SOCK_DGRAM = 2,           /* Connectionless, unreliable datagrams
00048                                of fixed maximum length.  */
00049 #define SOCK_DGRAM SOCK_DGRAM
00050   SOCK_RAW = 3,                    /* Raw protocol interface.  */
00051 #define SOCK_RAW SOCK_RAW
00052   SOCK_RDM = 4,                    /* Reliably-delivered messages.  */
00053 #define SOCK_RDM SOCK_RDM
00054   SOCK_SEQPACKET = 5        /* Sequenced, reliable, connection-based,
00055                                datagrams of fixed maximum length.  */
00056 #define SOCK_SEQPACKET SOCK_SEQPACKET
00057 };
00058 
00059 /* Protocol families.  */
00060 #define       PF_UNSPEC     0      /* Unspecified.  */
00061 #define       PF_LOCAL      1      /* Local to host (pipes and file-domain).  */
00062 #define       PF_UNIX              PF_LOCAL /* Old BSD name for PF_LOCAL.  */
00063 #define       PF_FILE              PF_LOCAL /* POSIX name for PF_LOCAL.  */
00064 #define       PF_INET              2      /* IP protocol family.  */
00065 #define       PF_IMPLINK    3      /* ARPAnet IMP protocol.  */
00066 #define       PF_PUP        4      /* PUP protocols.  */
00067 #define       PF_CHAOS      5      /* MIT Chaos protocols.  */
00068 #define       PF_NS         6      /* Xerox NS protocols.  */
00069 #define       PF_ISO        7      /* ISO protocols.  */
00070 #define       PF_OSI        PF_ISO
00071 #define       PF_ECMA              8      /* ECMA protocols.  */
00072 #define       PF_DATAKIT    9      /* AT&T Datakit protocols.  */
00073 #define       PF_CCITT      10     /* CCITT protocols (X.25 et al).  */
00074 #define       PF_SNA        11     /* IBM SNA protocol.  */
00075 #define       PF_DECnet     12     /* DECnet protocols.  */
00076 #define       PF_DLI        13     /* Direct data link interface.  */
00077 #define       PF_LAT        14     /* DEC Local Area Transport protocol.  */
00078 #define       PF_HYLINK     15     /* NSC Hyperchannel protocol.  */
00079 #define       PF_APPLETALK  16     /* Don't use this.  */
00080 #define       PF_ROUTE      17     /* Internal Routing Protocol.  */
00081 #define       PF_LINK              18     /* Link layer interface.  */
00082 #define       PF_XTP        19     /* eXpress Transfer Protocol (no AF).  */
00083 #define       PF_COIP              20     /* Connection-oriented IP, aka ST II.  */
00084 #define       PF_CNT        21     /* Computer Network Technology.  */
00085 #define PF_RTIP             22     /* Help Identify RTIP packets.  **/
00086 #define       PF_IPX        23     /* Novell Internet Protocol.  */
00087 #define       PF_SIP        24     /* Simple Internet Protocol.  */
00088 #define PF_PIP              25     /* Help Identify PIP packets.  */
00089 #define PF_INET6     26     /* IP version 6.  */
00090 #define       PF_MAX        27
00091 
00092 /* Address families.  */
00093 #define       AF_UNSPEC     PF_UNSPEC
00094 #define       AF_LOCAL      PF_LOCAL
00095 #define       AF_UNIX              PF_UNIX
00096 #define       AF_FILE              PF_FILE
00097 #define       AF_INET              PF_INET
00098 #define       AF_IMPLINK    PF_IMPLINK
00099 #define       AF_PUP        PF_PUP
00100 #define       AF_CHAOS      PF_CHAOS
00101 #define       AF_NS         PF_NS
00102 #define       AF_ISO        PF_ISO
00103 #define       AF_OSI        PF_OSI
00104 #define       AF_ECMA              PF_ECMA
00105 #define       AF_DATAKIT    PF_DATAKIT
00106 #define       AF_CCITT      PF_CCITT
00107 #define       AF_SNA        PF_SNA
00108 #define       AF_DECnet     PF_DECnet
00109 #define       AF_DLI        PF_DLI
00110 #define       AF_LAT        PF_LAT
00111 #define       AF_HYLINK     PF_HYLINK
00112 #define       AF_APPLETALK  PF_APPLETALK
00113 #define       AF_ROUTE      PF_ROUTE
00114 #define       AF_LINK              PF_LINK
00115 #define       pseudo_AF_XTP PF_XTP
00116 #define       AF_COIP              PF_COIP
00117 #define       AF_CNT        PF_CNT
00118 #define pseudo_AF_RTIP      PF_RTIP
00119 #define       AF_IPX        PF_IPX
00120 #define       AF_SIP        PF_SIP
00121 #define pseudo_AF_PIP       PF_PIP
00122 #define AF_INET6     PF_INET6
00123 #define       AF_MAX        PF_MAX
00124 
00125 /* Maximum queue length specifiable by listen.  */
00126 #define SOMAXCONN    128    /* 5 on the origional 4.4 BSD.  */
00127 
00128 /* Get the definition of the macro to define the common sockaddr members.  */
00129 #include <bits/sockaddr.h>
00130 
00131 /* Structure describing a generic socket address.  */
00132 struct sockaddr
00133   {
00134     __SOCKADDR_COMMON (sa_);       /* Common data: address family and length.  */
00135     char sa_data[14];              /* Address data.  */
00136   };
00137 
00138 
00139 /* Structure large enough to hold any socket address (with the historical
00140    exception of AF_UNIX).  We reserve 128 bytes.  */
00141 #if ULONG_MAX > 0xffffffff
00142 # define __ss_aligntype     __uint64_t
00143 #else
00144 # define __ss_aligntype     __uint32_t
00145 #endif
00146 #define _SS_SIZE     128
00147 #define _SS_PADSIZE  (_SS_SIZE - (2 * sizeof (__ss_aligntype)))
00148 
00149 struct sockaddr_storage
00150   {
00151     __SOCKADDR_COMMON (ss_);       /* Address family, etc.  */
00152     __ss_aligntype __ss_align;     /* Force desired alignment.  */
00153     char __ss_padding[_SS_PADSIZE];
00154   };
00155 
00156 
00157 /* Bits in the FLAGS argument to `send', `recv', et al.  */
00158 enum
00159   {
00160     MSG_OOB          = 0x01,       /* Process out-of-band data.  */
00161 #define MSG_OOB MSG_OOB
00162     MSG_PEEK         = 0x02,       /* Peek at incoming messages.  */
00163 #define MSG_PEEK MSG_PEEK
00164     MSG_DONTROUTE    = 0x04,       /* Don't use local routing.  */
00165 #define MSG_DONTROUTE MSG_DONTROUTE
00166     MSG_EOR          = 0x08,       /* Data completes record.  */
00167 #define MSG_EOR MSG_EOR
00168     MSG_TRUNC        = 0x10,       /* Data discarded before delivery.  */
00169 #define MSG_TRUNC MSG_TRUNC
00170     MSG_CTRUNC              = 0x20,       /* Control data lost before delivery.  */
00171 #define MSG_CTRUNC MSG_CTRUNC
00172     MSG_WAITALL             = 0x40,       /* Wait for full request or error.  */
00173 #define MSG_WAITALL MSG_WAITALL
00174     MSG_DONTWAIT     = 0x80,       /* This message should be nonblocking.  */
00175 #define MSG_DONTWAIT MSG_DONTWAIT
00176     MSG_NOSIGNAL     = 0x0400      /* Do not generate SIGPIPE on EPIPE.  */
00177 #define MSG_NOSIGNAL MSG_NOSIGNAL
00178   };
00179 
00180 
00181 /* Structure describing messages sent by
00182    `sendmsg' and received by `recvmsg'.  */
00183 struct msghdr
00184   {
00185     void *msg_name;         /* Address to send to/receive from.  */
00186     socklen_t msg_namelen;  /* Length of address data.  */
00187 
00188     struct iovec *msg_iov;  /* Vector of data to send/receive into.  */
00189     int msg_iovlen;         /* Number of elements in the vector.  */
00190 
00191     void *msg_control;             /* Ancillary data (eg BSD filedesc passing). */
00192     socklen_t msg_controllen;      /* Ancillary data buffer length.  */
00193 
00194     int msg_flags;          /* Flags in received message.  */
00195   };
00196 
00197 /* Structure used for storage of ancillary data object information.  */
00198 struct cmsghdr
00199   {
00200     socklen_t cmsg_len;            /* Length of data in cmsg_data plus length
00201                                of cmsghdr structure.  */
00202     int cmsg_level;         /* Originating protocol.  */
00203     int cmsg_type;          /* Protocol specific type.  */
00204 #if (!defined __STRICT_ANSI__ && __GNUC__ >= 2) || __STDC_VERSION__ >= 199901L
00205     __extension__ unsigned char __cmsg_data __flexarr; /* Ancillary data.  */
00206 #endif
00207   };
00208 
00209 /* Ancillary data object manipulation macros.  */
00210 #if (!defined __STRICT_ANSI__ && __GNUC__ >= 2) || __STDC_VERSION__ >= 199901L
00211 # define CMSG_DATA(cmsg) ((cmsg)->__cmsg_data)
00212 #else
00213 # define CMSG_DATA(cmsg) ((unsigned char *) ((struct cmsghdr *) (cmsg) + 1))
00214 #endif
00215 
00216 #define CMSG_NXTHDR(mhdr, cmsg) __cmsg_nxthdr (mhdr, cmsg)
00217 
00218 #define CMSG_FIRSTHDR(mhdr) \
00219   ((size_t) (mhdr)->msg_controllen >= sizeof (struct cmsghdr)               \
00220    ? (struct cmsghdr *) (mhdr)->msg_control : (struct cmsghdr *) NULL)
00221 
00222 #define CMSG_ALIGN(len) (((len) + sizeof (size_t) - 1) \
00223                         & (size_t) ~(sizeof (size_t) - 1))
00224 #define CMSG_SPACE(len) (CMSG_ALIGN (len) \
00225                       + CMSG_ALIGN (sizeof (struct cmsghdr)))
00226 #define CMSG_LEN(len)   (CMSG_ALIGN (sizeof (struct cmsghdr)) + (len))
00227 
00228 extern struct cmsghdr *__cmsg_nxthdr (struct msghdr *__mhdr,
00229                                   struct cmsghdr *__cmsg) __THROW;
00230 #ifdef __USE_EXTERN_INLINES
00231 # ifndef _EXTERN_INLINE
00232 #  define _EXTERN_INLINE __extern_inline
00233 # endif
00234 _EXTERN_INLINE struct cmsghdr *
00235 __NTH (__cmsg_nxthdr (struct msghdr *__mhdr, struct cmsghdr *__cmsg))
00236 {
00237   if ((size_t) __cmsg->cmsg_len < sizeof (struct cmsghdr))
00238     /* The kernel header does this so there may be a reason.  */
00239     return 0;
00240 
00241   __cmsg = (struct cmsghdr *) ((unsigned char *) __cmsg
00242                             + CMSG_ALIGN (__cmsg->cmsg_len));
00243   if ((unsigned char *) (__cmsg + 1) > ((unsigned char *) __mhdr->msg_control
00244                                    + __mhdr->msg_controllen)
00245       || ((unsigned char *) __cmsg + CMSG_ALIGN (__cmsg->cmsg_len)
00246          > ((unsigned char *) __mhdr->msg_control + __mhdr->msg_controllen)))
00247     /* No more entries.  */
00248     return 0;
00249   return __cmsg;
00250 }
00251 #endif /* Use `extern inline'.  */
00252 
00253 /* Socket level message types.  */
00254 enum
00255   {
00256     SCM_RIGHTS = 0x01,             /* Access rights (array of int).  */
00257 #define SCM_RIGHTS SCM_RIGHTS
00258     SCM_TIMESTAMP = 0x02,   /* Timestamp (struct timeval).  */
00259 #define SCM_TIMESTAMP SCM_TIMESTAMP
00260     SCM_CREDS = 0x03        /* Process creds (struct cmsgcred).  */
00261 #define SCM_CREDS SCM_CREDS
00262   };
00263 
00264 /* Unfortunately, BSD practice dictates this structure be of fixed size.
00265    If there are more than CMGROUP_MAX groups, the list is truncated.
00266    (On GNU systems, the `cmcred_euid' field is just the first in the
00267    list of effective UIDs.)  */
00268 #define CMGROUP_MAX  16
00269 
00270 /* Structure delivered by SCM_CREDS.  This describes the identity of the
00271    sender of the data simultaneously received on the socket.  By BSD
00272    convention, this is included only when a sender on a AF_LOCAL socket
00273    sends cmsg data of this type and size; the sender's structure is
00274    ignored, and the system fills in the various IDs of the sender process.  */
00275 struct cmsgcred
00276   {
00277     __pid_t cmcred_pid;
00278     __uid_t cmcred_uid;
00279     __uid_t cmcred_euid;
00280     __gid_t cmcred_gid;
00281     int cmcred_ngroups;
00282     __gid_t cmcred_groups[CMGROUP_MAX];
00283   };
00284 
00285 /* Protocol number used to manipulate socket-level options
00286    with `getsockopt' and `setsockopt'.  */
00287 #define       SOL_SOCKET    0xffff
00288 
00289 /* Socket-level options for `getsockopt' and `setsockopt'.  */
00290 enum
00291   {
00292     SO_DEBUG = 0x0001,             /* Record debugging information.  */
00293 #define SO_DEBUG SO_DEBUG
00294     SO_ACCEPTCONN = 0x0002, /* Accept connections on socket.  */
00295 #define SO_ACCEPTCONN SO_ACCEPTCONN
00296     SO_REUSEADDR = 0x0004,  /* Allow reuse of local addresses.  */
00297 #define SO_REUSEADDR SO_REUSEADDR
00298     SO_KEEPALIVE = 0x0008,  /* Keep connections alive and send
00299                                SIGPIPE when they die.  */
00300 #define SO_KEEPALIVE SO_KEEPALIVE
00301     SO_DONTROUTE = 0x0010,  /* Don't do local routing.  */
00302 #define SO_DONTROUTE SO_DONTROUTE
00303     SO_BROADCAST = 0x0020,  /* Allow transmission of
00304                                broadcast messages.  */
00305 #define SO_BROADCAST SO_BROADCAST
00306     SO_USELOOPBACK = 0x0040,       /* Use the software loopback to avoid
00307                                hardware use when possible.  */
00308 #define SO_USELOOPBACK SO_USELOOPBACK
00309     SO_LINGER = 0x0080,            /* Block on close of a reliable
00310                                socket to transmit pending data.  */
00311 #define SO_LINGER SO_LINGER
00312     SO_OOBINLINE = 0x0100,  /* Receive out-of-band data in-band.  */
00313 #define SO_OOBINLINE SO_OOBINLINE
00314     SO_REUSEPORT = 0x0200,  /* Allow local address and port reuse.  */
00315 #define SO_REUSEPORT SO_REUSEPORT
00316     SO_SNDBUF = 0x1001,            /* Send buffer size.  */
00317 #define SO_SNDBUF SO_SNDBUF
00318     SO_RCVBUF = 0x1002,            /* Receive buffer.  */
00319 #define SO_RCVBUF SO_RCVBUF
00320     SO_SNDLOWAT = 0x1003,   /* Send low-water mark.  */
00321 #define SO_SNDLOWAT SO_SNDLOWAT
00322     SO_RCVLOWAT = 0x1004,   /* Receive low-water mark.  */
00323 #define SO_RCVLOWAT SO_RCVLOWAT
00324     SO_SNDTIMEO = 0x1005,   /* Send timeout.  */
00325 #define SO_SNDTIMEO SO_SNDTIMEO
00326     SO_RCVTIMEO = 0x1006,   /* Receive timeout.  */
00327 #define SO_RCVTIMEO SO_RCVTIMEO
00328     SO_ERROR = 0x1007,             /* Get and clear error status.  */
00329 #define SO_ERROR SO_ERROR
00330     SO_STYLE = 0x1008,             /* Get socket connection style.  */
00331 #define SO_STYLE SO_STYLE
00332     SO_TYPE = SO_STYLE             /* Compatible name for SO_STYLE.  */
00333 #define SO_TYPE SO_TYPE
00334   };
00335 
00336 /* Structure used to manipulate the SO_LINGER option.  */
00337 struct linger
00338   {
00339     int l_onoff;            /* Nonzero to linger on close.  */
00340     int l_linger;           /* Time to linger.  */
00341   };
00342 
00343 #endif /* bits/socket.h */