Files
coreutils/tests/tail/overlay-headers.sh
T
Pádraig Brady 8fab3c6d30 tests: fix "Hangup" termination of non-interactive runs
This avoids the test harness being terminated like:
  make[1]: *** [Makefile:24419: check-recursive] Hangup
  make[3]: *** [Makefile:24668: check-TESTS] Hangup
  make: *** [Makefile:24922: check] Hangup
  make[2]: *** [Makefile:24920: check-am] Hangup
  make[4]: *** [Makefile:24685: tests/misc/usage_vs_refs.log] Error 129
  ...

This happened sometimes when the tests were being run non interactively.
For example when run like:

  setsid make TESTS="tests/timeout/timeout.sh \
   tests/tail/overlay-headers.sh" SUBDIRS=. -j2 check

Note the race window can be made bigger by adding a sleep
after tail is stopped in overlay-headers.sh

The race can trigger the kernel to induce its job control
mechanism to prevent stuck processes.
I.e. where it sends SIGHUP + SIGCONT to a process group
when it determines that group may become orphaned,
and there are stopped processes in that group.

* tests/tail/overlay-headers.sh: Use setsid(1) to keep the stopped
tail process in a separate process group, thus avoiding any kernel
job control protection mechanism.
* tests/timeout/timeout.sh: Use setsid(1) to avoid the kernel
checking the main process group when sleep(1) is reparented.
Fixes https://bugs.gnu.org/80477
2026-02-24 19:25:58 +00:00

105 lines
3.1 KiB
Bash
Executable File

#!/bin/sh
# inotify-based tail would output redundant headers for
# overlapping inotify events while it was suspended
# Copyright (C) 2017-2026 Free Software Foundation, Inc.
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
. "${srcdir=.}/tests/init.sh"; path_prepend_ ./src
print_ver_ tail sleep
setsid true || skip_ 'setsid required to control groups'
# Function to count number of lines from tail
# while ignoring transient errors due to resource limits
countlines_ ()
{
grep -Ev 'inotify (resources exhausted|cannot be used)' out | wc -l
}
# Function to check the expected line count in 'out'.
# Called via retry_delay_(). Sleep some time - see retry_delay_() - if the
# line count is still smaller than expected.
wait4lines_ ()
{
local delay=$1
local elc=$2 # Expected line count.
[ "$(countlines_)" -ge "$elc" ] || { sleep $delay; return 1; }
}
# Speedup the non inotify case
fastpoll='-s.1 --max-unchanged-stats=1'
# Terminate any background tail process
cleanup_() {
kill -CONT $pid 2>/dev/null
kill $pid 2>/dev/null && wait $pid
kill $sleep 2>/dev/null && wait $sleep
}
echo start > file1 || framework_failure_
echo start > file2 || framework_failure_
# Use this as a way to gracefully terminate tail
env sleep 60 & sleep=$!
# Note don't use timeout(1) here as it currently
# does not propagate SIGCONT.
# Note use setsid here to ensure we're in a separate process group
# as we're going to STOP this tail process, and this can trigger
# the kernel to send SIGHUP to a group if other tests have
# processes that are reparented. (See tests/timeout/timeout.sh).
setsid tail $fastpoll --pid=$sleep -f file1 file2 > out & pid=$!
# Ensure tail is running
kill -0 $pid || fail=1
# Ensure SIGCONT is supported
kill -CONT $pid || framework_failure_
# Wait for 5 initial lines
retry_delay_ wait4lines_ .1 6 5 || fail=1
# Suspend tail so single read() caters for multiple inotify events
kill -STOP $pid || fail=1
wait4stopped_() {
local delay=$1
case $(ps -o state= -p "$pid" 2>/dev/null) in
T*) return 0 ;;
*) sleep $delay; return 1 ;;
esac
}
retry_delay_ wait4stopped_ .1 6 || skip_ 'failed to detect stopped tail'
# Interleave writes to files to generate overlapping inotify events
echo line >> file1 || framework_failure_
echo line >> file2 || framework_failure_
echo line >> file1 || framework_failure_
echo line >> file2 || framework_failure_
# Resume tail processing
kill -CONT $pid || fail=1
# Wait for 8 more lines
retry_delay_ wait4lines_ .1 6 13 || fail=1
kill $sleep && wait || framework_failure_
test "$(countlines_)" = 13 || { cat out; fail=1; }
Exit $fail