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