[mirror_edk2.git] / MdeModulePkg / Universal / Disk / UdfDxe / File.c

/** @file\r
  Handle operations in files and directories from UDF/ECMA-167 file systems.\r
\r
  Copyright (C) 2014-2017 Paulo Alcantara <pcacjr@zytor.com>\r
\r
  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, WITHOUT\r
  WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
**/\r
\r
#include "Udf.h"\r
\r
EFI_FILE_PROTOCOL gUdfFileIoOps = {\r
  EFI_FILE_PROTOCOL_REVISION,\r
  UdfOpen,\r
  UdfClose,\r
  UdfDelete,\r
  UdfRead,\r
  UdfWrite,\r
  UdfGetPosition,\r
  UdfSetPosition,\r
  UdfGetInfo,\r
  UdfSetInfo,\r
  UdfFlush,\r
  NULL,\r
  NULL,\r
  NULL,\r
  NULL\r
};\r
\r
#define _ROOT_FILE(_PrivData) (_PrivData)->Root\r
#define _PARENT_FILE(_PrivData) \\r
  ((_PrivData)->IsRootDirectory ? (_PrivData)->Root : &(_PrivData)->File)\r
#define _FILE(_PrivData) _PARENT_FILE(_PrivData)\r
\r
/**\r
  Open the root directory on a volume.\r
\r
  @param  This Protocol instance pointer.\r
  @param  Root Returns an Open file handle for the root directory\r
\r
  @retval EFI_SUCCESS          The device was opened.\r
  @retval EFI_UNSUPPORTED      This volume does not support the file system.\r
  @retval EFI_NO_MEDIA         The device has no media.\r
  @retval EFI_DEVICE_ERROR     The device reported an error.\r
  @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
  @retval EFI_ACCESS_DENIED    The service denied access to the file.\r
  @retval EFI_OUT_OF_RESOURCES The volume was not opened due to lack of\r
                               resources.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UdfOpenVolume (\r
  IN   EFI_SIMPLE_FILE_SYSTEM_PROTOCOL  *This,\r
  OUT  EFI_FILE_PROTOCOL                **Root\r
  )\r
{\r
  EFI_TPL                     OldTpl;\r
  EFI_STATUS                  Status;\r
  PRIVATE_UDF_SIMPLE_FS_DATA  *PrivFsData;\r
  PRIVATE_UDF_FILE_DATA       *PrivFileData;\r
\r
  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
\r
  if (This == NULL || Root == NULL) {\r
    Status = EFI_INVALID_PARAMETER;\r
    goto Error_Invalid_Params;\r
  }\r
\r
  PrivFsData = PRIVATE_UDF_SIMPLE_FS_DATA_FROM_THIS (This);\r
\r
  if (PrivFsData->OpenFiles == 0) {\r
    //\r
    // There is no more open files. Read volume information again since it was\r
    // cleaned up on the last UdfClose() call.\r
    //\r
    Status = ReadUdfVolumeInformation (\r
      PrivFsData->BlockIo,\r
      PrivFsData->DiskIo,\r
      &PrivFsData->Volume\r
      );\r
    if (EFI_ERROR (Status)) {\r
      goto Error_Read_Udf_Volume;\r
    }\r
  }\r
\r
  CleanupFileInformation (&PrivFsData->Root);\r
\r
  //\r
  // Find root directory file.\r
  //\r
  Status = FindRootDirectory (\r
    PrivFsData->BlockIo,\r
    PrivFsData->DiskIo,\r
    &PrivFsData->Volume,\r
    &PrivFsData->Root\r
    );\r
  if (EFI_ERROR (Status)) {\r
    goto Error_Find_Root_Dir;\r
  }\r
\r
  PrivFileData =\r
    (PRIVATE_UDF_FILE_DATA *) AllocateZeroPool (sizeof (PRIVATE_UDF_FILE_DATA));\r
  if (PrivFileData == NULL) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto Error_Alloc_Priv_File_Data;\r
  }\r
\r
  PrivFileData->Signature        = PRIVATE_UDF_FILE_DATA_SIGNATURE;\r
  PrivFileData->SimpleFs         = This;\r
  PrivFileData->Root             = &PrivFsData->Root;\r
  PrivFileData->IsRootDirectory  = TRUE;\r
\r
  CopyMem ((VOID *)&PrivFileData->FileIo, (VOID *)&gUdfFileIoOps,\r
           sizeof (EFI_FILE_PROTOCOL));\r
\r
  *Root = &PrivFileData->FileIo;\r
\r
  PrivFsData->OpenFiles++;\r
\r
  gBS->RestoreTPL (OldTpl);\r
\r
  return EFI_SUCCESS;\r
\r
Error_Alloc_Priv_File_Data:\r
  CleanupFileInformation (&PrivFsData->Root);\r
\r
Error_Find_Root_Dir:\r
  CleanupVolumeInformation (&PrivFsData->Volume);\r
\r
Error_Read_Udf_Volume:\r
Error_Invalid_Params:\r
  gBS->RestoreTPL (OldTpl);\r
\r
  return Status;\r
}\r
\r
/**\r
  Opens a new file relative to the source file's location.\r
\r
  @param  This       The protocol instance pointer.\r
  @param  NewHandle  Returns File Handle for FileName.\r
  @param  FileName   Null terminated string. "\", ".", and ".." are supported.\r
  @param  OpenMode   Open mode for file.\r
  @param  Attributes Only used for EFI_FILE_MODE_CREATE.\r
\r
  @retval EFI_SUCCESS          The device was opened.\r
  @retval EFI_NOT_FOUND        The specified file could not be found on the\r
                               device.\r
  @retval EFI_NO_MEDIA         The device has no media.\r
  @retval EFI_MEDIA_CHANGED    The media has changed.\r
  @retval EFI_DEVICE_ERROR     The device reported an error.\r
  @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
  @retval EFI_ACCESS_DENIED    The service denied access to the file.\r
  @retval EFI_OUT_OF_RESOURCES The volume was not opened due to lack of\r
                               resources.\r
  @retval EFI_VOLUME_FULL      The volume is full.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UdfOpen (\r
  IN   EFI_FILE_PROTOCOL  *This,\r
  OUT  EFI_FILE_PROTOCOL  **NewHandle,\r
  IN   CHAR16             *FileName,\r
  IN   UINT64             OpenMode,\r
  IN   UINT64             Attributes\r
  )\r
{\r
  EFI_TPL                     OldTpl;\r
  EFI_STATUS                  Status;\r
  PRIVATE_UDF_FILE_DATA       *PrivFileData;\r
  PRIVATE_UDF_SIMPLE_FS_DATA  *PrivFsData;\r
  CHAR16                      FilePath[UDF_PATH_LENGTH];\r
  UDF_FILE_INFO               File;\r
  PRIVATE_UDF_FILE_DATA       *NewPrivFileData;\r
  CHAR16                      *TempFileName;\r
\r
  ZeroMem (FilePath, sizeof FilePath);\r
  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
\r
  if (This == NULL || NewHandle == NULL || FileName == NULL) {\r
    Status = EFI_INVALID_PARAMETER;\r
    goto Error_Invalid_Params;\r
  }\r
\r
  if (OpenMode != EFI_FILE_MODE_READ) {\r
    Status = EFI_WRITE_PROTECTED;\r
    goto Error_Invalid_Params;\r
  }\r
\r
  PrivFileData = PRIVATE_UDF_FILE_DATA_FROM_THIS (This);\r
\r
  PrivFsData = PRIVATE_UDF_SIMPLE_FS_DATA_FROM_THIS (PrivFileData->SimpleFs);\r
\r
  //\r
  // Build full path\r
  //\r
  if (*FileName == L'\\') {\r
    StrCpyS (FilePath, UDF_PATH_LENGTH, FileName);\r
  } else {\r
    StrCpyS (FilePath, UDF_PATH_LENGTH, PrivFileData->AbsoluteFileName);\r
    StrCatS (FilePath, UDF_PATH_LENGTH, L"\\");\r
    StrCatS (FilePath, UDF_PATH_LENGTH, FileName);\r
  }\r
\r
  MangleFileName (FilePath);\r
  if (FilePath[0] == L'\0') {\r
    Status = EFI_NOT_FOUND;\r
    goto Error_Bad_FileName;\r
  }\r
\r
  Status = FindFile (\r
    PrivFsData->BlockIo,\r
    PrivFsData->DiskIo,\r
    &PrivFsData->Volume,\r
    FilePath,\r
    _ROOT_FILE (PrivFileData),\r
    _PARENT_FILE (PrivFileData),\r
    &_PARENT_FILE(PrivFileData)->FileIdentifierDesc->Icb,\r
    &File\r
    );\r
  if (EFI_ERROR (Status)) {\r
    goto Error_Find_File;\r
  }\r
\r
  NewPrivFileData =\r
    (PRIVATE_UDF_FILE_DATA *)AllocateZeroPool (sizeof (PRIVATE_UDF_FILE_DATA));\r
  if (NewPrivFileData == NULL) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto Error_Alloc_New_Priv_File_Data;\r
  }\r
\r
  CopyMem ((VOID *)NewPrivFileData, (VOID *)PrivFileData,\r
           sizeof (PRIVATE_UDF_FILE_DATA));\r
  CopyMem ((VOID *)&NewPrivFileData->File, &File, sizeof (UDF_FILE_INFO));\r
\r
  NewPrivFileData->IsRootDirectory = FALSE;\r
\r
  StrCpyS (NewPrivFileData->AbsoluteFileName, UDF_PATH_LENGTH, FilePath);\r
  FileName = NewPrivFileData->AbsoluteFileName;\r
\r
  while ((TempFileName = StrStr (FileName, L"\\")) != NULL) {\r
    FileName = TempFileName + 1;\r
  }\r
\r
  StrCpyS (NewPrivFileData->FileName, UDF_PATH_LENGTH, FileName);\r
\r
  Status = GetFileSize (\r
    PrivFsData->BlockIo,\r
    PrivFsData->DiskIo,\r
    &PrivFsData->Volume,\r
    &NewPrivFileData->File,\r
    &NewPrivFileData->FileSize\r
    );\r
  ASSERT_EFI_ERROR (Status);\r
  if (EFI_ERROR (Status)) {\r
    goto Error_Get_File_Size;\r
  }\r
\r
  NewPrivFileData->FilePosition = 0;\r
  ZeroMem ((VOID *)&NewPrivFileData->ReadDirInfo,\r
           sizeof (UDF_READ_DIRECTORY_INFO));\r
\r
  *NewHandle = &NewPrivFileData->FileIo;\r
\r
  PrivFsData->OpenFiles++;\r
\r
  gBS->RestoreTPL (OldTpl);\r
\r
  return Status;\r
\r
Error_Get_File_Size:\r
  FreePool ((VOID *)NewPrivFileData);\r
\r
Error_Alloc_New_Priv_File_Data:\r
  CleanupFileInformation (&File);\r
\r
Error_Find_File:\r
Error_Bad_FileName:\r
Error_Invalid_Params:\r
  gBS->RestoreTPL (OldTpl);\r
\r
  return Status;\r
}\r
\r
/**\r
  Read data from the file.\r
\r
  @param  This       Protocol instance pointer.\r
  @param  BufferSize On input size of buffer, on output amount of data in\r
                     buffer.\r
  @param  Buffer     The buffer in which data is read.\r
\r
  @retval EFI_SUCCESS          Data was read.\r
  @retval EFI_NO_MEDIA         The device has no media.\r
  @retval EFI_DEVICE_ERROR     The device reported an error.\r
  @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
  @retval EFI_BUFFER_TO_SMALL  BufferSize is too small. BufferSize contains\r
                               required size.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UdfRead (\r
  IN      EFI_FILE_PROTOCOL  *This,\r
  IN OUT  UINTN              *BufferSize,\r
  OUT     VOID               *Buffer\r
  )\r
{\r
  EFI_TPL                         OldTpl;\r
  EFI_STATUS                      Status;\r
  PRIVATE_UDF_FILE_DATA           *PrivFileData;\r
  PRIVATE_UDF_SIMPLE_FS_DATA      *PrivFsData;\r
  UDF_VOLUME_INFO                 *Volume;\r
  UDF_FILE_INFO                   *Parent;\r
  UDF_READ_DIRECTORY_INFO         *ReadDirInfo;\r
  EFI_BLOCK_IO_PROTOCOL           *BlockIo;\r
  EFI_DISK_IO_PROTOCOL            *DiskIo;\r
  UDF_FILE_INFO                   FoundFile;\r
  UDF_FILE_IDENTIFIER_DESCRIPTOR  *NewFileIdentifierDesc;\r
  VOID                            *NewFileEntryData;\r
  CHAR16                          FileName[UDF_FILENAME_LENGTH];\r
  UINT64                          FileSize;\r
  UINT64                          BufferSizeUint64;\r
\r
  ZeroMem (FileName, sizeof FileName);\r
  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
\r
  if (This == NULL || BufferSize == NULL || (*BufferSize != 0 &&\r
                                             Buffer == NULL)) {\r
    Status = EFI_INVALID_PARAMETER;\r
    goto Error_Invalid_Params;\r
  }\r
\r
  PrivFileData = PRIVATE_UDF_FILE_DATA_FROM_THIS (This);\r
  PrivFsData = PRIVATE_UDF_SIMPLE_FS_DATA_FROM_THIS (PrivFileData->SimpleFs);\r
\r
  BlockIo                = PrivFsData->BlockIo;\r
  DiskIo                 = PrivFsData->DiskIo;\r
  Volume                 = &PrivFsData->Volume;\r
  ReadDirInfo            = &PrivFileData->ReadDirInfo;\r
  NewFileIdentifierDesc  = NULL;\r
  NewFileEntryData       = NULL;\r
\r
  Parent = _PARENT_FILE (PrivFileData);\r
\r
  Status = EFI_VOLUME_CORRUPTED;\r
\r
  if (IS_FID_NORMAL_FILE (Parent->FileIdentifierDesc)) {\r
    if (PrivFileData->FilePosition > PrivFileData->FileSize) {\r
      //\r
      // File's position is beyond the EOF\r
      //\r
      Status = EFI_DEVICE_ERROR;\r
      goto Error_File_Beyond_The_Eof;\r
    }\r
\r
    if (PrivFileData->FilePosition == PrivFileData->FileSize) {\r
      *BufferSize = 0;\r
      Status = EFI_SUCCESS;\r
      goto Done;\r
    }\r
\r
    BufferSizeUint64 = *BufferSize;\r
\r
    Status = ReadFileData (\r
      BlockIo,\r
      DiskIo,\r
      Volume,\r
      Parent,\r
      PrivFileData->FileSize,\r
      &PrivFileData->FilePosition,\r
      Buffer,\r
      &BufferSizeUint64\r
      );\r
    ASSERT (BufferSizeUint64 <= MAX_UINTN);\r
    *BufferSize = (UINTN)BufferSizeUint64;\r
  } else if (IS_FID_DIRECTORY_FILE (Parent->FileIdentifierDesc)) {\r
    if (ReadDirInfo->FidOffset == 0 && PrivFileData->FilePosition > 0) {\r
      Status = EFI_DEVICE_ERROR;\r
      *BufferSize = 0;\r
      goto Done;\r
    }\r
\r
    for (;;) {\r
      Status = ReadDirectoryEntry (\r
        BlockIo,\r
        DiskIo,\r
        Volume,\r
        &Parent->FileIdentifierDesc->Icb,\r
        Parent->FileEntry,\r
        ReadDirInfo,\r
        &NewFileIdentifierDesc\r
        );\r
      if (EFI_ERROR (Status)) {\r
        if (Status == EFI_DEVICE_ERROR) {\r
          FreePool (ReadDirInfo->DirectoryData);\r
          ZeroMem ((VOID *)ReadDirInfo, sizeof (UDF_READ_DIRECTORY_INFO));\r
\r
          *BufferSize = 0;\r
          Status = EFI_SUCCESS;\r
        }\r
\r
        goto Done;\r
      }\r
\r
      if (!IS_FID_PARENT_FILE (NewFileIdentifierDesc)) {\r
        break;\r
      }\r
\r
      FreePool ((VOID *)NewFileIdentifierDesc);\r
    }\r
\r
    Status = FindFileEntry (\r
      BlockIo,\r
      DiskIo,\r
      Volume,\r
      &NewFileIdentifierDesc->Icb,\r
      &NewFileEntryData\r
      );\r
    if (EFI_ERROR (Status)) {\r
      goto Error_Find_Fe;\r
    }\r
    ASSERT (NewFileEntryData != NULL);\r
\r
    if (IS_FE_SYMLINK (NewFileEntryData)) {\r
      Status = ResolveSymlink (\r
        BlockIo,\r
        DiskIo,\r
        Volume,\r
        Parent,\r
        NewFileEntryData,\r
        &FoundFile\r
        );\r
      if (EFI_ERROR (Status)) {\r
        goto Error_Resolve_Symlink;\r
      }\r
\r
      FreePool ((VOID *)NewFileEntryData);\r
      NewFileEntryData = FoundFile.FileEntry;\r
\r
      Status = GetFileNameFromFid (NewFileIdentifierDesc, FileName);\r
      if (EFI_ERROR (Status)) {\r
        FreePool ((VOID *)FoundFile.FileIdentifierDesc);\r
        goto Error_Get_FileName;\r
      }\r
\r
      FreePool ((VOID *)NewFileIdentifierDesc);\r
      NewFileIdentifierDesc = FoundFile.FileIdentifierDesc;\r
    } else {\r
      FoundFile.FileIdentifierDesc  = NewFileIdentifierDesc;\r
      FoundFile.FileEntry           = NewFileEntryData;\r
\r
      Status = GetFileNameFromFid (FoundFile.FileIdentifierDesc, FileName);\r
      if (EFI_ERROR (Status)) {\r
        goto Error_Get_FileName;\r
      }\r
    }\r
\r
    Status = GetFileSize (\r
      BlockIo,\r
      DiskIo,\r
      Volume,\r
      &FoundFile,\r
      &FileSize\r
      );\r
    if (EFI_ERROR (Status)) {\r
      goto Error_Get_File_Size;\r
    }\r
\r
    Status = SetFileInfo (\r
      &FoundFile,\r
      FileSize,\r
      FileName,\r
      BufferSize,\r
      Buffer\r
      );\r
    if (EFI_ERROR (Status)) {\r
      goto Error_Set_File_Info;\r
    }\r
\r
    PrivFileData->FilePosition++;\r
    Status = EFI_SUCCESS;\r
  } else if (IS_FID_DELETED_FILE (Parent->FileIdentifierDesc)) {\r
    Status = EFI_DEVICE_ERROR;\r
  }\r
\r
Error_Set_File_Info:\r
Error_Get_File_Size:\r
Error_Get_FileName:\r
Error_Resolve_Symlink:\r
  if (NewFileEntryData != NULL) {\r
    FreePool (NewFileEntryData);\r
  }\r
\r
Error_Find_Fe:\r
  if (NewFileIdentifierDesc != NULL) {\r
    FreePool ((VOID *)NewFileIdentifierDesc);\r
  }\r
\r
Done:\r
Error_File_Beyond_The_Eof:\r
Error_Invalid_Params:\r
  gBS->RestoreTPL (OldTpl);\r
\r
  return Status;\r
}\r
\r
/**\r
  Close the file handle.\r
\r
  @param  This Protocol instance pointer.\r
\r
  @retval EFI_SUCCESS The file was closed.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UdfClose (\r
  IN EFI_FILE_PROTOCOL *This\r
  )\r
{\r
  EFI_TPL                     OldTpl;\r
  EFI_STATUS                  Status;\r
  PRIVATE_UDF_FILE_DATA       *PrivFileData;\r
  PRIVATE_UDF_SIMPLE_FS_DATA  *PrivFsData;\r
\r
  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
\r
  Status = EFI_SUCCESS;\r
\r
  if (This == NULL) {\r
    Status = EFI_INVALID_PARAMETER;\r
    goto Exit;\r
  }\r
\r
  PrivFileData = PRIVATE_UDF_FILE_DATA_FROM_THIS (This);\r
\r
  PrivFsData = PRIVATE_UDF_SIMPLE_FS_DATA_FROM_THIS (PrivFileData->SimpleFs);\r
\r
  if (!PrivFileData->IsRootDirectory) {\r
    CleanupFileInformation (&PrivFileData->File);\r
\r
    if (PrivFileData->ReadDirInfo.DirectoryData != NULL) {\r
      FreePool (PrivFileData->ReadDirInfo.DirectoryData);\r
    }\r
  }\r
\r
  if (--PrivFsData->OpenFiles == 0) {\r
    CleanupVolumeInformation (&PrivFsData->Volume);\r
  }\r
\r
  FreePool ((VOID *)PrivFileData);\r
\r
Exit:\r
  gBS->RestoreTPL (OldTpl);\r
\r
  return Status;\r
}\r
\r
/**\r
  Close and delete the file handle.\r
\r
  @param  This                     Protocol instance pointer.\r
\r
  @retval EFI_SUCCESS              The file was closed and deleted.\r
  @retval EFI_WARN_DELETE_FAILURE  The handle was closed but the file was not\r
                                   deleted.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UdfDelete (\r
  IN EFI_FILE_PROTOCOL  *This\r
  )\r
{\r
  PRIVATE_UDF_FILE_DATA *PrivFileData;\r
\r
  if (This == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  PrivFileData = PRIVATE_UDF_FILE_DATA_FROM_THIS (This);\r
\r
  (VOID)PrivFileData->FileIo.Close(This);\r
\r
  return EFI_WARN_DELETE_FAILURE;\r
}\r
\r
/**\r
  Write data to a file.\r
\r
  @param  This       Protocol instance pointer.\r
  @param  BufferSize On input size of buffer, on output amount of data in\r
                     buffer.\r
  @param  Buffer     The buffer in which data to write.\r
\r
  @retval EFI_SUCCESS          Data was written.\r
  @retval EFI_UNSUPPORTED      Writes to Open directory are not supported.\r
  @retval EFI_NO_MEDIA         The device has no media.\r
  @retval EFI_DEVICE_ERROR     The device reported an error.\r
  @retval EFI_DEVICE_ERROR     An attempt was made to write to a deleted file.\r
  @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
  @retval EFI_WRITE_PROTECTED  The device is write protected.\r
  @retval EFI_ACCESS_DENIED    The file was open for read only.\r
  @retval EFI_VOLUME_FULL      The volume is full.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UdfWrite (\r
  IN      EFI_FILE_PROTOCOL  *This,\r
  IN OUT  UINTN              *BufferSize,\r
  IN      VOID               *Buffer\r
  )\r
{\r
  return EFI_UNSUPPORTED;\r
}\r
\r
/**\r
  Get file's current position.\r
\r
  @param  This      Protocol instance pointer.\r
  @param  Position  Byte position from the start of the file.\r
\r
  @retval EFI_SUCCESS      Position was updated.\r
  @retval EFI_UNSUPPORTED  Seek request for directories is not valid.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UdfGetPosition (\r
  IN   EFI_FILE_PROTOCOL  *This,\r
  OUT  UINT64             *Position\r
  )\r
{\r
  PRIVATE_UDF_FILE_DATA *PrivFileData;\r
\r
  if (This == NULL || Position == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  PrivFileData = PRIVATE_UDF_FILE_DATA_FROM_THIS (This);\r
\r
  //\r
  // As per UEFI spec, if the file handle is a directory, then the current file\r
  // position has no meaning and the operation is not supported.\r
  //\r
  if (IS_FID_DIRECTORY_FILE (&PrivFileData->File.FileIdentifierDesc)) {\r
    return  EFI_UNSUPPORTED;\r
  }\r
\r
  //\r
  // The file is not a directory. So, return its position.\r
  //\r
  *Position = PrivFileData->FilePosition;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Set file's current position.\r
\r
  @param  This      Protocol instance pointer.\r
  @param  Position  Byte position from the start of the file.\r
\r
  @retval EFI_SUCCESS      Position was updated.\r
  @retval EFI_UNSUPPORTED  Seek request for non-zero is not valid on open.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UdfSetPosition (\r
  IN EFI_FILE_PROTOCOL  *This,\r
  IN UINT64             Position\r
  )\r
{\r
  EFI_STATUS                      Status;\r
  PRIVATE_UDF_FILE_DATA           *PrivFileData;\r
  UDF_FILE_IDENTIFIER_DESCRIPTOR  *FileIdentifierDesc;\r
\r
  if (This == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Status = EFI_UNSUPPORTED;\r
\r
  PrivFileData = PRIVATE_UDF_FILE_DATA_FROM_THIS (This);\r
\r
  FileIdentifierDesc = _FILE (PrivFileData)->FileIdentifierDesc;\r
  ASSERT (FileIdentifierDesc != NULL);\r
  if (IS_FID_DIRECTORY_FILE (FileIdentifierDesc)) {\r
    //\r
    // If the file handle is a directory, the _only_ position that may be set is\r
    // zero. This has no effect of starting the read proccess of the directory\r
    // entries over.\r
    //\r
    if (Position == 0) {\r
      PrivFileData->FilePosition = Position;\r
      PrivFileData->ReadDirInfo.FidOffset = 0;\r
      Status = EFI_SUCCESS;\r
    }\r
  } else if (IS_FID_NORMAL_FILE (FileIdentifierDesc)) {\r
    //\r
    // Seeking to position 0xFFFFFFFFFFFFFFFF causes the current position to be\r
    // set to the EOF.\r
    //\r
    if (Position == 0xFFFFFFFFFFFFFFFF) {\r
      PrivFileData->FilePosition = PrivFileData->FileSize - 1;\r
    } else {\r
      PrivFileData->FilePosition = Position;\r
    }\r
\r
    Status = EFI_SUCCESS;\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Get information about a file.\r
\r
  @param  This            Protocol instance pointer.\r
  @param  InformationType Type of information to return in Buffer.\r
  @param  BufferSize      On input size of buffer, on output amount of data in\r
                          buffer.\r
  @param  Buffer          The buffer to return data.\r
\r
  @retval EFI_SUCCESS          Data was returned.\r
  @retval EFI_UNSUPPORTED      InformationType is not supported.\r
  @retval EFI_NO_MEDIA         The device has no media.\r
  @retval EFI_DEVICE_ERROR     The device reported an error.\r
  @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
  @retval EFI_WRITE_PROTECTED  The device is write protected.\r
  @retval EFI_ACCESS_DENIED    The file was open for read only.\r
  @retval EFI_BUFFER_TOO_SMALL Buffer was too small; required size returned in\r
                               BufferSize.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UdfGetInfo (\r
  IN      EFI_FILE_PROTOCOL  *This,\r
  IN      EFI_GUID           *InformationType,\r
  IN OUT  UINTN              *BufferSize,\r
  OUT     VOID               *Buffer\r
  )\r
{\r
  EFI_STATUS                  Status;\r
  PRIVATE_UDF_FILE_DATA       *PrivFileData;\r
  PRIVATE_UDF_SIMPLE_FS_DATA  *PrivFsData;\r
  EFI_FILE_SYSTEM_INFO        *FileSystemInfo;\r
  UINTN                       FileSystemInfoLength;\r
  CHAR16                      *String;\r
  UDF_FILE_SET_DESCRIPTOR     *FileSetDesc;\r
  UINTN                       Index;\r
  UINT8                       *OstaCompressed;\r
  UINT8                       CompressionId;\r
  UINT64                      VolumeSize;\r
  UINT64                      FreeSpaceSize;\r
  CHAR16                      VolumeLabel[64];\r
\r
  if (This == NULL || InformationType == NULL || BufferSize == NULL ||\r
      (*BufferSize != 0 && Buffer == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  PrivFileData = PRIVATE_UDF_FILE_DATA_FROM_THIS (This);\r
\r
  PrivFsData = PRIVATE_UDF_SIMPLE_FS_DATA_FROM_THIS (PrivFileData->SimpleFs);\r
\r
  Status = EFI_UNSUPPORTED;\r
\r
  if (CompareGuid (InformationType, &gEfiFileInfoGuid)) {\r
    Status = SetFileInfo (\r
      _FILE (PrivFileData),\r
      PrivFileData->FileSize,\r
      PrivFileData->FileName,\r
      BufferSize,\r
      Buffer\r
      );\r
  } else if (CompareGuid (InformationType, &gEfiFileSystemInfoGuid)) {\r
    String = VolumeLabel;\r
\r
    FileSetDesc = PrivFsData->Volume.FileSetDescs[0];\r
\r
    OstaCompressed = &FileSetDesc->LogicalVolumeIdentifier[0];\r
\r
    CompressionId = OstaCompressed[0];\r
    if (!IS_VALID_COMPRESSION_ID (CompressionId)) {\r
      return EFI_VOLUME_CORRUPTED;\r
    }\r
\r
    for (Index = 1; Index < 128; Index++) {\r
      if (CompressionId == 16) {\r
        *String = *(UINT8 *)(OstaCompressed + Index) << 8;\r
        Index++;\r
      } else {\r
        *String = 0;\r
      }\r
\r
      if (Index < 128) {\r
        *String |= *(UINT8 *)(OstaCompressed + Index);\r
      }\r
\r
      //\r
      // Unlike FID Identifiers, Logical Volume Identifier is stored in a\r
      // NULL-terminated OSTA compressed format, so we must check for the NULL\r
      // character.\r
      //\r
      if (*String == L'\0') {\r
        break;\r
      }\r
\r
      String++;\r
    }\r
\r
    *String = L'\0';\r
\r
    FileSystemInfoLength = StrSize (VolumeLabel) +\r
                           sizeof (EFI_FILE_SYSTEM_INFO);\r
    if (*BufferSize < FileSystemInfoLength) {\r
      *BufferSize = FileSystemInfoLength;\r
      return EFI_BUFFER_TOO_SMALL;\r
    }\r
\r
    FileSystemInfo = (EFI_FILE_SYSTEM_INFO *)Buffer;\r
    StrCpyS (FileSystemInfo->VolumeLabel, ARRAY_SIZE (VolumeLabel),\r
             VolumeLabel);\r
    Status = GetVolumeSize (\r
      PrivFsData->BlockIo,\r
      PrivFsData->DiskIo,\r
      &PrivFsData->Volume,\r
      &VolumeSize,\r
      &FreeSpaceSize\r
      );\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
\r
    FileSystemInfo->Size        = FileSystemInfoLength;\r
    FileSystemInfo->ReadOnly    = TRUE;\r
    FileSystemInfo->BlockSize   =\r
      LV_BLOCK_SIZE (&PrivFsData->Volume, UDF_DEFAULT_LV_NUM);\r
    FileSystemInfo->VolumeSize  = VolumeSize;\r
    FileSystemInfo->FreeSpace   = FreeSpaceSize;\r
\r
    *BufferSize = FileSystemInfoLength;\r
    Status = EFI_SUCCESS;\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Set information about a file.\r
\r
  @param  File            Protocol instance pointer.\r
  @param  InformationType Type of information in Buffer.\r
  @param  BufferSize      Size of buffer.\r
  @param  Buffer          The data to write.\r
\r
  @retval EFI_SUCCESS          Data was set.\r
  @retval EFI_UNSUPPORTED      InformationType is not supported.\r
  @retval EFI_NO_MEDIA         The device has no media.\r
  @retval EFI_DEVICE_ERROR     The device reported an error.\r
  @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
  @retval EFI_WRITE_PROTECTED  The device is write protected.\r
  @retval EFI_ACCESS_DENIED    The file was open for read only.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UdfSetInfo (\r
  IN EFI_FILE_PROTOCOL  *This,\r
  IN EFI_GUID           *InformationType,\r
  IN UINTN              BufferSize,\r
  IN VOID               *Buffer\r
  )\r
{\r
  return EFI_WRITE_PROTECTED;\r
}\r
\r
/**\r
  Flush data back for the file handle.\r
\r
  @param  This Protocol instance pointer.\r
\r
  @retval EFI_SUCCESS          Data was flushed.\r
  @retval EFI_UNSUPPORTED      Writes to Open directory are not supported.\r
  @retval EFI_NO_MEDIA         The device has no media.\r
  @retval EFI_DEVICE_ERROR     The device reported an error.\r
  @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
  @retval EFI_WRITE_PROTECTED  The device is write protected.\r
  @retval EFI_ACCESS_DENIED    The file was open for read only.\r
  @retval EFI_VOLUME_FULL      The volume is full.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UdfFlush (\r
  IN EFI_FILE_PROTOCOL *This\r
  )\r
{\r
  return EFI_WRITE_PROTECTED;\r
}\r