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