1 # Copyright (C) all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
4 # Contains common daemon code for the httpd, imapd, and nntpd servers
5 # and designed for handling thousands of untrusted clients over slow
6 # and/or lossy connections.
7 package PublicInbox::Daemon;
10 use Getopt::Long qw(:config gnu_getopt no_ignore_case auto_abbrev);
11 use IO::Handle; # ->autoflush
14 use POSIX qw(WNOHANG :signal_h);
15 use Socket qw(IPPROTO_TCP SOL_SOCKET);
18 use PublicInbox::DS qw(now);
19 use PublicInbox::Listener;
20 use PublicInbox::EOFpipe;
21 use PublicInbox::Sigfd;
23 use PublicInbox::GitAsyncCat;
25 our $SO_ACCEPTFILTER = 0x1000;
27 my ($set_user, $oldset);
28 my (@cfg_listen, $stdout, $stderr, $group, $user, $pid_file, $daemonize);
29 my $worker_processes = 1;
32 my %tls_opt; # scheme://sockname => args for IO::Socket::SSL->start_SSL
35 my ($default_cert, $default_key);
36 my %KNOWN_TLS = (443 => 'https', 563 => 'nntps', 993 => 'imaps', 995 =>'pop3s');
37 my %KNOWN_STARTTLS = (110 => 'pop3', 119 => 'nntp', 143 => 'imap');
39 sub listener_opt ($) {
40 my ($str) = @_; # opt1=val1,opt2=val2 (opt may repeat for multi-value)
42 # allow ',' as delimiter since '&' is shell-unfriendly
43 for (split(/[,&]/, $str)) {
44 my ($k, $v) = split(/=/, $_, 2);
48 # key may be a part of cert. At least
49 # p5-io-socket-ssl/example/ssl_server.pl has this fallback:
50 $o->{cert} //= [ $default_cert ] if defined($default_cert);
51 $o->{key} //= defined($default_key) ? [ $default_key ] : $o->{cert};
55 sub accept_tls_opt ($) {
57 my $o = ref($opt) eq 'HASH' ? $opt : listener_opt($opt);
58 return if !defined($o->{cert});
59 require PublicInbox::TLS;
60 my %ctx_opt = (SSL_server => 1);
61 # parse out hostname:/path/to/ mappings:
62 for my $k (qw(cert key)) {
64 my $x = $ctx_opt{'SSL_'.$k.'_file'} = {};
65 foreach my $path (@{$o->{$k}}) {
67 $path =~ s/\A([^:]+):// and $host = $1;
69 check_absolute($k, $path) if $daemonize;
72 my $ctx = IO::Socket::SSL::SSL_Context->new(%ctx_opt) or
73 die 'SSL_Context->new: '.PublicInbox::TLS::err();
75 # save ~34K per idle connection (cf. SSL_CTX_set_mode(3ssl))
76 # RSS goes from 346MB to 171MB with 10K idle NNTPS clients on amd64
77 # cf. https://rt.cpan.org/Ticket/Display.html?id=129463
78 my $mode = eval { Net::SSLeay::MODE_RELEASE_BUFFERS() };
79 if ($mode && $ctx->{context}) {
80 eval { Net::SSLeay::CTX_set_mode($ctx->{context}, $mode) };
81 warn "W: $@ (setting SSL_MODE_RELEASE_BUFFERS)\n" if $@;
84 { SSL_server => 1, SSL_startHandshake => 0, SSL_reuse_ctx => $ctx };
87 sub check_absolute ($$) {
89 die <<EOM if index($val // '/', '/') != 0;
90 $var must be an absolute path when using --daemonize: $val
97 chown($uid, $gid, $path) or warn "chown $path: $!\n";
100 sub open_log_path ($$) { # my ($fh, $path) = @_; # $_[0] is modified
101 open $_[0], '>>', $_[1] or die "open(>> $_[1]): $!";
107 my ($scheme, $opt) = @_;
108 my $modc = "PublicInbox::\U$scheme";
110 eval "require $mod"; # IMAPD|HTTPD|NNTPD|POP3D
113 my $tlsd = $xn{tlsd} = $mod->new;
115 substr($_, length('env.')) => $opt->{$_}->[-1];
116 } grep(/\Aenv\./, keys %$opt);
119 local @ENV{keys %env} = values %env;
120 $tlsd->refresh_groups($sig);
122 $xn{post_accept} = $tlsd->can('post_accept_cb') ?
123 $tlsd->post_accept_cb : sub { $modc->new($_[0], $tlsd) };
124 my @paths = qw(out err);
125 if ($modc eq 'PublicInbox::HTTP') {
127 $xn{af_default} = 'httpready';
128 if (my $p = $opt->{psgi}) {
129 die "multiple psgi= options specified\n" if @$p > 1;
130 check_absolute('psgi=', $p->[0]) if $daemonize;
131 $tlsd->{psgi} = $p->[0];
132 warn "# $scheme://$addr psgi=$p->[0]\n";
136 my $p = $opt->{$f} or next;
137 die "multiple $f= options specified\n" if @$p > 1;
138 check_absolute("$f=", $p->[0]) if $daemonize;
139 $p = File::Spec->canonpath($p->[0]);
140 open_log_path(my $fh, $p);
141 $tlsd->{$f} = $logs{$p} = $fh;
142 warn "# $scheme://$addr $f=$p\n";
147 sub daemon_prepare ($$) {
148 my ($default_listen, $xnetd) = @_;
149 my $listener_names = {}; # sockname => IO::Handle
150 $oldset = PublicInbox::DS::block_signals();
152 my ($prog) = ($CMD[0] =~ m!([^/]+)\z!g);
153 my $dh = defined($default_listen) ? " (default: $default_listen)" : '';
155 usage: $prog [-l ADDRESS] [--cert=FILE] [--key=FILE]
159 -l ADDRESS address to listen on$dh
160 --cert=FILE default SSL/TLS certificate
161 --key=FILE default SSL/TLS certificate
162 -W WORKERS number of worker processes to spawn (default: 1)
164 See public-inbox-daemon(8) and $prog(1) man pages for more.
167 'l|listen=s' => \@cfg_listen,
168 '1|stdout=s' => \$stdout,
169 '2|stderr=s' => \$stderr,
170 'W|worker-processes=i' => \$worker_processes,
171 'P|pid-file=s' => \$pid_file,
172 'u|user=s' => \$user,
173 'g|group=s' => \$group,
174 'D|daemonize' => \$daemonize,
175 'cert=s' => \$default_cert,
176 'key=s' => \$default_key,
177 'help|h' => \(my $show_help),
179 GetOptions(%opt) or die $help;
180 if ($show_help) { print $help; exit 0 };
182 $_ = File::Spec->canonpath($_ // next) for ($stdout, $stderr);
183 if (defined $pid_file && $pid_file =~ /\.oldbin\z/) {
184 die "--pid-file cannot end with '.oldbin'\n";
186 @listeners = inherit($listener_names);
188 # allow socket-activation users to set certs once and not
189 # have to configure each socket:
190 my @inherited_names = keys(%$listener_names) if defined($default_cert);
192 # ignore daemonize when inheriting
193 $daemonize = undef if scalar @listeners;
195 unless (@listeners || @cfg_listen) {
196 $default_listen // die "no listeners specified\n";
197 push @cfg_listen, $default_listen
200 foreach my $l (@cfg_listen) {
203 if ($l =~ s!\A([^:]+)://!!) {
205 } elsif ($l =~ /\A(?:\[[^\]]+\]|[^:]+):([0-9])+/) {
206 my $s = $KNOWN_TLS{$1} // $KNOWN_STARTTLS{$1};
207 $scheme = $s if defined $s;
209 my $opt; # non-TLS options
210 if ($l =~ s!/?\?(.+)\z!!) {
211 $opt = listener_opt($1);
212 $tls_opt{"$scheme://$l"} = accept_tls_opt($opt);
213 } elsif (defined($default_cert)) {
214 $tls_opt{"$scheme://$l"} = accept_tls_opt('');
215 } elsif ($scheme =~ /\A(?:https|imaps|nntps|pop3s)\z/) {
216 die "$orig specified w/o cert=\n";
218 $scheme =~ /\A(http|imap|nntp|pop3)/ and
219 $xnetd->{$l} = load_mod($1, $opt);
221 next if $listener_names->{$l}; # already inherited
223 if (index($l, '/') == 0) {
224 $sock_pkg = 'IO::Socket::UNIX';
225 eval "use $sock_pkg";
227 %o = (Type => SOCK_STREAM, Peer => $l);
229 my $c = $sock_pkg->new(%o);
230 if (!defined($c) && $!{ECONNREFUSED}) {
232 "failed to unlink stale socket=$l: $!\n";
233 } # else: let the bind fail
235 $o{Local} = delete $o{Peer};
237 # both work for IPv4, too
238 for (qw(IO::Socket::IP IO::Socket::INET6)) {
240 eval "use $sock_pkg";
244 %o = (LocalAddr => $l, ReuseAddr => 1, Proto => 'tcp');
247 my $prev = umask 0000;
248 my $s = eval { $sock_pkg->new(%o) };
249 warn "error binding $l: $! ($@)\n" unless $s;
253 my $k = sockname($s);
254 warn "# bound $scheme://$k\n";
255 $listener_names->{$k} = $s;
260 # cert/key options in @cfg_listen takes precedence when inheriting,
261 # but map well-known inherited ports if --listen isn't specified
263 for my $sockname (@inherited_names) {
264 $sockname =~ /:([0-9]+)\z/ or next;
265 if (my $scheme = $KNOWN_TLS{$1}) {
266 $xnetd->{$sockname} = load_mod(substr($scheme, 0, -1));
267 $tls_opt{"$scheme://$sockname"} ||= accept_tls_opt('');
268 } elsif (($scheme = $KNOWN_STARTTLS{$1})) {
269 $xnetd->{$sockname} = load_mod($scheme);
270 $tls_opt{"$scheme://$sockname"} ||= accept_tls_opt('');
271 $tls_opt{''} ||= accept_tls_opt('');
275 while (my ($k, $v) = each %tls_opt) { push(@d, $k) if !defined($v) }
277 die "No listeners bound\n" unless @listeners;
283 foreach my $i (0..$#ARGV) {
286 $ARGV[$i] = Cwd::abs_path($arg);
288 check_absolute('--stdout', $stdout);
289 check_absolute('--stderr', $stderr);
290 check_absolute('--pid-file', $pid_file);
291 check_absolute('--cert', $default_cert);
292 check_absolute('--key', $default_key);
294 chdir '/' or die "chdir failed: $!";
296 if (defined($pid_file) || defined($group) || defined($user)) {
297 eval { require Net::Server::Daemonize; 1 } // die <<EOF;
298 Net::Server required for --pid-file, --group, --user
302 Net::Server::Daemonize::check_pid_file($pid_file) if defined $pid_file;
303 $uid = Net::Server::Daemonize::get_uid($user) if defined $user;
304 if (defined $group) {
305 $gid = Net::Server::Daemonize::get_gid($group);
306 $gid = (split /\s+/, $gid)[0];
307 } elsif (defined $uid) {
308 $gid = (getpwuid($uid))[3];
311 # We change users in the worker to ensure upgradability,
312 # The upgrade will create the ".oldbin" pid file in the
313 # same directory as the given pid file.
314 $uid and $set_user = sub {
316 Net::Server::Daemonize::set_user($uid, $gid);
320 my $pid = fork // die "fork: $!";
323 open(STDIN, '+<', '/dev/null') or
324 die "redirect stdin failed: $!\n";
325 open STDOUT, '>&STDIN' or die "redirect stdout failed: $!\n";
326 open STDERR, '>&STDIN' or die "redirect stderr failed: $!\n";
328 $pid = fork // die "fork: $!";
331 return unless defined $pid_file;
333 write_pid($pid_file);
335 bless { pid => $$, pid_file => \$pid_file }, __PACKAGE__;
338 sub worker_quit { # $_[0] = signal name or number (unused)
339 # killing again terminates immediately:
340 exit unless @listeners;
342 $_->close foreach @listeners; # call PublicInbox::DS::close
346 # drop idle connections and try to quit gracefully
347 PublicInbox::DS->SetPostLoopCallback(sub {
348 my ($dmap, undef) = @_;
351 for my $s (values %$dmap) {
352 $s->can('busy') or next;
355 } else { # close as much as possible, early as possible
360 if (($warn + 5) < now()) {
361 warn "$$ quitting, $n client(s) left\n";
364 unless (defined $proc_name) {
365 $proc_name = (split(/\s+/, $0))[0];
366 $proc_name =~ s!\A.*?([^/]+)\z!$1!;
368 $0 = "$proc_name quitting, $n client(s) left";
370 $n; # true: loop continues, false: loop breaks
375 $logs{$stdout} //= \*STDOUT if defined $stdout;
376 $logs{$stderr} //= \*STDERR if defined $stderr;
377 while (my ($p, $fh) = each %logs) { open_log_path($fh, $p) }
382 my $addr = getsockname($s) or return;
383 my ($host, $port) = host_with_port($addr);
384 if ($port == 0 && $host eq '127.0.0.1') {
385 my ($path) = Socket::sockaddr_un($addr);
391 sub unpack_ipv6 ($) {
395 # Socket.pm in Perl 5.14+ supports IPv6:
397 ($port, $host) = Socket::unpack_sockaddr_in6($addr);
398 $host = Socket::inet_ntop(Socket::AF_INET6(), $host);
402 # Perl 5.12 or earlier? SpamAssassin and Net::Server use
403 # Socket6, so it may be installed on our system, already
404 # (otherwise die here):
407 ($port, $host) = Socket6::unpack_sockaddr_in6($addr);
408 $host = Socket6::inet_ntop(Socket6::AF_INET6(), $host);
413 sub host_with_port ($) {
417 # this eval will die on Unix sockets:
419 if (length($addr) >= 28) {
420 ($host, $port) = unpack_ipv6($addr);
423 ($port, $host) = Socket::sockaddr_in($addr);
424 $host = Socket::inet_ntoa($host);
427 $@ ? ('127.0.0.1', 0) : ($host, $port);
431 my ($listener_names) = @_;
432 return () if ($ENV{LISTEN_PID} || 0) != $$;
433 my $fds = $ENV{LISTEN_FDS} or return ();
434 my $end = $fds + 2; # LISTEN_FDS_START - 1
436 foreach my $fd (3..$end) {
437 open(my $s, '<&=', $fd) or warn "fdopen fd=$fd: $!";
438 if (my $k = sockname($s)) {
439 my $prev_was_blocking = $s->blocking(0);
440 warn <<"" if $prev_was_blocking;
441 Inherited socket ($k fd=$fd) is blocking, making it non-blocking.
442 Set 'NonBlocking = true' in the systemd.service unit to avoid stalled
443 processes when multiple service instances start.
445 $listener_names->{$k} = $s;
446 warn "# inherited $k fd=$fd\n";
449 warn "failed to inherit fd=$fd (LISTEN_FDS=$fds)";
455 sub upgrade { # $_[0] = signal name or number (unused)
457 warn "upgrade in-progress: $reexec_pid\n";
460 if (defined $pid_file) {
461 if ($pid_file =~ /\.oldbin\z/) {
462 warn "BUG: .oldbin suffix exists: $pid_file\n";
465 unlink_pid_file_safe_ish($$, $pid_file);
466 $pid_file .= '.oldbin';
467 write_pid($pid_file);
470 unless (defined $pid) {
471 warn "fork failed: $!\n";
475 use Fcntl qw(FD_CLOEXEC F_SETFD F_GETFD);
476 $ENV{LISTEN_FDS} = scalar @listeners;
477 $ENV{LISTEN_PID} = $$;
478 foreach my $s (@listeners) {
479 # @listeners are globs with workers, PI::L w/o workers
480 $s = $s->{sock} if ref($s) eq 'PublicInbox::Listener';
482 my $fl = fcntl($s, F_GETFD, 0);
483 fcntl($s, F_SETFD, $fl &= ~FD_CLOEXEC);
486 die "Failed to exec: $!\n";
491 sub kill_workers ($) {
493 kill $sig, keys(%pids);
496 sub upgrade_aborted ($) {
498 warn "reexec PID($p) died with: $?\n";
500 return unless $pid_file;
502 my $file = $pid_file;
503 $file =~ s/\.oldbin\z// or die "BUG: no '.oldbin' suffix in $file";
504 unlink_pid_file_safe_ish($$, $pid_file);
506 eval { write_pid($pid_file) };
510 sub reap_children { # $_[0] = 'CHLD' or POSIX::SIGCHLD()
512 my $p = waitpid(-1, WNOHANG) or return;
513 if (defined $reexec_pid && $p == $reexec_pid) {
515 } elsif (defined(my $id = delete $pids{$p})) {
516 warn "worker[$id] PID($p) died with: $?\n";
518 warn "unknown PID($p) reaped: $?\n";
525 sub unlink_pid_file_safe_ish ($$) {
526 my ($unlink_pid, $file) = @_;
527 return unless defined $unlink_pid && $unlink_pid == $$;
529 open my $fh, '<', $file or return;
531 defined(my $read_pid = <$fh>) or return;
533 if ($read_pid == $unlink_pid) {
534 Net::Server::Daemonize::unlink_pid_file($file);
538 sub master_quit ($) {
539 exit unless @listeners;
545 pipe(my ($p0, $p1)) or die "failed to create parent-pipe: $!";
546 my $set_workers = $worker_processes;
550 USR1 => sub { reopen_logs(); kill_workers($_[0]); },
552 QUIT => \&master_quit,
553 INT => \&master_quit,
554 TERM => \&master_quit,
556 return if $ignore_winch || !@listeners;
557 if (-t STDIN || -t STDOUT || -t STDERR) {
560 ignoring SIGWINCH since we are not daemonized
563 $worker_processes = 0;
567 return unless @listeners;
568 $worker_processes = $set_workers;
572 return unless @listeners;
573 if ($set_workers > $worker_processes) {
576 $worker_processes = ++$set_workers;
580 $worker_processes = --$set_workers if $set_workers > 0;
582 CHLD => \&reap_children,
584 my $sigfd = PublicInbox::Sigfd->new($sig);
585 local @SIG{keys %$sig} = values(%$sig) unless $sigfd;
586 PublicInbox::DS::sig_setmask($oldset) if !$sigfd;
587 while (1) { # main loop
588 my $n = scalar keys %pids;
589 unless (@listeners) {
591 $set_workers = $worker_processes = $n = 0;
594 if ($n > $worker_processes) {
595 while (my ($k, $v) = each %pids) {
596 kill('TERM', $k) if $v >= $worker_processes;
598 $n = $worker_processes;
600 my $want = $worker_processes - 1;
602 PublicInbox::DS::block_signals() if !$sigfd;
603 for my $i ($n..$want) {
604 my $seed = rand(0xffffffff);
607 warn "failed to fork worker[$i]: $!\n";
608 } elsif ($pid == 0) {
610 eval { Net::SSLeay::randomize() };
611 $set_user->() if $set_user;
612 return $p0; # run normal work code
614 warn "PID=$pid is worker[$i]\n";
618 PublicInbox::DS::sig_setmask($oldset) if !$sigfd;
621 if ($sigfd) { # Linux and IO::KQueue users:
623 } else { # wake up every second
627 exit # never gets here, just for documentation
630 sub tls_start_cb ($$) {
631 my ($opt, $orig_post_accept) = @_;
633 my ($io, $addr, $srv) = @_;
634 my $ssl = IO::Socket::SSL->start_SSL($io, %$opt);
635 $orig_post_accept->($ssl, $addr, $srv);
639 sub defer_accept ($$) {
640 my ($s, $af_name) = @_;
641 return unless defined $af_name;
642 if ($^O eq 'linux') {
643 my $TCP_DEFER_ACCEPT = 9; # Socket::TCP_DEFER_ACCEPT is in 5.14+
644 my $x = getsockopt($s, IPPROTO_TCP, $TCP_DEFER_ACCEPT);
645 return unless defined $x; # may be Unix socket
646 my $sec = unpack('i', $x);
647 return if $sec > 0; # systemd users may set a higher value
648 setsockopt($s, IPPROTO_TCP, $TCP_DEFER_ACCEPT, 1);
649 } elsif ($^O eq 'freebsd') {
650 my $x = getsockopt($s, SOL_SOCKET, $SO_ACCEPTFILTER);
651 return if defined $x; # don't change if set
652 my $accf_arg = pack('a16a240', $af_name, '');
653 setsockopt($s, SOL_SOCKET, $SO_ACCEPTFILTER, $accf_arg);
657 sub daemon_loop ($) {
661 for my $xn (values %$xnetd) {
662 eval { $xn->{refresh}->($sig) };
663 warn "refresh $@\n" if $@;
667 while (my ($k, $v) = each %tls_opt) {
669 $l =~ s!\A([^:]+)://!!;
670 my $scheme = $1 // '';
671 my $xn = $xnetd->{$l} // $xnetd->{''};
672 if ($scheme =~ m!\A(?:https|imaps|nntps|pop3s)!) {
673 $post_accept{$l} = tls_start_cb($v, $xn->{post_accept});
674 } elsif ($xn->{tlsd}) { # STARTTLS, $k eq '' is OK
675 $xn->{tlsd}->{accept_tls} = $v;
680 INT => \&worker_quit,
681 QUIT => \&worker_quit,
682 TERM => \&worker_quit,
685 USR1 => \&reopen_logs,
688 CHLD => \&PublicInbox::DS::enqueue_reap,
690 if ($worker_processes > 0) {
691 $refresh->(); # preload by default
692 my $fh = master_loop(); # returns if in child process
693 PublicInbox::EOFpipe->new($fh, \&worker_quit, undef);
696 $set_user->() if $set_user;
697 $sig->{USR2} = sub { worker_quit() if upgrade() };
703 my $l = sockname($_);
704 my $tls_cb = $post_accept{$l};
705 my $xn = $xnetd->{$l} // $xnetd->{''};
707 # NNTPS, HTTPS, HTTP, IMAPS and POP3S are client-first traffic
708 # IMAP, NNTP and POP3 are server-first
709 defer_accept($_, $tls_cb ? 'dataready' : $xn->{af_default});
711 # this calls epoll_create:
712 PublicInbox::Listener->new($_, $tls_cb || $xn->{post_accept})
714 PublicInbox::DS::event_loop($sig, $oldset);
718 my ($default_listen) = @_;
720 if ($default_listen) {
721 $default_listen =~ /\A(http|imap|nntp|pop3)/ or
722 die "BUG: $default_listen";
723 $xnetd->{''} = load_mod($1);
725 daemon_prepare($default_listen, $xnetd);
726 my $for_destroy = daemonize();
728 # localize GCF2C for tests:
729 local $PublicInbox::GitAsyncCat::GCF2C;
730 local $PublicInbox::Git::async_warn = 1;
731 local $SIG{__WARN__} = PublicInbox::Eml::warn_ignore_cb();
734 PublicInbox::DS->Reset;
735 # ->DESTROY runs when $for_destroy goes out-of-scope
740 Net::Server::Daemonize::create_pid_file($path);
745 unlink_pid_file_safe_ish($_[0]->{pid}, ${$_[0]->{pid_file}});