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 use PublicInbox::Config;
26 our $SO_ACCEPTFILTER = 0x1000;
28 my ($set_user, $oldset);
29 my (@cfg_listen, $stdout, $stderr, $group, $user, $pid_file, $daemonize);
30 my $worker_processes = 1;
33 my %tls_opt; # scheme://sockname => args for IO::Socket::SSL::SSL_Context->new
36 my ($default_cert, $default_key);
37 my %KNOWN_TLS = (443 => 'https', 563 => 'nntps', 993 => 'imaps', 995 =>'pop3s');
38 my %KNOWN_STARTTLS = (110 => 'pop3', 119 => 'nntp', 143 => 'imap');
39 my %SCHEME2PORT = map { $KNOWN_TLS{$_} => $_ + 0 } keys %KNOWN_TLS;
40 for (keys %KNOWN_STARTTLS) { $SCHEME2PORT{$KNOWN_STARTTLS{$_}} = $_ + 0 }
41 $SCHEME2PORT{http} = 80;
43 sub listener_opt ($) {
44 my ($str) = @_; # opt1=val1,opt2=val2 (opt may repeat for multi-value)
46 # allow ',' as delimiter since '&' is shell-unfriendly
47 for (split(/[,&]/, $str)) {
48 my ($k, $v) = split(/=/, $_, 2);
52 # key may be a part of cert. At least
53 # p5-io-socket-ssl/example/ssl_server.pl has this fallback:
54 $o->{cert} //= [ $default_cert ] if defined($default_cert);
55 $o->{key} //= defined($default_key) ? [ $default_key ] : $o->{cert};
59 sub check_absolute ($$) {
61 die <<EOM if index($val // '/', '/') != 0;
62 $var must be an absolute path when using --daemonize: $val
66 sub accept_tls_opt ($) {
68 my $o = ref($opt) eq 'HASH' ? $opt : listener_opt($opt);
69 return if !defined($o->{cert});
70 require PublicInbox::TLS;
72 # parse out hostname:/path/to/ mappings:
73 for my $k (qw(cert key)) {
75 push(@ctx_opt, "SSL_${k}_file", {});
76 foreach my $path (@{$o->{$k}}) {
78 $path =~ s/\A([^:]+):// and $host = $1;
79 $ctx_opt[-1]->{$host} = $path;
80 check_absolute($k, $path) if $daemonize;
89 chown($uid, $gid, $path) or warn "chown $path: $!\n";
92 sub open_log_path ($$) { # my ($fh, $path) = @_; # $_[0] is modified
93 open $_[0], '>>', $_[1] or die "open(>> $_[1]): $!";
100 my ($scheme, $opt, $addr) = @_;
101 my $modc = "PublicInbox::\U$scheme";
104 eval "require $mod"; # IMAPD|HTTPD|NNTPD|POP3D
107 my $tlsd = $xn{tlsd} = $mod->new;
109 substr($_, length('env.')) => $opt->{$_}->[-1];
110 } grep(/\Aenv\./, keys %$opt);
113 local @ENV{keys %env} = values %env;
114 $tlsd->refresh_groups($sig);
116 $xn{post_accept} = $tlsd->can('post_accept_cb') ?
117 $tlsd->post_accept_cb : sub { $modc->new($_[0], $tlsd) };
118 my @paths = qw(out err);
119 if ($modc eq 'PublicInbox::HTTP') {
121 $xn{af_default} = 'httpready';
122 if (my $p = $opt->{psgi}) {
123 die "multiple psgi= options specified\n" if @$p > 1;
124 check_absolute('psgi=', $p->[0]) if $daemonize;
125 $tlsd->{psgi} = $p->[0];
126 warn "# $scheme://$addr psgi=$p->[0]\n";
130 my $p = $opt->{$f} or next;
131 die "multiple $f= options specified\n" if @$p > 1;
132 check_absolute("$f=", $p->[0]) if $daemonize;
133 $p = File::Spec->canonpath($p->[0]);
134 $tlsd->{$f} = $logs{$p} //= open_log_path(my $fh, $p);
135 warn "# $scheme://$addr $f=$p\n";
137 my $err = $tlsd->{err};
138 $tlsd->{warn_cb} = sub { print $err @_ }; # for local $SIG{__WARN__}
142 sub daemon_prepare ($$) {
143 my ($default_listen, $xnetd) = @_;
144 my $listener_names = {}; # sockname => IO::Handle
145 $oldset = PublicInbox::DS::block_signals();
147 my ($prog) = ($CMD[0] =~ m!([^/]+)\z!g);
148 my $dh = defined($default_listen) ? " (default: $default_listen)" : '';
150 usage: $prog [-l ADDRESS] [--cert=FILE] [--key=FILE]
154 -l ADDRESS address to listen on$dh
155 --cert=FILE default SSL/TLS certificate
156 --key=FILE default SSL/TLS certificate
157 -W WORKERS number of worker processes to spawn (default: 1)
159 See public-inbox-daemon(8) and $prog(1) man pages for more.
162 'l|listen=s' => \@cfg_listen,
163 '1|stdout=s' => \$stdout,
164 '2|stderr=s' => \$stderr,
165 'W|worker-processes=i' => \$worker_processes,
166 'P|pid-file=s' => \$pid_file,
167 'u|user=s' => \$user,
168 'g|group=s' => \$group,
169 'D|daemonize' => \$daemonize,
170 'cert=s' => \$default_cert,
171 'key=s' => \$default_key,
172 'help|h' => \(my $show_help),
174 GetOptions(%opt) or die $help;
175 if ($show_help) { print $help; exit 0 };
177 $_ = File::Spec->canonpath($_ // next) for ($stdout, $stderr);
178 if (defined $pid_file && $pid_file =~ /\.oldbin\z/) {
179 die "--pid-file cannot end with '.oldbin'\n";
181 @listeners = inherit($listener_names);
183 # allow socket-activation users to set certs once and not
184 # have to configure each socket:
185 my @inherited_names = keys(%$listener_names) if defined($default_cert);
187 # ignore daemonize when inheriting
188 $daemonize = undef if scalar @listeners;
190 unless (@listeners || @cfg_listen) {
191 $default_listen // die "no listeners specified\n";
192 push @cfg_listen, $default_listen
195 foreach my $l (@cfg_listen) {
197 my ($scheme, $port, $opt);
199 $l =~ s!\A([a-z0-9]+)://!! and $scheme = $1;
200 (!$scheme && ($default_listen // '') =~ m!\A([^:]+)://!) and
202 if ($l =~ /\A(?:\[[^\]]+\]|[^:]+):([0-9]+)/) {
204 $scheme //= $KNOWN_TLS{$port} // $KNOWN_STARTTLS{$port};
206 $scheme or die "unable to determine URL scheme of $orig\n";
207 if (!defined($port) && index($l, '/') != 0) { # unix socket
208 $port = $SCHEME2PORT{$scheme} //
209 die "no port in listen=$orig\n";
210 $l =~ s!\A([^/]+)!$1:$port! or
211 die "unable to add port=$port to $l\n";
213 $l =~ s!/\z!!; # chop one trailing slash
214 if ($l =~ s!/?\?(.+)\z!!) {
215 $opt = listener_opt($1);
216 $tls_opt{"$scheme://$l"} = accept_tls_opt($opt);
217 } elsif (defined($default_cert)) {
218 $tls_opt{"$scheme://$l"} = accept_tls_opt('');
219 } elsif ($scheme =~ /\A(?:https|imaps|nntps|pop3s)\z/) {
220 die "$orig specified w/o cert=\n";
222 if ($listener_names->{$l}) { # already inherited
223 $xnetd->{$l} = load_mod($scheme, $opt, $l);
227 if (index($l, '/') == 0) {
228 $sock_pkg = 'IO::Socket::UNIX';
229 eval "use $sock_pkg";
231 %o = (Type => SOCK_STREAM, Peer => $l);
233 my $c = $sock_pkg->new(%o);
234 if (!defined($c) && $!{ECONNREFUSED}) {
236 "failed to unlink stale socket=$l: $!\n";
237 } # else: let the bind fail
239 $o{Local} = delete $o{Peer};
241 # both work for IPv4, too
242 for (qw(IO::Socket::IP IO::Socket::INET6)) {
244 eval "use $sock_pkg";
248 %o = (LocalAddr => $l, ReuseAddr => 1, Proto => 'tcp');
251 my $prev = umask 0000;
252 my $s = eval { $sock_pkg->new(%o) } or
253 warn "error binding $l: $! ($@)\n";
257 my $sockname = sockname($s);
258 warn "# bound $scheme://$sockname\n";
259 $xnetd->{$sockname} //= load_mod($scheme);
260 $listener_names->{$sockname} = $s;
264 # cert/key options in @cfg_listen takes precedence when inheriting,
265 # but map well-known inherited ports if --listen isn't specified
267 for my $sockname (@inherited_names) {
268 $sockname =~ /:([0-9]+)\z/ or next;
269 if (my $scheme = $KNOWN_TLS{$1}) {
270 $xnetd->{$sockname} //= load_mod($scheme);
271 $tls_opt{"$scheme://$sockname"} ||= accept_tls_opt('');
272 } elsif (($scheme = $KNOWN_STARTTLS{$1})) {
273 $xnetd->{$sockname} //= load_mod($scheme);
274 $tls_opt{"$scheme://$sockname"} ||= accept_tls_opt('');
275 $tls_opt{''} ||= accept_tls_opt('');
279 while (my ($k, $v) = each %tls_opt) { push(@d, $k) if !defined($v) }
281 die "No listeners bound\n" unless @listeners;
287 foreach my $i (0..$#ARGV) {
290 $ARGV[$i] = Cwd::abs_path($arg);
292 check_absolute('--stdout', $stdout);
293 check_absolute('--stderr', $stderr);
294 check_absolute('--pid-file', $pid_file);
295 check_absolute('--cert', $default_cert);
296 check_absolute('--key', $default_key);
298 chdir '/' or die "chdir failed: $!";
300 if (defined($pid_file) || defined($group) || defined($user)) {
301 eval { require Net::Server::Daemonize; 1 } // die <<EOF;
302 Net::Server required for --pid-file, --group, --user
306 Net::Server::Daemonize::check_pid_file($pid_file) if defined $pid_file;
307 $uid = Net::Server::Daemonize::get_uid($user) if defined $user;
308 if (defined $group) {
309 $gid = Net::Server::Daemonize::get_gid($group);
310 $gid = (split /\s+/, $gid)[0];
311 } elsif (defined $uid) {
312 $gid = (getpwuid($uid))[3];
315 # We change users in the worker to ensure upgradability,
316 # The upgrade will create the ".oldbin" pid file in the
317 # same directory as the given pid file.
318 $uid and $set_user = sub {
320 Net::Server::Daemonize::set_user($uid, $gid);
324 my $pid = fork // die "fork: $!";
327 open(STDIN, '+<', '/dev/null') or
328 die "redirect stdin failed: $!\n";
329 open STDOUT, '>&STDIN' or die "redirect stdout failed: $!\n";
330 open STDERR, '>&STDIN' or die "redirect stderr failed: $!\n";
332 $pid = fork // die "fork: $!";
335 return unless defined $pid_file;
337 write_pid($pid_file);
339 bless { pid => $$, pid_file => \$pid_file }, __PACKAGE__;
342 sub worker_quit { # $_[0] = signal name or number (unused)
343 # killing again terminates immediately:
344 exit unless @listeners;
346 $_->close foreach @listeners; # call PublicInbox::DS::close
350 # drop idle connections and try to quit gracefully
351 PublicInbox::DS->SetPostLoopCallback(sub {
352 my ($dmap, undef) = @_;
355 for my $s (values %$dmap) {
356 $s->can('busy') or next;
359 } else { # close as much as possible, early as possible
364 if (($warn + 5) < now()) {
365 warn "$$ quitting, $n client(s) left\n";
368 unless (defined $proc_name) {
369 $proc_name = (split(/\s+/, $0))[0];
370 $proc_name =~ s!\A.*?([^/]+)\z!$1!;
372 $0 = "$proc_name quitting, $n client(s) left";
374 $n; # true: loop continues, false: loop breaks
379 $logs{$stdout} //= \*STDOUT if defined $stdout;
380 $logs{$stderr} //= \*STDERR if defined $stderr;
381 while (my ($p, $fh) = each %logs) { open_log_path($fh, $p) }
386 my $addr = getsockname($s) or return;
387 my ($host, $port) = host_with_port($addr);
388 if ($port == 0 && $host eq '127.0.0.1') {
389 my ($path) = Socket::sockaddr_un($addr);
395 sub unpack_ipv6 ($) {
399 # Socket.pm in Perl 5.14+ supports IPv6:
401 ($port, $host) = Socket::unpack_sockaddr_in6($addr);
402 $host = Socket::inet_ntop(Socket::AF_INET6(), $host);
406 # Perl 5.12 or earlier? SpamAssassin and Net::Server use
407 # Socket6, so it may be installed on our system, already
408 # (otherwise die here):
411 ($port, $host) = Socket6::unpack_sockaddr_in6($addr);
412 $host = Socket6::inet_ntop(Socket6::AF_INET6(), $host);
417 sub host_with_port ($) {
421 # this eval will die on Unix sockets:
423 if (length($addr) >= 28) {
424 ($host, $port) = unpack_ipv6($addr);
427 ($port, $host) = Socket::sockaddr_in($addr);
428 $host = Socket::inet_ntoa($host);
431 $@ ? ('127.0.0.1', 0) : ($host, $port);
435 my ($listener_names) = @_;
436 return () if ($ENV{LISTEN_PID} || 0) != $$;
437 my $fds = $ENV{LISTEN_FDS} or return ();
438 my $end = $fds + 2; # LISTEN_FDS_START - 1
440 foreach my $fd (3..$end) {
441 open(my $s, '<&=', $fd) or warn "fdopen fd=$fd: $!";
442 if (my $k = sockname($s)) {
443 my $prev_was_blocking = $s->blocking(0);
444 warn <<"" if $prev_was_blocking;
445 Inherited socket ($k fd=$fd) is blocking, making it non-blocking.
446 Set 'NonBlocking = true' in the systemd.service unit to avoid stalled
447 processes when multiple service instances start.
449 $listener_names->{$k} = $s;
450 warn "# inherited $k fd=$fd\n";
453 warn "failed to inherit fd=$fd (LISTEN_FDS=$fds)";
459 sub upgrade { # $_[0] = signal name or number (unused)
461 warn "upgrade in-progress: $reexec_pid\n";
464 if (defined $pid_file) {
465 if ($pid_file =~ /\.oldbin\z/) {
466 warn "BUG: .oldbin suffix exists: $pid_file\n";
469 unlink_pid_file_safe_ish($$, $pid_file);
470 $pid_file .= '.oldbin';
471 write_pid($pid_file);
474 unless (defined $pid) {
475 warn "fork failed: $!\n";
479 use Fcntl qw(FD_CLOEXEC F_SETFD F_GETFD);
480 $ENV{LISTEN_FDS} = scalar @listeners;
481 $ENV{LISTEN_PID} = $$;
482 foreach my $s (@listeners) {
483 # @listeners are globs with workers, PI::L w/o workers
484 $s = $s->{sock} if ref($s) eq 'PublicInbox::Listener';
486 my $fl = fcntl($s, F_GETFD, 0);
487 fcntl($s, F_SETFD, $fl &= ~FD_CLOEXEC);
490 die "Failed to exec: $!\n";
495 sub kill_workers ($) {
497 kill $sig, keys(%pids);
500 sub upgrade_aborted ($) {
502 warn "reexec PID($p) died with: $?\n";
504 return unless $pid_file;
506 my $file = $pid_file;
507 $file =~ s/\.oldbin\z// or die "BUG: no '.oldbin' suffix in $file";
508 unlink_pid_file_safe_ish($$, $pid_file);
510 eval { write_pid($pid_file) };
514 sub reap_children { # $_[0] = 'CHLD' or POSIX::SIGCHLD()
516 my $p = waitpid(-1, WNOHANG) or return;
517 if (defined $reexec_pid && $p == $reexec_pid) {
519 } elsif (defined(my $id = delete $pids{$p})) {
520 warn "worker[$id] PID($p) died with: $?\n";
522 warn "unknown PID($p) reaped: $?\n";
529 sub unlink_pid_file_safe_ish ($$) {
530 my ($unlink_pid, $file) = @_;
531 return unless defined $unlink_pid && $unlink_pid == $$;
533 open my $fh, '<', $file or return;
535 defined(my $read_pid = <$fh>) or return;
537 if ($read_pid == $unlink_pid) {
538 Net::Server::Daemonize::unlink_pid_file($file);
542 sub master_quit ($) {
543 exit unless @listeners;
549 pipe(my ($p0, $p1)) or die "failed to create parent-pipe: $!";
550 my $set_workers = $worker_processes;
554 USR1 => sub { reopen_logs(); kill_workers($_[0]); },
556 QUIT => \&master_quit,
557 INT => \&master_quit,
558 TERM => \&master_quit,
560 return if $ignore_winch || !@listeners;
561 if (-t STDIN || -t STDOUT || -t STDERR) {
564 ignoring SIGWINCH since we are not daemonized
567 $worker_processes = 0;
571 return unless @listeners;
572 $worker_processes = $set_workers;
576 return unless @listeners;
577 if ($set_workers > $worker_processes) {
580 $worker_processes = ++$set_workers;
584 $worker_processes = --$set_workers if $set_workers > 0;
586 CHLD => \&reap_children,
588 my $sigfd = PublicInbox::Sigfd->new($sig);
589 local @SIG{keys %$sig} = values(%$sig) unless $sigfd;
590 PublicInbox::DS::sig_setmask($oldset) if !$sigfd;
591 while (1) { # main loop
592 my $n = scalar keys %pids;
593 unless (@listeners) {
595 $set_workers = $worker_processes = $n = 0;
598 if ($n > $worker_processes) {
599 while (my ($k, $v) = each %pids) {
600 kill('TERM', $k) if $v >= $worker_processes;
602 $n = $worker_processes;
604 my $want = $worker_processes - 1;
606 PublicInbox::DS::block_signals() if !$sigfd;
607 for my $i ($n..$want) {
608 my $seed = rand(0xffffffff);
611 warn "failed to fork worker[$i]: $!\n";
612 } elsif ($pid == 0) {
614 eval { Net::SSLeay::randomize() };
615 $set_user->() if $set_user;
616 return $p0; # run normal work code
618 warn "PID=$pid is worker[$i]\n";
622 PublicInbox::DS::sig_setmask($oldset) if !$sigfd;
625 if ($sigfd) { # Linux and IO::KQueue users:
627 } else { # wake up every second
631 exit # never gets here, just for documentation
635 my ($post_accept, $tlsd) = @_;
637 my ($io, $addr, $srv) = @_;
638 $post_accept->(PublicInbox::TLS::start($io, $tlsd), $addr, $srv)
642 sub defer_accept ($$) {
643 my ($s, $af_name) = @_;
644 return unless defined $af_name;
645 if ($^O eq 'linux') {
646 my $TCP_DEFER_ACCEPT = 9; # Socket::TCP_DEFER_ACCEPT is in 5.14+
647 my $x = getsockopt($s, IPPROTO_TCP, $TCP_DEFER_ACCEPT);
648 return unless defined $x; # may be Unix socket
649 my $sec = unpack('i', $x);
650 return if $sec > 0; # systemd users may set a higher value
651 setsockopt($s, IPPROTO_TCP, $TCP_DEFER_ACCEPT, 1);
652 } elsif ($^O eq 'freebsd') {
653 my $x = getsockopt($s, SOL_SOCKET, $SO_ACCEPTFILTER);
654 return if defined $x; # don't change if set
655 my $accf_arg = pack('a16a240', $af_name, '');
656 setsockopt($s, SOL_SOCKET, $SO_ACCEPTFILTER, $accf_arg);
660 sub daemon_loop ($) {
662 local $PublicInbox::Config::DEDUPE = {}; # enable dedupe cache
665 %$PublicInbox::Config::DEDUPE = (); # clear cache
666 for my $xn (values %$xnetd) {
667 delete $xn->{tlsd}->{ssl_ctx}; # PublicInbox::TLS::start
668 eval { $xn->{refresh}->($sig) };
669 warn "refresh $@\n" if $@;
673 while (my ($k, $ctx_opt) = each %tls_opt) {
675 $l =~ s!\A([^:]+)://!!;
676 my $scheme = $1 // '';
677 my $xn = $xnetd->{$l} // $xnetd->{''};
678 $xn->{tlsd}->{ssl_ctx_opt} //= $ctx_opt;
679 $scheme =~ m!\A(?:https|imaps|nntps|pop3s)! and
680 $post_accept{$l} = tls_cb(@$xn{qw(post_accept tlsd)});
684 INT => \&worker_quit,
685 QUIT => \&worker_quit,
686 TERM => \&worker_quit,
689 USR1 => \&reopen_logs,
692 CHLD => \&PublicInbox::DS::enqueue_reap,
694 if ($worker_processes > 0) {
695 $refresh->(); # preload by default
696 my $fh = master_loop(); # returns if in child process
697 PublicInbox::EOFpipe->new($fh, \&worker_quit, undef);
700 $set_user->() if $set_user;
701 $sig->{USR2} = sub { worker_quit() if upgrade() };
707 my $l = sockname($_);
708 my $tls_cb = $post_accept{$l};
709 my $xn = $xnetd->{$l} // $xnetd->{''};
711 # NNTPS, HTTPS, HTTP, IMAPS and POP3S are client-first traffic
712 # IMAP, NNTP and POP3 are server-first
713 defer_accept($_, $tls_cb ? 'dataready' : $xn->{af_default});
715 # this calls epoll_create:
716 PublicInbox::Listener->new($_, $tls_cb || $xn->{post_accept})
718 PublicInbox::DS::event_loop($sig, $oldset);
722 my ($default_listen) = @_;
724 if ($default_listen) {
725 $default_listen =~ /\A(http|imap|nntp|pop3)/ or
726 die "BUG: $default_listen";
727 $xnetd->{''} = load_mod($1);
729 daemon_prepare($default_listen, $xnetd);
730 my $for_destroy = daemonize();
732 # localize GCF2C for tests:
733 local $PublicInbox::GitAsyncCat::GCF2C;
734 local $PublicInbox::Git::async_warn = 1;
735 local $SIG{__WARN__} = PublicInbox::Eml::warn_ignore_cb();
738 PublicInbox::DS->Reset;
739 # ->DESTROY runs when $for_destroy goes out-of-scope
744 Net::Server::Daemonize::create_pid_file($path);
749 unlink_pid_file_safe_ish($_[0]->{pid}, ${$_[0]->{pid_file}});