]> Sergey Matveev's repositories - public-inbox.git/blobdiff - lib/PublicInbox/LEI.pm
lei: prefer IO::FDPass over our Inline::C recv_3fds
[public-inbox.git] / lib / PublicInbox / LEI.pm
index 7002a1f7e21444df924fadf2979bad27612cd212..f41f63ed126870683e4f93fd499e50c345605053 100644 (file)
@@ -1,4 +1,4 @@
-# Copyright (C) 2020 all contributors <meta@public-inbox.org>
+# Copyright (C) 2020-2021 all contributors <meta@public-inbox.org>
 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
 
 # Backend for `lei' (local email interface).  Unlike the C10K-oriented
@@ -8,7 +8,7 @@
 package PublicInbox::LEI;
 use strict;
 use v5.10.1;
-use parent qw(PublicInbox::DS PublicInbox::LeiExtinbox);
+use parent qw(PublicInbox::DS PublicInbox::LeiExternal);
 use Getopt::Long ();
 use Socket qw(AF_UNIX SOCK_STREAM pack_sockaddr_un);
 use Errno qw(EAGAIN ECONNREFUSED ENOENT);
@@ -16,15 +16,16 @@ use POSIX ();
 use IO::Handle ();
 use Sys::Syslog qw(syslog openlog);
 use PublicInbox::Config;
-use PublicInbox::Syscall qw($SFD_NONBLOCK EPOLLIN EPOLLONESHOT);
+use PublicInbox::Syscall qw(SFD_NONBLOCK EPOLLIN EPOLLONESHOT);
 use PublicInbox::Sigfd;
-use PublicInbox::DS qw(now);
-use PublicInbox::Spawn qw(spawn);
+use PublicInbox::DS qw(now dwaitpid);
+use PublicInbox::Spawn qw(spawn run_die);
 use PublicInbox::OnDestroy;
 use Text::Wrap qw(wrap);
 use File::Path qw(mkpath);
 use File::Spec;
 our $quit = \&CORE::exit;
+my $recv_3fds;
 my $GLP = Getopt::Long::Parser->new;
 $GLP->configure(qw(gnu_getopt no_ignore_case auto_abbrev));
 my $GLP_PASS = Getopt::Long::Parser->new;
@@ -69,20 +70,20 @@ sub _config_path ($) {
 # command => [ positional_args, 1-line description, Getopt::Long option spec ]
 our %CMD = ( # sorted in order of importance/use:
 'q' => [ 'SEARCH_TERMS...', 'search for messages matching terms', qw(
-       save-as=s output|o=s format|f=s dedupe|d=s thread|t augment|a
-       sort|s=s@ reverse|r offset=i remote local! extinbox!
+       save-as=s output|mfolder|o=s format|f=s dedupe|d=s thread|t augment|a
+       sort|s=s@ reverse|r offset=i remote local! external!
        since|after=s until|before=s), opt_dash('limit|n=i', '[0-9]+') ],
 
 'show' => [ 'MID|OID', 'show a given object (Message-ID or object ID)',
        qw(type=s solve! format|f=s dedupe|d=s thread|t remote local!),
        pass_through('git show') ],
 
-'add-extinbox' => [ 'URL_OR_PATHNAME',
+'add-external' => [ 'URL_OR_PATHNAME',
        'add/set priority of a publicinbox|extindex for extra matches',
        qw(boost=i quiet|q) ],
-'ls-extinbox' => [ '[FILTER...]', 'list publicinbox|extindex locations',
+'ls-external' => [ '[FILTER...]', 'list publicinbox|extindex locations',
        qw(format|f=s z|0 local remote quiet|q) ],
-'forget-extinbox' => [ '{URL_OR_PATHNAME|--prune}',
+'forget-external' => [ '{URL_OR_PATHNAME|--prune}',
        'exclude further results from a publicinbox|extindex',
        qw(prune quiet|q) ],
 
@@ -172,7 +173,7 @@ my %OPTDESC = (
 
 'type=s' => [ 'any|mid|git', 'disambiguate type' ],
 
-'dedupe|d=s' => ['STRAT|content|oid|mid',
+'dedupe|d=s' => ['STRAT|content|oid|mid|none',
                'deduplication strategy'],
 'show  thread|t' => 'display entire thread a message belongs to',
 'q     thread|t' =>
@@ -189,7 +190,7 @@ my %OPTDESC = (
 'q     format|f=s' => [ 'OUT|maildir|mboxrd|mboxcl2|mboxcl|html|oid|json',
                'specify output format, default depends on --output'],
 'ls-query      format|f=s' => $ls_format,
-'ls-extinbox   format|f=s' => $ls_format,
+'ls-external   format|f=s' => $ls_format,
 
 'limit|n=i@' => ['NUM', 'limit on number of matches (default: 10000)' ],
 'offset=i' => ['OFF', 'search result offset (default: 0)'],
@@ -235,6 +236,7 @@ my %CONFIG_KEYS = (
 
 sub x_it ($$) { # pronounced "exit"
        my ($self, $code) = @_;
+       $self->{1}->autoflush(1); # make sure client sees stdout before exit
        if (my $sig = ($code & 127)) {
                kill($sig, $self->{pid} // $$);
        } else {
@@ -453,7 +455,6 @@ sub _lei_store ($;$) {
        my $cfg = _lei_cfg($self, $creat);
        $cfg->{-lei_store} //= do {
                require PublicInbox::LeiStore;
-               PublicInbox::SearchIdx::load_xapian_writable();
                my $dir = $cfg->{'leistore.dir'};
                $dir //= _store_path($self->{env}) if $creat;
                return unless $dir;
@@ -482,8 +483,7 @@ sub lei_config {
        my $cfg = _lei_cfg($self, 1);
        my $cmd = [ qw(git config -f), $cfg->{'-f'}, @argv ];
        my %rdr = map { $_ => $self->{$_} } (0..2);
-       require PublicInbox::Import;
-       PublicInbox::Import::run_die($cmd, $env, \%rdr);
+       run_die($cmd, $env, \%rdr);
 }
 
 sub lei_init {
@@ -605,7 +605,7 @@ sub lei_git { # support passing through random git commands
        my ($self, @argv) = @_;
        my %rdr = map { $_ => $self->{$_} } (0..2);
        my $pid = spawn(['git', @argv], $self->{env}, \%rdr);
-       PublicInbox::DS::dwaitpid($pid, \&reap_exec, $self);
+       dwaitpid($pid, \&reap_exec, $self);
 }
 
 sub accept_dispatch { # Listener {post_accept} callback
@@ -615,26 +615,28 @@ sub accept_dispatch { # Listener {post_accept} callback
        my $self = bless { sock => $sock }, __PACKAGE__;
        vec(my $rin = '', fileno($sock), 1) = 1;
        # `say $sock' triggers "die" in lei(1)
-       for my $i (0..2) {
-               if (select(my $rout = $rin, undef, undef, 1)) {
-                       my $fd = IO::FDPass::recv(fileno($sock));
-                       if ($fd >= 0) {
-                               my $rdr = ($fd == 0 ? '<&=' : '>&=');
+       if (select(my $rout = $rin, undef, undef, 1)) {
+               my @fds = $recv_3fds->(fileno($sock));
+               if (scalar(@fds) == 3) {
+                       my $i = 0;
+                       for my $rdr (qw(<&= >&= >&=)) {
+                               my $fd = shift(@fds);
                                if (open(my $fh, $rdr, $fd)) {
-                                       $self->{$i} = $fh;
-                               } else {
+                                       $self->{$i++} = $fh;
+                               }  else {
                                        say $sock "open($rdr$fd) (FD=$i): $!";
                                        return;
                                }
-                       } else {
-                               say $sock "recv FD=$i: $!";
-                               return;
                        }
                } else {
-                       say $sock "timed out waiting to recv FD=$i";
+                       say $sock "recv_3fds failed: $!";
                        return;
                }
+       } else {
+               say $sock "timed out waiting to recv FDs";
+               return;
        }
+       $self->{2}->autoflush(1); # keep stdout buffered until x_it|DESTROY
        # $ARGV_STR = join("]\0[", @ARGV);
        # $ENV_STR = join('', map { "$_=$ENV{$_}\0" } keys %ENV);
        # $line = "$$\0\0>$ARGV_STR\0\0>$ENV_STR\0\0";
@@ -658,7 +660,7 @@ sub noop {}
 
 # lei(1) calls this when it can't connect
 sub lazy_start {
-       my ($path, $errno) = @_;
+       my ($path, $errno, $nfd) = @_;
        if ($errno == ECONNREFUSED) {
                unlink($path) or die "unlink($path): $!";
        } elsif ($errno != ENOENT) {
@@ -673,10 +675,17 @@ sub lazy_start {
        my $dev_ino_expect = pack('dd', $st[0], $st[1]); # dev+ino
        pipe(my ($eof_r, $eof_w)) or die "pipe: $!";
        my $oldset = PublicInbox::Sigfd::block_signals();
-       require IO::FDPass;
+       if ($nfd == 1) {
+               require IO::FDPass;
+               $recv_3fds = sub { map { IO::FDPass::recv($_[0]) } (0..2) };
+       } elsif ($nfd == 3) {
+               $recv_3fds = PublicInbox::Spawn->can('recv_3fds');
+       }
+       $recv_3fds or die
+               "IO::FDPass missing or Inline::C not installed/configured\n";
        require PublicInbox::Listener;
        require PublicInbox::EOFpipe;
-       (-p STDOUT && -p STDERR) or die "E: stdout+stderr must be pipes\n";
+       (-p STDOUT) or die "E: stdout must be a pipe\n";
        open(STDIN, '+<', '/dev/null') or die "redirect stdin failed: $!";
        POSIX::setsid() > 0 or die "setsid: $!";
        my $pid = fork // die "fork: $!";
@@ -705,7 +714,7 @@ sub lazy_start {
                USR1 => \&noop,
                USR2 => \&noop,
        };
-       my $sigfd = PublicInbox::Sigfd->new($sig, $SFD_NONBLOCK);
+       my $sigfd = PublicInbox::Sigfd->new($sig, SFD_NONBLOCK);
        local %SIG = (%SIG, %$sig) if !$sigfd;
        if ($sigfd) { # TODO: use inotify/kqueue to detect unlinked sockets
                PublicInbox::DS->SetLoopTimeout(5000);
@@ -741,17 +750,16 @@ sub lazy_start {
                $n; # true: continue, false: stop
        });
 
-       # STDIN was redirected to /dev/null above, closing STDOUT and
-       # STDERR will cause the calling `lei' client process to finish
-       # reading <$daemon> pipe.
-       open STDOUT, '>&STDIN' or die "redirect stdout failed: $!";
+       # STDIN was redirected to /dev/null above, closing STDERR and
+       # STDOUT will cause the calling `lei' client process to finish
+       # reading the <$daemon> pipe.
        openlog($path, 'pid', 'user');
        local $SIG{__WARN__} = sub { syslog('warning', "@_") };
-       my $owner_pid = $$;
-       my $on_destroy = PublicInbox::OnDestroy->new(sub {
-               syslog('crit', "$@") if $@ && $$ == $owner_pid;
+       my $on_destroy = PublicInbox::OnDestroy->new($$, sub {
+               syslog('crit', "$@") if $@;
        });
        open STDERR, '>&STDIN' or die "redirect stderr failed: $!";
+       open STDOUT, '>&STDIN' or die "redirect stdout failed: $!";
        # $daemon pipe to `lei' closed, main loop begins:
        PublicInbox::DS->EventLoop;
        @$on_destroy = (); # cancel on_destroy if we get here
@@ -773,4 +781,8 @@ sub oneshot {
        }, __PACKAGE__), @ARGV);
 }
 
+# ensures stdout hits the FS before sock disconnects so a client
+# can immediately reread it
+sub DESTROY { $_[0]->{1}->autoflush(1) }
+
 1;