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