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