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 F_SETFD);
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);
182 my @inherited_names = keys(%$listener_names);
184 # ignore daemonize when inheriting
185 $daemonize = undef if scalar @listeners;
187 unless (@listeners || @cfg_listen) {
188 $default_listen // die "no listeners specified\n";
189 push @cfg_listen, $default_listen
191 my ($default_scheme) = (($default_listen // '') =~ m!\A([^:]+)://!);
192 foreach my $l (@cfg_listen) {
194 my ($scheme, $port, $opt);
195 $l =~ s!\A([a-z0-9]+)://!! and $scheme = $1;
196 $scheme //= $default_scheme;
197 if ($l =~ /\A(?:\[[^\]]+\]|[^:]+):([0-9]+)/) {
199 $scheme //= $KNOWN_TLS{$port} // $KNOWN_STARTTLS{$port};
201 $scheme // die "unable to determine URL scheme of $orig\n";
202 if (!defined($port) && index($l, '/') != 0) { # AF_UNIX socket
203 $port = $SCHEME2PORT{$scheme} //
204 die "no port in listen=$orig\n";
205 $l =~ s!\A([^/]+)!$1:$port! or
206 die "unable to add port=$port to $l\n";
208 $l =~ s!/\z!!; # chop one trailing slash
209 if ($l =~ s!/?\?(.+)\z!!) {
210 $opt = listener_opt($1);
211 $tls_opt{"$scheme://$l"} = accept_tls_opt($opt);
212 } elsif (defined($default_cert)) {
213 $tls_opt{"$scheme://$l"} = accept_tls_opt('');
214 } elsif ($scheme =~ /\A(?:https|imaps|nntps|pop3s)\z/) {
215 die "$orig specified w/o cert=\n";
217 if ($listener_names->{$l}) { # already inherited
218 $xnetd->{$l} = load_mod($scheme, $opt, $l);
222 if (index($l, '/') == 0) {
223 $sock_pkg = 'IO::Socket::UNIX';
224 eval "use $sock_pkg";
226 %o = (Type => SOCK_STREAM, Peer => $l);
228 my $c = $sock_pkg->new(%o);
229 if (!defined($c) && $!{ECONNREFUSED}) {
231 "failed to unlink stale socket=$l: $!\n";
232 } # else: let the bind fail
234 $o{Local} = delete $o{Peer};
236 # both work for IPv4, too
237 for (qw(IO::Socket::IP IO::Socket::INET6)) {
239 eval "use $sock_pkg";
243 %o = (LocalAddr => $l, ReuseAddr => 1, Proto => 'tcp');
246 my $prev = umask 0000;
247 my $s = eval { $sock_pkg->new(%o) } or
248 warn "error binding $l: $! ($@)\n";
252 my $sockname = sockname($s);
253 warn "# bound $scheme://$sockname\n";
254 $xnetd->{$sockname} //= load_mod($scheme);
255 $listener_names->{$sockname} = $s;
259 # cert/key options in @cfg_listen takes precedence when inheriting,
260 # but map well-known inherited ports if --listen isn't specified
261 # at all. This allows socket-activation users to set certs once
262 # and not have to configure each socket:
263 if (defined $default_cert) {
264 my ($stls) = (($default_scheme // '') =~ /\A(pop3|nntp|imap)/);
265 for my $x (@inherited_names) {
266 $x =~ /:([0-9]+)\z/ or next; # no TLS for AF_UNIX
267 if (my $scheme = $KNOWN_TLS{$1}) {
268 $xnetd->{$x} //= load_mod($scheme);
269 $tls_opt{"$scheme://$x"} ||= accept_tls_opt('');
270 } elsif (($scheme = $KNOWN_STARTTLS{$1})) {
271 $xnetd->{$x} //= load_mod($scheme);
272 $tls_opt{"$scheme://$x"} ||= accept_tls_opt('');
273 } elsif (defined $stls) {
274 $tls_opt{"$stls://$x"} ||= accept_tls_opt('');
278 if (defined $default_scheme) {
279 for my $x (@inherited_names) {
280 $xnetd->{$x} //= load_mod($default_scheme);
283 die "No listeners bound\n" unless @listeners;
289 foreach my $i (0..$#ARGV) {
292 $ARGV[$i] = Cwd::abs_path($arg);
294 check_absolute('--stdout', $stdout);
295 check_absolute('--stderr', $stderr);
296 check_absolute('--pid-file', $pid_file);
297 check_absolute('--cert', $default_cert);
298 check_absolute('--key', $default_key);
300 chdir '/' or die "chdir failed: $!";
302 if (defined($pid_file) || defined($group) || defined($user)) {
303 eval { require Net::Server::Daemonize; 1 } // die <<EOF;
304 Net::Server required for --pid-file, --group, --user
308 Net::Server::Daemonize::check_pid_file($pid_file) if defined $pid_file;
309 $uid = Net::Server::Daemonize::get_uid($user) if defined $user;
310 if (defined $group) {
311 $gid = Net::Server::Daemonize::get_gid($group);
312 $gid = (split /\s+/, $gid)[0];
313 } elsif (defined $uid) {
314 $gid = (getpwuid($uid))[3];
317 # We change users in the worker to ensure upgradability,
318 # The upgrade will create the ".oldbin" pid file in the
319 # same directory as the given pid file.
320 $uid and $set_user = sub {
322 Net::Server::Daemonize::set_user($uid, $gid);
326 my $pid = fork // die "fork: $!";
329 open(STDIN, '+<', '/dev/null') or
330 die "redirect stdin failed: $!\n";
331 open STDOUT, '>&STDIN' or die "redirect stdout failed: $!\n";
332 open STDERR, '>&STDIN' or die "redirect stderr failed: $!\n";
334 $pid = fork // die "fork: $!";
337 return unless defined $pid_file;
339 write_pid($pid_file);
341 bless { pid => $$, pid_file => \$pid_file }, __PACKAGE__;
344 sub worker_quit { # $_[0] = signal name or number (unused)
345 # killing again terminates immediately:
346 exit unless @listeners;
348 $_->close foreach @listeners; # call PublicInbox::DS::close
352 # drop idle connections and try to quit gracefully
353 PublicInbox::DS->SetPostLoopCallback(sub {
354 my ($dmap, undef) = @_;
357 for my $s (values %$dmap) {
358 $s->can('busy') or next;
361 } else { # close as much as possible, early as possible
366 if (($warn + 5) < now()) {
367 warn "$$ quitting, $n client(s) left\n";
370 unless (defined $proc_name) {
371 $proc_name = (split(/\s+/, $0))[0];
372 $proc_name =~ s!\A.*?([^/]+)\z!$1!;
374 $0 = "$proc_name quitting, $n client(s) left";
376 $n; # true: loop continues, false: loop breaks
381 $logs{$stdout} //= \*STDOUT if defined $stdout;
382 $logs{$stderr} //= \*STDERR if defined $stderr;
383 while (my ($p, $fh) = each %logs) { open_log_path($fh, $p) }
388 my $addr = getsockname($s) or return;
389 my ($host, $port) = host_with_port($addr);
390 if ($port == 0 && $host eq '127.0.0.1') {
391 my ($path) = Socket::sockaddr_un($addr);
397 sub unpack_ipv6 ($) {
401 # Socket.pm in Perl 5.14+ supports IPv6:
403 ($port, $host) = Socket::unpack_sockaddr_in6($addr);
404 $host = Socket::inet_ntop(Socket::AF_INET6(), $host);
408 # Perl 5.12 or earlier? SpamAssassin and Net::Server use
409 # Socket6, so it may be installed on our system, already
410 # (otherwise die here):
413 ($port, $host) = Socket6::unpack_sockaddr_in6($addr);
414 $host = Socket6::inet_ntop(Socket6::AF_INET6(), $host);
419 sub host_with_port ($) {
423 # this eval will die on Unix sockets:
425 if (length($addr) >= 28) {
426 ($host, $port) = unpack_ipv6($addr);
429 ($port, $host) = Socket::sockaddr_in($addr);
430 $host = Socket::inet_ntoa($host);
433 $@ ? ('127.0.0.1', 0) : ($host, $port);
437 my ($listener_names) = @_;
438 return () if ($ENV{LISTEN_PID} || 0) != $$;
439 my $fds = $ENV{LISTEN_FDS} or return ();
440 my $end = $fds + 2; # LISTEN_FDS_START - 1
442 foreach my $fd (3..$end) {
443 open(my $s, '<&=', $fd) or warn "fdopen fd=$fd: $!";
444 if (my $k = sockname($s)) {
445 my $prev_was_blocking = $s->blocking(0);
446 warn <<"" if $prev_was_blocking;
447 Inherited socket ($k fd=$fd) is blocking, making it non-blocking.
448 Set 'NonBlocking = true' in the systemd.service unit to avoid stalled
449 processes when multiple service instances start.
451 $listener_names->{$k} = $s;
452 warn "# inherited $k fd=$fd\n";
455 warn "failed to inherit fd=$fd (LISTEN_FDS=$fds)";
461 sub upgrade { # $_[0] = signal name or number (unused)
463 warn "upgrade in-progress: $reexec_pid\n";
466 if (defined $pid_file) {
467 if ($pid_file =~ /\.oldbin\z/) {
468 warn "BUG: .oldbin suffix exists: $pid_file\n";
471 unlink_pid_file_safe_ish($$, $pid_file);
472 $pid_file .= '.oldbin';
473 write_pid($pid_file);
476 unless (defined $pid) {
477 warn "fork failed: $!\n";
481 $ENV{LISTEN_FDS} = scalar @listeners;
482 $ENV{LISTEN_PID} = $$;
483 foreach my $s (@listeners) {
484 # @listeners are globs with workers, PI::L w/o workers
485 $s = $s->{sock} if ref($s) eq 'PublicInbox::Listener';
486 fcntl($s, F_SETFD, 0) // die "F_SETFD: $!";
489 die "Failed to exec: $!\n";
494 sub kill_workers ($) {
496 kill $sig, keys(%pids);
499 sub upgrade_aborted ($) {
501 warn "reexec PID($p) died with: $?\n";
503 return unless $pid_file;
505 my $file = $pid_file;
506 $file =~ s/\.oldbin\z// or die "BUG: no '.oldbin' suffix in $file";
507 unlink_pid_file_safe_ish($$, $pid_file);
509 eval { write_pid($pid_file) };
513 sub reap_children { # $_[0] = 'CHLD' or POSIX::SIGCHLD()
515 my $p = waitpid(-1, WNOHANG) or return;
516 if (defined $reexec_pid && $p == $reexec_pid) {
518 } elsif (defined(my $id = delete $pids{$p})) {
519 warn "worker[$id] PID($p) died with: $?\n";
521 warn "unknown PID($p) reaped: $?\n";
528 sub unlink_pid_file_safe_ish ($$) {
529 my ($unlink_pid, $file) = @_;
530 return unless defined $unlink_pid && $unlink_pid == $$;
532 open my $fh, '<', $file or return;
534 defined(my $read_pid = <$fh>) or return;
536 if ($read_pid == $unlink_pid) {
537 Net::Server::Daemonize::unlink_pid_file($file);
541 sub master_quit ($) {
542 exit unless @listeners;
548 pipe(my ($p0, $p1)) or die "failed to create parent-pipe: $!";
549 my $set_workers = $worker_processes;
553 USR1 => sub { reopen_logs(); kill_workers($_[0]); },
555 QUIT => \&master_quit,
556 INT => \&master_quit,
557 TERM => \&master_quit,
559 return if $ignore_winch || !@listeners;
560 if (-t STDIN || -t STDOUT || -t STDERR) {
563 ignoring SIGWINCH since we are not daemonized
566 $worker_processes = 0;
570 return unless @listeners;
571 $worker_processes = $set_workers;
575 return unless @listeners;
576 if ($set_workers > $worker_processes) {
579 $worker_processes = ++$set_workers;
583 $worker_processes = --$set_workers if $set_workers > 0;
585 CHLD => \&reap_children,
587 my $sigfd = PublicInbox::Sigfd->new($sig);
588 local @SIG{keys %$sig} = values(%$sig) unless $sigfd;
589 PublicInbox::DS::sig_setmask($oldset) if !$sigfd;
590 while (1) { # main loop
591 my $n = scalar keys %pids;
592 unless (@listeners) {
594 $set_workers = $worker_processes = $n = 0;
597 if ($n > $worker_processes) {
598 while (my ($k, $v) = each %pids) {
599 kill('TERM', $k) if $v >= $worker_processes;
601 $n = $worker_processes;
603 my $want = $worker_processes - 1;
605 PublicInbox::DS::block_signals() if !$sigfd;
606 for my $i ($n..$want) {
607 my $seed = rand(0xffffffff);
610 warn "failed to fork worker[$i]: $!\n";
611 } elsif ($pid == 0) {
613 eval { Net::SSLeay::randomize() };
614 $set_user->() if $set_user;
615 return $p0; # run normal work code
617 warn "PID=$pid is worker[$i]\n";
621 PublicInbox::DS::sig_setmask($oldset) if !$sigfd;
624 if ($sigfd) { # Linux and IO::KQueue users:
626 } else { # wake up every second
630 exit # never gets here, just for documentation
634 my ($post_accept, $tlsd) = @_;
636 my ($io, $addr, $srv) = @_;
637 $post_accept->(PublicInbox::TLS::start($io, $tlsd), $addr, $srv)
641 sub defer_accept ($$) {
642 my ($s, $af_name) = @_;
643 return unless defined $af_name;
644 if ($^O eq 'linux') {
645 my $TCP_DEFER_ACCEPT = 9; # Socket::TCP_DEFER_ACCEPT is in 5.14+
646 my $x = getsockopt($s, IPPROTO_TCP, $TCP_DEFER_ACCEPT);
647 return unless defined $x; # may be Unix socket
648 my $sec = unpack('i', $x);
649 return if $sec > 0; # systemd users may set a higher value
650 setsockopt($s, IPPROTO_TCP, $TCP_DEFER_ACCEPT, 1);
651 } elsif ($^O eq 'freebsd') {
652 my $x = getsockopt($s, SOL_SOCKET, $SO_ACCEPTFILTER);
653 return if defined $x; # don't change if set
654 my $accf_arg = pack('a16a240', $af_name, '');
655 setsockopt($s, SOL_SOCKET, $SO_ACCEPTFILTER, $accf_arg);
659 sub daemon_loop ($) {
661 local $PublicInbox::Config::DEDUPE = {}; # enable dedupe cache
664 %$PublicInbox::Config::DEDUPE = (); # clear cache
665 for my $xn (values %$xnetd) {
666 delete $xn->{tlsd}->{ssl_ctx}; # PublicInbox::TLS::start
667 eval { $xn->{refresh}->($sig) };
668 warn "refresh $@\n" if $@;
672 while (my ($k, $ctx_opt) = each %tls_opt) {
674 my ($scheme, $l) = split(m!://!, $k, 2);
675 my $xn = $xnetd->{$l} // die "BUG: no xnetd for $k";
676 $xn->{tlsd}->{ssl_ctx_opt} //= $ctx_opt;
677 $scheme =~ m!\A(?:https|imaps|nntps|pop3s)! and
678 $post_accept{$l} = tls_cb(@$xn{qw(post_accept tlsd)});
683 INT => \&worker_quit,
684 QUIT => \&worker_quit,
685 TERM => \&worker_quit,
688 USR1 => \&reopen_logs,
691 CHLD => \&PublicInbox::DS::enqueue_reap,
693 if ($worker_processes > 0) {
694 $refresh->(); # preload by default
695 my $fh = master_loop(); # returns if in child process
696 PublicInbox::EOFpipe->new($fh, \&worker_quit);
699 $set_user->() if $set_user;
700 $sig->{USR2} = sub { worker_quit() if upgrade() };
706 my $l = sockname($_);
707 my $tls_cb = $post_accept{$l};
708 my $xn = $xnetd->{$l} // die "BUG: no xnetd for $l";
710 # NNTPS, HTTPS, HTTP, IMAPS and POP3S are client-first traffic
711 # IMAP, NNTP and POP3 are server-first
712 defer_accept($_, $tls_cb ? 'dataready' : $xn->{af_default});
714 # this calls epoll_create:
715 PublicInbox::Listener->new($_, $tls_cb || $xn->{post_accept})
717 PublicInbox::DS::event_loop($sig, $oldset);
721 my ($default_listen) = @_;
722 daemon_prepare($default_listen, my $xnetd = {});
723 my $for_destroy = daemonize();
725 # localize GCF2C for tests:
726 local $PublicInbox::GitAsyncCat::GCF2C;
727 local $PublicInbox::Git::async_warn = 1;
728 local $SIG{__WARN__} = PublicInbox::Eml::warn_ignore_cb();
731 PublicInbox::DS->Reset;
732 # ->DESTROY runs when $for_destroy goes out-of-scope
737 Net::Server::Daemonize::create_pid_file($path);
742 unlink_pid_file_safe_ish($_[0]->{pid}, ${$_[0]->{pid_file}});