Watchdog.pm

filter: Statementstmt 14.2% 9 / 63 Branchbran 7.1% 3 / 42 Conditioncond 0.0% 0 / 8 MC/DCmcdc 0.0% 0 / 5 Subroutinesub 66.6% 4 / 6 Podpod 0.0% 0 / 2 totaltotal 12.7% 16 / 126 CC 26 SCAR 57.6
CC
26
Cov
11%
server
462.0
import
18.4
poll
2.0
CRAP 316.2
↑ Summary Watchdog/Util.pm »
1 =head1 NAME
2  
3 AnyEvent::Watchdog - generic watchdog/program restarter
4  
5 =head1 SYNOPSIS
6  
7 # MUST be use'd as the very first thing in the main program,
8 # as it clones/forks the program before it returns.
9 use AnyEvent::Watchdog;
10  
11 =head1 DESCRIPTION
12  
13 This module implements a watchdog that can repeatedly fork the program and
14 thus effectively restart it - as soon as the module is use'd, it will fork
15 the program (if possible) and continue to run it normally in the child,
16 while the parent becomes a supervisor.
17  
18 The child can then ask the supervisor to restart itself instead of
19 exiting, or ask the supervisor to restart it gracefully or forcefully.
20  
21 B<NOTE:> This module B<< I<MUST> >> be used as the first thing in the main
22 program. It will cause weird effects when used from another module, as
23 perl does not expect to be forked inside C<BEGIN> blocks.
24  
25 =head1 RECIPES
26  
27 Use AnyEvent::Watchdog solely as a convenient on-demand-restarter:
28  
29 use AnyEvent::Watchdog;
30  
31 # and whenever you want to restart (e.g. to upgrade code):
32 use AnyEvent::Watchdog::Util;
33 AnyEvent::Watchdog::Util::restart;
34  
35 Use AnyEvent::Watchdog to kill the program and exit when the event loop
36 fails to run for more than two minutes:
37  
38 use AnyEvent::Watchdog autorestart => 1, heartbeat => 120;
39  
40 Use AnyEvent::Watchdog to automatically kill (but not restart) the program when it fails
41 to handle events for longer than 5 minutes:
42  
43 use AnyEvent::Watchdog heartbeat => 300;
44  
45 =head1 VARIABLES/FUNCTIONS
46  
47 This module is controlled via the L<AnyEvent::Watchdog::Util> module:
48  
49 use AnyEvent::Watchdog::Util;
50  
51 # attempt restart
52 AnyEvent::Watchdog::Util::restart;
53  
54 # check if it is running
55 AnyEvent::Watchdog::Util::enabled
56 or croak "not running under watchdog!";
57  
58 =cut
59  
60 package AnyEvent::Watchdog;
61  
62 # load modules we will use later anyways
63 2 ▶use common::sense;
Subroutine BEGIN: called CC=1 SCAR=0.0
64  
65 2 ▶use Carp ();
Subroutine BEGIN: called CC=1 SCAR=0.0
66  
67 our $VERSION = '1.02';
68  
69 our $PID; # child pid
70 our $ENABLED = 0; # also version
71 our $AUTORESTART; # actually exit
72 our ($P, $C);
73  
74 0 ▶sub poll($) {
Subroutine poll: not called CC=1 SCAR=6.9
Pod undocumented
75 0 (vec my $v, fileno $P, 1) = 1;
76 0 CORE::select $v, undef, undef, $_[0]
77 }
78  
79 0 ▶sub server {
Subroutine server: not called CC=21 SCAR=61.4
Pod undocumented
80 0 my $expected;# do we expect a program exit?
81 my $heartbeat;
82  
83 0 $AUTORESTART = 0;
84  
85 0 local $SIG{HUP} = 'IGNORE';
86 0 local $SIG{INT} = 'IGNORE';
87 0 local $SIG{TERM} = 'IGNORE';
88  
89 0 while () {
90 0 ▶ if ($heartbeat) {
Branch: 1 branch
BranchTrueFalseTotal
if ($heartbeat) 0 0 0
91 0 ▶ unless (poll $heartbeat) {
Branch: 1 branch
BranchTrueFalseTotal
unless (&poll($heartbeat)) 0 0 0
92 0 $expected = 1;
93 0 warn "AnyEvent::Watchdog: heartbeat failed. killing.\n";
94 0 kill 9, $PID;
95 0 last;
96 }
97 }
98  
99 0 ▶ sysread $P, my $cmd, 1
Branch: 1 branch
BranchTrueFalseTotal
sysread $AnyEvent::Watchdog::P, my $cmd, 1 or last 0 0 0
100 or last;
101  
102 0 ▶ if ($cmd eq chr 0) {
Branch: 5 branches
BranchTrueFalseTotal
if ($cmd eq "\000") { } 0 0 0
elsif ($cmd eq "\cA") { } 0 0 0
elsif ($cmd eq "\cB") { } 0 0 0
elsif ($cmd eq "\cC") { } 0 0 0
elsif ($cmd eq "\cD") { } 0 0 0
103 0 $AUTORESTART = 0;
104  
105 } elsif ($cmd eq chr 1) {
106 0 $AUTORESTART = 1;
107  
108 } elsif ($cmd eq chr 2) {
109 0 ▶ sysread $P, my $timeout, 1
Branch: 1 branch
BranchTrueFalseTotal
sysread $AnyEvent::Watchdog::P, my $timeout, 1 or last 0 0 0
110 or last;
111  
112 0 $timeout = ord $timeout;
113  
114 0 ▶ unless (poll $timeout) {
Branch: 1 branch
BranchTrueFalseTotal
unless (&poll($timeout)) 0 0 0
115 0 warn "AnyEvent::Watchdog: program attempted restart, but failed to do so within $timeout seconds. killing.\n";
116 0 kill 9, $PID;
117 }
118  
119 0 ▶ if (sysread $P, my $dummy, 1) {
Branch: 1 branch
BranchTrueFalseTotal
if (sysread $AnyEvent::Watchdog::P, my $dummy, 1) 0 0 0
120 0 warn "AnyEvent::Watchdog: unexpected program output. killing.\n";
121 0 kill 9, $PID;
122 }
123  
124 0 $expected = 1;
125 0 last;
126  
127 } elsif ($cmd eq chr 3) {
128 0 ▶ sysread $P, my $interval, 1
Branch: 1 branch
BranchTrueFalseTotal
sysread $AnyEvent::Watchdog::P, my $interval, 1 or last 0 0 0
129 or last;
130  
131 0 $heartbeat = ord $interval;
132  
133 } elsif ($cmd eq chr 4) {
134 # heartbeat
135 # TODO: should only reset heartbeat timeout with \005
136  
137 } else {
138 0 warn "AnyEvent::Watchdog: unexpected program output. killing.\n";
139 0 kill 9, $PID;
140 0 last;
141 }
142 }
143  
144 0 waitpid $PID, 0;
145  
146 0 require POSIX;
147  
148 0 ▶ my $termsig = POSIX::WIFSIGNALED ($?) && POSIX::WTERMSIG ($?);
Condition0%0/3
POSIX::WIFSIGNALED($?) && POSIX::WTERMSIG($?)
!ll&&!rl&&r
000
MC/DC0%0/2
POSIX::WIFSIGNALED($?) && POSIX::WTERMSIG($?)
POSIX::WIFSIGNALED($?) POSIX::WTERMSIG($?)
Truth table0%0/3
A && B
A= POSIX::WIFSIGNALED($?)B= POSIX::WTERMSIG($?)
ABresult
0X0
100
111
149  
150 0 ▶ if ($termsig == POSIX::SIGINT () || $termsig == POSIX::SIGTERM ()) {
Branch: 1 branch
BranchTrueFalseTotal
if ($termsig == POSIX::SIGINT() or $termsig == POSIX::SIGTERM()) 0 0 0
Condition0%0/3
$termsig == POSIX::SIGINT() or $termsig == POSIX::SIGTERM()
l!l&&r!l&&!r
000
MC/DC0%0/2
$termsig == POSIX::SIGINT() or $termsig == POSIX::SIGTERM()
$termsig == POSIX::SIGINT() $termsig == POSIX::SIGTERM()
Truth table0%0/3
A or B
A= $termsig == POSIX::SIGINT()B= $termsig == POSIX::SIGTERM()
ABresult
1X1
011
000
151 0 $AUTORESTART = 0;
152 0 $expected = 1;
153 }
154  
155 0 ▶ unless ($expected) {
Branch: 1 branch
BranchTrueFalseTotal
unless ($expected) 0 0 0
156 0 ▶ warn "AnyEvent::Watchdog: program exited unexpectedly with status $?.\n"
Branch: 1 branch
BranchTrueFalseTotal
if $? >> 8 0 0 0
157 if $? >> 8;
158 }
159  
160 0 ▶ if ($AUTORESTART) {
Branch: 1 branch
BranchTrueFalseTotal
if ($AnyEvent::Watchdog::AUTORESTART) { } 0 0 0
161 0 warn "AnyEvent::Watchdog: attempting automatic restart.\n";
162 } else {
163 0 ▶ if ($termsig) {
Branch: 1 branch
BranchTrueFalseTotal
if ($termsig) { } 0 0 0
164 0 $SIG{$_} = 'DEFAULT' for keys %SIG;
165 0 kill $termsig, $$;
166 0 POSIX::_exit (127);
167 } else {
168 0 POSIX::_exit ($? >> 8);
169 }
170 }
171 }
172  
173 our %SEEKPOS;
174 # due to bugs in perl, try to remember file offsets for all fds, and restore them later
175 # (the parser otherwise exhausts the input files)
176  
177 # this causes perlio to flush its handles internally, so
178 # seek offsets become correct.
179 exec "."; # toi toi toi
180 #{
181 # local $SIG{CHLD} = 'DEFAULT';
182 # my $pid = fork;
183 #
184 # if ($pid) {
185 # waitpid $pid, 0;
186 # } else {
187 # kill 9, $$;
188 # }
189 #}
190  
191 # now record "all" fd positions, assuming 1023 is more than enough.
192 for (0 .. 1023) {
193 open my $fh, "<&$_" or next;
194 $SEEKPOS{$_} = (sysseek $fh, 0, 1 or next);
195 }
196  
197 while () {
198 if ($^O =~ /mswin32/i) {
199 require AnyEvent::Util;
200 ($P, $C) = AnyEvent::Util::portable_socketpair ()
201 or Carp::croak "AnyEvent::Watchdog: unable to create restarter pipe: $!\n";
202 } else {
203 require Socket;
204 socketpair $P, $C, Socket::AF_UNIX (), Socket::SOCK_STREAM (), 0
205 or Carp::croak "AnyEvent::Watchdog: unable to create restarter pipe: $!\n";
206 }
207  
208 local $SIG{CHLD} = 'DEFAULT';
209  
210 $PID = fork;
211  
212 unless (defined $PID) {
213 warn "AnyEvent::Watchdog: '$!', retrying in one second...\n";
214 sleep 1;
215 } elsif ($PID) {
216 # parent code
217 close $C;
218 server;
219 } else {
220 # child code
221 $ENABLED = 1; # also version
222  
223 # restore seek offsets
224 while (my ($k, $v) = each %SEEKPOS) {
225 open my $fh, "<&$k" or next;
226 sysseek $fh, $v, 0;
227 }
228  
229 # continue the program normally
230 close $P;
231 last;
232 }
233 }
234  
235 1 ▶sub import {
Subroutine import: called CC=5 SCAR=29.1
236 1 shift;
237  
238 1 ▶ while (@_) {
Branch: 1 branch
BranchTrueFalseTotal
if (@_) 0 1 1
239 0 my $k = shift;
240  
241 0 require AnyEvent::Watchdog::Util;
242  
243 0 ▶ if ($k eq "autorestart") {
Branch: 2 branches
BranchTrueFalseTotal
if ($k eq 'autorestart') { } 0 0 0
elsif ($k eq 'heartbeat') { } 0 0 0
244 0 AnyEvent::Watchdog::Util::autorestart (! ! shift);
245 } elsif ($k eq "heartbeat") {
246 0 ▶ AnyEvent::Watchdog::Util::heartbeat (shift || 60);
Condition0%0/2
shift() || 60
l!l
00
MC/DC0%0/1
shift() || 60
shift()
Truth table0%0/2
A
A= shift()
Aresult
11
00
247 } else {
248 0 Carp::croak "AnyEvent::Watchdog: '$_' is not a valid import argument";
249 }
250 }
251 }
252  
253 # used by AnyEvent::Watchdog::Util.
254 our $end;
255 2 ▶END { $end && &$end }
Subroutine END: called CC=2 SCAR=6.9
Branch: 1 branch
BranchTrueFalseTotal
$AnyEvent::Watchdog::end and &$AnyEvent::Watchdog::end 4 1021 1025
256  
257 =head1 SEE ALSO
258  
259 L<AnyEvent::Watchdog::Util>, L<AnyEvent>.
260  
261 =head1 AUTHOR
262  
263 Marc Lehmann <schmorp@schmorp.de>
264 http://home.schmorp.de/
265  
266 =cut
267  
268 1
269  
↑ Summary Watchdog/Util.pm »