hw/net/vhost_net.c

   1 /*
   2  * vhost-net support
   3  *
   4  * Copyright Red Hat, Inc. 2010
   5  *
   6  * Authors:
   7  *  Michael S. Tsirkin <[email protected]>
   8  *
   9  * This work is licensed under the terms of the GNU GPL, version 2.  See
  10  * the COPYING file in the top-level directory.
  11  *
  12  * Contributions after 2012-01-13 are licensed under the terms of the
  13  * GNU GPL, version 2 or (at your option) any later version.
  14  */
  15
  16 #include "qemu/osdep.h"
  17 #include "net/net.h"
  18 #include "net/tap.h"
  19 #include "net/vhost-user.h"
  20
  21 #include "standard-headers/linux/vhost_types.h"
  22 #include "hw/virtio/virtio-net.h"
  23 #include "net/vhost_net.h"
  24 #include "qemu/error-report.h"
  25
  26
  27 #include <sys/socket.h>
  28 #include <netpacket/packet.h>
  29 #include <net/ethernet.h>
  30 #include <net/if.h>
  31 #include <netinet/in.h>
  32
  33
  34 #include "standard-headers/linux/virtio_ring.h"
  35 #include "hw/virtio/vhost.h"
  36 #include "hw/virtio/virtio-bus.h"
  37
  38 struct vhost_net {
  39     struct vhost_dev dev;
  40     struct vhost_virtqueue vqs[2];
  41     int backend;
  42     NetClientState *nc;
  43 };
  44
  45 /* Features supported by host kernel. */
  46 static const int kernel_feature_bits[] = {
  47     VIRTIO_F_NOTIFY_ON_EMPTY,
  48     VIRTIO_RING_F_INDIRECT_DESC,
  49     VIRTIO_RING_F_EVENT_IDX,
  50     VIRTIO_NET_F_MRG_RXBUF,
  51     VIRTIO_F_VERSION_1,
  52     VIRTIO_NET_F_MTU,
  53     VIRTIO_F_IOMMU_PLATFORM,
  54     VHOST_INVALID_FEATURE_BIT
  55 };
  56
  57 /* Features supported by others. */
  58 static const int user_feature_bits[] = {
  59     VIRTIO_F_NOTIFY_ON_EMPTY,
  60     VIRTIO_RING_F_INDIRECT_DESC,
  61     VIRTIO_RING_F_EVENT_IDX,
  62
  63     VIRTIO_F_ANY_LAYOUT,
  64     VIRTIO_F_VERSION_1,
  65     VIRTIO_NET_F_CSUM,
  66     VIRTIO_NET_F_GUEST_CSUM,
  67     VIRTIO_NET_F_GSO,
  68     VIRTIO_NET_F_GUEST_TSO4,
  69     VIRTIO_NET_F_GUEST_TSO6,
  70     VIRTIO_NET_F_GUEST_ECN,
  71     VIRTIO_NET_F_GUEST_UFO,
  72     VIRTIO_NET_F_HOST_TSO4,
  73     VIRTIO_NET_F_HOST_TSO6,
  74     VIRTIO_NET_F_HOST_ECN,
  75     VIRTIO_NET_F_HOST_UFO,
  76     VIRTIO_NET_F_MRG_RXBUF,
  77     VIRTIO_NET_F_MTU,
  78     VIRTIO_F_IOMMU_PLATFORM,
  79
  80     /* This bit implies RARP isn't sent by QEMU out of band */
  81     VIRTIO_NET_F_GUEST_ANNOUNCE,
  82
  83     VIRTIO_NET_F_MQ,
  84
  85     VHOST_INVALID_FEATURE_BIT
  86 };
  87
  88 static const int *vhost_net_get_feature_bits(struct vhost_net *net)
  89 {
  90     const int *feature_bits = 0;
  91
  92     switch (net->nc->info->type) {
  93     case NET_CLIENT_DRIVER_TAP:
  94         feature_bits = kernel_feature_bits;
  95         break;
  96     case NET_CLIENT_DRIVER_VHOST_USER:
  97         feature_bits = user_feature_bits;
  98         break;
  99     default:
 100         error_report("Feature bits not defined for this type: %d",
 101                 net->nc->info->type);
 102         break;
 103     }
 104
 105     return feature_bits;
 106 }
 107
 108 uint64_t vhost_net_get_features(struct vhost_net *net, uint64_t features)
 109 {
 110     return vhost_get_features(&net->dev, vhost_net_get_feature_bits(net),
 111             features);
 112 }
 113
 114 void vhost_net_ack_features(struct vhost_net *net, uint64_t features)
 115 {
 116     net->dev.acked_features = net->dev.backend_features;
 117     vhost_ack_features(&net->dev, vhost_net_get_feature_bits(net), features);
 118 }
 119
 120 uint64_t vhost_net_get_max_queues(VHostNetState *net)
 121 {
 122     return net->dev.max_queues;
 123 }
 124
 125 uint64_t vhost_net_get_acked_features(VHostNetState *net)
 126 {
 127     return net->dev.acked_features;
 128 }
 129
 130 static int vhost_net_get_fd(NetClientState *backend)
 131 {
 132     switch (backend->info->type) {
 133     case NET_CLIENT_DRIVER_TAP:
 134         return tap_get_fd(backend);
 135     default:
 136         fprintf(stderr, "vhost-net requires tap backend\n");
 137         return -EBADFD;
 138     }
 139 }
 140
 141 struct vhost_net *vhost_net_init(VhostNetOptions *options)
 142 {
 143     int r;
 144     bool backend_kernel = options->backend_type == VHOST_BACKEND_TYPE_KERNEL;
 145     struct vhost_net *net = g_new0(struct vhost_net, 1);
 146     uint64_t features = 0;
 147
 148     if (!options->net_backend) {
 149         fprintf(stderr, "vhost-net requires net backend to be setup\n");
 150         goto fail;
 151     }
 152     net->nc = options->net_backend;
 153
 154     net->dev.max_queues = 1;
 155     net->dev.nvqs = 2;
 156     net->dev.vqs = net->vqs;
 157
 158     if (backend_kernel) {
 159         r = vhost_net_get_fd(options->net_backend);
 160         if (r < 0) {
 161             goto fail;
 162         }
 163         net->dev.backend_features = qemu_has_vnet_hdr(options->net_backend)
 164             ? 0 : (1ULL << VHOST_NET_F_VIRTIO_NET_HDR);
 165         net->backend = r;
 166         net->dev.protocol_features = 0;
 167     } else {
 168         net->dev.backend_features = 0;
 169         net->dev.protocol_features = 0;
 170         net->backend = -1;
 171
 172         /* vhost-user needs vq_index to initiate a specific queue pair */
 173         net->dev.vq_index = net->nc->queue_index * net->dev.nvqs;
 174     }
 175
 176     r = vhost_dev_init(&net->dev, options->opaque,
 177                        options->backend_type, options->busyloop_timeout);
 178     if (r < 0) {
 179         goto fail;
 180     }
 181     if (backend_kernel) {
 182         if (!qemu_has_vnet_hdr_len(options->net_backend,
 183                                sizeof(struct virtio_net_hdr_mrg_rxbuf))) {
 184             net->dev.features &= ~(1ULL << VIRTIO_NET_F_MRG_RXBUF);
 185         }
 186         if (~net->dev.features & net->dev.backend_features) {
 187             fprintf(stderr, "vhost lacks feature mask %" PRIu64
 188                    " for backend\n",
 189                    (uint64_t)(~net->dev.features & net->dev.backend_features));
 190             goto fail;
 191         }
 192     }
 193
 194     /* Set sane init value. Override when guest acks. */
 195 #ifdef CONFIG_VHOST_NET_USER
 196     if (net->nc->info->type == NET_CLIENT_DRIVER_VHOST_USER) {
 197         features = vhost_user_get_acked_features(net->nc);
 198         if (~net->dev.features & features) {
 199             fprintf(stderr, "vhost lacks feature mask %" PRIu64
 200                     " for backend\n",
 201                     (uint64_t)(~net->dev.features & features));
 202             goto fail;
 203         }
 204     }
 205 #endif
 206
 207     vhost_net_ack_features(net, features);
 208
 209     return net;
 210
 211 fail:
 212     vhost_dev_cleanup(&net->dev);
 213     g_free(net);
 214     return NULL;
 215 }
 216
 217 static void vhost_net_set_vq_index(struct vhost_net *net, int vq_index)
 218 {
 219     net->dev.vq_index = vq_index;
 220 }
 221
 222 static int vhost_net_start_one(struct vhost_net *net,
 223                                VirtIODevice *dev)
 224 {
 225     struct vhost_vring_file file = { };
 226     int r;
 227
 228     net->dev.nvqs = 2;
 229     net->dev.vqs = net->vqs;
 230
 231     r = vhost_dev_enable_notifiers(&net->dev, dev);
 232     if (r < 0) {
 233         goto fail_notifiers;
 234     }
 235
 236     r = vhost_dev_start(&net->dev, dev);
 237     if (r < 0) {
 238         goto fail_start;
 239     }
 240
 241     if (net->nc->info->poll) {
 242         net->nc->info->poll(net->nc, false);
 243     }
 244
 245     if (net->nc->info->type == NET_CLIENT_DRIVER_TAP) {
 246         qemu_set_fd_handler(net->backend, NULL, NULL, NULL);
 247         file.fd = net->backend;
 248         for (file.index = 0; file.index < net->dev.nvqs; ++file.index) {
 249             r = vhost_net_set_backend(&net->dev, &file);
 250             if (r < 0) {
 251                 r = -errno;
 252                 goto fail;
 253             }
 254         }
 255     }
 256     return 0;
 257 fail:
 258     file.fd = -1;
 259     if (net->nc->info->type == NET_CLIENT_DRIVER_TAP) {
 260         while (file.index-- > 0) {
 261             int r = vhost_net_set_backend(&net->dev, &file);
 262             assert(r >= 0);
 263         }
 264     }
 265     if (net->nc->info->poll) {
 266         net->nc->info->poll(net->nc, true);
 267     }
 268     vhost_dev_stop(&net->dev, dev);
 269 fail_start:
 270     vhost_dev_disable_notifiers(&net->dev, dev);
 271 fail_notifiers:
 272     return r;
 273 }
 274
 275 static void vhost_net_stop_one(struct vhost_net *net,
 276                                VirtIODevice *dev)
 277 {
 278     struct vhost_vring_file file = { .fd = -1 };
 279
 280     if (net->nc->info->type == NET_CLIENT_DRIVER_TAP) {
 281         for (file.index = 0; file.index < net->dev.nvqs; ++file.index) {
 282             int r = vhost_net_set_backend(&net->dev, &file);
 283             assert(r >= 0);
 284         }
 285     }
 286     if (net->nc->info->poll) {
 287         net->nc->info->poll(net->nc, true);
 288     }
 289     vhost_dev_stop(&net->dev, dev);
 290     vhost_dev_disable_notifiers(&net->dev, dev);
 291 }
 292
 293 int vhost_net_start(VirtIODevice *dev, NetClientState *ncs,
 294                     int total_queues)
 295 {
 296     BusState *qbus = BUS(qdev_get_parent_bus(DEVICE(dev)));
 297     VirtioBusState *vbus = VIRTIO_BUS(qbus);
 298     VirtioBusClass *k = VIRTIO_BUS_GET_CLASS(vbus);
 299     int r, e, i;
 300
 301     if (!k->set_guest_notifiers) {
 302         error_report("binding does not support guest notifiers");
 303         return -ENOSYS;
 304     }
 305
 306     for (i = 0; i < total_queues; i++) {
 307         struct vhost_net *net;
 308
 309         net = get_vhost_net(ncs[i].peer);
 310         vhost_net_set_vq_index(net, i * 2);
 311
 312         /* Suppress the masking guest notifiers on vhost user
 313          * because vhost user doesn't interrupt masking/unmasking
 314          * properly.
 315          */
 316         if (net->nc->info->type == NET_CLIENT_DRIVER_VHOST_USER) {
 317             dev->use_guest_notifier_mask = false;
 318         }
 319      }
 320
 321     r = k->set_guest_notifiers(qbus->parent, total_queues * 2, true);
 322     if (r < 0) {
 323         error_report("Error binding guest notifier: %d", -r);
 324         goto err;
 325     }
 326
 327     for (i = 0; i < total_queues; i++) {
 328         r = vhost_net_start_one(get_vhost_net(ncs[i].peer), dev);
 329
 330         if (r < 0) {
 331             goto err_start;
 332         }
 333
 334         if (ncs[i].peer->vring_enable) {
 335             /* restore vring enable state */
 336             r = vhost_set_vring_enable(ncs[i].peer, ncs[i].peer->vring_enable);
 337
 338             if (r < 0) {
 339                 goto err_start;
 340             }
 341         }
 342     }
 343
 344     return 0;
 345
 346 err_start:
 347     while (--i >= 0) {
 348         vhost_net_stop_one(get_vhost_net(ncs[i].peer), dev);
 349     }
 350     e = k->set_guest_notifiers(qbus->parent, total_queues * 2, false);
 351     if (e < 0) {
 352         fprintf(stderr, "vhost guest notifier cleanup failed: %d\n", e);
 353         fflush(stderr);
 354     }
 355 err:
 356     return r;
 357 }
 358
 359 void vhost_net_stop(VirtIODevice *dev, NetClientState *ncs,
 360                     int total_queues)
 361 {
 362     BusState *qbus = BUS(qdev_get_parent_bus(DEVICE(dev)));
 363     VirtioBusState *vbus = VIRTIO_BUS(qbus);
 364     VirtioBusClass *k = VIRTIO_BUS_GET_CLASS(vbus);
 365     int i, r;
 366
 367     for (i = 0; i < total_queues; i++) {
 368         vhost_net_stop_one(get_vhost_net(ncs[i].peer), dev);
 369     }
 370
 371     r = k->set_guest_notifiers(qbus->parent, total_queues * 2, false);
 372     if (r < 0) {
 373         fprintf(stderr, "vhost guest notifier cleanup failed: %d\n", r);
 374         fflush(stderr);
 375     }
 376     assert(r >= 0);
 377 }
 378
 379 void vhost_net_cleanup(struct vhost_net *net)
 380 {
 381     vhost_dev_cleanup(&net->dev);
 382 }
 383
 384 int vhost_net_notify_migration_done(struct vhost_net *net, char* mac_addr)
 385 {
 386     const VhostOps *vhost_ops = net->dev.vhost_ops;
 387
 388     assert(vhost_ops->backend_type == VHOST_BACKEND_TYPE_USER);
 389     assert(vhost_ops->vhost_migration_done);
 390
 391     return vhost_ops->vhost_migration_done(&net->dev, mac_addr);
 392 }
 393
 394 bool vhost_net_virtqueue_pending(VHostNetState *net, int idx)
 395 {
 396     return vhost_virtqueue_pending(&net->dev, idx);
 397 }
 398
 399 void vhost_net_virtqueue_mask(VHostNetState *net, VirtIODevice *dev,
 400                               int idx, bool mask)
 401 {
 402     vhost_virtqueue_mask(&net->dev, dev, idx, mask);
 403 }
 404
 405 VHostNetState *get_vhost_net(NetClientState *nc)
 406 {
 407     VHostNetState *vhost_net = 0;
 408
 409     if (!nc) {
 410         return 0;
 411     }
 412
 413     switch (nc->info->type) {
 414     case NET_CLIENT_DRIVER_TAP:
 415         vhost_net = tap_get_vhost_net(nc);
 416         break;
 417 #ifdef CONFIG_VHOST_NET_USER
 418     case NET_CLIENT_DRIVER_VHOST_USER:
 419         vhost_net = vhost_user_get_vhost_net(nc);
 420         assert(vhost_net);
 421         break;
 422 #endif
 423     default:
 424         break;
 425     }
 426
 427     return vhost_net;
 428 }
 429
 430 int vhost_set_vring_enable(NetClientState *nc, int enable)
 431 {
 432     VHostNetState *net = get_vhost_net(nc);
 433     const VhostOps *vhost_ops = net->dev.vhost_ops;
 434
 435     nc->vring_enable = enable;
 436
 437     if (vhost_ops && vhost_ops->vhost_set_vring_enable) {
 438         return vhost_ops->vhost_set_vring_enable(&net->dev, enable);
 439     }
 440
 441     return 0;
 442 }
 443
 444 int vhost_net_set_mtu(struct vhost_net *net, uint16_t mtu)
 445 {
 446     const VhostOps *vhost_ops = net->dev.vhost_ops;
 447
 448     if (!vhost_ops->vhost_net_set_mtu) {
 449         return 0;
 450     }
 451
 452     return vhost_ops->vhost_net_set_mtu(&net->dev, mtu);
 453 }