ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
(Generate patch)

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.269 by root, Tue May 22 21:35:26 2007 UTC vs.
Revision 1.623 by root, Wed Aug 30 14:18:51 2017 UTC

1#
2# This file is part of Deliantra, the Roguelike Realtime MMORPG.
3#
4# Copyright (©) 2006,2007,2008,2009,2010,2011,2012 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5#
6# Deliantra is free software: you can redistribute it and/or modify it under
7# the terms of the Affero GNU General Public License as published by the
8# Free Software Foundation, either version 3 of the License, or (at your
9# 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 Affero GNU General Public License
17# and the GNU General Public License along with this program. If not, see
18# <http://www.gnu.org/licenses/>.
19#
20# The authors can be reached via e-mail to <support@deliantra.net>
21#
22
1package cf; 23package cf;
2 24
3use utf8; 25use common::sense;
4use strict;
5 26
6use Symbol; 27use Symbol;
7use List::Util; 28use List::Util;
8use Socket; 29use Socket;
9use Storable; 30use EV;
10use Event;
11use Opcode; 31use Opcode;
12use Safe; 32use Safe;
13use Safe::Hole; 33use Safe::Hole;
34use Storable ();
35use Carp ();
14 36
37use AnyEvent ();
38use AnyEvent::IO ();
39use AnyEvent::DNS ();
40
15use Coro 3.61 (); 41use Coro ();
16use Coro::State; 42use Coro::State;
17use Coro::Handle; 43use Coro::Handle;
44use Coro::EV;
18use Coro::Event; 45use Coro::AnyEvent;
19use Coro::Timer; 46use Coro::Timer;
20use Coro::Signal; 47use Coro::Signal;
21use Coro::Semaphore; 48use Coro::Semaphore;
49use Coro::SemaphoreSet;
50use Coro::AnyEvent;
22use Coro::AIO; 51use Coro::AIO;
52use Coro::BDB 1.6;
23use Coro::Storable; 53use Coro::Storable;
54use Coro::Util ();
24 55
56use Guard ();
57use JSON::XS 2.01 ();
25use BDB (); 58use BDB ();
26use Data::Dumper; 59use Data::Dumper;
27use Digest::MD5;
28use Fcntl; 60use Fcntl;
29use YAML::Syck (); 61use YAML::XS ();
62use CBOR::XS ();
30use IO::AIO 2.32 (); 63use IO::AIO ();
31use Time::HiRes;
32use Compress::LZF; 64use Compress::LZF;
65use Digest::MD5 ();
66
67AnyEvent::detect;
33 68
34# configure various modules to our taste 69# configure various modules to our taste
35# 70#
36$Storable::canonical = 1; # reduce rsync transfers 71$Storable::canonical = 1; # reduce rsync transfers
37Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator 72Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
73
74$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
75
76# make sure c-lzf reinitialises itself
77Compress::LZF::set_serializer "Storable", "Storable::net_mstore", "Storable::mretrieve";
38Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later 78Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
39 79
40$Event::Eval = 1; # no idea why this is required, but it is 80# strictly for debugging
41 81$SIG{QUIT} = sub { Carp::cluck "SIGQUIT" };
42# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
43$YAML::Syck::ImplicitUnicode = 1;
44
45$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
46 82
47sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload 83sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
84
85our @ORIG_INC;
48 86
49our %COMMAND = (); 87our %COMMAND = ();
50our %COMMAND_TIME = (); 88our %COMMAND_TIME = ();
51 89
52our @EXTS = (); # list of extension package names 90our @EXTS = (); # list of extension package names
53our %EXTCMD = (); 91our %EXTCMD = ();
92our %EXTACMD = ();
93our %EXTICMD = ();
94our %EXTIACMD = ();
54our %EXT_CORO = (); # coroutines bound to extensions 95our %EXT_CORO = (); # coroutines bound to extensions
55our %EXT_MAP = (); # pluggable maps 96our %EXT_MAP = (); # pluggable maps
56 97
57our $RELOAD; # number of reloads so far 98our $RELOAD; # number of reloads so far, non-zero while in reload
58our @EVENT; 99our @EVENT;
100our @REFLECT; # set by XS
101our %REFLECT; # set by us
59 102
60our $CONFDIR = confdir; 103our $CONFDIR = confdir;
104
61our $DATADIR = datadir; 105our $DATADIR = datadir;
62our $LIBDIR = "$DATADIR/ext"; 106our $LIBDIR = "$DATADIR/ext";
63our $PODDIR = "$DATADIR/pod"; 107our $PODDIR = "$DATADIR/pod";
64our $MAPDIR = "$DATADIR/" . mapdir; 108our $MAPDIR = "$DATADIR/" . mapdir;
109
65our $LOCALDIR = localdir; 110our $LOCALDIR = localdir;
66our $TMPDIR = "$LOCALDIR/" . tmpdir; 111our $TMPDIR = "$LOCALDIR/" . tmpdir;
67our $UNIQUEDIR = "$LOCALDIR/" . uniquedir; 112our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
68our $PLAYERDIR = "$LOCALDIR/" . playerdir; 113our $PLAYERDIR = "$LOCALDIR/" . playerdir;
69our $RANDOMDIR = "$LOCALDIR/random"; 114our $RANDOMDIR = "$LOCALDIR/random";
70our $BDBDIR = "$LOCALDIR/db"; 115our $BDBDIR = "$LOCALDIR/db";
116our $PIDFILE = "$LOCALDIR/pid";
117our $RUNTIMEFILE = "$LOCALDIR/runtime";
118
119#our %RESOURCE; # unused
120
121our $OUTPUT_RATE_MIN = 3000;
122our $OUTPUT_RATE_MAX = 1000000;
123
124our $MAX_LINKS = 32; # how many chained exits to follow
125our $VERBOSE_IO = 1;
71 126
72our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!) 127our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
73our $TICK_WATCHER;
74our $AIO_POLL_WATCHER;
75our $NEXT_RUNTIME_WRITE; # when should the runtime file be written 128our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
76our $NEXT_TICK; 129our $NEXT_TICK;
130our $USE_FSYNC = 1; # use fsync to write maps - default on
131
132our $BDB_DEADLOCK_WATCHER;
133our $BDB_CHECKPOINT_WATCHER;
134our $BDB_TRICKLE_WATCHER;
135our $DB_ENV;
136
137our @EXTRA_MODULES = qw(pod match mapscript incloader);
138
139our %CFG;
140our %EXT_CFG; # cfgkeyname => [var-ref, defaultvalue]
141
142our $UPTIME; $UPTIME ||= time;
143our $RUNTIME = 0;
144our $SERVER_TICK = 0;
77our $NOW; 145our $NOW;
78our $USE_FSYNC = 1; # use fsync to write maps - default off
79 146
80our $BDB_POLL_WATCHER; 147our (%PLAYER, %PLAYER_LOADING); # all users
81our $DB_ENV; 148our (%MAP, %MAP_LOADING ); # all maps
82
83our %CFG;
84
85our $UPTIME; $UPTIME ||= time;
86our $RUNTIME;
87
88our %PLAYER; # all users
89our %MAP; # all maps
90our $LINK_MAP; # the special {link} map, which is always available 149our $LINK_MAP; # the special {link} map, which is always available
91 150
92# used to convert map paths into valid unix filenames by replacing / by ∕ 151# used to convert map paths into valid unix filenames by replacing / by ∕
93our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 152our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
94 153
95our $LOAD; # a number between 0 (idle) and 1 (too many objects) 154our $LOAD; # a number between 0 (idle) and 1 (too many objects)
96our $LOADAVG; # same thing, but with alpha-smoothing 155our $LOADAVG; # same thing, but with alpha-smoothing
156our $JITTER; # average jitter
97our $tick_start; # for load detecting purposes 157our $TICK_START; # for load detecting purposes
158
159our @POST_INIT;
160
161our $REATTACH_ON_RELOAD; # set to true to force object reattach on reload (slow)
162our $REALLY_UNLOOP; # never set to true, please :)
163
164our $WAIT_FOR_TICK = new Coro::Signal;
165our @WAIT_FOR_TICK_BEGIN;
98 166
99binmode STDOUT; 167binmode STDOUT;
100binmode STDERR; 168binmode STDERR;
101 169
102# read virtual server time, if available 170# read virtual server time, if available
103unless ($RUNTIME || !-e "$LOCALDIR/runtime") { 171unless ($RUNTIME || !-e $RUNTIMEFILE) {
104 open my $fh, "<", "$LOCALDIR/runtime" 172 open my $fh, "<", $RUNTIMEFILE
105 or die "unable to read runtime file: $!"; 173 or die "unable to read $RUNTIMEFILE file: $!";
106 $RUNTIME = <$fh> + 0.; 174 $RUNTIME = <$fh> + 0.;
107} 175}
176
177eval "sub TICK() { $TICK } 1" or die;
108 178
109mkdir $_ 179mkdir $_
110 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR; 180 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
111 181
112our $EMERGENCY_POSITION; 182our $EMERGENCY_POSITION;
113 183
114sub cf::map::normalise; 184sub cf::map::normalise;
115 185
186sub in_main() {
187 $Coro::current == $Coro::main
188}
189
116############################################################################# 190#############################################################################
117 191
192%REFLECT = ();
193for (@REFLECT) {
194 my $reflect = JSON::XS::decode_json $_;
195 $REFLECT{$reflect->{class}} = $reflect;
196}
197
198# this is decidedly evil
199$REFLECT{object}{flags} = { map +($_ => undef), grep $_, map /^FLAG_([A-Z0-9_]+)$/ && lc $1, keys %{"cf::"} };
200
201#############################################################################
202
118=head2 GLOBAL VARIABLES 203=head2 GLOBAL VARIABLES
119 204
120=over 4 205=over 4
121 206
122=item $cf::UPTIME 207=item $cf::UPTIME
123 208
124The timestamp of the server start (so not actually an uptime). 209The timestamp of the server start (so not actually an "uptime").
210
211=item $cf::SERVER_TICK
212
213An unsigned integer that starts at zero when the server is started and is
214incremented on every tick.
215
216=item $cf::NOW
217
218The (real) time of the last (current) server tick - updated before and
219after tick processing, so this is useful only as a rough "what time is it
220now" estimate.
221
222=item $cf::TICK
223
224The interval between each server tick, in seconds.
125 225
126=item $cf::RUNTIME 226=item $cf::RUNTIME
127 227
128The time this server has run, starts at 0 and is increased by $cf::TICK on 228The time this server has run, starts at 0 and is increased by $cf::TICK on
129every server tick. 229every server tick.
130 230
131=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR 231=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
132$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR 232$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
133$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR 233$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
134 234
135Various directories - "/etc", read-only install directory, perl-library 235Various directories - "/etc", read-only install directory, perl-library
136directory, pod-directory, read-only maps directory, "/var", "/var/tmp", 236directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
137unique-items directory, player file directory, random maps directory and 237unique-items directory, player file directory, random maps directory and
138database environment. 238database environment.
139 239
140=item $cf::NOW
141
142The time of the last (current) server tick.
143
144=item $cf::TICK
145
146The interval between server ticks, in seconds.
147
148=item $cf::LOADAVG 240=item $cf::LOADAVG
149 241
150The current CPU load on the server (alpha-smoothed), as a value between 0 242The current CPU load on the server (alpha-smoothed), as a value between 0
151(none) and 1 (overloaded), indicating how much time is spent on processing 243(none) and 1 (overloaded), indicating how much time is spent on processing
152objects per tick. Healthy values are < 0.5. 244objects per tick. Healthy values are < 0.5.
155 247
156The raw value load value from the last tick. 248The raw value load value from the last tick.
157 249
158=item %cf::CFG 250=item %cf::CFG
159 251
160Configuration for the server, loaded from C</etc/crossfire/config>, or 252Configuration for the server, loaded from C</etc/deliantra-server/config>, or
161from wherever your confdir points to. 253from wherever your confdir points to.
162 254
163=item cf::wait_for_tick, cf::wait_for_tick_begin 255=item cf::wait_for_tick, cf::wait_for_tick_begin
164 256
165These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only 257These are functions that inhibit the current coroutine one tick.
166returns directly I<after> the tick processing (and consequently, can only wake one process 258cf::wait_for_tick_begin only returns directly I<after> the tick
259processing (and consequently, can only wake one thread per tick), while
167per tick), while cf::wait_for_tick wakes up all waiters after tick processing. 260cf::wait_for_tick wakes up all waiters after tick processing.
261
262Note that cf::wait_for_tick will immediately return when the server is not
263ticking, making it suitable for small pauses in threads that need to run
264when the server is paused. If that is not applicable (i.e. you I<really>
265want to wait, use C<$cf::WAIT_FOR_TICK>).
266
267=item $cf::WAIT_FOR_TICK
268
269Note that C<cf::wait_for_tick> is probably the correct thing to use. This
270variable contains a L<Coro::Signal> that is broadcats after every server
271tick. Calling C<< ->wait >> on it will suspend the caller until after the
272next server tick.
273
274=cut
275
276sub wait_for_tick();
277sub wait_for_tick_begin();
278
279=item @cf::INVOKE_RESULTS
280
281This array contains the results of the last C<invoke ()> call. When
282C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
283that call.
284
285=item %cf::REFLECT
286
287Contains, for each (C++) class name, a hash reference with information
288about object members (methods, scalars, arrays and flags) and other
289metadata, which is useful for introspection.
168 290
169=back 291=back
170 292
171=cut 293=cut
172 294
173BEGIN { 295sub error(@) { LOG llevError, join "", @_ }
174 *CORE::GLOBAL::warn = sub { 296sub warn (@) { LOG llevWarn , join "", @_ }
297sub info (@) { LOG llevInfo , join "", @_ }
298sub debug(@) { LOG llevDebug, join "", @_ }
299sub trace(@) { LOG llevTrace, join "", @_ }
300
301$Coro::State::WARNHOOK = sub {
175 my $msg = join "", @_; 302 my $msg = join "", @_;
176 303
177 $msg .= "\n" 304 $msg .= "\n"
178 unless $msg =~ /\n$/; 305 unless $msg =~ /\n$/;
179 306
180 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge; 307 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
181 308
182 utf8::encode $msg;
183 LOG llevError, $msg; 309 LOG llevWarn, $msg;
184 }; 310};
185} 311
312$Coro::State::DIEHOOK = sub {
313 return unless $^S eq 0; # "eq", not "=="
314
315 error Carp::longmess $_[0];
316
317 if (in_main) {#d#
318 error "DIEHOOK called in main context, Coro bug?\n";#d#
319 return;#d#
320 }#d#
321
322 # kill coroutine otherwise
323 Coro::terminate
324};
186 325
187@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 326@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
188@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 327@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
189@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 328@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
190@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 329@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
191@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 330@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
331@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
192@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 332@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
193 333
194# we bless all objects into (empty) derived classes to force a method lookup 334# we bless all objects into (empty) derived classes to force a method lookup
195# within the Safe compartment. 335# within the Safe compartment.
196for my $pkg (qw( 336for my $pkg (qw(
197 cf::global cf::attachable 337 cf::global cf::attachable
198 cf::object cf::object::player 338 cf::object cf::object::player
199 cf::client cf::player 339 cf::client cf::player
200 cf::arch cf::living 340 cf::arch cf::living
341 cf::map cf::mapspace
201 cf::map cf::party cf::region 342 cf::party cf::region
202)) { 343)) {
203 no strict 'refs';
204 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 344 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
205} 345}
206 346
207$Event::DIED = sub { 347$EV::DIED = sub {
208 warn "error in event callback: @_"; 348 warn "error in event callback: $@";
209}; 349};
350
351#############################################################################
352
353sub fork_call(&@);
354sub get_slot($;$$);
355
356#############################################################################
210 357
211=head2 UTILITY FUNCTIONS 358=head2 UTILITY FUNCTIONS
212 359
213=over 4 360=over 4
214 361
233 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 380 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
234 $d 381 $d
235 } || "[unable to dump $_[0]: '$@']"; 382 } || "[unable to dump $_[0]: '$@']";
236} 383}
237 384
238use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working 385=item $scalar = cf::load_file $path
239 386
387Loads the given file from path and returns its contents. Croaks on error
388and can block.
389
390=cut
391
392sub load_file($) {
393 0 <= aio_load $_[0], my $data
394 or Carp::croak "$_[0]: $!";
395
396 $data
397}
398
399=item $success = cf::replace_file $path, $data, $sync
400
401Atomically replaces the file at the given $path with new $data, and
402optionally $sync the data to disk before replacing the file.
403
404=cut
405
406sub replace_file($$;$) {
407 my ($path, $data, $sync) = @_;
408
409 my $lock = cf::lock_acquire ("replace_file:$path");
410
411 my $fh = aio_open "$path~", Fcntl::O_WRONLY | Fcntl::O_CREAT | Fcntl::O_TRUNC, 0644
412 or return;
413
414 $data = $data->() if ref $data;
415
416 length $data == aio_write $fh, 0, (length $data), $data, 0
417 or return;
418
419 !$sync
420 or !aio_fsync $fh
421 or return;
422
423 aio_close $fh
424 and return;
425
426 aio_rename "$path~", $path
427 and return;
428
429 if ($sync) {
430 $path =~ s%/[^/]*$%%;
431 aio_pathsync $path;
432 }
433
434 1
435}
436
240=item $ref = cf::from_json $json 437=item $ref = cf::decode_json $json
241 438
242Converts a JSON string into the corresponding perl data structure. 439Converts a JSON string into the corresponding perl data structure.
243 440
244=item $json = cf::to_json $ref 441=item $json = cf::encode_json $ref
245 442
246Converts a perl data structure into its JSON representation. 443Converts a perl data structure into its JSON representation.
247 444
445=cut
446
447our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
448
449sub encode_json($) { $json_coder->encode ($_[0]) }
450sub decode_json($) { $json_coder->decode ($_[0]) }
451
452=item $ref = cf::decode_storable $scalar
453
454Same as Coro::Storable::thaw, so blocks.
455
456=cut
457
458BEGIN { *decode_storable = \&Coro::Storable::thaw }
459
460=item $ref = cf::decode_yaml $scalar
461
462Same as YAML::XS::Load, but doesn't leak, because it forks (and thus blocks).
463
464=cut
465
466sub decode_yaml($) {
467 fork_call { YAML::XS::Load $_[0] } @_
468}
469
470=item $scalar = cf::decode_cbor $scalar
471
472Same as CBOR::XS::decode_cbor, but takes server ticks into account, so
473blocks. For small amounts of data, C<CBOR::XS::decode_cbor> is the better
474alternative.
475
476=cut
477
478sub decode_cbor($) {
479 # we assume 10mb/s minimum decoding speed (on a ~2ghz machine)
480 cf::get_slot +(length $_[0]) / 10_000_000, 0, "decode_cbor";
481 CBOR::XS::decode_cbor $_[0]
482}
483
484=item $scalar = cf::unlzf $scalar
485
486Same as Compress::LZF::compress, but takes server ticks into account, so
487blocks.
488
489=cut
490
491sub unlzf($) {
492 # we assume 100mb/s minimum decompression speed (noncompressible data on a ~2ghz machine)
493 cf::get_slot +(length $_[0]) / 100_000_000, 0, "unlzf";
494 Compress::LZF::decompress $_[0]
495}
496
497=item cf::post_init { BLOCK }
498
499Execute the given codeblock, I<after> all extensions have been (re-)loaded,
500but I<before> the server starts ticking again.
501
502The codeblock will have a single boolean argument to indicate whether this
503is a reload or not.
504
505=cut
506
507sub post_init(&) {
508 push @POST_INIT, shift;
509}
510
511sub _post_init {
512 trace "running post_init jobs";
513
514 # run them in parallel...
515
516 my @join;
517
518 while () {
519 push @join, map &Coro::async ($_, 0), @POST_INIT;
520 @POST_INIT = ();
521
522 @join or last;
523
524 (pop @join)->join;
525 }
526}
527
248=item cf::lock_wait $string 528=item cf::lock_wait $string
249 529
250Wait until the given lock is available. See cf::lock_acquire. 530Wait until the given lock is available. See cf::lock_acquire.
251 531
252=item my $lock = cf::lock_acquire $string 532=item my $lock = cf::lock_acquire $string
253 533
254Wait until the given lock is available and then acquires it and returns 534Wait until the given lock is available and then acquires it and returns
255a Coro::guard object. If the guard object gets destroyed (goes out of scope, 535a L<Guard> object. If the guard object gets destroyed (goes out of scope,
256for example when the coroutine gets canceled), the lock is automatically 536for example when the coroutine gets canceled), the lock is automatically
257returned. 537returned.
258 538
539Locks are *not* recursive, locking from the same coro twice results in a
540deadlocked coro.
541
259Lock names should begin with a unique identifier (for example, cf::map::find 542Lock names should begin with a unique identifier (for example, cf::map::find
260uses map_find and cf::map::load uses map_load). 543uses map_find and cf::map::load uses map_load).
261 544
262=item $locked = cf::lock_active $string 545=item $locked = cf::lock_active $string
263 546
264Return true if the lock is currently active, i.e. somebody has locked it. 547Return true if the lock is currently active, i.e. somebody has locked it.
265 548
266=cut 549=cut
267 550
268our %LOCK; 551our $LOCKS = new Coro::SemaphoreSet;
269 552
270sub lock_wait($) { 553sub lock_wait($) {
271 my ($key) = @_; 554 $LOCKS->wait ($_[0]);
272
273 # wait for lock, if any
274 while ($LOCK{$key}) {
275 push @{ $LOCK{$key} }, $Coro::current;
276 Coro::schedule;
277 }
278} 555}
279 556
280sub lock_acquire($) { 557sub lock_acquire($) {
281 my ($key) = @_; 558 $LOCKS->guard ($_[0])
282
283 # wait, to be sure we are not locked
284 lock_wait $key;
285
286 $LOCK{$key} = [];
287
288 Coro::guard {
289 # wake up all waiters, to be on the safe side
290 $_->ready for @{ delete $LOCK{$key} };
291 }
292} 559}
293 560
294sub lock_active($) { 561sub lock_active($) {
295 my ($key) = @_; 562 $LOCKS->count ($_[0]) < 1
296
297 ! ! $LOCK{$key}
298} 563}
299 564
300sub freeze_mainloop { 565sub freeze_mainloop {
301 return unless $TICK_WATCHER->is_active; 566 tick_inhibit_inc;
302 567
303 my $guard = Coro::guard { 568 &Guard::guard (\&tick_inhibit_dec);
304 $TICK_WATCHER->start; 569}
570
571=item cf::periodic $interval, $cb
572
573Like EV::periodic, but randomly selects a starting point so that the actions
574get spread over time.
575
576=cut
577
578sub periodic($$) {
579 my ($interval, $cb) = @_;
580
581 my $start = rand List::Util::min 180, $interval;
582
583 EV::periodic $start, $interval, 0, $cb
584}
585
586=item cf::get_slot $time[, $priority[, $name]]
587
588Allocate $time seconds of blocking CPU time at priority C<$priority>
589(default: 0): This call blocks and returns only when you have at least
590C<$time> seconds of cpu time till the next tick. The slot is only valid
591till the next cede.
592
593Background jobs should use a priority less than zero, interactive jobs
594should use 100 or more.
595
596The optional C<$name> can be used to identify the job to run. It might be
597used for statistical purposes and should identify the same time-class.
598
599Useful for short background jobs.
600
601=cut
602
603our @SLOT_QUEUE;
604our $SLOT_QUEUE;
605our $SLOT_DECAY = 0.9;
606
607$SLOT_QUEUE->cancel if $SLOT_QUEUE;
608$SLOT_QUEUE = Coro::async {
609 $Coro::current->desc ("timeslot manager");
610
611 my $signal = new Coro::Signal;
612 my $busy;
613
614 while () {
615 next_job:
616
617 Coro::cede;
618
619 my $avail = cf::till_tick;
620
621 for (0 .. $#SLOT_QUEUE) {
622 if ($SLOT_QUEUE[$_][0] <= $avail) {
623 $busy = 0;
624 my $job = splice @SLOT_QUEUE, $_, 1, ();
625 $job->[2]->send;
626 goto next_job;
627 } else {
628 $SLOT_QUEUE[$_][0] *= $SLOT_DECAY;
629 }
630 }
631
632 if (@SLOT_QUEUE) {
633 wait_for_tick;
634 } else {
635 $busy = 0;
636 Coro::schedule;
637 }
305 }; 638 }
306 $TICK_WATCHER->stop; 639};
307 $guard 640
641sub get_slot($;$$) {
642 return if tick_inhibit || $Coro::current == $Coro::main;
643
644 my ($time, $pri, $name) = @_;
645
646 $time = clamp $time, 0.01, $TICK * .6;
647
648 my $sig = new Coro::Signal;
649
650 push @SLOT_QUEUE, [$time, $pri, $sig, $name];
651 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
652 $SLOT_QUEUE->ready;
653 $sig->wait;
308} 654}
309 655
310=item cf::async { BLOCK } 656=item cf::async { BLOCK }
311 657
312Currently the same as Coro::async_pool, meaning you cannot use 658Currently the same as Coro::async_pool, meaning you cannot use
317 663
318BEGIN { *async = \&Coro::async_pool } 664BEGIN { *async = \&Coro::async_pool }
319 665
320=item cf::sync_job { BLOCK } 666=item cf::sync_job { BLOCK }
321 667
322The design of crossfire+ requires that the main coro ($Coro::main) is 668The design of Deliantra requires that the main coroutine ($Coro::main)
323always able to handle events or runnable, as crossfire+ is only partly 669is always able to handle events or is runnable, as Deliantra is only
324reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 670partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
671acceptable.
325 672
326If it must be done, put the blocking parts into C<sync_job>. This will run 673If it must be done, put the blocking parts into C<sync_job>. This will run
327the given BLOCK in another coroutine while waiting for the result. The 674the given BLOCK in another coroutine while waiting for the result. The
328server will be frozen during this time, so the block should either finish 675server will be frozen during this time, so the block should either finish
329fast or be very important. 676fast or be very important.
331=cut 678=cut
332 679
333sub sync_job(&) { 680sub sync_job(&) {
334 my ($job) = @_; 681 my ($job) = @_;
335 682
336 if ($Coro::current == $Coro::main) { 683 if (in_main) {
337 my $time = Event::time; 684 my $time = AE::time;
338 685
339 # this is the main coro, too bad, we have to block 686 # this is the main coro, too bad, we have to block
340 # till the operation succeeds, freezing the server :/ 687 # till the operation succeeds, freezing the server :/
341 688
342 # TODO: use suspend/resume instead 689 #LOG llevError, Carp::longmess "sync job";#d#
343 # (but this is cancel-safe) 690
344 my $freeze_guard = freeze_mainloop; 691 my $freeze_guard = freeze_mainloop;
345 692
346 my $busy = 1; 693 my $busy = 1;
347 my @res; 694 my @res;
348 695
349 (async { 696 (async {
697 $Coro::current->desc ("sync job coro");
350 @res = eval { $job->() }; 698 @res = eval { $job->() };
351 warn $@ if $@; 699 error $@ if $@;
352 undef $busy; 700 undef $busy;
353 })->prio (Coro::PRIO_MAX); 701 })->prio (Coro::PRIO_MAX);
354 702
355 while ($busy) { 703 while ($busy) {
356 Coro::cede or Event::one_event; 704 if (Coro::nready) {
705 Coro::cede_notself;
706 } else {
707 EV::run EV::RUN_ONCE;
357 } 708 }
709 }
358 710
359 $time = Event::time - $time; 711 my $time = AE::time - $time;
360 712
361 LOG llevError | logBacktrace, Carp::longmess "long sync job"
362 if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
363
364 $tick_start += $time; # do not account sync jobs to server load 713 $TICK_START += $time; # do not account sync jobs to server load
365 714
366 wantarray ? @res : $res[0] 715 wantarray ? @res : $res[0]
367 } else { 716 } else {
368 # we are in another coroutine, how wonderful, everything just works 717 # we are in another coroutine, how wonderful, everything just works
369 718
389 $EXT_CORO{$coro+0} = $coro; 738 $EXT_CORO{$coro+0} = $coro;
390 739
391 $coro 740 $coro
392} 741}
393 742
394sub write_runtime { 743=item fork_call { }, @args
395 my $runtime = "$LOCALDIR/runtime";
396 744
397 # first touch the runtime file to show we are still running: 745Executes the given code block with the given arguments in a seperate
398 # the fsync below can take a very very long time. 746process, returning the results. Everything must be serialisable with
747Coro::Storable. May, of course, block. Note that the executed sub may
748never block itself or use any form of event handling.
399 749
400 if (my $fh = aio_open $runtime, O_WRONLY, 0) { 750=cut
401 utime undef, undef, $fh; 751
752sub post_fork {
753 reset_signals;
754}
755
756sub fork_call(&@) {
757 my ($cb, @args) = @_;
758
759 my @res = Coro::Util::fork_eval {
760 cf::post_fork;
761 &$cb
762 } @args;
763
764 wantarray ? @res : $res[-1]
765}
766
767sub objinfo {
768 (
769 "counter value" => cf::object::object_count,
770 "objects created" => cf::object::create_count,
771 "objects destroyed" => cf::object::destroy_count,
772 "freelist size" => cf::object::free_count,
773 "allocated objects" => cf::object::objects_size,
774 "active objects" => cf::object::actives_size,
775 )
776}
777
778=item $coin = coin_from_name $name
779
780=cut
781
782our %coin_alias = (
783 "silver" => "silvercoin",
784 "silvercoin" => "silvercoin",
785 "silvercoins" => "silvercoin",
786 "gold" => "goldcoin",
787 "goldcoin" => "goldcoin",
788 "goldcoins" => "goldcoin",
789 "platinum" => "platinacoin",
790 "platinumcoin" => "platinacoin",
791 "platinumcoins" => "platinacoin",
792 "platina" => "platinacoin",
793 "platinacoin" => "platinacoin",
794 "platinacoins" => "platinacoin",
795 "royalty" => "royalty",
796 "royalties" => "royalty",
797);
798
799sub coin_from_name($) {
800 $coin_alias{$_[0]}
801 ? cf::arch::find $coin_alias{$_[0]}
802 : undef
803}
804
805=item $value = cf::db_get $family => $key
806
807Returns a single value from the environment database.
808
809=item cf::db_put $family => $key => $value
810
811Stores the given C<$value> in the family. It can currently store binary
812data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
813
814=item $db = cf::db_table "name"
815
816Create and/or open a new database table. The string must not be "db" and must be unique
817within each server.
818
819=cut
820
821sub db_table($) {
822 cf::error "db_get called from main context"
823 if $Coro::current == $Coro::main;
824
825 my ($name) = @_;
826 my $db = BDB::db_create $DB_ENV;
827
828 eval {
829 $db->set_flags (BDB::CHKSUM);
830
831 utf8::encode $name;
832 BDB::db_open $db, undef, $name, undef, BDB::BTREE,
833 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
834 cf::cleanup "db_open(db): $!" if $!;
402 } 835 };
836 cf::cleanup "db_open(db): $@" if $@;
403 837
404 my $guard = cf::lock_acquire "write_runtime"; 838 $db
839}
405 840
406 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 841our $DB;
407 or return;
408 842
409 my $value = $cf::RUNTIME + 90 + 10; 843sub db_init {
410 # 10 is the runtime save interval, for a monotonic clock 844 $DB ||= db_table "db";
411 # 60 allows for the watchdog to kill the server. 845}
412 846
413 (aio_write $fh, 0, (length $value), $value, 0) <= 0 847sub db_get($$) {
414 and return; 848 my $key = "$_[0]/$_[1]";
415 849
416 # always fsync - this file is important 850 cf::error "db_get called from main context"
417 aio_fsync $fh 851 if $Coro::current == $Coro::main;
418 and return;
419 852
420 # touch it again to show we are up-to-date 853 BDB::db_get $DB, undef, $key, my $data;
421 utime undef, undef, $fh;
422 854
423 close $fh 855 $! ? ()
424 or return; 856 : $data
857}
425 858
426 aio_rename "$runtime~", $runtime 859sub db_put($$$) {
427 and return; 860 BDB::dbreq_pri 4;
861 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
862}
428 863
429 warn "runtime file written.\n";#d# 864=item cf::cache $id => [$paths...], $processversion => $process
430 865
866Generic caching function that returns the value of the resource $id,
867caching and regenerating as required.
868
869This function can block.
870
871=cut
872
873sub cache {
874 my ($id, $src, $processversion, $process) = @_;
875
876 my $meta =
877 join "\x00",
878 $processversion,
879 map {
880 aio_stat $_
881 and Carp::croak "$_: $!";
882
883 ($_, (stat _)[7,9])
884 } @$src;
885
886 my $dbmeta = db_get cache => "$id/meta";
887 if ($dbmeta ne $meta) {
888 # changed, we may need to process
889
890 my @data;
891 my $md5;
892
893 for (0 .. $#$src) {
894 $data[$_] = load_file $src->[$_];
895 }
896
897 # if processing is expensive, check
898 # checksum first
899 if (1) {
900 $md5 =
901 join "\x00",
902 $processversion,
903 map {
904 cf::cede_to_tick;
905 ($src->[$_], Digest::MD5::md5_hex $data[$_])
906 } 0.. $#$src;
907
908
909 my $dbmd5 = db_get cache => "$id/md5";
910 if ($dbmd5 eq $md5) {
911 db_put cache => "$id/meta", $meta;
912
913 return db_get cache => "$id/data";
914 }
915 }
916
917 my $t1 = EV::time;
918 my $data = $process->(\@data);
919 my $t2 = EV::time;
920
921 info "cache: '$id' processed in ", $t2 - $t1, "s\n";
922
923 db_put cache => "$id/data", $data;
924 db_put cache => "$id/md5" , $md5;
925 db_put cache => "$id/meta", $meta;
926
927 return $data;
431 1 928 }
929
930 db_get cache => "$id/data"
432} 931}
433 932
434=item cf::datalog type => key => value, ... 933=item cf::datalog type => key => value, ...
435 934
436Log a datalog packet of the given type with the given key-value pairs. 935Log a datalog packet of the given type with the given key-value pairs.
437 936
438=cut 937=cut
439 938
440sub datalog($@) { 939sub datalog($@) {
441 my ($type, %kv) = @_; 940 my ($type, %kv) = @_;
442 warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type }); 941 info "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
443} 942}
444 943
445=back 944=back
446 945
447=cut 946=cut
448 947
449############################################################################# 948#############################################################################
450 949
451=head2 ATTACHABLE OBJECTS 950=head2 ATTACHABLE OBJECTS
452 951
453Many objects in crossfire are so-called attachable objects. That means you can 952Many objects in deliantra are so-called attachable objects. That means you can
454attach callbacks/event handlers (a collection of which is called an "attachment") 953attach callbacks/event handlers (a collection of which is called an "attachment")
455to it. All such attachable objects support the following methods. 954to it. All such attachable objects support the following methods.
456 955
457In the following description, CLASS can be any of C<global>, C<object> 956In the following description, CLASS can be any of C<global>, C<object>
458C<player>, C<client> or C<map> (i.e. the attachable objects in 957C<player>, C<client> or C<map> (i.e. the attachable objects in
459crossfire+). 958Deliantra).
460 959
461=over 4 960=over 4
462 961
463=item $attachable->attach ($attachment, key => $value...) 962=item $attachable->attach ($attachment, key => $value...)
464 963
508=item cf::CLASS::attachment $name, ... 1007=item cf::CLASS::attachment $name, ...
509 1008
510Register an attachment by C<$name> through which attachable objects of the 1009Register an attachment by C<$name> through which attachable objects of the
511given CLASS can refer to this attachment. 1010given CLASS can refer to this attachment.
512 1011
513Some classes such as crossfire maps and objects can specify attachments 1012Some classes such as deliantra maps and objects can specify attachments
514that are attached at load/instantiate time, thus the need for a name. 1013that are attached at load/instantiate time, thus the need for a name.
515 1014
516These calls expect any number of the following handler/hook descriptions: 1015These calls expect any number of the following handler/hook descriptions:
517 1016
518=over 4 1017=over 4
642 1141
643 } elsif (exists $cb_id{$type}) { 1142 } elsif (exists $cb_id{$type}) {
644 _attach_cb $registry, $cb_id{$type}, $prio, shift @arg; 1143 _attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
645 1144
646 } elsif (ref $type) { 1145 } elsif (ref $type) {
647 warn "attaching objects not supported, ignoring.\n"; 1146 error "attaching objects not supported, ignoring.\n";
648 1147
649 } else { 1148 } else {
650 shift @arg; 1149 shift @arg;
651 warn "attach argument '$type' not supported, ignoring.\n"; 1150 error "attach argument '$type' not supported, ignoring.\n";
652 } 1151 }
653 } 1152 }
654} 1153}
655 1154
656sub _object_attach { 1155sub _object_attach {
666 _attach $registry, $klass, @attach; 1165 _attach $registry, $klass, @attach;
667 } 1166 }
668 1167
669 $obj->{$name} = \%arg; 1168 $obj->{$name} = \%arg;
670 } else { 1169 } else {
671 warn "object uses attachment '$name' that is not available, postponing.\n"; 1170 info "object uses attachment '$name' which is not available, postponing.\n";
672 } 1171 }
673 1172
674 $obj->{_attachment}{$name} = undef; 1173 $obj->{_attachment}{$name} = undef;
675} 1174}
676 1175
716 "; 1215 ";
717 die if $@; 1216 die if $@;
718} 1217}
719 1218
720our $override; 1219our $override;
721our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 1220our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
722 1221
723sub override { 1222sub override {
724 $override = 1; 1223 $override = 1;
725 @invoke_results = (); 1224 @INVOKE_RESULTS = (@_);
726} 1225}
727 1226
728sub do_invoke { 1227sub do_invoke {
729 my $event = shift; 1228 my $event = shift;
730 my $callbacks = shift; 1229 my $callbacks = shift;
731 1230
732 @invoke_results = (); 1231 @INVOKE_RESULTS = ();
733 1232
734 local $override; 1233 local $override;
735 1234
736 for (@$callbacks) { 1235 for (@$callbacks) {
737 eval { &{$_->[1]} }; 1236 eval { &{$_->[1]} };
738 1237
739 if ($@) { 1238 if ($@) {
740 warn "$@";
741 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n"; 1239 error "$@", "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
742 override; 1240 override;
743 } 1241 }
744 1242
745 return 1 if $override; 1243 return 1 if $override;
746 } 1244 }
747 1245
748 0 1246 0
749} 1247}
750 1248
751=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...) 1249=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
752 1250
753=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...) 1251=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
754 1252
755Generate an object-specific event with the given arguments. 1253Generate an object-specific event with the given arguments.
756 1254
757This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be 1255This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
758removed in future versions), and there is no public API to access override 1256removed in future versions), and there is no public API to access override
759results (if you must, access C<@cf::invoke_results> directly). 1257results (if you must, access C<@cf::INVOKE_RESULTS> directly).
760 1258
761=back 1259=back
762 1260
763=cut 1261=cut
764 1262
765############################################################################# 1263#############################################################################
766# object support 1264# object support
1265
1266sub _object_equal($$);
1267sub _object_equal($$) {
1268 my ($a, $b) = @_;
1269
1270 return 0 unless (ref $a) eq (ref $b);
1271
1272 if ("HASH" eq ref $a) {
1273 my @ka = keys %$a;
1274 my @kb = keys %$b;
1275
1276 return 0 if @ka != @kb;
1277
1278 for (0 .. $#ka) {
1279 return 0 unless $ka[$_] eq $kb[$_];
1280 return 0 unless _object_equal $a->{$ka[$_]}, $b->{$kb[$_]};
1281 }
1282
1283 } elsif ("ARRAY" eq ref $a) {
1284
1285 return 0 if @$a != @$b;
1286
1287 for (0 .. $#$a) {
1288 return 0 unless _object_equal $a->[$_], $b->[$_];
1289 }
1290
1291 } elsif ($a ne $b) {
1292 return 0;
1293 }
1294
1295 1
1296}
1297
1298our $SLOW_MERGES;#d#
1299sub _can_merge {
1300 my ($ob1, $ob2) = @_;
1301
1302 ++$SLOW_MERGES;#d#
1303
1304 # we do the slow way here
1305 return _object_equal $ob1, $ob2
1306}
767 1307
768sub reattach { 1308sub reattach {
769 # basically do the same as instantiate, without calling instantiate 1309 # basically do the same as instantiate, without calling instantiate
770 my ($obj) = @_; 1310 my ($obj) = @_;
771 1311
1312 # no longer needed after getting rid of delete_package?
772 bless $obj, ref $obj; # re-bless in case extensions have been reloaded 1313 #bless $obj, ref $obj; # re-bless in case extensions have been reloaded
773 1314
774 my $registry = $obj->registry; 1315 my $registry = $obj->registry;
775 1316
776 @$registry = (); 1317 @$registry = ();
777 1318
782 for (@$attach) { 1323 for (@$attach) {
783 my ($klass, @attach) = @$_; 1324 my ($klass, @attach) = @$_;
784 _attach $registry, $klass, @attach; 1325 _attach $registry, $klass, @attach;
785 } 1326 }
786 } else { 1327 } else {
787 warn "object uses attachment '$name' that is not available, postponing.\n"; 1328 info "object uses attachment '$name' that is not available, postponing.\n";
788 } 1329 }
789 } 1330 }
790} 1331}
791 1332
792cf::attachable->attach ( 1333cf::attachable->attach (
793 prio => -1000000, 1334 prio => -1000000,
794 on_instantiate => sub { 1335 on_instantiate => sub {
795 my ($obj, $data) = @_; 1336 my ($obj, $data) = @_;
796 1337
797 $data = from_json $data; 1338 $data = decode_json $data;
798 1339
799 for (@$data) { 1340 for (@$data) {
800 my ($name, $args) = @$_; 1341 my ($name, $args) = @$_;
801 1342
802 $obj->attach ($name, %{$args || {} }); 1343 $obj->attach ($name, %{$args || {} });
818sub object_freezer_save { 1359sub object_freezer_save {
819 my ($filename, $rdata, $objs) = @_; 1360 my ($filename, $rdata, $objs) = @_;
820 1361
821 sync_job { 1362 sync_job {
822 if (length $$rdata) { 1363 if (length $$rdata) {
1364 utf8::decode (my $decname = $filename);
823 warn sprintf "saving %s (%d,%d)\n", 1365 trace sprintf "saving %s (%d,%d)\n",
824 $filename, length $$rdata, scalar @$objs; 1366 $decname, length $$rdata, scalar @$objs
1367 if $VERBOSE_IO;
825 1368
826 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1369 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
827 chmod SAVE_MODE, $fh; 1370 aio_chmod $fh, SAVE_MODE;
828 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 1371 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
829 aio_fsync $fh if $cf::USE_FSYNC; 1372 if ($cf::USE_FSYNC) {
1373 aio_sync_file_range $fh, 0, 0, IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE | IO::AIO::SYNC_FILE_RANGE_WRITE | IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER;
1374 aio_fsync $fh;
1375 }
830 close $fh; 1376 aio_close $fh;
831 1377
832 if (@$objs) { 1378 if (@$objs) {
833 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) { 1379 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
834 chmod SAVE_MODE, $fh; 1380 aio_chmod $fh, SAVE_MODE;
835 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1381 my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
836 aio_write $fh, 0, (length $data), $data, 0; 1382 aio_write $fh, 0, (length $data), $data, 0;
837 aio_fsync $fh if $cf::USE_FSYNC; 1383 if ($cf::USE_FSYNC) {
1384 aio_sync_file_range $fh, 0, 0, IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE | IO::AIO::SYNC_FILE_RANGE_WRITE | IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER;
1385 aio_fsync $fh;
1386 }
838 close $fh; 1387 aio_close $fh;
839 aio_rename "$filename.pst~", "$filename.pst"; 1388 aio_rename "$filename.pst~", "$filename.pst";
840 } 1389 }
841 } else { 1390 } else {
842 aio_unlink "$filename.pst"; 1391 aio_unlink "$filename.pst";
843 } 1392 }
844 1393
845 aio_rename "$filename~", $filename; 1394 aio_rename "$filename~", $filename;
1395
1396 $filename =~ s%/[^/]+$%%;
1397 aio_pathsync $filename if $cf::USE_FSYNC;
846 } else { 1398 } else {
847 warn "FATAL: $filename~: $!\n"; 1399 error "unable to save objects: $filename~: $!\n";
848 } 1400 }
849 } else { 1401 } else {
850 aio_unlink $filename; 1402 aio_unlink $filename;
851 aio_unlink "$filename.pst"; 1403 aio_unlink "$filename.pst";
852 } 1404 }
853 } 1405 };
854} 1406}
855 1407
856sub object_freezer_as_string { 1408sub object_freezer_as_string {
857 my ($rdata, $objs) = @_; 1409 my ($rdata, $objs) = @_;
858 1410
870 or return; 1422 or return;
871 1423
872 unless (aio_stat "$filename.pst") { 1424 unless (aio_stat "$filename.pst") {
873 (aio_load "$filename.pst", $av) >= 0 1425 (aio_load "$filename.pst", $av) >= 0
874 or return; 1426 or return;
1427
875 $av = eval { (Storable::thaw $av)->{objs} }; 1428 my $st = eval { Coro::Storable::thaw $av };
1429 $av = $st->{objs};
876 } 1430 }
877 1431
1432 utf8::decode (my $decname = $filename);
878 warn sprintf "loading %s (%d)\n", 1433 trace sprintf "loading %s (%d,%d)\n",
879 $filename, length $data, scalar @{$av || []};#d# 1434 $decname, length $data, scalar @{$av || []}
1435 if $VERBOSE_IO;
1436
880 return ($data, $av); 1437 ($data, $av)
881} 1438}
1439
1440=head2 COMMAND CALLBACKS
1441
1442=over 4
1443
1444=cut
882 1445
883############################################################################# 1446#############################################################################
884# command handling &c 1447# command handling &c
885 1448
886=item cf::register_command $name => \&callback($ob,$args); 1449=item cf::register_command $name => \&callback($ob,$args)
887 1450
888Register a callback for execution when the client sends the user command 1451Register a callback for execution when the client sends the user command
889$name. 1452$name.
890 1453
891=cut 1454=cut
897 #warn "registering command '$name/$time' to '$caller'"; 1460 #warn "registering command '$name/$time' to '$caller'";
898 1461
899 push @{ $COMMAND{$name} }, [$caller, $cb]; 1462 push @{ $COMMAND{$name} }, [$caller, $cb];
900} 1463}
901 1464
902=item cf::register_extcmd $name => \&callback($pl,$packet); 1465=item cf::register_extcmd $name => \&callback($pl,@args)
903 1466
904Register a callbackf ro execution when the client sends an extcmd packet. 1467Register a callback for execution when the client sends an (synchronous)
1468extcmd packet. Ext commands will be processed in the order they are
1469received by the server, like other user commands. The first argument is
1470the logged-in player. Ext commands can only be processed after a player
1471has logged in successfully.
905 1472
906If the callback returns something, it is sent back as if reply was being 1473The values will be sent back to the client.
907called.
908 1474
909=cut 1475=item cf::register_async_extcmd $name => \&callback($pl,$reply->(...),@args)
910 1476
1477Same as C<cf::register_extcmd>, but instead of returning values, the
1478callback needs to clal the C<$reply> function.
1479
1480=item cf::register_exticmd $name => \&callback($ns,@args)
1481
1482Register a callback for execution when the client sends an (asynchronous)
1483exticmd packet. Exti commands are processed by the server as soon as they
1484are received, i.e. out of order w.r.t. other commands. The first argument
1485is a client socket. Exti commands can be received anytime, even before
1486log-in.
1487
1488The values will be sent back to the client.
1489
1490=item cf::register_async_exticmd $name => \&callback($ns,$reply->(...),@args)
1491
1492Same as C<cf::register_extcmd>, but instead of returning values, the
1493callback needs to clal the C<$reply> function.
1494
1495=cut
1496
911sub register_extcmd { 1497sub register_extcmd($$) {
912 my ($name, $cb) = @_; 1498 my ($name, $cb) = @_;
913 1499
914 $EXTCMD{$name} = $cb; 1500 $EXTCMD{$name} = $cb;
915} 1501}
916 1502
1503sub register_async_extcmd($$) {
1504 my ($name, $cb) = @_;
1505
1506 $EXTACMD{$name} = $cb;
1507}
1508
1509sub register_exticmd($$) {
1510 my ($name, $cb) = @_;
1511
1512 $EXTICMD{$name} = $cb;
1513}
1514
1515sub register_async_exticmd($$) {
1516 my ($name, $cb) = @_;
1517
1518 $EXTIACMD{$name} = $cb;
1519}
1520
1521use File::Glob ();
1522
917cf::player->attach ( 1523cf::player->attach (
918 on_command => sub { 1524 on_unknown_command => sub {
919 my ($pl, $name, $params) = @_; 1525 my ($pl, $name, $params) = @_;
920 1526
921 my $cb = $COMMAND{$name} 1527 my $cb = $COMMAND{$name}
922 or return; 1528 or return;
923 1529
928 cf::override; 1534 cf::override;
929 }, 1535 },
930 on_extcmd => sub { 1536 on_extcmd => sub {
931 my ($pl, $buf) = @_; 1537 my ($pl, $buf) = @_;
932 1538
933 my $msg = eval { from_json $buf }; 1539 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
934 1540
935 if (ref $msg) { 1541 if (ref $msg) {
1542 my ($type, $reply, @payload) = @$msg; # version 1 used %type, $id, %$hash
1543
936 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1544 if (my $cb = $EXTACMD{$type}) {
937 if (my %reply = $cb->($pl, $msg)) { 1545 $cb->(
938 $pl->ext_reply ($msg->{msgid}, %reply); 1546 $pl,
1547 sub {
1548 $pl->ext_msg ("reply-$reply", @_)
1549 if $reply;
1550 },
1551 @payload
1552 );
1553 } else {
1554 my @reply;
1555
1556 if (my $cb = $EXTCMD{$type}) {
1557 @reply = $cb->($pl, @payload);
939 } 1558 }
1559
1560 $pl->ext_msg ("reply-$reply", @reply)
1561 if $reply;
940 } 1562 }
1563
941 } else { 1564 } else {
942 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1565 error "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
943 } 1566 }
944 1567
945 cf::override; 1568 cf::override;
946 }, 1569 },
947); 1570);
948 1571
1572# "readahead" all extensions
949sub load_extension { 1573sub cache_extensions {
950 my ($path) = @_; 1574 my $grp = IO::AIO::aio_group;
951 1575
952 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1576 add $grp IO::AIO::aio_readdirx $LIBDIR, IO::AIO::READDIR_STAT_ORDER, sub {
953 my $base = $1; 1577 for (grep /\.ext$/, @{$_[0]}) {
954 my $pkg = $1; 1578 add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
955 $pkg =~ s/[^[:word:]]/_/g;
956 $pkg = "ext::$pkg";
957
958 warn "... loading '$path' into '$pkg'\n";
959
960 open my $fh, "<:utf8", $path
961 or die "$path: $!";
962
963 my $source =
964 "package $pkg; use strict; use utf8;\n"
965 . "#line 1 \"$path\"\n{\n"
966 . (do { local $/; <$fh> })
967 . "\n};\n1";
968
969 unless (eval $source) {
970 my $msg = $@ ? "$path: $@\n"
971 : "extension disabled.\n";
972 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
973 warn $@;
974 warn "mandatory extension failed to load, exiting.\n";
975 exit 1;
976 } 1579 }
977 die $@;
978 } 1580 };
979 1581
980 push @EXTS, $pkg; 1582 $grp
1583}
1584
1585sub _ext_cfg_reg($$$$) {
1586 my ($rvar, $varname, $cfgname, $default) = @_;
1587
1588 $cfgname = lc $varname
1589 unless length $cfgname;
1590
1591 $EXT_CFG{$cfgname} = [$rvar, $default];
1592
1593 $$rvar = exists $CFG{$cfgname} ? $CFG{$cfgname} : $default;
981} 1594}
982 1595
983sub load_extensions { 1596sub load_extensions {
1597 info "loading extensions...";
1598
1599 %EXT_CFG = ();
1600
1601 cf::sync_job {
1602 my %todo;
1603
984 for my $ext (<$LIBDIR/*.ext>) { 1604 for my $path (<$LIBDIR/*.ext>) {
985 next unless -r $ext; 1605 next unless -r $path;
986 eval { 1606
987 load_extension $ext; 1607 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1608 my $base = $1;
1609 my $pkg = $1;
1610 $pkg =~ s/[^[:word:]]/_/g;
1611 $pkg = "ext::$pkg";
1612
1613 open my $fh, "<:utf8", $path
1614 or die "$path: $!";
1615
1616 my $source = do { local $/; <$fh> };
1617
1618 my %ext = (
1619 path => $path,
1620 base => $base,
1621 pkg => $pkg,
1622 );
1623
1624 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1625 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1626
1627 $ext{source} =
1628 "package $pkg; use common::sense;\n"
1629 . "#line 1 \"$path\"\n{\n"
1630 . $source
1631 . "\n};\n1";
1632
1633 $todo{$base} = \%ext;
1634 }
1635
1636 my $pass = 0;
1637 my %done;
1638 while (%todo) {
1639 my $progress;
1640
1641 ++$pass;
1642
1643 ext:
1644 while (my ($k, $v) = each %todo) {
1645 for (split /,\s*/, $v->{meta}{depends}) {
1646 next ext
1647 unless exists $done{$_};
1648 }
1649
1650 trace "... pass $pass, loading '$k' into '$v->{pkg}'\n";
1651
1652 my $source = $v->{source};
1653
1654 # support "CONF varname :confname = default" pseudo-statements
1655 $source =~ s{
1656 ^ CONF \s+ ([^\s:=]+) \s* (?:: \s* ([^\s:=]+) \s* )? = ([^\n#]+)
1657 }{
1658 "our \$$1; BEGIN { cf::_ext_cfg_reg \\\$$1, q\x00$1\x00, q\x00$2\x00, $3 }";
1659 }gmxe;
1660
1661 my $active = eval $source;
1662
1663 if (length $@) {
1664 error "$v->{path}: $@\n";
1665
1666 cf::cleanup "mandatory extension '$k' failed to load, exiting."
1667 if exists $v->{meta}{mandatory};
1668
1669 warn "$v->{base}: optional extension cannot be loaded, skipping.\n";
1670 delete $todo{$k};
1671 } else {
1672 $done{$k} = delete $todo{$k};
1673 push @EXTS, $v->{pkg};
1674 $progress = 1;
1675
1676 info "$v->{base}: extension inactive.\n"
1677 unless $active;
1678 }
988 1 1679 }
989 } or warn "$ext not loaded: $@"; 1680
1681 unless ($progress) {
1682 warn "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n";
1683
1684 while (my ($k, $v) = each %todo) {
1685 cf::cleanup "mandatory extension '$k' has unresolved dependencies, exiting."
1686 if exists $v->{meta}{mandatory};
1687 }
1688
1689 last;
1690 }
1691 }
990 } 1692 };
991} 1693}
992 1694
993############################################################################# 1695#############################################################################
994 1696
1697=back
1698
995=head2 CORE EXTENSIONS 1699=head2 CORE EXTENSIONS
996 1700
997Functions and methods that extend core crossfire objects. 1701Functions and methods that extend core deliantra objects.
998 1702
999=cut 1703=cut
1000 1704
1001package cf::player; 1705package cf::player;
1002 1706
1003use Coro::AIO; 1707use Coro::AIO;
1004 1708
1005=head3 cf::player 1709=head3 cf::player
1006 1710
1007=over 4 1711=over 4
1712
1713=item cf::player::num_playing
1714
1715Returns the official number of playing players, as per the Crossfire metaserver rules.
1716
1717=cut
1718
1719sub num_playing {
1720 scalar grep
1721 $_->ob->map
1722 && !$_->hidden
1723 && !$_->ob->flag (cf::FLAG_WIZ),
1724 cf::player::list
1725}
1008 1726
1009=item cf::player::find $login 1727=item cf::player::find $login
1010 1728
1011Returns the given player object, loading it if necessary (might block). 1729Returns the given player object, loading it if necessary (might block).
1012 1730
1031 1749
1032sub exists($) { 1750sub exists($) {
1033 my ($login) = @_; 1751 my ($login) = @_;
1034 1752
1035 $cf::PLAYER{$login} 1753 $cf::PLAYER{$login}
1036 or cf::sync_job { !aio_stat path $login } 1754 or !aio_stat path $login
1037} 1755}
1038 1756
1039sub find($) { 1757sub find($) {
1040 return $cf::PLAYER{$_[0]} || do { 1758 return $cf::PLAYER{$_[0]} || do {
1041 my $login = $_[0]; 1759 my $login = $_[0];
1048 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst"; 1766 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1049 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata"; 1767 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1050 aio_unlink +(playerdir $login) . "/$login.pl.pst"; 1768 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1051 aio_unlink +(playerdir $login) . "/$login.pl"; 1769 aio_unlink +(playerdir $login) . "/$login.pl";
1052 1770
1053 my $pl = load_pl path $login 1771 my $f = new_from_file cf::object::thawer path $login
1054 or return; 1772 or return;
1773
1774 my $pl = cf::player::load_pl $f
1775 or return;
1776
1777 local $cf::PLAYER_LOADING{$login} = $pl;
1778 $f->resolve_delayed_derefs;
1055 $cf::PLAYER{$login} = $pl 1779 $cf::PLAYER{$login} = $pl
1056 } 1780 }
1057 } 1781 }
1058} 1782}
1783
1784cf::player->attach (
1785 on_load => sub {
1786 my ($pl, $path) = @_;
1787
1788 # restore slots saved in save, below
1789 my $slots = delete $pl->{_slots};
1790
1791 $pl->ob->current_weapon ($slots->[0]);
1792 $pl->combat_ob ($slots->[1]);
1793 $pl->ranged_ob ($slots->[2]);
1794 },
1795);
1059 1796
1060sub save($) { 1797sub save($) {
1061 my ($pl) = @_; 1798 my ($pl) = @_;
1062 1799
1063 return if $pl->{deny_save}; 1800 return if $pl->{deny_save};
1068 return if $pl->{deny_save}; 1805 return if $pl->{deny_save};
1069 1806
1070 aio_mkdir playerdir $pl, 0770; 1807 aio_mkdir playerdir $pl, 0770;
1071 $pl->{last_save} = $cf::RUNTIME; 1808 $pl->{last_save} = $cf::RUNTIME;
1072 1809
1810 cf::get_slot 0.01;
1811
1812 # save slots, to be restored later
1813 local $pl->{_slots} = [$pl->ob->current_weapon, $pl->combat_ob, $pl->ranged_ob];
1814
1073 $pl->save_pl ($path); 1815 $pl->save_pl ($path);
1074 Coro::cede; 1816 cf::cede_to_tick;
1075} 1817}
1076 1818
1077sub new($) { 1819sub new($) {
1078 my ($login) = @_; 1820 my ($login) = @_;
1079 1821
1085 $cf::PLAYER{$login} = $self; 1827 $cf::PLAYER{$login} = $self;
1086 1828
1087 $self 1829 $self
1088} 1830}
1089 1831
1832=item $player->send_msg ($channel, $msg, $color, [extra...])
1833
1834=cut
1835
1836sub send_msg {
1837 my $ns = shift->ns
1838 or return;
1839 $ns->send_msg (@_);
1840}
1841
1090=item $pl->quit_character 1842=item $pl->quit_character
1091 1843
1092Nukes the player without looking back. If logged in, the connection will 1844Nukes the player without looking back. If logged in, the connection will
1093be destroyed. May block for a long time. 1845be destroyed. May block for a long time.
1094 1846
1098 my ($pl) = @_; 1850 my ($pl) = @_;
1099 1851
1100 my $name = $pl->ob->name; 1852 my $name = $pl->ob->name;
1101 1853
1102 $pl->{deny_save} = 1; 1854 $pl->{deny_save} = 1;
1103 $pl->password ("*"); # this should lock out the player until we nuked the dir 1855 $pl->password ("*"); # this should lock out the player until we have nuked the dir
1104 1856
1105 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1857 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->ns;
1106 $pl->deactivate; 1858 $pl->deactivate;
1859
1860 my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
1107 $pl->invoke (cf::EVENT_PLAYER_QUIT); 1861 $pl->invoke (cf::EVENT_PLAYER_QUIT) if $pl->ns;
1862 ext::highscore::check ($pl->ob);
1863
1108 $pl->ns->destroy if $pl->ns; 1864 $pl->ns->destroy if $pl->ns;
1109 1865
1110 my $path = playerdir $pl; 1866 my $path = playerdir $pl;
1111 my $temp = "$path~$cf::RUNTIME~deleting~"; 1867 my $temp = "$path~$cf::RUNTIME~deleting~";
1112 aio_rename $path, $temp; 1868 aio_rename $path, $temp;
1147 or return []; 1903 or return [];
1148 1904
1149 my @logins; 1905 my @logins;
1150 1906
1151 for my $login (@$dirs) { 1907 for my $login (@$dirs) {
1908 my $path = path $login;
1909
1910 # a .pst is a dead give-away for a valid player
1911 # if no pst file found, open and chekc for blocked users
1912 if (aio_stat "$path.pst") {
1152 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next; 1913 my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1153 aio_read $fh, 0, 512, my $buf, 0 or next; 1914 aio_read $fh, 0, 512, my $buf, 0 or next;
1154 $buf !~ /^password -------------$/m or next; # official not-valid tag 1915 $buf !~ /^password -------------$/m or next; # official not-valid tag
1916 }
1155 1917
1156 utf8::decode $login; 1918 utf8::decode $login;
1157 push @logins, $login; 1919 push @logins, $login;
1158 } 1920 }
1159 1921
1160 \@logins 1922 \@logins
1161} 1923}
1162 1924
1163=item $player->maps 1925=item $player->maps
1926
1927=item cf::player::maps $login
1164 1928
1165Returns an arrayref of map paths that are private for this 1929Returns an arrayref of map paths that are private for this
1166player. May block. 1930player. May block.
1167 1931
1168=cut 1932=cut
1186 } 1950 }
1187 1951
1188 \@paths 1952 \@paths
1189} 1953}
1190 1954
1191=item $player->ext_reply ($msgid, %msg) 1955=item $protocol_xml = $player->expand_cfpod ($cfpod)
1192 1956
1193Sends an ext reply to the player. 1957Expand deliantra pod fragments into protocol xml.
1194 1958
1195=cut
1196
1197sub ext_reply($$%) {
1198 my ($self, $id, %msg) = @_;
1199
1200 $msg{msgid} = $id;
1201
1202 $self->send ("ext " . cf::to_json \%msg);
1203}
1204
1205=item $player->ext_event ($type, %msg) 1959=item $player->ext_msg ($type, @msg)
1206 1960
1207Sends an ext event to the client. 1961Sends an ext event to the client.
1208 1962
1209=cut 1963=cut
1210 1964
1211sub ext_event($$%) { 1965sub ext_msg($$@) {
1212 my ($self, $type, %msg) = @_; 1966 my ($self, $type, @msg) = @_;
1213 1967
1214 $self->ns->ext_event ($type, %msg); 1968 $self->ns->ext_msg ($type, @msg);
1215} 1969}
1216 1970
1217=head3 cf::region 1971=head3 cf::region
1218 1972
1219=over 4 1973=over 4
1222 1976
1223package cf::region; 1977package cf::region;
1224 1978
1225=item cf::region::find_by_path $path 1979=item cf::region::find_by_path $path
1226 1980
1227Tries to decuce the probable region for a map knowing only its path. 1981Tries to decuce the likely region for a map knowing only its path.
1228 1982
1229=cut 1983=cut
1230 1984
1231sub find_by_path($) { 1985sub find_by_path($) {
1232 my ($path) = @_; 1986 my ($path) = @_;
1233 1987
1988 $path =~ s/^~[^\/]*//; # skip ~login
1989
1234 my ($match, $specificity); 1990 my ($match, $specificity);
1235 1991
1236 for my $region (list) { 1992 for my $region (list) {
1237 if ($region->match && $path =~ $region->match) { 1993 if ($region->{match} && $path =~ $region->{match}) {
1238 ($match, $specificity) = ($region, $region->specificity) 1994 ($match, $specificity) = ($region, $region->specificity)
1239 if $region->specificity > $specificity; 1995 if $region->specificity > $specificity;
1240 } 1996 }
1241 } 1997 }
1242 1998
1263our $MAX_RESET = 3600; 2019our $MAX_RESET = 3600;
1264our $DEFAULT_RESET = 3000; 2020our $DEFAULT_RESET = 3000;
1265 2021
1266sub generate_random_map { 2022sub generate_random_map {
1267 my ($self, $rmp) = @_; 2023 my ($self, $rmp) = @_;
1268 # mit "rum" bekleckern, nicht 2024
2025 my $lock = cf::lock_acquire "generate_random_map"; # the random map generator is NOT reentrant ATM
2026
1269 $self->_create_random_map ( 2027 $self->_create_random_map ($rmp);
1270 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1271 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1272 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1273 $rmp->{exit_on_final_map},
1274 $rmp->{xsize}, $rmp->{ysize},
1275 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1276 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1277 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1278 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1279 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1280 (cf::region::find $rmp->{region}), $rmp->{custom}
1281 )
1282} 2028}
1283 2029
1284=item cf::map->register ($regex, $prio) 2030=item cf::map->register ($regex, $prio)
1285 2031
1286Register a handler for the map path matching the given regex at the 2032Register a handler for the map path matching the given regex at the
1291 2037
1292sub register { 2038sub register {
1293 my (undef, $regex, $prio) = @_; 2039 my (undef, $regex, $prio) = @_;
1294 my $pkg = caller; 2040 my $pkg = caller;
1295 2041
1296 no strict;
1297 push @{"$pkg\::ISA"}, __PACKAGE__; 2042 push @{"$pkg\::ISA"}, __PACKAGE__;
1298 2043
1299 $EXT_MAP{$pkg} = [$prio, qr<$regex>]; 2044 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1300} 2045}
1301 2046
1302# also paths starting with '/' 2047# also paths starting with '/'
1303$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}]; 2048$EXT_MAP{"cf::map::wrap"} = [0, qr{^(?=/)}];
1304 2049
1305sub thawer_merge { 2050sub thawer_merge {
1306 my ($self, $merge) = @_; 2051 my ($self, $merge) = @_;
1307 2052
1308 # we have to keep some variables in memory intact 2053 # we have to keep some variables in memory intact
1309 local $self->{path}; 2054 local $self->{path};
1310 local $self->{load_path}; 2055 local $self->{load_path};
1311 local $self->{deny_save};
1312 local $self->{deny_reset};
1313 2056
1314 $self->SUPER::thawer_merge ($merge); 2057 $self->SUPER::thawer_merge ($merge);
1315} 2058}
1316 2059
1317sub normalise { 2060sub normalise {
1318 my ($path, $base) = @_; 2061 my ($path, $base) = @_;
1319 2062
1320 $path = "$path"; # make sure its a string 2063 $path = "$path"; # make sure it's a string
1321 2064
1322 $path =~ s/\.map$//; 2065 $path =~ s/\.map$//;
1323 2066
1324 # map plan: 2067 # map plan:
1325 # 2068 #
1340 $base =~ s{[^/]+/?$}{}; 2083 $base =~ s{[^/]+/?$}{};
1341 $path = "$base/$path"; 2084 $path = "$base/$path";
1342 } 2085 }
1343 2086
1344 for ($path) { 2087 for ($path) {
1345 redo if s{//}{/};
1346 redo if s{/\.?/}{/}; 2088 redo if s{/\.?/}{/};
1347 redo if s{/[^/]+/\.\./}{/}; 2089 redo if s{/[^/]+/\.\./}{/};
1348 } 2090 }
1349 2091
1350 $path 2092 $path
1364 $self->init; # pass $1 etc. 2106 $self->init; # pass $1 etc.
1365 return $self; 2107 return $self;
1366 } 2108 }
1367 } 2109 }
1368 2110
1369 Carp::carp "unable to resolve path '$path' (base '$base')."; 2111 Carp::cluck "unable to resolve path '$path' (base '$base')";
1370 () 2112 ()
1371} 2113}
1372 2114
2115# may re-bless or do other evil things
1373sub init { 2116sub init {
1374 my ($self) = @_; 2117 my ($self) = @_;
1375 2118
1376 $self 2119 $self
1377} 2120}
1396 2139
1397# the temporary/swap location 2140# the temporary/swap location
1398sub save_path { 2141sub save_path {
1399 my ($self) = @_; 2142 my ($self) = @_;
1400 2143
1401 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 2144 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1402 "$TMPDIR/$path.map" 2145 "$TMPDIR/$path.map"
1403} 2146}
1404 2147
1405# the unique path, undef == no special unique path 2148# the unique path, undef == no special unique path
1406sub uniq_path { 2149sub uniq_path {
1407 my ($self) = @_; 2150 my ($self) = @_;
1408 2151
1409 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 2152 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1410 "$UNIQUEDIR/$path" 2153 "$UNIQUEDIR/$path"
1411} 2154}
1412 2155
1413# and all this just because we cannot iterate over 2156sub decay_objects {
1414# all maps in C++...
1415sub change_all_map_light {
1416 my ($change) = @_; 2157 my ($self) = @_;
1417 2158
1418 $_->change_map_light ($change) 2159 return if $self->{deny_reset};
1419 for grep $_->outdoor, values %cf::MAP; 2160
2161 $self->do_decay_objects;
1420} 2162}
1421 2163
1422sub unlink_save { 2164sub unlink_save {
1423 my ($self) = @_; 2165 my ($self) = @_;
1424 2166
1429 2171
1430sub load_header_from($) { 2172sub load_header_from($) {
1431 my ($self, $path) = @_; 2173 my ($self, $path) = @_;
1432 2174
1433 utf8::encode $path; 2175 utf8::encode $path;
1434 #aio_open $path, O_RDONLY, 0 2176 my $f = new_from_file cf::object::thawer $path
1435 # or return;
1436
1437 $self->_load_header ($path)
1438 or return; 2177 or return;
1439 2178
2179 $self->_load_header ($f)
2180 or return;
2181
2182 local $MAP_LOADING{$self->{path}} = $self;
2183 $f->resolve_delayed_derefs;
2184
1440 $self->{load_path} = $path; 2185 $self->{load_path} = $path;
1441 2186
1442 1 2187 1
1443} 2188}
1444 2189
2190# used to laod the header of an original map
1445sub load_header_orig { 2191sub load_header_orig {
1446 my ($self) = @_; 2192 my ($self) = @_;
1447 2193
1448 $self->load_header_from ($self->load_path) 2194 $self->load_header_from ($self->load_path)
1449} 2195}
1450 2196
2197# used to laod the header of an instantiated map
1451sub load_header_temp { 2198sub load_header_temp {
1452 my ($self) = @_; 2199 my ($self) = @_;
1453 2200
1454 $self->load_header_from ($self->save_path) 2201 $self->load_header_from ($self->save_path)
1455} 2202}
1456 2203
2204# called after loading the header from an instantiated map
1457sub prepare_temp { 2205sub prepare_temp {
1458 my ($self) = @_; 2206 my ($self) = @_;
1459 2207
1460 $self->last_access ((delete $self->{last_access}) 2208 $self->last_access ((delete $self->{last_access})
1461 || $cf::RUNTIME); #d# 2209 || $cf::RUNTIME); #d#
1462 # safety 2210 # safety
1463 $self->{instantiate_time} = $cf::RUNTIME 2211 $self->{instantiate_time} = $cf::RUNTIME
1464 if $self->{instantiate_time} > $cf::RUNTIME; 2212 if $self->{instantiate_time} > $cf::RUNTIME;
1465} 2213}
1466 2214
2215# called after loading the header from an original map
1467sub prepare_orig { 2216sub prepare_orig {
1468 my ($self) = @_; 2217 my ($self) = @_;
1469 2218
1470 $self->{load_original} = 1; 2219 $self->{load_original} = 1;
1471 $self->{instantiate_time} = $cf::RUNTIME; 2220 $self->{instantiate_time} = $cf::RUNTIME;
1482 $self->load_header_orig 2231 $self->load_header_orig
1483 or return; 2232 or return;
1484 $self->prepare_orig; 2233 $self->prepare_orig;
1485 } 2234 }
1486 2235
2236 $self->{deny_reset} = 1
2237 if $self->no_reset;
2238
1487 $self->default_region (cf::region::find_by_path $self->{path}) 2239 $self->default_region (cf::region::find_by_path $self->{path})
1488 unless $self->default_region; 2240 unless $self->default_region;
1489 2241
1490 1 2242 1
1491} 2243}
1492 2244
1493sub find; 2245sub find;
1494sub find { 2246sub find {
1495 my ($path, $origin) = @_; 2247 my ($path, $origin) = @_;
1496 2248
2249 cf::cede_to_tick;
2250
1497 $path = normalise $path, $origin && $origin->path; 2251 $path = normalise $path, $origin;
1498 2252
2253 my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1499 cf::lock_wait "map_find:$path"; 2254 my $guard2 = cf::lock_acquire "map_find:$path";
1500 2255
1501 $cf::MAP{$path} || do { 2256 $cf::MAP{$path} || do {
1502 my $guard = cf::lock_acquire "map_find:$path";
1503 my $map = new_from_path cf::map $path 2257 my $map = new_from_path cf::map $path
1504 or return; 2258 or return;
1505 2259
1506 $map->{last_save} = $cf::RUNTIME; 2260 $map->{last_save} = $cf::RUNTIME;
1507 2261
1508 $map->load_header 2262 $map->load_header
1509 or return; 2263 or return;
1510 2264
1511 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 2265 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1512 # doing this can freeze the server in a sync job, obviously 2266 # doing this can freeze the server in a sync job, obviously
1513 #$cf::WAIT_FOR_TICK->wait; 2267 #$cf::WAIT_FOR_TICK->wait;
2268 undef $guard2;
2269 undef $guard1;
1514 $map->reset; 2270 $map->reset;
1515 undef $guard;
1516 return find $path; 2271 return find $path;
1517 } 2272 }
1518 2273
1519 $cf::MAP{$path} = $map 2274 $cf::MAP{$path} = $map
1520 } 2275 }
1521} 2276}
1522 2277
1523sub pre_load { } 2278sub pre_load { }
1524sub post_load { } 2279#sub post_load { } # XS
1525 2280
1526sub load { 2281sub load {
1527 my ($self) = @_; 2282 my ($self) = @_;
1528 2283
1529 local $self->{deny_reset} = 1; # loading can take a long time 2284 local $self->{deny_reset} = 1; # loading can take a long time
1530 2285
1531 my $path = $self->{path}; 2286 my $path = $self->{path};
1532 2287
1533 { 2288 {
1534 my $guard = cf::lock_acquire "map_load:$path"; 2289 my $guard = cf::lock_acquire "map_data:$path";
1535 2290
2291 return unless $self->valid;
1536 return if $self->in_memory != cf::MAP_SWAPPED; 2292 return unless $self->state == cf::MAP_SWAPPED;
1537
1538 $self->in_memory (cf::MAP_LOADING);
1539 2293
1540 $self->alloc; 2294 $self->alloc;
1541 2295
1542 $self->pre_load; 2296 $self->pre_load;
1543 Coro::cede; 2297 cf::cede_to_tick;
1544 2298
1545 $self->_load_objects ($self->{load_path}, 1) 2299 if (exists $self->{load_path}) {
2300 my $f = new_from_file cf::object::thawer $self->{load_path};
2301 $f->skip_block;
2302 $self->_load_objects ($f)
1546 or return; 2303 or return;
1547 2304
1548 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 2305 $self->post_load_original
1549 if delete $self->{load_original}; 2306 if delete $self->{load_original};
1550 2307
1551 if (my $uniq = $self->uniq_path) { 2308 if (my $uniq = $self->uniq_path) {
1552 utf8::encode $uniq; 2309 utf8::encode $uniq;
1553 if (aio_open $uniq, O_RDONLY, 0) { 2310 unless (aio_stat $uniq) {
2311 if (my $f = new_from_file cf::object::thawer $uniq) {
1554 $self->clear_unique_items; 2312 $self->clear_unique_items;
1555 $self->_load_objects ($uniq, 0); 2313 $self->_load_objects ($f);
2314 $f->resolve_delayed_derefs;
2315 }
2316 }
1556 } 2317 }
1557 }
1558 2318
1559 Coro::cede; 2319 $f->resolve_delayed_derefs;
2320 } else {
2321 $self->post_load_original
2322 if delete $self->{load_original};
2323 }
2324
2325 $self->state (cf::MAP_INACTIVE);
2326
2327 cf::cede_to_tick;
1560 # now do the right thing for maps 2328 # now do the right thing for maps
1561 $self->link_multipart_objects; 2329 $self->link_multipart_objects;
1562 $self->difficulty ($self->estimate_difficulty) 2330 $self->difficulty ($self->estimate_difficulty)
1563 unless $self->difficulty; 2331 unless $self->difficulty;
1564 Coro::cede; 2332 cf::cede_to_tick;
1565 2333
1566 unless ($self->{deny_activate}) { 2334 unless ($self->{deny_activate}) {
1567 $self->decay_objects; 2335 $self->decay_objects;
1568 $self->fix_auto_apply; 2336 $self->fix_auto_apply;
1569 $self->update_buttons; 2337 $self->update_buttons;
1570 Coro::cede; 2338 cf::cede_to_tick;
1571 $self->set_darkness_map; 2339 #$self->activate; # no longer activate maps automatically
1572 Coro::cede;
1573 $self->activate;
1574 } 2340 }
1575 2341
1576 $self->in_memory (cf::MAP_IN_MEMORY); 2342 $self->{last_save} = $cf::RUNTIME;
2343 $self->last_access ($cf::RUNTIME);
1577 } 2344 }
1578 2345
1579 $self->post_load; 2346 $self->post_load;
1580}
1581 2347
2348 1
2349}
2350
2351# customize the map for a given player, i.e.
2352# return the _real_ map. used by e.g. per-player
2353# maps to change the path to ~playername/mappath
1582sub customise_for { 2354sub customise_for {
1583 my ($self, $ob) = @_; 2355 my ($self, $ob) = @_;
1584 2356
1585 return find "~" . $ob->name . "/" . $self->{path} 2357 return find "~" . $ob->name . "/" . $self->{path}
1586 if $self->per_player; 2358 if $self->per_player;
1587 2359
2360# return find "?party/" . $ob->name . "/" . $self->{path}
2361# if $self->per_party;
2362
1588 $self 2363 $self
1589}
1590
1591# find and load all maps in the 3x3 area around a map
1592sub load_diag {
1593 my ($map) = @_;
1594
1595 my @diag; # diagonal neighbours
1596
1597 for (0 .. 3) {
1598 my $neigh = $map->tile_path ($_)
1599 or next;
1600 $neigh = find $neigh, $map
1601 or next;
1602 $neigh->load;
1603
1604 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1605 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1606 }
1607
1608 for (@diag) {
1609 my $neigh = find @$_
1610 or next;
1611 $neigh->load;
1612 }
1613} 2364}
1614 2365
1615sub find_sync { 2366sub find_sync {
1616 my ($path, $origin) = @_; 2367 my ($path, $origin) = @_;
1617 2368
1618 cf::sync_job { find $path, $origin } 2369 # it's a bug to call this from the main context
2370 return cf::LOG cf::llevError | cf::logBacktrace, "do_find_sync"
2371 if $Coro::current == $Coro::main;
2372
2373 find $path, $origin
1619} 2374}
1620 2375
1621sub do_load_sync { 2376sub do_load_sync {
1622 my ($map) = @_; 2377 my ($map) = @_;
1623 2378
1624 cf::sync_job { $map->load }; 2379 # it's a bug to call this from the main context
2380 return cf::LOG cf::llevError | cf::logBacktrace, "do_load_sync"
2381 if $Coro::current == $Coro::main;
2382
2383 $map->load;
1625} 2384}
1626 2385
1627our %MAP_PREFETCH; 2386our %MAP_PREFETCH;
1628our $MAP_PREFETCHER = undef; 2387our $MAP_PREFETCHER = undef;
1629 2388
1630sub find_async { 2389sub find_async {
1631 my ($path, $origin) = @_; 2390 my ($path, $origin, $load) = @_;
1632 2391
1633 $path = normalise $path, $origin && $origin->{path}; 2392 $path = normalise $path, $origin;
1634 2393
1635 if (my $map = $cf::MAP{$path}) { 2394 if (my $map = $cf::MAP{$path}) {
1636 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 2395 return $map if !$load || $map->linkable;
1637 } 2396 }
1638 2397
1639 undef $MAP_PREFETCH{$path}; 2398 $MAP_PREFETCH{$path} |= $load;
2399
1640 $MAP_PREFETCHER ||= cf::async { 2400 $MAP_PREFETCHER ||= cf::async {
2401 $Coro::current->{desc} = "map prefetcher";
2402
1641 while (%MAP_PREFETCH) { 2403 while (%MAP_PREFETCH) {
1642 for my $path (keys %MAP_PREFETCH) { 2404 for my $k (keys %MAP_PREFETCH) {
1643 my $map = find $path 2405 if (my $map = find $k) {
1644 or next; 2406 $map->load if $MAP_PREFETCH{$k};
1645 $map->load; 2407 }
1646 2408
1647 delete $MAP_PREFETCH{$path}; 2409 delete $MAP_PREFETCH{$k};
1648 } 2410 }
1649 } 2411 }
1650 undef $MAP_PREFETCHER; 2412 undef $MAP_PREFETCHER;
1651 }; 2413 };
1652 $MAP_PREFETCHER->prio (6); 2414 $MAP_PREFETCHER->prio (6);
1653 2415
1654 () 2416 ()
1655} 2417}
1656 2418
2419# common code, used by both ->save and ->swapout
1657sub save { 2420sub _save {
1658 my ($self) = @_; 2421 my ($self) = @_;
1659
1660 my $lock = cf::lock_acquire "map_data:" . $self->path;
1661 2422
1662 $self->{last_save} = $cf::RUNTIME; 2423 $self->{last_save} = $cf::RUNTIME;
1663 2424
1664 return unless $self->dirty; 2425 return unless $self->dirty;
1665 2426
1671 return if $self->{deny_save}; 2432 return if $self->{deny_save};
1672 2433
1673 local $self->{last_access} = $self->last_access;#d# 2434 local $self->{last_access} = $self->last_access;#d#
1674 2435
1675 cf::async { 2436 cf::async {
2437 $Coro::current->{desc} = "map player save";
1676 $_->contr->save for $self->players; 2438 $_->contr->save for $self->players;
1677 }; 2439 };
2440
2441 cf::get_slot 0.02;
1678 2442
1679 if ($uniq) { 2443 if ($uniq) {
1680 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 2444 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1681 $self->_save_objects ($uniq, cf::IO_UNIQUES); 2445 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1682 } else { 2446 } else {
1683 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES); 2447 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1684 } 2448 }
1685} 2449}
1686 2450
2451sub save {
2452 my ($self) = @_;
2453
2454 my $lock = cf::lock_acquire "map_data:$self->{path}";
2455
2456 $self->_save;
2457}
2458
1687sub swap_out { 2459sub swap_out {
1688 my ($self) = @_; 2460 my ($self) = @_;
1689 2461
1690 # save first because save cedes
1691 $self->save;
1692
1693 my $lock = cf::lock_acquire "map_data:" . $self->path; 2462 my $lock = cf::lock_acquire "map_data:$self->{path}";
1694 2463
2464 return if !$self->linkable;
2465 return if $self->{deny_save};
1695 return if $self->players; 2466 return if $self->players;
1696 return if $self->in_memory != cf::MAP_IN_MEMORY;
1697 return if $self->{deny_save};
1698 2467
2468 # first deactivate the map and "unlink" it from the core
2469 $self->deactivate;
2470 $_->clear_links_to ($self) for values %cf::MAP;
2471 $self->state (cf::MAP_SWAPPED);
2472
2473 # then atomically save
2474 $self->_save;
2475
2476 # then free the map
1699 $self->clear; 2477 $self->clear;
1700 $self->in_memory (cf::MAP_SWAPPED);
1701} 2478}
1702 2479
1703sub reset_at { 2480sub reset_at {
1704 my ($self) = @_; 2481 my ($self) = @_;
1705 2482
1706 # TODO: safety, remove and allow resettable per-player maps 2483 # TODO: safety, remove and allow resettable per-player maps
1707 return 1e99 if $self->isa ("ext::map_per_player");#d#
1708 return 1e99 if $self->{deny_reset}; 2484 return 1e99 if $self->{deny_reset};
1709 2485
1710 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2486 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1711 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2487 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1712 2488
1723 my ($self) = @_; 2499 my ($self) = @_;
1724 2500
1725 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2501 my $lock = cf::lock_acquire "map_data:$self->{path}";
1726 2502
1727 return if $self->players; 2503 return if $self->players;
1728 return if $self->isa ("ext::map_per_player");#d#
1729 2504
1730 warn "resetting map ", $self->path;#d# 2505 cf::trace "resetting map ", $self->path, "\n";
1731 2506
1732 $self->in_memory (cf::MAP_SWAPPED); 2507 $self->state (cf::MAP_SWAPPED);
1733 2508
1734 # need to save uniques path 2509 # need to save uniques path
1735 unless ($self->{deny_save}) { 2510 unless ($self->{deny_save}) {
1736 my $uniq = $self->uniq_path; utf8::encode $uniq; 2511 my $uniq = $self->uniq_path; utf8::encode $uniq;
1737 2512
1739 if $uniq; 2514 if $uniq;
1740 } 2515 }
1741 2516
1742 delete $cf::MAP{$self->path}; 2517 delete $cf::MAP{$self->path};
1743 2518
2519 $self->deactivate;
2520 $_->clear_links_to ($self) for values %cf::MAP;
1744 $self->clear; 2521 $self->clear;
1745
1746 $_->clear_links_to ($self) for values %cf::MAP;
1747 2522
1748 $self->unlink_save; 2523 $self->unlink_save;
1749 $self->destroy; 2524 $self->destroy;
1750} 2525}
1751 2526
1752my $nuke_counter = "aaaa"; 2527my $nuke_counter = "aaaa";
1753 2528
1754sub nuke { 2529sub nuke {
1755 my ($self) = @_; 2530 my ($self) = @_;
1756 2531
2532 {
2533 my $lock = cf::lock_acquire "map_data:$self->{path}";
2534
1757 delete $cf::MAP{$self->path}; 2535 delete $cf::MAP{$self->path};
1758 2536
1759 $self->unlink_save; 2537 $self->unlink_save;
1760 2538
1761 bless $self, "cf::map"; 2539 bless $self, "cf::map::wrap";
1762 delete $self->{deny_reset}; 2540 delete $self->{deny_reset};
1763 $self->{deny_save} = 1; 2541 $self->{deny_save} = 1;
1764 $self->reset_timeout (1); 2542 $self->reset_timeout (1);
1765 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++)); 2543 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1766 2544
1767 $cf::MAP{$self->path} = $self; 2545 $cf::MAP{$self->path} = $self;
2546 }
1768 2547
1769 $self->reset; # polite request, might not happen 2548 $self->reset; # polite request, might not happen
2549}
2550
2551=item $maps = cf::map::tmp_maps
2552
2553Returns an arrayref with all map paths of currently instantiated and saved
2554maps. May block.
2555
2556=cut
2557
2558sub tmp_maps() {
2559 [
2560 map {
2561 utf8::decode $_;
2562 /\.map$/
2563 ? normalise $_
2564 : ()
2565 } @{ aio_readdir $TMPDIR or [] }
2566 ]
2567}
2568
2569=item $maps = cf::map::random_maps
2570
2571Returns an arrayref with all map paths of currently instantiated and saved
2572random maps. May block.
2573
2574=cut
2575
2576sub random_maps() {
2577 [
2578 map {
2579 utf8::decode $_;
2580 /\.map$/
2581 ? normalise "?random/$_"
2582 : ()
2583 } @{ aio_readdir $RANDOMDIR or [] }
2584 ]
1770} 2585}
1771 2586
1772=item cf::map::unique_maps 2587=item cf::map::unique_maps
1773 2588
1774Returns an arrayref of paths of all shared maps that have 2589Returns an arrayref of paths of all shared maps that have
1775instantiated unique items. May block. 2590instantiated unique items. May block.
1776 2591
1777=cut 2592=cut
1778 2593
1779sub unique_maps() { 2594sub unique_maps() {
1780 my $files = aio_readdir $UNIQUEDIR 2595 [
1781 or return; 2596 map {
1782
1783 my @paths;
1784
1785 for (@$files) {
1786 utf8::decode $_; 2597 utf8::decode $_;
1787 next if /\.pst$/; 2598 s/\.map$//; # TODO future compatibility hack
1788 next unless /^$PATH_SEP/o; 2599 /\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
1789 2600 ? ()
1790 push @paths, cf::map::normalise $_; 2601 : normalise $_
2602 } @{ aio_readdir $UNIQUEDIR or [] }
1791 } 2603 ]
1792
1793 \@paths
1794} 2604}
1795 2605
1796package cf; 2606=item cf::map::static_maps
2607
2608Returns an arrayref if paths of all static maps (all preinstalled F<.map>
2609file in the shared directory excluding F</styles> and F</editor>). May
2610block.
2611
2612=cut
2613
2614sub static_maps() {
2615 my @dirs = "";
2616 my @maps;
2617
2618 while (@dirs) {
2619 my $dir = shift @dirs;
2620
2621 next if $dir eq "/styles" || $dir eq "/editor";
2622
2623 my ($dirs, $files) = Coro::AIO::aio_scandir "$MAPDIR$dir", 2
2624 or return;
2625
2626 for (@$files) {
2627 s/\.map$// or next;
2628 utf8::decode $_;
2629 push @maps, "$dir/$_";
2630 }
2631
2632 push @dirs, map "$dir/$_", @$dirs;
2633 }
2634
2635 \@maps
2636}
1797 2637
1798=back 2638=back
1799 2639
1800=head3 cf::object 2640=head3 cf::object
1801 2641
1805 2645
1806=over 4 2646=over 4
1807 2647
1808=item $ob->inv_recursive 2648=item $ob->inv_recursive
1809 2649
1810Returns the inventory of the object _and_ their inventories, recursively. 2650Returns the inventory of the object I<and> their inventories, recursively,
2651but I<not> the object itself.
1811 2652
1812=cut 2653=cut
1813 2654
1814sub inv_recursive_; 2655sub inv_recursive_;
1815sub inv_recursive_ { 2656sub inv_recursive_ {
1818 2659
1819sub inv_recursive { 2660sub inv_recursive {
1820 inv_recursive_ inv $_[0] 2661 inv_recursive_ inv $_[0]
1821} 2662}
1822 2663
2664=item $ref = $ob->ref
2665
2666Creates and returns a persistent reference to an object that can be stored as a string.
2667
2668=item $ob = cf::object::deref ($refstring)
2669
2670returns the objetc referenced by refstring. may return undef when it cannot find the object,
2671even if the object actually exists. May block.
2672
2673=cut
2674
2675sub deref {
2676 my ($ref) = @_;
2677
2678 if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
2679 my ($uuid, $name) = ($1, $2);
2680 my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
2681 or return;
2682 $pl->ob->uuid eq $uuid
2683 or return;
2684
2685 $pl->ob
2686 } else {
2687 warn "$ref: cannot resolve object reference\n";
2688 undef
2689 }
2690}
2691
1823package cf; 2692package cf;
1824 2693
1825=back 2694=back
1826 2695
1827=head3 cf::object::player 2696=head3 cf::object::player
1833Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 2702Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
1834can be C<undef>. Does the right thing when the player is currently in a 2703can be C<undef>. Does the right thing when the player is currently in a
1835dialogue with the given NPC character. 2704dialogue with the given NPC character.
1836 2705
1837=cut 2706=cut
2707
2708our $SAY_CHANNEL = {
2709 id => "say",
2710 title => "Map",
2711 reply => "say ",
2712 tooltip => "Things said to and replied from NPCs near you and other players on the same map only.",
2713};
2714
2715our $CHAT_CHANNEL = {
2716 id => "chat",
2717 title => "Chat",
2718 reply => "chat ",
2719 tooltip => "Player chat and shouts, global to the server.",
2720};
1838 2721
1839# rough implementation of a future "reply" method that works 2722# rough implementation of a future "reply" method that works
1840# with dialog boxes. 2723# with dialog boxes.
1841#TODO: the first argument must go, split into a $npc->reply_to ( method 2724#TODO: the first argument must go, split into a $npc->reply_to ( method
1842sub cf::object::player::reply($$$;$) { 2725sub cf::object::player::reply($$$;$) {
1844 2727
1845 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2728 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1846 2729
1847 if ($self->{record_replies}) { 2730 if ($self->{record_replies}) {
1848 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2731 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2732
1849 } else { 2733 } else {
2734 my $pl = $self->contr;
2735
2736 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2737 my $dialog = $pl->{npc_dialog};
2738 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2739
2740 } else {
1850 $msg = $npc->name . " says: $msg" if $npc; 2741 $msg = $npc->name . " says: $msg" if $npc;
1851 $self->message ($msg, $flags); 2742 $self->send_msg ($SAY_CHANNEL => $msg, $flags);
2743 }
1852 } 2744 }
2745}
2746
2747=item $object->send_msg ($channel, $msg, $color, [extra...])
2748
2749=cut
2750
2751sub cf::object::send_msg {
2752 my $pl = shift->contr
2753 or return;
2754 $pl->send_msg (@_);
1853} 2755}
1854 2756
1855=item $player_object->may ("access") 2757=item $player_object->may ("access")
1856 2758
1857Returns wether the given player is authorized to access resource "access" 2759Returns wether the given player is authorized to access resource "access"
1858(e.g. "command_wizcast"). 2760(e.g. "command_wizcast").
1859 2761
2762This is implemented by checking a config setting of C<may_access> where
2763C<access> is replaced by the access string. The following alternatives are
2764possible (and are tested in order):
2765
2766=over 4
2767
2768=item * Player is DM
2769
2770The request will succeed.
2771
2772=item * may_access is an array reference
2773
2774If either the player nickname or UUID is in the array, the request will
2775succeed, otherwise it will fail.
2776
2777=item * may_access is a true value
2778
2779The request will succeed.
2780
2781=item * may_access is missing or false
2782
2783The request will fail.
2784
2785=back
2786
1860=cut 2787=cut
1861 2788
1862sub cf::object::player::may { 2789sub cf::object::player::may {
1863 my ($self, $access) = @_; 2790 my ($self, $access) = @_;
1864 2791
1865 $self->flag (cf::FLAG_WIZ) || 2792 $self->flag (cf::FLAG_WIZ) ||
1866 (ref $cf::CFG{"may_$access"} 2793 (ref $cf::CFG{"may_$access"}
1867 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 2794 ? scalar grep $self->name eq $_ || $self->uuid eq $_, @{$cf::CFG{"may_$access"}}
1868 : $cf::CFG{"may_$access"}) 2795 : $cf::CFG{"may_$access"})
1869} 2796}
1870 2797
1871=item $player_object->enter_link 2798=item $player_object->enter_link
1872 2799
1873Freezes the player and moves him/her to a special map (C<{link}>). 2800Freezes the player and moves him/her to a special map (C<{link}>).
1874 2801
1875The player should be reasonably safe there for short amounts of time. You 2802The player should be reasonably safe there for short amounts of time (e.g.
1876I<MUST> call C<leave_link> as soon as possible, though. 2803for loading a map). You I<MUST> call C<leave_link> as soon as possible,
2804though, as the player cannot control the character while it is on the link
2805map.
1877 2806
1878Will never block. 2807This method will never block, which is the whole reaosn for it's
2808existance: you can I<always> put a player onto the link map, which is the
2809only place to put objects that is guaranteed to exist.
2810
2811A typical usage pattern is to call C<enter_link> synchronously from the
2812server, then start a new thread, do your blocking stuff there and then
2813call C<leave_link> from that thread.
1879 2814
1880=item $player_object->leave_link ($map, $x, $y) 2815=item $player_object->leave_link ($map, $x, $y)
1881 2816
1882Moves the player out of the special C<{link}> map onto the specified 2817Moves the player out of the special C<{link}> map onto the specified
1883map. If the map is not valid (or omitted), the player will be moved back 2818map. If the map is not valid (or omitted), the player will be moved back
1901sub cf::object::player::enter_link { 2836sub cf::object::player::enter_link {
1902 my ($self) = @_; 2837 my ($self) = @_;
1903 2838
1904 $self->deactivate_recursive; 2839 $self->deactivate_recursive;
1905 2840
2841 ++$self->{_link_recursion};
2842
1906 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2843 return if UNIVERSAL::isa $self->map, "ext::map_link";
1907 2844
1908 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2845 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1909 if $self->map; 2846 if $self->map && $self->map->{path} ne "{link}";
1910 2847
1911 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2848 $self->enter_map ($LINK_MAP || link_map, 3, 3);
1912} 2849}
1913 2850
1914sub cf::object::player::leave_link { 2851sub cf::object::player::leave_link {
1915 my ($self, $map, $x, $y) = @_; 2852 my ($self, $map, $x, $y) = @_;
2853
2854 return unless $self->contr->active;
1916 2855
1917 my $link_pos = delete $self->{_link_pos}; 2856 my $link_pos = delete $self->{_link_pos};
1918 2857
1919 unless ($map) { 2858 unless ($map) {
1920 # restore original map position 2859 # restore original map position
1931 ($x, $y) = (-1, -1) 2870 ($x, $y) = (-1, -1)
1932 unless (defined $x) && (defined $y); 2871 unless (defined $x) && (defined $y);
1933 2872
1934 # use -1 or undef as default coordinates, not 0, 0 2873 # use -1 or undef as default coordinates, not 0, 0
1935 ($x, $y) = ($map->enter_x, $map->enter_y) 2874 ($x, $y) = ($map->enter_x, $map->enter_y)
1936 if $x <=0 && $y <= 0; 2875 if $x <= 0 && $y <= 0;
1937 2876
1938 $map->load; 2877 $map->load;
1939 $map->load_diag;
1940 2878
1941 return unless $self->contr->active; 2879 return unless $self->contr->active;
1942 $self->activate_recursive;
1943 2880
1944 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2881 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1945 $self->enter_map ($map, $x, $y); 2882 if ($self->enter_map ($map, $x, $y)) {
1946} 2883 # entering was successful
1947 2884 delete $self->{_link_recursion};
1948cf::player->attach ( 2885 # only activate afterwards, to support waiting in hooks
1949 on_logout => sub { 2886 $self->activate_recursive;
1950 my ($pl) = @_;
1951
1952 # abort map switching before logout
1953 if ($pl->ob->{_link_pos}) {
1954 cf::sync_job {
1955 $pl->ob->leave_link
1956 };
1957 }
1958 }, 2887 }
1959 on_login => sub {
1960 my ($pl) = @_;
1961 2888
1962 # try to abort aborted map switching on player login :) 2889}
1963 # should happen only on crashes
1964 if ($pl->ob->{_link_pos}) {
1965 $pl->ob->enter_link;
1966 (async {
1967 $pl->ob->reply (undef,
1968 "There was an internal problem at your last logout, "
1969 . "the server will try to bring you to your intended destination in a second.",
1970 cf::NDI_RED);
1971 # we need this sleep as the login has a concurrent enter_exit running
1972 # and this sleep increases chances of the player not ending up in scorn
1973 Coro::Timer::sleep 1;
1974 $pl->ob->leave_link;
1975 })->prio (2);
1976 }
1977 },
1978);
1979 2890
1980=item $player_object->goto ($path, $x, $y[, $check->($map)]) 2891=item $player_object->goto ($path, $x, $y[, $check->($map, $x, $y, $player)[, $done->($player)]])
1981 2892
1982Moves the player to the given map-path and coordinates by first freezing 2893Moves the player to the given map-path and coordinates by first freezing
1983her, loading and preparing them map, calling the provided $check callback 2894her, loading and preparing them map, calling the provided $check callback
1984that has to return the map if sucecssful, and then unfreezes the player on 2895that has to return the map if sucecssful, and then unfreezes the player on
1985the new (success) or old (failed) map position. 2896the new (success) or old (failed) map position. In either case, $done will
2897be called at the end of this process.
1986 2898
2899Note that $check will be called with a potentially non-loaded map, so if
2900it needs a loaded map it has to call C<< ->load >>.
2901
1987=cut 2902=cut
2903
2904our $GOTOGEN;
1988 2905
1989sub cf::object::player::goto { 2906sub cf::object::player::goto {
1990 my ($self, $path, $x, $y, $check) = @_; 2907 my ($self, $path, $x, $y, $check, $done) = @_;
2908
2909 if ($self->{_link_recursion} >= $MAX_LINKS) {
2910 error "FATAL: link recursion exceeded, ", $self->name, " goto $path $x $y, redirecting.";
2911 $self->failmsg ("Something went wrong inside the server - please contact an administrator!");
2912 ($path, $x, $y) = @$EMERGENCY_POSITION;
2913 }
2914
2915 # do generation counting so two concurrent goto's will be executed in-order
2916 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1991 2917
1992 $self->enter_link; 2918 $self->enter_link;
1993 2919
1994 (async { 2920 (async {
2921 $Coro::current->{desc} = "player::goto $path $x $y";
2922
2923 # *tag paths override both path and x|y
2924 if ($path =~ /^\*(.*)$/) {
2925 if (my @obs = grep $_->map, ext::map_tags::find $1) {
2926 my $ob = $obs[rand @obs];
2927
2928 # see if we actually can go there
2929 if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
2930 $ob = $obs[rand @obs];
2931 } else {
2932 $self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
2933 }
2934 # else put us there anyways for now #d#
2935
2936 ($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
2937 } else {
2938 ($path, $x, $y) = (undef, undef, undef);
2939 }
2940 }
2941
1995 my $map = eval { 2942 my $map = eval {
1996 my $map = cf::map::find $path; 2943 my $map = defined $path ? cf::map::find $path, $self->map : undef;
1997 2944
1998 if ($map) { 2945 if ($map) {
1999 $map = $map->customise_for ($self); 2946 $map = $map->customise_for ($self);
2000 $map = $check->($map) if $check && $map; 2947 $map = $check->($map, $x, $y, $self) if $check && $map;
2001 } else { 2948 } else {
2002 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED); 2949 $self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
2003 } 2950 }
2004 2951
2005 $map 2952 $map
2006 }; 2953 };
2007 2954
2008 if ($@) { 2955 if ($@) {
2009 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED); 2956 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2010 LOG llevError | logBacktrace, Carp::longmess $@; 2957 LOG llevError | logBacktrace, Carp::longmess $@;
2011 } 2958 }
2012 2959
2960 if ($gen == $self->{_goto_generation}) {
2961 delete $self->{_goto_generation};
2013 $self->leave_link ($map, $x, $y); 2962 $self->leave_link ($map, $x, $y);
2963 }
2964
2965 $done->($self) if $done;
2014 })->prio (1); 2966 })->prio (1);
2015} 2967}
2016 2968
2017=item $player_object->enter_exit ($exit_object) 2969=item $player_object->enter_exit ($exit_object)
2018 2970
2038} 2990}
2039 2991
2040sub prepare_random_map { 2992sub prepare_random_map {
2041 my ($exit) = @_; 2993 my ($exit) = @_;
2042 2994
2043 my $guard = cf::lock_acquire "exit_prepare:$exit";
2044
2045 # all this does is basically replace the /! path by 2995 # all this does is basically replace the /! path by
2046 # a new random map path (?random/...) with a seed 2996 # a new random map path (?random/...) with a seed
2047 # that depends on the exit object 2997 # that depends on the exit object
2048 2998
2049 my $rmp = parse_random_map_params $exit->msg; 2999 my $rmp = parse_random_map_params $exit->msg;
2051 if ($exit->map) { 3001 if ($exit->map) {
2052 $rmp->{region} = $exit->region->name; 3002 $rmp->{region} = $exit->region->name;
2053 $rmp->{origin_map} = $exit->map->path; 3003 $rmp->{origin_map} = $exit->map->path;
2054 $rmp->{origin_x} = $exit->x; 3004 $rmp->{origin_x} = $exit->x;
2055 $rmp->{origin_y} = $exit->y; 3005 $rmp->{origin_y} = $exit->y;
3006
3007 $exit->map->touch;
2056 } 3008 }
2057 3009
2058 $rmp->{random_seed} ||= $exit->random_seed; 3010 $rmp->{random_seed} ||= $exit->random_seed;
2059 3011
2060 my $data = cf::to_json $rmp; 3012 my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
2061 my $md5 = Digest::MD5::md5_hex $data; 3013 my $md5 = Digest::MD5::md5_hex $data;
2062 my $meta = "$RANDOMDIR/$md5.meta"; 3014 my $meta = "$RANDOMDIR/$md5.meta";
2063 3015
2064 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 3016 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
2065 aio_write $fh, 0, (length $data), $data, 0; 3017 aio_write $fh, 0, (length $data), $data, 0;
2066 undef $fh; 3018 undef $fh;
2067 aio_rename "$meta~", $meta; 3019 aio_rename "$meta~", $meta;
2068 3020
3021 my $slaying = "?random/$md5";
3022
3023 if ($exit->valid) {
2069 $exit->slaying ("?random/$md5"); 3024 $exit->slaying ("?random/$md5");
2070 $exit->msg (undef); 3025 $exit->msg (undef);
3026 }
2071 } 3027 }
2072} 3028}
2073 3029
2074sub cf::object::player::enter_exit { 3030sub cf::object::player::enter_exit {
2075 my ($self, $exit) = @_; 3031 my ($self, $exit) = @_;
2076 3032
2077 return unless $self->type == cf::PLAYER; 3033 return unless $self->type == cf::PLAYER;
2078 3034
2079 if ($exit->slaying eq "/!") {
2080 #TODO: this should de-fi-ni-te-ly not be a sync-job
2081 # the problem is that $exit might not survive long enough
2082 # so it needs to be done right now, right here
2083 cf::sync_job { prepare_random_map $exit };
2084 }
2085
2086 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2087 my $hp = $exit->stats->hp;
2088 my $sp = $exit->stats->sp;
2089
2090 $self->enter_link; 3035 $self->enter_link;
2091 3036
2092 (async { 3037 (async {
2093 $self->deactivate_recursive; # just to be sure 3038 $Coro::current->{desc} = "enter_exit";
3039
2094 unless (eval { 3040 unless (eval {
3041 $self->deactivate_recursive; # just to be sure
3042
3043 my $map = cf::map::normalise $exit->slaying, $exit->map;
3044 my $x = $exit->stats->hp;
3045 my $y = $exit->stats->sp;
3046
3047 # special map handling
3048 my $slaying = $exit->slaying;
3049
3050 # special map handling
3051 if ($slaying eq "/!") {
3052 my $guard = cf::lock_acquire "exit_prepare:$exit";
3053
3054 prepare_random_map $exit
3055 if $exit->slaying eq "/!"; # need to re-check after getting the lock
3056
3057 $map = $exit->slaying;
3058
3059 } elsif ($slaying eq '!up') {
3060 $map = $exit->map->tile_path (cf::TILE_UP);
3061 $x = $exit->x;
3062 $y = $exit->y;
3063
3064 } elsif ($slaying eq '!down') {
3065 $map = $exit->map->tile_path (cf::TILE_DOWN);
3066 $x = $exit->x;
3067 $y = $exit->y;
3068 }
3069
2095 $self->goto ($slaying, $hp, $sp); 3070 $self->goto ($map, $x, $y);
2096 3071
3072 # if exit is damned, update players death & WoR home-position
3073 $self->contr->savebed ($map, $x, $y)
3074 if $exit->flag (cf::FLAG_DAMNED);
3075
2097 1; 3076 1
2098 }) { 3077 }) {
2099 $self->message ("Something went wrong deep within the crossfire server. " 3078 $self->message ("Something went wrong deep within the deliantra server. "
2100 . "I'll try to bring you back to the map you were before. " 3079 . "I'll try to bring you back to the map you were before. "
2101 . "Please report this to the dungeon master!", 3080 . "Please report this to the dungeon master!",
2102 cf::NDI_UNIQUE | cf::NDI_RED); 3081 cf::NDI_UNIQUE | cf::NDI_RED);
2103 3082
2104 warn "ERROR in enter_exit: $@"; 3083 error "ERROR in enter_exit: $@";
2105 $self->leave_link; 3084 $self->leave_link;
2106 } 3085 }
2107 })->prio (1); 3086 })->prio (1);
2108} 3087}
2109 3088
2110=head3 cf::client 3089=head3 cf::client
2111 3090
2112=over 4 3091=over 4
2113 3092
2114=item $client->send_drawinfo ($text, $flags) 3093=item $client->send_big_packet ($pkt)
2115 3094
2116Sends a drawinfo packet to the client. Circumvents output buffering so 3095Like C<send_packet>, but tries to compress large packets, and fragments
2117should not be used under normal circumstances. 3096them as required.
2118 3097
2119=cut 3098=cut
2120 3099
3100our $MAXFRAGSIZE = cf::MAXSOCKBUF - 64;
3101
3102sub cf::client::send_big_packet {
3103 my ($self, $pkt) = @_;
3104
3105 # try lzf for large packets
3106 $pkt = "lzf " . Compress::LZF::compress $pkt
3107 if 1024 <= length $pkt and $self->{can_lzf};
3108
3109 # split very large packets
3110 if ($MAXFRAGSIZE < length $pkt and $self->{can_lzf}) {
3111 $self->send_packet ("frag $_") for unpack "(a$MAXFRAGSIZE)*", $pkt;
3112 $pkt = "frag";
3113 }
3114
3115 $self->send_packet ($pkt);
3116}
3117
3118=item $client->send_msg ($channel, $msg, $color, [extra...])
3119
3120Send a msg packet to the client, formatting the msg for the client if
3121necessary. C<$type> should be a string identifying the type of the
3122message, with C<log> being the default. If C<$color> is negative, suppress
3123the message unless the client supports the msg packet.
3124
3125=cut
3126
3127# non-persistent channels (usually the info channel)
3128our %CHANNEL = (
3129 "c/motd" => {
3130 id => "infobox",
3131 title => "MOTD",
3132 reply => undef,
3133 tooltip => "The message of the day",
3134 },
3135 "c/identify" => {
3136 id => "infobox",
3137 title => "Identify",
3138 reply => undef,
3139 tooltip => "Items recently identified",
3140 },
3141 "c/examine" => {
3142 id => "infobox",
3143 title => "Examine",
3144 reply => undef,
3145 tooltip => "Signs and other items you examined",
3146 },
3147 "c/shopinfo" => {
3148 id => "infobox",
3149 title => "Shop Info",
3150 reply => undef,
3151 tooltip => "What your bargaining skill tells you about the shop",
3152 },
3153 "c/book" => {
3154 id => "infobox",
3155 title => "Book",
3156 reply => undef,
3157 tooltip => "The contents of a note or book",
3158 },
3159 "c/lookat" => {
3160 id => "infobox",
3161 title => "Look",
3162 reply => undef,
3163 tooltip => "What you saw there",
3164 },
3165 "c/who" => {
3166 id => "infobox",
3167 title => "Players",
3168 reply => undef,
3169 tooltip => "Shows players who are currently online",
3170 },
3171 "c/body" => {
3172 id => "infobox",
3173 title => "Body Parts",
3174 reply => undef,
3175 tooltip => "Shows which body parts you possess and are available",
3176 },
3177 "c/statistics" => {
3178 id => "infobox",
3179 title => "Statistics",
3180 reply => undef,
3181 tooltip => "Shows your primary statistics",
3182 },
3183 "c/skills" => {
3184 id => "infobox",
3185 title => "Skills",
3186 reply => undef,
3187 tooltip => "Shows your experience per skill and item power",
3188 },
3189 "c/shopitems" => {
3190 id => "infobox",
3191 title => "Shop Items",
3192 reply => undef,
3193 tooltip => "Shows the items currently for sale in this shop",
3194 },
3195 "c/resistances" => {
3196 id => "infobox",
3197 title => "Resistances",
3198 reply => undef,
3199 tooltip => "Shows your resistances",
3200 },
3201 "c/pets" => {
3202 id => "infobox",
3203 title => "Pets",
3204 reply => undef,
3205 tooltip => "Shows information abotu your pets/a specific pet",
3206 },
3207 "c/perceiveself" => {
3208 id => "infobox",
3209 title => "Perceive Self",
3210 reply => undef,
3211 tooltip => "You gained detailed knowledge about yourself",
3212 },
3213 "c/uptime" => {
3214 id => "infobox",
3215 title => "Uptime",
3216 reply => undef,
3217 tooltip => "How long the server has been running since last restart",
3218 },
3219 "c/mapinfo" => {
3220 id => "infobox",
3221 title => "Map Info",
3222 reply => undef,
3223 tooltip => "Information related to the maps",
3224 },
3225 "c/party" => {
3226 id => "party",
3227 title => "Party",
3228 reply => "gsay ",
3229 tooltip => "Messages and chat related to your party",
3230 },
3231 "c/death" => {
3232 id => "death",
3233 title => "Death",
3234 reply => undef,
3235 tooltip => "Reason for and more info about your most recent death",
3236 },
3237 "c/fatal" => {
3238 id => "fatal",
3239 title => "Fatal Error",
3240 reply => undef,
3241 tooltip => "Reason for the server disconnect",
3242 },
3243 "c/say" => $SAY_CHANNEL,
3244 "c/chat" => $CHAT_CHANNEL,
3245);
3246
2121sub cf::client::send_drawinfo { 3247sub cf::client::send_msg {
2122 my ($self, $text, $flags) = @_; 3248 my ($self, $channel, $msg, $color, @extra) = @_;
2123 3249
2124 utf8::encode $text; 3250 $msg = $self->pl->expand_cfpod ($msg)
2125 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 3251 unless $color & cf::NDI_VERBATIM;
2126}
2127 3252
3253 $color &= cf::NDI_CLIENT_MASK; # just in case...
3254
3255 # check predefined channels, for the benefit of C
3256 if ($CHANNEL{$channel}) {
3257 $channel = $CHANNEL{$channel};
3258
3259 $self->ext_msg (channel_info => $channel);
3260 $channel = $channel->{id};
3261
3262 } elsif (ref $channel) {
3263 # send meta info to client, if not yet sent
3264 unless (exists $self->{channel}{$channel->{id}}) {
3265 $self->{channel}{$channel->{id}} = $channel;
3266 $self->ext_msg (channel_info => $channel);
3267 }
3268
3269 $channel = $channel->{id};
3270 }
3271
3272 return unless @extra || length $msg;
3273
3274 # default colour, mask it out
3275 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
3276 if $color & cf::NDI_DEF;
3277
3278 my $pkt = "msg "
3279 . $self->{json_coder}->encode (
3280 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]
3281 );
3282
3283 $self->send_big_packet ($pkt);
3284}
3285
2128=item $client->ext_event ($type, %msg) 3286=item $client->ext_msg ($type, @msg)
2129 3287
2130Sends an exti event to the client. 3288Sends an ext event to the client.
2131 3289
2132=cut 3290=cut
2133 3291
2134sub cf::client::ext_event($$%) { 3292sub cf::client::ext_msg($$@) {
2135 my ($self, $type, %msg) = @_; 3293 my ($self, $type, @msg) = @_;
2136 3294
2137 $msg{msgtype} = "event_$type"; 3295 $self->send_big_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2138 $self->send_packet ("ext " . cf::to_json \%msg);
2139} 3296}
2140 3297
2141=item $success = $client->query ($flags, "text", \&cb) 3298=item $success = $client->query ($flags, "text", \&cb)
2142 3299
2143Queues a query to the client, calling the given callback with 3300Queues a query to the client, calling the given callback with
2144the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 3301the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2145C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 3302C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2146 3303
2147Queries can fail, so check the return code. Or don't, as queries will become 3304Queries can fail, so check the return code. Or don't, as queries will
2148reliable at some point in the future. 3305become reliable at some point in the future.
2149 3306
2150=cut 3307=cut
2151 3308
2152sub cf::client::query { 3309sub cf::client::query {
2153 my ($self, $flags, $text, $cb) = @_; 3310 my ($self, $flags, $text, $cb) = @_;
2161 utf8::encode $text; 3318 utf8::encode $text;
2162 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 3319 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2163 3320
2164 $self->send_packet ($self->{query_queue}[0][0]) 3321 $self->send_packet ($self->{query_queue}[0][0])
2165 if @{ $self->{query_queue} } == 1; 3322 if @{ $self->{query_queue} } == 1;
3323
3324 1
3325}
3326
3327=item $client->update_command_faces
3328
3329=cut
3330
3331our %COMMAND_FACE;
3332
3333sub cf::client::update_command_faces {
3334 my ($self) = @_;
3335
3336 my @faces = grep $_,
3337 $COMMAND_FACE{preferred},
3338 $COMMAND_FACE{standard},
3339 $COMMAND_FACE{skill},
3340 $self->pl->ob->flag (cf::FLAG_WIZ) ? $COMMAND_FACE{dm} : (),
3341 $COMMAND_FACE{emote},
3342 ;
3343
3344 $self->send_face ($_)
3345 for @faces;
3346 $self->flush_fx;
3347
3348 $self->ext_msg (command_list => @faces);
3349}
3350
3351=item cf::client::set_command_face $type, $commands
3352
3353=cut
3354
3355sub cf::client::set_command_face {
3356 my ($type, $list) = @_;
3357
3358 my $idx = &cf::face::set ( #d# ugly forward reference
3359 "command_list/$type" => cf::FT_RSRC,
3360 JSON::XS->new->utf8->encode ([ sort @$list ])
3361 );
3362
3363 $COMMAND_FACE{$type} = $idx;
2166} 3364}
2167 3365
2168cf::client->attach ( 3366cf::client->attach (
3367 on_connect => sub {
3368 my ($ns) = @_;
3369
3370 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
3371 },
2169 on_reply => sub { 3372 on_reply => sub {
2170 my ($ns, $msg) = @_; 3373 my ($ns, $msg) = @_;
2171 3374
2172 # this weird shuffling is so that direct followup queries 3375 # this weird shuffling is so that direct followup queries
2173 # get handled first 3376 # get handled first
2185 } else { 3388 } else {
2186 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 3389 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2187 } 3390 }
2188 } 3391 }
2189 }, 3392 },
3393 on_exticmd => sub {
3394 my ($ns, $buf) = @_;
3395
3396 my $msg = eval { $ns->{json_coder}->decode ($buf) };
3397
3398 if (ref $msg) {
3399 my ($type, $reply, @payload) = @$msg; # version 1 used %type, $id, %$hash
3400
3401 if (my $cb = $EXTIACMD{$type}) {
3402 $cb->(
3403 $ns,
3404 sub {
3405 $ns->ext_msg ("reply-$reply", @_)
3406 if $reply;
3407 },
3408 @payload
3409 );
3410 } else {
3411 my @reply;
3412
3413 if (my $cb = $EXTICMD{$type}) {
3414 @reply = $cb->($ns, @payload);
3415 }
3416
3417 $ns->ext_msg ("reply-$reply", @reply)
3418 if $reply;
3419 }
3420 } else {
3421 error "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
3422 }
3423
3424 cf::override;
3425 },
2190); 3426);
2191 3427
2192=item $client->async (\&cb) 3428=item $client->async (\&cb)
2193 3429
2194Create a new coroutine, running the specified callback. The coroutine will 3430Create a new coroutine, running the specified callback. The coroutine will
2210 3446
2211 $coro 3447 $coro
2212} 3448}
2213 3449
2214cf::client->attach ( 3450cf::client->attach (
2215 on_destroy => sub { 3451 on_client_destroy => sub {
2216 my ($ns) = @_; 3452 my ($ns) = @_;
2217 3453
2218 $_->cancel for values %{ (delete $ns->{_coro}) || {} }; 3454 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
2219 }, 3455 },
2220); 3456);
2235our $safe = new Safe "safe"; 3471our $safe = new Safe "safe";
2236our $safe_hole = new Safe::Hole; 3472our $safe_hole = new Safe::Hole;
2237 3473
2238$SIG{FPE} = 'IGNORE'; 3474$SIG{FPE} = 'IGNORE';
2239 3475
2240$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 3476$safe->permit_only (Opcode::opset qw(
3477 :base_core :base_mem :base_orig :base_math :base_loop
3478 grepstart grepwhile mapstart mapwhile
3479 sort time
3480));
2241 3481
2242# here we export the classes and methods available to script code 3482# here we export the classes and methods available to script code
2243 3483
2244=pod 3484=pod
2245 3485
2246The following functions and methods are available within a safe environment: 3486The following functions and methods are available within a safe environment:
2247 3487
2248 cf::object contr pay_amount pay_player map 3488 cf::object
3489 contr pay_amount pay_player map x y force_find force_add destroy
3490 insert remove name archname title slaying race decrease split
3491 value
3492
2249 cf::object::player player 3493 cf::object::player
2250 cf::player peaceful 3494 player
2251 cf::map trigger 3495
3496 cf::player
3497 peaceful
3498
3499 cf::map
3500 trigger
2252 3501
2253=cut 3502=cut
2254 3503
2255for ( 3504for (
2256 ["cf::object" => qw(contr pay_amount pay_player map)], 3505 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
3506 insert remove inv nrof name archname title slaying race
3507 decrease split destroy change_exp value msg lore send_msg)],
2257 ["cf::object::player" => qw(player)], 3508 ["cf::object::player" => qw(player)],
2258 ["cf::player" => qw(peaceful)], 3509 ["cf::player" => qw(peaceful send_msg)],
2259 ["cf::map" => qw(trigger)], 3510 ["cf::map" => qw(trigger)],
2260) { 3511) {
2261 no strict 'refs';
2262 my ($pkg, @funs) = @$_; 3512 my ($pkg, @funs) = @$_;
2263 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 3513 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
2264 for @funs; 3514 for @funs;
2265} 3515}
2266 3516
2281 3531
2282 my $qcode = $code; 3532 my $qcode = $code;
2283 $qcode =~ s/"/‟/g; # not allowed in #line filenames 3533 $qcode =~ s/"/‟/g; # not allowed in #line filenames
2284 $qcode =~ s/\n/\\n/g; 3534 $qcode =~ s/\n/\\n/g;
2285 3535
3536 %vars = (_dummy => 0) unless %vars;
3537
3538 my @res;
2286 local $_; 3539 local $_;
2287 local @safe::cf::_safe_eval_args = values %vars;
2288 3540
2289 my $eval = 3541 my $eval =
2290 "do {\n" 3542 "do {\n"
2291 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n" 3543 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
2292 . "#line 0 \"{$qcode}\"\n" 3544 . "#line 0 \"{$qcode}\"\n"
2293 . $code 3545 . $code
2294 . "\n}" 3546 . "\n}"
2295 ; 3547 ;
2296 3548
3549 if ($CFG{safe_eval}) {
2297 sub_generation_inc; 3550 sub_generation_inc;
3551 local @safe::cf::_safe_eval_args = values %vars;
2298 my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval); 3552 @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
2299 sub_generation_inc; 3553 sub_generation_inc;
3554 } else {
3555 local @cf::_safe_eval_args = values %vars;
3556 @res = wantarray ? eval eval : scalar eval $eval;
3557 }
2300 3558
2301 if ($@) { 3559 if ($@) {
2302 warn "$@"; 3560 warn "$@",
2303 warn "while executing safe code '$code'\n"; 3561 "while executing safe code '$code'\n",
2304 warn "with arguments " . (join " ", %vars) . "\n"; 3562 "with arguments " . (join " ", %vars) . "\n";
2305 } 3563 }
2306 3564
2307 wantarray ? @res : $res[0] 3565 wantarray ? @res : $res[0]
2308} 3566}
2309 3567
2323=cut 3581=cut
2324 3582
2325sub register_script_function { 3583sub register_script_function {
2326 my ($fun, $cb) = @_; 3584 my ($fun, $cb) = @_;
2327 3585
2328 no strict 'refs'; 3586 $fun = "safe::$fun" if $CFG{safe_eval};
2329 *{"safe::$fun"} = $safe_hole->wrap ($cb); 3587 *$fun = $safe_hole->wrap ($cb);
2330} 3588}
2331 3589
2332=back 3590=back
2333 3591
2334=cut 3592=cut
2335
2336#############################################################################
2337
2338=head2 EXTENSION DATABASE SUPPORT
2339
2340Crossfire maintains a very simple database for extension use. It can
2341currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2342convert to/from binary).
2343
2344The parameter C<$family> should best start with the name of the extension
2345using it, it should be unique.
2346
2347=over 4
2348
2349=item $value = cf::db_get $family => $key
2350
2351Returns a single value from the database.
2352
2353=item cf::db_put $family => $key => $value
2354
2355Stores the given C<$value> in the family.
2356
2357=cut
2358
2359our $DB;
2360
2361sub db_init {
2362 unless ($DB) {
2363 $DB = BDB::db_create $DB_ENV;
2364
2365 cf::sync_job {
2366 eval {
2367 $DB->set_flags (BDB::CHKSUM);
2368
2369 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2370 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2371 cf::cleanup "db_open(db): $!" if $!;
2372 };
2373 cf::cleanup "db_open(db): $@" if $@;
2374 };
2375 }
2376}
2377
2378sub db_get($$) {
2379 my $key = "$_[0]/$_[1]";
2380
2381 cf::sync_job {
2382 BDB::db_get $DB, undef, $key, my $data;
2383
2384 $! ? ()
2385 : $data
2386 }
2387}
2388
2389sub db_put($$$) {
2390 BDB::dbreq_pri 4;
2391 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2392}
2393
2394=item cf::cache $id => [$paths...], $processversion => $process
2395
2396Generic caching function that returns the value of the resource $id,
2397caching and regenerating as required.
2398
2399This function can block.
2400
2401=cut
2402
2403sub cache {
2404 my ($id, $src, $processversion, $process) = @_;
2405
2406 my $meta =
2407 join "\x00",
2408 $processversion,
2409 map {
2410 aio_stat $_
2411 and Carp::croak "$_: $!";
2412
2413 ($_, (stat _)[7,9])
2414 } @$src;
2415
2416 my $dbmeta = db_get cache => "$id/meta";
2417 if ($dbmeta ne $meta) {
2418 # changed, we may need to process
2419
2420 my @data;
2421 my $md5;
2422
2423 for (0 .. $#$src) {
2424 0 <= aio_load $src->[$_], $data[$_]
2425 or Carp::croak "$src->[$_]: $!";
2426 }
2427
2428 # if processing is expensive, check
2429 # checksum first
2430 if (1) {
2431 $md5 =
2432 join "\x00",
2433 $processversion,
2434 map {
2435 Coro::cede;
2436 ($src->[$_], Digest::MD5::md5_hex $data[$_])
2437 } 0.. $#$src;
2438
2439
2440 my $dbmd5 = db_get cache => "$id/md5";
2441 if ($dbmd5 eq $md5) {
2442 db_put cache => "$id/meta", $meta;
2443
2444 return db_get cache => "$id/data";
2445 }
2446 }
2447
2448 my $t1 = Time::HiRes::time;
2449 my $data = $process->(\@data);
2450 my $t2 = Time::HiRes::time;
2451
2452 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2453
2454 db_put cache => "$id/data", $data;
2455 db_put cache => "$id/md5" , $md5;
2456 db_put cache => "$id/meta", $meta;
2457
2458 return $data;
2459 }
2460
2461 db_get cache => "$id/data"
2462}
2463
2464=item fork_call { }, $args
2465
2466Executes the given code block with the given arguments in a seperate
2467process, returning the results. Everything must be serialisable with
2468Coro::Storable. May, of course, block. Note that the executed sub may
2469never block itself or use any form of Event handling.
2470
2471=cut
2472
2473sub fork_call(&@) {
2474 my ($cb, @args) = @_;
2475
2476# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2477# or die "socketpair: $!";
2478 pipe my $fh1, my $fh2
2479 or die "pipe: $!";
2480
2481 if (my $pid = fork) {
2482 close $fh2;
2483
2484 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2485 $res = Coro::Storable::thaw $res;
2486
2487 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2488
2489 die $$res unless "ARRAY" eq ref $res;
2490
2491 return wantarray ? @$res : $res->[-1];
2492 } else {
2493 reset_signals;
2494 local $SIG{__WARN__};
2495 local $SIG{__DIE__};
2496 eval {
2497 close $fh1;
2498
2499 my @res = eval { $cb->(@args) };
2500 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2501 };
2502
2503 warn $@ if $@;
2504 _exit 0;
2505 }
2506}
2507
2508
2509 3593
2510############################################################################# 3594#############################################################################
2511# the server's init and main functions 3595# the server's init and main functions
2512 3596
3597{
3598 package cf::face;
3599
3600 our %HASH; # hash => idx
3601 our @DATA; # dynamically-created facedata, only faceste 0 used
3602 our @FOFS; # file offset, if > 0
3603 our @SIZE; # size of face, in octets
3604 our @META; # meta hash of face, if any
3605 our $DATAFH; # facedata filehandle
3606
3607 # internal api, not finalised
3608 sub set {
3609 my ($name, $type, $data) = @_;
3610
3611 my $idx = cf::face::find $name;
3612
3613 if ($idx) {
3614 delete $HASH{cf::face::get_csum $idx};
3615 } else {
3616 $idx = cf::face::alloc $name;
3617 }
3618
3619 my $hash = cf::face::mangle_csum Digest::MD5::md5 $data;
3620
3621 cf::face::set_type $idx, $type;
3622 cf::face::set_csum $idx, 0, $hash;
3623
3624 # we need to destroy the SV itself, not just modify it, as a running ix
3625 # might hold a reference to it: "delete" achieves that.
3626 delete $FOFS[0][$idx];
3627 delete $DATA[0][$idx];
3628 $DATA[0][$idx] = $data;
3629 $SIZE[0][$idx] = length $data;
3630 delete $META[$idx];
3631 $HASH{$hash} = $idx;#d#
3632
3633 $idx
3634 }
3635
3636 sub _get_data($$$) {
3637 my ($idx, $set, $cb) = @_;
3638
3639 if (defined $DATA[$set][$idx]) {
3640 $cb->($DATA[$set][$idx]);
3641 } elsif (my $fofs = $FOFS[$set][$idx]) {
3642 my $size = $SIZE[$set][$idx];
3643 my $buf;
3644 IO::AIO::aio_read $DATAFH, $fofs, $size, $buf, 0, sub {
3645 if ($_[0] == $size) {
3646 #cf::debug "read face $idx, $size from $fofs as ", length $buf;#d#
3647 $cb->($buf);
3648 } else {
3649 cf::error "INTERNAL ERROR: unable to read facedata for face $idx#$set ($size, $fofs), ignoring request.";
3650 }
3651 };
3652 } else {
3653 cf::error "requested facedata for unknown face $idx#$set, ignoring.";
3654 }
3655 }
3656
3657 # rather ineffient
3658 sub cf::face::get_data($;$) {
3659 my ($idx, $set) = @_;
3660
3661 _get_data $idx, $set, Coro::rouse_cb;
3662 Coro::rouse_wait
3663 }
3664
3665 sub cf::face::ix {
3666 my ($ns, $set, $idx, $pri) = @_;
3667
3668 _get_data $idx, $set, sub {
3669 $ns->ix_send ($idx, $pri, $_[0]);
3670 };
3671 }
3672}
3673
2513sub load_facedata($) { 3674sub load_facedata($) {
2514 my ($path) = @_; 3675 my ($path) = @_;
2515 3676
3677 my $enc = JSON::XS->new->utf8->canonical->relaxed;
3678
2516 warn "loading facedata from $path\n"; 3679 trace "loading facedata from $path\n";
2517 3680
2518 my $facedata; 3681 my $facedata = decode_storable load_file "$path/faceinfo";
2519 0 < aio_load $path, $facedata
2520 or die "$path: $!";
2521
2522 $facedata = Coro::Storable::thaw $facedata;
2523 3682
2524 $facedata->{version} == 2 3683 $facedata->{version} == 2
2525 or cf::cleanup "$path: version mismatch, cannot proceed."; 3684 or cf::cleanup "$path/faceinfo: version mismatch, cannot proceed.";
3685
3686 my $fh = aio_open "$DATADIR/facedata", IO::AIO::O_RDONLY, 0
3687 or cf::cleanup "$path/facedata: $!, cannot proceed.";
3688
3689 get_slot 1, -100, "load_facedata"; # make sure we get a very big slot
3690
3691 # BEGIN ATOMIC
3692 # from here on, everything must be atomic - no thread switch allowed
3693 my $t1 = EV::time;
2526 3694
2527 { 3695 {
2528 my $faces = $facedata->{faceinfo}; 3696 my $faces = $facedata->{faceinfo};
2529 3697
2530 while (my ($face, $info) = each %$faces) { 3698 for my $face (sort keys %$faces) {
3699 my $info = $faces->{$face};
2531 my $idx = (cf::face::find $face) || cf::face::alloc $face; 3700 my $idx = (cf::face::find $face) || cf::face::alloc $face;
3701
2532 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 3702 cf::face::set_visibility $idx, $info->{visibility};
2533 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 3703 cf::face::set_magicmap $idx, $info->{magicmap};
2534 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 3704 cf::face::set_csum $idx, 0, $info->{hash64}; $cf::face::SIZE[0][$idx] = $info->{size64}; $cf::face::FOFS[0][$idx] = $info->{fofs64};
2535 Coro::cede; 3705 cf::face::set_csum $idx, 1, $info->{hash32}; $cf::face::SIZE[1][$idx] = $info->{size32}; $cf::face::FOFS[1][$idx] = $info->{fofs32};
3706 cf::face::set_csum $idx, 2, $info->{glyph}; $cf::face::DATA[2][$idx] = $info->{glyph};
3707 $cf::face::HASH{$info->{hash64}} = $idx;
3708 delete $cf::face::META[$idx];
2536 } 3709 }
2537 3710
2538 while (my ($face, $info) = each %$faces) { 3711 while (my ($face, $info) = each %$faces) {
2539 next unless $info->{smooth}; 3712 next unless $info->{smooth};
3713
2540 my $idx = cf::face::find $face 3714 my $idx = cf::face::find $face
2541 or next; 3715 or next;
3716
2542 if (my $smooth = cf::face::find $info->{smooth}) { 3717 if (my $smooth = cf::face::find $info->{smooth}) {
3718 cf::face::set_smooth $idx, $smooth;
2543 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel}; 3719 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2544 } else { 3720 } else {
2545 warn "smooth face '$info->{smooth}' not found for face '$face'"; 3721 error "smooth face '$info->{smooth}' not found for face '$face'";
2546 } 3722 }
2547 Coro::cede;
2548 } 3723 }
2549 } 3724 }
2550 3725
2551 { 3726 {
2552 my $anims = $facedata->{animinfo}; 3727 my $anims = $facedata->{animinfo};
2553 3728
2554 while (my ($anim, $info) = each %$anims) { 3729 while (my ($anim, $info) = each %$anims) {
2555 cf::anim::set $anim, $info->{frames}, $info->{facings}; 3730 cf::anim::set $anim, $info->{frames}, $info->{facings};
2556 Coro::cede;
2557 } 3731 }
2558 3732
2559 cf::anim::invalidate_all; # d'oh 3733 cf::anim::invalidate_all; # d'oh
2560 } 3734 }
2561 3735
3736 {
3737 my $res = $facedata->{resource};
3738
3739 while (my ($name, $info) = each %$res) {
3740 if (defined (my $type = $info->{type})) {
3741 # TODO: different hash - must free and use new index, or cache ixface data queue
3742 my $idx = (cf::face::find $name) || cf::face::alloc $name;
3743
3744 cf::face::set_type $idx, $type;
3745 cf::face::set_csum $idx, 0, $info->{hash};
3746 $cf::face::SIZE[0][$idx] = $info->{size};
3747 $cf::face::FOFS[0][$idx] = $info->{fofs};
3748 $cf::face::META[$idx] = $type & 1 ? undef : $info->{meta}; # preserve meta unless prepended already
3749 $cf::face::HASH{$info->{hash}} = $idx;
3750 } else {
3751# $RESOURCE{$name} = $info; # unused
3752 }
3753 }
3754 }
3755
3756 ($fh, $cf::face::DATAFH) = ($cf::face::DATAFH, $fh);
3757
3758 # HACK to clear player env face cache, we need some signal framework
3759 # for this (global event?)
3760 %ext::player_env::MUSIC_FACE_CACHE = ();
3761
3762 # END ATOMIC
3763
3764 cf::debug "facedata atomic update time ", EV::time - $t1;
3765
3766 cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
3767
3768 aio_close $fh if $fh; # close old facedata
3769
2562 1 3770 1
2563} 3771}
2564 3772
3773register_exticmd fx_want => sub {
3774 my ($ns, $want) = @_;
3775
3776 while (my ($k, $v) = each %$want) {
3777 $ns->fx_want ($k, $v);
3778 }
3779};
3780
3781sub load_resource_file($) {
3782 my $guard = lock_acquire "load_resource_file";
3783
3784 my $status = load_resource_file_ $_[0];
3785 get_slot 0.1, 100;
3786 cf::arch::commit_load;
3787
3788 $status
3789}
3790
3791sub reload_exp_table {
3792 _reload_exp_table;
3793
3794 cf::face::set
3795 "res/exp_table" => FT_RSRC,
3796 JSON::XS->new->utf8->canonical->encode (
3797 [map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]
3798 );
3799}
3800
3801sub reload_materials {
3802 _reload_materials;
3803}
3804
2565sub reload_regions { 3805sub reload_regions {
3806 # HACK to clear player env face cache, we need some signal framework
3807 # for this (global event?)
3808 %ext::player_env::MUSIC_FACE_CACHE = ();
3809
2566 load_resource_file "$MAPDIR/regions" 3810 load_resource_file "$MAPDIR/regions"
2567 or die "unable to load regions file\n"; 3811 or die "unable to load regions file\n";
3812
3813 for (cf::region::list) {
3814 $_->{match} = qr/$_->{match}/
3815 if exists $_->{match};
3816 }
2568} 3817}
2569 3818
2570sub reload_facedata { 3819sub reload_facedata {
2571 load_facedata "$DATADIR/facedata" 3820 load_facedata $DATADIR
2572 or die "unable to load facedata\n"; 3821 or die "unable to load facedata\n";
2573} 3822}
2574 3823
2575sub reload_archetypes { 3824sub reload_archetypes {
2576 load_resource_file "$DATADIR/archetypes" 3825 load_resource_file "$DATADIR/archetypes"
2577 or die "unable to load archetypes\n"; 3826 or die "unable to load archetypes\n";
3827
3828 cf::face::set
3829 "res/skill_info" => FT_RSRC,
3830 JSON::XS->new->utf8->canonical->encode (
3831 [map [cf::arch::skillvec ($_)->name], 0 .. cf::arch::skillvec_size - 1]
3832 );
3833
3834 cf::face::set
3835 "res/spell_paths" => FT_RSRC,
3836 JSON::XS->new->utf8->canonical->encode (
3837 [map [cf::spellpathnames ($_)], 0 .. NRSPELLPATHS - 1]
3838 );
3839
3840 # command completion
3841 my @commands;
3842
3843 for (0..cf::arch::skillvec_size - 1) {
3844 my $skill = cf::arch::skillvec $_;
3845 my $name = $skill->name;
3846 my $flags = cf::skill_flags $skill->subtype;
3847
3848 push @commands, "ready_skill $name" if $flags & (SF_COMBAT | SF_RANGED | SF_GRACE);
3849 push @commands, "use_skill $name" if $flags & (SF_USE | SF_AUTARK | SF_GRACE);
3850 }
3851
3852 cf::client::set_command_face skill => \@commands;
2578} 3853}
2579 3854
2580sub reload_treasures { 3855sub reload_treasures {
2581 load_resource_file "$DATADIR/treasures" 3856 load_resource_file "$DATADIR/treasures"
2582 or die "unable to load treasurelists\n"; 3857 or die "unable to load treasurelists\n";
2583} 3858}
2584 3859
3860sub reload_sound {
3861 trace "loading sound config from $DATADIR/sound\n";
3862
3863 my $soundconf = JSON::XS->new->utf8->relaxed->decode (load_file "$DATADIR/sound");
3864
3865 for (0 .. SOUND_CAST_SPELL_0 - 1) {
3866 my $sound = $soundconf->{compat}[$_]
3867 or next;
3868
3869 my $face = cf::face::find "sound/$sound->[1]";
3870 cf::sound::set $sound->[0] => $face;
3871 cf::sound::old_sound_index $_, $face; # gcfclient-compat
3872 }
3873
3874 while (my ($k, $v) = each %{$soundconf->{event}}) {
3875 my $face = cf::face::find "sound/$v";
3876 cf::sound::set $k => $face;
3877 }
3878}
3879
2585sub reload_resources { 3880sub reload_resources {
2586 warn "reloading resource files...\n"; 3881 trace "reloading resource files...\n";
2587 3882
3883 reload_materials;
3884 reload_facedata;
3885 reload_exp_table;
3886 reload_sound;
3887 reload_archetypes;
2588 reload_regions; 3888 reload_regions;
2589 reload_facedata;
2590 reload_archetypes;
2591 reload_treasures; 3889 reload_treasures;
2592 3890
2593 warn "finished reloading resource files\n"; 3891 trace "finished reloading resource files\n";
2594} 3892}
2595 3893
2596sub init { 3894sub reload_config {
2597 reload_resources; 3895 trace "reloading config file...\n";
2598}
2599 3896
2600sub cfg_load { 3897 my $config = load_file "$CONFDIR/config";
2601 open my $fh, "<:utf8", "$CONFDIR/config" 3898 utf8::decode $config;
2602 or return; 3899 *CFG = decode_yaml $config;
2603 3900
2604 local $/;
2605 *CFG = YAML::Syck::Load <$fh>;
2606
2607 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37]; 3901 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_104_115", 49, 38];
2608 3902
2609 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset}; 3903 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2610 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset}; 3904 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2611 3905
2612 if (exists $CFG{mlockall}) { 3906 if (exists $CFG{mlockall}) {
2616 }; 3910 };
2617 warn $@ if $@; 3911 warn $@ if $@;
2618 } 3912 }
2619} 3913}
2620 3914
3915sub pidfile() {
3916 sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
3917 or die "$PIDFILE: $!";
3918 flock $fh, &Fcntl::LOCK_EX
3919 or die "$PIDFILE: flock: $!";
3920 $fh
3921}
3922
3923# make sure only one server instance is running at any one time
3924sub atomic {
3925 my $fh = pidfile;
3926
3927 my $pid = <$fh>;
3928 kill 9, $pid if $pid > 0;
3929
3930 seek $fh, 0, 0;
3931 print $fh $$;
3932}
3933
3934sub main_loop {
3935 trace "EV::run starting\n";
3936 if (1) {
3937 EV::run;
3938 }
3939 trace "EV::run returned\n";
3940 goto &main_loop unless $REALLY_UNLOOP;
3941}
3942
2621sub main { 3943sub main {
3944 cf::init_globals; # initialise logging
3945
3946 LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
3947 LOG llevInfo, "Copyright (C) 2005-2012 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
3948 LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
3949 LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
3950
3951 $Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
3952
2622 # we must not ever block the main coroutine 3953 # we must not ever block the main coroutine
2623 local $Coro::idle = sub { 3954 $Coro::idle = sub {
2624 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 3955 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2625 (async { 3956 (async {
2626 Event::one_event; 3957 $Coro::current->{desc} = "IDLE BUG HANDLER";
3958 EV::run EV::RUN_ONCE;
2627 })->prio (Coro::PRIO_MAX); 3959 })->prio (Coro::PRIO_MAX);
2628 }; 3960 };
2629 3961
2630 cfg_load; 3962 evthread_start IO::AIO::poll_fileno;
3963
3964 cf::sync_job {
3965 cf::incloader::init ();
3966
2631 db_init; 3967 db_init;
3968
3969 cf::init_anim;
3970 cf::init_attackmess;
3971 cf::init_dynamic;
3972
3973 cf::load_settings;
3974
3975 reload_resources;
3976 reload_config;
3977
3978 cf::init_uuid;
3979 cf::init_signals;
3980 cf::init_skills;
3981
3982 cf::init_beforeplay;
3983
3984 atomic;
3985
2632 load_extensions; 3986 load_extensions;
2633 3987
2634 $TICK_WATCHER->start; 3988 utime time, time, $RUNTIMEFILE;
2635 Event::loop; 3989
3990 # no (long-running) fork's whatsoever before this point(!)
3991 use POSIX ();
3992 POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
3993
3994 cf::_post_init 0;
3995 };
3996
3997 cf::object::thawer::errors_are_fatal 0;
3998 info "parse errors in files are no longer fatal from this point on.\n";
3999
4000 AE::postpone {
4001 undef &main; # free gobs of memory :)
4002 };
4003
4004 goto &main_loop;
2636} 4005}
2637 4006
2638############################################################################# 4007#############################################################################
2639# initialisation and cleanup 4008# initialisation and cleanup
2640 4009
2641# install some emergency cleanup handlers 4010# install some emergency cleanup handlers
2642BEGIN { 4011BEGIN {
4012 our %SIGWATCHER = ();
2643 for my $signal (qw(INT HUP TERM)) { 4013 for my $signal (qw(INT HUP TERM)) {
2644 Event->signal ( 4014 $SIGWATCHER{$signal} = AE::signal $signal, sub {
2645 reentrant => 0,
2646 data => WF_AUTOCANCEL,
2647 signal => $signal,
2648 prio => 0,
2649 cb => sub {
2650 cf::cleanup "SIG$signal"; 4015 cf::cleanup "SIG$signal";
2651 },
2652 ); 4016 };
4017 }
4018}
4019
4020sub write_runtime_sync {
4021 my $t0 = AE::time;
4022
4023 # first touch the runtime file to show we are still running:
4024 # the fsync below can take a very very long time.
4025
4026 IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
4027
4028 my $guard = cf::lock_acquire "write_runtime";
4029
4030 my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT | O_TRUNC, 0644
4031 or return;
4032
4033 my $value = $cf::RUNTIME + 90 + 10;
4034 # 10 is the runtime save interval, for a monotonic clock
4035 # 60 allows for the watchdog to kill the server.
4036
4037 (aio_write $fh, 0, (length $value), $value, 0) <= 0
4038 and return;
4039
4040 # always fsync - this file is important
4041 aio_fsync $fh
4042 and return;
4043
4044 # touch it again to show we are up-to-date
4045 aio_utime $fh, undef, undef;
4046
4047 close $fh
4048 or return;
4049
4050 aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
4051 and return;
4052
4053 trace sprintf "runtime file written (%gs).\n", AE::time - $t0;
4054
2653 } 4055 1
4056}
4057
4058our $uuid_lock;
4059our $uuid_skip;
4060
4061sub write_uuid_sync($) {
4062 $uuid_skip ||= $_[0];
4063
4064 return if $uuid_lock;
4065 local $uuid_lock = 1;
4066
4067 my $uuid = "$LOCALDIR/uuid";
4068
4069 my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
4070 or return;
4071
4072 my $value = uuid_seq uuid_cur;
4073
4074 unless ($value) {
4075 info "cowardly refusing to write zero uuid value!\n";
4076 return;
4077 }
4078
4079 my $value = uuid_str $value + $uuid_skip;
4080 $uuid_skip = 0;
4081
4082 (aio_write $fh, 0, (length $value), $value, 0) <= 0
4083 and return;
4084
4085 # always fsync - this file is important
4086 aio_fsync $fh
4087 and return;
4088
4089 close $fh
4090 or return;
4091
4092 aio_rename "$uuid~", $uuid
4093 and return;
4094
4095 trace "uuid file written ($value).\n";
4096
4097 1
4098
4099}
4100
4101sub write_uuid($$) {
4102 my ($skip, $sync) = @_;
4103
4104 $sync ? write_uuid_sync $skip
4105 : async { write_uuid_sync $skip };
2654} 4106}
2655 4107
2656sub emergency_save() { 4108sub emergency_save() {
2657 my $freeze_guard = cf::freeze_mainloop; 4109 my $freeze_guard = cf::freeze_mainloop;
2658 4110
2659 warn "enter emergency perl save\n"; 4111 info "emergency_perl_save: enter\n";
4112
4113 # this is a trade-off: we want to be very quick here, so
4114 # save all maps without fsync, and later call a global sync
4115 # (which in turn might be very very slow)
4116 local $USE_FSYNC = 0;
2660 4117
2661 cf::sync_job { 4118 cf::sync_job {
4119 cf::write_runtime_sync; # external watchdog should not bark
4120
2662 # use a peculiar iteration method to avoid tripping on perl 4121 # use a peculiar iteration method to avoid tripping on perl
2663 # refcount bugs in for. also avoids problems with players 4122 # refcount bugs in for. also avoids problems with players
2664 # and maps saved/destroyed asynchronously. 4123 # and maps saved/destroyed asynchronously.
2665 warn "begin emergency player save\n"; 4124 info "emergency_perl_save: begin player save\n";
2666 for my $login (keys %cf::PLAYER) { 4125 for my $login (keys %cf::PLAYER) {
2667 my $pl = $cf::PLAYER{$login} or next; 4126 my $pl = $cf::PLAYER{$login} or next;
2668 $pl->valid or next; 4127 $pl->valid or next;
4128 delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2669 $pl->save; 4129 $pl->save;
2670 } 4130 }
2671 warn "end emergency player save\n"; 4131 info "emergency_perl_save: end player save\n";
2672 4132
2673 warn "begin emergency map save\n"; 4133 cf::write_runtime_sync; # external watchdog should not bark
4134
4135 info "emergency_perl_save: begin map save\n";
2674 for my $path (keys %cf::MAP) { 4136 for my $path (keys %cf::MAP) {
2675 my $map = $cf::MAP{$path} or next; 4137 my $map = $cf::MAP{$path} or next;
2676 $map->valid or next; 4138 $map->valid or next;
2677 $map->save; 4139 $map->save;
2678 } 4140 }
2679 warn "end emergency map save\n"; 4141 info "emergency_perl_save: end map save\n";
2680 4142
2681 warn "begin emergency database checkpoint\n"; 4143 cf::write_runtime_sync; # external watchdog should not bark
4144
4145 info "emergency_perl_save: begin database checkpoint\n";
2682 BDB::db_env_txn_checkpoint $DB_ENV; 4146 BDB::db_env_txn_checkpoint $DB_ENV;
2683 warn "end emergency database checkpoint\n"; 4147 info "emergency_perl_save: end database checkpoint\n";
4148
4149 info "emergency_perl_save: begin write uuid\n";
4150 write_uuid_sync 1;
4151 info "emergency_perl_save: end write uuid\n";
4152
4153 cf::write_runtime_sync; # external watchdog should not bark
4154
4155 trace "emergency_perl_save: syncing database to disk";
4156 BDB::db_env_txn_checkpoint $DB_ENV;
4157
4158 info "emergency_perl_save: starting sync\n";
4159 IO::AIO::aio_sync sub {
4160 info "emergency_perl_save: finished sync\n";
4161 };
4162
4163 cf::write_runtime_sync; # external watchdog should not bark
4164
4165 trace "emergency_perl_save: flushing outstanding aio requests";
4166 while (IO::AIO::nreqs || BDB::nreqs) {
4167 Coro::AnyEvent::sleep 0.01; # let the sync_job do it's thing
4168 }
4169
4170 cf::write_runtime_sync; # external watchdog should not bark
2684 }; 4171 };
2685 4172
2686 warn "leave emergency perl save\n"; 4173 info "emergency_perl_save: leave\n";
2687} 4174}
2688 4175
2689sub post_cleanup { 4176sub post_cleanup {
2690 my ($make_core) = @_; 4177 my ($make_core) = @_;
2691 4178
4179 IO::AIO::flush;
4180
2692 warn Carp::longmess "post_cleanup backtrace" 4181 error Carp::longmess "post_cleanup backtrace"
2693 if $make_core; 4182 if $make_core;
4183
4184 my $fh = pidfile;
4185 unlink $PIDFILE if <$fh> == $$;
4186}
4187
4188# a safer delete_package, copied from Symbol
4189sub clear_package($) {
4190 my $pkg = shift;
4191
4192 # expand to full symbol table name if needed
4193 unless ($pkg =~ /^main::.*::$/) {
4194 $pkg = "main$pkg" if $pkg =~ /^::/;
4195 $pkg = "main::$pkg" unless $pkg =~ /^main::/;
4196 $pkg .= '::' unless $pkg =~ /::$/;
4197 }
4198
4199 my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
4200 my $stem_symtab = *{$stem}{HASH};
4201
4202 defined $stem_symtab and exists $stem_symtab->{$leaf}
4203 or return;
4204
4205 # clear all symbols
4206 my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
4207 for my $name (keys %$leaf_symtab) {
4208 _gv_clear *{"$pkg$name"};
4209# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
4210 }
2694} 4211}
2695 4212
2696sub do_reload_perl() { 4213sub do_reload_perl() {
2697 # can/must only be called in main 4214 # can/must only be called in main
2698 if ($Coro::current != $Coro::main) { 4215 unless (in_main) {
2699 warn "can only reload from main coroutine"; 4216 error "can only reload from main coroutine";
2700 return; 4217 return;
2701 } 4218 }
2702 4219
2703 warn "reloading..."; 4220 return if $RELOAD++;
2704 4221
2705 warn "entering sync_job"; 4222 my $t1 = AE::time;
2706 4223
4224 while ($RELOAD) {
4225 cf::get_slot 0.1, -1, "reload_perl";
4226 info "perl_reload: reloading...";
4227
4228 trace "perl_reload: entering sync_job";
4229
2707 cf::sync_job { 4230 cf::sync_job {
2708 cf::write_runtime; # external watchdog should not bark
2709 cf::emergency_save; 4231 #cf::emergency_save;
2710 cf::write_runtime; # external watchdog should not bark
2711 4232
2712 warn "syncing database to disk";
2713 BDB::db_env_txn_checkpoint $DB_ENV;
2714
2715 # if anything goes wrong in here, we should simply crash as we already saved
2716
2717 warn "cancelling all WF_AUTOCANCEL watchers";
2718 for (Event::all_watchers) {
2719 $_->cancel if $_->data & WF_AUTOCANCEL;
2720 }
2721
2722 warn "flushing outstanding aio requests";
2723 for (;;) {
2724 BDB::flush;
2725 IO::AIO::flush;
2726 Coro::cede;
2727 last unless IO::AIO::nreqs || BDB::nreqs;
2728 warn "iterate...";
2729 }
2730
2731 ++$RELOAD;
2732
2733 warn "cancelling all extension coros"; 4233 trace "perl_reload: cancelling all extension coros";
2734 $_->cancel for values %EXT_CORO; 4234 $_->cancel for values %EXT_CORO;
2735 %EXT_CORO = (); 4235 %EXT_CORO = ();
2736 4236
2737 warn "removing commands"; 4237 trace "perl_reload: removing commands";
2738 %COMMAND = (); 4238 %COMMAND = ();
2739 4239
2740 warn "removing ext commands"; 4240 trace "perl_reload: removing ext/exti commands";
2741 %EXTCMD = (); 4241 %EXTCMD = ();
4242 %EXTICMD = ();
2742 4243
2743 warn "unloading/nuking all extensions"; 4244 trace "perl_reload: unloading/nuking all extensions";
2744 for my $pkg (@EXTS) { 4245 for my $pkg (@EXTS) {
2745 warn "... unloading $pkg"; 4246 trace "... unloading $pkg";
2746 4247
2747 if (my $cb = $pkg->can ("unload")) { 4248 if (my $cb = $pkg->can ("unload")) {
2748 eval { 4249 eval {
2749 $cb->($pkg); 4250 $cb->($pkg);
2750 1 4251 1
2751 } or warn "$pkg unloaded, but with errors: $@"; 4252 } or error "$pkg unloaded, but with errors: $@";
4253 }
4254
4255 trace "... clearing $pkg";
4256 clear_package $pkg;
2752 } 4257 }
2753 4258
2754 warn "... nuking $pkg";
2755 Symbol::delete_package $pkg;
2756 }
2757
2758 warn "unloading all perl modules loaded from $LIBDIR"; 4259 trace "perl_reload: unloading all perl modules loaded from $LIBDIR";
2759 while (my ($k, $v) = each %INC) { 4260 while (my ($k, $v) = each %INC) {
2760 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 4261 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2761 4262
2762 warn "... unloading $k"; 4263 trace "... unloading $k";
2763 delete $INC{$k}; 4264 delete $INC{$k};
2764 4265
2765 $k =~ s/\.pm$//; 4266 $k =~ s/\.pm$//;
2766 $k =~ s/\//::/g; 4267 $k =~ s/\//::/g;
2767 4268
2768 if (my $cb = $k->can ("unload_module")) { 4269 if (my $cb = $k->can ("unload_module")) {
2769 $cb->(); 4270 $cb->();
4271 }
4272
4273 clear_package $k;
2770 } 4274 }
2771 4275
2772 Symbol::delete_package $k;
2773 }
2774
2775 warn "getting rid of safe::, as good as possible"; 4276 trace "perl_reload: getting rid of safe::, as good as possible";
2776 Symbol::delete_package "safe::$_" 4277 clear_package "safe::$_"
2777 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 4278 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2778 4279
2779 warn "unloading cf.pm \"a bit\""; 4280 trace "perl_reload: unloading cf.pm \"a bit\"";
2780 delete $INC{"cf.pm"}; 4281 delete $INC{"cf.pm"};
2781 delete $INC{"cf/pod.pm"}; 4282 delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
2782 4283
2783 # don't, removes xs symbols, too, 4284 # don't, removes xs symbols, too,
2784 # and global variables created in xs 4285 # and global variables created in xs
2785 #Symbol::delete_package __PACKAGE__; 4286 #clear_package __PACKAGE__;
2786 4287
2787 warn "unload completed, starting to reload now"; 4288 info "perl_reload: unload completed, starting to reload now";
2788 4289
2789 warn "reloading cf.pm"; 4290 trace "perl_reload: reloading cf.pm";
2790 require cf; 4291 require cf;
2791 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 4292 cf::_connect_to_perl_1;
2792 4293
2793 warn "loading config and database again"; 4294 trace "perl_reload: loading config and database again";
2794 cf::cfg_load; 4295 cf::reload_config;
2795 4296
2796 warn "loading extensions"; 4297 trace "perl_reload: loading extensions";
2797 cf::load_extensions; 4298 cf::load_extensions;
2798 4299
4300 if ($REATTACH_ON_RELOAD) {
2799 warn "reattaching attachments to objects/players"; 4301 trace "perl_reload: reattaching attachments to objects/players";
2800 _global_reattach; # objects, sockets 4302 _global_reattach; # objects, sockets
2801 warn "reattaching attachments to maps"; 4303 trace "perl_reload: reattaching attachments to maps";
2802 reattach $_ for values %MAP; 4304 reattach $_ for values %MAP;
2803 warn "reattaching attachments to players"; 4305 trace "perl_reload: reattaching attachments to players";
2804 reattach $_ for values %PLAYER; 4306 reattach $_ for values %PLAYER;
4307 }
2805 4308
2806 warn "leaving sync_job"; 4309 cf::_post_init 1;
2807 4310
4311 trace "perl_reload: leaving sync_job";
4312
2808 1 4313 1
2809 } or do { 4314 } or do {
2810 warn $@; 4315 error $@;
2811 warn "error while reloading, exiting."; 4316 cf::cleanup "perl_reload: error, exiting.";
2812 exit 1; 4317 };
4318
4319 --$RELOAD;
2813 }; 4320 }
2814 4321
2815 warn "reloaded"; 4322 $t1 = AE::time - $t1;
4323 info "perl_reload: completed in ${t1}s\n";
2816}; 4324};
2817 4325
2818our $RELOAD_WATCHER; # used only during reload 4326our $RELOAD_WATCHER; # used only during reload
2819 4327
2820sub reload_perl() { 4328sub reload_perl() {
2821 # doing reload synchronously and two reloads happen back-to-back, 4329 # doing reload synchronously and two reloads happen back-to-back,
2822 # coro crashes during coro_state_free->destroy here. 4330 # coro crashes during coro_state_free->destroy here.
2823 4331
2824 $RELOAD_WATCHER ||= Event->timer ( 4332 $RELOAD_WATCHER ||= cf::async {
2825 reentrant => 0, 4333 Coro::AIO::aio_wait cache_extensions;
2826 after => 0, 4334
2827 data => WF_AUTOCANCEL, 4335 $RELOAD_WATCHER = AE::timer $TICK * 1.5, 0, sub {
2828 cb => sub {
2829 do_reload_perl; 4336 do_reload_perl;
2830 undef $RELOAD_WATCHER; 4337 undef $RELOAD_WATCHER;
2831 }, 4338 };
2832 ); 4339 };
2833} 4340}
2834 4341
2835register_command "reload" => sub { 4342register_command "reload" => sub {
2836 my ($who, $arg) = @_; 4343 my ($who, $arg) = @_;
2837 4344
2838 if ($who->flag (FLAG_WIZ)) { 4345 if ($who->flag (FLAG_WIZ)) {
2839 $who->message ("reloading server."); 4346 $who->message ("reloading server.");
4347 async {
4348 $Coro::current->{desc} = "perl_reload";
2840 async { reload_perl }; 4349 reload_perl;
4350 };
2841 } 4351 }
2842}; 4352};
2843 4353
2844unshift @INC, $LIBDIR; 4354#############################################################################
2845 4355
2846my $bug_warning = 0; 4356my $bug_warning = 0;
2847 4357
2848our @WAIT_FOR_TICK;
2849our @WAIT_FOR_TICK_BEGIN;
2850
2851sub wait_for_tick { 4358sub wait_for_tick() {
2852 return unless $TICK_WATCHER->is_active; 4359 return Coro::AnyEvent::poll if tick_inhibit || $Coro::current == $Coro::main;
2853 return if $Coro::current == $Coro::main;
2854 4360
2855 my $signal = new Coro::Signal; 4361 $WAIT_FOR_TICK->wait;
2856 push @WAIT_FOR_TICK, $signal;
2857 $signal->wait;
2858} 4362}
2859 4363
2860sub wait_for_tick_begin { 4364sub wait_for_tick_begin() {
2861 return unless $TICK_WATCHER->is_active; 4365 return Coro::AnyEvent::poll if tick_inhibit || $Coro::current == $Coro::main;
2862 return if $Coro::current == $Coro::main;
2863 4366
2864 my $signal = new Coro::Signal; 4367 my $signal = new Coro::Signal;
2865 push @WAIT_FOR_TICK_BEGIN, $signal; 4368 push @WAIT_FOR_TICK_BEGIN, $signal;
2866 $signal->wait; 4369 $signal->wait;
2867} 4370}
2868 4371
2869 my $min = 1e6;#d# 4372sub tick {
2870 my $avg = 10;
2871$TICK_WATCHER = Event->timer (
2872 reentrant => 0,
2873 parked => 1,
2874 prio => 0,
2875 at => $NEXT_TICK || $TICK,
2876 data => WF_AUTOCANCEL,
2877 cb => sub {
2878 if ($Coro::current != $Coro::main) { 4373 if ($Coro::current != $Coro::main) {
2879 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 4374 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2880 unless ++$bug_warning > 10; 4375 unless ++$bug_warning > 10;
2881 return; 4376 return;
2882 } 4377 }
2883 4378
2884 $NOW = $tick_start = Event::time; 4379 cf::one_tick; # one server iteration
2885 4380
2886 cf::server_tick; # one server iteration 4381 #for(1..3e6){} AE::now_update; $NOW=AE::now; # generate load #d#
2887 4382
2888 0 && sync_job {#d# 4383 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2889 for(1..10) { 4384 $NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2890 my $t = Event::time; 4385 Coro::async_pool {
2891 my $map = my $map = new_from_path cf::map "/tmp/x.map" 4386 $Coro::current->{desc} = "runtime saver";
2892 or die; 4387 write_runtime_sync
2893 4388 or error "ERROR: unable to write runtime file: $!";
2894 $map->width (50);
2895 $map->height (50);
2896 $map->alloc;
2897 $map->_load_objects ("/tmp/x.map", 1);
2898 my $t = Event::time - $t;
2899
2900 #next unless $t < 0.0013;#d#
2901 if ($t < $min) {
2902 $min = $t;
2903 }
2904 $avg = $avg * 0.99 + $t * 0.01;
2905 }
2906 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
2907 exit 0;
2908 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
2909 }; 4389 };
4390 }
2910 4391
2911 $RUNTIME += $TICK;
2912 $NEXT_TICK += $TICK;
2913
2914 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2915 $NEXT_RUNTIME_WRITE = $NOW + 10;
2916 Coro::async_pool {
2917 write_runtime
2918 or warn "ERROR: unable to write runtime file: $!";
2919 };
2920 }
2921
2922# my $AFTER = Event::time;
2923# warn $AFTER - $NOW;#d#
2924
2925 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) { 4392 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
2926 $sig->send; 4393 $sig->send;
2927 } 4394 }
2928 while (my $sig = shift @WAIT_FOR_TICK) { 4395 $WAIT_FOR_TICK->broadcast;
2929 $sig->send;
2930 }
2931 4396
2932 $NOW = Event::time; 4397 $LOAD = ($NOW - $TICK_START) / $TICK;
2933
2934 # if we are delayed by four ticks or more, skip them all
2935 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2936
2937 $TICK_WATCHER->at ($NEXT_TICK);
2938 $TICK_WATCHER->start;
2939
2940 $LOAD = ($NOW - $tick_start) / $TICK;
2941 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25; 4398 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
2942 4399
2943 _post_tick; 4400 if (0) {
2944 4401 if ($NEXT_TICK) {
2945 4402 my $jitter = $TICK_START - $NEXT_TICK;
4403 $JITTER = $JITTER * 0.75 + $jitter * 0.25;
4404 debug "jitter $JITTER\n";#d#
4405 }
2946 }, 4406 }
2947); 4407}
2948 4408
2949{ 4409{
2950 BDB::max_poll_time $TICK * 0.1; 4410 # configure BDB
2951 $BDB_POLL_WATCHER = Event->io ( 4411 info "initialising database";
2952 reentrant => 0, 4412
2953 fd => BDB::poll_fileno,
2954 poll => 'r',
2955 prio => 0,
2956 data => WF_AUTOCANCEL,
2957 cb => \&BDB::poll_cb,
2958 );
2959 BDB::min_parallel 8; 4413 BDB::min_parallel 16;
2960 4414 BDB::max_poll_reqs $TICK * 0.1;
2961 BDB::set_sync_prepare { 4415 #$AnyEvent::BDB::WATCHER->priority (1);
2962 my $status;
2963 my $current = $Coro::current;
2964 (
2965 sub {
2966 $status = $!;
2967 $current->ready; undef $current;
2968 },
2969 sub {
2970 Coro::schedule while defined $current;
2971 $! = $status;
2972 },
2973 )
2974 };
2975 4416
2976 unless ($DB_ENV) { 4417 unless ($DB_ENV) {
2977 $DB_ENV = BDB::db_env_create; 4418 $DB_ENV = BDB::db_env_create;
4419 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
4420 $DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
4421 $DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
4422 $DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
4423 $DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
2978 4424
2979 cf::sync_job { 4425 cf::sync_job {
2980 eval { 4426 eval {
2981 BDB::db_env_open 4427 BDB::db_env_open
2982 $DB_ENV, 4428 $DB_ENV,
2984 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 4430 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2985 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 4431 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2986 0666; 4432 0666;
2987 4433
2988 cf::cleanup "db_env_open($BDBDIR): $!" if $!; 4434 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2989
2990 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2991 $DB_ENV->set_lk_detect;
2992 }; 4435 };
2993 4436
2994 cf::cleanup "db_env_open(db): $@" if $@; 4437 cf::cleanup "db_env_open(db): $@" if $@;
2995 }; 4438 };
2996 } 4439 }
4440
4441 $BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
4442 BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
4443 };
4444 $BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
4445 BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
4446 };
4447 $BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
4448 BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
4449 };
4450
4451 info "database initialised";
2997} 4452}
2998 4453
2999{ 4454{
4455 # configure IO::AIO
4456
4457 info "initialising aio";
3000 IO::AIO::min_parallel 8; 4458 IO::AIO::min_parallel 8;
3001
3002 undef $Coro::AIO::WATCHER;
3003 IO::AIO::max_poll_time $TICK * 0.1; 4459 IO::AIO::max_poll_time $TICK * 0.1;
3004 $AIO_POLL_WATCHER = Event->io ( 4460 undef $AnyEvent::AIO::WATCHER;
3005 reentrant => 0, 4461 info "aio initialised";
3006 data => WF_AUTOCANCEL,
3007 fd => IO::AIO::poll_fileno,
3008 poll => 'r',
3009 prio => 6,
3010 cb => \&IO::AIO::poll_cb,
3011 );
3012} 4462}
3013 4463
3014my $_log_backtrace; 4464our $_log_backtrace;
4465our $_log_backtrace_last;
3015 4466
3016sub _log_backtrace { 4467sub _log_backtrace {
3017 my ($msg, @addr) = @_; 4468 my ($msg, @addr) = @_;
3018 4469
3019 $msg =~ s/\n//; 4470 $msg =~ s/\n$//;
3020 4471
4472 if ($_log_backtrace_last eq $msg) {
4473 LOG llevInfo, "[ABT] $msg\n";
4474 LOG llevInfo, "[ABT] [duplicate, suppressed]\n";
3021 # limit the # of concurrent backtraces 4475 # limit the # of concurrent backtraces
3022 if ($_log_backtrace < 2) { 4476 } elsif ($_log_backtrace < 2) {
4477 $_log_backtrace_last = $msg;
3023 ++$_log_backtrace; 4478 ++$_log_backtrace;
4479 my $perl_bt = Carp::longmess $msg;
3024 async { 4480 async {
4481 $Coro::current->{desc} = "abt $msg";
4482
3025 my @bt = fork_call { 4483 my @bt = fork_call {
3026 @addr = map { sprintf "%x", $_ } @addr; 4484 @addr = map { sprintf "%x", $_ } @addr;
3027 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X; 4485 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3028 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |" 4486 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3029 or die "addr2line: $!"; 4487 or die "addr2line: $!";
3037 } 4495 }
3038 4496
3039 @funcs 4497 @funcs
3040 }; 4498 };
3041 4499
3042 LOG llevInfo, "[ABT] $msg\n"; 4500 LOG llevInfo, "[ABT] $perl_bt\n";
4501 LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
3043 LOG llevInfo, "[ABT] $_\n" for @bt; 4502 LOG llevInfo, "[ABT] $_\n" for @bt;
3044 --$_log_backtrace; 4503 --$_log_backtrace;
3045 }; 4504 };
3046 } else { 4505 } else {
3047 LOG llevInfo, "[ABT] $msg\n"; 4506 LOG llevInfo, "[ABT] $msg\n";
3048 LOG llevInfo, "[ABT] [suppressed]\n"; 4507 LOG llevInfo, "[ABT] [overload, suppressed]\n";
3049 } 4508 }
3050} 4509}
3051 4510
3052# load additional modules 4511# load additional modules
3053use cf::pod; 4512require "cf/$_.pm" for @EXTRA_MODULES;
4513cf::_connect_to_perl_2;
3054 4514
3055END { cf::emergency_save } 4515END { cf::emergency_save }
3056 4516
30571 45171
3058 4518

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines