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