configs, driver, tools: Add and validate config revision

A common source of breakages during development and testing is to run with outdated configuration files against newer binaries, or vice versa. Catch and report this by converting the last 2 bytes of the system and cell config signatures into a revision number. Whenever we change their layout or semantic, this number shall be increased. Configs were auto-converted via sed -i -e '/\.signature =/a\\t\t.revision = JAILHOUSE_CONFIG_REVISION,' \ `git ls-files configs/*.c` Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
siemens · Nov 27, 2016 · 80226df · 80226df
1 parent c295bdb
commit 80226df
Show file tree

Hide file tree

Showing 39 changed files with 61 additions and 6 deletions.
diff --git a/configs/amd-seattle-gic-demo.c b/configs/amd-seattle-gic-demo.c
@@ -22,6 +22,7 @@ struct {
 } __attribute__((packed)) config = {
 	.cell = {
 		.signature = JAILHOUSE_CELL_DESC_SIGNATURE,
+		.revision = JAILHOUSE_CONFIG_REVISION,
 		.name = "gic-demo",
 		.flags = JAILHOUSE_CELL_PASSIVE_COMMREG,
 

diff --git a/configs/amd-seattle-linux-demo.c b/configs/amd-seattle-linux-demo.c
@@ -24,6 +24,7 @@ struct {
 } __attribute__((packed)) config = {
 	.cell = {
 		.signature = JAILHOUSE_CELL_DESC_SIGNATURE,
+		.revision = JAILHOUSE_CONFIG_REVISION,
 		.name = "linux-inmate-demo",
 		.flags = JAILHOUSE_CELL_PASSIVE_COMMREG,
 

diff --git a/configs/amd-seattle-uart-demo.c b/configs/amd-seattle-uart-demo.c
@@ -22,6 +22,7 @@ struct {
 } __attribute__((packed)) config = {
 	.cell = {
 		.signature = JAILHOUSE_CELL_DESC_SIGNATURE,
+		.revision = JAILHOUSE_CONFIG_REVISION,
 		.name = "pl011-demo",
 		.flags = JAILHOUSE_CELL_PASSIVE_COMMREG,
 

diff --git a/configs/amd-seattle.c b/configs/amd-seattle.c
@@ -24,6 +24,7 @@ struct {
 } __attribute__((packed)) config = {
 	.header = {
 		.signature = JAILHOUSE_SYSTEM_SIGNATURE,
+		.revision = JAILHOUSE_CONFIG_REVISION,
 		.hypervisor_memory = {
 			.phys_start = 0x82fc000000,
 			.size =          0x4000000,

diff --git a/configs/apic-demo.c b/configs/apic-demo.c
@@ -26,6 +26,7 @@ struct {
 } __attribute__((packed)) config = {
 	.cell = {
 		.signature = JAILHOUSE_CELL_DESC_SIGNATURE,
+		.revision = JAILHOUSE_CONFIG_REVISION,
 		.name = "apic-demo",
 
 		.cpu_set_size = sizeof(config.cpus),

diff --git a/configs/bananapi-gic-demo.c b/configs/bananapi-gic-demo.c
@@ -25,6 +25,7 @@ struct {
 } __attribute__((packed)) config = {
 	.cell = {
 		.signature = JAILHOUSE_CELL_DESC_SIGNATURE,
+		.revision = JAILHOUSE_CONFIG_REVISION,
 		.name = "bananapi-gic-demo",
 		.flags = JAILHOUSE_CELL_PASSIVE_COMMREG,
 

diff --git a/configs/bananapi-linux-demo.c b/configs/bananapi-linux-demo.c
@@ -27,6 +27,7 @@ struct {
 } __attribute__((packed)) config = {
 	.cell = {
 		.signature = JAILHOUSE_CELL_DESC_SIGNATURE,
+		.revision = JAILHOUSE_CONFIG_REVISION,
 		.name = "bananapi-linux-demo",
 		.flags = JAILHOUSE_CELL_PASSIVE_COMMREG,
 

diff --git a/configs/bananapi-uart-demo.c b/configs/bananapi-uart-demo.c
@@ -25,6 +25,7 @@ struct {
 } __attribute__((packed)) config = {
 	.cell = {
 		.signature = JAILHOUSE_CELL_DESC_SIGNATURE,
+		.revision = JAILHOUSE_CONFIG_REVISION,
 		.name = "bananapi-uart-demo",
 		.flags = JAILHOUSE_CELL_PASSIVE_COMMREG,
 

diff --git a/configs/bananapi.c b/configs/bananapi.c
@@ -26,6 +26,7 @@ struct {
 } __attribute__((packed)) config = {
 	.header = {
 		.signature = JAILHOUSE_SYSTEM_SIGNATURE,
+		.revision = JAILHOUSE_CONFIG_REVISION,
 		.hypervisor_memory = {
 			.phys_start = 0x7c000000,
 			.size = 0x4000000,

diff --git a/configs/e1000-demo.c b/configs/e1000-demo.c
@@ -28,6 +28,7 @@ struct {
 } __attribute__((packed)) config = {
 	.cell = {
 		.signature = JAILHOUSE_CELL_DESC_SIGNATURE,
+		.revision = JAILHOUSE_CONFIG_REVISION,
 		.name = "e1000-demo",
 		.flags = JAILHOUSE_CELL_PASSIVE_COMMREG,
 

diff --git a/configs/f2a88xm-hd3.c b/configs/f2a88xm-hd3.c
@@ -33,6 +33,7 @@ struct {
 } __attribute__((packed)) config = {
 	.header = {
 		.signature = JAILHOUSE_SYSTEM_SIGNATURE,
+		.revision = JAILHOUSE_CONFIG_REVISION,
 		.hypervisor_memory = {
 			.phys_start = 0x3b000000,
 			.size = 0x4000000,

diff --git a/configs/foundation-v8-gic-demo.c b/configs/foundation-v8-gic-demo.c
@@ -22,6 +22,7 @@ struct {
 } __attribute__((packed)) config = {
 	.cell = {
 		.signature = JAILHOUSE_CELL_DESC_SIGNATURE,
+		.revision = JAILHOUSE_CONFIG_REVISION,
 		.name = "gic-demo",
 		.flags = JAILHOUSE_CELL_PASSIVE_COMMREG,
 

diff --git a/configs/foundation-v8-linux-demo.c b/configs/foundation-v8-linux-demo.c
@@ -23,6 +23,7 @@ struct {
 } __attribute__((packed)) config = {
 	.cell = {
 		.signature = JAILHOUSE_CELL_DESC_SIGNATURE,
+		.revision = JAILHOUSE_CONFIG_REVISION,
 		.name = "linux-inmate-demo",
 		.flags = JAILHOUSE_CELL_PASSIVE_COMMREG,
 

diff --git a/configs/foundation-v8-uart-demo.c b/configs/foundation-v8-uart-demo.c
@@ -22,6 +22,7 @@ struct {
 } __attribute__((packed)) config = {
 	.cell = {
 		.signature = JAILHOUSE_CELL_DESC_SIGNATURE,
+		.revision = JAILHOUSE_CONFIG_REVISION,
 		.name = "pl011-demo",
 		.flags = JAILHOUSE_CELL_PASSIVE_COMMREG,
 

diff --git a/configs/foundation-v8.c b/configs/foundation-v8.c
@@ -23,6 +23,7 @@ struct {
 } __attribute__((packed)) config = {
 	.header = {
 		.signature = JAILHOUSE_SYSTEM_SIGNATURE,
+		.revision = JAILHOUSE_CONFIG_REVISION,
 		.hypervisor_memory = {
 			.phys_start = 0xfc000000,
 			.size = 0x4000000,

diff --git a/configs/h87i.c b/configs/h87i.c
@@ -28,6 +28,7 @@ struct {
 } __attribute__((packed)) config = {
 	.header = {
 		.signature = JAILHOUSE_SYSTEM_SIGNATURE,
+		.revision = JAILHOUSE_CONFIG_REVISION,
 		.hypervisor_memory = {
 			.phys_start = 0x3b000000,
 			.size = 0x4000000,

diff --git a/configs/hikey-gic-demo.c b/configs/hikey-gic-demo.c
@@ -22,6 +22,7 @@ struct {
 } __attribute__((packed)) config = {
 	.cell = {
 		.signature = JAILHOUSE_CELL_DESC_SIGNATURE,
+		.revision = JAILHOUSE_CONFIG_REVISION,
 		.name = "gic-demo",
 		.flags = JAILHOUSE_CELL_PASSIVE_COMMREG,
 

diff --git a/configs/hikey-linux-demo.c b/configs/hikey-linux-demo.c
@@ -27,6 +27,7 @@ struct {
 } __attribute__((packed)) config = {
 	.cell = {
 		.signature = JAILHOUSE_CELL_DESC_SIGNATURE,
+		.revision = JAILHOUSE_CONFIG_REVISION,
 		.name = "hikey-linux-demo",
 		.flags = JAILHOUSE_CELL_PASSIVE_COMMREG,
 

diff --git a/configs/hikey.c b/configs/hikey.c
@@ -24,6 +24,7 @@ struct {
 } __attribute__((packed)) config = {
 	.header = {
 		.signature = JAILHOUSE_SYSTEM_SIGNATURE,
+		.revision = JAILHOUSE_CONFIG_REVISION,
 		.hypervisor_memory = {
 			.phys_start = 0x7c000000,
 			.size =       0x04000000,

diff --git a/configs/imb-a180.c b/configs/imb-a180.c
@@ -32,6 +32,7 @@ struct {
 } __attribute__((packed)) config = {
 	.header = {
 		.signature = JAILHOUSE_SYSTEM_SIGNATURE,
+		.revision = JAILHOUSE_CONFIG_REVISION,
 		.hypervisor_memory = {
 			.phys_start = 0x3b000000,
 			.size = 0x4000000,

diff --git a/configs/ioapic-demo.c b/configs/ioapic-demo.c
@@ -27,6 +27,7 @@ struct {
 } __attribute__((packed)) config = {
 	.cell = {
 		.signature = JAILHOUSE_CELL_DESC_SIGNATURE,
+		.revision = JAILHOUSE_CONFIG_REVISION,
 		.name = "ioapic-demo",
 		.flags = JAILHOUSE_CELL_PASSIVE_COMMREG,
 

diff --git a/configs/ivshmem-demo.c b/configs/ivshmem-demo.c
@@ -25,6 +25,7 @@ struct {
 } __attribute__((packed)) config = {
 	.cell = {
 		.signature = JAILHOUSE_CELL_DESC_SIGNATURE,
+		.revision = JAILHOUSE_CONFIG_REVISION,
 		.name = "ivshmem-demo",
 		.flags = JAILHOUSE_CELL_PASSIVE_COMMREG,
 

diff --git a/configs/jetson-tk1-demo.c b/configs/jetson-tk1-demo.c
@@ -25,6 +25,7 @@ struct {
 } __attribute__((packed)) config = {
 	.cell = {
 		.signature = JAILHOUSE_CELL_DESC_SIGNATURE,
+		.revision = JAILHOUSE_CONFIG_REVISION,
 		.name = "jetson-tk1-demo",
 		.flags = JAILHOUSE_CELL_PASSIVE_COMMREG,
 

diff --git a/configs/jetson-tk1-linux-demo.c b/configs/jetson-tk1-linux-demo.c
@@ -27,6 +27,7 @@ struct {
 } __attribute__((packed)) config = {
 	.cell = {
 		.signature = JAILHOUSE_CELL_DESC_SIGNATURE,
+		.revision = JAILHOUSE_CONFIG_REVISION,
 		.name = "jetson-tk1-linux-demo",
 		.flags = JAILHOUSE_CELL_PASSIVE_COMMREG|JAILHOUSE_CELL_DEBUG_CONSOLE,
 

diff --git a/configs/jetson-tk1.c b/configs/jetson-tk1.c
@@ -29,6 +29,7 @@ struct {
 } __attribute__((packed)) config = {
 	.header = {
 		.signature = JAILHOUSE_SYSTEM_SIGNATURE,
+		.revision = JAILHOUSE_CONFIG_REVISION,
 		.hypervisor_memory = {
 			.phys_start = 0xfc000000,
 			.size = 0x4000000 - 0x100000, /* -1MB (PSCI) */

diff --git a/configs/linux-x86-demo.c b/configs/linux-x86-demo.c
@@ -27,6 +27,7 @@ struct {
 } __attribute__((packed)) config = {
 	.cell = {
 		.signature = JAILHOUSE_CELL_DESC_SIGNATURE,
+		.revision = JAILHOUSE_CONFIG_REVISION,
 		.name = "linux-x86-demo",
 		.flags = JAILHOUSE_CELL_PASSIVE_COMMREG,
 

diff --git a/configs/pci-demo.c b/configs/pci-demo.c
@@ -28,6 +28,7 @@ struct {
 } __attribute__((packed)) config = {
 	.cell = {
 		.signature = JAILHOUSE_CELL_DESC_SIGNATURE,
+		.revision = JAILHOUSE_CONFIG_REVISION,
 		.name = "pci-demo",
 		.flags = JAILHOUSE_CELL_PASSIVE_COMMREG,
 

diff --git a/configs/qemu-vm.c b/configs/qemu-vm.c
@@ -42,6 +42,7 @@ struct {
 } __attribute__((packed)) config = {
 	.header = {
 		.signature = JAILHOUSE_SYSTEM_SIGNATURE,
+		.revision = JAILHOUSE_CONFIG_REVISION,
 		.hypervisor_memory = {
 			.phys_start = 0x3b000000,
 			.size = 0x600000,

diff --git a/configs/smp-demo.c b/configs/smp-demo.c
@@ -25,6 +25,7 @@ struct {
 } __attribute__((packed)) config = {
 	.cell = {
 		.signature = JAILHOUSE_CELL_DESC_SIGNATURE,
+		.revision = JAILHOUSE_CONFIG_REVISION,
 		.name = "smp-demo",
 		.flags = JAILHOUSE_CELL_PASSIVE_COMMREG,
 

diff --git a/configs/tiny-demo.c b/configs/tiny-demo.c
@@ -26,6 +26,7 @@ struct {
 } __attribute__((packed)) config = {
 	.cell = {
 		.signature = JAILHOUSE_CELL_DESC_SIGNATURE,
+		.revision = JAILHOUSE_CONFIG_REVISION,
 		.name = "tiny-demo",
 		.flags = JAILHOUSE_CELL_PASSIVE_COMMREG,
 

diff --git a/configs/vexpress-gic-demo.c b/configs/vexpress-gic-demo.c
@@ -22,6 +22,7 @@ struct {
 } __attribute__((packed)) config = {
 	.cell = {
 		.signature = JAILHOUSE_CELL_DESC_SIGNATURE,
+		.revision = JAILHOUSE_CONFIG_REVISION,
 		.name = "gic-demo",
 		.flags = JAILHOUSE_CELL_PASSIVE_COMMREG,
 

diff --git a/configs/vexpress-linux-demo.c b/configs/vexpress-linux-demo.c
@@ -23,6 +23,7 @@ struct {
 } __attribute__((packed)) config = {
 	.cell = {
 		.signature = JAILHOUSE_CELL_DESC_SIGNATURE,
+		.revision = JAILHOUSE_CONFIG_REVISION,
 		.name = "linux-demo",
 		.flags = JAILHOUSE_CELL_PASSIVE_COMMREG,
 

diff --git a/configs/vexpress-uart-demo.c b/configs/vexpress-uart-demo.c
@@ -22,6 +22,7 @@ struct {
 } __attribute__((packed)) config = {
 	.cell = {
 		.signature = JAILHOUSE_CELL_DESC_SIGNATURE,
+		.revision = JAILHOUSE_CONFIG_REVISION,
 		.name = "pl011-demo",
 		.flags = JAILHOUSE_CELL_PASSIVE_COMMREG,
 

diff --git a/configs/vexpress.c b/configs/vexpress.c
@@ -23,6 +23,7 @@ struct {
 } __attribute__((packed)) config = {
 	.header = {
 		.signature = JAILHOUSE_SYSTEM_SIGNATURE,
+		.revision = JAILHOUSE_CONFIG_REVISION,
 		.hypervisor_memory = {
 			.phys_start = 0xfc000000,
 			.size = 0x4000000,

diff --git a/driver/cell.c b/driver/cell.c
@@ -173,6 +173,11 @@ int jailhouse_cmd_cell_create(struct jailhouse_cell_create __user *arg)
 		err = -EINVAL;
 		goto kfree_config_out;
 	}
+	if (config->revision != JAILHOUSE_CONFIG_REVISION) {
+		pr_err("jailhouse: Configuration revision mismatch\n");
+		err = -EINVAL;
+		goto kfree_config_out;
+	}
 
 	config->name[JAILHOUSE_CELL_NAME_MAXLEN] = 0;
 

diff --git a/driver/main.c b/driver/main.c
@@ -211,6 +211,10 @@ static int jailhouse_cmd_enable(struct jailhouse_system __user *arg)
 		pr_err("jailhouse: Not a system configuration\n");
 		return -EINVAL;
 	}
+	if (config_header.revision != JAILHOUSE_CONFIG_REVISION) {
+		pr_err("jailhouse: Configuration revision mismatch\n");
+		return -EINVAL;
+	}
 
 	config_header.root_cell.name[JAILHOUSE_CELL_NAME_MAXLEN] = 0;
 

diff --git a/hypervisor/include/jailhouse/cell-config.h b/hypervisor/include/jailhouse/cell-config.h
@@ -39,12 +39,15 @@
 #ifndef _JAILHOUSE_CELL_CONFIG_H
 #define _JAILHOUSE_CELL_CONFIG_H
 
+/* Incremented on any layout or semantic change of system or cell config. */
+#define JAILHOUSE_CONFIG_REVISION	1
+
 #define JAILHOUSE_CELL_NAME_MAXLEN	31
 
 #define JAILHOUSE_CELL_PASSIVE_COMMREG	0x00000001
 #define JAILHOUSE_CELL_DEBUG_CONSOLE	0x00000002
 
-#define JAILHOUSE_CELL_DESC_SIGNATURE	"JAILCELL"
+#define JAILHOUSE_CELL_DESC_SIGNATURE	"JHCELL"
 
 /**
  * The jailhouse cell configuration.
@@ -53,7 +56,9 @@
  * structure.
  */
 struct jailhouse_cell_desc {
-	char signature[8];
+	char signature[6];
+	__u16 revision;
+
 	char name[JAILHOUSE_CELL_NAME_MAXLEN+1];
 	__u32 id; /* set by the driver */
 	__u32 flags;
@@ -166,13 +171,14 @@ struct jailhouse_iommu {
 	__u32 amd_features;
 } __attribute__((packed));
 
-#define JAILHOUSE_SYSTEM_SIGNATURE	"JAILSYST"
+#define JAILHOUSE_SYSTEM_SIGNATURE	"JHSYST"
 
 /**
  * General descriptor of the system.
  */
 struct jailhouse_system {
-	char signature[8];
+	char signature[6];
+	__u16 revision;
 
 	/** Jailhouse's location in memory */
 	struct jailhouse_memory hypervisor_memory;

diff --git a/tools/jailhouse-cell-linux b/tools/jailhouse-cell-linux
@@ -509,12 +509,14 @@ class MemoryRegion:
 
 
 class Config:
-    _HEADER_FORMAT = '8s32s4xIIIIIIIII'
+    _HEADER_FORMAT = '6sH32s4xIIIIIIIII'
+    _HEADER_REVISION = 1
 
     def __init__(self, config_file):
         self.data = config_file.read()
 
         (signature,
+         revision,
          name,
          self.flags,
          self.cpu_set_size,
@@ -526,10 +528,13 @@ class Config:
          self.num_pci_caps,
          self.vpci_irq_base) = \
             struct.unpack_from(Config._HEADER_FORMAT, self.data)
-        if str(signature.decode()) != 'JAILCELL':
+        if str(signature.decode()) != 'JHCELL':
             print('Not a cell configuration: %s' % config_file.name,
                   file=sys.stderr)
             exit(1)
+        if revision != Config._HEADER_REVISION:
+            print('Configuration file revision mismatch', file=sys.stderr)
+            exit(1)
         self.name = str(name.decode())
 
         memregion_offs = struct.calcsize(Config._HEADER_FORMAT) + \

diff --git a/tools/root-cell-config.c.tmpl b/tools/root-cell-config.c.tmpl
@@ -55,6 +55,7 @@ struct {
 } __attribute__((packed)) config = {
 	.header = {
 		.signature = JAILHOUSE_SYSTEM_SIGNATURE,
+		.revision = JAILHOUSE_CONFIG_REVISION,
 		.hypervisor_memory = {
 			.phys_start = ${hex(hvmem[0])},
 			.size = ${hex(hvmem[1])},