1 # Copyright (C) 2015-2019 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
3 # contains common daemon code for the nntpd and httpd servers.
4 # This may be used for read-only IMAP server if we decide to implement it.
5 package PublicInbox::Daemon;
8 use Getopt::Long qw/:config gnu_getopt no_ignore_case auto_abbrev/;
11 use POSIX qw(WNOHANG :signal_h);
12 use Socket qw(IPPROTO_TCP SOL_SOCKET);
13 sub SO_ACCEPTFILTER () { 0x1000 }
17 use PublicInbox::DS qw(now);
18 require PublicInbox::EvCleanup;
19 require PublicInbox::Listener;
20 require PublicInbox::ParentPipe;
22 my ($set_user, $oldset, $newset);
23 my (@cfg_listen, $stdout, $stderr, $group, $user, $pid_file, $daemonize);
24 my $worker_processes = 1;
27 my %listener_names; # sockname => IO::Handle
28 my %tls_opt; # scheme://sockname => args for IO::Socket::SSL->start_SSL
32 my ($default_cert, $default_key);
33 END { $cleanup->() if $cleanup };
34 my %KNOWN_TLS = ( 443 => 'https', 563 => 'nntps' );
35 my %KNOWN_STARTTLS = ( 119 => 'nntp' );
37 sub accept_tls_opt ($) {
39 # opt_str: opt1=val1,opt2=val2 (opt may repeat for multi-value)
40 require PublicInbox::TLS;
42 # allow ',' as delimiter since '&' is shell-unfriendly
43 foreach (split(/[,&]/, $opt_str)) {
44 my ($k, $v) = split(/=/, $_, 2);
45 push @{$o->{$k} ||= []}, $v;
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 ];
51 $o->{key} //= defined($default_key) ? [ $default_key ] : $o->{cert};
52 my %ctx_opt = (SSL_server => 1);
53 # parse out hostname:/path/to/ mappings:
54 foreach my $k (qw(cert key)) {
55 my $x = $ctx_opt{'SSL_'.$k.'_file'} = {};
56 foreach my $path (@{$o->{$k}}) {
58 $path =~ s/\A([^:]+):// and $host = $1;
62 my $ctx = IO::Socket::SSL::SSL_Context->new(%ctx_opt) or
63 die 'SSL_Context->new: '.PublicInbox::TLS::err();
65 # save ~34K per idle connection (cf. SSL_CTX_set_mode(3ssl))
66 # RSS goes from 346MB to 171MB with 10K idle NNTPS clients on amd64
67 # cf. https://rt.cpan.org/Ticket/Display.html?id=129463
68 my $mode = eval { Net::SSLeay::MODE_RELEASE_BUFFERS() };
69 if ($mode && $ctx->{context}) {
70 eval { Net::SSLeay::CTX_set_mode($ctx->{context}, $mode) };
71 warn "W: $@ (setting SSL_MODE_RELEASE_BUFFERS)\n" if $@;
74 { SSL_server => 1, SSL_startHandshake => 0, SSL_reuse_ctx => $ctx };
77 sub daemon_prepare ($) {
78 my ($default_listen) = @_;
79 $oldset = POSIX::SigSet->new();
80 $newset = POSIX::SigSet->new();
81 $newset->fillset or die "fillset: $!";
82 sigprocmask(SIG_SETMASK, $newset, $oldset) or die "sigprocmask: $!";
85 'l|listen=s' => \@cfg_listen,
86 '1|stdout=s' => \$stdout,
87 '2|stderr=s' => \$stderr,
88 'W|worker-processes=i' => \$worker_processes,
89 'P|pid-file=s' => \$pid_file,
91 'g|group=s' => \$group,
92 'D|daemonize' => \$daemonize,
93 'cert=s' => \$default_cert,
94 'key=s' => \$default_key,
96 GetOptions(%opts) or die "bad command-line args\n";
98 if (defined $pid_file && $pid_file =~ /\.oldbin\z/) {
99 die "--pid-file cannot end with '.oldbin'\n";
101 @listeners = inherit();
103 # allow socket-activation users to set certs once and not
104 # have to configure each socket:
105 my @inherited_names = keys(%listener_names) if defined($default_cert);
107 # ignore daemonize when inheriting
108 $daemonize = undef if scalar @listeners;
110 push @cfg_listen, $default_listen unless (@listeners || @cfg_listen);
112 foreach my $l (@cfg_listen) {
115 if ($l =~ s!\A([^:]+)://!!) {
117 } elsif ($l =~ /\A(?:\[[^\]]+\]|[^:]+):([0-9])+/) {
118 my $s = $KNOWN_TLS{$1} // $KNOWN_STARTTLS{$1};
119 $scheme = $s if defined $s;
121 if ($l =~ s!/?\?(.+)\z!!) {
122 $tls_opt{"$scheme://$l"} = accept_tls_opt($1);
123 } elsif (defined($default_cert)) {
124 $tls_opt{"$scheme://$l"} = accept_tls_opt('');
125 } elsif ($scheme =~ /\A(?:nntps|https)\z/) {
126 die "$orig specified w/o cert=\n";
128 # TODO: use scheme to load either NNTP.pm or HTTP.pm
130 next if $listener_names{$l}; # already inherited
132 if (index($l, '/') == 0) {
133 $sock_pkg = 'IO::Socket::UNIX';
134 eval "use $sock_pkg";
136 %o = (Type => SOCK_STREAM, Peer => $l);
138 my $c = $sock_pkg->new(%o);
139 if (!defined($c) && $!{ECONNREFUSED}) {
141 "failed to unlink stale socket=$l: $!\n";
142 } # else: let the bind fail
144 $o{Local} = delete $o{Peer};
146 # both work for IPv4, too
147 for (qw(IO::Socket::IP IO::Socket::INET6)) {
149 eval "use $sock_pkg";
153 %o = (LocalAddr => $l, ReuseAddr => 1, Proto => 'tcp');
156 my $prev = umask 0000;
157 my $s = eval { $sock_pkg->new(%o) };
158 warn "error binding $l: $! ($@)\n" unless $s;
161 $listener_names{sockname($s)} = $s;
167 # cert/key options in @cfg_listen takes precedence when inheriting,
168 # but map well-known inherited ports if --listen isn't specified
170 for my $sockname (@inherited_names) {
171 $sockname =~ /:([0-9]+)\z/ or next;
172 if (my $scheme = $KNOWN_TLS{$1}) {
173 $tls_opt{"$scheme://$sockname"} ||= accept_tls_opt('');
174 } elsif (($scheme = $KNOWN_STARTTLS{$1})) {
175 next if $tls_opt{"$scheme://$sockname"};
176 $tls_opt{''} ||= accept_tls_opt('');
180 die "No listeners bound\n" unless @listeners;
183 sub check_absolute ($$) {
184 my ($var, $val) = @_;
185 if (defined $val && index($val, '/') != 0) {
187 "--$var must be an absolute path when using --daemonize: $val\n";
193 foreach my $i (0..$#ARGV) {
196 $ARGV[$i] = abs_path($arg);
198 check_absolute('stdout', $stdout);
199 check_absolute('stderr', $stderr);
200 check_absolute('pid-file', $pid_file);
202 chdir '/' or die "chdir failed: $!";
205 return unless (defined $pid_file || defined $group || defined $user
208 eval { require Net::Server::Daemonize };
211 "Net::Server required for --pid-file, --group, --user, and --daemonize\n$@\n";
214 Net::Server::Daemonize::check_pid_file($pid_file) if defined $pid_file;
215 $uid = Net::Server::Daemonize::get_uid($user) if defined $user;
216 if (defined $group) {
217 $gid = Net::Server::Daemonize::get_gid($group);
218 $gid = (split /\s+/, $gid)[0];
219 } elsif (defined $uid) {
220 $gid = (getpwuid($uid))[3];
223 # We change users in the worker to ensure upgradability,
224 # The upgrade will create the ".oldbin" pid file in the
225 # same directory as the given pid file.
226 $uid and $set_user = sub {
228 Net::Server::Daemonize::set_user($uid, $gid);
233 die "could not fork: $!\n" unless defined $pid;
236 open(STDIN, '+<', '/dev/null') or
237 die "redirect stdin failed: $!\n";
238 open STDOUT, '>&STDIN' or die "redirect stdout failed: $!\n";
239 open STDERR, '>&STDIN' or die "redirect stderr failed: $!\n";
242 die "could not fork: $!\n" unless defined $pid;
245 if (defined $pid_file) {
246 write_pid($pid_file);
249 $cleanup = undef; # avoid cyclic reference
250 unlink_pid_file_safe_ish($unlink_pid, $pid_file);
256 if ($^O eq 'linux') { # 1031: F_SETPIPE_SZ, 4096: page size
257 fcntl($_, 1031, 4096) for @_;
262 # killing again terminates immediately:
263 exit unless @listeners;
265 $_->close foreach @listeners; # call PublicInbox::DS::close
268 # create a lazy self-pipe which kicks us out of the EventLoop
269 # so DS::PostEventLoop can fire
270 if (pipe(my ($r, $w))) {
273 # shrink_pipes == noop
274 PublicInbox::ParentPipe->new($r, *shrink_pipes);
275 close $w; # wake up from the event loop
277 warn "E: pipe failed ($!), quit unreliable\n";
281 # drop idle connections and try to quit gracefully
282 PublicInbox::DS->SetPostLoopCallback(sub {
283 my ($dmap, undef) = @_;
287 foreach my $s (values %$dmap) {
288 $s->can('busy') or next;
289 if ($s->busy($now)) {
292 # close as much as possible, early as possible
297 if (($warn + 5) < now()) {
298 warn "$$ quitting, $n client(s) left\n";
301 unless (defined $proc_name) {
302 $proc_name = (split(/\s+/, $0))[0];
303 $proc_name =~ s!\A.*?([^/]+)\z!$1!;
305 $0 = "$proc_name quitting, $n client(s) left";
307 $n; # true: loop continues, false: loop breaks
313 open STDOUT, '>>', $stdout or
314 warn "failed to redirect stdout to $stdout: $!\n";
315 STDOUT->autoflush(1);
319 open STDERR, '>>', $stderr or
320 warn "failed to redirect stderr to $stderr: $!\n";
321 STDERR->autoflush(1);
328 my $addr = getsockname($s) or return;
329 my ($host, $port) = host_with_port($addr);
330 if ($port == 0 && $host eq '127.0.0.1') {
331 my ($path) = Socket::sockaddr_un($addr);
337 sub unpack_ipv6 ($) {
341 # Socket.pm in Perl 5.14+ supports IPv6:
343 ($port, $host) = Socket::unpack_sockaddr_in6($addr);
344 $host = Socket::inet_ntop(Socket::AF_INET6(), $host);
348 # Perl 5.12 or earlier? SpamAssassin and Net::Server use
349 # Socket6, so it may be installed on our system, already
350 # (otherwise die here):
353 ($port, $host) = Socket6::unpack_sockaddr_in6($addr);
354 $host = Socket6::inet_ntop(Socket6::AF_INET6(), $host);
359 sub host_with_port ($) {
363 # this eval will die on Unix sockets:
365 if (length($addr) >= 28) {
366 ($host, $port) = unpack_ipv6($addr);
369 ($port, $host) = Socket::sockaddr_in($addr);
370 $host = Socket::inet_ntoa($host);
373 $@ ? ('127.0.0.1', 0) : ($host, $port);
377 return () if ($ENV{LISTEN_PID} || 0) != $$;
378 my $fds = $ENV{LISTEN_FDS} or return ();
379 my $end = $fds + 2; # LISTEN_FDS_START - 1
381 foreach my $fd (3..$end) {
382 my $s = IO::Handle->new_from_fd($fd, 'r');
383 if (my $k = sockname($s)) {
387 Inherited socket (fd=$fd) is blocking, making it non-blocking.
388 Set 'NonBlocking = true' in the systemd.service unit to avoid stalled
389 processes when multiple service instances start.
392 $listener_names{$k} = $s;
395 warn "failed to inherit fd=$fd (LISTEN_FDS=$fds)";
403 warn "upgrade in-progress: $reexec_pid\n";
406 if (defined $pid_file) {
407 if ($pid_file =~ /\.oldbin\z/) {
408 warn "BUG: .oldbin suffix exists: $pid_file\n";
411 unlink_pid_file_safe_ish($$, $pid_file);
412 $pid_file .= '.oldbin';
413 write_pid($pid_file);
416 unless (defined $pid) {
417 warn "fork failed: $!\n";
421 use Fcntl qw(FD_CLOEXEC F_SETFD F_GETFD);
422 $ENV{LISTEN_FDS} = scalar @listeners;
423 $ENV{LISTEN_PID} = $$;
424 foreach my $s (@listeners) {
425 my $fl = fcntl($s, F_GETFD, 0);
426 fcntl($s, F_SETFD, $fl &= ~FD_CLOEXEC);
429 die "Failed to exec: $!\n";
434 sub kill_workers ($) {
437 while (my ($pid, $id) = each %pids) {
442 sub upgrade_aborted ($) {
444 warn "reexec PID($p) died with: $?\n";
446 return unless $pid_file;
448 my $file = $pid_file;
449 $file =~ s/\.oldbin\z// or die "BUG: no '.oldbin' suffix in $file";
450 unlink_pid_file_safe_ish($$, $pid_file);
452 eval { write_pid($pid_file) };
456 sub reap_children () {
458 my $p = waitpid(-1, WNOHANG) or return;
459 if (defined $reexec_pid && $p == $reexec_pid) {
461 } elsif (defined(my $id = delete $pids{$p})) {
462 warn "worker[$id] PID($p) died with: $?\n";
464 warn "unknown PID($p) reaped: $?\n";
471 sub unlink_pid_file_safe_ish ($$) {
472 my ($unlink_pid, $file) = @_;
473 return unless defined $unlink_pid && $unlink_pid == $$;
475 open my $fh, '<', $file or return;
477 defined(my $read_pid = <$fh>) or return;
479 if ($read_pid == $unlink_pid) {
480 Net::Server::Daemonize::unlink_pid_file($file);
485 pipe(my ($p0, $p1)) or die "failed to create parent-pipe: $!";
486 pipe(my ($r, $w)) or die "failed to create self-pipe: $!";
487 shrink_pipes($w, $p1);
489 IO::Handle::blocking($w, 0);
490 my $set_workers = $worker_processes;
493 foreach my $s (qw(HUP CHLD QUIT INT TERM USR1 USR2 TTIN TTOU WINCH)) {
495 return if $$ != $master_pid;
500 sigprocmask(SIG_SETMASK, $oldset) or die "sigprocmask: $!";
505 while (my $s = shift @caught) {
509 } elsif ($s eq 'USR2') {
511 } elsif ($s =~ /\A(?:QUIT|TERM|INT)\z/) {
514 } elsif ($s eq 'WINCH') {
515 if (-t STDIN || -t STDOUT || -t STDERR) {
517 "ignoring SIGWINCH since we are not daemonized\n";
518 $SIG{WINCH} = 'IGNORE';
520 $worker_processes = 0;
522 } elsif ($s eq 'HUP') {
523 $worker_processes = $set_workers;
525 } elsif ($s eq 'TTIN') {
526 if ($set_workers > $worker_processes) {
529 $worker_processes = ++$set_workers;
531 } elsif ($s eq 'TTOU') {
532 if ($set_workers > 0) {
533 $worker_processes = --$set_workers;
535 } elsif ($s eq 'CHLD') {
540 my $n = scalar keys %pids;
543 $set_workers = $worker_processes = $n = 0;
546 if ($n > $worker_processes) {
547 while (my ($k, $v) = each %pids) {
548 kill('TERM', $k) if $v >= $worker_processes;
550 $n = $worker_processes;
552 sigprocmask(SIG_SETMASK, $newset) or die "sigprocmask: $!";
553 foreach my $i ($n..($worker_processes - 1)) {
556 warn "failed to fork worker[$i]: $!\n";
557 } elsif ($pid == 0) {
558 $set_user->() if $set_user;
559 return $p0; # run normal work code
561 warn "PID=$pid is worker[$i]\n";
565 sigprocmask(SIG_SETMASK, $oldset) or die "sigprocmask: $!";
566 # just wait on signal events here:
567 sysread($r, my $buf, 8);
569 exit # never gets here, just for documentation
572 sub tls_start_cb ($$) {
573 my ($opt, $orig_post_accept) = @_;
575 my ($io, $addr, $srv) = @_;
576 my $ssl = IO::Socket::SSL->start_SSL($io, %$opt);
577 $orig_post_accept->($ssl, $addr, $srv);
581 sub defer_accept ($$) {
582 my ($s, $af_name) = @_;
583 return unless defined $af_name;
584 if ($^O eq 'linux') {
585 my $x = getsockopt($s, IPPROTO_TCP, Socket::TCP_DEFER_ACCEPT());
586 return unless defined $x; # may be Unix socket
587 my $sec = unpack('i', $x);
588 return if $sec > 0; # systemd users may set a higher value
589 setsockopt($s, IPPROTO_TCP, Socket::TCP_DEFER_ACCEPT(), 1);
590 } elsif ($^O eq 'freebsd') {
591 my $x = getsockopt($s, SOL_SOCKET, SO_ACCEPTFILTER);
592 return if defined $x; # don't change if set
593 my $accf_arg = pack('a16a240', $af_name, '');
594 setsockopt($s, SOL_SOCKET, SO_ACCEPTFILTER, $accf_arg);
598 sub daemon_loop ($$$$) {
599 my ($refresh, $post_accept, $nntpd, $af_default) = @_;
600 PublicInbox::EvCleanup::enable(); # early for $refresh
602 while (my ($k, $v) = each %tls_opt) {
603 if ($k =~ s!\A(?:nntps|https)://!!) {
604 $post_accept{$k} = tls_start_cb($v, $post_accept);
605 } elsif ($nntpd) { # STARTTLS, $k eq '' is OK
606 $nntpd->{accept_tls} = $v;
610 if ($worker_processes > 0) {
611 $refresh->(); # preload by default
612 my $fh = master_loop(); # returns if in child process
613 $parent_pipe = PublicInbox::ParentPipe->new($fh, *worker_quit);
616 $set_user->() if $set_user;
617 $SIG{USR2} = sub { worker_quit() if upgrade() };
622 $SIG{QUIT} = $SIG{INT} = $SIG{TERM} = *worker_quit;
623 $SIG{USR1} = *reopen_logs;
624 $SIG{HUP} = $refresh;
625 $SIG{CHLD} = 'DEFAULT';
626 $SIG{$_} = 'IGNORE' for qw(USR2 TTIN TTOU WINCH);
628 my $tls_cb = $post_accept{sockname($_)};
630 # NNTPS, HTTPS, HTTP, and POP3S are client-first traffic
631 # NNTP and POP3 are server-first
632 defer_accept($_, $tls_cb ? 'dataready' : $af_default);
634 # this calls epoll_create:
635 PublicInbox::Listener->new($_, $tls_cb || $post_accept)
637 sigprocmask(SIG_SETMASK, $oldset) or die "sigprocmask: $!";
638 PublicInbox::DS->EventLoop;
639 $parent_pipe = undef;
644 my ($default, $refresh, $post_accept, $nntpd) = @_;
645 daemon_prepare($default);
646 my $af_default = $default =~ /:8080\z/ ? 'httpready' : undef;
648 daemon_loop($refresh, $post_accept, $nntpd, $af_default);
653 if (defined $uid and !chown($uid, $gid, $path)) {
654 warn "could not chown $path: $!\n";
660 Net::Server::Daemonize::create_pid_file($path);