1 /* System-specific socket constants and types. Linux version.
2 Copyright (C) 1991-2013 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
7 License as published by the Free Software Foundation; either
8 version 2.1 of the 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; if not, see
17 <http://www.gnu.org/licenses/>. */
18
19 #ifndef __BITS_SOCKET_H
20 #define __BITS_SOCKET_H
21
22 #ifndef _SYS_SOCKET_H
23 # error "Never include <bits/socket.h> directly; use <sys/socket.h> instead."
24 #endif
25
26 #define __need_size_t
27 #include <stddef.h>
28
29 #include <sys/types.h>
30
31 /* Type for length arguments in socket calls. */
32 #ifndef __socklen_t_defined
33 typedef __socklen_t socklen_t;
34 # define __socklen_t_defined
35 #endif
36
37 /* Get the architecture-dependent definition of enum __socket_type. */
38 #include <bits/socket_type.h>
39
40 /* Protocol families. */
41 #define PF_UNSPEC 0 /* Unspecified. */
42 #define PF_LOCAL 1 /* Local to host (pipes and file-domain). */
43 #define PF_UNIX PF_LOCAL /* POSIX name for PF_LOCAL. */
44 #define PF_FILE PF_LOCAL /* Another non-standard name for PF_LOCAL. */
45 #define PF_INET 2 /* IP protocol family. */
46 #define PF_AX25 3 /* Amateur Radio AX.25. */
47 #define PF_IPX 4 /* Novell Internet Protocol. */
48 #define PF_APPLETALK 5 /* Appletalk DDP. */
49 #define PF_NETROM 6 /* Amateur radio NetROM. */
50 #define PF_BRIDGE 7 /* Multiprotocol bridge. */
51 #define PF_ATMPVC 8 /* ATM PVCs. */
52 #define PF_X25 9 /* Reserved for X.25 project. */
53 #define PF_INET6 10 /* IP version 6. */
54 #define PF_ROSE 11 /* Amateur Radio X.25 PLP. */
55 #define PF_DECnet 12 /* Reserved for DECnet project. */
56 #define PF_NETBEUI 13 /* Reserved for 802.2LLC project. */
57 #define PF_SECURITY 14 /* Security callback pseudo AF. */
58 #define PF_KEY 15 /* PF_KEY key management API. */
59 #define PF_NETLINK 16
60 #define PF_ROUTE PF_NETLINK /* Alias to emulate 4.4BSD. */
61 #define PF_PACKET 17 /* Packet family. */
62 #define PF_ASH 18 /* Ash. */
63 #define PF_ECONET 19 /* Acorn Econet. */
64 #define PF_ATMSVC 20 /* ATM SVCs. */
65 #define PF_RDS 21 /* RDS sockets. */
66 #define PF_SNA 22 /* Linux SNA Project */
67 #define PF_IRDA 23 /* IRDA sockets. */
68 #define PF_PPPOX 24 /* PPPoX sockets. */
69 #define PF_WANPIPE 25 /* Wanpipe API sockets. */
70 #define PF_LLC 26 /* Linux LLC. */
71 #define PF_CAN 29 /* Controller Area Network. */
72 #define PF_TIPC 30 /* TIPC sockets. */
73 #define PF_BLUETOOTH 31 /* Bluetooth sockets. */
74 #define PF_IUCV 32 /* IUCV sockets. */
75 #define PF_RXRPC 33 /* RxRPC sockets. */
76 #define PF_ISDN 34 /* mISDN sockets. */
77 #define PF_PHONET 35 /* Phonet sockets. */
78 #define PF_IEEE802154 36 /* IEEE 802.15.4 sockets. */
79 #define PF_CAIF 37 /* CAIF sockets. */
80 #define PF_ALG 38 /* Algorithm sockets. */
81 #define PF_NFC 39 /* NFC sockets. */
82 #define PF_VSOCK 40 /* vSockets. */
83 #define PF_KCM 41 /* Kernel Connection Multiplexor. */
84 #define PF_QIPCRTR 42 /* Qualcomm IPC Router. */
85 #define PF_SMC 43 /* SMC sockets. */
86 #define PF_XDP 44 /* XDP sockets. */
87 #define PF_MCTP 45 /* Management component transport protocol. */
88 #define PF_MAX 46 /* For now.. */
89
90 /* Address families. */
91 #define AF_UNSPEC PF_UNSPEC
92 #define AF_LOCAL PF_LOCAL
93 #define AF_UNIX PF_UNIX
94 #define AF_FILE PF_FILE
95 #define AF_INET PF_INET
96 #define AF_AX25 PF_AX25
97 #define AF_IPX PF_IPX
98 #define AF_APPLETALK PF_APPLETALK
99 #define AF_NETROM PF_NETROM
100 #define AF_BRIDGE PF_BRIDGE
101 #define AF_ATMPVC PF_ATMPVC
102 #define AF_X25 PF_X25
103 #define AF_INET6 PF_INET6
104 #define AF_ROSE PF_ROSE
105 #define AF_DECnet PF_DECnet
106 #define AF_NETBEUI PF_NETBEUI
107 #define AF_SECURITY PF_SECURITY
108 #define AF_KEY PF_KEY
109 #define AF_NETLINK PF_NETLINK
110 #define AF_ROUTE PF_ROUTE
111 #define AF_PACKET PF_PACKET
112 #define AF_ASH PF_ASH
113 #define AF_ECONET PF_ECONET
114 #define AF_ATMSVC PF_ATMSVC
115 #define AF_RDS PF_RDS
116 #define AF_SNA PF_SNA
117 #define AF_IRDA PF_IRDA
118 #define AF_PPPOX PF_PPPOX
119 #define AF_WANPIPE PF_WANPIPE
120 #define AF_LLC PF_LLC
121 #define AF_CAN PF_CAN
122 #define AF_TIPC PF_TIPC
123 #define AF_BLUETOOTH PF_BLUETOOTH
124 #define AF_IUCV PF_IUCV
125 #define AF_RXRPC PF_RXRPC
126 #define AF_ISDN PF_ISDN
127 #define AF_PHONET PF_PHONET
128 #define AF_IEEE802154 PF_IEEE802154
129 #define AF_CAIF PF_CAIF
130 #define AF_ALG PF_ALG
131 #define AF_NFC PF_NFC
132 #define AF_VSOCK PF_VSOCK
133 #define AF_KCM PF_KCM
134 #define AF_QIPCRTR PF_QIPCRTR
135 #define AF_SMC PF_SMC
136 #define AF_XDP PF_XDP
137 #define AF_MCTP PF_MCTP
138 #define AF_MAX PF_MAX
139
140 /* Socket level values. Others are defined in the appropriate headers.
141
142 XXX These definitions also should go into the appropriate headers as
143 far as they are available. */
144 #define SOL_RAW 255
145 #define SOL_DECNET 261
146 #define SOL_X25 262
147 #define SOL_PACKET 263
148 #define SOL_ATM 264 /* ATM layer (cell level). */
149 #define SOL_AAL 265 /* ATM Adaption Layer (packet level). */
150 #define SOL_IRDA 266
151
152 /* Maximum queue length specifiable by listen. */
153 #define SOMAXCONN 128
154
155 /* Get the definition of the macro to define the common sockaddr members. */
156 #include <bits/sockaddr.h>
157
158 /* Structure describing a generic socket address. */
159 struct sockaddr
160 {
161 __SOCKADDR_COMMON (sa_); /* Common data: address family and length. */
162 char sa_data[14]; /* Address data. */
163 };
164
165
166 /* Structure large enough to hold any socket address (with the historical
167 exception of AF_UNIX). We reserve 128 bytes. */
168 #define __ss_aligntype unsigned long int
169 #define _SS_SIZE 128
170 #define _SS_PADSIZE (_SS_SIZE - (2 * sizeof (__ss_aligntype)))
171
172 struct sockaddr_storage
173 {
174 __SOCKADDR_COMMON (ss_); /* Address family, etc. */
175 __ss_aligntype __ss_align; /* Force desired alignment. */
176 char __ss_padding[_SS_PADSIZE];
177 };
178
179
180 /* Bits in the FLAGS argument to `send', `recv', et al. */
181 enum
182 {
183 MSG_OOB = 0x01, /* Process out-of-band data. */
184 #define MSG_OOB MSG_OOB
185 MSG_PEEK = 0x02, /* Peek at incoming messages. */
186 #define MSG_PEEK MSG_PEEK
187 MSG_DONTROUTE = 0x04, /* Don't use local routing. */
188 #define MSG_DONTROUTE MSG_DONTROUTE
189 #ifdef __USE_GNU
190 /* DECnet uses a different name. */
191 MSG_TRYHARD = MSG_DONTROUTE,
192 # define MSG_TRYHARD MSG_DONTROUTE
193 #endif
194 MSG_CTRUNC = 0x08, /* Control data lost before delivery. */
195 #define MSG_CTRUNC MSG_CTRUNC
196 MSG_PROXY = 0x10, /* Supply or ask second address. */
197 #define MSG_PROXY MSG_PROXY
198 MSG_TRUNC = 0x20,
199 #define MSG_TRUNC MSG_TRUNC
200 MSG_DONTWAIT = 0x40, /* Nonblocking IO. */
201 #define MSG_DONTWAIT MSG_DONTWAIT
202 MSG_EOR = 0x80, /* End of record. */
203 #define MSG_EOR MSG_EOR
204 MSG_WAITALL = 0x100, /* Wait for a full request. */
205 #define MSG_WAITALL MSG_WAITALL
206 MSG_FIN = 0x200,
207 #define MSG_FIN MSG_FIN
208 MSG_SYN = 0x400,
209 #define MSG_SYN MSG_SYN
210 MSG_CONFIRM = 0x800, /* Confirm path validity. */
211 #define MSG_CONFIRM MSG_CONFIRM
212 MSG_RST = 0x1000,
213 #define MSG_RST MSG_RST
214 MSG_ERRQUEUE = 0x2000, /* Fetch message from error queue. */
215 #define MSG_ERRQUEUE MSG_ERRQUEUE
216 MSG_NOSIGNAL = 0x4000, /* Do not generate SIGPIPE. */
217 #define MSG_NOSIGNAL MSG_NOSIGNAL
218 MSG_MORE = 0x8000, /* Sender will send more. */
219 #define MSG_MORE MSG_MORE
220 MSG_WAITFORONE = 0x10000, /* Wait for at least one packet to return.*/
221 #define MSG_WAITFORONE MSG_WAITFORONE
222 MSG_FASTOPEN = 0x20000000, /* Send data in TCP SYN. */
223 #define MSG_FASTOPEN MSG_FASTOPEN
224
225 MSG_CMSG_CLOEXEC = 0x40000000 /* Set close_on_exit for file
226 descriptor received through
227 SCM_RIGHTS. */
228 #define MSG_CMSG_CLOEXEC MSG_CMSG_CLOEXEC
229 };
230
231
232 /* Structure describing messages sent by
233 `sendmsg' and received by `recvmsg'. */
234 struct msghdr
235 {
236 void *msg_name; /* Address to send to/receive from. */
237 socklen_t msg_namelen; /* Length of address data. */
238
239 struct iovec *msg_iov; /* Vector of data to send/receive into. */
240 size_t msg_iovlen; /* Number of elements in the vector. */
241
242 void *msg_control; /* Ancillary data (eg BSD filedesc passing). */
243 size_t msg_controllen; /* Ancillary data buffer length.
244 !! The type should be socklen_t but the
245 definition of the kernel is incompatible
246 with this. */
247
248 int msg_flags; /* Flags on received message. */
249 };
250
251 /* Structure used for storage of ancillary data object information. */
252 struct cmsghdr
253 {
254 size_t cmsg_len; /* Length of data in cmsg_data plus length
255 of cmsghdr structure.
256 !! The type should be socklen_t but the
257 definition of the kernel is incompatible
258 with this. */
259 int cmsg_level; /* Originating protocol. */
260 int cmsg_type; /* Protocol specific type. */
261 #if (!defined __STRICT_ANSI__ && __GNUC__ >= 2) || __STDC_VERSION__ >= 199901L
262 __extension__ unsigned char __cmsg_data __flexarr; /* Ancillary data. */
263 #endif
264 };
265
266 /* Ancillary data object manipulation macros. */
267 #if (!defined __STRICT_ANSI__ && __GNUC__ >= 2) || __STDC_VERSION__ >= 199901L
268 # define CMSG_DATA(cmsg) ((cmsg)->__cmsg_data)
269 #else
270 # define CMSG_DATA(cmsg) ((unsigned char *) ((struct cmsghdr *) (cmsg) + 1))
271 #endif
272 #define CMSG_NXTHDR(mhdr, cmsg) __cmsg_nxthdr (mhdr, cmsg)
273 #define CMSG_FIRSTHDR(mhdr) \
274 ((size_t) (mhdr)->msg_controllen >= sizeof (struct cmsghdr) \
275 ? (struct cmsghdr *) (mhdr)->msg_control : (struct cmsghdr *) 0)
276 #define CMSG_ALIGN(len) (((len) + sizeof (size_t) - 1) \
277 & (size_t) ~(sizeof (size_t) - 1))
278 #define CMSG_SPACE(len) (CMSG_ALIGN (len) \
279 + CMSG_ALIGN (sizeof (struct cmsghdr)))
280 #define CMSG_LEN(len) (CMSG_ALIGN (sizeof (struct cmsghdr)) + (len))
281
282 extern struct cmsghdr *__cmsg_nxthdr (struct msghdr *__mhdr,
283 struct cmsghdr *__cmsg) __THROW;
284 #ifdef __USE_EXTERN_INLINES
285 # ifndef _EXTERN_INLINE
286 # define _EXTERN_INLINE __extern_inline
287 # endif
288 _EXTERN_INLINE struct cmsghdr *
__NTH(__cmsg_nxthdr (struct msghdr * __mhdr,struct cmsghdr * __cmsg))289 __NTH (__cmsg_nxthdr (struct msghdr *__mhdr, struct cmsghdr *__cmsg))
290 {
291 if ((size_t) __cmsg->cmsg_len < sizeof (struct cmsghdr))
292 /* The kernel header does this so there may be a reason. */
293 return (struct cmsghdr *) 0;
294
295 __cmsg = (struct cmsghdr *) ((unsigned char *) __cmsg
296 + CMSG_ALIGN (__cmsg->cmsg_len));
297 if ((unsigned char *) (__cmsg + 1) > ((unsigned char *) __mhdr->msg_control
298 + __mhdr->msg_controllen)
299 || ((unsigned char *) __cmsg + CMSG_ALIGN (__cmsg->cmsg_len)
300 > ((unsigned char *) __mhdr->msg_control + __mhdr->msg_controllen)))
301 /* No more entries. */
302 return (struct cmsghdr *) 0;
303 return __cmsg;
304 }
305 #endif /* Use `extern inline'. */
306
307 /* Socket level message types. This must match the definitions in
308 <linux/socket.h>. */
309 enum
310 {
311 SCM_RIGHTS = 0x01 /* Transfer file descriptors. */
312 #define SCM_RIGHTS SCM_RIGHTS
313 #ifdef __USE_GNU
314 , SCM_CREDENTIALS = 0x02 /* Credentials passing. */
315 # define SCM_CREDENTIALS SCM_CREDENTIALS
316 #endif
317 };
318
319 #ifdef __USE_GNU
320 /* User visible structure for SCM_CREDENTIALS message */
321 struct ucred
322 {
323 pid_t pid; /* PID of sending process. */
324 uid_t uid; /* UID of sending process. */
325 gid_t gid; /* GID of sending process. */
326 };
327 #endif
328
329 /* Ugly workaround for unclean kernel headers. */
330 #if !defined __USE_MISC && !defined __USE_GNU
331 # ifndef FIOGETOWN
332 # define __SYS_SOCKET_H_undef_FIOGETOWN
333 # endif
334 # ifndef FIOSETOWN
335 # define __SYS_SOCKET_H_undef_FIOSETOWN
336 # endif
337 # ifndef SIOCATMARK
338 # define __SYS_SOCKET_H_undef_SIOCATMARK
339 # endif
340 # ifndef SIOCGPGRP
341 # define __SYS_SOCKET_H_undef_SIOCGPGRP
342 # endif
343 # ifndef SIOCGSTAMP
344 # define __SYS_SOCKET_H_undef_SIOCGSTAMP
345 # endif
346 # ifndef SIOCGSTAMPNS
347 # define __SYS_SOCKET_H_undef_SIOCGSTAMPNS
348 # endif
349 # ifndef SIOCSPGRP
350 # define __SYS_SOCKET_H_undef_SIOCSPGRP
351 # endif
352 #endif
353
354 /* Get socket manipulation related informations from kernel headers. */
355 #include <asm/socket.h>
356
357 #if !defined __USE_MISC && !defined __USE_GNU
358 # ifdef __SYS_SOCKET_H_undef_FIOGETOWN
359 # undef __SYS_SOCKET_H_undef_FIOGETOWN
360 # undef FIOGETOWN
361 # endif
362 # ifdef __SYS_SOCKET_H_undef_FIOSETOWN
363 # undef __SYS_SOCKET_H_undef_FIOSETOWN
364 # undef FIOSETOWN
365 # endif
366 # ifdef __SYS_SOCKET_H_undef_SIOCATMARK
367 # undef __SYS_SOCKET_H_undef_SIOCATMARK
368 # undef SIOCATMARK
369 # endif
370 # ifdef __SYS_SOCKET_H_undef_SIOCGPGRP
371 # undef __SYS_SOCKET_H_undef_SIOCGPGRP
372 # undef SIOCGPGRP
373 # endif
374 # ifdef __SYS_SOCKET_H_undef_SIOCGSTAMP
375 # undef __SYS_SOCKET_H_undef_SIOCGSTAMP
376 # undef SIOCGSTAMP
377 # endif
378 # ifdef __SYS_SOCKET_H_undef_SIOCGSTAMPNS
379 # undef __SYS_SOCKET_H_undef_SIOCGSTAMPNS
380 # undef SIOCGSTAMPNS
381 # endif
382 # ifdef __SYS_SOCKET_H_undef_SIOCSPGRP
383 # undef __SYS_SOCKET_H_undef_SIOCSPGRP
384 # undef SIOCSPGRP
385 # endif
386 #endif
387
388 /* Structure used to manipulate the SO_LINGER option. */
389 struct linger
390 {
391 int l_onoff; /* Nonzero to linger on close. */
392 int l_linger; /* Time to linger. */
393 };
394
395 #endif /* bits/socket.h */
396