ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/AnyEvent/lib/AnyEvent/Strict.pm
(Generate patch)

Comparing AnyEvent/lib/AnyEvent/Strict.pm (file contents):
Revision 1.9 by root, Fri Mar 27 10:49:50 2009 UTC vs.
Revision 1.35 by root, Fri Sep 2 04:35:03 2011 UTC

11 11
12This module implements AnyEvent's strict mode. 12This module implements AnyEvent's strict mode.
13 13
14Loading it makes AnyEvent check all arguments to AnyEvent-methods, at the 14Loading it makes AnyEvent check all arguments to AnyEvent-methods, at the
15expense of being slower (often the argument checking takes longer than the 15expense of being slower (often the argument checking takes longer than the
16actual function). 16actual function). It also wraps all callbacks to check for modifications
17of C<$_>, which indicates a programming bug inside the watcher callback.
17 18
18Normally, you don't load this module yourself but instead use it 19Normally, you don't load this module yourself but instead use it
19indirectly via the C<PERL_ANYEVENT_STRICT> environment variable (see 20indirectly via the C<PERL_ANYEVENT_STRICT> environment variable (see
20L<AnyEvent>). However, this module can be loaded at any time. 21L<AnyEvent>). However, this module can be loaded manually at any time.
21 22
22=cut 23=cut
23 24
24package AnyEvent::Strict; 25package AnyEvent::Strict;
25 26
26use Carp qw(croak); 27use Carp qw(croak);
28use Errno ();
29use POSIX ();
27 30
28use AnyEvent (); 31use AnyEvent (); BEGIN { AnyEvent::common_sense }
29 32
30AnyEvent::post_detect { 33AnyEvent::_isa_hook 1 => "AnyEvent::Strict", 1;
31 # assume the first ISA member is the implementation 34
32 # # and link us in before it in the chain. 35BEGIN {
33 my $MODEL = shift @AnyEvent::ISA; 36 if (defined &Internals::SvREADONLY) {
34 unshift @ISA, $MODEL; 37 # readonly available (at least 5.8.9+, working better in 5.10.1+)
35 unshift @AnyEvent::ISA, AnyEvent::Strict:: 38 *wrap = sub {
39 my $cb = shift;
40
41 sub {
42 Internals::SvREADONLY $_, 1;
43 &$cb;
44 Internals::SvREADONLY $_, 0;
45 }
46 };
47 } else {
48 # or not :/
49 my $magic = []; # a unique magic value
50
51 *wrap = sub {
52 my $cb = shift;
53
54 sub {
55 local $_ = $magic;
56
57 &$cb;
58
59 if (!ref $_ || $_ != $magic) {
60 require AnyEvent::Debug;
61 die "callback $cb (" . AnyEvent::Debug::cb2str ($cb) . ") modified \$_ without restoring it.\n";
62 }
63 }
64 };
65 }
66}
67
68our (@FD_INUSE, $FD_I);
69our $FD_CHECK_W = AE::timer 4, 4, sub {
70 my $cnt = (@FD_INUSE < 100 * 10 ? int @FD_INUSE * 0.1 : 100) || 10;
71
72 if ($FD_I <= 0) {
73 #pop @FD_INUSE while @FD_INUSE && !$FD_INUSE[-1];
74 ($FD_I = @FD_INUSE) >= 0
75 or return; # empty
76 }
77
78 $cnt = $FD_I if $cnt > $FD_I;
79
80 eval {
81 do {
82 !$FD_INUSE[--$FD_I]
83 or (POSIX::lseek $FD_I, 0, 1) != -1
84 or $! != Errno::EBADF
85 or die;
86 } while --$cnt;
87 1
88 } or AE::log crit => "file descriptor $FD_I registered with AnyEvent but prematurely closed, event loop might malfunction.\n";
36}; 89};
37 90
38sub io { 91sub io {
39 my $class = shift; 92 my $class = shift;
40 my %arg = @_; 93 my (%arg, $fh, $cb, $fd) = @_;
41 94
42 ref $arg{cb} 95 ref $arg{cb}
43 or croak "AnyEvent->io called with illegal cb argument '$arg{cb}'"; 96 or croak "AnyEvent->io called with illegal cb argument '$arg{cb}'";
44 delete $arg{cb}; 97 $cb = wrap delete $arg{cb};
45
46 defined fileno $arg{fh}
47 or croak "AnyEvent->io called with illegal fh argument '$arg{fh}'";
48 -f $arg{fh}
49 and croak "AnyEvent->io called with fh argument pointing to a file";
50 delete $arg{fh};
51 98
52 $arg{poll} =~ /^[rw]$/ 99 $arg{poll} =~ /^[rw]$/
53 or croak "AnyEvent->io called with illegal poll argument '$arg{poll}'"; 100 or croak "AnyEvent->io called with illegal poll argument '$arg{poll}'";
101
102 $fh = delete $arg{fh};
103
104 if ($fh =~ /^\s*\d+\s*$/) {
105 $fd = $fh;
106 $fh = AnyEvent::_dupfh $arg{poll}, $fh;
107 } else {
108 defined eval { $fd = fileno $fh }
109 or croak "AnyEvent->io called with illegal fh argument '$fh'";
110 }
111
112 -f $fh
113 and croak "AnyEvent->io called with fh argument pointing to a file";
114
54 delete $arg{poll}; 115 delete $arg{poll};
55 116
56 croak "AnyEvent->io called with unsupported parameter(s) " . join ", ", keys %arg 117 croak "AnyEvent->io called with unsupported parameter(s) " . join ", ", keys %arg
57 if keys %arg; 118 if keys %arg;
58 119
120 ++$FD_INUSE[$fd];
121
122 bless [
123 $fd,
59 $class->SUPER::io (@_) 124 $class->SUPER::io (@_, cb => $cb)
125 ], "AnyEvent::Strict::io";
126}
127
128sub AnyEvent::Strict::io::DESTROY {
129 --$FD_INUSE[$_[0][0]];
60} 130}
61 131
62sub timer { 132sub timer {
63 my $class = shift; 133 my $class = shift;
64 my %arg = @_; 134 my %arg = @_;
65 135
66 ref $arg{cb} 136 ref $arg{cb}
67 or croak "AnyEvent->timer called with illegal cb argument '$arg{cb}'"; 137 or croak "AnyEvent->timer called with illegal cb argument '$arg{cb}'";
68 delete $arg{cb}; 138 my $cb = wrap delete $arg{cb};
69 139
70 exists $arg{after} 140 exists $arg{after}
71 or croak "AnyEvent->timer called without mandatory 'after' parameter"; 141 or croak "AnyEvent->timer called without mandatory 'after' parameter";
72 delete $arg{after}; 142 delete $arg{after};
73 143
76 delete $arg{interval}; 146 delete $arg{interval};
77 147
78 croak "AnyEvent->timer called with unsupported parameter(s) " . join ", ", keys %arg 148 croak "AnyEvent->timer called with unsupported parameter(s) " . join ", ", keys %arg
79 if keys %arg; 149 if keys %arg;
80 150
81 $class->SUPER::timer (@_) 151 $class->SUPER::timer (@_, cb => $cb)
82} 152}
83 153
84sub signal { 154sub signal {
85 my $class = shift; 155 my $class = shift;
86 my %arg = @_; 156 my %arg = @_;
87 157
88 ref $arg{cb} 158 ref $arg{cb}
89 or croak "AnyEvent->signal called with illegal cb argument '$arg{cb}'"; 159 or croak "AnyEvent->signal called with illegal cb argument '$arg{cb}'";
90 delete $arg{cb}; 160 my $cb = wrap delete $arg{cb};
91 161
92 eval "require POSIX; 0 < &POSIX::SIG$arg{signal}" 162 defined AnyEvent::Base::sig2num $arg{signal} and $arg{signal} == 0
93 or croak "AnyEvent->signal called with illegal signal name '$arg{signal}'"; 163 or croak "AnyEvent->signal called with illegal signal name '$arg{signal}'";
94 delete $arg{signal}; 164 delete $arg{signal};
95 165
96 croak "AnyEvent->signal called with unsupported parameter(s) " . join ", ", keys %arg 166 croak "AnyEvent->signal called with unsupported parameter(s) " . join ", ", keys %arg
97 if keys %arg; 167 if keys %arg;
98 168
99 $class->SUPER::signal (@_) 169 $class->SUPER::signal (@_, cb => $cb)
100} 170}
101 171
102sub child { 172sub child {
103 my $class = shift; 173 my $class = shift;
104 my %arg = @_; 174 my %arg = @_;
105 175
106 ref $arg{cb} 176 ref $arg{cb}
107 or croak "AnyEvent->signal called with illegal cb argument '$arg{cb}'"; 177 or croak "AnyEvent->child called with illegal cb argument '$arg{cb}'";
108 delete $arg{cb}; 178 my $cb = wrap delete $arg{cb};
109 179
110 $arg{pid} =~ /^-?\d+$/ 180 $arg{pid} =~ /^-?\d+$/
111 or croak "AnyEvent->signal called with illegal pid value '$arg{pid}'"; 181 or croak "AnyEvent->child called with malformed pid value '$arg{pid}'";
112 delete $arg{pid}; 182 delete $arg{pid};
113 183
184 croak "AnyEvent->child called with unsupported parameter(s) " . join ", ", keys %arg
185 if keys %arg;
186
187 $class->SUPER::child (@_, cb => $cb)
188}
189
190sub idle {
191 my $class = shift;
192 my %arg = @_;
193
194 ref $arg{cb}
195 or croak "AnyEvent->idle called with illegal cb argument '$arg{cb}'";
196 my $cb = wrap delete $arg{cb};
197
114 croak "AnyEvent->signal called with unsupported parameter(s) " . join ", ", keys %arg 198 croak "AnyEvent->idle called with unsupported parameter(s) " . join ", ", keys %arg
115 if keys %arg; 199 if keys %arg;
116 200
117 $class->SUPER::child (@_) 201 $class->SUPER::idle (@_, cb => $cb)
118} 202}
119 203
120sub condvar { 204sub condvar {
121 my $class = shift; 205 my $class = shift;
122 my %arg = @_; 206 my %arg = @_;
123 207
124 !exists $arg{cb} or ref $arg{cb} 208 !exists $arg{cb} or ref $arg{cb}
125 or croak "AnyEvent->condvar called with illegal cb argument '$arg{cb}'"; 209 or croak "AnyEvent->condvar called with illegal cb argument '$arg{cb}'";
126 delete $arg{cb}; 210 my @cb = exists $arg{cb} ? (cb => wrap delete $arg{cb}) : ();
127 211
128 croak "AnyEvent->condvar called with unsupported parameter(s) " . join ", ", keys %arg 212 croak "AnyEvent->condvar called with unsupported parameter(s) " . join ", ", keys %arg
129 if keys %arg; 213 if keys %arg;
130 214
131 $class->SUPER::condvar (@_) 215 $class->SUPER::condvar (@cb);
132} 216}
133 217
134sub time { 218sub time {
135 my $class = shift; 219 my $class = shift;
136 220

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines