src/PVE/HA/Tools.pm

   1 package PVE::HA::Tools;
   2
   3 use strict;
   4 use warnings;
   5 use JSON;
   6
   7 use PVE::JSONSchema;
   8 use PVE::Tools;
   9 use PVE::ProcFSTools;
  10
  11 # return codes used in the ha environment
  12 # mainly by the resource agents
  13 use constant {
  14     SUCCESS => 0, # action finished as expected
  15     ERROR => 1, # action was erroneous
  16     ETRY_AGAIN => 2, # action was erroneous and needs to be repeated
  17     EWRONG_NODE => 3, # needs to fixup the service location
  18     EUNKNOWN_SERVICE_TYPE => 4, # no plugin for this type service found
  19     EUNKNOWN_COMMAND => 5,
  20     EINVALID_PARAMETER => 6,
  21     EUNKNOWN_SERVICE => 7, # service not found
  22 };
  23
  24 # get constants out of package in a somewhat easy way
  25 use base 'Exporter';
  26 our @EXPORT_OK = qw(SUCCESS ERROR EWRONG_NODE EUNKNOWN_SERVICE_TYPE
  27  EUNKNOWN_COMMAND EINVALID_PARAMETER ETRY_AGAIN EUNKNOWN_SERVICE);
  28 our %EXPORT_TAGS = ( 'exit_codes' => [@EXPORT_OK] );
  29
  30 PVE::JSONSchema::register_format('pve-ha-resource-id', \&pve_verify_ha_resource_id);
  31 sub pve_verify_ha_resource_id {
  32     my ($sid, $noerr) = @_;
  33
  34     if ($sid !~ m/^[a-z]+:\S+$/) {
  35         return undef if $noerr;
  36         die "value does not look like a valid ha resource id\n";
  37     }
  38     return $sid;
  39 }
  40
  41 PVE::JSONSchema::register_standard_option('pve-ha-resource-id', {
  42     description => "HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100).",
  43     typetext => "<type>:<name>",
  44     type => 'string', format => 'pve-ha-resource-id',
  45 });
  46
  47 PVE::JSONSchema::register_format('pve-ha-resource-or-vm-id', \&pve_verify_ha_resource_or_vm_id);
  48 sub pve_verify_ha_resource_or_vm_id {
  49     my ($sid, $noerr) = @_;
  50
  51     if ($sid !~ m/^([a-z]+:\S+|\d+)$/) {
  52         return undef if $noerr;
  53         die "value does not look like a valid ha resource id\n";
  54     }
  55     return $sid;
  56 }
  57
  58 PVE::JSONSchema::register_standard_option('pve-ha-resource-or-vm-id', {
  59     description => "HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).",
  60     typetext => "<type>:<name>",
  61     type => 'string', format => 'pve-ha-resource-or-vm-id',
  62 });
  63
  64 PVE::JSONSchema::register_format('pve-ha-group-node', \&pve_verify_ha_group_node);
  65 sub pve_verify_ha_group_node {
  66     my ($node, $noerr) = @_;
  67
  68     if ($node !~ m/^([a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?)(:\d+)?$/) {
  69         return undef if $noerr;
  70         die "value does not look like a valid ha group node\n";
  71     }
  72     return $node;
  73 }
  74
  75 PVE::JSONSchema::register_standard_option('pve-ha-group-node-list', {
  76     description => "List of cluster node names with optional priority.",
  77     verbose_description => "List of cluster node members, where a priority can be given to each node. A resource bound to a group will run on the available nodes with the highest priority. If there are more nodes in the highest priority class, the services will get distributed to those nodes. The priorities have a relative meaning only.",
  78     type => 'string', format => 'pve-ha-group-node-list',
  79     typetext => '<node>[:<pri>]{,<node>[:<pri>]}*',
  80 });
  81
  82 PVE::JSONSchema::register_standard_option('pve-ha-group-id', {
  83     description => "The HA group identifier.",
  84     type => 'string', format => 'pve-configid',
  85 });
  86
  87 sub read_json_from_file {
  88     my ($filename, $default) = @_;
  89
  90     my $data;
  91
  92     if (defined($default) && (! -f $filename)) {
  93         $data = $default;
  94     } else {
  95         my $raw = PVE::Tools::file_get_contents($filename);
  96         $data = decode_json($raw);
  97     }
  98
  99     return $data;
 100 }
 101
 102 sub write_json_to_file {
 103     my ($filename, $data) = @_;
 104
 105     my $raw = encode_json($data);
 106
 107     PVE::Tools::file_set_contents($filename, $raw);
 108 }
 109
 110 sub count_fenced_services {
 111     my ($ss, $node) = @_;
 112
 113     my $count = 0;
 114
 115     foreach my $sid (keys %$ss) {
 116         my $sd = $ss->{$sid};
 117         next if !$sd->{node};
 118         next if $sd->{node} ne $node;
 119         my $req_state = $sd->{state};
 120         next if !defined($req_state);
 121         if ($req_state eq 'fence') {
 122             $count++;
 123             next;
 124         }
 125     }
 126
 127     return $count;
 128 }
 129
 130 sub get_verbose_service_state {
 131     my ($service_state, $service_conf) = @_;
 132
 133     my $req = $service_conf->{state} // 'ignored';
 134     return 'ignored' if $req eq 'ignored';
 135
 136     return 'not found' if !defined($service_conf->{node});
 137
 138     # service not yet processed by manager
 139     return 'queued' if !defined($service_state);
 140     my $cur = $service_state->{state};
 141
 142     # give fast feedback to the user
 143     my $state = $cur;
 144     if (!defined($cur)) {
 145         $state = 'queued';
 146     } elsif ($cur eq 'stopped') {
 147         if ($req eq 'started') {
 148             $state = 'starting';
 149         } elsif ($req eq 'disabled') {
 150             $state = 'disabled';
 151         }
 152     } elsif ($cur eq 'started') {
 153         if ($req eq 'stopped' || $req eq 'disabled') {
 154             $state = 'stopping';
 155         }
 156         $state = 'starting' if !$service_state->{running};
 157     } elsif ($cur eq 'error') {
 158         if ($req eq 'disabled') {
 159             $state = 'clearing error flag';
 160         }
 161     }
 162
 163     return $state;
 164 }
 165
 166 sub upid_wait {
 167     my ($upid, $haenv) = @_;
 168
 169     my $waitfunc = sub {
 170         my $task = PVE::Tools::upid_encode(shift);
 171         $haenv->log('info', "Task '$task' still active, waiting");
 172     };
 173
 174     PVE::ProcFSTools::upid_wait($upid, $waitfunc, 5);
 175 }
 176
 177 # bash auto completion helper
 178
 179 # NOTE: we use PVE::HA::Config here without declaring an 'use' clause above as
 180 # an hack. It uses the PVE::Cluster module from pve-cluster, which we do not
 181 # have nor want as dependency in the simulator - where the completion helpers
 182 # are never called. The PVE::CLI::ha_manager package pulls it in for us.
 183
 184 sub complete_sid {
 185     my ($cmd, $pname, $cur) = @_;
 186
 187     my $cfg = PVE::HA::Config::read_resources_config();
 188
 189     my $res = [];
 190
 191     if ($cmd eq 'add') {
 192
 193         my $vmlist = PVE::Cluster::get_vmlist();
 194
 195         while (my ($vmid, $info) = each %{$vmlist->{ids}}) {
 196
 197             my $sid;
 198
 199             if ($info->{type} eq 'lxc') {
 200                 $sid = "ct:$vmid";
 201             } elsif ($info->{type} eq 'qemu') {
 202                 $sid = "vm:$vmid";
 203             } else {
 204                 next; # should not happen
 205             }
 206
 207             next if $cfg->{ids}->{$sid};
 208
 209             push @$res, $sid;
 210         }
 211
 212     } else {
 213
 214         foreach my $sid (keys %{$cfg->{ids}}) {
 215             push @$res, $sid;
 216         }
 217     }
 218
 219     return $res;
 220 }
 221
 222 sub complete_enabled_sid {
 223     my $cfg = PVE::HA::Config::read_resources_config();
 224
 225     my $res = [];
 226     foreach my $sid (keys %{$cfg->{ids}}) {
 227         my $state = $cfg->{ids}->{$sid}->{state} // 'started';
 228         next if $state ne 'started';
 229         push @$res, $sid;
 230     }
 231
 232     return $res;
 233 }
 234
 235 sub complete_disabled_sid {
 236     my $cfg = PVE::HA::Config::read_resources_config();
 237
 238     my $res = [];
 239     foreach my $sid (keys %{$cfg->{ids}}) {
 240         my $state = $cfg->{ids}->{$sid}->{state} // 'started';
 241         next if $state eq 'started';
 242         push @$res, $sid;
 243     }
 244
 245     return $res;
 246 }
 247
 248 sub complete_group {
 249     my ($cmd, $pname, $cur) = @_;
 250
 251     my $cfg = PVE::HA::Config::read_group_config();
 252
 253     my $res = [];
 254     if ($cmd ne 'groupadd') {
 255
 256         foreach my $group (keys %{$cfg->{ids}}) {
 257             push @$res, $group;
 258         }
 259
 260     }
 261
 262     return $res;
 263 }
 264
 265 1;