2 Provides interface to shell functionality for shell commands and applications.
4 Copyright 2016 Dell Inc.
5 Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #include "UefiShellLib.h"
17 #include <ShellBase.h>
18 #include <Library/SortLib.h>
19 #include <Library/BaseLib.h>
21 #define FIND_XXXXX_FILE_BUFFER_SIZE (SIZE_OF_EFI_FILE_INFO + MAX_FILE_NAME_LEN)
26 SHELL_PARAM_ITEM EmptyParamList
[] = {
29 SHELL_PARAM_ITEM SfoParamList
[] = {
33 EFI_SHELL_ENVIRONMENT2
*mEfiShellEnvironment2
;
34 EFI_SHELL_INTERFACE
*mEfiShellInterface
;
35 EFI_SHELL_PROTOCOL
*gEfiShellProtocol
;
36 EFI_SHELL_PARAMETERS_PROTOCOL
*gEfiShellParametersProtocol
;
37 EFI_HANDLE mEfiShellEnvironment2Handle
;
38 FILE_HANDLE_FUNCTION_MAP FileFunctionMap
;
41 Check if a Unicode character is a hexadecimal character.
43 This internal function checks if a Unicode character is a
44 numeric character. The valid hexadecimal characters are
45 L'0' to L'9', L'a' to L'f', or L'A' to L'F'.
47 @param Char The character to check against.
49 @retval TRUE If the Char is a hexadecmial character.
50 @retval FALSE If the Char is not a hexadecmial character.
55 ShellIsHexaDecimalDigitCharacter (
59 return (BOOLEAN
) ((Char
>= L
'0' && Char
<= L
'9') || (Char
>= L
'A' && Char
<= L
'F') || (Char
>= L
'a' && Char
<= L
'f'));
63 Check if a Unicode character is a decimal character.
65 This internal function checks if a Unicode character is a
66 decimal character. The valid characters are
70 @param Char The character to check against.
72 @retval TRUE If the Char is a hexadecmial character.
73 @retval FALSE If the Char is not a hexadecmial character.
78 ShellIsDecimalDigitCharacter (
82 return (BOOLEAN
) (Char
>= L
'0' && Char
<= L
'9');
86 Helper function to find ShellEnvironment2 for constructor.
88 @param[in] ImageHandle A copy of the calling image's handle.
90 @retval EFI_OUT_OF_RESOURCES Memory allocation failed.
95 IN EFI_HANDLE ImageHandle
105 Status
= gBS
->OpenProtocol(ImageHandle
,
106 &gEfiShellEnvironment2Guid
,
107 (VOID
**)&mEfiShellEnvironment2
,
110 EFI_OPEN_PROTOCOL_GET_PROTOCOL
113 // look for the mEfiShellEnvironment2 protocol at a higher level
115 if (EFI_ERROR (Status
) || !(CompareGuid (&mEfiShellEnvironment2
->SESGuid
, &gEfiShellEnvironment2ExtGuid
))){
117 // figure out how big of a buffer we need.
119 Status
= gBS
->LocateHandle (ByProtocol
,
120 &gEfiShellEnvironment2Guid
,
121 NULL
, // ignored for ByProtocol
126 // maybe it's not there???
128 if (Status
== EFI_BUFFER_TOO_SMALL
) {
129 Buffer
= (EFI_HANDLE
*)AllocateZeroPool(BufferSize
);
130 if (Buffer
== NULL
) {
131 return (EFI_OUT_OF_RESOURCES
);
133 Status
= gBS
->LocateHandle (ByProtocol
,
134 &gEfiShellEnvironment2Guid
,
135 NULL
, // ignored for ByProtocol
140 if (!EFI_ERROR (Status
) && Buffer
!= NULL
) {
142 // now parse the list of returned handles
144 Status
= EFI_NOT_FOUND
;
145 for (HandleIndex
= 0; HandleIndex
< (BufferSize
/sizeof(Buffer
[0])); HandleIndex
++) {
146 Status
= gBS
->OpenProtocol(Buffer
[HandleIndex
],
147 &gEfiShellEnvironment2Guid
,
148 (VOID
**)&mEfiShellEnvironment2
,
151 EFI_OPEN_PROTOCOL_GET_PROTOCOL
153 if (CompareGuid (&mEfiShellEnvironment2
->SESGuid
, &gEfiShellEnvironment2ExtGuid
)) {
154 mEfiShellEnvironment2Handle
= Buffer
[HandleIndex
];
155 Status
= EFI_SUCCESS
;
161 if (Buffer
!= NULL
) {
168 Function to do most of the work of the constructor. Allows for calling
169 multiple times without complete re-initialization.
171 @param[in] ImageHandle A copy of the ImageHandle.
172 @param[in] SystemTable A pointer to the SystemTable for the application.
174 @retval EFI_SUCCESS The operationw as successful.
178 ShellLibConstructorWorker (
179 IN EFI_HANDLE ImageHandle
,
180 IN EFI_SYSTEM_TABLE
*SystemTable
186 // UEFI 2.0 shell interfaces (used preferentially)
188 Status
= gBS
->OpenProtocol(
190 &gEfiShellProtocolGuid
,
191 (VOID
**)&gEfiShellProtocol
,
194 EFI_OPEN_PROTOCOL_GET_PROTOCOL
196 if (EFI_ERROR(Status
)) {
198 // Search for the shell protocol
200 Status
= gBS
->LocateProtocol(
201 &gEfiShellProtocolGuid
,
203 (VOID
**)&gEfiShellProtocol
205 if (EFI_ERROR(Status
)) {
206 gEfiShellProtocol
= NULL
;
209 Status
= gBS
->OpenProtocol(
211 &gEfiShellParametersProtocolGuid
,
212 (VOID
**)&gEfiShellParametersProtocol
,
215 EFI_OPEN_PROTOCOL_GET_PROTOCOL
217 if (EFI_ERROR(Status
)) {
218 gEfiShellParametersProtocol
= NULL
;
221 if (gEfiShellParametersProtocol
== NULL
|| gEfiShellProtocol
== NULL
) {
223 // Moved to seperate function due to complexity
225 Status
= ShellFindSE2(ImageHandle
);
227 if (EFI_ERROR(Status
)) {
228 DEBUG((DEBUG_ERROR
, "Status: 0x%08x\r\n", Status
));
229 mEfiShellEnvironment2
= NULL
;
231 Status
= gBS
->OpenProtocol(ImageHandle
,
232 &gEfiShellInterfaceGuid
,
233 (VOID
**)&mEfiShellInterface
,
236 EFI_OPEN_PROTOCOL_GET_PROTOCOL
238 if (EFI_ERROR(Status
)) {
239 mEfiShellInterface
= NULL
;
244 // only success getting 2 of either the old or new, but no 1/2 and 1/2
246 if ((mEfiShellEnvironment2
!= NULL
&& mEfiShellInterface
!= NULL
) ||
247 (gEfiShellProtocol
!= NULL
&& gEfiShellParametersProtocol
!= NULL
) ) {
248 if (gEfiShellProtocol
!= NULL
) {
249 FileFunctionMap
.GetFileInfo
= gEfiShellProtocol
->GetFileInfo
;
250 FileFunctionMap
.SetFileInfo
= gEfiShellProtocol
->SetFileInfo
;
251 FileFunctionMap
.ReadFile
= gEfiShellProtocol
->ReadFile
;
252 FileFunctionMap
.WriteFile
= gEfiShellProtocol
->WriteFile
;
253 FileFunctionMap
.CloseFile
= gEfiShellProtocol
->CloseFile
;
254 FileFunctionMap
.DeleteFile
= gEfiShellProtocol
->DeleteFile
;
255 FileFunctionMap
.GetFilePosition
= gEfiShellProtocol
->GetFilePosition
;
256 FileFunctionMap
.SetFilePosition
= gEfiShellProtocol
->SetFilePosition
;
257 FileFunctionMap
.FlushFile
= gEfiShellProtocol
->FlushFile
;
258 FileFunctionMap
.GetFileSize
= gEfiShellProtocol
->GetFileSize
;
260 FileFunctionMap
.GetFileInfo
= (EFI_SHELL_GET_FILE_INFO
)FileHandleGetInfo
;
261 FileFunctionMap
.SetFileInfo
= (EFI_SHELL_SET_FILE_INFO
)FileHandleSetInfo
;
262 FileFunctionMap
.ReadFile
= (EFI_SHELL_READ_FILE
)FileHandleRead
;
263 FileFunctionMap
.WriteFile
= (EFI_SHELL_WRITE_FILE
)FileHandleWrite
;
264 FileFunctionMap
.CloseFile
= (EFI_SHELL_CLOSE_FILE
)FileHandleClose
;
265 FileFunctionMap
.DeleteFile
= (EFI_SHELL_DELETE_FILE
)FileHandleDelete
;
266 FileFunctionMap
.GetFilePosition
= (EFI_SHELL_GET_FILE_POSITION
)FileHandleGetPosition
;
267 FileFunctionMap
.SetFilePosition
= (EFI_SHELL_SET_FILE_POSITION
)FileHandleSetPosition
;
268 FileFunctionMap
.FlushFile
= (EFI_SHELL_FLUSH_FILE
)FileHandleFlush
;
269 FileFunctionMap
.GetFileSize
= (EFI_SHELL_GET_FILE_SIZE
)FileHandleGetSize
;
271 return (EFI_SUCCESS
);
273 return (EFI_NOT_FOUND
);
276 Constructor for the Shell library.
278 Initialize the library and determine if the underlying is a UEFI Shell 2.0 or an EFI shell.
280 @param ImageHandle the image handle of the process
281 @param SystemTable the EFI System Table pointer
283 @retval EFI_SUCCESS the initialization was complete sucessfully
284 @return others an error ocurred during initialization
288 ShellLibConstructor (
289 IN EFI_HANDLE ImageHandle
,
290 IN EFI_SYSTEM_TABLE
*SystemTable
293 mEfiShellEnvironment2
= NULL
;
294 gEfiShellProtocol
= NULL
;
295 gEfiShellParametersProtocol
= NULL
;
296 mEfiShellInterface
= NULL
;
297 mEfiShellEnvironment2Handle
= NULL
;
300 // verify that auto initialize is not set false
302 if (PcdGetBool(PcdShellLibAutoInitialize
) == 0) {
303 return (EFI_SUCCESS
);
306 return (ShellLibConstructorWorker(ImageHandle
, SystemTable
));
310 Destructor for the library. free any resources.
312 @param[in] ImageHandle A copy of the ImageHandle.
313 @param[in] SystemTable A pointer to the SystemTable for the application.
315 @retval EFI_SUCCESS The operation was successful.
316 @return An error from the CloseProtocol function.
321 IN EFI_HANDLE ImageHandle
,
322 IN EFI_SYSTEM_TABLE
*SystemTable
325 if (mEfiShellEnvironment2
!= NULL
) {
326 gBS
->CloseProtocol(mEfiShellEnvironment2Handle
==NULL
?ImageHandle
:mEfiShellEnvironment2Handle
,
327 &gEfiShellEnvironment2Guid
,
330 mEfiShellEnvironment2
= NULL
;
332 if (mEfiShellInterface
!= NULL
) {
333 gBS
->CloseProtocol(ImageHandle
,
334 &gEfiShellInterfaceGuid
,
337 mEfiShellInterface
= NULL
;
339 if (gEfiShellProtocol
!= NULL
) {
340 gBS
->CloseProtocol(ImageHandle
,
341 &gEfiShellProtocolGuid
,
344 gEfiShellProtocol
= NULL
;
346 if (gEfiShellParametersProtocol
!= NULL
) {
347 gBS
->CloseProtocol(ImageHandle
,
348 &gEfiShellParametersProtocolGuid
,
351 gEfiShellParametersProtocol
= NULL
;
353 mEfiShellEnvironment2Handle
= NULL
;
355 return (EFI_SUCCESS
);
359 This function causes the shell library to initialize itself. If the shell library
360 is already initialized it will de-initialize all the current protocol poitners and
361 re-populate them again.
363 When the library is used with PcdShellLibAutoInitialize set to true this function
364 will return EFI_SUCCESS and perform no actions.
366 This function is intended for internal access for shell commands only.
368 @retval EFI_SUCCESS the initialization was complete sucessfully
377 // if auto initialize is not false then skip
379 if (PcdGetBool(PcdShellLibAutoInitialize
) != 0) {
380 return (EFI_SUCCESS
);
384 // deinit the current stuff
386 ASSERT_EFI_ERROR(ShellLibDestructor(gImageHandle
, gST
));
389 // init the new stuff
391 return (ShellLibConstructorWorker(gImageHandle
, gST
));
395 This function will retrieve the information about the file for the handle
396 specified and store it in allocated pool memory.
398 This function allocates a buffer to store the file's information. It is the
399 caller's responsibility to free the buffer
401 @param FileHandle The file handle of the file for which information is
404 @retval NULL information could not be retrieved.
406 @return the information about the file
411 IN SHELL_FILE_HANDLE FileHandle
414 return (FileFunctionMap
.GetFileInfo(FileHandle
));
418 This function sets the information about the file for the opened handle
421 @param[in] FileHandle The file handle of the file for which information
424 @param[in] FileInfo The information to set.
426 @retval EFI_SUCCESS The information was set.
427 @retval EFI_INVALID_PARAMETER A parameter was out of range or invalid.
428 @retval EFI_UNSUPPORTED The FileHandle does not support FileInfo.
429 @retval EFI_NO_MEDIA The device has no medium.
430 @retval EFI_DEVICE_ERROR The device reported an error.
431 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
432 @retval EFI_WRITE_PROTECTED The file or medium is write protected.
433 @retval EFI_ACCESS_DENIED The file was opened read only.
434 @retval EFI_VOLUME_FULL The volume is full.
439 IN SHELL_FILE_HANDLE FileHandle
,
440 IN EFI_FILE_INFO
*FileInfo
443 return (FileFunctionMap
.SetFileInfo(FileHandle
, FileInfo
));
447 This function will open a file or directory referenced by DevicePath.
449 This function opens a file with the open mode according to the file path. The
450 Attributes is valid only for EFI_FILE_MODE_CREATE.
452 @param FilePath on input the device path to the file. On output
453 the remaining device path.
454 @param DeviceHandle pointer to the system device handle.
455 @param FileHandle pointer to the file handle.
456 @param OpenMode the mode to open the file with.
457 @param Attributes the file's file attributes.
459 @retval EFI_SUCCESS The information was set.
460 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
461 @retval EFI_UNSUPPORTED Could not open the file path.
462 @retval EFI_NOT_FOUND The specified file could not be found on the
463 device or the file system could not be found on
465 @retval EFI_NO_MEDIA The device has no medium.
466 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the
467 medium is no longer supported.
468 @retval EFI_DEVICE_ERROR The device reported an error.
469 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
470 @retval EFI_WRITE_PROTECTED The file or medium is write protected.
471 @retval EFI_ACCESS_DENIED The file was opened read only.
472 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the
474 @retval EFI_VOLUME_FULL The volume is full.
478 ShellOpenFileByDevicePath(
479 IN OUT EFI_DEVICE_PATH_PROTOCOL
**FilePath
,
480 OUT EFI_HANDLE
*DeviceHandle
,
481 OUT SHELL_FILE_HANDLE
*FileHandle
,
488 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
*EfiSimpleFileSystemProtocol
;
489 EFI_FILE_PROTOCOL
*Handle1
;
490 EFI_FILE_PROTOCOL
*Handle2
;
491 CHAR16
*FnafPathName
;
494 if (FilePath
== NULL
|| FileHandle
== NULL
|| DeviceHandle
== NULL
) {
495 return (EFI_INVALID_PARAMETER
);
499 // which shell interface should we use
501 if (gEfiShellProtocol
!= NULL
) {
503 // use UEFI Shell 2.0 method.
505 FileName
= gEfiShellProtocol
->GetFilePathFromDevicePath(*FilePath
);
506 if (FileName
== NULL
) {
507 return (EFI_INVALID_PARAMETER
);
509 Status
= ShellOpenFileByName(FileName
, FileHandle
, OpenMode
, Attributes
);
516 // use old shell method.
518 Status
= gBS
->LocateDevicePath (&gEfiSimpleFileSystemProtocolGuid
,
521 if (EFI_ERROR (Status
)) {
524 Status
= gBS
->OpenProtocol(*DeviceHandle
,
525 &gEfiSimpleFileSystemProtocolGuid
,
526 (VOID
**)&EfiSimpleFileSystemProtocol
,
529 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
530 if (EFI_ERROR (Status
)) {
533 Status
= EfiSimpleFileSystemProtocol
->OpenVolume(EfiSimpleFileSystemProtocol
, &Handle1
);
534 if (EFI_ERROR (Status
)) {
540 // go down directories one node at a time.
542 while (!IsDevicePathEnd (*FilePath
)) {
544 // For file system access each node should be a file path component
546 if (DevicePathType (*FilePath
) != MEDIA_DEVICE_PATH
||
547 DevicePathSubType (*FilePath
) != MEDIA_FILEPATH_DP
550 return (EFI_INVALID_PARAMETER
);
553 // Open this file path node
559 // File Name Alignment Fix (FNAF)
560 // Handle2->Open may be incapable of handling a unaligned CHAR16 data.
561 // The structure pointed to by FilePath may be not CHAR16 aligned.
562 // This code copies the potentially unaligned PathName data from the
563 // FilePath structure to the aligned FnafPathName for use in the
564 // calls to Handl2->Open.
568 // Determine length of PathName, in bytes.
570 PathLen
= DevicePathNodeLength (*FilePath
) - SIZE_OF_FILEPATH_DEVICE_PATH
;
573 // Allocate memory for the aligned copy of the string Extra allocation is to allow for forced alignment
574 // Copy bytes from possibly unaligned location to aligned location
576 FnafPathName
= AllocateCopyPool(PathLen
, (UINT8
*)((FILEPATH_DEVICE_PATH
*)*FilePath
)->PathName
);
577 if (FnafPathName
== NULL
) {
578 return EFI_OUT_OF_RESOURCES
;
582 // Try to test opening an existing file
584 Status
= Handle2
->Open (
588 OpenMode
&~EFI_FILE_MODE_CREATE
,
593 // see if the error was that it needs to be created
595 if ((EFI_ERROR (Status
)) && (OpenMode
!= (OpenMode
&~EFI_FILE_MODE_CREATE
))) {
596 Status
= Handle2
->Open (
606 // Free the alignment buffer
608 FreePool(FnafPathName
);
611 // Close the last node
613 Handle2
->Close (Handle2
);
615 if (EFI_ERROR(Status
)) {
622 *FilePath
= NextDevicePathNode (*FilePath
);
626 // This is a weak spot since if the undefined SHELL_FILE_HANDLE format changes this must change also!
628 *FileHandle
= (VOID
*)Handle1
;
629 return (EFI_SUCCESS
);
633 This function will open a file or directory referenced by filename.
635 If return is EFI_SUCCESS, the Filehandle is the opened file's handle;
636 otherwise, the Filehandle is NULL. The Attributes is valid only for
637 EFI_FILE_MODE_CREATE.
639 if FileName is NULL then ASSERT()
641 @param FileName pointer to file name
642 @param FileHandle pointer to the file handle.
643 @param OpenMode the mode to open the file with.
644 @param Attributes the file's file attributes.
646 @retval EFI_SUCCESS The information was set.
647 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
648 @retval EFI_UNSUPPORTED Could not open the file path.
649 @retval EFI_NOT_FOUND The specified file could not be found on the
650 device or the file system could not be found
652 @retval EFI_NO_MEDIA The device has no medium.
653 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the
654 medium is no longer supported.
655 @retval EFI_DEVICE_ERROR The device reported an error.
656 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
657 @retval EFI_WRITE_PROTECTED The file or medium is write protected.
658 @retval EFI_ACCESS_DENIED The file was opened read only.
659 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the
661 @retval EFI_VOLUME_FULL The volume is full.
666 IN CONST CHAR16
*FileName
,
667 OUT SHELL_FILE_HANDLE
*FileHandle
,
672 EFI_HANDLE DeviceHandle
;
673 EFI_DEVICE_PATH_PROTOCOL
*FilePath
;
675 EFI_FILE_INFO
*FileInfo
;
676 CHAR16
*FileNameCopy
;
680 // ASSERT if FileName is NULL
682 ASSERT(FileName
!= NULL
);
684 if (FileName
== NULL
) {
685 return (EFI_INVALID_PARAMETER
);
688 if (gEfiShellProtocol
!= NULL
) {
689 if ((OpenMode
& EFI_FILE_MODE_CREATE
) == EFI_FILE_MODE_CREATE
) {
692 // Create only a directory
694 if ((Attributes
& EFI_FILE_DIRECTORY
) == EFI_FILE_DIRECTORY
) {
695 return ShellCreateDirectory(FileName
, FileHandle
);
699 // Create the directory to create the file in
701 FileNameCopy
= AllocateCopyPool (StrSize (FileName
), FileName
);
702 if (FileName
== NULL
) {
703 return (EFI_OUT_OF_RESOURCES
);
705 PathCleanUpDirectories (FileNameCopy
);
706 if (PathRemoveLastItem (FileNameCopy
)) {
707 if (!EFI_ERROR(ShellCreateDirectory (FileNameCopy
, FileHandle
))) {
708 ShellCloseFile (FileHandle
);
711 SHELL_FREE_NON_NULL (FileNameCopy
);
715 // Use UEFI Shell 2.0 method to create the file
717 Status
= gEfiShellProtocol
->OpenFileByName(FileName
,
720 if (StrCmp(FileName
, L
"NUL") != 0 && !EFI_ERROR(Status
) && ((OpenMode
& EFI_FILE_MODE_CREATE
) != 0)){
721 FileInfo
= FileFunctionMap
.GetFileInfo(*FileHandle
);
722 ASSERT(FileInfo
!= NULL
);
723 FileInfo
->Attribute
= Attributes
;
724 Status2
= FileFunctionMap
.SetFileInfo(*FileHandle
, FileInfo
);
726 if (EFI_ERROR (Status2
)) {
727 gEfiShellProtocol
->CloseFile(*FileHandle
);
734 // Using EFI Shell version
735 // this means convert name to path and call that function
736 // since this will use EFI method again that will open it.
738 ASSERT(mEfiShellEnvironment2
!= NULL
);
739 FilePath
= mEfiShellEnvironment2
->NameToPath ((CHAR16
*)FileName
);
740 if (FilePath
!= NULL
) {
741 return (ShellOpenFileByDevicePath(&FilePath
,
747 return (EFI_DEVICE_ERROR
);
750 This function create a directory
752 If return is EFI_SUCCESS, the Filehandle is the opened directory's handle;
753 otherwise, the Filehandle is NULL. If the directory already existed, this
754 function opens the existing directory.
756 @param DirectoryName pointer to directory name
757 @param FileHandle pointer to the file handle.
759 @retval EFI_SUCCESS The information was set.
760 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
761 @retval EFI_UNSUPPORTED Could not open the file path.
762 @retval EFI_NOT_FOUND The specified file could not be found on the
763 device or the file system could not be found
765 @retval EFI_NO_MEDIA The device has no medium.
766 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the
767 medium is no longer supported.
768 @retval EFI_DEVICE_ERROR The device reported an error.
769 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
770 @retval EFI_WRITE_PROTECTED The file or medium is write protected.
771 @retval EFI_ACCESS_DENIED The file was opened read only.
772 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the
774 @retval EFI_VOLUME_FULL The volume is full.
775 @sa ShellOpenFileByName
779 ShellCreateDirectory(
780 IN CONST CHAR16
*DirectoryName
,
781 OUT SHELL_FILE_HANDLE
*FileHandle
784 if (gEfiShellProtocol
!= NULL
) {
786 // Use UEFI Shell 2.0 method
788 return (gEfiShellProtocol
->CreateFile(DirectoryName
,
793 return (ShellOpenFileByName(DirectoryName
,
795 EFI_FILE_MODE_READ
| EFI_FILE_MODE_WRITE
| EFI_FILE_MODE_CREATE
,
802 This function reads information from an opened file.
804 If FileHandle is not a directory, the function reads the requested number of
805 bytes from the file at the file's current position and returns them in Buffer.
806 If the read goes beyond the end of the file, the read length is truncated to the
807 end of the file. The file's current position is increased by the number of bytes
808 returned. If FileHandle is a directory, the function reads the directory entry
809 at the file's current position and returns the entry in Buffer. If the Buffer
810 is not large enough to hold the current directory entry, then
811 EFI_BUFFER_TOO_SMALL is returned and the current file position is not updated.
812 BufferSize is set to be the size of the buffer needed to read the entry. On
813 success, the current position is updated to the next directory entry. If there
814 are no more directory entries, the read returns a zero-length buffer.
815 EFI_FILE_INFO is the structure returned as the directory entry.
817 @param FileHandle the opened file handle
818 @param BufferSize on input the size of buffer in bytes. on return
819 the number of bytes written.
820 @param Buffer the buffer to put read data into.
822 @retval EFI_SUCCESS Data was read.
823 @retval EFI_NO_MEDIA The device has no media.
824 @retval EFI_DEVICE_ERROR The device reported an error.
825 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
826 @retval EFI_BUFFER_TO_SMALL Buffer is too small. ReadSize contains required
833 IN SHELL_FILE_HANDLE FileHandle
,
834 IN OUT UINTN
*BufferSize
,
838 return (FileFunctionMap
.ReadFile(FileHandle
, BufferSize
, Buffer
));
843 Write data to a file.
845 This function writes the specified number of bytes to the file at the current
846 file position. The current file position is advanced the actual number of bytes
847 written, which is returned in BufferSize. Partial writes only occur when there
848 has been a data error during the write attempt (such as "volume space full").
849 The file is automatically grown to hold the data if required. Direct writes to
850 opened directories are not supported.
852 @param FileHandle The opened file for writing
853 @param BufferSize on input the number of bytes in Buffer. On output
854 the number of bytes written.
855 @param Buffer the buffer containing data to write is stored.
857 @retval EFI_SUCCESS Data was written.
858 @retval EFI_UNSUPPORTED Writes to an open directory are not supported.
859 @retval EFI_NO_MEDIA The device has no media.
860 @retval EFI_DEVICE_ERROR The device reported an error.
861 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
862 @retval EFI_WRITE_PROTECTED The device is write-protected.
863 @retval EFI_ACCESS_DENIED The file was open for read only.
864 @retval EFI_VOLUME_FULL The volume is full.
869 IN SHELL_FILE_HANDLE FileHandle
,
870 IN OUT UINTN
*BufferSize
,
874 return (FileFunctionMap
.WriteFile(FileHandle
, BufferSize
, Buffer
));
878 Close an open file handle.
880 This function closes a specified file handle. All "dirty" cached file data is
881 flushed to the device, and the file is closed. In all cases the handle is
884 @param FileHandle the file handle to close.
886 @retval EFI_SUCCESS the file handle was closed sucessfully.
891 IN SHELL_FILE_HANDLE
*FileHandle
894 return (FileFunctionMap
.CloseFile(*FileHandle
));
898 Delete a file and close the handle
900 This function closes and deletes a file. In all cases the file handle is closed.
901 If the file cannot be deleted, the warning code EFI_WARN_DELETE_FAILURE is
902 returned, but the handle is still closed.
904 @param FileHandle the file handle to delete
906 @retval EFI_SUCCESS the file was closed sucessfully
907 @retval EFI_WARN_DELETE_FAILURE the handle was closed, but the file was not
909 @retval INVALID_PARAMETER One of the parameters has an invalid value.
914 IN SHELL_FILE_HANDLE
*FileHandle
917 return (FileFunctionMap
.DeleteFile(*FileHandle
));
921 Set the current position in a file.
923 This function sets the current file position for the handle to the position
924 supplied. With the exception of seeking to position 0xFFFFFFFFFFFFFFFF, only
925 absolute positioning is supported, and seeking past the end of the file is
926 allowed (a subsequent write would grow the file). Seeking to position
927 0xFFFFFFFFFFFFFFFF causes the current position to be set to the end of the file.
928 If FileHandle is a directory, the only position that may be set is zero. This
929 has the effect of starting the read process of the directory entries over.
931 @param FileHandle The file handle on which the position is being set
932 @param Position Byte position from begining of file
934 @retval EFI_SUCCESS Operation completed sucessfully.
935 @retval EFI_UNSUPPORTED the seek request for non-zero is not valid on
937 @retval INVALID_PARAMETER One of the parameters has an invalid value.
941 ShellSetFilePosition (
942 IN SHELL_FILE_HANDLE FileHandle
,
946 return (FileFunctionMap
.SetFilePosition(FileHandle
, Position
));
950 Gets a file's current position
952 This function retrieves the current file position for the file handle. For
953 directories, the current file position has no meaning outside of the file
954 system driver and as such the operation is not supported. An error is returned
955 if FileHandle is a directory.
957 @param FileHandle The open file handle on which to get the position.
958 @param Position Byte position from begining of file.
960 @retval EFI_SUCCESS the operation completed sucessfully.
961 @retval INVALID_PARAMETER One of the parameters has an invalid value.
962 @retval EFI_UNSUPPORTED the request is not valid on directories.
966 ShellGetFilePosition (
967 IN SHELL_FILE_HANDLE FileHandle
,
971 return (FileFunctionMap
.GetFilePosition(FileHandle
, Position
));
974 Flushes data on a file
976 This function flushes all modified data associated with a file to a device.
978 @param FileHandle The file handle on which to flush data
980 @retval EFI_SUCCESS The data was flushed.
981 @retval EFI_NO_MEDIA The device has no media.
982 @retval EFI_DEVICE_ERROR The device reported an error.
983 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
984 @retval EFI_WRITE_PROTECTED The file or medium is write protected.
985 @retval EFI_ACCESS_DENIED The file was opened for read only.
990 IN SHELL_FILE_HANDLE FileHandle
993 return (FileFunctionMap
.FlushFile(FileHandle
));
996 /** Retrieve first entry from a directory.
998 This function takes an open directory handle and gets information from the
999 first entry in the directory. A buffer is allocated to contain
1000 the information and a pointer to the buffer is returned in *Buffer. The
1001 caller can use ShellFindNextFile() to get subsequent directory entries.
1003 The buffer will be freed by ShellFindNextFile() when the last directory
1004 entry is read. Otherwise, the caller must free the buffer, using FreePool,
1005 when finished with it.
1007 @param[in] DirHandle The file handle of the directory to search.
1008 @param[out] Buffer The pointer to the buffer for the file's information.
1010 @retval EFI_SUCCESS Found the first file.
1011 @retval EFI_NOT_FOUND Cannot find the directory.
1012 @retval EFI_NO_MEDIA The device has no media.
1013 @retval EFI_DEVICE_ERROR The device reported an error.
1014 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1015 @return Others status of ShellGetFileInfo, ShellSetFilePosition,
1020 ShellFindFirstFile (
1021 IN SHELL_FILE_HANDLE DirHandle
,
1022 OUT EFI_FILE_INFO
**Buffer
1026 // pass to file handle lib
1028 return (FileHandleFindFirstFile(DirHandle
, Buffer
));
1030 /** Retrieve next entries from a directory.
1032 To use this function, the caller must first call the ShellFindFirstFile()
1033 function to get the first directory entry. Subsequent directory entries are
1034 retrieved by using the ShellFindNextFile() function. This function can
1035 be called several times to get each entry from the directory. If the call of
1036 ShellFindNextFile() retrieved the last directory entry, the next call of
1037 this function will set *NoFile to TRUE and free the buffer.
1039 @param[in] DirHandle The file handle of the directory.
1040 @param[out] Buffer The pointer to buffer for file's information.
1041 @param[out] NoFile The pointer to boolean when last file is found.
1043 @retval EFI_SUCCESS Found the next file, or reached last file
1044 @retval EFI_NO_MEDIA The device has no media.
1045 @retval EFI_DEVICE_ERROR The device reported an error.
1046 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1051 IN SHELL_FILE_HANDLE DirHandle
,
1052 OUT EFI_FILE_INFO
*Buffer
,
1057 // pass to file handle lib
1059 return (FileHandleFindNextFile(DirHandle
, Buffer
, NoFile
));
1062 Retrieve the size of a file.
1064 if FileHandle is NULL then ASSERT()
1065 if Size is NULL then ASSERT()
1067 This function extracts the file size info from the FileHandle's EFI_FILE_INFO
1070 @param FileHandle file handle from which size is retrieved
1071 @param Size pointer to size
1073 @retval EFI_SUCCESS operation was completed sucessfully
1074 @retval EFI_DEVICE_ERROR cannot access the file
1079 IN SHELL_FILE_HANDLE FileHandle
,
1083 return (FileFunctionMap
.GetFileSize(FileHandle
, Size
));
1086 Retrieves the status of the break execution flag
1088 this function is useful to check whether the application is being asked to halt by the shell.
1090 @retval TRUE the execution break is enabled
1091 @retval FALSE the execution break is not enabled
1095 ShellGetExecutionBreakFlag(
1100 // Check for UEFI Shell 2.0 protocols
1102 if (gEfiShellProtocol
!= NULL
) {
1105 // We are using UEFI Shell 2.0; see if the event has been triggered
1107 if (gBS
->CheckEvent(gEfiShellProtocol
->ExecutionBreak
) != EFI_SUCCESS
) {
1114 // using EFI Shell; call the function to check
1116 if (mEfiShellEnvironment2
!= NULL
) {
1117 return (mEfiShellEnvironment2
->GetExecutionBreak());
1123 return the value of an environment variable
1125 this function gets the value of the environment variable set by the
1126 ShellSetEnvironmentVariable function
1128 @param EnvKey The key name of the environment variable.
1130 @retval NULL the named environment variable does not exist.
1131 @return != NULL pointer to the value of the environment variable
1135 ShellGetEnvironmentVariable (
1136 IN CONST CHAR16
*EnvKey
1140 // Check for UEFI Shell 2.0 protocols
1142 if (gEfiShellProtocol
!= NULL
) {
1143 return (gEfiShellProtocol
->GetEnv(EnvKey
));
1147 // Check for EFI shell
1149 if (mEfiShellEnvironment2
!= NULL
) {
1150 return (mEfiShellEnvironment2
->GetEnv((CHAR16
*)EnvKey
));
1156 set the value of an environment variable
1158 This function changes the current value of the specified environment variable. If the
1159 environment variable exists and the Value is an empty string, then the environment
1160 variable is deleted. If the environment variable exists and the Value is not an empty
1161 string, then the value of the environment variable is changed. If the environment
1162 variable does not exist and the Value is an empty string, there is no action. If the
1163 environment variable does not exist and the Value is a non-empty string, then the
1164 environment variable is created and assigned the specified value.
1166 This is not supported pre-UEFI Shell 2.0.
1168 @param EnvKey The key name of the environment variable.
1169 @param EnvVal The Value of the environment variable
1170 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
1172 @retval EFI_SUCCESS the operation was completed sucessfully
1173 @retval EFI_UNSUPPORTED This operation is not allowed in pre UEFI 2.0 Shell environments
1177 ShellSetEnvironmentVariable (
1178 IN CONST CHAR16
*EnvKey
,
1179 IN CONST CHAR16
*EnvVal
,
1184 // Check for UEFI Shell 2.0 protocols
1186 if (gEfiShellProtocol
!= NULL
) {
1187 return (gEfiShellProtocol
->SetEnv(EnvKey
, EnvVal
, Volatile
));
1191 // This feature does not exist under EFI shell
1193 return (EFI_UNSUPPORTED
);
1197 Cause the shell to parse and execute a command line.
1199 This function creates a nested instance of the shell and executes the specified
1200 command (CommandLine) with the specified environment (Environment). Upon return,
1201 the status code returned by the specified command is placed in StatusCode.
1202 If Environment is NULL, then the current environment is used and all changes made
1203 by the commands executed will be reflected in the current environment. If the
1204 Environment is non-NULL, then the changes made will be discarded.
1205 The CommandLine is executed from the current working directory on the current
1208 The EnvironmentVariables pararemeter is ignored in a pre-UEFI Shell 2.0
1209 environment. The values pointed to by the parameters will be unchanged by the
1210 ShellExecute() function. The Output parameter has no effect in a
1211 UEFI Shell 2.0 environment.
1213 @param[in] ParentHandle The parent image starting the operation.
1214 @param[in] CommandLine The pointer to a NULL terminated command line.
1215 @param[in] Output True to display debug output. False to hide it.
1216 @param[in] EnvironmentVariables Optional pointer to array of environment variables
1217 in the form "x=y". If NULL, the current set is used.
1218 @param[out] Status The status of the run command line.
1220 @retval EFI_SUCCESS The operation completed sucessfully. Status
1221 contains the status code returned.
1222 @retval EFI_INVALID_PARAMETER A parameter contains an invalid value.
1223 @retval EFI_OUT_OF_RESOURCES Out of resources.
1224 @retval EFI_UNSUPPORTED The operation is not allowed.
1229 IN EFI_HANDLE
*ParentHandle
,
1230 IN CHAR16
*CommandLine OPTIONAL
,
1231 IN BOOLEAN Output OPTIONAL
,
1232 IN CHAR16
**EnvironmentVariables OPTIONAL
,
1233 OUT EFI_STATUS
*Status OPTIONAL
1236 EFI_STATUS CmdStatus
;
1238 // Check for UEFI Shell 2.0 protocols
1240 if (gEfiShellProtocol
!= NULL
) {
1242 // Call UEFI Shell 2.0 version (not using Output parameter)
1244 return (gEfiShellProtocol
->Execute(ParentHandle
,
1246 EnvironmentVariables
,
1251 // Check for EFI shell
1253 if (mEfiShellEnvironment2
!= NULL
) {
1255 // Call EFI Shell version.
1256 // Due to oddity in the EFI shell we want to dereference the ParentHandle here
1258 CmdStatus
= (mEfiShellEnvironment2
->Execute(*ParentHandle
,
1262 // No Status output parameter so just use the returned status
1264 if (Status
!= NULL
) {
1265 *Status
= CmdStatus
;
1268 // If there was an error, we can't tell if it was from the command or from
1269 // the Execute() function, so we'll just assume the shell ran successfully
1270 // and the error came from the command.
1275 return (EFI_UNSUPPORTED
);
1279 Retreives the current directory path
1281 If the DeviceName is NULL, it returns the current device's current directory
1282 name. If the DeviceName is not NULL, it returns the current directory name
1285 Note that the current directory string should exclude the tailing backslash character.
1287 @param DeviceName the name of the drive to get directory on
1289 @retval NULL the directory does not exist
1290 @return != NULL the directory
1294 ShellGetCurrentDir (
1295 IN CHAR16
* CONST DeviceName OPTIONAL
1299 // Check for UEFI Shell 2.0 protocols
1301 if (gEfiShellProtocol
!= NULL
) {
1302 return (gEfiShellProtocol
->GetCurDir(DeviceName
));
1306 // Check for EFI shell
1308 if (mEfiShellEnvironment2
!= NULL
) {
1309 return (mEfiShellEnvironment2
->CurDir(DeviceName
));
1315 sets (enabled or disabled) the page break mode
1317 when page break mode is enabled the screen will stop scrolling
1318 and wait for operator input before scrolling a subsequent screen.
1320 @param CurrentState TRUE to enable and FALSE to disable
1324 ShellSetPageBreakMode (
1325 IN BOOLEAN CurrentState
1329 // check for enabling
1331 if (CurrentState
!= 0x00) {
1333 // check for UEFI Shell 2.0
1335 if (gEfiShellProtocol
!= NULL
) {
1337 // Enable with UEFI 2.0 Shell
1339 gEfiShellProtocol
->EnablePageBreak();
1343 // Check for EFI shell
1345 if (mEfiShellEnvironment2
!= NULL
) {
1347 // Enable with EFI Shell
1349 mEfiShellEnvironment2
->EnablePageBreak (DEFAULT_INIT_ROW
, DEFAULT_AUTO_LF
);
1355 // check for UEFI Shell 2.0
1357 if (gEfiShellProtocol
!= NULL
) {
1359 // Disable with UEFI 2.0 Shell
1361 gEfiShellProtocol
->DisablePageBreak();
1365 // Check for EFI shell
1367 if (mEfiShellEnvironment2
!= NULL
) {
1369 // Disable with EFI Shell
1371 mEfiShellEnvironment2
->DisablePageBreak ();
1379 /// version of EFI_SHELL_FILE_INFO struct, except has no CONST pointers.
1380 /// This allows for the struct to be populated.
1387 SHELL_FILE_HANDLE Handle
;
1388 EFI_FILE_INFO
*Info
;
1389 } EFI_SHELL_FILE_INFO_NO_CONST
;
1392 Converts a EFI shell list of structures to the coresponding UEFI Shell 2.0 type of list.
1394 if OldStyleFileList is NULL then ASSERT()
1396 this function will convert a SHELL_FILE_ARG based list into a callee allocated
1397 EFI_SHELL_FILE_INFO based list. it is up to the caller to free the memory via
1398 the ShellCloseFileMetaArg function.
1400 @param[in] FileList the EFI shell list type
1401 @param[in, out] ListHead the list to add to
1403 @retval the resultant head of the double linked new format list;
1407 InternalShellConvertFileListType (
1408 IN LIST_ENTRY
*FileList
,
1409 IN OUT LIST_ENTRY
*ListHead
1412 SHELL_FILE_ARG
*OldInfo
;
1414 EFI_SHELL_FILE_INFO_NO_CONST
*NewInfo
;
1419 ASSERT(FileList
!= NULL
);
1420 ASSERT(ListHead
!= NULL
);
1423 // enumerate through each member of the old list and copy
1425 for (Link
= FileList
->ForwardLink
; Link
!= FileList
; Link
= Link
->ForwardLink
) {
1426 OldInfo
= CR (Link
, SHELL_FILE_ARG
, Link
, SHELL_FILE_ARG_SIGNATURE
);
1427 ASSERT(OldInfo
!= NULL
);
1430 // Skip ones that failed to open...
1432 if (OldInfo
->Status
!= EFI_SUCCESS
) {
1437 // make sure the old list was valid
1439 ASSERT(OldInfo
->Info
!= NULL
);
1440 ASSERT(OldInfo
->FullName
!= NULL
);
1441 ASSERT(OldInfo
->FileName
!= NULL
);
1444 // allocate a new EFI_SHELL_FILE_INFO object
1446 NewInfo
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1447 if (NewInfo
== NULL
) {
1448 ShellCloseFileMetaArg((EFI_SHELL_FILE_INFO
**)(&ListHead
));
1454 // copy the simple items
1456 NewInfo
->Handle
= OldInfo
->Handle
;
1457 NewInfo
->Status
= OldInfo
->Status
;
1459 // old shell checks for 0 not NULL
1460 OldInfo
->Handle
= 0;
1463 // allocate new space to copy strings and structure
1465 NewInfo
->FullName
= AllocateCopyPool(StrSize(OldInfo
->FullName
), OldInfo
->FullName
);
1466 NewInfo
->FileName
= AllocateCopyPool(StrSize(OldInfo
->FileName
), OldInfo
->FileName
);
1467 NewInfo
->Info
= AllocateCopyPool((UINTN
)OldInfo
->Info
->Size
, OldInfo
->Info
);
1470 // make sure all the memory allocations were sucessful
1472 if (NULL
== NewInfo
->FullName
|| NewInfo
->FileName
== NULL
|| NewInfo
->Info
== NULL
) {
1474 // Free the partially allocated new node
1476 SHELL_FREE_NON_NULL(NewInfo
->FullName
);
1477 SHELL_FREE_NON_NULL(NewInfo
->FileName
);
1478 SHELL_FREE_NON_NULL(NewInfo
->Info
);
1479 SHELL_FREE_NON_NULL(NewInfo
);
1482 // Free the previously converted stuff
1484 ShellCloseFileMetaArg((EFI_SHELL_FILE_INFO
**)(&ListHead
));
1490 // add that to the list
1492 InsertTailList(ListHead
, &NewInfo
->Link
);
1497 Opens a group of files based on a path.
1499 This function uses the Arg to open all the matching files. Each matched
1500 file has a SHELL_FILE_INFO structure to record the file information. These
1501 structures are placed on the list ListHead. Users can get the SHELL_FILE_INFO
1502 structures from ListHead to access each file. This function supports wildcards
1503 and will process '?' and '*' as such. the list must be freed with a call to
1504 ShellCloseFileMetaArg().
1506 If you are NOT appending to an existing list *ListHead must be NULL. If
1507 *ListHead is NULL then it must be callee freed.
1509 @param Arg pointer to path string
1510 @param OpenMode mode to open files with
1511 @param ListHead head of linked list of results
1513 @retval EFI_SUCCESS the operation was sucessful and the list head
1514 contains the list of opened files
1515 @return != EFI_SUCCESS the operation failed
1517 @sa InternalShellConvertFileListType
1521 ShellOpenFileMetaArg (
1524 IN OUT EFI_SHELL_FILE_INFO
**ListHead
1528 LIST_ENTRY mOldStyleFileList
;
1529 CHAR16
*CleanFilePathStr
;
1532 // ASSERT that Arg and ListHead are not NULL
1534 ASSERT(Arg
!= NULL
);
1535 ASSERT(ListHead
!= NULL
);
1537 CleanFilePathStr
= NULL
;
1539 Status
= InternalShellStripQuotes (Arg
, &CleanFilePathStr
);
1540 if (EFI_ERROR (Status
)) {
1545 // Check for UEFI Shell 2.0 protocols
1547 if (gEfiShellProtocol
!= NULL
) {
1548 if (*ListHead
== NULL
) {
1549 *ListHead
= (EFI_SHELL_FILE_INFO
*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1550 if (*ListHead
== NULL
) {
1551 FreePool(CleanFilePathStr
);
1552 return (EFI_OUT_OF_RESOURCES
);
1554 InitializeListHead(&((*ListHead
)->Link
));
1556 Status
= gEfiShellProtocol
->OpenFileList(CleanFilePathStr
,
1559 if (EFI_ERROR(Status
)) {
1560 gEfiShellProtocol
->RemoveDupInFileList(ListHead
);
1562 Status
= gEfiShellProtocol
->RemoveDupInFileList(ListHead
);
1564 if (*ListHead
!= NULL
&& IsListEmpty(&(*ListHead
)->Link
)) {
1565 FreePool(*ListHead
);
1566 FreePool(CleanFilePathStr
);
1568 return (EFI_NOT_FOUND
);
1570 FreePool(CleanFilePathStr
);
1575 // Check for EFI shell
1577 if (mEfiShellEnvironment2
!= NULL
) {
1579 // make sure the list head is initialized
1581 InitializeListHead(&mOldStyleFileList
);
1584 // Get the EFI Shell list of files
1586 Status
= mEfiShellEnvironment2
->FileMetaArg(CleanFilePathStr
, &mOldStyleFileList
);
1587 if (EFI_ERROR(Status
)) {
1589 FreePool(CleanFilePathStr
);
1593 if (*ListHead
== NULL
) {
1594 *ListHead
= (EFI_SHELL_FILE_INFO
*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1595 if (*ListHead
== NULL
) {
1596 FreePool(CleanFilePathStr
);
1597 return (EFI_OUT_OF_RESOURCES
);
1599 InitializeListHead(&((*ListHead
)->Link
));
1603 // Convert that to equivalent of UEFI Shell 2.0 structure
1605 InternalShellConvertFileListType(&mOldStyleFileList
, &(*ListHead
)->Link
);
1608 // Free the EFI Shell version that was converted.
1610 mEfiShellEnvironment2
->FreeFileList(&mOldStyleFileList
);
1612 if ((*ListHead
)->Link
.ForwardLink
== (*ListHead
)->Link
.BackLink
&& (*ListHead
)->Link
.BackLink
== &((*ListHead
)->Link
)) {
1613 FreePool(*ListHead
);
1615 Status
= EFI_NOT_FOUND
;
1617 FreePool(CleanFilePathStr
);
1621 FreePool(CleanFilePathStr
);
1622 return (EFI_UNSUPPORTED
);
1625 Free the linked list returned from ShellOpenFileMetaArg.
1627 if ListHead is NULL then ASSERT().
1629 @param ListHead the pointer to free.
1631 @retval EFI_SUCCESS the operation was sucessful.
1635 ShellCloseFileMetaArg (
1636 IN OUT EFI_SHELL_FILE_INFO
**ListHead
1642 // ASSERT that ListHead is not NULL
1644 ASSERT(ListHead
!= NULL
);
1647 // Check for UEFI Shell 2.0 protocols
1649 if (gEfiShellProtocol
!= NULL
) {
1650 return (gEfiShellProtocol
->FreeFileList(ListHead
));
1651 } else if (mEfiShellEnvironment2
!= NULL
) {
1653 // Since this is EFI Shell version we need to free our internally made copy
1656 for ( Node
= GetFirstNode(&(*ListHead
)->Link
)
1657 ; *ListHead
!= NULL
&& !IsListEmpty(&(*ListHead
)->Link
)
1658 ; Node
= GetFirstNode(&(*ListHead
)->Link
)) {
1659 RemoveEntryList(Node
);
1660 ((EFI_FILE_PROTOCOL
*)((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->Handle
)->Close(((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->Handle
);
1661 FreePool(((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->FullName
);
1662 FreePool(((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->FileName
);
1663 FreePool(((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->Info
);
1664 FreePool((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
);
1666 SHELL_FREE_NON_NULL(*ListHead
);
1670 return (EFI_UNSUPPORTED
);
1674 Find a file by searching the CWD and then the path.
1676 If FileName is NULL then ASSERT.
1678 If the return value is not NULL then the memory must be caller freed.
1680 @param FileName Filename string.
1682 @retval NULL the file was not found
1683 @return !NULL the full path to the file.
1688 IN CONST CHAR16
*FileName
1692 SHELL_FILE_HANDLE Handle
;
1696 CONST CHAR16
*Walker
;
1703 // First make sure its not an absolute path.
1705 Status
= ShellOpenFileByName(FileName
, &Handle
, EFI_FILE_MODE_READ
, 0);
1706 if (!EFI_ERROR(Status
)){
1707 if (FileHandleIsDirectory(Handle
) != EFI_SUCCESS
) {
1708 ASSERT(RetVal
== NULL
);
1709 RetVal
= StrnCatGrow(&RetVal
, NULL
, FileName
, 0);
1710 ShellCloseFile(&Handle
);
1713 ShellCloseFile(&Handle
);
1717 Path
= ShellGetEnvironmentVariable(L
"cwd");
1719 Size
= StrSize(Path
) + sizeof(CHAR16
);
1720 Size
+= StrSize(FileName
);
1721 TestPath
= AllocateZeroPool(Size
);
1722 if (TestPath
== NULL
) {
1725 StrCpyS(TestPath
, Size
/sizeof(CHAR16
), Path
);
1726 StrCatS(TestPath
, Size
/sizeof(CHAR16
), L
"\\");
1727 StrCatS(TestPath
, Size
/sizeof(CHAR16
), FileName
);
1728 Status
= ShellOpenFileByName(TestPath
, &Handle
, EFI_FILE_MODE_READ
, 0);
1729 if (!EFI_ERROR(Status
)){
1730 if (FileHandleIsDirectory(Handle
) != EFI_SUCCESS
) {
1731 ASSERT(RetVal
== NULL
);
1732 RetVal
= StrnCatGrow(&RetVal
, NULL
, TestPath
, 0);
1733 ShellCloseFile(&Handle
);
1737 ShellCloseFile(&Handle
);
1742 Path
= ShellGetEnvironmentVariable(L
"path");
1744 Size
= StrSize(Path
)+sizeof(CHAR16
);
1745 Size
+= StrSize(FileName
);
1746 TestPath
= AllocateZeroPool(Size
);
1747 if (TestPath
== NULL
) {
1750 Walker
= (CHAR16
*)Path
;
1752 CopyMem(TestPath
, Walker
, StrSize(Walker
));
1753 if (TestPath
!= NULL
) {
1754 TempChar
= StrStr(TestPath
, L
";");
1755 if (TempChar
!= NULL
) {
1756 *TempChar
= CHAR_NULL
;
1758 if (TestPath
[StrLen(TestPath
)-1] != L
'\\') {
1759 StrCatS(TestPath
, Size
/sizeof(CHAR16
), L
"\\");
1761 if (FileName
[0] == L
'\\') {
1764 StrCatS(TestPath
, Size
/sizeof(CHAR16
), FileName
);
1765 if (StrStr(Walker
, L
";") != NULL
) {
1766 Walker
= StrStr(Walker
, L
";") + 1;
1770 Status
= ShellOpenFileByName(TestPath
, &Handle
, EFI_FILE_MODE_READ
, 0);
1771 if (!EFI_ERROR(Status
)){
1772 if (FileHandleIsDirectory(Handle
) != EFI_SUCCESS
) {
1773 ASSERT(RetVal
== NULL
);
1774 RetVal
= StrnCatGrow(&RetVal
, NULL
, TestPath
, 0);
1775 ShellCloseFile(&Handle
);
1778 ShellCloseFile(&Handle
);
1782 } while (Walker
!= NULL
&& Walker
[0] != CHAR_NULL
);
1789 Find a file by searching the CWD and then the path with a variable set of file
1790 extensions. If the file is not found it will append each extension in the list
1791 in the order provided and return the first one that is successful.
1793 If FileName is NULL, then ASSERT.
1794 If FileExtension is NULL, then behavior is identical to ShellFindFilePath.
1796 If the return value is not NULL then the memory must be caller freed.
1798 @param[in] FileName Filename string.
1799 @param[in] FileExtension Semi-colon delimeted list of possible extensions.
1801 @retval NULL The file was not found.
1802 @retval !NULL The path to the file.
1806 ShellFindFilePathEx (
1807 IN CONST CHAR16
*FileName
,
1808 IN CONST CHAR16
*FileExtension
1813 CONST CHAR16
*ExtensionWalker
;
1818 ASSERT(FileName
!= NULL
);
1819 if (FileExtension
== NULL
) {
1820 return (ShellFindFilePath(FileName
));
1822 RetVal
= ShellFindFilePath(FileName
);
1823 if (RetVal
!= NULL
) {
1826 Size
= StrSize(FileName
);
1827 Size
+= StrSize(FileExtension
);
1828 TestPath
= AllocateZeroPool(Size
);
1829 if (TestPath
== NULL
) {
1832 for (ExtensionWalker
= FileExtension
, TempChar2
= (CHAR16
*)FileExtension
; TempChar2
!= NULL
; ExtensionWalker
= TempChar2
+ 1){
1833 StrCpyS(TestPath
, Size
/sizeof(CHAR16
), FileName
);
1834 if (ExtensionWalker
!= NULL
) {
1835 StrCatS(TestPath
, Size
/sizeof(CHAR16
), ExtensionWalker
);
1837 TempChar
= StrStr(TestPath
, L
";");
1838 if (TempChar
!= NULL
) {
1839 *TempChar
= CHAR_NULL
;
1841 RetVal
= ShellFindFilePath(TestPath
);
1842 if (RetVal
!= NULL
) {
1845 ASSERT(ExtensionWalker
!= NULL
);
1846 TempChar2
= StrStr(ExtensionWalker
, L
";");
1855 SHELL_PARAM_TYPE Type
;
1857 UINTN OriginalPosition
;
1858 } SHELL_PARAM_PACKAGE
;
1861 Checks the list of valid arguments and returns TRUE if the item was found. If the
1862 return value is TRUE then the type parameter is set also.
1864 if CheckList is NULL then ASSERT();
1865 if Name is NULL then ASSERT();
1866 if Type is NULL then ASSERT();
1868 @param Name pointer to Name of parameter found
1869 @param CheckList List to check against
1870 @param Type pointer to type of parameter if it was found
1872 @retval TRUE the Parameter was found. Type is valid.
1873 @retval FALSE the Parameter was not found. Type is not valid.
1877 InternalIsOnCheckList (
1878 IN CONST CHAR16
*Name
,
1879 IN CONST SHELL_PARAM_ITEM
*CheckList
,
1880 OUT SHELL_PARAM_TYPE
*Type
1883 SHELL_PARAM_ITEM
*TempListItem
;
1887 // ASSERT that all 3 pointer parameters aren't NULL
1889 ASSERT(CheckList
!= NULL
);
1890 ASSERT(Type
!= NULL
);
1891 ASSERT(Name
!= NULL
);
1894 // question mark and page break mode are always supported
1896 if ((StrCmp(Name
, L
"-?") == 0) ||
1897 (StrCmp(Name
, L
"-b") == 0)
1904 // Enumerate through the list
1906 for (TempListItem
= (SHELL_PARAM_ITEM
*)CheckList
; TempListItem
->Name
!= NULL
; TempListItem
++) {
1908 // If the Type is TypeStart only check the first characters of the passed in param
1909 // If it matches set the type and return TRUE
1911 if (TempListItem
->Type
== TypeStart
) {
1912 if (StrnCmp(Name
, TempListItem
->Name
, StrLen(TempListItem
->Name
)) == 0) {
1913 *Type
= TempListItem
->Type
;
1917 TempString
= StrnCatGrow(&TempString
, NULL
, Name
, StrLen(TempListItem
->Name
));
1918 if (TempString
!= NULL
) {
1919 if (StringNoCaseCompare(&TempString
, &TempListItem
->Name
) == 0) {
1920 *Type
= TempListItem
->Type
;
1921 FreePool(TempString
);
1924 FreePool(TempString
);
1926 } else if (StringNoCaseCompare(&Name
, &TempListItem
->Name
) == 0) {
1927 *Type
= TempListItem
->Type
;
1935 Checks the string for indicators of "flag" status. this is a leading '/', '-', or '+'
1937 @param[in] Name pointer to Name of parameter found
1938 @param[in] AlwaysAllowNumbers TRUE to allow numbers, FALSE to not.
1939 @param[in] TimeNumbers TRUE to allow numbers with ":", FALSE otherwise.
1941 @retval TRUE the Parameter is a flag.
1942 @retval FALSE the Parameter not a flag.
1947 IN CONST CHAR16
*Name
,
1948 IN CONST BOOLEAN AlwaysAllowNumbers
,
1949 IN CONST BOOLEAN TimeNumbers
1953 // ASSERT that Name isn't NULL
1955 ASSERT(Name
!= NULL
);
1958 // If we accept numbers then dont return TRUE. (they will be values)
1960 if (((Name
[0] == L
'-' || Name
[0] == L
'+') && InternalShellIsHexOrDecimalNumber(Name
+1, FALSE
, FALSE
, TimeNumbers
)) && AlwaysAllowNumbers
) {
1965 // If the Name has a /, +, or - as the first character return TRUE
1967 if ((Name
[0] == L
'/') ||
1968 (Name
[0] == L
'-') ||
1977 Checks the command line arguments passed against the list of valid ones.
1979 If no initialization is required, then return RETURN_SUCCESS.
1981 @param[in] CheckList pointer to list of parameters to check
1982 @param[out] CheckPackage pointer to pointer to list checked values
1983 @param[out] ProblemParam optional pointer to pointer to unicode string for
1984 the paramater that caused failure. If used then the
1985 caller is responsible for freeing the memory.
1986 @param[in] AutoPageBreak will automatically set PageBreakEnabled for "b" parameter
1987 @param[in] Argv pointer to array of parameters
1988 @param[in] Argc Count of parameters in Argv
1989 @param[in] AlwaysAllowNumbers TRUE to allow numbers always, FALSE otherwise.
1991 @retval EFI_SUCCESS The operation completed sucessfully.
1992 @retval EFI_OUT_OF_RESOURCES A memory allocation failed
1993 @retval EFI_INVALID_PARAMETER A parameter was invalid
1994 @retval EFI_VOLUME_CORRUPTED the command line was corrupt. an argument was
1995 duplicated. the duplicated command line argument
1996 was returned in ProblemParam if provided.
1997 @retval EFI_NOT_FOUND a argument required a value that was missing.
1998 the invalid command line argument was returned in
1999 ProblemParam if provided.
2003 InternalCommandLineParse (
2004 IN CONST SHELL_PARAM_ITEM
*CheckList
,
2005 OUT LIST_ENTRY
**CheckPackage
,
2006 OUT CHAR16
**ProblemParam OPTIONAL
,
2007 IN BOOLEAN AutoPageBreak
,
2008 IN CONST CHAR16
**Argv
,
2010 IN BOOLEAN AlwaysAllowNumbers
2014 SHELL_PARAM_TYPE CurrentItemType
;
2015 SHELL_PARAM_PACKAGE
*CurrentItemPackage
;
2019 CONST CHAR16
*TempPointer
;
2020 UINTN CurrentValueSize
;
2022 CurrentItemPackage
= NULL
;
2028 // If there is only 1 item we dont need to do anything
2031 *CheckPackage
= NULL
;
2032 return (EFI_SUCCESS
);
2038 ASSERT(CheckList
!= NULL
);
2039 ASSERT(Argv
!= NULL
);
2042 // initialize the linked list
2044 *CheckPackage
= (LIST_ENTRY
*)AllocateZeroPool(sizeof(LIST_ENTRY
));
2045 if (*CheckPackage
== NULL
) {
2046 return (EFI_OUT_OF_RESOURCES
);
2049 InitializeListHead(*CheckPackage
);
2052 // loop through each of the arguments
2054 for (LoopCounter
= 0 ; LoopCounter
< Argc
; ++LoopCounter
) {
2055 if (Argv
[LoopCounter
] == NULL
) {
2057 // do nothing for NULL argv
2059 } else if (InternalIsOnCheckList(Argv
[LoopCounter
], CheckList
, &CurrentItemType
)) {
2061 // We might have leftover if last parameter didnt have optional value
2063 if (GetItemValue
!= 0) {
2065 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
2070 CurrentItemPackage
= AllocateZeroPool(sizeof(SHELL_PARAM_PACKAGE
));
2071 if (CurrentItemPackage
== NULL
) {
2072 ShellCommandLineFreeVarList(*CheckPackage
);
2073 *CheckPackage
= NULL
;
2074 return (EFI_OUT_OF_RESOURCES
);
2076 CurrentItemPackage
->Name
= AllocateCopyPool(StrSize(Argv
[LoopCounter
]), Argv
[LoopCounter
]);
2077 if (CurrentItemPackage
->Name
== NULL
) {
2078 ShellCommandLineFreeVarList(*CheckPackage
);
2079 *CheckPackage
= NULL
;
2080 return (EFI_OUT_OF_RESOURCES
);
2082 CurrentItemPackage
->Type
= CurrentItemType
;
2083 CurrentItemPackage
->OriginalPosition
= (UINTN
)(-1);
2084 CurrentItemPackage
->Value
= NULL
;
2087 // Does this flag require a value
2089 switch (CurrentItemPackage
->Type
) {
2091 // possibly trigger the next loop(s) to populate the value of this item
2098 case TypeDoubleValue
:
2103 GetItemValue
= (UINTN
)(-1);
2108 // this item has no value expected; we are done
2110 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
2111 ASSERT(GetItemValue
== 0);
2114 } else if (GetItemValue
!= 0 && CurrentItemPackage
!= NULL
&& !InternalIsFlag(Argv
[LoopCounter
], AlwaysAllowNumbers
, (BOOLEAN
)(CurrentItemPackage
->Type
== TypeTimeValue
))) {
2116 // get the item VALUE for a previous flag
2118 CurrentValueSize
= ValueSize
+ StrSize(Argv
[LoopCounter
]) + sizeof(CHAR16
);
2119 CurrentItemPackage
->Value
= ReallocatePool(ValueSize
, CurrentValueSize
, CurrentItemPackage
->Value
);
2120 ASSERT(CurrentItemPackage
->Value
!= NULL
);
2121 if (ValueSize
== 0) {
2122 StrCpyS( CurrentItemPackage
->Value
,
2123 CurrentValueSize
/sizeof(CHAR16
),
2127 StrCatS( CurrentItemPackage
->Value
,
2128 CurrentValueSize
/sizeof(CHAR16
),
2131 StrCatS( CurrentItemPackage
->Value
,
2132 CurrentValueSize
/sizeof(CHAR16
),
2136 ValueSize
+= StrSize(Argv
[LoopCounter
]) + sizeof(CHAR16
);
2139 if (GetItemValue
== 0) {
2140 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
2142 } else if (!InternalIsFlag(Argv
[LoopCounter
], AlwaysAllowNumbers
, FALSE
)){
2144 // add this one as a non-flag
2147 TempPointer
= Argv
[LoopCounter
];
2148 if ((*TempPointer
== L
'^' && *(TempPointer
+1) == L
'-')
2149 || (*TempPointer
== L
'^' && *(TempPointer
+1) == L
'/')
2150 || (*TempPointer
== L
'^' && *(TempPointer
+1) == L
'+')
2154 CurrentItemPackage
= AllocateZeroPool(sizeof(SHELL_PARAM_PACKAGE
));
2155 if (CurrentItemPackage
== NULL
) {
2156 ShellCommandLineFreeVarList(*CheckPackage
);
2157 *CheckPackage
= NULL
;
2158 return (EFI_OUT_OF_RESOURCES
);
2160 CurrentItemPackage
->Name
= NULL
;
2161 CurrentItemPackage
->Type
= TypePosition
;
2162 CurrentItemPackage
->Value
= AllocateCopyPool(StrSize(TempPointer
), TempPointer
);
2163 if (CurrentItemPackage
->Value
== NULL
) {
2164 ShellCommandLineFreeVarList(*CheckPackage
);
2165 *CheckPackage
= NULL
;
2166 return (EFI_OUT_OF_RESOURCES
);
2168 CurrentItemPackage
->OriginalPosition
= Count
++;
2169 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
2172 // this was a non-recognised flag... error!
2174 if (ProblemParam
!= NULL
) {
2175 *ProblemParam
= AllocateCopyPool(StrSize(Argv
[LoopCounter
]), Argv
[LoopCounter
]);
2177 ShellCommandLineFreeVarList(*CheckPackage
);
2178 *CheckPackage
= NULL
;
2179 return (EFI_VOLUME_CORRUPTED
);
2182 if (GetItemValue
!= 0) {
2184 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
2187 // support for AutoPageBreak
2189 if (AutoPageBreak
&& ShellCommandLineGetFlag(*CheckPackage
, L
"-b")) {
2190 ShellSetPageBreakMode(TRUE
);
2192 return (EFI_SUCCESS
);
2196 Checks the command line arguments passed against the list of valid ones.
2197 Optionally removes NULL values first.
2199 If no initialization is required, then return RETURN_SUCCESS.
2201 @param[in] CheckList The pointer to list of parameters to check.
2202 @param[out] CheckPackage The package of checked values.
2203 @param[out] ProblemParam Optional pointer to pointer to unicode string for
2204 the paramater that caused failure.
2205 @param[in] AutoPageBreak Will automatically set PageBreakEnabled.
2206 @param[in] AlwaysAllowNumbers Will never fail for number based flags.
2208 @retval EFI_SUCCESS The operation completed sucessfully.
2209 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
2210 @retval EFI_INVALID_PARAMETER A parameter was invalid.
2211 @retval EFI_VOLUME_CORRUPTED The command line was corrupt.
2212 @retval EFI_DEVICE_ERROR The commands contained 2 opposing arguments. One
2213 of the command line arguments was returned in
2214 ProblemParam if provided.
2215 @retval EFI_NOT_FOUND A argument required a value that was missing.
2216 The invalid command line argument was returned in
2217 ProblemParam if provided.
2221 ShellCommandLineParseEx (
2222 IN CONST SHELL_PARAM_ITEM
*CheckList
,
2223 OUT LIST_ENTRY
**CheckPackage
,
2224 OUT CHAR16
**ProblemParam OPTIONAL
,
2225 IN BOOLEAN AutoPageBreak
,
2226 IN BOOLEAN AlwaysAllowNumbers
2230 // ASSERT that CheckList and CheckPackage aren't NULL
2232 ASSERT(CheckList
!= NULL
);
2233 ASSERT(CheckPackage
!= NULL
);
2236 // Check for UEFI Shell 2.0 protocols
2238 if (gEfiShellParametersProtocol
!= NULL
) {
2239 return (InternalCommandLineParse(CheckList
,
2243 (CONST CHAR16
**) gEfiShellParametersProtocol
->Argv
,
2244 gEfiShellParametersProtocol
->Argc
,
2245 AlwaysAllowNumbers
));
2249 // ASSERT That EFI Shell is not required
2251 ASSERT (mEfiShellInterface
!= NULL
);
2252 return (InternalCommandLineParse(CheckList
,
2256 (CONST CHAR16
**) mEfiShellInterface
->Argv
,
2257 mEfiShellInterface
->Argc
,
2258 AlwaysAllowNumbers
));
2262 Frees shell variable list that was returned from ShellCommandLineParse.
2264 This function will free all the memory that was used for the CheckPackage
2265 list of postprocessed shell arguments.
2267 this function has no return value.
2269 if CheckPackage is NULL, then return
2271 @param CheckPackage the list to de-allocate
2275 ShellCommandLineFreeVarList (
2276 IN LIST_ENTRY
*CheckPackage
2282 // check for CheckPackage == NULL
2284 if (CheckPackage
== NULL
) {
2289 // for each node in the list
2291 for ( Node
= GetFirstNode(CheckPackage
)
2292 ; !IsListEmpty(CheckPackage
)
2293 ; Node
= GetFirstNode(CheckPackage
)
2296 // Remove it from the list
2298 RemoveEntryList(Node
);
2301 // if it has a name free the name
2303 if (((SHELL_PARAM_PACKAGE
*)Node
)->Name
!= NULL
) {
2304 FreePool(((SHELL_PARAM_PACKAGE
*)Node
)->Name
);
2308 // if it has a value free the value
2310 if (((SHELL_PARAM_PACKAGE
*)Node
)->Value
!= NULL
) {
2311 FreePool(((SHELL_PARAM_PACKAGE
*)Node
)->Value
);
2315 // free the node structure
2317 FreePool((SHELL_PARAM_PACKAGE
*)Node
);
2320 // free the list head node
2322 FreePool(CheckPackage
);
2325 Checks for presence of a flag parameter
2327 flag arguments are in the form of "-<Key>" or "/<Key>", but do not have a value following the key
2329 if CheckPackage is NULL then return FALSE.
2330 if KeyString is NULL then ASSERT()
2332 @param CheckPackage The package of parsed command line arguments
2333 @param KeyString the Key of the command line argument to check for
2335 @retval TRUE the flag is on the command line
2336 @retval FALSE the flag is not on the command line
2340 ShellCommandLineGetFlag (
2341 IN CONST LIST_ENTRY
* CONST CheckPackage
,
2342 IN CONST CHAR16
* CONST KeyString
2349 // return FALSE for no package or KeyString is NULL
2351 if (CheckPackage
== NULL
|| KeyString
== NULL
) {
2356 // enumerate through the list of parametrs
2358 for ( Node
= GetFirstNode(CheckPackage
)
2359 ; !IsNull (CheckPackage
, Node
)
2360 ; Node
= GetNextNode(CheckPackage
, Node
)
2363 // If the Name matches, return TRUE (and there may be NULL name)
2365 if (((SHELL_PARAM_PACKAGE
*)Node
)->Name
!= NULL
) {
2367 // If Type is TypeStart then only compare the begining of the strings
2369 if (((SHELL_PARAM_PACKAGE
*)Node
)->Type
== TypeStart
) {
2370 if (StrnCmp(KeyString
, ((SHELL_PARAM_PACKAGE
*)Node
)->Name
, StrLen(KeyString
)) == 0) {
2374 TempString
= StrnCatGrow(&TempString
, NULL
, KeyString
, StrLen(((SHELL_PARAM_PACKAGE
*)Node
)->Name
));
2375 if (TempString
!= NULL
) {
2376 if (StringNoCaseCompare(&KeyString
, &((SHELL_PARAM_PACKAGE
*)Node
)->Name
) == 0) {
2377 FreePool(TempString
);
2380 FreePool(TempString
);
2382 } else if (StringNoCaseCompare(&KeyString
, &((SHELL_PARAM_PACKAGE
*)Node
)->Name
) == 0) {
2390 Returns value from command line argument.
2392 Value parameters are in the form of "-<Key> value" or "/<Key> value".
2394 If CheckPackage is NULL, then return NULL.
2396 @param[in] CheckPackage The package of parsed command line arguments.
2397 @param[in] KeyString The Key of the command line argument to check for.
2399 @retval NULL The flag is not on the command line.
2400 @retval !=NULL The pointer to unicode string of the value.
2404 ShellCommandLineGetValue (
2405 IN CONST LIST_ENTRY
*CheckPackage
,
2406 IN CHAR16
*KeyString
2413 // return NULL for no package or KeyString is NULL
2415 if (CheckPackage
== NULL
|| KeyString
== NULL
) {
2420 // enumerate through the list of parametrs
2422 for ( Node
= GetFirstNode(CheckPackage
)
2423 ; !IsNull (CheckPackage
, Node
)
2424 ; Node
= GetNextNode(CheckPackage
, Node
)
2427 // If the Name matches, return TRUE (and there may be NULL name)
2429 if (((SHELL_PARAM_PACKAGE
*)Node
)->Name
!= NULL
) {
2431 // If Type is TypeStart then only compare the begining of the strings
2433 if (((SHELL_PARAM_PACKAGE
*)Node
)->Type
== TypeStart
) {
2434 if (StrnCmp(KeyString
, ((SHELL_PARAM_PACKAGE
*)Node
)->Name
, StrLen(KeyString
)) == 0) {
2435 return (((SHELL_PARAM_PACKAGE
*)Node
)->Name
+ StrLen(KeyString
));
2438 TempString
= StrnCatGrow(&TempString
, NULL
, KeyString
, StrLen(((SHELL_PARAM_PACKAGE
*)Node
)->Name
));
2439 if (TempString
!= NULL
) {
2440 if (StringNoCaseCompare(&KeyString
, &((SHELL_PARAM_PACKAGE
*)Node
)->Name
) == 0) {
2441 FreePool(TempString
);
2442 return (((SHELL_PARAM_PACKAGE
*)Node
)->Name
+ StrLen(KeyString
));
2444 FreePool(TempString
);
2446 } else if (StringNoCaseCompare(&KeyString
, &((SHELL_PARAM_PACKAGE
*)Node
)->Name
) == 0) {
2447 return (((SHELL_PARAM_PACKAGE
*)Node
)->Value
);
2455 Returns raw value from command line argument.
2457 Raw value parameters are in the form of "value" in a specific position in the list.
2459 If CheckPackage is NULL, then return NULL.
2461 @param[in] CheckPackage The package of parsed command line arguments.
2462 @param[in] Position The position of the value.
2464 @retval NULL The flag is not on the command line.
2465 @retval !=NULL The pointer to unicode string of the value.
2469 ShellCommandLineGetRawValue (
2470 IN CONST LIST_ENTRY
* CONST CheckPackage
,
2477 // check for CheckPackage == NULL
2479 if (CheckPackage
== NULL
) {
2484 // enumerate through the list of parametrs
2486 for ( Node
= GetFirstNode(CheckPackage
)
2487 ; !IsNull (CheckPackage
, Node
)
2488 ; Node
= GetNextNode(CheckPackage
, Node
)
2491 // If the position matches, return the value
2493 if (((SHELL_PARAM_PACKAGE
*)Node
)->OriginalPosition
== Position
) {
2494 return (((SHELL_PARAM_PACKAGE
*)Node
)->Value
);
2501 returns the number of command line value parameters that were parsed.
2503 this will not include flags.
2505 @param[in] CheckPackage The package of parsed command line arguments.
2507 @retval (UINTN)-1 No parsing has ocurred
2508 @return other The number of value parameters found
2512 ShellCommandLineGetCount(
2513 IN CONST LIST_ENTRY
*CheckPackage
2519 if (CheckPackage
== NULL
) {
2522 for ( Node1
= GetFirstNode(CheckPackage
), Count
= 0
2523 ; !IsNull (CheckPackage
, Node1
)
2524 ; Node1
= GetNextNode(CheckPackage
, Node1
)
2526 if (((SHELL_PARAM_PACKAGE
*)Node1
)->Name
== NULL
) {
2534 Determines if a parameter is duplicated.
2536 If Param is not NULL then it will point to a callee allocated string buffer
2537 with the parameter value if a duplicate is found.
2539 If CheckPackage is NULL, then ASSERT.
2541 @param[in] CheckPackage The package of parsed command line arguments.
2542 @param[out] Param Upon finding one, a pointer to the duplicated parameter.
2544 @retval EFI_SUCCESS No parameters were duplicated.
2545 @retval EFI_DEVICE_ERROR A duplicate was found.
2549 ShellCommandLineCheckDuplicate (
2550 IN CONST LIST_ENTRY
*CheckPackage
,
2557 ASSERT(CheckPackage
!= NULL
);
2559 for ( Node1
= GetFirstNode(CheckPackage
)
2560 ; !IsNull (CheckPackage
, Node1
)
2561 ; Node1
= GetNextNode(CheckPackage
, Node1
)
2563 for ( Node2
= GetNextNode(CheckPackage
, Node1
)
2564 ; !IsNull (CheckPackage
, Node2
)
2565 ; Node2
= GetNextNode(CheckPackage
, Node2
)
2567 if ((((SHELL_PARAM_PACKAGE
*)Node1
)->Name
!= NULL
) && (((SHELL_PARAM_PACKAGE
*)Node2
)->Name
!= NULL
) && StrCmp(((SHELL_PARAM_PACKAGE
*)Node1
)->Name
, ((SHELL_PARAM_PACKAGE
*)Node2
)->Name
) == 0) {
2568 if (Param
!= NULL
) {
2570 *Param
= StrnCatGrow(Param
, NULL
, ((SHELL_PARAM_PACKAGE
*)Node1
)->Name
, 0);
2572 return (EFI_DEVICE_ERROR
);
2576 return (EFI_SUCCESS
);
2580 This is a find and replace function. Upon successful return the NewString is a copy of
2581 SourceString with each instance of FindTarget replaced with ReplaceWith.
2583 If SourceString and NewString overlap the behavior is undefined.
2585 If the string would grow bigger than NewSize it will halt and return error.
2587 @param[in] SourceString The string with source buffer.
2588 @param[in, out] NewString The string with resultant buffer.
2589 @param[in] NewSize The size in bytes of NewString.
2590 @param[in] FindTarget The string to look for.
2591 @param[in] ReplaceWith The string to replace FindTarget with.
2592 @param[in] SkipPreCarrot If TRUE will skip a FindTarget that has a '^'
2593 immediately before it.
2594 @param[in] ParameterReplacing If TRUE will add "" around items with spaces.
2596 @retval EFI_INVALID_PARAMETER SourceString was NULL.
2597 @retval EFI_INVALID_PARAMETER NewString was NULL.
2598 @retval EFI_INVALID_PARAMETER FindTarget was NULL.
2599 @retval EFI_INVALID_PARAMETER ReplaceWith was NULL.
2600 @retval EFI_INVALID_PARAMETER FindTarget had length < 1.
2601 @retval EFI_INVALID_PARAMETER SourceString had length < 1.
2602 @retval EFI_BUFFER_TOO_SMALL NewSize was less than the minimum size to hold
2603 the new string (truncation occurred).
2604 @retval EFI_SUCCESS The string was successfully copied with replacement.
2608 ShellCopySearchAndReplace(
2609 IN CHAR16 CONST
*SourceString
,
2610 IN OUT CHAR16
*NewString
,
2612 IN CONST CHAR16
*FindTarget
,
2613 IN CONST CHAR16
*ReplaceWith
,
2614 IN CONST BOOLEAN SkipPreCarrot
,
2615 IN CONST BOOLEAN ParameterReplacing
2621 if ( (SourceString
== NULL
)
2622 || (NewString
== NULL
)
2623 || (FindTarget
== NULL
)
2624 || (ReplaceWith
== NULL
)
2625 || (StrLen(FindTarget
) < 1)
2626 || (StrLen(SourceString
) < 1)
2628 return (EFI_INVALID_PARAMETER
);
2631 if (StrStr(ReplaceWith
, L
" ") == NULL
|| !ParameterReplacing
) {
2632 Replace
= StrnCatGrow(&Replace
, NULL
, ReplaceWith
, 0);
2634 Replace
= AllocateZeroPool(StrSize(ReplaceWith
) + 2*sizeof(CHAR16
));
2635 if (Replace
!= NULL
) {
2636 UnicodeSPrint(Replace
, StrSize(ReplaceWith
) + 2*sizeof(CHAR16
), L
"\"%s\"", ReplaceWith
);
2639 if (Replace
== NULL
) {
2640 return (EFI_OUT_OF_RESOURCES
);
2642 NewString
= ZeroMem(NewString
, NewSize
);
2643 while (*SourceString
!= CHAR_NULL
) {
2645 // if we find the FindTarget and either Skip == FALSE or Skip and we
2646 // dont have a carrot do a replace...
2648 if (StrnCmp(SourceString
, FindTarget
, StrLen(FindTarget
)) == 0
2649 && ((SkipPreCarrot
&& *(SourceString
-1) != L
'^') || !SkipPreCarrot
)
2651 SourceString
+= StrLen(FindTarget
);
2652 Size
= StrSize(NewString
);
2653 if ((Size
+ (StrLen(Replace
)*sizeof(CHAR16
))) > NewSize
) {
2655 return (EFI_BUFFER_TOO_SMALL
);
2657 StrCatS(NewString
, NewSize
/sizeof(CHAR16
), Replace
);
2659 Size
= StrSize(NewString
);
2660 if (Size
+ sizeof(CHAR16
) > NewSize
) {
2662 return (EFI_BUFFER_TOO_SMALL
);
2664 StrnCatS(NewString
, NewSize
/sizeof(CHAR16
), SourceString
, 1);
2669 return (EFI_SUCCESS
);
2673 Internal worker function to output a string.
2675 This function will output a string to the correct StdOut.
2677 @param[in] String The string to print out.
2679 @retval EFI_SUCCESS The operation was sucessful.
2680 @retval !EFI_SUCCESS The operation failed.
2685 IN CONST CHAR16
*String
2689 Size
= StrSize(String
) - sizeof(CHAR16
);
2691 return (EFI_SUCCESS
);
2693 if (gEfiShellParametersProtocol
!= NULL
) {
2694 return (gEfiShellProtocol
->WriteFile(gEfiShellParametersProtocol
->StdOut
, &Size
, (VOID
*)String
));
2696 if (mEfiShellInterface
!= NULL
) {
2697 if (mEfiShellInterface
->RedirArgc
== 0) {
2699 // Divide in half for old shell. Must be string length not size.
2701 Size
/=2; // Divide in half only when no redirection.
2703 return (mEfiShellInterface
->StdOut
->Write(mEfiShellInterface
->StdOut
, &Size
, (VOID
*)String
));
2706 return (EFI_UNSUPPORTED
);
2710 Print at a specific location on the screen.
2712 This function will move the cursor to a given screen location and print the specified string
2714 If -1 is specified for either the Row or Col the current screen location for BOTH
2717 if either Row or Col is out of range for the current console, then ASSERT
2718 if Format is NULL, then ASSERT
2720 In addition to the standard %-based flags as supported by UefiLib Print() this supports
2721 the following additional flags:
2722 %N - Set output attribute to normal
2723 %H - Set output attribute to highlight
2724 %E - Set output attribute to error
2725 %B - Set output attribute to blue color
2726 %V - Set output attribute to green color
2728 Note: The background color is controlled by the shell command cls.
2730 @param[in] Col the column to print at
2731 @param[in] Row the row to print at
2732 @param[in] Format the format string
2733 @param[in] Marker the marker for the variable argument list
2735 @return EFI_SUCCESS The operation was successful.
2736 @return EFI_DEVICE_ERROR The console device reported an error.
2740 InternalShellPrintWorker(
2741 IN INT32 Col OPTIONAL
,
2742 IN INT32 Row OPTIONAL
,
2743 IN CONST CHAR16
*Format
,
2748 CHAR16
*ResumeLocation
;
2749 CHAR16
*FormatWalker
;
2750 UINTN OriginalAttribute
;
2751 CHAR16
*mPostReplaceFormat
;
2752 CHAR16
*mPostReplaceFormat2
;
2754 mPostReplaceFormat
= AllocateZeroPool (PcdGet16 (PcdShellPrintBufferSize
));
2755 mPostReplaceFormat2
= AllocateZeroPool (PcdGet16 (PcdShellPrintBufferSize
));
2757 if (mPostReplaceFormat
== NULL
|| mPostReplaceFormat2
== NULL
) {
2758 SHELL_FREE_NON_NULL(mPostReplaceFormat
);
2759 SHELL_FREE_NON_NULL(mPostReplaceFormat2
);
2760 return (EFI_OUT_OF_RESOURCES
);
2763 Status
= EFI_SUCCESS
;
2764 OriginalAttribute
= gST
->ConOut
->Mode
->Attribute
;
2767 // Back and forth each time fixing up 1 of our flags...
2769 Status
= ShellCopySearchAndReplace(Format
, mPostReplaceFormat
, PcdGet16 (PcdShellPrintBufferSize
), L
"%N", L
"%%N", FALSE
, FALSE
);
2770 ASSERT_EFI_ERROR(Status
);
2771 Status
= ShellCopySearchAndReplace(mPostReplaceFormat
, mPostReplaceFormat2
, PcdGet16 (PcdShellPrintBufferSize
), L
"%E", L
"%%E", FALSE
, FALSE
);
2772 ASSERT_EFI_ERROR(Status
);
2773 Status
= ShellCopySearchAndReplace(mPostReplaceFormat2
, mPostReplaceFormat
, PcdGet16 (PcdShellPrintBufferSize
), L
"%H", L
"%%H", FALSE
, FALSE
);
2774 ASSERT_EFI_ERROR(Status
);
2775 Status
= ShellCopySearchAndReplace(mPostReplaceFormat
, mPostReplaceFormat2
, PcdGet16 (PcdShellPrintBufferSize
), L
"%B", L
"%%B", FALSE
, FALSE
);
2776 ASSERT_EFI_ERROR(Status
);
2777 Status
= ShellCopySearchAndReplace(mPostReplaceFormat2
, mPostReplaceFormat
, PcdGet16 (PcdShellPrintBufferSize
), L
"%V", L
"%%V", FALSE
, FALSE
);
2778 ASSERT_EFI_ERROR(Status
);
2781 // Use the last buffer from replacing to print from...
2783 UnicodeVSPrint (mPostReplaceFormat2
, PcdGet16 (PcdShellPrintBufferSize
), mPostReplaceFormat
, Marker
);
2785 if (Col
!= -1 && Row
!= -1) {
2786 Status
= gST
->ConOut
->SetCursorPosition(gST
->ConOut
, Col
, Row
);
2789 FormatWalker
= mPostReplaceFormat2
;
2790 while (*FormatWalker
!= CHAR_NULL
) {
2792 // Find the next attribute change request
2794 ResumeLocation
= StrStr(FormatWalker
, L
"%");
2795 if (ResumeLocation
!= NULL
) {
2796 *ResumeLocation
= CHAR_NULL
;
2799 // print the current FormatWalker string
2801 if (StrLen(FormatWalker
)>0) {
2802 Status
= InternalPrintTo(FormatWalker
);
2803 if (EFI_ERROR(Status
)) {
2809 // update the attribute
2811 if (ResumeLocation
!= NULL
) {
2812 if (*(ResumeLocation
-1) == L
'^') {
2814 // Move cursor back 1 position to overwrite the ^
2816 gST
->ConOut
->SetCursorPosition(gST
->ConOut
, gST
->ConOut
->Mode
->CursorColumn
- 1, gST
->ConOut
->Mode
->CursorRow
);
2819 // Print a simple '%' symbol
2821 Status
= InternalPrintTo(L
"%");
2822 ResumeLocation
= ResumeLocation
- 1;
2824 switch (*(ResumeLocation
+1)) {
2826 gST
->ConOut
->SetAttribute(gST
->ConOut
, OriginalAttribute
);
2829 gST
->ConOut
->SetAttribute(gST
->ConOut
, EFI_TEXT_ATTR(EFI_YELLOW
, ((OriginalAttribute
&(BIT4
|BIT5
|BIT6
))>>4)));
2832 gST
->ConOut
->SetAttribute(gST
->ConOut
, EFI_TEXT_ATTR(EFI_WHITE
, ((OriginalAttribute
&(BIT4
|BIT5
|BIT6
))>>4)));
2835 gST
->ConOut
->SetAttribute(gST
->ConOut
, EFI_TEXT_ATTR(EFI_BLUE
, ((OriginalAttribute
&(BIT4
|BIT5
|BIT6
))>>4)));
2838 gST
->ConOut
->SetAttribute(gST
->ConOut
, EFI_TEXT_ATTR(EFI_GREEN
, ((OriginalAttribute
&(BIT4
|BIT5
|BIT6
))>>4)));
2842 // Print a simple '%' symbol
2844 Status
= InternalPrintTo(L
"%");
2845 if (EFI_ERROR(Status
)) {
2848 ResumeLocation
= ResumeLocation
- 1;
2854 // reset to normal now...
2860 // update FormatWalker to Resume + 2 (skip the % and the indicator)
2862 FormatWalker
= ResumeLocation
+ 2;
2865 gST
->ConOut
->SetAttribute(gST
->ConOut
, OriginalAttribute
);
2867 SHELL_FREE_NON_NULL(mPostReplaceFormat
);
2868 SHELL_FREE_NON_NULL(mPostReplaceFormat2
);
2873 Print at a specific location on the screen.
2875 This function will move the cursor to a given screen location and print the specified string.
2877 If -1 is specified for either the Row or Col the current screen location for BOTH
2880 If either Row or Col is out of range for the current console, then ASSERT.
2881 If Format is NULL, then ASSERT.
2883 In addition to the standard %-based flags as supported by UefiLib Print() this supports
2884 the following additional flags:
2885 %N - Set output attribute to normal
2886 %H - Set output attribute to highlight
2887 %E - Set output attribute to error
2888 %B - Set output attribute to blue color
2889 %V - Set output attribute to green color
2891 Note: The background color is controlled by the shell command cls.
2893 @param[in] Col the column to print at
2894 @param[in] Row the row to print at
2895 @param[in] Format the format string
2896 @param[in] ... The variable argument list.
2898 @return EFI_SUCCESS The printing was successful.
2899 @return EFI_DEVICE_ERROR The console device reported an error.
2904 IN INT32 Col OPTIONAL
,
2905 IN INT32 Row OPTIONAL
,
2906 IN CONST CHAR16
*Format
,
2912 if (Format
== NULL
) {
2913 return (EFI_INVALID_PARAMETER
);
2915 VA_START (Marker
, Format
);
2916 RetVal
= InternalShellPrintWorker(Col
, Row
, Format
, Marker
);
2922 Print at a specific location on the screen.
2924 This function will move the cursor to a given screen location and print the specified string.
2926 If -1 is specified for either the Row or Col the current screen location for BOTH
2929 If either Row or Col is out of range for the current console, then ASSERT.
2930 If Format is NULL, then ASSERT.
2932 In addition to the standard %-based flags as supported by UefiLib Print() this supports
2933 the following additional flags:
2934 %N - Set output attribute to normal.
2935 %H - Set output attribute to highlight.
2936 %E - Set output attribute to error.
2937 %B - Set output attribute to blue color.
2938 %V - Set output attribute to green color.
2940 Note: The background color is controlled by the shell command cls.
2942 @param[in] Col The column to print at.
2943 @param[in] Row The row to print at.
2944 @param[in] Language The language of the string to retrieve. If this parameter
2945 is NULL, then the current platform language is used.
2946 @param[in] HiiFormatStringId The format string Id for getting from Hii.
2947 @param[in] HiiFormatHandle The format string Handle for getting from Hii.
2948 @param[in] ... The variable argument list.
2950 @return EFI_SUCCESS The printing was successful.
2951 @return EFI_DEVICE_ERROR The console device reported an error.
2956 IN INT32 Col OPTIONAL
,
2957 IN INT32 Row OPTIONAL
,
2958 IN CONST CHAR8
*Language OPTIONAL
,
2959 IN CONST EFI_STRING_ID HiiFormatStringId
,
2960 IN CONST EFI_HANDLE HiiFormatHandle
,
2965 CHAR16
*HiiFormatString
;
2968 VA_START (Marker
, HiiFormatHandle
);
2969 HiiFormatString
= HiiGetString(HiiFormatHandle
, HiiFormatStringId
, Language
);
2970 ASSERT(HiiFormatString
!= NULL
);
2972 RetVal
= InternalShellPrintWorker(Col
, Row
, HiiFormatString
, Marker
);
2974 SHELL_FREE_NON_NULL(HiiFormatString
);
2981 Function to determine if a given filename represents a file or a directory.
2983 @param[in] DirName Path to directory to test.
2985 @retval EFI_SUCCESS The Path represents a directory
2986 @retval EFI_NOT_FOUND The Path does not represent a directory
2987 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
2988 @return The path failed to open
2993 IN CONST CHAR16
*DirName
2997 SHELL_FILE_HANDLE Handle
;
2998 CHAR16
*TempLocation
;
2999 CHAR16
*TempLocation2
;
3001 ASSERT(DirName
!= NULL
);
3004 TempLocation
= NULL
;
3006 Status
= ShellOpenFileByName(DirName
, &Handle
, EFI_FILE_MODE_READ
, 0);
3007 if (EFI_ERROR(Status
)) {
3009 // try good logic first.
3011 if (gEfiShellProtocol
!= NULL
) {
3012 TempLocation
= StrnCatGrow(&TempLocation
, NULL
, DirName
, 0);
3013 if (TempLocation
== NULL
) {
3014 ShellCloseFile(&Handle
);
3015 return (EFI_OUT_OF_RESOURCES
);
3017 TempLocation2
= StrStr(TempLocation
, L
":");
3018 if (TempLocation2
!= NULL
&& StrLen(StrStr(TempLocation
, L
":")) == 2) {
3019 *(TempLocation2
+1) = CHAR_NULL
;
3021 if (gEfiShellProtocol
->GetDevicePathFromMap(TempLocation
) != NULL
) {
3022 FreePool(TempLocation
);
3023 return (EFI_SUCCESS
);
3025 FreePool(TempLocation
);
3028 // probably a map name?!?!!?
3030 TempLocation
= StrStr(DirName
, L
"\\");
3031 if (TempLocation
!= NULL
&& *(TempLocation
+1) == CHAR_NULL
) {
3032 return (EFI_SUCCESS
);
3038 if (FileHandleIsDirectory(Handle
) == EFI_SUCCESS
) {
3039 ShellCloseFile(&Handle
);
3040 return (EFI_SUCCESS
);
3042 ShellCloseFile(&Handle
);
3043 return (EFI_NOT_FOUND
);
3047 Function to determine if a given filename represents a file.
3049 @param[in] Name Path to file to test.
3051 @retval EFI_SUCCESS The Path represents a file.
3052 @retval EFI_NOT_FOUND The Path does not represent a file.
3053 @retval other The path failed to open.
3058 IN CONST CHAR16
*Name
3062 SHELL_FILE_HANDLE Handle
;
3064 ASSERT(Name
!= NULL
);
3068 Status
= ShellOpenFileByName(Name
, &Handle
, EFI_FILE_MODE_READ
, 0);
3069 if (EFI_ERROR(Status
)) {
3073 if (FileHandleIsDirectory(Handle
) != EFI_SUCCESS
) {
3074 ShellCloseFile(&Handle
);
3075 return (EFI_SUCCESS
);
3077 ShellCloseFile(&Handle
);
3078 return (EFI_NOT_FOUND
);
3082 Function to determine if a given filename represents a file.
3084 This will search the CWD and then the Path.
3086 If Name is NULL, then ASSERT.
3088 @param[in] Name Path to file to test.
3090 @retval EFI_SUCCESS The Path represents a file.
3091 @retval EFI_NOT_FOUND The Path does not represent a file.
3092 @retval other The path failed to open.
3097 IN CONST CHAR16
*Name
3103 if (!EFI_ERROR(ShellIsFile(Name
))) {
3104 return (EFI_SUCCESS
);
3107 NewName
= ShellFindFilePath(Name
);
3108 if (NewName
== NULL
) {
3109 return (EFI_NOT_FOUND
);
3111 Status
= ShellIsFile(NewName
);
3117 Function return the number converted from a hex representation of a number.
3119 Note: this function cannot be used when (UINTN)(-1), (0xFFFFFFFF) may be a valid
3120 result. Use ShellConvertStringToUint64 instead.
3122 @param[in] String String representation of a number.
3124 @return The unsigned integer result of the conversion.
3125 @retval (UINTN)(-1) An error occured.
3130 IN CONST CHAR16
*String
3135 if (!EFI_ERROR(ShellConvertStringToUint64(String
, &RetVal
, TRUE
, TRUE
))) {
3136 return ((UINTN
)RetVal
);
3139 return ((UINTN
)(-1));
3143 Function to determine whether a string is decimal or hex representation of a number
3144 and return the number converted from the string. Spaces are always skipped.
3146 @param[in] String String representation of a number
3149 @retval (UINTN)(-1) An error ocurred.
3154 IN CONST CHAR16
*String
3162 if (!InternalShellIsHexOrDecimalNumber(String
, Hex
, TRUE
, FALSE
)) {
3166 if (!EFI_ERROR(ShellConvertStringToUint64(String
, &RetVal
, Hex
, TRUE
))) {
3167 return ((UINTN
)RetVal
);
3169 return ((UINTN
)(-1));
3173 Safely append with automatic string resizing given length of Destination and
3174 desired length of copy from Source.
3176 append the first D characters of Source to the end of Destination, where D is
3177 the lesser of Count and the StrLen() of Source. If appending those D characters
3178 will fit within Destination (whose Size is given as CurrentSize) and
3179 still leave room for a NULL terminator, then those characters are appended,
3180 starting at the original terminating NULL of Destination, and a new terminating
3183 If appending D characters onto Destination will result in a overflow of the size
3184 given in CurrentSize the string will be grown such that the copy can be performed
3185 and CurrentSize will be updated to the new size.
3187 If Source is NULL, there is nothing to append, just return the current buffer in
3190 if Destination is NULL, then ASSERT()
3191 if Destination's current length (including NULL terminator) is already more then
3192 CurrentSize, then ASSERT()
3194 @param[in, out] Destination The String to append onto
3195 @param[in, out] CurrentSize on call the number of bytes in Destination. On
3196 return possibly the new size (still in bytes). if NULL
3197 then allocate whatever is needed.
3198 @param[in] Source The String to append from
3199 @param[in] Count Maximum number of characters to append. if 0 then
3202 @return Destination return the resultant string.
3207 IN OUT CHAR16
**Destination
,
3208 IN OUT UINTN
*CurrentSize
,
3209 IN CONST CHAR16
*Source
,
3213 UINTN DestinationStartSize
;
3219 ASSERT(Destination
!= NULL
);
3222 // If there's nothing to do then just return Destination
3224 if (Source
== NULL
) {
3225 return (*Destination
);
3229 // allow for un-initialized pointers, based on size being 0
3231 if (CurrentSize
!= NULL
&& *CurrentSize
== 0) {
3232 *Destination
= NULL
;
3236 // allow for NULL pointers address as Destination
3238 if (*Destination
!= NULL
) {
3239 ASSERT(CurrentSize
!= 0);
3240 DestinationStartSize
= StrSize(*Destination
);
3241 ASSERT(DestinationStartSize
<= *CurrentSize
);
3243 DestinationStartSize
= 0;
3244 // ASSERT(*CurrentSize == 0);
3248 // Append all of Source?
3251 Count
= StrLen(Source
);
3255 // Test and grow if required
3257 if (CurrentSize
!= NULL
) {
3258 NewSize
= *CurrentSize
;
3259 if (NewSize
< DestinationStartSize
+ (Count
* sizeof(CHAR16
))) {
3260 while (NewSize
< (DestinationStartSize
+ (Count
*sizeof(CHAR16
)))) {
3261 NewSize
+= 2 * Count
* sizeof(CHAR16
);
3263 *Destination
= ReallocatePool(*CurrentSize
, NewSize
, *Destination
);
3264 *CurrentSize
= NewSize
;
3267 NewSize
= (Count
+1)*sizeof(CHAR16
);
3268 *Destination
= AllocateZeroPool(NewSize
);
3272 // Now use standard StrnCat on a big enough buffer
3274 if (*Destination
== NULL
) {
3278 StrnCatS(*Destination
, NewSize
/sizeof(CHAR16
), Source
, Count
);
3279 return *Destination
;
3283 Prompt the user and return the resultant answer to the requestor.
3285 This function will display the requested question on the shell prompt and then
3286 wait for an apropriate answer to be input from the console.
3288 if the SHELL_PROMPT_REQUEST_TYPE is SHELL_PROMPT_REQUEST_TYPE_YESNO, ShellPromptResponseTypeQuitContinue
3289 or SHELL_PROMPT_REQUEST_TYPE_YESNOCANCEL then *Response is of type SHELL_PROMPT_RESPONSE.
3291 if the SHELL_PROMPT_REQUEST_TYPE is ShellPromptResponseTypeFreeform then *Response is of type
3294 In either case *Response must be callee freed if Response was not NULL;
3296 @param Type What type of question is asked. This is used to filter the input
3297 to prevent invalid answers to question.
3298 @param Prompt Pointer to string prompt to use to request input.
3299 @param Response Pointer to Response which will be populated upon return.
3301 @retval EFI_SUCCESS The operation was sucessful.
3302 @retval EFI_UNSUPPORTED The operation is not supported as requested.
3303 @retval EFI_INVALID_PARAMETER A parameter was invalid.
3304 @return other The operation failed.
3308 ShellPromptForResponse (
3309 IN SHELL_PROMPT_REQUEST_TYPE Type
,
3310 IN CHAR16
*Prompt OPTIONAL
,
3311 IN OUT VOID
**Response OPTIONAL
3317 SHELL_PROMPT_RESPONSE
*Resp
;
3321 Status
= EFI_UNSUPPORTED
;
3325 if (Type
!= ShellPromptResponseTypeFreeform
) {
3326 Resp
= (SHELL_PROMPT_RESPONSE
*)AllocateZeroPool(sizeof(SHELL_PROMPT_RESPONSE
));
3328 return (EFI_OUT_OF_RESOURCES
);
3333 case ShellPromptResponseTypeQuitContinue
:
3334 if (Prompt
!= NULL
) {
3335 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3338 // wait for valid response
3340 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3341 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3342 if (EFI_ERROR(Status
)) {
3345 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3346 if (Key
.UnicodeChar
== L
'Q' || Key
.UnicodeChar
==L
'q') {
3347 *Resp
= ShellPromptResponseQuit
;
3349 *Resp
= ShellPromptResponseContinue
;
3352 case ShellPromptResponseTypeYesNoCancel
:
3353 if (Prompt
!= NULL
) {
3354 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3357 // wait for valid response
3359 *Resp
= ShellPromptResponseMax
;
3360 while (*Resp
== ShellPromptResponseMax
) {
3361 if (ShellGetExecutionBreakFlag()) {
3362 Status
= EFI_ABORTED
;
3365 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3366 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3367 if (EFI_ERROR(Status
)) {
3370 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3371 switch (Key
.UnicodeChar
) {
3374 *Resp
= ShellPromptResponseYes
;
3378 *Resp
= ShellPromptResponseNo
;
3382 *Resp
= ShellPromptResponseCancel
;
3386 break; case ShellPromptResponseTypeYesNoAllCancel
:
3387 if (Prompt
!= NULL
) {
3388 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3391 // wait for valid response
3393 *Resp
= ShellPromptResponseMax
;
3394 while (*Resp
== ShellPromptResponseMax
) {
3395 if (ShellGetExecutionBreakFlag()) {
3396 Status
= EFI_ABORTED
;
3399 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3400 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3401 if (EFI_ERROR(Status
)) {
3404 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3405 switch (Key
.UnicodeChar
) {
3408 *Resp
= ShellPromptResponseYes
;
3412 *Resp
= ShellPromptResponseNo
;
3416 *Resp
= ShellPromptResponseAll
;
3420 *Resp
= ShellPromptResponseCancel
;
3425 case ShellPromptResponseTypeEnterContinue
:
3426 case ShellPromptResponseTypeAnyKeyContinue
:
3427 if (Prompt
!= NULL
) {
3428 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3431 // wait for valid response
3433 *Resp
= ShellPromptResponseMax
;
3434 while (*Resp
== ShellPromptResponseMax
) {
3435 if (ShellGetExecutionBreakFlag()) {
3436 Status
= EFI_ABORTED
;
3439 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3440 if (Type
== ShellPromptResponseTypeEnterContinue
) {
3441 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3442 if (EFI_ERROR(Status
)) {
3445 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3446 if (Key
.UnicodeChar
== CHAR_CARRIAGE_RETURN
) {
3447 *Resp
= ShellPromptResponseContinue
;
3451 if (Type
== ShellPromptResponseTypeAnyKeyContinue
) {
3452 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3453 ASSERT_EFI_ERROR(Status
);
3454 *Resp
= ShellPromptResponseContinue
;
3459 case ShellPromptResponseTypeYesNo
:
3460 if (Prompt
!= NULL
) {
3461 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3464 // wait for valid response
3466 *Resp
= ShellPromptResponseMax
;
3467 while (*Resp
== ShellPromptResponseMax
) {
3468 if (ShellGetExecutionBreakFlag()) {
3469 Status
= EFI_ABORTED
;
3472 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3473 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3474 if (EFI_ERROR(Status
)) {
3477 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3478 switch (Key
.UnicodeChar
) {
3481 *Resp
= ShellPromptResponseYes
;
3485 *Resp
= ShellPromptResponseNo
;
3490 case ShellPromptResponseTypeFreeform
:
3491 if (Prompt
!= NULL
) {
3492 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3495 if (ShellGetExecutionBreakFlag()) {
3496 Status
= EFI_ABORTED
;
3499 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3500 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3501 if (EFI_ERROR(Status
)) {
3504 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3505 if (Key
.UnicodeChar
== CHAR_CARRIAGE_RETURN
) {
3508 ASSERT((Buffer
== NULL
&& Size
== 0) || (Buffer
!= NULL
));
3509 StrnCatGrow(&Buffer
, &Size
, &Key
.UnicodeChar
, 1);
3513 // This is the location to add new prompt types.
3514 // If your new type loops remember to add ExecutionBreak support.
3520 if (Response
!= NULL
) {
3523 } else if (Buffer
!= NULL
) {
3530 if (Buffer
!= NULL
) {
3535 ShellPrintEx(-1, -1, L
"\r\n");
3540 Prompt the user and return the resultant answer to the requestor.
3542 This function is the same as ShellPromptForResponse, except that the prompt is
3543 automatically pulled from HII.
3545 @param Type What type of question is asked. This is used to filter the input
3546 to prevent invalid answers to question.
3547 @param[in] HiiFormatStringId The format string Id for getting from Hii.
3548 @param[in] HiiFormatHandle The format string Handle for getting from Hii.
3549 @param Response Pointer to Response which will be populated upon return.
3551 @retval EFI_SUCCESS the operation was sucessful.
3552 @return other the operation failed.
3554 @sa ShellPromptForResponse
3558 ShellPromptForResponseHii (
3559 IN SHELL_PROMPT_REQUEST_TYPE Type
,
3560 IN CONST EFI_STRING_ID HiiFormatStringId
,
3561 IN CONST EFI_HANDLE HiiFormatHandle
,
3562 IN OUT VOID
**Response
3568 Prompt
= HiiGetString(HiiFormatHandle
, HiiFormatStringId
, NULL
);
3569 Status
= ShellPromptForResponse(Type
, Prompt
, Response
);
3575 Function to determin if an entire string is a valid number.
3577 If Hex it must be preceeded with a 0x or has ForceHex, set TRUE.
3579 @param[in] String The string to evaluate.
3580 @param[in] ForceHex TRUE - always assume hex.
3581 @param[in] StopAtSpace TRUE to halt upon finding a space, FALSE to keep going.
3582 @param[in] TimeNumbers TRUE to allow numbers with ":", FALSE otherwise.
3584 @retval TRUE It is all numeric (dec/hex) characters.
3585 @retval FALSE There is a non-numeric character.
3589 InternalShellIsHexOrDecimalNumber (
3590 IN CONST CHAR16
*String
,
3591 IN CONST BOOLEAN ForceHex
,
3592 IN CONST BOOLEAN StopAtSpace
,
3593 IN CONST BOOLEAN TimeNumbers
3599 // chop off a single negative sign
3601 if (String
!= NULL
&& *String
== L
'-') {
3605 if (String
== NULL
) {
3610 // chop leading zeroes
3612 while(String
!= NULL
&& *String
== L
'0'){
3616 // allow '0x' or '0X', but not 'x' or 'X'
3618 if (String
!= NULL
&& (*String
== L
'x' || *String
== L
'X')) {
3619 if (*(String
-1) != L
'0') {
3621 // we got an x without a preceeding 0
3627 } else if (ForceHex
) {
3634 // loop through the remaining characters and use the lib function
3636 for ( ; String
!= NULL
&& *String
!= CHAR_NULL
&& !(StopAtSpace
&& *String
== L
' ') ; String
++){
3637 if (TimeNumbers
&& (String
[0] == L
':')) {
3641 if (!ShellIsHexaDecimalDigitCharacter(*String
)) {
3645 if (!ShellIsDecimalDigitCharacter(*String
)) {
3655 Function to determine if a given filename exists.
3657 @param[in] Name Path to test.
3659 @retval EFI_SUCCESS The Path represents a file.
3660 @retval EFI_NOT_FOUND The Path does not represent a file.
3661 @retval other The path failed to open.
3666 IN CONST CHAR16
*Name
3670 EFI_SHELL_FILE_INFO
*List
;
3672 ASSERT(Name
!= NULL
);
3675 Status
= ShellOpenFileMetaArg((CHAR16
*)Name
, EFI_FILE_MODE_READ
, &List
);
3676 if (EFI_ERROR(Status
)) {
3680 ShellCloseFileMetaArg(&List
);
3682 return (EFI_SUCCESS
);
3686 Convert a Unicode character to upper case only if
3687 it maps to a valid small-case ASCII character.
3689 This internal function only deal with Unicode character
3690 which maps to a valid small-case ASCII character, i.e.
3691 L'a' to L'z'. For other Unicode character, the input character
3692 is returned directly.
3694 @param Char The character to convert.
3696 @retval LowerCharacter If the Char is with range L'a' to L'z'.
3697 @retval Unchanged Otherwise.
3702 InternalShellCharToUpper (
3706 if (Char
>= L
'a' && Char
<= L
'z') {
3707 return (CHAR16
) (Char
- (L
'a' - L
'A'));
3714 Convert a Unicode character to numerical value.
3716 This internal function only deal with Unicode character
3717 which maps to a valid hexadecimal ASII character, i.e.
3718 L'0' to L'9', L'a' to L'f' or L'A' to L'F'. For other
3719 Unicode character, the value returned does not make sense.
3721 @param Char The character to convert.
3723 @return The numerical value converted.
3728 InternalShellHexCharToUintn (
3732 if (ShellIsDecimalDigitCharacter (Char
)) {
3736 return (UINTN
) (10 + InternalShellCharToUpper (Char
) - L
'A');
3740 Convert a Null-terminated Unicode hexadecimal string to a value of type UINT64.
3742 This function returns a value of type UINT64 by interpreting the contents
3743 of the Unicode string specified by String as a hexadecimal number.
3744 The format of the input Unicode string String is:
3746 [spaces][zeros][x][hexadecimal digits].
3748 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
3749 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix.
3750 If "x" appears in the input string, it must be prefixed with at least one 0.
3751 The function will ignore the pad space, which includes spaces or tab characters,
3752 before [zeros], [x] or [hexadecimal digit]. The running zero before [x] or
3753 [hexadecimal digit] will be ignored. Then, the decoding starts after [x] or the
3754 first valid hexadecimal digit. Then, the function stops at the first character that is
3755 a not a valid hexadecimal character or NULL, whichever one comes first.
3757 If String has only pad spaces, then zero is returned.
3758 If String has no leading pad spaces, leading zeros or valid hexadecimal digits,
3759 then zero is returned.
3761 @param[in] String A pointer to a Null-terminated Unicode string.
3762 @param[out] Value Upon a successful return the value of the conversion.
3763 @param[in] StopAtSpace FALSE to skip spaces.
3765 @retval EFI_SUCCESS The conversion was successful.
3766 @retval EFI_INVALID_PARAMETER A parameter was NULL or invalid.
3767 @retval EFI_DEVICE_ERROR An overflow occured.
3771 InternalShellStrHexToUint64 (
3772 IN CONST CHAR16
*String
,
3774 IN CONST BOOLEAN StopAtSpace
3779 if (String
== NULL
|| StrSize(String
) == 0 || Value
== NULL
) {
3780 return (EFI_INVALID_PARAMETER
);
3784 // Ignore the pad spaces (space or tab)
3786 while ((*String
== L
' ') || (*String
== L
'\t')) {
3791 // Ignore leading Zeros after the spaces
3793 while (*String
== L
'0') {
3797 if (InternalShellCharToUpper (*String
) == L
'X') {
3798 if (*(String
- 1) != L
'0') {
3810 // there is a space where there should't be
3812 if (*String
== L
' ') {
3813 return (EFI_INVALID_PARAMETER
);
3816 while (ShellIsHexaDecimalDigitCharacter (*String
)) {
3818 // If the Hex Number represented by String overflows according
3819 // to the range defined by UINT64, then return EFI_DEVICE_ERROR.
3821 if (!(Result
<= (RShiftU64((((UINT64
) ~0) - InternalShellHexCharToUintn (*String
)), 4)))) {
3822 // if (!(Result <= ((((UINT64) ~0) - InternalShellHexCharToUintn (*String)) >> 4))) {
3823 return (EFI_DEVICE_ERROR
);
3826 Result
= (LShiftU64(Result
, 4));
3827 Result
+= InternalShellHexCharToUintn (*String
);
3831 // stop at spaces if requested
3833 if (StopAtSpace
&& *String
== L
' ') {
3839 return (EFI_SUCCESS
);
3843 Convert a Null-terminated Unicode decimal string to a value of
3846 This function returns a value of type UINT64 by interpreting the contents
3847 of the Unicode string specified by String as a decimal number. The format
3848 of the input Unicode string String is:
3850 [spaces] [decimal digits].
3852 The valid decimal digit character is in the range [0-9]. The
3853 function will ignore the pad space, which includes spaces or
3854 tab characters, before [decimal digits]. The running zero in the
3855 beginning of [decimal digits] will be ignored. Then, the function
3856 stops at the first character that is a not a valid decimal character
3857 or a Null-terminator, whichever one comes first.
3859 If String has only pad spaces, then 0 is returned.
3860 If String has no pad spaces or valid decimal digits,
3863 @param[in] String A pointer to a Null-terminated Unicode string.
3864 @param[out] Value Upon a successful return the value of the conversion.
3865 @param[in] StopAtSpace FALSE to skip spaces.
3867 @retval EFI_SUCCESS The conversion was successful.
3868 @retval EFI_INVALID_PARAMETER A parameter was NULL or invalid.
3869 @retval EFI_DEVICE_ERROR An overflow occured.
3873 InternalShellStrDecimalToUint64 (
3874 IN CONST CHAR16
*String
,
3876 IN CONST BOOLEAN StopAtSpace
3881 if (String
== NULL
|| StrSize (String
) == 0 || Value
== NULL
) {
3882 return (EFI_INVALID_PARAMETER
);
3886 // Ignore the pad spaces (space or tab)
3888 while ((*String
== L
' ') || (*String
== L
'\t')) {
3893 // Ignore leading Zeros after the spaces
3895 while (*String
== L
'0') {
3902 // Stop upon space if requested
3903 // (if the whole value was 0)
3905 if (StopAtSpace
&& *String
== L
' ') {
3907 return (EFI_SUCCESS
);
3910 while (ShellIsDecimalDigitCharacter (*String
)) {
3912 // If the number represented by String overflows according
3913 // to the range defined by UINT64, then return EFI_DEVICE_ERROR.
3916 if (!(Result
<= (DivU64x32((((UINT64
) ~0) - (*String
- L
'0')),10)))) {
3917 return (EFI_DEVICE_ERROR
);
3920 Result
= MultU64x32(Result
, 10) + (*String
- L
'0');
3924 // Stop at spaces if requested
3926 if (StopAtSpace
&& *String
== L
' ') {
3933 return (EFI_SUCCESS
);
3937 Function to verify and convert a string to its numerical value.
3939 If Hex it must be preceeded with a 0x, 0X, or has ForceHex set TRUE.
3941 @param[in] String The string to evaluate.
3942 @param[out] Value Upon a successful return the value of the conversion.
3943 @param[in] ForceHex TRUE - always assume hex.
3944 @param[in] StopAtSpace FALSE to skip spaces.
3946 @retval EFI_SUCCESS The conversion was successful.
3947 @retval EFI_INVALID_PARAMETER String contained an invalid character.
3948 @retval EFI_NOT_FOUND String was a number, but Value was NULL.
3952 ShellConvertStringToUint64(
3953 IN CONST CHAR16
*String
,
3955 IN CONST BOOLEAN ForceHex
,
3956 IN CONST BOOLEAN StopAtSpace
3960 CONST CHAR16
*Walker
;
3966 if (!InternalShellIsHexOrDecimalNumber(String
, Hex
, StopAtSpace
, FALSE
)) {
3969 if (!InternalShellIsHexOrDecimalNumber(String
, Hex
, StopAtSpace
, FALSE
)) {
3970 return (EFI_INVALID_PARAMETER
);
3973 return (EFI_INVALID_PARAMETER
);
3978 // Chop off leading spaces
3980 for (Walker
= String
; Walker
!= NULL
&& *Walker
!= CHAR_NULL
&& *Walker
== L
' '; Walker
++);
3983 // make sure we have something left that is numeric.
3985 if (Walker
== NULL
|| *Walker
== CHAR_NULL
|| !InternalShellIsHexOrDecimalNumber(Walker
, Hex
, StopAtSpace
, FALSE
)) {
3986 return (EFI_INVALID_PARAMETER
);
3990 // do the conversion.
3992 if (Hex
|| StrnCmp(Walker
, L
"0x", 2) == 0 || StrnCmp(Walker
, L
"0X", 2) == 0){
3993 Status
= InternalShellStrHexToUint64(Walker
, &RetVal
, StopAtSpace
);
3995 Status
= InternalShellStrDecimalToUint64(Walker
, &RetVal
, StopAtSpace
);
3998 if (Value
== NULL
&& !EFI_ERROR(Status
)) {
3999 return (EFI_NOT_FOUND
);
4002 if (Value
!= NULL
) {
4010 Function to determin if an entire string is a valid number.
4012 If Hex it must be preceeded with a 0x or has ForceHex, set TRUE.
4014 @param[in] String The string to evaluate.
4015 @param[in] ForceHex TRUE - always assume hex.
4016 @param[in] StopAtSpace TRUE to halt upon finding a space, FALSE to keep going.
4018 @retval TRUE It is all numeric (dec/hex) characters.
4019 @retval FALSE There is a non-numeric character.
4023 ShellIsHexOrDecimalNumber (
4024 IN CONST CHAR16
*String
,
4025 IN CONST BOOLEAN ForceHex
,
4026 IN CONST BOOLEAN StopAtSpace
4029 if (ShellConvertStringToUint64(String
, NULL
, ForceHex
, StopAtSpace
) == EFI_NOT_FOUND
) {
4036 Function to read a single line from a SHELL_FILE_HANDLE. The \n is not included in the returned
4037 buffer. The returned buffer must be callee freed.
4039 If the position upon start is 0, then the Ascii Boolean will be set. This should be
4040 maintained and not changed for all operations with the same file.
4042 @param[in] Handle SHELL_FILE_HANDLE to read from.
4043 @param[in, out] Ascii Boolean value for indicating whether the file is
4044 Ascii (TRUE) or UCS2 (FALSE).
4046 @return The line of text from the file.
4047 @retval NULL There was not enough memory available.
4049 @sa ShellFileHandleReadLine
4053 ShellFileHandleReturnLine(
4054 IN SHELL_FILE_HANDLE Handle
,
4055 IN OUT BOOLEAN
*Ascii
4065 Status
= ShellFileHandleReadLine(Handle
, RetVal
, &Size
, FALSE
, Ascii
);
4066 if (Status
== EFI_BUFFER_TOO_SMALL
) {
4067 RetVal
= AllocateZeroPool(Size
);
4068 if (RetVal
== NULL
) {
4071 Status
= ShellFileHandleReadLine(Handle
, RetVal
, &Size
, FALSE
, Ascii
);
4074 if (EFI_ERROR(Status
) && (RetVal
!= NULL
)) {
4082 Function to read a single line (up to but not including the \n) from a SHELL_FILE_HANDLE.
4084 If the position upon start is 0, then the Ascii Boolean will be set. This should be
4085 maintained and not changed for all operations with the same file.
4087 NOTE: LINES THAT ARE RETURNED BY THIS FUNCTION ARE UCS2, EVEN IF THE FILE BEING READ
4090 @param[in] Handle SHELL_FILE_HANDLE to read from.
4091 @param[in, out] Buffer The pointer to buffer to read into. If this function
4092 returns EFI_SUCCESS, then on output Buffer will
4093 contain a UCS2 string, even if the file being
4095 @param[in, out] Size On input, pointer to number of bytes in Buffer.
4096 On output, unchanged unless Buffer is too small
4097 to contain the next line of the file. In that
4098 case Size is set to the number of bytes needed
4099 to hold the next line of the file (as a UCS2
4100 string, even if it is an ASCII file).
4101 @param[in] Truncate If the buffer is large enough, this has no effect.
4102 If the buffer is is too small and Truncate is TRUE,
4103 the line will be truncated.
4104 If the buffer is is too small and Truncate is FALSE,
4105 then no read will occur.
4107 @param[in, out] Ascii Boolean value for indicating whether the file is
4108 Ascii (TRUE) or UCS2 (FALSE).
4110 @retval EFI_SUCCESS The operation was successful. The line is stored in
4112 @retval EFI_END_OF_FILE There are no more lines in the file.
4113 @retval EFI_INVALID_PARAMETER Handle was NULL.
4114 @retval EFI_INVALID_PARAMETER Size was NULL.
4115 @retval EFI_BUFFER_TOO_SMALL Size was not large enough to store the line.
4116 Size was updated to the minimum space required.
4120 ShellFileHandleReadLine(
4121 IN SHELL_FILE_HANDLE Handle
,
4122 IN OUT CHAR16
*Buffer
,
4124 IN BOOLEAN Truncate
,
4125 IN OUT BOOLEAN
*Ascii
4132 UINT64 OriginalFilePosition
;
4138 return (EFI_INVALID_PARAMETER
);
4140 if (Buffer
== NULL
) {
4143 *Buffer
= CHAR_NULL
;
4145 gEfiShellProtocol
->GetFilePosition(Handle
, &OriginalFilePosition
);
4146 if (OriginalFilePosition
== 0) {
4147 CharSize
= sizeof(CHAR16
);
4148 Status
= gEfiShellProtocol
->ReadFile(Handle
, &CharSize
, &CharBuffer
);
4149 ASSERT_EFI_ERROR(Status
);
4150 if (CharBuffer
== gUnicodeFileTag
) {
4154 gEfiShellProtocol
->SetFilePosition(Handle
, OriginalFilePosition
);
4159 CharSize
= sizeof(CHAR8
);
4161 CharSize
= sizeof(CHAR16
);
4163 for (CountSoFar
= 0;;CountSoFar
++){
4165 Status
= gEfiShellProtocol
->ReadFile(Handle
, &CharSize
, &CharBuffer
);
4166 if ( EFI_ERROR(Status
)
4168 || (CharBuffer
== L
'\n' && !(*Ascii
))
4169 || (CharBuffer
== '\n' && *Ascii
)
4171 if (CharSize
== 0) {
4172 Status
= EFI_END_OF_FILE
;
4177 // if we have space save it...
4179 if ((CountSoFar
+ 1) * CharSize
< *Size
){
4180 ASSERT(Buffer
!= NULL
);
4182 ((CHAR8
*)Buffer
)[CountSoFar
] = (CHAR8
) CharBuffer
;
4183 ((CHAR8
*)Buffer
)[CountSoFar
+1] = '\0';
4186 ((CHAR16
*)Buffer
)[CountSoFar
] = CharBuffer
;
4187 ((CHAR16
*)Buffer
)[CountSoFar
+1] = CHAR_NULL
;
4193 // if we ran out of space tell when...
4195 if (Status
!= EFI_END_OF_FILE
){
4196 if ((CountSoFar
+ 1) * CharSize
> *Size
){
4197 *Size
= (CountSoFar
+ 1) * CharSize
;
4199 gEfiShellProtocol
->SetFilePosition(Handle
, OriginalFilePosition
);
4201 DEBUG((DEBUG_WARN
, "The line was truncated in ShellFileHandleReadLine"));
4203 return (EFI_BUFFER_TOO_SMALL
);
4207 if (CountSoFar
&& ((CHAR8
*)Buffer
)[CountSoFar
- 1] == '\r') {
4208 ((CHAR8
*)Buffer
)[CountSoFar
- 1] = '\0';
4212 if (CountSoFar
&& Buffer
[CountSoFar
- 1] == L
'\r') {
4213 Buffer
[CountSoFar
- 1] = CHAR_NULL
;
4222 Function to print help file / man page content in the spec from the UEFI Shell protocol GetHelpText function.
4224 @param[in] CommandToGetHelpOn Pointer to a string containing the command name of help file to be printed.
4225 @param[in] SectionToGetHelpOn Pointer to the section specifier(s).
4226 @param[in] PrintCommandText If TRUE, prints the command followed by the help content, otherwise prints
4227 the help content only.
4228 @retval EFI_DEVICE_ERROR The help data format was incorrect.
4229 @retval EFI_NOT_FOUND The help data could not be found.
4230 @retval EFI_SUCCESS The operation was successful.
4235 IN CONST CHAR16
*CommandToGetHelpOn
,
4236 IN CONST CHAR16
*SectionToGetHelpOn
,
4237 IN BOOLEAN PrintCommandText
4246 // Get the string to print based
4248 Status
= gEfiShellProtocol
->GetHelpText (CommandToGetHelpOn
, SectionToGetHelpOn
, &OutText
);
4251 // make sure we got a valid string
4253 if (EFI_ERROR(Status
)){
4256 if (OutText
== NULL
|| StrLen(OutText
) == 0) {
4257 return EFI_NOT_FOUND
;
4261 // Chop off trailing stuff we dont need
4263 while (OutText
[StrLen(OutText
)-1] == L
'\r' || OutText
[StrLen(OutText
)-1] == L
'\n' || OutText
[StrLen(OutText
)-1] == L
' ') {
4264 OutText
[StrLen(OutText
)-1] = CHAR_NULL
;
4268 // Print this out to the console
4270 if (PrintCommandText
) {
4271 ShellPrintEx(-1, -1, L
"%H%-14s%N- %s\r\n", CommandToGetHelpOn
, OutText
);
4273 ShellPrintEx(-1, -1, L
"%N%s\r\n", OutText
);
4276 SHELL_FREE_NON_NULL(OutText
);
4282 Function to delete a file by name
4284 @param[in] FileName Pointer to file name to delete.
4286 @retval EFI_SUCCESS the file was deleted sucessfully
4287 @retval EFI_WARN_DELETE_FAILURE the handle was closed, but the file was not
4289 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
4290 @retval EFI_NOT_FOUND The specified file could not be found on the
4291 device or the file system could not be found
4293 @retval EFI_NO_MEDIA The device has no medium.
4294 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the
4295 medium is no longer supported.
4296 @retval EFI_DEVICE_ERROR The device reported an error.
4297 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
4298 @retval EFI_WRITE_PROTECTED The file or medium is write protected.
4299 @retval EFI_ACCESS_DENIED The file was opened read only.
4300 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the
4302 @retval other The file failed to open
4306 ShellDeleteFileByName(
4307 IN CONST CHAR16
*FileName
4311 SHELL_FILE_HANDLE FileHandle
;
4313 Status
= ShellFileExists(FileName
);
4315 if (Status
== EFI_SUCCESS
){
4316 Status
= ShellOpenFileByName(FileName
, &FileHandle
, EFI_FILE_MODE_READ
| EFI_FILE_MODE_WRITE
| EFI_FILE_MODE_CREATE
, 0x0);
4317 if (Status
== EFI_SUCCESS
){
4318 Status
= ShellDeleteFile(&FileHandle
);
4327 Cleans off all the quotes in the string.
4329 @param[in] OriginalString pointer to the string to be cleaned.
4330 @param[out] CleanString The new string with all quotes removed.
4331 Memory allocated in the function and free
4334 @retval EFI_SUCCESS The operation was successful.
4338 InternalShellStripQuotes (
4339 IN CONST CHAR16
*OriginalString
,
4340 OUT CHAR16
**CleanString
4345 if (OriginalString
== NULL
|| CleanString
== NULL
) {
4346 return EFI_INVALID_PARAMETER
;
4349 *CleanString
= AllocateCopyPool (StrSize (OriginalString
), OriginalString
);
4350 if (*CleanString
== NULL
) {
4351 return EFI_OUT_OF_RESOURCES
;
4354 for (Walker
= *CleanString
; Walker
!= NULL
&& *Walker
!= CHAR_NULL
; Walker
++) {
4355 if (*Walker
== L
'\"') {
4356 CopyMem(Walker
, Walker
+1, StrSize(Walker
) - sizeof(Walker
[0]));