Skip to content

fix dkms getting stuck with an incomplete $m/$v/$k/$a/module/ directory #513

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
scaronni merged 4 commits into from
Apr 10, 2025
Merged

fix dkms getting stuck with an incomplete $m/$v/$k/$a/module/ directory #513

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
41a8ceb
prefix tempdir with '.' to avoid being caught by architecture wildcards
anbe42 Apr 5, 2025
792e4b0
dkms: do not rely on side-effects from is_module_built
anbe42 Apr 5, 2025
31e1bdb
test 'incomplete' state caused by a partially populated $m/$v/$k/$a/m…
anbe42 Apr 4, 2025
6302147
dkms: is_module_built: be satisfied by $m/$v/$k/$a/module/ existence
anbe42 Apr 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 7 additions & 17 deletions dkms.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1444,7 +1444,7 @@ do_build()

# Build success, so create DKMS structure for a built module
mkdir -p "$kernelver_dir"
local -r tmp_base_dir=$(mktemp_or_die -d "$kernelver_dir/tmp_${arch}_XXXXXX")
local -r tmp_base_dir=$(mktemp_or_die -d "$kernelver_dir/.tmp_${arch}_XXXXXX")
mkdir -p "$tmp_base_dir/log"
[[ $kernel_config ]] && cp -f "$kernel_config" "$tmp_base_dir/log/"

Expand Down Expand Up @@ -1588,10 +1588,10 @@ do_install()
# If the module is set to be force-installed
local ret
ret=$(force_installation "$module")
if [[ "$ret" == "force" ]];then
if [[ "$ret" == "force" ]]; then
force="true"
echo "Forcing installation of $module"
elif [[ "$ret" == "version-override" ]];then
elif [[ "$ret" == "version-override" ]]; then
force_version_override="true"
echo "Forcing version override of $module"
fi
Expand All @@ -1602,6 +1602,7 @@ do_install()
"You cannot install a module onto a non-existant kernel."

# Read the conf file
set_module_suffix "$kernelver"
read_conf_strict_or_die "$kernelver" "$arch"

# Validate build completeness
Expand Down Expand Up @@ -1779,19 +1780,6 @@ is_module_built() {
local d
d="$dkms_tree/$1/$2/$3/$4"
[[ -d $d/module ]] || return 1
local default_conf
default_conf="$dkms_tree/$1/$2/source/dkms.conf"
# If a custom dkms.conf was specified use it, otherwise use the default one.
local real_conf
real_conf="${conf:-${default_conf}}"
read_conf_or_die "$3" "$4" "$real_conf"
set_module_suffix "$3"
local m
for m in "${dest_module_name[@]}"; do
local t
t=$(compressed_or_uncompressed "$d/module" "$m")
[[ $t ]] || return 1
done
}

# This assumes we have already checked to see if the module has been built.
Expand Down Expand Up @@ -1910,7 +1898,9 @@ do_uninstall()

echo "Module $module/$module_version for kernel $1 ($2):"

# Read the conf file
set_module_suffix "$1"
read_conf_or_die "$1" "$2"

# If kernel-<kernelver> symlink points to this module, check for original_module and put it back
local was_active
Expand Down Expand Up @@ -2076,7 +2066,7 @@ unbuild_module()
remove_module()
{
# Clean up leftover temporary directories
rm -rf "${dkms_tree:?}/$module/$module_version"/*/tmp_*
rm -rf "${dkms_tree:?}/$module/$module_version"/*/.tmp_*
find "$dkms_tree/$module/$module_version/" -maxdepth 1 -type d -empty -delete

# Do --rpm_safe_upgrade check (exit out and don't do remove if inter-release RPM upgrade scenario occurs)
Expand Down
120 changes: 119 additions & 1 deletion run_test.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ generalize_expected_output() {
local output_log=$1

# Normalize temporary directories
sed -i "s|/\(tmp_${KERNEL_ARCH}\)_....../|/\1_XXXXXX/|g" "${output_log}"
sed -i "s|/\(\.tmp_${KERNEL_ARCH}\)_....../|/\1_XXXXXX/|g" "${output_log}"
# On Red Hat and SUSE based distributions, weak-modules is executed. Drop it from the output, to be more generic
sed -i '/^Adding linked weak modules.*$/d' "${output_log}"
sed -i '/^Removing linked weak modules.*$/d' "${output_log}"
Expand Down Expand Up @@ -3599,6 +3599,124 @@ check_no_dkms_test

fi # os-release tests

if [[ ! $only || $only = incomplete ]]; then

############################################################################
echo '*** Testing '"'incomplete'"' status'
############################################################################

echo 'Adding the test module by directory'
run_with_expected_output dkms add test/dkms_test-1.0 << EOF
Creating symlink /var/lib/dkms/dkms_test/1.0/source -> /usr/src/dkms_test-1.0
EOF
check_module_source_tree_created /usr/src/dkms_test-1.0
run_status_with_expected_output 'dkms_test' << EOF
dkms_test/1.0: added
EOF

echo 'Building the test module'
set_signing_message "dkms_test" "1.0"
run_with_expected_output dkms build -k "${KERNEL_VER}" -m dkms_test -v 1.0 << EOF
${SIGNING_PROLOGUE}
Building module(s)... done.
${SIGNING_MESSAGE}Cleaning build area... done.
EOF
run_status_with_expected_output 'dkms_test' << EOF
dkms_test/1.0, ${KERNEL_VER}, ${KERNEL_ARCH}: built
EOF

echo 'Installing the test module'
run_with_expected_output dkms install -k "${KERNEL_VER}" -m dkms_test -v 1.0 << EOF
Installing /lib/modules/${KERNEL_VER}/${expected_dest_loc}/dkms_test.ko${mod_compression_ext}
Running depmod... done.
EOF
run_status_with_expected_output 'dkms_test' << EOF
dkms_test/1.0, ${KERNEL_VER}, ${KERNEL_ARCH}: installed
EOF

echo 'Making the built/installed module "incomplete"'
rm "/var/lib/dkms/dkms_test/1.0/${KERNEL_VER}/${KERNEL_ARCH}/module/dkms_test.ko${mod_compression_ext}"
# if the module didn't exist in the build tree it probably wasn't installed either
rm "/lib/modules/${KERNEL_VER}/${expected_dest_loc}/dkms_test.ko${mod_compression_ext}"
run_status_with_expected_output 'dkms_test' << EOF
dkms_test/1.0, ${KERNEL_VER}, ${KERNEL_ARCH}: installed (Built modules are missing in the kernel modules folder)
EOF

echo 'Uninstalling the "incomplete" test module'
run_with_expected_output dkms uninstall -k "${KERNEL_VER}" -m dkms_test -v 1.0 << EOF
Module dkms_test/1.0 for kernel ${KERNEL_VER} (${KERNEL_ARCH}):
Before uninstall, this module version was ACTIVE on this kernel.
Module dkms_test.ko${mod_compression_ext} was not found within /lib/modules/${KERNEL_VER}/
Running depmod... done.
EOF
run_status_with_expected_output 'dkms_test' << EOF
dkms_test/1.0, ${KERNEL_VER}, ${KERNEL_ARCH}: built (Built modules are missing in the kernel modules folder)
EOF

echo 'Installing the "incomplete" test module (expected error)'
run_with_expected_error 6 dkms install -k "${KERNEL_VER}" -m dkms_test -v 1.0 << EOF

Error! Missing module dkms_test in /var/lib/dkms/dkms_test/1.0/${KERNEL_VER}/${KERNEL_ARCH}/module
EOF
run_status_with_expected_output 'dkms_test' << EOF
dkms_test/1.0, ${KERNEL_VER}, ${KERNEL_ARCH}: built (Built modules are missing in the kernel modules folder)
EOF

echo 'Removing the "incomplete" test module with --all'
run_with_expected_output dkms remove --all -m dkms_test -v 1.0 << EOF
Module dkms_test/1.0 is not installed for kernel ${KERNEL_VER} (${KERNEL_ARCH}). Skipping...

Deleting module dkms_test/1.0 completely from the DKMS tree.
EOF
run_status_with_expected_output 'dkms_test' << EOF
EOF

echo 'Adding the test module by version'
run_with_expected_output dkms add -m dkms_test -v 1.0 << EOF
Creating symlink /var/lib/dkms/dkms_test/1.0/source -> /usr/src/dkms_test-1.0
EOF
run_status_with_expected_output 'dkms_test' << EOF
dkms_test/1.0: added
EOF

echo 'Building the test module'
run_with_expected_output dkms build -k "${KERNEL_VER}" -m dkms_test -v 1.0 << EOF
${SIGNING_PROLOGUE}
Building module(s)... done.
${SIGNING_MESSAGE}Cleaning build area... done.
EOF
run_status_with_expected_output 'dkms_test' << EOF
dkms_test/1.0, ${KERNEL_VER}, ${KERNEL_ARCH}: built
EOF

echo 'Installing the test module'
run_with_expected_output dkms install -k "${KERNEL_VER}" -m dkms_test -v 1.0 << EOF
Installing /lib/modules/${KERNEL_VER}/${expected_dest_loc}/dkms_test.ko${mod_compression_ext}
Running depmod... done.
EOF
run_status_with_expected_output 'dkms_test' << EOF
dkms_test/1.0, ${KERNEL_VER}, ${KERNEL_ARCH}: installed
EOF

echo 'Removing the test module with --all'
run_with_expected_output dkms remove --all -m dkms_test -v 1.0 << EOF
Module dkms_test/1.0 for kernel ${KERNEL_VER} (${KERNEL_ARCH}):
Before uninstall, this module version was ACTIVE on this kernel.
Deleting /lib/modules/${KERNEL_VER}/${expected_dest_loc}/dkms_test.ko${mod_compression_ext}
Running depmod... done.

Deleting module dkms_test/1.0 completely from the DKMS tree.
EOF
run_status_with_expected_output 'dkms_test' << EOF
EOF

remove_module_source_tree /usr/src/dkms_test-1.0

echo 'Checking that the environment is clean again'
check_no_dkms_test

fi # incomplete tests

if [[ ! $only || $only = broken ]]; then

############################################################################
Expand Down