[FREELDR] Add the possibility to change the boot load options from TXTSETUP.SIF

at runtime from the boot selection menu or from FREELDR.INI.

CORE-17350, CORE-9023

For a proper override of the options by new user options, specify the
/SIFOPTIONSOVERRIDE switch in addition. Otherwise, user options are
merged with those retrieved from TXTSETUP.SIF, with priority given to
the former ones.

- Update the documentation for the 'ReactOSSetup' OS type in the
  FREELDR.INI file template.

- Use a different prompt in the custom boot options editor for the
  'ReactOSSetup' OS type, with adequate explanation.

- Get rid of the ReactOS-specific TXTSETUP.SIF 'DbgOsLoadOptions' value,
  and use instead the Windows-compatible 'SetupDebugOptions' value that
  is added to the other load options when debugging is to be enabled.

Author: HBelusca

boot/bootdata/txtsetup.sif

@@ -208,10 +208,10 @@ Cabinet=reactos.cab
 
 [SetupData]
 DefaultPath = \ReactOS
+SetupDebugOptions = "/DEBUG /KDSERIAL /DEBUGPORT=COM1 /FIRSTCHANCE"
+;SetupDebugOptions = "/DEBUG /SOS /DEBUGPORT=SCREEN"
+;SetupDebugOptions = "/DEBUG /DEBUGPORT=BOCHS"
 OsLoadOptions = "/NOGUIBOOT /NODEBUG"
-DbgOsLoadOptions = "/NOGUIBOOT /KDSERIAL /DEBUGPORT=COM1 /FIRSTCHANCE"
-;DbgOsLoadOptions = "/SOS /DEBUGPORT=SCREEN"
-;DbgOsLoadOptions = "/NOGUIBOOT /DEBUGPORT=BOCHS"
 
 [NLS]
 AnsiCodepage     = c_1252.nls

boot/freeldr/FREELDR.INI

@@ -112,14 +112,14 @@
 ;                 will only be used to set the boot partition.
 ; Initrd        - specifies the optional init ramdisk file name to be used.
 ;                 The same remarks about the path as for "Kernel" remain valid.
-; CommandLine   - specifies the command line options for the kernel.
+; CommandLine   - specifies the boot load options for the kernel.
 
 ; ["Windows(NT40|2003)" OSType] Section Commands:
 ;
 ; SystemPath    - specifies the system root path (must be a valid ARC path):
 ;                 multi(0)disk(0)rdisk(0)partition(1)\reactos
 ;                 multi(0)disk(0)fdisk(0)
-; Options       - specifies the command line options for the kernel being booted.
+; Options       - specifies the boot load options for the kernel.
 ; Kernel        - specifies the kernel file name (default: ntoskrnl.exe)
 ; Hal           - specifies the HAL file name (default: hal.dll)
 ;
@@ -130,8 +130,24 @@
 
 ; ["ReactOSSetup" OSType] Section Commands:
 ;
-; No options defined for the moment. This OS type is used to tell FreeLdr
-; to start the SETUP portion of NT / ReactOS.
+; This OS type is used to start the SETUP portion of NT / ReactOS.
+;
+; SystemPath    - specifies the system root path (must be a valid ARC path):
+;                 multi(0)disk(0)rdisk(0)partition(1)\reactos
+;                 multi(0)disk(0)fdisk(0)
+; Options       - specifies extra boot load options for the kernel and the
+;                 setup environment (see REMARK 2 below).
+;
+; REMARK: Contrary to the "Windows" type, this OS type does not support separate
+; "Kernel" and "Hal" values. Instead, these values must be specified using the
+; NT-compatible "/HAL=filename" and "/KERNEL=filename" option switches.
+;
+; REMARK 2: The SETUP portion retrieves the default boot load options from the
+; TXTSETUP.SIF file present in the installation source (section "[SetupData]",
+; values "OsLoadOptions" and "SetupDebugOptions"). Thus, any options specified
+; using the "Options" value will supplement those already obtained from the
+; TXTSETUP.SIF file, unless the "/SIFOPTIONSOVERRIDE" option switch is specified,
+; in which case the "Options" value overrides those from TXTSETUP.SIF.
 
 
 [FREELOADER]

boot/freeldr/freeldr/custom.c

@@ -36,7 +36,8 @@ const CHAR BootDrivePrompt[] = "Enter the boot drive.\n\nExamples:\nfd0 - first
 const CHAR BootPartitionPrompt[] = "Enter the boot partition.\n\nEnter 0 for the active (bootable) partition.";
 const CHAR ARCPathPrompt[] = "Enter the boot ARC path.\n\nExamples:\nmulti(0)disk(0)rdisk(0)partition(1)\nmulti(0)disk(0)fdisk(0)";
 const CHAR ReactOSSystemPathPrompt[] = "Enter the path to your ReactOS system directory.\n\nExamples:\n\\REACTOS\n\\ROS";
-const CHAR ReactOSOptionsPrompt[] = "Enter the options you want passed to the kernel.\n\nExamples:\n/DEBUG /DEBUGPORT=COM1 /BAUDRATE=115200\n/FASTDETECT /SOS /NOGUIBOOT\n/BASEVIDEO /MAXMEM=64\n/KERNEL=NTKRNLMP.EXE /HAL=HALMPS.DLL";
+const CHAR ReactOSOptionsPrompt[] = "Enter the load options you want passed to the kernel.\n\nExamples:\n/DEBUG /DEBUGPORT=COM1 /BAUDRATE=115200\n/FASTDETECT /SOS /NOGUIBOOT\n/BASEVIDEO /MAXMEM=64\n/KERNEL=NTKRNLMP.EXE /HAL=HALMPS.DLL";
+const CHAR ReactOSSetupOptionsPrompt[] = "Enter additional load options you want passed to the ReactOS Setup.\nThese options will supplement those obtained from the TXTSETUP.SIF\nfile, unless you also specify the /SIFOPTIONSOVERRIDE option switch.\n\nExample:\n/NOGUIBOOT /DEBUG /DEBUGPORT=COM1 /BAUDRATE=115200";
 const CHAR CustomBootPrompt[] = "Press ENTER to boot your custom boot setup.";
 
 /* FUNCTIONS ******************************************************************/
@@ -659,7 +660,7 @@ EditCustomBootReactOS(
             return;
     }
 
-    if (!UiEditBox(ReactOSOptionsPrompt, ReactOSOptions, sizeof(ReactOSOptions)))
+    if (!UiEditBox(IsSetup ? ReactOSSetupOptionsPrompt : ReactOSOptionsPrompt, ReactOSOptions, sizeof(ReactOSOptions)))
         return;
 
     /* Modify the settings values and return if we were in edit mode */
@@ -686,7 +687,9 @@ EditCustomBootReactOS(
         return;
 
     /* Construct the ReactOS ARC system path */
-    ConstructArcPath(ReactOSARCPath, ReactOSSystemPath, DriveMapGetBiosDriveNumber(BootDriveString), atoi(BootPartitionString));
+    ConstructArcPath(ReactOSARCPath, ReactOSSystemPath,
+                     DriveMapGetBiosDriveNumber(BootDriveString),
+                     atoi(BootPartitionString));
 
     /* Add the system path */
     if (!IniAddSettingValueToSection(SectionId, "SystemPath", ReactOSARCPath))

boot/freeldr/freeldr/ntldr/ntldropts.c

@@ -131,3 +131,83 @@ NtLdrGetOption(
 {
     return NtLdrGetOptionEx(Options, OptionName, NULL);
 }
+
+/*
+ * Appends or prepends new options to the ones originally contained
+ * in the buffer pointed by LoadOptions, of maximum size BufferSize.
+ */
+VOID
+NtLdrAddOptions(
+    IN OUT PSTR LoadOptions,
+    IN ULONG BufferSize,
+    IN BOOLEAN Append,
+    IN PCSTR NewOptions OPTIONAL)
+{
+    ULONG OptionsLength;
+    ULONG NewOptsLength;
+    BOOLEAN AddSeparator;
+
+    if (!LoadOptions || (BufferSize == 0))
+        return;
+    // ASSERT(strlen(LoadOptions) + 1 <= BufferSize);
+
+    if (!NewOptions || !*NewOptions)
+        return;
+
+    if (Append)
+    {
+        OptionsLength = (ULONG)strlen(LoadOptions);
+        OptionsLength = min(OptionsLength, BufferSize-1);
+
+        /* Add a whitespace separator if needed */
+        if (OptionsLength != 0 &&
+            (LoadOptions[OptionsLength-1] != ' ') &&
+            (LoadOptions[OptionsLength-1] != '\t') &&
+            (*NewOptions != '\0') &&
+            (*NewOptions != ' ') &&
+            (*NewOptions != '\t'))
+        {
+            RtlStringCbCatA(LoadOptions, BufferSize * sizeof(CHAR), " ");
+        }
+
+        /* Append the options */
+        RtlStringCbCatA(LoadOptions, BufferSize * sizeof(CHAR), NewOptions);
+    }
+    else
+    {
+        NewOptsLength = (ULONG)strlen(NewOptions);
+        NewOptsLength = min(NewOptsLength, BufferSize-1);
+
+        /* Add a whitespace separator if needed */
+        AddSeparator = FALSE;
+        if (NewOptsLength != 0 &&
+            (NewOptions[NewOptsLength-1] != ' ') &&
+            (NewOptions[NewOptsLength-1] != '\t') &&
+            (*LoadOptions != '\0') &&
+            (*LoadOptions != ' ') &&
+            (*LoadOptions != '\t'))
+        {
+            AddSeparator = TRUE;
+            ++NewOptsLength;
+        }
+
+        /*
+         * Move the original load options forward (possibly truncating them
+         * at the end if the buffer is not large enough) to make place for
+         * the options to prepend.
+         */
+        OptionsLength = (ULONG)strlen(LoadOptions) + 1;
+        OptionsLength = min(OptionsLength, BufferSize - NewOptsLength);
+        RtlMoveMemory(LoadOptions + NewOptsLength,
+                      LoadOptions,
+                      OptionsLength * sizeof(CHAR));
+        /* NULL-terminate */
+        (LoadOptions + NewOptsLength)[OptionsLength-1] = '\0';
+
+        /* Restore the new options length back to its original value */
+        if (AddSeparator) --NewOptsLength;
+        /* Prepend the options and add the whitespace separator if needed */
+        strncpy(LoadOptions, NewOptions, NewOptsLength);
+        if (AddSeparator) LoadOptions[NewOptsLength] = ' ';
+    }
+}

boot/freeldr/freeldr/ntldr/ntldropts.h

@@ -29,3 +29,10 @@ PCSTR
 NtLdrGetOption(
     IN PCSTR Options,
     IN PCSTR OptionName);
+
+VOID
+NtLdrAddOptions(
+    IN OUT PSTR LoadOptions,
+    IN ULONG BufferSize,
+    IN BOOLEAN Append,
+    IN PCSTR NewOptions OPTIONAL);