1# ZFS boot stub for initramfs-tools. 2# 3# In the initramfs environment, the /init script sources this stub to 4# override the default functions in the /scripts/local script. 5# 6# Enable this by passing boot=zfs on the kernel command line. 7# 8# $quiet, $root, $rpool, $bootfs come from the cmdline: 9# shellcheck disable=SC2154 10 11# Source the common functions 12. /etc/zfs/zfs-functions 13 14# Start interactive shell. 15# Use debian's panic() if defined, because it allows to prevent shell access 16# by setting panic in cmdline (e.g. panic=0 or panic=15). 17# See "4.5 Disable root prompt on the initramfs" of Securing Debian Manual: 18# https://www.debian.org/doc/manuals/securing-debian-howto/ch4.en.html 19shell() { 20 if command -v panic > /dev/null 2>&1; then 21 panic 22 else 23 /bin/sh 24 fi 25} 26 27# This runs any scripts that should run before we start importing 28# pools and mounting any filesystems. 29pre_mountroot() 30{ 31 if command -v run_scripts > /dev/null 2>&1 32 then 33 if [ -f "/scripts/local-top" ] || [ -d "/scripts/local-top" ] 34 then 35 [ "$quiet" != "y" ] && \ 36 zfs_log_begin_msg "Running /scripts/local-top" 37 run_scripts /scripts/local-top 38 [ "$quiet" != "y" ] && zfs_log_end_msg 39 fi 40 41 if [ -f "/scripts/local-premount" ] || [ -d "/scripts/local-premount" ] 42 then 43 [ "$quiet" != "y" ] && \ 44 zfs_log_begin_msg "Running /scripts/local-premount" 45 run_scripts /scripts/local-premount 46 [ "$quiet" != "y" ] && zfs_log_end_msg 47 fi 48 fi 49} 50 51# If plymouth is available, hide the splash image. 52disable_plymouth() 53{ 54 if [ -x /bin/plymouth ] && /bin/plymouth --ping 55 then 56 /bin/plymouth hide-splash >/dev/null 2>&1 57 fi 58} 59 60# Get a ZFS filesystem property value. 61get_fs_value() 62{ 63 fs="$1" 64 value=$2 65 66 "${ZFS}" get -H -ovalue "$value" "$fs" 2> /dev/null 67} 68 69# Find the 'bootfs' property on pool $1. 70# If the property does not contain '/', then ignore this 71# pool by exporting it again. 72find_rootfs() 73{ 74 pool="$1" 75 76 # If 'POOL_IMPORTED' isn't set, no pool imported and therefore 77 # we won't be able to find a root fs. 78 [ -z "${POOL_IMPORTED}" ] && return 1 79 80 # If it's already specified, just keep it mounted and exit 81 # User (kernel command line) must be correct. 82 if [ -n "${ZFS_BOOTFS}" ] && [ "${ZFS_BOOTFS}" != "zfs:AUTO" ]; then 83 return 0 84 fi 85 86 # Not set, try to find it in the 'bootfs' property of the pool. 87 # NOTE: zpool does not support 'get -H -ovalue bootfs'... 88 ZFS_BOOTFS=$("${ZPOOL}" list -H -obootfs "$pool") 89 90 # Make sure it's not '-' and that it starts with /. 91 if [ "${ZFS_BOOTFS}" != "-" ] && \ 92 get_fs_value "${ZFS_BOOTFS}" mountpoint | grep -q '^/$' 93 then 94 # Keep it mounted 95 POOL_IMPORTED=1 96 return 0 97 fi 98 99 # Not boot fs here, export it and later try again.. 100 "${ZPOOL}" export "$pool" 101 POOL_IMPORTED= 102 ZFS_BOOTFS= 103 return 1 104} 105 106# Support function to get a list of all pools, separated with ';' 107find_pools() 108{ 109 pools=$("$@" 2> /dev/null | \ 110 sed -Ee '/pool:|^[a-zA-Z0-9]/!d' -e 's@.*: @@' | \ 111 tr '\n' ';') 112 113 echo "${pools%%;}" # Return without the last ';'. 114} 115 116# Get a list of all available pools 117get_pools() 118{ 119 if [ -n "${ZFS_POOL_IMPORT}" ]; then 120 echo "$ZFS_POOL_IMPORT" 121 return 0 122 fi 123 124 # Get the base list of available pools. 125 available_pools=$(find_pools "$ZPOOL" import) 126 127 # Just in case - seen it happen (that a pool isn't visible/found 128 # with a simple "zpool import" but only when using the "-d" 129 # option or setting ZPOOL_IMPORT_PATH). 130 if [ -d "/dev/disk/by-id" ] 131 then 132 npools=$(find_pools "$ZPOOL" import -d /dev/disk/by-id) 133 if [ -n "$npools" ] 134 then 135 # Because we have found extra pool(s) here, which wasn't 136 # found 'normally', we need to force USE_DISK_BY_ID to 137 # make sure we're able to actually import it/them later. 138 USE_DISK_BY_ID='yes' 139 140 if [ -n "$available_pools" ] 141 then 142 # Filter out duplicates (pools found with the simple 143 # "zpool import" but which is also found with the 144 # "zpool import -d ..."). 145 npools=$(echo "$npools" | sed "s,$available_pools,,") 146 147 # Add the list to the existing list of 148 # available pools 149 available_pools="$available_pools;$npools" 150 else 151 available_pools="$npools" 152 fi 153 fi 154 fi 155 156 # Filter out any exceptions... 157 if [ -n "$ZFS_POOL_EXCEPTIONS" ] 158 then 159 found="" 160 apools="" 161 OLD_IFS="$IFS" ; IFS=";" 162 163 for pool in $available_pools 164 do 165 for exception in $ZFS_POOL_EXCEPTIONS 166 do 167 [ "$pool" = "$exception" ] && continue 2 168 found="$pool" 169 done 170 171 if [ -n "$found" ] 172 then 173 if [ -n "$apools" ] 174 then 175 apools="$apools;$pool" 176 else 177 apools="$pool" 178 fi 179 fi 180 done 181 182 IFS="$OLD_IFS" 183 available_pools="$apools" 184 fi 185 186 # Return list of available pools. 187 echo "$available_pools" 188} 189 190# Import given pool $1 191import_pool() 192{ 193 pool="$1" 194 195 # Verify that the pool isn't already imported 196 # Make as sure as we can to not require '-f' to import. 197 "${ZPOOL}" get -H -o value name,guid 2>/dev/null | grep -Fxq "$pool" && return 0 198 199 # For backwards compatibility, make sure that ZPOOL_IMPORT_PATH is set 200 # to something we can use later with the real import(s). We want to 201 # make sure we find all by* dirs, BUT by-vdev should be first (if it 202 # exists). 203 if [ -n "$USE_DISK_BY_ID" ] && [ -z "$ZPOOL_IMPORT_PATH" ] 204 then 205 dirs="$(for dir in /dev/disk/by-* 206 do 207 # Ignore by-vdev here - we want it first! 208 echo "$dir" | grep -q /by-vdev && continue 209 [ ! -d "$dir" ] && continue 210 211 printf "%s" "$dir:" 212 done | sed 's,:$,,g')" 213 214 if [ -d "/dev/disk/by-vdev" ] 215 then 216 # Add by-vdev at the beginning. 217 ZPOOL_IMPORT_PATH="/dev/disk/by-vdev:" 218 fi 219 220 # ... and /dev at the very end, just for good measure. 221 ZPOOL_IMPORT_PATH="$ZPOOL_IMPORT_PATH$dirs:/dev" 222 fi 223 224 # Needs to be exported for "zpool" to catch it. 225 [ -n "$ZPOOL_IMPORT_PATH" ] && export ZPOOL_IMPORT_PATH 226 227 228 [ "$quiet" != "y" ] && zfs_log_begin_msg \ 229 "Importing pool '${pool}' using defaults" 230 231 ZFS_CMD="${ZPOOL} import -N ${ZPOOL_FORCE} ${ZPOOL_IMPORT_OPTS}" 232 ZFS_STDERR="$($ZFS_CMD "$pool" 2>&1)" 233 ZFS_ERROR="$?" 234 if [ "${ZFS_ERROR}" != 0 ] 235 then 236 [ "$quiet" != "y" ] && zfs_log_failure_msg "${ZFS_ERROR}" 237 238 if [ -f "${ZPOOL_CACHE}" ] 239 then 240 [ "$quiet" != "y" ] && zfs_log_begin_msg \ 241 "Importing pool '${pool}' using cachefile." 242 243 ZFS_CMD="${ZPOOL} import -c ${ZPOOL_CACHE} -N ${ZPOOL_FORCE} ${ZPOOL_IMPORT_OPTS}" 244 ZFS_STDERR="$($ZFS_CMD "$pool" 2>&1)" 245 ZFS_ERROR="$?" 246 fi 247 248 if [ "${ZFS_ERROR}" != 0 ] 249 then 250 [ "$quiet" != "y" ] && zfs_log_failure_msg "${ZFS_ERROR}" 251 252 disable_plymouth 253 echo "" 254 echo "Command: ${ZFS_CMD} '$pool'" 255 echo "Message: $ZFS_STDERR" 256 echo "Error: $ZFS_ERROR" 257 echo "" 258 echo "Failed to import pool '$pool'." 259 echo "Manually import the pool and exit." 260 shell 261 fi 262 fi 263 264 [ "$quiet" != "y" ] && zfs_log_end_msg 265 266 POOL_IMPORTED=1 267 return 0 268} 269 270# Load ZFS modules 271# Loading a module in a initrd require a slightly different approach, 272# with more logging etc. 273load_module_initrd() 274{ 275 ZFS_INITRD_PRE_MOUNTROOT_SLEEP=${ROOTDELAY:-0} 276 277 if [ "$ZFS_INITRD_PRE_MOUNTROOT_SLEEP" -gt 0 ]; then 278 [ "$quiet" != "y" ] && zfs_log_begin_msg "Delaying for up to '${ZFS_INITRD_PRE_MOUNTROOT_SLEEP}' seconds." 279 fi 280 281 START=$(/bin/date -u +%s) 282 END=$((START+ZFS_INITRD_PRE_MOUNTROOT_SLEEP)) 283 while true; do 284 285 # Wait for all of the /dev/{hd,sd}[a-z] device nodes to appear. 286 if command -v wait_for_udev > /dev/null 2>&1 ; then 287 wait_for_udev 10 288 elif command -v wait_for_dev > /dev/null 2>&1 ; then 289 wait_for_dev 290 fi 291 292 # 293 # zpool import refuse to import without a valid 294 # /proc/self/mounts 295 # 296 [ ! -f /proc/self/mounts ] && mount proc /proc 297 298 # Load the module 299 if load_module "zfs"; then 300 ret=0 301 break 302 else 303 ret=1 304 fi 305 306 [ "$(/bin/date -u +%s)" -gt "$END" ] && break 307 sleep 1 308 309 done 310 if [ "$ZFS_INITRD_PRE_MOUNTROOT_SLEEP" -gt 0 ]; then 311 [ "$quiet" != "y" ] && zfs_log_end_msg 312 fi 313 314 [ "$ret" -ne 0 ] && return 1 315 316 if [ "$ZFS_INITRD_POST_MODPROBE_SLEEP" -gt 0 ] 2>/dev/null 317 then 318 if [ "$quiet" != "y" ]; then 319 zfs_log_begin_msg "Sleeping for" \ 320 "$ZFS_INITRD_POST_MODPROBE_SLEEP seconds..." 321 fi 322 sleep "$ZFS_INITRD_POST_MODPROBE_SLEEP" 323 [ "$quiet" != "y" ] && zfs_log_end_msg 324 fi 325 326 return 0 327} 328 329# Mount a given filesystem 330mount_fs() 331{ 332 fs="$1" 333 334 # Check that the filesystem exists 335 "${ZFS}" list -oname -tfilesystem -H "${fs}" > /dev/null 2>&1 || return 1 336 337 # Skip filesystems with canmount=off. The root fs should not have 338 # canmount=off, but ignore it for backwards compatibility just in case. 339 if [ "$fs" != "${ZFS_BOOTFS}" ] 340 then 341 canmount=$(get_fs_value "$fs" canmount) 342 [ "$canmount" = "off" ] && return 0 343 fi 344 345 # Need the _original_ datasets mountpoint! 346 mountpoint=$(get_fs_value "$fs" mountpoint) 347 ZFS_CMD="mount.zfs -o zfsutil" 348 if [ "$mountpoint" = "legacy" ] || [ "$mountpoint" = "none" ]; then 349 # Can't use the mountpoint property. Might be one of our 350 # clones. Check the 'org.zol:mountpoint' property set in 351 # clone_snap() if that's usable. 352 mountpoint1=$(get_fs_value "$fs" org.zol:mountpoint) 353 if [ "$mountpoint1" = "legacy" ] || 354 [ "$mountpoint1" = "none" ] || 355 [ "$mountpoint1" = "-" ] 356 then 357 if [ "$fs" != "${ZFS_BOOTFS}" ]; then 358 # We don't have a proper mountpoint and this 359 # isn't the root fs. 360 return 0 361 fi 362 # Don't use mount.zfs -o zfsutils for legacy mountpoint 363 if [ "$mountpoint" = "legacy" ]; then 364 ZFS_CMD="mount.zfs" 365 fi 366 # Last hail-mary: Hope 'rootmnt' is set! 367 mountpoint="" 368 else 369 mountpoint="$mountpoint1" 370 fi 371 fi 372 373 # Possibly decrypt a filesystem using native encryption. 374 decrypt_fs "$fs" 375 376 [ "$quiet" != "y" ] && \ 377 zfs_log_begin_msg "Mounting '${fs}' on '${rootmnt}/${mountpoint}'" 378 [ -n "${ZFS_DEBUG}" ] && \ 379 zfs_log_begin_msg "CMD: '$ZFS_CMD ${fs} ${rootmnt}/${mountpoint}'" 380 381 ZFS_STDERR=$(${ZFS_CMD} "${fs}" "${rootmnt}/${mountpoint}" 2>&1) 382 ZFS_ERROR=$? 383 if [ "${ZFS_ERROR}" != 0 ] 384 then 385 [ "$quiet" != "y" ] && zfs_log_failure_msg "${ZFS_ERROR}" 386 387 disable_plymouth 388 echo "" 389 echo "Command: ${ZFS_CMD} ${fs} ${rootmnt}/${mountpoint}" 390 echo "Message: $ZFS_STDERR" 391 echo "Error: $ZFS_ERROR" 392 echo "" 393 echo "Failed to mount ${fs} on ${rootmnt}/${mountpoint}." 394 echo "Manually mount the filesystem and exit." 395 shell 396 else 397 [ "$quiet" != "y" ] && zfs_log_end_msg 398 fi 399 400 return 0 401} 402 403# Unlock a ZFS native encrypted filesystem. 404decrypt_fs() 405{ 406 fs="$1" 407 408 # If pool encryption is active and the zfs command understands '-o encryption' 409 if [ "$(zpool list -H -o feature@encryption "${fs%%/*}")" = 'active' ]; then 410 411 # Determine dataset that holds key for root dataset 412 ENCRYPTIONROOT="$(get_fs_value "${fs}" encryptionroot)" 413 KEYLOCATION="$(get_fs_value "${ENCRYPTIONROOT}" keylocation)" 414 415 echo "${ENCRYPTIONROOT}" > /run/zfs_fs_name 416 417 # If root dataset is encrypted... 418 if ! [ "${ENCRYPTIONROOT}" = "-" ]; then 419 KEYSTATUS="$(get_fs_value "${ENCRYPTIONROOT}" keystatus)" 420 # Continue only if the key needs to be loaded 421 [ "$KEYSTATUS" = "unavailable" ] || return 0 422 423 # Do not prompt if key is stored noninteractively, 424 if ! [ "${KEYLOCATION}" = "prompt" ]; then 425 $ZFS load-key "${ENCRYPTIONROOT}" 426 427 # Prompt with plymouth, if active 428 elif /bin/plymouth --ping 2>/dev/null; then 429 echo "plymouth" > /run/zfs_console_askpwd_cmd 430 for _ in 1 2 3; do 431 plymouth ask-for-password --prompt "Encrypted ZFS password for ${ENCRYPTIONROOT}" | \ 432 $ZFS load-key "${ENCRYPTIONROOT}" && break 433 done 434 435 # Prompt with systemd, if active 436 elif [ -e /run/systemd/system ]; then 437 echo "systemd-ask-password" > /run/zfs_console_askpwd_cmd 438 for _ in 1 2 3; do 439 systemd-ask-password --no-tty "Encrypted ZFS password for ${ENCRYPTIONROOT}" | \ 440 $ZFS load-key "${ENCRYPTIONROOT}" && break 441 done 442 443 # Prompt with ZFS tty, otherwise 444 else 445 # Temporarily setting "printk" to "7" allows the prompt to appear even when the "quiet" kernel option has been used 446 echo "load-key" > /run/zfs_console_askpwd_cmd 447 read -r storeprintk _ < /proc/sys/kernel/printk 448 echo 7 > /proc/sys/kernel/printk 449 $ZFS load-key "${ENCRYPTIONROOT}" 450 echo "$storeprintk" > /proc/sys/kernel/printk 451 fi 452 fi 453 fi 454 455 return 0 456} 457 458# Destroy a given filesystem. 459destroy_fs() 460{ 461 fs="$1" 462 463 [ "$quiet" != "y" ] && \ 464 zfs_log_begin_msg "Destroying '$fs'" 465 466 ZFS_CMD="${ZFS} destroy $fs" 467 ZFS_STDERR="$(${ZFS_CMD} 2>&1)" 468 ZFS_ERROR="$?" 469 if [ "${ZFS_ERROR}" != 0 ] 470 then 471 [ "$quiet" != "y" ] && zfs_log_failure_msg "${ZFS_ERROR}" 472 473 disable_plymouth 474 echo "" 475 echo "Command: $ZFS_CMD" 476 echo "Message: $ZFS_STDERR" 477 echo "Error: $ZFS_ERROR" 478 echo "" 479 echo "Failed to destroy '$fs'. Please make sure that '$fs' is not available." 480 echo "Hint: Try: zfs destroy -Rfn $fs" 481 echo "If this dryrun looks good, then remove the 'n' from '-Rfn' and try again." 482 shell 483 else 484 [ "$quiet" != "y" ] && zfs_log_end_msg 485 fi 486 487 return 0 488} 489 490# Clone snapshot $1 to destination filesystem $2 491# Set 'canmount=noauto' and 'mountpoint=none' so that we get to keep 492# manual control over it's mounting (i.e., make sure it's not automatically 493# mounted with a 'zfs mount -a' in the init/systemd scripts). 494clone_snap() 495{ 496 snap="$1" 497 destfs="$2" 498 mountpoint="$3" 499 500 [ "$quiet" != "y" ] && zfs_log_begin_msg "Cloning '$snap' to '$destfs'" 501 502 # Clone the snapshot into a dataset we can boot from 503 # + We don't want this filesystem to be automatically mounted, we 504 # want control over this here and nowhere else. 505 # + We don't need any mountpoint set for the same reason. 506 # We use the 'org.zol:mountpoint' property to remember the mountpoint. 507 ZFS_CMD="${ZFS} clone -o canmount=noauto -o mountpoint=none" 508 ZFS_CMD="${ZFS_CMD} -o org.zol:mountpoint=${mountpoint}" 509 ZFS_CMD="${ZFS_CMD} $snap $destfs" 510 ZFS_STDERR="$(${ZFS_CMD} 2>&1)" 511 ZFS_ERROR="$?" 512 if [ "${ZFS_ERROR}" != 0 ] 513 then 514 [ "$quiet" != "y" ] && zfs_log_failure_msg "${ZFS_ERROR}" 515 516 disable_plymouth 517 echo "" 518 echo "Command: $ZFS_CMD" 519 echo "Message: $ZFS_STDERR" 520 echo "Error: $ZFS_ERROR" 521 echo "" 522 echo "Failed to clone snapshot." 523 echo "Make sure that any problems are corrected and then make sure" 524 echo "that the dataset '$destfs' exists and is bootable." 525 shell 526 else 527 [ "$quiet" != "y" ] && zfs_log_end_msg 528 fi 529 530 return 0 531} 532 533# Rollback a given snapshot. 534rollback_snap() 535{ 536 snap="$1" 537 538 [ "$quiet" != "y" ] && zfs_log_begin_msg "Rollback $snap" 539 540 ZFS_CMD="${ZFS} rollback -Rf $snap" 541 ZFS_STDERR="$(${ZFS_CMD} 2>&1)" 542 ZFS_ERROR="$?" 543 if [ "${ZFS_ERROR}" != 0 ] 544 then 545 [ "$quiet" != "y" ] && zfs_log_failure_msg "${ZFS_ERROR}" 546 547 disable_plymouth 548 echo "" 549 echo "Command: $ZFS_CMD" 550 echo "Message: $ZFS_STDERR" 551 echo "Error: $ZFS_ERROR" 552 echo "" 553 echo "Failed to rollback snapshot." 554 shell 555 else 556 [ "$quiet" != "y" ] && zfs_log_end_msg 557 fi 558 559 return 0 560} 561 562# Get a list of snapshots, give them as a numbered list 563# to the user to choose from. 564ask_user_snap() 565{ 566 fs="$1" 567 568 # We need to temporarily disable debugging. Set 'debug' so we 569 # remember to enabled it again. 570 if [ -n "${ZFS_DEBUG}" ]; then 571 unset ZFS_DEBUG 572 set +x 573 debug=1 574 fi 575 576 # Because we need the resulting snapshot, which is sent on 577 # stdout to the caller, we use stderr for our questions. 578 echo "What snapshot do you want to boot from?" > /dev/stderr 579 # shellcheck disable=SC2046 580 IFS=" 581" set -- $("${ZFS}" list -H -oname -tsnapshot -r "${fs}") 582 583 i=1 584 for snap in "$@"; do 585 echo " $i: $snap" 586 i=$((i + 1)) 587 done > /dev/stderr 588 589 # expr instead of test here because [ a -lt 0 ] errors out, 590 # but expr falls back to lexicographical, which works out right 591 snapnr=0 592 while expr "$snapnr" "<" 1 > /dev/null || 593 expr "$snapnr" ">" "$#" > /dev/null 594 do 595 printf "%s" "Snap nr [1-$#]? " > /dev/stderr 596 read -r snapnr 597 done 598 599 # Re-enable debugging. 600 if [ -n "${debug}" ]; then 601 ZFS_DEBUG=1 602 set -x 603 fi 604 605 eval echo '$'"$snapnr" 606} 607 608setup_snapshot_booting() 609{ 610 snap="$1" 611 retval=0 612 613 # Make sure that the snapshot specified actually exists. 614 if [ -z "$(get_fs_value "${snap}" type)" ] 615 then 616 # Snapshot does not exist (...@<null> ?) 617 # ask the user for a snapshot to use. 618 snap="$(ask_user_snap "${snap%%@*}")" 619 fi 620 621 # Separate the full snapshot ('$snap') into it's filesystem and 622 # snapshot names. Would have been nice with a split() function.. 623 rootfs="${snap%%@*}" 624 snapname="${snap##*@}" 625 ZFS_BOOTFS="${rootfs}_${snapname}" 626 627 if ! grep -qiE '(^|[^\\](\\\\)* )(rollback)=(on|yes|1)( |$)' /proc/cmdline 628 then 629 # If the destination dataset for the clone 630 # already exists, destroy it. Recursively 631 if [ -n "$(get_fs_value "${rootfs}_${snapname}" type)" ] 632 then 633 filesystems=$("${ZFS}" list -oname -tfilesystem -H \ 634 -r -Sname "${ZFS_BOOTFS}") 635 for fs in $filesystems; do 636 destroy_fs "${fs}" 637 done 638 fi 639 fi 640 641 # Get all snapshots, recursively (might need to clone /usr, /var etc 642 # as well). 643 for s in $("${ZFS}" list -H -oname -tsnapshot -r "${rootfs}" | \ 644 grep "${snapname}") 645 do 646 if grep -qiE '(^|[^\\](\\\\)* )(rollback)=(on|yes|1)( |$)' /proc/cmdline 647 then 648 # Rollback snapshot 649 rollback_snap "$s" || retval=$((retval + 1)) 650 ZFS_BOOTFS="${rootfs}" 651 else 652 # Setup a destination filesystem name. 653 # Ex: Called with 'rpool/ROOT/debian@snap2' 654 # rpool/ROOT/debian@snap2 => rpool/ROOT/debian_snap2 655 # rpool/ROOT/debian/boot@snap2 => rpool/ROOT/debian_snap2/boot 656 # rpool/ROOT/debian/usr@snap2 => rpool/ROOT/debian_snap2/usr 657 # rpool/ROOT/debian/var@snap2 => rpool/ROOT/debian_snap2/var 658 subfs="${s##"$rootfs"}" 659 subfs="${subfs%%@"$snapname"}" 660 661 destfs="${rootfs}_${snapname}" # base fs. 662 [ -n "$subfs" ] && destfs="${destfs}$subfs" # + sub fs. 663 664 # Get the mountpoint of the filesystem, to be used 665 # with clone_snap(). If legacy or none, then use 666 # the sub fs value. 667 mountpoint=$(get_fs_value "${s%%@*}" mountpoint) 668 if [ "$mountpoint" = "legacy" ] || \ 669 [ "$mountpoint" = "none" ] 670 then 671 if [ -n "${subfs}" ]; then 672 mountpoint="${subfs}" 673 else 674 mountpoint="/" 675 fi 676 fi 677 678 # Clone the snapshot into its own 679 # filesystem 680 clone_snap "$s" "${destfs}" "${mountpoint}" || \ 681 retval=$((retval + 1)) 682 fi 683 done 684 685 # If we haven't return yet, we have a problem... 686 return "${retval}" 687} 688 689# ================================================================ 690 691# This is the main function. 692mountroot() 693{ 694 # ---------------------------------------------------------------- 695 # I N I T I A L S E T U P 696 697 # ------------ 698 # Run the pre-mount scripts from /scripts/local-top. 699 pre_mountroot 700 701 # ------------ 702 # Source the default setup variables. 703 [ -r '/etc/default/zfs' ] && . /etc/default/zfs 704 705 # ------------ 706 # Support debug option 707 if grep -qiE '(^|[^\\](\\\\)* )(zfs_debug|zfs\.debug|zfsdebug)=(on|yes|1)( |$)' /proc/cmdline 708 then 709 ZFS_DEBUG=1 710 mkdir /var/log 711 #exec 2> /var/log/boot.debug 712 set -x 713 fi 714 715 # ------------ 716 # Load ZFS module etc. 717 if ! load_module_initrd; then 718 disable_plymouth 719 echo "" 720 echo "Failed to load ZFS modules." 721 echo "Manually load the modules and exit." 722 shell 723 fi 724 725 # ------------ 726 # Look for the cache file (if any). 727 [ -f "${ZPOOL_CACHE}" ] || unset ZPOOL_CACHE 728 [ -s "${ZPOOL_CACHE}" ] || unset ZPOOL_CACHE 729 730 # ------------ 731 # Compatibility: 'ROOT' is for Debian GNU/Linux (etc), 732 # 'root' is for Redhat/Fedora (etc), 733 # 'REAL_ROOT' is for Gentoo 734 if [ -z "$ROOT" ] 735 then 736 [ -n "$root" ] && ROOT=${root} 737 738 [ -n "$REAL_ROOT" ] && ROOT=${REAL_ROOT} 739 fi 740 741 # ------------ 742 # Where to mount the root fs in the initrd - set outside this script 743 # Compatibility: 'rootmnt' is for Debian GNU/Linux (etc), 744 # 'NEWROOT' is for RedHat/Fedora (etc), 745 # 'NEW_ROOT' is for Gentoo 746 if [ -z "$rootmnt" ] 747 then 748 [ -n "$NEWROOT" ] && rootmnt=${NEWROOT} 749 750 [ -n "$NEW_ROOT" ] && rootmnt=${NEW_ROOT} 751 fi 752 753 # ------------ 754 # No longer set in the defaults file, but it could have been set in 755 # get_pools() in some circumstances. If it's something, but not 'yes', 756 # it's no good to us. 757 [ -n "$USE_DISK_BY_ID" ] && [ "$USE_DISK_BY_ID" != 'yes' ] && \ 758 unset USE_DISK_BY_ID 759 760 # ---------------------------------------------------------------- 761 # P A R S E C O M M A N D L I N E O P T I O N S 762 763 # This part is the really ugly part - there's so many options and permutations 764 # 'out there', and if we should make this the 'primary' source for ZFS initrd 765 # scripting, we need/should support them all. 766 # 767 # Supports the following kernel command line argument combinations 768 # (in this order - first match win): 769 # 770 # rpool=<pool> (tries to finds bootfs automatically) 771 # bootfs=<pool>/<dataset> (uses this for rpool - first part) 772 # rpool=<pool> bootfs=<pool>/<dataset> 773 # -B zfs-bootfs=<pool>/<fs> (uses this for rpool - first part) 774 # rpool=rpool (default if none of the above is used) 775 # root=<pool>/<dataset> (uses this for rpool - first part) 776 # root=ZFS=<pool>/<dataset> (uses this for rpool - first part, without 'ZFS=') 777 # root=zfs:AUTO (tries to detect both pool and rootfs) 778 # root=zfs:<pool>/<dataset> (uses this for rpool - first part, without 'zfs:') 779 # 780 # Option <dataset> could also be <snapshot> 781 # Option <pool> could also be <guid> 782 783 # ------------ 784 # Support force option 785 # In addition, setting one of zfs_force, zfs.force or zfsforce to 786 # 'yes', 'on' or '1' will make sure we force import the pool. 787 # This should (almost) never be needed, but it's here for 788 # completeness. 789 ZPOOL_FORCE="" 790 if grep -qiE '(^|[^\\](\\\\)* )(zfs_force|zfs\.force|zfsforce)=(on|yes|1)( |$)' /proc/cmdline 791 then 792 ZPOOL_FORCE="-f" 793 fi 794 795 # ------------ 796 # Look for 'rpool' and 'bootfs' parameter 797 [ -n "$rpool" ] && ZFS_RPOOL="${rpool#rpool=}" 798 [ -n "$bootfs" ] && ZFS_BOOTFS="${bootfs#bootfs=}" 799 800 # ------------ 801 # If we have 'ROOT' (see above), but not 'ZFS_BOOTFS', then use 802 # 'ROOT' 803 [ -n "$ROOT" ] && [ -z "${ZFS_BOOTFS}" ] && ZFS_BOOTFS="$ROOT" 804 805 # ------------ 806 # Check for the `-B zfs-bootfs=%s/%u,...` kind of parameter. 807 # NOTE: Only use the pool name and dataset. The rest is not 808 # supported by OpenZFS (whatever it's for). 809 if [ -z "$ZFS_RPOOL" ] 810 then 811 # The ${zfs-bootfs} variable is set at the kernel command 812 # line, usually by GRUB, but it cannot be referenced here 813 # directly because bourne variable names cannot contain a 814 # hyphen. 815 # 816 # Reassign the variable by dumping the environment and 817 # stripping the zfs-bootfs= prefix. Let the shell handle 818 # quoting through the eval command: 819 # shellcheck disable=SC2046 820 eval ZFS_RPOOL=$(set | sed -n -e 's,^zfs-bootfs=,,p') 821 fi 822 823 # ------------ 824 # No root fs or pool specified - do auto detect. 825 if [ -z "$ZFS_RPOOL" ] && [ -z "${ZFS_BOOTFS}" ] 826 then 827 # Do auto detect. Do this by 'cheating' - set 'root=zfs:AUTO' 828 # which will be caught later 829 ROOT='zfs:AUTO' 830 fi 831 832 # ---------------------------------------------------------------- 833 # F I N D A N D I M P O R T C O R R E C T P O O L 834 835 # ------------ 836 if [ "$ROOT" = "zfs:AUTO" ] 837 then 838 # Try to detect both pool and root fs. 839 840 # If we got here, that means we don't have a hint so as to 841 # the root dataset, but with root=zfs:AUTO on cmdline, 842 # this says "zfs:AUTO" here and interferes with checks later 843 ZFS_BOOTFS= 844 845 [ "$quiet" != "y" ] && \ 846 zfs_log_begin_msg "Attempting to import additional pools." 847 848 # Get a list of pools available for import 849 if [ -n "$ZFS_RPOOL" ] 850 then 851 # We've specified a pool - check only that 852 POOLS=$ZFS_RPOOL 853 else 854 POOLS=$(get_pools) 855 fi 856 857 OLD_IFS="$IFS" ; IFS=";" 858 for pool in $POOLS 859 do 860 [ -z "$pool" ] && continue 861 862 IFS="$OLD_IFS" import_pool "$pool" 863 IFS="$OLD_IFS" find_rootfs "$pool" && break 864 done 865 IFS="$OLD_IFS" 866 867 [ "$quiet" != "y" ] && zfs_log_end_msg "$ZFS_ERROR" 868 else 869 # No auto - use value from the command line option. 870 871 # Strip 'zfs:' and 'ZFS='. 872 ZFS_BOOTFS="${ROOT#*[:=]}" 873 874 # Strip everything after the first slash. 875 ZFS_RPOOL="${ZFS_BOOTFS%%/*}" 876 fi 877 878 # Import the pool (if not already done so in the AUTO check above). 879 if [ -n "$ZFS_RPOOL" ] && [ -z "${POOL_IMPORTED}" ] 880 then 881 [ "$quiet" != "y" ] && \ 882 zfs_log_begin_msg "Importing ZFS root pool '$ZFS_RPOOL'" 883 884 import_pool "${ZFS_RPOOL}" 885 find_rootfs "${ZFS_RPOOL}" 886 887 [ "$quiet" != "y" ] && zfs_log_end_msg 888 fi 889 890 if [ -z "${POOL_IMPORTED}" ] 891 then 892 # No pool imported, this is serious! 893 disable_plymouth 894 echo "" 895 echo "Command: $ZFS_CMD" 896 echo "Message: $ZFS_STDERR" 897 echo "Error: $ZFS_ERROR" 898 echo "" 899 echo "No pool imported. Manually import the root pool" 900 echo "at the command prompt and then exit." 901 echo "Hint: Try: zpool import -N ${ZFS_RPOOL}" 902 shell 903 fi 904 905 # In case the pool was specified as guid, resolve guid to name 906 pool="$("${ZPOOL}" get -H -o name,value name,guid | \ 907 awk -v pool="${ZFS_RPOOL}" '$2 == pool { print $1 }')" 908 if [ -n "$pool" ]; then 909 # If $ZFS_BOOTFS contains guid, replace the guid portion with $pool 910 ZFS_BOOTFS=$(echo "$ZFS_BOOTFS" | \ 911 sed -e "s/$("${ZPOOL}" get -H -o value guid "$pool")/$pool/g") 912 ZFS_RPOOL="${pool}" 913 fi 914 915 916 # ---------------------------------------------------------------- 917 # P R E P A R E R O O T F I L E S Y S T E M 918 919 if [ -n "${ZFS_BOOTFS}" ] 920 then 921 # Booting from a snapshot? 922 # Will overwrite the ZFS_BOOTFS variable like so: 923 # rpool/ROOT/debian@snap2 => rpool/ROOT/debian_snap2 924 echo "${ZFS_BOOTFS}" | grep -q '@' && \ 925 setup_snapshot_booting "${ZFS_BOOTFS}" 926 fi 927 928 if [ -z "${ZFS_BOOTFS}" ] 929 then 930 # Still nothing! Let the user sort this out. 931 disable_plymouth 932 echo "" 933 echo "Error: Unknown root filesystem - no 'bootfs' pool property and" 934 echo " not specified on the kernel command line." 935 echo "" 936 echo "Manually mount the root filesystem on $rootmnt and then exit." 937 echo "Hint: Try: mount.zfs -o zfsutil ${ZFS_RPOOL-rpool}/ROOT/system $rootmnt" 938 shell 939 fi 940 941 # ---------------------------------------------------------------- 942 # M O U N T F I L E S Y S T E M S 943 944 # * Ideally, the root filesystem would be mounted like this: 945 # 946 # zpool import -R "$rootmnt" -N "$ZFS_RPOOL" 947 # zfs mount -o mountpoint=/ "${ZFS_BOOTFS}" 948 # 949 # but the MOUNTPOINT prefix is preserved on descendent filesystem 950 # after the pivot into the regular root, which later breaks things 951 # like `zfs mount -a` and the /proc/self/mounts refresh. 952 # 953 # * Mount additional filesystems required 954 # Such as /usr, /var, /usr/local etc. 955 # NOTE: Mounted in the order specified in the 956 # ZFS_INITRD_ADDITIONAL_DATASETS variable so take care! 957 958 # Go through the complete list (recursively) of all filesystems below 959 # the real root dataset 960 filesystems="$("${ZFS}" list -oname -tfilesystem -H -r "${ZFS_BOOTFS}")" 961 OLD_IFS="$IFS" ; IFS=" 962" 963 for fs in $filesystems; do 964 IFS="$OLD_IFS" mount_fs "$fs" 965 done 966 IFS="$OLD_IFS" 967 for fs in $ZFS_INITRD_ADDITIONAL_DATASETS; do 968 mount_fs "$fs" 969 done 970 971 touch /run/zfs_unlock_complete 972 if [ -e /run/zfs_unlock_complete_notify ]; then 973 read -r < /run/zfs_unlock_complete_notify 974 fi 975 976 # ------------ 977 # Debugging information 978 if [ -n "${ZFS_DEBUG}" ] 979 then 980 #exec 2>&1- 981 982 echo "DEBUG: imported pools:" 983 "${ZPOOL}" list -H 984 echo 985 986 echo "DEBUG: mounted ZFS filesystems:" 987 mount | grep zfs 988 echo 989 990 echo "=> waiting for ENTER before continuing because of 'zfsdebug=1'. " 991 printf "%s" " 'c' for shell, 'r' for reboot, 'ENTER' to continue. " 992 read -r b 993 994 [ "$b" = "c" ] && /bin/sh 995 [ "$b" = "r" ] && reboot -f 996 997 set +x 998 fi 999 1000 # ------------ 1001 # Run local bottom script 1002 if command -v run_scripts > /dev/null 2>&1 1003 then 1004 if [ -f "/scripts/local-bottom" ] || [ -d "/scripts/local-bottom" ] 1005 then 1006 [ "$quiet" != "y" ] && \ 1007 zfs_log_begin_msg "Running /scripts/local-bottom" 1008 run_scripts /scripts/local-bottom 1009 [ "$quiet" != "y" ] && zfs_log_end_msg 1010 fi 1011 fi 1012} 1013