Skip to content

About

SplashOS LinuxBoot-style graphical boot manager (GTK4/libadwaita on Rust): default boot, Super-key boot menu, kexec/efibootmgr targets

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

SplashBootManager

SplashOS's LinuxBoot-style graphical boot manager: a tiny Linux system whose only job is to present a GTK4/libadwaita boot UI and boot other distros/operating systems. No systemd, no initramfs, no GRUB — the SplashOS kernel (with EFI_STUB, built-in storage/filesystem drivers) is the bootloader.

Boot flow

firmware (UEFI) -> SplashOS kernel (EFI stub) -> read-only root
  -> seatd -> cage (kiosk Wayland compositor) -> splash-boot-manager
       |  default entry: auto-booted after `timeout` seconds
       |  hold Super key: boot-options menu
       -> Linux target:      kexec -l <kernel> --initrd <...> --command-line <...>; kexec -e
       -> installed OS:      efibootmgr --bootnext <Boot####>; warm reboot
       -> USB (EFI app):     efibootmgr -c ...; efibootmgr --bootnext <entry>; reboot
       -> optical (EFI):     efibootmgr --bootnext <firmware entry for the drive>; reboot

Non-Linux operating systems

kexec can only load Linux kernels — so every non-Linux target goes through the firmware. On UEFI systems the picker also lists:

  • the firmware's existing boot entries (Boot####): "Windows Boot Manager", a distro's GRUB/shim, ... — shown in the firmware's own boot order with a UEFI · Boot0003 caption
  • installed ESP loaders on internal disks that no entry covers yet: Windows (EFI/Microsoft/Boot/bootmgfw.efi), distro shims/GRUBs (EFI/ubuntu/...), systemd-boot, rEFInd, Apple loaders — with their distro name

Firmware tools are not boot volumes and are not shown as discs: the firmware boot-manager UI, firmware setup and the UEFI shell live in the header-bar menu instead, under friendly names (BootManagerMenuApp → "UEFI Boot Menu"). Selecting one still goes through the firmware (efibootmgr --bootnext + reboot). The same menu holds About SplashOS Boot Manager (libadwaita about dialog with the running version; no "Report an issue" button — the boot environment has no network).

Entries the firmware generated itself (efibootmgr marks them {auto_created_boot_option}) are hidden too: they point at a bare disk, DVD drive or network device and only duplicate the media/OS row.

Installed-OS icons use Adwaita's drive-harddisk-symbolic artwork and optical media media-optical-symbolic; the image carries no SVG loader, so their path data is rendered directly with Cairo.

Selecting one sets efibootmgr --bootnext <entry> and warm-reboots the machine into it; a missing entry is created on the fly (labeled SplashOS <name> [<fs-uuid>] so a different stick never reuses it).

Duplicate detection: a firmware entry is hidden when it boots the same OS as something already shown — its title matches an internal BLS/scan title ("Debian" vs "Debian GNU/Linux 12", "SplashOS" vs "SplashOS 0.0.1-dev"), or its label names a drive already offered as a media row ("UEFI: SanDisk Extreme" vs the USB row for that stick), or an internal ESP scan already found its loader. What stays visible is one disc per bootable OS.

BIOS systems have no firmware interface, so the UEFI discs are not offered there (and Boot failed: UEFI firmware boot is unavailable... is what a BIOS boot of such a target reports). Internal Linux roots (BLS/GRUB trees) are still kexec-able on BIOS machines.

Removable media

While the menu is open the manager polls sysfs once a second and looks for bootable USB/optical media. Newly plugged devices appear next to the internal BLS entries, with a USB-stick or CD icon and the volume label (or drive model) underneath; unplugging removes them again. Detection runs on a worker thread because it read-only mounts each media to inspect it, and it caches results by (device node, size, filesystem UUID) so nothing is mounted twice.

How a device is booted depends on what is on it:

  • a BLS tree (loader/entries/*.conf) — kexec (the media is mounted, the kernel/initrd are loaded, the media is unmounted, then kexec -e)
  • a GRUB or isolinux/syslinux config — the first/default menu entry is kexec'ed the same way (live Linux discs/installers)
  • optical media — the firmware route: an existing firmware entry for the drive (matched by label or by a CD/DVD device path), else the one-shot entry this app created earlier, else a new one-shot entry. Created entries are rewritten to their short form (device path without a file node): efibootmgr's file path has no filesystem node in front of it on a CD, so the firmware cannot resolve it and silently skips the option. Short form makes the firmware search \EFI\BOOT\BOOTX64.EFI on every filesystem of the drive, which finds the El Torito boot image — the one Windows install media actually boots from (the UDF view is readable by firmware for listing, but its loaders are not executable). The firmware's own boot order is restored after creation so future boots still prefer the installed OS. Windows install media then shows its own "Press any key to boot from CD or DVD" prompt; ignore it and the firmware falls through to the next boot option
  • only EFI/BOOT/BOOT*.EFI (Windows/Ubuntu installers) — a one-shot firmware boot entry is created (efibootmgr --bootnext) and the machine reboots into it
  • anything else (exFAT/NTFS/UDF-only data media) is not bootable and is not shown — except optical discs: a present but unreadable disc (UDF bridge images like Windows install media, which this kernel cannot mount) is still shown with the firmware route, because the firmware is not bound to the kernel's filesystem drivers. The first scan also traces every candidate and its verdict to stderr (/run/gbm.err), which makes a missing device diagnosable. shown

--list-devices prints the scanner's result (device, route, parsed boot entries) without starting GTK; it is the easiest way to debug a stick that does not show up.

Configuration — Boot Loader Specification

Entries are read from $BOOT/loader/entries/*.conf (freedesktop Boot Loader Specification, type 1) and $BOOT/loader/loader.conf (default, timeout). This keeps the manager interoperable with systemd-boot/GRUB-style layouts and makes booting other installed distros a pure data problem: their entries point at their kernel/initrd/cmdline on disk.

Phase 1 (now)

  • BLS entry parsing (src/bls.rs, dependency-free)
  • countdown to default boot; Super key opens the menu; picking an entry boots it via kexec (src/boot.rs)
  • hotplug detection of bootable USB/optical media (src/devices.rs)
  • installed non-Linux OSes via the firmware (efibootmgr --bootnext + warm reboot): existing Boot#### entries and ESP loaders on internal disks
  • --dry-run prints the boot commands instead of executing them
  • --boot-dir <path> to point at any $BOOT tree (development/testing)
  • --list-devices dumps the hotplug scanner's results

Later phases

  • diagnostics/rescue tooling inside the UI (read-only root)
  • BuildScripts packaging: rust toolchain package + vendored crates (kept tiny: gtk4 + libadwaita only, hand-rolled BLS parser instead of serde), kiosk integration with cage/seatd

Development

cargo test                                   # BLS parser + device/GRUB/isolinux parser tests
cargo run -- --dry-run --boot-dir ./example-boot
sudo ./target/debug/splash-boot-manager --list-devices   # what the hotplug scanner sees

example-boot/ provides a sample $BOOT tree with BLS entries for development without a boot environment.

Boot logo

Two assets ship in assets/:

  • boot-logo.raw.xz — the fbdev splash (splash-logo.c), a SPLASHLOGO2 frame array: 28-byte header (SPLASHLOGO2\0, u32 LE width, height, frame count, frame delay in ms) followed by 560×531 BGR24 frames composited over black, 74 frames at 40 ms (25 fps). It is stored xz-compressed because the flat frame array is 66 MB; the build script decompresses it to /usr/share/splashos/boot-logo.raw. The player mmaps it and resamples with a box/tent kernel (area averaging when shrinking, bilinear when growing) — point sampling a 560×531 animation down to a ~200 px logo drops most source rows and visibly aliases the edges.
  • boot-logo.gif — the GTK splash page (--splash). gdk-pixbuf cannot read APNG, so this stays a GIF.

Both represent the same source animation (the APNG export, 74 frames at 25 fps, 560×531 RGBA); the raw asset is generated with:

tools/apng2raw.py splashos_boot.apng -o boot-logo.raw   # ~12 s, needs zlib only
xz -9 -k boot-logo.raw                                  # -> assets/boot-logo.raw.xz

Testing a built boot-manager partition

install-test-entries.sh (dev helper, machine-specific) prepares a partition built by SplashBuilder's bootloader edition for a boot test:

sudo ./install-test-entries.sh [boot-dir] [splashos-root] [--skip-grub]
# defaults: /mnt/bootmanager /mnt/splashos

It snapshots this machine's Debian + SplashOS kernels into the boot tree, writes the BLS loader/ tree for them, and appends a "Splash Boot Manager (dev)" entry to the host GRUB (/etc/grub.d/40_custom + update-grub, idempotent). Re-run it after every rebuild — the builder wipes the partition. Until the graphical manager is packaged, the target's placeholder /sbin/init (edition config in the configuration repo) kexecs the default BLS entry after the loader.conf timeout.

About

SplashOS LinuxBoot-style graphical boot manager (GTK4/libadwaita on Rust): default boot, Super-key boot menu, kexec/efibootmgr targets

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages