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