1 /* System-specific socket constants and types. Linux version.
2 Copyright (C) 1991-2012 Free Software Foundation, Inc.
3 This file is part of the GNU C Library.
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.
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.
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/>. */
19 #ifndef __BITS_SOCKET_H
20 #define __BITS_SOCKET_H
23 # error "Never include <bits/socket.h> directly; use <sys/socket.h> instead."
29 #include <sys/types.h>
31 /* Type for length arguments in socket calls. */
32 #ifndef __socklen_t_defined
33 typedef __socklen_t socklen_t
;
34 # define __socklen_t_defined
37 /* Types of sockets. */
40 SOCK_STREAM
= 1, /* Sequenced, reliable, connection-based
42 #define SOCK_STREAM SOCK_STREAM
43 SOCK_DGRAM
= 2, /* Connectionless, unreliable datagrams
44 of fixed maximum length. */
45 #define SOCK_DGRAM SOCK_DGRAM
46 SOCK_RAW
= 3, /* Raw protocol interface. */
47 #define SOCK_RAW SOCK_RAW
48 SOCK_RDM
= 4, /* Reliably-delivered messages. */
49 #define SOCK_RDM SOCK_RDM
50 SOCK_SEQPACKET
= 5, /* Sequenced, reliable, connection-based,
51 datagrams of fixed maximum length. */
52 #define SOCK_SEQPACKET SOCK_SEQPACKET
53 SOCK_DCCP
= 6, /* Datagram Congestion Control Protocol. */
54 #define SOCK_DCCP SOCK_DCCP
55 SOCK_PACKET
= 10, /* Linux specific way of getting packets
56 at the dev level. For writing rarp and
57 other similar things on the user level. */
58 #define SOCK_PACKET SOCK_PACKET
60 /* Flags to be ORed into the type parameter of socket and socketpair and
61 used for the flags parameter of paccept. */
63 SOCK_CLOEXEC
= 010000000, /* Atomically set close-on-exec flag for the
65 #define SOCK_CLOEXEC SOCK_CLOEXEC
66 SOCK_NONBLOCK
= 0x40000000 /* Atomically mark descriptor(s) as
68 #define SOCK_NONBLOCK SOCK_NONBLOCK
71 /* Protocol families. */
72 #define PF_UNSPEC 0 /* Unspecified. */
73 #define PF_LOCAL 1 /* Local to host (pipes and file-domain). */
74 #define PF_UNIX PF_LOCAL /* POSIX name for PF_LOCAL. */
75 #define PF_FILE PF_LOCAL /* Another non-standard name for PF_LOCAL. */
76 #define PF_INET 2 /* IP protocol family. */
77 #define PF_AX25 3 /* Amateur Radio AX.25. */
78 #define PF_IPX 4 /* Novell Internet Protocol. */
79 #define PF_APPLETALK 5 /* Appletalk DDP. */
80 #define PF_NETROM 6 /* Amateur radio NetROM. */
81 #define PF_BRIDGE 7 /* Multiprotocol bridge. */
82 #define PF_ATMPVC 8 /* ATM PVCs. */
83 #define PF_X25 9 /* Reserved for X.25 project. */
84 #define PF_INET6 10 /* IP version 6. */
85 #define PF_ROSE 11 /* Amateur Radio X.25 PLP. */
86 #define PF_DECnet 12 /* Reserved for DECnet project. */
87 #define PF_NETBEUI 13 /* Reserved for 802.2LLC project. */
88 #define PF_SECURITY 14 /* Security callback pseudo AF. */
89 #define PF_KEY 15 /* PF_KEY key management API. */
91 #define PF_ROUTE PF_NETLINK /* Alias to emulate 4.4BSD. */
92 #define PF_PACKET 17 /* Packet family. */
93 #define PF_ASH 18 /* Ash. */
94 #define PF_ECONET 19 /* Acorn Econet. */
95 #define PF_ATMSVC 20 /* ATM SVCs. */
96 #define PF_RDS 21 /* RDS sockets. */
97 #define PF_SNA 22 /* Linux SNA Project */
98 #define PF_IRDA 23 /* IRDA sockets. */
99 #define PF_PPPOX 24 /* PPPoX sockets. */
100 #define PF_WANPIPE 25 /* Wanpipe API sockets. */
101 #define PF_LLC 26 /* Linux LLC. */
102 #define PF_CAN 29 /* Controller Area Network. */
103 #define PF_TIPC 30 /* TIPC sockets. */
104 #define PF_BLUETOOTH 31 /* Bluetooth sockets. */
105 #define PF_IUCV 32 /* IUCV sockets. */
106 #define PF_RXRPC 33 /* RxRPC sockets. */
107 #define PF_ISDN 34 /* mISDN sockets. */
108 #define PF_PHONET 35 /* Phonet sockets. */
109 #define PF_IEEE802154 36 /* IEEE 802.15.4 sockets. */
110 #define PF_MAX 37 /* For now.. */
112 /* Address families. */
113 #define AF_UNSPEC PF_UNSPEC
114 #define AF_LOCAL PF_LOCAL
115 #define AF_UNIX PF_UNIX
116 #define AF_FILE PF_FILE
117 #define AF_INET PF_INET
118 #define AF_AX25 PF_AX25
119 #define AF_IPX PF_IPX
120 #define AF_APPLETALK PF_APPLETALK
121 #define AF_NETROM PF_NETROM
122 #define AF_BRIDGE PF_BRIDGE
123 #define AF_ATMPVC PF_ATMPVC
124 #define AF_X25 PF_X25
125 #define AF_INET6 PF_INET6
126 #define AF_ROSE PF_ROSE
127 #define AF_DECnet PF_DECnet
128 #define AF_NETBEUI PF_NETBEUI
129 #define AF_SECURITY PF_SECURITY
130 #define AF_KEY PF_KEY
131 #define AF_NETLINK PF_NETLINK
132 #define AF_ROUTE PF_ROUTE
133 #define AF_PACKET PF_PACKET
134 #define AF_ASH PF_ASH
135 #define AF_ECONET PF_ECONET
136 #define AF_ATMSVC PF_ATMSVC
137 #define AF_RDS PF_RDS
138 #define AF_SNA PF_SNA
139 #define AF_IRDA PF_IRDA
140 #define AF_PPPOX PF_PPPOX
141 #define AF_WANPIPE PF_WANPIPE
142 #define AF_LLC PF_LLC
143 #define AF_CAN PF_CAN
144 #define AF_TIPC PF_TIPC
145 #define AF_BLUETOOTH PF_BLUETOOTH
146 #define AF_IUCV PF_IUCV
147 #define AF_RXRPC PF_RXRPC
148 #define AF_ISDN PF_ISDN
149 #define AF_PHONET PF_PHONET
150 #define AF_IEEE802154 PF_IEEE802154
151 #define AF_MAX PF_MAX
153 /* Socket level values. Others are defined in the appropriate headers.
155 XXX These definitions also should go into the appropriate headers as
156 far as they are available. */
158 #define SOL_DECNET 261
160 #define SOL_PACKET 263
161 #define SOL_ATM 264 /* ATM layer (cell level). */
162 #define SOL_AAL 265 /* ATM Adaption Layer (packet level). */
165 /* Maximum queue length specifiable by listen. */
166 #define SOMAXCONN 128
168 /* Get the definition of the macro to define the common sockaddr members. */
169 #include <bits/sockaddr.h>
171 /* Structure describing a generic socket address. */
174 __SOCKADDR_COMMON (sa_
); /* Common data: address family and length. */
175 char sa_data
[14]; /* Address data. */
179 /* Structure large enough to hold any socket address (with the historical
180 exception of AF_UNIX). We reserve 128 bytes. */
181 #define __ss_aligntype unsigned long int
183 #define _SS_PADSIZE (_SS_SIZE - (2 * sizeof (__ss_aligntype)))
185 struct sockaddr_storage
187 __SOCKADDR_COMMON (ss_
); /* Address family, etc. */
188 __ss_aligntype __ss_align
; /* Force desired alignment. */
189 char __ss_padding
[_SS_PADSIZE
];
193 /* Bits in the FLAGS argument to `send', `recv', et al. */
196 MSG_OOB
= 0x01, /* Process out-of-band data. */
197 #define MSG_OOB MSG_OOB
198 MSG_PEEK
= 0x02, /* Peek at incoming messages. */
199 #define MSG_PEEK MSG_PEEK
200 MSG_DONTROUTE
= 0x04, /* Don't use local routing. */
201 #define MSG_DONTROUTE MSG_DONTROUTE
203 /* DECnet uses a different name. */
204 MSG_TRYHARD
= MSG_DONTROUTE
,
205 # define MSG_TRYHARD MSG_DONTROUTE
207 MSG_CTRUNC
= 0x08, /* Control data lost before delivery. */
208 #define MSG_CTRUNC MSG_CTRUNC
209 MSG_PROXY
= 0x10, /* Supply or ask second address. */
210 #define MSG_PROXY MSG_PROXY
212 #define MSG_TRUNC MSG_TRUNC
213 MSG_DONTWAIT
= 0x40, /* Nonblocking IO. */
214 #define MSG_DONTWAIT MSG_DONTWAIT
215 MSG_EOR
= 0x80, /* End of record. */
216 #define MSG_EOR MSG_EOR
217 MSG_WAITALL
= 0x100, /* Wait for a full request. */
218 #define MSG_WAITALL MSG_WAITALL
220 #define MSG_FIN MSG_FIN
222 #define MSG_SYN MSG_SYN
223 MSG_CONFIRM
= 0x800, /* Confirm path validity. */
224 #define MSG_CONFIRM MSG_CONFIRM
226 #define MSG_RST MSG_RST
227 MSG_ERRQUEUE
= 0x2000, /* Fetch message from error queue. */
228 #define MSG_ERRQUEUE MSG_ERRQUEUE
229 MSG_NOSIGNAL
= 0x4000, /* Do not generate SIGPIPE. */
230 #define MSG_NOSIGNAL MSG_NOSIGNAL
231 MSG_MORE
= 0x8000, /* Sender will send more. */
232 #define MSG_MORE MSG_MORE
233 MSG_WAITFORONE
= 0x10000, /* Wait for at least one packet to return.*/
234 #define MSG_WAITFORONE MSG_WAITFORONE
236 MSG_CMSG_CLOEXEC
= 0x40000000 /* Set close_on_exit for file
237 descriptor received through
239 #define MSG_CMSG_CLOEXEC MSG_CMSG_CLOEXEC
243 /* Structure describing messages sent by
244 `sendmsg' and received by `recvmsg'. */
247 void *msg_name
; /* Address to send to/receive from. */
248 socklen_t msg_namelen
; /* Length of address data. */
250 struct iovec
*msg_iov
; /* Vector of data to send/receive into. */
251 size_t msg_iovlen
; /* Number of elements in the vector. */
253 void *msg_control
; /* Ancillary data (eg BSD filedesc passing). */
254 size_t msg_controllen
; /* Ancillary data buffer length.
255 !! The type should be socklen_t but the
256 definition of the kernel is incompatible
259 int msg_flags
; /* Flags on received message. */
263 /* For `recvmmsg'. */
266 struct msghdr msg_hdr
; /* Actual message header. */
267 unsigned int msg_len
; /* Number of received bytes for the entry. */
271 /* Structure used for storage of ancillary data object information. */
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
279 int cmsg_level
; /* Originating protocol. */
280 int cmsg_type
; /* Protocol specific type. */
281 #if (!defined __STRICT_ANSI__ && __GNUC__ >= 2) || __STDC_VERSION__ >= 199901L
282 __extension__
unsigned char __cmsg_data __flexarr
; /* Ancillary data. */
286 /* Ancillary data object manipulation macros. */
287 #if (!defined __STRICT_ANSI__ && __GNUC__ >= 2) || __STDC_VERSION__ >= 199901L
288 # define CMSG_DATA(cmsg) ((cmsg)->__cmsg_data)
290 # define CMSG_DATA(cmsg) ((unsigned char *) ((struct cmsghdr *) (cmsg) + 1))
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))
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
308 _EXTERN_INLINE
struct cmsghdr
*
309 __NTH (__cmsg_nxthdr (struct msghdr
*__mhdr
, struct cmsghdr
*__cmsg
))
311 if ((size_t) __cmsg
->cmsg_len
< sizeof (struct cmsghdr
))
312 /* The kernel header does this so there may be a reason. */
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. */
325 #endif /* Use `extern inline'. */
327 /* Socket level message types. This must match the definitions in
331 SCM_RIGHTS
= 0x01 /* Transfer file descriptors. */
332 #define SCM_RIGHTS SCM_RIGHTS
334 , SCM_CREDENTIALS
= 0x02 /* Credentials passing. */
335 # define SCM_CREDENTIALS SCM_CREDENTIALS
340 /* User visible structure for SCM_CREDENTIALS message */
343 pid_t pid
; /* PID of sending process. */
344 uid_t uid
; /* UID of sending process. */
345 gid_t gid
; /* GID of sending process. */
349 /* Ugly workaround for unclean kernel headers. */
350 #if !defined __USE_MISC && !defined __USE_GNU
352 # define __SYS_SOCKET_H_undef_FIOGETOWN
355 # define __SYS_SOCKET_H_undef_FIOSETOWN
358 # define __SYS_SOCKET_H_undef_SIOCATMARK
361 # define __SYS_SOCKET_H_undef_SIOCGPGRP
364 # define __SYS_SOCKET_H_undef_SIOCGSTAMP
366 # ifndef SIOCGSTAMPNS
367 # define __SYS_SOCKET_H_undef_SIOCGSTAMPNS
370 # define __SYS_SOCKET_H_undef_SIOCSPGRP
374 /* Get socket manipulation related informations from kernel headers. */
375 #include <asm/socket.h>
377 #if !defined __USE_MISC && !defined __USE_GNU
378 # ifdef __SYS_SOCKET_H_undef_FIOGETOWN
379 # undef __SYS_SOCKET_H_undef_FIOGETOWN
382 # ifdef __SYS_SOCKET_H_undef_FIOSETOWN
383 # undef __SYS_SOCKET_H_undef_FIOSETOWN
386 # ifdef __SYS_SOCKET_H_undef_SIOCATMARK
387 # undef __SYS_SOCKET_H_undef_SIOCATMARK
390 # ifdef __SYS_SOCKET_H_undef_SIOCGPGRP
391 # undef __SYS_SOCKET_H_undef_SIOCGPGRP
394 # ifdef __SYS_SOCKET_H_undef_SIOCGSTAMP
395 # undef __SYS_SOCKET_H_undef_SIOCGSTAMP
398 # ifdef __SYS_SOCKET_H_undef_SIOCGSTAMPNS
399 # undef __SYS_SOCKET_H_undef_SIOCGSTAMPNS
402 # ifdef __SYS_SOCKET_H_undef_SIOCSPGRP
403 # undef __SYS_SOCKET_H_undef_SIOCSPGRP
408 /* Structure used to manipulate the SO_LINGER option. */
411 int l_onoff
; /* Nonzero to linger on close. */
412 int l_linger
; /* Time to linger. */
419 /* Receive up to VLEN messages as described by VMESSAGES from socket FD.
420 Returns the number of bytes read or -1 for errors.
421 This function is a cancellation point and therefore not marked with
423 extern int recvmmsg (int __fd
, struct mmsghdr
*__vmessages
,
424 unsigned int __vlen
, int __flags
,
425 const struct timespec
*__tmo
);
427 /* Send a VLEN messages as described by VMESSAGES to socket FD.
428 Return the number of datagrams successfully written or -1 for errors.
429 This function is a cancellation point and therefore not marked with
431 extern int sendmmsg (int __fd
, struct mmsghdr
*__vmessages
,
432 unsigned int __vlen
, int __flags
);
437 #endif /* bits/socket.h */