xen/arm: Probe the load/entry point address of an uImage correctly
PATCH v4 1/1 xen/arm: Probe the load/entry point address of an uImage correctly
Currently, kernel_uimage_probe() does not read the load/entry point address set in the uImge header. Thus, info->zimage.start is 0 (default value). This causes, kernel_zimage_place() to treat the binary (contained within uImage) as position independent executable. Thus, it loads it at an incorrect address.
The correct approach would be to read "uimage.load" and set info->zimage.start. This will ensure that the binary is loaded at the correct address. Also, read "uimage.ep" and set info->entry (ie kernel entry address).
If user provides load address (ie "uimage.load") as 0x0, then the image is treated as position independent executable. Xen can load such an image at any address it considers appropriate. A position independent executable cannot have a fixed entry point address.
This behavior is applicable for both arm32 and arm64 platforms.
Earlier for arm32 and arm64 platforms, Xen was ignoring the load and entry point address set in the uImage header. With this commit, Xen will use them. This makes the behavior of Xen consistent with uboot for uimage headers.
Users who want to use Xen with statically partitioned domains, can provide non zero load address and entry address for the dom0/domU kernel. It is required that the load and entry address provided must be within the memory region allocated by Xen.
A deviation from uboot behaviour is that we consider load address == 0x0, to denote that the image supports position independent execution. This is to make the behavior consistent across uImage and zImage.
---
Changes from v1 :-
1. Added a check to ensure load address and entry address are the same.
2. Considered load address == 0x0 as position independent execution.
3. Ensured that the uImage header interpretation is consistent across arm32 and arm64.
v2 :-
1. Mentioned the change in existing behavior in booting.txt.
2. Updated booting.txt with a new section to document "Booting Guests".
v3 :-
1. Removed the constraint that the entry point should be same as the load address. Thus, Xen uses both the load address and entry point to determine where the image is to be copied and the start address.
2. Updated documentation to denote that load address and start address should be within the memory region allocated by Xen.
3. Added constraint that user cannot provide entry point for a position independent executable (PIE) image.
docs/misc/arm/booting.txt | 26 ++++++++++++++++++ xen/arch/arm/include/asm/kernel.h | 2 +- xen/arch/arm/kernel.c | 45 ++++++++++++++++++++++++++++--- 3 files changed, 69 insertions(+), 4 deletions(-)
docs/misc/arm/booting.txt +26 -0
@@ -23,6 +23,28 @@ The exceptions to this on 32-bit ARM are as follows: There are no exception on 64-bit ARM. +Booting Guests +-------------- + +Xen supports the legacy image header[3], zImage protocol for 32-bit +ARM Linux[1] and Image protocol defined for ARM64[2]. + +Earlier for legacy image protocol, Xen ignored the load address and +entry point specified in the header. This has now changed. + +Now, it loads the image at the load address provided in the header. +And the entry point is used as the kernel start address. + +A deviation from uboot is that, Xen treats "load address == 0x0" as +position independent execution (PIE). Thus, Xen will load such an image +at an address it considers appropriate. Also, user cannot specify the +entry point of a PIE image since the start address cennot be +predetermined. + +Users who want to use Xen with statically partitioned domains, can provide +the fixed non zero load address and start address for the dom0/domU kernel. +The load address and start address specified by the user in the header must +be within the memory region allocated by Xen. Firmware/bootloader requirements --------------------------------
@@ -39,3 +61,7 @@ Latest version: http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/t [2] linux/Documentation/arm64/booting.rst Latest version: http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/arm64/booting.rst + +[3] legacy format header +Latest version: https://source.denx.de/u-boot/u-boot/-/blob/master/include/image.h#L315 +https://linux.die.net/man/1/mkimage
xen/arch/arm/include/asm/kernel.h +1 -1
@@ -72,7 +72,7 @@ struct kernel_info {#ifdef CONFIG_ARM_64 paddr_t text_offset;/* 64-bit Image only */ #endif -paddr_t start;/* 32-bit zImage only */ +paddr_t start;/* Must be 0 for 64-bit Image */ } zimage; }; };
xen/arch/arm/kernel.c +42 -3
78 lines not on this page · raw message
Signature · 1 line
2.17.1
Hi Ayan,
Quoted 16 lines · Ayan Kumar Halder
Currently,
kernel_uimage_probe()does not read the load/entry point address set in the uImge header. Thus,info->zimage.startis 0 (default value). This causes,kernel_zimage_place()to treat the binary (contained within uImage) as position independent executable. Thus, it loads it at an incorrect address.The correct approach would be to read "uimage.load" and set
info->zimage.start. This will ensure that the binary is loaded at the correct address. Also, read "uimage.ep" and setinfo->entry(ie kernel entry address).If user provides load address (ie "uimage.load") as
0x0, then the image is treated as position independent executable. Xen can load such an image at any address it considers appropriate. A position independent executable cannot have a fixed entry point address.
Quoted 5 lines
This behavior is applicable for both arm32 and arm64 platforms.
Earlier for arm32 and arm64 platforms, Xen was ignoring the load and entry point address set in the uImage header. With this commit, Xen will use them. This makes the behavior of Xen consistent with uboot for uimage headers.
The changes look good to me (with a few of comments below). That said, before acking the code, I would like an existing user of uImage (maybe EPAM or Arm?) to confirm they are happy with the change.
Quoted 42 lines
Users who want to use Xen with statically partitioned domains, can provide non zero load address and entry address for the dom0/domU kernel. It is required that the load and entry address provided must be within the memory region allocated by Xen.
A deviation from uboot behaviour is that we consider load address ==
0x0, to denote that the image supports position independent execution. This is to make the behavior consistent across uImage and zImage.Signed-off-by Ayan Kumar Halder <[email protected]>---
Changes from v1 :-
1. Added a check to ensure load address and entry address are the same.
2. Considered load address ==0x0as position independent execution.
3. Ensured that the uImage header interpretation is consistent across arm32 and arm64.v2 :-
1. Mentioned the change in existing behavior in booting.txt.
2. Updated booting.txt with a new section to document "Booting Guests".v3 :-
1. Removed the constraint that the entry point should be same as the load address. Thus, Xen uses both the load address and entry point to determine where the image is to be copied and the start address.
2. Updated documentation to denote that load address and start address should be within the memory region allocated by Xen.
3. Added constraint that user cannot provide entry point for a position independent executable (PIE) image.docs/misc/arm/booting.txt | 26 ++++++++++++++++++ xen/arch/arm/include/asm/kernel.h | 2 +- xen/arch/arm/kernel.c | 45 ++++++++++++++++++++++++++++--- 3 files changed, 69 insertions(+), 4 deletions(-)docs/misc/arm/booting.txt +0
-0
docs/misc/arm/booting.txt The exceptions to this on 32-bit ARM are as follows: · line 32
Quoted 10 lines
docs/misc/arm/booting.txt +7
-0@@ -23,6 +23,28 @@ The exceptions to this on 32-bit ARM are as follows: There are no exception on 64-bit ARM. +Booting Guests +-------------- + +Xen supports the legacy image header[3], zImage protocol for 32-bit +ARM Linux[1] and Image protocol defined for ARM64[2]. + +Earlier for legacy image protocol, Xen ignored the load address and
We should explicitly say when the change was introduced. So please replace "Earlier" with "Until Xen 4.17...". The rest of the sentence may be reworded.
Quoted 67 lines
docs/misc/arm/booting.txt +19
-0+entry point specified in the header. This has now changed. + +Now, it loads the image at the load address provided in the header. +And the entry point is used as the kernel start address. + +A deviation from uboot is that, Xen treats "load address == 0x0" as +position independent execution (PIE). Thus, Xen will load such an image +at an address it considers appropriate. Also, user cannot specify the +entry point of a PIE image since the start address cennot be +predetermined. + +Users who want to use Xen with statically partitioned domains, can provide +the fixed non zero load address and start address for the dom0/domU kernel. +The load address and start address specified by the user in the header must +be within the memory region allocated by Xen. Firmware/bootloader requirements --------------------------------@@ -39,3 +61,7 @@ Latest version: http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/t [2] linux/Documentation/arm64/booting.rst Latest version: http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/arm64/booting.rst + +[3] legacy format header +Latest version: https://source.denx.de/u-boot/u-boot/-/blob/master/include/image.h#L315 +https://linux.die.net/man/1/mkimagexen/arch/arm/include/asm/kernel.h +1
-1@@ -72,7 +72,7 @@ struct kernel_info {#ifdef CONFIG_ARM_64 paddr_t text_offset;/* 64-bit Image only */ #endif -paddr_t start;/* 32-bit zImage only */ +paddr_t start;/* Must be 0 for 64-bit Image */ } zimage; }; };xen/arch/arm/kernel.c +7
-2@@ -127,7 +127,7 @@ static paddr_t __init kernel_zimage_place(struct kernel_info *info)paddr_t load_addr;#ifdef CONFIG_ARM_64 -if ( info->type ==DOMAIN_64BIT ) +if ( (info->type ==DOMAIN_64BIT ) && (info->zimage.start ==0 ) )return info->mem.bank[0 ].start + info->zimage.text_offset;#endif @@ -162,7 +162,12 @@ static void __init kernel_zimage_load(struct kernel_info *info)void *kernel;int rc; - info->entry = load_addr; +/* +* If the image does not have a fixed entry point, then use the load +* address as the entry point. +*/ +if ( info->entry ==0 ) + info->entry = load_addr;place_modules (info, load_addr, load_addr + len);
xen/arch/arm/kernel.c static int __init kernel_uimage_probe(struct kernel_info *info, · line 236
Quoted 9 lines
xen/arch/arm/kernel.c +6
-0@@ -223,10 +228,35 @@ static int __init kernel_uimage_probe(struct kernel_info *info,if ( len > size -sizeof (uimage) )return -EINVAL ; + info->zimage.start =be32_to_cpu (uimage.load); + info->entry =be32_to_cpu (uimage.ep); + +/* +* While uboot considers 0x0 to be a valid load/start address, for Xen +* to mantain parity with zimage, we consider 0x0 to denote position
s/mantain/maintain/
s/zimage/zImage/
xen/arch/arm/kernel.c static int __init kernel_uimage_probe(struct kernel_info *info, · line 239
Quoted 3 lines
xen/arch/arm/kernel.c +3
-0+* independent image. That means Xen is free to load such an image at +* any valid address. +* Thus, we will print an appropriate message.
NIT: No need to say you will print a message.
xen/arch/arm/kernel.c static int __init kernel_uimage_probe(struct kernel_info *info, · line 243
Quoted 4 lines
xen/arch/arm/kernel.c +4
-0+*/ +if ( info->zimage.start ==0 ) +printk (XENLOG_INFO +"No load address provided. Xen will decide where to load it.\n" );
NIT: I would consider to add a else and printing the requested load address and entry point.
Quoted 29 lines
xen/arch/arm/kernel.c +14
-1+ +/* +* If the image supports position independent execution, then user cannot +* provide an entry point as Xen will load such an image at any appropriate +* memory address. Thus, we need to return error. +*/ +if ( (info->zimage.start ==0 ) && (info->entry !=0 ) ) + { +printk (XENLOG_ERR +"Entry point cannot be non zero for PIE image.\n" ); +return -EINVAL ; + } + info->zimage.kernel_addr = addr +sizeof (uimage); info->zimage.len = len; - info->entry = info->zimage.start; info->load = kernel_zimage_load;#ifdef CONFIG_ARM_64 @@ -366,6 +396,7 @@ static int __init kernel_zimage64_probe(struct kernel_info *info, info->zimage.kernel_addr = addr; info->zimage.len = end - start; info->zimage.text_offset = zimage.text_offset; + info->zimage.start =0 ; info->load = kernel_zimage_load;
xen/arch/arm/kernel.c int __init kernel_probe(struct kernel_info *info, · line 470
Quoted 4 lines
xen/arch/arm/kernel.c +1
-0@@ -436,6 +467,14 @@ int __init kernel_probe(struct kernel_info *info,u64 kernel_addr, initrd_addr, dtb_addr, size;int rc; +/* We need to initialize start to 0. This field may be populated during
Coding style:
/*
* Foo
* Bar
*/
xen/arch/arm/kernel.c int __init kernel_probe(struct kernel_info *info, · line 471
Quoted 1 line
xen/arch/arm/kernel.c +1
-0+* kernel_xxx_probe() if the image has a fixed entry point (for eg
s/eg/e.g./
xen/arch/arm/kernel.c int __init kernel_probe(struct kernel_info *info, · line 480
Quoted 9 lines
xen/arch/arm/kernel.c +6
-0+* uimage.ep). +* We will use this to determine if the image has a fixed entry point or +* the load address should be used as the start address. +*/ + info->entry =0 ; +/* domain is NULL only for the hardware domain */ if ( domain ==NULL ) {
Cheers,
Signature · 1 line
Julien Grall
On 08.01.23 18:06, Julien Grall wrote:
Hello Julien, Ayan, all
Quoted 19 lines
Hi Ayan,
Quoted 16 lines · Ayan Kumar Halder
Currently,
kernel_uimage_probe()does not read the load/entry point address set in the uImge header. Thus,info->zimage.startis 0 (default value). This causes,kernel_zimage_place()to treat the binary (contained within uImage) as position independent executable. Thus, it loads it at an incorrect address.The correct approach would be to read "uimage.load" and set
info->zimage.start. This will ensure that the binary is loaded at the correct address. Also, read "uimage.ep" and setinfo->entry(ie kernel entry address).If user provides load address (ie "uimage.load") as
0x0, then the image is treated as position independent executable. Xen can load such an image at any address it considers appropriate. A position independent executable cannot have a fixed entry point address.
Quoted 7 lines
Quoted 5 lines
This behavior is applicable for both arm32 and arm64 platforms.
Earlier for arm32 and arm64 platforms, Xen was ignoring the load and entry point address set in the uImage header. With this commit, Xen will use them. This makes the behavior of Xen consistent with uboot for uimage headers.
The changes look good to me (with a few of comments below). That said, before acking the code, I would like an existing user of uImage (maybe EPAM or Arm?) to confirm they are happy with the change.
I have just re-checked current patch in our typical Xen based environment (no dom0less, Linux in Dom0) and didn't notice issues with it. But we use zImage for Dom0's kernel, so kernel_uimage_probe() is not called.
I CCed Dmytro Firsov who is playing with Zephyr in Dom0 and *might* use uImage.
[snip]
Quoted 12 lines · Oleksandr Tyshchenko
On 08.01.23 18:06, Julien Grall wrote:
Hello Julien, Ayan, all
Quoted 5 lines
Hi Ayan,
...
The changes look good to me (with a few of comments below). That said, before acking the code, I would like an existing user of uImage (maybe EPAM or Arm?) to confirm they are happy with the change.
Quoted 8 lines
I have just re-checked current patch in our typical Xen based environment (no dom0less, Linux in Dom0) and didn't notice issues with it. But we use zImage for Dom0's kernel, so
kernel_uimage_probe()is not called.I CCed Dmytro Firsov who is playing with Zephyr in Dom0 and *might* use uImage.
Hi Oleksandr, Julien, all
Current Xenutils/Zephyr Dom0 setup uses standard format for Zephyr on arm64 which is zImage. Thus uImage changes will not affect me.
Hi All,
Quoted 17 lines · Dmytro Firsov
Quoted 16 lines · Oleksandr Tyshchenko
On 08.01.23 18:06, Julien Grall wrote:
Hello Julien, Ayan, all
Quoted 5 lines
Hi Ayan,
...
The changes look good to me (with a few of comments below). That said, before acking the code, I would like an existing user of uImage (maybe EPAM or Arm?) to confirm they are happy with the change.I have just re-checked current patch in our typical Xen based environment (no dom0less, Linux in Dom0) and didn't notice issues with it. But we use zImage for Dom0's kernel, so
kernel_uimage_probe()is not called.
Quoted 6 lines
Quoted 2 lines
I CCed Dmytro Firsov who is playing with Zephyr in Dom0 and *might* use uImage.
Hi Oleksandr, Julien, all
Current Xenutils/Zephyr Dom0 setup uses standard format for Zephyr on arm64 which is zImage. Thus uImage changes will not affect me.
Many thanks for the confirmation.
I have addressed all of Julien's comments and sent out "[XEN v5] xen/arm: Probe the load/entry point address of an uImage correctly".
- Ayan