BaseTools: Library hashing fix and optimization for --hash feature

[mirror_edk2.git] / FatPkg / EnhancedFatDxe / Info.c

/** @file\r
  Routines dealing with setting/getting file/volume info\r
\r
Copyright (c) 2005 - 2015, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
\r
\r
**/\r
\r
#include "Fat.h"\r
\r
/**\r
\r
  Get the volume's info into Buffer.\r
\r
  @param  Volume                - FAT file system volume.\r
  @param  BufferSize            - Size of Buffer.\r
  @param  Buffer                - Buffer containing volume info.\r
\r
  @retval EFI_SUCCESS           - Get the volume info successfully.\r
  @retval EFI_BUFFER_TOO_SMALL  - The buffer is too small.\r
\r
**/\r
EFI_STATUS\r
FatGetVolumeInfo (\r
  IN FAT_VOLUME       *Volume,\r
  IN OUT UINTN        *BufferSize,\r
  OUT VOID            *Buffer\r
  );\r
\r
/**\r
\r
  Set the volume's info.\r
\r
  @param  Volume                - FAT file system volume.\r
  @param  BufferSize            - Size of Buffer.\r
  @param  Buffer                - Buffer containing the new volume info.\r
\r
  @retval EFI_SUCCESS           - Set the volume info successfully.\r
  @retval EFI_BAD_BUFFER_SIZE   - The buffer size is error.\r
  @retval EFI_WRITE_PROTECTED   - The volume is read only.\r
  @return other                 - An error occurred when operation the disk.\r
\r
**/\r
EFI_STATUS\r
FatSetVolumeInfo (\r
  IN FAT_VOLUME       *Volume,\r
  IN UINTN            BufferSize,\r
  IN VOID            *Buffer\r
  );\r
\r
/**\r
\r
  Set or Get the some types info of the file into Buffer.\r
\r
  @param  IsSet      - TRUE:The access is set, else is get\r
  @param  FHand      - The handle of file\r
  @param  Type       - The type of the info\r
  @param  BufferSize - Size of Buffer\r
  @param  Buffer     - Buffer containing volume info\r
\r
  @retval EFI_SUCCESS       - Get the info successfully\r
  @retval EFI_DEVICE_ERROR  - Can not find the OFile for the file\r
\r
**/\r
EFI_STATUS\r
FatSetOrGetInfo (\r
  IN BOOLEAN              IsSet,\r
  IN EFI_FILE_PROTOCOL    *FHand,\r
  IN EFI_GUID             *Type,\r
  IN OUT UINTN            *BufferSize,\r
  IN OUT VOID             *Buffer\r
  );\r
\r
/**\r
\r
  Get the open file's info into Buffer.\r
\r
  @param  OFile                 - The open file.\r
  @param  BufferSize            - Size of Buffer.\r
  @param  Buffer                - Buffer containing file info.\r
\r
  @retval EFI_SUCCESS           - Get the file info successfully.\r
  @retval EFI_BUFFER_TOO_SMALL  - The buffer is too small.\r
\r
**/\r
EFI_STATUS\r
FatGetFileInfo (\r
  IN FAT_OFILE        *OFile,\r
  IN OUT UINTN        *BufferSize,\r
  OUT VOID            *Buffer\r
  )\r
{\r
  return FatGetDirEntInfo (OFile->Volume, OFile->DirEnt, BufferSize, Buffer);\r
}\r
\r
/**\r
\r
  Get the volume's info into Buffer.\r
\r
  @param  Volume                - FAT file system volume.\r
  @param  BufferSize            - Size of Buffer.\r
  @param  Buffer                - Buffer containing volume info.\r
\r
  @retval EFI_SUCCESS           - Get the volume info successfully.\r
  @retval EFI_BUFFER_TOO_SMALL  - The buffer is too small.\r
\r
**/\r
EFI_STATUS\r
FatGetVolumeInfo (\r
  IN     FAT_VOLUME     *Volume,\r
  IN OUT UINTN          *BufferSize,\r
     OUT VOID           *Buffer\r
  )\r
{\r
  UINTN                 Size;\r
  UINTN                 NameSize;\r
  UINTN                 ResultSize;\r
  CHAR16                Name[FAT_NAME_LEN + 1];\r
  EFI_STATUS            Status;\r
  EFI_FILE_SYSTEM_INFO  *Info;\r
  UINT8                 ClusterAlignment;\r
\r
  Size              = SIZE_OF_EFI_FILE_SYSTEM_INFO;\r
  Status            = FatGetVolumeEntry (Volume, Name);\r
  NameSize          = StrSize (Name);\r
  ResultSize        = Size + NameSize;\r
  ClusterAlignment  = Volume->ClusterAlignment;\r
\r
  //\r
  // If we don't have valid info, compute it now\r
  //\r
  FatComputeFreeInfo (Volume);\r
\r
  Status = EFI_BUFFER_TOO_SMALL;\r
  if (*BufferSize >= ResultSize) {\r
    Status  = EFI_SUCCESS;\r
\r
    Info    = Buffer;\r
    ZeroMem (Info, SIZE_OF_EFI_FILE_SYSTEM_INFO);\r
\r
    Info->Size        = ResultSize;\r
    Info->ReadOnly    = Volume->ReadOnly;\r
    Info->BlockSize   = (UINT32) Volume->ClusterSize;\r
    Info->VolumeSize  = LShiftU64 (Volume->MaxCluster, ClusterAlignment);\r
    Info->FreeSpace   = LShiftU64 (\r
                          Volume->FatInfoSector.FreeInfo.ClusterCount,\r
                          ClusterAlignment\r
                          );\r
    CopyMem ((CHAR8 *) Buffer + Size, Name, NameSize);\r
  }\r
\r
  *BufferSize = ResultSize;\r
  return Status;\r
}\r
\r
/**\r
\r
  Get the volume's label info into Buffer.\r
\r
  @param  Volume                - FAT file system volume.\r
  @param  BufferSize            - Size of Buffer.\r
  @param  Buffer                - Buffer containing volume's label info.\r
\r
  @retval EFI_SUCCESS           - Get the volume's label info successfully.\r
  @retval EFI_BUFFER_TOO_SMALL  - The buffer is too small.\r
\r
**/\r
EFI_STATUS\r
FatGetVolumeLabelInfo (\r
  IN FAT_VOLUME       *Volume,\r
  IN OUT UINTN        *BufferSize,\r
  OUT VOID            *Buffer\r
  )\r
{\r
  UINTN                             Size;\r
  UINTN                             NameSize;\r
  UINTN                             ResultSize;\r
  CHAR16                            Name[FAT_NAME_LEN + 1];\r
  EFI_STATUS                        Status;\r
\r
  Size        = SIZE_OF_EFI_FILE_SYSTEM_VOLUME_LABEL;\r
  Status      = FatGetVolumeEntry (Volume, Name);\r
  NameSize    = StrSize (Name);\r
  ResultSize  = Size + NameSize;\r
\r
  Status      = EFI_BUFFER_TOO_SMALL;\r
  if (*BufferSize >= ResultSize) {\r
    Status  = EFI_SUCCESS;\r
    CopyMem ((CHAR8 *) Buffer + Size, Name, NameSize);\r
  }\r
\r
  *BufferSize = ResultSize;\r
  return Status;\r
}\r
\r
/**\r
\r
  Set the volume's info.\r
\r
  @param  Volume                - FAT file system volume.\r
  @param  BufferSize            - Size of Buffer.\r
  @param  Buffer                - Buffer containing the new volume info.\r
\r
  @retval EFI_SUCCESS           - Set the volume info successfully.\r
  @retval EFI_BAD_BUFFER_SIZE   - The buffer size is error.\r
  @retval EFI_WRITE_PROTECTED   - The volume is read only.\r
  @return other                 - An error occurred when operation the disk.\r
\r
**/\r
EFI_STATUS\r
FatSetVolumeInfo (\r
  IN FAT_VOLUME       *Volume,\r
  IN UINTN            BufferSize,\r
  IN VOID             *Buffer\r
  )\r
{\r
  EFI_FILE_SYSTEM_INFO  *Info;\r
\r
  Info = (EFI_FILE_SYSTEM_INFO *) Buffer;\r
\r
  if (BufferSize < SIZE_OF_EFI_FILE_SYSTEM_INFO + 2 || Info->Size > BufferSize) {\r
    return EFI_BAD_BUFFER_SIZE;\r
  }\r
\r
  return FatSetVolumeEntry (Volume, Info->VolumeLabel);\r
}\r
\r
/**\r
\r
  Set the volume's label info.\r
\r
  @param  Volume                - FAT file system volume.\r
  @param  BufferSize            - Size of Buffer.\r
  @param  Buffer                - Buffer containing the new volume label info.\r
\r
  @retval EFI_SUCCESS           - Set the volume label info successfully.\r
  @retval EFI_WRITE_PROTECTED   - The disk is write protected.\r
  @retval EFI_BAD_BUFFER_SIZE   - The buffer size is error.\r
  @return other                 - An error occurred when operation the disk.\r
\r
**/\r
EFI_STATUS\r
FatSetVolumeLabelInfo (\r
  IN FAT_VOLUME       *Volume,\r
  IN UINTN            BufferSize,\r
  IN VOID             *Buffer\r
  )\r
{\r
  EFI_FILE_SYSTEM_VOLUME_LABEL *Info;\r
\r
  Info = (EFI_FILE_SYSTEM_VOLUME_LABEL *) Buffer;\r
\r
  if (BufferSize < SIZE_OF_EFI_FILE_SYSTEM_VOLUME_LABEL + 2) {\r
    return EFI_BAD_BUFFER_SIZE;\r
  }\r
\r
  return FatSetVolumeEntry (Volume, Info->VolumeLabel);\r
}\r
\r
/**\r
\r
  Set the file info.\r
\r
  @param  Volume                - FAT file system volume.\r
  @param  IFile                 - The instance of the open file.\r
  @param  OFile                 - The open file.\r
  @param  BufferSize            - Size of Buffer.\r
  @param  Buffer                - Buffer containing the new file info.\r
\r
  @retval EFI_SUCCESS           - Set the file info successfully.\r
  @retval EFI_ACCESS_DENIED     - It is the root directory\r
                          or the directory attribute bit can not change\r
                          or try to change a directory size\r
                          or something else.\r
  @retval EFI_UNSUPPORTED       - The new file size is larger than 4GB.\r
  @retval EFI_WRITE_PROTECTED   - The disk is write protected.\r
  @retval EFI_BAD_BUFFER_SIZE   - The buffer size is error.\r
  @retval EFI_INVALID_PARAMETER - The time info or attributes info is error.\r
  @retval EFI_OUT_OF_RESOURCES  - Can not allocate new memory.\r
  @retval EFI_VOLUME_CORRUPTED  - The volume is corrupted.\r
  @return other                 - An error occurred when operation the disk.\r
\r
**/\r
EFI_STATUS\r
FatSetFileInfo (\r
  IN FAT_VOLUME       *Volume,\r
  IN FAT_IFILE        *IFile,\r
  IN FAT_OFILE        *OFile,\r
  IN UINTN            BufferSize,\r
  IN VOID             *Buffer\r
  )\r
{\r
  EFI_STATUS    Status;\r
  EFI_FILE_INFO *NewInfo;\r
  FAT_OFILE     *DotOFile;\r
  FAT_OFILE     *Parent;\r
  CHAR16        NewFileName[EFI_PATH_STRING_LENGTH];\r
  EFI_TIME      ZeroTime;\r
  FAT_DIRENT    *DirEnt;\r
  FAT_DIRENT    *TempDirEnt;\r
  UINT8         NewAttribute;\r
  BOOLEAN       ReadOnly;\r
\r
  ZeroMem (&ZeroTime, sizeof (EFI_TIME));\r
  Parent  = OFile->Parent;\r
  DirEnt  = OFile->DirEnt;\r
  //\r
  // If this is the root directory, we can't make any updates\r
  //\r
  if (Parent == NULL) {\r
    return EFI_ACCESS_DENIED;\r
  }\r
  //\r
  // Make sure there's a valid input buffer\r
  //\r
  NewInfo = Buffer;\r
  if (BufferSize < SIZE_OF_EFI_FILE_INFO + 2 || NewInfo->Size > BufferSize) {\r
    return EFI_BAD_BUFFER_SIZE;\r
  }\r
\r
  ReadOnly = (BOOLEAN)(IFile->ReadOnly || (DirEnt->Entry.Attributes & EFI_FILE_READ_ONLY));\r
  //\r
  // if a zero time is specified, then the original time is preserved\r
  //\r
  if (CompareMem (&ZeroTime, &NewInfo->CreateTime, sizeof (EFI_TIME)) != 0) {\r
    if (!FatIsValidTime (&NewInfo->CreateTime)) {\r
      return EFI_INVALID_PARAMETER;\r
    }\r
\r
    if (!ReadOnly) {\r
      FatEfiTimeToFatTime (&NewInfo->CreateTime, &DirEnt->Entry.FileCreateTime);\r
    }\r
  }\r
\r
  if (CompareMem (&ZeroTime, &NewInfo->ModificationTime, sizeof (EFI_TIME)) != 0) {\r
    if (!FatIsValidTime (&NewInfo->ModificationTime)) {\r
      return EFI_INVALID_PARAMETER;\r
    }\r
\r
    if (!ReadOnly) {\r
      FatEfiTimeToFatTime (&NewInfo->ModificationTime, &DirEnt->Entry.FileModificationTime);\r
    }\r
\r
    OFile->PreserveLastModification = TRUE;\r
  }\r
\r
  if (NewInfo->Attribute & (~EFI_FILE_VALID_ATTR)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  NewAttribute = (UINT8) NewInfo->Attribute;\r
  //\r
  // Can not change the directory attribute bit\r
  //\r
  if ((NewAttribute ^ DirEnt->Entry.Attributes) & EFI_FILE_DIRECTORY) {\r
    return EFI_ACCESS_DENIED;\r
  }\r
  //\r
  // Set the current attributes even if the IFile->ReadOnly is TRUE\r
  //\r
  DirEnt->Entry.Attributes = (UINT8) ((DirEnt->Entry.Attributes &~EFI_FILE_VALID_ATTR) | NewAttribute);\r
  //\r
  // Open the filename and see if it refers to an existing file\r
  //\r
  Status = FatLocateOFile (&Parent, NewInfo->FileName, DirEnt->Entry.Attributes, NewFileName);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  if (*NewFileName != 0) {\r
    //\r
    // File was not found.  We do not allow rename of the current directory if\r
    // there are open files below the current directory\r
    //\r
    if (!IsListEmpty (&OFile->ChildHead) || Parent == OFile) {\r
      return EFI_ACCESS_DENIED;\r
    }\r
\r
    if (ReadOnly) {\r
      return EFI_ACCESS_DENIED;\r
    }\r
\r
    Status = FatRemoveDirEnt (OFile->Parent, DirEnt);\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
    //\r
    // Create new dirent\r
    //\r
    Status = FatCreateDirEnt (Parent, NewFileName, DirEnt->Entry.Attributes, &TempDirEnt);\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
\r
    FatCloneDirEnt (TempDirEnt, DirEnt);\r
    FatFreeDirEnt (DirEnt);\r
    DirEnt        = TempDirEnt;\r
    DirEnt->OFile = OFile;\r
    OFile->DirEnt = DirEnt;\r
    OFile->Parent = Parent;\r
    RemoveEntryList (&OFile->ChildLink);\r
    InsertHeadList (&Parent->ChildHead, &OFile->ChildLink);\r
    //\r
    // If this is a directory, synchronize its dot directory entry\r
    //\r
    if (OFile->ODir != NULL) {\r
      //\r
      // Syncronize its dot entry\r
      //\r
      FatResetODirCursor (OFile);\r
      ASSERT (OFile->Parent != NULL);\r
      for (DotOFile = OFile; DotOFile != OFile->Parent->Parent; DotOFile = DotOFile->Parent) {\r
        Status = FatGetNextDirEnt (OFile, &DirEnt);\r
        if (EFI_ERROR (Status) || DirEnt == NULL || !FatIsDotDirEnt (DirEnt)) {\r
          return EFI_VOLUME_CORRUPTED;\r
        }\r
\r
        FatCloneDirEnt (DirEnt, DotOFile->DirEnt);\r
        Status = FatStoreDirEnt (OFile, DirEnt);\r
        if (EFI_ERROR (Status)) {\r
          return Status;\r
        }\r
      }\r
    }\r
    //\r
    // If the file is renamed, we should append the ARCHIVE attribute\r
    //\r
    OFile->Archive = TRUE;\r
  } else if (Parent != OFile) {\r
    //\r
    // filename is to a different filename that already exists\r
    //\r
    return EFI_ACCESS_DENIED;\r
  }\r
  //\r
  // If the file size has changed, apply it\r
  //\r
  if (NewInfo->FileSize != OFile->FileSize) {\r
    if (OFile->ODir != NULL || ReadOnly) {\r
      //\r
      // If this is a directory or the file is read only, we can't change the file size\r
      //\r
      return EFI_ACCESS_DENIED;\r
    }\r
\r
    if (NewInfo->FileSize > OFile->FileSize) {\r
      Status = FatExpandOFile (OFile, NewInfo->FileSize);\r
    } else {\r
      Status = FatTruncateOFile (OFile, (UINTN) NewInfo->FileSize);\r
    }\r
\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
\r
    FatUpdateDirEntClusterSizeInfo (OFile);\r
  }\r
\r
  OFile->Dirty = TRUE;\r
  return FatOFileFlush (OFile);\r
}\r
\r
/**\r
\r
  Set or Get the some types info of the file into Buffer.\r
\r
  @param  IsSet      - TRUE:The access is set, else is get\r
  @param  FHand      - The handle of file\r
  @param  Type       - The type of the info\r
  @param  BufferSize - Size of Buffer\r
  @param  Buffer     - Buffer containing volume info\r
\r
  @retval EFI_SUCCESS       - Get the info successfully\r
  @retval EFI_DEVICE_ERROR  - Can not find the OFile for the file\r
\r
**/\r
EFI_STATUS\r
FatSetOrGetInfo (\r
  IN     BOOLEAN            IsSet,\r
  IN     EFI_FILE_PROTOCOL  *FHand,\r
  IN     EFI_GUID           *Type,\r
  IN OUT UINTN              *BufferSize,\r
  IN OUT VOID               *Buffer\r
  )\r
{\r
  FAT_IFILE   *IFile;\r
  FAT_OFILE   *OFile;\r
  FAT_VOLUME  *Volume;\r
  EFI_STATUS  Status;\r
\r
  IFile   = IFILE_FROM_FHAND (FHand);\r
  OFile   = IFile->OFile;\r
  Volume  = OFile->Volume;\r
\r
  Status  = OFile->Error;\r
  if (Status == EFI_NOT_FOUND) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  FatWaitNonblockingTask (IFile);\r
\r
  FatAcquireLock ();\r
\r
  //\r
  // Verify the file handle isn't in an error state\r
  //\r
  if (!EFI_ERROR (Status)) {\r
    //\r
    // Get the proper information based on the request\r
    //\r
    Status = EFI_UNSUPPORTED;\r
    if (IsSet) {\r
      if (CompareGuid (Type, &gEfiFileInfoGuid)) {\r
        Status = Volume->ReadOnly ? EFI_WRITE_PROTECTED : FatSetFileInfo (Volume, IFile, OFile, *BufferSize, Buffer);\r
      }\r
\r
      if (CompareGuid (Type, &gEfiFileSystemInfoGuid)) {\r
        Status = Volume->ReadOnly ? EFI_WRITE_PROTECTED : FatSetVolumeInfo (Volume, *BufferSize, Buffer);\r
      }\r
\r
      if (CompareGuid (Type, &gEfiFileSystemVolumeLabelInfoIdGuid)) {\r
        Status = Volume->ReadOnly ? EFI_WRITE_PROTECTED : FatSetVolumeLabelInfo (Volume, *BufferSize, Buffer);\r
      }\r
    } else {\r
      if (CompareGuid (Type, &gEfiFileInfoGuid)) {\r
        Status = FatGetFileInfo (OFile, BufferSize, Buffer);\r
      }\r
\r
      if (CompareGuid (Type, &gEfiFileSystemInfoGuid)) {\r
        Status = FatGetVolumeInfo (Volume, BufferSize, Buffer);\r
      }\r
\r
      if (CompareGuid (Type, &gEfiFileSystemVolumeLabelInfoIdGuid)) {\r
        Status = FatGetVolumeLabelInfo (Volume, BufferSize, Buffer);\r
      }\r
    }\r
  }\r
\r
  Status = FatCleanupVolume (Volume, NULL, Status, NULL);\r
\r
  FatReleaseLock ();\r
  return Status;\r
}\r
\r
/**\r
\r
  Get the some types info of the file into Buffer.\r
\r
  @param  FHand                 - The handle of file.\r
  @param  Type                  - The type of the info.\r
  @param  BufferSize            - Size of Buffer.\r
  @param  Buffer                - Buffer containing volume info.\r
\r
  @retval EFI_SUCCESS           - Get the info successfully.\r
  @retval EFI_DEVICE_ERROR      - Can not find the OFile for the file.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FatGetInfo (\r
  IN     EFI_FILE_PROTOCOL   *FHand,\r
  IN     EFI_GUID            *Type,\r
  IN OUT UINTN               *BufferSize,\r
     OUT VOID                *Buffer\r
  )\r
{\r
  return FatSetOrGetInfo (FALSE, FHand, Type, BufferSize, Buffer);\r
}\r
\r
/**\r
\r
  Set the some types info of the file into Buffer.\r
\r
  @param  FHand                 - The handle of file.\r
  @param  Type                  - The type of the info.\r
  @param  BufferSize            - Size of Buffer\r
  @param  Buffer                - Buffer containing volume info.\r
\r
  @retval EFI_SUCCESS           - Set the info successfully.\r
  @retval EFI_DEVICE_ERROR      - Can not find the OFile for the file.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FatSetInfo (\r
  IN EFI_FILE_PROTOCOL  *FHand,\r
  IN EFI_GUID           *Type,\r
  IN UINTN              BufferSize,\r
  IN VOID               *Buffer\r
  )\r
{\r
  return FatSetOrGetInfo (TRUE, FHand, Type, &BufferSize, Buffer);\r
}\r