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