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#define SYS_RECVMMSG    19              /* sys_recvmmsg(2)              */
  45
  46typedef enum {
  47        SS_FREE = 0,                    /* not allocated                */
  48        SS_UNCONNECTED,                 /* unconnected to any socket    */
  49        SS_CONNECTING,                  /* in process of connecting     */
  50        SS_CONNECTED,                   /* connected to socket          */
  51        SS_DISCONNECTING                /* in process of disconnecting  */
  52} socket_state;
  53
  54#define __SO_ACCEPTCON  (1 << 16)       /* performed a listen           */
  55
  56#ifdef __KERNEL__
  57#include <linux/stringify.h>
  58#include <linux/random.h>
  59#include <linux/wait.h>
  60#include <linux/fcntl.h>        /* For O_CLOEXEC and O_NONBLOCK */
  61#include <linux/kmemcheck.h>
  62
  63struct poll_table_struct;
  64struct pipe_inode_info;
  65struct inode;
  66struct net;
  67
  68#define SOCK_ASYNC_NOSPACE      0
  69#define SOCK_ASYNC_WAITDATA     1
  70#define SOCK_NOSPACE            2
  71#define SOCK_PASSCRED           3
  72#define SOCK_PASSSEC            4
  73
  74#ifndef ARCH_HAS_SOCKET_TYPES
  75/**
  76 * enum sock_type - Socket types
  77 * @SOCK_STREAM: stream (connection) socket
  78 * @SOCK_DGRAM: datagram (conn.less) socket
  79 * @SOCK_RAW: raw socket
  80 * @SOCK_RDM: reliably-delivered message
  81 * @SOCK_SEQPACKET: sequential packet socket
  82 * @SOCK_DCCP: Datagram Congestion Control Protocol socket
  83 * @SOCK_PACKET: linux specific way of getting packets at the dev level.
  84 *                For writing rarp and other similar things on the user level.
  85 *
  86 * When adding some new socket type please
  87 * grep ARCH_HAS_SOCKET_TYPE include/asm-* /socket.h, at least MIPS
  88 * overrides this enum for binary compat reasons.
  89 */
  90enum sock_type {
  91        SOCK_STREAM     = 1,
  92        SOCK_DGRAM      = 2,
  93        SOCK_RAW        = 3,
  94        SOCK_RDM        = 4,
  95        SOCK_SEQPACKET  = 5,
  96        SOCK_DCCP       = 6,
  97        SOCK_PACKET     = 10,
  98};
  99
 100#define SOCK_MAX (SOCK_PACKET + 1)
 101/* Mask which covers at least up to SOCK_MASK-1.  The
 102 * remaining bits are used as flags. */
 103#define SOCK_TYPE_MASK 0xf
 104
 105/* Flags for socket, socketpair, accept4 */
 106#define SOCK_CLOEXEC    O_CLOEXEC
 107#ifndef SOCK_NONBLOCK
 108#define SOCK_NONBLOCK   O_NONBLOCK
 109#endif
 110
 111#endif /* ARCH_HAS_SOCKET_TYPES */
 112
 113enum sock_shutdown_cmd {
 114        SHUT_RD         = 0,
 115        SHUT_WR         = 1,
 116        SHUT_RDWR       = 2,
 117};
 118
 119/**
 120 *  struct socket - general BSD socket
 121 *  @state: socket state (%SS_CONNECTED, etc)
 122 *  @type: socket type (%SOCK_STREAM, etc)
 123 *  @flags: socket flags (%SOCK_ASYNC_NOSPACE, etc)
 124 *  @ops: protocol specific socket operations
 125 *  @fasync_list: Asynchronous wake up list
 126 *  @file: File back pointer for gc
 127 *  @sk: internal networking protocol agnostic socket representation
 128 *  @wait: wait queue for several uses
 129 */
 130struct socket {
 131        socket_state            state;
 132
 133        kmemcheck_bitfield_begin(type);
 134        short                   type;
 135        kmemcheck_bitfield_end(type);
 136
 137        unsigned long           flags;
 138        /*
 139         * Please keep fasync_list & wait fields in the same cache line
 140         */
 141        struct fasync_struct    *fasync_list;
 142        wait_queue_head_t       wait;
 143
 144        struct file             *file;
 145        struct sock             *sk;
 146        const struct proto_ops  *ops;
 147};
 148
 149struct vm_area_struct;
 150struct page;
 151struct kiocb;
 152struct sockaddr;
 153struct msghdr;
 154struct module;
 155
 156struct proto_ops {
 157        int             family;
 158        struct module   *owner;
 159        int             (*release)   (struct socket *sock);
 160        int             (*bind)      (struct socket *sock,
 161                                      struct sockaddr *myaddr,
 162                                      int sockaddr_len);
 163        int             (*connect)   (struct socket *sock,
 164                                      struct sockaddr *vaddr,
 165                                      int sockaddr_len, int flags);
 166        int             (*socketpair)(struct socket *sock1,
 167                                      struct socket *sock2);
 168        int             (*accept)    (struct socket *sock,
 169                                      struct socket *newsock, int flags);
 170        int             (*getname)   (struct socket *sock,
 171                                      struct sockaddr *addr,
 172                                      int *sockaddr_len, int peer);
 173        unsigned int    (*poll)      (struct file *file, struct socket *sock,
 174                                      struct poll_table_struct *wait);
 175        int             (*ioctl)     (struct socket *sock, unsigned int cmd,
 176                                      unsigned long arg);
 177        int             (*compat_ioctl) (struct socket *sock, unsigned int cmd,
 178                                      unsigned long arg);
 179        int             (*listen)    (struct socket *sock, int len);
 180        int             (*shutdown)  (struct socket *sock, int flags);
 181        int             (*setsockopt)(struct socket *sock, int level,
 182                                      int optname, char __user *optval, unsigned int optlen);
 183        int             (*getsockopt)(struct socket *sock, int level,
 184                                      int optname, char __user *optval, int __user *optlen);
 185        int             (*compat_setsockopt)(struct socket *sock, int level,
 186                                      int optname, char __user *optval, unsigned int optlen);
 187        int             (*compat_getsockopt)(struct socket *sock, int level,
 188                                      int optname, char __user *optval, int __user *optlen);
 189        int             (*sendmsg)   (struct kiocb *iocb, struct socket *sock,
 190                                      struct msghdr *m, size_t total_len);
 191        int             (*recvmsg)   (struct kiocb *iocb, struct socket *sock,
 192                                      struct msghdr *m, size_t total_len,
 193                                      int flags);
 194        int             (*mmap)      (struct file *file, struct socket *sock,
 195                                      struct vm_area_struct * vma);
 196        ssize_t         (*sendpage)  (struct socket *sock, struct page *page,
 197                                      int offset, size_t size, int flags);
 198        ssize_t         (*splice_read)(struct socket *sock,  loff_t *ppos,
 199                                       struct pipe_inode_info *pipe, size_t len, unsigned int flags);
 200};
 201
 202#define DECLARE_SOCKADDR(type, dst, src)        \
 203        type dst = ({ __sockaddr_check_size(sizeof(*dst)); (type) src; })
 204
 205struct net_proto_family {
 206        int             family;
 207        int             (*create)(struct net *net, struct socket *sock,
 208                                  int protocol, int kern);
 209        struct module   *owner;
 210};
 211
 212struct iovec;
 213struct kvec;
 214
 215enum {
 216        SOCK_WAKE_IO,
 217        SOCK_WAKE_WAITD,
 218        SOCK_WAKE_SPACE,
 219        SOCK_WAKE_URG,
 220};
 221
 222extern int           sock_wake_async(struct socket *sk, int how, int band);
 223extern int           sock_register(const struct net_proto_family *fam);
 224extern void          sock_unregister(int family);
 225extern int           sock_create(int family, int type, int proto,
 226                                 struct socket **res);
 227extern int           sock_create_kern(int family, int type, int proto,
 228                                      struct socket **res);
 229extern int           sock_create_lite(int family, int type, int proto,
 230                                      struct socket **res); 
 231extern void          sock_release(struct socket *sock);
 232extern int           sock_sendmsg(struct socket *sock, struct msghdr *msg,
 233                                  size_t len);
 234extern int           sock_recvmsg(struct socket *sock, struct msghdr *msg,
 235                                  size_t size, int flags);
 236extern int           sock_map_fd(struct socket *sock, int flags);
 237extern struct socket *sockfd_lookup(int fd, int *err);
 238#define              sockfd_put(sock) fput(sock->file)
 239extern int           net_ratelimit(void);
 240
 241#define net_random()            random32()
 242#define net_srandom(seed)       srandom32((__force u32)seed)
 243
 244extern int           kernel_sendmsg(struct socket *sock, struct msghdr *msg,
 245                                    struct kvec *vec, size_t num, size_t len);
 246extern int           kernel_recvmsg(struct socket *sock, struct msghdr *msg,
 247                                    struct kvec *vec, size_t num,
 248                                    size_t len, int flags);
 249
 250extern int kernel_bind(struct socket *sock, struct sockaddr *addr,
 251                       int addrlen);
 252extern int kernel_listen(struct socket *sock, int backlog);
 253extern int kernel_accept(struct socket *sock, struct socket **newsock,
 254                         int flags);
 255extern int kernel_connect(struct socket *sock, struct sockaddr *addr,
 256                          int addrlen, int flags);
 257extern int kernel_getsockname(struct socket *sock, struct sockaddr *addr,
 258                              int *addrlen);
 259extern int kernel_getpeername(struct socket *sock, struct sockaddr *addr,
 260                              int *addrlen);
 261extern int kernel_getsockopt(struct socket *sock, int level, int optname,
 262                             char *optval, int *optlen);
 263extern int kernel_setsockopt(struct socket *sock, int level, int optname,
 264                             char *optval, unsigned int optlen);
 265extern int kernel_sendpage(struct socket *sock, struct page *page, int offset,
 266                           size_t size, int flags);
 267extern int kernel_sock_ioctl(struct socket *sock, int cmd, unsigned long arg);
 268extern int kernel_sock_shutdown(struct socket *sock,
 269                                enum sock_shutdown_cmd how);
 270
 271#define MODULE_ALIAS_NETPROTO(proto) \
 272        MODULE_ALIAS("net-pf-" __stringify(proto))
 273
 274#define MODULE_ALIAS_NET_PF_PROTO(pf, proto) \
 275        MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto))
 276
 277#define MODULE_ALIAS_NET_PF_PROTO_TYPE(pf, proto, type) \
 278        MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto) \
 279                     "-type-" __stringify(type))
 280
 281#ifdef CONFIG_SYSCTL
 282#include <linux/sysctl.h>
 283#include <linux/ratelimit.h>
 284extern struct ratelimit_state net_ratelimit_state;
 285#endif
 286
 287#endif /* __KERNEL__ */
 288#endif  /* _LINUX_NET_H */
 289