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.26 by root, Sun Aug 14 01:38:14 2011 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
17 17of C<$_>, which indicates a programming bug inside the watcher callback.
18B<< Currently, only AnyEvent I<methods> are checked, the AE:: I<functions> are not
19affected. >>
20 18
21Normally, you don't load this module yourself but instead use it 19Normally, you don't load this module yourself but instead use it
22indirectly via the C<PERL_ANYEVENT_STRICT> environment variable (see 20indirectly via the C<PERL_ANYEVENT_STRICT> environment variable (see
23L<AnyEvent>). However, this module can be loaded manually at any time. 21L<AnyEvent>). However, this module can be loaded manually at any time.
24 22
25=cut 23=cut
26 24
27package AnyEvent::Strict; 25package AnyEvent::Strict;
28 26
29use Carp qw(croak); 27use Carp qw(croak);
28use Errno ();
29use POSIX ();
30 30
31use AnyEvent (); BEGIN { AnyEvent::common_sense } 31use AnyEvent (); BEGIN { AnyEvent::common_sense }
32 32
33AnyEvent::_isa_hook 0 => "AnyEvent::Strict", 1; 33AnyEvent::_isa_hook 1 => "AnyEvent::Strict", 1;
34
35BEGIN {
36 if (defined &Internals::SvREADONLY) {
37 # readonly available (at least 5.8.9+, working better in 5.10.1+)
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";
89};
34 90
35sub io { 91sub io {
36 my $class = shift; 92 my $class = shift;
37 my %arg = @_; 93 my (%arg, $fh, $cb, $fd) = @_;
38 94
39 ref $arg{cb} 95 ref $arg{cb}
40 or croak "AnyEvent->io called with illegal cb argument '$arg{cb}'"; 96 or croak "AnyEvent->io called with illegal cb argument '$arg{cb}'";
41 delete $arg{cb}; 97 $cb = wrap delete $arg{cb};
42 98
43 $arg{poll} =~ /^[rw]$/ 99 $arg{poll} =~ /^[rw]$/
44 or croak "AnyEvent->io called with illegal poll argument '$arg{poll}'"; 100 or croak "AnyEvent->io called with illegal poll argument '$arg{poll}'";
45 101
102 $fh = delete $arg{fh};
103
46 if ($arg{fh} =~ /^\s*\d+\s*$/) { 104 if ($fh =~ /^\s*\d+\s*$/) {
105 $fd = $fh;
47 $arg{fh} = AnyEvent::_dupfh $arg{poll}, $arg{fh}; 106 $fh = AnyEvent::_dupfh $arg{poll}, $fh;
48 } else { 107 } else {
49 defined eval { fileno $arg{fh} } 108 defined eval { $fd = fileno $fh }
50 or croak "AnyEvent->io called with illegal fh argument '$arg{fh}'"; 109 or croak "AnyEvent->io called with illegal fh argument '$fh'";
51 } 110 }
52 111
53 -f $arg{fh} 112 -f $fh
54 and croak "AnyEvent->io called with fh argument pointing to a file"; 113 and croak "AnyEvent->io called with fh argument pointing to a file";
55 114
56 delete $arg{poll}; 115 delete $arg{poll};
57 delete $arg{fh};
58 116
59 croak "AnyEvent->io called with unsupported parameter(s) " . join ", ", keys %arg 117 croak "AnyEvent->io called with unsupported parameter(s) " . join ", ", keys %arg
60 if keys %arg; 118 if keys %arg;
61 119
120 ++$FD_INUSE[$fd];
121
122 bless [
123 $fd,
62 $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]];
63} 130}
64 131
65sub timer { 132sub timer {
66 my $class = shift; 133 my $class = shift;
67 my %arg = @_; 134 my %arg = @_;
68 135
69 ref $arg{cb} 136 ref $arg{cb}
70 or croak "AnyEvent->timer called with illegal cb argument '$arg{cb}'"; 137 or croak "AnyEvent->timer called with illegal cb argument '$arg{cb}'";
71 delete $arg{cb}; 138 my $cb = wrap delete $arg{cb};
72 139
73 exists $arg{after} 140 exists $arg{after}
74 or croak "AnyEvent->timer called without mandatory 'after' parameter"; 141 or croak "AnyEvent->timer called without mandatory 'after' parameter";
75 delete $arg{after}; 142 delete $arg{after};
76 143
… …
79 delete $arg{interval}; 146 delete $arg{interval};
80 147
81 croak "AnyEvent->timer called with unsupported parameter(s) " . join ", ", keys %arg 148 croak "AnyEvent->timer called with unsupported parameter(s) " . join ", ", keys %arg
82 if keys %arg; 149 if keys %arg;
83 150
84 $class->SUPER::timer (@_) 151 $class->SUPER::timer (@_, cb => $cb)
85} 152}
86 153
87sub signal { 154sub signal {
88 my $class = shift; 155 my $class = shift;
89 my %arg = @_; 156 my %arg = @_;
90 157
91 ref $arg{cb} 158 ref $arg{cb}
92 or croak "AnyEvent->signal called with illegal cb argument '$arg{cb}'"; 159 or croak "AnyEvent->signal called with illegal cb argument '$arg{cb}'";
93 delete $arg{cb}; 160 my $cb = wrap delete $arg{cb};
94 161
95 defined AnyEvent::Base::sig2num $arg{signal} and $arg{signal} == 0 162 defined AnyEvent::Base::sig2num $arg{signal} and $arg{signal} == 0
96 or croak "AnyEvent->signal called with illegal signal name '$arg{signal}'"; 163 or croak "AnyEvent->signal called with illegal signal name '$arg{signal}'";
97 delete $arg{signal}; 164 delete $arg{signal};
98 165
99 croak "AnyEvent->signal called with unsupported parameter(s) " . join ", ", keys %arg 166 croak "AnyEvent->signal called with unsupported parameter(s) " . join ", ", keys %arg
100 if keys %arg; 167 if keys %arg;
101 168
102 $class->SUPER::signal (@_) 169 $class->SUPER::signal (@_, cb => $cb)
103} 170}
104 171
105sub child { 172sub child {
106 my $class = shift; 173 my $class = shift;
107 my %arg = @_; 174 my %arg = @_;
108 175
109 ref $arg{cb} 176 ref $arg{cb}
110 or croak "AnyEvent->child called with illegal cb argument '$arg{cb}'"; 177 or croak "AnyEvent->child called with illegal cb argument '$arg{cb}'";
111 delete $arg{cb}; 178 my $cb = wrap delete $arg{cb};
112 179
113 $arg{pid} =~ /^-?\d+$/ 180 $arg{pid} =~ /^-?\d+$/
114 or croak "AnyEvent->child called with malformed pid value '$arg{pid}'"; 181 or croak "AnyEvent->child called with malformed pid value '$arg{pid}'";
115 delete $arg{pid}; 182 delete $arg{pid};
116 183
117 croak "AnyEvent->child called with unsupported parameter(s) " . join ", ", keys %arg 184 croak "AnyEvent->child called with unsupported parameter(s) " . join ", ", keys %arg
118 if keys %arg; 185 if keys %arg;
119 186
120 $class->SUPER::child (@_) 187 $class->SUPER::child (@_, cb => $cb)
121} 188}
122 189
123sub idle { 190sub idle {
124 my $class = shift; 191 my $class = shift;
125 my %arg = @_; 192 my %arg = @_;
126 193
127 ref $arg{cb} 194 ref $arg{cb}
128 or croak "AnyEvent->idle called with illegal cb argument '$arg{cb}'"; 195 or croak "AnyEvent->idle called with illegal cb argument '$arg{cb}'";
129 delete $arg{cb}; 196 my $cb = wrap delete $arg{cb};
130 197
131 croak "AnyEvent->idle called with unsupported parameter(s) " . join ", ", keys %arg 198 croak "AnyEvent->idle called with unsupported parameter(s) " . join ", ", keys %arg
132 if keys %arg; 199 if keys %arg;
133 200
134 $class->SUPER::idle (@_) 201 $class->SUPER::idle (@_, cb => $cb)
135} 202}
136 203
137sub condvar { 204sub condvar {
138 my $class = shift; 205 my $class = shift;
139 my %arg = @_; 206 my %arg = @_;
140 207
141 !exists $arg{cb} or ref $arg{cb} 208 !exists $arg{cb} or ref $arg{cb}
142 or croak "AnyEvent->condvar called with illegal cb argument '$arg{cb}'"; 209 or croak "AnyEvent->condvar called with illegal cb argument '$arg{cb}'";
143 delete $arg{cb}; 210 my @cb = exists $arg{cb} ? (cb => wrap delete $arg{cb}) : ();
144 211
145 croak "AnyEvent->condvar called with unsupported parameter(s) " . join ", ", keys %arg 212 croak "AnyEvent->condvar called with unsupported parameter(s) " . join ", ", keys %arg
146 if keys %arg; 213 if keys %arg;
147 214
148 $class->SUPER::condvar (@_) 215 $class->SUPER::condvar (@cb);
149} 216}
150 217
151sub time { 218sub time {
152 my $class = shift; 219 my $class = shift;
153 220

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines