Daemon: new option to change user/group (setuid/setgid)
[pve-common.git] / data / PVE / Daemon.pm
1 package PVE::Daemon;
2
3 # Abstract class to implement Daemons
4 #
5 # Features:
6 # * lock and write PID file /var/run/$name.pid to make sure onyl
7 #   one instance is running.
8 # * keep lock open during restart
9 # * correctly daemonize (redirect STDIN/STDOUT)
10 # * restart by stop/start, exec, or signal HUP
11 # * daemon restart on error (option 'restart_on_error')
12 # * handle worker processes (option 'max_workers')
13 # * allow to restart while workers are still runningl
14 #   (option 'leave_children_open_on_reload')
15 # * run as different user using setuid/setgid
16  
17 use strict;
18 use warnings;
19 use English;
20
21 use PVE::SafeSyslog;
22 use PVE::INotify;
23
24 use POSIX ":sys_wait_h";
25 use Fcntl ':flock';
26 use Socket qw(IPPROTO_TCP TCP_NODELAY SOMAXCONN);
27 use IO::Socket::INET;
28
29 use Getopt::Long;
30 use Time::HiRes qw (gettimeofday);
31
32 use base qw(PVE::CLIHandler);
33
34 $ENV{'PATH'} = '/sbin:/bin:/usr/sbin:/usr/bin';
35
36 my $daemon_initialized = 0; # we only allow one instance
37
38 my $close_daemon_lock = sub {
39     my ($self) = @_;
40
41     return if !$self->{daemon_lock_fh};
42
43     close $self->{daemon_lock_fh};
44     delete $self->{daemon_lock_fh};
45 };
46
47 my $log_err = sub {
48     my ($msg) = @_;
49     chomp $msg;
50     print STDERR "$msg\n";
51     syslog('err', "%s", $msg);
52 };
53
54 # call this if you fork() from child
55 # Note: we already call this for workers, so it is only required
56 # if you fork inside a simple daemon (max_workers == 0).
57 sub after_fork_cleanup {
58     my ($self) = @_;
59
60     &$close_daemon_lock($self);
61
62     PVE::INotify::inotify_close();
63
64     for my $sig (qw(CHLD HUP INT TERM QUIT)) {
65         $SIG{$sig} = 'DEFAULT'; # restore default handler
66         # AnyEvent signals only works if $SIG{XX} is 
67         # undefined (perl event loop)
68         delete $SIG{$sig}; # so that we can handle events with AnyEvent
69     }
70 }
71
72 my $lockpidfile = sub {
73     my ($self) = @_;
74
75     my $lkfn = $self->{pidfile} . ".lock";
76
77     my $waittime = 0;
78
79     if (my $fd = $self->{env_pve_lock_fd}) {
80
81         $self->{daemon_lock_fh} = IO::Handle->new_from_fd($fd, "a");
82         
83     } else {
84
85         $waittime = 5;
86         $self->{daemon_lock_fh} = IO::File->new(">>$lkfn");
87     }
88
89     if (!$self->{daemon_lock_fh}) {
90         die "can't open lock '$lkfn' - $!\n";
91     }
92
93     for (my $i = 0; $i < $waittime; $i ++) {
94         return if flock ($self->{daemon_lock_fh}, LOCK_EX|LOCK_NB);
95         sleep(1);
96     }
97
98     if (!flock ($self->{daemon_lock_fh}, LOCK_EX|LOCK_NB)) {
99         &$close_daemon_lock($self);
100         my $err = $!;
101
102         my ($running, $pid) = $self->running();
103         if ($running) {
104             die "can't aquire lock '$lkfn' - daemon already started (pid = $pid)\n";
105         } else {
106             die "can't aquire lock '$lkfn' - $err\n";
107         }
108     }
109 };
110
111 my $writepidfile = sub {
112     my ($self) = @_;
113
114     my $pidfile = $self->{pidfile};
115
116     die "can't open pid file '$pidfile' - $!\n" if !open (PIDFH, ">$pidfile");
117
118     print PIDFH "$$\n";
119     close (PIDFH);
120 };
121
122 my $server_cleanup = sub {
123     my ($self) = @_;
124
125     unlink $self->{pidfile} . ".lock";
126     unlink $self->{pidfile};
127 };
128
129 my $finish_workers = sub {
130     my ($self) = @_;
131
132     foreach my $id (qw(workers old_workers)) {
133         foreach my $cpid (keys %{$self->{$id}}) {
134             my $waitpid = waitpid($cpid, WNOHANG);
135             if (defined($waitpid) && ($waitpid == $cpid)) {
136                 delete ($self->{$id}->{$cpid});
137                 syslog('info', "worker $cpid finished");
138             }
139         }
140     }
141 };
142
143 my $start_workers = sub {
144     my ($self) = @_;
145
146     return if $self->{terminate};
147
148     my $count = 0;
149     foreach my $cpid (keys %{$self->{workers}}) {
150         $count++;
151     }
152
153     my $need = $self->{max_workers} - $count;
154
155     return if $need <= 0;
156
157     syslog('info', "starting $need worker(s)");
158
159     while ($need > 0) {
160         my $pid = fork;
161
162         if (!defined ($pid)) {
163             syslog('err', "can't fork worker");
164             sleep (1);
165         } elsif ($pid) { # parent
166             $self->{workers}->{$pid} = 1;
167             syslog('info', "worker $pid started");
168             $need--;
169         } else {
170             $0 = "$self->{name} worker";
171
172             $self->after_fork_cleanup();
173
174             eval { $self->run(); };
175             if (my $err = $@) {
176                 syslog('err', $err);
177                 sleep(5); # avoid fast restarts
178             }
179
180             syslog('info', "worker exit");
181             exit (0);
182         }
183     }
184 };
185
186 my $terminate_server = sub {
187     my ($self, $allow_open_children) = @_;
188
189     $self->{terminate} = 1; # set flag to avoid worker restart
190
191     if (!$self->{max_workers}) {
192         eval { $self->shutdown(); };
193         warn $@ if $@;
194         return;
195     }
196
197     eval { $self->shutdown(); };
198     warn $@ if $@;
199
200     # we have workers - send TERM signal
201
202     foreach my $cpid (keys %{$self->{workers}}) {
203         kill(15, $cpid); # TERM childs
204     }
205
206     # if configured, leave children running on HUP
207     return if $allow_open_children &&
208         $self->{leave_children_open_on_reload};
209
210     # else, send TERM to old workers
211     foreach my $cpid (keys %{$self->{old_workers}}) {
212         kill(15, $cpid); # TERM childs
213     }
214
215     # nicely shutdown childs (give them max 10 seconds to shut down)
216     my $previous_alarm = alarm(10);
217     eval {
218         local $SIG{ALRM} = sub { die "timeout\n" };
219
220         while ((my $pid = waitpid (-1, 0)) > 0) {
221             foreach my $id (qw(workers old_workers)) {
222                 if (defined($self->{$id}->{$pid})) {
223                     delete($self->{$id}->{$pid});
224                     syslog('info', "worker $pid finished");
225                 }
226             }
227         }
228         alarm(0); # avoid race condition
229     };
230     my $err = $@;
231
232     alarm ($previous_alarm);
233
234     if ($err) {
235         syslog('err', "error stopping workers (will kill them now) - $err");
236         foreach my $id (qw(workers old_workers)) {
237             foreach my $cpid (keys %{$self->{$id}}) {
238                 # KILL childs still alive!
239                 if (kill (0, $cpid)) {
240                     delete($self->{$id}->{$cpid});
241                     syslog("err", "kill worker $cpid");
242                     kill(9, $cpid);
243                     # fixme: waitpid?
244                 }
245             }
246         }
247     }
248 };
249
250 my $server_run = sub {
251     my ($self, $debug) = @_;
252
253     # fixme: handle restart lockfd
254     &$lockpidfile($self);
255
256     # remove FD_CLOEXEC bit to reuse on exec
257     $self->{daemon_lock_fh}->fcntl(Fcntl::F_SETFD(), 0);
258
259     $ENV{PVE_DAEMON_LOCK_FD} = $self->{daemon_lock_fh}->fileno;
260
261     # run in background
262     my $spid;
263
264     $self->{debug} = 1 if $debug;
265
266     $self->init();
267
268     if (!$debug) {
269         open STDIN,  '</dev/null' || die "can't read /dev/null";
270         open STDOUT, '>/dev/null' || die "can't write /dev/null";
271     }
272
273     if (!$self->{env_restart_pve_daemon} && !$debug) {
274         PVE::INotify::inotify_close();
275         $spid = fork();
276         if (!defined ($spid)) {
277             die "can't put server into background - fork failed";
278         } elsif ($spid) { # parent
279             exit (0);
280         }
281         PVE::INotify::inotify_init();
282     }
283
284     if ($self->{env_restart_pve_daemon}) {
285         syslog('info' , "restarting server");
286     } else {
287         &$writepidfile($self);
288         syslog('info' , "starting server");
289     }
290
291     POSIX::setsid(); 
292
293     open STDERR, '>&STDOUT' || die "can't close STDERR\n";
294
295     my $old_sig_term = $SIG{TERM};
296     local $SIG{TERM} = sub {
297         local ($@, $!, $?); # do not overwrite error vars
298         syslog('info', "received signal TERM");
299         &$terminate_server($self, 0);
300         &$server_cleanup($self);
301         &$old_sig_term(@_) if $old_sig_term;
302     };
303
304     my $old_sig_quit = $SIG{QUIT};
305     local $SIG{QUIT} = sub {
306         local ($@, $!, $?); # do not overwrite error vars
307         syslog('info', "received signal QUIT");
308         &$terminate_server($self, 0);
309         &$server_cleanup($self);
310         &$old_sig_quit(@_) if $old_sig_quit;
311     };
312
313     my $old_sig_int = $SIG{INT};
314     local $SIG{INT} = sub {
315         local ($@, $!, $?); # do not overwrite error vars
316         syslog('info', "received signal INT");
317         $SIG{INT} = 'DEFAULT'; # allow to terminate now
318         &$terminate_server($self, 0);
319         &$server_cleanup($self);
320         &$old_sig_int(@_) if $old_sig_int;
321     };
322
323     $SIG{HUP} = sub {
324         local ($@, $!, $?); # do not overwrite error vars
325         syslog('info', "received signal HUP");
326         $self->{got_hup_signal} = 1;
327         if ($self->{max_workers}) {
328             &$terminate_server($self, 1);
329         } elsif ($self->can('hup')) {
330             eval { $self->hup() };
331             warn $@ if $@;
332         }
333     };
334
335     eval { 
336         if ($self->{max_workers}) {
337             my $old_sig_chld = $SIG{CHLD};
338             local $SIG{CHLD} = sub {
339                 local ($@, $!, $?); # do not overwrite error vars
340                 &$finish_workers($self);
341                 &$old_sig_chld(@_) if $old_sig_chld;
342             };
343
344             # catch worker finished during restart phase 
345             &$finish_workers($self);
346
347             # now loop forever (until we receive terminate signal)
348             for (;;) { 
349                 &$start_workers($self);
350                 sleep(5);
351                 &$finish_workers($self);
352                 last if $self->{terminate};
353             }
354
355         } else {
356             $self->run();
357         } 
358     };
359     my $err = $@;
360
361     if ($err) {
362         syslog ('err', "ERROR: $err");
363
364         &$terminate_server($self, 1);
365
366         if (my $wait_time = $self->{restart_on_error}) {
367             $self->restart_daemon($wait_time);
368         } else {
369             $self->exit_daemon(-1);
370         }
371     }
372
373     if ($self->{got_hup_signal}) {
374         $self->restart_daemon();
375     } else {
376         $self->exit_daemon(0);
377     }
378 };
379
380 sub new {
381     my ($this, $name, $cmdline, %params) = @_;
382
383     $name = 'daemon' if !$name; # should not happen
384
385     initlog($name);
386
387     my $self;
388
389     eval {
390
391         my $restart = $ENV{RESTART_PVE_DAEMON};
392         delete $ENV{RESTART_PVE_DAEMON};
393
394         my $lockfd = $ENV{PVE_DAEMON_LOCK_FD};
395         delete $ENV{PVE_DAEMON_LOCK_FD};
396
397         if (defined($lockfd)) {
398             die "unable to parse lock fd '$lockfd'\n"
399                 if $lockfd !~ m/^(\d+)$/;
400             $lockfd = $1; # untaint
401         }
402
403         die "please run as root\n" if !$restart && ($> != 0);
404
405         die "can't create more that one PVE::Daemon" if $daemon_initialized;
406         $daemon_initialized = 1;
407
408         PVE::INotify::inotify_init();
409
410         my $class = ref($this) || $this;
411
412         $self = bless { 
413             name => $name,
414             run_dir => '/var/run',
415             env_restart_pve_daemon => $restart,
416             env_pve_lock_fd => $lockfd,
417             workers => {},
418             old_workers => {},
419         }, $class;
420
421         foreach my $opt (keys %params) {
422             my $value = $params{$opt};
423             if ($opt eq 'restart_on_error') {
424                 $self->{$opt} = $value;
425             } elsif ($opt eq 'stop_wait_time') {
426                 $self->{$opt} = $value;
427             } elsif ($opt eq 'run_dir') {
428                 $self->{$opt} = $value;
429             } elsif ($opt eq 'max_workers') {
430                 $self->{$opt} = $value;
431             } elsif ($opt eq 'leave_children_open_on_reload') {
432                 $self->{$opt} = $value;
433             } elsif ($opt eq 'setgid') {
434                 $self->{$opt} = $value;
435             } elsif ($opt eq 'setuid') {
436                 $self->{$opt} = $value;
437             } else {
438                 die "unknown daemon option '$opt'\n";
439             }
440         }
441         
442         if (my $gidstr = $self->{setgid}) {
443             my $gid = getgrnam($gidstr) || die "getgrnam failed - $!\n";
444             POSIX::setgid($gid) || die "setgid $gid failed - $!\n";
445             $EGID = "$gid $gid"; # this calls setgroups
446             # just to be sure
447             die "detected strange gid\n" if !($GID eq "$gid $gid" && $EGID eq "$gid $gid");
448         }
449
450         if (my $uidstr = $self->{setuid}) {
451             my $uid = getpwnam($uidstr) || die "getpwnam failed - $!\n";
452             POSIX::setuid($uid) || die "setuid $uid failed - $!\n";
453             # just to be sure
454             die "detected strange uid\n" if !($UID == $uid && $EUID == $uid);
455         }
456
457         if ($restart && $self->{max_workers}) {
458             if (my $wpids = $ENV{PVE_DAEMON_WORKER_PIDS}) {
459                 foreach my $pid (split(':', $wpids)) {
460                     if ($pid =~ m/^(\d+)$/) {
461                         $self->{old_workers}->{$1} = 1;
462                     }
463                 }
464             }
465         }
466
467         $self->{pidfile} = "$self->{run_dir}/${name}.pid";
468
469         $self->{nodename} = PVE::INotify::nodename();
470
471         $self->{cmdline} = [];
472
473         foreach my $el (@$cmdline) {
474             $el =~ m/^(.*)$/; # untaint
475             push @{$self->{cmdline}}, $1;
476         }
477
478         $0 = $name;
479     };
480     if (my $err = $@) {
481         &$log_err($err);
482         exit(-1);
483     }
484
485     return $self;
486 }
487
488 sub exit_daemon {
489     my ($self, $status) = @_;
490
491     syslog("info", "server stopped");
492
493     &$server_cleanup($self);
494
495     exit($status);
496 }
497
498 sub restart_daemon {
499     my ($self, $waittime) = @_;
500
501     syslog('info', "server shutdown (restart)");
502
503     $ENV{RESTART_PVE_DAEMON} = 1;
504
505     if ($self->{max_workers}) {
506         my @workers = keys %{$self->{workers}};
507         push @workers, keys %{$self->{old_workers}};
508         $ENV{PVE_DAEMON_WORKER_PIDS} = join(':', @workers);
509     }
510
511     sleep($waittime) if $waittime; # avoid high server load due to restarts
512
513     PVE::INotify::inotify_close();
514
515     exec (@{$self->{cmdline}});
516
517     exit (-1); # never reached?
518 }
519
520 # please overwrite in subclass
521 # this is called at startup - before forking
522 sub init {
523     my ($self) = @_;
524
525 }
526
527 # please overwrite in subclass
528 sub shutdown {
529     my ($self) = @_;
530
531     syslog('info' , "server closing");
532
533     if (!$self->{max_workers}) {
534         # wait for children
535         1 while (waitpid(-1, POSIX::WNOHANG()) > 0);
536     }
537 }
538
539 # please define in subclass
540 #sub hup {
541 #    my ($self) = @_;
542 #
543 #    syslog('info' , "received signal HUP (restart)");
544 #}
545
546 # please overwrite in subclass
547 sub run {
548     my ($self) = @_;
549
550     for (;;) { # forever
551         syslog('info' , "server is running");
552         sleep(5);
553     }
554 }
555
556 sub start {
557     my ($self, $debug) = @_;
558
559     eval  { &$server_run($self, $debug); };
560     if (my $err = $@) {
561         &$log_err("start failed - $err");
562         exit(-1);
563     }
564 }
565
566 my $read_pid = sub {
567     my ($self) = @_;
568
569     my $pid_str = PVE::Tools::file_read_firstline($self->{pidfile});
570
571     return 0 if !$pid_str;
572
573     return 0 if $pid_str !~ m/^(\d+)$/; # untaint
574  
575     my $pid = int($1);
576
577     return $pid;
578 };
579
580 sub running {
581     my ($self) = @_;
582
583     my $pid = &$read_pid($self);
584
585     if ($pid) {
586         my $res = PVE::ProcFSTools::check_process_running($pid) ? 1 : 0;
587         return wantarray ? ($res, $pid) : $res;
588     }
589
590     return wantarray ? (0, 0) : 0;
591 }
592
593 sub stop {
594     my ($self) = @_;
595
596     my $pid = &$read_pid($self);
597
598     return if !$pid;
599
600     if (PVE::ProcFSTools::check_process_running($pid)) {
601         kill(15, $pid); # send TERM signal
602         # give some time
603         my $wait_time = $self->{stop_wait_time} || 5;
604         my $running = 1;
605         for (my $i = 0; $i < $wait_time; $i++) {
606             $running = PVE::ProcFSTools::check_process_running($pid);
607             last if !$running;
608             sleep (1);
609         }
610
611         syslog('err', "server still running - send KILL") if $running;
612
613         # to be sure
614         kill(9, $pid);
615         waitpid($pid, 0);
616     }
617
618     if (-f $self->{pidfile}) {
619         eval {
620             # try to get the lock
621             &$lockpidfile($self);
622             &$server_cleanup($self);
623         };
624         if (my $err = $@) {
625             &$log_err("cleanup failed - $err");
626         }
627     }
628 }
629
630 sub register_start_command {
631     my ($self, $description) = @_;
632
633     my $class = ref($self);
634
635     $class->register_method({
636         name => 'start',
637         path => 'start',
638         method => 'POST',
639         description => $description || "Start the daemon.",
640         parameters => {
641             additionalProperties => 0,
642             properties => {
643                 debug => {
644                     description => "Debug mode - stay in foreground",
645                     type => "boolean",
646                     optional => 1,
647                     default => 0,
648                 },
649             },
650         },
651         returns => { type => 'null' },
652
653         code => sub {
654             my ($param) = @_;
655
656             $self->start($param->{debug});
657
658             return undef;
659         }});  
660 }
661
662 my $reload_daemon = sub {
663     my ($self, $use_hup) = @_;
664
665     if ($self->{env_restart_pve_daemon}) {
666         $self->start();
667     } else {
668         my ($running, $pid) = $self->running(); 
669         if (!$running) {
670             $self->start();
671         } else {
672             if ($use_hup) {
673                 syslog('info', "send HUP to $pid");
674                 kill 1, $pid;
675             } else {
676                 $self->stop();
677                 $self->start();
678             }
679         }
680     }
681 };
682
683 sub register_restart_command {
684     my ($self, $use_hup, $description) = @_;
685
686     my $class = ref($self);
687
688     $class->register_method({
689         name => 'restart',
690         path => 'restart',
691         method => 'POST',
692         description => $description || "Restart the daemon (or start if not running).",
693         parameters => {
694             additionalProperties => 0,
695             properties => {},
696         },
697         returns => { type => 'null' },
698
699         code => sub {
700             my ($param) = @_;
701
702             &$reload_daemon($self, $use_hup);
703
704             return undef;
705         }});               
706 }
707
708 sub register_reload_command {
709     my ($self, $description) = @_;
710
711     my $class = ref($self);
712
713     $class->register_method({
714         name => 'reload',
715         path => 'reload',
716         method => 'POST',
717         description => $description || "Reload daemon configuration (or start if not running).",
718         parameters => {
719             additionalProperties => 0,
720             properties => {},
721         },
722         returns => { type => 'null' },
723
724         code => sub {
725             my ($param) = @_;
726
727             &$reload_daemon($self, 1);
728
729             return undef;
730         }});               
731 }
732
733 sub register_stop_command {
734     my ($self, $description) = @_;
735
736     my $class = ref($self);
737
738     $class->register_method({
739         name => 'stop',
740         path => 'stop',
741         method => 'POST',
742         description => $description || "Stop the daemon.",
743         parameters => {
744             additionalProperties => 0,
745             properties => {},
746         },
747         returns => { type => 'null' },
748
749         code => sub {
750             my ($param) = @_;
751             
752             $self->stop();
753
754             return undef;
755         }});               
756 }
757
758 sub register_status_command {
759     my ($self, $description) = @_;
760
761     my $class = ref($self);
762
763     $class->register_method({
764         name => 'status',
765         path => 'status',
766         method => 'GET',
767         description => "Get daemon status.",
768         parameters => {
769             additionalProperties => 0,
770             properties => {},
771         },
772         returns => { 
773             type => 'string',
774             enum => ['stopped', 'running'],
775         },
776         code => sub {
777             my ($param) = @_;
778
779             return $self->running() ? 'running' : 'stopped';
780         }});
781 }
782
783 # some useful helper
784
785 sub create_reusable_socket {
786     my ($self, $port, $host) = @_;
787
788     die "no port specifed" if !$port;
789
790     my ($socket, $sockfd);
791
792     if (defined($sockfd = $ENV{"PVE_DAEMON_SOCKET_$port"}) &&
793         $self->{env_restart_pve_daemon}) {
794
795         die "unable to parse socket fd '$sockfd'\n" 
796             if $sockfd !~ m/^(\d+)$/;
797         $sockfd = $1; # untaint
798
799         $socket = IO::Socket::INET->new;
800         $socket->fdopen($sockfd, 'w') || 
801             die "cannot fdopen file descriptor '$sockfd' - $!\n";
802
803     } else {
804
805         $socket = IO::Socket::INET->new(
806             LocalAddr => $host,
807             LocalPort => $port,
808             Listen => SOMAXCONN,
809             Proto  => 'tcp',
810             ReuseAddr => 1) ||
811             die "unable to create socket - $@\n";
812
813         # we often observe delays when using Nagle algorithm,
814         # so we disable that to maximize performance
815         setsockopt($socket, IPPROTO_TCP, TCP_NODELAY, 1);
816
817         $ENV{"PVE_DAEMON_SOCKET_$port"} = $socket->fileno;
818     }
819
820     # remove FD_CLOEXEC bit to reuse on exec
821     $socket->fcntl(Fcntl::F_SETFD(), 0);
822     
823     return $socket;
824 }
825
826
827 1;
828