fsutil.h File Reference

#include <fmifs/fmifs.h>

Include dependency graph for fsutil.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	_FORMAT_VOLUME_INFO
struct	_CHECK_VOLUME_INFO

Macros
#define	FAT_BOOTSECTOR_SIZE   (1 * SECTORSIZE)
#define	FAT32_BOOTSECTOR_SIZE   (1 * SECTORSIZE)
#define	BTRFS_BOOTSECTOR_SIZE   (3 * SECTORSIZE)
#define	NTFS_BOOTSECTOR_SIZE   (16 * SECTORSIZE)
#define	InstallFat12BootCode   InstallFatBootCode
#define	InstallFat16BootCode   InstallFatBootCode

Typedefs
typedef IN HANDLE	DstPath
typedef IN HANDLE IN HANDLE	RootPartition
typedef enum _FSVOLNOTIFY	FSVOLNOTIFY
typedef enum _FSVOL_OP	FSVOL_OP
typedef struct _FORMAT_VOLUME_INFO	FORMAT_VOLUME_INFO
typedef struct _FORMAT_VOLUME_INFO *	PFORMAT_VOLUME_INFO
typedef struct _CHECK_VOLUME_INFO	CHECK_VOLUME_INFO
typedef struct _CHECK_VOLUME_INFO *	PCHECK_VOLUME_INFO
typedef FSVOL_OP(CALLBACK *	PFSVOL_CALLBACK) (_In_opt_ PVOID Context, _In_ FSVOLNOTIFY FormatStatus, _In_ ULONG_PTR Param1, _In_ ULONG_PTR Param2)

Enumerations
enum	_FSVOLNOTIFY {   FSVOLNOTIFY_STARTQUEUE = 0 , FSVOLNOTIFY_ENDQUEUE , FSVOLNOTIFY_STARTSUBQUEUE , FSVOLNOTIFY_ENDSUBQUEUE ,   FSVOLNOTIFY_PARTITIONERROR , FSVOLNOTIFY_STARTFORMAT , FSVOLNOTIFY_ENDFORMAT , FSVOLNOTIFY_FORMATERROR ,   FSVOLNOTIFY_STARTCHECK , FSVOLNOTIFY_ENDCHECK , FSVOLNOTIFY_CHECKERROR , ChangeSystemPartition }
enum	_FSVOL_OP {   FSVOL_FORMAT = 0 , FSVOL_CHECK , FSVOL_ABORT = 0 , FSVOL_DOIT ,   FSVOL_RETRY = FSVOL_DOIT , FSVOL_SKIP }

Functions
BOOLEAN	GetRegisteredFileSystems (IN ULONG Index, OUT PCWSTR *FileSystemName)
NTSTATUS	ChkdskFileSystem_UStr (_In_ PUNICODE_STRING DriveRoot, _In_ PCWSTR FileSystemName, _In_ BOOLEAN FixErrors, _In_ BOOLEAN Verbose, _In_ BOOLEAN CheckOnlyIfDirty, _In_ BOOLEAN ScanDrive, _In_opt_ PFMIFSCALLBACK Callback)
NTSTATUS	ChkdskFileSystem (_In_ PCWSTR DriveRoot, _In_ PCWSTR FileSystemName, _In_ BOOLEAN FixErrors, _In_ BOOLEAN Verbose, _In_ BOOLEAN CheckOnlyIfDirty, _In_ BOOLEAN ScanDrive, _In_opt_ PFMIFSCALLBACK Callback)
NTSTATUS	FormatFileSystem_UStr (_In_ PUNICODE_STRING DriveRoot, _In_ PCWSTR FileSystemName, _In_ FMIFS_MEDIA_FLAG MediaFlag, _In_opt_ PUNICODE_STRING Label, _In_ BOOLEAN QuickFormat, _In_ ULONG ClusterSize, _In_opt_ PFMIFSCALLBACK Callback)
NTSTATUS	FormatFileSystem (_In_ PCWSTR DriveRoot, _In_ PCWSTR FileSystemName, _In_ FMIFS_MEDIA_FLAG MediaFlag, _In_opt_ PCWSTR Label, _In_ BOOLEAN QuickFormat, _In_ ULONG ClusterSize, _In_opt_ PFMIFSCALLBACK Callback)
typedef	NTSTATUS (*PFS_INSTALL_BOOTCODE)(IN PCWSTR SrcPath
NTSTATUS	InstallFatBootCode (IN PCWSTR SrcPath, IN HANDLE DstPath, IN HANDLE RootPartition)
NTSTATUS	InstallFat32BootCode (IN PCWSTR SrcPath, IN HANDLE DstPath, IN HANDLE RootPartition)
NTSTATUS	InstallBtrfsBootCode (IN PCWSTR SrcPath, IN HANDLE DstPath, IN HANDLE RootPartition)
NTSTATUS	InstallNtfsBootCode (IN PCWSTR SrcPath, IN HANDLE DstPath, IN HANDLE RootPartition)
NTSTATUS	ChkdskPartition (_In_ PPARTENTRY PartEntry, _In_ BOOLEAN FixErrors, _In_ BOOLEAN Verbose, _In_ BOOLEAN CheckOnlyIfDirty, _In_ BOOLEAN ScanDrive, _In_opt_ PFMIFSCALLBACK Callback)
NTSTATUS	FormatPartition (_In_ PPARTENTRY PartEntry, _In_ PCWSTR FileSystemName, _In_ FMIFS_MEDIA_FLAG MediaFlag, _In_opt_ PCWSTR Label, _In_ BOOLEAN QuickFormat, _In_ ULONG ClusterSize, _In_opt_ PFMIFSCALLBACK Callback)
BOOLEAN	FsVolCommitOpsQueue (_In_ PPARTLIST PartitionList, _In_ PPARTENTRY SystemPartition, _In_ PPARTENTRY InstallPartition, _In_opt_ PFSVOL_CALLBACK FsVolCallback, _In_opt_ PVOID Context)

Macro Definition Documentation

BTRFS_BOOTSECTOR_SIZE

#define BTRFS_BOOTSECTOR_SIZE   (3 * SECTORSIZE)

Definition at line 70 of file fsutil.h.

FAT32_BOOTSECTOR_SIZE

#define FAT32_BOOTSECTOR_SIZE   (1 * SECTORSIZE)

Definition at line 69 of file fsutil.h.

FAT_BOOTSECTOR_SIZE

#define FAT_BOOTSECTOR_SIZE   (1 * SECTORSIZE)

Definition at line 68 of file fsutil.h.

InstallFat12BootCode

#define InstallFat12BootCode   InstallFatBootCode

Definition at line 85 of file fsutil.h.

InstallFat16BootCode

#define InstallFat16BootCode   InstallFatBootCode

Definition at line 86 of file fsutil.h.

NTFS_BOOTSECTOR_SIZE

#define NTFS_BOOTSECTOR_SIZE   (16 * SECTORSIZE)

Definition at line 71 of file fsutil.h.

Typedef Documentation

CHECK_VOLUME_INFO

typedef struct _CHECK_VOLUME_INFO CHECK_VOLUME_INFO

DstPath

typedef IN HANDLE DstPath

Definition at line 76 of file fsutil.h.

FORMAT_VOLUME_INFO

typedef struct _FORMAT_VOLUME_INFO FORMAT_VOLUME_INFO

FSVOL_OP

typedef enum _FSVOL_OP FSVOL_OP

FSVOLNOTIFY

typedef enum _FSVOLNOTIFY FSVOLNOTIFY

PCHECK_VOLUME_INFO

typedef struct _CHECK_VOLUME_INFO * PCHECK_VOLUME_INFO

PFORMAT_VOLUME_INFO

typedef struct _FORMAT_VOLUME_INFO * PFORMAT_VOLUME_INFO

PFSVOL_CALLBACK

typedef FSVOL_OP(CALLBACK * PFSVOL_CALLBACK) (_In_opt_ PVOID Context, _In_ FSVOLNOTIFY FormatStatus, _In_ ULONG_PTR Param1, _In_ ULONG_PTR Param2)

Definition at line 195 of file fsutil.h.

RootPartition

typedef IN HANDLE IN HANDLE RootPartition

Definition at line 77 of file fsutil.h.

Enumeration Type Documentation

_FSVOL_OP

enum _FSVOL_OP

Enumerator
FSVOL_FORMAT
FSVOL_CHECK
FSVOL_ABORT
FSVOL_DOIT
FSVOL_RETRY
FSVOL_SKIP

Definition at line 152 of file fsutil.h.

{
/* Operations ****/
    FSVOL_FORMAT = 0,
    FSVOL_CHECK,
/* Response actions ****/
    FSVOL_ABORT = 0,
    FSVOL_DOIT,
    FSVOL_RETRY = FSVOL_DOIT,
    FSVOL_SKIP,
} FSVOL_OP;

_FSVOLNOTIFY

enum _FSVOLNOTIFY

Enumerator
FSVOLNOTIFY_STARTQUEUE
FSVOLNOTIFY_ENDQUEUE
FSVOLNOTIFY_STARTSUBQUEUE
FSVOLNOTIFY_ENDSUBQUEUE
FSVOLNOTIFY_PARTITIONERROR
FSVOLNOTIFY_STARTFORMAT
FSVOLNOTIFY_ENDFORMAT
FSVOLNOTIFY_FORMATERROR
FSVOLNOTIFY_STARTCHECK
FSVOLNOTIFY_ENDCHECK
FSVOLNOTIFY_CHECKERROR
ChangeSystemPartition

Definition at line 135 of file fsutil.h.

{
    FSVOLNOTIFY_STARTQUEUE = 0,
    FSVOLNOTIFY_ENDQUEUE,
    FSVOLNOTIFY_STARTSUBQUEUE,
    FSVOLNOTIFY_ENDSUBQUEUE,
// FSVOLNOTIFY_STARTPARTITION, FSVOLNOTIFY_ENDPARTITION,
    FSVOLNOTIFY_PARTITIONERROR,
    FSVOLNOTIFY_STARTFORMAT,
    FSVOLNOTIFY_ENDFORMAT,
    FSVOLNOTIFY_FORMATERROR,
    FSVOLNOTIFY_STARTCHECK,
    FSVOLNOTIFY_ENDCHECK,
    FSVOLNOTIFY_CHECKERROR,
    ChangeSystemPartition // FIXME: Deprecate!
} FSVOLNOTIFY;

Function Documentation

ChkdskFileSystem()

NTSTATUS ChkdskFileSystem	(	_In_ PCWSTR	DriveRoot,
		_In_ PCWSTR	FileSystemName,
		_In_ BOOLEAN	FixErrors,
		_In_ BOOLEAN	Verbose,
		_In_ BOOLEAN	CheckOnlyIfDirty,
		_In_ BOOLEAN	ScanDrive,
		_In_opt_ PFMIFSCALLBACK	Callback
	)

Definition at line 287 of file fsutil.c.

{
    UNICODE_STRING DriveRootU;
 
    RtlInitUnicodeString(&DriveRootU, DriveRoot);
    return ChkdskFileSystem_UStr(&DriveRootU,
                                 FileSystemName,
                                 FixErrors,
                                 Verbose,
                                 CheckOnlyIfDirty,
                                 ScanDrive,
                                 Callback);
}

Referenced by ChkdskPartition().

ChkdskFileSystem_UStr()

NTSTATUS ChkdskFileSystem_UStr	(	_In_ PUNICODE_STRING	DriveRoot,
		_In_ PCWSTR	FileSystemName,
		_In_ BOOLEAN	FixErrors,
		_In_ BOOLEAN	Verbose,
		_In_ BOOLEAN	CheckOnlyIfDirty,
		_In_ BOOLEAN	ScanDrive,
		_In_opt_ PFMIFSCALLBACK	Callback
	)

ChkdskEx()

Definition at line 244 of file fsutil.c.

{
    PFILE_SYSTEM FileSystem;
    NTSTATUS Status;
    BOOLEAN Success;
 
    FileSystem = GetFileSystemByName(FileSystemName);
 
    if (!FileSystem || !FileSystem->ChkdskFunc)
    {
        // Success = FALSE;
        // Callback(DONE, 0, &Success);
        return STATUS_NOT_SUPPORTED;
    }
 
    Status = STATUS_SUCCESS;
    Success = FileSystem->ChkdskFunc(DriveRoot,
                                     Callback,
                                     FixErrors,
                                     Verbose,
                                     CheckOnlyIfDirty,
                                     ScanDrive,
                                     NULL,
                                     NULL,
                                     NULL,
                                     NULL,
                                     (PULONG)&Status);
    if (!Success)
        DPRINT1("ChkdskFunc() failed with Status 0x%lx\n", Status);
 
    // Callback(DONE, 0, &Success);
 
    return Status;
}

Referenced by ChkdskFileSystem().

ChkdskPartition()

NTSTATUS ChkdskPartition	(	_In_ PPARTENTRY	PartEntry,
		_In_ BOOLEAN	FixErrors,
		_In_ BOOLEAN	Verbose,
		_In_ BOOLEAN	CheckOnlyIfDirty,
		_In_ BOOLEAN	ScanDrive,
		_In_opt_ PFMIFSCALLBACK	Callback
	)

Definition at line 757 of file fsutil.c.

{
    PDISKENTRY DiskEntry = PartEntry->DiskEntry;
    // UNICODE_STRING PartitionRootPath;
    WCHAR PartitionRootPath[MAX_PATH]; // PathBuffer
 
    ASSERT(PartEntry->IsPartitioned && PartEntry->PartitionNumber != 0);
 
    /* Do not check a partition with an unknown file system */
    if (!*PartEntry->FileSystem)
        return STATUS_UNRECOGNIZED_VOLUME; // STATUS_NOT_SUPPORTED;
 
    /* Set PartitionRootPath */
    RtlStringCchPrintfW(PartitionRootPath, ARRAYSIZE(PartitionRootPath),
                        L"\\Device\\Harddisk%lu\\Partition%lu",
                        DiskEntry->DiskNumber,
                        PartEntry->PartitionNumber);
    DPRINT("PartitionRootPath: %S\n", PartitionRootPath);
 
    /* Check the partition */
    return ChkdskFileSystem(PartitionRootPath,
                            PartEntry->FileSystem,
                            FixErrors,
                            Verbose,
                            CheckOnlyIfDirty,
                            ScanDrive,
                            Callback);
}

Referenced by DoChecking().

FormatFileSystem()

NTSTATUS FormatFileSystem	(	_In_ PCWSTR	DriveRoot,
		_In_ PCWSTR	FileSystemName,
		_In_ FMIFS_MEDIA_FLAG	MediaFlag,
		_In_opt_ PCWSTR	Label,
		_In_ BOOLEAN	QuickFormat,
		_In_ ULONG	ClusterSize,
		_In_opt_ PFMIFSCALLBACK	Callback
	)

Definition at line 376 of file fsutil.c.

{
    UNICODE_STRING DriveRootU;
    UNICODE_STRING LabelU;
 
    RtlInitUnicodeString(&DriveRootU, DriveRoot);
    RtlInitUnicodeString(&LabelU, Label);
 
    return FormatFileSystem_UStr(&DriveRootU,
                                 FileSystemName,
                                 MediaFlag,
                                 &LabelU,
                                 QuickFormat,
                                 ClusterSize,
                                 Callback);
}

Referenced by FormatPartition(), and InstallFatBootcodeToFloppy().

FormatFileSystem_UStr()

NTSTATUS FormatFileSystem_UStr	(	_In_ PUNICODE_STRING	DriveRoot,
		_In_ PCWSTR	FileSystemName,
		_In_ FMIFS_MEDIA_FLAG	MediaFlag,
		_In_opt_ PUNICODE_STRING	Label,
		_In_ BOOLEAN	QuickFormat,
		_In_ ULONG	ClusterSize,
		_In_opt_ PFMIFSCALLBACK	Callback
	)

FormatEx()

Definition at line 311 of file fsutil.c.

{
    PFILE_SYSTEM FileSystem;
    BOOLEAN Success;
    BOOLEAN BackwardCompatible = FALSE; // Default to latest FS versions.
    MEDIA_TYPE MediaType;
 
    FileSystem = GetFileSystemByName(FileSystemName);
 
    if (!FileSystem || !FileSystem->FormatFunc)
    {
        // Success = FALSE;
        // Callback(DONE, 0, &Success);
        return STATUS_NOT_SUPPORTED;
    }
 
    /* Set the BackwardCompatible flag in case we format with older FAT12/16 */
    if (_wcsicmp(FileSystemName, L"FAT") == 0)
        BackwardCompatible = TRUE;
    // else if (_wcsicmp(FileSystemName, L"FAT32") == 0)
        // BackwardCompatible = FALSE;
 
    /* Convert the FMIFS MediaFlag to a NT MediaType */
    // FIXME: Actually covert all the possible flags.
    switch (MediaFlag)
    {
    case FMIFS_FLOPPY:
        MediaType = F5_320_1024; // FIXME: This is hardfixed!
        break;
    case FMIFS_REMOVABLE:
        MediaType = RemovableMedia;
        break;
    case FMIFS_HARDDISK:
        MediaType = FixedMedia;
        break;
    default:
        DPRINT1("Unknown FMIFS MediaFlag %d, converting 1-to-1 to NT MediaType\n",
                MediaFlag);
        MediaType = (MEDIA_TYPE)MediaFlag;
        break;
    }
 
    Success = FileSystem->FormatFunc(DriveRoot,
                                     Callback,
                                     QuickFormat,
                                     BackwardCompatible,
                                     MediaType,
                                     Label,
                                     ClusterSize);
    if (!Success)
        DPRINT1("FormatFunc() failed\n");
 
    // Callback(DONE, 0, &Success);
 
    return (Success ? STATUS_SUCCESS : STATUS_UNSUCCESSFUL);
}

Referenced by FormatFileSystem().

FormatPartition()

NTSTATUS FormatPartition	(	_In_ PPARTENTRY	PartEntry,
		_In_ PCWSTR	FileSystemName,
		_In_ FMIFS_MEDIA_FLAG	MediaFlag,
		_In_opt_ PCWSTR	Label,
		_In_ BOOLEAN	QuickFormat,
		_In_ ULONG	ClusterSize,
		_In_opt_ PFMIFSCALLBACK	Callback
	)

Definition at line 793 of file fsutil.c.

{
    NTSTATUS Status;
    PDISKENTRY DiskEntry = PartEntry->DiskEntry;
    UCHAR PartitionType;
    // UNICODE_STRING PartitionRootPath;
    WCHAR PartitionRootPath[MAX_PATH]; // PathBuffer
 
    ASSERT(PartEntry->IsPartitioned && PartEntry->PartitionNumber != 0);
 
    if (!FileSystemName || !*FileSystemName)
    {
        DPRINT1("No file system specified?\n");
        return STATUS_UNRECOGNIZED_VOLUME;
    }
 
    /*
     * Prepare the partition for formatting (for MBR disks, reset the
     * partition type), and adjust the file system name in case of FAT
     * vs. FAT32, depending on the geometry of the partition.
     */
 
// FIXME: Do this only if QuickFormat == FALSE? What about FAT handling?
 
    /*
     * Retrieve a partition type as a hint only. It will be used to determine
     * whether to actually use FAT12/16 or FAT32 file system, depending on the
     * geometry of the partition. If the partition resides on an MBR disk,
     * the partition style will be reset to this value as well, unless the
     * partition is OEM.
     */
    PartitionType = FileSystemToMBRPartitionType(FileSystemName,
                                                 PartEntry->StartSector.QuadPart,
                                                 PartEntry->SectorCount.QuadPart);
    if (PartitionType == PARTITION_ENTRY_UNUSED)
    {
        /* Unknown file system */
        DPRINT1("Unknown file system '%S'\n", FileSystemName);
        return STATUS_UNRECOGNIZED_VOLUME;
    }
 
    /* Reset the MBR partition type, unless this is an OEM partition */
    if (DiskEntry->DiskStyle == PARTITION_STYLE_MBR)
    {
        if (!IsOEMPartition(PartEntry->PartitionType))
            SetMBRPartitionType(PartEntry, PartitionType);
    }
 
    /*
     * Adjust the file system name in case of FAT vs. FAT32, according to
     * the type of partition returned by FileSystemToMBRPartitionType().
     */
    if (_wcsicmp(FileSystemName, L"FAT") == 0)
    {
        if ((PartitionType == PARTITION_FAT32) ||
            (PartitionType == PARTITION_FAT32_XINT13))
        {
            FileSystemName = L"FAT32";
        }
    }
 
    /* Commit the partition changes to the disk */
    Status = WritePartitions(DiskEntry);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("WritePartitions(disk %lu) failed, Status 0x%08lx\n",
                DiskEntry->DiskNumber, Status);
        return STATUS_PARTITION_FAILURE;
    }
 
    /* Set PartitionRootPath */
    RtlStringCchPrintfW(PartitionRootPath, ARRAYSIZE(PartitionRootPath),
                        L"\\Device\\Harddisk%lu\\Partition%lu",
                        DiskEntry->DiskNumber,
                        PartEntry->PartitionNumber);
    DPRINT("PartitionRootPath: %S\n", PartitionRootPath);
 
    /* Format the partition */
    Status = FormatFileSystem(PartitionRootPath,
                              FileSystemName,
                              MediaFlag,
                              Label,
                              QuickFormat,
                              ClusterSize,
                              Callback);
    if (!NT_SUCCESS(Status))
        return Status;
 
//
// TODO: Here, call a partlist.c function that update the actual
// FS name and the label fields of the volume.
//
    PartEntry->FormatState = Formatted;
 
    /* Set the new partition's file system proper */
    RtlStringCbCopyW(PartEntry->FileSystem,
                     sizeof(PartEntry->FileSystem),
                     FileSystemName);
 
    PartEntry->New = FALSE;
 
    return STATUS_SUCCESS;
}

Referenced by DoFormatting().

FsVolCommitOpsQueue()

BOOLEAN FsVolCommitOpsQueue	(	_In_ PPARTLIST	PartitionList,
		_In_ PPARTENTRY	SystemPartition,
		_In_ PPARTENTRY	InstallPartition,
		_In_opt_ PFSVOL_CALLBACK	FsVolCallback,
		_In_opt_ PVOID	Context
	)

HACK!!

END HACK!!

Definition at line 1137 of file fsutil.c.

{
    BOOLEAN Success = TRUE; // Suppose success originally.
    FSVOL_OP Result;
    PPARTENTRY PartEntry;
 
    /* Machine state for the format step */
    typedef enum _FORMATMACHINESTATE
    {
        Start,
        FormatSystemVolume,
        FormatInstallVolume,
        FormatOtherVolume,
        FormatDone
    } FORMATMACHINESTATE;
    FORMATMACHINESTATE FormatState, OldFormatState;
    static const PCSTR FormatStateNames[] = {
        "Start",
        "FormatSystemVolume",
        "FormatInstallVolume",
        "FormatOtherVolume",
        "FormatDone"
    };
 
    ASSERT(PartitionList && InstallPartition && SystemPartition);
 
    /* Commit all partition changes to all the disks */
    if (!WritePartitionsToDisk(PartitionList))
    {
        DPRINT("WritePartitionsToDisk() failed\n");
        /* Result = */ FsVolCallback(Context,
                            FSVOLNOTIFY_PARTITIONERROR,
                            STATUS_PARTITION_FAILURE, // FIXME
                            0);
        return FALSE;
    }
 
//
// FIXME: Should we do the following here, or in the caller?
//
    /*
     * In all cases, whether or not we are going to perform a formatting,
     * we must perform a file system check of both the system and the
     * installation volumes.
     */
    SystemPartition->NeedsCheck = TRUE;
    InstallPartition->NeedsCheck = TRUE;
 
    Result = FsVolCallback(Context,
                           FSVOLNOTIFY_STARTQUEUE,
                           0, 0);
    if (Result == FSVOL_ABORT)
        return FALSE;
 
    /*
     * Commit the Format queue
     */
 
    Result = FsVolCallback(Context,
                           FSVOLNOTIFY_STARTSUBQUEUE,
                           FSVOL_FORMAT,
                           0);
    if (Result == FSVOL_ABORT)
        return FALSE;
    if (Result == FSVOL_SKIP)
        goto StartCheckQueue;
    /* Reset the formatter machine state */
    FormatState = Start;
NextFormat:
    PartEntry = NULL;
    OldFormatState = FormatState;
    switch (FormatState)
    {
        case Start:
        {
            /*
             * We start by formatting the system volume in case it is new
             * (it didn't exist before) and is not the same as the installation
             * volume. Otherwise we just require a file system check on it,
             * and start by formatting the installation volume instead.
             */
            ASSERT(SystemPartition->IsPartitioned);
            if (SystemPartition != InstallPartition)
            {
                PartEntry = SystemPartition;
 
                if (PartEntry->FormatState == Unformatted)
                {
                    // TODO: Should we let the user use a custom file system,
                    // or should we always use FAT(32) for it?
                    // For "compatibility", FAT(32) would be best indeed.
 
                    FormatState = FormatSystemVolume;
                    DPRINT1("FormatState: %s --> %s\n",
                            FormatStateNames[OldFormatState], FormatStateNames[FormatState]);
                    break;
                }
 
                /* The system volume is separate, so it had better be formatted! */
                ASSERT((PartEntry->FormatState == Preformatted) ||
                       (PartEntry->FormatState == Formatted));
 
                /* Require a file system check on the system volume too */
                PartEntry->NeedsCheck = TRUE;
            }
            __fallthrough;
        }
 
        case FormatSystemVolume:
        {
            PartEntry = InstallPartition;
 
            FormatState = FormatInstallVolume;
            DPRINT1("FormatState: %s --> %s\n",
                    FormatStateNames[OldFormatState], FormatStateNames[FormatState]);
            break;
        }
 
        case FormatInstallVolume:
        case FormatOtherVolume:
        {
            BOOLEAN Found = GetNextUnformattedPartition(PartitionList, &PartEntry);
            if (Found) ASSERT(PartEntry);
 
            FormatState = (PartEntry ? FormatOtherVolume : FormatDone);
            DPRINT1("FormatState: %s --> %s\n",
                    FormatStateNames[OldFormatState], FormatStateNames[FormatState]);
            if (Found)
                break;
            __fallthrough;
        }
 
        case FormatDone:
        {
            DPRINT1("FormatState: FormatDone\n");
            Success = TRUE;
            goto EndFormat;
        }
        DEFAULT_UNREACHABLE;
    }
 
    ASSERT(PartEntry);
    Result = DoFormatting(PartEntry, Context, FsVolCallback);
    if (Result == FSVOL_ABORT)
    {
        Success = FALSE;
        goto Quit;
    }
    /* Schedule a check for this volume */
    PartEntry->NeedsCheck = TRUE;
    /* Go to the next volume to be formatted */
    goto NextFormat;
 
EndFormat:
    FsVolCallback(Context,
                  FSVOLNOTIFY_ENDSUBQUEUE,
                  FSVOL_FORMAT,
                  0);
 
 
    /*
     * Commit the CheckFS queue
     */
 
StartCheckQueue:
    Result = FsVolCallback(Context,
                           FSVOLNOTIFY_STARTSUBQUEUE,
                           FSVOL_CHECK,
                           0);
    if (Result == FSVOL_ABORT)
        return FALSE;
 
NextCheck:
    if (!GetNextUncheckedPartition(PartitionList, &PartEntry))
    {
        Success = TRUE;
        goto EndCheck;
    }
 
    ASSERT(PartEntry);
    Result = DoChecking(PartEntry, Context, FsVolCallback);
    if (Result == FSVOL_ABORT)
    {
        Success = FALSE;
        goto Quit;
    }
    /* Go to the next volume to be checked */
    goto NextCheck;
 
EndCheck:
    FsVolCallback(Context,
                  FSVOLNOTIFY_ENDSUBQUEUE,
                  FSVOL_CHECK,
                  0);
 
 
Quit:
    /* All the queues have been committed */
    FsVolCallback(Context,
                  FSVOLNOTIFY_ENDQUEUE,
                  Success,
                  0);
    return Success;
}

Referenced by StartPartitionOperationsPage().

GetRegisteredFileSystems()

BOOLEAN GetRegisteredFileSystems	(	IN ULONG	Index,
		OUT PCWSTR *	FileSystemName
	)

QueryAvailableFileSystemFormat()

Definition at line 182 of file fsutil.c.

{
    if (Index >= ARRAYSIZE(RegisteredFileSystems))
        return FALSE;
 
    *FileSystemName = RegisteredFileSystems[Index].FileSystemName;
 
    return TRUE;
}

Referenced by InitializeFileSystemList().

InstallBtrfsBootCode()

NTSTATUS InstallBtrfsBootCode	(	IN PCWSTR	SrcPath,
		IN HANDLE	DstPath,
		IN HANDLE	RootPartition
	)

Definition at line 585 of file fsutil.c.

{
    NTSTATUS Status;
    NTSTATUS LockStatus;
    UNICODE_STRING Name;
    IO_STATUS_BLOCK IoStatusBlock;
    LARGE_INTEGER FileOffset;
    PARTITION_INFORMATION_EX PartInfo;
    BOOTCODE NewBootSector = {0};
 
    /* Allocate and read the new bootsector from SrcPath */
    RtlInitUnicodeString(&Name, SrcPath);
    Status = ReadBootCodeFromFile(&NewBootSector,
                                  &Name,
                                  BTRFS_BOOTSECTOR_SIZE);
    if (!NT_SUCCESS(Status))
        return Status;
 
    /*
     * The BTRFS driver requires the volume to be locked in order to modify
     * the first sectors of the partition, even though they are outside the
     * file-system space / in the reserved area (they are situated before
     * the super-block at 0x1000) and is in principle allowed by the NT
     * storage stack.
     * So we lock here in order to write the bootsector at sector 0.
     * If locking fails, we ignore and continue nonetheless.
     */
    LockStatus = NtFsControlFile(DstPath,
                                 NULL,
                                 NULL,
                                 NULL,
                                 &IoStatusBlock,
                                 FSCTL_LOCK_VOLUME,
                                 NULL,
                                 0,
                                 NULL,
                                 0);
    if (!NT_SUCCESS(LockStatus))
    {
        DPRINT1("WARNING: Failed to lock BTRFS volume for writing bootsector! Operations may fail! (Status 0x%lx)\n", LockStatus);
    }
 
    /* Obtain partition info and write it to the bootsector */
    Status = NtDeviceIoControlFile(RootPartition,
                                   NULL,
                                   NULL,
                                   NULL,
                                   &IoStatusBlock,
                                   IOCTL_DISK_GET_PARTITION_INFO_EX,
                                   NULL,
                                   0,
                                   &PartInfo,
                                   sizeof(PartInfo));
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("IOCTL_DISK_GET_PARTITION_INFO_EX failed (Status %lx)\n", Status);
        goto Quit;
    }
 
    /* Write new bootsector to RootPath */
    ((PBTRFS_BOOTSECTOR)NewBootSector.BootCode)->PartitionStartLBA =
        PartInfo.StartingOffset.QuadPart / SECTORSIZE;
 
    /* Write sector 0 */
    FileOffset.QuadPart = 0ULL;
    Status = NtWriteFile(DstPath,
                         NULL,
                         NULL,
                         NULL,
                         &IoStatusBlock,
                         NewBootSector.BootCode,
                         NewBootSector.Length,
                         &FileOffset,
                         NULL);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("NtWriteFile() failed (Status %lx)\n", Status);
        goto Quit;
    }
 
Quit:
    /* Unlock the volume */
    LockStatus = NtFsControlFile(DstPath,
                                 NULL,
                                 NULL,
                                 NULL,
                                 &IoStatusBlock,
                                 FSCTL_UNLOCK_VOLUME,
                                 NULL,
                                 0,
                                 NULL,
                                 0);
    if (!NT_SUCCESS(LockStatus))
    {
        DPRINT1("Failed to unlock BTRFS volume (Status 0x%lx)\n", LockStatus);
    }
 
    /* Free the new bootsector */
    FreeBootCode(&NewBootSector);
 
    return Status;
}

Referenced by InstallBtrfsBootcodeToPartition().

InstallFat32BootCode()

NTSTATUS InstallFat32BootCode	(	IN PCWSTR	SrcPath,
		IN HANDLE	DstPath,
		IN HANDLE	RootPartition
	)

Definition at line 464 of file fsutil.c.

{
    NTSTATUS Status;
    UNICODE_STRING Name;
    IO_STATUS_BLOCK IoStatusBlock;
    LARGE_INTEGER FileOffset;
    USHORT BackupBootSector = 0;
    BOOTCODE OrigBootSector = {0};
    BOOTCODE NewBootSector  = {0};
 
    /* Allocate and read the current original partition bootsector */
    Status = ReadBootCodeByHandle(&OrigBootSector,
                                  RootPartition,
                                  FAT32_BOOTSECTOR_SIZE);
    if (!NT_SUCCESS(Status))
        return Status;
 
    /* Allocate and read the new bootsector (2 sectors) from SrcPath */
    RtlInitUnicodeString(&Name, SrcPath);
    Status = ReadBootCodeFromFile(&NewBootSector,
                                  &Name,
                                  2 * FAT32_BOOTSECTOR_SIZE);
    if (!NT_SUCCESS(Status))
    {
        FreeBootCode(&OrigBootSector);
        return Status;
    }
 
    /* Adjust the bootsector (copy a part of the FAT32 BPB) */
    RtlCopyMemory(&((PFAT32_BOOTSECTOR)NewBootSector.BootCode)->OemName,
                  &((PFAT32_BOOTSECTOR)OrigBootSector.BootCode)->OemName,
                  FIELD_OFFSET(FAT32_BOOTSECTOR, BootCodeAndData) -
                  FIELD_OFFSET(FAT32_BOOTSECTOR, OemName));
 
    /*
     * We know we copy the boot code to a file only when DstPath != RootPartition,
     * otherwise the boot code is copied to the specified root partition.
     */
    if (DstPath != RootPartition)
    {
        /* Copy to a file: Disable the backup bootsector */
        ((PFAT32_BOOTSECTOR)NewBootSector.BootCode)->BackupBootSector = 0;
    }
    else
    {
        /* Copy to a disk: Get the location of the backup bootsector */
        BackupBootSector = ((PFAT32_BOOTSECTOR)OrigBootSector.BootCode)->BackupBootSector;
    }
 
    /* Free the original bootsector */
    FreeBootCode(&OrigBootSector);
 
    /* Write the first sector of the new bootcode to DstPath sector 0 */
    FileOffset.QuadPart = 0ULL;
    Status = NtWriteFile(DstPath,
                         NULL,
                         NULL,
                         NULL,
                         &IoStatusBlock,
                         NewBootSector.BootCode,
                         FAT32_BOOTSECTOR_SIZE,
                         &FileOffset,
                         NULL);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("NtWriteFile() failed (Status %lx)\n", Status);
        FreeBootCode(&NewBootSector);
        return Status;
    }
 
    if (DstPath == RootPartition)
    {
        /* Copy to a disk: Write the backup bootsector */
        if ((BackupBootSector != 0x0000) && (BackupBootSector != 0xFFFF))
        {
            FileOffset.QuadPart = (ULONGLONG)((ULONG)BackupBootSector * FAT32_BOOTSECTOR_SIZE);
            Status = NtWriteFile(DstPath,
                                 NULL,
                                 NULL,
                                 NULL,
                                 &IoStatusBlock,
                                 NewBootSector.BootCode,
                                 FAT32_BOOTSECTOR_SIZE,
                                 &FileOffset,
                                 NULL);
            if (!NT_SUCCESS(Status))
            {
                DPRINT1("NtWriteFile() failed (Status %lx)\n", Status);
                FreeBootCode(&NewBootSector);
                return Status;
            }
        }
    }
 
    /* Write the second sector of the new bootcode to boot disk sector 14 */
    // FileOffset.QuadPart = (ULONGLONG)(14 * FAT32_BOOTSECTOR_SIZE);
    FileOffset.QuadPart = 14 * FAT32_BOOTSECTOR_SIZE;
    Status = NtWriteFile(DstPath,   // or really RootPartition ???
                         NULL,
                         NULL,
                         NULL,
                         &IoStatusBlock,
                         ((PUCHAR)NewBootSector.BootCode + FAT32_BOOTSECTOR_SIZE),
                         FAT32_BOOTSECTOR_SIZE,
                         &FileOffset,
                         NULL);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("NtWriteFile() failed (Status %lx)\n", Status);
    }
 
    /* Free the new bootsector */
    FreeBootCode(&NewBootSector);
 
    return Status;
}

Referenced by InstallFatBootcodeToPartition().

InstallFatBootCode()

NTSTATUS InstallFatBootCode	(	IN PCWSTR	SrcPath,
		IN HANDLE	DstPath,
		IN HANDLE	RootPartition
	)

Definition at line 406 of file fsutil.c.

{
    NTSTATUS Status;
    UNICODE_STRING Name;
    IO_STATUS_BLOCK IoStatusBlock;
    LARGE_INTEGER FileOffset;
    BOOTCODE OrigBootSector = {0};
    BOOTCODE NewBootSector  = {0};
 
    /* Allocate and read the current original partition bootsector */
    Status = ReadBootCodeByHandle(&OrigBootSector,
                                  RootPartition,
                                  FAT_BOOTSECTOR_SIZE);
    if (!NT_SUCCESS(Status))
        return Status;
 
    /* Allocate and read the new bootsector from SrcPath */
    RtlInitUnicodeString(&Name, SrcPath);
    Status = ReadBootCodeFromFile(&NewBootSector,
                                  &Name,
                                  FAT_BOOTSECTOR_SIZE);
    if (!NT_SUCCESS(Status))
    {
        FreeBootCode(&OrigBootSector);
        return Status;
    }
 
    /* Adjust the bootsector (copy a part of the FAT12/16 BPB) */
    RtlCopyMemory(&((PFAT_BOOTSECTOR)NewBootSector.BootCode)->OemName,
                  &((PFAT_BOOTSECTOR)OrigBootSector.BootCode)->OemName,
                  FIELD_OFFSET(FAT_BOOTSECTOR, BootCodeAndData) -
                  FIELD_OFFSET(FAT_BOOTSECTOR, OemName));
 
    /* Free the original bootsector */
    FreeBootCode(&OrigBootSector);
 
    /* Write the new bootsector to DstPath */
    FileOffset.QuadPart = 0ULL;
    Status = NtWriteFile(DstPath,
                         NULL,
                         NULL,
                         NULL,
                         &IoStatusBlock,
                         NewBootSector.BootCode,
                         NewBootSector.Length,
                         &FileOffset,
                         NULL);
 
    /* Free the new bootsector */
    FreeBootCode(&NewBootSector);
 
    return Status;
}

InstallNtfsBootCode()

NTSTATUS InstallNtfsBootCode	(	IN PCWSTR	SrcPath,
		IN HANDLE	DstPath,
		IN HANDLE	RootPartition
	)

Definition at line 692 of file fsutil.c.

{
    NTSTATUS Status;
    UNICODE_STRING Name;
    IO_STATUS_BLOCK IoStatusBlock;
    LARGE_INTEGER FileOffset;
    BOOTCODE OrigBootSector = {0};
    BOOTCODE NewBootSector  = {0};
 
    /* Allocate and read the current original partition bootsector */
    Status = ReadBootCodeByHandle(&OrigBootSector, RootPartition, NTFS_BOOTSECTOR_SIZE);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("InstallNtfsBootCode: Status %lx\n", Status);
        return Status;
    }
 
    /* Allocate and read the new bootsector (16 sectors) from SrcPath */
    RtlInitUnicodeString(&Name, SrcPath);
    Status = ReadBootCodeFromFile(&NewBootSector, &Name, NTFS_BOOTSECTOR_SIZE);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("InstallNtfsBootCode: Status %lx\n", Status);
        FreeBootCode(&OrigBootSector);
        return Status;
    }
 
    /* Adjust the bootsector (copy a part of the NTFS BPB) */
    RtlCopyMemory(&((PNTFS_BOOTSECTOR)NewBootSector.BootCode)->OEMID,
                  &((PNTFS_BOOTSECTOR)OrigBootSector.BootCode)->OEMID,
                  FIELD_OFFSET(NTFS_BOOTSECTOR, BootStrap) - FIELD_OFFSET(NTFS_BOOTSECTOR, OEMID));
 
    /* Write sector 0 */
    FileOffset.QuadPart = 0ULL;
    Status = NtWriteFile(DstPath,
                         NULL,
                         NULL,
                         NULL,
                         &IoStatusBlock,
                         NewBootSector.BootCode,
                         NewBootSector.Length,
                         &FileOffset,
                         NULL);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("NtWriteFile() failed (Status %lx)\n", Status);
        goto Quit;
    }
 
Quit:
    /* Free the new bootsector */
    FreeBootCode(&NewBootSector);
 
    return Status;
}

Referenced by InstallNtfsBootcodeToPartition().

NTSTATUS()

typedef NTSTATUS

(

*

PFS_INSTALL_BOOTCODE

)