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