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>
12 static bool sk_msg_try_coalesce_ok(struct sk_msg *msg, int elem_first_coalesce)
14 if (msg->sg.end > msg->sg.start &&
15 elem_first_coalesce < msg->sg.end)
18 if (msg->sg.end < msg->sg.start &&
19 (elem_first_coalesce > msg->sg.start ||
20 elem_first_coalesce < msg->sg.end))
26 int sk_msg_alloc(struct sock *sk, struct sk_msg *msg, int len,
27 int elem_first_coalesce)
29 struct page_frag *pfrag = sk_page_frag(sk);
30 u32 osize = msg->sg.size;
35 struct scatterlist *sge;
39 if (!sk_page_frag_refill(sk, pfrag)) {
44 orig_offset = pfrag->offset;
45 use = min_t(int, len, pfrag->size - orig_offset);
46 if (!sk_wmem_schedule(sk, use)) {
52 sk_msg_iter_var_prev(i);
53 sge = &msg->sg.data[i];
55 if (sk_msg_try_coalesce_ok(msg, elem_first_coalesce) &&
56 sg_page(sge) == pfrag->page &&
57 sge->offset + sge->length == orig_offset) {
60 if (sk_msg_full(msg)) {
65 sge = &msg->sg.data[msg->sg.end];
67 sg_set_page(sge, pfrag->page, use, orig_offset);
68 get_page(pfrag->page);
69 sk_msg_iter_next(msg, end);
72 sk_mem_charge(sk, use);
81 sk_msg_trim(sk, msg, osize);
84 EXPORT_SYMBOL_GPL(sk_msg_alloc);
86 int sk_msg_clone(struct sock *sk, struct sk_msg *dst, struct sk_msg *src,
89 int i = src->sg.start;
90 struct scatterlist *sge = sk_msg_elem(src, i);
91 struct scatterlist *sgd = NULL;
95 if (sge->length > off)
98 sk_msg_iter_var_next(i);
99 if (i == src->sg.end && off)
101 sge = sk_msg_elem(src, i);
105 sge_len = sge->length - off;
110 sgd = sk_msg_elem(dst, dst->sg.end - 1);
113 (sg_page(sge) == sg_page(sgd)) &&
114 (sg_virt(sge) + off == sg_virt(sgd) + sgd->length)) {
115 sgd->length += sge_len;
116 dst->sg.size += sge_len;
117 } else if (!sk_msg_full(dst)) {
118 sge_off = sge->offset + off;
119 sk_msg_page_add(dst, sg_page(sge), sge_len, sge_off);
126 sk_mem_charge(sk, sge_len);
127 sk_msg_iter_var_next(i);
128 if (i == src->sg.end && len)
130 sge = sk_msg_elem(src, i);
135 EXPORT_SYMBOL_GPL(sk_msg_clone);
137 void sk_msg_return_zero(struct sock *sk, struct sk_msg *msg, int bytes)
139 int i = msg->sg.start;
142 struct scatterlist *sge = sk_msg_elem(msg, i);
144 if (bytes < sge->length) {
145 sge->length -= bytes;
146 sge->offset += bytes;
147 sk_mem_uncharge(sk, bytes);
151 sk_mem_uncharge(sk, sge->length);
152 bytes -= sge->length;
155 sk_msg_iter_var_next(i);
156 } while (bytes && i != msg->sg.end);
159 EXPORT_SYMBOL_GPL(sk_msg_return_zero);
161 void sk_msg_return(struct sock *sk, struct sk_msg *msg, int bytes)
163 int i = msg->sg.start;
166 struct scatterlist *sge = &msg->sg.data[i];
167 int uncharge = (bytes < sge->length) ? bytes : sge->length;
169 sk_mem_uncharge(sk, uncharge);
171 sk_msg_iter_var_next(i);
172 } while (i != msg->sg.end);
174 EXPORT_SYMBOL_GPL(sk_msg_return);
176 static int sk_msg_free_elem(struct sock *sk, struct sk_msg *msg, u32 i,
179 struct scatterlist *sge = sk_msg_elem(msg, i);
180 u32 len = sge->length;
182 /* When the skb owns the memory we free it from consume_skb path. */
185 sk_mem_uncharge(sk, len);
186 put_page(sg_page(sge));
188 memset(sge, 0, sizeof(*sge));
192 static int __sk_msg_free(struct sock *sk, struct sk_msg *msg, u32 i,
195 struct scatterlist *sge = sk_msg_elem(msg, i);
198 while (msg->sg.size) {
199 msg->sg.size -= sge->length;
200 freed += sk_msg_free_elem(sk, msg, i, charge);
201 sk_msg_iter_var_next(i);
202 sk_msg_check_to_free(msg, i, msg->sg.size);
203 sge = sk_msg_elem(msg, i);
205 consume_skb(msg->skb);
210 int sk_msg_free_nocharge(struct sock *sk, struct sk_msg *msg)
212 return __sk_msg_free(sk, msg, msg->sg.start, false);
214 EXPORT_SYMBOL_GPL(sk_msg_free_nocharge);
216 int sk_msg_free(struct sock *sk, struct sk_msg *msg)
218 return __sk_msg_free(sk, msg, msg->sg.start, true);
220 EXPORT_SYMBOL_GPL(sk_msg_free);
222 static void __sk_msg_free_partial(struct sock *sk, struct sk_msg *msg,
223 u32 bytes, bool charge)
225 struct scatterlist *sge;
226 u32 i = msg->sg.start;
229 sge = sk_msg_elem(msg, i);
232 if (bytes < sge->length) {
234 sk_mem_uncharge(sk, bytes);
235 sge->length -= bytes;
236 sge->offset += bytes;
237 msg->sg.size -= bytes;
241 msg->sg.size -= sge->length;
242 bytes -= sge->length;
243 sk_msg_free_elem(sk, msg, i, charge);
244 sk_msg_iter_var_next(i);
245 sk_msg_check_to_free(msg, i, bytes);
250 void sk_msg_free_partial(struct sock *sk, struct sk_msg *msg, u32 bytes)
252 __sk_msg_free_partial(sk, msg, bytes, true);
254 EXPORT_SYMBOL_GPL(sk_msg_free_partial);
256 void sk_msg_free_partial_nocharge(struct sock *sk, struct sk_msg *msg,
259 __sk_msg_free_partial(sk, msg, bytes, false);
262 void sk_msg_trim(struct sock *sk, struct sk_msg *msg, int len)
264 int trim = msg->sg.size - len;
272 sk_msg_iter_var_prev(i);
274 while (msg->sg.data[i].length &&
275 trim >= msg->sg.data[i].length) {
276 trim -= msg->sg.data[i].length;
277 sk_msg_free_elem(sk, msg, i, true);
278 sk_msg_iter_var_prev(i);
283 msg->sg.data[i].length -= trim;
284 sk_mem_uncharge(sk, trim);
285 /* Adjust copybreak if it falls into the trimmed part of last buf */
286 if (msg->sg.curr == i && msg->sg.copybreak > msg->sg.data[i].length)
287 msg->sg.copybreak = msg->sg.data[i].length;
289 sk_msg_iter_var_next(i);
292 /* If we trim data a full sg elem before curr pointer update
293 * copybreak and current so that any future copy operations
294 * start at new copy location.
295 * However trimed data that has not yet been used in a copy op
296 * does not require an update.
299 msg->sg.curr = msg->sg.start;
300 msg->sg.copybreak = 0;
301 } else if (sk_msg_iter_dist(msg->sg.start, msg->sg.curr) >=
302 sk_msg_iter_dist(msg->sg.start, msg->sg.end)) {
303 sk_msg_iter_var_prev(i);
305 msg->sg.copybreak = msg->sg.data[i].length;
308 EXPORT_SYMBOL_GPL(sk_msg_trim);
310 int sk_msg_zerocopy_from_iter(struct sock *sk, struct iov_iter *from,
311 struct sk_msg *msg, u32 bytes)
313 int i, maxpages, ret = 0, num_elems = sk_msg_elem_used(msg);
314 const int to_max_pages = MAX_MSG_FRAGS;
315 struct page *pages[MAX_MSG_FRAGS];
316 ssize_t orig, copied, use, offset;
321 maxpages = to_max_pages - num_elems;
327 copied = iov_iter_get_pages(from, pages, bytes, maxpages,
334 iov_iter_advance(from, copied);
336 msg->sg.size += copied;
339 use = min_t(int, copied, PAGE_SIZE - offset);
340 sg_set_page(&msg->sg.data[msg->sg.end],
341 pages[i], use, offset);
342 sg_unmark_end(&msg->sg.data[msg->sg.end]);
343 sk_mem_charge(sk, use);
347 sk_msg_iter_next(msg, end);
351 /* When zerocopy is mixed with sk_msg_*copy* operations we
352 * may have a copybreak set in this case clear and prefer
353 * zerocopy remainder when possible.
355 msg->sg.copybreak = 0;
356 msg->sg.curr = msg->sg.end;
359 /* Revert iov_iter updates, msg will need to use 'trim' later if it
360 * also needs to be cleared.
363 iov_iter_revert(from, msg->sg.size - orig);
366 EXPORT_SYMBOL_GPL(sk_msg_zerocopy_from_iter);
368 int sk_msg_memcopy_from_iter(struct sock *sk, struct iov_iter *from,
369 struct sk_msg *msg, u32 bytes)
371 int ret = -ENOSPC, i = msg->sg.curr;
372 struct scatterlist *sge;
377 sge = sk_msg_elem(msg, i);
378 /* This is possible if a trim operation shrunk the buffer */
379 if (msg->sg.copybreak >= sge->length) {
380 msg->sg.copybreak = 0;
381 sk_msg_iter_var_next(i);
382 if (i == msg->sg.end)
384 sge = sk_msg_elem(msg, i);
387 buf_size = sge->length - msg->sg.copybreak;
388 copy = (buf_size > bytes) ? bytes : buf_size;
389 to = sg_virt(sge) + msg->sg.copybreak;
390 msg->sg.copybreak += copy;
391 if (sk->sk_route_caps & NETIF_F_NOCACHE_COPY)
392 ret = copy_from_iter_nocache(to, copy, from);
394 ret = copy_from_iter(to, copy, from);
402 msg->sg.copybreak = 0;
403 sk_msg_iter_var_next(i);
404 } while (i != msg->sg.end);
409 EXPORT_SYMBOL_GPL(sk_msg_memcopy_from_iter);
411 static struct sk_msg *sk_psock_create_ingress_msg(struct sock *sk,
416 if (atomic_read(&sk->sk_rmem_alloc) > sk->sk_rcvbuf)
419 if (!sk_rmem_schedule(sk, skb, skb->truesize))
422 msg = kzalloc(sizeof(*msg), __GFP_NOWARN | GFP_ATOMIC);
430 static int sk_psock_skb_ingress_enqueue(struct sk_buff *skb,
431 struct sk_psock *psock,
435 int num_sge = skb_to_sgvec(skb, msg->sg.data, 0, skb->len);
438 if (unlikely(num_sge < 0)) {
445 msg->sg.size = copied;
446 msg->sg.end = num_sge;
449 sk_psock_queue_msg(psock, msg);
450 sk_psock_data_ready(sk, psock);
454 static int sk_psock_skb_ingress(struct sk_psock *psock, struct sk_buff *skb)
456 struct sock *sk = psock->sk;
459 msg = sk_psock_create_ingress_msg(sk, skb);
463 /* This will transition ownership of the data from the socket where
464 * the BPF program was run initiating the redirect to the socket
465 * we will eventually receive this data on. The data will be released
466 * from skb_consume found in __tcp_bpf_recvmsg() after its been copied
469 skb_set_owner_r(skb, sk);
470 return sk_psock_skb_ingress_enqueue(skb, psock, sk, msg);
473 /* Puts an skb on the ingress queue of the socket already assigned to the
474 * skb. In this case we do not need to check memory limits or skb_set_owner_r
475 * because the skb is already accounted for here.
477 static int sk_psock_skb_ingress_self(struct sk_psock *psock, struct sk_buff *skb)
479 struct sk_msg *msg = kzalloc(sizeof(*msg), __GFP_NOWARN | GFP_ATOMIC);
480 struct sock *sk = psock->sk;
485 return sk_psock_skb_ingress_enqueue(skb, psock, sk, msg);
488 static int sk_psock_handle_skb(struct sk_psock *psock, struct sk_buff *skb,
489 u32 off, u32 len, bool ingress)
492 return sk_psock_skb_ingress(psock, skb);
494 return skb_send_sock_locked(psock->sk, skb, off, len);
497 static void sk_psock_backlog(struct work_struct *work)
499 struct sk_psock *psock = container_of(work, struct sk_psock, work);
500 struct sk_psock_work_state *state = &psock->work_state;
506 /* Lock sock to avoid losing sk_socket during loop. */
507 lock_sock(psock->sk);
516 while ((skb = skb_dequeue(&psock->ingress_skb))) {
520 ingress = tcp_skb_bpf_ingress(skb);
523 if (likely(psock->sk->sk_socket))
524 ret = sk_psock_handle_skb(psock, skb, off,
527 if (ret == -EAGAIN) {
533 /* Hard errors break pipe and stop xmit. */
534 sk_psock_report_error(psock, ret ? -ret : EPIPE);
535 sk_psock_clear_state(psock, SK_PSOCK_TX_ENABLED);
547 release_sock(psock->sk);
550 struct sk_psock *sk_psock_init(struct sock *sk, int node)
552 struct sk_psock *psock = kzalloc_node(sizeof(*psock),
553 GFP_ATOMIC | __GFP_NOWARN,
559 psock->eval = __SK_NONE;
561 INIT_LIST_HEAD(&psock->link);
562 spin_lock_init(&psock->link_lock);
564 INIT_WORK(&psock->work, sk_psock_backlog);
565 INIT_LIST_HEAD(&psock->ingress_msg);
566 skb_queue_head_init(&psock->ingress_skb);
568 sk_psock_set_state(psock, SK_PSOCK_TX_ENABLED);
569 refcount_set(&psock->refcnt, 1);
571 rcu_assign_sk_user_data(sk, psock);
576 EXPORT_SYMBOL_GPL(sk_psock_init);
578 struct sk_psock_link *sk_psock_link_pop(struct sk_psock *psock)
580 struct sk_psock_link *link;
582 spin_lock_bh(&psock->link_lock);
583 link = list_first_entry_or_null(&psock->link, struct sk_psock_link,
586 list_del(&link->list);
587 spin_unlock_bh(&psock->link_lock);
591 void __sk_psock_purge_ingress_msg(struct sk_psock *psock)
593 struct sk_msg *msg, *tmp;
595 list_for_each_entry_safe(msg, tmp, &psock->ingress_msg, list) {
596 list_del(&msg->list);
597 sk_msg_free(psock->sk, msg);
602 static void sk_psock_zap_ingress(struct sk_psock *psock)
604 __skb_queue_purge(&psock->ingress_skb);
605 __sk_psock_purge_ingress_msg(psock);
608 static void sk_psock_link_destroy(struct sk_psock *psock)
610 struct sk_psock_link *link, *tmp;
612 list_for_each_entry_safe(link, tmp, &psock->link, list) {
613 list_del(&link->list);
614 sk_psock_free_link(link);
618 static void sk_psock_destroy_deferred(struct work_struct *gc)
620 struct sk_psock *psock = container_of(gc, struct sk_psock, gc);
622 /* No sk_callback_lock since already detached. */
624 /* Parser has been stopped */
625 if (psock->progs.skb_parser)
626 strp_done(&psock->parser.strp);
628 cancel_work_sync(&psock->work);
630 psock_progs_drop(&psock->progs);
632 sk_psock_link_destroy(psock);
633 sk_psock_cork_free(psock);
634 sk_psock_zap_ingress(psock);
637 sock_put(psock->sk_redir);
642 void sk_psock_destroy(struct rcu_head *rcu)
644 struct sk_psock *psock = container_of(rcu, struct sk_psock, rcu);
646 INIT_WORK(&psock->gc, sk_psock_destroy_deferred);
647 schedule_work(&psock->gc);
649 EXPORT_SYMBOL_GPL(sk_psock_destroy);
651 void sk_psock_drop(struct sock *sk, struct sk_psock *psock)
653 sk_psock_cork_free(psock);
654 sk_psock_zap_ingress(psock);
656 write_lock_bh(&sk->sk_callback_lock);
657 sk_psock_restore_proto(sk, psock);
658 rcu_assign_sk_user_data(sk, NULL);
659 if (psock->progs.skb_parser)
660 sk_psock_stop_strp(sk, psock);
661 write_unlock_bh(&sk->sk_callback_lock);
662 sk_psock_clear_state(psock, SK_PSOCK_TX_ENABLED);
664 call_rcu(&psock->rcu, sk_psock_destroy);
666 EXPORT_SYMBOL_GPL(sk_psock_drop);
668 static int sk_psock_map_verd(int verdict, bool redir)
672 return redir ? __SK_REDIRECT : __SK_PASS;
681 int sk_psock_msg_verdict(struct sock *sk, struct sk_psock *psock,
684 struct bpf_prog *prog;
689 prog = READ_ONCE(psock->progs.msg_parser);
690 if (unlikely(!prog)) {
695 sk_msg_compute_data_pointers(msg);
697 ret = BPF_PROG_RUN(prog, msg);
698 ret = sk_psock_map_verd(ret, msg->sk_redir);
699 psock->apply_bytes = msg->apply_bytes;
700 if (ret == __SK_REDIRECT) {
702 sock_put(psock->sk_redir);
703 psock->sk_redir = msg->sk_redir;
704 if (!psock->sk_redir) {
708 sock_hold(psock->sk_redir);
715 EXPORT_SYMBOL_GPL(sk_psock_msg_verdict);
717 static int sk_psock_bpf_run(struct sk_psock *psock, struct bpf_prog *prog,
723 bpf_compute_data_end_sk_skb(skb);
725 ret = BPF_PROG_RUN(prog, skb);
727 /* strparser clones the skb before handing it to a upper layer,
728 * meaning skb_orphan has been called. We NULL sk on the way out
729 * to ensure we don't trigger a BUG_ON() in skb/sk operations
730 * later and because we are not charging the memory of this skb
737 static struct sk_psock *sk_psock_from_strp(struct strparser *strp)
739 struct sk_psock_parser *parser;
741 parser = container_of(strp, struct sk_psock_parser, strp);
742 return container_of(parser, struct sk_psock, parser);
745 static void sk_psock_skb_redirect(struct sk_buff *skb)
747 struct sk_psock *psock_other;
748 struct sock *sk_other;
751 sk_other = tcp_skb_bpf_redirect_fetch(skb);
752 if (unlikely(!sk_other)) {
756 psock_other = sk_psock(sk_other);
757 if (!psock_other || sock_flag(sk_other, SOCK_DEAD) ||
758 !sk_psock_test_state(psock_other, SK_PSOCK_TX_ENABLED)) {
763 ingress = tcp_skb_bpf_ingress(skb);
764 if ((!ingress && sock_writeable(sk_other)) ||
766 atomic_read(&sk_other->sk_rmem_alloc) <=
767 sk_other->sk_rcvbuf)) {
769 skb_set_owner_w(skb, sk_other);
770 skb_queue_tail(&psock_other->ingress_skb, skb);
771 schedule_work(&psock_other->work);
777 static void sk_psock_tls_verdict_apply(struct sk_buff *skb, int verdict)
781 sk_psock_skb_redirect(skb);
790 int sk_psock_tls_strp_read(struct sk_psock *psock, struct sk_buff *skb)
792 struct bpf_prog *prog;
796 prog = READ_ONCE(psock->progs.skb_verdict);
798 tcp_skb_bpf_redirect_clear(skb);
799 ret = sk_psock_bpf_run(psock, prog, skb);
800 ret = sk_psock_map_verd(ret, tcp_skb_bpf_redirect_fetch(skb));
802 sk_psock_tls_verdict_apply(skb, ret);
806 EXPORT_SYMBOL_GPL(sk_psock_tls_strp_read);
808 static void sk_psock_verdict_apply(struct sk_psock *psock,
809 struct sk_buff *skb, int verdict)
811 struct tcp_skb_cb *tcp;
812 struct sock *sk_other;
817 sk_other = psock->sk;
818 if (sock_flag(sk_other, SOCK_DEAD) ||
819 !sk_psock_test_state(psock, SK_PSOCK_TX_ENABLED)) {
823 tcp = TCP_SKB_CB(skb);
824 tcp->bpf.flags |= BPF_F_INGRESS;
826 /* If the queue is empty then we can submit directly
827 * into the msg queue. If its not empty we have to
828 * queue work otherwise we may get OOO data. Otherwise,
829 * if sk_psock_skb_ingress errors will be handled by
830 * retrying later from workqueue.
832 if (skb_queue_empty(&psock->ingress_skb)) {
833 err = sk_psock_skb_ingress_self(psock, skb);
836 skb_queue_tail(&psock->ingress_skb, skb);
837 schedule_work(&psock->work);
841 sk_psock_skb_redirect(skb);
851 static void sk_psock_strp_read(struct strparser *strp, struct sk_buff *skb)
853 struct sk_psock *psock;
854 struct bpf_prog *prog;
860 psock = sk_psock(sk);
861 if (unlikely(!psock)) {
865 prog = READ_ONCE(psock->progs.skb_verdict);
868 tcp_skb_bpf_redirect_clear(skb);
869 ret = sk_psock_bpf_run(psock, prog, skb);
870 ret = sk_psock_map_verd(ret, tcp_skb_bpf_redirect_fetch(skb));
872 sk_psock_verdict_apply(psock, skb, ret);
877 static int sk_psock_strp_read_done(struct strparser *strp, int err)
882 static int sk_psock_strp_parse(struct strparser *strp, struct sk_buff *skb)
884 struct sk_psock *psock = sk_psock_from_strp(strp);
885 struct bpf_prog *prog;
889 prog = READ_ONCE(psock->progs.skb_parser);
891 ret = sk_psock_bpf_run(psock, prog, skb);
896 /* Called with socket lock held. */
897 static void sk_psock_strp_data_ready(struct sock *sk)
899 struct sk_psock *psock;
902 psock = sk_psock(sk);
904 if (tls_sw_has_ctx_rx(sk)) {
905 psock->parser.saved_data_ready(sk);
907 write_lock_bh(&sk->sk_callback_lock);
908 strp_data_ready(&psock->parser.strp);
909 write_unlock_bh(&sk->sk_callback_lock);
915 static void sk_psock_write_space(struct sock *sk)
917 struct sk_psock *psock;
918 void (*write_space)(struct sock *sk) = NULL;
921 psock = sk_psock(sk);
923 if (sk_psock_test_state(psock, SK_PSOCK_TX_ENABLED))
924 schedule_work(&psock->work);
925 write_space = psock->saved_write_space;
932 int sk_psock_init_strp(struct sock *sk, struct sk_psock *psock)
934 static const struct strp_callbacks cb = {
935 .rcv_msg = sk_psock_strp_read,
936 .read_sock_done = sk_psock_strp_read_done,
937 .parse_msg = sk_psock_strp_parse,
940 psock->parser.enabled = false;
941 return strp_init(&psock->parser.strp, sk, &cb);
944 void sk_psock_start_strp(struct sock *sk, struct sk_psock *psock)
946 struct sk_psock_parser *parser = &psock->parser;
951 parser->saved_data_ready = sk->sk_data_ready;
952 sk->sk_data_ready = sk_psock_strp_data_ready;
953 sk->sk_write_space = sk_psock_write_space;
954 parser->enabled = true;
957 void sk_psock_stop_strp(struct sock *sk, struct sk_psock *psock)
959 struct sk_psock_parser *parser = &psock->parser;
961 if (!parser->enabled)
964 sk->sk_data_ready = parser->saved_data_ready;
965 parser->saved_data_ready = NULL;
966 strp_stop(&parser->strp);
967 parser->enabled = false;