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::SSL_Context->new
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');
38 my %SCHEME2PORT = map { $KNOWN_TLS{$_} => $_ + 0 } keys %KNOWN_TLS;
39 for (keys %KNOWN_STARTTLS) { $SCHEME2PORT{$KNOWN_STARTTLS{$_}} = $_ + 0 }
40 $SCHEME2PORT{http} = 80;
42 sub listener_opt ($) {
43 my ($str) = @_; # opt1=val1,opt2=val2 (opt may repeat for multi-value)
45 # allow ',' as delimiter since '&' is shell-unfriendly
46 for (split(/[,&]/, $str)) {
47 my ($k, $v) = split(/=/, $_, 2);
51 # key may be a part of cert. At least
52 # p5-io-socket-ssl/example/ssl_server.pl has this fallback:
53 $o->{cert} //= [ $default_cert ] if defined($default_cert);
54 $o->{key} //= defined($default_key) ? [ $default_key ] : $o->{cert};
58 sub check_absolute ($$) {
60 die <<EOM if index($val // '/', '/') != 0;
61 $var must be an absolute path when using --daemonize: $val
65 sub accept_tls_opt ($) {
67 my $o = ref($opt) eq 'HASH' ? $opt : listener_opt($opt);
68 return if !defined($o->{cert});
69 require PublicInbox::TLS;
71 # parse out hostname:/path/to/ mappings:
72 for my $k (qw(cert key)) {
74 push(@ctx_opt, "SSL_${k}_file", {});
75 foreach my $path (@{$o->{$k}}) {
77 $path =~ s/\A([^:]+):// and $host = $1;
78 $ctx_opt[-1]->{$host} = $path;
79 check_absolute($k, $path) if $daemonize;
88 chown($uid, $gid, $path) or warn "chown $path: $!\n";
91 sub open_log_path ($$) { # my ($fh, $path) = @_; # $_[0] is modified
92 open $_[0], '>>', $_[1] or die "open(>> $_[1]): $!";
99 my ($scheme, $opt, $addr) = @_;
100 my $modc = "PublicInbox::\U$scheme";
103 eval "require $mod"; # IMAPD|HTTPD|NNTPD|POP3D
106 my $tlsd = $xn{tlsd} = $mod->new;
108 substr($_, length('env.')) => $opt->{$_}->[-1];
109 } grep(/\Aenv\./, keys %$opt);
112 local @ENV{keys %env} = values %env;
113 $tlsd->refresh_groups($sig);
115 $xn{post_accept} = $tlsd->can('post_accept_cb') ?
116 $tlsd->post_accept_cb : sub { $modc->new($_[0], $tlsd) };
117 my @paths = qw(out err);
118 if ($modc eq 'PublicInbox::HTTP') {
120 $xn{af_default} = 'httpready';
121 if (my $p = $opt->{psgi}) {
122 die "multiple psgi= options specified\n" if @$p > 1;
123 check_absolute('psgi=', $p->[0]) if $daemonize;
124 $tlsd->{psgi} = $p->[0];
125 warn "# $scheme://$addr psgi=$p->[0]\n";
129 my $p = $opt->{$f} or next;
130 die "multiple $f= options specified\n" if @$p > 1;
131 check_absolute("$f=", $p->[0]) if $daemonize;
132 $p = File::Spec->canonpath($p->[0]);
133 $tlsd->{$f} = $logs{$p} //= open_log_path(my $fh, $p);
134 warn "# $scheme://$addr $f=$p\n";
139 sub daemon_prepare ($$) {
140 my ($default_listen, $xnetd) = @_;
141 my $listener_names = {}; # sockname => IO::Handle
142 $oldset = PublicInbox::DS::block_signals();
144 my ($prog) = ($CMD[0] =~ m!([^/]+)\z!g);
145 my $dh = defined($default_listen) ? " (default: $default_listen)" : '';
147 usage: $prog [-l ADDRESS] [--cert=FILE] [--key=FILE]
151 -l ADDRESS address to listen on$dh
152 --cert=FILE default SSL/TLS certificate
153 --key=FILE default SSL/TLS certificate
154 -W WORKERS number of worker processes to spawn (default: 1)
156 See public-inbox-daemon(8) and $prog(1) man pages for more.
159 'l|listen=s' => \@cfg_listen,
160 '1|stdout=s' => \$stdout,
161 '2|stderr=s' => \$stderr,
162 'W|worker-processes=i' => \$worker_processes,
163 'P|pid-file=s' => \$pid_file,
164 'u|user=s' => \$user,
165 'g|group=s' => \$group,
166 'D|daemonize' => \$daemonize,
167 'cert=s' => \$default_cert,
168 'key=s' => \$default_key,
169 'help|h' => \(my $show_help),
171 GetOptions(%opt) or die $help;
172 if ($show_help) { print $help; exit 0 };
174 $_ = File::Spec->canonpath($_ // next) for ($stdout, $stderr);
175 if (defined $pid_file && $pid_file =~ /\.oldbin\z/) {
176 die "--pid-file cannot end with '.oldbin'\n";
178 @listeners = inherit($listener_names);
180 # allow socket-activation users to set certs once and not
181 # have to configure each socket:
182 my @inherited_names = keys(%$listener_names) if defined($default_cert);
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
192 foreach my $l (@cfg_listen) {
196 if ($l =~ s!\A([^:]+)://!!) { $scheme = $1 }
197 if ($l =~ /\A(?:\[[^\]]+\]|[^:]+):([0-9]+)/) {
199 my $s = $KNOWN_TLS{$port} // $KNOWN_STARTTLS{$port};
200 $scheme //= $s if defined $s;
201 } elsif (index($l, '/') != 0) { # unix socket
202 $port //= $SCHEME2PORT{$scheme} if $scheme;
203 $port // die "no port in listen=$l\n";
204 $l =~ s!\A([^/]+)!$1:$port! or
205 die "unable to add port=$port to $l\n";
207 my $opt; # non-TLS options
208 if ($l =~ s!/?\?(.+)\z!!) {
209 $opt = listener_opt($1);
210 $tls_opt{"$scheme://$l"} = accept_tls_opt($opt);
211 } elsif (defined($default_cert)) {
212 $tls_opt{"$scheme://$l"} = accept_tls_opt('');
213 } elsif ($scheme =~ /\A(?:https|imaps|nntps|pop3s)\z/) {
214 die "$orig specified w/o cert=\n";
216 $scheme =~ /\A(?:http|imap|nntp|pop3)/ and
217 $xnetd->{$l} = load_mod($scheme, $opt, $l);
219 next if $listener_names->{$l}; # already inherited
221 if (index($l, '/') == 0) {
222 $sock_pkg = 'IO::Socket::UNIX';
223 eval "use $sock_pkg";
225 %o = (Type => SOCK_STREAM, Peer => $l);
227 my $c = $sock_pkg->new(%o);
228 if (!defined($c) && $!{ECONNREFUSED}) {
230 "failed to unlink stale socket=$l: $!\n";
231 } # else: let the bind fail
233 $o{Local} = delete $o{Peer};
235 # both work for IPv4, too
236 for (qw(IO::Socket::IP IO::Socket::INET6)) {
238 eval "use $sock_pkg";
242 %o = (LocalAddr => $l, ReuseAddr => 1, Proto => 'tcp');
245 my $prev = umask 0000;
246 my $s = eval { $sock_pkg->new(%o) };
247 warn "error binding $l: $! ($@)\n" unless $s;
251 my $k = sockname($s);
252 warn "# bound $scheme://$k\n";
253 $listener_names->{$k} = $s;
258 # cert/key options in @cfg_listen takes precedence when inheriting,
259 # but map well-known inherited ports if --listen isn't specified
261 for my $sockname (@inherited_names) {
262 $sockname =~ /:([0-9]+)\z/ or next;
263 if (my $scheme = $KNOWN_TLS{$1}) {
264 $xnetd->{$sockname} //= load_mod($scheme);
265 $tls_opt{"$scheme://$sockname"} ||= accept_tls_opt('');
266 } elsif (($scheme = $KNOWN_STARTTLS{$1})) {
267 $xnetd->{$sockname} //= load_mod($scheme);
268 $tls_opt{"$scheme://$sockname"} ||= accept_tls_opt('');
269 $tls_opt{''} ||= accept_tls_opt('');
273 while (my ($k, $v) = each %tls_opt) { push(@d, $k) if !defined($v) }
275 die "No listeners bound\n" unless @listeners;
281 foreach my $i (0..$#ARGV) {
284 $ARGV[$i] = Cwd::abs_path($arg);
286 check_absolute('--stdout', $stdout);
287 check_absolute('--stderr', $stderr);
288 check_absolute('--pid-file', $pid_file);
289 check_absolute('--cert', $default_cert);
290 check_absolute('--key', $default_key);
292 chdir '/' or die "chdir failed: $!";
294 if (defined($pid_file) || defined($group) || defined($user)) {
295 eval { require Net::Server::Daemonize; 1 } // die <<EOF;
296 Net::Server required for --pid-file, --group, --user
300 Net::Server::Daemonize::check_pid_file($pid_file) if defined $pid_file;
301 $uid = Net::Server::Daemonize::get_uid($user) if defined $user;
302 if (defined $group) {
303 $gid = Net::Server::Daemonize::get_gid($group);
304 $gid = (split /\s+/, $gid)[0];
305 } elsif (defined $uid) {
306 $gid = (getpwuid($uid))[3];
309 # We change users in the worker to ensure upgradability,
310 # The upgrade will create the ".oldbin" pid file in the
311 # same directory as the given pid file.
312 $uid and $set_user = sub {
314 Net::Server::Daemonize::set_user($uid, $gid);
318 my $pid = fork // die "fork: $!";
321 open(STDIN, '+<', '/dev/null') or
322 die "redirect stdin failed: $!\n";
323 open STDOUT, '>&STDIN' or die "redirect stdout failed: $!\n";
324 open STDERR, '>&STDIN' or die "redirect stderr failed: $!\n";
326 $pid = fork // die "fork: $!";
329 return unless defined $pid_file;
331 write_pid($pid_file);
333 bless { pid => $$, pid_file => \$pid_file }, __PACKAGE__;
336 sub worker_quit { # $_[0] = signal name or number (unused)
337 # killing again terminates immediately:
338 exit unless @listeners;
340 $_->close foreach @listeners; # call PublicInbox::DS::close
344 # drop idle connections and try to quit gracefully
345 PublicInbox::DS->SetPostLoopCallback(sub {
346 my ($dmap, undef) = @_;
349 for my $s (values %$dmap) {
350 $s->can('busy') or next;
353 } else { # close as much as possible, early as possible
358 if (($warn + 5) < now()) {
359 warn "$$ quitting, $n client(s) left\n";
362 unless (defined $proc_name) {
363 $proc_name = (split(/\s+/, $0))[0];
364 $proc_name =~ s!\A.*?([^/]+)\z!$1!;
366 $0 = "$proc_name quitting, $n client(s) left";
368 $n; # true: loop continues, false: loop breaks
373 $logs{$stdout} //= \*STDOUT if defined $stdout;
374 $logs{$stderr} //= \*STDERR if defined $stderr;
375 while (my ($p, $fh) = each %logs) { open_log_path($fh, $p) }
380 my $addr = getsockname($s) or return;
381 my ($host, $port) = host_with_port($addr);
382 if ($port == 0 && $host eq '127.0.0.1') {
383 my ($path) = Socket::sockaddr_un($addr);
389 sub unpack_ipv6 ($) {
393 # Socket.pm in Perl 5.14+ supports IPv6:
395 ($port, $host) = Socket::unpack_sockaddr_in6($addr);
396 $host = Socket::inet_ntop(Socket::AF_INET6(), $host);
400 # Perl 5.12 or earlier? SpamAssassin and Net::Server use
401 # Socket6, so it may be installed on our system, already
402 # (otherwise die here):
405 ($port, $host) = Socket6::unpack_sockaddr_in6($addr);
406 $host = Socket6::inet_ntop(Socket6::AF_INET6(), $host);
411 sub host_with_port ($) {
415 # this eval will die on Unix sockets:
417 if (length($addr) >= 28) {
418 ($host, $port) = unpack_ipv6($addr);
421 ($port, $host) = Socket::sockaddr_in($addr);
422 $host = Socket::inet_ntoa($host);
425 $@ ? ('127.0.0.1', 0) : ($host, $port);
429 my ($listener_names) = @_;
430 return () if ($ENV{LISTEN_PID} || 0) != $$;
431 my $fds = $ENV{LISTEN_FDS} or return ();
432 my $end = $fds + 2; # LISTEN_FDS_START - 1
434 foreach my $fd (3..$end) {
435 open(my $s, '<&=', $fd) or warn "fdopen fd=$fd: $!";
436 if (my $k = sockname($s)) {
437 my $prev_was_blocking = $s->blocking(0);
438 warn <<"" if $prev_was_blocking;
439 Inherited socket ($k fd=$fd) is blocking, making it non-blocking.
440 Set 'NonBlocking = true' in the systemd.service unit to avoid stalled
441 processes when multiple service instances start.
443 $listener_names->{$k} = $s;
444 warn "# inherited $k fd=$fd\n";
447 warn "failed to inherit fd=$fd (LISTEN_FDS=$fds)";
453 sub upgrade { # $_[0] = signal name or number (unused)
455 warn "upgrade in-progress: $reexec_pid\n";
458 if (defined $pid_file) {
459 if ($pid_file =~ /\.oldbin\z/) {
460 warn "BUG: .oldbin suffix exists: $pid_file\n";
463 unlink_pid_file_safe_ish($$, $pid_file);
464 $pid_file .= '.oldbin';
465 write_pid($pid_file);
468 unless (defined $pid) {
469 warn "fork failed: $!\n";
473 use Fcntl qw(FD_CLOEXEC F_SETFD F_GETFD);
474 $ENV{LISTEN_FDS} = scalar @listeners;
475 $ENV{LISTEN_PID} = $$;
476 foreach my $s (@listeners) {
477 # @listeners are globs with workers, PI::L w/o workers
478 $s = $s->{sock} if ref($s) eq 'PublicInbox::Listener';
480 my $fl = fcntl($s, F_GETFD, 0);
481 fcntl($s, F_SETFD, $fl &= ~FD_CLOEXEC);
484 die "Failed to exec: $!\n";
489 sub kill_workers ($) {
491 kill $sig, keys(%pids);
494 sub upgrade_aborted ($) {
496 warn "reexec PID($p) died with: $?\n";
498 return unless $pid_file;
500 my $file = $pid_file;
501 $file =~ s/\.oldbin\z// or die "BUG: no '.oldbin' suffix in $file";
502 unlink_pid_file_safe_ish($$, $pid_file);
504 eval { write_pid($pid_file) };
508 sub reap_children { # $_[0] = 'CHLD' or POSIX::SIGCHLD()
510 my $p = waitpid(-1, WNOHANG) or return;
511 if (defined $reexec_pid && $p == $reexec_pid) {
513 } elsif (defined(my $id = delete $pids{$p})) {
514 warn "worker[$id] PID($p) died with: $?\n";
516 warn "unknown PID($p) reaped: $?\n";
523 sub unlink_pid_file_safe_ish ($$) {
524 my ($unlink_pid, $file) = @_;
525 return unless defined $unlink_pid && $unlink_pid == $$;
527 open my $fh, '<', $file or return;
529 defined(my $read_pid = <$fh>) or return;
531 if ($read_pid == $unlink_pid) {
532 Net::Server::Daemonize::unlink_pid_file($file);
536 sub master_quit ($) {
537 exit unless @listeners;
543 pipe(my ($p0, $p1)) or die "failed to create parent-pipe: $!";
544 my $set_workers = $worker_processes;
548 USR1 => sub { reopen_logs(); kill_workers($_[0]); },
550 QUIT => \&master_quit,
551 INT => \&master_quit,
552 TERM => \&master_quit,
554 return if $ignore_winch || !@listeners;
555 if (-t STDIN || -t STDOUT || -t STDERR) {
558 ignoring SIGWINCH since we are not daemonized
561 $worker_processes = 0;
565 return unless @listeners;
566 $worker_processes = $set_workers;
570 return unless @listeners;
571 if ($set_workers > $worker_processes) {
574 $worker_processes = ++$set_workers;
578 $worker_processes = --$set_workers if $set_workers > 0;
580 CHLD => \&reap_children,
582 my $sigfd = PublicInbox::Sigfd->new($sig);
583 local @SIG{keys %$sig} = values(%$sig) unless $sigfd;
584 PublicInbox::DS::sig_setmask($oldset) if !$sigfd;
585 while (1) { # main loop
586 my $n = scalar keys %pids;
587 unless (@listeners) {
589 $set_workers = $worker_processes = $n = 0;
592 if ($n > $worker_processes) {
593 while (my ($k, $v) = each %pids) {
594 kill('TERM', $k) if $v >= $worker_processes;
596 $n = $worker_processes;
598 my $want = $worker_processes - 1;
600 PublicInbox::DS::block_signals() if !$sigfd;
601 for my $i ($n..$want) {
602 my $seed = rand(0xffffffff);
605 warn "failed to fork worker[$i]: $!\n";
606 } elsif ($pid == 0) {
608 eval { Net::SSLeay::randomize() };
609 $set_user->() if $set_user;
610 return $p0; # run normal work code
612 warn "PID=$pid is worker[$i]\n";
616 PublicInbox::DS::sig_setmask($oldset) if !$sigfd;
619 if ($sigfd) { # Linux and IO::KQueue users:
621 } else { # wake up every second
625 exit # never gets here, just for documentation
629 my ($post_accept, $tlsd) = @_;
631 my ($io, $addr, $srv) = @_;
632 $post_accept->(PublicInbox::TLS::start($io, $tlsd), $addr, $srv)
636 sub defer_accept ($$) {
637 my ($s, $af_name) = @_;
638 return unless defined $af_name;
639 if ($^O eq 'linux') {
640 my $TCP_DEFER_ACCEPT = 9; # Socket::TCP_DEFER_ACCEPT is in 5.14+
641 my $x = getsockopt($s, IPPROTO_TCP, $TCP_DEFER_ACCEPT);
642 return unless defined $x; # may be Unix socket
643 my $sec = unpack('i', $x);
644 return if $sec > 0; # systemd users may set a higher value
645 setsockopt($s, IPPROTO_TCP, $TCP_DEFER_ACCEPT, 1);
646 } elsif ($^O eq 'freebsd') {
647 my $x = getsockopt($s, SOL_SOCKET, $SO_ACCEPTFILTER);
648 return if defined $x; # don't change if set
649 my $accf_arg = pack('a16a240', $af_name, '');
650 setsockopt($s, SOL_SOCKET, $SO_ACCEPTFILTER, $accf_arg);
654 sub daemon_loop ($) {
658 for my $xn (values %$xnetd) {
659 delete $xn->{tlsd}->{ssl_ctx}; # PublicInbox::TLS::start
660 eval { $xn->{refresh}->($sig) };
661 warn "refresh $@\n" if $@;
665 while (my ($k, $ctx_opt) = each %tls_opt) {
667 $l =~ s!\A([^:]+)://!!;
668 my $scheme = $1 // '';
669 my $xn = $xnetd->{$l} // $xnetd->{''};
670 $xn->{tlsd}->{ssl_ctx_opt} //= $ctx_opt;
671 $scheme =~ m!\A(?:https|imaps|nntps|pop3s)! and
672 $post_accept{$l} = tls_cb(@$xn{qw(post_accept tlsd)});
676 INT => \&worker_quit,
677 QUIT => \&worker_quit,
678 TERM => \&worker_quit,
681 USR1 => \&reopen_logs,
684 CHLD => \&PublicInbox::DS::enqueue_reap,
686 if ($worker_processes > 0) {
687 $refresh->(); # preload by default
688 my $fh = master_loop(); # returns if in child process
689 PublicInbox::EOFpipe->new($fh, \&worker_quit, undef);
692 $set_user->() if $set_user;
693 $sig->{USR2} = sub { worker_quit() if upgrade() };
699 my $l = sockname($_);
700 my $tls_cb = $post_accept{$l};
701 my $xn = $xnetd->{$l} // $xnetd->{''};
703 # NNTPS, HTTPS, HTTP, IMAPS and POP3S are client-first traffic
704 # IMAP, NNTP and POP3 are server-first
705 defer_accept($_, $tls_cb ? 'dataready' : $xn->{af_default});
707 # this calls epoll_create:
708 PublicInbox::Listener->new($_, $tls_cb || $xn->{post_accept})
710 PublicInbox::DS::event_loop($sig, $oldset);
714 my ($default_listen) = @_;
716 if ($default_listen) {
717 $default_listen =~ /\A(http|imap|nntp|pop3)/ or
718 die "BUG: $default_listen";
719 $xnetd->{''} = load_mod($1);
721 daemon_prepare($default_listen, $xnetd);
722 my $for_destroy = daemonize();
724 # localize GCF2C for tests:
725 local $PublicInbox::GitAsyncCat::GCF2C;
726 local $PublicInbox::Git::async_warn = 1;
727 local $SIG{__WARN__} = PublicInbox::Eml::warn_ignore_cb();
730 PublicInbox::DS->Reset;
731 # ->DESTROY runs when $for_destroy goes out-of-scope
736 Net::Server::Daemonize::create_pid_file($path);
741 unlink_pid_file_safe_ish($_[0]->{pid}, ${$_[0]->{pid_file}});