--- deliantra/server/lib/cf.pm 2007/01/07 02:39:14 1.143 +++ deliantra/server/lib/cf.pm 2007/01/10 22:50:12 1.159 @@ -17,24 +17,28 @@ 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 (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority -sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload - our %COMMAND = (); our %COMMAND_TIME = (); + +our @EXTS = (); # list of extension package names our %EXTCMD = (); +our %EXT_CORO = (); # coroutines bound to extensions our @EVENT; our $LIBDIR = datadir . "/ext"; @@ -53,7 +57,9 @@ our %MAP; # all maps our $LINK_MAP; # the special {link} map our $RANDOM_MAPS = cf::localdir . "/random"; -our %EXT_CORO; # coroutines bound to extensions + +our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal; +our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal; binmode STDOUT; binmode STDERR; @@ -108,6 +114,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 @@ -120,7 +133,7 @@ $msg .= "\n" unless $msg =~ /\n$/; - LOG llevError, "cfperl: $msg"; + LOG llevError, $msg; }; } @@ -148,16 +161,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 @@ -289,7 +319,7 @@ =item $coro = cf::async_ext { BLOCK } -Like async, but this coro is automcatially being canceled when the +Like async, but this coro is automatically being canceled when the extension calling this is being unloaded. =cut @@ -337,6 +367,12 @@ package cf::path; +use overload + '""' => \&as_string; + +# used to convert map paths into valid unix filenames by repalcing / by ∕ +our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons + sub new { my ($class, $path, $base) = @_; @@ -352,6 +388,8 @@ # ~/... per-player maps without a specific player (DO NOT USE) # ~user/... per-player map of a specific user + $path =~ s/$PATH_SEP/\//go; + if ($path =~ /^{/) { # fine as it is } elsif ($path =~ s{^\?random/}{}) { @@ -409,8 +447,7 @@ # escape the /'s in the path sub _escaped_path { - # ∕ is U+2215 - (my $path = $_[0]{path}) =~ s/\//∕/g; + (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; $path } @@ -908,10 +945,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 ( @@ -934,7 +968,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); } } @@ -946,12 +980,6 @@ }, ); -sub register { - my ($base, $pkg) = @_; - - #TODO -} - sub load_extension { my ($path) = @_; @@ -976,50 +1004,7 @@ or die $@ ? "$path: $@\n" : "extension disabled.\n"; - push @exts, $pkg; - $ext_pkg{$base} = $pkg; - -# no strict 'refs'; -# @{"$pkg\::ISA"} = ext::; - - register $base, $pkg; -} - -sub unload_extension { - my ($pkg) = @_; - - warn "removing extension $pkg\n"; - - # remove hooks - #TODO -# for my $idx (0 .. $#PLUGIN_EVENT) { -# delete $hook[$idx]{$pkg}; -# } - - # remove commands - for my $name (keys %COMMAND) { - my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} }; - - if (@cb) { - $COMMAND{$name} = \@cb; - } else { - delete $COMMAND{$name}; - } - } - - # remove extcmds - for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) { - delete $EXTCMD{$name}; - } - - if (my $cb = $pkg->can ("unload")) { - eval { - $cb->($pkg); - 1 - } or warn "$pkg unloaded, but with errors: $@"; - } - - Symbol::delete_package $pkg; + push @EXTS, $pkg; } sub load_extensions { @@ -1047,28 +1032,6 @@ cf::map->attach (prio => -10000, package => cf::mapsupport::); ############################################################################# -# load/save perl data associated with player->ob objects - -sub all_objects(@) { - @_, map all_objects ($_->inv), @_ -} - -# TODO: compatibility cruft, remove when no longer needed -cf::player->attach ( - on_load => sub { - my ($pl, $path) = @_; - - for my $o (all_objects $pl->ob) { - if (my $value = $o->get_ob_key_value ("_perl_data")) { - $o->set_ob_key_value ("_perl_data"); - - %$o = %{ Storable::thaw pack "H*", $value }; - } - } - }, -); - -############################################################################# =head2 CORE EXTENSIONS @@ -1078,6 +1041,8 @@ package cf::player; +use Coro::AIO; + =head3 cf::player =over 4 @@ -1088,10 +1053,18 @@ =cut +sub playerdir($) { + cf::localdir + . "/" + . cf::playerdir + . "/" + . (ref $_[0] ? $_[0]->ob->name : $_[0]) +} + sub path($) { - sprintf "%s/%s/%s/%s.pl", - cf::localdir, cf::playerdir, - (ref $_[0] ? $_[0]->ob->name : $_[0]) x 2 + my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; + + (playerdir $login) . "/$login.pl" } sub find_active($) { @@ -1113,8 +1086,12 @@ my $guard = cf::lock_acquire "user_find:$login"; - $cf::PLAYER{$login} ||= (load_pl path $login or return); - }; + $cf::PLAYER{$_[0]} || do { + my $pl = load_pl path $login + or return; + $cf::PLAYER{$login} = $pl + } + } } sub save($) { @@ -1126,9 +1103,10 @@ my $guard = cf::lock_acquire "user_save:$path"; return if $pl->{deny_save}; + + aio_mkdir playerdir $pl, 0770; $pl->{last_save} = $cf::RUNTIME; - Coro::cede; $pl->save_pl ($path); Coro::cede; } @@ -1146,6 +1124,83 @@ $self } +=item $pl->quit_character + +Nukes the player without looking back. If logged in, the connection will +be destroyed. May block for a long time. + +=cut + +sub quit_character { + my ($pl) = @_; + + $pl->{deny_save} = 1; + $pl->password ("*"); # this should lock out the player until we nuked the dir + + $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; + $pl->deactivate; + $pl->invoke (cf::EVENT_PLAYER_QUIT); + $pl->ns->destroy if $pl->ns; + + 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; +} + +=item cf::player::list_logins + +Returns am arrayref of all valid playernames in the system, can take a +while and may block, so not sync_job-capable, ever. + +=cut + +sub list_logins { + my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir + or return []; + + my @logins; + + 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 + + utf8::decode $login; + push @logins, $login; + } + + \@logins +} + +=item $player->maps + +Returns an arrayref of cf::path's of all maps that are private for this +player. May block. + +=cut + +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; + + push @paths, new cf::path "~" . $pl->ob->name . "/" . $_; + } + + \@paths +} + =item $player->ext_reply ($msgid, $msgtype, %msg) Sends an ext reply to the player. @@ -1336,10 +1391,34 @@ $self->in_memory (cf::MAP_IN_MEMORY); } +# 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) = @_; - cf::sync_job { cf::map::find $path, $origin } + cf::sync_job { find $path, $origin } } sub do_load_sync { @@ -1348,6 +1427,38 @@ cf::sync_job { $map->load }; } +our %MAP_PREFETCH; +our $MAP_PREFETCHER = Coro::async { + while () { + while (%MAP_PREFETCH) { + my $key = each %MAP_PREFETCH + or next; + my $path = delete $MAP_PREFETCH{$key}; + + my $map = find $path + or next; + $map->load; + } + Coro::schedule; + } +}; + +sub find_async { + my ($path, $origin) = @_; + + $path = new cf::path $path, $origin && $origin->path; + my $key = $path->as_string; + + if (my $map = $cf::MAP{$key}) { + return $map if $map->in_memory == cf::MAP_IN_MEMORY; + } + + $MAP_PREFETCH{$key} = $path; + $MAP_PREFETCHER->ready; + + () +} + sub save { my ($self) = @_; @@ -1473,23 +1584,60 @@ $map } -sub emergency_save { - my $freeze_guard = cf::freeze_mainloop; +=item cf::map::unique_maps - warn "enter emergency map save\n"; +Returns an arrayref of cf::path's of all shared maps that have +instantiated unique items. May block. - cf::sync_job { - warn "begin emergency map save\n"; - $_->save for values %cf::MAP; - }; +=cut + +sub unique_maps() { + my $files = aio_readdir cf::localdir . "/" . cf::uniquedir + or return; - warn "end emergency map save\n"; + my @paths; + + for (@$files) { + utf8::decode $_; + next if /\.pst$/; + next unless /^$PATH_SEP/o; + + push @paths, new cf::path $_; + } + + \@paths } package cf; =back +=head3 cf::object + +=cut + +package cf::object; + +=over 4 + +=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 @@ -1591,6 +1739,7 @@ if $x <=0 && $y <= 0; $map->load; + $map->load_diag; return unless $self->contr->active; $self->activate_recursive; @@ -1636,18 +1785,18 @@ sub cf::object::player::goto { my ($self, $path, $x, $y) = @_; + $path = new cf::path $path; + $self->enter_link; (async { - $path = new cf::path $path; - my $map = cf::map::find $path->as_string; $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); @@ -1723,7 +1872,7 @@ }) { $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: $@"; @@ -2065,7 +2214,7 @@ if (exists $CFG{mlockall}) { eval { - $CFG{mlockall} ? &mlockall : &munlockall + $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()" and die "WARNING: m(un)lockall failed: $!\n"; }; warn $@ if $@; @@ -2086,7 +2235,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 @@ -2097,28 +2288,47 @@ warn "reloading..."; + 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: $@"; + } + + 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$/; @@ -2135,40 +2345,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 ($@) { @@ -2177,7 +2379,7 @@ exit 1; } - warn "reloaded successfully"; + warn "reloaded"; }; ############################################################################# @@ -2223,8 +2425,6 @@ $cf::MAP{$LINK_MAP->path} = $LINK_MAP; } -register "", __PACKAGE__; - register_command "reload" => sub { my ($who, $arg) = @_; @@ -2247,6 +2447,9 @@ $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;