1
/* Skeleton for test programs.
2
Copyright (C) 1998,2000-2004, 2005, 2009 Free Software Foundation, Inc.
3
This file is part of the GNU C Library.
4
Contributed by Ulrich Drepper <drepper@cygnus.com>, 1998.
6
The GNU C Library is free software; you can redistribute it and/or
7
modify it under the terms of the GNU Lesser General Public
8
License as published by the Free Software Foundation; either
9
version 2.1 of the License, or (at your option) any later version.
11
The GNU C Library is distributed in the hope that it will be useful,
12
but WITHOUT ANY WARRANTY; without even the implied warranty of
13
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14
Lesser General Public License for more details.
16
You should have received a copy of the GNU Lesser General Public
17
License along with the GNU C Library; if not, write to the Free
18
Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
30
#include <sys/resource.h>
32
#include <sys/param.h>
35
/* The test function is normally called `do_test' and it is called
36
with argc and argv as the arguments. We nevertheless provide the
37
possibility to overwrite this name. */
39
# define TEST_FUNCTION do_test (argc, argv)
42
#ifndef TEST_DATA_LIMIT
43
# define TEST_DATA_LIMIT (64 << 20) /* Data limit (bytes) to run with. */
46
#define OPT_DIRECT 1000
47
#define OPT_TESTDIR 1001
49
static struct option options[] =
51
#ifdef CMDLINE_OPTIONS
54
{ "direct", no_argument, NULL, OPT_DIRECT },
55
{ "test-dir", required_argument, NULL, OPT_TESTDIR },
59
/* PID of the test itself. */
62
/* Directory to place temporary files in. */
63
static const char *test_dir;
65
/* List of temporary files. */
72
/* Add temporary files in list. */
74
__attribute__ ((unused))
75
add_temp_file (const char *name)
77
struct temp_name_list *newp
78
= (struct temp_name_list *) calloc (sizeof (*newp), 1);
82
if (temp_name_list == NULL)
83
temp_name_list = (struct temp_name_list *) &newp->q;
85
insque (newp, temp_name_list);
89
/* Delete all temporary files. */
91
delete_temp_files (void)
93
while (temp_name_list != NULL)
95
remove (temp_name_list->name);
96
temp_name_list = (struct temp_name_list *) temp_name_list->q.q_forw;
100
/* Create a temporary file. */
102
__attribute__ ((unused))
103
create_temp_file (const char *base, char **filename)
108
fname = (char *) malloc (strlen (test_dir) + 1 + strlen (base)
109
+ sizeof ("XXXXXX"));
112
puts ("out of memory");
115
strcpy (stpcpy (stpcpy (stpcpy (fname, test_dir), "/"), base), "XXXXXX");
117
fd = mkstemp (fname);
120
printf ("cannot open temporary file '%s': %m\n", fname);
125
add_temp_file (fname);
126
if (filename != NULL)
132
/* Timeout handler. We kill the child and exit with an error. */
134
__attribute__ ((noreturn))
135
signal_handler (int sig __attribute__ ((unused)))
143
/* Wait for it to terminate. */
145
for (i = 0; i < 5; ++i)
147
killed = waitpid (pid, &status, WNOHANG|WUNTRACED);
151
/* Delay, give the system time to process the kill. If the
152
nanosleep() call return prematurely, all the better. We
153
won't restart it since this probably means the child process
157
ts.tv_nsec = 100000000;
158
nanosleep (&ts, NULL);
160
if (killed != 0 && killed != pid)
162
perror ("Failed to kill test process");
166
#ifdef CLEANUP_HANDLER
172
signal (sig, SIG_DFL);
176
/* If we expected this signal: good! */
177
#ifdef EXPECTED_SIGNAL
178
if (EXPECTED_SIGNAL == SIGALRM)
182
if (killed == 0 || (WIFSIGNALED (status) && WTERMSIG (status) == SIGKILL))
183
fputs ("Timed out: killed the child process\n", stderr);
184
else if (WIFSTOPPED (status))
185
fprintf (stderr, "Timed out: the child process was %s\n",
186
strsignal (WSTOPSIG (status)));
187
else if (WIFSIGNALED (status))
188
fprintf (stderr, "Timed out: the child process got signal %s\n",
189
strsignal (WTERMSIG (status)));
191
fprintf (stderr, "Timed out: killed the child process but it exited %d\n",
192
WEXITSTATUS (status));
194
/* Exit with an error. */
198
/* We provide the entry point here. */
200
main (int argc, char *argv[])
202
int direct = 0; /* Directly call the test function? */
205
unsigned int timeoutfactor = 1;
208
/* Make uses of freed and uninitialized memory known. */
209
mallopt (M_PERTURB, 42);
211
#ifdef STDOUT_UNBUFFERED
212
setbuf (stdout, NULL);
215
while ((opt = getopt_long (argc, argv, "+", options, NULL)) != -1)
226
#ifdef CMDLINE_PROCESS
231
/* If set, read the test TIMEOUTFACTOR value from the environment.
232
This value is used to scale the default test timeout values. */
233
char *envstr_timeoutfactor = getenv ("TIMEOUTFACTOR");
234
if (envstr_timeoutfactor != NULL)
236
char *envstr_conv = envstr_timeoutfactor;
237
unsigned long int env_fact;
239
env_fact = strtoul (envstr_timeoutfactor, &envstr_conv, 0);
240
if (*envstr_conv == '\0' && envstr_conv != envstr_timeoutfactor)
241
timeoutfactor = MAX (env_fact, 1);
244
/* Set TMPDIR to specified test directory. */
245
if (test_dir != NULL)
247
setenv ("TMPDIR", test_dir, 1);
249
if (chdir (test_dir) < 0)
257
test_dir = getenv ("TMPDIR");
258
if (test_dir == NULL || test_dir[0] == '\0')
262
/* Make sure we see all message, even those on stdout. */
263
setvbuf (stdout, NULL, _IONBF, 0);
265
/* make sure temporary files are deleted. */
266
atexit (delete_temp_files);
268
/* Correct for the possible parameters. */
269
argv[optind - 1] = argv[0];
273
/* Call the initializing function, if one is available. */
275
PREPARE (argc, argv);
278
/* If we are not expected to fork run the function immediately. */
280
return TEST_FUNCTION;
282
/* Set up the test environment:
285
- fork and execute the function. */
290
/* This is the child. */
292
/* Try to avoid dumping core. */
293
struct rlimit core_limit;
294
core_limit.rlim_cur = 0;
295
core_limit.rlim_max = 0;
296
setrlimit (RLIMIT_CORE, &core_limit);
300
/* Try to avoid eating all memory if a test leaks. */
301
struct rlimit data_limit;
302
if (getrlimit (RLIMIT_DATA, &data_limit) == 0)
304
if (TEST_DATA_LIMIT == RLIM_INFINITY)
305
data_limit.rlim_cur = data_limit.rlim_max;
306
else if (data_limit.rlim_cur > (rlim_t) TEST_DATA_LIMIT)
307
data_limit.rlim_cur = MIN ((rlim_t) TEST_DATA_LIMIT,
308
data_limit.rlim_max);
309
if (setrlimit (RLIMIT_DATA, &data_limit) < 0)
310
perror ("setrlimit: RLIMIT_DATA");
313
perror ("getrlimit: RLIMIT_DATA");
316
/* We put the test process in its own pgrp so that if it bogusly
317
generates any job control signals, they won't hit the whole build. */
320
/* Execute the test function and exit with the return value. */
321
exit (TEST_FUNCTION);
325
perror ("Cannot fork test program");
331
/* Default timeout is two seconds. */
334
signal (SIGALRM, signal_handler);
335
alarm (TIMEOUT * timeoutfactor);
337
/* Make sure we clean up if the wrapper gets interrupted. */
338
signal (SIGINT, signal_handler);
340
/* Wait for the regular termination. */
341
termpid = TEMP_FAILURE_RETRY (waitpid (pid, &status, 0));
344
printf ("Waiting for test program failed: %m\n");
349
printf ("Oops, wrong test program terminated: expected %ld, got %ld\n",
350
(long int) pid, (long int) termpid);
354
#ifndef EXPECTED_SIGNAL
355
/* We don't expect any signal. */
356
# define EXPECTED_SIGNAL 0
358
if (WTERMSIG (status) != EXPECTED_SIGNAL)
360
if (EXPECTED_SIGNAL != 0)
362
if (WTERMSIG (status) == 0)
364
"Expected signal '%s' from child, got none\n",
365
strsignal (EXPECTED_SIGNAL));
368
"Incorrect signal from child: got `%s', need `%s'\n",
369
strsignal (WTERMSIG (status)),
370
strsignal (EXPECTED_SIGNAL));
373
fprintf (stderr, "Didn't expect signal from child: got `%s'\n",
374
strsignal (WTERMSIG (status)));
378
/* Simply exit with the return value of the test. */
379
#ifndef EXPECTED_STATUS
380
return WEXITSTATUS (status);
382
if (WEXITSTATUS (status) != EXPECTED_STATUS)
384
fprintf (stderr, "Expected status %d, got %d\n",
385
EXPECTED_STATUS, WEXITSTATUS (status));