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