test-skeleton.c 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410
  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 <errno.h>
  17. #include <getopt.h>
  18. #include <malloc.h>
  19. #include <search.h>
  20. #include <signal.h>
  21. #include <stdio.h>
  22. #include <stdlib.h>
  23. #include <string.h>
  24. #include <unistd.h>
  25. #include <sys/resource.h>
  26. #include <sys/wait.h>
  27. #include <sys/param.h>
  28. #include <time.h>
  29. #include <features.h>
  30. /* The test function is normally called `do_test' and it is called
  31. with argc and argv as the arguments. We nevertheless provide the
  32. possibility to overwrite this name. */
  33. #ifndef TEST_FUNCTION
  34. # define TEST_FUNCTION do_test (argc, argv)
  35. #endif
  36. #ifndef TEST_DATA_LIMIT
  37. # define TEST_DATA_LIMIT (64 << 20) /* Data limit (bytes) to run with. */
  38. #endif
  39. #define OPT_DIRECT 1000
  40. #define OPT_TESTDIR 1001
  41. static struct option options[] =
  42. {
  43. #ifdef CMDLINE_OPTIONS
  44. CMDLINE_OPTIONS
  45. #endif
  46. { "direct", no_argument, NULL, OPT_DIRECT },
  47. { "test-dir", required_argument, NULL, OPT_TESTDIR },
  48. { NULL, 0, NULL, 0 }
  49. };
  50. /* PID of the test itself. */
  51. static pid_t pid;
  52. /* Directory to place temporary files in. */
  53. static const char *test_dir;
  54. /* List of temporary files. */
  55. struct temp_name_list
  56. {
  57. struct qelem q;
  58. const char *name;
  59. } *temp_name_list;
  60. /* Add temporary files in list. */
  61. static void
  62. __attribute__ ((unused))
  63. add_temp_file (const char *name)
  64. {
  65. struct temp_name_list *newp
  66. = (struct temp_name_list *) calloc (sizeof (*newp), 1);
  67. if (newp != NULL)
  68. {
  69. newp->name = name;
  70. if (temp_name_list == NULL)
  71. temp_name_list = (struct temp_name_list *) &newp->q;
  72. else
  73. insque (newp, temp_name_list);
  74. }
  75. }
  76. /* Delete all temporary files. */
  77. static void
  78. delete_temp_files (void)
  79. {
  80. while (temp_name_list != NULL)
  81. {
  82. remove (temp_name_list->name);
  83. temp_name_list = (struct temp_name_list *) temp_name_list->q.q_forw;
  84. }
  85. }
  86. /* Create a temporary file. */
  87. static int
  88. __attribute__ ((unused))
  89. create_temp_file (const char *base, char **filename)
  90. {
  91. char *fname;
  92. int fd;
  93. fname = (char *) malloc (strlen (test_dir) + 1 + strlen (base)
  94. + sizeof ("XXXXXX"));
  95. if (fname == NULL)
  96. {
  97. puts ("out of memory");
  98. return -1;
  99. }
  100. strcpy (stpcpy (stpcpy (stpcpy (fname, test_dir), "/"), base), "XXXXXX");
  101. fd = mkstemp (fname);
  102. if (fd == -1)
  103. {
  104. printf ("cannot open temporary file '%s': %s\n", fname, strerror(errno));
  105. free (fname);
  106. return -1;
  107. }
  108. add_temp_file (fname);
  109. if (filename != NULL)
  110. *filename = fname;
  111. return fd;
  112. }
  113. /* Timeout handler. We kill the child and exit with an error. */
  114. static void
  115. __attribute__ ((noreturn))
  116. timeout_handler (int sig __attribute__ ((unused)))
  117. {
  118. int killed = 0;
  119. int status;
  120. int i;
  121. /* Send signal. */
  122. kill (pid, SIGKILL);
  123. /* Wait for it to terminate. */
  124. for (i = 0; i < 5; ++i)
  125. {
  126. struct timespec ts;
  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. ts.tv_sec = 0;
  135. ts.tv_nsec = 100000000;
  136. nanosleep (&ts, NULL);
  137. }
  138. if (killed != 0 && killed != pid)
  139. {
  140. perror ("Failed to kill test process");
  141. exit (1);
  142. }
  143. #ifdef CLEANUP_HANDLER
  144. CLEANUP_HANDLER;
  145. #endif
  146. /* If we expected this signal: good! */
  147. #ifdef EXPECTED_SIGNAL
  148. if (EXPECTED_SIGNAL == SIGALRM)
  149. exit (0);
  150. #endif
  151. if (killed == 0 || (WIFSIGNALED (status) && WTERMSIG (status) == SIGKILL))
  152. fputs ("Timed out: killed the child process\n", stderr);
  153. else if (WIFSTOPPED (status))
  154. fprintf (stderr, "Timed out: the child process was %s\n",
  155. strsignal (WSTOPSIG (status)));
  156. else if (WIFSIGNALED (status))
  157. fprintf (stderr, "Timed out: the child process got signal %s\n",
  158. strsignal (WTERMSIG (status)));
  159. else
  160. fprintf (stderr, "Timed out: killed the child process but it exited %d\n",
  161. WEXITSTATUS (status));
  162. /* Exit with an error. */
  163. exit (1);
  164. }
  165. static void
  166. __attribute__ ((noreturn))
  167. handler_killpid(int sig)
  168. {
  169. kill(pid, SIGKILL); /* kill test */
  170. signal(sig, SIG_DFL);
  171. raise(sig); /* kill ourself */
  172. _exit(128 + sig); /* paranoia */
  173. }
  174. /* We provide the entry point here. */
  175. int
  176. main (int argc, char *argv[])
  177. {
  178. #ifdef __ARCH_USE_MMU__
  179. int direct = 0; /* Directly call the test function? */
  180. #else
  181. int direct = 1;
  182. #endif
  183. int status;
  184. int opt;
  185. unsigned int timeoutfactor = 1;
  186. pid_t termpid;
  187. char *envstr_timeoutfactor;
  188. /* Make uses of freed and uninitialized memory known. */
  189. #ifdef __MALLOC_STANDARD__
  190. #ifndef M_PERTURB
  191. # define M_PERTURB -6
  192. #endif
  193. mallopt (M_PERTURB, 42);
  194. #endif
  195. #ifdef STDOUT_UNBUFFERED
  196. setbuf (stdout, NULL);
  197. #endif
  198. while ((opt = getopt_long (argc, argv, "+", options, NULL)) != -1)
  199. switch (opt)
  200. {
  201. case '?':
  202. exit (1);
  203. case OPT_DIRECT:
  204. direct = 1;
  205. break;
  206. case OPT_TESTDIR:
  207. test_dir = optarg;
  208. break;
  209. #ifdef CMDLINE_PROCESS
  210. CMDLINE_PROCESS
  211. #endif
  212. }
  213. /* If set, read the test TIMEOUTFACTOR value from the environment.
  214. This value is used to scale the default test timeout values. */
  215. envstr_timeoutfactor = getenv ("TIMEOUTFACTOR");
  216. if (envstr_timeoutfactor != NULL)
  217. {
  218. char *envstr_conv = envstr_timeoutfactor;
  219. unsigned long int env_fact;
  220. env_fact = strtoul (envstr_timeoutfactor, &envstr_conv, 0);
  221. if (*envstr_conv == '\0' && envstr_conv != envstr_timeoutfactor)
  222. timeoutfactor = MAX (env_fact, 1);
  223. }
  224. /* Set TMPDIR to specified test directory. */
  225. if (test_dir != NULL)
  226. {
  227. setenv ("TMPDIR", test_dir, 1);
  228. if (chdir (test_dir) < 0)
  229. {
  230. perror ("chdir");
  231. exit (1);
  232. }
  233. }
  234. else
  235. {
  236. test_dir = getenv ("TMPDIR");
  237. if (test_dir == NULL || test_dir[0] == '\0')
  238. test_dir = "/tmp";
  239. }
  240. /* Make sure we see all message, even those on stdout. */
  241. setvbuf (stdout, NULL, _IONBF, 0);
  242. /* make sure temporary files are deleted. */
  243. atexit (delete_temp_files);
  244. /* Correct for the possible parameters. */
  245. argv[optind - 1] = argv[0];
  246. argv += optind - 1;
  247. argc -= optind - 1;
  248. /* Call the initializing function, if one is available. */
  249. #ifdef PREPARE
  250. PREPARE (argc, argv);
  251. #endif
  252. /* If we are not expected to fork run the function immediately. */
  253. if (direct)
  254. return TEST_FUNCTION;
  255. /* Set up the test environment:
  256. - prevent core dumps
  257. - set up the timer
  258. - fork and execute the function. */
  259. #if defined __ARCH_USE_MMU__ || ! defined __UCLIBC__
  260. pid = fork ();
  261. if (pid == 0)
  262. {
  263. /* This is the child. */
  264. #ifdef RLIMIT_DATA
  265. struct rlimit data_limit;
  266. #endif
  267. #ifdef RLIMIT_CORE
  268. /* Try to avoid dumping core. */
  269. struct rlimit core_limit;
  270. core_limit.rlim_cur = 0;
  271. core_limit.rlim_max = 0;
  272. setrlimit (RLIMIT_CORE, &core_limit);
  273. #endif
  274. #ifdef RLIMIT_DATA
  275. /* Try to avoid eating all memory if a test leaks. */
  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. /* We put the test process in its own pgrp so that if it bogusly
  290. generates any job control signals, they won't hit the whole build. */
  291. setpgid (0, 0);
  292. /* Execute the test function and exit with the return value. */
  293. exit (TEST_FUNCTION);
  294. }
  295. else if (pid < 0)
  296. #endif
  297. {
  298. perror ("Cannot fork test program");
  299. exit (1);
  300. }
  301. signal (SIGTERM, handler_killpid);
  302. signal (SIGINT, handler_killpid);
  303. signal (SIGQUIT, handler_killpid);
  304. /* Set timeout. */
  305. #ifndef TIMEOUT
  306. /* Default timeout is two seconds. */
  307. # define TIMEOUT 2
  308. #endif
  309. signal (SIGALRM, timeout_handler);
  310. alarm (TIMEOUT * timeoutfactor);
  311. /* Wait for the regular termination. */
  312. termpid = TEMP_FAILURE_RETRY (waitpid (pid, &status, 0));
  313. if (termpid == -1)
  314. {
  315. printf ("Waiting for test program failed: %s\n", strerror(errno));
  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);
  322. exit (1);
  323. }
  324. #ifndef EXPECTED_SIGNAL
  325. /* We don't expect any signal. */
  326. # define EXPECTED_SIGNAL 0
  327. #endif
  328. if (WTERMSIG (status) != EXPECTED_SIGNAL)
  329. {
  330. if (EXPECTED_SIGNAL != 0)
  331. {
  332. if (WTERMSIG (status) == 0)
  333. fprintf (stderr,
  334. "Expected signal '%s' from child, got none\n",
  335. strsignal (EXPECTED_SIGNAL));
  336. else
  337. fprintf (stderr,
  338. "Incorrect signal from child: got `%s', need `%s'\n",
  339. strsignal (WTERMSIG (status)),
  340. strsignal (EXPECTED_SIGNAL));
  341. }
  342. else
  343. fprintf (stderr, "Didn't expect signal from child: got `%s'\n",
  344. strsignal (WTERMSIG (status)));
  345. exit (1);
  346. }
  347. /* Simply exit with the return value of the test. */
  348. #ifndef EXPECTED_STATUS
  349. return WEXITSTATUS (status);
  350. #else
  351. if (WEXITSTATUS (status) != EXPECTED_STATUS)
  352. {
  353. fprintf (stderr, "Expected status %d, got %d\n",
  354. EXPECTED_STATUS, WEXITSTATUS (status));
  355. exit (1);
  356. }
  357. return 0;
  358. #endif
  359. }