fs.c File Reference

#include <freeldr.h>
#include <debug.h>

Include dependency graph for fs.c:

Go to the source code of this file.

Classes
struct	tagFILEDATA
struct	tagDEVICE

Macros
#define	TAG_DEVICE_NAME   'NDsF'
#define	TAG_DEVICE   'vDsF'

Typedefs
typedef struct tagFILEDATA	FILEDATA
typedef struct tagDEVICE	DEVICE

Functions
	DBG_DEFAULT_CHANNEL (FILESYSTEM)
ARC_STATUS	ArcOpen (CHAR *Path, OPENMODE OpenMode, ULONG *FileId)
ARC_STATUS	ArcClose (ULONG FileId)
ARC_STATUS	ArcRead (ULONG FileId, VOID *Buffer, ULONG N, ULONG *Count)
ARC_STATUS	ArcSeek (ULONG FileId, LARGE_INTEGER *Position, SEEKMODE SeekMode)
ARC_STATUS	ArcGetFileInformation (ULONG FileId, FILEINFORMATION *Information)
VOID	FileSystemError (PCSTR ErrorString)
ARC_STATUS	FsOpenFile (IN PCSTR FileName, IN PCSTR DefaultPath OPTIONAL, IN OPENMODE OpenMode, OUT PULONG FileId)
ULONG	FsGetNumPathParts (PCSTR Path)
VOID	FsGetFirstNameFromPath (PCHAR Buffer, PCSTR Path)
VOID	FsRegisterDevice (CHAR *Prefix, const DEVVTBL *FuncTable)
PCWSTR	FsGetServiceName (ULONG FileId)
VOID	FsSetDeviceSpecific (ULONG FileId, VOID *Specific)
VOID *	FsGetDeviceSpecific (ULONG FileId)
ULONG	FsGetDeviceId (ULONG FileId)
VOID	FsInit (VOID)

Variables
static FILEDATA	FileData [MAX_FDS]
static LIST_ENTRY	DeviceListHead

Macro Definition Documentation

TAG_DEVICE

#define TAG_DEVICE   'vDsF'

Definition at line 31 of file fs.c.

TAG_DEVICE_NAME

#define TAG_DEVICE_NAME   'NDsF'

Definition at line 30 of file fs.c.

Typedef Documentation

DEVICE

typedef struct tagDEVICE DEVICE

FILEDATA

typedef struct tagFILEDATA FILEDATA

Function Documentation

ArcClose()

ARC_STATUS ArcClose

(

ULONG

FileId

)

Definition at line 220 of file fs.c.

{
    ARC_STATUS Status;
 
    if (FileId >= MAX_FDS || !FileData[FileId].FuncTable)
        return EBADF;
 
    Status = FileData[FileId].FuncTable->Close(FileId);
 
    if (Status == ESUCCESS)
    {
        FileData[FileId].FuncTable = NULL;
        FileData[FileId].Specific = NULL;
        FileData[FileId].DeviceId = -1;
    }
    return Status;
}

Referenced by InfOpenFile(), IniFileInitialize(), InitOperatingSystemList(), PeLdrLoadImage(), RamDiskLoadVirtualFile(), RegLoadHiveLog(), SpiScanDevice(), WinLdrLoadModule(), WinLdrLoadNLSData(), and WinLdrLoadSystemHive().

ArcGetFileInformation()

ARC_STATUS ArcGetFileInformation	(	ULONG	FileId,
		FILEINFORMATION *	Information
	)

Definition at line 252 of file fs.c.

{
    if (FileId >= MAX_FDS || !FileData[FileId].FuncTable)
        return EBADF;
    return FileData[FileId].FuncTable->GetFileInformation(FileId, Information);
}

Referenced by FatMount(), InfOpenFile(), IniFileInitialize(), RamDiskLoadVirtualFile(), RegLoadHiveLog(), WinLdrLoadModule(), WinLdrLoadNLSData(), and WinLdrLoadSystemHive().

ArcOpen()

ARC_STATUS ArcOpen	(	CHAR *	Path,
		OPENMODE	OpenMode,
		ULONG *	FileId
	)

Definition at line 56 of file fs.c.

{
    ARC_STATUS Status;
    ULONG Count, i;
    PLIST_ENTRY pEntry;
    DEVICE* pDevice;
    CHAR* DeviceName;
    CHAR* FileName;
    CHAR* p;
    CHAR* q;
    SIZE_T Length;
    OPENMODE DeviceOpenMode;
    ULONG DeviceId;
 
    /* Print status message */
    TRACE("Opening file '%s'...\n", Path);
 
    *FileId = MAX_FDS;
 
    /* Search last ')', which delimits device and path */
    FileName = strrchr(Path, ')');
    if (!FileName)
        return EINVAL;
    FileName++;
 
    /* Count number of "()", which needs to be replaced by "(0)" */
    Count = 0;
    for (p = Path; p != FileName; p++)
    {
        if (*p == '(' && *(p + 1) == ')')
            Count++;
    }
 
    /* Duplicate device name, and replace "()" by "(0)" (if required) */
    Length = FileName - Path + Count;
    if (Count != 0)
    {
        DeviceName = FrLdrTempAlloc(FileName - Path + Count, TAG_DEVICE_NAME);
        if (!DeviceName)
            return ENOMEM;
        for (p = Path, q = DeviceName; p != FileName; p++)
        {
            *q++ = *p;
            if (*p == '(' && *(p + 1) == ')')
                *q++ = '0';
        }
    }
    else
    {
        DeviceName = Path;
    }
 
    /* Search for the device */
    if (OpenMode == OpenReadOnly || OpenMode == OpenWriteOnly)
        DeviceOpenMode = OpenMode;
    else
        DeviceOpenMode = OpenReadWrite;
 
    pEntry = DeviceListHead.Flink;
    while (pEntry != &DeviceListHead)
    {
        pDevice = CONTAINING_RECORD(pEntry, DEVICE, ListEntry);
        if (strncmp(pDevice->Prefix, DeviceName, Length) == 0)
        {
            /* OK, device found. It is already opened? */
            if (pDevice->ReferenceCount == 0)
            {
                /* Search some room for the device */
                for (DeviceId = 0; DeviceId < MAX_FDS; DeviceId++)
                {
                    if (!FileData[DeviceId].FuncTable)
                        break;
                }
                if (DeviceId == MAX_FDS)
                    return EMFILE;
 
                /* Try to open the device */
                FileData[DeviceId].FuncTable = pDevice->FuncTable;
                Status = pDevice->FuncTable->Open(pDevice->Prefix, DeviceOpenMode, &DeviceId);
                if (Status != ESUCCESS)
                {
                    FileData[DeviceId].FuncTable = NULL;
                    return Status;
                }
                else if (!*FileName)
                {
                    /* Done, caller wanted to open the raw device */
                    *FileId = DeviceId;
                    pDevice->ReferenceCount++;
                    return ESUCCESS;
                }
 
                /* Try to detect the file system */
#ifndef _M_ARM
                FileData[DeviceId].FileFuncTable = IsoMount(DeviceId);
                if (!FileData[DeviceId].FileFuncTable)
#endif
                    FileData[DeviceId].FileFuncTable = FatMount(DeviceId);
                if (!FileData[DeviceId].FileFuncTable)
                    FileData[DeviceId].FileFuncTable = BtrFsMount(DeviceId);
#ifndef _M_ARM
                if (!FileData[DeviceId].FileFuncTable)
                    FileData[DeviceId].FileFuncTable = NtfsMount(DeviceId);
                if (!FileData[DeviceId].FileFuncTable)
                    FileData[DeviceId].FileFuncTable = Ext2Mount(DeviceId);
#endif
#if defined(_M_IX86) || defined(_M_AMD64)
#ifndef UEFIBOOT
                if (!FileData[DeviceId].FileFuncTable)
                    FileData[DeviceId].FileFuncTable = PxeMount(DeviceId);
#endif
#endif
                if (!FileData[DeviceId].FileFuncTable)
                {
                    /* Error, unable to detect file system */
                    pDevice->FuncTable->Close(DeviceId);
                    FileData[DeviceId].FuncTable = NULL;
                    return ENODEV;
                }
 
                pDevice->DeviceId = DeviceId;
            }
            else
            {
                DeviceId = pDevice->DeviceId;
            }
            pDevice->ReferenceCount++;
            break;
        }
        pEntry = pEntry->Flink;
    }
    if (pEntry == &DeviceListHead)
        return ENODEV;
 
    /* At this point, device is found and opened. Its file id is stored
     * in DeviceId, and FileData[DeviceId].FileFuncTable contains what
     * needs to be called to open the file */
 
    /* Search some room for the device */
    for (i = 0; i < MAX_FDS; i++)
    {
        if (!FileData[i].FuncTable)
            break;
    }
    if (i == MAX_FDS)
        return EMFILE;
 
    /* Skip leading path separator, if any */
    if (*FileName == '\\' || *FileName == '/')
        FileName++;
 
    /* Open the file */
    FileData[i].FuncTable = FileData[DeviceId].FileFuncTable;
    FileData[i].DeviceId = DeviceId;
    *FileId = i;
    Status = FileData[i].FuncTable->Open(FileName, OpenMode, FileId);
    if (Status != ESUCCESS)
    {
        FileData[i].FuncTable = NULL;
        *FileId = MAX_FDS;
    }
    return Status;
}

Referenced by FsOpenFile(), InfOpenFile(), InitOperatingSystemList(), PeLdrLoadImage(), RegLoadHiveLog(), SpiScanDevice(), WinLdrLoadModule(), WinLdrLoadNLSData(), and WinLdrLoadSystemHive().

ArcRead()

ARC_STATUS ArcRead	(	ULONG	FileId,
		VOID *	Buffer,
		ULONG	N,
		ULONG *	Count
	)

Definition at line 238 of file fs.c.

{
    if (FileId >= MAX_FDS || !FileData[FileId].FuncTable)
        return EBADF;
    return FileData[FileId].FuncTable->Read(FileId, Buffer, N, Count);
}

Referenced by disk_read(), Ext2Mount(), Ext2ReadSuperBlock(), Ext2ReadVolumeSectors(), FatMount(), FatReadVolumeSectors(), InfOpenFile(), IniFileInitialize(), IopReadBootRecord(), IsoBufferDirectory(), IsoLookupFile(), IsoMount(), IsoRead(), NtfsDiskRead(), NtfsMount(), PeLdrLoadImage(), RamDiskLoadVirtualFile(), RegLoadHiveLog(), WinLdrLoadModule(), WinLdrLoadNLSData(), and WinLdrLoadSystemHive().

ArcSeek()

ARC_STATUS ArcSeek	(	ULONG	FileId,
		LARGE_INTEGER *	Position,
		SEEKMODE	SeekMode
	)

Definition at line 245 of file fs.c.

{
    if (FileId >= MAX_FDS || !FileData[FileId].FuncTable)
        return EBADF;
    return FileData[FileId].FuncTable->Seek(FileId, Position, SeekMode);
}

Referenced by disk_read(), Ext2Mount(), Ext2ReadSuperBlock(), Ext2ReadVolumeSectors(), FatMount(), FatReadVolumeSectors(), IopReadBootRecord(), IsoBufferDirectory(), IsoLookupFile(), IsoMount(), IsoRead(), NtfsDiskRead(), NtfsMount(), PeLdrLoadImage(), RamDiskLoadVirtualFile(), and RegLoadHiveLog().

DBG_DEFAULT_CHANNEL()

DBG_DEFAULT_CHANNEL

(

FILESYSTEM

)

FileSystemError()

VOID FileSystemError

(

PCSTR

ErrorString

)

Definition at line 261 of file fs.c.

{
    ERR("%s\n", ErrorString);
    UiMessageBox(ErrorString);
}

Referenced by Ext2LookupFile(), Ext2ReadBlock(), Ext2ReadDirectory(), Ext2ReadFileBig(), Ext2ReadGroupDescriptors(), Ext2ReadInode(), Ext2ReadSuperBlock(), Ext2SearchDirectoryBufferForFile(), FatOpenVolume(), and NtfsMount().

FsGetDeviceId()

ULONG FsGetDeviceId

(

ULONG

FileId

)

Definition at line 425 of file fs.c.

{
    if (FileId >= MAX_FDS)
        return (ULONG)-1;
    return FileData[FileId].DeviceId;
}

Referenced by BtrFsOpen(), Ext2Open(), FatOpen(), IsoOpen(), IsoRead(), and NtfsOpen().

FsGetDeviceSpecific()

VOID * FsGetDeviceSpecific

(

ULONG

FileId

)

Definition at line 418 of file fs.c.

{
    if (FileId >= MAX_FDS || !FileData[FileId].FuncTable)
        return NULL;
    return FileData[FileId].Specific;
}

Referenced by BtrFsClose(), BtrFsGetFileInformation(), BtrFsRead(), BtrFsSeek(), DiskClose(), DiskGetFileInformation(), DiskRead(), DiskSeek(), Ext2Close(), Ext2GetFileInformation(), Ext2Read(), Ext2Seek(), FatClose(), FatGetFileInformation(), FatRead(), FatSeek(), IsoClose(), IsoGetFileInformation(), IsoRead(), IsoSeek(), NtfsClose(), NtfsGetFileInformation(), NtfsRead(), NtfsSeek(), UefiDiskClose(), UefiDiskGetFileInformation(), UefiDiskRead(), and UefiDiskSeek().

FsGetFirstNameFromPath()

VOID FsGetFirstNameFromPath	(	PCHAR	Buffer,
		PCSTR	Path
	)

Definition at line 358 of file fs.c.

{
    size_t i;
    size_t len;
 
    len = strlen(Path);
 
    // Copy all the characters up to the end of the
    // string or until we hit a '\' character
    // and put them in Buffer
    for (i = 0; i < len; i++)
    {
        if ((Path[i] == '\\') || (Path[i] == '/'))
        {
            break;
        }
        else
        {
            Buffer[i] = Path[i];
        }
    }
 
    Buffer[i] = 0;
 
    TRACE("FsGetFirstNameFromPath() Path = %s FirstName = %s\n", Path, Buffer);
}

Referenced by Ext2LookupFile(), FatLookupFile(), IsoLookupFile(), and NtfsLookupFile().

FsGetNumPathParts()

ULONG FsGetNumPathParts

(

PCSTR

Path

)

Definition at line 330 of file fs.c.

{
    size_t i;
    size_t len;
    ULONG  num;
 
    len = strlen(Path);
 
    for (i = 0, num = 0; i < len; i++)
    {
        if ((Path[i] == '\\') || (Path[i] == '/'))
        {
            num++;
        }
    }
    num++;
 
    TRACE("FsGetNumPathParts() Path = %s NumPathParts = %d\n", Path, num);
 
    return num;
}

Referenced by Ext2LookupFile(), FatLookupFile(), IsoLookupFile(), and NtfsLookupFile().

FsGetServiceName()

PCWSTR FsGetServiceName

(

ULONG

FileId

)

Definition at line 404 of file fs.c.

{
    if (FileId >= MAX_FDS || !FileData[FileId].FuncTable)
        return NULL;
    return FileData[FileId].FuncTable->ServiceName;
}

Referenced by WinLdrLoadSystemHive().

FsInit()

VOID FsInit

(

VOID

)

Definition at line 432 of file fs.c.

{
    ULONG i;
 
    RtlZeroMemory(FileData, sizeof(FileData));
    for (i = 0; i < MAX_FDS; i++)
        FileData[i].DeviceId = (ULONG)-1;
 
    InitializeListHead(&DeviceListHead);
}

Referenced by BootMain(), and EfiEntry().

FsOpenFile()

ARC_STATUS FsOpenFile	(	IN PCSTR	FileName,
		IN PCSTR DefaultPath	OPTIONAL,
		IN OPENMODE	OpenMode,
		OUT PULONG	FileId
	)

Definition at line 268 of file fs.c.

{
    NTSTATUS Status;
    SIZE_T cchPathLen;
    CHAR FullPath[MAX_PATH] = "";
 
    /*
     * Check whether FileName is a full path and if not, create a full
     * file name using the user-provided default path (if present).
     *
     * See ArcOpen(): Search last ')', which delimits device and path.
     */
    if (strrchr(FileName, ')') == NULL)
    {
        /* This is not a full path: prepend the user-provided default path */
        if (DefaultPath)
        {
            Status = RtlStringCbCopyA(FullPath, sizeof(FullPath), DefaultPath);
            if (!NT_SUCCESS(Status))
                return ENAMETOOLONG;
        }
 
        /* Append a path separator if needed */
 
        cchPathLen = min(sizeof(FullPath)/sizeof(CHAR), strlen(FullPath));
        if (cchPathLen >= sizeof(FullPath)/sizeof(CHAR))
            return ENAMETOOLONG;
 
        if ((*FileName != '\\' && *FileName != '/') &&
            cchPathLen > 0 && (FullPath[cchPathLen-1] != '\\' && FullPath[cchPathLen-1] != '/'))
        {
            /* FileName does not start with '\' and FullPath does not end with '\' */
            Status = RtlStringCbCatA(FullPath, sizeof(FullPath), "\\");
            if (!NT_SUCCESS(Status))
                return ENAMETOOLONG;
        }
        else if ((*FileName == '\\' || *FileName == '/') &&
                 cchPathLen > 0 && (FullPath[cchPathLen-1] == '\\' || FullPath[cchPathLen-1] == '/'))
        {
            /* FileName starts with '\' and FullPath ends with '\' */
            while (*FileName == '\\' || *FileName == '/')
                ++FileName; // Skip any backslash
        }
    }
    /* Append (or just copy) the remaining file name */
    Status = RtlStringCbCatA(FullPath, sizeof(FullPath), FileName);
    if (!NT_SUCCESS(Status))
        return ENAMETOOLONG;
 
    /* Open the file */
    return ArcOpen(FullPath, OpenMode, FileId);
}

Referenced by IniFileInitialize(), and RamDiskLoadVirtualFile().

FsRegisterDevice()

VOID FsRegisterDevice	(	CHAR *	Prefix,
		const DEVVTBL *	FuncTable
	)

Definition at line 385 of file fs.c.

{
    DEVICE* pNewEntry;
    SIZE_T Length;
 
    TRACE("FsRegisterDevice() Prefix = %s\n", Prefix);
 
    Length = strlen(Prefix) + 1;
    pNewEntry = FrLdrTempAlloc(sizeof(DEVICE) + Length, TAG_DEVICE);
    if (!pNewEntry)
        return;
    pNewEntry->FuncTable = FuncTable;
    pNewEntry->ReferenceCount = 0;
    pNewEntry->Prefix = (CHAR*)(pNewEntry + 1);
    RtlCopyMemory(pNewEntry->Prefix, Prefix, Length);
 
    InsertHeadList(&DeviceListHead, &pNewEntry->ListEntry);
}

Referenced by GetHarddiskInformation(), PcInitializeBootDevices(), PxeInit(), RamDiskInitialize(), SpiScanAdapter(), SpiScanDevice(), and UefiInitializeBootDevices().

FsSetDeviceSpecific()

VOID FsSetDeviceSpecific	(	ULONG	FileId,
		VOID *	Specific
	)

Definition at line 411 of file fs.c.

{
    if (FileId >= MAX_FDS || !FileData[FileId].FuncTable)
        return;
    FileData[FileId].Specific = Specific;
}

Referenced by BtrFsOpen(), DiskOpen(), Ext2Open(), FatOpen(), IsoOpen(), NtfsOpen(), and UefiDiskOpen().

Variable Documentation

DeviceListHead

LIST_ENTRY DeviceListHead

static

Definition at line 52 of file fs.c.

Referenced by ArcOpen(), FsInit(), FsRegisterDevice(), and IsaFdoRemoveDevice().

FileData

FILEDATA FileData[MAX_FDS]

static

Definition at line 51 of file fs.c.

Referenced by ArcClose(), ArcGetFileInformation(), ArcOpen(), ArcRead(), ArcSeek(), FsGetDeviceId(), FsGetDeviceSpecific(), FsGetServiceName(), FsInit(), FsSetDeviceSpecific(), get_sectionheader(), GetCoffInfo(), GetStabInfo(), load_file(), LoadSoundFiles(), main(), process_data(), process_file(), START_TEST(), and Test_GetFiles().