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.234 by root, Thu Apr 5 13:44:31 2007 UTC vs.
Revision 1.282 by elmex, Tue Jun 19 18:15:34 2007 UTC

3use utf8; 3use utf8;
4use strict; 4use strict;
5 5
6use Symbol; 6use Symbol;
7use List::Util; 7use List::Util;
8use Socket;
8use Storable; 9use Storable;
9use Event; 10use Event;
10use Opcode; 11use Opcode;
11use Safe; 12use Safe;
12use Safe::Hole; 13use Safe::Hole;
13 14
14use Coro 3.52 (); 15use Coro 3.61 ();
15use Coro::State; 16use Coro::State;
17use Coro::Handle;
16use Coro::Event; 18use Coro::Event;
17use Coro::Timer; 19use Coro::Timer;
18use Coro::Signal; 20use Coro::Signal;
19use Coro::Semaphore; 21use Coro::Semaphore;
20use Coro::AIO; 22use Coro::AIO;
23use Coro::Storable;
21 24
22use BDB (); 25use BDB ();
23use Data::Dumper; 26use Data::Dumper;
24use Digest::MD5; 27use Digest::MD5;
25use Fcntl; 28use Fcntl;
28use Time::HiRes; 31use Time::HiRes;
29use Compress::LZF; 32use Compress::LZF;
30 33
31# configure various modules to our taste 34# configure various modules to our taste
32# 35#
36$Storable::canonical = 1; # reduce rsync transfers
33Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator 37Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
34Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later 38Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
35 39
36$Event::Eval = 1; # no idea why this is required, but it is 40$Event::Eval = 1; # no idea why this is required, but it is
37 41
50our %EXT_CORO = (); # coroutines bound to extensions 54our %EXT_CORO = (); # coroutines bound to extensions
51our %EXT_MAP = (); # pluggable maps 55our %EXT_MAP = (); # pluggable maps
52 56
53our $RELOAD; # number of reloads so far 57our $RELOAD; # number of reloads so far
54our @EVENT; 58our @EVENT;
55our $LIBDIR = datadir . "/ext";
56 59
57our $TICK = MAX_TIME * 1e-6; 60our $CONFDIR = confdir;
61our $DATADIR = datadir;
62our $LIBDIR = "$DATADIR/ext";
63our $PODDIR = "$DATADIR/pod";
64our $MAPDIR = "$DATADIR/" . mapdir;
65our $LOCALDIR = localdir;
66our $TMPDIR = "$LOCALDIR/" . tmpdir;
67our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
68our $PLAYERDIR = "$LOCALDIR/" . playerdir;
69our $RANDOMDIR = "$LOCALDIR/random";
70our $BDBDIR = "$LOCALDIR/db";
71
72our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
58our $TICK_WATCHER; 73our $TICK_WATCHER;
59our $AIO_POLL_WATCHER; 74our $AIO_POLL_WATCHER;
60our $NEXT_RUNTIME_WRITE; # when should the runtime file be written 75our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
61our $NEXT_TICK; 76our $NEXT_TICK;
62our $NOW; 77our $NOW;
71our $RUNTIME; 86our $RUNTIME;
72 87
73our %PLAYER; # all users 88our %PLAYER; # all users
74our %MAP; # all maps 89our %MAP; # all maps
75our $LINK_MAP; # the special {link} map, which is always available 90our $LINK_MAP; # the special {link} map, which is always available
76our $RANDOM_MAPS = cf::localdir . "/random";
77our $BDB_ENV_DIR = cf::localdir . "/db";
78
79our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
80our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
81 91
82# used to convert map paths into valid unix filenames by replacing / by ∕ 92# used to convert map paths into valid unix filenames by replacing / by ∕
83our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 93our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
84 94
95our $LOAD; # a number between 0 (idle) and 1 (too many objects)
96our $LOADAVG; # same thing, but with alpha-smoothing
97our $tick_start; # for load detecting purposes
98
85binmode STDOUT; 99binmode STDOUT;
86binmode STDERR; 100binmode STDERR;
87 101
88# read virtual server time, if available 102# read virtual server time, if available
89unless ($RUNTIME || !-e cf::localdir . "/runtime") { 103unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
90 open my $fh, "<", cf::localdir . "/runtime" 104 open my $fh, "<", "$LOCALDIR/runtime"
91 or die "unable to read runtime file: $!"; 105 or die "unable to read runtime file: $!";
92 $RUNTIME = <$fh> + 0.; 106 $RUNTIME = <$fh> + 0.;
93} 107}
94 108
95mkdir cf::localdir; 109mkdir $_
96mkdir cf::localdir . "/" . cf::playerdir; 110 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
97mkdir cf::localdir . "/" . cf::tmpdir;
98mkdir cf::localdir . "/" . cf::uniquedir;
99mkdir $RANDOM_MAPS;
100mkdir $BDB_ENV_DIR;
101 111
102our $EMERGENCY_POSITION; 112our $EMERGENCY_POSITION;
103 113
104sub cf::map::normalise; 114sub cf::map::normalise;
105 115
116=item $cf::RUNTIME 126=item $cf::RUNTIME
117 127
118The time this server has run, starts at 0 and is increased by $cf::TICK on 128The time this server has run, starts at 0 and is increased by $cf::TICK on
119every server tick. 129every server tick.
120 130
121=item $cf::LIBDIR 131=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
132$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
133$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
122 134
123The perl library directory, where extensions and cf-specific modules can 135Various directories - "/etc", read-only install directory, perl-library
124be found. It will be added to C<@INC> automatically. 136directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
137unique-items directory, player file directory, random maps directory and
138database environment.
125 139
126=item $cf::NOW 140=item $cf::NOW
127 141
128The time of the last (current) server tick. 142The time of the last (current) server tick.
129 143
130=item $cf::TICK 144=item $cf::TICK
131 145
132The interval between server ticks, in seconds. 146The interval between server ticks, in seconds.
147
148=item $cf::LOADAVG
149
150The 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
152objects per tick. Healthy values are < 0.5.
153
154=item $cf::LOAD
155
156The raw value load value from the last tick.
133 157
134=item %cf::CFG 158=item %cf::CFG
135 159
136Configuration for the server, loaded from C</etc/crossfire/config>, or 160Configuration for the server, loaded from C</etc/crossfire/config>, or
137from wherever your confdir points to. 161from wherever your confdir points to.
138 162
139=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE 163=item cf::wait_for_tick, cf::wait_for_tick_begin
140 164
141These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK) 165These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
142or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick 166returns directly I<after> the tick processing (and consequently, can only wake one process
143processing has been done. Call C<< ->wait >> on them to maximise the 167per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
144window of cpu time available, or simply to synchronise to the server tick.
145 168
146=back 169=back
147 170
148=cut 171=cut
149 172
150BEGIN { 173BEGIN {
151 *CORE::GLOBAL::warn = sub { 174 *CORE::GLOBAL::warn = sub {
152 my $msg = join "", @_; 175 my $msg = join "", @_;
153 utf8::encode $msg;
154 176
155 $msg .= "\n" 177 $msg .= "\n"
156 unless $msg =~ /\n$/; 178 unless $msg =~ /\n$/;
157 179
180 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
181
182 utf8::encode $msg;
158 LOG llevError, $msg; 183 LOG llevError, $msg;
159 }; 184 };
160} 185}
161 186
162@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 187@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
163@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 188@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
164@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 189@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
165@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 190@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
166@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 191@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
192@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
167@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 193@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
168 194
169# we bless all objects into (empty) derived classes to force a method lookup 195# we bless all objects into (empty) derived classes to force a method lookup
170# within the Safe compartment. 196# within the Safe compartment.
171for my $pkg (qw( 197for my $pkg (qw(
172 cf::global cf::attachable 198 cf::global cf::attachable
180} 206}
181 207
182$Event::DIED = sub { 208$Event::DIED = sub {
183 warn "error in event callback: @_"; 209 warn "error in event callback: @_";
184}; 210};
211
212#############################################################################
185 213
186=head2 UTILITY FUNCTIONS 214=head2 UTILITY FUNCTIONS
187 215
188=over 4 216=over 4
189 217
232returned. 260returned.
233 261
234Lock names should begin with a unique identifier (for example, cf::map::find 262Lock names should begin with a unique identifier (for example, cf::map::find
235uses map_find and cf::map::load uses map_load). 263uses map_find and cf::map::load uses map_load).
236 264
265=item $locked = cf::lock_active $string
266
267Return true if the lock is currently active, i.e. somebody has locked it.
268
237=cut 269=cut
238 270
239our %LOCK; 271our %LOCK;
240 272
241sub lock_wait($) { 273sub lock_wait($) {
258 290
259 Coro::guard { 291 Coro::guard {
260 # wake up all waiters, to be on the safe side 292 # wake up all waiters, to be on the safe side
261 $_->ready for @{ delete $LOCK{$key} }; 293 $_->ready for @{ delete $LOCK{$key} };
262 } 294 }
295}
296
297sub lock_active($) {
298 my ($key) = @_;
299
300 ! ! $LOCK{$key}
263} 301}
264 302
265sub freeze_mainloop { 303sub freeze_mainloop {
266 return unless $TICK_WATCHER->is_active; 304 return unless $TICK_WATCHER->is_active;
267 305
282 320
283BEGIN { *async = \&Coro::async_pool } 321BEGIN { *async = \&Coro::async_pool }
284 322
285=item cf::sync_job { BLOCK } 323=item cf::sync_job { BLOCK }
286 324
287The design of crossfire+ requires that the main coro ($Coro::main) is 325The design of Crossfire TRT requires that the main coroutine ($Coro::main)
288always able to handle events or runnable, as crossfire+ is only partly 326is always able to handle events or runnable, as Crossfire TRT is only
289reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 327partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
328acceptable.
290 329
291If it must be done, put the blocking parts into C<sync_job>. This will run 330If it must be done, put the blocking parts into C<sync_job>. This will run
292the given BLOCK in another coroutine while waiting for the result. The 331the given BLOCK in another coroutine while waiting for the result. The
293server will be frozen during this time, so the block should either finish 332server will be frozen during this time, so the block should either finish
294fast or be very important. 333fast or be very important.
297 336
298sub sync_job(&) { 337sub sync_job(&) {
299 my ($job) = @_; 338 my ($job) = @_;
300 339
301 if ($Coro::current == $Coro::main) { 340 if ($Coro::current == $Coro::main) {
341 my $time = Event::time;
342
302 # this is the main coro, too bad, we have to block 343 # this is the main coro, too bad, we have to block
303 # till the operation succeeds, freezing the server :/ 344 # till the operation succeeds, freezing the server :/
304 345
305 # TODO: use suspend/resume instead 346 # TODO: use suspend/resume instead
306 # (but this is cancel-safe) 347 # (but this is cancel-safe)
317 358
318 while ($busy) { 359 while ($busy) {
319 Coro::cede or Event::one_event; 360 Coro::cede or Event::one_event;
320 } 361 }
321 362
363 $time = Event::time - $time;
364
365 LOG llevError | logBacktrace, Carp::longmess "long sync job"
366 if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
367
368 $tick_start += $time; # do not account sync jobs to server load
369
322 wantarray ? @res : $res[0] 370 wantarray ? @res : $res[0]
323 } else { 371 } else {
324 # we are in another coroutine, how wonderful, everything just works 372 # we are in another coroutine, how wonderful, everything just works
325 373
326 $job->() 374 $job->()
345 $EXT_CORO{$coro+0} = $coro; 393 $EXT_CORO{$coro+0} = $coro;
346 394
347 $coro 395 $coro
348} 396}
349 397
350sub write_runtime { 398=item fork_call { }, $args
351 my $guard = cf::lock_acquire "write_runtime";
352 399
353 my $runtime = cf::localdir . "/runtime"; 400Executes the given code block with the given arguments in a seperate
401process, returning the results. Everything must be serialisable with
402Coro::Storable. May, of course, block. Note that the executed sub may
403never block itself or use any form of Event handling.
354 404
355 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 405=cut
356 or return;
357 406
358 my $value = $cf::RUNTIME + 90 + 10; 407sub fork_call(&@) {
359 # 10 is the runtime save interval, for a monotonic clock 408 my ($cb, @args) = @_;
360 # 60 allows for the watchdog to kill the server.
361 409
362 (aio_write $fh, 0, (length $value), $value, 0) <= 0 410# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
363 and return; 411# or die "socketpair: $!";
412 pipe my $fh1, my $fh2
413 or die "pipe: $!";
364 414
365 # always fsync - this file is important 415 if (my $pid = fork) {
366 aio_fsync $fh
367 and return;
368
369 close $fh 416 close $fh2;
370 or return;
371 417
372 aio_rename "$runtime~", $runtime 418 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
373 and return; 419 $res = Coro::Storable::thaw $res;
374 420
421 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
422
423 die $$res unless "ARRAY" eq ref $res;
424
425 return wantarray ? @$res : $res->[-1];
426 } else {
427 reset_signals;
428 local $SIG{__WARN__};
429 local $SIG{__DIE__};
430 eval {
431 close $fh1;
432
433 my @res = eval { $cb->(@args) };
434 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
435 };
436
437 warn $@ if $@;
438 _exit 0;
375 1 439 }
440}
441
442=item $value = cf::db_get $family => $key
443
444Returns a single value from the environment database.
445
446=item cf::db_put $family => $key => $value
447
448Stores the given C<$value> in the family. It can currently store binary
449data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
450
451=cut
452
453our $DB;
454
455sub db_init {
456 unless ($DB) {
457 $DB = BDB::db_create $DB_ENV;
458
459 cf::sync_job {
460 eval {
461 $DB->set_flags (BDB::CHKSUM);
462
463 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
464 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
465 cf::cleanup "db_open(db): $!" if $!;
466 };
467 cf::cleanup "db_open(db): $@" if $@;
468 };
469 }
470}
471
472sub db_get($$) {
473 my $key = "$_[0]/$_[1]";
474
475 cf::sync_job {
476 BDB::db_get $DB, undef, $key, my $data;
477
478 $! ? ()
479 : $data
480 }
481}
482
483sub db_put($$$) {
484 BDB::dbreq_pri 4;
485 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
486}
487
488=item cf::cache $id => [$paths...], $processversion => $process
489
490Generic caching function that returns the value of the resource $id,
491caching and regenerating as required.
492
493This function can block.
494
495=cut
496
497sub cache {
498 my ($id, $src, $processversion, $process) = @_;
499
500 my $meta =
501 join "\x00",
502 $processversion,
503 map {
504 aio_stat $_
505 and Carp::croak "$_: $!";
506
507 ($_, (stat _)[7,9])
508 } @$src;
509
510 my $dbmeta = db_get cache => "$id/meta";
511 if ($dbmeta ne $meta) {
512 # changed, we may need to process
513
514 my @data;
515 my $md5;
516
517 for (0 .. $#$src) {
518 0 <= aio_load $src->[$_], $data[$_]
519 or Carp::croak "$src->[$_]: $!";
520 }
521
522 # if processing is expensive, check
523 # checksum first
524 if (1) {
525 $md5 =
526 join "\x00",
527 $processversion,
528 map {
529 Coro::cede;
530 ($src->[$_], Digest::MD5::md5_hex $data[$_])
531 } 0.. $#$src;
532
533
534 my $dbmd5 = db_get cache => "$id/md5";
535 if ($dbmd5 eq $md5) {
536 db_put cache => "$id/meta", $meta;
537
538 return db_get cache => "$id/data";
539 }
540 }
541
542 my $t1 = Time::HiRes::time;
543 my $data = $process->(\@data);
544 my $t2 = Time::HiRes::time;
545
546 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
547
548 db_put cache => "$id/data", $data;
549 db_put cache => "$id/md5" , $md5;
550 db_put cache => "$id/meta", $meta;
551
552 return $data;
553 }
554
555 db_get cache => "$id/data"
376} 556}
377 557
378=item cf::datalog type => key => value, ... 558=item cf::datalog type => key => value, ...
379 559
380Log a datalog packet of the given type with the given key-value pairs. 560Log a datalog packet of the given type with the given key-value pairs.
398attach callbacks/event handlers (a collection of which is called an "attachment") 578attach callbacks/event handlers (a collection of which is called an "attachment")
399to it. All such attachable objects support the following methods. 579to it. All such attachable objects support the following methods.
400 580
401In the following description, CLASS can be any of C<global>, C<object> 581In the following description, CLASS can be any of C<global>, C<object>
402C<player>, C<client> or C<map> (i.e. the attachable objects in 582C<player>, C<client> or C<map> (i.e. the attachable objects in
403crossfire+). 583Crossfire TRT).
404 584
405=over 4 585=over 4
406 586
407=item $attachable->attach ($attachment, key => $value...) 587=item $attachable->attach ($attachment, key => $value...)
408 588
571 $registry = $CB_TYPE[$object_type] ||= []; 751 $registry = $CB_TYPE[$object_type] ||= [];
572 752
573 } elsif ($type eq "subtype") { 753 } elsif ($type eq "subtype") {
574 defined $object_type or Carp::croak "subtype specified without type"; 754 defined $object_type or Carp::croak "subtype specified without type";
575 my $object_subtype = shift @arg; 755 my $object_subtype = shift @arg;
576 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 756 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
577 757
578 } elsif ($type eq "package") { 758 } elsif ($type eq "package") {
579 my $pkg = shift @arg; 759 my $pkg = shift @arg;
580 760
581 while (my ($name, $id) = each %cb_id) { 761 while (my ($name, $id) = each %cb_id) {
610 _attach $registry, $klass, @attach; 790 _attach $registry, $klass, @attach;
611 } 791 }
612 792
613 $obj->{$name} = \%arg; 793 $obj->{$name} = \%arg;
614 } else { 794 } else {
615 warn "object uses attachment '$name' that is not available, postponing.\n"; 795 warn "object uses attachment '$name' which is not available, postponing.\n";
616 } 796 }
617 797
618 $obj->{_attachment}{$name} = undef; 798 $obj->{_attachment}{$name} = undef;
619} 799}
620 800
622 if (ref $_[0]) { 802 if (ref $_[0]) {
623 _object_attach @_; 803 _object_attach @_;
624 } else { 804 } else {
625 _attach shift->_attach_registry, @_; 805 _attach shift->_attach_registry, @_;
626 } 806 }
807 _recalc_want;
627}; 808};
628 809
629# all those should be optimised 810# all those should be optimised
630sub cf::attachable::detach { 811sub cf::attachable::detach {
631 my ($obj, $name) = @_; 812 my ($obj, $name) = @_;
634 delete $obj->{_attachment}{$name}; 815 delete $obj->{_attachment}{$name};
635 reattach ($obj); 816 reattach ($obj);
636 } else { 817 } else {
637 Carp::croak "cannot, currently, detach class attachments"; 818 Carp::croak "cannot, currently, detach class attachments";
638 } 819 }
820 _recalc_want;
639}; 821};
640 822
641sub cf::attachable::attached { 823sub cf::attachable::attached {
642 my ($obj, $name) = @_; 824 my ($obj, $name) = @_;
643 825
816 or return; 998 or return;
817 $av = eval { (Storable::thaw $av)->{objs} }; 999 $av = eval { (Storable::thaw $av)->{objs} };
818 } 1000 }
819 1001
820 warn sprintf "loading %s (%d)\n", 1002 warn sprintf "loading %s (%d)\n",
821 $filename, length $data, scalar @{$av || []};#d# 1003 $filename, length $data, scalar @{$av || []};
822 return ($data, $av); 1004 return ($data, $av);
823} 1005}
1006
1007=head2 COMMAND CALLBACKS
1008
1009=over 4
1010
1011=cut
824 1012
825############################################################################# 1013#############################################################################
826# command handling &c 1014# command handling &c
827 1015
828=item cf::register_command $name => \&callback($ob,$args); 1016=item cf::register_command $name => \&callback($ob,$args);
841 push @{ $COMMAND{$name} }, [$caller, $cb]; 1029 push @{ $COMMAND{$name} }, [$caller, $cb];
842} 1030}
843 1031
844=item cf::register_extcmd $name => \&callback($pl,$packet); 1032=item cf::register_extcmd $name => \&callback($pl,$packet);
845 1033
846Register a callbackf ro execution when the client sends an extcmd packet. 1034Register a callback fro execution when the client sends an extcmd packet.
847 1035
848If the callback returns something, it is sent back as if reply was being 1036If the callback returns something, it is sent back as if reply was being
849called. 1037called.
850 1038
851=cut 1039=cut
886 1074
887 cf::override; 1075 cf::override;
888 }, 1076 },
889); 1077);
890 1078
891sub load_extension {
892 my ($path) = @_;
893
894 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
895 my $base = $1;
896 my $pkg = $1;
897 $pkg =~ s/[^[:word:]]/_/g;
898 $pkg = "ext::$pkg";
899
900 warn "... loading '$path' into '$pkg'\n";
901
902 open my $fh, "<:utf8", $path
903 or die "$path: $!";
904
905 my $source =
906 "package $pkg; use strict; use utf8;\n"
907 . "#line 1 \"$path\"\n{\n"
908 . (do { local $/; <$fh> })
909 . "\n};\n1";
910
911 unless (eval $source) {
912 my $msg = $@ ? "$path: $@\n"
913 : "extension disabled.\n";
914 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
915 warn $@;
916 warn "mandatory extension failed to load, exiting.\n";
917 exit 1;
918 }
919 die $@;
920 }
921
922 push @EXTS, $pkg;
923}
924
925sub load_extensions { 1079sub load_extensions {
1080 cf::sync_job {
1081 my %todo;
1082
926 for my $ext (<$LIBDIR/*.ext>) { 1083 for my $path (<$LIBDIR/*.ext>) {
927 next unless -r $ext; 1084 next unless -r $path;
928 eval { 1085
929 load_extension $ext; 1086 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1087 my $base = $1;
1088 my $pkg = $1;
1089 $pkg =~ s/[^[:word:]]/_/g;
1090 $pkg = "ext::$pkg";
1091
1092 open my $fh, "<:utf8", $path
1093 or die "$path: $!";
1094
1095 my $source = do { local $/; <$fh> };
1096
1097 my %ext = (
1098 path => $path,
1099 base => $base,
1100 pkg => $pkg,
1101 );
1102
1103 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1104 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1105
1106 $ext{source} =
1107 "package $pkg; use strict; use utf8;\n"
1108 . "#line 1 \"$path\"\n{\n"
1109 . $source
1110 . "\n};\n1";
1111
1112 $todo{$base} = \%ext;
1113 }
1114
1115 my %done;
1116 while (%todo) {
1117 my $progress;
1118
1119 while (my ($k, $v) = each %todo) {
1120 for (split /,\s*/, $v->{meta}{depends}) {
1121 goto skip
1122 unless exists $done{$_};
1123 }
1124
1125 warn "... loading '$k' into '$v->{pkg}'\n";
1126
1127 unless (eval $v->{source}) {
1128 my $msg = $@ ? "$v->{path}: $@\n"
1129 : "$v->{base}: extension inactive.\n";
1130
1131 if (exists $v->{meta}{mandatory}) {
1132 warn $msg;
1133 warn "mandatory extension failed to load, exiting.\n";
1134 exit 1;
1135 }
1136
1137 warn $msg;
1138 }
1139
1140 $done{$k} = delete $todo{$k};
1141 push @EXTS, $v->{pkg};
1142 $progress = 1;
930 1 1143 }
931 } or warn "$ext not loaded: $@"; 1144
1145 skip:
1146 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1147 unless $progress;
1148 }
932 } 1149 };
933} 1150}
934 1151
935############################################################################# 1152#############################################################################
936 1153
1154=back
1155
937=head2 CORE EXTENSIONS 1156=head2 CORE EXTENSIONS
938 1157
939Functions and methods that extend core crossfire objects. 1158Functions and methods that extend core crossfire objects.
940 1159
941=cut 1160=cut
953Returns the given player object, loading it if necessary (might block). 1172Returns the given player object, loading it if necessary (might block).
954 1173
955=cut 1174=cut
956 1175
957sub playerdir($) { 1176sub playerdir($) {
958 cf::localdir 1177 "$PLAYERDIR/"
959 . "/"
960 . cf::playerdir
961 . "/"
962 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1178 . (ref $_[0] ? $_[0]->ob->name : $_[0])
963} 1179}
964 1180
965sub path($) { 1181sub path($) {
966 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1182 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1086while and may block, so not sync_job-capable, ever. 1302while and may block, so not sync_job-capable, ever.
1087 1303
1088=cut 1304=cut
1089 1305
1090sub list_logins { 1306sub list_logins {
1091 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1307 my $dirs = aio_readdir $PLAYERDIR
1092 or return []; 1308 or return [];
1093 1309
1094 my @logins; 1310 my @logins;
1095 1311
1096 for my $login (@$dirs) { 1312 for my $login (@$dirs) {
1157 my ($self, $type, %msg) = @_; 1373 my ($self, $type, %msg) = @_;
1158 1374
1159 $self->ns->ext_event ($type, %msg); 1375 $self->ns->ext_event ($type, %msg);
1160} 1376}
1161 1377
1162package cf; 1378=head3 cf::region
1379
1380=over 4
1381
1382=cut
1383
1384package cf::region;
1385
1386=item cf::region::find_by_path $path
1387
1388Tries to decuce the likely region for a map knowing only its path.
1389
1390=cut
1391
1392sub find_by_path($) {
1393 my ($path) = @_;
1394
1395 my ($match, $specificity);
1396
1397 for my $region (list) {
1398 if ($region->match && $path =~ $region->match) {
1399 ($match, $specificity) = ($region, $region->specificity)
1400 if $region->specificity > $specificity;
1401 }
1402 }
1403
1404 $match
1405}
1163 1406
1164=back 1407=back
1165
1166 1408
1167=head3 cf::map 1409=head3 cf::map
1168 1410
1169=over 4 1411=over 4
1170 1412
1225 my ($self, $merge) = @_; 1467 my ($self, $merge) = @_;
1226 1468
1227 # we have to keep some variables in memory intact 1469 # we have to keep some variables in memory intact
1228 local $self->{path}; 1470 local $self->{path};
1229 local $self->{load_path}; 1471 local $self->{load_path};
1230 local $self->{deny_save};
1231 local $self->{deny_reset};
1232 1472
1233 $self->SUPER::thawer_merge ($merge); 1473 $self->SUPER::thawer_merge ($merge);
1234} 1474}
1235 1475
1236sub normalise { 1476sub normalise {
1308 1548
1309# the original (read-only) location 1549# the original (read-only) location
1310sub load_path { 1550sub load_path {
1311 my ($self) = @_; 1551 my ($self) = @_;
1312 1552
1313 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1553 "$MAPDIR/$self->{path}.map"
1314} 1554}
1315 1555
1316# the temporary/swap location 1556# the temporary/swap location
1317sub save_path { 1557sub save_path {
1318 my ($self) = @_; 1558 my ($self) = @_;
1319 1559
1320 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1560 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1321 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1561 "$TMPDIR/$path.map"
1322} 1562}
1323 1563
1324# the unique path, undef == no special unique path 1564# the unique path, undef == no special unique path
1325sub uniq_path { 1565sub uniq_path {
1326 my ($self) = @_; 1566 my ($self) = @_;
1327 1567
1328 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1568 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1329 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1569 "$UNIQUEDIR/$path"
1330} 1570}
1331 1571
1332# and all this just because we cannot iterate over 1572# and all this just because we cannot iterate over
1333# all maps in C++... 1573# all maps in C++...
1334sub change_all_map_light { 1574sub change_all_map_light {
1335 my ($change) = @_; 1575 my ($change) = @_;
1336 1576
1337 $_->change_map_light ($change) 1577 $_->change_map_light ($change)
1338 for grep $_->outdoor, values %cf::MAP; 1578 for grep $_->outdoor, values %cf::MAP;
1579}
1580
1581sub decay_objects {
1582 my ($self) = @_;
1583
1584 return if $self->{deny_reset};
1585
1586 $self->do_decay_objects;
1339} 1587}
1340 1588
1341sub unlink_save { 1589sub unlink_save {
1342 my ($self) = @_; 1590 my ($self) = @_;
1343 1591
1401 $self->load_header_orig 1649 $self->load_header_orig
1402 or return; 1650 or return;
1403 $self->prepare_orig; 1651 $self->prepare_orig;
1404 } 1652 }
1405 1653
1654 $self->{deny_reset} = 1
1655 if $self->no_reset;
1656
1657 $self->default_region (cf::region::find_by_path $self->{path})
1658 unless $self->default_region;
1659
1406 1 1660 1
1407} 1661}
1408 1662
1409sub find; 1663sub find;
1410sub find { 1664sub find {
1422 $map->{last_save} = $cf::RUNTIME; 1676 $map->{last_save} = $cf::RUNTIME;
1423 1677
1424 $map->load_header 1678 $map->load_header
1425 or return; 1679 or return;
1426 1680
1427 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1681 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1428 # doing this can freeze the server in a sync job, obviously 1682 # doing this can freeze the server in a sync job, obviously
1429 #$cf::WAIT_FOR_TICK->wait; 1683 #$cf::WAIT_FOR_TICK->wait;
1430 $map->reset; 1684 $map->reset;
1431 undef $guard; 1685 undef $guard;
1432 return find $path; 1686 return find $path;
1443 my ($self) = @_; 1697 my ($self) = @_;
1444 1698
1445 local $self->{deny_reset} = 1; # loading can take a long time 1699 local $self->{deny_reset} = 1; # loading can take a long time
1446 1700
1447 my $path = $self->{path}; 1701 my $path = $self->{path};
1702
1703 {
1448 my $guard = cf::lock_acquire "map_load:$path"; 1704 my $guard = cf::lock_acquire "map_load:$path";
1449 1705
1450 return if $self->in_memory != cf::MAP_SWAPPED; 1706 return if $self->in_memory != cf::MAP_SWAPPED;
1451 1707
1452 $self->in_memory (cf::MAP_LOADING); 1708 $self->in_memory (cf::MAP_LOADING);
1453 1709
1454 $self->alloc; 1710 $self->alloc;
1455 1711
1456 $self->pre_load; 1712 $self->pre_load;
1457
1458 $self->_load_objects ($self->{load_path}, 1)
1459 or return;
1460
1461 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1462 if delete $self->{load_original};
1463
1464 if (my $uniq = $self->uniq_path) {
1465 utf8::encode $uniq;
1466 if (aio_open $uniq, O_RDONLY, 0) {
1467 $self->clear_unique_items;
1468 $self->_load_objects ($uniq, 0);
1469 }
1470 }
1471
1472 Coro::cede;
1473
1474 # now do the right thing for maps
1475 $self->link_multipart_objects;
1476
1477 unless ($self->{deny_activate}) {
1478 $self->decay_objects;
1479 $self->fix_auto_apply;
1480 $self->update_buttons;
1481 Coro::cede; 1713 Coro::cede;
1482 $self->set_darkness_map; 1714
1715 $self->_load_objects ($self->{load_path}, 1)
1716 or return;
1717
1718 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1719 if delete $self->{load_original};
1720
1721 if (my $uniq = $self->uniq_path) {
1722 utf8::encode $uniq;
1723 if (aio_open $uniq, O_RDONLY, 0) {
1724 $self->clear_unique_items;
1725 $self->_load_objects ($uniq, 0);
1726 }
1727 }
1728
1729 Coro::cede;
1730 # now do the right thing for maps
1731 $self->link_multipart_objects;
1483 $self->difficulty ($self->estimate_difficulty) 1732 $self->difficulty ($self->estimate_difficulty)
1484 unless $self->difficulty; 1733 unless $self->difficulty;
1485 Coro::cede; 1734 Coro::cede;
1735
1736 unless ($self->{deny_activate}) {
1737 $self->decay_objects;
1738 $self->fix_auto_apply;
1739 $self->update_buttons;
1740 Coro::cede;
1741 $self->set_darkness_map;
1742 Coro::cede;
1486 $self->activate; 1743 $self->activate;
1744 }
1745
1746 $self->in_memory (cf::MAP_IN_MEMORY);
1487 } 1747 }
1488 1748
1489 $self->post_load; 1749 $self->post_load;
1490
1491 $self->in_memory (cf::MAP_IN_MEMORY);
1492} 1750}
1493 1751
1494sub customise_for { 1752sub customise_for {
1495 my ($self, $ob) = @_; 1753 my ($self, $ob) = @_;
1496 1754
1497 return find "~" . $ob->name . "/" . $self->{path} 1755 return find "~" . $ob->name . "/" . $self->{path}
1498 if $self->per_player; 1756 if $self->per_player;
1757
1758# return find "?party/" . $ob->name . "/" . $self->{path}
1759# if $self->per_party;
1499 1760
1500 $self 1761 $self
1501} 1762}
1502 1763
1503# find and load all maps in the 3x3 area around a map 1764# find and load all maps in the 3x3 area around a map
1614 1875
1615sub reset_at { 1876sub reset_at {
1616 my ($self) = @_; 1877 my ($self) = @_;
1617 1878
1618 # TODO: safety, remove and allow resettable per-player maps 1879 # TODO: safety, remove and allow resettable per-player maps
1619 return 1e99 if $self->isa ("ext::map_per_player");#d#
1620 return 1e99 if $self->{deny_reset}; 1880 return 1e99 if $self->{deny_reset};
1621 1881
1622 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 1882 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1623 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 1883 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1624 1884
1635 my ($self) = @_; 1895 my ($self) = @_;
1636 1896
1637 my $lock = cf::lock_acquire "map_data:$self->{path}"; 1897 my $lock = cf::lock_acquire "map_data:$self->{path}";
1638 1898
1639 return if $self->players; 1899 return if $self->players;
1640 return if $self->isa ("ext::map_per_player");#d#
1641 1900
1642 warn "resetting map ", $self->path;#d# 1901 warn "resetting map ", $self->path;
1643 1902
1644 $self->in_memory (cf::MAP_SWAPPED); 1903 $self->in_memory (cf::MAP_SWAPPED);
1645 1904
1646 # need to save uniques path 1905 # need to save uniques path
1647 unless ($self->{deny_save}) { 1906 unless ($self->{deny_save}) {
1679 $cf::MAP{$self->path} = $self; 1938 $cf::MAP{$self->path} = $self;
1680 1939
1681 $self->reset; # polite request, might not happen 1940 $self->reset; # polite request, might not happen
1682} 1941}
1683 1942
1943=item $maps = cf::map::tmp_maps
1944
1945Returns an arrayref with all map paths of currently instantiated and saved
1946maps. May block.
1947
1948=cut
1949
1950sub tmp_maps() {
1951 [
1952 map {
1953 utf8::decode $_;
1954 /\.map$/
1955 ? normalise $_
1956 : ()
1957 } @{ aio_readdir $TMPDIR or [] }
1958 ]
1959}
1960
1961=item $maps = cf::map::random_maps
1962
1963Returns an arrayref with all map paths of currently instantiated and saved
1964random maps. May block.
1965
1966=cut
1967
1968sub random_maps() {
1969 [
1970 map {
1971 utf8::decode $_;
1972 /\.map$/
1973 ? normalise "?random/$_"
1974 : ()
1975 } @{ aio_readdir $RANDOMDIR or [] }
1976 ]
1977}
1978
1684=item cf::map::unique_maps 1979=item cf::map::unique_maps
1685 1980
1686Returns an arrayref of paths of all shared maps that have 1981Returns an arrayref of paths of all shared maps that have
1687instantiated unique items. May block. 1982instantiated unique items. May block.
1688 1983
1689=cut 1984=cut
1690 1985
1691sub unique_maps() { 1986sub unique_maps() {
1692 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 1987 [
1693 or return; 1988 map {
1694
1695 my @paths;
1696
1697 for (@$files) {
1698 utf8::decode $_; 1989 utf8::decode $_;
1699 next if /\.pst$/; 1990 /\.map$/
1700 next unless /^$PATH_SEP/o; 1991 ? normalise $_
1701 1992 : ()
1702 push @paths, cf::map::normalise $_; 1993 } @{ aio_readdir $UNIQUEDIR or [] }
1703 } 1994 ]
1704
1705 \@paths
1706} 1995}
1707 1996
1708package cf; 1997package cf;
1709 1998
1710=back 1999=back
1756 2045
1757 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2046 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1758 2047
1759 if ($self->{record_replies}) { 2048 if ($self->{record_replies}) {
1760 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2049 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2050
1761 } else { 2051 } else {
2052 my $pl = $self->contr;
2053
2054 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2055 my $diag = $pl->{npc_dialog};
2056 $diag->{pl}->ext_reply (
2057 $diag->{id}, msgtype => "reply", msg => $msg, add_topics => []
2058 );
2059
2060 } else {
1762 $msg = $npc->name . " says: $msg" if $npc; 2061 $msg = $npc->name . " says: $msg" if $npc;
1763 $self->message ($msg, $flags); 2062 $self->message ($msg, $flags);
2063 }
1764 } 2064 }
1765} 2065}
1766 2066
1767=item $player_object->may ("access") 2067=item $player_object->may ("access")
1768 2068
1816 $self->deactivate_recursive; 2116 $self->deactivate_recursive;
1817 2117
1818 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2118 return if UNIVERSAL::isa $self->map, "ext::map_link";
1819 2119
1820 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2120 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1821 if $self->map; 2121 if $self->map && $self->map->{path} ne "{link}";
1822 2122
1823 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2123 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1824} 2124}
1825 2125
1826sub cf::object::player::leave_link { 2126sub cf::object::player::leave_link {
1827 my ($self, $map, $x, $y) = @_; 2127 my ($self, $map, $x, $y) = @_;
2128
2129 return unless $self->contr->active;
1828 2130
1829 my $link_pos = delete $self->{_link_pos}; 2131 my $link_pos = delete $self->{_link_pos};
1830 2132
1831 unless ($map) { 2133 unless ($map) {
1832 # restore original map position 2134 # restore original map position
1855 2157
1856 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2158 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1857 $self->enter_map ($map, $x, $y); 2159 $self->enter_map ($map, $x, $y);
1858} 2160}
1859 2161
1860cf::player->attach (
1861 on_logout => sub {
1862 my ($pl) = @_;
1863
1864 # abort map switching before logout
1865 if ($pl->ob->{_link_pos}) {
1866 cf::sync_job {
1867 $pl->ob->leave_link
1868 };
1869 }
1870 },
1871 on_login => sub {
1872 my ($pl) = @_;
1873
1874 # try to abort aborted map switching on player login :)
1875 # should happen only on crashes
1876 if ($pl->ob->{_link_pos}) {
1877 $pl->ob->enter_link;
1878 (async {
1879 $pl->ob->reply (undef,
1880 "There was an internal problem at your last logout, "
1881 . "the server will try to bring you to your intended destination in a second.",
1882 cf::NDI_RED);
1883 # we need this sleep as the login has a concurrent enter_exit running
1884 # and this sleep increases chances of the player not ending up in scorn
1885 Coro::Timer::sleep 1;
1886 $pl->ob->leave_link;
1887 })->prio (2);
1888 }
1889 },
1890);
1891
1892=item $player_object->goto ($path, $x, $y) 2162=item $player_object->goto ($path, $x, $y[, $check->($map)])
1893 2163
2164Moves the player to the given map-path and coordinates by first freezing
2165her, loading and preparing them map, calling the provided $check callback
2166that has to return the map if sucecssful, and then unfreezes the player on
2167the new (success) or old (failed) map position.
2168
1894=cut 2169=cut
2170
2171our $GOTOGEN;
1895 2172
1896sub cf::object::player::goto { 2173sub cf::object::player::goto {
1897 my ($self, $path, $x, $y) = @_; 2174 my ($self, $path, $x, $y, $check) = @_;
2175
2176 # do generation counting so two concurrent goto's will be executed in-order
2177 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1898 2178
1899 $self->enter_link; 2179 $self->enter_link;
1900 2180
1901 (async { 2181 (async {
1902 my $map = eval { 2182 my $map = eval {
1903 my $map = cf::map::find $path; 2183 my $map = cf::map::find $path;
2184
2185 if ($map) {
1904 $map = $map->customise_for ($self) if $map; 2186 $map = $map->customise_for ($self);
2187 $map = $check->($map) if $check && $map;
2188 } else {
2189 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2190 }
2191
1905 $map 2192 $map
2193 };
2194
2195 if ($@) {
2196 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2197 LOG llevError | logBacktrace, Carp::longmess $@;
1906 } or 2198 }
1907 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1908 2199
2200 if ($gen == $self->{_goto_generation}) {
2201 delete $self->{_goto_generation};
1909 $self->leave_link ($map, $x, $y); 2202 $self->leave_link ($map, $x, $y);
2203 }
1910 })->prio (1); 2204 })->prio (1);
1911} 2205}
1912 2206
1913=item $player_object->enter_exit ($exit_object) 2207=item $player_object->enter_exit ($exit_object)
1914 2208
1953 2247
1954 $rmp->{random_seed} ||= $exit->random_seed; 2248 $rmp->{random_seed} ||= $exit->random_seed;
1955 2249
1956 my $data = cf::to_json $rmp; 2250 my $data = cf::to_json $rmp;
1957 my $md5 = Digest::MD5::md5_hex $data; 2251 my $md5 = Digest::MD5::md5_hex $data;
1958 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2252 my $meta = "$RANDOMDIR/$md5.meta";
1959 2253
1960 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2254 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1961 aio_write $fh, 0, (length $data), $data, 0; 2255 aio_write $fh, 0, (length $data), $data, 0;
1962 undef $fh; 2256 undef $fh;
1963 aio_rename "$meta~", $meta; 2257 aio_rename "$meta~", $meta;
2228=back 2522=back
2229 2523
2230=cut 2524=cut
2231 2525
2232############################################################################# 2526#############################################################################
2233
2234=head2 EXTENSION DATABASE SUPPORT
2235
2236Crossfire maintains a very simple database for extension use. It can
2237currently store anything that can be serialised using Storable, which
2238excludes objects.
2239
2240The parameter C<$family> should best start with the name of the extension
2241using it, it should be unique.
2242
2243=over 4
2244
2245=item $value = cf::db_get $family => $key
2246
2247Returns a single value from the database.
2248
2249=item cf::db_put $family => $key => $value
2250
2251Stores the given C<$value> in the family.
2252
2253=cut
2254
2255our $DB;
2256
2257sub db_init {
2258 unless ($DB) {
2259 $DB = BDB::db_create $DB_ENV;
2260
2261 cf::sync_job {
2262 eval {
2263 $DB->set_flags (BDB::CHKSUM);
2264
2265 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2266 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2267 cf::cleanup "db_open(db): $!" if $!;
2268 };
2269 cf::cleanup "db_open(db): $@" if $@;
2270 };
2271
2272 my $path = cf::localdir . "/database.pst";
2273 if (stat $path) {
2274 cf::sync_job {
2275 my $pst = Storable::retrieve $path;
2276
2277 cf::db_put (board => data => $pst->{board});
2278 cf::db_put (guildrules => data => $pst->{guildrules});
2279 cf::db_put (rent => balance => $pst->{rent}{balance});
2280 BDB::db_env_txn_checkpoint $DB_ENV;
2281
2282 unlink $path;
2283 };
2284 }
2285 }
2286}
2287
2288sub db_get($$) {
2289 my $key = "$_[0]/$_[1]";
2290
2291 cf::sync_job {
2292 BDB::db_get $DB, undef, $key, my $data;
2293
2294 $! ? ()
2295 : Compress::LZF::sthaw $data
2296 }
2297}
2298
2299sub db_put($$$) {
2300 BDB::dbreq_pri 4;
2301 BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2302}
2303
2304#############################################################################
2305# the server's init and main functions 2527# the server's init and main functions
2306 2528
2307sub load_facedata { 2529sub load_facedata($) {
2308 my $path = sprintf "%s/facedata", cf::datadir; 2530 my ($path) = @_;
2309 2531
2310 warn "loading facedata from $path\n"; 2532 warn "loading facedata from $path\n";
2311 2533
2312 my $faces; 2534 my $facedata;
2313 0 < aio_load $path, $faces 2535 0 < aio_load $path, $facedata
2314 or die "$path: $!"; 2536 or die "$path: $!";
2315 2537
2316 Coro::cede;
2317 $faces = Storable::thaw $faces; 2538 $facedata = Coro::Storable::thaw $facedata;
2318 Coro::cede;
2319 2539
2320 my $meta = delete $faces->{""};
2321 $meta->{version} == 1 2540 $facedata->{version} == 2
2322 or cf::cleanup "$path: version mismatch, cannot proceed."; 2541 or cf::cleanup "$path: version mismatch, cannot proceed.";
2323 2542
2543 {
2544 my $faces = $facedata->{faceinfo};
2545
2324 while (my ($face, $info) = each %$faces) { 2546 while (my ($face, $info) = each %$faces) {
2325 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2547 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2326 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2548 cf::face::set $idx, $info->{visibility}, $info->{magicmap};
2327 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2549 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2328 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 2550 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2329 Coro::cede; 2551 Coro::cede;
2330 } 2552 }
2331 2553
2332 while (my ($face, $info) = each %$faces) { 2554 while (my ($face, $info) = each %$faces) {
2333 next unless $info->{smooth}; 2555 next unless $info->{smooth};
2334 my $idx = cf::face::find $face 2556 my $idx = cf::face::find $face
2335 or next; 2557 or next;
2336 if (my $smooth = cf::face::find $info->{smooth}) { 2558 if (my $smooth = cf::face::find $info->{smooth}) {
2337 cf::face::set_smooth $idx, $smooth; 2559 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
2338 } else { 2560 } else {
2339 warn "smooth face '$info->{smooth}' not found for face '$face'"; 2561 warn "smooth face '$info->{smooth}' not found for face '$face'";
2340 } 2562 }
2341 Coro::cede; 2563 Coro::cede;
2564 }
2565 }
2566
2567 {
2568 my $anims = $facedata->{animinfo};
2569
2570 while (my ($anim, $info) = each %$anims) {
2571 cf::anim::set $anim, $info->{frames}, $info->{facings};
2572 Coro::cede;
2573 }
2574
2575 cf::anim::invalidate_all; # d'oh
2342 } 2576 }
2343 2577
2344 1 2578 1
2345} 2579}
2346 2580
2581sub reload_regions {
2582 load_resource_file "$MAPDIR/regions"
2583 or die "unable to load regions file\n";
2584}
2585
2586sub reload_facedata {
2587 load_facedata "$DATADIR/facedata"
2588 or die "unable to load facedata\n";
2589}
2590
2591sub reload_archetypes {
2592 load_resource_file "$DATADIR/archetypes"
2593 or die "unable to load archetypes\n";
2594}
2595
2596sub reload_treasures {
2597 load_resource_file "$DATADIR/treasures"
2598 or die "unable to load treasurelists\n";
2599}
2600
2347sub reload_resources { 2601sub reload_resources {
2348 load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir 2602 warn "reloading resource files...\n";
2349 or die "unable to load regions file\n";#d# 2603
2604 reload_regions;
2350 load_facedata 2605 reload_facedata;
2351 or die "unable to load facedata\n";#d# 2606 #reload_archetypes;#d#
2607 reload_archetypes;
2608 reload_treasures;
2609
2610 warn "finished reloading resource files\n";
2352} 2611}
2353 2612
2354sub init { 2613sub init {
2355 reload_resources; 2614 reload_resources;
2356} 2615}
2357 2616
2358sub cfg_load { 2617sub cfg_load {
2359 open my $fh, "<:utf8", cf::confdir . "/config" 2618 open my $fh, "<:utf8", "$CONFDIR/config"
2360 or return; 2619 or return;
2361 2620
2362 local $/; 2621 local $/;
2363 *CFG = YAML::Syck::Load <$fh>; 2622 *CFG = YAML::Syck::Load <$fh>;
2364 2623
2409 }, 2668 },
2410 ); 2669 );
2411 } 2670 }
2412} 2671}
2413 2672
2673sub write_runtime {
2674 my $runtime = "$LOCALDIR/runtime";
2675
2676 # first touch the runtime file to show we are still running:
2677 # the fsync below can take a very very long time.
2678
2679 IO::AIO::aio_utime $runtime, undef, undef;
2680
2681 my $guard = cf::lock_acquire "write_runtime";
2682
2683 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2684 or return;
2685
2686 my $value = $cf::RUNTIME + 90 + 10;
2687 # 10 is the runtime save interval, for a monotonic clock
2688 # 60 allows for the watchdog to kill the server.
2689
2690 (aio_write $fh, 0, (length $value), $value, 0) <= 0
2691 and return;
2692
2693 # always fsync - this file is important
2694 aio_fsync $fh
2695 and return;
2696
2697 # touch it again to show we are up-to-date
2698 aio_utime $fh, undef, undef;
2699
2700 close $fh
2701 or return;
2702
2703 aio_rename "$runtime~", $runtime
2704 and return;
2705
2706 warn "runtime file written.\n";
2707
2708 1
2709}
2710
2414sub emergency_save() { 2711sub emergency_save() {
2415 my $freeze_guard = cf::freeze_mainloop; 2712 my $freeze_guard = cf::freeze_mainloop;
2416 2713
2417 warn "enter emergency perl save\n"; 2714 warn "enter emergency perl save\n";
2418 2715
2449 2746
2450 warn Carp::longmess "post_cleanup backtrace" 2747 warn Carp::longmess "post_cleanup backtrace"
2451 if $make_core; 2748 if $make_core;
2452} 2749}
2453 2750
2454sub reload() { 2751sub do_reload_perl() {
2455 # can/must only be called in main 2752 # can/must only be called in main
2456 if ($Coro::current != $Coro::main) { 2753 if ($Coro::current != $Coro::main) {
2457 warn "can only reload from main coroutine"; 2754 warn "can only reload from main coroutine";
2458 return; 2755 return;
2459 } 2756 }
2534 Symbol::delete_package "safe::$_" 2831 Symbol::delete_package "safe::$_"
2535 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 2832 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2536 2833
2537 warn "unloading cf.pm \"a bit\""; 2834 warn "unloading cf.pm \"a bit\"";
2538 delete $INC{"cf.pm"}; 2835 delete $INC{"cf.pm"};
2836 delete $INC{"cf/pod.pm"};
2539 2837
2540 # don't, removes xs symbols, too, 2838 # don't, removes xs symbols, too,
2541 # and global variables created in xs 2839 # and global variables created in xs
2542 #Symbol::delete_package __PACKAGE__; 2840 #Symbol::delete_package __PACKAGE__;
2543 2841
2558 warn "reattaching attachments to maps"; 2856 warn "reattaching attachments to maps";
2559 reattach $_ for values %MAP; 2857 reattach $_ for values %MAP;
2560 warn "reattaching attachments to players"; 2858 warn "reattaching attachments to players";
2561 reattach $_ for values %PLAYER; 2859 reattach $_ for values %PLAYER;
2562 2860
2563 warn "loading reloadable resources";
2564 reload_resources;
2565
2566 warn "leaving sync_job"; 2861 warn "leaving sync_job";
2567 2862
2568 1 2863 1
2569 } or do { 2864 } or do {
2570 warn $@; 2865 warn $@;
2575 warn "reloaded"; 2870 warn "reloaded";
2576}; 2871};
2577 2872
2578our $RELOAD_WATCHER; # used only during reload 2873our $RELOAD_WATCHER; # used only during reload
2579 2874
2875sub reload_perl() {
2876 # doing reload synchronously and two reloads happen back-to-back,
2877 # coro crashes during coro_state_free->destroy here.
2878
2879 $RELOAD_WATCHER ||= Event->timer (
2880 reentrant => 0,
2881 after => 0,
2882 data => WF_AUTOCANCEL,
2883 cb => sub {
2884 do_reload_perl;
2885 undef $RELOAD_WATCHER;
2886 },
2887 );
2888}
2889
2580register_command "reload" => sub { 2890register_command "reload" => sub {
2581 my ($who, $arg) = @_; 2891 my ($who, $arg) = @_;
2582 2892
2583 if ($who->flag (FLAG_WIZ)) { 2893 if ($who->flag (FLAG_WIZ)) {
2584 $who->message ("reloading server."); 2894 $who->message ("reloading server.");
2585 2895 async { reload_perl };
2586 # doing reload synchronously and two reloads happen back-to-back,
2587 # coro crashes during coro_state_free->destroy here.
2588
2589 $RELOAD_WATCHER ||= Event->timer (
2590 reentrant => 0,
2591 after => 0,
2592 data => WF_AUTOCANCEL,
2593 cb => sub {
2594 reload;
2595 undef $RELOAD_WATCHER;
2596 },
2597 );
2598 } 2896 }
2599}; 2897};
2600 2898
2601unshift @INC, $LIBDIR; 2899unshift @INC, $LIBDIR;
2602 2900
2603my $bug_warning = 0; 2901my $bug_warning = 0;
2604 2902
2903our @WAIT_FOR_TICK;
2904our @WAIT_FOR_TICK_BEGIN;
2905
2906sub wait_for_tick {
2907 return unless $TICK_WATCHER->is_active;
2908 return if $Coro::current == $Coro::main;
2909
2910 my $signal = new Coro::Signal;
2911 push @WAIT_FOR_TICK, $signal;
2912 $signal->wait;
2913}
2914
2915sub wait_for_tick_begin {
2916 return unless $TICK_WATCHER->is_active;
2917 return if $Coro::current == $Coro::main;
2918
2919 my $signal = new Coro::Signal;
2920 push @WAIT_FOR_TICK_BEGIN, $signal;
2921 $signal->wait;
2922}
2923
2924 my $min = 1e6;#d#
2925 my $avg = 10;
2605$TICK_WATCHER = Event->timer ( 2926$TICK_WATCHER = Event->timer (
2606 reentrant => 0, 2927 reentrant => 0,
2607 parked => 1, 2928 parked => 1,
2608 prio => 0, 2929 prio => 0,
2609 at => $NEXT_TICK || $TICK, 2930 at => $NEXT_TICK || $TICK,
2613 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 2934 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2614 unless ++$bug_warning > 10; 2935 unless ++$bug_warning > 10;
2615 return; 2936 return;
2616 } 2937 }
2617 2938
2618 $NOW = Event::time; 2939 $NOW = $tick_start = Event::time;
2619 2940
2620 cf::server_tick; # one server iteration 2941 cf::server_tick; # one server iteration
2942
2943 0 && sync_job {#d#
2944 for(1..10) {
2945 my $t = Event::time;
2946 my $map = my $map = new_from_path cf::map "/tmp/x.map"
2947 or die;
2948
2949 $map->width (50);
2950 $map->height (50);
2951 $map->alloc;
2952 $map->_load_objects ("/tmp/x.map", 1);
2953 my $t = Event::time - $t;
2954
2955 #next unless $t < 0.0013;#d#
2956 if ($t < $min) {
2957 $min = $t;
2958 }
2959 $avg = $avg * 0.99 + $t * 0.01;
2960 }
2961 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
2962 exit 0;
2963 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
2964 };
2965
2621 $RUNTIME += $TICK; 2966 $RUNTIME += $TICK;
2622 $NEXT_TICK += $TICK; 2967 $NEXT_TICK += $TICK;
2623 2968
2624 if ($NOW >= $NEXT_RUNTIME_WRITE) { 2969 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2625 $NEXT_RUNTIME_WRITE = $NOW + 10; 2970 $NEXT_RUNTIME_WRITE = $NOW + 10;
2627 write_runtime 2972 write_runtime
2628 or warn "ERROR: unable to write runtime file: $!"; 2973 or warn "ERROR: unable to write runtime file: $!";
2629 }; 2974 };
2630 } 2975 }
2631 2976
2632 $WAIT_FOR_TICK->broadcast;
2633 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2634
2635# my $AFTER = Event::time; 2977# my $AFTER = Event::time;
2636# warn $AFTER - $NOW;#d# 2978# warn $AFTER - $NOW;#d#
2637 2979
2980 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
2981 $sig->send;
2982 }
2983 while (my $sig = shift @WAIT_FOR_TICK) {
2984 $sig->send;
2985 }
2986
2987 $NOW = Event::time;
2988
2638 # if we are delayed by four ticks or more, skip them all 2989 # if we are delayed by four ticks or more, skip them all
2639 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 2990 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2640 2991
2641 $TICK_WATCHER->at ($NEXT_TICK); 2992 $TICK_WATCHER->at ($NEXT_TICK);
2642 $TICK_WATCHER->start; 2993 $TICK_WATCHER->start;
2994
2995 $LOAD = ($NOW - $tick_start) / $TICK;
2996 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
2997
2998 _post_tick;
2999
3000
2643 }, 3001 },
2644); 3002);
2645 3003
2646{ 3004{
2647 BDB::max_poll_time $TICK * 0.1; 3005 BDB::max_poll_time $TICK * 0.1;
2675 3033
2676 cf::sync_job { 3034 cf::sync_job {
2677 eval { 3035 eval {
2678 BDB::db_env_open 3036 BDB::db_env_open
2679 $DB_ENV, 3037 $DB_ENV,
2680 $BDB_ENV_DIR, 3038 $BDBDIR,
2681 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 3039 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2682 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3040 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2683 0666; 3041 0666;
2684 3042
2685 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!; 3043 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2686 3044
2687 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1); 3045 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2688 $DB_ENV->set_lk_detect; 3046 $DB_ENV->set_lk_detect;
2689 }; 3047 };
2690 3048
2706 prio => 6, 3064 prio => 6,
2707 cb => \&IO::AIO::poll_cb, 3065 cb => \&IO::AIO::poll_cb,
2708 ); 3066 );
2709} 3067}
2710 3068
3069my $_log_backtrace;
3070
3071sub _log_backtrace {
3072 my ($msg, @addr) = @_;
3073
3074 $msg =~ s/\n//;
3075
3076 # limit the # of concurrent backtraces
3077 if ($_log_backtrace < 2) {
3078 ++$_log_backtrace;
3079 async {
3080 my @bt = fork_call {
3081 @addr = map { sprintf "%x", $_ } @addr;
3082 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3083 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3084 or die "addr2line: $!";
3085
3086 my @funcs;
3087 my @res = <$fh>;
3088 chomp for @res;
3089 while (@res) {
3090 my ($func, $line) = splice @res, 0, 2, ();
3091 push @funcs, "[$func] $line";
3092 }
3093
3094 @funcs
3095 };
3096
3097 LOG llevInfo, "[ABT] $msg\n";
3098 LOG llevInfo, "[ABT] $_\n" for @bt;
3099 --$_log_backtrace;
3100 };
3101 } else {
3102 LOG llevInfo, "[ABT] $msg\n";
3103 LOG llevInfo, "[ABT] [suppressed]\n";
3104 }
3105}
3106
3107# load additional modules
3108use cf::pod;
3109
2711END { cf::emergency_save } 3110END { cf::emergency_save }
2712 3111
27131 31121
2714 3113

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines