clone/update: include a "References" header in messages
[girocco.git] / taskd / taskd.pl
blobe8bda6eeab109ad3ac5bc44bb1682eb6da79e48c
1 #!/usr/bin/perl
3 # taskd - Clone repositories on request
5 # taskd is Girocco mirroring servant; it processes requests for clones
6 # of given URLs received over its socket.
8 # When a request is received, new process is spawned that sets up
9 # the repository and reports further progress
10 # to .clonelog within the repository. In case the clone fails,
11 # .clone_failed is touched and .clone_in_progress is removed.
13 # Clone protocol:
14 # Alice sets up repository and touches .cloning
15 # Alice opens connection to Bob
16 # Alice sends project name through the connection
17 # Bob opens the repository and sends error code if there is a problem
18 # Bob closes connection
19 # Alice polls .clonelog in case of success.
20 # If Alice reads "@OVER@" from .clonelog, it stops polling.
22 # Ref-change protocol:
23 # Alice opens connection to Bob
24 # Alice sends ref-change command for each changed ref
25 # Alice closes connection
26 # Bob sends out notifications
28 # Initially based on perlipc example.
30 use 5.008; # we need safe signals
31 use strict;
32 use warnings;
34 use Getopt::Long;
35 use Pod::Usage;
36 use Socket;
37 use Errno;
38 use Fcntl;
39 use POSIX ":sys_wait_h";
40 use File::Basename;
41 use File::Spec ();
42 use Cwd qw(realpath);
44 use lib dirname($0);
45 use Girocco::Config;
46 use Girocco::Notify;
47 use Girocco::Project;
48 use Girocco::User;
49 use Girocco::Util qw(noFatalsToBrowser get_git);
50 BEGIN {noFatalsToBrowser}
51 use Girocco::ExecUtil;
53 use constant SOCKFDENV => "GIROCCO_TASKD_SOCKET_FD";
55 # Throttle Classes Defaults
56 # Note that any same-named classes in @Girocco::Config::throttle_classes
57 # will override (completely replacing the entire hash) these ones.
58 my @throttle_defaults = (
60 name => "ref-change",
61 maxproc => 0,
62 maxjobs => 1,
63 interval => 2
66 name => "clone",
67 maxproc => 0,
68 maxjobs => 2,
69 interval => 5
72 name => "snapshot",
73 #maxproc => max(5, cpucount + maxjobs), # this is the default
74 #maxjobs => max(1, int(cpucount / 4)) , # this is the default
75 interval => 5
79 # Options
80 my $quiet;
81 my $progress;
82 my $syslog;
83 my $stderr;
84 my $inetd;
85 my $idle_timeout;
86 my $daemon;
87 my $max_lifetime;
88 my $abbrev = 8;
89 my $showff = 1;
90 my $same_pid;
91 my $statusintv = 60;
92 my $idleintv = 3600;
93 my $maxspawn = 8;
95 $| = 1;
97 my $progname = basename($0);
98 my $children = 0;
99 my $idlestart = time;
100 my $idlestatus = 0;
102 sub cpucount {
103 use Girocco::Util "online_cpus";
104 our $online_cpus_result;
105 $online_cpus_result = online_cpus unless $online_cpus_result;
106 return $online_cpus_result;
109 sub logmsg {
110 my $hdr = "[@{[scalar localtime]}] $progname $$: ";
111 if (tied *STDOUT) {
112 $OStream::only = 2; # STDERR only
113 print "$hdr@_\n";
114 $OStream::only = 1; # syslog only
115 print "@_\n";
116 $OStream::only = 0; # back to default
117 } else {
118 print "$hdr@_\n";
122 sub statmsg {
123 return unless $progress;
124 my $hdr = "[@{[scalar localtime]}] $progname $$: ";
125 if (tied *STDERR) {
126 $OStream::only = 2; # STDERR only
127 print STDERR "$hdr@_\n";
128 $OStream::only = 1; # syslog only
129 print STDERR "@_\n";
130 $OStream::only = 0; # back to default
131 } else {
132 print STDERR "$hdr@_\n";
136 sub duration {
137 my $secs = shift;
138 return $secs unless defined($secs) && $secs >= 0;
139 $secs = int($secs);
140 my $ans = ($secs % 60) . 's';
141 return $ans if $secs < 60;
142 $secs = int($secs / 60);
143 $ans = ($secs % 60) . 'm' . $ans;
144 return $ans if $secs < 60;
145 $secs = int($secs / 60);
146 $ans = ($secs % 24) . 'h' . $ans;
147 return $ans if $secs < 24;
148 $secs = int($secs / 24);
149 return $secs . 'd' . $ans;
152 sub isfdopen {
153 my $fd = shift;
154 return undef unless defined($fd) && $fd >= 0;
155 my $result = POSIX::dup($fd);
156 POSIX::close($result) if defined($result);
157 defined($result);
160 sub setnoncloexec {
161 my $fd = shift;
162 fcntl($fd, F_SETFD, 0) or die "fcntl failed: $!";
165 sub setcloexec {
166 my $fd = shift;
167 fcntl($fd, F_SETFD, FD_CLOEXEC) or die "fcntl failed: $!";
170 sub setnonblock {
171 my $fd = shift;
172 my $flags = fcntl($fd, F_GETFL, 0);
173 defined($flags) or die "fcntl failed: $!";
174 fcntl($fd, F_SETFL, $flags | O_NONBLOCK) or die "fcntl failed: $!";
177 sub setblock {
178 my $fd = shift;
179 my $flags = fcntl($fd, F_GETFL, 0);
180 defined($flags) or die "fcntl failed: $!";
181 fcntl($fd, F_SETFL, $flags & ~O_NONBLOCK) or die "fcntl failed: $!";
184 package Throttle;
187 ## Throttle protocol
189 ## 1) Process needing throttle services acquire a control file descriptor
190 ## a) Either as a result of a fork + exec (the write end of a pipe)
191 ## b) Or by connecting to the taskd socket (not yet implemented)
193 ## 2) The process requesting throttle services will be referred to
194 ## as the supplicant or just "supp" for short.
196 ## 3) The supp first completes any needed setup which may include
197 ## gathering data it needs to perform the action -- if that fails
198 ## then there's no need for any throttling.
200 ## 4) The supp writes a throttle request to the control descriptor in
201 ## this format:
202 ## throttle <pid> <class>\n
203 ## for example if the supp's pid was 1234 and it was requesting throttle
204 ## control as a member of the mail class it would write this message:
205 ## throttle 1234 mail\n
206 ## Note that if the control descriptor happens to be a pipe rather than a
207 ## socket, the message should be preceded by another "\n" just be be safe.
208 ## If the control descriptor is a socket, not a pipe, the message may be
209 ## preceded by a "\n" but that's not recommended.
211 ## 5) For supplicants with a control descriptor that is a pipe
212 ## (getsockopt(SO_TYPE) returns ENOTSOCK) the (5a) protocol should be used.
213 ## If the control descriptor is a socket (getsockname succeeds) then
214 ## protocol (5b) should be used.
216 ## 5a) The supp now enters a "pause" loop awaiting either a SIGUSR1, SIGUSR2 or
217 ## SIGTERM. It should wake up periodically (SIGALRM works well) and attempt
218 ## to write a "keepalive\n" message to the control descriptor. If that
219 ## fails, the controller has gone away and it may make its own decision
220 ## whether or not to proceed at that point. If, on the other hand, it
221 ## receives a SIGTERM, the process limit for its class has been reached
222 ## and it should abort without performing its action. If it receives
223 ## SIGUSR1, it may proceed without writing anything more to the control
224 ## descriptor, any MAY even close the control descriptor. Finally, a
225 ## SIGUSR2 indicates rejection of the throttle request for some other reason
226 ## such as unrecognized class name or invalid pid in which case the supp may
227 ## make its own decision how to proceed.
229 ## 5b) The supp now enters a read wait on the socket -- it need accomodate no
230 ## more than 512 bytes and if a '\n' does not appear within that number of
231 ## bytes the read should be considered failed. Otherwise the read should
232 ## be retried until either a full line has been read or the socket is
233 ## closed from the other end. If the lone read is "proceed\n" then it may
234 ## proceed without reading or writing anything more to the control
235 ## descriptor, but MUST keep the control descriptor open and not call
236 ## shutdown on it either. Any other result (except EINTR or EAGAIN which
237 ## should be retried) constitutes failure. If a full line starting with at
238 ## least one alpha character was read but it was not "proceed" then it
239 ## should abort without performing its action. For any other failure it
240 ## may make its own decision whether or not to proceed as the controller has
241 ## gone away.
243 ## 6) The supp now performs its throttled action.
245 ## 7) The supp now closes its control descriptor (if it hasn't already in the
246 ## case of (5a)) and exits -- in the case of a socket, the other end receives
247 ## notification that the socket has been closed (read EOF). In the case of
248 ## a pipe the other end receives a SIGCHLD (multiple processes have a hold
249 ## of the other end of the pipe, so it will not reaach EOF by the supp's
250 ## exit in that case).
253 # keys are class names, values are hash refs with these fields:
254 # 'maxproc' => integer; maximum number of allowed supplicants (the sum of how
255 # many may be queued waiting plus how many may be
256 # concurrently active) with 0 meaning no limit.
257 # 'maxjobs' => integer; how many supplicants may proceed simultaneously a value
258 # of 0 is unlimited but the number of concurrent
259 # supplicants will always be limited to no more than
260 # the 'maxproc' value (if > 0) no matter what the
261 # 'maxjobs' value is.
262 # 'total' -> integer; the total number of pids belonging to this clase that
263 # can currently be found in %pid.
264 # 'active' -> integer; the number of currently active supplicants which should
265 # be the same as (the number of elements of %pid with a
266 # matching class name) - (number of my class in @queue).
267 # 'interval' -> integer; minimum number of seconds between 'proceed' responses
268 # or SIGUSR1 signals to members of this class.
269 # 'lastqueue' -> time; last time a supplicant was successfully queued.
270 # 'lastproceed' => time; last time a supplicant was allowed to proceed.
271 # 'lastthrottle' => time; last time a supplicant was throttled
272 # 'lastdied' => time; last time a supplicant in this class died/exited/etc.
273 my %classes = ();
275 # keys are pid numbers, values are array refs with these elements:
276 # [0] => name of class (key to classes hash)
277 # [1] => supplicant state (0 => queued, non-zero => time it started running)
278 # [2] => descriptive text (e.g. project name)
279 my %pid = ();
281 # minimum number of seconds between any two proceed responses no matter what
282 # class. this takes priority in that it can effectively increase the
283 # class's 'interval' value by delaying proceed notifications if the minimum
284 # interval has not yet elapsed.
285 my $interval = 1;
287 # fifo of pids awaiting notification as soon as the next $interval elapses
288 # provided interval and maxjobs requirements are satisfied
289 # for the class of the pid that will next be triggered.
290 my @queue = ();
292 # time of most recent successful call to AddSupplicant
293 my $lastqueue = 0;
295 # time of most recent proceed notification
296 my $lastproceed = 0;
298 # time of most recent throttle
299 my $lastthrottle = 0;
301 # time of most recent removal
302 my $lastdied = 0;
304 # lifetime count of how many have been queued
305 my $totalqueue = 0;
307 # lifetime count of how many have been allowed to proceed
308 my $totalproceed = 0;
310 # lifetime count of how many have been throttled
311 my $totalthrottle = 0;
313 # lifetime count of how many have died
314 # It should always be true that $totalqueued - $totaldied == $curentlyactive
315 my $totaldied = 0;
317 # Returns an unordered list of currently registered class names
318 sub GetClassList {
319 return keys(%classes);
322 sub _max {
323 return $_[0] if $_[0] >= $_[1];
324 return $_[1];
327 sub _getnum {
328 my ($min, $val, $default) = @_;
329 my $ans;
330 if (defined($val) && $val =~ /^[+-]?\d+$/) {
331 $ans = 0 + $val;
332 } else {
333 $ans = &$default;
335 return _max($min, $ans);
338 # [0] => name of class to find
339 # [1] => if true, create class if it doesn't exist, if a hashref then
340 # it contains initial values for maxproc, maxjobs and interval.
341 # Otherwise maxjobs defaults to max(cpu cores/4, 1), maxprocs
342 # defaults to the max(5, number of cpu cores + maxjobs) and interval
343 # defaults to 1.
344 # Returns a hash ref with info about the class on success
345 sub GetClassInfo {
346 my ($classname, $init) = @_;
347 defined($classname) && $classname =~ /^[a-zA-Z][a-zA-Z0-9._+-]*$/
348 or return;
349 $classname = lc($classname);
350 my %info;
351 if ($classes{$classname}) {
352 %info = %{$classes{$classname}};
353 return \%info;
355 return unless $init;
356 my %newclass = ();
357 ref($init) eq 'HASH' or $init = {};
358 $newclass{'maxjobs'} = _getnum(0, $init->{'maxjobs'}, sub{_max(1, int(::cpucount() / 4))});
359 $newclass{'maxproc'} = _getnum(0, $init->{'maxproc'}, sub{_max(5, ::cpucount() + $newclass{'maxjobs'})});
360 $newclass{'interval'} = _getnum(0, $init->{'interval'}, sub{1});
361 $newclass{'total'} = 0;
362 $newclass{'active'} = 0;
363 $newclass{'lastqueue'} = 0;
364 $newclass{'lastproceed'} = 0;
365 $newclass{'lastthrottle'} = 0;
366 $newclass{'lastdied'} = 0;
367 $classes{$classname} = \%newclass;
368 %info = %newclass;
369 return \%info;
372 # [0] => pid to look up
373 # Returns () if not found otherwise ($classname, $timestarted, $description)
374 # Where $timestarted will be 0 if it's still queued otherwise a time() value
375 sub GetPidInfo {
376 my $pid = shift;
377 return () unless exists $pid{$pid};
378 return @{$pid{$pid}};
381 # Returns array of pid numbers that are currently running sorted
382 # by time started (oldest to newest). Can return an empty array.
383 sub GetRunningPids {
384 return sort({ ${$pid{$a}}[1] <=> ${$pid{$b}}[1] }
385 grep({ ${$pid{$_}}[1] } keys(%pid)));
388 # Returns a hash with various about the current state
389 # 'interval' => global minimum interval between proceeds
390 # 'active' => how many pids are currently queued + how many are running
391 # 'queue' => how many pids are currently queued
392 # 'lastqueue' => time (epoch seconds) of last queue
393 # 'lastproceed' => time (epoch seconds) of last proceed
394 # 'lastthrottle' => time (epoch seconds) of last throttle
395 # 'lastdied' => time (epoch seconds) of last removal
396 # 'totalqueue' => lifetime total number of processes queued
397 # 'totalproceed' => lifetime total number of processes proceeded
398 # 'totalthrottle' => lifetime total number of processes throttled
399 # 'totaldied' => lifetime total number of removed processes
400 sub GetInfo {
401 return {
402 interval => $interval,
403 active => scalar(keys(%pid)) - scalar(@queue),
404 queue => scalar(@queue),
405 lastqueue => $lastqueue,
406 lastproceed => $lastproceed,
407 lastthrottle => $lastthrottle,
408 lastdied => $lastdied,
409 totalqueue => $totalqueue,
410 totalproceed => $totalproceed,
411 totalthrottle => $totalthrottle,
412 totaldied => $totaldied
416 # with no args get the global interval
417 # with one arg set it, returns previous value if set
418 sub Interval {
419 my $ans = $interval;
420 $interval = 0 + $_[0] if defined($_[0]) && $_[0] =~ /^\d+$/;
421 return $ans;
424 sub RemoveSupplicant;
426 # Perform queue service (i.e. send SIGUSR1 to any eligible queued process)
427 # Returns minimum interval until next proceed is possible
428 # Returns undef if there's nothing waiting to proceed or
429 # the 'maxjobs' limits have been reached for all queued items (in which
430 # case it won't be possible to proceed until one of them exits, hence undef)
431 # This is called automatially by AddSupplicant and RemoveSupplicant
432 sub ServiceQueue {
433 RETRY:
434 return undef unless @queue; # if there's nothing queued, nothing to do
435 my $now = time;
436 my $min = _max(0, $interval - ($now - $lastproceed));
437 my $classmin = undef;
438 my $classchecked = 0;
439 my %seenclass = ();
440 my $classcount = scalar(keys(%classes));
441 for (my $i=0; $i <= $#queue && $classchecked < $classcount; ++$i) {
442 my $pid = $queue[$i];
443 my $procinfo = $pid{$pid};
444 if (!$procinfo) {
445 RemoveSupplicant($pid, 1);
446 goto RETRY;
448 my $classinfo = $classes{$$procinfo[0]};
449 if (!$classinfo) {
450 RemoveSupplicant($pid, 1);
451 goto RETRY;
453 if (!$seenclass{$$procinfo[0]}) {
454 $seenclass{$$procinfo[0]} = 1;
455 ++$classchecked;
456 if (!$classinfo->{'maxjobs'} || $classinfo->{'active'} < $classinfo->{'maxjobs'}) {
457 my $cmin = _max(0, $classinfo->{'interval'} - ($now - $classinfo->{'lastproceed'}));
458 if (!$cmin && !$min) {
459 $now = time;
460 $$procinfo[1] = $now;
461 splice(@queue, $i, 1);
462 ++$totalproceed;
463 $lastproceed = $now;
464 $classinfo->{'lastproceed'} = $now;
465 ++$classinfo->{'active'};
466 kill("USR1", $pid) or RemoveSupplicant($pid, 1);
467 goto RETRY;
469 $classmin = $cmin unless defined($classmin) && $classmin < $cmin;
473 return defined($classmin) ? _max($min, $classmin) : undef;
476 # $1 => pid to add (must not already be in %pids)
477 # $2 => class name (must exist)
478 # Returns -1 if no such class or pid already present or invalid
479 # Returns 0 if added successfully (and possibly already SIGUSR1'd)
480 # Return 1 if throttled and cannot be added
481 sub AddSupplicant {
482 my ($pid, $classname, $text, $noservice) = @_;
483 return -1 unless $pid && $pid =~ /^[1-9][0-9]*$/;
484 $pid += 0;
485 kill(0, $pid) or return -1;
486 my $classinfo = $classes{$classname};
487 return -1 unless $classinfo;
488 return -1 if $pid{$pid};
489 $text = '' unless defined($text);
490 my $now = time;
491 if ($classinfo->{'maxproc'} && $classinfo->{'total'} >= $classinfo->{'maxproc'}) {
492 ++$totalthrottle;
493 $lastthrottle = $now;
494 $classinfo->{'lastthrottle'} = $now;
495 return 1;
497 ++$totalqueue;
498 $lastqueue = $now;
499 $pid{$pid} = [$classname, 0, $text];
500 ++$classinfo->{'total'};
501 $classinfo->{'lastqueue'} = $now;
502 push(@queue, $pid);
503 ServiceQueue unless $noservice;
504 return 0;
507 # $1 => pid to remove (died, killed, exited normally, doesn't matter)
508 # Returns 0 if removed
509 # Returns -1 if unknown pid or other error during removal
510 sub RemoveSupplicant {
511 my ($pid, $noservice) = @_;
512 return -1 unless defined($pid) && $pid =~ /^\d+$/;
513 $pid += 0;
514 my $pidinfo = $pid{$pid};
515 $pidinfo or return -1;
516 my $now = time;
517 $lastdied = $now;
518 ++$totaldied;
519 delete $pid{$pid};
520 if (!$$pidinfo[1]) {
521 for (my $i=0; $i<=$#queue; ++$i) {
522 if ($queue[$i] == $pid) {
523 splice(@queue, $i, 1);
524 --$i;
528 my $classinfo = $classes{$$pidinfo[0]};
529 ServiceQueue, return -1 unless $classinfo;
530 --$classinfo->{'active'} if $$pidinfo[1];
531 --$classinfo->{'total'};
532 $classinfo->{'lastdied'} = $now;
533 ServiceQueue unless $noservice;
534 return 0;
537 # Instance Methods
539 package main;
542 ## ---------
543 ## Functions
544 ## ---------
547 my @reapedpids = ();
548 my %signame = (
549 # http://pubs.opengroup.org/onlinepubs/000095399/utilities/trap.html
550 1 => 'SIGHUP',
551 2 => 'SIGINT',
552 3 => 'SIGQUIT',
553 6 => 'SIGABRT',
554 9 => 'SIGKILL',
555 14 => 'SIGALRM',
556 15 => 'SIGTERM',
558 sub REAPER {
559 local $!;
560 my $child;
561 my $waitedpid;
562 while (($waitedpid = waitpid(-1, WNOHANG)) > 0) {
563 my $code = $? & 0xffff;
564 $idlestart = time if !--$children;
565 my $codemsg = '';
566 if (!($code & 0xff)) {
567 $codemsg = " with exit code ".($code >> 8) if $code;
568 } elsif ($code & 0x7f) {
569 my $signum = ($code & 0x7f);
570 $codemsg = " with signal ".
571 ($signame{$signum}?$signame{$signum}:$signum);
573 logmsg "reaped $waitedpid$codemsg";
574 push(@reapedpids, $waitedpid);
576 $SIG{CHLD} = \&REAPER; # loathe sysV
579 $SIG{CHLD} = \&REAPER; # Apollo 440
581 my ($piperead, $pipewrite);
582 sub spawn {
583 my $coderef = shift;
585 my $pid = fork;
586 if (not defined $pid) {
587 logmsg "cannot fork: $!";
588 return;
589 } elsif ($pid) {
590 $idlestart = time if !++$children;
591 $idlestatus = 0;
592 logmsg "begat $pid";
593 return; # I'm the parent
596 close(Server) unless fileno(Server) == 0;
597 close($piperead);
598 $SIG{'CHLD'} = sub {};
600 open STDIN, "+<&Client" or die "can't dup client to stdin";
601 close(Client);
602 exit &$coderef();
605 # returns:
606 # < 0: error
607 # = 0: proceed
608 # > 0: throttled
609 sub request_throttle {
610 use POSIX qw(sigprocmask sigsuspend SIG_SETMASK);
611 my $classname = shift;
612 my $text = shift;
614 Throttle::GetClassInfo($classname)
615 or return -1; # no such throttle class
617 my $throttled = 0;
618 my $proceed = 0;
619 my $error = 0;
620 my $controldead = 0;
621 my $setempty = POSIX::SigSet->new;
622 my $setfull = POSIX::SigSet->new;
623 $setempty->emptyset();
624 $setfull->fillset();
625 $SIG{'TERM'} = sub {$throttled = 1};
626 $SIG{'USR1'} = sub {$proceed = 1};
627 $SIG{'USR2'} = sub {$error = 1};
628 $SIG{'PIPE'} = sub {$controldead = 1};
629 $SIG{'ALRM'} = sub {};
631 # After writing we can expect a SIGTERM, SIGUSR1 or SIGUSR2
632 print $pipewrite "\nthrottle $$ $classname $text\n";
633 my $old = POSIX::SigSet->new;
634 sigprocmask(SIG_SETMASK, $setfull, $old);
635 until ($controldead || $throttled || $proceed || $error) {
636 alarm(30);
637 sigsuspend($setempty);
638 alarm(0);
639 sigprocmask(SIG_SETMASK, $setempty, $old);
640 print $pipewrite "\nkeepalive $$\n";
641 sigprocmask(SIG_SETMASK, $setfull, $old);
643 sigprocmask(SIG_SETMASK, $setempty, $old);
644 $SIG{'TERM'} = "DEFAULT";
645 $SIG{'USR1'} = "DEFAULT";
646 $SIG{'USR2'} = "DEFAULT";
647 $SIG{'ALRM'} = "DEFAULT";
648 $SIG{'PIPE'} = "DEFAULT";
650 my $result = -1;
651 if ($throttled) {
652 $result = 1;
653 } elsif ($proceed) {
654 $result = 0;
656 return $result;
659 sub clone {
660 my ($name) = @_;
661 Girocco::Project::does_exist($name, 1) or die "no such project: $name";
662 my $proj;
663 eval {$proj = Girocco::Project->load($name)};
664 if (!$proj && Girocco::Project::does_exist($name, 1)) {
665 # If the .clone_in_progress file exists, but the .clonelog does not
666 # and neither does the .clone_failed, be helpful and touch the
667 # .clone_failed file so that the mirror can be restarted
668 my $projdir = $Girocco::Config::reporoot."/$name.git";
669 if (-d "$projdir" && -f "$projdir/.clone_in_progress" && ! -f "$projdir/.clonelog" && ! -f "$projdir/.clone_failed") {
670 open X, '>', "$projdir/.clone_failed" and close(X);
673 $proj or die "failed to load project $name";
674 $proj->{clone_in_progress} or die "project $name is not marked for cloning";
675 $proj->{clone_logged} and die "project $name is already being cloned";
676 request_throttle("clone", $name) <= 0 or die "cloning $name aborted (throttled)";
677 statmsg "cloning $name";
678 open STDOUT, '>', "$Girocco::Config::reporoot/$name.git/.clonelog" or die "cannot open clonelog: $!";
679 open STDERR, ">&STDOUT";
680 open STDIN, '<', '/dev/null';
681 exec "$Girocco::Config::basedir/taskd/clone.sh", "$name.git" or die "exec failed: $!";
684 sub ref_indicator {
685 return ' -> ' unless $showff && defined($_[0]);
686 my ($git_dir, $old, $new) = @_;
687 return '..' unless defined($old) && defined($new) && $old !~ /^0+$/ && $new !~ /^0+$/ && $old ne $new;
688 # In many cases `git merge-base` is slower than this even if using the
689 # `--is-ancestor` option available since Git 1.8.0, but it's never faster
690 my $ans = get_git("--git-dir=$git_dir", "rev-list", "-n", "1", "^$new^0", "$old^0", "--") ? '...' : '..';
691 return wantarray ? ($ans, 1) : $ans;
694 sub ref_change {
695 my ($arg) = @_;
696 my ($username, $name, $oldrev, $newrev, $ref) = split(/\s+/, $arg);
697 $username && $name && $oldrev && $newrev && $ref or return 0;
698 $oldrev =~ /^[0-9a-f]{40}$/ && $newrev =~ /^[0-9a-f]{40}$/ && $ref =~ m{^refs/} or return 0;
699 $newrev ne $oldrev or return 0;
701 Girocco::Project::does_exist($name, 1) or die "no such project: $name";
702 my $proj = Girocco::Project->load($name);
703 $proj or die "failed to load project $name";
704 my $has_notify = $proj->has_notify;
705 my $type = $has_notify ? "notify" : "change";
707 my $user;
708 if ($username && $username !~ /^%.*%$/) {
709 Girocco::User::does_exist($username, 1) or die "no such user: $username";
710 $user = Girocco::User->load($username);
711 $user or die "failed to load user $username";
712 } elsif ($username eq "%$name%") {
713 $username = "-";
716 request_throttle("ref-change", $name) <= 0 or die "ref-change $name aborted (throttled)";
717 my $ind = ref_indicator($proj->{path}, $oldrev, $newrev);
718 statmsg "ref-$type $username $name ($ref: @{[substr($oldrev,0,$abbrev)]}$ind@{[substr($newrev,0,$abbrev)]})";
719 open STDIN, '<', '/dev/null';
720 Girocco::Notify::ref_change($proj, $user, $ref, $oldrev, $newrev) if $has_notify;
721 return 0;
724 sub ref_changes {
725 my ($arg) = @_;
726 my ($username, $name) = split(/\s+/, $arg);
727 $username && $name or return 0;
729 Girocco::Project::does_exist($name, 1) or die "no such project: $name";
730 my $proj = Girocco::Project->load($name);
731 $proj or die "failed to load project $name";
732 my $has_notify = $proj->has_notify;
733 my $type = $has_notify ? "notify" : "change";
735 my $user;
736 if ($username && $username !~ /^%.*%$/) {
737 Girocco::User::does_exist($username, 1) or die "no such user: $username";
738 $user = Girocco::User->load($username);
739 $user or die "failed to load user $username";
740 } elsif ($username eq "%$name%") {
741 $username = "-";
744 my @changes = ();
745 my %oldheads = ();
746 my %deletedheads = ();
747 while (my $change = <STDIN>) {
748 my ($oldrev, $newrev, $ref) = split(/\s+/, $change);
749 $oldrev =~ /^[0-9a-f]{40}$/ && $newrev =~ /^[0-9a-f]{40}$/ && $ref =~ m{^refs/} or next;
750 if ($ref =~ m{^refs/heads/.}) {
751 if ($oldrev =~ /^0{40}$/) {
752 delete $oldheads{$ref};
753 $deletedheads{$ref} = 1;
754 } elsif ($newrev ne $oldrev || (!exists($oldheads{$ref}) && !$deletedheads{$ref})) {
755 $oldheads{$ref} = $oldrev;
758 $newrev ne $oldrev or next;
759 push(@changes, [$oldrev, $newrev, $ref]);
761 return 0 unless @changes;
762 open STDIN, '<', '/dev/null';
763 request_throttle("ref-change", $name) <= 0 or die "ref-changes $name aborted (throttled)";
764 my $statproc = sub {
765 my ($old, $new, $ref, $ran_mail_sh) = @_;
766 my ($ind, $ran_git) = ref_indicator($proj->{path}, $old, $new);
767 statmsg "ref-$type $username $name ($ref: @{[substr($old,0,$abbrev)]}$ind@{[substr($new,0,$abbrev)]})";
768 if ($ran_mail_sh) {
769 sleep 2;
770 } elsif ($ran_git) {
771 sleep 1;
774 if ($has_notify) {
775 Girocco::Notify::ref_changes($proj, $user, $statproc, \%oldheads, @changes);
776 } else {
777 &$statproc(@$_) foreach @changes;
779 return 0;
782 sub throttle {
783 my ($arg) = @_;
784 my ($pid, $classname, $text) = split(/\s+/, $arg);
785 $pid =~ /^\d+/ or return 0; # invalid pid
786 $pid += 0;
787 $pid > 0 or return 0; # invalid pid
788 kill(0, $pid) || $!{EPERM} or return 0; # no such process
789 Throttle::GetClassInfo($classname) or return 0; # no such throttle class
790 defined($text) && $text ne '' or return 0; # no text no service
792 my $throttled = 0;
793 my $proceed = 0;
794 my $error = 0;
795 my $controldead = 0;
796 my $suppdead = 0;
797 my ($waker, $wakew);
798 pipe($waker, $wakew) or die "pipe failed: $!";
799 select((select($wakew),$|=1)[0]);
800 setnonblock($wakew);
801 $SIG{'TERM'} = sub {$throttled = 1; syswrite($wakew, '!')};
802 $SIG{'USR1'} = sub {$proceed = 1; syswrite($wakew, '!')};
803 $SIG{'USR2'} = sub {$error = 1; syswrite($wakew, '!')};
804 $SIG{'PIPE'} = sub {$controldead = 1; syswrite($wakew, '!')};
805 select((select(STDIN),$|=1)[0]);
807 logmsg "throttle $pid $classname $text request";
808 # After writing we can expect a SIGTERM or SIGUSR1
809 print $pipewrite "\nthrottle $$ $classname $text\n";
811 # NOTE: the only way to detect the socket close is to read all the
812 # data until EOF is reached -- recv can be used to peek.
813 my $v = '';
814 vec($v, fileno(STDIN), 1) = 1;
815 vec($v, fileno($waker), 1) = 1;
816 setnonblock(\*STDIN);
817 setnonblock($waker);
818 until ($controldead || $throttled || $proceed || $error || $suppdead) {
819 my ($r, $e);
820 select($r=$v, undef, $e=$v, 30);
821 my ($bytes, $discard);
822 do {$bytes = sysread($waker, $discard, 512)} while (defined($bytes) && $bytes > 0);
823 do {$bytes = sysread(STDIN, $discard, 4096)} while (defined($bytes) && $bytes > 0);
824 $suppdead = 1 unless !defined($bytes) && $!{EAGAIN};
825 print $pipewrite "\nkeepalive $$\n";
827 setblock(\*STDIN);
829 if ($throttled && !$suppdead) {
830 print STDIN "throttled\n";
831 logmsg "throttle $pid $classname $text throttled";
832 } elsif ($proceed && !$suppdead) {
833 print STDIN "proceed\n";
834 logmsg "throttle $pid $classname $text proceed";
835 $SIG{'TERM'} = 'DEFAULT';
836 # Stay alive until the child dies which we detect by EOF on STDIN
837 setnonblock(\*STDIN);
838 until ($controldead || $suppdead) {
839 my ($r, $e);
840 select($r=$v, undef, $e=$v, 30);
841 my ($bytes, $discard);
842 do {$bytes = sysread($waker, $discard, 512)} while (defined($bytes) && $bytes > 0);
843 do {$bytes = sysread(STDIN, $discard, 512)} while (defined($bytes) && $bytes > 0);
844 $suppdead = 1 unless !defined($bytes) && $!{EAGAIN};
845 print $pipewrite "\nkeepalive $$\n";
847 setblock(\*STDIN);
848 } else {
849 my $prefix = '';
850 $prefix = "control" if $controldead && !$suppdead;
851 logmsg "throttle $pid $classname $text ${prefix}died";
853 exit 0;
856 sub process_pipe_msg {
857 my ($act, $pid, $cls, $text) = split(/\s+/, $_[0]);
858 if ($act eq "throttle") {
859 $pid =~ /^\d+$/ or return 0;
860 $pid += 0;
861 $pid > 0 or return 0; # invalid pid
862 kill(0, $pid) or return 0; # invalid pid
863 defined($cls) && $cls ne "" or kill('USR2', $pid), return 0;
864 defined($text) && $text ne "" or kill('USR2', $pid), return 0;
865 Throttle::GetClassInfo($cls) or kill('USR2', $pid), return 0;
866 # the AddSupplicant call could send SIGUSR1 before it returns
867 my $result = Throttle::AddSupplicant($pid, $cls, $text);
868 kill('USR2', $pid), return 0 if $result < 0;
869 kill('TERM', $pid), return 0 if $result > 0;
870 # $pid was added to class $cls and will receive SIGUSR1 when
871 # it's time for it to proceed
872 return 0;
873 } elsif ($act eq "keepalive") {
874 # nothing to do although we could verify pid is valid and
875 # still in %Throttle::pids and send a SIGUSR2 if not, but
876 # really keepalive should just be ignored.
877 return 0;
879 print STDERR "discarding unknown pipe message \"$_[0]\"\n";
880 return 0;
884 ## -------
885 ## OStream
886 ## -------
889 package OStream;
891 # Set to 1 for only syslog output (if enabled by mode)
892 # Set to 2 for only stderr output (if enabled by mode)
893 our $only = 0; # This is a hack
895 use Carp 'croak';
896 use Sys::Syslog qw(:DEFAULT :macros);
898 sub writeall {
899 my ($fd, $data) = @_;
900 my $offset = 0;
901 my $remaining = length($data);
902 while ($remaining) {
903 my $bytes = POSIX::write(
904 $fd,
905 substr($data, $offset, $remaining),
906 $remaining);
907 next if !defined($bytes) && $!{EINTR};
908 croak "POSIX::write failed: $!" unless defined $bytes;
909 croak "POSIX::write wrote 0 bytes" unless $bytes;
910 $remaining -= $bytes;
911 $offset += $bytes;
915 sub dumpline {
916 use POSIX qw(STDERR_FILENO);
917 my ($self, $line) = @_;
918 $only = 0 unless defined($only);
919 writeall(STDERR_FILENO, $line) if $self->{'stderr'} && $only != 1;
920 substr($line, -1, 1) = '' if substr($line, -1, 1) eq "\n";
921 return unless length($line);
922 syslog(LOG_NOTICE, "%s", $line) if $self->{'syslog'} && $only != 2;
925 sub TIEHANDLE {
926 my $class = shift || 'OStream';
927 my $mode = shift;
928 my $syslogname = shift;
929 my $syslogfacility = shift;
930 defined($syslogfacility) or $syslogfacility = LOG_USER;
931 my $self = {};
932 $self->{'syslog'} = $mode > 0;
933 $self->{'stderr'} = $mode <= 0 || $mode > 1;
934 $self->{'lastline'} = '';
935 if ($self->{'syslog'}) {
936 # Some Sys::Syslog have a stupid default setlogsock order
937 eval {Sys::Syslog::setlogsock("native"); 1;} or
938 eval {Sys::Syslog::setlogsock("unix");};
939 openlog($syslogname, "ndelay,pid", $syslogfacility)
940 or croak "Sys::Syslog::openlog failed: $!";
942 return bless $self, $class;
945 sub BINMODE {return 1}
946 sub FILENO {return undef}
947 sub EOF {return 0}
948 sub CLOSE {return 1}
950 sub PRINTF {
951 my $self = shift;
952 my $template = shift;
953 return $self->PRINT(sprintf $template, @_);
956 sub PRINT {
957 my $self = shift;
958 my $data = join('', $self->{'lastline'}, @_);
959 my $pos = 0;
960 while ((my $idx = index($data, "\n", $pos)) >= 0) {
961 ++$idx;
962 my $line = substr($data, $pos, $idx - $pos);
963 substr($data, $pos, $idx - $pos) = '';
964 $pos = $idx;
965 $self->dumpline($line);
967 $self->{'lastline'} = $data;
968 return 1;
971 sub DESTROY {
972 my $self = shift;
973 $self->dumpline($self->{'lastline'})
974 if length($self->{'lastline'});
975 closelog;
978 sub WRITE {
979 my $self = shift;
980 my ($scalar, $length, $offset) = @_;
981 $scalar = '' if !defined($scalar);
982 $length = length($scalar) if !defined($length);
983 croak "OStream::WRITE invalid length $length"
984 if $length < 0;
985 $offset = 0 if !defined($offset);
986 $offset += length($scalar) if $offset < 0;
987 croak "OStream::WRITE invalid write offset"
988 if $offset < 0 || $offset > $length;
989 my $max = length($scalar) - $offset;
990 $length = $max if $length > $max;
991 $self->PRINT(substr($scalar, $offset, $length));
992 return $length;
996 ## ----
997 ## main
998 ## ----
1001 package main;
1003 # returns pid of process that will schedule jobd.pl restart on success
1004 # returns 0 if fork or other system call failed with error in $!
1005 # returns undef if jobd.pl does not currently appear to be running (no lockfile)
1006 sub schedule_jobd_restart {
1007 use POSIX qw(_exit setpgid dup2 :fcntl_h);
1008 my $devnull = File::Spec->devnull;
1009 my $newpg = shift;
1010 my $jdlf = "/tmp/jobd-$Girocco::Config::tmpsuffix.lock";
1011 return undef unless -f $jdlf;
1012 my $oldsigchld = $SIG{'CHLD'};
1013 defined($oldsigchld) or $oldsigchld = sub {};
1014 my ($read, $write, $read2, $write2);
1015 pipe($read, $write) or return 0;
1016 select((select($write),$|=1)[0]);
1017 if (!pipe($read2, $write2)) {
1018 local $!;
1019 close $write;
1020 close $read;
1021 return 0;
1023 select((select($write2),$|=1)[0]);
1024 $SIG{'CHLD'} = sub {};
1025 my $retries = 3;
1026 my $child;
1027 while (!defined($child) && $retries--) {
1028 $child = fork;
1029 sleep 1 unless defined($child) || !$retries;
1031 if (!defined($child)) {
1032 local $!;
1033 close $write2;
1034 close $read2;
1035 close $write;
1036 close $read;
1037 $SIG{'CHLD'} = $oldsigchld;
1038 return 0;
1040 # double fork the child
1041 if (!$child) {
1042 close $read2;
1043 my $retries2 = 3;
1044 my $child2;
1045 while (!defined($child2) && $retries2--) {
1046 $child2 = fork;
1047 sleep 1 unless defined($child2) || !$retries2;
1049 if (!defined($child2)) {
1050 my $ec = 0 + $!;
1051 $ec = 255 unless $ec;
1052 print $write2 ":$ec";
1053 close $write2;
1054 _exit 127;
1056 if ($child2) {
1057 # pass new child pid up to parent and exit
1058 print $write2 $child2;
1059 close $write2;
1060 _exit 0;
1061 } else {
1062 # this is the grandchild
1063 close $write2;
1065 } else {
1066 close $write2;
1067 my $result = <$read2>;
1068 close $read2;
1069 chomp $result if defined($result);
1070 if (!defined($result) || $result !~ /^:?\d+$/) {
1071 # something's wrong with the child -- kill it
1072 kill(9, $child) && waitpid($child, 0);
1073 my $oldsigpipe = $SIG{'PIPE'};
1074 # make sure the grandchild, if any,
1075 # doesn't run the success proc
1076 $SIG{'PIPE'} = sub {};
1077 print $write 1;
1078 close $write;
1079 close $read;
1080 $SIG{'PIPE'} = defined($oldsigpipe) ?
1081 $oldsigpipe : 'DEFAULT';
1082 $! = 255;
1083 $SIG{'CHLD'} = $oldsigchld;
1084 return 0;
1086 if ($result =~ /^:(\d+)$/) {
1087 # fork failed in child, there is no grandchild
1088 my $ec = $1;
1089 waitpid($child, 0);
1090 close $write;
1091 close $read;
1092 $! = $ec;
1093 $SIG{'CHLD'} = $oldsigchld;
1094 return 0;
1096 # reap the child and set $child to grandchild's pid
1097 waitpid($child, 0);
1098 $child = $result;
1100 if (!$child) {
1101 # grandchild that actually initiates the jobd.pl restart
1102 close $write;
1103 my $wait = 5;
1104 my $ufd = POSIX::open($devnull, O_RDWR);
1105 if (defined($ufd)) {
1106 dup2($ufd, 0) unless $ufd == 0;
1107 dup2($ufd, 1) unless $ufd == 1;
1108 dup2($ufd, 2) unless $ufd == 2;
1109 POSIX::close($ufd) unless $ufd == 0 || $ufd == 1 || $ufd == 2;
1111 chdir "/";
1112 if ($newpg) {
1113 my $makepg = sub {
1114 my $result = setpgid(0, 0);
1115 if (!defined($result)) {
1116 --$wait;
1117 sleep 1;
1119 $result;
1121 my $result = &$makepg;
1122 defined($result) or $result = &$makepg;
1123 defined($result) or $result = &$makepg;
1124 defined($result) or $result = &$makepg;
1126 sleep $wait;
1127 my $result = <$read>;
1128 close $read;
1129 chomp $result if defined($result);
1130 if (!defined($result) || $result eq 0) {
1131 open JDLF, '+<', $jdlf or _exit(1);
1132 select((select(JDLF),$|=1)[0]);
1133 print JDLF "restart\n";
1134 truncate JDLF, tell(JDLF);
1135 close JDLF;
1137 _exit(0);
1139 close $write;
1140 close $read;
1141 $SIG{'CHLD'} = $oldsigchld;
1142 return $child;
1145 sub cancel_jobd_restart {
1146 my $restarter = shift;
1147 return unless defined($restarter) && $restarter != 0;
1148 return -1 unless kill(0, $restarter);
1149 kill(9, $restarter) or die "failed to kill jobd restarter process (pid $restarter): $!\n";
1150 # we must not waitpid because $restarter was doubly forked and will
1151 # NOT send us a SIGCHLD when it terminates
1152 return $restarter;
1155 my $reexec = Girocco::ExecUtil->new;
1156 my $realpath0 = realpath($0);
1157 chdir "/";
1158 close(DATA) if fileno(DATA);
1159 my $sfac;
1160 Getopt::Long::Configure('bundling');
1161 my ($stiv, $idiv);
1162 my $parse_res = GetOptions(
1163 'help|?|h' => sub {
1164 pod2usage(-verbose => 2, -exitval => 0, -input => $realpath0)},
1165 'quiet|q' => \$quiet,
1166 'no-quiet' => sub {$quiet = 0},
1167 'progress|P' => \$progress,
1168 'inetd|i' => sub {$inetd = 1; $syslog = 1; $quiet = 1;},
1169 'idle-timeout|t=i' => \$idle_timeout,
1170 'daemon' => sub {$daemon = 1; $syslog = 1; $quiet = 1;},
1171 'max-lifetime=i' => \$max_lifetime,
1172 'syslog|s:s' => \$sfac,
1173 'no-syslog' => sub {$syslog = 0; $sfac = undef;},
1174 'stderr' => \$stderr,
1175 'abbrev=i' => \$abbrev,
1176 'show-fast-forward-info' => \$showff,
1177 'no-show-fast-forward-info' => sub {$showff = 0},
1178 'same-pid' => \$same_pid,
1179 'no-same-pid' => sub {$same_pid = 0},
1180 'status-interval=i' => \$stiv,
1181 'idle-status-interval=i' => \$idiv,
1182 ) || pod2usage(-exitval => 2, -input => $realpath0);
1183 $same_pid = !$daemon unless defined($same_pid);
1184 $syslog = 1 if defined($sfac);
1185 $progress = 1 unless $quiet;
1186 $abbrev = 128 unless $abbrev > 0;
1187 pod2usage(-msg => "--inetd and --daemon are incompatible") if ($inetd && $daemon);
1188 if (defined($idle_timeout)) {
1189 die "--idle-timeout must be a whole number\n" unless $idle_timeout =~ /^\d+$/;
1190 die "--idle-timeout may not be used without --inetd\n" unless $inetd;
1192 if (defined($max_lifetime)) {
1193 die "--max-lifetime must be a whole number\n" unless $max_lifetime =~ /^\d+$/;
1194 $max_lifetime += 0;
1196 defined($max_lifetime) or $max_lifetime = 604800; # 1 week
1197 if (defined($stiv)) {
1198 die "--status-interval must be a whole number\n" unless $stiv =~ /^\d+$/;
1199 $statusintv = $stiv * 60;
1201 if (defined($idiv)) {
1202 die "--idle-status-interval must be a whole number\n" unless $idiv =~ /^\d+$/;
1203 $idleintv = $idiv * 60;
1206 open STDIN, '<'.File::Spec->devnull or die "could not redirect STDIN to /dev/null\n" unless $inetd;
1207 open STDOUT, '>&STDERR' if $inetd;
1208 if ($syslog) {
1209 use Sys::Syslog qw();
1210 my $mode = 1;
1211 ++$mode if $stderr;
1212 $sfac = "user" unless defined($sfac) && $sfac ne "";
1213 my $ofac = $sfac;
1214 $sfac = uc($sfac);
1215 $sfac = 'LOG_'.$sfac unless $sfac =~ /^LOG_/;
1216 my $facility;
1217 my %badfac = map({("LOG_$_" => 1)}
1218 (qw(PID CONS ODELAY NDELAY NOWAIT PERROR FACMASK NFACILITIES PRIMASK LFMT)));
1219 eval "\$facility = Sys::Syslog::$sfac; 1" or die "invalid syslog facility: $ofac\n";
1220 die "invalid syslog facility: $ofac\n"
1221 if ($facility & ~0xf8) || ($facility >> 3) > 23 || $badfac{$sfac};
1222 tie *STDERR, 'OStream', $mode, $progname, $facility or die "tie failed";
1224 if ($quiet) {
1225 open STDOUT, '>', '/dev/null';
1226 } elsif ($inetd) {
1227 *STDOUT = *STDERR;
1230 my ($NAME, $INO);
1232 my $restart_file = $Girocco::Config::chroot.'/etc/taskd.restart';
1233 my $restart_active = 1;
1234 my $resumefd = $ENV{(SOCKFDENV)};
1235 delete $ENV{(SOCKFDENV)};
1236 if (defined($resumefd)) {{
1237 unless ($resumefd =~ /^(\d+)(?::(-?\d+))?$/) {
1238 warn "ignoring invalid ".SOCKFDENV." environment value (\"$resumefd\") -- bad format\n";
1239 $resumefd = undef;
1240 last;
1242 my $resumeino;
1243 ($resumefd, $resumeino) = ($1, $2);
1244 $resumefd += 0;
1245 unless (isfdopen($resumefd)) {
1246 warn "ignoring invalid ".SOCKFDENV." environment value -- fd \"$resumefd\" not open\n";
1247 $resumefd = undef;
1248 last;
1250 unless ($inetd) {
1251 unless (defined($resumeino)) {
1252 warn "ignoring invalid ".SOCKFDENV." environment value (\"$resumefd\") -- missing inode\n";
1253 POSIX::close($resumefd);
1254 $resumefd = undef;
1255 last;
1257 $resumeino += 0;
1258 my $sockloc = $Girocco::Config::chroot.'/etc/taskd.socket';
1259 my $slinode = (stat($sockloc))[1];
1260 unless (defined($slinode) && -S _) {
1261 warn "ignoring ".SOCKFDENV." environment value; socket file does not exist: $sockloc\n";
1262 POSIX::close($resumefd);
1263 $resumefd = undef;
1264 last;
1266 open Test, "<&$resumefd" or die "open: $!";
1267 my $sockname = getsockname Test;
1268 my $sockpath;
1269 $sockpath = unpack_sockaddr_un $sockname if $sockname && sockaddr_family($sockname) == AF_UNIX;
1270 close Test;
1271 if (!defined($resumeino) || !defined($sockpath) || $resumeino != $slinode || realpath($sockloc) ne realpath($sockpath)) {
1272 warn "ignoring ".SOCKFDENV." environment value; does not match socket file: $sockloc\n";
1273 POSIX::close($resumefd);
1274 $resumefd = undef;
1276 $INO = $resumeino;
1279 if ($inetd || defined($resumefd)) {
1280 my $fdopen = defined($resumefd) ? $resumefd : 0;
1281 open Server, "<&=$fdopen" or die "open: $!";
1282 setcloexec(\*Server) if $fdopen > $^F;
1283 my $sockname = getsockname Server;
1284 die "getsockname: $!" unless $sockname;
1285 die "socket already connected! must be 'wait' socket\n" if getpeername Server;
1286 die "getpeername: $!" unless $!{ENOTCONN};
1287 my $st = getsockopt Server, SOL_SOCKET, SO_TYPE;
1288 die "getsockopt(SOL_SOCKET, SO_TYPE): $!" unless $st;
1289 my $socktype = unpack('i', $st);
1290 die "stream socket required\n" unless defined $socktype && $socktype == SOCK_STREAM;
1291 die "AF_UNIX socket required\n" unless sockaddr_family($sockname) == AF_UNIX;
1292 $NAME = unpack_sockaddr_un $sockname;
1293 my $expected = $Girocco::Config::chroot.'/etc/taskd.socket';
1294 if (realpath($NAME) ne realpath($expected)) {
1295 $restart_active = 0;
1296 warn "listening on \"$NAME\" but expected \"$expected\", restart file disabled\n";
1298 my $mode = (stat($NAME))[2];
1299 die "stat: $!" unless $mode;
1300 $mode &= 07777;
1301 if (($mode & 0660) != 0660) {
1302 chmod(($mode|0660), $NAME) == 1 or die "chmod ug+rw \"$NAME\" failed: $!";
1304 } else {
1305 $NAME = $Girocco::Config::chroot.'/etc/taskd.socket';
1306 my $uaddr = sockaddr_un($NAME);
1308 socket(Server, PF_UNIX, SOCK_STREAM, 0) or die "socket failed: $!";
1309 die "already exists but not a socket: $NAME\n" if -e $NAME && ! -S _;
1310 if (-e _) {
1311 # Do not unlink another instance's active listen socket!
1312 socket(my $sfd, PF_UNIX, SOCK_STREAM, 0) or die "socket failed: $!";
1313 connect($sfd, $uaddr) || $!{EPROTOTYPE} and
1314 die "Live socket '$NAME' exists. Please make sure no other instance of taskd is running.\n";
1315 close($sfd);
1316 unlink($NAME);
1318 bind(Server, $uaddr) or die "bind failed: $!";
1319 listen(Server, SOMAXCONN) or die "listen failed: $!";
1320 chmod 0666, $NAME or die "chmod failed: $!";
1321 $INO = (stat($NAME))[1] or die "stat failed: $!";
1324 foreach my $throttle (@Girocco::Config::throttle_classes, @throttle_defaults) {
1325 my $classname = $throttle->{"name"};
1326 $classname or next;
1327 Throttle::GetClassInfo($classname, $throttle);
1330 sub _min {
1331 return $_[0] <= $_[1] ? $_[0] : $_[1];
1334 pipe($piperead, $pipewrite) or die "pipe failed: $!";
1335 setnonblock($piperead);
1336 select((select($pipewrite), $|=1)[0]);
1337 my $pipebuff = '';
1338 my $fdset_both = '';
1339 vec($fdset_both, fileno($piperead), 1) = 1;
1340 my $fdset_pipe = $fdset_both;
1341 vec($fdset_both, fileno(Server), 1) = 1;
1342 my $penalty = 0;
1343 my $t = time;
1344 my $penaltytime = $t;
1345 my $nextwakeup = $t + 60;
1346 my $nextstatus = undef;
1347 $nextstatus = $t + $statusintv if $statusintv;
1348 if ($restart_active) {
1349 unless (unlink($restart_file) || $!{ENOENT}) {
1350 $restart_active = 0;
1351 statmsg "restart file disabled could not unlink \"$restart_file\": $!";
1354 daemon(1, 1) or die "failed to daemonize: $!\n" if $daemon;
1355 my $starttime = time;
1356 my $endtime = $max_lifetime ? $starttime + $max_lifetime : 0;
1357 statmsg "listening on $NAME";
1358 while (1) {
1359 my ($rout, $eout, $nfound);
1360 do {
1361 my $wait;
1362 my $now = time;
1363 my $adjustpenalty = sub {
1364 if ($penaltytime < $now) {
1365 my $credit = $now - $penaltytime;
1366 $penalty = $penalty > $credit ? $penalty - $credit : 0;
1367 $penaltytime = $now;
1370 if (defined($nextstatus) && $now >= $nextstatus) {
1371 unless ($idlestatus && !$children && (!$idleintv || $now - $idlestatus < $idleintv)) {
1372 my $statmsg = "STATUS: $children active";
1373 my @running = ();
1374 if ($children) {
1375 my @stats = ();
1376 my $cnt = 0;
1377 foreach my $cls (sort(Throttle::GetClassList())) {
1378 my $inf = Throttle::GetClassInfo($cls);
1379 if ($inf->{'total'}) {
1380 $cnt += $inf->{'total'};
1381 push(@stats, substr(lc($cls),0,1)."=".
1382 $inf->{'total'}.'/'.$inf->{'active'});
1385 push(@stats, "?=".($children-$cnt)) if @stats && $cnt < $children;
1386 $statmsg .= " (".join(" ",@stats).")" if @stats;
1387 foreach (Throttle::GetRunningPids()) {
1388 my ($cls, $ts, $desc) = Throttle::GetPidInfo($_);
1389 next unless $ts;
1390 push(@running, "[${cls}::$desc] ".duration($now-$ts));
1393 my $idlesecs;
1394 $statmsg .= ", idle " . duration($idlesecs)
1395 if !$children && ($idlesecs = $now - $idlestart) >= 2;
1396 statmsg $statmsg;
1397 statmsg "STATUS: currently running: ".join(", ", @running)
1398 if @running;
1399 $idlestatus = $now if !$children;
1401 $nextstatus += $statusintv while $nextstatus <= $now;
1403 $nextwakeup += 60, $now = time while ($wait = $nextwakeup - $now) <= 0;
1404 $wait = _min($wait, (Throttle::ServiceQueue()||60));
1405 &$adjustpenalty; # this prevents ignoring accept when we shouldn't
1406 my $fdset;
1407 if ($penalty <= $maxspawn) {
1408 $fdset = $fdset_both;
1409 } else {
1410 $fdset = $fdset_pipe;
1411 $wait = $penalty - $maxspawn if $wait > $penalty - $maxspawn;
1413 $nfound = select($rout=$fdset, undef, $eout=$fdset, $wait);
1414 logmsg("select failed: $!"), exit(1) unless $nfound >= 0 || $!{EINTR} || $!{EAGAIN};
1415 my $reaped;
1416 Throttle::RemoveSupplicant($reaped) while ($reaped = shift(@reapedpids));
1417 $now = time;
1418 &$adjustpenalty; # this prevents banking credits for elapsed time
1419 if (!$children && !$nfound && $restart_active && (($endtime && $now >= $endtime) || -e $restart_file)) {
1420 statmsg "RESTART: restart requested; max lifetime ($max_lifetime) exceeded" if $endtime && $now >= $endtime;
1421 $SIG{CHLD} = sub {};
1422 my $restarter = schedule_jobd_restart($inetd);
1423 if (defined($restarter) && !$restarter) {
1424 statmsg "RESTART: restart requested; retrying failed scheduling of jobd restart: $!";
1425 sleep 2; # *cough*
1426 $restarter = schedule_jobd_restart;
1427 if (!defined($restarter)) {
1428 statmsg "RESTART: restart requested; reschedule skipped jobd no longer running";
1429 } elsif (defined($restarter) && !$restarter) {
1430 statmsg "RESTART: restart requested; retry of jobd restart scheduling failed, skipping jobd restart: $!";
1431 $restarter = undef;
1434 if ($inetd) {
1435 statmsg "RESTART: restart requested; now exiting for inetd restart";
1436 statmsg "RESTART: restart requested; jobd restart scheduled in 5 seconds" if $restarter;
1437 sleep 2; # *cough*
1438 exit 0;
1439 } else {
1440 statmsg "RESTART: restart requested; now restarting";
1441 statmsg "RESTART: restart requested; jobd restart scheduled in 5 seconds" if $restarter;
1442 setnoncloexec(\*Server);
1443 $reexec->setenv(SOCKFDENV, fileno(Server).":$INO");
1444 $reexec->reexec($same_pid);
1445 setcloexec(\*Server) if fileno(Server) > $^F;
1446 statmsg "RESTART: continuing after failed restart: $!";
1447 chdir "/";
1448 cancel_jobd_restart($restarter) if $restarter;
1449 statmsg "RESTART: scheduled jobd restart has been cancelled" if $restarter;
1450 $SIG{CHLD} = \&REAPER;
1453 if ($idle_timeout && !$children && !$nfound && $now - $idlestart >= $idle_timeout) {
1454 statmsg "idle timeout (@{[duration($idle_timeout)]}) exceeded now exiting";
1455 exit 0;
1457 } while $nfound < 1;
1458 my $reout = $rout | $eout;
1459 if (vec($reout, fileno($piperead), 1)) {{
1460 my $nloff = -1;
1462 my $bytes;
1463 do {$bytes = sysread($piperead, $pipebuff, 512, length($pipebuff))}
1464 while (!defined($bytes) && $!{EINTR});
1465 last if !defined($bytes) && $!{EAGAIN};
1466 die "sysread failed: $!" unless defined $bytes;
1467 # since we always keep a copy of $pipewrite open EOF is fatal
1468 die "sysread returned EOF on pipe read" unless $bytes;
1469 $nloff = index($pipebuff, "\n", 0);
1470 if ($nloff < 0 && length($pipebuff) >= 512) {
1471 $pipebuff = '';
1472 print STDERR "discarding 512 bytes of control pipe data with no \\n found\n";
1474 redo unless $nloff >= 0;
1476 last unless $nloff >= 0;
1477 do {
1478 my $msg = substr($pipebuff, 0, $nloff);
1479 substr($pipebuff, 0, $nloff + 1) = '';
1480 $nloff = index($pipebuff, "\n", 0);
1481 process_pipe_msg($msg) if length($msg);
1482 } while $nloff >= 0;
1483 redo;
1485 next unless vec($reout, fileno(Server), 1);
1486 unless (accept(Client, Server)) {
1487 logmsg "accept failed: $!" unless $!{EINTR};
1488 next;
1490 logmsg "connection on $NAME";
1491 ++$penalty;
1492 spawn sub {
1493 my $inp = <STDIN>;
1494 $inp = <STDIN> if defined($inp) && $inp eq "\n";
1495 chomp $inp if defined($inp);
1496 # ignore empty and "nop" connects
1497 defined($inp) && $inp ne "" && $inp ne "nop" or exit 0;
1498 my ($cmd, $arg) = $inp =~ /^([a-zA-Z][a-zA-Z0-9._+-]*)(?:\s+(.*))?$/;
1499 defined($arg) or $arg = '';
1500 if ($cmd eq 'ref-changes') {
1501 ref_changes($arg);
1502 } elsif ($cmd eq 'clone') {
1503 clone($arg);
1504 } elsif ($cmd eq 'ref-change') {
1505 ref_change($arg);
1506 } elsif ($cmd eq 'throttle') {
1507 throttle($arg);
1508 } else {
1509 statmsg "ignoring unknown command: $cmd";
1510 exit 3;
1513 close Client;
1517 ## -------------
1518 ## Documentation
1519 ## -------------
1522 __END__
1524 =head1 NAME
1526 taskd.pl - Perform Girocco service tasks
1528 =head1 SYNOPSIS
1530 taskd.pl [options]
1532 Options:
1533 -h | --help detailed instructions
1534 -q | --quiet run quietly
1535 --no-quiet do not run quietly
1536 -P | --progress show occasional status updates
1537 -i | --inetd run as inetd unix stream wait service
1538 implies --quiet --syslog
1539 -t SECONDS | --idle-timeout=SECONDS how long to wait idle before exiting
1540 requires --inetd
1541 --daemon become a background daemon
1542 implies --quiet --syslog
1543 --max-lifetime=SECONDS how long before graceful restart
1544 default is 1 week, 0 disables
1545 -s | --syslog[=facility] send messages to syslog instead of
1546 stderr but see --stderr
1547 enabled by --inetd
1548 --no-syslog do not send message to syslog
1549 --stderr always send messages to stderr too
1550 --abbrev=n abbreviate hashes to n (default is 8)
1551 --show-fast-forward-info show fast-forward info (default is on)
1552 --no-show-fast-forward-info disable showing fast-forward info
1553 --same-pid keep same pid during graceful restart
1554 --no-same-pid do not keep same pid on graceful rstrt
1555 --status-interval=MINUTES status update interval (default 1)
1556 --idle-status-interval=IDLEMINUTES idle status interval (default 60)
1558 =head1 OPTIONS
1560 =over 8
1562 =item B<--help>
1564 Print the full description of taskd.pl's options.
1566 =item B<--quiet>
1568 Suppress non-error messages, e.g. for use when running this task as an inetd
1569 service. Enabled by default by --inetd.
1571 =item B<--no-quiet>
1573 Enable non-error messages. When running in --inetd mode these messages are
1574 sent to STDERR instead of STDOUT.
1576 =item B<--progress>
1578 Show information about the current status of the task operation occasionally.
1579 This is automatically enabled if --quiet is not given.
1581 =item B<--inetd>
1583 Run as an inetd wait service. File descriptor 0 must be an unconnected unix
1584 stream socket ready to have accept called on it. To be useful, the unix socket
1585 should be located at "$Girocco::Config::chroot/etc/taskd.socket". A warning
1586 will be issued if the socket is not in the expected location. Socket file
1587 permissions will be adjusted if necessary and if they cannot be taskd.pl will
1588 die. The --inetd option also enables the --quiet and --syslog options but
1589 --no-quiet and --no-syslog may be used to alter that.
1591 The correct specification for the inetd socket is a "unix" protocol "stream"
1592 socket in "wait" mode with user and group writable permissions (0660). An
1593 attempt will be made to alter the socket's file mode if needed and if that
1594 cannot be accomplished taskd.pl will die.
1596 Although most inetd stream services run in nowait mode, taskd.pl MUST be run
1597 in wait mode and will die if the passed in socket is already connected.
1599 Note that while *BSD's inetd happily supports unix sockets (and so does
1600 Darwin's launchd), neither xinetd nor GNU's inetd supports unix sockets.
1601 However, systemd does seem to.
1603 =item B<--idle-timeout=SECONDS>
1605 Only permitted when running in --inetd mode. After SECONDS of inactivity
1606 (i.e. all outstanding tasks have completed and no new requests have come in)
1607 exit normally. The default is no timeout at all (a SECONDS value of 0).
1608 Note that it may actually take up to SECONDS+60 for the idle exit to occur.
1610 =item B<--daemon>
1612 Fork and become a background daemon. Implies B<--syslog> and B<--quiet> (which
1613 can be altered by subsequent B<--no-syslog> and/or B<--no-quiet> options).
1614 Also implies B<--no-same-pid>, but since graceful restarts work by re-exec'ing
1615 taskd.pl with all of its original arguments, using B<--same-pid> won't really
1616 be effective with B<--daemon> since although it will cause the graceful restart
1617 exec to happen from the same pid, when the B<--daemon> option is subsequently
1618 processed it will end up in a new pid anyway.
1620 =item B<--max-lifetime=SECONDS>
1622 After taskd has been running for SECONDS of realtime, it will behave as though
1623 a graceful restart has been requested. A graceful restart takes place the
1624 next time taskd becomes idle (which may require up to 60 seconds to notice).
1625 If jobd is running when a graceful restart occurs, then jabd will also receive
1626 a graceful restart request at that time. The default value is 1 week (604800),
1627 set to 0 to disable.
1629 =item B<--syslog[=facility]>
1631 Normally error output is sent to STDERR. With this option it's sent to
1632 syslog instead. Note that when running in --inetd mode non-error output is
1633 also affected by this option as it's sent to STDERR in that case. If
1634 not specified, the default for facility is LOG_USER. Facility names are
1635 case-insensitive and the leading 'LOG_' is optional. Messages are logged
1636 with the LOG_NOTICE priority.
1638 =item B<--no-syslog>
1640 Send error message output to STDERR but not syslog.
1642 =item B<--stderr>
1644 Always send error message output to STDERR. If --syslog is in effect then
1645 a copy will also be sent to syslog. In --inetd mode this applies to non-error
1646 messages as well.
1648 =item B<--abbrev=n>
1650 Abbreviate displayed hash values to only the first n hexadecimal characters.
1651 The default is 8 characters. Set to 0 for no abbreviation at all.
1653 =item B<--show-fast-forward-info>
1655 Instead of showing ' -> ' in ref-change/ref-notify update messages, show either
1656 '..' for a fast-forward, creation or deletion or '...' for non-fast-forward.
1657 This requires running an extra git command for each ref update that is not a
1658 creation or deletion in order to determine whether or not it's a fast forward.
1660 =item B<--no-show-fast-forward-info>
1662 Disable showing of fast-forward information for ref-change/ref-notify update
1663 messages. Instead just show a ' -> ' indicator.
1665 =item B<--same-pid>
1667 When performing a graceful restart, perform the graceful restart exec from
1668 the same pid rather than switching to a new one. This is implied when
1669 I<--daemon> is I<NOT> used.
1671 =item B<--no-same-pid>
1673 When performing a graceful restart, perform the graceful restart exec after
1674 switching to a new pid. This is implied when I<--daemon> I<IS> used.
1676 =item B<--status-interval=MINUTES>
1678 If progress is enabled (with --progress or by default if no --inetd or --quiet)
1679 status updates are shown at each MINUTES interval. Setting the interval to 0
1680 disables them entirely even with --progress.
1682 =item B<--idle-status-interval=IDLEMINUTES>
1684 Two consecutive "idle" status updates with no intervening activity will not be
1685 shown unless IDLEMINUTES have elapsed between them. The default is 60 minutes.
1686 Setting the interval to 0 prevents any consecutive idle updates (with no
1687 activity between them) from appearing at all.
1689 =back
1691 =head1 DESCRIPTION
1693 taskd.pl is Girocco's service request servant; it listens for service requests
1694 such as new clone requests and ref update notifications and spawns a task to
1695 perform the requested action.
1697 =cut