git: d84b694a589d - stable/13 - bhyve: add varfile option to nvlist of lpc device

From: Corvin Köhne <corvink_at_FreeBSD.org>
Date: Thu, 08 Dec 2022 17:43:59 UTC
The branch stable/13 has been updated by corvink:

URL: https://cgit.FreeBSD.org/src/commit/?id=d84b694a589d516add11022ba69501ee0a772e31

commit d84b694a589d516add11022ba69501ee0a772e31
Author:     Corvin Köhne <CorvinK@beckhoff.com>
AuthorDate: 2022-03-03 07:45:20 +0000
Commit:     Corvin Köhne <corvink@FreeBSD.org>
CommitDate: 2022-12-08 13:54:14 +0000

    bhyve: add varfile option to nvlist of lpc device
    
    Use seperate nvlist entries for the romfile and the varfile.
    
    While here, don't leak varfd in bootrom_loadrom().
    
    Reviewed by:    jhb, markj
    Differential Revision:  https://reviews.freebsd.org/D33433
    
    (cherry picked from commit 87f6367f10614f58e5f93130b7be3364d2f83068)
---
 usr.sbin/bhyve/bhyve_config.5 |  7 +++++-
 usr.sbin/bhyve/bootrom.c      | 52 +++++++++++++++++++++++++++++--------------
 usr.sbin/bhyve/bootrom.h      |  4 +++-
 usr.sbin/bhyve/pci_lpc.c      | 23 ++++++++++++++-----
 4 files changed, 62 insertions(+), 24 deletions(-)

diff --git a/usr.sbin/bhyve/bhyve_config.5 b/usr.sbin/bhyve/bhyve_config.5
index 882479bf7b00..f14773313180 100644
--- a/usr.sbin/bhyve/bhyve_config.5
+++ b/usr.sbin/bhyve/bhyve_config.5
@@ -23,7 +23,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd August 19, 2022
+.Dd December 8, 2022
 .Dt BHYVE_CONFIG 5
 .Os
 .Sh NAME
@@ -514,6 +514,11 @@ The contents of this file are copied into the guest's
 memory ending just before the 4GB physical address.
 If a boot ROM is present, a firmware interface device is
 also enabled for use by the boot ROM.
+.It Va bootvars Ta path Ta Ta
+Path to boot VARS.
+The contents of this file are copied beneath the boot ROM.
+Firmware can write to it to save variables.
+All variables will be persistent even on reboots of the guest.
 .It Va com1 Ta node Ta Ta
 Settings for the COM1 serial port device.
 .It Va com2 Ta node Ta Ta
diff --git a/usr.sbin/bhyve/bootrom.c b/usr.sbin/bhyve/bootrom.c
index 757ec07d4a54..2406d4539e55 100644
--- a/usr.sbin/bhyve/bootrom.c
+++ b/usr.sbin/bhyve/bootrom.c
@@ -191,19 +191,33 @@ bootrom_alloc(struct vmctx *ctx, size_t len, int prot, int flags,
 }
 
 int
-bootrom_loadrom(struct vmctx *ctx, const char *romfile)
+bootrom_loadrom(struct vmctx *ctx, const nvlist_t *nvl)
 {
 	struct stat sbuf;
 	ssize_t rlen;
 	off_t rom_size, var_size, total_size;
-	char *ptr, *varfile;
+	char *ptr, *romfile;
 	int fd, varfd, i, rv;
+	const char *bootrom, *varfile;
 
 	rv = -1;
 	varfd = -1;
 
-	varfile = strdup(romfile);
-	romfile = strsep(&varfile, ",");
+	bootrom = get_config_value_node(nvl, "bootrom");
+	if (bootrom == NULL) {
+		return (-1);
+	}
+
+	/*
+	 * get_config_value_node may use a thread local buffer to return
+	 * variables. So, when we query the second variable, the first variable
+	 * might get overwritten. For that reason, the bootrom should be
+	 * duplicated.
+	 */
+	romfile = strdup(bootrom);
+	if (romfile == NULL) {
+		return (-1);
+	}
 
 	fd = open(romfile, O_RDONLY);
 	if (fd < 0) {
@@ -212,6 +226,16 @@ bootrom_loadrom(struct vmctx *ctx, const char *romfile)
 		goto done;
 	}
 
+	if (fstat(fd, &sbuf) < 0) {
+		EPRINTLN("Could not fstat bootrom file \"%s\": %s", romfile,
+		    strerror(errno));
+		goto done;
+	}
+
+	rom_size = sbuf.st_size;
+
+	varfile = get_config_value_node(nvl, "bootvars");
+	var_size = 0;
 	if (varfile != NULL) {
 		varfd = open(varfile, O_RDWR);
 		if (varfd < 0) {
@@ -219,23 +243,14 @@ bootrom_loadrom(struct vmctx *ctx, const char *romfile)
 			    "\"%s\": %s\n", varfile, strerror(errno));
 			goto done;
 		}
-	}
-
-	if (fstat(fd, &sbuf) < 0) {
-		EPRINTLN("Could not fstat bootrom file \"%s\": %s",
-			romfile, strerror(errno));
-		goto done;
-	}
 
-	rom_size = sbuf.st_size;
-	if (varfd < 0) {
-		var_size = 0;
-	} else {
 		if (fstat(varfd, &sbuf) < 0) {
-			fprintf(stderr, "Could not fstat bootrom variable file \"%s\": %s\n",
-				varfile, strerror(errno));
+			fprintf(stderr,
+			    "Could not fstat bootrom variable file \"%s\": %s\n",
+			    varfile, strerror(errno));
 			goto done;
 		}
+
 		var_size = sbuf.st_size;
 	}
 
@@ -291,7 +306,10 @@ bootrom_loadrom(struct vmctx *ctx, const char *romfile)
 
 	rv = 0;
 done:
+	if (varfd >= 0)
+		close(varfd);
 	if (fd >= 0)
 		close(fd);
+	free(romfile);
 	return (rv);
 }
diff --git a/usr.sbin/bhyve/bootrom.h b/usr.sbin/bhyve/bootrom.h
index da802343eefc..f718d5728c84 100644
--- a/usr.sbin/bhyve/bootrom.h
+++ b/usr.sbin/bhyve/bootrom.h
@@ -36,6 +36,8 @@
 #include <stdint.h>
 #include <limits.h>
 
+#include "config.h"
+
 struct vmctx;
 
 void init_bootrom(struct vmctx *ctx);
@@ -45,6 +47,6 @@ enum {
 };
 int bootrom_alloc(struct vmctx *ctx, size_t len, int prot, int flags,
     char **region_out, uint64_t *gpa_out);
-int bootrom_loadrom(struct vmctx *ctx, const char *romfile);
+int bootrom_loadrom(struct vmctx *ctx, const nvlist_t *nvl);
 
 #endif
diff --git a/usr.sbin/bhyve/pci_lpc.c b/usr.sbin/bhyve/pci_lpc.c
index 85c8ef86fed4..f430d32dbd49 100644
--- a/usr.sbin/bhyve/pci_lpc.c
+++ b/usr.sbin/bhyve/pci_lpc.c
@@ -36,6 +36,7 @@ __FBSDID("$FreeBSD$");
 #include <machine/vmm.h>
 #include <machine/vmm_snapshot.h>
 
+#include <err.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
@@ -95,13 +96,24 @@ lpc_device_parse(const char *opts)
 {
 	int unit, error;
 	char *str, *cpy, *lpcdev, *node_name;
+	const char *romfile, *varfile;
 
 	error = -1;
 	str = cpy = strdup(opts);
 	lpcdev = strsep(&str, ",");
 	if (lpcdev != NULL) {
 		if (strcasecmp(lpcdev, "bootrom") == 0) {
-			set_config_value("lpc.bootrom", str);
+			romfile = strsep(&str, ",");
+			if (romfile == NULL) {
+				errx(4, "invalid bootrom option \"%s\"", opts);
+			}
+			set_config_value("lpc.bootrom", romfile);
+
+			varfile = strsep(&str, ",");
+			if (varfile != NULL) {
+				set_config_value("lpc.bootvars", varfile);
+			}
+
 			error = 0;
 			goto done;
 		}
@@ -204,13 +216,14 @@ lpc_init(struct vmctx *ctx)
 {
 	struct lpc_uart_softc *sc;
 	struct inout_port iop;
-	const char *backend, *name, *romfile;
+	const char *backend, *name;
 	char *node_name;
 	int unit, error;
+	const nvlist_t *nvl;
 
-	romfile = get_config_value("lpc.bootrom");
-	if (romfile != NULL) {
-		error = bootrom_loadrom(ctx, romfile);
+	nvl = find_config_node("lpc");
+	if (nvl != NULL && nvlist_exists(nvl, "bootrom")) {
+		error = bootrom_loadrom(ctx, nvl);
 		if (error)
 			return (error);
 	}