Cleanups, spelling fixes, allow symbol names for signals (-k option),
[tinc] / src / process.c
1 /*
2     process.c -- process management functions
3     Copyright (C) 1999-2002 Ivo Timmermans <itimmermans@bigfoot.com>,
4                   2000-2002 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.36 2002/03/11 11:23:04 guus 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 <stdlib.h>
35 #include <unistd.h>
36 #include <termios.h>
37
38 #include <pidfile.h>
39 #include <utils.h>
40 #include <xalloc.h>
41
42 #include "conf.h"
43 #include "process.h"
44 #include "subnet.h"
45 #include "device.h"
46 #include "connection.h"
47 #include "device.h"
48
49 #include "system.h"
50
51 /* If zero, don't detach from the terminal. */
52 int do_detach = 1;
53
54 extern char *identname;
55 extern char *pidfilename;
56 extern char **g_argv;
57
58 sigset_t emptysigset;
59
60 static int saved_debug_lvl = 0;
61
62 extern int sighup;
63 extern int sigalrm;
64 extern int do_purge;
65
66 void memory_full(int size)
67 {
68   syslog(LOG_ERR, _("Memory exhausted (couldn't allocate %d bytes), exitting."), size);
69   cp_trace();
70   exit(1);
71 }
72
73 /* Some functions the less gifted operating systems might lack... */
74
75 #ifndef HAVE_FCLOSEALL
76 int fcloseall(void)
77 {
78   fflush(stdin);
79   fflush(stdout);
80   fflush(stderr);
81   fclose(stdin);
82   fclose(stdout);
83   fclose(stderr);
84 }
85 #endif
86
87 /*
88   Close network connections, and terminate neatly
89 */
90 void cleanup_and_exit(int c)
91 {
92 cp
93   close_network_connections();
94
95   if(debug_lvl > DEBUG_NOTHING)
96     dump_device_stats();
97
98   syslog(LOG_NOTICE, _("Terminating"));
99
100   closelog();
101   exit(c);
102 }
103
104 /*
105   check for an existing tinc for this net, and write pid to pidfile
106 */
107 int write_pidfile(void)
108 {
109   int pid;
110 cp
111   if((pid = check_pid(pidfilename)))
112     {
113       if(netname)
114         fprintf(stderr, _("A tincd is already running for net `%s' with pid %d.\n"),
115                 netname, pid);
116       else
117         fprintf(stderr, _("A tincd is already running with pid %d.\n"), pid);
118       return 1;
119     }
120
121   /* if it's locked, write-protected, or whatever */
122   if(!write_pid(pidfilename))
123     return 1;
124 cp
125   return 0;
126 }
127
128 /*
129   kill older tincd for this net
130 */
131 int kill_other(int signal)
132 {
133   int pid;
134 cp
135   if(!(pid = read_pid(pidfilename)))
136     {
137       if(netname)
138         fprintf(stderr, _("No other tincd is running for net `%s'.\n"), netname);
139       else
140         fprintf(stderr, _("No other tincd is running.\n"));
141       return 1;
142     }
143
144   errno = 0;    /* No error, sometimes errno is only changed on error */
145   /* ESRCH is returned when no process with that pid is found */
146   if(kill(pid, signal) && errno == ESRCH)
147     {
148       if(netname)
149         fprintf(stderr, _("The tincd for net `%s' is no longer running. "), netname);
150       else
151         fprintf(stderr, _("The tincd is no longer running. "));
152
153       fprintf(stderr, _("Removing stale lock file.\n"));
154       remove_pid(pidfilename);
155     }
156 cp
157   return 0;
158 }
159
160 /*
161   Detach from current terminal, write pidfile, kill parent
162 */
163 int detach(void)
164 {
165 cp
166   setup_signals();
167
168   /* First check if we can open a fresh new pidfile */
169   
170   if(write_pidfile())
171     return -1;
172
173   /* If we succeeded in doing that, detach */
174
175   closelog();
176
177   if(do_detach)
178     {
179       if(daemon(0, 0) < 0)
180         {
181           fprintf(stderr, _("Couldn't detach from terminal: %s"), strerror(errno));
182           return -1;
183         }
184
185       /* Now UPDATE the pid in the pidfile, because we changed it... */
186       
187       if(!write_pid(pidfilename))
188         return -1;
189     }
190   
191   openlog(identname, LOG_CONS | LOG_PID, LOG_DAEMON);
192
193   if(debug_lvl > DEBUG_NOTHING)
194     syslog(LOG_NOTICE, _("tincd %s (%s %s) starting, debug level %d"),
195            VERSION, __DATE__, __TIME__, debug_lvl);
196   else
197     syslog(LOG_NOTICE, _("tincd %s starting"), VERSION);
198
199   xalloc_fail_func = memory_full;
200 cp
201   return 0;
202 }
203
204 /*
205   Execute the program name, with sane environment.  All output will be
206   redirected to syslog.
207 */
208 void _execute_script(const char *name)  __attribute__ ((noreturn));
209 void _execute_script(const char *name)
210 {
211   char *scriptname;
212   char *s;
213 cp
214 #ifdef HAVE_UNSETENV
215   unsetenv("NETNAME");
216   unsetenv("DEVICE");
217   unsetenv("INTERFACE");
218 #endif
219
220   if(netname)
221     {
222       asprintf(&s, "NETNAME=%s", netname);
223       putenv(s);        /* Don't free s! see man 3 putenv */
224     }
225
226   if(device)
227     {
228       asprintf(&s, "DEVICE=%s", device);
229       putenv(s);        /* Don't free s! see man 3 putenv */
230     }
231
232   if(interface)
233     {
234       asprintf(&s, "INTERFACE=%s", interface);
235       putenv(s);        /* Don't free s! see man 3 putenv */
236     }
237
238   chdir("/");
239   
240   asprintf(&scriptname, "%s/%s", confbase, name);
241
242   /* Close all file descriptors */
243   closelog();           /* <- this means we cannot use syslog() here anymore! */
244   fcloseall();
245
246   execl(scriptname, NULL);
247   /* No return on success */
248   
249   if(errno != ENOENT)   /* Ignore if the file does not exist */
250     exit(1);            /* Some error while trying execl(). */
251   else
252     exit(0);
253 }
254
255 /*
256   Fork and execute the program pointed to by name.
257 */
258 int execute_script(const char *name)
259 {
260   pid_t pid;
261   int status;
262 cp
263   if((pid = fork()) < 0)
264     {
265       syslog(LOG_ERR, _("System call `%s' failed: %s"), "fork", strerror(errno));
266       return -1;
267     }
268
269   if(pid)
270     {
271       if(debug_lvl >= DEBUG_STATUS)
272         syslog(LOG_INFO, _("Executing script %s"), name);
273
274       if(waitpid(pid, &status, 0) == pid)
275         {
276           if(WIFEXITED(status))         /* Child exited by itself */
277             {
278               if(WEXITSTATUS(status))
279                 {
280                   syslog(LOG_ERR, _("Process %d (%s) exited with non-zero status %d"), pid, name, WEXITSTATUS(status));
281                   return -1;
282                 }
283               else
284                 return 0;
285             }
286           else if(WIFSIGNALED(status))  /* Child was killed by a signal */
287             {
288               syslog(LOG_ERR, _("Process %d (%s) was killed by signal %d (%s)"),
289                      pid, name, WTERMSIG(status), strsignal(WTERMSIG(status)));
290               return -1;
291             }
292           else                          /* Something strange happened */
293             {
294               syslog(LOG_ERR, _("Process %d (%s) terminated abnormally"), pid, name);
295               return -1;
296             }
297         }
298       else
299         {
300           syslog(LOG_ERR, _("System call `%s' failed: %s"), "waitpid", strerror(errno));
301           return -1;
302         }
303     }
304 cp
305   /* Child here */
306
307   _execute_script(name);
308 }
309
310
311 /*
312   Signal handlers.
313 */
314
315 RETSIGTYPE
316 sigterm_handler(int a)
317 {
318   if(debug_lvl > DEBUG_NOTHING)
319     syslog(LOG_NOTICE, _("Got TERM signal"));
320
321   cleanup_and_exit(0);
322 }
323
324 RETSIGTYPE
325 sigquit_handler(int a)
326 {
327   if(debug_lvl > DEBUG_NOTHING)
328     syslog(LOG_NOTICE, _("Got QUIT signal"));
329   cleanup_and_exit(0);
330 }
331
332 RETSIGTYPE
333 fatal_signal_square(int a)
334 {
335   syslog(LOG_ERR, _("Got another fatal signal %d (%s): not restarting."), a, strsignal(a));
336   cp_trace();
337   exit(1);
338 }
339
340 RETSIGTYPE
341 fatal_signal_handler(int a)
342 {
343   struct sigaction act;
344   syslog(LOG_ERR, _("Got fatal signal %d (%s)"), a, strsignal(a));
345   cp_trace();
346
347   if(do_detach)
348     {
349       syslog(LOG_NOTICE, _("Trying to re-execute in 5 seconds..."));
350
351       act.sa_handler = fatal_signal_square;
352       act.sa_mask = emptysigset;
353       act.sa_flags = 0;
354       sigaction(SIGSEGV, &act, NULL);
355
356       close_network_connections();
357       sleep(5);
358       remove_pid(pidfilename);
359       execvp(g_argv[0], g_argv);
360     }
361   else
362     {
363       syslog(LOG_NOTICE, _("Not restarting."));
364       exit(1);
365     }
366 }
367
368 RETSIGTYPE
369 sighup_handler(int a)
370 {
371   if(debug_lvl > DEBUG_NOTHING)
372     syslog(LOG_NOTICE, _("Got HUP signal"));
373   sighup = 1;
374 }
375
376 RETSIGTYPE
377 sigint_handler(int a)
378 {
379   if(saved_debug_lvl)
380     {
381       syslog(LOG_NOTICE, _("Reverting to old debug level (%d)"),
382              saved_debug_lvl);
383       debug_lvl = saved_debug_lvl;
384       saved_debug_lvl = 0;
385     }
386   else
387     {
388       syslog(LOG_NOTICE, _("Temporarily setting debug level to 5.  Kill me with SIGINT again to go back to level %d."),
389              debug_lvl);
390       saved_debug_lvl = debug_lvl;
391       debug_lvl = 5;
392     }
393 }
394
395 RETSIGTYPE
396 sigalrm_handler(int a)
397 {
398   if(debug_lvl > DEBUG_NOTHING)
399     syslog(LOG_NOTICE, _("Got ALRM signal"));
400   sigalrm = 1;
401 }
402
403 RETSIGTYPE
404 sigusr1_handler(int a)
405 {
406   dump_connections();
407 }
408
409 RETSIGTYPE
410 sigusr2_handler(int a)
411 {
412   dump_device_stats();
413   dump_nodes();
414   dump_edges();
415   dump_subnets();
416 }
417
418 RETSIGTYPE
419 sigwinch_handler(int a)
420 {
421   extern int do_purge;
422   do_purge = 1;
423 }
424
425 RETSIGTYPE
426 unexpected_signal_handler(int a)
427 {
428   syslog(LOG_WARNING, _("Got unexpected signal %d (%s)"), a, strsignal(a));
429   cp_trace();
430 }
431
432 RETSIGTYPE
433 ignore_signal_handler(int a)
434 {
435   if(debug_lvl >= DEBUG_SCARY_THINGS)
436   {
437     syslog(LOG_DEBUG, _("Ignored signal %d (%s)"), a, strsignal(a));
438     cp_trace();
439   }
440 }
441
442 struct {
443   int signal;
444   void (*handler)(int);
445 } sighandlers[] = {
446   { SIGHUP, sighup_handler },
447   { SIGTERM, sigterm_handler },
448   { SIGQUIT, sigquit_handler },
449   { SIGSEGV, fatal_signal_handler },
450   { SIGBUS, fatal_signal_handler },
451   { SIGILL, fatal_signal_handler },
452   { SIGPIPE, ignore_signal_handler },
453   { SIGINT, sigint_handler },
454   { SIGUSR1, sigusr1_handler },
455   { SIGUSR2, sigusr2_handler },
456   { SIGCHLD, ignore_signal_handler },
457   { SIGALRM, sigalrm_handler },
458   { SIGWINCH, sigwinch_handler },
459   { 0, NULL }
460 };
461
462 void
463 setup_signals(void)
464 {
465   int i;
466   struct sigaction act;
467
468   sigemptyset(&emptysigset);
469   act.sa_handler = NULL;
470   act.sa_mask = emptysigset;
471   act.sa_flags = 0;
472
473   /* Set a default signal handler for every signal, errors will be
474      ignored. */
475   for(i = 0; i < NSIG; i++) 
476     {
477       if(!do_detach)
478         act.sa_handler = SIG_DFL;
479       else
480         act.sa_handler = unexpected_signal_handler;
481       sigaction(i, &act, NULL);
482     }
483
484   /* If we didn't detach, allow coredumps */
485   if(!do_detach)
486     sighandlers[3].handler = SIG_DFL;
487
488   /* Then, for each known signal that we want to catch, assign a
489      handler to the signal, with error checking this time. */
490   for(i = 0; sighandlers[i].signal; i++)
491     {
492       act.sa_handler = sighandlers[i].handler;
493       if(sigaction(sighandlers[i].signal, &act, NULL) < 0)
494         fprintf(stderr, _("Installing signal handler for signal %d (%s) failed: %s\n"),
495                 sighandlers[i].signal, strsignal(sighandlers[i].signal), strerror(errno));
496     }
497 }