-/* $Id: fsw_efi.c 29125 2010-05-06 09:43:05Z vboxsync $ */
-/** @file
- * fsw_efi.c - EFI host environment code.
- */
-
-/*
- * Copyright (C) 2010 Oracle Corporation
- *
- * This file is part of VirtualBox Open Source Edition (OSE), as
- * available from http://www.virtualbox.org. This file is free software;
- * you can redistribute it and/or modify it under the terms of the GNU
- * General Public License (GPL) as published by the Free Software
- * Foundation, in version 2 as it comes in the "COPYING" file of the
- * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
- * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
+/**
+ * \file fsw_efi.c
+ * EFI host environment code.
*/
/*-
- * This code is based on:
- *
* Copyright (c) 2006 Christoph Pfisterer
*
* Redistribution and use in source and binary forms, with or without
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
+/*
+ * Changes by Roderick Smith are licensed under the preceding terms.
+ */
#include "fsw_efi.h"
#include "fsw_core.h"
#ifdef __MAKEWITH_GNUEFI
#include "edk2/DriverBinding.h"
#include "edk2/ComponentName.h"
+#else
+#define REFIND_EFI_COMPONENT_NAME_PROTOCOL EFI_COMPONENT_NAME_PROTOCOL
#endif
#include "../include/refit_call_wrapper.h"
#define DEBUG_LEVEL 0
#ifndef FSTYPE
-#error FSTYPE must be defined!
-#endif
-
-#define DEBUG_VBFS 1
-
-#if DEBUG_VBFS==2
-#define DBG(x...) AsciiPrint(x)
-#elif DEBUG_VBFS==1
-#define DBG(x...) BootLog(x)
-#else
-#define DBG(x...)
+/** The file system type name to use. */
+#define FSTYPE ext2
#endif
#ifdef __MAKEWITH_GNUEFI
}
EFI_GUID gEfiDriverBindingProtocolGuid = EFI_DRIVER_BINDING_PROTOCOL_GUID;
-EFI_GUID gEfiComponentNameProtocolGuid = EFI_COMPONENT_NAME_PROTOCOL_GUID;
+EFI_GUID gEfiComponentNameProtocolGuid = REFIND_EFI_COMPONENT_NAME_PROTOCOL_GUID;
EFI_GUID gEfiDiskIoProtocolGuid = EFI_DISK_IO_PROTOCOL_GUID;
EFI_GUID gEfiBlockIoProtocolGuid = EFI_BLOCK_IO_PROTOCOL_GUID;
EFI_GUID gEfiFileInfoGuid = EFI_FILE_INFO_ID;
EFI_GUID gEfiFileSystemInfoGuid = EFI_FILE_SYSTEM_INFO_ID;
EFI_GUID gEfiFileSystemVolumeLabelInfoIdGuid = EFI_FILE_SYSTEM_VOLUME_LABEL_INFO_ID;
-#define SimpleFileSystemProtocol FileSystemProtocol
+#define gEfiSimpleFileSystemProtocolGuid FileSystemProtocol
#endif
/** Helper macro for stringification. */
#define FSW_EFI_STRINGIFY(x) #x
/** Expands to the EFI driver name given the file system type name. */
-#define FSW_EFI_DRIVER_NAME(t) L"rEFInd 0.6.8 " FSW_EFI_STRINGIFY(t) L" File System Driver"
+#define FSW_EFI_DRIVER_NAME(t) L"rEFInd 0.10.3 " FSW_EFI_STRINGIFY(t) L" File System Driver"
// function prototypes
IN UINTN NumberOfChildren,
IN EFI_HANDLE *ChildHandleBuffer);
-EFI_STATUS EFIAPI fsw_efi_ComponentName_GetDriverName(IN EFI_COMPONENT_NAME_PROTOCOL *This,
+EFI_STATUS EFIAPI fsw_efi_ComponentName_GetDriverName(IN REFIND_EFI_COMPONENT_NAME_PROTOCOL *This,
IN CHAR8 *Language,
OUT CHAR16 **DriverName);
-EFI_STATUS EFIAPI fsw_efi_ComponentName_GetControllerName(IN EFI_COMPONENT_NAME_PROTOCOL *This,
+EFI_STATUS EFIAPI fsw_efi_ComponentName_GetControllerName(IN REFIND_EFI_COMPONENT_NAME_PROTOCOL *This,
IN EFI_HANDLE ControllerHandle,
IN EFI_HANDLE ChildHandle OPTIONAL,
IN CHAR8 *Language,
OUT CHAR16 **ControllerName);
-void fsw_efi_change_blocksize(struct fsw_volume *vol,
+void EFIAPI fsw_efi_change_blocksize(struct fsw_volume *vol,
fsw_u32 old_phys_blocksize, fsw_u32 old_log_blocksize,
fsw_u32 new_phys_blocksize, fsw_u32 new_log_blocksize);
-fsw_status_t fsw_efi_read_block(struct fsw_volume *vol, fsw_u32 phys_bno, void *buffer);
+fsw_status_t EFIAPI fsw_efi_read_block(struct fsw_volume *vol, fsw_u64 phys_bno, void *buffer);
EFI_STATUS fsw_efi_map_status(fsw_status_t fsw_status, FSW_VOLUME_DATA *Volume);
IN OUT UINTN *BufferSize,
OUT VOID *Buffer);
+/**
+ * Structure for holding disk cache data.
+ */
+
+#define CACHE_SIZE 131072 /* 128KiB */
+struct cache_data {
+ fsw_u8 *Cache;
+ fsw_u64 CacheStart;
+ BOOLEAN CacheValid;
+ FSW_VOLUME_DATA *Volume; // NOTE: Do not deallocate; copied here to ID volume
+};
+
+#define NUM_CACHES 2 /* Don't increase without modifying fsw_efi_read_block() */
+static struct cache_data Caches[NUM_CACHES];
+static int LastRead = -1;
+
/**
* Interface structure for the EFI Driver Binding protocol.
*/
* Interface structure for the EFI Component Name protocol.
*/
-EFI_COMPONENT_NAME_PROTOCOL fsw_efi_ComponentName_table = {
+REFIND_EFI_COMPONENT_NAME_PROTOCOL fsw_efi_ComponentName_table = {
fsw_efi_ComponentName_GetDriverName,
fsw_efi_ComponentName_GetControllerName,
(CHAR8*) "eng"
extern struct fsw_fstype_table FSW_FSTYPE_TABLE_NAME(FSTYPE);
-//#include "OverrideFunctions-kabyl.edk2.c.include"
+
+static VOID EFIAPI fsw_efi_clear_cache(VOID) {
+ int i;
+
+ // clear the cache
+ for (i = 0; i < NUM_CACHES; i++) {
+ if (Caches[i].Cache != NULL) {
+ FreePool(Caches[i].Cache);
+ Caches[i].Cache = NULL;
+ } // if
+ Caches[i].CacheStart = 0;
+ Caches[i].CacheValid = FALSE;
+ Caches[i].Volume = NULL;
+ }
+ LastRead = -1;
+} // VOID EFIAPI fsw_efi_clear_cache();
/**
* Image entry point. Installs the Driver Binding and Component Name protocols
{
EFI_STATUS Status;
-#ifndef HOST_EFI_EDK2
+#ifndef __MAKEWITH_TIANO
// Not available in EDK2 toolkit
InitializeLib(ImageHandle, SystemTable);
#endif
// first, open DiskIO
Status = refit_call6_wrapper(BS->OpenProtocol, ControllerHandle,
- &PROTO_NAME(DiskIoProtocol),
+ &gEfiDiskIoProtocolGuid,
(VOID **) &DiskIo,
This->DriverBindingHandle,
ControllerHandle,
// we were just checking, close it again
refit_call4_wrapper(BS->CloseProtocol, ControllerHandle,
- &PROTO_NAME(DiskIoProtocol),
+ &gEfiDiskIoProtocolGuid,
This->DriverBindingHandle,
ControllerHandle);
// next, check BlockIO without actually opening it
Status = refit_call6_wrapper(BS->OpenProtocol, ControllerHandle,
- &PROTO_NAME(BlockIoProtocol),
+ &gEfiBlockIoProtocolGuid,
NULL,
This->DriverBindingHandle,
ControllerHandle,
// open consumed protocols
Status = refit_call6_wrapper(BS->OpenProtocol, ControllerHandle,
- &PROTO_NAME(BlockIoProtocol),
+ &gEfiBlockIoProtocolGuid,
(VOID **) &BlockIo,
This->DriverBindingHandle,
ControllerHandle,
}
Status = refit_call6_wrapper(BS->OpenProtocol, ControllerHandle,
- &PROTO_NAME(DiskIoProtocol),
+ &gEfiDiskIoProtocolGuid,
(VOID **) &DiskIo,
This->DriverBindingHandle,
ControllerHandle,
EFI_OPEN_PROTOCOL_BY_DRIVER);
if (EFI_ERROR(Status)) {
- Print(L"Fsw ERROR: OpenProtocol(DiskIo) returned %r\n", Status);
+ Print(L"Fsw ERROR: OpenProtocol(DiskIo) returned %x\n", Status);
return Status;
}
Volume->FileSystem.Revision = EFI_FILE_IO_INTERFACE_REVISION;
Volume->FileSystem.OpenVolume = fsw_efi_FileSystem_OpenVolume;
Status = refit_call4_wrapper(BS->InstallMultipleProtocolInterfaces, &ControllerHandle,
- &PROTO_NAME(SimpleFileSystemProtocol),
+ &gEfiSimpleFileSystemProtocolGuid,
&Volume->FileSystem,
NULL);
if (EFI_ERROR(Status)) {
FreePool(Volume);
refit_call4_wrapper(BS->CloseProtocol, ControllerHandle,
- &PROTO_NAME(DiskIoProtocol),
+ &gEfiDiskIoProtocolGuid,
This->DriverBindingHandle,
ControllerHandle);
}
-
return Status;
}
// get the installed SimpleFileSystem interface
Status = refit_call6_wrapper(BS->OpenProtocol, ControllerHandle,
- &PROTO_NAME(SimpleFileSystemProtocol),
+ &gEfiSimpleFileSystemProtocolGuid,
(VOID **) &FileSystem,
This->DriverBindingHandle,
ControllerHandle,
// uninstall Simple File System protocol
Status = refit_call4_wrapper(BS->UninstallMultipleProtocolInterfaces, ControllerHandle,
- &PROTO_NAME(SimpleFileSystemProtocol), &Volume->FileSystem,
+ &gEfiSimpleFileSystemProtocolGuid, &Volume->FileSystem,
NULL);
if (EFI_ERROR(Status)) {
// Print(L"Fsw ERROR: UninstallMultipleProtocolInterfaces returned %x\n", Status);
// close the consumed protocols
Status = refit_call4_wrapper(BS->CloseProtocol, ControllerHandle,
- &PROTO_NAME(DiskIoProtocol),
+ &gEfiDiskIoProtocolGuid,
This->DriverBindingHandle,
ControllerHandle);
+ // clear the cache
+ fsw_efi_clear_cache();
+
return Status;
}
* based on the file system type actually used in compilation.
*/
-EFI_STATUS EFIAPI fsw_efi_ComponentName_GetDriverName(IN EFI_COMPONENT_NAME_PROTOCOL *This,
+EFI_STATUS EFIAPI fsw_efi_ComponentName_GetDriverName(IN REFIND_EFI_COMPONENT_NAME_PROTOCOL *This,
IN CHAR8 *Language,
OUT CHAR16 **DriverName)
{
* because this is not a "bus" driver in the sense of the EFI Driver Model.
*/
-EFI_STATUS EFIAPI fsw_efi_ComponentName_GetControllerName(IN EFI_COMPONENT_NAME_PROTOCOL *This,
+EFI_STATUS EFIAPI fsw_efi_ComponentName_GetControllerName(IN REFIND_EFI_COMPONENT_NAME_PROTOCOL *This,
IN EFI_HANDLE ControllerHandle,
IN EFI_HANDLE ChildHandle OPTIONAL,
IN CHAR8 *Language,
* when the file system driver changes the block sizes for the volume.
*/
-void fsw_efi_change_blocksize(struct fsw_volume *vol,
+void EFIAPI fsw_efi_change_blocksize(struct fsw_volume *vol,
fsw_u32 old_phys_blocksize, fsw_u32 old_log_blocksize,
fsw_u32 new_phys_blocksize, fsw_u32 new_log_blocksize)
{
/**
* FSW interface function to read data blocks. This function is called by the FSW core
* to read a block of data from the device. The buffer is allocated by the core code.
+ * Two caches are maintained, so as to improve performance on some systems. (VirtualBox
+ * is particularly susceptible to performance problems with an uncached driver -- the
+ * ext2 driver can take 200 seconds to load a Linux kernel under VirtualBox, whereas
+ * the time is more like 3 seconds with a cache!) Two independent caches are maintained
+ * because the ext2fs driver tends to alternate between accessing two parts of the
+ * disk.
*/
-fsw_status_t fsw_efi_read_block(struct fsw_volume *vol, fsw_u32 phys_bno, void *buffer)
-{
- EFI_STATUS Status;
- FSW_VOLUME_DATA *Volume = (FSW_VOLUME_DATA *)vol->host_data;
-
-// FSW_MSG_DEBUGV((FSW_MSGSTR("fsw_efi_read_block: %d (%d)\n"), phys_bno, vol->phys_blocksize));
-
- // read from disk
- Status = refit_call5_wrapper(Volume->DiskIo->ReadDisk, Volume->DiskIo, Volume->MediaId,
- (UINT64)phys_bno * vol->phys_blocksize,
- vol->phys_blocksize,
- buffer);
- Volume->LastIOStatus = Status;
- if (EFI_ERROR(Status))
- return FSW_IO_ERROR;
- return FSW_SUCCESS;
-}
+fsw_status_t EFIAPI fsw_efi_read_block(struct fsw_volume *vol, fsw_u64 phys_bno, void *buffer) {
+ int i, ReadCache = -1;
+ FSW_VOLUME_DATA *Volume = (FSW_VOLUME_DATA *)vol->host_data;
+ EFI_STATUS Status = EFI_SUCCESS;
+ BOOLEAN ReadOneBlock = FALSE;
+ UINT64 StartRead = (UINT64) phys_bno * (UINT64) vol->phys_blocksize;
+
+ if (buffer == NULL)
+ return (fsw_status_t) EFI_BAD_BUFFER_SIZE;
+
+ // Initialize static data structures, if necessary....
+ if (LastRead < 0) {
+ fsw_efi_clear_cache();
+ } // if
+
+ // Look for a cache hit on the current query....
+ i = 0;
+ do {
+ if ((Caches[i].Volume == Volume) &&
+ (Caches[i].CacheValid == TRUE) &&
+ (StartRead >= Caches[i].CacheStart) &&
+ ((StartRead + vol->phys_blocksize) <= (Caches[i].CacheStart + CACHE_SIZE))) {
+ ReadCache = i;
+ }
+ i++;
+ } while ((i < NUM_CACHES) && (ReadCache < 0));
+
+ // No cache hit found; load new cache and pass it on....
+ if (ReadCache < 0) {
+ if (LastRead == -1)
+ LastRead = 1;
+ ReadCache = 1 - LastRead; // NOTE: If NUM_CACHES > 2, this must become more complex
+ Caches[ReadCache].CacheValid = FALSE;
+ if (Caches[ReadCache].Cache == NULL)
+ Caches[ReadCache].Cache = AllocatePool(CACHE_SIZE);
+ if (Caches[ReadCache].Cache != NULL) {
+ // TODO: Below call hangs on my 32-bit Mac Mini when compiled with GNU-EFI.
+ // The same binary is fine under VirtualBox, and the same call is fine when
+ // compiled with Tianocore. Further clue: Omitting "Status =" avoids the
+ // hang but produces a failure to mount the filesystem, even when the same
+ // change is made to later similar call. Calling Volume->DiskIo->ReadDisk()
+ // directly (without refit_call5_wrapper()) changes nothing. Placing Print()
+ // statements at the start and end of the function, and before and after the
+ // ReadDisk() call, suggests that when it fails, the program is executing
+ // code starting mid-function, so there seems to be something messed up in
+ // the way the function is being called. FIGURE THIS OUT!
+ Status = refit_call5_wrapper(Volume->DiskIo->ReadDisk, Volume->DiskIo, Volume->MediaId,
+ StartRead, (UINTN) CACHE_SIZE, (VOID*) Caches[ReadCache].Cache);
+ if (!EFI_ERROR(Status)) {
+ Caches[ReadCache].CacheStart = StartRead;
+ Caches[ReadCache].CacheValid = TRUE;
+ Caches[ReadCache].Volume = Volume;
+ LastRead = ReadCache;
+ } else {
+ ReadOneBlock = TRUE;
+ }
+ } else {
+ ReadOneBlock = TRUE;
+ } // if cache memory allocated
+ } // if (ReadCache < 0)
+
+ if (Caches[ReadCache].Cache != NULL && Caches[ReadCache].CacheValid == TRUE && vol->phys_blocksize > 0) {
+ CopyMem(buffer, &Caches[ReadCache].Cache[StartRead - Caches[ReadCache].CacheStart], vol->phys_blocksize);
+ } else {
+ ReadOneBlock = TRUE;
+ }
+
+ if (ReadOneBlock) { // Something's failed, so try a simple disk read of one block....
+ Status = refit_call5_wrapper(Volume->DiskIo->ReadDisk, Volume->DiskIo, Volume->MediaId,
+ phys_bno * vol->phys_blocksize,
+ (UINTN) vol->phys_blocksize,
+ (VOID*) buffer);
+ }
+ Volume->LastIOStatus = Status;
+
+ return Status;
+} // fsw_status_t *fsw_efi_read_block()
/**
* Map FSW status codes to EFI status codes. The FSW_IO_ERROR code is only produced
Print(L"fsw_efi_FileSystem_OpenVolume\n");
#endif
+ fsw_efi_clear_cache();
Status = fsw_efi_dnode_to_FileHandle(Volume->vol->root, Root);
return Status;
* appropriate member of the EFI_FILE_INFO structure that we're filling.
*/
-static void fsw_efi_store_time_posix(struct fsw_dnode_stat *sb, int which, fsw_u32 posix_time)
+void fsw_store_time_posix(struct fsw_dnode_stat *sb, int which, fsw_u32 posix_time)
{
EFI_FILE_INFO *FileInfo = (EFI_FILE_INFO *)sb->host_data;
* adjustments to the EFI_FILE_INFO structure that we're filling.
*/
-static void fsw_efi_store_attr_posix(struct fsw_dnode_stat *sb, fsw_u16 posix_mode)
+void fsw_store_attr_posix(struct fsw_dnode_stat *sb, fsw_u16 posix_mode)
{
EFI_FILE_INFO *FileInfo = (EFI_FILE_INFO *)sb->host_data;
FileInfo->Attribute |= EFI_FILE_READ_ONLY;
}
+void fsw_store_attr_efi(struct fsw_dnode_stat *sb, fsw_u16 attr)
+{
+ EFI_FILE_INFO *FileInfo = (EFI_FILE_INFO *)sb->host_data;
+
+ FileInfo->Attribute |= attr;
+}
+
/**
* Common function to fill an EFI_FILE_INFO with information about a dnode.
*/
// get the missing info from the fs driver
ZeroMem(&sb, sizeof(struct fsw_dnode_stat));
- sb.store_time_posix = fsw_efi_store_time_posix;
- sb.store_attr_posix = fsw_efi_store_attr_posix;
sb.host_data = FileInfo;
Status = fsw_efi_map_status(fsw_dnode_stat(dno, &sb), Volume);
if (EFI_ERROR(Status))