2 * A bus for connecting virtio serial and console ports
4 * Copyright (C) 2009, 2010 Red Hat, Inc.
7 * Amit Shah <amit.shah@redhat.com>
9 * Some earlier parts are:
10 * Copyright IBM, Corp. 2008
12 * Christian Ehrhardt <ehrhardt@linux.vnet.ibm.com>
14 * This work is licensed under the terms of the GNU GPL, version 2. See
15 * the COPYING file in the top-level directory.
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.
21 #define VMSTATE_VIRTIO_DEVICE_USE_NEW
23 #include "qemu/osdep.h"
24 #include "qapi/error.h"
26 #include "monitor/monitor.h"
27 #include "qemu/error-report.h"
28 #include "qemu/queue.h"
29 #include "hw/sysbus.h"
31 #include "hw/virtio/virtio-serial.h"
32 #include "hw/virtio/virtio-access.h"
34 static struct VirtIOSerialDevices
{
35 QLIST_HEAD(, VirtIOSerial
) devices
;
38 static VirtIOSerialPort
*find_port_by_id(VirtIOSerial
*vser
, uint32_t id
)
40 VirtIOSerialPort
*port
;
42 if (id
== VIRTIO_CONSOLE_BAD_ID
) {
46 QTAILQ_FOREACH(port
, &vser
->ports
, next
) {
53 static VirtIOSerialPort
*find_port_by_vq(VirtIOSerial
*vser
, VirtQueue
*vq
)
55 VirtIOSerialPort
*port
;
57 QTAILQ_FOREACH(port
, &vser
->ports
, next
) {
58 if (port
->ivq
== vq
|| port
->ovq
== vq
)
64 static VirtIOSerialPort
*find_port_by_name(char *name
)
68 QLIST_FOREACH(vser
, &vserdevices
.devices
, next
) {
69 VirtIOSerialPort
*port
;
71 QTAILQ_FOREACH(port
, &vser
->ports
, next
) {
72 if (port
->name
&& !strcmp(port
->name
, name
)) {
80 static VirtIOSerialPort
*find_first_connected_console(VirtIOSerial
*vser
)
82 VirtIOSerialPort
*port
;
84 QTAILQ_FOREACH(port
, &vser
->ports
, next
) {
85 VirtIOSerialPortClass
const *vsc
= VIRTIO_SERIAL_PORT_GET_CLASS(port
);
86 if (vsc
->is_console
&& port
->host_connected
) {
93 static bool use_multiport(VirtIOSerial
*vser
)
95 VirtIODevice
*vdev
= VIRTIO_DEVICE(vser
);
96 return virtio_vdev_has_feature(vdev
, VIRTIO_CONSOLE_F_MULTIPORT
);
99 static size_t write_to_port(VirtIOSerialPort
*port
,
100 const uint8_t *buf
, size_t size
)
102 VirtQueueElement
*elem
;
107 if (!virtio_queue_ready(vq
)) {
112 while (offset
< size
) {
115 elem
= virtqueue_pop(vq
, sizeof(VirtQueueElement
));
120 len
= iov_from_buf(elem
->in_sg
, elem
->in_num
, 0,
121 buf
+ offset
, size
- offset
);
124 virtqueue_push(vq
, elem
, len
);
128 virtio_notify(VIRTIO_DEVICE(port
->vser
), vq
);
132 static void discard_vq_data(VirtQueue
*vq
, VirtIODevice
*vdev
)
134 VirtQueueElement
*elem
;
136 if (!virtio_queue_ready(vq
)) {
140 elem
= virtqueue_pop(vq
, sizeof(VirtQueueElement
));
144 virtqueue_push(vq
, elem
, 0);
147 virtio_notify(vdev
, vq
);
150 static void discard_throttle_data(VirtIOSerialPort
*port
)
153 virtqueue_detach_element(port
->ovq
, port
->elem
, 0);
159 static void do_flush_queued_data(VirtIOSerialPort
*port
, VirtQueue
*vq
,
162 VirtIOSerialPortClass
*vsc
;
165 assert(virtio_queue_ready(vq
));
167 vsc
= VIRTIO_SERIAL_PORT_GET_CLASS(port
);
169 while (!port
->throttled
) {
172 /* Pop an elem only if we haven't left off a previous one mid-way */
174 port
->elem
= virtqueue_pop(vq
, sizeof(VirtQueueElement
));
179 port
->iov_offset
= 0;
182 for (i
= port
->iov_idx
; i
< port
->elem
->out_num
; i
++) {
186 buf_size
= port
->elem
->out_sg
[i
].iov_len
- port
->iov_offset
;
187 ret
= vsc
->have_data(port
,
188 port
->elem
->out_sg
[i
].iov_base
191 if (port
->throttled
) {
194 port
->iov_offset
+= ret
;
198 port
->iov_offset
= 0;
200 if (port
->throttled
) {
203 virtqueue_push(vq
, port
->elem
, 0);
207 virtio_notify(vdev
, vq
);
210 static void flush_queued_data(VirtIOSerialPort
*port
)
214 if (!virtio_queue_ready(port
->ovq
)) {
217 do_flush_queued_data(port
, port
->ovq
, VIRTIO_DEVICE(port
->vser
));
220 static size_t send_control_msg(VirtIOSerial
*vser
, void *buf
, size_t len
)
222 VirtQueueElement
*elem
;
226 if (!virtio_queue_ready(vq
)) {
230 elem
= virtqueue_pop(vq
, sizeof(VirtQueueElement
));
235 /* TODO: detect a buffer that's too short, set NEEDS_RESET */
236 iov_from_buf(elem
->in_sg
, elem
->in_num
, 0, buf
, len
);
238 virtqueue_push(vq
, elem
, len
);
239 virtio_notify(VIRTIO_DEVICE(vser
), vq
);
245 static size_t send_control_event(VirtIOSerial
*vser
, uint32_t port_id
,
246 uint16_t event
, uint16_t value
)
248 VirtIODevice
*vdev
= VIRTIO_DEVICE(vser
);
249 struct virtio_console_control cpkt
;
251 virtio_stl_p(vdev
, &cpkt
.id
, port_id
);
252 virtio_stw_p(vdev
, &cpkt
.event
, event
);
253 virtio_stw_p(vdev
, &cpkt
.value
, value
);
255 trace_virtio_serial_send_control_event(port_id
, event
, value
);
256 return send_control_msg(vser
, &cpkt
, sizeof(cpkt
));
259 /* Functions for use inside qemu to open and read from/write to ports */
260 int virtio_serial_open(VirtIOSerialPort
*port
)
262 /* Don't allow opening an already-open port */
263 if (port
->host_connected
) {
266 /* Send port open notification to the guest */
267 port
->host_connected
= true;
268 send_control_event(port
->vser
, port
->id
, VIRTIO_CONSOLE_PORT_OPEN
, 1);
273 int virtio_serial_close(VirtIOSerialPort
*port
)
275 port
->host_connected
= false;
277 * If there's any data the guest sent which the app didn't
278 * consume, reset the throttling flag and discard the data.
280 port
->throttled
= false;
281 discard_throttle_data(port
);
282 discard_vq_data(port
->ovq
, VIRTIO_DEVICE(port
->vser
));
284 send_control_event(port
->vser
, port
->id
, VIRTIO_CONSOLE_PORT_OPEN
, 0);
289 /* Individual ports/apps call this function to write to the guest. */
290 ssize_t
virtio_serial_write(VirtIOSerialPort
*port
, const uint8_t *buf
,
293 if (!port
|| !port
->host_connected
|| !port
->guest_connected
) {
296 return write_to_port(port
, buf
, size
);
300 * Readiness of the guest to accept data on a port.
301 * Returns max. data the guest can receive
303 size_t virtio_serial_guest_ready(VirtIOSerialPort
*port
)
305 VirtIODevice
*vdev
= VIRTIO_DEVICE(port
->vser
);
306 VirtQueue
*vq
= port
->ivq
;
309 if (!virtio_queue_ready(vq
) ||
310 !(vdev
->status
& VIRTIO_CONFIG_S_DRIVER_OK
) ||
311 virtio_queue_empty(vq
)) {
314 if (use_multiport(port
->vser
) && !port
->guest_connected
) {
317 virtqueue_get_avail_bytes(vq
, &bytes
, NULL
, 4096, 0);
321 static void flush_queued_data_bh(void *opaque
)
323 VirtIOSerialPort
*port
= opaque
;
325 flush_queued_data(port
);
328 void virtio_serial_throttle_port(VirtIOSerialPort
*port
, bool throttle
)
334 trace_virtio_serial_throttle_port(port
->id
, throttle
);
335 port
->throttled
= throttle
;
339 qemu_bh_schedule(port
->bh
);
342 /* Guest wants to notify us of some event */
343 static void handle_control_message(VirtIOSerial
*vser
, void *buf
, size_t len
)
345 VirtIODevice
*vdev
= VIRTIO_DEVICE(vser
);
346 struct VirtIOSerialPort
*port
;
347 VirtIOSerialPortClass
*vsc
;
348 struct virtio_console_control cpkt
, *gcpkt
;
354 if (len
< sizeof(cpkt
)) {
355 /* The guest sent an invalid control packet */
359 cpkt
.event
= virtio_lduw_p(vdev
, &gcpkt
->event
);
360 cpkt
.value
= virtio_lduw_p(vdev
, &gcpkt
->value
);
362 trace_virtio_serial_handle_control_message(cpkt
.event
, cpkt
.value
);
364 if (cpkt
.event
== VIRTIO_CONSOLE_DEVICE_READY
) {
366 error_report("virtio-serial-bus: Guest failure in adding device %s",
367 vser
->bus
.qbus
.name
);
371 * The device is up, we can now tell the device about all the
372 * ports we have here.
374 QTAILQ_FOREACH(port
, &vser
->ports
, next
) {
375 send_control_event(vser
, port
->id
, VIRTIO_CONSOLE_PORT_ADD
, 1);
380 port
= find_port_by_id(vser
, virtio_ldl_p(vdev
, &gcpkt
->id
));
382 error_report("virtio-serial-bus: Unexpected port id %u for device %s",
383 virtio_ldl_p(vdev
, &gcpkt
->id
), vser
->bus
.qbus
.name
);
387 trace_virtio_serial_handle_control_message_port(port
->id
);
389 vsc
= VIRTIO_SERIAL_PORT_GET_CLASS(port
);
392 case VIRTIO_CONSOLE_PORT_READY
:
394 error_report("virtio-serial-bus: Guest failure in adding port %u for device %s",
395 port
->id
, vser
->bus
.qbus
.name
);
399 * Now that we know the guest asked for the port name, we're
400 * sure the guest has initialised whatever state is necessary
401 * for this port. Now's a good time to let the guest know if
402 * this port is a console port so that the guest can hook it
405 if (vsc
->is_console
) {
406 send_control_event(vser
, port
->id
, VIRTIO_CONSOLE_CONSOLE_PORT
, 1);
410 virtio_stl_p(vdev
, &cpkt
.id
, port
->id
);
411 virtio_stw_p(vdev
, &cpkt
.event
, VIRTIO_CONSOLE_PORT_NAME
);
412 virtio_stw_p(vdev
, &cpkt
.value
, 1);
414 buffer_len
= sizeof(cpkt
) + strlen(port
->name
) + 1;
415 buffer
= g_malloc(buffer_len
);
417 memcpy(buffer
, &cpkt
, sizeof(cpkt
));
418 memcpy(buffer
+ sizeof(cpkt
), port
->name
, strlen(port
->name
));
419 buffer
[buffer_len
- 1] = 0;
421 send_control_msg(vser
, buffer
, buffer_len
);
425 if (port
->host_connected
) {
426 send_control_event(vser
, port
->id
, VIRTIO_CONSOLE_PORT_OPEN
, 1);
430 * When the guest has asked us for this information it means
431 * the guest is all setup and has its virtqueues
432 * initialised. If some app is interested in knowing about
433 * this event, let it know.
435 if (vsc
->guest_ready
) {
436 vsc
->guest_ready(port
);
440 case VIRTIO_CONSOLE_PORT_OPEN
:
441 port
->guest_connected
= cpkt
.value
;
442 if (vsc
->set_guest_connected
) {
443 /* Send the guest opened notification if an app is interested */
444 vsc
->set_guest_connected(port
, cpkt
.value
);
450 static void control_in(VirtIODevice
*vdev
, VirtQueue
*vq
)
454 static void control_out(VirtIODevice
*vdev
, VirtQueue
*vq
)
456 VirtQueueElement
*elem
;
461 vser
= VIRTIO_SERIAL(vdev
);
468 elem
= virtqueue_pop(vq
, sizeof(VirtQueueElement
));
473 cur_len
= iov_size(elem
->out_sg
, elem
->out_num
);
475 * Allocate a new buf only if we didn't have one previously or
476 * if the size of the buf differs
481 buf
= g_malloc(cur_len
);
484 iov_to_buf(elem
->out_sg
, elem
->out_num
, 0, buf
, cur_len
);
486 handle_control_message(vser
, buf
, cur_len
);
487 virtqueue_push(vq
, elem
, 0);
491 virtio_notify(vdev
, vq
);
494 /* Guest wrote something to some port. */
495 static void handle_output(VirtIODevice
*vdev
, VirtQueue
*vq
)
498 VirtIOSerialPort
*port
;
500 vser
= VIRTIO_SERIAL(vdev
);
501 port
= find_port_by_vq(vser
, vq
);
503 if (!port
|| !port
->host_connected
) {
504 discard_vq_data(vq
, vdev
);
508 if (!port
->throttled
) {
509 do_flush_queued_data(port
, vq
, vdev
);
514 static void handle_input(VirtIODevice
*vdev
, VirtQueue
*vq
)
517 * Users of virtio-serial would like to know when guest becomes
518 * writable again -- i.e. if a vq had stuff queued up and the
519 * guest wasn't reading at all, the host would not be able to
520 * write to the vq anymore. Once the guest reads off something,
521 * we can start queueing things up again. However, this call is
522 * made for each buffer addition by the guest -- even though free
523 * buffers existed prior to the current buffer addition. This is
524 * done so as not to maintain previous state, which will need
525 * additional live-migration-related changes.
528 VirtIOSerialPort
*port
;
529 VirtIOSerialPortClass
*vsc
;
531 vser
= VIRTIO_SERIAL(vdev
);
532 port
= find_port_by_vq(vser
, vq
);
537 vsc
= VIRTIO_SERIAL_PORT_GET_CLASS(port
);
540 * If guest_connected is false, this call is being made by the
541 * early-boot queueing up of descriptors, which is just noise for
542 * the host apps -- don't disturb them in that case.
544 if (port
->guest_connected
&& port
->host_connected
&& vsc
->guest_writable
) {
545 vsc
->guest_writable(port
);
549 static uint64_t get_features(VirtIODevice
*vdev
, uint64_t features
,
554 vser
= VIRTIO_SERIAL(vdev
);
556 features
|= vser
->host_features
;
557 if (vser
->bus
.max_nr_ports
> 1) {
558 virtio_add_feature(&features
, VIRTIO_CONSOLE_F_MULTIPORT
);
563 /* Guest requested config info */
564 static void get_config(VirtIODevice
*vdev
, uint8_t *config_data
)
566 VirtIOSerial
*vser
= VIRTIO_SERIAL(vdev
);
567 struct virtio_console_config
*config
=
568 (struct virtio_console_config
*)config_data
;
572 config
->max_nr_ports
= virtio_tswap32(vdev
,
573 vser
->serial
.max_virtserial_ports
);
576 /* Guest sent new config info */
577 static void set_config(VirtIODevice
*vdev
, const uint8_t *config_data
)
579 VirtIOSerial
*vser
= VIRTIO_SERIAL(vdev
);
580 struct virtio_console_config
*config
=
581 (struct virtio_console_config
*)config_data
;
582 uint8_t emerg_wr_lo
= le32_to_cpu(config
->emerg_wr
);
583 VirtIOSerialPort
*port
= find_first_connected_console(vser
);
584 VirtIOSerialPortClass
*vsc
;
586 if (!config
->emerg_wr
) {
589 /* Make sure we don't misdetect an emergency write when the guest
590 * does a short config write after an emergency write. */
591 config
->emerg_wr
= 0;
595 vsc
= VIRTIO_SERIAL_PORT_GET_CLASS(port
);
596 (void)vsc
->have_data(port
, &emerg_wr_lo
, 1);
599 static void guest_reset(VirtIOSerial
*vser
)
601 VirtIOSerialPort
*port
;
602 VirtIOSerialPortClass
*vsc
;
604 QTAILQ_FOREACH(port
, &vser
->ports
, next
) {
605 vsc
= VIRTIO_SERIAL_PORT_GET_CLASS(port
);
607 discard_throttle_data(port
);
609 if (port
->guest_connected
) {
610 port
->guest_connected
= false;
611 if (vsc
->set_guest_connected
) {
612 vsc
->set_guest_connected(port
, false);
618 static void set_status(VirtIODevice
*vdev
, uint8_t status
)
621 VirtIOSerialPort
*port
;
623 vser
= VIRTIO_SERIAL(vdev
);
624 port
= find_port_by_id(vser
, 0);
626 if (port
&& !use_multiport(port
->vser
)
627 && (status
& VIRTIO_CONFIG_S_DRIVER_OK
)) {
629 * Non-multiport guests won't be able to tell us guest
630 * open/close status. Such guests can only have a port at id
631 * 0, so set guest_connected for such ports as soon as guest
634 port
->guest_connected
= true;
636 if (!(status
& VIRTIO_CONFIG_S_DRIVER_OK
)) {
641 static void vser_reset(VirtIODevice
*vdev
)
645 vser
= VIRTIO_SERIAL(vdev
);
649 static void virtio_serial_save_device(VirtIODevice
*vdev
, QEMUFile
*f
)
651 VirtIOSerial
*s
= VIRTIO_SERIAL(vdev
);
652 VirtIOSerialPort
*port
;
653 uint32_t nr_active_ports
;
654 unsigned int i
, max_nr_ports
;
655 struct virtio_console_config config
;
657 /* The config space (ignored on the far end in current versions) */
658 get_config(vdev
, (uint8_t *)&config
);
659 qemu_put_be16s(f
, &config
.cols
);
660 qemu_put_be16s(f
, &config
.rows
);
661 qemu_put_be32s(f
, &config
.max_nr_ports
);
664 max_nr_ports
= s
->serial
.max_virtserial_ports
;
665 for (i
= 0; i
< (max_nr_ports
+ 31) / 32; i
++) {
666 qemu_put_be32s(f
, &s
->ports_map
[i
]);
672 QTAILQ_FOREACH(port
, &s
->ports
, next
) {
676 qemu_put_be32s(f
, &nr_active_ports
);
679 * Items in struct VirtIOSerialPort.
681 QTAILQ_FOREACH(port
, &s
->ports
, next
) {
682 uint32_t elem_popped
;
684 qemu_put_be32s(f
, &port
->id
);
685 qemu_put_byte(f
, port
->guest_connected
);
686 qemu_put_byte(f
, port
->host_connected
);
692 qemu_put_be32s(f
, &elem_popped
);
694 qemu_put_be32s(f
, &port
->iov_idx
);
695 qemu_put_be64s(f
, &port
->iov_offset
);
696 qemu_put_virtqueue_element(f
, port
->elem
);
701 static void virtio_serial_post_load_timer_cb(void *opaque
)
704 VirtIOSerial
*s
= VIRTIO_SERIAL(opaque
);
705 VirtIOSerialPort
*port
;
706 uint8_t host_connected
;
707 VirtIOSerialPortClass
*vsc
;
712 for (i
= 0 ; i
< s
->post_load
->nr_active_ports
; ++i
) {
713 port
= s
->post_load
->connected
[i
].port
;
714 host_connected
= s
->post_load
->connected
[i
].host_connected
;
715 if (host_connected
!= port
->host_connected
) {
717 * We have to let the guest know of the host connection
720 send_control_event(s
, port
->id
, VIRTIO_CONSOLE_PORT_OPEN
,
721 port
->host_connected
);
723 vsc
= VIRTIO_SERIAL_PORT_GET_CLASS(port
);
724 if (vsc
->set_guest_connected
) {
725 vsc
->set_guest_connected(port
, port
->guest_connected
);
728 g_free(s
->post_load
->connected
);
729 timer_free(s
->post_load
->timer
);
730 g_free(s
->post_load
);
734 static int fetch_active_ports_list(QEMUFile
*f
,
735 VirtIOSerial
*s
, uint32_t nr_active_ports
)
739 s
->post_load
= g_malloc0(sizeof(*s
->post_load
));
740 s
->post_load
->nr_active_ports
= nr_active_ports
;
741 s
->post_load
->connected
=
742 g_malloc0(sizeof(*s
->post_load
->connected
) * nr_active_ports
);
744 s
->post_load
->timer
= timer_new_ns(QEMU_CLOCK_VIRTUAL
,
745 virtio_serial_post_load_timer_cb
,
748 /* Items in struct VirtIOSerialPort */
749 for (i
= 0; i
< nr_active_ports
; i
++) {
750 VirtIOSerialPort
*port
;
751 uint32_t elem_popped
;
754 id
= qemu_get_be32(f
);
755 port
= find_port_by_id(s
, id
);
760 port
->guest_connected
= qemu_get_byte(f
);
761 s
->post_load
->connected
[i
].port
= port
;
762 s
->post_load
->connected
[i
].host_connected
= qemu_get_byte(f
);
764 qemu_get_be32s(f
, &elem_popped
);
766 qemu_get_be32s(f
, &port
->iov_idx
);
767 qemu_get_be64s(f
, &port
->iov_offset
);
770 qemu_get_virtqueue_element(f
, sizeof(VirtQueueElement
));
773 * Port was throttled on source machine. Let's
774 * unthrottle it here so data starts flowing again.
776 virtio_serial_throttle_port(port
, false);
779 timer_mod(s
->post_load
->timer
, 1);
783 static int virtio_serial_load_device(VirtIODevice
*vdev
, QEMUFile
*f
,
786 VirtIOSerial
*s
= VIRTIO_SERIAL(vdev
);
787 uint32_t max_nr_ports
, nr_active_ports
, ports_map
;
793 qemu_get_be16s(f
, (uint16_t *) &tmp
);
794 qemu_get_be16s(f
, (uint16_t *) &tmp
);
795 qemu_get_be32s(f
, &tmp
);
797 max_nr_ports
= s
->serial
.max_virtserial_ports
;
798 for (i
= 0; i
< (max_nr_ports
+ 31) / 32; i
++) {
799 qemu_get_be32s(f
, &ports_map
);
801 if (ports_map
!= s
->ports_map
[i
]) {
803 * Ports active on source and destination don't
804 * match. Fail migration.
810 qemu_get_be32s(f
, &nr_active_ports
);
812 if (nr_active_ports
) {
813 ret
= fetch_active_ports_list(f
, s
, nr_active_ports
);
821 static void virtser_bus_dev_print(Monitor
*mon
, DeviceState
*qdev
, int indent
);
823 static Property virtser_props
[] = {
824 DEFINE_PROP_UINT32("nr", VirtIOSerialPort
, id
, VIRTIO_CONSOLE_BAD_ID
),
825 DEFINE_PROP_STRING("name", VirtIOSerialPort
, name
),
826 DEFINE_PROP_END_OF_LIST()
829 #define TYPE_VIRTIO_SERIAL_BUS "virtio-serial-bus"
830 #define VIRTIO_SERIAL_BUS(obj) \
831 OBJECT_CHECK(VirtIOSerialBus, (obj), TYPE_VIRTIO_SERIAL_BUS)
833 static void virtser_bus_class_init(ObjectClass
*klass
, void *data
)
835 BusClass
*k
= BUS_CLASS(klass
);
836 k
->print_dev
= virtser_bus_dev_print
;
839 static const TypeInfo virtser_bus_info
= {
840 .name
= TYPE_VIRTIO_SERIAL_BUS
,
842 .instance_size
= sizeof(VirtIOSerialBus
),
843 .class_init
= virtser_bus_class_init
,
846 static void virtser_bus_dev_print(Monitor
*mon
, DeviceState
*qdev
, int indent
)
848 VirtIOSerialPort
*port
= VIRTIO_SERIAL_PORT(qdev
);
850 monitor_printf(mon
, "%*sport %d, guest %s, host %s, throttle %s\n",
851 indent
, "", port
->id
,
852 port
->guest_connected
? "on" : "off",
853 port
->host_connected
? "on" : "off",
854 port
->throttled
? "on" : "off");
857 /* This function is only used if a port id is not provided by the user */
858 static uint32_t find_free_port_id(VirtIOSerial
*vser
)
860 unsigned int i
, max_nr_ports
;
862 max_nr_ports
= vser
->serial
.max_virtserial_ports
;
863 for (i
= 0; i
< (max_nr_ports
+ 31) / 32; i
++) {
864 uint32_t map
, zeroes
;
866 map
= vser
->ports_map
[i
];
867 zeroes
= ctz32(~map
);
869 return zeroes
+ i
* 32;
872 return VIRTIO_CONSOLE_BAD_ID
;
875 static void mark_port_added(VirtIOSerial
*vser
, uint32_t port_id
)
880 vser
->ports_map
[i
] |= 1U << (port_id
% 32);
883 static void add_port(VirtIOSerial
*vser
, uint32_t port_id
)
885 mark_port_added(vser
, port_id
);
886 send_control_event(vser
, port_id
, VIRTIO_CONSOLE_PORT_ADD
, 1);
889 static void remove_port(VirtIOSerial
*vser
, uint32_t port_id
)
891 VirtIOSerialPort
*port
;
894 * Don't mark port 0 removed -- we explicitly reserve it for
895 * backward compat with older guests, ensure a virtconsole device
896 * unplug retains the reservation.
902 vser
->ports_map
[i
] &= ~(1U << (port_id
% 32));
905 port
= find_port_by_id(vser
, port_id
);
907 * This function is only called from qdev's unplug callback; if we
908 * get a NULL port here, we're in trouble.
912 /* Flush out any unconsumed buffers first */
913 discard_throttle_data(port
);
914 discard_vq_data(port
->ovq
, VIRTIO_DEVICE(port
->vser
));
916 send_control_event(vser
, port
->id
, VIRTIO_CONSOLE_PORT_REMOVE
, 1);
919 static void virtser_port_device_realize(DeviceState
*dev
, Error
**errp
)
921 VirtIOSerialPort
*port
= VIRTIO_SERIAL_PORT(dev
);
922 VirtIOSerialPortClass
*vsc
= VIRTIO_SERIAL_PORT_GET_CLASS(port
);
923 VirtIOSerialBus
*bus
= VIRTIO_SERIAL_BUS(qdev_get_parent_bus(dev
));
928 port
->vser
= bus
->vser
;
929 port
->bh
= qemu_bh_new(flush_queued_data_bh
, port
);
931 assert(vsc
->have_data
);
934 * Is the first console port we're seeing? If so, put it up at
935 * location 0. This is done for backward compatibility (old
938 plugging_port0
= vsc
->is_console
&& !find_port_by_id(port
->vser
, 0);
940 if (find_port_by_id(port
->vser
, port
->id
)) {
941 error_setg(errp
, "virtio-serial-bus: A port already exists at id %u",
946 if (port
->name
!= NULL
&& find_port_by_name(port
->name
)) {
947 error_setg(errp
, "virtio-serial-bus: A port already exists by name %s",
952 if (port
->id
== VIRTIO_CONSOLE_BAD_ID
) {
953 if (plugging_port0
) {
956 port
->id
= find_free_port_id(port
->vser
);
957 if (port
->id
== VIRTIO_CONSOLE_BAD_ID
) {
958 error_setg(errp
, "virtio-serial-bus: Maximum port limit for "
959 "this device reached");
965 max_nr_ports
= port
->vser
->serial
.max_virtserial_ports
;
966 if (port
->id
>= max_nr_ports
) {
967 error_setg(errp
, "virtio-serial-bus: Out-of-range port id specified, "
968 "max. allowed: %u", max_nr_ports
- 1);
972 vsc
->realize(dev
, &err
);
974 error_propagate(errp
, err
);
981 static void virtser_port_device_plug(HotplugHandler
*hotplug_dev
,
982 DeviceState
*dev
, Error
**errp
)
984 VirtIOSerialPort
*port
= VIRTIO_SERIAL_PORT(dev
);
986 QTAILQ_INSERT_TAIL(&port
->vser
->ports
, port
, next
);
987 port
->ivq
= port
->vser
->ivqs
[port
->id
];
988 port
->ovq
= port
->vser
->ovqs
[port
->id
];
990 add_port(port
->vser
, port
->id
);
992 /* Send an update to the guest about this new port added */
993 virtio_notify_config(VIRTIO_DEVICE(hotplug_dev
));
996 static void virtser_port_device_unrealize(DeviceState
*dev
, Error
**errp
)
998 VirtIOSerialPort
*port
= VIRTIO_SERIAL_PORT(dev
);
999 VirtIOSerialPortClass
*vsc
= VIRTIO_SERIAL_PORT_GET_CLASS(dev
);
1000 VirtIOSerial
*vser
= port
->vser
;
1002 qemu_bh_delete(port
->bh
);
1003 remove_port(port
->vser
, port
->id
);
1005 QTAILQ_REMOVE(&vser
->ports
, port
, next
);
1007 if (vsc
->unrealize
) {
1008 vsc
->unrealize(dev
, errp
);
1012 static void virtio_serial_device_realize(DeviceState
*dev
, Error
**errp
)
1014 VirtIODevice
*vdev
= VIRTIO_DEVICE(dev
);
1015 VirtIOSerial
*vser
= VIRTIO_SERIAL(dev
);
1016 uint32_t i
, max_supported_ports
;
1017 size_t config_size
= sizeof(struct virtio_console_config
);
1019 if (!vser
->serial
.max_virtserial_ports
) {
1020 error_setg(errp
, "Maximum number of serial ports not specified");
1024 /* Each port takes 2 queues, and one pair is for the control queue */
1025 max_supported_ports
= VIRTIO_QUEUE_MAX
/ 2 - 1;
1027 if (vser
->serial
.max_virtserial_ports
> max_supported_ports
) {
1028 error_setg(errp
, "maximum ports supported: %u", max_supported_ports
);
1032 if (!virtio_has_feature(vser
->host_features
,
1033 VIRTIO_CONSOLE_F_EMERG_WRITE
)) {
1034 config_size
= offsetof(struct virtio_console_config
, emerg_wr
);
1036 virtio_init(vdev
, "virtio-serial", VIRTIO_ID_CONSOLE
,
1039 /* Spawn a new virtio-serial bus on which the ports will ride as devices */
1040 qbus_create_inplace(&vser
->bus
, sizeof(vser
->bus
), TYPE_VIRTIO_SERIAL_BUS
,
1041 dev
, vdev
->bus_name
);
1042 qbus_set_hotplug_handler(BUS(&vser
->bus
), DEVICE(vser
), errp
);
1043 vser
->bus
.vser
= vser
;
1044 QTAILQ_INIT(&vser
->ports
);
1046 vser
->bus
.max_nr_ports
= vser
->serial
.max_virtserial_ports
;
1047 vser
->ivqs
= g_malloc(vser
->serial
.max_virtserial_ports
1048 * sizeof(VirtQueue
*));
1049 vser
->ovqs
= g_malloc(vser
->serial
.max_virtserial_ports
1050 * sizeof(VirtQueue
*));
1052 /* Add a queue for host to guest transfers for port 0 (backward compat) */
1053 vser
->ivqs
[0] = virtio_add_queue(vdev
, 128, handle_input
);
1054 /* Add a queue for guest to host transfers for port 0 (backward compat) */
1055 vser
->ovqs
[0] = virtio_add_queue(vdev
, 128, handle_output
);
1057 /* TODO: host to guest notifications can get dropped
1058 * if the queue fills up. Implement queueing in host,
1059 * this might also make it possible to reduce the control
1060 * queue size: as guest preposts buffers there,
1061 * this will save 4Kbyte of guest memory per entry. */
1063 /* control queue: host to guest */
1064 vser
->c_ivq
= virtio_add_queue(vdev
, 32, control_in
);
1065 /* control queue: guest to host */
1066 vser
->c_ovq
= virtio_add_queue(vdev
, 32, control_out
);
1068 for (i
= 1; i
< vser
->bus
.max_nr_ports
; i
++) {
1069 /* Add a per-port queue for host to guest transfers */
1070 vser
->ivqs
[i
] = virtio_add_queue(vdev
, 128, handle_input
);
1071 /* Add a per-per queue for guest to host transfers */
1072 vser
->ovqs
[i
] = virtio_add_queue(vdev
, 128, handle_output
);
1075 vser
->ports_map
= g_malloc0(((vser
->serial
.max_virtserial_ports
+ 31) / 32)
1076 * sizeof(vser
->ports_map
[0]));
1078 * Reserve location 0 for a console port for backward compat
1079 * (old kernel, new qemu)
1081 mark_port_added(vser
, 0);
1083 vser
->post_load
= NULL
;
1085 QLIST_INSERT_HEAD(&vserdevices
.devices
, vser
, next
);
1088 static void virtio_serial_port_class_init(ObjectClass
*klass
, void *data
)
1090 DeviceClass
*k
= DEVICE_CLASS(klass
);
1092 set_bit(DEVICE_CATEGORY_INPUT
, k
->categories
);
1093 k
->bus_type
= TYPE_VIRTIO_SERIAL_BUS
;
1094 k
->realize
= virtser_port_device_realize
;
1095 k
->unrealize
= virtser_port_device_unrealize
;
1096 k
->props
= virtser_props
;
1099 static const TypeInfo virtio_serial_port_type_info
= {
1100 .name
= TYPE_VIRTIO_SERIAL_PORT
,
1101 .parent
= TYPE_DEVICE
,
1102 .instance_size
= sizeof(VirtIOSerialPort
),
1104 .class_size
= sizeof(VirtIOSerialPortClass
),
1105 .class_init
= virtio_serial_port_class_init
,
1108 static void virtio_serial_device_unrealize(DeviceState
*dev
, Error
**errp
)
1110 VirtIODevice
*vdev
= VIRTIO_DEVICE(dev
);
1111 VirtIOSerial
*vser
= VIRTIO_SERIAL(dev
);
1113 QLIST_REMOVE(vser
, next
);
1117 g_free(vser
->ports_map
);
1118 if (vser
->post_load
) {
1119 g_free(vser
->post_load
->connected
);
1120 timer_del(vser
->post_load
->timer
);
1121 timer_free(vser
->post_load
->timer
);
1122 g_free(vser
->post_load
);
1124 virtio_cleanup(vdev
);
1127 /* Note: 'console' is used for backwards compatibility */
1128 static const VMStateDescription vmstate_virtio_console
= {
1129 .name
= "virtio-console",
1130 .minimum_version_id
= 3,
1132 .fields
= (VMStateField
[]) {
1133 VMSTATE_VIRTIO_DEVICE
,
1134 VMSTATE_END_OF_LIST()
1138 static Property virtio_serial_properties
[] = {
1139 DEFINE_PROP_UINT32("max_ports", VirtIOSerial
, serial
.max_virtserial_ports
,
1141 DEFINE_PROP_BIT64("emergency-write", VirtIOSerial
, host_features
,
1142 VIRTIO_CONSOLE_F_EMERG_WRITE
, true),
1143 DEFINE_PROP_END_OF_LIST(),
1146 static void virtio_serial_class_init(ObjectClass
*klass
, void *data
)
1148 DeviceClass
*dc
= DEVICE_CLASS(klass
);
1149 VirtioDeviceClass
*vdc
= VIRTIO_DEVICE_CLASS(klass
);
1150 HotplugHandlerClass
*hc
= HOTPLUG_HANDLER_CLASS(klass
);
1152 QLIST_INIT(&vserdevices
.devices
);
1154 dc
->props
= virtio_serial_properties
;
1155 dc
->vmsd
= &vmstate_virtio_console
;
1156 set_bit(DEVICE_CATEGORY_INPUT
, dc
->categories
);
1157 vdc
->realize
= virtio_serial_device_realize
;
1158 vdc
->unrealize
= virtio_serial_device_unrealize
;
1159 vdc
->get_features
= get_features
;
1160 vdc
->get_config
= get_config
;
1161 vdc
->set_config
= set_config
;
1162 vdc
->set_status
= set_status
;
1163 vdc
->reset
= vser_reset
;
1164 vdc
->save
= virtio_serial_save_device
;
1165 vdc
->load
= virtio_serial_load_device
;
1166 hc
->plug
= virtser_port_device_plug
;
1167 hc
->unplug
= qdev_simple_device_unplug_cb
;
1170 static const TypeInfo virtio_device_info
= {
1171 .name
= TYPE_VIRTIO_SERIAL
,
1172 .parent
= TYPE_VIRTIO_DEVICE
,
1173 .instance_size
= sizeof(VirtIOSerial
),
1174 .class_init
= virtio_serial_class_init
,
1175 .interfaces
= (InterfaceInfo
[]) {
1176 { TYPE_HOTPLUG_HANDLER
},
1181 static void virtio_serial_register_types(void)
1183 type_register_static(&virtser_bus_info
);
1184 type_register_static(&virtio_serial_port_type_info
);
1185 type_register_static(&virtio_device_info
);
1188 type_init(virtio_serial_register_types
)