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/filter.h>
7 #include <linux/init.h>
8 #include <linux/wait.h>
9 #include <linux/util_macros.h>
11 #include <net/inet_common.h>
14 static int bpf_tcp_ingress(struct sock *sk, struct sk_psock *psock,
15 struct sk_msg *msg, u32 apply_bytes, int flags)
17 bool apply = apply_bytes;
18 struct scatterlist *sge;
23 tmp = kzalloc(sizeof(*tmp), __GFP_NOWARN | GFP_KERNEL);
28 tmp->sg.start = msg->sg.start;
31 sge = sk_msg_elem(msg, i);
32 size = (apply && apply_bytes < sge->length) ?
33 apply_bytes : sge->length;
34 if (!sk_wmem_schedule(sk, size)) {
40 sk_mem_charge(sk, size);
41 sk_msg_xfer(tmp, msg, i, size);
44 get_page(sk_msg_page(tmp, i));
45 sk_msg_iter_var_next(i);
51 sk_msg_iter_var_prev(i);
55 } while (i != msg->sg.end);
59 sk_psock_queue_msg(psock, tmp);
60 sk_psock_data_ready(sk, psock);
70 static int tcp_bpf_push(struct sock *sk, struct sk_msg *msg, u32 apply_bytes,
71 int flags, bool uncharge)
73 bool apply = apply_bytes;
74 struct scatterlist *sge;
82 sge = sk_msg_elem(msg, msg->sg.start);
83 size = (apply && apply_bytes < sge->length) ?
84 apply_bytes : sge->length;
88 tcp_rate_check_app_limited(sk);
90 has_tx_ulp = tls_sw_has_ctx_tx(sk);
92 flags |= MSG_SENDPAGE_NOPOLICY;
93 ret = kernel_sendpage_locked(sk,
94 page, off, size, flags);
96 ret = do_tcp_sendpages(sk, page, off, size, flags);
107 sk_mem_uncharge(sk, ret);
115 sk_msg_iter_next(msg, start);
116 sg_init_table(sge, 1);
117 if (msg->sg.start == msg->sg.end)
120 if (apply && !apply_bytes)
127 static int tcp_bpf_push_locked(struct sock *sk, struct sk_msg *msg,
128 u32 apply_bytes, int flags, bool uncharge)
133 ret = tcp_bpf_push(sk, msg, apply_bytes, flags, uncharge);
138 int tcp_bpf_sendmsg_redir(struct sock *sk, bool ingress,
139 struct sk_msg *msg, u32 bytes, int flags)
141 struct sk_psock *psock = sk_psock_get(sk);
144 if (unlikely(!psock))
147 ret = ingress ? bpf_tcp_ingress(sk, psock, msg, bytes, flags) :
148 tcp_bpf_push_locked(sk, msg, bytes, flags, false);
149 sk_psock_put(sk, psock);
152 EXPORT_SYMBOL_GPL(tcp_bpf_sendmsg_redir);
154 #ifdef CONFIG_BPF_SYSCALL
155 static int tcp_msg_wait_data(struct sock *sk, struct sk_psock *psock,
158 DEFINE_WAIT_FUNC(wait, woken_wake_function);
161 if (sk->sk_shutdown & RCV_SHUTDOWN)
167 add_wait_queue(sk_sleep(sk), &wait);
168 sk_set_bit(SOCKWQ_ASYNC_WAITDATA, sk);
169 ret = sk_wait_event(sk, &timeo,
170 !list_empty(&psock->ingress_msg) ||
171 !skb_queue_empty_lockless(&sk->sk_receive_queue), &wait);
172 sk_clear_bit(SOCKWQ_ASYNC_WAITDATA, sk);
173 remove_wait_queue(sk_sleep(sk), &wait);
177 static int tcp_bpf_recvmsg_parser(struct sock *sk,
184 struct sk_psock *psock;
187 if (unlikely(flags & MSG_ERRQUEUE))
188 return inet_recv_error(sk, msg, len, addr_len);
193 psock = sk_psock_get(sk);
194 if (unlikely(!psock))
195 return tcp_recvmsg(sk, msg, len, nonblock, flags, addr_len);
199 copied = sk_msg_recvmsg(sk, psock, msg, len, flags);
204 if (sock_flag(sk, SOCK_DONE))
208 copied = sock_error(sk);
212 if (sk->sk_shutdown & RCV_SHUTDOWN)
215 if (sk->sk_state == TCP_CLOSE) {
220 timeo = sock_rcvtimeo(sk, nonblock);
226 if (signal_pending(current)) {
227 copied = sock_intr_errno(timeo);
231 data = tcp_msg_wait_data(sk, psock, timeo);
232 if (data && !sk_psock_queue_empty(psock))
233 goto msg_bytes_ready;
238 sk_psock_put(sk, psock);
242 static int tcp_bpf_recvmsg(struct sock *sk, struct msghdr *msg, size_t len,
243 int nonblock, int flags, int *addr_len)
245 struct sk_psock *psock;
248 if (unlikely(flags & MSG_ERRQUEUE))
249 return inet_recv_error(sk, msg, len, addr_len);
254 psock = sk_psock_get(sk);
255 if (unlikely(!psock))
256 return tcp_recvmsg(sk, msg, len, nonblock, flags, addr_len);
257 if (!skb_queue_empty(&sk->sk_receive_queue) &&
258 sk_psock_queue_empty(psock)) {
259 sk_psock_put(sk, psock);
260 return tcp_recvmsg(sk, msg, len, nonblock, flags, addr_len);
264 copied = sk_msg_recvmsg(sk, psock, msg, len, flags);
269 timeo = sock_rcvtimeo(sk, nonblock);
270 data = tcp_msg_wait_data(sk, psock, timeo);
272 if (!sk_psock_queue_empty(psock))
273 goto msg_bytes_ready;
275 sk_psock_put(sk, psock);
276 return tcp_recvmsg(sk, msg, len, nonblock, flags, addr_len);
282 sk_psock_put(sk, psock);
286 static int tcp_bpf_send_verdict(struct sock *sk, struct sk_psock *psock,
287 struct sk_msg *msg, int *copied, int flags)
289 bool cork = false, enospc = sk_msg_full(msg), redir_ingress;
290 struct sock *sk_redir;
291 u32 tosend, origsize, sent, delta = 0;
296 if (psock->eval == __SK_NONE) {
297 /* Track delta in msg size to add/subtract it on SK_DROP from
298 * returned to user copied size. This ensures user doesn't
299 * get a positive return code with msg_cut_data and SK_DROP
302 delta = msg->sg.size;
303 psock->eval = sk_psock_msg_verdict(sk, psock, msg);
304 delta -= msg->sg.size;
307 if (msg->cork_bytes &&
308 msg->cork_bytes > msg->sg.size && !enospc) {
309 psock->cork_bytes = msg->cork_bytes - msg->sg.size;
311 psock->cork = kzalloc(sizeof(*psock->cork),
312 GFP_ATOMIC | __GFP_NOWARN);
316 memcpy(psock->cork, msg, sizeof(*msg));
320 tosend = msg->sg.size;
321 if (psock->apply_bytes && psock->apply_bytes < tosend)
322 tosend = psock->apply_bytes;
325 switch (psock->eval) {
327 ret = tcp_bpf_push(sk, msg, tosend, flags, true);
329 *copied -= sk_msg_free(sk, msg);
332 sk_msg_apply_bytes(psock, tosend);
335 redir_ingress = psock->redir_ingress;
336 sk_redir = psock->sk_redir;
337 sk_msg_apply_bytes(psock, tosend);
338 if (!psock->apply_bytes) {
339 /* Clean up before releasing the sock lock. */
341 psock->eval = __SK_NONE;
342 psock->sk_redir = NULL;
348 sk_msg_return(sk, msg, tosend);
351 origsize = msg->sg.size;
352 ret = tcp_bpf_sendmsg_redir(sk_redir, redir_ingress,
354 sent = origsize - msg->sg.size;
356 if (eval == __SK_REDIRECT)
360 if (unlikely(ret < 0)) {
361 int free = sk_msg_free_nocharge(sk, msg);
367 sk_msg_free(sk, msg);
375 sk_msg_free_partial(sk, msg, tosend);
376 sk_msg_apply_bytes(psock, tosend);
377 *copied -= (tosend + delta);
382 if (!psock->apply_bytes) {
383 psock->eval = __SK_NONE;
384 if (psock->sk_redir) {
385 sock_put(psock->sk_redir);
386 psock->sk_redir = NULL;
390 msg->sg.data[msg->sg.start].page_link &&
391 msg->sg.data[msg->sg.start].length) {
392 if (eval == __SK_REDIRECT)
393 sk_mem_charge(sk, tosend - sent);
400 static int tcp_bpf_sendmsg(struct sock *sk, struct msghdr *msg, size_t size)
402 struct sk_msg tmp, *msg_tx = NULL;
403 int copied = 0, err = 0;
404 struct sk_psock *psock;
408 /* Don't let internal do_tcp_sendpages() flags through */
409 flags = (msg->msg_flags & ~MSG_SENDPAGE_DECRYPTED);
410 flags |= MSG_NO_SHARED_FRAGS;
412 psock = sk_psock_get(sk);
413 if (unlikely(!psock))
414 return tcp_sendmsg(sk, msg, size);
417 timeo = sock_sndtimeo(sk, msg->msg_flags & MSG_DONTWAIT);
418 while (msg_data_left(msg)) {
427 copy = msg_data_left(msg);
428 if (!sk_stream_memory_free(sk))
429 goto wait_for_sndbuf;
431 msg_tx = psock->cork;
437 osize = msg_tx->sg.size;
438 err = sk_msg_alloc(sk, msg_tx, msg_tx->sg.size + copy, msg_tx->sg.end - 1);
441 goto wait_for_memory;
443 copy = msg_tx->sg.size - osize;
446 err = sk_msg_memcopy_from_iter(sk, &msg->msg_iter, msg_tx,
449 sk_msg_trim(sk, msg_tx, osize);
454 if (psock->cork_bytes) {
455 if (size > psock->cork_bytes)
456 psock->cork_bytes = 0;
458 psock->cork_bytes -= size;
459 if (psock->cork_bytes && !enospc)
461 /* All cork bytes are accounted, rerun the prog. */
462 psock->eval = __SK_NONE;
463 psock->cork_bytes = 0;
466 err = tcp_bpf_send_verdict(sk, psock, msg_tx, &copied, flags);
467 if (unlikely(err < 0))
471 set_bit(SOCK_NOSPACE, &sk->sk_socket->flags);
473 err = sk_stream_wait_memory(sk, &timeo);
475 if (msg_tx && msg_tx != psock->cork)
476 sk_msg_free(sk, msg_tx);
482 err = sk_stream_error(sk, msg->msg_flags, err);
484 sk_psock_put(sk, psock);
485 return copied ? copied : err;
488 static int tcp_bpf_sendpage(struct sock *sk, struct page *page, int offset,
489 size_t size, int flags)
491 struct sk_msg tmp, *msg = NULL;
492 int err = 0, copied = 0;
493 struct sk_psock *psock;
496 psock = sk_psock_get(sk);
497 if (unlikely(!psock))
498 return tcp_sendpage(sk, page, offset, size, flags);
508 /* Catch case where ring is full and sendpage is stalled. */
509 if (unlikely(sk_msg_full(msg)))
512 sk_msg_page_add(msg, page, size, offset);
513 sk_mem_charge(sk, size);
515 if (sk_msg_full(msg))
517 if (psock->cork_bytes) {
518 if (size > psock->cork_bytes)
519 psock->cork_bytes = 0;
521 psock->cork_bytes -= size;
522 if (psock->cork_bytes && !enospc)
524 /* All cork bytes are accounted, rerun the prog. */
525 psock->eval = __SK_NONE;
526 psock->cork_bytes = 0;
529 err = tcp_bpf_send_verdict(sk, psock, msg, &copied, flags);
532 sk_psock_put(sk, psock);
533 return copied ? copied : err;
550 static struct proto *tcpv6_prot_saved __read_mostly;
551 static DEFINE_SPINLOCK(tcpv6_prot_lock);
552 static struct proto tcp_bpf_prots[TCP_BPF_NUM_PROTS][TCP_BPF_NUM_CFGS];
554 static void tcp_bpf_rebuild_protos(struct proto prot[TCP_BPF_NUM_CFGS],
557 prot[TCP_BPF_BASE] = *base;
558 prot[TCP_BPF_BASE].destroy = sock_map_destroy;
559 prot[TCP_BPF_BASE].close = sock_map_close;
560 prot[TCP_BPF_BASE].recvmsg = tcp_bpf_recvmsg;
561 prot[TCP_BPF_BASE].sock_is_readable = sk_msg_is_readable;
563 prot[TCP_BPF_TX] = prot[TCP_BPF_BASE];
564 prot[TCP_BPF_TX].sendmsg = tcp_bpf_sendmsg;
565 prot[TCP_BPF_TX].sendpage = tcp_bpf_sendpage;
567 prot[TCP_BPF_RX] = prot[TCP_BPF_BASE];
568 prot[TCP_BPF_RX].recvmsg = tcp_bpf_recvmsg_parser;
570 prot[TCP_BPF_TXRX] = prot[TCP_BPF_TX];
571 prot[TCP_BPF_TXRX].recvmsg = tcp_bpf_recvmsg_parser;
574 static void tcp_bpf_check_v6_needs_rebuild(struct proto *ops)
576 if (unlikely(ops != smp_load_acquire(&tcpv6_prot_saved))) {
577 spin_lock_bh(&tcpv6_prot_lock);
578 if (likely(ops != tcpv6_prot_saved)) {
579 tcp_bpf_rebuild_protos(tcp_bpf_prots[TCP_BPF_IPV6], ops);
580 smp_store_release(&tcpv6_prot_saved, ops);
582 spin_unlock_bh(&tcpv6_prot_lock);
586 static int __init tcp_bpf_v4_build_proto(void)
588 tcp_bpf_rebuild_protos(tcp_bpf_prots[TCP_BPF_IPV4], &tcp_prot);
591 late_initcall(tcp_bpf_v4_build_proto);
593 static int tcp_bpf_assert_proto_ops(struct proto *ops)
595 /* In order to avoid retpoline, we make assumptions when we call
596 * into ops if e.g. a psock is not present. Make sure they are
597 * indeed valid assumptions.
599 return ops->recvmsg == tcp_recvmsg &&
600 ops->sendmsg == tcp_sendmsg &&
601 ops->sendpage == tcp_sendpage ? 0 : -ENOTSUPP;
604 int tcp_bpf_update_proto(struct sock *sk, struct sk_psock *psock, bool restore)
606 int family = sk->sk_family == AF_INET6 ? TCP_BPF_IPV6 : TCP_BPF_IPV4;
607 int config = psock->progs.msg_parser ? TCP_BPF_TX : TCP_BPF_BASE;
609 if (psock->progs.stream_verdict || psock->progs.skb_verdict) {
610 config = (config == TCP_BPF_TX) ? TCP_BPF_TXRX : TCP_BPF_RX;
614 if (inet_csk_has_ulp(sk)) {
615 /* TLS does not have an unhash proto in SW cases,
616 * but we need to ensure we stop using the sock_map
617 * unhash routine because the associated psock is being
618 * removed. So use the original unhash handler.
620 WRITE_ONCE(sk->sk_prot->unhash, psock->saved_unhash);
621 tcp_update_ulp(sk, psock->sk_proto, psock->saved_write_space);
623 sk->sk_write_space = psock->saved_write_space;
624 /* Pairs with lockless read in sk_clone_lock() */
625 WRITE_ONCE(sk->sk_prot, psock->sk_proto);
630 if (sk->sk_family == AF_INET6) {
631 if (tcp_bpf_assert_proto_ops(psock->sk_proto))
634 tcp_bpf_check_v6_needs_rebuild(psock->sk_proto);
637 /* Pairs with lockless read in sk_clone_lock() */
638 WRITE_ONCE(sk->sk_prot, &tcp_bpf_prots[family][config]);
641 EXPORT_SYMBOL_GPL(tcp_bpf_update_proto);
643 /* If a child got cloned from a listening socket that had tcp_bpf
644 * protocol callbacks installed, we need to restore the callbacks to
645 * the default ones because the child does not inherit the psock state
646 * that tcp_bpf callbacks expect.
648 void tcp_bpf_clone(const struct sock *sk, struct sock *newsk)
650 struct proto *prot = newsk->sk_prot;
652 if (is_insidevar(prot, tcp_bpf_prots))
653 newsk->sk_prot = sk->sk_prot_creator;
655 #endif /* CONFIG_BPF_SYSCALL */