Roll back check in r15180 which caused the shell always returns EFI_ABORTED no matter...
[mirror_edk2.git] / ShellPkg / Application / Shell / ShellProtocol.c
1 /** @file
2 Member functions of EFI_SHELL_PROTOCOL and functions for creation,
3 manipulation, and initialization of EFI_SHELL_PROTOCOL.
4
5 (C) Copyright 2014, Hewlett-Packard Development Company, L.P.
6 Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved.<BR>
7 This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
11
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
14
15 **/
16
17 #include "Shell.h"
18
19 /**
20 Close an open file handle.
21
22 This function closes a specified file handle. All "dirty" cached file data is
23 flushed to the device, and the file is closed. In all cases the handle is
24 closed.
25
26 @param[in] FileHandle The file handle to close.
27
28 @retval EFI_SUCCESS The file handle was closed successfully.
29 **/
30 EFI_STATUS
31 EFIAPI
32 EfiShellClose (
33 IN SHELL_FILE_HANDLE FileHandle
34 )
35 {
36 ShellFileHandleRemove(FileHandle);
37 return (FileHandleClose(ConvertShellHandleToEfiFileProtocol(FileHandle)));
38 }
39
40 /**
41 Internal worker to determine whether there is a BlockIo somewhere
42 upon the device path specified.
43
44 @param[in] DevicePath The device path to test.
45
46 @retval TRUE gEfiBlockIoProtocolGuid was installed on a handle with this device path
47 @retval FALSE gEfiBlockIoProtocolGuid was not found.
48 **/
49 BOOLEAN
50 EFIAPI
51 InternalShellProtocolIsBlockIoPresent(
52 IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath
53 )
54 {
55 EFI_DEVICE_PATH_PROTOCOL *DevicePathCopy;
56 EFI_STATUS Status;
57 EFI_HANDLE Handle;
58
59 Handle = NULL;
60
61 DevicePathCopy = (EFI_DEVICE_PATH_PROTOCOL*)DevicePath;
62 Status = gBS->LocateDevicePath(&gEfiBlockIoProtocolGuid, &DevicePathCopy, &Handle);
63
64 if ((Handle != NULL) && (!EFI_ERROR(Status))) {
65 return (TRUE);
66 }
67 return (FALSE);
68 }
69
70 /**
71 Internal worker to determine whether there is a file system somewhere
72 upon the device path specified.
73
74 @param[in] DevicePath The device path to test.
75
76 @retval TRUE gEfiSimpleFileSystemProtocolGuid was installed on a handle with this device path
77 @retval FALSE gEfiSimpleFileSystemProtocolGuid was not found.
78 **/
79 BOOLEAN
80 EFIAPI
81 InternalShellProtocolIsSimpleFileSystemPresent(
82 IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath
83 )
84 {
85 EFI_DEVICE_PATH_PROTOCOL *DevicePathCopy;
86 EFI_STATUS Status;
87 EFI_HANDLE Handle;
88
89 Handle = NULL;
90
91 DevicePathCopy = (EFI_DEVICE_PATH_PROTOCOL*)DevicePath;
92 Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &DevicePathCopy, &Handle);
93
94 if ((Handle != NULL) && (!EFI_ERROR(Status))) {
95 return (TRUE);
96 }
97 return (FALSE);
98 }
99
100 /**
101 Internal worker debug helper function to print out maps as they are added.
102
103 @param[in] Mapping string mapping that has been added
104 @param[in] DevicePath pointer to device path that has been mapped.
105
106 @retval EFI_SUCCESS the operation was successful.
107 @return other an error ocurred
108
109 @sa LocateHandle
110 @sa OpenProtocol
111 **/
112 EFI_STATUS
113 EFIAPI
114 InternalShellProtocolDebugPrintMessage (
115 IN CONST CHAR16 *Mapping,
116 IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath
117 )
118 {
119 EFI_STATUS Status;
120 CHAR16 *Temp;
121
122 Status = EFI_SUCCESS;
123 DEBUG_CODE_BEGIN();
124
125 if (Mapping != NULL) {
126 DEBUG((EFI_D_INFO, "Added new map item:\"%S\"\r\n", Mapping));
127 }
128 Temp = ConvertDevicePathToText(DevicePath, TRUE, TRUE);
129 DEBUG((EFI_D_INFO, "DevicePath: %S\r\n", Temp));
130 FreePool(Temp);
131
132 DEBUG_CODE_END();
133 return (Status);
134 }
135
136 /**
137 This function creates a mapping for a device path.
138
139 If both DeviecPath and Mapping are NULL, this will reset the mapping to default values.
140
141 @param DevicePath Points to the device path. If this is NULL and Mapping points to a valid mapping,
142 then the mapping will be deleted.
143 @param Mapping Points to the NULL-terminated mapping for the device path. Must end with a ':'
144
145 @retval EFI_SUCCESS Mapping created or deleted successfully.
146 @retval EFI_NO_MAPPING There is no handle that corresponds exactly to DevicePath. See the
147 boot service function LocateDevicePath().
148 @retval EFI_ACCESS_DENIED The mapping is a built-in alias.
149 @retval EFI_INVALID_PARAMETER Mapping was NULL
150 @retval EFI_INVALID_PARAMETER Mapping did not end with a ':'
151 @retval EFI_INVALID_PARAMETER DevicePath was not pointing at a device that had a SIMPLE_FILE_SYSTEM_PROTOCOL installed.
152 @retval EFI_NOT_FOUND There was no mapping found to delete
153 @retval EFI_OUT_OF_RESOURCES Memory allocation failed
154 **/
155 EFI_STATUS
156 EFIAPI
157 EfiShellSetMap(
158 IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath OPTIONAL,
159 IN CONST CHAR16 *Mapping
160 )
161 {
162 EFI_STATUS Status;
163 SHELL_MAP_LIST *MapListNode;
164
165 if (Mapping == NULL){
166 return (EFI_INVALID_PARAMETER);
167 }
168
169 if (Mapping[StrLen(Mapping)-1] != ':') {
170 return (EFI_INVALID_PARAMETER);
171 }
172
173 //
174 // Delete the mapping
175 //
176 if (DevicePath == NULL) {
177 if (IsListEmpty(&gShellMapList.Link)) {
178 return (EFI_NOT_FOUND);
179 }
180 for ( MapListNode = (SHELL_MAP_LIST *)GetFirstNode(&gShellMapList.Link)
181 ; !IsNull(&gShellMapList.Link, &MapListNode->Link)
182 ; MapListNode = (SHELL_MAP_LIST *)GetNextNode(&gShellMapList.Link, &MapListNode->Link)
183 ){
184 if (StringNoCaseCompare(&MapListNode->MapName, &Mapping) == 0) {
185 RemoveEntryList(&MapListNode->Link);
186 FreePool(MapListNode);
187 return (EFI_SUCCESS);
188 }
189 } // for loop
190
191 //
192 // We didnt find one to delete
193 //
194 return (EFI_NOT_FOUND);
195 }
196
197 //
198 // make sure this is a valid to add device path
199 //
200 ///@todo add BlockIo to this test...
201 if (!InternalShellProtocolIsSimpleFileSystemPresent(DevicePath)
202 && !InternalShellProtocolIsBlockIoPresent(DevicePath)) {
203 return (EFI_INVALID_PARAMETER);
204 }
205
206 //
207 // First make sure there is no old mapping
208 //
209 Status = EfiShellSetMap(NULL, Mapping);
210 if ((Status != EFI_SUCCESS) && (Status != EFI_NOT_FOUND)) {
211 return (Status);
212 }
213
214 //
215 // now add the new one.
216 //
217 Status = ShellCommandAddMapItemAndUpdatePath(Mapping, DevicePath, 0, FALSE);
218
219 return(Status);
220 }
221
222 /**
223 Gets the device path from the mapping.
224
225 This function gets the device path associated with a mapping.
226
227 @param Mapping A pointer to the mapping
228
229 @retval !=NULL Pointer to the device path that corresponds to the
230 device mapping. The returned pointer does not need
231 to be freed.
232 @retval NULL There is no device path associated with the
233 specified mapping.
234 **/
235 CONST EFI_DEVICE_PATH_PROTOCOL *
236 EFIAPI
237 EfiShellGetDevicePathFromMap(
238 IN CONST CHAR16 *Mapping
239 )
240 {
241 SHELL_MAP_LIST *MapListItem;
242 CHAR16 *NewName;
243 UINTN Size;
244
245 NewName = NULL;
246 Size = 0;
247
248 StrnCatGrow(&NewName, &Size, Mapping, 0);
249 if (Mapping[StrLen(Mapping)-1] != L':') {
250 StrnCatGrow(&NewName, &Size, L":", 0);
251 }
252
253 MapListItem = ShellCommandFindMapItem(NewName);
254
255 FreePool(NewName);
256
257 if (MapListItem != NULL) {
258 return (MapListItem->DevicePath);
259 }
260 return(NULL);
261 }
262
263 /**
264 Gets the mapping(s) that most closely matches the device path.
265
266 This function gets the mapping which corresponds to the device path *DevicePath. If
267 there is no exact match, then the mapping which most closely matches *DevicePath
268 is returned, and *DevicePath is updated to point to the remaining portion of the
269 device path. If there is an exact match, the mapping is returned and *DevicePath
270 points to the end-of-device-path node.
271
272 If there are multiple map names they will be semi-colon seperated in the
273 NULL-terminated string.
274
275 @param DevicePath On entry, points to a device path pointer. On
276 exit, updates the pointer to point to the
277 portion of the device path after the mapping.
278
279 @retval NULL No mapping was found.
280 @return !=NULL Pointer to NULL-terminated mapping. The buffer
281 is callee allocated and should be freed by the caller.
282 **/
283 CONST CHAR16 *
284 EFIAPI
285 EfiShellGetMapFromDevicePath(
286 IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath
287 )
288 {
289 SHELL_MAP_LIST *Node;
290 CHAR16 *PathForReturn;
291 UINTN PathSize;
292 // EFI_HANDLE PathHandle;
293 // EFI_HANDLE MapHandle;
294 // EFI_STATUS Status;
295 // EFI_DEVICE_PATH_PROTOCOL *DevicePathCopy;
296 // EFI_DEVICE_PATH_PROTOCOL *MapPathCopy;
297
298 if (DevicePath == NULL || *DevicePath == NULL) {
299 return (NULL);
300 }
301
302 PathForReturn = NULL;
303 PathSize = 0;
304
305 for ( Node = (SHELL_MAP_LIST *)GetFirstNode(&gShellMapList.Link)
306 ; !IsNull(&gShellMapList.Link, &Node->Link)
307 ; Node = (SHELL_MAP_LIST *)GetNextNode(&gShellMapList.Link, &Node->Link)
308 ){
309 //
310 // check for exact match
311 //
312 if (DevicePathCompare(DevicePath, &Node->DevicePath) == 0) {
313 ASSERT((PathForReturn == NULL && PathSize == 0) || (PathForReturn != NULL));
314 if (PathSize != 0) {
315 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, L";", 0);
316 }
317 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, Node->MapName, 0);
318 }
319 }
320 if (PathForReturn != NULL) {
321 while (!IsDevicePathEndType (*DevicePath)) {
322 *DevicePath = NextDevicePathNode (*DevicePath);
323 }
324 SetDevicePathEndNode (*DevicePath);
325 }
326 /*
327 ///@todo finish code for inexact matches.
328 if (PathForReturn == NULL) {
329 PathSize = 0;
330
331 DevicePathCopy = DuplicateDevicePath(*DevicePath);
332 ASSERT(DevicePathCopy != NULL);
333 Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &DevicePathCopy, &PathHandle);
334 ASSERT_EFI_ERROR(Status);
335 //
336 // check each of the device paths we have to get the root of the path for consist mappings
337 //
338 for ( Node = (SHELL_MAP_LIST *)GetFirstNode(&gShellMapList.Link)
339 ; !IsNull(&gShellMapList.Link, &Node->Link)
340 ; Node = (SHELL_MAP_LIST *)GetNextNode(&gShellMapList.Link, &Node->Link)
341 ){
342 if ((Node->Flags & SHELL_MAP_FLAGS_CONSIST) == 0) {
343 continue;
344 }
345 MapPathCopy = DuplicateDevicePath(Node->DevicePath);
346 ASSERT(MapPathCopy != NULL);
347 Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &MapPathCopy, &MapHandle);
348 if (MapHandle == PathHandle) {
349
350 *DevicePath = DevicePathCopy;
351
352 MapPathCopy = NULL;
353 DevicePathCopy = NULL;
354 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, Node->MapName, 0);
355 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, L";", 0);
356 break;
357 }
358 }
359 //
360 // now add on the non-consistent mappings
361 //
362 for ( Node = (SHELL_MAP_LIST *)GetFirstNode(&gShellMapList.Link)
363 ; !IsNull(&gShellMapList.Link, &Node->Link)
364 ; Node = (SHELL_MAP_LIST *)GetNextNode(&gShellMapList.Link, &Node->Link)
365 ){
366 if ((Node->Flags & SHELL_MAP_FLAGS_CONSIST) != 0) {
367 continue;
368 }
369 MapPathCopy = Node->DevicePath;
370 ASSERT(MapPathCopy != NULL);
371 Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &MapPathCopy, &MapHandle);
372 if (MapHandle == PathHandle) {
373 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, Node->MapName, 0);
374 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, L";", 0);
375 break;
376 }
377 }
378 }
379 */
380
381 return (AddBufferToFreeList(PathForReturn));
382 }
383
384 /**
385 Converts a device path to a file system-style path.
386
387 This function converts a device path to a file system path by replacing part, or all, of
388 the device path with the file-system mapping. If there are more than one application
389 file system mappings, the one that most closely matches Path will be used.
390
391 @param Path The pointer to the device path
392
393 @retval NULL the device path could not be found.
394 @return all The pointer of the NULL-terminated file path. The path
395 is callee-allocated and should be freed by the caller.
396 **/
397 CHAR16 *
398 EFIAPI
399 EfiShellGetFilePathFromDevicePath(
400 IN CONST EFI_DEVICE_PATH_PROTOCOL *Path
401 )
402 {
403 EFI_DEVICE_PATH_PROTOCOL *DevicePathCopy;
404 EFI_DEVICE_PATH_PROTOCOL *MapPathCopy;
405 SHELL_MAP_LIST *MapListItem;
406 CHAR16 *PathForReturn;
407 UINTN PathSize;
408 EFI_HANDLE PathHandle;
409 EFI_HANDLE MapHandle;
410 EFI_STATUS Status;
411 FILEPATH_DEVICE_PATH *FilePath;
412 FILEPATH_DEVICE_PATH *AlignedNode;
413
414 PathForReturn = NULL;
415 PathSize = 0;
416
417 DevicePathCopy = (EFI_DEVICE_PATH_PROTOCOL*)Path;
418 ASSERT(DevicePathCopy != NULL);
419 if (DevicePathCopy == NULL) {
420 return (NULL);
421 }
422 ///@todo BlockIo?
423 Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &DevicePathCopy, &PathHandle);
424
425 if (EFI_ERROR(Status)) {
426 return (NULL);
427 }
428 //
429 // check each of the device paths we have to get the root of the path
430 //
431 for ( MapListItem = (SHELL_MAP_LIST *)GetFirstNode(&gShellMapList.Link)
432 ; !IsNull(&gShellMapList.Link, &MapListItem->Link)
433 ; MapListItem = (SHELL_MAP_LIST *)GetNextNode(&gShellMapList.Link, &MapListItem->Link)
434 ){
435 MapPathCopy = (EFI_DEVICE_PATH_PROTOCOL*)MapListItem->DevicePath;
436 ASSERT(MapPathCopy != NULL);
437 ///@todo BlockIo?
438 Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &MapPathCopy, &MapHandle);
439 if (MapHandle == PathHandle) {
440 ASSERT((PathForReturn == NULL && PathSize == 0) || (PathForReturn != NULL));
441 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, MapListItem->MapName, 0);
442 //
443 // go through all the remaining nodes in the device path
444 //
445 for ( FilePath = (FILEPATH_DEVICE_PATH*)DevicePathCopy
446 ; !IsDevicePathEnd (&FilePath->Header)
447 ; FilePath = (FILEPATH_DEVICE_PATH*)NextDevicePathNode (&FilePath->Header)
448 ){
449 //
450 // all the rest should be file path nodes
451 //
452 if ((DevicePathType(&FilePath->Header) != MEDIA_DEVICE_PATH) ||
453 (DevicePathSubType(&FilePath->Header) != MEDIA_FILEPATH_DP)) {
454 FreePool(PathForReturn);
455 PathForReturn = NULL;
456 ASSERT(FALSE);
457 } else {
458 //
459 // append the path part onto the filepath.
460 //
461 ASSERT((PathForReturn == NULL && PathSize == 0) || (PathForReturn != NULL));
462
463 AlignedNode = AllocateCopyPool (DevicePathNodeLength(FilePath), FilePath);
464 ASSERT (AlignedNode != NULL);
465
466 // File Path Device Path Nodes 'can optionally add a "\" separator to
467 // the beginning and/or the end of the Path Name string.'
468 // (UEFI Spec 2.4 section 9.3.6.4).
469 // If necessary, add a "\", but otherwise don't
470 // (This is specified in the above section, and also implied by the
471 // UEFI Shell spec section 3.7)
472 if ((PathSize != 0) &&
473 (PathForReturn != NULL) &&
474 (PathForReturn[PathSize - 1] != L'\\') &&
475 (AlignedNode->PathName[0] != L'\\')) {
476 PathForReturn = StrnCatGrow (&PathForReturn, &PathSize, L"\\", 1);
477 }
478
479 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, AlignedNode->PathName, 0);
480 FreePool(AlignedNode);
481 }
482 } // for loop of remaining nodes
483 }
484 if (PathForReturn != NULL) {
485 break;
486 }
487 } // for loop of paths to check
488 return(PathForReturn);
489 }
490
491 /**
492 Converts a file system style name to a device path.
493
494 This function converts a file system style name to a device path, by replacing any
495 mapping references to the associated device path.
496
497 @param[in] Path The pointer to the path.
498
499 @return The pointer of the file path. The file path is callee
500 allocated and should be freed by the caller.
501 @retval NULL The path could not be found.
502 @retval NULL There was not enough available memory.
503 **/
504 EFI_DEVICE_PATH_PROTOCOL *
505 EFIAPI
506 EfiShellGetDevicePathFromFilePath(
507 IN CONST CHAR16 *Path
508 )
509 {
510 CHAR16 *MapName;
511 CHAR16 *NewPath;
512 CONST CHAR16 *Cwd;
513 UINTN Size;
514 CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath;
515 EFI_DEVICE_PATH_PROTOCOL *DevicePathCopy;
516 EFI_DEVICE_PATH_PROTOCOL *DevicePathCopyForFree;
517 EFI_DEVICE_PATH_PROTOCOL *DevicePathForReturn;
518 EFI_HANDLE Handle;
519 EFI_STATUS Status;
520
521 if (Path == NULL) {
522 return (NULL);
523 }
524
525 MapName = NULL;
526 NewPath = NULL;
527
528 if (StrStr(Path, L":") == NULL) {
529 Cwd = EfiShellGetCurDir(NULL);
530 if (Cwd == NULL) {
531 return (NULL);
532 }
533 Size = StrSize(Cwd) + StrSize(Path) - sizeof(CHAR16);
534 NewPath = AllocateZeroPool(Size);
535 if (NewPath == NULL) {
536 return (NULL);
537 }
538 StrnCpy(NewPath, Cwd, Size/sizeof(CHAR16)-1);
539 if (*Path == L'\\') {
540 Path++;
541 while (PathRemoveLastItem(NewPath)) ;
542 }
543 StrnCat(NewPath, Path, Size/sizeof(CHAR16) - 1 - StrLen(NewPath));
544 DevicePathForReturn = EfiShellGetDevicePathFromFilePath(NewPath);
545 FreePool(NewPath);
546 return (DevicePathForReturn);
547 }
548
549 Size = 0;
550 //
551 // find the part before (but including) the : for the map name
552 //
553 ASSERT((MapName == NULL && Size == 0) || (MapName != NULL));
554 MapName = StrnCatGrow(&MapName, &Size, Path, (StrStr(Path, L":")-Path+1));
555 if (MapName == NULL || MapName[StrLen(MapName)-1] != L':') {
556 return (NULL);
557 }
558
559 //
560 // look up the device path in the map
561 //
562 DevicePath = EfiShellGetDevicePathFromMap(MapName);
563 if (DevicePath == NULL) {
564 //
565 // Must have been a bad Mapname
566 //
567 return (NULL);
568 }
569
570 //
571 // make a copy for LocateDevicePath to modify (also save a pointer to call FreePool with)
572 //
573 DevicePathCopyForFree = DevicePathCopy = DuplicateDevicePath(DevicePath);
574 if (DevicePathCopy == NULL) {
575 FreePool(MapName);
576 return (NULL);
577 }
578
579 //
580 // get the handle
581 //
582 ///@todo BlockIo?
583 Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &DevicePathCopy, &Handle);
584 if (EFI_ERROR(Status)) {
585 if (DevicePathCopyForFree != NULL) {
586 FreePool(DevicePathCopyForFree);
587 }
588 FreePool(MapName);
589 return (NULL);
590 }
591
592 //
593 // build the full device path
594 //
595 if (*(Path+StrLen(MapName)+1) == CHAR_NULL) {
596 DevicePathForReturn = FileDevicePath(Handle, L"\\");
597 } else {
598 DevicePathForReturn = FileDevicePath(Handle, Path+StrLen(MapName));
599 }
600
601 FreePool(MapName);
602 if (DevicePathCopyForFree != NULL) {
603 FreePool(DevicePathCopyForFree);
604 }
605
606 return (DevicePathForReturn);
607 }
608
609 /**
610 Gets the name of the device specified by the device handle.
611
612 This function gets the user-readable name of the device specified by the device
613 handle. If no user-readable name could be generated, then *BestDeviceName will be
614 NULL and EFI_NOT_FOUND will be returned.
615
616 If EFI_DEVICE_NAME_USE_COMPONENT_NAME is set, then the function will return the
617 device's name using the EFI_COMPONENT_NAME2_PROTOCOL, if present on
618 DeviceHandle.
619
620 If EFI_DEVICE_NAME_USE_DEVICE_PATH is set, then the function will return the
621 device's name using the EFI_DEVICE_PATH_PROTOCOL, if present on DeviceHandle.
622 If both EFI_DEVICE_NAME_USE_COMPONENT_NAME and
623 EFI_DEVICE_NAME_USE_DEVICE_PATH are set, then
624 EFI_DEVICE_NAME_USE_COMPONENT_NAME will have higher priority.
625
626 @param DeviceHandle The handle of the device.
627 @param Flags Determines the possible sources of component names.
628 Valid bits are:
629 EFI_DEVICE_NAME_USE_COMPONENT_NAME
630 EFI_DEVICE_NAME_USE_DEVICE_PATH
631 @param Language A pointer to the language specified for the device
632 name, in the same format as described in the UEFI
633 specification, Appendix M
634 @param BestDeviceName On return, points to the callee-allocated NULL-
635 terminated name of the device. If no device name
636 could be found, points to NULL. The name must be
637 freed by the caller...
638
639 @retval EFI_SUCCESS Get the name successfully.
640 @retval EFI_NOT_FOUND Fail to get the device name.
641 @retval EFI_INVALID_PARAMETER Flags did not have a valid bit set.
642 @retval EFI_INVALID_PARAMETER BestDeviceName was NULL
643 @retval EFI_INVALID_PARAMETER DeviceHandle was NULL
644 **/
645 EFI_STATUS
646 EFIAPI
647 EfiShellGetDeviceName(
648 IN EFI_HANDLE DeviceHandle,
649 IN EFI_SHELL_DEVICE_NAME_FLAGS Flags,
650 IN CHAR8 *Language,
651 OUT CHAR16 **BestDeviceName
652 )
653 {
654 EFI_STATUS Status;
655 EFI_COMPONENT_NAME2_PROTOCOL *CompName2;
656 EFI_DEVICE_PATH_PROTOCOL *DevicePath;
657 EFI_HANDLE *HandleList;
658 UINTN HandleCount;
659 UINTN LoopVar;
660 CHAR16 *DeviceNameToReturn;
661 CHAR8 *Lang;
662 UINTN ParentControllerCount;
663 EFI_HANDLE *ParentControllerBuffer;
664 UINTN ParentDriverCount;
665 EFI_HANDLE *ParentDriverBuffer;
666
667 if (BestDeviceName == NULL ||
668 DeviceHandle == NULL
669 ){
670 return (EFI_INVALID_PARAMETER);
671 }
672
673 //
674 // make sure one of the 2 supported bits is on
675 //
676 if (((Flags & EFI_DEVICE_NAME_USE_COMPONENT_NAME) == 0) &&
677 ((Flags & EFI_DEVICE_NAME_USE_DEVICE_PATH) == 0)) {
678 return (EFI_INVALID_PARAMETER);
679 }
680
681 DeviceNameToReturn = NULL;
682 *BestDeviceName = NULL;
683 HandleList = NULL;
684 HandleCount = 0;
685 Lang = NULL;
686
687 if ((Flags & EFI_DEVICE_NAME_USE_COMPONENT_NAME) != 0) {
688 Status = ParseHandleDatabaseByRelationship(
689 NULL,
690 DeviceHandle,
691 HR_DRIVER_BINDING_HANDLE|HR_DEVICE_DRIVER,
692 &HandleCount,
693 &HandleList);
694 for (LoopVar = 0; LoopVar < HandleCount ; LoopVar++){
695 //
696 // Go through those handles until we get one that passes for GetComponentName
697 //
698 Status = gBS->OpenProtocol(
699 HandleList[LoopVar],
700 &gEfiComponentName2ProtocolGuid,
701 (VOID**)&CompName2,
702 gImageHandle,
703 NULL,
704 EFI_OPEN_PROTOCOL_GET_PROTOCOL);
705 if (EFI_ERROR(Status)) {
706 Status = gBS->OpenProtocol(
707 HandleList[LoopVar],
708 &gEfiComponentNameProtocolGuid,
709 (VOID**)&CompName2,
710 gImageHandle,
711 NULL,
712 EFI_OPEN_PROTOCOL_GET_PROTOCOL);
713 }
714
715 if (EFI_ERROR(Status)) {
716 continue;
717 }
718 Lang = GetBestLanguageForDriver(CompName2->SupportedLanguages, Language, FALSE);
719 Status = CompName2->GetControllerName(CompName2, DeviceHandle, NULL, Lang, &DeviceNameToReturn);
720 FreePool(Lang);
721 Lang = NULL;
722 if (!EFI_ERROR(Status) && DeviceNameToReturn != NULL) {
723 break;
724 }
725 }
726 if (HandleList != NULL) {
727 FreePool(HandleList);
728 }
729
730 //
731 // Now check the parent controller using this as the child.
732 //
733 if (DeviceNameToReturn == NULL){
734 PARSE_HANDLE_DATABASE_PARENTS(DeviceHandle, &ParentControllerCount, &ParentControllerBuffer);
735 for (LoopVar = 0 ; LoopVar < ParentControllerCount ; LoopVar++) {
736 PARSE_HANDLE_DATABASE_UEFI_DRIVERS(ParentControllerBuffer[LoopVar], &ParentDriverCount, &ParentDriverBuffer);
737 for (HandleCount = 0 ; HandleCount < ParentDriverCount ; HandleCount++) {
738 //
739 // try using that driver's component name with controller and our driver as the child.
740 //
741 Status = gBS->OpenProtocol(
742 ParentDriverBuffer[HandleCount],
743 &gEfiComponentName2ProtocolGuid,
744 (VOID**)&CompName2,
745 gImageHandle,
746 NULL,
747 EFI_OPEN_PROTOCOL_GET_PROTOCOL);
748 if (EFI_ERROR(Status)) {
749 Status = gBS->OpenProtocol(
750 ParentDriverBuffer[HandleCount],
751 &gEfiComponentNameProtocolGuid,
752 (VOID**)&CompName2,
753 gImageHandle,
754 NULL,
755 EFI_OPEN_PROTOCOL_GET_PROTOCOL);
756 }
757
758 if (EFI_ERROR(Status)) {
759 continue;
760 }
761 Lang = GetBestLanguageForDriver(CompName2->SupportedLanguages, Language, FALSE);
762 Status = CompName2->GetControllerName(CompName2, ParentControllerBuffer[LoopVar], DeviceHandle, Lang, &DeviceNameToReturn);
763 FreePool(Lang);
764 Lang = NULL;
765 if (!EFI_ERROR(Status) && DeviceNameToReturn != NULL) {
766 break;
767 }
768
769
770
771 }
772 SHELL_FREE_NON_NULL(ParentDriverBuffer);
773 if (!EFI_ERROR(Status) && DeviceNameToReturn != NULL) {
774 break;
775 }
776 }
777 SHELL_FREE_NON_NULL(ParentControllerBuffer);
778 }
779 //
780 // dont return on fail since we will try device path if that bit is on
781 //
782 if (DeviceNameToReturn != NULL){
783 ASSERT(BestDeviceName != NULL);
784 StrnCatGrow(BestDeviceName, NULL, DeviceNameToReturn, 0);
785 return (EFI_SUCCESS);
786 }
787 }
788 if ((Flags & EFI_DEVICE_NAME_USE_DEVICE_PATH) != 0) {
789 Status = gBS->OpenProtocol(
790 DeviceHandle,
791 &gEfiDevicePathProtocolGuid,
792 (VOID**)&DevicePath,
793 gImageHandle,
794 NULL,
795 EFI_OPEN_PROTOCOL_GET_PROTOCOL);
796 if (!EFI_ERROR(Status)) {
797 //
798 // use device path to text on the device path
799 //
800 *BestDeviceName = ConvertDevicePathToText(DevicePath, TRUE, TRUE);
801 return (EFI_SUCCESS);
802 }
803 }
804 //
805 // none of the selected bits worked.
806 //
807 return (EFI_NOT_FOUND);
808 }
809
810 /**
811 Opens the root directory of a device on a handle
812
813 This function opens the root directory of a device and returns a file handle to it.
814
815 @param DeviceHandle The handle of the device that contains the volume.
816 @param FileHandle On exit, points to the file handle corresponding to the root directory on the
817 device.
818
819 @retval EFI_SUCCESS Root opened successfully.
820 @retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory
821 could not be opened.
822 @retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.
823 @retval EFI_DEVICE_ERROR The device had an error
824 **/
825 EFI_STATUS
826 EFIAPI
827 EfiShellOpenRootByHandle(
828 IN EFI_HANDLE DeviceHandle,
829 OUT SHELL_FILE_HANDLE *FileHandle
830 )
831 {
832 EFI_STATUS Status;
833 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *SimpleFileSystem;
834 EFI_FILE_PROTOCOL *RealFileHandle;
835 EFI_DEVICE_PATH_PROTOCOL *DevPath;
836
837 //
838 // get the simple file system interface
839 //
840 Status = gBS->OpenProtocol(DeviceHandle,
841 &gEfiSimpleFileSystemProtocolGuid,
842 (VOID**)&SimpleFileSystem,
843 gImageHandle,
844 NULL,
845 EFI_OPEN_PROTOCOL_GET_PROTOCOL);
846 if (EFI_ERROR(Status)) {
847 return (EFI_NOT_FOUND);
848 }
849
850 Status = gBS->OpenProtocol(DeviceHandle,
851 &gEfiDevicePathProtocolGuid,
852 (VOID**)&DevPath,
853 gImageHandle,
854 NULL,
855 EFI_OPEN_PROTOCOL_GET_PROTOCOL);
856 if (EFI_ERROR(Status)) {
857 return (EFI_NOT_FOUND);
858 }
859 //
860 // Open the root volume now...
861 //
862 Status = SimpleFileSystem->OpenVolume(SimpleFileSystem, &RealFileHandle);
863 *FileHandle = ConvertEfiFileProtocolToShellHandle(RealFileHandle, EfiShellGetMapFromDevicePath(&DevPath));
864 return (Status);
865 }
866
867 /**
868 Opens the root directory of a device.
869
870 This function opens the root directory of a device and returns a file handle to it.
871
872 @param DevicePath Points to the device path corresponding to the device where the
873 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL is installed.
874 @param FileHandle On exit, points to the file handle corresponding to the root directory on the
875 device.
876
877 @retval EFI_SUCCESS Root opened successfully.
878 @retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory
879 could not be opened.
880 @retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.
881 @retval EFI_DEVICE_ERROR The device had an error
882 @retval EFI_INVALID_PARAMETER FileHandle is NULL.
883 **/
884 EFI_STATUS
885 EFIAPI
886 EfiShellOpenRoot(
887 IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,
888 OUT SHELL_FILE_HANDLE *FileHandle
889 )
890 {
891 EFI_STATUS Status;
892 EFI_HANDLE Handle;
893
894 if (FileHandle == NULL) {
895 return (EFI_INVALID_PARAMETER);
896 }
897
898 //
899 // find the handle of the device with that device handle and the file system
900 //
901 ///@todo BlockIo?
902 Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid,
903 &DevicePath,
904 &Handle);
905 if (EFI_ERROR(Status)) {
906 return (EFI_NOT_FOUND);
907 }
908
909 return (EfiShellOpenRootByHandle(Handle, FileHandle));
910 }
911
912 /**
913 Returns whether any script files are currently being processed.
914
915 @retval TRUE There is at least one script file active.
916 @retval FALSE No script files are active now.
917
918 **/
919 BOOLEAN
920 EFIAPI
921 EfiShellBatchIsActive (
922 VOID
923 )
924 {
925 if (ShellCommandGetCurrentScriptFile() == NULL) {
926 return (FALSE);
927 }
928 return (TRUE);
929 }
930
931 /**
932 Worker function to open a file based on a device path. this will open the root
933 of the volume and then traverse down to the file itself.
934
935 @param DevicePath Device Path of the file.
936 @param FileHandle Pointer to the file upon a successful return.
937 @param OpenMode mode to open file in.
938 @param Attributes the File Attributes to use when creating a new file.
939
940 @retval EFI_SUCCESS the file is open and FileHandle is valid
941 @retval EFI_UNSUPPORTED the device path cotained non-path elements
942 @retval other an error ocurred.
943 **/
944 EFI_STATUS
945 EFIAPI
946 InternalOpenFileDevicePath(
947 IN OUT EFI_DEVICE_PATH_PROTOCOL *DevicePath,
948 OUT SHELL_FILE_HANDLE *FileHandle,
949 IN UINT64 OpenMode,
950 IN UINT64 Attributes OPTIONAL
951 )
952 {
953 EFI_STATUS Status;
954 FILEPATH_DEVICE_PATH *FilePathNode;
955 EFI_HANDLE Handle;
956 SHELL_FILE_HANDLE ShellHandle;
957 EFI_FILE_PROTOCOL *Handle1;
958 EFI_FILE_PROTOCOL *Handle2;
959 FILEPATH_DEVICE_PATH *AlignedNode;
960
961 if (FileHandle == NULL) {
962 return (EFI_INVALID_PARAMETER);
963 }
964 *FileHandle = NULL;
965 Handle1 = NULL;
966 Handle2 = NULL;
967 Handle = NULL;
968 ShellHandle = NULL;
969 FilePathNode = NULL;
970 AlignedNode = NULL;
971
972 Status = EfiShellOpenRoot(DevicePath, &ShellHandle);
973
974 if (!EFI_ERROR(Status)) {
975 Handle1 = ConvertShellHandleToEfiFileProtocol(ShellHandle);
976 if (Handle1 != NULL) {
977 //
978 // chop off the begining part before the file system part...
979 //
980 ///@todo BlockIo?
981 Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid,
982 &DevicePath,
983 &Handle);
984 if (!EFI_ERROR(Status)) {
985 //
986 // To access as a file system, the file path should only
987 // contain file path components. Follow the file path nodes
988 // and find the target file
989 //
990 for ( FilePathNode = (FILEPATH_DEVICE_PATH *)DevicePath
991 ; !IsDevicePathEnd (&FilePathNode->Header)
992 ; FilePathNode = (FILEPATH_DEVICE_PATH *) NextDevicePathNode (&FilePathNode->Header)
993 ){
994 SHELL_FREE_NON_NULL(AlignedNode);
995 AlignedNode = AllocateCopyPool (DevicePathNodeLength(FilePathNode), FilePathNode);
996 //
997 // For file system access each node should be a file path component
998 //
999 if (DevicePathType (&FilePathNode->Header) != MEDIA_DEVICE_PATH ||
1000 DevicePathSubType (&FilePathNode->Header) != MEDIA_FILEPATH_DP
1001 ) {
1002 Status = EFI_UNSUPPORTED;
1003 break;
1004 }
1005
1006 //
1007 // Open this file path node
1008 //
1009 Handle2 = Handle1;
1010 Handle1 = NULL;
1011
1012 //
1013 // if this is the last node in the DevicePath always create (if that was requested).
1014 //
1015 if (IsDevicePathEnd ((NextDevicePathNode (&FilePathNode->Header)))) {
1016 Status = Handle2->Open (
1017 Handle2,
1018 &Handle1,
1019 AlignedNode->PathName,
1020 OpenMode,
1021 Attributes
1022 );
1023 } else {
1024
1025 //
1026 // This is not the last node and we dont want to 'create' existing
1027 // directory entries...
1028 //
1029
1030 //
1031 // open without letting it create
1032 // prevents error on existing files/directories
1033 //
1034 Status = Handle2->Open (
1035 Handle2,
1036 &Handle1,
1037 AlignedNode->PathName,
1038 OpenMode &~EFI_FILE_MODE_CREATE,
1039 Attributes
1040 );
1041 //
1042 // if above failed now open and create the 'item'
1043 // if OpenMode EFI_FILE_MODE_CREATE bit was on (but disabled above)
1044 //
1045 if ((EFI_ERROR (Status)) && ((OpenMode & EFI_FILE_MODE_CREATE) != 0)) {
1046 Status = Handle2->Open (
1047 Handle2,
1048 &Handle1,
1049 AlignedNode->PathName,
1050 OpenMode,
1051 Attributes
1052 );
1053 }
1054 }
1055 //
1056 // Close the last node
1057 //
1058 ShellInfoObject.NewEfiShellProtocol->CloseFile (Handle2);
1059
1060 //
1061 // If there's been an error, stop
1062 //
1063 if (EFI_ERROR (Status)) {
1064 break;
1065 }
1066 } // for loop
1067 }
1068 }
1069 }
1070 SHELL_FREE_NON_NULL(AlignedNode);
1071 if (EFI_ERROR(Status)) {
1072 if (Handle1 != NULL) {
1073 ShellInfoObject.NewEfiShellProtocol->CloseFile(Handle1);
1074 }
1075 } else {
1076 *FileHandle = ConvertEfiFileProtocolToShellHandle(Handle1, ShellFileHandleGetPath(ShellHandle));
1077 }
1078 return (Status);
1079 }
1080
1081 /**
1082 Creates a file or directory by name.
1083
1084 This function creates an empty new file or directory with the specified attributes and
1085 returns the new file's handle. If the file already exists and is read-only, then
1086 EFI_INVALID_PARAMETER will be returned.
1087
1088 If the file already existed, it is truncated and its attributes updated. If the file is
1089 created successfully, the FileHandle is the file's handle, else, the FileHandle is NULL.
1090
1091 If the file name begins with >v, then the file handle which is returned refers to the
1092 shell environment variable with the specified name. If the shell environment variable
1093 already exists and is non-volatile then EFI_INVALID_PARAMETER is returned.
1094
1095 @param FileName Pointer to NULL-terminated file path
1096 @param FileAttribs The new file's attrbiutes. the different attributes are
1097 described in EFI_FILE_PROTOCOL.Open().
1098 @param FileHandle On return, points to the created file handle or directory's handle
1099
1100 @retval EFI_SUCCESS The file was opened. FileHandle points to the new file's handle.
1101 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
1102 @retval EFI_UNSUPPORTED could not open the file path
1103 @retval EFI_NOT_FOUND the specified file could not be found on the devide, or could not
1104 file the file system on the device.
1105 @retval EFI_NO_MEDIA the device has no medium.
1106 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no
1107 longer supported.
1108 @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according
1109 the DirName.
1110 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1111 @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write
1112 when the media is write-protected.
1113 @retval EFI_ACCESS_DENIED The service denied access to the file.
1114 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file.
1115 @retval EFI_VOLUME_FULL The volume is full.
1116 **/
1117 EFI_STATUS
1118 EFIAPI
1119 EfiShellCreateFile(
1120 IN CONST CHAR16 *FileName,
1121 IN UINT64 FileAttribs,
1122 OUT SHELL_FILE_HANDLE *FileHandle
1123 )
1124 {
1125 EFI_DEVICE_PATH_PROTOCOL *DevicePath;
1126 EFI_STATUS Status;
1127
1128 //
1129 // Is this for an environment variable
1130 // do we start with >v
1131 //
1132 if (StrStr(FileName, L">v") == FileName) {
1133 if (!IsVolatileEnv(FileName+2)) {
1134 return (EFI_INVALID_PARAMETER);
1135 }
1136 *FileHandle = CreateFileInterfaceEnv(FileName+2);
1137 return (EFI_SUCCESS);
1138 }
1139
1140 //
1141 // We are opening a regular file.
1142 //
1143 DevicePath = EfiShellGetDevicePathFromFilePath(FileName);
1144 if (DevicePath == NULL) {
1145 return (EFI_NOT_FOUND);
1146 }
1147
1148 Status = InternalOpenFileDevicePath(DevicePath, FileHandle, EFI_FILE_MODE_READ|EFI_FILE_MODE_WRITE|EFI_FILE_MODE_CREATE, FileAttribs);
1149 FreePool(DevicePath);
1150
1151 return(Status);
1152 }
1153
1154 /**
1155 Register a GUID and a localized human readable name for it.
1156
1157 If Guid is not assigned a name, then assign GuidName to Guid. This list of GUID
1158 names must be used whenever a shell command outputs GUID information.
1159
1160 This function is only available when the major and minor versions in the
1161 EfiShellProtocol are greater than or equal to 2 and 1, respectively.
1162
1163 @param[in] Guid A pointer to the GUID being registered.
1164 @param[in] GuidName A pointer to the localized name for the GUID being registered.
1165
1166 @retval EFI_SUCCESS The operation was successful.
1167 @retval EFI_INVALID_PARAMETER Guid was NULL.
1168 @retval EFI_INVALID_PARAMETER GuidName was NULL.
1169 @retval EFI_ACCESS_DENIED Guid already is assigned a name.
1170 **/
1171 EFI_STATUS
1172 EFIAPI
1173 EfiShellRegisterGuidName(
1174 IN CONST EFI_GUID *Guid,
1175 IN CONST CHAR16 *GuidName
1176 )
1177 {
1178 return (AddNewGuidNameMapping(Guid, GuidName, NULL));
1179 }
1180
1181 /**
1182 Opens a file or a directory by file name.
1183
1184 This function opens the specified file in the specified OpenMode and returns a file
1185 handle.
1186 If the file name begins with >v, then the file handle which is returned refers to the
1187 shell environment variable with the specified name. If the shell environment variable
1188 exists, is non-volatile and the OpenMode indicates EFI_FILE_MODE_WRITE, then
1189 EFI_INVALID_PARAMETER is returned.
1190
1191 If the file name is >i, then the file handle which is returned refers to the standard
1192 input. If the OpenMode indicates EFI_FILE_MODE_WRITE, then EFI_INVALID_PARAMETER
1193 is returned.
1194
1195 If the file name is >o, then the file handle which is returned refers to the standard
1196 output. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER
1197 is returned.
1198
1199 If the file name is >e, then the file handle which is returned refers to the standard
1200 error. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER
1201 is returned.
1202
1203 If the file name is NUL, then the file handle that is returned refers to the standard NUL
1204 file. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER is
1205 returned.
1206
1207 If return EFI_SUCCESS, the FileHandle is the opened file's handle, else, the
1208 FileHandle is NULL.
1209
1210 @param FileName Points to the NULL-terminated UCS-2 encoded file name.
1211 @param FileHandle On return, points to the file handle.
1212 @param OpenMode File open mode. Either EFI_FILE_MODE_READ or
1213 EFI_FILE_MODE_WRITE from section 12.4 of the UEFI
1214 Specification.
1215 @retval EFI_SUCCESS The file was opened. FileHandle has the opened file's handle.
1216 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value. FileHandle is NULL.
1217 @retval EFI_UNSUPPORTED Could not open the file path. FileHandle is NULL.
1218 @retval EFI_NOT_FOUND The specified file could not be found on the device or the file
1219 system could not be found on the device. FileHandle is NULL.
1220 @retval EFI_NO_MEDIA The device has no medium. FileHandle is NULL.
1221 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no
1222 longer supported. FileHandle is NULL.
1223 @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according
1224 the FileName. FileHandle is NULL.
1225 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted. FileHandle is NULL.
1226 @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write
1227 when the media is write-protected. FileHandle is NULL.
1228 @retval EFI_ACCESS_DENIED The service denied access to the file. FileHandle is NULL.
1229 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file. FileHandle
1230 is NULL.
1231 @retval EFI_VOLUME_FULL The volume is full. FileHandle is NULL.
1232 **/
1233 EFI_STATUS
1234 EFIAPI
1235 EfiShellOpenFileByName(
1236 IN CONST CHAR16 *FileName,
1237 OUT SHELL_FILE_HANDLE *FileHandle,
1238 IN UINT64 OpenMode
1239 )
1240 {
1241 EFI_DEVICE_PATH_PROTOCOL *DevicePath;
1242 EFI_STATUS Status;
1243
1244 *FileHandle = NULL;
1245
1246 //
1247 // Is this for StdIn
1248 //
1249 if (StrCmp(FileName, L">i") == 0) {
1250 //
1251 // make sure not writing to StdIn
1252 //
1253 if ((OpenMode & EFI_FILE_MODE_WRITE) != 0) {
1254 return (EFI_INVALID_PARAMETER);
1255 }
1256 *FileHandle = ShellInfoObject.NewShellParametersProtocol->StdIn;
1257 ASSERT(*FileHandle != NULL);
1258 return (EFI_SUCCESS);
1259 }
1260
1261 //
1262 // Is this for StdOut
1263 //
1264 if (StrCmp(FileName, L">o") == 0) {
1265 //
1266 // make sure not writing to StdIn
1267 //
1268 if ((OpenMode & EFI_FILE_MODE_READ) != 0) {
1269 return (EFI_INVALID_PARAMETER);
1270 }
1271 *FileHandle = &FileInterfaceStdOut;
1272 return (EFI_SUCCESS);
1273 }
1274
1275 //
1276 // Is this for NUL file
1277 //
1278 if (StrCmp(FileName, L"NUL") == 0) {
1279 *FileHandle = &FileInterfaceNulFile;
1280 return (EFI_SUCCESS);
1281 }
1282
1283 //
1284 // Is this for StdErr
1285 //
1286 if (StrCmp(FileName, L">e") == 0) {
1287 //
1288 // make sure not writing to StdIn
1289 //
1290 if ((OpenMode & EFI_FILE_MODE_READ) != 0) {
1291 return (EFI_INVALID_PARAMETER);
1292 }
1293 *FileHandle = &FileInterfaceStdErr;
1294 return (EFI_SUCCESS);
1295 }
1296
1297 //
1298 // Is this for an environment variable
1299 // do we start with >v
1300 //
1301 if (StrStr(FileName, L">v") == FileName) {
1302 if (!IsVolatileEnv(FileName+2) &&
1303 ((OpenMode & EFI_FILE_MODE_WRITE) != 0)) {
1304 return (EFI_INVALID_PARAMETER);
1305 }
1306 *FileHandle = CreateFileInterfaceEnv(FileName+2);
1307 return (EFI_SUCCESS);
1308 }
1309
1310 //
1311 // We are opening a regular file.
1312 //
1313 DevicePath = EfiShellGetDevicePathFromFilePath(FileName);
1314 // DEBUG_CODE(InternalShellProtocolDebugPrintMessage (NULL, DevicePath););
1315 if (DevicePath == NULL) {
1316 return (EFI_NOT_FOUND);
1317 }
1318
1319 //
1320 // Copy the device path, open the file, then free the memory
1321 //
1322 Status = InternalOpenFileDevicePath(DevicePath, FileHandle, OpenMode, 0); // 0 = no specific file attributes
1323 FreePool(DevicePath);
1324
1325 return(Status);
1326 }
1327
1328 /**
1329 Deletes the file specified by the file name.
1330
1331 This function deletes a file.
1332
1333 @param FileName Points to the NULL-terminated file name.
1334
1335 @retval EFI_SUCCESS The file was closed and deleted, and the handle was closed.
1336 @retval EFI_WARN_DELETE_FAILURE The handle was closed but the file was not deleted.
1337 @sa EfiShellCreateFile
1338 **/
1339 EFI_STATUS
1340 EFIAPI
1341 EfiShellDeleteFileByName(
1342 IN CONST CHAR16 *FileName
1343 )
1344 {
1345 SHELL_FILE_HANDLE FileHandle;
1346 EFI_STATUS Status;
1347
1348 FileHandle = NULL;
1349
1350 //
1351 // get a handle to the file
1352 //
1353 Status = EfiShellCreateFile(FileName,
1354 0,
1355 &FileHandle);
1356 if (EFI_ERROR(Status)) {
1357 return (Status);
1358 }
1359 //
1360 // now delete the file
1361 //
1362 return (ShellInfoObject.NewEfiShellProtocol->DeleteFile(FileHandle));
1363 }
1364
1365 /**
1366 Disables the page break output mode.
1367 **/
1368 VOID
1369 EFIAPI
1370 EfiShellDisablePageBreak (
1371 VOID
1372 )
1373 {
1374 ShellInfoObject.PageBreakEnabled = FALSE;
1375 }
1376
1377 /**
1378 Enables the page break output mode.
1379 **/
1380 VOID
1381 EFIAPI
1382 EfiShellEnablePageBreak (
1383 VOID
1384 )
1385 {
1386 ShellInfoObject.PageBreakEnabled = TRUE;
1387 }
1388
1389 /**
1390 internal worker function to load and run an image via device path.
1391
1392 @param ParentImageHandle A handle of the image that is executing the specified
1393 command line.
1394 @param DevicePath device path of the file to execute
1395 @param CommandLine Points to the NULL-terminated UCS-2 encoded string
1396 containing the command line. If NULL then the command-
1397 line will be empty.
1398 @param Environment Points to a NULL-terminated array of environment
1399 variables with the format 'x=y', where x is the
1400 environment variable name and y is the value. If this
1401 is NULL, then the current shell environment is used.
1402
1403 @param[out] StartImageStatus Returned status from gBS->StartImage.
1404
1405 @retval EFI_SUCCESS The command executed successfully. The status code
1406 returned by the command is pointed to by StatusCode.
1407 @retval EFI_INVALID_PARAMETER The parameters are invalid.
1408 @retval EFI_OUT_OF_RESOURCES Out of resources.
1409 @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.
1410 **/
1411 EFI_STATUS
1412 EFIAPI
1413 InternalShellExecuteDevicePath(
1414 IN CONST EFI_HANDLE *ParentImageHandle,
1415 IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath,
1416 IN CONST CHAR16 *CommandLine OPTIONAL,
1417 IN CONST CHAR16 **Environment OPTIONAL,
1418 OUT EFI_STATUS *StartImageStatus OPTIONAL
1419 )
1420 {
1421 EFI_STATUS Status;
1422 EFI_STATUS StartStatus;
1423 EFI_STATUS CleanupStatus;
1424 EFI_HANDLE NewHandle;
1425 EFI_LOADED_IMAGE_PROTOCOL *LoadedImage;
1426 LIST_ENTRY OrigEnvs;
1427 EFI_SHELL_PARAMETERS_PROTOCOL ShellParamsProtocol;
1428 CHAR16 *ImagePath;
1429 UINTN Index;
1430 CHAR16 *Walker;
1431 CHAR16 *NewCmdLine;
1432
1433 if (ParentImageHandle == NULL) {
1434 return (EFI_INVALID_PARAMETER);
1435 }
1436
1437 InitializeListHead(&OrigEnvs);
1438
1439 NewHandle = NULL;
1440
1441 NewCmdLine = AllocateCopyPool (StrSize (CommandLine), CommandLine);
1442 if (NewCmdLine == NULL) {
1443 return EFI_OUT_OF_RESOURCES;
1444 }
1445
1446 for (Walker = NewCmdLine; Walker != NULL && *Walker != CHAR_NULL ; Walker++) {
1447 if (*Walker == L'^' && *(Walker+1) == L'#') {
1448 CopyMem(Walker, Walker+1, StrSize(Walker) - sizeof(Walker[0]));
1449 }
1450 }
1451
1452 //
1453 // Load the image with:
1454 // FALSE - not from boot manager and NULL, 0 being not already in memory
1455 //
1456 Status = gBS->LoadImage(
1457 FALSE,
1458 *ParentImageHandle,
1459 (EFI_DEVICE_PATH_PROTOCOL*)DevicePath,
1460 NULL,
1461 0,
1462 &NewHandle);
1463
1464 if (EFI_ERROR(Status)) {
1465 if (NewHandle != NULL) {
1466 gBS->UnloadImage(NewHandle);
1467 }
1468 return (Status);
1469 }
1470 Status = gBS->OpenProtocol(
1471 NewHandle,
1472 &gEfiLoadedImageProtocolGuid,
1473 (VOID**)&LoadedImage,
1474 gImageHandle,
1475 NULL,
1476 EFI_OPEN_PROTOCOL_GET_PROTOCOL);
1477
1478 if (!EFI_ERROR(Status)) {
1479 ASSERT(LoadedImage->LoadOptionsSize == 0);
1480 if (NewCmdLine != NULL) {
1481 LoadedImage->LoadOptionsSize = (UINT32)StrSize(NewCmdLine);
1482 LoadedImage->LoadOptions = (VOID*)NewCmdLine;
1483 }
1484
1485 //
1486 // Save our current environment settings for later restoration if necessary
1487 //
1488 if (Environment != NULL) {
1489 Status = GetEnvironmentVariableList(&OrigEnvs);
1490 if (!EFI_ERROR(Status)) {
1491 Status = SetEnvironmentVariables(Environment);
1492 }
1493 }
1494
1495 //
1496 // Initialize and install a shell parameters protocol on the image.
1497 //
1498 ShellParamsProtocol.StdIn = ShellInfoObject.NewShellParametersProtocol->StdIn;
1499 ShellParamsProtocol.StdOut = ShellInfoObject.NewShellParametersProtocol->StdOut;
1500 ShellParamsProtocol.StdErr = ShellInfoObject.NewShellParametersProtocol->StdErr;
1501 Status = UpdateArgcArgv(&ShellParamsProtocol, NewCmdLine, NULL, NULL);
1502 ASSERT_EFI_ERROR(Status);
1503 //
1504 // Replace Argv[0] with the full path of the binary we're executing:
1505 // If the command line was "foo", the binary might be called "foo.efi".
1506 // "The first entry in [Argv] is always the full file path of the
1507 // executable" - UEFI Shell Spec section 2.3
1508 //
1509 ImagePath = EfiShellGetFilePathFromDevicePath (DevicePath);
1510 // The image we're executing isn't necessarily in a filesystem - it might
1511 // be memory mapped. In this case EfiShellGetFilePathFromDevicePath will
1512 // return NULL, and we'll leave Argv[0] as UpdateArgcArgv set it.
1513 if (ImagePath != NULL) {
1514 if (ShellParamsProtocol.Argv == NULL) {
1515 // Command line was empty or null.
1516 // (UpdateArgcArgv sets Argv to NULL when CommandLine is "" or NULL)
1517 ShellParamsProtocol.Argv = AllocatePool (sizeof (CHAR16 *));
1518 if (ShellParamsProtocol.Argv == NULL) {
1519 Status = EFI_OUT_OF_RESOURCES;
1520 goto UnloadImage;
1521 }
1522 ShellParamsProtocol.Argc = 1;
1523 } else {
1524 // Free the string UpdateArgcArgv put in Argv[0];
1525 FreePool (ShellParamsProtocol.Argv[0]);
1526 }
1527 ShellParamsProtocol.Argv[0] = ImagePath;
1528 }
1529
1530 Status = gBS->InstallProtocolInterface(&NewHandle, &gEfiShellParametersProtocolGuid, EFI_NATIVE_INTERFACE, &ShellParamsProtocol);
1531 ASSERT_EFI_ERROR(Status);
1532
1533 ///@todo initialize and install ShellInterface protocol on the new image for compatibility if - PcdGetBool(PcdShellSupportOldProtocols)
1534
1535 //
1536 // now start the image and if the caller wanted the return code pass it to them...
1537 //
1538 if (!EFI_ERROR(Status)) {
1539 StartStatus = gBS->StartImage(
1540 NewHandle,
1541 0,
1542 NULL
1543 );
1544 if (StartImageStatus != NULL) {
1545 *StartImageStatus = StartStatus;
1546 }
1547
1548 CleanupStatus = gBS->UninstallProtocolInterface(
1549 NewHandle,
1550 &gEfiShellParametersProtocolGuid,
1551 &ShellParamsProtocol
1552 );
1553 ASSERT_EFI_ERROR(CleanupStatus);
1554
1555 goto FreeAlloc;
1556 }
1557
1558 UnloadImage:
1559 // Unload image - We should only get here if we didn't call StartImage
1560 gBS->UnloadImage (NewHandle);
1561
1562 FreeAlloc:
1563 // Free Argv (Allocated in UpdateArgcArgv)
1564 if (ShellParamsProtocol.Argv != NULL) {
1565 for (Index = 0; Index < ShellParamsProtocol.Argc; Index++) {
1566 if (ShellParamsProtocol.Argv[Index] != NULL) {
1567 FreePool (ShellParamsProtocol.Argv[Index]);
1568 }
1569 }
1570 FreePool (ShellParamsProtocol.Argv);
1571 }
1572 }
1573
1574 // Restore environment variables
1575 if (!IsListEmpty(&OrigEnvs)) {
1576 CleanupStatus = SetEnvironmentVariableList(&OrigEnvs);
1577 ASSERT_EFI_ERROR (CleanupStatus);
1578 }
1579
1580 FreePool (NewCmdLine);
1581
1582 return(Status);
1583 }
1584 /**
1585 Execute the command line.
1586
1587 This function creates a nested instance of the shell and executes the specified
1588 command (CommandLine) with the specified environment (Environment). Upon return,
1589 the status code returned by the specified command is placed in StatusCode.
1590
1591 If Environment is NULL, then the current environment is used and all changes made
1592 by the commands executed will be reflected in the current environment. If the
1593 Environment is non-NULL, then the changes made will be discarded.
1594
1595 The CommandLine is executed from the current working directory on the current
1596 device.
1597
1598 @param ParentImageHandle A handle of the image that is executing the specified
1599 command line.
1600 @param CommandLine Points to the NULL-terminated UCS-2 encoded string
1601 containing the command line. If NULL then the command-
1602 line will be empty.
1603 @param Environment Points to a NULL-terminated array of environment
1604 variables with the format 'x=y', where x is the
1605 environment variable name and y is the value. If this
1606 is NULL, then the current shell environment is used.
1607 @param StatusCode Points to the status code returned by the command.
1608
1609 @retval EFI_SUCCESS The command executed successfully. The status code
1610 returned by the command is pointed to by StatusCode.
1611 @retval EFI_INVALID_PARAMETER The parameters are invalid.
1612 @retval EFI_OUT_OF_RESOURCES Out of resources.
1613 @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.
1614 @retval EFI_UNSUPPORTED The support level required for this function is not present.
1615
1616 @sa InternalShellExecuteDevicePath
1617 **/
1618 EFI_STATUS
1619 EFIAPI
1620 EfiShellExecute(
1621 IN EFI_HANDLE *ParentImageHandle,
1622 IN CHAR16 *CommandLine OPTIONAL,
1623 IN CHAR16 **Environment OPTIONAL,
1624 OUT EFI_STATUS *StatusCode OPTIONAL
1625 )
1626 {
1627 EFI_STATUS Status;
1628 CHAR16 *Temp;
1629 EFI_DEVICE_PATH_PROTOCOL *DevPath;
1630 UINTN Size;
1631
1632 if ((PcdGet8(PcdShellSupportLevel) < 1)) {
1633 return (EFI_UNSUPPORTED);
1634 }
1635
1636 DevPath = AppendDevicePath (ShellInfoObject.ImageDevPath, ShellInfoObject.FileDevPath);
1637
1638 DEBUG_CODE_BEGIN();
1639 Temp = ConvertDevicePathToText(ShellInfoObject.FileDevPath, TRUE, TRUE);
1640 FreePool(Temp);
1641 Temp = ConvertDevicePathToText(ShellInfoObject.ImageDevPath, TRUE, TRUE);
1642 FreePool(Temp);
1643 Temp = ConvertDevicePathToText(DevPath, TRUE, TRUE);
1644 FreePool(Temp);
1645 DEBUG_CODE_END();
1646
1647 Temp = NULL;
1648 Size = 0;
1649 ASSERT((Temp == NULL && Size == 0) || (Temp != NULL));
1650 StrnCatGrow(&Temp, &Size, L"Shell.efi -_exit ", 0);
1651 StrnCatGrow(&Temp, &Size, CommandLine, 0);
1652
1653 Status = InternalShellExecuteDevicePath(
1654 ParentImageHandle,
1655 DevPath,
1656 Temp,
1657 (CONST CHAR16**)Environment,
1658 StatusCode);
1659
1660 //
1661 // de-allocate and return
1662 //
1663 FreePool(DevPath);
1664 FreePool(Temp);
1665 return(Status);
1666 }
1667
1668 /**
1669 Utility cleanup function for EFI_SHELL_FILE_INFO objects.
1670
1671 1) frees all pointers (non-NULL)
1672 2) Closes the SHELL_FILE_HANDLE
1673
1674 @param FileListNode pointer to the list node to free
1675 **/
1676 VOID
1677 EFIAPI
1678 InternalFreeShellFileInfoNode(
1679 IN EFI_SHELL_FILE_INFO *FileListNode
1680 )
1681 {
1682 if (FileListNode->Info != NULL) {
1683 FreePool((VOID*)FileListNode->Info);
1684 }
1685 if (FileListNode->FileName != NULL) {
1686 FreePool((VOID*)FileListNode->FileName);
1687 }
1688 if (FileListNode->FullName != NULL) {
1689 FreePool((VOID*)FileListNode->FullName);
1690 }
1691 if (FileListNode->Handle != NULL) {
1692 ShellInfoObject.NewEfiShellProtocol->CloseFile(FileListNode->Handle);
1693 }
1694 FreePool(FileListNode);
1695 }
1696 /**
1697 Frees the file list.
1698
1699 This function cleans up the file list and any related data structures. It has no
1700 impact on the files themselves.
1701
1702 @param FileList The file list to free. Type EFI_SHELL_FILE_INFO is
1703 defined in OpenFileList()
1704
1705 @retval EFI_SUCCESS Free the file list successfully.
1706 @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;
1707 **/
1708 EFI_STATUS
1709 EFIAPI
1710 EfiShellFreeFileList(
1711 IN EFI_SHELL_FILE_INFO **FileList
1712 )
1713 {
1714 EFI_SHELL_FILE_INFO *ShellFileListItem;
1715
1716 if (FileList == NULL || *FileList == NULL) {
1717 return (EFI_INVALID_PARAMETER);
1718 }
1719
1720 for ( ShellFileListItem = (EFI_SHELL_FILE_INFO*)GetFirstNode(&(*FileList)->Link)
1721 ; !IsListEmpty(&(*FileList)->Link)
1722 ; ShellFileListItem = (EFI_SHELL_FILE_INFO*)GetFirstNode(&(*FileList)->Link)
1723 ){
1724 RemoveEntryList(&ShellFileListItem->Link);
1725 InternalFreeShellFileInfoNode(ShellFileListItem);
1726 }
1727 InternalFreeShellFileInfoNode(*FileList);
1728 *FileList = NULL;
1729 return(EFI_SUCCESS);
1730 }
1731
1732 /**
1733 Deletes the duplicate file names files in the given file list.
1734
1735 This function deletes the reduplicate files in the given file list.
1736
1737 @param FileList A pointer to the first entry in the file list.
1738
1739 @retval EFI_SUCCESS Always success.
1740 @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;
1741 **/
1742 EFI_STATUS
1743 EFIAPI
1744 EfiShellRemoveDupInFileList(
1745 IN EFI_SHELL_FILE_INFO **FileList
1746 )
1747 {
1748 EFI_SHELL_FILE_INFO *ShellFileListItem;
1749 EFI_SHELL_FILE_INFO *ShellFileListItem2;
1750 EFI_SHELL_FILE_INFO *TempNode;
1751
1752 if (FileList == NULL || *FileList == NULL) {
1753 return (EFI_INVALID_PARAMETER);
1754 }
1755 for ( ShellFileListItem = (EFI_SHELL_FILE_INFO*)GetFirstNode(&(*FileList)->Link)
1756 ; !IsNull(&(*FileList)->Link, &ShellFileListItem->Link)
1757 ; ShellFileListItem = (EFI_SHELL_FILE_INFO*)GetNextNode(&(*FileList)->Link, &ShellFileListItem->Link)
1758 ){
1759 for ( ShellFileListItem2 = (EFI_SHELL_FILE_INFO*)GetNextNode(&(*FileList)->Link, &ShellFileListItem->Link)
1760 ; !IsNull(&(*FileList)->Link, &ShellFileListItem2->Link)
1761 ; ShellFileListItem2 = (EFI_SHELL_FILE_INFO*)GetNextNode(&(*FileList)->Link, &ShellFileListItem2->Link)
1762 ){
1763 if (gUnicodeCollation->StriColl(
1764 gUnicodeCollation,
1765 (CHAR16*)ShellFileListItem->FullName,
1766 (CHAR16*)ShellFileListItem2->FullName) == 0
1767 ){
1768 TempNode = (EFI_SHELL_FILE_INFO *)GetPreviousNode(
1769 &(*FileList)->Link,
1770 &ShellFileListItem2->Link
1771 );
1772 RemoveEntryList(&ShellFileListItem2->Link);
1773 InternalFreeShellFileInfoNode(ShellFileListItem2);
1774 // Set ShellFileListItem2 to PreviousNode so we don't access Freed
1775 // memory in GetNextNode in the loop expression above.
1776 ShellFileListItem2 = TempNode;
1777 }
1778 }
1779 }
1780 return (EFI_SUCCESS);
1781 }
1782
1783 //
1784 // This is the same structure as the external version, but it has no CONST qualifiers.
1785 //
1786 typedef struct {
1787 LIST_ENTRY Link; ///< Linked list members.
1788 EFI_STATUS Status; ///< Status of opening the file. Valid only if Handle != NULL.
1789 CHAR16 *FullName; ///< Fully qualified filename.
1790 CHAR16 *FileName; ///< name of this file.
1791 SHELL_FILE_HANDLE Handle; ///< Handle for interacting with the opened file or NULL if closed.
1792 EFI_FILE_INFO *Info; ///< Pointer to the FileInfo struct for this file or NULL.
1793 } EFI_SHELL_FILE_INFO_NO_CONST;
1794
1795 /**
1796 Allocates and duplicates a EFI_SHELL_FILE_INFO node.
1797
1798 @param[in] Node The node to copy from.
1799 @param[in] Save TRUE to set Node->Handle to NULL, FALSE otherwise.
1800
1801 @retval NULL a memory allocation error ocurred
1802 @return != NULL a pointer to the new node
1803 **/
1804 EFI_SHELL_FILE_INFO*
1805 EFIAPI
1806 InternalDuplicateShellFileInfo(
1807 IN EFI_SHELL_FILE_INFO *Node,
1808 IN BOOLEAN Save
1809 )
1810 {
1811 EFI_SHELL_FILE_INFO_NO_CONST *NewNode;
1812
1813 //
1814 // try to confirm that the objects are in sync
1815 //
1816 ASSERT(sizeof(EFI_SHELL_FILE_INFO_NO_CONST) == sizeof(EFI_SHELL_FILE_INFO));
1817
1818 NewNode = AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO));
1819 if (NewNode == NULL) {
1820 return (NULL);
1821 }
1822 NewNode->FullName = AllocateCopyPool(StrSize(Node->FullName), Node->FullName);
1823 NewNode->FileName = AllocateCopyPool(StrSize(Node->FileName), Node->FileName);
1824 NewNode->Info = AllocateCopyPool((UINTN)Node->Info->Size, Node->Info);
1825 if ( NewNode->FullName == NULL
1826 || NewNode->FileName == NULL
1827 || NewNode->Info == NULL
1828 ){
1829 SHELL_FREE_NON_NULL(NewNode->FullName);
1830 SHELL_FREE_NON_NULL(NewNode->FileName);
1831 SHELL_FREE_NON_NULL(NewNode->Info);
1832 SHELL_FREE_NON_NULL(NewNode);
1833 return(NULL);
1834 }
1835 NewNode->Status = Node->Status;
1836 NewNode->Handle = Node->Handle;
1837 if (!Save) {
1838 Node->Handle = NULL;
1839 }
1840
1841 return((EFI_SHELL_FILE_INFO*)NewNode);
1842 }
1843
1844 /**
1845 Allocates and populates a EFI_SHELL_FILE_INFO structure. if any memory operation
1846 failed it will return NULL.
1847
1848 @param[in] BasePath the Path to prepend onto filename for FullPath
1849 @param[in] Status Status member initial value.
1850 @param[in] FileName FileName member initial value.
1851 @param[in] Handle Handle member initial value.
1852 @param[in] Info Info struct to copy.
1853
1854 @retval NULL An error ocurred.
1855 @return a pointer to the newly allocated structure.
1856 **/
1857 EFI_SHELL_FILE_INFO *
1858 EFIAPI
1859 CreateAndPopulateShellFileInfo(
1860 IN CONST CHAR16 *BasePath,
1861 IN CONST EFI_STATUS Status,
1862 IN CONST CHAR16 *FileName,
1863 IN CONST SHELL_FILE_HANDLE Handle,
1864 IN CONST EFI_FILE_INFO *Info
1865 )
1866 {
1867 EFI_SHELL_FILE_INFO *ShellFileListItem;
1868 CHAR16 *TempString;
1869 UINTN Size;
1870
1871 TempString = NULL;
1872 Size = 0;
1873
1874 ShellFileListItem = AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO));
1875 if (ShellFileListItem == NULL) {
1876 return (NULL);
1877 }
1878 if (Info != NULL && Info->Size != 0) {
1879 ShellFileListItem->Info = AllocateZeroPool((UINTN)Info->Size);
1880 if (ShellFileListItem->Info == NULL) {
1881 FreePool(ShellFileListItem);
1882 return (NULL);
1883 }
1884 CopyMem(ShellFileListItem->Info, Info, (UINTN)Info->Size);
1885 } else {
1886 ShellFileListItem->Info = NULL;
1887 }
1888 if (FileName != NULL) {
1889 ASSERT(TempString == NULL);
1890 ShellFileListItem->FileName = StrnCatGrow(&TempString, 0, FileName, 0);
1891 if (ShellFileListItem->FileName == NULL) {
1892 FreePool(ShellFileListItem->Info);
1893 FreePool(ShellFileListItem);
1894 return (NULL);
1895 }
1896 } else {
1897 ShellFileListItem->FileName = NULL;
1898 }
1899 Size = 0;
1900 TempString = NULL;
1901 if (BasePath != NULL) {
1902 ASSERT((TempString == NULL && Size == 0) || (TempString != NULL));
1903 TempString = StrnCatGrow(&TempString, &Size, BasePath, 0);
1904 if (TempString == NULL) {
1905 FreePool((VOID*)ShellFileListItem->FileName);
1906 SHELL_FREE_NON_NULL(ShellFileListItem->Info);
1907 FreePool(ShellFileListItem);
1908 return (NULL);
1909 }
1910 }
1911 if (ShellFileListItem->FileName != NULL) {
1912 ASSERT((TempString == NULL && Size == 0) || (TempString != NULL));
1913 TempString = StrnCatGrow(&TempString, &Size, ShellFileListItem->FileName, 0);
1914 if (TempString == NULL) {
1915 FreePool((VOID*)ShellFileListItem->FileName);
1916 FreePool(ShellFileListItem->Info);
1917 FreePool(ShellFileListItem);
1918 return (NULL);
1919 }
1920 }
1921
1922 TempString = PathCleanUpDirectories(TempString);
1923
1924 ShellFileListItem->FullName = TempString;
1925 ShellFileListItem->Status = Status;
1926 ShellFileListItem->Handle = Handle;
1927
1928 return (ShellFileListItem);
1929 }
1930
1931 /**
1932 Find all files in a specified directory.
1933
1934 @param FileDirHandle Handle of the directory to search.
1935 @param FileList On return, points to the list of files in the directory
1936 or NULL if there are no files in the directory.
1937
1938 @retval EFI_SUCCESS File information was returned successfully.
1939 @retval EFI_VOLUME_CORRUPTED The file system structures have been corrupted.
1940 @retval EFI_DEVICE_ERROR The device reported an error.
1941 @retval EFI_NO_MEDIA The device media is not present.
1942 @retval EFI_INVALID_PARAMETER The FileDirHandle was not a directory.
1943 @return An error from FileHandleGetFileName().
1944 **/
1945 EFI_STATUS
1946 EFIAPI
1947 EfiShellFindFilesInDir(
1948 IN SHELL_FILE_HANDLE FileDirHandle,
1949 OUT EFI_SHELL_FILE_INFO **FileList
1950 )
1951 {
1952 EFI_SHELL_FILE_INFO *ShellFileList;
1953 EFI_SHELL_FILE_INFO *ShellFileListItem;
1954 EFI_FILE_INFO *FileInfo;
1955 EFI_STATUS Status;
1956 BOOLEAN NoFile;
1957 CHAR16 *TempString;
1958 CHAR16 *BasePath;
1959 UINTN Size;
1960 CHAR16 *TempSpot;
1961
1962 BasePath = NULL;
1963 Status = FileHandleGetFileName(FileDirHandle, &BasePath);
1964 if (EFI_ERROR(Status)) {
1965 return (Status);
1966 }
1967
1968 if (ShellFileHandleGetPath(FileDirHandle) != NULL) {
1969 TempString = NULL;
1970 Size = 0;
1971 TempString = StrnCatGrow(&TempString, &Size, ShellFileHandleGetPath(FileDirHandle), 0);
1972 if (TempString == NULL) {
1973 SHELL_FREE_NON_NULL(BasePath);
1974 return (EFI_OUT_OF_RESOURCES);
1975 }
1976 TempSpot = StrStr(TempString, L";");
1977
1978 if (TempSpot != NULL) {
1979 *TempSpot = CHAR_NULL;
1980 }
1981
1982 TempString = StrnCatGrow(&TempString, &Size, BasePath, 0);
1983 if (TempString == NULL) {
1984 SHELL_FREE_NON_NULL(BasePath);
1985 return (EFI_OUT_OF_RESOURCES);
1986 }
1987 SHELL_FREE_NON_NULL(BasePath);
1988 BasePath = TempString;
1989 }
1990
1991 NoFile = FALSE;
1992 ShellFileList = NULL;
1993 ShellFileListItem = NULL;
1994 FileInfo = NULL;
1995 Status = EFI_SUCCESS;
1996
1997
1998 for ( Status = FileHandleFindFirstFile(FileDirHandle, &FileInfo)
1999 ; !EFI_ERROR(Status) && !NoFile
2000 ; Status = FileHandleFindNextFile(FileDirHandle, FileInfo, &NoFile)
2001 ){
2002 //
2003 // allocate a new EFI_SHELL_FILE_INFO and populate it...
2004 //
2005 ShellFileListItem = CreateAndPopulateShellFileInfo(
2006 BasePath,
2007 EFI_SUCCESS, // success since we didnt fail to open it...
2008 FileInfo->FileName,
2009 NULL, // no handle since not open
2010 FileInfo);
2011
2012 if (ShellFileList == NULL) {
2013 ShellFileList = (EFI_SHELL_FILE_INFO*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO));
2014 ASSERT(ShellFileList != NULL);
2015 InitializeListHead(&ShellFileList->Link);
2016 }
2017 InsertTailList(&ShellFileList->Link, &ShellFileListItem->Link);
2018 }
2019 if (EFI_ERROR(Status)) {
2020 EfiShellFreeFileList(&ShellFileList);
2021 *FileList = NULL;
2022 } else {
2023 *FileList = ShellFileList;
2024 }
2025 SHELL_FREE_NON_NULL(BasePath);
2026 return(Status);
2027 }
2028
2029 /**
2030 Get the GUID value from a human readable name.
2031
2032 If GuidName is a known GUID name, then update Guid to have the correct value for
2033 that GUID.
2034
2035 This function is only available when the major and minor versions in the
2036 EfiShellProtocol are greater than or equal to 2 and 1, respectively.
2037
2038 @param[in] GuidName A pointer to the localized name for the GUID being queried.
2039 @param[out] Guid A pointer to the GUID structure to be filled in.
2040
2041 @retval EFI_SUCCESS The operation was successful.
2042 @retval EFI_INVALID_PARAMETER Guid was NULL.
2043 @retval EFI_INVALID_PARAMETER GuidName was NULL.
2044 @retval EFI_NOT_FOUND GuidName is not a known GUID Name.
2045 **/
2046 EFI_STATUS
2047 EFIAPI
2048 EfiShellGetGuidFromName(
2049 IN CONST CHAR16 *GuidName,
2050 OUT EFI_GUID *Guid
2051 )
2052 {
2053 EFI_GUID *NewGuid;
2054 EFI_STATUS Status;
2055
2056 if (Guid == NULL || GuidName == NULL) {
2057 return (EFI_INVALID_PARAMETER);
2058 }
2059
2060 Status = GetGuidFromStringName(GuidName, NULL, &NewGuid);
2061
2062 if (!EFI_ERROR(Status)) {
2063 CopyGuid(NewGuid, Guid);
2064 }
2065
2066 return (Status);
2067 }
2068
2069 /**
2070 Get the human readable name for a GUID from the value.
2071
2072 If Guid is assigned a name, then update *GuidName to point to the name. The callee
2073 should not modify the value.
2074
2075 This function is only available when the major and minor versions in the
2076 EfiShellProtocol are greater than or equal to 2 and 1, respectively.
2077
2078 @param[in] Guid A pointer to the GUID being queried.
2079 @param[out] GuidName A pointer to a pointer the localized to name for the GUID being requested
2080
2081 @retval EFI_SUCCESS The operation was successful.
2082 @retval EFI_INVALID_PARAMETER Guid was NULL.
2083 @retval EFI_INVALID_PARAMETER GuidName was NULL.
2084 @retval EFI_NOT_FOUND Guid is not assigned a name.
2085 **/
2086 EFI_STATUS
2087 EFIAPI
2088 EfiShellGetGuidName(
2089 IN CONST EFI_GUID *Guid,
2090 OUT CONST CHAR16 **GuidName
2091 )
2092 {
2093 CHAR16 *Name;
2094
2095 if (Guid == NULL || GuidName == NULL) {
2096 return (EFI_INVALID_PARAMETER);
2097 }
2098
2099 Name = GetStringNameFromGuid(Guid, NULL);
2100 if (Name == NULL || StrLen(Name) == 0) {
2101 SHELL_FREE_NON_NULL(Name);
2102 return (EFI_NOT_FOUND);
2103 }
2104
2105 *GuidName = AddBufferToFreeList(Name);
2106
2107 return (EFI_SUCCESS);
2108 }
2109
2110 /**
2111 Updates a file name to be preceeded by the mapped drive name
2112
2113 @param[in] BasePath the Mapped drive name to prepend
2114 @param[in, out] Path pointer to pointer to the file name to update.
2115
2116 @retval EFI_SUCCESS
2117 @retval EFI_OUT_OF_RESOURCES
2118 **/
2119 EFI_STATUS
2120 EFIAPI
2121 UpdateFileName(
2122 IN CONST CHAR16 *BasePath,
2123 IN OUT CHAR16 **Path
2124 )
2125 {
2126 CHAR16 *Path2;
2127 UINTN Path2Size;
2128
2129 Path2Size = 0;
2130 Path2 = NULL;
2131
2132 ASSERT(Path != NULL);
2133 ASSERT(*Path != NULL);
2134 ASSERT(BasePath != NULL);
2135
2136 //
2137 // convert a local path to an absolute path
2138 //
2139 if (StrStr(*Path, L":") == NULL) {
2140 ASSERT((Path2 == NULL && Path2Size == 0) || (Path2 != NULL));
2141 StrnCatGrow(&Path2, &Path2Size, BasePath, 0);
2142 if (Path2 == NULL) {
2143 return (EFI_OUT_OF_RESOURCES);
2144 }
2145 ASSERT((Path2 == NULL && Path2Size == 0) || (Path2 != NULL));
2146 StrnCatGrow(&Path2, &Path2Size, (*Path)[0] == L'\\'?(*Path) + 1 :*Path, 0);
2147 if (Path2 == NULL) {
2148 return (EFI_OUT_OF_RESOURCES);
2149 }
2150 }
2151
2152 FreePool(*Path);
2153 (*Path) = Path2;
2154
2155 return (EFI_SUCCESS);
2156 }
2157
2158 /**
2159 If FileHandle is a directory then the function reads from FileHandle and reads in
2160 each of the FileInfo structures. If one of them matches the Pattern's first
2161 "level" then it opens that handle and calls itself on that handle.
2162
2163 If FileHandle is a file and matches all of the remaining Pattern (which would be
2164 on its last node), then add a EFI_SHELL_FILE_INFO object for this file to fileList.
2165
2166 Upon a EFI_SUCCESS return fromt he function any the caller is responsible to call
2167 FreeFileList with FileList.
2168
2169 @param[in] FilePattern The FilePattern to check against.
2170 @param[in] UnicodeCollation The pointer to EFI_UNICODE_COLLATION_PROTOCOL structure
2171 @param[in] FileHandle The FileHandle to start with
2172 @param[in, out] FileList pointer to pointer to list of found files.
2173 @param[in] ParentNode The node for the parent. Same file as identified by HANDLE.
2174 @param[in] MapName The file system name this file is on.
2175
2176 @retval EFI_SUCCESS all files were found and the FileList contains a list.
2177 @retval EFI_NOT_FOUND no files were found
2178 @retval EFI_OUT_OF_RESOURCES a memory allocation failed
2179 **/
2180 EFI_STATUS
2181 EFIAPI
2182 ShellSearchHandle(
2183 IN CONST CHAR16 *FilePattern,
2184 IN EFI_UNICODE_COLLATION_PROTOCOL *UnicodeCollation,
2185 IN SHELL_FILE_HANDLE FileHandle,
2186 IN OUT EFI_SHELL_FILE_INFO **FileList,
2187 IN CONST EFI_SHELL_FILE_INFO *ParentNode OPTIONAL,
2188 IN CONST CHAR16 *MapName
2189 )
2190 {
2191 EFI_STATUS Status;
2192 CONST CHAR16 *NextFilePatternStart;
2193 CHAR16 *CurrentFilePattern;
2194 EFI_SHELL_FILE_INFO *ShellInfo;
2195 EFI_SHELL_FILE_INFO *ShellInfoNode;
2196 EFI_SHELL_FILE_INFO *NewShellNode;
2197 EFI_FILE_INFO *FileInfo;
2198 BOOLEAN Directory;
2199 CHAR16 *NewFullName;
2200 UINTN Size;
2201
2202 if ( FilePattern == NULL
2203 || UnicodeCollation == NULL
2204 || FileList == NULL
2205 ){
2206 return (EFI_INVALID_PARAMETER);
2207 }
2208 ShellInfo = NULL;
2209 CurrentFilePattern = NULL;
2210
2211 if (*FilePattern == L'\\') {
2212 FilePattern++;
2213 }
2214
2215 for( NextFilePatternStart = FilePattern
2216 ; *NextFilePatternStart != CHAR_NULL && *NextFilePatternStart != L'\\'
2217 ; NextFilePatternStart++);
2218
2219 CurrentFilePattern = AllocateZeroPool((NextFilePatternStart-FilePattern+1)*sizeof(CHAR16));
2220 ASSERT(CurrentFilePattern != NULL);
2221 StrnCpy(CurrentFilePattern, FilePattern, NextFilePatternStart-FilePattern);
2222
2223 if (CurrentFilePattern[0] == CHAR_NULL
2224 &&NextFilePatternStart[0] == CHAR_NULL
2225 ){
2226 //
2227 // we want the parent or root node (if no parent)
2228 //
2229 if (ParentNode == NULL) {
2230 //
2231 // We want the root node. create the node.
2232 //
2233 FileInfo = FileHandleGetInfo(FileHandle);
2234 NewShellNode = CreateAndPopulateShellFileInfo(
2235 MapName,
2236 EFI_SUCCESS,
2237 L"\\",
2238 FileHandle,
2239 FileInfo
2240 );
2241 SHELL_FREE_NON_NULL(FileInfo);
2242 } else {
2243 //
2244 // Add the current parameter FileHandle to the list, then end...
2245 //
2246 NewShellNode = InternalDuplicateShellFileInfo((EFI_SHELL_FILE_INFO*)ParentNode, TRUE);
2247 }
2248 if (NewShellNode == NULL) {
2249 Status = EFI_OUT_OF_RESOURCES;
2250 } else {
2251 NewShellNode->Handle = NULL;
2252 if (*FileList == NULL) {
2253 *FileList = AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO));
2254 InitializeListHead(&((*FileList)->Link));
2255 }
2256
2257 //
2258 // Add to the returning to use list
2259 //
2260 InsertTailList(&(*FileList)->Link, &NewShellNode->Link);
2261
2262 Status = EFI_SUCCESS;
2263 }
2264 } else {
2265 Status = EfiShellFindFilesInDir(FileHandle, &ShellInfo);
2266
2267 if (!EFI_ERROR(Status)){
2268 if (StrStr(NextFilePatternStart, L"\\") != NULL){
2269 Directory = TRUE;
2270 } else {
2271 Directory = FALSE;
2272 }
2273 for ( ShellInfoNode = (EFI_SHELL_FILE_INFO*)GetFirstNode(&ShellInfo->Link)
2274 ; !IsNull (&ShellInfo->Link, &ShellInfoNode->Link)
2275 ; ShellInfoNode = (EFI_SHELL_FILE_INFO*)GetNextNode(&ShellInfo->Link, &ShellInfoNode->Link)
2276 ){
2277 if (UnicodeCollation->MetaiMatch(UnicodeCollation, (CHAR16*)ShellInfoNode->FileName, CurrentFilePattern)){
2278 if (ShellInfoNode->FullName != NULL && StrStr(ShellInfoNode->FullName, L":") == NULL) {
2279 Size = StrSize(ShellInfoNode->FullName);
2280 Size += StrSize(MapName) + sizeof(CHAR16);
2281 NewFullName = AllocateZeroPool(Size);
2282 if (NewFullName == NULL) {
2283 Status = EFI_OUT_OF_RESOURCES;
2284 } else {
2285 StrnCpy(NewFullName, MapName, Size/sizeof(CHAR16)-1);
2286 StrnCat(NewFullName, ShellInfoNode->FullName+1, (Size/sizeof(CHAR16))-StrLen(NewFullName)-1);
2287 FreePool((VOID*)ShellInfoNode->FullName);
2288 ShellInfoNode->FullName = NewFullName;
2289 }
2290 }
2291 if (Directory && !EFI_ERROR(Status) && ShellInfoNode->FullName != NULL && ShellInfoNode->FileName != NULL){
2292 //
2293 // should be a directory
2294 //
2295
2296 //
2297 // don't open the . and .. directories
2298 //
2299 if ( (StrCmp(ShellInfoNode->FileName, L".") != 0)
2300 && (StrCmp(ShellInfoNode->FileName, L"..") != 0)
2301 ){
2302 //
2303 //
2304 //
2305 if (EFI_ERROR(Status)) {
2306 break;
2307 }
2308 //
2309 // Open the directory since we need that handle in the next recursion.
2310 //
2311 ShellInfoNode->Status = EfiShellOpenFileByName (ShellInfoNode->FullName, &ShellInfoNode->Handle, EFI_FILE_MODE_READ);
2312
2313 //
2314 // recurse with the next part of the pattern
2315 //
2316 Status = ShellSearchHandle(NextFilePatternStart, UnicodeCollation, ShellInfoNode->Handle, FileList, ShellInfoNode, MapName);
2317 }
2318 } else if (!EFI_ERROR(Status)) {
2319 //
2320 // should be a file
2321 //
2322
2323 //
2324 // copy the information we need into a new Node
2325 //
2326 NewShellNode = InternalDuplicateShellFileInfo(ShellInfoNode, FALSE);
2327 ASSERT(NewShellNode != NULL);
2328 if (NewShellNode == NULL) {
2329 Status = EFI_OUT_OF_RESOURCES;
2330 }
2331 if (*FileList == NULL) {
2332 *FileList = AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO));
2333 InitializeListHead(&((*FileList)->Link));
2334 }
2335
2336 //
2337 // Add to the returning to use list
2338 //
2339 InsertTailList(&(*FileList)->Link, &NewShellNode->Link);
2340 }
2341 }
2342 if (EFI_ERROR(Status)) {
2343 break;
2344 }
2345 }
2346 if (EFI_ERROR(Status)) {
2347 EfiShellFreeFileList(&ShellInfo);
2348 } else {
2349 Status = EfiShellFreeFileList(&ShellInfo);
2350 }
2351 }
2352 }
2353
2354 FreePool(CurrentFilePattern);
2355 return (Status);
2356 }
2357
2358 /**
2359 Find files that match a specified pattern.
2360
2361 This function searches for all files and directories that match the specified
2362 FilePattern. The FilePattern can contain wild-card characters. The resulting file
2363 information is placed in the file list FileList.
2364
2365 Wildcards are processed
2366 according to the rules specified in UEFI Shell 2.0 spec section 3.7.1.
2367
2368 The files in the file list are not opened. The OpenMode field is set to 0 and the FileInfo
2369 field is set to NULL.
2370
2371 if *FileList is not NULL then it must be a pre-existing and properly initialized list.
2372
2373 @param FilePattern Points to a NULL-terminated shell file path, including wildcards.
2374 @param FileList On return, points to the start of a file list containing the names
2375 of all matching files or else points to NULL if no matching files
2376 were found. only on a EFI_SUCCESS return will; this be non-NULL.
2377
2378 @retval EFI_SUCCESS Files found. FileList is a valid list.
2379 @retval EFI_NOT_FOUND No files found.
2380 @retval EFI_NO_MEDIA The device has no media
2381 @retval EFI_DEVICE_ERROR The device reported an error
2382 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
2383 **/
2384 EFI_STATUS
2385 EFIAPI
2386 EfiShellFindFiles(
2387 IN CONST CHAR16 *FilePattern,
2388 OUT EFI_SHELL_FILE_INFO **FileList
2389 )
2390 {
2391 EFI_STATUS Status;
2392 CHAR16 *PatternCopy;
2393 CHAR16 *PatternCurrentLocation;
2394 EFI_DEVICE_PATH_PROTOCOL *RootDevicePath;
2395 SHELL_FILE_HANDLE RootFileHandle;
2396 CHAR16 *MapName;
2397 UINTN Count;
2398
2399 if ( FilePattern == NULL
2400 || FileList == NULL
2401 || StrStr(FilePattern, L":") == NULL
2402 ){
2403 return (EFI_INVALID_PARAMETER);
2404 }
2405 Status = EFI_SUCCESS;
2406 RootDevicePath = NULL;
2407 RootFileHandle = NULL;
2408 MapName = NULL;
2409 PatternCopy = AllocateCopyPool(StrSize(FilePattern), FilePattern);
2410 if (PatternCopy == NULL) {
2411 return (EFI_OUT_OF_RESOURCES);
2412 }
2413
2414 PatternCopy = PathCleanUpDirectories(PatternCopy);
2415
2416 Count = StrStr(PatternCopy, L":") - PatternCopy;
2417 Count += 2;
2418
2419 ASSERT(MapName == NULL);
2420 MapName = StrnCatGrow(&MapName, NULL, PatternCopy, Count);
2421 if (MapName == NULL) {
2422 Status = EFI_OUT_OF_RESOURCES;
2423 } else {
2424 RootDevicePath = EfiShellGetDevicePathFromFilePath(PatternCopy);
2425 if (RootDevicePath == NULL) {
2426 Status = EFI_INVALID_PARAMETER;
2427 } else {
2428 Status = EfiShellOpenRoot(RootDevicePath, &RootFileHandle);
2429 if (!EFI_ERROR(Status)) {
2430 for ( PatternCurrentLocation = PatternCopy
2431 ; *PatternCurrentLocation != ':'
2432 ; PatternCurrentLocation++);
2433 PatternCurrentLocation++;
2434 Status = ShellSearchHandle(PatternCurrentLocation, gUnicodeCollation, RootFileHandle, FileList, NULL, MapName);
2435 }
2436 FreePool(RootDevicePath);
2437 }
2438 }
2439
2440 SHELL_FREE_NON_NULL(PatternCopy);
2441 SHELL_FREE_NON_NULL(MapName);
2442
2443 return(Status);
2444 }
2445
2446 /**
2447 Opens the files that match the path specified.
2448
2449 This function opens all of the files specified by Path. Wildcards are processed
2450 according to the rules specified in UEFI Shell 2.0 spec section 3.7.1. Each
2451 matching file has an EFI_SHELL_FILE_INFO structure created in a linked list.
2452
2453 @param Path A pointer to the path string.
2454 @param OpenMode Specifies the mode used to open each file, EFI_FILE_MODE_READ or
2455 EFI_FILE_MODE_WRITE.
2456 @param FileList Points to the start of a list of files opened.
2457
2458 @retval EFI_SUCCESS Create the file list successfully.
2459 @return Others Can't create the file list.
2460 **/
2461 EFI_STATUS
2462 EFIAPI
2463 EfiShellOpenFileList(
2464 IN CHAR16 *Path,
2465 IN UINT64 OpenMode,
2466 IN OUT EFI_SHELL_FILE_INFO **FileList
2467 )
2468 {
2469 EFI_STATUS Status;
2470 EFI_SHELL_FILE_INFO *ShellFileListItem;
2471 CHAR16 *Path2;
2472 UINTN Path2Size;
2473 CONST CHAR16 *CurDir;
2474 BOOLEAN Found;
2475
2476 PathCleanUpDirectories(Path);
2477
2478 Path2Size = 0;
2479 Path2 = NULL;
2480
2481 if (FileList == NULL || *FileList == NULL) {
2482 return (EFI_INVALID_PARAMETER);
2483 }
2484
2485 if (*Path == L'.' && *(Path+1) == L'\\') {
2486 Path+=2;
2487 }
2488
2489 //
2490 // convert a local path to an absolute path
2491 //
2492 if (StrStr(Path, L":") == NULL) {
2493 CurDir = EfiShellGetCurDir(NULL);
2494 ASSERT((Path2 == NULL && Path2Size == 0) || (Path2 != NULL));
2495 StrnCatGrow(&Path2, &Path2Size, CurDir, 0);
2496 if (*Path == L'\\') {
2497 Path++;
2498 while (PathRemoveLastItem(Path2)) ;
2499 }
2500 ASSERT((Path2 == NULL && Path2Size == 0) || (Path2 != NULL));
2501 StrnCatGrow(&Path2, &Path2Size, Path, 0);
2502 } else {
2503 ASSERT(Path2 == NULL);
2504 StrnCatGrow(&Path2, NULL, Path, 0);
2505 }
2506
2507 PathCleanUpDirectories (Path2);
2508
2509 //
2510 // do the search
2511 //
2512 Status = EfiShellFindFiles(Path2, FileList);
2513
2514 FreePool(Path2);
2515
2516 if (EFI_ERROR(Status)) {
2517 return (Status);
2518 }
2519
2520 Found = FALSE;
2521 //
2522 // We had no errors so open all the files (that are not already opened...)
2523 //
2524 for ( ShellFileListItem = (EFI_SHELL_FILE_INFO*)GetFirstNode(&(*FileList)->Link)
2525 ; !IsNull(&(*FileList)->Link, &ShellFileListItem->Link)
2526 ; ShellFileListItem = (EFI_SHELL_FILE_INFO*)GetNextNode(&(*FileList)->Link, &ShellFileListItem->Link)
2527 ){
2528 if (ShellFileListItem->Status == 0 && ShellFileListItem->Handle == NULL) {
2529 ShellFileListItem->Status = EfiShellOpenFileByName (ShellFileListItem->FullName, &ShellFileListItem->Handle, OpenMode);
2530 Found = TRUE;
2531 }
2532 }
2533
2534 if (!Found) {
2535 return (EFI_NOT_FOUND);
2536 }
2537 return(EFI_SUCCESS);
2538 }
2539
2540 /**
2541 Gets the environment variable and Attributes, or list of environment variables. Can be
2542 used instead of GetEnv().
2543
2544 This function returns the current value of the specified environment variable and
2545 the Attributes. If no variable name was specified, then all of the known
2546 variables will be returned.
2547
2548 @param[in] Name A pointer to the environment variable name. If Name is NULL,
2549 then the function will return all of the defined shell
2550 environment variables. In the case where multiple environment
2551 variables are being returned, each variable will be terminated
2552 by a NULL, and the list will be terminated by a double NULL.
2553 @param[out] Attributes If not NULL, a pointer to the returned attributes bitmask for
2554 the environment variable. In the case where Name is NULL, and
2555 multiple environment variables are being returned, Attributes
2556 is undefined.
2557
2558 @retval NULL The environment variable doesn't exist.
2559 @return A non-NULL value points to the variable's value. The returned
2560 pointer does not need to be freed by the caller.
2561 **/
2562 CONST CHAR16 *
2563 EFIAPI
2564 EfiShellGetEnvEx(
2565 IN CONST CHAR16 *Name,
2566 OUT UINT32 *Attributes OPTIONAL
2567 )
2568 {
2569 EFI_STATUS Status;
2570 VOID *Buffer;
2571 UINTN Size;
2572 LIST_ENTRY List;
2573 ENV_VAR_LIST *Node;
2574 CHAR16 *CurrentWriteLocation;
2575
2576 Size = 0;
2577 Buffer = NULL;
2578
2579 if (Name == NULL) {
2580 //
2581 // Get all our environment variables
2582 //
2583 InitializeListHead(&List);
2584 Status = GetEnvironmentVariableList(&List);
2585 if (EFI_ERROR(Status)){
2586 return (NULL);
2587 }
2588
2589 //
2590 // Build the semi-colon delimited list. (2 passes)
2591 //
2592 for ( Node = (ENV_VAR_LIST*)GetFirstNode(&List)
2593 ; !IsNull(&List, &Node->Link)
2594 ; Node = (ENV_VAR_LIST*)GetNextNode(&List, &Node->Link)
2595 ){
2596 ASSERT(Node->Key != NULL);
2597 Size += StrSize(Node->Key);
2598 }
2599
2600 Size += 2*sizeof(CHAR16);
2601
2602 Buffer = AllocateZeroPool(Size);
2603 if (Buffer == NULL) {
2604 if (!IsListEmpty (&List)) {
2605 FreeEnvironmentVariableList(&List);
2606 }
2607 return (NULL);
2608 }
2609 CurrentWriteLocation = (CHAR16*)Buffer;
2610
2611 for ( Node = (ENV_VAR_LIST*)GetFirstNode(&List)
2612 ; !IsNull(&List, &Node->Link)
2613 ; Node = (ENV_VAR_LIST*)GetNextNode(&List, &Node->Link)
2614 ){
2615 ASSERT(Node->Key != NULL);
2616 StrnCpy(CurrentWriteLocation, Node->Key, (Size)/sizeof(CHAR16) - (CurrentWriteLocation - ((CHAR16*)Buffer)) - 1);
2617 CurrentWriteLocation += StrLen(CurrentWriteLocation) + 1;
2618 }
2619
2620 //
2621 // Free the list...
2622 //
2623 if (!IsListEmpty (&List)) {
2624 FreeEnvironmentVariableList(&List);
2625 }
2626 } else {
2627 //
2628 // We are doing a specific environment variable
2629 //
2630
2631 //
2632 // get the size we need for this EnvVariable
2633 //
2634 Status = SHELL_GET_ENVIRONMENT_VARIABLE_AND_ATTRIBUTES(Name, Attributes, &Size, Buffer);
2635 if (Status == EFI_BUFFER_TOO_SMALL) {
2636 //
2637 // Allocate the space and recall the get function
2638 //
2639 Buffer = AllocateZeroPool(Size);
2640 Status = SHELL_GET_ENVIRONMENT_VARIABLE_AND_ATTRIBUTES(Name, Attributes, &Size, Buffer);
2641 }
2642 //
2643 // we didnt get it (might not exist)
2644 // free the memory if we allocated any and return NULL
2645 //
2646 if (EFI_ERROR(Status)) {
2647 if (Buffer != NULL) {
2648 FreePool(Buffer);
2649 }
2650 return (NULL);
2651 }
2652 }
2653
2654 //
2655 // return the buffer
2656 //
2657 return (AddBufferToFreeList(Buffer));
2658 }
2659
2660 /**
2661 Gets either a single or list of environment variables.
2662
2663 If name is not NULL then this function returns the current value of the specified
2664 environment variable.
2665
2666 If Name is NULL, then a list of all environment variable names is returned. Each is a
2667 NULL terminated string with a double NULL terminating the list.
2668
2669 @param Name A pointer to the environment variable name. If
2670 Name is NULL, then the function will return all
2671 of the defined shell environment variables. In
2672 the case where multiple environment variables are
2673 being returned, each variable will be terminated by
2674 a NULL, and the list will be terminated by a double
2675 NULL.
2676
2677 @retval !=NULL A pointer to the returned string.
2678 The returned pointer does not need to be freed by the caller.
2679
2680 @retval NULL The environment variable doesn't exist or there are
2681 no environment variables.
2682 **/
2683 CONST CHAR16 *
2684 EFIAPI
2685 EfiShellGetEnv(
2686 IN CONST CHAR16 *Name
2687 )
2688 {
2689 return (EfiShellGetEnvEx(Name, NULL));
2690 }
2691
2692 /**
2693 Internal variable setting function. Allows for setting of the read only variables.
2694
2695 @param Name Points to the NULL-terminated environment variable name.
2696 @param Value Points to the NULL-terminated environment variable value. If the value is an
2697 empty string then the environment variable is deleted.
2698 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
2699
2700 @retval EFI_SUCCESS The environment variable was successfully updated.
2701 **/
2702 EFI_STATUS
2703 EFIAPI
2704 InternalEfiShellSetEnv(
2705 IN CONST CHAR16 *Name,
2706 IN CONST CHAR16 *Value,
2707 IN BOOLEAN Volatile
2708 )
2709 {
2710 if (Value == NULL || StrLen(Value) == 0) {
2711 return (SHELL_DELETE_ENVIRONMENT_VARIABLE(Name));
2712 } else {
2713 SHELL_DELETE_ENVIRONMENT_VARIABLE(Name);
2714 if (Volatile) {
2715 return (SHELL_SET_ENVIRONMENT_VARIABLE_V(Name, StrSize(Value), Value));
2716 } else {
2717 return (SHELL_SET_ENVIRONMENT_VARIABLE_NV(Name, StrSize(Value), Value));
2718 }
2719 }
2720 }
2721
2722 /**
2723 Sets the environment variable.
2724
2725 This function changes the current value of the specified environment variable. If the
2726 environment variable exists and the Value is an empty string, then the environment
2727 variable is deleted. If the environment variable exists and the Value is not an empty
2728 string, then the value of the environment variable is changed. If the environment
2729 variable does not exist and the Value is an empty string, there is no action. If the
2730 environment variable does not exist and the Value is a non-empty string, then the
2731 environment variable is created and assigned the specified value.
2732
2733 For a description of volatile and non-volatile environment variables, see UEFI Shell
2734 2.0 specification section 3.6.1.
2735
2736 @param Name Points to the NULL-terminated environment variable name.
2737 @param Value Points to the NULL-terminated environment variable value. If the value is an
2738 empty string then the environment variable is deleted.
2739 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
2740
2741 @retval EFI_SUCCESS The environment variable was successfully updated.
2742 **/
2743 EFI_STATUS
2744 EFIAPI
2745 EfiShellSetEnv(
2746 IN CONST CHAR16 *Name,
2747 IN CONST CHAR16 *Value,
2748 IN BOOLEAN Volatile
2749 )
2750 {
2751 if (Name == NULL || *Name == CHAR_NULL) {
2752 return (EFI_INVALID_PARAMETER);
2753 }
2754 //
2755 // Make sure we dont 'set' a predefined read only variable
2756 //
2757 if (gUnicodeCollation->StriColl(
2758 gUnicodeCollation,
2759 (CHAR16*)Name,
2760 L"cwd") == 0
2761 ||gUnicodeCollation->StriColl(
2762 gUnicodeCollation,
2763 (CHAR16*)Name,
2764 L"Lasterror") == 0
2765 ||gUnicodeCollation->StriColl(
2766 gUnicodeCollation,
2767 (CHAR16*)Name,
2768 L"profiles") == 0
2769 ||gUnicodeCollation->StriColl(
2770 gUnicodeCollation,
2771 (CHAR16*)Name,
2772 L"uefishellsupport") == 0
2773 ||gUnicodeCollation->StriColl(
2774 gUnicodeCollation,
2775 (CHAR16*)Name,
2776 L"uefishellversion") == 0
2777 ||gUnicodeCollation->StriColl(
2778 gUnicodeCollation,
2779 (CHAR16*)Name,
2780 L"uefiversion") == 0
2781 ){
2782 return (EFI_INVALID_PARAMETER);
2783 }
2784 return (InternalEfiShellSetEnv(Name, Value, Volatile));
2785 }
2786
2787 /**
2788 Returns the current directory on the specified device.
2789
2790 If FileSystemMapping is NULL, it returns the current working directory. If the
2791 FileSystemMapping is not NULL, it returns the current directory associated with the
2792 FileSystemMapping. In both cases, the returned name includes the file system
2793 mapping (i.e. fs0:\current-dir).
2794
2795 @param FileSystemMapping A pointer to the file system mapping. If NULL,
2796 then the current working directory is returned.
2797
2798 @retval !=NULL The current directory.
2799 @retval NULL Current directory does not exist.
2800 **/
2801 CONST CHAR16 *
2802 EFIAPI
2803 EfiShellGetCurDir(
2804 IN CONST CHAR16 *FileSystemMapping OPTIONAL
2805 )
2806 {
2807 CHAR16 *PathToReturn;
2808 UINTN Size;
2809 SHELL_MAP_LIST *MapListItem;
2810 if (!IsListEmpty(&gShellMapList.Link)) {
2811 //
2812 // if parameter is NULL, use current
2813 //
2814 if (FileSystemMapping == NULL) {
2815 return (EfiShellGetEnv(L"cwd"));
2816 } else {
2817 Size = 0;
2818 PathToReturn = NULL;
2819 MapListItem = ShellCommandFindMapItem(FileSystemMapping);
2820 if (MapListItem != NULL) {
2821 ASSERT((PathToReturn == NULL && Size == 0) || (PathToReturn != NULL));
2822 PathToReturn = StrnCatGrow(&PathToReturn, &Size, MapListItem->MapName, 0);
2823 PathToReturn = StrnCatGrow(&PathToReturn, &Size, MapListItem->CurrentDirectoryPath, 0);
2824 }
2825 }
2826 return (AddBufferToFreeList(PathToReturn));
2827 } else {
2828 return (NULL);
2829 }
2830 }
2831
2832 /**
2833 Changes the current directory on the specified device.
2834
2835 If the FileSystem is NULL, and the directory Dir does not contain a file system's
2836 mapped name, this function changes the current working directory.
2837
2838 If the FileSystem is NULL and the directory Dir contains a mapped name, then the
2839 current file system and the current directory on that file system are changed.
2840
2841 If FileSystem is NULL, and Dir is not NULL, then this changes the current working file
2842 system.
2843
2844 If FileSystem is not NULL and Dir is not NULL, then this function changes the current
2845 directory on the specified file system.
2846
2847 If the current working directory or the current working file system is changed then the
2848 %cwd% environment variable will be updated
2849
2850 @param FileSystem A pointer to the file system's mapped name. If NULL, then the current working
2851 directory is changed.
2852 @param Dir Points to the NULL-terminated directory on the device specified by FileSystem.
2853
2854 @retval EFI_SUCCESS The operation was sucessful
2855 @retval EFI_NOT_FOUND The file system could not be found
2856 **/
2857 EFI_STATUS
2858 EFIAPI
2859 EfiShellSetCurDir(
2860 IN CONST CHAR16 *FileSystem OPTIONAL,
2861 IN CONST CHAR16 *Dir
2862 )
2863 {
2864 CHAR16 *MapName;
2865 SHELL_MAP_LIST *MapListItem;
2866 UINTN Size;
2867 EFI_STATUS Status;
2868 CHAR16 *TempString;
2869 CHAR16 *DirectoryName;
2870 UINTN TempLen;
2871
2872 Size = 0;
2873 MapName = NULL;
2874 MapListItem = NULL;
2875 TempString = NULL;
2876 DirectoryName = NULL;
2877
2878 if ((FileSystem == NULL && Dir == NULL) || Dir == NULL) {
2879 return (EFI_INVALID_PARAMETER);
2880 }
2881
2882 if (IsListEmpty(&gShellMapList.Link)){
2883 return (EFI_NOT_FOUND);
2884 }
2885
2886 DirectoryName = StrnCatGrow(&DirectoryName, NULL, Dir, 0);
2887 ASSERT(DirectoryName != NULL);
2888
2889 PathCleanUpDirectories(DirectoryName);
2890
2891 if (FileSystem == NULL) {
2892 //
2893 // determine the file system mapping to use
2894 //
2895 if (StrStr(DirectoryName, L":") != NULL) {
2896 ASSERT(MapName == NULL);
2897 MapName = StrnCatGrow(&MapName, NULL, DirectoryName, (StrStr(DirectoryName, L":")-DirectoryName+1));
2898 }
2899 //
2900 // find the file system mapping's entry in the list
2901 // or use current
2902 //
2903 if (MapName != NULL) {
2904 MapListItem = ShellCommandFindMapItem(MapName);
2905
2906 //
2907 // make that the current file system mapping
2908 //
2909 if (MapListItem != NULL) {
2910 gShellCurDir = MapListItem;
2911 }
2912 } else {
2913 MapListItem = gShellCurDir;
2914 }
2915
2916 if (MapListItem == NULL) {
2917 return (EFI_NOT_FOUND);
2918 }
2919
2920 //
2921 // now update the MapListItem's current directory
2922 //
2923 if (MapListItem->CurrentDirectoryPath != NULL && DirectoryName[StrLen(DirectoryName) - 1] != L':') {
2924 FreePool(MapListItem->CurrentDirectoryPath);
2925 MapListItem->CurrentDirectoryPath = NULL;
2926 }
2927 if (MapName != NULL) {
2928 TempLen = StrLen(MapName);
2929 if (TempLen != StrLen(DirectoryName)) {
2930 ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));
2931 MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, DirectoryName+StrLen(MapName), 0);
2932 }
2933 } else {
2934 ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));
2935 MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, DirectoryName, 0);
2936 }
2937 if ((MapListItem->CurrentDirectoryPath != NULL && MapListItem->CurrentDirectoryPath[StrLen(MapListItem->CurrentDirectoryPath)-1] != L'\\') || (MapListItem->CurrentDirectoryPath == NULL)) {
2938 ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));
2939 MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, L"\\", 0);
2940 }
2941 } else {
2942 //
2943 // cant have a mapping in the directory...
2944 //
2945 if (StrStr(DirectoryName, L":") != NULL) {
2946 return (EFI_INVALID_PARAMETER);
2947 }
2948 //
2949 // FileSystem != NULL
2950 //
2951 MapListItem = ShellCommandFindMapItem(FileSystem);
2952 if (MapListItem == NULL) {
2953 return (EFI_INVALID_PARAMETER);
2954 }
2955 // gShellCurDir = MapListItem;
2956 if (DirectoryName != NULL) {
2957 //
2958 // change current dir on that file system
2959 //
2960
2961 if (MapListItem->CurrentDirectoryPath != NULL) {
2962 FreePool(MapListItem->CurrentDirectoryPath);
2963 DEBUG_CODE(MapListItem->CurrentDirectoryPath = NULL;);
2964 }
2965 // ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));
2966 // MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, FileSystem, 0);
2967 ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));
2968 MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, L"\\", 0);
2969 ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));
2970 MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, DirectoryName, 0);
2971 if (MapListItem->CurrentDirectoryPath != NULL && MapListItem->CurrentDirectoryPath[StrLen(MapListItem->CurrentDirectoryPath)-1] != L'\\') {
2972 ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));
2973 MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, L"\\", 0);
2974 }
2975 }
2976 }
2977 //
2978 // if updated the current directory then update the environment variable
2979 //
2980 if (MapListItem == gShellCurDir) {
2981 Size = 0;
2982 ASSERT((TempString == NULL && Size == 0) || (TempString != NULL));
2983 StrnCatGrow(&TempString, &Size, MapListItem->MapName, 0);
2984 ASSERT((TempString == NULL && Size == 0) || (TempString != NULL));
2985 StrnCatGrow(&TempString, &Size, MapListItem->CurrentDirectoryPath, 0);
2986 Status = InternalEfiShellSetEnv(L"cwd", TempString, TRUE);
2987 FreePool(TempString);
2988 return (Status);
2989 }
2990 return(EFI_SUCCESS);
2991 }
2992
2993 /**
2994 Return help information about a specific command.
2995
2996 This function returns the help information for the specified command. The help text
2997 can be internal to the shell or can be from a UEFI Shell manual page.
2998
2999 If Sections is specified, then each section name listed will be compared in a casesensitive
3000 manner, to the section names described in Appendix B. If the section exists,
3001 it will be appended to the returned help text. If the section does not exist, no
3002 information will be returned. If Sections is NULL, then all help text information
3003 available will be returned.
3004
3005 @param Command Points to the NULL-terminated UEFI Shell command name.
3006 @param Sections Points to the NULL-terminated comma-delimited
3007 section names to return. If NULL, then all
3008 sections will be returned.
3009 @param HelpText On return, points to a callee-allocated buffer
3010 containing all specified help text.
3011
3012 @retval EFI_SUCCESS The help text was returned.
3013 @retval EFI_OUT_OF_RESOURCES The necessary buffer could not be allocated to hold the
3014 returned help text.
3015 @retval EFI_INVALID_PARAMETER HelpText is NULL
3016 @retval EFI_NOT_FOUND There is no help text available for Command.
3017 **/
3018 EFI_STATUS
3019 EFIAPI
3020 EfiShellGetHelpText(
3021 IN CONST CHAR16 *Command,
3022 IN CONST CHAR16 *Sections OPTIONAL,
3023 OUT CHAR16 **HelpText
3024 )
3025 {
3026 CONST CHAR16 *ManFileName;
3027 CHAR16 *FixCommand;
3028 EFI_STATUS Status;
3029
3030 ASSERT(HelpText != NULL);
3031 FixCommand = NULL;
3032
3033 ManFileName = ShellCommandGetManFileNameHandler(Command);
3034
3035 if (ManFileName != NULL) {
3036 return (ProcessManFile(ManFileName, Command, Sections, NULL, HelpText));
3037 } else {
3038 if ((StrLen(Command)> 4)
3039 && (Command[StrLen(Command)-1] == L'i' || Command[StrLen(Command)-1] == L'I')
3040 && (Command[StrLen(Command)-2] == L'f' || Command[StrLen(Command)-2] == L'F')
3041 && (Command[StrLen(Command)-3] == L'e' || Command[StrLen(Command)-3] == L'E')
3042 && (Command[StrLen(Command)-4] == L'.')
3043 ) {
3044 FixCommand = AllocateZeroPool(StrSize(Command) - 4 * sizeof (CHAR16));
3045 ASSERT(FixCommand != NULL);
3046
3047 StrnCpy(FixCommand, Command, StrLen(Command)-4);
3048 Status = ProcessManFile(FixCommand, FixCommand, Sections, NULL, HelpText);
3049 FreePool(FixCommand);
3050 return Status;
3051 } else {
3052 return (ProcessManFile(Command, Command, Sections, NULL, HelpText));
3053 }
3054 }
3055 }
3056
3057 /**
3058 Gets the enable status of the page break output mode.
3059
3060 User can use this function to determine current page break mode.
3061
3062 @retval TRUE The page break output mode is enabled.
3063 @retval FALSE The page break output mode is disabled.
3064 **/
3065 BOOLEAN
3066 EFIAPI
3067 EfiShellGetPageBreak(
3068 VOID
3069 )
3070 {
3071 return(ShellInfoObject.PageBreakEnabled);
3072 }
3073
3074 /**
3075 Judges whether the active shell is the root shell.
3076
3077 This function makes the user to know that whether the active Shell is the root shell.
3078
3079 @retval TRUE The active Shell is the root Shell.
3080 @retval FALSE The active Shell is NOT the root Shell.
3081 **/
3082 BOOLEAN
3083 EFIAPI
3084 EfiShellIsRootShell(
3085 VOID
3086 )
3087 {
3088 return(ShellInfoObject.RootShellInstance);
3089 }
3090
3091 /**
3092 function to return a semi-colon delimeted list of all alias' in the current shell
3093
3094 up to caller to free the memory.
3095
3096 @retval NULL No alias' were found
3097 @retval NULL An error ocurred getting alias'
3098 @return !NULL a list of all alias'
3099 **/
3100 CHAR16 *
3101 EFIAPI
3102 InternalEfiShellGetListAlias(
3103 )
3104 {
3105 UINT64 MaxStorSize;
3106 UINT64 RemStorSize;
3107 UINT64 MaxVarSize;
3108 EFI_STATUS Status;
3109 EFI_GUID Guid;
3110 CHAR16 *VariableName;
3111 UINTN NameSize;
3112 CHAR16 *RetVal;
3113 UINTN RetSize;
3114
3115 Status = gRT->QueryVariableInfo(EFI_VARIABLE_NON_VOLATILE|EFI_VARIABLE_BOOTSERVICE_ACCESS, &MaxStorSize, &RemStorSize, &MaxVarSize);
3116 ASSERT_EFI_ERROR(Status);
3117
3118 VariableName = AllocateZeroPool((UINTN)MaxVarSize);
3119 RetSize = 0;
3120 RetVal = NULL;
3121
3122 if (VariableName == NULL) {
3123 return (NULL);
3124 }
3125
3126 VariableName[0] = CHAR_NULL;
3127
3128 while (TRUE) {
3129 NameSize = (UINTN)MaxVarSize;
3130 Status = gRT->GetNextVariableName(&NameSize, VariableName, &Guid);
3131 if (Status == EFI_NOT_FOUND){
3132 break;
3133 }
3134 ASSERT_EFI_ERROR(Status);
3135 if (EFI_ERROR(Status)) {
3136 break;
3137 }
3138 if (CompareGuid(&Guid, &gShellAliasGuid)){
3139 ASSERT((RetVal == NULL && RetSize == 0) || (RetVal != NULL));
3140 RetVal = StrnCatGrow(&RetVal, &RetSize, VariableName, 0);
3141 RetVal = StrnCatGrow(&RetVal, &RetSize, L";", 0);
3142 } // compare guid
3143 } // while
3144 FreePool(VariableName);
3145
3146 return (RetVal);
3147 }
3148
3149 /**
3150 Convert a null-terminated unicode string, in-place, to all lowercase.
3151 Then return it.
3152
3153 @param Str The null-terminated string to be converted to all lowercase.
3154
3155 @return The null-terminated string converted into all lowercase.
3156 **/
3157 CHAR16 *
3158 ToLower (
3159 CHAR16 *Str
3160 )
3161 {
3162 UINTN Index;
3163
3164 for (Index = 0; Str[Index] != L'\0'; Index++) {
3165 if (Str[Index] >= L'A' && Str[Index] <= L'Z') {
3166 Str[Index] -= (CHAR16)(L'A' - L'a');
3167 }
3168 }
3169 return Str;
3170 }
3171
3172 /**
3173 This function returns the command associated with a alias or a list of all
3174 alias'.
3175
3176 @param[in] Alias Points to the NULL-terminated shell alias.
3177 If this parameter is NULL, then all
3178 aliases will be returned in ReturnedData.
3179 @param[out] Volatile upon return of a single command if TRUE indicates
3180 this is stored in a volatile fashion. FALSE otherwise.
3181
3182 @return If Alias is not NULL, it will return a pointer to
3183 the NULL-terminated command for that alias.
3184 If Alias is NULL, ReturnedData points to a ';'
3185 delimited list of alias (e.g.
3186 ReturnedData = "dir;del;copy;mfp") that is NULL-terminated.
3187 @retval NULL an error ocurred
3188 @retval NULL Alias was not a valid Alias
3189 **/
3190 CONST CHAR16 *
3191 EFIAPI
3192 EfiShellGetAlias(
3193 IN CONST CHAR16 *Alias,
3194 OUT BOOLEAN *Volatile OPTIONAL
3195 )
3196 {
3197 CHAR16 *RetVal;
3198 UINTN RetSize;
3199 UINT32 Attribs;
3200 EFI_STATUS Status;
3201 CHAR16 *AliasLower;
3202
3203 // Convert to lowercase to make aliases case-insensitive
3204 if (Alias != NULL) {
3205 AliasLower = AllocateCopyPool (StrSize (Alias), Alias);
3206 ASSERT (AliasLower != NULL);
3207 ToLower (AliasLower);
3208