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