net/ipv4/tcp_bpf.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /* Copyright (c) 2017 - 2018 Covalent IO, Inc. http://covalent.io */
   3
   4 #include <linux/skmsg.h>
   5 #include <linux/filter.h>
   6 #include <linux/bpf.h>
   7 #include <linux/init.h>
   8 #include <linux/wait.h>
   9
  10 #include <net/inet_common.h>
  11 #include <net/tls.h>
  12
  13 static int bpf_tcp_ingress(struct sock *sk, struct sk_psock *psock,
  14                            struct sk_msg *msg, u32 apply_bytes, int flags)
  15 {
  16         bool apply = apply_bytes;
  17         struct scatterlist *sge;
  18         u32 size, copied = 0;
  19         struct sk_msg *tmp;
  20         int i, ret = 0;
  21
  22         tmp = kzalloc(sizeof(*tmp), __GFP_NOWARN | GFP_KERNEL);
  23         if (unlikely(!tmp))
  24                 return -ENOMEM;
  25
  26         lock_sock(sk);
  27         tmp->sg.start = msg->sg.start;
  28         i = msg->sg.start;
  29         do {
  30                 sge = sk_msg_elem(msg, i);
  31                 size = (apply && apply_bytes < sge->length) ?
  32                         apply_bytes : sge->length;
  33                 if (!sk_wmem_schedule(sk, size)) {
  34                         if (!copied)
  35                                 ret = -ENOMEM;
  36                         break;
  37                 }
  38
  39                 sk_mem_charge(sk, size);
  40                 sk_msg_xfer(tmp, msg, i, size);
  41                 copied += size;
  42                 if (sge->length)
  43                         get_page(sk_msg_page(tmp, i));
  44                 sk_msg_iter_var_next(i);
  45                 tmp->sg.end = i;
  46                 if (apply) {
  47                         apply_bytes -= size;
  48                         if (!apply_bytes)
  49                                 break;
  50                 }
  51         } while (i != msg->sg.end);
  52
  53         if (!ret) {
  54                 msg->sg.start = i;
  55                 sk_psock_queue_msg(psock, tmp);
  56                 sk_psock_data_ready(sk, psock);
  57         } else {
  58                 sk_msg_free(sk, tmp);
  59                 kfree(tmp);
  60         }
  61
  62         release_sock(sk);
  63         return ret;
  64 }
  65
  66 static int tcp_bpf_push(struct sock *sk, struct sk_msg *msg, u32 apply_bytes,
  67                         int flags, bool uncharge)
  68 {
  69         bool apply = apply_bytes;
  70         struct scatterlist *sge;
  71         struct page *page;
  72         int size, ret = 0;
  73         u32 off;
  74
  75         while (1) {
  76                 bool has_tx_ulp;
  77
  78                 sge = sk_msg_elem(msg, msg->sg.start);
  79                 size = (apply && apply_bytes < sge->length) ?
  80                         apply_bytes : sge->length;
  81                 off  = sge->offset;
  82                 page = sg_page(sge);
  83
  84                 tcp_rate_check_app_limited(sk);
  85 retry:
  86                 has_tx_ulp = tls_sw_has_ctx_tx(sk);
  87                 if (has_tx_ulp) {
  88                         flags |= MSG_SENDPAGE_NOPOLICY;
  89                         ret = kernel_sendpage_locked(sk,
  90                                                      page, off, size, flags);
  91                 } else {
  92                         ret = do_tcp_sendpages(sk, page, off, size, flags);
  93                 }
  94
  95                 if (ret <= 0)
  96                         return ret;
  97                 if (apply)
  98                         apply_bytes -= ret;
  99                 msg->sg.size -= ret;
 100                 sge->offset += ret;
 101                 sge->length -= ret;
 102                 if (uncharge)
 103                         sk_mem_uncharge(sk, ret);
 104                 if (ret != size) {
 105                         size -= ret;
 106                         off  += ret;
 107                         goto retry;
 108                 }
 109                 if (!sge->length) {
 110                         put_page(page);
 111                         sk_msg_iter_next(msg, start);
 112                         sg_init_table(sge, 1);
 113                         if (msg->sg.start == msg->sg.end)
 114                                 break;
 115                 }
 116                 if (apply && !apply_bytes)
 117                         break;
 118         }
 119
 120         return 0;
 121 }
 122
 123 static int tcp_bpf_push_locked(struct sock *sk, struct sk_msg *msg,
 124                                u32 apply_bytes, int flags, bool uncharge)
 125 {
 126         int ret;
 127
 128         lock_sock(sk);
 129         ret = tcp_bpf_push(sk, msg, apply_bytes, flags, uncharge);
 130         release_sock(sk);
 131         return ret;
 132 }
 133
 134 int tcp_bpf_sendmsg_redir(struct sock *sk, struct sk_msg *msg,
 135                           u32 bytes, int flags)
 136 {
 137         bool ingress = sk_msg_to_ingress(msg);
 138         struct sk_psock *psock = sk_psock_get(sk);
 139         int ret;
 140
 141         if (unlikely(!psock)) {
 142                 sk_msg_free(sk, msg);
 143                 return 0;
 144         }
 145         ret = ingress ? bpf_tcp_ingress(sk, psock, msg, bytes, flags) :
 146                         tcp_bpf_push_locked(sk, msg, bytes, flags, false);
 147         sk_psock_put(sk, psock);
 148         return ret;
 149 }
 150 EXPORT_SYMBOL_GPL(tcp_bpf_sendmsg_redir);
 151
 152 #ifdef CONFIG_BPF_SYSCALL
 153 static bool tcp_bpf_stream_read(const struct sock *sk)
 154 {
 155         struct sk_psock *psock;
 156         bool empty = true;
 157
 158         rcu_read_lock();
 159         psock = sk_psock(sk);
 160         if (likely(psock))
 161                 empty = list_empty(&psock->ingress_msg);
 162         rcu_read_unlock();
 163         return !empty;
 164 }
 165
 166 static int tcp_msg_wait_data(struct sock *sk, struct sk_psock *psock,
 167                              long timeo)
 168 {
 169         DEFINE_WAIT_FUNC(wait, woken_wake_function);
 170         int ret = 0;
 171
 172         if (sk->sk_shutdown & RCV_SHUTDOWN)
 173                 return 1;
 174
 175         if (!timeo)
 176                 return ret;
 177
 178         add_wait_queue(sk_sleep(sk), &wait);
 179         sk_set_bit(SOCKWQ_ASYNC_WAITDATA, sk);
 180         ret = sk_wait_event(sk, &timeo,
 181                             !list_empty(&psock->ingress_msg) ||
 182                             !skb_queue_empty(&sk->sk_receive_queue), &wait);
 183         sk_clear_bit(SOCKWQ_ASYNC_WAITDATA, sk);
 184         remove_wait_queue(sk_sleep(sk), &wait);
 185         return ret;
 186 }
 187
 188 static int tcp_bpf_recvmsg(struct sock *sk, struct msghdr *msg, size_t len,
 189                     int nonblock, int flags, int *addr_len)
 190 {
 191         struct sk_psock *psock;
 192         int copied, ret;
 193
 194         if (unlikely(flags & MSG_ERRQUEUE))
 195                 return inet_recv_error(sk, msg, len, addr_len);
 196
 197         psock = sk_psock_get(sk);
 198         if (unlikely(!psock))
 199                 return tcp_recvmsg(sk, msg, len, nonblock, flags, addr_len);
 200         if (!skb_queue_empty(&sk->sk_receive_queue) &&
 201             sk_psock_queue_empty(psock)) {
 202                 sk_psock_put(sk, psock);
 203                 return tcp_recvmsg(sk, msg, len, nonblock, flags, addr_len);
 204         }
 205         lock_sock(sk);
 206 msg_bytes_ready:
 207         copied = sk_msg_recvmsg(sk, psock, msg, len, flags);
 208         if (!copied) {
 209                 long timeo;
 210                 int data;
 211
 212                 timeo = sock_rcvtimeo(sk, nonblock);
 213                 data = tcp_msg_wait_data(sk, psock, timeo);
 214                 if (data) {
 215                         if (!sk_psock_queue_empty(psock))
 216                                 goto msg_bytes_ready;
 217                         release_sock(sk);
 218                         sk_psock_put(sk, psock);
 219                         return tcp_recvmsg(sk, msg, len, nonblock, flags, addr_len);
 220                 }
 221                 copied = -EAGAIN;
 222         }
 223         ret = copied;
 224         release_sock(sk);
 225         sk_psock_put(sk, psock);
 226         return ret;
 227 }
 228
 229 static int tcp_bpf_send_verdict(struct sock *sk, struct sk_psock *psock,
 230                                 struct sk_msg *msg, int *copied, int flags)
 231 {
 232         bool cork = false, enospc = sk_msg_full(msg);
 233         struct sock *sk_redir;
 234         u32 tosend, delta = 0;
 235         u32 eval = __SK_NONE;
 236         int ret;
 237
 238 more_data:
 239         if (psock->eval == __SK_NONE) {
 240                 /* Track delta in msg size to add/subtract it on SK_DROP from
 241                  * returned to user copied size. This ensures user doesn't
 242                  * get a positive return code with msg_cut_data and SK_DROP
 243                  * verdict.
 244                  */
 245                 delta = msg->sg.size;
 246                 psock->eval = sk_psock_msg_verdict(sk, psock, msg);
 247                 delta -= msg->sg.size;
 248         }
 249
 250         if (msg->cork_bytes &&
 251             msg->cork_bytes > msg->sg.size && !enospc) {
 252                 psock->cork_bytes = msg->cork_bytes - msg->sg.size;
 253                 if (!psock->cork) {
 254                         psock->cork = kzalloc(sizeof(*psock->cork),
 255                                               GFP_ATOMIC | __GFP_NOWARN);
 256                         if (!psock->cork)
 257                                 return -ENOMEM;
 258                 }
 259                 memcpy(psock->cork, msg, sizeof(*msg));
 260                 return 0;
 261         }
 262
 263         tosend = msg->sg.size;
 264         if (psock->apply_bytes && psock->apply_bytes < tosend)
 265                 tosend = psock->apply_bytes;
 266
 267         switch (psock->eval) {
 268         case __SK_PASS:
 269                 ret = tcp_bpf_push(sk, msg, tosend, flags, true);
 270                 if (unlikely(ret)) {
 271                         *copied -= sk_msg_free(sk, msg);
 272                         break;
 273                 }
 274                 sk_msg_apply_bytes(psock, tosend);
 275                 break;
 276         case __SK_REDIRECT:
 277                 sk_redir = psock->sk_redir;
 278                 sk_msg_apply_bytes(psock, tosend);
 279                 if (!psock->apply_bytes) {
 280                         /* Clean up before releasing the sock lock. */
 281                         eval = psock->eval;
 282                         psock->eval = __SK_NONE;
 283                         psock->sk_redir = NULL;
 284                 }
 285                 if (psock->cork) {
 286                         cork = true;
 287                         psock->cork = NULL;
 288                 }
 289                 sk_msg_return(sk, msg, tosend);
 290                 release_sock(sk);
 291
 292                 ret = tcp_bpf_sendmsg_redir(sk_redir, msg, tosend, flags);
 293
 294                 if (eval == __SK_REDIRECT)
 295                         sock_put(sk_redir);
 296
 297                 lock_sock(sk);
 298                 if (unlikely(ret < 0)) {
 299                         int free = sk_msg_free_nocharge(sk, msg);
 300
 301                         if (!cork)
 302                                 *copied -= free;
 303                 }
 304                 if (cork) {
 305                         sk_msg_free(sk, msg);
 306                         kfree(msg);
 307                         msg = NULL;
 308                         ret = 0;
 309                 }
 310                 break;
 311         case __SK_DROP:
 312         default:
 313                 sk_msg_free_partial(sk, msg, tosend);
 314                 sk_msg_apply_bytes(psock, tosend);
 315                 *copied -= (tosend + delta);
 316                 return -EACCES;
 317         }
 318
 319         if (likely(!ret)) {
 320                 if (!psock->apply_bytes) {
 321                         psock->eval =  __SK_NONE;
 322                         if (psock->sk_redir) {
 323                                 sock_put(psock->sk_redir);
 324                                 psock->sk_redir = NULL;
 325                         }
 326                 }
 327                 if (msg &&
 328                     msg->sg.data[msg->sg.start].page_link &&
 329                     msg->sg.data[msg->sg.start].length)
 330                         goto more_data;
 331         }
 332         return ret;
 333 }
 334
 335 static int tcp_bpf_sendmsg(struct sock *sk, struct msghdr *msg, size_t size)
 336 {
 337         struct sk_msg tmp, *msg_tx = NULL;
 338         int copied = 0, err = 0;
 339         struct sk_psock *psock;
 340         long timeo;
 341         int flags;
 342
 343         /* Don't let internal do_tcp_sendpages() flags through */
 344         flags = (msg->msg_flags & ~MSG_SENDPAGE_DECRYPTED);
 345         flags |= MSG_NO_SHARED_FRAGS;
 346
 347         psock = sk_psock_get(sk);
 348         if (unlikely(!psock))
 349                 return tcp_sendmsg(sk, msg, size);
 350
 351         lock_sock(sk);
 352         timeo = sock_sndtimeo(sk, msg->msg_flags & MSG_DONTWAIT);
 353         while (msg_data_left(msg)) {
 354                 bool enospc = false;
 355                 u32 copy, osize;
 356
 357                 if (sk->sk_err) {
 358                         err = -sk->sk_err;
 359                         goto out_err;
 360                 }
 361
 362                 copy = msg_data_left(msg);
 363                 if (!sk_stream_memory_free(sk))
 364                         goto wait_for_sndbuf;
 365                 if (psock->cork) {
 366                         msg_tx = psock->cork;
 367                 } else {
 368                         msg_tx = &tmp;
 369                         sk_msg_init(msg_tx);
 370                 }
 371
 372                 osize = msg_tx->sg.size;
 373                 err = sk_msg_alloc(sk, msg_tx, msg_tx->sg.size + copy, msg_tx->sg.end - 1);
 374                 if (err) {
 375                         if (err != -ENOSPC)
 376                                 goto wait_for_memory;
 377                         enospc = true;
 378                         copy = msg_tx->sg.size - osize;
 379                 }
 380
 381                 err = sk_msg_memcopy_from_iter(sk, &msg->msg_iter, msg_tx,
 382                                                copy);
 383                 if (err < 0) {
 384                         sk_msg_trim(sk, msg_tx, osize);
 385                         goto out_err;
 386                 }
 387
 388                 copied += copy;
 389                 if (psock->cork_bytes) {
 390                         if (size > psock->cork_bytes)
 391                                 psock->cork_bytes = 0;
 392                         else
 393                                 psock->cork_bytes -= size;
 394                         if (psock->cork_bytes && !enospc)
 395                                 goto out_err;
 396                         /* All cork bytes are accounted, rerun the prog. */
 397                         psock->eval = __SK_NONE;
 398                         psock->cork_bytes = 0;
 399                 }
 400
 401                 err = tcp_bpf_send_verdict(sk, psock, msg_tx, &copied, flags);
 402                 if (unlikely(err < 0))
 403                         goto out_err;
 404                 continue;
 405 wait_for_sndbuf:
 406                 set_bit(SOCK_NOSPACE, &sk->sk_socket->flags);
 407 wait_for_memory:
 408                 err = sk_stream_wait_memory(sk, &timeo);
 409                 if (err) {
 410                         if (msg_tx && msg_tx != psock->cork)
 411                                 sk_msg_free(sk, msg_tx);
 412                         goto out_err;
 413                 }
 414         }
 415 out_err:
 416         if (err < 0)
 417                 err = sk_stream_error(sk, msg->msg_flags, err);
 418         release_sock(sk);
 419         sk_psock_put(sk, psock);
 420         return copied ? copied : err;
 421 }
 422
 423 static int tcp_bpf_sendpage(struct sock *sk, struct page *page, int offset,
 424                             size_t size, int flags)
 425 {
 426         struct sk_msg tmp, *msg = NULL;
 427         int err = 0, copied = 0;
 428         struct sk_psock *psock;
 429         bool enospc = false;
 430
 431         psock = sk_psock_get(sk);
 432         if (unlikely(!psock))
 433                 return tcp_sendpage(sk, page, offset, size, flags);
 434
 435         lock_sock(sk);
 436         if (psock->cork) {
 437                 msg = psock->cork;
 438         } else {
 439                 msg = &tmp;
 440                 sk_msg_init(msg);
 441         }
 442
 443         /* Catch case where ring is full and sendpage is stalled. */
 444         if (unlikely(sk_msg_full(msg)))
 445                 goto out_err;
 446
 447         sk_msg_page_add(msg, page, size, offset);
 448         sk_mem_charge(sk, size);
 449         copied = size;
 450         if (sk_msg_full(msg))
 451                 enospc = true;
 452         if (psock->cork_bytes) {
 453                 if (size > psock->cork_bytes)
 454                         psock->cork_bytes = 0;
 455                 else
 456                         psock->cork_bytes -= size;
 457                 if (psock->cork_bytes && !enospc)
 458                         goto out_err;
 459                 /* All cork bytes are accounted, rerun the prog. */
 460                 psock->eval = __SK_NONE;
 461                 psock->cork_bytes = 0;
 462         }
 463
 464         err = tcp_bpf_send_verdict(sk, psock, msg, &copied, flags);
 465 out_err:
 466         release_sock(sk);
 467         sk_psock_put(sk, psock);
 468         return copied ? copied : err;
 469 }
 470
 471 enum {
 472         TCP_BPF_IPV4,
 473         TCP_BPF_IPV6,
 474         TCP_BPF_NUM_PROTS,
 475 };
 476
 477 enum {
 478         TCP_BPF_BASE,
 479         TCP_BPF_TX,
 480         TCP_BPF_NUM_CFGS,
 481 };
 482
 483 static struct proto *tcpv6_prot_saved __read_mostly;
 484 static DEFINE_SPINLOCK(tcpv6_prot_lock);
 485 static struct proto tcp_bpf_prots[TCP_BPF_NUM_PROTS][TCP_BPF_NUM_CFGS];
 486
 487 static void tcp_bpf_rebuild_protos(struct proto prot[TCP_BPF_NUM_CFGS],
 488                                    struct proto *base)
 489 {
 490         prot[TCP_BPF_BASE]                      = *base;
 491         prot[TCP_BPF_BASE].unhash               = sock_map_unhash;
 492         prot[TCP_BPF_BASE].close                = sock_map_close;
 493         prot[TCP_BPF_BASE].recvmsg              = tcp_bpf_recvmsg;
 494         prot[TCP_BPF_BASE].stream_memory_read   = tcp_bpf_stream_read;
 495
 496         prot[TCP_BPF_TX]                        = prot[TCP_BPF_BASE];
 497         prot[TCP_BPF_TX].sendmsg                = tcp_bpf_sendmsg;
 498         prot[TCP_BPF_TX].sendpage               = tcp_bpf_sendpage;
 499 }
 500
 501 static void tcp_bpf_check_v6_needs_rebuild(struct proto *ops)
 502 {
 503         if (unlikely(ops != smp_load_acquire(&tcpv6_prot_saved))) {
 504                 spin_lock_bh(&tcpv6_prot_lock);
 505                 if (likely(ops != tcpv6_prot_saved)) {
 506                         tcp_bpf_rebuild_protos(tcp_bpf_prots[TCP_BPF_IPV6], ops);
 507                         smp_store_release(&tcpv6_prot_saved, ops);
 508                 }
 509                 spin_unlock_bh(&tcpv6_prot_lock);
 510         }
 511 }
 512
 513 static int __init tcp_bpf_v4_build_proto(void)
 514 {
 515         tcp_bpf_rebuild_protos(tcp_bpf_prots[TCP_BPF_IPV4], &tcp_prot);
 516         return 0;
 517 }
 518 late_initcall(tcp_bpf_v4_build_proto);
 519
 520 static int tcp_bpf_assert_proto_ops(struct proto *ops)
 521 {
 522         /* In order to avoid retpoline, we make assumptions when we call
 523          * into ops if e.g. a psock is not present. Make sure they are
 524          * indeed valid assumptions.
 525          */
 526         return ops->recvmsg  == tcp_recvmsg &&
 527                ops->sendmsg  == tcp_sendmsg &&
 528                ops->sendpage == tcp_sendpage ? 0 : -ENOTSUPP;
 529 }
 530
 531 int tcp_bpf_update_proto(struct sock *sk, struct sk_psock *psock, bool restore)
 532 {
 533         int family = sk->sk_family == AF_INET6 ? TCP_BPF_IPV6 : TCP_BPF_IPV4;
 534         int config = psock->progs.msg_parser   ? TCP_BPF_TX   : TCP_BPF_BASE;
 535
 536         if (restore) {
 537                 if (inet_csk_has_ulp(sk)) {
 538                         /* TLS does not have an unhash proto in SW cases,
 539                          * but we need to ensure we stop using the sock_map
 540                          * unhash routine because the associated psock is being
 541                          * removed. So use the original unhash handler.
 542                          */
 543                         WRITE_ONCE(sk->sk_prot->unhash, psock->saved_unhash);
 544                         tcp_update_ulp(sk, psock->sk_proto, psock->saved_write_space);
 545                 } else {
 546                         sk->sk_write_space = psock->saved_write_space;
 547                         /* Pairs with lockless read in sk_clone_lock() */
 548                         WRITE_ONCE(sk->sk_prot, psock->sk_proto);
 549                 }
 550                 return 0;
 551         }
 552
 553         if (inet_csk_has_ulp(sk))
 554                 return -EINVAL;
 555
 556         if (sk->sk_family == AF_INET6) {
 557                 if (tcp_bpf_assert_proto_ops(psock->sk_proto))
 558                         return -EINVAL;
 559
 560                 tcp_bpf_check_v6_needs_rebuild(psock->sk_proto);
 561         }
 562
 563         /* Pairs with lockless read in sk_clone_lock() */
 564         WRITE_ONCE(sk->sk_prot, &tcp_bpf_prots[family][config]);
 565         return 0;
 566 }
 567 EXPORT_SYMBOL_GPL(tcp_bpf_update_proto);
 568
 569 /* If a child got cloned from a listening socket that had tcp_bpf
 570  * protocol callbacks installed, we need to restore the callbacks to
 571  * the default ones because the child does not inherit the psock state
 572  * that tcp_bpf callbacks expect.
 573  */
 574 void tcp_bpf_clone(const struct sock *sk, struct sock *newsk)
 575 {
 576         int family = sk->sk_family == AF_INET6 ? TCP_BPF_IPV6 : TCP_BPF_IPV4;
 577         struct proto *prot = newsk->sk_prot;
 578
 579         if (prot == &tcp_bpf_prots[family][TCP_BPF_BASE])
 580                 newsk->sk_prot = sk->sk_prot_creator;
 581 }
 582 #endif /* CONFIG_BPF_SYSCALL */