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";
105 foreach my $i (0..$#ARGV) {
108 $ARGV[$i] = abs_path($arg);
110 check_absolute('stdout', $stdout);
111 check_absolute('stderr', $stderr);
112 check_absolute('pid-file', $pid_file);
114 chdir '/' or die "chdir failed: $!";
116 return unless (defined $pid_file || defined $group || defined $user
119 eval { require Net::Server::Daemonize };
122 "Net::Server required for --pid-file, --group, --user, and --daemonize\n$@\n";
125 Net::Server::Daemonize::check_pid_file($pid_file) if defined $pid_file;
126 $uid = Net::Server::Daemonize::get_uid($user) if defined $user;
127 if (defined $group) {
128 $gid = Net::Server::Daemonize::get_gid($group);
129 $gid = (split /\s+/, $gid)[0];
130 } elsif (defined $uid) {
131 $gid = (getpwuid($uid))[3];
134 # We change users in the worker to ensure upgradability,
135 # The upgrade will create the ".oldbin" pid file in the
136 # same directory as the given pid file.
137 $uid and $set_user = sub {
139 Net::Server::Daemonize::set_user($uid, $gid);
144 die "could not fork: $!\n" unless defined $pid;
147 open(STDIN, '+<', '/dev/null') or
148 die "redirect stdin failed: $!\n";
149 open STDOUT, '>&STDIN' or die "redirect stdout failed: $!\n";
150 open STDERR, '>&STDIN' or die "redirect stderr failed: $!\n";
153 die "could not fork: $!\n" unless defined $pid;
156 if (defined $pid_file) {
157 write_pid($pid_file);
160 $cleanup = undef; # avoid cyclic reference
161 unlink_pid_file_safe_ish($unlink_pid, $pid_file);
169 # killing again terminates immediately:
170 exit unless @listeners;
172 $_->close foreach @listeners; # call Danga::Socket::close
174 $reason->close if ref($reason) eq 'PublicInbox::ParentPipe';
178 # drop idle connections and try to quit gracefully
179 Danga::Socket->SetPostLoopCallback(sub {
180 my ($dmap, undef) = @_;
183 foreach my $s (values %$dmap) {
184 $s->can('busy') or next;
188 # close as much as possible, early as possible
193 if (($warn + 5) < time) {
194 warn "$$ quitting, $n client(s) left\n";
197 unless (defined $proc_name) {
198 $proc_name = (split(/\s+/, $0))[0];
199 $proc_name =~ s!\A.*?([^/]+)\z!$1!;
201 $0 = "$proc_name quitting, $n client(s) left";
203 $n; # true: loop continues, false: loop breaks
209 open STDOUT, '>>', $stdout or
210 warn "failed to redirect stdout to $stdout: $!\n";
211 STDOUT->autoflush(1);
215 open STDERR, '>>', $stderr or
216 warn "failed to redirect stderr to $stderr: $!\n";
217 STDERR->autoflush(1);
224 my $addr = getsockname($s) or return;
225 my ($host, $port) = host_with_port($addr);
226 if ($port == 0 && $host eq '127.0.0.1') {
227 my ($path) = Socket::sockaddr_un($addr);
233 sub host_with_port ($) {
237 # this eval will die on Unix sockets:
239 if (length($addr) >= 28) {
241 ($port, $host) = Socket6::unpack_sockaddr_in6($addr);
242 $host = Socket6::inet_ntop(Socket6::AF_INET6(), $host);
245 ($port, $host) = Socket::sockaddr_in($addr);
246 $host = Socket::inet_ntoa($host);
249 $@ ? ('127.0.0.1', 0) : ($host, $port);
253 return () if ($ENV{LISTEN_PID} || 0) != $$;
254 my $fds = $ENV{LISTEN_FDS} or return ();
255 my $end = $fds + 2; # LISTEN_FDS_START - 1
257 foreach my $fd (3..$end) {
258 my $s = IO::Handle->new_from_fd($fd, 'r');
259 if (my $k = sockname($s)) {
260 $listener_names{$k} = $s;
263 warn "failed to inherit fd=$fd (LISTEN_FDS=$fds)";
271 warn "upgrade in-progress: $reexec_pid\n";
274 if (defined $pid_file) {
275 if ($pid_file =~ /\.oldbin\z/) {
276 warn "BUG: .oldbin suffix exists: $pid_file\n";
279 unlink_pid_file_safe_ish($$, $pid_file);
280 $pid_file .= '.oldbin';
281 write_pid($pid_file);
284 unless (defined $pid) {
285 warn "fork failed: $!\n";
289 use Fcntl qw(FD_CLOEXEC F_SETFD F_GETFD);
290 $ENV{LISTEN_FDS} = scalar @listeners;
291 $ENV{LISTEN_PID} = $$;
292 foreach my $s (@listeners) {
293 my $fl = fcntl($s, F_GETFD, 0);
294 fcntl($s, F_SETFD, $fl &= ~FD_CLOEXEC);
297 die "Failed to exec: $!\n";
302 sub kill_workers ($) {
305 while (my ($pid, $id) = each %pids) {
310 sub upgrade_aborted ($) {
312 warn "reexec PID($p) died with: $?\n";
314 return unless $pid_file;
316 my $file = $pid_file;
317 $file =~ s/\.oldbin\z// or die "BUG: no '.oldbin' suffix in $file";
318 unlink_pid_file_safe_ish($$, $pid_file);
320 eval { write_pid($pid_file) };
324 sub reap_children () {
326 my $p = waitpid(-1, &POSIX::WNOHANG) or return;
327 if (defined $reexec_pid && $p == $reexec_pid) {
329 } elsif (defined(my $id = delete $pids{$p})) {
330 warn "worker[$id] PID($p) died with: $?\n";
332 warn "unknown PID($p) reaped: $?\n";
339 sub unlink_pid_file_safe_ish ($$) {
340 my ($unlink_pid, $file) = @_;
341 return unless defined $unlink_pid && $unlink_pid == $$;
343 open my $fh, '<', $file or return;
345 defined(my $read_pid = <$fh>) or return;
347 if ($read_pid == $unlink_pid) {
348 Net::Server::Daemonize::unlink_pid_file($file);
353 pipe(my ($p0, $p1)) or die "failed to create parent-pipe: $!";
354 pipe(my ($r, $w)) or die "failed to create self-pipe: $!";
355 IO::Handle::blocking($w, 0);
356 my $set_workers = $worker_processes;
359 foreach my $s (qw(HUP CHLD QUIT INT TERM USR1 USR2 TTIN TTOU WINCH)) {
361 return if $$ != $master_pid;
370 while (my $s = shift @caught) {
374 } elsif ($s eq 'USR2') {
376 } elsif ($s =~ /\A(?:QUIT|TERM|INT)\z/) {
379 } elsif ($s eq 'WINCH') {
380 if (-t STDIN || -t STDOUT || -t STDERR) {
382 "ignoring SIGWINCH since we are not daemonized\n";
383 $SIG{WINCH} = 'IGNORE';
385 $worker_processes = 0;
387 } elsif ($s eq 'HUP') {
388 $worker_processes = $set_workers;
390 } elsif ($s eq 'TTIN') {
391 if ($set_workers > $worker_processes) {
394 $worker_processes = ++$set_workers;
396 } elsif ($s eq 'TTOU') {
397 if ($set_workers > 0) {
398 $worker_processes = --$set_workers;
400 } elsif ($s eq 'CHLD') {
405 my $n = scalar keys %pids;
408 $set_workers = $worker_processes = $n = 0;
411 if ($n > $worker_processes) {
412 while (my ($k, $v) = each %pids) {
413 kill('TERM', $k) if $v >= $worker_processes;
415 $n = $worker_processes;
417 foreach my $i ($n..($worker_processes - 1)) {
420 warn "failed to fork worker[$i]: $!\n";
421 } elsif ($pid == 0) {
422 $set_user->() if $set_user;
423 return $p0; # run normal work code
425 warn "PID=$pid is worker[$i]\n";
429 # just wait on signal events here:
430 sysread($r, my $buf, 8);
432 exit # never gets here, just for documentation
435 sub daemon_loop ($$) {
436 my ($refresh, $post_accept) = @_;
438 if ($worker_processes > 0) {
439 $refresh->(); # preload by default
440 my $fh = master_loop(); # returns if in child process
441 $parent_pipe = PublicInbox::ParentPipe->new($fh, *worker_quit);
444 $set_user->() if $set_user;
445 $SIG{USR2} = sub { worker_quit('USR2') if upgrade() };
450 $SIG{QUIT} = $SIG{INT} = $SIG{TERM} = *worker_quit;
451 $SIG{USR1} = *reopen_logs;
452 $SIG{HUP} = $refresh;
453 $SIG{CHLD} = 'DEFAULT';
454 $SIG{$_} = 'IGNORE' for qw(USR2 TTIN TTOU WINCH);
455 # this calls epoll_create:
457 PublicInbox::Listener->new($_, $post_accept)
459 Danga::Socket->EventLoop;
460 $parent_pipe = undef;
465 my ($default, $refresh, $post_accept) = @_;
466 daemon_prepare($default);
468 daemon_loop($refresh, $post_accept);
473 if (defined $uid and !chown($uid, $gid, $path)) {
474 warn "could not chown $path: $!\n";
480 Net::Server::Daemonize::create_pid_file($path);