net/vhost-user.c

   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
  21 typedef struct VhostUserState {
  22     NetClientState nc;
  23     CharBackend chr;
  24     VHostNetState *vhost_net;
  25     guint watch;
  26     uint64_t acked_features;
  27     bool started;
  28 } VhostUserState;
  29
  30 VHostNetState *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
  37 uint64_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
  44 static 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
  65 static int vhost_user_start(int queues, NetClientState *ncs[])
  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      = s->chr.chr;
  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
 107 err:
 108     if (net) {
 109         vhost_net_cleanup(net);
 110     }
 111     vhost_user_stop(i, ncs);
 112     return -1;
 113 }
 114
 115 static 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
 144 static 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 (s->chr.chr) {
 154         qemu_chr_add_handlers(s->chr.chr, NULL, NULL, NULL, NULL);
 155         qemu_chr_fe_release(s->chr.chr);
 156         s->chr.chr = NULL;
 157     }
 158
 159     qemu_purge_queued_packets(nc);
 160 }
 161
 162 static bool vhost_user_has_vnet_hdr(NetClientState *nc)
 163 {
 164     assert(nc->info->type == NET_CLIENT_DRIVER_VHOST_USER);
 165
 166     return true;
 167 }
 168
 169 static bool vhost_user_has_ufo(NetClientState *nc)
 170 {
 171     assert(nc->info->type == NET_CLIENT_DRIVER_VHOST_USER);
 172
 173     return true;
 174 }
 175
 176 static NetClientInfo net_vhost_user_info = {
 177         .type = NET_CLIENT_DRIVER_VHOST_USER,
 178         .size = sizeof(VhostUserState),
 179         .receive = vhost_user_receive,
 180         .cleanup = vhost_user_cleanup,
 181         .has_vnet_hdr = vhost_user_has_vnet_hdr,
 182         .has_ufo = vhost_user_has_ufo,
 183 };
 184
 185 static gboolean net_vhost_user_watch(GIOChannel *chan, GIOCondition cond,
 186                                            void *opaque)
 187 {
 188     VhostUserState *s = opaque;
 189
 190     qemu_chr_disconnect(s->chr.chr);
 191
 192     return FALSE;
 193 }
 194
 195 static void net_vhost_user_event(void *opaque, int event)
 196 {
 197     const char *name = opaque;
 198     NetClientState *ncs[MAX_QUEUE_NUM];
 199     VhostUserState *s;
 200     Error *err = NULL;
 201     int queues;
 202
 203     queues = qemu_find_net_clients_except(name, ncs,
 204                                           NET_CLIENT_DRIVER_NIC,
 205                                           MAX_QUEUE_NUM);
 206     assert(queues < MAX_QUEUE_NUM);
 207
 208     s = DO_UPCAST(VhostUserState, nc, ncs[0]);
 209     trace_vhost_user_event(s->chr.chr->label, event);
 210     switch (event) {
 211     case CHR_EVENT_OPENED:
 212         s->watch = qemu_chr_fe_add_watch(s->chr.chr, G_IO_HUP,
 213                                          net_vhost_user_watch, s);
 214         if (vhost_user_start(queues, ncs) < 0) {
 215             qemu_chr_disconnect(s->chr.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
 234 static 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         if (!nc0) {
 249             nc0 = nc;
 250         }
 251
 252         snprintf(nc->info_str, sizeof(nc->info_str), "vhost-user%d to %s",
 253                  i, chr->label);
 254
 255         nc->queue_index = i;
 256
 257         s = DO_UPCAST(VhostUserState, nc, nc);
 258         if (!qemu_chr_fe_init(&s->chr, chr, &err)) {
 259             error_report_err(err);
 260             return -1;
 261         }
 262     }
 263
 264     s = DO_UPCAST(VhostUserState, nc, nc0);
 265     do {
 266         if (qemu_chr_wait_connected(chr, &err) < 0) {
 267             error_report_err(err);
 268             return -1;
 269         }
 270         qemu_chr_add_handlers(chr, NULL, NULL,
 271                               net_vhost_user_event, nc0->name);
 272     } while (!s->started);
 273
 274     assert(s->vhost_net);
 275
 276     return 0;
 277 }
 278
 279 static CharDriverState *net_vhost_claim_chardev(
 280     const NetdevVhostUserOptions *opts, Error **errp)
 281 {
 282     CharDriverState *chr = qemu_chr_find(opts->chardev);
 283
 284     if (chr == NULL) {
 285         error_setg(errp, "chardev \"%s\" not found", opts->chardev);
 286         return NULL;
 287     }
 288
 289     if (!qemu_chr_has_feature(chr, QEMU_CHAR_FEATURE_RECONNECTABLE)) {
 290         error_setg(errp, "chardev \"%s\" is not reconnectable",
 291                    opts->chardev);
 292         return NULL;
 293     }
 294     if (!qemu_chr_has_feature(chr, QEMU_CHAR_FEATURE_FD_PASS)) {
 295         error_setg(errp, "chardev \"%s\" does not support FD passing",
 296                    opts->chardev);
 297         return NULL;
 298     }
 299
 300     qemu_chr_fe_claim_no_fail(chr);
 301
 302     return chr;
 303 }
 304
 305 static int net_vhost_check_net(void *opaque, QemuOpts *opts, Error **errp)
 306 {
 307     const char *name = opaque;
 308     const char *driver, *netdev;
 309
 310     driver = qemu_opt_get(opts, "driver");
 311     netdev = qemu_opt_get(opts, "netdev");
 312
 313     if (!driver || !netdev) {
 314         return 0;
 315     }
 316
 317     if (strcmp(netdev, name) == 0 &&
 318         !g_str_has_prefix(driver, "virtio-net-")) {
 319         error_setg(errp, "vhost-user requires frontend driver virtio-net-*");
 320         return -1;
 321     }
 322
 323     return 0;
 324 }
 325
 326 int net_init_vhost_user(const Netdev *netdev, const char *name,
 327                         NetClientState *peer, Error **errp)
 328 {
 329     int queues;
 330     const NetdevVhostUserOptions *vhost_user_opts;
 331     CharDriverState *chr;
 332
 333     assert(netdev->type == NET_CLIENT_DRIVER_VHOST_USER);
 334     vhost_user_opts = &netdev->u.vhost_user;
 335
 336     chr = net_vhost_claim_chardev(vhost_user_opts, errp);
 337     if (!chr) {
 338         return -1;
 339     }
 340
 341     /* verify net frontend */
 342     if (qemu_opts_foreach(qemu_find_opts("device"), net_vhost_check_net,
 343                           (char *)name, errp)) {
 344         return -1;
 345     }
 346
 347     queues = vhost_user_opts->has_queues ? vhost_user_opts->queues : 1;
 348     if (queues < 1 || queues > MAX_QUEUE_NUM) {
 349         error_setg(errp,
 350                    "vhost-user number of queues must be in range [1, %d]",
 351                    MAX_QUEUE_NUM);
 352         return -1;
 353     }
 354
 355     return net_vhost_user_init(peer, "vhost_user", name, chr, queues);
 356 }