drivers/vhost/net.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /* Copyright (C) 2009 Red Hat, Inc.
   3  * Author: Michael S. Tsirkin <mst@redhat.com>
   4  *
   5  * virtio-net server in host kernel.
   6  */
   7
   8 #include <linux/compat.h>
   9 #include <linux/eventfd.h>
  10 #include <linux/vhost.h>
  11 #include <linux/virtio_net.h>
  12 #include <linux/miscdevice.h>
  13 #include <linux/module.h>
  14 #include <linux/moduleparam.h>
  15 #include <linux/mutex.h>
  16 #include <linux/workqueue.h>
  17 #include <linux/file.h>
  18 #include <linux/slab.h>
  19 #include <linux/sched/clock.h>
  20 #include <linux/sched/signal.h>
  21 #include <linux/vmalloc.h>
  22
  23 #include <linux/net.h>
  24 #include <linux/if_packet.h>
  25 #include <linux/if_arp.h>
  26 #include <linux/if_tun.h>
  27 #include <linux/if_macvlan.h>
  28 #include <linux/if_tap.h>
  29 #include <linux/if_vlan.h>
  30 #include <linux/skb_array.h>
  31 #include <linux/skbuff.h>
  32
  33 #include <net/sock.h>
  34 #include <net/xdp.h>
  35
  36 #include "vhost.h"
  37
  38 static int experimental_zcopytx = 0;
  39 module_param(experimental_zcopytx, int, 0444);
  40 MODULE_PARM_DESC(experimental_zcopytx, "Enable Zero Copy TX;"
  41                                        " 1 -Enable; 0 - Disable");
  42
  43 /* Max number of bytes transferred before requeueing the job.
  44  * Using this limit prevents one virtqueue from starving others. */
  45 #define VHOST_NET_WEIGHT 0x80000
  46
  47 /* Max number of packets transferred before requeueing the job.
  48  * Using this limit prevents one virtqueue from starving others with small
  49  * pkts.
  50  */
  51 #define VHOST_NET_PKT_WEIGHT 256
  52
  53 /* MAX number of TX used buffers for outstanding zerocopy */
  54 #define VHOST_MAX_PEND 128
  55 #define VHOST_GOODCOPY_LEN 256
  56
  57 /*
  58  * For transmit, used buffer len is unused; we override it to track buffer
  59  * status internally; used for zerocopy tx only.
  60  */
  61 /* Lower device DMA failed */
  62 #define VHOST_DMA_FAILED_LEN    ((__force __virtio32)3)
  63 /* Lower device DMA done */
  64 #define VHOST_DMA_DONE_LEN      ((__force __virtio32)2)
  65 /* Lower device DMA in progress */
  66 #define VHOST_DMA_IN_PROGRESS   ((__force __virtio32)1)
  67 /* Buffer unused */
  68 #define VHOST_DMA_CLEAR_LEN     ((__force __virtio32)0)
  69
  70 #define VHOST_DMA_IS_DONE(len) ((__force u32)(len) >= (__force u32)VHOST_DMA_DONE_LEN)
  71
  72 enum {
  73         VHOST_NET_FEATURES = VHOST_FEATURES |
  74                          (1ULL << VHOST_NET_F_VIRTIO_NET_HDR) |
  75                          (1ULL << VIRTIO_NET_F_MRG_RXBUF) |
  76                          (1ULL << VIRTIO_F_IOMMU_PLATFORM)
  77 };
  78
  79 enum {
  80         VHOST_NET_BACKEND_FEATURES = (1ULL << VHOST_BACKEND_F_IOTLB_MSG_V2)
  81 };
  82
  83 enum {
  84         VHOST_NET_VQ_RX = 0,
  85         VHOST_NET_VQ_TX = 1,
  86         VHOST_NET_VQ_MAX = 2,
  87 };
  88
  89 struct vhost_net_ubuf_ref {
  90         /* refcount follows semantics similar to kref:
  91          *  0: object is released
  92          *  1: no outstanding ubufs
  93          * >1: outstanding ubufs
  94          */
  95         atomic_t refcount;
  96         wait_queue_head_t wait;
  97         struct vhost_virtqueue *vq;
  98 };
  99
 100 #define VHOST_NET_BATCH 64
 101 struct vhost_net_buf {
 102         void **queue;
 103         int tail;
 104         int head;
 105 };
 106
 107 struct vhost_net_virtqueue {
 108         struct vhost_virtqueue vq;
 109         size_t vhost_hlen;
 110         size_t sock_hlen;
 111         /* vhost zerocopy support fields below: */
 112         /* last used idx for outstanding DMA zerocopy buffers */
 113         int upend_idx;
 114         /* For TX, first used idx for DMA done zerocopy buffers
 115          * For RX, number of batched heads
 116          */
 117         int done_idx;
 118         /* Number of XDP frames batched */
 119         int batched_xdp;
 120         /* an array of userspace buffers info */
 121         struct ubuf_info *ubuf_info;
 122         /* Reference counting for outstanding ubufs.
 123          * Protected by vq mutex. Writers must also take device mutex. */
 124         struct vhost_net_ubuf_ref *ubufs;
 125         struct ptr_ring *rx_ring;
 126         struct vhost_net_buf rxq;
 127         /* Batched XDP buffs */
 128         struct xdp_buff *xdp;
 129 };
 130
 131 struct vhost_net {
 132         struct vhost_dev dev;
 133         struct vhost_net_virtqueue vqs[VHOST_NET_VQ_MAX];
 134         struct vhost_poll poll[VHOST_NET_VQ_MAX];
 135         /* Number of TX recently submitted.
 136          * Protected by tx vq lock. */
 137         unsigned tx_packets;
 138         /* Number of times zerocopy TX recently failed.
 139          * Protected by tx vq lock. */
 140         unsigned tx_zcopy_err;
 141         /* Flush in progress. Protected by tx vq lock. */
 142         bool tx_flush;
 143         /* Private page frag */
 144         struct page_frag page_frag;
 145         /* Refcount bias of page frag */
 146         int refcnt_bias;
 147 };
 148
 149 static unsigned vhost_net_zcopy_mask __read_mostly;
 150
 151 static void *vhost_net_buf_get_ptr(struct vhost_net_buf *rxq)
 152 {
 153         if (rxq->tail != rxq->head)
 154                 return rxq->queue[rxq->head];
 155         else
 156                 return NULL;
 157 }
 158
 159 static int vhost_net_buf_get_size(struct vhost_net_buf *rxq)
 160 {
 161         return rxq->tail - rxq->head;
 162 }
 163
 164 static int vhost_net_buf_is_empty(struct vhost_net_buf *rxq)
 165 {
 166         return rxq->tail == rxq->head;
 167 }
 168
 169 static void *vhost_net_buf_consume(struct vhost_net_buf *rxq)
 170 {
 171         void *ret = vhost_net_buf_get_ptr(rxq);
 172         ++rxq->head;
 173         return ret;
 174 }
 175
 176 static int vhost_net_buf_produce(struct vhost_net_virtqueue *nvq)
 177 {
 178         struct vhost_net_buf *rxq = &nvq->rxq;
 179
 180         rxq->head = 0;
 181         rxq->tail = ptr_ring_consume_batched(nvq->rx_ring, rxq->queue,
 182                                               VHOST_NET_BATCH);
 183         return rxq->tail;
 184 }
 185
 186 static void vhost_net_buf_unproduce(struct vhost_net_virtqueue *nvq)
 187 {
 188         struct vhost_net_buf *rxq = &nvq->rxq;
 189
 190         if (nvq->rx_ring && !vhost_net_buf_is_empty(rxq)) {
 191                 ptr_ring_unconsume(nvq->rx_ring, rxq->queue + rxq->head,
 192                                    vhost_net_buf_get_size(rxq),
 193                                    tun_ptr_free);
 194                 rxq->head = rxq->tail = 0;
 195         }
 196 }
 197
 198 static int vhost_net_buf_peek_len(void *ptr)
 199 {
 200         if (tun_is_xdp_frame(ptr)) {
 201                 struct xdp_frame *xdpf = tun_ptr_to_xdp(ptr);
 202
 203                 return xdpf->len;
 204         }
 205
 206         return __skb_array_len_with_tag(ptr);
 207 }
 208
 209 static int vhost_net_buf_peek(struct vhost_net_virtqueue *nvq)
 210 {
 211         struct vhost_net_buf *rxq = &nvq->rxq;
 212
 213         if (!vhost_net_buf_is_empty(rxq))
 214                 goto out;
 215
 216         if (!vhost_net_buf_produce(nvq))
 217                 return 0;
 218
 219 out:
 220         return vhost_net_buf_peek_len(vhost_net_buf_get_ptr(rxq));
 221 }
 222
 223 static void vhost_net_buf_init(struct vhost_net_buf *rxq)
 224 {
 225         rxq->head = rxq->tail = 0;
 226 }
 227
 228 static void vhost_net_enable_zcopy(int vq)
 229 {
 230         vhost_net_zcopy_mask |= 0x1 << vq;
 231 }
 232
 233 static struct vhost_net_ubuf_ref *
 234 vhost_net_ubuf_alloc(struct vhost_virtqueue *vq, bool zcopy)
 235 {
 236         struct vhost_net_ubuf_ref *ubufs;
 237         /* No zero copy backend? Nothing to count. */
 238         if (!zcopy)
 239                 return NULL;
 240         ubufs = kmalloc(sizeof(*ubufs), GFP_KERNEL);
 241         if (!ubufs)
 242                 return ERR_PTR(-ENOMEM);
 243         atomic_set(&ubufs->refcount, 1);
 244         init_waitqueue_head(&ubufs->wait);
 245         ubufs->vq = vq;
 246         return ubufs;
 247 }
 248
 249 static int vhost_net_ubuf_put(struct vhost_net_ubuf_ref *ubufs)
 250 {
 251         int r = atomic_sub_return(1, &ubufs->refcount);
 252         if (unlikely(!r))
 253                 wake_up(&ubufs->wait);
 254         return r;
 255 }
 256
 257 static void vhost_net_ubuf_put_and_wait(struct vhost_net_ubuf_ref *ubufs)
 258 {
 259         vhost_net_ubuf_put(ubufs);
 260         wait_event(ubufs->wait, !atomic_read(&ubufs->refcount));
 261 }
 262
 263 static void vhost_net_ubuf_put_wait_and_free(struct vhost_net_ubuf_ref *ubufs)
 264 {
 265         vhost_net_ubuf_put_and_wait(ubufs);
 266         kfree(ubufs);
 267 }
 268
 269 static void vhost_net_clear_ubuf_info(struct vhost_net *n)
 270 {
 271         int i;
 272
 273         for (i = 0; i < VHOST_NET_VQ_MAX; ++i) {
 274                 kfree(n->vqs[i].ubuf_info);
 275                 n->vqs[i].ubuf_info = NULL;
 276         }
 277 }
 278
 279 static int vhost_net_set_ubuf_info(struct vhost_net *n)
 280 {
 281         bool zcopy;
 282         int i;
 283
 284         for (i = 0; i < VHOST_NET_VQ_MAX; ++i) {
 285                 zcopy = vhost_net_zcopy_mask & (0x1 << i);
 286                 if (!zcopy)
 287                         continue;
 288                 n->vqs[i].ubuf_info =
 289                         kmalloc_array(UIO_MAXIOV,
 290                                       sizeof(*n->vqs[i].ubuf_info),
 291                                       GFP_KERNEL);
 292                 if  (!n->vqs[i].ubuf_info)
 293                         goto err;
 294         }
 295         return 0;
 296
 297 err:
 298         vhost_net_clear_ubuf_info(n);
 299         return -ENOMEM;
 300 }
 301
 302 static void vhost_net_vq_reset(struct vhost_net *n)
 303 {
 304         int i;
 305
 306         vhost_net_clear_ubuf_info(n);
 307
 308         for (i = 0; i < VHOST_NET_VQ_MAX; i++) {
 309                 n->vqs[i].done_idx = 0;
 310                 n->vqs[i].upend_idx = 0;
 311                 n->vqs[i].ubufs = NULL;
 312                 n->vqs[i].vhost_hlen = 0;
 313                 n->vqs[i].sock_hlen = 0;
 314                 vhost_net_buf_init(&n->vqs[i].rxq);
 315         }
 316
 317 }
 318
 319 static void vhost_net_tx_packet(struct vhost_net *net)
 320 {
 321         ++net->tx_packets;
 322         if (net->tx_packets < 1024)
 323                 return;
 324         net->tx_packets = 0;
 325         net->tx_zcopy_err = 0;
 326 }
 327
 328 static void vhost_net_tx_err(struct vhost_net *net)
 329 {
 330         ++net->tx_zcopy_err;
 331 }
 332
 333 static bool vhost_net_tx_select_zcopy(struct vhost_net *net)
 334 {
 335         /* TX flush waits for outstanding DMAs to be done.
 336          * Don't start new DMAs.
 337          */
 338         return !net->tx_flush &&
 339                 net->tx_packets / 64 >= net->tx_zcopy_err;
 340 }
 341
 342 static bool vhost_sock_zcopy(struct socket *sock)
 343 {
 344         return unlikely(experimental_zcopytx) &&
 345                 sock_flag(sock->sk, SOCK_ZEROCOPY);
 346 }
 347
 348 static bool vhost_sock_xdp(struct socket *sock)
 349 {
 350         return sock_flag(sock->sk, SOCK_XDP);
 351 }
 352
 353 /* In case of DMA done not in order in lower device driver for some reason.
 354  * upend_idx is used to track end of used idx, done_idx is used to track head
 355  * of used idx. Once lower device DMA done contiguously, we will signal KVM
 356  * guest used idx.
 357  */
 358 static void vhost_zerocopy_signal_used(struct vhost_net *net,
 359                                        struct vhost_virtqueue *vq)
 360 {
 361         struct vhost_net_virtqueue *nvq =
 362                 container_of(vq, struct vhost_net_virtqueue, vq);
 363         int i, add;
 364         int j = 0;
 365
 366         for (i = nvq->done_idx; i != nvq->upend_idx; i = (i + 1) % UIO_MAXIOV) {
 367                 if (vq->heads[i].len == VHOST_DMA_FAILED_LEN)
 368                         vhost_net_tx_err(net);
 369                 if (VHOST_DMA_IS_DONE(vq->heads[i].len)) {
 370                         vq->heads[i].len = VHOST_DMA_CLEAR_LEN;
 371                         ++j;
 372                 } else
 373                         break;
 374         }
 375         while (j) {
 376                 add = min(UIO_MAXIOV - nvq->done_idx, j);
 377                 vhost_add_used_and_signal_n(vq->dev, vq,
 378                                             &vq->heads[nvq->done_idx], add);
 379                 nvq->done_idx = (nvq->done_idx + add) % UIO_MAXIOV;
 380                 j -= add;
 381         }
 382 }
 383
 384 static void vhost_zerocopy_callback(struct ubuf_info *ubuf, bool success)
 385 {
 386         struct vhost_net_ubuf_ref *ubufs = ubuf->ctx;
 387         struct vhost_virtqueue *vq = ubufs->vq;
 388         int cnt;
 389
 390         rcu_read_lock_bh();
 391
 392         /* set len to mark this desc buffers done DMA */
 393         vq->heads[ubuf->desc].len = success ?
 394                 VHOST_DMA_DONE_LEN : VHOST_DMA_FAILED_LEN;
 395         cnt = vhost_net_ubuf_put(ubufs);
 396
 397         /*
 398          * Trigger polling thread if guest stopped submitting new buffers:
 399          * in this case, the refcount after decrement will eventually reach 1.
 400          * We also trigger polling periodically after each 16 packets
 401          * (the value 16 here is more or less arbitrary, it's tuned to trigger
 402          * less than 10% of times).
 403          */
 404         if (cnt <= 1 || !(cnt % 16))
 405                 vhost_poll_queue(&vq->poll);
 406
 407         rcu_read_unlock_bh();
 408 }
 409
 410 static inline unsigned long busy_clock(void)
 411 {
 412         return local_clock() >> 10;
 413 }
 414
 415 static bool vhost_can_busy_poll(unsigned long endtime)
 416 {
 417         return likely(!need_resched() && !time_after(busy_clock(), endtime) &&
 418                       !signal_pending(current));
 419 }
 420
 421 static void vhost_net_disable_vq(struct vhost_net *n,
 422                                  struct vhost_virtqueue *vq)
 423 {
 424         struct vhost_net_virtqueue *nvq =
 425                 container_of(vq, struct vhost_net_virtqueue, vq);
 426         struct vhost_poll *poll = n->poll + (nvq - n->vqs);
 427         if (!vq->private_data)
 428                 return;
 429         vhost_poll_stop(poll);
 430 }
 431
 432 static int vhost_net_enable_vq(struct vhost_net *n,
 433                                 struct vhost_virtqueue *vq)
 434 {
 435         struct vhost_net_virtqueue *nvq =
 436                 container_of(vq, struct vhost_net_virtqueue, vq);
 437         struct vhost_poll *poll = n->poll + (nvq - n->vqs);
 438         struct socket *sock;
 439
 440         sock = vq->private_data;
 441         if (!sock)
 442                 return 0;
 443
 444         return vhost_poll_start(poll, sock->file);
 445 }
 446
 447 static void vhost_net_signal_used(struct vhost_net_virtqueue *nvq)
 448 {
 449         struct vhost_virtqueue *vq = &nvq->vq;
 450         struct vhost_dev *dev = vq->dev;
 451
 452         if (!nvq->done_idx)
 453                 return;
 454
 455         vhost_add_used_and_signal_n(dev, vq, vq->heads, nvq->done_idx);
 456         nvq->done_idx = 0;
 457 }
 458
 459 static void vhost_tx_batch(struct vhost_net *net,
 460                            struct vhost_net_virtqueue *nvq,
 461                            struct socket *sock,
 462                            struct msghdr *msghdr)
 463 {
 464         struct tun_msg_ctl ctl = {
 465                 .type = TUN_MSG_PTR,
 466                 .num = nvq->batched_xdp,
 467                 .ptr = nvq->xdp,
 468         };
 469         int i, err;
 470
 471         if (nvq->batched_xdp == 0)
 472                 goto signal_used;
 473
 474         msghdr->msg_control = &ctl;
 475         msghdr->msg_controllen = sizeof(ctl);
 476         err = sock->ops->sendmsg(sock, msghdr, 0);
 477         if (unlikely(err < 0)) {
 478                 vq_err(&nvq->vq, "Fail to batch sending packets\n");
 479
 480                 /* free pages owned by XDP; since this is an unlikely error path,
 481                  * keep it simple and avoid more complex bulk update for the
 482                  * used pages
 483                  */
 484                 for (i = 0; i < nvq->batched_xdp; ++i)
 485                         put_page(virt_to_head_page(nvq->xdp[i].data));
 486                 nvq->batched_xdp = 0;
 487                 nvq->done_idx = 0;
 488                 return;
 489         }
 490
 491 signal_used:
 492         vhost_net_signal_used(nvq);
 493         nvq->batched_xdp = 0;
 494 }
 495
 496 static int sock_has_rx_data(struct socket *sock)
 497 {
 498         if (unlikely(!sock))
 499                 return 0;
 500
 501         if (sock->ops->peek_len)
 502                 return sock->ops->peek_len(sock);
 503
 504         return skb_queue_empty(&sock->sk->sk_receive_queue);
 505 }
 506
 507 static void vhost_net_busy_poll_try_queue(struct vhost_net *net,
 508                                           struct vhost_virtqueue *vq)
 509 {
 510         if (!vhost_vq_avail_empty(&net->dev, vq)) {
 511                 vhost_poll_queue(&vq->poll);
 512         } else if (unlikely(vhost_enable_notify(&net->dev, vq))) {
 513                 vhost_disable_notify(&net->dev, vq);
 514                 vhost_poll_queue(&vq->poll);
 515         }
 516 }
 517
 518 static void vhost_net_busy_poll(struct vhost_net *net,
 519                                 struct vhost_virtqueue *rvq,
 520                                 struct vhost_virtqueue *tvq,
 521                                 bool *busyloop_intr,
 522                                 bool poll_rx)
 523 {
 524         unsigned long busyloop_timeout;
 525         unsigned long endtime;
 526         struct socket *sock;
 527         struct vhost_virtqueue *vq = poll_rx ? tvq : rvq;
 528
 529         /* Try to hold the vq mutex of the paired virtqueue. We can't
 530          * use mutex_lock() here since we could not guarantee a
 531          * consistenet lock ordering.
 532          */
 533         if (!mutex_trylock(&vq->mutex))
 534                 return;
 535
 536         vhost_disable_notify(&net->dev, vq);
 537         sock = rvq->private_data;
 538
 539         busyloop_timeout = poll_rx ? rvq->busyloop_timeout:
 540                                      tvq->busyloop_timeout;
 541
 542         preempt_disable();
 543         endtime = busy_clock() + busyloop_timeout;
 544
 545         while (vhost_can_busy_poll(endtime)) {
 546                 if (vhost_has_work(&net->dev)) {
 547                         *busyloop_intr = true;
 548                         break;
 549                 }
 550
 551                 if ((sock_has_rx_data(sock) &&
 552                      !vhost_vq_avail_empty(&net->dev, rvq)) ||
 553                     !vhost_vq_avail_empty(&net->dev, tvq))
 554                         break;
 555
 556                 cpu_relax();
 557         }
 558
 559         preempt_enable();
 560
 561         if (poll_rx || sock_has_rx_data(sock))
 562                 vhost_net_busy_poll_try_queue(net, vq);
 563         else if (!poll_rx) /* On tx here, sock has no rx data. */
 564                 vhost_enable_notify(&net->dev, rvq);
 565
 566         mutex_unlock(&vq->mutex);
 567 }
 568
 569 static int vhost_net_tx_get_vq_desc(struct vhost_net *net,
 570                                     struct vhost_net_virtqueue *tnvq,
 571                                     unsigned int *out_num, unsigned int *in_num,
 572                                     struct msghdr *msghdr, bool *busyloop_intr)
 573 {
 574         struct vhost_net_virtqueue *rnvq = &net->vqs[VHOST_NET_VQ_RX];
 575         struct vhost_virtqueue *rvq = &rnvq->vq;
 576         struct vhost_virtqueue *tvq = &tnvq->vq;
 577
 578         int r = vhost_get_vq_desc(tvq, tvq->iov, ARRAY_SIZE(tvq->iov),
 579                                   out_num, in_num, NULL, NULL);
 580
 581         if (r == tvq->num && tvq->busyloop_timeout) {
 582                 /* Flush batched packets first */
 583                 if (!vhost_sock_zcopy(tvq->private_data))
 584                         vhost_tx_batch(net, tnvq, tvq->private_data, msghdr);
 585
 586                 vhost_net_busy_poll(net, rvq, tvq, busyloop_intr, false);
 587
 588                 r = vhost_get_vq_desc(tvq, tvq->iov, ARRAY_SIZE(tvq->iov),
 589                                       out_num, in_num, NULL, NULL);
 590         }
 591
 592         return r;
 593 }
 594
 595 static bool vhost_exceeds_maxpend(struct vhost_net *net)
 596 {
 597         struct vhost_net_virtqueue *nvq = &net->vqs[VHOST_NET_VQ_TX];
 598         struct vhost_virtqueue *vq = &nvq->vq;
 599
 600         return (nvq->upend_idx + UIO_MAXIOV - nvq->done_idx) % UIO_MAXIOV >
 601                min_t(unsigned int, VHOST_MAX_PEND, vq->num >> 2);
 602 }
 603
 604 static size_t init_iov_iter(struct vhost_virtqueue *vq, struct iov_iter *iter,
 605                             size_t hdr_size, int out)
 606 {
 607         /* Skip header. TODO: support TSO. */
 608         size_t len = iov_length(vq->iov, out);
 609
 610         iov_iter_init(iter, WRITE, vq->iov, out, len);
 611         iov_iter_advance(iter, hdr_size);
 612
 613         return iov_iter_count(iter);
 614 }
 615
 616 static int get_tx_bufs(struct vhost_net *net,
 617                        struct vhost_net_virtqueue *nvq,
 618                        struct msghdr *msg,
 619                        unsigned int *out, unsigned int *in,
 620                        size_t *len, bool *busyloop_intr)
 621 {
 622         struct vhost_virtqueue *vq = &nvq->vq;
 623         int ret;
 624
 625         ret = vhost_net_tx_get_vq_desc(net, nvq, out, in, msg, busyloop_intr);
 626
 627         if (ret < 0 || ret == vq->num)
 628                 return ret;
 629
 630         if (*in) {
 631                 vq_err(vq, "Unexpected descriptor format for TX: out %d, int %d\n",
 632                         *out, *in);
 633                 return -EFAULT;
 634         }
 635
 636         /* Sanity check */
 637         *len = init_iov_iter(vq, &msg->msg_iter, nvq->vhost_hlen, *out);
 638         if (*len == 0) {
 639                 vq_err(vq, "Unexpected header len for TX: %zd expected %zd\n",
 640                         *len, nvq->vhost_hlen);
 641                 return -EFAULT;
 642         }
 643
 644         return ret;
 645 }
 646
 647 static bool tx_can_batch(struct vhost_virtqueue *vq, size_t total_len)
 648 {
 649         return total_len < VHOST_NET_WEIGHT &&
 650                !vhost_vq_avail_empty(vq->dev, vq);
 651 }
 652
 653 #define SKB_FRAG_PAGE_ORDER     get_order(32768)
 654
 655 static bool vhost_net_page_frag_refill(struct vhost_net *net, unsigned int sz,
 656                                        struct page_frag *pfrag, gfp_t gfp)
 657 {
 658         if (pfrag->page) {
 659                 if (pfrag->offset + sz <= pfrag->size)
 660                         return true;
 661                 __page_frag_cache_drain(pfrag->page, net->refcnt_bias);
 662         }
 663
 664         pfrag->offset = 0;
 665         net->refcnt_bias = 0;
 666         if (SKB_FRAG_PAGE_ORDER) {
 667                 /* Avoid direct reclaim but allow kswapd to wake */
 668                 pfrag->page = alloc_pages((gfp & ~__GFP_DIRECT_RECLAIM) |
 669                                           __GFP_COMP | __GFP_NOWARN |
 670                                           __GFP_NORETRY,
 671                                           SKB_FRAG_PAGE_ORDER);
 672                 if (likely(pfrag->page)) {
 673                         pfrag->size = PAGE_SIZE << SKB_FRAG_PAGE_ORDER;
 674                         goto done;
 675                 }
 676         }
 677         pfrag->page = alloc_page(gfp);
 678         if (likely(pfrag->page)) {
 679                 pfrag->size = PAGE_SIZE;
 680                 goto done;
 681         }
 682         return false;
 683
 684 done:
 685         net->refcnt_bias = USHRT_MAX;
 686         page_ref_add(pfrag->page, USHRT_MAX - 1);
 687         return true;
 688 }
 689
 690 #define VHOST_NET_RX_PAD (NET_IP_ALIGN + NET_SKB_PAD)
 691
 692 static int vhost_net_build_xdp(struct vhost_net_virtqueue *nvq,
 693                                struct iov_iter *from)
 694 {
 695         struct vhost_virtqueue *vq = &nvq->vq;
 696         struct vhost_net *net = container_of(vq->dev, struct vhost_net,
 697                                              dev);
 698         struct socket *sock = vq->private_data;
 699         struct page_frag *alloc_frag = &net->page_frag;
 700         struct virtio_net_hdr *gso;
 701         struct xdp_buff *xdp = &nvq->xdp[nvq->batched_xdp];
 702         struct tun_xdp_hdr *hdr;
 703         size_t len = iov_iter_count(from);
 704         int headroom = vhost_sock_xdp(sock) ? XDP_PACKET_HEADROOM : 0;
 705         int buflen = SKB_DATA_ALIGN(sizeof(struct skb_shared_info));
 706         int pad = SKB_DATA_ALIGN(VHOST_NET_RX_PAD + headroom + nvq->sock_hlen);
 707         int sock_hlen = nvq->sock_hlen;
 708         void *buf;
 709         int copied;
 710
 711         if (unlikely(len < nvq->sock_hlen))
 712                 return -EFAULT;
 713
 714         if (SKB_DATA_ALIGN(len + pad) +
 715             SKB_DATA_ALIGN(sizeof(struct skb_shared_info)) > PAGE_SIZE)
 716                 return -ENOSPC;
 717
 718         buflen += SKB_DATA_ALIGN(len + pad);
 719         alloc_frag->offset = ALIGN((u64)alloc_frag->offset, SMP_CACHE_BYTES);
 720         if (unlikely(!vhost_net_page_frag_refill(net, buflen,
 721                                                  alloc_frag, GFP_KERNEL)))
 722                 return -ENOMEM;
 723
 724         buf = (char *)page_address(alloc_frag->page) + alloc_frag->offset;
 725         copied = copy_page_from_iter(alloc_frag->page,
 726                                      alloc_frag->offset +
 727                                      offsetof(struct tun_xdp_hdr, gso),
 728                                      sock_hlen, from);
 729         if (copied != sock_hlen)
 730                 return -EFAULT;
 731
 732         hdr = buf;
 733         gso = &hdr->gso;
 734
 735         if ((gso->flags & VIRTIO_NET_HDR_F_NEEDS_CSUM) &&
 736             vhost16_to_cpu(vq, gso->csum_start) +
 737             vhost16_to_cpu(vq, gso->csum_offset) + 2 >
 738             vhost16_to_cpu(vq, gso->hdr_len)) {
 739                 gso->hdr_len = cpu_to_vhost16(vq,
 740                                vhost16_to_cpu(vq, gso->csum_start) +
 741                                vhost16_to_cpu(vq, gso->csum_offset) + 2);
 742
 743                 if (vhost16_to_cpu(vq, gso->hdr_len) > len)
 744                         return -EINVAL;
 745         }
 746
 747         len -= sock_hlen;
 748         copied = copy_page_from_iter(alloc_frag->page,
 749                                      alloc_frag->offset + pad,
 750                                      len, from);
 751         if (copied != len)
 752                 return -EFAULT;
 753
 754         xdp->data_hard_start = buf;
 755         xdp->data = buf + pad;
 756         xdp->data_end = xdp->data + len;
 757         hdr->buflen = buflen;
 758
 759         --net->refcnt_bias;
 760         alloc_frag->offset += buflen;
 761
 762         ++nvq->batched_xdp;
 763
 764         return 0;
 765 }
 766
 767 static void handle_tx_copy(struct vhost_net *net, struct socket *sock)
 768 {
 769         struct vhost_net_virtqueue *nvq = &net->vqs[VHOST_NET_VQ_TX];
 770         struct vhost_virtqueue *vq = &nvq->vq;
 771         unsigned out, in;
 772         int head;
 773         struct msghdr msg = {
 774                 .msg_name = NULL,
 775                 .msg_namelen = 0,
 776                 .msg_control = NULL,
 777                 .msg_controllen = 0,
 778                 .msg_flags = MSG_DONTWAIT,
 779         };
 780         size_t len, total_len = 0;
 781         int err;
 782         int sent_pkts = 0;
 783         bool sock_can_batch = (sock->sk->sk_sndbuf == INT_MAX);
 784
 785         do {
 786                 bool busyloop_intr = false;
 787
 788                 if (nvq->done_idx == VHOST_NET_BATCH)
 789                         vhost_tx_batch(net, nvq, sock, &msg);
 790
 791                 head = get_tx_bufs(net, nvq, &msg, &out, &in, &len,
 792                                    &busyloop_intr);
 793                 /* On error, stop handling until the next kick. */
 794                 if (unlikely(head < 0))
 795                         break;
 796                 /* Nothing new?  Wait for eventfd to tell us they refilled. */
 797                 if (head == vq->num) {
 798                         if (unlikely(busyloop_intr)) {
 799                                 vhost_poll_queue(&vq->poll);
 800                         } else if (unlikely(vhost_enable_notify(&net->dev,
 801                                                                 vq))) {
 802                                 vhost_disable_notify(&net->dev, vq);
 803                                 continue;
 804                         }
 805                         break;
 806                 }
 807
 808                 total_len += len;
 809
 810                 /* For simplicity, TX batching is only enabled if
 811                  * sndbuf is unlimited.
 812                  */
 813                 if (sock_can_batch) {
 814                         err = vhost_net_build_xdp(nvq, &msg.msg_iter);
 815                         if (!err) {
 816                                 goto done;
 817                         } else if (unlikely(err != -ENOSPC)) {
 818                                 vhost_tx_batch(net, nvq, sock, &msg);
 819                                 vhost_discard_vq_desc(vq, 1);
 820                                 vhost_net_enable_vq(net, vq);
 821                                 break;
 822                         }
 823
 824                         /* We can't build XDP buff, go for single
 825                          * packet path but let's flush batched
 826                          * packets.
 827                          */
 828                         vhost_tx_batch(net, nvq, sock, &msg);
 829                         msg.msg_control = NULL;
 830                 } else {
 831                         if (tx_can_batch(vq, total_len))
 832                                 msg.msg_flags |= MSG_MORE;
 833                         else
 834                                 msg.msg_flags &= ~MSG_MORE;
 835                 }
 836
 837                 /* TODO: Check specific error and bomb out unless ENOBUFS? */
 838                 err = sock->ops->sendmsg(sock, &msg, len);
 839                 if (unlikely(err < 0)) {
 840                         vhost_discard_vq_desc(vq, 1);
 841                         vhost_net_enable_vq(net, vq);
 842                         break;
 843                 }
 844                 if (err != len)
 845                         pr_debug("Truncated TX packet: len %d != %zd\n",
 846                                  err, len);
 847 done:
 848                 vq->heads[nvq->done_idx].id = cpu_to_vhost32(vq, head);
 849                 vq->heads[nvq->done_idx].len = 0;
 850                 ++nvq->done_idx;
 851         } while (likely(!vhost_exceeds_weight(vq, ++sent_pkts, total_len)));
 852
 853         vhost_tx_batch(net, nvq, sock, &msg);
 854 }
 855
 856 static void handle_tx_zerocopy(struct vhost_net *net, struct socket *sock)
 857 {
 858         struct vhost_net_virtqueue *nvq = &net->vqs[VHOST_NET_VQ_TX];
 859         struct vhost_virtqueue *vq = &nvq->vq;
 860         unsigned out, in;
 861         int head;
 862         struct msghdr msg = {
 863                 .msg_name = NULL,
 864                 .msg_namelen = 0,
 865                 .msg_control = NULL,
 866                 .msg_controllen = 0,
 867                 .msg_flags = MSG_DONTWAIT,
 868         };
 869         struct tun_msg_ctl ctl;
 870         size_t len, total_len = 0;
 871         int err;
 872         struct vhost_net_ubuf_ref *uninitialized_var(ubufs);
 873         struct ubuf_info *ubuf;
 874         bool zcopy_used;
 875         int sent_pkts = 0;
 876
 877         do {
 878                 bool busyloop_intr;
 879
 880                 /* Release DMAs done buffers first */
 881                 vhost_zerocopy_signal_used(net, vq);
 882
 883                 busyloop_intr = false;
 884                 head = get_tx_bufs(net, nvq, &msg, &out, &in, &len,
 885                                    &busyloop_intr);
 886                 /* On error, stop handling until the next kick. */
 887                 if (unlikely(head < 0))
 888                         break;
 889                 /* Nothing new?  Wait for eventfd to tell us they refilled. */
 890                 if (head == vq->num) {
 891                         if (unlikely(busyloop_intr)) {
 892                                 vhost_poll_queue(&vq->poll);
 893                         } else if (unlikely(vhost_enable_notify(&net->dev, vq))) {
 894                                 vhost_disable_notify(&net->dev, vq);
 895                                 continue;
 896                         }
 897                         break;
 898                 }
 899
 900                 zcopy_used = len >= VHOST_GOODCOPY_LEN
 901                              && !vhost_exceeds_maxpend(net)
 902                              && vhost_net_tx_select_zcopy(net);
 903
 904                 /* use msg_control to pass vhost zerocopy ubuf info to skb */
 905                 if (zcopy_used) {
 906                         ubuf = nvq->ubuf_info + nvq->upend_idx;
 907                         vq->heads[nvq->upend_idx].id = cpu_to_vhost32(vq, head);
 908                         vq->heads[nvq->upend_idx].len = VHOST_DMA_IN_PROGRESS;
 909                         ubuf->callback = vhost_zerocopy_callback;
 910                         ubuf->ctx = nvq->ubufs;
 911                         ubuf->desc = nvq->upend_idx;
 912                         refcount_set(&ubuf->refcnt, 1);
 913                         msg.msg_control = &ctl;
 914                         ctl.type = TUN_MSG_UBUF;
 915                         ctl.ptr = ubuf;
 916                         msg.msg_controllen = sizeof(ctl);
 917                         ubufs = nvq->ubufs;
 918                         atomic_inc(&ubufs->refcount);
 919                         nvq->upend_idx = (nvq->upend_idx + 1) % UIO_MAXIOV;
 920                 } else {
 921                         msg.msg_control = NULL;
 922                         ubufs = NULL;
 923                 }
 924                 total_len += len;
 925                 if (tx_can_batch(vq, total_len) &&
 926                     likely(!vhost_exceeds_maxpend(net))) {
 927                         msg.msg_flags |= MSG_MORE;
 928                 } else {
 929                         msg.msg_flags &= ~MSG_MORE;
 930                 }
 931
 932                 /* TODO: Check specific error and bomb out unless ENOBUFS? */
 933                 err = sock->ops->sendmsg(sock, &msg, len);
 934                 if (unlikely(err < 0)) {
 935                         if (zcopy_used) {
 936                                 if (vq->heads[ubuf->desc].len == VHOST_DMA_IN_PROGRESS)
 937                                         vhost_net_ubuf_put(ubufs);
 938                                 nvq->upend_idx = ((unsigned)nvq->upend_idx - 1)
 939                                         % UIO_MAXIOV;
 940                         }
 941                         vhost_discard_vq_desc(vq, 1);
 942                         vhost_net_enable_vq(net, vq);
 943                         break;
 944                 }
 945                 if (err != len)
 946                         pr_debug("Truncated TX packet: "
 947                                  " len %d != %zd\n", err, len);
 948                 if (!zcopy_used)
 949                         vhost_add_used_and_signal(&net->dev, vq, head, 0);
 950                 else
 951                         vhost_zerocopy_signal_used(net, vq);
 952                 vhost_net_tx_packet(net);
 953         } while (likely(!vhost_exceeds_weight(vq, ++sent_pkts, total_len)));
 954 }
 955
 956 /* Expects to be always run from workqueue - which acts as
 957  * read-size critical section for our kind of RCU. */
 958 static void handle_tx(struct vhost_net *net)
 959 {
 960         struct vhost_net_virtqueue *nvq = &net->vqs[VHOST_NET_VQ_TX];
 961         struct vhost_virtqueue *vq = &nvq->vq;
 962         struct socket *sock;
 963
 964         mutex_lock_nested(&vq->mutex, VHOST_NET_VQ_TX);
 965         sock = vq->private_data;
 966         if (!sock)
 967                 goto out;
 968
 969         if (!vq_meta_prefetch(vq))
 970                 goto out;
 971
 972         vhost_disable_notify(&net->dev, vq);
 973         vhost_net_disable_vq(net, vq);
 974
 975         if (vhost_sock_zcopy(sock))
 976                 handle_tx_zerocopy(net, sock);
 977         else
 978                 handle_tx_copy(net, sock);
 979
 980 out:
 981         mutex_unlock(&vq->mutex);
 982 }
 983
 984 static int peek_head_len(struct vhost_net_virtqueue *rvq, struct sock *sk)
 985 {
 986         struct sk_buff *head;
 987         int len = 0;
 988         unsigned long flags;
 989
 990         if (rvq->rx_ring)
 991                 return vhost_net_buf_peek(rvq);
 992
 993         spin_lock_irqsave(&sk->sk_receive_queue.lock, flags);
 994         head = skb_peek(&sk->sk_receive_queue);
 995         if (likely(head)) {
 996                 len = head->len;
 997                 if (skb_vlan_tag_present(head))
 998                         len += VLAN_HLEN;
 999         }
1000
1001         spin_unlock_irqrestore(&sk->sk_receive_queue.lock, flags);
1002         return len;
1003 }
1004
1005 static int vhost_net_rx_peek_head_len(struct vhost_net *net, struct sock *sk,
1006                                       bool *busyloop_intr)
1007 {
1008         struct vhost_net_virtqueue *rnvq = &net->vqs[VHOST_NET_VQ_RX];
1009         struct vhost_net_virtqueue *tnvq = &net->vqs[VHOST_NET_VQ_TX];
1010         struct vhost_virtqueue *rvq = &rnvq->vq;
1011         struct vhost_virtqueue *tvq = &tnvq->vq;
1012         int len = peek_head_len(rnvq, sk);
1013
1014         if (!len && rvq->busyloop_timeout) {
1015                 /* Flush batched heads first */
1016                 vhost_net_signal_used(rnvq);
1017                 /* Both tx vq and rx socket were polled here */
1018                 vhost_net_busy_poll(net, rvq, tvq, busyloop_intr, true);
1019
1020                 len = peek_head_len(rnvq, sk);
1021         }
1022
1023         return len;
1024 }
1025
1026 /* This is a multi-buffer version of vhost_get_desc, that works if
1027  *      vq has read descriptors only.
1028  * @vq          - the relevant virtqueue
1029  * @datalen     - data length we'll be reading
1030  * @iovcount    - returned count of io vectors we fill
1031  * @log         - vhost log
1032  * @log_num     - log offset
1033  * @quota       - headcount quota, 1 for big buffer
1034  *      returns number of buffer heads allocated, negative on error
1035  */
1036 static int get_rx_bufs(struct vhost_virtqueue *vq,
1037                        struct vring_used_elem *heads,
1038                        int datalen,
1039                        unsigned *iovcount,
1040                        struct vhost_log *log,
1041                        unsigned *log_num,
1042                        unsigned int quota)
1043 {
1044         unsigned int out, in;
1045         int seg = 0;
1046         int headcount = 0;
1047         unsigned d;
1048         int r, nlogs = 0;
1049         /* len is always initialized before use since we are always called with
1050          * datalen > 0.
1051          */
1052         u32 uninitialized_var(len);
1053
1054         while (datalen > 0 && headcount < quota) {
1055                 if (unlikely(seg >= UIO_MAXIOV)) {
1056                         r = -ENOBUFS;
1057                         goto err;
1058                 }
1059                 r = vhost_get_vq_desc(vq, vq->iov + seg,
1060                                       ARRAY_SIZE(vq->iov) - seg, &out,
1061                                       &in, log, log_num);
1062                 if (unlikely(r < 0))
1063                         goto err;
1064
1065                 d = r;
1066                 if (d == vq->num) {
1067                         r = 0;
1068                         goto err;
1069                 }
1070                 if (unlikely(out || in <= 0)) {
1071                         vq_err(vq, "unexpected descriptor format for RX: "
1072                                 "out %d, in %d\n", out, in);
1073                         r = -EINVAL;
1074                         goto err;
1075                 }
1076                 if (unlikely(log)) {
1077                         nlogs += *log_num;
1078                         log += *log_num;
1079                 }
1080                 heads[headcount].id = cpu_to_vhost32(vq, d);
1081                 len = iov_length(vq->iov + seg, in);
1082                 heads[headcount].len = cpu_to_vhost32(vq, len);
1083                 datalen -= len;
1084                 ++headcount;
1085                 seg += in;
1086         }
1087         heads[headcount - 1].len = cpu_to_vhost32(vq, len + datalen);
1088         *iovcount = seg;
1089         if (unlikely(log))
1090                 *log_num = nlogs;
1091
1092         /* Detect overrun */
1093         if (unlikely(datalen > 0)) {
1094                 r = UIO_MAXIOV + 1;
1095                 goto err;
1096         }
1097         return headcount;
1098 err:
1099         vhost_discard_vq_desc(vq, headcount);
1100         return r;
1101 }
1102
1103 /* Expects to be always run from workqueue - which acts as
1104  * read-size critical section for our kind of RCU. */
1105 static void handle_rx(struct vhost_net *net)
1106 {
1107         struct vhost_net_virtqueue *nvq = &net->vqs[VHOST_NET_VQ_RX];
1108         struct vhost_virtqueue *vq = &nvq->vq;
1109         unsigned uninitialized_var(in), log;
1110         struct vhost_log *vq_log;
1111         struct msghdr msg = {
1112                 .msg_name = NULL,
1113                 .msg_namelen = 0,
1114                 .msg_control = NULL, /* FIXME: get and handle RX aux data. */
1115                 .msg_controllen = 0,
1116                 .msg_flags = MSG_DONTWAIT,
1117         };
1118         struct virtio_net_hdr hdr = {
1119                 .flags = 0,
1120                 .gso_type = VIRTIO_NET_HDR_GSO_NONE
1121         };
1122         size_t total_len = 0;
1123         int err, mergeable;
1124         s16 headcount;
1125         size_t vhost_hlen, sock_hlen;
1126         size_t vhost_len, sock_len;
1127         bool busyloop_intr = false;
1128         struct socket *sock;
1129         struct iov_iter fixup;
1130         __virtio16 num_buffers;
1131         int recv_pkts = 0;
1132
1133         mutex_lock_nested(&vq->mutex, VHOST_NET_VQ_RX);
1134         sock = vq->private_data;
1135         if (!sock)
1136                 goto out;
1137
1138         if (!vq_meta_prefetch(vq))
1139                 goto out;
1140
1141         vhost_disable_notify(&net->dev, vq);
1142         vhost_net_disable_vq(net, vq);
1143
1144         vhost_hlen = nvq->vhost_hlen;
1145         sock_hlen = nvq->sock_hlen;
1146
1147         vq_log = unlikely(vhost_has_feature(vq, VHOST_F_LOG_ALL)) ?
1148                 vq->log : NULL;
1149         mergeable = vhost_has_feature(vq, VIRTIO_NET_F_MRG_RXBUF);
1150
1151         do {
1152                 sock_len = vhost_net_rx_peek_head_len(net, sock->sk,
1153                                                       &busyloop_intr);
1154                 if (!sock_len)
1155                         break;
1156                 sock_len += sock_hlen;
1157                 vhost_len = sock_len + vhost_hlen;
1158                 headcount = get_rx_bufs(vq, vq->heads + nvq->done_idx,
1159                                         vhost_len, &in, vq_log, &log,
1160                                         likely(mergeable) ? UIO_MAXIOV : 1);
1161                 /* On error, stop handling until the next kick. */
1162                 if (unlikely(headcount < 0))
1163                         goto out;
1164                 /* OK, now we need to know about added descriptors. */
1165                 if (!headcount) {
1166                         if (unlikely(busyloop_intr)) {
1167                                 vhost_poll_queue(&vq->poll);
1168                         } else if (unlikely(vhost_enable_notify(&net->dev, vq))) {
1169                                 /* They have slipped one in as we were
1170                                  * doing that: check again. */
1171                                 vhost_disable_notify(&net->dev, vq);
1172                                 continue;
1173                         }
1174                         /* Nothing new?  Wait for eventfd to tell us
1175                          * they refilled. */
1176                         goto out;
1177                 }
1178                 busyloop_intr = false;
1179                 if (nvq->rx_ring)
1180                         msg.msg_control = vhost_net_buf_consume(&nvq->rxq);
1181                 /* On overrun, truncate and discard */
1182                 if (unlikely(headcount > UIO_MAXIOV)) {
1183                         iov_iter_init(&msg.msg_iter, READ, vq->iov, 1, 1);
1184                         err = sock->ops->recvmsg(sock, &msg,
1185                                                  1, MSG_DONTWAIT | MSG_TRUNC);
1186                         pr_debug("Discarded rx packet: len %zd\n", sock_len);
1187                         continue;
1188                 }
1189                 /* We don't need to be notified again. */
1190                 iov_iter_init(&msg.msg_iter, READ, vq->iov, in, vhost_len);
1191                 fixup = msg.msg_iter;
1192                 if (unlikely((vhost_hlen))) {
1193                         /* We will supply the header ourselves
1194                          * TODO: support TSO.
1195                          */
1196                         iov_iter_advance(&msg.msg_iter, vhost_hlen);
1197                 }
1198                 err = sock->ops->recvmsg(sock, &msg,
1199                                          sock_len, MSG_DONTWAIT | MSG_TRUNC);
1200                 /* Userspace might have consumed the packet meanwhile:
1201                  * it's not supposed to do this usually, but might be hard
1202                  * to prevent. Discard data we got (if any) and keep going. */
1203                 if (unlikely(err != sock_len)) {
1204                         pr_debug("Discarded rx packet: "
1205                                  " len %d, expected %zd\n", err, sock_len);
1206                         vhost_discard_vq_desc(vq, headcount);
1207                         continue;
1208                 }
1209                 /* Supply virtio_net_hdr if VHOST_NET_F_VIRTIO_NET_HDR */
1210                 if (unlikely(vhost_hlen)) {
1211                         if (copy_to_iter(&hdr, sizeof(hdr),
1212                                          &fixup) != sizeof(hdr)) {
1213                                 vq_err(vq, "Unable to write vnet_hdr "
1214                                        "at addr %p\n", vq->iov->iov_base);
1215                                 goto out;
1216                         }
1217                 } else {
1218                         /* Header came from socket; we'll need to patch
1219                          * ->num_buffers over if VIRTIO_NET_F_MRG_RXBUF
1220                          */
1221                         iov_iter_advance(&fixup, sizeof(hdr));
1222                 }
1223                 /* TODO: Should check and handle checksum. */
1224
1225                 num_buffers = cpu_to_vhost16(vq, headcount);
1226                 if (likely(mergeable) &&
1227                     copy_to_iter(&num_buffers, sizeof num_buffers,
1228                                  &fixup) != sizeof num_buffers) {
1229                         vq_err(vq, "Failed num_buffers write");
1230                         vhost_discard_vq_desc(vq, headcount);
1231                         goto out;
1232                 }
1233                 nvq->done_idx += headcount;
1234                 if (nvq->done_idx > VHOST_NET_BATCH)
1235                         vhost_net_signal_used(nvq);
1236                 if (unlikely(vq_log))
1237                         vhost_log_write(vq, vq_log, log, vhost_len,
1238                                         vq->iov, in);
1239                 total_len += vhost_len;
1240         } while (likely(!vhost_exceeds_weight(vq, ++recv_pkts, total_len)));
1241
1242         if (unlikely(busyloop_intr))
1243                 vhost_poll_queue(&vq->poll);
1244         else if (!sock_len)
1245                 vhost_net_enable_vq(net, vq);
1246 out:
1247         vhost_net_signal_used(nvq);
1248         mutex_unlock(&vq->mutex);
1249 }
1250
1251 static void handle_tx_kick(struct vhost_work *work)
1252 {
1253         struct vhost_virtqueue *vq = container_of(work, struct vhost_virtqueue,
1254                                                   poll.work);
1255         struct vhost_net *net = container_of(vq->dev, struct vhost_net, dev);
1256
1257         handle_tx(net);
1258 }
1259
1260 static void handle_rx_kick(struct vhost_work *work)
1261 {
1262         struct vhost_virtqueue *vq = container_of(work, struct vhost_virtqueue,
1263                                                   poll.work);
1264         struct vhost_net *net = container_of(vq->dev, struct vhost_net, dev);
1265
1266         handle_rx(net);
1267 }
1268
1269 static void handle_tx_net(struct vhost_work *work)
1270 {
1271         struct vhost_net *net = container_of(work, struct vhost_net,
1272                                              poll[VHOST_NET_VQ_TX].work);
1273         handle_tx(net);
1274 }
1275
1276 static void handle_rx_net(struct vhost_work *work)
1277 {
1278         struct vhost_net *net = container_of(work, struct vhost_net,
1279                                              poll[VHOST_NET_VQ_RX].work);
1280         handle_rx(net);
1281 }
1282
1283 static int vhost_net_open(struct inode *inode, struct file *f)
1284 {
1285         struct vhost_net *n;
1286         struct vhost_dev *dev;
1287         struct vhost_virtqueue **vqs;
1288         void **queue;
1289         struct xdp_buff *xdp;
1290         int i;
1291
1292         n = kvmalloc(sizeof *n, GFP_KERNEL | __GFP_RETRY_MAYFAIL);
1293         if (!n)
1294                 return -ENOMEM;
1295         vqs = kmalloc_array(VHOST_NET_VQ_MAX, sizeof(*vqs), GFP_KERNEL);
1296         if (!vqs) {
1297                 kvfree(n);
1298                 return -ENOMEM;
1299         }
1300
1301         queue = kmalloc_array(VHOST_NET_BATCH, sizeof(void *),
1302                               GFP_KERNEL);
1303         if (!queue) {
1304                 kfree(vqs);
1305                 kvfree(n);
1306                 return -ENOMEM;
1307         }
1308         n->vqs[VHOST_NET_VQ_RX].rxq.queue = queue;
1309
1310         xdp = kmalloc_array(VHOST_NET_BATCH, sizeof(*xdp), GFP_KERNEL);
1311         if (!xdp) {
1312                 kfree(vqs);
1313                 kvfree(n);
1314                 kfree(queue);
1315                 return -ENOMEM;
1316         }
1317         n->vqs[VHOST_NET_VQ_TX].xdp = xdp;
1318
1319         dev = &n->dev;
1320         vqs[VHOST_NET_VQ_TX] = &n->vqs[VHOST_NET_VQ_TX].vq;
1321         vqs[VHOST_NET_VQ_RX] = &n->vqs[VHOST_NET_VQ_RX].vq;
1322         n->vqs[VHOST_NET_VQ_TX].vq.handle_kick = handle_tx_kick;
1323         n->vqs[VHOST_NET_VQ_RX].vq.handle_kick = handle_rx_kick;
1324         for (i = 0; i < VHOST_NET_VQ_MAX; i++) {
1325                 n->vqs[i].ubufs = NULL;
1326                 n->vqs[i].ubuf_info = NULL;
1327                 n->vqs[i].upend_idx = 0;
1328                 n->vqs[i].done_idx = 0;
1329                 n->vqs[i].batched_xdp = 0;
1330                 n->vqs[i].vhost_hlen = 0;
1331                 n->vqs[i].sock_hlen = 0;
1332                 n->vqs[i].rx_ring = NULL;
1333                 vhost_net_buf_init(&n->vqs[i].rxq);
1334         }
1335         vhost_dev_init(dev, vqs, VHOST_NET_VQ_MAX,
1336                        UIO_MAXIOV + VHOST_NET_BATCH,
1337                        VHOST_NET_PKT_WEIGHT, VHOST_NET_WEIGHT);
1338
1339         vhost_poll_init(n->poll + VHOST_NET_VQ_TX, handle_tx_net, EPOLLOUT, dev);
1340         vhost_poll_init(n->poll + VHOST_NET_VQ_RX, handle_rx_net, EPOLLIN, dev);
1341
1342         f->private_data = n;
1343         n->page_frag.page = NULL;
1344         n->refcnt_bias = 0;
1345
1346         return 0;
1347 }
1348
1349 static struct socket *vhost_net_stop_vq(struct vhost_net *n,
1350                                         struct vhost_virtqueue *vq)
1351 {
1352         struct socket *sock;
1353         struct vhost_net_virtqueue *nvq =
1354                 container_of(vq, struct vhost_net_virtqueue, vq);
1355
1356         mutex_lock(&vq->mutex);
1357         sock = vq->private_data;
1358         vhost_net_disable_vq(n, vq);
1359         vq->private_data = NULL;
1360         vhost_net_buf_unproduce(nvq);
1361         nvq->rx_ring = NULL;
1362         mutex_unlock(&vq->mutex);
1363         return sock;
1364 }
1365
1366 static void vhost_net_stop(struct vhost_net *n, struct socket **tx_sock,
1367                            struct socket **rx_sock)
1368 {
1369         *tx_sock = vhost_net_stop_vq(n, &n->vqs[VHOST_NET_VQ_TX].vq);
1370         *rx_sock = vhost_net_stop_vq(n, &n->vqs[VHOST_NET_VQ_RX].vq);
1371 }
1372
1373 static void vhost_net_flush_vq(struct vhost_net *n, int index)
1374 {
1375         vhost_poll_flush(n->poll + index);
1376         vhost_poll_flush(&n->vqs[index].vq.poll);
1377 }
1378
1379 static void vhost_net_flush(struct vhost_net *n)
1380 {
1381         vhost_net_flush_vq(n, VHOST_NET_VQ_TX);
1382         vhost_net_flush_vq(n, VHOST_NET_VQ_RX);
1383         if (n->vqs[VHOST_NET_VQ_TX].ubufs) {
1384                 mutex_lock(&n->vqs[VHOST_NET_VQ_TX].vq.mutex);
1385                 n->tx_flush = true;
1386                 mutex_unlock(&n->vqs[VHOST_NET_VQ_TX].vq.mutex);
1387                 /* Wait for all lower device DMAs done. */
1388                 vhost_net_ubuf_put_and_wait(n->vqs[VHOST_NET_VQ_TX].ubufs);
1389                 mutex_lock(&n->vqs[VHOST_NET_VQ_TX].vq.mutex);
1390                 n->tx_flush = false;
1391                 atomic_set(&n->vqs[VHOST_NET_VQ_TX].ubufs->refcount, 1);
1392                 mutex_unlock(&n->vqs[VHOST_NET_VQ_TX].vq.mutex);
1393         }
1394 }
1395
1396 static int vhost_net_release(struct inode *inode, struct file *f)
1397 {
1398         struct vhost_net *n = f->private_data;
1399         struct socket *tx_sock;
1400         struct socket *rx_sock;
1401
1402         vhost_net_stop(n, &tx_sock, &rx_sock);
1403         vhost_net_flush(n);
1404         vhost_dev_stop(&n->dev);
1405         vhost_dev_cleanup(&n->dev);
1406         vhost_net_vq_reset(n);
1407         if (tx_sock)
1408                 sockfd_put(tx_sock);
1409         if (rx_sock)
1410                 sockfd_put(rx_sock);
1411         /* Make sure no callbacks are outstanding */
1412         synchronize_rcu();
1413         /* We do an extra flush before freeing memory,
1414          * since jobs can re-queue themselves. */
1415         vhost_net_flush(n);
1416         kfree(n->vqs[VHOST_NET_VQ_RX].rxq.queue);
1417         kfree(n->vqs[VHOST_NET_VQ_TX].xdp);
1418         kfree(n->dev.vqs);
1419         if (n->page_frag.page)
1420                 __page_frag_cache_drain(n->page_frag.page, n->refcnt_bias);
1421         kvfree(n);
1422         return 0;
1423 }
1424
1425 static struct socket *get_raw_socket(int fd)
1426 {
1427         int r;
1428         struct socket *sock = sockfd_lookup(fd, &r);
1429
1430         if (!sock)
1431                 return ERR_PTR(-ENOTSOCK);
1432
1433         /* Parameter checking */
1434         if (sock->sk->sk_type != SOCK_RAW) {
1435                 r = -ESOCKTNOSUPPORT;
1436                 goto err;
1437         }
1438
1439         if (sock->sk->sk_family != AF_PACKET) {
1440                 r = -EPFNOSUPPORT;
1441                 goto err;
1442         }
1443         return sock;
1444 err:
1445         sockfd_put(sock);
1446         return ERR_PTR(r);
1447 }
1448
1449 static struct ptr_ring *get_tap_ptr_ring(struct file *file)
1450 {
1451         struct ptr_ring *ring;
1452         ring = tun_get_tx_ring(file);
1453         if (!IS_ERR(ring))
1454                 goto out;
1455         ring = tap_get_ptr_ring(file);
1456         if (!IS_ERR(ring))
1457                 goto out;
1458         ring = NULL;
1459 out:
1460         return ring;
1461 }
1462
1463 static struct socket *get_tap_socket(int fd)
1464 {
1465         struct file *file = fget(fd);
1466         struct socket *sock;
1467
1468         if (!file)
1469                 return ERR_PTR(-EBADF);
1470         sock = tun_get_socket(file);
1471         if (!IS_ERR(sock))
1472                 return sock;
1473         sock = tap_get_socket(file);
1474         if (IS_ERR(sock))
1475                 fput(file);
1476         return sock;
1477 }
1478
1479 static struct socket *get_socket(int fd)
1480 {
1481         struct socket *sock;
1482
1483         /* special case to disable backend */
1484         if (fd == -1)
1485                 return NULL;
1486         sock = get_raw_socket(fd);
1487         if (!IS_ERR(sock))
1488                 return sock;
1489         sock = get_tap_socket(fd);
1490         if (!IS_ERR(sock))
1491                 return sock;
1492         return ERR_PTR(-ENOTSOCK);
1493 }
1494
1495 static long vhost_net_set_backend(struct vhost_net *n, unsigned index, int fd)
1496 {
1497         struct socket *sock, *oldsock;
1498         struct vhost_virtqueue *vq;
1499         struct vhost_net_virtqueue *nvq;
1500         struct vhost_net_ubuf_ref *ubufs, *oldubufs = NULL;
1501         int r;
1502
1503         mutex_lock(&n->dev.mutex);
1504         r = vhost_dev_check_owner(&n->dev);
1505         if (r)
1506                 goto err;
1507
1508         if (index >= VHOST_NET_VQ_MAX) {
1509                 r = -ENOBUFS;
1510                 goto err;
1511         }
1512         vq = &n->vqs[index].vq;
1513         nvq = &n->vqs[index];
1514         mutex_lock(&vq->mutex);
1515
1516         /* Verify that ring has been setup correctly. */
1517         if (!vhost_vq_access_ok(vq)) {
1518                 r = -EFAULT;
1519                 goto err_vq;
1520         }
1521         sock = get_socket(fd);
1522         if (IS_ERR(sock)) {
1523                 r = PTR_ERR(sock);
1524                 goto err_vq;
1525         }
1526
1527         /* start polling new socket */
1528         oldsock = vq->private_data;
1529         if (sock != oldsock) {
1530                 ubufs = vhost_net_ubuf_alloc(vq,
1531                                              sock && vhost_sock_zcopy(sock));
1532                 if (IS_ERR(ubufs)) {
1533                         r = PTR_ERR(ubufs);
1534                         goto err_ubufs;
1535                 }
1536
1537                 vhost_net_disable_vq(n, vq);
1538                 vq->private_data = sock;
1539                 vhost_net_buf_unproduce(nvq);
1540                 r = vhost_vq_init_access(vq);
1541                 if (r)
1542                         goto err_used;
1543                 r = vhost_net_enable_vq(n, vq);
1544                 if (r)
1545                         goto err_used;
1546                 if (index == VHOST_NET_VQ_RX) {
1547                         if (sock)
1548                                 nvq->rx_ring = get_tap_ptr_ring(sock->file);
1549                         else
1550                                 nvq->rx_ring = NULL;
1551                 }
1552
1553                 oldubufs = nvq->ubufs;
1554                 nvq->ubufs = ubufs;
1555
1556                 n->tx_packets = 0;
1557                 n->tx_zcopy_err = 0;
1558                 n->tx_flush = false;
1559         }
1560
1561         mutex_unlock(&vq->mutex);
1562
1563         if (oldubufs) {
1564                 vhost_net_ubuf_put_wait_and_free(oldubufs);
1565                 mutex_lock(&vq->mutex);
1566                 vhost_zerocopy_signal_used(n, vq);
1567                 mutex_unlock(&vq->mutex);
1568         }
1569
1570         if (oldsock) {
1571                 vhost_net_flush_vq(n, index);
1572                 sockfd_put(oldsock);
1573         }
1574
1575         mutex_unlock(&n->dev.mutex);
1576         return 0;
1577
1578 err_used:
1579         vq->private_data = oldsock;
1580         vhost_net_enable_vq(n, vq);
1581         if (ubufs)
1582                 vhost_net_ubuf_put_wait_and_free(ubufs);
1583 err_ubufs:
1584         if (sock)
1585                 sockfd_put(sock);
1586 err_vq:
1587         mutex_unlock(&vq->mutex);
1588 err:
1589         mutex_unlock(&n->dev.mutex);
1590         return r;
1591 }
1592
1593 static long vhost_net_reset_owner(struct vhost_net *n)
1594 {
1595         struct socket *tx_sock = NULL;
1596         struct socket *rx_sock = NULL;
1597         long err;
1598         struct vhost_umem *umem;
1599
1600         mutex_lock(&n->dev.mutex);
1601         err = vhost_dev_check_owner(&n->dev);
1602         if (err)
1603                 goto done;
1604         umem = vhost_dev_reset_owner_prepare();
1605         if (!umem) {
1606                 err = -ENOMEM;
1607                 goto done;
1608         }
1609         vhost_net_stop(n, &tx_sock, &rx_sock);
1610         vhost_net_flush(n);
1611         vhost_dev_stop(&n->dev);
1612         vhost_dev_reset_owner(&n->dev, umem);
1613         vhost_net_vq_reset(n);
1614 done:
1615         mutex_unlock(&n->dev.mutex);
1616         if (tx_sock)
1617                 sockfd_put(tx_sock);
1618         if (rx_sock)
1619                 sockfd_put(rx_sock);
1620         return err;
1621 }
1622
1623 static int vhost_net_set_backend_features(struct vhost_net *n, u64 features)
1624 {
1625         int i;
1626
1627         mutex_lock(&n->dev.mutex);
1628         for (i = 0; i < VHOST_NET_VQ_MAX; ++i) {
1629                 mutex_lock(&n->vqs[i].vq.mutex);
1630                 n->vqs[i].vq.acked_backend_features = features;
1631                 mutex_unlock(&n->vqs[i].vq.mutex);
1632         }
1633         mutex_unlock(&n->dev.mutex);
1634
1635         return 0;
1636 }
1637
1638 static int vhost_net_set_features(struct vhost_net *n, u64 features)
1639 {
1640         size_t vhost_hlen, sock_hlen, hdr_len;
1641         int i;
1642
1643         hdr_len = (features & ((1ULL << VIRTIO_NET_F_MRG_RXBUF) |
1644                                (1ULL << VIRTIO_F_VERSION_1))) ?
1645                         sizeof(struct virtio_net_hdr_mrg_rxbuf) :
1646                         sizeof(struct virtio_net_hdr);
1647         if (features & (1 << VHOST_NET_F_VIRTIO_NET_HDR)) {
1648                 /* vhost provides vnet_hdr */
1649                 vhost_hlen = hdr_len;
1650                 sock_hlen = 0;
1651         } else {
1652                 /* socket provides vnet_hdr */
1653                 vhost_hlen = 0;
1654                 sock_hlen = hdr_len;
1655         }
1656         mutex_lock(&n->dev.mutex);
1657         if ((features & (1 << VHOST_F_LOG_ALL)) &&
1658             !vhost_log_access_ok(&n->dev))
1659                 goto out_unlock;
1660
1661         if ((features & (1ULL << VIRTIO_F_IOMMU_PLATFORM))) {
1662                 if (vhost_init_device_iotlb(&n->dev, true))
1663                         goto out_unlock;
1664         }
1665
1666         for (i = 0; i < VHOST_NET_VQ_MAX; ++i) {
1667                 mutex_lock(&n->vqs[i].vq.mutex);
1668                 n->vqs[i].vq.acked_features = features;
1669                 n->vqs[i].vhost_hlen = vhost_hlen;
1670                 n->vqs[i].sock_hlen = sock_hlen;
1671                 mutex_unlock(&n->vqs[i].vq.mutex);
1672         }
1673         mutex_unlock(&n->dev.mutex);
1674         return 0;
1675
1676 out_unlock:
1677         mutex_unlock(&n->dev.mutex);
1678         return -EFAULT;
1679 }
1680
1681 static long vhost_net_set_owner(struct vhost_net *n)
1682 {
1683         int r;
1684
1685         mutex_lock(&n->dev.mutex);
1686         if (vhost_dev_has_owner(&n->dev)) {
1687                 r = -EBUSY;
1688                 goto out;
1689         }
1690         r = vhost_net_set_ubuf_info(n);
1691         if (r)
1692                 goto out;
1693         r = vhost_dev_set_owner(&n->dev);
1694         if (r)
1695                 vhost_net_clear_ubuf_info(n);
1696         vhost_net_flush(n);
1697 out:
1698         mutex_unlock(&n->dev.mutex);
1699         return r;
1700 }
1701
1702 static long vhost_net_ioctl(struct file *f, unsigned int ioctl,
1703                             unsigned long arg)
1704 {
1705         struct vhost_net *n = f->private_data;
1706         void __user *argp = (void __user *)arg;
1707         u64 __user *featurep = argp;
1708         struct vhost_vring_file backend;
1709         u64 features;
1710         int r;
1711
1712         switch (ioctl) {
1713         case VHOST_NET_SET_BACKEND:
1714                 if (copy_from_user(&backend, argp, sizeof backend))
1715                         return -EFAULT;
1716                 return vhost_net_set_backend(n, backend.index, backend.fd);
1717         case VHOST_GET_FEATURES:
1718                 features = VHOST_NET_FEATURES;
1719                 if (copy_to_user(featurep, &features, sizeof features))
1720                         return -EFAULT;
1721                 return 0;
1722         case VHOST_SET_FEATURES:
1723                 if (copy_from_user(&features, featurep, sizeof features))
1724                         return -EFAULT;
1725                 if (features & ~VHOST_NET_FEATURES)
1726                         return -EOPNOTSUPP;
1727                 return vhost_net_set_features(n, features);
1728         case VHOST_GET_BACKEND_FEATURES:
1729                 features = VHOST_NET_BACKEND_FEATURES;
1730                 if (copy_to_user(featurep, &features, sizeof(features)))
1731                         return -EFAULT;
1732                 return 0;
1733         case VHOST_SET_BACKEND_FEATURES:
1734                 if (copy_from_user(&features, featurep, sizeof(features)))
1735                         return -EFAULT;
1736                 if (features & ~VHOST_NET_BACKEND_FEATURES)
1737                         return -EOPNOTSUPP;
1738                 return vhost_net_set_backend_features(n, features);
1739         case VHOST_RESET_OWNER:
1740                 return vhost_net_reset_owner(n);
1741         case VHOST_SET_OWNER:
1742                 return vhost_net_set_owner(n);
1743         default:
1744                 mutex_lock(&n->dev.mutex);
1745                 r = vhost_dev_ioctl(&n->dev, ioctl, argp);
1746                 if (r == -ENOIOCTLCMD)
1747                         r = vhost_vring_ioctl(&n->dev, ioctl, argp);
1748                 else
1749                         vhost_net_flush(n);
1750                 mutex_unlock(&n->dev.mutex);
1751                 return r;
1752         }
1753 }
1754
1755 #ifdef CONFIG_COMPAT
1756 static long vhost_net_compat_ioctl(struct file *f, unsigned int ioctl,
1757                                    unsigned long arg)
1758 {
1759         return vhost_net_ioctl(f, ioctl, (unsigned long)compat_ptr(arg));
1760 }
1761 #endif
1762
1763 static ssize_t vhost_net_chr_read_iter(struct kiocb *iocb, struct iov_iter *to)
1764 {
1765         struct file *file = iocb->ki_filp;
1766         struct vhost_net *n = file->private_data;
1767         struct vhost_dev *dev = &n->dev;
1768         int noblock = file->f_flags & O_NONBLOCK;
1769
1770         return vhost_chr_read_iter(dev, to, noblock);
1771 }
1772
1773 static ssize_t vhost_net_chr_write_iter(struct kiocb *iocb,
1774                                         struct iov_iter *from)
1775 {
1776         struct file *file = iocb->ki_filp;
1777         struct vhost_net *n = file->private_data;
1778         struct vhost_dev *dev = &n->dev;
1779
1780         return vhost_chr_write_iter(dev, from);
1781 }
1782
1783 static __poll_t vhost_net_chr_poll(struct file *file, poll_table *wait)
1784 {
1785         struct vhost_net *n = file->private_data;
1786         struct vhost_dev *dev = &n->dev;
1787
1788         return vhost_chr_poll(file, dev, wait);
1789 }
1790
1791 static const struct file_operations vhost_net_fops = {
1792         .owner          = THIS_MODULE,
1793         .release        = vhost_net_release,
1794         .read_iter      = vhost_net_chr_read_iter,
1795         .write_iter     = vhost_net_chr_write_iter,
1796         .poll           = vhost_net_chr_poll,
1797         .unlocked_ioctl = vhost_net_ioctl,
1798 #ifdef CONFIG_COMPAT
1799         .compat_ioctl   = vhost_net_compat_ioctl,
1800 #endif
1801         .open           = vhost_net_open,
1802         .llseek         = noop_llseek,
1803 };
1804
1805 static struct miscdevice vhost_net_misc = {
1806         .minor = VHOST_NET_MINOR,
1807         .name = "vhost-net",
1808         .fops = &vhost_net_fops,
1809 };
1810
1811 static int vhost_net_init(void)
1812 {
1813         if (experimental_zcopytx)
1814                 vhost_net_enable_zcopy(VHOST_NET_VQ_TX);
1815         return misc_register(&vhost_net_misc);
1816 }
1817 module_init(vhost_net_init);
1818
1819 static void vhost_net_exit(void)
1820 {
1821         misc_deregister(&vhost_net_misc);
1822 }
1823 module_exit(vhost_net_exit);
1824
1825 MODULE_VERSION("0.0.1");
1826 MODULE_LICENSE("GPL v2");
1827 MODULE_AUTHOR("Michael S. Tsirkin");
1828 MODULE_DESCRIPTION("Host kernel accelerator for virtio net");
1829 MODULE_ALIAS_MISCDEV(VHOST_NET_MINOR);
1830 MODULE_ALIAS("devname:vhost-net");