2 Library used for sorting routines.
4 Copyright (c) 2009-2010, Intel Corporation. All rights reserved. <BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 #include <Protocol/UnicodeCollation.h>
18 #include <Protocol/DevicePath.h>
19 #include <Protocol/DevicePathToText.h>
21 #include <Library/UefiBootServicesTableLib.h>
22 #include <Library/BaseLib.h>
23 #include <Library/BaseMemoryLib.h>
24 #include <Library/DebugLib.h>
25 #include <Library/MemoryAllocationLib.h>
26 #include <Library/SortLib.h>
28 STATIC EFI_DEVICE_PATH_TO_TEXT_PROTOCOL
*mDevicePathToText
= NULL
;
29 STATIC EFI_UNICODE_COLLATION_PROTOCOL
*mUnicodeCollation
= NULL
;
33 Worker function for QuickSorting. This function is identical to PerformQuickSort,
34 except that is uses the pre-allocated buffer so the in place sorting does not need to
35 allocate and free buffers constantly.
37 Each element must be equal sized.
39 if BufferToSort is NULL, then ASSERT.
40 if CompareFunction is NULL, then ASSERT.
41 if Buffer is NULL, then ASSERT.
43 if Count is < 2 then perform no action.
44 if Size is < 1 then perform no action.
46 @param[in,out] BufferToSort on call a Buffer of (possibly sorted) elements
47 on return a buffer of sorted elements
48 @param[in] Count the number of elements in the buffer to sort
49 @param[in] ElementSize Size of an element in bytes
50 @param[in] CompareFunction The function to call to perform the comparison
52 @param[in] Buffer Buffer of size ElementSize for use in swapping
57 IN OUT VOID
*BufferToSort
,
59 IN CONST UINTN ElementSize
,
60 IN SORT_COMPARE CompareFunction
,
66 UINTN NextSwapLocation
;
68 ASSERT(BufferToSort
!= NULL
);
69 ASSERT(CompareFunction
!= NULL
);
70 ASSERT(Buffer
!= NULL
);
81 // pick a pivot (we choose last element)
83 Pivot
= ((UINT8
*)BufferToSort
+((Count
-1)*ElementSize
));
86 // Now get the pivot such that all on "left" are below it
87 // and everything "right" are above it
90 ; LoopCount
< Count
-1
94 // if the element is less than the pivot
96 if (CompareFunction((VOID
*)((UINT8
*)BufferToSort
+((LoopCount
)*ElementSize
)),Pivot
) <= 0){
100 CopyMem (Buffer
, (UINT8
*)BufferToSort
+(NextSwapLocation
*ElementSize
), ElementSize
);
101 CopyMem ((UINT8
*)BufferToSort
+(NextSwapLocation
*ElementSize
), (UINT8
*)BufferToSort
+((LoopCount
)*ElementSize
), ElementSize
);
102 CopyMem ((UINT8
*)BufferToSort
+((LoopCount
)*ElementSize
), Buffer
, ElementSize
);
105 // increment NextSwapLocation
111 // swap pivot to it's final position (NextSwapLocaiton)
113 CopyMem (Buffer
, Pivot
, ElementSize
);
114 CopyMem (Pivot
, (UINT8
*)BufferToSort
+(NextSwapLocation
*ElementSize
), ElementSize
);
115 CopyMem ((UINT8
*)BufferToSort
+(NextSwapLocation
*ElementSize
), Buffer
, ElementSize
);
118 // Now recurse on 2 paritial lists. neither of these will have the 'pivot' element
119 // IE list is sorted left half, pivot element, sorted right half...
129 (UINT8
*)BufferToSort
+ (NextSwapLocation
+1) * ElementSize
,
130 Count
- NextSwapLocation
- 1,
138 Function to perform a Quick Sort alogrithm on a buffer of comparable elements.
140 Each element must be equal sized.
142 if BufferToSort is NULL, then ASSERT.
143 if CompareFunction is NULL, then ASSERT.
145 if Count is < 2 then perform no action.
146 if Size is < 1 then perform no action.
148 @param[in,out] BufferToSort on call a Buffer of (possibly sorted) elements
149 on return a buffer of sorted elements
150 @param[in] Count the number of elements in the buffer to sort
151 @param[in] ElementSize Size of an element in bytes
152 @param[in] CompareFunction The function to call to perform the comparison
158 IN OUT VOID
*BufferToSort
,
159 IN CONST UINTN Count
,
160 IN CONST UINTN ElementSize
,
161 IN SORT_COMPARE CompareFunction
166 ASSERT(BufferToSort
!= NULL
);
167 ASSERT(CompareFunction
!= NULL
);
169 Buffer
= AllocatePool(ElementSize
);
170 ASSERT(Buffer
!= NULL
);
184 function to compare 2 device paths for use in QuickSort
186 @param[in] Buffer1 pointer to Device Path poiner to compare
187 @param[in] Buffer2 pointer to second DevicePath pointer to compare
189 @retval 0 Buffer1 equal to Buffer2
190 @return < 0 Buffer1 is less than Buffer2
191 @return > 0 Buffer1 is greater than Buffer2
195 IN CONST VOID
*Buffer1
,
196 IN CONST VOID
*Buffer2
199 EFI_DEVICE_PATH_PROTOCOL
*DevicePath1
;
200 EFI_DEVICE_PATH_PROTOCOL
*DevicePath2
;
206 DevicePath1
= *(EFI_DEVICE_PATH_PROTOCOL
**)Buffer1
;
207 DevicePath2
= *(EFI_DEVICE_PATH_PROTOCOL
**)Buffer2
;
209 if (DevicePath1
== NULL
) {
210 if (DevicePath2
== NULL
) {
217 if (DevicePath2
== NULL
) {
221 if (mDevicePathToText
== NULL
) {
222 Status
= gBS
->LocateProtocol(
223 &gEfiDevicePathToTextProtocolGuid
,
225 (VOID
**)&mDevicePathToText
);
227 ASSERT_EFI_ERROR(Status
);
230 if (mUnicodeCollation
== NULL
) {
231 Status
= gBS
->LocateProtocol(
232 &gEfiUnicodeCollation2ProtocolGuid
,
234 (VOID
**)&mUnicodeCollation
);
236 ASSERT_EFI_ERROR(Status
);
239 TextPath1
= mDevicePathToText
->ConvertDevicePathToText(
244 TextPath2
= mDevicePathToText
->ConvertDevicePathToText(
249 RetVal
= mUnicodeCollation
->StriColl(
261 Function to compare 2 strings without regard to case of the characters.
263 @param[in] Buffer1 Pointer to String to compare.
264 @param[in] Buffer2 Pointer to second String to compare.
266 @retval 0 Buffer1 equal to Buffer2.
267 @return < 0 Buffer1 is less than Buffer2.
268 @return > 0 Buffer1 is greater than Buffer2.
272 StringNoCaseCompare (
273 IN CONST VOID
*Buffer1
,
274 IN CONST VOID
*Buffer2
278 if (mUnicodeCollation
== NULL
) {
279 Status
= gBS
->LocateProtocol(
280 &gEfiUnicodeCollation2ProtocolGuid
,
282 (VOID
**)&mUnicodeCollation
);
284 ASSERT_EFI_ERROR(Status
);
287 return (mUnicodeCollation
->StriColl(
290 *(CHAR16
**)Buffer2
));