blob: b29923006b11e50b4aac2c99f9a81be14afc7fd1 [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) */
Anton Blanchard228e5482011-05-02 20:21:35 +000045#define SYS_SENDMMSG 20 /* sys_sendmmsg(2) */
Linus Torvalds1da177e2005-04-16 15:20:36 -070046
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>
David Woodhouse5770a3f2008-08-26 15:29:22 +010060#include <linux/wait.h>
61#include <linux/fcntl.h> /* For O_CLOEXEC and O_NONBLOCK */
Eric Dumazet29a020d2009-09-15 02:39:20 -070062#include <linux/kmemcheck.h>
Eric Dumazet43815482010-04-29 11:01:49 +000063#include <linux/rcupdate.h>
David Woodhouse5770a3f2008-08-26 15:29:22 +010064
65struct poll_table_struct;
66struct pipe_inode_info;
67struct inode;
68struct net;
Linus Torvalds1da177e2005-04-16 15:20:36 -070069
70#define SOCK_ASYNC_NOSPACE 0
71#define SOCK_ASYNC_WAITDATA 1
72#define SOCK_NOSPACE 2
73#define SOCK_PASSCRED 3
Catherine Zhang877ce7c2006-06-29 12:27:47 -070074#define SOCK_PASSSEC 4
Linus Torvalds1da177e2005-04-16 15:20:36 -070075
76#ifndef ARCH_HAS_SOCKET_TYPES
Pavel Pisa4dc3b162005-05-01 08:59:25 -070077/**
78 * enum sock_type - Socket types
79 * @SOCK_STREAM: stream (connection) socket
80 * @SOCK_DGRAM: datagram (conn.less) socket
81 * @SOCK_RAW: raw socket
82 * @SOCK_RDM: reliably-delivered message
83 * @SOCK_SEQPACKET: sequential packet socket
Randy Dunlap8f2709b2005-11-07 01:01:05 -080084 * @SOCK_DCCP: Datagram Congestion Control Protocol socket
Pavel Pisa4dc3b162005-05-01 08:59:25 -070085 * @SOCK_PACKET: linux specific way of getting packets at the dev level.
86 * For writing rarp and other similar things on the user level.
87 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070088 * When adding some new socket type please
89 * grep ARCH_HAS_SOCKET_TYPE include/asm-* /socket.h, at least MIPS
90 * overrides this enum for binary compat reasons.
Linus Torvalds1da177e2005-04-16 15:20:36 -070091 */
92enum sock_type {
93 SOCK_STREAM = 1,
94 SOCK_DGRAM = 2,
95 SOCK_RAW = 3,
96 SOCK_RDM = 4,
97 SOCK_SEQPACKET = 5,
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -070098 SOCK_DCCP = 6,
Linus Torvalds1da177e2005-04-16 15:20:36 -070099 SOCK_PACKET = 10,
100};
101
102#define SOCK_MAX (SOCK_PACKET + 1)
Ulrich Dreppera677a032008-07-23 21:29:17 -0700103/* Mask which covers at least up to SOCK_MASK-1. The
104 * remaining bits are used as flags. */
105#define SOCK_TYPE_MASK 0xf
106
Ulrich Drepperde11def2008-11-19 15:36:14 -0800107/* Flags for socket, socketpair, accept4 */
Ulrich Dreppera677a032008-07-23 21:29:17 -0700108#define SOCK_CLOEXEC O_CLOEXEC
Ulrich Drepperc019bbc2008-07-23 21:29:21 -0700109#ifndef SOCK_NONBLOCK
110#define SOCK_NONBLOCK O_NONBLOCK
111#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112
113#endif /* ARCH_HAS_SOCKET_TYPES */
114
Trond Myklebust91cf45f2007-11-12 18:10:39 -0800115enum sock_shutdown_cmd {
116 SHUT_RD = 0,
117 SHUT_WR = 1,
118 SHUT_RDWR = 2,
119};
120
Eric Dumazet43815482010-04-29 11:01:49 +0000121struct socket_wq {
Eric Dumazeteaefd112011-02-18 03:26:36 +0000122 /* Note: wait MUST be first field of socket_wq */
Eric Dumazet43815482010-04-29 11:01:49 +0000123 wait_queue_head_t wait;
124 struct fasync_struct *fasync_list;
125 struct rcu_head rcu;
126} ____cacheline_aligned_in_smp;
127
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128/**
129 * struct socket - general BSD socket
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700130 * @state: socket state (%SS_CONNECTED, etc)
Richard Kennedy2c693612008-07-08 03:03:01 -0700131 * @type: socket type (%SOCK_STREAM, etc)
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700132 * @flags: socket flags (%SOCK_ASYNC_NOSPACE, etc)
133 * @ops: protocol specific socket operations
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700134 * @file: File back pointer for gc
135 * @sk: internal networking protocol agnostic socket representation
Randy Dunlape2aec372010-07-01 13:18:58 +0000136 * @wq: wait queue for several uses
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137 */
138struct socket {
139 socket_state state;
Eric Dumazet29a020d2009-09-15 02:39:20 -0700140
141 kmemcheck_bitfield_begin(type);
Richard Kennedy2c693612008-07-08 03:03:01 -0700142 short type;
Eric Dumazet29a020d2009-09-15 02:39:20 -0700143 kmemcheck_bitfield_end(type);
144
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 unsigned long flags;
Eric Dumazet43815482010-04-29 11:01:49 +0000146
Eric Dumazeteaefd112011-02-18 03:26:36 +0000147 struct socket_wq __rcu *wq;
Eric Dumazet8bdd6632009-03-15 19:59:13 -0700148
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 struct file *file;
150 struct sock *sk;
Eric Dumazet8bdd6632009-03-15 19:59:13 -0700151 const struct proto_ops *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152};
153
154struct vm_area_struct;
155struct page;
156struct kiocb;
157struct sockaddr;
158struct msghdr;
159struct module;
160
161struct proto_ops {
162 int family;
163 struct module *owner;
164 int (*release) (struct socket *sock);
165 int (*bind) (struct socket *sock,
166 struct sockaddr *myaddr,
167 int sockaddr_len);
168 int (*connect) (struct socket *sock,
169 struct sockaddr *vaddr,
170 int sockaddr_len, int flags);
171 int (*socketpair)(struct socket *sock1,
172 struct socket *sock2);
173 int (*accept) (struct socket *sock,
174 struct socket *newsock, int flags);
175 int (*getname) (struct socket *sock,
176 struct sockaddr *addr,
177 int *sockaddr_len, int peer);
178 unsigned int (*poll) (struct file *file, struct socket *sock,
179 struct poll_table_struct *wait);
180 int (*ioctl) (struct socket *sock, unsigned int cmd,
181 unsigned long arg);
Alexey Dobriyan1621e092010-02-01 09:44:19 +0000182#ifdef CONFIG_COMPAT
Shaun Pereira89bbfc92006-03-21 23:58:08 -0800183 int (*compat_ioctl) (struct socket *sock, unsigned int cmd,
184 unsigned long arg);
Alexey Dobriyan1621e092010-02-01 09:44:19 +0000185#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 int (*listen) (struct socket *sock, int len);
187 int (*shutdown) (struct socket *sock, int flags);
188 int (*setsockopt)(struct socket *sock, int level,
David S. Millerb7058842009-09-30 16:12:20 -0700189 int optname, char __user *optval, unsigned int optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190 int (*getsockopt)(struct socket *sock, int level,
191 int optname, char __user *optval, int __user *optlen);
Alexey Dobriyan1621e092010-02-01 09:44:19 +0000192#ifdef CONFIG_COMPAT
Dmitry Mishin3fdadf72006-03-20 22:45:21 -0800193 int (*compat_setsockopt)(struct socket *sock, int level,
David S. Millerb7058842009-09-30 16:12:20 -0700194 int optname, char __user *optval, unsigned int optlen);
Dmitry Mishin3fdadf72006-03-20 22:45:21 -0800195 int (*compat_getsockopt)(struct socket *sock, int level,
196 int optname, char __user *optval, int __user *optlen);
Alexey Dobriyan1621e092010-02-01 09:44:19 +0000197#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198 int (*sendmsg) (struct kiocb *iocb, struct socket *sock,
199 struct msghdr *m, size_t total_len);
200 int (*recvmsg) (struct kiocb *iocb, struct socket *sock,
201 struct msghdr *m, size_t total_len,
202 int flags);
203 int (*mmap) (struct file *file, struct socket *sock,
204 struct vm_area_struct * vma);
205 ssize_t (*sendpage) (struct socket *sock, struct page *page,
206 int offset, size_t size, int flags);
Jens Axboe9c55e012007-11-06 23:30:13 -0800207 ssize_t (*splice_read)(struct socket *sock, loff_t *ppos,
208 struct pipe_inode_info *pipe, size_t len, unsigned int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209};
210
Cyrill Gorcunov38bfd8f2009-10-29 02:59:18 -0700211#define DECLARE_SOCKADDR(type, dst, src) \
212 type dst = ({ __sockaddr_check_size(sizeof(*dst)); (type) src; })
213
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214struct net_proto_family {
215 int family;
Eric Paris3f378b62009-11-05 22:18:14 -0800216 int (*create)(struct net *net, struct socket *sock,
217 int protocol, int kern);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218 struct module *owner;
219};
220
221struct iovec;
222struct kvec;
223
Pavel Emelyanov8d8ad9d2007-11-26 20:10:50 +0800224enum {
225 SOCK_WAKE_IO,
226 SOCK_WAKE_WAITD,
227 SOCK_WAKE_SPACE,
228 SOCK_WAKE_URG,
229};
230
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231extern int sock_wake_async(struct socket *sk, int how, int band);
Stephen Hemmingerf0fd27d2006-08-09 21:03:17 -0700232extern int sock_register(const struct net_proto_family *fam);
233extern void sock_unregister(int family);
Pavel Emelyanov721db932010-09-29 16:06:32 +0400234extern int __sock_create(struct net *net, int family, int type, int proto,
235 struct socket **res, int kern);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236extern int sock_create(int family, int type, int proto,
237 struct socket **res);
238extern int sock_create_kern(int family, int type, int proto,
239 struct socket **res);
240extern int sock_create_lite(int family, int type, int proto,
241 struct socket **res);
242extern void sock_release(struct socket *sock);
243extern int sock_sendmsg(struct socket *sock, struct msghdr *msg,
244 size_t len);
245extern int sock_recvmsg(struct socket *sock, struct msghdr *msg,
246 size_t size, int flags);
Ulrich Dreppera677a032008-07-23 21:29:17 -0700247extern int sock_map_fd(struct socket *sock, int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248extern struct socket *sockfd_lookup(int fd, int *err);
249#define sockfd_put(sock) fput(sock->file)
250extern int net_ratelimit(void);
Stephen Hemmingeraaa248f2006-10-17 00:09:42 -0700251
252#define net_random() random32()
Al Viroa64b78a2006-11-14 21:12:29 -0800253#define net_srandom(seed) srandom32((__force u32)seed)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254
255extern int kernel_sendmsg(struct socket *sock, struct msghdr *msg,
256 struct kvec *vec, size_t num, size_t len);
257extern int kernel_recvmsg(struct socket *sock, struct msghdr *msg,
258 struct kvec *vec, size_t num,
259 size_t len, int flags);
260
Sridhar Samudralaac5a4882006-08-07 20:57:31 -0700261extern int kernel_bind(struct socket *sock, struct sockaddr *addr,
262 int addrlen);
263extern int kernel_listen(struct socket *sock, int backlog);
264extern int kernel_accept(struct socket *sock, struct socket **newsock,
265 int flags);
266extern int kernel_connect(struct socket *sock, struct sockaddr *addr,
267 int addrlen, int flags);
268extern int kernel_getsockname(struct socket *sock, struct sockaddr *addr,
269 int *addrlen);
270extern int kernel_getpeername(struct socket *sock, struct sockaddr *addr,
271 int *addrlen);
272extern int kernel_getsockopt(struct socket *sock, int level, int optname,
273 char *optval, int *optlen);
274extern int kernel_setsockopt(struct socket *sock, int level, int optname,
David S. Millerb7058842009-09-30 16:12:20 -0700275 char *optval, unsigned int optlen);
Sridhar Samudralaac5a4882006-08-07 20:57:31 -0700276extern int kernel_sendpage(struct socket *sock, struct page *page, int offset,
277 size_t size, int flags);
278extern int kernel_sock_ioctl(struct socket *sock, int cmd, unsigned long arg);
Trond Myklebust91cf45f2007-11-12 18:10:39 -0800279extern int kernel_sock_shutdown(struct socket *sock,
280 enum sock_shutdown_cmd how);
Sridhar Samudralaac5a4882006-08-07 20:57:31 -0700281
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282#define MODULE_ALIAS_NETPROTO(proto) \
283 MODULE_ALIAS("net-pf-" __stringify(proto))
284
Harald Welte4fdb3bb2005-08-09 19:40:55 -0700285#define MODULE_ALIAS_NET_PF_PROTO(pf, proto) \
286 MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto))
287
Jean Delvare305e1e92007-10-21 16:44:04 -0700288#define MODULE_ALIAS_NET_PF_PROTO_TYPE(pf, proto, type) \
289 MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto) \
290 "-type-" __stringify(type))
291
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292#endif /* __KERNEL__ */
293#endif /* _LINUX_NET_H */