]> git.ipfire.org Git - thirdparty/glibc.git/blame - test-skeleton.c
(gnulib): If have-cc-withh-libunwind is "yes", also mention -lunwind.
[thirdparty/glibc.git] / test-skeleton.c
CommitLineData
80a18298 1/* Skeleton for test programs.
6f1acb30 2 Copyright (C) 1998, 2000, 2001, 2002, 2003 Free Software Foundation, Inc.
41bdb6e2 3 This file is part of the GNU C Library.
80a18298
UD
4 Contributed by Ulrich Drepper <drepper@cygnus.com>, 1998.
5
6 The GNU C Library is free software; you can redistribute it and/or
41bdb6e2
AJ
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.
80a18298
UD
10
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
41bdb6e2 14 Lesser General Public License for more details.
80a18298 15
41bdb6e2
AJ
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
19 02111-1307 USA. */
80a18298 20
e1d8e1b7 21#include <errno.h>
80a18298 22#include <getopt.h>
b9337b6a 23#include <search.h>
80a18298
UD
24#include <signal.h>
25#include <stdio.h>
26#include <stdlib.h>
4380ef5e 27#include <string.h>
80a18298
UD
28#include <unistd.h>
29#include <sys/resource.h>
30#include <sys/wait.h>
63b11dd1 31#include <sys/param.h>
fa4a36fd 32#include <time.h>
80a18298
UD
33
34/* The test function is normally called `do_test' and it is called
35 with argc and argv as the arguments. We nevertheless provide the
36 possibility to overwrite this name. */
37#ifndef TEST_FUNCTION
38# define TEST_FUNCTION do_test (argc, argv)
39#endif
40
63b11dd1
RM
41#ifndef TEST_DATA_LIMIT
42# define TEST_DATA_LIMIT (64 << 20) /* Data limit (bytes) to run with. */
43#endif
80a18298
UD
44
45#define OPT_DIRECT 1000
46#define OPT_TESTDIR 1001
47
48static struct option options[] =
49{
50#ifdef CMDLINE_OPTIONS
51 CMDLINE_OPTIONS
52#endif
53 { "direct", no_argument, NULL, OPT_DIRECT },
54 { "test-dir", required_argument, NULL, OPT_TESTDIR },
55 { NULL, 0, NULL, 0 }
56};
57
58/* PID of the test itself. */
608c5afd 59static pid_t pid;
80a18298
UD
60
61/* Directory to place temporary files in. */
62static const char *test_dir;
63
b9337b6a 64/* List of temporary files. */
51eecc4a 65struct temp_name_list
b9337b6a
UD
66{
67 struct qelem q;
68 const char *name;
51eecc4a 69} *temp_name_list;
b9337b6a
UD
70
71/* Add temporary files in list. */
9c0592ab 72static void
5cd6f8f7 73__attribute__ ((unused))
b9337b6a
UD
74add_temp_file (const char *name)
75{
51eecc4a
AJ
76 struct temp_name_list *newp
77 = (struct temp_name_list *) calloc (sizeof (*newp), 1);
b9337b6a
UD
78 if (newp != NULL)
79 {
80 newp->name = name;
51eecc4a
AJ
81 if (temp_name_list == NULL)
82 temp_name_list = (struct temp_name_list *) &newp->q;
b9337b6a 83 else
51eecc4a 84 insque (newp, temp_name_list);
b9337b6a
UD
85 }
86}
87
88/* Delete all temporary files. */
9c0592ab 89static void
b9337b6a
UD
90delete_temp_files (void)
91{
51eecc4a 92 while (temp_name_list != NULL)
b9337b6a 93 {
51eecc4a
AJ
94 remove (temp_name_list->name);
95 temp_name_list = (struct temp_name_list *) temp_name_list->q.q_forw;
b9337b6a
UD
96 }
97}
98
10e62564
UD
99/* Create a temporary file. */
100static int
101__attribute__ ((unused))
102create_temp_file (const char *base, char **filename)
103{
104 char *fname;
105 int fd;
106
107 fname = (char *) malloc (strlen (test_dir) + 1 + strlen (base)
108 + sizeof ("XXXXXX"));
109 if (fname == NULL)
110 {
111 puts ("out of memory");
112 return -1;
113 }
114 strcpy (stpcpy (stpcpy (stpcpy (fname, test_dir), "/"), base), "XXXXXX");
115
116 fd = mkstemp (fname);
117 if (fd == -1)
118 {
119 printf ("cannot open temporary file '%s': %m\n", fname);
120 free (fname);
121 return -1;
122 }
123
124 add_temp_file (fname);
125 if (filename != NULL)
126 *filename = fname;
127
128 return fd;
129}
130
80a18298 131/* Timeout handler. We kill the child and exit with an error. */
9c0592ab 132static void
8c0b7170 133__attribute__ ((noreturn))
80a18298
UD
134timeout_handler (int sig __attribute__ ((unused)))
135{
136 int killed;
b79e3737 137 int status;
80a18298
UD
138
139 /* Send signal. */
140 kill (pid, SIGKILL);
141
142 /* Wait for it to terminate. */
6d0e6e84
UD
143 int i;
144 for (i = 0; i < 5; ++i)
145 {
146 killed = waitpid (pid, &status, WNOHANG|WUNTRACED);
147 if (killed != 0)
148 break;
149
150 /* Delay, give the system time to process the kill. If the
151 nanosleep() call return prematurely, all the better. We
152 won't restart it since this probably means the child process
153 finally died. */
154 struct timespec ts = { .tv_sec = 0, .tv_nsec = 100000000 };
155 nanosleep (&ts, NULL);
156 }
80a18298
UD
157 if (killed != 0 && killed != pid)
158 {
159 perror ("Failed to killed test process");
160 exit (1);
161 }
162
163#ifdef CLEANUP_HANDLER
164 CLEANUP_HANDLER;
165#endif
166
4614167a
UD
167 /* If we expected this signal: good! */
168#ifdef EXPECTED_SIGNAL
169 if (EXPECTED_SIGNAL == SIGALRM)
170 exit (0);
171#endif
172
6d0e6e84 173 if (killed == 0 || (WIFSIGNALED (status) && WTERMSIG (status) == SIGKILL))
b79e3737
RM
174 fputs ("Timed out: killed the child process\n", stderr);
175 else if (WIFSTOPPED (status))
176 fprintf (stderr, "Timed out: the child process was %s\n",
177 strsignal (WSTOPSIG (status)));
178 else if (WIFSIGNALED (status))
179 fprintf (stderr, "Timed out: the child process got signal %s\n",
180 strsignal (WTERMSIG (status)));
181 else
182 fprintf (stderr, "Timed out: killed the child process but it exited %d\n",
183 WEXITSTATUS (status));
80a18298
UD
184
185 /* Exit with an error. */
186 exit (1);
187}
188
189/* We provide the entry point here. */
190int
191main (int argc, char *argv[])
192{
193 int direct = 0; /* Directly call the test function? */
194 int status;
195 int opt;
608c5afd 196 pid_t termpid;
80a18298 197
e7c036b3
UD
198#ifdef STDOUT_UNBUFFERED
199 setbuf (stdout, NULL);
200#endif
201
6f1acb30 202 while ((opt = getopt_long (argc, argv, "+", options, NULL)) != -1)
80a18298
UD
203 switch (opt)
204 {
205 case '?':
206 exit (1);
207 case OPT_DIRECT:
208 direct = 1;
209 break;
210 case OPT_TESTDIR:
211 test_dir = optarg;
212 break;
213#ifdef CMDLINE_PROCESS
214 CMDLINE_PROCESS
215#endif
216 }
217
218 /* Set TMPDIR to specified test directory. */
219 if (test_dir != NULL)
220 {
221 setenv ("TMPDIR", test_dir, 1);
222
223 if (chdir (test_dir) < 0)
224 {
225 perror ("chdir");
226 exit (1);
227 }
228 }
b9337b6a
UD
229 else
230 {
231 test_dir = getenv ("TMPDIR");
232 if (test_dir == NULL || test_dir[0] == '\0')
233 test_dir = "/tmp";
234 }
80a18298 235
6b9c2e67
UD
236 /* Make sure we see all message, even those on stdout. */
237 setvbuf (stdout, NULL, _IONBF, 0);
238
310b3460
UD
239 /* make sure temporary files are deleted. */
240 atexit (delete_temp_files);
241
726b7b0f 242 /* Correct for the possible parameters. */
55033a44 243 argv[optind - 1] = argv[0];
726b7b0f
UD
244 argv += optind - 1;
245 argc -= optind - 1;
246
310b3460
UD
247 /* Call the initializing function, if one is available. */
248#ifdef PREPARE
249 PREPARE (argc, argv);
250#endif
251
80a18298
UD
252 /* If we are not expected to fork run the function immediately. */
253 if (direct)
254 return TEST_FUNCTION;
255
256 /* Set up the test environment:
257 - prevent core dumps
258 - set up the timer
259 - fork and execute the function. */
260
261 pid = fork ();
262 if (pid == 0)
263 {
264 /* This is the child. */
265#ifdef RLIMIT_CORE
266 /* Try to avoid dumping core. */
267 struct rlimit core_limit;
268 core_limit.rlim_cur = 0;
269 core_limit.rlim_max = 0;
270 setrlimit (RLIMIT_CORE, &core_limit);
271#endif
272
63b11dd1
RM
273#ifdef RLIMIT_DATA
274 /* Try to avoid eating all memory if a test leaks. */
275 struct rlimit data_limit;
276 if (getrlimit (RLIMIT_DATA, &data_limit) == 0)
277 {
278 if (TEST_DATA_LIMIT == RLIM_INFINITY)
279 data_limit.rlim_cur = data_limit.rlim_max;
280 else if (data_limit.rlim_cur > (rlim_t) TEST_DATA_LIMIT)
281 data_limit.rlim_cur = MIN ((rlim_t) TEST_DATA_LIMIT,
282 data_limit.rlim_max);
283 if (setrlimit (RLIMIT_DATA, &data_limit) < 0)
284 perror ("setrlimit: RLIMIT_DATA");
285 }
286 else
287 perror ("getrlimit: RLIMIT_DATA");
288#endif
289
b79e3737
RM
290 /* We put the test process in its own pgrp so that if it bogusly
291 generates any job control signals, they won't hit the whole build. */
292 setpgid (0, 0);
293
80a18298
UD
294 /* Execute the test function and exit with the return value. */
295 exit (TEST_FUNCTION);
296 }
297 else if (pid < 0)
298 {
299 perror ("Cannot fork test program");
300 exit (1);
301 }
302
303 /* Set timeout. */
304#ifndef TIMEOUT
305 /* Default timeout is two seconds. */
306# define TIMEOUT 2
307#endif
80a18298 308 signal (SIGALRM, timeout_handler);
53854476 309 alarm (TIMEOUT);
80a18298
UD
310
311 /* Wait for the regular termination. */
53854476 312 termpid = TEMP_FAILURE_RETRY (waitpid (pid, &status, 0));
608c5afd 313 if (termpid == -1)
80a18298 314 {
608c5afd
UD
315 printf ("Waiting for test program failed: %m\n");
316 exit (1);
317 }
318 if (termpid != pid)
319 {
320 printf ("Oops, wrong test program terminated: expected %ld, got %ld\n",
321 (long int) pid, (long int) termpid);
80a18298
UD
322 exit (1);
323 }
324
325#ifndef EXPECTED_SIGNAL
326 /* We don't expect any signal. */
327# define EXPECTED_SIGNAL 0
328#endif
789b13c4 329 if (WTERMSIG (status) != EXPECTED_SIGNAL)
80a18298 330 {
b9337b6a 331 if (EXPECTED_SIGNAL != 0)
3fc65a77
UD
332 {
333 if (WTERMSIG (status) == 0)
334 fprintf (stderr,
335 "Expected signal '%s' from child, got none\n",
336 strsignal (EXPECTED_SIGNAL));
337 else
338 fprintf (stderr,
339 "Incorrect signal from child: got `%s', need `%s'\n",
340 strsignal (WTERMSIG (status)),
341 strsignal (EXPECTED_SIGNAL));
342 }
b9337b6a 343 else
6b9c2e67 344 fprintf (stderr, "Didn't expect signal from child: got `%s'\n",
b9337b6a 345 strsignal (WTERMSIG (status)));
80a18298
UD
346 exit (1);
347 }
348
349 /* Simply exit with the return value of the test. */
ede0f73a 350#ifndef EXPECTED_STATUS
80a18298 351 return WEXITSTATUS (status);
ede0f73a
UD
352#else
353 if (WEXITSTATUS (status) != EXPECTED_STATUS)
354 {
355 fprintf (stderr, "Expected status %d, got %d\n",
356 EXPECTED_STATUS, WEXITSTATUS (status));
357 exit (1);
358 }
359
360 return 0;
361#endif
80a18298 362}