===================================================================
RCS file: /cvs/openbsd/fw_update/fw_install.sh,v
retrieving revision 1.49
retrieving revision 1.102
diff -u -r1.49 -r1.102
--- openbsd/fw_update/fw_install.sh	2021/12/02 04:00:37	1.49
+++ openbsd/fw_update/fw_install.sh	2021/12/22 04:43:41	1.102
@@ -1,7 +1,6 @@
 #!/bin/ksh
-#	$OpenBSD: fw_install.sh,v 1.49 2021/12/02 04:00:37 afresh1 Exp $
-set -e
-
+#	$OpenBSD: fw_install.sh,v 1.102 2021/12/22 04:43:41 afresh1 Exp $
+#
 # Copyright (c) 2021 Andrew Hewus Fresh <afresh1@openbsd.org>
 #
 # Permission to use, copy, modify, and distribute this software for any
@@ -16,249 +15,307 @@
 # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
-# Fake up some things from install.sub that we don't need to actually do
-prefetcharea_fs_list() {
-	echo "${DESTDIR}/tmp"
-}
+set -o errexit -o pipefail -o nounset -o noclobber -o noglob
+set +o monitor
+export PATH=/usr/bin:/bin:/usr/sbin:/sbin
 
-# tmpdir, do_as, and unpriv are from install.sub
-# modified to use su(1) when not in the installer.
-# modified to use mktemp(1) when not in the installer.
+CFILE=SHA256.sig
+DESTDIR=${DESTDIR:-}
+FWPATTERNS="${DESTDIR}/usr/share/misc/firmware_patterns"
 
-# Create a temporary directory based on the supplied directory name prefix.
+VNAME=${VNAME:-$(sysctl -n kern.osrelease)}
+VERSION=${VERSION:-"${VNAME%.*}${VNAME#*.}"}
+
+HTTP_FWDIR="$VNAME"
+VTYPE=$( sed -n "/^OpenBSD $VNAME\([^ ]*\).*$/s//\1/p" \
+    /var/run/dmesg.boot | sed '$!d' )
+[[ $VTYPE == -!(stable) ]] && HTTP_FWDIR=snapshots
+
+FWURL=http://firmware.openbsd.org/firmware/${HTTP_FWDIR}
+FWPUB_KEY=${DESTDIR}/etc/signify/openbsd-${VERSION}-fw.pub
+
+VERBOSE=false
+DOWNLOAD=true
+INSTALL=true
+LOCALSRC=
+
 tmpdir() {
 	local _i=1 _dir
-	if [[ -z $1 ]]; then
-		echo No tmpdir >&2
-		exit 1
-	fi
 
-	if [[ -e /usr/bin/mktemp ]]; then
-		_dir=$( /usr/bin/mktemp -d $1 )
-		chown _file "$_dir"
+	# If we're not in the installer,
+	# we have mktemp and a more hostile environment.
+	if [ -x /usr/bin/mktemp ]; then
+		_dir=$( mktemp -d "${1}-XXXXXXXXX" )
 	else
-		until _dir="${1%-+(X)}.$_i.$RANDOM" && mkdir -- "$_dir" 2>/dev/null; do
+		until _dir="${1}.$_i.$RANDOM" && mkdir -- "$_dir" 2>/dev/null; do
 		    ((++_i < 10000)) || return 1
 		done
 	fi
+
 	echo "$_dir"
 }
 
-# Run a command ($2+) as unprivileged user ($1).
-# Take extra care that after "cmd" no "user" processes exist.
-#
-# Optionally:
-#	- create "file" and chown it to "user"
-#	- after "cmd", chown "file" back to root
-#
-# Usage: do_as user [-f file] cmd
-do_as() {
-	(( $# >= 2 )) || return
+fetch() {
+	local _src="${FWURL}/${1##*/}" _dst=$1 _user=_file _pid _exit _error=''
 
-	local _file _rc _user=$1
-	shift
-
-	if [[ $1 == -f ]]; then
-		_file=$2
-		shift 2
+	# If we're not in the installer,
+	# we have su(1) and doas(1) is unlikely to be configured.
+	set -o monitor # make sure ftp gets its own process group
+	(
+	flags=-VM
+	"$VERBOSE" && flags=-vm
+	if [ -x /usr/bin/su ]; then
+		exec /usr/bin/su -s /bin/ksh "$_user" -c \
+		    "/usr/bin/ftp -D 'Get/Verify' $flags -o- '$_src'" > "$_dst"
+	else
+		exec /usr/bin/doas -u "$_user" \
+		    /usr/bin/ftp -D 'Get/Verify' $flags -o- "$_src" > "$_dst"
 	fi
+	) & _pid=$!
+	set +o monitor
 
-	if [[ -n $_file ]]; then
-		>$_file
-		chown "$_user" "$_file"
+	trap "kill -TERM '-$_pid' 2>/dev/null; exit 1" EXIT INT QUIT ABRT TERM
+
+	SECONDS=0
+	_last=0
+	while kill -0 -"$_pid" 2>/dev/null; do
+		if [[ $SECONDS -gt 12 ]]; then
+			set -- $( ls -ln "$_dst" 2>/dev/null )
+			if [[ $_last -ne $5 ]]; then
+				_last=$5
+				SECONDS=0
+				sleep 1
+			else
+				kill -INT -"$_pid"
+				_error=" (timed out)"
+			fi
+		else
+			sleep 1
+		fi
+	done
+
+	set +o errexit
+	wait "$_pid"
+	_exit=$?
+	set -o errexit
+
+	trap "" EXIT INT QUIT ABRT TERM
+
+	if [ "$_exit" -ne 0 ]; then
+		rm -f "$_dst"
+		echo "Cannot fetch $_src$_error" >&2
+		return 1
 	fi
+}
 
-	if [[ -x /usr/bin/su ]]; then
-		/usr/bin/su -s /bin/ksh "$_user" -c "$*"
-	else
-		doas -u "$_user" "$@"
+verify() {
+	# On the installer we don't get sha256 -C, so fake it.
+	if ! fgrep -qx "SHA256 (${1##*/}) = $( /bin/sha256 -qb "$1" )" "$CFILE"; then
+		echo "Checksum test for ${1##*/} failed." >&2
+		return 1
 	fi
-	_rc=$?
+}
 
-	while doas -u "$_user" kill -9 -1 2>/dev/null; do
-		echo "Processes still running for user $_user after: $@"
-		sleep 1
-	done
+devices_needing_firmware() {
+	local _d _m _line _dmesgtail _last='' _nl=$( echo )
 
-	[[ -n $_file ]] && chown root "$_file"
+	# When we're not in the installer, the dmesg.boot can
+	# contain multiple boots, so only look in the last one
+	_dmesgtail="$( echo ; sed -n 'H;/^OpenBSD/h;${g;p;}' /var/run/dmesg.boot |
+	    grep -e "^[a-z][a-z]*[0-9]" -e " not configured " )"
 
-	return $_rc
+	grep -v '^[[:space:]]*#' "$FWPATTERNS" |
+	    while read -r _d _m; do
+		[ "$_d" = "$_last" ] && continue
+		[ "$_m" ]             || _m="${_nl}${_d}[0-9] at "
+		[ "$_m" = "${_m#^}" ] || _m="${_nl}${_m#^}"
+
+		if [[ $_dmesgtail = *$_m* ]]; then
+			echo "$_d"
+			_last="$_d"
+		fi
+	    done
 }
 
-unpriv() {
-	do_as _file "$@"
+firmware_filename() {
+	local _f
+	_f="$( sed -n "s/.*(\($1-firmware-.*\.tgz\)).*/\1/p" "$CFILE" | sed '$!d' )"
+	! [ "$_f" ] && echo "Unable to find firmware for $1" >&2 && return 1
+	echo "$_f"
 }
 
-VNAME=${VNAME:-$(sysctl -n kern.osrelease)}
-VERSION=${VERSION:-"${VNAME%.*}${VNAME#*.}"}
-FWDIR=${FWDIR:-$VNAME}
+firmware_devicename() {
+	local _d="${1##*/}"
+	_d="${_d%-firmware-*}"
+	echo "$_d"
+}
 
-# TODO: We need the firmware for the system we just installed
-#       not the one we booted from.  For example:
-#       * booting from a snapshot bsd.rd that thinks it is the 7.0 release
-#         will install the firmware from the 7.0 directory instead of
-#         from the snapshots dir.
-#       If they're using sysupgrade, then the installer kernel will be correct.
-#       If we're doing this in the installer we can check what they picked
-#       for downloading sets and use that value.
-#       Otherwise, the fw_update after first boot will fix it up for us.
+installed_firmware() {
+	set +o noglob
+	for fw in "${DESTDIR}/var/db/pkg/$1-firmware"*; do
+		[ -e "$fw/+CONTENTS" ] || continue
+		echo "${fw##*/}"
+	done
+	set -o noglob
+}
 
-HTTP_FWDIR=$FWDIR
-VTYPE=$( sed -n "/^OpenBSD $VNAME\([^ ]*\).*$/s//\1/p" /var/run/dmesg.boot | sed '$!d' )
-[[ $VTYPE == -!(stable) ]] && HTTP_FWDIR=snapshots
+add_firmware () {
+	local _f="${1##*/}"
+	local _pkgdir="${DESTDIR}/var/db/pkg/${_f%.tgz}"
+	local flags=-VM
+	"$VERBOSE" && flags=-vm
+	ftp -D "Install" "$flags" -o- "file:${1}" |
+		tar -s ",^\+,${_pkgdir}/+," \
+		    -s ",^firmware,${DESTDIR}/etc/firmware," \
+		    -C / -zxphf - "+*" "firmware/*"
 
-FWURL=http://firmware.openbsd.org/firmware/${HTTP_FWDIR}
-FWPUB_KEY=${DESTDIR}/etc/signify/openbsd-${VERSION}-fw.pub
-FWPATTERNS="${DESTDIR}/usr/share/misc/firmware_patterns"
+	# TODO: Should we mark these so real fw_update can -Drepair?
+	ed -s "${_pkgdir}/+CONTENTS" <<EOL
+/^@comment pkgpath/ -1a
+@option manual-installation
+@option firmware
+@comment install-script
+.
+w
+EOL
+}
 
-# TODO: support srclocal installation of firmware somehow
-fw_install() {
-	local _src=$1 _tmpfs_list _tmpfs _tmpsrc \
-		_t=Get _cfile="/tmp/SHA256" _pkgdir=${DESTDIR}/var/db/pkg \
-		_f _r _remove _i _installed
-	local _srclocal=false _unpriv=unpriv
+delete_firmware() {
+	local _cwd _pkg="$1" _pkgdir="${DESTDIR}/var/db/pkg"
 
-	local _d _drivers=$(
-		last=''
-		while read _d _m; do
-			grep=grep
-			[ "$last" = "$_d" ] && continue
-			[ "$_m" ] || _m="^$_d[0-9][0-9]* at "
-			[ "$_m" = "${_m#^}" ] && grep=fgrep
-			$grep -q "$_m" /var/run/dmesg.boot || continue
-			echo $_d
-			last=$_d
-		done < $FWPATTERNS
-	)
+	# TODO: Check hash for files before deleting
+	"$VERBOSE" && echo "Uninstalling $_pkg"
+	_cwd="${_pkgdir}/$_pkg"
 
-	if [ -z "$_drivers" ]; then
-		echo "No devices found which need firmware files to be downloaded."
-		return
-	fi
+	set -A _remove -- "${_cwd}/+CONTENTS" "${_cwd}"
 
-	! _tmpfs_list=$(prefetcharea_fs_list) &&
-		echo "Cannot determine prefetch area" >&2 && return
+	while read -r c g; do
+		case $c in
+		@cwd) _cwd="${DESTDIR}$g"
+		  ;;
+		@*) continue
+		  ;;
+		*) set -A _remove -- "$_cwd/$c" "${_remove[@]}"
+		  ;;
+		esac
+	done < "${_pkgdir}/${_pkg}/+CONTENTS"
 
-	for _tmpfs in $_tmpfs_list; do
-		# Try to clean up from previous runs, assuming
-		# the _tmpfs selection yields the same mount
-		# point.
-		for _tmpsrc in $_tmpfs/firmware.+([0-9]).+([0-9]); do
-			[[ -d $_tmpsrc ]] && rm -r $_tmpsrc
-		done
-
-		# Create a download directory for the firmware and
-		# check that the _file user can read files from
-		# it. Otherwise cleanup and skip the filesystem.
-		if _tmpsrc=$(tmpdir "$_tmpfs/firmware-XXXXXXXXX"); then
-			(
-			>$_tmpsrc/t &&
-			$_unpriv cat $_tmpsrc/t
-			) >/dev/null 2>&1 && break ||
-				rm -r $_tmpsrc
+	# We specifically rm -f here because not removing files/dirs
+	# is probably not worth failing over.
+	for _r in "${_remove[@]}" ; do
+		if [ -d "$_r" ]; then
+			# Try hard not to actually remove recursively
+			# without rmdir on the install media.
+			set +o noglob
+			[ "$_r/*" = "$( echo "$_r"/* )" ] && rm -rf "$_r"
+			set -o noglob
+		else
+			rm -f "$_r"
 		fi
 	done
+}
 
-	[[ ! -d $_tmpsrc ]] &&
-		echo "Cannot create prefetch area" >&2 && return 1
+usage() {
+	echo "usage:  ${0##*/} [-D | -L] [driver | file ...]"
+	exit 2
+}
 
-	# Cleanup from previous runs.
-	rm -f $_cfile $_cfile.sig
+OPT_D=
+OPT_L=
+while getopts :DLv name
+do
+       case "$name" in
+       D) OPT_D=true ;;
+       L) OPT_L=true ;;
+       v) VERBOSE=true ;;
+       ?) echo "${0##*/}: unknown option -- -$OPTARG"; usage 2 ;;
+       esac
+done
+shift $((OPTIND - 1))
 
-	_t=Get/Verify
+[ "$OPT_D" ] && [ "$OPT_L" ] && usage 1
 
-	! $_unpriv ftp -D "$_t" -Vmo - "$_src/SHA256.sig" >"$_cfile.sig" &&
-	    echo "Cannot fetch SHA256.sig" >&2 && return 1
+if [ "$OPT_D" ]; then
+	# "Download only" means local dir and don't install
+	INSTALL=false
+	LOCALSRC=.
+elif [ "$OPT_L" ]; then
+	# "Local" means don't download, install from local dir
+	DOWNLOAD=false
+	LOCALSRC=.
+else
+	LOCALSRC="$( tmpdir "${DESTDIR}/tmp/${0##*/}" )"
+fi
 
-	# Verify signature file with public keys.
-	! signify -Vep $FWPUB_KEY -x "$_cfile.sig" -m "$_cfile" &&
-	    echo "Signature check of SHA256.sig failed" >&2 && return 1
+CFILE="$LOCALSRC/$CFILE"
 
-	for _d in $_drivers; do
-		_f=$( sed -n "s/.*(\($_d-firmware-.*\.tgz\)).*/\1/p" "$_cfile" | sed '$!d' )
-		_installed=$(
-	        for fw in "${_pkgdir}/$_d-firmware"*; do
-		        [ -e "$fw" ] || continue
-		        echo ${fw##*/}
-	        done
-		)
+if "$INSTALL" && [ -x /usr/bin/id ] && [ $(/usr/bin/id -u) != 0 ]; then
+	echo "need root privileges" >&2
+	exit 1
+fi
 
-		for _i in $_installed; do
-			if [ "$_f" = "$_i.tgz" ]; then
-				echo "$_i already installed"
-				continue 2
-			fi
-		done
+set -A devices -- "$@"
 
-		rm -f /tmp/h /tmp/fail
+if [ ! "${devices[*]:-}" ]; then
+	"$VERBOSE" && echo -n "Detecting firmware ..."
+	set -A devices -- $( devices_needing_firmware )
+	"$VERBOSE" &&
+	    { [ "${devices[*]:-}" ] && echo " found." || echo " done." ; }
+fi
 
-		# Fetch firmware file and create a checksum by piping through
-		# sha256. Create a flag file in case ftp failed. Firmware
-		# from net is written to the prefetch area.
-		( $_unpriv ftp -D "$_t" -Vmo - "$_src/$_f" || >/tmp/fail ) |
-		( $_srclocal && sha256 -b >/tmp/h ||
-		    sha256 -bph /tmp/h >"$_tmpsrc/$_f" )
+[ "${devices[*]:-}" ] || exit
 
-		# Handle failed transfer.
-		if [[ -f /tmp/fail ]]; then
-			rm -f "$_tmpsrc/$_f"
-			echo "Fetching of $_f failed!" >&2
-			continue
-		fi
+if "$DOWNLOAD"; then
+	fetch "$CFILE"
+	! signify -qVep "$FWPUB_KEY" -x "$CFILE" -m "$CFILE" &&
+	    echo "Signature check of SHA256.sig failed" >&2 && exit 1
+fi
 
-		# Verify firmware by comparing its checksum with SHA256.
-		if ! fgrep -qx "SHA256 ($_f) = $(</tmp/h)" "$_cfile"; then
-			[[ -d "$_tmpsrc" ]] && rm -rf "$_tmpsrc"
-			echo "Checksum test for $_f failed." >&2
-			continue
-		fi
+for f in "${devices[@]}"; do
+	d="$( firmware_devicename "$f" )"
 
-		# TODO: Check hash for files before deleting
-		if [ "$_installed" ] && [ -e "${_pkgdir}/$_installed/+CONTENTS" ]; then
-			echo "Uninstalling $_installed"
-			cwd=${_pkgdir}/$_installed
+	if [ "$f" = "$d" ]; then
+		f=$( firmware_filename "$d" || true )
+		[ "$f" ] || continue
+		f="$LOCALSRC/$f"
+	elif ! "$INSTALL" && ! grep -Fq "($f)" "$CFILE" ; then
+		echo "Cannot download local file $f" >&2
+		exit 2
+	fi
 
-			set -A _remove -- "${cwd}/+CONTENTS" "${cwd}"
+	set -A installed -- $( installed_firmware "$d" )
 
-			while read c g; do
-				case $c in
-				@cwd) cwd="${DESTDIR}/$g"
-				  ;;
-				@*) continue
-				  ;;
-				*)  set -A _remove -- "$cwd/$c" "${_remove[@]}"
-				  ;;
-				esac
-			done < "${_pkgdir}/$_installed/+CONTENTS"
+	if "$INSTALL" && [ "${installed[*]:-}" ]; then
+		for i in "${installed[@]}"; do
+			if [ "${f##*/}" = "$i.tgz" ]; then
+				"$VERBOSE" && echo "$i already installed"
+				continue 2
+			fi
+		done
+	fi
 
-			# We specifically rm -f here because not removing files/dirs
-			# is probably not worth failing over.
-			for _r in "${_remove[@]}" ; do
-				if [ -d "$_r" ]; then
-					# Try hard not to actually remove recursively
-					# without rmdir on the install media.
-					[ "$_r/*" = $( echo "$_r"/* ) ] && rm -rf "$_r"
-				else
-					rm -f "$_r"
-				fi
-			done
+	if [ -e "$f" ]; then
+		if "$DOWNLOAD"; then
+			"$VERBOSE" && echo "Verify existing ${f##*/}"
+			verify "$f" || continue
+		# else assume it was verified when downloaded
 		fi
+	elif "$DOWNLOAD"; then
+		fetch  "$f" || continue
+		verify "$f" || continue
+	elif "$INSTALL"; then
+		echo "Cannot install ${f##*/}, not found" >&2
+		continue
+	fi
 
-		# TODO: Should we mark these so real fw_update can -Drepair?
-		ftp -D "Install" -Vmo- "file:$_tmpsrc/$_f" |
-			tar -s ",^\+,${_pkgdir}/${_f%.tgz}/+," \
-			-s ",^firmware,${DESTDIR}/etc/firmware," \
-			-C / -zxphf - "+*" "firmware/*"
+	"$INSTALL" || continue
 
-		ed -s "${_pkgdir}/${_f%.tgz}/+CONTENTS" <<EOL
-/^@comment pkgpath/ -1a
-@option manual-installation
-@option firmware
-@comment install-script
-.
-w
-EOL
-	done
-}
+	if [ "${installed[*]:-}" ]; then
+		for i in "${installed[@]}"; do
+			delete_firmware "$i"
+		done
+	fi
 
-fw_install "$FWURL"
+	add_firmware "$f"
+done
+