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.35 2002/02/18 16:25:16 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), exiting."), 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     fprintf(stderr, _("Removing stale lock file.\n"));
 148   remove_pid(pidfilename);
 149 cp
 150   return 0;
 151 }
 152
 153 /*
 154   Detach from current terminal, write pidfile, kill parent
 155 */
 156 int detach(void)
 157 {
 158 cp
 159   setup_signals();
 160
 161   /* First check if we can open a fresh new pidfile */
 162
 163   if(write_pidfile())
 164     return -1;
 165
 166   /* If we succeeded in doing that, detach */
 167
 168   closelog();
 169
 170   if(do_detach)
 171     {
 172       if(daemon(0, 0) < 0)
 173         {
 174           fprintf(stderr, _("Couldn't detach from terminal: %s"), strerror(errno));
 175           return -1;
 176         }
 177
 178       /* Now UPDATE the pid in the pidfile, because we changed it... */
 179
 180       if(!write_pid(pidfilename))
 181         return -1;
 182     }
 183
 184   openlog(identname, LOG_CONS | LOG_PID, LOG_DAEMON);
 185
 186   if(debug_lvl > DEBUG_NOTHING)
 187     syslog(LOG_NOTICE, _("tincd %s (%s %s) starting, debug level %d"),
 188            VERSION, __DATE__, __TIME__, debug_lvl);
 189   else
 190     syslog(LOG_NOTICE, _("tincd %s starting"), VERSION);
 191
 192   xalloc_fail_func = memory_full;
 193 cp
 194   return 0;
 195 }
 196
 197 /*
 198   Execute the program name, with sane environment.  All output will be
 199   redirected to syslog.
 200 */
 201 void _execute_script(const char *name)  __attribute__ ((noreturn));
 202 void _execute_script(const char *name)
 203 {
 204   char *scriptname;
 205   char *s;
 206 cp
 207 #ifdef HAVE_UNSETENV
 208   unsetenv("NETNAME");
 209   unsetenv("DEVICE");
 210   unsetenv("INTERFACE");
 211 #endif
 212
 213   if(netname)
 214     {
 215       asprintf(&s, "NETNAME=%s", netname);
 216       putenv(s);        /* Don't free s! see man 3 putenv */
 217     }
 218
 219   if(device)
 220     {
 221       asprintf(&s, "DEVICE=%s", device);
 222       putenv(s);        /* Don't free s! see man 3 putenv */
 223     }
 224
 225   if(interface)
 226     {
 227       asprintf(&s, "INTERFACE=%s", interface);
 228       putenv(s);        /* Don't free s! see man 3 putenv */
 229     }
 230
 231   chdir("/");
 232
 233   asprintf(&scriptname, "%s/%s", confbase, name);
 234
 235   /* Close all file descriptors */
 236   closelog();           /* <- this means we cannot use syslog() here anymore! */
 237   fcloseall();
 238
 239   execl(scriptname, NULL);
 240   /* No return on success */
 241
 242   if(errno != ENOENT)   /* Ignore if the file does not exist */
 243     exit(1);            /* Some error while trying execl(). */
 244   else
 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   int status;
 255 cp
 256   if((pid = fork()) < 0)
 257     {
 258       syslog(LOG_ERR, _("System call `%s' failed: %s"), "fork", strerror(errno));
 259       return -1;
 260     }
 261
 262   if(pid)
 263     {
 264       if(debug_lvl >= DEBUG_STATUS)
 265         syslog(LOG_INFO, _("Executing script %s"), name);
 266
 267       if(waitpid(pid, &status, 0) == pid)
 268         {
 269           if(WIFEXITED(status))         /* Child exited by itself */
 270             {
 271               if(WEXITSTATUS(status))
 272                 {
 273                   syslog(LOG_ERR, _("Process %d (%s) exited with non-zero status %d"), pid, name, WEXITSTATUS(status));
 274                   return -1;
 275                 }
 276               else
 277                 return 0;
 278             }
 279           else if(WIFSIGNALED(status))  /* Child was killed by a signal */
 280             {
 281               syslog(LOG_ERR, _("Process %d (%s) was killed by signal %d (%s)"),
 282                      pid, name, WTERMSIG(status), strsignal(WTERMSIG(status)));
 283               return -1;
 284             }
 285           else                          /* Something strange happened */
 286             {
 287               syslog(LOG_ERR, _("Process %d (%s) terminated abnormally"), pid, name);
 288               return -1;
 289             }
 290         }
 291       else
 292         {
 293           syslog(LOG_ERR, _("System call `%s' failed: %s"), "waitpid", strerror(errno));
 294           return -1;
 295         }
 296     }
 297 cp
 298   /* Child here */
 299
 300   _execute_script(name);
 301 }
 302
 303
 304 /*
 305   Signal handlers.
 306 */
 307
 308 RETSIGTYPE
 309 sigterm_handler(int a)
 310 {
 311   if(debug_lvl > DEBUG_NOTHING)
 312     syslog(LOG_NOTICE, _("Got TERM signal"));
 313
 314   cleanup_and_exit(0);
 315 }
 316
 317 RETSIGTYPE
 318 sigquit_handler(int a)
 319 {
 320   if(debug_lvl > DEBUG_NOTHING)
 321     syslog(LOG_NOTICE, _("Got QUIT signal"));
 322   cleanup_and_exit(0);
 323 }
 324
 325 RETSIGTYPE
 326 sigsegv_square(int a)
 327 {
 328   syslog(LOG_ERR, _("Got another SEGV signal: not restarting"));
 329   cp_trace();
 330   exit(1);
 331 }
 332
 333 RETSIGTYPE
 334 sigsegv_handler(int a)
 335 {
 336   struct sigaction act;
 337   syslog(LOG_ERR, _("Got SEGV signal"));
 338   cp_trace();
 339
 340   if(do_detach)
 341     {
 342       syslog(LOG_NOTICE, _("Trying to re-execute in 5 seconds..."));
 343
 344       act.sa_handler = sigsegv_square;
 345       act.sa_mask = emptysigset;
 346       act.sa_flags = 0;
 347       sigaction(SIGSEGV, &act, NULL);
 348
 349       close_network_connections();
 350       sleep(5);
 351       remove_pid(pidfilename);
 352       execvp(g_argv[0], g_argv);
 353     }
 354   else
 355     {
 356       syslog(LOG_NOTICE, _("Not restarting."));
 357       exit(1);
 358     }
 359 }
 360
 361 RETSIGTYPE
 362 sighup_handler(int a)
 363 {
 364   if(debug_lvl > DEBUG_NOTHING)
 365     syslog(LOG_NOTICE, _("Got HUP signal"));
 366   sighup = 1;
 367 }
 368
 369 RETSIGTYPE
 370 sigint_handler(int a)
 371 {
 372   if(saved_debug_lvl)
 373     {
 374       syslog(LOG_NOTICE, _("Reverting to old debug level (%d)"),
 375              saved_debug_lvl);
 376       debug_lvl = saved_debug_lvl;
 377       saved_debug_lvl = 0;
 378     }
 379   else
 380     {
 381       syslog(LOG_NOTICE, _("Temporarily setting debug level to 5.  Kill me with SIGINT again to go back to level %d."),
 382              debug_lvl);
 383       saved_debug_lvl = debug_lvl;
 384       debug_lvl = 5;
 385     }
 386 }
 387
 388 RETSIGTYPE
 389 sigalrm_handler(int a)
 390 {
 391   if(debug_lvl > DEBUG_NOTHING)
 392     syslog(LOG_NOTICE, _("Got ALRM signal"));
 393   sigalrm = 1;
 394 }
 395
 396 RETSIGTYPE
 397 sigusr1_handler(int a)
 398 {
 399   dump_connections();
 400 }
 401
 402 RETSIGTYPE
 403 sigusr2_handler(int a)
 404 {
 405   dump_device_stats();
 406   dump_nodes();
 407   dump_edges();
 408   dump_subnets();
 409 }
 410
 411 RETSIGTYPE
 412 sigwinch_handler(int a)
 413 {
 414   extern int do_purge;
 415   do_purge = 1;
 416 }
 417
 418 RETSIGTYPE
 419 unexpected_signal_handler(int a)
 420 {
 421   syslog(LOG_WARNING, _("Got unexpected signal %d (%s)"), a, strsignal(a));
 422   cp_trace();
 423 }
 424
 425 RETSIGTYPE
 426 ignore_signal_handler(int a)
 427 {
 428   if(debug_lvl >= DEBUG_SCARY_THINGS)
 429   {
 430     syslog(LOG_DEBUG, _("Ignored signal %d (%s)"), a, strsignal(a));
 431     cp_trace();
 432   }
 433 }
 434
 435 struct {
 436   int signal;
 437   void (*handler)(int);
 438 } sighandlers[] = {
 439   { SIGHUP, sighup_handler },
 440   { SIGTERM, sigterm_handler },
 441   { SIGQUIT, sigquit_handler },
 442   { SIGSEGV, sigsegv_handler },
 443   { SIGPIPE, ignore_signal_handler },
 444   { SIGINT, sigint_handler },
 445   { SIGUSR1, sigusr1_handler },
 446   { SIGUSR2, sigusr2_handler },
 447   { SIGCHLD, ignore_signal_handler },
 448   { SIGALRM, sigalrm_handler },
 449   { SIGWINCH, sigwinch_handler },
 450   { 0, NULL }
 451 };
 452
 453 void
 454 setup_signals(void)
 455 {
 456   int i;
 457   struct sigaction act;
 458
 459   sigemptyset(&emptysigset);
 460   act.sa_handler = NULL;
 461   act.sa_mask = emptysigset;
 462   act.sa_flags = 0;
 463
 464   /* Set a default signal handler for every signal, errors will be
 465      ignored. */
 466   for(i = 0; i < NSIG; i++)
 467     {
 468       if(!do_detach)
 469         act.sa_handler = SIG_DFL;
 470       else
 471         act.sa_handler = unexpected_signal_handler;
 472       sigaction(i, &act, NULL);
 473     }
 474
 475   /* If we didn't detach, allow coredumps */
 476   if(!do_detach)
 477     sighandlers[3].handler = SIG_DFL;
 478
 479   /* Then, for each known signal that we want to catch, assign a
 480      handler to the signal, with error checking this time. */
 481   for(i = 0; sighandlers[i].signal; i++)
 482     {
 483       act.sa_handler = sighandlers[i].handler;
 484       if(sigaction(sighandlers[i].signal, &act, NULL) < 0)
 485         fprintf(stderr, _("Installing signal handler for signal %d (%s) failed: %s\n"),
 486                 sighandlers[i].signal, strsignal(sighandlers[i].signal), strerror(errno));
 487     }
 488 }