OvmfPkg: Apply uncrustify changes

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

/** @file\r
  FUSE_CREATE 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 <Library/BaseLib.h> // AsciiStrSize()\r
\r
#include "VirtioFsDxe.h"\r
\r
/**\r
  Send a FUSE_CREATE request to the Virtio Filesystem device, for opening a\r
  regular file with (O_RDWR | O_CREAT) semantics.\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_CREATE\r
                           request to. On output, the FUSE request counter\r
                           "VirtioFs->RequestId" will have been incremented.\r
\r
  @param[in] ParentNodeId  The inode number of the direct parent directory of\r
                           the regular file to open or create.\r
\r
  @param[in] Name          The single-component filename of the regular file to\r
                           open or create, under the parent directory\r
                           identified by ParentNodeId.\r
\r
  @param[out] NodeId       The inode number of the regular file, returned by\r
                           the Virtio Filesystem device.\r
\r
  @param[out] FuseHandle   The open file handle returned by the Virtio\r
                           Filesystem device.\r
\r
  @retval EFI_SUCCESS  The regular file has been opened, and (if necessary)\r
                       created.\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
VirtioFsFuseOpenOrCreate (\r
  IN OUT VIRTIO_FS  *VirtioFs,\r
  IN     UINT64     ParentNodeId,\r
  IN     CHAR8      *Name,\r
  OUT UINT64        *NodeId,\r
  OUT UINT64        *FuseHandle\r
  )\r
{\r
  VIRTIO_FS_FUSE_REQUEST              CommonReq;\r
  VIRTIO_FS_FUSE_CREATE_REQUEST       CreateReq;\r
  VIRTIO_FS_IO_VECTOR                 ReqIoVec[3];\r
  VIRTIO_FS_SCATTER_GATHER_LIST       ReqSgList;\r
  VIRTIO_FS_FUSE_RESPONSE             CommonResp;\r
  VIRTIO_FS_FUSE_NODE_RESPONSE        NodeResp;\r
  VIRTIO_FS_FUSE_ATTRIBUTES_RESPONSE  AttrResp;\r
  VIRTIO_FS_FUSE_OPEN_RESPONSE        OpenResp;\r
  VIRTIO_FS_IO_VECTOR                 RespIoVec[4];\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 = &CreateReq;\r
  ReqIoVec[1].Size   = sizeof CreateReq;\r
  ReqIoVec[2].Buffer = Name;\r
  ReqIoVec[2].Size   = AsciiStrSize (Name);\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 = &NodeResp;\r
  RespIoVec[1].Size   = sizeof NodeResp;\r
  RespIoVec[2].Buffer = &AttrResp;\r
  RespIoVec[2].Size   = sizeof AttrResp;\r
  RespIoVec[3].Buffer = &OpenResp;\r
  RespIoVec[3].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
             VirtioFsFuseOpCreate,\r
             ParentNodeId\r
             );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Populate the FUSE_CREATE-specific fields.\r
  //\r
  // VIRTIO_FS_FUSE_OPEN_REQ_F_RDWR is why this request can never open a\r
  // directory (EISDIR). And VIRTIO_FS_FUSE_OPEN_REQ_F_RDWR is consistent with\r
  // the only OpenMode of EFI_FILE_PROTOCOL.Open() that enables filesystem\r
  // object creation -- that is, Create/Read/Write.\r
  //\r
  CreateReq.Flags = VIRTIO_FS_FUSE_OPEN_REQ_F_RDWR;\r
  CreateReq.Mode  = (VIRTIO_FS_FUSE_MODE_PERM_RUSR |\r
                     VIRTIO_FS_FUSE_MODE_PERM_WUSR |\r
                     VIRTIO_FS_FUSE_MODE_PERM_RGRP |\r
                     VIRTIO_FS_FUSE_MODE_PERM_WGRP |\r
                     VIRTIO_FS_FUSE_MODE_PERM_ROTH |\r
                     VIRTIO_FS_FUSE_MODE_PERM_WOTH);\r
  CreateReq.Umask   = 0;\r
  CreateReq.Padding = 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\" ParentNodeId=%Lu Name=\"%a\" "\r
        "Errno=%d\n",\r
        __FUNCTION__,\r
        VirtioFs->Label,\r
        ParentNodeId,\r
        Name,\r
        CommonResp.Error\r
        ));\r
      Status = VirtioFsErrnoToEfiStatus (CommonResp.Error);\r
    }\r
\r
    return Status;\r
  }\r
\r
  //\r
  // Output the NodeId of the (possibly new) regular file. Also output the open\r
  // file handle.\r
  //\r
  *NodeId     = NodeResp.NodeId;\r
  *FuseHandle = OpenResp.FileHandle;\r
  return EFI_SUCCESS;\r
}\r