2 Internal macro definitions, type definitions, and function declarations for
3 the Virtio Filesystem device driver.
5 Copyright (C) 2020, Red Hat, Inc.
7 SPDX-License-Identifier: BSD-2-Clause-Patent
10 #ifndef VIRTIO_FS_DXE_H_
11 #define VIRTIO_FS_DXE_H_
13 #include <Base.h> // SIGNATURE_64()
14 #include <Guid/FileInfo.h> // EFI_FILE_INFO
15 #include <IndustryStandard/VirtioFs.h> // VIRTIO_FS_TAG_BYTES
16 #include <Library/DebugLib.h> // CR()
17 #include <Protocol/SimpleFileSystem.h> // EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
18 #include <Protocol/VirtioDevice.h> // VIRTIO_DEVICE_PROTOCOL
19 #include <Uefi/UefiBaseType.h> // EFI_EVENT
21 #define VIRTIO_FS_SIG SIGNATURE_64 ('V', 'I', 'R', 'T', 'I', 'O', 'F', 'S')
23 #define VIRTIO_FS_FILE_SIG \
24 SIGNATURE_64 ('V', 'I', 'O', 'F', 'S', 'F', 'I', 'L')
27 // The following limit applies to two kinds of pathnames.
29 // - The length of a POSIX-style, canonical pathname *at rest* never exceeds
30 // VIRTIO_FS_MAX_PATHNAME_LENGTH. (Length is defined as the number of CHAR8
31 // elements in the canonical pathname, excluding the terminating '\0'.) This
32 // is an invariant that is ensured for canonical pathnames created, and that
33 // is assumed about canonical pathname inputs (which all originate
36 // - If the length of a UEFI-style pathname *argument*, originating directly or
37 // indirectly from the EFI_FILE_PROTOCOL caller, exceeds
38 // VIRTIO_FS_MAX_PATHNAME_LENGTH, then the argument is rejected. (Length is
39 // defined as the number of CHAR16 elements in the UEFI-style pathname,
40 // excluding the terminating L'\0'.) This is a restriction that's checked on
41 // external UEFI-style pathname inputs.
43 // The limit is not expected to be a practical limitation; it's only supposed
44 // to prevent attempts at overflowing size calculations. For both kinds of
45 // pathnames, separate limits could be used; a common limit is used purely for
48 #define VIRTIO_FS_MAX_PATHNAME_LENGTH ((UINTN)65535)
51 // Maximum value for VIRTIO_FS_FILE.NumFileInfo.
53 #define VIRTIO_FS_FILE_MAX_FILE_INFO 256
56 // Filesystem label encoded in UCS-2, transformed from the UTF-8 representation
57 // in "VIRTIO_FS_CONFIG.Tag", and NUL-terminated. Only the printable ASCII code
58 // points (U+0020 through U+007E) are supported.
60 typedef CHAR16 VIRTIO_FS_LABEL
[VIRTIO_FS_TAG_BYTES
+ 1];
63 // Main context structure, expressing an EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
64 // interface on top of the Virtio Filesystem device.
68 // Parts of this structure are initialized / torn down in various functions
69 // at various call depths. The table to the right should make it easier to
72 // field init function init depth
73 // ----------- ------------------ ----------
74 UINT64 Signature
; // DriverBindingStart 0
75 VIRTIO_DEVICE_PROTOCOL
*Virtio
; // DriverBindingStart 0
76 VIRTIO_FS_LABEL Label
; // VirtioFsInit 1
77 UINT16 QueueSize
; // VirtioFsInit 1
78 VRING Ring
; // VirtioRingInit 2
79 VOID
*RingMap
; // VirtioRingMap 2
80 UINT64 RequestId
; // FuseInitSession 1
81 EFI_EVENT ExitBoot
; // DriverBindingStart 0
82 LIST_ENTRY OpenFiles
; // DriverBindingStart 0
83 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL SimpleFs
; // DriverBindingStart 0
86 #define VIRTIO_FS_FROM_SIMPLE_FS(SimpleFsReference) \
87 CR (SimpleFsReference, VIRTIO_FS, SimpleFs, VIRTIO_FS_SIG);
90 // Structure for describing a contiguous buffer, potentially mapped for Virtio
95 // The following fields originate from the owner of the buffer.
100 // All of the fields below, until the end of the structure, are
101 // zero-initialized when the structure is initially validated.
103 // Mapped, MappedAddress and Mapping are updated when the buffer is mapped
104 // for VirtioOperationBusMasterRead or VirtioOperationBusMasterWrite. They
105 // are again updated when the buffer is unmapped.
108 EFI_PHYSICAL_ADDRESS MappedAddress
;
111 // Transferred is updated after VirtioFlush() returns successfully:
112 // - for VirtioOperationBusMasterRead, Transferred is set to Size;
113 // - for VirtioOperationBusMasterWrite, Transferred is calculated from the
114 // UsedLen output parameter of VirtioFlush().
117 } VIRTIO_FS_IO_VECTOR
;
120 // Structure for describing a list of IO Vectors.
124 // The following fields originate from the owner of the buffers.
126 VIRTIO_FS_IO_VECTOR
*IoVec
;
129 // TotalSize is calculated when the scatter-gather list is initially
133 } VIRTIO_FS_SCATTER_GATHER_LIST
;
136 // Private context structure that exposes EFI_FILE_PROTOCOL on top of an open
137 // FUSE file reference.
141 EFI_FILE_PROTOCOL SimpleFile
;
143 BOOLEAN IsOpenForWriting
;
145 LIST_ENTRY OpenFilesEntry
;
146 CHAR8
*CanonicalPathname
;
149 // In the FUSE wire protocol, every request except FUSE_INIT refers to a
150 // file, namely by the "VIRTIO_FS_FUSE_REQUEST.NodeId" field; that is, by the
151 // inode number of the file. However, some of the FUSE requests that we need
152 // for some of the EFI_FILE_PROTOCOL member functions require an open file
153 // handle *in addition* to the inode number. For simplicity, whenever a
154 // VIRTIO_FS_FILE object is created, primarily defined by its NodeId field,
155 // we also *open* the referenced file at once, and save the returned file
156 // handle in the FuseHandle field. This way, when an EFI_FILE_PROTOCOL member
157 // function must send a FUSE request that needs the file handle *in addition*
158 // to the inode number, FuseHandle will be at our disposal at once.
163 // EFI_FILE_INFO objects cached for an in-flight directory read.
165 // For reading through a directory stream with tolerable performance, we have
166 // to call FUSE_READDIRPLUS each time with such a buffer that can deliver a
167 // good number of variable size records (VIRTIO_FS_FUSE_DIRENTPLUS_RESPONSE
168 // elements). Every time we do that, we turn the whole bunch into an array of
169 // EFI_FILE_INFOs immediately. EFI_FILE_PROTOCOL.Read() invocations (on
170 // directories) will be served from this EFI_FILE_INFO cache.
172 UINT8
*FileInfoArray
;
173 UINTN SingleFileInfoSize
;
178 #define VIRTIO_FS_FILE_FROM_SIMPLE_FILE(SimpleFileReference) \
179 CR (SimpleFileReference, VIRTIO_FS_FILE, SimpleFile, VIRTIO_FS_FILE_SIG);
181 #define VIRTIO_FS_FILE_FROM_OPEN_FILES_ENTRY(OpenFilesEntryReference) \
182 CR (OpenFilesEntryReference, VIRTIO_FS_FILE, OpenFilesEntry, \
186 // Initialization and helper routines for the Virtio Filesystem device.
191 IN OUT VIRTIO_FS
*VirtioFs
196 IN OUT VIRTIO_FS
*VirtioFs
202 IN EFI_EVENT ExitBootEvent
,
203 IN VOID
*VirtioFsAsVoid
207 VirtioFsSgListsValidate (
208 IN VIRTIO_FS
*VirtioFs
,
209 IN OUT VIRTIO_FS_SCATTER_GATHER_LIST
*RequestSgList
,
210 IN OUT VIRTIO_FS_SCATTER_GATHER_LIST
*ResponseSgList OPTIONAL
214 VirtioFsSgListsSubmit (
215 IN OUT VIRTIO_FS
*VirtioFs
,
216 IN OUT VIRTIO_FS_SCATTER_GATHER_LIST
*RequestSgList
,
217 IN OUT VIRTIO_FS_SCATTER_GATHER_LIST
*ResponseSgList OPTIONAL
221 VirtioFsFuseNewRequest (
222 IN OUT VIRTIO_FS
*VirtioFs
,
223 OUT VIRTIO_FS_FUSE_REQUEST
*Request
,
224 IN UINT32 RequestSize
,
225 IN VIRTIO_FS_FUSE_OPCODE Opcode
,
230 VirtioFsFuseCheckResponse (
231 IN VIRTIO_FS_SCATTER_GATHER_LIST
*ResponseSgList
,
233 OUT UINTN
*TailBufferFill
237 VirtioFsErrnoToEfiStatus (
244 IN CHAR16
*RhsPath16
,
245 OUT CHAR8
**ResultPath8
,
246 OUT BOOLEAN
*RootEscape
250 VirtioFsLookupMostSpecificParentDir (
251 IN OUT VIRTIO_FS
*VirtioFs
,
253 OUT UINT64
*DirNodeId
,
254 OUT CHAR8
**LastComponent
258 VirtioFsGetBasename (
260 OUT CHAR16
*Basename OPTIONAL
,
261 IN OUT UINTN
*BasenameSize
265 VirtioFsFuseAttrToEfiFileInfo (
266 IN VIRTIO_FS_FUSE_ATTRIBUTES_RESPONSE
*FuseAttr
,
267 OUT EFI_FILE_INFO
*FileInfo
271 VirtioFsFuseDirentPlusToEfiFileInfo (
272 IN VIRTIO_FS_FUSE_DIRENTPLUS_RESPONSE
*FuseDirent
,
273 IN OUT EFI_FILE_INFO
*FileInfo
277 // Wrapper functions for FUSE commands (primitives).
282 IN OUT VIRTIO_FS
*VirtioFs
,
286 OUT VIRTIO_FS_FUSE_ATTRIBUTES_RESPONSE
*FuseAttr
291 IN OUT VIRTIO_FS
*VirtioFs
,
296 VirtioFsFuseGetAttr (
297 IN OUT VIRTIO_FS
*VirtioFs
,
299 OUT VIRTIO_FS_FUSE_ATTRIBUTES_RESPONSE
*FuseAttr
304 IN OUT VIRTIO_FS
*VirtioFs
,
305 IN UINT64 ParentNodeId
,
311 VirtioFsFuseRemoveFileOrDir (
312 IN OUT VIRTIO_FS
*VirtioFs
,
313 IN UINT64 ParentNodeId
,
320 IN OUT VIRTIO_FS
*VirtioFs
,
322 IN BOOLEAN ReadWrite
,
323 OUT UINT64
*FuseHandle
327 VirtioFsFuseReadFileOrDir (
328 IN OUT VIRTIO_FS
*VirtioFs
,
330 IN UINT64 FuseHandle
,
339 IN OUT VIRTIO_FS
*VirtioFs
,
341 OUT VIRTIO_FS_FUSE_STATFS_RESPONSE
*FilesysAttr
345 VirtioFsFuseReleaseFileOrDir (
346 IN OUT VIRTIO_FS
*VirtioFs
,
348 IN UINT64 FuseHandle
,
353 VirtioFsFuseFsyncFileOrDir (
354 IN OUT VIRTIO_FS
*VirtioFs
,
356 IN UINT64 FuseHandle
,
362 IN OUT VIRTIO_FS
*VirtioFs
,
368 VirtioFsFuseInitSession (
369 IN OUT VIRTIO_FS
*VirtioFs
373 VirtioFsFuseOpenDir (
374 IN OUT VIRTIO_FS
*VirtioFs
,
376 OUT UINT64
*FuseHandle
380 VirtioFsFuseOpenOrCreate (
381 IN OUT VIRTIO_FS
*VirtioFs
,
382 IN UINT64 ParentNodeId
,
385 OUT UINT64
*FuseHandle
389 // EFI_SIMPLE_FILE_SYSTEM_PROTOCOL member functions for the Virtio Filesystem
396 IN EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
*This
,
397 OUT EFI_FILE_PROTOCOL
**Root
401 // EFI_FILE_PROTOCOL member functions for the Virtio Filesystem driver.
406 VirtioFsSimpleFileClose (
407 IN EFI_FILE_PROTOCOL
*This
412 VirtioFsSimpleFileDelete (
413 IN EFI_FILE_PROTOCOL
*This
418 VirtioFsSimpleFileFlush (
419 IN EFI_FILE_PROTOCOL
*This
424 VirtioFsSimpleFileGetInfo (
425 IN EFI_FILE_PROTOCOL
*This
,
426 IN EFI_GUID
*InformationType
,
427 IN OUT UINTN
*BufferSize
,
433 VirtioFsSimpleFileGetPosition (
434 IN EFI_FILE_PROTOCOL
*This
,
440 VirtioFsSimpleFileOpen (
441 IN EFI_FILE_PROTOCOL
*This
,
442 OUT EFI_FILE_PROTOCOL
**NewHandle
,
450 VirtioFsSimpleFileRead (
451 IN EFI_FILE_PROTOCOL
*This
,
452 IN OUT UINTN
*BufferSize
,
458 VirtioFsSimpleFileSetInfo (
459 IN EFI_FILE_PROTOCOL
*This
,
460 IN EFI_GUID
*InformationType
,
467 VirtioFsSimpleFileSetPosition (
468 IN EFI_FILE_PROTOCOL
*This
,
474 VirtioFsSimpleFileWrite (
475 IN EFI_FILE_PROTOCOL
*This
,
476 IN OUT UINTN
*BufferSize
,
480 #endif // VIRTIO_FS_DXE_H_