1 # Copyright (C) 2020-2021 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
4 # base class for remote IPC calls and workqueues, requires Storable or Sereal
5 package PublicInbox::IPC;
8 use Carp qw(confess croak);
9 use PublicInbox::DS qw(dwaitpid);
10 use PublicInbox::Spawn;
11 use POSIX qw(WNOHANG);
12 use Socket qw(AF_UNIX MSG_EOR);
13 my $SEQPACKET = eval { Socket::SOCK_SEQPACKET() }; # portable enough?
14 use constant PIPE_BUF => $^O eq 'linux' ? 4096 : POSIX::_POSIX_PIPE_BUF();
16 # ->imports at BEGIN turns sereal_*_with_object into custom ops on 5.14+
17 # and eliminate method call overhead
20 require Sereal::Encoder;
21 require Sereal::Decoder;
22 Sereal::Encoder->import('sereal_encode_with_object');
23 Sereal::Decoder->import('sereal_decode_with_object');
24 ($enc, $dec) = (Sereal::Encoder->new, Sereal::Decoder->new);
28 if ($enc && $dec) { # should be custom ops
29 *freeze = sub ($) { sereal_encode_with_object $enc, $_[0] };
30 *thaw = sub ($) { sereal_decode_with_object $dec, $_[0], my $ret };
32 eval { # some distros have Storable as a separate package from Perl
34 Storable->import(qw(freeze thaw));
36 } // warn("Storable (part of Perl) missing: $@\n");
39 my $recv_cmd = PublicInbox::Spawn->can('recv_cmd4');
40 my $send_cmd = PublicInbox::Spawn->can('send_cmd4') // do {
41 require PublicInbox::CmdIPC4;
42 $recv_cmd //= PublicInbox::CmdIPC4->can('recv_cmd4');
43 PublicInbox::CmdIPC4->can('send_cmd4');
45 require PublicInbox::CmdIPC1;
46 $recv_cmd = PublicInbox::CmdIPC1->can('recv_cmd1');
47 PublicInbox::CmdIPC1->can('send_cmd1');
52 defined(my $len = <$r>) or return;
53 chop($len) eq "\n" or croak "no LF byte in $len";
54 defined(my $n = read($r, my $buf, $len)) or croak "read error: $!";
55 $n == $len or croak "short read: $n != $len";
61 my $buf = freeze($ref);
62 length($buf) . "\n" . $buf;
67 print $w _pack_rec($ref) or croak "print: $!";
70 sub ipc_return ($$$) {
71 my ($w, $ret, $exc) = @_;
72 _send_rec($w, $exc ? bless(\$exc, 'PublicInbox::IPC::Die') : $ret);
75 sub ipc_worker_loop ($$$) {
76 my ($self, $r_req, $w_res) = @_;
77 my ($rec, $wantarray, $sub, @args);
79 while ($rec = _get_rec($r_req)) {
80 ($wantarray, $sub, @args) = @$rec;
81 # no waiting if client doesn't care,
82 # this is the overwhelmingly likely case
83 if (!defined($wantarray)) {
84 eval { $self->$sub(@args) };
85 warn "$$ die: $@ (from nowait $sub)\n" if $@;
86 } elsif ($wantarray) {
87 my @ret = eval { $self->$sub(@args) };
88 ipc_return($w_res, \@ret, $@);
89 } else { # '' => wantscalar
90 my $ret = eval { $self->$sub(@args) };
91 ipc_return($w_res, \$ret, $@);
96 # starts a worker if Sereal or Storable is installed
97 sub ipc_worker_spawn {
98 my ($self, $ident, $oldset) = @_;
99 return unless $enc; # no Sereal or Storable
100 return if ($self->{-ipc_ppid} // -1) == $$; # idempotent
101 delete(@$self{qw(-ipc_req -ipc_res -ipc_ppid -ipc_pid)});
102 pipe(my ($r_req, $w_req)) or die "pipe: $!";
103 pipe(my ($r_res, $w_res)) or die "pipe: $!";
104 my $sigset = $oldset // PublicInbox::DS::block_signals();
106 $self->ipc_atfork_parent;
107 defined(my $pid = fork) or die "fork: $!";
109 eval { PublicInbox::DS->Reset };
110 $w_req = $r_res = undef;
111 $w_res->autoflush(1);
112 $SIG{$_} = 'IGNORE' for (qw(TERM INT QUIT));
114 PublicInbox::DS::sig_setmask($sigset);
115 my $on_destroy = $self->ipc_atfork_child;
116 eval { ipc_worker_loop($self, $r_req, $w_res) };
117 die "worker $ident PID:$$ died: $@\n" if $@;
120 PublicInbox::DS::sig_setmask($sigset) unless $oldset;
121 $r_req = $w_res = undef;
122 $w_req->autoflush(1);
123 $self->{-ipc_req} = $w_req;
124 $self->{-ipc_res} = $r_res;
125 $self->{-ipc_ppid} = $$;
126 $self->{-ipc_pid} = $pid;
129 sub ipc_worker_reap { # dwaitpid callback
130 my ($self, $pid) = @_;
131 warn "PID:$pid died with \$?=$?\n" if $?;
134 # for base class, override in sub classes
135 sub ipc_atfork_parent {}
136 sub ipc_atfork_child {}
138 # idempotent, can be called regardless of whether worker is active or not
139 sub ipc_worker_stop {
141 my ($pid, $ppid) = delete(@$self{qw(-ipc_pid -ipc_ppid)});
142 my ($w_req, $r_res) = delete(@$self{qw(-ipc_req -ipc_res)});
143 if (!$w_req && !$r_res) {
144 die "unexpected PID:$pid without IPC pipes" if $pid;
147 die 'no PID with IPC pipes' unless $pid;
148 $w_req = $r_res = undef;
150 return if $$ != $ppid;
151 dwaitpid($pid, \&ipc_worker_reap, $self);
154 # use this if we have multiple readers reading curl or "pigz -dc"
155 # and writing to the same store
158 require PublicInbox::Lock;
159 $self->{-ipc_lock} //= bless { lock_path => $f }, 'PublicInbox::Lock'
162 sub ipc_async_wait ($$) {
163 my ($self, $max) = @_; # max == -1 to wait for all
164 my $aif = $self->{-async_inflight} or return;
165 my $r_res = $self->{-ipc_res} or die 'BUG: no ipc_res';
166 while (my ($sub, $bytes, $cb, $cb_arg) = splice(@$aif, 0, 4)) {
167 my $ret = _get_rec($r_res) //
168 die "no response on $sub (req.size=$bytes)";
169 $self->{-async_inflight_bytes} -= $bytes;
171 eval { $cb->($cb_arg, $ret) };
172 warn "E: $sub callback error: $@\n" if $@;
173 return if --$max == 0;
177 # call $self->$sub(@args), on a worker if ipc_worker_spawn was used
179 my ($self, $sub, @args) = @_;
180 if (my $w_req = $self->{-ipc_req}) { # run in worker
181 my $ipc_lock = $self->{-ipc_lock};
182 my $lock = $ipc_lock ? $ipc_lock->lock_for_scope : undef;
183 if (defined(wantarray)) {
184 my $r_res = $self->{-ipc_res} or die 'BUG: no ipc_res';
185 ipc_async_wait($self, -1);
186 _send_rec($w_req, [ wantarray, $sub, @args ]);
187 my $ret = _get_rec($r_res) // die "no response on $sub";
188 die $$ret if ref($ret) eq 'PublicInbox::IPC::Die';
189 wantarray ? @$ret : $$ret;
190 } else { # likely, fire-and-forget into pipe
191 _send_rec($w_req, [ undef , $sub, @args ]);
193 } else { # run locally
199 my ($self, $sub, $sub_args, $cb, $cb_arg) = @_;
200 if (my $w_req = $self->{-ipc_req}) { # run in worker
201 my $rec = _pack_rec([ 1, $sub, @$sub_args ]);
202 my $cur_bytes = \($self->{-async_inflight_bytes} //= 0);
203 while (($$cur_bytes + length($rec)) > PIPE_BUF) {
204 ipc_async_wait($self, 1);
206 my $ipc_lock = $self->{-ipc_lock};
207 my $lock = $ipc_lock ? $ipc_lock->lock_for_scope : undef;
208 print $w_req $rec or croak "print: $!";
209 $$cur_bytes += length($rec);
210 push @{$self->{-async_inflight}},
211 $sub, length($rec), $cb, $cb_arg;
213 my $ret = [ eval { $self->$sub(@$sub_args) } ];
215 $ret = ( bless(\$exc, 'PublicInbox::IPC::Die') );
217 eval { $cb->($cb_arg, $ret) };
218 warn "E: $sub callback error: $@\n" if $@;
222 # needed when there's multiple IPC workers and the parent forking
223 # causes newer siblings to inherit older siblings sockets
224 sub ipc_sibling_atfork_child {
226 my ($pid, undef) = delete(@$self{qw(-ipc_pid -ipc_ppid)});
227 delete(@$self{qw(-ipc_req -ipc_res)});
228 $pid == $$ and die "BUG: $$ ipc_atfork_child called on itself";
231 sub wq_worker_loop ($) {
234 my $len = $self->{wq_req_len} // (4096 * 33);
235 my ($rec, $sub, @args);
236 my $s2 = $self->{-wq_s2} // die 'BUG: no -wq_s2';
237 local $SIG{PIPE} = sub {
238 die(bless(\"$_[0]", __PACKAGE__.'::PIPE')) if $sub;
240 until ($self->{-wq_quit}) {
241 my (@fds) = $recv_cmd->($s2, $buf, $len) or return; # EOF
243 my @m = @{$self->{wq_open_modes} // [qw( +<&= >&= >&= )]};
245 my $mode = shift(@m);
246 if (open(my $fh, $mode, $fd)) {
250 die "$$ open($mode$fd) (FD:$i): $!";
253 # Sereal dies, Storable returns undef
255 die "thaw error on buffer of size:".length($buf);
256 ($sub, @args) = @$rec;
257 eval { $self->$sub(@args) };
258 warn "$$ wq_worker: $@" if $@ && ref $@ ne __PACKAGE__.'::PIPE';
259 undef $sub; # quiet SIG{PIPE} handler
260 # need to close explicitly to avoid warnings after SIGPIPE
261 close($_) for (delete(@$self{0..2}));
265 sub wq_do { # always async
266 my ($self, $sub, $in, $out, $err, @args) = @_;
267 if (my $s1 = $self->{-wq_s1}) { # run in worker
268 $_ = fileno($_) for ($in, $out, $err);
269 $send_cmd->($s1, $in, $out, $err,
270 freeze([$sub, @args]), MSG_EOR);
272 @$self{0, 1, 2} = ($in, $out, $err);
273 eval { $self->$sub(@args) };
274 warn "wq_do: $@" if $@;
275 delete @$self{0, 1, 2};
279 sub _wq_worker_start ($$) {
280 my ($self, $oldset) = @_;
281 my $pid = fork // die "fork: $!";
283 eval { PublicInbox::DS->Reset };
284 close(delete $self->{-wq_s1});
285 delete $self->{qw(-wq_workers -wq_quit -wq_ppid)};
286 my $quit = sub { $self->{-wq_quit} = 1 };
287 $SIG{$_} = $quit for (qw(TERM INT QUIT));
288 $SIG{$_} = 'IGNORE' for (qw(TTOU TTIN));
289 local $0 = $self->{-wq_ident};
290 PublicInbox::DS::sig_setmask($oldset);
291 my $on_destroy = $self->ipc_atfork_child;
292 eval { wq_worker_loop($self) };
293 warn "worker $self->{-wq_ident} PID:$$ died: $@" if $@;
296 $self->{-wq_workers}->{$pid} = \undef;
300 # starts workqueue workers if Sereal or Storable is installed
301 sub wq_workers_start {
302 my ($self, $ident, $nr_workers, $oldset) = @_;
303 ($enc && $send_cmd && $recv_cmd && defined($SEQPACKET)) or return;
304 return if $self->{-wq_s1}; # idempotent
306 socketpair($s1, $s2, AF_UNIX, $SEQPACKET, 0) or die "socketpair: $!";
307 $self->ipc_atfork_parent;
309 my $sigset = $oldset // PublicInbox::DS::block_signals();
310 $self->{-wq_workers} = {};
311 $self->{-wq_ident} = $ident;
312 $self->{-wq_s1} = $s1;
313 $self->{-wq_s2} = $s2;
314 _wq_worker_start($self, $sigset) for (1..$nr_workers);
315 PublicInbox::DS::sig_setmask($sigset) unless $oldset;
316 $self->{-wq_ppid} = $$;
319 sub wq_worker_incr { # SIGTTIN handler
320 my ($self, $oldset) = @_;
321 $self->{-wq_s2} or return;
322 $self->ipc_atfork_parent;
323 my $sigset = $oldset // PublicInbox::DS::block_signals();
324 _wq_worker_start($self, $sigset);
325 PublicInbox::DS::sig_setmask($sigset) unless $oldset;
328 sub wq_exit { # wakes up wq_worker_decr_wait
329 send($_[0]->{-wq_s2}, $$, MSG_EOR) // die "$$ send: $!";
333 sub wq_worker_decr { # SIGTTOU handler, kills first idle worker
335 my $workers = $self->{-wq_workers} or return;
336 my $s2 = $self->{-wq_s2} // die 'BUG: no wq_s2';
337 $self->wq_do('wq_exit', $s2, $s2, $s2);
338 $self->{-wq_exit_pending}++;
339 # caller must call wq_worker_decr_wait in main loop
342 sub wq_worker_decr_wait {
343 my ($self, $timeout) = @_;
344 return if $self->{-wq_ppid} != $$; # can't reap siblings or parents
345 my $s1 = $self->{-wq_s1} // croak 'BUG: no wq_s1';
346 vec(my $rin = '', fileno($s1), 1) = 1;
347 select(my $rout = $rin, undef, undef, $timeout) or
348 croak 'timed out waiting for wq_exit';
349 recv($s1, my $pid, 64, 0) // croak "recv: $!";
350 my $workers = $self->{-wq_workers} // croak 'BUG: no wq_workers';
351 delete $workers->{$pid} // croak "BUG: PID:$pid invalid";
352 $self->{-wq_exit_pending}--;
353 dwaitpid($pid, \&ipc_worker_reap, $self);
356 # set or retrieve number of workers
358 my ($self, $nr) = @_;
359 my $cur = $self->{-wq_workers} or return;
361 while (scalar(keys(%$cur)) > $nr) {
362 $self->wq_worker_decr;
363 $self->wq_worker_decr_wait;
365 $self->wq_worker_incr while scalar(keys(%$cur)) < $nr;
372 delete @$self{qw(-wq_s1 -wq_s2)} or return;
373 my $ppid = delete $self->{-wq_ppid} or return;
374 my $workers = delete $self->{-wq_workers} // die 'BUG: no wq_workers';
375 return if $ppid != $$; # can't reap siblings or parents
376 for my $pid (keys %$workers) {
377 dwaitpid($pid, \&ipc_worker_reap, $self);
383 ipc_worker_stop($_[0]);