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