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