test-skeleton.c 9.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394
  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, write to the Free
  15. Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  16. 02111-1307 USA. */
  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. /* The test function is normally called `do_test' and it is called
  32. with argc and argv as the arguments. We nevertheless provide the
  33. possibility to overwrite this name. */
  34. #ifndef TEST_FUNCTION
  35. # define TEST_FUNCTION do_test (argc, argv)
  36. #endif
  37. #ifndef TEST_DATA_LIMIT
  38. # define TEST_DATA_LIMIT (64 << 20) /* Data limit (bytes) to run with. */
  39. #endif
  40. #define OPT_DIRECT 1000
  41. #define OPT_TESTDIR 1001
  42. static struct option options[] =
  43. {
  44. #ifdef CMDLINE_OPTIONS
  45. CMDLINE_OPTIONS
  46. #endif
  47. { "direct", no_argument, NULL, OPT_DIRECT },
  48. { "test-dir", required_argument, NULL, OPT_TESTDIR },
  49. { NULL, 0, NULL, 0 }
  50. };
  51. /* PID of the test itself. */
  52. static pid_t pid;
  53. /* Directory to place temporary files in. */
  54. static const char *test_dir;
  55. /* List of temporary files. */
  56. struct temp_name_list
  57. {
  58. struct qelem q;
  59. const char *name;
  60. } *temp_name_list;
  61. /* Add temporary files in list. */
  62. static void
  63. __attribute__ ((unused))
  64. add_temp_file (const char *name)
  65. {
  66. struct temp_name_list *newp
  67. = (struct temp_name_list *) calloc (sizeof (*newp), 1);
  68. if (newp != NULL)
  69. {
  70. newp->name = name;
  71. if (temp_name_list == NULL)
  72. temp_name_list = (struct temp_name_list *) &newp->q;
  73. else
  74. insque (newp, temp_name_list);
  75. }
  76. }
  77. /* Delete all temporary files. */
  78. static void
  79. delete_temp_files (void)
  80. {
  81. while (temp_name_list != NULL)
  82. {
  83. remove (temp_name_list->name);
  84. temp_name_list = (struct temp_name_list *) temp_name_list->q.q_forw;
  85. }
  86. }
  87. /* Create a temporary file. */
  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. return fd;
  113. }
  114. /* Timeout handler. We kill the child and exit with an error. */
  115. static void
  116. __attribute__ ((noreturn))
  117. timeout_handler (int sig __attribute__ ((unused)))
  118. {
  119. int killed = 0;
  120. int status;
  121. /* Send signal. */
  122. kill (pid, SIGKILL);
  123. /* Wait for it to terminate. */
  124. int i;
  125. for (i = 0; i < 5; ++i)
  126. {
  127. killed = waitpid (pid, &status, WNOHANG|WUNTRACED);
  128. if (killed != 0)
  129. break;
  130. /* Delay, give the system time to process the kill. If the
  131. nanosleep() call return prematurely, all the better. We
  132. won't restart it since this probably means the child process
  133. finally died. */
  134. struct timespec ts;
  135. ts.tv_sec = 0;
  136. ts.tv_nsec = 100000000;
  137. nanosleep (&ts, NULL);
  138. }
  139. if (killed != 0 && killed != pid)
  140. {
  141. perror ("Failed to kill test process");
  142. exit (1);
  143. }
  144. #ifdef CLEANUP_HANDLER
  145. CLEANUP_HANDLER;
  146. #endif
  147. /* If we expected this signal: good! */
  148. #ifdef EXPECTED_SIGNAL
  149. if (EXPECTED_SIGNAL == SIGALRM)
  150. exit (0);
  151. #endif
  152. if (killed == 0 || (WIFSIGNALED (status) && WTERMSIG (status) == SIGKILL))
  153. fputs ("Timed out: killed the child process\n", stderr);
  154. else if (WIFSTOPPED (status))
  155. fprintf (stderr, "Timed out: the child process was %s\n",
  156. strsignal (WSTOPSIG (status)));
  157. else if (WIFSIGNALED (status))
  158. fprintf (stderr, "Timed out: the child process got signal %s\n",
  159. strsignal (WTERMSIG (status)));
  160. else
  161. fprintf (stderr, "Timed out: killed the child process but it exited %d\n",
  162. WEXITSTATUS (status));
  163. /* Exit with an error. */
  164. exit (1);
  165. }
  166. /* We provide the entry point here. */
  167. int
  168. main (int argc, char *argv[])
  169. {
  170. #ifdef __ARCH_USE_MMU__
  171. int direct = 0; /* Directly call the test function? */
  172. #else
  173. int direct = 1;
  174. #endif
  175. int status;
  176. int opt;
  177. unsigned int timeoutfactor = 1;
  178. pid_t termpid;
  179. /* Make uses of freed and uninitialized memory known. */
  180. #ifdef __MALLOC_STANDARD__
  181. #ifndef M_PERTURB
  182. # define M_PERTURB -6
  183. #endif
  184. mallopt (M_PERTURB, 42);
  185. #endif
  186. #ifdef STDOUT_UNBUFFERED
  187. setbuf (stdout, NULL);
  188. #endif
  189. while ((opt = getopt_long (argc, argv, "+", options, NULL)) != -1)
  190. switch (opt)
  191. {
  192. case '?':
  193. exit (1);
  194. case OPT_DIRECT:
  195. direct = 1;
  196. break;
  197. case OPT_TESTDIR:
  198. test_dir = optarg;
  199. break;
  200. #ifdef CMDLINE_PROCESS
  201. CMDLINE_PROCESS
  202. #endif
  203. }
  204. /* If set, read the test TIMEOUTFACTOR value from the environment.
  205. This value is used to scale the default test timeout values. */
  206. char *envstr_timeoutfactor = getenv ("TIMEOUTFACTOR");
  207. if (envstr_timeoutfactor != NULL)
  208. {
  209. char *envstr_conv = envstr_timeoutfactor;
  210. unsigned long int env_fact;
  211. env_fact = strtoul (envstr_timeoutfactor, &envstr_conv, 0);
  212. if (*envstr_conv == '\0' && envstr_conv != envstr_timeoutfactor)
  213. timeoutfactor = MAX (env_fact, 1);
  214. }
  215. /* Set TMPDIR to specified test directory. */
  216. if (test_dir != NULL)
  217. {
  218. setenv ("TMPDIR", test_dir, 1);
  219. if (chdir (test_dir) < 0)
  220. {
  221. perror ("chdir");
  222. exit (1);
  223. }
  224. }
  225. else
  226. {
  227. test_dir = getenv ("TMPDIR");
  228. if (test_dir == NULL || test_dir[0] == '\0')
  229. test_dir = "/tmp";
  230. }
  231. /* Make sure we see all message, even those on stdout. */
  232. setvbuf (stdout, NULL, _IONBF, 0);
  233. /* make sure temporary files are deleted. */
  234. atexit (delete_temp_files);
  235. /* Correct for the possible parameters. */
  236. argv[optind - 1] = argv[0];
  237. argv += optind - 1;
  238. argc -= optind - 1;
  239. /* Call the initializing function, if one is available. */
  240. #ifdef PREPARE
  241. PREPARE (argc, argv);
  242. #endif
  243. /* If we are not expected to fork run the function immediately. */
  244. if (direct)
  245. return TEST_FUNCTION;
  246. /* Set up the test environment:
  247. - prevent core dumps
  248. - set up the timer
  249. - fork and execute the function. */
  250. #if defined __ARCH_USE_MMU__ || ! defined __UCLIBC__
  251. pid = fork ();
  252. if (pid == 0)
  253. {
  254. /* This is the child. */
  255. #ifdef RLIMIT_CORE
  256. /* Try to avoid dumping core. */
  257. struct rlimit core_limit;
  258. core_limit.rlim_cur = 0;
  259. core_limit.rlim_max = 0;
  260. setrlimit (RLIMIT_CORE, &core_limit);
  261. #endif
  262. #ifdef RLIMIT_DATA
  263. /* Try to avoid eating all memory if a test leaks. */
  264. struct rlimit data_limit;
  265. if (getrlimit (RLIMIT_DATA, &data_limit) == 0)
  266. {
  267. if (TEST_DATA_LIMIT == RLIM_INFINITY)
  268. data_limit.rlim_cur = data_limit.rlim_max;
  269. else if (data_limit.rlim_cur > (rlim_t) TEST_DATA_LIMIT)
  270. data_limit.rlim_cur = MIN ((rlim_t) TEST_DATA_LIMIT,
  271. data_limit.rlim_max);
  272. if (setrlimit (RLIMIT_DATA, &data_limit) < 0)
  273. perror ("setrlimit: RLIMIT_DATA");
  274. }
  275. else
  276. perror ("getrlimit: RLIMIT_DATA");
  277. #endif
  278. /* We put the test process in its own pgrp so that if it bogusly
  279. generates any job control signals, they won't hit the whole build. */
  280. setpgid (0, 0);
  281. /* Execute the test function and exit with the return value. */
  282. exit (TEST_FUNCTION);
  283. }
  284. else if (pid < 0)
  285. #endif
  286. {
  287. perror ("Cannot fork test program");
  288. exit (1);
  289. }
  290. /* Set timeout. */
  291. #ifndef TIMEOUT
  292. /* Default timeout is two seconds. */
  293. # define TIMEOUT 2
  294. #endif
  295. signal (SIGALRM, timeout_handler);
  296. alarm (TIMEOUT * timeoutfactor);
  297. /* Wait for the regular termination. */
  298. termpid = TEMP_FAILURE_RETRY (waitpid (pid, &status, 0));
  299. if (termpid == -1)
  300. {
  301. printf ("Waiting for test program failed: %s\n", strerror(errno));
  302. exit (1);
  303. }
  304. if (termpid != pid)
  305. {
  306. printf ("Oops, wrong test program terminated: expected %ld, got %ld\n",
  307. (long int) pid, (long int) termpid);
  308. exit (1);
  309. }
  310. #ifndef EXPECTED_SIGNAL
  311. /* We don't expect any signal. */
  312. # define EXPECTED_SIGNAL 0
  313. #endif
  314. if (WTERMSIG (status) != EXPECTED_SIGNAL)
  315. {
  316. if (EXPECTED_SIGNAL != 0)
  317. {
  318. if (WTERMSIG (status) == 0)
  319. fprintf (stderr,
  320. "Expected signal '%s' from child, got none\n",
  321. strsignal (EXPECTED_SIGNAL));
  322. else
  323. fprintf (stderr,
  324. "Incorrect signal from child: got `%s', need `%s'\n",
  325. strsignal (WTERMSIG (status)),
  326. strsignal (EXPECTED_SIGNAL));
  327. }
  328. else
  329. fprintf (stderr, "Didn't expect signal from child: got `%s'\n",
  330. strsignal (WTERMSIG (status)));
  331. exit (1);
  332. }
  333. /* Simply exit with the return value of the test. */
  334. #ifndef EXPECTED_STATUS
  335. return WEXITSTATUS (status);
  336. #else
  337. if (WEXITSTATUS (status) != EXPECTED_STATUS)
  338. {
  339. fprintf (stderr, "Expected status %d, got %d\n",
  340. EXPECTED_STATUS, WEXITSTATUS (status));
  341. exit (1);
  342. }
  343. return 0;
  344. #endif
  345. }