X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=lib%2FPublicInbox%2FDaemon.pm;h=bceae6e5699f5d13412f7cdc4e544074b58fd1d7;hb=23af251dd607c4e75ab1e68063f2c885c48cc035;hp=90f111370e9a23b1a740adc7e486add82d977f44;hpb=34a51e5736d7d1b7d2da7f7640eb2b87eec121ff;p=public-inbox.git diff --git a/lib/PublicInbox/Daemon.pm b/lib/PublicInbox/Daemon.pm index 90f11137..bceae6e5 100644 --- a/lib/PublicInbox/Daemon.pm +++ b/lib/PublicInbox/Daemon.pm @@ -1,38 +1,39 @@ -# Copyright (C) 2015-2019 all contributors +# Copyright (C) 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. +# +# Contains common daemon code for the httpd, imapd, and nntpd servers +# and designed for handling thousands of untrusted clients over slow +# and/or lossy connections. package PublicInbox::Daemon; use strict; -use warnings; -use Getopt::Long qw/:config gnu_getopt no_ignore_case auto_abbrev/; -use IO::Handle; +use v5.10.1; +use Getopt::Long qw(:config gnu_getopt no_ignore_case auto_abbrev); +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/; STDOUT->autoflush(1); STDERR->autoflush(1); use PublicInbox::DS qw(now); -require PublicInbox::EvCleanup; -require PublicInbox::Listener; -require PublicInbox::ParentPipe; +use PublicInbox::Listener; +use PublicInbox::EOFpipe; +use PublicInbox::Sigfd; +use PublicInbox::Git; +use PublicInbox::GitAsyncCat; +use PublicInbox::Eml; +our $SO_ACCEPTFILTER = 0x1000; my @CMD; -my ($set_user, $oldset, $newset); +my ($set_user, $oldset); my (@cfg_listen, $stdout, $stderr, $group, $user, $pid_file, $daemonize); my $worker_processes = 1; my @listeners; my %pids; -my %listener_names; # sockname => IO::Handle my %tls_opt; # scheme://sockname => args for IO::Socket::SSL->start_SSL my $reexec_pid; -my $cleanup; my ($uid, $gid); my ($default_cert, $default_key); -END { $cleanup->() if $cleanup }; -my %KNOWN_TLS = ( 443 => 'https', 563 => 'nntps' ); -my %KNOWN_STARTTLS = ( 119 => 'nntp' ); +my %KNOWN_TLS = (443 => 'https', 563 => 'nntps', 993 => 'imaps', 995 =>'pop3s'); +my %KNOWN_STARTTLS = (110 => 'pop3', 119 => 'nntp', 143 => 'imap'); sub accept_tls_opt ($) { my ($opt_str) = @_; @@ -74,14 +75,41 @@ sub accept_tls_opt ($) { { SSL_server => 1, SSL_startHandshake => 0, SSL_reuse_ctx => $ctx }; } -sub daemon_prepare ($) { - my ($default_listen) = @_; - $oldset = POSIX::SigSet->new(); - $newset = POSIX::SigSet->new(); - $newset->fillset or die "fillset: $!"; - sigprocmask(SIG_SETMASK, $newset, $oldset) or die "sigprocmask: $!"; +sub load_mod ($) { + my ($scheme) = @_; + my $modc = "PublicInbox::\U$scheme"; + my $mod = $modc.'D'; + eval "require $mod"; # IMAPD|HTTPD|NNTPD|POP3D + die $@ if $@; + my %xn = map { $_ => $mod->can($_) } qw(refresh post_accept); + $xn{tlsd} = $mod->new if $mod->can('refresh_groups'); #!HTTPD + my $tlsd = $xn{tlsd}; + $xn{refresh} //= sub { $tlsd->refresh_groups(@_) }; + $xn{post_accept} //= sub { $modc->new($_[0], $tlsd) }; + $xn{af_default} = 'httpready' if $modc eq 'PublicInbox::HTTP'; + \%xn; +} + +sub daemon_prepare ($$) { + my ($default_listen, $xnetd) = @_; + my $listener_names = {}; # sockname => IO::Handle + $oldset = PublicInbox::DS::block_signals(); @CMD = ($0, @ARGV); - my %opts = ( + my ($prog) = ($CMD[0] =~ m!([^/]+)\z!g); + my $dh = defined($default_listen) ? " (default: $default_listen)" : ''; + my $help = < \@cfg_listen, '1|stdout=s' => \$stdout, '2|stderr=s' => \$stderr, @@ -92,22 +120,27 @@ sub daemon_prepare ($) { 'D|daemonize' => \$daemonize, 'cert=s' => \$default_cert, 'key=s' => \$default_key, + 'help|h' => \(my $show_help), ); - GetOptions(%opts) or die "bad command-line args\n"; + GetOptions(%opt) or die $help; + if ($show_help) { print $help; exit 0 }; 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); + 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); + unless (@listeners || @cfg_listen) { + $default_listen // die "no listeners specified\n"; + push @cfg_listen, $default_listen + } foreach my $l (@cfg_listen) { my $orig = $l; @@ -122,12 +155,13 @@ sub daemon_prepare ($) { $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/) { + } elsif ($scheme =~ /\A(?:https|imaps|nntps|pop3s)\z/) { die "$orig specified w/o cert=\n"; } - # TODO: use scheme to load either NNTP.pm or HTTP.pm + $scheme =~ /\A(http|imap|nntp|pop3)/ and + $xnetd->{$l} = load_mod($1); - next if $listener_names{$l}; # already inherited + next if $listener_names->{$l}; # already inherited my (%o, $sock_pkg); if (index($l, '/') == 0) { $sock_pkg = 'IO::Socket::UNIX'; @@ -158,7 +192,7 @@ sub daemon_prepare ($) { 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; } @@ -170,9 +204,11 @@ sub daemon_prepare ($) { for my $sockname (@inherited_names) { $sockname =~ /:([0-9]+)\z/ or next; if (my $scheme = $KNOWN_TLS{$1}) { + $xnetd->{$sockname} = load_mod(substr($scheme, 0, -1)); $tls_opt{"$scheme://$sockname"} ||= accept_tls_opt(''); } elsif (($scheme = $KNOWN_STARTTLS{$1})) { - next if $tls_opt{"$scheme://$sockname"}; + $xnetd->{$sockname} = load_mod($scheme); + $tls_opt{"$scheme://$sockname"} ||= accept_tls_opt(''); $tls_opt{''} ||= accept_tls_opt(''); } } @@ -190,10 +226,11 @@ sub check_absolute ($$) { sub daemonize () { if ($daemonize) { + require Cwd; foreach my $i (0..$#ARGV) { my $arg = $ARGV[$i]; next unless -e $arg; - $ARGV[$i] = abs_path($arg); + $ARGV[$i] = Cwd::abs_path($arg); } check_absolute('stdout', $stdout); check_absolute('stderr', $stderr); @@ -201,16 +238,12 @@ sub daemonize () { chdir '/' or die "chdir failed: $!"; } - - return unless (defined $pid_file || defined $group || defined $user - || $daemonize); - - eval { require Net::Server::Daemonize }; - if ($@) { - die -"Net::Server required for --pid-file, --group, --user, and --daemonize\n$@\n"; + if (defined($pid_file) || defined($group) || defined($user)) { + eval { require Net::Server::Daemonize; 1 } // die <&STDIN' or die "redirect stdout failed: $!\n"; open STDERR, '>&STDIN' or die "redirect stderr failed: $!\n"; POSIX::setsid(); - $pid = fork; - die "could not fork: $!\n" unless defined $pid; + $pid = fork // die "fork: $!"; 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 { +sub worker_quit { # $_[0] = signal name or number (unused) # killing again terminates immediately: exit unless @listeners; $_->close foreach @listeners; # call PublicInbox::DS::close @listeners = (); - my $proc_name; my $warn = 0; # drop idle connections and try to quit gracefully @@ -267,13 +293,11 @@ sub worker_quit { my ($dmap, undef) = @_; my $n = 0; my $now = now(); - - foreach my $s (values %$dmap) { + for my $s (values %$dmap) { $s->can('busy') or next; - if ($s->busy($now)) { + if ($s->busy) { ++$n; - } else { - # close as much as possible, early as possible + } else { # close as much as possible, early as possible $s->close; } } @@ -357,23 +381,22 @@ 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 my @rv = (); foreach my $fd (3..$end) { - my $s = IO::Handle->new_from_fd($fd, 'r'); + open(my $s, '<&=', $fd) or warn "fdopen fd=$fd: $!"; if (my $k = sockname($s)) { - if ($s->blocking) { - $s->blocking(0); - warn <<""; + my $prev_was_blocking = $s->blocking(0); + warn <<"" if $prev_was_blocking; 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; + $listener_names->{$k} = $s; push @rv, $s; } else { warn "failed to inherit fd=$fd (LISTEN_FDS=$fds)"; @@ -382,7 +405,7 @@ processes when multiple service instances start. @rv } -sub upgrade () { +sub upgrade { # $_[0] = signal name or number (unused) if ($reexec_pid) { warn "upgrade in-progress: $reexec_pid\n"; return; @@ -406,6 +429,9 @@ sub upgrade () { $ENV{LISTEN_FDS} = scalar @listeners; $ENV{LISTEN_PID} = $$; foreach my $s (@listeners) { + # @listeners are globs with workers, PI::L w/o workers + $s = $s->{sock} if ref($s) eq 'PublicInbox::Listener'; + my $fl = fcntl($s, F_GETFD, 0); fcntl($s, F_SETFD, $fl &= ~FD_CLOEXEC); } @@ -416,11 +442,8 @@ sub upgrade () { } sub kill_workers ($) { - my ($s) = @_; - - while (my ($pid, $id) = each %pids) { - kill $s, $pid; - } + my ($sig) = @_; + kill $sig, keys(%pids); } sub upgrade_aborted ($) { @@ -437,7 +460,7 @@ sub upgrade_aborted ($) { warn $@, "\n" if $@; } -sub reap_children () { +sub reap_children { # $_[0] = 'CHLD' or POSIX::SIGCHLD() while (1) { my $p = waitpid(-1, WNOHANG) or return; if (defined $reexec_pid && $p == $reexec_pid) { @@ -465,67 +488,58 @@ 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: $!"; - - if ($^O eq 'linux') { # 1031: F_SETPIPE_SZ = 1031 - fcntl($_, 1031, 4096) for ($w, $p1); - } - - IO::Handle::blocking($w, 0); 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, '.'); - }; - } - sigprocmask(SIG_SETMASK, $oldset) or die "sigprocmask: $!"; 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); + local @SIG{keys %$sig} = values(%$sig) unless $sigfd; + PublicInbox::DS::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; } @@ -536,22 +550,32 @@ sub master_loop { } $n = $worker_processes; } - sigprocmask(SIG_SETMASK, $newset) or die "sigprocmask: $!"; - 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) { + PublicInbox::DS::block_signals() if !$sigfd; + for my $i ($n..$want) { + my $seed = rand(0xffffffff); + my $pid = fork; + if (!defined $pid) { + warn "failed to fork worker[$i]: $!\n"; + } elsif ($pid == 0) { + srand($seed); + eval { Net::SSLeay::randomize() }; + $set_user->() if $set_user; + return $p0; # run normal work code + } else { + warn "PID=$pid is worker[$i]\n"; + $pids{$pid} = $i; + } } + PublicInbox::DS::sig_setmask($oldset) if !$sigfd; + } + + if ($sigfd) { # Linux and IO::KQueue users: + $sigfd->wait_once; + } else { # wake up every second + sleep(1); } - sigprocmask(SIG_SETMASK, $oldset) or die "sigprocmask: $!"; - # just wait on signal events here: - sysread($r, my $buf, 8); } exit # never gets here, just for documentation } @@ -569,70 +593,99 @@ 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()); + my $TCP_DEFER_ACCEPT = 9; # Socket::TCP_DEFER_ACCEPT is in 5.14+ + my $x = getsockopt($s, IPPROTO_TCP, $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); + setsockopt($s, IPPROTO_TCP, $TCP_DEFER_ACCEPT, 1); } elsif ($^O eq 'freebsd') { - my $x = getsockopt($s, SOL_SOCKET, SO_ACCEPTFILTER); + 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); + setsockopt($s, SOL_SOCKET, $SO_ACCEPTFILTER, $accf_arg); } } -sub daemon_loop ($$$$) { - my ($refresh, $post_accept, $nntpd, $af_default) = @_; - PublicInbox::EvCleanup::enable(); # early for $refresh +sub daemon_loop ($) { + my ($xnetd) = @_; + my $refresh = sub { + my ($sig) = @_; + for my $xn (values %$xnetd) { + eval { $xn->{refresh}->($sig) }; + warn "refresh $@\n" if $@; + } + }; 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 $l = $k; + $l =~ s!\A([^:]+)://!!; + my $scheme = $1 // ''; + my $xn = $xnetd->{$l} // $xnetd->{''}; + if ($scheme =~ m!\A(?:https|imaps|nntps|pop3s)!) { + $post_accept{$l} = tls_start_cb($v, $xn->{post_accept}); + } elsif ($xn->{tlsd}) { # STARTTLS, $k eq '' is OK + $xn->{tlsd}->{accept_tls} = $v; } } - my $parent_pipe; + 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, + }; if ($worker_processes > 0) { $refresh->(); # preload by default my $fh = master_loop(); # returns if in child process - $parent_pipe = PublicInbox::ParentPipe->new($fh, *worker_quit); + PublicInbox::EOFpipe->new($fh, \&worker_quit, undef); } else { reopen_logs(); $set_user->() if $set_user; - $SIG{USR2} = sub { worker_quit() 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); @listeners = map {; - my $tls_cb = $post_accept{sockname($_)}; + my $l = sockname($_); + my $tls_cb = $post_accept{$l}; + my $xn = $xnetd->{$l} // $xnetd->{''}; - # NNTPS, HTTPS, HTTP, and POP3S are client-first traffic - # NNTP and POP3 are server-first - defer_accept($_, $tls_cb ? 'dataready' : $af_default); + # NNTPS, HTTPS, HTTP, IMAPS and POP3S are client-first traffic + # IMAP, NNTP and POP3 are server-first + defer_accept($_, $tls_cb ? 'dataready' : $xn->{af_default}); # this calls epoll_create: - PublicInbox::Listener->new($_, $tls_cb || $post_accept) + PublicInbox::Listener->new($_, $tls_cb || $xn->{post_accept}) } @listeners; - sigprocmask(SIG_SETMASK, $oldset) or die "sigprocmask: $!"; - PublicInbox::DS->EventLoop; - $parent_pipe = undef; + PublicInbox::DS::event_loop($sig, $oldset); } - -sub run ($$$;$) { - my ($default, $refresh, $post_accept, $nntpd) = @_; - daemon_prepare($default); - my $af_default = $default =~ /:8080\z/ ? 'httpready' : undef; - daemonize(); - daemon_loop($refresh, $post_accept, $nntpd, $af_default); +sub run { + my ($default_listen) = @_; + my $xnetd = {}; + if ($default_listen) { + $default_listen =~ /\A(http|imap|nntp|pop3)/ or + die "BUG: $default_listen"; + $xnetd->{''} = load_mod($1); + } + daemon_prepare($default_listen, $xnetd); + my $for_destroy = daemonize(); + + # localize GCF2C for tests: + local $PublicInbox::GitAsyncCat::GCF2C; + local $PublicInbox::Git::async_warn = 1; + local $SIG{__WARN__} = PublicInbox::Eml::warn_ignore_cb(); + + daemon_loop($xnetd); + PublicInbox::DS->Reset; + # ->DESTROY runs when $for_destroy goes out-of-scope } sub do_chown ($) { @@ -648,4 +701,8 @@ sub write_pid ($) { do_chown($path); } +sub DESTROY { + unlink_pid_file_safe_ish($_[0]->{pid}, ${$_[0]->{pid_file}}); +} + 1;