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