[PATCH] fdt: arch/arm64: Delete the rng-seed property after use

[Bartosz Szczepanek]

As a part of platform boot, device tree is being read to extract
randonmess bits. The 'rng-seed' property is used for that purpose.
After reading the value, the field was overridden with NOP instead of
being deleted or zeroed. The problem is that NOPed fields are later not
reused, and kexec code appended this property every time DTB is prepared:

  /* add rng-seed */
  if (rng_is_initialized()) {
          void *rng_seed;
          ret = fdt_setprop_placeholder(dtb, off, FDT_PROP_RNG_SEED,
                          RNG_SEED_SIZE, &rng_seed);
          if (ret)
                  goto out;
          get_random_bytes(rng_seed, RNG_SEED_SIZE);
  }
(source: arch/arm64/kernel/machine_kexec_file.c)

Taken together, DTB grew at each kexec by 140 bytes ie. size of the
newly added (and not overwritten) rng-seed property. ARM64 sets a hard
limit on FDT size at 2MB, which means that after at most 14,979 kexecs
DTB exceeded the limit causing catastrophic (but silent) failure in
setup_machine_fdt().

This commits addresses the issue as follows:
 1. Call to fdt_nop_property is replaced with overwriting the rng-seed
    value with zeros.
 2. Zeroed rng-seed gets special treatment and is not accepted as valid
    seed. Warning is emitted on zeroed value.
 3. Kexec_file code is modified to delete the zeroed property if it
    can't fill it with valid seed.
 4. Proper error handling is added for the case when DTB exceeds 2MB.

The change was tested in QEMU arm64 environment. To do so, kernel
containing the change was built and included in buildroot initramfs.
Subsequently, kernel was started in QEMU. Using kexec_file, new kernel
was loaded and kexec reboot was issued. DTB size was noted in this step.
After new kernel has booted, another kexec_file was issued. DTB size
was confirmed not to change.

Signed-off-by: Bartosz Szczepanek <bsz@xxxxxxxxx>
---
 arch/arm64/kernel/machine_kexec_file.c |  5 +++++
 drivers/of/fdt.c                       | 18 +++++++++++++++---
 drivers/of/kexec.c                     | 12 +++++++++++-
 3 files changed, 31 insertions(+), 4 deletions(-)

diff --git a/arch/arm64/kernel/machine_kexec_file.c b/arch/arm64/kernel/machine_kexec_file.c
index af1ca875c52c..af0e39f6c96d 100644
--- a/arch/arm64/kernel/machine_kexec_file.c
+++ b/arch/arm64/kernel/machine_kexec_file.c
@@ -170,6 +170,11 @@ int load_other_segments(struct kimage *image,
 	/* trim it */
 	fdt_pack(dtb);
 	dtb_len = fdt_totalsize(dtb);
+	if (dtb_len > MAX_FDT_SIZE) {
+		pr_err("DTB exceeds the maximum size: 0x%lx > 0x%x", dtb_len, MAX_FDT_SIZE);
+		goto out_err;
+	}
+	pr_info("DTB successfully created at 0x%lx (length 0x%lx)", (unsigned long)dtb, dtb_len);
 	kbuf.buffer = dtb;
 	kbuf.bufsz = dtb_len;
 	kbuf.mem = KEXEC_BUF_MEM_UNKNOWN;
diff --git a/drivers/of/fdt.c b/drivers/of/fdt.c
index aedd0e2dcd89..8c2895cee682 100644
--- a/drivers/of/fdt.c
+++ b/drivers/of/fdt.c
@@ -1019,6 +1019,18 @@ int __init early_init_dt_scan_memory(void)
 	return found_memory;
 }
 
+static int check_randomness_nonzero(const uint8_t *rng_seed, int len)
+{
+	int i;
+
+	for (i = 0; i < len; i++)
+		if (rng_seed[i] != 0)
+			return true;
+
+	pr_warn("Provided rng-seed value is all zeros!");
+	return false;
+}
+
 int __init early_init_dt_scan_chosen(char *cmdline)
 {
 	int l, node;
@@ -1039,11 +1051,11 @@ int __init early_init_dt_scan_chosen(char *cmdline)
 	early_init_dt_check_for_elfcorehdr(node);
 
 	rng_seed = of_get_flat_dt_prop(node, "rng-seed", &l);
-	if (rng_seed && l > 0) {
+	if (rng_seed && l > 0 && check_randomness_nonzero(rng_seed, l)) {
 		add_bootloader_randomness(rng_seed, l);
 
-		/* try to clear seed so it won't be found. */
-		fdt_nop_property(initial_boot_params, node, "rng-seed");
+		/* Zero out the rng-seed property */
+		memset((void *)rng_seed, 0, l);
 
 		/* update CRC check value */
 		of_fdt_crc32 = crc32_be(~0, initial_boot_params,
diff --git a/drivers/of/kexec.c b/drivers/of/kexec.c
index 5b924597a4de..f5bfbac77a66 100644
--- a/drivers/of/kexec.c
+++ b/drivers/of/kexec.c
@@ -453,8 +453,18 @@ void *of_kexec_alloc_and_setup_fdt(const struct kimage *image,
 			goto out;
 		get_random_bytes(rng_seed, RNG_SEED_SIZE);
 	} else {
-		pr_notice("RNG is not initialised: omitting \"%s\" property\n",
+		pr_notice("RNG is not initialised: deleting \"%s\" property\n",
 			  "rng-seed");
+		/*
+		 * The rng-seed property may exist as zeroed stub. If so,
+		 * remove it to not confuse the incoming kernel.
+		 */
+		ret = fdt_delprop(fdt, chosen_node, "rng-seed");
+		if (ret == -FDT_ERR_NOTFOUND)
+			/* It's fine */
+			ret = 0;
+		else if (ret)
+			goto out;
 	}
 
 	ret = fdt_setprop(fdt, chosen_node, "linux,booted-from-kexec", NULL, 0);
-- 
2.47.1