Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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>
10 * Ross Biro
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
21#include <linux/stringify.h>
22#include <linux/random.h>
23#include <linux/wait.h>
24#include <linux/fcntl.h> /* For O_CLOEXEC and O_NONBLOCK */
25#include <linux/kmemcheck.h>
26#include <linux/rcupdate.h>
27#include <linux/jump_label.h>
28#include <uapi/linux/net.h>
29
30struct poll_table_struct;
31struct pipe_inode_info;
32struct inode;
33struct file;
34struct net;
35
36#define SOCK_ASYNC_NOSPACE 0
37#define SOCK_ASYNC_WAITDATA 1
38#define SOCK_NOSPACE 2
39#define SOCK_PASSCRED 3
40#define SOCK_PASSSEC 4
41#define SOCK_EXTERNALLY_ALLOCATED 5
42
43#ifndef ARCH_HAS_SOCKET_TYPES
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
51 * @SOCK_DCCP: Datagram Congestion Control Protocol socket
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 *
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.
58 */
59enum sock_type {
60 SOCK_STREAM = 1,
61 SOCK_DGRAM = 2,
62 SOCK_RAW = 3,
63 SOCK_RDM = 4,
64 SOCK_SEQPACKET = 5,
65 SOCK_DCCP = 6,
66 SOCK_PACKET = 10,
67};
68
69#define SOCK_MAX (SOCK_PACKET + 1)
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
74/* Flags for socket, socketpair, accept4 */
75#define SOCK_CLOEXEC O_CLOEXEC
76#ifndef SOCK_NONBLOCK
77#define SOCK_NONBLOCK O_NONBLOCK
78#endif
79
80#endif /* ARCH_HAS_SOCKET_TYPES */
81
82enum sock_shutdown_cmd {
83 SHUT_RD,
84 SHUT_WR,
85 SHUT_RDWR,
86};
87
88struct socket_wq {
89 /* Note: wait MUST be first field of socket_wq */
90 wait_queue_head_t wait;
91 struct fasync_struct *fasync_list;
92 struct rcu_head rcu;
93} ____cacheline_aligned_in_smp;
94
95/**
96 * struct socket - general BSD socket
97 * @state: socket state (%SS_CONNECTED, etc)
98 * @type: socket type (%SOCK_STREAM, etc)
99 * @flags: socket flags (%SOCK_ASYNC_NOSPACE, etc)
100 * @ops: protocol specific socket operations
101 * @file: File back pointer for gc
102 * @sk: internal networking protocol agnostic socket representation
103 * @wq: wait queue for several uses
104 */
105struct socket {
106 socket_state state;
107
108 kmemcheck_bitfield_begin(type);
109 short type;
110 kmemcheck_bitfield_end(type);
111
112 unsigned long flags;
113
114 struct socket_wq __rcu *wq;
115
116 struct file *file;
117 struct sock *sk;
118 const struct proto_ops *ops;
119};
120
121struct vm_area_struct;
122struct page;
123struct kiocb;
124struct sockaddr;
125struct msghdr;
126struct module;
127
128struct proto_ops {
129 int family;
130 struct module *owner;
131 int (*release) (struct socket *sock);
132 int (*bind) (struct socket *sock,
133 struct sockaddr *myaddr,
134 int sockaddr_len);
135 int (*connect) (struct socket *sock,
136 struct sockaddr *vaddr,
137 int sockaddr_len, int flags);
138 int (*socketpair)(struct socket *sock1,
139 struct socket *sock2);
140 int (*accept) (struct socket *sock,
141 struct socket *newsock, int flags);
142 int (*getname) (struct socket *sock,
143 struct sockaddr *addr,
144 int *sockaddr_len, int peer);
145 unsigned int (*poll) (struct file *file, struct socket *sock,
146 struct poll_table_struct *wait);
147 int (*ioctl) (struct socket *sock, unsigned int cmd,
148 unsigned long arg);
149#ifdef CONFIG_COMPAT
150 int (*compat_ioctl) (struct socket *sock, unsigned int cmd,
151 unsigned long arg);
152#endif
153 int (*listen) (struct socket *sock, int len);
154 int (*shutdown) (struct socket *sock, int flags);
155 int (*setsockopt)(struct socket *sock, int level,
156 int optname, char __user *optval, unsigned int optlen);
157 int (*getsockopt)(struct socket *sock, int level,
158 int optname, char __user *optval, int __user *optlen);
159#ifdef CONFIG_COMPAT
160 int (*compat_setsockopt)(struct socket *sock, int level,
161 int optname, char __user *optval, unsigned int optlen);
162 int (*compat_getsockopt)(struct socket *sock, int level,
163 int optname, char __user *optval, int __user *optlen);
164#endif
165 int (*sendmsg) (struct kiocb *iocb, struct socket *sock,
166 struct msghdr *m, size_t total_len);
167 /* Notes for implementing recvmsg:
168 * ===============================
169 * msg->msg_namelen should get updated by the recvmsg handlers
170 * iff msg_name != NULL. It is by default 0 to prevent
171 * returning uninitialized memory to user space. The recvfrom
172 * handlers can assume that msg.msg_name is either NULL or has
173 * a minimum size of sizeof(struct sockaddr_storage).
174 */
175 int (*recvmsg) (struct kiocb *iocb, struct socket *sock,
176 struct msghdr *m, size_t total_len,
177 int flags);
178 int (*mmap) (struct file *file, struct socket *sock,
179 struct vm_area_struct * vma);
180 ssize_t (*sendpage) (struct socket *sock, struct page *page,
181 int offset, size_t size, int flags);
182 ssize_t (*splice_read)(struct socket *sock, loff_t *ppos,
183 struct pipe_inode_info *pipe, size_t len, unsigned int flags);
184 int (*set_peek_off)(struct sock *sk, int val);
185};
186
187#define DECLARE_SOCKADDR(type, dst, src) \
188 type dst = ({ __sockaddr_check_size(sizeof(*dst)); (type) src; })
189
190struct net_proto_family {
191 int family;
192 int (*create)(struct net *net, struct socket *sock,
193 int protocol, int kern);
194 struct module *owner;
195};
196
197struct iovec;
198struct kvec;
199
200enum {
201 SOCK_WAKE_IO,
202 SOCK_WAKE_WAITD,
203 SOCK_WAKE_SPACE,
204 SOCK_WAKE_URG,
205};
206
207int sock_wake_async(struct socket *sk, int how, int band);
208int sock_register(const struct net_proto_family *fam);
209void sock_unregister(int family);
210int __sock_create(struct net *net, int family, int type, int proto,
211 struct socket **res, int kern);
212int sock_create(int family, int type, int proto, struct socket **res);
213int sock_create_kern(int family, int type, int proto, struct socket **res);
214int sock_create_lite(int family, int type, int proto, struct socket **res);
215void sock_release(struct socket *sock);
216int sock_sendmsg(struct socket *sock, struct msghdr *msg, size_t len);
217int sock_recvmsg(struct socket *sock, struct msghdr *msg, size_t size,
218 int flags);
219struct file *sock_alloc_file(struct socket *sock, int flags, const char *dname);
220struct socket *sockfd_lookup(int fd, int *err);
221struct socket *sock_from_file(struct file *file, int *err);
222#define sockfd_put(sock) fput(sock->file)
223int net_ratelimit(void);
224
225#define net_ratelimited_function(function, ...) \
226do { \
227 if (net_ratelimit()) \
228 function(__VA_ARGS__); \
229} while (0)
230
231#define net_emerg_ratelimited(fmt, ...) \
232 net_ratelimited_function(pr_emerg, fmt, ##__VA_ARGS__)
233#define net_alert_ratelimited(fmt, ...) \
234 net_ratelimited_function(pr_alert, fmt, ##__VA_ARGS__)
235#define net_crit_ratelimited(fmt, ...) \
236 net_ratelimited_function(pr_crit, fmt, ##__VA_ARGS__)
237#define net_err_ratelimited(fmt, ...) \
238 net_ratelimited_function(pr_err, fmt, ##__VA_ARGS__)
239#define net_notice_ratelimited(fmt, ...) \
240 net_ratelimited_function(pr_notice, fmt, ##__VA_ARGS__)
241#define net_warn_ratelimited(fmt, ...) \
242 net_ratelimited_function(pr_warn, fmt, ##__VA_ARGS__)
243#define net_info_ratelimited(fmt, ...) \
244 net_ratelimited_function(pr_info, fmt, ##__VA_ARGS__)
245#define net_dbg_ratelimited(fmt, ...) \
246 net_ratelimited_function(pr_debug, fmt, ##__VA_ARGS__)
247
248#define net_random() prandom_u32()
249#define net_srandom(seed) prandom_seed((__force u32)(seed))
250
251bool __net_get_random_once(void *buf, int nbytes, bool *done,
252 struct static_key *done_key);
253
254#ifdef HAVE_JUMP_LABEL
255#define ___NET_RANDOM_STATIC_KEY_INIT ((struct static_key) \
256 { .enabled = ATOMIC_INIT(0), .entries = (void *)1 })
257#else /* !HAVE_JUMP_LABEL */
258#define ___NET_RANDOM_STATIC_KEY_INIT STATIC_KEY_INIT_FALSE
259#endif /* HAVE_JUMP_LABEL */
260
261#define net_get_random_once(buf, nbytes) \
262 ({ \
263 bool ___ret = false; \
264 static bool ___done = false; \
265 static struct static_key ___done_key = \
266 ___NET_RANDOM_STATIC_KEY_INIT; \
267 if (!static_key_true(&___done_key)) \
268 ___ret = __net_get_random_once(buf, \
269 nbytes, \
270 &___done, \
271 &___done_key); \
272 ___ret; \
273 })
274
275int kernel_sendmsg(struct socket *sock, struct msghdr *msg, struct kvec *vec,
276 size_t num, size_t len);
277int kernel_recvmsg(struct socket *sock, struct msghdr *msg, struct kvec *vec,
278 size_t num, size_t len, int flags);
279
280int kernel_bind(struct socket *sock, struct sockaddr *addr, int addrlen);
281int kernel_listen(struct socket *sock, int backlog);
282int kernel_accept(struct socket *sock, struct socket **newsock, int flags);
283int kernel_connect(struct socket *sock, struct sockaddr *addr, int addrlen,
284 int flags);
285int kernel_getsockname(struct socket *sock, struct sockaddr *addr,
286 int *addrlen);
287int kernel_getpeername(struct socket *sock, struct sockaddr *addr,
288 int *addrlen);
289int kernel_getsockopt(struct socket *sock, int level, int optname, char *optval,
290 int *optlen);
291int kernel_setsockopt(struct socket *sock, int level, int optname, char *optval,
292 unsigned int optlen);
293int kernel_sendpage(struct socket *sock, struct page *page, int offset,
294 size_t size, int flags);
295int kernel_sock_ioctl(struct socket *sock, int cmd, unsigned long arg);
296int kernel_sock_shutdown(struct socket *sock, enum sock_shutdown_cmd how);
297
298#define MODULE_ALIAS_NETPROTO(proto) \
299 MODULE_ALIAS("net-pf-" __stringify(proto))
300
301#define MODULE_ALIAS_NET_PF_PROTO(pf, proto) \
302 MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto))
303
304#define MODULE_ALIAS_NET_PF_PROTO_TYPE(pf, proto, type) \
305 MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto) \
306 "-type-" __stringify(type))
307
308#define MODULE_ALIAS_NET_PF_PROTO_NAME(pf, proto, name) \
309 MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto) \
310 name)
311#endif /* _LINUX_NET_H */