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.63 2003/08/03 21:45:13 guus Exp $
  21 */
  22
  23 #include "system.h"
  24
  25 #include "conf.h"
  26 #include "connection.h"
  27 #include "device.h"
  28 #include "edge.h"
  29 #include "logger.h"
  30 #include "node.h"
  31 #include "pidfile.h"
  32 #include "process.h"
  33 #include "subnet.h"
  34 #include "utils.h"
  35 #include "xalloc.h"
  36
  37 /* If zero, don't detach from the terminal. */
  38 bool do_detach = true;
  39 bool sighup = false;
  40 bool sigalrm = false;
  41
  42 extern char *identname;
  43 extern char *pidfilename;
  44 extern char **g_argv;
  45 extern bool use_logfile;
  46 extern volatile bool running;
  47
  48 sigset_t emptysigset;
  49
  50 static int saved_debug_level = -1;
  51
  52 static void memory_full(int size)
  53 {
  54         logger(LOG_ERR, _("Memory exhausted (couldn't allocate %d bytes), exitting."), size);
  55         cp_trace();
  56         exit(1);
  57 }
  58
  59 /* Some functions the less gifted operating systems might lack... */
  60
  61 #ifndef HAVE_FCLOSEALL
  62 static int fcloseall(void)
  63 {
  64         fflush(stdin);
  65         fflush(stdout);
  66         fflush(stderr);
  67         fclose(stdin);
  68         fclose(stdout);
  69         fclose(stderr);
  70         return 0;
  71 }
  72 #endif
  73
  74 #ifdef HAVE_MINGW
  75 extern char *identname;
  76 extern char *program_name;
  77 extern char **g_argv;
  78
  79 static SC_HANDLE manager = NULL;
  80 static SC_HANDLE service = NULL;
  81 static SERVICE_STATUS status = {0};
  82 static SERVICE_STATUS_HANDLE statushandle = 0;
  83
  84 bool install_service(void) {
  85         char command[4096] = "";
  86         char **argp;
  87
  88         manager = OpenSCManager(NULL, NULL, SC_MANAGER_ALL_ACCESS);
  89         if(!manager) {
  90                 logger(LOG_ERR, _("Could not open service manager: %s"), winerror(GetLastError()));
  91                 return false;
  92         }
  93
  94         if(!strchr(program_name, '\\')) {
  95                 GetCurrentDirectory(sizeof(command), command);
  96                 strncat(command, "\\", sizeof(command));
  97         }
  98
  99         strncat(command, program_name, sizeof(command));
 100         for(argp = g_argv + 1; *argp; argp++) {
 101                 strncat(command, " ", sizeof(command));
 102                 strncat(command, *argp, sizeof(command));
 103         }
 104
 105         service = CreateService(manager, identname, identname,
 106                         SERVICE_ALL_ACCESS, SERVICE_WIN32_OWN_PROCESS, SERVICE_AUTO_START, SERVICE_ERROR_NORMAL,
 107                         command, "NDIS", NULL, NULL, NULL, NULL);
 108
 109         if(!service) {
 110                 logger(LOG_ERR, _("Could not create %s service: %s"), identname, winerror(GetLastError()));
 111                 return false;
 112         }
 113
 114         logger(LOG_INFO, _("%s service installed"), identname);
 115
 116         if(!StartService(service, 0, NULL))
 117                 logger(LOG_WARNING, _("Could not start %s service: %s"), identname, winerror(GetLastError()));
 118         else
 119                 logger(LOG_INFO, _("%s service started"), identname);
 120
 121         return true;
 122 }
 123
 124 bool remove_service(void) {
 125         manager = OpenSCManager(NULL, NULL, SC_MANAGER_ALL_ACCESS);
 126         if(!manager) {
 127                 logger(LOG_ERR, _("Could not open service manager: %s"), winerror(GetLastError()));
 128                 return false;
 129         }
 130
 131         service = OpenService(manager, identname, SERVICE_ALL_ACCESS);
 132
 133         if(!service) {
 134                 logger(LOG_ERR, _("Could not open %s service: %s"), identname, winerror(GetLastError()));
 135                 return false;
 136         }
 137
 138         if(!ControlService(service, SERVICE_CONTROL_STOP, &status))
 139                 logger(LOG_ERR, _("Could not stop %s service: %s"), identname, winerror(GetLastError()));
 140         else
 141                 logger(LOG_INFO, _("%s service stopped"), identname);
 142
 143         if(!DeleteService(service)) {
 144                 logger(LOG_ERR, _("Could not remove %s service: %s"), identname, winerror(GetLastError()));
 145                 return false;
 146         }
 147
 148         logger(LOG_INFO, _("%s service removed"), identname);
 149
 150         return true;
 151 }
 152
 153 DWORD WINAPI controlhandler(DWORD request, DWORD type, LPVOID boe, LPVOID bah) {
 154         switch(request) {
 155                 case SERVICE_CONTROL_STOP:
 156                         logger(LOG_NOTICE, _("Got %s request"), "SERVICE_CONTROL_STOP");
 157                         running = false;
 158                         break;
 159                 case SERVICE_CONTROL_SHUTDOWN:
 160                         logger(LOG_NOTICE, _("Got %s request"), "SERVICE_CONTROL_SHUTDOWN");
 161                         running = false;
 162                         break;
 163                 default:
 164                         logger(LOG_WARNING, _("Got unexpected request %d"), request);
 165                         return ERROR_CALL_NOT_IMPLEMENTED;
 166         }
 167
 168         if(!running) {
 169                 status.dwCurrentState = SERVICE_STOP_PENDING;
 170                 SetServiceStatus(statushandle, &status);
 171         }
 172
 173         return NO_ERROR;
 174 }
 175
 176 VOID WINAPI run_service(DWORD argc, LPTSTR* argv)
 177 {
 178         int err = 1;
 179         extern int main2(int argc, char **argv);
 180
 181
 182         status.dwServiceType = SERVICE_WIN32;
 183         status.dwControlsAccepted = SERVICE_ACCEPT_STOP | SERVICE_ACCEPT_SHUTDOWN;
 184         status.dwWin32ExitCode = 0;
 185         status.dwServiceSpecificExitCode = 0;
 186         status.dwCheckPoint = 0;
 187         status.dwWaitHint = 0;
 188
 189         statushandle = RegisterServiceCtrlHandlerEx(identname, controlhandler, NULL);
 190
 191         if (!statushandle) {
 192                 logger(LOG_ERR, _("System call `%s' failed: %s"), "RegisterServiceCtrlHandlerEx", winerror(GetLastError()));
 193                 err = 1;
 194         } else {
 195                 status.dwCurrentState = SERVICE_START_PENDING;
 196                 SetServiceStatus(statushandle, &status);
 197
 198                 status.dwCurrentState = SERVICE_RUNNING;
 199                 SetServiceStatus(statushandle, &status);
 200
 201                 err = main2(argc, argv);
 202
 203                 status.dwCurrentState = SERVICE_STOPPED;
 204                 //status.dwWin32ExitCode = err;
 205                 SetServiceStatus(statushandle, &status);
 206         }
 207
 208         return;
 209 }
 210
 211 bool init_service(void) {
 212         SERVICE_TABLE_ENTRY services[] = {
 213                 {identname, run_service},
 214                 {NULL, NULL}
 215         };
 216
 217         if(!StartServiceCtrlDispatcher(services)) {
 218                 if(GetLastError() == ERROR_FAILED_SERVICE_CONTROLLER_CONNECT) {
 219                         return false;
 220                 }
 221                 else
 222                         logger(LOG_ERR, _("System call `%s' failed: %s"), "StartServiceCtrlDispatcher", winerror(GetLastError()));
 223         }
 224
 225         return true;
 226 }
 227 #endif
 228
 229 #ifndef HAVE_MINGW
 230 /*
 231   check for an existing tinc for this net, and write pid to pidfile
 232 */
 233 static bool write_pidfile(void)
 234 {
 235         int pid;
 236
 237         cp();
 238
 239         pid = check_pid(pidfilename);
 240
 241         if(pid) {
 242                 if(netname)
 243                         fprintf(stderr, _("A tincd is already running for net `%s' with pid %d.\n"),
 244                                         netname, pid);
 245                 else
 246                         fprintf(stderr, _("A tincd is already running with pid %d.\n"), pid);
 247                 return false;
 248         }
 249
 250         /* if it's locked, write-protected, or whatever */
 251         if(!write_pid(pidfilename))
 252                 return false;
 253
 254         return true;
 255 }
 256 #endif
 257
 258 /*
 259   kill older tincd for this net
 260 */
 261 bool kill_other(int signal)
 262 {
 263 #ifndef HAVE_MINGW
 264         int pid;
 265
 266         cp();
 267
 268         pid = read_pid(pidfilename);
 269
 270         if(!pid) {
 271                 if(netname)
 272                         fprintf(stderr, _("No other tincd is running for net `%s'.\n"),
 273                                         netname);
 274                 else
 275                         fprintf(stderr, _("No other tincd is running.\n"));
 276                 return false;
 277         }
 278
 279         errno = 0;                                      /* No error, sometimes errno is only changed on error */
 280
 281         /* ESRCH is returned when no process with that pid is found */
 282         if(kill(pid, signal) && errno == ESRCH) {
 283                 if(netname)
 284                         fprintf(stderr, _("The tincd for net `%s' is no longer running. "),
 285                                         netname);
 286                 else
 287                         fprintf(stderr, _("The tincd is no longer running. "));
 288
 289                 fprintf(stderr, _("Removing stale lock file.\n"));
 290                 remove_pid(pidfilename);
 291         }
 292
 293         return true;
 294 #else
 295         return remove_service();
 296 #endif
 297 }
 298
 299 /*
 300   Detach from current terminal, write pidfile, kill parent
 301 */
 302 bool detach(void)
 303 {
 304         cp();
 305
 306         setup_signals();
 307
 308         /* First check if we can open a fresh new pidfile */
 309
 310 #ifndef HAVE_MINGW
 311         if(!write_pidfile())
 312                 return false;
 313
 314         /* If we succeeded in doing that, detach */
 315
 316         closelogger();
 317 #endif
 318
 319         if(do_detach) {
 320 #ifndef HAVE_MINGW
 321                 if(daemon(0, 0)) {
 322                         fprintf(stderr, _("Couldn't detach from terminal: %s"),
 323                                         strerror(errno));
 324                         return false;
 325                 }
 326
 327                 /* Now UPDATE the pid in the pidfile, because we changed it... */
 328
 329                 if(!write_pid(pidfilename))
 330                         return false;
 331 #else
 332                 if(!statushandle)
 333                         exit(install_service());
 334 #endif
 335         }
 336
 337         openlogger(identname, use_logfile?LOGMODE_FILE:(do_detach?LOGMODE_SYSLOG:LOGMODE_STDERR));
 338
 339         logger(LOG_NOTICE, _("tincd %s (%s %s) starting, debug level %d"),
 340                            VERSION, __DATE__, __TIME__, debug_level);
 341
 342         xalloc_fail_func = memory_full;
 343
 344         return true;
 345 }
 346
 347 #ifdef HAVE_FORK
 348 /*
 349   Execute the program name, with sane environment.
 350 */
 351 static void _execute_script(const char *scriptname, char **envp)
 352         __attribute__ ((__noreturn__));
 353 static void _execute_script(const char *scriptname, char **envp)
 354 {
 355         int save_errno;
 356
 357         cp();
 358
 359         while(*envp)
 360                 putenv(*envp++);
 361
 362         chdir("/");
 363
 364         closelogger();
 365
 366         /* Close all file descriptors */
 367         fcloseall();
 368
 369         execl(scriptname, scriptname, NULL);
 370         /* No return on success */
 371
 372         save_errno = errno;
 373
 374         openlogger(identname, use_logfile?LOGMODE_FILE:(do_detach?LOGMODE_SYSLOG:LOGMODE_STDERR));
 375         logger(LOG_ERR, _("Could not execute `%s': %s"), scriptname,
 376                    strerror(save_errno));
 377         exit(save_errno);
 378 }
 379 #endif
 380
 381 /*
 382   Fork and execute the program pointed to by name.
 383 */
 384 bool execute_script(const char *name, char **envp)
 385 {
 386 #ifdef HAVE_FORK
 387         pid_t pid;
 388         int status;
 389         struct stat s;
 390         char *scriptname;
 391
 392         cp();
 393
 394         asprintf(&scriptname, "%s/%s", confbase, name);
 395
 396         /* First check if there is a script */
 397
 398         if(stat(scriptname, &s))
 399                 return true;
 400
 401         pid = fork();
 402
 403         if(pid < 0) {
 404                 logger(LOG_ERR, _("System call `%s' failed: %s"), "fork",
 405                            strerror(errno));
 406                 return false;
 407         }
 408
 409         if(pid) {
 410                 ifdebug(STATUS) logger(LOG_INFO, _("Executing script %s"), name);
 411
 412                 free(scriptname);
 413
 414                 if(waitpid(pid, &status, 0) == pid) {
 415                         if(WIFEXITED(status)) { /* Child exited by itself */
 416                                 if(WEXITSTATUS(status)) {
 417                                         logger(LOG_ERR, _("Process %d (%s) exited with non-zero status %d"),
 418                                                    pid, name, WEXITSTATUS(status));
 419                                         return false;
 420                                 } else
 421                                         return true;
 422                         } else if(WIFSIGNALED(status)) {        /* Child was killed by a signal */
 423                                 logger(LOG_ERR, _("Process %d (%s) was killed by signal %d (%s)"), pid,
 424                                            name, WTERMSIG(status), strsignal(WTERMSIG(status)));
 425                                 return false;
 426                         } else {                        /* Something strange happened */
 427                                 logger(LOG_ERR, _("Process %d (%s) terminated abnormally"), pid,
 428                                            name);
 429                                 return false;
 430                         }
 431                 } else if (errno != EINTR) {
 432                         logger(LOG_ERR, _("System call `%s' failed: %s"), "waitpid",
 433                                    strerror(errno));
 434                         return false;
 435                 }
 436
 437                 /* Why do we get EINTR? */
 438                 return true;
 439         }
 440
 441         /* Child here */
 442
 443         _execute_script(scriptname, envp);
 444 #else
 445         return true;
 446 #endif
 447 }
 448
 449
 450 /*
 451   Signal handlers.
 452 */
 453
 454 #ifndef HAVE_MINGW
 455 static RETSIGTYPE sigterm_handler(int a)
 456 {
 457         logger(LOG_NOTICE, _("Got %s signal"), "TERM");
 458         running = false;
 459 }
 460
 461 static RETSIGTYPE sigquit_handler(int a)
 462 {
 463         logger(LOG_NOTICE, _("Got %s signal"), "QUIT");
 464         running = false;
 465 }
 466
 467 static RETSIGTYPE fatal_signal_square(int a)
 468 {
 469         logger(LOG_ERR, _("Got another fatal signal %d (%s): not restarting."), a,
 470                    strsignal(a));
 471         cp_trace();
 472         exit(1);
 473 }
 474
 475 static RETSIGTYPE fatal_signal_handler(int a)
 476 {
 477         struct sigaction act;
 478         logger(LOG_ERR, _("Got fatal signal %d (%s)"), a, strsignal(a));
 479         cp_trace();
 480
 481         if(do_detach) {
 482                 logger(LOG_NOTICE, _("Trying to re-execute in 5 seconds..."));
 483
 484                 act.sa_handler = fatal_signal_square;
 485                 act.sa_mask = emptysigset;
 486                 act.sa_flags = 0;
 487                 sigaction(SIGSEGV, &act, NULL);
 488
 489                 close_network_connections();
 490                 sleep(5);
 491                 remove_pid(pidfilename);
 492                 execvp(g_argv[0], g_argv);
 493         } else {
 494                 logger(LOG_NOTICE, _("Not restarting."));
 495                 exit(1);
 496         }
 497 }
 498
 499 static RETSIGTYPE sighup_handler(int a)
 500 {
 501         logger(LOG_NOTICE, _("Got %s signal"), "HUP");
 502         sighup = true;
 503 }
 504
 505 static RETSIGTYPE sigint_handler(int a)
 506 {
 507         logger(LOG_NOTICE, _("Got %s signal"), "INT");
 508
 509         if(saved_debug_level != -1) {
 510                 logger(LOG_NOTICE, _("Reverting to old debug level (%d)"),
 511                         saved_debug_level);
 512                 debug_level = saved_debug_level;
 513                 saved_debug_level = -1;
 514         } else {
 515                 logger(LOG_NOTICE,
 516                         _("Temporarily setting debug level to 5.  Kill me with SIGINT again to go back to level %d."),
 517                         debug_level);
 518                 saved_debug_level = debug_level;
 519                 debug_level = 5;
 520         }
 521 }
 522
 523 static RETSIGTYPE sigalrm_handler(int a)
 524 {
 525         logger(LOG_NOTICE, _("Got %s signal"), "ALRM");
 526         sigalrm = true;
 527 }
 528
 529 static RETSIGTYPE sigusr1_handler(int a)
 530 {
 531         dump_connections();
 532 }
 533
 534 static RETSIGTYPE sigusr2_handler(int a)
 535 {
 536         dump_device_stats();
 537         dump_nodes();
 538         dump_edges();
 539         dump_subnets();
 540 }
 541
 542 static RETSIGTYPE sigwinch_handler(int a)
 543 {
 544         do_purge = true;
 545 }
 546
 547 static RETSIGTYPE unexpected_signal_handler(int a)
 548 {
 549         logger(LOG_WARNING, _("Got unexpected signal %d (%s)"), a, strsignal(a));
 550         cp_trace();
 551 }
 552
 553 static RETSIGTYPE ignore_signal_handler(int a)
 554 {
 555         ifdebug(SCARY_THINGS) logger(LOG_DEBUG, _("Ignored signal %d (%s)"), a, strsignal(a));
 556 }
 557
 558 static struct {
 559         int signal;
 560         void (*handler)(int);
 561 } sighandlers[] = {
 562         {SIGHUP, sighup_handler},
 563         {SIGTERM, sigterm_handler},
 564         {SIGQUIT, sigquit_handler},
 565         {SIGSEGV, fatal_signal_handler},
 566         {SIGBUS, fatal_signal_handler},
 567         {SIGILL, fatal_signal_handler},
 568         {SIGPIPE, ignore_signal_handler},
 569         {SIGINT, sigint_handler},
 570         {SIGUSR1, sigusr1_handler},
 571         {SIGUSR2, sigusr2_handler},
 572         {SIGCHLD, ignore_signal_handler},
 573         {SIGALRM, sigalrm_handler},
 574         {SIGWINCH, sigwinch_handler},
 575         {0, NULL}
 576 };
 577 #endif
 578
 579 void setup_signals(void)
 580 {
 581 #ifndef HAVE_MINGW
 582         int i;
 583         struct sigaction act;
 584
 585         sigemptyset(&emptysigset);
 586         act.sa_handler = NULL;
 587         act.sa_mask = emptysigset;
 588         act.sa_flags = 0;
 589
 590         /* Set a default signal handler for every signal, errors will be
 591            ignored. */
 592         for(i = 0; i < NSIG; i++) {
 593                 if(!do_detach)
 594                         act.sa_handler = SIG_DFL;
 595                 else
 596                         act.sa_handler = unexpected_signal_handler;
 597                 sigaction(i, &act, NULL);
 598         }
 599
 600         /* If we didn't detach, allow coredumps */
 601         if(!do_detach)
 602                 sighandlers[3].handler = SIG_DFL;
 603
 604         /* Then, for each known signal that we want to catch, assign a
 605            handler to the signal, with error checking this time. */
 606         for(i = 0; sighandlers[i].signal; i++) {
 607                 act.sa_handler = sighandlers[i].handler;
 608                 if(sigaction(sighandlers[i].signal, &act, NULL) < 0)
 609                         fprintf(stderr, _("Installing signal handler for signal %d (%s) failed: %s\n"),
 610                                         sighandlers[i].signal, strsignal(sighandlers[i].signal),
 611                                         strerror(errno));
 612         }
 613 #endif
 614 }