blob: 738ea48be889e670275616bae5063259ca3d61d9 [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
David Woodhouseeacf17b2006-04-25 14:46:09 +010021#include <linux/stringify.h>
David Woodhousecb4db4c2006-12-28 21:21:55 -080022#include <linux/random.h>
David Woodhouse5770a3f2008-08-26 15:29:22 +010023#include <linux/wait.h>
24#include <linux/fcntl.h> /* For O_CLOEXEC and O_NONBLOCK */
Eric Dumazet29a020d2009-09-15 02:39:20 -070025#include <linux/kmemcheck.h>
Eric Dumazet43815482010-04-29 11:01:49 +000026#include <linux/rcupdate.h>
Hannes Frederic Sowac68c7f52013-10-20 06:26:02 +020027#include <linux/jump_label.h>
David Howells607ca462012-10-13 10:46:48 +010028#include <uapi/linux/net.h>
David Woodhouse5770a3f2008-08-26 15:29:22 +010029
30struct poll_table_struct;
31struct pipe_inode_info;
32struct inode;
Al Viro56b31d12012-08-18 00:25:51 -040033struct file;
David Woodhouse5770a3f2008-08-26 15:29:22 +010034struct net;
Linus Torvalds1da177e2005-04-16 15:20:36 -070035
36#define SOCK_ASYNC_NOSPACE 0
37#define SOCK_ASYNC_WAITDATA 1
38#define SOCK_NOSPACE 2
39#define SOCK_PASSCRED 3
Catherine Zhang877ce7c2006-06-29 12:27:47 -070040#define SOCK_PASSSEC 4
Mikulas Patockab09e7862012-07-19 06:13:36 +000041#define SOCK_EXTERNALLY_ALLOCATED 5
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
43#ifndef ARCH_HAS_SOCKET_TYPES
Pavel Pisa4dc3b162005-05-01 08:59:25 -070044/**
45 * enum sock_type - Socket types
46 * @SOCK_STREAM: stream (connection) socket
47 * @SOCK_DGRAM: datagram (conn.less) socket
48 * @SOCK_RAW: raw socket
49 * @SOCK_RDM: reliably-delivered message
50 * @SOCK_SEQPACKET: sequential packet socket
Randy Dunlap8f2709b2005-11-07 01:01:05 -080051 * @SOCK_DCCP: Datagram Congestion Control Protocol socket
Pavel Pisa4dc3b162005-05-01 08:59:25 -070052 * @SOCK_PACKET: linux specific way of getting packets at the dev level.
53 * For writing rarp and other similar things on the user level.
54 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070055 * When adding some new socket type please
56 * grep ARCH_HAS_SOCKET_TYPE include/asm-* /socket.h, at least MIPS
57 * overrides this enum for binary compat reasons.
Linus Torvalds1da177e2005-04-16 15:20:36 -070058 */
59enum sock_type {
60 SOCK_STREAM = 1,
61 SOCK_DGRAM = 2,
62 SOCK_RAW = 3,
63 SOCK_RDM = 4,
64 SOCK_SEQPACKET = 5,
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -070065 SOCK_DCCP = 6,
Linus Torvalds1da177e2005-04-16 15:20:36 -070066 SOCK_PACKET = 10,
67};
68
69#define SOCK_MAX (SOCK_PACKET + 1)
Ulrich Dreppera677a032008-07-23 21:29:17 -070070/* Mask which covers at least up to SOCK_MASK-1. The
71 * remaining bits are used as flags. */
72#define SOCK_TYPE_MASK 0xf
73
Ulrich Drepperde11def2008-11-19 15:36:14 -080074/* Flags for socket, socketpair, accept4 */
Ulrich Dreppera677a032008-07-23 21:29:17 -070075#define SOCK_CLOEXEC O_CLOEXEC
Ulrich Drepperc019bbc2008-07-23 21:29:21 -070076#ifndef SOCK_NONBLOCK
77#define SOCK_NONBLOCK O_NONBLOCK
78#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070079
80#endif /* ARCH_HAS_SOCKET_TYPES */
81
Trond Myklebust91cf45f2007-11-12 18:10:39 -080082enum sock_shutdown_cmd {
Jean Sacren0e9649c2013-06-01 16:23:16 +000083 SHUT_RD,
84 SHUT_WR,
85 SHUT_RDWR,
Trond Myklebust91cf45f2007-11-12 18:10:39 -080086};
87
Eric Dumazet43815482010-04-29 11:01:49 +000088struct socket_wq {
Eric Dumazeteaefd112011-02-18 03:26:36 +000089 /* Note: wait MUST be first field of socket_wq */
Eric Dumazet43815482010-04-29 11:01:49 +000090 wait_queue_head_t wait;
91 struct fasync_struct *fasync_list;
92 struct rcu_head rcu;
93} ____cacheline_aligned_in_smp;
94
Linus Torvalds1da177e2005-04-16 15:20:36 -070095/**
96 * struct socket - general BSD socket
Pavel Pisa4dc3b162005-05-01 08:59:25 -070097 * @state: socket state (%SS_CONNECTED, etc)
Richard Kennedy2c693612008-07-08 03:03:01 -070098 * @type: socket type (%SOCK_STREAM, etc)
Pavel Pisa4dc3b162005-05-01 08:59:25 -070099 * @flags: socket flags (%SOCK_ASYNC_NOSPACE, etc)
100 * @ops: protocol specific socket operations
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700101 * @file: File back pointer for gc
102 * @sk: internal networking protocol agnostic socket representation
Randy Dunlape2aec372010-07-01 13:18:58 +0000103 * @wq: wait queue for several uses
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 */
105struct socket {
106 socket_state state;
Eric Dumazet29a020d2009-09-15 02:39:20 -0700107
108 kmemcheck_bitfield_begin(type);
Richard Kennedy2c693612008-07-08 03:03:01 -0700109 short type;
Eric Dumazet29a020d2009-09-15 02:39:20 -0700110 kmemcheck_bitfield_end(type);
111
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112 unsigned long flags;
Eric Dumazet43815482010-04-29 11:01:49 +0000113
Eric Dumazeteaefd112011-02-18 03:26:36 +0000114 struct socket_wq __rcu *wq;
Eric Dumazet8bdd6632009-03-15 19:59:13 -0700115
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 struct file *file;
117 struct sock *sk;
Eric Dumazet8bdd6632009-03-15 19:59:13 -0700118 const struct proto_ops *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119};
120
121struct vm_area_struct;
122struct page;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123struct sockaddr;
124struct msghdr;
125struct module;
126
127struct proto_ops {
128 int family;
129 struct module *owner;
130 int (*release) (struct socket *sock);
131 int (*bind) (struct socket *sock,
132 struct sockaddr *myaddr,
133 int sockaddr_len);
134 int (*connect) (struct socket *sock,
135 struct sockaddr *vaddr,
136 int sockaddr_len, int flags);
137 int (*socketpair)(struct socket *sock1,
138 struct socket *sock2);
139 int (*accept) (struct socket *sock,
140 struct socket *newsock, int flags);
141 int (*getname) (struct socket *sock,
142 struct sockaddr *addr,
143 int *sockaddr_len, int peer);
144 unsigned int (*poll) (struct file *file, struct socket *sock,
145 struct poll_table_struct *wait);
146 int (*ioctl) (struct socket *sock, unsigned int cmd,
147 unsigned long arg);
Alexey Dobriyan1621e092010-02-01 09:44:19 +0000148#ifdef CONFIG_COMPAT
Shaun Pereira89bbfc92006-03-21 23:58:08 -0800149 int (*compat_ioctl) (struct socket *sock, unsigned int cmd,
150 unsigned long arg);
Alexey Dobriyan1621e092010-02-01 09:44:19 +0000151#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152 int (*listen) (struct socket *sock, int len);
153 int (*shutdown) (struct socket *sock, int flags);
154 int (*setsockopt)(struct socket *sock, int level,
David S. Millerb7058842009-09-30 16:12:20 -0700155 int optname, char __user *optval, unsigned int optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 int (*getsockopt)(struct socket *sock, int level,
157 int optname, char __user *optval, int __user *optlen);
Alexey Dobriyan1621e092010-02-01 09:44:19 +0000158#ifdef CONFIG_COMPAT
Dmitry Mishin3fdadf72006-03-20 22:45:21 -0800159 int (*compat_setsockopt)(struct socket *sock, int level,
David S. Millerb7058842009-09-30 16:12:20 -0700160 int optname, char __user *optval, unsigned int optlen);
Dmitry Mishin3fdadf72006-03-20 22:45:21 -0800161 int (*compat_getsockopt)(struct socket *sock, int level,
162 int optname, char __user *optval, int __user *optlen);
Alexey Dobriyan1621e092010-02-01 09:44:19 +0000163#endif
Ying Xue1b784142015-03-02 15:37:48 +0800164 int (*sendmsg) (struct socket *sock, struct msghdr *m,
165 size_t total_len);
Hannes Frederic Sowaf3d33422013-11-21 03:14:22 +0100166 /* Notes for implementing recvmsg:
167 * ===============================
168 * msg->msg_namelen should get updated by the recvmsg handlers
169 * iff msg_name != NULL. It is by default 0 to prevent
170 * returning uninitialized memory to user space. The recvfrom
171 * handlers can assume that msg.msg_name is either NULL or has
172 * a minimum size of sizeof(struct sockaddr_storage).
173 */
Ying Xue1b784142015-03-02 15:37:48 +0800174 int (*recvmsg) (struct socket *sock, struct msghdr *m,
175 size_t total_len, int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176 int (*mmap) (struct file *file, struct socket *sock,
177 struct vm_area_struct * vma);
178 ssize_t (*sendpage) (struct socket *sock, struct page *page,
179 int offset, size_t size, int flags);
Jens Axboe9c55e012007-11-06 23:30:13 -0800180 ssize_t (*splice_read)(struct socket *sock, loff_t *ppos,
181 struct pipe_inode_info *pipe, size_t len, unsigned int flags);
Sasha Levin12663bf2013-12-07 17:26:27 -0500182 int (*set_peek_off)(struct sock *sk, int val);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183};
184
Cyrill Gorcunov38bfd8f2009-10-29 02:59:18 -0700185#define DECLARE_SOCKADDR(type, dst, src) \
186 type dst = ({ __sockaddr_check_size(sizeof(*dst)); (type) src; })
187
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188struct net_proto_family {
189 int family;
Eric Paris3f378b62009-11-05 22:18:14 -0800190 int (*create)(struct net *net, struct socket *sock,
191 int protocol, int kern);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192 struct module *owner;
193};
194
195struct iovec;
196struct kvec;
197
Pavel Emelyanov8d8ad9d2007-11-26 20:10:50 +0800198enum {
199 SOCK_WAKE_IO,
200 SOCK_WAKE_WAITD,
201 SOCK_WAKE_SPACE,
202 SOCK_WAKE_URG,
203};
204
Joe Perches7965bd42013-09-26 14:48:15 -0700205int sock_wake_async(struct socket *sk, int how, int band);
206int sock_register(const struct net_proto_family *fam);
207void sock_unregister(int family);
208int __sock_create(struct net *net, int family, int type, int proto,
209 struct socket **res, int kern);
210int sock_create(int family, int type, int proto, struct socket **res);
211int sock_create_kern(int family, int type, int proto, struct socket **res);
212int sock_create_lite(int family, int type, int proto, struct socket **res);
213void sock_release(struct socket *sock);
Al Virod8725c82014-12-11 00:02:50 -0500214int sock_sendmsg(struct socket *sock, struct msghdr *msg);
Joe Perches7965bd42013-09-26 14:48:15 -0700215int sock_recvmsg(struct socket *sock, struct msghdr *msg, size_t size,
216 int flags);
217struct file *sock_alloc_file(struct socket *sock, int flags, const char *dname);
218struct socket *sockfd_lookup(int fd, int *err);
219struct socket *sock_from_file(struct file *file, int *err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220#define sockfd_put(sock) fput(sock->file)
Joe Perches7965bd42013-09-26 14:48:15 -0700221int net_ratelimit(void);
Stephen Hemmingeraaa248f2006-10-17 00:09:42 -0700222
Joe Perches3a3bfb62012-05-13 21:56:25 +0000223#define net_ratelimited_function(function, ...) \
224do { \
225 if (net_ratelimit()) \
226 function(__VA_ARGS__); \
227} while (0)
228
229#define net_emerg_ratelimited(fmt, ...) \
230 net_ratelimited_function(pr_emerg, fmt, ##__VA_ARGS__)
231#define net_alert_ratelimited(fmt, ...) \
232 net_ratelimited_function(pr_alert, fmt, ##__VA_ARGS__)
233#define net_crit_ratelimited(fmt, ...) \
234 net_ratelimited_function(pr_crit, fmt, ##__VA_ARGS__)
235#define net_err_ratelimited(fmt, ...) \
236 net_ratelimited_function(pr_err, fmt, ##__VA_ARGS__)
237#define net_notice_ratelimited(fmt, ...) \
238 net_ratelimited_function(pr_notice, fmt, ##__VA_ARGS__)
239#define net_warn_ratelimited(fmt, ...) \
240 net_ratelimited_function(pr_warn, fmt, ##__VA_ARGS__)
241#define net_info_ratelimited(fmt, ...) \
242 net_ratelimited_function(pr_info, fmt, ##__VA_ARGS__)
243#define net_dbg_ratelimited(fmt, ...) \
244 net_ratelimited_function(pr_debug, fmt, ##__VA_ARGS__)
245
Hannes Frederic Sowaa48e4292013-10-19 21:48:55 +0200246bool __net_get_random_once(void *buf, int nbytes, bool *done,
247 struct static_key *done_key);
248
Hannes Frederic Sowaa48e4292013-10-19 21:48:55 +0200249#define net_get_random_once(buf, nbytes) \
250 ({ \
251 bool ___ret = false; \
252 static bool ___done = false; \
Hannes Frederic Sowa3d440522014-05-11 22:59:30 +0200253 static struct static_key ___once_key = \
254 STATIC_KEY_INIT_TRUE; \
255 if (static_key_true(&___once_key)) \
Hannes Frederic Sowaa48e4292013-10-19 21:48:55 +0200256 ___ret = __net_get_random_once(buf, \
257 nbytes, \
258 &___done, \
Hannes Frederic Sowa3d440522014-05-11 22:59:30 +0200259 &___once_key); \
Hannes Frederic Sowaa48e4292013-10-19 21:48:55 +0200260 ___ret; \
261 })
262
Joe Perches7965bd42013-09-26 14:48:15 -0700263int kernel_sendmsg(struct socket *sock, struct msghdr *msg, struct kvec *vec,
264 size_t num, size_t len);
265int kernel_recvmsg(struct socket *sock, struct msghdr *msg, struct kvec *vec,
266 size_t num, size_t len, int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267
Joe Perches7965bd42013-09-26 14:48:15 -0700268int kernel_bind(struct socket *sock, struct sockaddr *addr, int addrlen);
269int kernel_listen(struct socket *sock, int backlog);
270int kernel_accept(struct socket *sock, struct socket **newsock, int flags);
271int kernel_connect(struct socket *sock, struct sockaddr *addr, int addrlen,
272 int flags);
273int kernel_getsockname(struct socket *sock, struct sockaddr *addr,
274 int *addrlen);
275int kernel_getpeername(struct socket *sock, struct sockaddr *addr,
276 int *addrlen);
277int kernel_getsockopt(struct socket *sock, int level, int optname, char *optval,
278 int *optlen);
279int kernel_setsockopt(struct socket *sock, int level, int optname, char *optval,
280 unsigned int optlen);
281int kernel_sendpage(struct socket *sock, struct page *page, int offset,
282 size_t size, int flags);
283int kernel_sock_ioctl(struct socket *sock, int cmd, unsigned long arg);
284int kernel_sock_shutdown(struct socket *sock, enum sock_shutdown_cmd how);
Sridhar Samudralaac5a4882006-08-07 20:57:31 -0700285
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286#define MODULE_ALIAS_NETPROTO(proto) \
287 MODULE_ALIAS("net-pf-" __stringify(proto))
288
Harald Welte4fdb3bb2005-08-09 19:40:55 -0700289#define MODULE_ALIAS_NET_PF_PROTO(pf, proto) \
290 MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto))
291
Jean Delvare305e1e92007-10-21 16:44:04 -0700292#define MODULE_ALIAS_NET_PF_PROTO_TYPE(pf, proto, type) \
293 MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto) \
294 "-type-" __stringify(type))
295
Neil Horman2033e9b2012-05-29 09:30:40 +0000296#define MODULE_ALIAS_NET_PF_PROTO_NAME(pf, proto, name) \
297 MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto) \
298 name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299#endif /* _LINUX_NET_H */