blob: d8d5f2c7b77647cc5f1fe72068604f1c269a9074 [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 Dumazet43815482010-04-29 11:01:49 +000025#include <linux/rcupdate.h>
Hannes Frederic Sowa46234252015-10-08 01:20:35 +020026#include <linux/once.h>
Tom Herbert0294b622016-08-28 14:43:17 -070027#include <linux/fs.h>
Hannes Frederic Sowa46234252015-10-08 01:20:35 +020028
David Howells607ca462012-10-13 10:46:48 +010029#include <uapi/linux/net.h>
David Woodhouse5770a3f2008-08-26 15:29:22 +010030
31struct poll_table_struct;
32struct pipe_inode_info;
33struct inode;
Al Viro56b31d12012-08-18 00:25:51 -040034struct file;
David Woodhouse5770a3f2008-08-26 15:29:22 +010035struct net;
Linus Torvalds1da177e2005-04-16 15:20:36 -070036
Eric Dumazetceb5d582015-11-29 20:03:11 -080037/* Historically, SOCKWQ_ASYNC_NOSPACE & SOCKWQ_ASYNC_WAITDATA were located
38 * in sock->flags, but moved into sk->sk_wq->flags to be RCU protected.
Tonghao Zhangb3dc8f72017-08-15 04:28:54 -070039 * Eventually all flags will be in sk->sk_wq->flags.
Eric Dumazetceb5d582015-11-29 20:03:11 -080040 */
Eric Dumazet9cd3e072015-11-29 20:03:10 -080041#define SOCKWQ_ASYNC_NOSPACE 0
42#define SOCKWQ_ASYNC_WAITDATA 1
Linus Torvalds1da177e2005-04-16 15:20:36 -070043#define SOCK_NOSPACE 2
44#define SOCK_PASSCRED 3
Catherine Zhang877ce7c2006-06-29 12:27:47 -070045#define SOCK_PASSSEC 4
Linus Torvalds1da177e2005-04-16 15:20:36 -070046
47#ifndef ARCH_HAS_SOCKET_TYPES
Pavel Pisa4dc3b162005-05-01 08:59:25 -070048/**
49 * enum sock_type - Socket types
50 * @SOCK_STREAM: stream (connection) socket
51 * @SOCK_DGRAM: datagram (conn.less) socket
52 * @SOCK_RAW: raw socket
53 * @SOCK_RDM: reliably-delivered message
54 * @SOCK_SEQPACKET: sequential packet socket
Randy Dunlap8f2709b2005-11-07 01:01:05 -080055 * @SOCK_DCCP: Datagram Congestion Control Protocol socket
Pavel Pisa4dc3b162005-05-01 08:59:25 -070056 * @SOCK_PACKET: linux specific way of getting packets at the dev level.
57 * For writing rarp and other similar things on the user level.
58 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070059 * When adding some new socket type please
60 * grep ARCH_HAS_SOCKET_TYPE include/asm-* /socket.h, at least MIPS
61 * overrides this enum for binary compat reasons.
Linus Torvalds1da177e2005-04-16 15:20:36 -070062 */
63enum sock_type {
64 SOCK_STREAM = 1,
65 SOCK_DGRAM = 2,
66 SOCK_RAW = 3,
67 SOCK_RDM = 4,
68 SOCK_SEQPACKET = 5,
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -070069 SOCK_DCCP = 6,
Linus Torvalds1da177e2005-04-16 15:20:36 -070070 SOCK_PACKET = 10,
71};
72
73#define SOCK_MAX (SOCK_PACKET + 1)
Ulrich Dreppera677a032008-07-23 21:29:17 -070074/* Mask which covers at least up to SOCK_MASK-1. The
75 * remaining bits are used as flags. */
76#define SOCK_TYPE_MASK 0xf
77
Ulrich Drepperde11def2008-11-19 15:36:14 -080078/* Flags for socket, socketpair, accept4 */
Ulrich Dreppera677a032008-07-23 21:29:17 -070079#define SOCK_CLOEXEC O_CLOEXEC
Ulrich Drepperc019bbc2008-07-23 21:29:21 -070080#ifndef SOCK_NONBLOCK
81#define SOCK_NONBLOCK O_NONBLOCK
82#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070083
84#endif /* ARCH_HAS_SOCKET_TYPES */
85
Trond Myklebust91cf45f2007-11-12 18:10:39 -080086enum sock_shutdown_cmd {
Jean Sacren0e9649c2013-06-01 16:23:16 +000087 SHUT_RD,
88 SHUT_WR,
89 SHUT_RDWR,
Trond Myklebust91cf45f2007-11-12 18:10:39 -080090};
91
Eric Dumazet43815482010-04-29 11:01:49 +000092struct socket_wq {
Eric Dumazeteaefd112011-02-18 03:26:36 +000093 /* Note: wait MUST be first field of socket_wq */
Eric Dumazet43815482010-04-29 11:01:49 +000094 wait_queue_head_t wait;
95 struct fasync_struct *fasync_list;
Eric Dumazetceb5d582015-11-29 20:03:11 -080096 unsigned long flags; /* %SOCKWQ_ASYNC_NOSPACE, etc */
Eric Dumazet43815482010-04-29 11:01:49 +000097 struct rcu_head rcu;
98} ____cacheline_aligned_in_smp;
99
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100/**
101 * struct socket - general BSD socket
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700102 * @state: socket state (%SS_CONNECTED, etc)
Richard Kennedy2c693612008-07-08 03:03:01 -0700103 * @type: socket type (%SOCK_STREAM, etc)
Eric Dumazet9cd3e072015-11-29 20:03:10 -0800104 * @flags: socket flags (%SOCK_NOSPACE, etc)
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700105 * @ops: protocol specific socket operations
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700106 * @file: File back pointer for gc
107 * @sk: internal networking protocol agnostic socket representation
Randy Dunlape2aec372010-07-01 13:18:58 +0000108 * @wq: wait queue for several uses
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109 */
110struct socket {
111 socket_state state;
Eric Dumazet29a020d2009-09-15 02:39:20 -0700112
Richard Kennedy2c693612008-07-08 03:03:01 -0700113 short type;
Eric Dumazet29a020d2009-09-15 02:39:20 -0700114
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 unsigned long flags;
Eric Dumazet43815482010-04-29 11:01:49 +0000116
Eric Dumazeteaefd112011-02-18 03:26:36 +0000117 struct socket_wq __rcu *wq;
Eric Dumazet8bdd6632009-03-15 19:59:13 -0700118
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 struct file *file;
120 struct sock *sk;
Eric Dumazet8bdd6632009-03-15 19:59:13 -0700121 const struct proto_ops *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122};
123
124struct vm_area_struct;
125struct page;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126struct sockaddr;
127struct msghdr;
128struct module;
Tom Herbert0294b622016-08-28 14:43:17 -0700129struct sk_buff;
130typedef int (*sk_read_actor_t)(read_descriptor_t *, struct sk_buff *,
131 unsigned int, size_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132
133struct proto_ops {
134 int family;
135 struct module *owner;
136 int (*release) (struct socket *sock);
137 int (*bind) (struct socket *sock,
138 struct sockaddr *myaddr,
139 int sockaddr_len);
140 int (*connect) (struct socket *sock,
141 struct sockaddr *vaddr,
142 int sockaddr_len, int flags);
143 int (*socketpair)(struct socket *sock1,
144 struct socket *sock2);
145 int (*accept) (struct socket *sock,
David Howellscdfbabf2017-03-09 08:09:05 +0000146 struct socket *newsock, int flags, bool kern);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147 int (*getname) (struct socket *sock,
148 struct sockaddr *addr,
149 int *sockaddr_len, int peer);
150 unsigned int (*poll) (struct file *file, struct socket *sock,
151 struct poll_table_struct *wait);
152 int (*ioctl) (struct socket *sock, unsigned int cmd,
153 unsigned long arg);
Alexey Dobriyan1621e092010-02-01 09:44:19 +0000154#ifdef CONFIG_COMPAT
Shaun Pereira89bbfc92006-03-21 23:58:08 -0800155 int (*compat_ioctl) (struct socket *sock, unsigned int cmd,
156 unsigned long arg);
Alexey Dobriyan1621e092010-02-01 09:44:19 +0000157#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158 int (*listen) (struct socket *sock, int len);
159 int (*shutdown) (struct socket *sock, int flags);
160 int (*setsockopt)(struct socket *sock, int level,
David S. Millerb7058842009-09-30 16:12:20 -0700161 int optname, char __user *optval, unsigned int optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 int (*getsockopt)(struct socket *sock, int level,
163 int optname, char __user *optval, int __user *optlen);
Alexey Dobriyan1621e092010-02-01 09:44:19 +0000164#ifdef CONFIG_COMPAT
Dmitry Mishin3fdadf72006-03-20 22:45:21 -0800165 int (*compat_setsockopt)(struct socket *sock, int level,
David S. Millerb7058842009-09-30 16:12:20 -0700166 int optname, char __user *optval, unsigned int optlen);
Dmitry Mishin3fdadf72006-03-20 22:45:21 -0800167 int (*compat_getsockopt)(struct socket *sock, int level,
168 int optname, char __user *optval, int __user *optlen);
Alexey Dobriyan1621e092010-02-01 09:44:19 +0000169#endif
Ying Xue1b784142015-03-02 15:37:48 +0800170 int (*sendmsg) (struct socket *sock, struct msghdr *m,
171 size_t total_len);
Hannes Frederic Sowaf3d33422013-11-21 03:14:22 +0100172 /* Notes for implementing recvmsg:
173 * ===============================
174 * msg->msg_namelen should get updated by the recvmsg handlers
175 * iff msg_name != NULL. It is by default 0 to prevent
176 * returning uninitialized memory to user space. The recvfrom
177 * handlers can assume that msg.msg_name is either NULL or has
178 * a minimum size of sizeof(struct sockaddr_storage).
179 */
Ying Xue1b784142015-03-02 15:37:48 +0800180 int (*recvmsg) (struct socket *sock, struct msghdr *m,
181 size_t total_len, int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182 int (*mmap) (struct file *file, struct socket *sock,
183 struct vm_area_struct * vma);
184 ssize_t (*sendpage) (struct socket *sock, struct page *page,
185 int offset, size_t size, int flags);
Jens Axboe9c55e012007-11-06 23:30:13 -0800186 ssize_t (*splice_read)(struct socket *sock, loff_t *ppos,
187 struct pipe_inode_info *pipe, size_t len, unsigned int flags);
Sasha Levin12663bf2013-12-07 17:26:27 -0500188 int (*set_peek_off)(struct sock *sk, int val);
Jason Wang1576d982016-06-30 14:45:36 +0800189 int (*peek_len)(struct socket *sock);
Tom Herbert306b13e2017-07-28 16:22:41 -0700190
191 /* The following functions are called internally by kernel with
192 * sock lock already held.
193 */
Tom Herbert0294b622016-08-28 14:43:17 -0700194 int (*read_sock)(struct sock *sk, read_descriptor_t *desc,
195 sk_read_actor_t recv_actor);
Tom Herbert306b13e2017-07-28 16:22:41 -0700196 int (*sendpage_locked)(struct sock *sk, struct page *page,
197 int offset, size_t size, int flags);
198 int (*sendmsg_locked)(struct sock *sk, struct msghdr *msg,
199 size_t size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200};
201
Cyrill Gorcunov38bfd8f2009-10-29 02:59:18 -0700202#define DECLARE_SOCKADDR(type, dst, src) \
203 type dst = ({ __sockaddr_check_size(sizeof(*dst)); (type) src; })
204
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205struct net_proto_family {
206 int family;
Eric Paris3f378b62009-11-05 22:18:14 -0800207 int (*create)(struct net *net, struct socket *sock,
208 int protocol, int kern);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209 struct module *owner;
210};
211
212struct iovec;
213struct kvec;
214
Pavel Emelyanov8d8ad9d2007-11-26 20:10:50 +0800215enum {
216 SOCK_WAKE_IO,
217 SOCK_WAKE_WAITD,
218 SOCK_WAKE_SPACE,
219 SOCK_WAKE_URG,
220};
221
Eric Dumazetceb5d582015-11-29 20:03:11 -0800222int sock_wake_async(struct socket_wq *sk_wq, int how, int band);
Joe Perches7965bd42013-09-26 14:48:15 -0700223int sock_register(const struct net_proto_family *fam);
224void sock_unregister(int family);
Xin Longc4d2af72018-03-10 18:57:50 +0800225bool sock_is_registered(int family);
Joe Perches7965bd42013-09-26 14:48:15 -0700226int __sock_create(struct net *net, int family, int type, int proto,
227 struct socket **res, int kern);
228int sock_create(int family, int type, int proto, struct socket **res);
Eric W. Biedermaneeb1bd52015-05-08 21:08:05 -0500229int sock_create_kern(struct net *net, int family, int type, int proto, struct socket **res);
Joe Perches7965bd42013-09-26 14:48:15 -0700230int sock_create_lite(int family, int type, int proto, struct socket **res);
Tom Herbertf4a00aa2016-03-07 14:11:01 -0800231struct socket *sock_alloc(void);
Joe Perches7965bd42013-09-26 14:48:15 -0700232void sock_release(struct socket *sock);
Al Virod8725c82014-12-11 00:02:50 -0500233int sock_sendmsg(struct socket *sock, struct msghdr *msg);
Al Viro2da62902015-03-14 21:13:46 -0400234int sock_recvmsg(struct socket *sock, struct msghdr *msg, int flags);
Joe Perches7965bd42013-09-26 14:48:15 -0700235struct file *sock_alloc_file(struct socket *sock, int flags, const char *dname);
236struct socket *sockfd_lookup(int fd, int *err);
237struct socket *sock_from_file(struct file *file, int *err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238#define sockfd_put(sock) fput(sock->file)
Joe Perches7965bd42013-09-26 14:48:15 -0700239int net_ratelimit(void);
Stephen Hemmingeraaa248f2006-10-17 00:09:42 -0700240
Joe Perches3a3bfb62012-05-13 21:56:25 +0000241#define net_ratelimited_function(function, ...) \
242do { \
243 if (net_ratelimit()) \
244 function(__VA_ARGS__); \
245} while (0)
246
247#define net_emerg_ratelimited(fmt, ...) \
248 net_ratelimited_function(pr_emerg, fmt, ##__VA_ARGS__)
249#define net_alert_ratelimited(fmt, ...) \
250 net_ratelimited_function(pr_alert, fmt, ##__VA_ARGS__)
251#define net_crit_ratelimited(fmt, ...) \
252 net_ratelimited_function(pr_crit, fmt, ##__VA_ARGS__)
253#define net_err_ratelimited(fmt, ...) \
254 net_ratelimited_function(pr_err, fmt, ##__VA_ARGS__)
255#define net_notice_ratelimited(fmt, ...) \
256 net_ratelimited_function(pr_notice, fmt, ##__VA_ARGS__)
257#define net_warn_ratelimited(fmt, ...) \
258 net_ratelimited_function(pr_warn, fmt, ##__VA_ARGS__)
259#define net_info_ratelimited(fmt, ...) \
260 net_ratelimited_function(pr_info, fmt, ##__VA_ARGS__)
Tim Bingham2c94b532016-04-29 13:30:23 -0400261#if defined(CONFIG_DYNAMIC_DEBUG)
262#define net_dbg_ratelimited(fmt, ...) \
263do { \
264 DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \
265 if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT) && \
266 net_ratelimit()) \
Jason A. Donenfelddaddef72016-06-15 11:14:53 +0200267 __dynamic_pr_debug(&descriptor, pr_fmt(fmt), \
268 ##__VA_ARGS__); \
Tim Bingham2c94b532016-04-29 13:30:23 -0400269} while (0)
270#elif defined(DEBUG)
Joe Perches3a3bfb62012-05-13 21:56:25 +0000271#define net_dbg_ratelimited(fmt, ...) \
272 net_ratelimited_function(pr_debug, fmt, ##__VA_ARGS__)
Jason A. Donenfeldd92cff82015-08-04 18:26:19 +0200273#else
274#define net_dbg_ratelimited(fmt, ...) \
275 do { \
276 if (0) \
277 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); \
278 } while (0)
279#endif
Joe Perches3a3bfb62012-05-13 21:56:25 +0000280
Hannes Frederic Sowa46234252015-10-08 01:20:35 +0200281#define net_get_random_once(buf, nbytes) \
282 get_random_once((buf), (nbytes))
Jason A. Donenfeldda9ba562017-06-07 20:05:02 -0400283#define net_get_random_once_wait(buf, nbytes) \
284 get_random_once_wait((buf), (nbytes))
Hannes Frederic Sowaa48e4292013-10-19 21:48:55 +0200285
Joe Perches7965bd42013-09-26 14:48:15 -0700286int kernel_sendmsg(struct socket *sock, struct msghdr *msg, struct kvec *vec,
287 size_t num, size_t len);
Tom Herbert306b13e2017-07-28 16:22:41 -0700288int kernel_sendmsg_locked(struct sock *sk, struct msghdr *msg,
289 struct kvec *vec, size_t num, size_t len);
Joe Perches7965bd42013-09-26 14:48:15 -0700290int kernel_recvmsg(struct socket *sock, struct msghdr *msg, struct kvec *vec,
291 size_t num, size_t len, int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292
Joe Perches7965bd42013-09-26 14:48:15 -0700293int kernel_bind(struct socket *sock, struct sockaddr *addr, int addrlen);
294int kernel_listen(struct socket *sock, int backlog);
295int kernel_accept(struct socket *sock, struct socket **newsock, int flags);
296int kernel_connect(struct socket *sock, struct sockaddr *addr, int addrlen,
297 int flags);
298int kernel_getsockname(struct socket *sock, struct sockaddr *addr,
299 int *addrlen);
300int kernel_getpeername(struct socket *sock, struct sockaddr *addr,
301 int *addrlen);
302int kernel_getsockopt(struct socket *sock, int level, int optname, char *optval,
303 int *optlen);
304int kernel_setsockopt(struct socket *sock, int level, int optname, char *optval,
305 unsigned int optlen);
306int kernel_sendpage(struct socket *sock, struct page *page, int offset,
307 size_t size, int flags);
Tom Herbert306b13e2017-07-28 16:22:41 -0700308int kernel_sendpage_locked(struct sock *sk, struct page *page, int offset,
309 size_t size, int flags);
Joe Perches7965bd42013-09-26 14:48:15 -0700310int kernel_sock_ioctl(struct socket *sock, int cmd, unsigned long arg);
311int kernel_sock_shutdown(struct socket *sock, enum sock_shutdown_cmd how);
Sridhar Samudralaac5a4882006-08-07 20:57:31 -0700312
R. Parameswaran57240d02017-04-12 18:31:04 -0700313/* Routine returns the IP overhead imposed by a (caller-protected) socket. */
R. Parameswaran113c3072017-04-05 16:50:35 -0700314u32 kernel_sock_ip_overhead(struct sock *sk);
315
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316#define MODULE_ALIAS_NETPROTO(proto) \
317 MODULE_ALIAS("net-pf-" __stringify(proto))
318
Harald Welte4fdb3bb2005-08-09 19:40:55 -0700319#define MODULE_ALIAS_NET_PF_PROTO(pf, proto) \
320 MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto))
321
Jean Delvare305e1e92007-10-21 16:44:04 -0700322#define MODULE_ALIAS_NET_PF_PROTO_TYPE(pf, proto, type) \
323 MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto) \
324 "-type-" __stringify(type))
325
Neil Horman2033e9b2012-05-29 09:30:40 +0000326#define MODULE_ALIAS_NET_PF_PROTO_NAME(pf, proto, name) \
327 MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto) \
328 name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329#endif /* _LINUX_NET_H */