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