zfsbootmenu: add sysrq-based reboot/poweroff

zbm-dev · Sep 27, 2023 · e93de79 · e93de79
1 parent 6afe2ff
commit e93de79
Show file tree

Hide file tree

Showing 10 changed files with 138 additions and 16 deletions.
diff --git a/docs/online/recovery-shell.rst b/docs/online/recovery-shell.rst
@@ -51,3 +51,11 @@ Common Commands
 **logs**
 
   View warning/error/debug logs.
+
+**shutdown**|**poweroff**
+
+  Shutdown the system using a SysRq magic invocation.
+
+**reboot**
+
+  Reboot the system using a SysRq magic invocation.
diff --git a/zfsbootmenu/bin/poweroff b/zfsbootmenu/bin/poweroff
@@ -0,0 +1 @@
+reboot
diff --git a/zfsbootmenu/bin/reboot b/zfsbootmenu/bin/reboot
@@ -0,0 +1,42 @@
+#!/bin/bash
+# vim: softtabstop=2 shiftwidth=2 expandtab
+
+# shellcheck disable=SC1091
+sources=(
+  /lib/kmsg-log-lib.sh
+  /lib/zfsbootmenu-core.sh
+)
+
+for src in "${sources[@]}"; do
+  # shellcheck disable=SC1090
+  if ! source "${src}" >/dev/null 2>&1 ; then
+    echo -e "\033[0;31mWARNING: ${src} was not sourced; unable to proceed\033[0m"
+    exit 1
+  fi
+done
+
+unset src sources
+
+case "${0##*/}" in
+  reboot)
+    trigger="b"
+    ;;
+  shutdown|poweroff)
+    trigger="o"
+    ;;
+  *)
+    exit
+    ;;
+esac
+
+while read -r _pool; do
+  is_writable "${_pool}" && export_pool "${_pool}"
+done <<<"$( zpool list -H -o name )"
+
+sysrq="/proc/sysrq-trigger"
+if [ -e  "${sysrq}" ] && [ -w "${sysrq}" ]; then
+  echo "${trigger}" > /proc/sysrq-trigger
+else
+  echo "${sysrq} does not exist, hard reset system"
+  exit 1
+fi
diff --git a/zfsbootmenu/bin/shutdown b/zfsbootmenu/bin/shutdown
@@ -0,0 +1 @@
+reboot
diff --git a/zfsbootmenu/help-files/132/recovery-shell.ansi b/zfsbootmenu/help-files/132/recovery-shell.ansi
@@ -51,3 +51,11 @@
   [1mlogs[0m
 
     View warning/error/debug logs.
+
+  [1mshutdown**|**poweroff[0m
+
+    Shutdown the system using a SysRq magic invocation.
+
+  [1mreboot[0m
+
+    Reboot the system using a SysRq magic invocation.
diff --git a/zfsbootmenu/help-files/132/zfsbootmenu.7.ansi b/zfsbootmenu/help-files/132/zfsbootmenu.7.ansi
@@ -162,6 +162,11 @@
 
       [1mNOTE[0m: The [33mhooklist[0m argument [1mMUST NOT[0m contain spaces and [1mMUST NOT[0m be enclosed in quotes.
 
+    [1mzbm.autosize[0m
+
+      Enable automatic font resizing of the kernel console to normalize the apparent resolution for both low resolution and high
+      resolution displays. This option is enabled by default.
+
     [1mDeprecated Parameters[0m
 
       [1mtimeout[0m
@@ -344,7 +349,7 @@
       Boot-selection hooks will be installed from the directory [33m${zfsbootmenu_hook_root}/boot-sel.d[0m. These hooks will be executed
       after a user has selected a boot environment, but before ZFSBootMenu attempts to load and boot the kernel.
 
-      Teardown hooks will be installed from the directory [33m${zfsbootmenu_hook_root}/teardown.d[0m. These hooks will be exectued after
+      Teardown hooks will be installed from the directory [33m${zfsbootmenu_hook_root}/teardown.d[0m. These hooks will be executed after
       the kernel for a selected environment has been loaded and is launching via [1mkexec[0m is imminent. Some hardware initialized
       by the ZFSBootMenu kernel may not be properly reinitialized when a boot environment is launched; teardown hooks may be
       useful to unbind drivers from problematic hardware or remove associated kernel modules.
@@ -364,9 +369,16 @@
 
         The path to the initramfs corresponding to the selected kernel, again relative to the root of [1mZBM_SELECTED_BE[0m.
 
-      No boot-selection or teardown hook should assume that the filesystem named in [1mZBM_SELECTED_BE[0m is currently mounted. In
-      addition, no teardown hook should assume that the ZFSBootMenu environment is in a consistent operating state.
-      ZFSBootMenu may have exported some or all pools prior to executing teardown hooks.
+      Additionally, boot-selection hooks will have access to a fourth environment variable:
+
+      [1mZBM_SELECTED_MOUNTPOINT[0m
+
+        The path where the selected boot environment is currently mounted, which is the root relative to which ZFSBootMenu will
+        attempt to load the selected kernel and initramfs.
+
+      Teardown hooks should never assume that the filesystem named in [1mZBM_SELECTED_BE[0m is currently mounted. In addition, no teardown
+      hook should assume that the ZFSBootMenu environment is in a consistent operating state. ZFSBootMenu may have exported
+      some or all pools prior to executing teardown hooks.
 
       In general, it is not possible to cleanly abort a boot attempt from boot-selection or teardown hooks. However, a
       boot-selection or teardown hook may take control of the boot attempt by implementing its own [1mkexec[0m load and execution

diff --git a/zfsbootmenu/help-files/52/recovery-shell.ansi b/zfsbootmenu/help-files/52/recovery-shell.ansi
@@ -62,3 +62,13 @@
   [1mlogs[0m
 
     View warning/error/debug logs.
+
+  [1mshutdown**|**poweroff[0m
+
+    Shutdown the system using a SysRq magic
+    invocation.
+
+  [1mreboot[0m
+
+    Reboot the system using a SysRq magic
+    invocation.
diff --git a/zfsbootmenu/help-files/52/zfsbootmenu.7.ansi b/zfsbootmenu/help-files/52/zfsbootmenu.7.ansi
@@ -274,6 +274,14 @@
       spaces and [1mMUST NOT[0m be enclosed in
       quotes.
 
+    [1mzbm.autosize[0m
+
+      Enable automatic font resizing of the kernel
+      console to normalize the apparent
+      resolution for both low resolution and
+      high resolution displays. This option is
+      enabled by default.
+
     [1mDeprecated Parameters[0m
 
       [1mtimeout[0m
@@ -596,7 +604,7 @@
 
       Teardown hooks will be installed from the
       directory [33m${zfsbootmenu_hook_root}/-
-      teardown.d[0m. These hooks will be exectued
+      teardown.d[0m. These hooks will be executed
       after the kernel for a selected
       environment has been loaded and is
       launching via [1mkexec[0m is imminent. Some
@@ -630,11 +638,22 @@
         the selected kernel, again relative
         to the root of [1mZBM_SELECTED_BE[0m.
 
-      No boot-selection or teardown hook should
-      assume that the filesystem named in
-      [1mZBM_SELECTED_BE[0m is currently mounted. In
-      addition, no teardown hook should assume
-      that the ZFSBootMenu environment is in a
+      Additionally, boot-selection hooks will have
+      access to a fourth environment variable:
+
+      [1mZBM_SELECTED_MOUNTPOINT[0m
+
+        The path where the selected boot environment
+        is currently mounted, which is the
+        root relative to which ZFSBootMenu
+        will attempt to load the selected
+        kernel and initramfs.
+
+      Teardown hooks should never assume that the
+      filesystem named in [1mZBM_SELECTED_BE[0m is
+      currently mounted. In addition, no
+      teardown hook should assume that the
+      ZFSBootMenu environment is in a
       consistent operating state. ZFSBootMenu
       may have exported some or all pools
       prior to executing teardown hooks.

diff --git a/zfsbootmenu/help-files/92/recovery-shell.ansi b/zfsbootmenu/help-files/92/recovery-shell.ansi
@@ -52,3 +52,11 @@
   [1mlogs[0m
 
     View warning/error/debug logs.
+
+  [1mshutdown**|**poweroff[0m
+
+    Shutdown the system using a SysRq magic invocation.
+
+  [1mreboot[0m
+
+    Reboot the system using a SysRq magic invocation.
diff --git a/zfsbootmenu/help-files/92/zfsbootmenu.7.ansi b/zfsbootmenu/help-files/92/zfsbootmenu.7.ansi
@@ -191,6 +191,12 @@
       [1mNOTE[0m: The [33mhooklist[0m argument [1mMUST NOT[0m contain spaces and [1mMUST NOT[0m be enclosed in
       quotes.
 
+    [1mzbm.autosize[0m
+
+      Enable automatic font resizing of the kernel console to normalize the apparent
+      resolution for both low resolution and high resolution displays. This option is
+      enabled by default.
+
     [1mDeprecated Parameters[0m
 
       [1mtimeout[0m
@@ -414,7 +420,7 @@
       boot the kernel.
 
       Teardown hooks will be installed from the directory
-      [33m${zfsbootmenu_hook_root}/teardown.d[0m. These hooks will be exectued after the
+      [33m${zfsbootmenu_hook_root}/teardown.d[0m. These hooks will be executed after the
       kernel for a selected environment has been loaded and is launching via [1mkexec[0m is
       imminent. Some hardware initialized by the ZFSBootMenu kernel may not be
       properly reinitialized when a boot environment is launched; teardown hooks may
@@ -437,11 +443,18 @@
         The path to the initramfs corresponding to the selected kernel, again relative to
         the root of [1mZBM_SELECTED_BE[0m.
 
-      No boot-selection or teardown hook should assume that the filesystem named in
-      [1mZBM_SELECTED_BE[0m is currently mounted. In addition, no teardown hook should
-      assume that the ZFSBootMenu environment is in a consistent operating state.
-      ZFSBootMenu may have exported some or all pools prior to executing teardown
-      hooks.
+      Additionally, boot-selection hooks will have access to a fourth environment variable:
+
+      [1mZBM_SELECTED_MOUNTPOINT[0m
+
+        The path where the selected boot environment is currently mounted, which is the root
+        relative to which ZFSBootMenu will attempt to load the selected kernel and
+        initramfs.
+
+      Teardown hooks should never assume that the filesystem named in [1mZBM_SELECTED_BE[0m is
+      currently mounted. In addition, no teardown hook should assume that the
+      ZFSBootMenu environment is in a consistent operating state. ZFSBootMenu may have
+      exported some or all pools prior to executing teardown hooks.
 
       In general, it is not possible to cleanly abort a boot attempt from boot-selection or
       teardown hooks. However, a boot-selection or teardown hook may take control of