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 "clients.h"
  12 #include "net/vhost_net.h"
  13 #include "net/vhost-user.h"
  14 #include "sysemu/char.h"
  15 #include "qemu/config-file.h"
  16 #include "qemu/error-report.h"
  17
  18 typedef struct VhostUserState {
  19     NetClientState nc;
  20     CharDriverState *chr;
  21     VHostNetState *vhost_net;
  22 } VhostUserState;
  23
  24 typedef struct VhostUserChardevProps {
  25     bool is_socket;
  26     bool is_unix;
  27     bool is_server;
  28 } VhostUserChardevProps;
  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_OPTIONS_KIND_VHOST_USER);
  34     return s->vhost_net;
  35 }
  36
  37 static int vhost_user_running(VhostUserState *s)
  38 {
  39     return (s->vhost_net) ? 1 : 0;
  40 }
  41
  42 static int vhost_user_start(VhostUserState *s)
  43 {
  44     VhostNetOptions options;
  45
  46     if (vhost_user_running(s)) {
  47         return 0;
  48     }
  49
  50     options.backend_type = VHOST_BACKEND_TYPE_USER;
  51     options.net_backend = &s->nc;
  52     options.opaque = s->chr;
  53     options.force = true;
  54
  55     s->vhost_net = vhost_net_init(&options);
  56
  57     return vhost_user_running(s) ? 0 : -1;
  58 }
  59
  60 static void vhost_user_stop(VhostUserState *s)
  61 {
  62     if (vhost_user_running(s)) {
  63         vhost_net_cleanup(s->vhost_net);
  64     }
  65
  66     s->vhost_net = 0;
  67 }
  68
  69 static void vhost_user_cleanup(NetClientState *nc)
  70 {
  71     VhostUserState *s = DO_UPCAST(VhostUserState, nc, nc);
  72
  73     vhost_user_stop(s);
  74     qemu_purge_queued_packets(nc);
  75 }
  76
  77 static bool vhost_user_has_vnet_hdr(NetClientState *nc)
  78 {
  79     assert(nc->info->type == NET_CLIENT_OPTIONS_KIND_VHOST_USER);
  80
  81     return true;
  82 }
  83
  84 static bool vhost_user_has_ufo(NetClientState *nc)
  85 {
  86     assert(nc->info->type == NET_CLIENT_OPTIONS_KIND_VHOST_USER);
  87
  88     return true;
  89 }
  90
  91 static NetClientInfo net_vhost_user_info = {
  92         .type = NET_CLIENT_OPTIONS_KIND_VHOST_USER,
  93         .size = sizeof(VhostUserState),
  94         .cleanup = vhost_user_cleanup,
  95         .has_vnet_hdr = vhost_user_has_vnet_hdr,
  96         .has_ufo = vhost_user_has_ufo,
  97 };
  98
  99 static void net_vhost_link_down(VhostUserState *s, bool link_down)
 100 {
 101     s->nc.link_down = link_down;
 102
 103     if (s->nc.peer) {
 104         s->nc.peer->link_down = link_down;
 105     }
 106
 107     if (s->nc.info->link_status_changed) {
 108         s->nc.info->link_status_changed(&s->nc);
 109     }
 110
 111     if (s->nc.peer && s->nc.peer->info->link_status_changed) {
 112         s->nc.peer->info->link_status_changed(s->nc.peer);
 113     }
 114 }
 115
 116 static void net_vhost_user_event(void *opaque, int event)
 117 {
 118     VhostUserState *s = opaque;
 119
 120     switch (event) {
 121     case CHR_EVENT_OPENED:
 122         vhost_user_start(s);
 123         net_vhost_link_down(s, false);
 124         error_report("chardev \"%s\" went up", s->nc.info_str);
 125         break;
 126     case CHR_EVENT_CLOSED:
 127         net_vhost_link_down(s, true);
 128         vhost_user_stop(s);
 129         error_report("chardev \"%s\" went down", s->nc.info_str);
 130         break;
 131     }
 132 }
 133
 134 static int net_vhost_user_init(NetClientState *peer, const char *device,
 135                                const char *name, CharDriverState *chr,
 136                                uint32_t queues)
 137 {
 138     NetClientState *nc;
 139     VhostUserState *s;
 140     int i;
 141
 142     for (i = 0; i < queues; i++) {
 143         nc = qemu_new_net_client(&net_vhost_user_info, peer, device, name);
 144
 145         snprintf(nc->info_str, sizeof(nc->info_str), "vhost-user%d to %s",
 146                  i, chr->label);
 147
 148         s = DO_UPCAST(VhostUserState, nc, nc);
 149
 150         /* We don't provide a receive callback */
 151         s->nc.receive_disabled = 1;
 152         s->chr = chr;
 153         s->nc.queue_index = i;
 154
 155         qemu_chr_add_handlers(s->chr, NULL, NULL, net_vhost_user_event, s);
 156     }
 157     return 0;
 158 }
 159
 160 static int net_vhost_chardev_opts(void *opaque,
 161                                   const char *name, const char *value,
 162                                   Error **errp)
 163 {
 164     VhostUserChardevProps *props = opaque;
 165
 166     if (strcmp(name, "backend") == 0 && strcmp(value, "socket") == 0) {
 167         props->is_socket = true;
 168     } else if (strcmp(name, "path") == 0) {
 169         props->is_unix = true;
 170     } else if (strcmp(name, "server") == 0) {
 171         props->is_server = true;
 172     } else {
 173         error_setg(errp,
 174                    "vhost-user does not support a chardev with option %s=%s",
 175                    name, value);
 176         return -1;
 177     }
 178     return 0;
 179 }
 180
 181 static CharDriverState *net_vhost_parse_chardev(
 182     const NetdevVhostUserOptions *opts, Error **errp)
 183 {
 184     CharDriverState *chr = qemu_chr_find(opts->chardev);
 185     VhostUserChardevProps props;
 186
 187     if (chr == NULL) {
 188         error_setg(errp, "chardev \"%s\" not found", opts->chardev);
 189         return NULL;
 190     }
 191
 192     /* inspect chardev opts */
 193     memset(&props, 0, sizeof(props));
 194     if (qemu_opt_foreach(chr->opts, net_vhost_chardev_opts, &props, errp)) {
 195         return NULL;
 196     }
 197
 198     if (!props.is_socket || !props.is_unix) {
 199         error_setg(errp, "chardev \"%s\" is not a unix socket",
 200                    opts->chardev);
 201         return NULL;
 202     }
 203
 204     qemu_chr_fe_claim_no_fail(chr);
 205
 206     return chr;
 207 }
 208
 209 static int net_vhost_check_net(void *opaque, QemuOpts *opts, Error **errp)
 210 {
 211     const char *name = opaque;
 212     const char *driver, *netdev;
 213     const char virtio_name[] = "virtio-net-";
 214
 215     driver = qemu_opt_get(opts, "driver");
 216     netdev = qemu_opt_get(opts, "netdev");
 217
 218     if (!driver || !netdev) {
 219         return 0;
 220     }
 221
 222     if (strcmp(netdev, name) == 0 &&
 223         strncmp(driver, virtio_name, strlen(virtio_name)) != 0) {
 224         error_setg(errp, "vhost-user requires frontend driver virtio-net-*");
 225         return -1;
 226     }
 227
 228     return 0;
 229 }
 230
 231 int net_init_vhost_user(const NetClientOptions *opts, const char *name,
 232                         NetClientState *peer, Error **errp)
 233 {
 234     uint32_t queues;
 235     const NetdevVhostUserOptions *vhost_user_opts;
 236     CharDriverState *chr;
 237
 238     assert(opts->kind == NET_CLIENT_OPTIONS_KIND_VHOST_USER);
 239     vhost_user_opts = opts->vhost_user;
 240
 241     chr = net_vhost_parse_chardev(vhost_user_opts, errp);
 242     if (!chr) {
 243         return -1;
 244     }
 245
 246     /* verify net frontend */
 247     if (qemu_opts_foreach(qemu_find_opts("device"), net_vhost_check_net,
 248                           (char *)name, errp)) {
 249         return -1;
 250     }
 251
 252     /* number of queues for multiqueue */
 253     if (vhost_user_opts->has_queues) {
 254         queues = vhost_user_opts->queues;
 255     } else {
 256         queues = 1;
 257     }
 258
 259     return net_vhost_user_init(peer, "vhost_user", name, chr, queues);
 260 }