test-skeleton.c 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421
  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. The GNU C Library is free software; you can redistribute it and/or
  6. modify it under the terms of the GNU Lesser General Public
  7. License as published by the Free Software Foundation; either
  8. version 2.1 of the License, or (at your option) any later version.
  9. The GNU C Library is distributed in the hope that it will be useful,
  10. but WITHOUT ANY WARRANTY; without even the implied warranty of
  11. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  12. Lesser General Public License for more details.
  13. You should have received a copy of the GNU Lesser General Public
  14. License along with the GNU C Library; if not, see
  15. <http://www.gnu.org/licenses/>. */
  16. #include <assert.h>
  17. #include <errno.h>
  18. #include <getopt.h>
  19. #include <malloc.h>
  20. #include <search.h>
  21. #include <signal.h>
  22. #include <stdio.h>
  23. #include <stdlib.h>
  24. #include <string.h>
  25. #include <unistd.h>
  26. #include <sys/resource.h>
  27. #include <sys/wait.h>
  28. #include <sys/param.h>
  29. #include <time.h>
  30. #include <features.h>
  31. #include "test-skeleton.h"
  32. /* The test function is normally called `do_test' and it is called
  33. with argc and argv as the arguments. We nevertheless provide the
  34. possibility to overwrite this name. */
  35. #ifndef TEST_FUNCTION
  36. # define TEST_FUNCTION do_test (argc, argv)
  37. #endif
  38. #ifndef TEST_DATA_LIMIT
  39. # define TEST_DATA_LIMIT (64 << 20) /* Data limit (bytes) to run with. */
  40. #endif
  41. /* PID of the test itself. */
  42. static pid_t pid;
  43. /* Directory to place temporary files in. */
  44. static const char *test_dir;
  45. /* List of temporary files. */
  46. struct temp_name_list
  47. {
  48. struct qelem q;
  49. char *name;
  50. } *temp_name_list;
  51. /* Add temporary files in list. */
  52. static void
  53. __attribute__ ((unused))
  54. add_temp_file (const char *name)
  55. {
  56. struct temp_name_list *newp
  57. = (struct temp_name_list *) calloc (sizeof (*newp), 1);
  58. char *newname = strdup (name);
  59. if (newp != NULL && newname != NULL)
  60. {
  61. newp->name = newname;
  62. if (temp_name_list == NULL)
  63. temp_name_list = (struct temp_name_list *) &newp->q;
  64. else
  65. insque (newp, temp_name_list);
  66. }
  67. else
  68. free (newp);
  69. }
  70. /* Delete all temporary files. */
  71. static void
  72. delete_temp_files (void)
  73. {
  74. while (temp_name_list != NULL)
  75. {
  76. remove (temp_name_list->name);
  77. free (temp_name_list->name);
  78. struct temp_name_list *next
  79. = (struct temp_name_list *) temp_name_list->q.q_forw;
  80. free (temp_name_list);
  81. temp_name_list = next;
  82. }
  83. }
  84. /* Create a temporary file. Return the opened file descriptor on
  85. success, or -1 on failure. Write the file name to *FILENAME if
  86. FILENAME is not NULL. In this case, the caller is expected to free
  87. *FILENAME. */
  88. static int
  89. __attribute__ ((unused))
  90. create_temp_file (const char *base, char **filename)
  91. {
  92. char *fname;
  93. int _fd;
  94. fname = (char *) malloc (strlen (test_dir) + 1 + strlen (base)
  95. + sizeof ("XXXXXX"));
  96. if (fname == NULL)
  97. {
  98. puts ("out of memory");
  99. return -1;
  100. }
  101. strcpy (stpcpy (stpcpy (stpcpy (fname, test_dir), "/"), base), "XXXXXX");
  102. _fd = mkstemp (fname);
  103. if (_fd == -1)
  104. {
  105. printf ("cannot open temporary file '%s': %s\n", fname, strerror(errno));
  106. free (fname);
  107. return -1;
  108. }
  109. add_temp_file (fname);
  110. if (filename != NULL)
  111. *filename = fname;
  112. else
  113. free (fname);
  114. return _fd;
  115. }
  116. /* Timeout handler. We kill the child and exit with an error. */
  117. static void
  118. __attribute__ ((noreturn))
  119. signal_handler (int sig __attribute__ ((unused)))
  120. {
  121. int killed = 0;
  122. int status;
  123. int i;
  124. assert (pid > 1);
  125. /* Kill the whole process group. */
  126. kill (-pid, SIGKILL);
  127. /* In case setpgid failed in the child, kill it individually too. */
  128. kill (pid, SIGKILL);
  129. /* Wait for it to terminate. */
  130. for (i = 0; i < 5; ++i)
  131. {
  132. #ifdef __UCLIBC_HAS_REALTIME__
  133. struct timespec ts;
  134. #endif
  135. killed = waitpid (pid, &status, WNOHANG|WUNTRACED);
  136. if (killed != 0)
  137. break;
  138. /* Delay, give the system time to process the kill. If the
  139. nanosleep() call return prematurely, all the better. We
  140. won't restart it since this probably means the child process
  141. finally died. */
  142. #ifdef __UCLIBC_HAS_REALTIME__
  143. ts.tv_sec = 0;
  144. ts.tv_nsec = 100000000;
  145. nanosleep (&ts, NULL);
  146. #else
  147. /* No nanosleep, just sleep 1s instead of 0.1s */
  148. sleep(1);
  149. #endif
  150. }
  151. if (killed != 0 && killed != pid)
  152. {
  153. perror ("Failed to kill test process");
  154. exit (1);
  155. }
  156. #ifdef CLEANUP_HANDLER
  157. CLEANUP_HANDLER;
  158. #endif
  159. if (sig == SIGINT)
  160. {
  161. signal (sig, SIG_DFL);
  162. raise (sig);
  163. }
  164. /* If we expected this signal: good! */
  165. #ifdef EXPECTED_SIGNAL
  166. if (EXPECTED_SIGNAL == SIGALRM)
  167. exit (0);
  168. #endif
  169. if (killed == 0 || (WIFSIGNALED (status) && WTERMSIG (status) == SIGKILL))
  170. fputs ("Timed out: killed the child process\n", stderr);
  171. else if (WIFSTOPPED (status))
  172. fprintf (stderr, "Timed out: the child process was %s\n",
  173. strsignal (WSTOPSIG (status)));
  174. else if (WIFSIGNALED (status))
  175. fprintf (stderr, "Timed out: the child process got signal %s\n",
  176. strsignal (WTERMSIG (status)));
  177. else
  178. fprintf (stderr, "Timed out: killed the child process but it exited %d\n",
  179. WEXITSTATUS (status));
  180. /* Exit with an error. */
  181. exit (1);
  182. }
  183. #ifdef __XXX_HANDLE_CTRL_C
  184. static void
  185. __attribute__ ((noreturn))
  186. handler_killpid(int sig)
  187. {
  188. kill(pid, SIGKILL); /* kill test */
  189. signal(sig, SIG_DFL);
  190. raise(sig); /* kill ourself */
  191. _exit(128 + sig); /* paranoia */
  192. }
  193. #endif
  194. /* We provide the entry point here. */
  195. int
  196. main (int argc, char *argv[])
  197. {
  198. #ifdef __ARCH_USE_MMU__
  199. int direct = 0; /* Directly call the test function? */
  200. #else
  201. int direct = 1;
  202. #endif
  203. int status;
  204. int opt;
  205. unsigned int timeoutfactor = 1;
  206. pid_t termpid;
  207. char *envstr_timeoutfactor;
  208. /* Make uses of freed and uninitialized memory known. */
  209. #ifdef __MALLOC_STANDARD__
  210. #ifndef M_PERTURB
  211. # define M_PERTURB -6
  212. #endif
  213. mallopt (M_PERTURB, 42);
  214. #endif
  215. #ifdef STDOUT_UNBUFFERED
  216. setbuf (stdout, NULL);
  217. #endif
  218. # ifndef CMDLINE_OPTIONS
  219. # define CMDLINE_OPTIONS ""
  220. # endif
  221. while ((opt = getopt (argc, argv, "+dt:" CMDLINE_OPTIONS)) >= 0)
  222. switch (opt)
  223. {
  224. case '?':
  225. exit (1);
  226. case 'd':
  227. direct = 1;
  228. break;
  229. case 't':
  230. test_dir = optarg;
  231. break;
  232. #ifdef CMDLINE_PROCESS
  233. CMDLINE_PROCESS
  234. #endif
  235. }
  236. /* If set, read the test TIMEOUTFACTOR value from the environment.
  237. This value is used to scale the default test timeout values. */
  238. envstr_timeoutfactor = getenv ("TIMEOUTFACTOR");
  239. if (envstr_timeoutfactor != NULL)
  240. {
  241. char *envstr_conv = envstr_timeoutfactor;
  242. unsigned long int env_fact;
  243. env_fact = strtoul (envstr_timeoutfactor, &envstr_conv, 0);
  244. if (*envstr_conv == '\0' && envstr_conv != envstr_timeoutfactor)
  245. timeoutfactor = MAX (env_fact, 1);
  246. }
  247. /* Set TMPDIR to specified test directory. */
  248. if (test_dir != NULL)
  249. {
  250. setenv ("TMPDIR", test_dir, 1);
  251. if (chdir (test_dir) < 0)
  252. {
  253. perror ("chdir");
  254. exit (1);
  255. }
  256. }
  257. else
  258. {
  259. test_dir = getenv ("TMPDIR");
  260. if (test_dir == NULL || test_dir[0] == '\0')
  261. test_dir = "/tmp";
  262. }
  263. /* Make sure we see all message, even those on stdout. */
  264. setvbuf (stdout, NULL, _IONBF, 0);
  265. /* make sure temporary files are deleted. */
  266. atexit (delete_temp_files);
  267. /* Correct for the possible parameters. */
  268. argv[optind - 1] = argv[0];
  269. argv += optind - 1;
  270. argc -= optind - 1;
  271. /* Call the initializing function, if one is available. */
  272. #ifdef PREPARE
  273. PREPARE (argc, argv);
  274. #endif
  275. /* If we are not expected to fork run the function immediately. */
  276. if (direct)
  277. return TEST_FUNCTION;
  278. /* Set up the test environment:
  279. - prevent core dumps
  280. - set up the timer
  281. - fork and execute the function. */
  282. #if defined __ARCH_USE_MMU__ || ! defined __UCLIBC__
  283. pid = fork ();
  284. if (pid == 0)
  285. {
  286. /* This is the child. */
  287. #ifdef RLIMIT_CORE
  288. /* Try to avoid dumping core. */
  289. struct rlimit core_limit;
  290. core_limit.rlim_cur = 0;
  291. core_limit.rlim_max = 0;
  292. setrlimit (RLIMIT_CORE, &core_limit);
  293. #endif
  294. /* We put the test process in its own pgrp so that if it bogusly
  295. generates any job control signals, they won't hit the whole build. */
  296. if (setpgid (0, 0) != 0)
  297. printf ("Failed to set the process group ID: %m\n");
  298. /* Execute the test function and exit with the return value. */
  299. exit (TEST_FUNCTION);
  300. }
  301. else if (pid < 0)
  302. #endif
  303. {
  304. perror ("Cannot fork test program");
  305. exit (1);
  306. }
  307. #ifdef __XXX_HANDLE_CTRL_C
  308. signal (SIGTERM, handler_killpid);
  309. signal (SIGINT, handler_killpid);
  310. signal (SIGQUIT, handler_killpid);
  311. #endif
  312. /* Set timeout. */
  313. #ifndef TIMEOUT
  314. /* Default timeout is two seconds. */
  315. # define TIMEOUT 2
  316. #endif
  317. signal (SIGALRM, signal_handler);
  318. alarm (TIMEOUT * timeoutfactor);
  319. /* Make sure we clean up if the wrapper gets interrupted. */
  320. signal (SIGINT, signal_handler);
  321. /* Wait for the regular termination. */
  322. termpid = TEMP_FAILURE_RETRY (waitpid (pid, &status, 0));
  323. if (termpid == -1)
  324. {
  325. printf ("Waiting for test program failed: %s\n", strerror(errno));
  326. exit (1);
  327. }
  328. if (termpid != pid)
  329. {
  330. printf ("Oops, wrong test program terminated: expected %ld, got %ld\n",
  331. (long int) pid, (long int) termpid);
  332. exit (1);
  333. }
  334. #ifndef EXPECTED_SIGNAL
  335. /* We don't expect any signal. */
  336. # define EXPECTED_SIGNAL 0
  337. #endif
  338. if (WTERMSIG (status) != EXPECTED_SIGNAL)
  339. {
  340. if (EXPECTED_SIGNAL != 0)
  341. {
  342. if (WTERMSIG (status) == 0)
  343. fprintf (stderr,
  344. "Expected signal '%s' from child, got none\n",
  345. strsignal (EXPECTED_SIGNAL));
  346. else
  347. fprintf (stderr,
  348. "Incorrect signal from child: got `%s', need `%s'\n",
  349. strsignal (WTERMSIG (status)),
  350. strsignal (EXPECTED_SIGNAL));
  351. }
  352. else
  353. fprintf (stderr, "Didn't expect signal from child: got `%s'\n",
  354. strsignal (WTERMSIG (status)));
  355. exit (1);
  356. }
  357. /* Simply exit with the return value of the test. */
  358. #ifndef EXPECTED_STATUS
  359. return WEXITSTATUS (status);
  360. #else
  361. if (WEXITSTATUS (status) != EXPECTED_STATUS)
  362. {
  363. fprintf (stderr, "Expected status %d, got %d\n",
  364. EXPECTED_STATUS, WEXITSTATUS (status));
  365. exit (1);
  366. }
  367. return 0;
  368. #endif
  369. }