Hibernation script and Solus

rincor

I ran this script on machine running Mint, for setting up hibernation, and it worked perfectly.
Would it work on Solus too, taking into account its different base?


# Script to setup hibernation in Linux Mint 22
# Author: Random Person
# Data: 2024-08-12
# Based on: https://ubuntuhandbook.org/index.php/2021/08/enable-hibernate-ubuntu-21-10

# Print text inside a boxed border.
box_title() {
    local len=$((${#1}+2))

    printf "\n╔"
    printf -- "═%.0s" $(seq 1 $len)
    printf "╗\n║ $1 ║\n╚"
    printf -- "═%.0s" $(seq 1 $len)
    printf "╝\n\n"
}

# Setup swap file
setup_swap() {
    echo
    echo "Setting up the swap file."
    echo "Please wait..."
    echo

    swapoff -a
    rm -f /swapfile
    dd if=/dev/zero of=/swapfile bs=1M count=$needed
    chmod 0600 /swapfile
    mkswap /swapfile
    sed -i '/swap/{s/^/#/}' /etc/fstab
    tee -a /etc/fstab <<< "/swapfile  none  swap  sw 0  0"
    swapon -a
}

# Setup Hibernate
setup_hibernate() {
    local resume_params="resume=UUID=$(findmnt / -o UUID -n) resume_offset=$(filefrag -v /swapfile|awk 'NR==4{gsub(/\./,"");print $4;}') "
    

    echo
    echo "Setting up hibernation."
    echo "Please wait..."
    echo
    

    # Adds kernel parameter in grub boot configuration file
    if grep resume /etc/default/grub>/dev/null; then
        sed -i "s/GRUB_CMDLINE_LINUX_DEFAULT=\".*resume_offset=[0-9]* /GRUB_CMDLINE_LINUX_DEFAULT=\"$resume_params/" /etc/default/grub
    else
        sed -i "s/GRUB_CMDLINE_LINUX_DEFAULT=\"/GRUB_CMDLINE_LINUX_DEFAULT=\"$resume_params/" /etc/default/grub
    fi
    update-grub

    # Adds device major:minor numbers in resume configuration
    echo $(findmnt / -o MAJ:MIN -n) > /sys/power/resume
    echo "#    Path                   Mode UID  GID  Age Argument" > /etc/tmpfiles.d/hibernation_resume.conf
    echo "w    /sys/power/resume       -    -    -    -   $(findmnt / -o MAJ:MIN -n)" >> /etc/tmpfiles.d/hibernation_resume.conf

    # Adds hibernation option in power-off menu
    apt install -y -qq polkitd-pkla

    mkdir -p /etc/polkit-1/localauthority/50-local.d
    tee /etc/polkit-1/localauthority/50-local.d/com.ubuntu.enable-hibernate.pkla << 'EOB' >/dev/null
[Re-enable hibernate by default in upower]
Identity=unix-user:*
Action=org.freedesktop.upower.hibernate
ResultActive=yes

[Re-enable hibernate by default in logind]
Identity=unix-user:*
Action=org.freedesktop.login1.hibernate;org.freedesktop.login1.handle-hibernate-key;org.freedesktop.login1;org.freedesktop.login1.hibernate-multiple-sessions;org.freedesktop.login1.hibernate-ignore-inhibit
ResultActive=yes
EOB

    mkdir -p /etc/polkit-1/localauthority/90-mandatory.d
    tee /etc/polkit-1/localauthority/90-mandatory.d/enable-hibernate.pkla << 'EOB' >/dev/null
[Enable hibernate]
Identity=unix-user:*
Action=org.freedesktop.login1.hibernate;org.freedesktop.login1.handle-hibernate-key;org.freedesktop.login1;org.freedesktop.login1.hibernate-multiple-sessions
ResultActive=yes
EOB

    mkdir -p /etc/polkit-1/rules.d
    tee /etc/polkit-1/rules.d/10-enable-hibernate.rules << 'EOB' >/dev/null
polkit.addRule(function(action, subject) {
    if (action.id == \"org.freedesktop.login1.hibernate\" ||
        action.id == \"org.freedesktop.login1.hibernate-multiple-sessions\" ||
        action.id == \"org.freedesktop.upower.hibernate\" ||
        action.id == \"org.freedesktop.login1.handle-hibernate-key\" ||
        action.id == \"org.freedesktop.login1.hibernate-ignore-inhibit\")
    {
        return polkit.Result.YES;
    }
});
EOB

    echo
    echo "Hibernation setup completed."
    echo "Please reboot your system for all changes to take effect."
    echo
}

main() {
    local available=$(df -m / | tail -n1 | awk '{print $4}')
    local swap=$(free -m | tail -n1 | awk '{print $2}')
    local needed=$(($1 * 1024))

    box_title "Setup Hibernate"

    if [[ ! `id -u` -eq "0" ]] || [[ "$#" != "1" ]] || ! [[ $1 =~ ^[0-9]+$ ]]; then
        echo    

        echo "Use: sudo bash setup-hibernate.sh [SIZE]"
        echo "[SIZE] => Swap size in GB."
        echo
    else
        # Check required swap file size
        available=$(($available + $swap))
        if [ "$available" -gt "$needed" ]; then
            setup_swap
            setup_hibernate
        else
            echo
            echo "Hibernate setup aborted."
            echo "Available swap space: $available"
            echo "Needed swap space: $needed"
            echo    

        fi
    fi
}

main "$@"```

nolan

The script adds configurations for GRUB but Solus uses clr-boot-manager, so no, the script won't work for Solus.
To my experience, hibernation can be enabled at install.

rincor

nolan To my experience, hibernation can be enabled at install.

You mean there is like a checkbox for creating a swapfile for hibernation?
AFAIK MX-Linux is the only distro that includes that option in the installer.

sheepman4267

rincor I can confirm that there is indeed an option in the Solus installer for how much swap to create. The available options are "None", "Swap" and "Swap+Hibernate" (or something like that), the last of which will create a swap partition large enough to accommodate swap + your system's entire RAM size, which is what enables hibernate.

If you've got enough swap space configured, hibernate should Just Work (tm) on Solus. I know from long experience that it works perfectly on Plasma, at least with Intel graphics.

But no, the script you posted won't work on Solus.

rincor

You were right, there is that option in the installer. I installed Solus on another laptop and so far it has worked without problems. Thanks for the heads up!
Had I known that I would have installed Solus on my other laptop too instead of Mint.
I think that feature should be mentioned on the Solus homepage, so it shows up during a search. I googled it but didn't get any hits for any distros, and it's a often requested but missing feature in most distros.