1. Correct File header to ## @file 2. Remove unnecessary .common] postfix on section.

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

/*++\r
\r
Copyright (c) 2005 - 2009, Intel Corporation\r
All rights reserved. This program and the accompanying materials are licensed and made available\r
under the terms and conditions of the BSD License which accompanies this\r
distribution. The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
\r
Module Name:\r
\r
  Info.c\r
\r
Abstract:\r
\r
  Routines dealing with setting/getting file/volume info\r
\r
Revision History\r
\r
--*/\r
\r
#include "Fat.h"\r
\r
EFI_STATUS\r
FatGetVolumeInfo (\r
  IN FAT_VOLUME       *Volume,\r
  IN OUT UINTN        *BufferSize,\r
  OUT VOID            *Buffer\r
  );\r
\r
EFI_STATUS\r
FatSetVolumeInfo (\r
  IN FAT_VOLUME       *Volume,\r
  IN OUT UINTN        BufferSize,\r
  OUT VOID            *Buffer\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
EFI_STATUS\r
FatGetFileInfo (\r
  IN FAT_OFILE        *OFile,\r
  IN OUT UINTN        *BufferSize,\r
  OUT VOID            *Buffer\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Get the open file's info into Buffer.\r
\r
Arguments:\r
\r
  OFile                 - The open file.\r
  BufferSize            - Size of Buffer.\r
  Buffer                - Buffer containing file info.\r
\r
Returns:\r
\r
  EFI_SUCCESS           - Get the file info successfully.\r
  EFI_BUFFER_TOO_SMALL  - The buffer is too small.\r
\r
--*/\r
{\r
  return FatGetDirEntInfo (OFile->Volume, OFile->DirEnt, BufferSize, Buffer);\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
Routine Description:\r
\r
  Get the volume's info into Buffer.\r
\r
Arguments:\r
\r
  Volume                - FAT file system volume.\r
  BufferSize            - Size of Buffer.\r
  Buffer                - Buffer containing volume info.\r
\r
Returns:\r
\r
  EFI_SUCCESS           - Get the volume info successfully.\r
  EFI_BUFFER_TOO_SMALL  - The buffer is too small.\r
\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
EFI_STATUS\r
FatGetVolumeLabelInfo (\r
  IN FAT_VOLUME       *Volume,\r
  IN OUT UINTN        *BufferSize,\r
  OUT VOID            *Buffer\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Get the volume's label info into Buffer.\r
\r
Arguments:\r
\r
  Volume                - FAT file system volume.\r
  BufferSize            - Size of Buffer.\r
  Buffer                - Buffer containing volume's label info.\r
\r
Returns:\r
\r
  EFI_SUCCESS           - Get the volume's label info successfully.\r
  EFI_BUFFER_TOO_SMALL  - The buffer is too small.\r
\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
EFI_STATUS\r
FatSetVolumeInfo (\r
  IN FAT_VOLUME       *Volume,\r
  IN UINTN            BufferSize,\r
  IN VOID             *Buffer\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Set the volume's info.\r
\r
Arguments:\r
\r
  Volume                - FAT file system volume.\r
  BufferSize            - Size of Buffer.\r
  Buffer                - Buffer containing the new volume info.\r
\r
Returns:\r
\r
  EFI_SUCCESS           - Set the volume info successfully.\r
  EFI_BAD_BUFFER_SIZE   - The buffer size is error.\r
  EFI_WRITE_PROTECTED   - The volume is read only.\r
  other                 - An error occurred when operation the disk.\r
\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
EFI_STATUS\r
FatSetVolumeLabelInfo (\r
  IN FAT_VOLUME       *Volume,\r
  IN UINTN            BufferSize,\r
  IN VOID             *Buffer\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Set the volume's label info\r
\r
Arguments:\r
\r
  Volume                - FAT file system volume.\r
  BufferSize            - Size of Buffer.\r
  Buffer                - Buffer containing the new volume label info.\r
\r
Returns:\r
\r
  EFI_SUCCESS           - Set the volume label info successfully.\r
  EFI_WRITE_PROTECTED   - The disk is write protected.\r
  EFI_BAD_BUFFER_SIZE   - The buffer size is error.\r
  other                 - An error occurred when operation the disk.\r
\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
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
\r
Routine Description:\r
\r
  Set the file info.\r
\r
Arguments:\r
\r
  Volume                - FAT file system volume.\r
  IFile                 - The instance of the open file.\r
  OFile                 - The open file.\r
  BufferSize            - Size of Buffer.\r
  Buffer                - Buffer containing the new file info.\r
\r
Returns:\r
\r
  EFI_SUCCESS           - Set the file info successfully.\r
  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
  EFI_UNSUPPORTED       - The new file size is larger than 4GB.\r
  EFI_WRITE_PROTECTED   - The disk is write protected.\r
  EFI_BAD_BUFFER_SIZE   - The buffer size is error.\r
  EFI_INVALID_PARAMETER - The time info or attributes info is error.\r
  EFI_OUT_OF_RESOURCES  - Can not allocate new memory.\r
  EFI_VOLUME_CORRUPTED  - The volume is corrupted.\r
  other                 - An error occurred when operation the disk.\r
\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
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
Routine Description:\r
\r
  Set or Get the some types info of the file into Buffer\r
\r
Arguments:\r
\r
  IsSet      - TRUE:The access is set, else is get\r
  FHand      - The handle of file\r
  Type       - The type of the info\r
  BufferSize - Size of Buffer\r
  Buffer     - Buffer containing volume info\r
\r
Returns:\r
\r
  EFI_SUCCESS       - Get the info successfully\r
  EFI_DEVICE_ERROR  - Can not find the OFile for the file\r
\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
  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 (Volume->ReadOnly) {\r
        Status = EFI_WRITE_PROTECTED;\r
      } else {\r
        if (CompareGuid (Type, &gEfiFileInfoGuid)) {\r
          Status = FatSetFileInfo (Volume, IFile, OFile, *BufferSize, Buffer);\r
        }\r
\r
        if (CompareGuid (Type, &gEfiFileSystemInfoGuid)) {\r
          Status = FatSetVolumeInfo (Volume, *BufferSize, Buffer);\r
        }\r
\r
        if (CompareGuid (Type, &gEfiFileSystemVolumeLabelInfoIdGuid)) {\r
          Status = FatSetVolumeLabelInfo (Volume, *BufferSize, Buffer);\r
        }\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);\r
\r
  FatReleaseLock ();\r
  return Status;\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
\r
Routine Description:\r
\r
  Get the some types info of the file into Buffer.\r
\r
Arguments:\r
\r
  FHand                 - The handle of file.\r
  Type                  - The type of the info.\r
  BufferSize            - Size of Buffer.\r
  Buffer                - Buffer containing volume info.\r
\r
Returns:\r
\r
  EFI_SUCCESS           - Get the info successfully.\r
  EFI_DEVICE_ERROR      - Can not find the OFile for the file.\r
\r
--*/\r
{\r
  return FatSetOrGetInfo (FALSE, FHand, Type, BufferSize, Buffer);\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
\r
Routine Description:\r
\r
  Set the some types info of the file into Buffer.\r
\r
Arguments:\r
\r
  FHand                 - The handle of file.\r
  Type                  - The type of the info.\r
  BufferSize            - Size of Buffer\r
  Buffer                - Buffer containing volume info.\r
\r
Returns:\r
\r
  EFI_SUCCESS           - Set the info successfully.\r
  EFI_DEVICE_ERROR      - Can not find the OFile for the file.\r
\r
--*/\r
{\r
  return FatSetOrGetInfo (TRUE, FHand, Type, &BufferSize, Buffer);\r
}\r