ShellPkg/Library/UefiShellDebug1CommandsLib/DmpStore.c

   1 /** @file
   2   Main file for DmpStore shell Debug1 function.
   3
   4   Copyright (c) 2005 - 2010, Intel Corporation. All rights reserved.<BR>
   5   This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #include "UefiShellDebug1CommandsLib.h"
  16
  17 STATIC CHAR16   *AttrType[] = {
  18   L"invalid",   // 000
  19   L"invalid",   // 001
  20   L"BS",        // 010
  21   L"NV+BS",     // 011
  22   L"RT+BS",     // 100
  23   L"NV+RT+BS",  // 101
  24   L"RT+BS",     // 110
  25   L"NV+RT+BS",  // 111
  26 };
  27
  28 SHELL_STATUS
  29 EFIAPI
  30 ProcessVariables (
  31   IN CONST CHAR16   *VariableName OPTIONAL,
  32   IN CONST EFI_GUID *Guid OPTIONAL,
  33   IN BOOLEAN        Delete
  34   )
  35 {
  36   EFI_STATUS                Status;
  37   UINT64                    MaxStorSize;
  38   UINT64                    RemStorSize;
  39   UINT64                    MaxVarSize;
  40   CHAR16                    *FoundVarName;
  41   UINTN                     Size;
  42   EFI_GUID                  FoundVarGuid;
  43   UINT8                     *DataBuffer;
  44   UINTN                     DataSize;
  45   UINT32                    Atts;
  46   SHELL_STATUS              ShellStatus;
  47
  48   ShellStatus   = SHELL_SUCCESS;
  49   Size          = PcdGet16(PcdShellFileOperationSize);
  50   FoundVarName  = AllocatePool(Size);
  51
  52   if (FoundVarName == NULL) {
  53     return (SHELL_OUT_OF_RESOURCES);
  54   }
  55   FoundVarName[0] = CHAR_NULL;
  56
  57   Status = gRT->QueryVariableInfo(EFI_VARIABLE_BOOTSERVICE_ACCESS|EFI_VARIABLE_RUNTIME_ACCESS|EFI_VARIABLE_NON_VOLATILE, &MaxStorSize, &RemStorSize, &MaxVarSize);
  58   ASSERT_EFI_ERROR(Status);
  59
  60   DataSize = (UINTN)MaxVarSize;
  61   DataBuffer = AllocatePool(DataSize);
  62   if (DataBuffer == NULL) {
  63     FreePool(FoundVarName);
  64     return (SHELL_OUT_OF_RESOURCES);
  65   }
  66
  67   for (;;){
  68     if (ShellGetExecutionBreakFlag()) {
  69       ShellStatus = SHELL_ABORTED;
  70       break;
  71     }
  72     Size      = (UINTN)PcdGet16(PcdShellFileOperationSize);
  73     DataSize  = (UINTN)MaxVarSize;
  74
  75     Status = gRT->GetNextVariableName(&Size, FoundVarName, &FoundVarGuid);
  76     if (Status == EFI_NOT_FOUND) {
  77       break;
  78     }
  79     ASSERT_EFI_ERROR(Status);
  80
  81     Status = gRT->GetVariable(FoundVarName, &FoundVarGuid, &Atts, &DataSize, DataBuffer);
  82     ASSERT_EFI_ERROR(Status);
  83
  84     //
  85     // Check if it matches
  86     //
  87     if (VariableName != NULL) {
  88       if (!gUnicodeCollation->MetaiMatch(gUnicodeCollation, FoundVarName, (CHAR16*)VariableName)) {
  89         continue;
  90       }
  91     }
  92     if (Guid != NULL) {
  93       if (!CompareGuid(&FoundVarGuid, Guid)) {
  94         continue;
  95       }
  96     }
  97
  98     //
  99     // do the print or delete
 100     //
 101     if (!Delete) {
 102       ShellPrintHiiEx(
 103         -1,
 104         -1,
 105         NULL,
 106         STRING_TOKEN(STR_DMPSTORE_HEADER_LINE),
 107         gShellDebug1HiiHandle,
 108         AttrType[Atts & 7],
 109         &FoundVarGuid,
 110         FoundVarName,
 111         DataSize);
 112       DumpHex(2, 0, DataSize, DataBuffer);
 113     } else {
 114       ShellPrintHiiEx(
 115         -1,
 116         -1,
 117         NULL,
 118         STRING_TOKEN(STR_DMPSTORE_DELETE_LINE),
 119         gShellDebug1HiiHandle,
 120         &FoundVarGuid,
 121         FoundVarName);
 122       ShellPrintHiiEx(
 123         -1,
 124         -1,
 125         NULL,
 126         STRING_TOKEN(STR_DMPSTORE_DELETE_DONE),
 127         gShellDebug1HiiHandle,
 128         gRT->SetVariable(FoundVarName, &FoundVarGuid, Atts, 0, NULL));
 129     }
 130   }
 131
 132   if (FoundVarName != NULL) {
 133     FreePool(FoundVarName);
 134   }
 135   if (DataBuffer != NULL) {
 136     FreePool(DataBuffer);
 137   }
 138
 139   return (SHELL_UNSUPPORTED);
 140 }
 141
 142 STATIC CONST SHELL_PARAM_ITEM ParamList[] = {
 143   {L"-d", TypeFlag},
 144   {L"-l", TypeFlag},
 145   {L"-s", TypeFlag},
 146   {L"-all", TypeFlag},
 147   {L"-guid", TypeValue},
 148   {NULL, TypeMax}
 149   };
 150
 151 SHELL_STATUS
 152 EFIAPI
 153 ShellCommandRunDmpStore (
 154   IN EFI_HANDLE        ImageHandle,
 155   IN EFI_SYSTEM_TABLE  *SystemTable
 156   )
 157 {
 158   EFI_STATUS    Status;
 159   LIST_ENTRY    *Package;
 160   CHAR16        *ProblemParam;
 161   SHELL_STATUS  ShellStatus;
 162   CONST CHAR16  *Temp;
 163   EFI_GUID      *Guid;
 164   EFI_GUID      GuidData;
 165   CONST CHAR16  *VariableName;
 166
 167   ShellStatus   = SHELL_SUCCESS;
 168   Package       = NULL;
 169
 170   Status = ShellCommandLineParse (ParamList, &Package, &ProblemParam, TRUE);
 171   if (EFI_ERROR(Status)) {
 172     if (Status == EFI_VOLUME_CORRUPTED && ProblemParam != NULL) {
 173       ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellDebug1HiiHandle, ProblemParam);
 174       FreePool(ProblemParam);
 175       ShellStatus = SHELL_INVALID_PARAMETER;
 176     } else {
 177       ASSERT(FALSE);
 178     }
 179   } else {
 180     if (ShellCommandLineGetCount(Package) < 1) {
 181       ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_FEW), gShellDebug1HiiHandle);
 182       ShellStatus = SHELL_INVALID_PARAMETER;
 183     } else if (ShellCommandLineGetCount(Package) > 2) {
 184       ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_MANY), gShellDebug1HiiHandle);
 185       ShellStatus = SHELL_INVALID_PARAMETER;
 186     } else if (ShellCommandLineGetFlag(Package, L"-all") && ShellCommandLineGetFlag(Package, L"-guid")) {
 187       ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_CONFLICT), gShellDebug1HiiHandle, L"-all", L"-guid");
 188       ShellStatus = SHELL_INVALID_PARAMETER;
 189     } else if ((ShellCommandLineGetFlag(Package, L"-s") || ShellCommandLineGetFlag(Package, L"-l")) && ShellCommandLineGetFlag(Package, L"-d")) {
 190       ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_CONFLICT), gShellDebug1HiiHandle, L"-l or -s", L"-d");
 191       ShellStatus = SHELL_INVALID_PARAMETER;
 192     } else {
 193       if (!ShellCommandLineGetFlag(Package, L"-all")) {
 194         Temp = ShellCommandLineGetValue(Package, L"-guid");
 195         if (Temp != NULL) {
 196           Status = ConvertStringToGuid(Temp, &GuidData);
 197           if (EFI_ERROR(Status)) {
 198             ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellDebug1HiiHandle, L"-guid");
 199             ShellStatus = SHELL_INVALID_PARAMETER;
 200           }
 201           Guid = &GuidData;
 202         } else  {
 203           Guid = &gEfiGlobalVariableGuid;
 204         }
 205         VariableName = ShellCommandLineGetRawValue(Package, 2);
 206       } else {
 207         VariableName  = NULL;
 208         Guid          = NULL;
 209       }
 210       if (ShellStatus == SHELL_SUCCESS) {
 211         if (ShellCommandLineGetFlag(Package, L"-s") || ShellCommandLineGetFlag(Package, L"-l")) {
 212           ///@todo fix this after Jordan makes lib...
 213           ShellPrintEx(-1, -1, L"Not implemeneted yet (ASSERT follows).\r\n");
 214           ShellStatus = SHELL_INVALID_PARAMETER;
 215           ASSERT(FALSE);
 216         } else {
 217           ShellStatus = ProcessVariables (VariableName, Guid, ShellCommandLineGetFlag(Package, L"-d"));
 218         }
 219       }
 220     }
 221   }
 222
 223   if (Package != NULL) {
 224     ShellCommandLineFreeVarList (Package);
 225   }
 226   return ShellStatus;
 227 }
 228