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