blob: 6dc14a240042eab5685fddfb0f357eaae9eecd9d [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 Drepperaaca0bd2008-07-23 21:29:20 -070043#define SYS_PACCEPT 18 /* sys_paccept(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 */
60
61struct poll_table_struct;
62struct pipe_inode_info;
63struct inode;
64struct net;
Linus Torvalds1da177e2005-04-16 15:20:36 -070065
66#define SOCK_ASYNC_NOSPACE 0
67#define SOCK_ASYNC_WAITDATA 1
68#define SOCK_NOSPACE 2
69#define SOCK_PASSCRED 3
Catherine Zhang877ce7c2006-06-29 12:27:47 -070070#define SOCK_PASSSEC 4
Linus Torvalds1da177e2005-04-16 15:20:36 -070071
72#ifndef ARCH_HAS_SOCKET_TYPES
Pavel Pisa4dc3b162005-05-01 08:59:25 -070073/**
74 * enum sock_type - Socket types
75 * @SOCK_STREAM: stream (connection) socket
76 * @SOCK_DGRAM: datagram (conn.less) socket
77 * @SOCK_RAW: raw socket
78 * @SOCK_RDM: reliably-delivered message
79 * @SOCK_SEQPACKET: sequential packet socket
Randy Dunlap8f2709b2005-11-07 01:01:05 -080080 * @SOCK_DCCP: Datagram Congestion Control Protocol socket
Pavel Pisa4dc3b162005-05-01 08:59:25 -070081 * @SOCK_PACKET: linux specific way of getting packets at the dev level.
82 * For writing rarp and other similar things on the user level.
83 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070084 * When adding some new socket type please
85 * grep ARCH_HAS_SOCKET_TYPE include/asm-* /socket.h, at least MIPS
86 * overrides this enum for binary compat reasons.
Linus Torvalds1da177e2005-04-16 15:20:36 -070087 */
88enum sock_type {
89 SOCK_STREAM = 1,
90 SOCK_DGRAM = 2,
91 SOCK_RAW = 3,
92 SOCK_RDM = 4,
93 SOCK_SEQPACKET = 5,
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -070094 SOCK_DCCP = 6,
Linus Torvalds1da177e2005-04-16 15:20:36 -070095 SOCK_PACKET = 10,
96};
97
98#define SOCK_MAX (SOCK_PACKET + 1)
Ulrich Dreppera677a032008-07-23 21:29:17 -070099/* Mask which covers at least up to SOCK_MASK-1. The
100 * remaining bits are used as flags. */
101#define SOCK_TYPE_MASK 0xf
102
103/* Flags for socket, socketpair, paccept */
104#define SOCK_CLOEXEC O_CLOEXEC
Ulrich Drepperc019bbc2008-07-23 21:29:21 -0700105#ifndef SOCK_NONBLOCK
106#define SOCK_NONBLOCK O_NONBLOCK
107#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108
109#endif /* ARCH_HAS_SOCKET_TYPES */
110
Trond Myklebust91cf45f2007-11-12 18:10:39 -0800111enum sock_shutdown_cmd {
112 SHUT_RD = 0,
113 SHUT_WR = 1,
114 SHUT_RDWR = 2,
115};
116
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117/**
118 * struct socket - general BSD socket
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700119 * @state: socket state (%SS_CONNECTED, etc)
Richard Kennedy2c693612008-07-08 03:03:01 -0700120 * @type: socket type (%SOCK_STREAM, etc)
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700121 * @flags: socket flags (%SOCK_ASYNC_NOSPACE, etc)
122 * @ops: protocol specific socket operations
123 * @fasync_list: Asynchronous wake up list
124 * @file: File back pointer for gc
125 * @sk: internal networking protocol agnostic socket representation
126 * @wait: wait queue for several uses
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127 */
128struct socket {
129 socket_state state;
Richard Kennedy2c693612008-07-08 03:03:01 -0700130 short type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 unsigned long flags;
Eric Dumazet90ddc4f2005-12-22 12:49:22 -0800132 const struct proto_ops *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 struct fasync_struct *fasync_list;
134 struct file *file;
135 struct sock *sk;
136 wait_queue_head_t wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137};
138
139struct vm_area_struct;
140struct page;
141struct kiocb;
142struct sockaddr;
143struct msghdr;
144struct module;
145
146struct proto_ops {
147 int family;
148 struct module *owner;
149 int (*release) (struct socket *sock);
150 int (*bind) (struct socket *sock,
151 struct sockaddr *myaddr,
152 int sockaddr_len);
153 int (*connect) (struct socket *sock,
154 struct sockaddr *vaddr,
155 int sockaddr_len, int flags);
156 int (*socketpair)(struct socket *sock1,
157 struct socket *sock2);
158 int (*accept) (struct socket *sock,
159 struct socket *newsock, int flags);
160 int (*getname) (struct socket *sock,
161 struct sockaddr *addr,
162 int *sockaddr_len, int peer);
163 unsigned int (*poll) (struct file *file, struct socket *sock,
164 struct poll_table_struct *wait);
165 int (*ioctl) (struct socket *sock, unsigned int cmd,
166 unsigned long arg);
Shaun Pereira89bbfc92006-03-21 23:58:08 -0800167 int (*compat_ioctl) (struct socket *sock, unsigned int cmd,
168 unsigned long arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169 int (*listen) (struct socket *sock, int len);
170 int (*shutdown) (struct socket *sock, int flags);
171 int (*setsockopt)(struct socket *sock, int level,
172 int optname, char __user *optval, int optlen);
173 int (*getsockopt)(struct socket *sock, int level,
174 int optname, char __user *optval, int __user *optlen);
Dmitry Mishin3fdadf72006-03-20 22:45:21 -0800175 int (*compat_setsockopt)(struct socket *sock, int level,
176 int optname, char __user *optval, int optlen);
177 int (*compat_getsockopt)(struct socket *sock, int level,
178 int optname, char __user *optval, int __user *optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179 int (*sendmsg) (struct kiocb *iocb, struct socket *sock,
180 struct msghdr *m, size_t total_len);
181 int (*recvmsg) (struct kiocb *iocb, struct socket *sock,
182 struct msghdr *m, size_t total_len,
183 int flags);
184 int (*mmap) (struct file *file, struct socket *sock,
185 struct vm_area_struct * vma);
186 ssize_t (*sendpage) (struct socket *sock, struct page *page,
187 int offset, size_t size, int flags);
Jens Axboe9c55e012007-11-06 23:30:13 -0800188 ssize_t (*splice_read)(struct socket *sock, loff_t *ppos,
189 struct pipe_inode_info *pipe, size_t len, unsigned int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190};
191
192struct net_proto_family {
193 int family;
Eric W. Biederman1b8d7ae2007-10-08 23:24:22 -0700194 int (*create)(struct net *net, struct socket *sock, int protocol);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 struct module *owner;
196};
197
198struct iovec;
199struct kvec;
200
Pavel Emelyanov8d8ad9d2007-11-26 20:10:50 +0800201enum {
202 SOCK_WAKE_IO,
203 SOCK_WAKE_WAITD,
204 SOCK_WAKE_SPACE,
205 SOCK_WAKE_URG,
206};
207
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208extern int sock_wake_async(struct socket *sk, int how, int band);
Stephen Hemmingerf0fd27d2006-08-09 21:03:17 -0700209extern int sock_register(const struct net_proto_family *fam);
210extern void sock_unregister(int family);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211extern int sock_create(int family, int type, int proto,
212 struct socket **res);
213extern int sock_create_kern(int family, int type, int proto,
214 struct socket **res);
215extern int sock_create_lite(int family, int type, int proto,
216 struct socket **res);
217extern void sock_release(struct socket *sock);
218extern int sock_sendmsg(struct socket *sock, struct msghdr *msg,
219 size_t len);
220extern int sock_recvmsg(struct socket *sock, struct msghdr *msg,
221 size_t size, int flags);
Ulrich Dreppera677a032008-07-23 21:29:17 -0700222extern int sock_map_fd(struct socket *sock, int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223extern struct socket *sockfd_lookup(int fd, int *err);
224#define sockfd_put(sock) fput(sock->file)
225extern int net_ratelimit(void);
Ulrich Drepperaaca0bd2008-07-23 21:29:20 -0700226extern long do_accept(int fd, struct sockaddr __user *upeer_sockaddr,
227 int __user *upeer_addrlen, int flags);
Stephen Hemmingeraaa248f2006-10-17 00:09:42 -0700228
229#define net_random() random32()
Al Viroa64b78a2006-11-14 21:12:29 -0800230#define net_srandom(seed) srandom32((__force u32)seed)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231
232extern int kernel_sendmsg(struct socket *sock, struct msghdr *msg,
233 struct kvec *vec, size_t num, size_t len);
234extern int kernel_recvmsg(struct socket *sock, struct msghdr *msg,
235 struct kvec *vec, size_t num,
236 size_t len, int flags);
237
Sridhar Samudralaac5a4882006-08-07 20:57:31 -0700238extern int kernel_bind(struct socket *sock, struct sockaddr *addr,
239 int addrlen);
240extern int kernel_listen(struct socket *sock, int backlog);
241extern int kernel_accept(struct socket *sock, struct socket **newsock,
242 int flags);
243extern int kernel_connect(struct socket *sock, struct sockaddr *addr,
244 int addrlen, int flags);
245extern int kernel_getsockname(struct socket *sock, struct sockaddr *addr,
246 int *addrlen);
247extern int kernel_getpeername(struct socket *sock, struct sockaddr *addr,
248 int *addrlen);
249extern int kernel_getsockopt(struct socket *sock, int level, int optname,
250 char *optval, int *optlen);
251extern int kernel_setsockopt(struct socket *sock, int level, int optname,
252 char *optval, int optlen);
253extern int kernel_sendpage(struct socket *sock, struct page *page, int offset,
254 size_t size, int flags);
255extern int kernel_sock_ioctl(struct socket *sock, int cmd, unsigned long arg);
Trond Myklebust91cf45f2007-11-12 18:10:39 -0800256extern int kernel_sock_shutdown(struct socket *sock,
257 enum sock_shutdown_cmd how);
Sridhar Samudralaac5a4882006-08-07 20:57:31 -0700258
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259#ifndef CONFIG_SMP
260#define SOCKOPS_WRAPPED(name) name
261#define SOCKOPS_WRAP(name, fam)
262#else
263
264#define SOCKOPS_WRAPPED(name) __unlocked_##name
265
266#define SOCKCALL_WRAP(name, call, parms, args) \
267static int __lock_##name##_##call parms \
268{ \
269 int ret; \
270 lock_kernel(); \
271 ret = __unlocked_##name##_ops.call args ;\
272 unlock_kernel(); \
273 return ret; \
274}
275
276#define SOCKCALL_UWRAP(name, call, parms, args) \
277static unsigned int __lock_##name##_##call parms \
278{ \
279 int ret; \
280 lock_kernel(); \
281 ret = __unlocked_##name##_ops.call args ;\
282 unlock_kernel(); \
283 return ret; \
284}
285
286
287#define SOCKOPS_WRAP(name, fam) \
288SOCKCALL_WRAP(name, release, (struct socket *sock), (sock)) \
289SOCKCALL_WRAP(name, bind, (struct socket *sock, struct sockaddr *uaddr, int addr_len), \
290 (sock, uaddr, addr_len)) \
291SOCKCALL_WRAP(name, connect, (struct socket *sock, struct sockaddr * uaddr, \
292 int addr_len, int flags), \
293 (sock, uaddr, addr_len, flags)) \
294SOCKCALL_WRAP(name, socketpair, (struct socket *sock1, struct socket *sock2), \
295 (sock1, sock2)) \
296SOCKCALL_WRAP(name, accept, (struct socket *sock, struct socket *newsock, \
297 int flags), (sock, newsock, flags)) \
298SOCKCALL_WRAP(name, getname, (struct socket *sock, struct sockaddr *uaddr, \
299 int *addr_len, int peer), (sock, uaddr, addr_len, peer)) \
300SOCKCALL_UWRAP(name, poll, (struct file *file, struct socket *sock, struct poll_table_struct *wait), \
301 (file, sock, wait)) \
302SOCKCALL_WRAP(name, ioctl, (struct socket *sock, unsigned int cmd, \
303 unsigned long arg), (sock, cmd, arg)) \
Shaun Pereira89bbfc92006-03-21 23:58:08 -0800304SOCKCALL_WRAP(name, compat_ioctl, (struct socket *sock, unsigned int cmd, \
305 unsigned long arg), (sock, cmd, arg)) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306SOCKCALL_WRAP(name, listen, (struct socket *sock, int len), (sock, len)) \
307SOCKCALL_WRAP(name, shutdown, (struct socket *sock, int flags), (sock, flags)) \
308SOCKCALL_WRAP(name, setsockopt, (struct socket *sock, int level, int optname, \
309 char __user *optval, int optlen), (sock, level, optname, optval, optlen)) \
310SOCKCALL_WRAP(name, getsockopt, (struct socket *sock, int level, int optname, \
311 char __user *optval, int __user *optlen), (sock, level, optname, optval, optlen)) \
312SOCKCALL_WRAP(name, sendmsg, (struct kiocb *iocb, struct socket *sock, struct msghdr *m, size_t len), \
313 (iocb, sock, m, len)) \
314SOCKCALL_WRAP(name, recvmsg, (struct kiocb *iocb, struct socket *sock, struct msghdr *m, size_t len, int flags), \
315 (iocb, sock, m, len, flags)) \
316SOCKCALL_WRAP(name, mmap, (struct file *file, struct socket *sock, struct vm_area_struct *vma), \
317 (file, sock, vma)) \
318 \
Eric Dumazet90ddc4f2005-12-22 12:49:22 -0800319static const struct proto_ops name##_ops = { \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320 .family = fam, \
321 .owner = THIS_MODULE, \
322 .release = __lock_##name##_release, \
323 .bind = __lock_##name##_bind, \
324 .connect = __lock_##name##_connect, \
325 .socketpair = __lock_##name##_socketpair, \
326 .accept = __lock_##name##_accept, \
327 .getname = __lock_##name##_getname, \
328 .poll = __lock_##name##_poll, \
329 .ioctl = __lock_##name##_ioctl, \
Shaun Pereira89bbfc92006-03-21 23:58:08 -0800330 .compat_ioctl = __lock_##name##_compat_ioctl, \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331 .listen = __lock_##name##_listen, \
332 .shutdown = __lock_##name##_shutdown, \
333 .setsockopt = __lock_##name##_setsockopt, \
334 .getsockopt = __lock_##name##_getsockopt, \
335 .sendmsg = __lock_##name##_sendmsg, \
336 .recvmsg = __lock_##name##_recvmsg, \
337 .mmap = __lock_##name##_mmap, \
338};
Shaun Pereira89bbfc92006-03-21 23:58:08 -0800339
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340#endif
341
342#define MODULE_ALIAS_NETPROTO(proto) \
343 MODULE_ALIAS("net-pf-" __stringify(proto))
344
Harald Welte4fdb3bb2005-08-09 19:40:55 -0700345#define MODULE_ALIAS_NET_PF_PROTO(pf, proto) \
346 MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto))
347
Jean Delvare305e1e92007-10-21 16:44:04 -0700348#define MODULE_ALIAS_NET_PF_PROTO_TYPE(pf, proto, type) \
349 MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto) \
350 "-type-" __stringify(type))
351
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -0300352#ifdef CONFIG_SYSCTL
353#include <linux/sysctl.h>
Dave Young717115e2008-07-25 01:45:58 -0700354extern struct ratelimit_state net_ratelimit_state;
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -0300355#endif
356
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357#endif /* __KERNEL__ */
358#endif /* _LINUX_NET_H */