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