1 /* System-specific socket constants and types. Hurd version.
2 Copyright (C) 1991-2017 Free Software Foundation, Inc.
4 This file is part of the GNU C Library.
6 The GNU C Library is free software; you can redistribute it and/or
7 modify it under the terms of the GNU Lesser General Public License as
8 published by the Free Software Foundation; either version 2.1 of the
9 License, or (at your option) any later version.
11 The GNU C Library is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Lesser General Public License for more details.
16 You should have received a copy of the GNU Lesser General Public
17 License along with the GNU C Library; see the file COPYING.LIB. If
18 not, see <http://www.gnu.org/licenses/>. */
20 #ifndef __BITS_SOCKET_H
21 #define __BITS_SOCKET_H 1
24 # error "Never include <bits/socket.h> directly; use <sys/socket.h> instead."
31 #include <limits.h> /* XXX Is this allowed? */
32 #include <bits/types.h>
34 /* Type for length arguments in socket calls. */
35 #ifndef __socklen_t_defined
36 typedef __socklen_t socklen_t
;
37 # define __socklen_t_defined
41 /* Types of sockets. */
44 SOCK_STREAM
= 1, /* Sequenced, reliable, connection-based
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
58 #define SOCK_MAX (SOCK_SEQPACKET + 1)
59 /* Mask which covers at least up to SOCK_MASK-1. The
60 remaining bits are used as flags. */
61 #define SOCK_TYPE_MASK 0xf
63 /* Flags to be ORed into the type parameter of socket and socketpair and
64 used for the flags parameter of accept4. */
66 SOCK_CLOEXEC
= 0x00400000, /* Atomically set close-on-exec flag for the
68 #define SOCK_CLOEXEC SOCK_CLOEXEC
70 /* Changed from the O_NONBLOCK value (0x8, which is unusable for us as it is
71 conflicting with the original SOCK_* flags' values) to the Linux value
72 (04000). TODO: is there a ``better'' value? */
73 SOCK_NONBLOCK
= 0x0800 /* Atomically mark descriptor(s) as
75 #define SOCK_NONBLOCK SOCK_NONBLOCK
78 /* Protocol families. */
79 #define PF_UNSPEC 0 /* Unspecified. */
80 #define PF_LOCAL 1 /* Local to host (pipes and file-domain). */
81 #define PF_UNIX PF_LOCAL /* Old BSD name for PF_LOCAL. */
82 #define PF_FILE PF_LOCAL /* POSIX name for PF_LOCAL. */
83 #define PF_INET 2 /* IP protocol family. */
84 #define PF_IMPLINK 3 /* ARPAnet IMP protocol. */
85 #define PF_PUP 4 /* PUP protocols. */
86 #define PF_CHAOS 5 /* MIT Chaos protocols. */
87 #define PF_NS 6 /* Xerox NS protocols. */
88 #define PF_ISO 7 /* ISO protocols. */
90 #define PF_ECMA 8 /* ECMA protocols. */
91 #define PF_DATAKIT 9 /* AT&T Datakit protocols. */
92 #define PF_CCITT 10 /* CCITT protocols (X.25 et al). */
93 #define PF_SNA 11 /* IBM SNA protocol. */
94 #define PF_DECnet 12 /* DECnet protocols. */
95 #define PF_DLI 13 /* Direct data link interface. */
96 #define PF_LAT 14 /* DEC Local Area Transport protocol. */
97 #define PF_HYLINK 15 /* NSC Hyperchannel protocol. */
98 #define PF_APPLETALK 16 /* Don't use this. */
99 #define PF_ROUTE 17 /* Internal Routing Protocol. */
100 #define PF_LINK 18 /* Link layer interface. */
101 #define PF_XTP 19 /* eXpress Transfer Protocol (no AF). */
102 #define PF_COIP 20 /* Connection-oriented IP, aka ST II. */
103 #define PF_CNT 21 /* Computer Network Technology. */
104 #define PF_RTIP 22 /* Help Identify RTIP packets. **/
105 #define PF_IPX 23 /* Novell Internet Protocol. */
106 #define PF_SIP 24 /* Simple Internet Protocol. */
107 #define PF_PIP 25 /* Help Identify PIP packets. */
108 #define PF_INET6 26 /* IP version 6. */
111 /* Address families. */
112 #define AF_UNSPEC PF_UNSPEC
113 #define AF_LOCAL PF_LOCAL
114 #define AF_UNIX PF_UNIX
115 #define AF_FILE PF_FILE
116 #define AF_INET PF_INET
117 #define AF_IMPLINK PF_IMPLINK
118 #define AF_PUP PF_PUP
119 #define AF_CHAOS PF_CHAOS
121 #define AF_ISO PF_ISO
122 #define AF_OSI PF_OSI
123 #define AF_ECMA PF_ECMA
124 #define AF_DATAKIT PF_DATAKIT
125 #define AF_CCITT PF_CCITT
126 #define AF_SNA PF_SNA
127 #define AF_DECnet PF_DECnet
128 #define AF_DLI PF_DLI
129 #define AF_LAT PF_LAT
130 #define AF_HYLINK PF_HYLINK
131 #define AF_APPLETALK PF_APPLETALK
132 #define AF_ROUTE PF_ROUTE
133 #define AF_LINK PF_LINK
134 #define pseudo_AF_XTP PF_XTP
135 #define AF_COIP PF_COIP
136 #define AF_CNT PF_CNT
137 #define pseudo_AF_RTIP PF_RTIP
138 #define AF_IPX PF_IPX
139 #define AF_SIP PF_SIP
140 #define pseudo_AF_PIP PF_PIP
141 #define AF_INET6 PF_INET6
142 #define AF_MAX PF_MAX
144 /* Maximum queue length specifiable by listen. */
145 #define SOMAXCONN 128 /* 5 on the origional 4.4 BSD. */
147 /* Get the definition of the macro to define the common sockaddr members. */
148 #include <bits/sockaddr.h>
150 /* Structure describing a generic socket address. */
153 __SOCKADDR_COMMON (sa_
); /* Common data: address family and length. */
154 char sa_data
[14]; /* Address data. */
158 /* Structure large enough to hold any socket address (with the historical
159 exception of AF_UNIX). */
160 #if ULONG_MAX > 0xffffffff
161 # define __ss_aligntype __uint64_t
163 # define __ss_aligntype __uint32_t
165 #define _SS_PADSIZE \
166 (_SS_SIZE - __SOCKADDR_COMMON_SIZE - sizeof (__ss_aligntype))
168 struct sockaddr_storage
170 __SOCKADDR_COMMON (ss_
); /* Address family, etc. */
171 char __ss_padding
[_SS_PADSIZE
];
172 __ss_aligntype __ss_align
; /* Force desired alignment. */
176 /* Bits in the FLAGS argument to `send', `recv', et al. */
179 MSG_OOB
= 0x01, /* Process out-of-band data. */
180 #define MSG_OOB MSG_OOB
181 MSG_PEEK
= 0x02, /* Peek at incoming messages. */
182 #define MSG_PEEK MSG_PEEK
183 MSG_DONTROUTE
= 0x04, /* Don't use local routing. */
184 #define MSG_DONTROUTE MSG_DONTROUTE
185 MSG_EOR
= 0x08, /* Data completes record. */
186 #define MSG_EOR MSG_EOR
187 MSG_TRUNC
= 0x10, /* Data discarded before delivery. */
188 #define MSG_TRUNC MSG_TRUNC
189 MSG_CTRUNC
= 0x20, /* Control data lost before delivery. */
190 #define MSG_CTRUNC MSG_CTRUNC
191 MSG_WAITALL
= 0x40, /* Wait for full request or error. */
192 #define MSG_WAITALL MSG_WAITALL
193 MSG_DONTWAIT
= 0x80, /* This message should be nonblocking. */
194 #define MSG_DONTWAIT MSG_DONTWAIT
195 MSG_NOSIGNAL
= 0x0400 /* Do not generate SIGPIPE on EPIPE. */
196 #define MSG_NOSIGNAL MSG_NOSIGNAL
200 /* Structure describing messages sent by
201 `sendmsg' and received by `recvmsg'. */
204 void *msg_name
; /* Address to send to/receive from. */
205 socklen_t msg_namelen
; /* Length of address data. */
207 struct iovec
*msg_iov
; /* Vector of data to send/receive into. */
208 int msg_iovlen
; /* Number of elements in the vector. */
210 void *msg_control
; /* Ancillary data (eg BSD filedesc passing). */
211 socklen_t msg_controllen
; /* Ancillary data buffer length. */
213 int msg_flags
; /* Flags in received message. */
216 /* Structure used for storage of ancillary data object information. */
219 socklen_t cmsg_len
; /* Length of data in cmsg_data plus length
220 of cmsghdr structure. */
221 int cmsg_level
; /* Originating protocol. */
222 int cmsg_type
; /* Protocol specific type. */
223 #if __glibc_c99_flexarr_available
224 __extension__
unsigned char __cmsg_data __flexarr
; /* Ancillary data. */
228 /* Ancillary data object manipulation macros. */
229 #if __glibc_c99_flexarr_available
230 # define CMSG_DATA(cmsg) ((cmsg)->__cmsg_data)
232 # define CMSG_DATA(cmsg) ((unsigned char *) ((struct cmsghdr *) (cmsg) + 1))
235 #define CMSG_NXTHDR(mhdr, cmsg) __cmsg_nxthdr (mhdr, cmsg)
237 #define CMSG_FIRSTHDR(mhdr) \
238 ((size_t) (mhdr)->msg_controllen >= sizeof (struct cmsghdr) \
239 ? (struct cmsghdr *) (mhdr)->msg_control : (struct cmsghdr *) NULL)
241 #define CMSG_ALIGN(len) (((len) + sizeof (size_t) - 1) \
242 & (size_t) ~(sizeof (size_t) - 1))
243 #define CMSG_SPACE(len) (CMSG_ALIGN (len) \
244 + CMSG_ALIGN (sizeof (struct cmsghdr)))
245 #define CMSG_LEN(len) (CMSG_ALIGN (sizeof (struct cmsghdr)) + (len))
247 extern struct cmsghdr
*__cmsg_nxthdr (struct msghdr
*__mhdr
,
248 struct cmsghdr
*__cmsg
) __THROW
;
249 #ifdef __USE_EXTERN_INLINES
250 # ifndef _EXTERN_INLINE
251 # define _EXTERN_INLINE __extern_inline
253 _EXTERN_INLINE
struct cmsghdr
*
254 __NTH (__cmsg_nxthdr (struct msghdr
*__mhdr
, struct cmsghdr
*__cmsg
))
256 if ((size_t) __cmsg
->cmsg_len
< sizeof (struct cmsghdr
))
257 /* The kernel header does this so there may be a reason. */
260 __cmsg
= (struct cmsghdr
*) ((unsigned char *) __cmsg
261 + CMSG_ALIGN (__cmsg
->cmsg_len
));
262 if ((unsigned char *) (__cmsg
+ 1) > ((unsigned char *) __mhdr
->msg_control
263 + __mhdr
->msg_controllen
)
264 || ((unsigned char *) __cmsg
+ CMSG_ALIGN (__cmsg
->cmsg_len
)
265 > ((unsigned char *) __mhdr
->msg_control
+ __mhdr
->msg_controllen
)))
266 /* No more entries. */
270 #endif /* Use `extern inline'. */
272 /* Socket level message types. */
275 SCM_RIGHTS
= 0x01, /* Access rights (array of int). */
276 #define SCM_RIGHTS SCM_RIGHTS
277 SCM_TIMESTAMP
= 0x02, /* Timestamp (struct timeval). */
278 #define SCM_TIMESTAMP SCM_TIMESTAMP
279 SCM_CREDS
= 0x03 /* Process creds (struct cmsgcred). */
280 #define SCM_CREDS SCM_CREDS
283 /* Unfortunately, BSD practice dictates this structure be of fixed size.
284 If there are more than CMGROUP_MAX groups, the list is truncated.
285 (On GNU systems, the `cmcred_euid' field is just the first in the
286 list of effective UIDs.) */
287 #define CMGROUP_MAX 16
289 /* Structure delivered by SCM_CREDS. This describes the identity of the
290 sender of the data simultaneously received on the socket. By BSD
291 convention, this is included only when a sender on a AF_LOCAL socket
292 sends cmsg data of this type and size; the sender's structure is
293 ignored, and the system fills in the various IDs of the sender process. */
301 __gid_t cmcred_groups
[CMGROUP_MAX
];
304 /* Protocol number used to manipulate socket-level options
305 with `getsockopt' and `setsockopt'. */
306 #define SOL_SOCKET 0xffff
308 /* Socket-level options for `getsockopt' and `setsockopt'. */
311 SO_DEBUG
= 0x0001, /* Record debugging information. */
312 #define SO_DEBUG SO_DEBUG
313 SO_ACCEPTCONN
= 0x0002, /* Accept connections on socket. */
314 #define SO_ACCEPTCONN SO_ACCEPTCONN
315 SO_REUSEADDR
= 0x0004, /* Allow reuse of local addresses. */
316 #define SO_REUSEADDR SO_REUSEADDR
317 SO_KEEPALIVE
= 0x0008, /* Keep connections alive and send
318 SIGPIPE when they die. */
319 #define SO_KEEPALIVE SO_KEEPALIVE
320 SO_DONTROUTE
= 0x0010, /* Don't do local routing. */
321 #define SO_DONTROUTE SO_DONTROUTE
322 SO_BROADCAST
= 0x0020, /* Allow transmission of
323 broadcast messages. */
324 #define SO_BROADCAST SO_BROADCAST
325 SO_USELOOPBACK
= 0x0040, /* Use the software loopback to avoid
326 hardware use when possible. */
327 #define SO_USELOOPBACK SO_USELOOPBACK
328 SO_LINGER
= 0x0080, /* Block on close of a reliable
329 socket to transmit pending data. */
330 #define SO_LINGER SO_LINGER
331 SO_OOBINLINE
= 0x0100, /* Receive out-of-band data in-band. */
332 #define SO_OOBINLINE SO_OOBINLINE
333 SO_REUSEPORT
= 0x0200, /* Allow local address and port reuse. */
334 #define SO_REUSEPORT SO_REUSEPORT
335 SO_SNDBUF
= 0x1001, /* Send buffer size. */
336 #define SO_SNDBUF SO_SNDBUF
337 SO_RCVBUF
= 0x1002, /* Receive buffer. */
338 #define SO_RCVBUF SO_RCVBUF
339 SO_SNDLOWAT
= 0x1003, /* Send low-water mark. */
340 #define SO_SNDLOWAT SO_SNDLOWAT
341 SO_RCVLOWAT
= 0x1004, /* Receive low-water mark. */
342 #define SO_RCVLOWAT SO_RCVLOWAT
343 SO_SNDTIMEO
= 0x1005, /* Send timeout. */
344 #define SO_SNDTIMEO SO_SNDTIMEO
345 SO_RCVTIMEO
= 0x1006, /* Receive timeout. */
346 #define SO_RCVTIMEO SO_RCVTIMEO
347 SO_ERROR
= 0x1007, /* Get and clear error status. */
348 #define SO_ERROR SO_ERROR
349 SO_STYLE
= 0x1008, /* Get socket connection style. */
350 #define SO_STYLE SO_STYLE
351 SO_TYPE
= SO_STYLE
/* Compatible name for SO_STYLE. */
352 #define SO_TYPE SO_TYPE
355 /* Structure used to manipulate the SO_LINGER option. */
358 int l_onoff
; /* Nonzero to linger on close. */
359 int l_linger
; /* Time to linger. */
362 #endif /* bits/socket.h */