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/;
14 require Danga::Socket;
16 require PublicInbox::Listener;
19 my (@cfg_listen, $stdout, $stderr, $group, $user, $pid_file, $daemonize);
20 my $worker_processes = 1;
27 END { $cleanup->() if $cleanup };
29 sub daemon_prepare ($) {
30 my ($default_listen) = @_;
32 $SIG{HUP} = $SIG{USR1} = $SIG{USR2} = $SIG{PIPE} =
33 $SIG{TTIN} = $SIG{TTOU} = $SIG{WINCH} = 'IGNORE';
35 'l|listen=s' => \@cfg_listen,
36 '1|stdout=s' => \$stdout,
37 '2|stderr=s' => \$stderr,
38 'W|worker-processes=i' => \$worker_processes,
39 'P|pid-file=s' => \$pid_file,
41 'g|group=s' => \$group,
42 'D|daemonize' => \$daemonize,
44 GetOptions(%opts) or die "bad command-line args\n";
46 if (defined $pid_file && $pid_file =~ /\.oldbin\z/) {
47 die "--pid-file cannot end with '.oldbin'\n";
49 @listeners = inherit();
50 # ignore daemonize when inheriting
51 $daemonize = undef if scalar @listeners;
53 push @cfg_listen, $default_listen unless (@listeners || @cfg_listen);
55 foreach my $l (@cfg_listen) {
56 next if $listener_names{$l}; # already inherited
57 require IO::Socket::INET6; # works for IPv4, too
63 if (my $s = IO::Socket::INET6->new(%o)) {
64 $listener_names{sockname($s)} = $s;
67 warn "error binding $l: $!\n";
70 die 'No listeners bound' unless @listeners;
74 chdir '/' or die "chdir failed: $!\n";
75 open(STDIN, '+<', '/dev/null') or die "redirect stdin failed: $!\n";
77 return unless (defined $pid_file || defined $group || defined $user
80 require Net::Server::Daemonize;
82 Net::Server::Daemonize::check_pid_file($pid_file) if defined $pid_file;
83 $uid = Net::Server::Daemonize::get_uid($user) if defined $user;
85 $gid = Net::Server::Daemonize::get_gid($group);
86 $gid = (split /\s+/, $gid)[0];
87 } elsif (defined $uid) {
88 $gid = (getpwuid($uid))[3];
91 # We change users in the worker to ensure upgradability,
92 # The upgrade will create the ".oldbin" pid file in the
93 # same directory as the given pid file.
94 $uid and $set_user = sub {
95 Net::Server::Daemonize::set_user($uid, $gid);
99 my ($pid, $err) = do_fork();
100 die "could not fork: $err\n" unless defined $pid;
103 open STDOUT, '>&STDIN' or die "redirect stdout failed: $!\n";
104 open STDERR, '>&STDIN' or die "redirect stderr failed: $!\n";
106 ($pid, $err) = do_fork();
107 die "could not fork: $err\n" unless defined $pid;
110 if (defined $pid_file) {
111 write_pid($pid_file);
114 unlink_pid_file_safe_ish($unlink_pid, $pid_file);
120 # killing again terminates immediately:
121 exit unless @listeners;
125 # give slow clients 30s to finish reading/writing whatever
126 Danga::Socket->AddTimer(30, sub { exit });
128 # drop idle connections and try to quit gracefully
129 Danga::Socket->SetPostLoopCallback(sub {
130 my ($dmap, undef) = @_;
133 foreach my $s (values %$dmap) {
134 if ($s->can('busy') && $s->busy) {
137 # close as much as possible, early as possible
141 $n; # true: loop continues, false: loop breaks
147 open STDOUT, '>>', $stdout or
148 warn "failed to redirect stdout to $stdout: $!\n";
149 STDOUT->autoflush(1);
153 open STDERR, '>>', $stderr or
154 warn "failed to redirect stderr to $stderr: $!\n";
155 STDERR->autoflush(1);
162 my $n = getsockname($s) or return;
164 if (length($n) >= 28) {
166 ($port, $addr) = Socket6::unpack_sockaddr_in6($n);
168 ($port, $addr) = Socket::sockaddr_in($n);
170 if (length($addr) == 4) {
171 $n = Socket::inet_ntoa($addr)
173 $n = '['.Socket6::inet_ntop(Socket6::AF_INET6(), $addr).']';
179 return () if ($ENV{LISTEN_PID} || 0) != $$;
180 my $fds = $ENV{LISTEN_FDS} or return ();
181 my $end = $fds + 2; # LISTEN_FDS_START - 1
183 foreach my $fd (3..$end) {
184 my $s = IO::Handle->new;
185 $s->fdopen($fd, 'r');
186 if (my $k = sockname($s)) {
187 $listener_names{$k} = $s;
190 warn "failed to inherit fd=$fd (LISTEN_FDS=$fds)";
198 warn "upgrade in-progress: $reexec_pid\n";
201 if (defined $pid_file) {
202 if ($pid_file =~ /\.oldbin\z/) {
203 warn "BUG: .oldbin suffix exists: $pid_file\n";
206 unlink_pid_file_safe_ish($$, $pid_file);
207 $pid_file .= '.oldbin';
208 write_pid($pid_file);
210 my ($pid, $err) = do_fork();
211 unless (defined $pid) {
212 warn "fork failed: $err\n";
216 use Fcntl qw(FD_CLOEXEC F_SETFD F_GETFD);
217 $ENV{LISTEN_FDS} = scalar @listeners;
218 $ENV{LISTEN_PID} = $$;
219 foreach my $s (@listeners) {
220 my $fl = fcntl($s, F_GETFD, 0);
221 fcntl($s, F_SETFD, $fl &= ~FD_CLOEXEC);
224 die "Failed to exec: $!\n";
229 sub kill_workers ($) {
232 while (my ($pid, $id) = each %pids) {
238 my $new = POSIX::SigSet->new;
240 my $old = POSIX::SigSet->new;
241 POSIX::sigprocmask(&POSIX::SIG_BLOCK, $new, $old) or
242 die "SIG_BLOCK: $!\n";
245 POSIX::sigprocmask(&POSIX::SIG_SETMASK, $old) or
246 die "SIG_SETMASK: $!\n";
250 sub upgrade_aborted ($) {
252 warn "reexec PID($p) died with: $?\n";
254 return unless $pid_file;
256 my $file = $pid_file;
257 $file =~ s/\.oldbin\z// or die "BUG: no '.oldbin' suffix in $file\n";
258 unlink_pid_file_safe_ish($$, $pid_file);
260 eval { write_pid($pid_file) };
264 sub reap_children () {
266 my $p = waitpid(-1, &POSIX::WNOHANG) or return;
267 if (defined $reexec_pid && $p == $reexec_pid) {
269 } elsif (defined(my $id = delete $pids{$p})) {
270 warn "worker[$id] PID($p) died with: $?\n";
272 warn "unknown PID($p) reaped: $?\n";
279 sub unlink_pid_file_safe_ish ($$) {
280 my ($unlink_pid, $file) = @_;
281 return unless defined $unlink_pid && $unlink_pid == $$;
283 open my $fh, '<', $file or return;
284 defined(my $read_pid = <$fh>) or return;
286 if ($read_pid == $unlink_pid) {
287 Net::Server::Daemonize::unlink_pid_file($file);
292 pipe(my ($p0, $p1)) or die "failed to create parent-pipe: $!\n";
293 pipe(my ($r, $w)) or die "failed to create self-pipe: $!\n";
294 IO::Handle::blocking($w, 0);
295 my $set_workers = $worker_processes;
298 foreach my $s (qw(HUP CHLD QUIT INT TERM USR1 USR2 TTIN TTOU WINCH)) {
300 return if $$ != $master_pid;
308 while (my $s = shift @caught) {
312 } elsif ($s eq 'USR2') {
314 } elsif ($s =~ /\A(?:QUIT|TERM|INT)\z/) {
315 # drops pipes and causes children to die
317 } elsif ($s eq 'WINCH') {
318 $worker_processes = 0;
319 } elsif ($s eq 'HUP') {
320 $worker_processes = $set_workers;
322 } elsif ($s eq 'TTIN') {
323 if ($set_workers > $worker_processes) {
326 $worker_processes = ++$set_workers;
328 } elsif ($s eq 'TTOU') {
329 if ($set_workers > 0) {
330 $worker_processes = --$set_workers;
332 } elsif ($s eq 'CHLD') {
337 my $n = scalar keys %pids;
338 if ($n > $worker_processes) {
339 while (my ($k, $v) = each %pids) {
340 kill('TERM', $k) if $v >= $worker_processes;
342 $n = $worker_processes;
344 foreach my $i ($n..($worker_processes - 1)) {
345 my ($pid, $err) = do_fork();
347 warn "failed to fork worker[$i]: $err\n";
348 } elsif ($pid == 0) {
349 $set_user->() if $set_user;
350 return $p0; # run normal work code
352 warn "PID=$pid is worker[$i]\n";
356 # just wait on signal events here:
357 sysread($r, my $buf, 8);
359 exit # never gets here, just for documentation
362 sub daemon_loop ($$) {
363 my ($refresh, $post_accept) = @_;
365 if ($worker_processes > 0) {
366 $parent_pipe = master_loop(); # returns if in child process
367 my $fd = fileno($parent_pipe);
368 Danga::Socket->AddOtherFds($fd => sub { kill('TERM', $$) } );
371 $set_user->() if $set_user;
372 $SIG{USR2} = sub { worker_quit() if upgrade() };
377 $SIG{QUIT} = $SIG{INT} = $SIG{TERM} = *worker_quit;
378 $SIG{USR1} = *reopen_logs;
379 $SIG{HUP} = $refresh;
380 # this calls epoll_create:
381 PublicInbox::Listener->new($_, $post_accept) for @listeners;
382 Danga::Socket->EventLoop;
383 $parent_pipe = undef;
387 sub daemon_run ($$$) {
388 my ($default, $refresh, $post_accept) = @_;
389 daemon_prepare($default);
391 daemon_loop($refresh, $post_accept);
396 if (defined $uid and !chown($uid, $gid, $path)) {
397 warn "could not chown $path: $!\n";
403 Net::Server::Daemonize::create_pid_file($path);