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

source code of linux/include/linux/socket.h