OvmfPkg/VirtioFsDxe: implement the wrapper function for FUSE_MKDIR

Add the VirtioFsFuseMkDir() function, for sending the FUSE_MKDIR 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-20-lersek@redhat.com>
Acked-by: Ard Biesheuvel <ard.biesheuvel@arm.com>

4 files changed, 198 insertions, 0 deletions

diff --git a/OvmfPkg/Include/IndustryStandard/VirtioFs.h b/OvmfPkg/Include/IndustryStandard/VirtioFs.h
index 7b6f303355..9ffeb9c8c9 100644
--- a/OvmfPkg/Include/IndustryStandard/VirtioFs.h
+++ b/OvmfPkg/Include/IndustryStandard/VirtioFs.h
@@ -82,6 +82,13 @@ typedef struct {
 #define VIRTIO_FS_FUSE_ROOT_DIR_NODE_ID 1

 

 //

+// File mode bitmasks.

+//

+#define VIRTIO_FS_FUSE_MODE_PERM_RWXU 0000700u

+#define VIRTIO_FS_FUSE_MODE_PERM_RWXG 0000070u

+#define VIRTIO_FS_FUSE_MODE_PERM_RWXO 0000007u

+

+//

 // Flags for VirtioFsFuseOpOpen.

 //

 #define VIRTIO_FS_FUSE_OPEN_REQ_F_RDONLY 0

@@ -92,6 +99,7 @@ typedef struct {
 //

 typedef enum {

   VirtioFsFuseOpForget      =  2,

+  VirtioFsFuseOpMkDir       =  9,

   VirtioFsFuseOpOpen        = 14,

   VirtioFsFuseOpRelease     = 18,

   VirtioFsFuseOpFsync       = 20,

@@ -124,6 +132,45 @@ typedef struct {
 } VIRTIO_FS_FUSE_RESPONSE;

 

 //

+// Structure with which the Virtio Filesystem device reports a NodeId to the

+// FUSE client (i.e., to the Virtio Filesystem driver). This structure is a

+// part of the response headers for operations that inform the FUSE client of

+// an inode.

+//

+typedef struct {

+  UINT64 NodeId;

+  UINT64 Generation;

+  UINT64 EntryValid;

+  UINT64 AttrValid;

+  UINT32 EntryValidNsec;

+  UINT32 AttrValidNsec;

+} VIRTIO_FS_FUSE_NODE_RESPONSE;

+

+//

+// Structure describing the host-side attributes of an inode. This structure is

+// a part of the response headers for operations that inform the FUSE client of

+// an inode.

+//

+typedef struct {

+  UINT64 Ino;

+  UINT64 Size;

+  UINT64 Blocks;

+  UINT64 Atime;

+  UINT64 Mtime;

+  UINT64 Ctime;

+  UINT32 AtimeNsec;

+  UINT32 MtimeNsec;

+  UINT32 CtimeNsec;

+  UINT32 Mode;

+  UINT32 Nlink;

+  UINT32 Uid;

+  UINT32 Gid;

+  UINT32 Rdev;

+  UINT32 Blksize;

+  UINT32 Padding;

+} VIRTIO_FS_FUSE_ATTRIBUTES_RESPONSE;

+

+//

 // Header for VirtioFsFuseOpForget.

 //

 typedef struct {

@@ -131,6 +178,14 @@ typedef struct {
 } VIRTIO_FS_FUSE_FORGET_REQUEST;

 

 //

+// Header for VirtioFsFuseOpMkDir.

+//

+typedef struct {

+  UINT32 Mode;

+  UINT32 Umask;

+} VIRTIO_FS_FUSE_MKDIR_REQUEST;

+

+//

 // Headers for VirtioFsFuseOpOpen and VirtioFsFuseOpOpenDir.

 //

 typedef struct {

diff --git a/OvmfPkg/VirtioFsDxe/FuseMkDir.c b/OvmfPkg/VirtioFsDxe/FuseMkDir.c
new file mode 100644
index 0000000000..541ff330cd
--- /dev/null
+++ b/OvmfPkg/VirtioFsDxe/FuseMkDir.c
@@ -0,0 +1,134 @@
+/** @file

+  FUSE_MKDIR wrapper for the Virtio Filesystem device.

+

+  Copyright (C) 2020, Red Hat, Inc.

+

+  SPDX-License-Identifier: BSD-2-Clause-Patent

+**/

+

+#include <Library/BaseLib.h> // AsciiStrSize()

+

+#include "VirtioFsDxe.h"

+

+/**

+  Send a FUSE_MKDIR request to the Virtio Filesystem device, for creating a

+  directory.

+

+  The function may only be called after VirtioFsFuseInitSession() returns

+  successfully and before VirtioFsUninit() is called.

+

+  @param[in,out] VirtioFs  The Virtio Filesystem device to send the FUSE_MKDIR

+                           request to. On output, the FUSE request counter

+                           "VirtioFs->RequestId" will have been incremented.

+

+  @param[in] ParentNodeId  The inode number of the direct parent directory of

+                           the directory to create.

+

+  @param[in] Name          The single-component filename of the directory to

+                           create, under the parent directory identified by

+                           ParentNodeId.

+

+  @param[out] NodeId       The inode number of the new directory.

+

+  @retval EFI_SUCCESS  The directory has been created.

+

+  @return              The "errno" value mapped to an EFI_STATUS code, if the

+                       Virtio Filesystem device explicitly reported an error.

+

+  @return              Error codes propagated from VirtioFsSgListsValidate(),

+                       VirtioFsFuseNewRequest(), VirtioFsSgListsSubmit(),

+                       VirtioFsFuseCheckResponse().

+**/

+EFI_STATUS

+VirtioFsFuseMkDir (

+  IN OUT VIRTIO_FS *VirtioFs,

+  IN     UINT64    ParentNodeId,

+  IN     CHAR8     *Name,

+     OUT UINT64    *NodeId

+  )

+{

+  VIRTIO_FS_FUSE_REQUEST             CommonReq;

+  VIRTIO_FS_FUSE_MKDIR_REQUEST       MkDirReq;

+  VIRTIO_FS_IO_VECTOR                ReqIoVec[3];

+  VIRTIO_FS_SCATTER_GATHER_LIST      ReqSgList;

+  VIRTIO_FS_FUSE_RESPONSE            CommonResp;

+  VIRTIO_FS_FUSE_NODE_RESPONSE       NodeResp;

+  VIRTIO_FS_FUSE_ATTRIBUTES_RESPONSE AttrResp;

+  VIRTIO_FS_IO_VECTOR                RespIoVec[3];

+  VIRTIO_FS_SCATTER_GATHER_LIST      RespSgList;

+  EFI_STATUS                         Status;

+

+  //

+  // Set up the scatter-gather lists.

+  //

+  ReqIoVec[0].Buffer = &CommonReq;

+  ReqIoVec[0].Size   = sizeof CommonReq;

+  ReqIoVec[1].Buffer = &MkDirReq;

+  ReqIoVec[1].Size   = sizeof MkDirReq;

+  ReqIoVec[2].Buffer = Name;

+  ReqIoVec[2].Size   = AsciiStrSize (Name);

+  ReqSgList.IoVec    = ReqIoVec;

+  ReqSgList.NumVec   = ARRAY_SIZE (ReqIoVec);

+

+  RespIoVec[0].Buffer = &CommonResp;

+  RespIoVec[0].Size   = sizeof CommonResp;

+  RespIoVec[1].Buffer = &NodeResp;

+  RespIoVec[1].Size   = sizeof NodeResp;

+  RespIoVec[2].Buffer = &AttrResp;

+  RespIoVec[2].Size   = sizeof AttrResp;

+  RespSgList.IoVec    = RespIoVec;

+  RespSgList.NumVec   = ARRAY_SIZE (RespIoVec);

+

+  //

+  // Validate the scatter-gather lists; calculate the total transfer sizes.

+  //

+  Status = VirtioFsSgListsValidate (VirtioFs, &ReqSgList, &RespSgList);

+  if (EFI_ERROR (Status)) {

+    return Status;

+  }

+

+  //

+  // Populate the common request header.

+  //

+  Status = VirtioFsFuseNewRequest (VirtioFs, &CommonReq, ReqSgList.TotalSize,

+             VirtioFsFuseOpMkDir, ParentNodeId);

+  if (EFI_ERROR (Status)) {

+    return Status;

+  }

+

+  //

+  // Populate the FUSE_MKDIR-specific fields.

+  //

+  MkDirReq.Mode  = (VIRTIO_FS_FUSE_MODE_PERM_RWXU |

+                    VIRTIO_FS_FUSE_MODE_PERM_RWXG |

+                    VIRTIO_FS_FUSE_MODE_PERM_RWXO);

+  MkDirReq.Umask = 0;

+

+  //

+  // Submit the request.

+  //

+  Status = VirtioFsSgListsSubmit (VirtioFs, &ReqSgList, &RespSgList);

+  if (EFI_ERROR (Status)) {

+    return Status;

+  }

+

+  //

+  // Verify the response (all response buffers are fixed size).

+  //

+  Status = VirtioFsFuseCheckResponse (&RespSgList, CommonReq.Unique, NULL);

+  if (EFI_ERROR (Status)) {

+    if (Status == EFI_DEVICE_ERROR) {

+      DEBUG ((DEBUG_ERROR, "%a: Label=\"%s\" ParentNodeId=%Lu Name=\"%a\" "

+        "Errno=%d\n", __FUNCTION__, VirtioFs->Label, ParentNodeId, Name,

+        CommonResp.Error));

+      Status = VirtioFsErrnoToEfiStatus (CommonResp.Error);

+    }

+    return Status;

+  }

+

+  //

+  // Output the NodeId of the new directory.

+  //

+  *NodeId = NodeResp.NodeId;

+  return EFI_SUCCESS;

+}

diff --git a/OvmfPkg/VirtioFsDxe/VirtioFsDxe.h b/OvmfPkg/VirtioFsDxe/VirtioFsDxe.h
index c13258a2e0..8fd56bdbf6 100644
--- a/OvmfPkg/VirtioFsDxe/VirtioFsDxe.h
+++ b/OvmfPkg/VirtioFsDxe/VirtioFsDxe.h
@@ -236,6 +236,14 @@ VirtioFsFuseForget (
   );

 

 EFI_STATUS

+VirtioFsFuseMkDir (

+  IN OUT VIRTIO_FS *VirtioFs,

+  IN     UINT64    ParentNodeId,

+  IN     CHAR8     *Name,

+     OUT UINT64    *NodeId

+  );

+

+EFI_STATUS

 VirtioFsFuseOpen (

   IN OUT VIRTIO_FS *VirtioFs,

   IN     UINT64    NodeId,

diff --git a/OvmfPkg/VirtioFsDxe/VirtioFsDxe.inf b/OvmfPkg/VirtioFsDxe/VirtioFsDxe.inf
index dc9a12820f..eebb86f7c2 100644
--- a/OvmfPkg/VirtioFsDxe/VirtioFsDxe.inf
+++ b/OvmfPkg/VirtioFsDxe/VirtioFsDxe.inf
@@ -86,6 +86,7 @@
   FuseForget.c

   FuseFsync.c

   FuseInit.c

+  FuseMkDir.c

   FuseOpen.c

   FuseOpenDir.c

   FuseRelease.c