452676ffd8
The original code as below intend to set the character before last column to CHAR_NULL. Line[(LastCol % (ARRAY_SIZE (Line) - 1)) - 1] = CHAR_NULL; But when LastCol % (ARRAY_SIZE (Line) - 1)) equals to 0, Line[-1] is modified. We should change to code as below: Line[(LastCol - 1) % (ARRAY_SIZE (Line) - 1)] = CHAR_NULL; Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Ruiyu Ni <ruiyu.ni@intel.com> Reviewed-by: Jaben Carsey <jaben.carsey@intel.com> Reviewed-by: Hao A Wu <hao.a.wu@intel.com>
456 lines
14 KiB
C
456 lines
14 KiB
C
/** @file
|
|
Main file for NULL named library for debug1 profile shell command functions.
|
|
|
|
Copyright (c) 2010 - 2017, Intel Corporation. All rights reserved.<BR>
|
|
This program and the accompanying materials
|
|
are licensed and made available under the terms and conditions of the BSD License
|
|
which accompanies this distribution. The full text of the license may be found at
|
|
http://opensource.org/licenses/bsd-license.php
|
|
|
|
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
|
|
|
**/
|
|
|
|
#include "UefiShellDebug1CommandsLib.h"
|
|
#include <Library/BcfgCommandLib.h>
|
|
|
|
STATIC CONST CHAR16 mFileName[] = L"Debug1Commands";
|
|
EFI_HANDLE gShellDebug1HiiHandle = NULL;
|
|
|
|
/**
|
|
Gets the debug file name. This will be used if HII is not working.
|
|
|
|
@retval NULL No file is available.
|
|
@return The NULL-terminated filename to get help from.
|
|
**/
|
|
CONST CHAR16*
|
|
EFIAPI
|
|
ShellCommandGetManFileNameDebug1 (
|
|
VOID
|
|
)
|
|
{
|
|
return (mFileName);
|
|
}
|
|
|
|
/**
|
|
Constructor for the Shell Debug1 Commands library.
|
|
|
|
@param ImageHandle the image handle of the process
|
|
@param SystemTable the EFI System Table pointer
|
|
|
|
@retval EFI_SUCCESS the shell command handlers were installed sucessfully
|
|
@retval EFI_UNSUPPORTED the shell level required was not found.
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
UefiShellDebug1CommandsLibConstructor (
|
|
IN EFI_HANDLE ImageHandle,
|
|
IN EFI_SYSTEM_TABLE *SystemTable
|
|
)
|
|
{
|
|
//
|
|
// check our bit of the profiles mask
|
|
//
|
|
if ((PcdGet8(PcdShellProfileMask) & BIT1) == 0) {
|
|
return (EFI_SUCCESS);
|
|
}
|
|
|
|
//
|
|
// install the HII stuff.
|
|
//
|
|
gShellDebug1HiiHandle = HiiAddPackages (&gShellDebug1HiiGuid, gImageHandle, UefiShellDebug1CommandsLibStrings, NULL);
|
|
if (gShellDebug1HiiHandle == NULL) {
|
|
return (EFI_DEVICE_ERROR);
|
|
}
|
|
|
|
//
|
|
// install our shell command handlers that are always installed
|
|
//
|
|
ShellCommandRegisterCommandName(L"setsize", ShellCommandRunSetSize , ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN(STR_GET_HELP_SETSIZE) );
|
|
ShellCommandRegisterCommandName(L"comp", ShellCommandRunComp , ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN(STR_GET_HELP_COMP) );
|
|
ShellCommandRegisterCommandName(L"mode", ShellCommandRunMode , ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN(STR_GET_HELP_MODE) );
|
|
ShellCommandRegisterCommandName(L"memmap", ShellCommandRunMemMap , ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN(STR_GET_HELP_MEMMAP) );
|
|
ShellCommandRegisterCommandName(L"eficompress", ShellCommandRunEfiCompress , ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN(STR_GET_HELP_EFICOMPRESS) );
|
|
ShellCommandRegisterCommandName(L"efidecompress", ShellCommandRunEfiDecompress , ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN(STR_GET_HELP_EFIDCOMPRESS) );
|
|
ShellCommandRegisterCommandName(L"dmem", ShellCommandRunDmem , ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN(STR_GET_HELP_DMEM) );
|
|
ShellCommandRegisterCommandName(L"loadpcirom", ShellCommandRunLoadPciRom , ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN(STR_GET_HELP_LOAD_PCI_ROM) );
|
|
ShellCommandRegisterCommandName(L"mm", ShellCommandRunMm , ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN(STR_GET_HELP_MM) );
|
|
ShellCommandRegisterCommandName(L"setvar", ShellCommandRunSetVar , ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN(STR_GET_HELP_SETVAR) );
|
|
ShellCommandRegisterCommandName(L"sermode", ShellCommandRunSerMode , ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN(STR_GET_HELP_SERMODE) );
|
|
ShellCommandRegisterCommandName(L"pci", ShellCommandRunPci , ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN(STR_GET_HELP_PCI) );
|
|
ShellCommandRegisterCommandName(L"smbiosview", ShellCommandRunSmbiosView , ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN(STR_GET_HELP_SMBIOSVIEW) );
|
|
ShellCommandRegisterCommandName(L"dmpstore", ShellCommandRunDmpStore , ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN(STR_GET_HELP_DMPSTORE) );
|
|
ShellCommandRegisterCommandName(L"dblk", ShellCommandRunDblk , ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN(STR_GET_HELP_DBLK) );
|
|
ShellCommandRegisterCommandName(L"edit", ShellCommandRunEdit , ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN(STR_GET_HELP_EDIT) );
|
|
ShellCommandRegisterCommandName(L"hexedit", ShellCommandRunHexEdit , ShellCommandGetManFileNameDebug1, 0, L"Debug1", TRUE, gShellDebug1HiiHandle, STRING_TOKEN(STR_GET_HELP_HEXEDIT) );
|
|
|
|
ShellCommandRegisterAlias(L"dmem", L"mem");
|
|
|
|
BcfgLibraryRegisterBcfgCommand(ImageHandle, SystemTable, L"Debug1");
|
|
|
|
return (EFI_SUCCESS);
|
|
}
|
|
|
|
/**
|
|
Destructor for the library. free any resources.
|
|
|
|
@param ImageHandle The image handle of the process.
|
|
@param SystemTable The EFI System Table pointer.
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
UefiShellDebug1CommandsLibDestructor (
|
|
IN EFI_HANDLE ImageHandle,
|
|
IN EFI_SYSTEM_TABLE *SystemTable
|
|
)
|
|
{
|
|
if (gShellDebug1HiiHandle != NULL) {
|
|
HiiRemovePackages(gShellDebug1HiiHandle);
|
|
}
|
|
|
|
BcfgLibraryUnregisterBcfgCommand(ImageHandle, SystemTable);
|
|
return (EFI_SUCCESS);
|
|
}
|
|
|
|
/**
|
|
Convert a Unicode character to upper case only if
|
|
it maps to a valid small-case ASCII character.
|
|
|
|
This internal function only deal with Unicode character
|
|
which maps to a valid small-case ASCII character, i.e.
|
|
L'a' to L'z'. For other Unicode character, the input character
|
|
is returned directly.
|
|
|
|
@param Char The character to convert.
|
|
|
|
@retval LowerCharacter If the Char is with range L'a' to L'z'.
|
|
@retval Unchanged Otherwise.
|
|
|
|
|
|
//Stolen from MdePkg Baselib
|
|
**/
|
|
CHAR16
|
|
CharToUpper (
|
|
IN CHAR16 Char
|
|
)
|
|
{
|
|
if (Char >= L'a' && Char <= L'z') {
|
|
return (CHAR16) (Char - (L'a' - L'A'));
|
|
}
|
|
|
|
return Char;
|
|
}
|
|
|
|
/**
|
|
Function returns a system configuration table that is stored in the
|
|
EFI System Table based on the provided GUID.
|
|
|
|
@param[in] TableGuid A pointer to the table's GUID type.
|
|
@param[in, out] Table On exit, a pointer to a system configuration table.
|
|
|
|
@retval EFI_SUCCESS A configuration table matching TableGuid was found.
|
|
@retval EFI_NOT_FOUND A configuration table matching TableGuid was not found.
|
|
**/
|
|
EFI_STATUS
|
|
GetSystemConfigurationTable (
|
|
IN EFI_GUID *TableGuid,
|
|
IN OUT VOID **Table
|
|
)
|
|
{
|
|
UINTN Index;
|
|
ASSERT (Table != NULL);
|
|
|
|
for (Index = 0; Index < gST->NumberOfTableEntries; Index++) {
|
|
if (CompareGuid (TableGuid, &(gST->ConfigurationTable[Index].VendorGuid))) {
|
|
*Table = gST->ConfigurationTable[Index].VendorTable;
|
|
return EFI_SUCCESS;
|
|
}
|
|
}
|
|
|
|
return EFI_NOT_FOUND;
|
|
}
|
|
|
|
/**
|
|
Clear the line at the specified Row.
|
|
|
|
@param[in] Row The row number to be cleared ( start from 1 )
|
|
@param[in] LastCol The last printable column.
|
|
@param[in] LastRow The last printable row.
|
|
**/
|
|
VOID
|
|
EditorClearLine (
|
|
IN UINTN Row,
|
|
IN UINTN LastCol,
|
|
IN UINTN LastRow
|
|
)
|
|
{
|
|
UINTN Col;
|
|
CHAR16 Line[200];
|
|
|
|
if (Row == 0) {
|
|
Row = 1;
|
|
}
|
|
|
|
//
|
|
// prepare a blank line
|
|
// If max column is larger, split to multiple prints.
|
|
//
|
|
SetMem16 (Line, sizeof (Line), L' ');
|
|
Line[ARRAY_SIZE (Line) - 1] = CHAR_NULL;
|
|
|
|
for (Col = 1; Col <= LastCol; Col += ARRAY_SIZE (Line) - 1) {
|
|
if (Col + ARRAY_SIZE (Line) - 1 > LastCol) {
|
|
if (Row == LastRow) {
|
|
//
|
|
// if CHAR_NULL is still at position LastCol, it will cause first line error
|
|
//
|
|
Line[(LastCol - 1) % (ARRAY_SIZE (Line) - 1)] = CHAR_NULL;
|
|
} else {
|
|
Line[LastCol % (ARRAY_SIZE (Line) - 1)] = CHAR_NULL;
|
|
}
|
|
}
|
|
|
|
//
|
|
// print out the blank line
|
|
//
|
|
ShellPrintEx ((INT32) Col - 1, (INT32) Row - 1, Line);
|
|
}
|
|
}
|
|
|
|
/**
|
|
Determine if the character is valid for a filename.
|
|
|
|
@param[in] Ch The character to test.
|
|
|
|
@retval TRUE The character is valid.
|
|
@retval FALSE The character is not valid.
|
|
**/
|
|
BOOLEAN
|
|
IsValidFileNameChar (
|
|
IN CONST CHAR16 Ch
|
|
)
|
|
{
|
|
//
|
|
// See if there are any illegal characters within the name
|
|
//
|
|
if (Ch < 0x20 || Ch == L'\"' || Ch == L'*' || Ch == L'/' || Ch == L'<' || Ch == L'>' || Ch == L'?' || Ch == L'|') {
|
|
return FALSE;
|
|
}
|
|
|
|
return TRUE;
|
|
}
|
|
|
|
/**
|
|
Check if file name has illegal characters.
|
|
|
|
@param Name The filename to check.
|
|
|
|
@retval TRUE The filename is ok.
|
|
@retval FALSE The filename is not ok.
|
|
**/
|
|
BOOLEAN
|
|
IsValidFileName (
|
|
IN CONST CHAR16 *Name
|
|
)
|
|
{
|
|
|
|
UINTN Index;
|
|
UINTN Len;
|
|
|
|
//
|
|
// check the length of Name
|
|
//
|
|
for (Len = 0, Index = StrLen (Name) - 1; Index + 1 != 0; Index--, Len++) {
|
|
if (Name[Index] == '\\' || Name[Index] == ':') {
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (Len == 0 || Len > 255) {
|
|
return FALSE;
|
|
}
|
|
//
|
|
// check whether any char in Name not appears in valid file name char
|
|
//
|
|
for (Index = 0; Index < StrLen (Name); Index++) {
|
|
if (!IsValidFileNameChar (Name[Index])) {
|
|
return FALSE;
|
|
}
|
|
}
|
|
|
|
return TRUE;
|
|
}
|
|
|
|
/**
|
|
Find a filename that is valid (not taken) with the given extension.
|
|
|
|
@param[in] Extension The file extension.
|
|
|
|
@retval NULL Something went wrong.
|
|
@return the valid filename.
|
|
**/
|
|
CHAR16 *
|
|
EditGetDefaultFileName (
|
|
IN CONST CHAR16 *Extension
|
|
)
|
|
{
|
|
EFI_STATUS Status;
|
|
UINTN Suffix;
|
|
CHAR16 *FileNameTmp;
|
|
|
|
Suffix = 0;
|
|
|
|
do {
|
|
FileNameTmp = CatSPrint (NULL, L"NewFile%d.%s", Suffix, Extension);
|
|
|
|
//
|
|
// after that filename changed to path
|
|
//
|
|
Status = ShellFileExists (FileNameTmp);
|
|
|
|
if (Status == EFI_NOT_FOUND) {
|
|
return FileNameTmp;
|
|
}
|
|
|
|
FreePool (FileNameTmp);
|
|
FileNameTmp = NULL;
|
|
Suffix++;
|
|
} while (Suffix != 0);
|
|
|
|
FreePool (FileNameTmp);
|
|
return NULL;
|
|
}
|
|
|
|
/**
|
|
Read a file into an allocated buffer. The buffer is the responsibility
|
|
of the caller to free.
|
|
|
|
@param[in] FileName The filename of the file to open.
|
|
@param[out] Buffer Upon successful return, the pointer to the
|
|
address of the allocated buffer.
|
|
@param[out] BufferSize If not NULL, then the pointer to the size
|
|
of the allocated buffer.
|
|
@param[out] ReadOnly Upon successful return TRUE if the file is
|
|
read only. FALSE otherwise.
|
|
|
|
@retval EFI_NOT_FOUND The filename did not represent a file in the
|
|
file system.
|
|
@retval EFI_SUCCESS The file was read into the buffer.
|
|
@retval EFI_OUT_OF_RESOURCES A memory allocation failed.
|
|
@retval EFI_LOAD_ERROR The file read operation failed.
|
|
@retval EFI_INVALID_PARAMETER A parameter was invalid.
|
|
@retval EFI_INVALID_PARAMETER FileName was NULL.
|
|
@retval EFI_INVALID_PARAMETER FileName was a directory.
|
|
**/
|
|
EFI_STATUS
|
|
ReadFileIntoBuffer (
|
|
IN CONST CHAR16 *FileName,
|
|
OUT VOID **Buffer,
|
|
OUT UINTN *BufferSize OPTIONAL,
|
|
OUT BOOLEAN *ReadOnly
|
|
)
|
|
{
|
|
VOID *InternalBuffer;
|
|
UINTN FileSize;
|
|
SHELL_FILE_HANDLE FileHandle;
|
|
BOOLEAN CreateFile;
|
|
EFI_STATUS Status;
|
|
EFI_FILE_INFO *Info;
|
|
|
|
InternalBuffer = NULL;
|
|
FileSize = 0;
|
|
FileHandle = NULL;
|
|
CreateFile = FALSE;
|
|
Status = EFI_SUCCESS;
|
|
Info = NULL;
|
|
|
|
if (FileName == NULL || Buffer == NULL || ReadOnly == NULL) {
|
|
return (EFI_INVALID_PARAMETER);
|
|
}
|
|
|
|
//
|
|
// try to open the file
|
|
//
|
|
Status = ShellOpenFileByName (FileName, &FileHandle, EFI_FILE_MODE_READ, 0);
|
|
|
|
if (!EFI_ERROR(Status)) {
|
|
ASSERT(CreateFile == FALSE);
|
|
if (FileHandle == NULL) {
|
|
return EFI_LOAD_ERROR;
|
|
}
|
|
|
|
Info = ShellGetFileInfo(FileHandle);
|
|
|
|
if (Info->Attribute & EFI_FILE_DIRECTORY) {
|
|
FreePool (Info);
|
|
return EFI_INVALID_PARAMETER;
|
|
}
|
|
|
|
if (Info->Attribute & EFI_FILE_READ_ONLY) {
|
|
*ReadOnly = TRUE;
|
|
} else {
|
|
*ReadOnly = FALSE;
|
|
}
|
|
//
|
|
// get file size
|
|
//
|
|
FileSize = (UINTN) Info->FileSize;
|
|
|
|
FreePool (Info);
|
|
} else if (Status == EFI_NOT_FOUND) {
|
|
//
|
|
// file not exists. add create and try again
|
|
//
|
|
Status = ShellOpenFileByName (FileName, &FileHandle, EFI_FILE_MODE_READ|EFI_FILE_MODE_WRITE|EFI_FILE_MODE_CREATE, 0);
|
|
if (EFI_ERROR (Status)) {
|
|
return Status;
|
|
} else {
|
|
//
|
|
// it worked. now delete it and move on with the name (now validated)
|
|
//
|
|
Status = ShellDeleteFile (&FileHandle);
|
|
if (Status == EFI_WARN_DELETE_FAILURE) {
|
|
Status = EFI_ACCESS_DENIED;
|
|
}
|
|
if (EFI_ERROR (Status)) {
|
|
return Status;
|
|
}
|
|
}
|
|
//
|
|
// file doesn't exist, so set CreateFile to TRUE and can't be read-only
|
|
//
|
|
CreateFile = TRUE;
|
|
*ReadOnly = FALSE;
|
|
}
|
|
|
|
//
|
|
// the file exists
|
|
//
|
|
if (!CreateFile) {
|
|
//
|
|
// allocate buffer to read file
|
|
//
|
|
InternalBuffer = AllocateZeroPool (FileSize);
|
|
if (InternalBuffer == NULL) {
|
|
return EFI_OUT_OF_RESOURCES;
|
|
}
|
|
//
|
|
// read file into InternalBuffer
|
|
//
|
|
Status = ShellReadFile (FileHandle, &FileSize, InternalBuffer);
|
|
ShellCloseFile(&FileHandle);
|
|
FileHandle = NULL;
|
|
if (EFI_ERROR (Status)) {
|
|
SHELL_FREE_NON_NULL (InternalBuffer);
|
|
return EFI_LOAD_ERROR;
|
|
}
|
|
}
|
|
*Buffer = InternalBuffer;
|
|
if (BufferSize != NULL) {
|
|
*BufferSize = FileSize;
|
|
}
|
|
return (EFI_SUCCESS);
|
|
|
|
}
|