SectionExtraction.c revision 4fd606d1f5abe38e1f42c38de1d2e895166bd0f4
/** @file
Section Extraction Protocol implementation.
Stream database is implemented as a linked list of section streams,
where each stream contains a linked list of children, which may be leaves or
encapsulations.
Children that are encapsulations generate new stream entries
when they are created. Streams can also be created by calls to
SEP->OpenSectionStream().
The database is only created far enough to return the requested data from
any given stream, or to determine that the requested data is not found.
If a GUIDed encapsulation is encountered, there are three possiblilites.
1) A support protocol is found, in which the stream is simply processed with
the support protocol.
2) A support protocol is not found, but the data is available to be read
without processing. In this case, the database is built up through the
recursions to return the data, and a RPN event is set that will enable
the stream in question to be refreshed if and when the required section
extraction protocol is published.This insures the AuthenticationStatus
does not become stale in the cache.
3) A support protocol is not found, and the data is not available to be read
without it. This results in EFI_PROTOCOL_ERROR.
Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>
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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#include <FrameworkDxe.h>
#include <Library/DebugLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/BaseMemoryLib.h>
#include <Protocol/Decompress.h>
#include <Protocol/GuidedSectionExtraction.h>
#include <Protocol/SectionExtraction.h>
//
// Local defines and typedefs
//
#define CHILD_SECTION_NODE_FROM_LINK(Node) \
typedef struct {
//
// StreamBase + OffsetInStream == pointer to section header in stream. The
// stream base is always known when walking the sections within.
//
//
// Then EncapsulatedStreamHandle below is always 0 if the section is NOT an
// encapsulating section. Otherwise, it contains the stream handle
// of the encapsulated stream. This handle is ALWAYS produced any time an
// encapsulating child is encountered, irrespective of whether the
// encapsulated stream is processed further.
//
#define STREAM_NODE_FROM_LINK(Node) \
typedef struct {
//
// Authentication status is from GUIDed encapsulations.
//
#define NULL_STREAM_HANDLE 0
typedef struct {
/**
SEP member function. This function creates and returns a new section stream
handle to represent the new section stream.
@param This Indicates the calling context.
@param SectionStreamLength Size in bytes of the section stream.
@param SectionStream Buffer containing the new section stream.
@param SectionStreamHandle A pointer to a caller allocated UINTN that on output
contains the new section stream handle.
@retval EFI_SUCCESS Section wase opened successfully.
@retval EFI_OUT_OF_RESOURCES Memory allocation failed.
@retval EFI_INVALID_PARAMETER Section stream does not end concident with end of
last section.
**/
)
;
/**
SEP member function. Retrieves requested section from section stream.
@param This Pointer to SEP instance.
@param SectionStreamHandle The section stream from which to extract the requested
section.
@param SectionType A pointer to the type of section to search for.
@param SectionDefinitionGuid If the section type is EFI_SECTION_GUID_DEFINED, then
SectionDefinitionGuid indicates which of these types
of sections to search for.
@param SectionInstance Indicates which instance of the requested section to
return.
@param Buffer Double indirection to buffer. If *Buffer is non-null on
input, then the buffer is caller allocated. If
*Buffer is NULL, then the buffer is callee allocated.
In either case, the requried buffer size is returned
in *BufferSize.
@param BufferSize On input, indicates the size of *Buffer if *Buffer is
non-null on input. On output, indicates the required
size (allocated size if callee allocated) of *Buffer.
@param AuthenticationStatus Indicates the authentication status of the retrieved
section.
@retval EFI_SUCCESS Section was retrieved successfully
@retval EFI_PROTOCOL_ERROR A GUID defined section was encountered in the section
stream with its EFI_GUIDED_SECTION_PROCESSING_REQUIRED
bit set, but there was no corresponding GUIDed Section
Extraction Protocol in the handle database. *Buffer is
unmodified.
@retval EFI_NOT_FOUND An error was encountered when parsing the SectionStream.
This indicates the SectionStream is not correctly
formatted.
@retval EFI_NOT_FOUND The requested section does not exist.
@retval EFI_OUT_OF_RESOURCES The system has insufficient resources to process the
request.
@retval EFI_INVALID_PARAMETER The SectionStreamHandle does not exist.
@retval EFI_WARN_TOO_SMALL The size of the caller allocated input buffer is
insufficient to contain the requested section. The
input buffer is filled and contents are section contents
are truncated.
**/
)
;
/**
SEP member function. Deletes an existing section stream
@param This Indicates the calling context.
@param StreamHandleToClose Indicates the stream to close
@retval EFI_SUCCESS Section stream was closed successfully.
@retval EFI_OUT_OF_RESOURCES Memory allocation failed.
@retval EFI_INVALID_PARAMETER Section stream does not end concident with end of
last section.
**/
)
;
//
// Module globals
//
};
/**
Entry point of the section extraction code. Initializes an instance of the
section extraction interface and installs it on a new handle.
@param ImageHandle A handle for the image that is initializing this driver
@param SystemTable A pointer to the EFI system table
@retval EFI_SUCCESS Driver initialized successfully
@retval EFI_OUT_OF_RESOURCES Could not allocate needed resources
**/
)
{
//
// Install SEP to a new handle
//
);
return Status;
}
/**
Check if a stream is valid.
@param SectionStream The section stream to be checked
@param SectionStreamLength The length of section stream
@return A boolean value indicating the validness of the section stream.
**/
)
{
TotalLength = 0;
while (TotalLength < SectionStreamLength) {
if (IS_SECTION2 (SectionHeader)) {
} else {
}
if (TotalLength == SectionStreamLength) {
return TRUE;
}
//
// Move to the next byte following the section...
//
//
// Figure out where the next section begins
//
}
return FALSE;
}
/**
Worker function. Constructor for section streams.
@param SectionStreamLength Size in bytes of the section stream.
@param SectionStream Buffer containing the new section stream.
@param AllocateBuffer Indicates whether the stream buffer is to be copied
or the input buffer is to be used in place.
@param AuthenticationStatus Indicates the default authentication status for the
new stream.
@param SectionStreamHandle A pointer to a caller allocated section stream handle.
@retval EFI_SUCCESS Stream was added to stream database.
@retval EFI_OUT_OF_RESOURCES Memory allocation failed.
**/
)
{
//
// Allocate a new stream
//
return EFI_OUT_OF_RESOURCES;
}
if (AllocateBuffer) {
//
// if we're here, we're double buffering, allocate the buffer and copy the
// data in
//
if (SectionStreamLength > 0) {
return EFI_OUT_OF_RESOURCES;
}
//
// Copy in stream data
//
} else {
//
// It's possible to have a zero length section stream.
//
}
} else {
//
// If were here, the caller has supplied the buffer (it's an internal call)
// so just assign the buffer. This happens when we open section streams
// as a result of expanding an encapsulating section.
//
}
//
// Initialize the rest of the section stream
//
//
// Add new stream to stream list
//
return EFI_SUCCESS;
}
/**
SEP member function. This function creates and returns a new section stream
handle to represent the new section stream.
@param This Indicates the calling context.
@param SectionStreamLength Size in bytes of the section stream.
@param SectionStream Buffer containing the new section stream.
@param SectionStreamHandle A pointer to a caller allocated UINTN that on output
contains the new section stream handle.
@retval EFI_SUCCESS Section wase opened successfully.
@retval EFI_OUT_OF_RESOURCES Memory allocation failed.
@retval EFI_INVALID_PARAMETER Section stream does not end concident with end of
last section.
**/
)
{
//
// Check to see section stream looks good...
//
return EFI_INVALID_PARAMETER;
}
return OpenSectionStreamEx (
TRUE,
0,
);
}
/**
Worker function. Determine if the input stream:child matches the input type.
@param Stream Indicates the section stream associated with the child
@param Child Indicates the child to check
@param SearchType Indicates the type of section to check against for
@param SectionDefinitionGuid Indicates the GUID to check against if the type is
EFI_SECTION_GUID_DEFINED
@retval TRUE The child matches
@retval FALSE The child doesn't match
**/
)
{
if (SearchType == EFI_SECTION_ALL) {
return TRUE;
}
return FALSE;
}
return TRUE;
}
if (IS_SECTION2 (GuidedSection)) {
return CompareGuid (&(((EFI_GUID_DEFINED_SECTION2 *) GuidedSection)->SectionDefinitionGuid), SectionDefinitionGuid);
} else {
}
}
/**
Create a protocol notification event and return it.
@param ProtocolGuid Protocol to register notification event on.
@param NotifyTpl Maximum TPL to signal the NotifyFunction.
@param NotifyFunction EFI notification routine.
@param NotifyContext Context passed into Event when it is created.
@param Registration Registration key returned from RegisterProtocolNotify().
@param SignalFlag Boolean value to decide whether kick the event after register or not.
@return The EFI_EVENT that has been registered to be signaled when a ProtocolGuid
is added to the system.
**/
)
{
//
// Create the event
//
);
//
// Register for protocol notifactions on this event
//
);
if (SignalFlag) {
//
// Kick the event so we will perform an initial pass of
// current installed drivers
//
}
return Event;
}
/**
RPN callback function.
1. Initialize the section stream when the GUIDED_SECTION_EXTRACTION_PROTOCOL is installed.
2. Removes a stale section stream and re-initializes it with an updated AuthenticationStatus.
@param Event The event that fired
@param RpnContext A pointer to the context that allows us to identify
the relevent encapsulation.
**/
)
{
}
//
// The stream is not initialized, open it.
// Or the stream closed successfully, so re-open the stream with correct AuthenticationStatus.
//
Status = gBS->LocateProtocol (Context->ChildNode->EncapsulationGuid, NULL, (VOID **)&GuidedExtraction);
);
//
// OR in the parent stream's aggregate status.
//
AuthenticationStatus |= Context->ParentStream->AuthenticationStatus & EFI_AGGREGATE_AUTH_STATUS_ALL;
);
}
//
// If above, the stream did not close successfully, it indicates it's
// alread been closed by someone, so just destroy the event and be done with
// it.
//
}
/**
Worker function. Constructor for RPN event if needed to keep AuthenticationStatus
cache correct when a missing GUIDED_SECTION_EXTRACTION_PROTOCOL appears...
@param ParentStream Indicates the parent of the ecnapsulation section (child)
@param ChildNode Indicates the child node that is the encapsulation section.
**/
)
{
//
// Allocate new event structure and context
//
);
}
/**
Worker function. Constructor for new child nodes.
@param Stream Indicates the section stream in which to add the child.
@param ChildOffset Indicates the offset in Stream that is the beginning
of the child section.
@param ChildNode Indicates the Callee allocated and initialized child.
@retval EFI_SUCCESS Child node was found and returned.
@retval EFI_OUT_OF_RESOURCES Memory allocation failed.
@retval EFI_PROTOCOL_ERROR Encapsulation sections produce new stream handles when
the child node is created. If the section type is GUID
defined, and the extraction GUID does not exist, and
producing the stream requires the GUID, then a protocol
error is generated and no child is produced.
Values returned by OpenSectionStreamEx.
**/
)
{
//
// Allocate a new node
//
return EFI_OUT_OF_RESOURCES;
}
//
// Now initialize it
//
if (IS_SECTION2 (SectionHeader)) {
} else {
}
//
// If it's an encapsulating section, then create the new section stream also
//
case EFI_SECTION_COMPRESSION:
//
// Get the CompressionSectionHeader
//
return EFI_NOT_FOUND;
}
if (IS_SECTION2 (CompressionHeader)) {
CompressionSourceSize = (UINT32) (SECTION2_SIZE (CompressionHeader) - sizeof (EFI_COMPRESSION_SECTION2));
} else {
CompressionSourceSize = (UINT32) (SECTION_SIZE (CompressionHeader) - sizeof (EFI_COMPRESSION_SECTION));
}
//
// Allocate space for the new stream
//
if (UncompressedLength > 0) {
if (NewStreamBuffer == NULL) {
return EFI_OUT_OF_RESOURCES;
}
if (CompressionType == EFI_NOT_COMPRESSED) {
//
// stream is not actually compressed, just encapsulated. So just copy it.
//
} else if (CompressionType == EFI_STANDARD_COMPRESSION) {
//
// Only support the EFI_SATNDARD_COMPRESSION algorithm.
//
//
// Decompress the stream
//
);
}
return Status;
}
if (ScratchBuffer == NULL) {
return EFI_OUT_OF_RESOURCES;
}
);
return Status;
}
}
} else {
NewStreamBufferSize = 0;
}
);
return Status;
}
break;
case EFI_SECTION_GUID_DEFINED:
if (IS_SECTION2 (GuidedHeader)) {
} else {
}
//
// NewStreamBuffer is always allocated by ExtractSection... No caller
// allocation here.
//
);
return EFI_PROTOCOL_ERROR;
}
//
// Make sure we initialize the new stream with the correct
// authentication status for both aggregate and local status fields.
//
if ((GuidedSectionAttributes & EFI_GUIDED_SECTION_AUTH_STATUS_VALID) == EFI_GUIDED_SECTION_AUTH_STATUS_VALID) {
//
// OR in the parent stream's aggregate status.
//
} else {
//
// since there's no authentication data contributed by the section,
// just inherit the full value from our immediate parent.
//
}
);
return Status;
}
} else {
//
// There's no GUIDed section extraction protocol available.
//
if ((GuidedSectionAttributes & EFI_GUIDED_SECTION_PROCESSING_REQUIRED) == EFI_GUIDED_SECTION_PROCESSING_REQUIRED) {
//
// If the section REQUIRES an extraction protocol, register for RPN
// when the required GUIDed extraction protocol becomes available.
//
AuthenticationStatus = 0;
} else {
//
// Figure out the proper authentication status
//
if ((GuidedSectionAttributes & EFI_GUIDED_SECTION_AUTH_STATUS_VALID) == EFI_GUIDED_SECTION_AUTH_STATUS_VALID) {
//
// The local status of the new stream is contained in
// AuthenticaionStatus. This value needs to be ORed into the
// Aggregate bits also...
//
//
// Clear out and initialize the local status
//
//
// OR local status into aggregate status
//
}
if (IS_SECTION2 (GuidedHeader)) {
TRUE,
);
} else {
TRUE,
);
}
return Status;
}
}
}
if ((AuthenticationStatus & EFI_LOCAL_AUTH_STATUS_ALL) ==
//
// Need to register for RPN for when the required GUIDed extraction
// protocol becomes available. This will enable us to refresh the
// AuthenticationStatus cached in the Stream if it's ever requested
// again.
//
}
break;
default:
//
// Nothing to do if it's a leaf
//
break;
}
//
// Last, add the new child node to the stream
//
return EFI_SUCCESS;
}
/**
Worker function Recursively searches / builds section stream database
looking for requested section.
@param SourceStream Indicates the section stream in which to do the search.
@param SearchType Indicates the type of section to search for.
@param SectionInstance Indicates which instance of section to find. This is
@param SectionDefinitionGuid Guid of section definition
@param FoundChild Output indicating the child node that is found.
@param FoundStream Output indicating which section stream the child was
found in. If this stream was generated as a result of
an encapsulation section, the streamhandle is visible
within the SEP driver only.
@param AuthenticationStatus Indicates the authentication status of the found section.
@retval EFI_SUCCESS Child node was found and returned.
@retval EFI_OUT_OF_RESOURCES Memory allocation failed.
@retval EFI_NOT_FOUND Requested child node does not exist.
@retval EFI_PROTOCOL_ERROR A required GUIDED section extraction protocol does not
exist
**/
)
{
if (SourceStream->StreamLength == 0) {
return EFI_NOT_FOUND;
}
//
// This occurs when a section stream exists, but no child sections
// have been parsed out yet. Therefore, extract the first child and add it
// to the list of children so we can get started.
// Section stream may contain an array of zero or more bytes.
// So, its size should be >= the size of commen section header.
//
return Status;
}
}
//
// At least one child has been parsed out of the section stream. So, walk
// through the sections that have already been parsed out looking for the
// requested section, if necessary, continue parsing section stream and
// adding children until either the requested section is found, or we run
// out of data
//
for (;;) {
//
// The type matches, so check the instance count to see if it's the one we want
//
(*SectionInstance)--;
if (*SectionInstance == 0) {
//
// Got it!
//
return EFI_SUCCESS;
}
}
//
// If the current node is an encapsulating node, recurse into it...
//
Status = FindChildNode (
);
//
// If the status is not EFI_SUCCESS, just save the error code and continue
// to find the request child node in the rest stream.
//
if (*SectionInstance == 0) {
return EFI_SUCCESS;
} else {
}
} else if ((CurrentChildNode->Type == EFI_SECTION_GUID_DEFINED) && (SearchType != EFI_SECTION_GUID_DEFINED)) {
//
// When Node Type is GUIDED section, but Node has no encapsulated data, Node data should not be parsed
// because a required GUIDED section extraction protocol does not exist.
// If SearchType is not GUIDED section, EFI_PROTOCOL_ERROR should return.
//
}
//
// We haven't found the child node we're interested in yet, but there's
// still more nodes that have already been parsed so get the next one
// and continue searching..
//
CurrentChildNode = CHILD_SECTION_NODE_FROM_LINK (GetNextNode (&SourceStream->Children, &CurrentChildNode->Link));
} else {
//
// We've exhausted children that have already been parsed, so see if
// there's any more data and continue parsing out more children if there
// is.
//
//
// Round up to 4 byte boundary
//
NextChildOffset += 3;
//
// There's an unparsed child remaining in the stream, so create a new child node
//
return Status;
}
} else {
return ErrorStatus;
}
}
}
}
/**
Worker function. Search stream database for requested stream handle.
@param SearchHandle Indicates which stream to look for.
@param FoundStream Output pointer to the found stream.
@retval EFI_SUCCESS StreamHandle was found and *FoundStream contains
the stream node.
@retval EFI_NOT_FOUND SearchHandle was not found in the stream database.
**/
)
{
if (!IsListEmpty (&mStreamRoot)) {
for (;;) {
return EFI_SUCCESS;
break;
} else {
}
}
}
return EFI_NOT_FOUND;
}
/**
SEP member function. Retrieves requested section from section stream.
@param This Pointer to SEP instance.
@param SectionStreamHandle The section stream from which to extract the requested
section.
@param SectionType A pointer to the type of section to search for.
@param SectionDefinitionGuid If the section type is EFI_SECTION_GUID_DEFINED, then
SectionDefinitionGuid indicates which of these types
of sections to search for.
@param SectionInstance Indicates which instance of the requested section to
return.
@param Buffer Double indirection to buffer. If *Buffer is non-null on
input, then the buffer is caller allocated. If
*Buffer is NULL, then the buffer is callee allocated.
In either case, the requried buffer size is returned
in *BufferSize.
@param BufferSize On input, indicates the size of *Buffer if *Buffer is
non-null on input. On output, indicates the required
size (allocated size if callee allocated) of *Buffer.
@param AuthenticationStatus Indicates the authentication status of the retrieved
section.
@retval EFI_SUCCESS Section was retrieved successfully
@retval EFI_PROTOCOL_ERROR A GUID defined section was encountered in the section
stream with its EFI_GUIDED_SECTION_PROCESSING_REQUIRED
bit set, but there was no corresponding GUIDed Section
Extraction Protocol in the handle database. *Buffer is
unmodified.
@retval EFI_NOT_FOUND An error was encountered when parsing the SectionStream.
This indicates the SectionStream is not correctly
formatted.
@retval EFI_NOT_FOUND The requested section does not exist.
@retval EFI_OUT_OF_RESOURCES The system has insufficient resources to process the
request.
@retval EFI_INVALID_PARAMETER The SectionStreamHandle does not exist.
@retval EFI_WARN_TOO_SMALL The size of the caller allocated input buffer is
insufficient to contain the requested section. The
input buffer is filled and contents are section contents
are truncated.
**/
)
{
//
// Locate target stream
//
goto GetSection_Done;
}
//
// Found the stream, now locate and return the appropriate section
//
if (SectionType == NULL) {
//
// SectionType == NULL means return the WHOLE section stream...
//
} else {
//
// There's a requested section type, so go find it and return it...
//
Status = FindChildNode (
&Instance,
);
goto GetSection_Done;
}
Section = (EFI_COMMON_SECTION_HEADER *) (ChildStreamNode->StreamBuffer + ChildNode->OffsetInStream);
if (IS_SECTION2 (Section)) {
} else {
}
}
//
// Caller allocated buffer. Fill to size and return required size...
//
if (*BufferSize < CopySize) {
CopySize = *BufferSize;
}
} else {
//
// Callee allocated buffer. Allocate buffer and return size.
//
goto GetSection_Done;
}
}
return Status;
}
/**
Worker function. Destructor for child nodes.
@param ChildNode Indicates the node to destroy
**/
)
{
//
// Remove the child from it's list
//
//
// If it's an encapsulating section, we close the resulting section stream.
// CloseSectionStream will free all memory associated with the stream.
//
}
//
// Last, free the child node itself
//
}
/**
SEP member function. Deletes an existing section stream
@param This Indicates the calling context.
@param StreamHandleToClose Indicates the stream to close
@retval EFI_SUCCESS Section stream was closed successfully.
@retval EFI_OUT_OF_RESOURCES Memory allocation failed.
@retval EFI_INVALID_PARAMETER Section stream does not end concident with end of
last section.
**/
)
{
//
// Locate target stream
//
//
// Found the stream, so close it
//
}
} else {
}
return Status;
}