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>
67 #include "sockstream.h"
69 #define VTCON_RINGSZ 64
70 #define VTCON_MAXPORTS 16
71 #define VTCON_MAXQ (VTCON_MAXPORTS * 2 + 2)
73 #define VTCON_DEVICE_READY 0
74 #define VTCON_DEVICE_ADD 1
75 #define VTCON_DEVICE_REMOVE 2
76 #define VTCON_PORT_READY 3
77 #define VTCON_CONSOLE_PORT 4
78 #define VTCON_CONSOLE_RESIZE 5
79 #define VTCON_PORT_OPEN 6
80 #define VTCON_PORT_NAME 7
82 #define VTCON_F_SIZE 0
83 #define VTCON_F_MULTIPORT 1
84 #define VTCON_F_EMERG_WRITE 2
85 #define VTCON_S_HOSTCAPS \
86 (VTCON_F_SIZE | VTCON_F_MULTIPORT | VTCON_F_EMERG_WRITE)
88 static int pci_vtcon_debug;
89 #define DPRINTF(params) if (pci_vtcon_debug) PRINTLN params
90 #define WPRINTF(params) PRINTLN params
92 struct pci_vtcon_softc;
93 struct pci_vtcon_port;
94 struct pci_vtcon_config;
95 typedef void (pci_vtcon_cb_t)(struct pci_vtcon_port *, void *, struct iovec *,
98 struct pci_vtcon_port {
99 struct pci_vtcon_softc * vsp_sc;
101 const char * vsp_name;
109 pci_vtcon_cb_t * vsp_cb;
112 struct pci_vtcon_sock
114 struct pci_vtcon_port * vss_port;
115 const char * vss_path;
116 struct mevent * vss_server_evp;
117 struct mevent * vss_conn_evp;
123 struct pci_vtcon_softc {
124 struct virtio_softc vsc_vs;
125 struct vqueue_info vsc_queues[VTCON_MAXQ];
126 pthread_mutex_t vsc_mtx;
128 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, const char *name,
246 pci_vtcon_cb_t *cb, void *arg)
248 struct pci_vtcon_port *port;
250 if (sc->vsc_nports == VTCON_MAXPORTS) {
255 port = &sc->vsc_ports[sc->vsc_nports++];
256 port->vsp_id = sc->vsc_nports - 1;
258 port->vsp_name = name;
262 if (port->vsp_id == 0) {
267 port->vsp_txq = sc->vsc_nports * 2;
268 port->vsp_rxq = port->vsp_txq + 1;
271 port->vsp_enabled = true;
276 pci_vtcon_sock_add(struct pci_vtcon_softc *sc, const char *name,
279 struct pci_vtcon_sock *sock;
280 struct sockaddr_un sun;
282 int s = -1, fd = -1, error = 0;
283 #ifndef WITHOUT_CAPSICUM
287 sock = calloc(1, sizeof(struct pci_vtcon_sock));
293 s = socket(AF_UNIX, SOCK_STREAM, 0);
299 pathcopy = strdup(path);
300 if (pathcopy == NULL) {
305 fd = open(dirname(pathcopy), O_RDONLY | O_DIRECTORY);
312 sun.sun_family = AF_UNIX;
313 sun.sun_len = sizeof(struct sockaddr_un);
314 strcpy(pathcopy, path);
315 strlcpy(sun.sun_path, basename(pathcopy), sizeof(sun.sun_path));
318 if (bindat(fd, s, (struct sockaddr *)&sun, sun.sun_len) < 0) {
323 if (fcntl(s, F_SETFL, O_NONBLOCK) < 0) {
328 if (listen(s, 1) < 0) {
333 #ifndef WITHOUT_CAPSICUM
334 cap_rights_init(&rights, CAP_ACCEPT, CAP_EVENT, CAP_READ, CAP_WRITE);
335 if (caph_rights_limit(s, &rights) == -1)
336 errx(EX_OSERR, "Unable to apply rights for sandbox");
339 sock->vss_port = pci_vtcon_port_add(sc, name, pci_vtcon_sock_tx, sock);
340 if (sock->vss_port == NULL) {
345 sock->vss_open = false;
346 sock->vss_conn_fd = -1;
347 sock->vss_server_fd = s;
348 sock->vss_server_evp = mevent_add(s, EVF_READ, pci_vtcon_sock_accept,
351 if (sock->vss_server_evp == NULL) {
370 pci_vtcon_sock_accept(int fd __unused, enum ev_type t __unused, void *arg)
372 struct pci_vtcon_sock *sock = (struct pci_vtcon_sock *)arg;
375 s = accept(sock->vss_server_fd, NULL, NULL);
379 if (sock->vss_open) {
384 sock->vss_open = true;
385 sock->vss_conn_fd = s;
386 sock->vss_conn_evp = mevent_add(s, EVF_READ, pci_vtcon_sock_rx, sock);
388 pci_vtcon_open_port(sock->vss_port, true);
392 pci_vtcon_sock_rx(int fd __unused, enum ev_type t __unused, void *arg)
394 struct pci_vtcon_port *port;
395 struct pci_vtcon_sock *sock = (struct pci_vtcon_sock *)arg;
396 struct vqueue_info *vq;
398 static char dummybuf[2048];
402 port = sock->vss_port;
403 vq = pci_vtcon_port_to_vq(port, true);
405 if (!sock->vss_open || !port->vsp_rx_ready) {
406 len = read(sock->vss_conn_fd, dummybuf, sizeof(dummybuf));
413 if (!vq_has_descs(vq)) {
414 len = read(sock->vss_conn_fd, dummybuf, sizeof(dummybuf));
423 n = vq_getchain(vq, &idx, &iov, 1, NULL);
424 len = readv(sock->vss_conn_fd, &iov, n);
426 if (len == 0 || (len < 0 && errno == EWOULDBLOCK)) {
435 vq_relchain(vq, idx, len);
436 } while (vq_has_descs(vq));
441 mevent_delete_close(sock->vss_conn_evp);
442 sock->vss_conn_fd = -1;
443 sock->vss_open = false;
447 pci_vtcon_sock_tx(struct pci_vtcon_port *port, void *arg, struct iovec *iov,
450 struct pci_vtcon_sock *sock;
453 sock = (struct pci_vtcon_sock *)arg;
455 if (sock->vss_conn_fd == -1)
458 for (i = 0; i < niov; i++) {
459 ret = stream_write(sock->vss_conn_fd, iov[i].iov_base,
466 mevent_delete_close(sock->vss_conn_evp);
467 sock->vss_conn_fd = -1;
468 sock->vss_open = false;
473 pci_vtcon_control_tx(struct pci_vtcon_port *port, void *arg, struct iovec *iov,
476 struct pci_vtcon_softc *sc;
477 struct pci_vtcon_port *tmp;
478 struct pci_vtcon_control resp, *ctrl;
484 ctrl = (struct pci_vtcon_control *)iov->iov_base;
486 switch (ctrl->event) {
487 case VTCON_DEVICE_READY:
488 sc->vsc_ready = true;
489 /* set port ready events for registered ports */
490 for (i = 0; i < VTCON_MAXPORTS; i++) {
491 tmp = &sc->vsc_ports[i];
492 if (tmp->vsp_enabled)
493 pci_vtcon_announce_port(tmp);
496 pci_vtcon_open_port(tmp, true);
500 case VTCON_PORT_READY:
501 if (ctrl->id >= sc->vsc_nports) {
502 WPRINTF(("VTCON_PORT_READY event for unknown port %d",
507 tmp = &sc->vsc_ports[ctrl->id];
508 if (tmp->vsp_console) {
509 resp.event = VTCON_CONSOLE_PORT;
512 pci_vtcon_control_send(sc, &resp, NULL, 0);
519 pci_vtcon_announce_port(struct pci_vtcon_port *port)
521 struct pci_vtcon_control event;
523 event.id = port->vsp_id;
524 event.event = VTCON_DEVICE_ADD;
526 pci_vtcon_control_send(port->vsp_sc, &event, NULL, 0);
528 event.event = VTCON_PORT_NAME;
529 pci_vtcon_control_send(port->vsp_sc, &event, port->vsp_name,
530 strlen(port->vsp_name));
534 pci_vtcon_open_port(struct pci_vtcon_port *port, bool open)
536 struct pci_vtcon_control event;
538 if (!port->vsp_sc->vsc_ready) {
539 port->vsp_open = true;
543 event.id = port->vsp_id;
544 event.event = VTCON_PORT_OPEN;
545 event.value = (int)open;
546 pci_vtcon_control_send(port->vsp_sc, &event, NULL, 0);
550 pci_vtcon_control_send(struct pci_vtcon_softc *sc,
551 struct pci_vtcon_control *ctrl, const void *payload, size_t len)
553 struct vqueue_info *vq;
558 vq = pci_vtcon_port_to_vq(&sc->vsc_control_port, true);
560 if (!vq_has_descs(vq))
563 n = vq_getchain(vq, &idx, &iov, 1, NULL);
567 memcpy(iov.iov_base, ctrl, sizeof(struct pci_vtcon_control));
568 if (payload != NULL && len > 0)
569 memcpy(iov.iov_base + sizeof(struct pci_vtcon_control),
572 vq_relchain(vq, idx, sizeof(struct pci_vtcon_control) + len);
578 pci_vtcon_notify_tx(void *vsc, struct vqueue_info *vq)
580 struct pci_vtcon_softc *sc;
581 struct pci_vtcon_port *port;
587 port = pci_vtcon_vq_to_port(sc, vq);
589 while (vq_has_descs(vq)) {
590 n = vq_getchain(vq, &idx, iov, 1, flags);
593 port->vsp_cb(port, port->vsp_arg, iov, 1);
596 * Release this chain and handle more
598 vq_relchain(vq, idx, 0);
600 vq_endchains(vq, 1); /* Generate interrupt if appropriate. */
604 pci_vtcon_notify_rx(void *vsc, struct vqueue_info *vq)
606 struct pci_vtcon_softc *sc;
607 struct pci_vtcon_port *port;
610 port = pci_vtcon_vq_to_port(sc, vq);
612 if (!port->vsp_rx_ready) {
613 port->vsp_rx_ready = 1;
619 pci_vtcon_init(struct vmctx *ctx, struct pci_devinst *pi, char *opts)
621 struct pci_vtcon_softc *sc;
622 char *portname = NULL;
623 char *portpath = NULL;
627 sc = calloc(1, sizeof(struct pci_vtcon_softc));
628 sc->vsc_config = calloc(1, sizeof(struct pci_vtcon_config));
629 sc->vsc_config->max_nr_ports = VTCON_MAXPORTS;
630 sc->vsc_config->cols = 80;
631 sc->vsc_config->rows = 25;
633 vi_softc_linkup(&sc->vsc_vs, &vtcon_vi_consts, sc, pi, sc->vsc_queues);
634 sc->vsc_vs.vs_mtx = &sc->vsc_mtx;
636 for (i = 0; i < VTCON_MAXQ; i++) {
637 sc->vsc_queues[i].vq_qsize = VTCON_RINGSZ;
638 sc->vsc_queues[i].vq_notify = i % 2 == 0
639 ? pci_vtcon_notify_rx
640 : pci_vtcon_notify_tx;
643 /* initialize config space */
644 pci_set_cfgdata16(pi, PCIR_DEVICE, VIRTIO_DEV_CONSOLE);
645 pci_set_cfgdata16(pi, PCIR_VENDOR, VIRTIO_VENDOR);
646 pci_set_cfgdata8(pi, PCIR_CLASS, PCIC_SIMPLECOMM);
647 pci_set_cfgdata16(pi, PCIR_SUBDEV_0, VIRTIO_TYPE_CONSOLE);
648 pci_set_cfgdata16(pi, PCIR_SUBVEND_0, VIRTIO_VENDOR);
650 if (vi_intr_init(&sc->vsc_vs, 1, fbsdrun_virtio_msix()))
652 vi_set_io_bar(&sc->vsc_vs, 0);
654 /* create control port */
655 sc->vsc_control_port.vsp_sc = sc;
656 sc->vsc_control_port.vsp_txq = 2;
657 sc->vsc_control_port.vsp_rxq = 3;
658 sc->vsc_control_port.vsp_cb = pci_vtcon_control_tx;
659 sc->vsc_control_port.vsp_enabled = true;
661 while ((opt = strsep(&opts, ",")) != NULL) {
662 portname = strsep(&opt, "=");
666 if (pci_vtcon_sock_add(sc, portname, portpath) < 0) {
667 EPRINTLN("cannot create port %s: %s",
668 portname, strerror(errno));
676 struct pci_devemu pci_de_vcon = {
677 .pe_emu = "virtio-console",
678 .pe_init = pci_vtcon_init,
679 .pe_barwrite = vi_pci_write,
680 .pe_barread = vi_pci_read
682 PCI_EMUL_SET(pci_de_vcon);