1 # Copyright (C) 2015 all contributors <meta@public-inbox.org>
2 # License: AGPLv3 or later (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/;
14 require Danga::Socket;
16 require PublicInbox::Listener;
17 require PublicInbox::ParentPipe;
20 my (@cfg_listen, $stdout, $stderr, $group, $user, $pid_file, $daemonize);
21 my $worker_processes = 1;
28 END { $cleanup->() if $cleanup };
30 sub daemon_prepare ($) {
31 my ($default_listen) = @_;
33 $SIG{HUP} = $SIG{USR1} = $SIG{USR2} = $SIG{PIPE} =
34 $SIG{TTIN} = $SIG{TTOU} = $SIG{WINCH} = 'IGNORE';
36 'l|listen=s' => \@cfg_listen,
37 '1|stdout=s' => \$stdout,
38 '2|stderr=s' => \$stderr,
39 'W|worker-processes=i' => \$worker_processes,
40 'P|pid-file=s' => \$pid_file,
42 'g|group=s' => \$group,
43 'D|daemonize' => \$daemonize,
45 GetOptions(%opts) or die "bad command-line args\n";
47 if (defined $pid_file && $pid_file =~ /\.oldbin\z/) {
48 die "--pid-file cannot end with '.oldbin'\n";
50 @listeners = inherit();
51 # ignore daemonize when inheriting
52 $daemonize = undef if scalar @listeners;
54 push @cfg_listen, $default_listen unless (@listeners || @cfg_listen);
56 foreach my $l (@cfg_listen) {
57 next if $listener_names{$l}; # already inherited
59 if (index($l, '/') == 0) {
60 $sock_pkg = 'IO::Socket::UNIX';
63 %o = (Type => SOCK_STREAM, Peer => $l);
65 my $c = $sock_pkg->new(%o);
66 if (!defined($c) && $!{ECONNREFUSED}) {
68 "failed to unlink stale socket=$l: $!\n";
69 } # else: let the bind fail
71 $o{Local} = delete $o{Peer};
73 # both work for IPv4, too
74 for (qw(IO::Socket::IP IO::Socket::INET6)) {
80 %o = (LocalAddr => $l, ReuseAddr => 1, Proto => 'tcp');
83 my $prev = umask 0000;
84 my $s = eval { $sock_pkg->new(%o) };
85 warn "error binding $l: $! ($@)\n" unless $s;
89 $listener_names{sockname($s)} = $s;
93 die "No listeners bound\n" unless @listeners;
96 sub check_absolute ($$) {
98 if (defined $val && index($val, '/') != 0) {
100 "--$var must be an absolute path when using --daemonize: $val\n";
106 foreach my $i (0..$#ARGV) {
109 $ARGV[$i] = abs_path($arg);
111 check_absolute('stdout', $stdout);
112 check_absolute('stderr', $stderr);
113 check_absolute('pid-file', $pid_file);
115 chdir '/' or die "chdir failed: $!";
118 return unless (defined $pid_file || defined $group || defined $user
121 eval { require Net::Server::Daemonize };
124 "Net::Server required for --pid-file, --group, --user, and --daemonize\n$@\n";
127 Net::Server::Daemonize::check_pid_file($pid_file) if defined $pid_file;
128 $uid = Net::Server::Daemonize::get_uid($user) if defined $user;
129 if (defined $group) {
130 $gid = Net::Server::Daemonize::get_gid($group);
131 $gid = (split /\s+/, $gid)[0];
132 } elsif (defined $uid) {
133 $gid = (getpwuid($uid))[3];
136 # We change users in the worker to ensure upgradability,
137 # The upgrade will create the ".oldbin" pid file in the
138 # same directory as the given pid file.
139 $uid and $set_user = sub {
141 Net::Server::Daemonize::set_user($uid, $gid);
146 die "could not fork: $!\n" unless defined $pid;
149 open(STDIN, '+<', '/dev/null') or
150 die "redirect stdin failed: $!\n";
151 open STDOUT, '>&STDIN' or die "redirect stdout failed: $!\n";
152 open STDERR, '>&STDIN' or die "redirect stderr failed: $!\n";
155 die "could not fork: $!\n" unless defined $pid;
158 if (defined $pid_file) {
159 write_pid($pid_file);
162 $cleanup = undef; # avoid cyclic reference
163 unlink_pid_file_safe_ish($unlink_pid, $pid_file);
171 # killing again terminates immediately:
172 exit unless @listeners;
174 $_->close foreach @listeners; # call Danga::Socket::close
176 $reason->close if ref($reason) eq 'PublicInbox::ParentPipe';
180 # drop idle connections and try to quit gracefully
181 Danga::Socket->SetPostLoopCallback(sub {
182 my ($dmap, undef) = @_;
185 foreach my $s (values %$dmap) {
186 $s->can('busy') or next;
190 # close as much as possible, early as possible
195 if (($warn + 5) < time) {
196 warn "$$ quitting, $n client(s) left\n";
199 unless (defined $proc_name) {
200 $proc_name = (split(/\s+/, $0))[0];
201 $proc_name =~ s!\A.*?([^/]+)\z!$1!;
203 $0 = "$proc_name quitting, $n client(s) left";
205 $n; # true: loop continues, false: loop breaks
211 open STDOUT, '>>', $stdout or
212 warn "failed to redirect stdout to $stdout: $!\n";
213 STDOUT->autoflush(1);
217 open STDERR, '>>', $stderr or
218 warn "failed to redirect stderr to $stderr: $!\n";
219 STDERR->autoflush(1);
226 my $addr = getsockname($s) or return;
227 my ($host, $port) = host_with_port($addr);
228 if ($port == 0 && $host eq '127.0.0.1') {
229 my ($path) = Socket::sockaddr_un($addr);
235 sub host_with_port ($) {
239 # this eval will die on Unix sockets:
241 if (length($addr) >= 28) {
243 ($port, $host) = Socket6::unpack_sockaddr_in6($addr);
244 $host = Socket6::inet_ntop(Socket6::AF_INET6(), $host);
247 ($port, $host) = Socket::sockaddr_in($addr);
248 $host = Socket::inet_ntoa($host);
251 $@ ? ('127.0.0.1', 0) : ($host, $port);
255 return () if ($ENV{LISTEN_PID} || 0) != $$;
256 my $fds = $ENV{LISTEN_FDS} or return ();
257 my $end = $fds + 2; # LISTEN_FDS_START - 1
259 foreach my $fd (3..$end) {
260 my $s = IO::Handle->new_from_fd($fd, 'r');
261 if (my $k = sockname($s)) {
262 $listener_names{$k} = $s;
265 warn "failed to inherit fd=$fd (LISTEN_FDS=$fds)";
273 warn "upgrade in-progress: $reexec_pid\n";
276 if (defined $pid_file) {
277 if ($pid_file =~ /\.oldbin\z/) {
278 warn "BUG: .oldbin suffix exists: $pid_file\n";
281 unlink_pid_file_safe_ish($$, $pid_file);
282 $pid_file .= '.oldbin';
283 write_pid($pid_file);
286 unless (defined $pid) {
287 warn "fork failed: $!\n";
291 use Fcntl qw(FD_CLOEXEC F_SETFD F_GETFD);
292 $ENV{LISTEN_FDS} = scalar @listeners;
293 $ENV{LISTEN_PID} = $$;
294 foreach my $s (@listeners) {
295 my $fl = fcntl($s, F_GETFD, 0);
296 fcntl($s, F_SETFD, $fl &= ~FD_CLOEXEC);
299 die "Failed to exec: $!\n";
304 sub kill_workers ($) {
307 while (my ($pid, $id) = each %pids) {
312 sub upgrade_aborted ($) {
314 warn "reexec PID($p) died with: $?\n";
316 return unless $pid_file;
318 my $file = $pid_file;
319 $file =~ s/\.oldbin\z// or die "BUG: no '.oldbin' suffix in $file";
320 unlink_pid_file_safe_ish($$, $pid_file);
322 eval { write_pid($pid_file) };
326 sub reap_children () {
328 my $p = waitpid(-1, &POSIX::WNOHANG) or return;
329 if (defined $reexec_pid && $p == $reexec_pid) {
331 } elsif (defined(my $id = delete $pids{$p})) {
332 warn "worker[$id] PID($p) died with: $?\n";
334 warn "unknown PID($p) reaped: $?\n";
341 sub unlink_pid_file_safe_ish ($$) {
342 my ($unlink_pid, $file) = @_;
343 return unless defined $unlink_pid && $unlink_pid == $$;
345 open my $fh, '<', $file or return;
347 defined(my $read_pid = <$fh>) or return;
349 if ($read_pid == $unlink_pid) {
350 Net::Server::Daemonize::unlink_pid_file($file);
355 pipe(my ($p0, $p1)) or die "failed to create parent-pipe: $!";
356 pipe(my ($r, $w)) or die "failed to create self-pipe: $!";
357 IO::Handle::blocking($w, 0);
358 my $set_workers = $worker_processes;
361 foreach my $s (qw(HUP CHLD QUIT INT TERM USR1 USR2 TTIN TTOU WINCH)) {
363 return if $$ != $master_pid;
372 while (my $s = shift @caught) {
376 } elsif ($s eq 'USR2') {
378 } elsif ($s =~ /\A(?:QUIT|TERM|INT)\z/) {
381 } elsif ($s eq 'WINCH') {
382 if (-t STDIN || -t STDOUT || -t STDERR) {
384 "ignoring SIGWINCH since we are not daemonized\n";
385 $SIG{WINCH} = 'IGNORE';
387 $worker_processes = 0;
389 } elsif ($s eq 'HUP') {
390 $worker_processes = $set_workers;
392 } elsif ($s eq 'TTIN') {
393 if ($set_workers > $worker_processes) {
396 $worker_processes = ++$set_workers;
398 } elsif ($s eq 'TTOU') {
399 if ($set_workers > 0) {
400 $worker_processes = --$set_workers;
402 } elsif ($s eq 'CHLD') {
407 my $n = scalar keys %pids;
410 $set_workers = $worker_processes = $n = 0;
413 if ($n > $worker_processes) {
414 while (my ($k, $v) = each %pids) {
415 kill('TERM', $k) if $v >= $worker_processes;
417 $n = $worker_processes;
419 foreach my $i ($n..($worker_processes - 1)) {
422 warn "failed to fork worker[$i]: $!\n";
423 } elsif ($pid == 0) {
424 $set_user->() if $set_user;
425 return $p0; # run normal work code
427 warn "PID=$pid is worker[$i]\n";
431 # just wait on signal events here:
432 sysread($r, my $buf, 8);
434 exit # never gets here, just for documentation
437 sub daemon_loop ($$) {
438 my ($refresh, $post_accept) = @_;
440 if ($worker_processes > 0) {
441 $refresh->(); # preload by default
442 my $fh = master_loop(); # returns if in child process
443 $parent_pipe = PublicInbox::ParentPipe->new($fh, *worker_quit);
446 $set_user->() if $set_user;
447 $SIG{USR2} = sub { worker_quit('USR2') if upgrade() };
452 $SIG{QUIT} = $SIG{INT} = $SIG{TERM} = *worker_quit;
453 $SIG{USR1} = *reopen_logs;
454 $SIG{HUP} = $refresh;
455 $SIG{CHLD} = 'DEFAULT';
456 $SIG{$_} = 'IGNORE' for qw(USR2 TTIN TTOU WINCH);
457 # this calls epoll_create:
459 PublicInbox::Listener->new($_, $post_accept)
461 Danga::Socket->EventLoop;
462 $parent_pipe = undef;
467 my ($default, $refresh, $post_accept) = @_;
468 daemon_prepare($default);
470 daemon_loop($refresh, $post_accept);
475 if (defined $uid and !chown($uid, $gid, $path)) {
476 warn "could not chown $path: $!\n";
482 Net::Server::Daemonize::create_pid_file($path);