qemu/net/vhost-user.c
<<
>>
Prefs
   1/*
   2 * vhost-user.c
   3 *
   4 * Copyright (c) 2013 Virtual Open Systems Sarl.
   5 *
   6 * This work is licensed under the terms of the GNU GPL, version 2 or later.
   7 * See the COPYING file in the top-level directory.
   8 *
   9 */
  10
  11#include "qemu/osdep.h"
  12#include "clients.h"
  13#include "net/vhost_net.h"
  14#include "net/vhost-user.h"
  15#include "sysemu/char.h"
  16#include "qemu/config-file.h"
  17#include "qemu/error-report.h"
  18#include "qmp-commands.h"
  19#include "trace.h"
  20
  21typedef struct VhostUserState {
  22    NetClientState nc;
  23    CharBackend chr; /* only queue index 0 */
  24    VHostNetState *vhost_net;
  25    guint watch;
  26    uint64_t acked_features;
  27    bool started;
  28} VhostUserState;
  29
  30VHostNetState *vhost_user_get_vhost_net(NetClientState *nc)
  31{
  32    VhostUserState *s = DO_UPCAST(VhostUserState, nc, nc);
  33    assert(nc->info->type == NET_CLIENT_DRIVER_VHOST_USER);
  34    return s->vhost_net;
  35}
  36
  37uint64_t vhost_user_get_acked_features(NetClientState *nc)
  38{
  39    VhostUserState *s = DO_UPCAST(VhostUserState, nc, nc);
  40    assert(nc->info->type == NET_CLIENT_DRIVER_VHOST_USER);
  41    return s->acked_features;
  42}
  43
  44static void vhost_user_stop(int queues, NetClientState *ncs[])
  45{
  46    VhostUserState *s;
  47    int i;
  48
  49    for (i = 0; i < queues; i++) {
  50        assert(ncs[i]->info->type == NET_CLIENT_DRIVER_VHOST_USER);
  51
  52        s = DO_UPCAST(VhostUserState, nc, ncs[i]);
  53
  54        if (s->vhost_net) {
  55            /* save acked features */
  56            uint64_t features = vhost_net_get_acked_features(s->vhost_net);
  57            if (features) {
  58                s->acked_features = features;
  59            }
  60            vhost_net_cleanup(s->vhost_net);
  61        }
  62    }
  63}
  64
  65static int vhost_user_start(int queues, NetClientState *ncs[], CharBackend *be)
  66{
  67    VhostNetOptions options;
  68    struct vhost_net *net = NULL;
  69    VhostUserState *s;
  70    int max_queues;
  71    int i;
  72
  73    options.backend_type = VHOST_BACKEND_TYPE_USER;
  74
  75    for (i = 0; i < queues; i++) {
  76        assert(ncs[i]->info->type == NET_CLIENT_DRIVER_VHOST_USER);
  77
  78        s = DO_UPCAST(VhostUserState, nc, ncs[i]);
  79
  80        options.net_backend = ncs[i];
  81        options.opaque      = be;
  82        options.busyloop_timeout = 0;
  83        net = vhost_net_init(&options);
  84        if (!net) {
  85            error_report("failed to init vhost_net for queue %d", i);
  86            goto err;
  87        }
  88
  89        if (i == 0) {
  90            max_queues = vhost_net_get_max_queues(net);
  91            if (queues > max_queues) {
  92                error_report("you are asking more queues than supported: %d",
  93                             max_queues);
  94                goto err;
  95            }
  96        }
  97
  98        if (s->vhost_net) {
  99            vhost_net_cleanup(s->vhost_net);
 100            g_free(s->vhost_net);
 101        }
 102        s->vhost_net = net;
 103    }
 104
 105    return 0;
 106
 107err:
 108    if (net) {
 109        vhost_net_cleanup(net);
 110    }
 111    vhost_user_stop(i, ncs);
 112    return -1;
 113}
 114
 115static ssize_t vhost_user_receive(NetClientState *nc, const uint8_t *buf,
 116                                  size_t size)
 117{
 118    /* In case of RARP (message size is 60) notify backup to send a fake RARP.
 119       This fake RARP will be sent by backend only for guest
 120       without GUEST_ANNOUNCE capability.
 121     */
 122    if (size == 60) {
 123        VhostUserState *s = DO_UPCAST(VhostUserState, nc, nc);
 124        int r;
 125        static int display_rarp_failure = 1;
 126        char mac_addr[6];
 127
 128        /* extract guest mac address from the RARP message */
 129        memcpy(mac_addr, &buf[6], 6);
 130
 131        r = vhost_net_notify_migration_done(s->vhost_net, mac_addr);
 132
 133        if ((r != 0) && (display_rarp_failure)) {
 134            fprintf(stderr,
 135                    "Vhost user backend fails to broadcast fake RARP\n");
 136            fflush(stderr);
 137            display_rarp_failure = 0;
 138        }
 139    }
 140
 141    return size;
 142}
 143
 144static void vhost_user_cleanup(NetClientState *nc)
 145{
 146    VhostUserState *s = DO_UPCAST(VhostUserState, nc, nc);
 147
 148    if (s->vhost_net) {
 149        vhost_net_cleanup(s->vhost_net);
 150        g_free(s->vhost_net);
 151        s->vhost_net = NULL;
 152    }
 153    if (nc->queue_index == 0) {
 154        qemu_chr_fe_deinit(&s->chr);
 155    }
 156
 157    qemu_purge_queued_packets(nc);
 158}
 159
 160static bool vhost_user_has_vnet_hdr(NetClientState *nc)
 161{
 162    assert(nc->info->type == NET_CLIENT_DRIVER_VHOST_USER);
 163
 164    return true;
 165}
 166
 167static bool vhost_user_has_ufo(NetClientState *nc)
 168{
 169    assert(nc->info->type == NET_CLIENT_DRIVER_VHOST_USER);
 170
 171    return true;
 172}
 173
 174static NetClientInfo net_vhost_user_info = {
 175        .type = NET_CLIENT_DRIVER_VHOST_USER,
 176        .size = sizeof(VhostUserState),
 177        .receive = vhost_user_receive,
 178        .cleanup = vhost_user_cleanup,
 179        .has_vnet_hdr = vhost_user_has_vnet_hdr,
 180        .has_ufo = vhost_user_has_ufo,
 181};
 182
 183static gboolean net_vhost_user_watch(GIOChannel *chan, GIOCondition cond,
 184                                           void *opaque)
 185{
 186    VhostUserState *s = opaque;
 187
 188    qemu_chr_fe_disconnect(&s->chr);
 189
 190    return FALSE;
 191}
 192
 193static void net_vhost_user_event(void *opaque, int event)
 194{
 195    const char *name = opaque;
 196    NetClientState *ncs[MAX_QUEUE_NUM];
 197    VhostUserState *s;
 198    CharDriverState *chr;
 199    Error *err = NULL;
 200    int queues;
 201
 202    queues = qemu_find_net_clients_except(name, ncs,
 203                                          NET_CLIENT_DRIVER_NIC,
 204                                          MAX_QUEUE_NUM);
 205    assert(queues < MAX_QUEUE_NUM);
 206
 207    s = DO_UPCAST(VhostUserState, nc, ncs[0]);
 208    chr = qemu_chr_fe_get_driver(&s->chr);
 209    trace_vhost_user_event(chr->label, event);
 210    switch (event) {
 211    case CHR_EVENT_OPENED:
 212        s->watch = qemu_chr_fe_add_watch(&s->chr, G_IO_HUP,
 213                                         net_vhost_user_watch, s);
 214        if (vhost_user_start(queues, ncs, &s->chr) < 0) {
 215            qemu_chr_fe_disconnect(&s->chr);
 216            return;
 217        }
 218        qmp_set_link(name, true, &err);
 219        s->started = true;
 220        break;
 221    case CHR_EVENT_CLOSED:
 222        qmp_set_link(name, false, &err);
 223        vhost_user_stop(queues, ncs);
 224        g_source_remove(s->watch);
 225        s->watch = 0;
 226        break;
 227    }
 228
 229    if (err) {
 230        error_report_err(err);
 231    }
 232}
 233
 234static int net_vhost_user_init(NetClientState *peer, const char *device,
 235                               const char *name, CharDriverState *chr,
 236                               int queues)
 237{
 238    Error *err = NULL;
 239    NetClientState *nc, *nc0 = NULL;
 240    VhostUserState *s;
 241    int i;
 242
 243    assert(name);
 244    assert(queues > 0);
 245
 246    for (i = 0; i < queues; i++) {
 247        nc = qemu_new_net_client(&net_vhost_user_info, peer, device, name);
 248        snprintf(nc->info_str, sizeof(nc->info_str), "vhost-user%d to %s",
 249                 i, chr->label);
 250        nc->queue_index = i;
 251        if (!nc0) {
 252            nc0 = nc;
 253            s = DO_UPCAST(VhostUserState, nc, nc);
 254            if (!qemu_chr_fe_init(&s->chr, chr, &err)) {
 255                error_report_err(err);
 256                return -1;
 257            }
 258        }
 259
 260    }
 261
 262    s = DO_UPCAST(VhostUserState, nc, nc0);
 263    do {
 264        if (qemu_chr_fe_wait_connected(&s->chr, &err) < 0) {
 265            error_report_err(err);
 266            return -1;
 267        }
 268        qemu_chr_fe_set_handlers(&s->chr, NULL, NULL,
 269                                 net_vhost_user_event, nc0->name, NULL, true);
 270    } while (!s->started);
 271
 272    assert(s->vhost_net);
 273
 274    return 0;
 275}
 276
 277static CharDriverState *net_vhost_claim_chardev(
 278    const NetdevVhostUserOptions *opts, Error **errp)
 279{
 280    CharDriverState *chr = qemu_chr_find(opts->chardev);
 281
 282    if (chr == NULL) {
 283        error_setg(errp, "chardev \"%s\" not found", opts->chardev);
 284        return NULL;
 285    }
 286
 287    if (!qemu_chr_has_feature(chr, QEMU_CHAR_FEATURE_RECONNECTABLE)) {
 288        error_setg(errp, "chardev \"%s\" is not reconnectable",
 289                   opts->chardev);
 290        return NULL;
 291    }
 292    if (!qemu_chr_has_feature(chr, QEMU_CHAR_FEATURE_FD_PASS)) {
 293        error_setg(errp, "chardev \"%s\" does not support FD passing",
 294                   opts->chardev);
 295        return NULL;
 296    }
 297
 298    return chr;
 299}
 300
 301static int net_vhost_check_net(void *opaque, QemuOpts *opts, Error **errp)
 302{
 303    const char *name = opaque;
 304    const char *driver, *netdev;
 305
 306    driver = qemu_opt_get(opts, "driver");
 307    netdev = qemu_opt_get(opts, "netdev");
 308
 309    if (!driver || !netdev) {
 310        return 0;
 311    }
 312
 313    if (strcmp(netdev, name) == 0 &&
 314        !g_str_has_prefix(driver, "virtio-net-")) {
 315        error_setg(errp, "vhost-user requires frontend driver virtio-net-*");
 316        return -1;
 317    }
 318
 319    return 0;
 320}
 321
 322int net_init_vhost_user(const Netdev *netdev, const char *name,
 323                        NetClientState *peer, Error **errp)
 324{
 325    int queues;
 326    const NetdevVhostUserOptions *vhost_user_opts;
 327    CharDriverState *chr;
 328
 329    assert(netdev->type == NET_CLIENT_DRIVER_VHOST_USER);
 330    vhost_user_opts = &netdev->u.vhost_user;
 331
 332    chr = net_vhost_claim_chardev(vhost_user_opts, errp);
 333    if (!chr) {
 334        return -1;
 335    }
 336
 337    /* verify net frontend */
 338    if (qemu_opts_foreach(qemu_find_opts("device"), net_vhost_check_net,
 339                          (char *)name, errp)) {
 340        return -1;
 341    }
 342
 343    queues = vhost_user_opts->has_queues ? vhost_user_opts->queues : 1;
 344    if (queues < 1 || queues > MAX_QUEUE_NUM) {
 345        error_setg(errp,
 346                   "vhost-user number of queues must be in range [1, %d]",
 347                   MAX_QUEUE_NUM);
 348        return -1;
 349    }
 350
 351    return net_vhost_user_init(peer, "vhost_user", name, chr, queues);
 352}
 353