hw/char/virtio-serial-bus.c

   1 /*
   2  * A bus for connecting virtio serial and console ports
   3  *
   4  * Copyright (C) 2009, 2010 Red Hat, Inc.
   5  *
   6  * Author(s):
   7  *  Amit Shah <[email protected]>
   8  *
   9  * Some earlier parts are:
  10  *  Copyright IBM, Corp. 2008
  11  * authored by
  12  *  Christian Ehrhardt <[email protected]>
  13  *
  14  * This work is licensed under the terms of the GNU GPL, version 2.  See
  15  * the COPYING file in the top-level directory.
  16  *
  17  * Contributions after 2012-01-13 are licensed under the terms of the
  18  * GNU GPL, version 2 or (at your option) any later version.
  19  */
  20
  21 #include "qemu/iov.h"
  22 #include "monitor/monitor.h"
  23 #include "qemu/queue.h"
  24 #include "hw/sysbus.h"
  25 #include "trace.h"
  26 #include "hw/virtio/virtio-serial.h"
  27
  28 static VirtIOSerialPort *find_port_by_id(VirtIOSerial *vser, uint32_t id)
  29 {
  30     VirtIOSerialPort *port;
  31
  32     if (id == VIRTIO_CONSOLE_BAD_ID) {
  33         return NULL;
  34     }
  35
  36     QTAILQ_FOREACH(port, &vser->ports, next) {
  37         if (port->id == id)
  38             return port;
  39     }
  40     return NULL;
  41 }
  42
  43 static VirtIOSerialPort *find_port_by_vq(VirtIOSerial *vser, VirtQueue *vq)
  44 {
  45     VirtIOSerialPort *port;
  46
  47     QTAILQ_FOREACH(port, &vser->ports, next) {
  48         if (port->ivq == vq || port->ovq == vq)
  49             return port;
  50     }
  51     return NULL;
  52 }
  53
  54 static bool use_multiport(VirtIOSerial *vser)
  55 {
  56     VirtIODevice *vdev = VIRTIO_DEVICE(vser);
  57     return vdev->guest_features & (1 << VIRTIO_CONSOLE_F_MULTIPORT);
  58 }
  59
  60 static size_t write_to_port(VirtIOSerialPort *port,
  61                             const uint8_t *buf, size_t size)
  62 {
  63     VirtQueueElement elem;
  64     VirtQueue *vq;
  65     size_t offset;
  66
  67     vq = port->ivq;
  68     if (!virtio_queue_ready(vq)) {
  69         return 0;
  70     }
  71
  72     offset = 0;
  73     while (offset < size) {
  74         size_t len;
  75
  76         if (!virtqueue_pop(vq, &elem)) {
  77             break;
  78         }
  79
  80         len = iov_from_buf(elem.in_sg, elem.in_num, 0,
  81                            buf + offset, size - offset);
  82         offset += len;
  83
  84         virtqueue_push(vq, &elem, len);
  85     }
  86
  87     virtio_notify(VIRTIO_DEVICE(port->vser), vq);
  88     return offset;
  89 }
  90
  91 static void discard_vq_data(VirtQueue *vq, VirtIODevice *vdev)
  92 {
  93     VirtQueueElement elem;
  94
  95     if (!virtio_queue_ready(vq)) {
  96         return;
  97     }
  98     while (virtqueue_pop(vq, &elem)) {
  99         virtqueue_push(vq, &elem, 0);
 100     }
 101     virtio_notify(vdev, vq);
 102 }
 103
 104 static void do_flush_queued_data(VirtIOSerialPort *port, VirtQueue *vq,
 105                                  VirtIODevice *vdev)
 106 {
 107     VirtIOSerialPortClass *vsc;
 108
 109     assert(port);
 110     assert(virtio_queue_ready(vq));
 111
 112     vsc = VIRTIO_SERIAL_PORT_GET_CLASS(port);
 113
 114     while (!port->throttled) {
 115         unsigned int i;
 116
 117         /* Pop an elem only if we haven't left off a previous one mid-way */
 118         if (!port->elem.out_num) {
 119             if (!virtqueue_pop(vq, &port->elem)) {
 120                 break;
 121             }
 122             port->iov_idx = 0;
 123             port->iov_offset = 0;
 124         }
 125
 126         for (i = port->iov_idx; i < port->elem.out_num; i++) {
 127             size_t buf_size;
 128             ssize_t ret;
 129
 130             buf_size = port->elem.out_sg[i].iov_len - port->iov_offset;
 131             ret = vsc->have_data(port,
 132                                   port->elem.out_sg[i].iov_base
 133                                   + port->iov_offset,
 134                                   buf_size);
 135             if (port->throttled) {
 136                 port->iov_idx = i;
 137                 if (ret > 0) {
 138                     port->iov_offset += ret;
 139                 }
 140                 break;
 141             }
 142             port->iov_offset = 0;
 143         }
 144         if (port->throttled) {
 145             break;
 146         }
 147         virtqueue_push(vq, &port->elem, 0);
 148         port->elem.out_num = 0;
 149     }
 150     virtio_notify(vdev, vq);
 151 }
 152
 153 static void flush_queued_data(VirtIOSerialPort *port)
 154 {
 155     assert(port);
 156
 157     if (!virtio_queue_ready(port->ovq)) {
 158         return;
 159     }
 160     do_flush_queued_data(port, port->ovq, VIRTIO_DEVICE(port->vser));
 161 }
 162
 163 static size_t send_control_msg(VirtIOSerial *vser, void *buf, size_t len)
 164 {
 165     VirtQueueElement elem;
 166     VirtQueue *vq;
 167
 168     vq = vser->c_ivq;
 169     if (!virtio_queue_ready(vq)) {
 170         return 0;
 171     }
 172     if (!virtqueue_pop(vq, &elem)) {
 173         return 0;
 174     }
 175
 176     memcpy(elem.in_sg[0].iov_base, buf, len);
 177
 178     virtqueue_push(vq, &elem, len);
 179     virtio_notify(VIRTIO_DEVICE(vser), vq);
 180     return len;
 181 }
 182
 183 static size_t send_control_event(VirtIOSerial *vser, uint32_t port_id,
 184                                  uint16_t event, uint16_t value)
 185 {
 186     struct virtio_console_control cpkt;
 187
 188     stl_p(&cpkt.id, port_id);
 189     stw_p(&cpkt.event, event);
 190     stw_p(&cpkt.value, value);
 191
 192     trace_virtio_serial_send_control_event(port_id, event, value);
 193     return send_control_msg(vser, &cpkt, sizeof(cpkt));
 194 }
 195
 196 /* Functions for use inside qemu to open and read from/write to ports */
 197 int virtio_serial_open(VirtIOSerialPort *port)
 198 {
 199     /* Don't allow opening an already-open port */
 200     if (port->host_connected) {
 201         return 0;
 202     }
 203     /* Send port open notification to the guest */
 204     port->host_connected = true;
 205     send_control_event(port->vser, port->id, VIRTIO_CONSOLE_PORT_OPEN, 1);
 206
 207     return 0;
 208 }
 209
 210 int virtio_serial_close(VirtIOSerialPort *port)
 211 {
 212     port->host_connected = false;
 213     /*
 214      * If there's any data the guest sent which the app didn't
 215      * consume, reset the throttling flag and discard the data.
 216      */
 217     port->throttled = false;
 218     discard_vq_data(port->ovq, VIRTIO_DEVICE(port->vser));
 219
 220     send_control_event(port->vser, port->id, VIRTIO_CONSOLE_PORT_OPEN, 0);
 221
 222     return 0;
 223 }
 224
 225 /* Individual ports/apps call this function to write to the guest. */
 226 ssize_t virtio_serial_write(VirtIOSerialPort *port, const uint8_t *buf,
 227                             size_t size)
 228 {
 229     if (!port || !port->host_connected || !port->guest_connected) {
 230         return 0;
 231     }
 232     return write_to_port(port, buf, size);
 233 }
 234
 235 /*
 236  * Readiness of the guest to accept data on a port.
 237  * Returns max. data the guest can receive
 238  */
 239 size_t virtio_serial_guest_ready(VirtIOSerialPort *port)
 240 {
 241     VirtIODevice *vdev = VIRTIO_DEVICE(port->vser);
 242     VirtQueue *vq = port->ivq;
 243     unsigned int bytes;
 244
 245     if (!virtio_queue_ready(vq) ||
 246         !(vdev->status & VIRTIO_CONFIG_S_DRIVER_OK) ||
 247         virtio_queue_empty(vq)) {
 248         return 0;
 249     }
 250     if (use_multiport(port->vser) && !port->guest_connected) {
 251         return 0;
 252     }
 253     virtqueue_get_avail_bytes(vq, &bytes, NULL, 4096, 0);
 254     return bytes;
 255 }
 256
 257 static void flush_queued_data_bh(void *opaque)
 258 {
 259     VirtIOSerialPort *port = opaque;
 260
 261     flush_queued_data(port);
 262 }
 263
 264 void virtio_serial_throttle_port(VirtIOSerialPort *port, bool throttle)
 265 {
 266     if (!port) {
 267         return;
 268     }
 269
 270     trace_virtio_serial_throttle_port(port->id, throttle);
 271     port->throttled = throttle;
 272     if (throttle) {
 273         return;
 274     }
 275     qemu_bh_schedule(port->bh);
 276 }
 277
 278 /* Guest wants to notify us of some event */
 279 static void handle_control_message(VirtIOSerial *vser, void *buf, size_t len)
 280 {
 281     struct VirtIOSerialPort *port;
 282     VirtIOSerialPortClass *vsc;
 283     struct virtio_console_control cpkt, *gcpkt;
 284     uint8_t *buffer;
 285     size_t buffer_len;
 286
 287     gcpkt = buf;
 288
 289     if (len < sizeof(cpkt)) {
 290         /* The guest sent an invalid control packet */
 291         return;
 292     }
 293
 294     cpkt.event = lduw_p(&gcpkt->event);
 295     cpkt.value = lduw_p(&gcpkt->value);
 296
 297     trace_virtio_serial_handle_control_message(cpkt.event, cpkt.value);
 298
 299     if (cpkt.event == VIRTIO_CONSOLE_DEVICE_READY) {
 300         if (!cpkt.value) {
 301             error_report("virtio-serial-bus: Guest failure in adding device %s",
 302                          vser->bus.qbus.name);
 303             return;
 304         }
 305         /*
 306          * The device is up, we can now tell the device about all the
 307          * ports we have here.
 308          */
 309         QTAILQ_FOREACH(port, &vser->ports, next) {
 310             send_control_event(vser, port->id, VIRTIO_CONSOLE_PORT_ADD, 1);
 311         }
 312         return;
 313     }
 314
 315     port = find_port_by_id(vser, ldl_p(&gcpkt->id));
 316     if (!port) {
 317         error_report("virtio-serial-bus: Unexpected port id %u for device %s",
 318                      ldl_p(&gcpkt->id), vser->bus.qbus.name);
 319         return;
 320     }
 321
 322     trace_virtio_serial_handle_control_message_port(port->id);
 323
 324     vsc = VIRTIO_SERIAL_PORT_GET_CLASS(port);
 325
 326     switch(cpkt.event) {
 327     case VIRTIO_CONSOLE_PORT_READY:
 328         if (!cpkt.value) {
 329             error_report("virtio-serial-bus: Guest failure in adding port %u for device %s",
 330                          port->id, vser->bus.qbus.name);
 331             break;
 332         }
 333         /*
 334          * Now that we know the guest asked for the port name, we're
 335          * sure the guest has initialised whatever state is necessary
 336          * for this port. Now's a good time to let the guest know if
 337          * this port is a console port so that the guest can hook it
 338          * up to hvc.
 339          */
 340         if (vsc->is_console) {
 341             send_control_event(vser, port->id, VIRTIO_CONSOLE_CONSOLE_PORT, 1);
 342         }
 343
 344         if (port->name) {
 345             stl_p(&cpkt.id, port->id);
 346             stw_p(&cpkt.event, VIRTIO_CONSOLE_PORT_NAME);
 347             stw_p(&cpkt.value, 1);
 348
 349             buffer_len = sizeof(cpkt) + strlen(port->name) + 1;
 350             buffer = g_malloc(buffer_len);
 351
 352             memcpy(buffer, &cpkt, sizeof(cpkt));
 353             memcpy(buffer + sizeof(cpkt), port->name, strlen(port->name));
 354             buffer[buffer_len - 1] = 0;
 355
 356             send_control_msg(vser, buffer, buffer_len);
 357             g_free(buffer);
 358         }
 359
 360         if (port->host_connected) {
 361             send_control_event(vser, port->id, VIRTIO_CONSOLE_PORT_OPEN, 1);
 362         }
 363
 364         /*
 365          * When the guest has asked us for this information it means
 366          * the guest is all setup and has its virtqueues
 367          * initialised. If some app is interested in knowing about
 368          * this event, let it know.
 369          */
 370         if (vsc->guest_ready) {
 371             vsc->guest_ready(port);
 372         }
 373         break;
 374
 375     case VIRTIO_CONSOLE_PORT_OPEN:
 376         port->guest_connected = cpkt.value;
 377         if (vsc->set_guest_connected) {
 378             /* Send the guest opened notification if an app is interested */
 379             vsc->set_guest_connected(port, cpkt.value);
 380         }
 381         break;
 382     }
 383 }
 384
 385 static void control_in(VirtIODevice *vdev, VirtQueue *vq)
 386 {
 387 }
 388
 389 static void control_out(VirtIODevice *vdev, VirtQueue *vq)
 390 {
 391     VirtQueueElement elem;
 392     VirtIOSerial *vser;
 393     uint8_t *buf;
 394     size_t len;
 395
 396     vser = VIRTIO_SERIAL(vdev);
 397
 398     len = 0;
 399     buf = NULL;
 400     while (virtqueue_pop(vq, &elem)) {
 401         size_t cur_len;
 402
 403         cur_len = iov_size(elem.out_sg, elem.out_num);
 404         /*
 405          * Allocate a new buf only if we didn't have one previously or
 406          * if the size of the buf differs
 407          */
 408         if (cur_len > len) {
 409             g_free(buf);
 410
 411             buf = g_malloc(cur_len);
 412             len = cur_len;
 413         }
 414         iov_to_buf(elem.out_sg, elem.out_num, 0, buf, cur_len);
 415
 416         handle_control_message(vser, buf, cur_len);
 417         virtqueue_push(vq, &elem, 0);
 418     }
 419     g_free(buf);
 420     virtio_notify(vdev, vq);
 421 }
 422
 423 /* Guest wrote something to some port. */
 424 static void handle_output(VirtIODevice *vdev, VirtQueue *vq)
 425 {
 426     VirtIOSerial *vser;
 427     VirtIOSerialPort *port;
 428
 429     vser = VIRTIO_SERIAL(vdev);
 430     port = find_port_by_vq(vser, vq);
 431
 432     if (!port || !port->host_connected) {
 433         discard_vq_data(vq, vdev);
 434         return;
 435     }
 436
 437     if (!port->throttled) {
 438         do_flush_queued_data(port, vq, vdev);
 439         return;
 440     }
 441 }
 442
 443 static void handle_input(VirtIODevice *vdev, VirtQueue *vq)
 444 {
 445 }
 446
 447 static uint32_t get_features(VirtIODevice *vdev, uint32_t features)
 448 {
 449     VirtIOSerial *vser;
 450
 451     vser = VIRTIO_SERIAL(vdev);
 452
 453     if (vser->bus.max_nr_ports > 1) {
 454         features |= (1 << VIRTIO_CONSOLE_F_MULTIPORT);
 455     }
 456     return features;
 457 }
 458
 459 /* Guest requested config info */
 460 static void get_config(VirtIODevice *vdev, uint8_t *config_data)
 461 {
 462     VirtIOSerial *vser;
 463
 464     vser = VIRTIO_SERIAL(vdev);
 465     memcpy(config_data, &vser->config, sizeof(struct virtio_console_config));
 466 }
 467
 468 static void guest_reset(VirtIOSerial *vser)
 469 {
 470     VirtIOSerialPort *port;
 471     VirtIOSerialPortClass *vsc;
 472
 473     QTAILQ_FOREACH(port, &vser->ports, next) {
 474         vsc = VIRTIO_SERIAL_PORT_GET_CLASS(port);
 475         if (port->guest_connected) {
 476             port->guest_connected = false;
 477             if (vsc->set_guest_connected) {
 478                 vsc->set_guest_connected(port, false);
 479             }
 480         }
 481     }
 482 }
 483
 484 static void set_status(VirtIODevice *vdev, uint8_t status)
 485 {
 486     VirtIOSerial *vser;
 487     VirtIOSerialPort *port;
 488
 489     vser = VIRTIO_SERIAL(vdev);
 490     port = find_port_by_id(vser, 0);
 491
 492     if (port && !use_multiport(port->vser)
 493         && (status & VIRTIO_CONFIG_S_DRIVER_OK)) {
 494         /*
 495          * Non-multiport guests won't be able to tell us guest
 496          * open/close status.  Such guests can only have a port at id
 497          * 0, so set guest_connected for such ports as soon as guest
 498          * is up.
 499          */
 500         port->guest_connected = true;
 501     }
 502     if (!(status & VIRTIO_CONFIG_S_DRIVER_OK)) {
 503         guest_reset(vser);
 504     }
 505 }
 506
 507 static void vser_reset(VirtIODevice *vdev)
 508 {
 509     VirtIOSerial *vser;
 510
 511     vser = VIRTIO_SERIAL(vdev);
 512     guest_reset(vser);
 513 }
 514
 515 static void virtio_serial_save(QEMUFile *f, void *opaque)
 516 {
 517     /* The virtio device */
 518     virtio_save(VIRTIO_DEVICE(opaque), f);
 519 }
 520
 521 static void virtio_serial_save_device(VirtIODevice *vdev, QEMUFile *f)
 522 {
 523     VirtIOSerial *s = VIRTIO_SERIAL(vdev);
 524     VirtIOSerialPort *port;
 525     uint32_t nr_active_ports;
 526     unsigned int i, max_nr_ports;
 527
 528     /* The config space */
 529     qemu_put_be16s(f, &s->config.cols);
 530     qemu_put_be16s(f, &s->config.rows);
 531
 532     qemu_put_be32s(f, &s->config.max_nr_ports);
 533
 534     /* The ports map */
 535     max_nr_ports = tswap32(s->config.max_nr_ports);
 536     for (i = 0; i < (max_nr_ports + 31) / 32; i++) {
 537         qemu_put_be32s(f, &s->ports_map[i]);
 538     }
 539
 540     /* Ports */
 541
 542     nr_active_ports = 0;
 543     QTAILQ_FOREACH(port, &s->ports, next) {
 544         nr_active_ports++;
 545     }
 546
 547     qemu_put_be32s(f, &nr_active_ports);
 548
 549     /*
 550      * Items in struct VirtIOSerialPort.
 551      */
 552     QTAILQ_FOREACH(port, &s->ports, next) {
 553         uint32_t elem_popped;
 554
 555         qemu_put_be32s(f, &port->id);
 556         qemu_put_byte(f, port->guest_connected);
 557         qemu_put_byte(f, port->host_connected);
 558
 559         elem_popped = 0;
 560         if (port->elem.out_num) {
 561             elem_popped = 1;
 562         }
 563         qemu_put_be32s(f, &elem_popped);
 564         if (elem_popped) {
 565             qemu_put_be32s(f, &port->iov_idx);
 566             qemu_put_be64s(f, &port->iov_offset);
 567
 568             qemu_put_buffer(f, (unsigned char *)&port->elem,
 569                             sizeof(port->elem));
 570         }
 571     }
 572 }
 573
 574 static void virtio_serial_post_load_timer_cb(void *opaque)
 575 {
 576     uint32_t i;
 577     VirtIOSerial *s = VIRTIO_SERIAL(opaque);
 578     VirtIOSerialPort *port;
 579     uint8_t host_connected;
 580     VirtIOSerialPortClass *vsc;
 581
 582     if (!s->post_load) {
 583         return;
 584     }
 585     for (i = 0 ; i < s->post_load->nr_active_ports; ++i) {
 586         port = s->post_load->connected[i].port;
 587         host_connected = s->post_load->connected[i].host_connected;
 588         if (host_connected != port->host_connected) {
 589             /*
 590              * We have to let the guest know of the host connection
 591              * status change
 592              */
 593             send_control_event(s, port->id, VIRTIO_CONSOLE_PORT_OPEN,
 594                                port->host_connected);
 595         }
 596         vsc = VIRTIO_SERIAL_PORT_GET_CLASS(port);
 597         if (vsc->set_guest_connected) {
 598             vsc->set_guest_connected(port, port->guest_connected);
 599         }
 600     }
 601     g_free(s->post_load->connected);
 602     timer_free(s->post_load->timer);
 603     g_free(s->post_load);
 604     s->post_load = NULL;
 605 }
 606
 607 static int fetch_active_ports_list(QEMUFile *f, int version_id,
 608                                    VirtIOSerial *s, uint32_t nr_active_ports)
 609 {
 610     uint32_t i;
 611
 612     s->post_load = g_malloc0(sizeof(*s->post_load));
 613     s->post_load->nr_active_ports = nr_active_ports;
 614     s->post_load->connected =
 615         g_malloc0(sizeof(*s->post_load->connected) * nr_active_ports);
 616
 617     s->post_load->timer = timer_new_ns(QEMU_CLOCK_VIRTUAL,
 618                                             virtio_serial_post_load_timer_cb,
 619                                             s);
 620
 621     /* Items in struct VirtIOSerialPort */
 622     for (i = 0; i < nr_active_ports; i++) {
 623         VirtIOSerialPort *port;
 624         uint32_t id;
 625
 626         id = qemu_get_be32(f);
 627         port = find_port_by_id(s, id);
 628         if (!port) {
 629             return -EINVAL;
 630         }
 631
 632         port->guest_connected = qemu_get_byte(f);
 633         s->post_load->connected[i].port = port;
 634         s->post_load->connected[i].host_connected = qemu_get_byte(f);
 635
 636         if (version_id > 2) {
 637             uint32_t elem_popped;
 638
 639             qemu_get_be32s(f, &elem_popped);
 640             if (elem_popped) {
 641                 qemu_get_be32s(f, &port->iov_idx);
 642                 qemu_get_be64s(f, &port->iov_offset);
 643
 644                 qemu_get_buffer(f, (unsigned char *)&port->elem,
 645                                 sizeof(port->elem));
 646                 virtqueue_map_sg(port->elem.in_sg, port->elem.in_addr,
 647                                  port->elem.in_num, 1);
 648                 virtqueue_map_sg(port->elem.out_sg, port->elem.out_addr,
 649                                  port->elem.out_num, 1);
 650
 651                 /*
 652                  *  Port was throttled on source machine.  Let's
 653                  *  unthrottle it here so data starts flowing again.
 654                  */
 655                 virtio_serial_throttle_port(port, false);
 656             }
 657         }
 658     }
 659     timer_mod(s->post_load->timer, 1);
 660     return 0;
 661 }
 662
 663 static int virtio_serial_load(QEMUFile *f, void *opaque, int version_id)
 664 {
 665     if (version_id > 3) {
 666         return -EINVAL;
 667     }
 668
 669     /* The virtio device */
 670     return virtio_load(VIRTIO_DEVICE(opaque), f, version_id);
 671 }
 672
 673 static int virtio_serial_load_device(VirtIODevice *vdev, QEMUFile *f,
 674                                      int version_id)
 675 {
 676     VirtIOSerial *s = VIRTIO_SERIAL(vdev);
 677     uint32_t max_nr_ports, nr_active_ports, ports_map;
 678     unsigned int i;
 679     int ret;
 680     uint32_t tmp;
 681
 682     if (version_id < 2) {
 683         return 0;
 684     }
 685
 686     /* Unused */
 687     qemu_get_be16s(f, (uint16_t *) &tmp);
 688     qemu_get_be16s(f, (uint16_t *) &tmp);
 689     qemu_get_be32s(f, &tmp);
 690
 691     max_nr_ports = tswap32(s->config.max_nr_ports);
 692     for (i = 0; i < (max_nr_ports + 31) / 32; i++) {
 693         qemu_get_be32s(f, &ports_map);
 694
 695         if (ports_map != s->ports_map[i]) {
 696             /*
 697              * Ports active on source and destination don't
 698              * match. Fail migration.
 699              */
 700             return -EINVAL;
 701         }
 702     }
 703
 704     qemu_get_be32s(f, &nr_active_ports);
 705
 706     if (nr_active_ports) {
 707         ret = fetch_active_ports_list(f, version_id, s, nr_active_ports);
 708         if (ret) {
 709             return ret;
 710         }
 711     }
 712     return 0;
 713 }
 714
 715 static void virtser_bus_dev_print(Monitor *mon, DeviceState *qdev, int indent);
 716
 717 static Property virtser_props[] = {
 718     DEFINE_PROP_UINT32("nr", VirtIOSerialPort, id, VIRTIO_CONSOLE_BAD_ID),
 719     DEFINE_PROP_STRING("name", VirtIOSerialPort, name),
 720     DEFINE_PROP_END_OF_LIST()
 721 };
 722
 723 #define TYPE_VIRTIO_SERIAL_BUS "virtio-serial-bus"
 724 #define VIRTIO_SERIAL_BUS(obj) \
 725       OBJECT_CHECK(VirtIOSerialBus, (obj), TYPE_VIRTIO_SERIAL_BUS)
 726
 727 static void virtser_bus_class_init(ObjectClass *klass, void *data)
 728 {
 729     BusClass *k = BUS_CLASS(klass);
 730     k->print_dev = virtser_bus_dev_print;
 731 }
 732
 733 static const TypeInfo virtser_bus_info = {
 734     .name = TYPE_VIRTIO_SERIAL_BUS,
 735     .parent = TYPE_BUS,
 736     .instance_size = sizeof(VirtIOSerialBus),
 737     .class_init = virtser_bus_class_init,
 738 };
 739
 740 static void virtser_bus_dev_print(Monitor *mon, DeviceState *qdev, int indent)
 741 {
 742     VirtIOSerialPort *port = DO_UPCAST(VirtIOSerialPort, dev, qdev);
 743
 744     monitor_printf(mon, "%*sport %d, guest %s, host %s, throttle %s\n",
 745                    indent, "", port->id,
 746                    port->guest_connected ? "on" : "off",
 747                    port->host_connected ? "on" : "off",
 748                    port->throttled ? "on" : "off");
 749 }
 750
 751 /* This function is only used if a port id is not provided by the user */
 752 static uint32_t find_free_port_id(VirtIOSerial *vser)
 753 {
 754     unsigned int i, max_nr_ports;
 755
 756     max_nr_ports = tswap32(vser->config.max_nr_ports);
 757     for (i = 0; i < (max_nr_ports + 31) / 32; i++) {
 758         uint32_t map, bit;
 759
 760         map = vser->ports_map[i];
 761         bit = ffs(~map);
 762         if (bit) {
 763             return (bit - 1) + i * 32;
 764         }
 765     }
 766     return VIRTIO_CONSOLE_BAD_ID;
 767 }
 768
 769 static void mark_port_added(VirtIOSerial *vser, uint32_t port_id)
 770 {
 771     unsigned int i;
 772
 773     i = port_id / 32;
 774     vser->ports_map[i] |= 1U << (port_id % 32);
 775 }
 776
 777 static void add_port(VirtIOSerial *vser, uint32_t port_id)
 778 {
 779     mark_port_added(vser, port_id);
 780     send_control_event(vser, port_id, VIRTIO_CONSOLE_PORT_ADD, 1);
 781 }
 782
 783 static void remove_port(VirtIOSerial *vser, uint32_t port_id)
 784 {
 785     VirtIOSerialPort *port;
 786     unsigned int i;
 787
 788     i = port_id / 32;
 789     vser->ports_map[i] &= ~(1U << (port_id % 32));
 790
 791     port = find_port_by_id(vser, port_id);
 792     /*
 793      * This function is only called from qdev's unplug callback; if we
 794      * get a NULL port here, we're in trouble.
 795      */
 796     assert(port);
 797
 798     /* Flush out any unconsumed buffers first */
 799     discard_vq_data(port->ovq, VIRTIO_DEVICE(port->vser));
 800
 801     send_control_event(vser, port->id, VIRTIO_CONSOLE_PORT_REMOVE, 1);
 802 }
 803
 804 static void virtser_port_device_realize(DeviceState *dev, Error **errp)
 805 {
 806     VirtIOSerialPort *port = VIRTIO_SERIAL_PORT(dev);
 807     VirtIOSerialPortClass *vsc = VIRTIO_SERIAL_PORT_GET_CLASS(port);
 808     VirtIOSerialBus *bus = VIRTIO_SERIAL_BUS(qdev_get_parent_bus(dev));
 809     int max_nr_ports;
 810     bool plugging_port0;
 811     Error *err = NULL;
 812
 813     port->vser = bus->vser;
 814     port->bh = qemu_bh_new(flush_queued_data_bh, port);
 815
 816     assert(vsc->have_data);
 817
 818     /*
 819      * Is the first console port we're seeing? If so, put it up at
 820      * location 0. This is done for backward compatibility (old
 821      * kernel, new qemu).
 822      */
 823     plugging_port0 = vsc->is_console && !find_port_by_id(port->vser, 0);
 824
 825     if (find_port_by_id(port->vser, port->id)) {
 826         error_setg(errp, "virtio-serial-bus: A port already exists at id %u",
 827                    port->id);
 828         return;
 829     }
 830
 831     if (port->id == VIRTIO_CONSOLE_BAD_ID) {
 832         if (plugging_port0) {
 833             port->id = 0;
 834         } else {
 835             port->id = find_free_port_id(port->vser);
 836             if (port->id == VIRTIO_CONSOLE_BAD_ID) {
 837                 error_setg(errp, "virtio-serial-bus: Maximum port limit for "
 838                                  "this device reached");
 839                 return;
 840             }
 841         }
 842     }
 843
 844     max_nr_ports = tswap32(port->vser->config.max_nr_ports);
 845     if (port->id >= max_nr_ports) {
 846         error_setg(errp, "virtio-serial-bus: Out-of-range port id specified, "
 847                          "max. allowed: %u", max_nr_ports - 1);
 848         return;
 849     }
 850
 851     vsc->realize(dev, &err);
 852     if (err != NULL) {
 853         error_propagate(errp, err);
 854         return;
 855     }
 856
 857     port->elem.out_num = 0;
 858
 859     QTAILQ_INSERT_TAIL(&port->vser->ports, port, next);
 860     port->ivq = port->vser->ivqs[port->id];
 861     port->ovq = port->vser->ovqs[port->id];
 862
 863     add_port(port->vser, port->id);
 864
 865     /* Send an update to the guest about this new port added */
 866     virtio_notify_config(VIRTIO_DEVICE(port->vser));
 867 }
 868
 869 static void virtser_port_device_unrealize(DeviceState *dev, Error **errp)
 870 {
 871     VirtIOSerialPort *port = VIRTIO_SERIAL_PORT(dev);
 872     VirtIOSerialPortClass *vsc = VIRTIO_SERIAL_PORT_GET_CLASS(dev);
 873     VirtIOSerial *vser = port->vser;
 874
 875     qemu_bh_delete(port->bh);
 876     remove_port(port->vser, port->id);
 877
 878     QTAILQ_REMOVE(&vser->ports, port, next);
 879
 880     if (vsc->unrealize) {
 881         vsc->unrealize(dev, errp);
 882     }
 883 }
 884
 885 static void virtio_serial_device_realize(DeviceState *dev, Error **errp)
 886 {
 887     VirtIODevice *vdev = VIRTIO_DEVICE(dev);
 888     VirtIOSerial *vser = VIRTIO_SERIAL(dev);
 889     BusState *bus;
 890     uint32_t i, max_supported_ports;
 891
 892     if (!vser->serial.max_virtserial_ports) {
 893         error_setg(errp, "Maximum number of serial ports not specified");
 894         return;
 895     }
 896
 897     /* Each port takes 2 queues, and one pair is for the control queue */
 898     max_supported_ports = VIRTIO_PCI_QUEUE_MAX / 2 - 1;
 899
 900     if (vser->serial.max_virtserial_ports > max_supported_ports) {
 901         error_setg(errp, "maximum ports supported: %u", max_supported_ports);
 902         return;
 903     }
 904
 905     virtio_init(vdev, "virtio-serial", VIRTIO_ID_CONSOLE,
 906                 sizeof(struct virtio_console_config));
 907
 908     /* Spawn a new virtio-serial bus on which the ports will ride as devices */
 909     qbus_create_inplace(&vser->bus, sizeof(vser->bus), TYPE_VIRTIO_SERIAL_BUS,
 910                         dev, vdev->bus_name);
 911     bus = BUS(&vser->bus);
 912     bus->allow_hotplug = 1;
 913     vser->bus.vser = vser;
 914     QTAILQ_INIT(&vser->ports);
 915
 916     vser->bus.max_nr_ports = vser->serial.max_virtserial_ports;
 917     vser->ivqs = g_malloc(vser->serial.max_virtserial_ports
 918                           * sizeof(VirtQueue *));
 919     vser->ovqs = g_malloc(vser->serial.max_virtserial_ports
 920                           * sizeof(VirtQueue *));
 921
 922     /* Add a queue for host to guest transfers for port 0 (backward compat) */
 923     vser->ivqs[0] = virtio_add_queue(vdev, 128, handle_input);
 924     /* Add a queue for guest to host transfers for port 0 (backward compat) */
 925     vser->ovqs[0] = virtio_add_queue(vdev, 128, handle_output);
 926
 927     /* TODO: host to guest notifications can get dropped
 928      * if the queue fills up. Implement queueing in host,
 929      * this might also make it possible to reduce the control
 930      * queue size: as guest preposts buffers there,
 931      * this will save 4Kbyte of guest memory per entry. */
 932
 933     /* control queue: host to guest */
 934     vser->c_ivq = virtio_add_queue(vdev, 32, control_in);
 935     /* control queue: guest to host */
 936     vser->c_ovq = virtio_add_queue(vdev, 32, control_out);
 937
 938     for (i = 1; i < vser->bus.max_nr_ports; i++) {
 939         /* Add a per-port queue for host to guest transfers */
 940         vser->ivqs[i] = virtio_add_queue(vdev, 128, handle_input);
 941         /* Add a per-per queue for guest to host transfers */
 942         vser->ovqs[i] = virtio_add_queue(vdev, 128, handle_output);
 943     }
 944
 945     vser->config.max_nr_ports = tswap32(vser->serial.max_virtserial_ports);
 946     vser->ports_map = g_malloc0(((vser->serial.max_virtserial_ports + 31) / 32)
 947         * sizeof(vser->ports_map[0]));
 948     /*
 949      * Reserve location 0 for a console port for backward compat
 950      * (old kernel, new qemu)
 951      */
 952     mark_port_added(vser, 0);
 953
 954     vser->post_load = NULL;
 955
 956     /*
 957      * Register for the savevm section with the virtio-console name
 958      * to preserve backward compat
 959      */
 960     register_savevm(dev, "virtio-console", -1, 3, virtio_serial_save,
 961                     virtio_serial_load, vser);
 962 }
 963
 964 static void virtio_serial_port_class_init(ObjectClass *klass, void *data)
 965 {
 966     DeviceClass *k = DEVICE_CLASS(klass);
 967
 968     set_bit(DEVICE_CATEGORY_INPUT, k->categories);
 969     k->bus_type = TYPE_VIRTIO_SERIAL_BUS;
 970     k->realize = virtser_port_device_realize;
 971     k->unrealize = virtser_port_device_unrealize;
 972     k->unplug = qdev_simple_unplug_cb;
 973     k->props = virtser_props;
 974 }
 975
 976 static const TypeInfo virtio_serial_port_type_info = {
 977     .name = TYPE_VIRTIO_SERIAL_PORT,
 978     .parent = TYPE_DEVICE,
 979     .instance_size = sizeof(VirtIOSerialPort),
 980     .abstract = true,
 981     .class_size = sizeof(VirtIOSerialPortClass),
 982     .class_init = virtio_serial_port_class_init,
 983 };
 984
 985 static void virtio_serial_device_unrealize(DeviceState *dev, Error **errp)
 986 {
 987     VirtIODevice *vdev = VIRTIO_DEVICE(dev);
 988     VirtIOSerial *vser = VIRTIO_SERIAL(dev);
 989
 990     unregister_savevm(dev, "virtio-console", vser);
 991
 992     g_free(vser->ivqs);
 993     g_free(vser->ovqs);
 994     g_free(vser->ports_map);
 995     if (vser->post_load) {
 996         g_free(vser->post_load->connected);
 997         timer_del(vser->post_load->timer);
 998         timer_free(vser->post_load->timer);
 999         g_free(vser->post_load);
1000     }
1001     virtio_cleanup(vdev);
1002 }
1003
1004 static Property virtio_serial_properties[] = {
1005     DEFINE_VIRTIO_SERIAL_PROPERTIES(VirtIOSerial, serial),
1006     DEFINE_PROP_END_OF_LIST(),
1007 };
1008
1009 static void virtio_serial_class_init(ObjectClass *klass, void *data)
1010 {
1011     DeviceClass *dc = DEVICE_CLASS(klass);
1012     VirtioDeviceClass *vdc = VIRTIO_DEVICE_CLASS(klass);
1013
1014     dc->props = virtio_serial_properties;
1015     set_bit(DEVICE_CATEGORY_INPUT, dc->categories);
1016     vdc->realize = virtio_serial_device_realize;
1017     vdc->unrealize = virtio_serial_device_unrealize;
1018     vdc->get_features = get_features;
1019     vdc->get_config = get_config;
1020     vdc->set_status = set_status;
1021     vdc->reset = vser_reset;
1022     vdc->save = virtio_serial_save_device;
1023     vdc->load = virtio_serial_load_device;
1024 }
1025
1026 static const TypeInfo virtio_device_info = {
1027     .name = TYPE_VIRTIO_SERIAL,
1028     .parent = TYPE_VIRTIO_DEVICE,
1029     .instance_size = sizeof(VirtIOSerial),
1030     .class_init = virtio_serial_class_init,
1031 };
1032
1033 static void virtio_serial_register_types(void)
1034 {
1035     type_register_static(&virtser_bus_info);
1036     type_register_static(&virtio_serial_port_type_info);
1037     type_register_static(&virtio_device_info);
1038 }
1039
1040 type_init(virtio_serial_register_types)