Greatly simplify error handling in shell scripts

Instead of having detailed error messages, run most
commands through a function that calls err() under
fault conditions.

Where detail is still required, err() is still called
manually. Where it isn't, the error message is simply
whatever command was executed to cause the error.

This results in a massive sloccount reduction for lbmk;
specifically, 178 sloc reduction, or a 8.1% reduction.
The total sloccount is now 2022, for shell scripts.

Signed-off-by: Leah Rowe <leah@libreboot.org>
This commit is contained in:
Leah Rowe
2023-10-01 06:33:43 +01:00
parent 5f914a4d00
commit 8c03b886c4
19 changed files with 278 additions and 461 deletions
+32 -60
View File
@@ -38,41 +38,33 @@ init_check()
[ ! -d "bin/" ] && \
err "init_check: no ROMs built yet (error)"
[ -d "release/" ] || \
mkdir -p release/ || \
err "init_check: !mkdir -p release/"
x_ mkdir -p release/
[ -d "release/${version}/" ] || \
mkdir -p "release/${version}/" || \
err "init_check: !mkdir -p release/${version}/"
x_ mkdir -p "release/${version}/"
[ ! -d "release/${version}/roms/" ] || \
rm -Rf "release/${version}/roms/" || \
err "init_check: !rm -Rf release/${version}/roms/"
x_ rm -Rf "release/${version}/roms/"
[ -d "release/${version}/roms/" ] && return 0
mkdir -p "release/${version}/roms/" || \
err "init_check: !mkdir -p release/${version}/roms/"
x_ mkdir -p "release/${version}/roms/"
}
make_archive()
{
builddir="${1}"
romdir="tmp/romdir" || \
err "make_archive: cannot create tmpdir"
rm -Rf "${romdir}" || err "make_archive: can't remove tmpdir"
romdir="tmp/romdir"
x_ rm -Rf "${romdir}"
target="${builddir##*/}"
if [ ! -f "config/coreboot/${target}/target.cfg" ]; then
# No config, just make a tarball
tarball=release/${version}/roms/${target}_${version}.tar.xz
tar -c "${builddir}" | xz -T0 -6 > ${tarball} || \
(rm ${tarball}
err "make_archive: cannot make \"${tarball}\"")
x_ tar -c "${builddir}" | xz -T0 -6 > ${tarball} || \
x_ rm -f ${tarball}
return 0
fi
romdir="${romdir}/bin/${target}"
mkdir -p "${romdir}" || \
err "make_archive: can't mkdir tmpdir"
cp "${builddir}"/* "${romdir}" || \
err "make_archive: cannot copy ROM images directory -> ${romdir}"
x_ mkdir -p "${romdir}"
x_ cp "${builddir}"/* "${romdir}"
printf "%s\n" "${target}"
@@ -97,24 +89,18 @@ make_archive()
printf "Generating release/%s/roms/%s-%s_%s.tar.xz\n" \
"${version}" "${projectname}" "${version}" "${target##*/}"
printf "%s\n" "${version}" > "${romdir}/version" || \
err "make_archive: can't create ${romdir}/version"
printf "%s\n" "${versiondate}" > "${romdir}/versiondate" || \
err "make_archive: can't create ${romdir}/versiondate"
printf "%s\n" "${projectname}" > "${romdir}/projectname" || \
err "make_archive: can't create ${romdir}/projectname"
x_ printf "%s\n" "${version}" > "${romdir}/version"
x_ printf "%s\n" "${versiondate}" > "${romdir}/versiondate"
x_ printf "%s\n" "${projectname}" > "${romdir}/projectname"
archivename="${projectname}-${version}_${target##*/}"
f="release/${version}/roms/${archivename}"
(
cd "${romdir%/bin/${target}}" || err "make_archive: can't cd to tmpdir"
tar -c "bin/${target}/" | xz -T0 -9e > "${archivename}.tar.xz" || \
err "make_archive:cant make ${projectname}-${version}_${target##*/}"
x_ cd "${romdir%/bin/${target}}"
x_ tar -c "bin/${target}/" | xz -T0 -9e > "${archivename}.tar.xz"
)
mv "${romdir%/bin/${target}}/${archivename}.tar.xz" "${f}.tar.xz" || \
err "make_archive: can't copy tarball"
rm -Rf "${romdir%/bin/${target}}" || \
err "make_archive: can't delete tmpdir"
x_ mv "${romdir%/bin/${target}}/${archivename}.tar.xz" "${f}.tar.xz"
x_ rm -Rf "${romdir%/bin/${target}}"
}
strip_archive()
@@ -122,10 +108,8 @@ strip_archive()
romdir=${1}
[ -d "coreboot/${tree}" ] || \
./update project trees coreboot ${tree} || \
err "strip_archive: coreboot/${tree}: can't fetch source"
./build coreboot utils ${tree} || \
err "strip_archive: coreboot/${tree}: can't build utils"
x_ ./update project trees coreboot ${tree}
x_ ./build coreboot utils ${tree}
if [ "${microcode_required}" = "n" ]; then
for romfile in "${romdir}"/*.rom; do
@@ -134,21 +118,17 @@ strip_archive()
done
for romfile in "${romdir}"/*.tmprom; do
[ -f "${romfile}" ] || continue
mv "${romfile}" "${romfile%.tmprom}.rom" || \
err "can't make no-u rom: ${romfile%.tmprom}.rom"
x_ mv "${romfile}" "${romfile%.tmprom}.rom"
done
fi
# Hash the rom before removing blobs
rm -f "${romdir}/blobhashes" || \
err "strip_archive: !rm -f ${blobdir}/blobhashes"
touch "${romdir}/blobhashes" || \
err "strip_archive: !touch ${blobdir}/blobhashes"
x_ rm -f "${romdir}/blobhashes"
x_ touch "${romdir}/blobhashes"
(
cd "${romdir}" || err "strip_archive: !cd ${romdir}"
sha512sum *.rom >> blobhashes || \
err "strip_archive: ${romdir}: !sha512sum *.rom >> blobhashes"
x_ cd "${romdir}"
x_ sha512sum *.rom >> blobhashes
)
for romfile in "${romdir}"/*.rom; do
@@ -161,40 +141,32 @@ strip_ucode()
{
romfile=${1}
_newrom_b="${romfile%.rom}_nomicrocode.tmprom"
cp "${romfile}" "${_newrom_b}" || \
err "strip_rom_image: cp \"${romfile}\" \"${_newrom_b}\""
x_ cp "${romfile}" "${_newrom_b}"
microcode_present="y"
"${cbfstool}" "${_newrom_b}" remove -n \
cpu_microcode_blob.bin 2>/dev/null || microcode_present="n"
[ "${microcode_present}" = "n" ] || return 0
printf "REMARK: '%s' already lacks microcode\n" "${romfile}" 1>&2
printf "Renaming default ROM file instead.\n" 1>&2
mv "${romfile}" "${_newrom_b}" || \
err "strip_rom_image: can't rename no-u ${romfile}"
x_ mv "${romfile}" "${_newrom_b}"
}
strip_rom_image()
{
[ -f "${1}" ] || return 0
[ "${CONFIG_HAVE_ME_BIN}" != "y" ] || \
"${ifdtool}" --nuke me "${1}" -O "${1}" || \
err "strip_rom_images: ${1}: cannot nuke Intel ME"
x_ "${ifdtool}" --nuke me "${1}" -O "${1}"
[ "${CONFIG_HAVE_MRC}" != "y" ] || \
"${cbfstool}" "${1}" remove -n mrc.bin || \
err "strip_rom_images: ${1}: cannot nuke mrc.bin"
x_ "${cbfstool}" "${1}" remove -n mrc.bin
[ "${CONFIG_INCLUDE_SMSC_SCH5545_EC_FW}" != "y" ] || \
"${cbfstool}" "${1}" remove -n sch5545_ecfw.bin || \
err "strip_rom_images: ${1}: can't nuke sch5545ec fw"
x_ "${cbfstool}" "${1}" remove -n sch5545_ecfw.bin
if [ "${CONFIG_KBC1126_FIRMWARE}" = "y" ]; then
"${cbfstool}" "${1}" remove -n ecfw1.bin || \
err "strip_rom_images: ${1}: can't nuke ecfw1.bin"
"${cbfstool}" "${1}" remove -n ecfw2.bin || \
err "strip_rom_images: ${1}: can't nuke ecfw2.bin"
x_ "${cbfstool}" "${1}" remove -n ecfw1.bin
x_ "${cbfstool}" "${1}" remove -n ecfw2.bin
fi
# TODO: replace this board-specific hack
[ "${target}" = "e6400_4mb" ] || return 0
"${cbfstool}" "${1}" remove -n "pci10de,06eb.rom" || \
err "strip_rom_images: ${1}: can't nuke e6400 vga rom"
x_ "${cbfstool}" "${1}" remove -n "pci10de,06eb.rom"
}
main $@
+31 -61
View File
@@ -45,31 +45,23 @@ create_release_directory()
dirname="${projectname}-${version}_src"
srcdir="${reldir}/${dirname}"
[ -d "release/" ] || mkdir -p release/ || \
err "create_release_directory: !mkdir -p release/"
[ -d "${reldir}/" ] || mkdir -p "${reldir}/" || \
err "create_release_directory: !mkdir -p ${reldir}/"
[ ! -d "${srcdir}/" ] || rm -Rf "${srcdir}/" || \
err "create_release_directory: !rm -Rf ${srcdir}/"
[ -d "release/" ] || x_ mkdir -p release/
[ -d "${reldir}/" ] || x_ mkdir -p "${reldir}/"
[ ! -d "${srcdir}/" ] || x_ rm -Rf "${srcdir}/"
[ ! -f "${srcdir}.tar.xz" ] || \
rm -f "${srcdir}.tar.xz/" || \
err "create_release_directory: !rm -f ${srcdir}.tar.xz/"
x_ rm -f "${srcdir}.tar.xz/"
mkdir -p "${srcdir}/" || \
err "create_release_directory: !mkdir -p ${srcdir}/"
printf "%s" "${version}" > "${srcdir}"/version || \
err "create_release_directory: ${srcdir}/version: can't create file"
x_ mkdir -p "${srcdir}/"
x_ printf "%s" "${version}" > "${srcdir}"/version
}
download_modules()
{
for modname in ${trees_fetch_list}; do
[ -d "${modname}" ] || ./update project trees ${modname} || \
err "download_modules: couldn't download ${modname} trees"
[ -d "${modname}" ] || x_ ./update project trees ${modname}
done
for modname in ${simple_fetch_list} ${download_only_list}; do
[ -d "${modname}/" ] || ./update project repo ${modname} || \
err "download_modules: couldn't download ${modname} repo"
[ -d "${modname}/" ] || x_ ./update project repo ${modname}
done
}
@@ -80,34 +72,27 @@ copy_files()
for subdir in "${dir}"/*; do
[ -d "${subdir}" ] || continue
[ "${subdir##*/}" = "${dir}" ] && continue
mkdir -p "${srcdir}/${dir}" || \
err "copy_files: !mkdir -p ${srcdir}/${dir}"
x_ mkdir -p "${srcdir}/${dir}"
[ ! -d "${srcdir}/${dir}/${subdir##*/}" ] || \
rm -Rf "${srcdir}/${dir}/${subdir##*/}" || \
err "copy_f:can't rm ${srcdir}/${dir}/${subdir##*/}"
cp -R "${subdir}" "${srcdir}/${dir}/${subdir##*/}" || \
err "copy_f:can't cp ${srcdir}/${dir}/${subdir##*/}"
x_ rm -Rf "${srcdir}/${dir}/${subdir##*/}"
x_ cp -R "${subdir}" "${srcdir}/${dir}/${subdir##*/}"
done
done
for dir in ${simple_fetch_list} ${dirlist}; do
cp -R "${dir}/" "${srcdir}/" || \
err "copy_files: !cp -R ${dir}/ ${srcdir}/"
x_ cp -R "${dir}/" "${srcdir}/"
done
for i in ${filelist}; do
if [ ! -f "${i}" ]; then
rm -Rf "${srcdir}" || \
err "copy_files: !rm -Rf ${srcdir}"
x_ rm -Rf "${srcdir}"
err "copy_files: file '${i}' does not exist"
fi
cp "${i}" "${srcdir}/" || \
err "copy_files: !cp ${i} ${srcdir}/"
x_ cp "${i}" "${srcdir}/"
done
(
cd "${srcdir}/" || err "copy_files: can't enter dir: ${srcdir}/"
x_ cd "${srcdir}/"
for i in ${linklist}; do
ln -s lbmk "${i}" || \
err "copy_files: cannot create symlink: ${i} -> lbmk"
x_ ln -s lbmk "${i}"
done
)
}
@@ -115,55 +100,40 @@ copy_files()
purge_files()
{
(
cd "${srcdir}/" || err "purge_files 3: !cd ${srcdir}/"
x_ cd "${srcdir}/"
[ ! -d "coreboot/default/util/kbc1126" ] || \
./handle make file -c "coreboot/default/util/kbc1126" || \
err "purge_files 1: default/util/kbc1126: ! make clean"
./handle make config -x coreboot || \
err "purge_files: coreboot: cannot clean crossgcc files"
x_ ./handle make file -c "coreboot/default/util/kbc1126"
x_ ./handle make config -x coreboot
for p in u-boot seabios coreboot; do
./handle make config -c "${p}" || \
err "purge_files: ${p}: cannot clean the source trees"
x_ ./handle make config -c "${p}"
done
for p in bios_extract flashrom grub uefitool; do
./handle make file -c "${p}" || \
err "purge_files: !./handle make file -c ${p}"
x_ ./handle make file -c "${p}"
done
for p in "stm32-vserprog" "stm32-vserprog/libopencm3"; do
./handle make file -c "util-fw/${p}" || \
err "purge_files !./handle make file util-fw/${p}"
x_ ./handle make file -c "util-fw/${p}"
done
for p in 32 64; do
./handle make file -c "memtest86plus/build${p}" || \
err "purge_files: cannot clean memtest86+ build${p}"
x_ ./handle make file -c "memtest86plus/build${p}"
done
for p in "nvmutil" "spkmodem_recv" "e6400-flash-unlock"; do
make clean -C "util/${p}" || \
err "purge_files 2: !make clean -C ${util}/p"
x_ make clean -C "util/${p}"
done
for p in ${trees_fetch_list}; do
rm -Rf "${p}/${p}" "${p}"/*/.git* || \
err "purge_files 1: cannot clean ${p} project files"
x_ rm -Rf "${p}/${p}" "${p}"/*/.git*
done
rm -Rf .git* */.git* */*/.git* */*/*/.git* */*/*/*/.git* \
*/*/*/*/*/.git* */*/*/*/*/*/.git* */*/*/*/*/*/*/.git* || \
err "purge_files rm-rf2: can't purge .git files/directories"
rm -Rf cbutils || err "purge_files: can't remove ${srcdir}/cbutils/"
rm -Rf elf || err "purge_files: can't remove ${srcdir}/elf/"
rm -Rf util-fw/rp2040/pico-serprog/build || \
err "purge_files: can't remove pico-serprog/build"
x_ rm -Rf .git* */.git* */*/.git* */*/*/.git* */*/*/*/.git* \
*/*/*/*/*/.git* */*/*/*/*/*/.git* */*/*/*/*/*/*/.git*
x_ rm -Rf cbutils elf util-fw/rp2040/pico-serprog/build
)
}
create_release_archive()
{
(
cd "${reldir}/" || \
err "create_release_archive 4: !cd ${reldir}/"
tar -c "${dirname}/" | xz -T0 -9e >"${dirname}.tar.xz" || \
err "create_release_archive: can't create ${dirname}.tar.xz"
rm -Rf "${dirname}/" || \
err "create_release_archive 5: !rm -Rf ${dirname}/"
x_ cd "${reldir}/"
x_ tar -c "${dirname}/" | xz -T0 -9e >"${dirname}.tar.xz"
x_ rm -Rf "${dirname}/"
)
}