Merge tag 'staging-4.18-rc1' of git://git.kernel.org/pub/scm/linux/kernel/git/gregkh...
[linux-2.6-block.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
eacf17bd 21#include <linux/stringify.h>
cb4db4c2 22#include <linux/random.h>
5770a3fb
DW
23#include <linux/wait.h>
24#include <linux/fcntl.h> /* For O_CLOEXEC and O_NONBLOCK */
43815482 25#include <linux/rcupdate.h>
46234253 26#include <linux/once.h>
0294b625 27#include <linux/fs.h>
46234253 28
607ca46e 29#include <uapi/linux/net.h>
5770a3fb
DW
30
31struct poll_table_struct;
32struct pipe_inode_info;
33struct inode;
56b31d1c 34struct file;
5770a3fb 35struct net;
1da177e4 36
ceb5d58b
ED
37/* Historically, SOCKWQ_ASYNC_NOSPACE & SOCKWQ_ASYNC_WAITDATA were located
38 * in sock->flags, but moved into sk->sk_wq->flags to be RCU protected.
b3dc8f77 39 * Eventually all flags will be in sk->sk_wq->flags.
ceb5d58b 40 */
9cd3e072
ED
41#define SOCKWQ_ASYNC_NOSPACE 0
42#define SOCKWQ_ASYNC_WAITDATA 1
1da177e4
LT
43#define SOCK_NOSPACE 2
44#define SOCK_PASSCRED 3
877ce7c1 45#define SOCK_PASSSEC 4
1da177e4
LT
46
47#ifndef ARCH_HAS_SOCKET_TYPES
4dc3b16b
PP
48/**
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
8f2709b5 55 * @SOCK_DCCP: Datagram Congestion Control Protocol socket
4dc3b16b
PP
56 * @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 *
1da177e4
LT
59 * 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.
1da177e4
LT
62 */
63enum sock_type {
64 SOCK_STREAM = 1,
65 SOCK_DGRAM = 2,
66 SOCK_RAW = 3,
67 SOCK_RDM = 4,
68 SOCK_SEQPACKET = 5,
7c657876 69 SOCK_DCCP = 6,
1da177e4
LT
70 SOCK_PACKET = 10,
71};
72
73#define SOCK_MAX (SOCK_PACKET + 1)
a677a039
UD
74/* 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
de11defe 78/* Flags for socket, socketpair, accept4 */
a677a039 79#define SOCK_CLOEXEC O_CLOEXEC
c019bbc6
UD
80#ifndef SOCK_NONBLOCK
81#define SOCK_NONBLOCK O_NONBLOCK
82#endif
1da177e4
LT
83
84#endif /* ARCH_HAS_SOCKET_TYPES */
85
91cf45f0 86enum sock_shutdown_cmd {
0e9649c1
JS
87 SHUT_RD,
88 SHUT_WR,
89 SHUT_RDWR,
91cf45f0
TM
90};
91
43815482 92struct socket_wq {
eaefd110 93 /* Note: wait MUST be first field of socket_wq */
43815482
ED
94 wait_queue_head_t wait;
95 struct fasync_struct *fasync_list;
ceb5d58b 96 unsigned long flags; /* %SOCKWQ_ASYNC_NOSPACE, etc */
43815482
ED
97 struct rcu_head rcu;
98} ____cacheline_aligned_in_smp;
99
1da177e4
LT
100/**
101 * struct socket - general BSD socket
4dc3b16b 102 * @state: socket state (%SS_CONNECTED, etc)
2c693610 103 * @type: socket type (%SOCK_STREAM, etc)
9cd3e072 104 * @flags: socket flags (%SOCK_NOSPACE, etc)
4dc3b16b 105 * @ops: protocol specific socket operations
4dc3b16b
PP
106 * @file: File back pointer for gc
107 * @sk: internal networking protocol agnostic socket representation
e2aec372 108 * @wq: wait queue for several uses
1da177e4
LT
109 */
110struct socket {
111 socket_state state;
29a020d3 112
2c693610 113 short type;
29a020d3 114
1da177e4 115 unsigned long flags;
43815482 116
eaefd110 117 struct socket_wq __rcu *wq;
8bdd663a 118
1da177e4
LT
119 struct file *file;
120 struct sock *sk;
8bdd663a 121 const struct proto_ops *ops;
1da177e4
LT
122};
123
124struct vm_area_struct;
125struct page;
1da177e4
LT
126struct sockaddr;
127struct msghdr;
128struct module;
0294b625
TH
129struct sk_buff;
130typedef int (*sk_read_actor_t)(read_descriptor_t *, struct sk_buff *,
131 unsigned int, size_t);
1da177e4
LT
132
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,
cdfbabfb 146 struct socket *newsock, int flags, bool kern);
1da177e4
LT
147 int (*getname) (struct socket *sock,
148 struct sockaddr *addr,
9b2c45d4 149 int peer);
15252423 150 __poll_t (*poll_mask) (struct socket *sock, __poll_t events);
a3f8683b 151 __poll_t (*poll) (struct file *file, struct socket *sock,
1da177e4
LT
152 struct poll_table_struct *wait);
153 int (*ioctl) (struct socket *sock, unsigned int cmd,
154 unsigned long arg);
1621e094 155#ifdef CONFIG_COMPAT
89bbfc95
SP
156 int (*compat_ioctl) (struct socket *sock, unsigned int cmd,
157 unsigned long arg);
1621e094 158#endif
1da177e4
LT
159 int (*listen) (struct socket *sock, int len);
160 int (*shutdown) (struct socket *sock, int flags);
161 int (*setsockopt)(struct socket *sock, int level,
b7058842 162 int optname, char __user *optval, unsigned int optlen);
1da177e4
LT
163 int (*getsockopt)(struct socket *sock, int level,
164 int optname, char __user *optval, int __user *optlen);
1621e094 165#ifdef CONFIG_COMPAT
3fdadf7d 166 int (*compat_setsockopt)(struct socket *sock, int level,
b7058842 167 int optname, char __user *optval, unsigned int optlen);
3fdadf7d
DM
168 int (*compat_getsockopt)(struct socket *sock, int level,
169 int optname, char __user *optval, int __user *optlen);
1621e094 170#endif
1b784140
YX
171 int (*sendmsg) (struct socket *sock, struct msghdr *m,
172 size_t total_len);
f3d33426
HFS
173 /* Notes for implementing recvmsg:
174 * ===============================
175 * msg->msg_namelen should get updated by the recvmsg handlers
176 * iff msg_name != NULL. It is by default 0 to prevent
177 * returning uninitialized memory to user space. The recvfrom
178 * handlers can assume that msg.msg_name is either NULL or has
179 * a minimum size of sizeof(struct sockaddr_storage).
180 */
1b784140
YX
181 int (*recvmsg) (struct socket *sock, struct msghdr *m,
182 size_t total_len, int flags);
1da177e4
LT
183 int (*mmap) (struct file *file, struct socket *sock,
184 struct vm_area_struct * vma);
185 ssize_t (*sendpage) (struct socket *sock, struct page *page,
186 int offset, size_t size, int flags);
9c55e01c
JA
187 ssize_t (*splice_read)(struct socket *sock, loff_t *ppos,
188 struct pipe_inode_info *pipe, size_t len, unsigned int flags);
12663bfc 189 int (*set_peek_off)(struct sock *sk, int val);
1576d986 190 int (*peek_len)(struct socket *sock);
306b13eb
TH
191
192 /* The following functions are called internally by kernel with
193 * sock lock already held.
194 */
0294b625
TH
195 int (*read_sock)(struct sock *sk, read_descriptor_t *desc,
196 sk_read_actor_t recv_actor);
306b13eb
TH
197 int (*sendpage_locked)(struct sock *sk, struct page *page,
198 int offset, size_t size, int flags);
199 int (*sendmsg_locked)(struct sock *sk, struct msghdr *msg,
200 size_t size);
d1361840 201 int (*set_rcvlowat)(struct sock *sk, int val);
1da177e4
LT
202};
203
38bfd8f5
CG
204#define DECLARE_SOCKADDR(type, dst, src) \
205 type dst = ({ __sockaddr_check_size(sizeof(*dst)); (type) src; })
206
1da177e4
LT
207struct net_proto_family {
208 int family;
3f378b68
EP
209 int (*create)(struct net *net, struct socket *sock,
210 int protocol, int kern);
1da177e4
LT
211 struct module *owner;
212};
213
214struct iovec;
215struct kvec;
216
8d8ad9d7
PE
217enum {
218 SOCK_WAKE_IO,
219 SOCK_WAKE_WAITD,
220 SOCK_WAKE_SPACE,
221 SOCK_WAKE_URG,
222};
223
ceb5d58b 224int sock_wake_async(struct socket_wq *sk_wq, int how, int band);
7965bd4d
JP
225int sock_register(const struct net_proto_family *fam);
226void sock_unregister(int family);
bf2ae2e4 227bool sock_is_registered(int family);
7965bd4d
JP
228int __sock_create(struct net *net, int family, int type, int proto,
229 struct socket **res, int kern);
230int sock_create(int family, int type, int proto, struct socket **res);
eeb1bd5c 231int sock_create_kern(struct net *net, int family, int type, int proto, struct socket **res);
7965bd4d 232int sock_create_lite(int family, int type, int proto, struct socket **res);
f4a00aac 233struct socket *sock_alloc(void);
7965bd4d 234void sock_release(struct socket *sock);
d8725c86 235int sock_sendmsg(struct socket *sock, struct msghdr *msg);
2da62906 236int sock_recvmsg(struct socket *sock, struct msghdr *msg, int flags);
7965bd4d
JP
237struct file *sock_alloc_file(struct socket *sock, int flags, const char *dname);
238struct socket *sockfd_lookup(int fd, int *err);
239struct socket *sock_from_file(struct file *file, int *err);
1da177e4 240#define sockfd_put(sock) fput(sock->file)
7965bd4d 241int net_ratelimit(void);
aaa248f6 242
3a3bfb61
JP
243#define net_ratelimited_function(function, ...) \
244do { \
245 if (net_ratelimit()) \
246 function(__VA_ARGS__); \
247} while (0)
248
249#define net_emerg_ratelimited(fmt, ...) \
250 net_ratelimited_function(pr_emerg, fmt, ##__VA_ARGS__)
251#define net_alert_ratelimited(fmt, ...) \
252 net_ratelimited_function(pr_alert, fmt, ##__VA_ARGS__)
253#define net_crit_ratelimited(fmt, ...) \
254 net_ratelimited_function(pr_crit, fmt, ##__VA_ARGS__)
255#define net_err_ratelimited(fmt, ...) \
256 net_ratelimited_function(pr_err, fmt, ##__VA_ARGS__)
257#define net_notice_ratelimited(fmt, ...) \
258 net_ratelimited_function(pr_notice, fmt, ##__VA_ARGS__)
259#define net_warn_ratelimited(fmt, ...) \
260 net_ratelimited_function(pr_warn, fmt, ##__VA_ARGS__)
261#define net_info_ratelimited(fmt, ...) \
262 net_ratelimited_function(pr_info, fmt, ##__VA_ARGS__)
2c94b537
TB
263#if defined(CONFIG_DYNAMIC_DEBUG)
264#define net_dbg_ratelimited(fmt, ...) \
265do { \
266 DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \
267 if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT) && \
268 net_ratelimit()) \
daddef76
JD
269 __dynamic_pr_debug(&descriptor, pr_fmt(fmt), \
270 ##__VA_ARGS__); \
2c94b537
TB
271} while (0)
272#elif defined(DEBUG)
3a3bfb61
JP
273#define net_dbg_ratelimited(fmt, ...) \
274 net_ratelimited_function(pr_debug, fmt, ##__VA_ARGS__)
d92cff89
JD
275#else
276#define net_dbg_ratelimited(fmt, ...) \
277 do { \
278 if (0) \
279 no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); \
280 } while (0)
281#endif
3a3bfb61 282
46234253
HFS
283#define net_get_random_once(buf, nbytes) \
284 get_random_once((buf), (nbytes))
da9ba564
JD
285#define net_get_random_once_wait(buf, nbytes) \
286 get_random_once_wait((buf), (nbytes))
a48e4292 287
7965bd4d
JP
288int kernel_sendmsg(struct socket *sock, struct msghdr *msg, struct kvec *vec,
289 size_t num, size_t len);
306b13eb
TH
290int kernel_sendmsg_locked(struct sock *sk, struct msghdr *msg,
291 struct kvec *vec, size_t num, size_t len);
7965bd4d
JP
292int kernel_recvmsg(struct socket *sock, struct msghdr *msg, struct kvec *vec,
293 size_t num, size_t len, int flags);
1da177e4 294
7965bd4d
JP
295int kernel_bind(struct socket *sock, struct sockaddr *addr, int addrlen);
296int kernel_listen(struct socket *sock, int backlog);
297int kernel_accept(struct socket *sock, struct socket **newsock, int flags);
298int kernel_connect(struct socket *sock, struct sockaddr *addr, int addrlen,
299 int flags);
9b2c45d4
DV
300int kernel_getsockname(struct socket *sock, struct sockaddr *addr);
301int kernel_getpeername(struct socket *sock, struct sockaddr *addr);
7965bd4d
JP
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);
306b13eb
TH
308int kernel_sendpage_locked(struct sock *sk, struct page *page, int offset,
309 size_t size, int flags);
7965bd4d 310int kernel_sock_shutdown(struct socket *sock, enum sock_shutdown_cmd how);
ac5a488e 311
57240d00 312/* Routine returns the IP overhead imposed by a (caller-protected) socket. */
113c3075
P
313u32 kernel_sock_ip_overhead(struct sock *sk);
314
1da177e4
LT
315#define MODULE_ALIAS_NETPROTO(proto) \
316 MODULE_ALIAS("net-pf-" __stringify(proto))
317
4fdb3bb7
HW
318#define MODULE_ALIAS_NET_PF_PROTO(pf, proto) \
319 MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto))
320
305e1e96
JD
321#define MODULE_ALIAS_NET_PF_PROTO_TYPE(pf, proto, type) \
322 MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto) \
323 "-type-" __stringify(type))
324
2033e9bf
NH
325#define MODULE_ALIAS_NET_PF_PROTO_NAME(pf, proto, name) \
326 MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto) \
327 name)
1da177e4 328#endif /* _LINUX_NET_H */