OvmfPkg/VirtioFsDxe: implement the wrapper function for FUSE_RENAME2

Add the VirtioFsFuseRename() function, for sending the FUSE_RENAME2
command to the Virtio Filesystem device.

Cc: Ard Biesheuvel <ard.biesheuvel@arm.com>
Cc: Jordan Justen <jordan.l.justen@intel.com>
Cc: Philippe Mathieu-Daudé <philmd@redhat.com>
Ref: https://bugzilla.tianocore.org/show_bug.cgi?id=3097
Signed-off-by: Laszlo Ersek <lersek@redhat.com>
Message-Id: <20201216211125.19496-42-lersek@redhat.com>
Acked-by: Ard Biesheuvel <ard.biesheuvel@arm.com>

diff --git a/OvmfPkg/Include/IndustryStandard/VirtioFs.h b/OvmfPkg/Include/IndustryStandard/VirtioFs.h
index 0b7b3ff80edde6c4de14246cf30b7ad8e0f0fa4e..0b2ed701004672acd543ce28bdd786fc8055253a 100644 (file)
--- a/OvmfPkg/Include/IndustryStandard/VirtioFs.h
+++ b/OvmfPkg/Include/IndustryStandard/VirtioFs.h
@@ -141,6 +141,11 @@ typedef struct {
      )                                                               \\r
    )\r
 \r
+//\r
+// Flags for VirtioFsFuseOpRename2.\r
+//\r
+#define VIRTIO_FS_FUSE_RENAME2_REQ_F_NOREPLACE BIT0\r
+\r
 //\r
 // FUSE operation codes.\r
 //\r
@@ -164,6 +169,7 @@ typedef enum {
   VirtioFsFuseOpFsyncDir    = 30,\r
   VirtioFsFuseOpCreate      = 35,\r
   VirtioFsFuseOpReadDirPlus = 44,\r
+  VirtioFsFuseOpRename2     = 45,\r
 } VIRTIO_FS_FUSE_OPCODE;\r
 \r
 #pragma pack (1)\r
@@ -398,6 +404,15 @@ typedef struct {
   UINT32                             Namelen;\r
   UINT32                             Type;\r
 } VIRTIO_FS_FUSE_DIRENTPLUS_RESPONSE;\r
+\r
+//\r
+// Header for VirtioFsFuseOpRename2.\r
+//\r
+typedef struct {\r
+  UINT64 NewDir;\r
+  UINT32 Flags;\r
+  UINT32 Padding;\r
+} VIRTIO_FS_FUSE_RENAME2_REQUEST;\r
 #pragma pack ()\r
 \r
 #endif // VIRTIO_FS_H_\r

diff --git a/OvmfPkg/VirtioFsDxe/FuseRename.c b/OvmfPkg/VirtioFsDxe/FuseRename.c
new file mode 100644 (file)
index 0000000..fc9b27c
--- /dev/null
+++ b/OvmfPkg/VirtioFsDxe/FuseRename.c
@@ -0,0 +1,131 @@
+/** @file\r
+  FUSE_RENAME2 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
+  Rename a regular file or a directory, by sending the FUSE_RENAME2 request to\r
+  the Virtio Filesystem device. If the new filename exists, the request will\r
+  fail.\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\r
+                              FUSE_RENAME2 request to. On output, the FUSE\r
+                              request counter "VirtioFs->RequestId" will have\r
+                              been incremented.\r
+\r
+  @param[in] OldParentNodeId  The inode number of the directory in which\r
+                              OldName should be removed.\r
+\r
+  @param[in] OldName          The single-component filename to remove in the\r
+                              directory identified by OldParentNodeId.\r
+\r
+  @param[in] NewParentNodeId  The inode number of the directory in which\r
+                              NewName should be created, such that on\r
+                              successful return, (NewParentNodeId, NewName)\r
+                              refer to the same inode as (OldParentNodeId,\r
+                              OldName) did on entry.\r
+\r
+  @param[in] NewName          The single-component filename to create in the\r
+                              directory identified by NewParentNodeId.\r
+\r
+  @retval EFI_SUCCESS  The file or directory has been renamed.\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
+VirtioFsFuseRename (\r
+  IN OUT VIRTIO_FS *VirtioFs,\r
+  IN     UINT64    OldParentNodeId,\r
+  IN     CHAR8     *OldName,\r
+  IN     UINT64    NewParentNodeId,\r
+  IN     CHAR8     *NewName\r
+  )\r
+{\r
+  VIRTIO_FS_FUSE_REQUEST         CommonReq;\r
+  VIRTIO_FS_FUSE_RENAME2_REQUEST Rename2Req;\r
+  VIRTIO_FS_IO_VECTOR            ReqIoVec[4];\r
+  VIRTIO_FS_SCATTER_GATHER_LIST  ReqSgList;\r
+  VIRTIO_FS_FUSE_RESPONSE        CommonResp;\r
+  VIRTIO_FS_IO_VECTOR            RespIoVec[1];\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 = &Rename2Req;\r
+  ReqIoVec[1].Size   = sizeof Rename2Req;\r
+  ReqIoVec[2].Buffer = OldName;\r
+  ReqIoVec[2].Size   = AsciiStrSize (OldName);\r
+  ReqIoVec[3].Buffer = NewName;\r
+  ReqIoVec[3].Size   = AsciiStrSize (NewName);\r
+  ReqSgList.IoVec    = ReqIoVec;\r
+  ReqSgList.NumVec   = ARRAY_SIZE (ReqIoVec);\r
+\r
+  RespIoVec[0].Buffer = &CommonResp;\r
+  RespIoVec[0].Size   = sizeof CommonResp;\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
+             VirtioFsFuseOpRename2, OldParentNodeId);\r
+  if (EFI_ERROR (Status)) {\r
+    return Status;\r
+  }\r
+\r
+  //\r
+  // Populate the FUSE_RENAME2-specific fields.\r
+  //\r
+  Rename2Req.NewDir  = NewParentNodeId;\r
+  Rename2Req.Flags   = VIRTIO_FS_FUSE_RENAME2_REQ_F_NOREPLACE;\r
+  Rename2Req.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 (Status == EFI_DEVICE_ERROR) {\r
+    DEBUG ((DEBUG_ERROR, "%a: Label=\"%s\" OldParentNodeId=%Lu OldName=\"%a\" "\r
+      "NewParentNodeId=%Lu NewName=\"%a\" Errno=%d\n", __FUNCTION__,\r
+      VirtioFs->Label, OldParentNodeId, OldName, NewParentNodeId, NewName,\r
+      CommonResp.Error));\r
+    Status = VirtioFsErrnoToEfiStatus (CommonResp.Error);\r
+  }\r
+  return Status;\r
+}\r

diff --git a/OvmfPkg/VirtioFsDxe/VirtioFsDxe.h b/OvmfPkg/VirtioFsDxe/VirtioFsDxe.h
index 132a63400527ab583cbbc96cb7c3f8f574365a4a..9334e5434c51b6dd1e72a40d075a8719eefb3acd 100644 (file)
--- a/OvmfPkg/VirtioFsDxe/VirtioFsDxe.h
+++ b/OvmfPkg/VirtioFsDxe/VirtioFsDxe.h
@@ -396,6 +396,15 @@ VirtioFsFuseOpenOrCreate (
      OUT UINT64    *FuseHandle\r
   );\r
 \r
+EFI_STATUS\r
+VirtioFsFuseRename (\r
+  IN OUT VIRTIO_FS *VirtioFs,\r
+  IN     UINT64    OldParentNodeId,\r
+  IN     CHAR8     *OldName,\r
+  IN     UINT64    NewParentNodeId,\r
+  IN     CHAR8     *NewName\r
+  );\r
+\r
 //\r
 // EFI_SIMPLE_FILE_SYSTEM_PROTOCOL member functions for the Virtio Filesystem\r
 // driver.\r

diff --git a/OvmfPkg/VirtioFsDxe/VirtioFsDxe.inf b/OvmfPkg/VirtioFsDxe/VirtioFsDxe.inf
index 2c145da5f5aed8be26a6482c4f58598ee195d1c4..9dccd7d6a9ef44a0013b14f3bbe0f4d5bddc93a8 100644 (file)
--- a/OvmfPkg/VirtioFsDxe/VirtioFsDxe.inf
+++ b/OvmfPkg/VirtioFsDxe/VirtioFsDxe.inf
@@ -95,6 +95,7 @@
   FuseOpenOrCreate.c\r
   FuseRead.c\r
   FuseRelease.c\r
+  FuseRename.c\r
   FuseStatFs.c\r
   FuseUnlink.c\r
   FuseWrite.c\r