1 // SPDX-License-Identifier: GPL-2.0
2 /* Copyright (c) 2017 - 2018 Covalent IO, Inc. http://covalent.io */
4 #include <linux/skmsg.h>
5 #include <linux/skbuff.h>
6 #include <linux/scatterlist.h>
11 static bool sk_msg_try_coalesce_ok(struct sk_msg *msg, int elem_first_coalesce)
13 if (msg->sg.end > msg->sg.start &&
14 elem_first_coalesce < msg->sg.end)
17 if (msg->sg.end < msg->sg.start &&
18 (elem_first_coalesce > msg->sg.start ||
19 elem_first_coalesce < msg->sg.end))
25 int sk_msg_alloc(struct sock *sk, struct sk_msg *msg, int len,
26 int elem_first_coalesce)
28 struct page_frag *pfrag = sk_page_frag(sk);
33 struct scatterlist *sge;
37 if (!sk_page_frag_refill(sk, pfrag))
40 orig_offset = pfrag->offset;
41 use = min_t(int, len, pfrag->size - orig_offset);
42 if (!sk_wmem_schedule(sk, use))
46 sk_msg_iter_var_prev(i);
47 sge = &msg->sg.data[i];
49 if (sk_msg_try_coalesce_ok(msg, elem_first_coalesce) &&
50 sg_page(sge) == pfrag->page &&
51 sge->offset + sge->length == orig_offset) {
54 if (sk_msg_full(msg)) {
59 sge = &msg->sg.data[msg->sg.end];
61 sg_set_page(sge, pfrag->page, use, orig_offset);
62 get_page(pfrag->page);
63 sk_msg_iter_next(msg, end);
66 sk_mem_charge(sk, use);
74 EXPORT_SYMBOL_GPL(sk_msg_alloc);
76 int sk_msg_clone(struct sock *sk, struct sk_msg *dst, struct sk_msg *src,
79 int i = src->sg.start;
80 struct scatterlist *sge = sk_msg_elem(src, i);
81 struct scatterlist *sgd = NULL;
85 if (sge->length > off)
88 sk_msg_iter_var_next(i);
89 if (i == src->sg.end && off)
91 sge = sk_msg_elem(src, i);
95 sge_len = sge->length - off;
100 sgd = sk_msg_elem(dst, dst->sg.end - 1);
103 (sg_page(sge) == sg_page(sgd)) &&
104 (sg_virt(sge) + off == sg_virt(sgd) + sgd->length)) {
105 sgd->length += sge_len;
106 dst->sg.size += sge_len;
107 } else if (!sk_msg_full(dst)) {
108 sge_off = sge->offset + off;
109 sk_msg_page_add(dst, sg_page(sge), sge_len, sge_off);
116 sk_mem_charge(sk, sge_len);
117 sk_msg_iter_var_next(i);
118 if (i == src->sg.end && len)
120 sge = sk_msg_elem(src, i);
125 EXPORT_SYMBOL_GPL(sk_msg_clone);
127 void sk_msg_return_zero(struct sock *sk, struct sk_msg *msg, int bytes)
129 int i = msg->sg.start;
132 struct scatterlist *sge = sk_msg_elem(msg, i);
134 if (bytes < sge->length) {
135 sge->length -= bytes;
136 sge->offset += bytes;
137 sk_mem_uncharge(sk, bytes);
141 sk_mem_uncharge(sk, sge->length);
142 bytes -= sge->length;
145 sk_msg_iter_var_next(i);
146 } while (bytes && i != msg->sg.end);
149 EXPORT_SYMBOL_GPL(sk_msg_return_zero);
151 void sk_msg_return(struct sock *sk, struct sk_msg *msg, int bytes)
153 int i = msg->sg.start;
156 struct scatterlist *sge = &msg->sg.data[i];
157 int uncharge = (bytes < sge->length) ? bytes : sge->length;
159 sk_mem_uncharge(sk, uncharge);
161 sk_msg_iter_var_next(i);
162 } while (i != msg->sg.end);
164 EXPORT_SYMBOL_GPL(sk_msg_return);
166 static int sk_msg_free_elem(struct sock *sk, struct sk_msg *msg, u32 i,
169 struct scatterlist *sge = sk_msg_elem(msg, i);
170 u32 len = sge->length;
173 sk_mem_uncharge(sk, len);
175 put_page(sg_page(sge));
176 memset(sge, 0, sizeof(*sge));
180 static int __sk_msg_free(struct sock *sk, struct sk_msg *msg, u32 i,
183 struct scatterlist *sge = sk_msg_elem(msg, i);
186 while (msg->sg.size) {
187 msg->sg.size -= sge->length;
188 freed += sk_msg_free_elem(sk, msg, i, charge);
189 sk_msg_iter_var_next(i);
190 sk_msg_check_to_free(msg, i, msg->sg.size);
191 sge = sk_msg_elem(msg, i);
194 consume_skb(msg->skb);
199 int sk_msg_free_nocharge(struct sock *sk, struct sk_msg *msg)
201 return __sk_msg_free(sk, msg, msg->sg.start, false);
203 EXPORT_SYMBOL_GPL(sk_msg_free_nocharge);
205 int sk_msg_free(struct sock *sk, struct sk_msg *msg)
207 return __sk_msg_free(sk, msg, msg->sg.start, true);
209 EXPORT_SYMBOL_GPL(sk_msg_free);
211 static void __sk_msg_free_partial(struct sock *sk, struct sk_msg *msg,
212 u32 bytes, bool charge)
214 struct scatterlist *sge;
215 u32 i = msg->sg.start;
218 sge = sk_msg_elem(msg, i);
221 if (bytes < sge->length) {
223 sk_mem_uncharge(sk, bytes);
224 sge->length -= bytes;
225 sge->offset += bytes;
226 msg->sg.size -= bytes;
230 msg->sg.size -= sge->length;
231 bytes -= sge->length;
232 sk_msg_free_elem(sk, msg, i, charge);
233 sk_msg_iter_var_next(i);
234 sk_msg_check_to_free(msg, i, bytes);
239 void sk_msg_free_partial(struct sock *sk, struct sk_msg *msg, u32 bytes)
241 __sk_msg_free_partial(sk, msg, bytes, true);
243 EXPORT_SYMBOL_GPL(sk_msg_free_partial);
245 void sk_msg_free_partial_nocharge(struct sock *sk, struct sk_msg *msg,
248 __sk_msg_free_partial(sk, msg, bytes, false);
251 void sk_msg_trim(struct sock *sk, struct sk_msg *msg, int len)
253 int trim = msg->sg.size - len;
261 sk_msg_iter_var_prev(i);
263 while (msg->sg.data[i].length &&
264 trim >= msg->sg.data[i].length) {
265 trim -= msg->sg.data[i].length;
266 sk_msg_free_elem(sk, msg, i, true);
267 sk_msg_iter_var_prev(i);
272 msg->sg.data[i].length -= trim;
273 sk_mem_uncharge(sk, trim);
275 /* If we trim data before curr pointer update copybreak and current
276 * so that any future copy operations start at new copy location.
277 * However trimed data that has not yet been used in a copy op
278 * does not require an update.
280 if (msg->sg.curr >= i) {
282 msg->sg.copybreak = msg->sg.data[i].length;
284 sk_msg_iter_var_next(i);
287 EXPORT_SYMBOL_GPL(sk_msg_trim);
289 int sk_msg_zerocopy_from_iter(struct sock *sk, struct iov_iter *from,
290 struct sk_msg *msg, u32 bytes)
292 int i, maxpages, ret = 0, num_elems = sk_msg_elem_used(msg);
293 const int to_max_pages = MAX_MSG_FRAGS;
294 struct page *pages[MAX_MSG_FRAGS];
295 ssize_t orig, copied, use, offset;
300 maxpages = to_max_pages - num_elems;
306 copied = iov_iter_get_pages(from, pages, bytes, maxpages,
313 iov_iter_advance(from, copied);
315 msg->sg.size += copied;
318 use = min_t(int, copied, PAGE_SIZE - offset);
319 sg_set_page(&msg->sg.data[msg->sg.end],
320 pages[i], use, offset);
321 sg_unmark_end(&msg->sg.data[msg->sg.end]);
322 sk_mem_charge(sk, use);
326 sk_msg_iter_next(msg, end);
330 /* When zerocopy is mixed with sk_msg_*copy* operations we
331 * may have a copybreak set in this case clear and prefer
332 * zerocopy remainder when possible.
334 msg->sg.copybreak = 0;
335 msg->sg.curr = msg->sg.end;
338 /* Revert iov_iter updates, msg will need to use 'trim' later if it
339 * also needs to be cleared.
342 iov_iter_revert(from, msg->sg.size - orig);
345 EXPORT_SYMBOL_GPL(sk_msg_zerocopy_from_iter);
347 int sk_msg_memcopy_from_iter(struct sock *sk, struct iov_iter *from,
348 struct sk_msg *msg, u32 bytes)
350 int ret = -ENOSPC, i = msg->sg.curr;
351 struct scatterlist *sge;
356 sge = sk_msg_elem(msg, i);
357 /* This is possible if a trim operation shrunk the buffer */
358 if (msg->sg.copybreak >= sge->length) {
359 msg->sg.copybreak = 0;
360 sk_msg_iter_var_next(i);
361 if (i == msg->sg.end)
363 sge = sk_msg_elem(msg, i);
366 buf_size = sge->length - msg->sg.copybreak;
367 copy = (buf_size > bytes) ? bytes : buf_size;
368 to = sg_virt(sge) + msg->sg.copybreak;
369 msg->sg.copybreak += copy;
370 if (sk->sk_route_caps & NETIF_F_NOCACHE_COPY)
371 ret = copy_from_iter_nocache(to, copy, from);
373 ret = copy_from_iter(to, copy, from);
381 msg->sg.copybreak = 0;
382 sk_msg_iter_var_next(i);
383 } while (i != msg->sg.end);
388 EXPORT_SYMBOL_GPL(sk_msg_memcopy_from_iter);
390 static int sk_psock_skb_ingress(struct sk_psock *psock, struct sk_buff *skb)
392 struct sock *sk = psock->sk;
393 int copied = 0, num_sge;
396 msg = kzalloc(sizeof(*msg), __GFP_NOWARN | GFP_ATOMIC);
399 if (!sk_rmem_schedule(sk, skb, skb->len)) {
405 num_sge = skb_to_sgvec(skb, msg->sg.data, 0, skb->len);
406 if (unlikely(num_sge < 0)) {
411 sk_mem_charge(sk, skb->len);
414 msg->sg.end = num_sge == MAX_MSG_FRAGS ? 0 : num_sge;
417 sk_psock_queue_msg(psock, msg);
418 sk_psock_data_ready(sk, psock);
422 static int sk_psock_handle_skb(struct sk_psock *psock, struct sk_buff *skb,
423 u32 off, u32 len, bool ingress)
426 return sk_psock_skb_ingress(psock, skb);
428 return skb_send_sock_locked(psock->sk, skb, off, len);
431 static void sk_psock_backlog(struct work_struct *work)
433 struct sk_psock *psock = container_of(work, struct sk_psock, work);
434 struct sk_psock_work_state *state = &psock->work_state;
440 /* Lock sock to avoid losing sk_socket during loop. */
441 lock_sock(psock->sk);
450 while ((skb = skb_dequeue(&psock->ingress_skb))) {
454 ingress = tcp_skb_bpf_ingress(skb);
457 if (likely(psock->sk->sk_socket))
458 ret = sk_psock_handle_skb(psock, skb, off,
461 if (ret == -EAGAIN) {
467 /* Hard errors break pipe and stop xmit. */
468 sk_psock_report_error(psock, ret ? -ret : EPIPE);
469 sk_psock_clear_state(psock, SK_PSOCK_TX_ENABLED);
481 release_sock(psock->sk);
484 struct sk_psock *sk_psock_init(struct sock *sk, int node)
486 struct sk_psock *psock = kzalloc_node(sizeof(*psock),
487 GFP_ATOMIC | __GFP_NOWARN,
493 psock->eval = __SK_NONE;
495 INIT_LIST_HEAD(&psock->link);
496 spin_lock_init(&psock->link_lock);
498 INIT_WORK(&psock->work, sk_psock_backlog);
499 INIT_LIST_HEAD(&psock->ingress_msg);
500 skb_queue_head_init(&psock->ingress_skb);
502 sk_psock_set_state(psock, SK_PSOCK_TX_ENABLED);
503 refcount_set(&psock->refcnt, 1);
505 rcu_assign_sk_user_data(sk, psock);
510 EXPORT_SYMBOL_GPL(sk_psock_init);
512 struct sk_psock_link *sk_psock_link_pop(struct sk_psock *psock)
514 struct sk_psock_link *link;
516 spin_lock_bh(&psock->link_lock);
517 link = list_first_entry_or_null(&psock->link, struct sk_psock_link,
520 list_del(&link->list);
521 spin_unlock_bh(&psock->link_lock);
525 void __sk_psock_purge_ingress_msg(struct sk_psock *psock)
527 struct sk_msg *msg, *tmp;
529 list_for_each_entry_safe(msg, tmp, &psock->ingress_msg, list) {
530 list_del(&msg->list);
531 sk_msg_free(psock->sk, msg);
536 static void sk_psock_zap_ingress(struct sk_psock *psock)
538 __skb_queue_purge(&psock->ingress_skb);
539 __sk_psock_purge_ingress_msg(psock);
542 static void sk_psock_link_destroy(struct sk_psock *psock)
544 struct sk_psock_link *link, *tmp;
546 list_for_each_entry_safe(link, tmp, &psock->link, list) {
547 list_del(&link->list);
548 sk_psock_free_link(link);
552 static void sk_psock_destroy_deferred(struct work_struct *gc)
554 struct sk_psock *psock = container_of(gc, struct sk_psock, gc);
556 /* No sk_callback_lock since already detached. */
557 strp_stop(&psock->parser.strp);
558 strp_done(&psock->parser.strp);
560 cancel_work_sync(&psock->work);
562 psock_progs_drop(&psock->progs);
564 sk_psock_link_destroy(psock);
565 sk_psock_cork_free(psock);
566 sk_psock_zap_ingress(psock);
569 sock_put(psock->sk_redir);
574 void sk_psock_destroy(struct rcu_head *rcu)
576 struct sk_psock *psock = container_of(rcu, struct sk_psock, rcu);
578 INIT_WORK(&psock->gc, sk_psock_destroy_deferred);
579 schedule_work(&psock->gc);
581 EXPORT_SYMBOL_GPL(sk_psock_destroy);
583 void sk_psock_drop(struct sock *sk, struct sk_psock *psock)
585 rcu_assign_sk_user_data(sk, NULL);
586 sk_psock_cork_free(psock);
587 sk_psock_zap_ingress(psock);
588 sk_psock_restore_proto(sk, psock);
590 write_lock_bh(&sk->sk_callback_lock);
591 if (psock->progs.skb_parser)
592 sk_psock_stop_strp(sk, psock);
593 write_unlock_bh(&sk->sk_callback_lock);
594 sk_psock_clear_state(psock, SK_PSOCK_TX_ENABLED);
596 call_rcu(&psock->rcu, sk_psock_destroy);
598 EXPORT_SYMBOL_GPL(sk_psock_drop);
600 static int sk_psock_map_verd(int verdict, bool redir)
604 return redir ? __SK_REDIRECT : __SK_PASS;
613 int sk_psock_msg_verdict(struct sock *sk, struct sk_psock *psock,
616 struct bpf_prog *prog;
621 prog = READ_ONCE(psock->progs.msg_parser);
622 if (unlikely(!prog)) {
627 sk_msg_compute_data_pointers(msg);
629 ret = BPF_PROG_RUN(prog, msg);
630 ret = sk_psock_map_verd(ret, msg->sk_redir);
631 psock->apply_bytes = msg->apply_bytes;
632 if (ret == __SK_REDIRECT) {
634 sock_put(psock->sk_redir);
635 psock->sk_redir = msg->sk_redir;
636 if (!psock->sk_redir) {
640 sock_hold(psock->sk_redir);
647 EXPORT_SYMBOL_GPL(sk_psock_msg_verdict);
649 static int sk_psock_bpf_run(struct sk_psock *psock, struct bpf_prog *prog,
655 bpf_compute_data_end_sk_skb(skb);
657 ret = BPF_PROG_RUN(prog, skb);
659 /* strparser clones the skb before handing it to a upper layer,
660 * meaning skb_orphan has been called. We NULL sk on the way out
661 * to ensure we don't trigger a BUG_ON() in skb/sk operations
662 * later and because we are not charging the memory of this skb
669 static struct sk_psock *sk_psock_from_strp(struct strparser *strp)
671 struct sk_psock_parser *parser;
673 parser = container_of(strp, struct sk_psock_parser, strp);
674 return container_of(parser, struct sk_psock, parser);
677 static void sk_psock_verdict_apply(struct sk_psock *psock,
678 struct sk_buff *skb, int verdict)
680 struct sk_psock *psock_other;
681 struct sock *sk_other;
686 sk_other = psock->sk;
687 if (sock_flag(sk_other, SOCK_DEAD) ||
688 !sk_psock_test_state(psock, SK_PSOCK_TX_ENABLED)) {
691 if (atomic_read(&sk_other->sk_rmem_alloc) <=
692 sk_other->sk_rcvbuf) {
693 struct tcp_skb_cb *tcp = TCP_SKB_CB(skb);
695 tcp->bpf.flags |= BPF_F_INGRESS;
696 skb_queue_tail(&psock->ingress_skb, skb);
697 schedule_work(&psock->work);
702 sk_other = tcp_skb_bpf_redirect_fetch(skb);
703 if (unlikely(!sk_other))
705 psock_other = sk_psock(sk_other);
706 if (!psock_other || sock_flag(sk_other, SOCK_DEAD) ||
707 !sk_psock_test_state(psock_other, SK_PSOCK_TX_ENABLED))
709 ingress = tcp_skb_bpf_ingress(skb);
710 if ((!ingress && sock_writeable(sk_other)) ||
712 atomic_read(&sk_other->sk_rmem_alloc) <=
713 sk_other->sk_rcvbuf)) {
715 skb_set_owner_w(skb, sk_other);
716 skb_queue_tail(&psock_other->ingress_skb, skb);
717 schedule_work(&psock_other->work);
729 static void sk_psock_strp_read(struct strparser *strp, struct sk_buff *skb)
731 struct sk_psock *psock = sk_psock_from_strp(strp);
732 struct bpf_prog *prog;
736 prog = READ_ONCE(psock->progs.skb_verdict);
739 tcp_skb_bpf_redirect_clear(skb);
740 ret = sk_psock_bpf_run(psock, prog, skb);
741 ret = sk_psock_map_verd(ret, tcp_skb_bpf_redirect_fetch(skb));
744 sk_psock_verdict_apply(psock, skb, ret);
747 static int sk_psock_strp_read_done(struct strparser *strp, int err)
752 static int sk_psock_strp_parse(struct strparser *strp, struct sk_buff *skb)
754 struct sk_psock *psock = sk_psock_from_strp(strp);
755 struct bpf_prog *prog;
759 prog = READ_ONCE(psock->progs.skb_parser);
761 ret = sk_psock_bpf_run(psock, prog, skb);
766 /* Called with socket lock held. */
767 static void sk_psock_strp_data_ready(struct sock *sk)
769 struct sk_psock *psock;
772 psock = sk_psock(sk);
774 write_lock_bh(&sk->sk_callback_lock);
775 strp_data_ready(&psock->parser.strp);
776 write_unlock_bh(&sk->sk_callback_lock);
781 static void sk_psock_write_space(struct sock *sk)
783 struct sk_psock *psock;
784 void (*write_space)(struct sock *sk);
787 psock = sk_psock(sk);
788 if (likely(psock && sk_psock_test_state(psock, SK_PSOCK_TX_ENABLED)))
789 schedule_work(&psock->work);
790 write_space = psock->saved_write_space;
795 int sk_psock_init_strp(struct sock *sk, struct sk_psock *psock)
797 static const struct strp_callbacks cb = {
798 .rcv_msg = sk_psock_strp_read,
799 .read_sock_done = sk_psock_strp_read_done,
800 .parse_msg = sk_psock_strp_parse,
803 psock->parser.enabled = false;
804 return strp_init(&psock->parser.strp, sk, &cb);
807 void sk_psock_start_strp(struct sock *sk, struct sk_psock *psock)
809 struct sk_psock_parser *parser = &psock->parser;
814 parser->saved_data_ready = sk->sk_data_ready;
815 sk->sk_data_ready = sk_psock_strp_data_ready;
816 sk->sk_write_space = sk_psock_write_space;
817 parser->enabled = true;
820 void sk_psock_stop_strp(struct sock *sk, struct sk_psock *psock)
822 struct sk_psock_parser *parser = &psock->parser;
824 if (!parser->enabled)
827 sk->sk_data_ready = parser->saved_data_ready;
828 parser->saved_data_ready = NULL;
829 strp_stop(&parser->strp);
830 parser->enabled = false;