Skip to contentSkip to conversation

xen/arm: bootfdt: Always sort memory banks

PATCH In review Oleksandr Tyshchenko 3 participants 4 messages Jul 5, 2021 – Jul 6, 2021

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 xen/arm: bootfdt: Always sort memory banks

From: Oleksandr Tyshchenko <[email protected]>

At the moment, Xen on Arm64 expects the memory banks to be ordered. Unfortunately, there may be a case when updated by firmware device tree contains unordered banks. This means Xen will panic when setting xenheap mappings for the subsequent bank with start address being less than xenheap_mfn_start (start address of the first bank).

As there is no clear requirement regarding ordering in the device tree, update code to be able to deal with by sorting memory banks. There is only one heap region on Arm32, so the sorting is fine to be done in the common code.

---
V2:
- add Stefano's R-b
- clarify patch description
- clarify comment in code
- drop "if (bootinfo.mem.nr_banks > 1)" check

---
 xen/arch/arm/bootfdt.c | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
xen/arch/arm/bootfdt.c +25 -0
index dcff512..476e32e 100644
@@ -13,6 +13,7 @@
 #include <xen/init.h>
 #include <xen/device_tree.h>
 #include <xen/libfdt/libfdt.h>
+#include <xen/sort.h>
 #include <xsm/xsm.h>
 #include <asm/setup.h>
 
@@ -395,6 +396,21 @@ static void __init early_print_info(void)
     printk("\n");
 }
 
+/* This function assumes that memory regions are not overlapped */
+static int __init cmp_memory_node(const void *key, const void *elem)
+{
+    const struct membank *handler0 = key;
+    const struct membank *handler1 = elem;
+
+    if ( handler0->start < handler1->start )
+        return -1;
+
+    if ( handler0->start >= (handler1->start + handler1->size) )
+        return 1;
+
+    return 0;
+}
+
 /**
  * boot_fdt_info - initialize bootinfo from a DTB
  * @fdt: flattened device tree binary
@@ -412,6 +428,15 @@ size_t __init boot_fdt_info(const void *fdt, paddr_t paddr)
     add_boot_module(BOOTMOD_FDT, paddr, fdt_totalsize(fdt), false);
 
     device_tree_for_each_node((void *)fdt, 0, early_scan_node, NULL);
+
+    /*
+     * On Arm64 setup_xenheap_mappings() expects to be called with the lowest
+     * bank in memory first. There is no requirement that the DT will provide
+     * the banks sorted in ascending order. So sort them through.
+     */
+    sort(bootinfo.mem.bank, bootinfo.mem.nr_banks, sizeof(struct membank),
+         cmp_memory_node, NULL);
+
     early_print_info();
 
     return fdt_totalsize(fdt);
Signature · 1 line
2.7.4
Reviewed-by Stefano Stabellini Reviewed-by on v2 1/1
#1 lore raw

Hi Oleksandr,

On 5 Jul 2021, at 18:48, Oleksandr Tyshchenko <[email protected]<mailto:[email protected]>> wrote:

From: Oleksandr Tyshchenko <[email protected]<mailto:[email protected]>>

At the moment, Xen on Arm64 expects the memory banks to be ordered. Unfortunately, there may be a case when updated by firmware device tree contains unordered banks. This means Xen will panic when setting xenheap mappings for the subsequent bank with start address being less than xenheap_mfn_start (start address of the first bank).

As there is no clear requirement regarding ordering in the device tree, update code to be able to deal with by sorting memory banks. There is only one heap region on Arm32, so the sorting is fine to be done in the common code.

Cheers
Bertrand

---
V2:
- add Stefano's R-b
- clarify patch description
- clarify comment in code
- drop "if (bootinfo.mem.nr_banks > 1)" check
---
xen/arch/arm/bootfdt.c | 25 +++++++++++++++++++++++++

1 file changed, 25 insertions(+)
xen/arch/arm/bootfdt.c +0 -0
index dcff512..476e32e 100644
@@ -13,6 +13,7 @@

#include <xen/init.h>
#include <xen/device_tree.h>
#include <xen/libfdt/libfdt.h>
+#include <xen/sort.h>
#include <xsm/xsm.h>
#include <asm/setup.h>

@@ -395,6 +396,21 @@ static void __init early_print_info(void)

    printk("\n");
}

+/* This function assumes that memory regions are not overlapped */ +static int __init cmp_memory_node(const void *key, const void *elem) +{
+ const struct membank *handler0 = key;
+ const struct membank *handler1 = elem;
+
+ if ( handler0->start < handler1->start )
+ return -1;
+
+ if ( handler0->start >= (handler1->start + handler1->size) )
+ return 1;
+
+ return 0;
+}
+
/**
* boot_fdt_info - initialize bootinfo from a DTB
* @fdt: flattened device tree binary
@@ -412,6 +428,15 @@ size_t __init boot_fdt_info(const void *fdt, paddr_t paddr)

    add_boot_module(BOOTMOD_FDT, paddr, fdt_totalsize(fdt), false);

    device_tree_for_each_node((void *)fdt, 0, early_scan_node, NULL);
+
+    /*
+     * On Arm64 setup_xenheap_mappings() expects to be called with the lowest
+     * bank in memory first. There is no requirement that the DT will provide
+     * the banks sorted in ascending order. So sort them through.
+     */
+    sort(bootinfo.mem.bank, bootinfo.mem.nr_banks, sizeof(struct membank),
+         cmp_memory_node, NULL);
+
    early_print_info();

    return fdt_totalsize(fdt);

--
2.7.4

Acked-by on v2 1/1
#2 lore raw
In reply to Oleksandr Tyshchenko

Hi Oleksandr,

Quoted 9 lines · Oleksandr Tyshchenko

From: Oleksandr Tyshchenko <[email protected]>

At the moment, Xen on Arm64 expects the memory banks to be ordered. Unfortunately, there may be a case when updated by firmware device tree contains unordered banks. This means Xen will panic when setting xenheap mappings for the subsequent bank with start address being less than xenheap_mfn_start (start address of the first bank).

Quoted 8 lines

As there is no clear requirement regarding ordering in the device tree, update code to be able to deal with by sorting memory banks. There is only one heap region on Arm32, so the sorting is fine to be done in the common code.

Cheers,

Quoted 62 lines

---
V2:
- add Stefano's R-b
- clarify patch description
- clarify comment in code
- drop "if (bootinfo.mem.nr_banks > 1)" check

---
  xen/arch/arm/bootfdt.c | 25 +++++++++++++++++++++++++
  1 file changed, 25 insertions(+)
xen/arch/arm/bootfdt.c +25 -0
index dcff512..476e32e 100644
@@ -13,6 +13,7 @@
  #include <xen/init.h>
  #include <xen/device_tree.h>
  #include <xen/libfdt/libfdt.h>
+#include <xen/sort.h>
  #include <xsm/xsm.h>
  #include <asm/setup.h>
 
@@ -395,6 +396,21 @@ static void __init early_print_info(void)
      printk("\n");
  }
 
+/* This function assumes that memory regions are not overlapped */
+static int __init cmp_memory_node(const void *key, const void *elem)
+{
+    const struct membank *handler0 = key;
+    const struct membank *handler1 = elem;
+
+    if ( handler0->start < handler1->start )
+        return -1;
+
+    if ( handler0->start >= (handler1->start + handler1->size) )
+        return 1;
+
+    return 0;
+}
+
  /**
   * boot_fdt_info - initialize bootinfo from a DTB
   * @fdt: flattened device tree binary
@@ -412,6 +428,15 @@ size_t __init boot_fdt_info(const void *fdt, paddr_t paddr)
      add_boot_module(BOOTMOD_FDT, paddr, fdt_totalsize(fdt), false);
 
      device_tree_for_each_node((void *)fdt, 0, early_scan_node, NULL);
+
+    /*
+     * On Arm64 setup_xenheap_mappings() expects to be called with the lowest
+     * bank in memory first. There is no requirement that the DT will provide
+     * the banks sorted in ascending order. So sort them through.
+     */
+    sort(bootinfo.mem.bank, bootinfo.mem.nr_banks, sizeof(struct membank),
+         cmp_memory_node, NULL);
+
      early_print_info();
 
      return fdt_totalsize(fdt);
Signature · 1 line
Julien Grall
#3 lore raw
Quoted 17 lines · Julien Grall

Hi Oleksandr,

Quoted 14 lines · Oleksandr Tyshchenko

From: Oleksandr Tyshchenko <[email protected]>

At the moment, Xen on Arm64 expects the memory banks to be ordered. Unfortunately, there may be a case when updated by firmware device tree contains unordered banks. This means Xen will panic when setting xenheap mappings for the subsequent bank with start address being less than xenheap_mfn_start (start address of the first bank).

As there is no clear requirement regarding ordering in the device tree, update code to be able to deal with by sorting memory banks. There is only one heap region on Arm32, so the sorting is fine to be done in the common code.

Quoted 6 lines
Quoted 3 lines

And committed.

Cheers,

Signature · 1 line
Julien Grall