X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=lib%2FPublicInbox%2FIPC.pm;h=548a72ebb11c70dba1ba1360fdc8d6d5598b9c95;hb=HEAD;hp=1fa67d00e704baff9b769a12ab25487a9cf1d774;hpb=707d4aca2256f284718c247ef00db64cd976d244;p=public-inbox.git diff --git a/lib/PublicInbox/IPC.pm b/lib/PublicInbox/IPC.pm index 1fa67d00..548a72eb 100644 --- a/lib/PublicInbox/IPC.pm +++ b/lib/PublicInbox/IPC.pm @@ -1,4 +1,4 @@ -# Copyright (C) 2020-2021 all contributors +# Copyright (C) all contributors # License: AGPL-3.0+ # base class for remote IPC calls and workqueues, requires Storable or Sereal @@ -12,14 +12,14 @@ use strict; use v5.10.1; use parent qw(Exporter); use Carp qw(croak); -use PublicInbox::DS qw(dwaitpid); +use PublicInbox::DS qw(awaitpid); use PublicInbox::Spawn; use PublicInbox::OnDestroy; use PublicInbox::WQWorker; use Socket qw(AF_UNIX MSG_EOR SOCK_STREAM); +my $MY_MAX_ARG_STRLEN = 4096 * 33; # extra 4K for serialization my $SEQPACKET = eval { Socket::SOCK_SEQPACKET() }; # portable enough? our @EXPORT_OK = qw(ipc_freeze ipc_thaw); -my $WQ_MAX_WORKERS = 4096; my ($enc, $dec); # ->imports at BEGIN turns sereal_*_with_object into custom ops on 5.14+ # and eliminate method call overhead @@ -43,10 +43,14 @@ if ($enc && $dec) { # should be custom ops } my $recv_cmd = PublicInbox::Spawn->can('recv_cmd4'); -my $send_cmd = PublicInbox::Spawn->can('send_cmd4') // do { +our $send_cmd = PublicInbox::Spawn->can('send_cmd4') // do { require PublicInbox::CmdIPC4; $recv_cmd //= PublicInbox::CmdIPC4->can('recv_cmd4'); PublicInbox::CmdIPC4->can('send_cmd4'); +} // do { + require PublicInbox::Syscall; + $recv_cmd //= PublicInbox::Syscall->can('recv_cmd4'); + PublicInbox::Syscall->can('send_cmd4'); }; sub _get_rec ($) { @@ -92,7 +96,7 @@ sub ipc_worker_loop ($$$) { # starts a worker if Sereal or Storable is installed sub ipc_worker_spawn { - my ($self, $ident, $oldset, $fields) = @_; + my ($self, $ident, $oldset, $fields, @cb_args) = @_; return if ($self->{-ipc_ppid} // -1) == $$; # idempotent delete(@$self{qw(-ipc_req -ipc_res -ipc_ppid -ipc_pid)}); pipe(my ($r_req, $w_req)) or die "pipe: $!"; @@ -103,6 +107,7 @@ sub ipc_worker_spawn { my $pid = fork // die "fork: $!"; if ($pid == 0) { srand($seed); + eval { Net::SSLeay::randomize() }; eval { PublicInbox::DS->Reset }; delete @$self{qw(-wq_s1 -wq_s2 -wq_workers -wq_ppid)}; $w_req = $r_res = undef; @@ -115,7 +120,7 @@ sub ipc_worker_spawn { $fields //= {}; local @$self{keys %$fields} = values(%$fields); my $on_destroy = $self->ipc_atfork_child; - local %SIG = %SIG; + local @SIG{keys %SIG} = values %SIG; PublicInbox::DS::sig_setmask($sigset); ipc_worker_loop($self, $r_req, $w_res); }; @@ -128,21 +133,18 @@ sub ipc_worker_spawn { $self->{-ipc_req} = $w_req; $self->{-ipc_res} = $r_res; $self->{-ipc_ppid} = $$; + awaitpid($pid, \&ipc_worker_reap, $self, @cb_args); $self->{-ipc_pid} = $pid; } -sub ipc_worker_reap { # dwaitpid callback - my ($args, $pid) = @_; +sub ipc_worker_reap { # awaitpid callback + my ($pid, $self, $cb, @args) = @_; + delete $self->{-wq_workers}->{$pid}; + return $cb->($pid, $self, @args) if $cb; return if !$?; - # TERM(15) is our default exit signal, PIPE(13) is likely w/ pager my $s = $? & 127; - warn "PID:$pid died with \$?=$?\n" if $s != 15 && $s != 13; -} - -sub wq_wait_old { - my ($self, $cb, @args) = @_; - my $pids = delete $self->{"-wq_old_pids.$$"} or return; - dwaitpid($_, $cb // \&ipc_worker_reap, [$self, @args]) for @$pids; + # TERM(15) is our default exit signal, PIPE(13) is likely w/ pager + warn "$self->{-wq_ident} PID:$pid died \$?=$?\n" if $s != 15 && $s != 13 } # for base class, override in sub classes @@ -159,7 +161,7 @@ sub ipc_atfork_child { # idempotent, can be called regardless of whether worker is active or not sub ipc_worker_stop { - my ($self, $args) = @_; + my ($self) = @_; my ($pid, $ppid) = delete(@$self{qw(-ipc_pid -ipc_ppid)}); my ($w_req, $r_res) = delete(@$self{qw(-ipc_req -ipc_res)}); if (!$w_req && !$r_res) { @@ -168,19 +170,25 @@ sub ipc_worker_stop { } die 'no PID with IPC pipes' unless $pid; $w_req = $r_res = undef; - - return if $$ != $ppid; - dwaitpid($pid, \&ipc_worker_reap, [$self, $args]); + awaitpid($pid) if $$ == $ppid; # for non-event loop } # use this if we have multiple readers reading curl or "pigz -dc" # and writing to the same store sub ipc_lock_init { my ($self, $f) = @_; + $f // die 'BUG: no filename given'; require PublicInbox::Lock; $self->{-ipc_lock} //= bless { lock_path => $f }, 'PublicInbox::Lock' } +sub _wait_return ($$) { + my ($r_res, $sub) = @_; + my $ret = _get_rec($r_res) // die "no response on $sub"; + die $$ret if ref($ret) eq 'PublicInbox::IPC::Die'; + wantarray ? @$ret : $$ret; +} + # call $self->$sub(@args), on a worker if ipc_worker_spawn was used sub ipc_do { my ($self, $sub, @args) = @_; @@ -190,9 +198,7 @@ sub ipc_do { if (defined(wantarray)) { my $r_res = $self->{-ipc_res} or die 'no ipc_res'; _send_rec($w_req, [ wantarray, $sub, @args ]); - my $ret = _get_rec($r_res) // die "no response on $sub"; - die $$ret if ref($ret) eq 'PublicInbox::IPC::Die'; - wantarray ? @$ret : $$ret; + _wait_return($r_res, $sub); } else { # likely, fire-and-forget into pipe _send_rec($w_req, [ undef , $sub, @args ]); } @@ -212,7 +218,7 @@ sub ipc_sibling_atfork_child { sub recv_and_run { my ($self, $s2, $len, $full_stream) = @_; - my @fds = $recv_cmd->($s2, my $buf, $len); + my @fds = $recv_cmd->($s2, my $buf, $len // $MY_MAX_ARG_STRLEN); return if scalar(@fds) && !defined($fds[0]); my $n = length($buf) or return 0; my $nfd = 0; @@ -234,31 +240,32 @@ sub recv_and_run { undef $buf; my $sub = shift @$args; eval { $self->$sub(@$args) }; - warn "$$ wq_worker: $@" if $@; + warn "$$ $0 wq_worker: $sub: $@" if $@; delete @$self{0..($nfd-1)}; $n; } -sub wq_worker_loop ($) { - my ($self, $bcast_a) = @_; - my $wqw = PublicInbox::WQWorker->new($self); - PublicInbox::WQWorker->new($self, '-wq_bcast2'); +sub wq_worker_loop ($$) { + my ($self, $bcast2) = @_; + my $wqw = PublicInbox::WQWorker->new($self, $self->{-wq_s2}); + PublicInbox::WQWorker->new($self, $bcast2) if $bcast2; PublicInbox::DS->SetPostLoopCallback(sub { $wqw->{sock} }); - PublicInbox::DS->EventLoop; + PublicInbox::DS::event_loop(); PublicInbox::DS->Reset; } sub do_sock_stream { # via wq_io_do, for big requests my ($self, $len) = @_; - recv_and_run($self, delete $self->{0}, $len, 1); + recv_and_run($self, my $s2 = delete $self->{0}, $len, 1); } sub wq_broadcast { my ($self, $sub, @args) = @_; if (my $wkr = $self->{-wq_workers}) { + my $buf = ipc_freeze([$sub, @args]); for my $bcast1 (values %$wkr) { - my $buf = ipc_freeze([$sub, @args]); - send($bcast1, $buf, MSG_EOR) // croak "send: $!"; + my $sock = $bcast1 // $self->{-wq_s1} // next; + send($sock, $buf, MSG_EOR) // croak "send: $!"; # XXX shouldn't have to deal with EMSGSIZE here... } } else { @@ -267,27 +274,37 @@ sub wq_broadcast { } } +sub stream_in_full ($$$) { + my ($s1, $fds, $buf) = @_; + socketpair(my $r, my $w, AF_UNIX, SOCK_STREAM, 0) or + croak "socketpair: $!"; + my $n = $send_cmd->($s1, [ fileno($r) ], + ipc_freeze(['do_sock_stream', length($buf)]), + MSG_EOR) // croak "sendmsg: $!"; + undef $r; + $n = $send_cmd->($w, $fds, $buf, 0) // croak "sendmsg: $!"; + while ($n < length($buf)) { + my $x = syswrite($w, $buf, length($buf) - $n, $n) // + croak "syswrite: $!"; + croak "syswrite wrote 0 bytes" if $x == 0; + $n += $x; + } +} + sub wq_io_do { # always async my ($self, $sub, $ios, @args) = @_; if (my $s1 = $self->{-wq_s1}) { # run in worker my $fds = [ map { fileno($_) } @$ios ]; my $buf = ipc_freeze([$sub, @args]); - my $n = $send_cmd->($s1, $fds, $buf, MSG_EOR); - return if defined($n); # likely - croak "sendmsg: $! (check RLIMIT_NOFILE)" if $!{ETOOMANYREFS}; - croak "sendmsg: $!" if !$!{EMSGSIZE}; - socketpair(my $r, my $w, AF_UNIX, SOCK_STREAM, 0) or - croak "socketpair: $!"; - $n = $send_cmd->($s1, [ fileno($r) ], - ipc_freeze(['do_sock_stream', length($buf)]), - MSG_EOR) // croak "sendmsg: $!"; - undef $r; - $n = $send_cmd->($w, $fds, $buf, 0) // croak "sendmsg: $!"; - while ($n < length($buf)) { - my $x = syswrite($w, $buf, length($buf) - $n, $n) // - croak "syswrite: $!"; - croak "syswrite wrote 0 bytes" if $x == 0; - $n += $x; + if (length($buf) > $MY_MAX_ARG_STRLEN) { + stream_in_full($s1, $fds, $buf); + } else { + my $n = $send_cmd->($s1, $fds, $buf, MSG_EOR); + return if defined($n); # likely + $!{ETOOMANYREFS} and + croak "sendmsg: $! (check RLIMIT_NOFILE)"; + $!{EMSGSIZE} ? stream_in_full($s1, $fds, $buf) : + croak("sendmsg: $!"); } } else { @$self{0..$#$ios} = @$ios; @@ -297,151 +314,125 @@ sub wq_io_do { # always async } } -sub _wq_worker_start ($$$) { - my ($self, $oldset, $fields) = @_; +sub wq_sync_run { + my ($self, $wantarray, $sub, @args) = @_; + if ($wantarray) { + my @ret = eval { $self->$sub(@args) }; + ipc_return($self->{0}, \@ret, $@); + } else { # '' => wantscalar + my $ret = eval { $self->$sub(@args) }; + ipc_return($self->{0}, \$ret, $@); + } +} + +sub wq_do { + my ($self, $sub, @args) = @_; + if (defined(wantarray)) { + pipe(my ($r, $w)) or die "pipe: $!"; + wq_io_do($self, 'wq_sync_run', [ $w ], wantarray, $sub, @args); + undef $w; + _wait_return($r, $sub); + } else { + wq_io_do($self, $sub, [], @args); + } +} + +sub prepare_nonblock { + ($_[0]->{-wq_s1} // die 'BUG: no {-wq_s1}')->blocking(0); + require PublicInbox::WQBlocked; +} + +sub wq_nonblock_do { # always async + my ($self, $sub, @args) = @_; + my $buf = ipc_freeze([$sub, @args]); + if ($self->{wqb}) { # saturated once, assume saturated forever + $self->{wqb}->flush_send($buf); + } else { + $send_cmd->($self->{-wq_s1}, [], $buf, MSG_EOR) // + ($!{EAGAIN} ? PublicInbox::WQBlocked->new($self, $buf) + : croak("sendmsg: $!")); + } +} + +sub _wq_worker_start { + my ($self, $oldset, $fields, $one, @cb_args) = @_; my ($bcast1, $bcast2); - socketpair($bcast1, $bcast2, AF_UNIX, $SEQPACKET, 0) or - die "socketpair: $!"; + $one or socketpair($bcast1, $bcast2, AF_UNIX, $SEQPACKET, 0) or + die "socketpair: $!"; my $seed = rand(0xffffffff); my $pid = fork // die "fork: $!"; if ($pid == 0) { srand($seed); + eval { Net::SSLeay::randomize() }; undef $bcast1; eval { PublicInbox::DS->Reset }; delete @$self{qw(-wq_s1 -wq_ppid)}; $self->{-wq_worker_nr} = keys %{delete($self->{-wq_workers}) // {}}; - $SIG{$_} = 'IGNORE' for (qw(PIPE)); $SIG{$_} = 'DEFAULT' for (qw(TTOU TTIN TERM QUIT INT CHLD)); - local $0 = "$self->{-wq_ident} $self->{-wq_worker_nr}"; + local $0 = $one ? $self->{-wq_ident} : + "$self->{-wq_ident} $self->{-wq_worker_nr}"; # ensure we properly exit even if warn() dies: my $end = PublicInbox::OnDestroy->new($$, sub { exit(!!$@) }); eval { $fields //= {}; local @$self{keys %$fields} = values(%$fields); my $on_destroy = $self->ipc_atfork_child; - local %SIG = %SIG; + local @SIG{keys %SIG} = values %SIG; PublicInbox::DS::sig_setmask($oldset); - $self->{-wq_bcast2} = $bcast2; - wq_worker_loop($self); + wq_worker_loop($self, $bcast2); }; warn "worker $self->{-wq_ident} PID:$$ died: $@" if $@; undef $end; # trigger exit } else { $self->{-wq_workers}->{$pid} = $bcast1; + awaitpid($pid, \&ipc_worker_reap, $self, @cb_args); } } # starts workqueue workers if Sereal or Storable is installed sub wq_workers_start { - my ($self, $ident, $nr_workers, $oldset, $fields) = @_; + my ($self, $ident, $nr_workers, $oldset, $fields, @cb_args) = @_; ($send_cmd && $recv_cmd && defined($SEQPACKET)) or return; return if $self->{-wq_s1}; # idempotent $self->{-wq_s1} = $self->{-wq_s2} = undef; socketpair($self->{-wq_s1}, $self->{-wq_s2}, AF_UNIX, $SEQPACKET, 0) or die "socketpair: $!"; $self->ipc_atfork_prepare; - $nr_workers //= $self->{-wq_nr_workers}; - $nr_workers = $WQ_MAX_WORKERS if $nr_workers > $WQ_MAX_WORKERS; + $nr_workers //= $self->{-wq_nr_workers}; # was set earlier my $sigset = $oldset // PublicInbox::DS::block_signals(); $self->{-wq_workers} = {}; $self->{-wq_ident} = $ident; - _wq_worker_start($self, $sigset, $fields) for (1..$nr_workers); + my $one = $nr_workers == 1; + $self->{-wq_nr_workers} = $nr_workers; + for (1..$nr_workers) { + _wq_worker_start($self, $sigset, $fields, $one, @cb_args); + } PublicInbox::DS::sig_setmask($sigset) unless $oldset; $self->{-wq_ppid} = $$; } -sub wq_worker_incr { # SIGTTIN handler - my ($self, $oldset, $fields) = @_; - $self->{-wq_s2} or return; - die "-wq_nr_workers locked" if defined $self->{-wq_nr_workers}; - return if wq_workers($self) >= $WQ_MAX_WORKERS; - $self->ipc_atfork_prepare; - my $sigset = $oldset // PublicInbox::DS::block_signals(); - _wq_worker_start($self, $sigset, $fields); - PublicInbox::DS::sig_setmask($sigset) unless $oldset; -} - -sub wq_exit { # wakes up wq_worker_decr_wait - send($_[0]->{-wq_s2}, $$, MSG_EOR) // die "$$ send: $!"; - exit; -} - -sub wq_worker_decr { # SIGTTOU handler, kills first idle worker +sub wq_close { my ($self) = @_; - return unless wq_workers($self); - die "-wq_nr_workers locked" if defined $self->{-wq_nr_workers}; - $self->wq_io_do('wq_exit'); - # caller must call wq_worker_decr_wait in main loop -} - -sub wq_worker_decr_wait { - my ($self, $timeout, $cb, @args) = @_; - return if $self->{-wq_ppid} != $$; # can't reap siblings or parents - die "-wq_nr_workers locked" if defined $self->{-wq_nr_workers}; - my $s1 = $self->{-wq_s1} // croak 'BUG: no wq_s1'; - vec(my $rin = '', fileno($s1), 1) = 1; - select(my $rout = $rin, undef, undef, $timeout) or - croak 'timed out waiting for wq_exit'; - recv($s1, my $pid, 64, 0) // croak "recv: $!"; - my $workers = $self->{-wq_workers} // croak 'BUG: no wq_workers'; - delete $workers->{$pid} // croak "BUG: PID:$pid invalid"; - dwaitpid($pid, $cb // \&ipc_worker_reap, [ $self, @args ]); -} - -# set or retrieve number of workers -sub wq_workers { - my ($self, $nr, $cb, @args) = @_; - my $cur = $self->{-wq_workers} or return; - if (defined $nr) { - while (scalar(keys(%$cur)) > $nr) { - $self->wq_worker_decr; - $self->wq_worker_decr_wait(undef, $cb, @args); - } - $self->wq_worker_incr while scalar(keys(%$cur)) < $nr; + if (my $wqb = delete $self->{wqb}) { + $wqb->enq_close; } - scalar(keys(%$cur)); -} - -sub wq_close { - my ($self, $nohang, $cb, @args) = @_; delete @$self{qw(-wq_s1 -wq_s2)} or return; - my $ppid = delete $self->{-wq_ppid} or return; - my $workers = delete $self->{-wq_workers} // die 'BUG: no wq_workers'; - return if $ppid != $$; # can't reap siblings or parents - my @pids = map { $_ + 0 } keys %$workers; - if ($nohang) { - push @{$self->{"-wq_old_pids.$$"}}, @pids; - } else { - $cb //= \&ipc_worker_reap; - unshift @args, $self; - dwaitpid($_, $cb, \@args) for @pids; - } -} - -sub wq_kill_old { - my ($self, $sig) = @_; - my $pids = $self->{"-wq_old_pids.$$"} or return; - kill($sig // 'TERM', @$pids); + return if ($self->{-wq_ppid} // -1) != $$; + awaitpid($_) for keys %{$self->{-wq_workers}}; } sub wq_kill { my ($self, $sig) = @_; - my $workers = $self->{-wq_workers} or return; - kill($sig // 'TERM', keys %$workers); + kill($sig // 'TERM', keys %{$self->{-wq_workers}}); } -sub WQ_MAX_WORKERS { $WQ_MAX_WORKERS } - sub DESTROY { my ($self) = @_; my $ppid = $self->{-wq_ppid}; wq_kill($self) if $ppid && $ppid == $$; - my $err = $?; wq_close($self); - wq_wait_old($self); ipc_worker_stop($self); - $? = $err if $err; } sub detect_nproc () {