De-prioritize Dracut as the primary generator

All core ZFSBootMenu libraries / hooks / binaries have been moved to a
generic 'zfsbootmenu' directory intended to be installed in /usr/share.
The dracut-specific module-setup.sh script has been moved to a 'dracut'
directory and it, along with the 'initcpio' hook scripts, have been
adapted to use common tooling in 'zfsbootmenu/install-helpers.sh'. Both
of these refer to the core components in '/usr/share/zfsbootmenu' when
creating a new image. The zbm-kcl utilit looks there by default.

The testing tools are now capable of producing images with mkinitcpio.

Co-authored-by: Zach Dykstra <[email protected]>
Co-authored-by: Andrew J. Hesford <[email protected]>

Author: zdykstra

.github/workflows/build.yml

@@ -14,6 +14,7 @@ jobs:
         run: |
           ln -s "$(pwd)" /zbm
           cp /zbm/etc/zfsbootmenu/release.conf.d/release.conf /zbm/etc/zfsbootmenu/dracut.conf.d/
+          echo "zfsbootmenu_module_root='/zbm/zfsbootmenu'" >> /zbm/etc/zfsbootmenu/dracut.conf.d/release.conf
           /zbm/releng/docker/zbm-build.sh -e '.Global.DracutFlags += ["--no-early-microcode"]' -- --debug
 
       - name: Archive EFI

Makefile

@@ -1,26 +1,32 @@
 DESTDIR=
 PREFIX=/usr
 CONFDIR=/etc/zfsbootmenu
-MODDIR=$(PREFIX)/lib/dracut/modules.d
+MODDIR=$(PREFIX)/share
+DRACUTDIR=$(PREFIX)/lib/dracut/modules.d
+INITCPIODIR=$(PREFIX)/lib/initcpio
 MANDIR=$(PREFIX)/share/man
 BINDIR=$(PREFIX)/bin
 EXAMPLES=$(PREFIX)/share/examples/zfsbootmenu
 
-.PHONY: install default
+.PHONY: install core dracut initcpio
 
-default:
+install: core dracut initcpio
 
-install:
-	# Recursively install non-executable parts of the Dracut module
-	find 90zfsbootmenu -type f -not -perm /111 -exec \
-		install -Dm 0644 "{}" "$(DESTDIR)$(MODDIR)/{}" \;
-	# Executable parts of the module
-	find 90zfsbootmenu -type f -perm /111 -exec \
-		install -Dm 0755 "{}" "$(DESTDIR)$(MODDIR)/{}" \;
+core:
+	./install-tree.sh zfsbootmenu "$(DESTDIR)$(MODDIR)"
 	install -m 0644 -t "$(DESTDIR)$(CONFDIR)" -D etc/zfsbootmenu/config.yaml
-	install -m 0644 -t "$(DESTDIR)$(CONFDIR)/dracut.conf.d/" -D etc/zfsbootmenu/dracut.conf.d/*
 	install -m 0755 -t "$(DESTDIR)$(BINDIR)" -D bin/*
 	install -m 0644 -t "$(DESTDIR)$(MANDIR)/man5" -D man/*.5
 	install -m 0644 -t "$(DESTDIR)$(MANDIR)/man7" -D man/*.7
 	install -m 0644 -t "$(DESTDIR)$(MANDIR)/man8" -D man/*.8
 	install -m 0755 -t "$(DESTDIR)$(EXAMPLES)" -D contrib/*
+
+dracut:
+	./install-tree.sh dracut "$(DESTDIR)$(DRACUTDIR)/90zfsbootmenu"
+	install -m 0644 -t \
+		"$(DESTDIR)$(CONFDIR)/dracut.conf.d/" \
+		-D etc/zfsbootmenu/dracut.conf.d/*
+
+initcpio:
+	./install-tree.sh initcpio "$(DESTDIR)$(INITCPIODIR)"
+	install -m 0644 -t "$(DESTDIR)$(CONFDIR)" -D etc/zfsbootmenu/mkinitcpio.conf

bin/zbm-kcl

@@ -4,7 +4,7 @@
 zbm_load_lib() {
   lib="${1?no library specified for load}"
 
-  : "${ZBM_MODULEDIR:=/usr/lib/dracut/modules.d/90zfsbootmenu}"
+  : "${ZBM_MODULEDIR:=/usr/share/zfsbootmenu}"
 
   if [ -r "${ZBM_MODULEDIR}/lib/${lib}" ]; then
     # shellcheck disable=SC1090

90zfsbootmenu/module-setup.sh dracut/module-setup.sh90zfsbootmenu/module-setup.sh renamed to dracut/module-setup.sh

@@ -43,6 +43,20 @@ installkernel() {
 }
 
 install() {
+  : "${zfsbootmenu_module_root:=/usr/share/zfsbootmenu}"
+
+  # shellcheck disable=SC1091
+  if ! source "${zfsbootmenu_module_root}/install-helpers.sh" ; then
+    dfatal "Unable to source ${zfsbootmenu_module_root}/install-helpers.sh"
+    exit 1
+  fi
+
+  # BUILDROOT is an initcpio-ism
+  # shellcheck disable=SC2154,2034
+  BUILDROOT="${initdir}"
+  # shellcheck disable=SC2034
+  BUILDSTYLE="dracut"
+
   local _rule _exec _ret
 
   local udev_rules=(
@@ -58,51 +72,14 @@ install() {
     fi
   done
 
-  local essential_execs=(
-    "zfs"
-    "zpool"
-    "zdb"
-    "lsblk"
-    "hostid"
-    "mount"
-    "mount.zfs"
-    "kexec"
-    "mkdir"
-    "tput"
-    "head"
-    "mktemp"
-    "sort"
-    "sed"
-    "grep"
-    "tail"
-    "tr"
-    "tac"
-    "blkid"
-    "awk"
-    "fold"
-    "ps"
-    "env"
-    "chmod"
-    "od"
-    "stty"
-    "insmod"
-    "modinfo"
-    "lsmod"
-    "depmod"
-  )
-
-  for _exec in "${essential_execs[@]}"; do
+  # shellcheck disable=SC2154
+  for _exec in "${zfsbootmenu_essential_binaries[@]}"; do
     if ! dracut_install "${_exec}"; then
       dfatal "failed to install essential executable '${_exec}'"
       exit 1
     fi
   done
 
-  if ! dracut_install fzf; then
-    dfatal "failed to install fzf"
-    exit 1
-  fi
-
   # BE clones will work (silently and less efficiently) without mbuffer
   if ! dracut_install mbuffer; then
     dwarning "mbuffer not found; ZFSBootMenu cannot show progress during BE clones"
@@ -131,54 +108,40 @@ install() {
 
   # shellcheck disable=SC2154
   while read -r doc ; do
-    relative="${doc//${moddir}\//}"
+    relative="${doc//${zfsbootmenu_module_root}\//}"
     inst_simple "${doc}" "/usr/share/docs/${relative}"
-  done <<<"$( find "${moddir}/help-files" -type f )"
+  done <<<"$( find "${zfsbootmenu_module_root}/help-files" -type f )"
 
   _ret=0
 
   # Core ZFSBootMenu functionality
   # shellcheck disable=SC2154
-  for _lib in "${moddir}"/lib/*; do
+  for _lib in "${zfsbootmenu_module_root}"/lib/*; do
     inst_simple "${_lib}" "/lib/$( basename "${_lib}" )" || _ret=$?
   done
 
   # Helper tools not intended for direct human consumption
-  for _libexec in "${moddir}"/libexec/*; do
+  for _libexec in "${zfsbootmenu_module_root}"/libexec/*; do
     inst_simple "${_libexec}" "/libexec/$( basename "${_libexec}" )" || _ret=$?
   done
 
   # User-facing utilities, useful for running in a recover shell
-  for _bin in "${moddir}"/bin/*; do
+  for _bin in "${zfsbootmenu_module_root}"/bin/*; do
     inst_simple "${_bin}" "/bin/$( basename "${_bin}" )" || _ret=$?
   done
 
   # Hooks necessary to initialize ZBM
-  inst_hook cmdline 95 "${moddir}/hook/zfsbootmenu-parse-commandline.sh" || _ret=$?
-  inst_hook pre-mount 90 "${moddir}/hook/zfsbootmenu-preinit.sh" || _ret=$?
+  inst_hook cmdline 95 "${zfsbootmenu_module_root}/hook/zfsbootmenu-parse-commandline.sh" || _ret=$?
+  inst_hook pre-mount 90 "${zfsbootmenu_module_root}/hook/zfsbootmenu-preinit.sh" || _ret=$?
 
   # Hooks to force the dracut event loop to fire at least once
   # Things like console configuration are done in optional event-loop hooks
-  inst_hook initqueue/settled 99 "${moddir}/hook/zfsbootmenu-ready-set.sh" || _ret=$?
-  inst_hook initqueue/finished 99 "${moddir}/hook/zfsbootmenu-ready-chk.sh" || _ret=$?
-
-  # If tracing is enabled, build in the full-weight profiling library
-  if [ -n "${zfsbootmenu_trace_enable}" ]; then
-    inst_simple "${moddir}/profiling/profiling-lib.sh" "/lib/profiling-lib.sh"
-
-    # shellcheck disable=SC2154
-    cat << EOF >> "${initdir}/etc/profiling.conf"
-export zfsbootmenu_trace_term=${zfsbootmenu_trace_term}
-export zfsbootmenu_trace_baud=${zfsbootmenu_trace_baud}
-EOF
-
-    # optionally enable early Dracut profiling
-    if [ -n "${dracut_trace_enable}" ]; then
-      inst_hook cmdline 00 "${moddir}/profiling/profiling-lib.sh"
-    fi
-  else
-    # Install the default profiling library that is a simple `return 0`
-    echo "return 0" > "${initdir}/lib/profiling-lib.sh"
+  inst_hook initqueue/settled 99 "${zfsbootmenu_module_root}/hook/zfsbootmenu-ready-set.sh" || _ret=$?
+  inst_hook initqueue/finished 99 "${zfsbootmenu_module_root}/hook/zfsbootmenu-ready-chk.sh" || _ret=$?
+
+  # optionally enable early Dracut profiling
+  if [ -n "${dracut_trace_enable}" ]; then
+    inst_hook cmdline 00 "${zfsbootmenu_module_root}/profiling/profiling-lib.sh"
   fi
 
   # Install "early setup" hooks
@@ -284,30 +247,6 @@ EOF
     mark_hostonly /etc/hostid
   fi
 
-  # Check if fuzzy finder supports the refresh-preview flag
-  # Added in fzf 0.22.0
-  if command -v fzf >/dev/null 2>&1 && \
-    echo "abc" | fzf -f "abc" --bind "alt-l:refresh-preview" --exit-0 >/dev/null 2>&1
-  then
-    has_refresh=1
-  else
-    has_refresh=
-  fi
-
-  # shellcheck disable=SC2154
-  cat << 'EOF' > "${initdir}/etc/zfsbootmenu.conf"
-# Include guard
-[ -n "${_ETC_ZFSBOOTMENU_CONF}" ] && return
-readonly _ETC_ZFSBOOTMENU_CONF=1
-EOF
-
-  # Collect all of our build-time feature flags
-  # shellcheck disable=SC2154
-  cat << EOF >> "${initdir}/etc/zfsbootmenu.conf"
-export BYTE_ORDER=${endian:-le}
-export HAS_REFRESH=${has_refresh}
-EOF
-
   # Embed a kernel command line in the initramfs
   # shellcheck disable=SC2154
   if [ -n "${embedded_kcl}" ]; then
@@ -320,36 +259,7 @@ EOF
     echo "rd.hostonly=0" > "${initdir}/etc/cmdline.d/hostonly.conf"
   fi
 
-  # Setup a default environment for all login shells
-  cat << EOF >> "${initdir}/etc/profile"
-export PATH=/usr/sbin:/usr/bin:/sbin:/bin
-export TERM=linux
-export HOME=/root
-EOF
-
-  # Setup a default environment for bash -i
-  cat << EOF >> "${initdir}/root/.bashrc"
-source /etc/zfsbootmenu.conf >/dev/null 2>&1
-source /lib/kmsg-log-lib.sh >/dev/null 2>&1
-source /lib/zfsbootmenu-core.sh >/dev/null 2>&1
-source /lib/zfsbootmenu-kcl.sh >/dev/null 2>&1
-[ -f /etc/profile ] && source /etc/profile
-[ -f /lib/zfsbootmenu-completions.sh ] && source /lib/zfsbootmenu-completions.sh
-
-export PS1="\033[0;33mzfsbootmenu\033[0m \w > "
-
-alias clear="tput clear"
-alias reset="tput reset"
-alias zbm="zfsbootmenu"
-alias logs="ztrace"
-alias trace="ztrace"
-alias debug="ztrace"
-alias help="/libexec/zfsbootmenu-help -L recovery-shell"
-
-zdebug "sourced /root/.bashrc" || true
-
-EOF
-
-  # symlink to .profile for /bin/sh - launched by dropbear
-  ln -s "/root/.bashrc" "${initdir}/root/.profile"
+  create_zbm_conf
+  create_zbm_profiles
+  create_zbm_traceconf
 }

etc/zfsbootmenu/config.yaml

@@ -4,6 +4,8 @@ Global:
   DracutConfDir: /etc/zfsbootmenu/dracut.conf.d
   PreHooksDir: /etc/zfsbootmenu/generate-zbm.pre.d
   PostHooksDir: /etc/zfsbootmenu/generate-zbm.post.d
+  InitCPIO: false
+  InitCPIOConfig: /etc/zfsbootmenu/mkinitcpio.conf
 Components:
   ImageDir: /boot/efi/EFI/void
   Versions: 3

etc/zfsbootmenu/mkinitcpio.conf

@@ -0,0 +1,67 @@
+# vim:set ft=sh
+# MODULES
+# The following modules are loaded before any boot hooks are
+# run.  Advanced users may wish to specify all system modules
+# in this array.  For instance:
+#     MODULES=(piix ide_disk reiserfs)
+MODULES=()
+
+# BINARIES
+# This setting includes any additional binaries a given user may
+# wish into the CPIO image.  This is run last, so it may be used to
+# override the actual binaries included by a given hook
+# BINARIES are dependency parsed, so you may safely ignore libraries
+BINARIES=()
+
+# FILES
+# This setting is similar to BINARIES above, however, files are added
+# as-is and are not parsed in any way.  This is useful for config files.
+FILES=()
+
+# HOOKS
+# This is the most important setting in this file.  The HOOKS control the
+# modules and scripts added to the image, and what happens at boot time.
+# Order is important, and it is recommended that you do not change the
+# order in which HOOKS are added.  Run 'mkinitcpio -H <hook name>' for
+# help on a given hook.
+# 'base' is _required_ unless you know precisely what you are doing.
+# 'udev' is _required_ in order to automatically load modules
+# 'filesystems' is _required_ unless you specify your fs modules in MODULES
+# Examples:
+##   This setup specifies all modules in the MODULES setting above.
+##   No raid, lvm2, or encrypted root is needed.
+#    HOOKS=(base)
+#
+##   This setup will autodetect all modules for your system and should
+##   work as a sane default
+#    HOOKS=(base udev autodetect block filesystems)
+#
+##   This setup will generate a 'full' image which supports most systems.
+##   No autodetection is done.
+#    HOOKS=(base udev block filesystems)
+#
+##   This setup assembles a pata mdadm array with an encrypted root FS.
+##   Note: See 'mkinitcpio -H mdadm' for more information on raid devices.
+#    HOOKS=(base udev block mdadm encrypt filesystems)
+#
+##   This setup loads an lvm2 volume group on a usb device.
+#    HOOKS=(base udev block lvm2 filesystems)
+#
+##   NOTE: If you have /usr on a separate partition, you MUST include the
+#    usr, fsck and shutdown hooks.
+HOOKS=(base udev autodetect modconf block filesystems keyboard zfsbootmenu )
+
+# COMPRESSION
+# Use this to compress the initramfs image. By default, gzip compression
+# is used. Use 'cat' to create an uncompressed image.
+#COMPRESSION="zstd"
+#COMPRESSION="gzip"
+#COMPRESSION="bzip2"
+#COMPRESSION="lzma"
+#COMPRESSION="xz"
+#COMPRESSION="lzop"
+#COMPRESSION="lz4"
+
+# COMPRESSION_OPTIONS
+# Additional options for the compressor
+#COMPRESSION_OPTIONS=()