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 package PublicInbox::Daemon; # empty class :p
5 # contains common daemon code for the nntpd server.
6 # This may be used for read-only IMAP server if we decide to implement it.
10 use Getopt::Long qw/:config gnu_getopt no_ignore_case auto_abbrev/;
11 require Danga::Socket;
13 require PublicInbox::Listener;
16 my (@cfg_listen, $stdout, $stderr, $group, $user, $pid_file, $daemonize);
17 my $worker_processes = 1;
24 END { $cleanup->() if $cleanup };
26 sub daemon_prepare ($) {
27 my ($default_listen) = @_;
29 $SIG{HUP} = $SIG{USR1} = $SIG{USR2} = $SIG{PIPE} =
30 $SIG{TTIN} = $SIG{TTOU} = $SIG{WINCH} = 'IGNORE';
32 'l|listen=s' => \@cfg_listen,
33 '1|stdout=s' => \$stdout,
34 '2|stderr=s' => \$stderr,
35 'W|worker-processes=i' => \$worker_processes,
36 'P|pid-file=s' => \$pid_file,
38 'g|group=s' => \$group,
39 'D|daemonize' => \$daemonize,
41 GetOptions(%opts) or die "bad command-line args\n";
43 if (defined $pid_file && $pid_file =~ /\.oldbin\z/) {
44 die "--pid-file cannot end with '.oldbin'\n";
46 @listeners = inherit();
47 # ignore daemonize when inheriting
48 $daemonize = undef if scalar @listeners;
50 push @cfg_listen, $default_listen unless (@listeners || @cfg_listen);
52 foreach my $l (@cfg_listen) {
53 next if $listener_names{$l}; # already inherited
54 require IO::Socket::INET6; # works for IPv4, too
60 if (my $s = IO::Socket::INET6->new(%o)) {
61 $listener_names{sockname($s)} = $s;
64 warn "error binding $l: $!\n";
67 die 'No listeners bound' unless @listeners;
71 chdir '/' or die "chdir failed: $!\n";
72 open(STDIN, '+<', '/dev/null') or die "redirect stdin failed: $!\n";
74 return unless (defined $pid_file || defined $group || defined $user
77 require Net::Server::Daemonize;
79 Net::Server::Daemonize::check_pid_file($pid_file) if defined $pid_file;
80 $uid = Net::Server::Daemonize::get_uid($user) if defined $user;
82 $gid = Net::Server::Daemonize::get_gid($group);
83 $gid = (split /\s+/, $gid)[0];
84 } elsif (defined $uid) {
85 $gid = (getpwuid($uid))[3];
88 # We change users in the worker to ensure upgradability,
89 # The upgrade will create the ".oldbin" pid file in the
90 # same directory as the given pid file.
91 $uid and $set_user = sub {
92 Net::Server::Daemonize::set_user($uid, $gid);
96 my ($pid, $err) = do_fork();
97 die "could not fork: $err\n" unless defined $pid;
100 open STDOUT, '>&STDIN' or die "redirect stdout failed: $!\n";
101 open STDERR, '>&STDIN' or die "redirect stderr failed: $!\n";
103 ($pid, $err) = do_fork();
104 die "could not fork: $err\n" unless defined $pid;
107 if (defined $pid_file) {
108 write_pid($pid_file);
111 unlink_pid_file_safe_ish($unlink_pid, $pid_file);
117 # killing again terminates immediately:
118 exit unless @listeners;
122 # give slow clients 30s to finish reading/writing whatever
123 Danga::Socket->AddTimer(30, sub { exit });
125 # drop idle connections and try to quit gracefully
126 Danga::Socket->SetPostLoopCallback(sub {
127 my ($dmap, undef) = @_;
130 foreach my $s (values %$dmap) {
131 if ($s->can('busy') && $s->busy) {
134 # close as much as possible, early as possible
138 $n; # true: loop continues, false: loop breaks
144 open STDOUT, '>>', $stdout or
145 warn "failed to redirect stdout to $stdout: $!\n";
146 STDOUT->autoflush(1);
150 open STDERR, '>>', $stderr or
151 warn "failed to redirect stderr to $stderr: $!\n";
152 STDERR->autoflush(1);
159 my $n = getsockname($s) or return;
161 if (length($n) >= 28) {
163 ($port, $addr) = Socket6::unpack_sockaddr_in6($n);
165 ($port, $addr) = Socket::sockaddr_in($n);
167 if (length($addr) == 4) {
168 $n = Socket::inet_ntoa($addr)
170 $n = '['.Socket6::inet_ntop(Socket6::AF_INET6(), $addr).']';
176 return () if ($ENV{LISTEN_PID} || 0) != $$;
177 my $fds = $ENV{LISTEN_FDS} or return ();
178 my $end = $fds + 2; # LISTEN_FDS_START - 1
180 foreach my $fd (3..$end) {
181 my $s = IO::Handle->new;
182 $s->fdopen($fd, 'r');
183 if (my $k = sockname($s)) {
184 $listener_names{$k} = $s;
187 warn "failed to inherit fd=$fd (LISTEN_FDS=$fds)";
195 warn "upgrade in-progress: $reexec_pid\n";
198 if (defined $pid_file) {
199 if ($pid_file =~ /\.oldbin\z/) {
200 warn "BUG: .oldbin suffix exists: $pid_file\n";
203 unlink_pid_file_safe_ish($$, $pid_file);
204 $pid_file .= '.oldbin';
205 write_pid($pid_file);
207 my ($pid, $err) = do_fork();
208 unless (defined $pid) {
209 warn "fork failed: $err\n";
213 use Fcntl qw(FD_CLOEXEC F_SETFD F_GETFD);
214 $ENV{LISTEN_FDS} = scalar @listeners;
215 $ENV{LISTEN_PID} = $$;
216 foreach my $s (@listeners) {
217 my $fl = fcntl($s, F_GETFD, 0);
218 fcntl($s, F_SETFD, $fl &= ~FD_CLOEXEC);
221 die "Failed to exec: $!\n";
226 sub kill_workers ($) {
229 while (my ($pid, $id) = each %pids) {
235 my $new = POSIX::SigSet->new;
237 my $old = POSIX::SigSet->new;
238 POSIX::sigprocmask(&POSIX::SIG_BLOCK, $new, $old) or
239 die "SIG_BLOCK: $!\n";
242 POSIX::sigprocmask(&POSIX::SIG_SETMASK, $old) or
243 die "SIG_SETMASK: $!\n";
247 sub upgrade_aborted ($) {
249 warn "reexec PID($p) died with: $?\n";
251 return unless $pid_file;
253 my $file = $pid_file;
254 $file =~ s/\.oldbin\z// or die "BUG: no '.oldbin' suffix in $file\n";
255 unlink_pid_file_safe_ish($$, $pid_file);
257 eval { write_pid($pid_file) };
261 sub reap_children () {
263 my $p = waitpid(-1, &POSIX::WNOHANG) or return;
264 if (defined $reexec_pid && $p == $reexec_pid) {
266 } elsif (defined(my $id = delete $pids{$p})) {
267 warn "worker[$id] PID($p) died with: $?\n";
269 warn "unknown PID($p) reaped: $?\n";
276 sub unlink_pid_file_safe_ish ($$) {
277 my ($unlink_pid, $file) = @_;
278 return unless defined $unlink_pid && $unlink_pid == $$;
280 open my $fh, '<', $file or return;
281 defined(my $read_pid = <$fh>) or return;
283 if ($read_pid == $unlink_pid) {
284 Net::Server::Daemonize::unlink_pid_file($file);
289 pipe(my ($p0, $p1)) or die "failed to create parent-pipe: $!\n";
290 pipe(my ($r, $w)) or die "failed to create self-pipe: $!\n";
291 IO::Handle::blocking($w, 0);
292 my $set_workers = $worker_processes;
295 foreach my $s (qw(HUP CHLD QUIT INT TERM USR1 USR2 TTIN TTOU WINCH)) {
297 return if $$ != $master_pid;
305 while (my $s = shift @caught) {
309 } elsif ($s eq 'USR2') {
311 } elsif ($s =~ /\A(?:QUIT|TERM|INT)\z/) {
312 # drops pipes and causes children to die
314 } elsif ($s eq 'WINCH') {
315 $worker_processes = 0;
316 } elsif ($s eq 'HUP') {
317 $worker_processes = $set_workers;
319 } elsif ($s eq 'TTIN') {
320 if ($set_workers > $worker_processes) {
323 $worker_processes = ++$set_workers;
325 } elsif ($s eq 'TTOU') {
326 if ($set_workers > 0) {
327 $worker_processes = --$set_workers;
329 } elsif ($s eq 'CHLD') {
334 my $n = scalar keys %pids;
335 if ($n > $worker_processes) {
336 while (my ($k, $v) = each %pids) {
337 kill('TERM', $k) if $v >= $worker_processes;
339 $n = $worker_processes;
341 foreach my $i ($n..($worker_processes - 1)) {
342 my ($pid, $err) = do_fork();
344 warn "failed to fork worker[$i]: $err\n";
345 } elsif ($pid == 0) {
346 $set_user->() if $set_user;
347 return $p0; # run normal work code
349 warn "PID=$pid is worker[$i]\n";
353 # just wait on signal events here:
354 sysread($r, my $buf, 8);
356 exit # never gets here, just for documentation
359 sub daemon_loop ($$) {
360 my ($refresh, $post_accept) = @_;
362 if ($worker_processes > 0) {
363 $parent_pipe = master_loop(); # returns if in child process
364 my $fd = fileno($parent_pipe);
365 Danga::Socket->AddOtherFds($fd => sub { kill('TERM', $$) } );
368 $set_user->() if $set_user;
369 $SIG{USR2} = sub { worker_quit() if upgrade() };
374 $SIG{QUIT} = $SIG{INT} = $SIG{TERM} = *worker_quit;
375 $SIG{USR1} = *reopen_logs;
376 $SIG{HUP} = $refresh;
377 # this calls epoll_create:
378 PublicInbox::Listener->new($_, $post_accept) for @listeners;
379 Danga::Socket->EventLoop;
380 $parent_pipe = undef;
384 sub daemon_run ($$$) {
385 my ($default, $refresh, $post_accept) = @_;
386 daemon_prepare($default);
388 daemon_loop($refresh, $post_accept);
393 if (defined $uid and !chown($uid, $gid, $path)) {
394 warn "could not chown $path: $!\n";
400 Net::Server::Daemonize::create_pid_file($path);