* [PATCH 7/9] rename ProcessPipe to ProcessIO
2023-10-07 21:24 7% [PATCH 0/9] more process-related cleanups Eric Wong
@ 2023-10-07 21:24 3% ` Eric Wong
0 siblings, 0 replies; 2+ results
From: Eric Wong @ 2023-10-07 21:24 UTC (permalink / raw)
To: meta
Since we deal with pipes (of either direction) and bidirectional
stream sockets for this class, it's better to remove the `Pipe'
from the name and replace it with `IO' to communicate that it
works for any form of IO::Handle-like object tied to a process.
---
MANIFEST | 2 +-
lib/PublicInbox/Gcf2Client.pm | 4 ++--
lib/PublicInbox/Git.pm | 4 ++--
lib/PublicInbox/HTTPD/Async.pm | 2 +-
lib/PublicInbox/LeiRediff.pm | 2 +-
lib/PublicInbox/LeiToMail.pm | 4 ++--
lib/PublicInbox/{ProcessPipe.pm => ProcessIO.pm} | 8 +++-----
lib/PublicInbox/Qspawn.pm | 4 ++--
lib/PublicInbox/Spamcheck/Spamc.pm | 2 +-
lib/PublicInbox/Spawn.pm | 6 +++---
t/spawn.t | 4 ++--
11 files changed, 20 insertions(+), 22 deletions(-)
rename lib/PublicInbox/{ProcessPipe.pm => ProcessIO.pm} (86%)
diff --git a/MANIFEST b/MANIFEST
index 689c6bf6..c972818f 100644
--- a/MANIFEST
+++ b/MANIFEST
@@ -318,7 +318,7 @@ lib/PublicInbox/OverIdx.pm
lib/PublicInbox/POP3.pm
lib/PublicInbox/POP3D.pm
lib/PublicInbox/PktOp.pm
-lib/PublicInbox/ProcessPipe.pm
+lib/PublicInbox/ProcessIO.pm
lib/PublicInbox/Qspawn.pm
lib/PublicInbox/Reply.pm
lib/PublicInbox/RepoAtom.pm
diff --git a/lib/PublicInbox/Gcf2Client.pm b/lib/PublicInbox/Gcf2Client.pm
index 4a0348b4..f63a0335 100644
--- a/lib/PublicInbox/Gcf2Client.pm
+++ b/lib/PublicInbox/Gcf2Client.pm
@@ -10,7 +10,7 @@ use PublicInbox::Gcf2; # fails if Inline::C or libgit2-dev isn't available
use PublicInbox::Spawn qw(spawn);
use Socket qw(AF_UNIX SOCK_STREAM);
use PublicInbox::Syscall qw(EPOLLIN);
-use PublicInbox::ProcessPipe;
+use PublicInbox::ProcessIO;
use autodie qw(socketpair);
# fields:
@@ -33,7 +33,7 @@ sub new {
my $cmd = [$^X, $^W ? ('-w') : (),
qw[-MPublicInbox::Gcf2 -e PublicInbox::Gcf2::loop]];
my $pid = spawn($cmd, $env, $opt);
- my $sock = PublicInbox::ProcessPipe->maybe_new($pid, $s1);
+ my $sock = PublicInbox::ProcessIO->maybe_new($pid, $s1);
$self->{inflight} = [];
$self->{epwatch} = \undef; # for Git->cleanup
$self->SUPER::new($sock, EPOLLIN);
diff --git a/lib/PublicInbox/Git.pm b/lib/PublicInbox/Git.pm
index 0fd621e1..94d5dcee 100644
--- a/lib/PublicInbox/Git.pm
+++ b/lib/PublicInbox/Git.pm
@@ -165,7 +165,7 @@ sub _sock_cmd {
$self->fail("tmpfile($id): $!");
}
my $pid = spawn(\@cmd, undef, $opt);
- $self->{sock} = PublicInbox::ProcessPipe->maybe_new($pid, $s1);
+ $self->{sock} = PublicInbox::ProcessIO->maybe_new($pid, $s1);
}
sub poll_in ($) { IO::Poll::_poll($RDTIMEO, fileno($_[0]), my $ev = POLLIN) }
@@ -626,7 +626,7 @@ sub cleanup_if_unlinked {
my $ret = 0;
for my $obj ($self, ($self->{ck} // ())) {
my $sock = $obj->{sock} // next;
- my PublicInbox::ProcessPipe $pp = tied *$sock; # ProcessPipe
+ my PublicInbox::ProcessIO $pp = tied *$sock; # ProcessIO
my $pid = $pp->{pid} // next;
open my $fh, '<', "/proc/$pid/maps" or return cleanup($self, 1);
while (<$fh>) {
diff --git a/lib/PublicInbox/HTTPD/Async.pm b/lib/PublicInbox/HTTPD/Async.pm
index 7bbab1e1..b9d2159c 100644
--- a/lib/PublicInbox/HTTPD/Async.pm
+++ b/lib/PublicInbox/HTTPD/Async.pm
@@ -37,7 +37,7 @@ sub new {
arg => $arg, # arg for $cb
end_obj => $end_obj, # like END{}, can ->event_step
}, $class;
- my $pp = tied *$io; # ProcessPipe
+ my $pp = tied *$io; # ProcessIO
$pp->{fh}->blocking(0) // die "$io->blocking(0): $!";
$self->SUPER::new($io, EPOLLIN);
}
diff --git a/lib/PublicInbox/LeiRediff.pm b/lib/PublicInbox/LeiRediff.pm
index a886931c..b894342b 100644
--- a/lib/PublicInbox/LeiRediff.pm
+++ b/lib/PublicInbox/LeiRediff.pm
@@ -152,7 +152,7 @@ sub requote ($$) {
# $^X (perl) is overkill, but maybe there's a weird system w/o sed
my ($w, $pid) = popen_wr([$^X, '-pe', "s/^/$pfx/"], $lei->{env}, $opt);
$w->autoflush(1);
- binmode $w, ':utf8'; # incompatible with ProcessPipe due to syswrite
+ binmode $w, ':utf8'; # incompatible with ProcessIO due to syswrite
$lei->{1} = $w;
PublicInbox::OnDestroy->new(\&wait_requote, $lei, $pid, $old_1);
}
diff --git a/lib/PublicInbox/LeiToMail.pm b/lib/PublicInbox/LeiToMail.pm
index f239da82..f56ad330 100644
--- a/lib/PublicInbox/LeiToMail.pm
+++ b/lib/PublicInbox/LeiToMail.pm
@@ -7,7 +7,7 @@ use strict;
use v5.10.1;
use parent qw(PublicInbox::IPC);
use PublicInbox::Eml;
-use PublicInbox::ProcessPipe;
+use PublicInbox::ProcessIO;
use PublicInbox::Spawn qw(spawn);
use IO::Handle; # ->autoflush
use Fcntl qw(SEEK_SET SEEK_END O_CREAT O_EXCL O_WRONLY);
@@ -162,7 +162,7 @@ sub _post_augment_mbox { # open a compressor process from top-level lei-daemon
my ($r, $w) = @{delete $lei->{zpipe}};
my $rdr = { 0 => $r, 1 => $lei->{1}, 2 => $lei->{2}, pgid => 0 };
my $pid = spawn($cmd, undef, $rdr);
- $lei->{1} = PublicInbox::ProcessPipe->maybe_new($pid, $w, {
+ $lei->{1} = PublicInbox::ProcessIO->maybe_new($pid, $w, {
cb_arg => [\&reap_compress, $lei, $cmd, $lei->{1} ] });
}
diff --git a/lib/PublicInbox/ProcessPipe.pm b/lib/PublicInbox/ProcessIO.pm
similarity index 86%
rename from lib/PublicInbox/ProcessPipe.pm
rename to lib/PublicInbox/ProcessIO.pm
index ba2c1ecb..eeb66139 100644
--- a/lib/PublicInbox/ProcessPipe.pm
+++ b/lib/PublicInbox/ProcessIO.pm
@@ -1,11 +1,9 @@
# Copyright (C) all contributors <meta@public-inbox.org>
# License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
-# a tied handle for auto reaping of children tied to a read-only pipe, see perltie(1)
-# DO NOT use this as-is for bidirectional pipes/sockets (e.g. in PublicInbox::Git),
-# both ends of the pipe must be at the same level of the Perl object hierarchy
-# to ensure orderly destruction.
-package PublicInbox::ProcessPipe;
+# a tied handle for auto reaping of children tied to a pipe or socket,
+# see perltie(1) for details.
+package PublicInbox::ProcessIO;
use v5.12;
use PublicInbox::DS qw(awaitpid);
use Symbol qw(gensym);
diff --git a/lib/PublicInbox/Qspawn.pm b/lib/PublicInbox/Qspawn.pm
index 5e4fd5cb..ea7ae647 100644
--- a/lib/PublicInbox/Qspawn.pm
+++ b/lib/PublicInbox/Qspawn.pm
@@ -124,7 +124,7 @@ sub finish ($;$) {
# we can safely finalize if pipe was closed before, or if
# {_err} is defined by waitpid_err. Deleting {rpipe} will
- # trigger PublicInbox::ProcessPipe::DESTROY -> waitpid_err,
+ # trigger PublicInbox::ProcessIO::DESTROY -> waitpid_err,
# but it may not fire right away if inside the event loop.
my $closed_before = !delete($self->{rpipe});
finalize($self) if $closed_before || defined($self->{_err});
@@ -251,7 +251,7 @@ sub psgi_return_init_cb { # this may be PublicInbox::HTTPD::Async {cb}
if (ref($r) ne 'ARRAY' || scalar(@$r) == 3) { # error
if ($async) { # calls rpipe->close && ->event_step
$async->close; # PublicInbox::HTTPD::Async::close
- } else { # generic PSGI, use PublicInbox::ProcessPipe::CLOSE
+ } else { # generic PSGI, use PublicInbox::ProcessIO::CLOSE
delete($self->{rpipe})->close;
event_step($self);
}
diff --git a/lib/PublicInbox/Spamcheck/Spamc.pm b/lib/PublicInbox/Spamcheck/Spamc.pm
index 726866c8..cba33a66 100644
--- a/lib/PublicInbox/Spamcheck/Spamc.pm
+++ b/lib/PublicInbox/Spamcheck/Spamc.pm
@@ -27,7 +27,7 @@ sub spamcheck {
$out = \$buf;
}
$$out = do { local $/; <$fh> };
- close $fh; # PublicInbox::ProcessPipe::CLOSE
+ close $fh; # PublicInbox::ProcessIO::CLOSE
($? || $$out eq '') ? 0 : 1;
}
diff --git a/lib/PublicInbox/Spawn.pm b/lib/PublicInbox/Spawn.pm
index 4c7e0f80..cb8b21c6 100644
--- a/lib/PublicInbox/Spawn.pm
+++ b/lib/PublicInbox/Spawn.pm
@@ -21,7 +21,7 @@ use PublicInbox::Lock;
use Fcntl qw(SEEK_SET);
use IO::Handle ();
use Carp qw(croak);
-use PublicInbox::ProcessPipe;
+use PublicInbox::ProcessIO;
our @EXPORT_OK = qw(which spawn popen_rd popen_wr run_die run_wait);
our @RLIMITS = qw(RLIMIT_CPU RLIMIT_CORE RLIMIT_DATA);
@@ -368,13 +368,13 @@ sub spawn ($;$$) {
sub popen_rd {
my ($cmd, $env, $opt) = @_;
pipe(my $r, local $opt->{1}) or die "pipe: $!\n";
- PublicInbox::ProcessPipe->maybe_new(spawn($cmd, $env, $opt), $r, $opt)
+ PublicInbox::ProcessIO->maybe_new(spawn($cmd, $env, $opt), $r, $opt)
}
sub popen_wr {
my ($cmd, $env, $opt) = @_;
pipe(local $opt->{0}, my $w) or die "pipe: $!\n";
- PublicInbox::ProcessPipe->maybe_new(spawn($cmd, $env, $opt), $w, $opt)
+ PublicInbox::ProcessIO->maybe_new(spawn($cmd, $env, $opt), $w, $opt)
}
sub run_wait ($;$$) {
diff --git a/t/spawn.t b/t/spawn.t
index 04589437..be5aaf9f 100644
--- a/t/spawn.t
+++ b/t/spawn.t
@@ -149,8 +149,8 @@ EOF
$fh = popen_rd(['true'], undef, { cb_arg => [sub { @c = caller }] });
undef $fh; # ->DESTROY
ok(scalar(@c), 'callback fired by ->DESTROY');
- ok(grep(!m[/PublicInbox/ProcessPipe\.pm\z], @c),
- 'callback not invoked by ProcessPipe');
+ ok(grep(!m[/PublicInbox/ProcessIO\.pm\z], @c),
+ 'callback not invoked by ProcessIO');
}
{ # children don't wait on siblings
^ permalink raw reply related [relevance 3%]
* [PATCH 0/9] more process-related cleanups
@ 2023-10-07 21:24 7% Eric Wong
2023-10-07 21:24 3% ` [PATCH 7/9] rename ProcessPipe to ProcessIO Eric Wong
0 siblings, 1 reply; 2+ results
From: Eric Wong @ 2023-10-07 21:24 UTC (permalink / raw)
To: meta
2/9 fixes an annoying syslog error I spotted running tests;
3/9 is long overdue, and there's a few more overdue things
coming up...
Eric Wong (9):
xt/httpd-async-stream: avoid waitpid call
lei: do not issue sto->done if socket is inactive
lei: always use async `done' requests to store
ipc: require fork+SOCK_SEQPACKET for wq_* functions
ipc: use autodie for most syscalls
import: use autodie, rely on PerlIO for retries
rename ProcessPipe to ProcessIO
process_io: pass args to awaitpid as list
cindex: start using autodie
MANIFEST | 3 +-
lib/PublicInbox/CodeSearchIdx.pm | 70 ++++++++--------
lib/PublicInbox/Gcf2Client.pm | 4 +-
lib/PublicInbox/Git.pm | 4 +-
lib/PublicInbox/HTTPD/Async.pm | 2 +-
lib/PublicInbox/IPC.pm | 82 ++++++++-----------
lib/PublicInbox/Import.pm | 45 ++++------
lib/PublicInbox/LEI.pm | 11 ++-
lib/PublicInbox/LeiInput.pm | 2 +-
lib/PublicInbox/LeiRediff.pm | 2 +-
lib/PublicInbox/LeiRemote.pm | 2 +-
lib/PublicInbox/LeiStore.pm | 17 ++--
lib/PublicInbox/LeiToMail.pm | 6 +-
lib/PublicInbox/LeiXSearch.pm | 6 +-
.../{ProcessPipe.pm => ProcessIO.pm} | 12 ++-
lib/PublicInbox/Qspawn.pm | 8 +-
lib/PublicInbox/Spamcheck/Spamc.pm | 2 +-
lib/PublicInbox/Spawn.pm | 12 +--
t/ipc.t | 19 ++---
t/lei-store-fail.t | 51 ++++++++++++
t/spawn.t | 12 +--
xt/httpd-async-stream.t | 6 +-
22 files changed, 196 insertions(+), 182 deletions(-)
rename lib/PublicInbox/{ProcessPipe.pm => ProcessIO.pm} (83%)
create mode 100644 t/lei-store-fail.t
^ permalink raw reply [relevance 7%]
Results 1-2 of 2 | reverse | options above
-- pct% links below jump to the message on this page, permalinks otherwise --
2023-10-07 21:24 7% [PATCH 0/9] more process-related cleanups Eric Wong
2023-10-07 21:24 3% ` [PATCH 7/9] rename ProcessPipe to ProcessIO Eric Wong
Code repositories for project(s) associated with this public inbox
https://80x24.org/public-inbox.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).