diff options
| author | Leah Rowe <leah@libreboot.org> | 2025-04-26 18:35:41 +0100 | 
|---|---|---|
| committer | Leah Rowe <leah@libreboot.org> | 2025-04-26 18:35:41 +0100 | 
| commit | ce4381169fa8b49e1dcc729c15b2a0a46d9a0906 (patch) | |
| tree | c2fe35dfd8d11d423534adf14e3e74e64c2f777c /include/lib.sh | |
| parent | 15b64cfebe87a4b3c02628ebce049983f6fec2e5 (diff) | |
lib.sh: introduce more top-down function order
a lot of init code was handled outside of any function. the
coding style used in the rest of the build system has now
been introduced, with xbmk_init being the main function.
Signed-off-by: Leah Rowe <leah@libreboot.org>
Diffstat (limited to 'include/lib.sh')
| -rw-r--r-- | include/lib.sh | 254 | 
1 files changed, 142 insertions, 112 deletions
| diff --git a/include/lib.sh b/include/lib.sh index f4e96c90..ef32ae6c 100644 --- a/include/lib.sh +++ b/include/lib.sh @@ -22,15 +22,6 @@ rmodtool="elf/cbfstool/default/rmodtool"  grubdata="config/data/grub"  err="err_" -err_() -{ -	printf "ERROR %s: %s\n" "$0" "$1" 1>&2 -	exit 1 -} -x_() { -	[ $# -lt 1 ] || "$@" || $err "Unhandled error for: $(echo "$@")"; : -} -  setvars()  {  	_setvars="" && [ $# -lt 2 ] && $err "setvars: too few arguments" @@ -39,64 +30,54 @@ setvars()  	done  	printf "%s\n" "${_setvars% }"  } -chkvars() -{ -	for var in "$@"; do -		eval "[ -n \"\${$var+x}\" ] || \$err \"$var unset\"" -		eval "[ -n \"\$$var\" ] || \$err \"$var unset\"" -	done; : -} -setcfg() +err_()  { -	[ $# -gt 1 ] && printf "e \"%s\" f missing && return %s;\n" "$1" "$2" -	[ $# -gt 1 ] || \ -		printf "e \"%s\" f not && %s \"Missing config\";\n" "$1" "$err" -	printf ". \"%s\" || %s \"Could not read config\";\n" "$1" "$err" +	printf "ERROR %s: %s\n" "$0" "$1" 1>&2 +	exit 1  } -e() -{ -	es_t="e" && [ $# -gt 1 ] && es_t="$2" -	es2="already exists" -	estr="[ -$es_t \"\$1\" ] || return 1" -	[ $# -gt 2 ] && estr="[ -$es_t \"\$1\" ] && return 1" && es2="missing" - -	eval "$estr" -	printf "%s %s\n" "$1" "$es2" 1>&2 -} +eval "`setvars "" _nogit board reinstall versiondate aur_notice configdir \ +    datadir version xbmkpwd relname xbmkpwd xbmktmp python pyver`" -install_packages() +xbmk_init()  { -	[ $# -lt 2 ] && $err "fewer than two arguments" -	[ $# -gt 2 ] && reinstall="$3" - -	eval "`setcfg "config/dependencies/$2"`" - -	chkvars pkg_add pkglist -	$pkg_add $pkglist || $err "Cannot install packages" +	xbmkpwd="`pwd`" || $err "Cannot generate PWD" +	export PWD="$xbmkpwd" -	[ -n "$aur_notice" ] && \ -	    printf "You need AUR packages: %s\n" "$aur_notice" 1>&2; : -} - -eval "`setvars "" _nogit board reinstall versiondate aur_notice configdir \ -    datadir version relname xbmktmp`" +	if [ $# -gt 0 ] && [ "$1" = "dependencies" ]; then +		install_packages "$@" || exit 1 +		exit 0 +	fi -if [ $# -gt 0 ] && [ "$1" = "dependencies" ]; then -	install_packages "$@" || exit 1 -	exit 0 -fi +	id -u 1>/dev/null 2>/dev/null || $err "suid check failed (id -u)" +	[ "$(id -u)" != "0" ] || $err "this command as root is not permitted" -id -u 1>/dev/null 2>/dev/null || $err "suid check failed (id -u)" -[ "$(id -u)" != "0" ] || $err "this command as root is not permitted" +	for fv in version versiondate; do +		eval "[ ! -f \".$fv\" ] || read -r $fv < \".$fv\" || :" +	done -xbmkpwd="`pwd`" || $err "Cannot generate PWD" -export PWD="$xbmkpwd" +	for xbmk_cmd in x_python x_cache x_vars x_setver x_run_child; do +		$xbmk_cmd "$@" +	done +} -for fv in version versiondate; do -	eval "[ ! -f \".$fv\" ] || read -r $fv < \".$fv\" || :" -done +x_python() +{ +	pyv="import sys; print(sys.version_info[:])" +	python="python3" +	pybin python3 1>/dev/null || python="python" +	pyver="2" && [ "$python" = "python3" ] && pyver="3" +	pybin "$python" 1>/dev/null || pyver="" +	[ -z "$pyver" ] || "`pybin "$python"`" -c "$pyv" 1>/dev/null \ +	    2>/dev/null || $err "Cannot detect host Python version." +	if [ -n "$pyver" ]; then +		pyver="$("$(pybin "$python")" -c "$pyv" | awk '{print $1}')" +		pyver="${pyver#(}" +		pyver="${pyver%,}" +	fi +	[ "${pyver%%.*}" = "3" ] || $err "Bad python version (must by 3.x)"; : +}  # Use direct path, to prevent a hang if Python is using a virtual environment,  # not command -v, to prevent a hang when checking python's version @@ -131,33 +112,62 @@ pybin()  	command -v "$1" 2>/dev/null || return 1  } -python="python3" -pybin python3 1>/dev/null || python="python" -pyver="2" && [ "$python" = "python3" ] && pyver="3" -pybin "$python" 1>/dev/null || pyver="" -[ -z "$pyver" ] || "`pybin "$python"`" -c \ -    'import sys; print(sys.version_info[:])' 1>/dev/null 2>/dev/null || \ -    $err "Cannot detect host Python version." -if [ -n "$pyver" ]; then -	pyver="$("$(pybin "$python")" -c \ -	    'import sys; print(sys.version_info[:])' | awk '{print $1}')" -	pyver="${pyver#(}" -	pyver="${pyver%,}" -fi -[ "${pyver%%.*}" = "3" ] || $err "Wrong python version (must be v 3.x)" - -# XBMK_CACHE is a directory, for caching downloads and git repositories -[ -z "${XBMK_CACHE+x}" ] && export XBMK_CACHE="$xbmkpwd/cache" -[ -z "$XBMK_CACHE" ] && export XBMK_CACHE="$xbmkpwd/cache" -[ -L "$XBMK_CACHE" ] && [ "$XBMK_CACHE" = "$xbmkpwd/cache" ] && \ -    $err "cachedir is default, $xbmkpwd/cache, but it exists and is a symlink" -[ -L "$XBMK_CACHE" ] && export XBMK_CACHE="$xbmkpwd/cache" -[ -f "$XBMK_CACHE" ] && $err "cachedir '$XBMK_CACHE' exists but it's a file" - -# unify all temporary files/directories in a single TMPDIR -[ -z "${TMPDIR+x}" ] || [ "${TMPDIR%_*}" = "/tmp/xbmk" ] || unset TMPDIR -[ -n "${TMPDIR+x}" ] && export TMPDIR="$TMPDIR" -if [ -z "${TMPDIR+x}" ]; then +x_cache() +{ +	# XBMK_CACHE is a directory, for caching downloads and git repon +	[ -z "${XBMK_CACHE+x}" ] && export XBMK_CACHE="$xbmkpwd/cache" +	[ -z "$XBMK_CACHE" ] && export XBMK_CACHE="$xbmkpwd/cache" +	[ -L "$XBMK_CACHE" ] && [ "$XBMK_CACHE" = "$xbmkpwd/cache" ] && \ +	    $err "cachedir '$xbmkpwd/cache' is a symlink" +	[ -L "$XBMK_CACHE" ] && export XBMK_CACHE="$xbmkpwd/cache" +	[ -f "$XBMK_CACHE" ] && $err "cachedir '$XBMK_CACHE' is a file"; : +} + +x_vars() +{ +	# if "y": a coreboot target won't be built if target.cfg says release="n" +	# (this is used to exclude certain build targets from releases) +	[ -z "${XBMK_RELEASE+x}" ] && export XBMK_RELEASE="n" +	[ "$XBMK_RELEASE" = "y" ] || export XBMK_RELEASE="n" + +	[ -z "${XBMK_THREADS+x}" ] && export XBMK_THREADS=1 +	expr "X$XBMK_THREADS" : "X-\{0,1\}[0123456789][0123456789]*$" \ +	    1>/dev/null 2>/dev/null || export XBMK_THREADS=1 + +	[ -e ".git" ] || [ -f ".version" ] || printf "unknown\n" > .version \ +	    || $err "Cannot generate unknown .version file" +	[ -e ".git" ] || [ -f ".versiondate" ] || printf "1716415872\n" > \ +	    .versiondate || $err "Cannot generate unknown .versiondate file" +} + +x_setver() +{ +	version_="$version" +	[ ! -e ".git" ] || version="$(git describe --tags HEAD 2>&1)" || \ +	    version="git-$(git rev-parse HEAD 2>&1)" || version="$version_" +	versiondate_="$versiondate" +	[ ! -e ".git" ] || versiondate="$(git show --no-patch --no-notes \ +	    --pretty='%ct' HEAD)" || versiondate="$versiondate_" + +	chkvars version versiondate +	printf "%s\n" "$version" > .version || $err "can't save version" +	printf "%s\n" "$versiondate" > .versiondate || $err "can't save date" + +	relname="$projectname-$version" +	export LOCALVERSION="-$projectname-${version%%-*}" +} + +# if this instance is the main parent, re-run as a child process and exit. +x_run_child() +{ +	# unify all temporary files/directories in a single TMPDIR +	[ -z "${TMPDIR+x}" ] || [ "${TMPDIR%_*}" = "/tmp/xbmk" ] || \ +	    unset TMPDIR +	[ -n "${TMPDIR+x}" ] && export TMPDIR="$TMPDIR" && xbmktmp="$TMPDIR" +	[ -z "${TMPDIR+x}" ] || return 0 # this is a child instance, so return + +	# parent instance of xbmk, so don't return. set up TMPDIR +	# and re-run as a child instance:  	[ -f "lock" ] && $err "$xbmkpwd/lock exists. Is a build running?"  	export TMPDIR="/tmp"  	export TMPDIR="$(mktemp -d -t xbmk_XXXXXXXX)" @@ -178,35 +188,48 @@ if [ -z "${TMPDIR+x}" ]; then  	rm -Rf "$xbmktmp" || xbmk_rval=1  	rm -f lock || xbmk_rval=1  	exit $xbmk_rval -fi -xbmktmp="$TMPDIR" - -# if "y": a coreboot target won't be built if target.cfg says release="n" -# (this is used to exclude certain build targets from releases) -[ -z "${XBMK_RELEASE+x}" ] && export XBMK_RELEASE="n" -[ "$XBMK_RELEASE" = "y" ] || export XBMK_RELEASE="n" - -[ -z "${XBMK_THREADS+x}" ] && export XBMK_THREADS=1 -expr "X$XBMK_THREADS" : "X-\{0,1\}[0123456789][0123456789]*$" \ -    1>/dev/null 2>/dev/null || export XBMK_THREADS=1 # user gave a non-integer - -[ -e ".git" ] || [ -f ".version" ] || printf "unknown\n" > .version || \ -    $err "Cannot generate unknown .version file" -[ -e ".git" ] || [ -f ".versiondate" ] || printf "1716415872\n" > \ -    .versiondate || $err "Cannot generate unknown .versiondate file" - -version_="$version" -[ ! -e ".git" ] || version="$(git describe --tags HEAD 2>&1)" || \ -    version="git-$(git rev-parse HEAD 2>&1)" || version="$version_" -versiondate_="$versiondate" -[ ! -e ".git" ] || versiondate="$(git show --no-patch --no-notes \ -    --pretty='%ct' HEAD)" || versiondate="$versiondate_" -for p in version versiondate; do -	chkvars "$p" -	eval "printf \"%s\\n\" \"\$$p\" > .$p || $err \"can't save $p\"" -done -relname="$projectname-$version" -export LOCALVERSION="-$projectname-${version%%-*}" +} + +chkvars() +{ +	for var in "$@"; do +		eval "[ -n \"\${$var+x}\" ] || \$err \"$var unset\"" +		eval "[ -n \"\$$var\" ] || \$err \"$var unset\"" +	done; : +} + +setcfg() +{ +	[ $# -gt 1 ] && printf "e \"%s\" f missing && return %s;\n" "$1" "$2" +	[ $# -gt 1 ] || \ +		printf "e \"%s\" f not && %s \"Missing config\";\n" "$1" "$err" +	printf ". \"%s\" || %s \"Could not read config\";\n" "$1" "$err" +} + +e() +{ +	es_t="e" && [ $# -gt 1 ] && es_t="$2" +	es2="already exists" +	estr="[ -$es_t \"\$1\" ] || return 1" +	[ $# -gt 2 ] && estr="[ -$es_t \"\$1\" ] && return 1" && es2="missing" + +	eval "$estr" +	printf "%s %s\n" "$1" "$es2" 1>&2 +} + +install_packages() +{ +	[ $# -lt 2 ] && $err "fewer than two arguments" +	[ $# -gt 2 ] && reinstall="$3" + +	eval "`setcfg "config/dependencies/$2"`" + +	chkvars pkg_add pkglist +	$pkg_add $pkglist || $err "Cannot install packages" + +	[ -n "$aur_notice" ] && \ +	    printf "You need AUR packages: %s\n" "$aur_notice" 1>&2; : +}  check_defconfig()  { @@ -323,3 +346,10 @@ mk()  		x_ ./mk $mk_flag $mk_arg  	done; :  } + +x_() +{ +	[ $# -lt 1 ] || "$@" || $err "Unhandled error for: $(echo "$@")"; : +} + +xbmk_init "$@" | 
