1 # Copyright (C) 2016-2019 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
4 # This allows vfork to be used for spawning subprocesses if
5 # PERL_INLINE_DIRECTORY is explicitly defined in the environment.
6 # Under Linux, vfork can make a big difference in spawning performance
7 # as process size increases (fork still needs to mark pages for CoW use).
8 # Currently, we only use this for code intended for long running
9 # daemons (inside the PSGI code (-httpd) and -nntpd). The short-lived
10 # scripts (-mda, -index, -learn, -init) either use IPC::run or standard
13 package PublicInbox::Spawn;
16 use base qw(Exporter);
17 use Symbol qw(gensym);
19 use PublicInbox::ProcessPipe;
20 our @EXPORT_OK = qw/which spawn popen_rd/;
21 sub RLIMITS () { qw(RLIMIT_CPU RLIMIT_CORE RLIMIT_DATA) }
23 my $vfork_spawn = <<'VFORK_SPAWN';
24 #include <sys/types.h>
27 #include <sys/resource.h>
31 /* some platforms need alloca.h, but some don't */
32 #if defined(__GNUC__) && !defined(alloca)
33 # define alloca(sz) __builtin_alloca(sz)
40 * From the av_len apidoc:
41 * Note that, unlike what the name implies, it returns
42 * the highest index in the array, so to get the size of
43 * the array you need to use "av_len(av) + 1".
44 * This is unlike "sv_len", which returns what you would expect.
46 #define AV2C_COPY(dst, src) do { \
48 I32 top_index = av_len(src); \
49 I32 real_len = top_index + 1; \
50 I32 capa = real_len + 1; \
51 dst = alloca(capa * sizeof(char *)); \
52 for (i = 0; i < real_len; i++) { \
53 SV **sv = av_fetch(src, i, 0); \
54 dst[i] = SvPV_nolen(*sv); \
59 static void *deconst(const char *s)
61 union { const char *in; void *out; } u;
66 /* needs to be safe inside a vfork'ed process */
67 static void xerr(const char *msg)
70 const char *err = strerror(errno); /* should be safe in practice */
72 iov[0].iov_base = deconst(msg);
73 iov[0].iov_len = strlen(msg);
74 iov[1].iov_base = deconst(err);
75 iov[1].iov_len = strlen(err);
76 iov[2].iov_base = deconst("\n");
83 * unstable internal API. It'll be updated depending on
84 * whatever we'll need in the future.
85 * Be sure to update PublicInbox::SpawnPP if this changes
87 int pi_fork_exec(SV *redirref, SV *file, SV *cmdref, SV *envref, SV *rlimref)
89 AV *redir = (AV *)SvRV(redirref);
90 AV *cmd = (AV *)SvRV(cmdref);
91 AV *env = (AV *)SvRV(envref);
92 AV *rlim = (AV *)SvRV(rlimref);
93 const char *filename = SvPV_nolen(file);
100 AV2C_COPY(envp, env);
102 ret = sigfillset(&set);
103 assert(ret == 0 && "BUG calling sigfillset");
104 ret = sigprocmask(SIG_SETMASK, &set, &old);
105 assert(ret == 0 && "BUG calling sigprocmask to block");
109 I32 i, child_fd, max = av_len(redir);
111 for (child_fd = 0; child_fd <= max; child_fd++) {
112 SV **parent = av_fetch(redir, child_fd, 0);
113 int parent_fd = SvIV(*parent);
114 if (parent_fd == child_fd)
116 if (dup2(parent_fd, child_fd) < 0)
119 for (sig = 1; sig < NSIG; sig++)
120 signal(sig, SIG_DFL); /* ignore errors on signals */
123 for (i = 0; i < max; i += 3) {
125 SV **res = av_fetch(rlim, i, 0);
126 SV **soft = av_fetch(rlim, i + 1, 0);
127 SV **hard = av_fetch(rlim, i + 2, 0);
129 rl.rlim_cur = SvIV(*soft);
130 rl.rlim_max = SvIV(*hard);
131 if (setrlimit(SvIV(*res), &rl) < 0)
136 * don't bother unblocking, we don't want signals
137 * to the group taking out a subprocess
139 execve(filename, argv, envp);
140 xerr("execve failed");
143 ret = sigprocmask(SIG_SETMASK, &old, NULL);
144 assert(ret == 0 && "BUG calling sigprocmask to restore");
151 my $inline_dir = $ENV{PERL_INLINE_DIRECTORY};
152 $vfork_spawn = undef unless defined $inline_dir && -d $inline_dir && -w _;
153 if (defined $vfork_spawn) {
154 # Inline 0.64 or later has locking in multi-process env,
155 # but we support 0.5 on Debian wheezy
156 use Fcntl qw(:flock);
158 my $f = "$inline_dir/.public-inbox.lock";
159 open my $fh, '>', $f or die "failed to open $f: $!\n";
160 flock($fh, LOCK_EX) or die "LOCK_EX failed on $f: $!\n";
161 eval 'use Inline C => $vfork_spawn'; #, BUILD_NOISY => 1';
163 flock($fh, LOCK_UN) or die "LOCK_UN failed on $f: $!\n";
167 warn "Inline::C failed for vfork: $@\n";
168 $vfork_spawn = undef;
172 unless (defined $vfork_spawn) {
173 require PublicInbox::SpawnPP;
174 *pi_fork_exec = \&PublicInbox::SpawnPP::pi_fork_exec
179 return $file if index($file, '/') >= 0;
180 foreach my $p (split(':', $ENV{PATH})) {
188 my ($cmd, $env, $opts) = @_;
189 my $f = which($cmd->[0]);
190 defined $f or die "$cmd->[0]: command not found\n";
194 my %env = $env ? (%ENV, %$env) : %ENV;
195 while (my ($k, $v) = each %env) {
199 for my $child_fd (0..2) {
200 my $parent_fd = $opts->{$child_fd};
201 if (defined($parent_fd) && $parent_fd !~ /\A[0-9]+\z/) {
202 defined(my $fd = fileno($parent_fd)) or
203 die "$parent_fd not an IO GLOB? $!";
206 $redir->[$child_fd] = $parent_fd // $child_fd;
210 foreach my $l (RLIMITS()) {
211 defined(my $v = $opts->{$l}) or next;
212 my $r = eval "require BSD::Resource; BSD::Resource::$l();";
213 unless (defined $r) {
214 warn "$l undefined by BSD::Resource: $@\n";
217 push @$rlim, $r, @$v;
219 my $pid = pi_fork_exec($redir, $f, $cmd, \@env, $rlim);
220 $pid < 0 ? undef : $pid;
224 my ($cmd, $env, $opts) = @_;
225 pipe(my ($r, $w)) or die "pipe: $!\n";
227 $opts->{1} = fileno($w);
228 my $pid = spawn($cmd, $env, $opts);
229 return unless defined $pid;
230 return ($r, $pid) if wantarray;
232 tie *$ret, 'PublicInbox::ProcessPipe', $pid, $r;