2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2016 iXsystems Inc.
7 * This software was developed by Jakub Klama <jceel@FreeBSD.org>
8 * under sponsorship from iXsystems Inc.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer
15 * in this position and unchanged.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
36 #include <sys/param.h>
37 #ifndef WITHOUT_CAPSICUM
38 #include <sys/capsicum.h>
40 #include <sys/linker_set.h>
42 #include <sys/types.h>
43 #include <sys/socket.h>
46 #ifndef WITHOUT_CAPSICUM
47 #include <capsicum_helpers.h>
68 #include "sockstream.h"
70 #define VTCON_RINGSZ 64
71 #define VTCON_MAXPORTS 16
72 #define VTCON_MAXQ (VTCON_MAXPORTS * 2 + 2)
74 #define VTCON_DEVICE_READY 0
75 #define VTCON_DEVICE_ADD 1
76 #define VTCON_DEVICE_REMOVE 2
77 #define VTCON_PORT_READY 3
78 #define VTCON_CONSOLE_PORT 4
79 #define VTCON_CONSOLE_RESIZE 5
80 #define VTCON_PORT_OPEN 6
81 #define VTCON_PORT_NAME 7
83 #define VTCON_F_SIZE 0
84 #define VTCON_F_MULTIPORT 1
85 #define VTCON_F_EMERG_WRITE 2
86 #define VTCON_S_HOSTCAPS \
87 (VTCON_F_SIZE | VTCON_F_MULTIPORT | VTCON_F_EMERG_WRITE)
89 static int pci_vtcon_debug;
90 #define DPRINTF(params) if (pci_vtcon_debug) PRINTLN params
91 #define WPRINTF(params) PRINTLN params
93 struct pci_vtcon_softc;
94 struct pci_vtcon_port;
95 struct pci_vtcon_config;
96 typedef void (pci_vtcon_cb_t)(struct pci_vtcon_port *, void *, struct iovec *,
99 struct pci_vtcon_port {
100 struct pci_vtcon_softc * vsp_sc;
102 const char * vsp_name;
110 pci_vtcon_cb_t * vsp_cb;
113 struct pci_vtcon_sock
115 struct pci_vtcon_port * vss_port;
116 const char * vss_path;
117 struct mevent * vss_server_evp;
118 struct mevent * vss_conn_evp;
124 struct pci_vtcon_softc {
125 struct virtio_softc vsc_vs;
126 struct vqueue_info vsc_queues[VTCON_MAXQ];
127 pthread_mutex_t vsc_mtx;
129 uint64_t vsc_features;
133 struct pci_vtcon_port vsc_control_port;
134 struct pci_vtcon_port vsc_ports[VTCON_MAXPORTS];
135 struct pci_vtcon_config *vsc_config;
138 struct pci_vtcon_config {
141 uint32_t max_nr_ports;
143 } __attribute__((packed));
145 struct pci_vtcon_control {
149 } __attribute__((packed));
151 struct pci_vtcon_console_resize {
154 } __attribute__((packed));
156 static void pci_vtcon_reset(void *);
157 static void pci_vtcon_notify_rx(void *, struct vqueue_info *);
158 static void pci_vtcon_notify_tx(void *, struct vqueue_info *);
159 static int pci_vtcon_cfgread(void *, int, int, uint32_t *);
160 static int pci_vtcon_cfgwrite(void *, int, int, uint32_t);
161 static void pci_vtcon_neg_features(void *, uint64_t);
162 static void pci_vtcon_sock_accept(int, enum ev_type, void *);
163 static void pci_vtcon_sock_rx(int, enum ev_type, void *);
164 static void pci_vtcon_sock_tx(struct pci_vtcon_port *, void *, struct iovec *,
166 static void pci_vtcon_control_send(struct pci_vtcon_softc *,
167 struct pci_vtcon_control *, const void *, size_t);
168 static void pci_vtcon_announce_port(struct pci_vtcon_port *);
169 static void pci_vtcon_open_port(struct pci_vtcon_port *, bool);
171 static struct virtio_consts vtcon_vi_consts = {
172 "vtcon", /* our name */
173 VTCON_MAXQ, /* we support VTCON_MAXQ virtqueues */
174 sizeof(struct pci_vtcon_config), /* config reg size */
175 pci_vtcon_reset, /* reset */
176 NULL, /* device-wide qnotify */
177 pci_vtcon_cfgread, /* read virtio config */
178 pci_vtcon_cfgwrite, /* write virtio config */
179 pci_vtcon_neg_features, /* apply negotiated features */
180 VTCON_S_HOSTCAPS, /* our capabilities */
185 pci_vtcon_reset(void *vsc)
187 struct pci_vtcon_softc *sc;
191 DPRINTF(("vtcon: device reset requested!"));
192 vi_reset_dev(&sc->vsc_vs);
196 pci_vtcon_neg_features(void *vsc, uint64_t negotiated_features)
198 struct pci_vtcon_softc *sc = vsc;
200 sc->vsc_features = negotiated_features;
204 pci_vtcon_cfgread(void *vsc, int offset, int size, uint32_t *retval)
206 struct pci_vtcon_softc *sc = vsc;
209 ptr = (uint8_t *)sc->vsc_config + offset;
210 memcpy(retval, ptr, size);
215 pci_vtcon_cfgwrite(void *vsc, int offset, int size, uint32_t val)
221 static inline struct pci_vtcon_port *
222 pci_vtcon_vq_to_port(struct pci_vtcon_softc *sc, struct vqueue_info *vq)
224 uint16_t num = vq->vq_num;
226 if (num == 0 || num == 1)
227 return (&sc->vsc_ports[0]);
229 if (num == 2 || num == 3)
230 return (&sc->vsc_control_port);
232 return (&sc->vsc_ports[(num / 2) - 1]);
235 static inline struct vqueue_info *
236 pci_vtcon_port_to_vq(struct pci_vtcon_port *port, bool tx_queue)
240 qnum = tx_queue ? port->vsp_txq : port->vsp_rxq;
241 return (&port->vsp_sc->vsc_queues[qnum]);
244 static struct pci_vtcon_port *
245 pci_vtcon_port_add(struct pci_vtcon_softc *sc, int port_id, const char *name,
246 pci_vtcon_cb_t *cb, void *arg)
248 struct pci_vtcon_port *port;
250 port = &sc->vsc_ports[port_id];
251 if (port->vsp_enabled) {
255 port->vsp_id = port_id;
257 port->vsp_name = name;
261 if (port->vsp_id == 0) {
266 port->vsp_txq = (port_id + 1) * 2;
267 port->vsp_rxq = port->vsp_txq + 1;
270 port->vsp_enabled = true;
275 pci_vtcon_sock_add(struct pci_vtcon_softc *sc, const char *port_name,
278 struct pci_vtcon_sock *sock;
279 struct sockaddr_un sun;
280 const char *name, *path;
283 int s = -1, fd = -1, error = 0;
284 #ifndef WITHOUT_CAPSICUM
288 port = strtol(port_name, &cp, 0);
289 if (*cp != '\0' || port < 0 || port >= VTCON_MAXPORTS) {
290 EPRINTLN("vtcon: Invalid port %s", port_name);
295 path = get_config_value_node(nvl, "path");
297 EPRINTLN("vtcon: required path missing for port %ld", port);
302 sock = calloc(1, sizeof(struct pci_vtcon_sock));
308 s = socket(AF_UNIX, SOCK_STREAM, 0);
314 pathcopy = strdup(path);
315 if (pathcopy == NULL) {
320 fd = open(dirname(pathcopy), O_RDONLY | O_DIRECTORY);
327 sun.sun_family = AF_UNIX;
328 sun.sun_len = sizeof(struct sockaddr_un);
329 strcpy(pathcopy, path);
330 strlcpy(sun.sun_path, basename(pathcopy), sizeof(sun.sun_path));
333 if (bindat(fd, s, (struct sockaddr *)&sun, sun.sun_len) < 0) {
338 if (fcntl(s, F_SETFL, O_NONBLOCK) < 0) {
343 if (listen(s, 1) < 0) {
348 #ifndef WITHOUT_CAPSICUM
349 cap_rights_init(&rights, CAP_ACCEPT, CAP_EVENT, CAP_READ, CAP_WRITE);
350 if (caph_rights_limit(s, &rights) == -1)
351 errx(EX_OSERR, "Unable to apply rights for sandbox");
354 name = get_config_value_node(nvl, "name");
356 EPRINTLN("vtcon: required name missing for port %ld", port);
360 sock->vss_port = pci_vtcon_port_add(sc, port, name, pci_vtcon_sock_tx, sock);
361 if (sock->vss_port == NULL) {
366 sock->vss_open = false;
367 sock->vss_conn_fd = -1;
368 sock->vss_server_fd = s;
369 sock->vss_server_evp = mevent_add(s, EVF_READ, pci_vtcon_sock_accept,
372 if (sock->vss_server_evp == NULL) {
391 pci_vtcon_sock_accept(int fd __unused, enum ev_type t __unused, void *arg)
393 struct pci_vtcon_sock *sock = (struct pci_vtcon_sock *)arg;
396 s = accept(sock->vss_server_fd, NULL, NULL);
400 if (sock->vss_open) {
405 sock->vss_open = true;
406 sock->vss_conn_fd = s;
407 sock->vss_conn_evp = mevent_add(s, EVF_READ, pci_vtcon_sock_rx, sock);
409 pci_vtcon_open_port(sock->vss_port, true);
413 pci_vtcon_sock_rx(int fd __unused, enum ev_type t __unused, void *arg)
415 struct pci_vtcon_port *port;
416 struct pci_vtcon_sock *sock = (struct pci_vtcon_sock *)arg;
417 struct vqueue_info *vq;
420 static char dummybuf[2048];
423 port = sock->vss_port;
424 vq = pci_vtcon_port_to_vq(port, true);
426 if (!sock->vss_open || !port->vsp_rx_ready) {
427 len = read(sock->vss_conn_fd, dummybuf, sizeof(dummybuf));
434 if (!vq_has_descs(vq)) {
435 len = read(sock->vss_conn_fd, dummybuf, sizeof(dummybuf));
444 n = vq_getchain(vq, &iov, 1, &req);
446 len = readv(sock->vss_conn_fd, &iov, n);
448 if (len == 0 || (len < 0 && errno == EWOULDBLOCK)) {
457 vq_relchain(vq, req.idx, len);
458 } while (vq_has_descs(vq));
463 mevent_delete_close(sock->vss_conn_evp);
464 sock->vss_conn_fd = -1;
465 sock->vss_open = false;
469 pci_vtcon_sock_tx(struct pci_vtcon_port *port, void *arg, struct iovec *iov,
472 struct pci_vtcon_sock *sock;
475 sock = (struct pci_vtcon_sock *)arg;
477 if (sock->vss_conn_fd == -1)
480 for (i = 0; i < niov; i++) {
481 ret = stream_write(sock->vss_conn_fd, iov[i].iov_base,
488 mevent_delete_close(sock->vss_conn_evp);
489 sock->vss_conn_fd = -1;
490 sock->vss_open = false;
495 pci_vtcon_control_tx(struct pci_vtcon_port *port, void *arg, struct iovec *iov,
498 struct pci_vtcon_softc *sc;
499 struct pci_vtcon_port *tmp;
500 struct pci_vtcon_control resp, *ctrl;
506 ctrl = (struct pci_vtcon_control *)iov->iov_base;
508 switch (ctrl->event) {
509 case VTCON_DEVICE_READY:
510 sc->vsc_ready = true;
511 /* set port ready events for registered ports */
512 for (i = 0; i < VTCON_MAXPORTS; i++) {
513 tmp = &sc->vsc_ports[i];
514 if (tmp->vsp_enabled)
515 pci_vtcon_announce_port(tmp);
518 pci_vtcon_open_port(tmp, true);
522 case VTCON_PORT_READY:
523 tmp = &sc->vsc_ports[ctrl->id];
524 if (ctrl->id >= VTCON_MAXPORTS || !tmp->vsp_enabled) {
525 WPRINTF(("VTCON_PORT_READY event for unknown port %d",
530 if (tmp->vsp_console) {
531 resp.event = VTCON_CONSOLE_PORT;
534 pci_vtcon_control_send(sc, &resp, NULL, 0);
541 pci_vtcon_announce_port(struct pci_vtcon_port *port)
543 struct pci_vtcon_control event;
545 event.id = port->vsp_id;
546 event.event = VTCON_DEVICE_ADD;
548 pci_vtcon_control_send(port->vsp_sc, &event, NULL, 0);
550 event.event = VTCON_PORT_NAME;
551 pci_vtcon_control_send(port->vsp_sc, &event, port->vsp_name,
552 strlen(port->vsp_name));
556 pci_vtcon_open_port(struct pci_vtcon_port *port, bool open)
558 struct pci_vtcon_control event;
560 if (!port->vsp_sc->vsc_ready) {
561 port->vsp_open = true;
565 event.id = port->vsp_id;
566 event.event = VTCON_PORT_OPEN;
567 event.value = (int)open;
568 pci_vtcon_control_send(port->vsp_sc, &event, NULL, 0);
572 pci_vtcon_control_send(struct pci_vtcon_softc *sc,
573 struct pci_vtcon_control *ctrl, const void *payload, size_t len)
575 struct vqueue_info *vq;
580 vq = pci_vtcon_port_to_vq(&sc->vsc_control_port, true);
582 if (!vq_has_descs(vq))
585 n = vq_getchain(vq, &iov, 1, &req);
588 memcpy(iov.iov_base, ctrl, sizeof(struct pci_vtcon_control));
589 if (payload != NULL && len > 0)
590 memcpy(iov.iov_base + sizeof(struct pci_vtcon_control),
593 vq_relchain(vq, req.idx, sizeof(struct pci_vtcon_control) + len);
599 pci_vtcon_notify_tx(void *vsc, struct vqueue_info *vq)
601 struct pci_vtcon_softc *sc;
602 struct pci_vtcon_port *port;
608 port = pci_vtcon_vq_to_port(sc, vq);
610 while (vq_has_descs(vq)) {
611 n = vq_getchain(vq, iov, 1, &req);
614 port->vsp_cb(port, port->vsp_arg, iov, 1);
617 * Release this chain and handle more
619 vq_relchain(vq, req.idx, 0);
621 vq_endchains(vq, 1); /* Generate interrupt if appropriate. */
625 pci_vtcon_notify_rx(void *vsc, struct vqueue_info *vq)
627 struct pci_vtcon_softc *sc;
628 struct pci_vtcon_port *port;
631 port = pci_vtcon_vq_to_port(sc, vq);
633 if (!port->vsp_rx_ready) {
634 port->vsp_rx_ready = 1;
640 * Each console device has a "port" node which contains nodes for
641 * each port. Ports are numbered starting at 0.
644 pci_vtcon_legacy_config_port(nvlist_t *nvl, int port, char *opt)
647 char node_name[sizeof("XX")];
650 name = strsep(&opt, "=");
653 EPRINTLN("vtcon: port %s requires a path", name);
656 if (port >= VTCON_MAXPORTS) {
657 EPRINTLN("vtcon: too many ports");
660 snprintf(node_name, sizeof(node_name), "%d", port);
661 port_nvl = create_relative_config_node(nvl, node_name);
662 set_config_value_node(port_nvl, "name", name);
663 set_config_value_node(port_nvl, "path", path);
668 pci_vtcon_legacy_config(nvlist_t *nvl, const char *opts)
670 char *opt, *str, *tofree;
674 ports_nvl = create_relative_config_node(nvl, "port");
675 tofree = str = strdup(opts);
678 while ((opt = strsep(&str, ",")) != NULL) {
679 error = pci_vtcon_legacy_config_port(ports_nvl, port, opt);
689 pci_vtcon_init(struct vmctx *ctx, struct pci_devinst *pi, nvlist_t *nvl)
691 struct pci_vtcon_softc *sc;
695 sc = calloc(1, sizeof(struct pci_vtcon_softc));
696 sc->vsc_config = calloc(1, sizeof(struct pci_vtcon_config));
697 sc->vsc_config->max_nr_ports = VTCON_MAXPORTS;
698 sc->vsc_config->cols = 80;
699 sc->vsc_config->rows = 25;
701 pthread_mutex_init(&sc->vsc_mtx, NULL);
703 vi_softc_linkup(&sc->vsc_vs, &vtcon_vi_consts, sc, pi, sc->vsc_queues);
704 sc->vsc_vs.vs_mtx = &sc->vsc_mtx;
706 for (i = 0; i < VTCON_MAXQ; i++) {
707 sc->vsc_queues[i].vq_qsize = VTCON_RINGSZ;
708 sc->vsc_queues[i].vq_notify = i % 2 == 0
709 ? pci_vtcon_notify_rx
710 : pci_vtcon_notify_tx;
713 /* initialize config space */
714 pci_set_cfgdata16(pi, PCIR_DEVICE, VIRTIO_DEV_CONSOLE);
715 pci_set_cfgdata16(pi, PCIR_VENDOR, VIRTIO_VENDOR);
716 pci_set_cfgdata8(pi, PCIR_CLASS, PCIC_SIMPLECOMM);
717 pci_set_cfgdata16(pi, PCIR_SUBDEV_0, VIRTIO_ID_CONSOLE);
718 pci_set_cfgdata16(pi, PCIR_SUBVEND_0, VIRTIO_VENDOR);
720 if (vi_intr_init(&sc->vsc_vs, 1, fbsdrun_virtio_msix()))
722 vi_set_io_bar(&sc->vsc_vs, 0);
724 /* create control port */
725 sc->vsc_control_port.vsp_sc = sc;
726 sc->vsc_control_port.vsp_txq = 2;
727 sc->vsc_control_port.vsp_rxq = 3;
728 sc->vsc_control_port.vsp_cb = pci_vtcon_control_tx;
729 sc->vsc_control_port.vsp_enabled = true;
731 ports_nvl = find_relative_config_node(nvl, "port");
732 if (ports_nvl != NULL) {
738 while ((name = nvlist_next(ports_nvl, &type, &cookie)) !=
740 if (type != NV_TYPE_NVLIST)
743 if (pci_vtcon_sock_add(sc, name,
744 nvlist_get_nvlist(ports_nvl, name)) < 0) {
745 EPRINTLN("cannot create port %s: %s",
746 name, strerror(errno));
755 struct pci_devemu pci_de_vcon = {
756 .pe_emu = "virtio-console",
757 .pe_init = pci_vtcon_init,
758 .pe_barwrite = vi_pci_write,
759 .pe_barread = vi_pci_read,
760 .pe_legacy_config = pci_vtcon_legacy_config,
762 PCI_EMUL_SET(pci_de_vcon);