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 don't 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 environment 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 memory 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 successfully.
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 successful return the device path to the loaded image.
773 @param[in, out] FilePath On a successful return the device path to the file.
775 @retval EFI_SUCCESS The 2 device paths were successfully 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 // Unrecognized 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 StrCpyS(FileStringPath
, NewSize
/sizeof(CHAR16
), ShellInfoObject
.ShellInitSettings
.FileName
);
1083 if (ShellInfoObject
.ShellInitSettings
.FileOptions
!= NULL
) {
1084 StrnCatS(FileStringPath
, NewSize
/sizeof(CHAR16
), L
" ", NewSize
/sizeof(CHAR16
) - StrLen(FileStringPath
) -1);
1085 StrnCatS(FileStringPath
, NewSize
/sizeof(CHAR16
), 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 don't 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 don't 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 // don't 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 occurred.
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 preceding and if there is space no ^ preceding (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 preceding and following % and if there is space no ^ preceding (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
1492 ((ItemSize
+(2*sizeof(CHAR16
)))/sizeof(CHAR16
)),
1496 ((ItemSize
+(2*sizeof(CHAR16
)))/sizeof(CHAR16
)),
1500 ((ItemSize
+(2*sizeof(CHAR16
)))/sizeof(CHAR16
)),
1503 ShellCopySearchAndReplace(NewCommandLine1
, NewCommandLine2
, NewSize
, ItemTemp
, EfiShellGetEnv(MasterEnvList
), TRUE
, FALSE
);
1504 StrCpyS(NewCommandLine1
, NewSize
/sizeof(CHAR16
), NewCommandLine2
);
1506 if (CurrentScriptFile
!= NULL
) {
1507 for (AliasListNode
= (ALIAS_LIST
*)GetFirstNode(&CurrentScriptFile
->SubstList
)
1508 ; !IsNull(&CurrentScriptFile
->SubstList
, &AliasListNode
->Link
)
1509 ; AliasListNode
= (ALIAS_LIST
*)GetNextNode(&CurrentScriptFile
->SubstList
, &AliasListNode
->Link
)
1511 ShellCopySearchAndReplace(NewCommandLine1
, NewCommandLine2
, NewSize
, AliasListNode
->Alias
, AliasListNode
->CommandString
, TRUE
, FALSE
);
1512 StrCpyS(NewCommandLine1
, NewSize
/sizeof(CHAR16
), NewCommandLine2
);
1517 // Remove non-existent environment variables
1519 StripUnreplacedEnvironmentVariables(NewCommandLine1
);
1522 // Now cleanup any straggler intentionally ignored "%" characters
1524 ShellCopySearchAndReplace(NewCommandLine1
, NewCommandLine2
, NewSize
, L
"^%", L
"%", TRUE
, FALSE
);
1525 StrCpyS(NewCommandLine1
, NewSize
/sizeof(CHAR16
), NewCommandLine2
);
1527 FreePool(NewCommandLine2
);
1530 return (NewCommandLine1
);
1534 Internal function to run a command line with pipe usage.
1536 @param[in] CmdLine The pointer to the command line.
1537 @param[in] StdIn The pointer to the Standard input.
1538 @param[in] StdOut The pointer to the Standard output.
1540 @retval EFI_SUCCESS The split command is executed successfully.
1541 @retval other Some error occurs when executing the split command.
1546 IN CONST CHAR16
*CmdLine
,
1547 IN SHELL_FILE_HANDLE
*StdIn
,
1548 IN SHELL_FILE_HANDLE
*StdOut
1552 CHAR16
*NextCommandLine
;
1553 CHAR16
*OurCommandLine
;
1557 SHELL_FILE_HANDLE
*TempFileHandle
;
1560 ASSERT(StdOut
== NULL
);
1562 ASSERT(StrStr(CmdLine
, L
"|") != NULL
);
1564 Status
= EFI_SUCCESS
;
1565 NextCommandLine
= NULL
;
1566 OurCommandLine
= NULL
;
1570 NextCommandLine
= StrnCatGrow(&NextCommandLine
, &Size1
, StrStr(CmdLine
, L
"|")+1, 0);
1571 OurCommandLine
= StrnCatGrow(&OurCommandLine
, &Size2
, CmdLine
, StrStr(CmdLine
, L
"|") - CmdLine
);
1573 if (NextCommandLine
== NULL
|| OurCommandLine
== NULL
) {
1574 SHELL_FREE_NON_NULL(OurCommandLine
);
1575 SHELL_FREE_NON_NULL(NextCommandLine
);
1576 return (EFI_OUT_OF_RESOURCES
);
1577 } else if (StrStr(OurCommandLine
, L
"|") != NULL
|| Size1
== 0 || Size2
== 0) {
1578 SHELL_FREE_NON_NULL(OurCommandLine
);
1579 SHELL_FREE_NON_NULL(NextCommandLine
);
1580 return (EFI_INVALID_PARAMETER
);
1581 } else if (NextCommandLine
[0] != CHAR_NULL
&&
1582 NextCommandLine
[0] == L
'a' &&
1583 NextCommandLine
[1] == L
' '
1585 CopyMem(NextCommandLine
, NextCommandLine
+1, StrSize(NextCommandLine
) - sizeof(NextCommandLine
[0]));
1593 // make a SPLIT_LIST item and add to list
1595 Split
= AllocateZeroPool(sizeof(SPLIT_LIST
));
1596 ASSERT(Split
!= NULL
);
1597 Split
->SplitStdIn
= StdIn
;
1598 Split
->SplitStdOut
= ConvertEfiFileProtocolToShellHandle(CreateFileInterfaceMem(Unicode
), NULL
);
1599 ASSERT(Split
->SplitStdOut
!= NULL
);
1600 InsertHeadList(&ShellInfoObject
.SplitList
.Link
, &Split
->Link
);
1602 Status
= RunCommand(OurCommandLine
);
1605 // move the output from the first to the in to the second.
1607 TempFileHandle
= Split
->SplitStdOut
;
1608 if (Split
->SplitStdIn
== StdIn
) {
1609 Split
->SplitStdOut
= NULL
;
1611 Split
->SplitStdOut
= Split
->SplitStdIn
;
1613 Split
->SplitStdIn
= TempFileHandle
;
1614 ShellInfoObject
.NewEfiShellProtocol
->SetFilePosition(ConvertShellHandleToEfiFileProtocol(Split
->SplitStdIn
), 0);
1616 if (!EFI_ERROR(Status
)) {
1617 Status
= RunCommand(NextCommandLine
);
1621 // remove the top level from the ScriptList
1623 ASSERT((SPLIT_LIST
*)GetFirstNode(&ShellInfoObject
.SplitList
.Link
) == Split
);
1624 RemoveEntryList(&Split
->Link
);
1627 // Note that the original StdIn is now the StdOut...
1629 if (Split
->SplitStdOut
!= NULL
&& Split
->SplitStdOut
!= StdIn
) {
1630 ShellInfoObject
.NewEfiShellProtocol
->CloseFile(ConvertShellHandleToEfiFileProtocol(Split
->SplitStdOut
));
1632 if (Split
->SplitStdIn
!= NULL
) {
1633 ShellInfoObject
.NewEfiShellProtocol
->CloseFile(ConvertShellHandleToEfiFileProtocol(Split
->SplitStdIn
));
1637 FreePool(NextCommandLine
);
1638 FreePool(OurCommandLine
);
1644 Take the original command line, substitute any variables, free
1645 the original string, return the modified copy.
1647 @param[in] CmdLine pointer to the command line to update.
1649 @retval EFI_SUCCESS the function was successful.
1650 @retval EFI_OUT_OF_RESOURCES a memory allocation failed.
1654 ShellSubstituteVariables(
1659 NewCmdLine
= ShellConvertVariables(*CmdLine
);
1660 SHELL_FREE_NON_NULL(*CmdLine
);
1661 if (NewCmdLine
== NULL
) {
1662 return (EFI_OUT_OF_RESOURCES
);
1664 *CmdLine
= NewCmdLine
;
1665 return (EFI_SUCCESS
);
1669 Take the original command line, substitute any alias in the first group of space delimited characters, free
1670 the original string, return the modified copy.
1672 @param[in] CmdLine pointer to the command line to update.
1674 @retval EFI_SUCCESS the function was successful.
1675 @retval EFI_OUT_OF_RESOURCES a memory allocation failed.
1679 ShellSubstituteAliases(
1684 CHAR16
*CommandName
;
1686 UINTN PostAliasSize
;
1687 ASSERT(CmdLine
!= NULL
);
1688 ASSERT(*CmdLine
!= NULL
);
1692 if (StrStr((*CmdLine
), L
" ") == NULL
){
1693 StrnCatGrow(&CommandName
, NULL
, (*CmdLine
), 0);
1695 StrnCatGrow(&CommandName
, NULL
, (*CmdLine
), StrStr((*CmdLine
), L
" ") - (*CmdLine
));
1699 // This cannot happen 'inline' since the CmdLine can need extra space.
1702 if (!ShellCommandIsCommandOnList(CommandName
)) {
1704 // Convert via alias
1706 Status
= ShellConvertAlias(&CommandName
);
1707 if (EFI_ERROR(Status
)){
1711 NewCmdLine
= StrnCatGrow(&NewCmdLine
, &PostAliasSize
, CommandName
, 0);
1712 if (NewCmdLine
== NULL
) {
1713 SHELL_FREE_NON_NULL(CommandName
);
1714 SHELL_FREE_NON_NULL(*CmdLine
);
1715 return (EFI_OUT_OF_RESOURCES
);
1717 NewCmdLine
= StrnCatGrow(&NewCmdLine
, &PostAliasSize
, StrStr((*CmdLine
), L
" "), 0);
1718 if (NewCmdLine
== NULL
) {
1719 SHELL_FREE_NON_NULL(CommandName
);
1720 SHELL_FREE_NON_NULL(*CmdLine
);
1721 return (EFI_OUT_OF_RESOURCES
);
1724 NewCmdLine
= StrnCatGrow(&NewCmdLine
, NULL
, (*CmdLine
), 0);
1727 SHELL_FREE_NON_NULL(*CmdLine
);
1728 SHELL_FREE_NON_NULL(CommandName
);
1731 // re-assign the passed in double pointer to point to our newly allocated buffer
1733 *CmdLine
= NewCmdLine
;
1735 return (EFI_SUCCESS
);
1739 Takes the Argv[0] part of the command line and determine the meaning of it.
1741 @param[in] CmdName pointer to the command line to update.
1743 @retval Internal_Command The name is an internal command.
1744 @retval File_Sys_Change the name is a file system change.
1745 @retval Script_File_Name the name is a NSH script file.
1746 @retval Unknown_Invalid the name is unknown.
1747 @retval Efi_Application the name is an application (.EFI).
1749 SHELL_OPERATION_TYPES
1752 IN CONST CHAR16
*CmdName
1755 CHAR16
* FileWithPath
;
1756 CONST CHAR16
* TempLocation
;
1757 CONST CHAR16
* TempLocation2
;
1759 FileWithPath
= NULL
;
1761 // test for an internal command.
1763 if (ShellCommandIsCommandOnList(CmdName
)) {
1764 return (Internal_Command
);
1768 // Test for file system change request. anything ending with first : and cant have spaces.
1770 if (CmdName
[(StrLen(CmdName
)-1)] == L
':') {
1771 if ( StrStr(CmdName
, L
" ") != NULL
1772 || StrLen(StrStr(CmdName
, L
":")) > 1
1774 return (Unknown_Invalid
);
1776 return (File_Sys_Change
);
1782 if ((FileWithPath
= ShellFindFilePathEx(CmdName
, mExecutableExtensions
)) != NULL
) {
1784 // See if that file has a script file extension
1786 if (StrLen(FileWithPath
) > 4) {
1787 TempLocation
= FileWithPath
+StrLen(FileWithPath
)-4;
1788 TempLocation2
= mScriptExtension
;
1789 if (StringNoCaseCompare((VOID
*)(&TempLocation
), (VOID
*)(&TempLocation2
)) == 0) {
1790 SHELL_FREE_NON_NULL(FileWithPath
);
1791 return (Script_File_Name
);
1796 // Was a file, but not a script. we treat this as an application.
1798 SHELL_FREE_NON_NULL(FileWithPath
);
1799 return (Efi_Application
);
1802 SHELL_FREE_NON_NULL(FileWithPath
);
1804 // No clue what this is... return invalid flag...
1806 return (Unknown_Invalid
);
1810 Determine if the first item in a command line is valid.
1812 @param[in] CmdLine The command line to parse.
1814 @retval EFI_SUCCESS The item is valid.
1815 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
1816 @retval EFI_NOT_FOUND The operation type is unknown or invalid.
1821 IN CONST CHAR16
*CmdLine
1825 CHAR16
*FirstParameter
;
1831 Temp
= StrnCatGrow(&Temp
, NULL
, CmdLine
, 0);
1833 return (EFI_OUT_OF_RESOURCES
);
1836 FirstParameter
= StrStr(Temp
, L
"|");
1837 if (FirstParameter
!= NULL
) {
1838 *FirstParameter
= CHAR_NULL
;
1841 FirstParameter
= NULL
;
1844 // Process the command line
1846 Status
= ProcessCommandLineToFinal(&Temp
);
1848 if (!EFI_ERROR(Status
)) {
1849 FirstParameter
= AllocateZeroPool(StrSize(CmdLine
));
1850 if (FirstParameter
== NULL
) {
1851 SHELL_FREE_NON_NULL(Temp
);
1852 return (EFI_OUT_OF_RESOURCES
);
1854 TempWalker
= (CHAR16
*)Temp
;
1855 if (!EFI_ERROR(GetNextParameter(&TempWalker
, &FirstParameter
, StrSize(CmdLine
)))) {
1856 if (GetOperationType(FirstParameter
) == Unknown_Invalid
) {
1857 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_SHELL_NOT_FOUND
), ShellInfoObject
.HiiHandle
, FirstParameter
);
1858 SetLastError(SHELL_NOT_FOUND
);
1859 Status
= EFI_NOT_FOUND
;
1864 SHELL_FREE_NON_NULL(Temp
);
1865 SHELL_FREE_NON_NULL(FirstParameter
);
1870 Determine if a command line contains with a split contains only valid commands.
1872 @param[in] CmdLine The command line to parse.
1874 @retval EFI_SUCCESS CmdLine has only valid commands, application, or has no split.
1875 @retval EFI_ABORTED CmdLine has at least one invalid command or application.
1880 IN CONST CHAR16
*CmdLine
1883 CONST CHAR16
*TempSpot
;
1887 // Verify up to the pipe or end character
1889 Status
= IsValidSplit(CmdLine
);
1890 if (EFI_ERROR(Status
)) {
1895 // If this was the only item, then get out
1897 if (!ContainsSplit(CmdLine
)) {
1898 return (EFI_SUCCESS
);
1902 // recurse to verify the next item
1904 TempSpot
= FindFirstCharacter(CmdLine
, L
"|", L
'^') + 1;
1905 return (VerifySplit(TempSpot
));
1909 Process a split based operation.
1911 @param[in] CmdLine pointer to the command line to process
1913 @retval EFI_SUCCESS The operation was successful
1914 @return an error occurred.
1918 ProcessNewSplitCommandLine(
1919 IN CONST CHAR16
*CmdLine
1925 Status
= VerifySplit(CmdLine
);
1926 if (EFI_ERROR(Status
)) {
1933 // are we in an existing split???
1935 if (!IsListEmpty(&ShellInfoObject
.SplitList
.Link
)) {
1936 Split
= (SPLIT_LIST
*)GetFirstNode(&ShellInfoObject
.SplitList
.Link
);
1939 if (Split
== NULL
) {
1940 Status
= RunSplitCommand(CmdLine
, NULL
, NULL
);
1942 Status
= RunSplitCommand(CmdLine
, Split
->SplitStdIn
, Split
->SplitStdOut
);
1944 if (EFI_ERROR(Status
)) {
1945 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_SHELL_INVALID_SPLIT
), ShellInfoObject
.HiiHandle
, CmdLine
);
1951 Handle a request to change the current file system.
1953 @param[in] CmdLine The passed in command line.
1955 @retval EFI_SUCCESS The operation was successful.
1960 IN CONST CHAR16
*CmdLine
1964 Status
= EFI_SUCCESS
;
1967 // make sure we are the right operation
1969 ASSERT(CmdLine
[(StrLen(CmdLine
)-1)] == L
':' && StrStr(CmdLine
, L
" ") == NULL
);
1972 // Call the protocol API to do the work
1974 Status
= ShellInfoObject
.NewEfiShellProtocol
->SetCurDir(NULL
, CmdLine
);
1977 // Report any errors
1979 if (EFI_ERROR(Status
)) {
1980 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_SHELL_INVALID_MAPPING
), ShellInfoObject
.HiiHandle
, CmdLine
);
1987 Reprocess the command line to direct all -? to the help command.
1989 if found, will add "help" as argv[0], and move the rest later.
1991 @param[in,out] CmdLine pointer to the command line to update
1996 IN OUT CHAR16
**CmdLine
1999 CHAR16
*CurrentParameter
;
2001 CHAR16
*NewCommandLine
;
2003 UINTN NewCmdLineSize
;
2005 Status
= EFI_SUCCESS
;
2007 CurrentParameter
= AllocateZeroPool(StrSize(*CmdLine
));
2008 if (CurrentParameter
== NULL
) {
2009 return (EFI_OUT_OF_RESOURCES
);
2013 while(Walker
!= NULL
&& *Walker
!= CHAR_NULL
) {
2014 if (!EFI_ERROR(GetNextParameter(&Walker
, &CurrentParameter
, StrSize(*CmdLine
)))) {
2015 if (StrStr(CurrentParameter
, L
"-?") == CurrentParameter
) {
2016 CurrentParameter
[0] = L
' ';
2017 CurrentParameter
[1] = L
' ';
2018 NewCmdLineSize
= StrSize(L
"help ") + StrSize(*CmdLine
);
2019 NewCommandLine
= AllocateZeroPool(NewCmdLineSize
);
2020 if (NewCommandLine
== NULL
) {
2021 Status
= EFI_OUT_OF_RESOURCES
;
2026 // We know the space is sufficient since we just calculated it.
2028 StrnCpyS(NewCommandLine
, NewCmdLineSize
/sizeof(CHAR16
), L
"help ", 5);
2029 StrnCatS(NewCommandLine
, NewCmdLineSize
/sizeof(CHAR16
), *CmdLine
, StrLen(*CmdLine
));
2030 SHELL_FREE_NON_NULL(*CmdLine
);
2031 *CmdLine
= NewCommandLine
;
2037 SHELL_FREE_NON_NULL(CurrentParameter
);
2043 Function to update the shell variable "lasterror".
2045 @param[in] ErrorCode the error code to put into lasterror.
2050 IN CONST SHELL_STATUS ErrorCode
2053 CHAR16 LeString
[19];
2054 if (sizeof(EFI_STATUS
) == sizeof(UINT64
)) {
2055 UnicodeSPrint(LeString
, sizeof(LeString
), L
"0x%Lx", ErrorCode
);
2057 UnicodeSPrint(LeString
, sizeof(LeString
), L
"0x%x", ErrorCode
);
2059 DEBUG_CODE(InternalEfiShellSetEnv(L
"debuglasterror", LeString
, TRUE
););
2060 InternalEfiShellSetEnv(L
"lasterror", LeString
, TRUE
);
2062 return (EFI_SUCCESS
);
2066 Converts the command line to it's post-processed form. this replaces variables and alias' per UEFI Shell spec.
2068 @param[in,out] CmdLine pointer to the command line to update
2070 @retval EFI_SUCCESS The operation was successful
2071 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
2072 @return some other error occurred
2076 ProcessCommandLineToFinal(
2077 IN OUT CHAR16
**CmdLine
2081 TrimSpaces(CmdLine
);
2083 Status
= ShellSubstituteAliases(CmdLine
);
2084 if (EFI_ERROR(Status
)) {
2088 TrimSpaces(CmdLine
);
2090 Status
= ShellSubstituteVariables(CmdLine
);
2091 if (EFI_ERROR(Status
)) {
2094 ASSERT (*CmdLine
!= NULL
);
2096 TrimSpaces(CmdLine
);
2099 // update for help parsing
2101 if (StrStr(*CmdLine
, L
"?") != NULL
) {
2103 // This may do nothing if the ? does not indicate help.
2104 // Save all the details for in the API below.
2106 Status
= DoHelpUpdate(CmdLine
);
2109 TrimSpaces(CmdLine
);
2111 return (EFI_SUCCESS
);
2115 Run an internal shell command.
2117 This API will update the shell's environment since these commands are libraries.
2119 @param[in] CmdLine the command line to run.
2120 @param[in] FirstParameter the first parameter on the command line
2121 @param[in] ParamProtocol the shell parameters protocol pointer
2123 @retval EFI_SUCCESS The command was completed.
2124 @retval EFI_ABORTED The command's operation was aborted.
2129 IN CONST CHAR16
*CmdLine
,
2130 IN CHAR16
*FirstParameter
,
2131 IN EFI_SHELL_PARAMETERS_PROTOCOL
*ParamProtocol
2137 SHELL_STATUS CommandReturnedStatus
;
2142 NewCmdLine
= AllocateCopyPool (StrSize (CmdLine
), CmdLine
);
2143 if (NewCmdLine
== NULL
) {
2144 return EFI_OUT_OF_RESOURCES
;
2147 for (Walker
= NewCmdLine
; Walker
!= NULL
&& *Walker
!= CHAR_NULL
; Walker
++) {
2148 if (*Walker
== L
'^' && *(Walker
+1) == L
'#') {
2149 CopyMem(Walker
, Walker
+1, StrSize(Walker
) - sizeof(Walker
[0]));
2154 // get the argc and argv updated for internal commands
2156 Status
= UpdateArgcArgv(ParamProtocol
, NewCmdLine
, &Argv
, &Argc
);
2157 if (!EFI_ERROR(Status
)) {
2159 // Run the internal command.
2161 Status
= ShellCommandRunCommandHandler(FirstParameter
, &CommandReturnedStatus
, &LastError
);
2163 if (!EFI_ERROR(Status
)) {
2165 // Update last error status.
2166 // some commands do not update last error.
2169 SetLastError(CommandReturnedStatus
);
2173 // Pass thru the exitcode from the app.
2175 if (ShellCommandGetExit()) {
2177 // An Exit was requested ("exit" command), pass its value up.
2179 Status
= CommandReturnedStatus
;
2180 } else if (CommandReturnedStatus
!= SHELL_SUCCESS
&& IsScriptOnlyCommand(FirstParameter
)) {
2182 // Always abort when a script only command fails for any reason
2184 Status
= EFI_ABORTED
;
2185 } else if (ShellCommandGetCurrentScriptFile() != NULL
&& CommandReturnedStatus
== SHELL_ABORTED
) {
2187 // Abort when in a script and a command aborted
2189 Status
= EFI_ABORTED
;
2195 // This is guaranteed to be called after UpdateArgcArgv no matter what else happened.
2196 // This is safe even if the update API failed. In this case, it may be a no-op.
2198 RestoreArgcArgv(ParamProtocol
, &Argv
, &Argc
);
2201 // If a script is running and the command is not a script only command, then
2202 // change return value to success so the script won't halt (unless aborted).
2204 // Script only commands have to be able halt the script since the script will
2205 // not operate if they are failing.
2207 if ( ShellCommandGetCurrentScriptFile() != NULL
2208 && !IsScriptOnlyCommand(FirstParameter
)
2209 && Status
!= EFI_ABORTED
2211 Status
= EFI_SUCCESS
;
2214 FreePool (NewCmdLine
);
2219 Function to run the command or file.
2221 @param[in] Type the type of operation being run.
2222 @param[in] CmdLine the command line to run.
2223 @param[in] FirstParameter the first parameter on the command line
2224 @param[in] ParamProtocol the shell parameters protocol pointer
2226 @retval EFI_SUCCESS The command was completed.
2227 @retval EFI_ABORTED The command's operation was aborted.
2232 IN SHELL_OPERATION_TYPES Type
,
2233 IN CONST CHAR16
*CmdLine
,
2234 IN CHAR16
*FirstParameter
,
2235 IN EFI_SHELL_PARAMETERS_PROTOCOL
*ParamProtocol
2239 EFI_STATUS StartStatus
;
2240 CHAR16
*CommandWithPath
;
2241 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
2242 SHELL_STATUS CalleeExitStatus
;
2244 Status
= EFI_SUCCESS
;
2245 CommandWithPath
= NULL
;
2247 CalleeExitStatus
= SHELL_INVALID_PARAMETER
;
2250 case Internal_Command
:
2251 Status
= RunInternalCommand(CmdLine
, FirstParameter
, ParamProtocol
);
2253 case Script_File_Name
:
2254 case Efi_Application
:
2256 // Process a fully qualified path
2258 if (StrStr(FirstParameter
, L
":") != NULL
) {
2259 ASSERT (CommandWithPath
== NULL
);
2260 if (ShellIsFile(FirstParameter
) == EFI_SUCCESS
) {
2261 CommandWithPath
= StrnCatGrow(&CommandWithPath
, NULL
, FirstParameter
, 0);
2266 // Process a relative path and also check in the path environment variable
2268 if (CommandWithPath
== NULL
) {
2269 CommandWithPath
= ShellFindFilePathEx(FirstParameter
, mExecutableExtensions
);
2273 // This should be impossible now.
2275 ASSERT(CommandWithPath
!= NULL
);
2278 // Make sure that path is not just a directory (or not found)
2280 if (!EFI_ERROR(ShellIsDirectory(CommandWithPath
))) {
2281 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_SHELL_NOT_FOUND
), ShellInfoObject
.HiiHandle
, FirstParameter
);
2282 SetLastError(SHELL_NOT_FOUND
);
2285 case Script_File_Name
:
2286 Status
= RunScriptFile (CommandWithPath
, NULL
, CmdLine
, ParamProtocol
);
2288 case Efi_Application
:
2290 // Get the device path of the application image
2292 DevPath
= ShellInfoObject
.NewEfiShellProtocol
->GetDevicePathFromFilePath(CommandWithPath
);
2293 if (DevPath
== NULL
){
2294 Status
= EFI_OUT_OF_RESOURCES
;
2299 // Execute the device path
2301 Status
= InternalShellExecuteDevicePath(
2309 SHELL_FREE_NON_NULL(DevPath
);
2311 if(EFI_ERROR (Status
)) {
2312 CalleeExitStatus
= (SHELL_STATUS
) (Status
& (~MAX_BIT
));
2314 CalleeExitStatus
= (SHELL_STATUS
) StartStatus
;
2318 // Update last error status.
2320 // Status is an EFI_STATUS. Clear top bit to convert to SHELL_STATUS
2321 SetLastError(CalleeExitStatus
);
2337 SHELL_FREE_NON_NULL(CommandWithPath
);
2343 Function to setup StdIn, StdErr, StdOut, and then run the command or file.
2345 @param[in] Type the type of operation being run.
2346 @param[in] CmdLine the command line to run.
2347 @param[in] FirstParameter the first parameter on the command line.
2348 @param[in] ParamProtocol the shell parameters protocol pointer
2350 @retval EFI_SUCCESS The command was completed.
2351 @retval EFI_ABORTED The command's operation was aborted.
2355 SetupAndRunCommandOrFile(
2356 IN SHELL_OPERATION_TYPES Type
,
2358 IN CHAR16
*FirstParameter
,
2359 IN EFI_SHELL_PARAMETERS_PROTOCOL
*ParamProtocol
2363 SHELL_FILE_HANDLE OriginalStdIn
;
2364 SHELL_FILE_HANDLE OriginalStdOut
;
2365 SHELL_FILE_HANDLE OriginalStdErr
;
2366 SYSTEM_TABLE_INFO OriginalSystemTableInfo
;
2369 // Update the StdIn, StdOut, and StdErr for redirection to environment variables, files, etc... unicode and ASCII
2371 Status
= UpdateStdInStdOutStdErr(ParamProtocol
, CmdLine
, &OriginalStdIn
, &OriginalStdOut
, &OriginalStdErr
, &OriginalSystemTableInfo
);
2374 // The StdIn, StdOut, and StdErr are set up.
2375 // Now run the command, script, or application
2377 if (!EFI_ERROR(Status
)) {
2378 TrimSpaces(&CmdLine
);
2379 Status
= RunCommandOrFile(Type
, CmdLine
, FirstParameter
, ParamProtocol
);
2385 if (EFI_ERROR(Status
)) {
2386 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_SHELL_ERROR
), ShellInfoObject
.HiiHandle
, (VOID
*)(Status
));
2390 // put back the original StdIn, StdOut, and StdErr
2392 RestoreStdInStdOutStdErr(ParamProtocol
, &OriginalStdIn
, &OriginalStdOut
, &OriginalStdErr
, &OriginalSystemTableInfo
);
2398 Function will process and run a command line.
2400 This will determine if the command line represents an internal shell
2401 command or dispatch an external application.
2403 @param[in] CmdLine The command line to parse.
2405 @retval EFI_SUCCESS The command was completed.
2406 @retval EFI_ABORTED The command's operation was aborted.
2411 IN CONST CHAR16
*CmdLine
2415 CHAR16
*CleanOriginal
;
2416 CHAR16
*FirstParameter
;
2418 SHELL_OPERATION_TYPES Type
;
2420 ASSERT(CmdLine
!= NULL
);
2421 if (StrLen(CmdLine
) == 0) {
2422 return (EFI_SUCCESS
);
2425 Status
= EFI_SUCCESS
;
2426 CleanOriginal
= NULL
;
2428 CleanOriginal
= StrnCatGrow(&CleanOriginal
, NULL
, CmdLine
, 0);
2429 if (CleanOriginal
== NULL
) {
2430 return (EFI_OUT_OF_RESOURCES
);
2433 TrimSpaces(&CleanOriginal
);
2436 // NULL out comments (leveraged from RunScriptFileHandle() ).
2437 // The # character on a line is used to denote that all characters on the same line
2438 // and to the right of the # are to be ignored by the shell.
2439 // Afterwards, again remove spaces, in case any were between the last command-parameter and '#'.
2441 for (TempWalker
= CleanOriginal
; TempWalker
!= NULL
&& *TempWalker
!= CHAR_NULL
; TempWalker
++) {
2442 if (*TempWalker
== L
'^') {
2443 if (*(TempWalker
+ 1) == L
'#') {
2446 } else if (*TempWalker
== L
'#') {
2447 *TempWalker
= CHAR_NULL
;
2451 TrimSpaces(&CleanOriginal
);
2454 // Handle case that passed in command line is just 1 or more " " characters.
2456 if (StrLen (CleanOriginal
) == 0) {
2457 SHELL_FREE_NON_NULL(CleanOriginal
);
2458 return (EFI_SUCCESS
);
2461 Status
= ProcessCommandLineToFinal(&CleanOriginal
);
2462 if (EFI_ERROR(Status
)) {
2463 SHELL_FREE_NON_NULL(CleanOriginal
);
2468 // We don't do normal processing with a split command line (output from one command input to another)
2470 if (ContainsSplit(CleanOriginal
)) {
2471 Status
= ProcessNewSplitCommandLine(CleanOriginal
);
2472 SHELL_FREE_NON_NULL(CleanOriginal
);
2477 // We need the first parameter information so we can determine the operation type
2479 FirstParameter
= AllocateZeroPool(StrSize(CleanOriginal
));
2480 if (FirstParameter
== NULL
) {
2481 SHELL_FREE_NON_NULL(CleanOriginal
);
2482 return (EFI_OUT_OF_RESOURCES
);
2484 TempWalker
= CleanOriginal
;
2485 if (!EFI_ERROR(GetNextParameter(&TempWalker
, &FirstParameter
, StrSize(CleanOriginal
)))) {
2487 // Depending on the first parameter we change the behavior
2489 switch (Type
= GetOperationType(FirstParameter
)) {
2490 case File_Sys_Change
:
2491 Status
= ChangeMappedDrive (FirstParameter
);
2493 case Internal_Command
:
2494 case Script_File_Name
:
2495 case Efi_Application
:
2496 Status
= SetupAndRunCommandOrFile(Type
, CleanOriginal
, FirstParameter
, ShellInfoObject
.NewShellParametersProtocol
);
2500 // Whatever was typed, it was invalid.
2502 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_SHELL_NOT_FOUND
), ShellInfoObject
.HiiHandle
, FirstParameter
);
2503 SetLastError(SHELL_NOT_FOUND
);
2507 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_SHELL_NOT_FOUND
), ShellInfoObject
.HiiHandle
, FirstParameter
);
2508 SetLastError(SHELL_NOT_FOUND
);
2511 SHELL_FREE_NON_NULL(CleanOriginal
);
2512 SHELL_FREE_NON_NULL(FirstParameter
);
2517 STATIC CONST UINT16 InvalidChars
[] = {L
'*', L
'?', L
'<', L
'>', L
'\\', L
'/', L
'\"', 0x0001, 0x0002};
2519 Function determines if the CommandName COULD be a valid command. It does not determine whether
2520 this is a valid command. It only checks for invalid characters.
2522 @param[in] CommandName The name to check
2524 @retval TRUE CommandName could be a command name
2525 @retval FALSE CommandName could not be a valid command name
2530 IN CONST CHAR16
*CommandName
2534 if (CommandName
== NULL
) {
2539 ; Count
< sizeof(InvalidChars
) / sizeof(InvalidChars
[0])
2542 if (ScanMem16(CommandName
, StrSize(CommandName
), InvalidChars
[Count
]) != NULL
) {
2550 Function to process a NSH script file via SHELL_FILE_HANDLE.
2552 @param[in] Handle The handle to the already opened file.
2553 @param[in] Name The name of the script file.
2555 @retval EFI_SUCCESS the script completed successfully
2559 RunScriptFileHandle (
2560 IN SHELL_FILE_HANDLE Handle
,
2561 IN CONST CHAR16
*Name
2565 SCRIPT_FILE
*NewScriptFile
;
2567 CHAR16
*CommandLine
;
2568 CHAR16
*CommandLine2
;
2569 CHAR16
*CommandLine3
;
2570 SCRIPT_COMMAND_LIST
*LastCommand
;
2572 BOOLEAN PreScriptEchoState
;
2573 BOOLEAN PreCommandEchoState
;
2574 CONST CHAR16
*CurDir
;
2576 CHAR16 LeString
[50];
2578 ASSERT(!ShellCommandGetScriptExit());
2580 PreScriptEchoState
= ShellCommandGetEchoState();
2582 NewScriptFile
= (SCRIPT_FILE
*)AllocateZeroPool(sizeof(SCRIPT_FILE
));
2583 if (NewScriptFile
== NULL
) {
2584 return (EFI_OUT_OF_RESOURCES
);
2590 ASSERT(NewScriptFile
->ScriptName
== NULL
);
2591 NewScriptFile
->ScriptName
= StrnCatGrow(&NewScriptFile
->ScriptName
, NULL
, Name
, 0);
2592 if (NewScriptFile
->ScriptName
== NULL
) {
2593 DeleteScriptFileStruct(NewScriptFile
);
2594 return (EFI_OUT_OF_RESOURCES
);
2598 // Save the parameters (used to replace %0 to %9 later on)
2600 NewScriptFile
->Argc
= ShellInfoObject
.NewShellParametersProtocol
->Argc
;
2601 if (NewScriptFile
->Argc
!= 0) {
2602 NewScriptFile
->Argv
= (CHAR16
**)AllocateZeroPool(NewScriptFile
->Argc
* sizeof(CHAR16
*));
2603 if (NewScriptFile
->Argv
== NULL
) {
2604 DeleteScriptFileStruct(NewScriptFile
);
2605 return (EFI_OUT_OF_RESOURCES
);
2607 for (LoopVar
= 0 ; LoopVar
< 10 && LoopVar
< NewScriptFile
->Argc
; LoopVar
++) {
2608 ASSERT(NewScriptFile
->Argv
[LoopVar
] == NULL
);
2609 NewScriptFile
->Argv
[LoopVar
] = StrnCatGrow(&NewScriptFile
->Argv
[LoopVar
], NULL
, ShellInfoObject
.NewShellParametersProtocol
->Argv
[LoopVar
], 0);
2610 if (NewScriptFile
->Argv
[LoopVar
] == NULL
) {
2611 DeleteScriptFileStruct(NewScriptFile
);
2612 return (EFI_OUT_OF_RESOURCES
);
2616 NewScriptFile
->Argv
= NULL
;
2619 InitializeListHead(&NewScriptFile
->CommandList
);
2620 InitializeListHead(&NewScriptFile
->SubstList
);
2623 // Now build the list of all script commands.
2626 while(!ShellFileHandleEof(Handle
)) {
2627 CommandLine
= ShellFileHandleReturnLine(Handle
, &Ascii
);
2629 if (CommandLine
== NULL
|| StrLen(CommandLine
) == 0 || CommandLine
[0] == '#') {
2630 SHELL_FREE_NON_NULL(CommandLine
);
2633 NewScriptFile
->CurrentCommand
= AllocateZeroPool(sizeof(SCRIPT_COMMAND_LIST
));
2634 if (NewScriptFile
->CurrentCommand
== NULL
) {
2635 SHELL_FREE_NON_NULL(CommandLine
);
2636 DeleteScriptFileStruct(NewScriptFile
);
2637 return (EFI_OUT_OF_RESOURCES
);
2640 NewScriptFile
->CurrentCommand
->Cl
= CommandLine
;
2641 NewScriptFile
->CurrentCommand
->Data
= NULL
;
2642 NewScriptFile
->CurrentCommand
->Line
= LineCount
;
2644 InsertTailList(&NewScriptFile
->CommandList
, &NewScriptFile
->CurrentCommand
->Link
);
2648 // Add this as the topmost script file
2650 ShellCommandSetNewScript (NewScriptFile
);
2653 // Now enumerate through the commands and run each one.
2655 CommandLine
= AllocateZeroPool(PcdGet16(PcdShellPrintBufferSize
));
2656 if (CommandLine
== NULL
) {
2657 DeleteScriptFileStruct(NewScriptFile
);
2658 return (EFI_OUT_OF_RESOURCES
);
2660 CommandLine2
= AllocateZeroPool(PcdGet16(PcdShellPrintBufferSize
));
2661 if (CommandLine2
== NULL
) {
2662 FreePool(CommandLine
);
2663 DeleteScriptFileStruct(NewScriptFile
);
2664 return (EFI_OUT_OF_RESOURCES
);
2667 for ( NewScriptFile
->CurrentCommand
= (SCRIPT_COMMAND_LIST
*)GetFirstNode(&NewScriptFile
->CommandList
)
2668 ; !IsNull(&NewScriptFile
->CommandList
, &NewScriptFile
->CurrentCommand
->Link
)
2669 ; // conditional increment in the body of the loop
2671 ASSERT(CommandLine2
!= NULL
);
2672 StrCpyS( CommandLine2
,
2673 PcdGet16(PcdShellPrintBufferSize
)/sizeof(CHAR16
),
2674 NewScriptFile
->CurrentCommand
->Cl
2678 // NULL out comments
2680 for (CommandLine3
= CommandLine2
; CommandLine3
!= NULL
&& *CommandLine3
!= CHAR_NULL
; CommandLine3
++) {
2681 if (*CommandLine3
== L
'^') {
2682 if ( *(CommandLine3
+1) == L
':') {
2683 CopyMem(CommandLine3
, CommandLine3
+1, StrSize(CommandLine3
) - sizeof(CommandLine3
[0]));
2684 } else if (*(CommandLine3
+1) == L
'#') {
2687 } else if (*CommandLine3
== L
'#') {
2688 *CommandLine3
= CHAR_NULL
;
2692 if (CommandLine2
!= NULL
&& StrLen(CommandLine2
) >= 1) {
2694 // Due to variability in starting the find and replace action we need to have both buffers the same.
2696 StrCpyS( CommandLine
,
2697 PcdGet16(PcdShellPrintBufferSize
)/sizeof(CHAR16
),
2702 // Remove the %0 to %9 from the command line (if we have some arguments)
2704 if (NewScriptFile
->Argv
!= NULL
) {
2705 switch (NewScriptFile
->Argc
) {
2707 Status
= ShellCopySearchAndReplace(CommandLine2
, CommandLine
, PcdGet16 (PcdShellPrintBufferSize
), L
"%9", NewScriptFile
->Argv
[9], FALSE
, TRUE
);
2708 ASSERT_EFI_ERROR(Status
);
2710 Status
= ShellCopySearchAndReplace(CommandLine
, CommandLine2
, PcdGet16 (PcdShellPrintBufferSize
), L
"%8", NewScriptFile
->Argv
[8], FALSE
, TRUE
);
2711 ASSERT_EFI_ERROR(Status
);
2713 Status
= ShellCopySearchAndReplace(CommandLine2
, CommandLine
, PcdGet16 (PcdShellPrintBufferSize
), L
"%7", NewScriptFile
->Argv
[7], FALSE
, TRUE
);
2714 ASSERT_EFI_ERROR(Status
);
2716 Status
= ShellCopySearchAndReplace(CommandLine
, CommandLine2
, PcdGet16 (PcdShellPrintBufferSize
), L
"%6", NewScriptFile
->Argv
[6], FALSE
, TRUE
);
2717 ASSERT_EFI_ERROR(Status
);
2719 Status
= ShellCopySearchAndReplace(CommandLine2
, CommandLine
, PcdGet16 (PcdShellPrintBufferSize
), L
"%5", NewScriptFile
->Argv
[5], FALSE
, TRUE
);
2720 ASSERT_EFI_ERROR(Status
);
2722 Status
= ShellCopySearchAndReplace(CommandLine
, CommandLine2
, PcdGet16 (PcdShellPrintBufferSize
), L
"%4", NewScriptFile
->Argv
[4], FALSE
, TRUE
);
2723 ASSERT_EFI_ERROR(Status
);
2725 Status
= ShellCopySearchAndReplace(CommandLine2
, CommandLine
, PcdGet16 (PcdShellPrintBufferSize
), L
"%3", NewScriptFile
->Argv
[3], FALSE
, TRUE
);
2726 ASSERT_EFI_ERROR(Status
);
2728 Status
= ShellCopySearchAndReplace(CommandLine
, CommandLine2
, PcdGet16 (PcdShellPrintBufferSize
), L
"%2", NewScriptFile
->Argv
[2], FALSE
, TRUE
);
2729 ASSERT_EFI_ERROR(Status
);
2731 Status
= ShellCopySearchAndReplace(CommandLine2
, CommandLine
, PcdGet16 (PcdShellPrintBufferSize
), L
"%1", NewScriptFile
->Argv
[1], FALSE
, TRUE
);
2732 ASSERT_EFI_ERROR(Status
);
2734 Status
= ShellCopySearchAndReplace(CommandLine
, CommandLine2
, PcdGet16 (PcdShellPrintBufferSize
), L
"%0", NewScriptFile
->Argv
[0], FALSE
, TRUE
);
2735 ASSERT_EFI_ERROR(Status
);
2741 Status
= ShellCopySearchAndReplace(CommandLine2
, CommandLine
, PcdGet16 (PcdShellPrintBufferSize
), L
"%1", L
"\"\"", FALSE
, FALSE
);
2742 Status
= ShellCopySearchAndReplace(CommandLine
, CommandLine2
, PcdGet16 (PcdShellPrintBufferSize
), L
"%2", L
"\"\"", FALSE
, FALSE
);
2743 Status
= ShellCopySearchAndReplace(CommandLine2
, CommandLine
, PcdGet16 (PcdShellPrintBufferSize
), L
"%3", L
"\"\"", FALSE
, FALSE
);
2744 Status
= ShellCopySearchAndReplace(CommandLine
, CommandLine2
, PcdGet16 (PcdShellPrintBufferSize
), L
"%4", L
"\"\"", FALSE
, FALSE
);
2745 Status
= ShellCopySearchAndReplace(CommandLine2
, CommandLine
, PcdGet16 (PcdShellPrintBufferSize
), L
"%5", L
"\"\"", FALSE
, FALSE
);
2746 Status
= ShellCopySearchAndReplace(CommandLine
, CommandLine2
, PcdGet16 (PcdShellPrintBufferSize
), L
"%6", L
"\"\"", FALSE
, FALSE
);
2747 Status
= ShellCopySearchAndReplace(CommandLine2
, CommandLine
, PcdGet16 (PcdShellPrintBufferSize
), L
"%7", L
"\"\"", FALSE
, FALSE
);
2748 Status
= ShellCopySearchAndReplace(CommandLine
, CommandLine2
, PcdGet16 (PcdShellPrintBufferSize
), L
"%8", L
"\"\"", FALSE
, FALSE
);
2749 Status
= ShellCopySearchAndReplace(CommandLine2
, CommandLine
, PcdGet16 (PcdShellPrintBufferSize
), L
"%9", L
"\"\"", FALSE
, FALSE
);
2751 StrCpyS( CommandLine2
,
2752 PcdGet16(PcdShellPrintBufferSize
)/sizeof(CHAR16
),
2756 LastCommand
= NewScriptFile
->CurrentCommand
;
2758 for (CommandLine3
= CommandLine2
; CommandLine3
[0] == L
' ' ; CommandLine3
++);
2760 if (CommandLine3
!= NULL
&& CommandLine3
[0] == L
':' ) {
2762 // This line is a goto target / label
2765 if (CommandLine3
!= NULL
&& StrLen(CommandLine3
) > 0) {
2766 if (CommandLine3
[0] == L
'@') {
2768 // We need to save the current echo state
2769 // and disable echo for just this command.
2771 PreCommandEchoState
= ShellCommandGetEchoState();
2772 ShellCommandSetEchoState(FALSE
);
2773 Status
= RunCommand(CommandLine3
+1);
2776 // If command was "@echo -off" or "@echo -on" then don't restore echo state
2778 if (StrCmp (L
"@echo -off", CommandLine3
) != 0 &&
2779 StrCmp (L
"@echo -on", CommandLine3
) != 0) {
2781 // Now restore the pre-'@' echo state.
2783 ShellCommandSetEchoState(PreCommandEchoState
);
2786 if (ShellCommandGetEchoState()) {
2787 CurDir
= ShellInfoObject
.NewEfiShellProtocol
->GetEnv(L
"cwd");
2788 if (CurDir
!= NULL
&& StrLen(CurDir
) > 1) {
2789 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_SHELL_CURDIR
), ShellInfoObject
.HiiHandle
, CurDir
);
2791 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_SHELL_SHELL
), ShellInfoObject
.HiiHandle
);
2793 ShellPrintEx(-1, -1, L
"%s\r\n", CommandLine2
);
2795 Status
= RunCommand(CommandLine3
);
2799 if (ShellCommandGetScriptExit()) {
2801 // ShellCommandGetExitCode() always returns a UINT64
2803 UnicodeSPrint(LeString
, sizeof(LeString
), L
"0x%Lx", ShellCommandGetExitCode());
2804 DEBUG_CODE(InternalEfiShellSetEnv(L
"debuglasterror", LeString
, TRUE
););
2805 InternalEfiShellSetEnv(L
"lasterror", LeString
, TRUE
);
2807 ShellCommandRegisterExit(FALSE
, 0);
2808 Status
= EFI_SUCCESS
;
2811 if (ShellGetExecutionBreakFlag()) {
2814 if (EFI_ERROR(Status
)) {
2817 if (ShellCommandGetExit()) {
2822 // If that commend did not update the CurrentCommand then we need to advance it...
2824 if (LastCommand
== NewScriptFile
->CurrentCommand
) {
2825 NewScriptFile
->CurrentCommand
= (SCRIPT_COMMAND_LIST
*)GetNextNode(&NewScriptFile
->CommandList
, &NewScriptFile
->CurrentCommand
->Link
);
2826 if (!IsNull(&NewScriptFile
->CommandList
, &NewScriptFile
->CurrentCommand
->Link
)) {
2827 NewScriptFile
->CurrentCommand
->Reset
= TRUE
;
2831 NewScriptFile
->CurrentCommand
= (SCRIPT_COMMAND_LIST
*)GetNextNode(&NewScriptFile
->CommandList
, &NewScriptFile
->CurrentCommand
->Link
);
2832 if (!IsNull(&NewScriptFile
->CommandList
, &NewScriptFile
->CurrentCommand
->Link
)) {
2833 NewScriptFile
->CurrentCommand
->Reset
= TRUE
;
2839 FreePool(CommandLine
);
2840 FreePool(CommandLine2
);
2841 ShellCommandSetNewScript (NULL
);
2844 // Only if this was the last script reset the state.
2846 if (ShellCommandGetCurrentScriptFile()==NULL
) {
2847 ShellCommandSetEchoState(PreScriptEchoState
);
2849 return (EFI_SUCCESS
);
2853 Function to process a NSH script file.
2855 @param[in] ScriptPath Pointer to the script file name (including file system path).
2856 @param[in] Handle the handle of the script file already opened.
2857 @param[in] CmdLine the command line to run.
2858 @param[in] ParamProtocol the shell parameters protocol pointer
2860 @retval EFI_SUCCESS the script completed successfully
2865 IN CONST CHAR16
*ScriptPath
,
2866 IN SHELL_FILE_HANDLE Handle OPTIONAL
,
2867 IN CONST CHAR16
*CmdLine
,
2868 IN EFI_SHELL_PARAMETERS_PROTOCOL
*ParamProtocol
2872 SHELL_FILE_HANDLE FileHandle
;
2876 if (ShellIsFile(ScriptPath
) != EFI_SUCCESS
) {
2877 return (EFI_INVALID_PARAMETER
);
2881 // get the argc and argv updated for scripts
2883 Status
= UpdateArgcArgv(ParamProtocol
, CmdLine
, &Argv
, &Argc
);
2884 if (!EFI_ERROR(Status
)) {
2886 if (Handle
== NULL
) {
2890 Status
= ShellOpenFileByName(ScriptPath
, &FileHandle
, EFI_FILE_MODE_READ
, 0);
2891 if (!EFI_ERROR(Status
)) {
2895 Status
= RunScriptFileHandle(FileHandle
, ScriptPath
);
2898 // now close the file
2900 ShellCloseFile(&FileHandle
);
2903 Status
= RunScriptFileHandle(Handle
, ScriptPath
);
2908 // This is guaranteed to be called after UpdateArgcArgv no matter what else happened.
2909 // This is safe even if the update API failed. In this case, it may be a no-op.
2911 RestoreArgcArgv(ParamProtocol
, &Argv
, &Argc
);
2917 Return the pointer to the first occurrence of any character from a list of characters.
2919 @param[in] String the string to parse
2920 @param[in] CharacterList the list of character to look for
2921 @param[in] EscapeCharacter An escape character to skip
2923 @return the location of the first character in the string
2924 @retval CHAR_NULL no instance of any character in CharacterList was found in String
2929 IN CONST CHAR16
*String
,
2930 IN CONST CHAR16
*CharacterList
,
2931 IN CONST CHAR16 EscapeCharacter
2937 for (WalkStr
= 0; WalkStr
< StrLen(String
); WalkStr
++) {
2938 if (String
[WalkStr
] == EscapeCharacter
) {
2942 for (WalkChar
= 0; WalkChar
< StrLen(CharacterList
); WalkChar
++) {
2943 if (String
[WalkStr
] == CharacterList
[WalkChar
]) {
2944 return (&String
[WalkStr
]);
2948 return (String
+ StrLen(String
));