empserver

Wolfpack Empire - mirror of https://git.pond.sub.org/empserver http://wolfpackempire.com/

Find a file

Markus Armbruster fb9595fe6a Fix unwanted player thread blocking on output during shutdown shutdwn() disables blocking on I/O for all player threads in state PS_PLAYING, by setting struct player member may_sleep to PLAYER_SLEEP_NEVER. This ensures the player threads complete logout quickly and reliably. A thread may still block on I/O in io_close() called from player_delete(), since commit `904822e3`, but that's okay, because it happens after all game state updates. Bug: if shutdwn() aborts a command, the player thread returns through dispatch(), which resets may_sleep back to PLAYER_SLEEP_FREELY. Input can't block regardless, because the EOF indicator is set, but output can. When it happens, the player thread may not complete logout before shutdwn() terminates the process. This can make us lose a treasury update (similar to the bug fixed by commit `bdc1c40f`; the relevant bug description is in commit note `6f8ca87f`), play time update, and log entries. How? There are two paths from dispatch() to player_delete(). Here's the first one: 1. command() Doesn't print since dispatch() returns 0 when it resets may_sleep 2. player_main() Loop and call status() 3. status() If the command set dolcost to a non-trivial amount, print it Charge dolcost If player went broke or became solvent, notify him Charge time used Return 0, because shutdwn() set the EOF indicator 4. player_main() Break the loop Charge time used print Bye-bye journal.log the logout 5. play_cmd() server.log the logout 6. player_login() Loop Try to flush output get EOF, break loop print so long call player_delete() Ways the bug can bite: A. When we block in 4. print Bye-bye, we can fail to log. B. When we block in 3. print broke/solvent notification, we can additionally fail to charge time used. C. When we block in 3. print dolcost, we can additionally fail to charge dolcost. Note: B. and C. couldn't happen before commit `bdc1c40f`. Instead, something just like C happened always, whether player thread blocked or not. The second path: 1. execute() Loop and call status() 2. status() As above 3. execute() break the loop 4. dispatch() Continue with the first path No additional ways to bite. Fix by avoiding the may_sleep reset when the player thread is on its way to terminate: may not sleep and has its EOF indicator set. Broken in commit `0a4d77e9`, v4.3.23.		2012-04-26 19:57:14 +02:00
doc	Clarify what happens when the player aborts commands	2012-02-21 18:11:13 +01:00
include	Add deadline support to io_output(), io_output_if_queue_long()	2012-04-26 19:43:22 +02:00
info	Clean up info sect on highlighting	2012-02-21 18:12:23 +01:00
m4	Rename m4/my_termlib.m4 to m4/my_terminfo.m4	2009-04-25 13:57:45 +02:00
man	Fix empire(6) synopsis for argument of -s	2011-12-29 11:47:04 +01:00
scripts	Make scripts/savecore create the core directory	2011-12-29 11:47:04 +01:00
src	Fix unwanted player thread blocking on output during shutdown	2012-04-26 19:57:14 +02:00
.gitignore	Fix unintentionally broad patterns in .gitignore	2008-02-07 08:01:53 +01:00
bootstrap	Replace other occurences of git-FOO by git FOO	2008-12-03 07:57:14 -05:00
compile	Replace the build process. The new one requires GNU Make, Autoconf	2005-12-20 20:25:35 +00:00
config.guess	Replace the build process. The new one requires GNU Make, Autoconf	2005-12-20 20:25:35 +00:00
config.sub	Replace the build process. The new one requires GNU Make, Autoconf	2005-12-20 20:25:35 +00:00
configure.ac	Put home page URL into configure --help	2012-02-20 07:34:34 +01:00
COPYING	License upgrade to GPL version 3 or later	2011-04-12 21:20:58 +02:00
CREDITS	Fix trailing whitespace	2008-09-17 21:31:40 -04:00
depcomp	Replace the build process. The new one requires GNU Make, Autoconf	2005-12-20 20:25:35 +00:00
GNUmakefile.in	License upgrade to GPL version 3 or later	2011-04-12 21:20:58 +02:00
INSTALL	Replace the build process. The new one requires GNU Make, Autoconf	2005-12-20 20:25:35 +00:00
install-sh	Replace the build process. The new one requires GNU Make, Autoconf	2005-12-20 20:25:35 +00:00
Make.mk	Update known contributors comments	2011-04-14 20:21:23 +02:00
README	License upgrade to GPL version 3 or later	2011-04-12 21:20:58 +02:00

README

Welcome to Empire 4, code-named Wolfpack.

Empire is a multi-player, client/server Internet based war game.
Copyright (C) 1986-2011, Dave Pare, Jeff Bailey, Thomas Ruschak,
Ken Stevens, Steve McClure, Markus Armbruster

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License (in file
`COPYING'), or (at your option) any later version.

See file `CREDITS' for a list of contributors.

Directory `doc' has additional information.  File `doc/README'
describes the files there and what they talk about.

To build the server and set up a game, follow the steps below.

(1) Unpacking the source tree

    If you downloaded a tarball, unpack it.

    If you cloned a git repository, run bootstrap.  This requires
    recent versions of Autoconf and Automake to be installed.

(2) Building a server

    Prerequisites: IEEE Std 1003.1-2001 (POSIX.1-2001), GNU make, a
    curses library, Perl, and either nroff or GNU troff (`groff').

    See file `INSTALL' for detailed compilation and installation
    instructions.  Quick guide for the impatient: run configure; make;
    make install.  The last step is optional; everything runs fine
    right from the build tree.

    If make fails without doing anything, you're probably not using
    GNU make.  Some systems have it installed as `gmake'.

    Solaris supports POSIX.1-2001, but you need to set up your
    environment for that.  Try passing
        SHELL=/usr/xpg4/bin/sh PATH=/usr/xpg6/bin:/usr/xpg4/bin:$PATH
    to make.  See standards(5) for details.

(3) Creating a game

    * Create a configuration for your game.  make install installs one
      in $prefix/etc/empire/econfig ($prefix is /usr/local unless you
      chose something else with configure).  You can use pconfig to
      create another one.

    * Edit your configuration file.  See doc/econfig for more
      information.

      Unless you put your configuration file in the default location
      (where make install installs it), you have to use -e with all
      programs to make them use your configuration.

    * Run files to set up your data directory.

    * Run fairland to create a world.  For a sample world, try
      `fairland 10 30'.  This creates file ./newcap_script, which will
      be used below.  You can edit it to change country names and
      passwords.

      Check out fairland's manual page for more information.

    * Start the server.  For development, you want to run it with -d
      in a debugger, see doc/debugging.  Do not use -d for a real
      game!

    * Log in as deity POGO with password peter.  This guide assumes
      you use the included client `empire', but other clients should
      work as well.

      For help, try `info'.

      To change the deity password, use `change re <password>'.

    * Create countries with `exec newcap_script'.

    Your game is now up!

Naturally, there's more to running a real game than that, but that's
beyond the scope of this file.

Please report bugs to <wolfpack@wolfpackempire.com> or via SourceForge
http://sourceforge.net/projects/empserver (registration required).

For more information or help, try rec.games.empire on Usenet, or send
e-mail to <wolfpack@wolfpackempire.com> and we'll try to answer if we
can.  Also check out our web site at "http://www.wolfpackempire.com".

Have fun!

Wolfpack!