MdeModulePkg, MdePkg, NetworkPkg, OvmfPkg, PerformancePkg, ShellPkg: Library Migration.

Move libraries from ShellPkg into MdeModulePkg and MdePkg.

The following libraries are being migrated out of ShellPkg in order to make
their functionality more widely available.
  • PathLib:        Incorporate into MdePkg/Library/BaseLib
  • FileHandleLib:  MdePkg/Library/UefiFileHandleLib
  • BaseSortLib:    MdeModulePkg/Library/BaseSortLib
  • UefiSortLib:    MdeModulePkg/Library/UefiSortLib

Diffs showing file changes are in the attached file, LibMigration.patch.
A description of the changes follows:

  • Move ShellPkg/Include/Library/FileHandleLib.h to MdePkg/Include/Library/FileHandleLib.h
  • Move ShellPkg/Include/Library/SortLib.h to MdeModulePkg/Include/Library/SortLib.h
  • Move ShellPkg/Library/BaseSortLib to MdeModulePkg/Library/BaseSortLib
  • Move ShellPkg/Library/UefiSortLib to MdeModulePkg/Library/UefiSortLib
  • Move ShellPkg/Library/BasePathLib/BasePathLib.c to MdePkg/Library/BaseLib/FilePaths.c
  • Merge ShellPkg/Include/Library/PathLib.h into MdePkg/Include/Library/BaseLib.h
  • Delete  ShellPkg/Library/BasePathLib; Includes BasePathLib.c and BasePathLib.inf

  • NetworkPkg/NetworkPkg.dsc
  • PerformancePkg.dsc
  • OvmfPkg/OvmfPkgX64.dsc
  • OvmfPkg/OvmfPkgIa32X64.dsc
  • OvmfPkg/OvmfPkgIa32.dsc
    o Update SortLib and FileHandleLib library classes to point to the new library locations.
    o Remove PathLib library class and make sure that BaseLib is described.

  • MdeModulePkg/MdeModulePkg.dec
    o Add SortLib library class

  • MdePkg/MdePkg.dec
    o Add FileHandleLib library class
    o Add PcdUefiFileHandleLibPrintBufferSize PCD

  • MdePkg/Library/BaseLib/BaseLib.inf
    o Add FilePaths.c to [Sources]

  • MdePkg/Include/Library/BaseLib.h
    o Update file description to include "file path functions"

  • ShellPkg/ShellPkg.dsc
    o Change PACKAGE_GUID to { C1014BB7-4092-43D4-984F-0738EB424DBF }
    o Update PACKAGE_VERSION to 1.0
    o Update SortLib and FileHandleLib library classes to point to the new library locations.
    o Remove PathLib library class and make sure that BaseLib is described.
    o Remove ShellPkg/Library/UefiFileHandleLib/UefiFileHandleLib.inf from [Components]

  • ShellPkg/ShellPkg.dec
    o Update PLATFORM_VERSION to 1.0
    o Remove declarations of the FileHandleLib, SortLib, and PathLib Library Classes
    o Update comment for the PcdShellPrintBufferSize PCD.

  • ShellPkg/Library/UefiShellLevel2CommandsLib/UefiShellLevel2CommandsLib.inf
  • ShellPkg/Application/Shell/Shell.inf
    o Remove PathLib from [LibraryClasses]

  • ShellPkg/Library/UefiShellLevel2CommandsLib/UefiShellLevel2CommandsLib.h
  • ShellPkg/Application/Shell/Shell.h
    o Remove #include <Library/PathLib.h>

  • ShellPkg/Library/UefiShellLevel1CommandsLib/UefiShellLevel1CommandsLib.inf
    o Add PathLib to [LibraryClasses]

  • ShellPkg/Library/UefiShellLevel1CommandsLib/If.c
    o Remove #include <Library/PathLib.h>

  • ShellPkg/Application/ShellSortTestApp/ShellSortTestApp.inf
    o Add MdeModulePkg/MdeModulePkg.dec to [Packages]

  • MdeModulePkg/Library/BaseSortLib/BaseSortLib.inf
  • MdeModulePkg/Library/UefiSortLib/UefiSortLib.inf
    o Replace ShellPkg.dec with MdeModulePkg.dec in [Packages]

  • MdeModulePkg/Library/UefiSortLib/UefiSortLib.c
    o Remove #include <ShellBase.h>
    o Define USL_FREE_NON_NULL() to replace SHELL_FREE_NON_NULL()

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Daryl McDaniel <daryl.mcdaniel@intel.com>
Reviewed-by: Jaben Carsey <jaben.carsey@intel.com>
Reviewed-by: Erik Bjorge <erik.c.bjorge@intel.com>


git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@16601 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 113 insertions, 0 deletions

diff --git a/MdeModulePkg/Include/Library/SortLib.h b/MdeModulePkg/Include/Library/SortLib.h
new file mode 100644
index 0000000..a891cab
--- /dev/null
+++ b/MdeModulePkg/Include/Library/SortLib.h
@@ -0,0 +1,113 @@
+/** @file

+  Library used for sorting and comparison routines.

+

+  Copyright (c) 2009 - 2014, 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

+  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.

+

+**/

+#ifndef __SORT_LIB_H__

+#define __SORT_LIB_H__

+

+/**

+  Prototype for comparison function for any two element types.

+

+  @param[in] Buffer1                  The pointer to first buffer.

+  @param[in] Buffer2                  The pointer to second buffer.

+

+  @retval 0                           Buffer1 equal to Buffer2.

+  @return <0                          Buffer1 is less than Buffer2.

+  @return >0                          Buffer1 is greater than Buffer2.

+**/

+typedef

+INTN

+(EFIAPI *SORT_COMPARE)(

+  IN CONST VOID                 *Buffer1,

+  IN CONST VOID                 *Buffer2

+  );

+

+/**

+  Function to perform a Quick Sort on a buffer of comparable elements.

+

+  Each element must be equally sized.

+

+  If BufferToSort is NULL, then ASSERT.

+  If CompareFunction is NULL, then ASSERT.

+

+  If Count is < 2 , then perform no action.

+  If Size is < 1 , then perform no action.

+

+  @param[in, out] BufferToSort   On call, a Buffer of (possibly sorted) elements;

+                                 on return, a buffer of sorted elements.

+  @param[in]  Count              The number of elements in the buffer to sort.

+  @param[in]  ElementSize        The size of an element in bytes.

+  @param[in]  CompareFunction    The function to call to perform the comparison

+                                 of any two elements.

+**/

+VOID

+EFIAPI

+PerformQuickSort (

+  IN OUT VOID                   *BufferToSort,

+  IN CONST UINTN                Count,

+  IN CONST UINTN                ElementSize,

+  IN       SORT_COMPARE         CompareFunction

+  );

+

+

+/**

+  Function to compare 2 device paths for use as CompareFunction.

+

+  @param[in] Buffer1            The pointer to Device Path to compare.

+  @param[in] Buffer2            The pointer to second DevicePath to compare.

+

+  @retval 0                     Buffer1 equal to Buffer2.

+  @return < 0                   Buffer1 is less than Buffer2.

+  @return > 0                   Buffer1 is greater than Buffer2.

+**/

+INTN

+EFIAPI

+DevicePathCompare (

+  IN  CONST VOID                *Buffer1,

+  IN  CONST VOID                *Buffer2

+  );

+

+/**

+  Function to compare 2 strings without regard to case of the characters.

+

+  @param[in] Buffer1            The pointer to String to compare (CHAR16**).

+  @param[in] Buffer2            The pointer to second String to compare (CHAR16**).

+

+  @retval 0                     Buffer1 equal to Buffer2.

+  @return < 0                   Buffer1 is less than Buffer2.

+  @return > 0                   Buffer1 is greater than Buffer2.

+**/

+INTN

+EFIAPI

+StringNoCaseCompare (

+  IN  CONST VOID                *Buffer1,

+  IN  CONST VOID                *Buffer2

+  );

+

+/**

+  Function to compare 2 strings.

+

+  @param[in] Buffer1            The pointer to String to compare (CHAR16**).

+  @param[in] Buffer2            The pointer to second String to compare (CHAR16**).

+

+  @retval 0                     Buffer1 equal to Buffer2.

+  @return < 0                   Buffer1 is less than Buffer2.

+  @return > 0                   Buffer1 is greater than Buffer2.

+**/

+INTN

+EFIAPI

+StringCompare (

+  IN  CONST VOID                *Buffer1,

+  IN  CONST VOID                *Buffer2

+  );

+

+#endif //__SORT_LIB_H__