LXR linux-bk/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, <bir7@leland.Stanford.Edu>
  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/config.h>
  22#include <linux/wait.h>
  23#include <linux/stringify.h>
  24#include <asm/socket.h>
  25
  26struct poll_table_struct;
  27struct inode;
  28
  29#define NPROTO          32              /* should be enough for now..   */
  30
  31#define SYS_SOCKET      1               /* sys_socket(2)                */
  32#define SYS_BIND        2               /* sys_bind(2)                  */
  33#define SYS_CONNECT     3               /* sys_connect(2)               */
  34#define SYS_LISTEN      4               /* sys_listen(2)                */
  35#define SYS_ACCEPT      5               /* sys_accept(2)                */
  36#define SYS_GETSOCKNAME 6               /* sys_getsockname(2)           */
  37#define SYS_GETPEERNAME 7               /* sys_getpeername(2)           */
  38#define SYS_SOCKETPAIR  8               /* sys_socketpair(2)            */
  39#define SYS_SEND        9               /* sys_send(2)                  */
  40#define SYS_RECV        10              /* sys_recv(2)                  */
  41#define SYS_SENDTO      11              /* sys_sendto(2)                */
  42#define SYS_RECVFROM    12              /* sys_recvfrom(2)              */
  43#define SYS_SHUTDOWN    13              /* sys_shutdown(2)              */
  44#define SYS_SETSOCKOPT  14              /* sys_setsockopt(2)            */
  45#define SYS_GETSOCKOPT  15              /* sys_getsockopt(2)            */
  46#define SYS_SENDMSG     16              /* sys_sendmsg(2)               */
  47#define SYS_RECVMSG     17              /* sys_recvmsg(2)               */
  48
  49typedef enum {
  50        SS_FREE = 0,                    /* not allocated                */
  51        SS_UNCONNECTED,                 /* unconnected to any socket    */
  52        SS_CONNECTING,                  /* in process of connecting     */
  53        SS_CONNECTED,                   /* connected to socket          */
  54        SS_DISCONNECTING                /* in process of disconnecting  */
  55} socket_state;
  56
  57#define __SO_ACCEPTCON  (1 << 16)       /* performed a listen           */
  58
  59#ifdef __KERNEL__
  60
  61#define SOCK_ASYNC_NOSPACE      0
  62#define SOCK_ASYNC_WAITDATA     1
  63#define SOCK_NOSPACE            2
  64
  65#ifndef ARCH_HAS_SOCKET_TYPES
  66/** sock_type - Socket types
  67 * 
  68 * When adding some new socket type please
  69 * grep ARCH_HAS_SOCKET_TYPE include/asm-* /socket.h, at least MIPS
  70 * overrides this enum for binary compat reasons.
  71 * 
  72 * @SOCK_STREAM - stream (connection) socket
  73 * @SOCK_DGRAM - datagram (conn.less) socket
  74 * @SOCK_RAW - raw socket
  75 * @SOCK_RDM - reliably-delivered message
  76 * @SOCK_SEQPACKET - sequential packet socket 
  77 * @SOCK_PACKET - linux specific way of getting packets at the dev level.
  78 *                For writing rarp and other similar things on the user level.
  79 */
  80enum sock_type {
  81        SOCK_STREAM     = 1,
  82        SOCK_DGRAM      = 2,
  83        SOCK_RAW        = 3,
  84        SOCK_RDM        = 4,
  85        SOCK_SEQPACKET  = 5,
  86        SOCK_PACKET     = 10,
  87};
  88
  89#define SOCK_MAX (SOCK_PACKET + 1)
  90
  91#endif /* ARCH_HAS_SOCKET_TYPES */
  92
  93/**
  94 *  struct socket - general BSD socket
  95 *  @state - socket state (%SS_CONNECTED, etc)
  96 *  @flags - socket flags (%SOCK_ASYNC_NOSPACE, etc)
  97 *  @ops - protocol specific socket operations
  98 *  @fasync_list - Asynchronous wake up list
  99 *  @file - File back pointer for gc
 100 *  @sk - internal networking protocol agnostic socket representation
 101 *  @wait - wait queue for several uses
 102 *  @type - socket type (%SOCK_STREAM, etc)
 103 *  @passcred - credentials (used only in Unix Sockets (aka PF_LOCAL))
 104 */
 105struct socket {
 106        socket_state            state;
 107        unsigned long           flags;
 108        struct proto_ops        *ops;
 109        struct fasync_struct    *fasync_list;
 110        struct file             *file;
 111        struct sock             *sk;
 112        wait_queue_head_t       wait;
 113        short                   type;
 114        unsigned char           passcred;
 115};
 116
 117struct vm_area_struct;
 118struct page;
 119struct kiocb;
 120struct sockaddr;
 121struct msghdr;
 122struct module;
 123
 124struct proto_ops {
 125        int             family;
 126        struct module   *owner;
 127        int             (*release)   (struct socket *sock);
 128        int             (*bind)      (struct socket *sock,
 129                                      struct sockaddr *myaddr,
 130                                      int sockaddr_len);
 131        int             (*connect)   (struct socket *sock,
 132                                      struct sockaddr *vaddr,
 133                                      int sockaddr_len, int flags);
 134        int             (*socketpair)(struct socket *sock1,
 135                                      struct socket *sock2);
 136        int             (*accept)    (struct socket *sock,
 137                                      struct socket *newsock, int flags);
 138        int             (*getname)   (struct socket *sock,
 139                                      struct sockaddr *addr,
 140                                      int *sockaddr_len, int peer);
 141        unsigned int    (*poll)      (struct file *file, struct socket *sock,
 142                                      struct poll_table_struct *wait);
 143        int             (*ioctl)     (struct socket *sock, unsigned int cmd,
 144                                      unsigned long arg);
 145        int             (*listen)    (struct socket *sock, int len);
 146        int             (*shutdown)  (struct socket *sock, int flags);
 147        int             (*setsockopt)(struct socket *sock, int level,
 148                                      int optname, char __user *optval, int optlen);
 149        int             (*getsockopt)(struct socket *sock, int level,
 150                                      int optname, char __user *optval, int __user *optlen);
 151        int             (*sendmsg)   (struct kiocb *iocb, struct socket *sock,
 152                                      struct msghdr *m, size_t total_len);
 153        int             (*recvmsg)   (struct kiocb *iocb, struct socket *sock,
 154                                      struct msghdr *m, size_t total_len,
 155                                      int flags);
 156        int             (*mmap)      (struct file *file, struct socket *sock,
 157                                      struct vm_area_struct * vma);
 158        ssize_t         (*sendpage)  (struct socket *sock, struct page *page,
 159                                      int offset, size_t size, int flags);
 160};
 161
 162struct net_proto_family {
 163        int             family;
 164        int             (*create)(struct socket *sock, int protocol);
 165        /* These are counters for the number of different methods of
 166           each we support */
 167        short           authentication;
 168        short           encryption;
 169        short           encrypt_net;
 170        struct module   *owner;
 171};
 172
 173struct iovec;
 174struct kvec;
 175
 176extern int           sock_wake_async(struct socket *sk, int how, int band);
 177extern int           sock_register(struct net_proto_family *fam);
 178extern int           sock_unregister(int family);
 179extern int           sock_create(int family, int type, int proto,
 180                                 struct socket **res);
 181extern int           sock_create_kern(int family, int type, int proto,
 182                                      struct socket **res);
 183extern int           sock_create_lite(int family, int type, int proto,
 184                                      struct socket **res); 
 185extern void          sock_release(struct socket *sock);
 186extern int           sock_sendmsg(struct socket *sock, struct msghdr *msg,
 187                                  size_t len);
 188extern int           sock_recvmsg(struct socket *sock, struct msghdr *msg,
 189                                  size_t size, int flags);
 190extern int           sock_readv_writev(int type, struct inode *inode,
 191                                       struct file *file,
 192                                       const struct iovec *iov, long count,
 193                                       size_t size);
 194extern int           sock_map_fd(struct socket *sock);
 195extern struct socket *sockfd_lookup(int fd, int *err);
 196#define              sockfd_put(sock) fput(sock->file)
 197extern int           net_ratelimit(void);
 198extern unsigned long net_random(void);
 199extern void          net_srandom(unsigned long);
 200extern void          net_random_init(void);
 201
 202extern int           kernel_sendmsg(struct socket *sock, struct msghdr *msg,
 203                                    struct kvec *vec, size_t num, size_t len);
 204extern int           kernel_recvmsg(struct socket *sock, struct msghdr *msg,
 205                                    struct kvec *vec, size_t num,
 206                                    size_t len, int flags);
 207
 208#ifndef CONFIG_SMP
 209#define SOCKOPS_WRAPPED(name) name
 210#define SOCKOPS_WRAP(name, fam)
 211#else
 212
 213#define SOCKOPS_WRAPPED(name) __unlocked_##name
 214
 215#define SOCKCALL_WRAP(name, call, parms, args)          \
 216static int __lock_##name##_##call  parms                \
 217{                                                       \
 218        int ret;                                        \
 219        lock_kernel();                                  \
 220        ret = __unlocked_##name##_ops.call  args ;\
 221        unlock_kernel();                                \
 222        return ret;                                     \
 223}
 224
 225#define SOCKCALL_UWRAP(name, call, parms, args)         \
 226static unsigned int __lock_##name##_##call  parms       \
 227{                                                       \
 228        int ret;                                        \
 229        lock_kernel();                                  \
 230        ret = __unlocked_##name##_ops.call  args ;\
 231        unlock_kernel();                                \
 232        return ret;                                     \
 233}
 234
 235
 236#define SOCKOPS_WRAP(name, fam)                                 \
 237SOCKCALL_WRAP(name, release, (struct socket *sock), (sock))     \
 238SOCKCALL_WRAP(name, bind, (struct socket *sock, struct sockaddr *uaddr, int addr_len), \
 239              (sock, uaddr, addr_len))                          \
 240SOCKCALL_WRAP(name, connect, (struct socket *sock, struct sockaddr * uaddr, \
 241                              int addr_len, int flags),         \
 242              (sock, uaddr, addr_len, flags))                   \
 243SOCKCALL_WRAP(name, socketpair, (struct socket *sock1, struct socket *sock2), \
 244              (sock1, sock2))                                   \
 245SOCKCALL_WRAP(name, accept, (struct socket *sock, struct socket *newsock, \
 246                         int flags), (sock, newsock, flags)) \
 247SOCKCALL_WRAP(name, getname, (struct socket *sock, struct sockaddr *uaddr, \
 248                         int *addr_len, int peer), (sock, uaddr, addr_len, peer)) \
 249SOCKCALL_UWRAP(name, poll, (struct file *file, struct socket *sock, struct poll_table_struct *wait), \
 250              (file, sock, wait)) \
 251SOCKCALL_WRAP(name, ioctl, (struct socket *sock, unsigned int cmd, \
 252                         unsigned long arg), (sock, cmd, arg)) \
 253SOCKCALL_WRAP(name, listen, (struct socket *sock, int len), (sock, len)) \
 254SOCKCALL_WRAP(name, shutdown, (struct socket *sock, int flags), (sock, flags)) \
 255SOCKCALL_WRAP(name, setsockopt, (struct socket *sock, int level, int optname, \
 256                         char __user *optval, int optlen), (sock, level, optname, optval, optlen)) \
 257SOCKCALL_WRAP(name, getsockopt, (struct socket *sock, int level, int optname, \
 258                         char __user *optval, int __user *optlen), (sock, level, optname, optval, optlen)) \
 259SOCKCALL_WRAP(name, sendmsg, (struct kiocb *iocb, struct socket *sock, struct msghdr *m, size_t len), \
 260              (iocb, sock, m, len)) \
 261SOCKCALL_WRAP(name, recvmsg, (struct kiocb *iocb, struct socket *sock, struct msghdr *m, size_t len, int flags), \
 262              (iocb, sock, m, len, flags)) \
 263SOCKCALL_WRAP(name, mmap, (struct file *file, struct socket *sock, struct vm_area_struct *vma), \
 264              (file, sock, vma)) \
 265              \
 266static struct proto_ops name##_ops = {                  \
 267        .family         = fam,                          \
 268        .owner          = THIS_MODULE,                  \
 269        .release        = __lock_##name##_release,      \
 270        .bind           = __lock_##name##_bind,         \
 271        .connect        = __lock_##name##_connect,      \
 272        .socketpair     = __lock_##name##_socketpair,   \
 273        .accept         = __lock_##name##_accept,       \
 274        .getname        = __lock_##name##_getname,      \
 275        .poll           = __lock_##name##_poll,         \
 276        .ioctl          = __lock_##name##_ioctl,        \
 277        .listen         = __lock_##name##_listen,       \
 278        .shutdown       = __lock_##name##_shutdown,     \
 279        .setsockopt     = __lock_##name##_setsockopt,   \
 280        .getsockopt     = __lock_##name##_getsockopt,   \
 281        .sendmsg        = __lock_##name##_sendmsg,      \
 282        .recvmsg        = __lock_##name##_recvmsg,      \
 283        .mmap           = __lock_##name##_mmap,         \
 284};
 285#endif
 286
 287#define MODULE_ALIAS_NETPROTO(proto) \
 288        MODULE_ALIAS("net-pf-" __stringify(proto))
 289
 290#endif /* __KERNEL__ */
 291#endif  /* _LINUX_NET_H */
 292