3 # Copyright (c) 2013 Allan Jude
4 # Copyright (c) 2013 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 name for the boot environment parent dataset
50 : ${ZFSBOOT_BEROOT_NAME:=ROOT}
53 # Default name for the primany boot environment
55 : ${ZFSBOOT_BOOTFS_NAME:=default}
58 # Default Virtual Device (vdev) type to create
60 : ${ZFSBOOT_VDEV_TYPE:=stripe}
63 # Should we use gnop(8) to configure a transparent mapping to 4K sectors?
65 : ${ZFSBOOT_GNOP_4K_FORCE_ALIGN:=1}
68 # Should we use geli(8) to encrypt the drives?
69 # NB: Automatically enables ZFSBOOT_BOOT_POOL
71 : ${ZFSBOOT_GELI_ENCRYPTION=}
74 # Default path to the geli(8) keyfile used in drive encryption
76 : ${ZFSBOOT_GELI_KEY_FILE:=/boot/encryption.key}
79 # Create a separate boot pool?
80 # NB: Automatically set when using geli(8) or MBR
82 : ${ZFSBOOT_BOOT_POOL=}
85 # Default name for boot pool when enabled (e.g., geli(8) or MBR)
87 : ${ZFSBOOT_BOOT_POOL_NAME:=bootpool}
90 # Default size for boot pool when enabled (e.g., geli(8) or MBR)
92 : ${ZFSBOOT_BOOT_POOL_SIZE:=2g}
95 # Default disks to use (always empty unless being scripted)
100 # Default partitioning scheme to use on disks
102 : ${ZFSBOOT_PARTITION_SCHEME:=GPT}
105 # How much swap to put on each block device in the boot zpool
106 # NOTE: Value passed to gpart(8); which supports SI unit suffixes.
108 : ${ZFSBOOT_SWAP_SIZE:=2g}
111 # Default ZFS datasets for root zpool
113 # NOTE: Requires /tmp, /var/tmp, /$ZFSBOOT_BOOTFS_NAME/$ZFSBOOT_BOOTFS_NAME
114 # NOTE: Anything after pound/hash character [#] is ignored as a comment.
116 f_isset ZFSBOOT_DATASETS || ZFSBOOT_DATASETS="
117 # DATASET OPTIONS (comma or space separated; or both)
119 # Boot Environment [BE] root and default boot dataset
120 /$ZFSBOOT_BEROOT_NAME mountpoint=none
121 /$ZFSBOOT_BEROOT_NAME/$ZFSBOOT_BOOTFS_NAME mountpoint=/
123 # Compress /tmp, allow exec but not setuid
124 /tmp mountpoint=/tmp,compression=lz4,exec=on,setuid=off
126 # Don't mount /usr so that 'base' files go to the BEROOT
127 /usr mountpoint=/usr,canmount=off
129 # Home directories separated so they are common to all BEs
130 /usr/home # NB: /home is a symlink to /usr/home
133 /usr/ports compression=lz4,setuid=off
135 # Source tree (compressed)
136 /usr/src compression=lz4,exec=off,setuid=off
138 # Create /var and friends
140 /var/crash compression=lz4,exec=off,setuid=off
141 /var/log compression=lz4,exec=off,setuid=off
142 /var/mail compression=lz4,atime=on
143 /var/tmp compression=lz4,exec=on,setuid=off
147 # If interactive and the user has not explicitly chosen a vdev type or disks,
148 # make the user confirm scripted/default choices when proceeding to install.
150 : ${ZFSBOOT_CONFIRM_LAYOUT:=1}
152 ############################################################ GLOBALS
155 # Format of a line in printf(1) syntax to add to fstab(5)
157 FSTAB_FMT="%s\t\t%s\t%s\t%s\t\t%s\t%s\n"
160 # Command strings for various tasks
162 CHMOD_MODE='chmod %s "%s"'
163 DD_WITH_OPTIONS='dd if="%s" of="%s" %s'
164 ECHO_APPEND='echo "%s" >> "%s"'
165 GELI_ATTACH='geli attach -j - -k "%s" "%s"'
166 GELI_DETACH_F='geli detach -f "%s"'
167 GELI_PASSWORD_INIT='geli init -b -B "%s" -e %s -J - -K "%s" -l 256 -s 4096 "%s"'
168 GNOP_CREATE='gnop create -S 4096 "%s"'
169 GNOP_DESTROY='gnop destroy "%s"'
170 GPART_ADD='gpart add -t %s "%s"'
171 GPART_ADD_INDEX='gpart add -i %s -t %s "%s"'
172 GPART_ADD_INDEX_WITH_SIZE='gpart add -i %s -t %s -s %s "%s"'
173 GPART_ADD_LABEL='gpart add -l %s -t %s "%s"'
174 GPART_ADD_LABEL_WITH_SIZE='gpart add -l %s -t %s -s %s "%s"'
175 GPART_BOOTCODE='gpart bootcode -b "%s" "%s"'
176 GPART_BOOTCODE_PART='gpart bootcode -b "%s" -p "%s" -i %s "%s"'
177 GPART_CREATE='gpart create -s %s "%s"'
178 GPART_DESTROY_F='gpart destroy -F "%s"'
179 GPART_SET_ACTIVE='gpart set -a active -i %s "%s"'
180 GRAID_DELETE='graid delete "%s"'
181 LN_SF='ln -sf "%s" "%s"'
182 MKDIR_P='mkdir -p "%s"'
183 MOUNT_TYPE='mount -t %s "%s" "%s"'
184 PRINTF_CONF="printf '%s=\"%%s\"\\\n' %s >> \"%s\""
185 PRINTF_FSTAB='printf "$FSTAB_FMT" "%s" "%s" "%s" "%s" "%s" "%s" >> "%s"'
186 SHELL_TRUNCATE=':> "%s"'
188 ZFS_CREATE_WITH_OPTIONS='zfs create %s "%s"'
189 ZFS_SET='zfs set "%s" "%s"'
190 ZFS_UNMOUNT='zfs unmount "%s"'
191 ZPOOL_CREATE_WITH_OPTIONS='zpool create %s "%s" %s %s'
192 ZPOOL_DESTROY='zpool destroy "%s"'
193 ZPOOL_EXPORT='zpool export "%s"'
194 ZPOOL_IMPORT_WITH_OPTIONS='zpool import %s "%s"'
195 ZPOOL_LABELCLEAR_F='zpool labelclear -f "%s"'
196 ZPOOL_SET='zpool set %s "%s"'
199 # Strings that should be moved to an i18n file and loaded with f_include_lang()
201 hline_alnum_arrows_punc_tab_enter="Use alnum, arrows, punctuation, TAB or ENTER"
202 hline_arrows_space_tab_enter="Use arrows, SPACE, TAB or ENTER"
203 hline_arrows_tab_enter="Press arrows, TAB or ENTER"
204 msg_an_unknown_error_occurred="An unknown error occurred"
207 msg_change_selection="Change Selection"
208 msg_configure_options="Configure Options:"
209 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"
210 msg_disk_info="Disk Info"
211 msg_disk_info_help="Get detailed information on disk device(s)"
212 msg_encrypt_disks="Encrypt Disks?"
213 msg_encrypt_disks_help="Use geli(8) to encrypt all data partitions"
215 msg_force_4k_sectors="Force 4K Sectors?"
216 msg_force_4k_sectors_help="Use gnop(8) to configure forced 4K sector alignment"
217 msg_freebsd_installer="FreeBSD Installer"
218 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"
219 msg_geli_setup="Initializing encryption on selected disks,\n this will take several seconds per disk"
220 msg_install="Install"
221 msg_install_desc="Proceed with Installation"
222 msg_install_help="Create ZFS boot pool with displayed options"
223 msg_invalid_boot_pool_size="Invalid boot pool size \`%s'"
224 msg_invalid_disk_argument="Invalid disk argument \`%s'"
225 msg_invalid_index_argument="Invalid index argument \`%s'"
226 msg_invalid_swap_size="Invalid swap size \`%s'"
227 msg_invalid_virtual_device_type="Invalid Virtual Device type \`%s'"
228 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"
229 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'
230 msg_mirror_desc="Mirror - n-Way Mirroring"
231 msg_mirror_help="[2+ Disks] Mirroring provides the best performance, but the least storage"
232 msg_missing_disk_arguments="missing disk arguments"
233 msg_missing_one_or_more_scripted_disks="Missing one or more scripted disks!"
235 msg_no_disks_present_to_configure="No disk(s) present to configure"
236 msg_no_disks_selected="No disks selected."
237 msg_not_enough_disks_selected="Not enough disks selected. (%u < %u minimum)"
238 msg_null_disk_argument="NULL disk argument"
239 msg_null_index_argument="NULL index argument"
240 msg_null_poolname="NULL poolname"
242 msg_partition_scheme="Partition Scheme"
243 msg_partition_scheme_help="Toggle between GPT and MBR partitioning schemes"
244 msg_please_enter_a_name_for_your_zpool="Please enter a name for your zpool:"
245 msg_please_enter_amount_of_swap_space="Please enter amount of swap space (SI-Unit suffixes\nrecommended; e.g., \`2g' for 2 Gigabytes):"
246 msg_please_select_one_or_more_disks="Please select one or more disks to create a zpool:"
247 msg_pool_name="Pool Name"
248 msg_pool_name_cannot_be_empty="Pool name cannot be empty."
249 msg_pool_name_help="Customize the name of the zpool to be created (Required)"
250 msg_pool_type_disks="Pool Type/Disks:"
251 msg_pool_type_disks_help="Choose type of ZFS Virtual Device and disks to use (Required)"
252 msg_processing_selection="Processing selection..."
253 msg_raidz1_desc="RAID-Z1 - Single Redundant RAID"
254 msg_raidz1_help="[3+ Disks] Withstand failure of 1 disk. Recommended for: 3, 5 or 9 disks"
255 msg_raidz2_desc="RAID-Z2 - Double Redundant RAID"
256 msg_raidz2_help="[4+ Disks] Withstand failure of 2 disks. Recommended for: 4, 6 or 10 disks"
257 msg_raidz3_desc="RAID-Z3 - Triple Redundant RAID"
258 msg_raidz3_help="[5+ Disks] Withstand failure of 3 disks. Recommended for: 5, 7 or 11 disks"
259 msg_rescan_devices="Rescan Devices"
260 msg_rescan_devices_help="Scan for device changes"
262 msg_select_a_disk_device="Select a disk device"
263 msg_select_virtual_device_type="Select Virtual Device type:"
264 msg_stripe_desc="Stripe - No Redundancy"
265 msg_stripe_help="[1+ Disks] Striping provides maximum storage but no redundancy"
266 msg_swap_size="Swap Size"
267 msg_swap_size_help="Customize how much swap space is allocated to each selected disk"
268 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."
269 msg_unable_to_get_disk_capacity="Unable to get disk capacity of \`%s'"
270 msg_unsupported_partition_scheme="%s is an unsupported partition scheme"
271 msg_user_cancelled="User Cancelled."
273 msg_zfs_configuration="ZFS Configuration"
275 ############################################################ FUNCTIONS
279 # Display the dialog(1)-based application main menu.
283 local title="$DIALOG_TITLE"
284 local btitle="$DIALOG_BACKTITLE"
285 local prompt="$msg_configure_options"
286 local force4k="$msg_no"
287 local usegeli="$msg_no"
288 [ "$ZFSBOOT_GNOP_4K_FORCE_ALIGN" ] && force4k="$msg_yes"
289 [ "$ZFSBOOT_GELI_ENCRYPTION" ] && usegeli="$msg_yes"
291 f_count n $ZFSBOOT_DISKS
292 { [ $n -eq 1 ] && disks=disk; } || disks=disks # grammar
294 '>>> $msg_install' '$msg_install_desc'
296 'T $msg_pool_type_disks' '$ZFSBOOT_VDEV_TYPE: $n $disks'
297 '$msg_pool_type_disks_help'
298 '- $msg_rescan_devices' '*'
299 '$msg_rescan_devices_help'
300 '- $msg_disk_info' '*'
301 '$msg_disk_info_help'
302 'N $msg_pool_name' '$ZFSBOOT_POOL_NAME'
303 '$msg_pool_name_help'
304 '4 $msg_force_4k_sectors' '$force4k'
305 '$msg_force_4k_sectors_help'
306 'E $msg_encrypt_disks' '$usegeli'
307 '$msg_encrypt_disks_help'
308 'P $msg_partition_scheme' '$ZFSBOOT_PARTITION_SCHEME'
309 '$msg_partition_scheme_help'
310 'S $msg_swap_size' '$ZFSBOOT_SWAP_SIZE'
311 '$msg_swap_size_help'
313 local defaultitem= # Calculated below
314 local hline="$hline_alnum_arrows_punc_tab_enter"
316 local height width rows
317 eval f_dialog_menu_with_help_size height width rows \
318 \"\$title\" \"\$btitle\" \"\$prompt\" \"\$hline\" $menu_list
320 # Obtain default-item from previously stored selection
321 f_dialog_default_fetch defaultitem
324 menu_choice=$( eval $DIALOG \
325 --title \"\$title\" \
326 --backtitle \"\$btitle\" \
327 --hline \"\$hline\" \
329 --ok-label \"\$msg_select\" \
330 --cancel-label \"\$msg_cancel\" \
331 --default-item \"\$defaultitem\" \
332 --menu \"\$prompt\" \
333 $height $width $rows \
335 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD
338 f_dialog_data_sanitize menu_choice
339 f_dialog_menutag_store "$menu_choice"
341 # Only update default-item on success
342 [ $retval -eq $DIALOG_OK ] && f_dialog_default_store "$menu_choice"
347 # dialog_last_chance $disks ...
349 # Display a list of the disks that the user is about to destroy. The default
350 # action is to return error status unless the user explicitly (non-default)
351 # selects "Yes" from the noyes dialog.
355 local title="$DIALOG_TITLE"
356 local btitle="$DIALOG_BACKTITLE"
357 local prompt # Calculated below
358 local hline="$hline_arrows_tab_enter"
360 local height=8 width=50 prefix=" "
361 local plen=${#prefix} list= line=
362 local max_width=$(( $width - 3 - $plen ))
364 local yes no defaultno extra_args format
365 if [ "$USE_XDIALOG" ]; then
366 yes=ok no=cancel defaultno=default-no
367 extra_args="--wrap --left"
368 format="$msg_last_chance_are_you_sure"
370 yes=yes no=no defaultno=defaultno
371 extra_args="--colors --cr-wrap"
372 format="$msg_last_chance_are_you_sure_color"
375 local disk line_width
382 line_width=$(( $line_width + 1 + ${#disk} ))
383 # Add newline before disk if it would exceed max_width
384 if [ $line_width -gt $max_width ]; then
387 height=$(( $height + 1 ))
389 # Add the disk to the list
392 # Append the left-overs
393 if [ "${line#$prefix}" ]; then
395 height=$(( $height + 1 ))
398 # Add height for Xdialog(1)
399 [ "$USE_XDIALOG" ] && height=$(( $height + $height / 5 + 3 ))
401 prompt=$( printf "$format" "$list" )
402 f_dprintf "%s: Last Chance!" "$0"
405 --backtitle "$btitle" \
408 --$yes-label "$msg_yes" \
409 --$no-label "$msg_no" \
411 --yesno "$prompt" $height $width
416 # Configure Virtual Device type and disks to use for the ZFS boot pool. User
417 # must select enough disks to satisfy the chosen vdev type.
421 local funcname=dialog_menu_layout
422 local title="$DIALOG_TITLE"
423 local btitle="$DIALOG_BACKTITLE"
424 local vdev_prompt="$msg_select_virtual_device_type"
425 local disk_prompt="$msg_please_select_one_or_more_disks"
426 local vdev_menu_list="
427 'stripe' '$msg_stripe_desc' '$msg_stripe_help'
428 'mirror' '$msg_mirror_desc' '$msg_mirror_help'
429 'raidz1' '$msg_raidz1_desc' '$msg_raidz1_help'
430 'raidz2' '$msg_raidz2_desc' '$msg_raidz2_help'
431 'raidz3' '$msg_raidz3_desc' '$msg_raidz3_help'
433 local disk_check_list= # Calculated below
434 local vdev_hline="$hline_arrows_tab_enter"
435 local disk_hline="$hline_arrows_space_tab_enter"
437 # Warn the user if vdev type is not valid
438 case "$ZFSBOOT_VDEV_TYPE" in
439 stripe|mirror|raidz1|raidz2|raidz3) : known good ;;
441 f_dprintf "%s: Invalid virtual device type \`%s'" \
442 $funcname "$ZFSBOOT_VDEV_TYPE"
443 f_show_err "$msg_invalid_virtual_device_type" \
445 f_interactive || return $FAILURE
448 # Calculate size of vdev menu once only
449 local vheight vwidth vrows
450 eval f_dialog_menu_with_help_size vheight vwidth vrows \
451 \"\$title\" \"\$btitle\" \"\$vdev_prompt\" \"\$vdev_hline\" \
454 # Get a list of probed disk devices
456 debug= f_device_find "" $DEVICE_TYPE_DISK disks
458 # Prune out mounted md(4) devices that may be part of the boot process
459 local disk name new_list=
460 for disk in $disks; do
461 debug= $disk get name name
463 md[0-9]*) f_mounted -b "/dev/$name" && continue ;;
465 new_list="$new_list $disk"
467 disks="${new_list# }"
470 if [ "$debug" ]; then
472 for disk in $disks; do
473 debug= $disk get name name
474 disk_names="$disk_names $name"
476 f_dprintf "$funcname: disks=[%s]" "${disk_names# }"
479 if [ ! "$disks" ]; then
480 f_dprintf "No disk(s) present to configure"
481 f_show_err "$msg_no_disks_present_to_configure"
485 # Lets sort the disks array to be more user friendly
486 f_device_sort_by name disks disks
489 # Operate in a loop so we can (if interactive) repeat if not enough
490 # disks are selected to satisfy the chosen vdev type or user wants to
491 # back-up to the previous menu.
493 local vardisk ndisks onoff selections vdev_choice breakout device
494 local valid_disks all_valid want_disks desc height width rows
497 # Confirm the vdev type that was selected
499 if f_interactive && [ "$ZFSBOOT_CONFIRM_LAYOUT" ]; then
500 vdev_choice=$( eval $DIALOG \
501 --title \"\$title\" \
502 --backtitle \"\$btitle\" \
503 --hline \"\$vdev_hline\" \
504 --ok-label \"\$msg_ok\" \
505 --cancel-label \"\$msg_cancel\" \
507 --default-item \"\$ZFSBOOT_VDEV_TYPE\" \
508 --menu \"\$vdev_prompt\" \
509 $vheight $vwidth $vrows \
511 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD
513 # Exit if user pressed ESC or chose Cancel/No
514 f_dialog_data_sanitize vdev_choice
516 ZFSBOOT_VDEV_TYPE="$vdev_choice"
517 f_dprintf "$funcname: ZFSBOOT_VDEV_TYPE=[%s]" \
521 # Determine the number of disks needed for this vdev type
523 case "$ZFSBOOT_VDEV_TYPE" in
524 stripe) want_disks=1 ;;
525 mirror) want_disks=2 ;;
526 raidz1) want_disks=3 ;;
527 raidz2) want_disks=4 ;;
528 raidz3) want_disks=5 ;;
532 # Warn the user if any scripted disks are invalid
534 valid_disks= all_valid=${ZFSBOOT_DISKS:+1} # optimism
535 for disk in $ZFSBOOT_DISKS; do
536 if debug= f_device_find -1 \
537 $disk $DEVICE_TYPE_DISK device
539 valid_disks="$valid_disks $disk"
542 f_dprintf "$funcname: \`%s' is not a real disk" "$disk"
545 if [ ! "$all_valid" ]; then
546 if [ "$ZFSBOOT_DISKS" ]; then
548 "$msg_missing_one_or_more_scripted_disks"
550 f_dprintf "No disks selected."
552 f_show_err "$msg_no_disks_selected"
554 f_interactive || return $FAILURE
556 ZFSBOOT_DISKS="${valid_disks# }"
559 # Short-circuit if we're running non-interactively
561 if ! f_interactive || [ ! "$ZFSBOOT_CONFIRM_LAYOUT" ]; then
562 f_count ndisks $ZFSBOOT_DISKS
563 [ $ndisks -ge $want_disks ] && break # to success
565 # Not enough disks selected
566 f_dprintf "$funcname: %s: %s (%u < %u minimum)" \
567 "$ZFSBOOT_VDEV_TYPE" \
568 "Not enough disks selected." \
570 f_interactive || return $FAILURE
571 msg_yes="$msg_change_selection" msg_no="$msg_cancel" \
572 f_yesno "%s: $msg_not_enough_disks_selected" \
573 "$ZFSBOOT_VDEV_TYPE" $ndisks $want_disks ||
578 # Confirm the disks that were selected
579 # Loop until the user cancels or selects enough disks
583 # Loop over list of available disks, resetting state
584 for disk in $disks; do
585 f_isset _${disk}_status && _${disk}_status=
588 # Loop over list of selected disks and create temporary
589 # locals to map statuses onto up-to-date list of disks
590 for disk in $ZFSBOOT_DISKS; do
591 debug= f_device_find -1 \
592 $disk $DEVICE_TYPE_DISK disk
593 f_isset _${disk}_status ||
594 local _${disk}_status
598 # Create the checklist menu of discovered disk devices
600 for disk in $disks; do
604 f_shell_escape "$desc" desc
605 f_getvar _${disk}_status:-off onoff
606 disk_check_list="$disk_check_list
607 $name '$desc' $onoff"
610 eval f_dialog_checklist_size height width rows \
611 \"\$title\" \"\$btitle\" \"\$prompt\" \
612 \"\$hline\" $disk_check_list
614 selections=$( eval $DIALOG \
615 --title \"\$DIALOG_TITLE\" \
616 --backtitle \"\$DIALOG_BACKTITLE\" \
618 --hline \"\$hline\" \
619 --ok-label \"\$msg_ok\" \
620 --cancel-label \"\$msg_back\" \
621 --checklist \"\$prompt\" \
622 $height $width $rows \
624 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD
626 # Loop if user pressed ESC or chose Cancel/No
627 f_dialog_data_sanitize selections
629 ZFSBOOT_DISKS="$selections"
630 f_dprintf "$funcname: ZFSBOOT_DISKS=[%s]" \
633 f_count ndisks $ZFSBOOT_DISKS
634 [ $ndisks -ge $want_disks ] &&
635 breakout=break && break
637 # Not enough disks selected
638 f_dprintf "$funcname: %s: %s (%u < %u minimum)" \
639 "$ZFSBOOT_VDEV_TYPE" \
640 "Not enough disks selected." \
642 msg_yes="$msg_change_selection" msg_no="$msg_cancel" \
643 f_yesno "%s: $msg_not_enough_disks_selected" \
644 "$ZFSBOOT_VDEV_TYPE" $ndisks $want_disks ||
647 [ "$breakout" = "break" ] && break
648 [ "$ZFSBOOT_CONFIRM_LAYOUT" ] || return $FAILURE
654 # zfs_create_diskpart $disk $index
656 # For each block device to be used in the zpool, rather than just create the
657 # zpool with the raw block devices (e.g., da0, da1, etc.) we create partitions
658 # so we can have some real swap. This also provides wiggle room incase your
659 # replacement drivers do not have the exact same sector counts.
661 # NOTE: $swapsize and $bootsize should be defined by the calling function.
662 # NOTE: Sets $bootpart and $targetpart for the calling function.
664 zfs_create_diskpart()
666 local funcname=zfs_create_diskpart
667 local disk="$1" index="$2"
670 if [ ! "$disk" ]; then
671 f_dprintf "$funcname: NULL disk argument"
672 msg_error="$msg_error: $funcname" \
673 f_show_err "$msg_null_disk_argument"
676 if [ "${disk#*[$IFS]}" != "$disk" ]; then
677 f_dprintf "$funcname: Invalid disk argument \`%s'" "$disk"
678 msg_error="$msg_error: $funcname" \
679 f_show_err "$msg_invalid_disk_argument" "$disk"
682 if [ ! "$index" ]; then
683 f_dprintf "$funcname: NULL index argument"
684 msg_error="$msg_error: $funcname" \
685 f_show_err "$msg_null_index_argument"
688 if ! f_isinteger "$index"; then
689 f_dprintf "$funcname: Invalid index argument \`%s'" "$index"
690 msg_error="$msg_error: $funcname" \
691 f_show_err "$msg_invalid_index_argument" "$index"
694 f_dprintf "$funcname: disk=[%s] index=[%s]" "$disk" "$index"
696 # Check for unknown partition scheme before proceeding further
697 case "$ZFSBOOT_PARTITION_SCHEME" in
698 ""|MBR|GPT) : known good ;;
700 f_dprintf "$funcname: %s is an unsupported partition scheme" \
701 "$ZFSBOOT_PARTITION_SCHEME"
702 msg_error="$msg_error: $funcname" f_show_err \
703 "$msg_unsupported_partition_scheme" \
704 "$ZFSBOOT_PARTITION_SCHEME"
709 # Destroy whatever partition layout is currently on disk.
710 # NOTE: `-F' required to destroy if partitions still exist.
711 # NOTE: Failure is ok here, blank disk will have nothing to destroy.
713 f_dprintf "$funcname: Destroying all data/layouts on \`%s'..." "$disk"
714 f_eval_catch -d $funcname gpart "$GPART_DESTROY_F" $disk
715 f_eval_catch -d $funcname graid "$GRAID_DELETE" $disk
716 f_eval_catch -d $funcname zpool "$ZPOOL_LABELCLEAR_F" /dev/$disk
718 # Make doubly-sure backup GPT is destroyed
719 f_eval_catch -d $funcname gpart "$GPART_CREATE" gpt $disk
720 f_eval_catch -d $funcname gpart "$GPART_DESTROY_F" $disk
723 # Enable boot pool if encryption is desired
725 [ "$ZFSBOOT_GELI_ENCRYPTION" ] && ZFSBOOT_BOOT_POOL=1
728 # Lay down the desired type of partition scheme
730 local setsize mbrindex
731 case "$ZFSBOOT_PARTITION_SCHEME" in
732 ""|GPT) f_dprintf "$funcname: Creating GPT layout..."
734 # 1. Create GPT layout using labels
736 f_eval_catch $funcname gpart "$GPART_CREATE" gpt $disk ||
740 # 2. Add small freebsd-boot partition labeled `boot#'
742 f_eval_catch $funcname gpart "$GPART_ADD_LABEL_WITH_SIZE" \
743 gptboot$index freebsd-boot 512k $disk ||
745 f_eval_catch $funcname gpart "$GPART_BOOTCODE_PART" \
746 /boot/pmbr /boot/gptzfsboot 1 $disk ||
749 # NB: zpool will use the `zfs#' GPT labels
750 bootpart=p2 targetpart=p2
751 [ ${swapsize:-0} -gt 0 ] && targetpart=p3
754 # Prepare boot pool if enabled (e.g., for geli(8))
756 if [ "$ZFSBOOT_BOOT_POOL" ]; then
757 bootpart=p2 targetpart=p3
758 [ ${swapsize:-0} -gt 0 ] && targetpart=p4
759 f_eval_catch $funcname gpart \
760 "$GPART_ADD_LABEL_WITH_SIZE" boot$index \
761 freebsd-zfs ${bootsize}b $disk ||
763 # Pedantically nuke any old labels
764 f_eval_catch -d $funcname zpool "$ZPOOL_LABELCLEAR_F" \
766 if [ "$ZFSBOOT_GELI_ENCRYPTION" ]; then
767 # Pedantically detach targetpart for later
768 f_eval_catch -d $funcname geli \
770 /dev/$disk$targetpart
775 # 3. Add freebsd-swap partition labeled `swap#'
777 if [ ${swapsize:-0} -gt 0 ]; then
778 f_eval_catch $funcname gpart \
779 "$GPART_ADD_LABEL_WITH_SIZE" swap$index \
780 freebsd-swap ${swapsize}b $disk ||
782 # Pedantically nuke any old labels on the swap
783 f_eval_catch -d $funcname zpool "$ZPOOL_LABELCLEAR_F" \
786 f_eval_catch $funcname printf "$PRINTF_FSTAB" \
787 /dev/gpt/swap$index none swap sw 0 0 \
788 $BSDINSTALL_TMPETC/fstab ||
793 # 4. Add freebsd-zfs partition labeled `zfs#' for zroot
795 f_eval_catch $funcname gpart "$GPART_ADD_LABEL" \
796 zfs$index freebsd-zfs $disk || return $FAILURE
797 f_eval_catch -d $funcname zpool "$ZPOOL_LABELCLEAR_F" \
798 /dev/$disk$targetpart
801 MBR) f_dprintf "$funcname: Creating MBR layout..."
803 # 1. Create MBR layout (no labels)
805 f_eval_catch $funcname gpart "$GPART_CREATE" mbr $disk ||
807 f_eval_catch $funcname gpart "$GPART_BOOTCODE" /boot/mbr \
808 $disk || return $FAILURE
811 # 2. Add freebsd slice with all available space
813 f_eval_catch $funcname gpart "$GPART_ADD" freebsd $disk ||
815 f_eval_catch $funcname gpart "$GPART_SET_ACTIVE" 1 $disk ||
817 # Pedantically nuke any old labels
818 f_eval_catch -d $funcname zpool "$ZPOOL_LABELCLEAR_F" \
820 # Pedantically nuke any old scheme
821 f_eval_catch -d $funcname gpart "$GPART_DESTROY_F" ${disk}s1
824 # 3. Write BSD scheme to the freebsd slice
826 f_eval_catch $funcname gpart "$GPART_CREATE" BSD ${disk}s1 ||
829 # NB: zpool will use s1a (no labels)
830 bootpart=s1a targetpart=s1d mbrindex=4
833 # Always prepare a boot pool on MBR
836 f_eval_catch $funcname gpart \
837 "$GPART_ADD_INDEX_WITH_SIZE" \
838 1 freebsd-zfs ${bootsize}b ${disk}s1 ||
840 # Pedantically nuke any old labels
841 f_eval_catch -d $funcname zpool "$ZPOOL_LABELCLEAR_F" \
843 if [ "$ZFSBOOT_GELI_ENCRYPTION" ]; then
844 # Pedantically detach targetpart for later
845 f_eval_catch -d $funcname geli \
847 /dev/$disk$targetpart
851 # 4. Add freebsd-swap partition
853 if [ ${swapsize:-0} -gt 0 ]; then
854 f_eval_catch $funcname gpart \
855 "$GPART_ADD_INDEX_WITH_SIZE" 2 \
856 freebsd-swap ${swapsize}b ${disk}s1 ||
858 # Pedantically nuke any old labels on the swap
859 f_eval_catch -d $funcname zpool "$ZPOOL_LABELCLEAR_F" \
862 f_eval_catch $funcname printf "$PRINTF_FSTAB" \
863 /dev/${disk}s1b none swap sw 0 0 \
864 $BSDINSTALL_TMPETC/fstab ||
869 # 5. Add freebsd-zfs partition for zroot
871 f_eval_catch $funcname gpart "$GPART_ADD_INDEX" \
872 $mbrindex freebsd-zfs ${disk}s1 || return $FAILURE
873 f_eval_catch -d $funcname zpool "$ZPOOL_LABELCLEAR_F" \
874 /dev/$disk$targetpart # Pedantic
875 f_eval_catch $funcname dd "$DD_WITH_OPTIONS" \
876 /boot/zfsboot /dev/${disk}s1 count=1 ||
880 esac # $ZFSBOOT_PARTITION_SCHEME
885 # zfs_create_boot $poolname $vdev_type $disks ...
887 # Creates boot pool and dataset layout. Returns error if something goes wrong.
888 # Errors are printed to stderr for collection and display.
892 local funcname=zfs_create_boot
893 local zroot_name="$1"
894 local zroot_vdevtype="$2"
895 local zroot_vdevs= # Calculated below
896 local boot_vdevs= # Used for geli(8) and/or MBR layouts
897 shift 2 # poolname vdev_type
898 local disks="$*" disk
899 local bootpart targetpart # Set by zfs_create_diskpart() below
902 # Pedantic checks; should never be seen
904 if [ ! "$zroot_name" ]; then
905 f_dprintf "$funcname: NULL poolname"
906 msg_error="$msg_error: $funcname" \
907 f_show_err "$msg_null_poolname"
910 if [ $# -lt 1 ]; then
911 f_dprintf "$funcname: missing disk arguments"
912 msg_error="$msg_error: $funcname" \
913 f_show_err "$msg_missing_disk_arguments"
916 f_dprintf "$funcname: poolname=[%s] vdev_type=[%s]" \
917 "$zroot_name" "$zroot_vdevtype"
920 # Initialize fstab(5)
922 f_dprintf "$funcname: Initializing temporary fstab(5) file..."
923 f_eval_catch $funcname sh "$SHELL_TRUNCATE" $BSDINSTALL_TMPETC/fstab ||
925 f_eval_catch $funcname printf "$PRINTF_FSTAB" \
926 "# Device" Mountpoint FStype Options Dump "Pass#" \
927 $BSDINSTALL_TMPETC/fstab || return $FAILURE
930 # Expand SI units in desired sizes
932 f_dprintf "$funcname: Expanding supplied size values..."
933 local swapsize bootsize
934 if ! f_expand_number "$ZFSBOOT_SWAP_SIZE" swapsize; then
935 f_dprintf "$funcname: Invalid swap size \`%s'" \
937 f_show_err "$msg_invalid_swap_size" "$ZFSBOOT_SWAP_SIZE"
940 if ! f_expand_number "$ZFSBOOT_BOOT_POOL_SIZE" bootsize; then
941 f_dprintf "$funcname: Invalid boot pool size \`%s'" \
942 "$ZFSBOOT_BOOT_POOL_SIZE"
943 f_show_err "$msg_invalid_boot_pool_size" \
944 "$ZFSBOOT_BOOT_POOL_SIZE"
947 f_dprintf "$funcname: ZFSBOOT_SWAP_SIZE=[%s] swapsize=[%s]" \
948 "$ZFSBOOT_SWAP_SIZE" "$swapsize"
949 f_dprintf "$funcname: ZFSBOOT_BOOT_POOL_SIZE=[%s] bootsize=[%s]" \
950 "$ZFSBOOT_BOOT_POOL_SIZE" "$bootsize"
953 # Destroy the pool in-case this is our second time 'round (case of
954 # failure and installer presented ``Retry'' option to come back).
956 # NB: If we don't destroy the pool, later gpart(8) destroy commands
957 # that try to clear existing partitions (see zfs_create_diskpart())
958 # will fail with a `Device Busy' error, leading to `GEOM exists'.
960 f_eval_catch -d $funcname zpool "$ZPOOL_DESTROY" "$zroot_name"
963 # Prepare the disks and build pool device list(s)
965 f_dprintf "$funcname: Preparing disk partitions for ZFS pool..."
966 [ "$ZFSBOOT_GNOP_4K_FORCE_ALIGN" ] &&
967 f_dprintf "$funcname: With 4k alignment using gnop(8)..."
969 for disk in $disks; do
970 zfs_create_diskpart $disk $n || return $FAILURE
971 # Now $bootpart and $targetpart are set (suffix for $disk)
973 # Forced 4k alignment support using Geom NOP (see gnop(8))
974 if [ "$ZFSBOOT_GNOP_4K_FORCE_ALIGN" ]; then
975 if [ "$ZFSBOOT_BOOT_POOL" ]; then
976 boot_vdevs="$boot_vdevs $disk$bootpart.nop"
977 f_eval_catch $funcname gnop "$GNOP_CREATE" \
978 $disk$bootpart || return $FAILURE
980 # Don't gnop encrypted partition
981 if [ "$ZFSBOOT_GELI_ENCRYPTION" ]; then
982 zroot_vdevs="$zroot_vdevs $disk$targetpart.eli"
984 zroot_vdevs="$zroot_vdevs $disk$targetpart.nop"
985 f_eval_catch $funcname gnop "$GNOP_CREATE" \
990 if [ "$ZFSBOOT_BOOT_POOL" ]; then
991 boot_vdevs="$boot_vdevs $disk$bootpart"
993 zroot_vdevs="$zroot_vdevs $disk$targetpart"
1000 # If we need/want a boot pool, create it
1002 if [ "$ZFSBOOT_BOOT_POOL" ]; then
1003 local bootpool_vdevtype= # Calculated below
1004 local bootpool_options= # Calculated below
1005 local bootpool_name="$ZFSBOOT_BOOT_POOL_NAME"
1006 local bootpool="$BSDINSTALL_CHROOT/$bootpool_name"
1007 local zroot_key="${ZFSBOOT_GELI_KEY_FILE#/}"
1009 f_dprintf "$funcname: Setting up boot pool..."
1010 [ "$ZFSBOOT_GELI_ENCRYPTION" ] &&
1011 f_dprintf "$funcname: For encrypted root disk..."
1013 # Create parent directory for boot pool
1014 f_eval_catch -d $funcname umount "$UMOUNT" /mnt
1015 f_eval_catch $funcname mount "$MOUNT_TYPE" tmpfs none \
1016 $BSDINSTALL_CHROOT || return $FAILURE
1018 # Create mirror across the boot partition on all disks
1020 f_count nvdevs $boot_vdevs
1021 [ $nvdevs -gt 1 ] && bootpool_vdevtype=mirror
1023 bootpool_options="-o altroot=$BSDINSTALL_CHROOT"
1024 bootpool_options="$bootpool_options -m \"/$bootpool_name\" -f"
1025 f_eval_catch $funcname zpool "$ZPOOL_CREATE_WITH_OPTIONS" \
1026 "$bootpool_options" "$bootpool_name" \
1027 "$bootpool_vdevtype" "$boot_vdevs" ||
1030 f_eval_catch $funcname mkdir "$MKDIR_P" "$bootpool/boot" ||
1033 if [ "$ZFSBOOT_GELI_ENCRYPTION" ]; then
1034 # Generate an encryption key using random(4)
1035 f_eval_catch $funcname dd "$DD_WITH_OPTIONS" \
1036 /dev/random "$bootpool/$zroot_key" \
1037 "bs=4096 count=1" || return $FAILURE
1040 f_eval_catch $funcname zfs "$ZFS_UNMOUNT" \
1041 "$bootpool_name" || return $FAILURE
1042 f_eval_catch -d $funcname umount "$UMOUNT" /mnt # tmpfs
1048 # Create the geli(8) GEOMS
1050 if [ "$ZFSBOOT_GELI_ENCRYPTION" ]; then
1051 # Prompt user for password (twice)
1052 if ! msg_enter_new_password="$msg_geli_password" \
1053 f_dialog_input_password
1055 f_dprintf "$funcname: User cancelled"
1056 f_show_err "$msg_user_cancelled"
1060 # Initialize geli(8) on each of the target partitions
1061 for disk in $disks; do
1062 f_dialog_info "$msg_geli_setup" \
1063 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD
1064 if ! echo "$pw_password" | f_eval_catch \
1065 $funcname geli "$GELI_PASSWORD_INIT" \
1066 "$bootpool/boot/$disk$targetpart.eli" \
1067 AES-XTS "$bootpool/$zroot_key" \
1070 f_interactive || f_die
1071 unset pw_password # Sensitive info
1074 if ! echo "$pw_password" | f_eval_catch \
1075 $funcname geli "$GELI_ATTACH" \
1076 "$bootpool/$zroot_key" $disk$targetpart
1078 f_interactive || f_die
1079 unset pw_password # Sensitive info
1083 unset pw_password # Sensitive info
1086 f_eval_catch $funcname zfs "$ZFS_UNMOUNT" "$bootpool_name" ||
1088 f_eval_catch -d $funcname umount "$UMOUNT" /mnt # tmpfs
1092 # Create the ZFS root pool with desired type and disk devices
1094 f_dprintf "$funcname: Creating root pool..."
1095 f_eval_catch $funcname zpool "$ZPOOL_CREATE_WITH_OPTIONS" \
1096 "-o altroot=$BSDINSTALL_CHROOT -m none -f" \
1097 "$zroot_name" "$zroot_vdevtype" "$zroot_vdevs" ||
1100 # Customize the zroot a bit...
1102 f_dprintf "$funcname: Setting miscellaneous options on root pool..."
1103 for option in atime=off; do
1104 f_eval_catch $funcname zfs "$ZFS_SET" $option "$zroot_name" ||
1109 # Create ZFS dataset layout within the new root pool
1111 f_dprintf "$funcname: Creating ZFS datasets..."
1112 echo "$ZFSBOOT_DATASETS" | while read dataset options; do
1113 # Skip blank lines and comments
1114 case "$dataset" in "#"*|"") continue; esac
1115 # Remove potential inline comments in options
1116 options="${options%%#*}"
1117 # Replace tabs with spaces
1118 f_replaceall "$options" " " " " options
1119 # Reduce contiguous runs of space to one single space
1121 while [ "$oldoptions" != "$options" ]; do
1122 oldoptions="$options"
1123 f_replaceall "$options" " " " " options
1125 # Replace both commas and spaces with ` -o '
1126 f_replaceall "$options" "[ ,]" " -o " options
1127 # Create the dataset with desired options
1128 f_eval_catch $funcname zfs "$ZFS_CREATE_WITH_OPTIONS" \
1129 "${options:+-o $options}" "$zroot_name$dataset" ||
1133 # Touch up permissions on the tmp directories
1134 f_dprintf "$funcname: Modifying directory permissions..."
1136 for dir in /tmp /var/tmp; do
1137 f_eval_catch $funcname chmod "$CHMOD_MODE" 1777 \
1138 $BSDINSTALL_CHROOTDIR$dir || return $FAILURE
1142 if [ "$ZFSBOOT_BOOT_POOL" ]; then
1143 f_dprintf "$funcname: Creating /boot symlink for boot pool..."
1144 f_eval_catch $funcname ln "$LN_SF" "$bootpool_name/boot" \
1145 $BSDINSTALL_CHROOT/boot || return $FAILURE
1148 # Set bootfs property
1149 local zroot_bootfs="$ZFSBOOT_BEROOT_NAME/$ZFSBOOT_BOOTFS_NAME"
1150 f_dprintf "$funcname: Setting bootfs property..."
1151 f_eval_catch $funcname zpool "$ZPOOL_SET" \
1152 "bootfs=\"$zroot_name/$zroot_bootfs\"" "$zroot_name" ||
1155 # Export the pool(s)
1156 f_dprintf "$funcname: Temporarily exporting ZFS pool(s)..."
1157 f_eval_catch $funcname zpool "$ZPOOL_EXPORT" "$zroot_name" ||
1159 if [ "$ZFSBOOT_BOOT_POOL" ]; then
1160 f_eval_catch $funcname zpool "$ZPOOL_EXPORT" \
1161 "$bootpool_name" || return $FAILURE
1164 # Destroy the gnop devices (if enabled)
1165 for disk in ${ZFSBOOT_GNOP_4K_FORCE_ALIGN:+$disks}; do
1166 if [ "$ZFSBOOT_BOOT_POOL" ]; then
1167 f_eval_catch -d $funcname gnop "$GNOP_DESTROY" \
1170 if [ ! "$ZFSBOOT_GELI_ENCRYPTION" ]; then
1171 f_eval_catch -d $funcname gnop "$GNOP_DESTROY" \
1172 $disk$targetpart.nop
1176 # MBR boot loader touch-up
1177 if [ "$ZFSBOOT_PARTITION_SCHEME" = "MBR" ]; then
1178 f_dprintf "$funcname: Updating MBR boot loader on disks..."
1179 # Stick the ZFS boot loader in the "convienient hole" after
1180 # the ZFS internal metadata
1181 for disk in $disks; do
1182 f_eval_catch $funcname dd "$DD_WITH_OPTIONS" \
1183 /boot/zfsboot /dev/$disk$bootpart \
1184 "skip=1 seek=1024" || return $FAILURE
1188 # Re-import the ZFS pool(s)
1189 f_dprintf "$funcname: Re-importing ZFS pool(s)..."
1190 f_eval_catch $funcname zpool "$ZPOOL_IMPORT_WITH_OPTIONS" \
1191 "-o altroot=\"$BSDINSTALL_CHROOT\"" "$zroot_name" ||
1193 if [ "$ZFSBOOT_BOOT_POOL" ]; then
1194 f_eval_catch $funcname zpool "$ZPOOL_IMPORT_WITH_OPTIONS" \
1195 "-o altroot=\"$BSDINSTALL_CHROOT\"" \
1196 "$bootpool_name" || return $FAILURE
1199 # While this is apparently not needed, it seems to help MBR
1200 f_dprintf "$funcname: Configuring zpool.cache for zroot..."
1201 f_eval_catch $funcname mkdir "$MKDIR_P" $BSDINSTALL_CHROOT/boot/zfs ||
1203 f_eval_catch $funcname zpool "$ZPOOL_SET" \
1204 "cachefile=\"$BSDINSTALL_CHROOT/boot/zfs/zpool.cache\"" \
1205 "$zroot_name" || return $FAILURE
1207 # Last, but not least... required lines for rc.conf(5)/loader.conf(5)
1208 # NOTE: We later concatenate these into their destination
1209 f_dprintf "%s: Configuring rc.conf(5)/loader.conf(5) additions..." \
1211 f_eval_catch $funcname echo "$ECHO_APPEND" 'zfs_enable=\"YES\"' \
1212 $BSDINSTALL_TMPETC/rc.conf.zfs || return $FAILURE
1213 f_eval_catch $funcname echo "$ECHO_APPEND" 'zfs_load=\"YES\"' \
1214 $BSDINSTALL_TMPBOOT/loader.conf.zfs || return $FAILURE
1216 # We're all done unless we should go on for boot pool
1217 [ "$ZFSBOOT_BOOT_POOL" ] || return $SUCCESS
1219 # Set cachefile for boot pool so it auto-imports at system start
1220 f_dprintf "$funcname: Configuring zpool.cache for boot pool..."
1221 f_eval_catch $funcname zpool "$ZPOOL_SET" \
1222 "cachefile=\"$BSDINSTALL_CHROOT/boot/zfs/zpool.cache\"" \
1223 "$bootpool_name" || return $FAILURE
1225 # Some additional geli(8) requirements for loader.conf(5)
1227 'zpool_cache_load=\"YES\"' \
1228 'zpool_cache_type=\"/boot/zfs/zpool.cache\"' \
1229 'zpool_cache_name=\"/boot/zfs/zpool.cache\"' \
1231 f_eval_catch $funcname echo "$ECHO_APPEND" "$option" \
1232 $BSDINSTALL_TMPBOOT/loader.conf.zfs ||
1235 f_eval_catch $funcname printf "$PRINTF_CONF" vfs.root.mountfrom \
1236 "\"zfs:$zroot_name/$zroot_bootfs\"" \
1237 $BSDINSTALL_TMPBOOT/loader.conf.root || return $FAILURE
1239 # We're all done unless we should go on to do encryption
1240 [ "$ZFSBOOT_GELI_ENCRYPTION" ] || return $SUCCESS
1243 # Configure geli(8)-based encryption
1245 f_dprintf "$funcname: Configuring disk encryption..."
1246 f_eval_catch $funcname echo "$ECHO_APPEND" 'aesni_load=\"YES\"' \
1247 $BSDINSTALL_TMPBOOT/loader.conf.aesni || return $FAILURE
1248 f_eval_catch $funcname echo "$ECHO_APPEND" 'geom_eli_load=\"YES\"' \
1249 $BSDINSTALL_TMPBOOT/loader.conf.geli || return $FAILURE
1250 for disk in $disks; do
1251 f_eval_catch $funcname printf "$PRINTF_CONF" \
1252 geli_%s_keyfile0_load "$disk$targetpart YES" \
1253 $BSDINSTALL_TMPBOOT/loader.conf.$disk$targetpart ||
1255 f_eval_catch $funcname printf "$PRINTF_CONF" \
1256 geli_%s_keyfile0_type \
1257 "$disk$targetpart $disk$targetpart:geli_keyfile0" \
1258 $BSDINSTALL_TMPBOOT/loader.conf.$disk$targetpart ||
1260 f_eval_catch $funcname printf "$PRINTF_CONF" \
1261 geli_%s_keyfile0_name \
1262 "$disk$targetpart \"$ZFSBOOT_GELI_KEY_FILE\"" \
1263 $BSDINSTALL_TMPBOOT/loader.conf.$disk$targetpart ||
1270 # dialog_menu_diskinfo
1272 # Prompt the user to select a disk and then provide detailed info on it.
1274 dialog_menu_diskinfo()
1279 # Break from loop when user cancels disk selection
1282 device=$( msg_cancel="$msg_back" f_device_menu \
1283 "$DIALOG_TITLE" "$msg_select_a_disk_device" "" \
1284 $DEVICE_TYPE_DISK 2>&1 ) || break
1285 $device get name disk
1287 # Show gpart(8) `show' and camcontrol(8) `inquiry' data
1288 f_show_msg "$msg_detailed_disk_info" \
1289 "$disk" "$( gpart show $disk 2> /dev/null )" \
1290 "$disk" "$( camcontrol inquiry $disk 2> /dev/null )" \
1291 "$disk" "$( camcontrol identify $disk 2> /dev/null )"
1297 ############################################################ MAIN
1302 f_dialog_title "$msg_zfs_configuration"
1303 f_dialog_backtitle "$msg_freebsd_installer"
1305 # User may have specifically requested ZFS-related operations be interactive
1306 ! f_interactive && f_zfsinteractive && unset $VAR_NONINTERACTIVE
1311 f_dprintf "BSDINSTALL_CHROOT=[%s]" "$BSDINSTALL_CHROOT"
1312 f_dprintf "BSDINSTALL_TMPETC=[%s]" "$BSDINSTALL_TMPETC"
1313 f_dprintf "FSTAB_FMT=[%s]" "$FSTAB_FMT"
1316 # Loop over the main menu until we've accomplished what we came here to do
1319 if ! f_interactive; then
1321 mtag=">>> $msg_install"
1325 f_dialog_menutag_fetch mtag
1328 f_dprintf "retval=%u mtag=[%s]" $retval "$mtag"
1329 [ $retval -eq $DIALOG_OK ] || f_die
1334 # First, validate the user's selections
1337 # Make sure they gave us a name for the pool
1338 if [ ! "$ZFSBOOT_POOL_NAME" ]; then
1339 f_dprintf "Pool name cannot be empty."
1340 f_show_err "$msg_pool_name_cannot_be_empty"
1344 # Validate vdev type against number of disks selected/scripted
1345 # (also validates that ZFSBOOT_DISKS are real [probed] disks)
1346 # NB: dialog_menu_layout supports running non-interactively
1347 dialog_menu_layout || continue
1349 # Make sure each disk will be at least 50% ZFS
1350 if f_expand_number "$ZFSBOOT_SWAP_SIZE" swapsize &&
1351 f_expand_number "$ZFSBOOT_BOOT_POOL_SIZE" bootsize
1353 minsize=$swapsize teeny_disks=
1354 [ "$ZFSBOOT_BOOT_POOL" ] &&
1355 minsize=$(( $minsize + $bootsize ))
1356 for disk in $ZFSBOOT_DISKS; do
1357 debug= f_device_find -1 \
1358 $disk $DEVICE_TYPE_DISK device
1359 $device get capacity disksize || continue
1360 [ ${disksize:-0} -ge 0 ] || disksize=0
1361 disksize=$(( $disksize - $minsize ))
1362 [ $disksize -lt $minsize ] &&
1363 teeny_disks="$teeny_disks $disk"
1365 if [ "$teeny_disks" ]; then
1366 f_dprintf "swapsize=[%s] bootsize[%s] %s" \
1367 "$ZFSBOOT_SWAP_SIZE" \
1368 "$ZFSBOOT_BOOT_POOL_SIZE" \
1369 "minsize=[$minsize]"
1370 f_dprintf "These disks are too small: %s" \
1372 f_show_err "$msg_these_disks_are_too_small" \
1373 "$ZFSBOOT_SWAP_SIZE" \
1374 "$ZFSBOOT_BOOT_POOL_SIZE" \
1383 if f_interactive; then
1384 dialog_last_chance $ZFSBOOT_DISKS || continue
1391 vdev_type="$ZFSBOOT_VDEV_TYPE"
1393 # Blank the vdev type for the default layout
1394 [ "$vdev_type" = "stripe" ] && vdev_type=
1396 zfs_create_boot "$ZFSBOOT_POOL_NAME" \
1397 "$vdev_type" $ZFSBOOT_DISKS || continue
1401 ?" $msg_pool_type_disks")
1402 ZFSBOOT_CONFIRM_LAYOUT=1
1404 # User has poked settings, disable later confirmation
1405 ZFSBOOT_CONFIRM_LAYOUT=
1407 "- $msg_rescan_devices") f_device_rescan ;;
1408 "- $msg_disk_info") dialog_menu_diskinfo ;;
1410 # Prompt the user to input/change the name for the new pool
1411 f_dialog_input input \
1412 "$msg_please_enter_a_name_for_your_zpool" \
1413 "$ZFSBOOT_POOL_NAME" &&
1414 ZFSBOOT_POOL_NAME="$input"
1416 ?" $msg_force_4k_sectors")
1417 # Toggle the variable referenced both by the menu and later
1418 if [ "$ZFSBOOT_GNOP_4K_FORCE_ALIGN" ]; then
1419 ZFSBOOT_GNOP_4K_FORCE_ALIGN=
1421 ZFSBOOT_GNOP_4K_FORCE_ALIGN=1
1424 ?" $msg_encrypt_disks")
1425 # Toggle the variable referenced both by the menu and later
1426 if [ "$ZFSBOOT_GELI_ENCRYPTION" ]; then
1427 ZFSBOOT_GELI_ENCRYPTION=
1429 ZFSBOOT_GNOP_4K_FORCE_ALIGN=1
1430 ZFSBOOT_GELI_ENCRYPTION=1
1433 ?" $msg_partition_scheme")
1434 # Toggle between GPT and MBR
1435 if [ "$ZFSBOOT_PARTITION_SCHEME" = GPT ]; then
1436 ZFSBOOT_PARTITION_SCHEME=MBR
1438 ZFSBOOT_PARTITION_SCHEME=GPT
1442 # Prompt the user to input/change the swap size for each disk
1443 f_dialog_input input \
1444 "$msg_please_enter_amount_of_swap_space" \
1445 "$ZFSBOOT_SWAP_SIZE" &&
1446 ZFSBOOT_SWAP_SIZE="${input:-0}"
1453 ################################################################################
1455 ################################################################################