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
13 use POSIX qw(WNOHANG :signal_h);
14 use Socket qw(IPPROTO_TCP SOL_SOCKET);
17 use PublicInbox::DS qw(now);
18 use PublicInbox::Listener;
19 use PublicInbox::EOFpipe;
20 use PublicInbox::Sigfd;
22 use PublicInbox::GitAsyncCat;
24 our $SO_ACCEPTFILTER = 0x1000;
26 my ($set_user, $oldset);
27 my (@cfg_listen, $stdout, $stderr, $group, $user, $pid_file, $daemonize);
28 my $worker_processes = 1;
31 my %tls_opt; # scheme://sockname => args for IO::Socket::SSL->start_SSL
34 my ($default_cert, $default_key);
35 my %KNOWN_TLS = ( 443 => 'https', 563 => 'nntps', 993 => 'imaps' );
36 my %KNOWN_STARTTLS = ( 119 => 'nntp', 143 => 'imap' );
38 sub accept_tls_opt ($) {
40 # opt_str: opt1=val1,opt2=val2 (opt may repeat for multi-value)
41 require PublicInbox::TLS;
43 # allow ',' as delimiter since '&' is shell-unfriendly
44 foreach (split(/[,&]/, $opt_str)) {
45 my ($k, $v) = split(/=/, $_, 2);
46 push @{$o->{$k} ||= []}, $v;
49 # key may be a part of cert. At least
50 # p5-io-socket-ssl/example/ssl_server.pl has this fallback:
51 $o->{cert} //= [ $default_cert ];
52 $o->{key} //= defined($default_key) ? [ $default_key ] : $o->{cert};
53 my %ctx_opt = (SSL_server => 1);
54 # parse out hostname:/path/to/ mappings:
55 foreach my $k (qw(cert key)) {
56 my $x = $ctx_opt{'SSL_'.$k.'_file'} = {};
57 foreach my $path (@{$o->{$k}}) {
59 $path =~ s/\A([^:]+):// and $host = $1;
63 my $ctx = IO::Socket::SSL::SSL_Context->new(%ctx_opt) or
64 die 'SSL_Context->new: '.PublicInbox::TLS::err();
66 # save ~34K per idle connection (cf. SSL_CTX_set_mode(3ssl))
67 # RSS goes from 346MB to 171MB with 10K idle NNTPS clients on amd64
68 # cf. https://rt.cpan.org/Ticket/Display.html?id=129463
69 my $mode = eval { Net::SSLeay::MODE_RELEASE_BUFFERS() };
70 if ($mode && $ctx->{context}) {
71 eval { Net::SSLeay::CTX_set_mode($ctx->{context}, $mode) };
72 warn "W: $@ (setting SSL_MODE_RELEASE_BUFFERS)\n" if $@;
75 { SSL_server => 1, SSL_startHandshake => 0, SSL_reuse_ctx => $ctx };
80 my $modc = "PublicInbox::\U$1";
82 eval "require $mod"; # IMAPD|HTTPD|NNTPD|POP3D
84 my %xn = map { $_ => $mod->can($_) } qw(refresh post_accept);
85 $xn{tlsd} = $mod->new if $mod->can('refresh_groups'); #!HTTPD
87 $xn{refresh} //= sub { $tlsd->refresh_groups(@_) };
88 $xn{post_accept} //= sub { $modc->new($_[0], $tlsd) };
89 $xn{af_default} = 'httpready' if $modc eq 'PublicInbox::HTTP';
93 sub daemon_prepare ($$) {
94 my ($default_listen, $xnetd) = @_;
95 my $listener_names = {}; # sockname => IO::Handle
96 $oldset = PublicInbox::DS::block_signals();
98 my ($prog) = ($CMD[0] =~ m!([^/]+)\z!g);
99 my $dh = defined($default_listen) ? " (default: $default_listen)" : '';
101 usage: $prog [-l ADDRESS] [--cert=FILE] [--key=FILE]
105 -l ADDRESS address to listen on$dh
106 --cert=FILE default SSL/TLS certificate
107 --key=FILE default SSL/TLS certificate
108 -W WORKERS number of worker processes to spawn (default: 1)
110 See public-inbox-daemon(8) and $prog(1) man pages for more.
113 'l|listen=s' => \@cfg_listen,
114 '1|stdout=s' => \$stdout,
115 '2|stderr=s' => \$stderr,
116 'W|worker-processes=i' => \$worker_processes,
117 'P|pid-file=s' => \$pid_file,
118 'u|user=s' => \$user,
119 'g|group=s' => \$group,
120 'D|daemonize' => \$daemonize,
121 'cert=s' => \$default_cert,
122 'key=s' => \$default_key,
123 'help|h' => \(my $show_help),
125 GetOptions(%opt) or die $help;
126 if ($show_help) { print $help; exit 0 };
128 if (defined $pid_file && $pid_file =~ /\.oldbin\z/) {
129 die "--pid-file cannot end with '.oldbin'\n";
131 @listeners = inherit($listener_names);
133 # allow socket-activation users to set certs once and not
134 # have to configure each socket:
135 my @inherited_names = keys(%$listener_names) if defined($default_cert);
137 # ignore daemonize when inheriting
138 $daemonize = undef if scalar @listeners;
140 unless (@listeners || @cfg_listen) {
141 $default_listen // die "no listeners specified\n";
142 push @cfg_listen, $default_listen
145 foreach my $l (@cfg_listen) {
148 if ($l =~ s!\A([^:]+)://!!) {
150 } elsif ($l =~ /\A(?:\[[^\]]+\]|[^:]+):([0-9])+/) {
151 my $s = $KNOWN_TLS{$1} // $KNOWN_STARTTLS{$1};
152 $scheme = $s if defined $s;
154 if ($l =~ s!/?\?(.+)\z!!) {
155 $tls_opt{"$scheme://$l"} = accept_tls_opt($1);
156 } elsif (defined($default_cert)) {
157 $tls_opt{"$scheme://$l"} = accept_tls_opt('');
158 } elsif ($scheme =~ /\A(?:https|imaps|imaps)\z/) {
159 die "$orig specified w/o cert=\n";
161 $scheme =~ /\A(http|imap|nntp|pop3)/ and
162 $xnetd->{$l} = load_mod($1);
164 next if $listener_names->{$l}; # already inherited
166 if (index($l, '/') == 0) {
167 $sock_pkg = 'IO::Socket::UNIX';
168 eval "use $sock_pkg";
170 %o = (Type => SOCK_STREAM, Peer => $l);
172 my $c = $sock_pkg->new(%o);
173 if (!defined($c) && $!{ECONNREFUSED}) {
175 "failed to unlink stale socket=$l: $!\n";
176 } # else: let the bind fail
178 $o{Local} = delete $o{Peer};
180 # both work for IPv4, too
181 for (qw(IO::Socket::IP IO::Socket::INET6)) {
183 eval "use $sock_pkg";
187 %o = (LocalAddr => $l, ReuseAddr => 1, Proto => 'tcp');
190 my $prev = umask 0000;
191 my $s = eval { $sock_pkg->new(%o) };
192 warn "error binding $l: $! ($@)\n" unless $s;
195 $listener_names->{sockname($s)} = $s;
201 # cert/key options in @cfg_listen takes precedence when inheriting,
202 # but map well-known inherited ports if --listen isn't specified
204 for my $sockname (@inherited_names) {
205 $sockname =~ /:([0-9]+)\z/ or next;
206 if (my $scheme = $KNOWN_TLS{$1}) {
207 $tls_opt{"$scheme://$sockname"} ||= accept_tls_opt('');
208 } elsif (($scheme = $KNOWN_STARTTLS{$1})) {
209 next if $tls_opt{"$scheme://$sockname"};
210 $tls_opt{''} ||= accept_tls_opt('');
214 die "No listeners bound\n" unless @listeners;
217 sub check_absolute ($$) {
218 my ($var, $val) = @_;
219 if (defined $val && index($val, '/') != 0) {
221 "--$var must be an absolute path when using --daemonize: $val\n";
228 foreach my $i (0..$#ARGV) {
231 $ARGV[$i] = Cwd::abs_path($arg);
233 check_absolute('stdout', $stdout);
234 check_absolute('stderr', $stderr);
235 check_absolute('pid-file', $pid_file);
237 chdir '/' or die "chdir failed: $!";
239 if (defined($pid_file) || defined($group) || defined($user)) {
240 eval { require Net::Server::Daemonize; 1 } // die <<EOF;
241 Net::Server required for --pid-file, --group, --user
245 Net::Server::Daemonize::check_pid_file($pid_file) if defined $pid_file;
246 $uid = Net::Server::Daemonize::get_uid($user) if defined $user;
247 if (defined $group) {
248 $gid = Net::Server::Daemonize::get_gid($group);
249 $gid = (split /\s+/, $gid)[0];
250 } elsif (defined $uid) {
251 $gid = (getpwuid($uid))[3];
254 # We change users in the worker to ensure upgradability,
255 # The upgrade will create the ".oldbin" pid file in the
256 # same directory as the given pid file.
257 $uid and $set_user = sub {
259 Net::Server::Daemonize::set_user($uid, $gid);
263 my $pid = fork // die "fork: $!";
266 open(STDIN, '+<', '/dev/null') or
267 die "redirect stdin failed: $!\n";
268 open STDOUT, '>&STDIN' or die "redirect stdout failed: $!\n";
269 open STDERR, '>&STDIN' or die "redirect stderr failed: $!\n";
271 $pid = fork // die "fork: $!";
274 return unless defined $pid_file;
276 write_pid($pid_file);
278 bless { pid => $$, pid_file => \$pid_file }, __PACKAGE__;
281 sub worker_quit { # $_[0] = signal name or number (unused)
282 # killing again terminates immediately:
283 exit unless @listeners;
285 $_->close foreach @listeners; # call PublicInbox::DS::close
289 # drop idle connections and try to quit gracefully
290 PublicInbox::DS->SetPostLoopCallback(sub {
291 my ($dmap, undef) = @_;
294 for my $s (values %$dmap) {
295 $s->can('busy') or next;
298 } else { # close as much as possible, early as possible
303 if (($warn + 5) < now()) {
304 warn "$$ quitting, $n client(s) left\n";
307 unless (defined $proc_name) {
308 $proc_name = (split(/\s+/, $0))[0];
309 $proc_name =~ s!\A.*?([^/]+)\z!$1!;
311 $0 = "$proc_name quitting, $n client(s) left";
313 $n; # true: loop continues, false: loop breaks
319 open STDOUT, '>>', $stdout or
320 warn "failed to redirect stdout to $stdout: $!\n";
321 STDOUT->autoflush(1);
325 open STDERR, '>>', $stderr or
326 warn "failed to redirect stderr to $stderr: $!\n";
327 STDERR->autoflush(1);
334 my $addr = getsockname($s) or return;
335 my ($host, $port) = host_with_port($addr);
336 if ($port == 0 && $host eq '127.0.0.1') {
337 my ($path) = Socket::sockaddr_un($addr);
343 sub unpack_ipv6 ($) {
347 # Socket.pm in Perl 5.14+ supports IPv6:
349 ($port, $host) = Socket::unpack_sockaddr_in6($addr);
350 $host = Socket::inet_ntop(Socket::AF_INET6(), $host);
354 # Perl 5.12 or earlier? SpamAssassin and Net::Server use
355 # Socket6, so it may be installed on our system, already
356 # (otherwise die here):
359 ($port, $host) = Socket6::unpack_sockaddr_in6($addr);
360 $host = Socket6::inet_ntop(Socket6::AF_INET6(), $host);
365 sub host_with_port ($) {
369 # this eval will die on Unix sockets:
371 if (length($addr) >= 28) {
372 ($host, $port) = unpack_ipv6($addr);
375 ($port, $host) = Socket::sockaddr_in($addr);
376 $host = Socket::inet_ntoa($host);
379 $@ ? ('127.0.0.1', 0) : ($host, $port);
383 my ($listener_names) = @_;
384 return () if ($ENV{LISTEN_PID} || 0) != $$;
385 my $fds = $ENV{LISTEN_FDS} or return ();
386 my $end = $fds + 2; # LISTEN_FDS_START - 1
388 foreach my $fd (3..$end) {
389 open(my $s, '<&=', $fd) or warn "fdopen fd=$fd: $!";
390 if (my $k = sockname($s)) {
391 my $prev_was_blocking = $s->blocking(0);
392 warn <<"" if $prev_was_blocking;
393 Inherited socket (fd=$fd) is blocking, making it non-blocking.
394 Set 'NonBlocking = true' in the systemd.service unit to avoid stalled
395 processes when multiple service instances start.
397 $listener_names->{$k} = $s;
400 warn "failed to inherit fd=$fd (LISTEN_FDS=$fds)";
406 sub upgrade { # $_[0] = signal name or number (unused)
408 warn "upgrade in-progress: $reexec_pid\n";
411 if (defined $pid_file) {
412 if ($pid_file =~ /\.oldbin\z/) {
413 warn "BUG: .oldbin suffix exists: $pid_file\n";
416 unlink_pid_file_safe_ish($$, $pid_file);
417 $pid_file .= '.oldbin';
418 write_pid($pid_file);
421 unless (defined $pid) {
422 warn "fork failed: $!\n";
426 use Fcntl qw(FD_CLOEXEC F_SETFD F_GETFD);
427 $ENV{LISTEN_FDS} = scalar @listeners;
428 $ENV{LISTEN_PID} = $$;
429 foreach my $s (@listeners) {
430 # @listeners are globs with workers, PI::L w/o workers
431 $s = $s->{sock} if ref($s) eq 'PublicInbox::Listener';
433 my $fl = fcntl($s, F_GETFD, 0);
434 fcntl($s, F_SETFD, $fl &= ~FD_CLOEXEC);
437 die "Failed to exec: $!\n";
442 sub kill_workers ($) {
444 kill $sig, keys(%pids);
447 sub upgrade_aborted ($) {
449 warn "reexec PID($p) died with: $?\n";
451 return unless $pid_file;
453 my $file = $pid_file;
454 $file =~ s/\.oldbin\z// or die "BUG: no '.oldbin' suffix in $file";
455 unlink_pid_file_safe_ish($$, $pid_file);
457 eval { write_pid($pid_file) };
461 sub reap_children { # $_[0] = 'CHLD' or POSIX::SIGCHLD()
463 my $p = waitpid(-1, WNOHANG) or return;
464 if (defined $reexec_pid && $p == $reexec_pid) {
466 } elsif (defined(my $id = delete $pids{$p})) {
467 warn "worker[$id] PID($p) died with: $?\n";
469 warn "unknown PID($p) reaped: $?\n";
476 sub unlink_pid_file_safe_ish ($$) {
477 my ($unlink_pid, $file) = @_;
478 return unless defined $unlink_pid && $unlink_pid == $$;
480 open my $fh, '<', $file or return;
482 defined(my $read_pid = <$fh>) or return;
484 if ($read_pid == $unlink_pid) {
485 Net::Server::Daemonize::unlink_pid_file($file);
489 sub master_quit ($) {
490 exit unless @listeners;
496 pipe(my ($p0, $p1)) or die "failed to create parent-pipe: $!";
497 my $set_workers = $worker_processes;
501 USR1 => sub { reopen_logs(); kill_workers($_[0]); },
503 QUIT => \&master_quit,
504 INT => \&master_quit,
505 TERM => \&master_quit,
507 return if $ignore_winch || !@listeners;
508 if (-t STDIN || -t STDOUT || -t STDERR) {
511 ignoring SIGWINCH since we are not daemonized
514 $worker_processes = 0;
518 return unless @listeners;
519 $worker_processes = $set_workers;
523 return unless @listeners;
524 if ($set_workers > $worker_processes) {
527 $worker_processes = ++$set_workers;
531 $worker_processes = --$set_workers if $set_workers > 0;
533 CHLD => \&reap_children,
535 my $sigfd = PublicInbox::Sigfd->new($sig);
536 local @SIG{keys %$sig} = values(%$sig) unless $sigfd;
537 PublicInbox::DS::sig_setmask($oldset) if !$sigfd;
538 while (1) { # main loop
539 my $n = scalar keys %pids;
540 unless (@listeners) {
542 $set_workers = $worker_processes = $n = 0;
545 if ($n > $worker_processes) {
546 while (my ($k, $v) = each %pids) {
547 kill('TERM', $k) if $v >= $worker_processes;
549 $n = $worker_processes;
551 my $want = $worker_processes - 1;
553 PublicInbox::DS::block_signals() if !$sigfd;
554 for my $i ($n..$want) {
555 my $seed = rand(0xffffffff);
558 warn "failed to fork worker[$i]: $!\n";
559 } elsif ($pid == 0) {
561 eval { Net::SSLeay::randomize() };
562 $set_user->() if $set_user;
563 return $p0; # run normal work code
565 warn "PID=$pid is worker[$i]\n";
569 PublicInbox::DS::sig_setmask($oldset) if !$sigfd;
572 if ($sigfd) { # Linux and IO::KQueue users:
574 } else { # wake up every second
578 exit # never gets here, just for documentation
581 sub tls_start_cb ($$) {
582 my ($opt, $orig_post_accept) = @_;
584 my ($io, $addr, $srv) = @_;
585 my $ssl = IO::Socket::SSL->start_SSL($io, %$opt);
586 $orig_post_accept->($ssl, $addr, $srv);
590 sub defer_accept ($$) {
591 my ($s, $af_name) = @_;
592 return unless defined $af_name;
593 if ($^O eq 'linux') {
594 my $TCP_DEFER_ACCEPT = 9; # Socket::TCP_DEFER_ACCEPT is in 5.14+
595 my $x = getsockopt($s, IPPROTO_TCP, $TCP_DEFER_ACCEPT);
596 return unless defined $x; # may be Unix socket
597 my $sec = unpack('i', $x);
598 return if $sec > 0; # systemd users may set a higher value
599 setsockopt($s, IPPROTO_TCP, $TCP_DEFER_ACCEPT, 1);
600 } elsif ($^O eq 'freebsd') {
601 my $x = getsockopt($s, SOL_SOCKET, $SO_ACCEPTFILTER);
602 return if defined $x; # don't change if set
603 my $accf_arg = pack('a16a240', $af_name, '');
604 setsockopt($s, SOL_SOCKET, $SO_ACCEPTFILTER, $accf_arg);
608 sub daemon_loop ($) {
612 for my $xn (values %$xnetd) {
613 eval { $xn->{refresh}->($sig) };
614 warn "refresh $@\n" if $@;
618 while (my ($k, $v) = each %tls_opt) {
620 $l =~ s!\A([^:]+)://!!;
621 my $scheme = $1 // '';
622 my $xn = $xnetd->{$l} // $xnetd->{''};
623 if ($scheme =~ m!\A(?:https|imaps|nntps)!) {
624 $post_accept{$l} = tls_start_cb($v, $xn->{post_accept});
625 } elsif ($xn->{tlsd}) { # STARTTLS, $k eq '' is OK
626 $xn->{tlsd}->{accept_tls} = $v;
631 INT => \&worker_quit,
632 QUIT => \&worker_quit,
633 TERM => \&worker_quit,
636 USR1 => \&reopen_logs,
639 CHLD => \&PublicInbox::DS::enqueue_reap,
641 if ($worker_processes > 0) {
642 $refresh->(); # preload by default
643 my $fh = master_loop(); # returns if in child process
644 PublicInbox::EOFpipe->new($fh, \&worker_quit, undef);
647 $set_user->() if $set_user;
648 $sig->{USR2} = sub { worker_quit() if upgrade() };
654 my $l = sockname($_);
655 my $tls_cb = $post_accept{$l};
656 my $xn = $xnetd->{$l} // $xnetd->{''};
658 # NNTPS, HTTPS, HTTP, IMAPS and POP3S are client-first traffic
659 # IMAP, NNTP and POP3 are server-first
660 defer_accept($_, $tls_cb ? 'dataready' : $xn->{af_default});
662 # this calls epoll_create:
663 PublicInbox::Listener->new($_, $tls_cb || $xn->{post_accept})
665 PublicInbox::DS::event_loop($sig, $oldset);
669 my ($default_listen) = @_;
671 if ($default_listen) {
672 $default_listen =~ /\A(http|imap|nntp|pop3)/ or
673 die "BUG: $default_listen";
674 $xnetd->{''} = load_mod($1);
676 daemon_prepare($default_listen, $xnetd);
677 my $for_destroy = daemonize();
679 # localize GCF2C for tests:
680 local $PublicInbox::GitAsyncCat::GCF2C;
681 local $PublicInbox::Git::async_warn = 1;
682 local $SIG{__WARN__} = PublicInbox::Eml::warn_ignore_cb();
685 PublicInbox::DS->Reset;
686 # ->DESTROY runs when $for_destroy goes out-of-scope
691 if (defined $uid and !chown($uid, $gid, $path)) {
692 warn "could not chown $path: $!\n";
698 Net::Server::Daemonize::create_pid_file($path);
703 unlink_pid_file_safe_ish($_[0]->{pid}, ${$_[0]->{pid_file}});