Updated to fedora-glibc-20080703T1203
[kopensolaris-gnu/glibc.git] / sysdeps / unix / bsd / bsd4.4 / bits / socket.h
1 /* System-specific socket constants and types.  4.4 BSD version.
2    Copyright (C) 1991,92,1994-2002,2004,2007 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 License as
7    published by the Free Software Foundation; either version 2.1 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    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; 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 __BITS_SOCKET_H
21 #define __BITS_SOCKET_H 1
22
23 #ifndef _SYS_SOCKET_H
24 # error "Never include <bits/socket.h> directly; use <sys/socket.h> instead."
25 #endif
26
27 #define __need_size_t
28 #define __need_NULL
29 #include <stddef.h>
30
31 #include <limits.h>             /* XXX Is this allowed?  */
32 #include <bits/types.h>
33
34 /* Type for length arguments in socket calls.  */
35 #ifndef __socklen_t_defined
36 typedef __socklen_t socklen_t;
37 # define __socklen_t_defined
38 #endif
39
40
41 /* Types of sockets.  */
42 enum __socket_type
43 {
44   SOCK_STREAM = 1,              /* Sequenced, reliable, connection-based
45                                    byte streams.  */
46 #define SOCK_STREAM SOCK_STREAM
47   SOCK_DGRAM = 2,               /* Connectionless, unreliable datagrams
48                                    of fixed maximum length.  */
49 #define SOCK_DGRAM SOCK_DGRAM
50   SOCK_RAW = 3,                 /* Raw protocol interface.  */
51 #define SOCK_RAW SOCK_RAW
52   SOCK_RDM = 4,                 /* Reliably-delivered messages.  */
53 #define SOCK_RDM SOCK_RDM
54   SOCK_SEQPACKET = 5            /* Sequenced, reliable, connection-based,
55                                    datagrams of fixed maximum length.  */
56 #define SOCK_SEQPACKET SOCK_SEQPACKET
57 };
58
59 /* Protocol families.  */
60 #define PF_UNSPEC       0       /* Unspecified.  */
61 #define PF_LOCAL        1       /* Local to host (pipes and file-domain).  */
62 #define PF_UNIX         PF_LOCAL /* Old BSD name for PF_LOCAL.  */
63 #define PF_FILE         PF_LOCAL /* POSIX name for PF_LOCAL.  */
64 #define PF_INET         2       /* IP protocol family.  */
65 #define PF_IMPLINK      3       /* ARPAnet IMP protocol.  */
66 #define PF_PUP          4       /* PUP protocols.  */
67 #define PF_CHAOS        5       /* MIT Chaos protocols.  */
68 #define PF_NS           6       /* Xerox NS protocols.  */
69 #define PF_ISO          7       /* ISO protocols.  */
70 #define PF_OSI          PF_ISO
71 #define PF_ECMA         8       /* ECMA protocols.  */
72 #define PF_DATAKIT      9       /* AT&T Datakit protocols.  */
73 #define PF_CCITT        10      /* CCITT protocols (X.25 et al).  */
74 #define PF_SNA          11      /* IBM SNA protocol.  */
75 #define PF_DECnet       12      /* DECnet protocols.  */
76 #define PF_DLI          13      /* Direct data link interface.  */
77 #define PF_LAT          14      /* DEC Local Area Transport protocol.  */
78 #define PF_HYLINK       15      /* NSC Hyperchannel protocol.  */
79 #define PF_APPLETALK    16      /* Don't use this.  */
80 #define PF_ROUTE        17      /* Internal Routing Protocol.  */
81 #define PF_LINK         18      /* Link layer interface.  */
82 #define PF_XTP          19      /* eXpress Transfer Protocol (no AF).  */
83 #define PF_COIP         20      /* Connection-oriented IP, aka ST II.  */
84 #define PF_CNT          21      /* Computer Network Technology.  */
85 #define PF_RTIP         22      /* Help Identify RTIP packets.  **/
86 #define PF_IPX          23      /* Novell Internet Protocol.  */
87 #define PF_SIP          24      /* Simple Internet Protocol.  */
88 #define PF_PIP          25      /* Help Identify PIP packets.  */
89 #define PF_INET6        26      /* IP version 6.  */
90 #define PF_MAX          27
91
92 /* Address families.  */
93 #define AF_UNSPEC       PF_UNSPEC
94 #define AF_LOCAL        PF_LOCAL
95 #define AF_UNIX         PF_UNIX
96 #define AF_FILE         PF_FILE
97 #define AF_INET         PF_INET
98 #define AF_IMPLINK      PF_IMPLINK
99 #define AF_PUP          PF_PUP
100 #define AF_CHAOS        PF_CHAOS
101 #define AF_NS           PF_NS
102 #define AF_ISO          PF_ISO
103 #define AF_OSI          PF_OSI
104 #define AF_ECMA         PF_ECMA
105 #define AF_DATAKIT      PF_DATAKIT
106 #define AF_CCITT        PF_CCITT
107 #define AF_SNA          PF_SNA
108 #define AF_DECnet       PF_DECnet
109 #define AF_DLI          PF_DLI
110 #define AF_LAT          PF_LAT
111 #define AF_HYLINK       PF_HYLINK
112 #define AF_APPLETALK    PF_APPLETALK
113 #define AF_ROUTE        PF_ROUTE
114 #define AF_LINK         PF_LINK
115 #define pseudo_AF_XTP   PF_XTP
116 #define AF_COIP         PF_COIP
117 #define AF_CNT          PF_CNT
118 #define pseudo_AF_RTIP  PF_RTIP
119 #define AF_IPX          PF_IPX
120 #define AF_SIP          PF_SIP
121 #define pseudo_AF_PIP   PF_PIP
122 #define AF_INET6        PF_INET6
123 #define AF_MAX          PF_MAX
124
125 /* Maximum queue length specifiable by listen.  */
126 #define SOMAXCONN       128     /* 5 on the origional 4.4 BSD.  */
127
128 /* Get the definition of the macro to define the common sockaddr members.  */
129 #include <bits/sockaddr.h>
130
131 /* Structure describing a generic socket address.  */
132 struct sockaddr
133   {
134     __SOCKADDR_COMMON (sa_);    /* Common data: address family and length.  */
135     char sa_data[14];           /* Address data.  */
136   };
137
138
139 /* Structure large enough to hold any socket address (with the historical
140    exception of AF_UNIX).  We reserve 128 bytes.  */
141 #if ULONG_MAX > 0xffffffff
142 # define __ss_aligntype __uint64_t
143 #else
144 # define __ss_aligntype __uint32_t
145 #endif
146 #define _SS_SIZE        128
147 #define _SS_PADSIZE     (_SS_SIZE - (2 * sizeof (__ss_aligntype)))
148
149 struct sockaddr_storage
150   {
151     __SOCKADDR_COMMON (ss_);    /* Address family, etc.  */
152     __ss_aligntype __ss_align;  /* Force desired alignment.  */
153     char __ss_padding[_SS_PADSIZE];
154   };
155
156
157 /* Bits in the FLAGS argument to `send', `recv', et al.  */
158 enum
159   {
160     MSG_OOB             = 0x01, /* Process out-of-band data.  */
161 #define MSG_OOB MSG_OOB
162     MSG_PEEK            = 0x02, /* Peek at incoming messages.  */
163 #define MSG_PEEK MSG_PEEK
164     MSG_DONTROUTE       = 0x04, /* Don't use local routing.  */
165 #define MSG_DONTROUTE MSG_DONTROUTE
166     MSG_EOR             = 0x08, /* Data completes record.  */
167 #define MSG_EOR MSG_EOR
168     MSG_TRUNC           = 0x10, /* Data discarded before delivery.  */
169 #define MSG_TRUNC MSG_TRUNC
170     MSG_CTRUNC          = 0x20, /* Control data lost before delivery.  */
171 #define MSG_CTRUNC MSG_CTRUNC
172     MSG_WAITALL         = 0x40, /* Wait for full request or error.  */
173 #define MSG_WAITALL MSG_WAITALL
174     MSG_DONTWAIT        = 0x80, /* This message should be nonblocking.  */
175 #define MSG_DONTWAIT MSG_DONTWAIT
176     MSG_NOSIGNAL        = 0x0400        /* Do not generate SIGPIPE on EPIPE.  */
177 #define MSG_NOSIGNAL MSG_NOSIGNAL
178   };
179
180
181 /* Structure describing messages sent by
182    `sendmsg' and received by `recvmsg'.  */
183 struct msghdr
184   {
185     void *msg_name;             /* Address to send to/receive from.  */
186     socklen_t msg_namelen;      /* Length of address data.  */
187
188     struct iovec *msg_iov;      /* Vector of data to send/receive into.  */
189     int msg_iovlen;             /* Number of elements in the vector.  */
190
191     void *msg_control;          /* Ancillary data (eg BSD filedesc passing). */
192     socklen_t msg_controllen;   /* Ancillary data buffer length.  */
193
194     int msg_flags;              /* Flags in received message.  */
195   };
196
197 /* Structure used for storage of ancillary data object information.  */
198 struct cmsghdr
199   {
200     socklen_t cmsg_len;         /* Length of data in cmsg_data plus length
201                                    of cmsghdr structure.  */
202     int cmsg_level;             /* Originating protocol.  */
203     int cmsg_type;              /* Protocol specific type.  */
204 #if (!defined __STRICT_ANSI__ && __GNUC__ >= 2) || __STDC_VERSION__ >= 199901L
205     __extension__ unsigned char __cmsg_data __flexarr; /* Ancillary data.  */
206 #endif
207   };
208
209 /* Ancillary data object manipulation macros.  */
210 #if (!defined __STRICT_ANSI__ && __GNUC__ >= 2) || __STDC_VERSION__ >= 199901L
211 # define CMSG_DATA(cmsg) ((cmsg)->__cmsg_data)
212 #else
213 # define CMSG_DATA(cmsg) ((unsigned char *) ((struct cmsghdr *) (cmsg) + 1))
214 #endif
215
216 #define CMSG_NXTHDR(mhdr, cmsg) __cmsg_nxthdr (mhdr, cmsg)
217
218 #define CMSG_FIRSTHDR(mhdr) \
219   ((size_t) (mhdr)->msg_controllen >= sizeof (struct cmsghdr)                 \
220    ? (struct cmsghdr *) (mhdr)->msg_control : (struct cmsghdr *) NULL)
221
222 #define CMSG_ALIGN(len) (((len) + sizeof (size_t) - 1) \
223                            & (size_t) ~(sizeof (size_t) - 1))
224 #define CMSG_SPACE(len) (CMSG_ALIGN (len) \
225                          + CMSG_ALIGN (sizeof (struct cmsghdr)))
226 #define CMSG_LEN(len)   (CMSG_ALIGN (sizeof (struct cmsghdr)) + (len))
227
228 extern struct cmsghdr *__cmsg_nxthdr (struct msghdr *__mhdr,
229                                       struct cmsghdr *__cmsg) __THROW;
230 #ifdef __USE_EXTERN_INLINES
231 # ifndef _EXTERN_INLINE
232 #  define _EXTERN_INLINE __extern_inline
233 # endif
234 _EXTERN_INLINE struct cmsghdr *
235 __NTH (__cmsg_nxthdr (struct msghdr *__mhdr, struct cmsghdr *__cmsg))
236 {
237   if ((size_t) __cmsg->cmsg_len < sizeof (struct cmsghdr))
238     /* The kernel header does this so there may be a reason.  */
239     return 0;
240
241   __cmsg = (struct cmsghdr *) ((unsigned char *) __cmsg
242                                + CMSG_ALIGN (__cmsg->cmsg_len));
243   if ((unsigned char *) (__cmsg + 1) > ((unsigned char *) __mhdr->msg_control
244                                         + __mhdr->msg_controllen)
245       || ((unsigned char *) __cmsg + CMSG_ALIGN (__cmsg->cmsg_len)
246           > ((unsigned char *) __mhdr->msg_control + __mhdr->msg_controllen)))
247     /* No more entries.  */
248     return 0;
249   return __cmsg;
250 }
251 #endif  /* Use `extern inline'.  */
252
253 /* Socket level message types.  */
254 enum
255   {
256     SCM_RIGHTS = 0x01,          /* Access rights (array of int).  */
257 #define SCM_RIGHTS SCM_RIGHTS
258     SCM_TIMESTAMP = 0x02,       /* Timestamp (struct timeval).  */
259 #define SCM_TIMESTAMP SCM_TIMESTAMP
260     SCM_CREDS = 0x03            /* Process creds (struct cmsgcred).  */
261 #define SCM_CREDS SCM_CREDS
262   };
263
264 /* Unfortunately, BSD practice dictates this structure be of fixed size.
265    If there are more than CMGROUP_MAX groups, the list is truncated.
266    (On GNU systems, the `cmcred_euid' field is just the first in the
267    list of effective UIDs.)  */
268 #define CMGROUP_MAX     16
269
270 /* Structure delivered by SCM_CREDS.  This describes the identity of the
271    sender of the data simultaneously received on the socket.  By BSD
272    convention, this is included only when a sender on a AF_LOCAL socket
273    sends cmsg data of this type and size; the sender's structure is
274    ignored, and the system fills in the various IDs of the sender process.  */
275 struct cmsgcred
276   {
277     __pid_t cmcred_pid;
278     __uid_t cmcred_uid;
279     __uid_t cmcred_euid;
280     __gid_t cmcred_gid;
281     int cmcred_ngroups;
282     __gid_t cmcred_groups[CMGROUP_MAX];
283   };
284
285 /* Protocol number used to manipulate socket-level options
286    with `getsockopt' and `setsockopt'.  */
287 #define SOL_SOCKET      0xffff
288
289 /* Socket-level options for `getsockopt' and `setsockopt'.  */
290 enum
291   {
292     SO_DEBUG = 0x0001,          /* Record debugging information.  */
293 #define SO_DEBUG SO_DEBUG
294     SO_ACCEPTCONN = 0x0002,     /* Accept connections on socket.  */
295 #define SO_ACCEPTCONN SO_ACCEPTCONN
296     SO_REUSEADDR = 0x0004,      /* Allow reuse of local addresses.  */
297 #define SO_REUSEADDR SO_REUSEADDR
298     SO_KEEPALIVE = 0x0008,      /* Keep connections alive and send
299                                    SIGPIPE when they die.  */
300 #define SO_KEEPALIVE SO_KEEPALIVE
301     SO_DONTROUTE = 0x0010,      /* Don't do local routing.  */
302 #define SO_DONTROUTE SO_DONTROUTE
303     SO_BROADCAST = 0x0020,      /* Allow transmission of
304                                    broadcast messages.  */
305 #define SO_BROADCAST SO_BROADCAST
306     SO_USELOOPBACK = 0x0040,    /* Use the software loopback to avoid
307                                    hardware use when possible.  */
308 #define SO_USELOOPBACK SO_USELOOPBACK
309     SO_LINGER = 0x0080,         /* Block on close of a reliable
310                                    socket to transmit pending data.  */
311 #define SO_LINGER SO_LINGER
312     SO_OOBINLINE = 0x0100,      /* Receive out-of-band data in-band.  */
313 #define SO_OOBINLINE SO_OOBINLINE
314     SO_REUSEPORT = 0x0200,      /* Allow local address and port reuse.  */
315 #define SO_REUSEPORT SO_REUSEPORT
316     SO_SNDBUF = 0x1001,         /* Send buffer size.  */
317 #define SO_SNDBUF SO_SNDBUF
318     SO_RCVBUF = 0x1002,         /* Receive buffer.  */
319 #define SO_RCVBUF SO_RCVBUF
320     SO_SNDLOWAT = 0x1003,       /* Send low-water mark.  */
321 #define SO_SNDLOWAT SO_SNDLOWAT
322     SO_RCVLOWAT = 0x1004,       /* Receive low-water mark.  */
323 #define SO_RCVLOWAT SO_RCVLOWAT
324     SO_SNDTIMEO = 0x1005,       /* Send timeout.  */
325 #define SO_SNDTIMEO SO_SNDTIMEO
326     SO_RCVTIMEO = 0x1006,       /* Receive timeout.  */
327 #define SO_RCVTIMEO SO_RCVTIMEO
328     SO_ERROR = 0x1007,          /* Get and clear error status.  */
329 #define SO_ERROR SO_ERROR
330     SO_STYLE = 0x1008,          /* Get socket connection style.  */
331 #define SO_STYLE SO_STYLE
332     SO_TYPE = SO_STYLE          /* Compatible name for SO_STYLE.  */
333 #define SO_TYPE SO_TYPE
334   };
335
336 /* Structure used to manipulate the SO_LINGER option.  */
337 struct linger
338   {
339     int l_onoff;                /* Nonzero to linger on close.  */
340     int l_linger;               /* Time to linger.  */
341   };
342
343 #endif  /* bits/socket.h */