cpp-d1064d
[cross.git] / i686-linux-gnu-4.7 / usr / include / x86_64-linux-gnu / bits / socket.h
1 /* System-specific socket constants and types.  Linux version.
2    Copyright (C) 1991-2018 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_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_KCM          41      /* Kernel Connection Multiplexor.  */
86 #define PF_QIPCRTR      42      /* Qualcomm IPC Router.  */
87 #define PF_SMC          43      /* SMC sockets.  */
88 #define PF_MAX          44      /* 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_IB           PF_IB
122 #define AF_MPLS         PF_MPLS
123 #define AF_CAN          PF_CAN
124 #define AF_TIPC         PF_TIPC
125 #define AF_BLUETOOTH    PF_BLUETOOTH
126 #define AF_IUCV         PF_IUCV
127 #define AF_RXRPC        PF_RXRPC
128 #define AF_ISDN         PF_ISDN
129 #define AF_PHONET       PF_PHONET
130 #define AF_IEEE802154   PF_IEEE802154
131 #define AF_CAIF         PF_CAIF
132 #define AF_ALG          PF_ALG
133 #define AF_NFC          PF_NFC
134 #define AF_VSOCK        PF_VSOCK
135 #define AF_KCM          PF_KCM
136 #define AF_QIPCRTR      PF_QIPCRTR
137 #define AF_SMC          PF_SMC
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 #define SOL_NETBEUI     267
152 #define SOL_LLC         268
153 #define SOL_DCCP        269
154 #define SOL_NETLINK     270
155 #define SOL_TIPC        271
156 #define SOL_RXRPC       272
157 #define SOL_PPPOL2TP    273
158 #define SOL_BLUETOOTH   274
159 #define SOL_PNPIPE      275
160 #define SOL_RDS         276
161 #define SOL_IUCV        277
162 #define SOL_CAIF        278
163 #define SOL_ALG         279
164 #define SOL_NFC         280
165 #define SOL_KCM         281
166 #define SOL_TLS         282
167
168 /* Maximum queue length specifiable by listen.  */
169 #define SOMAXCONN       128
170
171 /* Get the definition of the macro to define the common sockaddr members.  */
172 #include <bits/sockaddr.h>
173
174 /* Structure describing a generic socket address.  */
175 struct sockaddr
176   {
177     __SOCKADDR_COMMON (sa_);    /* Common data: address family and length.  */
178     char sa_data[14];           /* Address data.  */
179   };
180
181
182 /* Structure large enough to hold any socket address (with the historical
183    exception of AF_UNIX).  */
184 #define __ss_aligntype  unsigned long int
185 #define _SS_PADSIZE \
186   (_SS_SIZE - __SOCKADDR_COMMON_SIZE - sizeof (__ss_aligntype))
187
188 struct sockaddr_storage
189   {
190     __SOCKADDR_COMMON (ss_);    /* Address family, etc.  */
191     char __ss_padding[_SS_PADSIZE];
192     __ss_aligntype __ss_align;  /* Force desired alignment.  */
193   };
194
195
196 /* Bits in the FLAGS argument to `send', `recv', et al.  */
197 enum
198   {
199     MSG_OOB             = 0x01, /* Process out-of-band data.  */
200 #define MSG_OOB         MSG_OOB
201     MSG_PEEK            = 0x02, /* Peek at incoming messages.  */
202 #define MSG_PEEK        MSG_PEEK
203     MSG_DONTROUTE       = 0x04, /* Don't use local routing.  */
204 #define MSG_DONTROUTE   MSG_DONTROUTE
205 #ifdef __USE_GNU
206     /* DECnet uses a different name.  */
207     MSG_TRYHARD         = MSG_DONTROUTE,
208 # define MSG_TRYHARD    MSG_DONTROUTE
209 #endif
210     MSG_CTRUNC          = 0x08, /* Control data lost before delivery.  */
211 #define MSG_CTRUNC      MSG_CTRUNC
212     MSG_PROXY           = 0x10, /* Supply or ask second address.  */
213 #define MSG_PROXY       MSG_PROXY
214     MSG_TRUNC           = 0x20,
215 #define MSG_TRUNC       MSG_TRUNC
216     MSG_DONTWAIT        = 0x40, /* Nonblocking IO.  */
217 #define MSG_DONTWAIT    MSG_DONTWAIT
218     MSG_EOR             = 0x80, /* End of record.  */
219 #define MSG_EOR         MSG_EOR
220     MSG_WAITALL         = 0x100, /* Wait for a full request.  */
221 #define MSG_WAITALL     MSG_WAITALL
222     MSG_FIN             = 0x200,
223 #define MSG_FIN         MSG_FIN
224     MSG_SYN             = 0x400,
225 #define MSG_SYN         MSG_SYN
226     MSG_CONFIRM         = 0x800, /* Confirm path validity.  */
227 #define MSG_CONFIRM     MSG_CONFIRM
228     MSG_RST             = 0x1000,
229 #define MSG_RST         MSG_RST
230     MSG_ERRQUEUE        = 0x2000, /* Fetch message from error queue.  */
231 #define MSG_ERRQUEUE    MSG_ERRQUEUE
232     MSG_NOSIGNAL        = 0x4000, /* Do not generate SIGPIPE.  */
233 #define MSG_NOSIGNAL    MSG_NOSIGNAL
234     MSG_MORE            = 0x8000,  /* Sender will send more.  */
235 #define MSG_MORE        MSG_MORE
236     MSG_WAITFORONE      = 0x10000, /* Wait for at least one packet to return.*/
237 #define MSG_WAITFORONE  MSG_WAITFORONE
238     MSG_BATCH           = 0x40000, /* sendmmsg: more messages coming.  */
239 #define MSG_BATCH       MSG_BATCH
240     MSG_ZEROCOPY        = 0x4000000, /* Use user data in kernel path.  */
241 #define MSG_ZEROCOPY    MSG_ZEROCOPY
242     MSG_FASTOPEN        = 0x20000000, /* Send data in TCP SYN.  */
243 #define MSG_FASTOPEN    MSG_FASTOPEN
244
245     MSG_CMSG_CLOEXEC    = 0x40000000    /* Set close_on_exit for file
246                                            descriptor received through
247                                            SCM_RIGHTS.  */
248 #define MSG_CMSG_CLOEXEC MSG_CMSG_CLOEXEC
249   };
250
251
252 /* Structure describing messages sent by
253    `sendmsg' and received by `recvmsg'.  */
254 struct msghdr
255   {
256     void *msg_name;             /* Address to send to/receive from.  */
257     socklen_t msg_namelen;      /* Length of address data.  */
258
259     struct iovec *msg_iov;      /* Vector of data to send/receive into.  */
260     size_t msg_iovlen;          /* Number of elements in the vector.  */
261
262     void *msg_control;          /* Ancillary data (eg BSD filedesc passing). */
263     size_t msg_controllen;      /* Ancillary data buffer length.
264                                    !! The type should be socklen_t but the
265                                    definition of the kernel is incompatible
266                                    with this.  */
267
268     int msg_flags;              /* Flags on received message.  */
269   };
270
271 /* Structure used for storage of ancillary data object information.  */
272 struct cmsghdr
273   {
274     size_t cmsg_len;            /* Length of data in cmsg_data plus length
275                                    of cmsghdr structure.
276                                    !! The type should be socklen_t but the
277                                    definition of the kernel is incompatible
278                                    with this.  */
279     int cmsg_level;             /* Originating protocol.  */
280     int cmsg_type;              /* Protocol specific type.  */
281 #if __glibc_c99_flexarr_available
282     __extension__ unsigned char __cmsg_data __flexarr; /* Ancillary data.  */
283 #endif
284   };
285
286 /* Ancillary data object manipulation macros.  */
287 #if __glibc_c99_flexarr_available
288 # define CMSG_DATA(cmsg) ((cmsg)->__cmsg_data)
289 #else
290 # define CMSG_DATA(cmsg) ((unsigned char *) ((struct cmsghdr *) (cmsg) + 1))
291 #endif
292 #define CMSG_NXTHDR(mhdr, cmsg) __cmsg_nxthdr (mhdr, cmsg)
293 #define CMSG_FIRSTHDR(mhdr) \
294   ((size_t) (mhdr)->msg_controllen >= sizeof (struct cmsghdr)                 \
295    ? (struct cmsghdr *) (mhdr)->msg_control : (struct cmsghdr *) 0)
296 #define CMSG_ALIGN(len) (((len) + sizeof (size_t) - 1) \
297                          & (size_t) ~(sizeof (size_t) - 1))
298 #define CMSG_SPACE(len) (CMSG_ALIGN (len) \
299                          + CMSG_ALIGN (sizeof (struct cmsghdr)))
300 #define CMSG_LEN(len)   (CMSG_ALIGN (sizeof (struct cmsghdr)) + (len))
301
302 extern struct cmsghdr *__cmsg_nxthdr (struct msghdr *__mhdr,
303                                       struct cmsghdr *__cmsg) __THROW;
304 #ifdef __USE_EXTERN_INLINES
305 # ifndef _EXTERN_INLINE
306 #  define _EXTERN_INLINE __extern_inline
307 # endif
308 _EXTERN_INLINE struct cmsghdr *
309 __NTH (__cmsg_nxthdr (struct msghdr *__mhdr, struct cmsghdr *__cmsg))
310 {
311   if ((size_t) __cmsg->cmsg_len < sizeof (struct cmsghdr))
312     /* The kernel header does this so there may be a reason.  */
313     return (struct cmsghdr *) 0;
314
315   __cmsg = (struct cmsghdr *) ((unsigned char *) __cmsg
316                                + CMSG_ALIGN (__cmsg->cmsg_len));
317   if ((unsigned char *) (__cmsg + 1) > ((unsigned char *) __mhdr->msg_control
318                                         + __mhdr->msg_controllen)
319       || ((unsigned char *) __cmsg + CMSG_ALIGN (__cmsg->cmsg_len)
320           > ((unsigned char *) __mhdr->msg_control + __mhdr->msg_controllen)))
321     /* No more entries.  */
322     return (struct cmsghdr *) 0;
323   return __cmsg;
324 }
325 #endif  /* Use `extern inline'.  */
326
327 /* Socket level message types.  This must match the definitions in
328    <linux/socket.h>.  */
329 enum
330   {
331     SCM_RIGHTS = 0x01           /* Transfer file descriptors.  */
332 #define SCM_RIGHTS SCM_RIGHTS
333 #ifdef __USE_GNU
334     , SCM_CREDENTIALS = 0x02    /* Credentials passing.  */
335 # define SCM_CREDENTIALS SCM_CREDENTIALS
336 #endif
337   };
338
339 #ifdef __USE_GNU
340 /* User visible structure for SCM_CREDENTIALS message */
341 struct ucred
342 {
343   pid_t pid;                    /* PID of sending process.  */
344   uid_t uid;                    /* UID of sending process.  */
345   gid_t gid;                    /* GID of sending process.  */
346 };
347 #endif
348
349 /* Ugly workaround for unclean kernel headers.  */
350 #ifndef __USE_MISC
351 # ifndef FIOGETOWN
352 #  define __SYS_SOCKET_H_undef_FIOGETOWN
353 # endif
354 # ifndef FIOSETOWN
355 #  define __SYS_SOCKET_H_undef_FIOSETOWN
356 # endif
357 # ifndef SIOCATMARK
358 #  define __SYS_SOCKET_H_undef_SIOCATMARK
359 # endif
360 # ifndef SIOCGPGRP
361 #  define __SYS_SOCKET_H_undef_SIOCGPGRP
362 # endif
363 # ifndef SIOCGSTAMP
364 #  define __SYS_SOCKET_H_undef_SIOCGSTAMP
365 # endif
366 # ifndef SIOCGSTAMPNS
367 #  define __SYS_SOCKET_H_undef_SIOCGSTAMPNS
368 # endif
369 # ifndef SIOCSPGRP
370 #  define __SYS_SOCKET_H_undef_SIOCSPGRP
371 # endif
372 #endif
373 #ifndef IOCSIZE_MASK
374 # define __SYS_SOCKET_H_undef_IOCSIZE_MASK
375 #endif
376 #ifndef IOCSIZE_SHIFT
377 # define __SYS_SOCKET_H_undef_IOCSIZE_SHIFT
378 #endif
379 #ifndef IOC_IN
380 # define __SYS_SOCKET_H_undef_IOC_IN
381 #endif
382 #ifndef IOC_INOUT
383 # define __SYS_SOCKET_H_undef_IOC_INOUT
384 #endif
385 #ifndef IOC_OUT
386 # define __SYS_SOCKET_H_undef_IOC_OUT
387 #endif
388
389 /* Get socket manipulation related informations from kernel headers.  */
390 #include <asm/socket.h>
391
392 #ifndef __USE_MISC
393 # ifdef __SYS_SOCKET_H_undef_FIOGETOWN
394 #  undef __SYS_SOCKET_H_undef_FIOGETOWN
395 #  undef FIOGETOWN
396 # endif
397 # ifdef __SYS_SOCKET_H_undef_FIOSETOWN
398 #  undef __SYS_SOCKET_H_undef_FIOSETOWN
399 #  undef FIOSETOWN
400 # endif
401 # ifdef __SYS_SOCKET_H_undef_SIOCATMARK
402 #  undef __SYS_SOCKET_H_undef_SIOCATMARK
403 #  undef SIOCATMARK
404 # endif
405 # ifdef __SYS_SOCKET_H_undef_SIOCGPGRP
406 #  undef __SYS_SOCKET_H_undef_SIOCGPGRP
407 #  undef SIOCGPGRP
408 # endif
409 # ifdef __SYS_SOCKET_H_undef_SIOCGSTAMP
410 #  undef __SYS_SOCKET_H_undef_SIOCGSTAMP
411 #  undef SIOCGSTAMP
412 # endif
413 # ifdef __SYS_SOCKET_H_undef_SIOCGSTAMPNS
414 #  undef __SYS_SOCKET_H_undef_SIOCGSTAMPNS
415 #  undef SIOCGSTAMPNS
416 # endif
417 # ifdef __SYS_SOCKET_H_undef_SIOCSPGRP
418 #  undef __SYS_SOCKET_H_undef_SIOCSPGRP
419 #  undef SIOCSPGRP
420 # endif
421 #endif
422 #ifdef __SYS_SOCKET_H_undef_IOCSIZE_MASK
423 # undef __SYS_SOCKET_H_undef_IOCSIZE_MASK
424 # undef IOCSIZE_MASK
425 #endif
426 #ifdef __SYS_SOCKET_H_undef_IOCSIZE_SHIFT
427 # undef __SYS_SOCKET_H_undef_IOCSIZE_SHIFT
428 # undef IOCSIZE_SHIFT
429 #endif
430 #ifdef __SYS_SOCKET_H_undef_IOC_IN
431 # undef __SYS_SOCKET_H_undef_IOC_IN
432 # undef IOC_IN
433 #endif
434 #ifdef __SYS_SOCKET_H_undef_IOC_INOUT
435 # undef __SYS_SOCKET_H_undef_IOC_INOUT
436 # undef IOC_INOUT
437 #endif
438 #ifdef __SYS_SOCKET_H_undef_IOC_OUT
439 # undef __SYS_SOCKET_H_undef_IOC_OUT
440 # undef IOC_OUT
441 #endif
442
443 /* Structure used to manipulate the SO_LINGER option.  */
444 struct linger
445   {
446     int l_onoff;                /* Nonzero to linger on close.  */
447     int l_linger;               /* Time to linger.  */
448   };
449
450 #endif  /* bits/socket.h */