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