src/process.c

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