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>
63 #include "sockstream.h"
65 #define VTCON_RINGSZ 64
66 #define VTCON_MAXPORTS 16
67 #define VTCON_MAXQ (VTCON_MAXPORTS * 2 + 2)
69 #define VTCON_DEVICE_READY 0
70 #define VTCON_DEVICE_ADD 1
71 #define VTCON_DEVICE_REMOVE 2
72 #define VTCON_PORT_READY 3
73 #define VTCON_CONSOLE_PORT 4
74 #define VTCON_CONSOLE_RESIZE 5
75 #define VTCON_PORT_OPEN 6
76 #define VTCON_PORT_NAME 7
78 #define VTCON_F_SIZE 0
79 #define VTCON_F_MULTIPORT 1
80 #define VTCON_F_EMERG_WRITE 2
81 #define VTCON_S_HOSTCAPS \
82 (VTCON_F_SIZE | VTCON_F_MULTIPORT | VTCON_F_EMERG_WRITE)
84 static int pci_vtcon_debug;
85 #define DPRINTF(params) if (pci_vtcon_debug) printf params
86 #define WPRINTF(params) printf params
88 struct pci_vtcon_softc;
89 struct pci_vtcon_port;
90 struct pci_vtcon_config;
91 typedef void (pci_vtcon_cb_t)(struct pci_vtcon_port *, void *, struct iovec *,
94 struct pci_vtcon_port {
95 struct pci_vtcon_softc * vsp_sc;
97 const char * vsp_name;
105 pci_vtcon_cb_t * vsp_cb;
108 struct pci_vtcon_sock
110 struct pci_vtcon_port * vss_port;
111 const char * vss_path;
112 struct mevent * vss_server_evp;
113 struct mevent * vss_conn_evp;
119 struct pci_vtcon_softc {
120 struct virtio_softc vsc_vs;
121 struct vqueue_info vsc_queues[VTCON_MAXQ];
122 pthread_mutex_t vsc_mtx;
124 uint64_t vsc_features;
129 struct pci_vtcon_port vsc_control_port;
130 struct pci_vtcon_port vsc_ports[VTCON_MAXPORTS];
131 struct pci_vtcon_config *vsc_config;
134 struct pci_vtcon_config {
137 uint32_t max_nr_ports;
139 } __attribute__((packed));
141 struct pci_vtcon_control {
145 } __attribute__((packed));
147 struct pci_vtcon_console_resize {
150 } __attribute__((packed));
152 static void pci_vtcon_reset(void *);
153 static void pci_vtcon_notify_rx(void *, struct vqueue_info *);
154 static void pci_vtcon_notify_tx(void *, struct vqueue_info *);
155 static int pci_vtcon_cfgread(void *, int, int, uint32_t *);
156 static int pci_vtcon_cfgwrite(void *, int, int, uint32_t);
157 static void pci_vtcon_neg_features(void *, uint64_t);
158 static void pci_vtcon_sock_accept(int, enum ev_type, void *);
159 static void pci_vtcon_sock_rx(int, enum ev_type, void *);
160 static void pci_vtcon_sock_tx(struct pci_vtcon_port *, void *, struct iovec *,
162 static void pci_vtcon_control_send(struct pci_vtcon_softc *,
163 struct pci_vtcon_control *, const void *, size_t);
164 static void pci_vtcon_announce_port(struct pci_vtcon_port *);
165 static void pci_vtcon_open_port(struct pci_vtcon_port *, bool);
167 static struct virtio_consts vtcon_vi_consts = {
168 "vtcon", /* our name */
169 VTCON_MAXQ, /* we support VTCON_MAXQ virtqueues */
170 sizeof(struct pci_vtcon_config), /* config reg size */
171 pci_vtcon_reset, /* reset */
172 NULL, /* device-wide qnotify */
173 pci_vtcon_cfgread, /* read virtio config */
174 pci_vtcon_cfgwrite, /* write virtio config */
175 pci_vtcon_neg_features, /* apply negotiated features */
176 VTCON_S_HOSTCAPS, /* our capabilities */
181 pci_vtcon_reset(void *vsc)
183 struct pci_vtcon_softc *sc;
187 DPRINTF(("vtcon: device reset requested!\n"));
188 vi_reset_dev(&sc->vsc_vs);
192 pci_vtcon_neg_features(void *vsc, uint64_t negotiated_features)
194 struct pci_vtcon_softc *sc = vsc;
196 sc->vsc_features = negotiated_features;
200 pci_vtcon_cfgread(void *vsc, int offset, int size, uint32_t *retval)
202 struct pci_vtcon_softc *sc = vsc;
205 ptr = (uint8_t *)sc->vsc_config + offset;
206 memcpy(retval, ptr, size);
211 pci_vtcon_cfgwrite(void *vsc, int offset, int size, uint32_t val)
217 static inline struct pci_vtcon_port *
218 pci_vtcon_vq_to_port(struct pci_vtcon_softc *sc, struct vqueue_info *vq)
220 uint16_t num = vq->vq_num;
222 if (num == 0 || num == 1)
223 return (&sc->vsc_ports[0]);
225 if (num == 2 || num == 3)
226 return (&sc->vsc_control_port);
228 return (&sc->vsc_ports[(num / 2) - 1]);
231 static inline struct vqueue_info *
232 pci_vtcon_port_to_vq(struct pci_vtcon_port *port, bool tx_queue)
236 qnum = tx_queue ? port->vsp_txq : port->vsp_rxq;
237 return (&port->vsp_sc->vsc_queues[qnum]);
240 static struct pci_vtcon_port *
241 pci_vtcon_port_add(struct pci_vtcon_softc *sc, const char *name,
242 pci_vtcon_cb_t *cb, void *arg)
244 struct pci_vtcon_port *port;
246 if (sc->vsc_nports == VTCON_MAXPORTS) {
251 port = &sc->vsc_ports[sc->vsc_nports++];
252 port->vsp_id = sc->vsc_nports - 1;
254 port->vsp_name = name;
258 if (port->vsp_id == 0) {
263 port->vsp_txq = sc->vsc_nports * 2;
264 port->vsp_rxq = port->vsp_txq + 1;
267 port->vsp_enabled = true;
272 pci_vtcon_sock_add(struct pci_vtcon_softc *sc, const char *name,
275 struct pci_vtcon_sock *sock;
276 struct sockaddr_un sun;
278 int s = -1, fd = -1, error = 0;
279 #ifndef WITHOUT_CAPSICUM
283 sock = calloc(1, sizeof(struct pci_vtcon_sock));
289 s = socket(AF_UNIX, SOCK_STREAM, 0);
295 pathcopy = strdup(path);
296 if (pathcopy == NULL) {
301 fd = open(dirname(pathcopy), O_RDONLY | O_DIRECTORY);
308 sun.sun_family = AF_UNIX;
309 sun.sun_len = sizeof(struct sockaddr_un);
310 strcpy(pathcopy, path);
311 strlcpy(sun.sun_path, basename(pathcopy), sizeof(sun.sun_path));
314 if (bindat(fd, s, (struct sockaddr *)&sun, sun.sun_len) < 0) {
319 if (fcntl(s, F_SETFL, O_NONBLOCK) < 0) {
324 if (listen(s, 1) < 0) {
329 #ifndef WITHOUT_CAPSICUM
330 cap_rights_init(&rights, CAP_ACCEPT, CAP_EVENT, CAP_READ, CAP_WRITE);
331 if (cap_rights_limit(s, &rights) == -1 && errno != ENOSYS)
332 errx(EX_OSERR, "Unable to apply rights for sandbox");
335 sock->vss_port = pci_vtcon_port_add(sc, name, pci_vtcon_sock_tx, sock);
336 if (sock->vss_port == NULL) {
341 sock->vss_open = false;
342 sock->vss_conn_fd = -1;
343 sock->vss_server_fd = s;
344 sock->vss_server_evp = mevent_add(s, EVF_READ, pci_vtcon_sock_accept,
347 if (sock->vss_server_evp == NULL) {
356 if (error != 0 && s != -1)
363 pci_vtcon_sock_accept(int fd __unused, enum ev_type t __unused, void *arg)
365 struct pci_vtcon_sock *sock = (struct pci_vtcon_sock *)arg;
368 s = accept(sock->vss_server_fd, NULL, NULL);
372 if (sock->vss_open) {
377 sock->vss_open = true;
378 sock->vss_conn_fd = s;
379 sock->vss_conn_evp = mevent_add(s, EVF_READ, pci_vtcon_sock_rx, sock);
381 pci_vtcon_open_port(sock->vss_port, true);
385 pci_vtcon_sock_rx(int fd __unused, enum ev_type t __unused, void *arg)
387 struct pci_vtcon_port *port;
388 struct pci_vtcon_sock *sock = (struct pci_vtcon_sock *)arg;
389 struct vqueue_info *vq;
391 static char dummybuf[2048];
395 port = sock->vss_port;
396 vq = pci_vtcon_port_to_vq(port, true);
398 if (!sock->vss_open || !port->vsp_rx_ready) {
399 len = read(sock->vss_conn_fd, dummybuf, sizeof(dummybuf));
406 if (!vq_has_descs(vq)) {
407 len = read(sock->vss_conn_fd, dummybuf, sizeof(dummybuf));
416 n = vq_getchain(vq, &idx, &iov, 1, NULL);
417 len = readv(sock->vss_conn_fd, &iov, n);
419 if (len == 0 || (len < 0 && errno == EWOULDBLOCK)) {
428 vq_relchain(vq, idx, len);
429 } while (vq_has_descs(vq));
434 mevent_delete_close(sock->vss_conn_evp);
435 sock->vss_conn_fd = -1;
436 sock->vss_open = false;
440 pci_vtcon_sock_tx(struct pci_vtcon_port *port, void *arg, struct iovec *iov,
443 struct pci_vtcon_sock *sock;
446 sock = (struct pci_vtcon_sock *)arg;
448 if (sock->vss_conn_fd == -1)
451 for (i = 0; i < niov; i++) {
452 ret = stream_write(sock->vss_conn_fd, iov[i].iov_base,
459 mevent_delete_close(sock->vss_conn_evp);
460 sock->vss_conn_fd = -1;
461 sock->vss_open = false;
466 pci_vtcon_control_tx(struct pci_vtcon_port *port, void *arg, struct iovec *iov,
469 struct pci_vtcon_softc *sc;
470 struct pci_vtcon_port *tmp;
471 struct pci_vtcon_control resp, *ctrl;
477 ctrl = (struct pci_vtcon_control *)iov->iov_base;
479 switch (ctrl->event) {
480 case VTCON_DEVICE_READY:
481 sc->vsc_ready = true;
482 /* set port ready events for registered ports */
483 for (i = 0; i < VTCON_MAXPORTS; i++) {
484 tmp = &sc->vsc_ports[i];
485 if (tmp->vsp_enabled)
486 pci_vtcon_announce_port(tmp);
489 pci_vtcon_open_port(tmp, true);
493 case VTCON_PORT_READY:
494 if (ctrl->id >= sc->vsc_nports) {
495 WPRINTF(("VTCON_PORT_READY event for unknown port %d\n",
500 tmp = &sc->vsc_ports[ctrl->id];
501 if (tmp->vsp_console) {
502 resp.event = VTCON_CONSOLE_PORT;
505 pci_vtcon_control_send(sc, &resp, NULL, 0);
512 pci_vtcon_announce_port(struct pci_vtcon_port *port)
514 struct pci_vtcon_control event;
516 event.id = port->vsp_id;
517 event.event = VTCON_DEVICE_ADD;
519 pci_vtcon_control_send(port->vsp_sc, &event, NULL, 0);
521 event.event = VTCON_PORT_NAME;
522 pci_vtcon_control_send(port->vsp_sc, &event, port->vsp_name,
523 strlen(port->vsp_name));
527 pci_vtcon_open_port(struct pci_vtcon_port *port, bool open)
529 struct pci_vtcon_control event;
531 if (!port->vsp_sc->vsc_ready) {
532 port->vsp_open = true;
536 event.id = port->vsp_id;
537 event.event = VTCON_PORT_OPEN;
538 event.value = (int)open;
539 pci_vtcon_control_send(port->vsp_sc, &event, NULL, 0);
543 pci_vtcon_control_send(struct pci_vtcon_softc *sc,
544 struct pci_vtcon_control *ctrl, const void *payload, size_t len)
546 struct vqueue_info *vq;
551 vq = pci_vtcon_port_to_vq(&sc->vsc_control_port, true);
553 if (!vq_has_descs(vq))
556 n = vq_getchain(vq, &idx, &iov, 1, NULL);
560 memcpy(iov.iov_base, ctrl, sizeof(struct pci_vtcon_control));
561 if (payload != NULL && len > 0)
562 memcpy(iov.iov_base + sizeof(struct pci_vtcon_control),
565 vq_relchain(vq, idx, sizeof(struct pci_vtcon_control) + len);
571 pci_vtcon_notify_tx(void *vsc, struct vqueue_info *vq)
573 struct pci_vtcon_softc *sc;
574 struct pci_vtcon_port *port;
580 port = pci_vtcon_vq_to_port(sc, vq);
582 while (vq_has_descs(vq)) {
583 n = vq_getchain(vq, &idx, iov, 1, flags);
586 port->vsp_cb(port, port->vsp_arg, iov, 1);
589 * Release this chain and handle more
591 vq_relchain(vq, idx, 0);
593 vq_endchains(vq, 1); /* Generate interrupt if appropriate. */
597 pci_vtcon_notify_rx(void *vsc, struct vqueue_info *vq)
599 struct pci_vtcon_softc *sc;
600 struct pci_vtcon_port *port;
603 port = pci_vtcon_vq_to_port(sc, vq);
605 if (!port->vsp_rx_ready) {
606 port->vsp_rx_ready = 1;
607 vq->vq_used->vu_flags |= VRING_USED_F_NO_NOTIFY;
612 pci_vtcon_init(struct vmctx *ctx, struct pci_devinst *pi, char *opts)
614 struct pci_vtcon_softc *sc;
615 char *portname = NULL;
616 char *portpath = NULL;
620 sc = calloc(1, sizeof(struct pci_vtcon_softc));
621 sc->vsc_config = calloc(1, sizeof(struct pci_vtcon_config));
622 sc->vsc_config->max_nr_ports = VTCON_MAXPORTS;
623 sc->vsc_config->cols = 80;
624 sc->vsc_config->rows = 25;
626 vi_softc_linkup(&sc->vsc_vs, &vtcon_vi_consts, sc, pi, sc->vsc_queues);
627 sc->vsc_vs.vs_mtx = &sc->vsc_mtx;
629 for (i = 0; i < VTCON_MAXQ; i++) {
630 sc->vsc_queues[i].vq_qsize = VTCON_RINGSZ;
631 sc->vsc_queues[i].vq_notify = i % 2 == 0
632 ? pci_vtcon_notify_rx
633 : pci_vtcon_notify_tx;
636 /* initialize config space */
637 pci_set_cfgdata16(pi, PCIR_DEVICE, VIRTIO_DEV_CONSOLE);
638 pci_set_cfgdata16(pi, PCIR_VENDOR, VIRTIO_VENDOR);
639 pci_set_cfgdata8(pi, PCIR_CLASS, PCIC_SIMPLECOMM);
640 pci_set_cfgdata16(pi, PCIR_SUBDEV_0, VIRTIO_TYPE_CONSOLE);
641 pci_set_cfgdata16(pi, PCIR_SUBVEND_0, VIRTIO_VENDOR);
643 if (vi_intr_init(&sc->vsc_vs, 1, fbsdrun_virtio_msix()))
645 vi_set_io_bar(&sc->vsc_vs, 0);
647 /* create control port */
648 sc->vsc_control_port.vsp_sc = sc;
649 sc->vsc_control_port.vsp_txq = 2;
650 sc->vsc_control_port.vsp_rxq = 3;
651 sc->vsc_control_port.vsp_cb = pci_vtcon_control_tx;
652 sc->vsc_control_port.vsp_enabled = true;
654 while ((opt = strsep(&opts, ",")) != NULL) {
655 portname = strsep(&opt, "=");
659 if (pci_vtcon_sock_add(sc, portname, portpath) < 0) {
660 fprintf(stderr, "cannot create port %s: %s\n",
661 portname, strerror(errno));
669 struct pci_devemu pci_de_vcon = {
670 .pe_emu = "virtio-console",
671 .pe_init = pci_vtcon_init,
672 .pe_barwrite = vi_pci_write,
673 .pe_barread = vi_pci_read
675 PCI_EMUL_SET(pci_de_vcon);