1 # Copyright (C) 2016-2020 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
4 # Like most Perl modules in public-inbox, this is internal and
5 # NOT subject to any stability guarantees! It is only documented
8 # This is used to limit the number of processes spawned by the
9 # PSGI server, so it acts like a semaphore and queues up extra
10 # commands to be run if currently at the limit. Multiple "limiters"
11 # may be configured which give inboxes different channels to
12 # operate in. This can be useful to ensure smaller inboxes can
13 # be cloned while cloning of large inboxes is maxed out.
15 # This does not depend on PublicInbox::DS or any other external
16 # scheduling mechanism, you just need to call start() and finish()
17 # appropriately. However, public-inbox-httpd (which uses PublicInbox::DS)
18 # will be able to schedule this based on readability of stdout from
19 # the spawned process. See GitHTTPBackend.pm and SolverGit.pm for
20 # usage examples. It does not depend on any form of threading.
22 # This is useful for scheduling CGI execution of both long-lived
23 # git-http-backend(1) process (for "git clone") as well as short-lived
24 # processes such as git-apply(1).
26 package PublicInbox::Qspawn;
29 use PublicInbox::Spawn qw(popen_rd);
31 # n.b.: we get EAGAIN with public-inbox-httpd, and EINTR on other PSGI servers
32 use Errno qw(EAGAIN EINTR);
36 # declares a command to spawn (but does not spawn it).
37 # $cmd is the command to spawn
38 # $cmd_env is the environ for the child process (not PSGI env)
39 # $opt can include redirects and perhaps other process spawning options
41 my ($class, $cmd, $cmd_env, $opt) = @_;
42 bless { args => [ $cmd, $cmd_env, $opt ] }, $class;
46 my ($self, $start_cb, $limiter) = @_;
48 my ($cmd, $cmd_env, $opt) = @{delete $self->{args}};
49 my %o = %{$opt || {}};
50 $self->{limiter} = $limiter;
51 foreach my $k (PublicInbox::Spawn::RLIMITS()) {
52 if (defined(my $rlimit = $limiter->{$k})) {
56 $self->{cmd} = $o{quiet} ? undef : $cmd;
58 # popen_rd may die on EMFILE, ENFILE
59 ($self->{rpipe}, $self->{pid}) = popen_rd($cmd, $cmd_env, \%o);
61 die "E: $!" unless defined($self->{pid});
63 $limiter->{running}++;
64 $start_cb->($self); # EPOLL_CTL_ADD may ENOSPC/ENOMEM
66 finish($self, $@) if $@;
70 my ($child_error) = @_; # typically $?
71 my $exitstatus = ($child_error >> 8) or return;
72 my $sig = $child_error & 127;
73 my $msg = "exit status=$exitstatus";
74 $msg .= " signal=$sig" if $sig;
80 $env->{'psgi.errors'}->print($msg, "\n");
84 my ($self, $err) = @_;
86 my ($env, $qx_cb, $qx_arg, $qx_buf) =
87 delete @$self{qw(psgi_env qx_cb qx_arg qx_buf)};
89 # done, spawn whatever's in the queue
90 my $limiter = $self->{limiter};
91 my $running = --$limiter->{running};
93 if ($running < $limiter->{max}) {
94 if (my $next = shift(@{$limiter->{run_queue}})) {
95 _do_spawn(@$next, $limiter);
100 if (defined $self->{err}) {
101 $self->{err} .= "; $err";
105 if ($env && $self->{cmd}) {
106 log_err($env, join(' ', @{$self->{cmd}}) . ": $err");
110 eval { $qx_cb->($qx_buf, $qx_arg) };
111 } elsif (my $wcb = delete $env->{'qspawn.wcb'}) {
112 # have we started writing, yet?
113 require PublicInbox::WwwStatic;
114 $wcb->(PublicInbox::WwwStatic::r(500));
118 # callback for dwaitpid
119 sub waitpid_err ($$) {
120 my ($self, $pid) = @_;
121 my $xpid = delete $self->{pid};
124 if ($pid > 0) { # success!
125 $err = child_err($?);
126 } elsif ($pid < 0) { # ??? does this happen in our case?
127 $err = "W: waitpid($xpid, 0) => $pid: $!";
128 } # else should not be called with pid == 0
130 finalize($self, $err);
135 my $pid = $self->{pid};
136 # PublicInbox::DS may not be loaded
137 eval { PublicInbox::DS::dwaitpid($pid, \&waitpid_err, $self) };
138 # done if we're running in PublicInbox::DS::EventLoop
140 # non public-inbox-{httpd,nntpd} callers may block:
141 my $ret = waitpid($pid, 0);
142 waitpid_err($self, $ret);
147 my ($self, $err) = @_;
148 if (delete $self->{rpipe}) {
151 finalize($self, $err);
156 my ($self, $limiter, $start_cb) = @_;
157 if ($limiter->{running} < $limiter->{max}) {
158 _do_spawn($self, $start_cb, $limiter);
160 push @{$limiter->{run_queue}}, [ $self, $start_cb ];
164 sub psgi_qx_init_cb {
166 my $async = delete $self->{async};
168 my $qx_fh = $self->{qx_fh};
170 $r = sysread($self->{rpipe}, $buf, 65536);
172 $async->async_pass($self->{psgi_env}->{'psgix.io'},
174 } elsif (defined $r) {
175 $r ? (print $qx_fh $buf) : event_step($self, undef);
177 return if $! == EAGAIN; # try again when notified
178 goto reread if $! == EINTR;
179 event_step($self, $!);
185 if (my $async = $self->{psgi_env}->{'pi-httpd.async'}) {
186 # PublicInbox::HTTPD::Async->new(rpipe, $cb, cb_arg, $end_obj)
187 $self->{async} = $async->($self->{rpipe},
188 \&psgi_qx_init_cb, $self, $self);
189 # init_cb will call ->async_pass or ->close
190 } else { # generic PSGI
191 psgi_qx_init_cb($self) while $self->{qx_fh};
195 # Similar to `backtick` or "qx" ("perldoc -f qx"), it calls $qx_cb with
196 # the stdout of the given command when done; but respects the given limiter
197 # $env is the PSGI env. As with ``/qx; only use this when output is small
200 my ($self, $env, $limiter, $qx_cb, $qx_arg) = @_;
201 $self->{psgi_env} = $env;
203 open(my $qx_fh, '+>', \$qx_buf) or die; # PerlIO::scalar
204 $self->{qx_cb} = $qx_cb;
205 $self->{qx_arg} = $qx_arg;
206 $self->{qx_fh} = $qx_fh;
207 $self->{qx_buf} = \$qx_buf;
208 $limiter ||= $def_limiter ||= PublicInbox::Qspawn::Limiter->new(32);
209 start($self, $limiter, \&psgi_qx_start);
212 # this is called on pipe EOF to reap the process, may be called
213 # via PublicInbox::DS event loop OR via GetlineBody for generic
216 my ($self, $err) = @_; # $err: $!
217 log_err($self->{psgi_env}, "psgi_{return,qx} $err") if defined($err);
219 my ($fh, $qx_fh) = delete(@$self{qw(fh qx_fh)});
220 $fh->close if $fh; # async-only (psgi_return)
225 # typically used for reading CGI headers
226 # we must loop until EAGAIN for EPOLLET in HTTPD/Async.pm
227 # We also need to check EINTR for generic PSGI servers.
230 my $hdr_buf = $self->{hdr_buf};
231 my ($ph_cb, $ph_arg) = @{$self->{parse_hdr}};
233 my $r = sysread($self->{rpipe}, $$hdr_buf, 4096,
237 eval { $ret = $ph_cb->($total_rd, $hdr_buf, $ph_arg) };
239 log_err($self->{psgi_env}, "parse_hdr: $@");
240 $ret = [ 500, [], [ "Internal error\n" ] ];
243 # caller should notify us when it's ready:
244 return if $! == EAGAIN;
245 next if $! == EINTR; # immediate retry
246 log_err($self->{psgi_env}, "error reading header: $!");
247 $ret = [ 500, [], [ "Internal error\n" ] ];
249 } until (defined $ret);
250 delete $self->{parse_hdr}; # done parsing headers
254 sub psgi_return_init_cb {
256 my $r = rd_hdr($self) or return;
257 my $env = $self->{psgi_env};
258 my $filter = delete $env->{'qspawn.filter'};
259 my $wcb = delete $env->{'qspawn.wcb'};
260 my $async = delete $self->{async};
261 if (scalar(@$r) == 3) { # error
263 # calls rpipe->close && ->event_step
266 $self->{rpipe}->close;
271 # done reading headers, handoff to read body
272 my $fh = $wcb->($r); # scalar @$r == 2
273 $fh = $filter->attach($fh) if $filter;
275 $async->async_pass($env->{'psgix.io'}, $fh,
276 delete($self->{hdr_buf}));
277 } else { # for synchronous PSGI servers
278 require PublicInbox::GetlineBody;
279 $r->[2] = PublicInbox::GetlineBody->new($self->{rpipe},
281 ${$self->{hdr_buf}}, $filter);
286 sub psgi_return_start { # may run later, much later...
288 if (my $async = $self->{psgi_env}->{'pi-httpd.async'}) {
289 # PublicInbox::HTTPD::Async->new(rpipe, $cb, $cb_arg, $end_obj)
290 $self->{async} = $async->($self->{rpipe},
291 \&psgi_return_init_cb, $self, $self);
292 } else { # generic PSGI
293 psgi_return_init_cb($self) while $self->{parse_hdr};
297 # Used for streaming the stdout of one process as a PSGI response.
299 # $env is the PSGI env.
300 # optional keys in $env:
301 # $env->{'qspawn.wcb'} - the write callback from the PSGI server
302 # optional, use this if you've already
303 # captured it elsewhere. If not given,
304 # psgi_return will return an anonymous
305 # sub for the PSGI server to call
307 # $env->{'qspawn.filter'} - filter object, responds to ->attach for
308 # pi-httpd.async and ->translate for generic
311 # $limiter - the Limiter object to use (uses the def_limiter if not given)
313 # $parse_hdr - Initial read function; often for parsing CGI header output.
314 # It will be given the return value of sysread from the pipe
315 # and a string ref of the current buffer. Returns an arrayref
316 # for PSGI responses. 2-element arrays in PSGI mean the
317 # body will be streamed, later, via writes (push-based) to
318 # psgix.io. 3-element arrays means the body is available
319 # immediately (or streamed via ->getline (pull-based)).
321 my ($self, $env, $limiter, $parse_hdr, $hdr_arg) = @_;
322 $self->{psgi_env} = $env;
323 $self->{hdr_buf} = \(my $hdr_buf = '');
324 $self->{parse_hdr} = [ $parse_hdr, $hdr_arg ];
325 $limiter ||= $def_limiter ||= PublicInbox::Qspawn::Limiter->new(32);
327 # the caller already captured the PSGI write callback from
328 # the PSGI server, so we can call ->start, here:
329 $env->{'qspawn.wcb'} and
330 return start($self, $limiter, \&psgi_return_start);
332 # the caller will return this sub to the PSGI server, so
333 # it can set the response callback (that is, for
334 # PublicInbox::HTTP, the chunked_wcb or identity_wcb callback),
335 # but other HTTP servers are supported:
337 $env->{'qspawn.wcb'} = $_[0];
338 start($self, $limiter, \&psgi_return_start);
342 package PublicInbox::Qspawn::Limiter;
347 my ($class, $max) = @_;
349 # 32 is same as the git-daemon connection limit
353 # RLIMIT_CPU => undef,
354 # RLIMIT_DATA => undef,
355 # RLIMIT_CORE => undef,
360 my ($self, $name, $config) = @_;
361 foreach my $rlim (PublicInbox::Spawn::RLIMITS()) {
364 $k = "publicinboxlimiter.$name.$k";
365 defined(my $v = $config->{$k}) or next;
366 my @rlimit = split(/\s*,\s*/, $v);
367 if (scalar(@rlimit) == 1) {
368 push @rlimit, $rlimit[0];
369 } elsif (scalar(@rlimit) != 2) {
370 warn "could not parse $k: $v\n";
372 eval { require BSD::Resource };
374 warn "BSD::Resource missing for $rlim";
377 foreach my $i (0..$#rlimit) {
378 next if $rlimit[$i] ne 'INFINITY';
379 $rlimit[$i] = BSD::Resource::RLIM_INFINITY();
381 $self->{$rlim} = \@rlimit;