2 Member functions of EFI_SHELL_PARAMETERS_PROTOCOL and functions for creation,
3 manipulation, and initialization of EFI_SHELL_PARAMETERS_PROTOCOL.
5 Copyright (c) 2009 - 2011, 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
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.
16 #include "ShellParametersProtocol.h"
17 #include "ConsoleWrappers.h"
20 return the next parameter from a command line string;
22 This function moves the next parameter from Walker into TempParameter and moves
23 Walker up past that parameter for recursive calling. When the final parameter
24 is moved *Walker will be set to NULL;
26 Temp Parameter must be large enough to hold the parameter before calling this
29 @param[in,out] Walker pointer to string of command line. Adjusted to
30 reminaing command line on return
31 @param[in,out] TempParameter pointer to string of command line item extracted.
38 CHAR16
**TempParameter
44 ASSERT(Walker
!= NULL
);
45 ASSERT(*Walker
!= NULL
);
46 ASSERT(TempParameter
!= NULL
);
47 ASSERT(*TempParameter
!= NULL
);
50 // make sure we dont have any leading spaces
52 while ((*Walker
)[0] == L
' ') {
57 // make sure we still have some params now...
59 if (StrLen(*Walker
) == 0) {
60 ASSERT((*Walker
)[0] == CHAR_NULL
);
66 // we have a quoted parameter
67 // could be the last parameter, but SHOULD have a trailing quote
69 if ((*Walker
)[0] == L
'\"') {
71 for (TempLoc
= *Walker
+ 1 ; TempLoc
!= NULL
&& *TempLoc
!= CHAR_NULL
; TempLoc
++) {
72 if (*TempLoc
== L
'^' && *(TempLoc
+1) == L
'^') {
74 } else if (*TempLoc
== L
'^' && *(TempLoc
+1) == L
'\"') {
76 } else if (*TempLoc
== L
'\"') {
82 if (NextDelim
- ((*Walker
)+1) == 0) {
86 StrCpy(*TempParameter
, L
"");
87 *Walker
= NextDelim
+ 1;
88 } else if (NextDelim
!= NULL
) {
89 StrnCpy(*TempParameter
, (*Walker
)+1, NextDelim
- ((*Walker
)+1));
90 *Walker
= NextDelim
+ 1;
93 // last one... someone forgot the training quote!
95 StrCpy(*TempParameter
, *Walker
);
98 for (TempLoc
= *TempParameter
; TempLoc
!= NULL
&& *TempLoc
!= CHAR_NULL
; TempLoc
++) {
99 if ((*TempLoc
== L
'^' && *(TempLoc
+1) == L
'^')
100 || (*TempLoc
== L
'^' && *(TempLoc
+1) == L
'|')
101 || (*TempLoc
== L
'^' && *(TempLoc
+1) == L
'\"')
103 CopyMem(TempLoc
, TempLoc
+1, StrSize(TempLoc
) - sizeof(TempLoc
[0]));
108 // we have a regular parameter (no quote) OR
109 // we have the final parameter (no trailing space)
111 NextDelim
= StrStr((*Walker
), L
" ");
112 if (NextDelim
!= NULL
) {
113 StrnCpy(*TempParameter
, *Walker
, NextDelim
- (*Walker
));
114 (*TempParameter
)[NextDelim
- (*Walker
)] = CHAR_NULL
;
115 *Walker
= NextDelim
+1;
120 StrCpy(*TempParameter
, *Walker
);
123 for (NextDelim
= *TempParameter
; NextDelim
!= NULL
&& *NextDelim
!= CHAR_NULL
; NextDelim
++) {
124 if (*NextDelim
== L
'^' && *(NextDelim
+1) == L
'^') {
125 CopyMem(NextDelim
, NextDelim
+1, StrSize(NextDelim
) - sizeof(NextDelim
[0]));
126 }/* else if (*NextDelim == L'^') {
130 while ((*TempParameter
)[StrLen(*TempParameter
)-1] == L
' ') {
131 (*TempParameter
)[StrLen(*TempParameter
)-1] = CHAR_NULL
;
133 while ((*TempParameter
)[0] == L
' ') {
134 CopyMem(*TempParameter
, (*TempParameter
)+1, StrSize(*TempParameter
) - sizeof((*TempParameter
)[0]));
141 Function to populate Argc and Argv.
143 This function parses the CommandLine and divides it into standard C style Argc/Argv
144 parameters for inclusion in EFI_SHELL_PARAMETERS_PROTOCOL. this supports space
145 delimited and quote surrounded parameter definition.
147 @param[in] CommandLine String of command line to parse
148 @param[in,out] Argv pointer to array of strings; one for each parameter
149 @param[in,out] Argc pointer to number of strings in Argv array
151 @return EFI_SUCCESS the operation was sucessful
152 @return EFI_OUT_OF_RESOURCES a memory allocation failed.
156 ParseCommandLineToArgs(
157 IN CONST CHAR16
*CommandLine
,
158 IN OUT CHAR16
***Argv
,
163 CHAR16
*TempParameter
;
168 ASSERT(Argc
!= NULL
);
169 ASSERT(Argv
!= NULL
);
171 if (CommandLine
== NULL
|| StrLen(CommandLine
)==0) {
174 return (EFI_SUCCESS
);
177 Size
= StrSize(CommandLine
);
178 TempParameter
= AllocateZeroPool(Size
);
179 if (TempParameter
== NULL
) {
180 return (EFI_OUT_OF_RESOURCES
);
184 , Walker
= (CHAR16
*)CommandLine
185 ; Walker
!= NULL
&& *Walker
!= CHAR_NULL
186 ; GetNextParameter(&Walker
, &TempParameter
)
191 Walker = (CHAR16*)CommandLine;
192 while(Walker != NULL) {
193 GetNextParameter(&Walker, &TempParameter);
198 // lets allocate the pointer array
200 (*Argv
) = AllocateZeroPool((Count
)*sizeof(CHAR16
*));
202 return (EFI_OUT_OF_RESOURCES
);
206 Walker
= (CHAR16
*)CommandLine
;
207 while(Walker
!= NULL
&& *Walker
!= CHAR_NULL
) {
208 SetMem16(TempParameter
, Size
, CHAR_NULL
);
209 GetNextParameter(&Walker
, &TempParameter
);
210 NewParam
= AllocateZeroPool(StrSize(TempParameter
));
211 ASSERT(NewParam
!= NULL
);
212 StrCpy(NewParam
, TempParameter
);
213 ((CHAR16
**)(*Argv
))[(*Argc
)] = NewParam
;
216 ASSERT(Count
>= (*Argc
));
217 return (EFI_SUCCESS
);
221 creates a new EFI_SHELL_PARAMETERS_PROTOCOL instance and populates it and then
222 installs it on our handle and if there is an existing version of the protocol
223 that one is cached for removal later.
225 @param[in,out] NewShellParameters on a successful return, a pointer to pointer
226 to the newly installed interface.
227 @param[in,out] RootShellInstance on a successful return, pointer to boolean.
228 TRUE if this is the root shell instance.
230 @retval EFI_SUCCESS the operation completed successfully.
231 @return other the operation failed.
232 @sa ReinstallProtocolInterface
233 @sa InstallProtocolInterface
234 @sa ParseCommandLineToArgs
238 CreatePopulateInstallShellParametersProtocol (
239 IN OUT EFI_SHELL_PARAMETERS_PROTOCOL
**NewShellParameters
,
240 IN OUT BOOLEAN
*RootShellInstance
244 EFI_LOADED_IMAGE_PROTOCOL
*LoadedImage
;
245 CHAR16
*FullCommandLine
;
249 FullCommandLine
= NULL
;
253 // Assert for valid parameters
255 ASSERT(NewShellParameters
!= NULL
);
256 ASSERT(RootShellInstance
!= NULL
);
259 // See if we have a shell parameters placed on us
261 Status
= gBS
->OpenProtocol (
263 &gEfiShellParametersProtocolGuid
,
264 (VOID
**) &ShellInfoObject
.OldShellParameters
,
267 EFI_OPEN_PROTOCOL_GET_PROTOCOL
270 // if we don't then we must be the root shell (error is expected)
272 if (EFI_ERROR (Status
)) {
273 *RootShellInstance
= TRUE
;
277 // Allocate the new structure
279 *NewShellParameters
= AllocateZeroPool(sizeof(EFI_SHELL_PARAMETERS_PROTOCOL
));
280 if ((*NewShellParameters
) == NULL
) {
281 return (EFI_OUT_OF_RESOURCES
);
285 // get loaded image protocol
287 Status
= gBS
->OpenProtocol (
289 &gEfiLoadedImageProtocolGuid
,
290 (VOID
**) &LoadedImage
,
293 EFI_OPEN_PROTOCOL_GET_PROTOCOL
295 ASSERT_EFI_ERROR(Status
);
297 // Build the full command line
299 Status
= SHELL_GET_ENVIRONMENT_VARIABLE(L
"ShellOpt", &Size
, &FullCommandLine
);
300 if (Status
== EFI_BUFFER_TOO_SMALL
) {
301 FullCommandLine
= AllocateZeroPool(Size
+ LoadedImage
->LoadOptionsSize
);
302 Status
= SHELL_GET_ENVIRONMENT_VARIABLE(L
"ShellOpt", &Size
, &FullCommandLine
);
304 if (Status
== EFI_NOT_FOUND
) {
306 // no parameters via environment... ok
309 if (EFI_ERROR(Status
)) {
313 if (Size
== 0 && LoadedImage
->LoadOptionsSize
!= 0) {
314 ASSERT(FullCommandLine
== NULL
);
316 // Now we need to include a NULL terminator in the size.
318 Size
= LoadedImage
->LoadOptionsSize
+ sizeof(FullCommandLine
[0]);
319 FullCommandLine
= AllocateZeroPool(Size
);
321 if (FullCommandLine
!= NULL
) {
322 if (LoadedImage
->LoadOptionsSize
!= 0){
323 StrCpy(FullCommandLine
, LoadedImage
->LoadOptions
);
326 // Populate Argc and Argv
328 Status
= ParseCommandLineToArgs(FullCommandLine
,
329 &(*NewShellParameters
)->Argv
,
330 &(*NewShellParameters
)->Argc
);
332 FreePool(FullCommandLine
);
334 ASSERT_EFI_ERROR(Status
);
336 (*NewShellParameters
)->Argv
= NULL
;
337 (*NewShellParameters
)->Argc
= 0;
341 // Populate the 3 faked file systems...
343 if (*RootShellInstance
) {
344 (*NewShellParameters
)->StdIn
= &FileInterfaceStdIn
;
345 (*NewShellParameters
)->StdOut
= &FileInterfaceStdOut
;
346 (*NewShellParameters
)->StdErr
= &FileInterfaceStdErr
;
347 Status
= gBS
->InstallProtocolInterface(&gImageHandle
,
348 &gEfiShellParametersProtocolGuid
,
349 EFI_NATIVE_INTERFACE
,
350 (VOID
*)(*NewShellParameters
));
353 // copy from the existing ones
355 (*NewShellParameters
)->StdIn
= ShellInfoObject
.OldShellParameters
->StdIn
;
356 (*NewShellParameters
)->StdOut
= ShellInfoObject
.OldShellParameters
->StdOut
;
357 (*NewShellParameters
)->StdErr
= ShellInfoObject
.OldShellParameters
->StdErr
;
358 Status
= gBS
->ReinstallProtocolInterface(gImageHandle
,
359 &gEfiShellParametersProtocolGuid
,
360 (VOID
*)ShellInfoObject
.OldShellParameters
,
361 (VOID
*)(*NewShellParameters
));
368 frees all memory used by createion and installation of shell parameters protocol
369 and if there was an old version installed it will restore that one.
371 @param NewShellParameters the interface of EFI_SHELL_PARAMETERS_PROTOCOL that is
374 @retval EFI_SUCCESS the cleanup was successful
375 @return other the cleanup failed
376 @sa ReinstallProtocolInterface
377 @sa UninstallProtocolInterface
381 CleanUpShellParametersProtocol (
382 IN OUT EFI_SHELL_PARAMETERS_PROTOCOL
*NewShellParameters
389 // If the old exists we need to restore it
391 if (ShellInfoObject
.OldShellParameters
!= NULL
) {
392 Status
= gBS
->ReinstallProtocolInterface(gImageHandle
,
393 &gEfiShellParametersProtocolGuid
,
394 (VOID
*)NewShellParameters
,
395 (VOID
*)ShellInfoObject
.OldShellParameters
);
396 DEBUG_CODE(ShellInfoObject
.OldShellParameters
= NULL
;);
399 // No old one, just uninstall us...
401 Status
= gBS
->UninstallProtocolInterface(gImageHandle
,
402 &gEfiShellParametersProtocolGuid
,
403 (VOID
*)NewShellParameters
);
405 if (NewShellParameters
->Argv
!= NULL
) {
406 for ( LoopCounter
= 0
407 ; LoopCounter
< NewShellParameters
->Argc
410 FreePool(NewShellParameters
->Argv
[LoopCounter
]);
412 FreePool(NewShellParameters
->Argv
);
414 FreePool(NewShellParameters
);
421 IN CONST CHAR16
*FileName
424 SHELL_FILE_HANDLE Handle
;
426 UINT64 OriginalFilePosition
;
430 Status
= gEfiShellProtocol
->OpenFileByName(FileName
, &Handle
, EFI_FILE_MODE_READ
);
431 if (EFI_ERROR(Status
)) {
434 gEfiShellProtocol
->GetFilePosition(Handle
, &OriginalFilePosition
);
435 gEfiShellProtocol
->SetFilePosition(Handle
, 0);
436 CharSize
= sizeof(CHAR16
);
437 Status
= gEfiShellProtocol
->ReadFile(Handle
, &CharSize
, &CharBuffer
);
438 if (EFI_ERROR(Status
) || CharBuffer
!= gUnicodeFileTag
) {
439 Status
= EFI_BUFFER_TOO_SMALL
;
441 gEfiShellProtocol
->SetFilePosition(Handle
, OriginalFilePosition
);
442 gEfiShellProtocol
->CloseFile(Handle
);
447 Strips out quotes sections of a string.
449 All of the characters between quotes is replaced with spaces.
454 IN OUT CHAR16
*TheString
459 for (RemoveNow
= FALSE
; TheString
!= NULL
&& *TheString
!= CHAR_NULL
; TheString
++) {
460 if (*TheString
== L
'^' && *(TheString
+ 1) == L
'\"') {
462 } else if (*TheString
== L
'\"') {
463 RemoveNow
= (BOOLEAN
)!RemoveNow
;
464 } else if (RemoveNow
) {
471 Funcion will replace the current StdIn and StdOut in the ShellParameters protocol
472 structure by parsing NewCommandLine. The current values are returned to the
475 This will also update the system table.
477 @param[in,out] ShellParameters Pointer to parameter structure to modify.
478 @param[in] NewCommandLine The new command line to parse and use.
479 @param[out] OldStdIn Pointer to old StdIn.
480 @param[out] OldStdOut Pointer to old StdOut.
481 @param[out] OldStdErr Pointer to old StdErr.
482 @param[out] SystemTableInfo Pointer to old system table information.
484 @retval EFI_SUCCESS Operation was sucessful, Argv and Argc are valid.
485 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
489 UpdateStdInStdOutStdErr(
490 IN OUT EFI_SHELL_PARAMETERS_PROTOCOL
*ShellParameters
,
491 IN CHAR16
*NewCommandLine
,
492 OUT SHELL_FILE_HANDLE
*OldStdIn
,
493 OUT SHELL_FILE_HANDLE
*OldStdOut
,
494 OUT SHELL_FILE_HANDLE
*OldStdErr
,
495 OUT SYSTEM_TABLE_INFO
*SystemTableInfo
498 CHAR16
*CommandLineCopy
;
499 CHAR16
*CommandLineWalker
;
500 CHAR16
*StdErrFileName
;
501 CHAR16
*StdOutFileName
;
502 CHAR16
*StdInFileName
;
503 CHAR16
*StdInVarName
;
504 CHAR16
*StdOutVarName
;
505 CHAR16
*StdErrVarName
;
507 SHELL_FILE_HANDLE TempHandle
;
517 CHAR16
*FirstLocation
;
523 StdOutVarName
= NULL
;
524 StdErrVarName
= NULL
;
525 StdErrFileName
= NULL
;
526 StdInFileName
= NULL
;
527 StdOutFileName
= NULL
;
530 CommandLineCopy
= NULL
;
531 FirstLocation
= NULL
;
533 if (ShellParameters
== NULL
|| SystemTableInfo
== NULL
|| OldStdIn
== NULL
|| OldStdOut
== NULL
|| OldStdErr
== NULL
) {
534 return (EFI_INVALID_PARAMETER
);
537 SystemTableInfo
->ConIn
= gST
->ConIn
;
538 SystemTableInfo
->ConInHandle
= gST
->ConsoleInHandle
;
539 SystemTableInfo
->ConOut
= gST
->ConOut
;
540 SystemTableInfo
->ConOutHandle
= gST
->ConsoleOutHandle
;
541 SystemTableInfo
->ConErr
= gST
->StdErr
;
542 SystemTableInfo
->ConErrHandle
= gST
->StandardErrorHandle
;
543 *OldStdIn
= ShellParameters
->StdIn
;
544 *OldStdOut
= ShellParameters
->StdOut
;
545 *OldStdErr
= ShellParameters
->StdErr
;
547 if (NewCommandLine
== NULL
) {
548 return (EFI_SUCCESS
);
551 CommandLineCopy
= StrnCatGrow(&CommandLineCopy
, NULL
, NewCommandLine
, 0);
552 Status
= EFI_SUCCESS
;
554 FirstLocation
= CommandLineCopy
+ StrLen(CommandLineCopy
);
556 StripQuotes(CommandLineCopy
);
558 if (!IsListEmpty(&ShellInfoObject
.SplitList
.Link
)) {
559 Split
= (SPLIT_LIST
*)GetFirstNode(&ShellInfoObject
.SplitList
.Link
);
560 if (Split
!= NULL
&& Split
->SplitStdIn
!= NULL
) {
561 ShellParameters
->StdIn
= Split
->SplitStdIn
;
563 if (Split
!= NULL
&& Split
->SplitStdOut
!= NULL
) {
564 ShellParameters
->StdOut
= Split
->SplitStdOut
;
568 if (!EFI_ERROR(Status
) && (CommandLineWalker
= StrStr(CommandLineCopy
, L
" 2>>v ")) != NULL
) {
569 FirstLocation
= MIN(CommandLineWalker
, FirstLocation
);
570 SetMem16(CommandLineWalker
, 12, L
' ');
571 StdErrVarName
= CommandLineWalker
+= 6;
573 if (StrStr(CommandLineWalker
, L
" 2>>v ") != NULL
) {
574 Status
= EFI_NOT_FOUND
;
577 if (!EFI_ERROR(Status
) && (CommandLineWalker
= StrStr(CommandLineCopy
, L
" 1>>v ")) != NULL
) {
578 FirstLocation
= MIN(CommandLineWalker
, FirstLocation
);
579 SetMem16(CommandLineWalker
, 12, L
' ');
580 StdOutVarName
= CommandLineWalker
+= 6;
582 if (StrStr(CommandLineWalker
, L
" 1>>v ") != NULL
) {
583 Status
= EFI_NOT_FOUND
;
585 } else if (!EFI_ERROR(Status
) && (CommandLineWalker
= StrStr(CommandLineCopy
, L
" >>v ")) != NULL
) {
586 FirstLocation
= MIN(CommandLineWalker
, FirstLocation
);
587 SetMem16(CommandLineWalker
, 10, L
' ');
588 StdOutVarName
= CommandLineWalker
+= 5;
590 if (StrStr(CommandLineWalker
, L
" >>v ") != NULL
) {
591 Status
= EFI_NOT_FOUND
;
593 } else if (!EFI_ERROR(Status
) && (CommandLineWalker
= StrStr(CommandLineCopy
, L
" >v ")) != NULL
) {
594 FirstLocation
= MIN(CommandLineWalker
, FirstLocation
);
595 SetMem16(CommandLineWalker
, 8, L
' ');
596 StdOutVarName
= CommandLineWalker
+= 4;
598 if (StrStr(CommandLineWalker
, L
" >v ") != NULL
) {
599 Status
= EFI_NOT_FOUND
;
602 if (!EFI_ERROR(Status
) && (CommandLineWalker
= StrStr(CommandLineCopy
, L
" 1>>a ")) != NULL
) {
603 FirstLocation
= MIN(CommandLineWalker
, FirstLocation
);
604 SetMem16(CommandLineWalker
, 12, L
' ');
605 StdOutFileName
= CommandLineWalker
+= 6;
608 if (StrStr(CommandLineWalker
, L
" 1>>a ") != NULL
) {
609 Status
= EFI_NOT_FOUND
;
612 if (!EFI_ERROR(Status
) && (CommandLineWalker
= StrStr(CommandLineCopy
, L
" 1>> ")) != NULL
) {
613 FirstLocation
= MIN(CommandLineWalker
, FirstLocation
);
614 SetMem16(CommandLineWalker
, 10, L
' ');
615 if (StdOutFileName
!= NULL
) {
616 Status
= EFI_INVALID_PARAMETER
;
618 StdOutFileName
= CommandLineWalker
+= 5;
621 if (StrStr(CommandLineWalker
, L
" 1>> ") != NULL
) {
622 Status
= EFI_NOT_FOUND
;
625 if (!EFI_ERROR(Status
) && (CommandLineWalker
= StrStr(CommandLineCopy
, L
" >> ")) != NULL
) {
626 FirstLocation
= MIN(CommandLineWalker
, FirstLocation
);
627 SetMem16(CommandLineWalker
, 8, L
' ');
628 if (StdOutFileName
!= NULL
) {
629 Status
= EFI_INVALID_PARAMETER
;
631 StdOutFileName
= CommandLineWalker
+= 4;
634 if (StrStr(CommandLineWalker
, L
" >> ") != NULL
) {
635 Status
= EFI_NOT_FOUND
;
638 if (!EFI_ERROR(Status
) && (CommandLineWalker
= StrStr(CommandLineCopy
, L
" >>a ")) != NULL
) {
639 FirstLocation
= MIN(CommandLineWalker
, FirstLocation
);
640 SetMem16(CommandLineWalker
, 10, L
' ');
641 if (StdOutFileName
!= NULL
) {
642 Status
= EFI_INVALID_PARAMETER
;
644 StdOutFileName
= CommandLineWalker
+= 5;
648 if (StrStr(CommandLineWalker
, L
" >>a ") != NULL
) {
649 Status
= EFI_NOT_FOUND
;
652 if (!EFI_ERROR(Status
) && (CommandLineWalker
= StrStr(CommandLineCopy
, L
" 1>a ")) != NULL
) {
653 FirstLocation
= MIN(CommandLineWalker
, FirstLocation
);
654 SetMem16(CommandLineWalker
, 10, L
' ');
655 if (StdOutFileName
!= NULL
) {
656 Status
= EFI_INVALID_PARAMETER
;
658 StdOutFileName
= CommandLineWalker
+= 5;
662 if (StrStr(CommandLineWalker
, L
" 1>a ") != NULL
) {
663 Status
= EFI_NOT_FOUND
;
666 if (!EFI_ERROR(Status
) && (CommandLineWalker
= StrStr(CommandLineCopy
, L
" >a ")) != NULL
) {
667 FirstLocation
= MIN(CommandLineWalker
, FirstLocation
);
668 SetMem16(CommandLineWalker
, 8, L
' ');
669 if (StdOutFileName
!= NULL
) {
670 Status
= EFI_INVALID_PARAMETER
;
672 StdOutFileName
= CommandLineWalker
+= 4;
676 if (StrStr(CommandLineWalker
, L
" >a ") != NULL
) {
677 Status
= EFI_NOT_FOUND
;
680 if (!EFI_ERROR(Status
) && (CommandLineWalker
= StrStr(CommandLineCopy
, L
" 2>> ")) != NULL
) {
681 FirstLocation
= MIN(CommandLineWalker
, FirstLocation
);
682 SetMem16(CommandLineWalker
, 10, L
' ');
683 if (StdErrFileName
!= NULL
) {
684 Status
= EFI_INVALID_PARAMETER
;
686 StdErrFileName
= CommandLineWalker
+= 5;
689 if (StrStr(CommandLineWalker
, L
" 2>> ") != NULL
) {
690 Status
= EFI_NOT_FOUND
;
694 if (!EFI_ERROR(Status
) && (CommandLineWalker
= StrStr(CommandLineCopy
, L
" 2>v ")) != NULL
) {
695 FirstLocation
= MIN(CommandLineWalker
, FirstLocation
);
696 SetMem16(CommandLineWalker
, 10, L
' ');
697 if (StdErrVarName
!= NULL
) {
698 Status
= EFI_INVALID_PARAMETER
;
700 StdErrVarName
= CommandLineWalker
+= 5;
703 if (StrStr(CommandLineWalker
, L
" 2>v ") != NULL
) {
704 Status
= EFI_NOT_FOUND
;
707 if (!EFI_ERROR(Status
) && (CommandLineWalker
= StrStr(CommandLineCopy
, L
" 1>v ")) != NULL
) {
708 FirstLocation
= MIN(CommandLineWalker
, FirstLocation
);
709 SetMem16(CommandLineWalker
, 10, L
' ');
710 if (StdOutVarName
!= NULL
) {
711 Status
= EFI_INVALID_PARAMETER
;
713 StdOutVarName
= CommandLineWalker
+= 5;
716 if (StrStr(CommandLineWalker
, L
" 1>v ") != NULL
) {
717 Status
= EFI_NOT_FOUND
;
720 if (!EFI_ERROR(Status
) && (CommandLineWalker
= StrStr(CommandLineCopy
, L
" 2>a ")) != NULL
) {
721 FirstLocation
= MIN(CommandLineWalker
, FirstLocation
);
722 SetMem16(CommandLineWalker
, 10, L
' ');
723 if (StdErrFileName
!= NULL
) {
724 Status
= EFI_INVALID_PARAMETER
;
726 StdErrFileName
= CommandLineWalker
+= 5;
730 if (StrStr(CommandLineWalker
, L
" 2>a ") != NULL
) {
731 Status
= EFI_NOT_FOUND
;
734 if (!EFI_ERROR(Status
) && (CommandLineWalker
= StrStr(CommandLineCopy
, L
" 2> ")) != NULL
) {
735 FirstLocation
= MIN(CommandLineWalker
, FirstLocation
);
736 SetMem16(CommandLineWalker
, 8, L
' ');
737 if (StdErrFileName
!= NULL
) {
738 Status
= EFI_INVALID_PARAMETER
;
740 StdErrFileName
= CommandLineWalker
+= 4;
743 if (StrStr(CommandLineWalker
, L
" 2> ") != NULL
) {
744 Status
= EFI_NOT_FOUND
;
748 if (!EFI_ERROR(Status
) && (CommandLineWalker
= StrStr(CommandLineCopy
, L
" 1> ")) != NULL
) {
749 FirstLocation
= MIN(CommandLineWalker
, FirstLocation
);
750 SetMem16(CommandLineWalker
, 8, L
' ');
751 if (StdOutFileName
!= NULL
) {
752 Status
= EFI_INVALID_PARAMETER
;
754 StdOutFileName
= CommandLineWalker
+= 4;
757 if (StrStr(CommandLineWalker
, L
" 1> ") != NULL
) {
758 Status
= EFI_NOT_FOUND
;
762 if (!EFI_ERROR(Status
) && (CommandLineWalker
= StrStr(CommandLineCopy
, L
" > ")) != NULL
) {
763 FirstLocation
= MIN(CommandLineWalker
, FirstLocation
);
764 SetMem16(CommandLineWalker
, 6, L
' ');
765 if (StdOutFileName
!= NULL
) {
766 Status
= EFI_INVALID_PARAMETER
;
768 StdOutFileName
= CommandLineWalker
+= 3;
771 if (StrStr(CommandLineWalker
, L
" > ") != NULL
) {
772 Status
= EFI_NOT_FOUND
;
776 if (!EFI_ERROR(Status
) && (CommandLineWalker
= StrStr(CommandLineCopy
, L
" < ")) != NULL
) {
777 FirstLocation
= MIN(CommandLineWalker
, FirstLocation
);
778 SetMem16(CommandLineWalker
, 6, L
' ');
779 if (StdInFileName
!= NULL
) {
780 Status
= EFI_INVALID_PARAMETER
;
782 StdInFileName
= CommandLineWalker
+= 3;
784 if (StrStr(CommandLineWalker
, L
" < ") != NULL
) {
785 Status
= EFI_NOT_FOUND
;
788 if (!EFI_ERROR(Status
) && (CommandLineWalker
= StrStr(CommandLineCopy
, L
" <a ")) != NULL
) {
789 FirstLocation
= MIN(CommandLineWalker
, FirstLocation
);
790 SetMem16(CommandLineWalker
, 8, L
' ');
791 if (StdInFileName
!= NULL
) {
792 Status
= EFI_INVALID_PARAMETER
;
794 StdInFileName
= CommandLineWalker
+= 4;
797 if (StrStr(CommandLineWalker
, L
" <a ") != NULL
) {
798 Status
= EFI_NOT_FOUND
;
801 if (!EFI_ERROR(Status
) && (CommandLineWalker
= StrStr(CommandLineCopy
, L
" <v ")) != NULL
) {
802 FirstLocation
= MIN(CommandLineWalker
, FirstLocation
);
803 SetMem16(CommandLineWalker
, 8, L
' ');
804 if (StdInVarName
!= NULL
) {
805 Status
= EFI_INVALID_PARAMETER
;
807 StdInVarName
= CommandLineWalker
+= 4;
809 if (StrStr(CommandLineWalker
, L
" <v ") != NULL
) {
810 Status
= EFI_NOT_FOUND
;
814 if (FirstLocation
!= CommandLineCopy
+ StrLen(CommandLineCopy
)
815 && ((UINTN
)(FirstLocation
- CommandLineCopy
) < StrLen(NewCommandLine
))
817 *(NewCommandLine
+ (UINTN
)(FirstLocation
- CommandLineCopy
)) = CHAR_NULL
;
820 if (!EFI_ERROR(Status
)) {
821 if (StdErrFileName
!= NULL
&& (CommandLineWalker
= StrStr(StdErrFileName
, L
" ")) != NULL
) {
822 CommandLineWalker
[0] = CHAR_NULL
;
824 if (StdOutFileName
!= NULL
&& (CommandLineWalker
= StrStr(StdOutFileName
, L
" ")) != NULL
) {
825 CommandLineWalker
[0] = CHAR_NULL
;
827 if (StdInFileName
!= NULL
&& (CommandLineWalker
= StrStr(StdInFileName
, L
" ")) != NULL
) {
828 CommandLineWalker
[0] = CHAR_NULL
;
830 if (StdErrVarName
!= NULL
&& (CommandLineWalker
= StrStr(StdErrVarName
, L
" ")) != NULL
) {
831 CommandLineWalker
[0] = CHAR_NULL
;
833 if (StdOutVarName
!= NULL
&& (CommandLineWalker
= StrStr(StdOutVarName
, L
" ")) != NULL
) {
834 CommandLineWalker
[0] = CHAR_NULL
;
836 if (StdInVarName
!= NULL
&& (CommandLineWalker
= StrStr(StdInVarName
, L
" ")) != NULL
) {
837 CommandLineWalker
[0] = CHAR_NULL
;
841 // Verify not the same and not duplicating something from a split
845 // Check that no 2 filenames are the same
847 (StdErrFileName
!= NULL
&& StdOutFileName
!= NULL
&& StringNoCaseCompare(&StdErrFileName
, &StdOutFileName
) == 0)
848 ||(StdErrFileName
!= NULL
&& StdInFileName
!= NULL
&& StringNoCaseCompare(&StdErrFileName
, &StdInFileName
) == 0)
849 ||(StdOutFileName
!= NULL
&& StdInFileName
!= NULL
&& StringNoCaseCompare(&StdOutFileName
, &StdInFileName
) == 0)
851 // Check that no 2 variable names are the same
853 ||(StdErrVarName
!= NULL
&& StdInVarName
!= NULL
&& StringNoCaseCompare(&StdErrVarName
, &StdInVarName
) == 0)
854 ||(StdOutVarName
!= NULL
&& StdInVarName
!= NULL
&& StringNoCaseCompare(&StdOutVarName
, &StdInVarName
) == 0)
855 ||(StdErrVarName
!= NULL
&& StdOutVarName
!= NULL
&& StringNoCaseCompare(&StdErrVarName
, &StdOutVarName
) == 0)
857 // When a split (using | operator) is in place some are not allowed
859 ||(Split
!= NULL
&& Split
->SplitStdIn
!= NULL
&& (StdInVarName
!= NULL
|| StdInFileName
!= NULL
))
860 ||(Split
!= NULL
&& Split
->SplitStdOut
!= NULL
&& (StdOutVarName
!= NULL
|| StdOutFileName
!= NULL
))
862 // Check that nothing is trying to be output to 2 locations.
864 ||(StdErrFileName
!= NULL
&& StdErrVarName
!= NULL
)
865 ||(StdOutFileName
!= NULL
&& StdOutVarName
!= NULL
)
866 ||(StdInFileName
!= NULL
&& StdInVarName
!= NULL
)
868 // Check for no volatile environment variables
870 ||(StdErrVarName
!= NULL
&& !IsVolatileEnv(StdErrVarName
))
871 ||(StdOutVarName
!= NULL
&& !IsVolatileEnv(StdOutVarName
))
873 // Cant redirect during a reconnect operation.
875 ||(StrStr(NewCommandLine
, L
"connect -r") != NULL
876 && (StdOutVarName
!= NULL
|| StdOutFileName
!= NULL
|| StdErrFileName
!= NULL
|| StdErrVarName
!= NULL
))
878 // Check that filetypes (Unicode/Ascii) do not change during an append
880 ||(StdOutFileName
!= NULL
&& OutUnicode
&& OutAppend
&& (!EFI_ERROR(ShellFileExists(StdOutFileName
)) && EFI_ERROR(IsUnicodeFile(StdOutFileName
))))
881 ||(StdErrFileName
!= NULL
&& ErrUnicode
&& ErrAppend
&& (!EFI_ERROR(ShellFileExists(StdErrFileName
)) && EFI_ERROR(IsUnicodeFile(StdErrFileName
))))
882 ||(StdOutFileName
!= NULL
&& !OutUnicode
&& OutAppend
&& (!EFI_ERROR(ShellFileExists(StdOutFileName
)) && !EFI_ERROR(IsUnicodeFile(StdOutFileName
))))
883 ||(StdErrFileName
!= NULL
&& !ErrUnicode
&& ErrAppend
&& (!EFI_ERROR(ShellFileExists(StdErrFileName
)) && !EFI_ERROR(IsUnicodeFile(StdErrFileName
))))
885 Status
= EFI_INVALID_PARAMETER
;
886 } else if (!EFI_ERROR(Status
)){
888 // Open the Std<Whatever> and we should not have conflicts here...
894 if (StdErrFileName
!= NULL
) {
897 // delete existing file.
899 ShellInfoObject
.NewEfiShellProtocol
->DeleteFileByName(StdErrFileName
);
901 Status
= ShellOpenFileByName(StdErrFileName
, &TempHandle
, EFI_FILE_MODE_WRITE
|EFI_FILE_MODE_READ
|EFI_FILE_MODE_CREATE
,0);
902 if (!ErrAppend
&& ErrUnicode
&& !EFI_ERROR(Status
)) {
904 // Write out the gUnicodeFileTag
906 Size
= sizeof(CHAR16
);
907 TagBuffer
[0] = gUnicodeFileTag
;
908 TagBuffer
[1] = CHAR_NULL
;
909 ShellInfoObject
.NewEfiShellProtocol
->WriteFile(TempHandle
, &Size
, TagBuffer
);
911 if (!ErrUnicode
&& !EFI_ERROR(Status
)) {
912 TempHandle
= CreateFileInterfaceFile(TempHandle
, FALSE
);
913 ASSERT(TempHandle
!= NULL
);
915 if (!EFI_ERROR(Status
)) {
916 ShellParameters
->StdErr
= TempHandle
;
917 gST
->StdErr
= CreateSimpleTextOutOnFile(TempHandle
, &gST
->StandardErrorHandle
);
924 if (!EFI_ERROR(Status
) && StdOutFileName
!= NULL
) {
927 // delete existing file.
929 ShellInfoObject
.NewEfiShellProtocol
->DeleteFileByName(StdOutFileName
);
931 Status
= ShellOpenFileByName(StdOutFileName
, &TempHandle
, EFI_FILE_MODE_WRITE
|EFI_FILE_MODE_READ
|EFI_FILE_MODE_CREATE
,0);
932 if (TempHandle
== NULL
) {
933 Status
= EFI_INVALID_PARAMETER
;
935 if (StrStr(StdOutFileName
, L
"NUL")==StdOutFileName
) {
937 } else if (!OutAppend
&& OutUnicode
&& !EFI_ERROR(Status
)) {
939 // Write out the gUnicodeFileTag
941 Size
= sizeof(CHAR16
);
942 TagBuffer
[0] = gUnicodeFileTag
;
943 TagBuffer
[1] = CHAR_NULL
;
944 ShellInfoObject
.NewEfiShellProtocol
->WriteFile(TempHandle
, &Size
, TagBuffer
);
945 } else if (OutAppend
) {
947 // Move to end of file
949 Status
= ShellInfoObject
.NewEfiShellProtocol
->GetFileSize(TempHandle
, &FileSize
);
950 if (!EFI_ERROR(Status
)) {
951 Status
= ShellInfoObject
.NewEfiShellProtocol
->SetFilePosition(TempHandle
, FileSize
);
954 if (!OutUnicode
&& !EFI_ERROR(Status
)) {
955 TempHandle
= CreateFileInterfaceFile(TempHandle
, FALSE
);
956 ASSERT(TempHandle
!= NULL
);
958 if (!EFI_ERROR(Status
)) {
959 ShellParameters
->StdOut
= TempHandle
;
960 gST
->ConOut
= CreateSimpleTextOutOnFile(TempHandle
, &gST
->ConsoleOutHandle
);
968 if (!EFI_ERROR(Status
) && StdOutVarName
!= NULL
) {
971 // delete existing variable.
973 SHELL_SET_ENVIRONMENT_VARIABLE_V(StdOutVarName
, 0, L
"");
975 TempHandle
= CreateFileInterfaceEnv(StdOutVarName
);
976 ASSERT(TempHandle
!= NULL
);
977 ShellParameters
->StdOut
= TempHandle
;
978 gST
->ConOut
= CreateSimpleTextOutOnFile(TempHandle
, &gST
->ConsoleOutHandle
);
984 if (!EFI_ERROR(Status
) && StdErrVarName
!= NULL
) {
987 // delete existing variable.
989 SHELL_SET_ENVIRONMENT_VARIABLE_V(StdErrVarName
, 0, L
"");
991 TempHandle
= CreateFileInterfaceEnv(StdErrVarName
);
992 ASSERT(TempHandle
!= NULL
);
993 ShellParameters
->StdErr
= TempHandle
;
994 gST
->StdErr
= CreateSimpleTextOutOnFile(TempHandle
, &gST
->StandardErrorHandle
);
1000 if (!EFI_ERROR(Status
) && StdInVarName
!= NULL
) {
1001 TempHandle
= CreateFileInterfaceEnv(StdInVarName
);
1003 TempHandle
= CreateFileInterfaceFile(TempHandle
, FALSE
);
1006 ASSERT(TempHandle
!= NULL
);
1007 if (((EFI_FILE_PROTOCOL
*)TempHandle
)->Read(TempHandle
, &Size
, NULL
) != EFI_BUFFER_TOO_SMALL
) {
1008 Status
= EFI_INVALID_PARAMETER
;
1010 ShellParameters
->StdIn
= TempHandle
;
1011 gST
->ConIn
= CreateSimpleTextInOnFile(TempHandle
, &gST
->ConsoleInHandle
);
1016 // StdIn from a file
1018 if (!EFI_ERROR(Status
) && StdInFileName
!= NULL
) {
1019 Status
= ShellOpenFileByName(
1024 if (!InUnicode
&& !EFI_ERROR(Status
)) {
1025 TempHandle
= CreateFileInterfaceFile(TempHandle
, FALSE
);
1027 if (!EFI_ERROR(Status
)) {
1028 ShellParameters
->StdIn
= TempHandle
;
1029 gST
->ConIn
= CreateSimpleTextInOnFile(TempHandle
, &gST
->ConsoleInHandle
);
1034 FreePool(CommandLineCopy
);
1036 if (gST
->ConIn
== NULL
||gST
->ConOut
== NULL
) {
1037 return (EFI_OUT_OF_RESOURCES
);
1043 Funcion will replace the current StdIn and StdOut in the ShellParameters protocol
1044 structure with StdIn and StdOut. The current values are de-allocated.
1046 @param[in,out] ShellParameters Pointer to parameter structure to modify.
1047 @param[in] OldStdIn Pointer to old StdIn.
1048 @param[in] OldStdOut Pointer to old StdOut.
1049 @param[in] OldStdErr Pointer to old StdErr.
1050 @param[in] SystemTableInfo Pointer to old system table information.
1054 RestoreStdInStdOutStdErr (
1055 IN OUT EFI_SHELL_PARAMETERS_PROTOCOL
*ShellParameters
,
1056 IN SHELL_FILE_HANDLE
*OldStdIn
,
1057 IN SHELL_FILE_HANDLE
*OldStdOut
,
1058 IN SHELL_FILE_HANDLE
*OldStdErr
,
1059 IN SYSTEM_TABLE_INFO
*SystemTableInfo
1064 if (ShellParameters
== NULL
1068 ||SystemTableInfo
== NULL
) {
1069 return (EFI_INVALID_PARAMETER
);
1071 if (!IsListEmpty(&ShellInfoObject
.SplitList
.Link
)) {
1072 Split
= (SPLIT_LIST
*)GetFirstNode(&ShellInfoObject
.SplitList
.Link
);
1076 if (ShellParameters
->StdIn
!= *OldStdIn
) {
1077 if ((Split
!= NULL
&& Split
->SplitStdIn
!= ShellParameters
->StdIn
) || Split
== NULL
) {
1078 gEfiShellProtocol
->CloseFile(ShellParameters
->StdIn
);
1080 ShellParameters
->StdIn
= *OldStdIn
;
1082 if (ShellParameters
->StdOut
!= *OldStdOut
) {
1083 if ((Split
!= NULL
&& Split
->SplitStdOut
!= ShellParameters
->StdOut
) || Split
== NULL
) {
1084 gEfiShellProtocol
->CloseFile(ShellParameters
->StdOut
);
1086 ShellParameters
->StdOut
= *OldStdOut
;
1088 if (ShellParameters
->StdErr
!= *OldStdErr
) {
1089 gEfiShellProtocol
->CloseFile(ShellParameters
->StdErr
);
1090 ShellParameters
->StdErr
= *OldStdErr
;
1093 if (gST
->ConIn
!= SystemTableInfo
->ConIn
) {
1094 CloseSimpleTextInOnFile(gST
->ConIn
);
1095 gST
->ConIn
= SystemTableInfo
->ConIn
;
1096 gST
->ConsoleInHandle
= SystemTableInfo
->ConInHandle
;
1098 if (gST
->ConOut
!= SystemTableInfo
->ConOut
) {
1099 CloseSimpleTextOutOnFile(gST
->ConOut
);
1100 gST
->ConOut
= SystemTableInfo
->ConOut
;
1101 gST
->ConsoleOutHandle
= SystemTableInfo
->ConOutHandle
;
1103 if (gST
->StdErr
!= SystemTableInfo
->ConErr
) {
1104 CloseSimpleTextOutOnFile(gST
->StdErr
);
1105 gST
->StdErr
= SystemTableInfo
->ConErr
;
1106 gST
->StandardErrorHandle
= SystemTableInfo
->ConErrHandle
;
1109 return (EFI_SUCCESS
);
1112 Funcion will replace the current Argc and Argv in the ShellParameters protocol
1113 structure by parsing NewCommandLine. The current values are returned to the
1116 If OldArgv or OldArgc is NULL then that value is not returned.
1118 @param[in,out] ShellParameters Pointer to parameter structure to modify.
1119 @param[in] NewCommandLine The new command line to parse and use.
1120 @param[out] OldArgv Pointer to old list of parameters.
1121 @param[out] OldArgc Pointer to old number of items in Argv list.
1123 @retval EFI_SUCCESS Operation was sucessful, Argv and Argc are valid.
1124 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
1129 IN OUT EFI_SHELL_PARAMETERS_PROTOCOL
*ShellParameters
,
1130 IN CONST CHAR16
*NewCommandLine
,
1131 OUT CHAR16
***OldArgv OPTIONAL
,
1132 OUT UINTN
*OldArgc OPTIONAL
1135 ASSERT(ShellParameters
!= NULL
);
1137 if (OldArgc
!= NULL
) {
1138 *OldArgc
= ShellParameters
->Argc
;
1140 if (OldArgc
!= NULL
) {
1141 *OldArgv
= ShellParameters
->Argv
;
1144 return (ParseCommandLineToArgs(NewCommandLine
, &(ShellParameters
->Argv
), &(ShellParameters
->Argc
)));
1148 Funcion will replace the current Argc and Argv in the ShellParameters protocol
1149 structure with Argv and Argc. The current values are de-allocated and the
1150 OldArgv must not be deallocated by the caller.
1152 @param[in,out] ShellParameters pointer to parameter structure to modify
1153 @param[in] OldArgv pointer to old list of parameters
1154 @param[in] OldArgc pointer to old number of items in Argv list
1159 IN OUT EFI_SHELL_PARAMETERS_PROTOCOL
*ShellParameters
,
1160 IN CHAR16
***OldArgv
,
1165 ASSERT(ShellParameters
!= NULL
);
1166 ASSERT(OldArgv
!= NULL
);
1167 ASSERT(OldArgc
!= NULL
);
1169 if (ShellParameters
->Argv
!= NULL
) {
1170 for ( LoopCounter
= 0
1171 ; LoopCounter
< ShellParameters
->Argc
1174 FreePool(ShellParameters
->Argv
[LoopCounter
]);
1176 FreePool(ShellParameters
->Argv
);
1178 ShellParameters
->Argv
= *OldArgv
;
1180 ShellParameters
->Argc
= *OldArgc
;