-
Notifications
You must be signed in to change notification settings - Fork 26
/
Kernel.pm
5322 lines (4062 loc) · 166 KB
/
Kernel.pm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package POE::Kernel;
use strict;
use vars qw($VERSION);
$VERSION = '1.299'; # NOTE - Should be #.### (three decimal places)
use POSIX qw(uname);
use Errno qw(ESRCH EINTR ECHILD EPERM EINVAL EEXIST EAGAIN EWOULDBLOCK);
use Carp qw(carp croak confess cluck);
use Sys::Hostname qw(hostname);
use IO::Handle ();
use File::Spec ();
use Time::HiRes qw(time sleep);
# People expect these to be lexical.
use vars qw($poe_kernel $poe_main_window);
#------------------------------------------------------------------------------
# A cheezy exporter to avoid using Exporter.
my $queue_class;
BEGIN {
eval {
require POE::XS::Queue::Array;
POE::XS::Queue::Array->import();
$queue_class = "POE::XS::Queue::Array";
};
unless ($queue_class) {
require POE::Queue::Array;
POE::Queue::Array->import();
$queue_class = "POE::Queue::Array";
}
}
sub import {
my ($class, $args) = ($poe_kernel, @_[1..$#_]);
my $package = caller();
croak "POE::Kernel expects its arguments in a hash ref"
if ($args && ref($args) ne 'HASH');
{
no strict 'refs';
*{ $package . '::poe_kernel' } = \$poe_kernel;
*{ $package . '::poe_main_window' } = \$poe_main_window;
}
# Extract the import arguments we're interested in here.
my $loop = delete $args->{loop} || $ENV{POE_EVENT_LOOP};
# Don't accept unknown/mistyped arguments.
my @unknown = sort keys %$args;
croak "Unknown POE::Kernel import arguments: @unknown" if @unknown;
# Now do things with them.
unless (UNIVERSAL::can('POE::Kernel', 'poe_kernel_loop')) {
if (defined $loop) {
$loop =~ s/^(POE::)?(XS::)?(Loop::)?//;
if (defined $2) {
$loop = "POE::XS::Loop::$loop";
}
else {
$loop = "POE::Loop::$loop";
}
}
_test_loop($loop);
# Bootstrap the kernel. This is inherited from a time when multiple
# kernels could be present in the same Perl process.
POE::Kernel->new() if UNIVERSAL::can('POE::Kernel', 'poe_kernel_loop');
}
}
#------------------------------------------------------------------------------
# Perform some optional setup.
BEGIN {
local $SIG{'__DIE__'} = 'DEFAULT';
{
no strict 'refs';
if ($^O eq 'MSWin32') {
*{ __PACKAGE__ . '::RUNNING_IN_HELL' } = sub { 1 };
} else {
*{ __PACKAGE__ . '::RUNNING_IN_HELL' } = sub { 0 };
}
}
}
BEGIN {
# Set up a "constant" sub that lets the user deactivate
# automatic exception handling
{ no strict 'refs';
unless (defined &CATCH_EXCEPTIONS) {
my $catch_exceptions = (
(exists $ENV{POE_CATCH_EXCEPTIONS})
? $ENV{POE_CATCH_EXCEPTIONS}
: 1
);
if ($catch_exceptions) {
*CATCH_EXCEPTIONS = sub () { 1 };
}
else {
*CATCH_EXCEPTIONS = sub () { 0 };
}
}
}
{ no strict 'refs';
unless (defined &CHILD_POLLING_INTERVAL) {
# That's one second, not a true value.
*CHILD_POLLING_INTERVAL = sub () { 1 };
}
}
{ no strict 'refs';
unless (defined &USE_SIGCHLD) {
# Perl >= 5.7.3 has safe signals support
# perlipc.pod#Deferred_Signals_(Safe_Signals)
# We decided to target 5.8.1 just to be safe :)
if ( $] >= 5.008001 and not RUNNING_IN_HELL ) {
*USE_SIGCHLD = sub () { 1 };
} else {
*USE_SIGCHLD = sub () { 0 };
}
}
}
{ no strict 'refs';
unless (defined &USE_SIGNAL_PIPE) {
my $use_signal_pipe;
if ( exists $ENV{POE_USE_SIGNAL_PIPE} ) {
$use_signal_pipe = $ENV{POE_USE_SIGNAL_PIPE};
}
if (RUNNING_IN_HELL) {
if ($use_signal_pipe) {
_warn(
"Sorry, disabling USE_SIGNAL_PIPE on $^O.\n",
"Programs are reported to hang when it's enabled.\n",
);
}
# Must be defined to supersede the default.
$use_signal_pipe = 0;
}
if ($use_signal_pipe or not defined $use_signal_pipe) {
*USE_SIGNAL_PIPE = sub () { 1 };
}
else {
*USE_SIGNAL_PIPE = sub () { 0 };
}
}
}
}
#==============================================================================
# Globals, or at least package-scoped things. Data structures were
# moved into lexicals in 0.1201.
# A reference to the currently active session. Used throughout the
# functions that act on the current session.
my $kr_active_session;
my $kr_active_event;
my $kr_active_event_type;
# Needs to be lexical so that POE::Resource::Events can see it
# change. TODO - Something better? Maybe we call a method in
# POE::Resource::Events to trigger the exception there?
use vars qw($kr_exception);
# The Kernel's master queue.
my $kr_queue;
# The current PID, to detect when it changes
my $kr_pid;
# Filehandle activity modes. They are often used as list indexes.
sub MODE_RD () { 0 } # read
sub MODE_WR () { 1 } # write
sub MODE_EX () { 2 } # exception/expedite
#------------------------------------------------------------------------------
# Kernel structure. This is the root of a large data tree. Dumping
# $poe_kernel with Data::Dumper or something will show most of the
# data that POE keeps track of. The exceptions to this are private
# storage in some of the leaf objects, such as POE::Wheel. All its
# members are described in detail further on.
my $kr_id_seq = 0;
sub KR_SESSIONS () { 0 } # [ \%kr_sessions,
sub KR_FILENOS () { 1 } # \%kr_filenos,
sub KR_SIGNALS () { 2 } # \%kr_signals,
sub KR_ALIASES () { 3 } # \%kr_aliases,
sub KR_ACTIVE_SESSION () { 4 } # \$kr_active_session,
sub KR_QUEUE () { 5 } # \$kr_queue,
sub KR_ID () { 6 } # $unique_kernel_id,
sub KR_SESSION_IDS () { 7 } # \%kr_session_ids,
sub KR_SID_SEQ () { 8 } # \$kr_sid_seq,
sub KR_EXTRA_REFS () { 9 } # \$kr_extra_refs,
sub KR_SIZE () { 10 } # XXX UNUSED ???
sub KR_RUN () { 11 } # \$kr_run_warning
sub KR_ACTIVE_EVENT () { 12 } # \$kr_active_event
sub KR_PIDS () { 13 } # \%kr_pids_to_events
sub KR_ACTIVE_EVENT_TYPE () { 14 } # \$kr_active_event_type
# ]
# This flag indicates that POE::Kernel's run() method was called.
# It's used to warn about forgetting $poe_kernel->run().
sub KR_RUN_CALLED () { 0x01 } # $kernel->run() called
sub KR_RUN_SESSION () { 0x02 } # sessions created
sub KR_RUN_DONE () { 0x04 } # run returned
my $kr_run_warning = 0;
#------------------------------------------------------------------------------
# Events themselves.
sub EV_SESSION () { 0 } # [ $destination_session,
sub EV_SOURCE () { 1 } # $sender_session,
sub EV_NAME () { 2 } # $event_name,
sub EV_TYPE () { 3 } # $event_type,
sub EV_ARGS () { 4 } # \@event_parameters_arg0_etc,
#
# (These fields go towards the end
# because they are optional in some
# cases. TODO: Is this still true?)
#
sub EV_OWNER_FILE () { 5 } # $caller_filename_where_enqueued,
sub EV_OWNER_LINE () { 6 } # $caller_line_where_enqueued,
sub EV_TIME () { 7 } # Maintained by POE::Queue (create time)
sub EV_SEQ () { 8 } # Maintained by POE::Queue (unique event ID)
# ]
# These are the names of POE's internal events. They're in constants
# so we don't mistype them again.
sub EN_CHILD () { '_child' }
sub EN_GC () { '_garbage_collect' }
sub EN_PARENT () { '_parent' }
sub EN_SCPOLL () { '_sigchld_poll' }
sub EN_SIGNAL () { '_signal' }
sub EN_START () { '_start' }
sub EN_STOP () { '_stop' }
# These are POE's event classes (types). They often shadow the event
# names themselves, but they can encompass a large group of events.
# For example, ET_ALARM describes anything enqueued as by an alarm
# call. Types are preferred over names because bitmask tests are
# faster than string equality tests.
sub ET_POST () { 0x0001 } # User events (posted, yielded).
sub ET_CALL () { 0x0002 } # User events that weren't enqueued.
sub ET_START () { 0x0004 } # _start
sub ET_STOP () { 0x0008 } # _stop
sub ET_SIGNAL () { 0x0010 } # _signal
sub ET_GC () { 0x0020 } # _garbage_collect
sub ET_PARENT () { 0x0040 } # _parent
sub ET_CHILD () { 0x0080 } # _child
sub ET_SCPOLL () { 0x0100 } # _sigchild_poll
sub ET_ALARM () { 0x0200 } # Alarm events.
sub ET_SELECT () { 0x0400 } # File activity events.
sub ET_SIGCLD () { 0x0800 } # sig_child() events.
# A mask for all events generated by/for users.
sub ET_MASK_USER () { ~(ET_GC | ET_SCPOLL) }
# A mask for all events that are delayed by a dispatch time.
sub ET_MASK_DELAYED () { ET_ALARM | ET_SCPOLL }
# Temporary signal subtypes, used during signal dispatch semantics
# deprecation and reformation.
sub ET_SIGNAL_RECURSIVE () { 0x2000 } # Explicitly requested signal.
# A hash of reserved names. It's used to test whether someone is
# trying to use an internal event directly.
my %poes_own_events = (
+EN_CHILD => 1,
+EN_GC => 1,
+EN_PARENT => 1,
+EN_SCPOLL => 1,
+EN_SIGNAL => 1,
+EN_START => 1,
+EN_STOP => 1,
+EN_STAT => 1,
);
# These are ways a child may come or go.
# TODO - It would be useful to split 'lose' into two types. One to
# indicate that the child has stopped, and one to indicate that it was
# given away.
sub CHILD_GAIN () { 'gain' } # The session was inherited from another.
sub CHILD_LOSE () { 'lose' } # The session is no longer this one's child.
sub CHILD_CREATE () { 'create' } # The session was created as a child of this.
# Argument offsets for different types of internally generated events.
# TODO Exporting (EXPORT_OK) these would let people stop depending on
# positions for them.
sub EA_SEL_HANDLE () { 0 }
sub EA_SEL_MODE () { 1 }
sub EA_SEL_ARGS () { 2 }
#------------------------------------------------------------------------------
# Debugging and configuration constants.
# Shorthand for defining a trace constant.
sub _define_trace {
no strict 'refs';
foreach my $name (@_) {
next if defined *{"TRACE_$name"}{CODE};
my $trace_value = &TRACE_DEFAULT;
my $trace_name = "TRACE_$name";
*$trace_name = sub () { $trace_value };
}
}
# Debugging flags for subsystems. They're done as double evals here
# so that someone may define them before using POE::Kernel (or POE),
# and the pre-defined value will take precedence over the defaults
# here.
my $trace_file_handle;
BEGIN {
# Shorthand for defining an assert constant.
sub _define_assert {
no strict 'refs';
foreach my $name (@_) {
next if defined *{"ASSERT_$name"}{CODE};
my $assert_value = &ASSERT_DEFAULT;
my $assert_name = "ASSERT_$name";
*$assert_name = sub () { $assert_value };
}
}
# Assimilate POE_TRACE_* and POE_ASSERT_* environment variables.
# Environment variables override everything else.
while (my ($var, $val) = each %ENV) {
next unless $var =~ /^POE_([A-Z_]+)$/;
my $const = $1;
next unless $const =~ /^(?:TRACE|ASSERT)_/ or do { no strict 'refs'; defined &$const };
# Copy so we don't hurt our environment.
my $value = $val;
$value =~ tr['"][]d;
$value = 0 + $value if $value =~ /^\s*-?\d+(?:\.\d+)?\s*$/;
no strict 'refs';
local $^W = 0;
local $SIG{__WARN__} = sub { }; # redefine
*$const = sub () { $value };
}
# TRACE_FILENAME is special.
{
no strict 'refs';
my $trace_filename = TRACE_FILENAME() if defined &TRACE_FILENAME;
if (defined $trace_filename) {
open $trace_file_handle, ">$trace_filename"
or die "can't open trace file `$trace_filename': $!";
CORE::select((CORE::select($trace_file_handle), $| = 1)[0]);
}
}
# TRACE_DEFAULT changes the default value for other TRACE_*
# constants. Since define_trace() uses TRACE_DEFAULT internally, it
# can't be used to define TRACE_DEFAULT itself.
defined &TRACE_DEFAULT or *TRACE_DEFAULT = sub () { 0 };
_define_trace qw(
EVENTS FILES PROFILE REFCNT RETVALS SESSIONS SIGNALS STATISTICS
);
# See the notes for TRACE_DEFAULT, except read ASSERT and assert
# where you see TRACE and trace.
defined &ASSERT_DEFAULT or *ASSERT_DEFAULT = sub () { 0 };
_define_assert qw(DATA EVENTS FILES RETVALS USAGE);
}
# An "idle" POE::Kernel may still have events enqueued. These events
# regulate polling for signals, profiling, and perhaps other aspects of
# POE::Kernel's internal workings.
#
# XXX - There must be a better mechanism.
#
my $idle_queue_size;
sub _idle_queue_grow { $idle_queue_size++; }
sub _idle_queue_shrink { $idle_queue_size--; }
sub _idle_queue_size { $idle_queue_size; }
sub _idle_queue_reset { $idle_queue_size = 0; }
#------------------------------------------------------------------------------
# Helpers to carp, croak, confess, cluck, warn and die with whatever
# trace file we're using today. _trap is reserved for internal
# errors.
sub _trap {
local $Carp::CarpLevel = $Carp::CarpLevel + 1;
local *STDERR = $trace_file_handle || *STDERR;
confess(
"=== ($$) ===\n",
"Please address any warnings or errors above this message, and try\n",
"again. If there are none, or those messages are from within POE,\n",
"then please mail them along with the following information\n",
"to bug-POE\@rt.cpan.org:\n---\n@_\n-----\n"
);
}
sub _croak {
local $Carp::CarpLevel = $Carp::CarpLevel + 1;
local *STDERR = $trace_file_handle || *STDERR;
croak "($$) ", @_;
}
sub _confess {
local $Carp::CarpLevel = $Carp::CarpLevel + 1;
local *STDERR = $trace_file_handle || *STDERR;
confess "($$) ", @_;
}
sub _cluck {
local $Carp::CarpLevel = $Carp::CarpLevel + 1;
local *STDERR = $trace_file_handle || *STDERR;
cluck "($$) ", @_;
}
sub _carp {
local $Carp::CarpLevel = $Carp::CarpLevel + 1;
local *STDERR = $trace_file_handle || *STDERR;
carp "($$) ", @_;
}
sub _warn {
my ($package, $file, $line) = caller();
my $message = join("", @_);
$message .= " at $file line $line\n" unless $message =~ /\n$/;
warn "=== $$ === $message";
}
sub _die {
my ($package, $file, $line) = caller();
my $message = join("", @_);
$message .= " at $file line $line\n" unless $message =~ /\n$/;
local *STDERR = $trace_file_handle || *STDERR;
die "($$) $message";
}
#------------------------------------------------------------------------------
# Adapt POE::Kernel's personality to whichever event loop is present.
sub _find_loop {
my ($mod) = @_;
foreach my $dir (@INC) {
return 1 if (-r "$dir/$mod");
}
return 0;
}
sub _load_loop {
my $loop = shift;
*poe_kernel_loop = sub { return "$loop" };
# Modules can die with "not really dying" if they've loaded
# something else. This exception prevents the rest of the
# originally used module from being parsed, so the module it's
# handed off to takes over.
eval "require $loop";
if ($@ and $@ !~ /not really dying/) {
die(
"*\n",
"* POE can't use $loop:\n",
"* $@\n",
"*\n",
);
}
}
sub _test_loop {
my $used_first = shift;
local $SIG{__DIE__} = "DEFAULT";
# First see if someone wants to load a POE::Loop or XS version
# explicitly.
if (defined $used_first) {
_load_loop($used_first);
return;
}
foreach my $file (keys %INC) {
next if (substr ($file, -3) ne '.pm');
my @split_dirs = File::Spec->splitdir($file);
# Create a module name by replacing the path separators with
# underscores and removing ".pm"
my $module = join("_", @split_dirs);
substr($module, -3) = "";
# Skip the module name if it isn't legal.
next if $module =~ /[^\w\.]/;
# Try for the XS version first. If it fails, try the plain
# version. If that fails, we're up a creek.
$module = "POE/XS/Loop/$module.pm";
unless (_find_loop($module)) {
$module =~ s|XS/||;
next unless (_find_loop($module));
}
if (defined $used_first and $used_first ne $module) {
die(
"*\n",
"* POE can't use multiple event loops at once.\n",
"* You used $used_first and $module.\n",
"* Specify the loop you want as an argument to POE\n",
"* use POE qw(Loop::Select);\n",
"* or;\n",
"* use POE::Kernel { loop => 'Select' };\n",
"*\n",
);
}
$used_first = $module;
}
# No loop found. Default to our internal select() loop.
unless (defined $used_first) {
$used_first = "POE/XS/Loop/Select.pm";
unless (_find_loop($used_first)) {
$used_first =~ s/XS\///;
}
}
substr($used_first, -3) = "";
$used_first =~ s|/|::|g;
_load_loop($used_first);
}
#------------------------------------------------------------------------------
# Include resource modules here. Later, when we have the option of XS
# versions, we'll adapt this to include them if they're available.
use POE::Resources;
###############################################################################
# Helpers.
### Resolve $whatever into a session reference, trying every method we
### can until something succeeds.
sub _resolve_session {
my ($self, $whatever) = @_;
my $session;
# Resolve against sessions.
$session = $self->_data_ses_resolve($whatever);
return $session if defined $session;
# Resolve against IDs.
$session = $self->_data_sid_resolve($whatever);
return $session if defined $session;
# Resolve against aliases.
$session = $self->_data_alias_resolve($whatever);
return $session if defined $session;
# Resolve against the Kernel itself. Use "eq" instead of "==" here
# because $whatever is often a string.
return $whatever if $whatever eq $self;
# We don't know what it is.
return undef;
}
### Test whether POE has become idle.
sub _test_if_kernel_is_idle {
my $self = shift;
if (TRACE_REFCNT) {
_warn(
"<rc> ,----- Kernel Activity -----\n",
"<rc> | Events : ", $kr_queue->get_item_count(),
" (vs. idle size = ", $idle_queue_size, ")\n",
"<rc> | Files : ", $self->_data_handle_count(), "\n",
"<rc> | Extra : ", $self->_data_extref_count(), "\n",
"<rc> | Procs : ", $self->_data_sig_child_procs(), "\n",
"<rc> | Sess : ", $self->_data_ses_count(), "\n",
"<rc> `---------------------------\n",
"<rc> ..."
);
}
if( ASSERT_DATA ) {
if( $kr_pid != $$ ) {
_trap(
"New process detected. " .
"You must call ->has_forked() in the child process."
);
}
}
# Not yet idle, or SO idle that there's nothing to receive the
# event. Try to order these from most to least likely to be true so
# that the tests short-circuit quickly.
return if (
$kr_queue->get_item_count() > $idle_queue_size or
$self->_data_handle_count() or
$self->_data_extref_count() or
$self->_data_sig_child_procs() or
!$self->_data_ses_count()
);
$self->_data_ev_enqueue(
$self, $self, EN_SIGNAL, ET_SIGNAL, [ 'IDLE' ],
__FILE__, __LINE__, undef, time(),
);
}
### Explain why a session could not be resolved.
sub _explain_resolve_failure {
my ($self, $whatever, $nonfatal) = @_;
local $Carp::CarpLevel = 2;
if (ASSERT_DATA and !$nonfatal) {
_trap "<dt> Cannot resolve ``$whatever'' into a session reference";
}
$! = ESRCH;
TRACE_RETVALS and _carp "<rv> session not resolved: $!";
ASSERT_RETVALS and _carp "<rv> session not resolved: $!";
}
### Explain why a function is returning unsuccessfully.
sub _explain_return {
my ($self, $message) = @_;
local $Carp::CarpLevel = 2;
ASSERT_RETVALS and _confess "<rv> $message";
TRACE_RETVALS and _carp "<rv> $message";
}
### Explain how the user made a mistake calling a function.
sub _explain_usage {
my ($self, $message) = @_;
local $Carp::CarpLevel = 2;
ASSERT_USAGE and _confess "<us> $message";
ASSERT_RETVALS and _confess "<rv> $message";
TRACE_RETVALS and _carp "<rv> $message";
}
#==============================================================================
# SIGNALS
#==============================================================================
#------------------------------------------------------------------------------
# Register or remove signals.
# Public interface for adding or removing signal handlers.
sub sig {
my ($self, $signal, $event_name, @args) = ($poe_kernel, @_[1..$#_]);
if (ASSERT_USAGE) {
_confess "<us> must call sig() from a running session"
if $kr_active_session == $self;
_confess "<us> undefined signal in sig()" unless defined $signal;
_carp(
"<us> The '$event_name' event is one of POE's own. Its " .
"effect cannot be achieved assigning it to a signal"
) if defined($event_name) and exists($poes_own_events{$event_name});
};
if (defined $event_name) {
$self->_data_sig_add($kr_active_session, $signal, $event_name, \@args);
}
else {
$self->_data_sig_remove($kr_active_session->ID, $signal);
}
}
# Public interface for posting signal events.
# TODO - Like post(), signal() should return
sub signal {
my ($self, $dest_session, $signal, @etc) = ($poe_kernel, @_[1..$#_]);
if (ASSERT_USAGE) {
_confess "<us> undefined destination in signal()"
unless defined $dest_session;
_confess "<us> undefined signal in signal()" unless defined $signal;
};
my $session = $self->_resolve_session($dest_session);
unless (defined $session) {
$self->_explain_resolve_failure($dest_session);
return;
}
$self->_data_ev_enqueue(
$session, $kr_active_session,
EN_SIGNAL, ET_SIGNAL, [ $signal, @etc ],
(caller)[1,2], $kr_active_event, time(),
);
return 1;
}
# Public interface for flagging signals as handled. This will replace
# the handlers' return values as an implicit flag. Returns undef so
# it may be used as the last function in an event handler.
sub sig_handled {
my $self = $poe_kernel;
$self->_data_sig_handled();
if ($kr_active_event eq EN_SIGNAL) {
_die(
",----- DEPRECATION ERROR -----\n",
"| ", $self->_data_alias_loggable($kr_active_session->ID), ":\n",
"| handled a _signal event. You must register a handler with sig().\n",
"`-----------------------------\n",
);
}
}
# Attach a window or widget's destroy/closure to the UIDESTROY signal.
sub signal_ui_destroy {
my ($self, $window) = @_;
$self->loop_attach_uidestroy($window);
}
# Handle child PIDs being reaped. Added 2006-09-15.
sub sig_child {
my ($self, $pid, $event_name, @args) = ($poe_kernel, @_[1..$#_]);
if (ASSERT_USAGE) {
_confess "<us> must call sig_chld() from a running session"
if $kr_active_session == $self;
_confess "<us> undefined process ID in sig_chld()" unless defined $pid;
_carp(
"<us> The '$event_name' event is one of POE's own. Its " .
"effect cannot be achieved assigning it to a signal"
) if defined($event_name) and exists($poes_own_events{$event_name});
};
if (defined $event_name) {
$self->_data_sig_pid_watch($kr_active_session, $pid, $event_name, \@args);
}
elsif ($self->_data_sig_pids_is_ses_watching($kr_active_session->ID, $pid)) {
$self->_data_sig_pid_ignore($kr_active_session->ID, $pid);
}
}
#==============================================================================
# KERNEL
#==============================================================================
sub new {
my $type = shift;
# Prevent multiple instances, no matter how many times it's called.
# This is a backward-compatibility enhancement for programs that
# have used versions prior to 0.06. It also provides a convenient
# single entry point into the entirety of POE's state: point a
# Dumper module at it, and you'll see a hideous tree of knowledge.
# Be careful, though. Its apples bite back.
unless (defined $poe_kernel) {
# Create our master queue.
$kr_queue = $queue_class->new();
# Remember the PID
$kr_pid = $$;
# TODO - Should KR_ACTIVE_SESSIONS and KR_ACTIVE_EVENT be handled
# by POE::Resource::Sessions?
# TODO - Should the subsystems be split off into separate real
# objects, such as KR_QUEUE is?
my $self = $poe_kernel = bless [
undef, # KR_SESSIONS - from POE::Resource::Sessions
undef, # KR_FILENOS - from POE::Resource::FileHandles
undef, # KR_SIGNALS - from POE::Resource::Signals
undef, # KR_ALIASES - from POE::Resource::Aliases
\$kr_active_session, # KR_ACTIVE_SESSION
$kr_queue, # KR_QUEUE - reference to an object
undef, # KR_ID
undef, # KR_SESSION_IDS - from POE::Resource::SIDS
undef, # KR_SID_SEQ - from POE::Resource::SIDS
undef, # KR_EXTRA_REFS
undef, # KR_SIZE
\$kr_run_warning, # KR_RUN
\$kr_active_event, # KR_ACTIVE_EVENT
undef, # KR_PIDS
\$kr_active_event_type, # KR_ACTIVE_EVENT_TYPE
], $type;
POE::Resources->load();
$self->_recalc_id();
$self->_data_sid_set($self->[KR_ID], $self);
# Initialize subsystems. The order is important.
# We need events before sessions, and the kernel's session before
# it can start polling for signals.
$self->_data_ev_initialize($kr_queue);
$self->_initialize_kernel_session();
$self->_data_sig_initialize();
$self->_data_alias_initialize();
# These other subsystems don't have strange interactions.
$self->_data_handle_initialize($kr_queue);
_idle_queue_reset();
}
# Return the global instance.
$poe_kernel;
}
sub CLONE {
_data_ses_clone();
}
#------------------------------------------------------------------------------
# Send an event to a session right now. Used by _disp_select to
# expedite select() events, and used by run() to deliver posted events
# from the queue.
# Dispatch an event to its session. A lot of work goes on here.
sub _dispatch_event {
my (
$self,
$session, $source_session, $event, $type, $etc,
$file, $line, $fromstate, $time, $seq
) = @_;
if (ASSERT_EVENTS) {
_confess "<ev> undefined dest session" unless defined $session;
_confess "<ev> undefined source session" unless defined $source_session;
};
if (TRACE_EVENTS) {
my $log_session = $session;
$log_session = $self->_data_alias_loggable($session->ID) unless (
$type & ET_START
);
my $string_etc = join(" ", map { defined() ? $_ : "(undef)" } @$etc);
_warn(
"<ev> Dispatching event $seq ``$event'' ($string_etc) from ",
$self->_data_alias_loggable($source_session->ID), " to $log_session"
);
}
### Pre-dispatch processing.
# Some sessions don't do anything in _start and expect their
# creators to provide a start-up event. This means we can't
# &_collect_garbage at _start time. Instead, an ET_GC event is
# posted as part of session allocation. Simply dispatching it
# will trigger a GC sweep.
return 0 if $type & ET_GC;
# Preprocess signals. This is where _signal is translated into
# its registered handler's event name, if there is one.
if ($type & ET_SIGNAL) {
my $signal = $etc->[0];
if (TRACE_SIGNALS) {
_warn(
"<sg> dispatching ET_SIGNAL ($signal) to ",
$self->_data_alias_loggable($session->ID)
);
}
# Step 1a: Reset the handled-signal flags.
local @POE::Kernel::kr_signaled_sessions;
local $POE::Kernel::kr_signal_total_handled;
local $POE::Kernel::kr_signal_type;
$self->_data_sig_reset_handled($signal);
# Step 1b: Collect a list of sessions to receive the signal.
my @touched_sessions = ($session);
my $touched_index = 0;
while ($touched_index < @touched_sessions) {
my $next_target = $touched_sessions[$touched_index]->ID;
push @touched_sessions, $self->_data_ses_get_children($next_target);
$touched_index++;
}
# Step 1c: The DIE signal propagates up through parents, too.
if ($signal eq "DIE") {
my $next_target = $self->_data_ses_get_parent($session->ID);
while (defined($next_target) and $next_target != $self) {
unshift @touched_sessions, $next_target;
$next_target = $self->_data_ses_get_parent($next_target->ID);
}
}
# Step 2: Propagate the signal to the explicit watchers in the
# child tree. Ensure the full tree is touched regardless
# whether there are explicit watchers.
if ($self->_data_sig_explicitly_watched($signal)) {
my %signal_watchers = $self->_data_sig_watchers($signal);
$touched_index = @touched_sessions;
while ($touched_index--) {
my $target_session = $touched_sessions[$touched_index];
$self->_data_sig_touched_session($target_session);
my $target_sid = $target_session->ID;
next unless exists $signal_watchers{$target_sid};
my ($target_event, $target_etc) = @{$signal_watchers{$target_sid}};
if (TRACE_SIGNALS) {
_warn(
"<sg> propagating explicit signal $target_event ($signal) ",
"(@$target_etc) to ", $self->_data_alias_loggable($target_sid)
);
}
# ET_SIGNAL_RECURSIVE is used here to avoid repropagating
# the signal ad nauseam.
$self->_dispatch_event(
$target_session, $self,
$target_event, ET_SIGNAL_RECURSIVE, [ @$etc, @$target_etc ],
$file, $line, $fromstate, time(), -__LINE__
);
}
}
else {
$touched_index = @touched_sessions;
while ($touched_index--) {
$self->_data_sig_touched_session($touched_sessions[$touched_index]);
}
}
# Step 3: Check to see if the signal was handled.
$self->_data_sig_free_terminated_sessions();
# If the signal was SIGDIE, then propagate the exception.
my $handled_session_count = (_data_sig_handled_status())[0];
if ($signal eq "DIE" and !$handled_session_count) {
$kr_exception = $etc->[1]{error_str};
}
# Signal completely dispatched. Thanks for flying!
return;
}
if (TRACE_EVENTS) {
_warn(
"<ev> dispatching event $seq ``$event'' to ",
$self->_data_alias_loggable($session->ID)
);
if ($event eq EN_SIGNAL) {
_warn("<ev> signal($etc->[0])");
}
}
# Prepare to call the appropriate handler. Push the current active
# session on Perl's call stack.
my ($hold_active_session, $hold_active_event, $hold_active_event_type) = (