blob: 28195a2d8ff0a50501a5ab180ef6bf3b252cbb28 [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
21#include <linux/config.h>
22#include <linux/wait.h>
23#include <linux/stringify.h>
24#include <asm/socket.h>
25
26struct poll_table_struct;
27struct inode;
28
29#define NPROTO 32 /* should be enough for now.. */
30
31#define SYS_SOCKET 1 /* sys_socket(2) */
32#define SYS_BIND 2 /* sys_bind(2) */
33#define SYS_CONNECT 3 /* sys_connect(2) */
34#define SYS_LISTEN 4 /* sys_listen(2) */
35#define SYS_ACCEPT 5 /* sys_accept(2) */
36#define SYS_GETSOCKNAME 6 /* sys_getsockname(2) */
37#define SYS_GETPEERNAME 7 /* sys_getpeername(2) */
38#define SYS_SOCKETPAIR 8 /* sys_socketpair(2) */
39#define SYS_SEND 9 /* sys_send(2) */
40#define SYS_RECV 10 /* sys_recv(2) */
41#define SYS_SENDTO 11 /* sys_sendto(2) */
42#define SYS_RECVFROM 12 /* sys_recvfrom(2) */
43#define SYS_SHUTDOWN 13 /* sys_shutdown(2) */
44#define SYS_SETSOCKOPT 14 /* sys_setsockopt(2) */
45#define SYS_GETSOCKOPT 15 /* sys_getsockopt(2) */
46#define SYS_SENDMSG 16 /* sys_sendmsg(2) */
47#define SYS_RECVMSG 17 /* sys_recvmsg(2) */
48
49typedef enum {
50 SS_FREE = 0, /* not allocated */
51 SS_UNCONNECTED, /* unconnected to any socket */
52 SS_CONNECTING, /* in process of connecting */
53 SS_CONNECTED, /* connected to socket */
54 SS_DISCONNECTING /* in process of disconnecting */
55} socket_state;
56
57#define __SO_ACCEPTCON (1 << 16) /* performed a listen */
58
59#ifdef __KERNEL__
60
61#define SOCK_ASYNC_NOSPACE 0
62#define SOCK_ASYNC_WAITDATA 1
63#define SOCK_NOSPACE 2
64#define SOCK_PASSCRED 3
65
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);
146 int (*listen) (struct socket *sock, int len);
147 int (*shutdown) (struct socket *sock, int flags);
148 int (*setsockopt)(struct socket *sock, int level,
149 int optname, char __user *optval, int optlen);
150 int (*getsockopt)(struct socket *sock, int level,
151 int optname, char __user *optval, int __user *optlen);
152 int (*sendmsg) (struct kiocb *iocb, struct socket *sock,
153 struct msghdr *m, size_t total_len);
154 int (*recvmsg) (struct kiocb *iocb, struct socket *sock,
155 struct msghdr *m, size_t total_len,
156 int flags);
157 int (*mmap) (struct file *file, struct socket *sock,
158 struct vm_area_struct * vma);
159 ssize_t (*sendpage) (struct socket *sock, struct page *page,
160 int offset, size_t size, int flags);
161};
162
163struct net_proto_family {
164 int family;
165 int (*create)(struct socket *sock, int protocol);
166 /* These are counters for the number of different methods of
167 each we support */
168 short authentication;
169 short encryption;
170 short encrypt_net;
171 struct module *owner;
172};
173
174struct iovec;
175struct kvec;
176
177extern int sock_wake_async(struct socket *sk, int how, int band);
178extern int sock_register(struct net_proto_family *fam);
179extern int sock_unregister(int family);
180extern int sock_create(int family, int type, int proto,
181 struct socket **res);
182extern int sock_create_kern(int family, int type, int proto,
183 struct socket **res);
184extern int sock_create_lite(int family, int type, int proto,
185 struct socket **res);
186extern void sock_release(struct socket *sock);
187extern int sock_sendmsg(struct socket *sock, struct msghdr *msg,
188 size_t len);
189extern int sock_recvmsg(struct socket *sock, struct msghdr *msg,
190 size_t size, int flags);
191extern int sock_map_fd(struct socket *sock);
192extern struct socket *sockfd_lookup(int fd, int *err);
193#define sockfd_put(sock) fput(sock->file)
194extern int net_ratelimit(void);
195extern unsigned long net_random(void);
196extern void net_srandom(unsigned long);
197extern void net_random_init(void);
198
199extern int kernel_sendmsg(struct socket *sock, struct msghdr *msg,
200 struct kvec *vec, size_t num, size_t len);
201extern int kernel_recvmsg(struct socket *sock, struct msghdr *msg,
202 struct kvec *vec, size_t num,
203 size_t len, int flags);
204
205#ifndef CONFIG_SMP
206#define SOCKOPS_WRAPPED(name) name
207#define SOCKOPS_WRAP(name, fam)
208#else
209
210#define SOCKOPS_WRAPPED(name) __unlocked_##name
211
212#define SOCKCALL_WRAP(name, call, parms, args) \
213static int __lock_##name##_##call parms \
214{ \
215 int ret; \
216 lock_kernel(); \
217 ret = __unlocked_##name##_ops.call args ;\
218 unlock_kernel(); \
219 return ret; \
220}
221
222#define SOCKCALL_UWRAP(name, call, parms, args) \
223static unsigned int __lock_##name##_##call parms \
224{ \
225 int ret; \
226 lock_kernel(); \
227 ret = __unlocked_##name##_ops.call args ;\
228 unlock_kernel(); \
229 return ret; \
230}
231
232
233#define SOCKOPS_WRAP(name, fam) \
234SOCKCALL_WRAP(name, release, (struct socket *sock), (sock)) \
235SOCKCALL_WRAP(name, bind, (struct socket *sock, struct sockaddr *uaddr, int addr_len), \
236 (sock, uaddr, addr_len)) \
237SOCKCALL_WRAP(name, connect, (struct socket *sock, struct sockaddr * uaddr, \
238 int addr_len, int flags), \
239 (sock, uaddr, addr_len, flags)) \
240SOCKCALL_WRAP(name, socketpair, (struct socket *sock1, struct socket *sock2), \
241 (sock1, sock2)) \
242SOCKCALL_WRAP(name, accept, (struct socket *sock, struct socket *newsock, \
243 int flags), (sock, newsock, flags)) \
244SOCKCALL_WRAP(name, getname, (struct socket *sock, struct sockaddr *uaddr, \
245 int *addr_len, int peer), (sock, uaddr, addr_len, peer)) \
246SOCKCALL_UWRAP(name, poll, (struct file *file, struct socket *sock, struct poll_table_struct *wait), \
247 (file, sock, wait)) \
248SOCKCALL_WRAP(name, ioctl, (struct socket *sock, unsigned int cmd, \
249 unsigned long arg), (sock, cmd, arg)) \
250SOCKCALL_WRAP(name, listen, (struct socket *sock, int len), (sock, len)) \
251SOCKCALL_WRAP(name, shutdown, (struct socket *sock, int flags), (sock, flags)) \
252SOCKCALL_WRAP(name, setsockopt, (struct socket *sock, int level, int optname, \
253 char __user *optval, int optlen), (sock, level, optname, optval, optlen)) \
254SOCKCALL_WRAP(name, getsockopt, (struct socket *sock, int level, int optname, \
255 char __user *optval, int __user *optlen), (sock, level, optname, optval, optlen)) \
256SOCKCALL_WRAP(name, sendmsg, (struct kiocb *iocb, struct socket *sock, struct msghdr *m, size_t len), \
257 (iocb, sock, m, len)) \
258SOCKCALL_WRAP(name, recvmsg, (struct kiocb *iocb, struct socket *sock, struct msghdr *m, size_t len, int flags), \
259 (iocb, sock, m, len, flags)) \
260SOCKCALL_WRAP(name, mmap, (struct file *file, struct socket *sock, struct vm_area_struct *vma), \
261 (file, sock, vma)) \
262 \
Eric Dumazet90ddc4f2005-12-22 12:49:22 -0800263static const struct proto_ops name##_ops = { \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264 .family = fam, \
265 .owner = THIS_MODULE, \
266 .release = __lock_##name##_release, \
267 .bind = __lock_##name##_bind, \
268 .connect = __lock_##name##_connect, \
269 .socketpair = __lock_##name##_socketpair, \
270 .accept = __lock_##name##_accept, \
271 .getname = __lock_##name##_getname, \
272 .poll = __lock_##name##_poll, \
273 .ioctl = __lock_##name##_ioctl, \
274 .listen = __lock_##name##_listen, \
275 .shutdown = __lock_##name##_shutdown, \
276 .setsockopt = __lock_##name##_setsockopt, \
277 .getsockopt = __lock_##name##_getsockopt, \
278 .sendmsg = __lock_##name##_sendmsg, \
279 .recvmsg = __lock_##name##_recvmsg, \
280 .mmap = __lock_##name##_mmap, \
281};
282#endif
283
284#define MODULE_ALIAS_NETPROTO(proto) \
285 MODULE_ALIAS("net-pf-" __stringify(proto))
286
Harald Welte4fdb3bb2005-08-09 19:40:55 -0700287#define MODULE_ALIAS_NET_PF_PROTO(pf, proto) \
288 MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto))
289
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -0300290#ifdef CONFIG_SYSCTL
291#include <linux/sysctl.h>
292extern ctl_table net_table[];
293extern int net_msg_cost;
294extern int net_msg_burst;
295#endif
296
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297#endif /* __KERNEL__ */
298#endif /* _LINUX_NET_H */