--- deliantra/server/lib/cf.pm 2007/06/04 12:19:08 1.273
+++ deliantra/server/lib/cf.pm 2009/01/08 19:23:44 1.468
@@ -1,49 +1,79 @@
+#
+# This file is part of Deliantra, the Roguelike Realtime MMORPG.
+#
+# Copyright (©) 2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
+#
+# Deliantra 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, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see .
+#
+# The authors can be reached via e-mail to
+#
+
package cf;
+use 5.10.0;
use utf8;
-use strict;
+use strict qw(vars subs);
use Symbol;
use List::Util;
use Socket;
-use Storable;
-use Event;
+use EV;
use Opcode;
use Safe;
use Safe::Hole;
+use Storable ();
-use Coro 3.61 ();
+use Guard ();
+use Coro ();
use Coro::State;
use Coro::Handle;
-use Coro::Event;
+use Coro::EV;
+use Coro::AnyEvent;
use Coro::Timer;
use Coro::Signal;
use Coro::Semaphore;
+use Coro::SemaphoreSet;
+use Coro::AnyEvent;
use Coro::AIO;
+use Coro::BDB 1.6;
use Coro::Storable;
+use Coro::Util ();
+use JSON::XS 2.01 ();
use BDB ();
use Data::Dumper;
use Digest::MD5;
use Fcntl;
-use YAML::Syck ();
-use IO::AIO 2.32 ();
+use YAML ();
+use IO::AIO ();
use Time::HiRes;
use Compress::LZF;
+use Digest::MD5 ();
+
+AnyEvent::detect;
# configure various modules to our taste
#
$Storable::canonical = 1; # reduce rsync transfers
Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
-Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
-
-$Event::Eval = 1; # no idea why this is required, but it is
-
-# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
-$YAML::Syck::ImplicitUnicode = 1;
$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
+# make sure c-lzf reinitialises itself
+Compress::LZF::set_serializer "Storable", "Storable::net_mstore", "Storable::mretrieve";
+Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
+
sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
our %COMMAND = ();
@@ -51,42 +81,49 @@
our @EXTS = (); # list of extension package names
our %EXTCMD = ();
+our %EXTICMD = ();
our %EXT_CORO = (); # coroutines bound to extensions
our %EXT_MAP = (); # pluggable maps
-our $RELOAD; # number of reloads so far
+our $RELOAD; # number of reloads so far, non-zero while in reload
our @EVENT;
-our $CONFDIR = confdir;
-our $DATADIR = datadir;
-our $LIBDIR = "$DATADIR/ext";
-our $PODDIR = "$DATADIR/pod";
-our $MAPDIR = "$DATADIR/" . mapdir;
-our $LOCALDIR = localdir;
-our $TMPDIR = "$LOCALDIR/" . tmpdir;
-our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
-our $PLAYERDIR = "$LOCALDIR/" . playerdir;
-our $RANDOMDIR = "$LOCALDIR/random";
-our $BDBDIR = "$LOCALDIR/db";
+our $CONFDIR = confdir;
+our $DATADIR = datadir;
+our $LIBDIR = "$DATADIR/ext";
+our $PODDIR = "$DATADIR/pod";
+our $MAPDIR = "$DATADIR/" . mapdir;
+our $LOCALDIR = localdir;
+our $TMPDIR = "$LOCALDIR/" . tmpdir;
+our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
+our $PLAYERDIR = "$LOCALDIR/" . playerdir;
+our $RANDOMDIR = "$LOCALDIR/random";
+our $BDBDIR = "$LOCALDIR/db";
+our $PIDFILE = "$LOCALDIR/pid";
+our $RUNTIMEFILE = "$LOCALDIR/runtime";
+
+our %RESOURCE;
our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
-our $TICK_WATCHER;
-our $AIO_POLL_WATCHER;
our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
our $NEXT_TICK;
-our $NOW;
our $USE_FSYNC = 1; # use fsync to write maps - default off
-our $BDB_POLL_WATCHER;
+our $BDB_DEADLOCK_WATCHER;
+our $BDB_CHECKPOINT_WATCHER;
+our $BDB_TRICKLE_WATCHER;
our $DB_ENV;
+our @EXTRA_MODULES = qw(pod mapscript);
+
our %CFG;
our $UPTIME; $UPTIME ||= time;
our $RUNTIME;
+our $NOW;
-our %PLAYER; # all users
-our %MAP; # all maps
+our (%PLAYER, %PLAYER_LOADING); # all users
+our (%MAP, %MAP_LOADING ); # all maps
our $LINK_MAP; # the special {link} map, which is always available
# used to convert map paths into valid unix filenames by replacing / by ∕
@@ -94,18 +131,25 @@
our $LOAD; # a number between 0 (idle) and 1 (too many objects)
our $LOADAVG; # same thing, but with alpha-smoothing
-our $tick_start; # for load detecting purposes
+our $JITTER; # average jitter
+our $TICK_START; # for load detecting purposes
+
+our @POST_INIT;
+
+our $REATTACH_ON_RELOAD; # ste to true to force object reattach on reload (slow)
binmode STDOUT;
binmode STDERR;
# read virtual server time, if available
-unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
- open my $fh, "<", "$LOCALDIR/runtime"
- or die "unable to read runtime file: $!";
+unless ($RUNTIME || !-e $RUNTIMEFILE) {
+ open my $fh, "<", $RUNTIMEFILE
+ or die "unable to read $RUNTIMEFILE file: $!";
$RUNTIME = <$fh> + 0.;
}
+eval "sub TICK() { $TICK } 1" or die;
+
mkdir $_
for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
@@ -157,7 +201,7 @@
=item %cf::CFG
-Configuration for the server, loaded from C, or
+Configuration for the server, loaded from C, or
from wherever your confdir points to.
=item cf::wait_for_tick, cf::wait_for_tick_begin
@@ -166,6 +210,12 @@
returns directly I the tick processing (and consequently, can only wake one process
per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
+=item @cf::INVOKE_RESULTS
+
+This array contains the results of the last C call. When
+C is called C<@cf::INVOKE_RESULTS> is set to the parameters of
+that call.
+
=back
=cut
@@ -179,11 +229,25 @@
$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
- utf8::encode $msg;
LOG llevError, $msg;
};
}
+$Coro::State::DIEHOOK = sub {
+ return unless $^S eq 0; # "eq", not "=="
+
+ if ($Coro::current == $Coro::main) {#d#
+ warn "DIEHOOK called in main context, Coro bug?\n";#d#
+ return;#d#
+ }#d#
+
+ # kill coroutine otherwise
+ warn Carp::longmess $_[0];
+ Coro::terminate
+};
+
+$SIG{__DIE__} = sub { }; #d#?
+
@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
@@ -199,16 +263,18 @@
cf::object cf::object::player
cf::client cf::player
cf::arch cf::living
- cf::map cf::party cf::region
+ cf::map cf::mapspace
+ cf::party cf::region
)) {
- no strict 'refs';
@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
}
-$Event::DIED = sub {
+$EV::DIED = sub {
warn "error in event callback: @_";
};
+#############################################################################
+
=head2 UTILITY FUNCTIONS
=over 4
@@ -236,16 +302,35 @@
} || "[unable to dump $_[0]: '$@']";
}
-use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
-
-=item $ref = cf::from_json $json
+=item $ref = cf::decode_json $json
Converts a JSON string into the corresponding perl data structure.
-=item $json = cf::to_json $ref
+=item $json = cf::encode_json $ref
Converts a perl data structure into its JSON representation.
+=cut
+
+our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
+
+sub encode_json($) { $json_coder->encode ($_[0]) }
+sub decode_json($) { $json_coder->decode ($_[0]) }
+
+=item cf::post_init { BLOCK }
+
+Execute the given codeblock, I all extensions have been (re-)loaded,
+but I the server starts ticking again.
+
+The cdoeblock will have a single boolean argument to indicate whether this
+is a reload or not.
+
+=cut
+
+sub post_init(&) {
+ push @POST_INIT, shift;
+}
+
=item cf::lock_wait $string
Wait until the given lock is available. See cf::lock_acquire.
@@ -253,10 +338,13 @@
=item my $lock = cf::lock_acquire $string
Wait until the given lock is available and then acquires it and returns
-a Coro::guard object. If the guard object gets destroyed (goes out of scope,
+a L object. If the guard object gets destroyed (goes out of scope,
for example when the coroutine gets canceled), the lock is automatically
returned.
+Locks are *not* recursive, locking from the same coro twice results in a
+deadlocked coro.
+
Lock names should begin with a unique identifier (for example, cf::map::find
uses map_find and cf::map::load uses map_load).
@@ -266,46 +354,99 @@
=cut
-our %LOCK;
+our $LOCKS = new Coro::SemaphoreSet;
sub lock_wait($) {
- my ($key) = @_;
-
- # wait for lock, if any
- while ($LOCK{$key}) {
- push @{ $LOCK{$key} }, $Coro::current;
- Coro::schedule;
- }
+ $LOCKS->wait ($_[0]);
}
sub lock_acquire($) {
- my ($key) = @_;
+ $LOCKS->guard ($_[0])
+}
- # wait, to be sure we are not locked
- lock_wait $key;
+sub lock_active($) {
+ $LOCKS->count ($_[0]) < 1
+}
- $LOCK{$key} = [];
+sub freeze_mainloop {
+ tick_inhibit_inc;
- Coro::guard {
- # wake up all waiters, to be on the safe side
- $_->ready for @{ delete $LOCK{$key} };
- }
+ &Guard::guard (\&tick_inhibit_dec);
}
-sub lock_active($) {
- my ($key) = @_;
+=item cf::periodic $interval, $cb
+
+Like EV::periodic, but randomly selects a starting point so that the actions
+get spread over timer.
+
+=cut
- ! ! $LOCK{$key}
+sub periodic($$) {
+ my ($interval, $cb) = @_;
+
+ my $start = rand List::Util::min 180, $interval;
+
+ EV::periodic $start, $interval, 0, $cb
}
-sub freeze_mainloop {
- return unless $TICK_WATCHER->is_active;
+=item cf::get_slot $time[, $priority[, $name]]
- my $guard = Coro::guard {
- $TICK_WATCHER->start;
- };
- $TICK_WATCHER->stop;
- $guard
+Allocate $time seconds of blocking CPU time at priority C<$priority>:
+This call blocks and returns only when you have at least C<$time> seconds
+of cpu time till the next tick. The slot is only valid till the next cede.
+
+The optional C<$name> can be used to identify the job to run. It might be
+used for statistical purposes and should identify the same time-class.
+
+Useful for short background jobs.
+
+=cut
+
+our @SLOT_QUEUE;
+our $SLOT_QUEUE;
+
+$SLOT_QUEUE->cancel if $SLOT_QUEUE;
+$SLOT_QUEUE = Coro::async {
+ $Coro::current->desc ("timeslot manager");
+
+ my $signal = new Coro::Signal;
+
+ while () {
+ next_job:
+ my $avail = cf::till_tick;
+ if ($avail > 0.01) {
+ for (0 .. $#SLOT_QUEUE) {
+ if ($SLOT_QUEUE[$_][0] < $avail) {
+ my $job = splice @SLOT_QUEUE, $_, 1, ();
+ $job->[2]->send;
+ Coro::cede;
+ goto next_job;
+ }
+ }
+ }
+
+ if (@SLOT_QUEUE) {
+ # we do not use wait_for_tick() as it returns immediately when tick is inactive
+ push @cf::WAIT_FOR_TICK, $signal;
+ $signal->wait;
+ } else {
+ Coro::schedule;
+ }
+ }
+};
+
+sub get_slot($;$$) {
+ return if tick_inhibit || $Coro::current == $Coro::main;
+
+ my ($time, $pri, $name) = @_;
+
+ $time = $TICK * .6 if $time > $TICK * .6;
+ my $sig = new Coro::Signal;
+
+ push @SLOT_QUEUE, [$time, $pri, $sig, $name];
+ @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
+ $SLOT_QUEUE->ready;
+ $sig->wait;
}
=item cf::async { BLOCK }
@@ -320,9 +461,10 @@
=item cf::sync_job { BLOCK }
-The design of crossfire+ requires that the main coro ($Coro::main) is
-always able to handle events or runnable, as crossfire+ is only partly
-reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
+The design of Deliantra requires that the main coroutine ($Coro::main)
+is always able to handle events or runnable, as Deliantra is only
+partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
+acceptable.
If it must be done, put the blocking parts into C. This will run
the given BLOCK in another coroutine while waiting for the result. The
@@ -335,34 +477,36 @@
my ($job) = @_;
if ($Coro::current == $Coro::main) {
- my $time = Event::time;
+ my $time = EV::time;
# this is the main coro, too bad, we have to block
# till the operation succeeds, freezing the server :/
- # TODO: use suspend/resume instead
- # (but this is cancel-safe)
+ LOG llevError, Carp::longmess "sync job";#d#
+
my $freeze_guard = freeze_mainloop;
my $busy = 1;
my @res;
(async {
+ $Coro::current->desc ("sync job coro");
@res = eval { $job->() };
warn $@ if $@;
undef $busy;
})->prio (Coro::PRIO_MAX);
while ($busy) {
- Coro::cede or Event::one_event;
+ if (Coro::nready) {
+ Coro::cede_notself;
+ } else {
+ EV::loop EV::LOOP_ONESHOT;
+ }
}
- $time = Event::time - $time;
-
- LOG llevError | logBacktrace, Carp::longmess "long sync job"
- if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
+ my $time = EV::time - $time;
- $tick_start += $time; # do not account sync jobs to server load
+ $TICK_START += $time; # do not account sync jobs to server load
wantarray ? @res : $res[0]
} else {
@@ -392,42 +536,182 @@
$coro
}
-sub write_runtime {
- my $runtime = "$LOCALDIR/runtime";
+=item fork_call { }, $args
- # first touch the runtime file to show we are still running:
- # the fsync below can take a very very long time.
+Executes the given code block with the given arguments in a seperate
+process, returning the results. Everything must be serialisable with
+Coro::Storable. May, of course, block. Note that the executed sub may
+never block itself or use any form of event handling.
- IO::AIO::aio_utime $runtime, undef, undef;
+=cut
- my $guard = cf::lock_acquire "write_runtime";
+sub fork_call(&@) {
+ my ($cb, @args) = @_;
- my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
- or return;
+ # we seemingly have to make a local copy of the whole thing,
+ # otherwise perl prematurely frees the stuff :/
+ # TODO: investigate and fix (likely this will be rather laborious)
- my $value = $cf::RUNTIME + 90 + 10;
- # 10 is the runtime save interval, for a monotonic clock
- # 60 allows for the watchdog to kill the server.
+ my @res = Coro::Util::fork_eval {
+ reset_signals;
+ &$cb
+ }, @args;
- (aio_write $fh, 0, (length $value), $value, 0) <= 0
- and return;
+ wantarray ? @res : $res[-1]
+}
- # always fsync - this file is important
- aio_fsync $fh
- and return;
+=item $coin = coin_from_name $name
- # touch it again to show we are up-to-date
- aio_utime $fh, undef, undef;
+=cut
- close $fh
- or return;
+our %coin_alias = (
+ "silver" => "silvercoin",
+ "silvercoin" => "silvercoin",
+ "silvercoins" => "silvercoin",
+ "gold" => "goldcoin",
+ "goldcoin" => "goldcoin",
+ "goldcoins" => "goldcoin",
+ "platinum" => "platinacoin",
+ "platinumcoin" => "platinacoin",
+ "platinumcoins" => "platinacoin",
+ "platina" => "platinacoin",
+ "platinacoin" => "platinacoin",
+ "platinacoins" => "platinacoin",
+ "royalty" => "royalty",
+ "royalties" => "royalty",
+);
- aio_rename "$runtime~", $runtime
- and return;
+sub coin_from_name($) {
+ $coin_alias{$_[0]}
+ ? cf::arch::find $coin_alias{$_[0]}
+ : undef
+}
- warn "runtime file written.\n";#d#
+=item $value = cf::db_get $family => $key
- 1
+Returns a single value from the environment database.
+
+=item cf::db_put $family => $key => $value
+
+Stores the given C<$value> in the family. It can currently store binary
+data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
+
+=item $db = cf::db_table "name"
+
+Create and/or open a new database table. The string must not be "db" and must be unique
+within each server.
+
+=cut
+
+sub db_table($) {
+ my ($name) = @_;
+ my $db = BDB::db_create $DB_ENV;
+
+ eval {
+ $db->set_flags (BDB::CHKSUM);
+
+ utf8::encode $name;
+ BDB::db_open $db, undef, $name, undef, BDB::BTREE,
+ BDB::CREATE | BDB::AUTO_COMMIT, 0666;
+ cf::cleanup "db_open(db): $!" if $!;
+ };
+ cf::cleanup "db_open(db): $@" if $@;
+
+ $db
+}
+
+our $DB;
+
+sub db_init {
+ cf::sync_job {
+ $DB ||= db_table "db";
+ };
+}
+
+sub db_get($$) {
+ my $key = "$_[0]/$_[1]";
+
+ cf::sync_job {
+ BDB::db_get $DB, undef, $key, my $data;
+
+ $! ? ()
+ : $data
+ }
+}
+
+sub db_put($$$) {
+ BDB::dbreq_pri 4;
+ BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
+}
+
+=item cf::cache $id => [$paths...], $processversion => $process
+
+Generic caching function that returns the value of the resource $id,
+caching and regenerating as required.
+
+This function can block.
+
+=cut
+
+sub cache {
+ my ($id, $src, $processversion, $process) = @_;
+
+ my $meta =
+ join "\x00",
+ $processversion,
+ map {
+ aio_stat $_
+ and Carp::croak "$_: $!";
+
+ ($_, (stat _)[7,9])
+ } @$src;
+
+ my $dbmeta = db_get cache => "$id/meta";
+ if ($dbmeta ne $meta) {
+ # changed, we may need to process
+
+ my @data;
+ my $md5;
+
+ for (0 .. $#$src) {
+ 0 <= aio_load $src->[$_], $data[$_]
+ or Carp::croak "$src->[$_]: $!";
+ }
+
+ # if processing is expensive, check
+ # checksum first
+ if (1) {
+ $md5 =
+ join "\x00",
+ $processversion,
+ map {
+ cf::cede_to_tick;
+ ($src->[$_], Digest::MD5::md5_hex $data[$_])
+ } 0.. $#$src;
+
+
+ my $dbmd5 = db_get cache => "$id/md5";
+ if ($dbmd5 eq $md5) {
+ db_put cache => "$id/meta", $meta;
+
+ return db_get cache => "$id/data";
+ }
+ }
+
+ my $t1 = Time::HiRes::time;
+ my $data = $process->(\@data);
+ my $t2 = Time::HiRes::time;
+
+ warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
+
+ db_put cache => "$id/data", $data;
+ db_put cache => "$id/md5" , $md5;
+ db_put cache => "$id/meta", $meta;
+
+ return $data;
+ }
+
+ db_get cache => "$id/data"
}
=item cf::datalog type => key => value, ...
@@ -449,13 +733,13 @@
=head2 ATTACHABLE OBJECTS
-Many objects in crossfire are so-called attachable objects. That means you can
+Many objects in deliantra are so-called attachable objects. That means you can
attach callbacks/event handlers (a collection of which is called an "attachment")
to it. All such attachable objects support the following methods.
In the following description, CLASS can be any of C, C