1 /* Skeleton for test programs.
2 Copyright (C) 1998,2000-2004, 2005 Free Software Foundation, Inc.
3 This file is part of the GNU C Library.
4 Contributed by Ulrich Drepper <drepper@cygnus.com>, 1998.
5
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.
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
14 Lesser General Public License for more details.
15
16 You should have received a copy of the GNU Lesser General Public
17 License along with the GNU C Library; if not, see
18 <http://www.gnu.org/licenses/>. */
19
20 #include <errno.h>
21 #include <getopt.h>
22 #include <malloc.h>
23 #include <search.h>
24 #include <signal.h>
25 #include <stdio.h>
26 #include <stdlib.h>
27 #include <string.h>
28 #include <unistd.h>
29 #include <sys/resource.h>
30 #include <sys/wait.h>
31 #include <sys/param.h>
32 #include <time.h>
33 #include <features.h>
34
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. */
38 #ifndef TEST_FUNCTION
39 # define TEST_FUNCTION do_test (argc, argv)
40 #endif
41
42 #ifndef TEST_DATA_LIMIT
43 # define TEST_DATA_LIMIT (64 << 20) /* Data limit (bytes) to run with. */
44 #endif
45
46 #define OPT_DIRECT 1000
47 #define OPT_TESTDIR 1001
48
49 static struct option options[] =
50 {
51 #ifdef CMDLINE_OPTIONS
52 CMDLINE_OPTIONS
53 #endif
54 { "direct", no_argument, NULL, OPT_DIRECT },
55 { "test-dir", required_argument, NULL, OPT_TESTDIR },
56 { NULL, 0, NULL, 0 }
57 };
58
59 /* PID of the test itself. */
60 static pid_t pid;
61
62 /* Directory to place temporary files in. */
63 static const char *test_dir;
64
65 /* List of temporary files. */
66 struct temp_name_list
67 {
68 struct qelem q;
69 const char *name;
70 } *temp_name_list;
71
72 /* Add temporary files in list. */
73 static void
74 __attribute__ ((unused))
add_temp_file(const char * name)75 add_temp_file (const char *name)
76 {
77 struct temp_name_list *newp
78 = (struct temp_name_list *) calloc (sizeof (*newp), 1);
79 if (newp != NULL)
80 {
81 newp->name = name;
82 if (temp_name_list == NULL)
83 temp_name_list = (struct temp_name_list *) &newp->q;
84 else
85 insque (newp, temp_name_list);
86 }
87 }
88
89 /* Delete all temporary files. */
90 static void
delete_temp_files(void)91 delete_temp_files (void)
92 {
93 while (temp_name_list != NULL)
94 {
95 remove (temp_name_list->name);
96 temp_name_list = (struct temp_name_list *) temp_name_list->q.q_forw;
97 }
98 }
99
100 /* Create a temporary file. */
101 static int
102 __attribute__ ((unused))
create_temp_file(const char * base,char ** filename)103 create_temp_file (const char *base, char **filename)
104 {
105 char *fname;
106 int _fd;
107
108 fname = (char *) malloc (strlen (test_dir) + 1 + strlen (base)
109 + sizeof ("XXXXXX"));
110 if (fname == NULL)
111 {
112 puts ("out of memory");
113 return -1;
114 }
115 strcpy (stpcpy (stpcpy (stpcpy (fname, test_dir), "/"), base), "XXXXXX");
116
117 _fd = mkstemp (fname);
118 if (_fd == -1)
119 {
120 printf ("cannot open temporary file '%s': %s\n", fname, strerror(errno));
121 free (fname);
122 return -1;
123 }
124
125 add_temp_file (fname);
126 if (filename != NULL)
127 *filename = fname;
128
129 return _fd;
130 }
131
132 /* Timeout handler. We kill the child and exit with an error. */
133 static void
134 __attribute__ ((noreturn))
signal_handler(int sig)135 signal_handler (int sig __attribute__ ((unused)))
136 {
137 int killed = 0;
138 int status;
139 int i;
140
141 /* Send signal. */
142 kill (pid, SIGKILL);
143
144 /* Wait for it to terminate. */
145 for (i = 0; i < 5; ++i)
146 {
147 struct timespec ts;
148 killed = waitpid (pid, &status, WNOHANG|WUNTRACED);
149 if (killed != 0)
150 break;
151
152 /* Delay, give the system time to process the kill. If the
153 nanosleep() call return prematurely, all the better. We
154 won't restart it since this probably means the child process
155 finally died. */
156 ts.tv_sec = 0;
157 ts.tv_nsec = 100000000;
158 nanosleep (&ts, NULL);
159 }
160 if (killed != 0 && killed != pid)
161 {
162 perror ("Failed to kill test process");
163 exit (1);
164 }
165
166 #ifdef CLEANUP_HANDLER
167 CLEANUP_HANDLER;
168 #endif
169
170 if (sig == SIGINT)
171 {
172 signal (sig, SIG_DFL);
173 raise (sig);
174 }
175
176 /* If we expected this signal: good! */
177 #ifdef EXPECTED_SIGNAL
178 if (EXPECTED_SIGNAL == SIGALRM)
179 exit (0);
180 #endif
181
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)));
190 else
191 fprintf (stderr, "Timed out: killed the child process but it exited %d\n",
192 WEXITSTATUS (status));
193
194 /* Exit with an error. */
195 exit (1);
196 }
197
198 #ifdef __XXX_HANDLE_CTRL_C
199 static void
200 __attribute__ ((noreturn))
handler_killpid(int sig)201 handler_killpid(int sig)
202 {
203 kill(pid, SIGKILL); /* kill test */
204 signal(sig, SIG_DFL);
205 raise(sig); /* kill ourself */
206 _exit(128 + sig); /* paranoia */
207 }
208 #endif
209
210 /* We provide the entry point here. */
211 int
main(int argc,char * argv[])212 main (int argc, char *argv[])
213 {
214 #ifdef __ARCH_USE_MMU__
215 int direct = 0; /* Directly call the test function? */
216 #else
217 int direct = 1;
218 #endif
219 int status;
220 int opt;
221 unsigned int timeoutfactor = 1;
222 pid_t termpid;
223 char *envstr_timeoutfactor;
224
225 /* Make uses of freed and uninitialized memory known. */
226 #ifdef __MALLOC_STANDARD__
227 #ifndef M_PERTURB
228 # define M_PERTURB -6
229 #endif
230 mallopt (M_PERTURB, 42);
231 #endif
232
233 #ifdef STDOUT_UNBUFFERED
234 setbuf (stdout, NULL);
235 #endif
236
237 while ((opt = getopt_long (argc, argv, "+", options, NULL)) != -1)
238 switch (opt)
239 {
240 case '?':
241 exit (1);
242 case OPT_DIRECT:
243 direct = 1;
244 break;
245 case OPT_TESTDIR:
246 test_dir = optarg;
247 break;
248 #ifdef CMDLINE_PROCESS
249 CMDLINE_PROCESS
250 #endif
251 }
252
253 /* If set, read the test TIMEOUTFACTOR value from the environment.
254 This value is used to scale the default test timeout values. */
255 envstr_timeoutfactor = getenv ("TIMEOUTFACTOR");
256 if (envstr_timeoutfactor != NULL)
257 {
258 char *envstr_conv = envstr_timeoutfactor;
259 unsigned long int env_fact;
260
261 env_fact = strtoul (envstr_timeoutfactor, &envstr_conv, 0);
262 if (*envstr_conv == '\0' && envstr_conv != envstr_timeoutfactor)
263 timeoutfactor = MAX (env_fact, 1);
264 }
265
266 /* Set TMPDIR to specified test directory. */
267 if (test_dir != NULL)
268 {
269 setenv ("TMPDIR", test_dir, 1);
270
271 if (chdir (test_dir) < 0)
272 {
273 perror ("chdir");
274 exit (1);
275 }
276 }
277 else
278 {
279 test_dir = getenv ("TMPDIR");
280 if (test_dir == NULL || test_dir[0] == '\0')
281 test_dir = "/tmp";
282 }
283
284 /* Make sure we see all message, even those on stdout. */
285 setvbuf (stdout, NULL, _IONBF, 0);
286
287 /* make sure temporary files are deleted. */
288 atexit (delete_temp_files);
289
290 /* Correct for the possible parameters. */
291 argv[optind - 1] = argv[0];
292 argv += optind - 1;
293 argc -= optind - 1;
294
295 /* Call the initializing function, if one is available. */
296 #ifdef PREPARE
297 PREPARE (argc, argv);
298 #endif
299
300 /* If we are not expected to fork run the function immediately. */
301 if (direct)
302 return TEST_FUNCTION;
303
304 /* Set up the test environment:
305 - prevent core dumps
306 - set up the timer
307 - fork and execute the function. */
308
309 #if defined __ARCH_USE_MMU__ || ! defined __UCLIBC__
310 pid = fork ();
311 if (pid == 0)
312 {
313 /* This is the child. */
314 #ifdef RLIMIT_DATA
315 struct rlimit data_limit;
316 #endif
317 #ifdef RLIMIT_CORE
318 /* Try to avoid dumping core. */
319 struct rlimit core_limit;
320 core_limit.rlim_cur = 0;
321 core_limit.rlim_max = 0;
322 setrlimit (RLIMIT_CORE, &core_limit);
323 #endif
324
325 #ifdef RLIMIT_DATA
326 /* Try to avoid eating all memory if a test leaks. */
327 if (getrlimit (RLIMIT_DATA, &data_limit) == 0)
328 {
329 if (TEST_DATA_LIMIT == RLIM_INFINITY)
330 data_limit.rlim_cur = data_limit.rlim_max;
331 else if (data_limit.rlim_cur > (rlim_t) TEST_DATA_LIMIT)
332 data_limit.rlim_cur = MIN ((rlim_t) TEST_DATA_LIMIT,
333 data_limit.rlim_max);
334 if (setrlimit (RLIMIT_DATA, &data_limit) < 0)
335 perror ("setrlimit: RLIMIT_DATA");
336 }
337 else
338 perror ("getrlimit: RLIMIT_DATA");
339 #endif
340
341 /* We put the test process in its own pgrp so that if it bogusly
342 generates any job control signals, they won't hit the whole build. */
343 setpgid (0, 0);
344
345 /* Execute the test function and exit with the return value. */
346 exit (TEST_FUNCTION);
347 }
348 else if (pid < 0)
349 #endif
350 {
351 perror ("Cannot fork test program");
352 exit (1);
353 }
354
355 #ifdef __XXX_HANDLE_CTRL_C
356 signal (SIGTERM, handler_killpid);
357 signal (SIGINT, handler_killpid);
358 signal (SIGQUIT, handler_killpid);
359 #endif
360
361 /* Set timeout. */
362 #ifndef TIMEOUT
363 /* Default timeout is two seconds. */
364 # define TIMEOUT 2
365 #endif
366 signal (SIGALRM, signal_handler);
367 alarm (TIMEOUT * timeoutfactor);
368
369 /* Make sure we clean up if the wrapper gets interrupted. */
370 signal (SIGINT, signal_handler);
371
372 /* Wait for the regular termination. */
373 termpid = TEMP_FAILURE_RETRY (waitpid (pid, &status, 0));
374 if (termpid == -1)
375 {
376 printf ("Waiting for test program failed: %s\n", strerror(errno));
377 exit (1);
378 }
379 if (termpid != pid)
380 {
381 printf ("Oops, wrong test program terminated: expected %ld, got %ld\n",
382 (long int) pid, (long int) termpid);
383 exit (1);
384 }
385
386 #ifndef EXPECTED_SIGNAL
387 /* We don't expect any signal. */
388 # define EXPECTED_SIGNAL 0
389 #endif
390 if (WTERMSIG (status) != EXPECTED_SIGNAL)
391 {
392 if (EXPECTED_SIGNAL != 0)
393 {
394 if (WTERMSIG (status) == 0)
395 fprintf (stderr,
396 "Expected signal '%s' from child, got none\n",
397 strsignal (EXPECTED_SIGNAL));
398 else
399 fprintf (stderr,
400 "Incorrect signal from child: got `%s', need `%s'\n",
401 strsignal (WTERMSIG (status)),
402 strsignal (EXPECTED_SIGNAL));
403 }
404 else
405 fprintf (stderr, "Didn't expect signal from child: got `%s'\n",
406 strsignal (WTERMSIG (status)));
407 exit (1);
408 }
409
410 /* Simply exit with the return value of the test. */
411 #ifndef EXPECTED_STATUS
412 return WEXITSTATUS (status);
413 #else
414 if (WEXITSTATUS (status) != EXPECTED_STATUS)
415 {
416 fprintf (stderr, "Expected status %d, got %d\n",
417 EXPECTED_STATUS, WEXITSTATUS (status));
418 exit (1);
419 }
420
421 return 0;
422 #endif
423 }
424