3 # Local Resource Manager
7 use POSIX
qw(:sys_wait_h);
11 use PVE
::HA
::Tools
':exit_codes';
12 use PVE
::HA
::Resources
;
14 # Server can have several states:
17 wait_for_agent_lock
=> "waiting for agent lock",
18 active
=> "got agent_lock",
19 maintenance
=> "got agent_lock (maintenance)",
20 lost_agent_lock
=> "lost agent_lock",
24 my ($this, $haenv) = @_;
26 my $class = ref($this) || $this;
30 status
=> { state => 'startup' },
34 shutdown_request
=> 0,
36 # mode can be: active, reboot, shutdown, restart
38 cluster_state_update
=> 0,
41 $self->set_local_status({ state => 'wait_for_agent_lock' });
46 sub shutdown_request
{
49 return if $self->{shutdown_request
}; # already in shutdown mode
51 my $haenv = $self->{haenv
};
53 my $nodename = $haenv->nodename();
55 my ($shutdown, $reboot) = $haenv->is_node_shutdown();
57 my $dc_ha_cfg = $haenv->get_ha_settings();
58 my $shutdown_policy = $dc_ha_cfg->{shutdown_policy
} // 'conditional';
60 if ($shutdown) { # don't log this on service restart, only on node shutdown
61 $haenv->log('info', "got shutdown request with shutdown policy '$shutdown_policy'");
65 if ($shutdown_policy eq 'conditional') {
66 $freeze_all = $reboot;
67 } elsif ($shutdown_policy eq 'freeze') {
69 } elsif ($shutdown_policy eq 'failover') {
72 $haenv->log('err', "unknown shutdown policy '$shutdown_policy', fall back to conditional");
73 $freeze_all = $reboot;
77 # *always* queue stop jobs for all services if the node shuts down,
78 # independent if it's a reboot or a poweroff, else we may corrupt
79 # services or hinder node shutdown
80 my $ss = $self->{service_status
};
82 foreach my $sid (keys %$ss) {
85 next if $sd->{node
} ne $nodename;
86 # Note: use undef uid to mark shutdown/stop jobs
87 $self->queue_resource_command($sid, undef, 'request_stop');
94 $haenv->log('info', "reboot LRM, stop and freeze all services");
96 $haenv->log('info', "shutdown LRM, stop and freeze all services");
98 $self->{mode
} = 'restart';
100 $haenv->log('info', "shutdown LRM, stop all services");
101 $self->{mode
} = 'shutdown';
104 $haenv->log('info', "restart LRM, freeze all services");
105 $self->{mode
} = 'restart';
108 $self->{shutdown_request
} = 1;
110 eval { $self->update_lrm_status(); };
112 $self->log('err', "unable to update lrm status file - $err");
116 sub get_local_status
{
119 return $self->{status
};
122 sub set_local_status
{
123 my ($self, $new) = @_;
125 die "invalid state '$new->{state}'" if !$valid_states->{$new->{state}};
127 my $haenv = $self->{haenv
};
129 my $old = $self->{status
};
131 # important: only update if if really changed
132 return if $old->{state} eq $new->{state};
134 $haenv->log('info', "status change $old->{state} => $new->{state}");
136 $new->{state_change_time
} = $haenv->get_time();
138 $self->{status
} = $new;
141 sub update_lrm_status
{
144 my $haenv = $self->{haenv
};
146 return 0 if !$haenv->quorate();
149 state => $self->{status
}->{state},
150 mode
=> $self->{mode
},
151 results
=> $self->{results
},
152 timestamp
=> $haenv->get_time(),
155 eval { $haenv->write_lrm_status($lrm_status); };
157 $haenv->log('err', "unable to write lrm status file - $err");
164 sub update_service_status
{
167 my $haenv = $self->{haenv
};
169 my $ms = eval { $haenv->read_manager_status(); };
171 $haenv->log('err', "updating service status from manager failed: $err");
174 $self->{service_status
} = $ms->{service_status
} || {};
179 sub get_protected_ha_agent_lock
{
182 my $haenv = $self->{haenv
};
185 my $starttime = $haenv->get_time();
189 if ($haenv->get_ha_agent_lock()) {
190 if ($self->{ha_agent_wd
}) {
191 $haenv->watchdog_update($self->{ha_agent_wd
});
193 my $wfh = $haenv->watchdog_open();
194 $self->{ha_agent_wd
} = $wfh;
199 last if ++$count > 5; # try max 5 time
201 my $delay = $haenv->get_time() - $starttime;
202 last if $delay > 5; # for max 5 seconds
210 sub active_service_count
{
213 my $haenv = $self->{haenv
};
215 my $nodename = $haenv->nodename();
217 my $ss = $self->{service_status
};
221 foreach my $sid (keys %$ss) {
222 my $sd = $ss->{$sid};
223 next if !$sd->{node
};
224 next if $sd->{node
} ne $nodename;
225 my $req_state = $sd->{state};
226 next if !defined($req_state);
227 next if $req_state eq 'stopped';
228 next if $req_state eq 'freeze';
229 # erroneous services are not managed by HA, don't count them as active
230 next if $req_state eq 'error';
238 my $wrote_lrm_status_at_startup = 0;
240 sub do_one_iteration
{
243 my $haenv = $self->{haenv
};
245 $haenv->loop_start_hook();
247 $self->{cluster_state_update
} = $haenv->cluster_state_update();
249 my $res = $self->work();
251 $haenv->loop_end_hook();
259 my $haenv = $self->{haenv
};
261 if (!$wrote_lrm_status_at_startup) {
262 if ($self->update_lrm_status()) {
263 $wrote_lrm_status_at_startup = 1;
267 return $self->{shutdown_request
} ?
0 : 1;
271 my $status = $self->get_local_status();
272 my $state = $status->{state};
274 $self->update_service_status();
276 my $fence_request = PVE
::HA
::Tools
::count_fenced_services
($self->{service_status
}, $haenv->nodename());
278 # do state changes first
280 my $ctime = $haenv->get_time();
284 if ($state eq 'wait_for_agent_lock') {
286 my $service_count = $self->active_service_count();
288 if (!$fence_request && $service_count && $haenv->quorate()) {
289 if ($self->get_protected_ha_agent_lock()) {
290 $self->set_local_status({ state => 'active' });
294 } elsif ($state eq 'lost_agent_lock') {
296 if (!$fence_request && $haenv->quorate()) {
297 if ($self->get_protected_ha_agent_lock()) {
298 $self->set_local_status({ state => 'active' });
302 } elsif ($state eq 'active') {
304 if ($fence_request) {
305 $haenv->log('err', "node need to be fenced - releasing agent_lock\n");
306 $self->set_local_status({ state => 'lost_agent_lock'});
307 } elsif (!$self->get_protected_ha_agent_lock()) {
308 $self->set_local_status({ state => 'lost_agent_lock'});
312 $status = $self->get_local_status();
313 $state = $status->{state};
317 if ($state eq 'wait_for_agent_lock') {
319 return 0 if $self->{shutdown_request
};
321 $self->update_lrm_status();
325 } elsif ($state eq 'active') {
327 my $startime = $haenv->get_time();
333 # do work (max_time seconds)
335 # fixme: set alert timer
337 # if we could not get the current service status there's no point
338 # in doing anything, try again next round.
339 return if !$self->update_service_status();
341 if ($self->{shutdown_request
}) {
343 if ($self->{mode
} eq 'restart') {
345 my $service_count = $self->active_service_count();
347 if ($service_count == 0) {
349 if ($self->run_workers() == 0) {
350 if ($self->{ha_agent_wd
}) {
351 $haenv->watchdog_close($self->{ha_agent_wd
});
352 delete $self->{ha_agent_wd
};
357 # restart with no or freezed services, release the lock
358 $haenv->release_ha_agent_lock();
363 if ($self->run_workers() == 0) {
364 if ($self->{shutdown_errors
} == 0) {
365 if ($self->{ha_agent_wd
}) {
366 $haenv->watchdog_close($self->{ha_agent_wd
});
367 delete $self->{ha_agent_wd
};
370 # shutdown with all services stopped thus release the lock
371 $haenv->release_ha_agent_lock();
378 if (!$self->{cluster_state_update
}) {
379 # update failed but we could still renew our lock (cfs restart?),
380 # safely skip manage and expect to update just fine next round
381 $haenv->log('notice', "temporary inconsistent cluster state " .
382 "(cfs restart?), skip round");
386 $self->manage_resources();
391 $haenv->log('err', "got unexpected error - $err");
394 $self->update_lrm_status();
396 return 0 if $shutdown;
398 $haenv->sleep_until($startime + $max_time);
400 } elsif ($state eq 'lost_agent_lock') {
402 # Note: watchdog is active an will triger soon!
404 # so we hope to get the lock back soon!
406 if ($self->{shutdown_request
}) {
408 my $service_count = $self->active_service_count();
410 if ($service_count > 0) {
411 $haenv->log('err', "get shutdown request in state 'lost_agent_lock' - " .
412 "detected $service_count running services");
414 if ($self->{mode
} eq 'restart') {
415 my $state_mt = $self->{status
}->{state_change_time
};
417 # watchdog should have already triggered, so either it's set
418 # set to noboot or it failed. As we are in restart mode, and
419 # have infinity stoptimeout -> exit now - we don't touch services
420 # or change state, so this is save, relatively speaking
421 if (($haenv->get_time() - $state_mt) > 90) {
422 $haenv->log('err', "lost agent lock and restart request for over 90 seconds - giving up!");
428 # all services are stopped, so we can close the watchdog
430 if ($self->{ha_agent_wd
}) {
431 $haenv->watchdog_close($self->{ha_agent_wd
});
432 delete $self->{ha_agent_wd
};
443 die "got unexpected status '$state'\n";
453 my $haenv = $self->{haenv
};
455 my $starttime = $haenv->get_time();
457 # number of workers to start, if 0 we exec the command directly witouth forking
458 my $max_workers = $haenv->get_max_workers();
460 my $sc = $haenv->read_service_config();
462 while (($haenv->get_time() - $starttime) < 5) {
463 my $count = $self->check_active_workers();
465 foreach my $sid (sort keys %{$self->{workers
}}) {
466 last if $count >= $max_workers && $max_workers > 0;
468 my $w = $self->{workers
}->{$sid};
470 # only fork if we may else call exec_resource_agent
471 # directly (e.g. for regression tests)
472 if ($max_workers > 0) {
474 if (!defined($pid)) {
475 $haenv->log('err', "fork worker failed");
476 $count = 0; last; # abort, try later
477 } elsif ($pid == 0) {
478 $haenv->after_fork(); # cleanup
483 $res = $self->exec_resource_agent($sid, $sc->{$sid}, $w->{state}, $w->{target
});
486 $haenv->log('err', $err);
497 $res = $self->exec_resource_agent($sid, $sc->{$sid}, $w->{state}, $w->{target
});
498 $res = $res << 8 if $res > 0;
501 $haenv->log('err', $err);
503 if (defined($w->{uid
})) {
504 $self->resource_command_finished($sid, $w->{uid
}, $res);
506 $self->stop_command_finished($sid, $res);
517 return scalar(keys %{$self->{workers
}});
520 sub manage_resources
{
523 my $haenv = $self->{haenv
};
525 my $nodename = $haenv->nodename();
527 my $ss = $self->{service_status
};
529 foreach my $sid (keys %{$self->{restart_tries
}}) {
530 delete $self->{restart_tries
}->{$sid} if !$ss->{$sid};
533 foreach my $sid (keys %$ss) {
534 my $sd = $ss->{$sid};
535 next if !$sd->{node
};
537 next if $sd->{node
} ne $nodename;
538 my $req_state = $sd->{state};
539 next if !defined($req_state);
540 next if $req_state eq 'freeze';
541 $self->queue_resource_command($sid, $sd->{uid
}, $req_state, $sd->{target
});
544 return $self->run_workers();
547 sub queue_resource_command
{
548 my ($self, $sid, $uid, $state, $target) = @_;
550 # do not queue the excatly same command twice as this may lead to
551 # an inconsistent HA state when the first command fails but the CRM
552 # does not process its failure right away and the LRM starts a second
553 # try, without the CRM knowing of it (race condition)
554 # The 'stopped' command is an exception as we do not process its result
555 # in the CRM and we want to execute it always (even with no active CRM)
556 return if $state ne 'stopped' && $uid && defined($self->{results
}->{$uid});
558 if (my $w = $self->{workers
}->{$sid}) {
559 return if $w->{pid
}; # already started
560 # else, delete and overwrite queue entry with new command
561 delete $self->{workers
}->{$sid};
564 $self->{workers
}->{$sid} = {
570 $self->{workers
}->{$sid}->{target
} = $target if $target;
573 sub check_active_workers
{
576 # finish/count workers
578 foreach my $sid (keys %{$self->{workers
}}) {
579 my $w = $self->{workers
}->{$sid};
580 if (my $pid = $w->{pid
}) {
582 my $waitpid = waitpid($pid, WNOHANG
);
583 if (defined($waitpid) && ($waitpid == $pid)) {
584 if (defined($w->{uid
})) {
585 $self->resource_command_finished($sid, $w->{uid
}, $?);
587 $self->stop_command_finished($sid, $?);
598 sub stop_command_finished
{
599 my ($self, $sid, $status) = @_;
601 my $haenv = $self->{haenv
};
603 my $w = delete $self->{workers
}->{$sid};
604 return if !$w; # should not happen
609 $haenv->log('err', "resource agent $sid finished - failed to execute");
610 } elsif (my $sig = ($status & 127)) {
611 $haenv->log('err', "resource agent $sid finished - got signal $sig");
613 $exit_code = ($status >> 8);
616 if ($exit_code != 0) {
617 $self->{shutdown_errors
}++;
621 sub resource_command_finished
{
622 my ($self, $sid, $uid, $status) = @_;
624 my $haenv = $self->{haenv
};
626 my $w = delete $self->{workers
}->{$sid};
627 return if !$w; # should not happen
632 $haenv->log('err', "resource agent $sid finished - failed to execute");
633 } elsif (my $sig = ($status & 127)) {
634 $haenv->log('err', "resource agent $sid finished - got signal $sig");
636 $exit_code = ($status >> 8);
639 $exit_code = $self->handle_service_exitcode($sid, $w->{state}, $exit_code);
641 return if $exit_code == ETRY_AGAIN
; # tell nobody, simply retry
643 $self->{results
}->{$uid} = {
645 state => $w->{state},
646 exit_code
=> $exit_code,
649 my $ss = $self->{service_status
};
651 # compute hash of valid/existing uids
653 foreach my $sid (keys %$ss) {
654 my $sd = $ss->{$sid};
656 $valid_uids->{$sd->{uid
}} = 1;
660 foreach my $id (keys %{$self->{results
}}) {
661 next if !$valid_uids->{$id};
662 $results->{$id} = $self->{results
}->{$id};
664 $self->{results
} = $results;
667 # processes the exit code from a finished resource agent, so that the CRM knows
668 # if the LRM wants to retry an action based on the current recovery policies for
669 # the failed service, or the CRM itself must try to recover from the failure.
670 sub handle_service_exitcode
{
671 my ($self, $sid, $cmd, $exit_code) = @_;
673 my $haenv = $self->{haenv
};
674 my $tries = $self->{restart_tries
};
676 my $sc = $haenv->read_service_config();
680 if (my $cd = $sc->{$sid}) {
681 $max_restart = $cd->{max_restart
};
684 if ($cmd eq 'started') {
686 if ($exit_code == SUCCESS
) {
692 } elsif ($exit_code == ERROR
) {
694 $tries->{$sid} = 0 if !defined($tries->{$sid});
696 if ($tries->{$sid} >= $max_restart) {
697 $haenv->log('err', "unable to start service $sid on local node".
698 " after $tries->{$sid} retries");
705 $haenv->log('warning', "restart policy: retry number $tries->{$sid}" .
706 " for service '$sid'");
707 # tell CRM that we retry the start
716 sub exec_resource_agent
{
717 my ($self, $sid, $service_config, $cmd, @params) = @_;
719 # setup execution environment
721 $ENV{'PATH'} = '/sbin:/bin:/usr/sbin:/usr/bin';
723 my $haenv = $self->{haenv
};
725 my $nodename = $haenv->nodename();
727 my (undef, $service_type, $service_name) = $haenv->parse_sid($sid);
729 my $plugin = PVE
::HA
::Resources-
>lookup($service_type);
731 $haenv->log('err', "service type '$service_type' not implemented");
732 return EUNKNOWN_SERVICE_TYPE
;
735 if (!$service_config) {
736 $haenv->log('err', "missing resource configuration for '$sid'");
737 return EUNKNOWN_SERVICE
;
740 # process error state early
741 if ($cmd eq 'error') {
743 $haenv->log('err', "service $sid is in an error state and needs manual " .
744 "intervention. Look up 'ERROR RECOVERY' in the documentation.");
746 return SUCCESS
; # error always succeeds
749 if ($service_config->{node
} ne $nodename) {
750 $haenv->log('err', "service '$sid' not on this node");
754 my $id = $service_name;
756 my $running = $plugin->check_running($haenv, $id);
758 if ($cmd eq 'started') {
760 return SUCCESS
if $running;
762 $haenv->log("info", "starting service $sid");
764 $plugin->start($haenv, $id);
766 $running = $plugin->check_running($haenv, $id);
769 $haenv->log("info", "service status $sid started");
772 $haenv->log("warning", "unable to start service $sid");
776 } elsif ($cmd eq 'request_stop' || $cmd eq 'stopped') {
778 return SUCCESS
if !$running;
780 $haenv->log("info", "stopping service $sid");
782 $plugin->shutdown($haenv, $id);
784 $running = $plugin->check_running($haenv, $id);
787 $haenv->log("info", "service status $sid stopped");
790 $haenv->log("info", "unable to stop stop service $sid (still running)");
794 } elsif ($cmd eq 'migrate' || $cmd eq 'relocate') {
796 my $target = $params[0];
797 if (!defined($target)) {
798 die "$cmd '$sid' failed - missing target\n" if !defined($target);
799 return EINVALID_PARAMETER
;
802 if ($service_config->{node
} eq $target) {
807 my $online = ($cmd eq 'migrate') ?
1 : 0;
809 my $res = $plugin->migrate($haenv, $id, $target, $online);
811 # something went wrong if service is still on this node
813 $haenv->log("err", "service $sid not moved (migration error)");
821 $haenv->log("err", "implement me (cmd '$cmd')");
822 return EUNKNOWN_COMMAND
;