blob: 529a0931711da5875cc70e88953dbe9621afd5d3 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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>
Jesper Juhl02c30a82005-05-05 16:16:16 -070010 * Ross Biro
Linus Torvalds1da177e2005-04-16 15:20:36 -070011 * 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
Rusty Russell0098b722008-03-22 17:18:47 -070021#include <linux/socket.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <asm/socket.h>
23
Rusty Russell0098b722008-03-22 17:18:47 -070024#define NPROTO AF_MAX
Linus Torvalds1da177e2005-04-16 15:20:36 -070025
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) */
Ulrich Drepperde11def2008-11-19 15:36:14 -080043#define SYS_ACCEPT4 18 /* sys_accept4(2) */
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
45typedef 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__
David Woodhouseeacf17b2006-04-25 14:46:09 +010056#include <linux/stringify.h>
David Woodhousecb4db4c2006-12-28 21:21:55 -080057#include <linux/random.h>
David Woodhouse5770a3f2008-08-26 15:29:22 +010058#include <linux/wait.h>
59#include <linux/fcntl.h> /* For O_CLOEXEC and O_NONBLOCK */
Eric Dumazet29a020d2009-09-15 02:39:20 -070060#include <linux/kmemcheck.h>
David Woodhouse5770a3f2008-08-26 15:29:22 +010061
62struct poll_table_struct;
63struct pipe_inode_info;
64struct inode;
65struct net;
Linus Torvalds1da177e2005-04-16 15:20:36 -070066
67#define SOCK_ASYNC_NOSPACE 0
68#define SOCK_ASYNC_WAITDATA 1
69#define SOCK_NOSPACE 2
70#define SOCK_PASSCRED 3
Catherine Zhang877ce7c2006-06-29 12:27:47 -070071#define SOCK_PASSSEC 4
Linus Torvalds1da177e2005-04-16 15:20:36 -070072
73#ifndef ARCH_HAS_SOCKET_TYPES
Pavel Pisa4dc3b162005-05-01 08:59:25 -070074/**
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
Randy Dunlap8f2709b2005-11-07 01:01:05 -080081 * @SOCK_DCCP: Datagram Congestion Control Protocol socket
Pavel Pisa4dc3b162005-05-01 08:59:25 -070082 * @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 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070085 * 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -070088 */
89enum sock_type {
90 SOCK_STREAM = 1,
91 SOCK_DGRAM = 2,
92 SOCK_RAW = 3,
93 SOCK_RDM = 4,
94 SOCK_SEQPACKET = 5,
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -070095 SOCK_DCCP = 6,
Linus Torvalds1da177e2005-04-16 15:20:36 -070096 SOCK_PACKET = 10,
97};
98
99#define SOCK_MAX (SOCK_PACKET + 1)
Ulrich Dreppera677a032008-07-23 21:29:17 -0700100/* 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
Ulrich Drepperde11def2008-11-19 15:36:14 -0800104/* Flags for socket, socketpair, accept4 */
Ulrich Dreppera677a032008-07-23 21:29:17 -0700105#define SOCK_CLOEXEC O_CLOEXEC
Ulrich Drepperc019bbc2008-07-23 21:29:21 -0700106#ifndef SOCK_NONBLOCK
107#define SOCK_NONBLOCK O_NONBLOCK
108#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109
110#endif /* ARCH_HAS_SOCKET_TYPES */
111
Trond Myklebust91cf45f2007-11-12 18:10:39 -0800112enum sock_shutdown_cmd {
113 SHUT_RD = 0,
114 SHUT_WR = 1,
115 SHUT_RDWR = 2,
116};
117
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118/**
119 * struct socket - general BSD socket
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700120 * @state: socket state (%SS_CONNECTED, etc)
Richard Kennedy2c693612008-07-08 03:03:01 -0700121 * @type: socket type (%SOCK_STREAM, etc)
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700122 * @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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128 */
129struct socket {
130 socket_state state;
Eric Dumazet29a020d2009-09-15 02:39:20 -0700131
132 kmemcheck_bitfield_begin(type);
Richard Kennedy2c693612008-07-08 03:03:01 -0700133 short type;
Eric Dumazet29a020d2009-09-15 02:39:20 -0700134 kmemcheck_bitfield_end(type);
135
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 unsigned long flags;
Eric Dumazet8bdd6632009-03-15 19:59:13 -0700137 /*
138 * Please keep fasync_list & wait fields in the same cache line
139 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 struct fasync_struct *fasync_list;
Eric Dumazet8bdd6632009-03-15 19:59:13 -0700141 wait_queue_head_t wait;
142
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143 struct file *file;
144 struct sock *sk;
Eric Dumazet8bdd6632009-03-15 19:59:13 -0700145 const struct proto_ops *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146};
147
148struct vm_area_struct;
149struct page;
150struct kiocb;
151struct sockaddr;
152struct msghdr;
153struct module;
154
155struct 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);
Shaun Pereira89bbfc92006-03-21 23:58:08 -0800176 int (*compat_ioctl) (struct socket *sock, unsigned int cmd,
177 unsigned long arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178 int (*listen) (struct socket *sock, int len);
179 int (*shutdown) (struct socket *sock, int flags);
180 int (*setsockopt)(struct socket *sock, int level,
David S. Millerb7058842009-09-30 16:12:20 -0700181 int optname, char __user *optval, unsigned int optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182 int (*getsockopt)(struct socket *sock, int level,
183 int optname, char __user *optval, int __user *optlen);
Dmitry Mishin3fdadf72006-03-20 22:45:21 -0800184 int (*compat_setsockopt)(struct socket *sock, int level,
David S. Millerb7058842009-09-30 16:12:20 -0700185 int optname, char __user *optval, unsigned int optlen);
Dmitry Mishin3fdadf72006-03-20 22:45:21 -0800186 int (*compat_getsockopt)(struct socket *sock, int level,
187 int optname, char __user *optval, int __user *optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188 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);
Jens Axboe9c55e012007-11-06 23:30:13 -0800197 ssize_t (*splice_read)(struct socket *sock, loff_t *ppos,
198 struct pipe_inode_info *pipe, size_t len, unsigned int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199};
200
201struct net_proto_family {
202 int family;
Eric W. Biederman1b8d7ae2007-10-08 23:24:22 -0700203 int (*create)(struct net *net, struct socket *sock, int protocol);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204 struct module *owner;
205};
206
207struct iovec;
208struct kvec;
209
Pavel Emelyanov8d8ad9d2007-11-26 20:10:50 +0800210enum {
211 SOCK_WAKE_IO,
212 SOCK_WAKE_WAITD,
213 SOCK_WAKE_SPACE,
214 SOCK_WAKE_URG,
215};
216
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217extern int sock_wake_async(struct socket *sk, int how, int band);
Stephen Hemmingerf0fd27d2006-08-09 21:03:17 -0700218extern int sock_register(const struct net_proto_family *fam);
219extern void sock_unregister(int family);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220extern int sock_create(int family, int type, int proto,
221 struct socket **res);
222extern int sock_create_kern(int family, int type, int proto,
223 struct socket **res);
224extern int sock_create_lite(int family, int type, int proto,
225 struct socket **res);
226extern void sock_release(struct socket *sock);
227extern int sock_sendmsg(struct socket *sock, struct msghdr *msg,
228 size_t len);
229extern int sock_recvmsg(struct socket *sock, struct msghdr *msg,
230 size_t size, int flags);
Ulrich Dreppera677a032008-07-23 21:29:17 -0700231extern int sock_map_fd(struct socket *sock, int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232extern struct socket *sockfd_lookup(int fd, int *err);
233#define sockfd_put(sock) fput(sock->file)
234extern int net_ratelimit(void);
Stephen Hemmingeraaa248f2006-10-17 00:09:42 -0700235
236#define net_random() random32()
Al Viroa64b78a2006-11-14 21:12:29 -0800237#define net_srandom(seed) srandom32((__force u32)seed)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238
239extern int kernel_sendmsg(struct socket *sock, struct msghdr *msg,
240 struct kvec *vec, size_t num, size_t len);
241extern int kernel_recvmsg(struct socket *sock, struct msghdr *msg,
242 struct kvec *vec, size_t num,
243 size_t len, int flags);
244
Sridhar Samudralaac5a4882006-08-07 20:57:31 -0700245extern int kernel_bind(struct socket *sock, struct sockaddr *addr,
246 int addrlen);
247extern int kernel_listen(struct socket *sock, int backlog);
248extern int kernel_accept(struct socket *sock, struct socket **newsock,
249 int flags);
250extern int kernel_connect(struct socket *sock, struct sockaddr *addr,
251 int addrlen, int flags);
252extern int kernel_getsockname(struct socket *sock, struct sockaddr *addr,
253 int *addrlen);
254extern int kernel_getpeername(struct socket *sock, struct sockaddr *addr,
255 int *addrlen);
256extern int kernel_getsockopt(struct socket *sock, int level, int optname,
257 char *optval, int *optlen);
258extern int kernel_setsockopt(struct socket *sock, int level, int optname,
David S. Millerb7058842009-09-30 16:12:20 -0700259 char *optval, unsigned int optlen);
Sridhar Samudralaac5a4882006-08-07 20:57:31 -0700260extern int kernel_sendpage(struct socket *sock, struct page *page, int offset,
261 size_t size, int flags);
262extern int kernel_sock_ioctl(struct socket *sock, int cmd, unsigned long arg);
Trond Myklebust91cf45f2007-11-12 18:10:39 -0800263extern int kernel_sock_shutdown(struct socket *sock,
264 enum sock_shutdown_cmd how);
Sridhar Samudralaac5a4882006-08-07 20:57:31 -0700265
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266#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) \
274static 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) \
284static 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) \
295SOCKCALL_WRAP(name, release, (struct socket *sock), (sock)) \
296SOCKCALL_WRAP(name, bind, (struct socket *sock, struct sockaddr *uaddr, int addr_len), \
297 (sock, uaddr, addr_len)) \
298SOCKCALL_WRAP(name, connect, (struct socket *sock, struct sockaddr * uaddr, \
299 int addr_len, int flags), \
300 (sock, uaddr, addr_len, flags)) \
301SOCKCALL_WRAP(name, socketpair, (struct socket *sock1, struct socket *sock2), \
302 (sock1, sock2)) \
303SOCKCALL_WRAP(name, accept, (struct socket *sock, struct socket *newsock, \
304 int flags), (sock, newsock, flags)) \
305SOCKCALL_WRAP(name, getname, (struct socket *sock, struct sockaddr *uaddr, \
306 int *addr_len, int peer), (sock, uaddr, addr_len, peer)) \
307SOCKCALL_UWRAP(name, poll, (struct file *file, struct socket *sock, struct poll_table_struct *wait), \
308 (file, sock, wait)) \
309SOCKCALL_WRAP(name, ioctl, (struct socket *sock, unsigned int cmd, \
310 unsigned long arg), (sock, cmd, arg)) \
Shaun Pereira89bbfc92006-03-21 23:58:08 -0800311SOCKCALL_WRAP(name, compat_ioctl, (struct socket *sock, unsigned int cmd, \
312 unsigned long arg), (sock, cmd, arg)) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313SOCKCALL_WRAP(name, listen, (struct socket *sock, int len), (sock, len)) \
314SOCKCALL_WRAP(name, shutdown, (struct socket *sock, int flags), (sock, flags)) \
315SOCKCALL_WRAP(name, setsockopt, (struct socket *sock, int level, int optname, \
David S. Millerb7058842009-09-30 16:12:20 -0700316 char __user *optval, unsigned int optlen), (sock, level, optname, optval, optlen)) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317SOCKCALL_WRAP(name, getsockopt, (struct socket *sock, int level, int optname, \
318 char __user *optval, int __user *optlen), (sock, level, optname, optval, optlen)) \
319SOCKCALL_WRAP(name, sendmsg, (struct kiocb *iocb, struct socket *sock, struct msghdr *m, size_t len), \
320 (iocb, sock, m, len)) \
321SOCKCALL_WRAP(name, recvmsg, (struct kiocb *iocb, struct socket *sock, struct msghdr *m, size_t len, int flags), \
322 (iocb, sock, m, len, flags)) \
323SOCKCALL_WRAP(name, mmap, (struct file *file, struct socket *sock, struct vm_area_struct *vma), \
324 (file, sock, vma)) \
325 \
Eric Dumazet90ddc4f2005-12-22 12:49:22 -0800326static const struct proto_ops name##_ops = { \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 .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, \
Shaun Pereira89bbfc92006-03-21 23:58:08 -0800337 .compat_ioctl = __lock_##name##_compat_ioctl, \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338 .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};
Shaun Pereira89bbfc92006-03-21 23:58:08 -0800346
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347#endif
348
349#define MODULE_ALIAS_NETPROTO(proto) \
350 MODULE_ALIAS("net-pf-" __stringify(proto))
351
Harald Welte4fdb3bb2005-08-09 19:40:55 -0700352#define MODULE_ALIAS_NET_PF_PROTO(pf, proto) \
353 MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto))
354
Jean Delvare305e1e92007-10-21 16:44:04 -0700355#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
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -0300359#ifdef CONFIG_SYSCTL
360#include <linux/sysctl.h>
Dave Young717115e2008-07-25 01:45:58 -0700361extern struct ratelimit_state net_ratelimit_state;
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -0300362#endif
363
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364#endif /* __KERNEL__ */
365#endif /* _LINUX_NET_H */