Virtualization
/
edk2
mirror of https://gitlab.com/qemu-project/edk2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Ovmf/HardwareInfoLib: Create Pei lib to parse directly from fw-cfg 

Define the HardwareInfoLib API and create the PeiHardwareInfoLib
which implements it, specifically for Pei usage, supporting
only static accesses to parse data directly from a fw-cfg file.
All list-like APIs are implemented as unsupported and only a
fw-cfg wrapper to read hardware info elements is provided.

The Hardware Info library is intended to describe non-discoverable
hardware information and share that from the host to the guest in Ovmf
platforms. The QEMU fw-cfg extension for this library provides a first
variation to parse hardware info by reading it directly from a fw-cfg
file. This library offers a wrapper function to the plain
QmeuFwCfgReadBytes which, specifically, parses header-data pairs out
of the binary values in the file. For this purpose, the approach is
incremental, reading the file block by block and outputting the values
only for a specific known hardware type (e.g. PCI host bridges). One
element is returned in each call until the end of the file is reached.

Considering fw-cfg as the first means to transport hardware info from
the host to the guest, this wrapping library offers the possibility
to statically, and in steps, read a specific type of hardware info
elements out of the file. This method reads one hardware element of a
specific type at a time, without the need to pre-allocate memory and
read the whole file or dynamically allocate memory for each new
element found.

As a usage example, the static approach followed by this library
enables early UEFI stages to use and read hardware information
supplied by the host. For instance, in early times of the PEI stage,
hardware information can be parsed out from a fw-cfg file prescinding
from memory services, that may not yet be available, and avoiding
dynamic memory allocations.

Cc: Alexander Graf <graf@amazon.de>
Cc: Gerd Hoffmann <kraxel@redhat.com>
Acked-by: Gerd Hoffmann <kraxel@redhat.com>
Signed-off-by: Nicolas Ojeda Leon <ncoleon@amazon.com>
This commit is contained in:
Nicolas Ojeda Leon 2022-01-19 10:49:15 +01:00 committed by mergify[bot]
parent 6c9f218bc0
commit 2b1a5b8c61
14 changed files with 378 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
ArmVirtPkg/ArmVirtQemu.dsc
View File

@ -81,6 +81,7 @@
PciSegmentLib|MdePkg/Library/BasePciSegmentLibPci/BasePciSegmentLibPci.inf
PciHostBridgeLib|OvmfPkg/Fdt/FdtPciHostBridgeLib/FdtPciHostBridgeLib.inf
PciHostBridgeUtilityLib|OvmfPkg/Library/PciHostBridgeUtilityLib/PciHostBridgeUtilityLib.inf
PeiHardwareInfoLib|OvmfPkg/Library/HardwareInfoLib/PeiHardwareInfoLib.inf
!if $(TPM2_ENABLE) == TRUE
Tpm2CommandLib|SecurityPkg/Library/Tpm2CommandLib/Tpm2CommandLib.inf

1
OvmfPkg/AmdSev/AmdSevX64.dsc
View File

@ -168,6 +168,7 @@
FrameBufferBltLib|MdeModulePkg/Library/FrameBufferBltLib/FrameBufferBltLib.inf
BlobVerifierLib|OvmfPkg/AmdSev/BlobVerifierLibSevHashes/BlobVerifierLibSevHashes.inf
MemEncryptTdxLib|OvmfPkg/Library/BaseMemEncryptTdxLib/BaseMemEncryptTdxLib.inf
PeiHardwareInfoLib|OvmfPkg/Library/HardwareInfoLib/PeiHardwareInfoLib.inf
!if $(SOURCE_DEBUG_ENABLE) == TRUE
PeCoffExtraActionLib|SourceLevelDebugPkg/Library/PeCoffExtraActionLibDebug/PeCoffExtraActionLibDebug.inf

1
OvmfPkg/Bhyve/BhyveX64.dsc
View File

@ -170,6 +170,7 @@
MemEncryptSevLib|OvmfPkg/Library/BaseMemEncryptSevLib/DxeMemEncryptSevLib.inf
LockBoxLib|OvmfPkg/Library/LockBoxLib/LockBoxBaseLib.inf
MemEncryptTdxLib|OvmfPkg/Library/BaseMemEncryptTdxLib/BaseMemEncryptTdxLib.inf
PeiHardwareInfoLib|OvmfPkg/Library/HardwareInfoLib/PeiHardwareInfoLib.inf
CustomizedDisplayLib|MdeModulePkg/Library/CustomizedDisplayLib/CustomizedDisplayLib.inf
FrameBufferBltLib|MdeModulePkg/Library/FrameBufferBltLib/FrameBufferBltLib.inf

1
OvmfPkg/CloudHv/CloudHvX64.dsc
View File

@ -180,6 +180,7 @@
VirtioLib|OvmfPkg/Library/VirtioLib/VirtioLib.inf
LoadLinuxLib|OvmfPkg/Library/LoadLinuxLib/LoadLinuxLib.inf
MemEncryptSevLib|OvmfPkg/Library/BaseMemEncryptSevLib/DxeMemEncryptSevLib.inf
PeiHardwareInfoLib|OvmfPkg/Library/HardwareInfoLib/PeiHardwareInfoLib.inf
!if $(SMM_REQUIRE) == FALSE
LockBoxLib|OvmfPkg/Library/LockBoxLib/LockBoxBaseLib.inf
!endif

159
OvmfPkg/Include/Library/HardwareInfoLib.h Normal file
View File

@ -0,0 +1,159 @@
/*/@file
Hardware info parsing functions.
Binary data is expected as a consecutive series of header - object pairs.
Complete library providing static Qemu fw-cfg wrappers as well as list-like
interface to dynamically manipulate hardware info objects and parsing from
a generic blob.
Copyright 2021 - 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#ifndef __HARDWARE_INFO_LIB_H__
#define __HARDWARE_INFO_LIB_H__
#include "../Library/HardwareInfoLib/HardwareInfoTypesLib.h"
/**
Read, if available, the next Type element in the FwCfg file.
The FwCfg item must already be selected, this is a wrapper around
QemuFwCfgReadBytes and the Data pointer should be set to an existent
memory location with TypeSize bytes allocated for the date to be
properly written. If a Type element is found in the file which has a
size (in the header) greater than TypeSize, it is skipped.
@param[in] Type Hardware Info Type to search for
@param[in] TypeSize Size (in bytes) of the structure intended to
be used to dereference the data
@param[in] TotalFileSize Total size (in bytes) of the FwCfg file from
which the data is read.
@param[out] Data Pointer to a memory allocated instance into
which the data is written to.
@param[out] DataSize Size in bytes of the actually filled
data available in the Data object after a
successful operation
@param[inout] ReadIndex Index of the next byte to be read. Incremented
accordingly after a read operation to reflect
up to date status
@retval EFI_SUCCESS Next element found and read into Data
@retval EFI_INVALID_PARAMETER Operation failed
@retval EFI_END_OF_FILE End of the file reached, no more elements
to read.
**/
EFI_STATUS
QemuFwCfgReadNextHardwareInfoByType (
IN HARDWARE_INFO_TYPE Type,
IN UINTN TypeSize,
IN UINTN TotalFileSize,
OUT VOID *Data,
OUT UINTN *DataSize OPTIONAL,
IN OUT UINTN *ReadIndex
);
/**
Parse binary data containing resource information of multiple hardware
elements into a list of interpreted resources.
The translation is done on a copy-parse base so the blob can be freed
afterwards.
@param[in] Blob Binary data to be parsed
@param[in] BlobSize Size (in bytes) of the binary data
@param[in] TypeFilter Optional type to filter entries. Set to
undefined to disable filtering and retrieve all
@param[out] ListHead Head of the list to populate hardware information
@retval EFI_SUCCESS Succeed.
@retval EFI_INVALID_PARAMETER Provided Blob inforation is invalid
@retval EFI_OUT_OF_RESOURCES Out of memory, list populated as far as
possible
**/
EFI_STATUS
CreateHardwareInfoList (
IN UINT8 *Blob,
IN UINTN BlobSize,
IN HARDWARE_INFO_TYPE TypeFilter,
OUT LIST_ENTRY *ListHead
);
/**
Free the dynamically allocated list of HADWARE_INFO items populated
during parsing of Blob
@param ListHead Head of the list to be destroyed
**/
VOID
FreeHardwareInfoList (
IN OUT LIST_ENTRY *ListHead
);
/**
Retrieve the number of hardware components of a specific type
in the list.
@param[in] ListHead Head of the hardware info list
@param[in] Type Type of hardware elements to count
@param[in] TypeSize Size (in bytes) of the structure intended to
be used to dereference the data
@return Count of elements of Type found
**/
UINTN
GetHardwareInfoCountByType (
IN LIST_ENTRY *ListHead,
IN HARDWARE_INFO_TYPE Type,
IN UINTN TypeSize
);
/**
Get the First Hardware Info entry in the list of the specified type
@param[in] ListHead Head of the hardware info list
@param[in] Type Hardware Info Type to search for
@param[in] TypeSize Size (in bytes) of the structure intended to
be used to dereference the data
@return Link of first entry of specified type or list head if not found
**/
LIST_ENTRY *
GetFirstHardwareInfoByType (
IN LIST_ENTRY *ListHead,
IN HARDWARE_INFO_TYPE Type,
IN UINTN TypeSize
);
/**
Get the Next Hardware Info entry in the list with the specified
type, which follows the provided Node.
@param[in] ListHead Head of the hardware info list
@param[in] Node Current, already processed, node's link
@param[in] Type Hardware Info Type to search for
@param[in] TypeSize Size (in bytes) of the structure intended to
be used to dereference the data
@return Link of next entry, after Node, of the specified type.
List head otherwise
**/
LIST_ENTRY *
GetNextHardwareInfoByType (
IN LIST_ENTRY *ListHead,
IN LIST_ENTRY *Node,
IN HARDWARE_INFO_TYPE Type,
IN UINTN TypeSize
);
/**
Assess if Node stands at the end of the doubly linked list
@param[in] ListHead Head of the hardware info list
@param[in] Node Current Node link
@retval TRUE Node is at the end of the list
@retval FALSE Node is not at the end of the list
**/
BOOLEAN
EndOfHardwareInfoList (
IN LIST_ENTRY *ListHead,
IN LIST_ENTRY *Node
);
#endif // __HARDWARE_INFO_LIB_H__

79
OvmfPkg/Library/HardwareInfoLib/HardwareInfoPei.c Normal file
View File

@ -0,0 +1,79 @@
/*/@file
Hardware info parsing functions.
Binary data is expected as a consecutive series of header - object pairs.
Provides static Qemu fw-cfg wrappers as well as list-like interface to
dynamically manipulate hardware info objects and parsing from a generic
blob.
Copyright 2021 - 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#include <Library/DebugLib.h>
#include <Library/HardwareInfoLib.h>
EFI_STATUS
CreateHardwareInfoList (
IN UINT8 *Blob,
IN UINTN BlobSize,
IN HARDWARE_INFO_TYPE TypeFilter,
OUT LIST_ENTRY *ListHead
)
{
ASSERT (FALSE);
return EFI_UNSUPPORTED;
}
VOID
FreeHardwareInfoList (
IN OUT LIST_ENTRY *ListHead
)
{
ASSERT (FALSE);
}
UINTN
GetHardwareInfoCountByType (
IN LIST_ENTRY *ListHead,
IN HARDWARE_INFO_TYPE Type,
IN UINTN TypeSize
)
{
ASSERT (FALSE);
return 0;
}
LIST_ENTRY *
GetFirstHardwareInfoByType (
IN LIST_ENTRY *ListHead,
IN HARDWARE_INFO_TYPE Type,
IN UINTN TypeSize
)
{
ASSERT (FALSE);
return ListHead;
}
LIST_ENTRY *
GetNextHardwareInfoByType (
IN LIST_ENTRY *ListHead,
IN LIST_ENTRY *Node,
IN HARDWARE_INFO_TYPE Type,
IN UINTN TypeSize
)
{
ASSERT (FALSE);
return ListHead;
}
BOOLEAN
EndOfHardwareInfoList (
IN LIST_ENTRY *ListHead,
IN LIST_ENTRY *Node
)
{
ASSERT (FALSE);
return TRUE;
}

39
OvmfPkg/Library/HardwareInfoLib/PeiHardwareInfoLib.inf Normal file
View File

@ -0,0 +1,39 @@
## @file
# Hardware information library wrappers over Qemu fw-cfg functionality to parse,
# in a static manner, non-discoverable hardware information.
#
# Copyright 2021 - 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# SPDX-License-Identifier: BSD-2-Clause-Patent
#
#
##
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = PeiHardwareInfoLib
FILE_GUID = 3D5011B3-9CBB-4C0B-88E8-1D758283C659
MODULE_TYPE = BASE
VERSION_STRING = 1.0
LIBRARY_CLASS = PeiHardwareInfoLib
#
# The following information is for reference only and not required by the build
# tools.
#
# VALID_ARCHITECTURES = X64
#
[Sources]
HardwareInfoPei.c
QemuFwCfgHardwareInfoLib.c
HardwareInfoPciHostBridgeLib.c
[Packages]
MdeModulePkg/MdeModulePkg.dec
MdePkg/MdePkg.dec
OvmfPkg/OvmfPkg.dec
[LibraryClasses]
DebugLib
QemuFwCfgLib

88
OvmfPkg/Library/HardwareInfoLib/QemuFwCfgHardwareInfoLib.c Normal file
View File

@ -0,0 +1,88 @@
/*/@file
Qemu fw-cfg wrappers for hardware info parsing.
Provides an alternative to parse hardware information from a fw-cfg
file without relying on dynamic memory allocations.
Copyright 2021 - 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#include <Library/DebugLib.h>
#include <Library/QemuFwCfgLib.h>
#include <Library/HardwareInfoLib.h>
/**
Update an optional pointer value if possible
@param[out] DataSize Pointer to variable to be updated
@param[in] Value Value to set the pointed variable to.
**/
STATIC
VOID
UpdateDataSize (
OUT UINTN *DataSize,
IN UINTN Value
)
{
if (DataSize == NULL) {
return;
}
*DataSize = Value;
}
EFI_STATUS
QemuFwCfgReadNextHardwareInfoByType (
IN HARDWARE_INFO_TYPE Type,
IN UINTN TypeSize,
IN UINTN TotalFileSize,
OUT VOID *Data,
OUT UINTN *DataSize OPTIONAL,
IN OUT UINTN *ReadIndex
)
{
HARDWARE_INFO_HEADER Header;
if ((Data == NULL) ||
(ReadIndex == NULL) ||
(TypeSize == 0) ||
(Type == HardwareInfoTypeUndefined) ||
(TotalFileSize == 0))
{
return EFI_INVALID_PARAMETER;
}
UpdateDataSize (DataSize, 0);
while (*ReadIndex < TotalFileSize) {
QemuFwCfgReadBytes (sizeof (Header), &Header);
*ReadIndex += sizeof (Header);
if ((Header.Size > MAX_UINTN) || (((UINT64)*ReadIndex + Header.Size) > TotalFileSize)) {
*ReadIndex = TotalFileSize;
return EFI_ABORTED;
}
if ((Header.Type.Value == Type) && (Header.Size <= TypeSize)) {
QemuFwCfgReadBytes ((UINTN)Header.Size, Data);
*ReadIndex += (UINTN)Header.Size;
UpdateDataSize (DataSize, (UINTN)Header.Size);
return EFI_SUCCESS;
}
//
// Skip the bytes corresponding to the next element as it is
// not of the expected type and/or size. The TotalFileSize
// and individual elements sizes should match so the size
// check is skipped.
//
QemuFwCfgSkipBytes ((UINTN)Header.Size);
*ReadIndex += (UINTN)Header.Size;
}
return EFI_END_OF_FILE;
}

1
OvmfPkg/Microvm/MicrovmX64.dsc
View File

@ -183,6 +183,7 @@
CustomizedDisplayLib|MdeModulePkg/Library/CustomizedDisplayLib/CustomizedDisplayLib.inf
FrameBufferBltLib|MdeModulePkg/Library/FrameBufferBltLib/FrameBufferBltLib.inf
MemEncryptTdxLib|OvmfPkg/Library/BaseMemEncryptTdxLib/BaseMemEncryptTdxLib.inf
PeiHardwareInfoLib|OvmfPkg/Library/HardwareInfoLib/PeiHardwareInfoLib.inf
!if $(SOURCE_DEBUG_ENABLE) == TRUE
PeCoffExtraActionLib|SourceLevelDebugPkg/Library/PeCoffExtraActionLibDebug/PeCoffExtraActionLibDebug.inf

4
OvmfPkg/OvmfPkg.dec
View File

@ -125,6 +125,10 @@
#
PeilessStartupLib|Include/Library/PeilessStartupLib.h
## @libraryclass HardwareInfoLib
#
HardwareInfoLib|Include/Library/HardwareInfoLib.h
[Guids]
gUefiOvmfPkgTokenSpaceGuid = {0x93bb96af, 0xb9f2, 0x4eb8, {0x94, 0x62, 0xe0, 0xba, 0x74, 0x56, 0x42, 0x36}}
gEfiXenInfoGuid = {0xd3b46f3b, 0xd441, 0x1244, {0x9a, 0x12, 0x0, 0x12, 0x27, 0x3f, 0xc1, 0x4d}}

1
OvmfPkg/OvmfPkgIa32.dsc
View File

@ -178,6 +178,7 @@
LoadLinuxLib|OvmfPkg/Library/LoadLinuxLib/LoadLinuxLib.inf
MemEncryptSevLib|OvmfPkg/Library/BaseMemEncryptSevLib/DxeMemEncryptSevLib.inf
MemEncryptTdxLib|OvmfPkg/Library/BaseMemEncryptTdxLib/BaseMemEncryptTdxLibNull.inf
PeiHardwareInfoLib|OvmfPkg/Library/HardwareInfoLib/PeiHardwareInfoLib.inf
!if $(SMM_REQUIRE) == FALSE
LockBoxLib|OvmfPkg/Library/LockBoxLib/LockBoxBaseLib.inf
!endif

1
OvmfPkg/OvmfPkgIa32X64.dsc
View File

@ -182,6 +182,7 @@
LoadLinuxLib|OvmfPkg/Library/LoadLinuxLib/LoadLinuxLib.inf
MemEncryptSevLib|OvmfPkg/Library/BaseMemEncryptSevLib/DxeMemEncryptSevLib.inf
MemEncryptTdxLib|OvmfPkg/Library/BaseMemEncryptTdxLib/BaseMemEncryptTdxLibNull.inf
PeiHardwareInfoLib|OvmfPkg/Library/HardwareInfoLib/PeiHardwareInfoLib.inf
!if $(SMM_REQUIRE) == FALSE
LockBoxLib|OvmfPkg/Library/LockBoxLib/LockBoxBaseLib.inf
!endif

1
OvmfPkg/OvmfPkgX64.dsc
View File

@ -194,6 +194,7 @@
LoadLinuxLib|OvmfPkg/Library/LoadLinuxLib/LoadLinuxLib.inf
MemEncryptSevLib|OvmfPkg/Library/BaseMemEncryptSevLib/DxeMemEncryptSevLib.inf
MemEncryptTdxLib|OvmfPkg/Library/BaseMemEncryptTdxLib/BaseMemEncryptTdxLib.inf
PeiHardwareInfoLib|OvmfPkg/Library/HardwareInfoLib/PeiHardwareInfoLib.inf
!if $(SMM_REQUIRE) == FALSE
LockBoxLib|OvmfPkg/Library/LockBoxLib/LockBoxBaseLib.inf

1
OvmfPkg/OvmfXen.dsc
View File

@ -172,6 +172,7 @@
CustomizedDisplayLib|MdeModulePkg/Library/CustomizedDisplayLib/CustomizedDisplayLib.inf
FrameBufferBltLib|MdeModulePkg/Library/FrameBufferBltLib/FrameBufferBltLib.inf
MemEncryptTdxLib|OvmfPkg/Library/BaseMemEncryptTdxLib/BaseMemEncryptTdxLib.inf
PeiHardwareInfoLib|OvmfPkg/Library/HardwareInfoLib/PeiHardwareInfoLib.inf
!if $(SOURCE_DEBUG_ENABLE) == TRUE
PeCoffExtraActionLib|SourceLevelDebugPkg/Library/PeCoffExtraActionLibDebug/PeCoffExtraActionLibDebug.inf