]> bbs.cooldavid.org Git - net-next-2.6.git/blame - include/linux/net.h
linux/net.h: fix kernel-doc warnings
[net-next-2.6.git] / include / linux / net.h
CommitLineData
1da177e4
LT
1/*
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>
02c30a84 10 * Ross Biro
1da177e4
LT
11 * 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
0098b727 21#include <linux/socket.h>
1da177e4
LT
22#include <asm/socket.h>
23
0098b727 24#define NPROTO AF_MAX
1da177e4
LT
25
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) */
de11defe 43#define SYS_ACCEPT4 18 /* sys_accept4(2) */
a2e27255 44#define SYS_RECVMMSG 19 /* sys_recvmmsg(2) */
1da177e4
LT
45
46typedef enum {
47 SS_FREE = 0, /* not allocated */
48 SS_UNCONNECTED, /* unconnected to any socket */
49 SS_CONNECTING, /* in process of connecting */
50 SS_CONNECTED, /* connected to socket */
51 SS_DISCONNECTING /* in process of disconnecting */
52} socket_state;
53
54#define __SO_ACCEPTCON (1 << 16) /* performed a listen */
55
56#ifdef __KERNEL__
eacf17bd 57#include <linux/stringify.h>
cb4db4c2 58#include <linux/random.h>
5770a3fb
DW
59#include <linux/wait.h>
60#include <linux/fcntl.h> /* For O_CLOEXEC and O_NONBLOCK */
29a020d3 61#include <linux/kmemcheck.h>
43815482 62#include <linux/rcupdate.h>
5770a3fb
DW
63
64struct poll_table_struct;
65struct pipe_inode_info;
66struct inode;
67struct net;
1da177e4
LT
68
69#define SOCK_ASYNC_NOSPACE 0
70#define SOCK_ASYNC_WAITDATA 1
71#define SOCK_NOSPACE 2
72#define SOCK_PASSCRED 3
877ce7c1 73#define SOCK_PASSSEC 4
1da177e4
LT
74
75#ifndef ARCH_HAS_SOCKET_TYPES
4dc3b16b
PP
76/**
77 * enum sock_type - Socket types
78 * @SOCK_STREAM: stream (connection) socket
79 * @SOCK_DGRAM: datagram (conn.less) socket
80 * @SOCK_RAW: raw socket
81 * @SOCK_RDM: reliably-delivered message
82 * @SOCK_SEQPACKET: sequential packet socket
8f2709b5 83 * @SOCK_DCCP: Datagram Congestion Control Protocol socket
4dc3b16b
PP
84 * @SOCK_PACKET: linux specific way of getting packets at the dev level.
85 * For writing rarp and other similar things on the user level.
86 *
1da177e4
LT
87 * When adding some new socket type please
88 * grep ARCH_HAS_SOCKET_TYPE include/asm-* /socket.h, at least MIPS
89 * overrides this enum for binary compat reasons.
1da177e4
LT
90 */
91enum sock_type {
92 SOCK_STREAM = 1,
93 SOCK_DGRAM = 2,
94 SOCK_RAW = 3,
95 SOCK_RDM = 4,
96 SOCK_SEQPACKET = 5,
7c657876 97 SOCK_DCCP = 6,
1da177e4
LT
98 SOCK_PACKET = 10,
99};
100
101#define SOCK_MAX (SOCK_PACKET + 1)
a677a039
UD
102/* Mask which covers at least up to SOCK_MASK-1. The
103 * remaining bits are used as flags. */
104#define SOCK_TYPE_MASK 0xf
105
de11defe 106/* Flags for socket, socketpair, accept4 */
a677a039 107#define SOCK_CLOEXEC O_CLOEXEC
c019bbc6
UD
108#ifndef SOCK_NONBLOCK
109#define SOCK_NONBLOCK O_NONBLOCK
110#endif
1da177e4
LT
111
112#endif /* ARCH_HAS_SOCKET_TYPES */
113
91cf45f0
TM
114enum sock_shutdown_cmd {
115 SHUT_RD = 0,
116 SHUT_WR = 1,
117 SHUT_RDWR = 2,
118};
119
43815482
ED
120struct socket_wq {
121 wait_queue_head_t wait;
122 struct fasync_struct *fasync_list;
123 struct rcu_head rcu;
124} ____cacheline_aligned_in_smp;
125
1da177e4
LT
126/**
127 * struct socket - general BSD socket
4dc3b16b 128 * @state: socket state (%SS_CONNECTED, etc)
2c693610 129 * @type: socket type (%SOCK_STREAM, etc)
4dc3b16b
PP
130 * @flags: socket flags (%SOCK_ASYNC_NOSPACE, etc)
131 * @ops: protocol specific socket operations
4dc3b16b
PP
132 * @file: File back pointer for gc
133 * @sk: internal networking protocol agnostic socket representation
e2aec372 134 * @wq: wait queue for several uses
1da177e4
LT
135 */
136struct socket {
137 socket_state state;
29a020d3
ED
138
139 kmemcheck_bitfield_begin(type);
2c693610 140 short type;
29a020d3
ED
141 kmemcheck_bitfield_end(type);
142
1da177e4 143 unsigned long flags;
43815482
ED
144
145 struct socket_wq *wq;
8bdd663a 146
1da177e4
LT
147 struct file *file;
148 struct sock *sk;
8bdd663a 149 const struct proto_ops *ops;
1da177e4
LT
150};
151
152struct vm_area_struct;
153struct page;
154struct kiocb;
155struct sockaddr;
156struct msghdr;
157struct module;
158
159struct proto_ops {
160 int family;
161 struct module *owner;
162 int (*release) (struct socket *sock);
163 int (*bind) (struct socket *sock,
164 struct sockaddr *myaddr,
165 int sockaddr_len);
166 int (*connect) (struct socket *sock,
167 struct sockaddr *vaddr,
168 int sockaddr_len, int flags);
169 int (*socketpair)(struct socket *sock1,
170 struct socket *sock2);
171 int (*accept) (struct socket *sock,
172 struct socket *newsock, int flags);
173 int (*getname) (struct socket *sock,
174 struct sockaddr *addr,
175 int *sockaddr_len, int peer);
176 unsigned int (*poll) (struct file *file, struct socket *sock,
177 struct poll_table_struct *wait);
178 int (*ioctl) (struct socket *sock, unsigned int cmd,
179 unsigned long arg);
1621e094 180#ifdef CONFIG_COMPAT
89bbfc95
SP
181 int (*compat_ioctl) (struct socket *sock, unsigned int cmd,
182 unsigned long arg);
1621e094 183#endif
1da177e4
LT
184 int (*listen) (struct socket *sock, int len);
185 int (*shutdown) (struct socket *sock, int flags);
186 int (*setsockopt)(struct socket *sock, int level,
b7058842 187 int optname, char __user *optval, unsigned int optlen);
1da177e4
LT
188 int (*getsockopt)(struct socket *sock, int level,
189 int optname, char __user *optval, int __user *optlen);
1621e094 190#ifdef CONFIG_COMPAT
3fdadf7d 191 int (*compat_setsockopt)(struct socket *sock, int level,
b7058842 192 int optname, char __user *optval, unsigned int optlen);
3fdadf7d
DM
193 int (*compat_getsockopt)(struct socket *sock, int level,
194 int optname, char __user *optval, int __user *optlen);
1621e094 195#endif
1da177e4
LT
196 int (*sendmsg) (struct kiocb *iocb, struct socket *sock,
197 struct msghdr *m, size_t total_len);
198 int (*recvmsg) (struct kiocb *iocb, struct socket *sock,
199 struct msghdr *m, size_t total_len,
200 int flags);
201 int (*mmap) (struct file *file, struct socket *sock,
202 struct vm_area_struct * vma);
203 ssize_t (*sendpage) (struct socket *sock, struct page *page,
204 int offset, size_t size, int flags);
9c55e01c
JA
205 ssize_t (*splice_read)(struct socket *sock, loff_t *ppos,
206 struct pipe_inode_info *pipe, size_t len, unsigned int flags);
1da177e4
LT
207};
208
38bfd8f5
CG
209#define DECLARE_SOCKADDR(type, dst, src) \
210 type dst = ({ __sockaddr_check_size(sizeof(*dst)); (type) src; })
211
1da177e4
LT
212struct net_proto_family {
213 int family;
3f378b68
EP
214 int (*create)(struct net *net, struct socket *sock,
215 int protocol, int kern);
1da177e4
LT
216 struct module *owner;
217};
218
219struct iovec;
220struct kvec;
221
8d8ad9d7
PE
222enum {
223 SOCK_WAKE_IO,
224 SOCK_WAKE_WAITD,
225 SOCK_WAKE_SPACE,
226 SOCK_WAKE_URG,
227};
228
1da177e4 229extern int sock_wake_async(struct socket *sk, int how, int band);
f0fd27d4
SH
230extern int sock_register(const struct net_proto_family *fam);
231extern void sock_unregister(int family);
1da177e4
LT
232extern int sock_create(int family, int type, int proto,
233 struct socket **res);
234extern int sock_create_kern(int family, int type, int proto,
235 struct socket **res);
236extern int sock_create_lite(int family, int type, int proto,
237 struct socket **res);
238extern void sock_release(struct socket *sock);
239extern int sock_sendmsg(struct socket *sock, struct msghdr *msg,
240 size_t len);
241extern int sock_recvmsg(struct socket *sock, struct msghdr *msg,
242 size_t size, int flags);
a677a039 243extern int sock_map_fd(struct socket *sock, int flags);
1da177e4
LT
244extern struct socket *sockfd_lookup(int fd, int *err);
245#define sockfd_put(sock) fput(sock->file)
246extern int net_ratelimit(void);
aaa248f6
SH
247
248#define net_random() random32()
a64b78a0 249#define net_srandom(seed) srandom32((__force u32)seed)
1da177e4
LT
250
251extern int kernel_sendmsg(struct socket *sock, struct msghdr *msg,
252 struct kvec *vec, size_t num, size_t len);
253extern int kernel_recvmsg(struct socket *sock, struct msghdr *msg,
254 struct kvec *vec, size_t num,
255 size_t len, int flags);
256
ac5a488e
SS
257extern int kernel_bind(struct socket *sock, struct sockaddr *addr,
258 int addrlen);
259extern int kernel_listen(struct socket *sock, int backlog);
260extern int kernel_accept(struct socket *sock, struct socket **newsock,
261 int flags);
262extern int kernel_connect(struct socket *sock, struct sockaddr *addr,
263 int addrlen, int flags);
264extern int kernel_getsockname(struct socket *sock, struct sockaddr *addr,
265 int *addrlen);
266extern int kernel_getpeername(struct socket *sock, struct sockaddr *addr,
267 int *addrlen);
268extern int kernel_getsockopt(struct socket *sock, int level, int optname,
269 char *optval, int *optlen);
270extern int kernel_setsockopt(struct socket *sock, int level, int optname,
b7058842 271 char *optval, unsigned int optlen);
ac5a488e
SS
272extern int kernel_sendpage(struct socket *sock, struct page *page, int offset,
273 size_t size, int flags);
274extern int kernel_sock_ioctl(struct socket *sock, int cmd, unsigned long arg);
91cf45f0
TM
275extern int kernel_sock_shutdown(struct socket *sock,
276 enum sock_shutdown_cmd how);
ac5a488e 277
1da177e4
LT
278#define MODULE_ALIAS_NETPROTO(proto) \
279 MODULE_ALIAS("net-pf-" __stringify(proto))
280
4fdb3bb7
HW
281#define MODULE_ALIAS_NET_PF_PROTO(pf, proto) \
282 MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto))
283
305e1e96
JD
284#define MODULE_ALIAS_NET_PF_PROTO_TYPE(pf, proto, type) \
285 MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto) \
286 "-type-" __stringify(type))
287
20380731
ACM
288#ifdef CONFIG_SYSCTL
289#include <linux/sysctl.h>
3fff4c42 290#include <linux/ratelimit.h>
717115e1 291extern struct ratelimit_state net_ratelimit_state;
20380731
ACM
292#endif
293
1da177e4
LT
294#endif /* __KERNEL__ */
295#endif /* _LINUX_NET_H */