Skip to content

ShellPkg: Cleanup/refactor of some of the UefiShellLevel1 commands #12414

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pierregondois wants to merge 3 commits into
base: master
Choose a base branch
from
+153 −92
Open

ShellPkg: Cleanup/refactor of some of the UefiShellLevel1 commands #12414

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6905e1b
ShellPkg/UefiShellLevel1: Return if ShellCommandLineParse() failed
pierregondois Apr 7, 2026
3007c56
ShellPkg/UefiShellLevel1: Extract MainCmdXXX() function
pierregondois Apr 7, 2026
98e7df3
ShellPkg/UefiShellLevel1: Lower indentation level in MainCmdXXX()
pierregondois Apr 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 47 additions & 28 deletions ShellPkg/Library/UefiShellLevel1CommandsLib/Exit.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,48 @@ STATIC CONST SHELL_PARAM_ITEM ParamList[] = {
{ NULL, TypeMax }
};

/** Main function of the 'Exit' command.

@param[in] Package List of input parameter for the command.
**/
STATIC
SHELL_STATUS
MainCmdExit (
LIST_ENTRY *Package
)
{
EFI_STATUS Status;
UINT64 RetVal;
CONST CHAR16 *Return;
SHELL_STATUS ShellStatus;

ShellStatus = SHELL_SUCCESS;

//
// return the specified error code
//
Return = ShellCommandLineGetRawValue (Package, 1);
if (Return == NULL) {
// If we are in a batch file and /b then pass TRUE otherwise false...
//
ShellCommandRegisterExit ((BOOLEAN)(gEfiShellProtocol->BatchIsActive () && ShellCommandLineGetFlag (Package, L"/b")), 0);

return SHELL_SUCCESS;
}

Status = ShellConvertStringToUint64 (Return, &RetVal, FALSE, FALSE);
if (EFI_ERROR (Status)) {
ShellPrintHiiDefaultEx (STRING_TOKEN (STR_GEN_PARAM_INV), gShellLevel1HiiHandle, L"exit", Return);
return SHELL_INVALID_PARAMETER;
}

//
// If we are in a batch file and /b then pass TRUE otherwise false...
//
ShellCommandRegisterExit ((BOOLEAN)(gEfiShellProtocol->BatchIsActive () && ShellCommandLineGetFlag (Package, L"/b")), RetVal);
return ShellStatus;
}

/**
Function for 'exit' command.

Expand All @@ -31,8 +73,6 @@ ShellCommandRunExit (
LIST_ENTRY *Package;
CHAR16 *ProblemParam;
SHELL_STATUS ShellStatus;
UINT64 RetVal;
CONST CHAR16 *Return;

ShellStatus = SHELL_SUCCESS;

Expand All @@ -57,34 +97,13 @@ ShellCommandRunExit (
} else {
ASSERT (FALSE);
}
} else {
//
// return the specified error code
//
Return = ShellCommandLineGetRawValue (Package, 1);
if (Return != NULL) {
Status = ShellConvertStringToUint64 (Return, &RetVal, FALSE, FALSE);
if (EFI_ERROR (Status)) {
ShellPrintHiiDefaultEx (STRING_TOKEN (STR_GEN_PARAM_INV), gShellLevel1HiiHandle, L"exit", Return);
ShellStatus = SHELL_INVALID_PARAMETER;
} else {
//
// If we are in a batch file and /b then pass TRUE otherwise false...
//
ShellCommandRegisterExit ((BOOLEAN)(gEfiShellProtocol->BatchIsActive () && ShellCommandLineGetFlag (Package, L"/b")), RetVal);

ShellStatus = SHELL_SUCCESS;
}
} else {
// If we are in a batch file and /b then pass TRUE otherwise false...
//
ShellCommandRegisterExit ((BOOLEAN)(gEfiShellProtocol->BatchIsActive () && ShellCommandLineGetFlag (Package, L"/b")), 0);

ShellStatus = SHELL_SUCCESS;
}

ShellCommandLineFreeVarList (Package);
return ShellStatus;
}

ShellStatus = MainCmdExit (Package);

ShellCommandLineFreeVarList (Package);

return (ShellStatus);
}
104 changes: 62 additions & 42 deletions ShellPkg/Library/UefiShellLevel1CommandsLib/Goto.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,62 @@

#include "UefiShellLevel1CommandsLib.h"

/** Main function of the 'Goto' command.

@param[in] Package List of input parameter for the command.
**/
STATIC
SHELL_STATUS
MainCmdGoto (
LIST_ENTRY *Package
)
{
CHAR16 *CompareString;
UINTN Size;
SCRIPT_FILE *CurrentScriptFile;
SHELL_STATUS ShellStatus;

ShellStatus = SHELL_SUCCESS;
CompareString = NULL;

if (ShellCommandLineGetRawValue (Package, 2) != NULL) {
ShellPrintHiiDefaultEx (STRING_TOKEN (STR_GEN_TOO_MANY), gShellLevel1HiiHandle, L"goto");
return SHELL_INVALID_PARAMETER;
} else if (ShellCommandLineGetRawValue (Package, 1) == NULL) {
ShellPrintHiiDefaultEx (STRING_TOKEN (STR_GEN_TOO_FEW), gShellLevel1HiiHandle, L"goto");
return SHELL_INVALID_PARAMETER;
}

Size = 0;
ASSERT ((CompareString == NULL && Size == 0) || (CompareString != NULL));
CompareString = StrnCatGrow (&CompareString, &Size, L":", 0);
CompareString = StrnCatGrow (&CompareString, &Size, ShellCommandLineGetRawValue (Package, 1), 0);
if (CompareString == NULL) {
return SHELL_OUT_OF_RESOURCES;
}

//
// Check forwards and then backwards for a label...
//
if (!MoveToTag (GetNextNode, L"endfor", L"for", CompareString, ShellCommandGetCurrentScriptFile (), FALSE, FALSE, TRUE)) {
CurrentScriptFile = ShellCommandGetCurrentScriptFile ();
ShellPrintHiiDefaultEx (
STRING_TOKEN (STR_SYNTAX_NO_MATCHING),
gShellLevel1HiiHandle,
CompareString,
L"Goto",
CurrentScriptFile != NULL
&& CurrentScriptFile->CurrentCommand != NULL
? CurrentScriptFile->CurrentCommand->Line : 0
);
ShellStatus = SHELL_NOT_FOUND;
}

FreePool (CompareString);

return ShellStatus;
}

/**
Function for 'goto' command.

Expand All @@ -26,12 +82,8 @@ ShellCommandRunGoto (
LIST_ENTRY *Package;
CHAR16 *ProblemParam;
SHELL_STATUS ShellStatus;
CHAR16 *CompareString;
UINTN Size;
SCRIPT_FILE *CurrentScriptFile;

ShellStatus = SHELL_SUCCESS;
CompareString = NULL;
ShellStatus = SHELL_SUCCESS;

//
// initialize the shell lib (we must be in non-auto-init...)
Expand Down Expand Up @@ -59,45 +111,13 @@ ShellCommandRunGoto (
} else {
ASSERT (FALSE);
}
} else {
if (ShellCommandLineGetRawValue (Package, 2) != NULL) {
ShellPrintHiiDefaultEx (STRING_TOKEN (STR_GEN_TOO_MANY), gShellLevel1HiiHandle, L"goto");
ShellStatus = SHELL_INVALID_PARAMETER;
} else if (ShellCommandLineGetRawValue (Package, 1) == NULL) {
ShellPrintHiiDefaultEx (STRING_TOKEN (STR_GEN_TOO_FEW), gShellLevel1HiiHandle, L"goto");
ShellStatus = SHELL_INVALID_PARAMETER;
} else {
Size = 0;
ASSERT ((CompareString == NULL && Size == 0) || (CompareString != NULL));
CompareString = StrnCatGrow (&CompareString, &Size, L":", 0);
CompareString = StrnCatGrow (&CompareString, &Size, ShellCommandLineGetRawValue (Package, 1), 0);
if (CompareString == NULL) {
ShellCommandLineFreeVarList (Package);
return SHELL_OUT_OF_RESOURCES;
}

//
// Check forwards and then backwards for a label...
//
if (!MoveToTag (GetNextNode, L"endfor", L"for", CompareString, ShellCommandGetCurrentScriptFile (), FALSE, FALSE, TRUE)) {
CurrentScriptFile = ShellCommandGetCurrentScriptFile ();
ShellPrintHiiDefaultEx (
STRING_TOKEN (STR_SYNTAX_NO_MATCHING),
gShellLevel1HiiHandle,
CompareString,
L"Goto",
CurrentScriptFile != NULL
&& CurrentScriptFile->CurrentCommand != NULL
? CurrentScriptFile->CurrentCommand->Line : 0
);
ShellStatus = SHELL_NOT_FOUND;
}

FreePool (CompareString);
}

ShellCommandLineFreeVarList (Package);
return ShellStatus;
}

ShellStatus = MainCmdGoto (Package);

ShellCommandLineFreeVarList (Package);

return (ShellStatus);
}
66 changes: 44 additions & 22 deletions ShellPkg/Library/UefiShellLevel1CommandsLib/Stall.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,45 @@

#include "UefiShellLevel1CommandsLib.h"

/** Main function of the 'Stall' command.

@param[in] Package List of input parameter for the command.
**/
STATIC
SHELL_STATUS
MainCmdStall (
LIST_ENTRY *Package
)
{
EFI_STATUS Status;
SHELL_STATUS ShellStatus;
UINT64 Intermediate;

ShellStatus = SHELL_SUCCESS;

if (ShellCommandLineGetRawValue (Package, 2) != NULL) {
ShellPrintHiiDefaultEx (STRING_TOKEN (STR_GEN_TOO_MANY), gShellLevel1HiiHandle, L"stall");
return SHELL_INVALID_PARAMETER;
} else if (ShellCommandLineGetRawValue (Package, 1) == NULL) {
ShellPrintHiiDefaultEx (STRING_TOKEN (STR_GEN_TOO_FEW), gShellLevel1HiiHandle, L"stall");
return SHELL_INVALID_PARAMETER;
}

Status = ShellConvertStringToUint64 (ShellCommandLineGetRawValue (Package, 1), &Intermediate, FALSE, FALSE);
if (EFI_ERROR (Status) || (((UINT64)(UINTN)(Intermediate)) != Intermediate)) {
ShellPrintHiiDefaultEx (STRING_TOKEN (STR_GEN_PARAM_INV), gShellLevel1HiiHandle, L"stall", ShellCommandLineGetRawValue (Package, 1));
return SHELL_INVALID_PARAMETER;
}

Status = gBS->Stall ((UINTN)Intermediate);
if (EFI_ERROR (Status)) {
ShellPrintHiiDefaultEx (STRING_TOKEN (STR_STALL_FAILED), gShellLevel1HiiHandle, L"stall");
return SHELL_DEVICE_ERROR;
}

return ShellStatus;
}

/**
Function for 'stall' command.

Expand All @@ -26,7 +65,6 @@ ShellCommandRunStall (
LIST_ENTRY *Package;
CHAR16 *ProblemParam;
SHELL_STATUS ShellStatus;
UINT64 Intermediate;

ShellStatus = SHELL_SUCCESS;

Expand All @@ -51,29 +89,13 @@ ShellCommandRunStall (
} else {
ASSERT (FALSE);
}
} else {
if (ShellCommandLineGetRawValue (Package, 2) != NULL) {
ShellPrintHiiDefaultEx (STRING_TOKEN (STR_GEN_TOO_MANY), gShellLevel1HiiHandle, L"stall");
ShellStatus = SHELL_INVALID_PARAMETER;
} else if (ShellCommandLineGetRawValue (Package, 1) == NULL) {
ShellPrintHiiDefaultEx (STRING_TOKEN (STR_GEN_TOO_FEW), gShellLevel1HiiHandle, L"stall");
ShellStatus = SHELL_INVALID_PARAMETER;
} else {
Status = ShellConvertStringToUint64 (ShellCommandLineGetRawValue (Package, 1), &Intermediate, FALSE, FALSE);
if (EFI_ERROR (Status) || (((UINT64)(UINTN)(Intermediate)) != Intermediate)) {
ShellPrintHiiDefaultEx (STRING_TOKEN (STR_GEN_PARAM_INV), gShellLevel1HiiHandle, L"stall", ShellCommandLineGetRawValue (Package, 1));
ShellStatus = SHELL_INVALID_PARAMETER;
} else {
Status = gBS->Stall ((UINTN)Intermediate);
if (EFI_ERROR (Status)) {
ShellPrintHiiDefaultEx (STRING_TOKEN (STR_STALL_FAILED), gShellLevel1HiiHandle, L"stall");
ShellStatus = SHELL_DEVICE_ERROR;
}
}
}

ShellCommandLineFreeVarList (Package);
return ShellStatus;
}

ShellStatus = MainCmdStall (Package);

ShellCommandLineFreeVarList (Package);

return (ShellStatus);
}
Loading