1 /* Skeleton for test programs.
2 Copyright (C) 1998-2014 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, see
18 <http://www.gnu.org/licenses/>. */
32 #include <sys/resource.h>
34 #include <sys/param.h>
37 /* The test function is normally called `do_test' and it is called
38 with argc and argv as the arguments. We nevertheless provide the
39 possibility to overwrite this name. */
41 # define TEST_FUNCTION do_test (argc, argv)
44 #ifndef TEST_DATA_LIMIT
45 # define TEST_DATA_LIMIT (64 << 20) /* Data limit (bytes) to run with. */
48 #define OPT_DIRECT 1000
49 #define OPT_TESTDIR 1001
51 static struct option options
[] =
53 #ifdef CMDLINE_OPTIONS
56 { "direct", no_argument
, NULL
, OPT_DIRECT
},
57 { "test-dir", required_argument
, NULL
, OPT_TESTDIR
},
61 /* PID of the test itself. */
64 /* Directory to place temporary files in. */
65 static const char *test_dir
;
67 /* List of temporary files. */
74 /* Add temporary files in list. */
76 __attribute__ ((unused
))
77 add_temp_file (const char *name
)
79 struct temp_name_list
*newp
80 = (struct temp_name_list
*) calloc (sizeof (*newp
), 1);
84 if (temp_name_list
== NULL
)
85 temp_name_list
= (struct temp_name_list
*) &newp
->q
;
87 insque (newp
, temp_name_list
);
91 /* Delete all temporary files. */
93 delete_temp_files (void)
95 while (temp_name_list
!= NULL
)
97 remove (temp_name_list
->name
);
98 temp_name_list
= (struct temp_name_list
*) temp_name_list
->q
.q_forw
;
102 /* Create a temporary file. */
104 __attribute__ ((unused
))
105 create_temp_file (const char *base
, char **filename
)
110 fname
= (char *) malloc (strlen (test_dir
) + 1 + strlen (base
)
111 + sizeof ("XXXXXX"));
114 puts ("out of memory");
117 strcpy (stpcpy (stpcpy (stpcpy (fname
, test_dir
), "/"), base
), "XXXXXX");
119 fd
= mkstemp (fname
);
122 printf ("cannot open temporary file '%s': %m\n", fname
);
127 add_temp_file (fname
);
128 if (filename
!= NULL
)
134 /* Timeout handler. We kill the child and exit with an error. */
136 __attribute__ ((noreturn
))
137 signal_handler (int sig
__attribute__ ((unused
)))
143 /* Kill the whole process group. */
144 kill (-pid
, SIGKILL
);
145 /* In case setpgid failed in the child, kill it individually too. */
148 /* Wait for it to terminate. */
150 for (i
= 0; i
< 5; ++i
)
152 killed
= waitpid (pid
, &status
, WNOHANG
|WUNTRACED
);
156 /* Delay, give the system time to process the kill. If the
157 nanosleep() call return prematurely, all the better. We
158 won't restart it since this probably means the child process
162 ts
.tv_nsec
= 100000000;
163 nanosleep (&ts
, NULL
);
165 if (killed
!= 0 && killed
!= pid
)
167 printf ("Failed to kill test process: %m\n");
171 #ifdef CLEANUP_HANDLER
177 signal (sig
, SIG_DFL
);
181 /* If we expected this signal: good! */
182 #ifdef EXPECTED_SIGNAL
183 if (EXPECTED_SIGNAL
== SIGALRM
)
187 if (killed
== 0 || (WIFSIGNALED (status
) && WTERMSIG (status
) == SIGKILL
))
188 puts ("Timed out: killed the child process");
189 else if (WIFSTOPPED (status
))
190 printf ("Timed out: the child process was %s\n",
191 strsignal (WSTOPSIG (status
)));
192 else if (WIFSIGNALED (status
))
193 printf ("Timed out: the child process got signal %s\n",
194 strsignal (WTERMSIG (status
)));
196 printf ("Timed out: killed the child process but it exited %d\n",
197 WEXITSTATUS (status
));
199 /* Exit with an error. */
203 /* Set fortification error handler. Used when tests want to verify that bad
204 code is caught by the library. */
206 __attribute__ ((unused
))
207 set_fortify_handler (void (*handler
) (int sig
))
211 sa
.sa_handler
= handler
;
213 sigemptyset (&sa
.sa_mask
);
215 sigaction (SIGABRT
, &sa
, NULL
);
217 /* Avoid all the buffer overflow messages on stderr. */
218 int fd
= open (_PATH_DEVNULL
, O_WRONLY
);
220 close (STDERR_FILENO
);
223 dup2 (fd
, STDERR_FILENO
);
226 setenv ("LIBC_FATAL_STDERR_", "1", 1);
229 /* We provide the entry point here. */
231 main (int argc
, char *argv
[])
233 int direct
= 0; /* Directly call the test function? */
236 unsigned int timeoutfactor
= 1;
239 /* Make uses of freed and uninitialized memory known. */
240 mallopt (M_PERTURB
, 42);
242 #ifdef STDOUT_UNBUFFERED
243 setbuf (stdout
, NULL
);
246 while ((opt
= getopt_long (argc
, argv
, "+", options
, NULL
)) != -1)
257 #ifdef CMDLINE_PROCESS
262 /* If set, read the test TIMEOUTFACTOR value from the environment.
263 This value is used to scale the default test timeout values. */
264 char *envstr_timeoutfactor
= getenv ("TIMEOUTFACTOR");
265 if (envstr_timeoutfactor
!= NULL
)
267 char *envstr_conv
= envstr_timeoutfactor
;
268 unsigned long int env_fact
;
270 env_fact
= strtoul (envstr_timeoutfactor
, &envstr_conv
, 0);
271 if (*envstr_conv
== '\0' && envstr_conv
!= envstr_timeoutfactor
)
272 timeoutfactor
= MAX (env_fact
, 1);
275 /* Set TMPDIR to specified test directory. */
276 if (test_dir
!= NULL
)
278 setenv ("TMPDIR", test_dir
, 1);
280 if (chdir (test_dir
) < 0)
282 printf ("chdir: %m\n");
288 test_dir
= getenv ("TMPDIR");
289 if (test_dir
== NULL
|| test_dir
[0] == '\0')
293 /* Make sure we see all message, even those on stdout. */
294 setvbuf (stdout
, NULL
, _IONBF
, 0);
296 /* make sure temporary files are deleted. */
297 atexit (delete_temp_files
);
299 /* Correct for the possible parameters. */
300 argv
[optind
- 1] = argv
[0];
304 /* Call the initializing function, if one is available. */
306 PREPARE (argc
, argv
);
309 /* If we are not expected to fork run the function immediately. */
311 return TEST_FUNCTION
;
313 /* Set up the test environment:
316 - fork and execute the function. */
321 /* This is the child. */
323 /* Try to avoid dumping core. */
324 struct rlimit core_limit
;
325 core_limit
.rlim_cur
= 0;
326 core_limit
.rlim_max
= 0;
327 setrlimit (RLIMIT_CORE
, &core_limit
);
331 /* Try to avoid eating all memory if a test leaks. */
332 struct rlimit data_limit
;
333 if (getrlimit (RLIMIT_DATA
, &data_limit
) == 0)
335 if (TEST_DATA_LIMIT
== RLIM_INFINITY
)
336 data_limit
.rlim_cur
= data_limit
.rlim_max
;
337 else if (data_limit
.rlim_cur
> (rlim_t
) TEST_DATA_LIMIT
)
338 data_limit
.rlim_cur
= MIN ((rlim_t
) TEST_DATA_LIMIT
,
339 data_limit
.rlim_max
);
340 if (setrlimit (RLIMIT_DATA
, &data_limit
) < 0)
341 printf ("setrlimit: RLIMIT_DATA: %m\n");
344 printf ("getrlimit: RLIMIT_DATA: %m\n");
347 /* We put the test process in its own pgrp so that if it bogusly
348 generates any job control signals, they won't hit the whole build. */
349 if (setpgid (0, 0) != 0)
350 printf ("Failed to set the process group ID: %m\n");
352 /* Execute the test function and exit with the return value. */
353 exit (TEST_FUNCTION
);
357 printf ("Cannot fork test program: %m\n");
363 /* Default timeout is two seconds. */
366 signal (SIGALRM
, signal_handler
);
367 alarm (TIMEOUT
* timeoutfactor
);
369 /* Make sure we clean up if the wrapper gets interrupted. */
370 signal (SIGINT
, signal_handler
);
372 /* Wait for the regular termination. */
373 termpid
= TEMP_FAILURE_RETRY (waitpid (pid
, &status
, 0));
376 printf ("Waiting for test program failed: %m\n");
381 printf ("Oops, wrong test program terminated: expected %ld, got %ld\n",
382 (long int) pid
, (long int) termpid
);
386 /* Process terminated normaly without timeout etc. */
387 if (WIFEXITED (status
))
389 #ifndef EXPECTED_STATUS
390 # ifndef EXPECTED_SIGNAL
391 /* Simply exit with the return value of the test. */
392 return WEXITSTATUS (status
);
394 printf ("Expected signal '%s' from child, got none\n",
395 strsignal (EXPECTED_SIGNAL
));
399 if (WEXITSTATUS (status
) != EXPECTED_STATUS
)
401 printf ("Expected status %d, got %d\n",
402 EXPECTED_STATUS
, WEXITSTATUS (status
));
409 /* Process was killed by timer or other signal. */
412 #ifndef EXPECTED_SIGNAL
413 printf ("Didn't expect signal from child: got `%s'\n",
414 strsignal (WTERMSIG (status
)));
417 if (WTERMSIG (status
) != EXPECTED_SIGNAL
)
419 printf ("Incorrect signal from child: got `%s', need `%s'\n",
420 strsignal (WTERMSIG (status
)),
421 strsignal (EXPECTED_SIGNAL
));