]> git.ipfire.org Git - thirdparty/linux.git/blame - include/linux/skmsg.h
Merge tag 'io_uring-5.7-2020-05-22' of git://git.kernel.dk/linux-block
[thirdparty/linux.git] / include / linux / skmsg.h
CommitLineData
604326b4
DB
1/* SPDX-License-Identifier: GPL-2.0 */
2/* Copyright (c) 2017 - 2018 Covalent IO, Inc. http://covalent.io */
3
4#ifndef _LINUX_SKMSG_H
5#define _LINUX_SKMSG_H
6
7#include <linux/bpf.h>
8#include <linux/filter.h>
9#include <linux/scatterlist.h>
10#include <linux/skbuff.h>
11
12#include <net/sock.h>
13#include <net/tcp.h>
14#include <net/strparser.h>
15
16#define MAX_MSG_FRAGS MAX_SKB_FRAGS
031097d9 17#define NR_MSG_FRAG_IDS (MAX_MSG_FRAGS + 1)
604326b4
DB
18
19enum __sk_action {
20 __SK_DROP = 0,
21 __SK_PASS,
22 __SK_REDIRECT,
23 __SK_NONE,
24};
25
26struct sk_msg_sg {
27 u32 start;
28 u32 curr;
29 u32 end;
30 u32 size;
31 u32 copybreak;
163ab96b 32 unsigned long copy;
031097d9
JK
33 /* The extra two elements:
34 * 1) used for chaining the front and sections when the list becomes
35 * partitioned (e.g. end < start). The crypto APIs require the
36 * chaining;
37 * 2) to chain tailer SG entries after the message.
d3b18ad3 38 */
031097d9 39 struct scatterlist data[MAX_MSG_FRAGS + 2];
604326b4 40};
031097d9 41static_assert(BITS_PER_LONG >= NR_MSG_FRAG_IDS);
604326b4 42
7a69c0f2 43/* UAPI in filter.c depends on struct sk_msg_sg being first element. */
604326b4
DB
44struct sk_msg {
45 struct sk_msg_sg sg;
46 void *data;
47 void *data_end;
48 u32 apply_bytes;
49 u32 cork_bytes;
50 u32 flags;
51 struct sk_buff *skb;
52 struct sock *sk_redir;
53 struct sock *sk;
54 struct list_head list;
55};
56
57struct sk_psock_progs {
58 struct bpf_prog *msg_parser;
59 struct bpf_prog *skb_parser;
60 struct bpf_prog *skb_verdict;
61};
62
63enum sk_psock_state_bits {
64 SK_PSOCK_TX_ENABLED,
65};
66
67struct sk_psock_link {
68 struct list_head list;
69 struct bpf_map *map;
70 void *link_raw;
71};
72
73struct sk_psock_parser {
74 struct strparser strp;
75 bool enabled;
76 void (*saved_data_ready)(struct sock *sk);
77};
78
79struct sk_psock_work_state {
80 struct sk_buff *skb;
81 u32 len;
82 u32 off;
83};
84
85struct sk_psock {
86 struct sock *sk;
87 struct sock *sk_redir;
88 u32 apply_bytes;
89 u32 cork_bytes;
90 u32 eval;
91 struct sk_msg *cork;
92 struct sk_psock_progs progs;
93 struct sk_psock_parser parser;
94 struct sk_buff_head ingress_skb;
95 struct list_head ingress_msg;
96 unsigned long state;
97 struct list_head link;
98 spinlock_t link_lock;
99 refcount_t refcnt;
100 void (*saved_unhash)(struct sock *sk);
101 void (*saved_close)(struct sock *sk, long timeout);
102 void (*saved_write_space)(struct sock *sk);
103 struct proto *sk_proto;
104 struct sk_psock_work_state work_state;
105 struct work_struct work;
106 union {
107 struct rcu_head rcu;
108 struct work_struct gc;
109 };
110};
111
112int sk_msg_alloc(struct sock *sk, struct sk_msg *msg, int len,
113 int elem_first_coalesce);
d829e9c4
DB
114int sk_msg_clone(struct sock *sk, struct sk_msg *dst, struct sk_msg *src,
115 u32 off, u32 len);
604326b4
DB
116void sk_msg_trim(struct sock *sk, struct sk_msg *msg, int len);
117int sk_msg_free(struct sock *sk, struct sk_msg *msg);
118int sk_msg_free_nocharge(struct sock *sk, struct sk_msg *msg);
119void sk_msg_free_partial(struct sock *sk, struct sk_msg *msg, u32 bytes);
120void sk_msg_free_partial_nocharge(struct sock *sk, struct sk_msg *msg,
121 u32 bytes);
122
123void sk_msg_return(struct sock *sk, struct sk_msg *msg, int bytes);
d3b18ad3 124void sk_msg_return_zero(struct sock *sk, struct sk_msg *msg, int bytes);
604326b4
DB
125
126int sk_msg_zerocopy_from_iter(struct sock *sk, struct iov_iter *from,
127 struct sk_msg *msg, u32 bytes);
128int sk_msg_memcopy_from_iter(struct sock *sk, struct iov_iter *from,
129 struct sk_msg *msg, u32 bytes);
130
131static inline void sk_msg_check_to_free(struct sk_msg *msg, u32 i, u32 bytes)
132{
133 WARN_ON(i == msg->sg.end && bytes);
134}
135
136static inline void sk_msg_apply_bytes(struct sk_psock *psock, u32 bytes)
137{
138 if (psock->apply_bytes) {
139 if (psock->apply_bytes < bytes)
140 psock->apply_bytes = 0;
141 else
142 psock->apply_bytes -= bytes;
143 }
144}
145
683916f6
JK
146static inline u32 sk_msg_iter_dist(u32 start, u32 end)
147{
031097d9 148 return end >= start ? end - start : end + (NR_MSG_FRAG_IDS - start);
683916f6
JK
149}
150
604326b4
DB
151#define sk_msg_iter_var_prev(var) \
152 do { \
153 if (var == 0) \
031097d9 154 var = NR_MSG_FRAG_IDS - 1; \
604326b4
DB
155 else \
156 var--; \
157 } while (0)
158
159#define sk_msg_iter_var_next(var) \
160 do { \
161 var++; \
031097d9 162 if (var == NR_MSG_FRAG_IDS) \
604326b4
DB
163 var = 0; \
164 } while (0)
165
166#define sk_msg_iter_prev(msg, which) \
167 sk_msg_iter_var_prev(msg->sg.which)
168
169#define sk_msg_iter_next(msg, which) \
170 sk_msg_iter_var_next(msg->sg.which)
171
172static inline void sk_msg_clear_meta(struct sk_msg *msg)
173{
174 memset(&msg->sg, 0, offsetofend(struct sk_msg_sg, copy));
175}
176
177static inline void sk_msg_init(struct sk_msg *msg)
178{
031097d9 179 BUILD_BUG_ON(ARRAY_SIZE(msg->sg.data) - 1 != NR_MSG_FRAG_IDS);
604326b4 180 memset(msg, 0, sizeof(*msg));
031097d9 181 sg_init_marker(msg->sg.data, NR_MSG_FRAG_IDS);
604326b4
DB
182}
183
184static inline void sk_msg_xfer(struct sk_msg *dst, struct sk_msg *src,
185 int which, u32 size)
186{
187 dst->sg.data[which] = src->sg.data[which];
188 dst->sg.data[which].length = size;
3f4c3127 189 dst->sg.size += size;
81aabbb9 190 src->sg.size -= size;
604326b4
DB
191 src->sg.data[which].length -= size;
192 src->sg.data[which].offset += size;
193}
194
d3b18ad3
JF
195static inline void sk_msg_xfer_full(struct sk_msg *dst, struct sk_msg *src)
196{
197 memcpy(dst, src, sizeof(*src));
198 sk_msg_init(src);
199}
200
8734a162
JF
201static inline bool sk_msg_full(const struct sk_msg *msg)
202{
031097d9 203 return sk_msg_iter_dist(msg->sg.start, msg->sg.end) == MAX_MSG_FRAGS;
8734a162
JF
204}
205
604326b4
DB
206static inline u32 sk_msg_elem_used(const struct sk_msg *msg)
207{
683916f6 208 return sk_msg_iter_dist(msg->sg.start, msg->sg.end);
604326b4
DB
209}
210
604326b4
DB
211static inline struct scatterlist *sk_msg_elem(struct sk_msg *msg, int which)
212{
213 return &msg->sg.data[which];
214}
215
6fff607e
JF
216static inline struct scatterlist sk_msg_elem_cpy(struct sk_msg *msg, int which)
217{
218 return msg->sg.data[which];
219}
220
604326b4
DB
221static inline struct page *sk_msg_page(struct sk_msg *msg, int which)
222{
223 return sg_page(sk_msg_elem(msg, which));
224}
225
226static inline bool sk_msg_to_ingress(const struct sk_msg *msg)
227{
228 return msg->flags & BPF_F_INGRESS;
229}
230
231static inline void sk_msg_compute_data_pointers(struct sk_msg *msg)
232{
233 struct scatterlist *sge = sk_msg_elem(msg, msg->sg.start);
234
163ab96b 235 if (test_bit(msg->sg.start, &msg->sg.copy)) {
604326b4
DB
236 msg->data = NULL;
237 msg->data_end = NULL;
238 } else {
239 msg->data = sg_virt(sge);
240 msg->data_end = msg->data + sge->length;
241 }
242}
243
244static inline void sk_msg_page_add(struct sk_msg *msg, struct page *page,
245 u32 len, u32 offset)
246{
247 struct scatterlist *sge;
248
249 get_page(page);
250 sge = sk_msg_elem(msg, msg->sg.end);
251 sg_set_page(sge, page, len, offset);
252 sg_unmark_end(sge);
253
163ab96b 254 __set_bit(msg->sg.end, &msg->sg.copy);
604326b4
DB
255 msg->sg.size += len;
256 sk_msg_iter_next(msg, end);
257}
258
d3b18ad3
JF
259static inline void sk_msg_sg_copy(struct sk_msg *msg, u32 i, bool copy_state)
260{
261 do {
163ab96b
JK
262 if (copy_state)
263 __set_bit(i, &msg->sg.copy);
264 else
265 __clear_bit(i, &msg->sg.copy);
d3b18ad3
JF
266 sk_msg_iter_var_next(i);
267 if (i == msg->sg.end)
268 break;
269 } while (1);
270}
271
272static inline void sk_msg_sg_copy_set(struct sk_msg *msg, u32 start)
273{
274 sk_msg_sg_copy(msg, start, true);
275}
276
277static inline void sk_msg_sg_copy_clear(struct sk_msg *msg, u32 start)
278{
279 sk_msg_sg_copy(msg, start, false);
280}
281
604326b4
DB
282static inline struct sk_psock *sk_psock(const struct sock *sk)
283{
284 return rcu_dereference_sk_user_data(sk);
285}
286
604326b4
DB
287static inline void sk_psock_queue_msg(struct sk_psock *psock,
288 struct sk_msg *msg)
289{
290 list_add_tail(&msg->list, &psock->ingress_msg);
291}
292
d3b18ad3
JF
293static inline bool sk_psock_queue_empty(const struct sk_psock *psock)
294{
295 return psock ? list_empty(&psock->ingress_msg) : true;
296}
297
604326b4
DB
298static inline void sk_psock_report_error(struct sk_psock *psock, int err)
299{
300 struct sock *sk = psock->sk;
301
302 sk->sk_err = err;
303 sk->sk_error_report(sk);
304}
305
306struct sk_psock *sk_psock_init(struct sock *sk, int node);
307
308int sk_psock_init_strp(struct sock *sk, struct sk_psock *psock);
309void sk_psock_start_strp(struct sock *sk, struct sk_psock *psock);
310void sk_psock_stop_strp(struct sock *sk, struct sk_psock *psock);
311
312int sk_psock_msg_verdict(struct sock *sk, struct sk_psock *psock,
313 struct sk_msg *msg);
314
315static inline struct sk_psock_link *sk_psock_init_link(void)
316{
317 return kzalloc(sizeof(struct sk_psock_link),
318 GFP_ATOMIC | __GFP_NOWARN);
319}
320
321static inline void sk_psock_free_link(struct sk_psock_link *link)
322{
323 kfree(link);
324}
325
326struct sk_psock_link *sk_psock_link_pop(struct sk_psock *psock);
604326b4
DB
327
328void __sk_psock_purge_ingress_msg(struct sk_psock *psock);
329
330static inline void sk_psock_cork_free(struct sk_psock *psock)
331{
332 if (psock->cork) {
333 sk_msg_free(psock->sk, psock->cork);
334 kfree(psock->cork);
335 psock->cork = NULL;
336 }
337}
338
339static inline void sk_psock_update_proto(struct sock *sk,
340 struct sk_psock *psock,
341 struct proto *ops)
342{
1a2e2013
LB
343 /* Initialize saved callbacks and original proto only once, since this
344 * function may be called multiple times for a psock, e.g. when
345 * psock->progs.msg_parser is updated.
346 *
347 * Since we've not installed the new proto, psock is not yet in use and
348 * we can initialize it without synchronization.
349 */
350 if (!psock->sk_proto) {
351 struct proto *orig = READ_ONCE(sk->sk_prot);
352
353 psock->saved_unhash = orig->unhash;
354 psock->saved_close = orig->close;
355 psock->saved_write_space = sk->sk_write_space;
356
357 psock->sk_proto = orig;
358 }
604326b4 359
b8e202d1
JS
360 /* Pairs with lockless read in sk_clone_lock() */
361 WRITE_ONCE(sk->sk_prot, ops);
604326b4
DB
362}
363
364static inline void sk_psock_restore_proto(struct sock *sk,
365 struct sk_psock *psock)
366{
4da6a196 367 sk->sk_prot->unhash = psock->saved_unhash;
7b70973d
LB
368 if (inet_csk_has_ulp(sk)) {
369 tcp_update_ulp(sk, psock->sk_proto, psock->saved_write_space);
370 } else {
371 sk->sk_write_space = psock->saved_write_space;
372 /* Pairs with lockless read in sk_clone_lock() */
373 WRITE_ONCE(sk->sk_prot, psock->sk_proto);
374 }
604326b4
DB
375}
376
377static inline void sk_psock_set_state(struct sk_psock *psock,
378 enum sk_psock_state_bits bit)
379{
380 set_bit(bit, &psock->state);
381}
382
383static inline void sk_psock_clear_state(struct sk_psock *psock,
384 enum sk_psock_state_bits bit)
385{
386 clear_bit(bit, &psock->state);
387}
388
389static inline bool sk_psock_test_state(const struct sk_psock *psock,
390 enum sk_psock_state_bits bit)
391{
392 return test_bit(bit, &psock->state);
393}
394
395static inline struct sk_psock *sk_psock_get(struct sock *sk)
396{
397 struct sk_psock *psock;
398
399 rcu_read_lock();
400 psock = sk_psock(sk);
401 if (psock && !refcount_inc_not_zero(&psock->refcnt))
402 psock = NULL;
403 rcu_read_unlock();
404 return psock;
405}
406
407void sk_psock_stop(struct sock *sk, struct sk_psock *psock);
408void sk_psock_destroy(struct rcu_head *rcu);
409void sk_psock_drop(struct sock *sk, struct sk_psock *psock);
410
411static inline void sk_psock_put(struct sock *sk, struct sk_psock *psock)
412{
413 if (refcount_dec_and_test(&psock->refcnt))
414 sk_psock_drop(sk, psock);
415}
416
552de910
JF
417static inline void sk_psock_data_ready(struct sock *sk, struct sk_psock *psock)
418{
419 if (psock->parser.enabled)
420 psock->parser.saved_data_ready(sk);
421 else
422 sk->sk_data_ready(sk);
423}
424
604326b4
DB
425static inline void psock_set_prog(struct bpf_prog **pprog,
426 struct bpf_prog *prog)
427{
428 prog = xchg(pprog, prog);
429 if (prog)
430 bpf_prog_put(prog);
431}
432
433static inline void psock_progs_drop(struct sk_psock_progs *progs)
434{
435 psock_set_prog(&progs->msg_parser, NULL);
436 psock_set_prog(&progs->skb_parser, NULL);
437 psock_set_prog(&progs->skb_verdict, NULL);
438}
439
440#endif /* _LINUX_SKMSG_H */