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
);
419 Determin if a file name represents a unicode file.
421 @param[in] FileName Pointer to the filename to open.
423 @retval EFI_SUCCESS The file is a unicode file.
424 @return An error upon failure.
429 IN CONST CHAR16
*FileName
432 SHELL_FILE_HANDLE Handle
;
434 UINT64 OriginalFilePosition
;
438 Status
= gEfiShellProtocol
->OpenFileByName(FileName
, &Handle
, EFI_FILE_MODE_READ
);
439 if (EFI_ERROR(Status
)) {
442 gEfiShellProtocol
->GetFilePosition(Handle
, &OriginalFilePosition
);
443 gEfiShellProtocol
->SetFilePosition(Handle
, 0);
444 CharSize
= sizeof(CHAR16
);
445 Status
= gEfiShellProtocol
->ReadFile(Handle
, &CharSize
, &CharBuffer
);
446 if (EFI_ERROR(Status
) || CharBuffer
!= gUnicodeFileTag
) {
447 Status
= EFI_BUFFER_TOO_SMALL
;
449 gEfiShellProtocol
->SetFilePosition(Handle
, OriginalFilePosition
);
450 gEfiShellProtocol
->CloseFile(Handle
);
455 Strips out quotes sections of a string.
457 All of the characters between quotes is replaced with spaces.
459 @param[in,out] TheString A pointer to the string to update.
464 IN OUT CHAR16
*TheString
469 for (RemoveNow
= FALSE
; TheString
!= NULL
&& *TheString
!= CHAR_NULL
; TheString
++) {
470 if (*TheString
== L
'^' && *(TheString
+ 1) == L
'\"') {
472 } else if (*TheString
== L
'\"') {
473 RemoveNow
= (BOOLEAN
)!RemoveNow
;
474 } else if (RemoveNow
) {
481 Funcion will replace the current StdIn and StdOut in the ShellParameters protocol
482 structure by parsing NewCommandLine. The current values are returned to the
485 This will also update the system table.
487 @param[in,out] ShellParameters Pointer to parameter structure to modify.
488 @param[in] NewCommandLine The new command line to parse and use.
489 @param[out] OldStdIn Pointer to old StdIn.
490 @param[out] OldStdOut Pointer to old StdOut.
491 @param[out] OldStdErr Pointer to old StdErr.
492 @param[out] SystemTableInfo Pointer to old system table information.
494 @retval EFI_SUCCESS Operation was sucessful, Argv and Argc are valid.
495 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
499 UpdateStdInStdOutStdErr(
500 IN OUT EFI_SHELL_PARAMETERS_PROTOCOL
*ShellParameters
,
501 IN CHAR16
*NewCommandLine
,
502 OUT SHELL_FILE_HANDLE
*OldStdIn
,
503 OUT SHELL_FILE_HANDLE
*OldStdOut
,
504 OUT SHELL_FILE_HANDLE
*OldStdErr
,
505 OUT SYSTEM_TABLE_INFO
*SystemTableInfo
508 CHAR16
*CommandLineCopy
;
509 CHAR16
*CommandLineWalker
;
510 CHAR16
*StdErrFileName
;
511 CHAR16
*StdOutFileName
;
512 CHAR16
*StdInFileName
;
513 CHAR16
*StdInVarName
;
514 CHAR16
*StdOutVarName
;
515 CHAR16
*StdErrVarName
;
517 SHELL_FILE_HANDLE TempHandle
;
527 CHAR16
*FirstLocation
;
533 StdOutVarName
= NULL
;
534 StdErrVarName
= NULL
;
535 StdErrFileName
= NULL
;
536 StdInFileName
= NULL
;
537 StdOutFileName
= NULL
;
540 CommandLineCopy
= NULL
;
541 FirstLocation
= NULL
;
543 if (ShellParameters
== NULL
|| SystemTableInfo
== NULL
|| OldStdIn
== NULL
|| OldStdOut
== NULL
|| OldStdErr
== NULL
) {
544 return (EFI_INVALID_PARAMETER
);
547 SystemTableInfo
->ConIn
= gST
->ConIn
;
548 SystemTableInfo
->ConInHandle
= gST
->ConsoleInHandle
;
549 SystemTableInfo
->ConOut
= gST
->ConOut
;
550 SystemTableInfo
->ConOutHandle
= gST
->ConsoleOutHandle
;
551 SystemTableInfo
->ConErr
= gST
->StdErr
;
552 SystemTableInfo
->ConErrHandle
= gST
->StandardErrorHandle
;
553 *OldStdIn
= ShellParameters
->StdIn
;
554 *OldStdOut
= ShellParameters
->StdOut
;
555 *OldStdErr
= ShellParameters
->StdErr
;
557 if (NewCommandLine
== NULL
) {
558 return (EFI_SUCCESS
);
561 CommandLineCopy
= StrnCatGrow(&CommandLineCopy
, NULL
, NewCommandLine
, 0);
562 Status
= EFI_SUCCESS
;
564 FirstLocation
= CommandLineCopy
+ StrLen(CommandLineCopy
);
566 StripQuotes(CommandLineCopy
);
568 if (!IsListEmpty(&ShellInfoObject
.SplitList
.Link
)) {
569 Split
= (SPLIT_LIST
*)GetFirstNode(&ShellInfoObject
.SplitList
.Link
);
570 if (Split
!= NULL
&& Split
->SplitStdIn
!= NULL
) {
571 ShellParameters
->StdIn
= Split
->SplitStdIn
;
573 if (Split
!= NULL
&& Split
->SplitStdOut
!= NULL
) {
574 ShellParameters
->StdOut
= Split
->SplitStdOut
;
578 if (!EFI_ERROR(Status
) && (CommandLineWalker
= StrStr(CommandLineCopy
, L
" 2>>v ")) != NULL
) {
579 FirstLocation
= MIN(CommandLineWalker
, FirstLocation
);
580 SetMem16(CommandLineWalker
, 12, L
' ');
581 StdErrVarName
= CommandLineWalker
+= 6;
583 if (StrStr(CommandLineWalker
, L
" 2>>v ") != NULL
) {
584 Status
= EFI_NOT_FOUND
;
587 if (!EFI_ERROR(Status
) && (CommandLineWalker
= StrStr(CommandLineCopy
, L
" 1>>v ")) != NULL
) {
588 FirstLocation
= MIN(CommandLineWalker
, FirstLocation
);
589 SetMem16(CommandLineWalker
, 12, L
' ');
590 StdOutVarName
= CommandLineWalker
+= 6;
592 if (StrStr(CommandLineWalker
, L
" 1>>v ") != NULL
) {
593 Status
= EFI_NOT_FOUND
;
595 } else if (!EFI_ERROR(Status
) && (CommandLineWalker
= StrStr(CommandLineCopy
, L
" >>v ")) != NULL
) {
596 FirstLocation
= MIN(CommandLineWalker
, FirstLocation
);
597 SetMem16(CommandLineWalker
, 10, L
' ');
598 StdOutVarName
= CommandLineWalker
+= 5;
600 if (StrStr(CommandLineWalker
, L
" >>v ") != NULL
) {
601 Status
= EFI_NOT_FOUND
;
603 } else if (!EFI_ERROR(Status
) && (CommandLineWalker
= StrStr(CommandLineCopy
, L
" >v ")) != NULL
) {
604 FirstLocation
= MIN(CommandLineWalker
, FirstLocation
);
605 SetMem16(CommandLineWalker
, 8, L
' ');
606 StdOutVarName
= CommandLineWalker
+= 4;
608 if (StrStr(CommandLineWalker
, L
" >v ") != NULL
) {
609 Status
= EFI_NOT_FOUND
;
612 if (!EFI_ERROR(Status
) && (CommandLineWalker
= StrStr(CommandLineCopy
, L
" 1>>a ")) != NULL
) {
613 FirstLocation
= MIN(CommandLineWalker
, FirstLocation
);
614 SetMem16(CommandLineWalker
, 12, L
' ');
615 StdOutFileName
= CommandLineWalker
+= 6;
618 if (StrStr(CommandLineWalker
, L
" 1>>a ") != NULL
) {
619 Status
= EFI_NOT_FOUND
;
622 if (!EFI_ERROR(Status
) && (CommandLineWalker
= StrStr(CommandLineCopy
, L
" 1>> ")) != NULL
) {
623 FirstLocation
= MIN(CommandLineWalker
, FirstLocation
);
624 SetMem16(CommandLineWalker
, 10, L
' ');
625 if (StdOutFileName
!= NULL
) {
626 Status
= EFI_INVALID_PARAMETER
;
628 StdOutFileName
= CommandLineWalker
+= 5;
631 if (StrStr(CommandLineWalker
, L
" 1>> ") != NULL
) {
632 Status
= EFI_NOT_FOUND
;
635 if (!EFI_ERROR(Status
) && (CommandLineWalker
= StrStr(CommandLineCopy
, L
" >> ")) != NULL
) {
636 FirstLocation
= MIN(CommandLineWalker
, FirstLocation
);
637 SetMem16(CommandLineWalker
, 8, L
' ');
638 if (StdOutFileName
!= NULL
) {
639 Status
= EFI_INVALID_PARAMETER
;
641 StdOutFileName
= CommandLineWalker
+= 4;
644 if (StrStr(CommandLineWalker
, L
" >> ") != NULL
) {
645 Status
= EFI_NOT_FOUND
;
648 if (!EFI_ERROR(Status
) && (CommandLineWalker
= StrStr(CommandLineCopy
, L
" >>a ")) != NULL
) {
649 FirstLocation
= MIN(CommandLineWalker
, FirstLocation
);
650 SetMem16(CommandLineWalker
, 10, L
' ');
651 if (StdOutFileName
!= NULL
) {
652 Status
= EFI_INVALID_PARAMETER
;
654 StdOutFileName
= CommandLineWalker
+= 5;
658 if (StrStr(CommandLineWalker
, L
" >>a ") != NULL
) {
659 Status
= EFI_NOT_FOUND
;
662 if (!EFI_ERROR(Status
) && (CommandLineWalker
= StrStr(CommandLineCopy
, L
" 1>a ")) != NULL
) {
663 FirstLocation
= MIN(CommandLineWalker
, FirstLocation
);
664 SetMem16(CommandLineWalker
, 10, L
' ');
665 if (StdOutFileName
!= NULL
) {
666 Status
= EFI_INVALID_PARAMETER
;
668 StdOutFileName
= CommandLineWalker
+= 5;
672 if (StrStr(CommandLineWalker
, L
" 1>a ") != NULL
) {
673 Status
= EFI_NOT_FOUND
;
676 if (!EFI_ERROR(Status
) && (CommandLineWalker
= StrStr(CommandLineCopy
, L
" >a ")) != NULL
) {
677 FirstLocation
= MIN(CommandLineWalker
, FirstLocation
);
678 SetMem16(CommandLineWalker
, 8, L
' ');
679 if (StdOutFileName
!= NULL
) {
680 Status
= EFI_INVALID_PARAMETER
;
682 StdOutFileName
= CommandLineWalker
+= 4;
686 if (StrStr(CommandLineWalker
, L
" >a ") != NULL
) {
687 Status
= EFI_NOT_FOUND
;
690 if (!EFI_ERROR(Status
) && (CommandLineWalker
= StrStr(CommandLineCopy
, L
" 2>> ")) != NULL
) {
691 FirstLocation
= MIN(CommandLineWalker
, FirstLocation
);
692 SetMem16(CommandLineWalker
, 10, L
' ');
693 if (StdErrFileName
!= NULL
) {
694 Status
= EFI_INVALID_PARAMETER
;
696 StdErrFileName
= CommandLineWalker
+= 5;
699 if (StrStr(CommandLineWalker
, L
" 2>> ") != NULL
) {
700 Status
= EFI_NOT_FOUND
;
704 if (!EFI_ERROR(Status
) && (CommandLineWalker
= StrStr(CommandLineCopy
, L
" 2>v ")) != NULL
) {
705 FirstLocation
= MIN(CommandLineWalker
, FirstLocation
);
706 SetMem16(CommandLineWalker
, 10, L
' ');
707 if (StdErrVarName
!= NULL
) {
708 Status
= EFI_INVALID_PARAMETER
;
710 StdErrVarName
= CommandLineWalker
+= 5;
713 if (StrStr(CommandLineWalker
, L
" 2>v ") != NULL
) {
714 Status
= EFI_NOT_FOUND
;
717 if (!EFI_ERROR(Status
) && (CommandLineWalker
= StrStr(CommandLineCopy
, L
" 1>v ")) != NULL
) {
718 FirstLocation
= MIN(CommandLineWalker
, FirstLocation
);
719 SetMem16(CommandLineWalker
, 10, L
' ');
720 if (StdOutVarName
!= NULL
) {
721 Status
= EFI_INVALID_PARAMETER
;
723 StdOutVarName
= CommandLineWalker
+= 5;
726 if (StrStr(CommandLineWalker
, L
" 1>v ") != NULL
) {
727 Status
= EFI_NOT_FOUND
;
730 if (!EFI_ERROR(Status
) && (CommandLineWalker
= StrStr(CommandLineCopy
, L
" 2>a ")) != NULL
) {
731 FirstLocation
= MIN(CommandLineWalker
, FirstLocation
);
732 SetMem16(CommandLineWalker
, 10, L
' ');
733 if (StdErrFileName
!= NULL
) {
734 Status
= EFI_INVALID_PARAMETER
;
736 StdErrFileName
= CommandLineWalker
+= 5;
740 if (StrStr(CommandLineWalker
, L
" 2>a ") != NULL
) {
741 Status
= EFI_NOT_FOUND
;
744 if (!EFI_ERROR(Status
) && (CommandLineWalker
= StrStr(CommandLineCopy
, L
" 2> ")) != NULL
) {
745 FirstLocation
= MIN(CommandLineWalker
, FirstLocation
);
746 SetMem16(CommandLineWalker
, 8, L
' ');
747 if (StdErrFileName
!= NULL
) {
748 Status
= EFI_INVALID_PARAMETER
;
750 StdErrFileName
= CommandLineWalker
+= 4;
753 if (StrStr(CommandLineWalker
, L
" 2> ") != NULL
) {
754 Status
= EFI_NOT_FOUND
;
758 if (!EFI_ERROR(Status
) && (CommandLineWalker
= StrStr(CommandLineCopy
, L
" 1> ")) != NULL
) {
759 FirstLocation
= MIN(CommandLineWalker
, FirstLocation
);
760 SetMem16(CommandLineWalker
, 8, L
' ');
761 if (StdOutFileName
!= NULL
) {
762 Status
= EFI_INVALID_PARAMETER
;
764 StdOutFileName
= CommandLineWalker
+= 4;
767 if (StrStr(CommandLineWalker
, L
" 1> ") != NULL
) {
768 Status
= EFI_NOT_FOUND
;
772 if (!EFI_ERROR(Status
) && (CommandLineWalker
= StrStr(CommandLineCopy
, L
" > ")) != NULL
) {
773 FirstLocation
= MIN(CommandLineWalker
, FirstLocation
);
774 SetMem16(CommandLineWalker
, 6, L
' ');
775 if (StdOutFileName
!= NULL
) {
776 Status
= EFI_INVALID_PARAMETER
;
778 StdOutFileName
= CommandLineWalker
+= 3;
781 if (StrStr(CommandLineWalker
, L
" > ") != NULL
) {
782 Status
= EFI_NOT_FOUND
;
786 if (!EFI_ERROR(Status
) && (CommandLineWalker
= StrStr(CommandLineCopy
, L
" < ")) != NULL
) {
787 FirstLocation
= MIN(CommandLineWalker
, FirstLocation
);
788 SetMem16(CommandLineWalker
, 6, L
' ');
789 if (StdInFileName
!= NULL
) {
790 Status
= EFI_INVALID_PARAMETER
;
792 StdInFileName
= CommandLineWalker
+= 3;
794 if (StrStr(CommandLineWalker
, L
" < ") != NULL
) {
795 Status
= EFI_NOT_FOUND
;
798 if (!EFI_ERROR(Status
) && (CommandLineWalker
= StrStr(CommandLineCopy
, L
" <a ")) != NULL
) {
799 FirstLocation
= MIN(CommandLineWalker
, FirstLocation
);
800 SetMem16(CommandLineWalker
, 8, L
' ');
801 if (StdInFileName
!= NULL
) {
802 Status
= EFI_INVALID_PARAMETER
;
804 StdInFileName
= CommandLineWalker
+= 4;
807 if (StrStr(CommandLineWalker
, L
" <a ") != NULL
) {
808 Status
= EFI_NOT_FOUND
;
811 if (!EFI_ERROR(Status
) && (CommandLineWalker
= StrStr(CommandLineCopy
, L
" <v ")) != NULL
) {
812 FirstLocation
= MIN(CommandLineWalker
, FirstLocation
);
813 SetMem16(CommandLineWalker
, 8, L
' ');
814 if (StdInVarName
!= NULL
) {
815 Status
= EFI_INVALID_PARAMETER
;
817 StdInVarName
= CommandLineWalker
+= 4;
819 if (StrStr(CommandLineWalker
, L
" <v ") != NULL
) {
820 Status
= EFI_NOT_FOUND
;
824 if (FirstLocation
!= CommandLineCopy
+ StrLen(CommandLineCopy
)
825 && ((UINTN
)(FirstLocation
- CommandLineCopy
) < StrLen(NewCommandLine
))
827 *(NewCommandLine
+ (UINTN
)(FirstLocation
- CommandLineCopy
)) = CHAR_NULL
;
830 if (!EFI_ERROR(Status
)) {
831 if (StdErrFileName
!= NULL
&& (CommandLineWalker
= StrStr(StdErrFileName
, L
" ")) != NULL
) {
832 CommandLineWalker
[0] = CHAR_NULL
;
834 if (StdOutFileName
!= NULL
&& (CommandLineWalker
= StrStr(StdOutFileName
, L
" ")) != NULL
) {
835 CommandLineWalker
[0] = CHAR_NULL
;
837 if (StdInFileName
!= NULL
&& (CommandLineWalker
= StrStr(StdInFileName
, L
" ")) != NULL
) {
838 CommandLineWalker
[0] = CHAR_NULL
;
840 if (StdErrVarName
!= NULL
&& (CommandLineWalker
= StrStr(StdErrVarName
, L
" ")) != NULL
) {
841 CommandLineWalker
[0] = CHAR_NULL
;
843 if (StdOutVarName
!= NULL
&& (CommandLineWalker
= StrStr(StdOutVarName
, L
" ")) != NULL
) {
844 CommandLineWalker
[0] = CHAR_NULL
;
846 if (StdInVarName
!= NULL
&& (CommandLineWalker
= StrStr(StdInVarName
, L
" ")) != NULL
) {
847 CommandLineWalker
[0] = CHAR_NULL
;
851 // Verify not the same and not duplicating something from a split
855 // Check that no 2 filenames are the same
857 (StdErrFileName
!= NULL
&& StdOutFileName
!= NULL
&& StringNoCaseCompare(&StdErrFileName
, &StdOutFileName
) == 0)
858 ||(StdErrFileName
!= NULL
&& StdInFileName
!= NULL
&& StringNoCaseCompare(&StdErrFileName
, &StdInFileName
) == 0)
859 ||(StdOutFileName
!= NULL
&& StdInFileName
!= NULL
&& StringNoCaseCompare(&StdOutFileName
, &StdInFileName
) == 0)
861 // Check that no 2 variable names are the same
863 ||(StdErrVarName
!= NULL
&& StdInVarName
!= NULL
&& StringNoCaseCompare(&StdErrVarName
, &StdInVarName
) == 0)
864 ||(StdOutVarName
!= NULL
&& StdInVarName
!= NULL
&& StringNoCaseCompare(&StdOutVarName
, &StdInVarName
) == 0)
865 ||(StdErrVarName
!= NULL
&& StdOutVarName
!= NULL
&& StringNoCaseCompare(&StdErrVarName
, &StdOutVarName
) == 0)
867 // When a split (using | operator) is in place some are not allowed
869 ||(Split
!= NULL
&& Split
->SplitStdIn
!= NULL
&& (StdInVarName
!= NULL
|| StdInFileName
!= NULL
))
870 ||(Split
!= NULL
&& Split
->SplitStdOut
!= NULL
&& (StdOutVarName
!= NULL
|| StdOutFileName
!= NULL
))
872 // Check that nothing is trying to be output to 2 locations.
874 ||(StdErrFileName
!= NULL
&& StdErrVarName
!= NULL
)
875 ||(StdOutFileName
!= NULL
&& StdOutVarName
!= NULL
)
876 ||(StdInFileName
!= NULL
&& StdInVarName
!= NULL
)
878 // Check for no volatile environment variables
880 ||(StdErrVarName
!= NULL
&& !IsVolatileEnv(StdErrVarName
))
881 ||(StdOutVarName
!= NULL
&& !IsVolatileEnv(StdOutVarName
))
883 // Cant redirect during a reconnect operation.
885 ||(StrStr(NewCommandLine
, L
"connect -r") != NULL
886 && (StdOutVarName
!= NULL
|| StdOutFileName
!= NULL
|| StdErrFileName
!= NULL
|| StdErrVarName
!= NULL
))
888 // Check that filetypes (Unicode/Ascii) do not change during an append
890 ||(StdOutFileName
!= NULL
&& OutUnicode
&& OutAppend
&& (!EFI_ERROR(ShellFileExists(StdOutFileName
)) && EFI_ERROR(IsUnicodeFile(StdOutFileName
))))
891 ||(StdErrFileName
!= NULL
&& ErrUnicode
&& ErrAppend
&& (!EFI_ERROR(ShellFileExists(StdErrFileName
)) && EFI_ERROR(IsUnicodeFile(StdErrFileName
))))
892 ||(StdOutFileName
!= NULL
&& !OutUnicode
&& OutAppend
&& (!EFI_ERROR(ShellFileExists(StdOutFileName
)) && !EFI_ERROR(IsUnicodeFile(StdOutFileName
))))
893 ||(StdErrFileName
!= NULL
&& !ErrUnicode
&& ErrAppend
&& (!EFI_ERROR(ShellFileExists(StdErrFileName
)) && !EFI_ERROR(IsUnicodeFile(StdErrFileName
))))
895 Status
= EFI_INVALID_PARAMETER
;
896 } else if (!EFI_ERROR(Status
)){
898 // Open the Std<Whatever> and we should not have conflicts here...
904 if (StdErrFileName
!= NULL
) {
907 // delete existing file.
909 ShellInfoObject
.NewEfiShellProtocol
->DeleteFileByName(StdErrFileName
);
911 Status
= ShellOpenFileByName(StdErrFileName
, &TempHandle
, EFI_FILE_MODE_WRITE
|EFI_FILE_MODE_READ
|EFI_FILE_MODE_CREATE
,0);
912 if (!ErrAppend
&& ErrUnicode
&& !EFI_ERROR(Status
)) {
914 // Write out the gUnicodeFileTag
916 Size
= sizeof(CHAR16
);
917 TagBuffer
[0] = gUnicodeFileTag
;
918 TagBuffer
[1] = CHAR_NULL
;
919 ShellInfoObject
.NewEfiShellProtocol
->WriteFile(TempHandle
, &Size
, TagBuffer
);
921 if (!ErrUnicode
&& !EFI_ERROR(Status
)) {
922 TempHandle
= CreateFileInterfaceFile(TempHandle
, FALSE
);
923 ASSERT(TempHandle
!= NULL
);
925 if (!EFI_ERROR(Status
)) {
926 ShellParameters
->StdErr
= TempHandle
;
927 gST
->StdErr
= CreateSimpleTextOutOnFile(TempHandle
, &gST
->StandardErrorHandle
);
934 if (!EFI_ERROR(Status
) && StdOutFileName
!= NULL
) {
937 // delete existing file.
939 ShellInfoObject
.NewEfiShellProtocol
->DeleteFileByName(StdOutFileName
);
941 Status
= ShellOpenFileByName(StdOutFileName
, &TempHandle
, EFI_FILE_MODE_WRITE
|EFI_FILE_MODE_READ
|EFI_FILE_MODE_CREATE
,0);
942 if (TempHandle
== NULL
) {
943 Status
= EFI_INVALID_PARAMETER
;
945 if (StrStr(StdOutFileName
, L
"NUL")==StdOutFileName
) {
947 } else if (!OutAppend
&& OutUnicode
&& !EFI_ERROR(Status
)) {
949 // Write out the gUnicodeFileTag
951 Size
= sizeof(CHAR16
);
952 TagBuffer
[0] = gUnicodeFileTag
;
953 TagBuffer
[1] = CHAR_NULL
;
954 ShellInfoObject
.NewEfiShellProtocol
->WriteFile(TempHandle
, &Size
, TagBuffer
);
955 } else if (OutAppend
) {
957 // Move to end of file
959 Status
= ShellInfoObject
.NewEfiShellProtocol
->GetFileSize(TempHandle
, &FileSize
);
960 if (!EFI_ERROR(Status
)) {
961 Status
= ShellInfoObject
.NewEfiShellProtocol
->SetFilePosition(TempHandle
, FileSize
);
964 if (!OutUnicode
&& !EFI_ERROR(Status
)) {
965 TempHandle
= CreateFileInterfaceFile(TempHandle
, FALSE
);
966 ASSERT(TempHandle
!= NULL
);
968 if (!EFI_ERROR(Status
)) {
969 ShellParameters
->StdOut
= TempHandle
;
970 gST
->ConOut
= CreateSimpleTextOutOnFile(TempHandle
, &gST
->ConsoleOutHandle
);
978 if (!EFI_ERROR(Status
) && StdOutVarName
!= NULL
) {
981 // delete existing variable.
983 SHELL_SET_ENVIRONMENT_VARIABLE_V(StdOutVarName
, 0, L
"");
985 TempHandle
= CreateFileInterfaceEnv(StdOutVarName
);
986 ASSERT(TempHandle
!= NULL
);
987 ShellParameters
->StdOut
= TempHandle
;
988 gST
->ConOut
= CreateSimpleTextOutOnFile(TempHandle
, &gST
->ConsoleOutHandle
);
994 if (!EFI_ERROR(Status
) && StdErrVarName
!= NULL
) {
997 // delete existing variable.
999 SHELL_SET_ENVIRONMENT_VARIABLE_V(StdErrVarName
, 0, L
"");
1001 TempHandle
= CreateFileInterfaceEnv(StdErrVarName
);
1002 ASSERT(TempHandle
!= NULL
);
1003 ShellParameters
->StdErr
= TempHandle
;
1004 gST
->StdErr
= CreateSimpleTextOutOnFile(TempHandle
, &gST
->StandardErrorHandle
);
1010 if (!EFI_ERROR(Status
) && StdInVarName
!= NULL
) {
1011 TempHandle
= CreateFileInterfaceEnv(StdInVarName
);
1013 TempHandle
= CreateFileInterfaceFile(TempHandle
, FALSE
);
1016 ASSERT(TempHandle
!= NULL
);
1017 if (((EFI_FILE_PROTOCOL
*)TempHandle
)->Read(TempHandle
, &Size
, NULL
) != EFI_BUFFER_TOO_SMALL
) {
1018 Status
= EFI_INVALID_PARAMETER
;
1020 ShellParameters
->StdIn
= TempHandle
;
1021 gST
->ConIn
= CreateSimpleTextInOnFile(TempHandle
, &gST
->ConsoleInHandle
);
1026 // StdIn from a file
1028 if (!EFI_ERROR(Status
) && StdInFileName
!= NULL
) {
1029 Status
= ShellOpenFileByName(
1034 if (!InUnicode
&& !EFI_ERROR(Status
)) {
1035 TempHandle
= CreateFileInterfaceFile(TempHandle
, FALSE
);
1037 if (!EFI_ERROR(Status
)) {
1038 ShellParameters
->StdIn
= TempHandle
;
1039 gST
->ConIn
= CreateSimpleTextInOnFile(TempHandle
, &gST
->ConsoleInHandle
);
1044 FreePool(CommandLineCopy
);
1046 if (gST
->ConIn
== NULL
||gST
->ConOut
== NULL
) {
1047 return (EFI_OUT_OF_RESOURCES
);
1053 Funcion will replace the current StdIn and StdOut in the ShellParameters protocol
1054 structure with StdIn and StdOut. The current values are de-allocated.
1056 @param[in,out] ShellParameters Pointer to parameter structure to modify.
1057 @param[in] OldStdIn Pointer to old StdIn.
1058 @param[in] OldStdOut Pointer to old StdOut.
1059 @param[in] OldStdErr Pointer to old StdErr.
1060 @param[in] SystemTableInfo Pointer to old system table information.
1064 RestoreStdInStdOutStdErr (
1065 IN OUT EFI_SHELL_PARAMETERS_PROTOCOL
*ShellParameters
,
1066 IN SHELL_FILE_HANDLE
*OldStdIn
,
1067 IN SHELL_FILE_HANDLE
*OldStdOut
,
1068 IN SHELL_FILE_HANDLE
*OldStdErr
,
1069 IN SYSTEM_TABLE_INFO
*SystemTableInfo
1074 if (ShellParameters
== NULL
1078 ||SystemTableInfo
== NULL
) {
1079 return (EFI_INVALID_PARAMETER
);
1081 if (!IsListEmpty(&ShellInfoObject
.SplitList
.Link
)) {
1082 Split
= (SPLIT_LIST
*)GetFirstNode(&ShellInfoObject
.SplitList
.Link
);
1086 if (ShellParameters
->StdIn
!= *OldStdIn
) {
1087 if ((Split
!= NULL
&& Split
->SplitStdIn
!= ShellParameters
->StdIn
) || Split
== NULL
) {
1088 gEfiShellProtocol
->CloseFile(ShellParameters
->StdIn
);
1090 ShellParameters
->StdIn
= *OldStdIn
;
1092 if (ShellParameters
->StdOut
!= *OldStdOut
) {
1093 if ((Split
!= NULL
&& Split
->SplitStdOut
!= ShellParameters
->StdOut
) || Split
== NULL
) {
1094 gEfiShellProtocol
->CloseFile(ShellParameters
->StdOut
);
1096 ShellParameters
->StdOut
= *OldStdOut
;
1098 if (ShellParameters
->StdErr
!= *OldStdErr
) {
1099 gEfiShellProtocol
->CloseFile(ShellParameters
->StdErr
);
1100 ShellParameters
->StdErr
= *OldStdErr
;
1103 if (gST
->ConIn
!= SystemTableInfo
->ConIn
) {
1104 CloseSimpleTextInOnFile(gST
->ConIn
);
1105 gST
->ConIn
= SystemTableInfo
->ConIn
;
1106 gST
->ConsoleInHandle
= SystemTableInfo
->ConInHandle
;
1108 if (gST
->ConOut
!= SystemTableInfo
->ConOut
) {
1109 CloseSimpleTextOutOnFile(gST
->ConOut
);
1110 gST
->ConOut
= SystemTableInfo
->ConOut
;
1111 gST
->ConsoleOutHandle
= SystemTableInfo
->ConOutHandle
;
1113 if (gST
->StdErr
!= SystemTableInfo
->ConErr
) {
1114 CloseSimpleTextOutOnFile(gST
->StdErr
);
1115 gST
->StdErr
= SystemTableInfo
->ConErr
;
1116 gST
->StandardErrorHandle
= SystemTableInfo
->ConErrHandle
;
1119 return (EFI_SUCCESS
);
1122 Funcion will replace the current Argc and Argv in the ShellParameters protocol
1123 structure by parsing NewCommandLine. The current values are returned to the
1126 If OldArgv or OldArgc is NULL then that value is not returned.
1128 @param[in,out] ShellParameters Pointer to parameter structure to modify.
1129 @param[in] NewCommandLine The new command line to parse and use.
1130 @param[out] OldArgv Pointer to old list of parameters.
1131 @param[out] OldArgc Pointer to old number of items in Argv list.
1133 @retval EFI_SUCCESS Operation was sucessful, Argv and Argc are valid.
1134 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
1139 IN OUT EFI_SHELL_PARAMETERS_PROTOCOL
*ShellParameters
,
1140 IN CONST CHAR16
*NewCommandLine
,
1141 OUT CHAR16
***OldArgv OPTIONAL
,
1142 OUT UINTN
*OldArgc OPTIONAL
1145 ASSERT(ShellParameters
!= NULL
);
1147 if (OldArgc
!= NULL
) {
1148 *OldArgc
= ShellParameters
->Argc
;
1150 if (OldArgc
!= NULL
) {
1151 *OldArgv
= ShellParameters
->Argv
;
1154 return (ParseCommandLineToArgs(NewCommandLine
, &(ShellParameters
->Argv
), &(ShellParameters
->Argc
)));
1158 Funcion will replace the current Argc and Argv in the ShellParameters protocol
1159 structure with Argv and Argc. The current values are de-allocated and the
1160 OldArgv must not be deallocated by the caller.
1162 @param[in,out] ShellParameters pointer to parameter structure to modify
1163 @param[in] OldArgv pointer to old list of parameters
1164 @param[in] OldArgc pointer to old number of items in Argv list
1169 IN OUT EFI_SHELL_PARAMETERS_PROTOCOL
*ShellParameters
,
1170 IN CHAR16
***OldArgv
,
1175 ASSERT(ShellParameters
!= NULL
);
1176 ASSERT(OldArgv
!= NULL
);
1177 ASSERT(OldArgc
!= NULL
);
1179 if (ShellParameters
->Argv
!= NULL
) {
1180 for ( LoopCounter
= 0
1181 ; LoopCounter
< ShellParameters
->Argc
1184 FreePool(ShellParameters
->Argv
[LoopCounter
]);
1186 FreePool(ShellParameters
->Argv
);
1188 ShellParameters
->Argv
= *OldArgv
;
1190 ShellParameters
->Argc
= *OldArgc
;