net/xdp/xsk.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /* XDP sockets
   3  *
   4  * AF_XDP sockets allows a channel between XDP programs and userspace
   5  * applications.
   6  * Copyright(c) 2018 Intel Corporation.
   7  *
   8  * Author(s): Björn Töpel <bjorn.topel@intel.com>
   9  *            Magnus Karlsson <magnus.karlsson@intel.com>
  10  */
  11
  12 #define pr_fmt(fmt) "AF_XDP: %s: " fmt, __func__
  13
  14 #include <linux/if_xdp.h>
  15 #include <linux/init.h>
  16 #include <linux/sched/mm.h>
  17 #include <linux/sched/signal.h>
  18 #include <linux/sched/task.h>
  19 #include <linux/socket.h>
  20 #include <linux/file.h>
  21 #include <linux/uaccess.h>
  22 #include <linux/net.h>
  23 #include <linux/netdevice.h>
  24 #include <linux/rculist.h>
  25 #include <net/xdp_sock.h>
  26 #include <net/xdp.h>
  27
  28 #include "xsk_queue.h"
  29 #include "xdp_umem.h"
  30 #include "xsk.h"
  31
  32 #define TX_BATCH_SIZE 16
  33
  34 bool xsk_is_setup_for_bpf_map(struct xdp_sock *xs)
  35 {
  36         return READ_ONCE(xs->rx) &&  READ_ONCE(xs->umem) &&
  37                 READ_ONCE(xs->umem->fq);
  38 }
  39
  40 bool xsk_umem_has_addrs(struct xdp_umem *umem, u32 cnt)
  41 {
  42         return xskq_has_addrs(umem->fq, cnt);
  43 }
  44 EXPORT_SYMBOL(xsk_umem_has_addrs);
  45
  46 u64 *xsk_umem_peek_addr(struct xdp_umem *umem, u64 *addr)
  47 {
  48         return xskq_peek_addr(umem->fq, addr, umem);
  49 }
  50 EXPORT_SYMBOL(xsk_umem_peek_addr);
  51
  52 void xsk_umem_discard_addr(struct xdp_umem *umem)
  53 {
  54         xskq_discard_addr(umem->fq);
  55 }
  56 EXPORT_SYMBOL(xsk_umem_discard_addr);
  57
  58 void xsk_set_rx_need_wakeup(struct xdp_umem *umem)
  59 {
  60         if (umem->need_wakeup & XDP_WAKEUP_RX)
  61                 return;
  62
  63         umem->fq->ring->flags |= XDP_RING_NEED_WAKEUP;
  64         umem->need_wakeup |= XDP_WAKEUP_RX;
  65 }
  66 EXPORT_SYMBOL(xsk_set_rx_need_wakeup);
  67
  68 void xsk_set_tx_need_wakeup(struct xdp_umem *umem)
  69 {
  70         struct xdp_sock *xs;
  71
  72         if (umem->need_wakeup & XDP_WAKEUP_TX)
  73                 return;
  74
  75         rcu_read_lock();
  76         list_for_each_entry_rcu(xs, &umem->xsk_list, list) {
  77                 xs->tx->ring->flags |= XDP_RING_NEED_WAKEUP;
  78         }
  79         rcu_read_unlock();
  80
  81         umem->need_wakeup |= XDP_WAKEUP_TX;
  82 }
  83 EXPORT_SYMBOL(xsk_set_tx_need_wakeup);
  84
  85 void xsk_clear_rx_need_wakeup(struct xdp_umem *umem)
  86 {
  87         if (!(umem->need_wakeup & XDP_WAKEUP_RX))
  88                 return;
  89
  90         umem->fq->ring->flags &= ~XDP_RING_NEED_WAKEUP;
  91         umem->need_wakeup &= ~XDP_WAKEUP_RX;
  92 }
  93 EXPORT_SYMBOL(xsk_clear_rx_need_wakeup);
  94
  95 void xsk_clear_tx_need_wakeup(struct xdp_umem *umem)
  96 {
  97         struct xdp_sock *xs;
  98
  99         if (!(umem->need_wakeup & XDP_WAKEUP_TX))
 100                 return;
 101
 102         rcu_read_lock();
 103         list_for_each_entry_rcu(xs, &umem->xsk_list, list) {
 104                 xs->tx->ring->flags &= ~XDP_RING_NEED_WAKEUP;
 105         }
 106         rcu_read_unlock();
 107
 108         umem->need_wakeup &= ~XDP_WAKEUP_TX;
 109 }
 110 EXPORT_SYMBOL(xsk_clear_tx_need_wakeup);
 111
 112 bool xsk_umem_uses_need_wakeup(struct xdp_umem *umem)
 113 {
 114         return umem->flags & XDP_UMEM_USES_NEED_WAKEUP;
 115 }
 116 EXPORT_SYMBOL(xsk_umem_uses_need_wakeup);
 117
 118 /* If a buffer crosses a page boundary, we need to do 2 memcpy's, one for
 119  * each page. This is only required in copy mode.
 120  */
 121 static void __xsk_rcv_memcpy(struct xdp_umem *umem, u64 addr, void *from_buf,
 122                              u32 len, u32 metalen)
 123 {
 124         void *to_buf = xdp_umem_get_data(umem, addr);
 125
 126         addr = xsk_umem_add_offset_to_addr(addr);
 127         if (xskq_crosses_non_contig_pg(umem, addr, len + metalen)) {
 128                 void *next_pg_addr = umem->pages[(addr >> PAGE_SHIFT) + 1].addr;
 129                 u64 page_start = addr & ~(PAGE_SIZE - 1);
 130                 u64 first_len = PAGE_SIZE - (addr - page_start);
 131
 132                 memcpy(to_buf, from_buf, first_len);
 133                 memcpy(next_pg_addr, from_buf + first_len,
 134                        len + metalen - first_len);
 135
 136                 return;
 137         }
 138
 139         memcpy(to_buf, from_buf, len + metalen);
 140 }
 141
 142 static int __xsk_rcv(struct xdp_sock *xs, struct xdp_buff *xdp, u32 len)
 143 {
 144         u64 offset = xs->umem->headroom;
 145         u64 addr, memcpy_addr;
 146         void *from_buf;
 147         u32 metalen;
 148         int err;
 149
 150         if (!xskq_peek_addr(xs->umem->fq, &addr, xs->umem) ||
 151             len > xs->umem->chunk_size_nohr - XDP_PACKET_HEADROOM) {
 152                 xs->rx_dropped++;
 153                 return -ENOSPC;
 154         }
 155
 156         if (unlikely(xdp_data_meta_unsupported(xdp))) {
 157                 from_buf = xdp->data;
 158                 metalen = 0;
 159         } else {
 160                 from_buf = xdp->data_meta;
 161                 metalen = xdp->data - xdp->data_meta;
 162         }
 163
 164         memcpy_addr = xsk_umem_adjust_offset(xs->umem, addr, offset);
 165         __xsk_rcv_memcpy(xs->umem, memcpy_addr, from_buf, len, metalen);
 166
 167         offset += metalen;
 168         addr = xsk_umem_adjust_offset(xs->umem, addr, offset);
 169         err = xskq_produce_batch_desc(xs->rx, addr, len);
 170         if (!err) {
 171                 xskq_discard_addr(xs->umem->fq);
 172                 xdp_return_buff(xdp);
 173                 return 0;
 174         }
 175
 176         xs->rx_dropped++;
 177         return err;
 178 }
 179
 180 static int __xsk_rcv_zc(struct xdp_sock *xs, struct xdp_buff *xdp, u32 len)
 181 {
 182         int err = xskq_produce_batch_desc(xs->rx, (u64)xdp->handle, len);
 183
 184         if (err)
 185                 xs->rx_dropped++;
 186
 187         return err;
 188 }
 189
 190 static bool xsk_is_bound(struct xdp_sock *xs)
 191 {
 192         if (READ_ONCE(xs->state) == XSK_BOUND) {
 193                 /* Matches smp_wmb() in bind(). */
 194                 smp_rmb();
 195                 return true;
 196         }
 197         return false;
 198 }
 199
 200 int xsk_rcv(struct xdp_sock *xs, struct xdp_buff *xdp)
 201 {
 202         u32 len;
 203
 204         if (!xsk_is_bound(xs))
 205                 return -EINVAL;
 206
 207         if (xs->dev != xdp->rxq->dev || xs->queue_id != xdp->rxq->queue_index)
 208                 return -EINVAL;
 209
 210         len = xdp->data_end - xdp->data;
 211
 212         return (xdp->rxq->mem.type == MEM_TYPE_ZERO_COPY) ?
 213                 __xsk_rcv_zc(xs, xdp, len) : __xsk_rcv(xs, xdp, len);
 214 }
 215
 216 void xsk_flush(struct xdp_sock *xs)
 217 {
 218         xskq_produce_flush_desc(xs->rx);
 219         xs->sk.sk_data_ready(&xs->sk);
 220 }
 221
 222 int xsk_generic_rcv(struct xdp_sock *xs, struct xdp_buff *xdp)
 223 {
 224         u32 metalen = xdp->data - xdp->data_meta;
 225         u32 len = xdp->data_end - xdp->data;
 226         u64 offset = xs->umem->headroom;
 227         void *buffer;
 228         u64 addr;
 229         int err;
 230
 231         spin_lock_bh(&xs->rx_lock);
 232
 233         if (xs->dev != xdp->rxq->dev || xs->queue_id != xdp->rxq->queue_index) {
 234                 err = -EINVAL;
 235                 goto out_unlock;
 236         }
 237
 238         if (!xskq_peek_addr(xs->umem->fq, &addr, xs->umem) ||
 239             len > xs->umem->chunk_size_nohr - XDP_PACKET_HEADROOM) {
 240                 err = -ENOSPC;
 241                 goto out_drop;
 242         }
 243
 244         addr = xsk_umem_adjust_offset(xs->umem, addr, offset);
 245         buffer = xdp_umem_get_data(xs->umem, addr);
 246         memcpy(buffer, xdp->data_meta, len + metalen);
 247
 248         addr = xsk_umem_adjust_offset(xs->umem, addr, metalen);
 249         err = xskq_produce_batch_desc(xs->rx, addr, len);
 250         if (err)
 251                 goto out_drop;
 252
 253         xskq_discard_addr(xs->umem->fq);
 254         xskq_produce_flush_desc(xs->rx);
 255
 256         spin_unlock_bh(&xs->rx_lock);
 257
 258         xs->sk.sk_data_ready(&xs->sk);
 259         return 0;
 260
 261 out_drop:
 262         xs->rx_dropped++;
 263 out_unlock:
 264         spin_unlock_bh(&xs->rx_lock);
 265         return err;
 266 }
 267
 268 void xsk_umem_complete_tx(struct xdp_umem *umem, u32 nb_entries)
 269 {
 270         xskq_produce_flush_addr_n(umem->cq, nb_entries);
 271 }
 272 EXPORT_SYMBOL(xsk_umem_complete_tx);
 273
 274 void xsk_umem_consume_tx_done(struct xdp_umem *umem)
 275 {
 276         struct xdp_sock *xs;
 277
 278         rcu_read_lock();
 279         list_for_each_entry_rcu(xs, &umem->xsk_list, list) {
 280                 xs->sk.sk_write_space(&xs->sk);
 281         }
 282         rcu_read_unlock();
 283 }
 284 EXPORT_SYMBOL(xsk_umem_consume_tx_done);
 285
 286 bool xsk_umem_consume_tx(struct xdp_umem *umem, struct xdp_desc *desc)
 287 {
 288         struct xdp_sock *xs;
 289
 290         rcu_read_lock();
 291         list_for_each_entry_rcu(xs, &umem->xsk_list, list) {
 292                 if (!xskq_peek_desc(xs->tx, desc, umem))
 293                         continue;
 294
 295                 if (xskq_produce_addr_lazy(umem->cq, desc->addr))
 296                         goto out;
 297
 298                 xskq_discard_desc(xs->tx);
 299                 rcu_read_unlock();
 300                 return true;
 301         }
 302
 303 out:
 304         rcu_read_unlock();
 305         return false;
 306 }
 307 EXPORT_SYMBOL(xsk_umem_consume_tx);
 308
 309 static int xsk_wakeup(struct xdp_sock *xs, u8 flags)
 310 {
 311         struct net_device *dev = xs->dev;
 312         int err;
 313
 314         rcu_read_lock();
 315         err = dev->netdev_ops->ndo_xsk_wakeup(dev, xs->queue_id, flags);
 316         rcu_read_unlock();
 317
 318         return err;
 319 }
 320
 321 static int xsk_zc_xmit(struct xdp_sock *xs)
 322 {
 323         return xsk_wakeup(xs, XDP_WAKEUP_TX);
 324 }
 325
 326 static void xsk_destruct_skb(struct sk_buff *skb)
 327 {
 328         u64 addr = (u64)(long)skb_shinfo(skb)->destructor_arg;
 329         struct xdp_sock *xs = xdp_sk(skb->sk);
 330         unsigned long flags;
 331
 332         spin_lock_irqsave(&xs->tx_completion_lock, flags);
 333         WARN_ON_ONCE(xskq_produce_addr(xs->umem->cq, addr));
 334         spin_unlock_irqrestore(&xs->tx_completion_lock, flags);
 335
 336         sock_wfree(skb);
 337 }
 338
 339 static int xsk_generic_xmit(struct sock *sk)
 340 {
 341         struct xdp_sock *xs = xdp_sk(sk);
 342         u32 max_batch = TX_BATCH_SIZE;
 343         bool sent_frame = false;
 344         struct xdp_desc desc;
 345         struct sk_buff *skb;
 346         int err = 0;
 347
 348         mutex_lock(&xs->mutex);
 349
 350         if (xs->queue_id >= xs->dev->real_num_tx_queues)
 351                 goto out;
 352
 353         while (xskq_peek_desc(xs->tx, &desc, xs->umem)) {
 354                 char *buffer;
 355                 u64 addr;
 356                 u32 len;
 357
 358                 if (max_batch-- == 0) {
 359                         err = -EAGAIN;
 360                         goto out;
 361                 }
 362
 363                 len = desc.len;
 364                 skb = sock_alloc_send_skb(sk, len, 1, &err);
 365                 if (unlikely(!skb))
 366                         goto out;
 367
 368                 skb_put(skb, len);
 369                 addr = desc.addr;
 370                 buffer = xdp_umem_get_data(xs->umem, addr);
 371                 err = skb_store_bits(skb, 0, buffer, len);
 372                 if (unlikely(err) || xskq_reserve_addr(xs->umem->cq)) {
 373                         kfree_skb(skb);
 374                         goto out;
 375                 }
 376
 377                 skb->dev = xs->dev;
 378                 skb->priority = sk->sk_priority;
 379                 skb->mark = sk->sk_mark;
 380                 skb_shinfo(skb)->destructor_arg = (void *)(long)desc.addr;
 381                 skb->destructor = xsk_destruct_skb;
 382
 383                 err = dev_direct_xmit(skb, xs->queue_id);
 384                 xskq_discard_desc(xs->tx);
 385                 /* Ignore NET_XMIT_CN as packet might have been sent */
 386                 if (err == NET_XMIT_DROP || err == NETDEV_TX_BUSY) {
 387                         /* SKB completed but not sent */
 388                         err = -EBUSY;
 389                         goto out;
 390                 }
 391
 392                 sent_frame = true;
 393         }
 394
 395 out:
 396         if (sent_frame)
 397                 sk->sk_write_space(sk);
 398
 399         mutex_unlock(&xs->mutex);
 400         return err;
 401 }
 402
 403 static int __xsk_sendmsg(struct sock *sk)
 404 {
 405         struct xdp_sock *xs = xdp_sk(sk);
 406
 407         if (unlikely(!(xs->dev->flags & IFF_UP)))
 408                 return -ENETDOWN;
 409         if (unlikely(!xs->tx))
 410                 return -ENOBUFS;
 411
 412         return xs->zc ? xsk_zc_xmit(xs) : xsk_generic_xmit(sk);
 413 }
 414
 415 static int xsk_sendmsg(struct socket *sock, struct msghdr *m, size_t total_len)
 416 {
 417         bool need_wait = !(m->msg_flags & MSG_DONTWAIT);
 418         struct sock *sk = sock->sk;
 419         struct xdp_sock *xs = xdp_sk(sk);
 420
 421         if (unlikely(!xsk_is_bound(xs)))
 422                 return -ENXIO;
 423         if (unlikely(need_wait))
 424                 return -EOPNOTSUPP;
 425
 426         return __xsk_sendmsg(sk);
 427 }
 428
 429 static __poll_t xsk_poll(struct file *file, struct socket *sock,
 430                              struct poll_table_struct *wait)
 431 {
 432         __poll_t mask = 0;
 433         struct sock *sk = sock->sk;
 434         struct xdp_sock *xs = xdp_sk(sk);
 435         struct xdp_umem *umem;
 436
 437         sock_poll_wait(file, sock, wait);
 438
 439         if (unlikely(!xsk_is_bound(xs)))
 440                 return mask;
 441
 442         umem = xs->umem;
 443
 444         if (umem->need_wakeup) {
 445                 if (xs->zc)
 446                         xsk_wakeup(xs, umem->need_wakeup);
 447                 else
 448                         /* Poll needs to drive Tx also in copy mode */
 449                         __xsk_sendmsg(sk);
 450         }
 451
 452         if (xs->rx && !xskq_empty_desc(xs->rx))
 453                 mask |= EPOLLIN | EPOLLRDNORM;
 454         if (xs->tx && !xskq_full_desc(xs->tx))
 455                 mask |= EPOLLOUT | EPOLLWRNORM;
 456
 457         return mask;
 458 }
 459
 460 static int xsk_init_queue(u32 entries, struct xsk_queue **queue,
 461                           bool umem_queue)
 462 {
 463         struct xsk_queue *q;
 464
 465         if (entries == 0 || *queue || !is_power_of_2(entries))
 466                 return -EINVAL;
 467
 468         q = xskq_create(entries, umem_queue);
 469         if (!q)
 470                 return -ENOMEM;
 471
 472         /* Make sure queue is ready before it can be seen by others */
 473         smp_wmb();
 474         WRITE_ONCE(*queue, q);
 475         return 0;
 476 }
 477
 478 static void xsk_unbind_dev(struct xdp_sock *xs)
 479 {
 480         struct net_device *dev = xs->dev;
 481
 482         if (xs->state != XSK_BOUND)
 483                 return;
 484         WRITE_ONCE(xs->state, XSK_UNBOUND);
 485
 486         /* Wait for driver to stop using the xdp socket. */
 487         xdp_del_sk_umem(xs->umem, xs);
 488         xs->dev = NULL;
 489         synchronize_net();
 490         dev_put(dev);
 491 }
 492
 493 static struct xsk_map *xsk_get_map_list_entry(struct xdp_sock *xs,
 494                                               struct xdp_sock ***map_entry)
 495 {
 496         struct xsk_map *map = NULL;
 497         struct xsk_map_node *node;
 498
 499         *map_entry = NULL;
 500
 501         spin_lock_bh(&xs->map_list_lock);
 502         node = list_first_entry_or_null(&xs->map_list, struct xsk_map_node,
 503                                         node);
 504         if (node) {
 505                 WARN_ON(xsk_map_inc(node->map));
 506                 map = node->map;
 507                 *map_entry = node->map_entry;
 508         }
 509         spin_unlock_bh(&xs->map_list_lock);
 510         return map;
 511 }
 512
 513 static void xsk_delete_from_maps(struct xdp_sock *xs)
 514 {
 515         /* This function removes the current XDP socket from all the
 516          * maps it resides in. We need to take extra care here, due to
 517          * the two locks involved. Each map has a lock synchronizing
 518          * updates to the entries, and each socket has a lock that
 519          * synchronizes access to the list of maps (map_list). For
 520          * deadlock avoidance the locks need to be taken in the order
 521          * "map lock"->"socket map list lock". We start off by
 522          * accessing the socket map list, and take a reference to the
 523          * map to guarantee existence between the
 524          * xsk_get_map_list_entry() and xsk_map_try_sock_delete()
 525          * calls. Then we ask the map to remove the socket, which
 526          * tries to remove the socket from the map. Note that there
 527          * might be updates to the map between
 528          * xsk_get_map_list_entry() and xsk_map_try_sock_delete().
 529          */
 530         struct xdp_sock **map_entry = NULL;
 531         struct xsk_map *map;
 532
 533         while ((map = xsk_get_map_list_entry(xs, &map_entry))) {
 534                 xsk_map_try_sock_delete(map, xs, map_entry);
 535                 xsk_map_put(map);
 536         }
 537 }
 538
 539 static int xsk_release(struct socket *sock)
 540 {
 541         struct sock *sk = sock->sk;
 542         struct xdp_sock *xs = xdp_sk(sk);
 543         struct net *net;
 544
 545         if (!sk)
 546                 return 0;
 547
 548         net = sock_net(sk);
 549
 550         mutex_lock(&net->xdp.lock);
 551         sk_del_node_init_rcu(sk);
 552         mutex_unlock(&net->xdp.lock);
 553
 554         local_bh_disable();
 555         sock_prot_inuse_add(net, sk->sk_prot, -1);
 556         local_bh_enable();
 557
 558         xsk_delete_from_maps(xs);
 559         mutex_lock(&xs->mutex);
 560         xsk_unbind_dev(xs);
 561         mutex_unlock(&xs->mutex);
 562
 563         xskq_destroy(xs->rx);
 564         xskq_destroy(xs->tx);
 565
 566         sock_orphan(sk);
 567         sock->sk = NULL;
 568
 569         sk_refcnt_debug_release(sk);
 570         sock_put(sk);
 571
 572         return 0;
 573 }
 574
 575 static struct socket *xsk_lookup_xsk_from_fd(int fd)
 576 {
 577         struct socket *sock;
 578         int err;
 579
 580         sock = sockfd_lookup(fd, &err);
 581         if (!sock)
 582                 return ERR_PTR(-ENOTSOCK);
 583
 584         if (sock->sk->sk_family != PF_XDP) {
 585                 sockfd_put(sock);
 586                 return ERR_PTR(-ENOPROTOOPT);
 587         }
 588
 589         return sock;
 590 }
 591
 592 /* Check if umem pages are contiguous.
 593  * If zero-copy mode, use the DMA address to do the page contiguity check
 594  * For all other modes we use addr (kernel virtual address)
 595  * Store the result in the low bits of addr.
 596  */
 597 static void xsk_check_page_contiguity(struct xdp_umem *umem, u32 flags)
 598 {
 599         struct xdp_umem_page *pgs = umem->pages;
 600         int i, is_contig;
 601
 602         for (i = 0; i < umem->npgs - 1; i++) {
 603                 is_contig = (flags & XDP_ZEROCOPY) ?
 604                         (pgs[i].dma + PAGE_SIZE == pgs[i + 1].dma) :
 605                         (pgs[i].addr + PAGE_SIZE == pgs[i + 1].addr);
 606                 pgs[i].addr += is_contig << XSK_NEXT_PG_CONTIG_SHIFT;
 607         }
 608 }
 609
 610 static int xsk_bind(struct socket *sock, struct sockaddr *addr, int addr_len)
 611 {
 612         struct sockaddr_xdp *sxdp = (struct sockaddr_xdp *)addr;
 613         struct sock *sk = sock->sk;
 614         struct xdp_sock *xs = xdp_sk(sk);
 615         struct net_device *dev;
 616         int bound_dev_if;
 617         u32 flags, qid;
 618         int err = 0;
 619
 620         if (addr_len < sizeof(struct sockaddr_xdp))
 621                 return -EINVAL;
 622         if (sxdp->sxdp_family != AF_XDP)
 623                 return -EINVAL;
 624
 625         flags = sxdp->sxdp_flags;
 626         if (flags & ~(XDP_SHARED_UMEM | XDP_COPY | XDP_ZEROCOPY |
 627                       XDP_USE_NEED_WAKEUP))
 628                 return -EINVAL;
 629
 630         bound_dev_if = READ_ONCE(sk->sk_bound_dev_if);
 631         if (bound_dev_if && bound_dev_if != sxdp->sxdp_ifindex)
 632                 return -EINVAL;
 633
 634         rtnl_lock();
 635         mutex_lock(&xs->mutex);
 636         if (xs->state != XSK_READY) {
 637                 err = -EBUSY;
 638                 goto out_release;
 639         }
 640
 641         dev = dev_get_by_index(sock_net(sk), sxdp->sxdp_ifindex);
 642         if (!dev) {
 643                 err = -ENODEV;
 644                 goto out_release;
 645         }
 646
 647         if (!xs->rx && !xs->tx) {
 648                 err = -EINVAL;
 649                 goto out_unlock;
 650         }
 651
 652         qid = sxdp->sxdp_queue_id;
 653
 654         if (flags & XDP_SHARED_UMEM) {
 655                 struct xdp_sock *umem_xs;
 656                 struct socket *sock;
 657
 658                 if ((flags & XDP_COPY) || (flags & XDP_ZEROCOPY) ||
 659                     (flags & XDP_USE_NEED_WAKEUP)) {
 660                         /* Cannot specify flags for shared sockets. */
 661                         err = -EINVAL;
 662                         goto out_unlock;
 663                 }
 664
 665                 if (xs->umem) {
 666                         /* We have already our own. */
 667                         err = -EINVAL;
 668                         goto out_unlock;
 669                 }
 670
 671                 sock = xsk_lookup_xsk_from_fd(sxdp->sxdp_shared_umem_fd);
 672                 if (IS_ERR(sock)) {
 673                         err = PTR_ERR(sock);
 674                         goto out_unlock;
 675                 }
 676
 677                 umem_xs = xdp_sk(sock->sk);
 678                 if (!xsk_is_bound(umem_xs)) {
 679                         err = -EBADF;
 680                         sockfd_put(sock);
 681                         goto out_unlock;
 682                 }
 683                 if (umem_xs->dev != dev || umem_xs->queue_id != qid) {
 684                         err = -EINVAL;
 685                         sockfd_put(sock);
 686                         goto out_unlock;
 687                 }
 688
 689                 xdp_get_umem(umem_xs->umem);
 690                 WRITE_ONCE(xs->umem, umem_xs->umem);
 691                 sockfd_put(sock);
 692         } else if (!xs->umem || !xdp_umem_validate_queues(xs->umem)) {
 693                 err = -EINVAL;
 694                 goto out_unlock;
 695         } else {
 696                 /* This xsk has its own umem. */
 697                 xskq_set_umem(xs->umem->fq, xs->umem->size,
 698                               xs->umem->chunk_mask);
 699                 xskq_set_umem(xs->umem->cq, xs->umem->size,
 700                               xs->umem->chunk_mask);
 701
 702                 err = xdp_umem_assign_dev(xs->umem, dev, qid, flags);
 703                 if (err)
 704                         goto out_unlock;
 705
 706                 xsk_check_page_contiguity(xs->umem, flags);
 707         }
 708
 709         xs->dev = dev;
 710         xs->zc = xs->umem->zc;
 711         xs->queue_id = qid;
 712         xskq_set_umem(xs->rx, xs->umem->size, xs->umem->chunk_mask);
 713         xskq_set_umem(xs->tx, xs->umem->size, xs->umem->chunk_mask);
 714         xdp_add_sk_umem(xs->umem, xs);
 715
 716 out_unlock:
 717         if (err) {
 718                 dev_put(dev);
 719         } else {
 720                 /* Matches smp_rmb() in bind() for shared umem
 721                  * sockets, and xsk_is_bound().
 722                  */
 723                 smp_wmb();
 724                 WRITE_ONCE(xs->state, XSK_BOUND);
 725         }
 726 out_release:
 727         mutex_unlock(&xs->mutex);
 728         rtnl_unlock();
 729         return err;
 730 }
 731
 732 struct xdp_umem_reg_v1 {
 733         __u64 addr; /* Start of packet data area */
 734         __u64 len; /* Length of packet data area */
 735         __u32 chunk_size;
 736         __u32 headroom;
 737 };
 738
 739 static int xsk_setsockopt(struct socket *sock, int level, int optname,
 740                           char __user *optval, unsigned int optlen)
 741 {
 742         struct sock *sk = sock->sk;
 743         struct xdp_sock *xs = xdp_sk(sk);
 744         int err;
 745
 746         if (level != SOL_XDP)
 747                 return -ENOPROTOOPT;
 748
 749         switch (optname) {
 750         case XDP_RX_RING:
 751         case XDP_TX_RING:
 752         {
 753                 struct xsk_queue **q;
 754                 int entries;
 755
 756                 if (optlen < sizeof(entries))
 757                         return -EINVAL;
 758                 if (copy_from_user(&entries, optval, sizeof(entries)))
 759                         return -EFAULT;
 760
 761                 mutex_lock(&xs->mutex);
 762                 if (xs->state != XSK_READY) {
 763                         mutex_unlock(&xs->mutex);
 764                         return -EBUSY;
 765                 }
 766                 q = (optname == XDP_TX_RING) ? &xs->tx : &xs->rx;
 767                 err = xsk_init_queue(entries, q, false);
 768                 if (!err && optname == XDP_TX_RING)
 769                         /* Tx needs to be explicitly woken up the first time */
 770                         xs->tx->ring->flags |= XDP_RING_NEED_WAKEUP;
 771                 mutex_unlock(&xs->mutex);
 772                 return err;
 773         }
 774         case XDP_UMEM_REG:
 775         {
 776                 size_t mr_size = sizeof(struct xdp_umem_reg);
 777                 struct xdp_umem_reg mr = {};
 778                 struct xdp_umem *umem;
 779
 780                 if (optlen < sizeof(struct xdp_umem_reg_v1))
 781                         return -EINVAL;
 782                 else if (optlen < sizeof(mr))
 783                         mr_size = sizeof(struct xdp_umem_reg_v1);
 784
 785                 if (copy_from_user(&mr, optval, mr_size))
 786                         return -EFAULT;
 787
 788                 mutex_lock(&xs->mutex);
 789                 if (xs->state != XSK_READY || xs->umem) {
 790                         mutex_unlock(&xs->mutex);
 791                         return -EBUSY;
 792                 }
 793
 794                 umem = xdp_umem_create(&mr);
 795                 if (IS_ERR(umem)) {
 796                         mutex_unlock(&xs->mutex);
 797                         return PTR_ERR(umem);
 798                 }
 799
 800                 /* Make sure umem is ready before it can be seen by others */
 801                 smp_wmb();
 802                 WRITE_ONCE(xs->umem, umem);
 803                 mutex_unlock(&xs->mutex);
 804                 return 0;
 805         }
 806         case XDP_UMEM_FILL_RING:
 807         case XDP_UMEM_COMPLETION_RING:
 808         {
 809                 struct xsk_queue **q;
 810                 int entries;
 811
 812                 if (copy_from_user(&entries, optval, sizeof(entries)))
 813                         return -EFAULT;
 814
 815                 mutex_lock(&xs->mutex);
 816                 if (xs->state != XSK_READY) {
 817                         mutex_unlock(&xs->mutex);
 818                         return -EBUSY;
 819                 }
 820                 if (!xs->umem) {
 821                         mutex_unlock(&xs->mutex);
 822                         return -EINVAL;
 823                 }
 824
 825                 q = (optname == XDP_UMEM_FILL_RING) ? &xs->umem->fq :
 826                         &xs->umem->cq;
 827                 err = xsk_init_queue(entries, q, true);
 828                 mutex_unlock(&xs->mutex);
 829                 return err;
 830         }
 831         default:
 832                 break;
 833         }
 834
 835         return -ENOPROTOOPT;
 836 }
 837
 838 static void xsk_enter_rxtx_offsets(struct xdp_ring_offset_v1 *ring)
 839 {
 840         ring->producer = offsetof(struct xdp_rxtx_ring, ptrs.producer);
 841         ring->consumer = offsetof(struct xdp_rxtx_ring, ptrs.consumer);
 842         ring->desc = offsetof(struct xdp_rxtx_ring, desc);
 843 }
 844
 845 static void xsk_enter_umem_offsets(struct xdp_ring_offset_v1 *ring)
 846 {
 847         ring->producer = offsetof(struct xdp_umem_ring, ptrs.producer);
 848         ring->consumer = offsetof(struct xdp_umem_ring, ptrs.consumer);
 849         ring->desc = offsetof(struct xdp_umem_ring, desc);
 850 }
 851
 852 static int xsk_getsockopt(struct socket *sock, int level, int optname,
 853                           char __user *optval, int __user *optlen)
 854 {
 855         struct sock *sk = sock->sk;
 856         struct xdp_sock *xs = xdp_sk(sk);
 857         int len;
 858
 859         if (level != SOL_XDP)
 860                 return -ENOPROTOOPT;
 861
 862         if (get_user(len, optlen))
 863                 return -EFAULT;
 864         if (len < 0)
 865                 return -EINVAL;
 866
 867         switch (optname) {
 868         case XDP_STATISTICS:
 869         {
 870                 struct xdp_statistics stats;
 871
 872                 if (len < sizeof(stats))
 873                         return -EINVAL;
 874
 875                 mutex_lock(&xs->mutex);
 876                 stats.rx_dropped = xs->rx_dropped;
 877                 stats.rx_invalid_descs = xskq_nb_invalid_descs(xs->rx);
 878                 stats.tx_invalid_descs = xskq_nb_invalid_descs(xs->tx);
 879                 mutex_unlock(&xs->mutex);
 880
 881                 if (copy_to_user(optval, &stats, sizeof(stats)))
 882                         return -EFAULT;
 883                 if (put_user(sizeof(stats), optlen))
 884                         return -EFAULT;
 885
 886                 return 0;
 887         }
 888         case XDP_MMAP_OFFSETS:
 889         {
 890                 struct xdp_mmap_offsets off;
 891                 struct xdp_mmap_offsets_v1 off_v1;
 892                 bool flags_supported = true;
 893                 void *to_copy;
 894
 895                 if (len < sizeof(off_v1))
 896                         return -EINVAL;
 897                 else if (len < sizeof(off))
 898                         flags_supported = false;
 899
 900                 if (flags_supported) {
 901                         /* xdp_ring_offset is identical to xdp_ring_offset_v1
 902                          * except for the flags field added to the end.
 903                          */
 904                         xsk_enter_rxtx_offsets((struct xdp_ring_offset_v1 *)
 905                                                &off.rx);
 906                         xsk_enter_rxtx_offsets((struct xdp_ring_offset_v1 *)
 907                                                &off.tx);
 908                         xsk_enter_umem_offsets((struct xdp_ring_offset_v1 *)
 909                                                &off.fr);
 910                         xsk_enter_umem_offsets((struct xdp_ring_offset_v1 *)
 911                                                &off.cr);
 912                         off.rx.flags = offsetof(struct xdp_rxtx_ring,
 913                                                 ptrs.flags);
 914                         off.tx.flags = offsetof(struct xdp_rxtx_ring,
 915                                                 ptrs.flags);
 916                         off.fr.flags = offsetof(struct xdp_umem_ring,
 917                                                 ptrs.flags);
 918                         off.cr.flags = offsetof(struct xdp_umem_ring,
 919                                                 ptrs.flags);
 920
 921                         len = sizeof(off);
 922                         to_copy = &off;
 923                 } else {
 924                         xsk_enter_rxtx_offsets(&off_v1.rx);
 925                         xsk_enter_rxtx_offsets(&off_v1.tx);
 926                         xsk_enter_umem_offsets(&off_v1.fr);
 927                         xsk_enter_umem_offsets(&off_v1.cr);
 928
 929                         len = sizeof(off_v1);
 930                         to_copy = &off_v1;
 931                 }
 932
 933                 if (copy_to_user(optval, to_copy, len))
 934                         return -EFAULT;
 935                 if (put_user(len, optlen))
 936                         return -EFAULT;
 937
 938                 return 0;
 939         }
 940         case XDP_OPTIONS:
 941         {
 942                 struct xdp_options opts = {};
 943
 944                 if (len < sizeof(opts))
 945                         return -EINVAL;
 946
 947                 mutex_lock(&xs->mutex);
 948                 if (xs->zc)
 949                         opts.flags |= XDP_OPTIONS_ZEROCOPY;
 950                 mutex_unlock(&xs->mutex);
 951
 952                 len = sizeof(opts);
 953                 if (copy_to_user(optval, &opts, len))
 954                         return -EFAULT;
 955                 if (put_user(len, optlen))
 956                         return -EFAULT;
 957
 958                 return 0;
 959         }
 960         default:
 961                 break;
 962         }
 963
 964         return -EOPNOTSUPP;
 965 }
 966
 967 static int xsk_mmap(struct file *file, struct socket *sock,
 968                     struct vm_area_struct *vma)
 969 {
 970         loff_t offset = (loff_t)vma->vm_pgoff << PAGE_SHIFT;
 971         unsigned long size = vma->vm_end - vma->vm_start;
 972         struct xdp_sock *xs = xdp_sk(sock->sk);
 973         struct xsk_queue *q = NULL;
 974         struct xdp_umem *umem;
 975         unsigned long pfn;
 976         struct page *qpg;
 977
 978         if (READ_ONCE(xs->state) != XSK_READY)
 979                 return -EBUSY;
 980
 981         if (offset == XDP_PGOFF_RX_RING) {
 982                 q = READ_ONCE(xs->rx);
 983         } else if (offset == XDP_PGOFF_TX_RING) {
 984                 q = READ_ONCE(xs->tx);
 985         } else {
 986                 umem = READ_ONCE(xs->umem);
 987                 if (!umem)
 988                         return -EINVAL;
 989
 990                 /* Matches the smp_wmb() in XDP_UMEM_REG */
 991                 smp_rmb();
 992                 if (offset == XDP_UMEM_PGOFF_FILL_RING)
 993                         q = READ_ONCE(umem->fq);
 994                 else if (offset == XDP_UMEM_PGOFF_COMPLETION_RING)
 995                         q = READ_ONCE(umem->cq);
 996         }
 997
 998         if (!q)
 999                 return -EINVAL;
1000
1001         /* Matches the smp_wmb() in xsk_init_queue */
1002         smp_rmb();
1003         qpg = virt_to_head_page(q->ring);
1004         if (size > page_size(qpg))
1005                 return -EINVAL;
1006
1007         pfn = virt_to_phys(q->ring) >> PAGE_SHIFT;
1008         return remap_pfn_range(vma, vma->vm_start, pfn,
1009                                size, vma->vm_page_prot);
1010 }
1011
1012 static int xsk_notifier(struct notifier_block *this,
1013                         unsigned long msg, void *ptr)
1014 {
1015         struct net_device *dev = netdev_notifier_info_to_dev(ptr);
1016         struct net *net = dev_net(dev);
1017         struct sock *sk;
1018
1019         switch (msg) {
1020         case NETDEV_UNREGISTER:
1021                 mutex_lock(&net->xdp.lock);
1022                 sk_for_each(sk, &net->xdp.list) {
1023                         struct xdp_sock *xs = xdp_sk(sk);
1024
1025                         mutex_lock(&xs->mutex);
1026                         if (xs->dev == dev) {
1027                                 sk->sk_err = ENETDOWN;
1028                                 if (!sock_flag(sk, SOCK_DEAD))
1029                                         sk->sk_error_report(sk);
1030
1031                                 xsk_unbind_dev(xs);
1032
1033                                 /* Clear device references in umem. */
1034                                 xdp_umem_clear_dev(xs->umem);
1035                         }
1036                         mutex_unlock(&xs->mutex);
1037                 }
1038                 mutex_unlock(&net->xdp.lock);
1039                 break;
1040         }
1041         return NOTIFY_DONE;
1042 }
1043
1044 static struct proto xsk_proto = {
1045         .name =         "XDP",
1046         .owner =        THIS_MODULE,
1047         .obj_size =     sizeof(struct xdp_sock),
1048 };
1049
1050 static const struct proto_ops xsk_proto_ops = {
1051         .family         = PF_XDP,
1052         .owner          = THIS_MODULE,
1053         .release        = xsk_release,
1054         .bind           = xsk_bind,
1055         .connect        = sock_no_connect,
1056         .socketpair     = sock_no_socketpair,
1057         .accept         = sock_no_accept,
1058         .getname        = sock_no_getname,
1059         .poll           = xsk_poll,
1060         .ioctl          = sock_no_ioctl,
1061         .listen         = sock_no_listen,
1062         .shutdown       = sock_no_shutdown,
1063         .setsockopt     = xsk_setsockopt,
1064         .getsockopt     = xsk_getsockopt,
1065         .sendmsg        = xsk_sendmsg,
1066         .recvmsg        = sock_no_recvmsg,
1067         .mmap           = xsk_mmap,
1068         .sendpage       = sock_no_sendpage,
1069 };
1070
1071 static void xsk_destruct(struct sock *sk)
1072 {
1073         struct xdp_sock *xs = xdp_sk(sk);
1074
1075         if (!sock_flag(sk, SOCK_DEAD))
1076                 return;
1077
1078         xdp_put_umem(xs->umem);
1079
1080         sk_refcnt_debug_dec(sk);
1081 }
1082
1083 static int xsk_create(struct net *net, struct socket *sock, int protocol,
1084                       int kern)
1085 {
1086         struct sock *sk;
1087         struct xdp_sock *xs;
1088
1089         if (!ns_capable(net->user_ns, CAP_NET_RAW))
1090                 return -EPERM;
1091         if (sock->type != SOCK_RAW)
1092                 return -ESOCKTNOSUPPORT;
1093
1094         if (protocol)
1095                 return -EPROTONOSUPPORT;
1096
1097         sock->state = SS_UNCONNECTED;
1098
1099         sk = sk_alloc(net, PF_XDP, GFP_KERNEL, &xsk_proto, kern);
1100         if (!sk)
1101                 return -ENOBUFS;
1102
1103         sock->ops = &xsk_proto_ops;
1104
1105         sock_init_data(sock, sk);
1106
1107         sk->sk_family = PF_XDP;
1108
1109         sk->sk_destruct = xsk_destruct;
1110         sk_refcnt_debug_inc(sk);
1111
1112         sock_set_flag(sk, SOCK_RCU_FREE);
1113
1114         xs = xdp_sk(sk);
1115         xs->state = XSK_READY;
1116         mutex_init(&xs->mutex);
1117         spin_lock_init(&xs->rx_lock);
1118         spin_lock_init(&xs->tx_completion_lock);
1119
1120         INIT_LIST_HEAD(&xs->map_list);
1121         spin_lock_init(&xs->map_list_lock);
1122
1123         mutex_lock(&net->xdp.lock);
1124         sk_add_node_rcu(sk, &net->xdp.list);
1125         mutex_unlock(&net->xdp.lock);
1126
1127         local_bh_disable();
1128         sock_prot_inuse_add(net, &xsk_proto, 1);
1129         local_bh_enable();
1130
1131         return 0;
1132 }
1133
1134 static const struct net_proto_family xsk_family_ops = {
1135         .family = PF_XDP,
1136         .create = xsk_create,
1137         .owner  = THIS_MODULE,
1138 };
1139
1140 static struct notifier_block xsk_netdev_notifier = {
1141         .notifier_call  = xsk_notifier,
1142 };
1143
1144 static int __net_init xsk_net_init(struct net *net)
1145 {
1146         mutex_init(&net->xdp.lock);
1147         INIT_HLIST_HEAD(&net->xdp.list);
1148         return 0;
1149 }
1150
1151 static void __net_exit xsk_net_exit(struct net *net)
1152 {
1153         WARN_ON_ONCE(!hlist_empty(&net->xdp.list));
1154 }
1155
1156 static struct pernet_operations xsk_net_ops = {
1157         .init = xsk_net_init,
1158         .exit = xsk_net_exit,
1159 };
1160
1161 static int __init xsk_init(void)
1162 {
1163         int err;
1164
1165         err = proto_register(&xsk_proto, 0 /* no slab */);
1166         if (err)
1167                 goto out;
1168
1169         err = sock_register(&xsk_family_ops);
1170         if (err)
1171                 goto out_proto;
1172
1173         err = register_pernet_subsys(&xsk_net_ops);
1174         if (err)
1175                 goto out_sk;
1176
1177         err = register_netdevice_notifier(&xsk_netdev_notifier);
1178         if (err)
1179                 goto out_pernet;
1180
1181         return 0;
1182
1183 out_pernet:
1184         unregister_pernet_subsys(&xsk_net_ops);
1185 out_sk:
1186         sock_unregister(PF_XDP);
1187 out_proto:
1188         proto_unregister(&xsk_proto);
1189 out:
1190         return err;
1191 }
1192
1193 fs_initcall(xsk_init);