# License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
# base class for remote IPC calls and workqueues, requires Storable or Sereal
+# - ipc_do and ipc_worker_* is for a single worker/producer and uses pipes
+# - wq_do and wq_worker* is for a single producer and multiple workers,
+# using SOCK_SEQPACKET for work distribution
+# use ipc_do when you need work done on a certain process
+# use wq_do when your work can be done on any idle worker
package PublicInbox::IPC;
use strict;
use v5.10.1;
use Carp qw(confess croak);
use PublicInbox::DS qw(dwaitpid);
use PublicInbox::Spawn;
-use POSIX qw(mkfifo WNOHANG);
+use PublicInbox::OnDestroy;
+use PublicInbox::WQWorker;
use Socket qw(AF_UNIX MSG_EOR SOCK_STREAM);
use Errno qw(EMSGSIZE);
-use File::Temp 0.19 (); # 0.19 for ->newdir
my $SEQPACKET = eval { Socket::SOCK_SEQPACKET() }; # portable enough?
use constant PIPE_BUF => $^O eq 'linux' ? 4096 : POSIX::_POSIX_PIPE_BUF();
my $WQ_MAX_WORKERS = 4096;
if ($pid == 0) {
srand($seed);
eval { PublicInbox::DS->Reset };
- delete @$self{qw(-wq_s1 -wq_workers -wq_ppid)};
+ delete @$self{qw(-wq_s1 -wq_s2 -wq_workers -wq_ppid)};
$w_req = $r_res = undef;
$w_res->autoflush(1);
$SIG{$_} = 'IGNORE' for (qw(TERM INT QUIT));
local $0 = $ident;
PublicInbox::DS::sig_setmask($sigset);
- my $on_destroy = $self->ipc_atfork_child;
- eval { ipc_worker_loop($self, $r_req, $w_res) };
+ # ensure we properly exit even if warn() dies:
+ my $end = PublicInbox::OnDestroy->new($$, sub { exit(!!$@) });
+ eval {
+ my $on_destroy = $self->ipc_atfork_child;
+ local %SIG = %SIG;
+ ipc_worker_loop($self, $r_req, $w_res);
+ };
die "worker $ident PID:$$ died: $@\n" if $@;
- exit;
+ undef $end; # trigger exit
}
PublicInbox::DS::sig_setmask($sigset) unless $oldset;
$r_req = $w_res = undef;
# for base class, override in sub classes
sub ipc_atfork_prepare {}
+sub wq_atexit_child {}
+
sub ipc_atfork_child {
my ($self) = @_;
my $io = delete($self->{-ipc_atfork_child_close}) or return;
$pid == $$ and die "BUG: $$ ipc_atfork_child called on itself";
}
-sub _recv_and_run {
+sub recv_and_run {
my ($self, $s2, $len, $full_stream) = @_;
my @fds = $recv_cmd->($s2, my $buf, $len);
- my $n = length($buf // '') or return;
+ return if scalar(@fds) && !defined($fds[0]);
+ my $n = length($buf) or return 0;
my $nfd = 0;
for my $fd (@fds) {
if (open(my $cmdfh, '+<&=', $fd)) {
sub wq_worker_loop ($) {
my ($self) = @_;
- my $len = $self->{wq_req_len} // (4096 * 33);
- my $s2 = $self->{-wq_s2} // die 'BUG: no -wq_s2';
- 1 while (_recv_and_run($self, $s2, $len));
+ my $wqw = PublicInbox::WQWorker->new($self);
+ PublicInbox::DS->SetPostLoopCallback(sub { $wqw->{sock} });
+ PublicInbox::DS->EventLoop;
+ PublicInbox::DS->Reset;
}
sub do_sock_stream { # via wq_do, for big requests
my ($self, $len) = @_;
- _recv_and_run($self, delete $self->{0}, $len, 1);
+ recv_and_run($self, delete $self->{0}, $len, 1);
}
sub wq_do { # always async
}
}
-sub _wq_worker_start ($$) {
- my ($self, $oldset) = @_;
+sub _wq_worker_start ($$$) {
+ my ($self, $oldset, $fields) = @_;
my $seed = rand(0xffffffff);
my $pid = fork // die "fork: $!";
if ($pid == 0) {
srand($seed);
eval { PublicInbox::DS->Reset };
delete @$self{qw(-wq_s1 -wq_workers -wq_ppid)};
- $SIG{$_} = 'IGNORE' for (qw(PIPE TTOU TTIN));
- $SIG{$_} = 'DEFAULT' for (qw(TERM QUIT INT CHLD));
+ @$self{keys %$fields} = values(%$fields) if $fields;
+ $SIG{$_} = 'IGNORE' for (qw(PIPE));
+ $SIG{$_} = 'DEFAULT' for (qw(TTOU TTIN TERM QUIT INT CHLD));
local $0 = $self->{-wq_ident};
PublicInbox::DS::sig_setmask($oldset);
# ensure we properly exit even if warn() dies:
my $end = PublicInbox::OnDestroy->new($$, sub { exit(!!$@) });
- my $on_destroy = $self->ipc_atfork_child;
- eval { wq_worker_loop($self) };
+ eval {
+ my $on_destroy = $self->ipc_atfork_child;
+ local %SIG = %SIG;
+ wq_worker_loop($self);
+ };
warn "worker $self->{-wq_ident} PID:$$ died: $@" if $@;
- undef $on_destroy;
undef $end; # trigger exit
} else {
$self->{-wq_workers}->{$pid} = \undef;
# starts workqueue workers if Sereal or Storable is installed
sub wq_workers_start {
- my ($self, $ident, $nr_workers, $oldset) = @_;
+ my ($self, $ident, $nr_workers, $oldset, $fields) = @_;
($enc && $send_cmd && $recv_cmd && defined($SEQPACKET)) or return;
return if $self->{-wq_s1}; # idempotent
$self->{-wq_s1} = $self->{-wq_s2} = undef;
my $sigset = $oldset // PublicInbox::DS::block_signals();
$self->{-wq_workers} = {};
$self->{-wq_ident} = $ident;
- _wq_worker_start($self, $sigset) for (1..$nr_workers);
+ _wq_worker_start($self, $sigset, $fields) for (1..$nr_workers);
PublicInbox::DS::sig_setmask($sigset) unless $oldset;
$self->{-wq_ppid} = $$;
}
sub wq_worker_incr { # SIGTTIN handler
- my ($self, $oldset) = @_;
+ my ($self, $oldset, $fields) = @_;
$self->{-wq_s2} or return;
return if wq_workers($self) >= $WQ_MAX_WORKERS;
$self->ipc_atfork_prepare;
my $sigset = $oldset // PublicInbox::DS::block_signals();
- _wq_worker_start($self, $sigset);
+ _wq_worker_start($self, $sigset, $fields);
PublicInbox::DS::sig_setmask($sigset) unless $oldset;
}