1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _LINUX_SOCKET_H
3 #define _LINUX_SOCKET_H
4
5
6 #include <asm/socket.h> /* arch-dependent defines */
7 #include <linux/sockios.h> /* the SIOCxxx I/O controls */
8 #include <linux/uio.h> /* iovec support */
9 #include <linux/types.h> /* pid_t */
10 #include <linux/compiler.h> /* __user */
11 #include <uapi/linux/socket.h>
12
13 struct file;
14 struct pid;
15 struct cred;
16 struct socket;
17
18 #define __sockaddr_check_size(size) \
19 BUILD_BUG_ON(((size) > sizeof(struct __kernel_sockaddr_storage)))
20
21 #ifdef CONFIG_PROC_FS
22 struct seq_file;
23 extern void socket_seq_show(struct seq_file *seq);
24 #endif
25
26 typedef __kernel_sa_family_t sa_family_t;
27
28 /*
29 * 1003.1g requires sa_family_t and that sa_data is char.
30 */
31
32 struct sockaddr {
33 sa_family_t sa_family; /* address family, AF_xxx */
34 union {
35 char sa_data_min[14]; /* Minimum 14 bytes of protocol address */
36 DECLARE_FLEX_ARRAY(char, sa_data);
37 };
38 };
39
40 struct linger {
41 int l_onoff; /* Linger active */
42 int l_linger; /* How long to linger for */
43 };
44
45 #define sockaddr_storage __kernel_sockaddr_storage
46
47 /*
48 * As we do 4.4BSD message passing we use a 4.4BSD message passing
49 * system, not 4.3. Thus msg_accrights(len) are now missing. They
50 * belong in an obscure libc emulation or the bin.
51 */
52
53 struct msghdr {
54 void *msg_name; /* ptr to socket address structure */
55 int msg_namelen; /* size of socket address structure */
56 struct iov_iter msg_iter; /* data */
57
58 /*
59 * Ancillary data. msg_control_user is the user buffer used for the
60 * recv* side when msg_control_is_user is set, msg_control is the kernel
61 * buffer used for all other cases.
62 */
63 union {
64 void *msg_control;
65 void __user *msg_control_user;
66 };
67 bool msg_control_is_user : 1;
68 __kernel_size_t msg_controllen; /* ancillary data buffer length */
69 unsigned int msg_flags; /* flags on received message */
70 struct kiocb *msg_iocb; /* ptr to iocb for async requests */
71 };
72
73 struct user_msghdr {
74 void __user *msg_name; /* ptr to socket address structure */
75 int msg_namelen; /* size of socket address structure */
76 struct iovec __user *msg_iov; /* scatter/gather array */
77 __kernel_size_t msg_iovlen; /* # elements in msg_iov */
78 void __user *msg_control; /* ancillary data */
79 __kernel_size_t msg_controllen; /* ancillary data buffer length */
80 unsigned int msg_flags; /* flags on received message */
81 };
82
83 /* For recvmmsg/sendmmsg */
84 struct mmsghdr {
85 struct user_msghdr msg_hdr;
86 unsigned int msg_len;
87 };
88
89 /*
90 * POSIX 1003.1g - ancillary data object information
91 * Ancillary data consits of a sequence of pairs of
92 * (cmsghdr, cmsg_data[])
93 */
94
95 struct cmsghdr {
96 __kernel_size_t cmsg_len; /* data byte count, including hdr */
97 int cmsg_level; /* originating protocol */
98 int cmsg_type; /* protocol-specific type */
99 };
100
101 /*
102 * Ancillary data object information MACROS
103 * Table 5-14 of POSIX 1003.1g
104 */
105
106 #define __CMSG_NXTHDR(ctl, len, cmsg) __cmsg_nxthdr((ctl),(len),(cmsg))
107 #define CMSG_NXTHDR(mhdr, cmsg) cmsg_nxthdr((mhdr), (cmsg))
108
109 #define CMSG_ALIGN(len) ( ((len)+sizeof(long)-1) & ~(sizeof(long)-1) )
110
111 #define CMSG_DATA(cmsg) \
112 ((void *)(cmsg) + sizeof(struct cmsghdr))
113 #define CMSG_USER_DATA(cmsg) \
114 ((void __user *)(cmsg) + sizeof(struct cmsghdr))
115 #define CMSG_SPACE(len) (sizeof(struct cmsghdr) + CMSG_ALIGN(len))
116 #define CMSG_LEN(len) (sizeof(struct cmsghdr) + (len))
117
118 #define __CMSG_FIRSTHDR(ctl,len) ((len) >= sizeof(struct cmsghdr) ? \
119 (struct cmsghdr *)(ctl) : \
120 (struct cmsghdr *)NULL)
121 #define CMSG_FIRSTHDR(msg) __CMSG_FIRSTHDR((msg)->msg_control, (msg)->msg_controllen)
122 #define CMSG_OK(mhdr, cmsg) ((cmsg)->cmsg_len >= sizeof(struct cmsghdr) && \
123 (cmsg)->cmsg_len <= (unsigned long) \
124 ((mhdr)->msg_controllen - \
125 ((char *)(cmsg) - (char *)(mhdr)->msg_control)))
126 #define for_each_cmsghdr(cmsg, msg) \
127 for (cmsg = CMSG_FIRSTHDR(msg); \
128 cmsg; \
129 cmsg = CMSG_NXTHDR(msg, cmsg))
130
131 /*
132 * Get the next cmsg header
133 *
134 * PLEASE, do not touch this function. If you think, that it is
135 * incorrect, grep kernel sources and think about consequences
136 * before trying to improve it.
137 *
138 * Now it always returns valid, not truncated ancillary object
139 * HEADER. But caller still MUST check, that cmsg->cmsg_len is
140 * inside range, given by msg->msg_controllen before using
141 * ancillary object DATA. --ANK (980731)
142 */
143
__cmsg_nxthdr(void * __ctl,__kernel_size_t __size,struct cmsghdr * __cmsg)144 static inline struct cmsghdr * __cmsg_nxthdr(void *__ctl, __kernel_size_t __size,
145 struct cmsghdr *__cmsg)
146 {
147 struct cmsghdr * __ptr;
148
149 __ptr = (struct cmsghdr*)(((unsigned char *) __cmsg) + CMSG_ALIGN(__cmsg->cmsg_len));
150 if ((unsigned long)((char*)(__ptr+1) - (char *) __ctl) > __size)
151 return (struct cmsghdr *)0;
152
153 return __ptr;
154 }
155
cmsg_nxthdr(struct msghdr * __msg,struct cmsghdr * __cmsg)156 static inline struct cmsghdr * cmsg_nxthdr (struct msghdr *__msg, struct cmsghdr *__cmsg)
157 {
158 return __cmsg_nxthdr(__msg->msg_control, __msg->msg_controllen, __cmsg);
159 }
160
msg_data_left(struct msghdr * msg)161 static inline size_t msg_data_left(struct msghdr *msg)
162 {
163 return iov_iter_count(&msg->msg_iter);
164 }
165
166 /* "Socket"-level control message types: */
167
168 #define SCM_RIGHTS 0x01 /* rw: access rights (array of int) */
169 #define SCM_CREDENTIALS 0x02 /* rw: struct ucred */
170 #define SCM_SECURITY 0x03 /* rw: security label */
171
172 struct ucred {
173 __u32 pid;
174 __u32 uid;
175 __u32 gid;
176 };
177
178 /* Supported address families. */
179 #define AF_UNSPEC 0
180 #define AF_UNIX 1 /* Unix domain sockets */
181 #define AF_LOCAL 1 /* POSIX name for AF_UNIX */
182 #define AF_INET 2 /* Internet IP Protocol */
183 #define AF_AX25 3 /* Amateur Radio AX.25 */
184 #define AF_IPX 4 /* Novell IPX */
185 #define AF_APPLETALK 5 /* AppleTalk DDP */
186 #define AF_NETROM 6 /* Amateur Radio NET/ROM */
187 #define AF_BRIDGE 7 /* Multiprotocol bridge */
188 #define AF_ATMPVC 8 /* ATM PVCs */
189 #define AF_X25 9 /* Reserved for X.25 project */
190 #define AF_INET6 10 /* IP version 6 */
191 #define AF_ROSE 11 /* Amateur Radio X.25 PLP */
192 #define AF_DECnet 12 /* Reserved for DECnet project */
193 #define AF_NETBEUI 13 /* Reserved for 802.2LLC project*/
194 #define AF_SECURITY 14 /* Security callback pseudo AF */
195 #define AF_KEY 15 /* PF_KEY key management API */
196 #define AF_NETLINK 16
197 #define AF_ROUTE AF_NETLINK /* Alias to emulate 4.4BSD */
198 #define AF_PACKET 17 /* Packet family */
199 #define AF_ASH 18 /* Ash */
200 #define AF_ECONET 19 /* Acorn Econet */
201 #define AF_ATMSVC 20 /* ATM SVCs */
202 #define AF_RDS 21 /* RDS sockets */
203 #define AF_SNA 22 /* Linux SNA Project (nutters!) */
204 #define AF_IRDA 23 /* IRDA sockets */
205 #define AF_PPPOX 24 /* PPPoX sockets */
206 #define AF_WANPIPE 25 /* Wanpipe API Sockets */
207 #define AF_LLC 26 /* Linux LLC */
208 #define AF_IB 27 /* Native InfiniBand address */
209 #define AF_MPLS 28 /* MPLS */
210 #define AF_CAN 29 /* Controller Area Network */
211 #define AF_TIPC 30 /* TIPC sockets */
212 #define AF_BLUETOOTH 31 /* Bluetooth sockets */
213 #define AF_IUCV 32 /* IUCV sockets */
214 #define AF_RXRPC 33 /* RxRPC sockets */
215 #define AF_ISDN 34 /* mISDN sockets */
216 #define AF_PHONET 35 /* Phonet sockets */
217 #define AF_IEEE802154 36 /* IEEE802154 sockets */
218 #define AF_CAIF 37 /* CAIF sockets */
219 #define AF_ALG 38 /* Algorithm sockets */
220 #define AF_NFC 39 /* NFC sockets */
221 #define AF_VSOCK 40 /* vSockets */
222 #define AF_KCM 41 /* Kernel Connection Multiplexor*/
223 #define AF_QIPCRTR 42 /* Qualcomm IPC Router */
224 #define AF_SMC 43 /* smc sockets: reserve number for
225 * PF_SMC protocol family that
226 * reuses AF_INET address family
227 */
228 #define AF_XDP 44 /* XDP sockets */
229 #define AF_NINET 45 /* NIP */
230 #define AF_MAX 46 /* For now.. */
231
232 /* Protocol families, same as address families. */
233 #define PF_UNSPEC AF_UNSPEC
234 #define PF_UNIX AF_UNIX
235 #define PF_LOCAL AF_LOCAL
236 #define PF_INET AF_INET
237 #define PF_AX25 AF_AX25
238 #define PF_IPX AF_IPX
239 #define PF_APPLETALK AF_APPLETALK
240 #define PF_NETROM AF_NETROM
241 #define PF_BRIDGE AF_BRIDGE
242 #define PF_ATMPVC AF_ATMPVC
243 #define PF_X25 AF_X25
244 #define PF_INET6 AF_INET6
245 #define PF_ROSE AF_ROSE
246 #define PF_DECnet AF_DECnet
247 #define PF_NETBEUI AF_NETBEUI
248 #define PF_SECURITY AF_SECURITY
249 #define PF_KEY AF_KEY
250 #define PF_NETLINK AF_NETLINK
251 #define PF_ROUTE AF_ROUTE
252 #define PF_PACKET AF_PACKET
253 #define PF_ASH AF_ASH
254 #define PF_ECONET AF_ECONET
255 #define PF_ATMSVC AF_ATMSVC
256 #define PF_RDS AF_RDS
257 #define PF_SNA AF_SNA
258 #define PF_IRDA AF_IRDA
259 #define PF_PPPOX AF_PPPOX
260 #define PF_WANPIPE AF_WANPIPE
261 #define PF_LLC AF_LLC
262 #define PF_IB AF_IB
263 #define PF_MPLS AF_MPLS
264 #define PF_CAN AF_CAN
265 #define PF_TIPC AF_TIPC
266 #define PF_BLUETOOTH AF_BLUETOOTH
267 #define PF_IUCV AF_IUCV
268 #define PF_RXRPC AF_RXRPC
269 #define PF_ISDN AF_ISDN
270 #define PF_PHONET AF_PHONET
271 #define PF_IEEE802154 AF_IEEE802154
272 #define PF_CAIF AF_CAIF
273 #define PF_ALG AF_ALG
274 #define PF_NFC AF_NFC
275 #define PF_VSOCK AF_VSOCK
276 #define PF_KCM AF_KCM
277 #define PF_QIPCRTR AF_QIPCRTR
278 #define PF_SMC AF_SMC
279 #define PF_XDP AF_XDP
280 #define PF_NINET AF_NINET /* NIP */
281 #define PF_MAX AF_MAX
282
283 /* Maximum queue length specifiable by listen. */
284 #define SOMAXCONN 4096
285
286 /* Flags we can use with send/ and recv.
287 Added those for 1003.1g not all are supported yet
288 */
289
290 #define MSG_OOB 1
291 #define MSG_PEEK 2
292 #define MSG_DONTROUTE 4
293 #define MSG_TRYHARD 4 /* Synonym for MSG_DONTROUTE for DECnet */
294 #define MSG_CTRUNC 8
295 #define MSG_PROBE 0x10 /* Do not send. Only probe path f.e. for MTU */
296 #define MSG_TRUNC 0x20
297 #define MSG_DONTWAIT 0x40 /* Nonblocking io */
298 #define MSG_EOR 0x80 /* End of record */
299 #define MSG_WAITALL 0x100 /* Wait for a full request */
300 #define MSG_FIN 0x200
301 #define MSG_SYN 0x400
302 #define MSG_CONFIRM 0x800 /* Confirm path validity */
303 #define MSG_RST 0x1000
304 #define MSG_ERRQUEUE 0x2000 /* Fetch message from error queue */
305 #define MSG_NOSIGNAL 0x4000 /* Do not generate SIGPIPE */
306 #define MSG_MORE 0x8000 /* Sender will send more */
307 #define MSG_WAITFORONE 0x10000 /* recvmmsg(): block until 1+ packets avail */
308 #define MSG_SENDPAGE_NOPOLICY 0x10000 /* sendpage() internal : do no apply policy */
309 #define MSG_SENDPAGE_NOTLAST 0x20000 /* sendpage() internal : not the last page */
310 #define MSG_BATCH 0x40000 /* sendmmsg(): more messages coming */
311 #define MSG_EOF MSG_FIN
312 #define MSG_NO_SHARED_FRAGS 0x80000 /* sendpage() internal : page frags are not shared */
313 #define MSG_SENDPAGE_DECRYPTED 0x100000 /* sendpage() internal : page may carry
314 * plain text and require encryption
315 */
316
317 #define MSG_ZEROCOPY 0x4000000 /* Use user data in kernel path */
318 #define MSG_FASTOPEN 0x20000000 /* Send data in TCP SYN */
319 #define MSG_CMSG_CLOEXEC 0x40000000 /* Set close_on_exec for file
320 descriptor received through
321 SCM_RIGHTS */
322 #if defined(CONFIG_COMPAT)
323 #define MSG_CMSG_COMPAT 0x80000000 /* This message needs 32 bit fixups */
324 #else
325 #define MSG_CMSG_COMPAT 0 /* We never have 32 bit fixups */
326 #endif
327
328
329 /* Setsockoptions(2) level. Thanks to BSD these must match IPPROTO_xxx */
330 #define SOL_IP 0
331 /* #define SOL_ICMP 1 No-no-no! Due to Linux :-) we cannot use SOL_ICMP=1 */
332 #define SOL_TCP 6
333 #define SOL_UDP 17
334 #define SOL_IPV6 41
335 #define SOL_ICMPV6 58
336 #define SOL_SCTP 132
337 #define SOL_UDPLITE 136 /* UDP-Lite (RFC 3828) */
338 #define SOL_RAW 255
339 #define SOL_IPX 256
340 #define SOL_AX25 257
341 #define SOL_ATALK 258
342 #define SOL_NETROM 259
343 #define SOL_ROSE 260
344 #define SOL_DECNET 261
345 #define SOL_X25 262
346 #define SOL_PACKET 263
347 #define SOL_ATM 264 /* ATM layer (cell level) */
348 #define SOL_AAL 265 /* ATM Adaption Layer (packet level) */
349 #define SOL_IRDA 266
350 #define SOL_NETBEUI 267
351 #define SOL_LLC 268
352 #define SOL_DCCP 269
353 #define SOL_NETLINK 270
354 #define SOL_TIPC 271
355 #define SOL_RXRPC 272
356 #define SOL_PPPOL2TP 273
357 #define SOL_BLUETOOTH 274
358 #define SOL_PNPIPE 275
359 #define SOL_RDS 276
360 #define SOL_IUCV 277
361 #define SOL_CAIF 278
362 #define SOL_ALG 279
363 #define SOL_NFC 280
364 #define SOL_KCM 281
365 #define SOL_TLS 282
366 #define SOL_XDP 283
367
368 /* IPX options */
369 #define IPX_TYPE 1
370
371 extern int move_addr_to_kernel(void __user *uaddr, int ulen, struct sockaddr_storage *kaddr);
372 extern int put_cmsg(struct msghdr*, int level, int type, int len, void *data);
373
374 struct timespec64;
375 struct __kernel_timespec;
376 struct old_timespec32;
377
378 struct scm_timestamping_internal {
379 struct timespec64 ts[3];
380 };
381
382 extern void put_cmsg_scm_timestamping64(struct msghdr *msg, struct scm_timestamping_internal *tss);
383 extern void put_cmsg_scm_timestamping(struct msghdr *msg, struct scm_timestamping_internal *tss);
384
385 /* The __sys_...msg variants allow MSG_CMSG_COMPAT iff
386 * forbid_cmsg_compat==false
387 */
388 extern long __sys_recvmsg(int fd, struct user_msghdr __user *msg,
389 unsigned int flags, bool forbid_cmsg_compat);
390 extern long __sys_sendmsg(int fd, struct user_msghdr __user *msg,
391 unsigned int flags, bool forbid_cmsg_compat);
392 extern int __sys_recvmmsg(int fd, struct mmsghdr __user *mmsg,
393 unsigned int vlen, unsigned int flags,
394 struct __kernel_timespec __user *timeout,
395 struct old_timespec32 __user *timeout32);
396 extern int __sys_sendmmsg(int fd, struct mmsghdr __user *mmsg,
397 unsigned int vlen, unsigned int flags,
398 bool forbid_cmsg_compat);
399 extern long __sys_sendmsg_sock(struct socket *sock, struct msghdr *msg,
400 unsigned int flags);
401 extern long __sys_recvmsg_sock(struct socket *sock, struct msghdr *msg,
402 struct user_msghdr __user *umsg,
403 struct sockaddr __user *uaddr,
404 unsigned int flags);
405 extern int sendmsg_copy_msghdr(struct msghdr *msg,
406 struct user_msghdr __user *umsg, unsigned flags,
407 struct iovec **iov);
408 extern int recvmsg_copy_msghdr(struct msghdr *msg,
409 struct user_msghdr __user *umsg, unsigned flags,
410 struct sockaddr __user **uaddr,
411 struct iovec **iov);
412 extern int __copy_msghdr_from_user(struct msghdr *kmsg,
413 struct user_msghdr __user *umsg,
414 struct sockaddr __user **save_addr,
415 struct iovec __user **uiov, size_t *nsegs);
416
417 /* helpers which do the actual work for syscalls */
418 extern int __sys_recvfrom(int fd, void __user *ubuf, size_t size,
419 unsigned int flags, struct sockaddr __user *addr,
420 int __user *addr_len);
421 extern int __sys_sendto(int fd, void __user *buff, size_t len,
422 unsigned int flags, struct sockaddr __user *addr,
423 int addr_len);
424 extern int __sys_accept4_file(struct file *file, unsigned file_flags,
425 struct sockaddr __user *upeer_sockaddr,
426 int __user *upeer_addrlen, int flags,
427 unsigned long nofile);
428 extern struct file *do_accept(struct file *file, unsigned file_flags,
429 struct sockaddr __user *upeer_sockaddr,
430 int __user *upeer_addrlen, int flags);
431 extern int __sys_accept4(int fd, struct sockaddr __user *upeer_sockaddr,
432 int __user *upeer_addrlen, int flags);
433 extern int __sys_socket(int family, int type, int protocol);
434 extern int __sys_bind(int fd, struct sockaddr __user *umyaddr, int addrlen);
435 extern int __sys_connect_file(struct file *file, struct sockaddr_storage *addr,
436 int addrlen, int file_flags);
437 extern int __sys_connect(int fd, struct sockaddr __user *uservaddr,
438 int addrlen);
439 extern int __sys_listen(int fd, int backlog);
440 extern int __sys_getsockname(int fd, struct sockaddr __user *usockaddr,
441 int __user *usockaddr_len);
442 extern int __sys_getpeername(int fd, struct sockaddr __user *usockaddr,
443 int __user *usockaddr_len);
444 extern int __sys_socketpair(int family, int type, int protocol,
445 int __user *usockvec);
446 extern int __sys_shutdown_sock(struct socket *sock, int how);
447 extern int __sys_shutdown(int fd, int how);
448 #endif /* _LINUX_SOCKET_H */
449