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