include/linux/socket.h

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