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