improve doc

[pve-common.git] / data / PVE / Daemon.pm

diff --git a/data/PVE/Daemon.pm b/data/PVE/Daemon.pm
index 53fe519e2e92a535e2ad8076ae452ab60ec4dd2e..279a78c1f36fce16394c9b06b3b9bba6963061c2 100644 (file)
--- a/data/PVE/Daemon.pm
+++ b/data/PVE/Daemon.pm
@@ -6,7 +6,9 @@ package PVE::Daemon;
 # * lock and write PID file /var/run/$name.pid to make sure onyl
 #   one instance is running.
 # * correctly daemonize (redirect STDIN/STDOUT)
-# * daemon restart (option 'restart_on_error')
+# * restart by stop/start, exec, or signal HUP
+# * daemon restart on error (option 'restart_on_error')
+#
 
 use strict;
 use warnings;
@@ -126,13 +128,15 @@ my $server_run = sub {
        warn $@ if $@;
 
        &$server_cleanup($self);
-   };
-
-    $SIG{HUP} = sub {
-       eval { $self->hup(); };
-       warn $@ if $@;
     };
 
+    if ($self->can('hup')) {
+       $SIG{HUP} = sub {
+           eval { $self->hup() };
+           warn $@ if $@;
+       };
+    }
+
     eval { $self->run() };
     my $err = $@;
 
@@ -164,15 +168,10 @@ sub new {
 
     my $class = ref($this) || $this;
 
-    my $self = bless { name => $name }, $class;
-
-    $self->{pidfile} = "/var/run/${name}.pid";
-
-    $self->{nodename} = PVE::INotify::nodename();
-
-    $self->{cmdline} = $cmdline;
-
-    $0 = $name;
+    my $self = bless { 
+       name => $name,
+       run_dir => '/var/run',
+    }, $class;
 
     foreach my $opt (keys %params) {
        my $value = $params{$opt};
@@ -180,11 +179,22 @@ sub new {
            $self->{$opt} = $value;
        } elsif ($opt eq 'stop_wait_time') {
            $self->{$opt} = $value;
+       } elsif ($opt eq 'run_dir') {
+           $self->{$opt} = $value;
        } else {
            die "unknown option '$opt'";
        }
     }
 
+    $self->{pidfile} = "$self->{run_dir}/${name}.pid";
+
+    $self->{nodename} = PVE::INotify::nodename();
+
+    $self->{cmdline} = $cmdline;
+
+    $0 = $name;
+
+
     return $self;
 }
 
@@ -231,12 +241,12 @@ sub shutdown {
     1 while (waitpid(-1, POSIX::WNOHANG()) > 0);
 }
 
-# please overwrite in subclass
-sub hup {
-    my ($self) = @_;
-
-    syslog('info' , "received signal HUP (restart)");
-}
+# please define in subclass
+#sub hup {
+#    my ($self) = @_;
+#
+#    syslog('info' , "received signal HUP (restart)");
+#}
 
 # please overwrite in subclass
 sub run {
@@ -254,10 +264,24 @@ sub start {
     &$server_run($self, $debug);
 }
 
+my $read_pid = sub {
+    my ($self) = @_;
+
+    my $pid_str = PVE::Tools::file_read_firstline($self->{pidfile});
+
+    return 0 if !$pid_str;
+
+    return 0 if $pid_str !~ m/^(\d+)$/; # untaint
+ 
+    my $pid = int($1);
+
+    return $pid;
+};
+
 sub running {
     my ($self) = @_;
 
-    my $pid = int(PVE::Tools::file_read_firstline($self->{pidfile}) || 0);
+    my $pid = &$read_pid($self);
 
     if ($pid) {
        my $res = PVE::ProcFSTools::check_process_running($pid) ? 1 : 0;
@@ -270,7 +294,8 @@ sub running {
 sub stop {
     my ($self) = @_;
 
-    my $pid = int(PVE::Tools::file_read_firstline($self->{pidfile}) || 0);
+    my $pid = &$read_pid($self);
+
     return if !$pid;
 
     if (PVE::ProcFSTools::check_process_running($pid)) {
@@ -328,8 +353,28 @@ sub register_start_command {
        }});  
 }
 
+my $reload_daemon = sub {
+    my ($self, $use_hup) = @_;
+
+    if (my $restart = $ENV{RESTART_PVE_DAEMON}) {
+       $self->start();
+    } else {
+       my ($running, $pid) = $self->running(); 
+       if (!$running) {
+           $self->start();
+       } else {
+           if ($use_hup) {
+               kill(1, $pid);
+           } else {
+               $self->stop();
+               $self->start();
+           }
+       }
+    }
+};
+
 sub register_restart_command {
-    my ($self, $class, $description) = @_;
+    my ($self, $class, $use_hup, $description) = @_;
 
     $class->register_method({
        name => 'restart',
@@ -345,16 +390,30 @@ sub register_restart_command {
        code => sub {
            my ($param) = @_;
 
-           if (my $restart = $ENV{RESTART_PVE_DAEMON}) {
-               $self->start();
-           } else {
-               my ($running, $pid) = $self->running(); 
-               if (!$running) {
-                   $self->start();
-               } else {
-                   kill(1, $pid);
-               }
-           }
+           &$reload_daemon($self, $use_hup);
+
+           return undef;
+       }});               
+}
+
+sub register_reload_command {
+    my ($self, $class, $description) = @_;
+
+    $class->register_method({
+       name => 'reload',
+       path => 'reload',
+       method => 'POST',
+       description => $description || "Reload daemon configuration (or start if not running).",
+       parameters => {
+           additionalProperties => 0,
+           properties => {},
+       },
+       returns => { type => 'null' },
+
+       code => sub {
+           my ($param) = @_;
+
+           &$reload_daemon($self, 1);
 
            return undef;
        }});