X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdePkg%2FLibrary%2FDxeExtractGuidedSectionLib%2FDxeExtractGuidedSectionLib.c;h=e0a07835d709d406aa522be9b8090f836d018dc7;hp=164691389b3194c9272ecad4390af0d1a19465b3;hb=19388d2960b2fe0347da23799e93ccc52f540214;hpb=e6c560aad63b09e6aaee3ccc65be462651772fe5
diff --git a/MdePkg/Library/DxeExtractGuidedSectionLib/DxeExtractGuidedSectionLib.c b/MdePkg/Library/DxeExtractGuidedSectionLib/DxeExtractGuidedSectionLib.c
index 164691389b..e0a07835d7 100644
--- a/MdePkg/Library/DxeExtractGuidedSectionLib/DxeExtractGuidedSectionLib.c
+++ b/MdePkg/Library/DxeExtractGuidedSectionLib/DxeExtractGuidedSectionLib.c
@@ -1,92 +1,139 @@
-/*++
+/** @file
+ Provide generic extract guided section functions for Dxe phase.
-Copyright (c) 2007, Intel Corporation
-All rights reserved. This program and the accompanying materials
-are licensed and made available under the terms and conditions of the BSD License
-which accompanies this distribution. The full text of the license may be found at
-http://opensource.org/licenses/bsd-license.php
+ Copyright (c) 2007 - 2008, Intel Corporation. All rights reserved.
+ This program and the accompanying materials
+ are licensed and made available under the terms and conditions of the BSD License
+ which accompanies this distribution. The full text of the license may be found at
+ http://opensource.org/licenses/bsd-license.php
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-Module Name:
-
- DxeExtractGuidedSectionLib.c
-
-Abstract:
-
- Provide generic extract guided section functions.
-
---*/
+**/
#include
#include
-#include
#include
#include
#include
-STATIC GUID *mExtractHandlerGuidTable;
-STATIC UINT32 mNumberOfExtractHandler;
+#define EXTRACT_HANDLER_TABLE_SIZE 0x10
-STATIC EXTRACT_GUIDED_SECTION_DECODE_HANDLER *mExtractDecodeHandlerTable;
-STATIC EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER *mExtractGetInfoHandlerTable;
+UINT32 mNumberOfExtractHandler = 0;
+UINT32 mMaxNumberOfExtractHandler = 0;
-/**
- Construtor allocates the global memory to store the registered guid and Handler list.
+GUID *mExtractHandlerGuidTable = NULL;
+EXTRACT_GUIDED_SECTION_DECODE_HANDLER *mExtractDecodeHandlerTable = NULL;
+EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER *mExtractGetInfoHandlerTable = NULL;
- @param ImageHandle The firmware allocated handle for the EFI image.
- @param SystemTable A pointer to the EFI System Table.
+/**
+ Reallocates more global memory to store the registered guid and Handler list.
- @retval RETURN_SUCCESS Allocate the global memory space to store guid and funciton tables.
- @retval RETURN_OUT_OF_RESOURCES No enough memory to allocated.
+ @retval RETURN_SUCCESS Reallocate more global memory space to store guid and function tables.
+ @retval RETURN_OUT_OF_RESOURCES No enough memory to allocated.
**/
RETURN_STATUS
EFIAPI
-DxeExtractGuidedSectionLibConstructor (
- IN EFI_HANDLE ImageHandle,
- IN EFI_SYSTEM_TABLE *SystemTable
+ReallocateExtractHandlerTable (
)
-{
+{
//
- // Allocate global pool space to store the registered handler and its guid value.
+ // Reallocate memory for GuidTable
//
- mExtractHandlerGuidTable = (GUID *) AllocatePool (PcdGet32 (PcdMaximumGuidedExtractHandler) * sizeof (GUID));
+ mExtractHandlerGuidTable = ReallocatePool (
+ mMaxNumberOfExtractHandler * sizeof (GUID),
+ (mMaxNumberOfExtractHandler + EXTRACT_HANDLER_TABLE_SIZE) * sizeof (GUID),
+ mExtractHandlerGuidTable
+ );
+
if (mExtractHandlerGuidTable == NULL) {
- return RETURN_OUT_OF_RESOURCES;
+ goto Done;
}
-
- mExtractDecodeHandlerTable = (EXTRACT_GUIDED_SECTION_DECODE_HANDLER *) AllocatePool (PcdGet32 (PcdMaximumGuidedExtractHandler) * sizeof (EXTRACT_GUIDED_SECTION_DECODE_HANDLER));
+
+ //
+ // Reallocate memory for Decode handler Table
+ //
+ mExtractDecodeHandlerTable = ReallocatePool (
+ mMaxNumberOfExtractHandler * sizeof (EXTRACT_GUIDED_SECTION_DECODE_HANDLER),
+ (mMaxNumberOfExtractHandler + EXTRACT_HANDLER_TABLE_SIZE) * sizeof (EXTRACT_GUIDED_SECTION_DECODE_HANDLER),
+ mExtractDecodeHandlerTable
+ );
+
if (mExtractDecodeHandlerTable == NULL) {
- return RETURN_OUT_OF_RESOURCES;
+ goto Done;
}
- mExtractGetInfoHandlerTable = (EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER *) AllocatePool (PcdGet32 (PcdMaximumGuidedExtractHandler) * sizeof (EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER));
+ //
+ // Reallocate memory for GetInfo handler Table
+ //
+ mExtractGetInfoHandlerTable = ReallocatePool (
+ mMaxNumberOfExtractHandler * sizeof (EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER),
+ (mMaxNumberOfExtractHandler + EXTRACT_HANDLER_TABLE_SIZE) * sizeof (EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER),
+ mExtractGetInfoHandlerTable
+ );
+
if (mExtractGetInfoHandlerTable == NULL) {
- return RETURN_OUT_OF_RESOURCES;
+ goto Done;
}
//
- // the initialized number is Zero.
+ // Increase max handler number
//
- mNumberOfExtractHandler = 0;
-
+ mMaxNumberOfExtractHandler = mMaxNumberOfExtractHandler + EXTRACT_HANDLER_TABLE_SIZE;
return RETURN_SUCCESS;
+
+Done:
+ if (mExtractHandlerGuidTable != NULL) {
+ FreePool (mExtractHandlerGuidTable);
+ }
+ if (mExtractDecodeHandlerTable != NULL) {
+ FreePool (mExtractDecodeHandlerTable);
+ }
+ if (mExtractGetInfoHandlerTable != NULL) {
+ FreePool (mExtractGetInfoHandlerTable);
+ }
+
+ return RETURN_OUT_OF_RESOURCES;
+}
+/**
+ Constructor allocates the global memory to store the registered guid and Handler list.
+
+ @param ImageHandle The firmware allocated handle for the EFI image.
+ @param SystemTable A pointer to the EFI System Table.
+
+ @retval RETURN_SUCCESS Allocate the global memory space to store guid and function tables.
+ @retval RETURN_OUT_OF_RESOURCES No enough memory to allocated.
+**/
+RETURN_STATUS
+EFIAPI
+DxeExtractGuidedSectionLibConstructor (
+ IN EFI_HANDLE ImageHandle,
+ IN EFI_SYSTEM_TABLE *SystemTable
+ )
+{
+ return ReallocateExtractHandlerTable ();
}
-/**
- Get the supported exract guided section Handler guid list.
- If ExtractHandlerGuidTable = NULL, then ASSERT.
+/**
+ Retrieve the list GUIDs that have been registered through ExtractGuidedSectionRegisterHandlers().
+
+ Sets ExtractHandlerGuidTable so it points at a callee allocated array of registered GUIDs.
+ The total number of GUIDs in the array are returned. Since the array of GUIDs is callee allocated
+ and caller must treat this array of GUIDs as read-only data.
+ If ExtractHandlerGuidTable is NULL, then ASSERT().
+
+ @param[out] ExtractHandlerGuidTable A pointer to the array of GUIDs that have been registered through
+ ExtractGuidedSectionRegisterHandlers().
- @param[in, out] ExtractHandlerGuidTable The extract Handler guid pointer list.
+ @return the number of the supported extract guided Handler.
- @retval return the number of the supported extract guided Handler.
**/
UINTN
EFIAPI
ExtractGuidedSectionGetGuidList (
- IN OUT GUID **ExtractHandlerGuidTable
+ OUT GUID **ExtractHandlerGuidTable
)
{
ASSERT (ExtractHandlerGuidTable != NULL);
@@ -95,16 +142,29 @@ ExtractGuidedSectionGetGuidList (
return mNumberOfExtractHandler;
}
-/**
- Register Guided Section Extract and GetInfo handler.
+/**
+ Registers handlers of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER and EXTRACT_GUIDED_SECTION_DECODE_HANDLER
+ for a specific GUID section type.
+
+ Registers the handlers specified by GetInfoHandler and DecodeHandler with the GUID specified by SectionGuid.
+ If the GUID value specified by SectionGuid has already been registered, then return RETURN_ALREADY_STARTED.
+ If there are not enough resources available to register the handlers then RETURN_OUT_OF_RESOURCES is returned.
+
+ If SectionGuid is NULL, then ASSERT().
+ If GetInfoHandler is NULL, then ASSERT().
+ If DecodeHandler is NULL, then ASSERT().
+
+ @param[in] SectionGuid A pointer to the GUID associated with the the handlers
+ of the GUIDed section type being registered.
+ @param[in] GetInfoHandler Pointer to a function that examines a GUIDed section and returns the
+ size of the decoded buffer and the size of an optional scratch buffer
+ required to actually decode the data in a GUIDed section.
+ @param[in] DecodeHandler Pointer to a function that decodes a GUIDed section into a caller
+ allocated output buffer.
+
+ @retval RETURN_SUCCESS The handlers were registered.
+ @retval RETURN_OUT_OF_RESOURCES There are not enough resources available to register the handlers.
- @param[in] SectionGuid The guid matches this Extraction function.
- @param[in] GetInfoHandler Function to get info from guided section.
- @param[in] DecodeHandler Function to extract guided section.
-
- @retval RETURN_SUCCESS Register Guided Section Extract function successfully.
- @retval RETURN_OUT_OF_RESOURCES Resource is not enough to register new function.
- @retval RETURN_INVALID_PARAMETER Input pointer to Guid value is not valid.
**/
RETURN_STATUS
EFIAPI
@@ -114,17 +174,35 @@ ExtractGuidedSectionRegisterHandlers (
IN EXTRACT_GUIDED_SECTION_DECODE_HANDLER DecodeHandler
)
{
+ UINT32 Index;
//
// Check input paramter.
//
- if (SectionGuid == NULL) {
- return RETURN_INVALID_PARAMETER;
+ ASSERT (SectionGuid != NULL);
+ ASSERT (GetInfoHandler != NULL);
+ ASSERT (DecodeHandler != NULL);
+
+ //
+ // Search the match registered GetInfo handler for the input guided section.
+ //
+ for (Index = 0; Index < mNumberOfExtractHandler; Index ++) {
+ if (CompareGuid (&mExtractHandlerGuidTable[Index], SectionGuid)) {
+ //
+ // If the guided handler has been registered before, only update its handler.
+ //
+ mExtractDecodeHandlerTable [Index] = DecodeHandler;
+ mExtractGetInfoHandlerTable [Index] = GetInfoHandler;
+ return RETURN_SUCCESS;
+ }
}
+
//
// Check the global table is enough to contain new Handler.
//
- if (mNumberOfExtractHandler >= PcdGet32 (PcdMaximumGuidedExtractHandler)) {
- return RETURN_OUT_OF_RESOURCES;
+ if (mNumberOfExtractHandler >= mMaxNumberOfExtractHandler) {
+ if (ReallocateExtractHandlerTable () != RETURN_SUCCESS) {
+ return RETURN_OUT_OF_RESOURCES;
+ }
}
//
@@ -137,25 +215,38 @@ ExtractGuidedSectionRegisterHandlers (
return RETURN_SUCCESS;
}
-/**
- Get information from the guided section. This function first gets the guid value
- from guided section header, then match this guid in the registered extract Handler list
- to its corresponding getinfo Handler.
- If not found, RETURN_INVALID_PARAMETER will be return.
- If found, it will call the getinfo Handler to get the required size and attribute.
-
- It will ASSERT () if the pointer to OutputBufferSize is NULL.
- It will ASSERT () if the pointer to ScratchBufferSize is NULL.
- It will ASSERT () if the pointer to SectionAttribute is NULL.
-
- @param[in] InputSection Buffer containing the input GUIDed section to be processed.
- @param[out] OutputBufferSize The size of OutputBuffer.
- @param[out] ScratchBufferSize The size of ScratchBuffer.
- @param[out] SectionAttribute The attribute of the input guided section.
-
- @retval RETURN_SUCCESS Get the required information successfully.
- @retval RETURN_INVALID_PARAMETER The input data can't be parsed correctly.
- The GUID in InputSection does not match any registered guid list.
+/**
+ Retrieves a GUID from a GUIDed section and uses that GUID to select an associated handler of type
+ EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers().
+ The selected handler is used to retrieve and return the size of the decoded buffer and the size of an
+ optional scratch buffer required to actually decode the data in a GUIDed section.
+
+ Examines a GUIDed section specified by InputSection.
+ If GUID for InputSection does not match any of the GUIDs registered through ExtractGuidedSectionRegisterHandlers(),
+ then RETURN_UNSUPPORTED is returned.
+ If the GUID of InputSection does match the GUID that this handler supports, then the the associated handler
+ of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers()
+ is used to retrieve the OututBufferSize, ScratchSize, and Attributes values. The return status from the handler of
+ type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER is returned.
+
+ If InputSection is NULL, then ASSERT().
+ If OutputBufferSize is NULL, then ASSERT().
+ If ScratchBufferSize is NULL, then ASSERT().
+ If SectionAttribute is NULL, then ASSERT().
+
+ @param[in] InputSection A pointer to a GUIDed section of an FFS formatted file.
+ @param[out] OutputBufferSize A pointer to the size, in bytes, of an output buffer required if the buffer
+ specified by InputSection were decoded.
+ @param[out] ScratchBufferSize A pointer to the size, in bytes, required as scratch space if the buffer specified by
+ InputSection were decoded.
+ @param[out] SectionAttribute A pointer to the attributes of the GUIDed section. See the Attributes field of
+ EFI_GUID_DEFINED_SECTION in the PI Specification.
+
+ @retval RETURN_SUCCESS Get the required information successfully.
+ @retval RETURN_UNSUPPORTED The GUID from the section specified by InputSection does not match any of
+ the GUIDs registered with ExtractGuidedSectionRegisterHandlers().
+ @retval Others The return status from the handler associated with the GUID retrieved from
+ the section specified by InputSection.
**/
RETURN_STATUS
@@ -168,11 +259,8 @@ ExtractGuidedSectionGetInfo (
)
{
UINT32 Index;
-
- if (InputSection == NULL) {
- return RETURN_INVALID_PARAMETER;
- }
-
+
+ ASSERT (InputSection != NULL);
ASSERT (OutputBufferSize != NULL);
ASSERT (ScratchBufferSize != NULL);
ASSERT (SectionAttribute != NULL);
@@ -182,94 +270,96 @@ ExtractGuidedSectionGetInfo (
//
for (Index = 0; Index < mNumberOfExtractHandler; Index ++) {
if (CompareGuid (&mExtractHandlerGuidTable[Index], &(((EFI_GUID_DEFINED_SECTION *) InputSection)->SectionDefinitionGuid))) {
- break;
+ //
+ // Call the match handler to getinfo for the input section data.
+ //
+ return mExtractGetInfoHandlerTable [Index] (
+ InputSection,
+ OutputBufferSize,
+ ScratchBufferSize,
+ SectionAttribute
+ );
}
}
//
// Not found, the input guided section is not supported.
//
- if (Index == mNumberOfExtractHandler) {
- return RETURN_INVALID_PARAMETER;
- }
-
- //
- // Call the match handler to getinfo for the input section data.
- //
- return mExtractGetInfoHandlerTable [Index] (
- InputSection,
- OutputBufferSize,
- ScratchBufferSize,
- SectionAttribute
- );
+ return RETURN_UNSUPPORTED;
}
-/**
- Extract data from the guided section. This function first gets the guid value
- from guided section header, then match this guid in the registered extract Handler list
- to its corresponding extract Handler.
- If not found, RETURN_INVALID_PARAMETER will be return.
- If found, it will call this extract Handler to get output data and AuthenticationStatus.
-
- It will ASSERT () if the pointer to OutputBuffer is NULL.
- It will ASSERT () if the pointer to AuthenticationStatus is NULL.
-
- @param[in] InputSection Buffer containing the input GUIDed section to be processed.
- @param[out] OutputBuffer OutputBuffer to point the start of the section's contents
- if guided data is not required prcessing. Otherwise,
- OutputBuffer to contain the output data, which is
- allocated by the caller.
- @param[out] ScratchBuffer A pointer to a caller-allocated buffer for function internal use.
+/**
+ Retrieves the GUID from a GUIDed section and uses that GUID to select an associated handler of type
+ EXTRACT_GUIDED_SECTION_DECODE_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers().
+ The selected handler is used to decode the data in a GUIDed section and return the result in a caller
+ allocated output buffer.
+
+ Decodes the GUIDed section specified by InputSection.
+ If GUID for InputSection does not match any of the GUIDs registered through ExtractGuidedSectionRegisterHandlers(),
+ then RETURN_UNSUPPORTED is returned.
+ If the GUID of InputSection does match the GUID that this handler supports, then the the associated handler
+ of type EXTRACT_GUIDED_SECTION_DECODE_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers()
+ is used to decode InputSection into the buffer specified by OutputBuffer and the authentication status of this
+ decode operation is returned in AuthenticationStatus. If the decoded buffer is identical to the data in InputSection,
+ then OutputBuffer is set to point at the data in InputSection. Otherwise, the decoded data will be placed in caller
+ allocated buffer specified by OutputBuffer. This function is responsible for computing the EFI_AUTH_STATUS_PLATFORM_OVERRIDE
+ bit of in AuthenticationStatus. The return status from the handler of type EXTRACT_GUIDED_SECTION_DECODE_HANDLER is returned.
+
+ If InputSection is NULL, then ASSERT().
+ If OutputBuffer is NULL, then ASSERT().
+ If ScratchBuffer is NULL and this decode operation requires a scratch buffer, then ASSERT().
+ If AuthenticationStatus is NULL, then ASSERT().
+
+ @param[in] InputSection A pointer to a GUIDed section of an FFS formatted file.
+ @param[out] OutputBuffer A pointer to a buffer that contains the result of a decode operation.
+ @param[in] ScratchBuffer A caller allocated buffer that may be required by this function as a scratch buffer to perform the decode operation.
@param[out] AuthenticationStatus
- A pointer to a caller-allocated UINT32 that indicates the
- authentication status of the output buffer.
-
- @retval RETURN_SUCCESS Get the output data, size and AuthenticationStatus successfully.
- @retval RETURN_INVALID_PARAMETER The input data can't be parsed correctly.
- The GUID in InputSection does not match any registered guid.
-
+ A pointer to the authentication status of the decoded output buffer. See the definition
+ of authentication status in the EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI section of the PI
+ Specification.
+
+ @retval RETURN_SUCCESS The buffer specified by InputSection was decoded.
+ @retval RETURN_UNSUPPORTED The section specified by InputSection does not match the GUID this handler supports.
+ @retval RETURN_INVALID_PARAMETER The section specified by InputSection can not be decoded.
+
**/
RETURN_STATUS
EFIAPI
ExtractGuidedSectionDecode (
IN CONST VOID *InputSection,
OUT VOID **OutputBuffer,
- OUT VOID *ScratchBuffer, OPTIONAL
+ IN VOID *ScratchBuffer, OPTIONAL
OUT UINT32 *AuthenticationStatus
)
{
UINT32 Index;
- if (InputSection == NULL) {
- return RETURN_INVALID_PARAMETER;
- }
-
+ //
+ // Check the input parameters
+ //
+ ASSERT (InputSection != NULL);
ASSERT (OutputBuffer != NULL);
ASSERT (AuthenticationStatus != NULL);
//
- // Search the match registered GetInfo handler for the input guided section.
+ // Search the match registered extract handler for the input guided section.
//
for (Index = 0; Index < mNumberOfExtractHandler; Index ++) {
if (CompareGuid (&mExtractHandlerGuidTable[Index], &(((EFI_GUID_DEFINED_SECTION *) InputSection)->SectionDefinitionGuid))) {
- break;
+ //
+ // Call the match handler to extract raw data for the input section data.
+ //
+ return mExtractDecodeHandlerTable [Index] (
+ InputSection,
+ OutputBuffer,
+ ScratchBuffer,
+ AuthenticationStatus
+ );
}
}
//
// Not found, the input guided section is not supported.
//
- if (Index == mNumberOfExtractHandler) {
- return RETURN_INVALID_PARAMETER;
- }
-
- //
- // Call the match handler to getinfo for the input section data.
- //
- return mExtractDecodeHandlerTable [Index] (
- InputSection,
- OutputBuffer,
- ScratchBuffer,
- AuthenticationStatus
- );
+ return RETURN_UNSUPPORTED;
}