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