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