ShellPkg/Library/UefiShellLevel2CommandsLib/Vol.c

   1 /** @file
   2   Main file for vol shell level 2 function.
   3
   4   Copyright (c) 2011, 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 "UefiShellLevel2CommandsLib.h"
  16 #include <Guid/FileSystemInfo.h>
  17 #include <Guid/FileSystemVolumeLabelInfo.h>
  18
  19 /**
  20   Print the info or change the volume info.
  21
  22   @param[in] Path           String with starting path.
  23   @param[in] Delete         TRUE to delete the volume label. FALSE otherwise.
  24   @param[in] Name           New name to set to the volume label.
  25
  26   @retval SHELL_SUCCESS     The operation was sucessful.
  27 **/
  28 SHELL_STATUS
  29 EFIAPI
  30 HandleVol(
  31   IN CONST CHAR16  *Path,
  32   IN CONST BOOLEAN Delete,
  33   IN CONST CHAR16  *Name
  34   )
  35 {
  36   EFI_STATUS            Status;
  37   SHELL_STATUS          ShellStatus;
  38   EFI_FILE_SYSTEM_INFO  *SysInfo;
  39   UINTN                 SysInfoSize;
  40   SHELL_FILE_HANDLE     ShellFileHandle;
  41   EFI_FILE_PROTOCOL     *EfiFpHandle;
  42   UINTN                 Size1;
  43   UINTN                 Size2;
  44
  45   ShellStatus   = SHELL_SUCCESS;
  46
  47   Status = gEfiShellProtocol->OpenFileByName(
  48     Path,
  49     &ShellFileHandle,
  50     Name != NULL?EFI_FILE_MODE_READ|EFI_FILE_MODE_WRITE:EFI_FILE_MODE_READ);
  51
  52   if (EFI_ERROR(Status) || ShellFileHandle == NULL) {
  53     ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_FILE_OPEN_FAIL), gShellLevel2HiiHandle, Path);
  54     ShellStatus = SHELL_ACCESS_DENIED;
  55     return (ShellStatus);
  56   }
  57
  58   //
  59   // Get the Volume Info from ShellFileHandle
  60   //
  61   SysInfo     = NULL;
  62   SysInfoSize = 0;
  63   EfiFpHandle = ConvertShellHandleToEfiFileProtocol(ShellFileHandle);
  64   Status = EfiFpHandle->GetInfo(
  65     EfiFpHandle,
  66     &gEfiFileSystemInfoGuid,
  67     &SysInfoSize,
  68     SysInfo);
  69
  70   if (Status == EFI_BUFFER_TOO_SMALL) {
  71     SysInfo = AllocateZeroPool(SysInfoSize);
  72     Status = EfiFpHandle->GetInfo(
  73       EfiFpHandle,
  74       &gEfiFileSystemInfoGuid,
  75       &SysInfoSize,
  76       SysInfo);
  77   }
  78
  79   if (Delete) {
  80     StrCpy ((CHAR16 *) SysInfo->VolumeLabel, L"");
  81     SysInfo->Size = SIZE_OF_EFI_FILE_SYSTEM_INFO + StrSize(SysInfo->VolumeLabel);
  82     Status = EfiFpHandle->SetInfo(
  83       EfiFpHandle,
  84       &gEfiFileSystemInfoGuid,
  85       (UINTN)SysInfo->Size,
  86       SysInfo);
  87   } else if (Name != NULL) {
  88     Size1 = StrSize(Name);
  89     Size2 = StrSize(SysInfo->VolumeLabel);
  90     if (Size1 > Size2) {
  91       SysInfo = ReallocatePool((UINTN)SysInfo->Size, (UINTN)SysInfo->Size + Size1 - Size2, SysInfo);
  92     }
  93     StrCpy ((CHAR16 *) SysInfo->VolumeLabel, Name);
  94     SysInfo->Size = SIZE_OF_EFI_FILE_SYSTEM_INFO + Size1;
  95     Status = EfiFpHandle->SetInfo(
  96       EfiFpHandle,
  97       &gEfiFileSystemInfoGuid,
  98       (UINTN)SysInfo->Size,
  99       SysInfo);
 100   }
 101
 102   FreePool(SysInfo);
 103
 104   if (Delete || Name != NULL) {
 105     if (EFI_ERROR(Status)) {
 106       ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_FILE_AD), gShellLevel2HiiHandle, Path);
 107       ShellStatus = SHELL_ACCESS_DENIED;
 108     }
 109   }
 110
 111   SysInfoSize = 0;
 112   SysInfo = NULL;
 113
 114   Status = EfiFpHandle->GetInfo(
 115     EfiFpHandle,
 116     &gEfiFileSystemInfoGuid,
 117     &SysInfoSize,
 118     SysInfo);
 119
 120   if (Status == EFI_BUFFER_TOO_SMALL) {
 121     SysInfo = AllocateZeroPool(SysInfoSize);
 122     Status = EfiFpHandle->GetInfo(
 123       EfiFpHandle,
 124       &gEfiFileSystemInfoGuid,
 125       &SysInfoSize,
 126       SysInfo);
 127   }
 128
 129   gEfiShellProtocol->CloseFile(ShellFileHandle);
 130
 131   //
 132   // print VolumeInfo table
 133   //
 134   ShellPrintHiiEx (
 135     0,
 136     gST->ConOut->Mode->CursorRow,
 137     NULL,
 138     STRING_TOKEN (STR_VOL_VOLINFO),
 139     gShellLevel2HiiHandle,
 140     SysInfo->VolumeLabel,
 141     SysInfo->ReadOnly?L"r":L"rw",
 142     SysInfo->VolumeSize,
 143     SysInfo->FreeSpace,
 144     SysInfo->BlockSize
 145    );
 146   SHELL_FREE_NON_NULL(SysInfo);
 147
 148   return (ShellStatus);
 149 }
 150
 151 STATIC CONST SHELL_PARAM_ITEM ParamList[] = {
 152   {L"-d", TypeFlag},
 153   {L"-n", TypeValue},
 154   {NULL, TypeMax}
 155   };
 156
 157 /**
 158   Function for 'Vol' command.
 159
 160   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
 161   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
 162 **/
 163 SHELL_STATUS
 164 EFIAPI
 165 ShellCommandRunVol (
 166   IN EFI_HANDLE        ImageHandle,
 167   IN EFI_SYSTEM_TABLE  *SystemTable
 168   )
 169 {
 170   EFI_STATUS    Status;
 171   LIST_ENTRY    *Package;
 172   CHAR16        *ProblemParam;
 173   SHELL_STATUS  ShellStatus;
 174   CONST CHAR16  *PathName;
 175   CONST CHAR16  *CurDir;
 176   BOOLEAN       DeleteMode;
 177   CHAR16        *FullPath;
 178   CHAR16        *TempSpot;
 179   UINTN         Length;
 180
 181   Length              = 0;
 182   ProblemParam        = NULL;
 183   ShellStatus         = SHELL_SUCCESS;
 184   PathName            = NULL;
 185   CurDir              = NULL;
 186   FullPath            = NULL;
 187
 188   //
 189   // initialize the shell lib (we must be in non-auto-init...)
 190   //
 191   Status = ShellInitialize();
 192   ASSERT_EFI_ERROR(Status);
 193
 194   //
 195   // Fix local copies of the protocol pointers
 196   //
 197   Status = CommandInit();
 198   ASSERT_EFI_ERROR(Status);
 199
 200   //
 201   // parse the command line
 202   //
 203   Status = ShellCommandLineParse (ParamList, &Package, &ProblemParam, TRUE);
 204   if (EFI_ERROR(Status)) {
 205     if (Status == EFI_VOLUME_CORRUPTED && ProblemParam != NULL) {
 206       ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellLevel2HiiHandle, ProblemParam);
 207       FreePool(ProblemParam);
 208       ShellStatus = SHELL_INVALID_PARAMETER;
 209     } else {
 210       ASSERT(FALSE);
 211     }
 212   } else {
 213     //
 214     // check for "-?"
 215     //
 216     if (ShellCommandLineGetFlag(Package, L"-?")) {
 217       ASSERT(FALSE);
 218     }
 219
 220     if (ShellCommandLineGetCount(Package) > 2) {
 221       ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_MANY), gShellLevel2HiiHandle);
 222       ShellStatus = SHELL_INVALID_PARAMETER;
 223     } else {
 224       PathName = ShellCommandLineGetRawValue(Package, 1);
 225       if (PathName == NULL) {
 226         CurDir = gEfiShellProtocol->GetCurDir(NULL);
 227         if (CurDir == NULL) {
 228           ShellStatus = SHELL_NOT_FOUND;
 229           ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_NO_CWD), gShellLevel2HiiHandle);
 230         } else {
 231           PathName = CurDir;
 232         }
 233       }
 234       if (PathName != NULL) {
 235         TempSpot = StrStr(PathName, L":");
 236         if (TempSpot != NULL) {
 237           *TempSpot = CHAR_NULL;
 238         }
 239         TempSpot = StrStr(PathName, L"\\");
 240         if (TempSpot != NULL) {
 241           *TempSpot = CHAR_NULL;
 242         }
 243         StrnCatGrow(&FullPath, &Length, PathName, 0);
 244         StrnCatGrow(&FullPath, &Length, L":\\", 0);
 245         DeleteMode = ShellCommandLineGetFlag(Package, L"-d");
 246         if (DeleteMode && ShellCommandLineGetFlag(Package, L"-n")) {
 247           ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_CON), gShellLevel2HiiHandle);
 248           ShellStatus = SHELL_INVALID_PARAMETER;
 249         } else if (ShellCommandLineGetFlag(Package, L"-n") && ShellCommandLineGetValue(Package, L"-n") == NULL) {
 250           ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_NO_VALUE), gShellLevel2HiiHandle, L"-n");
 251           ShellStatus = SHELL_INVALID_PARAMETER;
 252         } else if (ShellCommandLineGetValue(Package, L"-n") != NULL && StrLen(ShellCommandLineGetValue(Package, L"-n")) > 11) {
 253           ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM_VAL), gShellLevel2HiiHandle, L"-n");
 254           ShellStatus = SHELL_INVALID_PARAMETER;
 255         } else if (ShellStatus == SHELL_SUCCESS) {
 256           ShellStatus = HandleVol(
 257             FullPath,
 258             DeleteMode,
 259             ShellCommandLineGetValue(Package, L"-n")
 260            );
 261         }
 262       }
 263     }
 264   }
 265
 266   SHELL_FREE_NON_NULL(FullPath);
 267
 268   //
 269   // free the command line package
 270   //
 271   ShellCommandLineFreeVarList (Package);
 272
 273   return (ShellStatus);
 274 }