bootmgr.c File Reference

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

Include dependency graph for bootmgr.c:

Go to the source code of this file.

Classes
struct	_OS_LOADING_METHOD

Typedefs
typedef VOID(*	EDIT_OS_ENTRY_PROC) (_Inout_ OperatingSystemItem *OperatingSystem)
typedef VOID(*	OS_MENU_PROC) (_Inout_ OperatingSystemItem *OperatingSystem)
typedef struct _OS_LOADING_METHOD	OS_LOADING_METHOD
typedef struct _OS_LOADING_METHOD *	POS_LOADING_METHOD

Functions
	DBG_DEFAULT_CHANNEL (WARNING)
static VOID	EditCustomBootReactOSSetup (_Inout_ OperatingSystemItem *OperatingSystem)
static VOID	EditCustomBootNTOS (_Inout_ OperatingSystemItem *OperatingSystem)
static const OS_LOADING_METHOD *	GetOSLoadingMethod (_In_ ULONG_PTR SectionId)
static PCHAR *	BuildArgvForOsLoader (_In_ PCSTR LoadIdentifier, _In_ ULONG_PTR SectionId, _Out_ PULONG pArgc)
	This function converts the list of Key=Value options in the given operating system section into an ARC-compatible argument vector, providing in addition the extra mandatory Software Loading Environment Variables, following the ARC specification.
VOID	LoadOperatingSystem (_In_ OperatingSystemItem *OperatingSystem)
BOOLEAN	MainBootMenuKeyPressFilter (IN ULONG KeyPress, IN ULONG SelectedMenuItem, IN PVOID Context OPTIONAL)
VOID	RunLoader (VOID)

Variables
static const OS_LOADING_METHOD	OSLoadingMethods []

Typedef Documentation

EDIT_OS_ENTRY_PROC

typedef VOID(* EDIT_OS_ENTRY_PROC) (_Inout_ OperatingSystemItem *OperatingSystem)

Definition at line 29 of file bootmgr.c.

OS_LOADING_METHOD

typedef struct _OS_LOADING_METHOD OS_LOADING_METHOD

OS_MENU_PROC

typedef VOID(* OS_MENU_PROC) (_Inout_ OperatingSystemItem *OperatingSystem)

Definition at line 33 of file bootmgr.c.

POS_LOADING_METHOD

typedef struct _OS_LOADING_METHOD * POS_LOADING_METHOD

Function Documentation

BuildArgvForOsLoader()

static PCHAR * BuildArgvForOsLoader ( _In_ PCSTR  LoadIdentifier, _In_ ULONG_PTR  SectionId, _Out_ PULONG  pArgc  )

static

This function converts the list of Key=Value options in the given operating system section into an ARC-compatible argument vector, providing in addition the extra mandatory Software Loading Environment Variables, following the ARC specification.

Definition at line 178 of file bootmgr.c.

{
    SIZE_T Size;
    ULONG Count;
    ULONG i;
    ULONG Argc;
    PCHAR* Argv;
    PCHAR* Args;
    PCHAR SettingName, SettingValue;
    PCCHAR BootPath = FrLdrGetBootPath();
 
    *pArgc = 0;
 
    ASSERT(SectionId != 0);
 
    /* Normalize LoadIdentifier to make subsequent tests simpler */
    if (LoadIdentifier && !*LoadIdentifier)
        LoadIdentifier = NULL;
 
    /* Count the number of operating systems in the section */
    Count = IniGetNumSectionItems(SectionId);
 
    /*
     * The argument vector contains the program name, the SystemPartition,
     * the LoadIdentifier (optional), and the items in the OS section.
     * For POSIX compliance, a terminating NULL pointer (not counted in Argc)
     * is appended, such that Argv[Argc] == NULL.
     */
    Argc = 2 + (LoadIdentifier ? 1 : 0) + Count;
 
    /* Calculate the total size needed for the string buffer of the argument vector */
    Size = 0;
    /* i == 0: Program name */
    // TODO: Provide one in the future...
    /* i == 1: SystemPartition : from where FreeLdr has been started */
    Size += (strlen("SystemPartition=") + strlen(BootPath) + 1) * sizeof(CHAR);
    /* i == 2: LoadIdentifier  : ASCII string that may be used
     * to associate an identifier with a set of load parameters */
    if (LoadIdentifier)
    {
        Size += (strlen("LoadIdentifier=") + strlen(LoadIdentifier) + 1) * sizeof(CHAR);
    }
    /* The section items */
    for (i = 0; i < Count; ++i)
    {
        Size += IniGetSectionSettingNameSize(SectionId, i);  // Counts also the NULL-terminator, that we transform into the '=' sign separator.
        Size += IniGetSectionSettingValueSize(SectionId, i); // Counts also the NULL-terminator.
    }
    Size += sizeof(ANSI_NULL); // Final NULL-terminator.
 
    /* Allocate memory to hold the argument vector: pointers and string buffer */
    Argv = FrLdrHeapAlloc((Argc + 1) * sizeof(PCHAR) + Size, TAG_STRING);
    if (!Argv)
        return NULL;
 
    /* Initialize the argument vector: loop through the section and copy the Key=Value options */
    SettingName = (PCHAR)((ULONG_PTR)Argv + ((Argc + 1) * sizeof(PCHAR)));
    Args = Argv;
    /* i == 0: Program name */
    *Args++ = NULL; // TODO: Provide one in the future...
    /* i == 1: SystemPartition */
    {
        strcpy(SettingName, "SystemPartition=");
        strcat(SettingName, BootPath);
 
        *Args++ = SettingName;
        SettingName += (strlen(SettingName) + 1);
    }
    /* i == 2: LoadIdentifier */
    if (LoadIdentifier)
    {
        strcpy(SettingName, "LoadIdentifier=");
        strcat(SettingName, LoadIdentifier);
 
        *Args++ = SettingName;
        SettingName += (strlen(SettingName) + 1);
    }
    /* The section items */
    for (i = 0; i < Count; ++i)
    {
        Size = IniGetSectionSettingNameSize(SectionId, i);
        SettingValue = SettingName + Size;
        IniReadSettingByNumber(SectionId, i,
                               SettingName, Size,
                               SettingValue, IniGetSectionSettingValueSize(SectionId, i));
        SettingName[Size - 1] = '=';
 
        *Args++ = SettingName;
        SettingName += (strlen(SettingName) + 1);
    }
    /* Terminating NULL pointer */
    *Args = NULL;
 
#if DBG
    /* Dump the argument vector for debugging */
    for (i = 0; i < Argc; ++i)
    {
        TRACE("Argv[%lu]: '%s'\n", i, Argv[i]);
    }
#endif
 
    *pArgc = Argc;
    return Argv;
}

Referenced by LoadOperatingSystem().

DBG_DEFAULT_CHANNEL()

DBG_DEFAULT_CHANNEL

(

WARNING

)

EditCustomBootNTOS()

static VOID EditCustomBootNTOS ( _Inout_ OperatingSystemItem *  OperatingSystem )

static

Definition at line 45 of file bootmgr.c.

{
    EditCustomBootReactOS(OperatingSystem, FALSE);
}

EditCustomBootReactOSSetup()

static VOID EditCustomBootReactOSSetup ( _Inout_ OperatingSystemItem *  OperatingSystem )

static

Definition at line 38 of file bootmgr.c.

{
    EditCustomBootReactOS(OperatingSystem, TRUE);
}

GetOSLoadingMethod()

static const OS_LOADING_METHOD * GetOSLoadingMethod ( _In_ ULONG_PTR  SectionId )

static

Definition at line 112 of file bootmgr.c.

{
    ULONG i;
    CHAR BootType[80];
 
    /* The operating system section has been opened by InitOperatingSystemList() */
    ASSERT(SectionId != 0);
 
    /* Try to read the boot type. We must have the value (it
     * has been possibly added by InitOperatingSystemList()) */
    *BootType = ANSI_NULL;
    IniReadSettingByName(SectionId, "BootType", BootType, sizeof(BootType));
    ASSERT(*BootType);
 
#ifdef HAS_DEPRECATED_OPTIONS
    if ((_stricmp(BootType, "Drive") == 0) ||
        (_stricmp(BootType, "Partition") == 0))
    {
        /* Display the deprecation warning message */
        WarnDeprecated(
            "The '%s' configuration you are booting into is no longer\n"
            "supported and will be removed in future FreeLoader versions.\n"
            "\n"
            "Please edit FREELDR.INI to replace all occurrences of\n"
            "\n"
            "             %*s        to:\n"
            "    BootType=%s      ------>     BootType=BootSector",
            BootType,
            strlen(BootType), "", // Indentation
            BootType);
 
        /* Type fixup */
        strcpy(BootType, "BootSector");
        if (!IniModifySettingValue(SectionId, "BootType", BootType))
        {
            ERR("Could not fixup the BootType entry for OS '%s', ignoring.\n",
                ((PINI_SECTION)SectionId)->SectionName);
        }
    }
#endif // HAS_DEPRECATED_OPTIONS
 
    /* Find the suitable OS loading method */
    for (i = 0; ; ++i)
    {
        if (i >= RTL_NUMBER_OF(OSLoadingMethods))
        {
            UiMessageBox("Unknown boot entry type '%s'", BootType);
            return NULL;
        }
        if (_stricmp(BootType, OSLoadingMethods[i].BootType) == 0)
            return &OSLoadingMethods[i];
    }
    UNREACHABLE;
}

Referenced by LoadOperatingSystem(), and MainBootMenuKeyPressFilter().

LoadOperatingSystem()

VOID LoadOperatingSystem

(

_In_ OperatingSystemItem *

OperatingSystem

)

Definition at line 287 of file bootmgr.c.

{
    ULONG_PTR SectionId = OperatingSystem->SectionId;
    const OS_LOADING_METHOD* OSLoadingMethod;
    ULONG Argc;
    PCHAR* Argv;
 
    /* Find the suitable OS loader to start */
    OSLoadingMethod = GetOSLoadingMethod(SectionId);
    if (!OSLoadingMethod)
        return;
    ASSERT(OSLoadingMethod->OsLoader);
 
    /* Build the ARC-compatible argument vector */
    Argv = BuildArgvForOsLoader(OperatingSystem->LoadIdentifier, SectionId, &Argc);
    if (!Argv)
        return; // Unexpected failure.
 
#ifdef _M_IX86
#ifndef UEFIBOOT
    /* Install the drive mapper according to this section drive mappings */
    DriveMapMapDrivesInSection(SectionId);
#endif
#endif
 
    /* Start the OS loader */
    OSLoadingMethod->OsLoader(Argc, Argv, NULL);
    FrLdrHeapFree(Argv, TAG_STRING);
}

Referenced by RunLoader().

MainBootMenuKeyPressFilter()

BOOLEAN MainBootMenuKeyPressFilter	(	IN ULONG	KeyPress,
		IN ULONG	SelectedMenuItem,
		IN PVOID Context	OPTIONAL
	)

Definition at line 335 of file bootmgr.c.

{
    OperatingSystemItem* OperatingSystem =
        &((OperatingSystemItem*)Context)[SelectedMenuItem];
 
    /* Any key-press cancels the global timeout */
    GetBootMgrInfo()->TimeOut = -1;
 
    switch (KeyPress)
    {
#if 0
    /* Help */
    case KEY_F1:
        DoHelp();
        return TRUE;
#endif
 
    /* FreeLdr Setup menu */
    case KEY_F2:
        FreeLdrSetupMenu(OperatingSystem);
        return TRUE;
 
    /* Boot entry-specific advanced boot menu */
    case KEY_F5:
    case KEY_F8:
    {
        /* Find the suitable OS menu procedure and display it */
        const OS_LOADING_METHOD* OSLoadingMethod =
            GetOSLoadingMethod(OperatingSystem->SectionId);
        if (OSLoadingMethod && OSLoadingMethod->OsMenu)
            OSLoadingMethod->OsMenu(OperatingSystem);
        DisplayBootTimeOptions(OperatingSystem); // TODO: Do this also elsewhere
        return TRUE;
    }
 
#ifdef HAS_OPTION_MENU_EDIT_CMDLINE
    /* Boot entry editor */
    case KEY_F10:
        EditOperatingSystemEntry(OperatingSystem);
        return TRUE;
#endif
 
    default:
        /* We didn't handle the key */
        return FALSE;
    }
}

Referenced by RunLoader().

RunLoader()

VOID RunLoader

(

VOID

)

Definition at line 386 of file bootmgr.c.

{
    OperatingSystemItem* OperatingSystemList;
    PCSTR* OperatingSystemDisplayNames;
    ULONG OperatingSystemCount;
    ULONG SelectedOperatingSystem;
    ULONG i;
 
#ifdef _M_IX86
#ifndef UEFIBOOT
    /* Load additional SCSI driver (if any) */
    if (LoadBootDeviceDriver() != ESUCCESS)
        UiMessageBoxCritical("Unable to load additional boot device drivers.");
#endif
#endif
 
    /* Open FREELDR.INI and load the global FreeLoader settings */
    if (!IniFileInitialize())
        UiMessageBoxCritical("Error initializing .ini file.");
    LoadSettings(NULL);
#if 0
    if (FALSE)
        UiMessageBoxCritical("Could not load global FreeLoader settings.");
#endif
 
    /* Debugger main initialization */
    DebugInit(GetBootMgrInfo()->DebugString);
 
    /* UI main initialization. If it fails, fall back to default UI. */
    if (!UiInitialize(TRUE))
        UiMessageBoxCritical("Unable to initialize UI.");
 
    /* If no FREELDR.INI, skip everything else and fall back to the FreeLdr setup menu */
    if (IsListEmpty(IniGetFileSectionListHead()))
        goto Fallback;
 
    /* Find all the message box settings and run them */
    UiShowMessageBoxesInSection(GetBootMgrInfo()->FrLdrSection);
 
    /* Retrieve the list of boot entries */
    OperatingSystemList = InitOperatingSystemList(&OperatingSystemCount,
                                                  &SelectedOperatingSystem);
    if (!OperatingSystemList)
    {
        UiMessageBox("There are no operating systems listed in freeldr.ini.");
        goto Fallback;
    }
    ASSERT(OperatingSystemCount != 0);
 
    /* Create list of display names */
    OperatingSystemDisplayNames = FrLdrTempAlloc(sizeof(PCSTR) * OperatingSystemCount, 'mNSO');
    if (!OperatingSystemDisplayNames)
        goto Fallback;
 
    for (i = 0; i < OperatingSystemCount; i++)
    {
        OperatingSystemDisplayNames[i] = OperatingSystemList[i].LoadIdentifier;
    }
 
    for (;;)
    {
        /* Redraw the backdrop, but don't overwrite boot options */
        UiDrawBackdrop(UiGetScreenHeight() - 2);
        DisplayBootTimeOptions(&OperatingSystemList[SelectedOperatingSystem]);
 
        /* Show the operating system list menu */
        if (!UiDisplayMenu("Please select the operating system to start:",
                           /* The string is 80 characters long; don't make it longer! */
                           "Press F8 for troubleshooting and advanced startup options."
                           "     F2: FreeLdr SETUP",
                           OperatingSystemDisplayNames,
                           OperatingSystemCount,
                           SelectedOperatingSystem,
                           GetBootMgrInfo()->TimeOut,
                           &SelectedOperatingSystem,
                           FALSE,
                           MainBootMenuKeyPressFilter,
                           OperatingSystemList))
        {
            UiMessageBox("Press ENTER to reboot.");
            goto Reboot;
        }
 
        /* Load the chosen operating system */
        LoadOperatingSystem(&OperatingSystemList[SelectedOperatingSystem]);
 
        GetBootMgrInfo()->TimeOut = -1;
 
        /* If we get there, the OS loader failed. As it may have
         * messed up the display, re-initialize the UI. */
#ifndef _M_ARM
        UiUnInitialize("");
#endif
        UiInitialize(TRUE);
    }
 
Fallback:
    /* Fall back to the FreeLdr setup menu */
    FreeLdrSetupMenu(NULL);
    UiMessageBox("The system will now reboot.");
 
Reboot:
    UiUnInitialize("Rebooting...");
    IniCleanup();
    return;
}

Referenced by ExecuteLoaderCleanly().

Variable Documentation

OSLoadingMethods

const OS_LOADING_METHOD OSLoadingMethods[]

static

Initial value:

=
{
 
 
 
 
 
 
 
 
 
    {"Windows"     , EditCustomBootNTOS, MenuNTOptions, LoadAndBootWindows},
    {"Windows2003" , EditCustomBootNTOS, MenuNTOptions, LoadAndBootWindows},
    {"WindowsVista", EditCustomBootNTOS, MenuNTOptions, LoadAndBootWindows},
    {"ReactOSSetup", EditCustomBootReactOSSetup, MenuNTOptions, LoadReactOSSetup},
}

Definition at line 60 of file bootmgr.c.

Referenced by GetOSLoadingMethod().