Preserve the EFI System Resource Table for dom0
PATCH v5 1/1 Preserve the EFI System Resource Table for dom0
The EFI System Resource Table (ESRT) is necessary for fwupd to identify firmware updates to install. According to the UEFI specification §23.4, the ESRT shall be stored in memory of type EfiBootServicesData. However, memory of type EfiBootServicesData is considered general-purpose memory by Xen, so the ESRT needs to be moved somewhere where Xen will not overwrite it. Copy the ESRT to memory of type EfiRuntimeServicesData, which Xen will not reuse. dom0 can use the ESRT if (and only if) it is in memory of type EfiRuntimeServicesData.
Earlier versions of this patch reserved the memory in which the ESRT was located. This created awkward alignment problems, and required either splitting the E820 table or wasting memory. It also would have required a new platform op for dom0 to use to indicate if the ESRT is reserved. By copying the ESRT into EfiRuntimeServicesData memory, the E820 table does not need to be modified, and dom0 can just check the type of the memory region containing the ESRT. The copy is only done if the ESRT is not already in EfiRuntimeServicesData memory, avoiding memory leaks on repeated kexec.
See https://lore.kernel.org/xen-devel/20200818184018.GN1679@mail-itl/T/
for details.
--- xen/common/efi/boot.c | 106 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 104 insertions(+), 2 deletions(-)
xen/common/efi/boot.c +104 -2
@@ -39,6 +39,25 @@ { 0x605dab50, 0xe046, 0x4300, {0xab, 0xb6, 0x3d, 0xd8, 0x10, 0xdd, 0x8b, 0x23} } #define APPLE_PROPERTIES_PROTOCOL_GUID \ { 0x91bd12fe, 0xf6c3, 0x44fb, { 0xa5, 0xb7, 0x51, 0x22, 0xab, 0x30, 0x3a, 0xe0} } +#define ESRT_GUID \ + { 0xb122a263, 0x3661, 0x4f68, {0x99, 0x29, 0x78, 0xf8, 0xb0, 0xd6, 0x21, 0x80} } + +typedef struct _ESRT_ENTRY { + EFI_GUID FwClass; +UINT32 FwType; +UINT32 FwVersion; +UINT32 FwLowestSupportedVersion; +UINT32 FwCapsuleFlags; +UINT32 FwLastAttemptVersion; +UINT32 FwLastAttemptStatus; +}ESRT_ENTRY ; + +typedef struct _ESRT { +UINT32 Count; +UINT32 Max; +UINT64 Version; +ESRT_ENTRY Entries[]; +}ESRT ;typedef EFI_STATUS (/* _not_ EFIAPI */ *EFI_SHIM_LOCK_VERIFY) (
@@ -567,6 +586,38 @@ static int __init efi_check_dt_boot(const EFI_LOADED_IMAGE *loaded_image) }#endif +static UINTN __initdata esrt =EFI_INVALID_TABLE_ADDR ; + +static size_t __init get_esrt_size (const EFI_MEMORY_DESCRIPTOR *desc) +{ +size_t available_len, len; +const UINTN physical_start = desc->PhysicalStart; +const ESRT *esrt_ptr; + + len = desc->NumberOfPages <<EFI_PAGE_SHIFT ; +if ( esrt ==EFI_INVALID_TABLE_ADDR ) +return 0 ; +if ( physical_start > esrt || esrt - physical_start >= len ) +return 0 ; +/* +* The specification requires EfiBootServicesData, but accept +* EfiRuntimeServicesData, which is a more logical choice. +*/ +if ( (desc->Type != EfiRuntimeServicesData) && + (desc->Type != EfiBootServicesData) ) +return 0 ; + available_len = len - (esrt - physical_start); +if ( available_len <= offsetof(ESRT , Entries) ) +return 0 ; + available_len -= offsetof(ESRT , Entries); + esrt_ptr = (const ESRT *)esrt; +if ( esrt_ptr->Version !=1 || !esrt_ptr->Count ) +return 0 ; +if ( esrt_ptr->Count > available_len /sizeof (esrt_ptr->Entries[0 ]) ) +return 0 ; +return esrt_ptr->Count *sizeof (esrt_ptr->Entries[0 ]); +} +/* * Include architecture specific implementation here, which references the * static globals defined above.
@@ -845,6 +896,8 @@ static UINTN __init efi_find_gop_mode(EFI_GRAPHICS_OUTPUT_PROTOCOL *gop,return gop_mode; } +static EFI_GUID __initdata esrt_guid =ESRT_GUID ; +static void __init efi_tables (void ) {unsigned int i;
@@ -868,6 +921,8 @@ static void __init efi_tables(void) efi.smbios = (unsigned long )efi_ct[i].VendorTable;if (match_guid (&smbios3_guid, &efi_ct[i].VendorGuid) ) efi.smbios3 = (unsigned long )efi_ct[i].VendorTable; +if (match_guid (&esrt_guid, &efi_ct[i].VendorGuid) ) + esrt = (UINTN )efi_ct[i].VendorTable; }#ifndef CONFIG_ARM /* TODO - disabled until implemented on ARM */
@@ -1056,9 +1111,7 @@ static void __init efi_exit_boot(EFI_HANDLE ImageHandle, EFI_SYSTEM_TABLE *SysteEFI_STATUS status;UINTN info_size =0 , map_key;bool retry; -#ifdef CONFIG_EFI_SET_VIRTUAL_ADDRESS_MAP unsigned int i; -#endif efi_bs->GetMemoryMap (&info_size,NULL , &map_key, &efi_mdesc_size, &mdesc_ver);
@@ -1067,6 +1120,46 @@ static void __init efi_exit_boot(EFI_HANDLE ImageHandle, EFI_SYSTEM_TABLE *Systeif ( !efi_memmap )blexit (L"Unable to allocate memory for EFI memory map" ); + efi_memmap_size = info_size; + status = SystemTable->BootServices->GetMemoryMap (&efi_memmap_size, + efi_memmap, &map_key, + &efi_mdesc_size, + &mdesc_ver); +if (EFI_ERROR (status) ) +PrintErrMesg (L"Cannot obtain memory map" , status); + +/* Try to obtain the ESRT. Errors are not fatal. */ +for ( i =0 ; i < efi_memmap_size; i += efi_mdesc_size ) + { +/* +* ESRT needs to be moved to memory of type EfiRuntimeServicesData +* so that the memory it is in will not be used for other purposes. +*/ +void *new_esrt =NULL ; +size_t esrt_size =get_esrt_size (efi_memmap + i); + +if ( !esrt_size ) +continue ; +if ( ((EFI_MEMORY_DESCRIPTOR *)(efi_memmap + i))->Type == + EfiRuntimeServicesData ) +break ;/* ESRT already safe from reuse */ + status = efi_bs->AllocatePool (EfiRuntimeServicesData, esrt_size, + &new_esrt); +if ( status ==EFI_SUCCESS && new_esrt ) + { +memcpy (new_esrt, (void *)esrt, esrt_size); + status = efi_bs->InstallConfigurationTable (&esrt_guid, new_esrt); +if ( status !=EFI_SUCCESS ) + { +PrintStr (L"Cannot install new ESRT\r\n" ); + efi_bs->FreePool (new_esrt); + } + } +else +PrintStr (L"Cannot allocate memory for ESRT\r\n" ); +break ; + } +for ( retry = false; ; retry = true ) { efi_memmap_size = info_size;
@@ -1753,3 +1846,12 @@ void __init efi_init_memory(void) unmap_domain_page(efi_l4t); }#endif + +/* +* Local variables: +* mode: C +* c-file-style: "BSD" +* c-basic-offset: 4 +* indent-tabs-mode: nil +* End: +*/
Signature · 3 lines
Sincerely, Demi Marie Obenour (she/her/hers) Invisible Things Lab
xen/common/efi/boot.c line 43
Quoted 8 lines · Demi Marie Obenour
xen/common/efi/boot.c +2
-0@@ -39,6 +39,25 @@ { 0x605dab50, 0xe046, 0x4300, {0xab, 0xb6, 0x3d, 0xd8, 0x10, 0xdd, 0x8b, 0x23} } #define APPLE_PROPERTIES_PROTOCOL_GUID \ { 0x91bd12fe, 0xf6c3, 0x44fb, { 0xa5, 0xb7, 0x51, 0x22, 0xab, 0x30, 0x3a, 0xe0} } +#define ESRT_GUID \ + { 0xb122a263, 0x3661, 0x4f68, {0x99, 0x29, 0x78, 0xf8, 0xb0, 0xd6, 0x21, 0x80} }
I'm sorry, but it looks like my earlier comments still weren't clear
enough: The spec calls this EFI_SYSTEM_RESOURCE_TABLE_GUID, ...
xen/common/efi/boot.c line 45
Quoted 1 line
xen/common/efi/boot.c +1
-0+typedef struct _ESRT_ENTRY {
... has no tag here, ...
xen/common/efi/boot.c line 53
Quoted 8 lines
xen/common/efi/boot.c +8
-0+EFI_GUID FwClass; +UINT32 FwType; +UINT32 FwVersion; +UINT32 FwLowestSupportedVersion; +UINT32 FwCapsuleFlags; +UINT32 FwLastAttemptVersion; +UINT32 FwLastAttemptStatus; +}ESRT_ENTRY ;
... calls this EFI_SYSTEM_RESOURCE_ENTRY, ...
xen/common/efi/boot.c line 55
Quoted 1 line
xen/common/efi/boot.c +1
-0+typedef struct _ESRT {
... again has no tag here, and ...
xen/common/efi/boot.c line 60
Quoted 5 lines
xen/common/efi/boot.c +5
-0+UINT32 Count; +UINT32 Max; +UINT64 Version; +ESRT_ENTRY Entries[]; +}ESRT ;
... calls this EFI_SYSTEM_RESOURCE_TABLE. Also some of the field names still aren't matching the spec.
Quoted 26 lines
xen/common/efi/boot.c +22
-0@@ -1067,6 +1120,46 @@ static void __init efi_exit_boot(EFI_HANDLE ImageHandle, EFI_SYSTEM_TABLE *Systeif ( !efi_memmap )blexit (L"Unable to allocate memory for EFI memory map" ); + efi_memmap_size = info_size; + status = SystemTable->BootServices->GetMemoryMap (&efi_memmap_size, + efi_memmap, &map_key, + &efi_mdesc_size, + &mdesc_ver); +if (EFI_ERROR (status) ) +PrintErrMesg (L"Cannot obtain memory map" , status); + +/* Try to obtain the ESRT. Errors are not fatal. */ +for ( i =0 ; i < efi_memmap_size; i += efi_mdesc_size ) + { +/* +* ESRT needs to be moved to memory of type EfiRuntimeServicesData +* so that the memory it is in will not be used for other purposes. +*/ +void *new_esrt =NULL ; +size_t esrt_size =get_esrt_size (efi_memmap + i); + +if ( !esrt_size ) +continue ; +if ( ((EFI_MEMORY_DESCRIPTOR *)(efi_memmap + i))->Type == + EfiRuntimeServicesData )
xen/common/efi/boot.c static void __init efi_exit_boot(EFI_HANDLE ImageHandle, EFI_SYSTEM_TABLE *Syste · line 1154
Quoted 10 lines
xen/common/efi/boot.c +10
-0+break ;/* ESRT already safe from reuse */ + status = efi_bs->AllocatePool (EfiRuntimeServicesData, esrt_size, + &new_esrt); +if ( status ==EFI_SUCCESS && new_esrt ) + { +memcpy (new_esrt, (void *)esrt, esrt_size); + status = efi_bs->InstallConfigurationTable (&esrt_guid, new_esrt); +if ( status !=EFI_SUCCESS ) + { +PrintStr (L"Cannot install new ESRT\r\n" );
Perhaps better PrintErr() here and ...
xen/common/efi/boot.c static void __init efi_exit_boot(EFI_HANDLE ImageHandle, EFI_SYSTEM_TABLE *Syste · line 1159
Quoted 5 lines
xen/common/efi/boot.c +5
-0+ efi_bs->FreePool (new_esrt); + } + } +else +PrintStr (L"Cannot allocate memory for ESRT\r\n" );
... here?
Jan