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::Listener;
20 require PublicInbox::ParentPipe;
21 require PublicInbox::Sigfd;
23 my ($set_user, $oldset, $newset);
24 my (@cfg_listen, $stdout, $stderr, $group, $user, $pid_file, $daemonize);
25 my $worker_processes = 1;
28 my %listener_names; # sockname => IO::Handle
29 my %tls_opt; # scheme://sockname => args for IO::Socket::SSL->start_SSL
33 my ($default_cert, $default_key);
34 END { $cleanup->() if $cleanup };
35 my %KNOWN_TLS = ( 443 => 'https', 563 => 'nntps' );
36 my %KNOWN_STARTTLS = ( 119 => 'nntp' );
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 };
78 sub sig_setmask { sigprocmask(SIG_SETMASK, @_) or die "sigprocmask: $!" }
80 sub daemon_prepare ($) {
81 my ($default_listen) = @_;
82 $oldset = POSIX::SigSet->new();
83 $newset = POSIX::SigSet->new();
84 $newset->fillset or die "fillset: $!";
85 sig_setmask($newset, $oldset);
88 'l|listen=s' => \@cfg_listen,
89 '1|stdout=s' => \$stdout,
90 '2|stderr=s' => \$stderr,
91 'W|worker-processes=i' => \$worker_processes,
92 'P|pid-file=s' => \$pid_file,
94 'g|group=s' => \$group,
95 'D|daemonize' => \$daemonize,
96 'cert=s' => \$default_cert,
97 'key=s' => \$default_key,
99 GetOptions(%opts) or die "bad command-line args\n";
101 if (defined $pid_file && $pid_file =~ /\.oldbin\z/) {
102 die "--pid-file cannot end with '.oldbin'\n";
104 @listeners = inherit();
106 # allow socket-activation users to set certs once and not
107 # have to configure each socket:
108 my @inherited_names = keys(%listener_names) if defined($default_cert);
110 # ignore daemonize when inheriting
111 $daemonize = undef if scalar @listeners;
113 push @cfg_listen, $default_listen unless (@listeners || @cfg_listen);
115 foreach my $l (@cfg_listen) {
118 if ($l =~ s!\A([^:]+)://!!) {
120 } elsif ($l =~ /\A(?:\[[^\]]+\]|[^:]+):([0-9])+/) {
121 my $s = $KNOWN_TLS{$1} // $KNOWN_STARTTLS{$1};
122 $scheme = $s if defined $s;
124 if ($l =~ s!/?\?(.+)\z!!) {
125 $tls_opt{"$scheme://$l"} = accept_tls_opt($1);
126 } elsif (defined($default_cert)) {
127 $tls_opt{"$scheme://$l"} = accept_tls_opt('');
128 } elsif ($scheme =~ /\A(?:nntps|https)\z/) {
129 die "$orig specified w/o cert=\n";
131 # TODO: use scheme to load either NNTP.pm or HTTP.pm
133 next if $listener_names{$l}; # already inherited
135 if (index($l, '/') == 0) {
136 $sock_pkg = 'IO::Socket::UNIX';
137 eval "use $sock_pkg";
139 %o = (Type => SOCK_STREAM, Peer => $l);
141 my $c = $sock_pkg->new(%o);
142 if (!defined($c) && $!{ECONNREFUSED}) {
144 "failed to unlink stale socket=$l: $!\n";
145 } # else: let the bind fail
147 $o{Local} = delete $o{Peer};
149 # both work for IPv4, too
150 for (qw(IO::Socket::IP IO::Socket::INET6)) {
152 eval "use $sock_pkg";
156 %o = (LocalAddr => $l, ReuseAddr => 1, Proto => 'tcp');
159 my $prev = umask 0000;
160 my $s = eval { $sock_pkg->new(%o) };
161 warn "error binding $l: $! ($@)\n" unless $s;
164 $listener_names{sockname($s)} = $s;
170 # cert/key options in @cfg_listen takes precedence when inheriting,
171 # but map well-known inherited ports if --listen isn't specified
173 for my $sockname (@inherited_names) {
174 $sockname =~ /:([0-9]+)\z/ or next;
175 if (my $scheme = $KNOWN_TLS{$1}) {
176 $tls_opt{"$scheme://$sockname"} ||= accept_tls_opt('');
177 } elsif (($scheme = $KNOWN_STARTTLS{$1})) {
178 next if $tls_opt{"$scheme://$sockname"};
179 $tls_opt{''} ||= accept_tls_opt('');
183 die "No listeners bound\n" unless @listeners;
186 sub check_absolute ($$) {
187 my ($var, $val) = @_;
188 if (defined $val && index($val, '/') != 0) {
190 "--$var must be an absolute path when using --daemonize: $val\n";
196 foreach my $i (0..$#ARGV) {
199 $ARGV[$i] = abs_path($arg);
201 check_absolute('stdout', $stdout);
202 check_absolute('stderr', $stderr);
203 check_absolute('pid-file', $pid_file);
205 chdir '/' or die "chdir failed: $!";
208 return unless (defined $pid_file || defined $group || defined $user
211 eval { require Net::Server::Daemonize };
214 "Net::Server required for --pid-file, --group, --user, and --daemonize\n$@\n";
217 Net::Server::Daemonize::check_pid_file($pid_file) if defined $pid_file;
218 $uid = Net::Server::Daemonize::get_uid($user) if defined $user;
219 if (defined $group) {
220 $gid = Net::Server::Daemonize::get_gid($group);
221 $gid = (split /\s+/, $gid)[0];
222 } elsif (defined $uid) {
223 $gid = (getpwuid($uid))[3];
226 # We change users in the worker to ensure upgradability,
227 # The upgrade will create the ".oldbin" pid file in the
228 # same directory as the given pid file.
229 $uid and $set_user = sub {
231 Net::Server::Daemonize::set_user($uid, $gid);
236 die "could not fork: $!\n" unless defined $pid;
239 open(STDIN, '+<', '/dev/null') or
240 die "redirect stdin failed: $!\n";
241 open STDOUT, '>&STDIN' or die "redirect stdout failed: $!\n";
242 open STDERR, '>&STDIN' or die "redirect stderr failed: $!\n";
245 die "could not fork: $!\n" unless defined $pid;
248 if (defined $pid_file) {
249 write_pid($pid_file);
252 $cleanup = undef; # avoid cyclic reference
253 unlink_pid_file_safe_ish($unlink_pid, $pid_file);
258 sub worker_quit { # $_[0] = signal name or number (unused)
259 # killing again terminates immediately:
260 exit unless @listeners;
262 $_->close foreach @listeners; # call PublicInbox::DS::close
266 # drop idle connections and try to quit gracefully
267 PublicInbox::DS->SetPostLoopCallback(sub {
268 my ($dmap, undef) = @_;
272 foreach my $s (values %$dmap) {
273 $s->can('busy') or next;
274 if ($s->busy($now)) {
277 # close as much as possible, early as possible
282 if (($warn + 5) < now()) {
283 warn "$$ quitting, $n client(s) left\n";
286 unless (defined $proc_name) {
287 $proc_name = (split(/\s+/, $0))[0];
288 $proc_name =~ s!\A.*?([^/]+)\z!$1!;
290 $0 = "$proc_name quitting, $n client(s) left";
292 $n; # true: loop continues, false: loop breaks
298 open STDOUT, '>>', $stdout or
299 warn "failed to redirect stdout to $stdout: $!\n";
300 STDOUT->autoflush(1);
304 open STDERR, '>>', $stderr or
305 warn "failed to redirect stderr to $stderr: $!\n";
306 STDERR->autoflush(1);
313 my $addr = getsockname($s) or return;
314 my ($host, $port) = host_with_port($addr);
315 if ($port == 0 && $host eq '127.0.0.1') {
316 my ($path) = Socket::sockaddr_un($addr);
322 sub unpack_ipv6 ($) {
326 # Socket.pm in Perl 5.14+ supports IPv6:
328 ($port, $host) = Socket::unpack_sockaddr_in6($addr);
329 $host = Socket::inet_ntop(Socket::AF_INET6(), $host);
333 # Perl 5.12 or earlier? SpamAssassin and Net::Server use
334 # Socket6, so it may be installed on our system, already
335 # (otherwise die here):
338 ($port, $host) = Socket6::unpack_sockaddr_in6($addr);
339 $host = Socket6::inet_ntop(Socket6::AF_INET6(), $host);
344 sub host_with_port ($) {
348 # this eval will die on Unix sockets:
350 if (length($addr) >= 28) {
351 ($host, $port) = unpack_ipv6($addr);
354 ($port, $host) = Socket::sockaddr_in($addr);
355 $host = Socket::inet_ntoa($host);
358 $@ ? ('127.0.0.1', 0) : ($host, $port);
362 return () if ($ENV{LISTEN_PID} || 0) != $$;
363 my $fds = $ENV{LISTEN_FDS} or return ();
364 my $end = $fds + 2; # LISTEN_FDS_START - 1
366 foreach my $fd (3..$end) {
367 my $s = IO::Handle->new_from_fd($fd, 'r');
368 if (my $k = sockname($s)) {
372 Inherited socket (fd=$fd) is blocking, making it non-blocking.
373 Set 'NonBlocking = true' in the systemd.service unit to avoid stalled
374 processes when multiple service instances start.
377 $listener_names{$k} = $s;
380 warn "failed to inherit fd=$fd (LISTEN_FDS=$fds)";
386 sub upgrade { # $_[0] = signal name or number (unused)
388 warn "upgrade in-progress: $reexec_pid\n";
391 if (defined $pid_file) {
392 if ($pid_file =~ /\.oldbin\z/) {
393 warn "BUG: .oldbin suffix exists: $pid_file\n";
396 unlink_pid_file_safe_ish($$, $pid_file);
397 $pid_file .= '.oldbin';
398 write_pid($pid_file);
401 unless (defined $pid) {
402 warn "fork failed: $!\n";
406 use Fcntl qw(FD_CLOEXEC F_SETFD F_GETFD);
407 $ENV{LISTEN_FDS} = scalar @listeners;
408 $ENV{LISTEN_PID} = $$;
409 foreach my $s (@listeners) {
410 my $fl = fcntl($s, F_GETFD, 0);
411 fcntl($s, F_SETFD, $fl &= ~FD_CLOEXEC);
414 die "Failed to exec: $!\n";
419 sub kill_workers ($) {
422 while (my ($pid, $id) = each %pids) {
427 sub upgrade_aborted ($) {
429 warn "reexec PID($p) died with: $?\n";
431 return unless $pid_file;
433 my $file = $pid_file;
434 $file =~ s/\.oldbin\z// or die "BUG: no '.oldbin' suffix in $file";
435 unlink_pid_file_safe_ish($$, $pid_file);
437 eval { write_pid($pid_file) };
441 sub reap_children { # $_[0] = 'CHLD' or POSIX::SIGCHLD()
443 my $p = waitpid(-1, WNOHANG) or return;
444 if (defined $reexec_pid && $p == $reexec_pid) {
446 } elsif (defined(my $id = delete $pids{$p})) {
447 warn "worker[$id] PID($p) died with: $?\n";
449 warn "unknown PID($p) reaped: $?\n";
456 sub unlink_pid_file_safe_ish ($$) {
457 my ($unlink_pid, $file) = @_;
458 return unless defined $unlink_pid && $unlink_pid == $$;
460 open my $fh, '<', $file or return;
462 defined(my $read_pid = <$fh>) or return;
464 if ($read_pid == $unlink_pid) {
465 Net::Server::Daemonize::unlink_pid_file($file);
470 pipe(my ($p0, $p1)) or die "failed to create parent-pipe: $!";
471 # 1031: F_SETPIPE_SZ, 4096: page size
472 fcntl($p1, 1031, 4096) if $^O eq 'linux';
473 my $set_workers = $worker_processes;
477 my $quit_cb = sub { exit if $quit++; kill_workers($_[0]) };
479 USR1 => sub { reopen_logs(); kill_workers($_[0]); },
485 return if $ignore_winch;
486 if (-t STDIN || -t STDOUT || -t STDERR) {
489 ignoring SIGWINCH since we are not daemonized
492 $worker_processes = 0;
496 $worker_processes = $set_workers;
500 if ($set_workers > $worker_processes) {
503 $worker_processes = ++$set_workers;
507 $worker_processes = --$set_workers if $set_workers > 0;
509 CHLD => \&reap_children,
511 my $sigfd = PublicInbox::Sigfd->new($sig, 0);
512 local %SIG = (%SIG, %$sig) if !$sigfd;
513 sig_setmask($oldset) if !$sigfd;
514 while (1) { # main loop
515 my $n = scalar keys %pids;
518 $set_workers = $worker_processes = $n = 0;
521 if ($n > $worker_processes) {
522 while (my ($k, $v) = each %pids) {
523 kill('TERM', $k) if $v >= $worker_processes;
525 $n = $worker_processes;
527 my $want = $worker_processes - 1;
529 sig_setmask($newset) if !$sigfd;
530 for my $i ($n..$want) {
533 warn "failed to fork worker[$i]: $!\n";
534 } elsif ($pid == 0) {
535 $set_user->() if $set_user;
536 return $p0; # run normal work code
538 warn "PID=$pid is worker[$i]\n";
542 sig_setmask($oldset) if !$sigfd;
545 if ($sigfd) { # Linux and IO::KQueue users:
547 } else { # wake up every second
551 exit # never gets here, just for documentation
554 sub tls_start_cb ($$) {
555 my ($opt, $orig_post_accept) = @_;
557 my ($io, $addr, $srv) = @_;
558 my $ssl = IO::Socket::SSL->start_SSL($io, %$opt);
559 $orig_post_accept->($ssl, $addr, $srv);
563 sub defer_accept ($$) {
564 my ($s, $af_name) = @_;
565 return unless defined $af_name;
566 if ($^O eq 'linux') {
567 my $x = getsockopt($s, IPPROTO_TCP, Socket::TCP_DEFER_ACCEPT());
568 return unless defined $x; # may be Unix socket
569 my $sec = unpack('i', $x);
570 return if $sec > 0; # systemd users may set a higher value
571 setsockopt($s, IPPROTO_TCP, Socket::TCP_DEFER_ACCEPT(), 1);
572 } elsif ($^O eq 'freebsd') {
573 my $x = getsockopt($s, SOL_SOCKET, SO_ACCEPTFILTER);
574 return if defined $x; # don't change if set
575 my $accf_arg = pack('a16a240', $af_name, '');
576 setsockopt($s, SOL_SOCKET, SO_ACCEPTFILTER, $accf_arg);
580 sub daemon_loop ($$$$) {
581 my ($refresh, $post_accept, $nntpd, $af_default) = @_;
583 while (my ($k, $v) = each %tls_opt) {
584 if ($k =~ s!\A(?:nntps|https)://!!) {
585 $post_accept{$k} = tls_start_cb($v, $post_accept);
586 } elsif ($nntpd) { # STARTTLS, $k eq '' is OK
587 $nntpd->{accept_tls} = $v;
592 INT => \&worker_quit,
593 QUIT => \&worker_quit,
594 TERM => \&worker_quit,
597 USR1 => \&reopen_logs,
600 CHLD => \&PublicInbox::DS::enqueue_reap,
603 if ($worker_processes > 0) {
604 $refresh->(); # preload by default
605 my $fh = master_loop(); # returns if in child process
606 $parent_pipe = PublicInbox::ParentPipe->new($fh, *worker_quit);
609 $set_user->() if $set_user;
610 $sig->{USR2} = sub { worker_quit() if upgrade() };
616 my $tls_cb = $post_accept{sockname($_)};
618 # NNTPS, HTTPS, HTTP, and POP3S are client-first traffic
619 # NNTP and POP3 are server-first
620 defer_accept($_, $tls_cb ? 'dataready' : $af_default);
622 # this calls epoll_create:
623 PublicInbox::Listener->new($_, $tls_cb || $post_accept)
625 my $sigfd = PublicInbox::Sigfd->new($sig, SFD_NONBLOCK);
626 local %SIG = (%SIG, %$sig) if !$sigfd;
628 # wake up every second to accept signals if we don't
629 # have signalfd or IO::KQueue:
630 sig_setmask($oldset);
631 PublicInbox::DS->SetLoopTimeout(1000);
633 PublicInbox::DS->EventLoop;
634 $parent_pipe = undef;
639 my ($default, $refresh, $post_accept, $nntpd) = @_;
640 daemon_prepare($default);
641 my $af_default = $default =~ /:8080\z/ ? 'httpready' : undef;
643 daemon_loop($refresh, $post_accept, $nntpd, $af_default);
648 if (defined $uid and !chown($uid, $gid, $path)) {
649 warn "could not chown $path: $!\n";
655 Net::Server::Daemonize::create_pid_file($path);