(add_temp_file): Add __attribute__ ((unused)) to avoid warnings.
[kopensolaris-gnu/glibc.git] / test-skeleton.c
1 /* Skeleton for test programs.
2    Copyright (C) 1998, 2000, 2001 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 int 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 /* Timeout handler.  We kill the child and exit with an error.  */
94 static void
95 __attribute__ ((noreturn))
96 timeout_handler (int sig __attribute__ ((unused)))
97 {
98   int killed;
99
100   /* Send signal.  */
101   kill (pid, SIGKILL);
102
103   /* Wait for it to terminate.  */
104   killed = waitpid (pid, NULL, WNOHANG);
105   if (killed != 0 && killed != pid)
106     {
107       perror ("Failed to killed test process");
108       exit (1);
109     }
110
111 #ifdef CLEANUP_HANDLER
112   CLEANUP_HANDLER;
113 #endif
114
115   fputs ("Timed out: killed the child process\n", stderr);
116
117   /* Exit with an error.  */
118   exit (1);
119 }
120
121 /* We provide the entry point here.  */
122 int
123 main (int argc, char *argv[])
124 {
125   int direct = 0;       /* Directly call the test function?  */
126   int status;
127   int opt;
128
129 #ifdef STDOUT_UNBUFFERED
130   setbuf (stdout, NULL);
131 #endif
132
133   while ((opt = getopt_long (argc, argv, "", options, NULL)) != -1)
134     switch (opt)
135       {
136       case '?':
137         exit (1);
138       case OPT_DIRECT:
139         direct = 1;
140         break;
141       case OPT_TESTDIR:
142         test_dir = optarg;
143         break;
144 #ifdef CMDLINE_PROCESS
145         CMDLINE_PROCESS
146 #endif
147       }
148
149   /* Set TMPDIR to specified test directory.  */
150   if (test_dir != NULL)
151     {
152       setenv ("TMPDIR", test_dir, 1);
153
154       if (chdir (test_dir) < 0)
155         {
156           perror ("chdir");
157           exit (1);
158         }
159     }
160   else
161     {
162       test_dir = getenv ("TMPDIR");
163       if (test_dir == NULL || test_dir[0] == '\0')
164         test_dir = "/tmp";
165     }
166
167   /* Make sure we see all message, even those on stdout.  */
168   setvbuf (stdout, NULL, _IONBF, 0);
169
170   /* make sure temporary files are deleted.  */
171   atexit (delete_temp_files);
172
173   /* Correct for the possible parameters.  */
174   argv += optind - 1;
175   argc -= optind - 1;
176
177   /* Call the initializing function, if one is available.  */
178 #ifdef PREPARE
179   PREPARE (argc, argv);
180 #endif
181
182   /* If we are not expected to fork run the function immediately.  */
183   if (direct)
184     return TEST_FUNCTION;
185
186   /* Set up the test environment:
187      - prevent core dumps
188      - set up the timer
189      - fork and execute the function.  */
190
191   pid = fork ();
192   if (pid == 0)
193     {
194       /* This is the child.  */
195 #ifdef RLIMIT_CORE
196       /* Try to avoid dumping core.  */
197       struct rlimit core_limit;
198       core_limit.rlim_cur = 0;
199       core_limit.rlim_max = 0;
200       setrlimit (RLIMIT_CORE, &core_limit);
201 #endif
202
203       /* Execute the test function and exit with the return value.   */
204       exit (TEST_FUNCTION);
205     }
206   else if (pid < 0)
207     {
208       perror ("Cannot fork test program");
209       exit (1);
210     }
211
212   /* Set timeout.  */
213 #ifndef TIMEOUT
214   /* Default timeout is two seconds.  */
215 # define TIMEOUT 2
216 #endif
217   alarm (TIMEOUT);
218   signal (SIGALRM, timeout_handler);
219
220   /* Wait for the regular termination.  */
221   if (waitpid (pid, &status, 0) != pid)
222     {
223       perror ("Oops, wrong test program terminated");
224       exit (1);
225     }
226
227 #ifndef EXPECTED_SIGNAL
228   /* We don't expect any signal.  */
229 # define EXPECTED_SIGNAL 0
230 #endif
231   if (WTERMSIG (status) != EXPECTED_SIGNAL)
232     {
233       if (EXPECTED_SIGNAL != 0)
234         fprintf (stderr, "Incorrect signal from child: got `%s', need `%s'\n",
235                  strsignal (WTERMSIG (status)), strsignal (EXPECTED_SIGNAL));
236       else
237         fprintf (stderr, "Didn't expect signal from child: got `%s'\n",
238                  strsignal (WTERMSIG (status)));
239       exit (1);
240     }
241
242   /* Simply exit with the return value of the test.  */
243   return WEXITSTATUS (status);
244 }