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

Diff Legend

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