ShellPkg: Fix the support for command line comments.
[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 @param[out] ExitDataSize ExitDataSize as returned from gBS->StartImage
1405 @param[out] ExitData ExitData as returned from gBS->StartImage
1406
1407 @retval EFI_SUCCESS The command executed successfully. The status code
1408 returned by the command is pointed to by StatusCode.
1409 @retval EFI_INVALID_PARAMETER The parameters are invalid.
1410 @retval EFI_OUT_OF_RESOURCES Out of resources.
1411 @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.
1412 **/
1413 EFI_STATUS
1414 EFIAPI
1415 InternalShellExecuteDevicePath(
1416 IN CONST EFI_HANDLE *ParentImageHandle,
1417 IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath,
1418 IN CONST CHAR16 *CommandLine OPTIONAL,
1419 IN CONST CHAR16 **Environment OPTIONAL,
1420 OUT EFI_STATUS *StartImageStatus OPTIONAL,
1421 OUT UINTN *ExitDataSize OPTIONAL,
1422 OUT CHAR16 **ExitData OPTIONAL
1423 )
1424 {
1425 EFI_STATUS Status;
1426 EFI_STATUS StartStatus;
1427 EFI_STATUS CleanupStatus;
1428 EFI_HANDLE NewHandle;
1429 EFI_LOADED_IMAGE_PROTOCOL *LoadedImage;
1430 LIST_ENTRY OrigEnvs;
1431 EFI_SHELL_PARAMETERS_PROTOCOL ShellParamsProtocol;
1432 UINTN InternalExitDataSize;
1433 UINTN *ExitDataSizePtr;
1434 CHAR16 *ImagePath;
1435 UINTN Index;
1436 CHAR16 *Walker;
1437 CHAR16 *NewCmdLine;
1438
1439 // ExitDataSize is not OPTIONAL for gBS->BootServices, provide somewhere for
1440 // it to be dumped if the caller doesn't want it.
1441 if (ExitData == NULL) {
1442 ExitDataSizePtr = &InternalExitDataSize;
1443 } else {
1444 ExitDataSizePtr = ExitDataSize;
1445 }
1446
1447 if (ParentImageHandle == NULL) {
1448 return (EFI_INVALID_PARAMETER);
1449 }
1450
1451 InitializeListHead(&OrigEnvs);
1452
1453 NewHandle = NULL;
1454
1455 NewCmdLine = AllocateCopyPool (StrSize (CommandLine), CommandLine);
1456 if (NewCmdLine == NULL) {
1457 return EFI_OUT_OF_RESOURCES;
1458 }
1459
1460 for (Walker = NewCmdLine; Walker != NULL && *Walker != CHAR_NULL ; Walker++) {
1461 if (*Walker == L'^' && *(Walker+1) == L'#') {
1462 CopyMem(Walker, Walker+1, StrSize(Walker) - sizeof(Walker[0]));
1463 }
1464 }
1465
1466 //
1467 // Load the image with:
1468 // FALSE - not from boot manager and NULL, 0 being not already in memory
1469 //
1470 Status = gBS->LoadImage(
1471 FALSE,
1472 *ParentImageHandle,
1473 (EFI_DEVICE_PATH_PROTOCOL*)DevicePath,
1474 NULL,
1475 0,
1476 &NewHandle);
1477
1478 if (EFI_ERROR(Status)) {
1479 if (NewHandle != NULL) {
1480 gBS->UnloadImage(NewHandle);
1481 }
1482 return (Status);
1483 }
1484 Status = gBS->OpenProtocol(
1485 NewHandle,
1486 &gEfiLoadedImageProtocolGuid,
1487 (VOID**)&LoadedImage,
1488 gImageHandle,
1489 NULL,
1490 EFI_OPEN_PROTOCOL_GET_PROTOCOL);
1491
1492 if (!EFI_ERROR(Status)) {
1493 ASSERT(LoadedImage->LoadOptionsSize == 0);
1494 if (NewCmdLine != NULL) {
1495 LoadedImage->LoadOptionsSize = (UINT32)StrSize(NewCmdLine);
1496 LoadedImage->LoadOptions = (VOID*)NewCmdLine;
1497 }
1498
1499 //
1500 // Save our current environment settings for later restoration if necessary
1501 //
1502 if (Environment != NULL) {
1503 Status = GetEnvironmentVariableList(&OrigEnvs);
1504 if (!EFI_ERROR(Status)) {
1505 Status = SetEnvironmentVariables(Environment);
1506 }
1507 }
1508
1509 //
1510 // Initialize and install a shell parameters protocol on the image.
1511 //
1512 ShellParamsProtocol.StdIn = ShellInfoObject.NewShellParametersProtocol->StdIn;
1513 ShellParamsProtocol.StdOut = ShellInfoObject.NewShellParametersProtocol->StdOut;
1514 ShellParamsProtocol.StdErr = ShellInfoObject.NewShellParametersProtocol->StdErr;
1515 Status = UpdateArgcArgv(&ShellParamsProtocol, NewCmdLine, NULL, NULL);
1516 ASSERT_EFI_ERROR(Status);
1517 //
1518 // Replace Argv[0] with the full path of the binary we're executing:
1519 // If the command line was "foo", the binary might be called "foo.efi".
1520 // "The first entry in [Argv] is always the full file path of the
1521 // executable" - UEFI Shell Spec section 2.3
1522 //
1523 ImagePath = EfiShellGetFilePathFromDevicePath (DevicePath);
1524 // The image we're executing isn't necessarily in a filesystem - it might
1525 // be memory mapped. In this case EfiShellGetFilePathFromDevicePath will
1526 // return NULL, and we'll leave Argv[0] as UpdateArgcArgv set it.
1527 if (ImagePath != NULL) {
1528 if (ShellParamsProtocol.Argv == NULL) {
1529 // Command line was empty or null.
1530 // (UpdateArgcArgv sets Argv to NULL when CommandLine is "" or NULL)
1531 ShellParamsProtocol.Argv = AllocatePool (sizeof (CHAR16 *));
1532 if (ShellParamsProtocol.Argv == NULL) {
1533 Status = EFI_OUT_OF_RESOURCES;
1534 goto UnloadImage;
1535 }
1536 ShellParamsProtocol.Argc = 1;
1537 } else {
1538 // Free the string UpdateArgcArgv put in Argv[0];
1539 FreePool (ShellParamsProtocol.Argv[0]);
1540 }
1541 ShellParamsProtocol.Argv[0] = ImagePath;
1542 }
1543
1544 Status = gBS->InstallProtocolInterface(&NewHandle, &gEfiShellParametersProtocolGuid, EFI_NATIVE_INTERFACE, &ShellParamsProtocol);
1545 ASSERT_EFI_ERROR(Status);
1546
1547 ///@todo initialize and install ShellInterface protocol on the new image for compatibility if - PcdGetBool(PcdShellSupportOldProtocols)
1548
1549 //
1550 // now start the image, passing up exit data if the caller requested it
1551 //
1552 if (!EFI_ERROR(Status)) {
1553 StartStatus = gBS->StartImage(
1554 NewHandle,
1555 ExitDataSizePtr,
1556 ExitData
1557 );
1558 if (StartImageStatus != NULL) {
1559 *StartImageStatus = StartStatus;
1560 }
1561
1562 CleanupStatus = gBS->UninstallProtocolInterface(
1563 NewHandle,
1564 &gEfiShellParametersProtocolGuid,
1565 &ShellParamsProtocol
1566 );
1567 ASSERT_EFI_ERROR(CleanupStatus);
1568
1569 goto FreeAlloc;
1570 }
1571
1572 UnloadImage:
1573 // Unload image - We should only get here if we didn't call StartImage
1574 gBS->UnloadImage (NewHandle);
1575
1576 FreeAlloc:
1577 // Free Argv (Allocated in UpdateArgcArgv)
1578 if (ShellParamsProtocol.Argv != NULL) {
1579 for (Index = 0; Index < ShellParamsProtocol.Argc; Index++) {
1580 if (ShellParamsProtocol.Argv[Index] != NULL) {
1581 FreePool (ShellParamsProtocol.Argv[Index]);
1582 }
1583 }
1584 FreePool (ShellParamsProtocol.Argv);
1585 }
1586 }
1587
1588 // Restore environment variables
1589 if (!IsListEmpty(&OrigEnvs)) {
1590 CleanupStatus = SetEnvironmentVariableList(&OrigEnvs);
1591 ASSERT_EFI_ERROR (CleanupStatus);
1592 }
1593
1594 FreePool (NewCmdLine);
1595
1596 return(Status);
1597 }
1598 /**
1599 Execute the command line.
1600
1601 This function creates a nested instance of the shell and executes the specified
1602 command (CommandLine) with the specified environment (Environment). Upon return,
1603 the status code returned by the specified command is placed in StatusCode.
1604
1605 If Environment is NULL, then the current environment is used and all changes made
1606 by the commands executed will be reflected in the current environment. If the
1607 Environment is non-NULL, then the changes made will be discarded.
1608
1609 The CommandLine is executed from the current working directory on the current
1610 device.
1611
1612 @param ParentImageHandle A handle of the image that is executing the specified
1613 command line.
1614 @param CommandLine Points to the NULL-terminated UCS-2 encoded string
1615 containing the command line. If NULL then the command-
1616 line will be empty.
1617 @param Environment Points to a NULL-terminated array of environment
1618 variables with the format 'x=y', where x is the
1619 environment variable name and y is the value. If this
1620 is NULL, then the current shell environment is used.
1621 @param StatusCode Points to the status code returned by the command.
1622
1623 @retval EFI_SUCCESS The command executed successfully. The status code
1624 returned by the command is pointed to by StatusCode.
1625 @retval EFI_INVALID_PARAMETER The parameters are invalid.
1626 @retval EFI_OUT_OF_RESOURCES Out of resources.
1627 @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.
1628 @retval EFI_UNSUPPORTED The support level required for this function is not present.
1629
1630 @sa InternalShellExecuteDevicePath
1631 **/
1632 EFI_STATUS
1633 EFIAPI
1634 EfiShellExecute(
1635 IN EFI_HANDLE *ParentImageHandle,
1636 IN CHAR16 *CommandLine OPTIONAL,
1637 IN CHAR16 **Environment OPTIONAL,
1638 OUT EFI_STATUS *StatusCode OPTIONAL
1639 )
1640 {
1641 EFI_STATUS Status;
1642 CHAR16 *Temp;
1643 EFI_DEVICE_PATH_PROTOCOL *DevPath;
1644 UINTN Size;
1645 UINTN ExitDataSize;
1646 CHAR16 *ExitData;
1647
1648 if ((PcdGet8(PcdShellSupportLevel) < 1)) {
1649 return (EFI_UNSUPPORTED);
1650 }
1651
1652 DevPath = AppendDevicePath (ShellInfoObject.ImageDevPath, ShellInfoObject.FileDevPath);
1653
1654 DEBUG_CODE_BEGIN();
1655 Temp = ConvertDevicePathToText(ShellInfoObject.FileDevPath, TRUE, TRUE);
1656 FreePool(Temp);
1657 Temp = ConvertDevicePathToText(ShellInfoObject.ImageDevPath, TRUE, TRUE);
1658 FreePool(Temp);
1659 Temp = ConvertDevicePathToText(DevPath, TRUE, TRUE);
1660 FreePool(Temp);
1661 DEBUG_CODE_END();
1662
1663 Temp = NULL;
1664 Size = 0;
1665 ASSERT((Temp == NULL && Size == 0) || (Temp != NULL));
1666 StrnCatGrow(&Temp, &Size, L"Shell.efi -_exit ", 0);
1667 StrnCatGrow(&Temp, &Size, CommandLine, 0);
1668
1669 Status = InternalShellExecuteDevicePath(
1670 ParentImageHandle,
1671 DevPath,
1672 Temp,
1673 (CONST CHAR16**)Environment,
1674 StatusCode,
1675 &ExitDataSize,
1676 &ExitData);
1677
1678 if (Status == EFI_ABORTED) {
1679 // If the command exited with an error, the shell should put the exit
1680 // status in ExitData, preceded by a null-terminated string.
1681 ASSERT (ExitDataSize == StrSize (ExitData) + sizeof (SHELL_STATUS));
1682
1683 if (StatusCode != NULL) {
1684 // Skip the null-terminated string
1685 ExitData += StrLen (ExitData) + 1;
1686
1687 // Use CopyMem to avoid alignment faults
1688 CopyMem (StatusCode, ExitData, sizeof (SHELL_STATUS));
1689
1690 // Convert from SHELL_STATUS to EFI_STATUS
1691 // EFI_STATUSes have top bit set when they are errors.
1692 // (See UEFI Spec Appendix D)
1693 if (*StatusCode != SHELL_SUCCESS) {
1694 *StatusCode = (EFI_STATUS) *StatusCode | MAX_BIT;
1695 }
1696 }
1697 FreePool (ExitData);
1698 Status = EFI_SUCCESS;
1699 }
1700
1701 //
1702 // de-allocate and return
1703 //
1704 FreePool(DevPath);
1705 FreePool(Temp);
1706 return(Status);
1707 }
1708
1709 /**
1710 Utility cleanup function for EFI_SHELL_FILE_INFO objects.
1711
1712 1) frees all pointers (non-NULL)
1713 2) Closes the SHELL_FILE_HANDLE
1714
1715 @param FileListNode pointer to the list node to free
1716 **/
1717 VOID
1718 EFIAPI
1719 InternalFreeShellFileInfoNode(
1720 IN EFI_SHELL_FILE_INFO *FileListNode
1721 )
1722 {
1723 if (FileListNode->Info != NULL) {
1724 FreePool((VOID*)FileListNode->Info);
1725 }
1726 if (FileListNode->FileName != NULL) {
1727 FreePool((VOID*)FileListNode->FileName);
1728 }
1729 if (FileListNode->FullName != NULL) {
1730 FreePool((VOID*)FileListNode->FullName);
1731 }
1732 if (FileListNode->Handle != NULL) {
1733 ShellInfoObject.NewEfiShellProtocol->CloseFile(FileListNode->Handle);
1734 }
1735 FreePool(FileListNode);
1736 }
1737 /**
1738 Frees the file list.
1739
1740 This function cleans up the file list and any related data structures. It has no
1741 impact on the files themselves.
1742
1743 @param FileList The file list to free. Type EFI_SHELL_FILE_INFO is
1744 defined in OpenFileList()
1745
1746 @retval EFI_SUCCESS Free the file list successfully.
1747 @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;
1748 **/
1749 EFI_STATUS
1750 EFIAPI
1751 EfiShellFreeFileList(
1752 IN EFI_SHELL_FILE_INFO **FileList
1753 )
1754 {
1755 EFI_SHELL_FILE_INFO *ShellFileListItem;
1756
1757 if (FileList == NULL || *FileList == NULL) {
1758 return (EFI_INVALID_PARAMETER);
1759 }
1760
1761 for ( ShellFileListItem = (EFI_SHELL_FILE_INFO*)GetFirstNode(&(*FileList)->Link)
1762 ; !IsListEmpty(&(*FileList)->Link)
1763 ; ShellFileListItem = (EFI_SHELL_FILE_INFO*)GetFirstNode(&(*FileList)->Link)
1764 ){
1765 RemoveEntryList(&ShellFileListItem->Link);
1766 InternalFreeShellFileInfoNode(ShellFileListItem);
1767 }
1768 InternalFreeShellFileInfoNode(*FileList);
1769 *FileList = NULL;
1770 return(EFI_SUCCESS);
1771 }
1772
1773 /**
1774 Deletes the duplicate file names files in the given file list.
1775
1776 This function deletes the reduplicate files in the given file list.
1777
1778 @param FileList A pointer to the first entry in the file list.
1779
1780 @retval EFI_SUCCESS Always success.
1781 @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;
1782 **/
1783 EFI_STATUS
1784 EFIAPI
1785 EfiShellRemoveDupInFileList(
1786 IN EFI_SHELL_FILE_INFO **FileList
1787 )
1788 {
1789 EFI_SHELL_FILE_INFO *ShellFileListItem;
1790 EFI_SHELL_FILE_INFO *ShellFileListItem2;
1791 EFI_SHELL_FILE_INFO *TempNode;
1792
1793 if (FileList == NULL || *FileList == NULL) {
1794 return (EFI_INVALID_PARAMETER);
1795 }
1796 for ( ShellFileListItem = (EFI_SHELL_FILE_INFO*)GetFirstNode(&(*FileList)->Link)
1797 ; !IsNull(&(*FileList)->Link, &ShellFileListItem->Link)
1798 ; ShellFileListItem = (EFI_SHELL_FILE_INFO*)GetNextNode(&(*FileList)->Link, &ShellFileListItem->Link)
1799 ){
1800 for ( ShellFileListItem2 = (EFI_SHELL_FILE_INFO*)GetNextNode(&(*FileList)->Link, &ShellFileListItem->Link)
1801 ; !IsNull(&(*FileList)->Link, &ShellFileListItem2->Link)
1802 ; ShellFileListItem2 = (EFI_SHELL_FILE_INFO*)GetNextNode(&(*FileList)->Link, &ShellFileListItem2->Link)
1803 ){
1804 if (gUnicodeCollation->StriColl(
1805 gUnicodeCollation,
1806 (CHAR16*)ShellFileListItem->FullName,
1807 (CHAR16*)ShellFileListItem2->FullName) == 0
1808 ){
1809 TempNode = (EFI_SHELL_FILE_INFO *)GetPreviousNode(
1810 &(*FileList)->Link,
1811 &ShellFileListItem2->Link
1812 );
1813 RemoveEntryList(&ShellFileListItem2->Link);
1814 InternalFreeShellFileInfoNode(ShellFileListItem2);
1815 // Set ShellFileListItem2 to PreviousNode so we don't access Freed
1816 // memory in GetNextNode in the loop expression above.
1817 ShellFileListItem2 = TempNode;
1818 }
1819 }
1820 }
1821 return (EFI_SUCCESS);
1822 }
1823
1824 //
1825 // This is the same structure as the external version, but it has no CONST qualifiers.
1826 //
1827 typedef struct {
1828 LIST_ENTRY Link; ///< Linked list members.
1829 EFI_STATUS Status; ///< Status of opening the file. Valid only if Handle != NULL.
1830 CHAR16 *FullName; ///< Fully qualified filename.
1831 CHAR16 *FileName; ///< name of this file.
1832 SHELL_FILE_HANDLE Handle; ///< Handle for interacting with the opened file or NULL if closed.
1833 EFI_FILE_INFO *Info; ///< Pointer to the FileInfo struct for this file or NULL.
1834 } EFI_SHELL_FILE_INFO_NO_CONST;
1835
1836 /**
1837 Allocates and duplicates a EFI_SHELL_FILE_INFO node.
1838
1839 @param[in] Node The node to copy from.
1840 @param[in] Save TRUE to set Node->Handle to NULL, FALSE otherwise.
1841
1842 @retval NULL a memory allocation error ocurred
1843 @return != NULL a pointer to the new node
1844 **/
1845 EFI_SHELL_FILE_INFO*
1846 EFIAPI
1847 InternalDuplicateShellFileInfo(
1848 IN EFI_SHELL_FILE_INFO *Node,
1849 IN BOOLEAN Save
1850 )
1851 {
1852 EFI_SHELL_FILE_INFO_NO_CONST *NewNode;
1853
1854 //
1855 // try to confirm that the objects are in sync
1856 //
1857 ASSERT(sizeof(EFI_SHELL_FILE_INFO_NO_CONST) == sizeof(EFI_SHELL_FILE_INFO));
1858
1859 NewNode = AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO));
1860 if (NewNode == NULL) {
1861 return (NULL);
1862 }
1863 NewNode->FullName = AllocateCopyPool(StrSize(Node->FullName), Node->FullName);
1864 NewNode->FileName = AllocateCopyPool(StrSize(Node->FileName), Node->FileName);
1865 NewNode->Info = AllocateCopyPool((UINTN)Node->Info->Size, Node->Info);
1866 if ( NewNode->FullName == NULL
1867 || NewNode->FileName == NULL
1868 || NewNode->Info == NULL
1869 ){
1870 SHELL_FREE_NON_NULL(NewNode->FullName);
1871 SHELL_FREE_NON_NULL(NewNode->FileName);
1872 SHELL_FREE_NON_NULL(NewNode->Info);
1873 SHELL_FREE_NON_NULL(NewNode);
1874 return(NULL);
1875 }
1876 NewNode->Status = Node->Status;
1877 NewNode->Handle = Node->Handle;
1878 if (!Save) {
1879 Node->Handle = NULL;
1880 }
1881
1882 return((EFI_SHELL_FILE_INFO*)NewNode);
1883 }
1884
1885 /**
1886 Allocates and populates a EFI_SHELL_FILE_INFO structure. if any memory operation
1887 failed it will return NULL.
1888
1889 @param[in] BasePath the Path to prepend onto filename for FullPath
1890 @param[in] Status Status member initial value.
1891 @param[in] FileName FileName member initial value.
1892 @param[in] Handle Handle member initial value.
1893 @param[in] Info Info struct to copy.
1894
1895 @retval NULL An error ocurred.
1896 @return a pointer to the newly allocated structure.
1897 **/
1898 EFI_SHELL_FILE_INFO *
1899 EFIAPI
1900 CreateAndPopulateShellFileInfo(
1901 IN CONST CHAR16 *BasePath,
1902 IN CONST EFI_STATUS Status,
1903 IN CONST CHAR16 *FileName,
1904 IN CONST SHELL_FILE_HANDLE Handle,
1905 IN CONST EFI_FILE_INFO *Info
1906 )
1907 {
1908 EFI_SHELL_FILE_INFO *ShellFileListItem;
1909 CHAR16 *TempString;
1910 UINTN Size;
1911
1912 TempString = NULL;
1913 Size = 0;
1914
1915 ShellFileListItem = AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO));
1916 if (ShellFileListItem == NULL) {
1917 return (NULL);
1918 }
1919 if (Info != NULL && Info->Size != 0) {
1920 ShellFileListItem->Info = AllocateZeroPool((UINTN)Info->Size);
1921 if (ShellFileListItem->Info == NULL) {
1922 FreePool(ShellFileListItem);
1923 return (NULL);
1924 }
1925 CopyMem(ShellFileListItem->Info, Info, (UINTN)Info->Size);
1926 } else {
1927 ShellFileListItem->Info = NULL;
1928 }
1929 if (FileName != NULL) {
1930 ASSERT(TempString == NULL);
1931 ShellFileListItem->FileName = StrnCatGrow(&TempString, 0, FileName, 0);
1932 if (ShellFileListItem->FileName == NULL) {
1933 FreePool(ShellFileListItem->Info);
1934 FreePool(ShellFileListItem);
1935 return (NULL);
1936 }
1937 } else {
1938 ShellFileListItem->FileName = NULL;
1939 }
1940 Size = 0;
1941 TempString = NULL;
1942 if (BasePath != NULL) {
1943 ASSERT((TempString == NULL && Size == 0) || (TempString != NULL));
1944 TempString = StrnCatGrow(&TempString, &Size, BasePath, 0);
1945 if (TempString == NULL) {
1946 FreePool((VOID*)ShellFileListItem->FileName);
1947 SHELL_FREE_NON_NULL(ShellFileListItem->Info);
1948 FreePool(ShellFileListItem);
1949 return (NULL);
1950 }
1951 }
1952 if (ShellFileListItem->FileName != NULL) {
1953 ASSERT((TempString == NULL && Size == 0) || (TempString != NULL));
1954 TempString = StrnCatGrow(&TempString, &Size, ShellFileListItem->FileName, 0);
1955 if (TempString == NULL) {
1956 FreePool((VOID*)ShellFileListItem->FileName);
1957 FreePool(ShellFileListItem->Info);
1958 FreePool(ShellFileListItem);
1959 return (NULL);
1960 }
1961 }
1962
1963 TempString = PathCleanUpDirectories(TempString);
1964
1965 ShellFileListItem->FullName = TempString;
1966 ShellFileListItem->Status = Status;
1967 ShellFileListItem->Handle = Handle;
1968
1969 return (ShellFileListItem);
1970 }
1971
1972 /**
1973 Find all files in a specified directory.
1974
1975 @param FileDirHandle Handle of the directory to search.
1976 @param FileList On return, points to the list of files in the directory
1977 or NULL if there are no files in the directory.
1978
1979 @retval EFI_SUCCESS File information was returned successfully.
1980 @retval EFI_VOLUME_CORRUPTED The file system structures have been corrupted.
1981 @retval EFI_DEVICE_ERROR The device reported an error.
1982 @retval EFI_NO_MEDIA The device media is not present.
1983 @retval EFI_INVALID_PARAMETER The FileDirHandle was not a directory.
1984 @return An error from FileHandleGetFileName().
1985 **/
1986 EFI_STATUS
1987 EFIAPI
1988 EfiShellFindFilesInDir(
1989 IN SHELL_FILE_HANDLE FileDirHandle,
1990 OUT EFI_SHELL_FILE_INFO **FileList
1991 )
1992 {
1993 EFI_SHELL_FILE_INFO *ShellFileList;
1994 EFI_SHELL_FILE_INFO *ShellFileListItem;
1995 EFI_FILE_INFO *FileInfo;
1996 EFI_STATUS Status;
1997 BOOLEAN NoFile;
1998 CHAR16 *TempString;
1999 CHAR16 *BasePath;
2000 UINTN Size;
2001 CHAR16 *TempSpot;
2002
2003 BasePath = NULL;
2004 Status = FileHandleGetFileName(FileDirHandle, &BasePath);
2005 if (EFI_ERROR(Status)) {
2006 return (Status);
2007 }
2008
2009 if (ShellFileHandleGetPath(FileDirHandle) != NULL) {
2010 TempString = NULL;
2011 Size = 0;
2012 TempString = StrnCatGrow(&TempString, &Size, ShellFileHandleGetPath(FileDirHandle), 0);
2013 if (TempString == NULL) {
2014 SHELL_FREE_NON_NULL(BasePath);
2015 return (EFI_OUT_OF_RESOURCES);
2016 }
2017 TempSpot = StrStr(TempString, L";");
2018
2019 if (TempSpot != NULL) {
2020 *TempSpot = CHAR_NULL;
2021 }
2022
2023 TempString = StrnCatGrow(&TempString, &Size, BasePath, 0);
2024 if (TempString == NULL) {
2025 SHELL_FREE_NON_NULL(BasePath);
2026 return (EFI_OUT_OF_RESOURCES);
2027 }
2028 SHELL_FREE_NON_NULL(BasePath);
2029 BasePath = TempString;
2030 }
2031
2032 NoFile = FALSE;
2033 ShellFileList = NULL;
2034 ShellFileListItem = NULL;
2035 FileInfo = NULL;
2036 Status = EFI_SUCCESS;
2037
2038
2039 for ( Status = FileHandleFindFirstFile(FileDirHandle, &FileInfo)
2040 ; !EFI_ERROR(Status) && !NoFile
2041 ; Status = FileHandleFindNextFile(FileDirHandle, FileInfo, &NoFile)
2042 ){
2043 //
2044 // allocate a new EFI_SHELL_FILE_INFO and populate it...
2045 //
2046 ShellFileListItem = CreateAndPopulateShellFileInfo(
2047 BasePath,
2048 EFI_SUCCESS, // success since we didnt fail to open it...
2049 FileInfo->FileName,
2050 NULL, // no handle since not open
2051 FileInfo);
2052
2053 if (ShellFileList == NULL) {
2054 ShellFileList = (EFI_SHELL_FILE_INFO*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO));
2055 ASSERT(ShellFileList != NULL);
2056 InitializeListHead(&ShellFileList->Link);
2057 }
2058 InsertTailList(&ShellFileList->Link, &ShellFileListItem->Link);
2059 }
2060 if (EFI_ERROR(Status)) {
2061 EfiShellFreeFileList(&ShellFileList);
2062 *FileList = NULL;
2063 } else {
2064 *FileList = ShellFileList;
2065 }
2066 SHELL_FREE_NON_NULL(BasePath);
2067 return(Status);
2068 }
2069
2070 /**
2071 Get the GUID value from a human readable name.
2072
2073 If GuidName is a known GUID name, then update Guid to have the correct value for
2074 that GUID.
2075
2076 This function is only available when the major and minor versions in the
2077 EfiShellProtocol are greater than or equal to 2 and 1, respectively.
2078
2079 @param[in] GuidName A pointer to the localized name for the GUID being queried.
2080 @param[out] Guid A pointer to the GUID structure to be filled in.
2081
2082 @retval EFI_SUCCESS The operation was successful.
2083 @retval EFI_INVALID_PARAMETER Guid was NULL.
2084 @retval EFI_INVALID_PARAMETER GuidName was NULL.
2085 @retval EFI_NOT_FOUND GuidName is not a known GUID Name.
2086 **/
2087 EFI_STATUS
2088 EFIAPI
2089 EfiShellGetGuidFromName(
2090 IN CONST CHAR16 *GuidName,
2091 OUT EFI_GUID *Guid
2092 )
2093 {
2094 EFI_GUID *NewGuid;
2095 EFI_STATUS Status;
2096
2097 if (Guid == NULL || GuidName == NULL) {
2098 return (EFI_INVALID_PARAMETER);
2099 }
2100
2101 Status = GetGuidFromStringName(GuidName, NULL, &NewGuid);
2102
2103 if (!EFI_ERROR(Status)) {
2104 CopyGuid(NewGuid, Guid);
2105 }
2106
2107 return (Status);
2108 }
2109
2110 /**
2111 Get the human readable name for a GUID from the value.
2112
2113 If Guid is assigned a name, then update *GuidName to point to the name. The callee
2114 should not modify the value.
2115
2116 This function is only available when the major and minor versions in the
2117 EfiShellProtocol are greater than or equal to 2 and 1, respectively.
2118
2119 @param[in] Guid A pointer to the GUID being queried.
2120 @param[out] GuidName A pointer to a pointer the localized to name for the GUID being requested
2121
2122 @retval EFI_SUCCESS The operation was successful.
2123 @retval EFI_INVALID_PARAMETER Guid was NULL.
2124 @retval EFI_INVALID_PARAMETER GuidName was NULL.
2125 @retval EFI_NOT_FOUND Guid is not assigned a name.
2126 **/
2127 EFI_STATUS
2128 EFIAPI
2129 EfiShellGetGuidName(
2130 IN CONST EFI_GUID *Guid,
2131 OUT CONST CHAR16 **GuidName
2132 )
2133 {
2134 CHAR16 *Name;
2135
2136 if (Guid == NULL || GuidName == NULL) {
2137 return (EFI_INVALID_PARAMETER);
2138 }
2139
2140 Name = GetStringNameFromGuid(Guid, NULL);
2141 if (Name == NULL || StrLen(Name) == 0) {
2142 SHELL_FREE_NON_NULL(Name);
2143 return (EFI_NOT_FOUND);
2144 }
2145
2146 *GuidName = AddBufferToFreeList(Name);
2147
2148 return (EFI_SUCCESS);
2149 }
2150
2151 /**
2152 Updates a file name to be preceeded by the mapped drive name
2153
2154 @param[in] BasePath the Mapped drive name to prepend
2155 @param[in, out] Path pointer to pointer to the file name to update.
2156
2157 @retval EFI_SUCCESS
2158 @retval EFI_OUT_OF_RESOURCES
2159 **/
2160 EFI_STATUS
2161 EFIAPI
2162 UpdateFileName(
2163 IN CONST CHAR16 *BasePath,
2164 IN OUT CHAR16 **Path
2165 )
2166 {
2167 CHAR16 *Path2;
2168 UINTN Path2Size;
2169
2170 Path2Size = 0;
2171 Path2 = NULL;
2172
2173 ASSERT(Path != NULL);
2174 ASSERT(*Path != NULL);
2175 ASSERT(BasePath != NULL);
2176
2177 //
2178 // convert a local path to an absolute path
2179 //
2180 if (StrStr(*Path, L":") == NULL) {
2181 ASSERT((Path2 == NULL && Path2Size == 0) || (Path2 != NULL));
2182 StrnCatGrow(&Path2, &Path2Size, BasePath, 0);
2183 if (Path2 == NULL) {
2184 return (EFI_OUT_OF_RESOURCES);
2185 }
2186 ASSERT((Path2 == NULL && Path2Size == 0) || (Path2 != NULL));
2187 StrnCatGrow(&Path2, &Path2Size, (*Path)[0] == L'\\'?(*Path) + 1 :*Path, 0);
2188 if (Path2 == NULL) {
2189 return (EFI_OUT_OF_RESOURCES);
2190 }
2191 }
2192
2193 FreePool(*Path);
2194 (*Path) = Path2;
2195
2196 return (EFI_SUCCESS);
2197 }
2198
2199 /**
2200 If FileHandle is a directory then the function reads from FileHandle and reads in
2201 each of the FileInfo structures. If one of them matches the Pattern's first
2202 "level" then it opens that handle and calls itself on that handle.
2203
2204 If FileHandle is a file and matches all of the remaining Pattern (which would be
2205 on its last node), then add a EFI_SHELL_FILE_INFO object for this file to fileList.
2206
2207 Upon a EFI_SUCCESS return fromt he function any the caller is responsible to call
2208 FreeFileList with FileList.
2209
2210 @param[in] FilePattern The FilePattern to check against.
2211 @param[in] UnicodeCollation The pointer to EFI_UNICODE_COLLATION_PROTOCOL structure
2212 @param[in] FileHandle The FileHandle to start with
2213 @param[in, out] FileList pointer to pointer to list of found files.
2214 @param[in] ParentNode The node for the parent. Same file as identified by HANDLE.
2215 @param[in] MapName The file system name this file is on.
2216
2217 @retval EFI_SUCCESS all files were found and the FileList contains a list.
2218 @retval EFI_NOT_FOUND no files were found
2219 @retval EFI_OUT_OF_RESOURCES a memory allocation failed
2220 **/
2221 EFI_STATUS
2222 EFIAPI
2223 ShellSearchHandle(
2224 IN CONST CHAR16 *FilePattern,
2225 IN EFI_UNICODE_COLLATION_PROTOCOL *UnicodeCollation,
2226 IN SHELL_FILE_HANDLE FileHandle,
2227 IN OUT EFI_SHELL_FILE_INFO **FileList,
2228 IN CONST EFI_SHELL_FILE_INFO *ParentNode OPTIONAL,
2229 IN CONST CHAR16 *MapName
2230 )
2231 {
2232 EFI_STATUS Status;
2233 CONST CHAR16 *NextFilePatternStart;
2234 CHAR16 *CurrentFilePattern;
2235 EFI_SHELL_FILE_INFO *ShellInfo;
2236 EFI_SHELL_FILE_INFO *ShellInfoNode;
2237 EFI_SHELL_FILE_INFO *NewShellNode;
2238 EFI_FILE_INFO *FileInfo;
2239 BOOLEAN Directory;
2240 CHAR16 *NewFullName;
2241 UINTN Size;
2242
2243 if ( FilePattern == NULL
2244 || UnicodeCollation == NULL
2245 || FileList == NULL
2246 ){
2247 return (EFI_INVALID_PARAMETER);
2248 }
2249 ShellInfo = NULL;
2250 CurrentFilePattern = NULL;
2251
2252 if (*FilePattern == L'\\') {
2253 FilePattern++;
2254 }
2255
2256 for( NextFilePatternStart = FilePattern
2257 ; *NextFilePatternStart != CHAR_NULL && *NextFilePatternStart != L'\\'
2258 ; NextFilePatternStart++);
2259
2260 CurrentFilePattern = AllocateZeroPool((NextFilePatternStart-FilePattern+1)*sizeof(CHAR16));
2261 ASSERT(CurrentFilePattern != NULL);
2262 StrnCpy(CurrentFilePattern, FilePattern, NextFilePatternStart-FilePattern);
2263
2264 if (CurrentFilePattern[0] == CHAR_NULL
2265 &&NextFilePatternStart[0] == CHAR_NULL
2266 ){
2267 //
2268 // we want the parent or root node (if no parent)
2269 //
2270 if (ParentNode == NULL) {
2271 //
2272 // We want the root node. create the node.
2273 //
2274 FileInfo = FileHandleGetInfo(FileHandle);
2275 NewShellNode = CreateAndPopulateShellFileInfo(
2276 MapName,
2277 EFI_SUCCESS,
2278 L"\\",
2279 FileHandle,
2280 FileInfo
2281 );
2282 SHELL_FREE_NON_NULL(FileInfo);
2283 } else {
2284 //
2285 // Add the current parameter FileHandle to the list, then end...
2286 //
2287 NewShellNode = InternalDuplicateShellFileInfo((EFI_SHELL_FILE_INFO*)ParentNode, TRUE);
2288 }
2289 if (NewShellNode == NULL) {
2290 Status = EFI_OUT_OF_RESOURCES;
2291 } else {
2292 NewShellNode->Handle = NULL;
2293 if (*FileList == NULL) {
2294 *FileList = AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO));
2295 InitializeListHead(&((*FileList)->Link));
2296 }
2297
2298 //
2299 // Add to the returning to use list
2300 //
2301 InsertTailList(&(*FileList)->Link, &NewShellNode->Link);
2302
2303 Status = EFI_SUCCESS;
2304 }
2305 } else {
2306 Status = EfiShellFindFilesInDir(FileHandle, &ShellInfo);
2307
2308 if (!EFI_ERROR(Status)){
2309 if (StrStr(NextFilePatternStart, L"\\") != NULL){
2310 Directory = TRUE;
2311 } else {
2312 Directory = FALSE;
2313 }
2314 for ( ShellInfoNode = (EFI_SHELL_FILE_INFO*)GetFirstNode(&ShellInfo->Link)
2315 ; !IsNull (&ShellInfo->Link, &ShellInfoNode->Link)
2316 ; ShellInfoNode = (EFI_SHELL_FILE_INFO*)GetNextNode(&ShellInfo->Link, &ShellInfoNode->Link)
2317 ){
2318 if (UnicodeCollation->MetaiMatch(UnicodeCollation, (CHAR16*)ShellInfoNode->FileName, CurrentFilePattern)){
2319 if (ShellInfoNode->FullName != NULL && StrStr(ShellInfoNode->FullName, L":") == NULL) {
2320 Size = StrSize(ShellInfoNode->FullName);
2321 Size += StrSize(MapName) + sizeof(CHAR16);
2322 NewFullName = AllocateZeroPool(Size);
2323 if (NewFullName == NULL) {
2324 Status = EFI_OUT_OF_RESOURCES;
2325 } else {
2326 StrnCpy(NewFullName, MapName, Size/sizeof(CHAR16)-1);
2327 StrnCat(NewFullName, ShellInfoNode->FullName+1, (Size/sizeof(CHAR16))-StrLen(NewFullName)-1);
2328 FreePool((VOID*)ShellInfoNode->FullName);
2329 ShellInfoNode->FullName = NewFullName;
2330 }
2331 }
2332 if (Directory && !EFI_ERROR(Status) && ShellInfoNode->FullName != NULL && ShellInfoNode->FileName != NULL){
2333 //
2334 // should be a directory
2335 //
2336
2337 //
2338 // don't open the . and .. directories
2339 //
2340 if ( (StrCmp(ShellInfoNode->FileName, L".") != 0)
2341 && (StrCmp(ShellInfoNode->FileName, L"..") != 0)
2342 ){
2343 //
2344 //
2345 //
2346 if (EFI_ERROR(Status)) {
2347 break;
2348 }
2349 //
2350 // Open the directory since we need that handle in the next recursion.
2351 //
2352 ShellInfoNode->Status = EfiShellOpenFileByName (ShellInfoNode->FullName, &ShellInfoNode->Handle, EFI_FILE_MODE_READ);
2353
2354 //
2355 // recurse with the next part of the pattern
2356 //
2357 Status = ShellSearchHandle(NextFilePatternStart, UnicodeCollation, ShellInfoNode->Handle, FileList, ShellInfoNode, MapName);
2358 }
2359 } else if (!EFI_ERROR(Status)) {
2360 //
2361 // should be a file
2362 //
2363
2364 //
2365 // copy the information we need into a new Node
2366 //
2367 NewShellNode = InternalDuplicateShellFileInfo(ShellInfoNode, FALSE);
2368 ASSERT(NewShellNode != NULL);
2369 if (NewShellNode == NULL) {
2370 Status = EFI_OUT_OF_RESOURCES;
2371 }
2372 if (*FileList == NULL) {
2373 *FileList = AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO));
2374 InitializeListHead(&((*FileList)->Link));
2375 }
2376
2377 //
2378 // Add to the returning to use list
2379 //
2380 InsertTailList(&(*FileList)->Link, &NewShellNode->Link);
2381 }
2382 }
2383 if (EFI_ERROR(Status)) {
2384 break;
2385 }
2386 }
2387 if (EFI_ERROR(Status)) {
2388 EfiShellFreeFileList(&ShellInfo);
2389 } else {
2390 Status = EfiShellFreeFileList(&ShellInfo);
2391 }
2392 }
2393 }
2394
2395 FreePool(CurrentFilePattern);
2396 return (Status);
2397 }
2398
2399 /**
2400 Find files that match a specified pattern.
2401
2402 This function searches for all files and directories that match the specified
2403 FilePattern. The FilePattern can contain wild-card characters. The resulting file
2404 information is placed in the file list FileList.
2405
2406 Wildcards are processed
2407 according to the rules specified in UEFI Shell 2.0 spec section 3.7.1.
2408
2409 The files in the file list are not opened. The OpenMode field is set to 0 and the FileInfo
2410 field is set to NULL.
2411
2412 if *FileList is not NULL then it must be a pre-existing and properly initialized list.
2413
2414 @param FilePattern Points to a NULL-terminated shell file path, including wildcards.
2415 @param FileList On return, points to the start of a file list containing the names
2416 of all matching files or else points to NULL if no matching files
2417 were found. only on a EFI_SUCCESS return will; this be non-NULL.
2418
2419 @retval EFI_SUCCESS Files found. FileList is a valid list.
2420 @retval EFI_NOT_FOUND No files found.
2421 @retval EFI_NO_MEDIA The device has no media
2422 @retval EFI_DEVICE_ERROR The device reported an error
2423 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
2424 **/
2425 EFI_STATUS
2426 EFIAPI
2427 EfiShellFindFiles(
2428 IN CONST CHAR16 *FilePattern,
2429 OUT EFI_SHELL_FILE_INFO **FileList
2430 )
2431 {
2432 EFI_STATUS Status;
2433 CHAR16 *PatternCopy;
2434 CHAR16 *PatternCurrentLocation;
2435 EFI_DEVICE_PATH_PROTOCOL *RootDevicePath;
2436 SHELL_FILE_HANDLE RootFileHandle;
2437 CHAR16 *MapName;
2438 UINTN Count;
2439
2440 if ( FilePattern == NULL
2441 || FileList == NULL
2442 || StrStr(FilePattern, L":") == NULL
2443 ){
2444 return (EFI_INVALID_PARAMETER);
2445 }
2446 Status = EFI_SUCCESS;
2447 RootDevicePath = NULL;
2448 RootFileHandle = NULL;
2449 MapName = NULL;
2450 PatternCopy = AllocateCopyPool(StrSize(FilePattern), FilePattern);
2451 if (PatternCopy == NULL) {
2452 return (EFI_OUT_OF_RESOURCES);
2453 }
2454
2455 PatternCopy = PathCleanUpDirectories(PatternCopy);
2456
2457 Count = StrStr(PatternCopy, L":") - PatternCopy;
2458 Count += 2;
2459
2460 ASSERT(MapName == NULL);
2461 MapName = StrnCatGrow(&MapName, NULL, PatternCopy, Count);
2462 if (MapName == NULL) {
2463 Status = EFI_OUT_OF_RESOURCES;
2464 } else {
2465 RootDevicePath = EfiShellGetDevicePathFromFilePath(PatternCopy);
2466 if (RootDevicePath == NULL) {
2467 Status = EFI_INVALID_PARAMETER;
2468 } else {
2469 Status = EfiShellOpenRoot(RootDevicePath, &RootFileHandle);
2470 if (!EFI_ERROR(Status)) {
2471 for ( PatternCurrentLocation = PatternCopy
2472 ; *PatternCurrentLocation != ':'
2473 ; PatternCurrentLocation++);
2474 PatternCurrentLocation++;
2475 Status = ShellSearchHandle(PatternCurrentLocation, gUnicodeCollation, RootFileHandle, FileList, NULL, MapName);
2476 }
2477 FreePool(RootDevicePath);
2478 }
2479 }
2480
2481 SHELL_FREE_NON_NULL(PatternCopy);
2482 SHELL_FREE_NON_NULL(MapName);
2483
2484 return(Status);
2485 }
2486
2487 /**
2488 Opens the files that match the path specified.
2489
2490 This function opens all of the files specified by Path. Wildcards are processed
2491 according to the rules specified in UEFI Shell 2.0 spec section 3.7.1. Each
2492 matching file has an EFI_SHELL_FILE_INFO structure created in a linked list.
2493
2494 @param Path A pointer to the path string.
2495 @param OpenMode Specifies the mode used to open each file, EFI_FILE_MODE_READ or
2496 EFI_FILE_MODE_WRITE.
2497 @param FileList Points to the start of a list of files opened.
2498
2499 @retval EFI_SUCCESS Create the file list successfully.
2500 @return Others Can't create the file list.
2501 **/
2502 EFI_STATUS
2503 EFIAPI
2504 EfiShellOpenFileList(
2505 IN CHAR16 *Path,
2506 IN UINT64 OpenMode,
2507 IN OUT EFI_SHELL_FILE_INFO **FileList
2508 )
2509 {
2510 EFI_STATUS Status;
2511 EFI_SHELL_FILE_INFO *ShellFileListItem;
2512 CHAR16 *Path2;
2513 UINTN Path2Size;
2514 CONST CHAR16 *CurDir;
2515 BOOLEAN Found;
2516
2517 PathCleanUpDirectories(Path);
2518
2519 Path2Size = 0;
2520 Path2 = NULL;
2521
2522 if (FileList == NULL || *FileList == NULL) {
2523 return (EFI_INVALID_PARAMETER);
2524 }
2525
2526 if (*Path == L'.' && *(Path+1) == L'\\') {
2527 Path+=2;
2528 }
2529
2530 //
2531 // convert a local path to an absolute path
2532 //
2533 if (StrStr(Path, L":") == NULL) {
2534 CurDir = EfiShellGetCurDir(NULL);
2535 ASSERT((Path2 == NULL && Path2Size == 0) || (Path2 != NULL));
2536 StrnCatGrow(&Path2, &Path2Size, CurDir, 0);
2537 if (*Path == L'\\') {
2538 Path++;
2539 while (PathRemoveLastItem(Path2)) ;
2540 }
2541 ASSERT((Path2 == NULL && Path2Size == 0) || (Path2 != NULL));
2542 StrnCatGrow(&Path2, &Path2Size, Path, 0);
2543 } else {
2544 ASSERT(Path2 == NULL);
2545 StrnCatGrow(&Path2, NULL, Path, 0);
2546 }
2547
2548 PathCleanUpDirectories (Path2);
2549
2550 //
2551 // do the search
2552 //
2553 Status = EfiShellFindFiles(Path2, FileList);
2554
2555 FreePool(Path2);
2556
2557 if (EFI_ERROR(Status)) {
2558 return (Status);
2559 }
2560
2561 Found = FALSE;
2562 //
2563 // We had no errors so open all the files (that are not already opened...)
2564 //
2565 for ( ShellFileListItem = (EFI_SHELL_FILE_INFO*)GetFirstNode(&(*FileList)->Link)
2566 ; !IsNull(&(*FileList)->Link, &ShellFileListItem->Link)
2567 ; ShellFileListItem = (EFI_SHELL_FILE_INFO*)GetNextNode(&(*FileList)->Link, &ShellFileListItem->Link)
2568 ){
2569 if (ShellFileListItem->Status == 0 && ShellFileListItem->Handle == NULL) {
2570 ShellFileListItem->Status = EfiShellOpenFileByName (ShellFileListItem->FullName, &ShellFileListItem->Handle, OpenMode);
2571 Found = TRUE;
2572 }
2573 }
2574
2575 if (!Found) {
2576 return (EFI_NOT_FOUND);
2577 }
2578 return(EFI_SUCCESS);
2579 }
2580
2581 /**
2582 Gets the environment variable and Attributes, or list of environment variables. Can be
2583 used instead of GetEnv().
2584
2585 This function returns the current value of the specified environment variable and
2586 the Attributes. If no variable name was specified, then all of the known
2587 variables will be returned.
2588
2589 @param[in] Name A pointer to the environment variable name. If Name is NULL,
2590 then the function will return all of the defined shell
2591 environment variables. In the case where multiple environment
2592 variables are being returned, each variable will be terminated
2593 by a NULL, and the list will be terminated by a double NULL.
2594 @param[out] Attributes If not NULL, a pointer to the returned attributes bitmask for
2595 the environment variable. In the case where Name is NULL, and
2596 multiple environment variables are being returned, Attributes
2597 is undefined.
2598
2599 @retval NULL The environment variable doesn't exist.
2600 @return A non-NULL value points to the variable's value. The returned
2601 pointer does not need to be freed by the caller.
2602 **/
2603 CONST CHAR16 *
2604 EFIAPI
2605 EfiShellGetEnvEx(
2606 IN CONST CHAR16 *Name,
2607 OUT UINT32 *Attributes OPTIONAL
2608 )
2609 {
2610 EFI_STATUS Status;
2611 VOID *Buffer;
2612 UINTN Size;
2613 LIST_ENTRY List;
2614 ENV_VAR_LIST *Node;
2615 CHAR16 *CurrentWriteLocation;
2616
2617 Size = 0;
2618 Buffer = NULL;
2619
2620 if (Name == NULL) {
2621 //
2622 // Get all our environment variables
2623 //
2624 InitializeListHead(&List);
2625 Status = GetEnvironmentVariableList(&List);
2626 if (EFI_ERROR(Status)){
2627 return (NULL);
2628 }
2629
2630 //
2631 // Build the semi-colon delimited list. (2 passes)
2632 //
2633 for ( Node = (ENV_VAR_LIST*)GetFirstNode(&List)
2634 ; !IsNull(&List, &Node->Link)
2635 ; Node = (ENV_VAR_LIST*)GetNextNode(&List, &Node->Link)
2636 ){
2637 ASSERT(Node->Key != NULL);
2638 Size += StrSize(Node->Key);
2639 }
2640
2641 Size += 2*sizeof(CHAR16);
2642
2643 Buffer = AllocateZeroPool(Size);
2644 if (Buffer == NULL) {
2645 if (!IsListEmpty (&List)) {
2646 FreeEnvironmentVariableList(&List);
2647 }
2648 return (NULL);
2649 }
2650 CurrentWriteLocation = (CHAR16*)Buffer;
2651
2652 for ( Node = (ENV_VAR_LIST*)GetFirstNode(&List)
2653 ; !IsNull(&List, &Node->Link)
2654 ; Node = (ENV_VAR_LIST*)GetNextNode(&List, &Node->Link)
2655 ){
2656 ASSERT(Node->Key != NULL);
2657 StrnCpy(CurrentWriteLocation, Node->Key, (Size)/sizeof(CHAR16) - (CurrentWriteLocation - ((CHAR16*)Buffer)) - 1);
2658 CurrentWriteLocation += StrLen(CurrentWriteLocation) + 1;
2659 }
2660
2661 //
2662 // Free the list...
2663 //
2664 if (!IsListEmpty (&List)) {
2665 FreeEnvironmentVariableList(&List);
2666 }
2667 } else {
2668 //
2669 // We are doing a specific environment variable
2670 //
2671
2672 //
2673 // get the size we need for this EnvVariable
2674 //
2675 Status = SHELL_GET_ENVIRONMENT_VARIABLE_AND_ATTRIBUTES(Name, Attributes, &Size, Buffer);
2676 if (Status == EFI_BUFFER_TOO_SMALL) {
2677 //
2678 // Allocate the space and recall the get function
2679 //
2680 Buffer = AllocateZeroPool(Size);
2681 Status = SHELL_GET_ENVIRONMENT_VARIABLE_AND_ATTRIBUTES(Name, Attributes, &Size, Buffer);
2682 }
2683 //
2684 // we didnt get it (might not exist)
2685 // free the memory if we allocated any and return NULL
2686 //
2687 if (EFI_ERROR(Status)) {
2688 if (Buffer != NULL) {
2689 FreePool(Buffer);
2690 }
2691 return (NULL);
2692 }
2693 }
2694
2695 //
2696 // return the buffer
2697 //
2698 return (AddBufferToFreeList(Buffer));
2699 }
2700
2701 /**
2702 Gets either a single or list of environment variables.
2703
2704 If name is not NULL then this function returns the current value of the specified
2705 environment variable.
2706
2707 If Name is NULL, then a list of all environment variable names is returned. Each is a
2708 NULL terminated string with a double NULL terminating the list.
2709
2710 @param Name A pointer to the environment variable name. If
2711 Name is NULL, then the function will return all
2712 of the defined shell environment variables. In
2713 the case where multiple environment variables are
2714 being returned, each variable will be terminated by
2715 a NULL, and the list will be terminated by a double
2716 NULL.
2717
2718 @retval !=NULL A pointer to the returned string.
2719 The returned pointer does not need to be freed by the caller.
2720
2721 @retval NULL The environment variable doesn't exist or there are
2722 no environment variables.
2723 **/
2724 CONST CHAR16 *
2725 EFIAPI
2726 EfiShellGetEnv(
2727 IN CONST CHAR16 *Name
2728 )
2729 {
2730 return (EfiShellGetEnvEx(Name, NULL));
2731 }
2732
2733 /**
2734 Internal variable setting function. Allows for setting of the read only variables.
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 InternalEfiShellSetEnv(
2746 IN CONST CHAR16 *Name,
2747 IN CONST CHAR16 *Value,
2748 IN BOOLEAN Volatile
2749 )
2750 {
2751 if (Value == NULL || StrLen(Value) == 0) {
2752 return (SHELL_DELETE_ENVIRONMENT_VARIABLE(Name));
2753 } else {
2754 SHELL_DELETE_ENVIRONMENT_VARIABLE(Name);
2755 if (Volatile) {
2756 return (SHELL_SET_ENVIRONMENT_VARIABLE_V(Name, StrSize(Value), Value));
2757 } else {
2758 return (SHELL_SET_ENVIRONMENT_VARIABLE_NV(Name, StrSize(Value), Value));
2759 }
2760 }
2761 }
2762
2763 /**
2764 Sets the environment variable.
2765
2766 This function changes the current value of the specified environment variable. If the
2767 environment variable exists and the Value is an empty string, then the environment
2768 variable is deleted. If the environment variable exists and the Value is not an empty
2769 string, then the value of the environment variable is changed. If the environment
2770 variable does not exist and the Value is an empty string, there is no action. If the
2771 environment variable does not exist and the Value is a non-empty string, then the
2772 environment variable is created and assigned the specified value.
2773
2774 For a description of volatile and non-volatile environment variables, see UEFI Shell
2775 2.0 specification section 3.6.1.
2776
2777 @param Name Points to the NULL-terminated environment variable name.
2778 @param Value Points to the NULL-terminated environment variable value. If the value is an
2779 empty string then the environment variable is deleted.
2780 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
2781
2782 @retval EFI_SUCCESS The environment variable was successfully updated.
2783 **/
2784 EFI_STATUS
2785 EFIAPI
2786 EfiShellSetEnv(
2787 IN CONST CHAR16 *Name,
2788 IN CONST CHAR16 *Value,
2789 IN BOOLEAN Volatile
2790 )
2791 {
2792 if (Name == NULL || *Name == CHAR_NULL) {
2793 return (EFI_INVALID_PARAMETER);
2794 }
2795 //
2796 // Make sure we dont 'set' a predefined read only variable
2797 //
2798 if (gUnicodeCollation->StriColl(
2799 gUnicodeCollation,
2800 (CHAR16*)Name,
2801 L"cwd") == 0
2802 ||gUnicodeCollation->StriColl(
2803 gUnicodeCollation,
2804 (CHAR16*)Name,
2805 L"Lasterror") == 0
2806 ||gUnicodeCollation->StriColl(
2807 gUnicodeCollation,
2808 (CHAR16*)Name,
2809 L"profiles") == 0
2810 ||gUnicodeCollation->StriColl(
2811 gUnicodeCollation,
2812 (CHAR16*)Name,
2813 L"uefishellsupport") == 0
2814 ||gUnicodeCollation->StriColl(
2815 gUnicodeCollation,
2816 (CHAR16*)Name,
2817 L"uefishellversion") == 0
2818 ||gUnicodeCollation->StriColl(
2819 gUnicodeCollation,
2820 (CHAR16*)Name,
2821 L"uefiversion") == 0
2822 ){
2823 return (EFI_INVALID_PARAMETER);
2824 }
2825 return (InternalEfiShellSetEnv(Name, Value, Volatile));
2826 }
2827
2828 /**
2829 Returns the current directory on the specified device.
2830
2831 If FileSystemMapping is NULL, it returns the current working directory. If the
2832 FileSystemMapping is not NULL, it returns the current directory associated with the
2833 FileSystemMapping. In both cases, the returned name includes the file system
2834 mapping (i.e. fs0:\current-dir).
2835
2836 @param FileSystemMapping A pointer to the file system mapping. If NULL,
2837 then the current working directory is returned.
2838
2839 @retval !=NULL The current directory.
2840 @retval NULL Current directory does not exist.
2841 **/
2842 CONST CHAR16 *
2843 EFIAPI
2844 EfiShellGetCurDir(
2845 IN CONST CHAR16 *FileSystemMapping OPTIONAL
2846 )
2847 {
2848 CHAR16 *PathToReturn;
2849 UINTN Size;
2850 SHELL_MAP_LIST *MapListItem;
2851 if (!IsListEmpty(&gShellMapList.Link)) {
2852 //
2853 // if parameter is NULL, use current
2854 //
2855 if (FileSystemMapping == NULL) {
2856 return (EfiShellGetEnv(L"cwd"));
2857 } else {
2858 Size = 0;
2859 PathToReturn = NULL;
2860 MapListItem = ShellCommandFindMapItem(FileSystemMapping);
2861 if (MapListItem != NULL) {
2862 ASSERT((PathToReturn == NULL && Size == 0) || (PathToReturn != NULL));
2863 PathToReturn = StrnCatGrow(&PathToReturn, &Size, MapListItem->MapName, 0);
2864 PathToReturn = StrnCatGrow(&PathToReturn, &Size, MapListItem->CurrentDirectoryPath, 0);
2865 }
2866 }
2867 return (AddBufferToFreeList(PathToReturn));
2868 } else {
2869 return (NULL);
2870 }
2871 }
2872
2873 /**
2874 Changes the current directory on the specified device.
2875
2876 If the FileSystem is NULL, and the directory Dir does not contain a file system's
2877 mapped name, this function changes the current working directory.
2878
2879 If the FileSystem is NULL and the directory Dir contains a mapped name, then the
2880 current file system and the current directory on that file system are changed.
2881
2882 If FileSystem is NULL, and Dir is not NULL, then this changes the current working file
2883 system.
2884
2885 If FileSystem is not NULL and Dir is not NULL, then this function changes the current
2886 directory on the specified file system.
2887
2888 If the current working directory or the current working file system is changed then the
2889 %cwd% environment variable will be updated
2890
2891 @param FileSystem A pointer to the file system's mapped name. If NULL, then the current working
2892 directory is changed.
2893 @param Dir Points to the NULL-terminated directory on the device specified by FileSystem.
2894
2895 @retval EFI_SUCCESS The operation was sucessful
2896 @retval EFI_NOT_FOUND The file system could not be found
2897 **/
2898 EFI_STATUS
2899 EFIAPI
2900 EfiShellSetCurDir(
2901 IN CONST CHAR16 *FileSystem OPTIONAL,
2902 IN CONST CHAR16 *Dir
2903 )
2904 {
2905 CHAR16 *MapName;
2906 SHELL_MAP_LIST *MapListItem;
2907 UINTN Size;
2908 EFI_STATUS Status;
2909 CHAR16 *TempString;
2910 CHAR16 *DirectoryName;
2911 UINTN TempLen;
2912
2913 Size = 0;
2914 MapName = NULL;
2915 MapListItem = NULL;
2916 TempString = NULL;
2917 DirectoryName = NULL;
2918
2919 if ((FileSystem == NULL && Dir == NULL) || Dir == NULL) {
2920 return (EFI_INVALID_PARAMETER);
2921 }
2922
2923 if (IsListEmpty(&gShellMapList.Link)){
2924 return (EFI_NOT_FOUND);
2925 }
2926
2927 DirectoryName = StrnCatGrow(&DirectoryName, NULL, Dir, 0);
2928 ASSERT(DirectoryName != NULL);
2929
2930 PathCleanUpDirectories(DirectoryName);
2931
2932 if (FileSystem == NULL) {
2933 //
2934 // determine the file system mapping to use
2935 //
2936 if (StrStr(DirectoryName, L":") != NULL) {
2937 ASSERT(MapName == NULL);
2938 MapName = StrnCatGrow(&MapName, NULL, DirectoryName, (StrStr(DirectoryName, L":")-DirectoryName+1));
2939 }
2940 //
2941 // find the file system mapping's entry in the list
2942 // or use current
2943 //
2944 if (MapName != NULL) {
2945 MapListItem = ShellCommandFindMapItem(MapName);
2946
2947 //
2948 // make that the current file system mapping
2949 //
2950 if (MapListItem != NULL) {
2951 gShellCurDir = MapListItem;
2952 }
2953 } else {
2954 MapListItem = gShellCurDir;
2955 }
2956
2957 if (MapListItem == NULL) {
2958 return (EFI_NOT_FOUND);
2959 }
2960
2961 //
2962 // now update the MapListItem's current directory
2963 //
2964 if (MapListItem->CurrentDirectoryPath != NULL && DirectoryName[StrLen(DirectoryName) - 1] != L':') {
2965 FreePool(MapListItem->CurrentDirectoryPath);
2966 MapListItem->CurrentDirectoryPath = NULL;
2967 }
2968 if (MapName != NULL) {
2969 TempLen = StrLen(MapName);
2970 if (TempLen != StrLen(DirectoryName)) {
2971 ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));
2972 MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, DirectoryName+StrLen(MapName), 0);
2973 }
2974 } else {
2975 ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));
2976 MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, DirectoryName, 0);
2977 }
2978 if ((MapListItem->CurrentDirectoryPath != NULL && MapListItem->CurrentDirectoryPath[StrLen(MapListItem->CurrentDirectoryPath)-1] != L'\\') || (MapListItem->CurrentDirectoryPath == NULL)) {
2979 ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));
2980 MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, L"\\", 0);
2981 }
2982 } else {
2983 //
2984 // cant have a mapping in the directory...
2985 //
2986 if (StrStr(DirectoryName, L":") != NULL) {
2987 return (EFI_INVALID_PARAMETER);
2988 }
2989 //
2990 // FileSystem != NULL
2991 //
2992 MapListItem = ShellCommandFindMapItem(FileSystem);
2993 if (MapListItem == NULL) {
2994 return (EFI_INVALID_PARAMETER);
2995 }
2996 // gShellCurDir = MapListItem;
2997 if (DirectoryName != NULL) {
2998 //
2999 // change current dir on that file system
3000 //
3001
3002 if (MapListItem->CurrentDirectoryPath != NULL) {
3003 FreePool(MapListItem->CurrentDirectoryPath);
3004 DEBUG_CODE(MapListItem->CurrentDirectoryPath = NULL;);
3005 }
3006 // ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));
3007 // MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, FileSystem, 0);
3008 ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));
3009 MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, L"\\", 0);
3010 ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));
3011 MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, DirectoryName, 0);
3012 if (MapListItem->CurrentDirectoryPath != NULL && MapListItem->CurrentDirectoryPath[StrLen(MapListItem->CurrentDirectoryPath)-1] != L'\\') {
3013 ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));
3014 MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, L"\\", 0);
3015 }
3016 }
3017 }
3018 //
3019 // if updated the current directory then update the environment variable
3020 //
3021 if (MapListItem == gShellCurDir) {
3022 Size = 0;
3023 ASSERT((TempString == NULL && Size == 0) || (TempString != NULL));
3024 StrnCatGrow(&TempString, &Size, MapListItem->MapName, 0);
3025 ASSERT((TempString == NULL && Size == 0) || (TempString != NULL));
3026 StrnCatGrow(&TempString, &Size, MapListItem->CurrentDirectoryPath, 0);
3027 Status = InternalEfiShellSetEnv(L"cwd", TempString, TRUE);
3028 FreePool(TempString);
3029 return (Status);
3030 }
3031 return(EFI_SUCCESS);
3032 }
3033
3034 /**
3035 Return help information about a specific command.
3036
3037 This function returns the help information for the specified command. The help text
3038 can be internal to the shell or can be from a UEFI Shell manual page.
3039
3040 If Sections is specified, then each section name listed will be compared in a casesensitive
3041 manner, to the section names described in Appendix B. If the section exists,
3042 it will be appended to the returned help text. If the section does not exist, no
3043 information will be returned. If Sections is NULL, then all help text information
3044 available will be returned.
3045
3046 @param Command Points to the NULL-terminated UEFI Shell command name.
3047 @param Sections Points to the NULL-terminated comma-delimited
3048 section names to return. If NULL, then all
3049 sections will be returned.
3050 @param HelpText On return, points to a callee-allocated buffer
3051 containing all specified help text.
3052
3053 @retval EFI_SUCCESS The help text was returned.
3054 @retval EFI_OUT_OF_RESOURCES The necessary buffer could not be allocated to hold the
3055 returned help text.
3056 @retval EFI_INVALID_PARAMETER HelpText is NULL
3057 @retval EFI_NOT_FOUND There is no help text available for Command.
3058 **/
3059 EFI_STATUS
3060 EFIAPI
3061 EfiShellGetHelpText(
3062 IN CONST CHAR16 *Command,
3063 IN CONST CHAR16 *Sections OPTIONAL,
3064 OUT CHAR16 **HelpText
3065 )
3066 {
3067 CONST CHAR16 *ManFileName;
3068 CHAR16 *FixCommand;
3069 EFI_STATUS Status;
3070
3071 ASSERT(HelpText != NULL);
3072 FixCommand = NULL;
3073
3074 ManFileName = ShellCommandGetManFileNameHandler(Command);
3075
3076 if (ManFileName != NULL) {
3077 return (ProcessManFile(ManFileName, Command, Sections, NULL, HelpText));
3078 } else {
3079 if ((StrLen(Command)> 4)
3080 && (Command[StrLen(Command)-1] == L'i' || Command[StrLen(Command)-1] == L'I')
3081 && (Command[StrLen(Command)-2] == L'f' || Command[StrLen(Command)-2] == L'F')
3082 && (Command[StrLen(Command)-3] == L'e' || Command[StrLen(Command)-3] == L'E')
3083 && (Command[StrLen(Command)-4] == L'.')
3084 ) {
3085 FixCommand = AllocateZeroPool(StrSize(Command) - 4 * sizeof (CHAR16));
3086 ASSERT(FixCommand != NULL);
3087
3088 StrnCpy(FixCommand, Command, StrLen(Command)-4);
3089 Status = ProcessManFile(FixCommand, FixCommand, Sections, NULL, HelpText);
3090 FreePool(FixCommand);
3091 return Status;
3092 } else {
3093 return (ProcessManFile(Command, Command, Sections, NULL, HelpText));
3094 }
3095 }
3096 }
3097
3098 /**
3099 Gets the enable status of the page break output mode.
3100
3101 User can use this function to determine current page break mode.
3102
3103 @retval TRUE The page break output mode is enabled.
3104 @retval FALSE The page break output mode is disabled.
3105 **/
3106 BOOLEAN
3107 EFIAPI
3108 EfiShellGetPageBreak(
3109 VOID
3110 )
3111 {
3112 return(ShellInfoObject.PageBreakEnabled);
3113 }
3114
3115 /**
3116 Judges whether the active shell is the root shell.
3117
3118 This function makes the user to know that whether the active Shell is the root shell.
3119
3120 @retval TRUE The active Shell is the root Shell.
3121 @retval FALSE The active Shell is NOT the root Shell.
3122 **/
3123 BOOLEAN
3124 EFIAPI
3125 EfiShellIsRootShell(
3126 VOID
3127 )
3128 {
3129 return(ShellInfoObject.RootShellInstance);
3130 }
3131
3132 /**
3133 function to return a semi-colon delimeted list of all alias' in the current shell
3134
3135 up to caller to free the memory.
3136
3137 @retval NULL No alias' were found
3138 @retval NULL An error ocurred getting alias'
3139 @return !NULL a list of all alias'
3140 **/
3141 CHAR16 *
3142 EFIAPI
3143 InternalEfiShellGetListAlias(
3144 )
3145 {
3146 UINT64 MaxStorSize;
3147 UINT64 RemStorSize;
3148 UINT64 MaxVarSize;
3149 EFI_STATUS Status;
3150 EFI_GUID Guid;
3151 CHAR16 *VariableName;
3152 UINTN NameSize;
3153 CHAR16 *RetVal;
3154 UINTN RetSize;
3155
3156 Status = gRT->QueryVariableInfo(EFI_VARIABLE_NON_VOLATILE|EFI_VARIABLE_BOOTSERVICE_ACCESS, &MaxStorSize, &RemStorSize, &MaxVarSize);
3157 ASSERT_EFI_ERROR(Status);
3158
3159 VariableName = AllocateZeroPool((UINTN)MaxVarSize);
3160 RetSize = 0;
3161 RetVal = NULL;
3162
3163 if (VariableName == NULL) {
3164 return (NULL);
3165 }
3166
3167 VariableName[0] = CHAR_NULL;
3168
3169 while (TRUE) {
3170 NameSize = (UINTN)MaxVarSize;
3171 Status = gRT->GetNextVariableName(&NameSize, VariableName, &Guid);
3172 if (Status == EFI_NOT_FOUND){
3173 break;
3174 }
3175 ASSERT_EFI_ERROR(Status);
3176 if (EFI_ERROR(Status)) {
3177 break;
3178 }
3179 if (CompareGuid(&Guid, &gShellAliasGuid)){
3180 ASSERT((RetVal == NULL && RetSize == 0) || (RetVal != NULL));
3181 RetVal = StrnCatGrow(&RetVal, &RetSize, VariableName, 0);
3182 RetVal = StrnCatGrow(&RetVal, &RetSize, L";", 0);
3183 } // compare guid
3184 } // while
3185 FreePool(VariableName);
3186
3187 return (RetVal);
3188 }
3189
3190 /**
3191 Convert a null-terminated unicode string, in-place, to all lowercase.
3192 Then return it.
3193
3194 @param Str The null-terminated string to be converted to all lowercase.
3195
3196 @return The null-terminated string converted into all lowercase.
3197 **/
3198 CHAR16 *
3199 ToLower (
3200 CHAR16 *Str
3201 )
3202 {
3203 UINTN Index;
3204
3205 for (Index = 0; Str[Index] != L'\0'; Index++) {
3206 if (Str[Index] >= L'A' && Str[Index] <= L'Z') {