[mirror_edk2.git] / OvmfPkg / VirtioFsDxe / VirtioFsDxe.h

/** @file\r
  Internal macro definitions, type definitions, and function declarations for\r
  the Virtio Filesystem device driver.\r
\r
  Copyright (C) 2020, Red Hat, Inc.\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
**/\r
\r
#ifndef VIRTIO_FS_DXE_H_\r
#define VIRTIO_FS_DXE_H_\r
\r
#include <Base.h>                      // SIGNATURE_64()\r
#include <Guid/FileInfo.h>             // EFI_FILE_INFO\r
#include <IndustryStandard/VirtioFs.h> // VIRTIO_FS_TAG_BYTES\r
#include <Library/DebugLib.h>          // CR()\r
#include <Protocol/SimpleFileSystem.h> // EFI_SIMPLE_FILE_SYSTEM_PROTOCOL\r
#include <Protocol/VirtioDevice.h>     // VIRTIO_DEVICE_PROTOCOL\r
#include <Uefi/UefiBaseType.h>         // EFI_EVENT\r
\r
#define VIRTIO_FS_SIG SIGNATURE_64 ('V', 'I', 'R', 'T', 'I', 'O', 'F', 'S')\r
\r
#define VIRTIO_FS_FILE_SIG \\r
  SIGNATURE_64 ('V', 'I', 'O', 'F', 'S', 'F', 'I', 'L')\r
\r
//\r
// The following limit applies to two kinds of pathnames.\r
//\r
// - The length of a POSIX-style, canonical pathname *at rest* never exceeds\r
//   VIRTIO_FS_MAX_PATHNAME_LENGTH. (Length is defined as the number of CHAR8\r
//   elements in the canonical pathname, excluding the terminating '\0'.) This\r
//   is an invariant that is ensured for canonical pathnames created, and that\r
//   is assumed about canonical pathname inputs (which all originate\r
//   internally).\r
//\r
// - If the length of a UEFI-style pathname *argument*, originating directly or\r
//   indirectly from the EFI_FILE_PROTOCOL caller, exceeds\r
//   VIRTIO_FS_MAX_PATHNAME_LENGTH, then the argument is rejected. (Length is\r
//   defined as the number of CHAR16 elements in the UEFI-style pathname,\r
//   excluding the terminating L'\0'.) This is a restriction that's checked on\r
//   external UEFI-style pathname inputs.\r
//\r
// The limit is not expected to be a practical limitation; it's only supposed\r
// to prevent attempts at overflowing size calculations. For both kinds of\r
// pathnames, separate limits could be used; a common limit is used purely for\r
// simplicity.\r
//\r
#define VIRTIO_FS_MAX_PATHNAME_LENGTH ((UINTN)65535)\r
\r
//\r
// Filesystem label encoded in UCS-2, transformed from the UTF-8 representation\r
// in "VIRTIO_FS_CONFIG.Tag", and NUL-terminated. Only the printable ASCII code\r
// points (U+0020 through U+007E) are supported.\r
//\r
typedef CHAR16 VIRTIO_FS_LABEL[VIRTIO_FS_TAG_BYTES + 1];\r
\r
//\r
// Main context structure, expressing an EFI_SIMPLE_FILE_SYSTEM_PROTOCOL\r
// interface on top of the Virtio Filesystem device.\r
//\r
typedef struct {\r
  //\r
  // Parts of this structure are initialized / torn down in various functions\r
  // at various call depths. The table to the right should make it easier to\r
  // track them.\r
  //\r
  //                              field         init function       init depth\r
  //                              -----------   ------------------  ----------\r
  UINT64                          Signature; // DriverBindingStart  0\r
  VIRTIO_DEVICE_PROTOCOL          *Virtio;   // DriverBindingStart  0\r
  VIRTIO_FS_LABEL                 Label;     // VirtioFsInit        1\r
  UINT16                          QueueSize; // VirtioFsInit        1\r
  VRING                           Ring;      // VirtioRingInit      2\r
  VOID                            *RingMap;  // VirtioRingMap       2\r
  UINT64                          RequestId; // FuseInitSession     1\r
  EFI_EVENT                       ExitBoot;  // DriverBindingStart  0\r
  LIST_ENTRY                      OpenFiles; // DriverBindingStart  0\r
  EFI_SIMPLE_FILE_SYSTEM_PROTOCOL SimpleFs;  // DriverBindingStart  0\r
} VIRTIO_FS;\r
\r
#define VIRTIO_FS_FROM_SIMPLE_FS(SimpleFsReference) \\r
  CR (SimpleFsReference, VIRTIO_FS, SimpleFs, VIRTIO_FS_SIG);\r
\r
//\r
// Structure for describing a contiguous buffer, potentially mapped for Virtio\r
// transfer.\r
//\r
typedef struct {\r
  //\r
  // The following fields originate from the owner of the buffer.\r
  //\r
  VOID  *Buffer;\r
  UINTN Size;\r
  //\r
  // All of the fields below, until the end of the structure, are\r
  // zero-initialized when the structure is initially validated.\r
  //\r
  // Mapped, MappedAddress and Mapping are updated when the buffer is mapped\r
  // for VirtioOperationBusMasterRead or VirtioOperationBusMasterWrite. They\r
  // are again updated when the buffer is unmapped.\r
  //\r
  BOOLEAN              Mapped;\r
  EFI_PHYSICAL_ADDRESS MappedAddress;\r
  VOID                 *Mapping;\r
  //\r
  // Transferred is updated after VirtioFlush() returns successfully:\r
  // - for VirtioOperationBusMasterRead, Transferred is set to Size;\r
  // - for VirtioOperationBusMasterWrite, Transferred is calculated from the\r
  //   UsedLen output parameter of VirtioFlush().\r
  //\r
  UINTN Transferred;\r
} VIRTIO_FS_IO_VECTOR;\r
\r
//\r
// Structure for describing a list of IO Vectors.\r
//\r
typedef struct {\r
  //\r
  // The following fields originate from the owner of the buffers.\r
  //\r
  VIRTIO_FS_IO_VECTOR *IoVec;\r
  UINTN               NumVec;\r
  //\r
  // TotalSize is calculated when the scatter-gather list is initially\r
  // validated.\r
  //\r
  UINT32 TotalSize;\r
} VIRTIO_FS_SCATTER_GATHER_LIST;\r
\r
//\r
// Private context structure that exposes EFI_FILE_PROTOCOL on top of an open\r
// FUSE file reference.\r
//\r
typedef struct {\r
  UINT64            Signature;\r
  EFI_FILE_PROTOCOL SimpleFile;\r
  BOOLEAN           IsDirectory;\r
  BOOLEAN           IsOpenForWriting;\r
  VIRTIO_FS         *OwnerFs;\r
  LIST_ENTRY        OpenFilesEntry;\r
  CHAR8             *CanonicalPathname;\r
  //\r
  // In the FUSE wire protocol, every request except FUSE_INIT refers to a\r
  // file, namely by the "VIRTIO_FS_FUSE_REQUEST.NodeId" field; that is, by the\r
  // inode number of the file. However, some of the FUSE requests that we need\r
  // for some of the EFI_FILE_PROTOCOL member functions require an open file\r
  // handle *in addition* to the inode number. For simplicity, whenever a\r
  // VIRTIO_FS_FILE object is created, primarily defined by its NodeId field,\r
  // we also *open* the referenced file at once, and save the returned file\r
  // handle in the FuseHandle field. This way, when an EFI_FILE_PROTOCOL member\r
  // function must send a FUSE request that needs the file handle *in addition*\r
  // to the inode number, FuseHandle will be at our disposal at once.\r
  //\r
  UINT64 NodeId;\r
  UINT64 FuseHandle;\r
} VIRTIO_FS_FILE;\r
\r
#define VIRTIO_FS_FILE_FROM_SIMPLE_FILE(SimpleFileReference) \\r
  CR (SimpleFileReference, VIRTIO_FS_FILE, SimpleFile, VIRTIO_FS_FILE_SIG);\r
\r
#define VIRTIO_FS_FILE_FROM_OPEN_FILES_ENTRY(OpenFilesEntryReference) \\r
  CR (OpenFilesEntryReference, VIRTIO_FS_FILE, OpenFilesEntry, \\r
    VIRTIO_FS_FILE_SIG);\r
\r
//\r
// Initialization and helper routines for the Virtio Filesystem device.\r
//\r
\r
EFI_STATUS\r
VirtioFsInit (\r
  IN OUT VIRTIO_FS *VirtioFs\r
  );\r
\r
VOID\r
VirtioFsUninit (\r
  IN OUT VIRTIO_FS *VirtioFs\r
  );\r
\r
VOID\r
EFIAPI\r
VirtioFsExitBoot (\r
  IN EFI_EVENT ExitBootEvent,\r
  IN VOID      *VirtioFsAsVoid\r
  );\r
\r
EFI_STATUS\r
VirtioFsSgListsValidate (\r
  IN     VIRTIO_FS                     *VirtioFs,\r
  IN OUT VIRTIO_FS_SCATTER_GATHER_LIST *RequestSgList,\r
  IN OUT VIRTIO_FS_SCATTER_GATHER_LIST *ResponseSgList OPTIONAL\r
  );\r
\r
EFI_STATUS\r
VirtioFsSgListsSubmit (\r
  IN OUT VIRTIO_FS                     *VirtioFs,\r
  IN OUT VIRTIO_FS_SCATTER_GATHER_LIST *RequestSgList,\r
  IN OUT VIRTIO_FS_SCATTER_GATHER_LIST *ResponseSgList OPTIONAL\r
  );\r
\r
EFI_STATUS\r
VirtioFsFuseNewRequest (\r
  IN OUT VIRTIO_FS              *VirtioFs,\r
     OUT VIRTIO_FS_FUSE_REQUEST *Request,\r
  IN     UINT32                 RequestSize,\r
  IN     VIRTIO_FS_FUSE_OPCODE  Opcode,\r
  IN     UINT64                 NodeId\r
  );\r
\r
EFI_STATUS\r
VirtioFsFuseCheckResponse (\r
  IN  VIRTIO_FS_SCATTER_GATHER_LIST *ResponseSgList,\r
  IN  UINT64                        RequestId,\r
  OUT UINTN                         *TailBufferFill\r
  );\r
\r
EFI_STATUS\r
VirtioFsErrnoToEfiStatus (\r
  IN INT32 Errno\r
  );\r
\r
EFI_STATUS\r
VirtioFsAppendPath (\r
  IN     CHAR8   *LhsPath8,\r
  IN     CHAR16  *RhsPath16,\r
     OUT CHAR8   **ResultPath8,\r
     OUT BOOLEAN *RootEscape\r
  );\r
\r
EFI_STATUS\r
VirtioFsLookupMostSpecificParentDir (\r
  IN OUT VIRTIO_FS *VirtioFs,\r
  IN OUT CHAR8     *Path,\r
     OUT UINT64    *DirNodeId,\r
     OUT CHAR8     **LastComponent\r
  );\r
\r
EFI_STATUS\r
VirtioFsGetBasename (\r
  IN     CHAR8  *Path,\r
     OUT CHAR16 *Basename     OPTIONAL,\r
  IN OUT UINTN  *BasenameSize\r
  );\r
\r
EFI_STATUS\r
VirtioFsFuseAttrToEfiFileInfo (\r
  IN     VIRTIO_FS_FUSE_ATTRIBUTES_RESPONSE *FuseAttr,\r
     OUT EFI_FILE_INFO                      *FileInfo\r
  );\r
\r
//\r
// Wrapper functions for FUSE commands (primitives).\r
//\r
\r
EFI_STATUS\r
VirtioFsFuseLookup (\r
  IN OUT VIRTIO_FS                          *VirtioFs,\r
  IN     UINT64                             DirNodeId,\r
  IN     CHAR8                              *Name,\r
     OUT UINT64                             *NodeId,\r
     OUT VIRTIO_FS_FUSE_ATTRIBUTES_RESPONSE *FuseAttr\r
  );\r
\r
EFI_STATUS\r
VirtioFsFuseForget (\r
  IN OUT VIRTIO_FS *VirtioFs,\r
  IN     UINT64    NodeId\r
  );\r
\r
EFI_STATUS\r
VirtioFsFuseGetAttr (\r
  IN OUT VIRTIO_FS                          *VirtioFs,\r
  IN     UINT64                             NodeId,\r
     OUT VIRTIO_FS_FUSE_ATTRIBUTES_RESPONSE *FuseAttr\r
  );\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
EFI_STATUS\r
VirtioFsFuseRemoveFileOrDir (\r
  IN OUT VIRTIO_FS *VirtioFs,\r
  IN     UINT64    ParentNodeId,\r
  IN     CHAR8     *Name,\r
  IN     BOOLEAN   IsDir\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
VirtioFsFuseStatFs (\r
  IN OUT VIRTIO_FS                      *VirtioFs,\r
  IN     UINT64                         NodeId,\r
     OUT VIRTIO_FS_FUSE_STATFS_RESPONSE *FilesysAttr\r
     );\r
\r
EFI_STATUS\r
VirtioFsFuseReleaseFileOrDir (\r
  IN OUT VIRTIO_FS *VirtioFs,\r
  IN     UINT64    NodeId,\r
  IN     UINT64    FuseHandle,\r
  IN     BOOLEAN   IsDir\r
  );\r
\r
EFI_STATUS\r
VirtioFsFuseFsyncFileOrDir (\r
  IN OUT VIRTIO_FS *VirtioFs,\r
  IN     UINT64    NodeId,\r
  IN     UINT64    FuseHandle,\r
  IN     BOOLEAN   IsDir\r
  );\r
\r
EFI_STATUS\r
VirtioFsFuseFlush (\r
  IN OUT VIRTIO_FS *VirtioFs,\r
  IN     UINT64    NodeId,\r
  IN     UINT64    FuseHandle\r
  );\r
\r
EFI_STATUS\r
VirtioFsFuseInitSession (\r
  IN OUT VIRTIO_FS *VirtioFs\r
  );\r
\r
EFI_STATUS\r
VirtioFsFuseOpenDir (\r
  IN OUT VIRTIO_FS *VirtioFs,\r
  IN     UINT64    NodeId,\r
     OUT UINT64    *FuseHandle\r
  );\r
\r
EFI_STATUS\r
VirtioFsFuseOpenOrCreate (\r
  IN OUT VIRTIO_FS *VirtioFs,\r
  IN     UINT64    ParentNodeId,\r
  IN     CHAR8     *Name,\r
     OUT UINT64    *NodeId,\r
     OUT UINT64    *FuseHandle\r
  );\r
\r
//\r
// EFI_SIMPLE_FILE_SYSTEM_PROTOCOL member functions for the Virtio Filesystem\r
// driver.\r
//\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioFsOpenVolume (\r
  IN  EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *This,\r
  OUT EFI_FILE_PROTOCOL               **Root\r
  );\r
\r
//\r
// EFI_FILE_PROTOCOL member functions for the Virtio Filesystem driver.\r
//\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioFsSimpleFileClose (\r
  IN EFI_FILE_PROTOCOL *This\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioFsSimpleFileDelete (\r
  IN EFI_FILE_PROTOCOL *This\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioFsSimpleFileFlush (\r
  IN EFI_FILE_PROTOCOL *This\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioFsSimpleFileGetInfo (\r
  IN     EFI_FILE_PROTOCOL *This,\r
  IN     EFI_GUID          *InformationType,\r
  IN OUT UINTN             *BufferSize,\r
     OUT VOID              *Buffer\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioFsSimpleFileGetPosition (\r
  IN     EFI_FILE_PROTOCOL *This,\r
     OUT UINT64            *Position\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioFsSimpleFileOpen (\r
  IN     EFI_FILE_PROTOCOL *This,\r
     OUT EFI_FILE_PROTOCOL **NewHandle,\r
  IN     CHAR16            *FileName,\r
  IN     UINT64            OpenMode,\r
  IN     UINT64            Attributes\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioFsSimpleFileRead (\r
  IN     EFI_FILE_PROTOCOL *This,\r
  IN OUT UINTN             *BufferSize,\r
     OUT VOID              *Buffer\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioFsSimpleFileSetInfo (\r
  IN EFI_FILE_PROTOCOL *This,\r
  IN EFI_GUID          *InformationType,\r
  IN UINTN             BufferSize,\r
  IN VOID              *Buffer\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioFsSimpleFileSetPosition (\r
  IN EFI_FILE_PROTOCOL *This,\r
  IN UINT64            Position\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioFsSimpleFileWrite (\r
  IN     EFI_FILE_PROTOCOL *This,\r
  IN OUT UINTN             *BufferSize,\r
  IN     VOID              *Buffer\r
  );\r
\r
#endif // VIRTIO_FS_DXE_H_\r
Commit	Line	Data
b55d6622 LE	1	/** @file\r
	2	Internal macro definitions, type definitions, and function declarations for\r
	3	the Virtio Filesystem device driver.\r
	4	\r
	5	Copyright (C) 2020, Red Hat, Inc.\r
	6	\r
	7	SPDX-License-Identifier: BSD-2-Clause-Patent\r
	8	**/\r
	9	\r
	10	#ifndef VIRTIO_FS_DXE_H_\r
	11	#define VIRTIO_FS_DXE_H_\r
	12	\r
	13	#include <Base.h> // SIGNATURE_64()\r
cd473d41	14	#include <Guid/FileInfo.h> // EFI_FILE_INFO\r
eaa7115d	15	#include <IndustryStandard/VirtioFs.h> // VIRTIO_FS_TAG_BYTES\r
b55d6622 LE	16	#include <Library/DebugLib.h> // CR()\r
	17	#include <Protocol/SimpleFileSystem.h> // EFI_SIMPLE_FILE_SYSTEM_PROTOCOL\r
	18	#include <Protocol/VirtioDevice.h> // VIRTIO_DEVICE_PROTOCOL\r
eaa7115d	19	#include <Uefi/UefiBaseType.h> // EFI_EVENT\r
b55d6622 LE	20	\r
	21	#define VIRTIO_FS_SIG SIGNATURE_64 ('V', 'I', 'R', 'T', 'I', 'O', 'F', 'S')\r
	22	\r
334c13e1 LE	23	#define VIRTIO_FS_FILE_SIG \\r
	24	SIGNATURE_64 ('V', 'I', 'O', 'F', 'S', 'F', 'I', 'L')\r
	25	\r
9307d7c7 LE	26	//\r
	27	// The following limit applies to two kinds of pathnames.\r
	28	//\r
	29	// - The length of a POSIX-style, canonical pathname at rest never exceeds\r
	30	// VIRTIO_FS_MAX_PATHNAME_LENGTH. (Length is defined as the number of CHAR8\r
	31	// elements in the canonical pathname, excluding the terminating '\0'.) This\r
	32	// is an invariant that is ensured for canonical pathnames created, and that\r
	33	// is assumed about canonical pathname inputs (which all originate\r
	34	// internally).\r
	35	//\r
	36	// - If the length of a UEFI-style pathname argument, originating directly or\r
	37	// indirectly from the EFI_FILE_PROTOCOL caller, exceeds\r
	38	// VIRTIO_FS_MAX_PATHNAME_LENGTH, then the argument is rejected. (Length is\r
	39	// defined as the number of CHAR16 elements in the UEFI-style pathname,\r
	40	// excluding the terminating L'\0'.) This is a restriction that's checked on\r
	41	// external UEFI-style pathname inputs.\r
	42	//\r
	43	// The limit is not expected to be a practical limitation; it's only supposed\r
	44	// to prevent attempts at overflowing size calculations. For both kinds of\r
	45	// pathnames, separate limits could be used; a common limit is used purely for\r
	46	// simplicity.\r
	47	//\r
	48	#define VIRTIO_FS_MAX_PATHNAME_LENGTH ((UINTN)65535)\r
	49	\r
eaa7115d LE	50	//\r
	51	// Filesystem label encoded in UCS-2, transformed from the UTF-8 representation\r
	52	// in "VIRTIO_FS_CONFIG.Tag", and NUL-terminated. Only the printable ASCII code\r
	53	// points (U+0020 through U+007E) are supported.\r
	54	//\r
	55	typedef CHAR16 VIRTIO_FS_LABEL[VIRTIO_FS_TAG_BYTES + 1];\r
	56	\r
b55d6622 LE	57	//\r
	58	// Main context structure, expressing an EFI_SIMPLE_FILE_SYSTEM_PROTOCOL\r
	59	// interface on top of the Virtio Filesystem device.\r
	60	//\r
	61	typedef struct {\r
	62	//\r
	63	// Parts of this structure are initialized / torn down in various functions\r
	64	// at various call depths. The table to the right should make it easier to\r
	65	// track them.\r
	66	//\r
	67	// field init function init depth\r
	68	// ----------- ------------------ ----------\r
	69	UINT64 Signature; // DriverBindingStart 0\r
	70	VIRTIO_DEVICE_PROTOCOL *Virtio; // DriverBindingStart 0\r
eaa7115d LE	71	VIRTIO_FS_LABEL Label; // VirtioFsInit 1\r
	72	UINT16 QueueSize; // VirtioFsInit 1\r
	73	VRING Ring; // VirtioRingInit 2\r
	74	VOID *RingMap; // VirtioRingMap 2\r
fa97e372	75	UINT64 RequestId; // FuseInitSession 1\r
eaa7115d	76	EFI_EVENT ExitBoot; // DriverBindingStart 0\r
334c13e1	77	LIST_ENTRY OpenFiles; // DriverBindingStart 0\r
b55d6622 LE	78	EFI_SIMPLE_FILE_SYSTEM_PROTOCOL SimpleFs; // DriverBindingStart 0\r
	79	} VIRTIO_FS;\r
	80	\r
	81	#define VIRTIO_FS_FROM_SIMPLE_FS(SimpleFsReference) \\r
	82	CR (SimpleFsReference, VIRTIO_FS, SimpleFs, VIRTIO_FS_SIG);\r
	83	\r
6578cacb LE	84	//\r
	85	// Structure for describing a contiguous buffer, potentially mapped for Virtio\r
	86	// transfer.\r
	87	//\r
	88	typedef struct {\r
	89	//\r
	90	// The following fields originate from the owner of the buffer.\r
	91	//\r
	92	VOID *Buffer;\r
	93	UINTN Size;\r
	94	//\r
	95	// All of the fields below, until the end of the structure, are\r
	96	// zero-initialized when the structure is initially validated.\r
	97	//\r
	98	// Mapped, MappedAddress and Mapping are updated when the buffer is mapped\r
	99	// for VirtioOperationBusMasterRead or VirtioOperationBusMasterWrite. They\r
	100	// are again updated when the buffer is unmapped.\r
	101	//\r
	102	BOOLEAN Mapped;\r
	103	EFI_PHYSICAL_ADDRESS MappedAddress;\r
	104	VOID *Mapping;\r
	105	//\r
	106	// Transferred is updated after VirtioFlush() returns successfully:\r
	107	// - for VirtioOperationBusMasterRead, Transferred is set to Size;\r
	108	// - for VirtioOperationBusMasterWrite, Transferred is calculated from the\r
	109	// UsedLen output parameter of VirtioFlush().\r
	110	//\r
	111	UINTN Transferred;\r
	112	} VIRTIO_FS_IO_VECTOR;\r
	113	\r
	114	//\r
	115	// Structure for describing a list of IO Vectors.\r
	116	//\r
	117	typedef struct {\r
	118	//\r
	119	// The following fields originate from the owner of the buffers.\r
	120	//\r
	121	VIRTIO_FS_IO_VECTOR *IoVec;\r
	122	UINTN NumVec;\r
	123	//\r
	124	// TotalSize is calculated when the scatter-gather list is initially\r
	125	// validated.\r
	126	//\r
	127	UINT32 TotalSize;\r
	128	} VIRTIO_FS_SCATTER_GATHER_LIST;\r
	129	\r
334c13e1 LE	130	//\r
	131	// Private context structure that exposes EFI_FILE_PROTOCOL on top of an open\r
	132	// FUSE file reference.\r
	133	//\r
	134	typedef struct {\r
	135	UINT64 Signature;\r
	136	EFI_FILE_PROTOCOL SimpleFile;\r
	137	BOOLEAN IsDirectory;\r
28092a39	138	BOOLEAN IsOpenForWriting;\r
334c13e1 LE	139	VIRTIO_FS *OwnerFs;\r
334c13e1 LE	140	LIST_ENTRY OpenFilesEntry;\r
7e8c83f7	141	CHAR8 *CanonicalPathname;\r
334c13e1 LE	142	//\r
	143	// In the FUSE wire protocol, every request except FUSE_INIT refers to a\r
	144	// file, namely by the "VIRTIO_FS_FUSE_REQUEST.NodeId" field; that is, by the\r
	145	// inode number of the file. However, some of the FUSE requests that we need\r
	146	// for some of the EFI_FILE_PROTOCOL member functions require an open file\r
	147	// handle in addition to the inode number. For simplicity, whenever a\r
	148	// VIRTIO_FS_FILE object is created, primarily defined by its NodeId field,\r
	149	// we also open the referenced file at once, and save the returned file\r
	150	// handle in the FuseHandle field. This way, when an EFI_FILE_PROTOCOL member\r
	151	// function must send a FUSE request that needs the file handle in addition\r
	152	// to the inode number, FuseHandle will be at our disposal at once.\r
	153	//\r
	154	UINT64 NodeId;\r
	155	UINT64 FuseHandle;\r
	156	} VIRTIO_FS_FILE;\r
	157	\r
	158	#define VIRTIO_FS_FILE_FROM_SIMPLE_FILE(SimpleFileReference) \\r
	159	CR (SimpleFileReference, VIRTIO_FS_FILE, SimpleFile, VIRTIO_FS_FILE_SIG);\r
	160	\r
	161	#define VIRTIO_FS_FILE_FROM_OPEN_FILES_ENTRY(OpenFilesEntryReference) \\r
	162	CR (OpenFilesEntryReference, VIRTIO_FS_FILE, OpenFilesEntry, \\r
	163	VIRTIO_FS_FILE_SIG);\r
	164	\r
eaa7115d LE	165	//\r
	166	// Initialization and helper routines for the Virtio Filesystem device.\r
	167	//\r
	168	\r
	169	EFI_STATUS\r
	170	VirtioFsInit (\r
	171	IN OUT VIRTIO_FS *VirtioFs\r
	172	);\r
	173	\r
	174	VOID\r
	175	VirtioFsUninit (\r
	176	IN OUT VIRTIO_FS *VirtioFs\r
	177	);\r
	178	\r
	179	VOID\r
	180	EFIAPI\r
	181	VirtioFsExitBoot (\r
	182	IN EFI_EVENT ExitBootEvent,\r
	183	IN VOID *VirtioFsAsVoid\r
	184	);\r
	185	\r
6578cacb LE	186	EFI_STATUS\r
	187	VirtioFsSgListsValidate (\r
	188	IN VIRTIO_FS *VirtioFs,\r
	189	IN OUT VIRTIO_FS_SCATTER_GATHER_LIST *RequestSgList,\r
	190	IN OUT VIRTIO_FS_SCATTER_GATHER_LIST *ResponseSgList OPTIONAL\r
	191	);\r
	192	\r
	193	EFI_STATUS\r
	194	VirtioFsSgListsSubmit (\r
	195	IN OUT VIRTIO_FS *VirtioFs,\r
	196	IN OUT VIRTIO_FS_SCATTER_GATHER_LIST *RequestSgList,\r
	197	IN OUT VIRTIO_FS_SCATTER_GATHER_LIST *ResponseSgList OPTIONAL\r
	198	);\r
	199	\r
6a2dc768 LE	200	EFI_STATUS\r
	201	VirtioFsFuseNewRequest (\r
	202	IN OUT VIRTIO_FS *VirtioFs,\r
	203	OUT VIRTIO_FS_FUSE_REQUEST *Request,\r
	204	IN UINT32 RequestSize,\r
fa97e372	205	IN VIRTIO_FS_FUSE_OPCODE Opcode,\r
6a2dc768 LE	206	IN UINT64 NodeId\r
	207	);\r
	208	\r
	209	EFI_STATUS\r
	210	VirtioFsFuseCheckResponse (\r
	211	IN VIRTIO_FS_SCATTER_GATHER_LIST *ResponseSgList,\r
	212	IN UINT64 RequestId,\r
	213	OUT UINTN *TailBufferFill\r
	214	);\r
	215	\r
e8a74c9a LE	216	EFI_STATUS\r
	217	VirtioFsErrnoToEfiStatus (\r
	218	IN INT32 Errno\r
	219	);\r
	220	\r
9307d7c7 LE	221	EFI_STATUS\r
	222	VirtioFsAppendPath (\r
	223	IN CHAR8 *LhsPath8,\r
	224	IN CHAR16 *RhsPath16,\r
	225	OUT CHAR8 **ResultPath8,\r
	226	OUT BOOLEAN *RootEscape\r
	227	);\r
	228	\r
ca61b845 LE	229	EFI_STATUS\r
	230	VirtioFsLookupMostSpecificParentDir (\r
	231	IN OUT VIRTIO_FS *VirtioFs,\r
	232	IN OUT CHAR8 *Path,\r
	233	OUT UINT64 *DirNodeId,\r
	234	OUT CHAR8 **LastComponent\r
	235	);\r
	236	\r
44bc7879 LE	237	EFI_STATUS\r
	238	VirtioFsGetBasename (\r
	239	IN CHAR8 *Path,\r
	240	OUT CHAR16 *Basename OPTIONAL,\r
	241	IN OUT UINTN *BasenameSize\r
	242	);\r
	243	\r
cd473d41 LE	244	EFI_STATUS\r
	245	VirtioFsFuseAttrToEfiFileInfo (\r
	246	IN VIRTIO_FS_FUSE_ATTRIBUTES_RESPONSE *FuseAttr,\r
	247	OUT EFI_FILE_INFO *FileInfo\r
	248	);\r
	249	\r
fa97e372 LE	250	//\r
	251	// Wrapper functions for FUSE commands (primitives).\r
	252	//\r
	253	\r
b6ce961a LE	254	EFI_STATUS\r
	255	VirtioFsFuseLookup (\r
	256	IN OUT VIRTIO_FS *VirtioFs,\r
	257	IN UINT64 DirNodeId,\r
	258	IN CHAR8 *Name,\r
	259	OUT UINT64 *NodeId,\r
	260	OUT VIRTIO_FS_FUSE_ATTRIBUTES_RESPONSE *FuseAttr\r
	261	);\r
	262	\r
92a4d30e LE	263	EFI_STATUS\r
	264	VirtioFsFuseForget (\r
	265	IN OUT VIRTIO_FS *VirtioFs,\r
	266	IN UINT64 NodeId\r
	267	);\r
	268	\r
e3bc9577 LE	269	EFI_STATUS\r
	270	VirtioFsFuseGetAttr (\r
	271	IN OUT VIRTIO_FS *VirtioFs,\r
	272	IN UINT64 NodeId,\r
	273	OUT VIRTIO_FS_FUSE_ATTRIBUTES_RESPONSE *FuseAttr\r
	274	);\r
	275	\r
f058cb69 LE	276	EFI_STATUS\r
	277	VirtioFsFuseMkDir (\r
	278	IN OUT VIRTIO_FS *VirtioFs,\r
	279	IN UINT64 ParentNodeId,\r
	280	IN CHAR8 *Name,\r
	281	OUT UINT64 *NodeId\r
	282	);\r
	283	\r
0771671c LE	284	EFI_STATUS\r
	285	VirtioFsFuseRemoveFileOrDir (\r
	286	IN OUT VIRTIO_FS *VirtioFs,\r
	287	IN UINT64 ParentNodeId,\r
	288	IN CHAR8 *Name,\r
	289	IN BOOLEAN IsDir\r
	290	);\r
	291	\r
da82d2e3 LE	292	EFI_STATUS\r
	293	VirtioFsFuseOpen (\r
	294	IN OUT VIRTIO_FS *VirtioFs,\r
	295	IN UINT64 NodeId,\r
	296	IN BOOLEAN ReadWrite,\r
	297	OUT UINT64 *FuseHandle\r
	298	);\r
	299	\r
ba118463 LE	300	EFI_STATUS\r
	301	VirtioFsFuseStatFs (\r
	302	IN OUT VIRTIO_FS *VirtioFs,\r
	303	IN UINT64 NodeId,\r
	304	OUT VIRTIO_FS_FUSE_STATFS_RESPONSE *FilesysAttr\r
	305	);\r
	306	\r
72d4f133 LE	307	EFI_STATUS\r
	308	VirtioFsFuseReleaseFileOrDir (\r
	309	IN OUT VIRTIO_FS *VirtioFs,\r
	310	IN UINT64 NodeId,\r
	311	IN UINT64 FuseHandle,\r
	312	IN BOOLEAN IsDir\r
	313	);\r
	314	\r
2e151d26 LE	315	EFI_STATUS\r
	316	VirtioFsFuseFsyncFileOrDir (\r
	317	IN OUT VIRTIO_FS *VirtioFs,\r
	318	IN UINT64 NodeId,\r
	319	IN UINT64 FuseHandle,\r
	320	IN BOOLEAN IsDir\r
	321	);\r
	322	\r
d0474399 LE	323	EFI_STATUS\r
	324	VirtioFsFuseFlush (\r
	325	IN OUT VIRTIO_FS *VirtioFs,\r
	326	IN UINT64 NodeId,\r
	327	IN UINT64 FuseHandle\r
	328	);\r
	329	\r
fa97e372 LE	330	EFI_STATUS\r
	331	VirtioFsFuseInitSession (\r
	332	IN OUT VIRTIO_FS *VirtioFs\r
	333	);\r
	334	\r
b62a0c56 LE	335	EFI_STATUS\r
	336	VirtioFsFuseOpenDir (\r
	337	IN OUT VIRTIO_FS *VirtioFs,\r
	338	IN UINT64 NodeId,\r
	339	OUT UINT64 *FuseHandle\r
	340	);\r
	341	\r
a70860f4 LE	342	EFI_STATUS\r
	343	VirtioFsFuseOpenOrCreate (\r
	344	IN OUT VIRTIO_FS *VirtioFs,\r
	345	IN UINT64 ParentNodeId,\r
	346	IN CHAR8 *Name,\r
	347	OUT UINT64 *NodeId,\r
	348	OUT UINT64 *FuseHandle\r
	349	);\r
	350	\r
b55d6622 LE	351	//\r
	352	// EFI_SIMPLE_FILE_SYSTEM_PROTOCOL member functions for the Virtio Filesystem\r
	353	// driver.\r
	354	//\r
	355	\r
	356	EFI_STATUS\r
	357	EFIAPI\r
	358	VirtioFsOpenVolume (\r
	359	IN EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *This,\r
	360	OUT EFI_FILE_PROTOCOL **Root\r
	361	);\r
	362	\r
334c13e1 LE	363	//\r
	364	// EFI_FILE_PROTOCOL member functions for the Virtio Filesystem driver.\r
	365	//\r
	366	\r
	367	EFI_STATUS\r
	368	EFIAPI\r
	369	VirtioFsSimpleFileClose (\r
	370	IN EFI_FILE_PROTOCOL *This\r
	371	);\r
	372	\r
	373	EFI_STATUS\r
	374	EFIAPI\r
	375	VirtioFsSimpleFileDelete (\r
	376	IN EFI_FILE_PROTOCOL *This\r
	377	);\r
	378	\r
	379	EFI_STATUS\r
	380	EFIAPI\r
	381	VirtioFsSimpleFileFlush (\r
	382	IN EFI_FILE_PROTOCOL *This\r
	383	);\r
	384	\r
	385	EFI_STATUS\r
	386	EFIAPI\r
	387	VirtioFsSimpleFileGetInfo (\r
	388	IN EFI_FILE_PROTOCOL *This,\r
	389	IN EFI_GUID *InformationType,\r
	390	IN OUT UINTN *BufferSize,\r
	391	OUT VOID *Buffer\r
	392	);\r
	393	\r
	394	EFI_STATUS\r
	395	EFIAPI\r
	396	VirtioFsSimpleFileGetPosition (\r
	397	IN EFI_FILE_PROTOCOL *This,\r
	398	OUT UINT64 *Position\r
	399	);\r
	400	\r
	401	EFI_STATUS\r
	402	EFIAPI\r
	403	VirtioFsSimpleFileOpen (\r
	404	IN EFI_FILE_PROTOCOL *This,\r
	405	OUT EFI_FILE_PROTOCOL **NewHandle,\r
	406	IN CHAR16 *FileName,\r
	407	IN UINT64 OpenMode,\r
	408	IN UINT64 Attributes\r
	409	);\r
	410	\r
	411	EFI_STATUS\r
	412	EFIAPI\r
	413	VirtioFsSimpleFileRead (\r
	414	IN EFI_FILE_PROTOCOL *This,\r
	415	IN OUT UINTN *BufferSize,\r
	416	OUT VOID *Buffer\r
	417	);\r
	418	\r
	419	EFI_STATUS\r
	420	EFIAPI\r
	421	VirtioFsSimpleFileSetInfo (\r
	422	IN EFI_FILE_PROTOCOL *This,\r
	423	IN EFI_GUID *InformationType,\r
	424	IN UINTN BufferSize,\r
	425	IN VOID *Buffer\r
	426	);\r
427	\r
428	EFI_STATUS\r
429	EFIAPI\r
430	VirtioFsSimpleFileSetPosition (\r
431	IN EFI_FILE_PROTOCOL *This,\r
432	IN UINT64 Position\r
433	);\r
434	\r
435	EFI_STATUS\r
436	EFIAPI\r
437	VirtioFsSimpleFileWrite (\r
438	IN EFI_FILE_PROTOCOL *This,\r
439	IN OUT UINTN *BufferSize,\r
440	IN VOID *Buffer\r
441	);\r
442	\r
b55d6622	443	#endif // VIRTIO_FS_DXE_H_\r