xref: /freebsd/usr.sbin/bhyve/pci_virtio_console.c (revision 23648b7d730bcb5cd0ed1bc061ac18387545f814)
1 /*-
2  * Copyright (c) 2016 iXsystems Inc.
3  * All rights reserved.
4  *
5  * This software was developed by Jakub Klama <jceel@FreeBSD.org>
6  * under sponsorship from iXsystems Inc.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer
13  *    in this position and unchanged.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  */
30 
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
33 
34 #include <sys/param.h>
35 #include <sys/linker_set.h>
36 #include <sys/uio.h>
37 #include <sys/types.h>
38 #include <sys/socket.h>
39 #include <sys/un.h>
40 
41 #include <errno.h>
42 #include <fcntl.h>
43 #include <stdio.h>
44 #include <stdlib.h>
45 #include <stdbool.h>
46 #include <string.h>
47 #include <unistd.h>
48 #include <assert.h>
49 #include <pthread.h>
50 #include <libgen.h>
51 
52 #include "bhyverun.h"
53 #include "pci_emul.h"
54 #include "virtio.h"
55 #include "mevent.h"
56 
57 #define	VTCON_RINGSZ	64
58 #define	VTCON_MAXPORTS	16
59 #define	VTCON_MAXQ	(VTCON_MAXPORTS * 2 + 2)
60 
61 #define	VTCON_DEVICE_READY	0
62 #define	VTCON_DEVICE_ADD	1
63 #define	VTCON_DEVICE_REMOVE	2
64 #define	VTCON_PORT_READY	3
65 #define	VTCON_CONSOLE_PORT	4
66 #define	VTCON_CONSOLE_RESIZE	5
67 #define	VTCON_PORT_OPEN		6
68 #define	VTCON_PORT_NAME		7
69 
70 #define	VTCON_F_SIZE		0
71 #define	VTCON_F_MULTIPORT	1
72 #define	VTCON_F_EMERG_WRITE	2
73 #define	VTCON_S_HOSTCAPS	\
74     (VTCON_F_SIZE | VTCON_F_MULTIPORT | VTCON_F_EMERG_WRITE)
75 
76 static int pci_vtcon_debug;
77 #define DPRINTF(params) if (pci_vtcon_debug) printf params
78 #define WPRINTF(params) printf params
79 
80 struct pci_vtcon_softc;
81 struct pci_vtcon_port;
82 struct pci_vtcon_config;
83 typedef void (pci_vtcon_cb_t)(struct pci_vtcon_port *, void *, struct iovec *,
84     int);
85 
86 struct pci_vtcon_port {
87 	struct pci_vtcon_softc * vsp_sc;
88 	int                      vsp_id;
89 	const char *             vsp_name;
90 	bool                     vsp_enabled;
91 	bool                     vsp_console;
92 	bool                     vsp_rx_ready;
93 	int                      vsp_rxq;
94 	int                      vsp_txq;
95 	void *                   vsp_arg;
96 	pci_vtcon_cb_t *         vsp_cb;
97 };
98 
99 struct pci_vtcon_sock
100 {
101 	struct pci_vtcon_port *  vss_port;
102 	const char *             vss_path;
103 	struct mevent *          vss_server_evp;
104 	struct mevent *          vss_conn_evp;
105 	int                      vss_server_fd;
106 	int                      vss_conn_fd;
107 	bool                     vss_open;
108 };
109 
110 struct pci_vtcon_softc {
111 	struct virtio_softc      vsc_vs;
112 	struct vqueue_info       vsc_queues[VTCON_MAXQ];
113 	pthread_mutex_t          vsc_mtx;
114 	uint64_t                 vsc_cfg;
115 	uint64_t                 vsc_features;
116 	char *                   vsc_rootdir;
117 	int                      vsc_kq;
118 	int                      vsc_nports;
119 	struct pci_vtcon_port    vsc_control_port;
120  	struct pci_vtcon_port    vsc_ports[VTCON_MAXPORTS];
121 	struct pci_vtcon_config *vsc_config;
122 };
123 
124 struct pci_vtcon_config {
125 	uint16_t cols;
126 	uint16_t rows;
127 	uint32_t max_nr_ports;
128 	uint32_t emerg_wr;
129 } __attribute__((packed));
130 
131 struct pci_vtcon_control {
132 	uint32_t id;
133 	uint16_t event;
134 	uint16_t value;
135 } __attribute__((packed));
136 
137 struct pci_vtcon_console_resize {
138 	uint16_t cols;
139 	uint16_t rows;
140 } __attribute__((packed));
141 
142 static void pci_vtcon_reset(void *);
143 static void pci_vtcon_notify_rx(void *, struct vqueue_info *);
144 static void pci_vtcon_notify_tx(void *, struct vqueue_info *);
145 static int pci_vtcon_cfgread(void *, int, int, uint32_t *);
146 static int pci_vtcon_cfgwrite(void *, int, int, uint32_t);
147 static void pci_vtcon_neg_features(void *, uint64_t);
148 static void pci_vtcon_sock_accept(int, enum ev_type,  void *);
149 static void pci_vtcon_sock_rx(int, enum ev_type, void *);
150 static void pci_vtcon_sock_tx(struct pci_vtcon_port *, void *, struct iovec *,
151     int);
152 static void pci_vtcon_control_send(struct pci_vtcon_softc *,
153     struct pci_vtcon_control *, const void *, size_t);
154 static void pci_vtcon_announce_port(struct pci_vtcon_port *);
155 static void pci_vtcon_open_port(struct pci_vtcon_port *, bool);
156 
157 static struct virtio_consts vtcon_vi_consts = {
158 	"vtcon",		/* our name */
159 	VTCON_MAXQ,		/* we support VTCON_MAXQ virtqueues */
160 	sizeof(struct pci_vtcon_config), /* config reg size */
161 	pci_vtcon_reset,	/* reset */
162 	NULL,			/* device-wide qnotify */
163 	pci_vtcon_cfgread,	/* read virtio config */
164 	pci_vtcon_cfgwrite,	/* write virtio config */
165 	pci_vtcon_neg_features,	/* apply negotiated features */
166 	VTCON_S_HOSTCAPS,	/* our capabilities */
167 };
168 
169 
170 static void
171 pci_vtcon_reset(void *vsc)
172 {
173 	struct pci_vtcon_softc *sc;
174 
175 	sc = vsc;
176 
177 	DPRINTF(("vtcon: device reset requested!\n"));
178 	vi_reset_dev(&sc->vsc_vs);
179 }
180 
181 static void
182 pci_vtcon_neg_features(void *vsc, uint64_t negotiated_features)
183 {
184 	struct pci_vtcon_softc *sc = vsc;
185 
186 	sc->vsc_features = negotiated_features;
187 }
188 
189 static int
190 pci_vtcon_cfgread(void *vsc, int offset, int size, uint32_t *retval)
191 {
192 	struct pci_vtcon_softc *sc = vsc;
193 	void *ptr;
194 
195 	ptr = (uint8_t *)sc->vsc_config + offset;
196 	memcpy(retval, ptr, size);
197 	return (0);
198 }
199 
200 static int
201 pci_vtcon_cfgwrite(void *vsc, int offset, int size, uint32_t val)
202 {
203 
204 	return (0);
205 }
206 
207 static inline struct pci_vtcon_port *
208 pci_vtcon_vq_to_port(struct pci_vtcon_softc *sc, struct vqueue_info *vq)
209 {
210 	uint16_t num = vq->vq_num;
211 
212 	if (num == 0 || num == 1)
213 		return (&sc->vsc_ports[0]);
214 
215 	if (num == 2 || num == 3)
216 		return (&sc->vsc_control_port);
217 
218 	return (&sc->vsc_ports[(num / 2) - 1]);
219 }
220 
221 static inline struct vqueue_info *
222 pci_vtcon_port_to_vq(struct pci_vtcon_port *port, bool tx_queue)
223 {
224 	int qnum;
225 
226 	qnum = tx_queue ? port->vsp_txq : port->vsp_rxq;
227 	return (&port->vsp_sc->vsc_queues[qnum]);
228 }
229 
230 static struct pci_vtcon_port *
231 pci_vtcon_port_add(struct pci_vtcon_softc *sc, const char *name,
232     pci_vtcon_cb_t *cb, void *arg)
233 {
234 	struct pci_vtcon_port *port;
235 
236 	if (sc->vsc_nports == VTCON_MAXPORTS) {
237 		errno = EBUSY;
238 		return (NULL);
239 	}
240 
241 	port = &sc->vsc_ports[sc->vsc_nports++];
242 	port->vsp_id = sc->vsc_nports - 1;
243 	port->vsp_sc = sc;
244 	port->vsp_name = name;
245 	port->vsp_cb = cb;
246 	port->vsp_arg = arg;
247 
248 	if (port->vsp_id == 0) {
249 		/* port0 */
250 		port->vsp_txq = 0;
251 		port->vsp_rxq = 1;
252 	} else {
253 		port->vsp_txq = sc->vsc_nports * 2;
254 		port->vsp_rxq = port->vsp_txq + 1;
255 	}
256 
257 	port->vsp_enabled = true;
258 	return (port);
259 }
260 
261 static int
262 pci_vtcon_sock_add(struct pci_vtcon_softc *sc, const char *name,
263     const char *path)
264 {
265 	struct pci_vtcon_sock *sock;
266 	struct sockaddr_un sun;
267 	int s = -1, fd = -1, error = 0;
268 
269 	sock = calloc(1, sizeof(struct pci_vtcon_sock));
270 	if (sock == NULL) {
271 		error = -1;
272 		goto out;
273 	}
274 
275 	s = socket(AF_UNIX, SOCK_STREAM, 0);
276 	if (s < 0) {
277 		error = -1;
278 		goto out;
279 	}
280 
281 	fd = open(dirname(path), O_RDONLY | O_DIRECTORY);
282 	if (fd < 0) {
283 		error = -1;
284 		goto out;
285 	}
286 
287 	sun.sun_family = AF_UNIX;
288 	sun.sun_len = sizeof(struct sockaddr_un);
289 	strncpy(sun.sun_path, basename((char *)path), sizeof(sun.sun_path));
290 
291 	if (bindat(fd, s, (struct sockaddr *)&sun, sun.sun_len) < 0) {
292 		error = -1;
293 		goto out;
294 	}
295 
296 	if (fcntl(s, F_SETFL, O_NONBLOCK) < 0) {
297 		error = -1;
298 		goto out;
299 	}
300 
301 	if (listen(s, 1) < 0) {
302 		error = -1;
303 		goto out;
304 	}
305 
306 
307 	sock->vss_port = pci_vtcon_port_add(sc, name, pci_vtcon_sock_tx, sock);
308 	if (sock->vss_port == NULL) {
309 		error = -1;
310 		goto out;
311 	}
312 
313 	sock->vss_open = false;
314 	sock->vss_conn_fd = -1;
315 	sock->vss_server_fd = s;
316 	sock->vss_server_evp = mevent_add(s, EVF_READ, pci_vtcon_sock_accept,
317 	    sock);
318 
319 	if (sock->vss_server_evp == NULL) {
320 		error = -1;
321 		goto out;
322 	}
323 
324 out:
325 	if (fd != -1)
326 		close(fd);
327 
328 	if (error != 0 && s != -1)
329 		close(s);
330 
331 	return (error);
332 }
333 
334 static void
335 pci_vtcon_sock_accept(int fd __unused, enum ev_type t __unused, void *arg)
336 {
337 	struct pci_vtcon_sock *sock = (struct pci_vtcon_sock *)arg;
338 	int s;
339 
340 	s = accept(sock->vss_server_fd, NULL, NULL);
341 	if (s < 0)
342 		return;
343 
344 	if (sock->vss_open) {
345 		close(s);
346 		return;
347 	}
348 
349 	sock->vss_open = true;
350 	sock->vss_conn_fd = s;
351 	sock->vss_conn_evp = mevent_add(s, EVF_READ, pci_vtcon_sock_rx, sock);
352 	pci_vtcon_open_port(sock->vss_port, true);
353 }
354 
355 static void
356 pci_vtcon_sock_rx(int fd __unused, enum ev_type t __unused, void *arg)
357 {
358 	struct pci_vtcon_port *port;
359 	struct pci_vtcon_sock *sock = (struct pci_vtcon_sock *)arg;
360 	struct vqueue_info *vq;
361 	struct iovec iov;
362 	static char dummybuf[2048];
363 	int len, n;
364 	uint16_t idx;
365 
366 	port = sock->vss_port;
367 	vq = pci_vtcon_port_to_vq(port, true);
368 
369 	if (!sock->vss_open || !port->vsp_rx_ready) {
370 		len = read(sock->vss_conn_fd, dummybuf, sizeof(dummybuf));
371 		if (len == 0)
372 			goto close;
373 
374 		return;
375 	}
376 
377 	if (!vq_has_descs(vq)) {
378 		len = read(sock->vss_conn_fd, dummybuf, sizeof(dummybuf));
379 		vq_endchains(vq, 1);
380 		if (len == 0)
381 			goto close;
382 
383 		return;
384 	}
385 
386 	do {
387 		n = vq_getchain(vq, &idx, &iov, 1, NULL);
388 		len = readv(sock->vss_conn_fd, &iov, n);
389 
390 		if (len == 0 || (len < 0 && errno == EWOULDBLOCK)) {
391 			vq_retchain(vq);
392 			vq_endchains(vq, 0);
393 			if (len == 0)
394 				goto close;
395 
396 			return;
397 		}
398 
399 		vq_relchain(vq, idx, len);
400 	} while (vq_has_descs(vq));
401 
402 	vq_endchains(vq, 1);
403 
404 close:
405 	mevent_delete_close(sock->vss_conn_evp);
406 	sock->vss_conn_fd = -1;
407 	sock->vss_open = false;
408 }
409 
410 static void
411 pci_vtcon_sock_tx(struct pci_vtcon_port *port, void *arg, struct iovec *iov,
412     int niov)
413 {
414 	struct pci_vtcon_sock *sock;
415 	int ret;
416 
417 	sock = (struct pci_vtcon_sock *)arg;
418 
419 	if (sock->vss_conn_fd == -1)
420 		return;
421 
422 	ret = writev(sock->vss_conn_fd, iov, niov);
423 
424 	if (ret < 0 && errno != EWOULDBLOCK) {
425 		mevent_delete_close(sock->vss_conn_evp);
426 		sock->vss_conn_fd = -1;
427 		sock->vss_open = false;
428 	}
429 }
430 
431 static void
432 pci_vtcon_control_tx(struct pci_vtcon_port *port, void *arg, struct iovec *iov,
433     int niov)
434 {
435 	struct pci_vtcon_softc *sc;
436 	struct pci_vtcon_port *tmp;
437 	struct pci_vtcon_control resp, *ctrl;
438 	int i;
439 
440 	assert(niov == 1);
441 
442 	sc = port->vsp_sc;
443 	ctrl = (struct pci_vtcon_control *)iov->iov_base;
444 
445 	switch (ctrl->event) {
446 	case VTCON_DEVICE_READY:
447 		/* set port ready events for registered ports */
448 		for (i = 0; i < VTCON_MAXPORTS; i++) {
449 			tmp = &sc->vsc_ports[i];
450 			if (tmp->vsp_enabled)
451 				pci_vtcon_announce_port(tmp);
452 		}
453 		break;
454 
455 	case VTCON_PORT_READY:
456 		if (ctrl->id >= sc->vsc_nports) {
457 			WPRINTF(("VTCON_PORT_READY event for unknown port %d\n",
458 			    ctrl->id));
459 			return;
460 		}
461 
462 		tmp = &sc->vsc_ports[ctrl->id];
463 		if (tmp->vsp_console) {
464 			resp.event = VTCON_CONSOLE_PORT;
465 			resp.id = ctrl->id;
466 			resp.value = 1;
467 			pci_vtcon_control_send(sc, &resp, NULL, 0);
468 		}
469 		break;
470 	}
471 }
472 
473 static void
474 pci_vtcon_announce_port(struct pci_vtcon_port *port)
475 {
476 	struct pci_vtcon_control event;
477 
478 	event.id = port->vsp_id;
479 	event.event = VTCON_DEVICE_ADD;
480 	event.value = 1;
481 	pci_vtcon_control_send(port->vsp_sc, &event, NULL, 0);
482 
483 	event.event = VTCON_PORT_NAME;
484 	pci_vtcon_control_send(port->vsp_sc, &event, port->vsp_name,
485 	    strlen(port->vsp_name));
486 }
487 
488 static void
489 pci_vtcon_open_port(struct pci_vtcon_port *port, bool open)
490 {
491 	struct pci_vtcon_control event;
492 
493 	event.id = port->vsp_id;
494 	event.event = VTCON_PORT_OPEN;
495 	event.value = (int)open;
496 	pci_vtcon_control_send(port->vsp_sc, &event, NULL, 0);
497 }
498 
499 static void
500 pci_vtcon_control_send(struct pci_vtcon_softc *sc,
501     struct pci_vtcon_control *ctrl, const void *payload, size_t len)
502 {
503 	struct vqueue_info *vq;
504 	struct iovec iov;
505 	uint16_t idx;
506 	int n;
507 
508 	vq = pci_vtcon_port_to_vq(&sc->vsc_control_port, true);
509 
510 	if (!vq_has_descs(vq))
511 		return;
512 
513 	n = vq_getchain(vq, &idx, &iov, 1, NULL);
514 
515 	assert(n == 1);
516 
517 	memcpy(iov.iov_base, ctrl, sizeof(struct pci_vtcon_control));
518 	if (payload != NULL && len > 0)
519 		memcpy(iov.iov_base + sizeof(struct pci_vtcon_control),
520 		     payload, len);
521 
522 	vq_relchain(vq, idx, sizeof(struct pci_vtcon_control) + len);
523 	vq_endchains(vq, 1);
524 }
525 
526 
527 static void
528 pci_vtcon_notify_tx(void *vsc, struct vqueue_info *vq)
529 {
530 	struct pci_vtcon_softc *sc;
531 	struct pci_vtcon_port *port;
532 	struct iovec iov[1];
533 	uint16_t idx, n;
534 	uint16_t flags[8];
535 
536 	sc = vsc;
537 	port = pci_vtcon_vq_to_port(sc, vq);
538 
539 	while (vq_has_descs(vq)) {
540 		n = vq_getchain(vq, &idx, iov, 1, flags);
541 		if (port != NULL)
542 			port->vsp_cb(port, port->vsp_arg, iov, 1);
543 
544 		/*
545 		 * Release this chain and handle more
546 		 */
547 		vq_relchain(vq, idx, 0);
548 	}
549 	vq_endchains(vq, 1);	/* Generate interrupt if appropriate. */
550 }
551 
552 static void
553 pci_vtcon_notify_rx(void *vsc, struct vqueue_info *vq)
554 {
555 	struct pci_vtcon_softc *sc;
556 	struct pci_vtcon_port *port;
557 
558 	sc = vsc;
559 	port = pci_vtcon_vq_to_port(sc, vq);
560 
561 	if (!port->vsp_rx_ready) {
562 		port->vsp_rx_ready = 1;
563 		vq->vq_used->vu_flags |= VRING_USED_F_NO_NOTIFY;
564 	}
565 }
566 
567 static int
568 pci_vtcon_init(struct vmctx *ctx, struct pci_devinst *pi, char *opts)
569 {
570 	struct pci_vtcon_softc *sc;
571 	char *portname = NULL;
572 	char *portpath = NULL;
573 	char *opt;
574 	int i;
575 
576 	sc = calloc(1, sizeof(struct pci_vtcon_softc));
577 	sc->vsc_config = calloc(1, sizeof(struct pci_vtcon_config));
578 	sc->vsc_config->max_nr_ports = VTCON_MAXPORTS;
579 	sc->vsc_config->cols = 80;
580 	sc->vsc_config->rows = 25;
581 
582 	vi_softc_linkup(&sc->vsc_vs, &vtcon_vi_consts, sc, pi, sc->vsc_queues);
583 	sc->vsc_vs.vs_mtx = &sc->vsc_mtx;
584 
585 	for (i = 0; i < VTCON_MAXQ; i++) {
586 		sc->vsc_queues[i].vq_qsize = VTCON_RINGSZ;
587 		sc->vsc_queues[i].vq_notify = i % 2 == 0
588 		    ? pci_vtcon_notify_rx
589 		    : pci_vtcon_notify_tx;
590 	}
591 
592 	/* initialize config space */
593 	pci_set_cfgdata16(pi, PCIR_DEVICE, VIRTIO_DEV_CONSOLE);
594 	pci_set_cfgdata16(pi, PCIR_VENDOR, VIRTIO_VENDOR);
595 	pci_set_cfgdata8(pi, PCIR_CLASS, PCIC_SIMPLECOMM);
596 	pci_set_cfgdata16(pi, PCIR_SUBDEV_0, VIRTIO_TYPE_CONSOLE);
597 	pci_set_cfgdata16(pi, PCIR_SUBVEND_0, VIRTIO_VENDOR);
598 
599 	if (vi_intr_init(&sc->vsc_vs, 1, fbsdrun_virtio_msix()))
600 		return (1);
601 	vi_set_io_bar(&sc->vsc_vs, 0);
602 
603 	/* create control port */
604 	sc->vsc_control_port.vsp_sc = sc;
605 	sc->vsc_control_port.vsp_txq = 2;
606 	sc->vsc_control_port.vsp_rxq = 3;
607 	sc->vsc_control_port.vsp_cb = pci_vtcon_control_tx;
608 	sc->vsc_control_port.vsp_enabled = true;
609 
610 	while ((opt = strsep(&opts, ",")) != NULL) {
611 		portname = strsep(&opt, "=");
612 		portpath = strdup(opt);
613 
614 		/* create port */
615 		if (pci_vtcon_sock_add(sc, portname, portpath) < 0) {
616 			fprintf(stderr, "cannot create port %s: %s\n",
617 			    portname, strerror(errno));
618 			return (1);
619 		}
620 	}
621 
622 	return (0);
623 }
624 
625 struct pci_devemu pci_de_vcon = {
626 	.pe_emu =	"virtio-console",
627 	.pe_init =	pci_vtcon_init,
628 	.pe_barwrite =	vi_pci_write,
629 	.pe_barread =	vi_pci_read
630 };
631 PCI_EMUL_SET(pci_de_vcon);
632