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