[FREELDR] Code fixes and enhancements.
authorHermès Bélusca-Maïto <hermes.belusca-maito@reactos.org>
Fri, 30 Aug 2019 22:49:37 +0000 (00:49 +0200)
committerHermès Bélusca-Maïto <hermes.belusca-maito@reactos.org>
Fri, 30 Aug 2019 23:42:46 +0000 (01:42 +0200)
commitbd451f240f2a1576aceb6f48b31ee49de917960b
tree7f0edec6d1f0be0fe667a85b3f0a58c9f0071aa8
parent602fc29ad4e7781c5e86bcb3c07d9e645beb3fce
[FREELDR] Code fixes and enhancements.
CORE-9023

FIXES:
======

- Fix parsing of the multiboot options string.
  NOTE: They are not yet treated in a case-insensitive manner!

- Fix a bug in ArcOpen() so that it correctly skips the first path
  separator (after the adapter-controller-peripheral ARC descriptors).
  The path separator can be either a backslash or a slash (both are
  allowed according to the specs); they were also already handled
  correctly in other parts of the code.

- Fix DissectArcPath() so as to:
  * **OPTIONALLY** (and not mandatorily!) return the path part that follows
    the ARC adapter-controller-peripheral elements in the ARC path;

  * make it correctly handle the (yes, optional!!) partition() part in the
    ARC path, for the multi(x)disk(y)rdisk(z) cases.

ENHANCEMENTS:
=============

- Directly retrieve the default OS entry as we enumerate them and
  build their list (i.e. merge the GetDefaultOperatingSystem() helper
  within InitOperatingSystemList()).

- Directly use the opened 'FreeLoader' INI section via its ID in the
  different functions that need it.

- Make the custom-boot and linux loaders honour the boot options they are
  supposed to support (see FREELDR.INI documentation / template).
  This includes the 'BootDrive' and 'BootPartition' (alternatively the ARC
  'BootPath').
  This also allows them to take into account the user-specified choices in the
  FreeLdr custom-boot editors.

- Modify the FreeLdr custom-boot editors so as to correctly honour
  the  priorities of the boot options as specified in the FREELDR.INI
  documentation / template.

- Use stack trick (union of structs) to reduce stack usage in the
  FreeLdr custom-boot editors, because there are strings buffers that are
  used in an alternate manner.

- Extract out from the editors the LoadOperatingSystem() calls, and
  move it back into OptionMenuCustomBoot(), so that when this latter
  function is called there is no risk of having a stack almost full.

- When building the ARC-compatible argument vector for the loaders, add
  the mandatory "SystemPartition" path. This allows the loaders to NOT
  call the machine-specific MachDiskGetBootPath() later on (this data is
  indeed passed to them by the boot manager part of FreeLdr).

- Improve the FsOpenFile() helper so as to make it:
  * return an adequate ARC_STATUS instead of a mere uninformative BOOLEAN;
  * take open options, as well as a default path (optional) that would be
    prepended to the file name in case the latter is a relative one.

- Make RamDiskLoadVirtualFile() return an actual descriptive ARC_STATUS
  value, and make it take an optional default path (same usage as the one
  in FsOpenFile() ).
  + Remove useless NTAPI .

- UiInitialize() and TuiTextToColor(), TuiTextToFillStyle(): load or
  convert named settings into corresponding values using setting table and
  a tight for-loop, instead of duplicating 10x the same parameter reading
  logic.

- UiInitialize(): Open the "Display" INI section just once. Remove usage
  of DisplayModeText[] buffer.

- UiShowMessageBoxesInSection() and UiShowMessageBoxesInArgv(): reduce
  code indentation level.

ENHANCEMENTS for NT OS loader:
==============================

- Don't use MachDiskGetBootPath() but use instead the "SystemPartition"
  value passed via the ARC argument vector by the boot manager
  (+ validation checks). Use it as the "default path" when calling
  FsOpenFile() or loading the ramdisk.

- Honour the FreeLdr-specific "Hal=" and "Kernel=" options by converting
  them into NT standard "/HAL=" and "/KERNEL=" options in the boot
  command line.

  Note that if the latter ones are already present on the standard "Options="
  option line, they would take precedence over those passed via the separate
  "Hal=" and "Kernel=" FreeLdr-specific options.

  Also add some documentation links to Geoff Chappell's website about
  how the default HAL and KERNEL names are chosen depending on the
  detected underlying platform on which the NT OS loader is running.
30 files changed:
boot/freeldr/freeldr/arch/i386/drivemap.c
boot/freeldr/freeldr/arch/i386/hwdisk.c
boot/freeldr/freeldr/arcname.c
boot/freeldr/freeldr/bootmgr.c
boot/freeldr/freeldr/cmdline.c
boot/freeldr/freeldr/custom.c
boot/freeldr/freeldr/disk/ramdisk.c
boot/freeldr/freeldr/freeldr.c
boot/freeldr/freeldr/include/arch/i386/drivemap.h
boot/freeldr/freeldr/include/arcname.h
boot/freeldr/freeldr/include/cmdline.h
boot/freeldr/freeldr/include/custom.h
boot/freeldr/freeldr/include/debug.h
boot/freeldr/freeldr/include/fs.h
boot/freeldr/freeldr/include/linux.h
boot/freeldr/freeldr/include/oslist.h
boot/freeldr/freeldr/include/ramdisk.h
boot/freeldr/freeldr/include/ui.h
boot/freeldr/freeldr/lib/debug.c
boot/freeldr/freeldr/lib/fs/fs.c
boot/freeldr/freeldr/lib/peloader.c
boot/freeldr/freeldr/linuxboot.c
boot/freeldr/freeldr/miscboot.c
boot/freeldr/freeldr/ntldr/inffile.c
boot/freeldr/freeldr/ntldr/setupldr.c
boot/freeldr/freeldr/ntldr/winldr.c
boot/freeldr/freeldr/oslist.c
boot/freeldr/freeldr/ui/directui.c
boot/freeldr/freeldr/ui/tui.c
boot/freeldr/freeldr/ui/ui.c