blob: c136abce7ef628291325c5ce00a49a1763db6101 [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
Linus Torvalds1da177e2005-04-16 15:20:36 -070021#include <linux/wait.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <asm/socket.h>
23
24struct poll_table_struct;
25struct inode;
Eric W. Biederman1b8d7ae2007-10-08 23:24:22 -070026struct net;
Linus Torvalds1da177e2005-04-16 15:20:36 -070027
David Howells17926a72007-04-26 15:48:28 -070028#define NPROTO 34 /* should be enough for now.. */
Linus Torvalds1da177e2005-04-16 15:20:36 -070029
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
48typedef 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__
David Woodhouseeacf17b2006-04-25 14:46:09 +010059#include <linux/stringify.h>
David Woodhousecb4db4c2006-12-28 21:21:55 -080060#include <linux/random.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070061
62#define SOCK_ASYNC_NOSPACE 0
63#define SOCK_ASYNC_WAITDATA 1
64#define SOCK_NOSPACE 2
65#define SOCK_PASSCRED 3
Catherine Zhang877ce7c2006-06-29 12:27:47 -070066#define SOCK_PASSSEC 4
Linus Torvalds1da177e2005-04-16 15:20:36 -070067
68#ifndef ARCH_HAS_SOCKET_TYPES
Pavel Pisa4dc3b162005-05-01 08:59:25 -070069/**
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
Randy Dunlap8f2709b2005-11-07 01:01:05 -080076 * @SOCK_DCCP: Datagram Congestion Control Protocol socket
Pavel Pisa4dc3b162005-05-01 08:59:25 -070077 * @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 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070080 * 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -070083 */
84enum sock_type {
85 SOCK_STREAM = 1,
86 SOCK_DGRAM = 2,
87 SOCK_RAW = 3,
88 SOCK_RDM = 4,
89 SOCK_SEQPACKET = 5,
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -070090 SOCK_DCCP = 6,
Linus Torvalds1da177e2005-04-16 15:20:36 -070091 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
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700100 * @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)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108 */
109struct socket {
110 socket_state state;
111 unsigned long flags;
Eric Dumazet90ddc4f2005-12-22 12:49:22 -0800112 const struct proto_ops *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113 struct fasync_struct *fasync_list;
114 struct file *file;
115 struct sock *sk;
116 wait_queue_head_t wait;
117 short type;
118};
119
120struct vm_area_struct;
121struct page;
122struct kiocb;
123struct sockaddr;
124struct msghdr;
125struct module;
126
127struct 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);
Shaun Pereira89bbfc92006-03-21 23:58:08 -0800148 int (*compat_ioctl) (struct socket *sock, unsigned int cmd,
149 unsigned long arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150 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);
Dmitry Mishin3fdadf72006-03-20 22:45:21 -0800156 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);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 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
171struct net_proto_family {
172 int family;
Eric W. Biederman1b8d7ae2007-10-08 23:24:22 -0700173 int (*create)(struct net *net, struct socket *sock, int protocol);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174 struct module *owner;
175};
176
177struct iovec;
178struct kvec;
179
180extern int sock_wake_async(struct socket *sk, int how, int band);
Stephen Hemmingerf0fd27d2006-08-09 21:03:17 -0700181extern int sock_register(const struct net_proto_family *fam);
182extern void sock_unregister(int family);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183extern int sock_create(int family, int type, int proto,
184 struct socket **res);
185extern int sock_create_kern(int family, int type, int proto,
186 struct socket **res);
187extern int sock_create_lite(int family, int type, int proto,
188 struct socket **res);
189extern void sock_release(struct socket *sock);
190extern int sock_sendmsg(struct socket *sock, struct msghdr *msg,
191 size_t len);
192extern int sock_recvmsg(struct socket *sock, struct msghdr *msg,
193 size_t size, int flags);
194extern int sock_map_fd(struct socket *sock);
195extern struct socket *sockfd_lookup(int fd, int *err);
196#define sockfd_put(sock) fput(sock->file)
197extern int net_ratelimit(void);
Stephen Hemmingeraaa248f2006-10-17 00:09:42 -0700198
199#define net_random() random32()
Al Viroa64b78a2006-11-14 21:12:29 -0800200#define net_srandom(seed) srandom32((__force u32)seed)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201
202extern int kernel_sendmsg(struct socket *sock, struct msghdr *msg,
203 struct kvec *vec, size_t num, size_t len);
204extern int kernel_recvmsg(struct socket *sock, struct msghdr *msg,
205 struct kvec *vec, size_t num,
206 size_t len, int flags);
207
Sridhar Samudralaac5a4882006-08-07 20:57:31 -0700208extern int kernel_bind(struct socket *sock, struct sockaddr *addr,
209 int addrlen);
210extern int kernel_listen(struct socket *sock, int backlog);
211extern int kernel_accept(struct socket *sock, struct socket **newsock,
212 int flags);
213extern int kernel_connect(struct socket *sock, struct sockaddr *addr,
214 int addrlen, int flags);
215extern int kernel_getsockname(struct socket *sock, struct sockaddr *addr,
216 int *addrlen);
217extern int kernel_getpeername(struct socket *sock, struct sockaddr *addr,
218 int *addrlen);
219extern int kernel_getsockopt(struct socket *sock, int level, int optname,
220 char *optval, int *optlen);
221extern int kernel_setsockopt(struct socket *sock, int level, int optname,
222 char *optval, int optlen);
223extern int kernel_sendpage(struct socket *sock, struct page *page, int offset,
224 size_t size, int flags);
225extern int kernel_sock_ioctl(struct socket *sock, int cmd, unsigned long arg);
226
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227#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) \
235static 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) \
245static 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) \
256SOCKCALL_WRAP(name, release, (struct socket *sock), (sock)) \
257SOCKCALL_WRAP(name, bind, (struct socket *sock, struct sockaddr *uaddr, int addr_len), \
258 (sock, uaddr, addr_len)) \
259SOCKCALL_WRAP(name, connect, (struct socket *sock, struct sockaddr * uaddr, \
260 int addr_len, int flags), \
261 (sock, uaddr, addr_len, flags)) \
262SOCKCALL_WRAP(name, socketpair, (struct socket *sock1, struct socket *sock2), \
263 (sock1, sock2)) \
264SOCKCALL_WRAP(name, accept, (struct socket *sock, struct socket *newsock, \
265 int flags), (sock, newsock, flags)) \
266SOCKCALL_WRAP(name, getname, (struct socket *sock, struct sockaddr *uaddr, \
267 int *addr_len, int peer), (sock, uaddr, addr_len, peer)) \
268SOCKCALL_UWRAP(name, poll, (struct file *file, struct socket *sock, struct poll_table_struct *wait), \
269 (file, sock, wait)) \
270SOCKCALL_WRAP(name, ioctl, (struct socket *sock, unsigned int cmd, \
271 unsigned long arg), (sock, cmd, arg)) \
Shaun Pereira89bbfc92006-03-21 23:58:08 -0800272SOCKCALL_WRAP(name, compat_ioctl, (struct socket *sock, unsigned int cmd, \
273 unsigned long arg), (sock, cmd, arg)) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274SOCKCALL_WRAP(name, listen, (struct socket *sock, int len), (sock, len)) \
275SOCKCALL_WRAP(name, shutdown, (struct socket *sock, int flags), (sock, flags)) \
276SOCKCALL_WRAP(name, setsockopt, (struct socket *sock, int level, int optname, \
277 char __user *optval, int optlen), (sock, level, optname, optval, optlen)) \
278SOCKCALL_WRAP(name, getsockopt, (struct socket *sock, int level, int optname, \
279 char __user *optval, int __user *optlen), (sock, level, optname, optval, optlen)) \
280SOCKCALL_WRAP(name, sendmsg, (struct kiocb *iocb, struct socket *sock, struct msghdr *m, size_t len), \
281 (iocb, sock, m, len)) \
282SOCKCALL_WRAP(name, recvmsg, (struct kiocb *iocb, struct socket *sock, struct msghdr *m, size_t len, int flags), \
283 (iocb, sock, m, len, flags)) \
284SOCKCALL_WRAP(name, mmap, (struct file *file, struct socket *sock, struct vm_area_struct *vma), \
285 (file, sock, vma)) \
286 \
Eric Dumazet90ddc4f2005-12-22 12:49:22 -0800287static const struct proto_ops name##_ops = { \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288 .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, \
Shaun Pereira89bbfc92006-03-21 23:58:08 -0800298 .compat_ioctl = __lock_##name##_compat_ioctl, \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299 .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};
Shaun Pereira89bbfc92006-03-21 23:58:08 -0800307
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308#endif
309
310#define MODULE_ALIAS_NETPROTO(proto) \
311 MODULE_ALIAS("net-pf-" __stringify(proto))
312
Harald Welte4fdb3bb2005-08-09 19:40:55 -0700313#define MODULE_ALIAS_NET_PF_PROTO(pf, proto) \
314 MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto))
315
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -0300316#ifdef CONFIG_SYSCTL
317#include <linux/sysctl.h>
318extern ctl_table net_table[];
319extern int net_msg_cost;
320extern int net_msg_burst;
321#endif
322
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323#endif /* __KERNEL__ */
324#endif /* _LINUX_NET_H */