(main): Provide more information in case waitpid fails.
[kopensolaris-gnu/glibc.git] / test-skeleton.c
1 /* Skeleton for test programs.
2    Copyright (C) 1998, 2000, 2001, 2002 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, write to the Free
18    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
19    02111-1307 USA.  */
20
21 #include <getopt.h>
22 #include <search.h>
23 #include <signal.h>
24 #include <stdio.h>
25 #include <stdlib.h>
26 #include <string.h>
27 #include <unistd.h>
28 #include <sys/resource.h>
29 #include <sys/wait.h>
30
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
38
39 #define OPT_DIRECT 1000
40 #define OPT_TESTDIR 1001
41
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
52 /* PID of the test itself.  */
53 static pid_t pid;
54
55 /* Directory to place temporary files in.  */
56 static const char *test_dir;
57
58 /* List of temporary files.  */
59 struct temp_name_list
60 {
61   struct qelem q;
62   const char *name;
63 } *temp_name_list;
64
65 /* Add temporary files in list.  */
66 static void
67 __attribute__ ((unused))
68 add_temp_file (const char *name)
69 {
70   struct temp_name_list *newp
71     = (struct temp_name_list *) calloc (sizeof (*newp), 1);
72   if (newp != NULL)
73     {
74       newp->name = name;
75       if (temp_name_list == NULL)
76         temp_name_list = (struct temp_name_list *) &newp->q;
77       else
78         insque (newp, temp_name_list);
79     }
80 }
81
82 /* Delete all temporary files.  */
83 static void
84 delete_temp_files (void)
85 {
86   while (temp_name_list != NULL)
87     {
88       remove (temp_name_list->name);
89       temp_name_list = (struct temp_name_list *) temp_name_list->q.q_forw;
90     }
91 }
92
93 /* Create a temporary file.  */
94 static int
95 __attribute__ ((unused))
96 create_temp_file (const char *base, char **filename)
97 {
98   char *fname;
99   int fd;
100
101   fname = (char *) malloc (strlen (test_dir) + 1 + strlen (base)
102                            + sizeof ("XXXXXX"));
103   if (fname == NULL)
104     {
105       puts ("out of memory");
106       return -1;
107     }
108   strcpy (stpcpy (stpcpy (stpcpy (fname, test_dir), "/"), base), "XXXXXX");
109
110   fd = mkstemp (fname);
111   if (fd == -1)
112     {
113       printf ("cannot open temporary file '%s': %m\n", fname);
114       free (fname);
115       return -1;
116     }
117
118   add_temp_file (fname);
119   if (filename != NULL)
120     *filename = fname;
121
122   return fd;
123 }
124
125 /* Timeout handler.  We kill the child and exit with an error.  */
126 static void
127 __attribute__ ((noreturn))
128 timeout_handler (int sig __attribute__ ((unused)))
129 {
130   int killed;
131
132   /* Send signal.  */
133   kill (pid, SIGKILL);
134
135   /* Wait for it to terminate.  */
136   killed = waitpid (pid, NULL, WNOHANG);
137   if (killed != 0 && killed != pid)
138     {
139       perror ("Failed to killed test process");
140       exit (1);
141     }
142
143 #ifdef CLEANUP_HANDLER
144   CLEANUP_HANDLER;
145 #endif
146
147   fputs ("Timed out: killed the child process\n", stderr);
148
149   /* Exit with an error.  */
150   exit (1);
151 }
152
153 /* We provide the entry point here.  */
154 int
155 main (int argc, char *argv[])
156 {
157   int direct = 0;       /* Directly call the test function?  */
158   int status;
159   int opt;
160   pid_t termpid;
161
162 #ifdef STDOUT_UNBUFFERED
163   setbuf (stdout, NULL);
164 #endif
165
166   while ((opt = getopt_long (argc, argv, "", options, NULL)) != -1)
167     switch (opt)
168       {
169       case '?':
170         exit (1);
171       case OPT_DIRECT:
172         direct = 1;
173         break;
174       case OPT_TESTDIR:
175         test_dir = optarg;
176         break;
177 #ifdef CMDLINE_PROCESS
178         CMDLINE_PROCESS
179 #endif
180       }
181
182   /* Set TMPDIR to specified test directory.  */
183   if (test_dir != NULL)
184     {
185       setenv ("TMPDIR", test_dir, 1);
186
187       if (chdir (test_dir) < 0)
188         {
189           perror ("chdir");
190           exit (1);
191         }
192     }
193   else
194     {
195       test_dir = getenv ("TMPDIR");
196       if (test_dir == NULL || test_dir[0] == '\0')
197         test_dir = "/tmp";
198     }
199
200   /* Make sure we see all message, even those on stdout.  */
201   setvbuf (stdout, NULL, _IONBF, 0);
202
203   /* make sure temporary files are deleted.  */
204   atexit (delete_temp_files);
205
206   /* Correct for the possible parameters.  */
207   argv += optind - 1;
208   argc -= optind - 1;
209
210   /* Call the initializing function, if one is available.  */
211 #ifdef PREPARE
212   PREPARE (argc, argv);
213 #endif
214
215   /* If we are not expected to fork run the function immediately.  */
216   if (direct)
217     return TEST_FUNCTION;
218
219   /* Set up the test environment:
220      - prevent core dumps
221      - set up the timer
222      - fork and execute the function.  */
223
224   pid = fork ();
225   if (pid == 0)
226     {
227       /* This is the child.  */
228 #ifdef RLIMIT_CORE
229       /* Try to avoid dumping core.  */
230       struct rlimit core_limit;
231       core_limit.rlim_cur = 0;
232       core_limit.rlim_max = 0;
233       setrlimit (RLIMIT_CORE, &core_limit);
234 #endif
235
236       /* Execute the test function and exit with the return value.   */
237       exit (TEST_FUNCTION);
238     }
239   else if (pid < 0)
240     {
241       perror ("Cannot fork test program");
242       exit (1);
243     }
244
245   /* Set timeout.  */
246 #ifndef TIMEOUT
247   /* Default timeout is two seconds.  */
248 # define TIMEOUT 2
249 #endif
250   alarm (TIMEOUT);
251   signal (SIGALRM, timeout_handler);
252
253   /* Wait for the regular termination.  */
254   termpid = waitpid (pid, &status, 0);
255   if (termpid == -1)
256     {
257       printf ("Waiting for test program failed: %m\n");
258       exit (1);
259     }
260   if (termpid != pid)
261     {
262       printf ("Oops, wrong test program terminated: expected %ld, got %ld\n",
263               (long int) pid, (long int) termpid);
264       exit (1);
265     }
266
267 #ifndef EXPECTED_SIGNAL
268   /* We don't expect any signal.  */
269 # define EXPECTED_SIGNAL 0
270 #endif
271   if (WTERMSIG (status) != EXPECTED_SIGNAL)
272     {
273       if (EXPECTED_SIGNAL != 0)
274         {
275           if (WTERMSIG (status) == 0)
276             fprintf (stderr,
277                      "Expected signal '%s' from child, got none\n",
278                      strsignal (EXPECTED_SIGNAL));
279           else
280             fprintf (stderr,
281                      "Incorrect signal from child: got `%s', need `%s'\n",
282                      strsignal (WTERMSIG (status)),
283                      strsignal (EXPECTED_SIGNAL));
284         }
285       else
286         fprintf (stderr, "Didn't expect signal from child: got `%s'\n",
287                  strsignal (WTERMSIG (status)));
288       exit (1);
289     }
290
291   /* Simply exit with the return value of the test.  */
292   return WEXITSTATUS (status);
293 }