]> Sergey Matveev's repositories - public-inbox.git/blobdiff - lib/PublicInbox/Spawn.pm
ipc: start supporting sending/receiving more than 3 FDs
[public-inbox.git] / lib / PublicInbox / Spawn.pm
index 1c74a5964aa59235d51eaa6af7bbb9b37fecb4eb..b35bf54c111265cc26e24fc1cd6c7d381816822b 100644 (file)
@@ -1,31 +1,34 @@
-# Copyright (C) 2016-2019 all contributors <meta@public-inbox.org>
+# Copyright (C) 2016-2021 all contributors <meta@public-inbox.org>
 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
 #
 # This allows vfork to be used for spawning subprocesses if
-# PERL_INLINE_DIRECTORY is explicitly defined in the environment.
+# ~/.cache/public-inbox/inline-c is writable or if PERL_INLINE_DIRECTORY
+# is explicitly defined in the environment (and writable).
 # Under Linux, vfork can make a big difference in spawning performance
 # as process size increases (fork still needs to mark pages for CoW use).
 # Currently, we only use this for code intended for long running
 # daemons (inside the PSGI code (-httpd) and -nntpd).  The short-lived
 # scripts (-mda, -index, -learn, -init) either use IPC::run or standard
 # Perl routines.
+#
+# There'll probably be more OS-level C stuff here, down the line.
+# We don't want too many DSOs: https://udrepper.livejournal.com/8790.html
 
 package PublicInbox::Spawn;
 use strict;
-use warnings;
-use base qw(Exporter);
+use parent qw(Exporter);
 use Symbol qw(gensym);
 use PublicInbox::ProcessPipe;
-our @EXPORT_OK = qw/which spawn popen_rd/;
-sub RLIMITS () { qw(RLIMIT_CPU RLIMIT_CORE RLIMIT_DATA) }
+our @EXPORT_OK = qw(which spawn popen_rd run_die nodatacow_dir);
+our @RLIMITS = qw(RLIMIT_CPU RLIMIT_CORE RLIMIT_DATA);
 
 my $vfork_spawn = <<'VFORK_SPAWN';
 #include <sys/types.h>
-#include <sys/uio.h>
 #include <sys/time.h>
 #include <sys/resource.h>
 #include <unistd.h>
 #include <stdlib.h>
+#include <errno.h>
 
 /* some platforms need alloca.h, but some don't */
 #if defined(__GNUC__) && !defined(alloca)
@@ -77,7 +80,7 @@ int pi_fork_exec(SV *redirref, SV *file, SV *cmdref, SV *envref, SV *rlimref,
        const char *filename = SvPV_nolen(file);
        pid_t pid;
        char **argv, **envp;
-       sigset_t set, old;
+       sigset_t set, old, cset;
        int ret, perrnum, cerrnum = 0;
 
        AV2C_COPY(argv, cmd);
@@ -87,6 +90,10 @@ int pi_fork_exec(SV *redirref, SV *file, SV *cmdref, SV *envref, SV *rlimref,
        assert(ret == 0 && "BUG calling sigfillset");
        ret = sigprocmask(SIG_SETMASK, &set, &old);
        assert(ret == 0 && "BUG calling sigprocmask to block");
+       ret = sigemptyset(&cset);
+       assert(ret == 0 && "BUG calling sigemptyset");
+       ret = sigaddset(&cset, SIGCHLD);
+       assert(ret == 0 && "BUG calling sigaddset for SIGCHLD");
        pid = vfork();
        if (pid == 0) {
                int sig;
@@ -119,9 +126,10 @@ int pi_fork_exec(SV *redirref, SV *file, SV *cmdref, SV *envref, SV *rlimref,
                }
 
                /*
-                * don't bother unblocking, we don't want signals
-                * to the group taking out a subprocess
+                * don't bother unblocking other signals for now, just SIGCHLD.
+                * we don't want signals to the group taking out a subprocess
                 */
+               (void)sigprocmask(SIG_UNBLOCK, &cset, NULL);
                execve(filename, argv, envp);
                exit_err(&cerrnum);
        }
@@ -140,8 +148,153 @@ int pi_fork_exec(SV *redirref, SV *file, SV *cmdref, SV *envref, SV *rlimref,
 }
 VFORK_SPAWN
 
-my $inline_dir = $ENV{PERL_INLINE_DIRECTORY};
-$vfork_spawn = undef unless defined $inline_dir && -d $inline_dir && -w _;
+# btrfs on Linux is copy-on-write (COW) by default.  As of Linux 5.7,
+# this still leads to fragmentation for SQLite and Xapian files where
+# random I/O happens, so we disable COW just for SQLite files and Xapian
+# directories.  Disabling COW disables checksumming, so we only do this
+# for regeneratable files, and not canonical git storage (git doesn't
+# checksum refs, only data under $GIT_DIR/objects).
+my $set_nodatacow = $^O eq 'linux' ? <<'SET_NODATACOW' : '';
+#include <sys/ioctl.h>
+#include <sys/vfs.h>
+#include <linux/magic.h>
+#include <linux/fs.h>
+#include <dirent.h>
+#include <errno.h>
+#include <stdio.h>
+#include <string.h>
+
+void nodatacow_fd(int fd)
+{
+       struct statfs buf;
+       int val = 0;
+
+       if (fstatfs(fd, &buf) < 0) {
+               fprintf(stderr, "fstatfs: %s\\n", strerror(errno));
+               return;
+       }
+
+       /* only btrfs is known to have this problem, so skip for non-btrfs */
+       if (buf.f_type != BTRFS_SUPER_MAGIC)
+               return;
+
+       if (ioctl(fd, FS_IOC_GETFLAGS, &val) < 0) {
+               fprintf(stderr, "FS_IOC_GET_FLAGS: %s\\n", strerror(errno));
+               return;
+       }
+       val |= FS_NOCOW_FL;
+       if (ioctl(fd, FS_IOC_SETFLAGS, &val) < 0)
+               fprintf(stderr, "FS_IOC_SET_FLAGS: %s\\n", strerror(errno));
+}
+
+void nodatacow_dir(const char *dir)
+{
+       DIR *dh = opendir(dir);
+       int fd;
+
+       if (!dh) croak("opendir(%s): %s", dir, strerror(errno));
+       fd = dirfd(dh);
+       if (fd >= 0)
+               nodatacow_fd(fd);
+       /* ENOTSUP probably won't happen under Linux... */
+       closedir(dh);
+}
+SET_NODATACOW
+
+# last choice for script/lei, 1st choice for lei internals
+# compatible with PublicInbox::CmdIPC4
+my $fdpass = <<'FDPASS';
+#include <sys/types.h>
+#include <sys/uio.h>
+#include <sys/socket.h>
+
+#if defined(CMSG_SPACE) && defined(CMSG_LEN)
+#define SEND_FD_CAPA 3
+#define SEND_FD_SPACE (SEND_FD_CAPA * sizeof(int))
+union my_cmsg {
+       struct cmsghdr hdr;
+       char pad[sizeof(struct cmsghdr) + 16 + SEND_FD_SPACE];
+};
+
+int send_cmd4(PerlIO *s, SV *svfds, SV *data, int flags)
+{
+       struct msghdr msg = { 0 };
+       union my_cmsg cmsg = { 0 };
+       STRLEN dlen = 0;
+       struct iovec iov;
+       AV *fds = (AV *)SvRV(svfds);
+       I32 i, nfds = av_len(fds) + 1;
+       int *fdp;
+
+       if (SvOK(data)) {
+               iov.iov_base = SvPV(data, dlen);
+               iov.iov_len = dlen;
+       }
+       if (!dlen) { /* must be non-zero */
+               iov.iov_base = &msg.msg_namelen; /* whatever */
+               iov.iov_len = 1;
+       }
+       msg.msg_iov = &iov;
+       msg.msg_iovlen = 1;
+       if (nfds) {
+               if (nfds > SEND_FD_CAPA) {
+                       fprintf(stderr, "FIXME: bump SEND_FD_CAPA=%d\n", nfds);
+                       nfds = SEND_FD_CAPA;
+               }
+               msg.msg_control = &cmsg.hdr;
+               msg.msg_controllen = CMSG_SPACE(nfds * sizeof(int));
+               cmsg.hdr.cmsg_level = SOL_SOCKET;
+               cmsg.hdr.cmsg_type = SCM_RIGHTS;
+               cmsg.hdr.cmsg_len = CMSG_LEN(nfds * sizeof(int));
+               fdp = (int *)CMSG_DATA(&cmsg.hdr);
+               for (i = 0; i < nfds; i++) {
+                       SV **fd = av_fetch(fds, i, 0);
+                       *fdp++ = SvIV(*fd);
+               }
+       }
+       return sendmsg(PerlIO_fileno(s), &msg, flags) >= 0;
+}
+
+void recv_cmd4(PerlIO *s, SV *buf, STRLEN n)
+{
+       union my_cmsg cmsg = { 0 };
+       struct msghdr msg = { 0 };
+       struct iovec iov;
+       size_t i;
+       Inline_Stack_Vars;
+       Inline_Stack_Reset;
+
+       if (!SvOK(buf))
+               sv_setpvn(buf, "", 0);
+       iov.iov_base = SvGROW(buf, n + 1);
+       iov.iov_len = n;
+       msg.msg_iov = &iov;
+       msg.msg_iovlen = 1;
+       msg.msg_control = &cmsg.hdr;
+       msg.msg_controllen = CMSG_SPACE(SEND_FD_SPACE);
+
+       i = recvmsg(PerlIO_fileno(s), &msg, 0);
+       if (i < 0)
+               croak("recvmsg: %s", strerror(errno));
+       SvCUR_set(buf, i);
+       if (i > 0 && cmsg.hdr.cmsg_level == SOL_SOCKET &&
+                       cmsg.hdr.cmsg_type == SCM_RIGHTS) {
+               size_t len = cmsg.hdr.cmsg_len;
+               int *fdp = (int *)CMSG_DATA(&cmsg.hdr);
+               for (i = 0; CMSG_LEN((i + 1) * sizeof(int)) <= len; i++)
+                       Inline_Stack_Push(sv_2mortal(newSViv(*fdp++)));
+       }
+       Inline_Stack_Done;
+}
+#endif /* defined(CMSG_SPACE) && defined(CMSG_LEN) */
+FDPASS
+
+my $inline_dir = $ENV{PERL_INLINE_DIRECTORY} //= (
+               $ENV{XDG_CACHE_HOME} //
+               ( ($ENV{HOME} // '/nonexistent').'/.cache' )
+       ).'/public-inbox/inline-c';
+
+$set_nodatacow = $vfork_spawn = $fdpass = undef unless -d $inline_dir && -w _;
 if (defined $vfork_spawn) {
        # Inline 0.64 or later has locking in multi-process env,
        # but we support 0.5 on Debian wheezy
@@ -150,14 +303,22 @@ if (defined $vfork_spawn) {
                my $f = "$inline_dir/.public-inbox.lock";
                open my $fh, '>', $f or die "failed to open $f: $!\n";
                flock($fh, LOCK_EX) or die "LOCK_EX failed on $f: $!\n";
-               eval 'use Inline C => $vfork_spawn'; #, BUILD_NOISY => 1';
+               eval 'use Inline C => $vfork_spawn.$fdpass.$set_nodatacow';
+                       # . ', BUILD_NOISY => 1';
                my $err = $@;
+               my $ndc_err;
+               if ($err && $set_nodatacow) { # missing Linux kernel headers
+                       $ndc_err = $err;
+                       undef $set_nodatacow;
+                       eval 'use Inline C => $vfork_spawn . $fdpass';
+               }
                flock($fh, LOCK_UN) or die "LOCK_UN failed on $f: $!\n";
                die $err if $err;
+               warn $ndc_err if $ndc_err;
        };
        if ($@) {
                warn "Inline::C failed for vfork: $@\n";
-               $vfork_spawn = undef;
+               $set_nodatacow = $vfork_spawn = $fdpass = undef;
        }
 }
 
@@ -165,6 +326,16 @@ unless (defined $vfork_spawn) {
        require PublicInbox::SpawnPP;
        *pi_fork_exec = \&PublicInbox::SpawnPP::pi_fork_exec
 }
+unless ($set_nodatacow) {
+       require PublicInbox::NDC_PP;
+       no warnings 'once';
+       *nodatacow_fd = \&PublicInbox::NDC_PP::nodatacow_fd;
+       *nodatacow_dir = \&PublicInbox::NDC_PP::nodatacow_dir;
+}
+
+undef $set_nodatacow;
+undef $vfork_spawn;
+undef $fdpass;
 
 sub which ($) {
        my ($file) = @_;
@@ -199,7 +370,7 @@ sub spawn ($;$$) {
        }
        my $rlim = [];
 
-       foreach my $l (RLIMITS()) {
+       foreach my $l (@RLIMITS) {
                defined(my $v = $opts->{$l}) or next;
                my $r = eval "require BSD::Resource; BSD::Resource::$l();";
                unless (defined $r) {
@@ -210,20 +381,27 @@ sub spawn ($;$$) {
        }
        my $cd = $opts->{'-C'} // ''; # undef => NULL mapping doesn't work?
        my $pid = pi_fork_exec($redir, $f, $cmd, \@env, $rlim, $cd);
-       $pid < 0 ? undef : $pid;
+       die "fork_exec @$cmd failed: $!\n" unless $pid > 0;
+       $pid;
 }
 
 sub popen_rd {
-       my ($cmd, $env, $opts) = @_;
+       my ($cmd, $env, $opt) = @_;
        pipe(my ($r, $w)) or die "pipe: $!\n";
-       $opts ||= {};
-       $opts->{1} = fileno($w);
-       my $pid = spawn($cmd, $env, $opts);
-       return unless defined $pid;
+       $opt ||= {};
+       $opt->{1} = fileno($w);
+       my $pid = spawn($cmd, $env, $opt);
        return ($r, $pid) if wantarray;
        my $ret = gensym;
-       tie *$ret, 'PublicInbox::ProcessPipe', $pid, $r;
+       tie *$ret, 'PublicInbox::ProcessPipe', $pid, $r, @$opt{qw(cb arg)};
        $ret;
 }
 
+sub run_die ($;$$) {
+       my ($cmd, $env, $rdr) = @_;
+       my $pid = spawn($cmd, $env, $rdr);
+       waitpid($pid, 0) == $pid or die "@$cmd did not finish";
+       $? == 0 or die "@$cmd failed: \$?=$?\n";
+}
+
 1;