OvmfPkg/VirtioFsDxe: implement the wrapper function for FUSE_OPEN

Add the VirtioFsFuseOpen() function, for sending the FUSE_OPEN 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-19-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 fec2f4be531f3c3cad574295f33b4677fdf7556e..7b6f30335577336f8541382a3f329ced591dfa53 100644 (file)
--- a/OvmfPkg/Include/IndustryStandard/VirtioFs.h
+++ b/OvmfPkg/Include/IndustryStandard/VirtioFs.h
@@ -81,11 +81,18 @@ typedef struct {
 //\r
 #define VIRTIO_FS_FUSE_ROOT_DIR_NODE_ID 1\r
 \r
+//\r
+// Flags for VirtioFsFuseOpOpen.\r
+//\r
+#define VIRTIO_FS_FUSE_OPEN_REQ_F_RDONLY 0\r
+#define VIRTIO_FS_FUSE_OPEN_REQ_F_RDWR   2\r
+\r
 //\r
 // FUSE operation codes.\r
 //\r
 typedef enum {\r
   VirtioFsFuseOpForget      =  2,\r
+  VirtioFsFuseOpOpen        = 14,\r
   VirtioFsFuseOpRelease     = 18,\r
   VirtioFsFuseOpFsync       = 20,\r
   VirtioFsFuseOpFlush       = 25,\r
@@ -123,6 +130,20 @@ typedef struct {
   UINT64 NumberOfLookups;\r
 } VIRTIO_FS_FUSE_FORGET_REQUEST;\r
 \r
+//\r
+// Headers for VirtioFsFuseOpOpen and VirtioFsFuseOpOpenDir.\r
+//\r
+typedef struct {\r
+  UINT32 Flags;\r
+  UINT32 Unused;\r
+} VIRTIO_FS_FUSE_OPEN_REQUEST;\r
+\r
+typedef struct {\r
+  UINT64 FileHandle;\r
+  UINT32 OpenFlags;\r
+  UINT32 Padding;\r
+} VIRTIO_FS_FUSE_OPEN_RESPONSE;\r
+\r
 //\r
 // Header for VirtioFsFuseOpRelease and VirtioFsFuseOpReleaseDir.\r
 //\r
@@ -175,20 +196,6 @@ typedef struct {
   UINT16 MapAlignment;\r
   UINT32 Unused[8];\r
 } VIRTIO_FS_FUSE_INIT_RESPONSE;\r
-\r
-//\r
-// Headers for VirtioFsFuseOpOpenDir.\r
-//\r
-typedef struct {\r
-  UINT32 Flags;\r
-  UINT32 Unused;\r
-} VIRTIO_FS_FUSE_OPEN_REQUEST;\r
-\r
-typedef struct {\r
-  UINT64 FileHandle;\r
-  UINT32 OpenFlags;\r
-  UINT32 Padding;\r
-} VIRTIO_FS_FUSE_OPEN_RESPONSE;\r
 #pragma pack ()\r
 \r
 #endif // VIRTIO_FS_H_\r

diff --git a/OvmfPkg/VirtioFsDxe/FuseOpen.c b/OvmfPkg/VirtioFsDxe/FuseOpen.c
new file mode 100644 (file)
index 0000000..b731580
--- /dev/null
+++ b/OvmfPkg/VirtioFsDxe/FuseOpen.c
@@ -0,0 +1,126 @@
+/** @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 (VirtioFs, &CommonReq, ReqSgList.TotalSize,\r
+             VirtioFsFuseOpOpen, NodeId);\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 ((DEBUG_ERROR, "%a: Label=\"%s\" NodeId=%Lu ReadWrite=%d "\r
+        "Errno=%d\n", __FUNCTION__, VirtioFs->Label, NodeId, ReadWrite,\r
+        CommonResp.Error));\r
+      Status = VirtioFsErrnoToEfiStatus (CommonResp.Error);\r
+    }\r
+    return Status;\r
+  }\r
+\r
+  //\r
+  // Output the open handle.\r
+  //\r
+  *FuseHandle = OpenResp.FileHandle;\r
+  return EFI_SUCCESS;\r
+}\r

diff --git a/OvmfPkg/VirtioFsDxe/VirtioFsDxe.h b/OvmfPkg/VirtioFsDxe/VirtioFsDxe.h
index 487d215c7f38fb20827e474e81fa9b787d9b27c3..c13258a2e08f9779fc44dd2911f5a9df07a38646 100644 (file)
--- a/OvmfPkg/VirtioFsDxe/VirtioFsDxe.h
+++ b/OvmfPkg/VirtioFsDxe/VirtioFsDxe.h
@@ -235,6 +235,14 @@ VirtioFsFuseForget (
   IN     UINT64    NodeId\r
   );\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
 EFI_STATUS\r
 VirtioFsFuseReleaseFileOrDir (\r
   IN OUT VIRTIO_FS *VirtioFs,\r

diff --git a/OvmfPkg/VirtioFsDxe/VirtioFsDxe.inf b/OvmfPkg/VirtioFsDxe/VirtioFsDxe.inf
index 0c92bccdac869c57320b5000cf969b59d70062d7..dc9a12820f3d3d896eb8e9fd2537784c8e4a9c35 100644 (file)
--- a/OvmfPkg/VirtioFsDxe/VirtioFsDxe.inf
+++ b/OvmfPkg/VirtioFsDxe/VirtioFsDxe.inf
@@ -86,6 +86,7 @@
   FuseForget.c\r
   FuseFsync.c\r
   FuseInit.c\r
+  FuseOpen.c\r
   FuseOpenDir.c\r
   FuseRelease.c\r
   Helpers.c\r