013b24dfcfa76d23370f4863219f8bae0151d42e
[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.16 2000/11/26 22:42:34 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 <stdlib.h>
35 #include <unistd.h>
36 #include <termios.h>
37
38 #include <list.h>
39 #include <pidfile.h>
40 #include <utils.h>
41 #include <xalloc.h>
42
43 #include "conf.h"
44 #include "process.h"
45 #include "subnet.h"
46 #include "connection.h"
47
48 #include "system.h"
49
50 /* If zero, don't detach from the terminal. */
51 int do_detach = 1;
52
53 extern char *identname;
54 extern char *pidfilename;
55 extern char **g_argv;
56
57 void memory_full(int size)
58 {
59   syslog(LOG_ERR, _("Memory exhausted (couldn't allocate %d bytes), exiting."), size);
60   cp_trace();
61   exit(1);
62 }
63
64 /* Some functions the less gifted operating systems might lack... */
65
66 #ifndef HAVE_FCLOSEALL
67 int fcloseall(void)
68 {
69   fflush(stdin);
70   fflush(stdout);
71   fflush(stderr);
72   fclose(stdin);
73   fclose(stdout);
74   fclose(stderr);
75 }
76 #endif
77
78 /*
79   Close network connections, and terminate neatly
80 */
81 void cleanup_and_exit(int c)
82 {
83 cp
84   close_network_connections();
85
86   if(debug_lvl > DEBUG_NOTHING)
87     syslog(LOG_INFO, _("Total bytes written: tap %d, socket %d; bytes read: tap %d, socket %d"),
88            total_tap_out, total_socket_out, total_tap_in, total_socket_in);
89
90   syslog(LOG_NOTICE, _("Terminating"));
91
92   closelog();
93   exit(c);
94 }
95
96 /*
97   check for an existing tinc for this net, and write pid to pidfile
98 */
99 int write_pidfile(void)
100 {
101   int pid;
102 cp
103   if((pid = check_pid(pidfilename)))
104     {
105       if(netname)
106         fprintf(stderr, _("A tincd is already running for net `%s' with pid %d.\n"),
107                 netname, pid);
108       else
109         fprintf(stderr, _("A tincd is already running with pid %d.\n"), pid);
110       return 1;
111     }
112
113   /* if it's locked, write-protected, or whatever */
114   if(!write_pid(pidfilename))
115     return 1;
116 cp
117   return 0;
118 }
119
120 /*
121   kill older tincd for this net
122 */
123 int kill_other(void)
124 {
125   int pid;
126 cp
127   if(!(pid = read_pid(pidfilename)))
128     {
129       if(netname)
130         fprintf(stderr, _("No other tincd is running for net `%s'.\n"), netname);
131       else
132         fprintf(stderr, _("No other tincd is running.\n"));
133       return 1;
134     }
135
136   errno = 0;    /* No error, sometimes errno is only changed on error */
137   /* ESRCH is returned when no process with that pid is found */
138   if(kill(pid, SIGTERM) && errno == ESRCH)
139     fprintf(stderr, _("Removing stale lock file.\n"));
140   remove_pid(pidfilename);
141 cp
142   return 0;
143 }
144
145 /*
146   Detach from current terminal, write pidfile, kill parent
147 */
148 int detach(void)
149 {
150 cp
151   setup_signals();
152
153   /* First check if we can open a fresh new pidfile */
154   
155   if(write_pidfile())
156     return -1;
157
158   /* If we succeeded in doing that, detach */
159
160   if(do_detach)
161     {
162       if(daemon(0, 0) < 0)
163         {
164           fprintf(stderr, _("Couldn't detach from terminal: %m"));
165           return -1;
166         }
167
168       /* Now UPDATE the pid in the pidfile, because we changed it... */
169       
170       if(!write_pid(pidfilename))
171         return -1;
172     }
173   
174   openlog(identname, LOG_CONS | LOG_PID, LOG_DAEMON);
175
176   if(debug_lvl > DEBUG_NOTHING)
177     syslog(LOG_NOTICE, _("tincd %s (%s %s) starting, debug level %d"),
178            VERSION, __DATE__, __TIME__, debug_lvl);
179   else
180     syslog(LOG_NOTICE, _("tincd %s starting"), VERSION);
181
182   xalloc_fail_func = memory_full;
183 cp
184   return 0;
185 }
186
187 /*
188   Execute the program name, with sane environment.  All output will be
189   redirected to syslog.
190 */
191 void _execute_script(const char *name)  __attribute__ ((noreturn));
192 void _execute_script(const char *name)
193 {
194   char *scriptname;
195   char *s;
196 cp
197   if(netname)
198     {
199       asprintf(&s, "NETNAME=%s", netname);
200       putenv(s);        /* Don't free s! see man 3 putenv */
201     }
202 #ifdef HAVE_UNSETENV
203   else
204     {
205       unsetenv("NETNAME");
206     }
207 #endif
208
209   chdir("/");
210   
211   asprintf(&scriptname, "%s/%s", confbase, name);
212
213   /* Close all file descriptors */
214   closelog();           /* <- this means we cannot use syslog() here anymore! */
215   fcloseall();
216
217   execl(scriptname, NULL);
218   /* No return on success */
219   
220   if(errno != ENOENT)   /* Ignore if the file does not exist */
221     exit(-1);           /* Some error while trying execl(). */
222   else
223     exit(0);
224 }
225
226 /*
227   Fork and execute the program pointed to by name.
228 */
229 int execute_script(const char *name)
230 {
231   pid_t pid;
232   int status;
233 cp
234   if((pid = fork()) < 0)
235     {
236       syslog(LOG_ERR, _("System call `%s' failed: %m"),
237              "fork");
238       return -1;
239     }
240
241   if(pid)
242     {
243       if(debug_lvl >= DEBUG_STATUS)
244         syslog(LOG_INFO, _("Executing script %s"), name);
245
246       if(waitpid(pid, &status, 0) == pid)
247         {
248           if(WIFEXITED(status))         /* Child exited by itself */
249             {
250               if(WEXITSTATUS(status))
251                 {
252                   syslog(LOG_ERR, _("Process %d (%s) exited with non-zero status %d"), pid, name, WEXITSTATUS(status));
253                   return -1;
254                 }
255               else
256                 return 0;
257             }
258           else if(WIFSIGNALED(status))  /* Child was killed by a signal */
259             {
260               syslog(LOG_ERR, _("Process %d (%s) was killed by signal %d (%s)"),
261                      pid, name, WTERMSIG(status), strsignal(WTERMSIG(status)));
262               return -1;
263             }
264           else                          /* Something strange happened */
265             {
266               syslog(LOG_ERR, _("Process %d (%s) terminated abnormaly"), pid, name);
267               return -1;
268             }
269         }
270       else
271         {
272           syslog(LOG_ERR, _("System call `%s' failed: %m"), "waitpid");
273           return -1;
274         }
275     }
276 cp
277   /* Child here */
278
279   _execute_script(name);
280 }
281
282
283 /*
284   Signal handlers.
285 */
286
287 RETSIGTYPE
288 sigterm_handler(int a, siginfo_t *info, void *)
289 {
290   if(debug_lvl > DEBUG_NOTHING)
291     syslog(LOG_NOTICE, _("Got TERM signal"));
292
293   cleanup_and_exit(0);
294 }
295
296 RETSIGTYPE
297 sigquit_handler(int a, siginfo_t *info, void *)
298 {
299   if(debug_lvl > DEBUG_NOTHING)
300     syslog(LOG_NOTICE, _("Got QUIT signal"));
301   cleanup_and_exit(0);
302 }
303
304 RETSIGTYPE
305 sigsegv_square(int a, siginfo_t *info, void *)
306 {
307   syslog(LOG_ERR, _("Got another SEGV signal: not restarting"));
308   cp_trace();
309   exit(0);
310 }
311
312 RETSIGTYPE
313 sigsegv_handler(int a, siginfo_t *info, void *)
314 {
315   syslog(LOG_ERR, _("Got SEGV signal"));
316   cp_trace();
317
318   if(do_detach)
319     {
320       syslog(LOG_NOTICE, _("Trying to re-execute in 5 seconds..."));
321       signal(SIGSEGV, sigsegv_square);
322       close_network_connections();
323       sleep(5);
324       remove_pid(pidfilename);
325       execvp(g_argv[0], g_argv);
326     }
327   else
328     {
329       syslog(LOG_NOTICE, _("Not restarting."));
330       exit(0);
331     }
332 }
333
334 RETSIGTYPE
335 sighup_handler(int a, siginfo_t *info, void *)
336 {
337   if(debug_lvl > DEBUG_NOTHING)
338     syslog(LOG_NOTICE, _("Got HUP signal"));
339   sighup = 1;
340 }
341
342 RETSIGTYPE
343 sigint_handler(int a, siginfo_t *info, void *)
344 {
345   if(debug_lvl > DEBUG_NOTHING)
346     syslog(LOG_NOTICE, _("Got INT signal, exiting"));
347   cleanup_and_exit(0);
348 }
349
350 RETSIGTYPE
351 sigusr1_handler(int a, siginfo_t *info, void *)
352 {
353   dump_connection_list();
354 }
355
356 RETSIGTYPE
357 sigusr2_handler(int a, siginfo_t *info, void *)
358 {
359   dump_subnet_list();
360 }
361
362 RETSIGTYPE
363 sighuh(int a, siginfo_t *info, void *)
364 {
365   syslog(LOG_WARNING, _("Got unexpected signal %d (%s)"), a, strsignal(a));
366   cp_trace();
367 }
368
369 struct {
370   int signal;
371   void (*handler)(int, siginfo_t *, void *);
372 } sighandlers[] = {
373   { SIGHUP, sighup_handler },
374   { SIGTERM, sigterm_handler },
375   { SIGQUIT, sigquit_handler },
376   { SIGSEGV, sigsegv_handler },
377   { SIGPIPE, NULL },
378   { SIGINT, sigint_handler },
379   { SIGUSR1, sigusr1_handler },
380   { SIGUSR2, sigusr2_handler },
381   { SIGCHLD, NULL },
382   { 0, NULL }
383 };
384
385 void
386 setup_signals(void)
387 {
388   int i;
389   sigset_t a;
390   struct sigaction act;
391
392   sigemptyset(&a);
393   act.sa_handler = NULL;
394   act.sa_mask = a;
395   act.sa_flags = SA_SIGINFO;
396
397   /* Set a default signal handler for every signal, errors will be
398      ignored. */
399   for(i = 0; i < NSIG; i++) 
400     {
401       act.sa_sigaction = sighuh_handler;
402       sigaction(sighandlers[i].signal, &act, NULL);
403     }
404
405   /* Then, for each known signal that we want to catch, assign a
406      handler to the signal, with error checking this time. */
407   for(i = 0; sighandlers[i].signal; i++)
408     {
409       act.sa_sigaction = sighandlers[i].handler;
410       if(sigaction(sighandlers[i].signal, &act, NULL) < 0)
411         fprintf(stderr, _("Installing signal handler for signal %d (%s) failed: %m\n"),
412                 sighandlers[i].signal, strsignal(sighandlers[i].signal));
413     }
414 }