2 Member functions of EFI_SHELL_PROTOCOL and functions for creation,
3 manipulation, and initialization of EFI_SHELL_PROTOCOL.
5 Copyright (c) 2009 - 2014, 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.
19 Close an open file handle.
21 This function closes a specified file handle. All "dirty" cached file data is
22 flushed to the device, and the file is closed. In all cases the handle is
25 @param[in] FileHandle The file handle to close.
27 @retval EFI_SUCCESS The file handle was closed successfully.
32 IN SHELL_FILE_HANDLE FileHandle
35 ShellFileHandleRemove(FileHandle
);
36 return (FileHandleClose(ConvertShellHandleToEfiFileProtocol(FileHandle
)));
40 Internal worker to determine whether there is a BlockIo somewhere
41 upon the device path specified.
43 @param[in] DevicePath The device path to test.
45 @retval TRUE gEfiBlockIoProtocolGuid was installed on a handle with this device path
46 @retval FALSE gEfiBlockIoProtocolGuid was not found.
50 InternalShellProtocolIsBlockIoPresent(
51 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
54 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
60 DevicePathCopy
= (EFI_DEVICE_PATH_PROTOCOL
*)DevicePath
;
61 Status
= gBS
->LocateDevicePath(&gEfiBlockIoProtocolGuid
, &DevicePathCopy
, &Handle
);
63 if ((Handle
!= NULL
) && (!EFI_ERROR(Status
))) {
70 Internal worker to determine whether there is a file system somewhere
71 upon the device path specified.
73 @param[in] DevicePath The device path to test.
75 @retval TRUE gEfiSimpleFileSystemProtocolGuid was installed on a handle with this device path
76 @retval FALSE gEfiSimpleFileSystemProtocolGuid was not found.
80 InternalShellProtocolIsSimpleFileSystemPresent(
81 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
84 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
90 DevicePathCopy
= (EFI_DEVICE_PATH_PROTOCOL
*)DevicePath
;
91 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &DevicePathCopy
, &Handle
);
93 if ((Handle
!= NULL
) && (!EFI_ERROR(Status
))) {
100 Internal worker debug helper function to print out maps as they are added.
102 @param[in] Mapping string mapping that has been added
103 @param[in] DevicePath pointer to device path that has been mapped.
105 @retval EFI_SUCCESS the operation was successful.
106 @return other an error ocurred
113 InternalShellProtocolDebugPrintMessage (
114 IN CONST CHAR16
*Mapping
,
115 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
121 Status
= EFI_SUCCESS
;
124 if (Mapping
!= NULL
) {
125 DEBUG((EFI_D_INFO
, "Added new map item:\"%S\"\r\n", Mapping
));
127 Temp
= ConvertDevicePathToText(DevicePath
, TRUE
, TRUE
);
128 DEBUG((EFI_D_INFO
, "DevicePath: %S\r\n", Temp
));
136 This function creates a mapping for a device path.
138 If both DeviecPath and Mapping are NULL, this will reset the mapping to default values.
140 @param DevicePath Points to the device path. If this is NULL and Mapping points to a valid mapping,
141 then the mapping will be deleted.
142 @param Mapping Points to the NULL-terminated mapping for the device path. Must end with a ':'
144 @retval EFI_SUCCESS Mapping created or deleted successfully.
145 @retval EFI_NO_MAPPING There is no handle that corresponds exactly to DevicePath. See the
146 boot service function LocateDevicePath().
147 @retval EFI_ACCESS_DENIED The mapping is a built-in alias.
148 @retval EFI_INVALID_PARAMETER Mapping was NULL
149 @retval EFI_INVALID_PARAMETER Mapping did not end with a ':'
150 @retval EFI_INVALID_PARAMETER DevicePath was not pointing at a device that had a SIMPLE_FILE_SYSTEM_PROTOCOL installed.
151 @retval EFI_NOT_FOUND There was no mapping found to delete
152 @retval EFI_OUT_OF_RESOURCES Memory allocation failed
157 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath OPTIONAL
,
158 IN CONST CHAR16
*Mapping
162 SHELL_MAP_LIST
*MapListNode
;
164 if (Mapping
== NULL
){
165 return (EFI_INVALID_PARAMETER
);
168 if (Mapping
[StrLen(Mapping
)-1] != ':') {
169 return (EFI_INVALID_PARAMETER
);
173 // Delete the mapping
175 if (DevicePath
== NULL
) {
176 if (IsListEmpty(&gShellMapList
.Link
)) {
177 return (EFI_NOT_FOUND
);
179 for ( MapListNode
= (SHELL_MAP_LIST
*)GetFirstNode(&gShellMapList
.Link
)
180 ; !IsNull(&gShellMapList
.Link
, &MapListNode
->Link
)
181 ; MapListNode
= (SHELL_MAP_LIST
*)GetNextNode(&gShellMapList
.Link
, &MapListNode
->Link
)
183 if (StringNoCaseCompare(&MapListNode
->MapName
, &Mapping
) == 0) {
184 RemoveEntryList(&MapListNode
->Link
);
185 FreePool(MapListNode
);
186 return (EFI_SUCCESS
);
191 // We didnt find one to delete
193 return (EFI_NOT_FOUND
);
197 // make sure this is a valid to add device path
199 ///@todo add BlockIo to this test...
200 if (!InternalShellProtocolIsSimpleFileSystemPresent(DevicePath
)
201 && !InternalShellProtocolIsBlockIoPresent(DevicePath
)) {
202 return (EFI_INVALID_PARAMETER
);
206 // First make sure there is no old mapping
208 Status
= EfiShellSetMap(NULL
, Mapping
);
209 if ((Status
!= EFI_SUCCESS
) && (Status
!= EFI_NOT_FOUND
)) {
214 // now add the new one.
216 Status
= ShellCommandAddMapItemAndUpdatePath(Mapping
, DevicePath
, 0, FALSE
);
222 Gets the device path from the mapping.
224 This function gets the device path associated with a mapping.
226 @param Mapping A pointer to the mapping
228 @retval !=NULL Pointer to the device path that corresponds to the
229 device mapping. The returned pointer does not need
231 @retval NULL There is no device path associated with the
234 CONST EFI_DEVICE_PATH_PROTOCOL
*
236 EfiShellGetDevicePathFromMap(
237 IN CONST CHAR16
*Mapping
240 SHELL_MAP_LIST
*MapListItem
;
247 StrnCatGrow(&NewName
, &Size
, Mapping
, 0);
248 if (Mapping
[StrLen(Mapping
)-1] != L
':') {
249 StrnCatGrow(&NewName
, &Size
, L
":", 0);
252 MapListItem
= ShellCommandFindMapItem(NewName
);
256 if (MapListItem
!= NULL
) {
257 return (MapListItem
->DevicePath
);
263 Gets the mapping(s) that most closely matches the device path.
265 This function gets the mapping which corresponds to the device path *DevicePath. If
266 there is no exact match, then the mapping which most closely matches *DevicePath
267 is returned, and *DevicePath is updated to point to the remaining portion of the
268 device path. If there is an exact match, the mapping is returned and *DevicePath
269 points to the end-of-device-path node.
271 If there are multiple map names they will be semi-colon seperated in the
272 NULL-terminated string.
274 @param DevicePath On entry, points to a device path pointer. On
275 exit, updates the pointer to point to the
276 portion of the device path after the mapping.
278 @retval NULL No mapping was found.
279 @return !=NULL Pointer to NULL-terminated mapping. The buffer
280 is callee allocated and should be freed by the caller.
284 EfiShellGetMapFromDevicePath(
285 IN OUT EFI_DEVICE_PATH_PROTOCOL
**DevicePath
288 SHELL_MAP_LIST
*Node
;
289 CHAR16
*PathForReturn
;
291 // EFI_HANDLE PathHandle;
292 // EFI_HANDLE MapHandle;
293 // EFI_STATUS Status;
294 // EFI_DEVICE_PATH_PROTOCOL *DevicePathCopy;
295 // EFI_DEVICE_PATH_PROTOCOL *MapPathCopy;
297 if (DevicePath
== NULL
|| *DevicePath
== NULL
) {
301 PathForReturn
= NULL
;
304 for ( Node
= (SHELL_MAP_LIST
*)GetFirstNode(&gShellMapList
.Link
)
305 ; !IsNull(&gShellMapList
.Link
, &Node
->Link
)
306 ; Node
= (SHELL_MAP_LIST
*)GetNextNode(&gShellMapList
.Link
, &Node
->Link
)
309 // check for exact match
311 if (DevicePathCompare(DevicePath
, &Node
->DevicePath
) == 0) {
312 ASSERT((PathForReturn
== NULL
&& PathSize
== 0) || (PathForReturn
!= NULL
));
314 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, L
";", 0);
316 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, Node
->MapName
, 0);
319 if (PathForReturn
!= NULL
) {
320 while (!IsDevicePathEndType (*DevicePath
)) {
321 *DevicePath
= NextDevicePathNode (*DevicePath
);
323 SetDevicePathEndNode (*DevicePath
);
326 ///@todo finish code for inexact matches.
327 if (PathForReturn == NULL) {
330 DevicePathCopy = DuplicateDevicePath(*DevicePath);
331 ASSERT(DevicePathCopy != NULL);
332 Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &DevicePathCopy, &PathHandle);
333 ASSERT_EFI_ERROR(Status);
335 // check each of the device paths we have to get the root of the path for consist mappings
337 for ( Node = (SHELL_MAP_LIST *)GetFirstNode(&gShellMapList.Link)
338 ; !IsNull(&gShellMapList.Link, &Node->Link)
339 ; Node = (SHELL_MAP_LIST *)GetNextNode(&gShellMapList.Link, &Node->Link)
341 if ((Node->Flags & SHELL_MAP_FLAGS_CONSIST) == 0) {
344 MapPathCopy = DuplicateDevicePath(Node->DevicePath);
345 ASSERT(MapPathCopy != NULL);
346 Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &MapPathCopy, &MapHandle);
347 if (MapHandle == PathHandle) {
349 *DevicePath = DevicePathCopy;
352 DevicePathCopy = NULL;
353 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, Node->MapName, 0);
354 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, L";", 0);
359 // now add on the non-consistent mappings
361 for ( Node = (SHELL_MAP_LIST *)GetFirstNode(&gShellMapList.Link)
362 ; !IsNull(&gShellMapList.Link, &Node->Link)
363 ; Node = (SHELL_MAP_LIST *)GetNextNode(&gShellMapList.Link, &Node->Link)
365 if ((Node->Flags & SHELL_MAP_FLAGS_CONSIST) != 0) {
368 MapPathCopy = Node->DevicePath;
369 ASSERT(MapPathCopy != NULL);
370 Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &MapPathCopy, &MapHandle);
371 if (MapHandle == PathHandle) {
372 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, Node->MapName, 0);
373 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, L";", 0);
380 return (AddBufferToFreeList(PathForReturn
));
384 Converts a device path to a file system-style path.
386 This function converts a device path to a file system path by replacing part, or all, of
387 the device path with the file-system mapping. If there are more than one application
388 file system mappings, the one that most closely matches Path will be used.
390 @param Path The pointer to the device path
392 @retval NULL the device path could not be found.
393 @return all The pointer of the NULL-terminated file path. The path
394 is callee-allocated and should be freed by the caller.
398 EfiShellGetFilePathFromDevicePath(
399 IN CONST EFI_DEVICE_PATH_PROTOCOL
*Path
402 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
403 EFI_DEVICE_PATH_PROTOCOL
*MapPathCopy
;
404 SHELL_MAP_LIST
*MapListItem
;
405 CHAR16
*PathForReturn
;
407 EFI_HANDLE PathHandle
;
408 EFI_HANDLE MapHandle
;
410 FILEPATH_DEVICE_PATH
*FilePath
;
411 FILEPATH_DEVICE_PATH
*AlignedNode
;
413 PathForReturn
= NULL
;
416 DevicePathCopy
= (EFI_DEVICE_PATH_PROTOCOL
*)Path
;
417 ASSERT(DevicePathCopy
!= NULL
);
418 if (DevicePathCopy
== NULL
) {
422 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &DevicePathCopy
, &PathHandle
);
424 if (EFI_ERROR(Status
)) {
428 // check each of the device paths we have to get the root of the path
430 for ( MapListItem
= (SHELL_MAP_LIST
*)GetFirstNode(&gShellMapList
.Link
)
431 ; !IsNull(&gShellMapList
.Link
, &MapListItem
->Link
)
432 ; MapListItem
= (SHELL_MAP_LIST
*)GetNextNode(&gShellMapList
.Link
, &MapListItem
->Link
)
434 MapPathCopy
= (EFI_DEVICE_PATH_PROTOCOL
*)MapListItem
->DevicePath
;
435 ASSERT(MapPathCopy
!= NULL
);
437 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &MapPathCopy
, &MapHandle
);
438 if (MapHandle
== PathHandle
) {
439 ASSERT((PathForReturn
== NULL
&& PathSize
== 0) || (PathForReturn
!= NULL
));
440 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, MapListItem
->MapName
, 0);
442 // go through all the remaining nodes in the device path
444 for ( FilePath
= (FILEPATH_DEVICE_PATH
*)DevicePathCopy
445 ; !IsDevicePathEnd (&FilePath
->Header
)
446 ; FilePath
= (FILEPATH_DEVICE_PATH
*)NextDevicePathNode (&FilePath
->Header
)
449 // all the rest should be file path nodes
451 if ((DevicePathType(&FilePath
->Header
) != MEDIA_DEVICE_PATH
) ||
452 (DevicePathSubType(&FilePath
->Header
) != MEDIA_FILEPATH_DP
)) {
453 FreePool(PathForReturn
);
454 PathForReturn
= NULL
;
458 // append the path part onto the filepath.
460 ASSERT((PathForReturn
== NULL
&& PathSize
== 0) || (PathForReturn
!= NULL
));
462 AlignedNode
= AllocateCopyPool (DevicePathNodeLength(FilePath
), FilePath
);
464 // File Path Device Path Nodes 'can optionally add a "\" separator to
465 // the beginning and/or the end of the Path Name string.'
466 // (UEFI Spec 2.4 section 9.3.6.4).
467 // If necessary, add a "\", but otherwise don't
468 // (This is specified in the above section, and also implied by the
469 // UEFI Shell spec section 3.7)
470 if ((PathForReturn
[PathSize
- 1] != L
'\\') &&
471 (AlignedNode
->PathName
[0] != L
'\\')) {
472 PathForReturn
= StrnCatGrow (&PathForReturn
, &PathSize
, L
"\\", 1);
475 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, AlignedNode
->PathName
, 0);
476 FreePool(AlignedNode
);
478 } // for loop of remaining nodes
480 if (PathForReturn
!= NULL
) {
483 } // for loop of paths to check
484 return(PathForReturn
);
488 Converts a file system style name to a device path.
490 This function converts a file system style name to a device path, by replacing any
491 mapping references to the associated device path.
493 @param[in] Path The pointer to the path.
495 @return The pointer of the file path. The file path is callee
496 allocated and should be freed by the caller.
497 @retval NULL The path could not be found.
498 @retval NULL There was not enough available memory.
500 EFI_DEVICE_PATH_PROTOCOL
*
502 EfiShellGetDevicePathFromFilePath(
503 IN CONST CHAR16
*Path
510 CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
511 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
512 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopyForFree
;
513 EFI_DEVICE_PATH_PROTOCOL
*DevicePathForReturn
;
524 if (StrStr(Path
, L
":") == NULL
) {
525 Cwd
= EfiShellGetCurDir(NULL
);
530 Size
+= StrSize(Path
);
531 NewPath
= AllocateZeroPool(Size
);
532 if (NewPath
== NULL
) {
535 StrCpy(NewPath
, Cwd
);
536 if (*Path
== L
'\\') {
538 while (PathRemoveLastItem(NewPath
)) ;
540 StrCat(NewPath
, Path
);
541 DevicePathForReturn
= EfiShellGetDevicePathFromFilePath(NewPath
);
543 return (DevicePathForReturn
);
548 // find the part before (but including) the : for the map name
550 ASSERT((MapName
== NULL
&& Size
== 0) || (MapName
!= NULL
));
551 MapName
= StrnCatGrow(&MapName
, &Size
, Path
, (StrStr(Path
, L
":")-Path
+1));
552 if (MapName
== NULL
|| MapName
[StrLen(MapName
)-1] != L
':') {
557 // look up the device path in the map
559 DevicePath
= EfiShellGetDevicePathFromMap(MapName
);
560 if (DevicePath
== NULL
) {
562 // Must have been a bad Mapname
568 // make a copy for LocateDevicePath to modify (also save a pointer to call FreePool with)
570 DevicePathCopyForFree
= DevicePathCopy
= DuplicateDevicePath(DevicePath
);
571 if (DevicePathCopy
== NULL
) {
580 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &DevicePathCopy
, &Handle
);
581 if (EFI_ERROR(Status
)) {
582 if (DevicePathCopyForFree
!= NULL
) {
583 FreePool(DevicePathCopyForFree
);
590 // build the full device path
592 if (*(Path
+StrLen(MapName
)+1) == CHAR_NULL
) {
593 DevicePathForReturn
= FileDevicePath(Handle
, L
"\\");
595 DevicePathForReturn
= FileDevicePath(Handle
, Path
+StrLen(MapName
));
599 if (DevicePathCopyForFree
!= NULL
) {
600 FreePool(DevicePathCopyForFree
);
603 return (DevicePathForReturn
);
607 Gets the name of the device specified by the device handle.
609 This function gets the user-readable name of the device specified by the device
610 handle. If no user-readable name could be generated, then *BestDeviceName will be
611 NULL and EFI_NOT_FOUND will be returned.
613 If EFI_DEVICE_NAME_USE_COMPONENT_NAME is set, then the function will return the
614 device's name using the EFI_COMPONENT_NAME2_PROTOCOL, if present on
617 If EFI_DEVICE_NAME_USE_DEVICE_PATH is set, then the function will return the
618 device's name using the EFI_DEVICE_PATH_PROTOCOL, if present on DeviceHandle.
619 If both EFI_DEVICE_NAME_USE_COMPONENT_NAME and
620 EFI_DEVICE_NAME_USE_DEVICE_PATH are set, then
621 EFI_DEVICE_NAME_USE_COMPONENT_NAME will have higher priority.
623 @param DeviceHandle The handle of the device.
624 @param Flags Determines the possible sources of component names.
626 EFI_DEVICE_NAME_USE_COMPONENT_NAME
627 EFI_DEVICE_NAME_USE_DEVICE_PATH
628 @param Language A pointer to the language specified for the device
629 name, in the same format as described in the UEFI
630 specification, Appendix M
631 @param BestDeviceName On return, points to the callee-allocated NULL-
632 terminated name of the device. If no device name
633 could be found, points to NULL. The name must be
634 freed by the caller...
636 @retval EFI_SUCCESS Get the name successfully.
637 @retval EFI_NOT_FOUND Fail to get the device name.
638 @retval EFI_INVALID_PARAMETER Flags did not have a valid bit set.
639 @retval EFI_INVALID_PARAMETER BestDeviceName was NULL
640 @retval EFI_INVALID_PARAMETER DeviceHandle was NULL
644 EfiShellGetDeviceName(
645 IN EFI_HANDLE DeviceHandle
,
646 IN EFI_SHELL_DEVICE_NAME_FLAGS Flags
,
648 OUT CHAR16
**BestDeviceName
652 EFI_COMPONENT_NAME2_PROTOCOL
*CompName2
;
653 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
654 EFI_HANDLE
*HandleList
;
657 CHAR16
*DeviceNameToReturn
;
659 UINTN ParentControllerCount
;
660 EFI_HANDLE
*ParentControllerBuffer
;
661 UINTN ParentDriverCount
;
662 EFI_HANDLE
*ParentDriverBuffer
;
664 if (BestDeviceName
== NULL
||
667 return (EFI_INVALID_PARAMETER
);
671 // make sure one of the 2 supported bits is on
673 if (((Flags
& EFI_DEVICE_NAME_USE_COMPONENT_NAME
) == 0) &&
674 ((Flags
& EFI_DEVICE_NAME_USE_DEVICE_PATH
) == 0)) {
675 return (EFI_INVALID_PARAMETER
);
678 DeviceNameToReturn
= NULL
;
679 *BestDeviceName
= NULL
;
684 if ((Flags
& EFI_DEVICE_NAME_USE_COMPONENT_NAME
) != 0) {
685 Status
= ParseHandleDatabaseByRelationship(
688 HR_DRIVER_BINDING_HANDLE
|HR_DEVICE_DRIVER
,
691 for (LoopVar
= 0; LoopVar
< HandleCount
; LoopVar
++){
693 // Go through those handles until we get one that passes for GetComponentName
695 Status
= gBS
->OpenProtocol(
697 &gEfiComponentName2ProtocolGuid
,
701 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
702 if (EFI_ERROR(Status
)) {
703 Status
= gBS
->OpenProtocol(
705 &gEfiComponentNameProtocolGuid
,
709 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
712 if (EFI_ERROR(Status
)) {
715 Lang
= GetBestLanguageForDriver(CompName2
->SupportedLanguages
, Language
, FALSE
);
716 Status
= CompName2
->GetControllerName(CompName2
, DeviceHandle
, NULL
, Lang
, &DeviceNameToReturn
);
719 if (!EFI_ERROR(Status
) && DeviceNameToReturn
!= NULL
) {
723 if (HandleList
!= NULL
) {
724 FreePool(HandleList
);
728 // Now check the parent controller using this as the child.
730 if (DeviceNameToReturn
== NULL
){
731 PARSE_HANDLE_DATABASE_PARENTS(DeviceHandle
, &ParentControllerCount
, &ParentControllerBuffer
);
732 for (LoopVar
= 0 ; LoopVar
< ParentControllerCount
; LoopVar
++) {
733 PARSE_HANDLE_DATABASE_UEFI_DRIVERS(ParentControllerBuffer
[LoopVar
], &ParentDriverCount
, &ParentDriverBuffer
);
734 for (HandleCount
= 0 ; HandleCount
< ParentDriverCount
; HandleCount
++) {
736 // try using that driver's component name with controller and our driver as the child.
738 Status
= gBS
->OpenProtocol(
739 ParentDriverBuffer
[HandleCount
],
740 &gEfiComponentName2ProtocolGuid
,
744 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
745 if (EFI_ERROR(Status
)) {
746 Status
= gBS
->OpenProtocol(
747 ParentDriverBuffer
[HandleCount
],
748 &gEfiComponentNameProtocolGuid
,
752 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
755 if (EFI_ERROR(Status
)) {
758 Lang
= GetBestLanguageForDriver(CompName2
->SupportedLanguages
, Language
, FALSE
);
759 Status
= CompName2
->GetControllerName(CompName2
, ParentControllerBuffer
[LoopVar
], DeviceHandle
, Lang
, &DeviceNameToReturn
);
762 if (!EFI_ERROR(Status
) && DeviceNameToReturn
!= NULL
) {
769 SHELL_FREE_NON_NULL(ParentDriverBuffer
);
770 if (!EFI_ERROR(Status
) && DeviceNameToReturn
!= NULL
) {
774 SHELL_FREE_NON_NULL(ParentControllerBuffer
);
777 // dont return on fail since we will try device path if that bit is on
779 if (DeviceNameToReturn
!= NULL
){
780 ASSERT(BestDeviceName
!= NULL
);
781 StrnCatGrow(BestDeviceName
, NULL
, DeviceNameToReturn
, 0);
782 return (EFI_SUCCESS
);
785 if ((Flags
& EFI_DEVICE_NAME_USE_DEVICE_PATH
) != 0) {
786 Status
= gBS
->OpenProtocol(
788 &gEfiDevicePathProtocolGuid
,
792 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
793 if (!EFI_ERROR(Status
)) {
795 // use device path to text on the device path
797 *BestDeviceName
= ConvertDevicePathToText(DevicePath
, TRUE
, TRUE
);
798 return (EFI_SUCCESS
);
802 // none of the selected bits worked.
804 return (EFI_NOT_FOUND
);
808 Opens the root directory of a device on a handle
810 This function opens the root directory of a device and returns a file handle to it.
812 @param DeviceHandle The handle of the device that contains the volume.
813 @param FileHandle On exit, points to the file handle corresponding to the root directory on the
816 @retval EFI_SUCCESS Root opened successfully.
817 @retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory
819 @retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.
820 @retval EFI_DEVICE_ERROR The device had an error
824 EfiShellOpenRootByHandle(
825 IN EFI_HANDLE DeviceHandle
,
826 OUT SHELL_FILE_HANDLE
*FileHandle
830 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
*SimpleFileSystem
;
831 EFI_FILE_PROTOCOL
*RealFileHandle
;
832 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
835 // get the simple file system interface
837 Status
= gBS
->OpenProtocol(DeviceHandle
,
838 &gEfiSimpleFileSystemProtocolGuid
,
839 (VOID
**)&SimpleFileSystem
,
842 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
843 if (EFI_ERROR(Status
)) {
844 return (EFI_NOT_FOUND
);
847 Status
= gBS
->OpenProtocol(DeviceHandle
,
848 &gEfiDevicePathProtocolGuid
,
852 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
853 if (EFI_ERROR(Status
)) {
854 return (EFI_NOT_FOUND
);
857 // Open the root volume now...
859 Status
= SimpleFileSystem
->OpenVolume(SimpleFileSystem
, &RealFileHandle
);
860 *FileHandle
= ConvertEfiFileProtocolToShellHandle(RealFileHandle
, EfiShellGetMapFromDevicePath(&DevPath
));
865 Opens the root directory of a device.
867 This function opens the root directory of a device and returns a file handle to it.
869 @param DevicePath Points to the device path corresponding to the device where the
870 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL is installed.
871 @param FileHandle On exit, points to the file handle corresponding to the root directory on the
874 @retval EFI_SUCCESS Root opened successfully.
875 @retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory
877 @retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.
878 @retval EFI_DEVICE_ERROR The device had an error
879 @retval EFI_INVALID_PARAMETER FileHandle is NULL.
884 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
885 OUT SHELL_FILE_HANDLE
*FileHandle
891 if (FileHandle
== NULL
) {
892 return (EFI_INVALID_PARAMETER
);
896 // find the handle of the device with that device handle and the file system
899 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
,
902 if (EFI_ERROR(Status
)) {
903 return (EFI_NOT_FOUND
);
906 return (EfiShellOpenRootByHandle(Handle
, FileHandle
));
910 Returns whether any script files are currently being processed.
912 @retval TRUE There is at least one script file active.
913 @retval FALSE No script files are active now.
918 EfiShellBatchIsActive (
922 if (ShellCommandGetCurrentScriptFile() == NULL
) {
929 Worker function to open a file based on a device path. this will open the root
930 of the volume and then traverse down to the file itself.
932 @param DevicePath Device Path of the file.
933 @param FileHandle Pointer to the file upon a successful return.
934 @param OpenMode mode to open file in.
935 @param Attributes the File Attributes to use when creating a new file.
937 @retval EFI_SUCCESS the file is open and FileHandle is valid
938 @retval EFI_UNSUPPORTED the device path cotained non-path elements
939 @retval other an error ocurred.
943 InternalOpenFileDevicePath(
944 IN OUT EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
945 OUT SHELL_FILE_HANDLE
*FileHandle
,
947 IN UINT64 Attributes OPTIONAL
951 FILEPATH_DEVICE_PATH
*FilePathNode
;
953 SHELL_FILE_HANDLE ShellHandle
;
954 EFI_FILE_PROTOCOL
*Handle1
;
955 EFI_FILE_PROTOCOL
*Handle2
;
956 FILEPATH_DEVICE_PATH
*AlignedNode
;
958 if (FileHandle
== NULL
) {
959 return (EFI_INVALID_PARAMETER
);
969 Status
= EfiShellOpenRoot(DevicePath
, &ShellHandle
);
971 if (!EFI_ERROR(Status
)) {
972 Handle1
= ConvertShellHandleToEfiFileProtocol(ShellHandle
);
973 if (Handle1
!= NULL
) {
975 // chop off the begining part before the file system part...
978 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
,
981 if (!EFI_ERROR(Status
)) {
983 // To access as a file system, the file path should only
984 // contain file path components. Follow the file path nodes
985 // and find the target file
987 for ( FilePathNode
= (FILEPATH_DEVICE_PATH
*)DevicePath
988 ; !IsDevicePathEnd (&FilePathNode
->Header
)
989 ; FilePathNode
= (FILEPATH_DEVICE_PATH
*) NextDevicePathNode (&FilePathNode
->Header
)
991 SHELL_FREE_NON_NULL(AlignedNode
);
992 AlignedNode
= AllocateCopyPool (DevicePathNodeLength(FilePathNode
), FilePathNode
);
994 // For file system access each node should be a file path component
996 if (DevicePathType (&FilePathNode
->Header
) != MEDIA_DEVICE_PATH
||
997 DevicePathSubType (&FilePathNode
->Header
) != MEDIA_FILEPATH_DP
999 Status
= EFI_UNSUPPORTED
;
1004 // Open this file path node
1010 // if this is the last node in the DevicePath always create (if that was requested).
1012 if (IsDevicePathEnd ((NextDevicePathNode (&FilePathNode
->Header
)))) {
1013 Status
= Handle2
->Open (
1016 AlignedNode
->PathName
,
1023 // This is not the last node and we dont want to 'create' existing
1024 // directory entries...
1028 // open without letting it create
1029 // prevents error on existing files/directories
1031 Status
= Handle2
->Open (
1034 AlignedNode
->PathName
,
1035 OpenMode
&~EFI_FILE_MODE_CREATE
,
1039 // if above failed now open and create the 'item'
1040 // if OpenMode EFI_FILE_MODE_CREATE bit was on (but disabled above)
1042 if ((EFI_ERROR (Status
)) && ((OpenMode
& EFI_FILE_MODE_CREATE
) != 0)) {
1043 Status
= Handle2
->Open (
1046 AlignedNode
->PathName
,
1053 // Close the last node
1055 ShellInfoObject
.NewEfiShellProtocol
->CloseFile (Handle2
);
1058 // If there's been an error, stop
1060 if (EFI_ERROR (Status
)) {
1067 SHELL_FREE_NON_NULL(AlignedNode
);
1068 if (EFI_ERROR(Status
)) {
1069 if (Handle1
!= NULL
) {
1070 ShellInfoObject
.NewEfiShellProtocol
->CloseFile(Handle1
);
1073 *FileHandle
= ConvertEfiFileProtocolToShellHandle(Handle1
, ShellFileHandleGetPath(ShellHandle
));
1079 Creates a file or directory by name.
1081 This function creates an empty new file or directory with the specified attributes and
1082 returns the new file's handle. If the file already exists and is read-only, then
1083 EFI_INVALID_PARAMETER will be returned.
1085 If the file already existed, it is truncated and its attributes updated. If the file is
1086 created successfully, the FileHandle is the file's handle, else, the FileHandle is NULL.
1088 If the file name begins with >v, then the file handle which is returned refers to the
1089 shell environment variable with the specified name. If the shell environment variable
1090 already exists and is non-volatile then EFI_INVALID_PARAMETER is returned.
1092 @param FileName Pointer to NULL-terminated file path
1093 @param FileAttribs The new file's attrbiutes. the different attributes are
1094 described in EFI_FILE_PROTOCOL.Open().
1095 @param FileHandle On return, points to the created file handle or directory's handle
1097 @retval EFI_SUCCESS The file was opened. FileHandle points to the new file's handle.
1098 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
1099 @retval EFI_UNSUPPORTED could not open the file path
1100 @retval EFI_NOT_FOUND the specified file could not be found on the devide, or could not
1101 file the file system on the device.
1102 @retval EFI_NO_MEDIA the device has no medium.
1103 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no
1105 @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according
1107 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1108 @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write
1109 when the media is write-protected.
1110 @retval EFI_ACCESS_DENIED The service denied access to the file.
1111 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file.
1112 @retval EFI_VOLUME_FULL The volume is full.
1117 IN CONST CHAR16
*FileName
,
1118 IN UINT64 FileAttribs
,
1119 OUT SHELL_FILE_HANDLE
*FileHandle
1122 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
1126 // Is this for an environment variable
1127 // do we start with >v
1129 if (StrStr(FileName
, L
">v") == FileName
) {
1130 if (!IsVolatileEnv(FileName
+2)) {
1131 return (EFI_INVALID_PARAMETER
);
1133 *FileHandle
= CreateFileInterfaceEnv(FileName
+2);
1134 return (EFI_SUCCESS
);
1138 // We are opening a regular file.
1140 DevicePath
= EfiShellGetDevicePathFromFilePath(FileName
);
1141 if (DevicePath
== NULL
) {
1142 return (EFI_NOT_FOUND
);
1145 Status
= InternalOpenFileDevicePath(DevicePath
, FileHandle
, EFI_FILE_MODE_READ
|EFI_FILE_MODE_WRITE
|EFI_FILE_MODE_CREATE
, FileAttribs
); // 0 = no specific file attributes
1146 FreePool(DevicePath
);
1152 Opens a file or a directory by file name.
1154 This function opens the specified file in the specified OpenMode and returns a file
1156 If the file name begins with >v, then the file handle which is returned refers to the
1157 shell environment variable with the specified name. If the shell environment variable
1158 exists, is non-volatile and the OpenMode indicates EFI_FILE_MODE_WRITE, then
1159 EFI_INVALID_PARAMETER is returned.
1161 If the file name is >i, then the file handle which is returned refers to the standard
1162 input. If the OpenMode indicates EFI_FILE_MODE_WRITE, then EFI_INVALID_PARAMETER
1165 If the file name is >o, then the file handle which is returned refers to the standard
1166 output. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER
1169 If the file name is >e, then the file handle which is returned refers to the standard
1170 error. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER
1173 If the file name is NUL, then the file handle that is returned refers to the standard NUL
1174 file. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER is
1177 If return EFI_SUCCESS, the FileHandle is the opened file's handle, else, the
1180 @param FileName Points to the NULL-terminated UCS-2 encoded file name.
1181 @param FileHandle On return, points to the file handle.
1182 @param OpenMode File open mode. Either EFI_FILE_MODE_READ or
1183 EFI_FILE_MODE_WRITE from section 12.4 of the UEFI
1185 @retval EFI_SUCCESS The file was opened. FileHandle has the opened file's handle.
1186 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value. FileHandle is NULL.
1187 @retval EFI_UNSUPPORTED Could not open the file path. FileHandle is NULL.
1188 @retval EFI_NOT_FOUND The specified file could not be found on the device or the file
1189 system could not be found on the device. FileHandle is NULL.
1190 @retval EFI_NO_MEDIA The device has no medium. FileHandle is NULL.
1191 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no
1192 longer supported. FileHandle is NULL.
1193 @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according
1194 the FileName. FileHandle is NULL.
1195 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted. FileHandle is NULL.
1196 @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write
1197 when the media is write-protected. FileHandle is NULL.
1198 @retval EFI_ACCESS_DENIED The service denied access to the file. FileHandle is NULL.
1199 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file. FileHandle
1201 @retval EFI_VOLUME_FULL The volume is full. FileHandle is NULL.
1205 EfiShellOpenFileByName(
1206 IN CONST CHAR16
*FileName
,
1207 OUT SHELL_FILE_HANDLE
*FileHandle
,
1211 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
1217 // Is this for StdIn
1219 if (StrCmp(FileName
, L
">i") == 0) {
1221 // make sure not writing to StdIn
1223 if ((OpenMode
& EFI_FILE_MODE_WRITE
) != 0) {
1224 return (EFI_INVALID_PARAMETER
);
1226 *FileHandle
= ShellInfoObject
.NewShellParametersProtocol
->StdIn
;
1227 ASSERT(*FileHandle
!= NULL
);
1228 return (EFI_SUCCESS
);
1232 // Is this for StdOut
1234 if (StrCmp(FileName
, L
">o") == 0) {
1236 // make sure not writing to StdIn
1238 if ((OpenMode
& EFI_FILE_MODE_READ
) != 0) {
1239 return (EFI_INVALID_PARAMETER
);
1241 *FileHandle
= &FileInterfaceStdOut
;
1242 return (EFI_SUCCESS
);
1246 // Is this for NUL file
1248 if (StrCmp(FileName
, L
"NUL") == 0) {
1249 *FileHandle
= &FileInterfaceNulFile
;
1250 return (EFI_SUCCESS
);
1254 // Is this for StdErr
1256 if (StrCmp(FileName
, L
">e") == 0) {
1258 // make sure not writing to StdIn
1260 if ((OpenMode
& EFI_FILE_MODE_READ
) != 0) {
1261 return (EFI_INVALID_PARAMETER
);
1263 *FileHandle
= &FileInterfaceStdErr
;
1264 return (EFI_SUCCESS
);
1268 // Is this for an environment variable
1269 // do we start with >v
1271 if (StrStr(FileName
, L
">v") == FileName
) {
1272 if (!IsVolatileEnv(FileName
+2) &&
1273 ((OpenMode
& EFI_FILE_MODE_WRITE
) != 0)) {
1274 return (EFI_INVALID_PARAMETER
);
1276 *FileHandle
= CreateFileInterfaceEnv(FileName
+2);
1277 return (EFI_SUCCESS
);
1281 // We are opening a regular file.
1283 DevicePath
= EfiShellGetDevicePathFromFilePath(FileName
);
1284 // DEBUG_CODE(InternalShellProtocolDebugPrintMessage (NULL, DevicePath););
1285 if (DevicePath
== NULL
) {
1286 return (EFI_NOT_FOUND
);
1290 // Copy the device path, open the file, then free the memory
1292 Status
= InternalOpenFileDevicePath(DevicePath
, FileHandle
, OpenMode
, 0); // 0 = no specific file attributes
1293 FreePool(DevicePath
);
1299 Deletes the file specified by the file name.
1301 This function deletes a file.
1303 @param FileName Points to the NULL-terminated file name.
1305 @retval EFI_SUCCESS The file was closed and deleted, and the handle was closed.
1306 @retval EFI_WARN_DELETE_FAILURE The handle was closed but the file was not deleted.
1307 @sa EfiShellCreateFile
1311 EfiShellDeleteFileByName(
1312 IN CONST CHAR16
*FileName
1315 SHELL_FILE_HANDLE FileHandle
;
1319 // get a handle to the file
1321 Status
= EfiShellCreateFile(FileName
,
1324 if (EFI_ERROR(Status
)) {
1328 // now delete the file
1330 return (ShellInfoObject
.NewEfiShellProtocol
->DeleteFile(FileHandle
));
1334 Disables the page break output mode.
1338 EfiShellDisablePageBreak (
1342 ShellInfoObject
.PageBreakEnabled
= FALSE
;
1346 Enables the page break output mode.
1350 EfiShellEnablePageBreak (
1354 ShellInfoObject
.PageBreakEnabled
= TRUE
;
1358 internal worker function to load and run an image via device path.
1360 @param ParentImageHandle A handle of the image that is executing the specified
1362 @param DevicePath device path of the file to execute
1363 @param CommandLine Points to the NULL-terminated UCS-2 encoded string
1364 containing the command line. If NULL then the command-
1366 @param Environment Points to a NULL-terminated array of environment
1367 variables with the format 'x=y', where x is the
1368 environment variable name and y is the value. If this
1369 is NULL, then the current shell environment is used.
1371 @param[out] ExitDataSize ExitDataSize as returned from gBS->StartImage
1372 @param[out] ExitData ExitData as returned from gBS->StartImage
1374 @retval EFI_SUCCESS The command executed successfully. The status code
1375 returned by the command is pointed to by StatusCode.
1376 @retval EFI_INVALID_PARAMETER The parameters are invalid.
1377 @retval EFI_OUT_OF_RESOURCES Out of resources.
1378 @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.
1382 InternalShellExecuteDevicePath(
1383 IN CONST EFI_HANDLE
*ParentImageHandle
,
1384 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
1385 IN CONST CHAR16
*CommandLine OPTIONAL
,
1386 IN CONST CHAR16
**Environment OPTIONAL
,
1387 OUT UINTN
*ExitDataSize OPTIONAL
,
1388 OUT CHAR16
**ExitData OPTIONAL
1392 EFI_STATUS CleanupStatus
;
1393 EFI_HANDLE NewHandle
;
1394 EFI_LOADED_IMAGE_PROTOCOL
*LoadedImage
;
1395 LIST_ENTRY OrigEnvs
;
1396 EFI_SHELL_PARAMETERS_PROTOCOL ShellParamsProtocol
;
1397 UINTN InternalExitDataSize
;
1398 UINTN
*ExitDataSizePtr
;
1400 // ExitDataSize is not OPTIONAL for gBS->BootServices, provide somewhere for
1401 // it to be dumped if the caller doesn't want it.
1402 if (ExitData
== NULL
) {
1403 ExitDataSizePtr
= &InternalExitDataSize
;
1405 ExitDataSizePtr
= ExitDataSize
;
1408 if (ParentImageHandle
== NULL
) {
1409 return (EFI_INVALID_PARAMETER
);
1412 InitializeListHead(&OrigEnvs
);
1417 // Load the image with:
1418 // FALSE - not from boot manager and NULL, 0 being not already in memory
1420 Status
= gBS
->LoadImage(
1423 (EFI_DEVICE_PATH_PROTOCOL
*)DevicePath
,
1428 if (EFI_ERROR(Status
)) {
1429 if (NewHandle
!= NULL
) {
1430 gBS
->UnloadImage(NewHandle
);
1434 Status
= gBS
->OpenProtocol(
1436 &gEfiLoadedImageProtocolGuid
,
1437 (VOID
**)&LoadedImage
,
1440 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
1442 if (!EFI_ERROR(Status
)) {
1443 ASSERT(LoadedImage
->LoadOptionsSize
== 0);
1444 if (CommandLine
!= NULL
) {
1445 LoadedImage
->LoadOptionsSize
= (UINT32
)StrSize(CommandLine
);
1446 LoadedImage
->LoadOptions
= (VOID
*)CommandLine
;
1450 // Save our current environment settings for later restoration if necessary
1452 if (Environment
!= NULL
) {
1453 Status
= GetEnvironmentVariableList(&OrigEnvs
);
1454 if (!EFI_ERROR(Status
)) {
1455 Status
= SetEnvironmentVariables(Environment
);
1460 // Initialize and install a shell parameters protocol on the image.
1462 ShellParamsProtocol
.StdIn
= ShellInfoObject
.NewShellParametersProtocol
->StdIn
;
1463 ShellParamsProtocol
.StdOut
= ShellInfoObject
.NewShellParametersProtocol
->StdOut
;
1464 ShellParamsProtocol
.StdErr
= ShellInfoObject
.NewShellParametersProtocol
->StdErr
;
1465 Status
= UpdateArgcArgv(&ShellParamsProtocol
, CommandLine
, NULL
, NULL
);
1466 ASSERT_EFI_ERROR(Status
);
1467 Status
= gBS
->InstallProtocolInterface(&NewHandle
, &gEfiShellParametersProtocolGuid
, EFI_NATIVE_INTERFACE
, &ShellParamsProtocol
);
1468 ASSERT_EFI_ERROR(Status
);
1470 ///@todo initialize and install ShellInterface protocol on the new image for compatibility if - PcdGetBool(PcdShellSupportOldProtocols)
1473 // now start the image, passing up exit data if the caller requested it
1475 if (!EFI_ERROR(Status
)) {
1476 Status
= gBS
->StartImage(
1484 // Cleanup (and dont overwrite errors)
1486 if (EFI_ERROR(Status
)) {
1487 CleanupStatus
= gBS
->UninstallProtocolInterface(
1489 &gEfiShellParametersProtocolGuid
,
1490 &ShellParamsProtocol
1492 ASSERT_EFI_ERROR(CleanupStatus
);
1494 CleanupStatus
= gBS
->UninstallProtocolInterface(
1496 &gEfiShellParametersProtocolGuid
,
1497 &ShellParamsProtocol
1499 ASSERT_EFI_ERROR(CleanupStatus
);
1503 if (!IsListEmpty(&OrigEnvs
)) {
1504 if (EFI_ERROR(Status
)) {
1505 CleanupStatus
= SetEnvironmentVariableList(&OrigEnvs
);
1506 ASSERT_EFI_ERROR(CleanupStatus
);
1508 CleanupStatus
= SetEnvironmentVariableList(&OrigEnvs
);
1509 ASSERT_EFI_ERROR (CleanupStatus
);
1516 Execute the command line.
1518 This function creates a nested instance of the shell and executes the specified
1519 command (CommandLine) with the specified environment (Environment). Upon return,
1520 the status code returned by the specified command is placed in StatusCode.
1522 If Environment is NULL, then the current environment is used and all changes made
1523 by the commands executed will be reflected in the current environment. If the
1524 Environment is non-NULL, then the changes made will be discarded.
1526 The CommandLine is executed from the current working directory on the current
1529 @param ParentImageHandle A handle of the image that is executing the specified
1531 @param CommandLine Points to the NULL-terminated UCS-2 encoded string
1532 containing the command line. If NULL then the command-
1534 @param Environment Points to a NULL-terminated array of environment
1535 variables with the format 'x=y', where x is the
1536 environment variable name and y is the value. If this
1537 is NULL, then the current shell environment is used.
1538 @param StatusCode Points to the status code returned by the command.
1540 @retval EFI_SUCCESS The command executed successfully. The status code
1541 returned by the command is pointed to by StatusCode.
1542 @retval EFI_INVALID_PARAMETER The parameters are invalid.
1543 @retval EFI_OUT_OF_RESOURCES Out of resources.
1544 @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.
1545 @retval EFI_UNSUPPORTED The support level required for this function is not present.
1547 @sa InternalShellExecuteDevicePath
1552 IN EFI_HANDLE
*ParentImageHandle
,
1553 IN CHAR16
*CommandLine OPTIONAL
,
1554 IN CHAR16
**Environment OPTIONAL
,
1555 OUT EFI_STATUS
*StatusCode OPTIONAL
1560 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
1565 if ((PcdGet8(PcdShellSupportLevel
) < 1)) {
1566 return (EFI_UNSUPPORTED
);
1569 DevPath
= AppendDevicePath (ShellInfoObject
.ImageDevPath
, ShellInfoObject
.FileDevPath
);
1572 Temp
= ConvertDevicePathToText(ShellInfoObject
.FileDevPath
, TRUE
, TRUE
);
1574 Temp
= ConvertDevicePathToText(ShellInfoObject
.ImageDevPath
, TRUE
, TRUE
);
1576 Temp
= ConvertDevicePathToText(DevPath
, TRUE
, TRUE
);
1582 ASSERT((Temp
== NULL
&& Size
== 0) || (Temp
!= NULL
));
1583 StrnCatGrow(&Temp
, &Size
, L
"Shell.efi -_exit ", 0);
1584 StrnCatGrow(&Temp
, &Size
, CommandLine
, 0);
1586 Status
= InternalShellExecuteDevicePath(
1590 (CONST CHAR16
**)Environment
,
1594 if (Status
== EFI_ABORTED
) {
1595 // If the command exited with an error, the shell should put the exit
1596 // status in ExitData, preceded by a null-terminated string.
1597 ASSERT (ExitDataSize
== StrSize (ExitData
) + sizeof (SHELL_STATUS
));
1599 if (StatusCode
!= NULL
) {
1600 // Skip the null-terminated string
1601 ExitData
+= StrLen (ExitData
) + 1;
1603 // Use CopyMem to avoid alignment faults
1604 CopyMem (StatusCode
, ExitData
, sizeof (SHELL_STATUS
));
1606 // Convert from SHELL_STATUS to EFI_STATUS
1607 // EFI_STATUSes have top bit set when they are errors.
1608 // (See UEFI Spec Appendix D)
1609 if (*StatusCode
!= SHELL_SUCCESS
) {
1610 *StatusCode
= (EFI_STATUS
) *StatusCode
| MAX_BIT
;
1613 FreePool (ExitData
);
1614 Status
= EFI_SUCCESS
;
1615 } else if ((StatusCode
!= NULL
) && !EFI_ERROR(Status
)) {
1616 *StatusCode
= EFI_SUCCESS
;
1620 // de-allocate and return
1628 Utility cleanup function for EFI_SHELL_FILE_INFO objects.
1630 1) frees all pointers (non-NULL)
1631 2) Closes the SHELL_FILE_HANDLE
1633 @param FileListNode pointer to the list node to free
1637 InternalFreeShellFileInfoNode(
1638 IN EFI_SHELL_FILE_INFO
*FileListNode
1641 if (FileListNode
->Info
!= NULL
) {
1642 FreePool((VOID
*)FileListNode
->Info
);
1644 if (FileListNode
->FileName
!= NULL
) {
1645 FreePool((VOID
*)FileListNode
->FileName
);
1647 if (FileListNode
->FullName
!= NULL
) {
1648 FreePool((VOID
*)FileListNode
->FullName
);
1650 if (FileListNode
->Handle
!= NULL
) {
1651 ShellInfoObject
.NewEfiShellProtocol
->CloseFile(FileListNode
->Handle
);
1653 FreePool(FileListNode
);
1656 Frees the file list.
1658 This function cleans up the file list and any related data structures. It has no
1659 impact on the files themselves.
1661 @param FileList The file list to free. Type EFI_SHELL_FILE_INFO is
1662 defined in OpenFileList()
1664 @retval EFI_SUCCESS Free the file list successfully.
1665 @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;
1669 EfiShellFreeFileList(
1670 IN EFI_SHELL_FILE_INFO
**FileList
1673 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1675 if (FileList
== NULL
|| *FileList
== NULL
) {
1676 return (EFI_INVALID_PARAMETER
);
1679 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1680 ; !IsListEmpty(&(*FileList
)->Link
)
1681 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1683 RemoveEntryList(&ShellFileListItem
->Link
);
1684 InternalFreeShellFileInfoNode(ShellFileListItem
);
1686 InternalFreeShellFileInfoNode(*FileList
);
1688 return(EFI_SUCCESS
);
1692 Deletes the duplicate file names files in the given file list.
1694 This function deletes the reduplicate files in the given file list.
1696 @param FileList A pointer to the first entry in the file list.
1698 @retval EFI_SUCCESS Always success.
1699 @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;
1703 EfiShellRemoveDupInFileList(
1704 IN EFI_SHELL_FILE_INFO
**FileList
1707 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1708 EFI_SHELL_FILE_INFO
*ShellFileListItem2
;
1710 if (FileList
== NULL
|| *FileList
== NULL
) {
1711 return (EFI_INVALID_PARAMETER
);
1713 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1714 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1715 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1717 for ( ShellFileListItem2
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1718 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem2
->Link
)
1719 ; ShellFileListItem2
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem2
->Link
)
1721 if (gUnicodeCollation
->StriColl(
1723 (CHAR16
*)ShellFileListItem
->FullName
,
1724 (CHAR16
*)ShellFileListItem2
->FullName
) == 0
1726 RemoveEntryList(&ShellFileListItem2
->Link
);
1727 InternalFreeShellFileInfoNode(ShellFileListItem2
);
1731 return (EFI_SUCCESS
);
1734 Allocates and duplicates a EFI_SHELL_FILE_INFO node.
1736 @param[in] Node The node to copy from.
1737 @param[in] Save TRUE to set Node->Handle to NULL, FALSE otherwise.
1739 @retval NULL a memory allocation error ocurred
1740 @return != NULL a pointer to the new node
1742 EFI_SHELL_FILE_INFO
*
1744 InternalDuplicateShellFileInfo(
1745 IN EFI_SHELL_FILE_INFO
*Node
,
1749 EFI_SHELL_FILE_INFO
*NewNode
;
1751 NewNode
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1752 if (NewNode
== NULL
) {
1755 NewNode
->FullName
= AllocateZeroPool(StrSize(Node
->FullName
));
1757 NewNode
->FileName
= AllocateZeroPool(StrSize(Node
->FileName
));
1758 NewNode
->Info
= AllocateZeroPool((UINTN
)Node
->Info
->Size
);
1759 if ( NewNode
->FullName
== NULL
1760 || NewNode
->FileName
== NULL
1761 || NewNode
->Info
== NULL
1765 NewNode
->Status
= Node
->Status
;
1766 NewNode
->Handle
= Node
->Handle
;
1768 Node
->Handle
= NULL
;
1770 StrCpy((CHAR16
*)NewNode
->FullName
, Node
->FullName
);
1771 StrCpy((CHAR16
*)NewNode
->FileName
, Node
->FileName
);
1772 CopyMem(NewNode
->Info
, Node
->Info
, (UINTN
)Node
->Info
->Size
);
1778 Allocates and populates a EFI_SHELL_FILE_INFO structure. if any memory operation
1779 failed it will return NULL.
1781 @param[in] BasePath the Path to prepend onto filename for FullPath
1782 @param[in] Status Status member initial value.
1783 @param[in] FileName FileName member initial value.
1784 @param[in] Handle Handle member initial value.
1785 @param[in] Info Info struct to copy.
1787 @retval NULL An error ocurred.
1788 @return a pointer to the newly allocated structure.
1790 EFI_SHELL_FILE_INFO
*
1792 CreateAndPopulateShellFileInfo(
1793 IN CONST CHAR16
*BasePath
,
1794 IN CONST EFI_STATUS Status
,
1795 IN CONST CHAR16
*FileName
,
1796 IN CONST SHELL_FILE_HANDLE Handle
,
1797 IN CONST EFI_FILE_INFO
*Info
1800 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1807 ShellFileListItem
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1808 if (ShellFileListItem
== NULL
) {
1811 if (Info
!= NULL
&& Info
->Size
!= 0) {
1812 ShellFileListItem
->Info
= AllocateZeroPool((UINTN
)Info
->Size
);
1813 if (ShellFileListItem
->Info
== NULL
) {
1814 FreePool(ShellFileListItem
);
1817 CopyMem(ShellFileListItem
->Info
, Info
, (UINTN
)Info
->Size
);
1819 ShellFileListItem
->Info
= NULL
;
1821 if (FileName
!= NULL
) {
1822 ASSERT(TempString
== NULL
);
1823 ShellFileListItem
->FileName
= StrnCatGrow(&TempString
, 0, FileName
, 0);
1824 if (ShellFileListItem
->FileName
== NULL
) {
1825 FreePool(ShellFileListItem
->Info
);
1826 FreePool(ShellFileListItem
);
1830 ShellFileListItem
->FileName
= NULL
;
1834 if (BasePath
!= NULL
) {
1835 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
1836 TempString
= StrnCatGrow(&TempString
, &Size
, BasePath
, 0);
1837 if (TempString
== NULL
) {
1838 FreePool((VOID
*)ShellFileListItem
->FileName
);
1839 FreePool(ShellFileListItem
->Info
);
1840 FreePool(ShellFileListItem
);
1844 if (ShellFileListItem
->FileName
!= NULL
) {
1845 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
1846 TempString
= StrnCatGrow(&TempString
, &Size
, ShellFileListItem
->FileName
, 0);
1847 if (TempString
== NULL
) {
1848 FreePool((VOID
*)ShellFileListItem
->FileName
);
1849 FreePool(ShellFileListItem
->Info
);
1850 FreePool(ShellFileListItem
);
1855 ShellFileListItem
->FullName
= TempString
;
1856 ShellFileListItem
->Status
= Status
;
1857 ShellFileListItem
->Handle
= Handle
;
1859 return (ShellFileListItem
);
1863 Find all files in a specified directory.
1865 @param FileDirHandle Handle of the directory to search.
1866 @param FileList On return, points to the list of files in the directory
1867 or NULL if there are no files in the directory.
1869 @retval EFI_SUCCESS File information was returned successfully.
1870 @retval EFI_VOLUME_CORRUPTED The file system structures have been corrupted.
1871 @retval EFI_DEVICE_ERROR The device reported an error.
1872 @retval EFI_NO_MEDIA The device media is not present.
1873 @retval EFI_INVALID_PARAMETER The FileDirHandle was not a directory.
1874 @return An error from FileHandleGetFileName().
1878 EfiShellFindFilesInDir(
1879 IN SHELL_FILE_HANDLE FileDirHandle
,
1880 OUT EFI_SHELL_FILE_INFO
**FileList
1883 EFI_SHELL_FILE_INFO
*ShellFileList
;
1884 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1885 EFI_FILE_INFO
*FileInfo
;
1893 Status
= FileHandleGetFileName(FileDirHandle
, &BasePath
);
1894 if (EFI_ERROR(Status
)) {
1898 if (ShellFileHandleGetPath(FileDirHandle
) != NULL
) {
1901 TempString
= StrnCatGrow(&TempString
, &Size
, ShellFileHandleGetPath(FileDirHandle
), 0);
1902 if (TempString
== NULL
) {
1903 SHELL_FREE_NON_NULL(BasePath
);
1904 return (EFI_OUT_OF_RESOURCES
);
1906 TempSpot
= StrStr(TempString
, L
";");
1908 if (TempSpot
!= NULL
) {
1909 *TempSpot
= CHAR_NULL
;
1912 TempString
= StrnCatGrow(&TempString
, &Size
, BasePath
, 0);
1913 if (TempString
== NULL
) {
1914 SHELL_FREE_NON_NULL(BasePath
);
1915 return (EFI_OUT_OF_RESOURCES
);
1917 SHELL_FREE_NON_NULL(BasePath
);
1918 BasePath
= TempString
;
1922 ShellFileList
= NULL
;
1923 ShellFileListItem
= NULL
;
1925 Status
= EFI_SUCCESS
;
1928 for ( Status
= FileHandleFindFirstFile(FileDirHandle
, &FileInfo
)
1929 ; !EFI_ERROR(Status
) && !NoFile
1930 ; Status
= FileHandleFindNextFile(FileDirHandle
, FileInfo
, &NoFile
)
1933 // allocate a new EFI_SHELL_FILE_INFO and populate it...
1935 ShellFileListItem
= CreateAndPopulateShellFileInfo(
1937 EFI_SUCCESS
, // success since we didnt fail to open it...
1939 NULL
, // no handle since not open
1942 if (ShellFileList
== NULL
) {
1943 ShellFileList
= (EFI_SHELL_FILE_INFO
*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1944 ASSERT(ShellFileList
!= NULL
);
1945 InitializeListHead(&ShellFileList
->Link
);
1947 InsertTailList(&ShellFileList
->Link
, &ShellFileListItem
->Link
);
1949 if (EFI_ERROR(Status
)) {
1950 EfiShellFreeFileList(&ShellFileList
);
1953 *FileList
= ShellFileList
;
1955 SHELL_FREE_NON_NULL(BasePath
);
1960 Updates a file name to be preceeded by the mapped drive name
1962 @param[in] BasePath the Mapped drive name to prepend
1963 @param[in, out] Path pointer to pointer to the file name to update.
1966 @retval EFI_OUT_OF_RESOURCES
1971 IN CONST CHAR16
*BasePath
,
1972 IN OUT CHAR16
**Path
1981 ASSERT(Path
!= NULL
);
1982 ASSERT(*Path
!= NULL
);
1983 ASSERT(BasePath
!= NULL
);
1986 // convert a local path to an absolute path
1988 if (StrStr(*Path
, L
":") == NULL
) {
1989 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
1990 StrnCatGrow(&Path2
, &Path2Size
, BasePath
, 0);
1991 if (Path2
== NULL
) {
1992 return (EFI_OUT_OF_RESOURCES
);
1994 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
1995 StrnCatGrow(&Path2
, &Path2Size
, (*Path
)[0] == L
'\\'?(*Path
) + 1 :*Path
, 0);
1996 if (Path2
== NULL
) {
1997 return (EFI_OUT_OF_RESOURCES
);
2004 return (EFI_SUCCESS
);
2008 If FileHandle is a directory then the function reads from FileHandle and reads in
2009 each of the FileInfo structures. If one of them matches the Pattern's first
2010 "level" then it opens that handle and calls itself on that handle.
2012 If FileHandle is a file and matches all of the remaining Pattern (which would be
2013 on its last node), then add a EFI_SHELL_FILE_INFO object for this file to fileList.
2015 Upon a EFI_SUCCESS return fromt he function any the caller is responsible to call
2016 FreeFileList with FileList.
2018 @param[in] FilePattern The FilePattern to check against.
2019 @param[in] UnicodeCollation The pointer to EFI_UNICODE_COLLATION_PROTOCOL structure
2020 @param[in] FileHandle The FileHandle to start with
2021 @param[in, out] FileList pointer to pointer to list of found files.
2022 @param[in] ParentNode The node for the parent. Same file as identified by HANDLE.
2023 @param[in] MapName The file system name this file is on.
2025 @retval EFI_SUCCESS all files were found and the FileList contains a list.
2026 @retval EFI_NOT_FOUND no files were found
2027 @retval EFI_OUT_OF_RESOURCES a memory allocation failed
2032 IN CONST CHAR16
*FilePattern
,
2033 IN EFI_UNICODE_COLLATION_PROTOCOL
*UnicodeCollation
,
2034 IN SHELL_FILE_HANDLE FileHandle
,
2035 IN OUT EFI_SHELL_FILE_INFO
**FileList
,
2036 IN CONST EFI_SHELL_FILE_INFO
*ParentNode OPTIONAL
,
2037 IN CONST CHAR16
*MapName
2041 CONST CHAR16
*NextFilePatternStart
;
2042 CHAR16
*CurrentFilePattern
;
2043 EFI_SHELL_FILE_INFO
*ShellInfo
;
2044 EFI_SHELL_FILE_INFO
*ShellInfoNode
;
2045 EFI_SHELL_FILE_INFO
*NewShellNode
;
2047 CHAR16
*NewFullName
;
2050 if ( FilePattern
== NULL
2051 || UnicodeCollation
== NULL
2054 return (EFI_INVALID_PARAMETER
);
2057 CurrentFilePattern
= NULL
;
2059 if (*FilePattern
== L
'\\') {
2063 for( NextFilePatternStart
= FilePattern
2064 ; *NextFilePatternStart
!= CHAR_NULL
&& *NextFilePatternStart
!= L
'\\'
2065 ; NextFilePatternStart
++);
2067 CurrentFilePattern
= AllocateZeroPool((NextFilePatternStart
-FilePattern
+1)*sizeof(CHAR16
));
2068 ASSERT(CurrentFilePattern
!= NULL
);
2069 StrnCpy(CurrentFilePattern
, FilePattern
, NextFilePatternStart
-FilePattern
);
2071 if (CurrentFilePattern
[0] == CHAR_NULL
2072 &&NextFilePatternStart
[0] == CHAR_NULL
2075 // Add the current parameter FileHandle to the list, then end...
2077 if (ParentNode
== NULL
) {
2078 Status
= EFI_INVALID_PARAMETER
;
2080 NewShellNode
= InternalDuplicateShellFileInfo((EFI_SHELL_FILE_INFO
*)ParentNode
, TRUE
);
2081 if (NewShellNode
== NULL
) {
2082 Status
= EFI_OUT_OF_RESOURCES
;
2084 NewShellNode
->Handle
= NULL
;
2085 if (*FileList
== NULL
) {
2086 *FileList
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2087 InitializeListHead(&((*FileList
)->Link
));
2091 // Add to the returning to use list
2093 InsertTailList(&(*FileList
)->Link
, &NewShellNode
->Link
);
2095 Status
= EFI_SUCCESS
;
2099 Status
= EfiShellFindFilesInDir(FileHandle
, &ShellInfo
);
2101 if (!EFI_ERROR(Status
)){
2102 if (StrStr(NextFilePatternStart
, L
"\\") != NULL
){
2107 for ( ShellInfoNode
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&ShellInfo
->Link
)
2108 ; !IsNull (&ShellInfo
->Link
, &ShellInfoNode
->Link
)
2109 ; ShellInfoNode
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&ShellInfo
->Link
, &ShellInfoNode
->Link
)
2111 if (UnicodeCollation
->MetaiMatch(UnicodeCollation
, (CHAR16
*)ShellInfoNode
->FileName
, CurrentFilePattern
)){
2112 if (ShellInfoNode
->FullName
!= NULL
&& StrStr(ShellInfoNode
->FullName
, L
":") == NULL
) {
2113 Size
= StrSize(ShellInfoNode
->FullName
);
2114 Size
+= StrSize(MapName
) + sizeof(CHAR16
);
2115 NewFullName
= AllocateZeroPool(Size
);
2116 if (NewFullName
== NULL
) {
2117 Status
= EFI_OUT_OF_RESOURCES
;
2119 StrCpy(NewFullName
, MapName
);
2120 StrCat(NewFullName
, ShellInfoNode
->FullName
+1);
2121 FreePool((VOID
*)ShellInfoNode
->FullName
);
2122 ShellInfoNode
->FullName
= NewFullName
;
2125 if (Directory
&& !EFI_ERROR(Status
) && ShellInfoNode
->FullName
!= NULL
&& ShellInfoNode
->FileName
!= NULL
){
2127 // should be a directory
2131 // don't open the . and .. directories
2133 if ( (StrCmp(ShellInfoNode
->FileName
, L
".") != 0)
2134 && (StrCmp(ShellInfoNode
->FileName
, L
"..") != 0)
2139 if (EFI_ERROR(Status
)) {
2143 // Open the directory since we need that handle in the next recursion.
2145 ShellInfoNode
->Status
= EfiShellOpenFileByName (ShellInfoNode
->FullName
, &ShellInfoNode
->Handle
, EFI_FILE_MODE_READ
);
2148 // recurse with the next part of the pattern
2150 Status
= ShellSearchHandle(NextFilePatternStart
, UnicodeCollation
, ShellInfoNode
->Handle
, FileList
, ShellInfoNode
, MapName
);
2152 } else if (!EFI_ERROR(Status
)) {
2158 // copy the information we need into a new Node
2160 NewShellNode
= InternalDuplicateShellFileInfo(ShellInfoNode
, FALSE
);
2161 ASSERT(NewShellNode
!= NULL
);
2162 if (NewShellNode
== NULL
) {
2163 Status
= EFI_OUT_OF_RESOURCES
;
2165 if (*FileList
== NULL
) {
2166 *FileList
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2167 InitializeListHead(&((*FileList
)->Link
));
2171 // Add to the returning to use list
2173 InsertTailList(&(*FileList
)->Link
, &NewShellNode
->Link
);
2176 if (EFI_ERROR(Status
)) {
2180 if (EFI_ERROR(Status
)) {
2181 EfiShellFreeFileList(&ShellInfo
);
2183 Status
= EfiShellFreeFileList(&ShellInfo
);
2188 FreePool(CurrentFilePattern
);
2193 Find files that match a specified pattern.
2195 This function searches for all files and directories that match the specified
2196 FilePattern. The FilePattern can contain wild-card characters. The resulting file
2197 information is placed in the file list FileList.
2199 Wildcards are processed
2200 according to the rules specified in UEFI Shell 2.0 spec section 3.7.1.
2202 The files in the file list are not opened. The OpenMode field is set to 0 and the FileInfo
2203 field is set to NULL.
2205 if *FileList is not NULL then it must be a pre-existing and properly initialized list.
2207 @param FilePattern Points to a NULL-terminated shell file path, including wildcards.
2208 @param FileList On return, points to the start of a file list containing the names
2209 of all matching files or else points to NULL if no matching files
2210 were found. only on a EFI_SUCCESS return will; this be non-NULL.
2212 @retval EFI_SUCCESS Files found. FileList is a valid list.
2213 @retval EFI_NOT_FOUND No files found.
2214 @retval EFI_NO_MEDIA The device has no media
2215 @retval EFI_DEVICE_ERROR The device reported an error
2216 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
2221 IN CONST CHAR16
*FilePattern
,
2222 OUT EFI_SHELL_FILE_INFO
**FileList
2226 CHAR16
*PatternCopy
;
2227 CHAR16
*PatternCurrentLocation
;
2228 EFI_DEVICE_PATH_PROTOCOL
*RootDevicePath
;
2229 SHELL_FILE_HANDLE RootFileHandle
;
2233 if ( FilePattern
== NULL
2235 || StrStr(FilePattern
, L
":") == NULL
2237 return (EFI_INVALID_PARAMETER
);
2239 Status
= EFI_SUCCESS
;
2240 RootDevicePath
= NULL
;
2241 RootFileHandle
= NULL
;
2243 PatternCopy
= AllocateZeroPool(StrSize(FilePattern
));
2244 if (PatternCopy
== NULL
) {
2245 return (EFI_OUT_OF_RESOURCES
);
2247 StrCpy(PatternCopy
, FilePattern
);
2249 PatternCopy
= PathCleanUpDirectories(PatternCopy
);
2251 Count
= StrStr(PatternCopy
, L
":") - PatternCopy
;
2254 ASSERT(MapName
== NULL
);
2255 MapName
= StrnCatGrow(&MapName
, NULL
, PatternCopy
, Count
);
2256 if (MapName
== NULL
) {
2257 Status
= EFI_OUT_OF_RESOURCES
;
2259 RootDevicePath
= EfiShellGetDevicePathFromFilePath(PatternCopy
);
2260 if (RootDevicePath
== NULL
) {
2261 Status
= EFI_INVALID_PARAMETER
;
2263 Status
= EfiShellOpenRoot(RootDevicePath
, &RootFileHandle
);
2264 if (!EFI_ERROR(Status
)) {
2265 for ( PatternCurrentLocation
= PatternCopy
2266 ; *PatternCurrentLocation
!= ':'
2267 ; PatternCurrentLocation
++);
2268 PatternCurrentLocation
++;
2269 Status
= ShellSearchHandle(PatternCurrentLocation
, gUnicodeCollation
, RootFileHandle
, FileList
, NULL
, MapName
);
2271 FreePool(RootDevicePath
);
2275 SHELL_FREE_NON_NULL(PatternCopy
);
2276 SHELL_FREE_NON_NULL(MapName
);
2282 Opens the files that match the path specified.
2284 This function opens all of the files specified by Path. Wildcards are processed
2285 according to the rules specified in UEFI Shell 2.0 spec section 3.7.1. Each
2286 matching file has an EFI_SHELL_FILE_INFO structure created in a linked list.
2288 @param Path A pointer to the path string.
2289 @param OpenMode Specifies the mode used to open each file, EFI_FILE_MODE_READ or
2290 EFI_FILE_MODE_WRITE.
2291 @param FileList Points to the start of a list of files opened.
2293 @retval EFI_SUCCESS Create the file list successfully.
2294 @return Others Can't create the file list.
2298 EfiShellOpenFileList(
2301 IN OUT EFI_SHELL_FILE_INFO
**FileList
2305 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
2308 CONST CHAR16
*CurDir
;
2311 PathCleanUpDirectories(Path
);
2316 if (FileList
== NULL
|| *FileList
== NULL
) {
2317 return (EFI_INVALID_PARAMETER
);
2320 if (*Path
== L
'.' && *(Path
+1) == L
'\\') {
2325 // convert a local path to an absolute path
2327 if (StrStr(Path
, L
":") == NULL
) {
2328 CurDir
= EfiShellGetCurDir(NULL
);
2329 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2330 StrnCatGrow(&Path2
, &Path2Size
, CurDir
, 0);
2331 if (*Path
== L
'\\') {
2333 while (PathRemoveLastItem(Path2
)) ;
2335 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2336 StrnCatGrow(&Path2
, &Path2Size
, Path
, 0);
2338 ASSERT(Path2
== NULL
);
2339 StrnCatGrow(&Path2
, NULL
, Path
, 0);
2342 PathCleanUpDirectories (Path2
);
2347 Status
= EfiShellFindFiles(Path2
, FileList
);
2351 if (EFI_ERROR(Status
)) {
2357 // We had no errors so open all the files (that are not already opened...)
2359 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
2360 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
2361 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
2363 if (ShellFileListItem
->Status
== 0 && ShellFileListItem
->Handle
== NULL
) {
2364 ShellFileListItem
->Status
= EfiShellOpenFileByName (ShellFileListItem
->FullName
, &ShellFileListItem
->Handle
, OpenMode
);
2370 return (EFI_NOT_FOUND
);
2372 return(EFI_SUCCESS
);
2376 This function updated with errata.
2378 Gets either a single or list of environment variables.
2380 If name is not NULL then this function returns the current value of the specified
2381 environment variable.
2383 If Name is NULL, then a list of all environment variable names is returned. Each is a
2384 NULL terminated string with a double NULL terminating the list.
2386 @param Name A pointer to the environment variable name. If
2387 Name is NULL, then the function will return all
2388 of the defined shell environment variables. In
2389 the case where multiple environment variables are
2390 being returned, each variable will be terminated by
2391 a NULL, and the list will be terminated by a double
2394 @return !=NULL A pointer to the returned string.
2395 The returned pointer does not need to be freed by the caller.
2397 @retval NULL The environment variable doesn't exist or there are
2398 no environment variables.
2403 IN CONST CHAR16
*Name
2411 CHAR16
*CurrentWriteLocation
;
2418 // Get all our environment variables
2420 InitializeListHead(&List
);
2421 Status
= GetEnvironmentVariableList(&List
);
2422 if (EFI_ERROR(Status
)){
2427 // Build the semi-colon delimited list. (2 passes)
2429 for ( Node
= (ENV_VAR_LIST
*)GetFirstNode(&List
)
2430 ; !IsNull(&List
, &Node
->Link
)
2431 ; Node
= (ENV_VAR_LIST
*)GetNextNode(&List
, &Node
->Link
)
2433 ASSERT(Node
->Key
!= NULL
);
2434 Size
+= StrSize(Node
->Key
);
2437 Size
+= 2*sizeof(CHAR16
);
2439 Buffer
= AllocateZeroPool(Size
);
2440 if (Buffer
== NULL
) {
2441 if (!IsListEmpty (&List
)) {
2442 FreeEnvironmentVariableList(&List
);
2446 CurrentWriteLocation
= (CHAR16
*)Buffer
;
2448 for ( Node
= (ENV_VAR_LIST
*)GetFirstNode(&List
)
2449 ; !IsNull(&List
, &Node
->Link
)
2450 ; Node
= (ENV_VAR_LIST
*)GetNextNode(&List
, &Node
->Link
)
2452 ASSERT(Node
->Key
!= NULL
);
2453 StrCpy(CurrentWriteLocation
, Node
->Key
);
2454 CurrentWriteLocation
+= StrLen(CurrentWriteLocation
) + 1;
2460 if (!IsListEmpty (&List
)) {
2461 FreeEnvironmentVariableList(&List
);
2465 // We are doing a specific environment variable
2469 // get the size we need for this EnvVariable
2471 Status
= SHELL_GET_ENVIRONMENT_VARIABLE(Name
, &Size
, Buffer
);
2472 if (Status
== EFI_BUFFER_TOO_SMALL
) {
2474 // Allocate the space and recall the get function
2476 Buffer
= AllocateZeroPool(Size
);
2477 ASSERT(Buffer
!= NULL
);
2478 Status
= SHELL_GET_ENVIRONMENT_VARIABLE(Name
, &Size
, Buffer
);
2481 // we didnt get it (might not exist)
2482 // free the memory if we allocated any and return NULL
2484 if (EFI_ERROR(Status
)) {
2485 if (Buffer
!= NULL
) {
2493 // return the buffer
2495 return (AddBufferToFreeList(Buffer
));
2499 Internal variable setting function. Allows for setting of the read only variables.
2501 @param Name Points to the NULL-terminated environment variable name.
2502 @param Value Points to the NULL-terminated environment variable value. If the value is an
2503 empty string then the environment variable is deleted.
2504 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
2506 @retval EFI_SUCCESS The environment variable was successfully updated.
2510 InternalEfiShellSetEnv(
2511 IN CONST CHAR16
*Name
,
2512 IN CONST CHAR16
*Value
,
2516 if (Value
== NULL
|| StrLen(Value
) == 0) {
2517 return (SHELL_DELETE_ENVIRONMENT_VARIABLE(Name
));
2519 SHELL_DELETE_ENVIRONMENT_VARIABLE(Name
);
2521 return (SHELL_SET_ENVIRONMENT_VARIABLE_V(Name
, StrSize(Value
), Value
));
2523 return (SHELL_SET_ENVIRONMENT_VARIABLE_NV(Name
, StrSize(Value
), Value
));
2529 Sets the environment variable.
2531 This function changes the current value of the specified environment variable. If the
2532 environment variable exists and the Value is an empty string, then the environment
2533 variable is deleted. If the environment variable exists and the Value is not an empty
2534 string, then the value of the environment variable is changed. If the environment
2535 variable does not exist and the Value is an empty string, there is no action. If the
2536 environment variable does not exist and the Value is a non-empty string, then the
2537 environment variable is created and assigned the specified value.
2539 For a description of volatile and non-volatile environment variables, see UEFI Shell
2540 2.0 specification section 3.6.1.
2542 @param Name Points to the NULL-terminated environment variable name.
2543 @param Value Points to the NULL-terminated environment variable value. If the value is an
2544 empty string then the environment variable is deleted.
2545 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
2547 @retval EFI_SUCCESS The environment variable was successfully updated.
2552 IN CONST CHAR16
*Name
,
2553 IN CONST CHAR16
*Value
,
2557 if (Name
== NULL
|| *Name
== CHAR_NULL
) {
2558 return (EFI_INVALID_PARAMETER
);
2561 // Make sure we dont 'set' a predefined read only variable
2563 if (gUnicodeCollation
->StriColl(
2567 ||gUnicodeCollation
->StriColl(
2571 ||gUnicodeCollation
->StriColl(
2575 ||gUnicodeCollation
->StriColl(
2578 L
"uefishellsupport") == 0
2579 ||gUnicodeCollation
->StriColl(
2582 L
"uefishellversion") == 0
2583 ||gUnicodeCollation
->StriColl(
2586 L
"uefiversion") == 0
2588 return (EFI_INVALID_PARAMETER
);
2590 return (InternalEfiShellSetEnv(Name
, Value
, Volatile
));
2594 Returns the current directory on the specified device.
2596 If FileSystemMapping is NULL, it returns the current working directory. If the
2597 FileSystemMapping is not NULL, it returns the current directory associated with the
2598 FileSystemMapping. In both cases, the returned name includes the file system
2599 mapping (i.e. fs0:\current-dir).
2601 @param FileSystemMapping A pointer to the file system mapping. If NULL,
2602 then the current working directory is returned.
2604 @retval !=NULL The current directory.
2605 @retval NULL Current directory does not exist.
2610 IN CONST CHAR16
*FileSystemMapping OPTIONAL
2613 CHAR16
*PathToReturn
;
2615 SHELL_MAP_LIST
*MapListItem
;
2616 if (!IsListEmpty(&gShellMapList
.Link
)) {
2618 // if parameter is NULL, use current
2620 if (FileSystemMapping
== NULL
) {
2621 return (EfiShellGetEnv(L
"cwd"));
2624 PathToReturn
= NULL
;
2625 MapListItem
= ShellCommandFindMapItem(FileSystemMapping
);
2626 if (MapListItem
!= NULL
) {
2627 ASSERT((PathToReturn
== NULL
&& Size
== 0) || (PathToReturn
!= NULL
));
2628 PathToReturn
= StrnCatGrow(&PathToReturn
, &Size
, MapListItem
->MapName
, 0);
2629 PathToReturn
= StrnCatGrow(&PathToReturn
, &Size
, MapListItem
->CurrentDirectoryPath
, 0);
2632 return (AddBufferToFreeList(PathToReturn
));
2639 Changes the current directory on the specified device.
2641 If the FileSystem is NULL, and the directory Dir does not contain a file system's
2642 mapped name, this function changes the current working directory.
2644 If the FileSystem is NULL and the directory Dir contains a mapped name, then the
2645 current file system and the current directory on that file system are changed.
2647 If FileSystem is NULL, and Dir is not NULL, then this changes the current working file
2650 If FileSystem is not NULL and Dir is not NULL, then this function changes the current
2651 directory on the specified file system.
2653 If the current working directory or the current working file system is changed then the
2654 %cwd% environment variable will be updated
2656 @param FileSystem A pointer to the file system's mapped name. If NULL, then the current working
2657 directory is changed.
2658 @param Dir Points to the NULL-terminated directory on the device specified by FileSystem.
2660 @retval EFI_SUCCESS The operation was sucessful
2661 @retval EFI_NOT_FOUND The file system could not be found
2666 IN CONST CHAR16
*FileSystem OPTIONAL
,
2667 IN CONST CHAR16
*Dir
2671 SHELL_MAP_LIST
*MapListItem
;
2675 CHAR16
*DirectoryName
;
2682 DirectoryName
= NULL
;
2684 if ((FileSystem
== NULL
&& Dir
== NULL
) || Dir
== NULL
) {
2685 return (EFI_INVALID_PARAMETER
);
2688 if (IsListEmpty(&gShellMapList
.Link
)){
2689 return (EFI_NOT_FOUND
);
2692 DirectoryName
= StrnCatGrow(&DirectoryName
, NULL
, Dir
, 0);
2693 ASSERT(DirectoryName
!= NULL
);
2695 PathCleanUpDirectories(DirectoryName
);
2697 if (FileSystem
== NULL
) {
2699 // determine the file system mapping to use
2701 if (StrStr(DirectoryName
, L
":") != NULL
) {
2702 ASSERT(MapName
== NULL
);
2703 MapName
= StrnCatGrow(&MapName
, NULL
, DirectoryName
, (StrStr(DirectoryName
, L
":")-DirectoryName
+1));
2706 // find the file system mapping's entry in the list
2709 if (MapName
!= NULL
) {
2710 MapListItem
= ShellCommandFindMapItem(MapName
);
2713 // make that the current file system mapping
2715 if (MapListItem
!= NULL
) {
2716 gShellCurDir
= MapListItem
;
2719 MapListItem
= gShellCurDir
;
2722 if (MapListItem
== NULL
) {
2723 return (EFI_NOT_FOUND
);
2727 // now update the MapListItem's current directory
2729 if (MapListItem
->CurrentDirectoryPath
!= NULL
&& DirectoryName
[StrLen(DirectoryName
) - 1] != L
':') {
2730 FreePool(MapListItem
->CurrentDirectoryPath
);
2731 MapListItem
->CurrentDirectoryPath
= NULL
;
2733 if (MapName
!= NULL
) {
2734 TempLen
= StrLen(MapName
);
2735 if (TempLen
!= StrLen(DirectoryName
)) {
2736 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2737 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
+StrLen(MapName
), 0);
2740 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2741 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
, 0);
2743 if ((MapListItem
->CurrentDirectoryPath
!= NULL
&& MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] != L
'\\') || (MapListItem
->CurrentDirectoryPath
== NULL
)) {
2744 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2745 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, L
"\\", 0);
2749 // cant have a mapping in the directory...
2751 if (StrStr(DirectoryName
, L
":") != NULL
) {
2752 return (EFI_INVALID_PARAMETER
);
2755 // FileSystem != NULL
2757 MapListItem
= ShellCommandFindMapItem(FileSystem
);
2758 if (MapListItem
== NULL
) {
2759 return (EFI_INVALID_PARAMETER
);
2761 // gShellCurDir = MapListItem;
2762 if (DirectoryName
!= NULL
) {
2764 // change current dir on that file system
2767 if (MapListItem
->CurrentDirectoryPath
!= NULL
) {
2768 FreePool(MapListItem
->CurrentDirectoryPath
);
2769 DEBUG_CODE(MapListItem
->CurrentDirectoryPath
= NULL
;);
2771 // ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));
2772 // MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, FileSystem, 0);
2773 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2774 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, L
"\\", 0);
2775 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2776 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
, 0);
2777 if (MapListItem
->CurrentDirectoryPath
!= NULL
&& MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] != L
'\\') {
2778 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2779 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, L
"\\", 0);
2784 // if updated the current directory then update the environment variable
2786 if (MapListItem
== gShellCurDir
) {
2788 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
2789 StrnCatGrow(&TempString
, &Size
, MapListItem
->MapName
, 0);
2790 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
2791 StrnCatGrow(&TempString
, &Size
, MapListItem
->CurrentDirectoryPath
, 0);
2792 Status
= InternalEfiShellSetEnv(L
"cwd", TempString
, TRUE
);
2793 FreePool(TempString
);
2796 return(EFI_SUCCESS
);
2800 Return help information about a specific command.
2802 This function returns the help information for the specified command. The help text
2803 can be internal to the shell or can be from a UEFI Shell manual page.
2805 If Sections is specified, then each section name listed will be compared in a casesensitive
2806 manner, to the section names described in Appendix B. If the section exists,
2807 it will be appended to the returned help text. If the section does not exist, no
2808 information will be returned. If Sections is NULL, then all help text information
2809 available will be returned.
2811 @param Command Points to the NULL-terminated UEFI Shell command name.
2812 @param Sections Points to the NULL-terminated comma-delimited
2813 section names to return. If NULL, then all
2814 sections will be returned.
2815 @param HelpText On return, points to a callee-allocated buffer
2816 containing all specified help text.
2818 @retval EFI_SUCCESS The help text was returned.
2819 @retval EFI_OUT_OF_RESOURCES The necessary buffer could not be allocated to hold the
2821 @retval EFI_INVALID_PARAMETER HelpText is NULL
2822 @retval EFI_NOT_FOUND There is no help text available for Command.
2826 EfiShellGetHelpText(
2827 IN CONST CHAR16
*Command
,
2828 IN CONST CHAR16
*Sections OPTIONAL
,
2829 OUT CHAR16
**HelpText
2832 CONST CHAR16
*ManFileName
;
2836 ASSERT(HelpText
!= NULL
);
2839 ManFileName
= ShellCommandGetManFileNameHandler(Command
);
2841 if (ManFileName
!= NULL
) {
2842 return (ProcessManFile(ManFileName
, Command
, Sections
, NULL
, HelpText
));
2844 if ((StrLen(Command
)> 4)
2845 && (Command
[StrLen(Command
)-1] == L
'i' || Command
[StrLen(Command
)-1] == L
'I')
2846 && (Command
[StrLen(Command
)-2] == L
'f' || Command
[StrLen(Command
)-2] == L
'F')
2847 && (Command
[StrLen(Command
)-3] == L
'e' || Command
[StrLen(Command
)-3] == L
'E')
2848 && (Command
[StrLen(Command
)-4] == L
'.')
2850 FixCommand
= AllocateZeroPool(StrSize(Command
) - 4 * sizeof (CHAR16
));
2851 ASSERT(FixCommand
!= NULL
);
2853 StrnCpy(FixCommand
, Command
, StrLen(Command
)-4);
2854 Status
= ProcessManFile(FixCommand
, FixCommand
, Sections
, NULL
, HelpText
);
2855 FreePool(FixCommand
);
2858 return (ProcessManFile(Command
, Command
, Sections
, NULL
, HelpText
));
2864 Gets the enable status of the page break output mode.
2866 User can use this function to determine current page break mode.
2868 @retval TRUE The page break output mode is enabled.
2869 @retval FALSE The page break output mode is disabled.
2873 EfiShellGetPageBreak(
2877 return(ShellInfoObject
.PageBreakEnabled
);
2881 Judges whether the active shell is the root shell.
2883 This function makes the user to know that whether the active Shell is the root shell.
2885 @retval TRUE The active Shell is the root Shell.
2886 @retval FALSE The active Shell is NOT the root Shell.
2890 EfiShellIsRootShell(
2894 return(ShellInfoObject
.RootShellInstance
);
2898 function to return a semi-colon delimeted list of all alias' in the current shell
2900 up to caller to free the memory.
2902 @retval NULL No alias' were found
2903 @retval NULL An error ocurred getting alias'
2904 @return !NULL a list of all alias'
2908 InternalEfiShellGetListAlias(
2916 CHAR16
*VariableName
;
2921 Status
= gRT
->QueryVariableInfo(EFI_VARIABLE_NON_VOLATILE
|EFI_VARIABLE_BOOTSERVICE_ACCESS
, &MaxStorSize
, &RemStorSize
, &MaxVarSize
);
2922 ASSERT_EFI_ERROR(Status
);
2924 VariableName
= AllocateZeroPool((UINTN
)MaxVarSize
);
2928 if (VariableName
== NULL
) {
2932 VariableName
[0] = CHAR_NULL
;
2935 NameSize
= (UINTN
)MaxVarSize
;
2936 Status
= gRT
->GetNextVariableName(&NameSize
, VariableName
, &Guid
);
2937 if (Status
== EFI_NOT_FOUND
){
2940 ASSERT_EFI_ERROR(Status
);
2941 if (EFI_ERROR(Status
)) {
2944 if (CompareGuid(&Guid
, &gShellAliasGuid
)){
2945 ASSERT((RetVal
== NULL
&& RetSize
== 0) || (RetVal
!= NULL
));
2946 RetVal
= StrnCatGrow(&RetVal
, &RetSize
, VariableName
, 0);
2947 RetVal
= StrnCatGrow(&RetVal
, &RetSize
, L
";", 0);
2950 FreePool(VariableName
);
2956 This function returns the command associated with a alias or a list of all
2959 @param[in] Alias Points to the NULL-terminated shell alias.
2960 If this parameter is NULL, then all
2961 aliases will be returned in ReturnedData.
2962 @param[out] Volatile upon return of a single command if TRUE indicates
2963 this is stored in a volatile fashion. FALSE otherwise.
2965 @return If Alias is not NULL, it will return a pointer to
2966 the NULL-terminated command for that alias.
2967 If Alias is NULL, ReturnedData points to a ';'
2968 delimited list of alias (e.g.
2969 ReturnedData = "dir;del;copy;mfp") that is NULL-terminated.
2970 @retval NULL an error ocurred
2971 @retval NULL Alias was not a valid Alias
2976 IN CONST CHAR16
*Alias
,
2977 OUT BOOLEAN
*Volatile OPTIONAL
2985 if (Alias
!= NULL
) {
2986 if (Volatile
== NULL
) {
2987 return (AddBufferToFreeList(GetVariable((CHAR16
*)Alias
, &gShellAliasGuid
)));
2991 Status
= gRT
->GetVariable((CHAR16
*)Alias
, &gShellAliasGuid
, &Attribs
, &RetSize
, RetVal
);
2992 if (Status
== EFI_BUFFER_TOO_SMALL
) {
2993 RetVal
= AllocateZeroPool(RetSize
);
2994 Status
= gRT
->GetVariable((CHAR16
*)Alias
, &gShellAliasGuid
, &Attribs
, &RetSize
, RetVal
);
2996 if (EFI_ERROR(Status
)) {
2997 if (RetVal
!= NULL
) {
3002 if ((EFI_VARIABLE_NON_VOLATILE
& Attribs
) == EFI_VARIABLE_NON_VOLATILE
) {
3008 return (AddBufferToFreeList(RetVal
));
3010 return (AddBufferToFreeList(InternalEfiShellGetListAlias()));
3014 Changes a shell command alias.
3016 This function creates an alias for a shell command or if Alias is NULL it will delete an existing alias.
3018 this function does not check for built in alias'.
3020 @param[in] Command Points to the NULL-terminated shell command or existing alias.
3021 @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and
3022 Command refers to an alias, that alias will be deleted.
3023 @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the
3024 Alias being set will be stored in a non-volatile fashion.
3026 @retval EFI_SUCCESS Alias created or deleted successfully.
3027 @retval EFI_NOT_FOUND the Alias intended to be deleted was not found
3032 IN CONST CHAR16
*Command
,
3033 IN CONST CHAR16
*Alias
,
3038 // We must be trying to remove one if Alias is NULL
3040 if (Alias
== NULL
) {
3042 // remove an alias (but passed in COMMAND parameter)
3044 return (gRT
->SetVariable((CHAR16
*)Command
, &gShellAliasGuid
, 0, 0, NULL
));
3047 // Add and replace are the same
3050 // We dont check the error return on purpose since the variable may not exist.
3051 gRT
->SetVariable((CHAR16
*)Command
, &gShellAliasGuid
, 0, 0, NULL
);
3053 return (gRT
->SetVariable((CHAR16
*)Alias
, &gShellAliasGuid
, EFI_VARIABLE_BOOTSERVICE_ACCESS
|(Volatile
?0:EFI_VARIABLE_NON_VOLATILE
), StrSize(Command
), (VOID
*)Command
));
3058 Changes a shell command alias.
3060 This function creates an alias for a shell command or if Alias is NULL it will delete an existing alias.
3063 @param[in] Command Points to the NULL-terminated shell command or existing alias.
3064 @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and
3065 Command refers to an alias, that alias will be deleted.
3066 @param[in] Replace If TRUE and the alias already exists, then the existing alias will be replaced. If
3067 FALSE and the alias already exists, then the existing alias is unchanged and
3068 EFI_ACCESS_DENIED is returned.
3069 @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the
3070 Alias being set will be stored in a non-volatile fashion.
3072 @retval EFI_SUCCESS Alias created or deleted successfully.
3073 @retval EFI_NOT_FOUND the Alias intended to be deleted was not found
3074 @retval EFI_ACCESS_DENIED The alias is a built-in alias or already existed and Replace was set to
3080 IN CONST CHAR16
*Command
,
3081 IN CONST CHAR16
*Alias
,
3087 // cant set over a built in alias
3089 if (ShellCommandIsOnAliasList(Alias
==NULL
?Command
:Alias
)) {
3090 return (EFI_ACCESS_DENIED
);
3092 if (Command
== NULL
|| *Command
== CHAR_NULL
|| StrLen(Command
) == 0) {
3093 return (EFI_INVALID_PARAMETER
);
3096 if (EfiShellGetAlias(Command
, NULL
) != NULL
&& !Replace
) {
3097 return (EFI_ACCESS_DENIED
);
3100 return (InternalSetAlias(Command
, Alias
, Volatile
));
3103 // Pure FILE_HANDLE operations are passed to FileHandleLib
3104 // these functions are indicated by the *
3105 EFI_SHELL_PROTOCOL mShellProtocol
= {
3111 EfiShellGetHelpText
,
3112 EfiShellGetDevicePathFromMap
,
3113 EfiShellGetMapFromDevicePath
,
3114 EfiShellGetDevicePathFromFilePath
,
3115 EfiShellGetFilePathFromDevicePath
,
3119 EfiShellOpenFileList
,
3120 EfiShellFreeFileList
,
3121 EfiShellRemoveDupInFileList
,
3122 EfiShellBatchIsActive
,
3123 EfiShellIsRootShell
,
3124 EfiShellEnablePageBreak
,
3125 EfiShellDisablePageBreak
,
3126 EfiShellGetPageBreak
,
3127 EfiShellGetDeviceName
,
3128 (EFI_SHELL_GET_FILE_INFO
)FileHandleGetInfo
, //*
3129 (EFI_SHELL_SET_FILE_INFO
)FileHandleSetInfo
, //*
3130 EfiShellOpenFileByName
,
3133 (EFI_SHELL_READ_FILE
)FileHandleRead
, //*
3134 (EFI_SHELL_WRITE_FILE
)FileHandleWrite
, //*
3135 (EFI_SHELL_DELETE_FILE
)FileHandleDelete
, //*
3136 EfiShellDeleteFileByName
,
3137 (EFI_SHELL_GET_FILE_POSITION
)FileHandleGetPosition
, //*
3138 (EFI_SHELL_SET_FILE_POSITION
)FileHandleSetPosition
, //*
3139 (EFI_SHELL_FLUSH_FILE
)FileHandleFlush
, //*
3141 EfiShellFindFilesInDir
,
3142 (EFI_SHELL_GET_FILE_SIZE
)FileHandleGetSize
, //*
3144 EfiShellOpenRootByHandle
,
3146 SHELL_MAJOR_VERSION
,
3151 Function to create and install on the current handle.
3153 Will overwrite any existing ShellProtocols in the system to be sure that
3154 the current shell is in control.
3156 This must be removed via calling CleanUpShellProtocol().
3158 @param[in, out] NewShell The pointer to the pointer to the structure
3161 @retval EFI_SUCCESS The operation was successful.
3162 @return An error from LocateHandle, CreateEvent, or other core function.
3166 CreatePopulateInstallShellProtocol (
3167 IN OUT EFI_SHELL_PROTOCOL
**NewShell
3173 UINTN HandleCounter
;
3174 SHELL_PROTOCOL_HANDLE_LIST
*OldProtocolNode
;
3176 if (NewShell
== NULL
) {
3177 return (EFI_INVALID_PARAMETER
);
3182 OldProtocolNode
= NULL
;
3183 InitializeListHead(&ShellInfoObject
.OldShellList
.Link
);
3186 // Initialize EfiShellProtocol object...
3188 Status
= gBS
->CreateEvent(0,
3192 &mShellProtocol
.ExecutionBreak
);
3193 if (EFI_ERROR(Status
)) {
3198 // Get the size of the buffer we need.
3200 Status
= gBS
->LocateHandle(ByProtocol
,
3201 &gEfiShellProtocolGuid
,
3205 if (Status
== EFI_BUFFER_TOO_SMALL
) {
3207 // Allocate and recall with buffer of correct size
3209 Buffer
= AllocateZeroPool(BufferSize
);
3210 if (Buffer
== NULL
) {
3211 return (EFI_OUT_OF_RESOURCES
);
3213 Status
= gBS
->LocateHandle(ByProtocol
,
3214 &gEfiShellProtocolGuid
,
3218 if (EFI_ERROR(Status
)) {
3223 // now overwrite each of them, but save the info to restore when we end.
3225 for (HandleCounter
= 0 ; HandleCounter
< (BufferSize
/sizeof(EFI_HANDLE
)) ; HandleCounter
++) {
3226 OldProtocolNode
= AllocateZeroPool(sizeof(SHELL_PROTOCOL_HANDLE_LIST
));
3227 ASSERT(OldProtocolNode
!= NULL
);
3228 Status
= gBS
->OpenProtocol(Buffer
[HandleCounter
],
3229 &gEfiShellProtocolGuid
,
3230 (VOID
**) &(OldProtocolNode
->Interface
),
3233 EFI_OPEN_PROTOCOL_GET_PROTOCOL
3235 if (!EFI_ERROR(Status
)) {
3237 // reinstall over the old one...
3239 OldProtocolNode
->Handle
= Buffer
[HandleCounter
];
3240 Status
= gBS
->ReinstallProtocolInterface(
3241 OldProtocolNode
->Handle
,
3242 &gEfiShellProtocolGuid
,
3243 OldProtocolNode
->Interface
,
3244 (VOID
*)(&mShellProtocol
));
3245 if (!EFI_ERROR(Status
)) {
3247 // we reinstalled sucessfully. log this so we can reverse it later.
3251 // add to the list for subsequent...
3253 InsertTailList(&ShellInfoObject
.OldShellList
.Link
, &OldProtocolNode
->Link
);
3258 } else if (Status
== EFI_NOT_FOUND
) {
3259 ASSERT(IsListEmpty(&ShellInfoObject
.OldShellList
.Link
));
3261 // no one else published yet. just publish it ourselves.
3263 Status
= gBS
->InstallProtocolInterface (
3265 &gEfiShellProtocolGuid
,
3266 EFI_NATIVE_INTERFACE
,
3267 (VOID
*)(&mShellProtocol
));
3270 if (PcdGetBool(PcdShellSupportOldProtocols
)){
3271 ///@todo support ShellEnvironment2
3272 ///@todo do we need to support ShellEnvironment (not ShellEnvironment2) also?
3275 if (!EFI_ERROR(Status
)) {
3276 *NewShell
= &mShellProtocol
;
3282 Opposite of CreatePopulateInstallShellProtocol.
3284 Free all memory and restore the system to the state it was in before calling
3285 CreatePopulateInstallShellProtocol.
3287 @param[in, out] NewShell The pointer to the new shell protocol structure.
3289 @retval EFI_SUCCESS The operation was successful.
3293 CleanUpShellProtocol (
3294 IN OUT EFI_SHELL_PROTOCOL
*NewShell
3298 SHELL_PROTOCOL_HANDLE_LIST
*Node2
;
3299 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*SimpleEx
;
3302 // if we need to restore old protocols...
3304 if (!IsListEmpty(&ShellInfoObject
.OldShellList
.Link
)) {
3305 for (Node2
= (SHELL_PROTOCOL_HANDLE_LIST
*)GetFirstNode(&ShellInfoObject
.OldShellList
.Link
)
3306 ; !IsListEmpty (&ShellInfoObject
.OldShellList
.Link
)
3307 ; Node2
= (SHELL_PROTOCOL_HANDLE_LIST
*)GetFirstNode(&ShellInfoObject
.OldShellList
.Link
)
3309 RemoveEntryList(&Node2
->Link
);
3310 Status
= gBS
->ReinstallProtocolInterface(Node2
->Handle
,
3311 &gEfiShellProtocolGuid
,
3318 // no need to restore
3320 Status
= gBS
->UninstallProtocolInterface(gImageHandle
,
3321 &gEfiShellProtocolGuid
,
3324 Status
= gBS
->CloseEvent(NewShell
->ExecutionBreak
);
3325 NewShell
->ExecutionBreak
= NULL
;
3327 Status
= gBS
->OpenProtocol(
3328 gST
->ConsoleInHandle
,
3329 &gEfiSimpleTextInputExProtocolGuid
,
3333 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
3335 if (!EFI_ERROR (Status
)) {
3336 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle1
);
3337 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle2
);
3338 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle3
);
3339 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle4
);
3340 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle1
);
3341 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle2
);
3342 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle3
);
3343 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle4
);
3349 Notification function for keystrokes.
3351 @param[in] KeyData The key that was pressed.
3353 @retval EFI_SUCCESS The operation was successful.
3357 NotificationFunction(
3358 IN EFI_KEY_DATA
*KeyData
3361 if ( ((KeyData
->Key
.UnicodeChar
== L
'c') &&
3362 (KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
) || KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
))) ||
3363 (KeyData
->Key
.UnicodeChar
== 3)
3365 if (ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
== NULL
) {
3366 return (EFI_UNSUPPORTED
);
3368 return (gBS
->SignalEvent(ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
));
3369 } else if ((KeyData
->Key
.UnicodeChar
== L
's') &&
3370 (KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
) || KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
))
3372 ShellInfoObject
.HaltOutput
= TRUE
;
3374 return (EFI_SUCCESS
);
3378 Function to start monitoring for CTRL-C using SimpleTextInputEx. This
3379 feature's enabled state was not known when the shell initially launched.
3381 @retval EFI_SUCCESS The feature is enabled.
3382 @retval EFI_OUT_OF_RESOURCES There is not enough mnemory available.
3386 InernalEfiShellStartMonitor(
3390 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*SimpleEx
;
3391 EFI_KEY_DATA KeyData
;
3394 Status
= gBS
->OpenProtocol(
3395 gST
->ConsoleInHandle
,
3396 &gEfiSimpleTextInputExProtocolGuid
,
3400 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
3401 if (EFI_ERROR(Status
)) {
3406 STRING_TOKEN (STR_SHELL_NO_IN_EX
),
3407 ShellInfoObject
.HiiHandle
);
3408 return (EFI_SUCCESS
);
3411 if (ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
== NULL
) {
3412 return (EFI_UNSUPPORTED
);
3415 KeyData
.KeyState
.KeyToggleState
= 0;
3416 KeyData
.Key
.ScanCode
= 0;
3417 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
;
3418 KeyData
.Key
.UnicodeChar
= L
'c';
3420 Status
= SimpleEx
->RegisterKeyNotify(
3423 NotificationFunction
,
3424 &ShellInfoObject
.CtrlCNotifyHandle1
);
3426 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
;
3427 if (!EFI_ERROR(Status
)) {
3428 Status
= SimpleEx
->RegisterKeyNotify(
3431 NotificationFunction
,
3432 &ShellInfoObject
.CtrlCNotifyHandle2
);
3434 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
;
3435 KeyData
.Key
.UnicodeChar
= 3;
3436 if (!EFI_ERROR(Status
)) {
3437 Status
= SimpleEx
->RegisterKeyNotify(
3440 NotificationFunction
,
3441 &ShellInfoObject
.CtrlCNotifyHandle3
);
3443 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
;
3444 if (!EFI_ERROR(Status
)) {
3445 Status
= SimpleEx
->RegisterKeyNotify(
3448 NotificationFunction
,
3449 &ShellInfoObject
.CtrlCNotifyHandle4
);