blob: 16faa130088c298fe8540b7fa29d365d0ea579b7 [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
Rusty Russell0098b722008-03-22 17:18:47 -070021#include <linux/socket.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <asm/socket.h>
23
Rusty Russell0098b722008-03-22 17:18:47 -070024#define NPROTO AF_MAX
Linus Torvalds1da177e2005-04-16 15:20:36 -070025
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) */
Ulrich Drepperde11def2008-11-19 15:36:14 -080043#define SYS_ACCEPT4 18 /* sys_accept4(2) */
Arnaldo Carvalho de Meloa2e27252009-10-12 23:40:10 -070044#define SYS_RECVMMSG 19 /* sys_recvmmsg(2) */
Linus Torvalds1da177e2005-04-16 15:20:36 -070045
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__
David Woodhouseeacf17b2006-04-25 14:46:09 +010057#include <linux/stringify.h>
David Woodhousecb4db4c2006-12-28 21:21:55 -080058#include <linux/random.h>
David Woodhouse5770a3f2008-08-26 15:29:22 +010059#include <linux/wait.h>
60#include <linux/fcntl.h> /* For O_CLOEXEC and O_NONBLOCK */
Eric Dumazet29a020d2009-09-15 02:39:20 -070061#include <linux/kmemcheck.h>
Eric Dumazet43815482010-04-29 11:01:49 +000062#include <linux/rcupdate.h>
David Woodhouse5770a3f2008-08-26 15:29:22 +010063
64struct poll_table_struct;
65struct pipe_inode_info;
66struct inode;
67struct net;
Linus Torvalds1da177e2005-04-16 15:20:36 -070068
69#define SOCK_ASYNC_NOSPACE 0
70#define SOCK_ASYNC_WAITDATA 1
71#define SOCK_NOSPACE 2
72#define SOCK_PASSCRED 3
Catherine Zhang877ce7c2006-06-29 12:27:47 -070073#define SOCK_PASSSEC 4
Linus Torvalds1da177e2005-04-16 15:20:36 -070074
75#ifndef ARCH_HAS_SOCKET_TYPES
Pavel Pisa4dc3b162005-05-01 08:59:25 -070076/**
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
Randy Dunlap8f2709b2005-11-07 01:01:05 -080083 * @SOCK_DCCP: Datagram Congestion Control Protocol socket
Pavel Pisa4dc3b162005-05-01 08:59:25 -070084 * @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 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070087 * 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -070090 */
91enum sock_type {
92 SOCK_STREAM = 1,
93 SOCK_DGRAM = 2,
94 SOCK_RAW = 3,
95 SOCK_RDM = 4,
96 SOCK_SEQPACKET = 5,
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -070097 SOCK_DCCP = 6,
Linus Torvalds1da177e2005-04-16 15:20:36 -070098 SOCK_PACKET = 10,
99};
100
101#define SOCK_MAX (SOCK_PACKET + 1)
Ulrich Dreppera677a032008-07-23 21:29:17 -0700102/* 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
Ulrich Drepperde11def2008-11-19 15:36:14 -0800106/* Flags for socket, socketpair, accept4 */
Ulrich Dreppera677a032008-07-23 21:29:17 -0700107#define SOCK_CLOEXEC O_CLOEXEC
Ulrich Drepperc019bbc2008-07-23 21:29:21 -0700108#ifndef SOCK_NONBLOCK
109#define SOCK_NONBLOCK O_NONBLOCK
110#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111
112#endif /* ARCH_HAS_SOCKET_TYPES */
113
Trond Myklebust91cf45f2007-11-12 18:10:39 -0800114enum sock_shutdown_cmd {
115 SHUT_RD = 0,
116 SHUT_WR = 1,
117 SHUT_RDWR = 2,
118};
119
Eric Dumazet43815482010-04-29 11:01:49 +0000120struct 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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126/**
127 * struct socket - general BSD socket
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700128 * @state: socket state (%SS_CONNECTED, etc)
Richard Kennedy2c693612008-07-08 03:03:01 -0700129 * @type: socket type (%SOCK_STREAM, etc)
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700130 * @flags: socket flags (%SOCK_ASYNC_NOSPACE, etc)
131 * @ops: protocol specific socket operations
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700132 * @file: File back pointer for gc
133 * @sk: internal networking protocol agnostic socket representation
Randy Dunlape2aec372010-07-01 13:18:58 +0000134 * @wq: wait queue for several uses
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 */
136struct socket {
137 socket_state state;
Eric Dumazet29a020d2009-09-15 02:39:20 -0700138
139 kmemcheck_bitfield_begin(type);
Richard Kennedy2c693612008-07-08 03:03:01 -0700140 short type;
Eric Dumazet29a020d2009-09-15 02:39:20 -0700141 kmemcheck_bitfield_end(type);
142
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143 unsigned long flags;
Eric Dumazet43815482010-04-29 11:01:49 +0000144
145 struct socket_wq *wq;
Eric Dumazet8bdd6632009-03-15 19:59:13 -0700146
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147 struct file *file;
148 struct sock *sk;
Eric Dumazet8bdd6632009-03-15 19:59:13 -0700149 const struct proto_ops *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150};
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);
Alexey Dobriyan1621e092010-02-01 09:44:19 +0000180#ifdef CONFIG_COMPAT
Shaun Pereira89bbfc92006-03-21 23:58:08 -0800181 int (*compat_ioctl) (struct socket *sock, unsigned int cmd,
182 unsigned long arg);
Alexey Dobriyan1621e092010-02-01 09:44:19 +0000183#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184 int (*listen) (struct socket *sock, int len);
185 int (*shutdown) (struct socket *sock, int flags);
186 int (*setsockopt)(struct socket *sock, int level,
David S. Millerb7058842009-09-30 16:12:20 -0700187 int optname, char __user *optval, unsigned int optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188 int (*getsockopt)(struct socket *sock, int level,
189 int optname, char __user *optval, int __user *optlen);
Alexey Dobriyan1621e092010-02-01 09:44:19 +0000190#ifdef CONFIG_COMPAT
Dmitry Mishin3fdadf72006-03-20 22:45:21 -0800191 int (*compat_setsockopt)(struct socket *sock, int level,
David S. Millerb7058842009-09-30 16:12:20 -0700192 int optname, char __user *optval, unsigned int optlen);
Dmitry Mishin3fdadf72006-03-20 22:45:21 -0800193 int (*compat_getsockopt)(struct socket *sock, int level,
194 int optname, char __user *optval, int __user *optlen);
Alexey Dobriyan1621e092010-02-01 09:44:19 +0000195#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196 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);
Jens Axboe9c55e012007-11-06 23:30:13 -0800205 ssize_t (*splice_read)(struct socket *sock, loff_t *ppos,
206 struct pipe_inode_info *pipe, size_t len, unsigned int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207};
208
Cyrill Gorcunov38bfd8f2009-10-29 02:59:18 -0700209#define DECLARE_SOCKADDR(type, dst, src) \
210 type dst = ({ __sockaddr_check_size(sizeof(*dst)); (type) src; })
211
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212struct net_proto_family {
213 int family;
Eric Paris3f378b62009-11-05 22:18:14 -0800214 int (*create)(struct net *net, struct socket *sock,
215 int protocol, int kern);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216 struct module *owner;
217};
218
219struct iovec;
220struct kvec;
221
Pavel Emelyanov8d8ad9d2007-11-26 20:10:50 +0800222enum {
223 SOCK_WAKE_IO,
224 SOCK_WAKE_WAITD,
225 SOCK_WAKE_SPACE,
226 SOCK_WAKE_URG,
227};
228
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229extern int sock_wake_async(struct socket *sk, int how, int band);
Stephen Hemmingerf0fd27d2006-08-09 21:03:17 -0700230extern int sock_register(const struct net_proto_family *fam);
231extern void sock_unregister(int family);
Pavel Emelyanov721db932010-09-29 16:06:32 +0400232extern int __sock_create(struct net *net, int family, int type, int proto,
233 struct socket **res, int kern);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234extern int sock_create(int family, int type, int proto,
235 struct socket **res);
236extern int sock_create_kern(int family, int type, int proto,
237 struct socket **res);
238extern int sock_create_lite(int family, int type, int proto,
239 struct socket **res);
240extern void sock_release(struct socket *sock);
241extern int sock_sendmsg(struct socket *sock, struct msghdr *msg,
242 size_t len);
243extern int sock_recvmsg(struct socket *sock, struct msghdr *msg,
244 size_t size, int flags);
Ulrich Dreppera677a032008-07-23 21:29:17 -0700245extern int sock_map_fd(struct socket *sock, int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246extern struct socket *sockfd_lookup(int fd, int *err);
247#define sockfd_put(sock) fput(sock->file)
248extern int net_ratelimit(void);
Stephen Hemmingeraaa248f2006-10-17 00:09:42 -0700249
250#define net_random() random32()
Al Viroa64b78a2006-11-14 21:12:29 -0800251#define net_srandom(seed) srandom32((__force u32)seed)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252
253extern int kernel_sendmsg(struct socket *sock, struct msghdr *msg,
254 struct kvec *vec, size_t num, size_t len);
255extern int kernel_recvmsg(struct socket *sock, struct msghdr *msg,
256 struct kvec *vec, size_t num,
257 size_t len, int flags);
258
Sridhar Samudralaac5a4882006-08-07 20:57:31 -0700259extern int kernel_bind(struct socket *sock, struct sockaddr *addr,
260 int addrlen);
261extern int kernel_listen(struct socket *sock, int backlog);
262extern int kernel_accept(struct socket *sock, struct socket **newsock,
263 int flags);
264extern int kernel_connect(struct socket *sock, struct sockaddr *addr,
265 int addrlen, int flags);
266extern int kernel_getsockname(struct socket *sock, struct sockaddr *addr,
267 int *addrlen);
268extern int kernel_getpeername(struct socket *sock, struct sockaddr *addr,
269 int *addrlen);
270extern int kernel_getsockopt(struct socket *sock, int level, int optname,
271 char *optval, int *optlen);
272extern int kernel_setsockopt(struct socket *sock, int level, int optname,
David S. Millerb7058842009-09-30 16:12:20 -0700273 char *optval, unsigned int optlen);
Sridhar Samudralaac5a4882006-08-07 20:57:31 -0700274extern int kernel_sendpage(struct socket *sock, struct page *page, int offset,
275 size_t size, int flags);
276extern int kernel_sock_ioctl(struct socket *sock, int cmd, unsigned long arg);
Trond Myklebust91cf45f2007-11-12 18:10:39 -0800277extern int kernel_sock_shutdown(struct socket *sock,
278 enum sock_shutdown_cmd how);
Sridhar Samudralaac5a4882006-08-07 20:57:31 -0700279
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280#define MODULE_ALIAS_NETPROTO(proto) \
281 MODULE_ALIAS("net-pf-" __stringify(proto))
282
Harald Welte4fdb3bb2005-08-09 19:40:55 -0700283#define MODULE_ALIAS_NET_PF_PROTO(pf, proto) \
284 MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto))
285
Jean Delvare305e1e92007-10-21 16:44:04 -0700286#define MODULE_ALIAS_NET_PF_PROTO_TYPE(pf, proto, type) \
287 MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto) \
288 "-type-" __stringify(type))
289
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -0300290#ifdef CONFIG_SYSCTL
291#include <linux/sysctl.h>
Ingo Molnar3fff4c42009-09-22 16:18:09 +0200292#include <linux/ratelimit.h>
Dave Young717115e2008-07-25 01:45:58 -0700293extern struct ratelimit_state net_ratelimit_state;
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -0300294#endif
295
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296#endif /* __KERNEL__ */
297#endif /* _LINUX_NET_H */