Topics

[PATCH v2 07/10] ShellPkg/Ls: sort output by FileName in non-SFO mode


Laszlo Ersek
 

Sorting the LS output in non-SFO mode by FileName is best demonstrated
with two examples.

(1a) Before:

FS2:\> dir -r apps
Directory of: FS2:\apps\
01/01/1970 01:00 <DIR> r 0 .
12/22/2020 17:53 <DIR> 4,096 X64
12/22/2020 17:53 <DIR> 4,096 AARCH64
01/01/1970 01:00 <DIR> r 0 ..
12/22/2020 17:53 <DIR> 4,096 IA32
0 File(s) 0 bytes
5 Dir(s)
Directory of: FS2:\apps\X64\
12/22/2020 17:52 18,752 DumpDynPcd.efi
12/22/2020 17:52 34,240 SmiHandlerProfileInfo.efi
01/01/1970 01:00 <DIR> r 0 .
12/22/2020 17:52 11,456 VariableInfo.efi
12/22/2020 17:52 26,304 MemoryProfileInfo.efi
12/22/2020 17:53 126,656 AcpiViewApp.efi
12/22/2020 17:53 38,784 Cpuid.efi
01/01/1970 01:00 <DIR> r 0 ..
6 File(s) 256,192 bytes
2 Dir(s)
Directory of: FS2:\apps\AARCH64\
12/22/2020 17:52 32,768 DumpDynPcd.efi
01/01/1970 01:00 <DIR> r 0 .
12/22/2020 17:52 20,480 VariableInfo.efi
12/22/2020 17:52 40,960 MemoryProfileInfo.efi
12/22/2020 17:53 139,264 AcpiViewApp.efi
01/01/1970 01:00 <DIR> r 0 ..
4 File(s) 233,472 bytes
2 Dir(s)
Directory of: FS2:\apps\IA32\
12/22/2020 17:52 17,344 DumpDynPcd.efi
12/22/2020 17:52 30,720 SmiHandlerProfileInfo.efi
01/01/1970 01:00 <DIR> r 0 .
12/22/2020 17:52 10,880 VariableInfo.efi
12/22/2020 17:52 24,192 MemoryProfileInfo.efi
12/22/2020 17:53 105,536 AcpiViewApp.efi
12/22/2020 17:53 36,096 Cpuid.efi
01/01/1970 01:00 <DIR> r 0 ..
6 File(s) 224,768 bytes
2 Dir(s)
(1b) After:

FS2:\> dir -r apps
Directory of: FS2:\apps\
01/01/1970 01:00 <DIR> r 0 .
01/01/1970 01:00 <DIR> r 0 ..
12/22/2020 17:53 <DIR> 4,096 AARCH64
12/22/2020 17:53 <DIR> 4,096 IA32
12/22/2020 17:53 <DIR> 4,096 X64
0 File(s) 0 bytes
5 Dir(s)
Directory of: FS2:\apps\X64\
01/01/1970 01:00 <DIR> r 0 .
01/01/1970 01:00 <DIR> r 0 ..
12/22/2020 17:53 126,656 AcpiViewApp.efi
12/22/2020 17:53 38,784 Cpuid.efi
12/22/2020 17:52 18,752 DumpDynPcd.efi
12/22/2020 17:52 26,304 MemoryProfileInfo.efi
12/22/2020 17:52 34,240 SmiHandlerProfileInfo.efi
12/22/2020 17:52 11,456 VariableInfo.efi
6 File(s) 256,192 bytes
2 Dir(s)
Directory of: FS2:\apps\AARCH64\
01/01/1970 01:00 <DIR> r 0 .
01/01/1970 01:00 <DIR> r 0 ..
12/22/2020 17:53 139,264 AcpiViewApp.efi
12/22/2020 17:52 32,768 DumpDynPcd.efi
12/22/2020 17:52 40,960 MemoryProfileInfo.efi
12/22/2020 17:52 20,480 VariableInfo.efi
4 File(s) 233,472 bytes
2 Dir(s)
Directory of: FS2:\apps\IA32\
01/01/1970 01:00 <DIR> r 0 .
01/01/1970 01:00 <DIR> r 0 ..
12/22/2020 17:53 105,536 AcpiViewApp.efi
12/22/2020 17:53 36,096 Cpuid.efi
12/22/2020 17:52 17,344 DumpDynPcd.efi
12/22/2020 17:52 24,192 MemoryProfileInfo.efi
12/22/2020 17:52 30,720 SmiHandlerProfileInfo.efi
12/22/2020 17:52 10,880 VariableInfo.efi
6 File(s) 224,768 bytes
2 Dir(s)
(2a) Before:

FS2:\> dir apps\*\*.efi
Directory of: FS2:\apps\*\
12/22/2020 17:52 18,752 DumpDynPcd.efi
12/22/2020 17:52 34,240 SmiHandlerProfileInfo.efi
12/22/2020 17:52 11,456 VariableInfo.efi
12/22/2020 17:52 26,304 MemoryProfileInfo.efi
12/22/2020 17:53 126,656 AcpiViewApp.efi
12/22/2020 17:53 38,784 Cpuid.efi
12/22/2020 17:52 32,768 DumpDynPcd.efi
12/22/2020 17:52 20,480 VariableInfo.efi
12/22/2020 17:52 40,960 MemoryProfileInfo.efi
12/22/2020 17:53 139,264 AcpiViewApp.efi
12/22/2020 17:52 17,344 DumpDynPcd.efi
12/22/2020 17:52 30,720 SmiHandlerProfileInfo.efi
12/22/2020 17:52 10,880 VariableInfo.efi
12/22/2020 17:52 24,192 MemoryProfileInfo.efi
12/22/2020 17:53 105,536 AcpiViewApp.efi
12/22/2020 17:53 36,096 Cpuid.efi
16 File(s) 714,432 bytes
0 Dir(s)
(2b) After:

FS2:\> dir apps\*\*.efi
Directory of: FS2:\apps\*\
12/22/2020 17:53 126,656 AcpiViewApp.efi
12/22/2020 17:53 139,264 AcpiViewApp.efi
12/22/2020 17:53 105,536 AcpiViewApp.efi
12/22/2020 17:53 38,784 Cpuid.efi
12/22/2020 17:53 36,096 Cpuid.efi
12/22/2020 17:52 18,752 DumpDynPcd.efi
12/22/2020 17:52 32,768 DumpDynPcd.efi
12/22/2020 17:52 17,344 DumpDynPcd.efi
12/22/2020 17:52 26,304 MemoryProfileInfo.efi
12/22/2020 17:52 40,960 MemoryProfileInfo.efi
12/22/2020 17:52 24,192 MemoryProfileInfo.efi
12/22/2020 17:52 34,240 SmiHandlerProfileInfo.efi
12/22/2020 17:52 30,720 SmiHandlerProfileInfo.efi
12/22/2020 17:52 11,456 VariableInfo.efi
12/22/2020 17:52 20,480 VariableInfo.efi
12/22/2020 17:52 10,880 VariableInfo.efi
16 File(s) 714,432 bytes
0 Dir(s)
(In example (2), note that the sorting is stable; that is, whatever order
is established between identical FileNames by ShellOpenFileMetaArg(), it
is preserved by ShellSortFileList().)

Cc: Philippe Mathieu-Daudé <philmd@redhat.com>
Cc: Ray Ni <ray.ni@intel.com>
Cc: Zhichao Gao <zhichao.gao@intel.com>
Ref: https://bugzilla.tianocore.org/show_bug.cgi?id=3151
Signed-off-by: Laszlo Ersek <lersek@redhat.com>
Reviewed-by: Zhichao Gao <zhichao.gao@intel.com>
---

Notes:
v2:
- no changes
- pick up Zhichao's R-b

ShellPkg/Library/UefiShellLevel2CommandsLib/Ls.c | 14 ++++++++++++++
1 file changed, 14 insertions(+)

diff --git a/ShellPkg/Library/UefiShellLevel2CommandsLib/Ls.c b/ShellPkg/Library/UefiShellLevel2CommandsLib/Ls.c
index da2b1acab47c..8b97926d7f47 100644
--- a/ShellPkg/Library/UefiShellLevel2CommandsLib/Ls.c
+++ b/ShellPkg/Library/UefiShellLevel2CommandsLib/Ls.c
@@ -489,6 +489,20 @@ PrintLsOutput(
PrintSfoVolumeInfoTableEntry(ListHead);
}

+ if (!Sfo) {
+ //
+ // Sort the file list by FileName, stably.
+ //
+ // If the call below fails, then the EFI_SHELL_FILE_INFO list anchored to
+ // ListHead will not be changed in any way.
+ //
+ ShellSortFileList (
+ &ListHead,
+ NULL, // Duplicates
+ ShellSortFileListByFileName
+ );
+ }
+
for ( Node = (EFI_SHELL_FILE_INFO *)GetFirstNode(&ListHead->Link), LongestPath = 0
; !IsNull(&ListHead->Link, &Node->Link)
; Node = (EFI_SHELL_FILE_INFO *)GetNextNode(&ListHead->Link, &Node->Link)
--
2.19.1.3.g30247aa5d201


Philippe Mathieu-Daudé
 

On 1/13/21 9:54 AM, Laszlo Ersek wrote:
Sorting the LS output in non-SFO mode by FileName is best demonstrated
with two examples.

(1a) Before:

FS2:\> dir -r apps
Directory of: FS2:\apps\
01/01/1970 01:00 <DIR> r 0 .
12/22/2020 17:53 <DIR> 4,096 X64
12/22/2020 17:53 <DIR> 4,096 AARCH64
01/01/1970 01:00 <DIR> r 0 ..
12/22/2020 17:53 <DIR> 4,096 IA32
0 File(s) 0 bytes
5 Dir(s)
Directory of: FS2:\apps\X64\
12/22/2020 17:52 18,752 DumpDynPcd.efi
12/22/2020 17:52 34,240 SmiHandlerProfileInfo.efi
01/01/1970 01:00 <DIR> r 0 .
12/22/2020 17:52 11,456 VariableInfo.efi
12/22/2020 17:52 26,304 MemoryProfileInfo.efi
12/22/2020 17:53 126,656 AcpiViewApp.efi
12/22/2020 17:53 38,784 Cpuid.efi
01/01/1970 01:00 <DIR> r 0 ..
6 File(s) 256,192 bytes
2 Dir(s)
Directory of: FS2:\apps\AARCH64\
12/22/2020 17:52 32,768 DumpDynPcd.efi
01/01/1970 01:00 <DIR> r 0 .
12/22/2020 17:52 20,480 VariableInfo.efi
12/22/2020 17:52 40,960 MemoryProfileInfo.efi
12/22/2020 17:53 139,264 AcpiViewApp.efi
01/01/1970 01:00 <DIR> r 0 ..
4 File(s) 233,472 bytes
2 Dir(s)
Directory of: FS2:\apps\IA32\
12/22/2020 17:52 17,344 DumpDynPcd.efi
12/22/2020 17:52 30,720 SmiHandlerProfileInfo.efi
01/01/1970 01:00 <DIR> r 0 .
12/22/2020 17:52 10,880 VariableInfo.efi
12/22/2020 17:52 24,192 MemoryProfileInfo.efi
12/22/2020 17:53 105,536 AcpiViewApp.efi
12/22/2020 17:53 36,096 Cpuid.efi
01/01/1970 01:00 <DIR> r 0 ..
6 File(s) 224,768 bytes
2 Dir(s)
(1b) After:

FS2:\> dir -r apps
Directory of: FS2:\apps\
01/01/1970 01:00 <DIR> r 0 .
01/01/1970 01:00 <DIR> r 0 ..
12/22/2020 17:53 <DIR> 4,096 AARCH64
12/22/2020 17:53 <DIR> 4,096 IA32
12/22/2020 17:53 <DIR> 4,096 X64
0 File(s) 0 bytes
5 Dir(s)
Directory of: FS2:\apps\X64\
01/01/1970 01:00 <DIR> r 0 .
01/01/1970 01:00 <DIR> r 0 ..
12/22/2020 17:53 126,656 AcpiViewApp.efi
12/22/2020 17:53 38,784 Cpuid.efi
12/22/2020 17:52 18,752 DumpDynPcd.efi
12/22/2020 17:52 26,304 MemoryProfileInfo.efi
12/22/2020 17:52 34,240 SmiHandlerProfileInfo.efi
12/22/2020 17:52 11,456 VariableInfo.efi
6 File(s) 256,192 bytes
2 Dir(s)
Directory of: FS2:\apps\AARCH64\
01/01/1970 01:00 <DIR> r 0 .
01/01/1970 01:00 <DIR> r 0 ..
12/22/2020 17:53 139,264 AcpiViewApp.efi
12/22/2020 17:52 32,768 DumpDynPcd.efi
12/22/2020 17:52 40,960 MemoryProfileInfo.efi
12/22/2020 17:52 20,480 VariableInfo.efi
4 File(s) 233,472 bytes
2 Dir(s)
Directory of: FS2:\apps\IA32\
01/01/1970 01:00 <DIR> r 0 .
01/01/1970 01:00 <DIR> r 0 ..
12/22/2020 17:53 105,536 AcpiViewApp.efi
12/22/2020 17:53 36,096 Cpuid.efi
12/22/2020 17:52 17,344 DumpDynPcd.efi
12/22/2020 17:52 24,192 MemoryProfileInfo.efi
12/22/2020 17:52 30,720 SmiHandlerProfileInfo.efi
12/22/2020 17:52 10,880 VariableInfo.efi
6 File(s) 224,768 bytes
2 Dir(s)
(2a) Before:

FS2:\> dir apps\*\*.efi
Directory of: FS2:\apps\*\
12/22/2020 17:52 18,752 DumpDynPcd.efi
12/22/2020 17:52 34,240 SmiHandlerProfileInfo.efi
12/22/2020 17:52 11,456 VariableInfo.efi
12/22/2020 17:52 26,304 MemoryProfileInfo.efi
12/22/2020 17:53 126,656 AcpiViewApp.efi
12/22/2020 17:53 38,784 Cpuid.efi
12/22/2020 17:52 32,768 DumpDynPcd.efi
12/22/2020 17:52 20,480 VariableInfo.efi
12/22/2020 17:52 40,960 MemoryProfileInfo.efi
12/22/2020 17:53 139,264 AcpiViewApp.efi
12/22/2020 17:52 17,344 DumpDynPcd.efi
12/22/2020 17:52 30,720 SmiHandlerProfileInfo.efi
12/22/2020 17:52 10,880 VariableInfo.efi
12/22/2020 17:52 24,192 MemoryProfileInfo.efi
12/22/2020 17:53 105,536 AcpiViewApp.efi
12/22/2020 17:53 36,096 Cpuid.efi
16 File(s) 714,432 bytes
0 Dir(s)
(2b) After:

FS2:\> dir apps\*\*.efi
Directory of: FS2:\apps\*\
12/22/2020 17:53 126,656 AcpiViewApp.efi
12/22/2020 17:53 139,264 AcpiViewApp.efi
12/22/2020 17:53 105,536 AcpiViewApp.efi
12/22/2020 17:53 38,784 Cpuid.efi
12/22/2020 17:53 36,096 Cpuid.efi
12/22/2020 17:52 18,752 DumpDynPcd.efi
12/22/2020 17:52 32,768 DumpDynPcd.efi
12/22/2020 17:52 17,344 DumpDynPcd.efi
12/22/2020 17:52 26,304 MemoryProfileInfo.efi
12/22/2020 17:52 40,960 MemoryProfileInfo.efi
12/22/2020 17:52 24,192 MemoryProfileInfo.efi
12/22/2020 17:52 34,240 SmiHandlerProfileInfo.efi
12/22/2020 17:52 30,720 SmiHandlerProfileInfo.efi
12/22/2020 17:52 11,456 VariableInfo.efi
12/22/2020 17:52 20,480 VariableInfo.efi
12/22/2020 17:52 10,880 VariableInfo.efi
16 File(s) 714,432 bytes
0 Dir(s)
(In example (2), note that the sorting is stable; that is, whatever order
is established between identical FileNames by ShellOpenFileMetaArg(), it
is preserved by ShellSortFileList().)

Cc: Philippe Mathieu-Daudé <philmd@redhat.com>
Cc: Ray Ni <ray.ni@intel.com>
Cc: Zhichao Gao <zhichao.gao@intel.com>
Ref: https://bugzilla.tianocore.org/show_bug.cgi?id=3151
Signed-off-by: Laszlo Ersek <lersek@redhat.com>
Reviewed-by: Zhichao Gao <zhichao.gao@intel.com>
---

Notes:
v2:
- no changes
- pick up Zhichao's R-b

ShellPkg/Library/UefiShellLevel2CommandsLib/Ls.c | 14 ++++++++++++++
1 file changed, 14 insertions(+)
Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com>