OvmfPkg: Apply uncrustify changes

[mirror_edk2.git] / OvmfPkg / VirtioFsDxe / FuseOpen.c

/** @file\r
  FUSE_OPEN wrapper for the Virtio Filesystem device.\r
\r
  Copyright (C) 2020, Red Hat, Inc.\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
**/\r
\r
#include "VirtioFsDxe.h"\r
\r
/**\r
  Send a FUSE_OPEN request to the Virtio Filesystem device, for opening a\r
  regular file.\r
\r
  The function may only be called after VirtioFsFuseInitSession() returns\r
  successfully and before VirtioFsUninit() is called.\r
\r
  @param[in,out] VirtioFs  The Virtio Filesystem device to send the FUSE_OPEN\r
                           request to. On output, the FUSE request counter\r
                           "VirtioFs->RequestId" will have been incremented.\r
\r
  @param[in] NodeId        The inode number of the regular file to open.\r
\r
  @param[in] ReadWrite     If TRUE, open the regular file in read-write mode.\r
                           If FALSE, open the regular file in read-only mode.\r
\r
  @param[out] FuseHandle   The open handle to the regular file, returned by the\r
                           Virtio Filesystem device.\r
\r
  @retval EFI_SUCCESS  The regular file has been opened.\r
\r
  @return              The "errno" value mapped to an EFI_STATUS code, if the\r
                       Virtio Filesystem device explicitly reported an error.\r
\r
  @return              Error codes propagated from VirtioFsSgListsValidate(),\r
                       VirtioFsFuseNewRequest(), VirtioFsSgListsSubmit(),\r
                       VirtioFsFuseCheckResponse().\r
**/\r
EFI_STATUS\r
VirtioFsFuseOpen (\r
  IN OUT VIRTIO_FS  *VirtioFs,\r
  IN     UINT64     NodeId,\r
  IN     BOOLEAN    ReadWrite,\r
  OUT UINT64        *FuseHandle\r
  )\r
{\r
  VIRTIO_FS_FUSE_REQUEST         CommonReq;\r
  VIRTIO_FS_FUSE_OPEN_REQUEST    OpenReq;\r
  VIRTIO_FS_IO_VECTOR            ReqIoVec[2];\r
  VIRTIO_FS_SCATTER_GATHER_LIST  ReqSgList;\r
  VIRTIO_FS_FUSE_RESPONSE        CommonResp;\r
  VIRTIO_FS_FUSE_OPEN_RESPONSE   OpenResp;\r
  VIRTIO_FS_IO_VECTOR            RespIoVec[2];\r
  VIRTIO_FS_SCATTER_GATHER_LIST  RespSgList;\r
  EFI_STATUS                     Status;\r
\r
  //\r
  // Set up the scatter-gather lists.\r
  //\r
  ReqIoVec[0].Buffer = &CommonReq;\r
  ReqIoVec[0].Size   = sizeof CommonReq;\r
  ReqIoVec[1].Buffer = &OpenReq;\r
  ReqIoVec[1].Size   = sizeof OpenReq;\r
  ReqSgList.IoVec    = ReqIoVec;\r
  ReqSgList.NumVec   = ARRAY_SIZE (ReqIoVec);\r
\r
  RespIoVec[0].Buffer = &CommonResp;\r
  RespIoVec[0].Size   = sizeof CommonResp;\r
  RespIoVec[1].Buffer = &OpenResp;\r
  RespIoVec[1].Size   = sizeof OpenResp;\r
  RespSgList.IoVec    = RespIoVec;\r
  RespSgList.NumVec   = ARRAY_SIZE (RespIoVec);\r
\r
  //\r
  // Validate the scatter-gather lists; calculate the total transfer sizes.\r
  //\r
  Status = VirtioFsSgListsValidate (VirtioFs, &ReqSgList, &RespSgList);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Populate the common request header.\r
  //\r
  Status = VirtioFsFuseNewRequest (\r
             VirtioFs,\r
             &CommonReq,\r
             ReqSgList.TotalSize,\r
             VirtioFsFuseOpOpen,\r
             NodeId\r
             );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Populate the FUSE_OPEN-specific fields.\r
  //\r
  OpenReq.Flags = (ReadWrite ?\r
                   VIRTIO_FS_FUSE_OPEN_REQ_F_RDWR :\r
                   VIRTIO_FS_FUSE_OPEN_REQ_F_RDONLY);\r
  OpenReq.Unused = 0;\r
\r
  //\r
  // Submit the request.\r
  //\r
  Status = VirtioFsSgListsSubmit (VirtioFs, &ReqSgList, &RespSgList);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Verify the response (all response buffers are fixed size).\r
  //\r
  Status = VirtioFsFuseCheckResponse (&RespSgList, CommonReq.Unique, NULL);\r
  if (EFI_ERROR (Status)) {\r
    if (Status == EFI_DEVICE_ERROR) {\r
      DEBUG ((\r
        DEBUG_ERROR,\r
        "%a: Label=\"%s\" NodeId=%Lu ReadWrite=%d "\r
        "Errno=%d\n",\r
        __FUNCTION__,\r
        VirtioFs->Label,\r
        NodeId,\r
        ReadWrite,\r
        CommonResp.Error\r
        ));\r
      Status = VirtioFsErrnoToEfiStatus (CommonResp.Error);\r
    }\r
\r
    return Status;\r
  }\r
\r
  //\r
  // Output the open handle.\r
  //\r
  *FuseHandle = OpenResp.FileHandle;\r
  return EFI_SUCCESS;\r
}\r