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.17 by root, Fri Jul 17 23:12:20 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);
27use Fcntl (); 28use Errno ();
29use POSIX ();
28 30
29use AnyEvent (); BEGIN { AnyEvent::common_sense } 31use AnyEvent (); BEGIN { AnyEvent::common_sense }
30use AnyEvent::Util ();
31 32
32our @ISA; 33AnyEvent::_isa_hook 1 => "AnyEvent::Strict", 1;
33 34
34AnyEvent::post_detect { 35BEGIN {
35 # assume the first ISA member is the implementation 36 if (defined &Internals::SvREADONLY) {
36 # # and link us in before it in the chain. 37 # readonly available (at least 5.8.9+, working better in 5.10.1+)
37 my $MODEL = shift @AnyEvent::ISA; 38 *wrap = sub {
38 unshift @ISA, $MODEL; 39 my $cb = shift;
39 unshift @AnyEvent::ISA, AnyEvent::Strict:: 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";
40}; 89};
41 90
42sub io { 91sub io {
43 my $class = shift; 92 my $class = shift;
44 my %arg = @_; 93 my (%arg, $fh, $cb, $fd) = @_;
45 94
46 ref $arg{cb} 95 ref $arg{cb}
47 or croak "AnyEvent->io called with illegal cb argument '$arg{cb}'"; 96 or croak "AnyEvent->io called with illegal cb argument '$arg{cb}'";
48 delete $arg{cb}; 97 $cb = wrap delete $arg{cb};
49 98
50 $arg{poll} =~ /^[rw]$/ 99 $arg{poll} =~ /^[rw]$/
51 or croak "AnyEvent->io called with illegal poll argument '$arg{poll}'"; 100 or croak "AnyEvent->io called with illegal poll argument '$arg{poll}'";
52 101
53 if (defined fileno $arg{fh} or ref $arg{fh} or $arg{fh} !~ /^\s*\d+\s*$/) { 102 $fh = delete $arg{fh};
54 defined fileno $arg{fh} 103
55 or croak "AnyEvent->io called with illegal fh argument '$arg{fh}'"; 104 if ($fh =~ /^\s*\d+\s*$/) {
105 $fd = $fh;
106 $fh = AnyEvent::_dupfh $arg{poll}, $fh;
56 } else { 107 } else {
57 $arg{fh} = AnyEvent::_dupfh $arg{poll}, $arg{fh}; 108 defined eval { $fd = fileno $fh }
109 or croak "AnyEvent->io called with illegal fh argument '$fh'";
58 } 110 }
59 111
60 -f $arg{fh} 112 -f $fh
61 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";
62 114
63 delete $arg{poll}; 115 delete $arg{poll};
64 delete $arg{fh};
65 116
66 croak "AnyEvent->io called with unsupported parameter(s) " . join ", ", keys %arg 117 croak "AnyEvent->io called with unsupported parameter(s) " . join ", ", keys %arg
67 if keys %arg; 118 if keys %arg;
68 119
120 ++$FD_INUSE[$fd];
121
122 bless [
123 $fd,
69 $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]];
70} 130}
71 131
72sub timer { 132sub timer {
73 my $class = shift; 133 my $class = shift;
74 my %arg = @_; 134 my %arg = @_;
75 135
76 ref $arg{cb} 136 ref $arg{cb}
77 or croak "AnyEvent->timer called with illegal cb argument '$arg{cb}'"; 137 or croak "AnyEvent->timer called with illegal cb argument '$arg{cb}'";
78 delete $arg{cb}; 138 my $cb = wrap delete $arg{cb};
79 139
80 exists $arg{after} 140 exists $arg{after}
81 or croak "AnyEvent->timer called without mandatory 'after' parameter"; 141 or croak "AnyEvent->timer called without mandatory 'after' parameter";
82 delete $arg{after}; 142 delete $arg{after};
83 143
… …
86 delete $arg{interval}; 146 delete $arg{interval};
87 147
88 croak "AnyEvent->timer called with unsupported parameter(s) " . join ", ", keys %arg 148 croak "AnyEvent->timer called with unsupported parameter(s) " . join ", ", keys %arg
89 if keys %arg; 149 if keys %arg;
90 150
91 $class->SUPER::timer (@_) 151 $class->SUPER::timer (@_, cb => $cb)
92} 152}
93 153
94sub signal { 154sub signal {
95 my $class = shift; 155 my $class = shift;
96 my %arg = @_; 156 my %arg = @_;
97 157
98 ref $arg{cb} 158 ref $arg{cb}
99 or croak "AnyEvent->signal called with illegal cb argument '$arg{cb}'"; 159 or croak "AnyEvent->signal called with illegal cb argument '$arg{cb}'";
100 delete $arg{cb}; 160 my $cb = wrap delete $arg{cb};
101 161
102 defined AnyEvent::Util::sig2num $arg{signal} 162 defined AnyEvent::Base::sig2num $arg{signal} and $arg{signal} == 0
103 or croak "AnyEvent->signal called with illegal signal name '$arg{signal}'"; 163 or croak "AnyEvent->signal called with illegal signal name '$arg{signal}'";
104 delete $arg{signal}; 164 delete $arg{signal};
105 165
106 croak "AnyEvent->signal called with unsupported parameter(s) " . join ", ", keys %arg 166 croak "AnyEvent->signal called with unsupported parameter(s) " . join ", ", keys %arg
107 if keys %arg; 167 if keys %arg;
108 168
109 $class->SUPER::signal (@_) 169 $class->SUPER::signal (@_, cb => $cb)
110} 170}
111 171
112sub child { 172sub child {
113 my $class = shift; 173 my $class = shift;
114 my %arg = @_; 174 my %arg = @_;
115 175
116 ref $arg{cb} 176 ref $arg{cb}
117 or croak "AnyEvent->child called with illegal cb argument '$arg{cb}'"; 177 or croak "AnyEvent->child called with illegal cb argument '$arg{cb}'";
118 delete $arg{cb}; 178 my $cb = wrap delete $arg{cb};
119 179
120 $arg{pid} =~ /^-?\d+$/ 180 $arg{pid} =~ /^-?\d+$/
121 or croak "AnyEvent->child called with malformed pid value '$arg{pid}'"; 181 or croak "AnyEvent->child called with malformed pid value '$arg{pid}'";
122 delete $arg{pid}; 182 delete $arg{pid};
123 183
124 croak "AnyEvent->child called with unsupported parameter(s) " . join ", ", keys %arg 184 croak "AnyEvent->child called with unsupported parameter(s) " . join ", ", keys %arg
125 if keys %arg; 185 if keys %arg;
126 186
127 $class->SUPER::child (@_) 187 $class->SUPER::child (@_, cb => $cb)
128} 188}
129 189
130sub idle { 190sub idle {
131 my $class = shift; 191 my $class = shift;
132 my %arg = @_; 192 my %arg = @_;
133 193
134 ref $arg{cb} 194 ref $arg{cb}
135 or croak "AnyEvent->idle called with illegal cb argument '$arg{cb}'"; 195 or croak "AnyEvent->idle called with illegal cb argument '$arg{cb}'";
136 delete $arg{cb}; 196 my $cb = wrap delete $arg{cb};
137 197
138 croak "AnyEvent->idle called with unsupported parameter(s) " . join ", ", keys %arg 198 croak "AnyEvent->idle called with unsupported parameter(s) " . join ", ", keys %arg
139 if keys %arg; 199 if keys %arg;
140 200
141 $class->SUPER::idle (@_) 201 $class->SUPER::idle (@_, cb => $cb)
142} 202}
143 203
144sub condvar { 204sub condvar {
145 my $class = shift; 205 my $class = shift;
146 my %arg = @_; 206 my %arg = @_;
147 207
148 !exists $arg{cb} or ref $arg{cb} 208 !exists $arg{cb} or ref $arg{cb}
149 or croak "AnyEvent->condvar called with illegal cb argument '$arg{cb}'"; 209 or croak "AnyEvent->condvar called with illegal cb argument '$arg{cb}'";
150 delete $arg{cb}; 210 my @cb = exists $arg{cb} ? (cb => wrap delete $arg{cb}) : ();
151 211
152 croak "AnyEvent->condvar called with unsupported parameter(s) " . join ", ", keys %arg 212 croak "AnyEvent->condvar called with unsupported parameter(s) " . join ", ", keys %arg
153 if keys %arg; 213 if keys %arg;
154 214
155 $class->SUPER::condvar (@_) 215 $class->SUPER::condvar (@cb);
156} 216}
157 217
158sub time { 218sub time {
159 my $class = shift; 219 my $class = shift;
160 220

Diff Legend

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