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

2 files changed, 279 insertions, 0 deletions

diff --git a/MdeModulePkg/Library/BaseSortLib/BaseSortLib.c b/MdeModulePkg/Library/BaseSortLib/BaseSortLib.c
new file mode 100644
index 0000000000..ab8a60585e
--- /dev/null
+++ b/MdeModulePkg/Library/BaseSortLib/BaseSortLib.c
@@ -0,0 +1,238 @@
+/** @file

+  Library used for sorting 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.

+

+**/

+#include <Uefi.h>

+

+#include <Library/BaseLib.h>

+#include <Library/BaseMemoryLib.h>

+#include <Library/DebugLib.h>

+#include <Library/MemoryAllocationLib.h>

+#include <Library/SortLib.h>

+

+/**

+  Worker function for QuickSorting.  This function is identical to PerformQuickSort,

+  except that is uses the pre-allocated buffer so the in place sorting does not need to

+  allocate and free buffers constantly.

+

+  Each element must be equal sized.

+

+  if BufferToSort is NULL, then ASSERT.

+  if CompareFunction is NULL, then ASSERT.

+  if Buffer 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         Size of an element in bytes

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

+                                 of any 2 elements

+  @param[in] Buffer              Buffer of size ElementSize for use in swapping

+**/

+VOID

+EFIAPI

+QuickSortWorker (

+  IN OUT VOID                           *BufferToSort,

+  IN CONST UINTN                        Count,

+  IN CONST UINTN                        ElementSize,

+  IN       SORT_COMPARE                 CompareFunction,

+  IN VOID                               *Buffer

+  )

+{

+  VOID        *Pivot;

+  UINTN       LoopCount;

+  UINTN       NextSwapLocation;

+

+  ASSERT(BufferToSort     != NULL);

+  ASSERT(CompareFunction  != NULL);

+  ASSERT(Buffer  != NULL);

+

+  if ( Count < 2

+    || ElementSize  < 1

+   ){

+    return;

+  }

+

+  NextSwapLocation = 0;

+

+  //

+  // pick a pivot (we choose last element)

+  //

+  Pivot = ((UINT8*)BufferToSort+((Count-1)*ElementSize));

+

+  //

+  // Now get the pivot such that all on "left" are below it

+  // and everything "right" are above it

+  //

+  for ( LoopCount = 0

+      ; LoopCount < Count -1

+      ; LoopCount++

+     ){

+    //

+    // if the element is less than the pivot

+    //

+    if (CompareFunction((VOID*)((UINT8*)BufferToSort+((LoopCount)*ElementSize)),Pivot) <= 0){

+      //

+      // swap

+      //

+      CopyMem (Buffer, (UINT8*)BufferToSort+(NextSwapLocation*ElementSize), ElementSize);

+      CopyMem ((UINT8*)BufferToSort+(NextSwapLocation*ElementSize), (UINT8*)BufferToSort+((LoopCount)*ElementSize), ElementSize);

+      CopyMem ((UINT8*)BufferToSort+((LoopCount)*ElementSize), Buffer, ElementSize);

+

+      //

+      // increment NextSwapLocation

+      //

+      NextSwapLocation++;

+    }

+  }

+  //

+  // swap pivot to it's final position (NextSwapLocaiton)

+  //

+  CopyMem (Buffer, Pivot, ElementSize);

+  CopyMem (Pivot, (UINT8*)BufferToSort+(NextSwapLocation*ElementSize), ElementSize);

+  CopyMem ((UINT8*)BufferToSort+(NextSwapLocation*ElementSize), Buffer, ElementSize);

+

+  //

+  // Now recurse on 2 paritial lists.  neither of these will have the 'pivot' element

+  // IE list is sorted left half, pivot element, sorted right half...

+  //

+  if (NextSwapLocation >= 2) {

+    QuickSortWorker(

+      BufferToSort,

+      NextSwapLocation,

+      ElementSize,

+      CompareFunction,

+      Buffer);

+  }

+

+  if ((Count - NextSwapLocation - 1) >= 2) {

+    QuickSortWorker(

+      (UINT8 *)BufferToSort + (NextSwapLocation+1) * ElementSize,

+      Count - NextSwapLocation - 1,

+      ElementSize,

+      CompareFunction,

+      Buffer);

+  }

+  return;

+}

+/**

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

+

+  Each element must be equal 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         Size of an element in bytes

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

+                                 of any 2 elements

+**/

+VOID

+EFIAPI

+PerformQuickSort (

+  IN OUT VOID                           *BufferToSort,

+  IN CONST UINTN                        Count,

+  IN CONST UINTN                        ElementSize,

+  IN       SORT_COMPARE                 CompareFunction

+  )

+{

+  VOID  *Buffer;

+

+  ASSERT(BufferToSort     != NULL);

+  ASSERT(CompareFunction  != NULL);

+

+  Buffer = AllocateZeroPool(ElementSize);

+  ASSERT(Buffer != NULL);

+

+  QuickSortWorker(

+    BufferToSort,

+    Count,

+    ElementSize,

+    CompareFunction,

+    Buffer);

+

+  FreePool(Buffer);

+  return;

+}

+

+/**

+  Not supported in Base version.

+

+  @param[in] Buffer1  Ignored.

+  @param[in] Buffer2  Ignored.

+

+  ASSERT and return 0.

+**/

+INTN

+EFIAPI

+DevicePathCompare (

+  IN  CONST VOID             *Buffer1,

+  IN  CONST VOID             *Buffer2

+  )

+{

+  ASSERT(FALSE);

+  return 0;

+}

+

+/**

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

+

+  @param[in] Buffer1            Pointer to String to compare.

+  @param[in] Buffer2            Pointer to second String to compare.

+

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

+  )

+{

+  ASSERT(FALSE);

+  return 0;

+}

+

+

+/**

+  Function to compare 2 strings.

+

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

+  @param[in] Buffer2            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

+  )

+{

+  ASSERT(FALSE);

+  return 0;

+}

+

+

diff --git a/MdeModulePkg/Library/BaseSortLib/BaseSortLib.inf b/MdeModulePkg/Library/BaseSortLib/BaseSortLib.inf
new file mode 100644
index 0000000000..e372248fef
--- /dev/null
+++ b/MdeModulePkg/Library/BaseSortLib/BaseSortLib.inf
@@ -0,0 +1,41 @@
+##  @file

+#   Library used for sorting 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.

+#

+#

+##

+

+[Defines]

+  INF_VERSION                    = 0x00010006

+  BASE_NAME                      = BaseSortLib

+  FILE_GUID                      = 03F3331B-F12D-494f-BF37-E55A657F2497

+  MODULE_TYPE                    = UEFI_DRIVER

+  VERSION_STRING                 = 1.0

+  LIBRARY_CLASS                  = SortLib|UEFI_APPLICATION UEFI_DRIVER

+

+#

+#  VALID_ARCHITECTURES           = IA32 X64 IPF EBC

+#

+

+[Sources.common]

+  BaseSortLib.c

+

+[Packages]

+  MdePkg/MdePkg.dec

+  MdeModulePkg/MdeModulePkg.dec

+

+[LibraryClasses]

+  MemoryAllocationLib

+  BaseLib

+  BaseMemoryLib

+  DebugLib

+

+