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.4 " 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
];
179 static int LastRead
= -1;
182 * Interface structure for the EFI Driver Binding protocol.
185 EFI_DRIVER_BINDING_PROTOCOL fsw_efi_DriverBinding_table
= {
186 fsw_efi_DriverBinding_Supported
,
187 fsw_efi_DriverBinding_Start
,
188 fsw_efi_DriverBinding_Stop
,
195 * Interface structure for the EFI Component Name protocol.
198 EFI_COMPONENT_NAME_PROTOCOL fsw_efi_ComponentName_table
= {
199 fsw_efi_ComponentName_GetDriverName
,
200 fsw_efi_ComponentName_GetControllerName
,
205 * Dispatch table for our FSW host driver.
208 struct fsw_host_table fsw_efi_host_table
= {
209 FSW_STRING_TYPE_UTF16
,
211 fsw_efi_change_blocksize
,
215 extern struct fsw_fstype_table
FSW_FSTYPE_TABLE_NAME(FSTYPE
);
217 //#include "OverrideFunctions-kabyl.edk2.c.include"
219 static VOID EFIAPI
fsw_efi_clear_cache(VOID
) {
223 for (i
= 0; i
< NUM_CACHES
; i
++) {
224 if (Caches
[i
].Cache
!= NULL
) {
225 FreePool(Caches
[i
].Cache
);
226 Caches
[i
].Cache
= NULL
;
228 Caches
[i
].CacheStart
= 0;
229 Caches
[i
].CacheValid
= FALSE
;
230 Caches
[i
].Volume
= NULL
;
233 } // VOID EFIAPI fsw_efi_clear_cache();
236 * Image entry point. Installs the Driver Binding and Component Name protocols
237 * on the image's handle. Actually mounting a file system is initiated through
238 * the Driver Binding protocol at the firmware's request.
240 EFI_STATUS EFIAPI
fsw_efi_main(IN EFI_HANDLE ImageHandle
,
241 IN EFI_SYSTEM_TABLE
*SystemTable
)
245 #ifndef HOST_EFI_EDK2
246 // Not available in EDK2 toolkit
247 InitializeLib(ImageHandle
, SystemTable
);
250 // complete Driver Binding protocol instance
251 fsw_efi_DriverBinding_table
.ImageHandle
= ImageHandle
;
252 fsw_efi_DriverBinding_table
.DriverBindingHandle
= ImageHandle
;
253 // install Driver Binding protocol
254 Status
= refit_call4_wrapper(BS
->InstallProtocolInterface
, &fsw_efi_DriverBinding_table
.DriverBindingHandle
,
255 &gEfiDriverBindingProtocolGuid
,
256 EFI_NATIVE_INTERFACE
,
257 &fsw_efi_DriverBinding_table
);
258 if (EFI_ERROR (Status
)) {
262 // install Component Name protocol
263 Status
= refit_call4_wrapper(BS
->InstallProtocolInterface
, &fsw_efi_DriverBinding_table
.DriverBindingHandle
,
264 &gEfiComponentNameProtocolGuid
,
265 EFI_NATIVE_INTERFACE
,
266 &fsw_efi_ComponentName_table
);
267 if (EFI_ERROR (Status
)) {
271 // OverrideFunctions();
274 // Status = BS->LocateProtocol(&gMsgLogProtocolGuid, NULL, (VOID **) &Msg);
275 // if (!EFI_ERROR(Status) && (Msg != NULL)) {
276 // msgCursor = Msg->Cursor;
277 // BootLog("MsgLog installed into VBoxFs\n");
283 #ifdef __MAKEWITH_GNUEFI
284 EFI_DRIVER_ENTRY_POINT(fsw_efi_main
)
288 * Driver Binding EFI protocol, Supported function. This function is called by EFI
289 * to test if this driver can handle a certain device. Our implementation only checks
290 * if the device is a disk (i.e. that it supports the Block I/O and Disk I/O protocols)
291 * and implicitly checks if the disk is already in use by another driver.
294 EFI_STATUS EFIAPI
fsw_efi_DriverBinding_Supported(IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
295 IN EFI_HANDLE ControllerHandle
,
296 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
)
301 // we check for both DiskIO and BlockIO protocols
303 // first, open DiskIO
304 Status
= refit_call6_wrapper(BS
->OpenProtocol
, ControllerHandle
,
305 &PROTO_NAME(DiskIoProtocol
),
307 This
->DriverBindingHandle
,
309 EFI_OPEN_PROTOCOL_BY_DRIVER
);
310 if (EFI_ERROR(Status
))
313 // we were just checking, close it again
314 refit_call4_wrapper(BS
->CloseProtocol
, ControllerHandle
,
315 &PROTO_NAME(DiskIoProtocol
),
316 This
->DriverBindingHandle
,
319 // next, check BlockIO without actually opening it
320 Status
= refit_call6_wrapper(BS
->OpenProtocol
, ControllerHandle
,
321 &PROTO_NAME(BlockIoProtocol
),
323 This
->DriverBindingHandle
,
325 EFI_OPEN_PROTOCOL_TEST_PROTOCOL
);
330 * Driver Binding EFI protocol, Start function. This function is called by EFI
331 * to start driving the given device. It is still possible at this point to
332 * return EFI_UNSUPPORTED, and in fact we will do so if the file system driver
333 * cannot find the superblock signature (or equivalent) that it expects.
335 * This function allocates memory for a per-volume structure, opens the
336 * required protocols (just Disk I/O in our case, Block I/O is only looked
337 * at to get the MediaId field), and lets the FSW core mount the file system.
338 * If successful, an EFI Simple File System protocol is exported on the
342 EFI_STATUS EFIAPI
fsw_efi_DriverBinding_Start(IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
343 IN EFI_HANDLE ControllerHandle
,
344 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
)
347 EFI_BLOCK_IO
*BlockIo
;
349 FSW_VOLUME_DATA
*Volume
;
352 Print(L
"fsw_efi_DriverBinding_Start\n");
355 // open consumed protocols
356 Status
= refit_call6_wrapper(BS
->OpenProtocol
, ControllerHandle
,
357 &PROTO_NAME(BlockIoProtocol
),
359 This
->DriverBindingHandle
,
361 EFI_OPEN_PROTOCOL_GET_PROTOCOL
); // NOTE: we only want to look at the MediaId
362 if (EFI_ERROR(Status
)) {
363 // Print(L"Fsw ERROR: OpenProtocol(BlockIo) returned %x\n", Status);
367 Status
= refit_call6_wrapper(BS
->OpenProtocol
, ControllerHandle
,
368 &PROTO_NAME(DiskIoProtocol
),
370 This
->DriverBindingHandle
,
372 EFI_OPEN_PROTOCOL_BY_DRIVER
);
373 if (EFI_ERROR(Status
)) {
377 // allocate volume structure
378 Volume
= AllocateZeroPool(sizeof(FSW_VOLUME_DATA
));
379 Volume
->Signature
= FSW_VOLUME_DATA_SIGNATURE
;
380 Volume
->Handle
= ControllerHandle
;
381 Volume
->DiskIo
= DiskIo
;
382 Volume
->MediaId
= BlockIo
->Media
->MediaId
;
383 Volume
->LastIOStatus
= EFI_SUCCESS
;
385 // mount the filesystem
386 Status
= fsw_efi_map_status(fsw_mount(Volume
, &fsw_efi_host_table
,
387 &FSW_FSTYPE_TABLE_NAME(FSTYPE
), &Volume
->vol
),
390 if (!EFI_ERROR(Status
)) {
391 // register the SimpleFileSystem protocol
392 Volume
->FileSystem
.Revision
= EFI_FILE_IO_INTERFACE_REVISION
;
393 Volume
->FileSystem
.OpenVolume
= fsw_efi_FileSystem_OpenVolume
;
394 Status
= refit_call4_wrapper(BS
->InstallMultipleProtocolInterfaces
, &ControllerHandle
,
395 &PROTO_NAME(SimpleFileSystemProtocol
),
398 if (EFI_ERROR(Status
)) {
399 // Print(L"Fsw ERROR: InstallMultipleProtocolInterfaces returned %x\n", Status);
403 // on errors, close the opened protocols
404 if (EFI_ERROR(Status
)) {
405 if (Volume
->vol
!= NULL
)
406 fsw_unmount(Volume
->vol
);
409 refit_call4_wrapper(BS
->CloseProtocol
, ControllerHandle
,
410 &PROTO_NAME(DiskIoProtocol
),
411 This
->DriverBindingHandle
,
419 * Driver Binding EFI protocol, Stop function. This function is called by EFI
420 * to stop the driver on the given device. This translates to an unmount
421 * call for the FSW core.
423 * We assume that all file handles on the volume have been closed before
424 * the driver is stopped. At least with the EFI shell, that is actually the
425 * case; it closes all file handles between commands.
428 EFI_STATUS EFIAPI
fsw_efi_DriverBinding_Stop(IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
429 IN EFI_HANDLE ControllerHandle
,
430 IN UINTN NumberOfChildren
,
431 IN EFI_HANDLE
*ChildHandleBuffer
)
434 EFI_FILE_IO_INTERFACE
*FileSystem
;
435 FSW_VOLUME_DATA
*Volume
;
438 Print(L
"fsw_efi_DriverBinding_Stop\n");
441 // get the installed SimpleFileSystem interface
442 Status
= refit_call6_wrapper(BS
->OpenProtocol
, ControllerHandle
,
443 &PROTO_NAME(SimpleFileSystemProtocol
),
444 (VOID
**) &FileSystem
,
445 This
->DriverBindingHandle
,
447 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
448 if (EFI_ERROR(Status
))
449 return EFI_UNSUPPORTED
;
451 // get private data structure
452 Volume
= FSW_VOLUME_FROM_FILE_SYSTEM(FileSystem
);
454 // uninstall Simple File System protocol
455 Status
= refit_call4_wrapper(BS
->UninstallMultipleProtocolInterfaces
, ControllerHandle
,
456 &PROTO_NAME(SimpleFileSystemProtocol
), &Volume
->FileSystem
,
458 if (EFI_ERROR(Status
)) {
459 // Print(L"Fsw ERROR: UninstallMultipleProtocolInterfaces returned %x\n", Status);
463 Print(L
"fsw_efi_DriverBinding_Stop: protocol uninstalled successfully\n");
466 // release private data structure
467 if (Volume
->vol
!= NULL
)
468 fsw_unmount(Volume
->vol
);
471 // close the consumed protocols
472 Status
= refit_call4_wrapper(BS
->CloseProtocol
, ControllerHandle
,
473 &PROTO_NAME(DiskIoProtocol
),
474 This
->DriverBindingHandle
,
478 fsw_efi_clear_cache();
484 * Component Name EFI protocol, GetDriverName function. Used by the EFI
485 * environment to inquire the name of this driver. The name returned is
486 * based on the file system type actually used in compilation.
489 EFI_STATUS EFIAPI
fsw_efi_ComponentName_GetDriverName(IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
491 OUT CHAR16
**DriverName
)
493 if (Language
== NULL
|| DriverName
== NULL
)
494 return EFI_INVALID_PARAMETER
;
496 if (Language
[0] == 'e' && Language
[1] == 'n' && Language
[2] == 'g' && Language
[3] == 0) {
497 *DriverName
= FSW_EFI_DRIVER_NAME(FSTYPE
);
500 return EFI_UNSUPPORTED
;
504 * Component Name EFI protocol, GetControllerName function. Not implemented
505 * because this is not a "bus" driver in the sense of the EFI Driver Model.
508 EFI_STATUS EFIAPI
fsw_efi_ComponentName_GetControllerName(IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
509 IN EFI_HANDLE ControllerHandle
,
510 IN EFI_HANDLE ChildHandle OPTIONAL
,
512 OUT CHAR16
**ControllerName
)
514 return EFI_UNSUPPORTED
;
518 * FSW interface function for block size changes. This function is called by the FSW core
519 * when the file system driver changes the block sizes for the volume.
522 void fsw_efi_change_blocksize(struct fsw_volume
*vol
,
523 fsw_u32 old_phys_blocksize
, fsw_u32 old_log_blocksize
,
524 fsw_u32 new_phys_blocksize
, fsw_u32 new_log_blocksize
)
530 * FSW interface function to read data blocks. This function is called by the FSW core
531 * to read a block of data from the device. The buffer is allocated by the core code.
532 * Two caches are maintained, so as to improve performance on some systems. (VirtualBox
533 * is particularly susceptible to performance problems with an uncached driver -- the
534 * ext2 driver can take 200 seconds to load a Linux kernel under VirtualBox, whereas
535 * the time is more like 3 seconds with a cache!) Two independent caches are maintained
536 * because the ext2fs driver tends to alternate between accessing two parts of the
540 fsw_status_t
fsw_efi_read_block(struct fsw_volume
*vol
, fsw_u64 phys_bno
, void *buffer
) {
541 int i
, ReadCache
= -1;
542 FSW_VOLUME_DATA
*Volume
= (FSW_VOLUME_DATA
*)vol
->host_data
;
543 EFI_STATUS Status
= EFI_SUCCESS
;
544 BOOLEAN ReadOneBlock
= FALSE
;
545 fsw_u64 StartRead
= phys_bno
* vol
->phys_blocksize
;
548 return (fsw_status_t
) EFI_BAD_BUFFER_SIZE
;
550 // Initialize static data structures, if necessary....
552 fsw_efi_clear_cache();
555 // Look for a cache hit on the current query....
558 if ((Caches
[i
].Volume
== Volume
) &&
559 (StartRead
>= Caches
[i
].CacheStart
) &&
560 ((StartRead
+ vol
->phys_blocksize
) <= (Caches
[i
].CacheStart
+ CACHE_SIZE
))) {
564 } while ((i
< NUM_CACHES
) && (ReadCache
< 0));
566 // No cache hit found; load new cache and pass it on....
570 ReadCache
= 1 - LastRead
; // NOTE: If NUM_CACHES > 2, this must become more complex
571 if (Caches
[ReadCache
].Cache
== NULL
)
572 Caches
[ReadCache
].Cache
= AllocatePool(CACHE_SIZE
);
573 if (Caches
[ReadCache
].Cache
!= NULL
) {
574 Status
= refit_call5_wrapper(Volume
->DiskIo
->ReadDisk
, Volume
->DiskIo
, Volume
->MediaId
,
575 StartRead
, CACHE_SIZE
, Caches
[ReadCache
].Cache
);
576 if (!EFI_ERROR(Status
)) {
577 Caches
[ReadCache
].CacheStart
= StartRead
;
578 Caches
[ReadCache
].CacheValid
= TRUE
;
579 Caches
[ReadCache
].Volume
= Volume
;
580 LastRead
= ReadCache
;
586 } // if cache memory allocated
587 } // if (ReadCache < 0)
589 if (Caches
[ReadCache
].Cache
!= NULL
) {
590 CopyMem(buffer
, &Caches
[ReadCache
].Cache
[StartRead
- Caches
[ReadCache
].CacheStart
], vol
->phys_blocksize
);
595 if (ReadOneBlock
) { // Something's failed, so try a simple disk read of one block....
596 Status
= refit_call5_wrapper(Volume
->DiskIo
->ReadDisk
, Volume
->DiskIo
, Volume
->MediaId
,
597 phys_bno
* vol
->phys_blocksize
,
601 Volume
->LastIOStatus
= Status
;
604 } // fsw_status_t *fsw_efi_read_block()
607 * Map FSW status codes to EFI status codes. The FSW_IO_ERROR code is only produced
608 * by fsw_efi_read_block, so we map it back to the EFI status code remembered from
609 * the last I/O operation.
612 EFI_STATUS
fsw_efi_map_status(fsw_status_t fsw_status
, FSW_VOLUME_DATA
*Volume
)
614 switch (fsw_status
) {
617 case FSW_OUT_OF_MEMORY
:
618 return EFI_VOLUME_CORRUPTED
;
620 return Volume
->LastIOStatus
;
621 case FSW_UNSUPPORTED
:
622 return EFI_UNSUPPORTED
;
624 return EFI_NOT_FOUND
;
625 case FSW_VOLUME_CORRUPTED
:
626 return EFI_VOLUME_CORRUPTED
;
628 return EFI_DEVICE_ERROR
;
633 * File System EFI protocol, OpenVolume function. Creates a file handle for
634 * the root directory and returns it. Note that this function may be called
635 * multiple times and returns a new file handle each time. Each returned
636 * handle is closed by the client using it.
639 EFI_STATUS EFIAPI
fsw_efi_FileSystem_OpenVolume(IN EFI_FILE_IO_INTERFACE
*This
,
643 FSW_VOLUME_DATA
*Volume
= FSW_VOLUME_FROM_FILE_SYSTEM(This
);
646 Print(L
"fsw_efi_FileSystem_OpenVolume\n");
649 fsw_efi_clear_cache();
650 Status
= fsw_efi_dnode_to_FileHandle(Volume
->vol
->root
, Root
);
656 * File Handle EFI protocol, Open function. Dispatches the call
657 * based on the kind of file handle.
660 EFI_STATUS EFIAPI
fsw_efi_FileHandle_Open(IN EFI_FILE
*This
,
661 OUT EFI_FILE
**NewHandle
,
664 IN UINT64 Attributes
)
666 FSW_FILE_DATA
*File
= FSW_FILE_FROM_FILE_HANDLE(This
);
668 if (File
->Type
== FSW_EFI_FILE_TYPE_DIR
)
669 return fsw_efi_dir_open(File
, NewHandle
, FileName
, OpenMode
, Attributes
);
670 // not supported for regular files
671 return EFI_UNSUPPORTED
;
675 * File Handle EFI protocol, Close function. Closes the FSW shandle
676 * and frees the memory used for the structure.
679 EFI_STATUS EFIAPI
fsw_efi_FileHandle_Close(IN EFI_FILE
*This
)
681 FSW_FILE_DATA
*File
= FSW_FILE_FROM_FILE_HANDLE(This
);
684 Print(L
"fsw_efi_FileHandle_Close\n");
687 fsw_shandle_close(&File
->shand
);
694 * File Handle EFI protocol, Delete function. Calls through to Close
695 * and returns a warning because this driver is read-only.
698 EFI_STATUS EFIAPI
fsw_efi_FileHandle_Delete(IN EFI_FILE
*This
)
702 Status
= refit_call1_wrapper(This
->Close
, This
);
703 if (Status
== EFI_SUCCESS
) {
704 // this driver is read-only
705 Status
= EFI_WARN_DELETE_FAILURE
;
712 * File Handle EFI protocol, Read function. Dispatches the call
713 * based on the kind of file handle.
716 EFI_STATUS EFIAPI
fsw_efi_FileHandle_Read(IN EFI_FILE
*This
,
717 IN OUT UINTN
*BufferSize
,
720 FSW_FILE_DATA
*File
= FSW_FILE_FROM_FILE_HANDLE(This
);
722 if (File
->Type
== FSW_EFI_FILE_TYPE_FILE
)
723 return fsw_efi_file_read(File
, BufferSize
, Buffer
);
724 else if (File
->Type
== FSW_EFI_FILE_TYPE_DIR
)
725 return fsw_efi_dir_read(File
, BufferSize
, Buffer
);
726 return EFI_UNSUPPORTED
;
730 * File Handle EFI protocol, Write function. Returns unsupported status
731 * because this driver is read-only.
734 EFI_STATUS EFIAPI
fsw_efi_FileHandle_Write(IN EFI_FILE
*This
,
735 IN OUT UINTN
*BufferSize
,
738 // this driver is read-only
739 return EFI_WRITE_PROTECTED
;
743 * File Handle EFI protocol, GetPosition function. Dispatches the call
744 * based on the kind of file handle.
747 EFI_STATUS EFIAPI
fsw_efi_FileHandle_GetPosition(IN EFI_FILE
*This
,
748 OUT UINT64
*Position
)
750 FSW_FILE_DATA
*File
= FSW_FILE_FROM_FILE_HANDLE(This
);
752 if (File
->Type
== FSW_EFI_FILE_TYPE_FILE
)
753 return fsw_efi_file_getpos(File
, Position
);
754 // not defined for directories
755 return EFI_UNSUPPORTED
;
759 * File Handle EFI protocol, SetPosition function. Dispatches the call
760 * based on the kind of file handle.
763 EFI_STATUS EFIAPI
fsw_efi_FileHandle_SetPosition(IN EFI_FILE
*This
,
766 FSW_FILE_DATA
*File
= FSW_FILE_FROM_FILE_HANDLE(This
);
768 if (File
->Type
== FSW_EFI_FILE_TYPE_FILE
)
769 return fsw_efi_file_setpos(File
, Position
);
770 else if (File
->Type
== FSW_EFI_FILE_TYPE_DIR
)
771 return fsw_efi_dir_setpos(File
, Position
);
772 return EFI_UNSUPPORTED
;
776 * File Handle EFI protocol, GetInfo function. Dispatches to the common
777 * function implementing this.
780 EFI_STATUS EFIAPI
fsw_efi_FileHandle_GetInfo(IN EFI_FILE
*This
,
781 IN EFI_GUID
*InformationType
,
782 IN OUT UINTN
*BufferSize
,
785 FSW_FILE_DATA
*File
= FSW_FILE_FROM_FILE_HANDLE(This
);
787 return fsw_efi_dnode_getinfo(File
, InformationType
, BufferSize
, Buffer
);
791 * File Handle EFI protocol, SetInfo function. Returns unsupported status
792 * because this driver is read-only.
795 EFI_STATUS EFIAPI
fsw_efi_FileHandle_SetInfo(IN EFI_FILE
*This
,
796 IN EFI_GUID
*InformationType
,
800 // this driver is read-only
801 return EFI_WRITE_PROTECTED
;
805 * File Handle EFI protocol, Flush function. Returns unsupported status
806 * because this driver is read-only.
809 EFI_STATUS EFIAPI
fsw_efi_FileHandle_Flush(IN EFI_FILE
*This
)
811 // this driver is read-only
812 return EFI_WRITE_PROTECTED
;
816 * Set up a file handle for a dnode. This function allocates a data structure
817 * for a file handle, opens a FSW shandle and populates the EFI_FILE structure
818 * with the interface functions.
821 EFI_STATUS
fsw_efi_dnode_to_FileHandle(IN
struct fsw_dnode
*dno
,
822 OUT EFI_FILE
**NewFileHandle
)
827 // make sure the dnode has complete info
828 Status
= fsw_efi_map_status(fsw_dnode_fill(dno
), (FSW_VOLUME_DATA
*)dno
->vol
->host_data
);
829 if (EFI_ERROR(Status
))
833 if (dno
->type
!= FSW_DNODE_TYPE_FILE
&& dno
->type
!= FSW_DNODE_TYPE_DIR
)
834 return EFI_UNSUPPORTED
;
836 // allocate file structure
837 File
= AllocateZeroPool(sizeof(FSW_FILE_DATA
));
838 File
->Signature
= FSW_FILE_DATA_SIGNATURE
;
839 if (dno
->type
== FSW_DNODE_TYPE_FILE
)
840 File
->Type
= FSW_EFI_FILE_TYPE_FILE
;
841 else if (dno
->type
== FSW_DNODE_TYPE_DIR
)
842 File
->Type
= FSW_EFI_FILE_TYPE_DIR
;
845 Status
= fsw_efi_map_status(fsw_shandle_open(dno
, &File
->shand
),
846 (FSW_VOLUME_DATA
*)dno
->vol
->host_data
);
847 if (EFI_ERROR(Status
)) {
852 // populate the file handle
853 File
->FileHandle
.Revision
= EFI_FILE_HANDLE_REVISION
;
854 File
->FileHandle
.Open
= fsw_efi_FileHandle_Open
;
855 File
->FileHandle
.Close
= fsw_efi_FileHandle_Close
;
856 File
->FileHandle
.Delete
= fsw_efi_FileHandle_Delete
;
857 File
->FileHandle
.Read
= fsw_efi_FileHandle_Read
;
858 File
->FileHandle
.Write
= fsw_efi_FileHandle_Write
;
859 File
->FileHandle
.GetPosition
= fsw_efi_FileHandle_GetPosition
;
860 File
->FileHandle
.SetPosition
= fsw_efi_FileHandle_SetPosition
;
861 File
->FileHandle
.GetInfo
= fsw_efi_FileHandle_GetInfo
;
862 File
->FileHandle
.SetInfo
= fsw_efi_FileHandle_SetInfo
;
863 File
->FileHandle
.Flush
= fsw_efi_FileHandle_Flush
;
865 *NewFileHandle
= &File
->FileHandle
;
870 * Data read function for regular files. Calls through to fsw_shandle_read.
873 EFI_STATUS
fsw_efi_file_read(IN FSW_FILE_DATA
*File
,
874 IN OUT UINTN
*BufferSize
,
881 Print(L
"fsw_efi_file_read %d bytes\n", *BufferSize
);
884 buffer_size
= (fsw_u32
)*BufferSize
;
885 Status
= fsw_efi_map_status(fsw_shandle_read(&File
->shand
, &buffer_size
, Buffer
),
886 (FSW_VOLUME_DATA
*)File
->shand
.dnode
->vol
->host_data
);
887 *BufferSize
= buffer_size
;
893 * Get file position for regular files.
896 EFI_STATUS
fsw_efi_file_getpos(IN FSW_FILE_DATA
*File
,
897 OUT UINT64
*Position
)
899 *Position
= File
->shand
.pos
;
904 * Set file position for regular files. EFI specifies the all-ones value
905 * to be a special value for the end of the file.
908 EFI_STATUS
fsw_efi_file_setpos(IN FSW_FILE_DATA
*File
, IN UINT64 Position
)
910 if (Position
== 0xFFFFFFFFFFFFFFFFULL
)
911 File
->shand
.pos
= File
->shand
.dnode
->size
;
913 File
->shand
.pos
= Position
;
918 * Open function used to open new file handles relative to a directory.
919 * In EFI, the "open file" function is implemented by directory file handles
920 * and is passed a relative or volume-absolute path to the file or directory
921 * to open. We use fsw_dnode_lookup_path to find the node plus an additional
922 * call to fsw_dnode_resolve because EFI has no concept of symbolic links.
925 EFI_STATUS
fsw_efi_dir_open(IN FSW_FILE_DATA
*File
,
926 OUT EFI_FILE
**NewHandle
,
929 IN UINT64 Attributes
)
932 FSW_VOLUME_DATA
*Volume
= (FSW_VOLUME_DATA
*)File
->shand
.dnode
->vol
->host_data
;
933 struct fsw_dnode
*dno
;
934 struct fsw_dnode
*target_dno
;
935 struct fsw_string lookup_path
;
938 Print(L
"fsw_efi_dir_open: '%s'\n", FileName
);
941 if (OpenMode
!= EFI_FILE_MODE_READ
)
942 return EFI_WRITE_PROTECTED
;
944 lookup_path
.type
= FSW_STRING_TYPE_UTF16
;
945 lookup_path
.len
= (int)StrLen(FileName
);
946 lookup_path
.size
= lookup_path
.len
* sizeof(fsw_u16
);
947 lookup_path
.data
= FileName
;
949 // resolve the path (symlinks along the way are automatically resolved)
950 Status
= fsw_efi_map_status(fsw_dnode_lookup_path(File
->shand
.dnode
, &lookup_path
, '\\', &dno
), Volume
);
951 if (EFI_ERROR(Status
))
954 // if the final node is a symlink, also resolve it
955 Status
= fsw_efi_map_status(fsw_dnode_resolve(dno
, &target_dno
), Volume
);
956 fsw_dnode_release(dno
);
957 if (EFI_ERROR(Status
))
961 // make a new EFI handle for the target dnode
962 Status
= fsw_efi_dnode_to_FileHandle(dno
, NewHandle
);
963 fsw_dnode_release(dno
);
968 * Read function for directories. A file handle read on a directory retrieves
969 * the next directory entry.
972 EFI_STATUS
fsw_efi_dir_read(IN FSW_FILE_DATA
*File
,
973 IN OUT UINTN
*BufferSize
,
977 FSW_VOLUME_DATA
*Volume
= (FSW_VOLUME_DATA
*)File
->shand
.dnode
->vol
->host_data
;
978 struct fsw_dnode
*dno
;
981 Print(L
"fsw_efi_dir_read...\n");
984 // read the next entry
985 Status
= fsw_efi_map_status(fsw_dnode_dir_read(&File
->shand
, &dno
), Volume
);
986 if (Status
== EFI_NOT_FOUND
) {
990 Print(L
"...no more entries\n");
994 if (EFI_ERROR(Status
))
997 // get info into buffer
998 Status
= fsw_efi_dnode_fill_FileInfo(Volume
, dno
, BufferSize
, Buffer
);
999 fsw_dnode_release(dno
);
1004 * Set file position for directories. The only allowed set position operation
1005 * for directories is to rewind the directory completely by setting the
1009 EFI_STATUS
fsw_efi_dir_setpos(IN FSW_FILE_DATA
*File
, IN UINT64 Position
)
1011 if (Position
== 0) {
1012 File
->shand
.pos
= 0;
1015 // directories can only rewind to the start
1016 return EFI_UNSUPPORTED
;
1021 * Get file or volume information. This function implements the GetInfo call
1022 * for all file handles. Control is dispatched according to the type of information
1023 * requested by the caller.
1026 EFI_STATUS
fsw_efi_dnode_getinfo(IN FSW_FILE_DATA
*File
,
1027 IN EFI_GUID
*InformationType
,
1028 IN OUT UINTN
*BufferSize
,
1032 FSW_VOLUME_DATA
*Volume
= (FSW_VOLUME_DATA
*)File
->shand
.dnode
->vol
->host_data
;
1033 EFI_FILE_SYSTEM_INFO
*FSInfo
;
1035 struct fsw_volume_stat vsb
;
1038 if (CompareGuid(InformationType
, &gEfiFileInfoGuid
)) {
1040 Print(L
"fsw_efi_dnode_getinfo: FILE_INFO\n");
1043 Status
= fsw_efi_dnode_fill_FileInfo(Volume
, File
->shand
.dnode
, BufferSize
, Buffer
);
1045 } else if (CompareGuid(InformationType
, &gEfiFileSystemInfoGuid
)) {
1047 Print(L
"fsw_efi_dnode_getinfo: FILE_SYSTEM_INFO\n");
1050 // check buffer size
1051 RequiredSize
= SIZE_OF_EFI_FILE_SYSTEM_INFO
+ fsw_efi_strsize(&Volume
->vol
->label
);
1052 if (*BufferSize
< RequiredSize
) {
1053 *BufferSize
= RequiredSize
;
1054 return EFI_BUFFER_TOO_SMALL
;
1058 FSInfo
= (EFI_FILE_SYSTEM_INFO
*)Buffer
;
1059 FSInfo
->Size
= RequiredSize
;
1060 FSInfo
->ReadOnly
= TRUE
;
1061 FSInfo
->BlockSize
= Volume
->vol
->log_blocksize
;
1062 fsw_efi_strcpy(FSInfo
->VolumeLabel
, &Volume
->vol
->label
);
1064 // get the missing info from the fs driver
1065 ZeroMem(&vsb
, sizeof(struct fsw_volume_stat
));
1066 Status
= fsw_efi_map_status(fsw_volume_stat(Volume
->vol
, &vsb
), Volume
);
1067 if (EFI_ERROR(Status
))
1069 FSInfo
->VolumeSize
= vsb
.total_bytes
;
1070 FSInfo
->FreeSpace
= vsb
.free_bytes
;
1072 // prepare for return
1073 *BufferSize
= RequiredSize
;
1074 Status
= EFI_SUCCESS
;
1076 } else if (CompareGuid(InformationType
, &gEfiFileSystemVolumeLabelInfoIdGuid
)) {
1078 Print(L
"fsw_efi_dnode_getinfo: FILE_SYSTEM_VOLUME_LABEL\n");
1081 // check buffer size
1082 RequiredSize
= SIZE_OF_EFI_FILE_SYSTEM_VOLUME_LABEL_INFO
+ fsw_efi_strsize(&Volume
->vol
->label
);
1083 if (*BufferSize
< RequiredSize
) {
1084 *BufferSize
= RequiredSize
;
1085 return EFI_BUFFER_TOO_SMALL
;
1088 // copy volume label
1089 fsw_efi_strcpy(((EFI_FILE_SYSTEM_VOLUME_LABEL_INFO
*)Buffer
)->VolumeLabel
, &Volume
->vol
->label
);
1091 // prepare for return
1092 *BufferSize
= RequiredSize
;
1093 Status
= EFI_SUCCESS
;
1096 Status
= EFI_UNSUPPORTED
;
1103 * Time mapping callback for the fsw_dnode_stat call. This function converts
1104 * a Posix style timestamp into an EFI_TIME structure and writes it to the
1105 * appropriate member of the EFI_FILE_INFO structure that we're filling.
1108 static void fsw_efi_store_time_posix(struct fsw_dnode_stat
*sb
, int which
, fsw_u32 posix_time
)
1110 EFI_FILE_INFO
*FileInfo
= (EFI_FILE_INFO
*)sb
->host_data
;
1112 if (which
== FSW_DNODE_STAT_CTIME
)
1113 fsw_efi_decode_time(&FileInfo
->CreateTime
, posix_time
);
1114 else if (which
== FSW_DNODE_STAT_MTIME
)
1115 fsw_efi_decode_time(&FileInfo
->ModificationTime
, posix_time
);
1116 else if (which
== FSW_DNODE_STAT_ATIME
)
1117 fsw_efi_decode_time(&FileInfo
->LastAccessTime
, posix_time
);
1121 * Mode mapping callback for the fsw_dnode_stat call. This function looks at
1122 * the Posix mode passed by the file system driver and makes appropriate
1123 * adjustments to the EFI_FILE_INFO structure that we're filling.
1126 static void fsw_efi_store_attr_posix(struct fsw_dnode_stat
*sb
, fsw_u16 posix_mode
)
1128 EFI_FILE_INFO
*FileInfo
= (EFI_FILE_INFO
*)sb
->host_data
;
1130 if ((posix_mode
& S_IWUSR
) == 0)
1131 FileInfo
->Attribute
|= EFI_FILE_READ_ONLY
;
1135 * Common function to fill an EFI_FILE_INFO with information about a dnode.
1138 EFI_STATUS
fsw_efi_dnode_fill_FileInfo(IN FSW_VOLUME_DATA
*Volume
,
1139 IN
struct fsw_dnode
*dno
,
1140 IN OUT UINTN
*BufferSize
,
1144 EFI_FILE_INFO
*FileInfo
;
1146 struct fsw_dnode_stat sb
;
1148 // make sure the dnode has complete info
1149 Status
= fsw_efi_map_status(fsw_dnode_fill(dno
), Volume
);
1150 if (EFI_ERROR(Status
))
1153 // TODO: check/assert that the dno's name is in UTF16
1155 // check buffer size
1156 RequiredSize
= SIZE_OF_EFI_FILE_INFO
+ fsw_efi_strsize(&dno
->name
);
1157 if (*BufferSize
< RequiredSize
) {
1158 // TODO: wind back the directory in this case
1161 Print(L
"...BUFFER TOO SMALL\n");
1163 *BufferSize
= RequiredSize
;
1164 return EFI_BUFFER_TOO_SMALL
;
1168 ZeroMem(Buffer
, RequiredSize
);
1169 FileInfo
= (EFI_FILE_INFO
*)Buffer
;
1170 FileInfo
->Size
= RequiredSize
;
1171 FileInfo
->FileSize
= dno
->size
;
1172 FileInfo
->Attribute
= 0;
1173 if (dno
->type
== FSW_DNODE_TYPE_DIR
)
1174 FileInfo
->Attribute
|= EFI_FILE_DIRECTORY
;
1175 fsw_efi_strcpy(FileInfo
->FileName
, &dno
->name
);
1177 // get the missing info from the fs driver
1178 ZeroMem(&sb
, sizeof(struct fsw_dnode_stat
));
1179 sb
.store_time_posix
= fsw_efi_store_time_posix
;
1180 sb
.store_attr_posix
= fsw_efi_store_attr_posix
;
1181 sb
.host_data
= FileInfo
;
1182 Status
= fsw_efi_map_status(fsw_dnode_stat(dno
, &sb
), Volume
);
1183 if (EFI_ERROR(Status
))
1185 FileInfo
->PhysicalSize
= sb
.used_bytes
;
1187 // prepare for return
1188 *BufferSize
= RequiredSize
;
1190 Print(L
"...returning '%s'\n", FileInfo
->FileName
);