printk: Remove ratelimit.h from kernel.h
[linux-2.6.git] / 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
45 typedef 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 #include <linux/kmemcheck.h>
61
62 struct poll_table_struct;
63 struct pipe_inode_info;
64 struct inode;
65 struct net;
66
67 #define SOCK_ASYNC_NOSPACE      0
68 #define SOCK_ASYNC_WAITDATA     1
69 #define SOCK_NOSPACE            2
70 #define SOCK_PASSCRED           3
71 #define SOCK_PASSSEC            4
72
73 #ifndef ARCH_HAS_SOCKET_TYPES
74 /**
75  * enum sock_type - Socket types
76  * @SOCK_STREAM: stream (connection) socket
77  * @SOCK_DGRAM: datagram (conn.less) socket
78  * @SOCK_RAW: raw socket
79  * @SOCK_RDM: reliably-delivered message
80  * @SOCK_SEQPACKET: sequential packet socket
81  * @SOCK_DCCP: Datagram Congestion Control Protocol socket
82  * @SOCK_PACKET: linux specific way of getting packets at the dev level.
83  *                For writing rarp and other similar things on the user level.
84  *
85  * When adding some new socket type please
86  * grep ARCH_HAS_SOCKET_TYPE include/asm-* /socket.h, at least MIPS
87  * overrides this enum for binary compat reasons.
88  */
89 enum sock_type {
90         SOCK_STREAM     = 1,
91         SOCK_DGRAM      = 2,
92         SOCK_RAW        = 3,
93         SOCK_RDM        = 4,
94         SOCK_SEQPACKET  = 5,
95         SOCK_DCCP       = 6,
96         SOCK_PACKET     = 10,
97 };
98
99 #define SOCK_MAX (SOCK_PACKET + 1)
100 /* Mask which covers at least up to SOCK_MASK-1.  The
101  * remaining bits are used as flags. */
102 #define SOCK_TYPE_MASK 0xf
103
104 /* Flags for socket, socketpair, accept4 */
105 #define SOCK_CLOEXEC    O_CLOEXEC
106 #ifndef SOCK_NONBLOCK
107 #define SOCK_NONBLOCK   O_NONBLOCK
108 #endif
109
110 #endif /* ARCH_HAS_SOCKET_TYPES */
111
112 enum sock_shutdown_cmd {
113         SHUT_RD         = 0,
114         SHUT_WR         = 1,
115         SHUT_RDWR       = 2,
116 };
117
118 /**
119  *  struct socket - general BSD socket
120  *  @state: socket state (%SS_CONNECTED, etc)
121  *  @type: socket type (%SOCK_STREAM, etc)
122  *  @flags: socket flags (%SOCK_ASYNC_NOSPACE, etc)
123  *  @ops: protocol specific socket operations
124  *  @fasync_list: Asynchronous wake up list
125  *  @file: File back pointer for gc
126  *  @sk: internal networking protocol agnostic socket representation
127  *  @wait: wait queue for several uses
128  */
129 struct socket {
130         socket_state            state;
131
132         kmemcheck_bitfield_begin(type);
133         short                   type;
134         kmemcheck_bitfield_end(type);
135
136         unsigned long           flags;
137         /*
138          * Please keep fasync_list & wait fields in the same cache line
139          */
140         struct fasync_struct    *fasync_list;
141         wait_queue_head_t       wait;
142
143         struct file             *file;
144         struct sock             *sk;
145         const struct proto_ops  *ops;
146 };
147
148 struct vm_area_struct;
149 struct page;
150 struct kiocb;
151 struct sockaddr;
152 struct msghdr;
153 struct module;
154
155 struct proto_ops {
156         int             family;
157         struct module   *owner;
158         int             (*release)   (struct socket *sock);
159         int             (*bind)      (struct socket *sock,
160                                       struct sockaddr *myaddr,
161                                       int sockaddr_len);
162         int             (*connect)   (struct socket *sock,
163                                       struct sockaddr *vaddr,
164                                       int sockaddr_len, int flags);
165         int             (*socketpair)(struct socket *sock1,
166                                       struct socket *sock2);
167         int             (*accept)    (struct socket *sock,
168                                       struct socket *newsock, int flags);
169         int             (*getname)   (struct socket *sock,
170                                       struct sockaddr *addr,
171                                       int *sockaddr_len, int peer);
172         unsigned int    (*poll)      (struct file *file, struct socket *sock,
173                                       struct poll_table_struct *wait);
174         int             (*ioctl)     (struct socket *sock, unsigned int cmd,
175                                       unsigned long arg);
176         int             (*compat_ioctl) (struct socket *sock, unsigned int cmd,
177                                       unsigned long arg);
178         int             (*listen)    (struct socket *sock, int len);
179         int             (*shutdown)  (struct socket *sock, int flags);
180         int             (*setsockopt)(struct socket *sock, int level,
181                                       int optname, char __user *optval, int optlen);
182         int             (*getsockopt)(struct socket *sock, int level,
183                                       int optname, char __user *optval, int __user *optlen);
184         int             (*compat_setsockopt)(struct socket *sock, int level,
185                                       int optname, char __user *optval, int optlen);
186         int             (*compat_getsockopt)(struct socket *sock, int level,
187                                       int optname, char __user *optval, int __user *optlen);
188         int             (*sendmsg)   (struct kiocb *iocb, struct socket *sock,
189                                       struct msghdr *m, size_t total_len);
190         int             (*recvmsg)   (struct kiocb *iocb, struct socket *sock,
191                                       struct msghdr *m, size_t total_len,
192                                       int flags);
193         int             (*mmap)      (struct file *file, struct socket *sock,
194                                       struct vm_area_struct * vma);
195         ssize_t         (*sendpage)  (struct socket *sock, struct page *page,
196                                       int offset, size_t size, int flags);
197         ssize_t         (*splice_read)(struct socket *sock,  loff_t *ppos,
198                                        struct pipe_inode_info *pipe, size_t len, unsigned int flags);
199 };
200
201 struct net_proto_family {
202         int             family;
203         int             (*create)(struct net *net, struct socket *sock, int protocol);
204         struct module   *owner;
205 };
206
207 struct iovec;
208 struct kvec;
209
210 enum {
211         SOCK_WAKE_IO,
212         SOCK_WAKE_WAITD,
213         SOCK_WAKE_SPACE,
214         SOCK_WAKE_URG,
215 };
216
217 extern int           sock_wake_async(struct socket *sk, int how, int band);
218 extern int           sock_register(const struct net_proto_family *fam);
219 extern void          sock_unregister(int family);
220 extern int           sock_create(int family, int type, int proto,
221                                  struct socket **res);
222 extern int           sock_create_kern(int family, int type, int proto,
223                                       struct socket **res);
224 extern int           sock_create_lite(int family, int type, int proto,
225                                       struct socket **res); 
226 extern void          sock_release(struct socket *sock);
227 extern int           sock_sendmsg(struct socket *sock, struct msghdr *msg,
228                                   size_t len);
229 extern int           sock_recvmsg(struct socket *sock, struct msghdr *msg,
230                                   size_t size, int flags);
231 extern int           sock_map_fd(struct socket *sock, int flags);
232 extern struct socket *sockfd_lookup(int fd, int *err);
233 #define              sockfd_put(sock) fput(sock->file)
234 extern int           net_ratelimit(void);
235
236 #define net_random()            random32()
237 #define net_srandom(seed)       srandom32((__force u32)seed)
238
239 extern int           kernel_sendmsg(struct socket *sock, struct msghdr *msg,
240                                     struct kvec *vec, size_t num, size_t len);
241 extern int           kernel_recvmsg(struct socket *sock, struct msghdr *msg,
242                                     struct kvec *vec, size_t num,
243                                     size_t len, int flags);
244
245 extern int kernel_bind(struct socket *sock, struct sockaddr *addr,
246                        int addrlen);
247 extern int kernel_listen(struct socket *sock, int backlog);
248 extern int kernel_accept(struct socket *sock, struct socket **newsock,
249                          int flags);
250 extern int kernel_connect(struct socket *sock, struct sockaddr *addr,
251                           int addrlen, int flags);
252 extern int kernel_getsockname(struct socket *sock, struct sockaddr *addr,
253                               int *addrlen);
254 extern int kernel_getpeername(struct socket *sock, struct sockaddr *addr,
255                               int *addrlen);
256 extern int kernel_getsockopt(struct socket *sock, int level, int optname,
257                              char *optval, int *optlen);
258 extern int kernel_setsockopt(struct socket *sock, int level, int optname,
259                              char *optval, int optlen);
260 extern int kernel_sendpage(struct socket *sock, struct page *page, int offset,
261                            size_t size, int flags);
262 extern int kernel_sock_ioctl(struct socket *sock, int cmd, unsigned long arg);
263 extern int kernel_sock_shutdown(struct socket *sock,
264                                 enum sock_shutdown_cmd how);
265
266 #ifndef CONFIG_SMP
267 #define SOCKOPS_WRAPPED(name) name
268 #define SOCKOPS_WRAP(name, fam)
269 #else
270
271 #define SOCKOPS_WRAPPED(name) __unlocked_##name
272
273 #define SOCKCALL_WRAP(name, call, parms, args)          \
274 static int __lock_##name##_##call  parms                \
275 {                                                       \
276         int ret;                                        \
277         lock_kernel();                                  \
278         ret = __unlocked_##name##_ops.call  args ;\
279         unlock_kernel();                                \
280         return ret;                                     \
281 }
282
283 #define SOCKCALL_UWRAP(name, call, parms, args)         \
284 static unsigned int __lock_##name##_##call  parms       \
285 {                                                       \
286         int ret;                                        \
287         lock_kernel();                                  \
288         ret = __unlocked_##name##_ops.call  args ;\
289         unlock_kernel();                                \
290         return ret;                                     \
291 }
292
293
294 #define SOCKOPS_WRAP(name, fam)                                 \
295 SOCKCALL_WRAP(name, release, (struct socket *sock), (sock))     \
296 SOCKCALL_WRAP(name, bind, (struct socket *sock, struct sockaddr *uaddr, int addr_len), \
297               (sock, uaddr, addr_len))                          \
298 SOCKCALL_WRAP(name, connect, (struct socket *sock, struct sockaddr * uaddr, \
299                               int addr_len, int flags),         \
300               (sock, uaddr, addr_len, flags))                   \
301 SOCKCALL_WRAP(name, socketpair, (struct socket *sock1, struct socket *sock2), \
302               (sock1, sock2))                                   \
303 SOCKCALL_WRAP(name, accept, (struct socket *sock, struct socket *newsock, \
304                          int flags), (sock, newsock, flags)) \
305 SOCKCALL_WRAP(name, getname, (struct socket *sock, struct sockaddr *uaddr, \
306                          int *addr_len, int peer), (sock, uaddr, addr_len, peer)) \
307 SOCKCALL_UWRAP(name, poll, (struct file *file, struct socket *sock, struct poll_table_struct *wait), \
308               (file, sock, wait)) \
309 SOCKCALL_WRAP(name, ioctl, (struct socket *sock, unsigned int cmd, \
310                          unsigned long arg), (sock, cmd, arg)) \
311 SOCKCALL_WRAP(name, compat_ioctl, (struct socket *sock, unsigned int cmd, \
312                          unsigned long arg), (sock, cmd, arg)) \
313 SOCKCALL_WRAP(name, listen, (struct socket *sock, int len), (sock, len)) \
314 SOCKCALL_WRAP(name, shutdown, (struct socket *sock, int flags), (sock, flags)) \
315 SOCKCALL_WRAP(name, setsockopt, (struct socket *sock, int level, int optname, \
316                          char __user *optval, int optlen), (sock, level, optname, optval, optlen)) \
317 SOCKCALL_WRAP(name, getsockopt, (struct socket *sock, int level, int optname, \
318                          char __user *optval, int __user *optlen), (sock, level, optname, optval, optlen)) \
319 SOCKCALL_WRAP(name, sendmsg, (struct kiocb *iocb, struct socket *sock, struct msghdr *m, size_t len), \
320               (iocb, sock, m, len)) \
321 SOCKCALL_WRAP(name, recvmsg, (struct kiocb *iocb, struct socket *sock, struct msghdr *m, size_t len, int flags), \
322               (iocb, sock, m, len, flags)) \
323 SOCKCALL_WRAP(name, mmap, (struct file *file, struct socket *sock, struct vm_area_struct *vma), \
324               (file, sock, vma)) \
325               \
326 static const struct proto_ops name##_ops = {                    \
327         .family         = fam,                          \
328         .owner          = THIS_MODULE,                  \
329         .release        = __lock_##name##_release,      \
330         .bind           = __lock_##name##_bind,         \
331         .connect        = __lock_##name##_connect,      \
332         .socketpair     = __lock_##name##_socketpair,   \
333         .accept         = __lock_##name##_accept,       \
334         .getname        = __lock_##name##_getname,      \
335         .poll           = __lock_##name##_poll,         \
336         .ioctl          = __lock_##name##_ioctl,        \
337         .compat_ioctl   = __lock_##name##_compat_ioctl, \
338         .listen         = __lock_##name##_listen,       \
339         .shutdown       = __lock_##name##_shutdown,     \
340         .setsockopt     = __lock_##name##_setsockopt,   \
341         .getsockopt     = __lock_##name##_getsockopt,   \
342         .sendmsg        = __lock_##name##_sendmsg,      \
343         .recvmsg        = __lock_##name##_recvmsg,      \
344         .mmap           = __lock_##name##_mmap,         \
345 };
346
347 #endif
348
349 #define MODULE_ALIAS_NETPROTO(proto) \
350         MODULE_ALIAS("net-pf-" __stringify(proto))
351
352 #define MODULE_ALIAS_NET_PF_PROTO(pf, proto) \
353         MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto))
354
355 #define MODULE_ALIAS_NET_PF_PROTO_TYPE(pf, proto, type) \
356         MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto) \
357                      "-type-" __stringify(type))
358
359 #ifdef CONFIG_SYSCTL
360 #include <linux/sysctl.h>
361 #include <linux/ratelimit.h>
362 extern struct ratelimit_state net_ratelimit_state;
363 #endif
364
365 #endif /* __KERNEL__ */
366 #endif  /* _LINUX_NET_H */