glibc/nptl/tst-cancel7.c
Maciej W. Rozycki bea2ad022d nptl: Fix stray process left by tst-cancel7 blocking testing
Fix an issue with commit b74121ae4b ("Update.") and prevent a stray
process from being left behind by tst-cancel7 (and also tst-cancelx7,
which is the same test built with '-fexceptions' additionally supplied
to the compiler), which then blocks remote testing until the process has
been killed by hand.

This test case creates a thread that runs an extra copy of the test via
system(3) and using the '--direct' option so that the test wrapper does
not interfere with this instance.  This extra copy executes its business
and calls sigsuspend(2) and then never terminates by itself.  Instead it
relies on being killed by the main test process directly via a thread
cancellation request or, should that fail, by issuing SIGKILL either at
the conclusion of 'do_test' or by the test driver via 'do_cleanup' where
the test timeout has been hit or the test driver interrupted.

However if the main test process has been instead killed by a signal,
such as due to incorrect execution, before it had a chance to kill the
extra copy of the test case, then the test wrapper will terminate
without running 'do_cleanup' and consequently the extra copy of the test
case will remain forever in its suspended state, and in the remote case
in particular it means that the remote test wrapper will wait forever
for the SSH command to complete.

This has been observed with the 'alpha-linux-gnu' target, where the main
test process triggers SIGSEGV and the test wrapper correctly records:

Didn't expect signal from child: got `Segmentation fault'

in nptl/tst-cancel7.out and terminates, but then the calling SSH command
continues waiting for the remaining process started in the same session
on the remote target to complete.

Address this problem by also registering 'do_cleanup' via atexit(3),
observing that 'support_delete_temp_files' is registered by the test
wrapper before the test initializing function 'do_prepare' is called and
that we call all the functions registered in the reverse of the order in
which they were registered, so it is safe to refer to 'pidfilename' in
'do_cleanup' invoked by exit(3) because by that time temporary files
have not yet been deleted.

A minor inconvenience is that if 'signal_handler' is invoked in the test
wrapper as a result of SIGALRM rather than SIGINT, then 'do_cleanup'
will be called twice, once as a cleanup handler and again by exit(3).
In reality it is harmless though, because issuing SIGKILL is guarded by
a record lock, so if the first call has succeeded in killing the extra
copy of the test case, then the subsequent call will do nothing.

Reviewed-by: Adhemerval Zanella <adhemerval.zanella@linaro.org>
2024-08-07 19:46:21 +01:00

210 lines
4.5 KiB
C

/* Copyright (C) 2002-2024 Free Software Foundation, Inc.
This file is part of the GNU C Library.
The GNU C Library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
The GNU C Library 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
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with the GNU C Library; if not, see
<https://www.gnu.org/licenses/>. */
#include <errno.h>
#include <fcntl.h>
#include <getopt.h>
#include <signal.h>
#include <stdlib.h>
#include <semaphore.h>
#include <sys/mman.h>
#include <support/check.h>
#include <support/support.h>
#include <support/temp_file.h>
#include <support/xstdio.h>
#include <support/xunistd.h>
#include <support/xthread.h>
static const char *command;
static const char *pidfile;
static const char *semfile;
static char *pidfilename;
static char *semfilename;
static sem_t *sem;
static void do_cleanup (void);
static void *
tf (void *arg)
{
char *cmd = xasprintf ("%s --direct --sem %s --pidfile %s",
command, semfilename, pidfilename);
if (system (cmd))
FAIL_EXIT1("system call unexpectedly returned");
/* This call should never return. */
return NULL;
}
static void
sl (void)
{
FILE *f = xfopen (pidfile, "w");
fprintf (f, "%lld\n", (long long) getpid ());
fflush (f);
struct flock fl =
{
.l_type = F_WRLCK,
.l_start = 0,
.l_whence = SEEK_SET,
.l_len = 1
};
if (fcntl (fileno (f), F_SETLK, &fl) != 0)
FAIL_EXIT1 ("fcntl (F_SETFL): %m");
if (sem_post (sem) != 0)
FAIL_EXIT1 ("sem_post: %m");
sigset_t ss;
sigfillset (&ss);
sigsuspend (&ss);
exit (0);
}
static void
do_prepare (int argc, char *argv[])
{
int semfd;
if (semfile == NULL)
semfd = create_temp_file ("tst-cancel7.", &semfilename);
else
semfd = open (semfile, O_RDWR);
TEST_VERIFY_EXIT (semfd != -1);
sem = xmmap (NULL, sizeof (sem_t), PROT_READ | PROT_WRITE, MAP_SHARED,
semfd);
TEST_VERIFY_EXIT (sem != SEM_FAILED);
if (semfile == NULL)
{
xftruncate (semfd, sizeof (sem_t));
TEST_VERIFY_EXIT (sem_init (sem, 1, 0) != -1);
}
if (command == NULL)
command = argv[0];
if (pidfile)
sl ();
int fd = create_temp_file ("tst-cancel7-pid-", &pidfilename);
if (fd == -1)
FAIL_EXIT1 ("create_temp_file failed: %m");
xwrite (fd, " ", 1);
xclose (fd);
atexit (do_cleanup);
}
static int
do_test (void)
{
pthread_t th = xpthread_create (NULL, tf, NULL);
/* Wait to cancel until after the pid is written and file locked. */
if (sem_wait (sem) != 0)
FAIL_EXIT1 ("sem_wait: %m");
xpthread_cancel (th);
void *r = xpthread_join (th);
FILE *f = xfopen (pidfilename, "r+");
long long ll;
if (fscanf (f, "%lld\n", &ll) != 1)
FAIL_EXIT1 ("fscanf: %m");
struct flock fl =
{
.l_type = F_WRLCK,
.l_start = 0,
.l_whence = SEEK_SET,
.l_len = 1
};
if (fcntl (fileno (f), F_GETLK, &fl) != 0)
FAIL_EXIT1 ("fcntl: %m");
if (fl.l_type != F_UNLCK)
{
printf ("child %lld still running\n", (long long) fl.l_pid);
if (fl.l_pid == ll)
kill (fl.l_pid, SIGKILL);
return 1;
}
xfclose (f);
return r != PTHREAD_CANCELED;
}
static void
do_cleanup (void)
{
FILE *f = fopen (pidfilename, "r+");
long long ll;
if (f != NULL && fscanf (f, "%lld\n", &ll) == 1)
{
struct flock fl =
{
.l_type = F_WRLCK,
.l_start = 0,
.l_whence = SEEK_SET,
.l_len = 1
};
if (fcntl (fileno (f), F_GETLK, &fl) == 0 && fl.l_type != F_UNLCK
&& fl.l_pid == ll)
kill (fl.l_pid, SIGKILL);
fclose (f);
}
}
#define OPT_COMMAND 10000
#define OPT_PIDFILE 10001
#define OPT_SEMFILE 10002
#define CMDLINE_OPTIONS \
{ "command", required_argument, NULL, OPT_COMMAND }, \
{ "pidfile", required_argument, NULL, OPT_PIDFILE }, \
{ "sem", required_argument, NULL, OPT_SEMFILE },
static void
cmdline_process (int c)
{
switch (c)
{
case OPT_COMMAND:
command = optarg;
break;
case OPT_PIDFILE:
pidfile = optarg;
break;
case OPT_SEMFILE:
semfile = optarg;
break;
}
}
#define CMDLINE_PROCESS cmdline_process
#define CLEANUP_HANDLER do_cleanup
#define PREPARE do_prepare
#include <support/test-driver.c>