OvmfPkg/VirtioFsDxe: implement the wrapper function for FUSE_MKDIR

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

/** @file\r
  FUSE_MKDIR 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_MKDIR request to the Virtio Filesystem device, for creating a\r
  directory.\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_MKDIR\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 directory to create.\r
\r
  @param[in] Name          The single-component filename of the directory to\r
                           create, under the parent directory identified by\r
                           ParentNodeId.\r
\r
  @param[out] NodeId       The inode number of the new directory.\r
\r
  @retval EFI_SUCCESS  The directory has been 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
VirtioFsFuseMkDir (\r
  IN OUT VIRTIO_FS *VirtioFs,\r
  IN     UINT64    ParentNodeId,\r
  IN     CHAR8     *Name,\r
     OUT UINT64    *NodeId\r
  )\r
{\r
  VIRTIO_FS_FUSE_REQUEST             CommonReq;\r
  VIRTIO_FS_FUSE_MKDIR_REQUEST       MkDirReq;\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_IO_VECTOR                RespIoVec[3];\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 = &MkDirReq;\r
  ReqIoVec[1].Size   = sizeof MkDirReq;\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
  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 (VirtioFs, &CommonReq, ReqSgList.TotalSize,\r
             VirtioFsFuseOpMkDir, ParentNodeId);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Populate the FUSE_MKDIR-specific fields.\r
  //\r
  MkDirReq.Mode  = (VIRTIO_FS_FUSE_MODE_PERM_RWXU |\r
                    VIRTIO_FS_FUSE_MODE_PERM_RWXG |\r
                    VIRTIO_FS_FUSE_MODE_PERM_RWXO);\r
  MkDirReq.Umask = 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 ((DEBUG_ERROR, "%a: Label=\"%s\" ParentNodeId=%Lu Name=\"%a\" "\r
        "Errno=%d\n", __FUNCTION__, VirtioFs->Label, ParentNodeId, Name,\r
        CommonResp.Error));\r
      Status = VirtioFsErrnoToEfiStatus (CommonResp.Error);\r
    }\r
    return Status;\r
  }\r
\r
  //\r
  // Output the NodeId of the new directory.\r
  //\r
  *NodeId = NodeResp.NodeId;\r
  return EFI_SUCCESS;\r
}\r