[SETUPLIB] Improve a bit the management of boot-store options

- QueryBootStoreOptions(): De-duplicate code.
- SetBootStoreOpt(): Respect the FieldsToChange flag.
- BOOT_STORE_OPTIONS: Remove unused Version field and distinguish
  between "Current" and "Next" BootEntryKey.

base/setup/lib/bootsup.c

@@ -130,15 +130,15 @@ CreateFreeLoaderReactOSEntries(
 #if DBG && !defined(_WINKD_)
     if (IsUnattendedSetup)
     {
-        BootOptions.CurrentBootEntryKey = MAKESTRKEY(L"ReactOS_KdSerial");
+        BootOptions.NextBootEntryKey = MAKESTRKEY(L"ReactOS_KdSerial");
     }
     else
 #endif
     {
 #if DBG
-        BootOptions.CurrentBootEntryKey = MAKESTRKEY(L"ReactOS_Debug");
+        BootOptions.NextBootEntryKey = MAKESTRKEY(L"ReactOS_Debug");
 #else
-        BootOptions.CurrentBootEntryKey = MAKESTRKEY(L"ReactOS");
+        BootOptions.NextBootEntryKey = MAKESTRKEY(L"ReactOS");
 #endif
     }
 
@@ -157,8 +157,8 @@ CreateFreeLoaderReactOSEntries(
     }
 #endif
 
-    BootOptions.Version = FreeLdr;
+    SetBootStoreOptions(BootStoreHandle, &BootOptions,
-    SetBootStoreOptions(BootStoreHandle, &BootOptions, 2 | 1);
+                        BOOT_OPTIONS_TIMEOUT | BOOT_OPTIONS_NEXT_BOOTENTRY_KEY);
 }
 
 static NTSTATUS

base/setup/lib/utils/bldrsup.c

@@ -130,6 +130,17 @@ NTOS_BOOT_LOADER_FILES NtosBootLoaders[] =
 };
 C_ASSERT(_countof(NtosBootLoaders) == BldrTypeMax);
 
+enum BOOT_OPTION
+{
+    BO_TimeOut,
+    BO_DefaultOS,
+};
+static const PCWSTR BootOptionNames[][2] =
+{
+    {L"TimeOut", L"DefaultOS"}, // FreeLdr
+    {L"timeout", L"default"  }  // NtLdr
+};
+
 
 /* FUNCTIONS ****************************************************************/
 
@@ -1031,36 +1042,32 @@ QueryBootStoreOptions(
         return STATUS_NOT_SUPPORTED;
     }
 
-    if (BootStore->Type == FreeLdr)
-    {
-        BootOptions->Version = FreeLdr;
-
-        BootOptions->CurrentBootEntryKey = 0;
-        IniGetKey(((PBOOT_STORE_INI_CONTEXT)BootStore)->OptionsIniSection,
-                  L"DefaultOS", (PCWSTR*)&BootOptions->CurrentBootEntryKey);
-
     BootOptions->Timeout = 0;
+    BootOptions->CurrentBootEntryKey = 0;
+    BootOptions->NextBootEntryKey = 0;
+
     if (IniGetKey(((PBOOT_STORE_INI_CONTEXT)BootStore)->OptionsIniSection,
-                      L"TimeOut", &TimeoutStr) && TimeoutStr)
+                  BootOptionNames[BootStore->Type][BO_TimeOut],
+                  &TimeoutStr) && TimeoutStr)
     {
         BootOptions->Timeout = _wtoi(TimeoutStr);
     }
-    }
-    else if (BootStore->Type == NtLdr)
-    {
-        BootOptions->Version = NtLdr;
 
-        BootOptions->CurrentBootEntryKey = 0;
     IniGetKey(((PBOOT_STORE_INI_CONTEXT)BootStore)->OptionsIniSection,
-                  L"default", (PCWSTR*)&BootOptions->CurrentBootEntryKey);
+              BootOptionNames[BootStore->Type][BO_DefaultOS],
+              (PCWSTR*)&BootOptions->NextBootEntryKey);
 
-        BootOptions->Timeout = 0;
+    /*
-        if (IniGetKey(((PBOOT_STORE_INI_CONTEXT)BootStore)->OptionsIniSection,
+     * NOTE: BootOptions->CurrentBootEntryKey is an informative field only.
-                      L"timeout", &TimeoutStr) && TimeoutStr)
+     * It indicates which boot entry has been selected for starting the
-        {
+     * current OS instance. Such information is NOT stored in the INI file,
-            BootOptions->Timeout = _wtoi(TimeoutStr);
+     * but has to be determined via other means. On UEFI the 'BootCurrent'
-        }
+     * environment variable does that. Otherwise, one could heuristically
-    }
+     * determine it by comparing the boot path and options of each entry
+     * with those used by the current OS instance.
+     * Since we currently do not need this information (and it can be costly
+     * to determine), BootOptions->CurrentBootEntryKey is not evaluated.
+     */
 
     return STATUS_SUCCESS;
 }
@@ -1072,7 +1079,6 @@ SetBootStoreOptions(
     IN ULONG FieldsToChange)
 {
     PBOOT_STORE_CONTEXT BootStore = (PBOOT_STORE_CONTEXT)Handle;
-    WCHAR TimeoutStr[15];
 
     if (!BootStore || !BootOptions)
         return STATUS_INVALID_PARAMETER;
@@ -1090,25 +1096,29 @@ SetBootStoreOptions(
     //
 
     // if (BootStore->Type >= BldrTypeMax || NtosBootLoaders[BootStore->Type].Type >= BldrTypeMax)
-    if (BootStore->Type != FreeLdr)
+    if (BootStore->Type != FreeLdr && BootStore->Type != NtLdr)
     {
         DPRINT1("Loader type %d is currently unsupported!\n", NtosBootLoaders[BootStore->Type].Type);
         return STATUS_NOT_SUPPORTED;
     }
 
-    if (BootOptions->Version != FreeLdr)
+    // if (BootOptions->Length < sizeof(*BootOptions))
-        return STATUS_INVALID_PARAMETER;
+    //     return STATUS_INVALID_PARAMETER;
-
-    //
-    // TODO: Depending on the flags set in 'FieldsToChange',
-    // change either one or both these bootloader options.
-    //
-    IniAddKey(((PBOOT_STORE_INI_CONTEXT)BootStore)->OptionsIniSection,
-              L"DefaultOS", (PCWSTR)BootOptions->CurrentBootEntryKey);
 
+    if (FieldsToChange & BOOT_OPTIONS_TIMEOUT)
+    {
+        WCHAR TimeoutStr[15];
         RtlStringCchPrintfW(TimeoutStr, ARRAYSIZE(TimeoutStr), L"%d", BootOptions->Timeout);
         IniAddKey(((PBOOT_STORE_INI_CONTEXT)BootStore)->OptionsIniSection,
-              L"TimeOut", TimeoutStr);
+                  BootOptionNames[BootStore->Type][BO_TimeOut],
+                  TimeoutStr);
+    }
+    if (FieldsToChange & BOOT_OPTIONS_NEXT_BOOTENTRY_KEY)
+    {
+        IniAddKey(((PBOOT_STORE_INI_CONTEXT)BootStore)->OptionsIniSection,
+                  BootOptionNames[BootStore->Type][BO_DefaultOS],
+                  (PCWSTR)BootOptions->NextBootEntryKey);
+    }
 
     return STATUS_SUCCESS;
 }

base/setup/lib/utils/bldrsup.h

@@ -30,14 +30,18 @@ typedef enum _BOOT_STORE_TYPE
  */
 typedef struct _BOOT_STORE_OPTIONS
 {
-    ULONG Version;          // BOOT_STORE_TYPE value
     // ULONG Length;
-    ULONG Timeout;
+    ULONG Timeout;  //< Timeout in seconds before the default boot entry is started.
-    ULONG_PTR CurrentBootEntryKey;
+    ULONG_PTR CurrentBootEntryKey;  //< Selected boot entry for the current boot (informative only).
-    // ULONG_PTR NextBootEntryKey;
+    ULONG_PTR NextBootEntryKey;     //< The boot entry for the next boot.
-    // WCHAR HeadlessRedirection[1];
+    // WCHAR HeadlessRedirection[ANYSIZE_ARRAY];
 } BOOT_STORE_OPTIONS, *PBOOT_STORE_OPTIONS;
 
+/* FieldsToChange flags for SetBootStoreOptions() */
+#define BOOT_OPTIONS_TIMEOUT                1
+#define BOOT_OPTIONS_NEXT_BOOTENTRY_KEY     2
+// #define BOOT_OPTIONS_HEADLESS_REDIRECTION   4
+
 /*
  * These macros are used to set a value for the BootEntryKey member of a
  * BOOT_STORE_ENTRY structure, much in the same idea as MAKEINTRESOURCE and
@@ -63,10 +67,10 @@ typedef struct _BOOT_STORE_ENTRY
 {
     ULONG Version;          // BOOT_STORE_TYPE value
     // ULONG Length;
-    ULONG_PTR BootEntryKey; // Boot entry "key"
+    ULONG_PTR BootEntryKey; //< Boot entry "key"
-    PCWSTR FriendlyName;    // Human-readable boot entry description        // LoadIdentifier
+    PCWSTR FriendlyName;    //< Human-readable boot entry description        // LoadIdentifier
-    PCWSTR BootFilePath;    // Path to e.g. osloader.exe, or winload.efi    // EfiOsLoaderFilePath
+    PCWSTR BootFilePath;    //< Path to e.g. osloader.exe, or winload.efi    // EfiOsLoaderFilePath
-    ULONG OsOptionsLength;  // Loader-specific options blob (can be a string, or a binary structure...)
+    ULONG OsOptionsLength;  //< Loader-specific options blob (can be a string, or a binary structure...)
     UCHAR OsOptions[ANYSIZE_ARRAY];
 /*
  * In packed form, this structure would contain offsets to 'FriendlyName'