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.
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
39 use POSIX
":sys_wait_h";
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 = (
73 #maxproc => max(5, cpucount + maxjobs), # this is the default
74 #maxjobs => max(1, int(cpucount / 4)) , # this is the default
97 my $progname = basename
($0);
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;
110 my $hdr = "[@{[scalar localtime]}] $progname $$: ";
112 $OStream::only
= 2; # STDERR only
114 $OStream::only
= 1; # syslog only
116 $OStream::only
= 0; # back to default
123 return unless $progress;
124 my $hdr = "[@{[scalar localtime]}] $progname $$: ";
126 $OStream::only
= 2; # STDERR only
127 print STDERR
"$hdr@_\n";
128 $OStream::only
= 1; # syslog only
130 $OStream::only
= 0; # back to default
132 print STDERR
"$hdr@_\n";
138 return $secs unless defined($secs) && $secs >= 0;
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;
154 return undef unless defined($fd) && $fd >= 0;
155 my $result = POSIX
::dup
($fd);
156 POSIX
::close($result) if defined($result);
162 fcntl($fd, F_SETFD
, 0) or die "fcntl failed: $!";
167 fcntl($fd, F_SETFD
, FD_CLOEXEC
) or die "fcntl failed: $!";
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: $!";
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: $!";
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
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
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.
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)
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.
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.
292 # time of most recent successful call to AddSupplicant
295 # time of most recent proceed notification
298 # time of most recent throttle
299 my $lastthrottle = 0;
301 # time of most recent removal
304 # lifetime count of how many have been queued
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
317 # Returns an unordered list of currently registered class names
319 return keys(%classes);
323 return $_[0] if $_[0] >= $_[1];
328 my ($min, $val, $default) = @_;
330 if (defined($val) && $val =~ /^[+-]?\d+$/) {
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
344 # Returns a hash ref with info about the class on success
346 my ($classname, $init) = @_;
347 defined($classname) && $classname =~ /^[a-zA-Z][a-zA-Z0-9._+-]*$/
349 $classname = lc($classname);
351 if ($classes{$classname}) {
352 %info = %{$classes{$classname}};
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;
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
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.
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
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
420 $interval = 0 + $_[0] if defined($_[0]) && $_[0] =~ /^\d+$/;
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
434 return undef unless @queue; # if there's nothing queued, nothing to do
436 my $min = _max
(0, $interval - ($now - $lastproceed));
437 my $classmin = undef;
438 my $classchecked = 0;
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};
445 RemoveSupplicant
($pid, 1);
448 my $classinfo = $classes{$$procinfo[0]};
450 RemoveSupplicant
($pid, 1);
453 if (!$seenclass{$$procinfo[0]}) {
454 $seenclass{$$procinfo[0]} = 1;
456 if (!$classinfo->{'maxjobs'} || $classinfo->{'active'} < $classinfo->{'maxjobs'}) {
457 my $cmin = _max
(0, $classinfo->{'interval'} - ($now - $classinfo->{'lastproceed'}));
458 if (!$cmin && !$min) {
460 $$procinfo[1] = $now;
461 splice(@queue, $i, 1);
464 $classinfo->{'lastproceed'} = $now;
465 ++$classinfo->{'active'};
466 kill("USR1", $pid) or RemoveSupplicant
($pid, 1);
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
482 my ($pid, $classname, $text, $noservice) = @_;
483 return -1 unless $pid && $pid =~ /^[1-9][0-9]*$/;
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);
491 if ($classinfo->{'maxproc'} && $classinfo->{'total'} >= $classinfo->{'maxproc'}) {
493 $lastthrottle = $now;
494 $classinfo->{'lastthrottle'} = $now;
499 $pid{$pid} = [$classname, 0, $text];
500 ++$classinfo->{'total'};
501 $classinfo->{'lastqueue'} = $now;
503 ServiceQueue
unless $noservice;
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+$/;
514 my $pidinfo = $pid{$pid};
515 $pidinfo or return -1;
521 for (my $i=0; $i<=$#queue; ++$i) {
522 if ($queue[$i] == $pid) {
523 splice(@queue, $i, 1);
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;
549 # http://pubs.opengroup.org/onlinepubs/000095399/utilities/trap.html
562 while (($waitedpid = waitpid(-1, WNOHANG
)) > 0) {
563 my $code = $?
& 0xffff;
564 $idlestart = time if !--$children;
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);
586 if (not defined $pid) {
587 logmsg
"cannot fork: $!";
590 $idlestart = time if !++$children;
593 return; # I'm the parent
596 close(Server
) unless fileno(Server
) == 0;
598 $SIG{'CHLD'} = sub {};
600 open STDIN
, "+<&Client" or die "can't dup client to stdin";
609 sub request_throttle
{
610 use POSIX
qw(sigprocmask sigsuspend SIG_SETMASK);
611 my $classname = shift;
614 Throttle
::GetClassInfo
($classname)
615 or return -1; # no such throttle class
621 my $setempty = POSIX
::SigSet
->new;
622 my $setfull = POSIX
::SigSet
->new;
623 $setempty->emptyset();
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) {
637 sigsuspend
($setempty);
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";
661 Girocco
::Project
::does_exist
($name, 1) or die "no such project: $name";
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: $!";
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;
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";
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%") {
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;
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";
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%") {
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)";
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 sleep 1 if $ran_mail_sh || $ran_git;
771 Girocco
::Notify
::ref_changes
($proj, $user, $statproc, \
%oldheads, @changes);
773 &$statproc(@
$_) foreach @changes;
780 my ($pid, $classname, $text) = split(/\s+/, $arg);
781 $pid =~ /^\d+/ or return 0; # invalid pid
783 $pid > 0 or return 0; # invalid pid
784 kill(0, $pid) || $!{EPERM
} or return 0; # no such process
785 Throttle
::GetClassInfo
($classname) or return 0; # no such throttle class
786 defined($text) && $text ne '' or return 0; # no text no service
794 pipe($waker, $wakew) or die "pipe failed: $!";
795 select((select($wakew),$|=1)[0]);
797 $SIG{'TERM'} = sub {$throttled = 1; syswrite($wakew, '!')};
798 $SIG{'USR1'} = sub {$proceed = 1; syswrite($wakew, '!')};
799 $SIG{'USR2'} = sub {$error = 1; syswrite($wakew, '!')};
800 $SIG{'PIPE'} = sub {$controldead = 1; syswrite($wakew, '!')};
801 select((select(STDIN
),$|=1)[0]);
803 logmsg
"throttle $pid $classname $text request";
804 # After writing we can expect a SIGTERM or SIGUSR1
805 print $pipewrite "\nthrottle $$ $classname $text\n";
807 # NOTE: the only way to detect the socket close is to read all the
808 # data until EOF is reached -- recv can be used to peek.
810 vec($v, fileno(STDIN
), 1) = 1;
811 vec($v, fileno($waker), 1) = 1;
812 setnonblock
(\
*STDIN
);
814 until ($controldead || $throttled || $proceed || $error || $suppdead) {
816 select($r=$v, undef, $e=$v, 30);
817 my ($bytes, $discard);
818 do {$bytes = sysread($waker, $discard, 512)} while (defined($bytes) && $bytes > 0);
819 do {$bytes = sysread(STDIN
, $discard, 4096)} while (defined($bytes) && $bytes > 0);
820 $suppdead = 1 unless !defined($bytes) && $!{EAGAIN
};
821 print $pipewrite "\nkeepalive $$\n";
825 if ($throttled && !$suppdead) {
826 print STDIN
"throttled\n";
827 logmsg
"throttle $pid $classname $text throttled";
828 } elsif ($proceed && !$suppdead) {
829 print STDIN
"proceed\n";
830 logmsg
"throttle $pid $classname $text proceed";
831 $SIG{'TERM'} = 'DEFAULT';
832 # Stay alive until the child dies which we detect by EOF on STDIN
833 setnonblock
(\
*STDIN
);
834 until ($controldead || $suppdead) {
836 select($r=$v, undef, $e=$v, 30);
837 my ($bytes, $discard);
838 do {$bytes = sysread($waker, $discard, 512)} while (defined($bytes) && $bytes > 0);
839 do {$bytes = sysread(STDIN
, $discard, 512)} while (defined($bytes) && $bytes > 0);
840 $suppdead = 1 unless !defined($bytes) && $!{EAGAIN
};
841 print $pipewrite "\nkeepalive $$\n";
846 $prefix = "control" if $controldead && !$suppdead;
847 logmsg
"throttle $pid $classname $text ${prefix}died";
852 sub process_pipe_msg
{
853 my ($act, $pid, $cls, $text) = split(/\s+/, $_[0]);
854 if ($act eq "throttle") {
855 $pid =~ /^\d+$/ or return 0;
857 $pid > 0 or return 0; # invalid pid
858 kill(0, $pid) or return 0; # invalid pid
859 defined($cls) && $cls ne "" or kill('USR2', $pid), return 0;
860 defined($text) && $text ne "" or kill('USR2', $pid), return 0;
861 Throttle
::GetClassInfo
($cls) or kill('USR2', $pid), return 0;
862 # the AddSupplicant call could send SIGUSR1 before it returns
863 my $result = Throttle
::AddSupplicant
($pid, $cls, $text);
864 kill('USR2', $pid), return 0 if $result < 0;
865 kill('TERM', $pid), return 0 if $result > 0;
866 # $pid was added to class $cls and will receive SIGUSR1 when
867 # it's time for it to proceed
869 } elsif ($act eq "keepalive") {
870 # nothing to do although we could verify pid is valid and
871 # still in %Throttle::pids and send a SIGUSR2 if not, but
872 # really keepalive should just be ignored.
875 print STDERR
"discarding unknown pipe message \"$_[0]\"\n";
887 # Set to 1 for only syslog output (if enabled by mode)
888 # Set to 2 for only stderr output (if enabled by mode)
889 our $only = 0; # This is a hack
892 use Sys
::Syslog
qw(:DEFAULT :macros);
895 my ($fd, $data) = @_;
897 my $remaining = length($data);
899 my $bytes = POSIX
::write(
901 substr($data, $offset, $remaining),
903 next if !defined($bytes) && $!{EINTR
};
904 croak
"POSIX::write failed: $!" unless defined $bytes;
905 croak
"POSIX::write wrote 0 bytes" unless $bytes;
906 $remaining -= $bytes;
912 use POSIX
qw(STDERR_FILENO);
913 my ($self, $line) = @_;
914 $only = 0 unless defined($only);
915 writeall
(STDERR_FILENO
, $line) if $self->{'stderr'} && $only != 1;
916 substr($line, -1, 1) = '' if substr($line, -1, 1) eq "\n";
917 return unless length($line);
918 syslog
(LOG_NOTICE
, "%s", $line) if $self->{'syslog'} && $only != 2;
922 my $class = shift || 'OStream';
924 my $syslogname = shift;
925 my $syslogfacility = shift;
926 defined($syslogfacility) or $syslogfacility = LOG_USER
;
928 $self->{'syslog'} = $mode > 0;
929 $self->{'stderr'} = $mode <= 0 || $mode > 1;
930 $self->{'lastline'} = '';
931 if ($self->{'syslog'}) {
932 # Some Sys::Syslog have a stupid default setlogsock order
933 eval {Sys
::Syslog
::setlogsock
("native"); 1;} or
934 eval {Sys
::Syslog
::setlogsock
("unix");};
935 openlog
($syslogname, "ndelay,pid", $syslogfacility)
936 or croak
"Sys::Syslog::openlog failed: $!";
938 return bless $self, $class;
941 sub BINMODE
{return 1}
942 sub FILENO
{return undef}
948 my $template = shift;
949 return $self->PRINT(sprintf $template, @_);
954 my $data = join('', $self->{'lastline'}, @_);
956 while ((my $idx = index($data, "\n", $pos)) >= 0) {
958 my $line = substr($data, $pos, $idx - $pos);
959 substr($data, $pos, $idx - $pos) = '';
961 $self->dumpline($line);
963 $self->{'lastline'} = $data;
969 $self->dumpline($self->{'lastline'})
970 if length($self->{'lastline'});
976 my ($scalar, $length, $offset) = @_;
977 $scalar = '' if !defined($scalar);
978 $length = length($scalar) if !defined($length);
979 croak
"OStream::WRITE invalid length $length"
981 $offset = 0 if !defined($offset);
982 $offset += length($scalar) if $offset < 0;
983 croak
"OStream::WRITE invalid write offset"
984 if $offset < 0 || $offset > $length;
985 my $max = length($scalar) - $offset;
986 $length = $max if $length > $max;
987 $self->PRINT(substr($scalar, $offset, $length));
999 # returns pid of process that will schedule jobd.pl restart on success
1000 # returns 0 if fork or other system call failed with error in $!
1001 # returns undef if jobd.pl does not currently appear to be running (no lockfile)
1002 sub schedule_jobd_restart
{
1003 use POSIX
qw(_exit setpgid);
1005 my $jdlf = "/tmp/jobd-$Girocco::Config::tmpsuffix.lock";
1006 return undef unless -f
$jdlf;
1007 my $oldsigchld = $SIG{'CHLD'};
1008 defined($oldsigchld) or $oldsigchld = sub {};
1009 my ($read, $write, $read2, $write2);
1010 pipe($read, $write) or return 0;
1011 select((select($write),$|=1)[0]);
1012 if (!pipe($read2, $write2)) {
1018 select((select($write2),$|=1)[0]);
1019 $SIG{'CHLD'} = sub {};
1022 while (!defined($child) && $retries--) {
1024 sleep 1 unless defined($child) || !$retries;
1026 if (!defined($child)) {
1032 $SIG{'CHLD'} = $oldsigchld;
1035 # double fork the child
1040 while (!defined($child2) && $retries2--) {
1042 sleep 1 unless defined($child2) || !$retries2;
1044 if (!defined($child2)) {
1046 $ec = 255 unless $ec;
1047 print $write2 ":$ec";
1052 # pass new child pid up to parent and exit
1053 print $write2 $child2;
1057 # this is the grandchild
1062 my $result = <$read2>;
1064 chomp $result if defined($result);
1065 if (!defined($result) || $result !~ /^:?\d+$/) {
1066 # something's wrong with the child -- kill it
1067 kill(9, $child) && waitpid($child, 0);
1068 my $oldsigpipe = $SIG{'PIPE'};
1069 # make sure the grandchild, if any,
1070 # doesn't run the success proc
1071 $SIG{'PIPE'} = sub {};
1075 $SIG{'PIPE'} = defined($oldsigpipe) ?
1076 $oldsigpipe : 'DEFAULT';
1078 $SIG{'CHLD'} = $oldsigchld;
1081 if ($result =~ /^:(\d+)$/) {
1082 # fork failed in child, there is no grandchild
1088 $SIG{'CHLD'} = $oldsigchld;
1091 # reap the child and set $child to grandchild's pid
1096 # grandchild that actually initiates the jobd.pl restart
1099 open STDIN
, '<', '/dev/null';
1100 open STDOUT
, '>', '/dev/null';
1101 open STDERR
, '>', '/dev/null';
1105 my $result = setpgid
(0, 0);
1106 if (!defined($result)) {
1112 my $result = &$makepg;
1113 defined($result) or $result = &$makepg;
1114 defined($result) or $result = &$makepg;
1115 defined($result) or $result = &$makepg;
1118 my $result = <$read>;
1120 chomp $result if defined($result);
1121 if (!defined($result) || $result eq 0) {
1122 open JDLF
, '+<', $jdlf or _exit
(1);
1123 select((select(JDLF
),$|=1)[0]);
1124 print JDLF
"restart\n";
1125 truncate JDLF
, tell(JDLF
);
1132 $SIG{'CHLD'} = $oldsigchld;
1136 sub cancel_jobd_restart
{
1137 my $restarter = shift;
1138 return unless defined($restarter) && $restarter != 0;
1139 return -1 unless kill(0, $restarter);
1140 kill(9, $restarter) or die "failed to kill jobd restarter process (pid $restarter): $!\n";
1141 # we must not waitpid because $restarter was doubly forked and will
1142 # NOT send us a SIGCHLD when it terminates
1146 my $reexec = Girocco
::ExecUtil
->new;
1149 close(DATA
) if fileno(DATA
);
1151 Getopt
::Long
::Configure
('bundling');
1153 my $parse_res = GetOptions
(
1154 'help|?|h' => sub {pod2usage
(-verbose
=> 2, -exitval
=> 0)},
1155 'quiet|q' => \
$quiet,
1156 'no-quiet' => sub {$quiet = 0},
1157 'progress|P' => \
$progress,
1158 'inetd|i' => sub {$inetd = 1; $syslog = 1; $quiet = 1;},
1159 'idle-timeout|t=i' => \
$idle_timeout,
1160 'daemon' => sub {$daemon = 1; $syslog = 1; $quiet = 1;},
1161 'max-lifetime=i' => \
$max_lifetime,
1162 'syslog|s:s' => \
$sfac,
1163 'no-syslog' => sub {$syslog = 0; $sfac = undef;},
1164 'stderr' => \
$stderr,
1165 'abbrev=i' => \
$abbrev,
1166 'show-fast-forward-info' => \
$showff,
1167 'no-show-fast-forward-info' => sub {$showff = 0},
1168 'same-pid' => \
$same_pid,
1169 'no-same-pid' => sub {$same_pid = 0},
1170 'status-interval=i' => \
$stiv,
1171 'idle-status-interval=i' => \
$idiv,
1173 $same_pid = !$daemon unless defined($same_pid);
1174 $syslog = 1 if defined($sfac);
1175 $progress = 1 unless $quiet;
1176 $abbrev = 128 unless $abbrev > 0;
1177 pod2usage
(-msg
=> "--inetd and --daemon are incompatible") if ($inetd && $daemon);
1178 if (defined($idle_timeout)) {
1179 die "--idle-timeout must be a whole number\n" unless $idle_timeout =~ /^\d+$/;
1180 die "--idle-timeout may not be used without --inetd\n" unless $inetd;
1182 if (defined($max_lifetime)) {
1183 die "--max-lifetime must be a whole number\n" unless $max_lifetime =~ /^\d+$/;
1186 defined($max_lifetime) or $max_lifetime = 604800; # 1 week
1187 if (defined($stiv)) {
1188 die "--status-interval must be a whole number\n" unless $stiv =~ /^\d+$/;
1189 $statusintv = $stiv * 60;
1191 if (defined($idiv)) {
1192 die "--idle-status-interval must be a whole number\n" unless $idiv =~ /^\d+$/;
1193 $idleintv = $idiv * 60;
1196 open STDIN
, '<'.File
::Spec
->devnull or die "could not redirect STDIN to /dev/null\n" unless $inetd;
1197 open STDOUT
, '>&STDERR' if $inetd;
1199 use Sys
::Syslog
qw();
1202 $sfac = "user" unless defined($sfac) && $sfac ne "";
1205 $sfac = 'LOG_'.$sfac unless $sfac =~ /^LOG_/;
1207 my %badfac = map({("LOG_$_" => 1)}
1208 (qw(PID CONS ODELAY NDELAY NOWAIT PERROR FACMASK NFACILITIES PRIMASK LFMT)));
1209 eval "\$facility = Sys::Syslog::$sfac; 1" or die "invalid syslog facility: $ofac\n";
1210 die "invalid syslog facility: $ofac\n"
1211 if ($facility & ~0xf8) || ($facility >> 3) > 23 || $badfac{$sfac};
1212 tie
*STDERR
, 'OStream', $mode, $progname, $facility or die "tie failed";
1215 open STDOUT
, '>', '/dev/null';
1222 my $restart_file = $Girocco::Config
::chroot.'/etc/taskd.restart';
1223 my $restart_active = 1;
1224 my $resumefd = $ENV{(SOCKFDENV
)};
1225 delete $ENV{(SOCKFDENV
)};
1226 if (defined($resumefd)) {{
1227 unless ($resumefd =~ /^(\d+)(?::(-?\d+))?$/) {
1228 warn "ignoring invalid ".SOCKFDENV
." environment value (\"$resumefd\") -- bad format\n";
1233 ($resumefd, $resumeino) = ($1, $2);
1235 unless (isfdopen
($resumefd)) {
1236 warn "ignoring invalid ".SOCKFDENV
." environment value -- fd \"$resumefd\" not open\n";
1241 unless (defined($resumeino)) {
1242 warn "ignoring invalid ".SOCKFDENV
." environment value (\"$resumefd\") -- missing inode\n";
1243 POSIX
::close($resumefd);
1248 my $sockloc = $Girocco::Config
::chroot.'/etc/taskd.socket';
1249 my $slinode = (stat($sockloc))[1];
1250 unless (defined($slinode) && -S _
) {
1251 warn "ignoring ".SOCKFDENV
." environment value; socket file does not exist: $sockloc\n";
1252 POSIX
::close($resumefd);
1256 open Test
, "<&$resumefd" or die "open: $!";
1257 my $sockname = getsockname Test
;
1259 $sockpath = unpack_sockaddr_un
$sockname if $sockname && sockaddr_family
($sockname) == AF_UNIX
;
1261 if (!defined($resumeino) || !defined($sockpath) || $resumeino != $slinode || realpath
($sockloc) ne realpath
($sockpath)) {
1262 warn "ignoring ".SOCKFDENV
." environment value; does not match socket file: $sockloc\n";
1263 POSIX
::close($resumefd);
1269 if ($inetd || defined($resumefd)) {
1270 my $fdopen = defined($resumefd) ?
$resumefd : 0;
1271 open Server
, "<&=$fdopen" or die "open: $!";
1272 setcloexec
(\
*Server
) if $fdopen > $^F
;
1273 my $sockname = getsockname Server
;
1274 die "getsockname: $!" unless $sockname;
1275 die "socket already connected! must be 'wait' socket\n" if getpeername Server
;
1276 die "getpeername: $!" unless $!{ENOTCONN
};
1277 my $st = getsockopt Server
, SOL_SOCKET
, SO_TYPE
;
1278 die "getsockopt(SOL_SOCKET, SO_TYPE): $!" unless $st;
1279 my $socktype = unpack('i', $st);
1280 die "stream socket required\n" unless defined $socktype && $socktype == SOCK_STREAM
;
1281 die "AF_UNIX socket required\n" unless sockaddr_family
($sockname) == AF_UNIX
;
1282 $NAME = unpack_sockaddr_un
$sockname;
1283 my $expected = $Girocco::Config
::chroot.'/etc/taskd.socket';
1284 if (realpath
($NAME) ne realpath
($expected)) {
1285 $restart_active = 0;
1286 warn "listening on \"$NAME\" but expected \"$expected\", restart file disabled\n";
1288 my $mode = (stat($NAME))[2];
1289 die "stat: $!" unless $mode;
1291 if (($mode & 0660) != 0660) {
1292 chmod(($mode|0660), $NAME) == 1 or die "chmod ug+rw \"$NAME\" failed: $!";
1295 $NAME = $Girocco::Config
::chroot.'/etc/taskd.socket';
1296 my $uaddr = sockaddr_un
($NAME);
1298 socket(Server
, PF_UNIX
, SOCK_STREAM
, 0) or die "socket failed: $!";
1299 die "already exists but not a socket: $NAME\n" if -e
$NAME && ! -S _
;
1301 # Do not unlink another instance's active listen socket!
1302 socket(my $sfd, PF_UNIX
, SOCK_STREAM
, 0) or die "socket failed: $!";
1303 connect($sfd, $uaddr) || $!{EPROTOTYPE
} and
1304 die "Live socket '$NAME' exists. Please make sure no other instance of taskd is running.\n";
1308 bind(Server
, $uaddr) or die "bind failed: $!";
1309 listen(Server
, SOMAXCONN
) or die "listen failed: $!";
1310 chmod 0666, $NAME or die "chmod failed: $!";
1311 $INO = (stat($NAME))[1] or die "stat failed: $!";
1314 foreach my $throttle (@Girocco::Config
::throttle_classes
, @throttle_defaults) {
1315 my $classname = $throttle->{"name"};
1317 Throttle
::GetClassInfo
($classname, $throttle);
1321 return $_[0] <= $_[1] ?
$_[0] : $_[1];
1324 pipe($piperead, $pipewrite) or die "pipe failed: $!";
1325 setnonblock
($piperead);
1326 select((select($pipewrite), $|=1)[0]);
1328 my $fdset_both = '';
1329 vec($fdset_both, fileno($piperead), 1) = 1;
1330 my $fdset_pipe = $fdset_both;
1331 vec($fdset_both, fileno(Server
), 1) = 1;
1334 my $penaltytime = $t;
1335 my $nextwakeup = $t + 60;
1336 my $nextstatus = undef;
1337 $nextstatus = $t + $statusintv if $statusintv;
1338 if ($restart_active) {
1339 unless (unlink($restart_file) || $!{ENOENT
}) {
1340 $restart_active = 0;
1341 statmsg
"restart file disabled could not unlink \"$restart_file\": $!";
1344 daemon
(1, 1) or die "failed to daemonize: $!\n" if $daemon;
1345 my $starttime = time;
1346 my $endtime = $max_lifetime ?
$starttime + $max_lifetime : 0;
1347 statmsg
"listening on $NAME";
1349 my ($rout, $eout, $nfound);
1353 my $adjustpenalty = sub {
1354 if ($penaltytime < $now) {
1355 my $credit = $now - $penaltytime;
1356 $penalty = $penalty > $credit ?
$penalty - $credit : 0;
1357 $penaltytime = $now;
1360 if (defined($nextstatus) && $now >= $nextstatus) {
1361 unless ($idlestatus && !$children && (!$idleintv || $now - $idlestatus < $idleintv)) {
1362 my $statmsg = "STATUS: $children active";
1367 foreach my $cls (sort(Throttle
::GetClassList
())) {
1368 my $inf = Throttle
::GetClassInfo
($cls);
1369 if ($inf->{'total'}) {
1370 $cnt += $inf->{'total'};
1371 push(@stats, substr(lc($cls),0,1)."=".
1372 $inf->{'total'}.'/'.$inf->{'active'});
1375 push(@stats, "?=".($children-$cnt)) if @stats && $cnt < $children;
1376 $statmsg .= " (".join(" ",@stats).")" if @stats;
1377 foreach (Throttle
::GetRunningPids
()) {
1378 my ($cls, $ts, $desc) = Throttle
::GetPidInfo
($_);
1380 push(@running, "[${cls}::$desc] ".duration
($now-$ts));
1384 $statmsg .= ", idle " . duration
($idlesecs)
1385 if !$children && ($idlesecs = $now - $idlestart) >= 2;
1387 statmsg
"STATUS: currently running: ".join(", ", @running)
1389 $idlestatus = $now if !$children;
1391 $nextstatus += $statusintv while $nextstatus <= $now;
1393 $nextwakeup += 60, $now = time while ($wait = $nextwakeup - $now) <= 0;
1394 $wait = _min
($wait, (Throttle
::ServiceQueue
()||60));
1395 &$adjustpenalty; # this prevents ignoring accept when we shouldn't
1397 if ($penalty <= $maxspawn) {
1398 $fdset = $fdset_both;
1400 $fdset = $fdset_pipe;
1401 $wait = $penalty - $maxspawn if $wait > $penalty - $maxspawn;
1403 $nfound = select($rout=$fdset, undef, $eout=$fdset, $wait);
1404 logmsg
("select failed: $!"), exit(1) unless $nfound >= 0 || $!{EINTR
} || $!{EAGAIN
};
1406 Throttle
::RemoveSupplicant
($reaped) while ($reaped = shift(@reapedpids));
1408 &$adjustpenalty; # this prevents banking credits for elapsed time
1409 if (!$children && !$nfound && $restart_active && (($endtime && $now >= $endtime) || -e
$restart_file)) {
1410 statmsg
"RESTART: restart requested; max lifetime ($max_lifetime) exceeded" if $endtime && $now >= $endtime;
1411 $SIG{CHLD
} = sub {};
1412 my $restarter = schedule_jobd_restart
($inetd);
1413 if (defined($restarter) && !$restarter) {
1414 statmsg
"RESTART: restart requested; retrying failed scheduling of jobd restart: $!";
1416 $restarter = schedule_jobd_restart
;
1417 if (!defined($restarter)) {
1418 statmsg
"RESTART: restart requested; reschedule skipped jobd no longer running";
1419 } elsif (defined($restarter) && !$restarter) {
1420 statmsg
"RESTART: restart requested; retry of jobd restart scheduling failed, skipping jobd restart: $!";
1425 statmsg
"RESTART: restart requested; now exiting for inetd restart";
1426 statmsg
"RESTART: restart requested; jobd restart scheduled in 5 seconds" if $restarter;
1430 statmsg
"RESTART: restart requested; now restarting";
1431 statmsg
"RESTART: restart requested; jobd restart scheduled in 5 seconds" if $restarter;
1432 setnoncloexec
(\
*Server
);
1433 $reexec->setenv(SOCKFDENV
, fileno(Server
).":$INO");
1434 $reexec->reexec($same_pid);
1435 setcloexec
(\
*Server
) if fileno(Server
) > $^F
;
1436 statmsg
"RESTART: continuing after failed restart: $!";
1438 cancel_jobd_restart
($restarter) if $restarter;
1439 statmsg
"RESTART: scheduled jobd restart has been cancelled" if $restarter;
1440 $SIG{CHLD
} = \
&REAPER
;
1443 if ($idle_timeout && !$children && !$nfound && $now - $idlestart >= $idle_timeout) {
1444 statmsg
"idle timeout (@{[duration($idle_timeout)]}) exceeded now exiting";
1447 } while $nfound < 1;
1448 my $reout = $rout | $eout;
1449 if (vec($reout, fileno($piperead), 1)) {{
1453 do {$bytes = sysread($piperead, $pipebuff, 512, length($pipebuff))}
1454 while (!defined($bytes) && $!{EINTR
});
1455 last if !defined($bytes) && $!{EAGAIN
};
1456 die "sysread failed: $!" unless defined $bytes;
1457 # since we always keep a copy of $pipewrite open EOF is fatal
1458 die "sysread returned EOF on pipe read" unless $bytes;
1459 $nloff = index($pipebuff, "\n", 0);
1460 if ($nloff < 0 && length($pipebuff) >= 512) {
1462 print STDERR
"discarding 512 bytes of control pipe data with no \\n found\n";
1464 redo unless $nloff >= 0;
1466 last unless $nloff >= 0;
1468 my $msg = substr($pipebuff, 0, $nloff);
1469 substr($pipebuff, 0, $nloff + 1) = '';
1470 $nloff = index($pipebuff, "\n", 0);
1471 process_pipe_msg
($msg) if length($msg);
1472 } while $nloff >= 0;
1475 next unless vec($reout, fileno(Server
), 1);
1476 unless (accept(Client
, Server
)) {
1477 logmsg
"accept failed: $!" unless $!{EINTR
};
1480 logmsg
"connection on $NAME";
1484 $inp = <STDIN
> if defined($inp) && $inp eq "\n";
1485 chomp $inp if defined($inp);
1486 # ignore empty and "nop" connects
1487 defined($inp) && $inp ne "" && $inp ne "nop" or exit 0;
1488 my ($cmd, $arg) = $inp =~ /^([a-zA-Z][a-zA-Z0-9._+-]*)(?:\s+(.*))?$/;
1489 defined($arg) or $arg = '';
1490 if ($cmd eq 'ref-changes') {
1492 } elsif ($cmd eq 'clone') {
1494 } elsif ($cmd eq 'ref-change') {
1496 } elsif ($cmd eq 'throttle') {
1499 statmsg
"ignoring unknown command: $cmd";
1516 taskd.pl - Perform Girocco service tasks
1523 -h | --help detailed instructions
1524 -q | --quiet run quietly
1525 --no-quiet do not run quietly
1526 -P | --progress show occasional status updates
1527 -i | --inetd run as inetd unix stream wait service
1528 implies --quiet --syslog
1529 -t SECONDS | --idle-timeout=SECONDS how long to wait idle before exiting
1531 --daemon become a background daemon
1532 implies --quiet --syslog
1533 --max-lifetime=SECONDS how long before graceful restart
1534 default is 1 week, 0 disables
1535 -s | --syslog[=facility] send messages to syslog instead of
1536 stderr but see --stderr
1538 --no-syslog do not send message to syslog
1539 --stderr always send messages to stderr too
1540 --abbrev=n abbreviate hashes to n (default is 8)
1541 --show-fast-forward-info show fast-forward info (default is on)
1542 --no-show-fast-forward-info disable showing fast-forward info
1543 --same-pid keep same pid during graceful restart
1544 --no-same-pid do not keep same pid on graceful rstrt
1545 --status-interval=MINUTES status update interval (default 1)
1546 --idle-status-interval=IDLEMINUTES idle status interval (default 60)
1554 Print the full description of taskd.pl's options.
1558 Suppress non-error messages, e.g. for use when running this task as an inetd
1559 service. Enabled by default by --inetd.
1563 Enable non-error messages. When running in --inetd mode these messages are
1564 sent to STDERR instead of STDOUT.
1568 Show information about the current status of the task operation occasionally.
1569 This is automatically enabled if --quiet is not given.
1573 Run as an inetd wait service. File descriptor 0 must be an unconnected unix
1574 stream socket ready to have accept called on it. To be useful, the unix socket
1575 should be located at "$Girocco::Config::chroot/etc/taskd.socket". A warning
1576 will be issued if the socket is not in the expected location. Socket file
1577 permissions will be adjusted if necessary and if they cannot be taskd.pl will
1578 die. The --inetd option also enables the --quiet and --syslog options but
1579 --no-quiet and --no-syslog may be used to alter that.
1581 The correct specification for the inetd socket is a "unix" protocol "stream"
1582 socket in "wait" mode with user and group writable permissions (0660). An
1583 attempt will be made to alter the socket's file mode if needed and if that
1584 cannot be accomplished taskd.pl will die.
1586 Although most inetd stream services run in nowait mode, taskd.pl MUST be run
1587 in wait mode and will die if the passed in socket is already connected.
1589 Note that while *BSD's inetd happily supports unix sockets (and so does
1590 Darwin's launchd), neither xinetd nor GNU's inetd supports unix sockets.
1591 However, systemd does seem to.
1593 =item B<--idle-timeout=SECONDS>
1595 Only permitted when running in --inetd mode. After SECONDS of inactivity
1596 (i.e. all outstanding tasks have completed and no new requests have come in)
1597 exit normally. The default is no timeout at all (a SECONDS value of 0).
1598 Note that it may actually take up to SECONDS+60 for the idle exit to occur.
1602 Fork and become a background daemon. Implies B<--syslog> and B<--quiet> (which
1603 can be altered by subsequent B<--no-syslog> and/or B<--no-quiet> options).
1604 Also implies B<--no-same-pid>, but since graceful restarts work by re-exec'ing
1605 taskd.pl with all of its original arguments, using B<--same-pid> won't really
1606 be effective with B<--daemon> since although it will cause the graceful restart
1607 exec to happen from the same pid, when the B<--daemon> option is subsequently
1608 processed it will end up in a new pid anyway.
1610 =item B<--max-lifetime=SECONDS>
1612 After taskd has been running for SECONDS of realtime, it will behave as though
1613 a graceful restart has been requested. A graceful restart takes place the
1614 next time taskd becomes idle (which may require up to 60 seconds to notice).
1615 If jobd is running when a graceful restart occurs, then jabd will also receive
1616 a graceful restart request at that time. The default value is 1 week (604800),
1617 set to 0 to disable.
1619 =item B<--syslog[=facility]>
1621 Normally error output is sent to STDERR. With this option it's sent to
1622 syslog instead. Note that when running in --inetd mode non-error output is
1623 also affected by this option as it's sent to STDERR in that case. If
1624 not specified, the default for facility is LOG_USER. Facility names are
1625 case-insensitive and the leading 'LOG_' is optional. Messages are logged
1626 with the LOG_NOTICE priority.
1628 =item B<--no-syslog>
1630 Send error message output to STDERR but not syslog.
1634 Always send error message output to STDERR. If --syslog is in effect then
1635 a copy will also be sent to syslog. In --inetd mode this applies to non-error
1640 Abbreviate displayed hash values to only the first n hexadecimal characters.
1641 The default is 8 characters. Set to 0 for no abbreviation at all.
1643 =item B<--show-fast-forward-info>
1645 Instead of showing ' -> ' in ref-change/ref-notify update messages, show either
1646 '..' for a fast-forward, creation or deletion or '...' for non-fast-forward.
1647 This requires running an extra git command for each ref update that is not a
1648 creation or deletion in order to determine whether or not it's a fast forward.
1650 =item B<--no-show-fast-forward-info>
1652 Disable showing of fast-forward information for ref-change/ref-notify update
1653 messages. Instead just show a ' -> ' indicator.
1657 When performing a graceful restart, perform the graceful restart exec from
1658 the same pid rather than switching to a new one. This is implied when
1659 I<--daemon> is I<NOT> used.
1661 =item B<--no-same-pid>
1663 When performing a graceful restart, perform the graceful restart exec after
1664 switching to a new pid. This is implied when I<--daemon> I<IS> used.
1666 =item B<--status-interval=MINUTES>
1668 If progress is enabled (with --progress or by default if no --inetd or --quiet)
1669 status updates are shown at each MINUTES interval. Setting the interval to 0
1670 disables them entirely even with --progress.
1672 =item B<--idle-status-interval=IDLEMINUTES>
1674 Two consecutive "idle" status updates with no intervening activity will not be
1675 shown unless IDLEMINUTES have elapsed between them. The default is 60 minutes.
1676 Setting the interval to 0 prevents any consecutive idle updates (with no
1677 activity between them) from appearing at all.
1683 taskd.pl is Girocco's service request servant; it listens for service requests
1684 such as new clone requests and ref update notifications and spawns a task to
1685 perform the requested action.