LXR linux/include/linux/socket.h

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