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

Diff Legend

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