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