3 # Copyright (c) 2013-2015 Allan Jude
4 # Copyright (c) 2013-2015 Devin Teske
7 # Redistribution and use in source and binary forms, with or without
8 # modification, are permitted provided that the following conditions
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.
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
30 ############################################################ INCLUDES
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
40 ############################################################ CONFIGURATION
43 # Default name of the boot-pool
45 : ${ZFSBOOT_POOL_NAME:=zroot}
48 # Default options to use when creating zroot pool
50 : ${ZFSBOOT_POOL_CREATE_OPTIONS:=-O compress=lz4 -O atime=off}
53 # Default name for the boot environment parent dataset
55 : ${ZFSBOOT_BEROOT_NAME:=ROOT}
58 # Default name for the primany boot environment
60 : ${ZFSBOOT_BOOTFS_NAME:=default}
63 # Default Virtual Device (vdev) type to create
65 : ${ZFSBOOT_VDEV_TYPE:=stripe}
68 # Should we use sysctl(8) vfs.zfs.min_auto_ashift=12 to force 4K sectors?
70 : ${ZFSBOOT_FORCE_4K_SECTORS:=1}
73 # Should we use geli(8) to encrypt the drives?
74 # NB: Automatically enables ZFSBOOT_BOOT_POOL
76 : ${ZFSBOOT_GELI_ENCRYPTION=}
79 # Default path to the geli(8) keyfile used in drive encryption
81 : ${ZFSBOOT_GELI_KEY_FILE:=/boot/encryption.key}
84 # Create a separate boot pool?
85 # NB: Automatically set when using geli(8) or MBR
87 : ${ZFSBOOT_BOOT_POOL=}
90 # Options to use when creating separate boot pool (if any)
92 : ${ZFSBOOT_BOOT_POOL_CREATE_OPTIONS:=}
95 # Default name for boot pool when enabled (e.g., geli(8) or MBR)
97 : ${ZFSBOOT_BOOT_POOL_NAME:=bootpool}
100 # Default size for boot pool when enabled (e.g., geli(8) or MBR)
102 : ${ZFSBOOT_BOOT_POOL_SIZE:=2g}
105 # Default disks to use (always empty unless being scripted)
110 # Default partitioning scheme to use on disks
112 : ${ZFSBOOT_PARTITION_SCHEME:=GPT}
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.
118 : ${ZFSBOOT_SWAP_SIZE:=2g}
121 # Should we use geli(8) to encrypt the swap?
123 : ${ZFSBOOT_SWAP_ENCRYPTION=}
126 # Should we use gmirror(8) to mirror the swap?
128 : ${ZFSBOOT_SWAP_MIRROR=}
131 # Default ZFS datasets for root zpool
133 # NOTE: Requires /tmp, /var/tmp, /$ZFSBOOT_BOOTFS_NAME/$ZFSBOOT_BOOTFS_NAME
134 # NOTE: Anything after pound/hash character [#] is ignored as a comment.
136 f_isset ZFSBOOT_DATASETS || ZFSBOOT_DATASETS="
137 # DATASET OPTIONS (comma or space separated; or both)
139 # Boot Environment [BE] root and default boot dataset
140 /$ZFSBOOT_BEROOT_NAME mountpoint=none
141 /$ZFSBOOT_BEROOT_NAME/$ZFSBOOT_BOOTFS_NAME mountpoint=/
143 # Compress /tmp, allow exec but not setuid
144 /tmp mountpoint=/tmp,exec=on,setuid=off
146 # Don't mount /usr so that 'base' files go to the BEROOT
147 /usr mountpoint=/usr,canmount=off
149 # Home directories separated so they are common to all BEs
150 /usr/home # NB: /home is a symlink to /usr/home
153 /usr/ports setuid=off
155 # Source tree (compressed)
158 # Create /var and friends
159 /var mountpoint=/var,canmount=off
160 /var/audit exec=off,setuid=off
161 /var/crash exec=off,setuid=off
162 /var/log exec=off,setuid=off
168 # If interactive and the user has not explicitly chosen a vdev type or disks,
169 # make the user confirm scripted/default choices when proceeding to install.
171 : ${ZFSBOOT_CONFIRM_LAYOUT:=1}
173 ############################################################ GLOBALS
176 # Format of a line in printf(1) syntax to add to fstab(5)
178 FSTAB_FMT="%s\t\t%s\t%s\t%s\t\t%s\t%s\n"
181 # Command strings for various tasks
183 CHMOD_MODE='chmod %s "%s"'
184 DD_WITH_OPTIONS='dd if="%s" of="%s" %s'
185 ECHO_APPEND='echo "%s" >> "%s"'
186 GELI_ATTACH='geli attach -j - -k "%s" "%s"'
187 GELI_DETACH_F='geli detach -f "%s"'
188 GELI_PASSWORD_INIT='geli init -b -B "%s" -e %s -J - -K "%s" -l 256 -s 4096 "%s"'
189 GPART_ADD_ALIGN='gpart add %s -t %s "%s"'
190 GPART_ADD_ALIGN_INDEX='gpart add %s -i %s -t %s "%s"'
191 GPART_ADD_ALIGN_INDEX_WITH_SIZE='gpart add %s -i %s -t %s -s %s "%s"'
192 GPART_ADD_ALIGN_LABEL='gpart add %s -l %s -t %s "%s"'
193 GPART_ADD_ALIGN_LABEL_WITH_SIZE='gpart add %s -l %s -t %s -s %s "%s"'
194 GPART_BOOTCODE='gpart bootcode -b "%s" "%s"'
195 GPART_BOOTCODE_PART='gpart bootcode -b "%s" -p "%s" -i %s "%s"'
196 GPART_CREATE='gpart create -s %s "%s"'
197 GPART_DESTROY_F='gpart destroy -F "%s"'
198 GPART_SET_ACTIVE='gpart set -a active -i %s "%s"'
199 GPART_SET_LENOVOFIX='gpart set -a lenovofix "%s"'
200 GPART_SET_PMBR_ACTIVE='gpart set -a active "%s"'
201 GRAID_DELETE='graid delete "%s"'
202 LN_SF='ln -sf "%s" "%s"'
203 MKDIR_P='mkdir -p "%s"'
204 MOUNT_TYPE='mount -t %s "%s" "%s"'
205 PRINTF_CONF="printf '%s=\"%%s\"\\\n' %s >> \"%s\""
206 PRINTF_FSTAB='printf "$FSTAB_FMT" "%s" "%s" "%s" "%s" "%s" "%s" >> "%s"'
207 SHELL_TRUNCATE=':> "%s"'
208 SWAP_GMIRROR_LABEL='gmirror label swap %s'
209 SYSCTL_ZFS_MIN_ASHIFT_12='sysctl vfs.zfs.min_auto_ashift=12'
211 ZFS_CREATE_WITH_OPTIONS='zfs create %s "%s"'
212 ZFS_SET='zfs set "%s" "%s"'
213 ZFS_UNMOUNT='zfs unmount "%s"'
214 ZPOOL_CREATE_WITH_OPTIONS='zpool create %s "%s" %s %s'
215 ZPOOL_DESTROY='zpool destroy "%s"'
216 ZPOOL_EXPORT='zpool export "%s"'
217 ZPOOL_IMPORT_WITH_OPTIONS='zpool import %s "%s"'
218 ZPOOL_LABELCLEAR_F='zpool labelclear -f "%s"'
219 ZPOOL_SET='zpool set %s "%s"'
222 # Strings that should be moved to an i18n file and loaded with f_include_lang()
224 hline_alnum_arrows_punc_tab_enter="Use alnum, arrows, punctuation, TAB or ENTER"
225 hline_arrows_space_tab_enter="Use arrows, SPACE, TAB or ENTER"
226 hline_arrows_tab_enter="Press arrows, TAB or ENTER"
227 msg_an_unknown_error_occurred="An unknown error occurred"
230 msg_change_selection="Change Selection"
231 msg_configure_options="Configure Options:"
232 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"
233 msg_disk_info="Disk Info"
234 msg_disk_info_help="Get detailed information on disk device(s)"
235 msg_disk_singular="disk"
236 msg_disk_plural="disks"
237 msg_encrypt_disks="Encrypt Disks?"
238 msg_encrypt_disks_help="Use geli(8) to encrypt all data partitions"
240 msg_force_4k_sectors="Force 4K Sectors?"
241 msg_force_4k_sectors_help="Align partitions to 4K sector boundries and set vfs.zfs.min_auto_ashift=12"
242 msg_freebsd_installer="FreeBSD Installer"
243 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"
244 msg_geli_setup="Initializing encryption on selected disks,\n this will take several seconds per disk"
245 msg_install="Install"
246 msg_install_desc="Proceed with Installation"
247 msg_install_help="Create ZFS boot pool with displayed options"
248 msg_invalid_boot_pool_size="Invalid boot pool size \`%s'"
249 msg_invalid_disk_argument="Invalid disk argument \`%s'"
250 msg_invalid_index_argument="Invalid index argument \`%s'"
251 msg_invalid_swap_size="Invalid swap size \`%s'"
252 msg_invalid_virtual_device_type="Invalid Virtual Device type \`%s'"
253 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"
254 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'
255 msg_mirror_desc="Mirror - n-Way Mirroring"
256 msg_mirror_help="[2+ Disks] Mirroring provides the best performance, but the least storage"
257 msg_missing_disk_arguments="missing disk arguments"
258 msg_missing_one_or_more_scripted_disks="Missing one or more scripted disks!"
260 msg_no_disks_present_to_configure="No disk(s) present to configure"
261 msg_no_disks_selected="No disks selected."
262 msg_not_enough_disks_selected="Not enough disks selected. (%u < %u minimum)"
263 msg_null_disk_argument="NULL disk argument"
264 msg_null_index_argument="NULL index argument"
265 msg_null_poolname="NULL poolname"
267 msg_partition_scheme="Partition Scheme"
268 msg_partition_scheme_help="Select partitioning scheme. GPT is recommended."
269 msg_please_enter_a_name_for_your_zpool="Please enter a name for your zpool:"
270 msg_please_enter_amount_of_swap_space="Please enter amount of swap space (SI-Unit suffixes\nrecommended; e.g., \`2g' for 2 Gigabytes):"
271 msg_please_select_one_or_more_disks="Please select one or more disks to create a zpool:"
272 msg_pool_name="Pool Name"
273 msg_pool_name_cannot_be_empty="Pool name cannot be empty."
274 msg_pool_name_help="Customize the name of the zpool to be created (Required)"
275 msg_pool_type_disks="Pool Type/Disks:"
276 msg_pool_type_disks_help="Choose type of ZFS Virtual Device and disks to use (Required)"
277 msg_processing_selection="Processing selection..."
278 msg_raidz1_desc="RAID-Z1 - Single Redundant RAID"
279 msg_raidz1_help="[3+ Disks] Withstand failure of 1 disk. Recommended for: 3, 5 or 9 disks"
280 msg_raidz2_desc="RAID-Z2 - Double Redundant RAID"
281 msg_raidz2_help="[4+ Disks] Withstand failure of 2 disks. Recommended for: 4, 6 or 10 disks"
282 msg_raidz3_desc="RAID-Z3 - Triple Redundant RAID"
283 msg_raidz3_help="[5+ Disks] Withstand failure of 3 disks. Recommended for: 5, 7 or 11 disks"
284 msg_rescan_devices="Rescan Devices"
285 msg_rescan_devices_help="Scan for device changes"
287 msg_select_a_disk_device="Select a disk device"
288 msg_select_virtual_device_type="Select Virtual Device type:"
289 msg_stripe_desc="Stripe - No Redundancy"
290 msg_stripe_help="[1+ Disks] Striping provides maximum storage but no redundancy"
291 msg_swap_encrypt="Encrypt Swap?"
292 msg_swap_encrypt_help="Encrypt swap partitions with temporary keys, discarded on reboot"
293 msg_swap_invalid="The selected swap size (%s) is invalid. Enter a number optionally followed by units. Example: 2G"
294 msg_swap_mirror="Mirror Swap?"
295 msg_swap_mirror_help="Mirror swap partitions for redundancy, breaks crash dumps"
296 msg_swap_size="Swap Size"
297 msg_swap_size_help="Customize how much swap space is allocated to each selected disk"
298 msg_swap_toosmall="The selected swap size (%s) is to small. Please enter a value greater than 100MB or enter 0 for no swap"
299 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."
300 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?"
301 msg_unable_to_get_disk_capacity="Unable to get disk capacity of \`%s'"
302 msg_unsupported_partition_scheme="%s is an unsupported partition scheme"
303 msg_user_cancelled="User Cancelled."
305 msg_zfs_configuration="ZFS Configuration"
307 ############################################################ FUNCTIONS
311 # Display the dialog(1)-based application main menu.
315 local title="$DIALOG_TITLE"
316 local btitle="$DIALOG_BACKTITLE"
317 local prompt="$msg_configure_options"
318 local force4k="$msg_no"
319 local usegeli="$msg_no"
320 local swapgeli="$msg_no"
321 local swapmirror="$msg_no"
322 [ "$ZFSBOOT_FORCE_4K_SECTORS" ] && force4k="$msg_yes"
323 [ "$ZFSBOOT_GELI_ENCRYPTION" ] && usegeli="$msg_yes"
324 [ "$ZFSBOOT_SWAP_ENCRYPTION" ] && swapgeli="$msg_yes"
325 [ "$ZFSBOOT_SWAP_MIRROR" ] && swapmirror="$msg_yes"
326 local disks n disks_grammar
327 f_count n $ZFSBOOT_DISKS
328 { [ $n -eq 1 ] && disks_grammar=$msg_disk_singular; } ||
329 disks_grammar=$msg_disk_plural # grammar
331 '>>> $msg_install' '$msg_install_desc'
333 'T $msg_pool_type_disks'
334 '$ZFSBOOT_VDEV_TYPE: $n $disks_grammar'
335 '$msg_pool_type_disks_help'
336 '- $msg_rescan_devices' '*'
337 '$msg_rescan_devices_help'
338 '- $msg_disk_info' '*'
339 '$msg_disk_info_help'
340 'N $msg_pool_name' '$ZFSBOOT_POOL_NAME'
341 '$msg_pool_name_help'
342 '4 $msg_force_4k_sectors'
344 '$msg_force_4k_sectors_help'
345 'E $msg_encrypt_disks' '$usegeli'
346 '$msg_encrypt_disks_help'
347 'P $msg_partition_scheme'
348 '$ZFSBOOT_PARTITION_SCHEME'
349 '$msg_partition_scheme_help'
350 'S $msg_swap_size' '$ZFSBOOT_SWAP_SIZE'
351 '$msg_swap_size_help'
352 'M $msg_swap_mirror' '$swapmirror'
353 '$msg_swap_mirror_help'
354 'W $msg_swap_encrypt' '$swapgeli'
355 '$msg_swap_encrypt_help'
357 local defaultitem= # Calculated below
358 local hline="$hline_alnum_arrows_punc_tab_enter"
360 local height width rows
361 eval f_dialog_menu_with_help_size height width rows \
362 \"\$title\" \"\$btitle\" \"\$prompt\" \"\$hline\" $menu_list
364 # Obtain default-item from previously stored selection
365 f_dialog_default_fetch defaultitem
368 menu_choice=$( eval $DIALOG \
369 --title \"\$title\" \
370 --backtitle \"\$btitle\" \
371 --hline \"\$hline\" \
373 --ok-label \"\$msg_select\" \
374 --cancel-label \"\$msg_cancel\" \
375 --default-item \"\$defaultitem\" \
376 --menu \"\$prompt\" \
377 $height $width $rows \
379 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD
382 f_dialog_data_sanitize menu_choice
383 f_dialog_menutag_store "$menu_choice"
385 # Only update default-item on success
386 [ $retval -eq $DIALOG_OK ] && f_dialog_default_store "$menu_choice"
391 # dialog_last_chance $disks ...
393 # Display a list of the disks that the user is about to destroy. The default
394 # action is to return error status unless the user explicitly (non-default)
395 # selects "Yes" from the noyes dialog.
399 local title="$DIALOG_TITLE"
400 local btitle="$DIALOG_BACKTITLE"
401 local prompt # Calculated below
402 local hline="$hline_arrows_tab_enter"
404 local height=8 width=50 prefix=" "
405 local plen=${#prefix} list= line=
406 local max_width=$(( $width - 3 - $plen ))
408 local yes no defaultno extra_args format
409 if [ "$USE_XDIALOG" ]; then
410 yes=ok no=cancel defaultno=default-no
411 extra_args="--wrap --left"
412 format="$msg_last_chance_are_you_sure"
414 yes=yes no=no defaultno=defaultno
415 extra_args="--colors --cr-wrap"
416 format="$msg_last_chance_are_you_sure_color"
419 local disk line_width
426 line_width=$(( $line_width + 1 + ${#disk} ))
427 # Add newline before disk if it would exceed max_width
428 if [ $line_width -gt $max_width ]; then
431 height=$(( $height + 1 ))
433 # Add the disk to the list
436 # Append the left-overs
437 if [ "${line#$prefix}" ]; then
439 height=$(( $height + 1 ))
442 # Add height for Xdialog(1)
443 [ "$USE_XDIALOG" ] && height=$(( $height + $height / 5 + 3 ))
445 prompt=$( printf "$format" "$list" )
446 f_dprintf "%s: Last Chance!" "$0"
449 --backtitle "$btitle" \
452 --$yes-label "$msg_yes" \
453 --$no-label "$msg_no" \
455 --yesno "$prompt" $height $width
460 # Configure Virtual Device type and disks to use for the ZFS boot pool. User
461 # must select enough disks to satisfy the chosen vdev type.
465 local funcname=dialog_menu_layout
466 local title="$DIALOG_TITLE"
467 local btitle="$DIALOG_BACKTITLE"
468 local vdev_prompt="$msg_select_virtual_device_type"
469 local disk_prompt="$msg_please_select_one_or_more_disks"
470 local vdev_menu_list="
471 'stripe' '$msg_stripe_desc' '$msg_stripe_help'
472 'mirror' '$msg_mirror_desc' '$msg_mirror_help'
473 'raidz1' '$msg_raidz1_desc' '$msg_raidz1_help'
474 'raidz2' '$msg_raidz2_desc' '$msg_raidz2_help'
475 'raidz3' '$msg_raidz3_desc' '$msg_raidz3_help'
477 local disk_check_list= # Calculated below
478 local vdev_hline="$hline_arrows_tab_enter"
479 local disk_hline="$hline_arrows_space_tab_enter"
481 # Warn the user if vdev type is not valid
482 case "$ZFSBOOT_VDEV_TYPE" in
483 stripe|mirror|raidz1|raidz2|raidz3) : known good ;;
485 f_dprintf "%s: Invalid virtual device type \`%s'" \
486 $funcname "$ZFSBOOT_VDEV_TYPE"
487 f_show_err "$msg_invalid_virtual_device_type" \
489 f_interactive || return $FAILURE
492 # Calculate size of vdev menu once only
493 local vheight vwidth vrows
494 eval f_dialog_menu_with_help_size vheight vwidth vrows \
495 \"\$title\" \"\$btitle\" \"\$vdev_prompt\" \"\$vdev_hline\" \
498 # Get a list of probed disk devices
500 debug= f_device_find "" $DEVICE_TYPE_DISK disks
502 # Prune out mounted md(4) devices that may be part of the boot process
503 local disk name new_list=
504 for disk in $disks; do
505 debug= $disk get name name
507 md[0-9]*) f_mounted -b "/dev/$name" && continue ;;
509 new_list="$new_list $disk"
511 disks="${new_list# }"
514 if [ "$debug" ]; then
516 for disk in $disks; do
517 debug= $disk get name name
518 disk_names="$disk_names $name"
520 f_dprintf "$funcname: disks=[%s]" "${disk_names# }"
523 if [ ! "$disks" ]; then
524 f_dprintf "No disk(s) present to configure"
525 f_show_err "$msg_no_disks_present_to_configure"
529 # Lets sort the disks array to be more user friendly
530 f_device_sort_by name disks disks
533 # Operate in a loop so we can (if interactive) repeat if not enough
534 # disks are selected to satisfy the chosen vdev type or user wants to
535 # back-up to the previous menu.
537 local vardisk ndisks onoff selections vdev_choice breakout device
538 local valid_disks all_valid want_disks desc height width rows
541 # Confirm the vdev type that was selected
543 if f_interactive && [ "$ZFSBOOT_CONFIRM_LAYOUT" ]; then
544 vdev_choice=$( eval $DIALOG \
545 --title \"\$title\" \
546 --backtitle \"\$btitle\" \
547 --hline \"\$vdev_hline\" \
548 --ok-label \"\$msg_ok\" \
549 --cancel-label \"\$msg_cancel\" \
551 --default-item \"\$ZFSBOOT_VDEV_TYPE\" \
552 --menu \"\$vdev_prompt\" \
553 $vheight $vwidth $vrows \
555 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD
557 # Exit if user pressed ESC or chose Cancel/No
558 f_dialog_data_sanitize vdev_choice
560 ZFSBOOT_VDEV_TYPE="$vdev_choice"
561 f_dprintf "$funcname: ZFSBOOT_VDEV_TYPE=[%s]" \
565 # Determine the number of disks needed for this vdev type
567 case "$ZFSBOOT_VDEV_TYPE" in
568 stripe) want_disks=1 ;;
569 mirror) want_disks=2 ;;
570 raidz1) want_disks=3 ;;
571 raidz2) want_disks=4 ;;
572 raidz3) want_disks=5 ;;
576 # Warn the user if any scripted disks are invalid
578 valid_disks= all_valid=${ZFSBOOT_DISKS:+1} # optimism
579 for disk in $ZFSBOOT_DISKS; do
580 if debug= f_device_find -1 \
581 $disk $DEVICE_TYPE_DISK device
583 valid_disks="$valid_disks $disk"
586 f_dprintf "$funcname: \`%s' is not a real disk" "$disk"
589 if [ ! "$all_valid" ]; then
590 if [ "$ZFSBOOT_DISKS" ]; then
592 "$msg_missing_one_or_more_scripted_disks"
594 f_dprintf "No disks selected."
596 f_show_err "$msg_no_disks_selected"
598 f_interactive || return $FAILURE
600 ZFSBOOT_DISKS="${valid_disks# }"
603 # Short-circuit if we're running non-interactively
605 if ! f_interactive || [ ! "$ZFSBOOT_CONFIRM_LAYOUT" ]; then
606 f_count ndisks $ZFSBOOT_DISKS
607 [ $ndisks -ge $want_disks ] && break # to success
609 # Not enough disks selected
610 f_dprintf "$funcname: %s: %s (%u < %u minimum)" \
611 "$ZFSBOOT_VDEV_TYPE" \
612 "Not enough disks selected." \
614 f_interactive || return $FAILURE
615 msg_yes="$msg_change_selection" msg_no="$msg_cancel" \
616 f_yesno "%s: $msg_not_enough_disks_selected" \
617 "$ZFSBOOT_VDEV_TYPE" $ndisks $want_disks ||
622 # Confirm the disks that were selected
623 # Loop until the user cancels or selects enough disks
627 # Loop over list of available disks, resetting state
628 for disk in $disks; do
629 f_isset _${disk}_status && _${disk}_status=
632 # Loop over list of selected disks and create temporary
633 # locals to map statuses onto up-to-date list of disks
634 for disk in $ZFSBOOT_DISKS; do
635 debug= f_device_find -1 \
636 $disk $DEVICE_TYPE_DISK disk
637 f_isset _${disk}_status ||
638 local _${disk}_status
642 # Create the checklist menu of discovered disk devices
644 for disk in $disks; do
648 f_shell_escape "$desc" desc
649 f_getvar _${disk}_status:-off onoff
650 disk_check_list="$disk_check_list
651 $name '$desc' $onoff"
654 eval f_dialog_checklist_size height width rows \
655 \"\$title\" \"\$btitle\" \"\$prompt\" \
656 \"\$hline\" $disk_check_list
658 selections=$( eval $DIALOG \
659 --title \"\$DIALOG_TITLE\" \
660 --backtitle \"\$DIALOG_BACKTITLE\" \
662 --hline \"\$hline\" \
663 --ok-label \"\$msg_ok\" \
664 --cancel-label \"\$msg_back\" \
665 --checklist \"\$prompt\" \
666 $height $width $rows \
668 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD
670 # Loop if user pressed ESC or chose Cancel/No
671 f_dialog_data_sanitize selections
673 ZFSBOOT_DISKS="$selections"
674 f_dprintf "$funcname: ZFSBOOT_DISKS=[%s]" \
677 f_count ndisks $ZFSBOOT_DISKS
678 [ $ndisks -ge $want_disks ] &&
679 breakout=break && break
681 # Not enough disks selected
682 f_dprintf "$funcname: %s: %s (%u < %u minimum)" \
683 "$ZFSBOOT_VDEV_TYPE" \
684 "Not enough disks selected." \
686 msg_yes="$msg_change_selection" msg_no="$msg_cancel" \
687 f_yesno "%s: $msg_not_enough_disks_selected" \
688 "$ZFSBOOT_VDEV_TYPE" $ndisks $want_disks ||
691 [ "$breakout" = "break" ] && break
692 [ "$ZFSBOOT_CONFIRM_LAYOUT" ] || return $FAILURE
700 # Confirm that the user wants to continue with the installation on a BIOS
701 # system when they have booted with UEFI
705 local title="$DIALOG_TITLE"
706 local btitle="$DIALOG_BACKTITLE"
707 local prompt # Calculated below
708 local hline="$hline_arrows_tab_enter"
710 local height=8 width=50 prefix=" "
711 local plen=${#prefix} list= line=
712 local max_width=$(( $width - 3 - $plen ))
714 local yes no defaultno extra_args format
715 if [ "$USE_XDIALOG" ]; then
716 yes=ok no=cancel defaultno=default-no
717 extra_args="--wrap --left"
718 format="$msg_uefi_not_supported"
720 yes=yes no=no defaultno=defaultno
721 extra_args="--cr-wrap"
722 format="$msg_uefi_not_supported"
725 # Add height for Xdialog(1)
726 [ "$USE_XDIALOG" ] && height=$(( $height + $height / 5 + 3 ))
728 prompt=$( printf "$format" )
729 f_dprintf "%s: UEFI prompt" "$0"
732 --backtitle "$btitle" \
734 --$yes-label "$msg_yes" \
735 --$no-label "$msg_no" \
737 --yesno "$prompt" $height $width
740 # zfs_create_diskpart $disk $index
742 # For each block device to be used in the zpool, rather than just create the
743 # zpool with the raw block devices (e.g., da0, da1, etc.) we create partitions
744 # so we can have some real swap. This also provides wiggle room incase your
745 # replacement drivers do not have the exact same sector counts.
747 # NOTE: $swapsize and $bootsize should be defined by the calling function.
748 # NOTE: Sets $bootpart and $targetpart for the calling function.
750 zfs_create_diskpart()
752 local funcname=zfs_create_diskpart
753 local disk="$1" index="$2"
756 if [ ! "$disk" ]; then
757 f_dprintf "$funcname: NULL disk argument"
758 msg_error="$msg_error: $funcname" \
759 f_show_err "$msg_null_disk_argument"
762 if [ "${disk#*[$IFS]}" != "$disk" ]; then
763 f_dprintf "$funcname: Invalid disk argument \`%s'" "$disk"
764 msg_error="$msg_error: $funcname" \
765 f_show_err "$msg_invalid_disk_argument" "$disk"
768 if [ ! "$index" ]; then
769 f_dprintf "$funcname: NULL index argument"
770 msg_error="$msg_error: $funcname" \
771 f_show_err "$msg_null_index_argument"
774 if ! f_isinteger "$index"; then
775 f_dprintf "$funcname: Invalid index argument \`%s'" "$index"
776 msg_error="$msg_error: $funcname" \
777 f_show_err "$msg_invalid_index_argument" "$index"
780 f_dprintf "$funcname: disk=[%s] index=[%s]" "$disk" "$index"
782 # Check for unknown partition scheme before proceeding further
783 case "$ZFSBOOT_PARTITION_SCHEME" in
784 ""|MBR|GPT*) : known good ;;
786 f_dprintf "$funcname: %s is an unsupported partition scheme" \
787 "$ZFSBOOT_PARTITION_SCHEME"
788 msg_error="$msg_error: $funcname" f_show_err \
789 "$msg_unsupported_partition_scheme" \
790 "$ZFSBOOT_PARTITION_SCHEME"
795 # Destroy whatever partition layout is currently on disk.
796 # NOTE: `-F' required to destroy if partitions still exist.
797 # NOTE: Failure is ok here, blank disk will have nothing to destroy.
799 f_dprintf "$funcname: Destroying all data/layouts on \`%s'..." "$disk"
800 f_eval_catch -d $funcname gpart "$GPART_DESTROY_F" $disk
801 f_eval_catch -d $funcname graid "$GRAID_DELETE" $disk
802 f_eval_catch -d $funcname zpool "$ZPOOL_LABELCLEAR_F" /dev/$disk
804 # Make doubly-sure backup GPT is destroyed
805 f_eval_catch -d $funcname gpart "$GPART_CREATE" gpt $disk
806 f_eval_catch -d $funcname gpart "$GPART_DESTROY_F" $disk
809 # Enable boot pool if encryption is desired
811 [ "$ZFSBOOT_GELI_ENCRYPTION" ] && ZFSBOOT_BOOT_POOL=1
814 # Lay down the desired type of partition scheme
816 local setsize mbrindex align_small align_big
818 # If user has requested 4 K alignment, add these params to the
819 # gpart add calls. With GPT, we align large partitions to 1 M for
820 # improved performance on SSDs. MBR does not always play well with gaps
821 # between partitions, so all alignment is only 4k for that case.
822 # With MBR, we align the BSD partition that contains the MBR, otherwise
823 # the system fails to boot.
825 if [ "$ZFSBOOT_FORCE_4K_SECTORS" ]; then
830 case "$ZFSBOOT_PARTITION_SCHEME" in
831 ""|GPT*) f_dprintf "$funcname: Creating GPT layout..."
833 # 1. Create GPT layout using labels
835 f_eval_catch $funcname gpart "$GPART_CREATE" gpt $disk ||
839 # Apply workarounds if requested by the user
841 if [ "$ZFSBOOT_PARTITION_SCHEME" = "GPT + Lenovo Fix" ]; then
842 f_eval_catch $funcname gpart "$GPART_SET_LENOVOFIX" \
843 $disk || return $FAILURE
844 elif [ "$ZFSBOOT_PARTITION_SCHEME" = "GPT + Active" ]; then
845 f_eval_catch $funcname gpart "$GPART_SET_PMBR_ACTIVE" \
846 $disk || return $FAILURE
850 # 2. Add small freebsd-boot partition labeled `boot#'
852 f_eval_catch $funcname gpart "$GPART_ADD_ALIGN_LABEL_WITH_SIZE" \
853 "$align_small" gptboot$index freebsd-boot 512k $disk ||
855 f_eval_catch $funcname gpart "$GPART_BOOTCODE_PART" \
856 /boot/pmbr /boot/gptzfsboot 1 $disk ||
859 # NB: zpool will use the `zfs#' GPT labels
860 bootpart=p2 swappart=p2 targetpart=p2
861 [ ${swapsize:-0} -gt 0 ] && targetpart=p3
864 # Prepare boot pool if enabled (e.g., for geli(8))
866 if [ "$ZFSBOOT_BOOT_POOL" ]; then
867 bootpart=p2 swappart=p3 targetpart=p3
868 [ ${swapsize:-0} -gt 0 ] && targetpart=p4
869 f_eval_catch $funcname gpart \
870 "$GPART_ADD_ALIGN_LABEL_WITH_SIZE" \
871 "$align_big" boot$index freebsd-zfs \
872 ${bootsize}b $disk ||
874 # Pedantically nuke any old labels
875 f_eval_catch -d $funcname zpool "$ZPOOL_LABELCLEAR_F" \
877 if [ "$ZFSBOOT_GELI_ENCRYPTION" ]; then
878 # Pedantically detach targetpart for later
879 f_eval_catch -d $funcname geli \
881 /dev/$disk$targetpart
886 # 3. Add freebsd-swap partition labeled `swap#'
888 if [ ${swapsize:-0} -gt 0 ]; then
889 f_eval_catch $funcname gpart \
890 "$GPART_ADD_ALIGN_LABEL_WITH_SIZE" \
891 "$align_big" swap$index freebsd-swap \
892 ${swapsize}b $disk ||
894 # Pedantically nuke any old labels on the swap
895 f_eval_catch -d $funcname zpool "$ZPOOL_LABELCLEAR_F" \
900 # 4. Add freebsd-zfs partition labeled `zfs#' for zroot
902 f_eval_catch $funcname gpart "$GPART_ADD_ALIGN_LABEL" \
903 "$align_big" zfs$index freebsd-zfs $disk ||
905 f_eval_catch -d $funcname zpool "$ZPOOL_LABELCLEAR_F" \
906 /dev/$disk$targetpart
909 MBR) f_dprintf "$funcname: Creating MBR layout..."
911 # 1. Create MBR layout (no labels)
913 f_eval_catch $funcname gpart "$GPART_CREATE" mbr $disk ||
915 f_eval_catch $funcname gpart "$GPART_BOOTCODE" /boot/mbr \
916 $disk || return $FAILURE
919 # 2. Add freebsd slice with all available space
921 f_eval_catch $funcname gpart "$GPART_ADD_ALIGN" "$align_small" \
924 f_eval_catch $funcname gpart "$GPART_SET_ACTIVE" 1 $disk ||
926 # Pedantically nuke any old labels
927 f_eval_catch -d $funcname zpool "$ZPOOL_LABELCLEAR_F" \
929 # Pedantically nuke any old scheme
930 f_eval_catch -d $funcname gpart "$GPART_DESTROY_F" ${disk}s1
933 # 3. Write BSD scheme to the freebsd slice
935 f_eval_catch $funcname gpart "$GPART_CREATE" BSD ${disk}s1 ||
938 # NB: zpool will use s1a (no labels)
939 bootpart=s1a swappart=s1b targetpart=s1d mbrindex=4
942 # Always prepare a boot pool on MBR
945 f_eval_catch $funcname gpart \
946 "$GPART_ADD_ALIGN_INDEX_WITH_SIZE" \
947 "$align_small" 1 freebsd-zfs ${bootsize}b ${disk}s1 ||
949 # Pedantically nuke any old labels
950 f_eval_catch -d $funcname zpool "$ZPOOL_LABELCLEAR_F" \
952 if [ "$ZFSBOOT_GELI_ENCRYPTION" ]; then
953 # Pedantically detach targetpart for later
954 f_eval_catch -d $funcname geli \
956 /dev/$disk$targetpart
960 # 4. Add freebsd-swap partition
962 if [ ${swapsize:-0} -gt 0 ]; then
963 f_eval_catch $funcname gpart \
964 "$GPART_ADD_ALIGN_INDEX_WITH_SIZE" \
965 "$align_small" 2 freebsd-swap ${swapsize}b ${disk}s1 ||
967 # Pedantically nuke any old labels on the swap
968 f_eval_catch -d $funcname zpool "$ZPOOL_LABELCLEAR_F" \
973 # 5. Add freebsd-zfs partition for zroot
975 f_eval_catch $funcname gpart "$GPART_ADD_ALIGN_INDEX" \
976 "$align_small" $mbrindex freebsd-zfs ${disk}s1 || return $FAILURE
977 f_eval_catch -d $funcname zpool "$ZPOOL_LABELCLEAR_F" \
978 /dev/$disk$targetpart # Pedantic
979 f_eval_catch $funcname dd "$DD_WITH_OPTIONS" \
980 /boot/zfsboot /dev/${disk}s1 count=1 ||
984 esac # $ZFSBOOT_PARTITION_SCHEME
988 f_expand_number "$ZFSBOOT_SWAP_SIZE" swapsize
989 if [ "$isswapmirror" ]; then
990 # This is not the first disk in the mirror, do nothing
991 elif [ "$ZFSBOOT_SWAP_ENCRYPTION" -a "$ZFSBOOT_SWAP_MIRROR" ]; then
992 f_eval_catch $funcname printf "$PRINTF_FSTAB" \
993 /dev/mirror/swap.eli none swap sw 0 0 \
994 $BSDINSTALL_TMPETC/fstab ||
997 elif [ "$ZFSBOOT_SWAP_MIRROR" ]; then
998 f_eval_catch $funcname printf "$PRINTF_FSTAB" \
999 /dev/mirror/swap none swap sw 0 0 \
1000 $BSDINSTALL_TMPETC/fstab ||
1003 elif [ "$ZFSBOOT_SWAP_ENCRYPTION" ]; then
1004 f_eval_catch $funcname printf "$PRINTF_FSTAB" \
1005 /dev/$disk${swappart}.eli none swap sw 0 0 \
1006 $BSDINSTALL_TMPETC/fstab ||
1008 elif [ ${swapsize:-0} -eq 0 ]; then
1009 # If swap is 0 sized, don't add it to fstab
1011 f_eval_catch $funcname printf "$PRINTF_FSTAB" \
1012 /dev/$disk$swappart none swap sw 0 0 \
1013 $BSDINSTALL_TMPETC/fstab ||
1020 # zfs_create_boot $poolname $vdev_type $disks ...
1022 # Creates boot pool and dataset layout. Returns error if something goes wrong.
1023 # Errors are printed to stderr for collection and display.
1027 local funcname=zfs_create_boot
1028 local zroot_name="$1"
1029 local zroot_vdevtype="$2"
1030 local zroot_vdevs= # Calculated below
1031 local swap_devs= # Calculated below
1032 local boot_vdevs= # Used for geli(8) and/or MBR layouts
1033 shift 2 # poolname vdev_type
1034 local disks="$*" disk
1036 local bootpart targetpart swappart # Set by zfs_create_diskpart() below
1037 local create_options
1040 # Pedantic checks; should never be seen
1042 if [ ! "$zroot_name" ]; then
1043 f_dprintf "$funcname: NULL poolname"
1044 msg_error="$msg_error: $funcname" \
1045 f_show_err "$msg_null_poolname"
1048 if [ $# -lt 1 ]; then
1049 f_dprintf "$funcname: missing disk arguments"
1050 msg_error="$msg_error: $funcname" \
1051 f_show_err "$msg_missing_disk_arguments"
1054 f_dprintf "$funcname: poolname=[%s] vdev_type=[%s]" \
1055 "$zroot_name" "$zroot_vdevtype"
1058 # Initialize fstab(5)
1060 f_dprintf "$funcname: Initializing temporary fstab(5) file..."
1061 f_eval_catch $funcname sh "$SHELL_TRUNCATE" $BSDINSTALL_TMPETC/fstab ||
1063 f_eval_catch $funcname printf "$PRINTF_FSTAB" \
1064 "# Device" Mountpoint FStype Options Dump "Pass#" \
1065 $BSDINSTALL_TMPETC/fstab || return $FAILURE
1068 # Expand SI units in desired sizes
1070 f_dprintf "$funcname: Expanding supplied size values..."
1071 local swapsize bootsize
1072 if ! f_expand_number "$ZFSBOOT_SWAP_SIZE" swapsize; then
1073 f_dprintf "$funcname: Invalid swap size \`%s'" \
1074 "$ZFSBOOT_SWAP_SIZE"
1075 f_show_err "$msg_invalid_swap_size" "$ZFSBOOT_SWAP_SIZE"
1078 if ! f_expand_number "$ZFSBOOT_BOOT_POOL_SIZE" bootsize; then
1079 f_dprintf "$funcname: Invalid boot pool size \`%s'" \
1080 "$ZFSBOOT_BOOT_POOL_SIZE"
1081 f_show_err "$msg_invalid_boot_pool_size" \
1082 "$ZFSBOOT_BOOT_POOL_SIZE"
1085 f_dprintf "$funcname: ZFSBOOT_SWAP_SIZE=[%s] swapsize=[%s]" \
1086 "$ZFSBOOT_SWAP_SIZE" "$swapsize"
1087 f_dprintf "$funcname: ZFSBOOT_BOOT_POOL_SIZE=[%s] bootsize=[%s]" \
1088 "$ZFSBOOT_BOOT_POOL_SIZE" "$bootsize"
1091 # Destroy the pool in-case this is our second time 'round (case of
1092 # failure and installer presented ``Retry'' option to come back).
1094 # NB: If we don't destroy the pool, later gpart(8) destroy commands
1095 # that try to clear existing partitions (see zfs_create_diskpart())
1096 # will fail with a `Device Busy' error, leading to `GEOM exists'.
1098 f_eval_catch -d $funcname zpool "$ZPOOL_DESTROY" "$zroot_name"
1101 # Prepare the disks and build pool device list(s)
1103 f_dprintf "$funcname: Preparing disk partitions for ZFS pool..."
1105 # Force 4K sectors using vfs.zfs.min_auto_ashift=12
1106 if [ "$ZFSBOOT_FORCE_4K_SECTORS" ]; then
1107 f_dprintf "$funcname: With 4K sectors..."
1108 f_eval_catch $funcname sysctl "$SYSCTL_ZFS_MIN_ASHIFT_12" \
1112 for disk in $disks; do
1113 zfs_create_diskpart $disk $n || return $FAILURE
1114 # Now $bootpart, $targetpart, and $swappart are set (suffix
1116 if [ "$ZFSBOOT_BOOT_POOL" ]; then
1117 boot_vdevs="$boot_vdevs $disk$bootpart"
1119 zroot_vdevs="$zroot_vdevs $disk$targetpart"
1120 if [ "$ZFSBOOT_GELI_ENCRYPTION" ]; then
1121 zroot_vdevs="$zroot_vdevs.eli"
1128 # If we need/want a boot pool, create it
1130 if [ "$ZFSBOOT_BOOT_POOL" ]; then
1131 local bootpool_vdevtype= # Calculated below
1132 local bootpool_options= # Calculated below
1133 local bootpool_name="$ZFSBOOT_BOOT_POOL_NAME"
1134 local bootpool="$BSDINSTALL_CHROOT/$bootpool_name"
1135 local zroot_key="${ZFSBOOT_GELI_KEY_FILE#/}"
1137 f_dprintf "$funcname: Setting up boot pool..."
1138 [ "$ZFSBOOT_GELI_ENCRYPTION" ] &&
1139 f_dprintf "$funcname: For encrypted root disk..."
1141 # Create parent directory for boot pool
1142 f_eval_catch -d $funcname umount "$UMOUNT" /mnt
1143 f_eval_catch $funcname mount "$MOUNT_TYPE" tmpfs none \
1144 $BSDINSTALL_CHROOT || return $FAILURE
1146 # Create mirror across the boot partition on all disks
1148 f_count nvdevs $boot_vdevs
1149 [ $nvdevs -gt 1 ] && bootpool_vdevtype=mirror
1151 create_options="$ZFSBOOT_BOOT_POOL_CREATE_OPTIONS"
1152 bootpool_options="-o altroot=$BSDINSTALL_CHROOT"
1153 bootpool_options="$bootpool_options $create_options"
1154 bootpool_options="$bootpool_options -m \"/$bootpool_name\" -f"
1155 f_eval_catch $funcname zpool "$ZPOOL_CREATE_WITH_OPTIONS" \
1156 "$bootpool_options" "$bootpool_name" \
1157 "$bootpool_vdevtype" "$boot_vdevs" ||
1160 f_eval_catch $funcname mkdir "$MKDIR_P" "$bootpool/boot" ||
1163 if [ "$ZFSBOOT_GELI_ENCRYPTION" ]; then
1164 # Generate an encryption key using random(4)
1165 f_eval_catch $funcname dd "$DD_WITH_OPTIONS" \
1166 /dev/random "$bootpool/$zroot_key" \
1167 "bs=4096 count=1" || return $FAILURE
1168 f_eval_catch $funcname chmod "$CHMOD_MODE" \
1169 go-wrx "$bootpool/$zroot_key" ||
1173 f_eval_catch $funcname zfs "$ZFS_UNMOUNT" \
1174 "$bootpool_name" || return $FAILURE
1175 f_eval_catch -d $funcname umount "$UMOUNT" /mnt # tmpfs
1181 # Create the geli(8) GEOMS
1183 if [ "$ZFSBOOT_GELI_ENCRYPTION" ]; then
1184 # Prompt user for password (twice)
1185 if ! msg_enter_new_password="$msg_geli_password" \
1186 f_dialog_input_password
1188 f_dprintf "$funcname: User cancelled"
1189 f_show_err "$msg_user_cancelled"
1193 # Initialize geli(8) on each of the target partitions
1194 for disk in $disks; do
1195 f_dialog_info "$msg_geli_setup" \
1196 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD
1197 if ! echo "$pw_password" | f_eval_catch \
1198 $funcname geli "$GELI_PASSWORD_INIT" \
1199 "$bootpool/boot/$disk$targetpart.eli" \
1200 AES-XTS "$bootpool/$zroot_key" \
1203 f_interactive || f_die
1204 unset pw_password # Sensitive info
1207 if ! echo "$pw_password" | f_eval_catch \
1208 $funcname geli "$GELI_ATTACH" \
1209 "$bootpool/$zroot_key" $disk$targetpart
1211 f_interactive || f_die
1212 unset pw_password # Sensitive info
1216 unset pw_password # Sensitive info
1219 f_eval_catch $funcname zfs "$ZFS_UNMOUNT" "$bootpool_name" ||
1221 f_eval_catch -d $funcname umount "$UMOUNT" /mnt # tmpfs
1225 # Create the gmirror(8) GEOMS for swap
1227 if [ "$ZFSBOOT_SWAP_MIRROR" ]; then
1228 for disk in $disks; do
1229 swap_devs="$swap_devs $disk$swappart"
1231 f_eval_catch $funcname gmirror "$SWAP_GMIRROR_LABEL" \
1232 "$swap_devs" || return $FAILURE
1236 # Create the ZFS root pool with desired type and disk devices
1238 f_dprintf "$funcname: Creating root pool..."
1239 create_options="$ZFSBOOT_POOL_CREATE_OPTIONS"
1240 f_eval_catch $funcname zpool "$ZPOOL_CREATE_WITH_OPTIONS" \
1241 "-o altroot=$BSDINSTALL_CHROOT $create_options -m none -f" \
1242 "$zroot_name" "$zroot_vdevtype" "$zroot_vdevs" ||
1246 # Create ZFS dataset layout within the new root pool
1248 f_dprintf "$funcname: Creating ZFS datasets..."
1249 echo "$ZFSBOOT_DATASETS" | while read dataset options; do
1250 # Skip blank lines and comments
1251 case "$dataset" in "#"*|"") continue; esac
1252 # Remove potential inline comments in options
1253 options="${options%%#*}"
1254 # Replace tabs with spaces
1255 f_replaceall "$options" " " " " options
1256 # Reduce contiguous runs of space to one single space
1258 while [ "$oldoptions" != "$options" ]; do
1259 oldoptions="$options"
1260 f_replaceall "$options" " " " " options
1262 # Replace both commas and spaces with ` -o '
1263 f_replaceall "$options" "[ ,]" " -o " options
1264 # Create the dataset with desired options
1265 f_eval_catch $funcname zfs "$ZFS_CREATE_WITH_OPTIONS" \
1266 "${options:+-o $options}" "$zroot_name$dataset" ||
1271 # Set a mountpoint for the root of the pool so newly created datasets
1272 # have a mountpoint to inherit
1274 f_dprintf "$funcname: Setting mountpoint for root of the pool..."
1275 f_eval_catch $funcname zfs "$ZFS_SET" \
1276 "mountpoint=/$zroot_name" "$zroot_name" ||
1279 # Touch up permissions on the tmp directories
1280 f_dprintf "$funcname: Modifying directory permissions..."
1282 for dir in /tmp /var/tmp; do
1283 f_eval_catch $funcname chmod "$CHMOD_MODE" 1777 \
1284 $BSDINSTALL_CHROOT$dir || return $FAILURE
1288 if [ "$ZFSBOOT_BOOT_POOL" ]; then
1289 f_dprintf "$funcname: Creating /boot symlink for boot pool..."
1290 f_eval_catch $funcname ln "$LN_SF" "$bootpool_name/boot" \
1291 $BSDINSTALL_CHROOT/boot || return $FAILURE
1294 # Set bootfs property
1295 local zroot_bootfs="$ZFSBOOT_BEROOT_NAME/$ZFSBOOT_BOOTFS_NAME"
1296 f_dprintf "$funcname: Setting bootfs property..."
1297 f_eval_catch $funcname zpool "$ZPOOL_SET" \
1298 "bootfs=\"$zroot_name/$zroot_bootfs\"" "$zroot_name" ||
1301 # Export the pool(s)
1302 f_dprintf "$funcname: Temporarily exporting ZFS pool(s)..."
1303 f_eval_catch $funcname zpool "$ZPOOL_EXPORT" "$zroot_name" ||
1305 if [ "$ZFSBOOT_BOOT_POOL" ]; then
1306 f_eval_catch $funcname zpool "$ZPOOL_EXPORT" \
1307 "$bootpool_name" || return $FAILURE
1310 # MBR boot loader touch-up
1311 if [ "$ZFSBOOT_PARTITION_SCHEME" = "MBR" ]; then
1312 f_dprintf "$funcname: Updating MBR boot loader on disks..."
1313 # Stick the ZFS boot loader in the "convienient hole" after
1314 # the ZFS internal metadata
1315 for disk in $disks; do
1316 f_eval_catch $funcname dd "$DD_WITH_OPTIONS" \
1317 /boot/zfsboot /dev/$disk$bootpart \
1318 "skip=1 seek=1024" || return $FAILURE
1322 # Re-import the ZFS pool(s)
1323 f_dprintf "$funcname: Re-importing ZFS pool(s)..."
1324 f_eval_catch $funcname zpool "$ZPOOL_IMPORT_WITH_OPTIONS" \
1325 "-o altroot=\"$BSDINSTALL_CHROOT\"" "$zroot_name" ||
1327 if [ "$ZFSBOOT_BOOT_POOL" ]; then
1328 f_eval_catch $funcname zpool "$ZPOOL_IMPORT_WITH_OPTIONS" \
1329 "-o altroot=\"$BSDINSTALL_CHROOT\"" \
1330 "$bootpool_name" || return $FAILURE
1333 # While this is apparently not needed, it seems to help MBR
1334 f_dprintf "$funcname: Configuring zpool.cache for zroot..."
1335 f_eval_catch $funcname mkdir "$MKDIR_P" $BSDINSTALL_CHROOT/boot/zfs ||
1337 f_eval_catch $funcname zpool "$ZPOOL_SET" \
1338 "cachefile=\"$BSDINSTALL_CHROOT/boot/zfs/zpool.cache\"" \
1339 "$zroot_name" || return $FAILURE
1341 # Last, but not least... required lines for rc.conf(5)/loader.conf(5)
1342 # NOTE: We later concatenate these into their destination
1343 f_dprintf "%s: Configuring rc.conf(5)/loader.conf(5) additions..." \
1345 f_eval_catch $funcname echo "$ECHO_APPEND" 'zfs_enable=\"YES\"' \
1346 $BSDINSTALL_TMPETC/rc.conf.zfs || return $FAILURE
1347 f_eval_catch $funcname echo "$ECHO_APPEND" \
1348 'kern.geom.label.gptid.enable=\"0\"' \
1349 $BSDINSTALL_TMPBOOT/loader.conf.zfs || return $FAILURE
1351 if [ "$ZFSBOOT_SWAP_MIRROR" ]; then
1352 f_eval_catch $funcname echo "$ECHO_APPEND" \
1353 'geom_mirror_load=\"YES\"' \
1354 $BSDINSTALL_TMPBOOT/loader.conf.gmirror ||
1358 # We're all done unless we should go on for boot pool
1359 [ "$ZFSBOOT_BOOT_POOL" ] || return $SUCCESS
1361 # Set cachefile for boot pool so it auto-imports at system start
1362 f_dprintf "$funcname: Configuring zpool.cache for boot pool..."
1363 f_eval_catch $funcname zpool "$ZPOOL_SET" \
1364 "cachefile=\"$BSDINSTALL_CHROOT/boot/zfs/zpool.cache\"" \
1365 "$bootpool_name" || return $FAILURE
1367 # Some additional geli(8) requirements for loader.conf(5)
1369 'zpool_cache_load=\"YES\"' \
1370 'zpool_cache_type=\"/boot/zfs/zpool.cache\"' \
1371 'zpool_cache_name=\"/boot/zfs/zpool.cache\"' \
1373 f_eval_catch $funcname echo "$ECHO_APPEND" "$option" \
1374 $BSDINSTALL_TMPBOOT/loader.conf.zfs ||
1377 f_eval_catch $funcname printf "$PRINTF_CONF" vfs.root.mountfrom \
1378 "\"zfs:$zroot_name/$zroot_bootfs\"" \
1379 $BSDINSTALL_TMPBOOT/loader.conf.root || return $FAILURE
1381 # We're all done unless we should go on to do encryption
1382 [ "$ZFSBOOT_GELI_ENCRYPTION" ] || return $SUCCESS
1385 # Configure geli(8)-based encryption
1387 f_dprintf "$funcname: Configuring disk encryption..."
1388 f_eval_catch $funcname echo "$ECHO_APPEND" 'aesni_load=\"YES\"' \
1389 $BSDINSTALL_TMPBOOT/loader.conf.aesni || return $FAILURE
1390 f_eval_catch $funcname echo "$ECHO_APPEND" 'geom_eli_load=\"YES\"' \
1391 $BSDINSTALL_TMPBOOT/loader.conf.geli || return $FAILURE
1392 f_eval_catch $funcname echo "$ECHO_APPEND" \
1393 'geom_eli_passphrase_prompt=\"YES\"' \
1394 $BSDINSTALL_TMPBOOT/loader.conf.geli || return $FAILURE
1395 for disk in $disks; do
1396 f_eval_catch $funcname printf "$PRINTF_CONF" \
1397 geli_%s_keyfile0_load "$disk$targetpart YES" \
1398 $BSDINSTALL_TMPBOOT/loader.conf.$disk$targetpart ||
1400 f_eval_catch $funcname printf "$PRINTF_CONF" \
1401 geli_%s_keyfile0_type \
1402 "$disk$targetpart $disk$targetpart:geli_keyfile0" \
1403 $BSDINSTALL_TMPBOOT/loader.conf.$disk$targetpart ||
1405 f_eval_catch $funcname printf "$PRINTF_CONF" \
1406 geli_%s_keyfile0_name \
1407 "$disk$targetpart \"$ZFSBOOT_GELI_KEY_FILE\"" \
1408 $BSDINSTALL_TMPBOOT/loader.conf.$disk$targetpart ||
1415 # dialog_menu_diskinfo
1417 # Prompt the user to select a disk and then provide detailed info on it.
1419 dialog_menu_diskinfo()
1424 # Break from loop when user cancels disk selection
1427 device=$( msg_cancel="$msg_back" f_device_menu \
1428 "$DIALOG_TITLE" "$msg_select_a_disk_device" "" \
1429 $DEVICE_TYPE_DISK 2>&1 ) || break
1430 $device get name disk
1432 # Show gpart(8) `show' and camcontrol(8) `inquiry' data
1433 f_show_msg "$msg_detailed_disk_info" \
1434 "$disk" "$( gpart show $disk 2> /dev/null )" \
1435 "$disk" "$( camcontrol inquiry $disk 2> /dev/null )" \
1436 "$disk" "$( camcontrol identify $disk 2> /dev/null )"
1442 ############################################################ MAIN
1447 f_dialog_title "$msg_zfs_configuration"
1448 f_dialog_backtitle "$msg_freebsd_installer"
1450 # User may have specifically requested ZFS-related operations be interactive
1451 ! f_interactive && f_zfsinteractive && unset $VAR_NONINTERACTIVE
1456 f_dprintf "BSDINSTALL_CHROOT=[%s]" "$BSDINSTALL_CHROOT"
1457 f_dprintf "BSDINSTALL_TMPETC=[%s]" "$BSDINSTALL_TMPETC"
1458 f_dprintf "FSTAB_FMT=[%s]" "$FSTAB_FMT"
1461 # If the system was booted with UEFI, warn the user that FreeBSD can't do
1464 if f_interactive; then
1465 bootmethod=$( sysctl -n machdep.bootmethod )
1466 f_dprintf "machdep.bootmethod=[%s]" "$bootmethod"
1467 if [ "$bootmethod" != "BIOS" ]; then
1470 f_dprintf "uefi_prompt=[%s]" "$retval"
1471 [ $retval -eq $DIALOG_OK ] || f_die
1476 # Loop over the main menu until we've accomplished what we came here to do
1479 if ! f_interactive; then
1481 mtag=">>> $msg_install"
1485 f_dialog_menutag_fetch mtag
1488 f_dprintf "retval=%u mtag=[%s]" $retval "$mtag"
1489 [ $retval -eq $DIALOG_OK ] || f_die
1494 # First, validate the user's selections
1497 # Make sure they gave us a name for the pool
1498 if [ ! "$ZFSBOOT_POOL_NAME" ]; then
1499 f_dprintf "Pool name cannot be empty."
1500 f_show_err "$msg_pool_name_cannot_be_empty"
1504 # Validate vdev type against number of disks selected/scripted
1505 # (also validates that ZFSBOOT_DISKS are real [probed] disks)
1506 # NB: dialog_menu_layout supports running non-interactively
1507 dialog_menu_layout || continue
1509 # Make sure each disk will be at least 50% ZFS
1510 if f_expand_number "$ZFSBOOT_SWAP_SIZE" swapsize &&
1511 f_expand_number "$ZFSBOOT_BOOT_POOL_SIZE" bootsize
1513 minsize=$swapsize teeny_disks=
1514 [ "$ZFSBOOT_BOOT_POOL" ] &&
1515 minsize=$(( $minsize + $bootsize ))
1516 for disk in $ZFSBOOT_DISKS; do
1517 debug= f_device_find -1 \
1518 $disk $DEVICE_TYPE_DISK device
1519 $device get capacity disksize || continue
1520 [ ${disksize:-0} -ge 0 ] || disksize=0
1521 disksize=$(( $disksize - $minsize ))
1522 [ $disksize -lt $minsize ] &&
1523 teeny_disks="$teeny_disks $disk"
1525 if [ "$teeny_disks" ]; then
1526 f_dprintf "swapsize=[%s] bootsize[%s] %s" \
1527 "$ZFSBOOT_SWAP_SIZE" \
1528 "$ZFSBOOT_BOOT_POOL_SIZE" \
1529 "minsize=[$minsize]"
1530 f_dprintf "These disks are too small: %s" \
1532 f_show_err "$msg_these_disks_are_too_small" \
1533 "$ZFSBOOT_SWAP_SIZE" \
1534 "$ZFSBOOT_BOOT_POOL_SIZE" \
1543 if f_interactive; then
1544 dialog_last_chance $ZFSBOOT_DISKS || continue
1551 vdev_type="$ZFSBOOT_VDEV_TYPE"
1553 # Blank the vdev type for the default layout
1554 [ "$vdev_type" = "stripe" ] && vdev_type=
1556 zfs_create_boot "$ZFSBOOT_POOL_NAME" \
1557 "$vdev_type" $ZFSBOOT_DISKS || continue
1561 ?" $msg_pool_type_disks")
1562 ZFSBOOT_CONFIRM_LAYOUT=1
1564 # User has poked settings, disable later confirmation
1565 ZFSBOOT_CONFIRM_LAYOUT=
1567 "- $msg_rescan_devices") f_device_rescan ;;
1568 "- $msg_disk_info") dialog_menu_diskinfo ;;
1570 # Prompt the user to input/change the name for the new pool
1571 f_dialog_input input \
1572 "$msg_please_enter_a_name_for_your_zpool" \
1573 "$ZFSBOOT_POOL_NAME" &&
1574 ZFSBOOT_POOL_NAME="$input"
1576 ?" $msg_force_4k_sectors")
1577 # Toggle the variable referenced both by the menu and later
1578 if [ "$ZFSBOOT_FORCE_4K_SECTORS" ]; then
1579 ZFSBOOT_FORCE_4K_SECTORS=
1581 ZFSBOOT_FORCE_4K_SECTORS=1
1584 ?" $msg_encrypt_disks")
1585 # Toggle the variable referenced both by the menu and later
1586 if [ "$ZFSBOOT_GELI_ENCRYPTION" ]; then
1587 ZFSBOOT_GELI_ENCRYPTION=
1589 ZFSBOOT_FORCE_4K_SECTORS=1
1590 ZFSBOOT_GELI_ENCRYPTION=1
1593 ?" $msg_partition_scheme")
1594 # Toggle between GPT and MBR
1595 if [ "$ZFSBOOT_PARTITION_SCHEME" = GPT ]; then
1596 ZFSBOOT_PARTITION_SCHEME=MBR
1597 elif [ "$ZFSBOOT_PARTITION_SCHEME" = MBR ]; then
1598 ZFSBOOT_PARTITION_SCHEME="GPT + Active"
1599 elif [ "$ZFSBOOT_PARTITION_SCHEME" = "GPT + Active" ]; then
1600 ZFSBOOT_PARTITION_SCHEME="GPT + Lenovo Fix"
1602 ZFSBOOT_PARTITION_SCHEME=GPT
1606 # Prompt the user to input/change the swap size for each disk
1608 f_dialog_input input \
1609 "$msg_please_enter_amount_of_swap_space" \
1610 "$ZFSBOOT_SWAP_SIZE" &&
1611 ZFSBOOT_SWAP_SIZE="${input:-0}"
1612 if f_expand_number "$ZFSBOOT_SWAP_SIZE" swapsize
1614 if [ $swapsize -ne 0 -a $swapsize -lt 104857600 ]; then
1615 f_show_err "$msg_swap_toosmall" \
1616 "$ZFSBOOT_SWAP_SIZE"
1622 f_show_err "$msg_swap_invalid" \
1623 "$ZFSBOOT_SWAP_SIZE"
1628 ?" $msg_swap_mirror")
1629 # Toggle the variable referenced both by the menu and later
1630 if [ "$ZFSBOOT_SWAP_MIRROR" ]; then
1631 ZFSBOOT_SWAP_MIRROR=
1633 ZFSBOOT_SWAP_MIRROR=1
1636 ?" $msg_swap_encrypt")
1637 # Toggle the variable referenced both by the menu and later
1638 if [ "$ZFSBOOT_SWAP_ENCRYPTION" ]; then
1639 ZFSBOOT_SWAP_ENCRYPTION=
1641 ZFSBOOT_SWAP_ENCRYPTION=1
1649 ################################################################################
1651 ################################################################################