X-Git-Url: http://www.git.stargrave.org/?p=public-inbox.git;a=blobdiff_plain;f=lib%2FPublicInbox%2FDaemon.pm;h=292bc339a73c086f06c4a34bc47f63e3e962b4ed;hp=0329bd34ed3292ea93b7db3a737bded43119bf43;hb=55b707d788ce13696e4411389583e720ea6dab01;hpb=3d41aa23f35501ca92aab8aa42980fa73f7fa74f diff --git a/lib/PublicInbox/Daemon.pm b/lib/PublicInbox/Daemon.pm index 0329bd34..292bc339 100644 --- a/lib/PublicInbox/Daemon.pm +++ b/lib/PublicInbox/Daemon.pm @@ -1,4 +1,4 @@ -# Copyright (C) 2015-2018 all contributors +# Copyright (C) 2015-2019 all contributors # License: AGPL-3.0+ # contains common daemon code for the nntpd and httpd servers. # This may be used for read-only IMAP server if we decide to implement it. @@ -6,33 +6,82 @@ package PublicInbox::Daemon; use strict; use warnings; use Getopt::Long qw/:config gnu_getopt no_ignore_case auto_abbrev/; -use IO::Handle; +use IO::Handle; # ->autoflush use IO::Socket; +use POSIX qw(WNOHANG :signal_h); +use Socket qw(IPPROTO_TCP SOL_SOCKET); +sub SO_ACCEPTFILTER () { 0x1000 } use Cwd qw/abs_path/; -use Time::HiRes qw(clock_gettime CLOCK_MONOTONIC); STDOUT->autoflush(1); STDERR->autoflush(1); -require Danga::Socket; -require POSIX; +use PublicInbox::DS qw(now); +use PublicInbox::Syscall qw(SFD_NONBLOCK); require PublicInbox::Listener; require PublicInbox::ParentPipe; +require PublicInbox::Sigfd; my @CMD; -my $set_user; +my ($set_user, $oldset, $newset); my (@cfg_listen, $stdout, $stderr, $group, $user, $pid_file, $daemonize); my $worker_processes = 1; my @listeners; my %pids; -my %listener_names; +my %tls_opt; # scheme://sockname => args for IO::Socket::SSL->start_SSL my $reexec_pid; -my $cleanup; my ($uid, $gid); -END { $cleanup->() if $cleanup }; +my ($default_cert, $default_key); +my %KNOWN_TLS = ( 443 => 'https', 563 => 'nntps' ); +my %KNOWN_STARTTLS = ( 119 => 'nntp' ); + +sub accept_tls_opt ($) { + my ($opt_str) = @_; + # opt_str: opt1=val1,opt2=val2 (opt may repeat for multi-value) + require PublicInbox::TLS; + my $o = {}; + # allow ',' as delimiter since '&' is shell-unfriendly + foreach (split(/[,&]/, $opt_str)) { + my ($k, $v) = split(/=/, $_, 2); + push @{$o->{$k} ||= []}, $v; + } + + # key may be a part of cert. At least + # p5-io-socket-ssl/example/ssl_server.pl has this fallback: + $o->{cert} //= [ $default_cert ]; + $o->{key} //= defined($default_key) ? [ $default_key ] : $o->{cert}; + my %ctx_opt = (SSL_server => 1); + # parse out hostname:/path/to/ mappings: + foreach my $k (qw(cert key)) { + my $x = $ctx_opt{'SSL_'.$k.'_file'} = {}; + foreach my $path (@{$o->{$k}}) { + my $host = ''; + $path =~ s/\A([^:]+):// and $host = $1; + $x->{$host} = $path; + } + } + my $ctx = IO::Socket::SSL::SSL_Context->new(%ctx_opt) or + die 'SSL_Context->new: '.PublicInbox::TLS::err(); + + # save ~34K per idle connection (cf. SSL_CTX_set_mode(3ssl)) + # RSS goes from 346MB to 171MB with 10K idle NNTPS clients on amd64 + # cf. https://rt.cpan.org/Ticket/Display.html?id=129463 + my $mode = eval { Net::SSLeay::MODE_RELEASE_BUFFERS() }; + if ($mode && $ctx->{context}) { + eval { Net::SSLeay::CTX_set_mode($ctx->{context}, $mode) }; + warn "W: $@ (setting SSL_MODE_RELEASE_BUFFERS)\n" if $@; + } + + { SSL_server => 1, SSL_startHandshake => 0, SSL_reuse_ctx => $ctx }; +} + +sub sig_setmask { sigprocmask(SIG_SETMASK, @_) or die "sigprocmask: $!" } sub daemon_prepare ($) { my ($default_listen) = @_; + my $listener_names = {}; # sockname => IO::Handle + $oldset = POSIX::SigSet->new(); + $newset = POSIX::SigSet->new(); + $newset->fillset or die "fillset: $!"; + sig_setmask($newset, $oldset); @CMD = ($0, @ARGV); - $SIG{HUP} = $SIG{USR1} = $SIG{USR2} = $SIG{PIPE} = - $SIG{TTIN} = $SIG{TTOU} = $SIG{WINCH} = 'IGNORE'; my %opts = ( 'l|listen=s' => \@cfg_listen, '1|stdout=s' => \$stdout, @@ -42,20 +91,44 @@ sub daemon_prepare ($) { 'u|user=s' => \$user, 'g|group=s' => \$group, 'D|daemonize' => \$daemonize, + 'cert=s' => \$default_cert, + 'key=s' => \$default_key, ); GetOptions(%opts) or die "bad command-line args\n"; if (defined $pid_file && $pid_file =~ /\.oldbin\z/) { die "--pid-file cannot end with '.oldbin'\n"; } - @listeners = inherit(); + @listeners = inherit($listener_names); + + # allow socket-activation users to set certs once and not + # have to configure each socket: + my @inherited_names = keys(%$listener_names) if defined($default_cert); + # ignore daemonize when inheriting $daemonize = undef if scalar @listeners; push @cfg_listen, $default_listen unless (@listeners || @cfg_listen); foreach my $l (@cfg_listen) { - next if $listener_names{$l}; # already inherited + my $orig = $l; + my $scheme = ''; + if ($l =~ s!\A([^:]+)://!!) { + $scheme = $1; + } elsif ($l =~ /\A(?:\[[^\]]+\]|[^:]+):([0-9])+/) { + my $s = $KNOWN_TLS{$1} // $KNOWN_STARTTLS{$1}; + $scheme = $s if defined $s; + } + if ($l =~ s!/?\?(.+)\z!!) { + $tls_opt{"$scheme://$l"} = accept_tls_opt($1); + } elsif (defined($default_cert)) { + $tls_opt{"$scheme://$l"} = accept_tls_opt(''); + } elsif ($scheme =~ /\A(?:nntps|https)\z/) { + die "$orig specified w/o cert=\n"; + } + # TODO: use scheme to load either NNTP.pm or HTTP.pm + + next if $listener_names->{$l}; # already inherited my (%o, $sock_pkg); if (index($l, '/') == 0) { $sock_pkg = 'IO::Socket::UNIX'; @@ -85,12 +158,26 @@ sub daemon_prepare ($) { my $s = eval { $sock_pkg->new(%o) }; warn "error binding $l: $! ($@)\n" unless $s; umask $prev; - if ($s) { - $listener_names{sockname($s)} = $s; + $listener_names->{sockname($s)} = $s; + $s->blocking(0); push @listeners, $s; } } + + # cert/key options in @cfg_listen takes precedence when inheriting, + # but map well-known inherited ports if --listen isn't specified + # at all + for my $sockname (@inherited_names) { + $sockname =~ /:([0-9]+)\z/ or next; + if (my $scheme = $KNOWN_TLS{$1}) { + $tls_opt{"$scheme://$sockname"} ||= accept_tls_opt(''); + } elsif (($scheme = $KNOWN_STARTTLS{$1})) { + next if $tls_opt{"$scheme://$sockname"}; + $tls_opt{''} ||= accept_tls_opt(''); + } + } + die "No listeners bound\n" unless @listeners; } @@ -156,33 +243,26 @@ sub daemonize () { die "could not fork: $!\n" unless defined $pid; exit if $pid; } - if (defined $pid_file) { - write_pid($pid_file); - my $unlink_pid = $$; - $cleanup = sub { - $cleanup = undef; # avoid cyclic reference - unlink_pid_file_safe_ish($unlink_pid, $pid_file); - }; - } -} + return unless defined $pid_file; + write_pid($pid_file); + # for ->DESTROY: + bless { pid => $$, pid_file => $pid_file }, __PACKAGE__; +} -sub worker_quit { - my ($reason) = @_; +sub worker_quit { # $_[0] = signal name or number (unused) # killing again terminates immediately: exit unless @listeners; - $_->close foreach @listeners; # call Danga::Socket::close + $_->close foreach @listeners; # call PublicInbox::DS::close @listeners = (); - $reason->close if ref($reason) eq 'PublicInbox::ParentPipe'; - my $proc_name; my $warn = 0; # drop idle connections and try to quit gracefully - Danga::Socket->SetPostLoopCallback(sub { + PublicInbox::DS->SetPostLoopCallback(sub { my ($dmap, undef) = @_; my $n = 0; - my $now = clock_gettime(CLOCK_MONOTONIC); + my $now = now(); foreach my $s (values %$dmap) { $s->can('busy') or next; @@ -194,9 +274,9 @@ sub worker_quit { } } if ($n) { - if (($warn + 5) < time) { + if (($warn + 5) < now()) { warn "$$ quitting, $n client(s) left\n"; - $warn = time; + $warn = now(); } unless (defined $proc_name) { $proc_name = (split(/\s+/, $0))[0]; @@ -234,6 +314,28 @@ sub sockname ($) { "$host:$port"; } +sub unpack_ipv6 ($) { + my ($addr) = @_; + my ($port, $host); + + # Socket.pm in Perl 5.14+ supports IPv6: + eval { + ($port, $host) = Socket::unpack_sockaddr_in6($addr); + $host = Socket::inet_ntop(Socket::AF_INET6(), $host); + }; + + if ($@) { + # Perl 5.12 or earlier? SpamAssassin and Net::Server use + # Socket6, so it may be installed on our system, already + # (otherwise die here): + require Socket6; + + ($port, $host) = Socket6::unpack_sockaddr_in6($addr); + $host = Socket6::inet_ntop(Socket6::AF_INET6(), $host); + } + ($host, $port); +} + sub host_with_port ($) { my ($addr) = @_; my ($port, $host); @@ -241,9 +343,7 @@ sub host_with_port ($) { # this eval will die on Unix sockets: eval { if (length($addr) >= 28) { - require Socket6; - ($port, $host) = Socket6::unpack_sockaddr_in6($addr); - $host = Socket6::inet_ntop(Socket6::AF_INET6(), $host); + ($host, $port) = unpack_ipv6($addr); $host = "[$host]"; } else { ($port, $host) = Socket::sockaddr_in($addr); @@ -253,7 +353,8 @@ sub host_with_port ($) { $@ ? ('127.0.0.1', 0) : ($host, $port); } -sub inherit () { +sub inherit ($) { + my ($listener_names) = @_; return () if ($ENV{LISTEN_PID} || 0) != $$; my $fds = $ENV{LISTEN_FDS} or return (); my $end = $fds + 2; # LISTEN_FDS_START - 1 @@ -261,7 +362,15 @@ sub inherit () { foreach my $fd (3..$end) { my $s = IO::Handle->new_from_fd($fd, 'r'); if (my $k = sockname($s)) { - $listener_names{$k} = $s; + if ($s->blocking) { + $s->blocking(0); + warn <<""; +Inherited socket (fd=$fd) is blocking, making it non-blocking. +Set 'NonBlocking = true' in the systemd.service unit to avoid stalled +processes when multiple service instances start. + + } + $listener_names->{$k} = $s; push @rv, $s; } else { warn "failed to inherit fd=$fd (LISTEN_FDS=$fds)"; @@ -270,7 +379,7 @@ sub inherit () { @rv } -sub upgrade () { +sub upgrade { # $_[0] = signal name or number (unused) if ($reexec_pid) { warn "upgrade in-progress: $reexec_pid\n"; return; @@ -325,9 +434,9 @@ sub upgrade_aborted ($) { warn $@, "\n" if $@; } -sub reap_children () { +sub reap_children { # $_[0] = 'CHLD' or POSIX::SIGCHLD() while (1) { - my $p = waitpid(-1, &POSIX::WNOHANG) or return; + my $p = waitpid(-1, WNOHANG) or return; if (defined $reexec_pid && $p == $reexec_pid) { upgrade_aborted($p); } elsif (defined(my $id = delete $pids{$p})) { @@ -353,61 +462,60 @@ sub unlink_pid_file_safe_ish ($$) { } } +sub master_quit ($) { + exit unless @listeners; + @listeners = (); + kill_workers($_[0]); +} + sub master_loop { pipe(my ($p0, $p1)) or die "failed to create parent-pipe: $!"; - pipe(my ($r, $w)) or die "failed to create self-pipe: $!"; - IO::Handle::blocking($w, 0); + # 1031: F_SETPIPE_SZ, 4096: page size + fcntl($p1, 1031, 4096) if $^O eq 'linux'; my $set_workers = $worker_processes; - my @caught; - my $master_pid = $$; - foreach my $s (qw(HUP CHLD QUIT INT TERM USR1 USR2 TTIN TTOU WINCH)) { - $SIG{$s} = sub { - return if $$ != $master_pid; - push @caught, $s; - syswrite($w, '.'); - }; - } reopen_logs(); - # main loop - my $quit = 0; - while (1) { - while (my $s = shift @caught) { - if ($s eq 'USR1') { - reopen_logs(); - kill_workers($s); - } elsif ($s eq 'USR2') { - upgrade(); - } elsif ($s =~ /\A(?:QUIT|TERM|INT)\z/) { - exit if $quit++; - kill_workers($s); - } elsif ($s eq 'WINCH') { - if (-t STDIN || -t STDOUT || -t STDERR) { - warn -"ignoring SIGWINCH since we are not daemonized\n"; - $SIG{WINCH} = 'IGNORE'; - } else { - $worker_processes = 0; - } - } elsif ($s eq 'HUP') { - $worker_processes = $set_workers; - kill_workers($s); - } elsif ($s eq 'TTIN') { - if ($set_workers > $worker_processes) { - ++$worker_processes; - } else { - $worker_processes = ++$set_workers; - } - } elsif ($s eq 'TTOU') { - if ($set_workers > 0) { - $worker_processes = --$set_workers; - } - } elsif ($s eq 'CHLD') { - reap_children(); + my $ignore_winch; + my $sig = { + USR1 => sub { reopen_logs(); kill_workers($_[0]); }, + USR2 => \&upgrade, + QUIT => \&master_quit, + INT => \&master_quit, + TERM => \&master_quit, + WINCH => sub { + return if $ignore_winch || !@listeners; + if (-t STDIN || -t STDOUT || -t STDERR) { + $ignore_winch = 1; + warn < sub { + return unless @listeners; + $worker_processes = $set_workers; + kill_workers($_[0]); + }, + TTIN => sub { + return unless @listeners; + if ($set_workers > $worker_processes) { + ++$worker_processes; + } else { + $worker_processes = ++$set_workers; + } + }, + TTOU => sub { + $worker_processes = --$set_workers if $set_workers > 0; + }, + CHLD => \&reap_children, + }; + my $sigfd = PublicInbox::Sigfd->new($sig, 0); + local %SIG = (%SIG, %$sig) if !$sigfd; + sig_setmask($oldset) if !$sigfd; + while (1) { # main loop my $n = scalar keys %pids; - if ($quit) { + unless (@listeners) { exit if $n == 0; $set_workers = $worker_processes = $n = 0; } @@ -418,26 +526,81 @@ sub master_loop { } $n = $worker_processes; } - foreach my $i ($n..($worker_processes - 1)) { - my $pid = fork; - if (!defined $pid) { - warn "failed to fork worker[$i]: $!\n"; - } elsif ($pid == 0) { - $set_user->() if $set_user; - return $p0; # run normal work code - } else { - warn "PID=$pid is worker[$i]\n"; - $pids{$pid} = $i; + my $want = $worker_processes - 1; + if ($n <= $want) { + sig_setmask($newset) if !$sigfd; + for my $i ($n..$want) { + my $pid = fork; + if (!defined $pid) { + warn "failed to fork worker[$i]: $!\n"; + } elsif ($pid == 0) { + $set_user->() if $set_user; + return $p0; # run normal work code + } else { + warn "PID=$pid is worker[$i]\n"; + $pids{$pid} = $i; + } } + sig_setmask($oldset) if !$sigfd; + } + + if ($sigfd) { # Linux and IO::KQueue users: + $sigfd->wait_once; + } else { # wake up every second + sleep(1); } - # just wait on signal events here: - sysread($r, my $buf, 8); } exit # never gets here, just for documentation } -sub daemon_loop ($$) { - my ($refresh, $post_accept) = @_; +sub tls_start_cb ($$) { + my ($opt, $orig_post_accept) = @_; + sub { + my ($io, $addr, $srv) = @_; + my $ssl = IO::Socket::SSL->start_SSL($io, %$opt); + $orig_post_accept->($ssl, $addr, $srv); + } +} + +sub defer_accept ($$) { + my ($s, $af_name) = @_; + return unless defined $af_name; + if ($^O eq 'linux') { + my $x = getsockopt($s, IPPROTO_TCP, Socket::TCP_DEFER_ACCEPT()); + return unless defined $x; # may be Unix socket + my $sec = unpack('i', $x); + return if $sec > 0; # systemd users may set a higher value + setsockopt($s, IPPROTO_TCP, Socket::TCP_DEFER_ACCEPT(), 1); + } elsif ($^O eq 'freebsd') { + my $x = getsockopt($s, SOL_SOCKET, SO_ACCEPTFILTER); + return if defined $x; # don't change if set + my $accf_arg = pack('a16a240', $af_name, ''); + setsockopt($s, SOL_SOCKET, SO_ACCEPTFILTER, $accf_arg); + } +} + +sub daemon_loop ($$$$) { + my ($refresh, $post_accept, $nntpd, $af_default) = @_; + my %post_accept; + while (my ($k, $v) = each %tls_opt) { + if ($k =~ s!\A(?:nntps|https)://!!) { + $post_accept{$k} = tls_start_cb($v, $post_accept); + } elsif ($nntpd) { # STARTTLS, $k eq '' is OK + $nntpd->{accept_tls} = $v; + } + } + my $sig = { + HUP => $refresh, + INT => \&worker_quit, + QUIT => \&worker_quit, + TERM => \&worker_quit, + TTIN => 'IGNORE', + TTOU => 'IGNORE', + USR1 => \&reopen_logs, + USR2 => 'IGNORE', + WINCH => 'IGNORE', + CHLD => \&PublicInbox::DS::enqueue_reap, + }; my $parent_pipe; if ($worker_processes > 0) { $refresh->(); # preload by default @@ -446,30 +609,40 @@ sub daemon_loop ($$) { } else { reopen_logs(); $set_user->() if $set_user; - $SIG{USR2} = sub { worker_quit('USR2') if upgrade() }; + $sig->{USR2} = sub { worker_quit() if upgrade() }; $refresh->(); } $uid = $gid = undef; reopen_logs(); - $SIG{QUIT} = $SIG{INT} = $SIG{TERM} = *worker_quit; - $SIG{USR1} = *reopen_logs; - $SIG{HUP} = $refresh; - $SIG{CHLD} = 'DEFAULT'; - $SIG{$_} = 'IGNORE' for qw(USR2 TTIN TTOU WINCH); - # this calls epoll_create: - @listeners = map { - PublicInbox::Listener->new($_, $post_accept) + @listeners = map {; + my $tls_cb = $post_accept{sockname($_)}; + + # NNTPS, HTTPS, HTTP, and POP3S are client-first traffic + # NNTP and POP3 are server-first + defer_accept($_, $tls_cb ? 'dataready' : $af_default); + + # this calls epoll_create: + PublicInbox::Listener->new($_, $tls_cb || $post_accept) } @listeners; - Danga::Socket->EventLoop; - $parent_pipe = undef; + my $sigfd = PublicInbox::Sigfd->new($sig, SFD_NONBLOCK); + local %SIG = (%SIG, %$sig) if !$sigfd; + if (!$sigfd) { + # wake up every second to accept signals if we don't + # have signalfd or IO::KQueue: + sig_setmask($oldset); + PublicInbox::DS->SetLoopTimeout(1000); + } + PublicInbox::DS->EventLoop; } - -sub run ($$$) { - my ($default, $refresh, $post_accept) = @_; +sub run ($$$;$) { + my ($default, $refresh, $post_accept, $nntpd) = @_; daemon_prepare($default); - daemonize(); - daemon_loop($refresh, $post_accept); + my $af_default = $default =~ /:8080\z/ ? 'httpready' : undef; + my $for_destroy = daemonize(); + daemon_loop($refresh, $post_accept, $nntpd, $af_default); + PublicInbox::DS->Reset; + # ->DESTROY runs when $for_destroy goes out-of-scope } sub do_chown ($) { @@ -485,4 +658,8 @@ sub write_pid ($) { do_chown($path); } +sub DESTROY { + unlink_pid_file_safe_ish($_[0]->{pid}, $_[0]->{pid_file}); +} + 1;