blob: c257f716e00f0b1698fb4154d67f6792e3b6fd50 [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
27#define NPROTO 32 /* should be enough for now.. */
28
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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070059
60#define SOCK_ASYNC_NOSPACE 0
61#define SOCK_ASYNC_WAITDATA 1
62#define SOCK_NOSPACE 2
63#define SOCK_PASSCRED 3
Catherine Zhang877ce7c2006-06-29 12:27:47 -070064#define SOCK_PASSSEC 4
Linus Torvalds1da177e2005-04-16 15:20:36 -070065
66#ifndef ARCH_HAS_SOCKET_TYPES
Pavel Pisa4dc3b162005-05-01 08:59:25 -070067/**
68 * enum sock_type - Socket types
69 * @SOCK_STREAM: stream (connection) socket
70 * @SOCK_DGRAM: datagram (conn.less) socket
71 * @SOCK_RAW: raw socket
72 * @SOCK_RDM: reliably-delivered message
73 * @SOCK_SEQPACKET: sequential packet socket
Randy Dunlap8f2709b2005-11-07 01:01:05 -080074 * @SOCK_DCCP: Datagram Congestion Control Protocol socket
Pavel Pisa4dc3b162005-05-01 08:59:25 -070075 * @SOCK_PACKET: linux specific way of getting packets at the dev level.
76 * For writing rarp and other similar things on the user level.
77 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070078 * When adding some new socket type please
79 * grep ARCH_HAS_SOCKET_TYPE include/asm-* /socket.h, at least MIPS
80 * overrides this enum for binary compat reasons.
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 */
82enum sock_type {
83 SOCK_STREAM = 1,
84 SOCK_DGRAM = 2,
85 SOCK_RAW = 3,
86 SOCK_RDM = 4,
87 SOCK_SEQPACKET = 5,
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -070088 SOCK_DCCP = 6,
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 SOCK_PACKET = 10,
90};
91
92#define SOCK_MAX (SOCK_PACKET + 1)
93
94#endif /* ARCH_HAS_SOCKET_TYPES */
95
96/**
97 * struct socket - general BSD socket
Pavel Pisa4dc3b162005-05-01 08:59:25 -070098 * @state: socket state (%SS_CONNECTED, etc)
99 * @flags: socket flags (%SOCK_ASYNC_NOSPACE, etc)
100 * @ops: protocol specific socket operations
101 * @fasync_list: Asynchronous wake up list
102 * @file: File back pointer for gc
103 * @sk: internal networking protocol agnostic socket representation
104 * @wait: wait queue for several uses
105 * @type: socket type (%SOCK_STREAM, etc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106 */
107struct socket {
108 socket_state state;
109 unsigned long flags;
Eric Dumazet90ddc4f2005-12-22 12:49:22 -0800110 const struct proto_ops *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111 struct fasync_struct *fasync_list;
112 struct file *file;
113 struct sock *sk;
114 wait_queue_head_t wait;
115 short type;
116};
117
118struct vm_area_struct;
119struct page;
120struct kiocb;
121struct sockaddr;
122struct msghdr;
123struct module;
124
125struct proto_ops {
126 int family;
127 struct module *owner;
128 int (*release) (struct socket *sock);
129 int (*bind) (struct socket *sock,
130 struct sockaddr *myaddr,
131 int sockaddr_len);
132 int (*connect) (struct socket *sock,
133 struct sockaddr *vaddr,
134 int sockaddr_len, int flags);
135 int (*socketpair)(struct socket *sock1,
136 struct socket *sock2);
137 int (*accept) (struct socket *sock,
138 struct socket *newsock, int flags);
139 int (*getname) (struct socket *sock,
140 struct sockaddr *addr,
141 int *sockaddr_len, int peer);
142 unsigned int (*poll) (struct file *file, struct socket *sock,
143 struct poll_table_struct *wait);
144 int (*ioctl) (struct socket *sock, unsigned int cmd,
145 unsigned long arg);
Shaun Pereira89bbfc92006-03-21 23:58:08 -0800146 int (*compat_ioctl) (struct socket *sock, unsigned int cmd,
147 unsigned long arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 int (*listen) (struct socket *sock, int len);
149 int (*shutdown) (struct socket *sock, int flags);
150 int (*setsockopt)(struct socket *sock, int level,
151 int optname, char __user *optval, int optlen);
152 int (*getsockopt)(struct socket *sock, int level,
153 int optname, char __user *optval, int __user *optlen);
Dmitry Mishin3fdadf72006-03-20 22:45:21 -0800154 int (*compat_setsockopt)(struct socket *sock, int level,
155 int optname, char __user *optval, int optlen);
156 int (*compat_getsockopt)(struct socket *sock, int level,
157 int optname, char __user *optval, int __user *optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158 int (*sendmsg) (struct kiocb *iocb, struct socket *sock,
159 struct msghdr *m, size_t total_len);
160 int (*recvmsg) (struct kiocb *iocb, struct socket *sock,
161 struct msghdr *m, size_t total_len,
162 int flags);
163 int (*mmap) (struct file *file, struct socket *sock,
164 struct vm_area_struct * vma);
165 ssize_t (*sendpage) (struct socket *sock, struct page *page,
166 int offset, size_t size, int flags);
167};
168
169struct net_proto_family {
170 int family;
171 int (*create)(struct socket *sock, int protocol);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172 struct module *owner;
173};
174
175struct iovec;
176struct kvec;
177
178extern int sock_wake_async(struct socket *sk, int how, int band);
Stephen Hemmingerf0fd27d2006-08-09 21:03:17 -0700179extern int sock_register(const struct net_proto_family *fam);
180extern void sock_unregister(int family);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181extern int sock_create(int family, int type, int proto,
182 struct socket **res);
183extern int sock_create_kern(int family, int type, int proto,
184 struct socket **res);
185extern int sock_create_lite(int family, int type, int proto,
186 struct socket **res);
187extern void sock_release(struct socket *sock);
188extern int sock_sendmsg(struct socket *sock, struct msghdr *msg,
189 size_t len);
190extern int sock_recvmsg(struct socket *sock, struct msghdr *msg,
191 size_t size, int flags);
192extern int sock_map_fd(struct socket *sock);
193extern struct socket *sockfd_lookup(int fd, int *err);
194#define sockfd_put(sock) fput(sock->file)
195extern int net_ratelimit(void);
196extern unsigned long net_random(void);
197extern void net_srandom(unsigned long);
198extern void net_random_init(void);
199
200extern int kernel_sendmsg(struct socket *sock, struct msghdr *msg,
201 struct kvec *vec, size_t num, size_t len);
202extern int kernel_recvmsg(struct socket *sock, struct msghdr *msg,
203 struct kvec *vec, size_t num,
204 size_t len, int flags);
205
Sridhar Samudralaac5a4882006-08-07 20:57:31 -0700206extern int kernel_bind(struct socket *sock, struct sockaddr *addr,
207 int addrlen);
208extern int kernel_listen(struct socket *sock, int backlog);
209extern int kernel_accept(struct socket *sock, struct socket **newsock,
210 int flags);
211extern int kernel_connect(struct socket *sock, struct sockaddr *addr,
212 int addrlen, int flags);
213extern int kernel_getsockname(struct socket *sock, struct sockaddr *addr,
214 int *addrlen);
215extern int kernel_getpeername(struct socket *sock, struct sockaddr *addr,
216 int *addrlen);
217extern int kernel_getsockopt(struct socket *sock, int level, int optname,
218 char *optval, int *optlen);
219extern int kernel_setsockopt(struct socket *sock, int level, int optname,
220 char *optval, int optlen);
221extern int kernel_sendpage(struct socket *sock, struct page *page, int offset,
222 size_t size, int flags);
223extern int kernel_sock_ioctl(struct socket *sock, int cmd, unsigned long arg);
224
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225#ifndef CONFIG_SMP
226#define SOCKOPS_WRAPPED(name) name
227#define SOCKOPS_WRAP(name, fam)
228#else
229
230#define SOCKOPS_WRAPPED(name) __unlocked_##name
231
232#define SOCKCALL_WRAP(name, call, parms, args) \
233static int __lock_##name##_##call parms \
234{ \
235 int ret; \
236 lock_kernel(); \
237 ret = __unlocked_##name##_ops.call args ;\
238 unlock_kernel(); \
239 return ret; \
240}
241
242#define SOCKCALL_UWRAP(name, call, parms, args) \
243static unsigned int __lock_##name##_##call parms \
244{ \
245 int ret; \
246 lock_kernel(); \
247 ret = __unlocked_##name##_ops.call args ;\
248 unlock_kernel(); \
249 return ret; \
250}
251
252
253#define SOCKOPS_WRAP(name, fam) \
254SOCKCALL_WRAP(name, release, (struct socket *sock), (sock)) \
255SOCKCALL_WRAP(name, bind, (struct socket *sock, struct sockaddr *uaddr, int addr_len), \
256 (sock, uaddr, addr_len)) \
257SOCKCALL_WRAP(name, connect, (struct socket *sock, struct sockaddr * uaddr, \
258 int addr_len, int flags), \
259 (sock, uaddr, addr_len, flags)) \
260SOCKCALL_WRAP(name, socketpair, (struct socket *sock1, struct socket *sock2), \
261 (sock1, sock2)) \
262SOCKCALL_WRAP(name, accept, (struct socket *sock, struct socket *newsock, \
263 int flags), (sock, newsock, flags)) \
264SOCKCALL_WRAP(name, getname, (struct socket *sock, struct sockaddr *uaddr, \
265 int *addr_len, int peer), (sock, uaddr, addr_len, peer)) \
266SOCKCALL_UWRAP(name, poll, (struct file *file, struct socket *sock, struct poll_table_struct *wait), \
267 (file, sock, wait)) \
268SOCKCALL_WRAP(name, ioctl, (struct socket *sock, unsigned int cmd, \
269 unsigned long arg), (sock, cmd, arg)) \
Shaun Pereira89bbfc92006-03-21 23:58:08 -0800270SOCKCALL_WRAP(name, compat_ioctl, (struct socket *sock, unsigned int cmd, \
271 unsigned long arg), (sock, cmd, arg)) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272SOCKCALL_WRAP(name, listen, (struct socket *sock, int len), (sock, len)) \
273SOCKCALL_WRAP(name, shutdown, (struct socket *sock, int flags), (sock, flags)) \
274SOCKCALL_WRAP(name, setsockopt, (struct socket *sock, int level, int optname, \
275 char __user *optval, int optlen), (sock, level, optname, optval, optlen)) \
276SOCKCALL_WRAP(name, getsockopt, (struct socket *sock, int level, int optname, \
277 char __user *optval, int __user *optlen), (sock, level, optname, optval, optlen)) \
278SOCKCALL_WRAP(name, sendmsg, (struct kiocb *iocb, struct socket *sock, struct msghdr *m, size_t len), \
279 (iocb, sock, m, len)) \
280SOCKCALL_WRAP(name, recvmsg, (struct kiocb *iocb, struct socket *sock, struct msghdr *m, size_t len, int flags), \
281 (iocb, sock, m, len, flags)) \
282SOCKCALL_WRAP(name, mmap, (struct file *file, struct socket *sock, struct vm_area_struct *vma), \
283 (file, sock, vma)) \
284 \
Eric Dumazet90ddc4f2005-12-22 12:49:22 -0800285static const struct proto_ops name##_ops = { \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286 .family = fam, \
287 .owner = THIS_MODULE, \
288 .release = __lock_##name##_release, \
289 .bind = __lock_##name##_bind, \
290 .connect = __lock_##name##_connect, \
291 .socketpair = __lock_##name##_socketpair, \
292 .accept = __lock_##name##_accept, \
293 .getname = __lock_##name##_getname, \
294 .poll = __lock_##name##_poll, \
295 .ioctl = __lock_##name##_ioctl, \
Shaun Pereira89bbfc92006-03-21 23:58:08 -0800296 .compat_ioctl = __lock_##name##_compat_ioctl, \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297 .listen = __lock_##name##_listen, \
298 .shutdown = __lock_##name##_shutdown, \
299 .setsockopt = __lock_##name##_setsockopt, \
300 .getsockopt = __lock_##name##_getsockopt, \
301 .sendmsg = __lock_##name##_sendmsg, \
302 .recvmsg = __lock_##name##_recvmsg, \
303 .mmap = __lock_##name##_mmap, \
304};
Shaun Pereira89bbfc92006-03-21 23:58:08 -0800305
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306#endif
307
308#define MODULE_ALIAS_NETPROTO(proto) \
309 MODULE_ALIAS("net-pf-" __stringify(proto))
310
Harald Welte4fdb3bb2005-08-09 19:40:55 -0700311#define MODULE_ALIAS_NET_PF_PROTO(pf, proto) \
312 MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto))
313
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -0300314#ifdef CONFIG_SYSCTL
315#include <linux/sysctl.h>
316extern ctl_table net_table[];
317extern int net_msg_cost;
318extern int net_msg_burst;
319#endif
320
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321#endif /* __KERNEL__ */
322#endif /* _LINUX_NET_H */