LXR linux/include/linux/net.h

   1/*
   2 * NET          An implementation of the SOCKET network access protocol.
   3 *              This is the master header file for the Linux NET layer,
   4 *              or, in plain English: the networking handling part of the
   5 *              kernel.
   6 *
   7 * Version:     @(#)net.h       1.0.3   05/25/93
   8 *
   9 * Authors:     Orest Zborowski, <obz@Kodak.COM>
  10 *              Ross Biro
  11 *              Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
  12 *
  13 *              This program is free software; you can redistribute it and/or
  14 *              modify it under the terms of the GNU General Public License
  15 *              as published by the Free Software Foundation; either version
  16 *              2 of the License, or (at your option) any later version.
  17 */
  18#ifndef _LINUX_NET_H
  19#define _LINUX_NET_H
  20
  21#include <linux/socket.h>
  22#include <asm/socket.h>
  23
  24#define NPROTO          AF_MAX
  25
  26#define SYS_SOCKET      1               /* sys_socket(2)                */
  27#define SYS_BIND        2               /* sys_bind(2)                  */
  28#define SYS_CONNECT     3               /* sys_connect(2)               */
  29#define SYS_LISTEN      4               /* sys_listen(2)                */
  30#define SYS_ACCEPT      5               /* sys_accept(2)                */
  31#define SYS_GETSOCKNAME 6               /* sys_getsockname(2)           */
  32#define SYS_GETPEERNAME 7               /* sys_getpeername(2)           */
  33#define SYS_SOCKETPAIR  8               /* sys_socketpair(2)            */
  34#define SYS_SEND        9               /* sys_send(2)                  */
  35#define SYS_RECV        10              /* sys_recv(2)                  */
  36#define SYS_SENDTO      11              /* sys_sendto(2)                */
  37#define SYS_RECVFROM    12              /* sys_recvfrom(2)              */
  38#define SYS_SHUTDOWN    13              /* sys_shutdown(2)              */
  39#define SYS_SETSOCKOPT  14              /* sys_setsockopt(2)            */
  40#define SYS_GETSOCKOPT  15              /* sys_getsockopt(2)            */
  41#define SYS_SENDMSG     16              /* sys_sendmsg(2)               */
  42#define SYS_RECVMSG     17              /* sys_recvmsg(2)               */
  43#define SYS_ACCEPT4     18              /* sys_accept4(2)               */
  44
  45typedef enum {
  46        SS_FREE = 0,                    /* not allocated                */
  47        SS_UNCONNECTED,                 /* unconnected to any socket    */
  48        SS_CONNECTING,                  /* in process of connecting     */
  49        SS_CONNECTED,                   /* connected to socket          */
  50        SS_DISCONNECTING                /* in process of disconnecting  */
  51} socket_state;
  52
  53#define __SO_ACCEPTCON  (1 << 16)       /* performed a listen           */
  54
  55#ifdef __KERNEL__
  56#include <linux/stringify.h>
  57#include <linux/random.h>
  58#include <linux/wait.h>
  59#include <linux/fcntl.h>        /* For O_CLOEXEC and O_NONBLOCK */
  60
  61struct poll_table_struct;
  62struct pipe_inode_info;
  63struct inode;
  64struct net;
  65
  66#define SOCK_ASYNC_NOSPACE      0
  67#define SOCK_ASYNC_WAITDATA     1
  68#define SOCK_NOSPACE            2
  69#define SOCK_PASSCRED           3
  70#define SOCK_PASSSEC            4
  71
  72#ifndef ARCH_HAS_SOCKET_TYPES
  73/**
  74 * enum sock_type - Socket types
  75 * @SOCK_STREAM: stream (connection) socket
  76 * @SOCK_DGRAM: datagram (conn.less) socket
  77 * @SOCK_RAW: raw socket
  78 * @SOCK_RDM: reliably-delivered message
  79 * @SOCK_SEQPACKET: sequential packet socket
  80 * @SOCK_DCCP: Datagram Congestion Control Protocol socket
  81 * @SOCK_PACKET: linux specific way of getting packets at the dev level.
  82 *                For writing rarp and other similar things on the user level.
  83 *
  84 * When adding some new socket type please
  85 * grep ARCH_HAS_SOCKET_TYPE include/asm-* /socket.h, at least MIPS
  86 * overrides this enum for binary compat reasons.
  87 */
  88enum sock_type {
  89        SOCK_STREAM     = 1,
  90        SOCK_DGRAM      = 2,
  91        SOCK_RAW        = 3,
  92        SOCK_RDM        = 4,
  93        SOCK_SEQPACKET  = 5,
  94        SOCK_DCCP       = 6,
  95        SOCK_PACKET     = 10,
  96};
  97
  98#define SOCK_MAX (SOCK_PACKET + 1)
  99/* Mask which covers at least up to SOCK_MASK-1.  The
 100 * remaining bits are used as flags. */
 101#define SOCK_TYPE_MASK 0xf
 102
 103/* Flags for socket, socketpair, accept4 */
 104#define SOCK_CLOEXEC    O_CLOEXEC
 105#ifndef SOCK_NONBLOCK
 106#define SOCK_NONBLOCK   O_NONBLOCK
 107#endif
 108
 109#endif /* ARCH_HAS_SOCKET_TYPES */
 110
 111enum sock_shutdown_cmd {
 112        SHUT_RD         = 0,
 113        SHUT_WR         = 1,
 114        SHUT_RDWR       = 2,
 115};
 116
 117/**
 118 *  struct socket - general BSD socket
 119 *  @state: socket state (%SS_CONNECTED, etc)
 120 *  @type: socket type (%SOCK_STREAM, etc)
 121 *  @flags: socket flags (%SOCK_ASYNC_NOSPACE, etc)
 122 *  @ops: protocol specific socket operations
 123 *  @fasync_list: Asynchronous wake up list
 124 *  @file: File back pointer for gc
 125 *  @sk: internal networking protocol agnostic socket representation
 126 *  @wait: wait queue for several uses
 127 */
 128struct socket {
 129        socket_state            state;
 130        short                   type;
 131        unsigned long           flags;
 132        /*
 133         * Please keep fasync_list & wait fields in the same cache line
 134         */
 135        struct fasync_struct    *fasync_list;
 136        wait_queue_head_t       wait;
 137
 138        struct file             *file;
 139        struct sock             *sk;
 140        const struct proto_ops  *ops;
 141};
 142
 143struct vm_area_struct;
 144struct page;
 145struct kiocb;
 146struct sockaddr;
 147struct msghdr;
 148struct module;
 149
 150struct proto_ops {
 151        int             family;
 152        struct module   *owner;
 153        int             (*release)   (struct socket *sock);
 154        int             (*bind)      (struct socket *sock,
 155                                      struct sockaddr *myaddr,
 156                                      int sockaddr_len);
 157        int             (*connect)   (struct socket *sock,
 158                                      struct sockaddr *vaddr,
 159                                      int sockaddr_len, int flags);
 160        int             (*socketpair)(struct socket *sock1,
 161                                      struct socket *sock2);
 162        int             (*accept)    (struct socket *sock,
 163                                      struct socket *newsock, int flags);
 164        int             (*getname)   (struct socket *sock,
 165                                      struct sockaddr *addr,
 166                                      int *sockaddr_len, int peer);
 167        unsigned int    (*poll)      (struct file *file, struct socket *sock,
 168                                      struct poll_table_struct *wait);
 169        int             (*ioctl)     (struct socket *sock, unsigned int cmd,
 170                                      unsigned long arg);
 171        int             (*compat_ioctl) (struct socket *sock, unsigned int cmd,
 172                                      unsigned long arg);
 173        int             (*listen)    (struct socket *sock, int len);
 174        int             (*shutdown)  (struct socket *sock, int flags);
 175        int             (*setsockopt)(struct socket *sock, int level,
 176                                      int optname, char __user *optval, int optlen);
 177        int             (*getsockopt)(struct socket *sock, int level,
 178                                      int optname, char __user *optval, int __user *optlen);
 179        int             (*compat_setsockopt)(struct socket *sock, int level,
 180                                      int optname, char __user *optval, int optlen);
 181        int             (*compat_getsockopt)(struct socket *sock, int level,
 182                                      int optname, char __user *optval, int __user *optlen);
 183        int             (*sendmsg)   (struct kiocb *iocb, struct socket *sock,
 184                                      struct msghdr *m, size_t total_len);
 185        int             (*recvmsg)   (struct kiocb *iocb, struct socket *sock,
 186                                      struct msghdr *m, size_t total_len,
 187                                      int flags);
 188        int             (*mmap)      (struct file *file, struct socket *sock,
 189                                      struct vm_area_struct * vma);
 190        ssize_t         (*sendpage)  (struct socket *sock, struct page *page,
 191                                      int offset, size_t size, int flags);
 192        ssize_t         (*splice_read)(struct socket *sock,  loff_t *ppos,
 193                                       struct pipe_inode_info *pipe, size_t len, unsigned int flags);
 194};
 195
 196struct net_proto_family {
 197        int             family;
 198        int             (*create)(struct net *net, struct socket *sock, int protocol);
 199        struct module   *owner;
 200};
 201
 202struct iovec;
 203struct kvec;
 204
 205enum {
 206        SOCK_WAKE_IO,
 207        SOCK_WAKE_WAITD,
 208        SOCK_WAKE_SPACE,
 209        SOCK_WAKE_URG,
 210};
 211
 212extern int           sock_wake_async(struct socket *sk, int how, int band);
 213extern int           sock_register(const struct net_proto_family *fam);
 214extern void          sock_unregister(int family);
 215extern int           sock_create(int family, int type, int proto,
 216                                 struct socket **res);
 217extern int           sock_create_kern(int family, int type, int proto,
 218                                      struct socket **res);
 219extern int           sock_create_lite(int family, int type, int proto,
 220                                      struct socket **res); 
 221extern void          sock_release(struct socket *sock);
 222extern int           sock_sendmsg(struct socket *sock, struct msghdr *msg,
 223                                  size_t len);
 224extern int           sock_recvmsg(struct socket *sock, struct msghdr *msg,
 225                                  size_t size, int flags);
 226extern int           sock_map_fd(struct socket *sock, int flags);
 227extern struct socket *sockfd_lookup(int fd, int *err);
 228#define              sockfd_put(sock) fput(sock->file)
 229extern int           net_ratelimit(void);
 230
 231#define net_random()            random32()
 232#define net_srandom(seed)       srandom32((__force u32)seed)
 233
 234extern int           kernel_sendmsg(struct socket *sock, struct msghdr *msg,
 235                                    struct kvec *vec, size_t num, size_t len);
 236extern int           kernel_recvmsg(struct socket *sock, struct msghdr *msg,
 237                                    struct kvec *vec, size_t num,
 238                                    size_t len, int flags);
 239
 240extern int kernel_bind(struct socket *sock, struct sockaddr *addr,
 241                       int addrlen);
 242extern int kernel_listen(struct socket *sock, int backlog);
 243extern int kernel_accept(struct socket *sock, struct socket **newsock,
 244                         int flags);
 245extern int kernel_connect(struct socket *sock, struct sockaddr *addr,
 246                          int addrlen, int flags);
 247extern int kernel_getsockname(struct socket *sock, struct sockaddr *addr,
 248                              int *addrlen);
 249extern int kernel_getpeername(struct socket *sock, struct sockaddr *addr,
 250                              int *addrlen);
 251extern int kernel_getsockopt(struct socket *sock, int level, int optname,
 252                             char *optval, int *optlen);
 253extern int kernel_setsockopt(struct socket *sock, int level, int optname,
 254                             char *optval, int optlen);
 255extern int kernel_sendpage(struct socket *sock, struct page *page, int offset,
 256                           size_t size, int flags);
 257extern int kernel_sock_ioctl(struct socket *sock, int cmd, unsigned long arg);
 258extern int kernel_sock_shutdown(struct socket *sock,
 259                                enum sock_shutdown_cmd how);
 260
 261#ifndef CONFIG_SMP
 262#define SOCKOPS_WRAPPED(name) name
 263#define SOCKOPS_WRAP(name, fam)
 264#else
 265
 266#define SOCKOPS_WRAPPED(name) __unlocked_##name
 267
 268#define SOCKCALL_WRAP(name, call, parms, args)          \
 269static int __lock_##name##_##call  parms                \
 270{                                                       \
 271        int ret;                                        \
 272        lock_kernel();                                  \
 273        ret = __unlocked_##name##_ops.call  args ;\
 274        unlock_kernel();                                \
 275        return ret;                                     \
 276}
 277
 278#define SOCKCALL_UWRAP(name, call, parms, args)         \
 279static unsigned int __lock_##name##_##call  parms       \
 280{                                                       \
 281        int ret;                                        \
 282        lock_kernel();                                  \
 283        ret = __unlocked_##name##_ops.call  args ;\
 284        unlock_kernel();                                \
 285        return ret;                                     \
 286}
 287
 288
 289#define SOCKOPS_WRAP(name, fam)                                 \
 290SOCKCALL_WRAP(name, release, (struct socket *sock), (sock))     \
 291SOCKCALL_WRAP(name, bind, (struct socket *sock, struct sockaddr *uaddr, int addr_len), \
 292              (sock, uaddr, addr_len))                          \
 293SOCKCALL_WRAP(name, connect, (struct socket *sock, struct sockaddr * uaddr, \
 294                              int addr_len, int flags),         \
 295              (sock, uaddr, addr_len, flags))                   \
 296SOCKCALL_WRAP(name, socketpair, (struct socket *sock1, struct socket *sock2), \
 297              (sock1, sock2))                                   \
 298SOCKCALL_WRAP(name, accept, (struct socket *sock, struct socket *newsock, \
 299                         int flags), (sock, newsock, flags)) \
 300SOCKCALL_WRAP(name, getname, (struct socket *sock, struct sockaddr *uaddr, \
 301                         int *addr_len, int peer), (sock, uaddr, addr_len, peer)) \
 302SOCKCALL_UWRAP(name, poll, (struct file *file, struct socket *sock, struct poll_table_struct *wait), \
 303              (file, sock, wait)) \
 304SOCKCALL_WRAP(name, ioctl, (struct socket *sock, unsigned int cmd, \
 305                         unsigned long arg), (sock, cmd, arg)) \
 306SOCKCALL_WRAP(name, compat_ioctl, (struct socket *sock, unsigned int cmd, \
 307                         unsigned long arg), (sock, cmd, arg)) \
 308SOCKCALL_WRAP(name, listen, (struct socket *sock, int len), (sock, len)) \
 309SOCKCALL_WRAP(name, shutdown, (struct socket *sock, int flags), (sock, flags)) \
 310SOCKCALL_WRAP(name, setsockopt, (struct socket *sock, int level, int optname, \
 311                         char __user *optval, int optlen), (sock, level, optname, optval, optlen)) \
 312SOCKCALL_WRAP(name, getsockopt, (struct socket *sock, int level, int optname, \
 313                         char __user *optval, int __user *optlen), (sock, level, optname, optval, optlen)) \
 314SOCKCALL_WRAP(name, sendmsg, (struct kiocb *iocb, struct socket *sock, struct msghdr *m, size_t len), \
 315              (iocb, sock, m, len)) \
 316SOCKCALL_WRAP(name, recvmsg, (struct kiocb *iocb, struct socket *sock, struct msghdr *m, size_t len, int flags), \
 317              (iocb, sock, m, len, flags)) \
 318SOCKCALL_WRAP(name, mmap, (struct file *file, struct socket *sock, struct vm_area_struct *vma), \
 319              (file, sock, vma)) \
 320              \
 321static const struct proto_ops name##_ops = {                    \
 322        .family         = fam,                          \
 323        .owner          = THIS_MODULE,                  \
 324        .release        = __lock_##name##_release,      \
 325        .bind           = __lock_##name##_bind,         \
 326        .connect        = __lock_##name##_connect,      \
 327        .socketpair     = __lock_##name##_socketpair,   \
 328        .accept         = __lock_##name##_accept,       \
 329        .getname        = __lock_##name##_getname,      \
 330        .poll           = __lock_##name##_poll,         \
 331        .ioctl          = __lock_##name##_ioctl,        \
 332        .compat_ioctl   = __lock_##name##_compat_ioctl, \
 333        .listen         = __lock_##name##_listen,       \
 334        .shutdown       = __lock_##name##_shutdown,     \
 335        .setsockopt     = __lock_##name##_setsockopt,   \
 336        .getsockopt     = __lock_##name##_getsockopt,   \
 337        .sendmsg        = __lock_##name##_sendmsg,      \
 338        .recvmsg        = __lock_##name##_recvmsg,      \
 339        .mmap           = __lock_##name##_mmap,         \
 340};
 341
 342#endif
 343
 344#define MODULE_ALIAS_NETPROTO(proto) \
 345        MODULE_ALIAS("net-pf-" __stringify(proto))
 346
 347#define MODULE_ALIAS_NET_PF_PROTO(pf, proto) \
 348        MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto))
 349
 350#define MODULE_ALIAS_NET_PF_PROTO_TYPE(pf, proto, type) \
 351        MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto) \
 352                     "-type-" __stringify(type))
 353
 354#ifdef CONFIG_SYSCTL
 355#include <linux/sysctl.h>
 356extern struct ratelimit_state net_ratelimit_state;
 357#endif
 358
 359#endif /* __KERNEL__ */
 360#endif  /* _LINUX_NET_H */
 361