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:=}
115 # Default partitioning scheme to use on disks
117 : ${ZFSBOOT_BOOT_TYPE:=}
120 # How much swap to put on each block device in the boot zpool
121 # NOTE: Value passed to gpart(8); which supports SI unit suffixes.
123 : ${ZFSBOOT_SWAP_SIZE:=2g}
126 # Should we use geli(8) to encrypt the swap?
128 : ${ZFSBOOT_SWAP_ENCRYPTION=}
131 # Should we use gmirror(8) to mirror the swap?
133 : ${ZFSBOOT_SWAP_MIRROR=}
136 # Default ZFS datasets for root zpool
138 # NOTE: Requires /tmp, /var/tmp, /$ZFSBOOT_BOOTFS_NAME/$ZFSBOOT_BOOTFS_NAME
139 # NOTE: Anything after pound/hash character [#] is ignored as a comment.
141 f_isset ZFSBOOT_DATASETS || ZFSBOOT_DATASETS="
142 # DATASET OPTIONS (comma or space separated; or both)
144 # Boot Environment [BE] root and default boot dataset
145 /$ZFSBOOT_BEROOT_NAME mountpoint=none
146 /$ZFSBOOT_BEROOT_NAME/$ZFSBOOT_BOOTFS_NAME mountpoint=/
148 # Compress /tmp, allow exec but not setuid
149 /tmp mountpoint=/tmp,exec=on,setuid=off
151 # Don't mount /usr so that 'base' files go to the BEROOT
152 /usr mountpoint=/usr,canmount=off
154 # Home directories separated so they are common to all BEs
155 /usr/home # NB: /home is a symlink to /usr/home
158 /usr/ports setuid=off
160 # Source tree (compressed)
163 # Create /var and friends
164 /var mountpoint=/var,canmount=off
165 /var/audit exec=off,setuid=off
166 /var/crash exec=off,setuid=off
167 /var/log exec=off,setuid=off
173 # If interactive and the user has not explicitly chosen a vdev type or disks,
174 # make the user confirm scripted/default choices when proceeding to install.
176 : ${ZFSBOOT_CONFIRM_LAYOUT:=1}
178 ############################################################ GLOBALS
181 # Format of a line in printf(1) syntax to add to fstab(5)
183 FSTAB_FMT="%s\t\t%s\t%s\t%s\t\t%s\t%s\n"
186 # Command strings for various tasks
188 CHMOD_MODE='chmod %s "%s"'
189 DD_WITH_OPTIONS='dd if="%s" of="%s" %s'
190 ECHO_APPEND='echo "%s" >> "%s"'
191 GELI_ATTACH='geli attach -j - -k "%s" "%s"'
192 GELI_DETACH_F='geli detach -f "%s"'
193 GELI_PASSWORD_INIT='geli init -b -B "%s" -e %s -J - -K "%s" -l 256 -s 4096 "%s"'
194 GPART_ADD_ALIGN='gpart add %s -t %s "%s"'
195 GPART_ADD_ALIGN_INDEX='gpart add %s -i %s -t %s "%s"'
196 GPART_ADD_ALIGN_INDEX_WITH_SIZE='gpart add %s -i %s -t %s -s %s "%s"'
197 GPART_ADD_ALIGN_LABEL='gpart add %s -l %s -t %s "%s"'
198 GPART_ADD_ALIGN_LABEL_WITH_SIZE='gpart add %s -l %s -t %s -s %s "%s"'
199 GPART_BOOTCODE='gpart bootcode -b "%s" "%s"'
200 GPART_BOOTCODE_PART='gpart bootcode -b "%s" -p "%s" -i %s "%s"'
201 GPART_BOOTCODE_PARTONLY='gpart bootcode -p "%s" -i %s "%s"'
202 GPART_CREATE='gpart create -s %s "%s"'
203 GPART_DESTROY_F='gpart destroy -F "%s"'
204 GPART_SET_ACTIVE='gpart set -a active -i %s "%s"'
205 GPART_SET_LENOVOFIX='gpart set -a lenovofix "%s"'
206 GPART_SET_PMBR_ACTIVE='gpart set -a active "%s"'
207 GRAID_DELETE='graid delete "%s"'
208 LN_SF='ln -sf "%s" "%s"'
209 MKDIR_P='mkdir -p "%s"'
210 MOUNT_TYPE='mount -t %s "%s" "%s"'
211 PRINTF_CONF="printf '%s=\"%%s\"\\\n' %s >> \"%s\""
212 PRINTF_FSTAB='printf "$FSTAB_FMT" "%s" "%s" "%s" "%s" "%s" "%s" >> "%s"'
213 SHELL_TRUNCATE=':> "%s"'
214 SWAP_GMIRROR_LABEL='gmirror label swap %s'
215 SYSCTL_ZFS_MIN_ASHIFT_12='sysctl vfs.zfs.min_auto_ashift=12'
217 ZFS_CREATE_WITH_OPTIONS='zfs create %s "%s"'
218 ZFS_SET='zfs set "%s" "%s"'
219 ZFS_UNMOUNT='zfs unmount "%s"'
220 ZPOOL_CREATE_WITH_OPTIONS='zpool create %s "%s" %s %s'
221 ZPOOL_DESTROY='zpool destroy "%s"'
222 ZPOOL_EXPORT='zpool export "%s"'
223 ZPOOL_IMPORT_WITH_OPTIONS='zpool import %s "%s"'
224 ZPOOL_LABELCLEAR_F='zpool labelclear -f "%s"'
225 ZPOOL_SET='zpool set %s "%s"'
228 # Strings that should be moved to an i18n file and loaded with f_include_lang()
230 hline_alnum_arrows_punc_tab_enter="Use alnum, arrows, punctuation, TAB or ENTER"
231 hline_arrows_space_tab_enter="Use arrows, SPACE, TAB or ENTER"
232 hline_arrows_tab_enter="Press arrows, TAB or ENTER"
233 msg_an_unknown_error_occurred="An unknown error occurred"
236 msg_change_selection="Change Selection"
237 msg_configure_options="Configure Options:"
238 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"
239 msg_disk_info="Disk Info"
240 msg_disk_info_help="Get detailed information on disk device(s)"
241 msg_disk_singular="disk"
242 msg_disk_plural="disks"
243 msg_encrypt_disks="Encrypt Disks?"
244 msg_encrypt_disks_help="Use geli(8) to encrypt all data partitions"
246 msg_force_4k_sectors="Force 4K Sectors?"
247 msg_force_4k_sectors_help="Align partitions to 4K sector boundries and set vfs.zfs.min_auto_ashift=12"
248 msg_freebsd_installer="FreeBSD Installer"
249 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"
250 msg_geli_setup="Initializing encryption on selected disks,\n this will take several seconds per disk"
251 msg_install="Install"
252 msg_install_desc="Proceed with Installation"
253 msg_install_help="Create ZFS boot pool with displayed options"
254 msg_invalid_boot_pool_size="Invalid boot pool size \`%s'"
255 msg_invalid_disk_argument="Invalid disk argument \`%s'"
256 msg_invalid_index_argument="Invalid index argument \`%s'"
257 msg_invalid_swap_size="Invalid swap size \`%s'"
258 msg_invalid_virtual_device_type="Invalid Virtual Device type \`%s'"
259 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"
260 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'
261 msg_mirror_desc="Mirror - n-Way Mirroring"
262 msg_mirror_help="[2+ Disks] Mirroring provides the best performance, but the least storage"
263 msg_missing_disk_arguments="missing disk arguments"
264 msg_missing_one_or_more_scripted_disks="Missing one or more scripted disks!"
266 msg_no_disks_present_to_configure="No disk(s) present to configure"
267 msg_no_disks_selected="No disks selected."
268 msg_not_enough_disks_selected="Not enough disks selected. (%u < %u minimum)"
269 msg_null_disk_argument="NULL disk argument"
270 msg_null_index_argument="NULL index argument"
271 msg_null_poolname="NULL poolname"
273 msg_partition_scheme="Partition Scheme"
274 msg_partition_scheme_help="Select partitioning scheme. GPT is recommended."
275 msg_please_enter_a_name_for_your_zpool="Please enter a name for your zpool:"
276 msg_please_enter_amount_of_swap_space="Please enter amount of swap space (SI-Unit suffixes\nrecommended; e.g., \`2g' for 2 Gigabytes):"
277 msg_please_select_one_or_more_disks="Please select one or more disks to create a zpool:"
278 msg_pool_name="Pool Name"
279 msg_pool_name_cannot_be_empty="Pool name cannot be empty."
280 msg_pool_name_help="Customize the name of the zpool to be created (Required)"
281 msg_pool_type_disks="Pool Type/Disks:"
282 msg_pool_type_disks_help="Choose type of ZFS Virtual Device and disks to use (Required)"
283 msg_processing_selection="Processing selection..."
284 msg_raidz1_desc="RAID-Z1 - Single Redundant RAID"
285 msg_raidz1_help="[3+ Disks] Withstand failure of 1 disk. Recommended for: 3, 5 or 9 disks"
286 msg_raidz2_desc="RAID-Z2 - Double Redundant RAID"
287 msg_raidz2_help="[4+ Disks] Withstand failure of 2 disks. Recommended for: 4, 6 or 10 disks"
288 msg_raidz3_desc="RAID-Z3 - Triple Redundant RAID"
289 msg_raidz3_help="[5+ Disks] Withstand failure of 3 disks. Recommended for: 5, 7 or 11 disks"
290 msg_rescan_devices="Rescan Devices"
291 msg_rescan_devices_help="Scan for device changes"
293 msg_select_a_disk_device="Select a disk device"
294 msg_select_virtual_device_type="Select Virtual Device type:"
295 msg_stripe_desc="Stripe - No Redundancy"
296 msg_stripe_help="[1+ Disks] Striping provides maximum storage but no redundancy"
297 msg_swap_encrypt="Encrypt Swap?"
298 msg_swap_encrypt_help="Encrypt swap partitions with temporary keys, discarded on reboot"
299 msg_swap_invalid="The selected swap size (%s) is invalid. Enter a number optionally followed by units. Example: 2G"
300 msg_swap_mirror="Mirror Swap?"
301 msg_swap_mirror_help="Mirror swap partitions for redundancy, breaks crash dumps"
302 msg_swap_size="Swap Size"
303 msg_swap_size_help="Customize how much swap space is allocated to each selected disk"
304 msg_swap_toosmall="The selected swap size (%s) is to small. Please enter a value greater than 100MB or enter 0 for no swap"
305 msg_these_disks_are_too_small="These disks are smaller than the amount of requested\nswap (%s) and/or geli(8) (%s) partitions, which would\ntake 100%% or more of each of the following selected disks:\n\n %s\n\nRecommend changing partition size(s) and/or selecting a\ndifferent set of disks."
306 msg_unable_to_get_disk_capacity="Unable to get disk capacity of \`%s'"
307 msg_unsupported_partition_scheme="%s is an unsupported partition scheme"
308 msg_user_cancelled="User Cancelled."
310 msg_zfs_configuration="ZFS Configuration"
312 ############################################################ FUNCTIONS
316 # Display the dialog(1)-based application main menu.
320 local title="$DIALOG_TITLE"
321 local btitle="$DIALOG_BACKTITLE"
322 local prompt="$msg_configure_options"
323 local force4k="$msg_no"
324 local usegeli="$msg_no"
325 local swapgeli="$msg_no"
326 local swapmirror="$msg_no"
327 [ "$ZFSBOOT_FORCE_4K_SECTORS" ] && force4k="$msg_yes"
328 [ "$ZFSBOOT_GELI_ENCRYPTION" ] && usegeli="$msg_yes"
329 [ "$ZFSBOOT_SWAP_ENCRYPTION" ] && swapgeli="$msg_yes"
330 [ "$ZFSBOOT_SWAP_MIRROR" ] && swapmirror="$msg_yes"
331 local disks n disks_grammar
332 f_count n $ZFSBOOT_DISKS
333 { [ $n -eq 1 ] && disks_grammar=$msg_disk_singular; } ||
334 disks_grammar=$msg_disk_plural # grammar
336 '>>> $msg_install' '$msg_install_desc'
338 'T $msg_pool_type_disks'
339 '$ZFSBOOT_VDEV_TYPE: $n $disks_grammar'
340 '$msg_pool_type_disks_help'
341 '- $msg_rescan_devices' '*'
342 '$msg_rescan_devices_help'
343 '- $msg_disk_info' '*'
344 '$msg_disk_info_help'
345 'N $msg_pool_name' '$ZFSBOOT_POOL_NAME'
346 '$msg_pool_name_help'
347 '4 $msg_force_4k_sectors'
349 '$msg_force_4k_sectors_help'
350 'E $msg_encrypt_disks' '$usegeli'
351 '$msg_encrypt_disks_help'
352 'P $msg_partition_scheme'
353 '$ZFSBOOT_PARTITION_SCHEME ($ZFSBOOT_BOOT_TYPE)'
354 '$msg_partition_scheme_help'
355 'S $msg_swap_size' '$ZFSBOOT_SWAP_SIZE'
356 '$msg_swap_size_help'
357 'M $msg_swap_mirror' '$swapmirror'
358 '$msg_swap_mirror_help'
359 'W $msg_swap_encrypt' '$swapgeli'
360 '$msg_swap_encrypt_help'
362 local defaultitem= # Calculated below
363 local hline="$hline_alnum_arrows_punc_tab_enter"
365 local height width rows
366 eval f_dialog_menu_with_help_size height width rows \
367 \"\$title\" \"\$btitle\" \"\$prompt\" \"\$hline\" $menu_list
369 # Obtain default-item from previously stored selection
370 f_dialog_default_fetch defaultitem
373 menu_choice=$( eval $DIALOG \
374 --title \"\$title\" \
375 --backtitle \"\$btitle\" \
376 --hline \"\$hline\" \
378 --ok-label \"\$msg_select\" \
379 --cancel-label \"\$msg_cancel\" \
380 --default-item \"\$defaultitem\" \
381 --menu \"\$prompt\" \
382 $height $width $rows \
384 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD
387 f_dialog_data_sanitize menu_choice
388 f_dialog_menutag_store "$menu_choice"
390 # Only update default-item on success
391 [ $retval -eq $DIALOG_OK ] && f_dialog_default_store "$menu_choice"
396 # dialog_last_chance $disks ...
398 # Display a list of the disks that the user is about to destroy. The default
399 # action is to return error status unless the user explicitly (non-default)
400 # selects "Yes" from the noyes dialog.
404 local title="$DIALOG_TITLE"
405 local btitle="$DIALOG_BACKTITLE"
406 local prompt # Calculated below
407 local hline="$hline_arrows_tab_enter"
409 local height=8 width=50 prefix=" "
410 local plen=${#prefix} list= line=
411 local max_width=$(( $width - 3 - $plen ))
413 local yes no defaultno extra_args format
414 if [ "$USE_XDIALOG" ]; then
415 yes=ok no=cancel defaultno=default-no
416 extra_args="--wrap --left"
417 format="$msg_last_chance_are_you_sure"
419 yes=yes no=no defaultno=defaultno
420 extra_args="--colors --cr-wrap"
421 format="$msg_last_chance_are_you_sure_color"
424 local disk line_width
431 line_width=$(( $line_width + 1 + ${#disk} ))
432 # Add newline before disk if it would exceed max_width
433 if [ $line_width -gt $max_width ]; then
436 height=$(( $height + 1 ))
438 # Add the disk to the list
441 # Append the left-overs
442 if [ "${line#$prefix}" ]; then
444 height=$(( $height + 1 ))
447 # Add height for Xdialog(1)
448 [ "$USE_XDIALOG" ] && height=$(( $height + $height / 5 + 3 ))
450 prompt=$( printf "$format" "$list" )
451 f_dprintf "%s: Last Chance!" "$0"
454 --backtitle "$btitle" \
457 --$yes-label "$msg_yes" \
458 --$no-label "$msg_no" \
460 --yesno "$prompt" $height $width
465 # Configure Virtual Device type and disks to use for the ZFS boot pool. User
466 # must select enough disks to satisfy the chosen vdev type.
470 local funcname=dialog_menu_layout
471 local title="$DIALOG_TITLE"
472 local btitle="$DIALOG_BACKTITLE"
473 local vdev_prompt="$msg_select_virtual_device_type"
474 local disk_prompt="$msg_please_select_one_or_more_disks"
475 local vdev_menu_list="
476 'stripe' '$msg_stripe_desc' '$msg_stripe_help'
477 'mirror' '$msg_mirror_desc' '$msg_mirror_help'
478 'raidz1' '$msg_raidz1_desc' '$msg_raidz1_help'
479 'raidz2' '$msg_raidz2_desc' '$msg_raidz2_help'
480 'raidz3' '$msg_raidz3_desc' '$msg_raidz3_help'
482 local disk_check_list= # Calculated below
483 local vdev_hline="$hline_arrows_tab_enter"
484 local disk_hline="$hline_arrows_space_tab_enter"
486 # Warn the user if vdev type is not valid
487 case "$ZFSBOOT_VDEV_TYPE" in
488 stripe|mirror|raidz1|raidz2|raidz3) : known good ;;
490 f_dprintf "%s: Invalid virtual device type \`%s'" \
491 $funcname "$ZFSBOOT_VDEV_TYPE"
492 f_show_err "$msg_invalid_virtual_device_type" \
494 f_interactive || return $FAILURE
497 # Calculate size of vdev menu once only
498 local vheight vwidth vrows
499 eval f_dialog_menu_with_help_size vheight vwidth vrows \
500 \"\$title\" \"\$btitle\" \"\$vdev_prompt\" \"\$vdev_hline\" \
503 # Get a list of probed disk devices
505 debug= f_device_find "" $DEVICE_TYPE_DISK disks
507 # Prune out mounted md(4) devices that may be part of the boot process
508 local disk name new_list=
509 for disk in $disks; do
510 debug= $disk get name name
512 md[0-9]*) f_mounted -b "/dev/$name" && continue ;;
514 new_list="$new_list $disk"
516 disks="${new_list# }"
519 if [ "$debug" ]; then
521 for disk in $disks; do
522 debug= $disk get name name
523 disk_names="$disk_names $name"
525 f_dprintf "$funcname: disks=[%s]" "${disk_names# }"
528 if [ ! "$disks" ]; then
529 f_dprintf "No disk(s) present to configure"
530 f_show_err "$msg_no_disks_present_to_configure"
534 # Lets sort the disks array to be more user friendly
535 f_device_sort_by name disks disks
538 # Operate in a loop so we can (if interactive) repeat if not enough
539 # disks are selected to satisfy the chosen vdev type or user wants to
540 # back-up to the previous menu.
542 local vardisk ndisks onoff selections vdev_choice breakout device
543 local valid_disks all_valid want_disks desc height width rows
546 # Confirm the vdev type that was selected
548 if f_interactive && [ "$ZFSBOOT_CONFIRM_LAYOUT" ]; then
549 vdev_choice=$( eval $DIALOG \
550 --title \"\$title\" \
551 --backtitle \"\$btitle\" \
552 --hline \"\$vdev_hline\" \
553 --ok-label \"\$msg_ok\" \
554 --cancel-label \"\$msg_cancel\" \
556 --default-item \"\$ZFSBOOT_VDEV_TYPE\" \
557 --menu \"\$vdev_prompt\" \
558 $vheight $vwidth $vrows \
560 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD
562 # Exit if user pressed ESC or chose Cancel/No
563 f_dialog_data_sanitize vdev_choice
565 ZFSBOOT_VDEV_TYPE="$vdev_choice"
566 f_dprintf "$funcname: ZFSBOOT_VDEV_TYPE=[%s]" \
570 # Determine the number of disks needed for this vdev type
572 case "$ZFSBOOT_VDEV_TYPE" in
573 stripe) want_disks=1 ;;
574 mirror) want_disks=2 ;;
575 raidz1) want_disks=3 ;;
576 raidz2) want_disks=4 ;;
577 raidz3) want_disks=5 ;;
581 # Warn the user if any scripted disks are invalid
583 valid_disks= all_valid=${ZFSBOOT_DISKS:+1} # optimism
584 for disk in $ZFSBOOT_DISKS; do
585 if debug= f_device_find -1 \
586 $disk $DEVICE_TYPE_DISK device
588 valid_disks="$valid_disks $disk"
591 f_dprintf "$funcname: \`%s' is not a real disk" "$disk"
594 if [ ! "$all_valid" ]; then
595 if [ "$ZFSBOOT_DISKS" ]; then
597 "$msg_missing_one_or_more_scripted_disks"
599 f_dprintf "No disks selected."
601 f_show_err "$msg_no_disks_selected"
603 f_interactive || return $FAILURE
605 ZFSBOOT_DISKS="${valid_disks# }"
608 # Short-circuit if we're running non-interactively
610 if ! f_interactive || [ ! "$ZFSBOOT_CONFIRM_LAYOUT" ]; then
611 f_count ndisks $ZFSBOOT_DISKS
612 [ $ndisks -ge $want_disks ] && break # to success
614 # Not enough disks selected
615 f_dprintf "$funcname: %s: %s (%u < %u minimum)" \
616 "$ZFSBOOT_VDEV_TYPE" \
617 "Not enough disks selected." \
619 f_interactive || return $FAILURE
620 msg_yes="$msg_change_selection" msg_no="$msg_cancel" \
621 f_yesno "%s: $msg_not_enough_disks_selected" \
622 "$ZFSBOOT_VDEV_TYPE" $ndisks $want_disks ||
627 # Confirm the disks that were selected
628 # Loop until the user cancels or selects enough disks
632 # Loop over list of available disks, resetting state
633 for disk in $disks; do
634 f_isset _${disk}_status && _${disk}_status=
637 # Loop over list of selected disks and create temporary
638 # locals to map statuses onto up-to-date list of disks
639 for disk in $ZFSBOOT_DISKS; do
640 debug= f_device_find -1 \
641 $disk $DEVICE_TYPE_DISK disk
642 f_isset _${disk}_status ||
643 local _${disk}_status
647 # Create the checklist menu of discovered disk devices
649 for disk in $disks; do
653 f_shell_escape "$desc" desc
654 f_getvar _${disk}_status:-off onoff
655 disk_check_list="$disk_check_list
656 $name '$desc' $onoff"
659 eval f_dialog_checklist_size height width rows \
660 \"\$title\" \"\$btitle\" \"\$prompt\" \
661 \"\$hline\" $disk_check_list
663 selections=$( eval $DIALOG \
664 --title \"\$DIALOG_TITLE\" \
665 --backtitle \"\$DIALOG_BACKTITLE\" \
667 --hline \"\$hline\" \
668 --ok-label \"\$msg_ok\" \
669 --cancel-label \"\$msg_back\" \
670 --checklist \"\$prompt\" \
671 $height $width $rows \
673 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD
675 # Loop if user pressed ESC or chose Cancel/No
676 f_dialog_data_sanitize selections
678 ZFSBOOT_DISKS="$selections"
679 f_dprintf "$funcname: ZFSBOOT_DISKS=[%s]" \
682 f_count ndisks $ZFSBOOT_DISKS
683 [ $ndisks -ge $want_disks ] &&
684 breakout=break && break
686 # Not enough disks selected
687 f_dprintf "$funcname: %s: %s (%u < %u minimum)" \
688 "$ZFSBOOT_VDEV_TYPE" \
689 "Not enough disks selected." \
691 msg_yes="$msg_change_selection" msg_no="$msg_cancel" \
692 f_yesno "%s: $msg_not_enough_disks_selected" \
693 "$ZFSBOOT_VDEV_TYPE" $ndisks $want_disks ||
696 [ "$breakout" = "break" ] && break
697 [ "$ZFSBOOT_CONFIRM_LAYOUT" ] || return $FAILURE
703 # zfs_create_diskpart $disk $index
705 # For each block device to be used in the zpool, rather than just create the
706 # zpool with the raw block devices (e.g., da0, da1, etc.) we create partitions
707 # so we can have some real swap. This also provides wiggle room incase your
708 # replacement drivers do not have the exact same sector counts.
710 # NOTE: $swapsize and $bootsize should be defined by the calling function.
711 # NOTE: Sets $bootpart and $targetpart for the calling function.
713 zfs_create_diskpart()
715 local funcname=zfs_create_diskpart
716 local disk="$1" index="$2"
719 if [ ! "$disk" ]; then
720 f_dprintf "$funcname: NULL disk argument"
721 msg_error="$msg_error: $funcname" \
722 f_show_err "$msg_null_disk_argument"
725 if [ "${disk#*[$IFS]}" != "$disk" ]; then
726 f_dprintf "$funcname: Invalid disk argument \`%s'" "$disk"
727 msg_error="$msg_error: $funcname" \
728 f_show_err "$msg_invalid_disk_argument" "$disk"
731 if [ ! "$index" ]; then
732 f_dprintf "$funcname: NULL index argument"
733 msg_error="$msg_error: $funcname" \
734 f_show_err "$msg_null_index_argument"
737 if ! f_isinteger "$index"; then
738 f_dprintf "$funcname: Invalid index argument \`%s'" "$index"
739 msg_error="$msg_error: $funcname" \
740 f_show_err "$msg_invalid_index_argument" "$index"
743 f_dprintf "$funcname: disk=[%s] index=[%s]" "$disk" "$index"
745 # Check for unknown partition scheme before proceeding further
746 case "$ZFSBOOT_PARTITION_SCHEME" in
747 ""|MBR|GPT*) : known good ;;
749 f_dprintf "$funcname: %s is an unsupported partition scheme" \
750 "$ZFSBOOT_PARTITION_SCHEME"
751 msg_error="$msg_error: $funcname" f_show_err \
752 "$msg_unsupported_partition_scheme" \
753 "$ZFSBOOT_PARTITION_SCHEME"
758 # Destroy whatever partition layout is currently on disk.
759 # NOTE: `-F' required to destroy if partitions still exist.
760 # NOTE: Failure is ok here, blank disk will have nothing to destroy.
762 f_dprintf "$funcname: Destroying all data/layouts on \`%s'..." "$disk"
763 f_eval_catch -d $funcname gpart "$GPART_DESTROY_F" $disk
764 f_eval_catch -d $funcname graid "$GRAID_DELETE" $disk
765 f_eval_catch -d $funcname zpool "$ZPOOL_LABELCLEAR_F" /dev/$disk
767 # Make doubly-sure backup GPT is destroyed
768 f_eval_catch -d $funcname gpart "$GPART_CREATE" gpt $disk
769 f_eval_catch -d $funcname gpart "$GPART_DESTROY_F" $disk
772 # Enable boot pool if encryption is desired
774 [ "$ZFSBOOT_GELI_ENCRYPTION" ] && ZFSBOOT_BOOT_POOL=1
777 # Lay down the desired type of partition scheme
779 local setsize mbrindex align_small align_big
781 # If user has requested 4 K alignment, add these params to the
782 # gpart add calls. With GPT, we align large partitions to 1 M for
783 # improved performance on SSDs. MBR does not always play well with gaps
784 # between partitions, so all alignment is only 4k for that case.
785 # With MBR, we align the BSD partition that contains the MBR, otherwise
786 # the system fails to boot.
788 if [ "$ZFSBOOT_FORCE_4K_SECTORS" ]; then
791 sysctl kern.geom.part.mbr.enforce_chs=0
794 case "$ZFSBOOT_PARTITION_SCHEME" in
795 ""|GPT*) f_dprintf "$funcname: Creating GPT layout..."
797 # 1. Create GPT layout using labels
799 f_eval_catch $funcname gpart "$GPART_CREATE" gpt $disk ||
803 # Apply workarounds if requested by the user
805 if [ "$ZFSBOOT_PARTITION_SCHEME" = "GPT + Lenovo Fix" ]; then
806 f_eval_catch $funcname gpart "$GPART_SET_LENOVOFIX" \
807 $disk || return $FAILURE
808 elif [ "$ZFSBOOT_PARTITION_SCHEME" = "GPT + Active" ]; then
809 f_eval_catch $funcname gpart "$GPART_SET_PMBR_ACTIVE" \
810 $disk || return $FAILURE
814 # 2. Add small freebsd-boot or efi partition
816 if [ "$ZFSBOOT_BOOT_TYPE" = "UEFI" ]; then
817 f_eval_catch $funcname gpart \
818 "$GPART_ADD_ALIGN_LABEL_WITH_SIZE" \
819 "$align_small" efiboot$index efi 200M $disk ||
821 f_eval_catch $funcname gpart "$GPART_BOOTCODE_PARTONLY" \
822 /boot/boot1.efifat 1 $disk ||
825 f_eval_catch $funcname gpart \
826 "$GPART_ADD_ALIGN_LABEL_WITH_SIZE" \
827 "$align_small" gptboot$index freebsd-boot \
828 512k $disk || return $FAILURE
829 f_eval_catch $funcname gpart "$GPART_BOOTCODE_PART" \
830 /boot/pmbr /boot/gptzfsboot 1 $disk ||
834 # NB: zpool will use the `zfs#' GPT labels
835 bootpart=p2 swappart=p2 targetpart=p2
836 [ ${swapsize:-0} -gt 0 ] && targetpart=p3
839 # Prepare boot pool if enabled (e.g., for geli(8))
841 if [ "$ZFSBOOT_BOOT_POOL" ]; then
842 bootpart=p2 swappart=p3 targetpart=p3
843 [ ${swapsize:-0} -gt 0 ] && targetpart=p4
844 f_eval_catch $funcname gpart \
845 "$GPART_ADD_ALIGN_LABEL_WITH_SIZE" \
846 "$align_big" boot$index freebsd-zfs \
847 ${bootsize}b $disk ||
849 # Pedantically nuke any old labels
850 f_eval_catch -d $funcname zpool "$ZPOOL_LABELCLEAR_F" \
852 if [ "$ZFSBOOT_GELI_ENCRYPTION" ]; then
853 # Pedantically detach targetpart for later
854 f_eval_catch -d $funcname geli \
856 /dev/$disk$targetpart
861 # 3. Add freebsd-swap partition labeled `swap#'
863 if [ ${swapsize:-0} -gt 0 ]; then
864 f_eval_catch $funcname gpart \
865 "$GPART_ADD_ALIGN_LABEL_WITH_SIZE" \
866 "$align_big" swap$index freebsd-swap \
867 ${swapsize}b $disk ||
869 # Pedantically nuke any old labels on the swap
870 f_eval_catch -d $funcname zpool "$ZPOOL_LABELCLEAR_F" \
875 # 4. Add freebsd-zfs partition labeled `zfs#' for zroot
877 f_eval_catch $funcname gpart "$GPART_ADD_ALIGN_LABEL" \
878 "$align_big" zfs$index freebsd-zfs $disk ||
880 f_eval_catch -d $funcname zpool "$ZPOOL_LABELCLEAR_F" \
881 /dev/$disk$targetpart
884 MBR) f_dprintf "$funcname: Creating MBR layout..."
886 # 1. Create MBR layout (no labels)
888 f_eval_catch $funcname gpart "$GPART_CREATE" mbr $disk ||
890 f_eval_catch $funcname gpart "$GPART_BOOTCODE" /boot/mbr \
891 $disk || return $FAILURE
894 # 2. Add freebsd slice with all available space
896 f_eval_catch $funcname gpart "$GPART_ADD_ALIGN" "$align_small" \
899 f_eval_catch $funcname gpart "$GPART_SET_ACTIVE" 1 $disk ||
901 # Pedantically nuke any old labels
902 f_eval_catch -d $funcname zpool "$ZPOOL_LABELCLEAR_F" \
904 # Pedantically nuke any old scheme
905 f_eval_catch -d $funcname gpart "$GPART_DESTROY_F" ${disk}s1
908 # 3. Write BSD scheme to the freebsd slice
910 f_eval_catch $funcname gpart "$GPART_CREATE" BSD ${disk}s1 ||
913 # NB: zpool will use s1a (no labels)
914 bootpart=s1a swappart=s1b targetpart=s1d mbrindex=4
917 # Always prepare a boot pool on MBR
918 # Do not align this partition, there must not be a gap
921 f_eval_catch $funcname gpart \
922 "$GPART_ADD_ALIGN_INDEX_WITH_SIZE" \
923 "" 1 freebsd-zfs ${bootsize}b ${disk}s1 ||
925 # Pedantically nuke any old labels
926 f_eval_catch -d $funcname zpool "$ZPOOL_LABELCLEAR_F" \
928 if [ "$ZFSBOOT_GELI_ENCRYPTION" ]; then
929 # Pedantically detach targetpart for later
930 f_eval_catch -d $funcname geli \
932 /dev/$disk$targetpart
936 # 4. Add freebsd-swap partition
938 if [ ${swapsize:-0} -gt 0 ]; then
939 f_eval_catch $funcname gpart \
940 "$GPART_ADD_ALIGN_INDEX_WITH_SIZE" \
941 "$align_small" 2 freebsd-swap ${swapsize}b ${disk}s1 ||
943 # Pedantically nuke any old labels on the swap
944 f_eval_catch -d $funcname zpool "$ZPOOL_LABELCLEAR_F" \
949 # 5. Add freebsd-zfs partition for zroot
951 f_eval_catch $funcname gpart "$GPART_ADD_ALIGN_INDEX" \
952 "$align_small" $mbrindex freebsd-zfs ${disk}s1 || return $FAILURE
953 f_eval_catch -d $funcname zpool "$ZPOOL_LABELCLEAR_F" \
954 /dev/$disk$targetpart # Pedantic
955 f_eval_catch $funcname dd "$DD_WITH_OPTIONS" \
956 /boot/zfsboot /dev/${disk}s1 count=1 ||
960 esac # $ZFSBOOT_PARTITION_SCHEME
964 f_expand_number "$ZFSBOOT_SWAP_SIZE" swapsize
965 if [ "$isswapmirror" ]; then
966 # This is not the first disk in the mirror, do nothing
967 elif [ "$ZFSBOOT_SWAP_ENCRYPTION" -a "$ZFSBOOT_SWAP_MIRROR" ]; then
968 f_eval_catch $funcname printf "$PRINTF_FSTAB" \
969 /dev/mirror/swap.eli none swap sw 0 0 \
970 $BSDINSTALL_TMPETC/fstab ||
973 elif [ "$ZFSBOOT_SWAP_MIRROR" ]; then
974 f_eval_catch $funcname printf "$PRINTF_FSTAB" \
975 /dev/mirror/swap none swap sw 0 0 \
976 $BSDINSTALL_TMPETC/fstab ||
979 elif [ "$ZFSBOOT_SWAP_ENCRYPTION" ]; then
980 f_eval_catch $funcname printf "$PRINTF_FSTAB" \
981 /dev/$disk${swappart}.eli none swap sw 0 0 \
982 $BSDINSTALL_TMPETC/fstab ||
984 elif [ ${swapsize:-0} -eq 0 ]; then
985 # If swap is 0 sized, don't add it to fstab
987 f_eval_catch $funcname printf "$PRINTF_FSTAB" \
988 /dev/$disk$swappart none swap sw 0 0 \
989 $BSDINSTALL_TMPETC/fstab ||
996 # zfs_create_boot $poolname $vdev_type $disks ...
998 # Creates boot pool and dataset layout. Returns error if something goes wrong.
999 # Errors are printed to stderr for collection and display.
1003 local funcname=zfs_create_boot
1004 local zroot_name="$1"
1005 local zroot_vdevtype="$2"
1006 local zroot_vdevs= # Calculated below
1007 local swap_devs= # Calculated below
1008 local boot_vdevs= # Used for geli(8) and/or MBR layouts
1009 shift 2 # poolname vdev_type
1010 local disks="$*" disk
1012 local bootpart targetpart swappart # Set by zfs_create_diskpart() below
1013 local create_options
1016 # Pedantic checks; should never be seen
1018 if [ ! "$zroot_name" ]; then
1019 f_dprintf "$funcname: NULL poolname"
1020 msg_error="$msg_error: $funcname" \
1021 f_show_err "$msg_null_poolname"
1024 if [ $# -lt 1 ]; then
1025 f_dprintf "$funcname: missing disk arguments"
1026 msg_error="$msg_error: $funcname" \
1027 f_show_err "$msg_missing_disk_arguments"
1030 f_dprintf "$funcname: poolname=[%s] vdev_type=[%s]" \
1031 "$zroot_name" "$zroot_vdevtype"
1034 # Initialize fstab(5)
1036 f_dprintf "$funcname: Initializing temporary fstab(5) file..."
1037 f_eval_catch $funcname sh "$SHELL_TRUNCATE" $BSDINSTALL_TMPETC/fstab ||
1039 f_eval_catch $funcname printf "$PRINTF_FSTAB" \
1040 "# Device" Mountpoint FStype Options Dump "Pass#" \
1041 $BSDINSTALL_TMPETC/fstab || return $FAILURE
1044 # Expand SI units in desired sizes
1046 f_dprintf "$funcname: Expanding supplied size values..."
1047 local swapsize bootsize
1048 if ! f_expand_number "$ZFSBOOT_SWAP_SIZE" swapsize; then
1049 f_dprintf "$funcname: Invalid swap size \`%s'" \
1050 "$ZFSBOOT_SWAP_SIZE"
1051 f_show_err "$msg_invalid_swap_size" "$ZFSBOOT_SWAP_SIZE"
1054 if ! f_expand_number "$ZFSBOOT_BOOT_POOL_SIZE" bootsize; then
1055 f_dprintf "$funcname: Invalid boot pool size \`%s'" \
1056 "$ZFSBOOT_BOOT_POOL_SIZE"
1057 f_show_err "$msg_invalid_boot_pool_size" \
1058 "$ZFSBOOT_BOOT_POOL_SIZE"
1061 f_dprintf "$funcname: ZFSBOOT_SWAP_SIZE=[%s] swapsize=[%s]" \
1062 "$ZFSBOOT_SWAP_SIZE" "$swapsize"
1063 f_dprintf "$funcname: ZFSBOOT_BOOT_POOL_SIZE=[%s] bootsize=[%s]" \
1064 "$ZFSBOOT_BOOT_POOL_SIZE" "$bootsize"
1067 # Destroy the pool in-case this is our second time 'round (case of
1068 # failure and installer presented ``Retry'' option to come back).
1070 # NB: If we don't destroy the pool, later gpart(8) destroy commands
1071 # that try to clear existing partitions (see zfs_create_diskpart())
1072 # will fail with a `Device Busy' error, leading to `GEOM exists'.
1074 f_eval_catch -d $funcname zpool "$ZPOOL_DESTROY" "$zroot_name"
1077 # Prepare the disks and build pool device list(s)
1079 f_dprintf "$funcname: Preparing disk partitions for ZFS pool..."
1081 # Force 4K sectors using vfs.zfs.min_auto_ashift=12
1082 if [ "$ZFSBOOT_FORCE_4K_SECTORS" ]; then
1083 f_dprintf "$funcname: With 4K sectors..."
1084 f_eval_catch $funcname sysctl "$SYSCTL_ZFS_MIN_ASHIFT_12" \
1088 for disk in $disks; do
1089 zfs_create_diskpart $disk $n || return $FAILURE
1090 # Now $bootpart, $targetpart, and $swappart are set (suffix
1092 if [ "$ZFSBOOT_BOOT_POOL" ]; then
1093 boot_vdevs="$boot_vdevs $disk$bootpart"
1095 zroot_vdevs="$zroot_vdevs $disk$targetpart"
1096 if [ "$ZFSBOOT_GELI_ENCRYPTION" ]; then
1097 zroot_vdevs="$zroot_vdevs.eli"
1104 # If we need/want a boot pool, create it
1106 if [ "$ZFSBOOT_BOOT_POOL" ]; then
1107 local bootpool_vdevtype= # Calculated below
1108 local bootpool_options= # Calculated below
1109 local bootpool_name="$ZFSBOOT_BOOT_POOL_NAME"
1110 local bootpool="$BSDINSTALL_CHROOT/$bootpool_name"
1111 local zroot_key="${ZFSBOOT_GELI_KEY_FILE#/}"
1113 f_dprintf "$funcname: Setting up boot pool..."
1114 [ "$ZFSBOOT_GELI_ENCRYPTION" ] &&
1115 f_dprintf "$funcname: For encrypted root disk..."
1117 # Create parent directory for boot pool
1118 f_eval_catch -d $funcname umount "$UMOUNT" /mnt
1119 f_eval_catch $funcname mount "$MOUNT_TYPE" tmpfs none \
1120 $BSDINSTALL_CHROOT || return $FAILURE
1122 # Create mirror across the boot partition on all disks
1124 f_count nvdevs $boot_vdevs
1125 [ $nvdevs -gt 1 ] && bootpool_vdevtype=mirror
1127 create_options="$ZFSBOOT_BOOT_POOL_CREATE_OPTIONS"
1128 bootpool_options="-o altroot=$BSDINSTALL_CHROOT"
1129 bootpool_options="$bootpool_options $create_options"
1130 bootpool_options="$bootpool_options -m \"/$bootpool_name\" -f"
1131 f_eval_catch $funcname zpool "$ZPOOL_CREATE_WITH_OPTIONS" \
1132 "$bootpool_options" "$bootpool_name" \
1133 "$bootpool_vdevtype" "$boot_vdevs" ||
1136 f_eval_catch $funcname mkdir "$MKDIR_P" "$bootpool/boot" ||
1139 if [ "$ZFSBOOT_GELI_ENCRYPTION" ]; then
1140 # Generate an encryption key using random(4)
1141 f_eval_catch $funcname dd "$DD_WITH_OPTIONS" \
1142 /dev/random "$bootpool/$zroot_key" \
1143 "bs=4096 count=1" || return $FAILURE
1144 f_eval_catch $funcname chmod "$CHMOD_MODE" \
1145 go-wrx "$bootpool/$zroot_key" ||
1149 f_eval_catch $funcname zfs "$ZFS_UNMOUNT" \
1150 "$bootpool_name" || return $FAILURE
1151 f_eval_catch -d $funcname umount "$UMOUNT" /mnt # tmpfs
1157 # Create the geli(8) GEOMS
1159 if [ "$ZFSBOOT_GELI_ENCRYPTION" ]; then
1160 # Prompt user for password (twice)
1161 if ! msg_enter_new_password="$msg_geli_password" \
1162 f_dialog_input_password
1164 f_dprintf "$funcname: User cancelled"
1165 f_show_err "$msg_user_cancelled"
1169 # Initialize geli(8) on each of the target partitions
1170 for disk in $disks; do
1171 f_dialog_info "$msg_geli_setup" \
1172 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD
1173 if ! echo "$pw_password" | f_eval_catch \
1174 $funcname geli "$GELI_PASSWORD_INIT" \
1175 "$bootpool/boot/$disk$targetpart.eli" \
1176 AES-XTS "$bootpool/$zroot_key" \
1179 f_interactive || f_die
1180 unset pw_password # Sensitive info
1183 if ! echo "$pw_password" | f_eval_catch \
1184 $funcname geli "$GELI_ATTACH" \
1185 "$bootpool/$zroot_key" $disk$targetpart
1187 f_interactive || f_die
1188 unset pw_password # Sensitive info
1192 unset pw_password # Sensitive info
1195 f_eval_catch $funcname zfs "$ZFS_UNMOUNT" "$bootpool_name" ||
1197 f_eval_catch -d $funcname umount "$UMOUNT" /mnt # tmpfs
1201 # Create the gmirror(8) GEOMS for swap
1203 if [ "$ZFSBOOT_SWAP_MIRROR" ]; then
1204 for disk in $disks; do
1205 swap_devs="$swap_devs $disk$swappart"
1207 f_eval_catch $funcname gmirror "$SWAP_GMIRROR_LABEL" \
1208 "$swap_devs" || return $FAILURE
1212 # Create the ZFS root pool with desired type and disk devices
1214 f_dprintf "$funcname: Creating root pool..."
1215 create_options="$ZFSBOOT_POOL_CREATE_OPTIONS"
1216 f_eval_catch $funcname zpool "$ZPOOL_CREATE_WITH_OPTIONS" \
1217 "-o altroot=$BSDINSTALL_CHROOT $create_options -m none -f" \
1218 "$zroot_name" "$zroot_vdevtype" "$zroot_vdevs" ||
1222 # Create ZFS dataset layout within the new root pool
1224 f_dprintf "$funcname: Creating ZFS datasets..."
1225 echo "$ZFSBOOT_DATASETS" | while read dataset options; do
1226 # Skip blank lines and comments
1227 case "$dataset" in "#"*|"") continue; esac
1228 # Remove potential inline comments in options
1229 options="${options%%#*}"
1230 # Replace tabs with spaces
1231 f_replaceall "$options" " " " " options
1232 # Reduce contiguous runs of space to one single space
1234 while [ "$oldoptions" != "$options" ]; do
1235 oldoptions="$options"
1236 f_replaceall "$options" " " " " options
1238 # Replace both commas and spaces with ` -o '
1239 f_replaceall "$options" "[ ,]" " -o " options
1240 # Create the dataset with desired options
1241 f_eval_catch $funcname zfs "$ZFS_CREATE_WITH_OPTIONS" \
1242 "${options:+-o $options}" "$zroot_name$dataset" ||
1247 # Set a mountpoint for the root of the pool so newly created datasets
1248 # have a mountpoint to inherit
1250 f_dprintf "$funcname: Setting mountpoint for root of the pool..."
1251 f_eval_catch $funcname zfs "$ZFS_SET" \
1252 "mountpoint=/$zroot_name" "$zroot_name" ||
1255 # Touch up permissions on the tmp directories
1256 f_dprintf "$funcname: Modifying directory permissions..."
1258 for dir in /tmp /var/tmp; do
1259 f_eval_catch $funcname chmod "$CHMOD_MODE" 1777 \
1260 $BSDINSTALL_CHROOT$dir || return $FAILURE
1264 if [ "$ZFSBOOT_BOOT_POOL" ]; then
1265 f_dprintf "$funcname: Creating /boot symlink for boot pool..."
1266 f_eval_catch $funcname ln "$LN_SF" "$bootpool_name/boot" \
1267 $BSDINSTALL_CHROOT/boot || return $FAILURE
1270 # Set bootfs property
1271 local zroot_bootfs="$ZFSBOOT_BEROOT_NAME/$ZFSBOOT_BOOTFS_NAME"
1272 f_dprintf "$funcname: Setting bootfs property..."
1273 f_eval_catch $funcname zpool "$ZPOOL_SET" \
1274 "bootfs=\"$zroot_name/$zroot_bootfs\"" "$zroot_name" ||
1277 # Export the pool(s)
1278 f_dprintf "$funcname: Temporarily exporting ZFS pool(s)..."
1279 f_eval_catch $funcname zpool "$ZPOOL_EXPORT" "$zroot_name" ||
1281 if [ "$ZFSBOOT_BOOT_POOL" ]; then
1282 f_eval_catch $funcname zpool "$ZPOOL_EXPORT" \
1283 "$bootpool_name" || return $FAILURE
1286 # MBR boot loader touch-up
1287 if [ "$ZFSBOOT_PARTITION_SCHEME" = "MBR" ]; then
1288 f_dprintf "$funcname: Updating MBR boot loader on disks..."
1289 # Stick the ZFS boot loader in the "convienient hole" after
1290 # the ZFS internal metadata
1291 for disk in $disks; do
1292 f_eval_catch $funcname dd "$DD_WITH_OPTIONS" \
1293 /boot/zfsboot /dev/$disk$bootpart \
1294 "skip=1 seek=1024" || return $FAILURE
1298 # Re-import the ZFS pool(s)
1299 f_dprintf "$funcname: Re-importing ZFS pool(s)..."
1300 f_eval_catch $funcname zpool "$ZPOOL_IMPORT_WITH_OPTIONS" \
1301 "-o altroot=\"$BSDINSTALL_CHROOT\"" "$zroot_name" ||
1303 if [ "$ZFSBOOT_BOOT_POOL" ]; then
1304 f_eval_catch $funcname zpool "$ZPOOL_IMPORT_WITH_OPTIONS" \
1305 "-o altroot=\"$BSDINSTALL_CHROOT\"" \
1306 "$bootpool_name" || return $FAILURE
1309 # While this is apparently not needed, it seems to help MBR
1310 f_dprintf "$funcname: Configuring zpool.cache for zroot..."
1311 f_eval_catch $funcname mkdir "$MKDIR_P" $BSDINSTALL_CHROOT/boot/zfs ||
1313 f_eval_catch $funcname zpool "$ZPOOL_SET" \
1314 "cachefile=\"$BSDINSTALL_CHROOT/boot/zfs/zpool.cache\"" \
1315 "$zroot_name" || return $FAILURE
1317 # Last, but not least... required lines for rc.conf(5)/loader.conf(5)
1318 # NOTE: We later concatenate these into their destination
1319 f_dprintf "%s: Configuring rc.conf(5)/loader.conf(5) additions..." \
1321 f_eval_catch $funcname echo "$ECHO_APPEND" 'zfs_enable=\"YES\"' \
1322 $BSDINSTALL_TMPETC/rc.conf.zfs || return $FAILURE
1323 f_eval_catch $funcname echo "$ECHO_APPEND" \
1324 'kern.geom.label.gptid.enable=\"0\"' \
1325 $BSDINSTALL_TMPBOOT/loader.conf.zfs || return $FAILURE
1327 if [ "$ZFSBOOT_SWAP_MIRROR" ]; then
1328 f_eval_catch $funcname echo "$ECHO_APPEND" \
1329 'geom_mirror_load=\"YES\"' \
1330 $BSDINSTALL_TMPBOOT/loader.conf.gmirror ||
1334 # We're all done unless we should go on for boot pool
1335 [ "$ZFSBOOT_BOOT_POOL" ] || return $SUCCESS
1337 # Set cachefile for boot pool so it auto-imports at system start
1338 f_dprintf "$funcname: Configuring zpool.cache for boot pool..."
1339 f_eval_catch $funcname zpool "$ZPOOL_SET" \
1340 "cachefile=\"$BSDINSTALL_CHROOT/boot/zfs/zpool.cache\"" \
1341 "$bootpool_name" || return $FAILURE
1343 # Some additional geli(8) requirements for loader.conf(5)
1345 'zpool_cache_load=\"YES\"' \
1346 'zpool_cache_type=\"/boot/zfs/zpool.cache\"' \
1347 'zpool_cache_name=\"/boot/zfs/zpool.cache\"' \
1349 f_eval_catch $funcname echo "$ECHO_APPEND" "$option" \
1350 $BSDINSTALL_TMPBOOT/loader.conf.zfs ||
1353 f_eval_catch $funcname printf "$PRINTF_CONF" vfs.root.mountfrom \
1354 "\"zfs:$zroot_name/$zroot_bootfs\"" \
1355 $BSDINSTALL_TMPBOOT/loader.conf.root || return $FAILURE
1357 # We're all done unless we should go on to do encryption
1358 [ "$ZFSBOOT_GELI_ENCRYPTION" ] || return $SUCCESS
1361 # Configure geli(8)-based encryption
1363 f_dprintf "$funcname: Configuring disk encryption..."
1364 f_eval_catch $funcname echo "$ECHO_APPEND" 'aesni_load=\"YES\"' \
1365 $BSDINSTALL_TMPBOOT/loader.conf.aesni || return $FAILURE
1366 f_eval_catch $funcname echo "$ECHO_APPEND" 'geom_eli_load=\"YES\"' \
1367 $BSDINSTALL_TMPBOOT/loader.conf.geli || return $FAILURE
1368 f_eval_catch $funcname echo "$ECHO_APPEND" \
1369 'geom_eli_passphrase_prompt=\"YES\"' \
1370 $BSDINSTALL_TMPBOOT/loader.conf.geli || return $FAILURE
1371 for disk in $disks; do
1372 f_eval_catch $funcname printf "$PRINTF_CONF" \
1373 geli_%s_keyfile0_load "$disk$targetpart YES" \
1374 $BSDINSTALL_TMPBOOT/loader.conf.$disk$targetpart ||
1376 f_eval_catch $funcname printf "$PRINTF_CONF" \
1377 geli_%s_keyfile0_type \
1378 "$disk$targetpart $disk$targetpart:geli_keyfile0" \
1379 $BSDINSTALL_TMPBOOT/loader.conf.$disk$targetpart ||
1381 f_eval_catch $funcname printf "$PRINTF_CONF" \
1382 geli_%s_keyfile0_name \
1383 "$disk$targetpart \"$ZFSBOOT_GELI_KEY_FILE\"" \
1384 $BSDINSTALL_TMPBOOT/loader.conf.$disk$targetpart ||
1391 # dialog_menu_diskinfo
1393 # Prompt the user to select a disk and then provide detailed info on it.
1395 dialog_menu_diskinfo()
1400 # Break from loop when user cancels disk selection
1403 device=$( msg_cancel="$msg_back" f_device_menu \
1404 "$DIALOG_TITLE" "$msg_select_a_disk_device" "" \
1405 $DEVICE_TYPE_DISK 2>&1 ) || break
1406 $device get name disk
1408 # Show gpart(8) `show' and camcontrol(8) `inquiry' data
1409 f_show_msg "$msg_detailed_disk_info" \
1410 "$disk" "$( gpart show $disk 2> /dev/null )" \
1411 "$disk" "$( camcontrol inquiry $disk 2> /dev/null )" \
1412 "$disk" "$( camcontrol identify $disk 2> /dev/null )"
1418 ############################################################ MAIN
1423 f_dialog_title "$msg_zfs_configuration"
1424 f_dialog_backtitle "$msg_freebsd_installer"
1426 # User may have specifically requested ZFS-related operations be interactive
1427 ! f_interactive && f_zfsinteractive && unset $VAR_NONINTERACTIVE
1432 f_dprintf "BSDINSTALL_CHROOT=[%s]" "$BSDINSTALL_CHROOT"
1433 f_dprintf "BSDINSTALL_TMPETC=[%s]" "$BSDINSTALL_TMPETC"
1434 f_dprintf "FSTAB_FMT=[%s]" "$FSTAB_FMT"
1437 # If the system was booted with UEFI, set the default boot type to UEFI
1439 bootmethod=$( sysctl -n machdep.bootmethod )
1440 f_dprintf "machdep.bootmethod=[%s]" "$bootmethod"
1441 if [ "$bootmethod" = "UEFI" ]; then
1442 : ${ZFSBOOT_BOOT_TYPE:=UEFI}
1443 : ${ZFSBOOT_PARTITION_SCHEME:=GPT}
1445 : ${ZFSBOOT_BOOT_TYPE:=BIOS}
1446 : ${ZFSBOOT_PARTITION_SCHEME:=GPT}
1450 # Loop over the main menu until we've accomplished what we came here to do
1453 if ! f_interactive; then
1455 mtag=">>> $msg_install"
1459 f_dialog_menutag_fetch mtag
1462 f_dprintf "retval=%u mtag=[%s]" $retval "$mtag"
1463 [ $retval -eq $DIALOG_OK ] || f_die
1468 # First, validate the user's selections
1471 # Make sure they gave us a name for the pool
1472 if [ ! "$ZFSBOOT_POOL_NAME" ]; then
1473 f_dprintf "Pool name cannot be empty."
1474 f_show_err "$msg_pool_name_cannot_be_empty"
1478 # Validate vdev type against number of disks selected/scripted
1479 # (also validates that ZFSBOOT_DISKS are real [probed] disks)
1480 # NB: dialog_menu_layout supports running non-interactively
1481 dialog_menu_layout || continue
1483 # Make sure each disk will have room for ZFS
1484 if f_expand_number "$ZFSBOOT_SWAP_SIZE" swapsize &&
1485 f_expand_number "$ZFSBOOT_BOOT_POOL_SIZE" bootsize &&
1486 f_expand_number "1g" zpoolmin
1488 minsize=$(( $swapsize + $zpoolmin )) teeny_disks=
1489 [ "$ZFSBOOT_BOOT_POOL" ] &&
1490 minsize=$(( $minsize + $bootsize ))
1491 for disk in $ZFSBOOT_DISKS; do
1492 debug= f_device_find -1 \
1493 $disk $DEVICE_TYPE_DISK device
1494 $device get capacity disksize || continue
1495 [ ${disksize:-0} -ge 0 ] || disksize=0
1496 [ $disksize -lt $minsize ] &&
1497 teeny_disks="$teeny_disks $disk"
1499 if [ "$teeny_disks" ]; then
1500 f_dprintf "swapsize=[%s] bootsize[%s] %s" \
1501 "$ZFSBOOT_SWAP_SIZE" \
1502 "$ZFSBOOT_BOOT_POOL_SIZE" \
1503 "minsize=[$minsize]"
1504 f_dprintf "These disks are too small: %s" \
1506 f_show_err "$msg_these_disks_are_too_small" \
1507 "$ZFSBOOT_SWAP_SIZE" \
1508 "$ZFSBOOT_BOOT_POOL_SIZE" \
1517 if f_interactive; then
1518 dialog_last_chance $ZFSBOOT_DISKS || continue
1525 vdev_type="$ZFSBOOT_VDEV_TYPE"
1527 # Blank the vdev type for the default layout
1528 [ "$vdev_type" = "stripe" ] && vdev_type=
1530 zfs_create_boot "$ZFSBOOT_POOL_NAME" \
1531 "$vdev_type" $ZFSBOOT_DISKS || continue
1535 ?" $msg_pool_type_disks")
1536 ZFSBOOT_CONFIRM_LAYOUT=1
1538 # User has poked settings, disable later confirmation
1539 ZFSBOOT_CONFIRM_LAYOUT=
1541 "- $msg_rescan_devices") f_device_rescan ;;
1542 "- $msg_disk_info") dialog_menu_diskinfo ;;
1544 # Prompt the user to input/change the name for the new pool
1545 f_dialog_input input \
1546 "$msg_please_enter_a_name_for_your_zpool" \
1547 "$ZFSBOOT_POOL_NAME" &&
1548 ZFSBOOT_POOL_NAME="$input"
1550 ?" $msg_force_4k_sectors")
1551 # Toggle the variable referenced both by the menu and later
1552 if [ "$ZFSBOOT_FORCE_4K_SECTORS" ]; then
1553 ZFSBOOT_FORCE_4K_SECTORS=
1555 ZFSBOOT_FORCE_4K_SECTORS=1
1558 ?" $msg_encrypt_disks")
1559 # Toggle the variable referenced both by the menu and later
1560 if [ "$ZFSBOOT_GELI_ENCRYPTION" ]; then
1561 ZFSBOOT_GELI_ENCRYPTION=
1563 ZFSBOOT_FORCE_4K_SECTORS=1
1564 ZFSBOOT_GELI_ENCRYPTION=1
1567 ?" $msg_partition_scheme")
1568 # Toggle between GPT (BIOS), GPT (UEFI) and MBR
1569 if [ "$ZFSBOOT_PARTITION_SCHEME" = "GPT" -a "$ZFSBOOT_BOOT_TYPE" = "BIOS" ]; then
1570 ZFSBOOT_PARTITION_SCHEME="GPT"
1571 ZFSBOOT_BOOT_TYPE="UEFI"
1572 elif [ "$ZFSBOOT_PARTITION_SCHEME" = "GPT" ]; then
1573 ZFSBOOT_PARTITION_SCHEME="MBR"
1574 ZFSBOOT_BOOT_TYPE="BIOS"
1575 elif [ "$ZFSBOOT_PARTITION_SCHEME" = "MBR" ]; then
1576 ZFSBOOT_PARTITION_SCHEME="GPT + Active"
1577 ZFSBOOT_BOOT_TYPE="BIOS"
1578 elif [ "$ZFSBOOT_PARTITION_SCHEME" = "GPT + Active" ]; then
1579 ZFSBOOT_PARTITION_SCHEME="GPT + Lenovo Fix"
1580 ZFSBOOT_BOOT_TYPE="BIOS"
1582 ZFSBOOT_PARTITION_SCHEME="GPT"
1583 ZFSBOOT_BOOT_TYPE="BIOS"
1587 # Prompt the user to input/change the swap size for each disk
1589 f_dialog_input input \
1590 "$msg_please_enter_amount_of_swap_space" \
1591 "$ZFSBOOT_SWAP_SIZE" &&
1592 ZFSBOOT_SWAP_SIZE="${input:-0}"
1593 if f_expand_number "$ZFSBOOT_SWAP_SIZE" swapsize
1595 if [ $swapsize -ne 0 -a $swapsize -lt 104857600 ]; then
1596 f_show_err "$msg_swap_toosmall" \
1597 "$ZFSBOOT_SWAP_SIZE"
1603 f_show_err "$msg_swap_invalid" \
1604 "$ZFSBOOT_SWAP_SIZE"
1609 ?" $msg_swap_mirror")
1610 # Toggle the variable referenced both by the menu and later
1611 if [ "$ZFSBOOT_SWAP_MIRROR" ]; then
1612 ZFSBOOT_SWAP_MIRROR=
1614 ZFSBOOT_SWAP_MIRROR=1
1617 ?" $msg_swap_encrypt")
1618 # Toggle the variable referenced both by the menu and later
1619 if [ "$ZFSBOOT_SWAP_ENCRYPTION" ]; then
1620 ZFSBOOT_SWAP_ENCRYPTION=
1622 ZFSBOOT_SWAP_ENCRYPTION=1
1630 ################################################################################
1632 ################################################################################