blob: efc45177b50359cf6cccb218ab75f6a3cb580e0c [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;
26
David Howells17926a72007-04-26 15:48:28 -070027#define NPROTO 34 /* should be enough for now.. */
Linus Torvalds1da177e2005-04-16 15:20:36 -070028
29#define SYS_SOCKET 1 /* sys_socket(2) */
30#define SYS_BIND 2 /* sys_bind(2) */
31#define SYS_CONNECT 3 /* sys_connect(2) */
32#define SYS_LISTEN 4 /* sys_listen(2) */
33#define SYS_ACCEPT 5 /* sys_accept(2) */
34#define SYS_GETSOCKNAME 6 /* sys_getsockname(2) */
35#define SYS_GETPEERNAME 7 /* sys_getpeername(2) */
36#define SYS_SOCKETPAIR 8 /* sys_socketpair(2) */
37#define SYS_SEND 9 /* sys_send(2) */
38#define SYS_RECV 10 /* sys_recv(2) */
39#define SYS_SENDTO 11 /* sys_sendto(2) */
40#define SYS_RECVFROM 12 /* sys_recvfrom(2) */
41#define SYS_SHUTDOWN 13 /* sys_shutdown(2) */
42#define SYS_SETSOCKOPT 14 /* sys_setsockopt(2) */
43#define SYS_GETSOCKOPT 15 /* sys_getsockopt(2) */
44#define SYS_SENDMSG 16 /* sys_sendmsg(2) */
45#define SYS_RECVMSG 17 /* sys_recvmsg(2) */
46
47typedef enum {
48 SS_FREE = 0, /* not allocated */
49 SS_UNCONNECTED, /* unconnected to any socket */
50 SS_CONNECTING, /* in process of connecting */
51 SS_CONNECTED, /* connected to socket */
52 SS_DISCONNECTING /* in process of disconnecting */
53} socket_state;
54
55#define __SO_ACCEPTCON (1 << 16) /* performed a listen */
56
57#ifdef __KERNEL__
David Woodhouseeacf17b2006-04-25 14:46:09 +010058#include <linux/stringify.h>
David Woodhousecb4db4c2006-12-28 21:21:55 -080059#include <linux/random.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070060
61#define SOCK_ASYNC_NOSPACE 0
62#define SOCK_ASYNC_WAITDATA 1
63#define SOCK_NOSPACE 2
64#define SOCK_PASSCRED 3
Catherine Zhang877ce7c2006-06-29 12:27:47 -070065#define SOCK_PASSSEC 4
Linus Torvalds1da177e2005-04-16 15:20:36 -070066
67#ifndef ARCH_HAS_SOCKET_TYPES
Pavel Pisa4dc3b162005-05-01 08:59:25 -070068/**
69 * enum sock_type - Socket types
70 * @SOCK_STREAM: stream (connection) socket
71 * @SOCK_DGRAM: datagram (conn.less) socket
72 * @SOCK_RAW: raw socket
73 * @SOCK_RDM: reliably-delivered message
74 * @SOCK_SEQPACKET: sequential packet socket
Randy Dunlap8f2709b2005-11-07 01:01:05 -080075 * @SOCK_DCCP: Datagram Congestion Control Protocol socket
Pavel Pisa4dc3b162005-05-01 08:59:25 -070076 * @SOCK_PACKET: linux specific way of getting packets at the dev level.
77 * For writing rarp and other similar things on the user level.
78 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070079 * When adding some new socket type please
80 * grep ARCH_HAS_SOCKET_TYPE include/asm-* /socket.h, at least MIPS
81 * overrides this enum for binary compat reasons.
Linus Torvalds1da177e2005-04-16 15:20:36 -070082 */
83enum sock_type {
84 SOCK_STREAM = 1,
85 SOCK_DGRAM = 2,
86 SOCK_RAW = 3,
87 SOCK_RDM = 4,
88 SOCK_SEQPACKET = 5,
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -070089 SOCK_DCCP = 6,
Linus Torvalds1da177e2005-04-16 15:20:36 -070090 SOCK_PACKET = 10,
91};
92
93#define SOCK_MAX (SOCK_PACKET + 1)
94
95#endif /* ARCH_HAS_SOCKET_TYPES */
96
97/**
98 * struct socket - general BSD socket
Pavel Pisa4dc3b162005-05-01 08:59:25 -070099 * @state: socket state (%SS_CONNECTED, etc)
100 * @flags: socket flags (%SOCK_ASYNC_NOSPACE, etc)
101 * @ops: protocol specific socket operations
102 * @fasync_list: Asynchronous wake up list
103 * @file: File back pointer for gc
104 * @sk: internal networking protocol agnostic socket representation
105 * @wait: wait queue for several uses
106 * @type: socket type (%SOCK_STREAM, etc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107 */
108struct socket {
109 socket_state state;
110 unsigned long flags;
Eric Dumazet90ddc4f2005-12-22 12:49:22 -0800111 const struct proto_ops *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112 struct fasync_struct *fasync_list;
113 struct file *file;
114 struct sock *sk;
115 wait_queue_head_t wait;
116 short type;
117};
118
119struct vm_area_struct;
120struct page;
121struct kiocb;
122struct sockaddr;
123struct msghdr;
124struct module;
125
126struct proto_ops {
127 int family;
128 struct module *owner;
129 int (*release) (struct socket *sock);
130 int (*bind) (struct socket *sock,
131 struct sockaddr *myaddr,
132 int sockaddr_len);
133 int (*connect) (struct socket *sock,
134 struct sockaddr *vaddr,
135 int sockaddr_len, int flags);
136 int (*socketpair)(struct socket *sock1,
137 struct socket *sock2);
138 int (*accept) (struct socket *sock,
139 struct socket *newsock, int flags);
140 int (*getname) (struct socket *sock,
141 struct sockaddr *addr,
142 int *sockaddr_len, int peer);
143 unsigned int (*poll) (struct file *file, struct socket *sock,
144 struct poll_table_struct *wait);
145 int (*ioctl) (struct socket *sock, unsigned int cmd,
146 unsigned long arg);
Shaun Pereira89bbfc92006-03-21 23:58:08 -0800147 int (*compat_ioctl) (struct socket *sock, unsigned int cmd,
148 unsigned long arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 int (*listen) (struct socket *sock, int len);
150 int (*shutdown) (struct socket *sock, int flags);
151 int (*setsockopt)(struct socket *sock, int level,
152 int optname, char __user *optval, int optlen);
153 int (*getsockopt)(struct socket *sock, int level,
154 int optname, char __user *optval, int __user *optlen);
Dmitry Mishin3fdadf72006-03-20 22:45:21 -0800155 int (*compat_setsockopt)(struct socket *sock, int level,
156 int optname, char __user *optval, int optlen);
157 int (*compat_getsockopt)(struct socket *sock, int level,
158 int optname, char __user *optval, int __user *optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159 int (*sendmsg) (struct kiocb *iocb, struct socket *sock,
160 struct msghdr *m, size_t total_len);
161 int (*recvmsg) (struct kiocb *iocb, struct socket *sock,
162 struct msghdr *m, size_t total_len,
163 int flags);
164 int (*mmap) (struct file *file, struct socket *sock,
165 struct vm_area_struct * vma);
166 ssize_t (*sendpage) (struct socket *sock, struct page *page,
167 int offset, size_t size, int flags);
168};
169
170struct net_proto_family {
171 int family;
172 int (*create)(struct socket *sock, int protocol);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173 struct module *owner;
174};
175
176struct iovec;
177struct kvec;
178
179extern int sock_wake_async(struct socket *sk, int how, int band);
Stephen Hemmingerf0fd27d2006-08-09 21:03:17 -0700180extern int sock_register(const struct net_proto_family *fam);
181extern void sock_unregister(int family);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182extern int sock_create(int family, int type, int proto,
183 struct socket **res);
184extern int sock_create_kern(int family, int type, int proto,
185 struct socket **res);
186extern int sock_create_lite(int family, int type, int proto,
187 struct socket **res);
188extern void sock_release(struct socket *sock);
189extern int sock_sendmsg(struct socket *sock, struct msghdr *msg,
190 size_t len);
191extern int sock_recvmsg(struct socket *sock, struct msghdr *msg,
192 size_t size, int flags);
193extern int sock_map_fd(struct socket *sock);
194extern struct socket *sockfd_lookup(int fd, int *err);
195#define sockfd_put(sock) fput(sock->file)
196extern int net_ratelimit(void);
Stephen Hemmingeraaa248f2006-10-17 00:09:42 -0700197
198#define net_random() random32()
Al Viroa64b78a2006-11-14 21:12:29 -0800199#define net_srandom(seed) srandom32((__force u32)seed)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200
201extern int kernel_sendmsg(struct socket *sock, struct msghdr *msg,
202 struct kvec *vec, size_t num, size_t len);
203extern int kernel_recvmsg(struct socket *sock, struct msghdr *msg,
204 struct kvec *vec, size_t num,
205 size_t len, int flags);
206
Sridhar Samudralaac5a4882006-08-07 20:57:31 -0700207extern int kernel_bind(struct socket *sock, struct sockaddr *addr,
208 int addrlen);
209extern int kernel_listen(struct socket *sock, int backlog);
210extern int kernel_accept(struct socket *sock, struct socket **newsock,
211 int flags);
212extern int kernel_connect(struct socket *sock, struct sockaddr *addr,
213 int addrlen, int flags);
214extern int kernel_getsockname(struct socket *sock, struct sockaddr *addr,
215 int *addrlen);
216extern int kernel_getpeername(struct socket *sock, struct sockaddr *addr,
217 int *addrlen);
218extern int kernel_getsockopt(struct socket *sock, int level, int optname,
219 char *optval, int *optlen);
220extern int kernel_setsockopt(struct socket *sock, int level, int optname,
221 char *optval, int optlen);
222extern int kernel_sendpage(struct socket *sock, struct page *page, int offset,
223 size_t size, int flags);
224extern int kernel_sock_ioctl(struct socket *sock, int cmd, unsigned long arg);
225
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226#ifndef CONFIG_SMP
227#define SOCKOPS_WRAPPED(name) name
228#define SOCKOPS_WRAP(name, fam)
229#else
230
231#define SOCKOPS_WRAPPED(name) __unlocked_##name
232
233#define SOCKCALL_WRAP(name, call, parms, args) \
234static int __lock_##name##_##call parms \
235{ \
236 int ret; \
237 lock_kernel(); \
238 ret = __unlocked_##name##_ops.call args ;\
239 unlock_kernel(); \
240 return ret; \
241}
242
243#define SOCKCALL_UWRAP(name, call, parms, args) \
244static unsigned int __lock_##name##_##call parms \
245{ \
246 int ret; \
247 lock_kernel(); \
248 ret = __unlocked_##name##_ops.call args ;\
249 unlock_kernel(); \
250 return ret; \
251}
252
253
254#define SOCKOPS_WRAP(name, fam) \
255SOCKCALL_WRAP(name, release, (struct socket *sock), (sock)) \
256SOCKCALL_WRAP(name, bind, (struct socket *sock, struct sockaddr *uaddr, int addr_len), \
257 (sock, uaddr, addr_len)) \
258SOCKCALL_WRAP(name, connect, (struct socket *sock, struct sockaddr * uaddr, \
259 int addr_len, int flags), \
260 (sock, uaddr, addr_len, flags)) \
261SOCKCALL_WRAP(name, socketpair, (struct socket *sock1, struct socket *sock2), \
262 (sock1, sock2)) \
263SOCKCALL_WRAP(name, accept, (struct socket *sock, struct socket *newsock, \
264 int flags), (sock, newsock, flags)) \
265SOCKCALL_WRAP(name, getname, (struct socket *sock, struct sockaddr *uaddr, \
266 int *addr_len, int peer), (sock, uaddr, addr_len, peer)) \
267SOCKCALL_UWRAP(name, poll, (struct file *file, struct socket *sock, struct poll_table_struct *wait), \
268 (file, sock, wait)) \
269SOCKCALL_WRAP(name, ioctl, (struct socket *sock, unsigned int cmd, \
270 unsigned long arg), (sock, cmd, arg)) \
Shaun Pereira89bbfc92006-03-21 23:58:08 -0800271SOCKCALL_WRAP(name, compat_ioctl, (struct socket *sock, unsigned int cmd, \
272 unsigned long arg), (sock, cmd, arg)) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273SOCKCALL_WRAP(name, listen, (struct socket *sock, int len), (sock, len)) \
274SOCKCALL_WRAP(name, shutdown, (struct socket *sock, int flags), (sock, flags)) \
275SOCKCALL_WRAP(name, setsockopt, (struct socket *sock, int level, int optname, \
276 char __user *optval, int optlen), (sock, level, optname, optval, optlen)) \
277SOCKCALL_WRAP(name, getsockopt, (struct socket *sock, int level, int optname, \
278 char __user *optval, int __user *optlen), (sock, level, optname, optval, optlen)) \
279SOCKCALL_WRAP(name, sendmsg, (struct kiocb *iocb, struct socket *sock, struct msghdr *m, size_t len), \
280 (iocb, sock, m, len)) \
281SOCKCALL_WRAP(name, recvmsg, (struct kiocb *iocb, struct socket *sock, struct msghdr *m, size_t len, int flags), \
282 (iocb, sock, m, len, flags)) \
283SOCKCALL_WRAP(name, mmap, (struct file *file, struct socket *sock, struct vm_area_struct *vma), \
284 (file, sock, vma)) \
285 \
Eric Dumazet90ddc4f2005-12-22 12:49:22 -0800286static const struct proto_ops name##_ops = { \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287 .family = fam, \
288 .owner = THIS_MODULE, \
289 .release = __lock_##name##_release, \
290 .bind = __lock_##name##_bind, \
291 .connect = __lock_##name##_connect, \
292 .socketpair = __lock_##name##_socketpair, \
293 .accept = __lock_##name##_accept, \
294 .getname = __lock_##name##_getname, \
295 .poll = __lock_##name##_poll, \
296 .ioctl = __lock_##name##_ioctl, \
Shaun Pereira89bbfc92006-03-21 23:58:08 -0800297 .compat_ioctl = __lock_##name##_compat_ioctl, \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298 .listen = __lock_##name##_listen, \
299 .shutdown = __lock_##name##_shutdown, \
300 .setsockopt = __lock_##name##_setsockopt, \
301 .getsockopt = __lock_##name##_getsockopt, \
302 .sendmsg = __lock_##name##_sendmsg, \
303 .recvmsg = __lock_##name##_recvmsg, \
304 .mmap = __lock_##name##_mmap, \
305};
Shaun Pereira89bbfc92006-03-21 23:58:08 -0800306
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307#endif
308
309#define MODULE_ALIAS_NETPROTO(proto) \
310 MODULE_ALIAS("net-pf-" __stringify(proto))
311
Harald Welte4fdb3bb2005-08-09 19:40:55 -0700312#define MODULE_ALIAS_NET_PF_PROTO(pf, proto) \
313 MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto))
314
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -0300315#ifdef CONFIG_SYSCTL
316#include <linux/sysctl.h>
317extern ctl_table net_table[];
318extern int net_msg_cost;
319extern int net_msg_burst;
320#endif
321
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322#endif /* __KERNEL__ */
323#endif /* _LINUX_NET_H */