2 * Copyright (c) 2016 iXsystems Inc.
5 * This software was developed by Jakub Klama <jceel@FreeBSD.org>
6 * under sponsorship from iXsystems Inc.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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.
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
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
34 #include <sys/param.h>
35 #include <sys/linker_set.h>
37 #include <sys/types.h>
38 #include <sys/socket.h>
57 #define VTCON_RINGSZ 64
58 #define VTCON_MAXPORTS 16
59 #define VTCON_MAXQ (VTCON_MAXPORTS * 2 + 2)
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
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)
76 static int pci_vtcon_debug;
77 #define DPRINTF(params) if (pci_vtcon_debug) printf params
78 #define WPRINTF(params) printf params
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 *,
86 struct pci_vtcon_port {
87 struct pci_vtcon_softc * vsp_sc;
89 const char * vsp_name;
96 pci_vtcon_cb_t * vsp_cb;
101 struct pci_vtcon_port * vss_port;
102 const char * vss_path;
103 struct mevent * vss_server_evp;
104 struct mevent * vss_conn_evp;
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;
115 uint64_t vsc_features;
119 struct pci_vtcon_port vsc_control_port;
120 struct pci_vtcon_port vsc_ports[VTCON_MAXPORTS];
121 struct pci_vtcon_config *vsc_config;
124 struct pci_vtcon_config {
127 uint32_t max_nr_ports;
129 } __attribute__((packed));
131 struct pci_vtcon_control {
135 } __attribute__((packed));
137 struct pci_vtcon_console_resize {
140 } __attribute__((packed));
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 *,
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);
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 */
171 pci_vtcon_reset(void *vsc)
173 struct pci_vtcon_softc *sc;
177 DPRINTF(("vtcon: device reset requested!\n"));
178 vi_reset_dev(&sc->vsc_vs);
182 pci_vtcon_neg_features(void *vsc, uint64_t negotiated_features)
184 struct pci_vtcon_softc *sc = vsc;
186 sc->vsc_features = negotiated_features;
190 pci_vtcon_cfgread(void *vsc, int offset, int size, uint32_t *retval)
192 struct pci_vtcon_softc *sc = vsc;
195 ptr = (uint8_t *)sc->vsc_config + offset;
196 memcpy(retval, ptr, size);
201 pci_vtcon_cfgwrite(void *vsc, int offset, int size, uint32_t val)
207 static inline struct pci_vtcon_port *
208 pci_vtcon_vq_to_port(struct pci_vtcon_softc *sc, struct vqueue_info *vq)
210 uint16_t num = vq->vq_num;
212 if (num == 0 || num == 1)
213 return (&sc->vsc_ports[0]);
215 if (num == 2 || num == 3)
216 return (&sc->vsc_control_port);
218 return (&sc->vsc_ports[(num / 2) - 1]);
221 static inline struct vqueue_info *
222 pci_vtcon_port_to_vq(struct pci_vtcon_port *port, bool tx_queue)
226 qnum = tx_queue ? port->vsp_txq : port->vsp_rxq;
227 return (&port->vsp_sc->vsc_queues[qnum]);
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)
234 struct pci_vtcon_port *port;
236 if (sc->vsc_nports == VTCON_MAXPORTS) {
241 port = &sc->vsc_ports[sc->vsc_nports++];
242 port->vsp_id = sc->vsc_nports - 1;
244 port->vsp_name = name;
248 if (port->vsp_id == 0) {
253 port->vsp_txq = sc->vsc_nports * 2;
254 port->vsp_rxq = port->vsp_txq + 1;
257 port->vsp_enabled = true;
262 pci_vtcon_sock_add(struct pci_vtcon_softc *sc, const char *name,
265 struct pci_vtcon_sock *sock;
266 struct sockaddr_un sun;
268 int s = -1, fd = -1, error = 0;
270 sock = calloc(1, sizeof(struct pci_vtcon_sock));
276 s = socket(AF_UNIX, SOCK_STREAM, 0);
282 pathcopy = strdup(path);
283 if (pathcopy == NULL) {
288 fd = open(dirname(pathcopy), O_RDONLY | O_DIRECTORY);
295 sun.sun_family = AF_UNIX;
296 sun.sun_len = sizeof(struct sockaddr_un);
297 strcpy(pathcopy, path);
298 strncpy(sun.sun_path, basename(pathcopy), sizeof(sun.sun_path));
301 if (bindat(fd, s, (struct sockaddr *)&sun, sun.sun_len) < 0) {
306 if (fcntl(s, F_SETFL, O_NONBLOCK) < 0) {
311 if (listen(s, 1) < 0) {
317 sock->vss_port = pci_vtcon_port_add(sc, name, pci_vtcon_sock_tx, sock);
318 if (sock->vss_port == NULL) {
323 sock->vss_open = false;
324 sock->vss_conn_fd = -1;
325 sock->vss_server_fd = s;
326 sock->vss_server_evp = mevent_add(s, EVF_READ, pci_vtcon_sock_accept,
329 if (sock->vss_server_evp == NULL) {
338 if (error != 0 && s != -1)
345 pci_vtcon_sock_accept(int fd __unused, enum ev_type t __unused, void *arg)
347 struct pci_vtcon_sock *sock = (struct pci_vtcon_sock *)arg;
350 s = accept(sock->vss_server_fd, NULL, NULL);
354 if (sock->vss_open) {
359 sock->vss_open = true;
360 sock->vss_conn_fd = s;
361 sock->vss_conn_evp = mevent_add(s, EVF_READ, pci_vtcon_sock_rx, sock);
362 pci_vtcon_open_port(sock->vss_port, true);
366 pci_vtcon_sock_rx(int fd __unused, enum ev_type t __unused, void *arg)
368 struct pci_vtcon_port *port;
369 struct pci_vtcon_sock *sock = (struct pci_vtcon_sock *)arg;
370 struct vqueue_info *vq;
372 static char dummybuf[2048];
376 port = sock->vss_port;
377 vq = pci_vtcon_port_to_vq(port, true);
379 if (!sock->vss_open || !port->vsp_rx_ready) {
380 len = read(sock->vss_conn_fd, dummybuf, sizeof(dummybuf));
387 if (!vq_has_descs(vq)) {
388 len = read(sock->vss_conn_fd, dummybuf, sizeof(dummybuf));
397 n = vq_getchain(vq, &idx, &iov, 1, NULL);
398 len = readv(sock->vss_conn_fd, &iov, n);
400 if (len == 0 || (len < 0 && errno == EWOULDBLOCK)) {
409 vq_relchain(vq, idx, len);
410 } while (vq_has_descs(vq));
415 mevent_delete_close(sock->vss_conn_evp);
416 sock->vss_conn_fd = -1;
417 sock->vss_open = false;
421 pci_vtcon_sock_tx(struct pci_vtcon_port *port, void *arg, struct iovec *iov,
424 struct pci_vtcon_sock *sock;
427 sock = (struct pci_vtcon_sock *)arg;
429 if (sock->vss_conn_fd == -1)
432 ret = writev(sock->vss_conn_fd, iov, niov);
434 if (ret < 0 && errno != EWOULDBLOCK) {
435 mevent_delete_close(sock->vss_conn_evp);
436 sock->vss_conn_fd = -1;
437 sock->vss_open = false;
442 pci_vtcon_control_tx(struct pci_vtcon_port *port, void *arg, struct iovec *iov,
445 struct pci_vtcon_softc *sc;
446 struct pci_vtcon_port *tmp;
447 struct pci_vtcon_control resp, *ctrl;
453 ctrl = (struct pci_vtcon_control *)iov->iov_base;
455 switch (ctrl->event) {
456 case VTCON_DEVICE_READY:
457 /* set port ready events for registered ports */
458 for (i = 0; i < VTCON_MAXPORTS; i++) {
459 tmp = &sc->vsc_ports[i];
460 if (tmp->vsp_enabled)
461 pci_vtcon_announce_port(tmp);
465 case VTCON_PORT_READY:
466 if (ctrl->id >= sc->vsc_nports) {
467 WPRINTF(("VTCON_PORT_READY event for unknown port %d\n",
472 tmp = &sc->vsc_ports[ctrl->id];
473 if (tmp->vsp_console) {
474 resp.event = VTCON_CONSOLE_PORT;
477 pci_vtcon_control_send(sc, &resp, NULL, 0);
484 pci_vtcon_announce_port(struct pci_vtcon_port *port)
486 struct pci_vtcon_control event;
488 event.id = port->vsp_id;
489 event.event = VTCON_DEVICE_ADD;
491 pci_vtcon_control_send(port->vsp_sc, &event, NULL, 0);
493 event.event = VTCON_PORT_NAME;
494 pci_vtcon_control_send(port->vsp_sc, &event, port->vsp_name,
495 strlen(port->vsp_name));
499 pci_vtcon_open_port(struct pci_vtcon_port *port, bool open)
501 struct pci_vtcon_control event;
503 event.id = port->vsp_id;
504 event.event = VTCON_PORT_OPEN;
505 event.value = (int)open;
506 pci_vtcon_control_send(port->vsp_sc, &event, NULL, 0);
510 pci_vtcon_control_send(struct pci_vtcon_softc *sc,
511 struct pci_vtcon_control *ctrl, const void *payload, size_t len)
513 struct vqueue_info *vq;
518 vq = pci_vtcon_port_to_vq(&sc->vsc_control_port, true);
520 if (!vq_has_descs(vq))
523 n = vq_getchain(vq, &idx, &iov, 1, NULL);
527 memcpy(iov.iov_base, ctrl, sizeof(struct pci_vtcon_control));
528 if (payload != NULL && len > 0)
529 memcpy(iov.iov_base + sizeof(struct pci_vtcon_control),
532 vq_relchain(vq, idx, sizeof(struct pci_vtcon_control) + len);
538 pci_vtcon_notify_tx(void *vsc, struct vqueue_info *vq)
540 struct pci_vtcon_softc *sc;
541 struct pci_vtcon_port *port;
547 port = pci_vtcon_vq_to_port(sc, vq);
549 while (vq_has_descs(vq)) {
550 n = vq_getchain(vq, &idx, iov, 1, flags);
552 port->vsp_cb(port, port->vsp_arg, iov, 1);
555 * Release this chain and handle more
557 vq_relchain(vq, idx, 0);
559 vq_endchains(vq, 1); /* Generate interrupt if appropriate. */
563 pci_vtcon_notify_rx(void *vsc, struct vqueue_info *vq)
565 struct pci_vtcon_softc *sc;
566 struct pci_vtcon_port *port;
569 port = pci_vtcon_vq_to_port(sc, vq);
571 if (!port->vsp_rx_ready) {
572 port->vsp_rx_ready = 1;
573 vq->vq_used->vu_flags |= VRING_USED_F_NO_NOTIFY;
578 pci_vtcon_init(struct vmctx *ctx, struct pci_devinst *pi, char *opts)
580 struct pci_vtcon_softc *sc;
581 char *portname = NULL;
582 char *portpath = NULL;
586 sc = calloc(1, sizeof(struct pci_vtcon_softc));
587 sc->vsc_config = calloc(1, sizeof(struct pci_vtcon_config));
588 sc->vsc_config->max_nr_ports = VTCON_MAXPORTS;
589 sc->vsc_config->cols = 80;
590 sc->vsc_config->rows = 25;
592 vi_softc_linkup(&sc->vsc_vs, &vtcon_vi_consts, sc, pi, sc->vsc_queues);
593 sc->vsc_vs.vs_mtx = &sc->vsc_mtx;
595 for (i = 0; i < VTCON_MAXQ; i++) {
596 sc->vsc_queues[i].vq_qsize = VTCON_RINGSZ;
597 sc->vsc_queues[i].vq_notify = i % 2 == 0
598 ? pci_vtcon_notify_rx
599 : pci_vtcon_notify_tx;
602 /* initialize config space */
603 pci_set_cfgdata16(pi, PCIR_DEVICE, VIRTIO_DEV_CONSOLE);
604 pci_set_cfgdata16(pi, PCIR_VENDOR, VIRTIO_VENDOR);
605 pci_set_cfgdata8(pi, PCIR_CLASS, PCIC_SIMPLECOMM);
606 pci_set_cfgdata16(pi, PCIR_SUBDEV_0, VIRTIO_TYPE_CONSOLE);
607 pci_set_cfgdata16(pi, PCIR_SUBVEND_0, VIRTIO_VENDOR);
609 if (vi_intr_init(&sc->vsc_vs, 1, fbsdrun_virtio_msix()))
611 vi_set_io_bar(&sc->vsc_vs, 0);
613 /* create control port */
614 sc->vsc_control_port.vsp_sc = sc;
615 sc->vsc_control_port.vsp_txq = 2;
616 sc->vsc_control_port.vsp_rxq = 3;
617 sc->vsc_control_port.vsp_cb = pci_vtcon_control_tx;
618 sc->vsc_control_port.vsp_enabled = true;
620 while ((opt = strsep(&opts, ",")) != NULL) {
621 portname = strsep(&opt, "=");
622 portpath = strdup(opt);
625 if (pci_vtcon_sock_add(sc, portname, portpath) < 0) {
626 fprintf(stderr, "cannot create port %s: %s\n",
627 portname, strerror(errno));
635 struct pci_devemu pci_de_vcon = {
636 .pe_emu = "virtio-console",
637 .pe_init = pci_vtcon_init,
638 .pe_barwrite = vi_pci_write,
639 .pe_barread = vi_pci_read
641 PCI_EMUL_SET(pci_de_vcon);