--- deliantra/server/lib/cf.pm 2007/01/02 22:55:05 1.124 +++ deliantra/server/lib/cf.pm 2007/01/13 23:32:43 1.167 @@ -10,31 +10,36 @@ use Safe; use Safe::Hole; -use Coro 3.3; +use Coro 3.3 (); use Coro::Event; use Coro::Timer; use Coro::Signal; use Coro::Semaphore; use Coro::AIO; +use Data::Dumper; use Digest::MD5; use Fcntl; -use IO::AIO 2.31 (); +use IO::AIO 2.32 (); use YAML::Syck (); use Time::HiRes; use Event; $Event::Eval = 1; # no idea why this is required, but it is +sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload + # work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? $YAML::Syck::ImplicitUnicode = 1; -$Coro::main->prio (2); # run main coroutine ("the server") with very high priority - -sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload +$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority our %COMMAND = (); our %COMMAND_TIME = (); + +our @EXTS = (); # list of extension package names our %EXTCMD = (); +our %EXT_CORO = (); # coroutines bound to extensions +our %EXT_MAP = (); # pluggable maps our @EVENT; our $LIBDIR = datadir . "/ext"; @@ -49,11 +54,16 @@ our $UPTIME; $UPTIME ||= time; our $RUNTIME; -our %MAP; # all maps -our $LINK_MAP; # the special {link} map -our $FREEZE; +our %PLAYER; # all users +our %MAP; # all maps +our $LINK_MAP; # the special {link} map, which is always available our $RANDOM_MAPS = cf::localdir . "/random"; -our %EXT_CORO; + +our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal; +our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal; + +# used to convert map paths into valid unix filenames by replacing / by ∕ +our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons binmode STDOUT; binmode STDERR; @@ -71,10 +81,7 @@ mkdir cf::localdir . "/" . cf::uniquedir; mkdir $RANDOM_MAPS; -# a special map that is always available -our $LINK_MAP; - -our $EMERGENCY_POSITION = $cf::CFG{emergency_position} || ["/world/world_105_115", 5, 37]; +our $EMERGENCY_POSITION; ############################################################################# @@ -109,6 +116,13 @@ Configuration for the server, loaded from C, or from wherever your confdir points to. +=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE + +These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK) +or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick +processing has been done. Call C<< ->wait >> on them to maximise the +window of cpu time available, or simply to synchronise to the server tick. + =back =cut @@ -121,7 +135,7 @@ $msg .= "\n" unless $msg =~ /\n$/; - LOG llevError, "cfperl: $msg"; + LOG llevError, $msg; }; } @@ -149,16 +163,33 @@ warn "error in event callback: @_"; }; -my %ext_pkg; -my @exts; -my @hook; - =head2 UTILITY FUNCTIONS =over 4 +=item dumpval $ref + =cut +sub dumpval { + eval { + local $SIG{__DIE__}; + my $d; + if (1) { + $d = new Data::Dumper([$_[0]], ["*var"]); + $d->Terse(1); + $d->Indent(2); + $d->Quotekeys(0); + $d->Useqq(1); + #$d->Bless(...); + $d->Seen($_[1]) if @_ > 1; + $d = $d->Dump(); + } + $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; + $d + } || "[unable to dump $_[0]: '$@']"; +} + use JSON::Syck (); # TODO# replace by JSON::PC once working =item $ref = cf::from_json $json @@ -183,28 +214,6 @@ JSON::Syck::Dump $_[0] } -=item my $guard = cf::guard { BLOCK } - -Run the given callback when the guard object gets destroyed (useful for -coroutine cancellations). - -You can call C<< ->cancel >> on the guard object to stop the block from -being executed. - -=cut - -sub guard(&) { - bless \(my $cb = $_[0]), cf::guard::; -} - -sub cf::guard::cancel { - ${$_[0]} = sub { }; -} - -sub cf::guard::DESTROY { - ${$_[0]}->(); -} - =item cf::lock_wait $string Wait until the given lock is available. See cf::lock_acquire. @@ -212,12 +221,12 @@ =item my $lock = cf::lock_acquire $string Wait until the given lock is available and then acquires it and returns -a guard object. If the guard object gets destroyed (goes out of scope, +a Coro::guard object. If the guard object gets destroyed (goes out of scope, for example when the coroutine gets canceled), the lock is automatically returned. -Lock names should begin with a unique identifier (for example, find_map -uses map_find and load_map uses map_load). +Lock names should begin with a unique identifier (for example, cf::map::find +uses map_find and cf::map::load uses map_load). =cut @@ -241,12 +250,30 @@ $LOCK{$key} = []; - cf::guard { + Coro::guard { # wake up all waiters, to be on the safe side $_->ready for @{ delete $LOCK{$key} }; } } +sub freeze_mainloop { + return unless $TICK_WATCHER->is_active; + + my $guard = Coro::guard { $TICK_WATCHER->start }; + $TICK_WATCHER->stop; + $guard +} + +=item cf::async { BLOCK } + +Currently the same as Coro::async_pool, meaning you cannot use +C, C or other gimmicks on these coroutines. The only +thing you are allowed to do is call C on it. + +=cut + +BEGIN { *async = \&Coro::async_pool } + =item cf::sync_job { BLOCK } The design of crossfire+ requires that the main coro ($Coro::main) is @@ -269,20 +296,19 @@ # TODO: use suspend/resume instead # (but this is cancel-safe) - local $FREEZE = 1; + my $freeze_guard = freeze_mainloop; my $busy = 1; my @res; - (Coro::async { + (async { @res = eval { $job->() }; warn $@ if $@; undef $busy; })->prio (Coro::PRIO_MAX); while ($busy) { - Coro::cede_notself; - Event::one_event unless Coro::nready; + Coro::cede or Event::one_event; } wantarray ? @res : $res[0] @@ -293,22 +319,17 @@ } } -=item $coro = cf::coro { BLOCK } +=item $coro = cf::async_ext { BLOCK } -Creates and returns a new coro. This coro is automcatially being canceled -when the extension calling this is being unloaded. +Like async, but this coro is automatically being canceled when the +extension calling this is being unloaded. =cut -sub coro(&) { +sub async_ext(&) { my $cb = shift; - my $coro; $coro = async { - eval { - $cb->(); - }; - warn $@ if $@; - }; + my $coro = &Coro::async ($cb); $coro->on_destroy (sub { delete $EXT_CORO{$coro+0}; @@ -319,6 +340,8 @@ } sub write_runtime { + return unless $TICK_WATCHER->is_active; + my $runtime = cf::localdir . "/runtime"; my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 @@ -346,126 +369,6 @@ ############################################################################# -package cf::path; - -sub new { - my ($class, $path, $base) = @_; - - $path = $path->as_string if ref $path; - - my $self = bless { }, $class; - - # {... are special paths that are not touched - # ?xxx/... are special absolute paths - # ?random/... random maps - # /! non-realised random map exit - # /... normal maps - # ~/... per-player maps without a specific player (DO NOT USE) - # ~user/... per-player map of a specific user - - if ($path =~ /^{/) { - # fine as it is - } elsif ($path =~ s{^\?random/}{}) { - Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data; - $self->{random} = cf::from_json $data; - } else { - if ($path =~ s{^~([^/]+)?}{}) { - $self->{user_rel} = 1; - - if (defined $1) { - $self->{user} = $1; - } elsif ($base =~ m{^~([^/]+)/}) { - $self->{user} = $1; - } else { - warn "cannot resolve user-relative path without user <$path,$base>\n"; - } - } elsif ($path =~ /^\//) { - # already absolute - } else { - $base =~ s{[^/]+/?$}{}; - return $class->new ("$base/$path"); - } - - for ($path) { - redo if s{/\.?/}{/}; - redo if s{/[^/]+/\.\./}{/}; - } - } - - $self->{path} = $path; - - $self -} - -# the name / primary key / in-game path -sub as_string { - my ($self) = @_; - - $self->{user_rel} ? "~$self->{user}$self->{path}" - : $self->{random} ? "?random/$self->{path}" - : $self->{path} -} - -# the displayed name, this is a one way mapping -sub visible_name { - my ($self) = @_; - -# if (my $rmp = $self->{random}) { -# # todo: be more intelligent about this -# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}" -# } else { - $self->as_string -# } -} - -# escape the /'s in the path -sub _escaped_path { - # ∕ is U+2215 - (my $path = $_[0]{path}) =~ s/\//∕/g; - $path -} - -# the original (read-only) location -sub load_path { - my ($self) = @_; - - sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path} -} - -# the temporary/swap location -sub save_path { - my ($self) = @_; - - $self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path - : $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path} - : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path -} - -# the unique path, might be eq to save_path -sub uniq_path { - my ($self) = @_; - - $self->{user_rel} || $self->{random} - ? undef - : sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path -} - -# return random map parameters, or undef -sub random_map_params { - my ($self) = @_; - - $self->{random} -} - -# this is somewhat ugly, but style maps do need special treatment -sub is_style_map { - $_[0]{path} =~ m{^/styles/} -} - -package cf; - -############################################################################# - =head2 ATTACHABLE OBJECTS Many objects in crossfire are so-called attachable objects. That means you can @@ -919,10 +822,7 @@ sub register_extcmd { my ($name, $cb) = @_; - my $caller = caller; - #warn "registering extcmd '$name' to '$caller'"; - - $EXTCMD{$name} = [$cb, $caller]; + $EXTCMD{$name} = $cb; } cf::player->attach ( @@ -945,7 +845,7 @@ if (ref $msg) { if (my $cb = $EXTCMD{$msg->{msgtype}}) { - if (my %reply = $cb->[0]->($pl, $msg)) { + if (my %reply = $cb->($pl, $msg)) { $pl->ext_reply ($msg->{msgid}, %reply); } } @@ -957,12 +857,6 @@ }, ); -sub register { - my ($base, $pkg) = @_; - - #TODO -} - sub load_extension { my ($path) = @_; @@ -972,7 +866,7 @@ $pkg =~ s/[^[:word:]]/_/g; $pkg = "ext::$pkg"; - warn "loading '$path' into '$pkg'\n"; + warn "... loading '$path' into '$pkg'\n"; open my $fh, "<:utf8", $path or die "$path: $!"; @@ -983,121 +877,199 @@ . (do { local $/; <$fh> }) . "\n};\n1"; - eval $source - or die $@ ? "$path: $@\n" - : "extension disabled.\n"; + unless (eval $source) { + my $msg = $@ ? "$path: $@\n" + : "extension disabled.\n"; + if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match + warn $@; + warn "mandatory extension failed to load, exiting.\n"; + exit 1; + } + die $@; + } - push @exts, $pkg; - $ext_pkg{$base} = $pkg; + push @EXTS, $pkg; +} -# no strict 'refs'; -# @{"$pkg\::ISA"} = ext::; +sub load_extensions { + for my $ext (<$LIBDIR/*.ext>) { + next unless -r $ext; + eval { + load_extension $ext; + 1 + } or warn "$ext not loaded: $@"; + } +} + +############################################################################# + +=head2 CORE EXTENSIONS + +Functions and methods that extend core crossfire objects. + +=cut + +package cf::player; + +use Coro::AIO; - register $base, $pkg; +=head3 cf::player + +=over 4 + +=item cf::player::find $login + +Returns the given player object, loading it if necessary (might block). + +=cut + +sub playerdir($) { + cf::localdir + . "/" + . cf::playerdir + . "/" + . (ref $_[0] ? $_[0]->ob->name : $_[0]) } -sub unload_extension { - my ($pkg) = @_; +sub path($) { + my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; + + (playerdir $login) . "/$login.pl" +} - warn "removing extension $pkg\n"; +sub find_active($) { + $cf::PLAYER{$_[0]} + and $cf::PLAYER{$_[0]}->active + and $cf::PLAYER{$_[0]} +} - # remove hooks - #TODO -# for my $idx (0 .. $#PLUGIN_EVENT) { -# delete $hook[$idx]{$pkg}; -# } +sub exists($) { + my ($login) = @_; - # remove commands - for my $name (keys %COMMAND) { - my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} }; + $cf::PLAYER{$login} + or cf::sync_job { !aio_stat $login } +} - if (@cb) { - $COMMAND{$name} = \@cb; - } else { - delete $COMMAND{$name}; +sub find($) { + return $cf::PLAYER{$_[0]} || do { + my $login = $_[0]; + + my $guard = cf::lock_acquire "user_find:$login"; + + $cf::PLAYER{$_[0]} || do { + my $pl = load_pl path $login + or return; + $cf::PLAYER{$login} = $pl } } +} - # remove extcmds - for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) { - delete $EXTCMD{$name}; - } +sub save($) { + my ($pl) = @_; - if (my $cb = $pkg->can ("unload")) { - eval { - $cb->($pkg); - 1 - } or warn "$pkg unloaded, but with errors: $@"; - } + return if $pl->{deny_save}; + + my $path = path $pl; + my $guard = cf::lock_acquire "user_save:$path"; + + return if $pl->{deny_save}; - Symbol::delete_package $pkg; + aio_mkdir playerdir $pl, 0770; + $pl->{last_save} = $cf::RUNTIME; + + $pl->save_pl ($path); + Coro::cede; } -sub load_extensions { - for my $ext (<$LIBDIR/*.ext>) { - next unless -r $ext; - eval { - load_extension $ext; - 1 - } or warn "$ext not loaded: $@"; - } +sub new($) { + my ($login) = @_; + + my $self = create; + + $self->ob->name ($login); + $self->{deny_save} = 1; + + $cf::PLAYER{$login} = $self; + + $self } -############################################################################# -# load/save/clean perl data associated with a map +=item $pl->quit_character -*cf::mapsupport::on_clean = sub { - my ($map) = @_; +Nukes the player without looking back. If logged in, the connection will +be destroyed. May block for a long time. - my $path = $map->tmpname; - defined $path or return; +=cut - unlink "$path.pst"; -}; +sub quit_character { + my ($pl) = @_; -cf::map->attach (prio => -10000, package => cf::mapsupport::); + $pl->{deny_save} = 1; + $pl->password ("*"); # this should lock out the player until we nuked the dir -############################################################################# -# load/save perl data associated with player->ob objects + $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; + $pl->deactivate; + $pl->invoke (cf::EVENT_PLAYER_QUIT); + $pl->ns->destroy if $pl->ns; -sub all_objects(@) { - @_, map all_objects ($_->inv), @_ + my $path = playerdir $pl; + my $temp = "$path~$cf::RUNTIME~deleting~"; + aio_rename $path, $temp; + delete $cf::PLAYER{$pl->ob->name}; + $pl->destroy; + IO::AIO::aio_rmtree $temp; } -# TODO: compatibility cruft, remove when no longer needed -cf::player->attach ( - on_load => sub { - my ($pl, $path) = @_; +=item cf::player::list_logins - for my $o (all_objects $pl->ob) { - if (my $value = $o->get_ob_key_value ("_perl_data")) { - $o->set_ob_key_value ("_perl_data"); +Returns am arrayref of all valid playernames in the system, can take a +while and may block, so not sync_job-capable, ever. - %$o = %{ Storable::thaw pack "H*", $value }; - } - } - }, -); +=cut -############################################################################# +sub list_logins { + my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir + or return []; -=head2 CORE EXTENSIONS + my @logins; -Functions and methods that extend core crossfire objects. + for my $login (@$dirs) { + my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next; + aio_read $fh, 0, 512, my $buf, 0 or next; + $buf !~ /^password -------------$/m or next; # official not-valid tag -=head3 cf::player + utf8::decode $login; + push @logins, $login; + } -=over 4 + \@logins +} -=item cf::player::exists $login +=item $player->maps -Returns true when the given account exists. +Returns an arrayref of map paths that are private for this +player. May block. =cut -sub cf::player::exists($) { - cf::player::find $_[0] - or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; +sub maps($) { + my ($pl) = @_; + + my $files = aio_readdir playerdir $pl + or return; + + my @paths; + + for (@$files) { + utf8::decode $_; + next if /\.(?:pl|pst)$/; + next unless /^$PATH_SEP/o; + + s/\.map$//; + push @paths, "~" . $pl->ob->name . "/" . $_; + } + + \@paths } =item $player->ext_reply ($msgid, $msgtype, %msg) @@ -1106,14 +1078,16 @@ =cut -sub cf::player::ext_reply($$$%) { +sub ext_reply($$$%) { my ($self, $id, %msg) = @_; $msg{msgid} = $id; - $self->send ("ext " . to_json \%msg); + $self->send ("ext " . cf::to_json \%msg); } +package cf; + =back @@ -1128,15 +1102,17 @@ use Fcntl; use Coro::AIO; -our $MAX_RESET = 7200; -our $DEFAULT_RESET = 3600; +use overload + '""' => \&as_string; + +our $MAX_RESET = 3600; +our $DEFAULT_RESET = 3000; sub generate_random_map { - my ($path, $rmp) = @_; + my ($self, $rmp) = @_; # mit "rum" bekleckern, nicht - cf::map::_create_random_map - $path, + $self->_create_random_map ( $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, @@ -1147,7 +1123,113 @@ $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation}, $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp}, $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, - (cf::region::find $rmp->{region}) + (cf::region::find $rmp->{region}), $rmp->{custom} + ) +} + +sub register { + my (undef, $regex) = @_; + my $pkg = caller; + + no strict; + push @{"$pkg\::ISA"}, __PACKAGE__; + + $EXT_MAP{$pkg} = qr<$regex>; +} + +# also paths starting with '/' +$EXT_MAP{"cf::map"} = qr{^(?=/)}; + +sub normalise { + my ($path, $base) = @_; + + # map plan: + # + # /! non-realised random map exit (special hack!) + # {... are special paths that are not being touched + # ?xxx/... are special absolute paths + # ?random/... random maps + # /... normal maps + # ~user/... per-player map of a specific user + + $path =~ s/$PATH_SEP/\//go; + + # treat it as relative path if it starts with + # something that looks reasonable + if ($path =~ m{^(?:\./|\.\./|\w)}) { + $base or Carp::carp "normalise called with relative path and no base: '$path'"; + + $base =~ s{[^/]+/?$}{}; + $path = "$base/$path"; + } + + for ($path) { + redo if s{//}{/}; + redo if s{/\.?/}{/}; + redo if s{/[^/]+/\.\./}{/}; + } + + $path +} + +sub new_from_path { + my (undef, $path, $base) = @_; + + return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object + + $path = normalise $path, $base; + + for my $pkg (keys %EXT_MAP) { + if ($path =~ $EXT_MAP{$pkg}) { + my $self = bless cf::map::new, $pkg; + $self->{path} = $path; $self->path ($path); + $self->init; # pass $1 etc. + return $self; + } + } + + Carp::carp "unable to resolve path '$path'."; + () +} + +sub init { + my ($self) = @_; + + $self +} + +sub as_string { + my ($self) = @_; + + "$self->{path}" +} + +# the displayed name, this is a one way mapping +sub visible_name { + &as_string +} + +# the original (read-only) location +sub load_path { + my ($self) = @_; + + sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path} +} + +# the temporary/swap location +sub save_path { + my ($self) = @_; + + (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; + sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path +} + +# the unique path, undef == no special unique path +sub uniq_path { + my ($self) = @_; + + (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; + sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path } # and all this just because we cannot iterate over @@ -1159,74 +1241,89 @@ for grep $_->outdoor, values %cf::MAP; } -sub try_load_header($) { - my ($path) = @_; +sub unlink_save { + my ($self) = @_; + + utf8::encode (my $save = $self->save_path); + IO::AIO::aioreq_pri 4; IO::AIO::aio_unlink $save; + IO::AIO::aioreq_pri 4; IO::AIO::aio_unlink "$save.pst"; +} + +sub load_header_from($) { + my ($self, $path) = @_; utf8::encode $path; aio_open $path, O_RDONLY, 0 or return; - my $map = cf::map::new + $self->_load_header ($path) or return; - $map->load_header ($path) - or return; + $self->{load_path} = $path; - $map->{load_path} = $path; + 1 +} - $map +sub load_orig { + my ($self) = @_; + + $self->load_header_from ($self->load_path) } -sub find_map { - my ($path, $origin) = @_; +sub load_temp { + my ($self) = @_; - #warn "find_map<$path,$origin>\n";#d# + $self->load_header_from ($self->save_path) +} - $path = new cf::path $path, $origin && $origin->path; - my $key = $path->as_string; +sub load_header { + my ($self) = @_; - cf::lock_wait "map_find:$key"; + if ($self->load_temp) { + $self->last_access ((delete $self->{last_access}) + || $cf::RUNTIME); #d# + # safety + $self->{instantiate_time} = $cf::RUNTIME + if $self->{instantiate_time} > $cf::RUNTIME; + } else { + $self->load_orig + or return; - $cf::MAP{$key} || do { - my $guard = cf::lock_acquire "map_find:$key"; + $self->{load_original} = 1; + $self->{instantiate_time} = $cf::RUNTIME; + $self->last_access ($cf::RUNTIME); + $self->instantiate; + } - # do it the slow way - my $map = try_load_header $path->save_path; + 1 +} - if ($map) { - # safety - $map->{instantiate_time} = $cf::RUNTIME - if $map->{instantiate_time} > $cf::RUNTIME; - } else { - if (my $rmp = $path->random_map_params) { - $map = generate_random_map $key, $rmp; - } else { - $map = try_load_header $path->load_path; - } +sub find; +sub find { + my ($path, $origin) = @_; - $map or return; + $path = normalise $path, $origin && $origin->path; - $map->{load_original} = 1; - $map->{instantiate_time} = $cf::RUNTIME; - $map->instantiate; + cf::lock_wait "map_find:$path"; - # per-player maps become, after loading, normal maps - $map->per_player (0) if $path->{user_rel}; - } + $cf::MAP{$path} || do { + my $guard = cf::lock_acquire "map_find:$path"; + my $map = new_from_path cf::map $path + or return; - $map->path ($key); - $map->{path} = $path; $map->{last_save} = $cf::RUNTIME; - $map->last_access ($cf::RUNTIME); + + $map->load_header + or return; if ($map->should_reset) { $map->reset; undef $guard; - $map = cf::map::find_map ($path) + $map = find $path or return; } - $cf::MAP{$key} = $map + $cf::MAP{$path} = $map } } @@ -1234,89 +1331,163 @@ my ($self) = @_; my $path = $self->{path}; - my $guard = cf::lock_acquire "map_load:" . $path->as_string; + my $guard = cf::lock_acquire "map_load:$path"; return if $self->in_memory != cf::MAP_SWAPPED; $self->in_memory (cf::MAP_LOADING); $self->alloc; - $self->load_objects ($self->{load_path}, 1) + $self->_load_objects ($self->{load_path}, 1) or return; $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) if delete $self->{load_original}; - if (my $uniq = $path->uniq_path) { + if (my $uniq = $self->uniq_path) { utf8::encode $uniq; if (aio_open $uniq, O_RDONLY, 0) { $self->clear_unique_items; - $self->load_objects ($uniq, 0); + $self->_load_objects ($uniq, 0); } } + Coro::cede; + # now do the right thing for maps $self->link_multipart_objects; - if ($self->{path}->is_style_map) { - $self->{deny_save} = 1; - $self->{deny_reset} = 1; - } else { - $self->fix_auto_apply; + unless ($self->{deny_activate}) { $self->decay_objects; + $self->fix_auto_apply; $self->update_buttons; + Coro::cede; $self->set_darkness_map; $self->difficulty ($self->estimate_difficulty) unless $self->difficulty; + Coro::cede; $self->activate; } $self->in_memory (cf::MAP_IN_MEMORY); } -sub load_map_sync { +sub customise_for { + my ($self, $ob) = @_; + + return find "~" . $ob->name . "/" . $self->{path} + if $self->per_player; + + $self +} + +# find and load all maps in the 3x3 area around a map +sub load_diag { + my ($map) = @_; + + my @diag; # diagonal neighbours + + for (0 .. 3) { + my $neigh = $map->tile_path ($_) + or next; + $neigh = find $neigh, $map + or next; + $neigh->load; + + push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], + [$neigh->tile_path (($_ + 1) % 4), $neigh]; + } + + for (@diag) { + my $neigh = find @$_ + or next; + $neigh->load; + } +} + +sub find_sync { my ($path, $origin) = @_; - #warn "load_map_sync<$path, $origin>\n";#d# + cf::sync_job { find $path, $origin } +} - cf::sync_job { - my $map = cf::map::find_map $path, $origin - or return; - $map->load; - $map +sub do_load_sync { + my ($map) = @_; + + cf::sync_job { $map->load }; +} + +our %MAP_PREFETCH; +our $MAP_PREFETCHER = Coro::async { + while () { + for my $path (keys %MAP_PREFETCH) { + my $map = find $path + or next; + $map->load; + + delete $MAP_PREFETCH{$path}; + } + Coro::schedule; } +}; + +sub find_async { + my ($path, $origin) = @_; + + $path = normalise $path, $origin && $origin->{path}; + + if (my $map = $cf::MAP{$path}) { + return $map if $map->in_memory == cf::MAP_IN_MEMORY; + } + + $MAP_PREFETCH{$path} = 0; + $MAP_PREFETCHER->ready; + + () } sub save { my ($self) = @_; + my $lock = cf::lock_acquire "map_data:" . $self->path; + $self->{last_save} = $cf::RUNTIME; return unless $self->dirty; - my $save = $self->{path}->save_path; utf8::encode $save; - my $uniq = $self->{path}->uniq_path; utf8::encode $uniq; + my $save = $self->save_path; utf8::encode $save; + my $uniq = $self->uniq_path; utf8::encode $uniq; $self->{load_path} = $save; return if $self->{deny_save}; + local $self->{last_access} = $self->last_access;#d# + + cf::async { + $_->contr->save for $self->players; + }; + if ($uniq) { - $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); - $self->save_objects ($uniq, cf::IO_UNIQUES); + $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); + $self->_save_objects ($uniq, cf::IO_UNIQUES); } else { - $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES); + $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES); } } sub swap_out { my ($self) = @_; + # save first because save cedes + $self->save; + + my $lock = cf::lock_acquire "map_data:" . $self->path; + return if $self->players; return if $self->in_memory != cf::MAP_IN_MEMORY; return if $self->{deny_save}; - $self->save; $self->clear; $self->in_memory (cf::MAP_SWAPPED); } @@ -1325,7 +1496,7 @@ my ($self) = @_; # TODO: safety, remove and allow resettable per-player maps - return 1e99 if $self->{path}{user_rel}; + return 1e99 if $self->isa ("ext::map_per_player"); return 1e99 if $self->{deny_reset}; my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; @@ -1340,22 +1511,15 @@ $self->reset_at <= $cf::RUNTIME } -sub unlink_save { - my ($self) = @_; - - utf8::encode (my $save = $self->{path}->save_path); - aioreq_pri 3; IO::AIO::aio_unlink $save; - aioreq_pri 3; IO::AIO::aio_unlink "$save.pst"; -} - sub rename { my ($self, $new_path) = @_; + normalise $new_path; + $self->unlink_save; delete $cf::MAP{$self->path}; - $self->{path} = new cf::path $new_path; - $self->path ($self->{path}->as_string); + $self->{path} = $new_path; $self->path ($self->{path}); $cf::MAP{$self->path} = $self; $self->save; @@ -1364,13 +1528,18 @@ sub reset { my ($self) = @_; + my $lock = cf::lock_acquire "map_data:$self->{path}"; + return if $self->players; - return if $self->{path}{user_rel};#d# + return if $self->isa ("ext::map_per_player");#d# warn "resetting map ", $self->path;#d# delete $cf::MAP{$self->path}; + $self->in_memory (cf::MAP_SWAPPED); + $self->clear; + $_->clear_links_to ($self) for values %cf::MAP; $self->unlink_save; @@ -1388,34 +1557,62 @@ $self->reset; # polite request, might not happen } -sub customise_for { - my ($map, $ob) = @_; +=item cf::map::unique_maps - if ($map->per_player) { - return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path}; +Returns an arrayref of paths of all shared maps that have +instantiated unique items. May block. + +=cut + +sub unique_maps() { + my $files = aio_readdir cf::localdir . "/" . cf::uniquedir + or return; + + my @paths; + + for (@$files) { + utf8::decode $_; + next if /\.pst$/; + next unless /^$PATH_SEP/o; + + s/\.map$//; + push @paths, $_; } - $map + \@paths } -sub emergency_save { - local $cf::FREEZE = 1; +package cf; - warn "enter emergency map save\n"; +=back - cf::sync_job { - warn "begin emergency map save\n"; - $_->save for values %cf::MAP; - }; +=head3 cf::object + +=cut + +package cf::object; + +=over 4 - warn "end emergency map save\n"; +=item $ob->inv_recursive + +Returns the inventory of the object _and_ their inventories, recursively. + +=cut + +sub inv_recursive_; +sub inv_recursive_ { + map { $_, inv_recursive_ $_->inv } @_ +} + +sub inv_recursive { + inv_recursive_ inv $_[0] } package cf; =back - =head3 cf::object::player =over 4 @@ -1464,31 +1661,43 @@ Freezes the player and moves him/her to a special map (C<{link}>). -The player should be reaosnably safe there for short amounts of time. You +The player should be reasonably safe there for short amounts of time. You I call C as soon as possible, though. +Will never block. + =item $player_object->leave_link ($map, $x, $y) -Moves the player out of the specila link map onto the given map. If the -map is not valid (or omitted), the player will be moved back to the -location he/she was before the call to C, or, if that fails, -to the emergency map position. +Moves the player out of the special C<{link}> map onto the specified +map. If the map is not valid (or omitted), the player will be moved back +to the location he/she was before the call to C, or, if that +fails, to the emergency map position. Might block. =cut +sub link_map { + unless ($LINK_MAP) { + $LINK_MAP = cf::map::find "{link}" + or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 }; + $LINK_MAP->load; + } + + $LINK_MAP +} + sub cf::object::player::enter_link { my ($self) = @_; $self->deactivate_recursive; - return if $self->map == $LINK_MAP; + return if UNIVERSAL::isa $self->map, "ext::map_link"; $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] if $self->map; - $self->enter_map ($LINK_MAP, 20, 20); + $self->enter_map ($LINK_MAP || link_map, 20, 20); } sub cf::object::player::leave_link { @@ -1499,11 +1708,11 @@ unless ($map) { # restore original map position ($map, $x, $y) = @{ $link_pos || [] }; - $map = cf::map::find_map $map; + $map = cf::map::find $map; unless ($map) { ($map, $x, $y) = @$EMERGENCY_POSITION; - $map = cf::map::find_map $map + $map = cf::map::find $map or die "FATAL: cannot load emergency map\n"; } } @@ -1516,7 +1725,9 @@ if $x <=0 && $y <= 0; $map->load; + $map->load_diag; + return unless $self->contr->active; $self->activate_recursive; $self->enter_map ($map, $x, $y); } @@ -1539,35 +1750,37 @@ # should happen only on crashes if ($pl->ob->{_link_pos}) { $pl->ob->enter_link; - Coro::async { + (async { # we need this sleep as the login has a concurrent enter_exit running # and this sleep increases chances of the player not ending up in scorn + $pl->ob->reply (undef, + "There was an internal problem at your last logout, " + . "the server will try to bring you to your intended destination in a second.", + cf::NDI_RED); Coro::Timer::sleep 1; $pl->ob->leave_link; - }; + })->prio (2); } }, ); -=item $player_object->goto_map ($path, $x, $y) +=item $player_object->goto ($path, $x, $y) =cut -sub cf::object::player::goto_map { +sub cf::object::player::goto { my ($self, $path, $x, $y) = @_; $self->enter_link; - (Coro::async { - $path = new cf::path $path; - - my $map = cf::map::find_map $path->as_string; + (async { + my $map = cf::map::find $path; $map = $map->customise_for ($self) if $map; # warn "entering ", $map->path, " at ($x, $y)\n" # if $map; - $map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED); + $map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED); $self->leave_link ($map, $x, $y); })->prio (1); @@ -1630,20 +1843,20 @@ $self->enter_link; - (Coro::async { + (async { + $self->deactivate_recursive; # just to be sure unless (eval { - prepare_random_map $exit if $exit->slaying eq "/!"; - my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path; - $self->goto_map ($path, $exit->stats->hp, $exit->stats->sp); + my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path; + $self->goto ($path, $exit->stats->hp, $exit->stats->sp); 1; }) { $self->message ("Something went wrong deep within the crossfire server. " . "I'll try to bring you back to the map you were before. " - . "Please report this to the dungeon master", + . "Please report this to the dungeon master!", cf::NDI_UNIQUE | cf::NDI_RED); warn "ERROR in enter_exit: $@"; @@ -1704,7 +1917,8 @@ # this weird shuffling is so that direct followup queries # get handled first - my $queue = delete $ns->{query_queue}; + my $queue = delete $ns->{query_queue} + or return; # be conservative, not sure how that can happen, but we saw a crash here (shift @$queue)->[1]->($msg); @@ -1720,7 +1934,7 @@ }, ); -=item $client->coro (\&cb) +=item $client->async (\&cb) Create a new coroutine, running the specified callback. The coroutine will be automatically cancelled when the client gets destroyed (e.g. on logout, @@ -1728,15 +1942,10 @@ =cut -sub cf::client::coro { +sub cf::client::async { my ($self, $cb) = @_; - my $coro; $coro = async { - eval { - $cb->(); - }; - warn $@ if $@; - }; + my $coro = &Coro::async ($cb); $coro->on_destroy (sub { delete $self->{_coro}{$coro+0}; @@ -1981,15 +2190,26 @@ local $/; *CFG = YAML::Syck::Load <$fh>; + + $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37]; + + $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset}; + $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset}; + + if (exists $CFG{mlockall}) { + eval { + $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()" + and die "WARNING: m(un)lockall failed: $!\n"; + }; + warn $@ if $@; + } } sub main { # we must not ever block the main coroutine local $Coro::idle = sub { Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# - (Coro::unblock_sub { - Event::one_event; - })->(); + async { Event::one_event }; }; cfg_load; @@ -1999,7 +2219,49 @@ } ############################################################################# -# initialisation +# initialisation and cleanup + +# install some emergency cleanup handlers +BEGIN { + for my $signal (qw(INT HUP TERM)) { + Event->signal ( + data => WF_AUTOCANCEL, + signal => $signal, + cb => sub { + cf::cleanup "SIG$signal"; + }, + ); + } +} + +sub emergency_save() { + my $freeze_guard = cf::freeze_mainloop; + + warn "enter emergency perl save\n"; + + cf::sync_job { + # use a peculiar iteration method to avoid tripping on perl + # refcount bugs in for. also avoids problems with players + # and maps saved/destroyed asynchronously. + warn "begin emergency player save\n"; + for my $login (keys %cf::PLAYER) { + my $pl = $cf::PLAYER{$login} or next; + $pl->valid or next; + $pl->save; + } + warn "end emergency player save\n"; + + warn "begin emergency map save\n"; + for my $path (keys %cf::MAP) { + my $map = $cf::MAP{$path} or next; + $map->valid or next; + $map->save; + } + warn "end emergency map save\n"; + }; + + warn "leave emergency perl save\n"; +} sub reload() { # can/must only be called in main @@ -2010,28 +2272,48 @@ warn "reloading..."; - local $FREEZE = 1; + warn "freezing server"; + my $guard = freeze_mainloop; cf::emergency_save; + warn "sync database to disk"; + cf::db_sync; + IO::AIO::flush; + eval { # if anything goes wrong in here, we should simply crash as we already saved - # cancel all watchers + warn "cancel all watchers"; for (Event::all_watchers) { $_->cancel if $_->data & WF_AUTOCANCEL; } - # cancel all extension coros + warn "cancel all extension coros"; $_->cancel for values %EXT_CORO; %EXT_CORO = (); - # unload all extensions - for (@exts) { - warn "unloading <$_>"; - unload_extension $_; + warn "remove commands"; + %COMMAND = (); + + warn "remove ext commands"; + %EXTCMD = (); + + warn "unload/nuke all extensions"; + for my $pkg (@EXTS) { + warn "... unloading $pkg"; + + if (my $cb = $pkg->can ("unload")) { + eval { + $cb->($pkg); + 1 + } or warn "$pkg unloaded, but with errors: $@"; + } + + warn "... nuking $pkg"; + Symbol::delete_package $pkg; } - # unload all modules loaded from $LIBDIR + warn "unload all perl modules loaded from $LIBDIR"; while (my ($k, $v) = each %INC) { next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; @@ -2048,40 +2330,32 @@ Symbol::delete_package $k; } - # sync database to disk - cf::db_sync; - IO::AIO::flush; - - # get rid of safe::, as good as possible + warn "get rid of safe::, as good as possible"; Symbol::delete_package "safe::$_" for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); - # remove register_script_function callbacks - # TODO - - # unload cf.pm "a bit" + warn "unload cf.pm \"a bit\""; delete $INC{"cf.pm"}; # don't, removes xs symbols, too, # and global variables created in xs #Symbol::delete_package __PACKAGE__; - # reload cf.pm warn "reloading cf.pm"; require cf; cf::_connect_to_perl; # nominally unnecessary, but cannot hurt - # load config and database again + warn "load config and database again"; cf::cfg_load; cf::db_load; - # load extensions warn "load extensions"; cf::load_extensions; - # reattach attachments to objects - warn "reattach"; + warn "reattach attachments to objects/players"; _global_reattach; + warn "reattach attachments to maps"; + reattach $_ for values %MAP; }; if ($@) { @@ -2090,54 +2364,9 @@ exit 1; } - warn "reloaded successfully"; + warn "reloaded"; }; -############################################################################# - -unless ($LINK_MAP) { - $LINK_MAP = cf::map::new; - - $LINK_MAP->width (41); - $LINK_MAP->height (41); - $LINK_MAP->alloc; - $LINK_MAP->path ("{link}"); - $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path"; - $LINK_MAP->in_memory (MAP_IN_MEMORY); - - # dirty hack because... archetypes are not yet loaded - Event->timer ( - after => 2, - cb => sub { - $_[0]->w->cancel; - - # provide some exits "home" - my $exit = cf::object::new "exit"; - - $exit->slaying ($EMERGENCY_POSITION->[0]); - $exit->stats->hp ($EMERGENCY_POSITION->[1]); - $exit->stats->sp ($EMERGENCY_POSITION->[2]); - - $LINK_MAP->insert ($exit->clone, 19, 19); - $LINK_MAP->insert ($exit->clone, 19, 20); - $LINK_MAP->insert ($exit->clone, 19, 21); - $LINK_MAP->insert ($exit->clone, 20, 19); - $LINK_MAP->insert ($exit->clone, 20, 21); - $LINK_MAP->insert ($exit->clone, 21, 19); - $LINK_MAP->insert ($exit->clone, 21, 20); - $LINK_MAP->insert ($exit->clone, 21, 21); - - $exit->destroy; - }); - - $LINK_MAP->{deny_save} = 1; - $LINK_MAP->{deny_reset} = 1; - - $cf::MAP{$LINK_MAP->path} = $LINK_MAP; -} - -register "", __PACKAGE__; - register_command "reload" => sub { my ($who, $arg) = @_; @@ -2156,13 +2385,15 @@ at => $NEXT_TICK || $TICK, data => WF_AUTOCANCEL, cb => sub { - unless ($FREEZE) { - cf::server_tick; # one server iteration - $RUNTIME += $TICK; - } + $NOW = Event::time; + cf::server_tick; # one server iteration + $RUNTIME += $TICK; $NEXT_TICK += $TICK; + $WAIT_FOR_TICK->broadcast; + $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited; + # if we are delayed by four ticks or more, skip them all $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; @@ -2193,5 +2424,7 @@ }, ); +END { cf::emergency_save } + 1