MdePkg/Include/Library/OrderedCollectionLib.h File Reference


Typedefs

typedef struct ORDERED_COLLECTION ORDERED_COLLECTION
typedef struct
ORDERED_COLLECTION_ENTRY 
ORDERED_COLLECTION_ENTRY
typedef INTN(EFIAPIORDERED_COLLECTION_USER_COMPARE )(IN CONST VOID *UserStruct1, IN CONST VOID *UserStruct2)
typedef INTN(EFIAPIORDERED_COLLECTION_KEY_COMPARE )(IN CONST VOID *StandaloneKey, IN CONST VOID *UserStruct)

Functions

VOID *EFIAPI OrderedCollectionUserStruct (IN CONST ORDERED_COLLECTION_ENTRY *Entry)
ORDERED_COLLECTION *EFIAPI OrderedCollectionInit (IN ORDERED_COLLECTION_USER_COMPARE UserStructCompare, IN ORDERED_COLLECTION_KEY_COMPARE KeyCompare)
BOOLEAN EFIAPI OrderedCollectionIsEmpty (IN CONST ORDERED_COLLECTION *Collection)
VOID EFIAPI OrderedCollectionUninit (IN ORDERED_COLLECTION *Collection)
ORDERED_COLLECTION_ENTRY *EFIAPI OrderedCollectionFind (IN CONST ORDERED_COLLECTION *Collection, IN CONST VOID *StandaloneKey)
ORDERED_COLLECTION_ENTRY *EFIAPI OrderedCollectionMin (IN CONST ORDERED_COLLECTION *Collection)
ORDERED_COLLECTION_ENTRY *EFIAPI OrderedCollectionMax (IN CONST ORDERED_COLLECTION *Collection)
ORDERED_COLLECTION_ENTRY *EFIAPI OrderedCollectionNext (IN CONST ORDERED_COLLECTION_ENTRY *Entry)
ORDERED_COLLECTION_ENTRY *EFIAPI OrderedCollectionPrev (IN CONST ORDERED_COLLECTION_ENTRY *Entry)
RETURN_STATUS EFIAPI OrderedCollectionInsert (IN OUT ORDERED_COLLECTION *Collection, OUT ORDERED_COLLECTION_ENTRY **Entry, IN VOID *UserStruct)
VOID EFIAPI OrderedCollectionDelete (IN OUT ORDERED_COLLECTION *Collection, IN ORDERED_COLLECTION_ENTRY *Entry, OUT VOID **UserStruct)

Detailed Description

An ordered collection library interface.

The library class provides a set of APIs to manage an ordered collection of items.

Copyright (C) 2014, Red Hat, Inc.

This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License that 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.


Typedef Documentation

typedef INTN(EFIAPI * ORDERED_COLLECTION_KEY_COMPARE)(IN CONST VOID *StandaloneKey, IN CONST VOID *UserStruct)

Compare a standalone key against a user structure containing an embedded key.

Parameters:
[in] StandaloneKey Pointer to the bare key.
[in] UserStruct Pointer to the user structure with the embedded key.
Return values:
<0 If StandaloneKey compares less than UserStruct's key.
0 If StandaloneKey compares equal to UserStruct's key.
>0 If StandaloneKey compares greater than UserStruct's key.

typedef INTN(EFIAPI * ORDERED_COLLECTION_USER_COMPARE)(IN CONST VOID *UserStruct1, IN CONST VOID *UserStruct2)

Comparator function type for two user structures.

Parameters:
[in] UserStruct1 Pointer to the first user structure.
[in] UserStruct2 Pointer to the second user structure.
Return values:
<0 If UserStruct1 compares less than UserStruct2.
0 If UserStruct1 compares equal to UserStruct2.
>0 If UserStruct1 compares greater than UserStruct2.


Function Documentation

VOID EFIAPI OrderedCollectionDelete ( IN OUT RED_BLACK_TREE Tree,
IN RED_BLACK_TREE_NODE Node,
OUT VOID **  UserStruct 
)

Delete an entry from the collection, unlinking the associated user structure.

Read-write operation.

Parameters:
[in,out] Collection The collection to delete Entry from.
[in] Entry The collection entry to delete from Collection. The caller is responsible for ensuring that Entry belongs to Collection, and that Entry is non-NULL and valid. Entry is typically an earlier return value, or output parameter, of:

  • OrderedCollectionInsert() with return value RETURN_ALREADY_STARTED, for deleting an entry whose linked user structure caused collision during insertion.

Existing ORDERED_COLLECTION_ENTRY pointers (ie. iterators) *different* from Entry remain valid. For example:

  • On-going iterations in the caller that would have otherwise returned Entry at some point, as dictated by user structure order, will correctly reflect the absence of Entry after OrderedCollectionDelete() is called mid-iteration.

Parameters:
[out] UserStruct If the caller provides this optional output-only parameter, then on output it is set to the user structure originally linked by Entry (which is now freed).
This is a convenience that may save the caller a OrderedCollectionUserStruct() invocation before calling OrderedCollectionDelete(), in order to retrieve the user structure being unlinked.

Delete a node from the tree, unlinking the associated user structure.

Read-write operation.

Parameters:
[in,out] Tree The tree to delete Node from.
[in] Node The tree node to delete from Tree. The caller is responsible for ensuring that Node belongs to Tree, and that Node is non-NULL and valid. Node is typically an earlier return value, or output parameter, of:

  • OrderedCollectionInsert() with return value RETURN_ALREADY_STARTED, for deleting a node whose linked user structure caused collision during insertion.

Given a non-empty Tree, Tree->Root is also a valid Node argument (typically used for simplicity in loops that empty the tree completely).

Node is released with MemoryAllocationLib's FreePool() function.

Existing RED_BLACK_TREE_NODE pointers (ie. iterators) *different* from Node remain valid. For example:

  • On-going iterations in the caller that would have otherwise returned Node at some point, as dictated by user structure order, will correctly reflect the absence of Node after OrderedCollectionDelete() is called mid-iteration.

Parameters:
[out] UserStruct If the caller provides this optional output-only parameter, then on output it is set to the user structure originally linked by Node (which is now freed).
This is a convenience that may save the caller a OrderedCollectionUserStruct() invocation before calling OrderedCollectionDelete(), in order to retrieve the user structure being unlinked.

References ASSERT, FeaturePcdGet, FreePool(), NodeIsNullOrBlack(), NULL, RedBlackTreeBlack, RedBlackTreeRed, RedBlackTreeRotateLeft(), RedBlackTreeRotateRight(), and RedBlackTreeValidate().

ORDERED_COLLECTION_ENTRY* EFIAPI OrderedCollectionFind ( IN CONST RED_BLACK_TREE Tree,
IN CONST VOID *  StandaloneKey 
)

Look up the collection entry that links the user structure that matches the specified standalone key.

Read-only operation.

Parameters:
[in] Collection The collection to search for StandaloneKey.
[in] StandaloneKey The key to locate among the user structures linked into Collection. StandaloneKey will be passed to ORDERED_COLLECTION_KEY_COMPARE.
Return values:
NULL StandaloneKey could not be found.
Returns:
The collection entry that links to the user structure matching StandaloneKey, otherwise.
Look up the tree node that links the user structure that matches the specified standalone key.

Read-only operation.

Parameters:
[in] Tree The tree to search for StandaloneKey.
[in] StandaloneKey The key to locate among the user structures linked into Tree. StandaloneKey will be passed to Tree->KeyCompare().
Return values:
NULL StandaloneKey could not be found.
Returns:
The tree node that links to the user structure matching StandaloneKey, otherwise.

References NULL.

ORDERED_COLLECTION* EFIAPI OrderedCollectionInit ( IN ORDERED_COLLECTION_USER_COMPARE  UserStructCompare,
IN ORDERED_COLLECTION_KEY_COMPARE  KeyCompare 
)

Allocate and initialize the ORDERED_COLLECTION structure.

Parameters:
[in] UserStructCompare This caller-provided function will be used to order two user structures linked into the collection, during the insertion procedure.
[in] KeyCompare This caller-provided function will be used to order the standalone search key against user structures linked into the collection, during the lookup procedure.
Return values:
NULL If allocation failed.
Returns:
Pointer to the allocated, initialized ORDERED_COLLECTION structure, otherwise.

RETURN_STATUS EFIAPI OrderedCollectionInsert ( IN OUT RED_BLACK_TREE Tree,
OUT RED_BLACK_TREE_NODE **  Node,
IN VOID *  UserStruct 
)

Insert (link) a user structure into the collection, allocating a new collection entry.

Read-write operation.

Parameters:
[in,out] Collection The collection to insert UserStruct into.
[out] Entry The meaning of this optional, output-only parameter depends on the return value of the function.
When insertion is successful (RETURN_SUCCESS), Entry is set on output to the new collection entry that now links UserStruct.

When insertion fails due to lack of memory (RETURN_OUT_OF_RESOURCES), Entry is not changed.

When insertion fails due to key collision (ie. another user structure is already in the collection that compares equal to UserStruct), with return value RETURN_ALREADY_STARTED, then Entry is set on output to the entry that links the colliding user structure. This enables "find-or-insert" in one function call, or helps with later removal of the colliding element.

Parameters:
[in] UserStruct The user structure to link into the collection. UserStruct is ordered against in-collection user structures with the ORDERED_COLLECTION_USER_COMPARE function.
Return values:
RETURN_SUCCESS Insertion successful. A new collection entry has been allocated, linking UserStruct. The new collection entry is reported back in Entry (if the caller requested it).
Existing ORDERED_COLLECTION_ENTRY pointers into Collection remain valid. For example, on-going iterations in the caller can continue with OrderedCollectionNext() / OrderedCollectionPrev(), and they will return the new entry at some point if user structure order dictates it.

Return values:
RETURN_OUT_OF_RESOURCES The function failed to allocate memory for the new collection entry. The collection has not been changed. Existing ORDERED_COLLECTION_ENTRY pointers into Collection remain valid.
RETURN_ALREADY_STARTED A user structure has been found in the collection that compares equal to UserStruct. The entry linking the colliding user structure is reported back in Entry (if the caller requested it). The collection has not been changed. Existing ORDERED_COLLECTION_ENTRY pointers into Collection remain valid.
Insert (link) a user structure into the tree.

Read-write operation.

This function allocates the new tree node with MemoryAllocationLib's AllocatePool() function.

Parameters:
[in,out] Tree The tree to insert UserStruct into.
[out] Node The meaning of this optional, output-only parameter depends on the return value of the function.
When insertion is successful (RETURN_SUCCESS), Node is set on output to the new tree node that now links UserStruct.

When insertion fails due to lack of memory (RETURN_OUT_OF_RESOURCES), Node is not changed.

When insertion fails due to key collision (ie. another user structure is already in the tree that compares equal to UserStruct), with return value RETURN_ALREADY_STARTED, then Node is set on output to the node that links the colliding user structure. This enables "find-or-insert" in one function call, or helps with later removal of the colliding element.

Parameters:
[in] UserStruct The user structure to link into the tree. UserStruct is ordered against in-tree user structures with the Tree->UserStructCompare() function.
Return values:
RETURN_SUCCESS Insertion successful. A new tree node has been allocated, linking UserStruct. The new tree node is reported back in Node (if the caller requested it).
Existing RED_BLACK_TREE_NODE pointers into Tree remain valid. For example, on-going iterations in the caller can continue with OrderedCollectionNext() / OrderedCollectionPrev(), and they will return the new node at some point if user structure order dictates it.

Return values:
RETURN_OUT_OF_RESOURCES AllocatePool() failed to allocate memory for the new tree node. The tree has not been changed. Existing RED_BLACK_TREE_NODE pointers into Tree remain valid.
RETURN_ALREADY_STARTED A user structure has been found in the tree that compares equal to UserStruct. The node linking the colliding user structure is reported back in Node (if the caller requested it). The tree has not been changed. Existing RED_BLACK_TREE_NODE pointers into Tree remain valid.

References AllocatePool(), ASSERT, FeaturePcdGet, NULL, RedBlackTreeBlack, RedBlackTreeRed, RedBlackTreeRotateLeft(), RedBlackTreeRotateRight(), RedBlackTreeValidate(), RETURN_ALREADY_STARTED, RETURN_OUT_OF_RESOURCES, and RETURN_SUCCESS.

BOOLEAN EFIAPI OrderedCollectionIsEmpty ( IN CONST RED_BLACK_TREE Tree  ) 

Check whether the collection is empty (has no entries).

Read-only operation.

Parameters:
[in] Collection The collection to check for emptiness.
Return values:
TRUE The collection is empty.
FALSE The collection is not empty.
Check whether the tree is empty (has no nodes).

Read-only operation.

Parameters:
[in] Tree The tree to check for emptiness.
Return values:
TRUE The tree is empty.
FALSE The tree is not empty.

References NULL.

Referenced by OrderedCollectionUninit().

ORDERED_COLLECTION_ENTRY* EFIAPI OrderedCollectionMax ( IN CONST RED_BLACK_TREE Tree  ) 

Find the collection entry of the maximum user structure stored in the collection.

Read-only operation.

Parameters:
[in] Collection The collection to return the maximum entry of. The user structure linked by the maximum entry compares greater than all other user structures in the collection.
Return values:
NULL If Collection is empty.
Returns:
The collection entry that links the maximum user structure, otherwise.
Find the tree node of the maximum user structure stored in the tree.

Read-only operation.

Parameters:
[in] Tree The tree to return the maximum node of. The user structure linked by the maximum node compares greater than all other user structures in the tree.
Return values:
NULL If Tree is empty.
Returns:
The tree node that links the maximum user structure, otherwise.

References NULL.

Referenced by RedBlackTreeValidate().

ORDERED_COLLECTION_ENTRY* EFIAPI OrderedCollectionMin ( IN CONST RED_BLACK_TREE Tree  ) 

Find the collection entry of the minimum user structure stored in the collection.

Read-only operation.

Parameters:
[in] Collection The collection to return the minimum entry of. The user structure linked by the minimum entry compares less than all other user structures in the collection.
Return values:
NULL If Collection is empty.
Returns:
The collection entry that links the minimum user structure, otherwise.
Find the tree node of the minimum user structure stored in the tree.

Read-only operation.

Parameters:
[in] Tree The tree to return the minimum node of. The user structure linked by the minimum node compares less than all other user structures in the tree.
Return values:
NULL If Tree is empty.
Returns:
The tree node that links the minimum user structure, otherwise.

References NULL.

Referenced by RedBlackTreeValidate().

ORDERED_COLLECTION_ENTRY* EFIAPI OrderedCollectionNext ( IN CONST RED_BLACK_TREE_NODE Node  ) 

Get the collection entry of the least user structure that is greater than the one linked by Entry.

Read-only operation.

Parameters:
[in] Entry The entry to get the successor entry of.
Return values:
NULL If Entry is NULL, or Entry is the maximum entry of its containing collection (ie. Entry has no successor entry).
Returns:
The collection entry linking the least user structure that is greater than the one linked by Entry, otherwise.
Get the tree node of the least user structure that is greater than the one linked by Node.

Read-only operation.

Parameters:
[in] Node The node to get the successor node of.
Return values:
NULL If Node is NULL, or Node is the maximum node of its containing tree (ie. Node has no successor node).
Returns:
The tree node linking the least user structure that is greater than the one linked by Node, otherwise.

References CONST, and NULL.

Referenced by RedBlackTreeValidate().

ORDERED_COLLECTION_ENTRY* EFIAPI OrderedCollectionPrev ( IN CONST RED_BLACK_TREE_NODE Node  ) 

Get the collection entry of the greatest user structure that is less than the one linked by Entry.

Read-only operation.

Parameters:
[in] Entry The entry to get the predecessor entry of.
Return values:
NULL If Entry is NULL, or Entry is the minimum entry of its containing collection (ie. Entry has no predecessor entry).
Returns:
The collection entry linking the greatest user structure that is less than the one linked by Entry, otherwise.
Get the tree node of the greatest user structure that is less than the one linked by Node.

Read-only operation.

Parameters:
[in] Node The node to get the predecessor node of.
Return values:
NULL If Node is NULL, or Node is the minimum node of its containing tree (ie. Node has no predecessor node).
Returns:
The tree node linking the greatest user structure that is less than the one linked by Node, otherwise.

References CONST, and NULL.

Referenced by RedBlackTreeValidate().

VOID EFIAPI OrderedCollectionUninit ( IN RED_BLACK_TREE Tree  ) 

Uninitialize and release an empty ORDERED_COLLECTION structure.

Read-write operation.

It is the caller's responsibility to delete all entries from the collection before calling this function.

Parameters:
[in] Collection The empty collection to uninitialize and release.
Uninitialize and release an empty RED_BLACK_TREE structure.

Read-write operation.

Release occurs via MemoryAllocationLib's FreePool() function.

It is the caller's responsibility to delete all nodes from the tree before calling this function.

Parameters:
[in] Tree The empty tree to uninitialize and release.

References ASSERT, FreePool(), and OrderedCollectionIsEmpty().

VOID* EFIAPI OrderedCollectionUserStruct ( IN CONST RED_BLACK_TREE_NODE Node  ) 

Retrieve the user structure linked by the specified collection entry.

Read-only operation.

Parameters:
[in] Entry Pointer to the collection entry whose associated user structure we want to retrieve. The caller is responsible for passing a non-NULL argument.
Returns:
Pointer to user structure linked by Entry.
Retrieve the user structure linked by the specified tree node.

Read-only operation.

Parameters:
[in] Node Pointer to the tree node whose associated user structure we want to retrieve. The caller is responsible for passing a non-NULL argument.
Returns:
Pointer to user structure linked by Node.


Generated on Thu Sep 24 23:14:17 2015 for MdePkg[ALL] by  doxygen 1.5.7.1