www.tinc-vpn.org Git - tinc/blob - src/process.c

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