Add more checks to ensure that filedescriptors are right in
[tinc] / src / process.c
1 /*
2     process.c -- process management functions
3     Copyright (C) 1999,2000 Ivo Timmermans <itimmermans@bigfoot.com>,
4                        2000 Guus Sliepen <guus@sliepen.warande.net>
5
6     This program is free software; you can redistribute it and/or modify
7     it under the terms of the GNU General Public License as published by
8     the Free Software Foundation; either version 2 of the License, or
9     (at your option) any later version.
10
11     This program 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
14     GNU General Public License for more details.
15
16     You should have received a copy of the GNU General Public License
17     along with this program; if not, write to the Free Software
18     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19
20     $Id: process.c,v 1.1.2.8 2000/11/22 17:48:15 zarq Exp $
21 */
22
23 #include "config.h"
24
25 #include <errno.h>
26 #include <fcntl.h>
27 #include <signal.h>
28 #include <stdio.h>
29 #include <string.h>
30 #include <syslog.h>
31 #include <sys/ioctl.h>
32 #include <sys/types.h>
33 #include <sys/wait.h>
34 #include <unistd.h>
35
36 #include <list.h>
37 #include <pidfile.h>
38 #include <utils.h>
39 #include <xalloc.h>
40
41 #include "conf.h"
42 #include "process.h"
43
44 #include "system.h"
45
46 /* A list containing all our children */
47 list_t *child_pids = NULL;
48
49 /* If zero, don't detach from the terminal. */
50 int do_detach = 1;
51
52 static pid_t ppid;
53
54 extern char *identname;
55 extern char *pidfilename;
56 extern char **g_argv;
57
58 void init_processes(void)
59 {
60 cp
61   child_pids = list_new();
62 cp
63 }
64
65 void memory_full(int size)
66 {
67   syslog(LOG_ERR, _("Memory exhausted (couldn't allocate %d bytes), exiting."), size);
68   cp_trace();
69   exit(1);
70 }
71
72 /*
73   Close network connections, and terminate neatly
74 */
75 void cleanup_and_exit(int c)
76 {
77 cp
78   close_network_connections();
79
80   if(debug_lvl > DEBUG_NOTHING)
81     syslog(LOG_INFO, _("Total bytes written: tap %d, socket %d; bytes read: tap %d, socket %d"),
82            total_tap_out, total_socket_out, total_tap_in, total_socket_in);
83
84   closelog();
85   kill(ppid, SIGTERM);
86   exit(c);
87 }
88
89 /*
90   check for an existing tinc for this net, and write pid to pidfile
91 */
92 int write_pidfile(void)
93 {
94   int pid;
95 cp
96   if((pid = check_pid(pidfilename)))
97     {
98       if(netname)
99         fprintf(stderr, _("A tincd is already running for net `%s' with pid %d.\n"),
100                 netname, pid);
101       else
102         fprintf(stderr, _("A tincd is already running with pid %d.\n"), pid);
103       return 1;
104     }
105
106   /* if it's locked, write-protected, or whatever */
107   if(!write_pid(pidfilename))
108     return 1;
109 cp
110   return 0;
111 }
112
113 /*
114   kill older tincd for this net
115 */
116 int kill_other(void)
117 {
118   int pid;
119 cp
120   if(!(pid = read_pid(pidfilename)))
121     {
122       if(netname)
123         fprintf(stderr, _("No other tincd is running for net `%s'.\n"), netname);
124       else
125         fprintf(stderr, _("No other tincd is running.\n"));
126       return 1;
127     }
128
129   errno = 0;    /* No error, sometimes errno is only changed on error */
130   /* ESRCH is returned when no process with that pid is found */
131   if(kill(pid, SIGTERM) && errno == ESRCH)
132     fprintf(stderr, _("Removing stale lock file.\n"));
133   remove_pid(pidfilename);
134 cp
135   return 0;
136 }
137
138 /*
139   Detach from current terminal, write pidfile, kill parent
140 */
141 int detach(void)
142 {
143   int fd;
144   pid_t pid;
145 cp
146   setup_signals();
147
148   if(write_pidfile())
149     return -1;
150
151   if(do_detach)
152     daemon(0, 0);
153
154   openlog(identname, LOG_CONS | LOG_PID, LOG_DAEMON);
155
156   if(debug_lvl > DEBUG_NOTHING)
157     syslog(LOG_NOTICE, _("tincd %s (%s %s) starting, debug level %d"),
158            VERSION, __DATE__, __TIME__, debug_lvl);
159   else
160     syslog(LOG_NOTICE, _("tincd %s starting"), VERSION);
161
162   xalloc_fail_func = memory_full;
163 cp
164   return 0;
165 }
166
167 /*
168   Execute the program name, with sane environment.  All output will be
169   redirected to syslog.
170 */
171 void _execute_script(const char *name)  __attribute__ ((noreturn));
172 void _execute_script(const char *name)
173 {
174   int error = 0;
175   char *scriptname;
176   char *s;
177 cp
178   if(netname)
179     {
180       asprintf(&s, "NETNAME=%s", netname);
181       putenv(s);        /* Don't free s! see man 3 putenv */
182     }
183 #ifdef HAVE_UNSETENV
184   else
185     {
186       unsetenv("NETNAME");
187     }
188 #endif
189
190   if(chdir(confbase) < 0)
191     /* This cannot fail since we already read config files from this
192        directory. - Guus */
193     /* Yes this can fail, somebody could have removed this directory
194        when we didn't pay attention. - Ivo */
195     {
196       if(chdir("/") < 0)
197         /* Now if THIS fails, something wicked is going on. - Ivo */
198         syslog(LOG_ERR, _("Couldn't chdir to `/': %m"));
199
200       /* Continue anyway. */
201     }
202   
203   asprintf(&scriptname, "%s/%s", confbase, name);
204
205   /* Close all file descriptors */
206   closelog();
207   fcloseall();
208
209   /* Open standard input */
210   if((fd = open("/dev/null", O_RDONLY)) < 0)
211     {
212       syslog(LOG_ERR, _("Opening `/dev/null' failed: %m"));
213       error = 1;
214     }
215   if(dup2(fd, 0) != 0)
216     {
217       syslog(LOG_ERR, _("Couldn't assign /dev/null to standard input: %m"));
218       error = 1;
219     }
220
221   if(!error)
222     {
223       close(1);  /* fd #1 should be the first available filedescriptor now. */
224       /* Standard output directly goes to syslog */
225       openlog(name, LOG_CONS | LOG_PID, LOG_DAEMON);
226       /* Standard error as well */
227       if(dup2(1, 2) < 0)
228         {
229           syslog(LOG_ERR, _("System call `%s' failed: %m"),
230                  "dup2");
231           error = 1;
232         }
233     }
234   
235   if(error && debug_lvl > 1)
236     syslog(LOG_INFO, _("This means that any output the script generates will not be shown in syslog."));
237   
238   execl(scriptname, NULL);
239   /* No return on success */
240   
241   if(errno != ENOENT)  /* Ignore if the file does not exist */
242     syslog(LOG_WARNING, _("Error executing `%s': %m"), scriptname);
243
244   /* No need to free things */
245   exit(0);
246 }
247
248 /*
249   Fork and execute the program pointed to by name.
250 */
251 int execute_script(const char *name)
252 {
253   pid_t pid;
254 cp
255   if((pid = fork()) < 0)
256     {
257       syslog(LOG_ERR, _("System call `%s' failed: %m"),
258              "fork");
259       return -1;
260     }
261
262   if(pid)
263     {
264       list_append(child_pids, &pid);
265       return 0;
266     }
267 cp
268   /* Child here */
269   _execute_script(name);
270 }
271
272 /*
273   Check a child (the pointer data is actually an integer, the PID of
274   that child.  A non-zero return value means that the child has exited
275   and can be removed from our list.
276 */
277 int check_child(void *data)
278 {
279   pid_t pid;
280   int status;
281 cp
282   pid = (pid_t) data;
283   pid = waitpid(pid, &status, WNOHANG);
284   if(WIFEXITED(status))
285     {
286       if(WIFSIGNALED(status)) /* Child was killed by a signal */
287         {
288           syslog(LOG_ERR, _("Child with PID %d was killed by signal %d (%s)"),
289                  pid, WTERMSIG(status), strsignal(WTERMSIG(status)));
290           return -1;
291         }
292       if(WEXITSTATUS(status) != 0)
293         {
294           syslog(LOG_INFO, _("Child with PID %d exited with code %d"),
295                  WEXITSTATUS(status));
296         }
297       return -1;
298     }
299 cp
300   /* Child is still running */
301   return 0;
302 }
303
304 /*
305   Check the status of all our children.
306 */
307 void check_children(void)
308 {
309   list_forall_nodes(child_pids, check_child);
310 }
311
312
313 /*
314   Signal handlers.
315 */
316
317 RETSIGTYPE
318 sigterm_handler(int a)
319 {
320   if(debug_lvl > DEBUG_NOTHING)
321     syslog(LOG_NOTICE, _("Got TERM signal"));
322
323   cleanup_and_exit(0);
324 }
325
326 RETSIGTYPE
327 sigquit_handler(int a)
328 {
329   if(debug_lvl > DEBUG_NOTHING)
330     syslog(LOG_NOTICE, _("Got QUIT signal"));
331   cleanup_and_exit(0);
332 }
333
334 RETSIGTYPE
335 sigsegv_square(int a)
336 {
337   syslog(LOG_ERR, _("Got another SEGV signal: not restarting"));
338   exit(0);
339 }
340
341 RETSIGTYPE
342 sigsegv_handler(int a)
343 {
344   syslog(LOG_ERR, _("Got SEGV signal"));
345   cp_trace();
346
347   if(do_detach)
348     {
349       syslog(LOG_NOTICE, _("Trying to re-execute in 5 seconds..."));
350       signal(SIGSEGV, sigsegv_square);
351       close_network_connections();
352       sleep(5);
353       remove_pid(pidfilename);
354       execvp(g_argv[0], g_argv);
355     }
356   else
357     {
358       syslog(LOG_NOTICE, _("Not restarting."));
359       exit(0);
360     }
361 }
362
363 RETSIGTYPE
364 sighup_handler(int a)
365 {
366   if(debug_lvl > DEBUG_NOTHING)
367     syslog(LOG_NOTICE, _("Got HUP signal"));
368   sighup = 1;
369 }
370
371 RETSIGTYPE
372 sigint_handler(int a)
373 {
374   if(debug_lvl > DEBUG_NOTHING)
375     syslog(LOG_NOTICE, _("Got INT signal, exiting"));
376   cleanup_and_exit(0);
377 }
378
379 RETSIGTYPE
380 sigusr1_handler(int a)
381 {
382   dump_connection_list();
383 }
384
385 RETSIGTYPE
386 sigusr2_handler(int a)
387 {
388   dump_subnet_list();
389 }
390
391 RETSIGTYPE
392 sighuh(int a)
393 {
394   syslog(LOG_WARNING, _("Got unexpected signal %d (%s)"), a, strsignal(a));
395   cp_trace();
396 }
397
398 void
399 setup_signals(void)
400 {
401   int i;
402
403   for(i=0;i<32;i++)
404     signal(i,sighuh);
405
406   if(signal(SIGTERM, SIG_IGN) != SIG_ERR)
407     signal(SIGTERM, sigterm_handler);
408   if(signal(SIGQUIT, SIG_IGN) != SIG_ERR)
409     signal(SIGQUIT, sigquit_handler);
410   if(signal(SIGSEGV, SIG_IGN) != SIG_ERR)
411     signal(SIGSEGV, sigsegv_handler);
412   if(signal(SIGHUP, SIG_IGN) != SIG_ERR)
413     signal(SIGHUP, sighup_handler);
414   signal(SIGPIPE, SIG_IGN);
415   if(signal(SIGINT, SIG_IGN) != SIG_ERR)
416     signal(SIGINT, sigint_handler);
417   signal(SIGUSR1, sigusr1_handler);
418   signal(SIGUSR2, sigusr2_handler);
419   signal(SIGCHLD, SIG_IGN);
420 }
421
422 RETSIGTYPE parent_exit(int a)
423 {
424   exit(0);
425 }