Skip site navigation (1)Skip section navigation (2)
Date:      Sun, 11 Dec 2022 11:09:25 +0100
From:      Gordon Bergling <gbe@freebsd.org>
To:        Mike Karels <karels@freebsd.org>
Cc:        src-committers@freebsd.org, dev-commits-src-all@freebsd.org, dev-commits-src-main@freebsd.org
Subject:   Re: git: 4a30d7bb373c - main - growfs script: add swap partition as well as growing root
Message-ID:  <Y5WsVX7GSqhKFjzy@lion.ttyv0.de>
In-Reply-To: <202212101941.2BAJfDx0085242@gitrepo.freebsd.org>
References:  <202212101941.2BAJfDx0085242@gitrepo.freebsd.org>

next in thread | previous in thread | raw e-mail | index | archive | help

--NFh+9eNsllkFuJIc
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

Hi Mike,

thanks for implementation. After the MFC and the new -STABLE snapshots
I am really looking forward to try this out an my RPi4B.

--Gordon

On Sat, Dec 10, 2022 at 07:41:13PM +0000, Mike Karels wrote:
> The branch main has been updated by karels:
>=20
> URL: https://cgit.FreeBSD.org/src/commit/?id=3D4a30d7bb373c08f42f953b9cd1=
e793e236b4cd92
>=20
> commit 4a30d7bb373c08f42f953b9cd1e793e236b4cd92
> Author:     Mike Karels <karels@FreeBSD.org>
> AuthorDate: 2022-12-10 19:38:36 +0000
> Commit:     Mike Karels <karels@FreeBSD.org>
> CommitDate: 2022-12-10 19:38:36 +0000
>=20
>     growfs script: add swap partition as well as growing root
>    =20
>     Add the ability to create a swap partition in the course of growing
>     the root file system on first boot, enabling by default.  The default
>     rules are: add swap if the disk is at least 15 GB (decimal), and the
>     existing root is less than 40% of the disk.  The default size is 10%
>     of the disk, but is limited by the memory size.  The limit is twice
>     memory size up to 4 GB, 8 GB up to 8 GB memory, and memory size over
>     8 GB memory. Swap size is clamped at vm.swap_maxpages/2 as well.
>     The new swap partition is labeled as "growfs_swap".
>    =20
>     The default behavior can be overridden by setting growfs_swap_size in
>     /etc/rc.conf or in the kernel environment, with kenv taking priority.
>     A value of 0 inhibits the addition of swap, an empty value specifies
>     the default, and other values indicate a swap size in bytes.
>    =20
>     By default, addition of swap is inhibited if a swap partition is found
>     in the output of the sysctl kern.geom.conftxt before the current root
>     partition, usually meaning that there is another disk present.
>     Swap space is not added if one is already present in /etc/fstab.
>    =20
>     The root partition is read-only when growfs runs, so /etc/fstab can
>     not be modified.  That step is handled by a new growfs_fstab script,
>     added in a separate commit.  Set the value "growfs_swap_pdev" in kenv
>     to indicate that this should be done, as well as for internal use.
>    =20
>     There is optional verbose output meant for debugging; it can only be
>     enabled by modifying the script (in two places, for sh and awk).
>     This should be removed before release, after testing on -current.
>    =20
>     Discussed with: cperciva
>     Reviewed by:    imp (previous version)
>     Differential Revision:  https://reviews.freebsd.org/D37462
> ---
>  libexec/rc/rc.d/growfs | 178 +++++++++++++++++++++++++++++++++++++++++++=
++++--
>  1 file changed, 172 insertions(+), 6 deletions(-)
>=20
> diff --git a/libexec/rc/rc.d/growfs b/libexec/rc/rc.d/growfs
> index 5402bd442279..3c48a7dca6b2 100755
> --- a/libexec/rc/rc.d/growfs
> +++ b/libexec/rc/rc.d/growfs
> @@ -1,5 +1,6 @@
>  #!/bin/sh
>  #
> +# Copyright 2022 Michael J. Karels
>  # Copyright 2014 John-Mark Gurney
>  # All rights reserved.
>  #
> @@ -32,8 +33,9 @@
>  # BEFORE: root
>  # KEYWORD: firstboot
> =20
> -# This allows us to distribute an image
> -# and have it work on essentially any size drive.
> +# Grow root partition to fill available space, optionally adding a swap
> +# partition at the end.  This allows us to distribute an image and
> +# have it work on essentially any size drive.
> =20
>  # Note that this uses awk(1), and thus will not work if /usr is on a sep=
arate
>  # filesystem.  We need to run early, because there might be not enough f=
ree
> @@ -48,7 +50,7 @@ start_cmd=3D"growfs_start"
>  stop_cmd=3D":"
>  rcvar=3D"growfs_enable"
> =20
> -growfs_get_diskdev ()
> +growfs_get_diskdev()
>  {
>  	local _search=3D${1}
>  	sysctl -b kern.geom.conftxt |
> @@ -61,8 +63,51 @@ growfs_get_diskdev ()
>  	done
>  }
> =20
> -growfs_start ()
> +# Compute upper bound on swap partition size (if added), based on physmem
> +# and vm.swap_maxpages / 2 (the limit that elicits a warning).
> +# Rule for swap size based on memory size:
> +#	up to 4 GB	twice memory size
> +#	4 GB - 8 GB	8 GB
> +#	over 8 GB	memory size
> +growfs_swap_max()
>  {
> +	memsize=3D$(sysctl -n hw.physmem)
> +	memsizeMB=3D$(($memsize / (1024 * 1024)))
> +
> +	if  [ $memsizeMB -lt 4096 ]
> +	then
> +		swapmax=3D$(($memsize * 2))
> +	elif  [ $memsizeMB -lt 8192 ]
> +	then
> +		swapmax=3D$((8192 * 1024 * 1024))
> +	else
> +		swapmax=3D$memsize
> +	fi
> +
> +	pagesize=3D$(sysctl -n hw.pagesize)
> +	vm_swap_max=3D$(($(sysctl -n vm.swap_maxpages) / 2 * $pagesize))
> +
> +	if [ $swapmax -gt $vm_swap_max ]
> +	then
> +		$swapmax=3D$vm_swap_max
> +	fi
> +	echo -n "$swapmax"
> +}
> +
> +# Find newly-added swap partition on parent device ($1).
> +growfs_last_swap()
> +{
> +	swapdev=3D$(gpart list $1 | awk '
> +		$2 =3D=3D "Name:" { dev =3D $3 }
> +		$1 =3D=3D "type:" && $2 =3D=3D "freebsd-swap" { swapdev =3D dev }
> +		END { print swapdev }
> +	    ')
> +	echo -n $swapdev
> +}
> +
> +growfs_start()
> +{
> +	verbose=3D0
>  	echo "Growing root partition to fill device"
>  	FSTYPE=3D$(mount -p | awk '{ if ( $2 =3D=3D "/") { print $3 }}')
>  	FSDEV=3D$(mount -p | awk '{ if ( $2 =3D=3D "/") { print $1 }}')
> @@ -100,19 +145,126 @@ growfs_start ()
>  		diskdev=3D${rootdev}
>  	fi
> =20
> +	# Check kenv for growfs_swap_size; if not present,
> +	# check $growfs_swap_size from /etc/rc.conf.
> +	# A value of 0 suppresses swap addition,
> +	# "" (or unset) specifies the default;
> +	# other values indicate the size in bytes.
> +	# If default, check whether swap is already in fstab;
> +	# if so, don't add another.
> +	addswap=3D1
> +	swapsize=3D"$(kenv -q growfs_swap_size 2>/dev/null)"
> +	case "$swapsize" in
> +	"0")	addswap=3D0
> +		;;
> +	"")	case "$growfs_swap_size" in
> +		"0")	addswap=3D0
> +			;;
> +		"")
> +			if ! awk '
> +				/^#/ { next }
> +				$3 =3D=3D "swap" { exit 1 }
> +			    ' < /etc/fstab
> +			then
> +				addswap=3D0
> +			fi
> +			;;
> +		*)	swapsize=3D"$growfs_swap_size"
> +			;;
> +		esac
> +		;;
> +	*)	;;
> +	esac
> +
> +	swaplim=3D$(growfs_swap_max)
> +
> +	[ $verbose -eq 1 ] && {
> +		echo "diskdev is $diskdev"
> +		echo "search is $search"
> +		echo "swapsize is $swapsize"
> +		echo "swaplim is $swaplim"
> +	}
> +
>  	sysctl -b kern.geom.conftxt | awk '
>  {
> +	verbose =3D 0
>  	lvl=3D$1
>  	device[lvl] =3D $3
>  	type[lvl] =3D $2
>  	idx[lvl] =3D $7
> +	offset[lvl] =3D $9
>  	parttype[lvl] =3D $13
> +	size[lvl] =3D $4
> +	if (verbose) print lvl, type[lvl], $3
> +	if (type[lvl] =3D=3D "DISK") {
> +		disksize =3D size[lvl]
> +		if (verbose)
> +			print "disksize ", disksize
> +		# Don't add swap on disks under 15 GB (decimal) by default.
> +		if (addswap =3D=3D 1 && (size[lvl] > 15000000000 || swapsize > 0))
> +			doing_swap =3D 1
> +		else
> +			doing_swap =3D 0
> +	} else if (type[lvl] =3D=3D "PART" && $11 =3D=3D "freebsd-swap" && \
> +	    int(swapsize) =3D=3D 0) {
> +		# This finds swap only if it precedes root, e.g. preceding disk.
> +		addswap =3D 0
> +		doing_swap =3D 0
> +		print "swap device exists, not adding swap"
> +	}
>  	if (dev =3D=3D $3) {
>  		for (i =3D 1; i <=3D lvl; i++) {
>  			# resize
>  			if (type[i] =3D=3D "PART") {
>  				pdev =3D device[i - 1]
> -				cmd[i] =3D "gpart resize -i " idx[i] " " pdev
> +				if (verbose)
> +					print i, pdev, addswap, disksize, \
> +					    doing_swap
> +				swapcmd =3D ""
> +				# Allow swap if current root is < 40% of disk.
> +				if (parttype[i] !=3D "MBR" && doing_swap =3D=3D 1 && \
> +				    (size[i] / disksize < 0.4 || \
> +				    swapsize > 0)) {
> +					print "Adding swap partition"
> +					if (int(swapsize) =3D=3D 0) {
> +						swapsize =3D int(disksize / 10)
> +						if (swapsize > swaplim)
> +							swapsize =3D swaplim
> +					}
> +					sector =3D $5
> +					swapsize /=3D sector
> +					if (verbose)
> +						print "swapsize sectors",
> +						    swapsize
> +					align =3D 4 * 1024 * 1024 / sector
> +
> +					# Estimate offset for swap; let
> +					# gpart compute actual start and size.
> +					# Assume expansion all goes into this
> +					# partition for MBR case.
> +					if (parttype[i - 1] =3D=3D "MBR") {
> +					    if (verbose)
> +						print "sz ", size[i - 1], \
> +						    " off ", offset[i - 1]
> +					    expand =3D size[0] - \
> +						(size[i - 1] + offset[i - 1])
> +					} else {
> +					    if (verbose)
> +						print "sz ", size[i], \
> +						    " off ", offset[i]
> +					    expand =3D size[0] - \
> +						(size[i] + offset[i])
> +					}
> +					if (verbose)
> +					    print "expand ", expand, \
> +						" sz ", size[i]
> +					swapbase =3D (expand + size[i]) / sector
> +					swapbase -=3D swapsize + align
> +					swapcmd =3D "gpart add -t freebsd-swap -a " align " -b " swapbase "=
 " pdev "; kenv growfs_swap_pdev=3D" pdev " >/dev/null; "
> +					if (verbose)
> +						swapcmd =3D "set -x; " swapcmd
> +				}
> +				cmd[i] =3D swapcmd "gpart resize -i " idx[i] " " pdev
>  				if (parttype[i] =3D=3D "GPT")
>  					cmd[i] =3D "gpart recover " pdev " ; " cmd[i]
>  			} else if (type[i] =3D=3D "LABEL") {
> @@ -128,7 +280,7 @@ growfs_start ()
>  		}
>  		exit 0
>  	}
> -}' dev=3D"$search"
> +}' dev=3D"$search" addswap=3D"$addswap" swapsize=3D"$swapsize" swaplim=
=3D"$swaplim"
>  	gpart commit "$diskdev" 2> /dev/null
>  	case "$FSTYPE" in
>  	ufs)
> @@ -138,6 +290,20 @@ growfs_start ()
>  		zpool online -e $pool $rootdev
>  		;;
>  	esac
> +
> +	# Get parent device of swap partition if one was added;
> +	# if so, find swap device and label it.
> +	pdev=3D$(kenv -q growfs_swap_pdev)
> +	if [ -n "$pdev" ]
> +	then
> +		dev=3D$(growfs_last_swap "$pdev")
> +		if [ -z "$dev" ]
> +		then
> +			echo "Swap partition not found on $pdev"
> +			exit 0
> +		fi
> +		glabel label -v growfs_swap $dev
> +	fi
>  }
> =20
>  load_rc_config $name
>=20

--=20

--NFh+9eNsllkFuJIc
Content-Type: application/pgp-signature; name="signature.asc"

-----BEGIN PGP SIGNATURE-----

iQGTBAEBCgB9FiEEYbWI0KY5X7yH/Fy4OQX2V8rP09wFAmOVrE9fFIAAAAAALgAo
aXNzdWVyLWZwckBub3RhdGlvbnMub3BlbnBncC5maWZ0aGhvcnNlbWFuLm5ldDYx
QjU4OEQwQTYzOTVGQkM4N0ZDNUNCODM5MDVGNjU3Q0FDRkQzREMACgkQOQX2V8rP
09yr7wgAo13XQQ+m8SyeSCCjardR/qs6y2MfAspTSkUcOFXCKOocU+HqhxHASv9M
NKV59qpzE5EOPau2bWTJyhvbgkT/7dnHuExV405MWhOwpKw6C6cFYCjpHJAIeLPW
PzxChCEZk4QCcflymF4mo/gU+enPwnnff6POS/9JYFNfo6o8jeg4a2ktMTiakPAY
TDX+Numwx5c5IewMsFtQ+6m81fuoR1D+CTvwzT1NZntrgk6z2/dEeO7MKiUL83rc
t9kh/tN/R/TexxuDOqatmfZemHWfmOHyv8lXUXN/f+wV53Rtaq7zkJKMJWfwPdQS
ZdqftLxwyHUZOgOY4Efmt4PA8rDguA==
=2X6p
-----END PGP SIGNATURE-----

--NFh+9eNsllkFuJIc--



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?Y5WsVX7GSqhKFjzy>