www.tinc-vpn.org Git - tinc/blob - 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.3 2002/04/13 10:25:38 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/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   log_add_hook(log_syslog);
 195   log_del_hook(log_default);
 196
 197   if(debug_lvl > DEBUG_NOTHING)
 198     syslog(LOG_NOTICE, _("tincd %s (%s %s) starting, debug level %d"),
 199            VERSION, __DATE__, __TIME__, debug_lvl);
 200   else
 201     syslog(LOG_NOTICE, _("tincd %s starting"), VERSION);
 202
 203   xalloc_fail_func = memory_full;
 204 cp
 205   return 0;
 206 }
 207
 208 /*
 209   Execute the program name, with sane environment.  All output will be
 210   redirected to syslog.
 211 */
 212 void _execute_script(const char *scriptname)  __attribute__ ((noreturn));
 213 void _execute_script(const char *scriptname)
 214 {
 215   char *s;
 216 cp
 217 #ifdef HAVE_UNSETENV
 218   unsetenv("NETNAME");
 219   unsetenv("DEVICE");
 220   unsetenv("INTERFACE");
 221 #endif
 222
 223   if(netname)
 224     {
 225       asprintf(&s, "NETNAME=%s", netname);
 226       putenv(s);        /* Don't free s! see man 3 putenv */
 227     }
 228
 229   if(device)
 230     {
 231       asprintf(&s, "DEVICE=%s", device);
 232       putenv(s);        /* Don't free s! see man 3 putenv */
 233     }
 234
 235   if(interface)
 236     {
 237       asprintf(&s, "INTERFACE=%s", interface);
 238       putenv(s);        /* Don't free s! see man 3 putenv */
 239     }
 240
 241   chdir("/");
 242
 243   /* Close all file descriptors */
 244   closelog();           /* <- this means we cannot use syslog() here anymore! */
 245   fcloseall();
 246
 247   execl(scriptname, NULL);
 248   /* No return on success */
 249
 250   if(errno != ENOENT)   /* Ignore if the file does not exist */
 251     exit(1);            /* Some error while trying execl(). */
 252   else
 253     exit(0);
 254 }
 255
 256 /*
 257   Fork and execute the program pointed to by name.
 258 */
 259 int execute_script(const char *name)
 260 {
 261   pid_t pid;
 262   int status;
 263   struct stat s;
 264   char *scriptname;
 265 cp
 266   asprintf(&scriptname, "%s/%s", confbase, name);
 267
 268   /* First check if there is a script */
 269
 270   if(stat(scriptname, &s))
 271     return 0;
 272
 273   if((pid = fork()) < 0)
 274     {
 275       syslog(LOG_ERR, _("System call `%s' failed: %s"), "fork", strerror(errno));
 276       return -1;
 277     }
 278
 279   if(pid)
 280     {
 281       if(debug_lvl >= DEBUG_STATUS)
 282         syslog(LOG_INFO, _("Executing script %s"), name);
 283
 284       free(scriptname);
 285
 286       if(waitpid(pid, &status, 0) == pid)
 287         {
 288           if(WIFEXITED(status))         /* Child exited by itself */
 289             {
 290               if(WEXITSTATUS(status))
 291                 {
 292                   syslog(LOG_ERR, _("Process %d (%s) exited with non-zero status %d"), pid, name, WEXITSTATUS(status));
 293                   return -1;
 294                 }
 295               else
 296                 return 0;
 297             }
 298           else if(WIFSIGNALED(status))  /* Child was killed by a signal */
 299             {
 300               syslog(LOG_ERR, _("Process %d (%s) was killed by signal %d (%s)"),
 301                      pid, name, WTERMSIG(status), strsignal(WTERMSIG(status)));
 302               return -1;
 303             }
 304           else                          /* Something strange happened */
 305             {
 306               syslog(LOG_ERR, _("Process %d (%s) terminated abnormally"), pid, name);
 307               return -1;
 308             }
 309         }
 310       else
 311         {
 312           syslog(LOG_ERR, _("System call `%s' failed: %s"), "waitpid", strerror(errno));
 313           return -1;
 314         }
 315     }
 316 cp
 317   /* Child here */
 318
 319   _execute_script(scriptname);
 320 }
 321
 322
 323 /*
 324   Signal handlers.
 325 */
 326
 327 RETSIGTYPE
 328 sigterm_handler(int a)
 329 {
 330   if(debug_lvl > DEBUG_NOTHING)
 331     syslog(LOG_NOTICE, _("Got TERM signal"));
 332
 333   cleanup_and_exit(0);
 334 }
 335
 336 RETSIGTYPE
 337 sigquit_handler(int a)
 338 {
 339   if(debug_lvl > DEBUG_NOTHING)
 340     syslog(LOG_NOTICE, _("Got QUIT signal"));
 341   cleanup_and_exit(0);
 342 }
 343
 344 RETSIGTYPE
 345 fatal_signal_square(int a)
 346 {
 347   syslog(LOG_ERR, _("Got another fatal signal %d (%s): not restarting."), a, strsignal(a));
 348   cp_trace();
 349   exit(1);
 350 }
 351
 352 RETSIGTYPE
 353 fatal_signal_handler(int a)
 354 {
 355   struct sigaction act;
 356   syslog(LOG_ERR, _("Got fatal signal %d (%s)"), a, strsignal(a));
 357   cp_trace();
 358
 359   if(do_detach)
 360     {
 361       syslog(LOG_NOTICE, _("Trying to re-execute in 5 seconds..."));
 362
 363       act.sa_handler = fatal_signal_square;
 364       act.sa_mask = emptysigset;
 365       act.sa_flags = 0;
 366       sigaction(SIGSEGV, &act, NULL);
 367
 368       close_network_connections();
 369       sleep(5);
 370       remove_pid(pidfilename);
 371       execvp(g_argv[0], g_argv);
 372     }
 373   else
 374     {
 375       syslog(LOG_NOTICE, _("Not restarting."));
 376       exit(1);
 377     }
 378 }
 379
 380 RETSIGTYPE
 381 sighup_handler(int a)
 382 {
 383   if(debug_lvl > DEBUG_NOTHING)
 384     syslog(LOG_NOTICE, _("Got HUP signal"));
 385   sighup = 1;
 386 }
 387
 388 RETSIGTYPE
 389 sigint_handler(int a)
 390 {
 391   if(saved_debug_lvl)
 392     {
 393       syslog(LOG_NOTICE, _("Reverting to old debug level (%d)"),
 394              saved_debug_lvl);
 395       debug_lvl = saved_debug_lvl;
 396       saved_debug_lvl = 0;
 397     }
 398   else
 399     {
 400       syslog(LOG_NOTICE, _("Temporarily setting debug level to 5.  Kill me with SIGINT again to go back to level %d."),
 401              debug_lvl);
 402       saved_debug_lvl = debug_lvl;
 403       debug_lvl = 5;
 404     }
 405 }
 406
 407 RETSIGTYPE
 408 sigalrm_handler(int a)
 409 {
 410   if(debug_lvl > DEBUG_NOTHING)
 411     syslog(LOG_NOTICE, _("Got ALRM signal"));
 412   sigalrm = 1;
 413 }
 414
 415 RETSIGTYPE
 416 sigusr1_handler(int a)
 417 {
 418   dump_connections();
 419 }
 420
 421 RETSIGTYPE
 422 sigusr2_handler(int a)
 423 {
 424   dump_device_stats();
 425   dump_nodes();
 426   dump_edges();
 427   dump_subnets();
 428 }
 429
 430 RETSIGTYPE
 431 sigwinch_handler(int a)
 432 {
 433   extern int do_purge;
 434   do_purge = 1;
 435 }
 436
 437 RETSIGTYPE
 438 unexpected_signal_handler(int a)
 439 {
 440   syslog(LOG_WARNING, _("Got unexpected signal %d (%s)"), a, strsignal(a));
 441   cp_trace();
 442 }
 443
 444 RETSIGTYPE
 445 ignore_signal_handler(int a)
 446 {
 447   if(debug_lvl >= DEBUG_SCARY_THINGS)
 448   {
 449     syslog(LOG_DEBUG, _("Ignored signal %d (%s)"), a, strsignal(a));
 450     cp_trace();
 451   }
 452 }
 453
 454 struct {
 455   int signal;
 456   void (*handler)(int);
 457 } sighandlers[] = {
 458   { SIGHUP, sighup_handler },
 459   { SIGTERM, sigterm_handler },
 460   { SIGQUIT, sigquit_handler },
 461   { SIGSEGV, fatal_signal_handler },
 462   { SIGBUS, fatal_signal_handler },
 463   { SIGILL, fatal_signal_handler },
 464   { SIGPIPE, ignore_signal_handler },
 465   { SIGINT, sigint_handler },
 466   { SIGUSR1, sigusr1_handler },
 467   { SIGUSR2, sigusr2_handler },
 468   { SIGCHLD, ignore_signal_handler },
 469   { SIGALRM, sigalrm_handler },
 470   { SIGWINCH, sigwinch_handler },
 471   { 0, NULL }
 472 };
 473
 474 void
 475 setup_signals(void)
 476 {
 477   int i;
 478   struct sigaction act;
 479
 480   sigemptyset(&emptysigset);
 481   act.sa_handler = NULL;
 482   act.sa_mask = emptysigset;
 483   act.sa_flags = 0;
 484
 485   /* Set a default signal handler for every signal, errors will be
 486      ignored. */
 487   for(i = 0; i < NSIG; i++)
 488     {
 489       if(!do_detach)
 490         act.sa_handler = SIG_DFL;
 491       else
 492         act.sa_handler = unexpected_signal_handler;
 493       sigaction(i, &act, NULL);
 494     }
 495
 496   /* If we didn't detach, allow coredumps */
 497   if(!do_detach)
 498     sighandlers[3].handler = SIG_DFL;
 499
 500   /* Then, for each known signal that we want to catch, assign a
 501      handler to the signal, with error checking this time. */
 502   for(i = 0; sighandlers[i].signal; i++)
 503     {
 504       act.sa_handler = sighandlers[i].handler;
 505       if(sigaction(sighandlers[i].signal, &act, NULL) < 0)
 506         fprintf(stderr, _("Installing signal handler for signal %d (%s) failed: %s\n"),
 507                 sighandlers[i].signal, strsignal(sighandlers[i].signal), strerror(errno));
 508     }
 509 }