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