{"id":127159,"date":"2022-08-10T08:07:00","date_gmt":"2022-08-10T08:07:00","guid":{"rendered":"https:\/\/fedoramagazine.org\/?p=36859"},"modified":"2022-08-10T08:07:00","modified_gmt":"2022-08-10T08:07:00","slug":"hibernation-in-fedora-workstation","status":"publish","type":"post","link":"https:\/\/sickgaming.net\/blog\/2022\/08\/10\/hibernation-in-fedora-workstation\/","title":{"rendered":"Hibernation in Fedora Workstation"},"content":{"rendered":"

This article walks you through the manual setup for hibernation in Fedora Linux 36 Workstation using BTRFS and is based on a gist by eloylp on github<\/a>.<\/p>\n

<\/span> <\/p>\n

Goal and Rationale<\/h2>\n

Hibernation stores the current runtime state of your machine – effectively the contents of your RAM, onto disk and does a clean shutdown. Upon next boot this state is restored from disk to memory such that everything, including open programs, is how you left it.<\/p>\n

Fedora Workstation uses ZRAM. This is a sophisticated approach to swap using compression inside a portion of your RAM to avoid the slower on-disk swap files. Unfortunately this means you don’t have persistent space to move your RAM upon hibernation when powering off your machine.<\/p>\n

How it works<\/h2>\n

The technique configures systemd<\/em> and dracut<\/em> to store and restore the contents of your RAM in a temporary swap file on disk. The swap file is created just before and removed right after hibernation to avoid trouble with ZRAM. A persistent swap file is not recommended in conjunction with ZRAM, as it creates some confusing problems compromising your systems stability.<\/p>\n

A word on compatibility and expectations<\/h2>\n

Hibernation following this guide might not work flawless on your particular machine(s). Due to possible shortcomings of certain drivers you might experience glitches like non-working wifi or display after resuming from hibernation. In that case feel free to reach out to the comment section of the gist on github<\/a>, or try the tips from the troubleshooting section at the bottom of this article.<\/p>\n

The changes introduced in this article are linked to the systemd hibernation.service and hibernation.target units and hence won’t execute on their own nor interfere with your system if you don’t initiate a hibernation. That being said, if it does not work it still adds some small bloat which you might want to remove.<\/p>\n

Hibernation in Fedora Workstation<\/h2>\n

The first step is to create a btrfs sub volume to contain the swap file.<\/p>\n

$ btrfs subvolume create \/swap<\/strong><\/pre>\n
In order to calculate the size of your swap file use swapon<\/em> to get the size of your zram<\/em> device.<\/p>\n
$ swapon<\/strong>\nNAME TYPE SIZE USED PRIO\n\/dev\/zram0 partition 8G 0B 100<\/pre>\n
In this example the machine has 16G of RAM and a 8G zram device. ZRAM stores roughly double the amount of system RAM compressed in a portion of your RAM. Let that sink in for a moment. This means that in total the memory of this machine can hold 8G * 2 + 8G of RAM which equals 24G uncompressed data. Create and configure the swapfile using the following commands.<\/p>\n
$ touch \/swap\/swapfile<\/strong>\n# Disable Copy On Write on the file<\/em>\n$ chattr +C \/swap\/swapfile\n$ fallocate --length 24G \/swap\/swapfile\n$ chmod 600 \/swap\/swapfile $ mkswap \/swap\/swapfile<\/strong><\/pre>\n
Modify the dracut configuration and rebuild your initramfs to include the <\/p>\n
\n
resume<\/div>\n<\/div>\n
 module, so it can later restore the state at boot.<\/p>\n
$ cat <<-EOF | sudo tee \/etc\/dracut.conf.d\/resume.conf<\/strong>\nadd_dracutmodules+=\" resume \"<\/strong>\nEOF\n$ dracut -f<\/strong><\/pre>\n
In order to configure grub to tell the kernel to resume from hibernation using the swapfile, you need the UUID and the physical offset.<\/p>\n
Use the following command to determine the UUID of the swap file and take note of it.<\/p>\n
$ findmnt -no UUID -T \/swap\/swapfile<\/strong>\ndbb0f71f-8fe9-491e-bce7-4e0e3125ecb8<\/pre>\n
Calculate the correct offset. In order to do this you’ll unfortunately need gcc<\/em> and the source of the btrfs_map_physical tool<\/a>, which computes the physical offset of the swapfile on disk. Invoke gcc in the directory you placed the source in and run the tool.<\/p>\n
$ gcc -O2 -o btrfs_map_physical btrfs_map_physical.c<\/strong>\n$ .\/btrfs_map_physical \/path\/to\/swapfile<\/strong> FILE OFFSET EXTENT TYPE LOGICAL SIZE LOGICAL OFFSET PHYSICAL SIZE DEVID PHYSICAL OFFSET\n0 regular 4096 2927632384 268435456 1 <4009762816>\n4096 prealloc 268431360 2927636480 268431360 1 4009766912\n268435456 prealloc 268435456 3251634176 268435456 1 4333764608\n536870912 prealloc 268435456 3520069632 268435456 1 4602200064\n805306368 prealloc 268435456 3788505088 268435456 1 4870635520\n1073741824 prealloc 268435456 4056940544 268435456 1 5139070976\n1342177280 prealloc 268435456 4325376000 268435456 1 5407506432\n1610612736 prealloc 268435456 4593811456 268435456 1 5675941888<\/pre>\n
The first value in the PHYSICAL OFFSET<\/em> column is the relevant one. In the above example it is 4009762816<\/strong>.<\/p>\n
Take note of the pagesize<\/em> you get from getconf PAGESIZE<\/em>.<\/p>\n
Calculate the kernel resume_offset<\/em> through division of physical offset<\/em> by the pagesize<\/em>. In this example that is 4009762816 \/ 4096 = 978946<\/em>.<\/p>\n
Update your grub configuration file and add the resume<\/em> and resume_offset<\/em> kernel cmdline parameters.<\/p>\n
grubby --args=\"resume=UUID=dbb0f71f-8fe9-491e-bce7-4e0e3125ecb8 resume_offset=2459934\" --update-kernel=ALL<\/pre>\n
The created swapfile<\/em> is only used in the hibernation stage of system shutdown and boot hence not configured in fstab<\/em>. Systemd units control this behavior, so create the two units hibernate-preparation.service<\/em> and hibernate-resume.service<\/em>.<\/p>\n
$ cat <<-EOF | sudo tee \/etc\/systemd\/system\/hibernate-preparation.service<\/strong>\n[Unit]\nDescription=Enable swap file and disable zram before hibernate\nBefore=systemd-hibernate.service [Service]\nUser=root\nType=oneshot\nExecStart=\/bin\/bash -c \"\/usr\/sbin\/swapon \/swap\/swapfile && \/usr\/sbin\/swapoff \/dev\/zram0\" [Install]\nWantedBy=systemd-hibernate.service\nEOF\n$ systemctl enable hibernate-preparation.service<\/strong>\n$ cat <<-EOF | sudo tee \/etc\/systemd\/system\/hibernate-resume.service<\/strong>\n[Unit]\nDescription=Disable swap after resuming from hibernation\nAfter=hibernate.target [Service]\nUser=root\nType=oneshot\nExecStart=\/usr\/sbin\/swapoff \/swap\/swapfile [Install]\nWantedBy=hibernate.target\nEOF\n$ systemctl enable hibernate-resume.service<\/strong><\/pre>\n
Systemd does memory checks on login and hibernation. In order to avoid issues when moving the memory back and forth between swapfile<\/em> and zram<\/em> disable some of them.<\/p>\n
$ mkdir -p \/etc\/systemd\/system\/systemd-logind.service.d\/\n$ cat <<-EOF | sudo tee \/etc\/systemd\/system\/systemd-logind.service.d<\/strong>\/override.conf\n[Service]\nEnvironment=SYSTEMD_BYPASS_HIBERNATION_MEMORY_CHECK=1\nEOF\n$ mkdir -p \/etc\/systemd\/system\/systemd-hibernate.service.d\/\n$ cat <<-EOF | sudo tee \/etc\/systemd\/system\/systemd-hibernate.service.d\/override.conf<\/strong>\n[Service]\nEnvironment=SYSTEMD_BYPASS_HIBERNATION_MEMORY_CHECK=1\nEOF<\/pre>\n
Reboot your machine for the changes to take effect<\/strong>. The following SELinux configuration won’t work if you don’t reboot first.<\/p>\n
SELinux won’t like hibernation attempts just yet. Change that with a new policy. An easy although “brute” approach is to initiate hibernation and use the audit log of this failed attempt via audit2allow<\/em>. The following command will fail, returning you to a login prompt.<\/p>\n
systemctl hibernate<\/pre>\n
After you’ve logged in again check the audit log, compile a policy and install it. The -b<\/em> option filters for audit log entries from last boot. The -M<\/em> option compiles all filtered rules into a module, which is then installed using semodule -i<\/em>.<\/p>\n
$ audit2allow -b<\/strong>\n#============= systemd_sleep_t ==============\nallow systemd_sleep_t unlabeled_t:dir search;\n$ cd \/tmp\n$ audit2allow -b -M systemd_sleep\n$ semodule -i systemd_sleep.pp<\/strong><\/pre>\n
Check that hibernation is working via systemctl hibernate<\/em> again. After resume check that ZRAM is indeed the only active swap device.<\/p>\n
$ swapon<\/strong>\nNAME TYPE SIZE USED PRIO\n\/dev\/zram0 partition 8G 0B 100<\/pre>\n
You now have hibernation configured.<\/p>\n
GNOME Shell hibernation integration<\/h2>\n
You might want to add a hibernation button to the GNOME Shell “Power Off \/ Logout” section. Check out the extension Hibernate Status Button<\/a> to do so.<\/p>\n
Troubleshooting<\/h2>\n
A first place to troubleshoot any problems is through journalctl -b<\/em>. Have a look around the end of the log, after trying to hibernate, to pin-point log entries that tell you what might be wrong.<\/p>\n
Another source of information on errors is the Problem Reporting tool. Especially problems, that are not common but more specific to your hardware configuration. Have a look at it before and after attempting hibernation and see if something comes up. Follow up on any issues via BugZilla and see if others experience similar problems.<\/p>\n
Revert the changes<\/h2>\n
To reverse the changes made above, follow this check-list:<\/p>\n