git.pond.sub.org Git - empserver/blob - src/server/main.c

   1 /*
   2  *  Empire - A multi-player, client/server Internet based war game.
   3  *  Copyright (C) 1986-2011, Dave Pare, Jeff Bailey, Thomas Ruschak,
   4  *                Ken Stevens, Steve McClure, Markus Armbruster
   5  *
   6  *  Empire 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 3 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, see <http://www.gnu.org/licenses/>.
  18  *
  19  *  ---
  20  *
  21  *  See files README, COPYING and CREDITS in the root of the source
  22  *  tree for related information and legal notices.  It is expected
  23  *  that future projects/authors will amend these files as needed.
  24  *
  25  *  ---
  26  *
  27  *  main.c: Empire Server main, startup and shutdown
  28  *
  29  *  Known contributors to this file:
  30  *     Dave Pare, 1994
  31  *     Steve McClure, 1996, 1998
  32  *     Doug Hay, 1998
  33  *     Ron Koenderink, 2004-2009
  34  *     Markus Armbruster, 2005-2011
  35  */
  36
  37 #include <config.h>
  38
  39 #include <errno.h>
  40 #include <signal.h>
  41 #include <stdio.h>
  42 #ifndef _WIN32
  43 #include <sys/wait.h>
  44 #endif
  45 #include <unistd.h>
  46
  47 #if defined(_WIN32)
  48 #include <process.h>
  49 #include "service.h"
  50 #include "sys/socket.h"
  51 #endif
  52
  53 #include "empio.h"
  54 #include "empthread.h"
  55 #include "file.h"
  56 #include "journal.h"
  57 #include "match.h"
  58 #include "misc.h"
  59 #include "optlist.h"
  60 #include "plane.h"
  61 #include "player.h"
  62 #include "product.h"
  63 #include "prototypes.h"
  64 #include "sect.h"
  65 #include "server.h"
  66 #include "version.h"
  67
  68 static void ignore(void);
  69 static void crash_dump(void);
  70 static void init_server(unsigned, int);
  71 static void create_pidfile(char *, pid_t);
  72
  73 #if defined(_WIN32)
  74 static void loc_NTInit(void);
  75 #endif
  76
  77 /*
  78  * Lock to synchronize player threads with update and shutdown.
  79  * Update and shutdown takes it exclusive, commands take it shared.
  80  */
  81 empth_rwlock_t *play_lock;
  82
  83 static char pidfname[] = "server.pid";
  84
  85 /* Run as daemon?  If yes, detach from controlling terminal etc. */
  86 static int daemonize = 1;
  87
  88 static void
  89 help(char *program_name, char *complaint)
  90 {
  91     if (complaint)
  92         fprintf(stderr, "%s: %s\n", program_name, complaint);
  93     fprintf(stderr, "Try -h for help.\n");
  94 }
  95
  96 static void
  97 print_usage(char *program_name)
  98 {
  99     printf("Usage: %s [OPTION]...\n"
 100            "  -d              debug mode, implies -E abort\n"
 101            "  -e CONFIG-FILE  configuration file\n"
 102            "                  (default %s)\n"
 103            "  -E ACTION       what to do on oops: abort, crash-dump, nothing (default)\n"
 104 #ifdef _WIN32
 105            "  -i              install service `%s'\n"
 106            "  -I NAME         install service NAME\n"
 107 #endif
 108            "  -p              threading debug mode, implies -d\n"
 109 #ifdef _WIN32
 110            "  -u              uninstall service `%s'\n"
 111            "  -U NAME         uninstall service NAME\n"
 112 #endif
 113            "  -s              enable stack checking\n"
 114            "  -R RANDOM-SEED  random seed\n"
 115            "  -h              display this help and exit\n"
 116            "  -v              display version information and exit\n",
 117            program_name, dflt_econfig
 118 #ifdef _WIN32
 119            , DEFAULT_SERVICE_NAME, DEFAULT_SERVICE_NAME
 120 #endif
 121         );
 122 }
 123
 124 int
 125 main(int argc, char **argv)
 126 {
 127     static char *oops_key[] = { "abort", "crash-dump", "nothing", NULL };
 128     static void (*oops_hndlr[])(void) = { abort, crash_dump, ignore };
 129     int flags = 0;
 130 #if defined(_WIN32)
 131     int install_service_set = 0;
 132     char *program_name = NULL;
 133     char *service_name = NULL;
 134     int remove_service_set = 0;
 135 #endif
 136     char *config_file = NULL;
 137     int force_bad_state = 0;
 138     int op, idx, sig;
 139     unsigned seed = time(NULL);
 140
 141     oops_handler = ignore;
 142
 143 #ifdef _WIN32
 144 # define XOPTS "iI:uU:"
 145 #else
 146 # define XOPTS
 147 #endif
 148     while ((op = getopt(argc, argv, "de:E:FhpsR:v" XOPTS)) != EOF) {
 149         switch (op) {
 150         case 'p':
 151             flags |= EMPTH_PRINT;
 152             /* fall through */
 153         case 'd':
 154             oops_handler = abort;
 155             daemonize = 0;
 156             break;
 157         case 'e':
 158             config_file = optarg;
 159             break;
 160         case 'E':
 161             idx = stmtch(optarg, oops_key, 0, sizeof(*oops_key));
 162             if (idx < 0) {
 163                 help(argv[0], "invalid argument for -E");
 164                 return EXIT_FAILURE;
 165             }
 166             oops_handler = oops_hndlr[idx];
 167             break;
 168         case 'F':
 169             force_bad_state = 1;
 170             break;
 171 #if defined(_WIN32)
 172         case 'I':
 173             service_name = optarg;
 174             /* fall through */
 175         case 'i':
 176             install_service_set++;
 177             break;
 178         case 'U':
 179             service_name = optarg;
 180             /* fall through */
 181         case 'u':
 182             remove_service_set++;
 183             break;
 184 #endif  /* _WIN32 */
 185         case 's':
 186             flags |= EMPTH_STACKCHECK;
 187             break;
 188         case 'R':
 189             seed = strtoul(optarg, NULL, 10);
 190             break;
 191         case 'v':
 192             printf("%s\n\n%s", version, legal);
 193             return EXIT_SUCCESS;
 194         case 'h':
 195             print_usage(argv[0]);
 196             return EXIT_SUCCESS;
 197         default:
 198             help(argv[0], NULL);
 199             return EXIT_FAILURE;
 200         }
 201     }
 202
 203     /* silently ignore operands for backward compatibility */
 204
 205 #if defined(_WIN32)
 206     if ((!daemonize || flags || config_file != NULL)
 207         && remove_service_set) {
 208         fprintf(stderr, "Can't use -p, -s, -d or -e with either "
 209             "-u or -U options\n");
 210         exit(EXIT_FAILURE);
 211     }
 212     if ((!daemonize || flags) && install_service_set) {
 213         fprintf(stderr,
 214                 "Can't use -d, -p or -s with either -i or -I options\n");
 215         exit(EXIT_FAILURE);
 216     }
 217     if (install_service_set && remove_service_set) {
 218         fprintf(stderr, "Can't use both -u or -U and -i or -I options\n");
 219         exit(EXIT_FAILURE);
 220     }
 221
 222     if (remove_service_set)
 223         return remove_service(service_name);
 224     if (install_service_set) {
 225         program_name = _fullpath(NULL, argv[0], 0);
 226         if (config_file != NULL)
 227             config_file = _fullpath(NULL, config_file, 0);
 228     }
 229 #endif  /* _WIN32 */
 230
 231     empfile_init();
 232     if (emp_config(config_file) < 0)
 233         exit(EXIT_FAILURE);
 234     empfile_fixup();
 235     if (read_builtin_tables() < 0)
 236         exit(EXIT_FAILURE);
 237     if (read_custom_tables() < 0)
 238         exit(EXIT_FAILURE);
 239     if (chdir(gamedir)) {
 240         fprintf(stderr, "Can't chdir to %s (%s)\n",
 241                 gamedir, strerror(errno));
 242         exit(EXIT_FAILURE);
 243     }
 244
 245 #if defined(_WIN32)
 246     if (install_service_set)
 247         return install_service(program_name, service_name, config_file);
 248 #endif  /* _WIN32 */
 249
 250     init_server(seed, force_bad_state);
 251
 252 #if defined(_WIN32)
 253     if (daemonize != 0) {
 254         SERVICE_TABLE_ENTRY DispatchTable[]={
 255             {"Empire Server", service_main},
 256             {NULL, NULL}
 257         };
 258         if (StartServiceCtrlDispatcher(DispatchTable))
 259             return 0;
 260         else {
 261             /*
 262              * If it is service startup error then exit otherwise
 263              * start server in the foreground
 264              */
 265             if (GetLastError() != ERROR_FAILED_SERVICE_CONTROLLER_CONNECT) {
 266                 logerror("Failed to dispatch service (%lu)",
 267                          GetLastError());
 268                 finish_server();
 269                 exit(EXIT_FAILURE);
 270             }
 271         }
 272     }
 273     daemonize = 0;
 274 #else  /* !_WIN32 */
 275     if (daemonize) {
 276         if (disassoc() < 0) {
 277             logerror("Can't become daemon (%s)", strerror(errno));
 278             exit(1);
 279         }
 280     }
 281 #endif /* !_WIN32 */
 282     start_server(flags);
 283     journal_prng(seed);
 284
 285     for (;;) {
 286         sig = empth_wait_for_signal();
 287 #ifdef SIGHUP
 288         if (sig == SIGHUP) {
 289             /* if you make changes here, also update relo() */
 290             journal_reopen();
 291             update_reschedule();
 292             logreopen();
 293             continue;
 294         }
 295 #endif
 296         break;
 297     }
 298
 299     shutdwn(sig);
 300     CANT_REACH();
 301     finish_server();
 302     return EXIT_SUCCESS;
 303 }
 304
 305 static void
 306 ignore(void)
 307 {
 308 }
 309
 310 static void
 311 crash_dump(void)
 312 {
 313 #ifdef _WIN32
 314     logerror("Crash dump is not implemented");
 315 #else
 316     pid_t pid;
 317     int status;
 318
 319     fflush(NULL);
 320     pid = fork();
 321     if (pid < 0) {
 322         logerror("Can't fork for crash dump (%s)", strerror(errno));
 323         return;
 324     }
 325     if (pid == 0)
 326         raise(SIGABRT);         /* child */
 327
 328     /* parent */
 329     while (waitpid(pid, &status, 0) < 0) {
 330         if (errno != EINTR) {
 331             logerror("Can't get crash dumping child's status (%s)",
 332                      strerror(errno));
 333             return;
 334         }
 335     }
 336     run_hook(post_crash_dump_hook, "post-crash-dump");
 337     logerror("Crash dump complete");
 338 #endif
 339 }
 340
 341 /*
 342  * Initialize for serving, acquire resources.
 343  */
 344 static void
 345 init_server(unsigned seed, int force_bad_state)
 346 {
 347     srandom(seed);
 348 #if defined(_WIN32)
 349     loc_NTInit();
 350 #endif
 351     player_init();
 352     ef_init_srv(force_bad_state);
 353     io_init();
 354     init_nreport();
 355
 356     loginit("server");
 357 }
 358
 359 /*
 360  * Start serving.
 361  */
 362 void
 363 start_server(int flags)
 364 {
 365     pid_t pid;
 366
 367     pid = getpid();
 368     create_pidfile(pidfname, pid);
 369     logerror("------------------------------------------------------");
 370     logerror("Empire server (pid %d) started", (int)pid);
 371
 372     empth_init((void **)&player, flags);
 373
 374     if (journal_startup() < 0)
 375         exit(1);
 376
 377     market_init();
 378     update_init();
 379     empth_create(player_accept, 50 * 1024, flags, "AcceptPlayers", NULL);
 380 }
 381
 382 /*
 383  * Finish serving, release resources.
 384  */
 385 void
 386 finish_server(void)
 387 {
 388     ef_fin_srv();
 389     journal_shutdown();
 390     remove(pidfname);
 391 }
 392
 393 static void
 394 create_pidfile(char *fname, pid_t pid)
 395 {
 396     FILE *pidf = fopen(fname, "w");
 397     if (!pidf
 398         || fprintf(pidf, "%d\n", (int)pid) < 0
 399         || fclose(pidf)) {
 400         logerror("Can't write PID file (%s)", strerror(errno));
 401         exit(1);
 402     }
 403 }
 404
 405 void
 406 shutdwn(int sig)
 407 {
 408     struct player *p;
 409     time_t now = time(NULL);
 410     int i;
 411
 412     logerror("Shutdown commencing (cleaning up threads.)");
 413
 414     for (p = player_next(NULL); p; p = player_next(p)) {
 415         if (p->state != PS_PLAYING)
 416             continue;
 417         pr_flash(p, "Server shutting down...\n");
 418         io_set_eof(p->iop);
 419         p->aborted = 1;
 420         p->may_sleep = PLAYER_SLEEP_NEVER;
 421         if (p->command) {
 422             pr_flash(p, "Shutdown aborting command\n");
 423         }
 424         empth_wakeup(p->proc);
 425     }
 426     empth_rwlock_wrlock(play_lock);
 427
 428     empth_yield();
 429     for (i = 1; i <= 3 && player_next(NULL); i++) {
 430         logerror("Waiting for player threads to terminate\n");
 431         empth_sleep(now + i);
 432     }
 433
 434     for (p = player_next(NULL); p; p = player_next(p))
 435         logerror("Player %d lingers, output might be lost", p->cnum);
 436
 437     if (sig)
 438         logerror("Server shutting down on signal %d", sig);
 439     else
 440         logerror("Server shutting down at deity's request");
 441     finish_server();
 442
 443 #if defined(_WIN32)
 444     if (daemonize)
 445         stop_service();
 446 #endif
 447     exit(0);
 448 }
 449
 450 #if defined(_WIN32)
 451 static void
 452 loc_NTInit(void)
 453 {
 454     int rc;
 455
 456     rc = w32_socket_init();
 457     if (rc != 0) {
 458         logerror("WSAStartup Failed, error code %d\n", rc);
 459         exit(1);
 460     }
 461 }
 462 #endif