diff --git a/OvmfPkg/Include/IndustryStandard/VirtioFs.h b/OvmfPkg/Include/IndustryStandard/VirtioFs.h index c481053255..c17a43c160 100644 --- a/OvmfPkg/Include/IndustryStandard/VirtioFs.h +++ b/OvmfPkg/Include/IndustryStandard/VirtioFs.h @@ -80,8 +80,10 @@ typedef struct { // FUSE operation codes. // typedef enum { + VirtioFsFuseOpRelease = 18, VirtioFsFuseOpInit = 26, VirtioFsFuseOpOpenDir = 27, + VirtioFsFuseOpReleaseDir = 29, } VIRTIO_FS_FUSE_OPCODE; #pragma pack (1) @@ -105,6 +107,16 @@ typedef struct { UINT64 Unique; } VIRTIO_FS_FUSE_RESPONSE; +// +// Header for VirtioFsFuseOpRelease and VirtioFsFuseOpReleaseDir. +// +typedef struct { + UINT64 FileHandle; + UINT32 Flags; + UINT32 ReleaseFlags; + UINT64 LockOwner; +} VIRTIO_FS_FUSE_RELEASE_REQUEST; + // // Headers for VirtioFsFuseOpInit. // diff --git a/OvmfPkg/VirtioFsDxe/FuseRelease.c b/OvmfPkg/VirtioFsDxe/FuseRelease.c new file mode 100644 index 0000000000..dd45c7864f --- /dev/null +++ b/OvmfPkg/VirtioFsDxe/FuseRelease.c @@ -0,0 +1,121 @@ +/** @file + FUSE_RELEASE / FUSE_RELEASEDIR wrapper for the Virtio Filesystem device. + + Copyright (C) 2020, Red Hat, Inc. + + SPDX-License-Identifier: BSD-2-Clause-Patent +**/ + +#include "VirtioFsDxe.h" + +/** + Close a regular file or a directory that is open, by sending the FUSE_RELEASE + or FUSE_RELEASEDIR request to the Virtio Filesystem device. + + 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_RELEASE / FUSE_RELEASEDIR request to. On + output, the FUSE request counter + "VirtioFs->RequestId" will have been incremented. + + @param[in] NodeId The inode number of the file or directory to close. + + @param[in] FuseHandle The open handle to the file or directory to close. + + @param[in] IsDir TRUE if NodeId and FuseHandle refer to a directory, + FALSE if NodeId and FuseHandle refer to a regular + file. + + @retval EFI_SUCCESS The file or directory has been closed. + + @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 +VirtioFsFuseReleaseFileOrDir ( + IN OUT VIRTIO_FS *VirtioFs, + IN UINT64 NodeId, + IN UINT64 FuseHandle, + IN BOOLEAN IsDir + ) +{ + VIRTIO_FS_FUSE_REQUEST CommonReq; + VIRTIO_FS_FUSE_RELEASE_REQUEST ReleaseReq; + VIRTIO_FS_IO_VECTOR ReqIoVec[2]; + VIRTIO_FS_SCATTER_GATHER_LIST ReqSgList; + VIRTIO_FS_FUSE_RESPONSE CommonResp; + VIRTIO_FS_IO_VECTOR RespIoVec[1]; + 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 = &ReleaseReq; + ReqIoVec[1].Size = sizeof ReleaseReq; + ReqSgList.IoVec = ReqIoVec; + ReqSgList.NumVec = ARRAY_SIZE (ReqIoVec); + + RespIoVec[0].Buffer = &CommonResp; + RespIoVec[0].Size = sizeof CommonResp; + 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, + IsDir ? VirtioFsFuseOpReleaseDir : VirtioFsFuseOpRelease, + NodeId + ); + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Populate the FUSE_RELEASE- / FUSE_RELEASEDIR-specific fields. + // + ReleaseReq.FileHandle = FuseHandle; + ReleaseReq.Flags = 0; + ReleaseReq.ReleaseFlags = 0; + ReleaseReq.LockOwner = 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 (Status == EFI_DEVICE_ERROR) { + DEBUG ((DEBUG_ERROR, "%a: Label=\"%s\" NodeId=%Lu FuseHandle=%Lu " + "IsDir=%d Errno=%d\n", __FUNCTION__, VirtioFs->Label, NodeId, FuseHandle, + IsDir, CommonResp.Error)); + Status = VirtioFsErrnoToEfiStatus (CommonResp.Error); + } + return Status; +} diff --git a/OvmfPkg/VirtioFsDxe/VirtioFsDxe.h b/OvmfPkg/VirtioFsDxe/VirtioFsDxe.h index 9c47454435..a99625d047 100644 --- a/OvmfPkg/VirtioFsDxe/VirtioFsDxe.h +++ b/OvmfPkg/VirtioFsDxe/VirtioFsDxe.h @@ -158,6 +158,14 @@ VirtioFsErrnoToEfiStatus ( // Wrapper functions for FUSE commands (primitives). // +EFI_STATUS +VirtioFsFuseReleaseFileOrDir ( + IN OUT VIRTIO_FS *VirtioFs, + IN UINT64 NodeId, + IN UINT64 FuseHandle, + IN BOOLEAN IsDir + ); + EFI_STATUS VirtioFsFuseInitSession ( IN OUT VIRTIO_FS *VirtioFs diff --git a/OvmfPkg/VirtioFsDxe/VirtioFsDxe.inf b/OvmfPkg/VirtioFsDxe/VirtioFsDxe.inf index 051acbdd71..95b1a5a8f6 100644 --- a/OvmfPkg/VirtioFsDxe/VirtioFsDxe.inf +++ b/OvmfPkg/VirtioFsDxe/VirtioFsDxe.inf @@ -84,6 +84,7 @@ DriverBinding.c FuseInit.c FuseOpenDir.c + FuseRelease.c Helpers.c SimpleFsOpenVolume.c VirtioFsDxe.h