usr.sbin/bsdinstall/scripts/zfsboot

   1 #!/bin/sh
   2 #-
   3 # Copyright (c) 2013-2014 Allan Jude
   4 # Copyright (c) 2013-2015 Devin Teske
   5 # All rights reserved.
   6 #
   7 # Redistribution and use in source and binary forms, with or without
   8 # modification, are permitted provided that the following conditions
   9 # are met:
  10 # 1. Redistributions of source code must retain the above copyright
  11 #    notice, this list of conditions and the following disclaimer.
  12 # 2. Redistributions in binary form must reproduce the above copyright
  13 #    notice, this list of conditions and the following disclaimer in the
  14 #    documentation and/or other materials provided with the distribution.
  15 #
  16 # THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 # ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 # SUCH DAMAGE.
  27 #
  28 # $FreeBSD$
  29 #
  30 ############################################################ INCLUDES
  31
  32 BSDCFG_SHARE="/usr/share/bsdconfig"
  33 . $BSDCFG_SHARE/common.subr || exit 1
  34 f_dprintf "%s: loading includes..." "$0"
  35 f_include $BSDCFG_SHARE/device.subr
  36 f_include $BSDCFG_SHARE/dialog.subr
  37 f_include $BSDCFG_SHARE/password/password.subr
  38 f_include $BSDCFG_SHARE/variable.subr
  39
  40 ############################################################ CONFIGURATION
  41
  42 #
  43 # Default name of the boot-pool
  44 #
  45 : ${ZFSBOOT_POOL_NAME:=zroot}
  46
  47 #
  48 # Default options to use when creating zroot pool
  49 #
  50 : ${ZFSBOOT_POOL_CREATE_OPTIONS:=-O compress=lz4 -O atime=off}
  51
  52 #
  53 # Default name for the boot environment parent dataset
  54 #
  55 : ${ZFSBOOT_BEROOT_NAME:=ROOT}
  56
  57 #
  58 # Default name for the primany boot environment
  59 #
  60 : ${ZFSBOOT_BOOTFS_NAME:=default}
  61
  62 #
  63 # Default Virtual Device (vdev) type to create
  64 #
  65 : ${ZFSBOOT_VDEV_TYPE:=stripe}
  66
  67 #
  68 # Should we use sysctl(8) vfs.zfs.min_auto_ashift=12 to force 4K sectors?
  69 #
  70 : ${ZFSBOOT_FORCE_4K_SECTORS:=1}
  71
  72 #
  73 # Should we use geli(8) to encrypt the drives?
  74 # NB: Automatically enables ZFSBOOT_BOOT_POOL
  75 #
  76 : ${ZFSBOOT_GELI_ENCRYPTION=}
  77
  78 #
  79 # Default path to the geli(8) keyfile used in drive encryption
  80 #
  81 : ${ZFSBOOT_GELI_KEY_FILE:=/boot/encryption.key}
  82
  83 #
  84 # Create a separate boot pool?
  85 # NB: Automatically set when using geli(8) or MBR
  86 #
  87 : ${ZFSBOOT_BOOT_POOL=}
  88
  89 #
  90 # Options to use when creating separate boot pool (if any)
  91 #
  92 : ${ZFSBOOT_BOOT_POOL_CREATE_OPTIONS:=}
  93
  94 #
  95 # Default name for boot pool when enabled (e.g., geli(8) or MBR)
  96 #
  97 : ${ZFSBOOT_BOOT_POOL_NAME:=bootpool}
  98
  99 #
 100 # Default size for boot pool when enabled (e.g., geli(8) or MBR)
 101 #
 102 : ${ZFSBOOT_BOOT_POOL_SIZE:=2g}
 103
 104 #
 105 # Default disks to use (always empty unless being scripted)
 106 #
 107 : ${ZFSBOOT_DISKS:=}
 108
 109 #
 110 # Default partitioning scheme to use on disks
 111 #
 112 : ${ZFSBOOT_PARTITION_SCHEME:=GPT}
 113
 114 #
 115 # How much swap to put on each block device in the boot zpool
 116 # NOTE: Value passed to gpart(8); which supports SI unit suffixes.
 117 #
 118 : ${ZFSBOOT_SWAP_SIZE:=2g}
 119
 120 #
 121 # Should we use geli(8) to encrypt the swap?
 122 #
 123 : ${ZFSBOOT_SWAP_ENCRYPTION=}
 124
 125 #
 126 # Should we use gmirror(8) to mirror the swap?
 127 #
 128 : ${ZFSBOOT_SWAP_MIRROR=}
 129
 130 #
 131 # Default ZFS datasets for root zpool
 132 #
 133 # NOTE: Requires /tmp, /var/tmp, /$ZFSBOOT_BOOTFS_NAME/$ZFSBOOT_BOOTFS_NAME
 134 # NOTE: Anything after pound/hash character [#] is ignored as a comment.
 135 #
 136 f_isset ZFSBOOT_DATASETS || ZFSBOOT_DATASETS="
 137         # DATASET       OPTIONS (comma or space separated; or both)
 138
 139         # Boot Environment [BE] root and default boot dataset
 140         /$ZFSBOOT_BEROOT_NAME                           mountpoint=none
 141         /$ZFSBOOT_BEROOT_NAME/$ZFSBOOT_BOOTFS_NAME      mountpoint=/
 142
 143         # Compress /tmp, allow exec but not setuid
 144         /tmp            mountpoint=/tmp,exec=on,setuid=off
 145
 146         # Don't mount /usr so that 'base' files go to the BEROOT
 147         /usr            mountpoint=/usr,canmount=off
 148
 149         # Home directories separated so they are common to all BEs
 150         /usr/home       # NB: /home is a symlink to /usr/home
 151
 152         # Ports tree
 153         /usr/ports      setuid=off
 154
 155         # Source tree (compressed)
 156         /usr/src
 157
 158         # Create /var and friends
 159         /var            mountpoint=/var,canmount=off
 160         /var/crash      exec=off,setuid=off
 161         /var/log        exec=off,setuid=off
 162         /var/mail       atime=on
 163         /var/tmp        setuid=off
 164 " # END-QUOTE
 165
 166 #
 167 # If interactive and the user has not explicitly chosen a vdev type or disks,
 168 # make the user confirm scripted/default choices when proceeding to install.
 169 #
 170 : ${ZFSBOOT_CONFIRM_LAYOUT:=1}
 171
 172 ############################################################ GLOBALS
 173
 174 #
 175 # Format of a line in printf(1) syntax to add to fstab(5)
 176 #
 177 FSTAB_FMT="%s\t\t%s\t%s\t%s\t\t%s\t%s\n"
 178
 179 #
 180 # Command strings for various tasks
 181 #
 182 CHMOD_MODE='chmod %s "%s"'
 183 DD_WITH_OPTIONS='dd if="%s" of="%s" %s'
 184 ECHO_APPEND='echo "%s" >> "%s"'
 185 GELI_ATTACH='geli attach -j - -k "%s" "%s"'
 186 GELI_DETACH_F='geli detach -f "%s"'
 187 GELI_PASSWORD_INIT='geli init -b -B "%s" -e %s -J - -K "%s" -l 256 -s 4096 "%s"'
 188 GPART_ADD='gpart add -t %s "%s"'
 189 GPART_ADD_INDEX='gpart add -i %s -t %s "%s"'
 190 GPART_ADD_INDEX_WITH_SIZE='gpart add -i %s -t %s -s %s "%s"'
 191 GPART_ADD_LABEL='gpart add -l %s -t %s "%s"'
 192 GPART_ADD_LABEL_WITH_SIZE='gpart add -l %s -t %s -s %s "%s"'
 193 GPART_BOOTCODE='gpart bootcode -b "%s" "%s"'
 194 GPART_BOOTCODE_PART='gpart bootcode -b "%s" -p "%s" -i %s "%s"'
 195 GPART_CREATE='gpart create -s %s "%s"'
 196 GPART_DESTROY_F='gpart destroy -F "%s"'
 197 GPART_SET_ACTIVE='gpart set -a active -i %s "%s"'
 198 GRAID_DELETE='graid delete "%s"'
 199 LN_SF='ln -sf "%s" "%s"'
 200 MKDIR_P='mkdir -p "%s"'
 201 MOUNT_TYPE='mount -t %s "%s" "%s"'
 202 PRINTF_CONF="printf '%s=\"%%s\"\\\n' %s >> \"%s\""
 203 PRINTF_FSTAB='printf "$FSTAB_FMT" "%s" "%s" "%s" "%s" "%s" "%s" >> "%s"'
 204 SHELL_TRUNCATE=':> "%s"'
 205 SWAP_GMIRROR_LABEL='gmirror label swap %s'
 206 SYSCTL_ZFS_MIN_ASHIFT_12='sysctl vfs.zfs.min_auto_ashift=12'
 207 UMOUNT='umount "%s"'
 208 ZFS_CREATE_WITH_OPTIONS='zfs create %s "%s"'
 209 ZFS_SET='zfs set "%s" "%s"'
 210 ZFS_UNMOUNT='zfs unmount "%s"'
 211 ZPOOL_CREATE_WITH_OPTIONS='zpool create %s "%s" %s %s'
 212 ZPOOL_DESTROY='zpool destroy "%s"'
 213 ZPOOL_EXPORT='zpool export "%s"'
 214 ZPOOL_IMPORT_WITH_OPTIONS='zpool import %s "%s"'
 215 ZPOOL_LABELCLEAR_F='zpool labelclear -f "%s"'
 216 ZPOOL_SET='zpool set %s "%s"'
 217
 218 #
 219 # Strings that should be moved to an i18n file and loaded with f_include_lang()
 220 #
 221 hline_alnum_arrows_punc_tab_enter="Use alnum, arrows, punctuation, TAB or ENTER"
 222 hline_arrows_space_tab_enter="Use arrows, SPACE, TAB or ENTER"
 223 hline_arrows_tab_enter="Press arrows, TAB or ENTER"
 224 msg_an_unknown_error_occurred="An unknown error occurred"
 225 msg_back="Back"
 226 msg_cancel="Cancel"
 227 msg_change_selection="Change Selection"
 228 msg_configure_options="Configure Options:"
 229 msg_detailed_disk_info="gpart(8) show %s:\n%s\n\ncamcontrol(8) inquiry %s:\n%s\n\n\ncamcontrol(8) identify %s:\n%s\n"
 230 msg_disk_info="Disk Info"
 231 msg_disk_info_help="Get detailed information on disk device(s)"
 232 msg_disk_singular="disk"
 233 msg_disk_plural="disks"
 234 msg_encrypt_disks="Encrypt Disks?"
 235 msg_encrypt_disks_help="Use geli(8) to encrypt all data partitions"
 236 msg_error="Error"
 237 msg_force_4k_sectors="Force 4K Sectors?"
 238 msg_force_4k_sectors_help="Use sysctl(8) vfs.zfs.min_auto_ashift=12 to force 4K sectors"
 239 msg_freebsd_installer="FreeBSD Installer"
 240 msg_geli_password="Enter a strong passphrase, used to protect your encryption keys. You will be required to enter this passphrase each time the system is booted"
 241 msg_geli_setup="Initializing encryption on selected disks,\n this will take several seconds per disk"
 242 msg_install="Install"
 243 msg_install_desc="Proceed with Installation"
 244 msg_install_help="Create ZFS boot pool with displayed options"
 245 msg_invalid_boot_pool_size="Invalid boot pool size \`%s'"
 246 msg_invalid_disk_argument="Invalid disk argument \`%s'"
 247 msg_invalid_index_argument="Invalid index argument \`%s'"
 248 msg_invalid_swap_size="Invalid swap size \`%s'"
 249 msg_invalid_virtual_device_type="Invalid Virtual Device type \`%s'"
 250 msg_last_chance_are_you_sure="Last Chance! Are you sure you want to destroy\nthe current contents of the following disks:\n\n   %s"
 251 msg_last_chance_are_you_sure_color='\\ZrLast Chance!\\ZR Are you \\Z1sure\\Zn you want to \\Zr\\Z1destroy\\Zn\nthe current contents of the following disks:\n\n   %s'
 252 msg_mirror_desc="Mirror - n-Way Mirroring"
 253 msg_mirror_help="[2+ Disks] Mirroring provides the best performance, but the least storage"
 254 msg_missing_disk_arguments="missing disk arguments"
 255 msg_missing_one_or_more_scripted_disks="Missing one or more scripted disks!"
 256 msg_no="NO"
 257 msg_no_disks_present_to_configure="No disk(s) present to configure"
 258 msg_no_disks_selected="No disks selected."
 259 msg_not_enough_disks_selected="Not enough disks selected. (%u < %u minimum)"
 260 msg_null_disk_argument="NULL disk argument"
 261 msg_null_index_argument="NULL index argument"
 262 msg_null_poolname="NULL poolname"
 263 msg_ok="OK"
 264 msg_partition_scheme="Partition Scheme"
 265 msg_partition_scheme_help="Toggle between GPT and MBR partitioning schemes"
 266 msg_please_enter_a_name_for_your_zpool="Please enter a name for your zpool:"
 267 msg_please_enter_amount_of_swap_space="Please enter amount of swap space (SI-Unit suffixes\nrecommended; e.g., \`2g' for 2 Gigabytes):"
 268 msg_please_select_one_or_more_disks="Please select one or more disks to create a zpool:"
 269 msg_pool_name="Pool Name"
 270 msg_pool_name_cannot_be_empty="Pool name cannot be empty."
 271 msg_pool_name_help="Customize the name of the zpool to be created (Required)"
 272 msg_pool_type_disks="Pool Type/Disks:"
 273 msg_pool_type_disks_help="Choose type of ZFS Virtual Device and disks to use (Required)"
 274 msg_processing_selection="Processing selection..."
 275 msg_raidz1_desc="RAID-Z1 - Single Redundant RAID"
 276 msg_raidz1_help="[3+ Disks] Withstand failure of 1 disk. Recommended for: 3, 5 or 9 disks"
 277 msg_raidz2_desc="RAID-Z2 - Double Redundant RAID"
 278 msg_raidz2_help="[4+ Disks] Withstand failure of 2 disks. Recommended for: 4, 6 or 10 disks"
 279 msg_raidz3_desc="RAID-Z3 - Triple Redundant RAID"
 280 msg_raidz3_help="[5+ Disks] Withstand failure of 3 disks. Recommended for: 5, 7 or 11 disks"
 281 msg_rescan_devices="Rescan Devices"
 282 msg_rescan_devices_help="Scan for device changes"
 283 msg_select="Select"
 284 msg_select_a_disk_device="Select a disk device"
 285 msg_select_virtual_device_type="Select Virtual Device type:"
 286 msg_stripe_desc="Stripe - No Redundancy"
 287 msg_stripe_help="[1+ Disks] Striping provides maximum storage but no redundancy"
 288 msg_swap_encrypt="Encrypt Swap?"
 289 msg_swap_encrypt_help="Encrypt swap partitions with temporary keys, discarded on reboot"
 290 msg_swap_invalid="The selected swap size (%s) is invalid. Enter a number optionally followed by units. Example: 2G"
 291 msg_swap_mirror="Mirror Swap?"
 292 msg_swap_mirror_help="Mirror swap partitions for redundancy, breaks crash dumps"
 293 msg_swap_size="Swap Size"
 294 msg_swap_size_help="Customize how much swap space is allocated to each selected disk"
 295 msg_swap_toosmall="The selected swap size (%s) is to small. Please enter a value greater than 100MB or enter 0 for no swap"
 296 msg_these_disks_are_too_small="These disks are too small given the amount of requested\nswap (%s) and/or geli(8) (%s) partitions, which would\ntake 50%% or more of each of the following selected disk\ndevices (not recommended):\n\n  %s\n\nRecommend changing partition size(s) and/or selecting a\ndifferent set of devices."
 297 msg_uefi_not_supported="The FreeBSD UEFI loader does not currently support booting root-on-ZFS. Your system will need to boot in legacy (CSM) mode.\nDo you want to continue?"
 298 msg_unable_to_get_disk_capacity="Unable to get disk capacity of \`%s'"
 299 msg_unsupported_partition_scheme="%s is an unsupported partition scheme"
 300 msg_user_cancelled="User Cancelled."
 301 msg_yes="YES"
 302 msg_zfs_configuration="ZFS Configuration"
 303
 304 ############################################################ FUNCTIONS
 305
 306 # dialog_menu_main
 307 #
 308 # Display the dialog(1)-based application main menu.
 309 #
 310 dialog_menu_main()
 311 {
 312         local title="$DIALOG_TITLE"
 313         local btitle="$DIALOG_BACKTITLE"
 314         local prompt="$msg_configure_options"
 315         local force4k="$msg_no"
 316         local usegeli="$msg_no"
 317         local swapgeli="$msg_no"
 318         local swapmirror="$msg_no"
 319         [ "$ZFSBOOT_FORCE_4K_SECTORS" ] && force4k="$msg_yes"
 320         [ "$ZFSBOOT_GELI_ENCRYPTION" ] && usegeli="$msg_yes"
 321         [ "$ZFSBOOT_SWAP_ENCRYPTION" ] && swapgeli="$msg_yes"
 322         [ "$ZFSBOOT_SWAP_MIRROR" ] && swapmirror="$msg_yes"
 323         local disks n disks_grammar
 324         f_count n $ZFSBOOT_DISKS
 325         { [ $n -eq 1 ] && disks_grammar=$msg_disk_singular; } ||
 326                 disks_grammar=$msg_disk_plural # grammar
 327         local menu_list="
 328                 '>>> $msg_install'      '$msg_install_desc'
 329                                         '$msg_install_help'
 330                 'T $msg_pool_type_disks'
 331                                         '$ZFSBOOT_VDEV_TYPE: $n $disks_grammar'
 332                                         '$msg_pool_type_disks_help'
 333                 '- $msg_rescan_devices' '*'
 334                                         '$msg_rescan_devices_help'
 335                 '- $msg_disk_info'      '*'
 336                                         '$msg_disk_info_help'
 337                 'N $msg_pool_name'      '$ZFSBOOT_POOL_NAME'
 338                                         '$msg_pool_name_help'
 339                 '4 $msg_force_4k_sectors'
 340                                         '$force4k'
 341                                         '$msg_force_4k_sectors_help'
 342                 'E $msg_encrypt_disks'  '$usegeli'
 343                                         '$msg_encrypt_disks_help'
 344                 'P $msg_partition_scheme'
 345                                         '$ZFSBOOT_PARTITION_SCHEME'
 346                                         '$msg_partition_scheme_help'
 347                 'S $msg_swap_size'      '$ZFSBOOT_SWAP_SIZE'
 348                                         '$msg_swap_size_help'
 349                 'M $msg_swap_mirror'    '$swapmirror'
 350                                         '$msg_swap_mirror_help'
 351                 'W $msg_swap_encrypt'   '$swapgeli'
 352                                         '$msg_swap_encrypt_help'
 353         " # END-QUOTE
 354         local defaultitem= # Calculated below
 355         local hline="$hline_alnum_arrows_punc_tab_enter"
 356
 357         local height width rows
 358         eval f_dialog_menu_with_help_size height width rows \
 359                 \"\$title\" \"\$btitle\" \"\$prompt\" \"\$hline\" $menu_list
 360
 361         # Obtain default-item from previously stored selection
 362         f_dialog_default_fetch defaultitem
 363
 364         local menu_choice
 365         menu_choice=$( eval $DIALOG \
 366                 --title \"\$title\"              \
 367                 --backtitle \"\$btitle\"         \
 368                 --hline \"\$hline\"              \
 369                 --item-help                      \
 370                 --ok-label \"\$msg_select\"      \
 371                 --cancel-label \"\$msg_cancel\"  \
 372                 --default-item \"\$defaultitem\" \
 373                 --menu \"\$prompt\"              \
 374                 $height $width $rows             \
 375                 $menu_list                       \
 376                 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD
 377         )
 378         local retval=$?
 379         f_dialog_data_sanitize menu_choice
 380         f_dialog_menutag_store "$menu_choice"
 381
 382         # Only update default-item on success
 383         [ $retval -eq $DIALOG_OK ] && f_dialog_default_store "$menu_choice"
 384
 385         return $retval
 386 }
 387
 388 # dialog_last_chance $disks ...
 389 #
 390 # Display a list of the disks that the user is about to destroy. The default
 391 # action is to return error status unless the user explicitly (non-default)
 392 # selects "Yes" from the noyes dialog.
 393 #
 394 dialog_last_chance()
 395 {
 396         local title="$DIALOG_TITLE"
 397         local btitle="$DIALOG_BACKTITLE"
 398         local prompt # Calculated below
 399         local hline="$hline_arrows_tab_enter"
 400
 401         local height=8 width=50 prefix="   "
 402         local plen=${#prefix} list= line=
 403         local max_width=$(( $width - 3 - $plen ))
 404
 405         local yes no defaultno extra_args format
 406         if [ "$USE_XDIALOG" ]; then
 407                 yes=ok no=cancel defaultno=default-no
 408                 extra_args="--wrap --left"
 409                 format="$msg_last_chance_are_you_sure"
 410         else
 411                 yes=yes no=no defaultno=defaultno
 412                 extra_args="--colors --cr-wrap"
 413                 format="$msg_last_chance_are_you_sure_color"
 414         fi
 415
 416         local disk line_width
 417         for disk in $*; do
 418                 if [ "$line" ]; then
 419                         line_width=${#line}
 420                 else
 421                         line_width=$plen
 422                 fi
 423                 line_width=$(( $line_width + 1 + ${#disk} ))
 424                 # Add newline before disk if it would exceed max_width
 425                 if [ $line_width -gt $max_width ]; then
 426                         list="$list$line\n"
 427                         line="$prefix"
 428                         height=$(( $height + 1 ))
 429                 fi
 430                 # Add the disk to the list
 431                 line="$line $disk"
 432         done
 433         # Append the left-overs
 434         if [ "${line#$prefix}" ]; then
 435                 list="$list$line"
 436                 height=$(( $height + 1 ))
 437         fi
 438
 439         # Add height for Xdialog(1)
 440         [ "$USE_XDIALOG" ] && height=$(( $height + $height / 5 + 3 ))
 441
 442         prompt=$( printf "$format" "$list" )
 443         f_dprintf "%s: Last Chance!" "$0"
 444         $DIALOG \
 445                 --title "$title"        \
 446                 --backtitle "$btitle"   \
 447                 --hline "$hline"        \
 448                 --$defaultno            \
 449                 --$yes-label "$msg_yes" \
 450                 --$no-label "$msg_no"   \
 451                 $extra_args             \
 452                 --yesno "$prompt" $height $width
 453 }
 454
 455 # dialog_menu_layout
 456 #
 457 # Configure Virtual Device type and disks to use for the ZFS boot pool. User
 458 # must select enough disks to satisfy the chosen vdev type.
 459 #
 460 dialog_menu_layout()
 461 {
 462         local funcname=dialog_menu_layout
 463         local title="$DIALOG_TITLE"
 464         local btitle="$DIALOG_BACKTITLE"
 465         local vdev_prompt="$msg_select_virtual_device_type"
 466         local disk_prompt="$msg_please_select_one_or_more_disks"
 467         local vdev_menu_list="
 468                 'stripe' '$msg_stripe_desc' '$msg_stripe_help'
 469                 'mirror' '$msg_mirror_desc' '$msg_mirror_help'
 470                 'raidz1' '$msg_raidz1_desc' '$msg_raidz1_help'
 471                 'raidz2' '$msg_raidz2_desc' '$msg_raidz2_help'
 472                 'raidz3' '$msg_raidz3_desc' '$msg_raidz3_help'
 473         " # END-QUOTE
 474         local disk_check_list= # Calculated below
 475         local vdev_hline="$hline_arrows_tab_enter"
 476         local disk_hline="$hline_arrows_space_tab_enter"
 477
 478         # Warn the user if vdev type is not valid
 479         case "$ZFSBOOT_VDEV_TYPE" in
 480         stripe|mirror|raidz1|raidz2|raidz3) : known good ;;
 481         *)
 482                 f_dprintf "%s: Invalid virtual device type \`%s'" \
 483                           $funcname "$ZFSBOOT_VDEV_TYPE"
 484                 f_show_err "$msg_invalid_virtual_device_type" \
 485                            "$ZFSBOOT_VDEV_TYPE"
 486                 f_interactive || return $FAILURE
 487         esac
 488
 489         # Calculate size of vdev menu once only
 490         local vheight vwidth vrows
 491         eval f_dialog_menu_with_help_size vheight vwidth vrows \
 492                 \"\$title\" \"\$btitle\" \"\$vdev_prompt\" \"\$vdev_hline\" \
 493                 $vdev_menu_list
 494
 495         # Get a list of probed disk devices
 496         local disks=
 497         debug= f_device_find "" $DEVICE_TYPE_DISK disks
 498
 499         # Prune out mounted md(4) devices that may be part of the boot process
 500         local disk name new_list=
 501         for disk in $disks; do
 502                 debug= $disk get name name
 503                 case "$name" in
 504                 md[0-9]*) f_mounted -b "/dev/$name" && continue ;;
 505                 esac
 506                 new_list="$new_list $disk"
 507         done
 508         disks="${new_list# }"
 509
 510         # Debugging
 511         if [ "$debug" ]; then
 512                 local disk_names=
 513                 for disk in $disks; do
 514                         debug= $disk get name name
 515                         disk_names="$disk_names $name"
 516                 done
 517                 f_dprintf "$funcname: disks=[%s]" "${disk_names# }"
 518         fi
 519
 520         if [ ! "$disks" ]; then
 521                 f_dprintf "No disk(s) present to configure"
 522                 f_show_err "$msg_no_disks_present_to_configure"
 523                 return $FAILURE
 524         fi
 525
 526         # Lets sort the disks array to be more user friendly
 527         f_device_sort_by name disks disks
 528
 529         #
 530         # Operate in a loop so we can (if interactive) repeat if not enough
 531         # disks are selected to satisfy the chosen vdev type or user wants to
 532         # back-up to the previous menu.
 533         #
 534         local vardisk ndisks onoff selections vdev_choice breakout device
 535         local valid_disks all_valid want_disks desc height width rows
 536         while :; do
 537                 #
 538                 # Confirm the vdev type that was selected
 539                 #
 540                 if f_interactive && [ "$ZFSBOOT_CONFIRM_LAYOUT" ]; then
 541                         vdev_choice=$( eval $DIALOG \
 542                                 --title \"\$title\"              \
 543                                 --backtitle \"\$btitle\"         \
 544                                 --hline \"\$vdev_hline\"         \
 545                                 --ok-label \"\$msg_ok\"          \
 546                                 --cancel-label \"\$msg_cancel\"  \
 547                                 --item-help                      \
 548                                 --default-item \"\$ZFSBOOT_VDEV_TYPE\" \
 549                                 --menu \"\$vdev_prompt\"         \
 550                                 $vheight $vwidth $vrows          \
 551                                 $vdev_menu_list                  \
 552                                 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD
 553                         ) || return $?
 554                                 # Exit if user pressed ESC or chose Cancel/No
 555                         f_dialog_data_sanitize vdev_choice
 556
 557                         ZFSBOOT_VDEV_TYPE="$vdev_choice"
 558                         f_dprintf "$funcname: ZFSBOOT_VDEV_TYPE=[%s]" \
 559                                   "$ZFSBOOT_VDEV_TYPE"
 560                 fi
 561
 562                 # Determine the number of disks needed for this vdev type
 563                 want_disks=0
 564                 case "$ZFSBOOT_VDEV_TYPE" in
 565                 stripe) want_disks=1 ;;
 566                 mirror) want_disks=2 ;;
 567                 raidz1) want_disks=3 ;;
 568                 raidz2) want_disks=4 ;;
 569                 raidz3) want_disks=5 ;;
 570                 esac
 571
 572                 #
 573                 # Warn the user if any scripted disks are invalid
 574                 #
 575                 valid_disks= all_valid=${ZFSBOOT_DISKS:+1} # optimism
 576                 for disk in $ZFSBOOT_DISKS; do
 577                         if debug= f_device_find -1 \
 578                                 $disk $DEVICE_TYPE_DISK device
 579                         then
 580                                 valid_disks="$valid_disks $disk"
 581                                 continue
 582                         fi
 583                         f_dprintf "$funcname: \`%s' is not a real disk" "$disk"
 584                         all_valid=
 585                 done
 586                 if [ ! "$all_valid" ]; then
 587                         if [ "$ZFSBOOT_DISKS" ]; then
 588                                 f_show_err \
 589                                     "$msg_missing_one_or_more_scripted_disks"
 590                         else
 591                                 f_dprintf "No disks selected."
 592                                 f_interactive ||
 593                                         f_show_err "$msg_no_disks_selected"
 594                         fi
 595                         f_interactive || return $FAILURE
 596                 fi
 597                 ZFSBOOT_DISKS="${valid_disks# }"
 598
 599                 #
 600                 # Short-circuit if we're running non-interactively
 601                 #
 602                 if ! f_interactive || [ ! "$ZFSBOOT_CONFIRM_LAYOUT" ]; then
 603                         f_count ndisks $ZFSBOOT_DISKS
 604                         [ $ndisks -ge $want_disks ] && break # to success
 605
 606                         # Not enough disks selected
 607                         f_dprintf "$funcname: %s: %s (%u < %u minimum)" \
 608                                   "$ZFSBOOT_VDEV_TYPE" \
 609                                   "Not enough disks selected." \
 610                                   $ndisks $want_disks
 611                         f_interactive || return $FAILURE
 612                         msg_yes="$msg_change_selection" msg_no="$msg_cancel" \
 613                                 f_yesno "%s: $msg_not_enough_disks_selected" \
 614                                 "$ZFSBOOT_VDEV_TYPE" $ndisks $want_disks ||
 615                                 return $FAILURE
 616                 fi
 617
 618                 #
 619                 # Confirm the disks that were selected
 620                 # Loop until the user cancels or selects enough disks
 621                 #
 622                 breakout=
 623                 while :; do
 624                         # Loop over list of available disks, resetting state
 625                         for disk in $disks; do
 626                                 f_isset _${disk}_status && _${disk}_status=
 627                         done
 628
 629                         # Loop over list of selected disks and create temporary
 630                         # locals to map statuses onto up-to-date list of disks
 631                         for disk in $ZFSBOOT_DISKS; do
 632                                 debug= f_device_find -1 \
 633                                         $disk $DEVICE_TYPE_DISK disk
 634                                 f_isset _${disk}_status ||
 635                                         local _${disk}_status
 636                                 _${disk}_status=on
 637                         done
 638
 639                         # Create the checklist menu of discovered disk devices
 640                         disk_check_list=
 641                         for disk in $disks; do
 642                                 desc=
 643                                 $disk get name name
 644                                 $disk get desc desc
 645                                 f_shell_escape "$desc" desc
 646                                 f_getvar _${disk}_status:-off onoff
 647                                 disk_check_list="$disk_check_list
 648                                         $name '$desc' $onoff"
 649                         done
 650
 651                         eval f_dialog_checklist_size height width rows \
 652                                 \"\$title\" \"\$btitle\" \"\$prompt\" \
 653                                 \"\$hline\" $disk_check_list
 654
 655                         selections=$( eval $DIALOG \
 656                                 --title \"\$DIALOG_TITLE\"         \
 657                                 --backtitle \"\$DIALOG_BACKTITLE\" \
 658                                 --separate-output                  \
 659                                 --hline \"\$hline\"                \
 660                                 --ok-label \"\$msg_ok\"            \
 661                                 --cancel-label \"\$msg_back\"      \
 662                                 --checklist \"\$prompt\"           \
 663                                 $height $width $rows               \
 664                                 $disk_check_list                   \
 665                                 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD
 666                         ) || break
 667                                 # Loop if user pressed ESC or chose Cancel/No
 668                         f_dialog_data_sanitize selections
 669
 670                         ZFSBOOT_DISKS="$selections"
 671                         f_dprintf "$funcname: ZFSBOOT_DISKS=[%s]" \
 672                                   "$ZFSBOOT_DISKS"
 673
 674                         f_count ndisks $ZFSBOOT_DISKS
 675                         [ $ndisks -ge $want_disks ] &&
 676                                 breakout=break && break
 677
 678                         # Not enough disks selected
 679                         f_dprintf "$funcname: %s: %s (%u < %u minimum)" \
 680                                   "$ZFSBOOT_VDEV_TYPE" \
 681                                   "Not enough disks selected." \
 682                                   $ndisks $want_disks
 683                         msg_yes="$msg_change_selection" msg_no="$msg_cancel" \
 684                                 f_yesno "%s: $msg_not_enough_disks_selected" \
 685                                 "$ZFSBOOT_VDEV_TYPE" $ndisks $want_disks ||
 686                                 break
 687                 done
 688                 [ "$breakout" = "break" ] && break
 689                 [ "$ZFSBOOT_CONFIRM_LAYOUT" ] || return $FAILURE
 690         done
 691
 692         return $DIALOG_OK
 693 }
 694
 695 # dialog_uefi_prompt
 696 #
 697 # Confirm that the user wants to continue with the installation on a BIOS
 698 # system when they have booted with UEFI
 699 #
 700 dialog_uefi_prompt()
 701 {
 702         local title="$DIALOG_TITLE"
 703         local btitle="$DIALOG_BACKTITLE"
 704         local prompt # Calculated below
 705         local hline="$hline_arrows_tab_enter"
 706
 707         local height=8 width=50 prefix="   "
 708         local plen=${#prefix} list= line=
 709         local max_width=$(( $width - 3 - $plen ))
 710
 711         local yes no defaultno extra_args format
 712         if [ "$USE_XDIALOG" ]; then
 713                 yes=ok no=cancel defaultno=default-no
 714                 extra_args="--wrap --left"
 715                 format="$msg_uefi_not_supported"
 716         else
 717                 yes=yes no=no defaultno=defaultno
 718                 extra_args="--cr-wrap"
 719                 format="$msg_uefi_not_supported"
 720         fi
 721
 722         # Add height for Xdialog(1)
 723         [ "$USE_XDIALOG" ] && height=$(( $height + $height / 5 + 3 ))
 724
 725         prompt=$( printf "$format" )
 726         f_dprintf "%s: UEFI prompt" "$0"
 727         $DIALOG \
 728                 --title "$title"        \
 729                 --backtitle "$btitle"   \
 730                 --hline "$hline"        \
 731                 --$yes-label "$msg_yes" \
 732                 --$no-label "$msg_no"   \
 733                 $extra_args             \
 734                 --yesno "$prompt" $height $width
 735 }
 736
 737 # zfs_create_diskpart $disk $index
 738 #
 739 # For each block device to be used in the zpool, rather than just create the
 740 # zpool with the raw block devices (e.g., da0, da1, etc.) we create partitions
 741 # so we can have some real swap. This also provides wiggle room incase your
 742 # replacement drivers do not have the exact same sector counts.
 743 #
 744 # NOTE: $swapsize and $bootsize should be defined by the calling function.
 745 # NOTE: Sets $bootpart and $targetpart for the calling function.
 746 #
 747 zfs_create_diskpart()
 748 {
 749         local funcname=zfs_create_diskpart
 750         local disk="$1" index="$2"
 751
 752         # Check arguments
 753         if [ ! "$disk" ]; then
 754                 f_dprintf "$funcname: NULL disk argument"
 755                 msg_error="$msg_error: $funcname" \
 756                         f_show_err "$msg_null_disk_argument"
 757                 return $FAILURE
 758         fi
 759         if [ "${disk#*[$IFS]}" != "$disk" ]; then
 760                 f_dprintf "$funcname: Invalid disk argument \`%s'" "$disk"
 761                 msg_error="$msg_error: $funcname" \
 762                         f_show_err "$msg_invalid_disk_argument" "$disk"
 763                 return $FAILURE
 764         fi
 765         if [ ! "$index" ]; then
 766                 f_dprintf "$funcname: NULL index argument"
 767                 msg_error="$msg_error: $funcname" \
 768                         f_show_err "$msg_null_index_argument"
 769                 return $FAILURE
 770         fi
 771         if ! f_isinteger "$index"; then
 772                 f_dprintf "$funcname: Invalid index argument \`%s'" "$index"
 773                 msg_error="$msg_error: $funcname" \
 774                         f_show_err "$msg_invalid_index_argument" "$index"
 775                 return $FAILURE
 776         fi
 777         f_dprintf "$funcname: disk=[%s] index=[%s]" "$disk" "$index"
 778
 779         # Check for unknown partition scheme before proceeding further
 780         case "$ZFSBOOT_PARTITION_SCHEME" in
 781         ""|MBR|GPT) : known good ;;
 782         *)
 783                 f_dprintf "$funcname: %s is an unsupported partition scheme" \
 784                           "$ZFSBOOT_PARTITION_SCHEME"
 785                 msg_error="$msg_error: $funcname" f_show_err \
 786                         "$msg_unsupported_partition_scheme" \
 787                         "$ZFSBOOT_PARTITION_SCHEME"
 788                 return $FAILURE
 789         esac
 790
 791         #
 792         # Destroy whatever partition layout is currently on disk.
 793         # NOTE: `-F' required to destroy if partitions still exist.
 794         # NOTE: Failure is ok here, blank disk will have nothing to destroy.
 795         #
 796         f_dprintf "$funcname: Destroying all data/layouts on \`%s'..." "$disk"
 797         f_eval_catch -d $funcname gpart "$GPART_DESTROY_F" $disk
 798         f_eval_catch -d $funcname graid "$GRAID_DELETE" $disk
 799         f_eval_catch -d $funcname zpool "$ZPOOL_LABELCLEAR_F" /dev/$disk
 800
 801         # Make doubly-sure backup GPT is destroyed
 802         f_eval_catch -d $funcname gpart "$GPART_CREATE" gpt $disk
 803         f_eval_catch -d $funcname gpart "$GPART_DESTROY_F" $disk
 804
 805         #
 806         # Enable boot pool if encryption is desired
 807         #
 808         [ "$ZFSBOOT_GELI_ENCRYPTION" ] && ZFSBOOT_BOOT_POOL=1
 809
 810         #
 811         # Lay down the desired type of partition scheme
 812         #
 813         local setsize mbrindex
 814         case "$ZFSBOOT_PARTITION_SCHEME" in
 815         ""|GPT) f_dprintf "$funcname: Creating GPT layout..."
 816                 #
 817                 # 1. Create GPT layout using labels
 818                 #
 819                 f_eval_catch $funcname gpart "$GPART_CREATE" gpt $disk ||
 820                              return $FAILURE
 821
 822                 #
 823                 # 2. Add small freebsd-boot partition labeled `boot#'
 824                 #
 825                 f_eval_catch $funcname gpart "$GPART_ADD_LABEL_WITH_SIZE" \
 826                              gptboot$index freebsd-boot 512k $disk ||
 827                              return $FAILURE
 828                 f_eval_catch $funcname gpart "$GPART_BOOTCODE_PART" \
 829                              /boot/pmbr /boot/gptzfsboot 1 $disk ||
 830                              return $FAILURE
 831
 832                 # NB: zpool will use the `zfs#' GPT labels
 833                 bootpart=p2 swappart=p2 targetpart=p2
 834                 [ ${swapsize:-0} -gt 0 ] && targetpart=p3
 835
 836                 #
 837                 # Prepare boot pool if enabled (e.g., for geli(8))
 838                 #
 839                 if [ "$ZFSBOOT_BOOT_POOL" ]; then
 840                         bootpart=p2 swappart=p3 targetpart=p3
 841                         [ ${swapsize:-0} -gt 0 ] && targetpart=p4
 842                         f_eval_catch $funcname gpart \
 843                                      "$GPART_ADD_LABEL_WITH_SIZE" boot$index \
 844                                      freebsd-zfs ${bootsize}b $disk ||
 845                                      return $FAILURE
 846                         # Pedantically nuke any old labels
 847                         f_eval_catch -d $funcname zpool "$ZPOOL_LABELCLEAR_F" \
 848                                         /dev/$disk$bootpart
 849                         if [ "$ZFSBOOT_GELI_ENCRYPTION" ]; then
 850                                 # Pedantically detach targetpart for later
 851                                 f_eval_catch -d $funcname geli \
 852                                                 "$GELI_DETACH_F" \
 853                                                 /dev/$disk$targetpart
 854                         fi
 855                 fi
 856
 857                 #
 858                 # 3. Add freebsd-swap partition labeled `swap#'
 859                 #
 860                 if [ ${swapsize:-0} -gt 0 ]; then
 861                         f_eval_catch $funcname gpart \
 862                                      "$GPART_ADD_LABEL_WITH_SIZE" swap$index \
 863                                      freebsd-swap ${swapsize}b $disk ||
 864                                      return $FAILURE
 865                         # Pedantically nuke any old labels on the swap
 866                         f_eval_catch -d $funcname zpool "$ZPOOL_LABELCLEAR_F" \
 867                                         /dev/$disk$swappart
 868                 fi
 869
 870                 #
 871                 # 4. Add freebsd-zfs partition labeled `zfs#' for zroot
 872                 #
 873                 f_eval_catch $funcname gpart "$GPART_ADD_LABEL" \
 874                              zfs$index freebsd-zfs $disk || return $FAILURE
 875                 f_eval_catch -d $funcname zpool "$ZPOOL_LABELCLEAR_F" \
 876                                 /dev/$disk$targetpart
 877                 ;;
 878
 879         MBR) f_dprintf "$funcname: Creating MBR layout..."
 880                 #
 881                 # 1. Create MBR layout (no labels)
 882                 #
 883                 f_eval_catch $funcname gpart "$GPART_CREATE" mbr $disk ||
 884                              return $FAILURE
 885                 f_eval_catch $funcname gpart "$GPART_BOOTCODE" /boot/mbr \
 886                              $disk || return $FAILURE
 887
 888                 #
 889                 # 2. Add freebsd slice with all available space
 890                 #
 891                 f_eval_catch $funcname gpart "$GPART_ADD" freebsd $disk ||
 892                              return $FAILURE
 893                 f_eval_catch $funcname gpart "$GPART_SET_ACTIVE" 1 $disk ||
 894                              return $FAILURE
 895                 # Pedantically nuke any old labels
 896                 f_eval_catch -d $funcname zpool "$ZPOOL_LABELCLEAR_F" \
 897                                 /dev/${disk}s1
 898                 # Pedantically nuke any old scheme
 899                 f_eval_catch -d $funcname gpart "$GPART_DESTROY_F" ${disk}s1
 900
 901                 #
 902                 # 3. Write BSD scheme to the freebsd slice
 903                 #
 904                 f_eval_catch $funcname gpart "$GPART_CREATE" BSD ${disk}s1 ||
 905                              return $FAILURE
 906
 907                 # NB: zpool will use s1a (no labels)
 908                 bootpart=s1a swappart=s1b targetpart=s1d mbrindex=4
 909
 910                 #
 911                 # Always prepare a boot pool on MBR
 912                 #
 913                 ZFSBOOT_BOOT_POOL=1
 914                 f_eval_catch $funcname gpart \
 915                              "$GPART_ADD_INDEX_WITH_SIZE" \
 916                              1 freebsd-zfs ${bootsize}b ${disk}s1 ||
 917                              return $FAILURE
 918                 # Pedantically nuke any old labels
 919                 f_eval_catch -d $funcname zpool "$ZPOOL_LABELCLEAR_F" \
 920                                 /dev/$disk$bootpart
 921                 if [ "$ZFSBOOT_GELI_ENCRYPTION" ]; then
 922                         # Pedantically detach targetpart for later
 923                         f_eval_catch -d $funcname geli \
 924                                         "$GELI_DETACH_F" \
 925                                         /dev/$disk$targetpart
 926                 fi
 927
 928                 #
 929                 # 4. Add freebsd-swap partition
 930                 #
 931                 if [ ${swapsize:-0} -gt 0 ]; then
 932                         f_eval_catch $funcname gpart \
 933                                      "$GPART_ADD_INDEX_WITH_SIZE" 2 \
 934                                      freebsd-swap ${swapsize}b ${disk}s1 ||
 935                                      return $FAILURE
 936                         # Pedantically nuke any old labels on the swap
 937                         f_eval_catch -d $funcname zpool "$ZPOOL_LABELCLEAR_F" \
 938                                         /dev/${disk}s1b
 939                 fi
 940
 941                 #
 942                 # 5. Add freebsd-zfs partition for zroot
 943                 #
 944                 f_eval_catch $funcname gpart "$GPART_ADD_INDEX" \
 945                              $mbrindex freebsd-zfs ${disk}s1 || return $FAILURE
 946                 f_eval_catch -d $funcname zpool "$ZPOOL_LABELCLEAR_F" \
 947                                 /dev/$disk$targetpart # Pedantic
 948                 f_eval_catch $funcname dd "$DD_WITH_OPTIONS" \
 949                              /boot/zfsboot /dev/${disk}s1 count=1 ||
 950                              return $FAILURE
 951                 ;;
 952
 953         esac # $ZFSBOOT_PARTITION_SCHEME
 954
 955         # Update fstab(5)
 956         local swapsize
 957         f_expand_number "$ZFSBOOT_SWAP_SIZE" swapsize
 958         if [ "$isswapmirror" ]; then
 959                 # This is not the first disk in the mirror, do nothing
 960         elif [ "$ZFSBOOT_SWAP_ENCRYPTION" -a "$ZFSBOOT_SWAP_MIRROR" ]; then
 961                 f_eval_catch $funcname printf "$PRINTF_FSTAB" \
 962                              /dev/mirror/swap.eli none swap sw 0 0 \
 963                              $BSDINSTALL_TMPETC/fstab ||
 964                              return $FAILURE
 965                 isswapmirror=1
 966         elif [ "$ZFSBOOT_SWAP_MIRROR" ]; then
 967                 f_eval_catch $funcname printf "$PRINTF_FSTAB" \
 968                              /dev/mirror/swap none swap sw 0 0 \
 969                              $BSDINSTALL_TMPETC/fstab ||
 970                              return $FAILURE
 971                 isswapmirror=1
 972         elif [ "$ZFSBOOT_SWAP_ENCRYPTION" ]; then
 973                 f_eval_catch $funcname printf "$PRINTF_FSTAB" \
 974                              /dev/$disk${swappart}.eli none swap sw 0 0 \
 975                              $BSDINSTALL_TMPETC/fstab ||
 976                              return $FAILURE
 977         elif [ ${swapsize:-0} -eq 0 ]; then
 978                 # If swap is 0 sized, don't add it to fstab
 979         else
 980                 f_eval_catch $funcname printf "$PRINTF_FSTAB" \
 981                              /dev/$disk$swappart none swap sw 0 0 \
 982                              $BSDINSTALL_TMPETC/fstab ||
 983                              return $FAILURE
 984         fi
 985
 986         return $SUCCESS
 987 }
 988
 989 # zfs_create_boot $poolname $vdev_type $disks ...
 990 #
 991 # Creates boot pool and dataset layout. Returns error if something goes wrong.
 992 # Errors are printed to stderr for collection and display.
 993 #
 994 zfs_create_boot()
 995 {
 996         local funcname=zfs_create_boot
 997         local zroot_name="$1"
 998         local zroot_vdevtype="$2"
 999         local zroot_vdevs= # Calculated below
1000         local swap_devs= # Calculated below
1001         local boot_vdevs= # Used for geli(8) and/or MBR layouts
1002         shift 2 # poolname vdev_type
1003         local disks="$*" disk
1004         local isswapmirror
1005         local bootpart targetpart swappart # Set by zfs_create_diskpart() below
1006         local create_options
1007
1008         #
1009         # Pedantic checks; should never be seen
1010         #
1011         if [ ! "$zroot_name" ]; then
1012                 f_dprintf "$funcname: NULL poolname"
1013                 msg_error="$msg_error: $funcname" \
1014                         f_show_err "$msg_null_poolname"
1015                 return $FAILURE
1016         fi
1017         if [ $# -lt 1 ]; then
1018                 f_dprintf "$funcname: missing disk arguments"
1019                 msg_error="$msg_error: $funcname" \
1020                         f_show_err "$msg_missing_disk_arguments"
1021                 return $FAILURE
1022         fi
1023         f_dprintf "$funcname: poolname=[%s] vdev_type=[%s]" \
1024                   "$zroot_name" "$zroot_vdevtype"
1025
1026         #
1027         # Initialize fstab(5)
1028         #
1029         f_dprintf "$funcname: Initializing temporary fstab(5) file..."
1030         f_eval_catch $funcname sh "$SHELL_TRUNCATE" $BSDINSTALL_TMPETC/fstab ||
1031                      return $FAILURE
1032         f_eval_catch $funcname printf "$PRINTF_FSTAB" \
1033                      "# Device" Mountpoint FStype Options Dump "Pass#" \
1034                      $BSDINSTALL_TMPETC/fstab || return $FAILURE
1035
1036         #
1037         # Expand SI units in desired sizes
1038         #
1039         f_dprintf "$funcname: Expanding supplied size values..."
1040         local swapsize bootsize
1041         if ! f_expand_number "$ZFSBOOT_SWAP_SIZE" swapsize; then
1042                 f_dprintf "$funcname: Invalid swap size \`%s'" \
1043                           "$ZFSBOOT_SWAP_SIZE"
1044                 f_show_err "$msg_invalid_swap_size" "$ZFSBOOT_SWAP_SIZE"
1045                 return $FAILURE
1046         fi
1047         if ! f_expand_number "$ZFSBOOT_BOOT_POOL_SIZE" bootsize; then
1048                 f_dprintf "$funcname: Invalid boot pool size \`%s'" \
1049                           "$ZFSBOOT_BOOT_POOL_SIZE"
1050                 f_show_err "$msg_invalid_boot_pool_size" \
1051                            "$ZFSBOOT_BOOT_POOL_SIZE"
1052                 return $FAILURE
1053         fi
1054         f_dprintf "$funcname: ZFSBOOT_SWAP_SIZE=[%s] swapsize=[%s]" \
1055                   "$ZFSBOOT_SWAP_SIZE" "$swapsize"
1056         f_dprintf "$funcname: ZFSBOOT_BOOT_POOL_SIZE=[%s] bootsize=[%s]" \
1057                   "$ZFSBOOT_BOOT_POOL_SIZE" "$bootsize"
1058
1059         #
1060         # Destroy the pool in-case this is our second time 'round (case of
1061         # failure and installer presented ``Retry'' option to come back).
1062         #
1063         # NB: If we don't destroy the pool, later gpart(8) destroy commands
1064         # that try to clear existing partitions (see zfs_create_diskpart())
1065         # will fail with a `Device Busy' error, leading to `GEOM exists'.
1066         #
1067         f_eval_catch -d $funcname zpool "$ZPOOL_DESTROY" "$zroot_name"
1068
1069         #
1070         # Prepare the disks and build pool device list(s)
1071         #
1072         f_dprintf "$funcname: Preparing disk partitions for ZFS pool..."
1073
1074         # Force 4K sectors using vfs.zfs.min_auto_ashift=12
1075         if [ "$ZFSBOOT_FORCE_4K_SECTORS" ]; then
1076                 f_dprintf "$funcname: With 4K sectors..."
1077                 f_eval_catch $funcname sysctl "$SYSCTL_ZFS_MIN_ASHIFT_12" \
1078                     || return $FAILURE
1079         fi
1080         local n=0
1081         for disk in $disks; do
1082                 zfs_create_diskpart $disk $n || return $FAILURE
1083                 # Now $bootpart, $targetpart, and $swappart are set (suffix
1084                 # for $disk)
1085                 if [ "$ZFSBOOT_BOOT_POOL" ]; then
1086                         boot_vdevs="$boot_vdevs $disk$bootpart"
1087                 fi
1088                 zroot_vdevs="$zroot_vdevs $disk$targetpart"
1089                 if [ "$ZFSBOOT_GELI_ENCRYPTION" ]; then
1090                         zroot_vdevs="$zroot_vdevs.eli"
1091                 fi
1092
1093                 n=$(( $n + 1 ))
1094         done # disks
1095
1096         #
1097         # If we need/want a boot pool, create it
1098         #
1099         if [ "$ZFSBOOT_BOOT_POOL" ]; then
1100                 local bootpool_vdevtype= # Calculated below
1101                 local bootpool_options= # Calculated below
1102                 local bootpool_name="$ZFSBOOT_BOOT_POOL_NAME"
1103                 local bootpool="$BSDINSTALL_CHROOT/$bootpool_name"
1104                 local zroot_key="${ZFSBOOT_GELI_KEY_FILE#/}"
1105
1106                 f_dprintf "$funcname: Setting up boot pool..."
1107                 [ "$ZFSBOOT_GELI_ENCRYPTION" ] &&
1108                         f_dprintf "$funcname: For encrypted root disk..."
1109
1110                 # Create parent directory for boot pool
1111                 f_eval_catch -d $funcname umount "$UMOUNT" /mnt
1112                 f_eval_catch $funcname mount "$MOUNT_TYPE" tmpfs none \
1113                              $BSDINSTALL_CHROOT || return $FAILURE
1114
1115                 # Create mirror across the boot partition on all disks
1116                 local nvdevs
1117                 f_count nvdevs $boot_vdevs
1118                 [ $nvdevs -gt 1 ] && bootpool_vdevtype=mirror
1119
1120                 create_options="$ZFSBOOT_BOOT_POOL_CREATE_OPTIONS"
1121                 bootpool_options="-o altroot=$BSDINSTALL_CHROOT"
1122                 bootpool_options="$bootpool_options $create_options"
1123                 bootpool_options="$bootpool_options -m \"/$bootpool_name\" -f"
1124                 f_eval_catch $funcname zpool "$ZPOOL_CREATE_WITH_OPTIONS" \
1125                              "$bootpool_options" "$bootpool_name" \
1126                              "$bootpool_vdevtype" "$boot_vdevs" ||
1127                              return $FAILURE
1128
1129                 f_eval_catch $funcname mkdir "$MKDIR_P" "$bootpool/boot" ||
1130                              return $FAILURE
1131
1132                 if [ "$ZFSBOOT_GELI_ENCRYPTION" ]; then
1133                         # Generate an encryption key using random(4)
1134                         f_eval_catch $funcname dd "$DD_WITH_OPTIONS" \
1135                                      /dev/random "$bootpool/$zroot_key" \
1136                                      "bs=4096 count=1" || return $FAILURE
1137                         f_eval_catch $funcname chmod "$CHMOD_MODE" \
1138                                      go-wrx "$bootpool/$zroot_key" ||
1139                                      return $FAILURE
1140                 else
1141                         # Clean up
1142                         f_eval_catch $funcname zfs "$ZFS_UNMOUNT" \
1143                                      "$bootpool_name" || return $FAILURE
1144                         f_eval_catch -d $funcname umount "$UMOUNT" /mnt # tmpfs
1145                 fi
1146
1147         fi
1148
1149         #
1150         # Create the geli(8) GEOMS
1151         #
1152         if [ "$ZFSBOOT_GELI_ENCRYPTION" ]; then
1153                 # Prompt user for password (twice)
1154                 if ! msg_enter_new_password="$msg_geli_password" \
1155                         f_dialog_input_password
1156                 then
1157                         f_dprintf "$funcname: User cancelled"
1158                         f_show_err "$msg_user_cancelled"
1159                         return $FAILURE
1160                 fi
1161
1162                 # Initialize geli(8) on each of the target partitions
1163                 for disk in $disks; do
1164                         f_dialog_info "$msg_geli_setup" \
1165                                 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD
1166                         if ! echo "$pw_password" | f_eval_catch \
1167                                 $funcname geli "$GELI_PASSWORD_INIT" \
1168                                 "$bootpool/boot/$disk$targetpart.eli" \
1169                                 AES-XTS "$bootpool/$zroot_key" \
1170                                 $disk$targetpart
1171                         then
1172                                 f_interactive || f_die
1173                                 unset pw_password # Sensitive info
1174                                 return $FAILURE
1175                         fi
1176                         if ! echo "$pw_password" | f_eval_catch \
1177                                 $funcname geli "$GELI_ATTACH" \
1178                                 "$bootpool/$zroot_key" $disk$targetpart
1179                         then
1180                                 f_interactive || f_die
1181                                 unset pw_password # Sensitive info
1182                                 return $FAILURE
1183                         fi
1184                 done
1185                 unset pw_password # Sensitive info
1186
1187                 # Clean up
1188                 f_eval_catch $funcname zfs "$ZFS_UNMOUNT" "$bootpool_name" ||
1189                         return $FAILURE
1190                 f_eval_catch -d $funcname umount "$UMOUNT" /mnt # tmpfs
1191         fi
1192
1193         #
1194         # Create the gmirror(8) GEOMS for swap
1195         #
1196         if [ "$ZFSBOOT_SWAP_MIRROR" ]; then
1197                 for disk in $disks; do
1198                         swap_devs="$swap_devs $disk$swappart"
1199                 done
1200                 f_eval_catch $funcname gmirror "$SWAP_GMIRROR_LABEL" \
1201                         "$swap_devs" || return $FAILURE
1202         fi
1203
1204         #
1205         # Create the ZFS root pool with desired type and disk devices
1206         #
1207         f_dprintf "$funcname: Creating root pool..."
1208         create_options="$ZFSBOOT_POOL_CREATE_OPTIONS"
1209         f_eval_catch $funcname zpool "$ZPOOL_CREATE_WITH_OPTIONS" \
1210                 "-o altroot=$BSDINSTALL_CHROOT $create_options -m none -f" \
1211                 "$zroot_name" "$zroot_vdevtype" "$zroot_vdevs" ||
1212                 return $FAILURE
1213
1214         #
1215         # Create ZFS dataset layout within the new root pool
1216         #
1217         f_dprintf "$funcname: Creating ZFS datasets..."
1218         echo "$ZFSBOOT_DATASETS" | while read dataset options; do
1219                 # Skip blank lines and comments
1220                 case "$dataset" in "#"*|"") continue; esac
1221                 # Remove potential inline comments in options
1222                 options="${options%%#*}"
1223                 # Replace tabs with spaces
1224                 f_replaceall "$options" "       " " " options
1225                 # Reduce contiguous runs of space to one single space
1226                 oldoptions=
1227                 while [ "$oldoptions" != "$options" ]; do
1228                         oldoptions="$options"
1229                         f_replaceall "$options" "  " " " options
1230                 done
1231                 # Replace both commas and spaces with ` -o '
1232                 f_replaceall "$options" "[ ,]" " -o " options
1233                 # Create the dataset with desired options
1234                 f_eval_catch $funcname zfs "$ZFS_CREATE_WITH_OPTIONS" \
1235                              "${options:+-o $options}" "$zroot_name$dataset" ||
1236                              return $FAILURE
1237         done
1238
1239         # Touch up permissions on the tmp directories
1240         f_dprintf "$funcname: Modifying directory permissions..."
1241         local dir
1242         for dir in /tmp /var/tmp; do
1243                 f_eval_catch $funcname chmod "$CHMOD_MODE" 1777 \
1244                              $BSDINSTALL_CHROOTDIR$dir || return $FAILURE
1245         done
1246
1247         # Create symlink(s)
1248         if [ "$ZFSBOOT_BOOT_POOL" ]; then
1249                 f_dprintf "$funcname: Creating /boot symlink for boot pool..."
1250                 f_eval_catch $funcname ln "$LN_SF" "$bootpool_name/boot" \
1251                              $BSDINSTALL_CHROOT/boot || return $FAILURE
1252         fi
1253
1254         # Set bootfs property
1255         local zroot_bootfs="$ZFSBOOT_BEROOT_NAME/$ZFSBOOT_BOOTFS_NAME"
1256         f_dprintf "$funcname: Setting bootfs property..."
1257         f_eval_catch $funcname zpool "$ZPOOL_SET" \
1258                 "bootfs=\"$zroot_name/$zroot_bootfs\"" "$zroot_name" ||
1259                 return $FAILURE
1260
1261         # Export the pool(s)
1262         f_dprintf "$funcname: Temporarily exporting ZFS pool(s)..."
1263         f_eval_catch $funcname zpool "$ZPOOL_EXPORT" "$zroot_name" ||
1264                      return $FAILURE
1265         if [ "$ZFSBOOT_BOOT_POOL" ]; then
1266                 f_eval_catch $funcname zpool "$ZPOOL_EXPORT" \
1267                              "$bootpool_name" || return $FAILURE
1268         fi
1269
1270         # MBR boot loader touch-up
1271         if [ "$ZFSBOOT_PARTITION_SCHEME" = "MBR" ]; then
1272                 f_dprintf "$funcname: Updating MBR boot loader on disks..."
1273                 # Stick the ZFS boot loader in the "convienient hole" after
1274                 # the ZFS internal metadata
1275                 for disk in $disks; do
1276                         f_eval_catch $funcname dd "$DD_WITH_OPTIONS" \
1277                                      /boot/zfsboot /dev/$disk$bootpart \
1278                                      "skip=1 seek=1024" || return $FAILURE
1279                 done
1280         fi
1281
1282         # Re-import the ZFS pool(s)
1283         f_dprintf "$funcname: Re-importing ZFS pool(s)..."
1284         f_eval_catch $funcname zpool "$ZPOOL_IMPORT_WITH_OPTIONS" \
1285                      "-o altroot=\"$BSDINSTALL_CHROOT\"" "$zroot_name" ||
1286                      return $FAILURE
1287         if [ "$ZFSBOOT_BOOT_POOL" ]; then
1288                 f_eval_catch $funcname zpool "$ZPOOL_IMPORT_WITH_OPTIONS" \
1289                              "-o altroot=\"$BSDINSTALL_CHROOT\"" \
1290                              "$bootpool_name" || return $FAILURE
1291         fi
1292
1293         # While this is apparently not needed, it seems to help MBR
1294         f_dprintf "$funcname: Configuring zpool.cache for zroot..."
1295         f_eval_catch $funcname mkdir "$MKDIR_P" $BSDINSTALL_CHROOT/boot/zfs ||
1296                      return $FAILURE
1297         f_eval_catch $funcname zpool "$ZPOOL_SET" \
1298                      "cachefile=\"$BSDINSTALL_CHROOT/boot/zfs/zpool.cache\"" \
1299                      "$zroot_name" || return $FAILURE
1300
1301         # Last, but not least... required lines for rc.conf(5)/loader.conf(5)
1302         # NOTE: We later concatenate these into their destination
1303         f_dprintf "%s: Configuring rc.conf(5)/loader.conf(5) additions..." \
1304                   "$funcname"
1305         f_eval_catch $funcname echo "$ECHO_APPEND" 'zfs_enable=\"YES\"' \
1306                      $BSDINSTALL_TMPETC/rc.conf.zfs || return $FAILURE
1307         f_eval_catch $funcname echo "$ECHO_APPEND" \
1308                      'kern.geom.label.gptid.enable=\"0\"' \
1309                      $BSDINSTALL_TMPBOOT/loader.conf.zfs || return $FAILURE
1310
1311         if [ "$ZFSBOOT_SWAP_MIRROR" ]; then
1312                 f_eval_catch $funcname echo "$ECHO_APPEND" \
1313                              'geom_mirror_load=\"YES\"' \
1314                              $BSDINSTALL_TMPBOOT/loader.conf.gmirror ||
1315                              return $FAILURE
1316         fi
1317
1318         # We're all done unless we should go on for boot pool
1319         [ "$ZFSBOOT_BOOT_POOL" ] || return $SUCCESS
1320
1321         # Set cachefile for boot pool so it auto-imports at system start
1322         f_dprintf "$funcname: Configuring zpool.cache for boot pool..."
1323         f_eval_catch $funcname zpool "$ZPOOL_SET" \
1324                      "cachefile=\"$BSDINSTALL_CHROOT/boot/zfs/zpool.cache\"" \
1325                      "$bootpool_name" || return $FAILURE
1326
1327         # Some additional geli(8) requirements for loader.conf(5)
1328         for option in \
1329                 'zpool_cache_load=\"YES\"' \
1330                 'zpool_cache_type=\"/boot/zfs/zpool.cache\"' \
1331                 'zpool_cache_name=\"/boot/zfs/zpool.cache\"' \
1332         ; do
1333                 f_eval_catch $funcname echo "$ECHO_APPEND" "$option" \
1334                              $BSDINSTALL_TMPBOOT/loader.conf.zfs ||
1335                              return $FAILURE
1336         done
1337         f_eval_catch $funcname printf "$PRINTF_CONF" vfs.root.mountfrom \
1338                 "\"zfs:$zroot_name/$zroot_bootfs\"" \
1339                 $BSDINSTALL_TMPBOOT/loader.conf.root || return $FAILURE
1340
1341         # We're all done unless we should go on to do encryption
1342         [ "$ZFSBOOT_GELI_ENCRYPTION" ] || return $SUCCESS
1343
1344         #
1345         # Configure geli(8)-based encryption
1346         #
1347         f_dprintf "$funcname: Configuring disk encryption..."
1348         f_eval_catch $funcname echo "$ECHO_APPEND" 'aesni_load=\"YES\"' \
1349                 $BSDINSTALL_TMPBOOT/loader.conf.aesni || return $FAILURE
1350         f_eval_catch $funcname echo "$ECHO_APPEND" 'geom_eli_load=\"YES\"' \
1351                 $BSDINSTALL_TMPBOOT/loader.conf.geli || return $FAILURE
1352         f_eval_catch $funcname echo "$ECHO_APPEND" \
1353                 'geom_eli_passphrase_prompt=\"YES\"' \
1354                 $BSDINSTALL_TMPBOOT/loader.conf.geli || return $FAILURE
1355         for disk in $disks; do
1356                 f_eval_catch $funcname printf "$PRINTF_CONF" \
1357                         geli_%s_keyfile0_load "$disk$targetpart YES" \
1358                         $BSDINSTALL_TMPBOOT/loader.conf.$disk$targetpart ||
1359                         return $FAILURE
1360                 f_eval_catch $funcname printf "$PRINTF_CONF" \
1361                         geli_%s_keyfile0_type \
1362                         "$disk$targetpart $disk$targetpart:geli_keyfile0" \
1363                         $BSDINSTALL_TMPBOOT/loader.conf.$disk$targetpart ||
1364                         return $FAILURE
1365                 f_eval_catch $funcname printf "$PRINTF_CONF" \
1366                         geli_%s_keyfile0_name \
1367                         "$disk$targetpart \"$ZFSBOOT_GELI_KEY_FILE\"" \
1368                         $BSDINSTALL_TMPBOOT/loader.conf.$disk$targetpart ||
1369                         return $FAILURE
1370         done
1371
1372         return $SUCCESS
1373 }
1374
1375 # dialog_menu_diskinfo
1376 #
1377 # Prompt the user to select a disk and then provide detailed info on it.
1378 #
1379 dialog_menu_diskinfo()
1380 {
1381         local device disk
1382
1383         #
1384         # Break from loop when user cancels disk selection
1385         #
1386         while :; do
1387                 device=$( msg_cancel="$msg_back" f_device_menu \
1388                         "$DIALOG_TITLE" "$msg_select_a_disk_device" "" \
1389                         $DEVICE_TYPE_DISK 2>&1 ) || break
1390                 $device get name disk
1391
1392                 # Show gpart(8) `show' and camcontrol(8) `inquiry' data
1393                 f_show_msg "$msg_detailed_disk_info" \
1394                         "$disk" "$( gpart show $disk 2> /dev/null )" \
1395                         "$disk" "$( camcontrol inquiry $disk 2> /dev/null )" \
1396                         "$disk" "$( camcontrol identify $disk 2> /dev/null )"
1397         done
1398
1399         return $SUCCESS
1400 }
1401
1402 ############################################################ MAIN
1403
1404 #
1405 # Initialize
1406 #
1407 f_dialog_title "$msg_zfs_configuration"
1408 f_dialog_backtitle "$msg_freebsd_installer"
1409
1410 # User may have specifically requested ZFS-related operations be interactive
1411 ! f_interactive && f_zfsinteractive && unset $VAR_NONINTERACTIVE
1412
1413 #
1414 # Debugging
1415 #
1416 f_dprintf "BSDINSTALL_CHROOT=[%s]" "$BSDINSTALL_CHROOT"
1417 f_dprintf "BSDINSTALL_TMPETC=[%s]" "$BSDINSTALL_TMPETC"
1418 f_dprintf "FSTAB_FMT=[%s]" "$FSTAB_FMT"
1419
1420 #
1421 # If the system was booted with UEFI, warn the user that FreeBSD can't do
1422 # ZFS with UEFI yet
1423 #
1424 if f_interactive; then
1425         bootmethod=$( sysctl -n machdep.bootmethod )
1426         f_dprintf "machdep.bootmethod=[%s]" "$bootmethod"
1427         if [ "$bootmethod" != "BIOS" ]; then
1428                 dialog_uefi_prompt
1429                 retval=$?
1430                 f_dprintf "uefi_prompt=[%s]" "$retval"
1431                 [ $retval -eq $DIALOG_OK ] || f_die
1432         fi
1433 fi
1434
1435 #
1436 # Loop over the main menu until we've accomplished what we came here to do
1437 #
1438 while :; do
1439         if ! f_interactive; then
1440                 retval=$DIALOG_OK
1441                 mtag=">>> $msg_install"
1442         else
1443                 dialog_menu_main
1444                 retval=$?
1445                 f_dialog_menutag_fetch mtag
1446         fi
1447
1448         f_dprintf "retval=%u mtag=[%s]" $retval "$mtag"
1449         [ $retval -eq $DIALOG_OK ] || f_die
1450
1451         case "$mtag" in
1452         ">>> $msg_install")
1453                 #
1454                 # First, validate the user's selections
1455                 #
1456
1457                 # Make sure they gave us a name for the pool
1458                 if [ ! "$ZFSBOOT_POOL_NAME" ]; then
1459                         f_dprintf "Pool name cannot be empty."
1460                         f_show_err "$msg_pool_name_cannot_be_empty"
1461                         continue
1462                 fi
1463
1464                 # Validate vdev type against number of disks selected/scripted
1465                 # (also validates that ZFSBOOT_DISKS are real [probed] disks)
1466                 # NB: dialog_menu_layout supports running non-interactively
1467                 dialog_menu_layout || continue
1468
1469                 # Make sure each disk will be at least 50% ZFS
1470                 if f_expand_number "$ZFSBOOT_SWAP_SIZE" swapsize &&
1471                    f_expand_number "$ZFSBOOT_BOOT_POOL_SIZE" bootsize
1472                 then
1473                         minsize=$swapsize teeny_disks=
1474                         [ "$ZFSBOOT_BOOT_POOL" ] &&
1475                                 minsize=$(( $minsize + $bootsize ))
1476                         for disk in $ZFSBOOT_DISKS; do
1477                                 debug= f_device_find -1 \
1478                                         $disk $DEVICE_TYPE_DISK device
1479                                 $device get capacity disksize || continue
1480                                 [ ${disksize:-0} -ge 0 ] || disksize=0
1481                                 disksize=$(( $disksize - $minsize ))
1482                                 [ $disksize -lt $minsize ] &&
1483                                         teeny_disks="$teeny_disks $disk"
1484                         done
1485                         if [ "$teeny_disks" ]; then
1486                                 f_dprintf "swapsize=[%s] bootsize[%s] %s" \
1487                                           "$ZFSBOOT_SWAP_SIZE" \
1488                                           "$ZFSBOOT_BOOT_POOL_SIZE" \
1489                                           "minsize=[$minsize]"
1490                                 f_dprintf "These disks are too small: %s" \
1491                                           "$teeny_disks"
1492                                 f_show_err "$msg_these_disks_are_too_small" \
1493                                            "$ZFSBOOT_SWAP_SIZE" \
1494                                            "$ZFSBOOT_BOOT_POOL_SIZE" \
1495                                            "$teeny_disks"
1496                                 continue
1497                         fi
1498                 fi
1499
1500                 #
1501                 # Last Chance!
1502                 #
1503                 if f_interactive; then
1504                         dialog_last_chance $ZFSBOOT_DISKS || continue
1505                 fi
1506
1507                 #
1508                 # Let's do this
1509                 #
1510
1511                 vdev_type="$ZFSBOOT_VDEV_TYPE"
1512
1513                 # Blank the vdev type for the default layout
1514                 [ "$vdev_type" = "stripe" ] && vdev_type=
1515
1516                 zfs_create_boot "$ZFSBOOT_POOL_NAME" \
1517                                 "$vdev_type" $ZFSBOOT_DISKS || continue
1518
1519                 break # to success
1520                 ;;
1521         ?" $msg_pool_type_disks")
1522                 ZFSBOOT_CONFIRM_LAYOUT=1
1523                 dialog_menu_layout
1524                 # User has poked settings, disable later confirmation
1525                 ZFSBOOT_CONFIRM_LAYOUT=
1526                 ;;
1527         "- $msg_rescan_devices") f_device_rescan ;;
1528         "- $msg_disk_info") dialog_menu_diskinfo ;;
1529         ?" $msg_pool_name")
1530                 # Prompt the user to input/change the name for the new pool
1531                 f_dialog_input input \
1532                         "$msg_please_enter_a_name_for_your_zpool" \
1533                         "$ZFSBOOT_POOL_NAME" &&
1534                         ZFSBOOT_POOL_NAME="$input"
1535                 ;;
1536         ?" $msg_force_4k_sectors")
1537                 # Toggle the variable referenced both by the menu and later
1538                 if [ "$ZFSBOOT_FORCE_4K_SECTORS" ]; then
1539                         ZFSBOOT_FORCE_4K_SECTORS=
1540                 else
1541                         ZFSBOOT_FORCE_4K_SECTORS=1
1542                 fi
1543                 ;;
1544         ?" $msg_encrypt_disks")
1545                 # Toggle the variable referenced both by the menu and later
1546                 if [ "$ZFSBOOT_GELI_ENCRYPTION" ]; then
1547                         ZFSBOOT_GELI_ENCRYPTION=
1548                 else
1549                         ZFSBOOT_FORCE_4K_SECTORS=1
1550                         ZFSBOOT_GELI_ENCRYPTION=1
1551                 fi
1552                 ;;
1553         ?" $msg_partition_scheme")
1554                 # Toggle between GPT and MBR
1555                 if [ "$ZFSBOOT_PARTITION_SCHEME" = GPT ]; then
1556                         ZFSBOOT_PARTITION_SCHEME=MBR
1557                 else
1558                         ZFSBOOT_PARTITION_SCHEME=GPT
1559                 fi
1560                 ;;
1561         ?" $msg_swap_size")
1562                 # Prompt the user to input/change the swap size for each disk
1563                 while :; do
1564                     f_dialog_input input \
1565                             "$msg_please_enter_amount_of_swap_space" \
1566                             "$ZFSBOOT_SWAP_SIZE" &&
1567                             ZFSBOOT_SWAP_SIZE="${input:-0}"
1568                     if f_expand_number "$ZFSBOOT_SWAP_SIZE" swapsize
1569                     then
1570                         if [ $swapsize -ne 0 -a $swapsize -lt 104857600 ]; then
1571                             f_show_err "$msg_swap_toosmall" \
1572                                        "$ZFSBOOT_SWAP_SIZE"
1573                             continue;
1574                         else
1575                             break;
1576                         fi
1577                     else
1578                         f_show_err "$msg_swap_invalid" \
1579                                    "$ZFSBOOT_SWAP_SIZE"
1580                         continue;
1581                     fi
1582                 done
1583                 ;;
1584         ?" $msg_swap_mirror")
1585                 # Toggle the variable referenced both by the menu and later
1586                 if [ "$ZFSBOOT_SWAP_MIRROR" ]; then
1587                         ZFSBOOT_SWAP_MIRROR=
1588                 else
1589                         ZFSBOOT_SWAP_MIRROR=1
1590                 fi
1591                 ;;
1592         ?" $msg_swap_encrypt")
1593                 # Toggle the variable referenced both by the menu and later
1594                 if [ "$ZFSBOOT_SWAP_ENCRYPTION" ]; then
1595                         ZFSBOOT_SWAP_ENCRYPTION=
1596                 else
1597                         ZFSBOOT_SWAP_ENCRYPTION=1
1598                 fi
1599                 ;;
1600         esac
1601 done
1602
1603 return $SUCCESS
1604
1605 ################################################################################
1606 # END
1607 ################################################################################