drivers/vhost/net.c

   1 /* Copyright (C) 2009 Red Hat, Inc.
   2  * Author: Michael S. Tsirkin <mst@redhat.com>
   3  *
   4  * This work is licensed under the terms of the GNU GPL, version 2.
   5  *
   6  * virtio-net server in host kernel.
   7  */
   8
   9 #include <linux/compat.h>
  10 #include <linux/eventfd.h>
  11 #include <linux/vhost.h>
  12 #include <linux/virtio_net.h>
  13 #include <linux/miscdevice.h>
  14 #include <linux/module.h>
  15 #include <linux/moduleparam.h>
  16 #include <linux/mutex.h>
  17 #include <linux/workqueue.h>
  18 #include <linux/file.h>
  19 #include <linux/slab.h>
  20
  21 #include <linux/net.h>
  22 #include <linux/if_packet.h>
  23 #include <linux/if_arp.h>
  24 #include <linux/if_tun.h>
  25 #include <linux/if_macvlan.h>
  26 #include <linux/if_vlan.h>
  27
  28 #include <net/sock.h>
  29
  30 #include "vhost.h"
  31
  32 static int experimental_zcopytx = 1;
  33 module_param(experimental_zcopytx, int, 0444);
  34 MODULE_PARM_DESC(experimental_zcopytx, "Enable Zero Copy TX;"
  35                                        " 1 -Enable; 0 - Disable");
  36
  37 /* Max number of bytes transferred before requeueing the job.
  38  * Using this limit prevents one virtqueue from starving others. */
  39 #define VHOST_NET_WEIGHT 0x80000
  40
  41 /* MAX number of TX used buffers for outstanding zerocopy */
  42 #define VHOST_MAX_PEND 128
  43 #define VHOST_GOODCOPY_LEN 256
  44
  45 /*
  46  * For transmit, used buffer len is unused; we override it to track buffer
  47  * status internally; used for zerocopy tx only.
  48  */
  49 /* Lower device DMA failed */
  50 #define VHOST_DMA_FAILED_LEN    3
  51 /* Lower device DMA done */
  52 #define VHOST_DMA_DONE_LEN      2
  53 /* Lower device DMA in progress */
  54 #define VHOST_DMA_IN_PROGRESS   1
  55 /* Buffer unused */
  56 #define VHOST_DMA_CLEAR_LEN     0
  57
  58 #define VHOST_DMA_IS_DONE(len) ((len) >= VHOST_DMA_DONE_LEN)
  59
  60 enum {
  61         VHOST_NET_FEATURES = VHOST_FEATURES |
  62                          (1ULL << VHOST_NET_F_VIRTIO_NET_HDR) |
  63                          (1ULL << VIRTIO_NET_F_MRG_RXBUF),
  64 };
  65
  66 enum {
  67         VHOST_NET_VQ_RX = 0,
  68         VHOST_NET_VQ_TX = 1,
  69         VHOST_NET_VQ_MAX = 2,
  70 };
  71
  72 struct vhost_net_ubuf_ref {
  73         struct kref kref;
  74         wait_queue_head_t wait;
  75         struct vhost_virtqueue *vq;
  76 };
  77
  78 struct vhost_net_virtqueue {
  79         struct vhost_virtqueue vq;
  80         /* hdr is used to store the virtio header.
  81          * Since each iovec has >= 1 byte length, we never need more than
  82          * header length entries to store the header. */
  83         struct iovec hdr[sizeof(struct virtio_net_hdr_mrg_rxbuf)];
  84         size_t vhost_hlen;
  85         size_t sock_hlen;
  86         /* vhost zerocopy support fields below: */
  87         /* last used idx for outstanding DMA zerocopy buffers */
  88         int upend_idx;
  89         /* first used idx for DMA done zerocopy buffers */
  90         int done_idx;
  91         /* an array of userspace buffers info */
  92         struct ubuf_info *ubuf_info;
  93         /* Reference counting for outstanding ubufs.
  94          * Protected by vq mutex. Writers must also take device mutex. */
  95         struct vhost_net_ubuf_ref *ubufs;
  96 };
  97
  98 struct vhost_net {
  99         struct vhost_dev dev;
 100         struct vhost_net_virtqueue vqs[VHOST_NET_VQ_MAX];
 101         struct vhost_poll poll[VHOST_NET_VQ_MAX];
 102         /* Number of TX recently submitted.
 103          * Protected by tx vq lock. */
 104         unsigned tx_packets;
 105         /* Number of times zerocopy TX recently failed.
 106          * Protected by tx vq lock. */
 107         unsigned tx_zcopy_err;
 108         /* Flush in progress. Protected by tx vq lock. */
 109         bool tx_flush;
 110 };
 111
 112 static unsigned vhost_net_zcopy_mask __read_mostly;
 113
 114 static void vhost_net_enable_zcopy(int vq)
 115 {
 116         vhost_net_zcopy_mask |= 0x1 << vq;
 117 }
 118
 119 static void vhost_net_zerocopy_done_signal(struct kref *kref)
 120 {
 121         struct vhost_net_ubuf_ref *ubufs;
 122
 123         ubufs = container_of(kref, struct vhost_net_ubuf_ref, kref);
 124         wake_up(&ubufs->wait);
 125 }
 126
 127 static struct vhost_net_ubuf_ref *
 128 vhost_net_ubuf_alloc(struct vhost_virtqueue *vq, bool zcopy)
 129 {
 130         struct vhost_net_ubuf_ref *ubufs;
 131         /* No zero copy backend? Nothing to count. */
 132         if (!zcopy)
 133                 return NULL;
 134         ubufs = kmalloc(sizeof(*ubufs), GFP_KERNEL);
 135         if (!ubufs)
 136                 return ERR_PTR(-ENOMEM);
 137         kref_init(&ubufs->kref);
 138         init_waitqueue_head(&ubufs->wait);
 139         ubufs->vq = vq;
 140         return ubufs;
 141 }
 142
 143 static void vhost_net_ubuf_put(struct vhost_net_ubuf_ref *ubufs)
 144 {
 145         kref_put(&ubufs->kref, vhost_net_zerocopy_done_signal);
 146 }
 147
 148 static void vhost_net_ubuf_put_and_wait(struct vhost_net_ubuf_ref *ubufs)
 149 {
 150         kref_put(&ubufs->kref, vhost_net_zerocopy_done_signal);
 151         wait_event(ubufs->wait, !atomic_read(&ubufs->kref.refcount));
 152 }
 153
 154 static void vhost_net_ubuf_put_wait_and_free(struct vhost_net_ubuf_ref *ubufs)
 155 {
 156         vhost_net_ubuf_put_and_wait(ubufs);
 157         kfree(ubufs);
 158 }
 159
 160 static void vhost_net_clear_ubuf_info(struct vhost_net *n)
 161 {
 162         int i;
 163
 164         for (i = 0; i < VHOST_NET_VQ_MAX; ++i) {
 165                 kfree(n->vqs[i].ubuf_info);
 166                 n->vqs[i].ubuf_info = NULL;
 167         }
 168 }
 169
 170 static int vhost_net_set_ubuf_info(struct vhost_net *n)
 171 {
 172         bool zcopy;
 173         int i;
 174
 175         for (i = 0; i < VHOST_NET_VQ_MAX; ++i) {
 176                 zcopy = vhost_net_zcopy_mask & (0x1 << i);
 177                 if (!zcopy)
 178                         continue;
 179                 n->vqs[i].ubuf_info = kmalloc(sizeof(*n->vqs[i].ubuf_info) *
 180                                               UIO_MAXIOV, GFP_KERNEL);
 181                 if  (!n->vqs[i].ubuf_info)
 182                         goto err;
 183         }
 184         return 0;
 185
 186 err:
 187         vhost_net_clear_ubuf_info(n);
 188         return -ENOMEM;
 189 }
 190
 191 static void vhost_net_vq_reset(struct vhost_net *n)
 192 {
 193         int i;
 194
 195         vhost_net_clear_ubuf_info(n);
 196
 197         for (i = 0; i < VHOST_NET_VQ_MAX; i++) {
 198                 n->vqs[i].done_idx = 0;
 199                 n->vqs[i].upend_idx = 0;
 200                 n->vqs[i].ubufs = NULL;
 201                 n->vqs[i].vhost_hlen = 0;
 202                 n->vqs[i].sock_hlen = 0;
 203         }
 204
 205 }
 206
 207 static void vhost_net_tx_packet(struct vhost_net *net)
 208 {
 209         ++net->tx_packets;
 210         if (net->tx_packets < 1024)
 211                 return;
 212         net->tx_packets = 0;
 213         net->tx_zcopy_err = 0;
 214 }
 215
 216 static void vhost_net_tx_err(struct vhost_net *net)
 217 {
 218         ++net->tx_zcopy_err;
 219 }
 220
 221 static bool vhost_net_tx_select_zcopy(struct vhost_net *net)
 222 {
 223         /* TX flush waits for outstanding DMAs to be done.
 224          * Don't start new DMAs.
 225          */
 226         return !net->tx_flush &&
 227                 net->tx_packets / 64 >= net->tx_zcopy_err;
 228 }
 229
 230 static bool vhost_sock_zcopy(struct socket *sock)
 231 {
 232         return unlikely(experimental_zcopytx) &&
 233                 sock_flag(sock->sk, SOCK_ZEROCOPY);
 234 }
 235
 236 /* Pop first len bytes from iovec. Return number of segments used. */
 237 static int move_iovec_hdr(struct iovec *from, struct iovec *to,
 238                           size_t len, int iov_count)
 239 {
 240         int seg = 0;
 241         size_t size;
 242
 243         while (len && seg < iov_count) {
 244                 size = min(from->iov_len, len);
 245                 to->iov_base = from->iov_base;
 246                 to->iov_len = size;
 247                 from->iov_len -= size;
 248                 from->iov_base += size;
 249                 len -= size;
 250                 ++from;
 251                 ++to;
 252                 ++seg;
 253         }
 254         return seg;
 255 }
 256 /* Copy iovec entries for len bytes from iovec. */
 257 static void copy_iovec_hdr(const struct iovec *from, struct iovec *to,
 258                            size_t len, int iovcount)
 259 {
 260         int seg = 0;
 261         size_t size;
 262
 263         while (len && seg < iovcount) {
 264                 size = min(from->iov_len, len);
 265                 to->iov_base = from->iov_base;
 266                 to->iov_len = size;
 267                 len -= size;
 268                 ++from;
 269                 ++to;
 270                 ++seg;
 271         }
 272 }
 273
 274 /* In case of DMA done not in order in lower device driver for some reason.
 275  * upend_idx is used to track end of used idx, done_idx is used to track head
 276  * of used idx. Once lower device DMA done contiguously, we will signal KVM
 277  * guest used idx.
 278  */
 279 static void vhost_zerocopy_signal_used(struct vhost_net *net,
 280                                        struct vhost_virtqueue *vq)
 281 {
 282         struct vhost_net_virtqueue *nvq =
 283                 container_of(vq, struct vhost_net_virtqueue, vq);
 284         int i, add;
 285         int j = 0;
 286
 287         for (i = nvq->done_idx; i != nvq->upend_idx; i = (i + 1) % UIO_MAXIOV) {
 288                 if (vq->heads[i].len == VHOST_DMA_FAILED_LEN)
 289                         vhost_net_tx_err(net);
 290                 if (VHOST_DMA_IS_DONE(vq->heads[i].len)) {
 291                         vq->heads[i].len = VHOST_DMA_CLEAR_LEN;
 292                         ++j;
 293                 } else
 294                         break;
 295         }
 296         while (j) {
 297                 add = min(UIO_MAXIOV - nvq->done_idx, j);
 298                 vhost_add_used_and_signal_n(vq->dev, vq,
 299                                             &vq->heads[nvq->done_idx], add);
 300                 nvq->done_idx = (nvq->done_idx + add) % UIO_MAXIOV;
 301                 j -= add;
 302         }
 303 }
 304
 305 static void vhost_zerocopy_callback(struct ubuf_info *ubuf, bool success)
 306 {
 307         struct vhost_net_ubuf_ref *ubufs = ubuf->ctx;
 308         struct vhost_virtqueue *vq = ubufs->vq;
 309         int cnt = atomic_read(&ubufs->kref.refcount);
 310
 311         /*
 312          * Trigger polling thread if guest stopped submitting new buffers:
 313          * in this case, the refcount after decrement will eventually reach 1
 314          * so here it is 2.
 315          * We also trigger polling periodically after each 16 packets
 316          * (the value 16 here is more or less arbitrary, it's tuned to trigger
 317          * less than 10% of times).
 318          */
 319         if (cnt <= 2 || !(cnt % 16))
 320                 vhost_poll_queue(&vq->poll);
 321         /* set len to mark this desc buffers done DMA */
 322         vq->heads[ubuf->desc].len = success ?
 323                 VHOST_DMA_DONE_LEN : VHOST_DMA_FAILED_LEN;
 324         vhost_net_ubuf_put(ubufs);
 325 }
 326
 327 /* Expects to be always run from workqueue - which acts as
 328  * read-size critical section for our kind of RCU. */
 329 static void handle_tx(struct vhost_net *net)
 330 {
 331         struct vhost_net_virtqueue *nvq = &net->vqs[VHOST_NET_VQ_TX];
 332         struct vhost_virtqueue *vq = &nvq->vq;
 333         unsigned out, in, s;
 334         int head;
 335         struct msghdr msg = {
 336                 .msg_name = NULL,
 337                 .msg_namelen = 0,
 338                 .msg_control = NULL,
 339                 .msg_controllen = 0,
 340                 .msg_iov = vq->iov,
 341                 .msg_flags = MSG_DONTWAIT,
 342         };
 343         size_t len, total_len = 0;
 344         int err;
 345         size_t hdr_size;
 346         struct socket *sock;
 347         struct vhost_net_ubuf_ref *uninitialized_var(ubufs);
 348         bool zcopy, zcopy_used;
 349
 350         mutex_lock(&vq->mutex);
 351         sock = vq->private_data;
 352         if (!sock)
 353                 goto out;
 354
 355         vhost_disable_notify(&net->dev, vq);
 356
 357         hdr_size = nvq->vhost_hlen;
 358         zcopy = nvq->ubufs;
 359
 360         for (;;) {
 361                 /* Release DMAs done buffers first */
 362                 if (zcopy)
 363                         vhost_zerocopy_signal_used(net, vq);
 364
 365                 head = vhost_get_vq_desc(&net->dev, vq, vq->iov,
 366                                          ARRAY_SIZE(vq->iov),
 367                                          &out, &in,
 368                                          NULL, NULL);
 369                 /* On error, stop handling until the next kick. */
 370                 if (unlikely(head < 0))
 371                         break;
 372                 /* Nothing new?  Wait for eventfd to tell us they refilled. */
 373                 if (head == vq->num) {
 374                         int num_pends;
 375
 376                         /* If more outstanding DMAs, queue the work.
 377                          * Handle upend_idx wrap around
 378                          */
 379                         num_pends = likely(nvq->upend_idx >= nvq->done_idx) ?
 380                                     (nvq->upend_idx - nvq->done_idx) :
 381                                     (nvq->upend_idx + UIO_MAXIOV -
 382                                      nvq->done_idx);
 383                         if (unlikely(num_pends > VHOST_MAX_PEND))
 384                                 break;
 385                         if (unlikely(vhost_enable_notify(&net->dev, vq))) {
 386                                 vhost_disable_notify(&net->dev, vq);
 387                                 continue;
 388                         }
 389                         break;
 390                 }
 391                 if (in) {
 392                         vq_err(vq, "Unexpected descriptor format for TX: "
 393                                "out %d, int %d\n", out, in);
 394                         break;
 395                 }
 396                 /* Skip header. TODO: support TSO. */
 397                 s = move_iovec_hdr(vq->iov, nvq->hdr, hdr_size, out);
 398                 msg.msg_iovlen = out;
 399                 len = iov_length(vq->iov, out);
 400                 /* Sanity check */
 401                 if (!len) {
 402                         vq_err(vq, "Unexpected header len for TX: "
 403                                "%zd expected %zd\n",
 404                                iov_length(nvq->hdr, s), hdr_size);
 405                         break;
 406                 }
 407                 zcopy_used = zcopy && (len >= VHOST_GOODCOPY_LEN ||
 408                                        nvq->upend_idx != nvq->done_idx);
 409
 410                 /* use msg_control to pass vhost zerocopy ubuf info to skb */
 411                 if (zcopy_used) {
 412                         vq->heads[nvq->upend_idx].id = head;
 413                         if (!vhost_net_tx_select_zcopy(net) ||
 414                             len < VHOST_GOODCOPY_LEN) {
 415                                 /* copy don't need to wait for DMA done */
 416                                 vq->heads[nvq->upend_idx].len =
 417                                                         VHOST_DMA_DONE_LEN;
 418                                 msg.msg_control = NULL;
 419                                 msg.msg_controllen = 0;
 420                                 ubufs = NULL;
 421                         } else {
 422                                 struct ubuf_info *ubuf;
 423                                 ubuf = nvq->ubuf_info + nvq->upend_idx;
 424
 425                                 vq->heads[nvq->upend_idx].len =
 426                                         VHOST_DMA_IN_PROGRESS;
 427                                 ubuf->callback = vhost_zerocopy_callback;
 428                                 ubuf->ctx = nvq->ubufs;
 429                                 ubuf->desc = nvq->upend_idx;
 430                                 msg.msg_control = ubuf;
 431                                 msg.msg_controllen = sizeof(ubuf);
 432                                 ubufs = nvq->ubufs;
 433                                 kref_get(&ubufs->kref);
 434                         }
 435                         nvq->upend_idx = (nvq->upend_idx + 1) % UIO_MAXIOV;
 436                 } else
 437                         msg.msg_control = NULL;
 438                 /* TODO: Check specific error and bomb out unless ENOBUFS? */
 439                 err = sock->ops->sendmsg(NULL, sock, &msg, len);
 440                 if (unlikely(err < 0)) {
 441                         if (zcopy_used) {
 442                                 if (ubufs)
 443                                         vhost_net_ubuf_put(ubufs);
 444                                 nvq->upend_idx = ((unsigned)nvq->upend_idx - 1)
 445                                         % UIO_MAXIOV;
 446                         }
 447                         vhost_discard_vq_desc(vq, 1);
 448                         break;
 449                 }
 450                 if (err != len)
 451                         pr_debug("Truncated TX packet: "
 452                                  " len %d != %zd\n", err, len);
 453                 if (!zcopy_used)
 454                         vhost_add_used_and_signal(&net->dev, vq, head, 0);
 455                 else
 456                         vhost_zerocopy_signal_used(net, vq);
 457                 total_len += len;
 458                 vhost_net_tx_packet(net);
 459                 if (unlikely(total_len >= VHOST_NET_WEIGHT)) {
 460                         vhost_poll_queue(&vq->poll);
 461                         break;
 462                 }
 463         }
 464 out:
 465         mutex_unlock(&vq->mutex);
 466 }
 467
 468 static int peek_head_len(struct sock *sk)
 469 {
 470         struct sk_buff *head;
 471         int len = 0;
 472         unsigned long flags;
 473
 474         spin_lock_irqsave(&sk->sk_receive_queue.lock, flags);
 475         head = skb_peek(&sk->sk_receive_queue);
 476         if (likely(head)) {
 477                 len = head->len;
 478                 if (vlan_tx_tag_present(head))
 479                         len += VLAN_HLEN;
 480         }
 481
 482         spin_unlock_irqrestore(&sk->sk_receive_queue.lock, flags);
 483         return len;
 484 }
 485
 486 /* This is a multi-buffer version of vhost_get_desc, that works if
 487  *      vq has read descriptors only.
 488  * @vq          - the relevant virtqueue
 489  * @datalen     - data length we'll be reading
 490  * @iovcount    - returned count of io vectors we fill
 491  * @log         - vhost log
 492  * @log_num     - log offset
 493  * @quota       - headcount quota, 1 for big buffer
 494  *      returns number of buffer heads allocated, negative on error
 495  */
 496 static int get_rx_bufs(struct vhost_virtqueue *vq,
 497                        struct vring_used_elem *heads,
 498                        int datalen,
 499                        unsigned *iovcount,
 500                        struct vhost_log *log,
 501                        unsigned *log_num,
 502                        unsigned int quota)
 503 {
 504         unsigned int out, in;
 505         int seg = 0;
 506         int headcount = 0;
 507         unsigned d;
 508         int r, nlogs = 0;
 509
 510         while (datalen > 0 && headcount < quota) {
 511                 if (unlikely(seg >= UIO_MAXIOV)) {
 512                         r = -ENOBUFS;
 513                         goto err;
 514                 }
 515                 d = vhost_get_vq_desc(vq->dev, vq, vq->iov + seg,
 516                                       ARRAY_SIZE(vq->iov) - seg, &out,
 517                                       &in, log, log_num);
 518                 if (d == vq->num) {
 519                         r = 0;
 520                         goto err;
 521                 }
 522                 if (unlikely(out || in <= 0)) {
 523                         vq_err(vq, "unexpected descriptor format for RX: "
 524                                 "out %d, in %d\n", out, in);
 525                         r = -EINVAL;
 526                         goto err;
 527                 }
 528                 if (unlikely(log)) {
 529                         nlogs += *log_num;
 530                         log += *log_num;
 531                 }
 532                 heads[headcount].id = d;
 533                 heads[headcount].len = iov_length(vq->iov + seg, in);
 534                 datalen -= heads[headcount].len;
 535                 ++headcount;
 536                 seg += in;
 537         }
 538         heads[headcount - 1].len += datalen;
 539         *iovcount = seg;
 540         if (unlikely(log))
 541                 *log_num = nlogs;
 542         return headcount;
 543 err:
 544         vhost_discard_vq_desc(vq, headcount);
 545         return r;
 546 }
 547
 548 /* Expects to be always run from workqueue - which acts as
 549  * read-size critical section for our kind of RCU. */
 550 static void handle_rx(struct vhost_net *net)
 551 {
 552         struct vhost_net_virtqueue *nvq = &net->vqs[VHOST_NET_VQ_RX];
 553         struct vhost_virtqueue *vq = &nvq->vq;
 554         unsigned uninitialized_var(in), log;
 555         struct vhost_log *vq_log;
 556         struct msghdr msg = {
 557                 .msg_name = NULL,
 558                 .msg_namelen = 0,
 559                 .msg_control = NULL, /* FIXME: get and handle RX aux data. */
 560                 .msg_controllen = 0,
 561                 .msg_iov = vq->iov,
 562                 .msg_flags = MSG_DONTWAIT,
 563         };
 564         struct virtio_net_hdr_mrg_rxbuf hdr = {
 565                 .hdr.flags = 0,
 566                 .hdr.gso_type = VIRTIO_NET_HDR_GSO_NONE
 567         };
 568         size_t total_len = 0;
 569         int err, mergeable;
 570         s16 headcount;
 571         size_t vhost_hlen, sock_hlen;
 572         size_t vhost_len, sock_len;
 573         struct socket *sock;
 574
 575         mutex_lock(&vq->mutex);
 576         sock = vq->private_data;
 577         if (!sock)
 578                 goto out;
 579         vhost_disable_notify(&net->dev, vq);
 580
 581         vhost_hlen = nvq->vhost_hlen;
 582         sock_hlen = nvq->sock_hlen;
 583
 584         vq_log = unlikely(vhost_has_feature(&net->dev, VHOST_F_LOG_ALL)) ?
 585                 vq->log : NULL;
 586         mergeable = vhost_has_feature(&net->dev, VIRTIO_NET_F_MRG_RXBUF);
 587
 588         while ((sock_len = peek_head_len(sock->sk))) {
 589                 sock_len += sock_hlen;
 590                 vhost_len = sock_len + vhost_hlen;
 591                 headcount = get_rx_bufs(vq, vq->heads, vhost_len,
 592                                         &in, vq_log, &log,
 593                                         likely(mergeable) ? UIO_MAXIOV : 1);
 594                 /* On error, stop handling until the next kick. */
 595                 if (unlikely(headcount < 0))
 596                         break;
 597                 /* OK, now we need to know about added descriptors. */
 598                 if (!headcount) {
 599                         if (unlikely(vhost_enable_notify(&net->dev, vq))) {
 600                                 /* They have slipped one in as we were
 601                                  * doing that: check again. */
 602                                 vhost_disable_notify(&net->dev, vq);
 603                                 continue;
 604                         }
 605                         /* Nothing new?  Wait for eventfd to tell us
 606                          * they refilled. */
 607                         break;
 608                 }
 609                 /* We don't need to be notified again. */
 610                 if (unlikely((vhost_hlen)))
 611                         /* Skip header. TODO: support TSO. */
 612                         move_iovec_hdr(vq->iov, nvq->hdr, vhost_hlen, in);
 613                 else
 614                         /* Copy the header for use in VIRTIO_NET_F_MRG_RXBUF:
 615                          * needed because recvmsg can modify msg_iov. */
 616                         copy_iovec_hdr(vq->iov, nvq->hdr, sock_hlen, in);
 617                 msg.msg_iovlen = in;
 618                 err = sock->ops->recvmsg(NULL, sock, &msg,
 619                                          sock_len, MSG_DONTWAIT | MSG_TRUNC);
 620                 /* Userspace might have consumed the packet meanwhile:
 621                  * it's not supposed to do this usually, but might be hard
 622                  * to prevent. Discard data we got (if any) and keep going. */
 623                 if (unlikely(err != sock_len)) {
 624                         pr_debug("Discarded rx packet: "
 625                                  " len %d, expected %zd\n", err, sock_len);
 626                         vhost_discard_vq_desc(vq, headcount);
 627                         continue;
 628                 }
 629                 if (unlikely(vhost_hlen) &&
 630                     memcpy_toiovecend(nvq->hdr, (unsigned char *)&hdr, 0,
 631                                       vhost_hlen)) {
 632                         vq_err(vq, "Unable to write vnet_hdr at addr %p\n",
 633                                vq->iov->iov_base);
 634                         break;
 635                 }
 636                 /* TODO: Should check and handle checksum. */
 637                 if (likely(mergeable) &&
 638                     memcpy_toiovecend(nvq->hdr, (unsigned char *)&headcount,
 639                                       offsetof(typeof(hdr), num_buffers),
 640                                       sizeof hdr.num_buffers)) {
 641                         vq_err(vq, "Failed num_buffers write");
 642                         vhost_discard_vq_desc(vq, headcount);
 643                         break;
 644                 }
 645                 vhost_add_used_and_signal_n(&net->dev, vq, vq->heads,
 646                                             headcount);
 647                 if (unlikely(vq_log))
 648                         vhost_log_write(vq, vq_log, log, vhost_len);
 649                 total_len += vhost_len;
 650                 if (unlikely(total_len >= VHOST_NET_WEIGHT)) {
 651                         vhost_poll_queue(&vq->poll);
 652                         break;
 653                 }
 654         }
 655 out:
 656         mutex_unlock(&vq->mutex);
 657 }
 658
 659 static void handle_tx_kick(struct vhost_work *work)
 660 {
 661         struct vhost_virtqueue *vq = container_of(work, struct vhost_virtqueue,
 662                                                   poll.work);
 663         struct vhost_net *net = container_of(vq->dev, struct vhost_net, dev);
 664
 665         handle_tx(net);
 666 }
 667
 668 static void handle_rx_kick(struct vhost_work *work)
 669 {
 670         struct vhost_virtqueue *vq = container_of(work, struct vhost_virtqueue,
 671                                                   poll.work);
 672         struct vhost_net *net = container_of(vq->dev, struct vhost_net, dev);
 673
 674         handle_rx(net);
 675 }
 676
 677 static void handle_tx_net(struct vhost_work *work)
 678 {
 679         struct vhost_net *net = container_of(work, struct vhost_net,
 680                                              poll[VHOST_NET_VQ_TX].work);
 681         handle_tx(net);
 682 }
 683
 684 static void handle_rx_net(struct vhost_work *work)
 685 {
 686         struct vhost_net *net = container_of(work, struct vhost_net,
 687                                              poll[VHOST_NET_VQ_RX].work);
 688         handle_rx(net);
 689 }
 690
 691 static int vhost_net_open(struct inode *inode, struct file *f)
 692 {
 693         struct vhost_net *n = kmalloc(sizeof *n, GFP_KERNEL);
 694         struct vhost_dev *dev;
 695         struct vhost_virtqueue **vqs;
 696         int r, i;
 697
 698         if (!n)
 699                 return -ENOMEM;
 700         vqs = kmalloc(VHOST_NET_VQ_MAX * sizeof(*vqs), GFP_KERNEL);
 701         if (!vqs) {
 702                 kfree(n);
 703                 return -ENOMEM;
 704         }
 705
 706         dev = &n->dev;
 707         vqs[VHOST_NET_VQ_TX] = &n->vqs[VHOST_NET_VQ_TX].vq;
 708         vqs[VHOST_NET_VQ_RX] = &n->vqs[VHOST_NET_VQ_RX].vq;
 709         n->vqs[VHOST_NET_VQ_TX].vq.handle_kick = handle_tx_kick;
 710         n->vqs[VHOST_NET_VQ_RX].vq.handle_kick = handle_rx_kick;
 711         for (i = 0; i < VHOST_NET_VQ_MAX; i++) {
 712                 n->vqs[i].ubufs = NULL;
 713                 n->vqs[i].ubuf_info = NULL;
 714                 n->vqs[i].upend_idx = 0;
 715                 n->vqs[i].done_idx = 0;
 716                 n->vqs[i].vhost_hlen = 0;
 717                 n->vqs[i].sock_hlen = 0;
 718         }
 719         r = vhost_dev_init(dev, vqs, VHOST_NET_VQ_MAX);
 720         if (r < 0) {
 721                 kfree(n);
 722                 kfree(vqs);
 723                 return r;
 724         }
 725
 726         vhost_poll_init(n->poll + VHOST_NET_VQ_TX, handle_tx_net, POLLOUT, dev);
 727         vhost_poll_init(n->poll + VHOST_NET_VQ_RX, handle_rx_net, POLLIN, dev);
 728
 729         f->private_data = n;
 730
 731         return 0;
 732 }
 733
 734 static void vhost_net_disable_vq(struct vhost_net *n,
 735                                  struct vhost_virtqueue *vq)
 736 {
 737         struct vhost_net_virtqueue *nvq =
 738                 container_of(vq, struct vhost_net_virtqueue, vq);
 739         struct vhost_poll *poll = n->poll + (nvq - n->vqs);
 740         if (!vq->private_data)
 741                 return;
 742         vhost_poll_stop(poll);
 743 }
 744
 745 static int vhost_net_enable_vq(struct vhost_net *n,
 746                                 struct vhost_virtqueue *vq)
 747 {
 748         struct vhost_net_virtqueue *nvq =
 749                 container_of(vq, struct vhost_net_virtqueue, vq);
 750         struct vhost_poll *poll = n->poll + (nvq - n->vqs);
 751         struct socket *sock;
 752
 753         sock = vq->private_data;
 754         if (!sock)
 755                 return 0;
 756
 757         return vhost_poll_start(poll, sock->file);
 758 }
 759
 760 static struct socket *vhost_net_stop_vq(struct vhost_net *n,
 761                                         struct vhost_virtqueue *vq)
 762 {
 763         struct socket *sock;
 764
 765         mutex_lock(&vq->mutex);
 766         sock = vq->private_data;
 767         vhost_net_disable_vq(n, vq);
 768         vq->private_data = NULL;
 769         mutex_unlock(&vq->mutex);
 770         return sock;
 771 }
 772
 773 static void vhost_net_stop(struct vhost_net *n, struct socket **tx_sock,
 774                            struct socket **rx_sock)
 775 {
 776         *tx_sock = vhost_net_stop_vq(n, &n->vqs[VHOST_NET_VQ_TX].vq);
 777         *rx_sock = vhost_net_stop_vq(n, &n->vqs[VHOST_NET_VQ_RX].vq);
 778 }
 779
 780 static void vhost_net_flush_vq(struct vhost_net *n, int index)
 781 {
 782         vhost_poll_flush(n->poll + index);
 783         vhost_poll_flush(&n->vqs[index].vq.poll);
 784 }
 785
 786 static void vhost_net_flush(struct vhost_net *n)
 787 {
 788         vhost_net_flush_vq(n, VHOST_NET_VQ_TX);
 789         vhost_net_flush_vq(n, VHOST_NET_VQ_RX);
 790         if (n->vqs[VHOST_NET_VQ_TX].ubufs) {
 791                 mutex_lock(&n->vqs[VHOST_NET_VQ_TX].vq.mutex);
 792                 n->tx_flush = true;
 793                 mutex_unlock(&n->vqs[VHOST_NET_VQ_TX].vq.mutex);
 794                 /* Wait for all lower device DMAs done. */
 795                 vhost_net_ubuf_put_and_wait(n->vqs[VHOST_NET_VQ_TX].ubufs);
 796                 mutex_lock(&n->vqs[VHOST_NET_VQ_TX].vq.mutex);
 797                 n->tx_flush = false;
 798                 kref_init(&n->vqs[VHOST_NET_VQ_TX].ubufs->kref);
 799                 mutex_unlock(&n->vqs[VHOST_NET_VQ_TX].vq.mutex);
 800         }
 801 }
 802
 803 static int vhost_net_release(struct inode *inode, struct file *f)
 804 {
 805         struct vhost_net *n = f->private_data;
 806         struct socket *tx_sock;
 807         struct socket *rx_sock;
 808
 809         vhost_net_stop(n, &tx_sock, &rx_sock);
 810         vhost_net_flush(n);
 811         vhost_dev_stop(&n->dev);
 812         vhost_dev_cleanup(&n->dev, false);
 813         vhost_net_vq_reset(n);
 814         if (tx_sock)
 815                 fput(tx_sock->file);
 816         if (rx_sock)
 817                 fput(rx_sock->file);
 818         /* We do an extra flush before freeing memory,
 819          * since jobs can re-queue themselves. */
 820         vhost_net_flush(n);
 821         kfree(n->dev.vqs);
 822         kfree(n);
 823         return 0;
 824 }
 825
 826 static struct socket *get_raw_socket(int fd)
 827 {
 828         struct {
 829                 struct sockaddr_ll sa;
 830                 char  buf[MAX_ADDR_LEN];
 831         } uaddr;
 832         int uaddr_len = sizeof uaddr, r;
 833         struct socket *sock = sockfd_lookup(fd, &r);
 834
 835         if (!sock)
 836                 return ERR_PTR(-ENOTSOCK);
 837
 838         /* Parameter checking */
 839         if (sock->sk->sk_type != SOCK_RAW) {
 840                 r = -ESOCKTNOSUPPORT;
 841                 goto err;
 842         }
 843
 844         r = sock->ops->getname(sock, (struct sockaddr *)&uaddr.sa,
 845                                &uaddr_len, 0);
 846         if (r)
 847                 goto err;
 848
 849         if (uaddr.sa.sll_family != AF_PACKET) {
 850                 r = -EPFNOSUPPORT;
 851                 goto err;
 852         }
 853         return sock;
 854 err:
 855         fput(sock->file);
 856         return ERR_PTR(r);
 857 }
 858
 859 static struct socket *get_tap_socket(int fd)
 860 {
 861         struct file *file = fget(fd);
 862         struct socket *sock;
 863
 864         if (!file)
 865                 return ERR_PTR(-EBADF);
 866         sock = tun_get_socket(file);
 867         if (!IS_ERR(sock))
 868                 return sock;
 869         sock = macvtap_get_socket(file);
 870         if (IS_ERR(sock))
 871                 fput(file);
 872         return sock;
 873 }
 874
 875 static struct socket *get_socket(int fd)
 876 {
 877         struct socket *sock;
 878
 879         /* special case to disable backend */
 880         if (fd == -1)
 881                 return NULL;
 882         sock = get_raw_socket(fd);
 883         if (!IS_ERR(sock))
 884                 return sock;
 885         sock = get_tap_socket(fd);
 886         if (!IS_ERR(sock))
 887                 return sock;
 888         return ERR_PTR(-ENOTSOCK);
 889 }
 890
 891 static long vhost_net_set_backend(struct vhost_net *n, unsigned index, int fd)
 892 {
 893         struct socket *sock, *oldsock;
 894         struct vhost_virtqueue *vq;
 895         struct vhost_net_virtqueue *nvq;
 896         struct vhost_net_ubuf_ref *ubufs, *oldubufs = NULL;
 897         int r;
 898
 899         mutex_lock(&n->dev.mutex);
 900         r = vhost_dev_check_owner(&n->dev);
 901         if (r)
 902                 goto err;
 903
 904         if (index >= VHOST_NET_VQ_MAX) {
 905                 r = -ENOBUFS;
 906                 goto err;
 907         }
 908         vq = &n->vqs[index].vq;
 909         nvq = &n->vqs[index];
 910         mutex_lock(&vq->mutex);
 911
 912         /* Verify that ring has been setup correctly. */
 913         if (!vhost_vq_access_ok(vq)) {
 914                 r = -EFAULT;
 915                 goto err_vq;
 916         }
 917         sock = get_socket(fd);
 918         if (IS_ERR(sock)) {
 919                 r = PTR_ERR(sock);
 920                 goto err_vq;
 921         }
 922
 923         /* start polling new socket */
 924         oldsock = vq->private_data;
 925         if (sock != oldsock) {
 926                 ubufs = vhost_net_ubuf_alloc(vq,
 927                                              sock && vhost_sock_zcopy(sock));
 928                 if (IS_ERR(ubufs)) {
 929                         r = PTR_ERR(ubufs);
 930                         goto err_ubufs;
 931                 }
 932
 933                 vhost_net_disable_vq(n, vq);
 934                 vq->private_data = sock;
 935                 r = vhost_init_used(vq);
 936                 if (r)
 937                         goto err_used;
 938                 r = vhost_net_enable_vq(n, vq);
 939                 if (r)
 940                         goto err_used;
 941
 942                 oldubufs = nvq->ubufs;
 943                 nvq->ubufs = ubufs;
 944
 945                 n->tx_packets = 0;
 946                 n->tx_zcopy_err = 0;
 947                 n->tx_flush = false;
 948         }
 949
 950         mutex_unlock(&vq->mutex);
 951
 952         if (oldubufs) {
 953                 vhost_net_ubuf_put_wait_and_free(oldubufs);
 954                 mutex_lock(&vq->mutex);
 955                 vhost_zerocopy_signal_used(n, vq);
 956                 mutex_unlock(&vq->mutex);
 957         }
 958
 959         if (oldsock) {
 960                 vhost_net_flush_vq(n, index);
 961                 fput(oldsock->file);
 962         }
 963
 964         mutex_unlock(&n->dev.mutex);
 965         return 0;
 966
 967 err_used:
 968         vq->private_data = oldsock;
 969         vhost_net_enable_vq(n, vq);
 970         if (ubufs)
 971                 vhost_net_ubuf_put_wait_and_free(ubufs);
 972 err_ubufs:
 973         fput(sock->file);
 974 err_vq:
 975         mutex_unlock(&vq->mutex);
 976 err:
 977         mutex_unlock(&n->dev.mutex);
 978         return r;
 979 }
 980
 981 static long vhost_net_reset_owner(struct vhost_net *n)
 982 {
 983         struct socket *tx_sock = NULL;
 984         struct socket *rx_sock = NULL;
 985         long err;
 986         struct vhost_memory *memory;
 987
 988         mutex_lock(&n->dev.mutex);
 989         err = vhost_dev_check_owner(&n->dev);
 990         if (err)
 991                 goto done;
 992         memory = vhost_dev_reset_owner_prepare();
 993         if (!memory) {
 994                 err = -ENOMEM;
 995                 goto done;
 996         }
 997         vhost_net_stop(n, &tx_sock, &rx_sock);
 998         vhost_net_flush(n);
 999         vhost_dev_reset_owner(&n->dev, memory);
1000         vhost_net_vq_reset(n);
1001 done:
1002         mutex_unlock(&n->dev.mutex);
1003         if (tx_sock)
1004                 fput(tx_sock->file);
1005         if (rx_sock)
1006                 fput(rx_sock->file);
1007         return err;
1008 }
1009
1010 static int vhost_net_set_features(struct vhost_net *n, u64 features)
1011 {
1012         size_t vhost_hlen, sock_hlen, hdr_len;
1013         int i;
1014
1015         hdr_len = (features & (1 << VIRTIO_NET_F_MRG_RXBUF)) ?
1016                         sizeof(struct virtio_net_hdr_mrg_rxbuf) :
1017                         sizeof(struct virtio_net_hdr);
1018         if (features & (1 << VHOST_NET_F_VIRTIO_NET_HDR)) {
1019                 /* vhost provides vnet_hdr */
1020                 vhost_hlen = hdr_len;
1021                 sock_hlen = 0;
1022         } else {
1023                 /* socket provides vnet_hdr */
1024                 vhost_hlen = 0;
1025                 sock_hlen = hdr_len;
1026         }
1027         mutex_lock(&n->dev.mutex);
1028         if ((features & (1 << VHOST_F_LOG_ALL)) &&
1029             !vhost_log_access_ok(&n->dev)) {
1030                 mutex_unlock(&n->dev.mutex);
1031                 return -EFAULT;
1032         }
1033         n->dev.acked_features = features;
1034         smp_wmb();
1035         for (i = 0; i < VHOST_NET_VQ_MAX; ++i) {
1036                 mutex_lock(&n->vqs[i].vq.mutex);
1037                 n->vqs[i].vhost_hlen = vhost_hlen;
1038                 n->vqs[i].sock_hlen = sock_hlen;
1039                 mutex_unlock(&n->vqs[i].vq.mutex);
1040         }
1041         vhost_net_flush(n);
1042         mutex_unlock(&n->dev.mutex);
1043         return 0;
1044 }
1045
1046 static long vhost_net_set_owner(struct vhost_net *n)
1047 {
1048         int r;
1049
1050         mutex_lock(&n->dev.mutex);
1051         if (vhost_dev_has_owner(&n->dev)) {
1052                 r = -EBUSY;
1053                 goto out;
1054         }
1055         r = vhost_net_set_ubuf_info(n);
1056         if (r)
1057                 goto out;
1058         r = vhost_dev_set_owner(&n->dev);
1059         if (r)
1060                 vhost_net_clear_ubuf_info(n);
1061         vhost_net_flush(n);
1062 out:
1063         mutex_unlock(&n->dev.mutex);
1064         return r;
1065 }
1066
1067 static long vhost_net_ioctl(struct file *f, unsigned int ioctl,
1068                             unsigned long arg)
1069 {
1070         struct vhost_net *n = f->private_data;
1071         void __user *argp = (void __user *)arg;
1072         u64 __user *featurep = argp;
1073         struct vhost_vring_file backend;
1074         u64 features;
1075         int r;
1076
1077         switch (ioctl) {
1078         case VHOST_NET_SET_BACKEND:
1079                 if (copy_from_user(&backend, argp, sizeof backend))
1080                         return -EFAULT;
1081                 return vhost_net_set_backend(n, backend.index, backend.fd);
1082         case VHOST_GET_FEATURES:
1083                 features = VHOST_NET_FEATURES;
1084                 if (copy_to_user(featurep, &features, sizeof features))
1085                         return -EFAULT;
1086                 return 0;
1087         case VHOST_SET_FEATURES:
1088                 if (copy_from_user(&features, featurep, sizeof features))
1089                         return -EFAULT;
1090                 if (features & ~VHOST_NET_FEATURES)
1091                         return -EOPNOTSUPP;
1092                 return vhost_net_set_features(n, features);
1093         case VHOST_RESET_OWNER:
1094                 return vhost_net_reset_owner(n);
1095         case VHOST_SET_OWNER:
1096                 return vhost_net_set_owner(n);
1097         default:
1098                 mutex_lock(&n->dev.mutex);
1099                 r = vhost_dev_ioctl(&n->dev, ioctl, argp);
1100                 if (r == -ENOIOCTLCMD)
1101                         r = vhost_vring_ioctl(&n->dev, ioctl, argp);
1102                 else
1103                         vhost_net_flush(n);
1104                 mutex_unlock(&n->dev.mutex);
1105                 return r;
1106         }
1107 }
1108
1109 #ifdef CONFIG_COMPAT
1110 static long vhost_net_compat_ioctl(struct file *f, unsigned int ioctl,
1111                                    unsigned long arg)
1112 {
1113         return vhost_net_ioctl(f, ioctl, (unsigned long)compat_ptr(arg));
1114 }
1115 #endif
1116
1117 static const struct file_operations vhost_net_fops = {
1118         .owner          = THIS_MODULE,
1119         .release        = vhost_net_release,
1120         .unlocked_ioctl = vhost_net_ioctl,
1121 #ifdef CONFIG_COMPAT
1122         .compat_ioctl   = vhost_net_compat_ioctl,
1123 #endif
1124         .open           = vhost_net_open,
1125         .llseek         = noop_llseek,
1126 };
1127
1128 static struct miscdevice vhost_net_misc = {
1129         .minor = VHOST_NET_MINOR,
1130         .name = "vhost-net",
1131         .fops = &vhost_net_fops,
1132 };
1133
1134 static int vhost_net_init(void)
1135 {
1136         if (experimental_zcopytx)
1137                 vhost_net_enable_zcopy(VHOST_NET_VQ_TX);
1138         return misc_register(&vhost_net_misc);
1139 }
1140 module_init(vhost_net_init);
1141
1142 static void vhost_net_exit(void)
1143 {
1144         misc_deregister(&vhost_net_misc);
1145 }
1146 module_exit(vhost_net_exit);
1147
1148 MODULE_VERSION("0.0.1");
1149 MODULE_LICENSE("GPL v2");
1150 MODULE_AUTHOR("Michael S. Tsirkin");
1151 MODULE_DESCRIPTION("Host kernel accelerator for virtio net");
1152 MODULE_ALIAS_MISCDEV(VHOST_NET_MINOR);
1153 MODULE_ALIAS("devname:vhost-net");