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 name,guid -o value -H 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 [ -n "$ROOTDELAY" ] && ZFS_INITRD_PRE_MOUNTROOT_SLEEP="$ROOTDELAY" 276 277 if [ "$ZFS_INITRD_PRE_MOUNTROOT_SLEEP" -gt 0 ] 2>/dev/null 278 then 279 if [ "$quiet" != "y" ]; then 280 zfs_log_begin_msg "Sleeping for" \ 281 "$ZFS_INITRD_PRE_MOUNTROOT_SLEEP seconds..." 282 fi 283 sleep "$ZFS_INITRD_PRE_MOUNTROOT_SLEEP" 284 [ "$quiet" != "y" ] && zfs_log_end_msg 285 fi 286 287 # Wait for all of the /dev/{hd,sd}[a-z] device nodes to appear. 288 if command -v wait_for_udev > /dev/null 2>&1 ; then 289 wait_for_udev 10 290 elif command -v wait_for_dev > /dev/null 2>&1 ; then 291 wait_for_dev 292 fi 293 294 # zpool import refuse to import without a valid /proc/self/mounts 295 [ ! -f /proc/self/mounts ] && mount proc /proc 296 297 # Load the module 298 load_module "zfs" || return 1 299 300 if [ "$ZFS_INITRD_POST_MODPROBE_SLEEP" -gt 0 ] 2>/dev/null 301 then 302 if [ "$quiet" != "y" ]; then 303 zfs_log_begin_msg "Sleeping for" \ 304 "$ZFS_INITRD_POST_MODPROBE_SLEEP seconds..." 305 fi 306 sleep "$ZFS_INITRD_POST_MODPROBE_SLEEP" 307 [ "$quiet" != "y" ] && zfs_log_end_msg 308 fi 309 310 return 0 311} 312 313# Mount a given filesystem 314mount_fs() 315{ 316 fs="$1" 317 318 # Check that the filesystem exists 319 "${ZFS}" list -oname -tfilesystem -H "${fs}" > /dev/null 2>&1 || return 1 320 321 # Skip filesystems with canmount=off. The root fs should not have 322 # canmount=off, but ignore it for backwards compatibility just in case. 323 if [ "$fs" != "${ZFS_BOOTFS}" ] 324 then 325 canmount=$(get_fs_value "$fs" canmount) 326 [ "$canmount" = "off" ] && return 0 327 fi 328 329 # Need the _original_ datasets mountpoint! 330 mountpoint=$(get_fs_value "$fs" mountpoint) 331 ZFS_CMD="mount -o zfsutil -t zfs" 332 if [ "$mountpoint" = "legacy" ] || [ "$mountpoint" = "none" ]; then 333 # Can't use the mountpoint property. Might be one of our 334 # clones. Check the 'org.zol:mountpoint' property set in 335 # clone_snap() if that's usable. 336 mountpoint=$(get_fs_value "$fs" org.zol:mountpoint) 337 if [ "$mountpoint" = "legacy" ] || 338 [ "$mountpoint" = "none" ] || 339 [ "$mountpoint" = "-" ] 340 then 341 if [ "$fs" != "${ZFS_BOOTFS}" ]; then 342 # We don't have a proper mountpoint and this 343 # isn't the root fs. 344 return 0 345 else 346 # Last hail-mary: Hope 'rootmnt' is set! 347 mountpoint="" 348 fi 349 fi 350 351 # If it's not a legacy filesystem, it can only be a 352 # native one... 353 if [ "$mountpoint" = "legacy" ]; then 354 ZFS_CMD="mount -t zfs" 355 fi 356 fi 357 358 # Possibly decrypt a filesystem using native encryption. 359 decrypt_fs "$fs" 360 361 [ "$quiet" != "y" ] && \ 362 zfs_log_begin_msg "Mounting '${fs}' on '${rootmnt}/${mountpoint}'" 363 [ -n "${ZFS_DEBUG}" ] && \ 364 zfs_log_begin_msg "CMD: '$ZFS_CMD ${fs} ${rootmnt}/${mountpoint}'" 365 366 ZFS_STDERR=$(${ZFS_CMD} "${fs}" "${rootmnt}/${mountpoint}" 2>&1) 367 ZFS_ERROR=$? 368 if [ "${ZFS_ERROR}" != 0 ] 369 then 370 [ "$quiet" != "y" ] && zfs_log_failure_msg "${ZFS_ERROR}" 371 372 disable_plymouth 373 echo "" 374 echo "Command: ${ZFS_CMD} ${fs} ${rootmnt}/${mountpoint}" 375 echo "Message: $ZFS_STDERR" 376 echo "Error: $ZFS_ERROR" 377 echo "" 378 echo "Failed to mount ${fs} on ${rootmnt}/${mountpoint}." 379 echo "Manually mount the filesystem and exit." 380 shell 381 else 382 [ "$quiet" != "y" ] && zfs_log_end_msg 383 fi 384 385 return 0 386} 387 388# Unlock a ZFS native encrypted filesystem. 389decrypt_fs() 390{ 391 fs="$1" 392 393 # If pool encryption is active and the zfs command understands '-o encryption' 394 if [ "$(zpool list -H -o feature@encryption "${fs%%/*}")" = 'active' ]; then 395 396 # Determine dataset that holds key for root dataset 397 ENCRYPTIONROOT="$(get_fs_value "${fs}" encryptionroot)" 398 KEYLOCATION="$(get_fs_value "${ENCRYPTIONROOT}" keylocation)" 399 400 echo "${ENCRYPTIONROOT}" > /run/zfs_fs_name 401 402 # If root dataset is encrypted... 403 if ! [ "${ENCRYPTIONROOT}" = "-" ]; then 404 KEYSTATUS="$(get_fs_value "${ENCRYPTIONROOT}" keystatus)" 405 # Continue only if the key needs to be loaded 406 [ "$KEYSTATUS" = "unavailable" ] || return 0 407 408 # Do not prompt if key is stored noninteractively, 409 if ! [ "${KEYLOCATION}" = "prompt" ]; then 410 $ZFS load-key "${ENCRYPTIONROOT}" 411 412 # Prompt with plymouth, if active 413 elif /bin/plymouth --ping 2>/dev/null; then 414 echo "plymouth" > /run/zfs_console_askpwd_cmd 415 for _ in 1 2 3; do 416 plymouth ask-for-password --prompt "Encrypted ZFS password for ${ENCRYPTIONROOT}" | \ 417 $ZFS load-key "${ENCRYPTIONROOT}" && break 418 done 419 420 # Prompt with systemd, if active 421 elif [ -e /run/systemd/system ]; then 422 echo "systemd-ask-password" > /run/zfs_console_askpwd_cmd 423 for _ in 1 2 3; do 424 systemd-ask-password "Encrypted ZFS password for ${ENCRYPTIONROOT}" --no-tty | \ 425 $ZFS load-key "${ENCRYPTIONROOT}" && break 426 done 427 428 # Prompt with ZFS tty, otherwise 429 else 430 # Temporarily setting "printk" to "7" allows the prompt to appear even when the "quiet" kernel option has been used 431 echo "load-key" > /run/zfs_console_askpwd_cmd 432 read -r storeprintk _ < /proc/sys/kernel/printk 433 echo 7 > /proc/sys/kernel/printk 434 $ZFS load-key "${ENCRYPTIONROOT}" 435 echo "$storeprintk" > /proc/sys/kernel/printk 436 fi 437 fi 438 fi 439 440 return 0 441} 442 443# Destroy a given filesystem. 444destroy_fs() 445{ 446 fs="$1" 447 448 [ "$quiet" != "y" ] && \ 449 zfs_log_begin_msg "Destroying '$fs'" 450 451 ZFS_CMD="${ZFS} destroy $fs" 452 ZFS_STDERR="$(${ZFS_CMD} 2>&1)" 453 ZFS_ERROR="$?" 454 if [ "${ZFS_ERROR}" != 0 ] 455 then 456 [ "$quiet" != "y" ] && zfs_log_failure_msg "${ZFS_ERROR}" 457 458 disable_plymouth 459 echo "" 460 echo "Command: $ZFS_CMD" 461 echo "Message: $ZFS_STDERR" 462 echo "Error: $ZFS_ERROR" 463 echo "" 464 echo "Failed to destroy '$fs'. Please make sure that '$fs' is not available." 465 echo "Hint: Try: zfs destroy -Rfn $fs" 466 echo "If this dryrun looks good, then remove the 'n' from '-Rfn' and try again." 467 shell 468 else 469 [ "$quiet" != "y" ] && zfs_log_end_msg 470 fi 471 472 return 0 473} 474 475# Clone snapshot $1 to destination filesystem $2 476# Set 'canmount=noauto' and 'mountpoint=none' so that we get to keep 477# manual control over it's mounting (i.e., make sure it's not automatically 478# mounted with a 'zfs mount -a' in the init/systemd scripts). 479clone_snap() 480{ 481 snap="$1" 482 destfs="$2" 483 mountpoint="$3" 484 485 [ "$quiet" != "y" ] && zfs_log_begin_msg "Cloning '$snap' to '$destfs'" 486 487 # Clone the snapshot into a dataset we can boot from 488 # + We don't want this filesystem to be automatically mounted, we 489 # want control over this here and nowhere else. 490 # + We don't need any mountpoint set for the same reason. 491 # We use the 'org.zol:mountpoint' property to remember the mountpoint. 492 ZFS_CMD="${ZFS} clone -o canmount=noauto -o mountpoint=none" 493 ZFS_CMD="${ZFS_CMD} -o org.zol:mountpoint=${mountpoint}" 494 ZFS_CMD="${ZFS_CMD} $snap $destfs" 495 ZFS_STDERR="$(${ZFS_CMD} 2>&1)" 496 ZFS_ERROR="$?" 497 if [ "${ZFS_ERROR}" != 0 ] 498 then 499 [ "$quiet" != "y" ] && zfs_log_failure_msg "${ZFS_ERROR}" 500 501 disable_plymouth 502 echo "" 503 echo "Command: $ZFS_CMD" 504 echo "Message: $ZFS_STDERR" 505 echo "Error: $ZFS_ERROR" 506 echo "" 507 echo "Failed to clone snapshot." 508 echo "Make sure that the any problems are corrected and then make sure" 509 echo "that the dataset '$destfs' exists and is bootable." 510 shell 511 else 512 [ "$quiet" != "y" ] && zfs_log_end_msg 513 fi 514 515 return 0 516} 517 518# Rollback a given snapshot. 519rollback_snap() 520{ 521 snap="$1" 522 523 [ "$quiet" != "y" ] && zfs_log_begin_msg "Rollback $snap" 524 525 ZFS_CMD="${ZFS} rollback -Rf $snap" 526 ZFS_STDERR="$(${ZFS_CMD} 2>&1)" 527 ZFS_ERROR="$?" 528 if [ "${ZFS_ERROR}" != 0 ] 529 then 530 [ "$quiet" != "y" ] && zfs_log_failure_msg "${ZFS_ERROR}" 531 532 disable_plymouth 533 echo "" 534 echo "Command: $ZFS_CMD" 535 echo "Message: $ZFS_STDERR" 536 echo "Error: $ZFS_ERROR" 537 echo "" 538 echo "Failed to rollback snapshot." 539 shell 540 else 541 [ "$quiet" != "y" ] && zfs_log_end_msg 542 fi 543 544 return 0 545} 546 547# Get a list of snapshots, give them as a numbered list 548# to the user to choose from. 549ask_user_snap() 550{ 551 fs="$1" 552 553 # We need to temporarily disable debugging. Set 'debug' so we 554 # remember to enabled it again. 555 if [ -n "${ZFS_DEBUG}" ]; then 556 unset ZFS_DEBUG 557 set +x 558 debug=1 559 fi 560 561 # Because we need the resulting snapshot, which is sent on 562 # stdout to the caller, we use stderr for our questions. 563 echo "What snapshot do you want to boot from?" > /dev/stderr 564 # shellcheck disable=SC2046 565 IFS=" 566" set -- $("${ZFS}" list -H -oname -tsnapshot -r "${fs}") 567 568 i=1 569 for snap in "$@"; do 570 echo " $i: $snap" 571 i=$((i + 1)) 572 done > /dev/stderr 573 574 # expr instead of test here because [ a -lt 0 ] errors out, 575 # but expr falls back to lexicographical, which works out right 576 snapnr=0 577 while expr "$snapnr" "<" 1 > /dev/null || 578 expr "$snapnr" ">" "$#" > /dev/null 579 do 580 printf "%s" "Snap nr [1-$#]? " > /dev/stderr 581 read -r snapnr 582 done 583 584 # Re-enable debugging. 585 if [ -n "${debug}" ]; then 586 ZFS_DEBUG=1 587 set -x 588 fi 589 590 eval echo '$'"$snapnr" 591} 592 593setup_snapshot_booting() 594{ 595 snap="$1" 596 retval=0 597 598 # Make sure that the snapshot specified actually exists. 599 if [ ! "$(get_fs_value "${snap}" type)" ] 600 then 601 # Snapshot does not exist (...@<null> ?) 602 # ask the user for a snapshot to use. 603 snap="$(ask_user_snap "${snap%%@*}")" 604 fi 605 606 # Separate the full snapshot ('$snap') into it's filesystem and 607 # snapshot names. Would have been nice with a split() function.. 608 rootfs="${snap%%@*}" 609 snapname="${snap##*@}" 610 ZFS_BOOTFS="${rootfs}_${snapname}" 611 612 if ! grep -qiE '(^|[^\\](\\\\)* )(rollback)=(on|yes|1)( |$)' /proc/cmdline 613 then 614 # If the destination dataset for the clone 615 # already exists, destroy it. Recursively 616 if [ "$(get_fs_value "${rootfs}_${snapname}" type)" ]; then 617 filesystems=$("${ZFS}" list -oname -tfilesystem -H \ 618 -r -Sname "${ZFS_BOOTFS}") 619 for fs in $filesystems; do 620 destroy_fs "${fs}" 621 done 622 fi 623 fi 624 625 # Get all snapshots, recursively (might need to clone /usr, /var etc 626 # as well). 627 for s in $("${ZFS}" list -H -oname -tsnapshot -r "${rootfs}" | \ 628 grep "${snapname}") 629 do 630 if grep -qiE '(^|[^\\](\\\\)* )(rollback)=(on|yes|1)( |$)' /proc/cmdline 631 then 632 # Rollback snapshot 633 rollback_snap "$s" || retval=$((retval + 1)) 634 ZFS_BOOTFS="${rootfs}" 635 else 636 # Setup a destination filesystem name. 637 # Ex: Called with 'rpool/ROOT/debian@snap2' 638 # rpool/ROOT/debian@snap2 => rpool/ROOT/debian_snap2 639 # rpool/ROOT/debian/boot@snap2 => rpool/ROOT/debian_snap2/boot 640 # rpool/ROOT/debian/usr@snap2 => rpool/ROOT/debian_snap2/usr 641 # rpool/ROOT/debian/var@snap2 => rpool/ROOT/debian_snap2/var 642 subfs="${s##$rootfs}" 643 subfs="${subfs%%@$snapname}" 644 645 destfs="${rootfs}_${snapname}" # base fs. 646 [ -n "$subfs" ] && destfs="${destfs}$subfs" # + sub fs. 647 648 # Get the mountpoint of the filesystem, to be used 649 # with clone_snap(). If legacy or none, then use 650 # the sub fs value. 651 mountpoint=$(get_fs_value "${s%%@*}" mountpoint) 652 if [ "$mountpoint" = "legacy" ] || \ 653 [ "$mountpoint" = "none" ] 654 then 655 if [ -n "${subfs}" ]; then 656 mountpoint="${subfs}" 657 else 658 mountpoint="/" 659 fi 660 fi 661 662 # Clone the snapshot into its own 663 # filesystem 664 clone_snap "$s" "${destfs}" "${mountpoint}" || \ 665 retval=$((retval + 1)) 666 fi 667 done 668 669 # If we haven't return yet, we have a problem... 670 return "${retval}" 671} 672 673# ================================================================ 674 675# This is the main function. 676mountroot() 677{ 678 # ---------------------------------------------------------------- 679 # I N I T I A L S E T U P 680 681 # ------------ 682 # Run the pre-mount scripts from /scripts/local-top. 683 pre_mountroot 684 685 # ------------ 686 # Source the default setup variables. 687 [ -r '/etc/default/zfs' ] && . /etc/default/zfs 688 689 # ------------ 690 # Support debug option 691 if grep -qiE '(^|[^\\](\\\\)* )(zfs_debug|zfs\.debug|zfsdebug)=(on|yes|1)( |$)' /proc/cmdline 692 then 693 ZFS_DEBUG=1 694 mkdir /var/log 695 #exec 2> /var/log/boot.debug 696 set -x 697 fi 698 699 # ------------ 700 # Load ZFS module etc. 701 if ! load_module_initrd; then 702 disable_plymouth 703 echo "" 704 echo "Failed to load ZFS modules." 705 echo "Manually load the modules and exit." 706 shell 707 fi 708 709 # ------------ 710 # Look for the cache file (if any). 711 [ -f "${ZPOOL_CACHE}" ] || unset ZPOOL_CACHE 712 [ -s "${ZPOOL_CACHE}" ] || unset ZPOOL_CACHE 713 714 # ------------ 715 # Compatibility: 'ROOT' is for Debian GNU/Linux (etc), 716 # 'root' is for Redhat/Fedora (etc), 717 # 'REAL_ROOT' is for Gentoo 718 if [ -z "$ROOT" ] 719 then 720 [ -n "$root" ] && ROOT=${root} 721 722 [ -n "$REAL_ROOT" ] && ROOT=${REAL_ROOT} 723 fi 724 725 # ------------ 726 # Where to mount the root fs in the initrd - set outside this script 727 # Compatibility: 'rootmnt' is for Debian GNU/Linux (etc), 728 # 'NEWROOT' is for RedHat/Fedora (etc), 729 # 'NEW_ROOT' is for Gentoo 730 if [ -z "$rootmnt" ] 731 then 732 [ -n "$NEWROOT" ] && rootmnt=${NEWROOT} 733 734 [ -n "$NEW_ROOT" ] && rootmnt=${NEW_ROOT} 735 fi 736 737 # ------------ 738 # No longer set in the defaults file, but it could have been set in 739 # get_pools() in some circumstances. If it's something, but not 'yes', 740 # it's no good to us. 741 [ -n "$USE_DISK_BY_ID" ] && [ "$USE_DISK_BY_ID" != 'yes' ] && \ 742 unset USE_DISK_BY_ID 743 744 # ---------------------------------------------------------------- 745 # P A R S E C O M M A N D L I N E O P T I O N S 746 747 # This part is the really ugly part - there's so many options and permutations 748 # 'out there', and if we should make this the 'primary' source for ZFS initrd 749 # scripting, we need/should support them all. 750 # 751 # Supports the following kernel command line argument combinations 752 # (in this order - first match win): 753 # 754 # rpool=<pool> (tries to finds bootfs automatically) 755 # bootfs=<pool>/<dataset> (uses this for rpool - first part) 756 # rpool=<pool> bootfs=<pool>/<dataset> 757 # -B zfs-bootfs=<pool>/<fs> (uses this for rpool - first part) 758 # rpool=rpool (default if none of the above is used) 759 # root=<pool>/<dataset> (uses this for rpool - first part) 760 # root=ZFS=<pool>/<dataset> (uses this for rpool - first part, without 'ZFS=') 761 # root=zfs:AUTO (tries to detect both pool and rootfs) 762 # root=zfs:<pool>/<dataset> (uses this for rpool - first part, without 'zfs:') 763 # 764 # Option <dataset> could also be <snapshot> 765 # Option <pool> could also be <guid> 766 767 # ------------ 768 # Support force option 769 # In addition, setting one of zfs_force, zfs.force or zfsforce to 770 # 'yes', 'on' or '1' will make sure we force import the pool. 771 # This should (almost) never be needed, but it's here for 772 # completeness. 773 ZPOOL_FORCE="" 774 if grep -qiE '(^|[^\\](\\\\)* )(zfs_force|zfs\.force|zfsforce)=(on|yes|1)( |$)' /proc/cmdline 775 then 776 ZPOOL_FORCE="-f" 777 fi 778 779 # ------------ 780 # Look for 'rpool' and 'bootfs' parameter 781 [ -n "$rpool" ] && ZFS_RPOOL="${rpool#rpool=}" 782 [ -n "$bootfs" ] && ZFS_BOOTFS="${bootfs#bootfs=}" 783 784 # ------------ 785 # If we have 'ROOT' (see above), but not 'ZFS_BOOTFS', then use 786 # 'ROOT' 787 [ -n "$ROOT" ] && [ -z "${ZFS_BOOTFS}" ] && ZFS_BOOTFS="$ROOT" 788 789 # ------------ 790 # Check for the `-B zfs-bootfs=%s/%u,...` kind of parameter. 791 # NOTE: Only use the pool name and dataset. The rest is not 792 # supported by OpenZFS (whatever it's for). 793 if [ -z "$ZFS_RPOOL" ] 794 then 795 # The ${zfs-bootfs} variable is set at the kernel command 796 # line, usually by GRUB, but it cannot be referenced here 797 # directly because bourne variable names cannot contain a 798 # hyphen. 799 # 800 # Reassign the variable by dumping the environment and 801 # stripping the zfs-bootfs= prefix. Let the shell handle 802 # quoting through the eval command: 803 # shellcheck disable=SC2046 804 eval ZFS_RPOOL=$(set | sed -n -e 's,^zfs-bootfs=,,p') 805 fi 806 807 # ------------ 808 # No root fs or pool specified - do auto detect. 809 if [ -z "$ZFS_RPOOL" ] && [ -z "${ZFS_BOOTFS}" ] 810 then 811 # Do auto detect. Do this by 'cheating' - set 'root=zfs:AUTO' 812 # which will be caught later 813 ROOT='zfs:AUTO' 814 fi 815 816 # ---------------------------------------------------------------- 817 # F I N D A N D I M P O R T C O R R E C T P O O L 818 819 # ------------ 820 if [ "$ROOT" = "zfs:AUTO" ] 821 then 822 # Try to detect both pool and root fs. 823 824 # If we got here, that means we don't have a hint so as to 825 # the root dataset, but with root=zfs:AUTO on cmdline, 826 # this says "zfs:AUTO" here and interferes with checks later 827 ZFS_BOOTFS= 828 829 [ "$quiet" != "y" ] && \ 830 zfs_log_begin_msg "Attempting to import additional pools." 831 832 # Get a list of pools available for import 833 if [ -n "$ZFS_RPOOL" ] 834 then 835 # We've specified a pool - check only that 836 POOLS=$ZFS_RPOOL 837 else 838 POOLS=$(get_pools) 839 fi 840 841 OLD_IFS="$IFS" ; IFS=";" 842 for pool in $POOLS 843 do 844 [ -z "$pool" ] && continue 845 846 IFS="$OLD_IFS" import_pool "$pool" 847 IFS="$OLD_IFS" find_rootfs "$pool" && break 848 done 849 IFS="$OLD_IFS" 850 851 [ "$quiet" != "y" ] && zfs_log_end_msg $ZFS_ERROR 852 else 853 # No auto - use value from the command line option. 854 855 # Strip 'zfs:' and 'ZFS='. 856 ZFS_BOOTFS="${ROOT#*[:=]}" 857 858 # Strip everything after the first slash. 859 ZFS_RPOOL="${ZFS_BOOTFS%%/*}" 860 fi 861 862 # Import the pool (if not already done so in the AUTO check above). 863 if [ -n "$ZFS_RPOOL" ] && [ -z "${POOL_IMPORTED}" ] 864 then 865 [ "$quiet" != "y" ] && \ 866 zfs_log_begin_msg "Importing ZFS root pool '$ZFS_RPOOL'" 867 868 import_pool "${ZFS_RPOOL}" 869 find_rootfs "${ZFS_RPOOL}" 870 871 [ "$quiet" != "y" ] && zfs_log_end_msg 872 fi 873 874 if [ -z "${POOL_IMPORTED}" ] 875 then 876 # No pool imported, this is serious! 877 disable_plymouth 878 echo "" 879 echo "Command: $ZFS_CMD" 880 echo "Message: $ZFS_STDERR" 881 echo "Error: $ZFS_ERROR" 882 echo "" 883 echo "No pool imported. Manually import the root pool" 884 echo "at the command prompt and then exit." 885 echo "Hint: Try: zpool import -N ${ZFS_RPOOL}" 886 shell 887 fi 888 889 # In case the pool was specified as guid, resolve guid to name 890 pool="$("${ZPOOL}" get name,guid -o name,value -H | \ 891 awk -v pool="${ZFS_RPOOL}" '$2 == pool { print $1 }')" 892 if [ -n "$pool" ]; then 893 # If $ZFS_BOOTFS contains guid, replace the guid portion with $pool 894 ZFS_BOOTFS=$(echo "$ZFS_BOOTFS" | \ 895 sed -e "s/$("${ZPOOL}" get guid -o value "$pool" -H)/$pool/g") 896 ZFS_RPOOL="${pool}" 897 fi 898 899 900 # ---------------------------------------------------------------- 901 # P R E P A R E R O O T F I L E S Y S T E M 902 903 if [ -n "${ZFS_BOOTFS}" ] 904 then 905 # Booting from a snapshot? 906 # Will overwrite the ZFS_BOOTFS variable like so: 907 # rpool/ROOT/debian@snap2 => rpool/ROOT/debian_snap2 908 echo "${ZFS_BOOTFS}" | grep -q '@' && \ 909 setup_snapshot_booting "${ZFS_BOOTFS}" 910 fi 911 912 if [ -z "${ZFS_BOOTFS}" ] 913 then 914 # Still nothing! Let the user sort this out. 915 disable_plymouth 916 echo "" 917 echo "Error: Unknown root filesystem - no 'bootfs' pool property and" 918 echo " not specified on the kernel command line." 919 echo "" 920 echo "Manually mount the root filesystem on $rootmnt and then exit." 921 echo "Hint: Try: mount -o zfsutil -t zfs ${ZFS_RPOOL-rpool}/ROOT/system $rootmnt" 922 shell 923 fi 924 925 # ---------------------------------------------------------------- 926 # M O U N T F I L E S Y S T E M S 927 928 # * Ideally, the root filesystem would be mounted like this: 929 # 930 # zpool import -R "$rootmnt" -N "$ZFS_RPOOL" 931 # zfs mount -o mountpoint=/ "${ZFS_BOOTFS}" 932 # 933 # but the MOUNTPOINT prefix is preserved on descendent filesystem 934 # after the pivot into the regular root, which later breaks things 935 # like `zfs mount -a` and the /proc/self/mounts refresh. 936 # 937 # * Mount additional filesystems required 938 # Such as /usr, /var, /usr/local etc. 939 # NOTE: Mounted in the order specified in the 940 # ZFS_INITRD_ADDITIONAL_DATASETS variable so take care! 941 942 # Go through the complete list (recursively) of all filesystems below 943 # the real root dataset 944 filesystems="$("${ZFS}" list -oname -tfilesystem -H -r "${ZFS_BOOTFS}")" 945 OLD_IFS="$IFS" ; IFS=" 946" 947 for fs in $filesystems; do 948 IFS="$OLD_IFS" mount_fs "$fs" 949 done 950 IFS="$OLD_IFS" 951 for fs in $ZFS_INITRD_ADDITIONAL_DATASETS; do 952 mount_fs "$fs" 953 done 954 955 touch /run/zfs_unlock_complete 956 if [ -e /run/zfs_unlock_complete_notify ]; then 957 read -r < /run/zfs_unlock_complete_notify 958 fi 959 960 # ------------ 961 # Debugging information 962 if [ -n "${ZFS_DEBUG}" ] 963 then 964 #exec 2>&1- 965 966 echo "DEBUG: imported pools:" 967 "${ZPOOL}" list -H 968 echo 969 970 echo "DEBUG: mounted ZFS filesystems:" 971 mount | grep zfs 972 echo 973 974 echo "=> waiting for ENTER before continuing because of 'zfsdebug=1'. " 975 printf "%s" " 'c' for shell, 'r' for reboot, 'ENTER' to continue. " 976 read -r b 977 978 [ "$b" = "c" ] && /bin/sh 979 [ "$b" = "r" ] && reboot -f 980 981 set +x 982 fi 983 984 # ------------ 985 # Run local bottom script 986 if command -v run_scripts > /dev/null 2>&1 987 then 988 if [ -f "/scripts/local-bottom" ] || [ -d "/scripts/local-bottom" ] 989 then 990 [ "$quiet" != "y" ] && \ 991 zfs_log_begin_msg "Running /scripts/local-bottom" 992 run_scripts /scripts/local-bottom 993 [ "$quiet" != "y" ] && zfs_log_end_msg 994 fi 995 fi 996} 997