2 This is THE shell (application)
4 Copyright (c) 2009 - 2015, Intel Corporation. All rights reserved.<BR>
5 (C) Copyright 2013-2014 Hewlett-Packard Development Company, L.P.<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.
19 // Initialize the global structure
21 SHELL_INFO ShellInfoObject
= {
56 {{NULL
, NULL
}, NULL
, NULL
},
57 {{NULL
, NULL
}, NULL
, NULL
},
69 STATIC CONST CHAR16 mScriptExtension
[] = L
".NSH";
70 STATIC CONST CHAR16 mExecutableExtensions
[] = L
".NSH;.EFI";
71 STATIC CONST CHAR16 mStartupScript
[] = L
"startup.nsh";
74 Cleans off leading and trailing spaces and tabs.
76 @param[in] String pointer to the string to trim them off.
84 ASSERT(String
!= NULL
);
85 ASSERT(*String
!= NULL
);
87 // Remove any spaces and tabs at the beginning of the (*String).
89 while (((*String
)[0] == L
' ') || ((*String
)[0] == L
'\t')) {
90 CopyMem((*String
), (*String
)+1, StrSize((*String
)) - sizeof((*String
)[0]));
94 // Remove any spaces and tabs at the end of the (*String).
96 while ((StrLen (*String
) > 0) && (((*String
)[StrLen((*String
))-1] == L
' ') || ((*String
)[StrLen((*String
))-1] == L
'\t'))) {
97 (*String
)[StrLen((*String
))-1] = CHAR_NULL
;
100 return (EFI_SUCCESS
);
104 Parse for the next instance of one string within another string. Can optionally make sure that
105 the string was not escaped (^ character) per the shell specification.
107 @param[in] SourceString The string to search within
108 @param[in] FindString The string to look for
109 @param[in] CheckForEscapeCharacter TRUE to skip escaped instances of FinfString, otherwise will return even escaped instances
114 IN CONST CHAR16
*SourceString
,
115 IN CONST CHAR16
*FindString
,
116 IN CONST BOOLEAN CheckForEscapeCharacter
120 if (SourceString
== NULL
) {
123 Temp
= StrStr(SourceString
, FindString
);
126 // If nothing found, or we dont care about escape characters
128 if (Temp
== NULL
|| !CheckForEscapeCharacter
) {
133 // If we found an escaped character, try again on the remainder of the string
135 if ((Temp
> (SourceString
)) && *(Temp
-1) == L
'^') {
136 return FindNextInstance(Temp
+1, FindString
, CheckForEscapeCharacter
);
140 // we found the right character
146 Check whether the string between a pair of % is a valid envifronment variable name.
148 @param[in] BeginPercent pointer to the first percent.
149 @param[in] EndPercent pointer to the last percent.
151 @retval TRUE is a valid environment variable name.
152 @retval FALSE is NOT a valid environment variable name.
155 IsValidEnvironmentVariableName(
156 IN CONST CHAR16
*BeginPercent
,
157 IN CONST CHAR16
*EndPercent
160 CONST CHAR16
*Walker
;
164 ASSERT (BeginPercent
!= NULL
);
165 ASSERT (EndPercent
!= NULL
);
166 ASSERT (BeginPercent
< EndPercent
);
168 if ((BeginPercent
+ 1) == EndPercent
) {
172 for (Walker
= BeginPercent
+ 1; Walker
< EndPercent
; Walker
++) {
174 (*Walker
>= L
'0' && *Walker
<= L
'9') ||
175 (*Walker
>= L
'A' && *Walker
<= L
'Z') ||
176 (*Walker
>= L
'a' && *Walker
<= L
'z') ||
179 if (Walker
== BeginPercent
+ 1 && (*Walker
>= L
'0' && *Walker
<= L
'9')) {
193 Determine if a command line contains a split operation
195 @param[in] CmdLine The command line to parse.
197 @retval TRUE CmdLine has a valid split.
198 @retval FALSE CmdLine does not have a valid split.
203 IN CONST CHAR16
*CmdLine
206 CONST CHAR16
*TempSpot
;
207 CONST CHAR16
*FirstQuote
;
208 CONST CHAR16
*SecondQuote
;
210 FirstQuote
= FindNextInstance (CmdLine
, L
"\"", TRUE
);
212 TempSpot
= FindFirstCharacter(CmdLine
, L
"|", L
'^');
214 if (FirstQuote
== NULL
||
216 TempSpot
== CHAR_NULL
||
217 FirstQuote
> TempSpot
219 return (BOOLEAN
) ((TempSpot
!= NULL
) && (*TempSpot
!= CHAR_NULL
));
222 while ((TempSpot
!= NULL
) && (*TempSpot
!= CHAR_NULL
)) {
223 if (FirstQuote
== NULL
|| FirstQuote
> TempSpot
) {
226 SecondQuote
= FindNextInstance (FirstQuote
+ 1, L
"\"", TRUE
);
227 if (SecondQuote
== NULL
) {
230 if (SecondQuote
< TempSpot
) {
231 FirstQuote
= FindNextInstance (SecondQuote
+ 1, L
"\"", TRUE
);
234 FirstQuote
= FindNextInstance (SecondQuote
+ 1, L
"\"", TRUE
);
235 TempSpot
= FindFirstCharacter(TempSpot
+ 1, L
"|", L
'^');
240 return (BOOLEAN
) ((TempSpot
!= NULL
) && (*TempSpot
!= CHAR_NULL
));
244 Function to start monitoring for CTRL-S using SimpleTextInputEx. This
245 feature's enabled state was not known when the shell initially launched.
247 @retval EFI_SUCCESS The feature is enabled.
248 @retval EFI_OUT_OF_RESOURCES There is not enough mnemory available.
252 InternalEfiShellStartCtrlSMonitor(
256 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*SimpleEx
;
257 EFI_KEY_DATA KeyData
;
260 Status
= gBS
->OpenProtocol(
261 gST
->ConsoleInHandle
,
262 &gEfiSimpleTextInputExProtocolGuid
,
266 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
267 if (EFI_ERROR(Status
)) {
272 STRING_TOKEN (STR_SHELL_NO_IN_EX
),
273 ShellInfoObject
.HiiHandle
);
274 return (EFI_SUCCESS
);
277 KeyData
.KeyState
.KeyToggleState
= 0;
278 KeyData
.Key
.ScanCode
= 0;
279 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
;
280 KeyData
.Key
.UnicodeChar
= L
's';
282 Status
= SimpleEx
->RegisterKeyNotify(
285 NotificationFunction
,
286 &ShellInfoObject
.CtrlSNotifyHandle1
);
288 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
;
289 if (!EFI_ERROR(Status
)) {
290 Status
= SimpleEx
->RegisterKeyNotify(
293 NotificationFunction
,
294 &ShellInfoObject
.CtrlSNotifyHandle2
);
296 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
;
297 KeyData
.Key
.UnicodeChar
= 19;
299 if (!EFI_ERROR(Status
)) {
300 Status
= SimpleEx
->RegisterKeyNotify(
303 NotificationFunction
,
304 &ShellInfoObject
.CtrlSNotifyHandle3
);
306 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
;
307 if (!EFI_ERROR(Status
)) {
308 Status
= SimpleEx
->RegisterKeyNotify(
311 NotificationFunction
,
312 &ShellInfoObject
.CtrlSNotifyHandle4
);
320 The entry point for the application.
322 @param[in] ImageHandle The firmware allocated handle for the EFI image.
323 @param[in] SystemTable A pointer to the EFI System Table.
325 @retval EFI_SUCCESS The entry point is executed successfully.
326 @retval other Some error occurs when executing this entry point.
332 IN EFI_HANDLE ImageHandle
,
333 IN EFI_SYSTEM_TABLE
*SystemTable
339 EFI_HANDLE ConInHandle
;
340 EFI_SIMPLE_TEXT_INPUT_PROTOCOL
*OldConIn
;
342 if (PcdGet8(PcdShellSupportLevel
) > 3) {
343 return (EFI_UNSUPPORTED
);
349 Status
= gST
->ConOut
->ClearScreen(gST
->ConOut
);
350 if (EFI_ERROR(Status
)) {
355 // Populate the global structure from PCDs
357 ShellInfoObject
.ImageDevPath
= NULL
;
358 ShellInfoObject
.FileDevPath
= NULL
;
359 ShellInfoObject
.PageBreakEnabled
= PcdGetBool(PcdShellPageBreakDefault
);
360 ShellInfoObject
.ViewingSettings
.InsertMode
= PcdGetBool(PcdShellInsertModeDefault
);
361 ShellInfoObject
.LogScreenCount
= PcdGet8 (PcdShellScreenLogCount
);
364 // verify we dont allow for spec violation
366 ASSERT(ShellInfoObject
.LogScreenCount
>= 3);
369 // Initialize the LIST ENTRY objects...
371 InitializeListHead(&ShellInfoObject
.BufferToFreeList
.Link
);
372 InitializeListHead(&ShellInfoObject
.ViewingSettings
.CommandHistory
.Link
);
373 InitializeListHead(&ShellInfoObject
.SplitList
.Link
);
376 // Check PCDs for optional features that are not implemented yet.
378 if ( PcdGetBool(PcdShellSupportOldProtocols
)
379 || !FeaturePcdGet(PcdShellRequireHiiPlatform
)
380 || FeaturePcdGet(PcdShellSupportFrameworkHii
)
382 return (EFI_UNSUPPORTED
);
386 // turn off the watchdog timer
388 gBS
->SetWatchdogTimer (0, 0, 0, NULL
);
391 // install our console logger. This will keep a log of the output for back-browsing
393 Status
= ConsoleLoggerInstall(ShellInfoObject
.LogScreenCount
, &ShellInfoObject
.ConsoleInfo
);
394 if (!EFI_ERROR(Status
)) {
396 // Enable the cursor to be visible
398 gST
->ConOut
->EnableCursor (gST
->ConOut
, TRUE
);
401 // If supporting EFI 1.1 we need to install HII protocol
402 // only do this if PcdShellRequireHiiPlatform == FALSE
404 // remove EFI_UNSUPPORTED check above when complete.
405 ///@todo add support for Framework HII
408 // install our (solitary) HII package
410 ShellInfoObject
.HiiHandle
= HiiAddPackages (&gEfiCallerIdGuid
, gImageHandle
, ShellStrings
, NULL
);
411 if (ShellInfoObject
.HiiHandle
== NULL
) {
412 if (PcdGetBool(PcdShellSupportFrameworkHii
)) {
413 ///@todo Add our package into Framework HII
415 if (ShellInfoObject
.HiiHandle
== NULL
) {
416 Status
= EFI_NOT_STARTED
;
422 // create and install the EfiShellParametersProtocol
424 Status
= CreatePopulateInstallShellParametersProtocol(&ShellInfoObject
.NewShellParametersProtocol
, &ShellInfoObject
.RootShellInstance
);
425 ASSERT_EFI_ERROR(Status
);
426 ASSERT(ShellInfoObject
.NewShellParametersProtocol
!= NULL
);
429 // create and install the EfiShellProtocol
431 Status
= CreatePopulateInstallShellProtocol(&ShellInfoObject
.NewEfiShellProtocol
);
432 ASSERT_EFI_ERROR(Status
);
433 ASSERT(ShellInfoObject
.NewEfiShellProtocol
!= NULL
);
436 // Now initialize the shell library (it requires Shell Parameters protocol)
438 Status
= ShellInitialize();
439 ASSERT_EFI_ERROR(Status
);
441 Status
= CommandInit();
442 ASSERT_EFI_ERROR(Status
);
445 // Check the command line
447 Status
= ProcessCommandLine ();
448 if (EFI_ERROR (Status
)) {
453 // If shell support level is >= 1 create the mappings and paths
455 if (PcdGet8(PcdShellSupportLevel
) >= 1) {
456 Status
= ShellCommandCreateInitialMappingsAndPaths();
460 // save the device path for the loaded image and the device path for the filepath (under loaded image)
461 // These are where to look for the startup.nsh file
463 Status
= GetDevicePathsForImageAndFile(&ShellInfoObject
.ImageDevPath
, &ShellInfoObject
.FileDevPath
);
464 ASSERT_EFI_ERROR(Status
);
467 // Display the version
469 if (!ShellInfoObject
.ShellInitSettings
.BitUnion
.Bits
.NoVersion
) {
472 gST
->ConOut
->Mode
->CursorRow
,
474 STRING_TOKEN (STR_VER_OUTPUT_MAIN_SHELL
),
475 ShellInfoObject
.HiiHandle
,
476 SupportLevel
[PcdGet8(PcdShellSupportLevel
)],
477 gEfiShellProtocol
->MajorVersion
,
478 gEfiShellProtocol
->MinorVersion
485 STRING_TOKEN (STR_VER_OUTPUT_MAIN_SUPPLIER
),
486 ShellInfoObject
.HiiHandle
,
487 (CHAR16
*) PcdGetPtr (PcdShellSupplier
)
494 STRING_TOKEN (STR_VER_OUTPUT_MAIN_UEFI
),
495 ShellInfoObject
.HiiHandle
,
496 (gST
->Hdr
.Revision
&0xffff0000)>>16,
497 (gST
->Hdr
.Revision
&0x0000ffff),
499 gST
->FirmwareRevision
504 // Display the mapping
506 if (PcdGet8(PcdShellSupportLevel
) >= 2 && !ShellInfoObject
.ShellInitSettings
.BitUnion
.Bits
.NoMap
) {
507 Status
= RunCommand(L
"map");
508 ASSERT_EFI_ERROR(Status
);
512 // init all the built in alias'
514 Status
= SetBuiltInAlias();
515 ASSERT_EFI_ERROR(Status
);
518 // Initialize environment variables
520 if (ShellCommandGetProfileList() != NULL
) {
521 Status
= InternalEfiShellSetEnv(L
"profiles", ShellCommandGetProfileList(), TRUE
);
522 ASSERT_EFI_ERROR(Status
);
526 TempString
= AllocateZeroPool(Size
);
528 UnicodeSPrint(TempString
, Size
, L
"%d", PcdGet8(PcdShellSupportLevel
));
529 Status
= InternalEfiShellSetEnv(L
"uefishellsupport", TempString
, TRUE
);
530 ASSERT_EFI_ERROR(Status
);
532 UnicodeSPrint(TempString
, Size
, L
"%d.%d", ShellInfoObject
.NewEfiShellProtocol
->MajorVersion
, ShellInfoObject
.NewEfiShellProtocol
->MinorVersion
);
533 Status
= InternalEfiShellSetEnv(L
"uefishellversion", TempString
, TRUE
);
534 ASSERT_EFI_ERROR(Status
);
536 UnicodeSPrint(TempString
, Size
, L
"%d.%d", (gST
->Hdr
.Revision
& 0xFFFF0000) >> 16, gST
->Hdr
.Revision
& 0x0000FFFF);
537 Status
= InternalEfiShellSetEnv(L
"uefiversion", TempString
, TRUE
);
538 ASSERT_EFI_ERROR(Status
);
540 FreePool(TempString
);
542 if (!EFI_ERROR(Status
)) {
543 if (!ShellInfoObject
.ShellInitSettings
.BitUnion
.Bits
.NoInterrupt
) {
545 // Set up the event for CTRL-C monitoring...
547 Status
= InernalEfiShellStartMonitor();
550 if (!EFI_ERROR(Status
) && !ShellInfoObject
.ShellInitSettings
.BitUnion
.Bits
.NoConsoleIn
) {
552 // Set up the event for CTRL-S monitoring...
554 Status
= InternalEfiShellStartCtrlSMonitor();
557 if (!EFI_ERROR(Status
) && ShellInfoObject
.ShellInitSettings
.BitUnion
.Bits
.NoConsoleIn
) {
559 // close off the gST->ConIn
561 OldConIn
= gST
->ConIn
;
562 ConInHandle
= gST
->ConsoleInHandle
;
563 gST
->ConIn
= CreateSimpleTextInOnFile((SHELL_FILE_HANDLE
)&FileInterfaceNulFile
, &gST
->ConsoleInHandle
);
569 if (!EFI_ERROR(Status
) && PcdGet8(PcdShellSupportLevel
) >= 1) {
571 // process the startup script or launch the called app.
573 Status
= DoStartupScript(ShellInfoObject
.ImageDevPath
, ShellInfoObject
.FileDevPath
);
576 if (!ShellInfoObject
.ShellInitSettings
.BitUnion
.Bits
.Exit
&& !ShellCommandGetExit() && (PcdGet8(PcdShellSupportLevel
) >= 3 || PcdGetBool(PcdShellForceConsole
)) && !EFI_ERROR(Status
) && !ShellInfoObject
.ShellInitSettings
.BitUnion
.Bits
.NoConsoleIn
) {
578 // begin the UI waiting loop
582 // clean out all the memory allocated for CONST <something> * return values
583 // between each shell prompt presentation
585 if (!IsListEmpty(&ShellInfoObject
.BufferToFreeList
.Link
)){
586 FreeBufferList(&ShellInfoObject
.BufferToFreeList
);
590 // Reset page break back to default.
592 ShellInfoObject
.PageBreakEnabled
= PcdGetBool(PcdShellPageBreakDefault
);
593 ASSERT (ShellInfoObject
.ConsoleInfo
!= NULL
);
594 ShellInfoObject
.ConsoleInfo
->Enabled
= TRUE
;
595 ShellInfoObject
.ConsoleInfo
->RowCounter
= 0;
598 // Reset the CTRL-C event (yes we ignore the return values)
600 Status
= gBS
->CheckEvent (ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
);
605 Status
= DoShellPrompt();
606 } while (!ShellCommandGetExit());
608 if (OldConIn
!= NULL
&& ConInHandle
!= NULL
) {
609 CloseSimpleTextInOnFile (gST
->ConIn
);
610 gST
->ConIn
= OldConIn
;
611 gST
->ConsoleInHandle
= ConInHandle
;
618 // uninstall protocols / free memory / etc...
620 if (ShellInfoObject
.UserBreakTimer
!= NULL
) {
621 gBS
->CloseEvent(ShellInfoObject
.UserBreakTimer
);
622 DEBUG_CODE(ShellInfoObject
.UserBreakTimer
= NULL
;);
624 if (ShellInfoObject
.ImageDevPath
!= NULL
) {
625 FreePool(ShellInfoObject
.ImageDevPath
);
626 DEBUG_CODE(ShellInfoObject
.ImageDevPath
= NULL
;);
628 if (ShellInfoObject
.FileDevPath
!= NULL
) {
629 FreePool(ShellInfoObject
.FileDevPath
);
630 DEBUG_CODE(ShellInfoObject
.FileDevPath
= NULL
;);
632 if (ShellInfoObject
.NewShellParametersProtocol
!= NULL
) {
633 CleanUpShellParametersProtocol(ShellInfoObject
.NewShellParametersProtocol
);
634 DEBUG_CODE(ShellInfoObject
.NewShellParametersProtocol
= NULL
;);
636 if (ShellInfoObject
.NewEfiShellProtocol
!= NULL
){
637 if (ShellInfoObject
.NewEfiShellProtocol
->IsRootShell()){
638 InternalEfiShellSetEnv(L
"cwd", NULL
, TRUE
);
640 CleanUpShellProtocol(ShellInfoObject
.NewEfiShellProtocol
);
641 DEBUG_CODE(ShellInfoObject
.NewEfiShellProtocol
= NULL
;);
644 if (!IsListEmpty(&ShellInfoObject
.BufferToFreeList
.Link
)){
645 FreeBufferList(&ShellInfoObject
.BufferToFreeList
);
648 if (!IsListEmpty(&ShellInfoObject
.SplitList
.Link
)){
649 ASSERT(FALSE
); ///@todo finish this de-allocation.
652 if (ShellInfoObject
.ShellInitSettings
.FileName
!= NULL
) {
653 FreePool(ShellInfoObject
.ShellInitSettings
.FileName
);
654 DEBUG_CODE(ShellInfoObject
.ShellInitSettings
.FileName
= NULL
;);
657 if (ShellInfoObject
.ShellInitSettings
.FileOptions
!= NULL
) {
658 FreePool(ShellInfoObject
.ShellInitSettings
.FileOptions
);
659 DEBUG_CODE(ShellInfoObject
.ShellInitSettings
.FileOptions
= NULL
;);
662 if (ShellInfoObject
.HiiHandle
!= NULL
) {
663 HiiRemovePackages(ShellInfoObject
.HiiHandle
);
664 DEBUG_CODE(ShellInfoObject
.HiiHandle
= NULL
;);
667 if (!IsListEmpty(&ShellInfoObject
.ViewingSettings
.CommandHistory
.Link
)){
668 FreeBufferList(&ShellInfoObject
.ViewingSettings
.CommandHistory
);
671 ASSERT(ShellInfoObject
.ConsoleInfo
!= NULL
);
672 if (ShellInfoObject
.ConsoleInfo
!= NULL
) {
673 ConsoleLoggerUninstall(ShellInfoObject
.ConsoleInfo
);
674 FreePool(ShellInfoObject
.ConsoleInfo
);
675 DEBUG_CODE(ShellInfoObject
.ConsoleInfo
= NULL
;);
678 if (ShellCommandGetExit()) {
679 return ((EFI_STATUS
)ShellCommandGetExitCode());
685 Sets all the alias' that were registered with the ShellCommandLib library.
687 @retval EFI_SUCCESS all init commands were run sucessfully.
695 CONST ALIAS_LIST
*List
;
699 // Get all the commands we want to run
701 List
= ShellCommandGetInitAliasList();
704 // for each command in the List
706 for ( Node
= (ALIAS_LIST
*)GetFirstNode(&List
->Link
)
707 ; !IsNull (&List
->Link
, &Node
->Link
)
708 ; Node
= (ALIAS_LIST
*)GetNextNode(&List
->Link
, &Node
->Link
)
711 // install the alias'
713 Status
= InternalSetAlias(Node
->CommandString
, Node
->Alias
, TRUE
);
714 ASSERT_EFI_ERROR(Status
);
716 return (EFI_SUCCESS
);
720 Internal function to determine if 2 command names are really the same.
722 @param[in] Command1 The pointer to the first command name.
723 @param[in] Command2 The pointer to the second command name.
725 @retval TRUE The 2 command names are the same.
726 @retval FALSE The 2 command names are not the same.
731 IN CONST CHAR16
*Command1
,
732 IN CONST CHAR16
*Command2
735 if (StringNoCaseCompare(&Command1
, &Command2
) == 0) {
742 Internal function to determine if a command is a script only command.
744 @param[in] CommandName The pointer to the command name.
746 @retval TRUE The command is a script only command.
747 @retval FALSE The command is not a script only command.
752 IN CONST CHAR16
*CommandName
755 if (IsCommand(CommandName
, L
"for")
756 ||IsCommand(CommandName
, L
"endfor")
757 ||IsCommand(CommandName
, L
"if")
758 ||IsCommand(CommandName
, L
"else")
759 ||IsCommand(CommandName
, L
"endif")
760 ||IsCommand(CommandName
, L
"goto")) {
767 This function will populate the 2 device path protocol parameters based on the
768 global gImageHandle. The DevPath will point to the device path for the handle that has
769 loaded image protocol installed on it. The FilePath will point to the device path
770 for the file that was loaded.
772 @param[in, out] DevPath On a sucessful return the device path to the loaded image.
773 @param[in, out] FilePath On a sucessful return the device path to the file.
775 @retval EFI_SUCCESS The 2 device paths were sucessfully returned.
776 @retval other A error from gBS->HandleProtocol.
782 GetDevicePathsForImageAndFile (
783 IN OUT EFI_DEVICE_PATH_PROTOCOL
**DevPath
,
784 IN OUT EFI_DEVICE_PATH_PROTOCOL
**FilePath
788 EFI_LOADED_IMAGE_PROTOCOL
*LoadedImage
;
789 EFI_DEVICE_PATH_PROTOCOL
*ImageDevicePath
;
791 ASSERT(DevPath
!= NULL
);
792 ASSERT(FilePath
!= NULL
);
794 Status
= gBS
->OpenProtocol (
796 &gEfiLoadedImageProtocolGuid
,
797 (VOID
**)&LoadedImage
,
800 EFI_OPEN_PROTOCOL_GET_PROTOCOL
802 if (!EFI_ERROR (Status
)) {
803 Status
= gBS
->OpenProtocol (
804 LoadedImage
->DeviceHandle
,
805 &gEfiDevicePathProtocolGuid
,
806 (VOID
**)&ImageDevicePath
,
809 EFI_OPEN_PROTOCOL_GET_PROTOCOL
811 if (!EFI_ERROR (Status
)) {
812 *DevPath
= DuplicateDevicePath (ImageDevicePath
);
813 *FilePath
= DuplicateDevicePath (LoadedImage
->FilePath
);
815 LoadedImage
->DeviceHandle
,
816 &gEfiDevicePathProtocolGuid
,
822 &gEfiLoadedImageProtocolGuid
,
830 Process all Uefi Shell 2.0 command line options.
832 see Uefi Shell 2.0 section 3.2 for full details.
834 the command line must resemble the following:
836 shell.efi [ShellOpt-options] [options] [file-name [file-name-options]]
838 ShellOpt-options Options which control the initialization behavior of the shell.
839 These options are read from the EFI global variable "ShellOpt"
840 and are processed before options or file-name.
842 options Options which control the initialization behavior of the shell.
844 file-name The name of a UEFI shell application or script to be executed
845 after initialization is complete. By default, if file-name is
846 specified, then -nostartup is implied. Scripts are not supported
849 file-name-options The command-line options that are passed to file-name when it
852 This will initialize the ShellInfoObject.ShellInitSettings global variable.
854 @retval EFI_SUCCESS The variable is initialized.
865 CHAR16
*DelayValueStr
;
868 EFI_UNICODE_COLLATION_PROTOCOL
*UnicodeCollation
;
870 // `file-name-options` will contain arguments to `file-name` that we don't
871 // know about. This would cause ShellCommandLineParse to error, so we parse
872 // arguments manually, ignoring those after the first thing that doesn't look
873 // like a shell option (which is assumed to be `file-name`).
875 Status
= gBS
->LocateProtocol (
876 &gEfiUnicodeCollationProtocolGuid
,
878 (VOID
**) &UnicodeCollation
880 if (EFI_ERROR (Status
)) {
884 // Set default options
885 ShellInfoObject
.ShellInitSettings
.BitUnion
.Bits
.Startup
= FALSE
;
886 ShellInfoObject
.ShellInitSettings
.BitUnion
.Bits
.NoStartup
= FALSE
;
887 ShellInfoObject
.ShellInitSettings
.BitUnion
.Bits
.NoConsoleOut
= FALSE
;
888 ShellInfoObject
.ShellInitSettings
.BitUnion
.Bits
.NoConsoleIn
= FALSE
;
889 ShellInfoObject
.ShellInitSettings
.BitUnion
.Bits
.NoInterrupt
= FALSE
;
890 ShellInfoObject
.ShellInitSettings
.BitUnion
.Bits
.NoMap
= FALSE
;
891 ShellInfoObject
.ShellInitSettings
.BitUnion
.Bits
.NoVersion
= FALSE
;
892 ShellInfoObject
.ShellInitSettings
.BitUnion
.Bits
.Delay
= FALSE
;
893 ShellInfoObject
.ShellInitSettings
.BitUnion
.Bits
.Exit
= FALSE
;
894 ShellInfoObject
.ShellInitSettings
.Delay
= 5;
897 // Start LoopVar at 0 to parse only optional arguments at Argv[0]
898 // and parse other parameters from Argv[1]. This is for use case that
899 // UEFI Shell boot option is created, and OptionalData is provided
900 // that starts with shell command-line options.
902 for (LoopVar
= 0 ; LoopVar
< gEfiShellParametersProtocol
->Argc
; LoopVar
++) {
903 CurrentArg
= gEfiShellParametersProtocol
->Argv
[LoopVar
];
904 if (UnicodeCollation
->StriColl (
909 ShellInfoObject
.ShellInitSettings
.BitUnion
.Bits
.Startup
= TRUE
;
911 else if (UnicodeCollation
->StriColl (
916 ShellInfoObject
.ShellInitSettings
.BitUnion
.Bits
.NoStartup
= TRUE
;
918 else if (UnicodeCollation
->StriColl (
923 ShellInfoObject
.ShellInitSettings
.BitUnion
.Bits
.NoConsoleOut
= TRUE
;
925 else if (UnicodeCollation
->StriColl (
930 ShellInfoObject
.ShellInitSettings
.BitUnion
.Bits
.NoConsoleIn
= TRUE
;
932 else if (UnicodeCollation
->StriColl (
937 ShellInfoObject
.ShellInitSettings
.BitUnion
.Bits
.NoInterrupt
= TRUE
;
939 else if (UnicodeCollation
->StriColl (
944 ShellInfoObject
.ShellInitSettings
.BitUnion
.Bits
.NoMap
= TRUE
;
946 else if (UnicodeCollation
->StriColl (
951 ShellInfoObject
.ShellInitSettings
.BitUnion
.Bits
.NoVersion
= TRUE
;
953 else if (UnicodeCollation
->StriColl (
958 ShellInfoObject
.ShellInitSettings
.BitUnion
.Bits
.Delay
= TRUE
;
959 // Check for optional delay value following "-delay"
960 DelayValueStr
= gEfiShellParametersProtocol
->Argv
[LoopVar
+ 1];
961 if (DelayValueStr
!= NULL
){
962 if (*DelayValueStr
== L
':') {
965 if (!EFI_ERROR(ShellConvertStringToUint64 (
971 ShellInfoObject
.ShellInitSettings
.Delay
= (UINTN
)DelayValue
;
975 } else if (UnicodeCollation
->StriColl (
980 ShellInfoObject
.ShellInitSettings
.BitUnion
.Bits
.Exit
= TRUE
;
981 } else if (StrnCmp (L
"-", CurrentArg
, 1) == 0) {
982 // Unrecognised option
983 ShellPrintHiiEx(-1, -1, NULL
,
984 STRING_TOKEN (STR_GEN_PROBLEM
),
985 ShellInfoObject
.HiiHandle
,
988 return EFI_INVALID_PARAMETER
;
991 // First argument should be Shell.efi image name
997 ShellInfoObject
.ShellInitSettings
.FileName
= AllocateCopyPool(StrSize(CurrentArg
), CurrentArg
);
998 if (ShellInfoObject
.ShellInitSettings
.FileName
== NULL
) {
999 return (EFI_OUT_OF_RESOURCES
);
1002 // We found `file-name`.
1004 ShellInfoObject
.ShellInitSettings
.BitUnion
.Bits
.NoStartup
= 1;
1007 // Add `file-name-options`
1008 for (Size
= 0 ; LoopVar
< gEfiShellParametersProtocol
->Argc
; LoopVar
++) {
1009 ASSERT((ShellInfoObject
.ShellInitSettings
.FileOptions
== NULL
&& Size
== 0) || (ShellInfoObject
.ShellInitSettings
.FileOptions
!= NULL
));
1010 StrnCatGrow(&ShellInfoObject
.ShellInitSettings
.FileOptions
,
1014 if (ShellInfoObject
.ShellInitSettings
.FileOptions
== NULL
) {
1015 SHELL_FREE_NON_NULL(ShellInfoObject
.ShellInitSettings
.FileName
);
1016 return (EFI_OUT_OF_RESOURCES
);
1018 StrnCatGrow(&ShellInfoObject
.ShellInitSettings
.FileOptions
,
1020 gEfiShellParametersProtocol
->Argv
[LoopVar
],
1022 if (ShellInfoObject
.ShellInitSettings
.FileOptions
== NULL
) {
1023 SHELL_FREE_NON_NULL(ShellInfoObject
.ShellInitSettings
.FileName
);
1024 return (EFI_OUT_OF_RESOURCES
);
1030 // "-nointerrupt" overrides "-delay"
1031 if (ShellInfoObject
.ShellInitSettings
.BitUnion
.Bits
.NoInterrupt
) {
1032 ShellInfoObject
.ShellInitSettings
.Delay
= 0;
1039 Handles all interaction with the default startup script.
1041 this will check that the correct command line parameters were passed, handle the delay, and then start running the script.
1043 @param ImagePath the path to the image for shell. first place to look for the startup script
1044 @param FilePath the path to the file for shell. second place to look for the startup script.
1046 @retval EFI_SUCCESS the variable is initialized.
1051 IN EFI_DEVICE_PATH_PROTOCOL
*ImagePath
,
1052 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
1058 SHELL_FILE_HANDLE FileHandle
;
1059 EFI_DEVICE_PATH_PROTOCOL
*NewPath
;
1060 EFI_DEVICE_PATH_PROTOCOL
*NamePath
;
1061 CHAR16
*FileStringPath
;
1064 CONST CHAR16
*MapName
;
1066 Key
.UnicodeChar
= CHAR_NULL
;
1070 if (!ShellInfoObject
.ShellInitSettings
.BitUnion
.Bits
.Startup
&& ShellInfoObject
.ShellInitSettings
.FileName
!= NULL
) {
1072 // launch something else instead
1074 NewSize
= StrSize(ShellInfoObject
.ShellInitSettings
.FileName
);
1075 if (ShellInfoObject
.ShellInitSettings
.FileOptions
!= NULL
) {
1076 NewSize
+= StrSize(ShellInfoObject
.ShellInitSettings
.FileOptions
) + sizeof(CHAR16
);
1078 FileStringPath
= AllocateZeroPool(NewSize
);
1079 if (FileStringPath
== NULL
) {
1080 return (EFI_OUT_OF_RESOURCES
);
1082 StrnCpy(FileStringPath
, ShellInfoObject
.ShellInitSettings
.FileName
, NewSize
/sizeof(CHAR16
) -1);
1083 if (ShellInfoObject
.ShellInitSettings
.FileOptions
!= NULL
) {
1084 StrnCat(FileStringPath
, L
" ", NewSize
/sizeof(CHAR16
) - StrLen(FileStringPath
) -1);
1085 StrnCat(FileStringPath
, ShellInfoObject
.ShellInitSettings
.FileOptions
, NewSize
/sizeof(CHAR16
) - StrLen(FileStringPath
) -1);
1087 Status
= RunCommand(FileStringPath
);
1088 FreePool(FileStringPath
);
1094 // for shell level 0 we do no scripts
1095 // Without the Startup bit overriding we allow for nostartup to prevent scripts
1097 if ( (PcdGet8(PcdShellSupportLevel
) < 1)
1098 || (ShellInfoObject
.ShellInitSettings
.BitUnion
.Bits
.NoStartup
&& !ShellInfoObject
.ShellInitSettings
.BitUnion
.Bits
.Startup
)
1100 return (EFI_SUCCESS
);
1103 gST
->ConOut
->EnableCursor(gST
->ConOut
, FALSE
);
1105 // print out our warning and see if they press a key
1107 for ( Status
= EFI_UNSUPPORTED
, Delay
= ShellInfoObject
.ShellInitSettings
.Delay
1108 ; Delay
!= 0 && EFI_ERROR(Status
)
1111 ShellPrintHiiEx(0, gST
->ConOut
->Mode
->CursorRow
, NULL
, STRING_TOKEN (STR_SHELL_STARTUP_QUESTION
), ShellInfoObject
.HiiHandle
, Delay
);
1112 gBS
->Stall (1000000);
1113 if (!ShellInfoObject
.ShellInitSettings
.BitUnion
.Bits
.NoConsoleIn
) {
1114 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
1117 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_SHELL_CRLF
), ShellInfoObject
.HiiHandle
);
1118 gST
->ConOut
->EnableCursor(gST
->ConOut
, TRUE
);
1123 if (Status
== EFI_SUCCESS
&& Key
.UnicodeChar
== 0 && Key
.ScanCode
== SCAN_ESC
) {
1124 return (EFI_SUCCESS
);
1128 // Try the first location (must be file system)
1130 MapName
= ShellInfoObject
.NewEfiShellProtocol
->GetMapFromDevicePath(&ImagePath
);
1131 if (MapName
!= NULL
) {
1132 FileStringPath
= NULL
;
1134 FileStringPath
= StrnCatGrow(&FileStringPath
, &NewSize
, MapName
, 0);
1135 if (FileStringPath
== NULL
) {
1136 Status
= EFI_OUT_OF_RESOURCES
;
1138 TempSpot
= StrStr(FileStringPath
, L
";");
1139 if (TempSpot
!= NULL
) {
1140 *TempSpot
= CHAR_NULL
;
1142 FileStringPath
= StrnCatGrow(&FileStringPath
, &NewSize
, ((FILEPATH_DEVICE_PATH
*)FilePath
)->PathName
, 0);
1143 PathRemoveLastItem(FileStringPath
);
1144 FileStringPath
= StrnCatGrow(&FileStringPath
, &NewSize
, mStartupScript
, 0);
1145 Status
= ShellInfoObject
.NewEfiShellProtocol
->OpenFileByName(FileStringPath
, &FileHandle
, EFI_FILE_MODE_READ
);
1146 FreePool(FileStringPath
);
1149 if (EFI_ERROR(Status
)) {
1150 NamePath
= FileDevicePath (NULL
, mStartupScript
);
1151 NewPath
= AppendDevicePathNode (ImagePath
, NamePath
);
1157 Status
= InternalOpenFileDevicePath(NewPath
, &FileHandle
, EFI_FILE_MODE_READ
, 0);
1161 // If we got a file, run it
1163 if (!EFI_ERROR(Status
) && FileHandle
!= NULL
) {
1164 Status
= RunScriptFile (mStartupScript
, FileHandle
, L
"", ShellInfoObject
.NewShellParametersProtocol
);
1165 ShellInfoObject
.NewEfiShellProtocol
->CloseFile(FileHandle
);
1167 FileStringPath
= ShellFindFilePath(mStartupScript
);
1168 if (FileStringPath
== NULL
) {
1170 // we return success since we dont need to have a startup script
1172 Status
= EFI_SUCCESS
;
1173 ASSERT(FileHandle
== NULL
);
1175 Status
= RunScriptFile(FileStringPath
, NULL
, L
"", ShellInfoObject
.NewShellParametersProtocol
);
1176 FreePool(FileStringPath
);
1185 Function to perform the shell prompt looping. It will do a single prompt,
1186 dispatch the result, and then return. It is expected that the caller will
1187 call this function in a loop many times.
1190 @retval RETURN_ABORTED
1201 CONST CHAR16
*CurDir
;
1208 // Get screen setting to decide size of the command line buffer
1210 gST
->ConOut
->QueryMode (gST
->ConOut
, gST
->ConOut
->Mode
->Mode
, &Column
, &Row
);
1211 BufferSize
= Column
* Row
* sizeof (CHAR16
);
1212 CmdLine
= AllocateZeroPool (BufferSize
);
1213 if (CmdLine
== NULL
) {
1214 return EFI_OUT_OF_RESOURCES
;
1217 CurDir
= ShellInfoObject
.NewEfiShellProtocol
->GetEnv(L
"cwd");
1222 gST
->ConOut
->SetCursorPosition (gST
->ConOut
, 0, gST
->ConOut
->Mode
->CursorRow
);
1224 if (CurDir
!= NULL
&& StrLen(CurDir
) > 1) {
1225 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_SHELL_CURDIR
), ShellInfoObject
.HiiHandle
, CurDir
);
1227 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_SHELL_SHELL
), ShellInfoObject
.HiiHandle
);
1231 // Read a line from the console
1233 Status
= ShellInfoObject
.NewEfiShellProtocol
->ReadFile(ShellInfoObject
.NewShellParametersProtocol
->StdIn
, &BufferSize
, CmdLine
);
1236 // Null terminate the string and parse it
1238 if (!EFI_ERROR (Status
)) {
1239 CmdLine
[BufferSize
/ sizeof (CHAR16
)] = CHAR_NULL
;
1240 Status
= RunCommand(CmdLine
);
1244 // Done with this command
1251 Add a buffer to the Buffer To Free List for safely returning buffers to other
1252 places without risking letting them modify internal shell information.
1254 @param Buffer Something to pass to FreePool when the shell is exiting.
1258 AddBufferToFreeList(
1262 BUFFER_LIST
*BufferListEntry
;
1264 if (Buffer
== NULL
) {
1268 BufferListEntry
= AllocateZeroPool(sizeof(BUFFER_LIST
));
1269 ASSERT(BufferListEntry
!= NULL
);
1270 BufferListEntry
->Buffer
= Buffer
;
1271 InsertTailList(&ShellInfoObject
.BufferToFreeList
.Link
, &BufferListEntry
->Link
);
1276 Add a buffer to the Line History List
1278 @param Buffer The line buffer to add.
1282 AddLineToCommandHistory(
1283 IN CONST CHAR16
*Buffer
1288 Node
= AllocateZeroPool(sizeof(BUFFER_LIST
));
1289 ASSERT(Node
!= NULL
);
1290 Node
->Buffer
= AllocateCopyPool(StrSize(Buffer
), Buffer
);
1291 ASSERT(Node
->Buffer
!= NULL
);
1293 InsertTailList(&ShellInfoObject
.ViewingSettings
.CommandHistory
.Link
, &Node
->Link
);
1297 Checks if a string is an alias for another command. If yes, then it replaces the alias name
1298 with the correct command name.
1300 @param[in, out] CommandString Upon entry the potential alias. Upon return the
1301 command name if it was an alias. If it was not
1302 an alias it will be unchanged. This function may
1303 change the buffer to fit the command name.
1305 @retval EFI_SUCCESS The name was changed.
1306 @retval EFI_SUCCESS The name was not an alias.
1307 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
1312 IN OUT CHAR16
**CommandString
1315 CONST CHAR16
*NewString
;
1317 NewString
= ShellInfoObject
.NewEfiShellProtocol
->GetAlias(*CommandString
, NULL
);
1318 if (NewString
== NULL
) {
1319 return (EFI_SUCCESS
);
1321 FreePool(*CommandString
);
1322 *CommandString
= AllocateCopyPool(StrSize(NewString
), NewString
);
1323 if (*CommandString
== NULL
) {
1324 return (EFI_OUT_OF_RESOURCES
);
1326 return (EFI_SUCCESS
);
1330 This function will eliminate unreplaced (and therefore non-found) environment variables.
1332 @param[in,out] CmdLine The command line to update.
1336 StripUnreplacedEnvironmentVariables(
1337 IN OUT CHAR16
*CmdLine
1340 CHAR16
*FirstPercent
;
1342 CHAR16
*SecondPercent
;
1343 CHAR16
*SecondQuote
;
1344 CHAR16
*CurrentLocator
;
1346 for (CurrentLocator
= CmdLine
; CurrentLocator
!= NULL
; ) {
1347 FirstQuote
= FindNextInstance(CurrentLocator
, L
"\"", TRUE
);
1348 FirstPercent
= FindNextInstance(CurrentLocator
, L
"%", TRUE
);
1349 SecondPercent
= FirstPercent
!=NULL
?FindNextInstance(FirstPercent
+1, L
"%", TRUE
):NULL
;
1350 if (FirstPercent
== NULL
|| SecondPercent
== NULL
) {
1352 // If we ever dont have 2 % we are done.
1357 if (FirstQuote
!= NULL
&& FirstQuote
< FirstPercent
) {
1358 SecondQuote
= FindNextInstance(FirstQuote
+1, L
"\"", TRUE
);
1360 // Quote is first found
1363 if (SecondQuote
< FirstPercent
) {
1365 // restart after the pair of "
1367 CurrentLocator
= SecondQuote
+ 1;
1368 } else /* FirstPercent < SecondQuote */{
1370 // Restart on the first percent
1372 CurrentLocator
= FirstPercent
;
1377 if (FirstQuote
== NULL
|| SecondPercent
< FirstQuote
) {
1378 if (IsValidEnvironmentVariableName(FirstPercent
, SecondPercent
)) {
1380 // We need to remove from FirstPercent to SecondPercent
1382 CopyMem(FirstPercent
, SecondPercent
+ 1, StrSize(SecondPercent
+ 1));
1384 // dont need to update the locator. both % characters are gone.
1387 CurrentLocator
= SecondPercent
+ 1;
1391 CurrentLocator
= FirstQuote
;
1393 return (EFI_SUCCESS
);
1397 Function allocates a new command line and replaces all instances of environment
1398 variable names that are correctly preset to their values.
1400 If the return value is not NULL the memory must be caller freed.
1402 @param[in] OriginalCommandLine The original command line
1404 @retval NULL An error ocurred.
1405 @return The new command line with no environment variables present.
1409 ShellConvertVariables (
1410 IN CONST CHAR16
*OriginalCommandLine
1413 CONST CHAR16
*MasterEnvList
;
1415 CHAR16
*NewCommandLine1
;
1416 CHAR16
*NewCommandLine2
;
1420 SCRIPT_FILE
*CurrentScriptFile
;
1421 ALIAS_LIST
*AliasListNode
;
1423 ASSERT(OriginalCommandLine
!= NULL
);
1426 NewSize
= StrSize(OriginalCommandLine
);
1427 CurrentScriptFile
= ShellCommandGetCurrentScriptFile();
1430 ///@todo update this to handle the %0 - %9 for scripting only (borrow from line 1256 area) ? ? ?
1433 // calculate the size required for the post-conversion string...
1435 if (CurrentScriptFile
!= NULL
) {
1436 for (AliasListNode
= (ALIAS_LIST
*)GetFirstNode(&CurrentScriptFile
->SubstList
)
1437 ; !IsNull(&CurrentScriptFile
->SubstList
, &AliasListNode
->Link
)
1438 ; AliasListNode
= (ALIAS_LIST
*)GetNextNode(&CurrentScriptFile
->SubstList
, &AliasListNode
->Link
)
1440 for (Temp
= StrStr(OriginalCommandLine
, AliasListNode
->Alias
)
1442 ; Temp
= StrStr(Temp
+1, AliasListNode
->Alias
)
1445 // we need a preceeding and if there is space no ^ preceeding (if no space ignore)
1447 if ((((Temp
-OriginalCommandLine
)>2) && *(Temp
-2) != L
'^') || ((Temp
-OriginalCommandLine
)<=2)) {
1448 NewSize
+= StrSize(AliasListNode
->CommandString
);
1454 for (MasterEnvList
= EfiShellGetEnv(NULL
)
1455 ; MasterEnvList
!= NULL
&& *MasterEnvList
!= CHAR_NULL
//&& *(MasterEnvList+1) != CHAR_NULL
1456 ; MasterEnvList
+= StrLen(MasterEnvList
) + 1
1458 if (StrSize(MasterEnvList
) > ItemSize
) {
1459 ItemSize
= StrSize(MasterEnvList
);
1461 for (Temp
= StrStr(OriginalCommandLine
, MasterEnvList
)
1463 ; Temp
= StrStr(Temp
+1, MasterEnvList
)
1466 // we need a preceeding and following % and if there is space no ^ preceeding (if no space ignore)
1468 if (*(Temp
-1) == L
'%' && *(Temp
+StrLen(MasterEnvList
)) == L
'%' &&
1469 ((((Temp
-OriginalCommandLine
)>2) && *(Temp
-2) != L
'^') || ((Temp
-OriginalCommandLine
)<=2))) {
1470 NewSize
+=StrSize(EfiShellGetEnv(MasterEnvList
));
1476 // now do the replacements...
1478 NewCommandLine1
= AllocateCopyPool(NewSize
, OriginalCommandLine
);
1479 NewCommandLine2
= AllocateZeroPool(NewSize
);
1480 ItemTemp
= AllocateZeroPool(ItemSize
+(2*sizeof(CHAR16
)));
1481 if (NewCommandLine1
== NULL
|| NewCommandLine2
== NULL
|| ItemTemp
== NULL
) {
1482 SHELL_FREE_NON_NULL(NewCommandLine1
);
1483 SHELL_FREE_NON_NULL(NewCommandLine2
);
1484 SHELL_FREE_NON_NULL(ItemTemp
);
1487 for (MasterEnvList
= EfiShellGetEnv(NULL
)
1488 ; MasterEnvList
!= NULL
&& *MasterEnvList
!= CHAR_NULL
1489 ; MasterEnvList
+= StrLen(MasterEnvList
) + 1
1491 StrnCpy(ItemTemp
, L
"%", ((ItemSize
+(2*sizeof(CHAR16
)))/sizeof(CHAR16
))-1);
1492 StrnCat(ItemTemp
, MasterEnvList
, ((ItemSize
+(2*sizeof(CHAR16
)))/sizeof(CHAR16
))-1 - StrLen(ItemTemp
));
1493 StrnCat(ItemTemp
, L
"%", ((ItemSize
+(2*sizeof(CHAR16
)))/sizeof(CHAR16
))-1 - StrLen(ItemTemp
));
1494 ShellCopySearchAndReplace(NewCommandLine1
, NewCommandLine2
, NewSize
, ItemTemp
, EfiShellGetEnv(MasterEnvList
), TRUE
, FALSE
);
1495 StrnCpy(NewCommandLine1
, NewCommandLine2
, NewSize
/sizeof(CHAR16
)-1);
1497 if (CurrentScriptFile
!= NULL
) {
1498 for (AliasListNode
= (ALIAS_LIST
*)GetFirstNode(&CurrentScriptFile
->SubstList
)
1499 ; !IsNull(&CurrentScriptFile
->SubstList
, &AliasListNode
->Link
)
1500 ; AliasListNode
= (ALIAS_LIST
*)GetNextNode(&CurrentScriptFile
->SubstList
, &AliasListNode
->Link
)
1502 ShellCopySearchAndReplace(NewCommandLine1
, NewCommandLine2
, NewSize
, AliasListNode
->Alias
, AliasListNode
->CommandString
, TRUE
, FALSE
);
1503 StrnCpy(NewCommandLine1
, NewCommandLine2
, NewSize
/sizeof(CHAR16
)-1);
1508 // Remove non-existant environment variables
1510 StripUnreplacedEnvironmentVariables(NewCommandLine1
);
1513 // Now cleanup any straggler intentionally ignored "%" characters
1515 ShellCopySearchAndReplace(NewCommandLine1
, NewCommandLine2
, NewSize
, L
"^%", L
"%", TRUE
, FALSE
);
1516 StrnCpy(NewCommandLine1
, NewCommandLine2
, NewSize
/sizeof(CHAR16
)-1);
1518 FreePool(NewCommandLine2
);
1521 return (NewCommandLine1
);
1525 Internal function to run a command line with pipe usage.
1527 @param[in] CmdLine The pointer to the command line.
1528 @param[in] StdIn The pointer to the Standard input.
1529 @param[in] StdOut The pointer to the Standard output.
1531 @retval EFI_SUCCESS The split command is executed successfully.
1532 @retval other Some error occurs when executing the split command.
1537 IN CONST CHAR16
*CmdLine
,
1538 IN SHELL_FILE_HANDLE
*StdIn
,
1539 IN SHELL_FILE_HANDLE
*StdOut
1543 CHAR16
*NextCommandLine
;
1544 CHAR16
*OurCommandLine
;
1548 SHELL_FILE_HANDLE
*TempFileHandle
;
1551 ASSERT(StdOut
== NULL
);
1553 ASSERT(StrStr(CmdLine
, L
"|") != NULL
);
1555 Status
= EFI_SUCCESS
;
1556 NextCommandLine
= NULL
;
1557 OurCommandLine
= NULL
;
1561 NextCommandLine
= StrnCatGrow(&NextCommandLine
, &Size1
, StrStr(CmdLine
, L
"|")+1, 0);
1562 OurCommandLine
= StrnCatGrow(&OurCommandLine
, &Size2
, CmdLine
, StrStr(CmdLine
, L
"|") - CmdLine
);
1564 if (NextCommandLine
== NULL
|| OurCommandLine
== NULL
) {
1565 SHELL_FREE_NON_NULL(OurCommandLine
);
1566 SHELL_FREE_NON_NULL(NextCommandLine
);
1567 return (EFI_OUT_OF_RESOURCES
);
1568 } else if (StrStr(OurCommandLine
, L
"|") != NULL
|| Size1
== 0 || Size2
== 0) {
1569 SHELL_FREE_NON_NULL(OurCommandLine
);
1570 SHELL_FREE_NON_NULL(NextCommandLine
);
1571 return (EFI_INVALID_PARAMETER
);
1572 } else if (NextCommandLine
[0] != CHAR_NULL
&&
1573 NextCommandLine
[0] == L
'a' &&
1574 NextCommandLine
[1] == L
' '
1576 CopyMem(NextCommandLine
, NextCommandLine
+1, StrSize(NextCommandLine
) - sizeof(NextCommandLine
[0]));
1584 // make a SPLIT_LIST item and add to list
1586 Split
= AllocateZeroPool(sizeof(SPLIT_LIST
));
1587 ASSERT(Split
!= NULL
);
1588 Split
->SplitStdIn
= StdIn
;
1589 Split
->SplitStdOut
= ConvertEfiFileProtocolToShellHandle(CreateFileInterfaceMem(Unicode
), NULL
);
1590 ASSERT(Split
->SplitStdOut
!= NULL
);
1591 InsertHeadList(&ShellInfoObject
.SplitList
.Link
, &Split
->Link
);
1593 Status
= RunCommand(OurCommandLine
);
1596 // move the output from the first to the in to the second.
1598 TempFileHandle
= Split
->SplitStdOut
;
1599 if (Split
->SplitStdIn
== StdIn
) {
1600 Split
->SplitStdOut
= NULL
;
1602 Split
->SplitStdOut
= Split
->SplitStdIn
;
1604 Split
->SplitStdIn
= TempFileHandle
;
1605 ShellInfoObject
.NewEfiShellProtocol
->SetFilePosition(ConvertShellHandleToEfiFileProtocol(Split
->SplitStdIn
), 0);
1607 if (!EFI_ERROR(Status
)) {
1608 Status
= RunCommand(NextCommandLine
);
1612 // remove the top level from the ScriptList
1614 ASSERT((SPLIT_LIST
*)GetFirstNode(&ShellInfoObject
.SplitList
.Link
) == Split
);
1615 RemoveEntryList(&Split
->Link
);
1618 // Note that the original StdIn is now the StdOut...
1620 if (Split
->SplitStdOut
!= NULL
&& Split
->SplitStdOut
!= StdIn
) {
1621 ShellInfoObject
.NewEfiShellProtocol
->CloseFile(ConvertShellHandleToEfiFileProtocol(Split
->SplitStdOut
));
1623 if (Split
->SplitStdIn
!= NULL
) {
1624 ShellInfoObject
.NewEfiShellProtocol
->CloseFile(ConvertShellHandleToEfiFileProtocol(Split
->SplitStdIn
));
1628 FreePool(NextCommandLine
);
1629 FreePool(OurCommandLine
);
1635 Take the original command line, substitute any variables, free
1636 the original string, return the modified copy.
1638 @param[in] CmdLine pointer to the command line to update.
1640 @retval EFI_SUCCESS the function was successful.
1641 @retval EFI_OUT_OF_RESOURCES a memory allocation failed.
1645 ShellSubstituteVariables(
1650 NewCmdLine
= ShellConvertVariables(*CmdLine
);
1651 SHELL_FREE_NON_NULL(*CmdLine
);
1652 if (NewCmdLine
== NULL
) {
1653 return (EFI_OUT_OF_RESOURCES
);
1655 *CmdLine
= NewCmdLine
;
1656 return (EFI_SUCCESS
);
1660 Take the original command line, substitute any alias in the first group of space delimited characters, free
1661 the original string, return the modified copy.
1663 @param[in] CmdLine pointer to the command line to update.
1665 @retval EFI_SUCCESS the function was successful.
1666 @retval EFI_OUT_OF_RESOURCES a memory allocation failed.
1670 ShellSubstituteAliases(
1675 CHAR16
*CommandName
;
1677 UINTN PostAliasSize
;
1678 ASSERT(CmdLine
!= NULL
);
1679 ASSERT(*CmdLine
!= NULL
);
1683 if (StrStr((*CmdLine
), L
" ") == NULL
){
1684 StrnCatGrow(&CommandName
, NULL
, (*CmdLine
), 0);
1686 StrnCatGrow(&CommandName
, NULL
, (*CmdLine
), StrStr((*CmdLine
), L
" ") - (*CmdLine
));
1690 // This cannot happen 'inline' since the CmdLine can need extra space.
1693 if (!ShellCommandIsCommandOnList(CommandName
)) {
1695 // Convert via alias
1697 Status
= ShellConvertAlias(&CommandName
);
1698 if (EFI_ERROR(Status
)){
1702 NewCmdLine
= StrnCatGrow(&NewCmdLine
, &PostAliasSize
, CommandName
, 0);
1703 if (NewCmdLine
== NULL
) {
1704 SHELL_FREE_NON_NULL(CommandName
);
1705 SHELL_FREE_NON_NULL(*CmdLine
);
1706 return (EFI_OUT_OF_RESOURCES
);
1708 NewCmdLine
= StrnCatGrow(&NewCmdLine
, &PostAliasSize
, StrStr((*CmdLine
), L
" "), 0);
1709 if (NewCmdLine
== NULL
) {
1710 SHELL_FREE_NON_NULL(CommandName
);
1711 SHELL_FREE_NON_NULL(*CmdLine
);
1712 return (EFI_OUT_OF_RESOURCES
);
1715 NewCmdLine
= StrnCatGrow(&NewCmdLine
, NULL
, (*CmdLine
), 0);
1718 SHELL_FREE_NON_NULL(*CmdLine
);
1719 SHELL_FREE_NON_NULL(CommandName
);
1722 // re-assign the passed in double pointer to point to our newly allocated buffer
1724 *CmdLine
= NewCmdLine
;
1726 return (EFI_SUCCESS
);
1730 Takes the Argv[0] part of the command line and determine the meaning of it.
1732 @param[in] CmdName pointer to the command line to update.
1734 @retval Internal_Command The name is an internal command.
1735 @retval File_Sys_Change the name is a file system change.
1736 @retval Script_File_Name the name is a NSH script file.
1737 @retval Unknown_Invalid the name is unknown.
1738 @retval Efi_Application the name is an application (.EFI).
1740 SHELL_OPERATION_TYPES
1743 IN CONST CHAR16
*CmdName
1746 CHAR16
* FileWithPath
;
1747 CONST CHAR16
* TempLocation
;
1748 CONST CHAR16
* TempLocation2
;
1750 FileWithPath
= NULL
;
1752 // test for an internal command.
1754 if (ShellCommandIsCommandOnList(CmdName
)) {
1755 return (Internal_Command
);
1759 // Test for file system change request. anything ending with first : and cant have spaces.
1761 if (CmdName
[(StrLen(CmdName
)-1)] == L
':') {
1762 if ( StrStr(CmdName
, L
" ") != NULL
1763 || StrLen(StrStr(CmdName
, L
":")) > 1
1765 return (Unknown_Invalid
);
1767 return (File_Sys_Change
);
1773 if ((FileWithPath
= ShellFindFilePathEx(CmdName
, mExecutableExtensions
)) != NULL
) {
1775 // See if that file has a script file extension
1777 if (StrLen(FileWithPath
) > 4) {
1778 TempLocation
= FileWithPath
+StrLen(FileWithPath
)-4;
1779 TempLocation2
= mScriptExtension
;
1780 if (StringNoCaseCompare((VOID
*)(&TempLocation
), (VOID
*)(&TempLocation2
)) == 0) {
1781 SHELL_FREE_NON_NULL(FileWithPath
);
1782 return (Script_File_Name
);
1787 // Was a file, but not a script. we treat this as an application.
1789 SHELL_FREE_NON_NULL(FileWithPath
);
1790 return (Efi_Application
);
1793 SHELL_FREE_NON_NULL(FileWithPath
);
1795 // No clue what this is... return invalid flag...
1797 return (Unknown_Invalid
);
1801 Determine if the first item in a command line is valid.
1803 @param[in] CmdLine The command line to parse.
1805 @retval EFI_SUCCESS The item is valid.
1806 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
1807 @retval EFI_NOT_FOUND The operation type is unknown or invalid.
1812 IN CONST CHAR16
*CmdLine
1816 CHAR16
*FirstParameter
;
1822 Temp
= StrnCatGrow(&Temp
, NULL
, CmdLine
, 0);
1824 return (EFI_OUT_OF_RESOURCES
);
1827 FirstParameter
= StrStr(Temp
, L
"|");
1828 if (FirstParameter
!= NULL
) {
1829 *FirstParameter
= CHAR_NULL
;
1832 FirstParameter
= NULL
;
1835 // Process the command line
1837 Status
= ProcessCommandLineToFinal(&Temp
);
1839 if (!EFI_ERROR(Status
)) {
1840 FirstParameter
= AllocateZeroPool(StrSize(CmdLine
));
1841 if (FirstParameter
== NULL
) {
1842 SHELL_FREE_NON_NULL(Temp
);
1843 return (EFI_OUT_OF_RESOURCES
);
1845 TempWalker
= (CHAR16
*)Temp
;
1846 if (!EFI_ERROR(GetNextParameter(&TempWalker
, &FirstParameter
, StrSize(CmdLine
)))) {
1847 if (GetOperationType(FirstParameter
) == Unknown_Invalid
) {
1848 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_SHELL_NOT_FOUND
), ShellInfoObject
.HiiHandle
, FirstParameter
);
1849 SetLastError(SHELL_NOT_FOUND
);
1850 Status
= EFI_NOT_FOUND
;
1855 SHELL_FREE_NON_NULL(Temp
);
1856 SHELL_FREE_NON_NULL(FirstParameter
);
1861 Determine if a command line contains with a split contains only valid commands.
1863 @param[in] CmdLine The command line to parse.
1865 @retval EFI_SUCCESS CmdLine has only valid commands, application, or has no split.
1866 @retval EFI_ABORTED CmdLine has at least one invalid command or application.
1871 IN CONST CHAR16
*CmdLine
1874 CONST CHAR16
*TempSpot
;
1878 // Verify up to the pipe or end character
1880 Status
= IsValidSplit(CmdLine
);
1881 if (EFI_ERROR(Status
)) {
1886 // If this was the only item, then get out
1888 if (!ContainsSplit(CmdLine
)) {
1889 return (EFI_SUCCESS
);
1893 // recurse to verify the next item
1895 TempSpot
= FindFirstCharacter(CmdLine
, L
"|", L
'^') + 1;
1896 return (VerifySplit(TempSpot
));
1900 Process a split based operation.
1902 @param[in] CmdLine pointer to the command line to process
1904 @retval EFI_SUCCESS The operation was successful
1905 @return an error occured.
1909 ProcessNewSplitCommandLine(
1910 IN CONST CHAR16
*CmdLine
1916 Status
= VerifySplit(CmdLine
);
1917 if (EFI_ERROR(Status
)) {
1924 // are we in an existing split???
1926 if (!IsListEmpty(&ShellInfoObject
.SplitList
.Link
)) {
1927 Split
= (SPLIT_LIST
*)GetFirstNode(&ShellInfoObject
.SplitList
.Link
);
1930 if (Split
== NULL
) {
1931 Status
= RunSplitCommand(CmdLine
, NULL
, NULL
);
1933 Status
= RunSplitCommand(CmdLine
, Split
->SplitStdIn
, Split
->SplitStdOut
);
1935 if (EFI_ERROR(Status
)) {
1936 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_SHELL_INVALID_SPLIT
), ShellInfoObject
.HiiHandle
, CmdLine
);
1942 Handle a request to change the current file system.
1944 @param[in] CmdLine The passed in command line.
1946 @retval EFI_SUCCESS The operation was successful.
1951 IN CONST CHAR16
*CmdLine
1955 Status
= EFI_SUCCESS
;
1958 // make sure we are the right operation
1960 ASSERT(CmdLine
[(StrLen(CmdLine
)-1)] == L
':' && StrStr(CmdLine
, L
" ") == NULL
);
1963 // Call the protocol API to do the work
1965 Status
= ShellInfoObject
.NewEfiShellProtocol
->SetCurDir(NULL
, CmdLine
);
1968 // Report any errors
1970 if (EFI_ERROR(Status
)) {
1971 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_SHELL_INVALID_MAPPING
), ShellInfoObject
.HiiHandle
, CmdLine
);
1978 Reprocess the command line to direct all -? to the help command.
1980 if found, will add "help" as argv[0], and move the rest later.
1982 @param[in,out] CmdLine pointer to the command line to update
1987 IN OUT CHAR16
**CmdLine
1990 CHAR16
*CurrentParameter
;
1992 CHAR16
*NewCommandLine
;
1995 Status
= EFI_SUCCESS
;
1997 CurrentParameter
= AllocateZeroPool(StrSize(*CmdLine
));
1998 if (CurrentParameter
== NULL
) {
1999 return (EFI_OUT_OF_RESOURCES
);
2003 while(Walker
!= NULL
&& *Walker
!= CHAR_NULL
) {
2004 if (!EFI_ERROR(GetNextParameter(&Walker
, &CurrentParameter
, StrSize(*CmdLine
)))) {
2005 if (StrStr(CurrentParameter
, L
"-?") == CurrentParameter
) {
2006 CurrentParameter
[0] = L
' ';
2007 CurrentParameter
[1] = L
' ';
2008 NewCommandLine
= AllocateZeroPool(StrSize(L
"help ") + StrSize(*CmdLine
));
2009 if (NewCommandLine
== NULL
) {
2010 Status
= EFI_OUT_OF_RESOURCES
;
2015 // We know the space is sufficient since we just calculated it.
2017 StrnCpy(NewCommandLine
, L
"help ", 5);
2018 StrnCat(NewCommandLine
, *CmdLine
, StrLen(*CmdLine
));
2019 SHELL_FREE_NON_NULL(*CmdLine
);
2020 *CmdLine
= NewCommandLine
;
2026 SHELL_FREE_NON_NULL(CurrentParameter
);
2032 Function to update the shell variable "lasterror".
2034 @param[in] ErrorCode the error code to put into lasterror.
2039 IN CONST SHELL_STATUS ErrorCode
2042 CHAR16 LeString
[19];
2043 if (sizeof(EFI_STATUS
) == sizeof(UINT64
)) {
2044 UnicodeSPrint(LeString
, sizeof(LeString
), L
"0x%Lx", ErrorCode
);
2046 UnicodeSPrint(LeString
, sizeof(LeString
), L
"0x%x", ErrorCode
);
2048 DEBUG_CODE(InternalEfiShellSetEnv(L
"debuglasterror", LeString
, TRUE
););
2049 InternalEfiShellSetEnv(L
"lasterror", LeString
, TRUE
);
2051 return (EFI_SUCCESS
);
2055 Converts the command line to it's post-processed form. this replaces variables and alias' per UEFI Shell spec.
2057 @param[in,out] CmdLine pointer to the command line to update
2059 @retval EFI_SUCCESS The operation was successful
2060 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
2061 @return some other error occured
2065 ProcessCommandLineToFinal(
2066 IN OUT CHAR16
**CmdLine
2070 TrimSpaces(CmdLine
);
2072 Status
= ShellSubstituteAliases(CmdLine
);
2073 if (EFI_ERROR(Status
)) {
2077 TrimSpaces(CmdLine
);
2079 Status
= ShellSubstituteVariables(CmdLine
);
2080 if (EFI_ERROR(Status
)) {
2083 ASSERT (*CmdLine
!= NULL
);
2085 TrimSpaces(CmdLine
);
2088 // update for help parsing
2090 if (StrStr(*CmdLine
, L
"?") != NULL
) {
2092 // This may do nothing if the ? does not indicate help.
2093 // Save all the details for in the API below.
2095 Status
= DoHelpUpdate(CmdLine
);
2098 TrimSpaces(CmdLine
);
2100 return (EFI_SUCCESS
);
2104 Run an internal shell command.
2106 This API will upadate the shell's environment since these commands are libraries.
2108 @param[in] CmdLine the command line to run.
2109 @param[in] FirstParameter the first parameter on the command line
2110 @param[in] ParamProtocol the shell parameters protocol pointer
2112 @retval EFI_SUCCESS The command was completed.
2113 @retval EFI_ABORTED The command's operation was aborted.
2118 IN CONST CHAR16
*CmdLine
,
2119 IN CHAR16
*FirstParameter
,
2120 IN EFI_SHELL_PARAMETERS_PROTOCOL
*ParamProtocol
2126 SHELL_STATUS CommandReturnedStatus
;
2131 NewCmdLine
= AllocateCopyPool (StrSize (CmdLine
), CmdLine
);
2132 if (NewCmdLine
== NULL
) {
2133 return EFI_OUT_OF_RESOURCES
;
2136 for (Walker
= NewCmdLine
; Walker
!= NULL
&& *Walker
!= CHAR_NULL
; Walker
++) {
2137 if (*Walker
== L
'^' && *(Walker
+1) == L
'#') {
2138 CopyMem(Walker
, Walker
+1, StrSize(Walker
) - sizeof(Walker
[0]));
2143 // get the argc and argv updated for internal commands
2145 Status
= UpdateArgcArgv(ParamProtocol
, NewCmdLine
, &Argv
, &Argc
);
2146 if (!EFI_ERROR(Status
)) {
2148 // Run the internal command.
2150 Status
= ShellCommandRunCommandHandler(FirstParameter
, &CommandReturnedStatus
, &LastError
);
2152 if (!EFI_ERROR(Status
)) {
2154 // Update last error status.
2155 // some commands do not update last error.
2158 SetLastError(CommandReturnedStatus
);
2162 // Pass thru the exitcode from the app.
2164 if (ShellCommandGetExit()) {
2166 // An Exit was requested ("exit" command), pass its value up.
2168 Status
= CommandReturnedStatus
;
2169 } else if (CommandReturnedStatus
!= SHELL_SUCCESS
&& IsScriptOnlyCommand(FirstParameter
)) {
2171 // Always abort when a script only command fails for any reason
2173 Status
= EFI_ABORTED
;
2174 } else if (ShellCommandGetCurrentScriptFile() != NULL
&& CommandReturnedStatus
== SHELL_ABORTED
) {
2176 // Abort when in a script and a command aborted
2178 Status
= EFI_ABORTED
;
2184 // This is guarenteed to be called after UpdateArgcArgv no matter what else happened.
2185 // This is safe even if the update API failed. In this case, it may be a no-op.
2187 RestoreArgcArgv(ParamProtocol
, &Argv
, &Argc
);
2190 // If a script is running and the command is not a scipt only command, then
2191 // change return value to success so the script won't halt (unless aborted).
2193 // Script only commands have to be able halt the script since the script will
2194 // not operate if they are failing.
2196 if ( ShellCommandGetCurrentScriptFile() != NULL
2197 && !IsScriptOnlyCommand(FirstParameter
)
2198 && Status
!= EFI_ABORTED
2200 Status
= EFI_SUCCESS
;
2203 FreePool (NewCmdLine
);
2208 Function to run the command or file.
2210 @param[in] Type the type of operation being run.
2211 @param[in] CmdLine the command line to run.
2212 @param[in] FirstParameter the first parameter on the command line
2213 @param[in] ParamProtocol the shell parameters protocol pointer
2215 @retval EFI_SUCCESS The command was completed.
2216 @retval EFI_ABORTED The command's operation was aborted.
2221 IN SHELL_OPERATION_TYPES Type
,
2222 IN CONST CHAR16
*CmdLine
,
2223 IN CHAR16
*FirstParameter
,
2224 IN EFI_SHELL_PARAMETERS_PROTOCOL
*ParamProtocol
2228 EFI_STATUS StartStatus
;
2229 CHAR16
*CommandWithPath
;
2230 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
2231 SHELL_STATUS CalleeExitStatus
;
2233 Status
= EFI_SUCCESS
;
2234 CommandWithPath
= NULL
;
2236 CalleeExitStatus
= SHELL_INVALID_PARAMETER
;
2239 case Internal_Command
:
2240 Status
= RunInternalCommand(CmdLine
, FirstParameter
, ParamProtocol
);
2242 case Script_File_Name
:
2243 case Efi_Application
:
2245 // Process a fully qualified path
2247 if (StrStr(FirstParameter
, L
":") != NULL
) {
2248 ASSERT (CommandWithPath
== NULL
);
2249 if (ShellIsFile(FirstParameter
) == EFI_SUCCESS
) {
2250 CommandWithPath
= StrnCatGrow(&CommandWithPath
, NULL
, FirstParameter
, 0);
2255 // Process a relative path and also check in the path environment variable
2257 if (CommandWithPath
== NULL
) {
2258 CommandWithPath
= ShellFindFilePathEx(FirstParameter
, mExecutableExtensions
);
2262 // This should be impossible now.
2264 ASSERT(CommandWithPath
!= NULL
);
2267 // Make sure that path is not just a directory (or not found)
2269 if (!EFI_ERROR(ShellIsDirectory(CommandWithPath
))) {
2270 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_SHELL_NOT_FOUND
), ShellInfoObject
.HiiHandle
, FirstParameter
);
2271 SetLastError(SHELL_NOT_FOUND
);
2274 case Script_File_Name
:
2275 Status
= RunScriptFile (CommandWithPath
, NULL
, CmdLine
, ParamProtocol
);
2277 case Efi_Application
:
2279 // Get the device path of the application image
2281 DevPath
= ShellInfoObject
.NewEfiShellProtocol
->GetDevicePathFromFilePath(CommandWithPath
);
2282 if (DevPath
== NULL
){
2283 Status
= EFI_OUT_OF_RESOURCES
;
2288 // Execute the device path
2290 Status
= InternalShellExecuteDevicePath(
2298 SHELL_FREE_NON_NULL(DevPath
);
2300 if(EFI_ERROR (Status
)) {
2301 CalleeExitStatus
= (SHELL_STATUS
) (Status
& (~MAX_BIT
));
2303 CalleeExitStatus
= (SHELL_STATUS
) StartStatus
;
2307 // Update last error status.
2309 // Status is an EFI_STATUS. Clear top bit to convert to SHELL_STATUS
2310 SetLastError(CalleeExitStatus
);
2326 SHELL_FREE_NON_NULL(CommandWithPath
);
2332 Function to setup StdIn, StdErr, StdOut, and then run the command or file.
2334 @param[in] Type the type of operation being run.
2335 @param[in] CmdLine the command line to run.
2336 @param[in] FirstParameter the first parameter on the command line.
2337 @param[in] ParamProtocol the shell parameters protocol pointer
2339 @retval EFI_SUCCESS The command was completed.
2340 @retval EFI_ABORTED The command's operation was aborted.
2344 SetupAndRunCommandOrFile(
2345 IN SHELL_OPERATION_TYPES Type
,
2347 IN CHAR16
*FirstParameter
,
2348 IN EFI_SHELL_PARAMETERS_PROTOCOL
*ParamProtocol
2352 SHELL_FILE_HANDLE OriginalStdIn
;
2353 SHELL_FILE_HANDLE OriginalStdOut
;
2354 SHELL_FILE_HANDLE OriginalStdErr
;
2355 SYSTEM_TABLE_INFO OriginalSystemTableInfo
;
2358 // Update the StdIn, StdOut, and StdErr for redirection to environment variables, files, etc... unicode and ASCII
2360 Status
= UpdateStdInStdOutStdErr(ParamProtocol
, CmdLine
, &OriginalStdIn
, &OriginalStdOut
, &OriginalStdErr
, &OriginalSystemTableInfo
);
2363 // The StdIn, StdOut, and StdErr are set up.
2364 // Now run the command, script, or application
2366 if (!EFI_ERROR(Status
)) {
2367 TrimSpaces(&CmdLine
);
2368 Status
= RunCommandOrFile(Type
, CmdLine
, FirstParameter
, ParamProtocol
);
2374 if (EFI_ERROR(Status
)) {
2375 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_SHELL_ERROR
), ShellInfoObject
.HiiHandle
, (VOID
*)(Status
));
2379 // put back the original StdIn, StdOut, and StdErr
2381 RestoreStdInStdOutStdErr(ParamProtocol
, &OriginalStdIn
, &OriginalStdOut
, &OriginalStdErr
, &OriginalSystemTableInfo
);
2387 Function will process and run a command line.
2389 This will determine if the command line represents an internal shell
2390 command or dispatch an external application.
2392 @param[in] CmdLine The command line to parse.
2394 @retval EFI_SUCCESS The command was completed.
2395 @retval EFI_ABORTED The command's operation was aborted.
2400 IN CONST CHAR16
*CmdLine
2404 CHAR16
*CleanOriginal
;
2405 CHAR16
*FirstParameter
;
2407 SHELL_OPERATION_TYPES Type
;
2409 ASSERT(CmdLine
!= NULL
);
2410 if (StrLen(CmdLine
) == 0) {
2411 return (EFI_SUCCESS
);
2414 Status
= EFI_SUCCESS
;
2415 CleanOriginal
= NULL
;
2417 CleanOriginal
= StrnCatGrow(&CleanOriginal
, NULL
, CmdLine
, 0);
2418 if (CleanOriginal
== NULL
) {
2419 return (EFI_OUT_OF_RESOURCES
);
2422 TrimSpaces(&CleanOriginal
);
2425 // NULL out comments (leveraged from RunScriptFileHandle() ).
2426 // The # character on a line is used to denote that all characters on the same line
2427 // and to the right of the # are to be ignored by the shell.
2428 // Afterward, again remove spaces, in case any were between the last command-parameter and '#'.
2430 for (TempWalker
= CleanOriginal
; TempWalker
!= NULL
&& *TempWalker
!= CHAR_NULL
; TempWalker
++) {
2431 if (*TempWalker
== L
'^') {
2432 if (*(TempWalker
+ 1) == L
'#') {
2435 } else if (*TempWalker
== L
'#') {
2436 *TempWalker
= CHAR_NULL
;
2440 TrimSpaces(&CleanOriginal
);
2443 // Handle case that passed in command line is just 1 or more " " characters.
2445 if (StrLen (CleanOriginal
) == 0) {
2446 SHELL_FREE_NON_NULL(CleanOriginal
);
2447 return (EFI_SUCCESS
);
2450 Status
= ProcessCommandLineToFinal(&CleanOriginal
);
2451 if (EFI_ERROR(Status
)) {
2452 SHELL_FREE_NON_NULL(CleanOriginal
);
2457 // We dont do normal processing with a split command line (output from one command input to another)
2459 if (ContainsSplit(CleanOriginal
)) {
2460 Status
= ProcessNewSplitCommandLine(CleanOriginal
);
2461 SHELL_FREE_NON_NULL(CleanOriginal
);
2466 // We need the first parameter information so we can determine the operation type
2468 FirstParameter
= AllocateZeroPool(StrSize(CleanOriginal
));
2469 if (FirstParameter
== NULL
) {
2470 SHELL_FREE_NON_NULL(CleanOriginal
);
2471 return (EFI_OUT_OF_RESOURCES
);
2473 TempWalker
= CleanOriginal
;
2474 if (!EFI_ERROR(GetNextParameter(&TempWalker
, &FirstParameter
, StrSize(CleanOriginal
)))) {
2476 // Depending on the first parameter we change the behavior
2478 switch (Type
= GetOperationType(FirstParameter
)) {
2479 case File_Sys_Change
:
2480 Status
= ChangeMappedDrive (FirstParameter
);
2482 case Internal_Command
:
2483 case Script_File_Name
:
2484 case Efi_Application
:
2485 Status
= SetupAndRunCommandOrFile(Type
, CleanOriginal
, FirstParameter
, ShellInfoObject
.NewShellParametersProtocol
);
2489 // Whatever was typed, it was invalid.
2491 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_SHELL_NOT_FOUND
), ShellInfoObject
.HiiHandle
, FirstParameter
);
2492 SetLastError(SHELL_NOT_FOUND
);
2496 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_SHELL_NOT_FOUND
), ShellInfoObject
.HiiHandle
, FirstParameter
);
2497 SetLastError(SHELL_NOT_FOUND
);
2500 SHELL_FREE_NON_NULL(CleanOriginal
);
2501 SHELL_FREE_NON_NULL(FirstParameter
);
2506 STATIC CONST UINT16 InvalidChars
[] = {L
'*', L
'?', L
'<', L
'>', L
'\\', L
'/', L
'\"', 0x0001, 0x0002};
2508 Function determins if the CommandName COULD be a valid command. It does not determine whether
2509 this is a valid command. It only checks for invalid characters.
2511 @param[in] CommandName The name to check
2513 @retval TRUE CommandName could be a command name
2514 @retval FALSE CommandName could not be a valid command name
2519 IN CONST CHAR16
*CommandName
2523 if (CommandName
== NULL
) {
2528 ; Count
< sizeof(InvalidChars
) / sizeof(InvalidChars
[0])
2531 if (ScanMem16(CommandName
, StrSize(CommandName
), InvalidChars
[Count
]) != NULL
) {
2539 Function to process a NSH script file via SHELL_FILE_HANDLE.
2541 @param[in] Handle The handle to the already opened file.
2542 @param[in] Name The name of the script file.
2544 @retval EFI_SUCCESS the script completed sucessfully
2548 RunScriptFileHandle (
2549 IN SHELL_FILE_HANDLE Handle
,
2550 IN CONST CHAR16
*Name
2554 SCRIPT_FILE
*NewScriptFile
;
2556 CHAR16
*CommandLine
;
2557 CHAR16
*CommandLine2
;
2558 CHAR16
*CommandLine3
;
2559 SCRIPT_COMMAND_LIST
*LastCommand
;
2561 BOOLEAN PreScriptEchoState
;
2562 BOOLEAN PreCommandEchoState
;
2563 CONST CHAR16
*CurDir
;
2565 CHAR16 LeString
[50];
2567 ASSERT(!ShellCommandGetScriptExit());
2569 PreScriptEchoState
= ShellCommandGetEchoState();
2571 NewScriptFile
= (SCRIPT_FILE
*)AllocateZeroPool(sizeof(SCRIPT_FILE
));
2572 if (NewScriptFile
== NULL
) {
2573 return (EFI_OUT_OF_RESOURCES
);
2579 ASSERT(NewScriptFile
->ScriptName
== NULL
);
2580 NewScriptFile
->ScriptName
= StrnCatGrow(&NewScriptFile
->ScriptName
, NULL
, Name
, 0);
2581 if (NewScriptFile
->ScriptName
== NULL
) {
2582 DeleteScriptFileStruct(NewScriptFile
);
2583 return (EFI_OUT_OF_RESOURCES
);
2587 // Save the parameters (used to replace %0 to %9 later on)
2589 NewScriptFile
->Argc
= ShellInfoObject
.NewShellParametersProtocol
->Argc
;
2590 if (NewScriptFile
->Argc
!= 0) {
2591 NewScriptFile
->Argv
= (CHAR16
**)AllocateZeroPool(NewScriptFile
->Argc
* sizeof(CHAR16
*));
2592 if (NewScriptFile
->Argv
== NULL
) {
2593 DeleteScriptFileStruct(NewScriptFile
);
2594 return (EFI_OUT_OF_RESOURCES
);
2596 for (LoopVar
= 0 ; LoopVar
< 10 && LoopVar
< NewScriptFile
->Argc
; LoopVar
++) {
2597 ASSERT(NewScriptFile
->Argv
[LoopVar
] == NULL
);
2598 NewScriptFile
->Argv
[LoopVar
] = StrnCatGrow(&NewScriptFile
->Argv
[LoopVar
], NULL
, ShellInfoObject
.NewShellParametersProtocol
->Argv
[LoopVar
], 0);
2599 if (NewScriptFile
->Argv
[LoopVar
] == NULL
) {
2600 DeleteScriptFileStruct(NewScriptFile
);
2601 return (EFI_OUT_OF_RESOURCES
);
2605 NewScriptFile
->Argv
= NULL
;
2608 InitializeListHead(&NewScriptFile
->CommandList
);
2609 InitializeListHead(&NewScriptFile
->SubstList
);
2612 // Now build the list of all script commands.
2615 while(!ShellFileHandleEof(Handle
)) {
2616 CommandLine
= ShellFileHandleReturnLine(Handle
, &Ascii
);
2618 if (CommandLine
== NULL
|| StrLen(CommandLine
) == 0 || CommandLine
[0] == '#') {
2619 SHELL_FREE_NON_NULL(CommandLine
);
2622 NewScriptFile
->CurrentCommand
= AllocateZeroPool(sizeof(SCRIPT_COMMAND_LIST
));
2623 if (NewScriptFile
->CurrentCommand
== NULL
) {
2624 SHELL_FREE_NON_NULL(CommandLine
);
2625 DeleteScriptFileStruct(NewScriptFile
);
2626 return (EFI_OUT_OF_RESOURCES
);
2629 NewScriptFile
->CurrentCommand
->Cl
= CommandLine
;
2630 NewScriptFile
->CurrentCommand
->Data
= NULL
;
2631 NewScriptFile
->CurrentCommand
->Line
= LineCount
;
2633 InsertTailList(&NewScriptFile
->CommandList
, &NewScriptFile
->CurrentCommand
->Link
);
2637 // Add this as the topmost script file
2639 ShellCommandSetNewScript (NewScriptFile
);
2642 // Now enumerate through the commands and run each one.
2644 CommandLine
= AllocateZeroPool(PcdGet16(PcdShellPrintBufferSize
));
2645 if (CommandLine
== NULL
) {
2646 DeleteScriptFileStruct(NewScriptFile
);
2647 return (EFI_OUT_OF_RESOURCES
);
2649 CommandLine2
= AllocateZeroPool(PcdGet16(PcdShellPrintBufferSize
));
2650 if (CommandLine2
== NULL
) {
2651 FreePool(CommandLine
);
2652 DeleteScriptFileStruct(NewScriptFile
);
2653 return (EFI_OUT_OF_RESOURCES
);
2656 for ( NewScriptFile
->CurrentCommand
= (SCRIPT_COMMAND_LIST
*)GetFirstNode(&NewScriptFile
->CommandList
)
2657 ; !IsNull(&NewScriptFile
->CommandList
, &NewScriptFile
->CurrentCommand
->Link
)
2658 ; // conditional increment in the body of the loop
2660 ASSERT(CommandLine2
!= NULL
);
2661 StrnCpy(CommandLine2
, NewScriptFile
->CurrentCommand
->Cl
, PcdGet16(PcdShellPrintBufferSize
)/sizeof(CHAR16
)-1);
2664 // NULL out comments
2666 for (CommandLine3
= CommandLine2
; CommandLine3
!= NULL
&& *CommandLine3
!= CHAR_NULL
; CommandLine3
++) {
2667 if (*CommandLine3
== L
'^') {
2668 if ( *(CommandLine3
+1) == L
':') {
2669 CopyMem(CommandLine3
, CommandLine3
+1, StrSize(CommandLine3
) - sizeof(CommandLine3
[0]));
2670 } else if (*(CommandLine3
+1) == L
'#') {
2673 } else if (*CommandLine3
== L
'#') {
2674 *CommandLine3
= CHAR_NULL
;
2678 if (CommandLine2
!= NULL
&& StrLen(CommandLine2
) >= 1) {
2680 // Due to variability in starting the find and replace action we need to have both buffers the same.
2682 StrnCpy(CommandLine
, CommandLine2
, PcdGet16(PcdShellPrintBufferSize
)/sizeof(CHAR16
)-1);
2685 // Remove the %0 to %9 from the command line (if we have some arguments)
2687 if (NewScriptFile
->Argv
!= NULL
) {
2688 switch (NewScriptFile
->Argc
) {
2690 Status
= ShellCopySearchAndReplace(CommandLine2
, CommandLine
, PcdGet16 (PcdShellPrintBufferSize
), L
"%9", NewScriptFile
->Argv
[9], FALSE
, TRUE
);
2691 ASSERT_EFI_ERROR(Status
);
2693 Status
= ShellCopySearchAndReplace(CommandLine
, CommandLine2
, PcdGet16 (PcdShellPrintBufferSize
), L
"%8", NewScriptFile
->Argv
[8], FALSE
, TRUE
);
2694 ASSERT_EFI_ERROR(Status
);
2696 Status
= ShellCopySearchAndReplace(CommandLine2
, CommandLine
, PcdGet16 (PcdShellPrintBufferSize
), L
"%7", NewScriptFile
->Argv
[7], FALSE
, TRUE
);
2697 ASSERT_EFI_ERROR(Status
);
2699 Status
= ShellCopySearchAndReplace(CommandLine
, CommandLine2
, PcdGet16 (PcdShellPrintBufferSize
), L
"%6", NewScriptFile
->Argv
[6], FALSE
, TRUE
);
2700 ASSERT_EFI_ERROR(Status
);
2702 Status
= ShellCopySearchAndReplace(CommandLine2
, CommandLine
, PcdGet16 (PcdShellPrintBufferSize
), L
"%5", NewScriptFile
->Argv
[5], FALSE
, TRUE
);
2703 ASSERT_EFI_ERROR(Status
);
2705 Status
= ShellCopySearchAndReplace(CommandLine
, CommandLine2
, PcdGet16 (PcdShellPrintBufferSize
), L
"%4", NewScriptFile
->Argv
[4], FALSE
, TRUE
);
2706 ASSERT_EFI_ERROR(Status
);
2708 Status
= ShellCopySearchAndReplace(CommandLine2
, CommandLine
, PcdGet16 (PcdShellPrintBufferSize
), L
"%3", NewScriptFile
->Argv
[3], FALSE
, TRUE
);
2709 ASSERT_EFI_ERROR(Status
);
2711 Status
= ShellCopySearchAndReplace(CommandLine
, CommandLine2
, PcdGet16 (PcdShellPrintBufferSize
), L
"%2", NewScriptFile
->Argv
[2], FALSE
, TRUE
);
2712 ASSERT_EFI_ERROR(Status
);
2714 Status
= ShellCopySearchAndReplace(CommandLine2
, CommandLine
, PcdGet16 (PcdShellPrintBufferSize
), L
"%1", NewScriptFile
->Argv
[1], FALSE
, TRUE
);
2715 ASSERT_EFI_ERROR(Status
);
2717 Status
= ShellCopySearchAndReplace(CommandLine
, CommandLine2
, PcdGet16 (PcdShellPrintBufferSize
), L
"%0", NewScriptFile
->Argv
[0], FALSE
, TRUE
);
2718 ASSERT_EFI_ERROR(Status
);
2724 Status
= ShellCopySearchAndReplace(CommandLine2
, CommandLine
, PcdGet16 (PcdShellPrintBufferSize
), L
"%1", L
"\"\"", FALSE
, FALSE
);
2725 Status
= ShellCopySearchAndReplace(CommandLine
, CommandLine2
, PcdGet16 (PcdShellPrintBufferSize
), L
"%2", L
"\"\"", FALSE
, FALSE
);
2726 Status
= ShellCopySearchAndReplace(CommandLine2
, CommandLine
, PcdGet16 (PcdShellPrintBufferSize
), L
"%3", L
"\"\"", FALSE
, FALSE
);
2727 Status
= ShellCopySearchAndReplace(CommandLine
, CommandLine2
, PcdGet16 (PcdShellPrintBufferSize
), L
"%4", L
"\"\"", FALSE
, FALSE
);
2728 Status
= ShellCopySearchAndReplace(CommandLine2
, CommandLine
, PcdGet16 (PcdShellPrintBufferSize
), L
"%5", L
"\"\"", FALSE
, FALSE
);
2729 Status
= ShellCopySearchAndReplace(CommandLine
, CommandLine2
, PcdGet16 (PcdShellPrintBufferSize
), L
"%6", L
"\"\"", FALSE
, FALSE
);
2730 Status
= ShellCopySearchAndReplace(CommandLine2
, CommandLine
, PcdGet16 (PcdShellPrintBufferSize
), L
"%7", L
"\"\"", FALSE
, FALSE
);
2731 Status
= ShellCopySearchAndReplace(CommandLine
, CommandLine2
, PcdGet16 (PcdShellPrintBufferSize
), L
"%8", L
"\"\"", FALSE
, FALSE
);
2732 Status
= ShellCopySearchAndReplace(CommandLine2
, CommandLine
, PcdGet16 (PcdShellPrintBufferSize
), L
"%9", L
"\"\"", FALSE
, FALSE
);
2734 StrnCpy(CommandLine2
, CommandLine
, PcdGet16(PcdShellPrintBufferSize
)/sizeof(CHAR16
)-1);
2736 LastCommand
= NewScriptFile
->CurrentCommand
;
2738 for (CommandLine3
= CommandLine2
; CommandLine3
[0] == L
' ' ; CommandLine3
++);
2740 if (CommandLine3
!= NULL
&& CommandLine3
[0] == L
':' ) {
2742 // This line is a goto target / label
2745 if (CommandLine3
!= NULL
&& StrLen(CommandLine3
) > 0) {
2746 if (CommandLine3
[0] == L
'@') {
2748 // We need to save the current echo state
2749 // and disable echo for just this command.
2751 PreCommandEchoState
= ShellCommandGetEchoState();
2752 ShellCommandSetEchoState(FALSE
);
2753 Status
= RunCommand(CommandLine3
+1);
2756 // If command was "@echo -off" or "@echo -on" then don't restore echo state
2758 if (StrCmp (L
"@echo -off", CommandLine3
) != 0 &&
2759 StrCmp (L
"@echo -on", CommandLine3
) != 0) {
2761 // Now restore the pre-'@' echo state.
2763 ShellCommandSetEchoState(PreCommandEchoState
);
2766 if (ShellCommandGetEchoState()) {
2767 CurDir
= ShellInfoObject
.NewEfiShellProtocol
->GetEnv(L
"cwd");
2768 if (CurDir
!= NULL
&& StrLen(CurDir
) > 1) {
2769 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_SHELL_CURDIR
), ShellInfoObject
.HiiHandle
, CurDir
);
2771 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_SHELL_SHELL
), ShellInfoObject
.HiiHandle
);
2773 ShellPrintEx(-1, -1, L
"%s\r\n", CommandLine2
);
2775 Status
= RunCommand(CommandLine3
);
2779 if (ShellCommandGetScriptExit()) {
2781 // ShellCommandGetExitCode() always returns a UINT64
2783 UnicodeSPrint(LeString
, sizeof(LeString
), L
"0x%Lx", ShellCommandGetExitCode());
2784 DEBUG_CODE(InternalEfiShellSetEnv(L
"debuglasterror", LeString
, TRUE
););
2785 InternalEfiShellSetEnv(L
"lasterror", LeString
, TRUE
);
2787 ShellCommandRegisterExit(FALSE
, 0);
2788 Status
= EFI_SUCCESS
;
2791 if (ShellGetExecutionBreakFlag()) {
2794 if (EFI_ERROR(Status
)) {
2797 if (ShellCommandGetExit()) {
2802 // If that commend did not update the CurrentCommand then we need to advance it...
2804 if (LastCommand
== NewScriptFile
->CurrentCommand
) {
2805 NewScriptFile
->CurrentCommand
= (SCRIPT_COMMAND_LIST
*)GetNextNode(&NewScriptFile
->CommandList
, &NewScriptFile
->CurrentCommand
->Link
);
2806 if (!IsNull(&NewScriptFile
->CommandList
, &NewScriptFile
->CurrentCommand
->Link
)) {
2807 NewScriptFile
->CurrentCommand
->Reset
= TRUE
;
2811 NewScriptFile
->CurrentCommand
= (SCRIPT_COMMAND_LIST
*)GetNextNode(&NewScriptFile
->CommandList
, &NewScriptFile
->CurrentCommand
->Link
);
2812 if (!IsNull(&NewScriptFile
->CommandList
, &NewScriptFile
->CurrentCommand
->Link
)) {
2813 NewScriptFile
->CurrentCommand
->Reset
= TRUE
;
2819 FreePool(CommandLine
);
2820 FreePool(CommandLine2
);
2821 ShellCommandSetNewScript (NULL
);
2824 // Only if this was the last script reset the state.
2826 if (ShellCommandGetCurrentScriptFile()==NULL
) {
2827 ShellCommandSetEchoState(PreScriptEchoState
);
2829 return (EFI_SUCCESS
);
2833 Function to process a NSH script file.
2835 @param[in] ScriptPath Pointer to the script file name (including file system path).
2836 @param[in] Handle the handle of the script file already opened.
2837 @param[in] CmdLine the command line to run.
2838 @param[in] ParamProtocol the shell parameters protocol pointer
2840 @retval EFI_SUCCESS the script completed sucessfully
2845 IN CONST CHAR16
*ScriptPath
,
2846 IN SHELL_FILE_HANDLE Handle OPTIONAL
,
2847 IN CONST CHAR16
*CmdLine
,
2848 IN EFI_SHELL_PARAMETERS_PROTOCOL
*ParamProtocol
2852 SHELL_FILE_HANDLE FileHandle
;
2856 if (ShellIsFile(ScriptPath
) != EFI_SUCCESS
) {
2857 return (EFI_INVALID_PARAMETER
);
2861 // get the argc and argv updated for scripts
2863 Status
= UpdateArgcArgv(ParamProtocol
, CmdLine
, &Argv
, &Argc
);
2864 if (!EFI_ERROR(Status
)) {
2866 if (Handle
== NULL
) {
2870 Status
= ShellOpenFileByName(ScriptPath
, &FileHandle
, EFI_FILE_MODE_READ
, 0);
2871 if (!EFI_ERROR(Status
)) {
2875 Status
= RunScriptFileHandle(FileHandle
, ScriptPath
);
2878 // now close the file
2880 ShellCloseFile(&FileHandle
);
2883 Status
= RunScriptFileHandle(Handle
, ScriptPath
);
2888 // This is guarenteed to be called after UpdateArgcArgv no matter what else happened.
2889 // This is safe even if the update API failed. In this case, it may be a no-op.
2891 RestoreArgcArgv(ParamProtocol
, &Argv
, &Argc
);
2897 Return the pointer to the first occurance of any character from a list of characters.
2899 @param[in] String the string to parse
2900 @param[in] CharacterList the list of character to look for
2901 @param[in] EscapeCharacter An escape character to skip
2903 @return the location of the first character in the string
2904 @retval CHAR_NULL no instance of any character in CharacterList was found in String
2909 IN CONST CHAR16
*String
,
2910 IN CONST CHAR16
*CharacterList
,
2911 IN CONST CHAR16 EscapeCharacter
2917 for (WalkStr
= 0; WalkStr
< StrLen(String
); WalkStr
++) {
2918 if (String
[WalkStr
] == EscapeCharacter
) {
2922 for (WalkChar
= 0; WalkChar
< StrLen(CharacterList
); WalkChar
++) {
2923 if (String
[WalkStr
] == CharacterList
[WalkChar
]) {
2924 return (&String
[WalkStr
]);
2928 return (String
+ StrLen(String
));