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