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