about summary refs log tree commit homepage
path: root/lib/PublicInbox/Inotify.pm
diff options
context:
space:
mode:
authorEric Wong <e@80x24.org>2023-03-28 11:12:36 +0000
committerEric Wong <e@80x24.org>2023-03-29 04:36:42 +0000
commit687f579ab401cc9ddf63e9901c37c37ab7d4eef1 (patch)
treed694b635940db1239109eaabc2268813c8e84e1b /lib/PublicInbox/Inotify.pm
parent6061f4e7b3c68bb4f41960c4df2c1eddcbdc86d9 (diff)
downloadpublic-inbox-687f579ab401cc9ddf63e9901c37c37ab7d4eef1.tar.gz
As encountered by Louis DeLosSantos, Linux inotify is capped by
a lesser-known limit than the standard RLIMIT_NOFILE (`ulimit -n`)
value.  Give the user a hint about the fs.inotify.max_user_instances
sysctl knob on EMFILE, since EMFILE alone may mislead users into
thinking they've hit the (typically higher) RLIMIT_NOFILE limit.

I can test this on my system using:

  perl -I lib -MPublicInbox::Inotify -E \
   'my @x = map { PublicInbox::Inotify->new } (1..128)'

But I hesitate to include it in the test suite since triggering
the limit can cause unrelated processes to fail.

Link: https://public-inbox.org/meta/CAE6jdTo8iQfNM9Yuk0Dwi-ARMxmQxX-onL8buXcQ9Ze3r0hKrg@mail.gmail.com/
Reported-by: Louis DeLosSantos <louis.delos@gmail.com>
Diffstat (limited to 'lib/PublicInbox/Inotify.pm')
-rw-r--r--lib/PublicInbox/Inotify.pm30
1 files changed, 30 insertions, 0 deletions
diff --git a/lib/PublicInbox/Inotify.pm b/lib/PublicInbox/Inotify.pm
new file mode 100644
index 00000000..3ef271c8
--- /dev/null
+++ b/lib/PublicInbox/Inotify.pm
@@ -0,0 +1,30 @@
+# Copyright (C) all contributors <meta@public-inbox.org>
+# License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
+
+# wrap Linux::Inotify2 XS module, support pure Perl via `syscall' someday
+package PublicInbox::Inotify;
+use v5.12;
+our @ISA;
+BEGIN {
+        eval { require Linux::Inotify2 };
+        if ($@) { # TODO: get rid of XS dependency
+                die "W: Linux::Inotify2 missing: $@\n";
+        } else {
+                push @ISA, 'Linux::Inotify2';
+        }
+};
+
+sub new {
+        $_[0]->SUPER::new // do {
+                my $msg = $!{EMFILE} ? <<EOM : "$_[0]->new: $!\n";
+inotify_init/inotify_init1: $!
+You may need to raise the `fs.inotify.max_user_instances' sysctl limit.
+Consult your OS documentation and/or sysctl(8) + sysctl.conf(5) manpages.
+EOM
+                $msg =~ s/^/E: /smg;
+                require Carp;
+                Carp::croak($msg);
+        }
+}
+
+1;