1 /* $Id: fsw_efi.c 29125 2010-05-06 09:43:05Z vboxsync $ */
3 * fsw_efi.c - EFI host environment code.
7 * Copyright (C) 2010 Oracle Corporation
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
19 * This code is based on:
21 * Copyright (c) 2006 Christoph Pfisterer
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions are
27 * * Redistributions of source code must retain the above copyright
28 * notice, this list of conditions and the following disclaimer.
30 * * Redistributions in binary form must reproduce the above copyright
31 * notice, this list of conditions and the following disclaimer in the
32 * documentation and/or other materials provided with the
35 * * Neither the name of Christoph Pfisterer nor the names of the
36 * contributors may be used to endorse or promote products derived
37 * from this software without specific prior written permission.
39 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
40 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
41 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
42 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
43 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
45 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
46 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
47 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
48 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
49 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
54 #ifdef __MAKEWITH_GNUEFI
55 #include "edk2/DriverBinding.h"
56 #include "edk2/ComponentName.h"
58 #include "../include/refit_call_wrapper.h"
63 #error FSTYPE must be defined!
69 #define DBG(x...) AsciiPrint(x)
71 #define DBG(x...) BootLog(x)
76 #ifdef __MAKEWITH_GNUEFI
78 #define EFI_DISK_IO_PROTOCOL_GUID \
80 0xce345171, 0xba0b, 0x11d2, {0x8e, 0x4f, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \
83 #define EFI_BLOCK_IO_PROTOCOL_GUID \
85 0x964e5b21, 0x6459, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \
88 EFI_GUID gEfiDriverBindingProtocolGuid
= EFI_DRIVER_BINDING_PROTOCOL_GUID
;
89 EFI_GUID gEfiComponentNameProtocolGuid
= EFI_COMPONENT_NAME_PROTOCOL_GUID
;
90 EFI_GUID gEfiDiskIoProtocolGuid
= EFI_DISK_IO_PROTOCOL_GUID
;
91 EFI_GUID gEfiBlockIoProtocolGuid
= EFI_BLOCK_IO_PROTOCOL_GUID
;
92 EFI_GUID gEfiFileInfoGuid
= EFI_FILE_INFO_ID
;
93 EFI_GUID gEfiFileSystemInfoGuid
= EFI_FILE_SYSTEM_INFO_ID
;
94 EFI_GUID gEfiFileSystemVolumeLabelInfoIdGuid
= EFI_FILE_SYSTEM_VOLUME_LABEL_INFO_ID
;
95 #define SimpleFileSystemProtocol FileSystemProtocol
98 /** Helper macro for stringification. */
99 #define FSW_EFI_STRINGIFY(x) #x
100 /** Expands to the EFI driver name given the file system type name. */
101 #define FSW_EFI_DRIVER_NAME(t) L"rEFInd 0.7.0 " FSW_EFI_STRINGIFY(t) L" File System Driver"
103 // function prototypes
105 EFI_STATUS EFIAPI
fsw_efi_DriverBinding_Supported(IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
106 IN EFI_HANDLE ControllerHandle
,
107 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
);
108 EFI_STATUS EFIAPI
fsw_efi_DriverBinding_Start(IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
109 IN EFI_HANDLE ControllerHandle
,
110 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
);
111 EFI_STATUS EFIAPI
fsw_efi_DriverBinding_Stop(IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
112 IN EFI_HANDLE ControllerHandle
,
113 IN UINTN NumberOfChildren
,
114 IN EFI_HANDLE
*ChildHandleBuffer
);
116 EFI_STATUS EFIAPI
fsw_efi_ComponentName_GetDriverName(IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
118 OUT CHAR16
**DriverName
);
119 EFI_STATUS EFIAPI
fsw_efi_ComponentName_GetControllerName(IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
120 IN EFI_HANDLE ControllerHandle
,
121 IN EFI_HANDLE ChildHandle OPTIONAL
,
123 OUT CHAR16
**ControllerName
);
125 void fsw_efi_change_blocksize(struct fsw_volume
*vol
,
126 fsw_u32 old_phys_blocksize
, fsw_u32 old_log_blocksize
,
127 fsw_u32 new_phys_blocksize
, fsw_u32 new_log_blocksize
);
128 fsw_status_t
fsw_efi_read_block(struct fsw_volume
*vol
, fsw_u64 phys_bno
, void *buffer
);
130 EFI_STATUS
fsw_efi_map_status(fsw_status_t fsw_status
, FSW_VOLUME_DATA
*Volume
);
132 EFI_STATUS EFIAPI
fsw_efi_FileSystem_OpenVolume(IN EFI_FILE_IO_INTERFACE
*This
,
133 OUT EFI_FILE
**Root
);
134 EFI_STATUS
fsw_efi_dnode_to_FileHandle(IN
struct fsw_dnode
*dno
,
135 OUT EFI_FILE
**NewFileHandle
);
137 EFI_STATUS
fsw_efi_file_read(IN FSW_FILE_DATA
*File
,
138 IN OUT UINTN
*BufferSize
,
140 EFI_STATUS
fsw_efi_file_getpos(IN FSW_FILE_DATA
*File
,
141 OUT UINT64
*Position
);
142 EFI_STATUS
fsw_efi_file_setpos(IN FSW_FILE_DATA
*File
,
145 EFI_STATUS
fsw_efi_dir_open(IN FSW_FILE_DATA
*File
,
146 OUT EFI_FILE
**NewHandle
,
149 IN UINT64 Attributes
);
150 EFI_STATUS
fsw_efi_dir_read(IN FSW_FILE_DATA
*File
,
151 IN OUT UINTN
*BufferSize
,
153 EFI_STATUS
fsw_efi_dir_setpos(IN FSW_FILE_DATA
*File
,
156 EFI_STATUS
fsw_efi_dnode_getinfo(IN FSW_FILE_DATA
*File
,
157 IN EFI_GUID
*InformationType
,
158 IN OUT UINTN
*BufferSize
,
160 EFI_STATUS
fsw_efi_dnode_fill_FileInfo(IN FSW_VOLUME_DATA
*Volume
,
161 IN
struct fsw_dnode
*dno
,
162 IN OUT UINTN
*BufferSize
,
166 * Structure for holding disk cache data.
169 #define CACHE_SIZE 131072 /* 128KiB */
174 FSW_VOLUME_DATA
*Volume
; // NOTE: Do not deallocate; copied here to ID volume
177 #define NUM_CACHES 2 /* Don't increase without modifying fsw_efi_read_block() */
178 static struct cache_data Caches
[NUM_CACHES
];
181 * Interface structure for the EFI Driver Binding protocol.
184 EFI_DRIVER_BINDING_PROTOCOL fsw_efi_DriverBinding_table
= {
185 fsw_efi_DriverBinding_Supported
,
186 fsw_efi_DriverBinding_Start
,
187 fsw_efi_DriverBinding_Stop
,
194 * Interface structure for the EFI Component Name protocol.
197 EFI_COMPONENT_NAME_PROTOCOL fsw_efi_ComponentName_table
= {
198 fsw_efi_ComponentName_GetDriverName
,
199 fsw_efi_ComponentName_GetControllerName
,
204 * Dispatch table for our FSW host driver.
207 struct fsw_host_table fsw_efi_host_table
= {
208 FSW_STRING_TYPE_UTF16
,
210 fsw_efi_change_blocksize
,
214 extern struct fsw_fstype_table
FSW_FSTYPE_TABLE_NAME(FSTYPE
);
216 //#include "OverrideFunctions-kabyl.edk2.c.include"
219 * Image entry point. Installs the Driver Binding and Component Name protocols
220 * on the image's handle. Actually mounting a file system is initiated through
221 * the Driver Binding protocol at the firmware's request.
223 EFI_STATUS EFIAPI
fsw_efi_main(IN EFI_HANDLE ImageHandle
,
224 IN EFI_SYSTEM_TABLE
*SystemTable
)
228 #ifndef HOST_EFI_EDK2
229 // Not available in EDK2 toolkit
230 InitializeLib(ImageHandle
, SystemTable
);
233 // complete Driver Binding protocol instance
234 fsw_efi_DriverBinding_table
.ImageHandle
= ImageHandle
;
235 fsw_efi_DriverBinding_table
.DriverBindingHandle
= ImageHandle
;
236 // install Driver Binding protocol
237 Status
= refit_call4_wrapper(BS
->InstallProtocolInterface
, &fsw_efi_DriverBinding_table
.DriverBindingHandle
,
238 &gEfiDriverBindingProtocolGuid
,
239 EFI_NATIVE_INTERFACE
,
240 &fsw_efi_DriverBinding_table
);
241 if (EFI_ERROR (Status
)) {
245 // install Component Name protocol
246 Status
= refit_call4_wrapper(BS
->InstallProtocolInterface
, &fsw_efi_DriverBinding_table
.DriverBindingHandle
,
247 &gEfiComponentNameProtocolGuid
,
248 EFI_NATIVE_INTERFACE
,
249 &fsw_efi_ComponentName_table
);
250 if (EFI_ERROR (Status
)) {
254 // OverrideFunctions();
257 // Status = BS->LocateProtocol(&gMsgLogProtocolGuid, NULL, (VOID **) &Msg);
258 // if (!EFI_ERROR(Status) && (Msg != NULL)) {
259 // msgCursor = Msg->Cursor;
260 // BootLog("MsgLog installed into VBoxFs\n");
266 #ifdef __MAKEWITH_GNUEFI
267 EFI_DRIVER_ENTRY_POINT(fsw_efi_main
)
271 * Driver Binding EFI protocol, Supported function. This function is called by EFI
272 * to test if this driver can handle a certain device. Our implementation only checks
273 * if the device is a disk (i.e. that it supports the Block I/O and Disk I/O protocols)
274 * and implicitly checks if the disk is already in use by another driver.
277 EFI_STATUS EFIAPI
fsw_efi_DriverBinding_Supported(IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
278 IN EFI_HANDLE ControllerHandle
,
279 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
)
284 // we check for both DiskIO and BlockIO protocols
286 // first, open DiskIO
287 Status
= refit_call6_wrapper(BS
->OpenProtocol
, ControllerHandle
,
288 &PROTO_NAME(DiskIoProtocol
),
290 This
->DriverBindingHandle
,
292 EFI_OPEN_PROTOCOL_BY_DRIVER
);
293 if (EFI_ERROR(Status
))
296 // we were just checking, close it again
297 refit_call4_wrapper(BS
->CloseProtocol
, ControllerHandle
,
298 &PROTO_NAME(DiskIoProtocol
),
299 This
->DriverBindingHandle
,
302 // next, check BlockIO without actually opening it
303 Status
= refit_call6_wrapper(BS
->OpenProtocol
, ControllerHandle
,
304 &PROTO_NAME(BlockIoProtocol
),
306 This
->DriverBindingHandle
,
308 EFI_OPEN_PROTOCOL_TEST_PROTOCOL
);
313 * Driver Binding EFI protocol, Start function. This function is called by EFI
314 * to start driving the given device. It is still possible at this point to
315 * return EFI_UNSUPPORTED, and in fact we will do so if the file system driver
316 * cannot find the superblock signature (or equivalent) that it expects.
318 * This function allocates memory for a per-volume structure, opens the
319 * required protocols (just Disk I/O in our case, Block I/O is only looked
320 * at to get the MediaId field), and lets the FSW core mount the file system.
321 * If successful, an EFI Simple File System protocol is exported on the
325 EFI_STATUS EFIAPI
fsw_efi_DriverBinding_Start(IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
326 IN EFI_HANDLE ControllerHandle
,
327 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
)
330 EFI_BLOCK_IO
*BlockIo
;
332 FSW_VOLUME_DATA
*Volume
;
335 Print(L
"fsw_efi_DriverBinding_Start\n");
338 // open consumed protocols
339 Status
= refit_call6_wrapper(BS
->OpenProtocol
, ControllerHandle
,
340 &PROTO_NAME(BlockIoProtocol
),
342 This
->DriverBindingHandle
,
344 EFI_OPEN_PROTOCOL_GET_PROTOCOL
); // NOTE: we only want to look at the MediaId
345 if (EFI_ERROR(Status
)) {
346 // Print(L"Fsw ERROR: OpenProtocol(BlockIo) returned %x\n", Status);
350 Status
= refit_call6_wrapper(BS
->OpenProtocol
, ControllerHandle
,
351 &PROTO_NAME(DiskIoProtocol
),
353 This
->DriverBindingHandle
,
355 EFI_OPEN_PROTOCOL_BY_DRIVER
);
356 if (EFI_ERROR(Status
)) {
357 Print(L
"Fsw ERROR: OpenProtocol(DiskIo) returned %r\n", Status
);
361 // allocate volume structure
362 Volume
= AllocateZeroPool(sizeof(FSW_VOLUME_DATA
));
363 Volume
->Signature
= FSW_VOLUME_DATA_SIGNATURE
;
364 Volume
->Handle
= ControllerHandle
;
365 Volume
->DiskIo
= DiskIo
;
366 Volume
->MediaId
= BlockIo
->Media
->MediaId
;
367 Volume
->LastIOStatus
= EFI_SUCCESS
;
369 // mount the filesystem
370 Status
= fsw_efi_map_status(fsw_mount(Volume
, &fsw_efi_host_table
,
371 &FSW_FSTYPE_TABLE_NAME(FSTYPE
), &Volume
->vol
),
374 if (!EFI_ERROR(Status
)) {
375 // register the SimpleFileSystem protocol
376 Volume
->FileSystem
.Revision
= EFI_FILE_IO_INTERFACE_REVISION
;
377 Volume
->FileSystem
.OpenVolume
= fsw_efi_FileSystem_OpenVolume
;
378 Status
= refit_call4_wrapper(BS
->InstallMultipleProtocolInterfaces
, &ControllerHandle
,
379 &PROTO_NAME(SimpleFileSystemProtocol
),
382 if (EFI_ERROR(Status
)) {
383 // Print(L"Fsw ERROR: InstallMultipleProtocolInterfaces returned %x\n", Status);
387 // on errors, close the opened protocols
388 if (EFI_ERROR(Status
)) {
389 if (Volume
->vol
!= NULL
)
390 fsw_unmount(Volume
->vol
);
393 refit_call4_wrapper(BS
->CloseProtocol
, ControllerHandle
,
394 &PROTO_NAME(DiskIoProtocol
),
395 This
->DriverBindingHandle
,
403 * Driver Binding EFI protocol, Stop function. This function is called by EFI
404 * to stop the driver on the given device. This translates to an unmount
405 * call for the FSW core.
407 * We assume that all file handles on the volume have been closed before
408 * the driver is stopped. At least with the EFI shell, that is actually the
409 * case; it closes all file handles between commands.
412 EFI_STATUS EFIAPI
fsw_efi_DriverBinding_Stop(IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
413 IN EFI_HANDLE ControllerHandle
,
414 IN UINTN NumberOfChildren
,
415 IN EFI_HANDLE
*ChildHandleBuffer
)
418 EFI_FILE_IO_INTERFACE
*FileSystem
;
419 FSW_VOLUME_DATA
*Volume
;
423 Print(L
"fsw_efi_DriverBinding_Stop\n");
426 // get the installed SimpleFileSystem interface
427 Status
= refit_call6_wrapper(BS
->OpenProtocol
, ControllerHandle
,
428 &PROTO_NAME(SimpleFileSystemProtocol
),
429 (VOID
**) &FileSystem
,
430 This
->DriverBindingHandle
,
432 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
433 if (EFI_ERROR(Status
))
434 return EFI_UNSUPPORTED
;
436 // get private data structure
437 Volume
= FSW_VOLUME_FROM_FILE_SYSTEM(FileSystem
);
439 // uninstall Simple File System protocol
440 Status
= refit_call4_wrapper(BS
->UninstallMultipleProtocolInterfaces
, ControllerHandle
,
441 &PROTO_NAME(SimpleFileSystemProtocol
), &Volume
->FileSystem
,
443 if (EFI_ERROR(Status
)) {
444 // Print(L"Fsw ERROR: UninstallMultipleProtocolInterfaces returned %x\n", Status);
448 Print(L
"fsw_efi_DriverBinding_Stop: protocol uninstalled successfully\n");
451 // release private data structure
452 if (Volume
->vol
!= NULL
)
453 fsw_unmount(Volume
->vol
);
456 // close the consumed protocols
457 Status
= refit_call4_wrapper(BS
->CloseProtocol
, ControllerHandle
,
458 &PROTO_NAME(DiskIoProtocol
),
459 This
->DriverBindingHandle
,
463 for (i
= 0; i
< NUM_CACHES
; i
++) {
464 if (Caches
[i
].Cache
!= NULL
) {
465 FreePool(Caches
[i
].Cache
);
466 Caches
[i
].Cache
= NULL
;
473 * Component Name EFI protocol, GetDriverName function. Used by the EFI
474 * environment to inquire the name of this driver. The name returned is
475 * based on the file system type actually used in compilation.
478 EFI_STATUS EFIAPI
fsw_efi_ComponentName_GetDriverName(IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
480 OUT CHAR16
**DriverName
)
482 if (Language
== NULL
|| DriverName
== NULL
)
483 return EFI_INVALID_PARAMETER
;
485 if (Language
[0] == 'e' && Language
[1] == 'n' && Language
[2] == 'g' && Language
[3] == 0) {
486 *DriverName
= FSW_EFI_DRIVER_NAME(FSTYPE
);
489 return EFI_UNSUPPORTED
;
493 * Component Name EFI protocol, GetControllerName function. Not implemented
494 * because this is not a "bus" driver in the sense of the EFI Driver Model.
497 EFI_STATUS EFIAPI
fsw_efi_ComponentName_GetControllerName(IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
498 IN EFI_HANDLE ControllerHandle
,
499 IN EFI_HANDLE ChildHandle OPTIONAL
,
501 OUT CHAR16
**ControllerName
)
503 return EFI_UNSUPPORTED
;
507 * FSW interface function for block size changes. This function is called by the FSW core
508 * when the file system driver changes the block sizes for the volume.
511 void fsw_efi_change_blocksize(struct fsw_volume
*vol
,
512 fsw_u32 old_phys_blocksize
, fsw_u32 old_log_blocksize
,
513 fsw_u32 new_phys_blocksize
, fsw_u32 new_log_blocksize
)
519 * FSW interface function to read data blocks. This function is called by the FSW core
520 * to read a block of data from the device. The buffer is allocated by the core code.
521 * Two caches are maintained, so as to improve performance on some systems. (VirtualBox
522 * is particularly susceptible to performance problems with an uncached driver -- the
523 * ext2 driver can take 200 seconds to load a Linux kernel under VirtualBox, whereas
524 * the time is more like 3 seconds with a cache!) Two independent caches are maintained
525 * because the ext2fs driver tends to alternate between accessing two parts of the
529 fsw_status_t
fsw_efi_read_block(struct fsw_volume
*vol
, fsw_u64 phys_bno
, void *buffer
) {
530 static int LastRead
= -1;
531 int i
, ReadCache
= -1;
532 FSW_VOLUME_DATA
*Volume
= (FSW_VOLUME_DATA
*)vol
->host_data
;
533 EFI_STATUS Status
= EFI_SUCCESS
;
534 BOOLEAN ReadOneBlock
= FALSE
;
535 fsw_u64 StartRead
= phys_bno
* vol
->phys_blocksize
;
538 return (fsw_status_t
) EFI_BAD_BUFFER_SIZE
;
540 // Initialize static data structures, if necessary....
542 for (i
= 0; i
< NUM_CACHES
; i
++) {
543 Caches
[i
].Cache
= NULL
;
544 Caches
[i
].CacheStart
= 0;
545 Caches
[i
].CacheValid
= FALSE
;
546 Caches
[i
].Volume
= NULL
;
550 // Look for a cache hit on the current query....
553 if ((Caches
[i
].Volume
== Volume
) &&
554 (StartRead
>= Caches
[i
].CacheStart
) &&
555 ((StartRead
+ vol
->phys_blocksize
) <= (Caches
[i
].CacheStart
+ CACHE_SIZE
))) {
559 } while ((i
< NUM_CACHES
) && (ReadCache
< 0));
561 // No cache hit found; load new cache and pass it on....
565 ReadCache
= 1 - LastRead
; // NOTE: If NUM_CACHES > 2, this must become more complex
566 if (Caches
[ReadCache
].Cache
== NULL
)
567 Caches
[ReadCache
].Cache
= AllocatePool(CACHE_SIZE
);
568 if (Caches
[ReadCache
].Cache
!= NULL
) {
569 Status
= refit_call5_wrapper(Volume
->DiskIo
->ReadDisk
, Volume
->DiskIo
, Volume
->MediaId
,
570 StartRead
, CACHE_SIZE
, Caches
[ReadCache
].Cache
);
571 if (!EFI_ERROR(Status
)) {
572 Caches
[ReadCache
].CacheStart
= StartRead
;
573 Caches
[ReadCache
].CacheValid
= TRUE
;
574 Caches
[ReadCache
].Volume
= Volume
;
575 LastRead
= ReadCache
;
581 } // if cache memory allocated
582 } // if (ReadCache < 0)
584 if (Caches
[ReadCache
].Cache
!= NULL
) {
585 CopyMem(buffer
, &Caches
[ReadCache
].Cache
[StartRead
- Caches
[ReadCache
].CacheStart
], vol
->phys_blocksize
);
590 if (ReadOneBlock
) { // Something's failed, so try a simple disk read of one block....
591 Status
= refit_call5_wrapper(Volume
->DiskIo
->ReadDisk
, Volume
->DiskIo
, Volume
->MediaId
,
592 phys_bno
* vol
->phys_blocksize
,
598 } // fsw_status_t *fsw_efi_read_block()
601 * Map FSW status codes to EFI status codes. The FSW_IO_ERROR code is only produced
602 * by fsw_efi_read_block, so we map it back to the EFI status code remembered from
603 * the last I/O operation.
606 EFI_STATUS
fsw_efi_map_status(fsw_status_t fsw_status
, FSW_VOLUME_DATA
*Volume
)
608 switch (fsw_status
) {
611 case FSW_OUT_OF_MEMORY
:
612 return EFI_VOLUME_CORRUPTED
;
614 return Volume
->LastIOStatus
;
615 case FSW_UNSUPPORTED
:
616 return EFI_UNSUPPORTED
;
618 return EFI_NOT_FOUND
;
619 case FSW_VOLUME_CORRUPTED
:
620 return EFI_VOLUME_CORRUPTED
;
622 return EFI_DEVICE_ERROR
;
627 * File System EFI protocol, OpenVolume function. Creates a file handle for
628 * the root directory and returns it. Note that this function may be called
629 * multiple times and returns a new file handle each time. Each returned
630 * handle is closed by the client using it.
633 EFI_STATUS EFIAPI
fsw_efi_FileSystem_OpenVolume(IN EFI_FILE_IO_INTERFACE
*This
,
637 FSW_VOLUME_DATA
*Volume
= FSW_VOLUME_FROM_FILE_SYSTEM(This
);
640 Print(L
"fsw_efi_FileSystem_OpenVolume\n");
643 Status
= fsw_efi_dnode_to_FileHandle(Volume
->vol
->root
, Root
);
649 * File Handle EFI protocol, Open function. Dispatches the call
650 * based on the kind of file handle.
653 EFI_STATUS EFIAPI
fsw_efi_FileHandle_Open(IN EFI_FILE
*This
,
654 OUT EFI_FILE
**NewHandle
,
657 IN UINT64 Attributes
)
659 FSW_FILE_DATA
*File
= FSW_FILE_FROM_FILE_HANDLE(This
);
661 if (File
->Type
== FSW_EFI_FILE_TYPE_DIR
)
662 return fsw_efi_dir_open(File
, NewHandle
, FileName
, OpenMode
, Attributes
);
663 // not supported for regular files
664 return EFI_UNSUPPORTED
;
668 * File Handle EFI protocol, Close function. Closes the FSW shandle
669 * and frees the memory used for the structure.
672 EFI_STATUS EFIAPI
fsw_efi_FileHandle_Close(IN EFI_FILE
*This
)
674 FSW_FILE_DATA
*File
= FSW_FILE_FROM_FILE_HANDLE(This
);
677 Print(L
"fsw_efi_FileHandle_Close\n");
680 fsw_shandle_close(&File
->shand
);
687 * File Handle EFI protocol, Delete function. Calls through to Close
688 * and returns a warning because this driver is read-only.
691 EFI_STATUS EFIAPI
fsw_efi_FileHandle_Delete(IN EFI_FILE
*This
)
695 Status
= refit_call1_wrapper(This
->Close
, This
);
696 if (Status
== EFI_SUCCESS
) {
697 // this driver is read-only
698 Status
= EFI_WARN_DELETE_FAILURE
;
705 * File Handle EFI protocol, Read function. Dispatches the call
706 * based on the kind of file handle.
709 EFI_STATUS EFIAPI
fsw_efi_FileHandle_Read(IN EFI_FILE
*This
,
710 IN OUT UINTN
*BufferSize
,
713 FSW_FILE_DATA
*File
= FSW_FILE_FROM_FILE_HANDLE(This
);
715 if (File
->Type
== FSW_EFI_FILE_TYPE_FILE
)
716 return fsw_efi_file_read(File
, BufferSize
, Buffer
);
717 else if (File
->Type
== FSW_EFI_FILE_TYPE_DIR
)
718 return fsw_efi_dir_read(File
, BufferSize
, Buffer
);
719 return EFI_UNSUPPORTED
;
723 * File Handle EFI protocol, Write function. Returns unsupported status
724 * because this driver is read-only.
727 EFI_STATUS EFIAPI
fsw_efi_FileHandle_Write(IN EFI_FILE
*This
,
728 IN OUT UINTN
*BufferSize
,
731 // this driver is read-only
732 return EFI_WRITE_PROTECTED
;
736 * File Handle EFI protocol, GetPosition function. Dispatches the call
737 * based on the kind of file handle.
740 EFI_STATUS EFIAPI
fsw_efi_FileHandle_GetPosition(IN EFI_FILE
*This
,
741 OUT UINT64
*Position
)
743 FSW_FILE_DATA
*File
= FSW_FILE_FROM_FILE_HANDLE(This
);
745 if (File
->Type
== FSW_EFI_FILE_TYPE_FILE
)
746 return fsw_efi_file_getpos(File
, Position
);
747 // not defined for directories
748 return EFI_UNSUPPORTED
;
752 * File Handle EFI protocol, SetPosition function. Dispatches the call
753 * based on the kind of file handle.
756 EFI_STATUS EFIAPI
fsw_efi_FileHandle_SetPosition(IN EFI_FILE
*This
,
759 FSW_FILE_DATA
*File
= FSW_FILE_FROM_FILE_HANDLE(This
);
761 if (File
->Type
== FSW_EFI_FILE_TYPE_FILE
)
762 return fsw_efi_file_setpos(File
, Position
);
763 else if (File
->Type
== FSW_EFI_FILE_TYPE_DIR
)
764 return fsw_efi_dir_setpos(File
, Position
);
765 return EFI_UNSUPPORTED
;
769 * File Handle EFI protocol, GetInfo function. Dispatches to the common
770 * function implementing this.
773 EFI_STATUS EFIAPI
fsw_efi_FileHandle_GetInfo(IN EFI_FILE
*This
,
774 IN EFI_GUID
*InformationType
,
775 IN OUT UINTN
*BufferSize
,
778 FSW_FILE_DATA
*File
= FSW_FILE_FROM_FILE_HANDLE(This
);
780 return fsw_efi_dnode_getinfo(File
, InformationType
, BufferSize
, Buffer
);
784 * File Handle EFI protocol, SetInfo function. Returns unsupported status
785 * because this driver is read-only.
788 EFI_STATUS EFIAPI
fsw_efi_FileHandle_SetInfo(IN EFI_FILE
*This
,
789 IN EFI_GUID
*InformationType
,
793 // this driver is read-only
794 return EFI_WRITE_PROTECTED
;
798 * File Handle EFI protocol, Flush function. Returns unsupported status
799 * because this driver is read-only.
802 EFI_STATUS EFIAPI
fsw_efi_FileHandle_Flush(IN EFI_FILE
*This
)
804 // this driver is read-only
805 return EFI_WRITE_PROTECTED
;
809 * Set up a file handle for a dnode. This function allocates a data structure
810 * for a file handle, opens a FSW shandle and populates the EFI_FILE structure
811 * with the interface functions.
814 EFI_STATUS
fsw_efi_dnode_to_FileHandle(IN
struct fsw_dnode
*dno
,
815 OUT EFI_FILE
**NewFileHandle
)
820 // make sure the dnode has complete info
821 Status
= fsw_efi_map_status(fsw_dnode_fill(dno
), (FSW_VOLUME_DATA
*)dno
->vol
->host_data
);
822 if (EFI_ERROR(Status
))
826 if (dno
->type
!= FSW_DNODE_TYPE_FILE
&& dno
->type
!= FSW_DNODE_TYPE_DIR
)
827 return EFI_UNSUPPORTED
;
829 // allocate file structure
830 File
= AllocateZeroPool(sizeof(FSW_FILE_DATA
));
831 File
->Signature
= FSW_FILE_DATA_SIGNATURE
;
832 if (dno
->type
== FSW_DNODE_TYPE_FILE
)
833 File
->Type
= FSW_EFI_FILE_TYPE_FILE
;
834 else if (dno
->type
== FSW_DNODE_TYPE_DIR
)
835 File
->Type
= FSW_EFI_FILE_TYPE_DIR
;
838 Status
= fsw_efi_map_status(fsw_shandle_open(dno
, &File
->shand
),
839 (FSW_VOLUME_DATA
*)dno
->vol
->host_data
);
840 if (EFI_ERROR(Status
)) {
845 // populate the file handle
846 File
->FileHandle
.Revision
= EFI_FILE_HANDLE_REVISION
;
847 File
->FileHandle
.Open
= fsw_efi_FileHandle_Open
;
848 File
->FileHandle
.Close
= fsw_efi_FileHandle_Close
;
849 File
->FileHandle
.Delete
= fsw_efi_FileHandle_Delete
;
850 File
->FileHandle
.Read
= fsw_efi_FileHandle_Read
;
851 File
->FileHandle
.Write
= fsw_efi_FileHandle_Write
;
852 File
->FileHandle
.GetPosition
= fsw_efi_FileHandle_GetPosition
;
853 File
->FileHandle
.SetPosition
= fsw_efi_FileHandle_SetPosition
;
854 File
->FileHandle
.GetInfo
= fsw_efi_FileHandle_GetInfo
;
855 File
->FileHandle
.SetInfo
= fsw_efi_FileHandle_SetInfo
;
856 File
->FileHandle
.Flush
= fsw_efi_FileHandle_Flush
;
858 *NewFileHandle
= &File
->FileHandle
;
863 * Data read function for regular files. Calls through to fsw_shandle_read.
866 EFI_STATUS
fsw_efi_file_read(IN FSW_FILE_DATA
*File
,
867 IN OUT UINTN
*BufferSize
,
874 Print(L
"fsw_efi_file_read %d bytes\n", *BufferSize
);
877 buffer_size
= (fsw_u32
)*BufferSize
;
878 Status
= fsw_efi_map_status(fsw_shandle_read(&File
->shand
, &buffer_size
, Buffer
),
879 (FSW_VOLUME_DATA
*)File
->shand
.dnode
->vol
->host_data
);
880 *BufferSize
= buffer_size
;
886 * Get file position for regular files.
889 EFI_STATUS
fsw_efi_file_getpos(IN FSW_FILE_DATA
*File
,
890 OUT UINT64
*Position
)
892 *Position
= File
->shand
.pos
;
897 * Set file position for regular files. EFI specifies the all-ones value
898 * to be a special value for the end of the file.
901 EFI_STATUS
fsw_efi_file_setpos(IN FSW_FILE_DATA
*File
, IN UINT64 Position
)
903 if (Position
== 0xFFFFFFFFFFFFFFFFULL
)
904 File
->shand
.pos
= File
->shand
.dnode
->size
;
906 File
->shand
.pos
= Position
;
911 * Open function used to open new file handles relative to a directory.
912 * In EFI, the "open file" function is implemented by directory file handles
913 * and is passed a relative or volume-absolute path to the file or directory
914 * to open. We use fsw_dnode_lookup_path to find the node plus an additional
915 * call to fsw_dnode_resolve because EFI has no concept of symbolic links.
918 EFI_STATUS
fsw_efi_dir_open(IN FSW_FILE_DATA
*File
,
919 OUT EFI_FILE
**NewHandle
,
922 IN UINT64 Attributes
)
925 FSW_VOLUME_DATA
*Volume
= (FSW_VOLUME_DATA
*)File
->shand
.dnode
->vol
->host_data
;
926 struct fsw_dnode
*dno
;
927 struct fsw_dnode
*target_dno
;
928 struct fsw_string lookup_path
;
931 Print(L
"fsw_efi_dir_open: '%s'\n", FileName
);
934 if (OpenMode
!= EFI_FILE_MODE_READ
)
935 return EFI_WRITE_PROTECTED
;
937 lookup_path
.type
= FSW_STRING_TYPE_UTF16
;
938 lookup_path
.len
= (int)StrLen(FileName
);
939 lookup_path
.size
= lookup_path
.len
* sizeof(fsw_u16
);
940 lookup_path
.data
= FileName
;
942 // resolve the path (symlinks along the way are automatically resolved)
943 Status
= fsw_efi_map_status(fsw_dnode_lookup_path(File
->shand
.dnode
, &lookup_path
, '\\', &dno
), Volume
);
944 if (EFI_ERROR(Status
))
947 // if the final node is a symlink, also resolve it
948 Status
= fsw_efi_map_status(fsw_dnode_resolve(dno
, &target_dno
), Volume
);
949 fsw_dnode_release(dno
);
950 if (EFI_ERROR(Status
))
954 // make a new EFI handle for the target dnode
955 Status
= fsw_efi_dnode_to_FileHandle(dno
, NewHandle
);
956 fsw_dnode_release(dno
);
961 * Read function for directories. A file handle read on a directory retrieves
962 * the next directory entry.
965 EFI_STATUS
fsw_efi_dir_read(IN FSW_FILE_DATA
*File
,
966 IN OUT UINTN
*BufferSize
,
970 FSW_VOLUME_DATA
*Volume
= (FSW_VOLUME_DATA
*)File
->shand
.dnode
->vol
->host_data
;
971 struct fsw_dnode
*dno
;
974 Print(L
"fsw_efi_dir_read...\n");
977 // read the next entry
978 Status
= fsw_efi_map_status(fsw_dnode_dir_read(&File
->shand
, &dno
), Volume
);
979 if (Status
== EFI_NOT_FOUND
) {
983 Print(L
"...no more entries\n");
987 if (EFI_ERROR(Status
))
990 // get info into buffer
991 Status
= fsw_efi_dnode_fill_FileInfo(Volume
, dno
, BufferSize
, Buffer
);
992 fsw_dnode_release(dno
);
997 * Set file position for directories. The only allowed set position operation
998 * for directories is to rewind the directory completely by setting the
1002 EFI_STATUS
fsw_efi_dir_setpos(IN FSW_FILE_DATA
*File
, IN UINT64 Position
)
1004 if (Position
== 0) {
1005 File
->shand
.pos
= 0;
1008 // directories can only rewind to the start
1009 return EFI_UNSUPPORTED
;
1014 * Get file or volume information. This function implements the GetInfo call
1015 * for all file handles. Control is dispatched according to the type of information
1016 * requested by the caller.
1019 EFI_STATUS
fsw_efi_dnode_getinfo(IN FSW_FILE_DATA
*File
,
1020 IN EFI_GUID
*InformationType
,
1021 IN OUT UINTN
*BufferSize
,
1025 FSW_VOLUME_DATA
*Volume
= (FSW_VOLUME_DATA
*)File
->shand
.dnode
->vol
->host_data
;
1026 EFI_FILE_SYSTEM_INFO
*FSInfo
;
1028 struct fsw_volume_stat vsb
;
1031 if (CompareGuid(InformationType
, &gEfiFileInfoGuid
)) {
1033 Print(L
"fsw_efi_dnode_getinfo: FILE_INFO\n");
1036 Status
= fsw_efi_dnode_fill_FileInfo(Volume
, File
->shand
.dnode
, BufferSize
, Buffer
);
1038 } else if (CompareGuid(InformationType
, &gEfiFileSystemInfoGuid
)) {
1040 Print(L
"fsw_efi_dnode_getinfo: FILE_SYSTEM_INFO\n");
1043 // check buffer size
1044 RequiredSize
= SIZE_OF_EFI_FILE_SYSTEM_INFO
+ fsw_efi_strsize(&Volume
->vol
->label
);
1045 if (*BufferSize
< RequiredSize
) {
1046 *BufferSize
= RequiredSize
;
1047 return EFI_BUFFER_TOO_SMALL
;
1051 FSInfo
= (EFI_FILE_SYSTEM_INFO
*)Buffer
;
1052 FSInfo
->Size
= RequiredSize
;
1053 FSInfo
->ReadOnly
= TRUE
;
1054 FSInfo
->BlockSize
= Volume
->vol
->log_blocksize
;
1055 fsw_efi_strcpy(FSInfo
->VolumeLabel
, &Volume
->vol
->label
);
1057 // get the missing info from the fs driver
1058 ZeroMem(&vsb
, sizeof(struct fsw_volume_stat
));
1059 Status
= fsw_efi_map_status(fsw_volume_stat(Volume
->vol
, &vsb
), Volume
);
1060 if (EFI_ERROR(Status
))
1062 FSInfo
->VolumeSize
= vsb
.total_bytes
;
1063 FSInfo
->FreeSpace
= vsb
.free_bytes
;
1065 // prepare for return
1066 *BufferSize
= RequiredSize
;
1067 Status
= EFI_SUCCESS
;
1069 } else if (CompareGuid(InformationType
, &gEfiFileSystemVolumeLabelInfoIdGuid
)) {
1071 Print(L
"fsw_efi_dnode_getinfo: FILE_SYSTEM_VOLUME_LABEL\n");
1074 // check buffer size
1075 RequiredSize
= SIZE_OF_EFI_FILE_SYSTEM_VOLUME_LABEL_INFO
+ fsw_efi_strsize(&Volume
->vol
->label
);
1076 if (*BufferSize
< RequiredSize
) {
1077 *BufferSize
= RequiredSize
;
1078 return EFI_BUFFER_TOO_SMALL
;
1081 // copy volume label
1082 fsw_efi_strcpy(((EFI_FILE_SYSTEM_VOLUME_LABEL_INFO
*)Buffer
)->VolumeLabel
, &Volume
->vol
->label
);
1084 // prepare for return
1085 *BufferSize
= RequiredSize
;
1086 Status
= EFI_SUCCESS
;
1089 Status
= EFI_UNSUPPORTED
;
1096 * Time mapping callback for the fsw_dnode_stat call. This function converts
1097 * a Posix style timestamp into an EFI_TIME structure and writes it to the
1098 * appropriate member of the EFI_FILE_INFO structure that we're filling.
1101 static void fsw_efi_store_time_posix(struct fsw_dnode_stat
*sb
, int which
, fsw_u32 posix_time
)
1103 EFI_FILE_INFO
*FileInfo
= (EFI_FILE_INFO
*)sb
->host_data
;
1105 if (which
== FSW_DNODE_STAT_CTIME
)
1106 fsw_efi_decode_time(&FileInfo
->CreateTime
, posix_time
);
1107 else if (which
== FSW_DNODE_STAT_MTIME
)
1108 fsw_efi_decode_time(&FileInfo
->ModificationTime
, posix_time
);
1109 else if (which
== FSW_DNODE_STAT_ATIME
)
1110 fsw_efi_decode_time(&FileInfo
->LastAccessTime
, posix_time
);
1114 * Mode mapping callback for the fsw_dnode_stat call. This function looks at
1115 * the Posix mode passed by the file system driver and makes appropriate
1116 * adjustments to the EFI_FILE_INFO structure that we're filling.
1119 static void fsw_efi_store_attr_posix(struct fsw_dnode_stat
*sb
, fsw_u16 posix_mode
)
1121 EFI_FILE_INFO
*FileInfo
= (EFI_FILE_INFO
*)sb
->host_data
;
1123 if ((posix_mode
& S_IWUSR
) == 0)
1124 FileInfo
->Attribute
|= EFI_FILE_READ_ONLY
;
1128 * Common function to fill an EFI_FILE_INFO with information about a dnode.
1131 EFI_STATUS
fsw_efi_dnode_fill_FileInfo(IN FSW_VOLUME_DATA
*Volume
,
1132 IN
struct fsw_dnode
*dno
,
1133 IN OUT UINTN
*BufferSize
,
1137 EFI_FILE_INFO
*FileInfo
;
1139 struct fsw_dnode_stat sb
;
1141 // make sure the dnode has complete info
1142 Status
= fsw_efi_map_status(fsw_dnode_fill(dno
), Volume
);
1143 if (EFI_ERROR(Status
))
1146 // TODO: check/assert that the dno's name is in UTF16
1148 // check buffer size
1149 RequiredSize
= SIZE_OF_EFI_FILE_INFO
+ fsw_efi_strsize(&dno
->name
);
1150 if (*BufferSize
< RequiredSize
) {
1151 // TODO: wind back the directory in this case
1154 Print(L
"...BUFFER TOO SMALL\n");
1156 *BufferSize
= RequiredSize
;
1157 return EFI_BUFFER_TOO_SMALL
;
1161 ZeroMem(Buffer
, RequiredSize
);
1162 FileInfo
= (EFI_FILE_INFO
*)Buffer
;
1163 FileInfo
->Size
= RequiredSize
;
1164 FileInfo
->FileSize
= dno
->size
;
1165 FileInfo
->Attribute
= 0;
1166 if (dno
->type
== FSW_DNODE_TYPE_DIR
)
1167 FileInfo
->Attribute
|= EFI_FILE_DIRECTORY
;
1168 fsw_efi_strcpy(FileInfo
->FileName
, &dno
->name
);
1170 // get the missing info from the fs driver
1171 ZeroMem(&sb
, sizeof(struct fsw_dnode_stat
));
1172 sb
.store_time_posix
= fsw_efi_store_time_posix
;
1173 sb
.store_attr_posix
= fsw_efi_store_attr_posix
;
1174 sb
.host_data
= FileInfo
;
1175 Status
= fsw_efi_map_status(fsw_dnode_stat(dno
, &sb
), Volume
);
1176 if (EFI_ERROR(Status
))
1178 FileInfo
->PhysicalSize
= sb
.used_bytes
;
1180 // prepare for return
1181 *BufferSize
= RequiredSize
;
1183 Print(L
"...returning '%s'\n", FileInfo
->FileName
);