nixos/plymouth: use bgrt theme #114000

worldofpeace · 2021-02-22T13:14:51Z

Motivation for this change

Closes #84158.
In a followup I'd like to pick up or encourage @puckipedia towards #88789. LUKS+ZFS is a tentative goal to having plymouth working entirely as expected.

This pull request focuses on getting "FlickerFree Boot" with the BGRT theme, an initiative from Fedora https://fedoraproject.org/wiki/Changes/FlickerFreeBoot, that now (as usual because RedHat values) other projects can benefit from. Most recently (IIRC), Ubuntu is using the master branch of plymouth. Whether plymouth is ready for release is debated, but if you look at this pull request certain polishing upstream is needed, but if you want it we certainly can use it.

I tested this pull request on a machine with using i915 and it worked pretty well, nothing seemed weird.
Here's an actual example of how the bootsplash should look: https://ic.pics.livejournal.com/hansdegoede/13347631/433/433_900.png, with a vendor image, a logo, and spinner.

If you want to see examples in other situations the mockup is useful: https://gitlab.gnome.org/Teams/Design/os-mockups/-/blob/master/boot/boot-progress.png, but they changed the shutdown to be the same as the startup.

Todo's:

Need a better logo available

We need something monochromatic, the current image we have looks too big and draws too much attention to itself.
Mentioned this in NixOS/nixos-artwork#58.

Switch to the white version of the nixos logo nixos-icons: 2017-03-16 -> 2021-02-24 #114276
- Merge icons: install white nixos logo nixos-artwork#59 and update nixos-artwork
We need to sync the GDM logo with this logo change for a smooth transition gnome3.gdm: use white nixos logo #114387
Testing for AMD+Nvidia users would be helpful but isn't required
logo doesn't show up at shutdown
In initrd we copy these logo's, but on the actual system we
would need to use environment.etc. However, when I try to do this I get ln permission denied errors. It's also rather confusing that in initrd everything is in $out/share, but on the running system it's /etc. This might require patching all theme files ImageDir to /run/current-system, and using runCommand to get an installable derivation with the logos?
It seems the source code attempts to change directory to the location of the image files, so no XDG_DATA_DIRS.
Why doesn't plymouth use the logo path it's configured to use?

Questions:

In pull request the following nix code is added:

boot.initrd.availableKernelModules = [ "i915" ];

also part of the work done by Fedora to get fastboot enabled for Intel users.
This sort of thing is a part of nixos-hardware, but I think ideally nixos really should have some base profiles that nixos-generate-hardware detects and adds like https://github.com/NixOS/nixos-hardware/blob/0cb5491af9da8d6f16540ffc4db24e2361852e46/flake.nix#L77
Perhaps in the release note nixos-hardware can be mentioned or just the configuration for intel users if they're not already using it.

Thanks

@eadwu and @andersk were motivation to finally fix this

Things done

r-rmcgibbo · 2021-02-22T14:18:30Z

Result of nixpkgs-review pr 114000 at feb0443e run on aarch64-linux 1

1 package marked as broken and skipped:

xmonad_log_applet

26 packages built:

1 suggestion:

warning: unclear-gpl
gpl2 is a deprecated license, check if project uses gpl2Plus or gpl2Only and change meta.license accordingly.

Near pkgs/os-specific/linux/plymouth/default.nix:115:5:
```
    |
115 |     license = licenses.gpl2;
    |     ^
```

Result of nixpkgs-review pr 114000 at feb0443e run on x86_64-linux 1

1 package marked as broken and skipped:

xmonad_log_applet

27 packages built:

1 suggestion:

warning: unclear-gpl
gpl2 is a deprecated license, check if project uses gpl2Plus or gpl2Only and change meta.license accordingly.

Near pkgs/os-specific/linux/plymouth/default.nix:115:5:
```
    |
115 |     license = licenses.gpl2;
    |     ^
```

SuperSandro2000 · 2021-02-22T17:29:31Z

nixos/modules/system/boot/plymouth.nix

@@ -47,15 +47,15 @@ in
      };

      themePackages = mkOption {
-        default = [ nixosBreezePlymouth ];
+        default = [ ] ++ lib.optional (cfg.theme == "breeze") nixosBreezePlymouth;


Suggested change

default = [ ] ++ lib.optional (cfg.theme == "breeze") nixosBreezePlymouth;

default = lib.optional (cfg.theme == "breeze") nixosBreezePlymouth;

We could just take this opportunity to get rid of nixosBreezePlymouth (I made it). It only exists so there was a default theme that actually displayed the logo and name nicely. If the bgrt theme works for this purpose we can kill it.

@michaelpj I still think there could be users that want the breeze-plymouth theme?

SuperSandro2000 · 2021-02-22T17:30:13Z

pkgs/os-specific/linux/plymouth/default.nix

+  outputs = [
+    "out"
+    "dev"
+  ];


Suggested change

outputs = [

"out"

"dev"

];

outputs = [ "out" "dev" ];

pkgs/os-specific/linux/plymouth/default.nix

andersk · 2021-02-22T17:43:51Z

pkgs/os-specific/linux/plymouth/default.nix

 }:

 stdenv.mkDerivation rec {
  pname = "plymouth";
-  version = "0.9.4";
+  version = "2020-12-07";


If we use the git describe format, version = "0.9.5-29-gc4ced2a", then the version numbers will remain monotonic if we switch back to a release. This format also works with fetchFromGit*, so we can use rev = version below.

Wait... Can we maybe open an issue for that? U probably know about that annoying rule we have with "pname = "something-unstable" and verison = YYY-MM-DD. IIRC this is what they do in debian world? Anyways, I think it's worth looking into that but I think it's out of scope of this PR, and I will use what the manual has currently.

~~But you haven’t changed pname to "plymouth-unstable", so the monotonicity problem is in scope for this PR.~~

Edit: never mind, GitHub just wasn’t showing that you changed this later.

Anyways, I think it's worth looking into that but I think it's out of scope of this PR, and I will use what the manual has currently.

The manual is inaccurate because it just mentions name and not pname or version. Changing pname is not an option because it breaks many package definitions and repology.

davidak · 2021-02-23T00:44:26Z

AMD GPU

https://youtu.be/88boyDEVKDs

I still see stage1 console output.

worldofpeace · 2021-02-23T12:05:24Z

AMD GPU

https://youtu.be/88boyDEVKDs

I still see stage1 console output.

We still see stage-1 because plymouth can't start that early because we don't have #74842 (comment)

But yeah, I didn't even see the splash in your video. According to https://hansdegoede.livejournal.com/20632.html

The graphics drivers for AMD and Nvidia GPUs reset the hardware when loading, this will cause the display to temporarily go black. There is nothing which can be done about this.

So it will not be perfect for these users, but u should see it. Do you boot in UEFI mode?

davidak · 2021-02-23T13:03:08Z

Yes, the splash screen disappeared, but also it's loading time. It seem a lot faster now.

The "NixOS" you see shortly at the start is from GRUB. So it boots in BIOS mode.

Is what you see in the video the expected behavior except not showing the start splash?

I also have an Nvidia card and will test that too.

Let me know if i can help with testing anything else.

worldofpeace · 2021-02-23T14:53:24Z

Yes, the splash screen disappeared, but also it's loading time. It seem a lot faster now.

The "NixOS" you see shortly at the start is from GRUB. So it boots in BIOS mode.

Is what you see in the video the expected behavior except not showing the start splash?

I also have an Nvidia card and will test that too.

Let me know if i can help with testing anything else.

It is expected behavior, BGRT is a UEFI thing. Nvidia in UEFI would also be helpful.

samueldr · 2021-02-23T20:28:41Z

The "NixOS" you see shortly at the start is from GRUB. So it boots in BIOS mode.

I'm not sure I follow, (sorry it is a bit tangentially off-topic) GRUB can be used, and is used, both with UEFI and Legacy boot.

As part of fedora's documentation, they list the planned changes they had to make to GRUB, with a user FAQ.

So it should be perfectly usable with GRUB, if we bring in the required patches (assuming they are not in upstream, since development upstream is not quick).

@worldofpeace am I understanding right that this has only been verified and tested with systemd-boot?

Note that it is not an issue if it is the case. But it is something to know.

worldofpeace · 2021-02-24T03:36:40Z

As part of fedora's documentation, they list the planned changes they had to make to GRUB, with a user FAQ.

So it should be perfectly usable with GRUB, if we bring in the required patches (assuming they are not in upstream, since development upstream is not quick).

@worldofpeace am I understanding right that this has only been verified and tested with systemd-boot?
Note that it is not an issue if it is the case. But it is something to know.

Ah, I should have mentioned. I use GRUB. Ahh, I've never actually noticed https://hansdegoede.livejournal.com/19081.html, but it's good that you mention this.

It seems particularly difficult to pick through what Fedora does with grub2 https://src.fedoraproject.org/rpms/grub2/tree/rawhide... They have a 301 patch series 😁 !
A quick find and I spot two patches https://src.fedoraproject.org/rpms/grub2/blob/rawhide/f/0129-Add-auto-hide-menu-support.patch https://src.fedoraproject.org/rpms/grub2/blob/rawhide/f/0170-grub.d-Split-out-boot-success-reset-from-menu-auto-h.patch, so it appears that they have this patched in. It appears from other threads that they have their GRUB done up specifically and there's kernel parameters like the log level etc. that also are being configured.

We should probably split this off as some other tangible sub tasks. I also did just peruse the grub ml archive because I was wondering if they sent these patches upstream, but I'm not very good at that 🐱

michaelpj · 2021-02-24T16:18:12Z

nixos/modules/system/boot/plymouth.nix

+      copy_bin_and_libs ${plymouth}/bin/plymouth
+      copy_bin_and_libs ${plymouth}/bin/plymouthd
+
+      # Check if the actual requested theme is here


pkgs/os-specific/linux/plymouth/default.nix

https://gitlab.freedesktop.org/plymouth/plymouth/-/issues/101 https://gitlab.freedesktop.org/plymouth/plymouth/-/blob/75204a2517658c01bd1d39f2dff845512c9cab12/src/plymouthd.defaults

worldofpeace · 2021-02-25T20:20:00Z

All my required todo's are now done ✨
More review and testing is welcome, but I believe it's pretty much "complete".

jtojnar · 2021-02-25T20:13:45Z

nixos/modules/system/boot/plymouth.nix

+
+    # For themes that are compiled with PLYMOUTH_LOGO_FILE
+    mkdir -p $out/etc/plymouth
+    ln -s $logo $out/etc/plymouth/logo.png


Using Nix value directly is IMO clearer than passing it to environment as a middleman:

Suggested change

ln -s $logo $out/etc/plymouth/logo.png

ln -s "${cfg.logo}" "$out/etc/plymouth/logo.png"

jtojnar · 2021-02-25T20:18:55Z

nixos/modules/system/boot/plymouth.nix


-      # patch out any attempted references to the theme or plymouth's themes directory
+      # Use -L to copy the directories proper, not the symlinks to them.


Could you also mention why?

extraUtils can't contain references to nix/store, and that's why we're patching. I thought that bit is usually a bit obvious whenever you're working with extraUtilsCommands

pkgs/os-specific/linux/plymouth/default.nix

* default to bgrt * don't use KillMode=none https://gitlab.freedesktop.org/plymouth/plymouth/-/issues/123 * multiple outputs * fix spinfinity logo file

Much better to provide a helpful message than to get an obscure sed message.

The BGRT theme is probably a close as to "FlickerFree" we can get without NixOS#74842. It's more agnostic than the Breeze theme. We also install all of themes provided by the packages, as it's possible that one theme needs the ImageDir of another, and they're small files anyways. Lastly, how plymouth handles logo and header files is a total mess, so hopefully when they have an actual release we won't need to do all this symlinking.

This looks cohesive with the spinner in the bgrt theme.

nixos-discourse · 2021-02-26T15:17:33Z

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/what-are-your-goals-for-21-05/11559/7

worldofpeace · 2021-03-03T09:02:13Z

Planning to merge this in a few days. Has been running totally fine on my machine.

bbigras · 2021-03-04T17:18:33Z

Do I only need this to test with nvidia?

{
  boot.plymouth.enable = true;
  initrd.availableKernelModules = [ "nvidia" ];
}

I don't see plymouth while booting. I'm using systemd-boot.

bbigras · 2021-03-04T22:49:05Z

I just tested on my laptop (i915). As expected (I think), the splash is only visible after I input the LUKS password and when I shutdown.

It's pretty :) Great work!

I wonder if plymouth could be visible while selecting the nix generation with systemd-boot.

worldofpeace · 2021-03-04T23:31:24Z

the splash is only visible after I input the LUKS password and when I shutdown.

Yep, once we have #88789 we'll have that through plymouth also.

bbigras · 2021-03-04T23:55:22Z

Oh, I was able to test with nvidia proprietary with:

{
    initrd.availableKernelModules = [ "nvidia" "nvidia_modeset" "nvidia_uvm" "nvidia_drm" ];

    kernelParams = [
      "nvidia-drm.modeset=1"
      "quiet"
      "splash"
    ];
}

I had some console text, then plymouth was visible, a black screen and then gdm.

Do you want me to open a new issue for that? and maybe wait for the PR to be in unstable.

worldofpeace · 2021-03-05T00:58:41Z

Do you want me to open a new issue for that? and maybe wait for the PR to be in unstable.

"If you have an AMD or Nvidia GPU driving your screen, then this is normal. The graphics drivers for AMD and Nvidia GPUs reset the hardware when loading, this will cause the display to temporarily go black. There is nothing which can be done about this."

https://hansdegoede.livejournal.com/20632.html

nixos-discourse · 2021-03-26T15:45:16Z

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/what-are-your-goals-for-21-05/11559/18

worldofpeace requested review from a team and samueldr February 22, 2021 13:15

ofborg bot added 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: module (update) This PR changes an existing module in `nixos/` labels Feb 22, 2021

worldofpeace force-pushed the plymouth-bgrt branch from 98cfacd to feb0443 Compare February 22, 2021 13:44

ofborg bot added 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 11-100 labels Feb 22, 2021

SuperSandro2000 reviewed Feb 22, 2021

View reviewed changes

andersk reviewed Feb 22, 2021

View reviewed changes

davidak mentioned this pull request Feb 23, 2021

resolved don't use default dns server #114118

Closed

michaelpj reviewed Feb 24, 2021

View reviewed changes

pkgs/os-specific/linux/plymouth/default.nix Outdated Show resolved Hide resolved

worldofpeace force-pushed the plymouth-bgrt branch from feb0443 to 5c17124 Compare February 24, 2021 17:26

worldofpeace mentioned this pull request Feb 25, 2021

gnome3.gdm: use white nixos logo #114387

Merged

10 tasks

worldofpeace force-pushed the plymouth-bgrt branch from 5c17124 to c1bbc56 Compare February 25, 2021 20:04

nixos/plymouth: use upstream defaults

f4208fe

https://gitlab.freedesktop.org/plymouth/plymouth/-/issues/101 https://gitlab.freedesktop.org/plymouth/plymouth/-/blob/75204a2517658c01bd1d39f2dff845512c9cab12/src/plymouthd.defaults

worldofpeace force-pushed the plymouth-bgrt branch from c1bbc56 to ed8b7a0 Compare February 25, 2021 20:19

jtojnar reviewed Feb 25, 2021

View reviewed changes

worldofpeace force-pushed the plymouth-bgrt branch from ed8b7a0 to 4fb91ba Compare February 25, 2021 21:18

jtojnar reviewed Feb 25, 2021

View reviewed changes

pkgs/os-specific/linux/plymouth/default.nix Outdated Show resolved Hide resolved

worldofpeace added 2 commits February 25, 2021 16:46

plymouth: 0.9.4 -> 2020-12-07

dd88056

* default to bgrt * don't use KillMode=none https://gitlab.freedesktop.org/plymouth/plymouth/-/issues/123 * multiple outputs * fix spinfinity logo file

nixos/plymouth: exit on missing theme

726dd98

Much better to provide a helpful message than to get an obscure sed message.

worldofpeace added 2 commits February 25, 2021 16:46

nixos/plymouth: use white nixos logo

9e84dc0

This looks cohesive with the spinner in the bgrt theme.

worldofpeace force-pushed the plymouth-bgrt branch from 4fb91ba to 9e84dc0 Compare February 25, 2021 21:46

worldofpeace merged commit 583f1a9 into NixOS:master Mar 4, 2021

worldofpeace deleted the plymouth-bgrt branch March 4, 2021 23:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

nixos/plymouth: use bgrt theme #114000

nixos/plymouth: use bgrt theme #114000

worldofpeace commented Feb 22, 2021 •

edited

Loading

r-rmcgibbo commented Feb 22, 2021 •

edited

Loading

SuperSandro2000 Feb 22, 2021

michaelpj Feb 24, 2021

worldofpeace Feb 24, 2021

SuperSandro2000 Feb 22, 2021

andersk Feb 22, 2021

worldofpeace Feb 24, 2021

andersk Feb 24, 2021 •

edited

Loading

SuperSandro2000 Feb 25, 2021

davidak commented Feb 23, 2021

worldofpeace commented Feb 23, 2021 •

edited

Loading

davidak commented Feb 23, 2021

worldofpeace commented Feb 23, 2021

samueldr commented Feb 23, 2021

worldofpeace commented Feb 24, 2021

michaelpj Feb 24, 2021

worldofpeace commented Feb 25, 2021

jtojnar Feb 25, 2021

jtojnar Feb 25, 2021

worldofpeace Feb 25, 2021

nixos-discourse commented Feb 26, 2021

worldofpeace commented Mar 3, 2021

bbigras commented Mar 4, 2021

bbigras commented Mar 4, 2021

worldofpeace commented Mar 4, 2021

bbigras commented Mar 4, 2021

worldofpeace commented Mar 5, 2021

nixos-discourse commented Mar 26, 2021

	default = [ ] ++ lib.optional (cfg.theme == "breeze") nixosBreezePlymouth;
	default = lib.optional (cfg.theme == "breeze") nixosBreezePlymouth;

	ln -s $logo $out/etc/plymouth/logo.png
	ln -s "${cfg.logo}" "$out/etc/plymouth/logo.png"


		# patch out any attempted references to the theme or plymouth's themes directory
		# Use -L to copy the directories proper, not the symlinks to them.

nixos/plymouth: use bgrt theme #114000

nixos/plymouth: use bgrt theme #114000

Conversation

worldofpeace commented Feb 22, 2021 • edited Loading

Motivation for this change

Todo's:

Questions:

Thanks

Things done

r-rmcgibbo commented Feb 22, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andersk Feb 24, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

davidak commented Feb 23, 2021

worldofpeace commented Feb 23, 2021 • edited Loading

davidak commented Feb 23, 2021

worldofpeace commented Feb 23, 2021

samueldr commented Feb 23, 2021

worldofpeace commented Feb 24, 2021

Choose a reason for hiding this comment

worldofpeace commented Feb 25, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nixos-discourse commented Feb 26, 2021

worldofpeace commented Mar 3, 2021

bbigras commented Mar 4, 2021

bbigras commented Mar 4, 2021

worldofpeace commented Mar 4, 2021

bbigras commented Mar 4, 2021

worldofpeace commented Mar 5, 2021

nixos-discourse commented Mar 26, 2021

worldofpeace commented Feb 22, 2021 •

edited

Loading

r-rmcgibbo commented Feb 22, 2021 •

edited

Loading

andersk Feb 24, 2021 •

edited

Loading

worldofpeace commented Feb 23, 2021 •

edited

Loading