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 use PublicInbox::Syscall qw(SFD_NONBLOCK);
19 require PublicInbox::EvCleanup;
20 require PublicInbox::Listener;
21 require PublicInbox::ParentPipe;
22 require PublicInbox::Sigfd;
24 my ($set_user, $oldset, $newset);
25 my (@cfg_listen, $stdout, $stderr, $group, $user, $pid_file, $daemonize);
26 my $worker_processes = 1;
29 my %listener_names; # sockname => IO::Handle
30 my %tls_opt; # scheme://sockname => args for IO::Socket::SSL->start_SSL
34 my ($default_cert, $default_key);
35 END { $cleanup->() if $cleanup };
36 my %KNOWN_TLS = ( 443 => 'https', 563 => 'nntps' );
37 my %KNOWN_STARTTLS = ( 119 => 'nntp' );
39 sub accept_tls_opt ($) {
41 # opt_str: opt1=val1,opt2=val2 (opt may repeat for multi-value)
42 require PublicInbox::TLS;
44 # allow ',' as delimiter since '&' is shell-unfriendly
45 foreach (split(/[,&]/, $opt_str)) {
46 my ($k, $v) = split(/=/, $_, 2);
47 push @{$o->{$k} ||= []}, $v;
50 # key may be a part of cert. At least
51 # p5-io-socket-ssl/example/ssl_server.pl has this fallback:
52 $o->{cert} //= [ $default_cert ];
53 $o->{key} //= defined($default_key) ? [ $default_key ] : $o->{cert};
54 my %ctx_opt = (SSL_server => 1);
55 # parse out hostname:/path/to/ mappings:
56 foreach my $k (qw(cert key)) {
57 my $x = $ctx_opt{'SSL_'.$k.'_file'} = {};
58 foreach my $path (@{$o->{$k}}) {
60 $path =~ s/\A([^:]+):// and $host = $1;
64 my $ctx = IO::Socket::SSL::SSL_Context->new(%ctx_opt) or
65 die 'SSL_Context->new: '.PublicInbox::TLS::err();
67 # save ~34K per idle connection (cf. SSL_CTX_set_mode(3ssl))
68 # RSS goes from 346MB to 171MB with 10K idle NNTPS clients on amd64
69 # cf. https://rt.cpan.org/Ticket/Display.html?id=129463
70 my $mode = eval { Net::SSLeay::MODE_RELEASE_BUFFERS() };
71 if ($mode && $ctx->{context}) {
72 eval { Net::SSLeay::CTX_set_mode($ctx->{context}, $mode) };
73 warn "W: $@ (setting SSL_MODE_RELEASE_BUFFERS)\n" if $@;
76 { SSL_server => 1, SSL_startHandshake => 0, SSL_reuse_ctx => $ctx };
79 sub sig_setmask { sigprocmask(SIG_SETMASK, @_) or die "sigprocmask: $!" }
81 sub daemon_prepare ($) {
82 my ($default_listen) = @_;
83 $oldset = POSIX::SigSet->new();
84 $newset = POSIX::SigSet->new();
85 $newset->fillset or die "fillset: $!";
86 sig_setmask($newset, $oldset);
89 'l|listen=s' => \@cfg_listen,
90 '1|stdout=s' => \$stdout,
91 '2|stderr=s' => \$stderr,
92 'W|worker-processes=i' => \$worker_processes,
93 'P|pid-file=s' => \$pid_file,
95 'g|group=s' => \$group,
96 'D|daemonize' => \$daemonize,
97 'cert=s' => \$default_cert,
98 'key=s' => \$default_key,
100 GetOptions(%opts) or die "bad command-line args\n";
102 if (defined $pid_file && $pid_file =~ /\.oldbin\z/) {
103 die "--pid-file cannot end with '.oldbin'\n";
105 @listeners = inherit();
107 # allow socket-activation users to set certs once and not
108 # have to configure each socket:
109 my @inherited_names = keys(%listener_names) if defined($default_cert);
111 # ignore daemonize when inheriting
112 $daemonize = undef if scalar @listeners;
114 push @cfg_listen, $default_listen unless (@listeners || @cfg_listen);
116 foreach my $l (@cfg_listen) {
119 if ($l =~ s!\A([^:]+)://!!) {
121 } elsif ($l =~ /\A(?:\[[^\]]+\]|[^:]+):([0-9])+/) {
122 my $s = $KNOWN_TLS{$1} // $KNOWN_STARTTLS{$1};
123 $scheme = $s if defined $s;
125 if ($l =~ s!/?\?(.+)\z!!) {
126 $tls_opt{"$scheme://$l"} = accept_tls_opt($1);
127 } elsif (defined($default_cert)) {
128 $tls_opt{"$scheme://$l"} = accept_tls_opt('');
129 } elsif ($scheme =~ /\A(?:nntps|https)\z/) {
130 die "$orig specified w/o cert=\n";
132 # TODO: use scheme to load either NNTP.pm or HTTP.pm
134 next if $listener_names{$l}; # already inherited
136 if (index($l, '/') == 0) {
137 $sock_pkg = 'IO::Socket::UNIX';
138 eval "use $sock_pkg";
140 %o = (Type => SOCK_STREAM, Peer => $l);
142 my $c = $sock_pkg->new(%o);
143 if (!defined($c) && $!{ECONNREFUSED}) {
145 "failed to unlink stale socket=$l: $!\n";
146 } # else: let the bind fail
148 $o{Local} = delete $o{Peer};
150 # both work for IPv4, too
151 for (qw(IO::Socket::IP IO::Socket::INET6)) {
153 eval "use $sock_pkg";
157 %o = (LocalAddr => $l, ReuseAddr => 1, Proto => 'tcp');
160 my $prev = umask 0000;
161 my $s = eval { $sock_pkg->new(%o) };
162 warn "error binding $l: $! ($@)\n" unless $s;
165 $listener_names{sockname($s)} = $s;
171 # cert/key options in @cfg_listen takes precedence when inheriting,
172 # but map well-known inherited ports if --listen isn't specified
174 for my $sockname (@inherited_names) {
175 $sockname =~ /:([0-9]+)\z/ or next;
176 if (my $scheme = $KNOWN_TLS{$1}) {
177 $tls_opt{"$scheme://$sockname"} ||= accept_tls_opt('');
178 } elsif (($scheme = $KNOWN_STARTTLS{$1})) {
179 next if $tls_opt{"$scheme://$sockname"};
180 $tls_opt{''} ||= accept_tls_opt('');
184 die "No listeners bound\n" unless @listeners;
187 sub check_absolute ($$) {
188 my ($var, $val) = @_;
189 if (defined $val && index($val, '/') != 0) {
191 "--$var must be an absolute path when using --daemonize: $val\n";
197 foreach my $i (0..$#ARGV) {
200 $ARGV[$i] = abs_path($arg);
202 check_absolute('stdout', $stdout);
203 check_absolute('stderr', $stderr);
204 check_absolute('pid-file', $pid_file);
206 chdir '/' or die "chdir failed: $!";
209 return unless (defined $pid_file || defined $group || defined $user
212 eval { require Net::Server::Daemonize };
215 "Net::Server required for --pid-file, --group, --user, and --daemonize\n$@\n";
218 Net::Server::Daemonize::check_pid_file($pid_file) if defined $pid_file;
219 $uid = Net::Server::Daemonize::get_uid($user) if defined $user;
220 if (defined $group) {
221 $gid = Net::Server::Daemonize::get_gid($group);
222 $gid = (split /\s+/, $gid)[0];
223 } elsif (defined $uid) {
224 $gid = (getpwuid($uid))[3];
227 # We change users in the worker to ensure upgradability,
228 # The upgrade will create the ".oldbin" pid file in the
229 # same directory as the given pid file.
230 $uid and $set_user = sub {
232 Net::Server::Daemonize::set_user($uid, $gid);
237 die "could not fork: $!\n" unless defined $pid;
240 open(STDIN, '+<', '/dev/null') or
241 die "redirect stdin failed: $!\n";
242 open STDOUT, '>&STDIN' or die "redirect stdout failed: $!\n";
243 open STDERR, '>&STDIN' or die "redirect stderr failed: $!\n";
246 die "could not fork: $!\n" unless defined $pid;
249 if (defined $pid_file) {
250 write_pid($pid_file);
253 $cleanup = undef; # avoid cyclic reference
254 unlink_pid_file_safe_ish($unlink_pid, $pid_file);
259 sub worker_quit { # $_[0] = signal name or number (unused)
260 # killing again terminates immediately:
261 exit unless @listeners;
263 $_->close foreach @listeners; # call PublicInbox::DS::close
267 # drop idle connections and try to quit gracefully
268 PublicInbox::DS->SetPostLoopCallback(sub {
269 my ($dmap, undef) = @_;
273 foreach my $s (values %$dmap) {
274 $s->can('busy') or next;
275 if ($s->busy($now)) {
278 # close as much as possible, early as possible
283 if (($warn + 5) < now()) {
284 warn "$$ quitting, $n client(s) left\n";
287 unless (defined $proc_name) {
288 $proc_name = (split(/\s+/, $0))[0];
289 $proc_name =~ s!\A.*?([^/]+)\z!$1!;
291 $0 = "$proc_name quitting, $n client(s) left";
293 $n; # true: loop continues, false: loop breaks
299 open STDOUT, '>>', $stdout or
300 warn "failed to redirect stdout to $stdout: $!\n";
301 STDOUT->autoflush(1);
305 open STDERR, '>>', $stderr or
306 warn "failed to redirect stderr to $stderr: $!\n";
307 STDERR->autoflush(1);
314 my $addr = getsockname($s) or return;
315 my ($host, $port) = host_with_port($addr);
316 if ($port == 0 && $host eq '127.0.0.1') {
317 my ($path) = Socket::sockaddr_un($addr);
323 sub unpack_ipv6 ($) {
327 # Socket.pm in Perl 5.14+ supports IPv6:
329 ($port, $host) = Socket::unpack_sockaddr_in6($addr);
330 $host = Socket::inet_ntop(Socket::AF_INET6(), $host);
334 # Perl 5.12 or earlier? SpamAssassin and Net::Server use
335 # Socket6, so it may be installed on our system, already
336 # (otherwise die here):
339 ($port, $host) = Socket6::unpack_sockaddr_in6($addr);
340 $host = Socket6::inet_ntop(Socket6::AF_INET6(), $host);
345 sub host_with_port ($) {
349 # this eval will die on Unix sockets:
351 if (length($addr) >= 28) {
352 ($host, $port) = unpack_ipv6($addr);
355 ($port, $host) = Socket::sockaddr_in($addr);
356 $host = Socket::inet_ntoa($host);
359 $@ ? ('127.0.0.1', 0) : ($host, $port);
363 return () if ($ENV{LISTEN_PID} || 0) != $$;
364 my $fds = $ENV{LISTEN_FDS} or return ();
365 my $end = $fds + 2; # LISTEN_FDS_START - 1
367 foreach my $fd (3..$end) {
368 my $s = IO::Handle->new_from_fd($fd, 'r');
369 if (my $k = sockname($s)) {
373 Inherited socket (fd=$fd) is blocking, making it non-blocking.
374 Set 'NonBlocking = true' in the systemd.service unit to avoid stalled
375 processes when multiple service instances start.
378 $listener_names{$k} = $s;
381 warn "failed to inherit fd=$fd (LISTEN_FDS=$fds)";
387 sub upgrade { # $_[0] = signal name or number (unused)
389 warn "upgrade in-progress: $reexec_pid\n";
392 if (defined $pid_file) {
393 if ($pid_file =~ /\.oldbin\z/) {
394 warn "BUG: .oldbin suffix exists: $pid_file\n";
397 unlink_pid_file_safe_ish($$, $pid_file);
398 $pid_file .= '.oldbin';
399 write_pid($pid_file);
402 unless (defined $pid) {
403 warn "fork failed: $!\n";
407 use Fcntl qw(FD_CLOEXEC F_SETFD F_GETFD);
408 $ENV{LISTEN_FDS} = scalar @listeners;
409 $ENV{LISTEN_PID} = $$;
410 foreach my $s (@listeners) {
411 my $fl = fcntl($s, F_GETFD, 0);
412 fcntl($s, F_SETFD, $fl &= ~FD_CLOEXEC);
415 die "Failed to exec: $!\n";
420 sub kill_workers ($) {
423 while (my ($pid, $id) = each %pids) {
428 sub upgrade_aborted ($) {
430 warn "reexec PID($p) died with: $?\n";
432 return unless $pid_file;
434 my $file = $pid_file;
435 $file =~ s/\.oldbin\z// or die "BUG: no '.oldbin' suffix in $file";
436 unlink_pid_file_safe_ish($$, $pid_file);
438 eval { write_pid($pid_file) };
442 sub reap_children { # $_[0] = 'CHLD' or POSIX::SIGCHLD()
444 my $p = waitpid(-1, WNOHANG) or return;
445 if (defined $reexec_pid && $p == $reexec_pid) {
447 } elsif (defined(my $id = delete $pids{$p})) {
448 warn "worker[$id] PID($p) died with: $?\n";
450 warn "unknown PID($p) reaped: $?\n";
457 sub unlink_pid_file_safe_ish ($$) {
458 my ($unlink_pid, $file) = @_;
459 return unless defined $unlink_pid && $unlink_pid == $$;
461 open my $fh, '<', $file or return;
463 defined(my $read_pid = <$fh>) or return;
465 if ($read_pid == $unlink_pid) {
466 Net::Server::Daemonize::unlink_pid_file($file);
471 pipe(my ($p0, $p1)) or die "failed to create parent-pipe: $!";
472 # 1031: F_SETPIPE_SZ, 4096: page size
473 fcntl($p1, 1031, 4096) if $^O eq 'linux';
474 my $set_workers = $worker_processes;
478 my $quit_cb = sub { exit if $quit++; kill_workers($_[0]) };
480 USR1 => sub { reopen_logs(); kill_workers($_[0]); },
486 return if $ignore_winch;
487 if (-t STDIN || -t STDOUT || -t STDERR) {
490 ignoring SIGWINCH since we are not daemonized
493 $worker_processes = 0;
497 $worker_processes = $set_workers;
501 if ($set_workers > $worker_processes) {
504 $worker_processes = ++$set_workers;
508 $worker_processes = --$set_workers if $set_workers > 0;
510 CHLD => \&reap_children,
512 my $sigfd = PublicInbox::Sigfd->new($sig, 0);
513 local %SIG = (%SIG, %$sig) if !$sigfd;
514 sig_setmask($oldset) if !$sigfd;
515 while (1) { # main loop
516 my $n = scalar keys %pids;
519 $set_workers = $worker_processes = $n = 0;
522 if ($n > $worker_processes) {
523 while (my ($k, $v) = each %pids) {
524 kill('TERM', $k) if $v >= $worker_processes;
526 $n = $worker_processes;
528 my $want = $worker_processes - 1;
530 sig_setmask($newset) if !$sigfd;
531 for my $i ($n..$want) {
534 warn "failed to fork worker[$i]: $!\n";
535 } elsif ($pid == 0) {
536 $set_user->() if $set_user;
537 return $p0; # run normal work code
539 warn "PID=$pid is worker[$i]\n";
543 sig_setmask($oldset) if !$sigfd;
546 if ($sigfd) { # Linux and IO::KQueue users:
548 } else { # wake up every second
552 exit # never gets here, just for documentation
555 sub tls_start_cb ($$) {
556 my ($opt, $orig_post_accept) = @_;
558 my ($io, $addr, $srv) = @_;
559 my $ssl = IO::Socket::SSL->start_SSL($io, %$opt);
560 $orig_post_accept->($ssl, $addr, $srv);
564 sub defer_accept ($$) {
565 my ($s, $af_name) = @_;
566 return unless defined $af_name;
567 if ($^O eq 'linux') {
568 my $x = getsockopt($s, IPPROTO_TCP, Socket::TCP_DEFER_ACCEPT());
569 return unless defined $x; # may be Unix socket
570 my $sec = unpack('i', $x);
571 return if $sec > 0; # systemd users may set a higher value
572 setsockopt($s, IPPROTO_TCP, Socket::TCP_DEFER_ACCEPT(), 1);
573 } elsif ($^O eq 'freebsd') {
574 my $x = getsockopt($s, SOL_SOCKET, SO_ACCEPTFILTER);
575 return if defined $x; # don't change if set
576 my $accf_arg = pack('a16a240', $af_name, '');
577 setsockopt($s, SOL_SOCKET, SO_ACCEPTFILTER, $accf_arg);
581 sub daemon_loop ($$$$) {
582 my ($refresh, $post_accept, $nntpd, $af_default) = @_;
583 PublicInbox::EvCleanup::enable(); # early for $refresh
585 while (my ($k, $v) = each %tls_opt) {
586 if ($k =~ s!\A(?:nntps|https)://!!) {
587 $post_accept{$k} = tls_start_cb($v, $post_accept);
588 } elsif ($nntpd) { # STARTTLS, $k eq '' is OK
589 $nntpd->{accept_tls} = $v;
594 INT => \&worker_quit,
595 QUIT => \&worker_quit,
596 TERM => \&worker_quit,
599 USR1 => \&reopen_logs,
602 CHLD => \&PublicInbox::DS::enqueue_reap,
605 if ($worker_processes > 0) {
606 $refresh->(); # preload by default
607 my $fh = master_loop(); # returns if in child process
608 $parent_pipe = PublicInbox::ParentPipe->new($fh, *worker_quit);
611 $set_user->() if $set_user;
612 $sig->{USR2} = sub { worker_quit() if upgrade() };
618 my $tls_cb = $post_accept{sockname($_)};
620 # NNTPS, HTTPS, HTTP, and POP3S are client-first traffic
621 # NNTP and POP3 are server-first
622 defer_accept($_, $tls_cb ? 'dataready' : $af_default);
624 # this calls epoll_create:
625 PublicInbox::Listener->new($_, $tls_cb || $post_accept)
627 my $sigfd = PublicInbox::Sigfd->new($sig, SFD_NONBLOCK);
628 local %SIG = (%SIG, %$sig) if !$sigfd;
630 # wake up every second to accept signals if we don't
631 # have signalfd or IO::KQueue:
632 sig_setmask($oldset);
633 PublicInbox::DS->SetLoopTimeout(1000);
635 PublicInbox::DS->EventLoop;
636 $parent_pipe = undef;
641 my ($default, $refresh, $post_accept, $nntpd) = @_;
642 daemon_prepare($default);
643 my $af_default = $default =~ /:8080\z/ ? 'httpready' : undef;
645 daemon_loop($refresh, $post_accept, $nntpd, $af_default);
650 if (defined $uid and !chown($uid, $gid, $path)) {
651 warn "could not chown $path: $!\n";
657 Net::Server::Daemonize::create_pid_file($path);