LXR linux/include/linux/socket.h

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