8 use File
::Path
qw(make_path);
13 use Storable
qw(dclone);
21 use PVE
::Tools
qw(run_command);
23 use PVE
::Cluster
::IPCConst
;
33 # x509 certificate utils
35 my $basedir = "/etc/pve";
36 my $authdir = "$basedir/priv";
37 my $lockdir = "/etc/pve/priv/lock";
39 # cfs and corosync files
40 my $dbfile = "/var/lib/pve-cluster/config.db";
41 my $dbbackupdir = "/var/lib/pve-cluster/backup";
43 # this is just a readonly copy, the relevant one is in status.c from pmxcfs
44 # observed files are the one we can get directly through IPCC, they are cached
45 # using a computed version and only those can be used by the cfs_*_file methods
50 'datacenter.cfg' => 1,
51 'replication.cfg' => 1,
53 'corosync.conf.new' => 1,
54 'firewall/cluster.fw' => 1,
57 'priv/shadow.cfg' => 1,
59 'priv/token.cfg' => 1,
60 'priv/acme/plugins.cfg' => 1,
65 'ha/crm_commands' => 1,
66 'ha/manager_status' => 1,
67 'ha/resources.cfg' => 1,
74 'sdn/controllers.cfg' => 1,
75 'sdn/subnets.cfg' => 1,
78 'sdn/.running-config' => 1,
79 'virtual-guest/cpu-models.conf' => 1,
82 sub prepare_observed_file_basedirs
{
84 if (!check_cfs_is_mounted
(1)) {
85 warn "pmxcfs isn't mounted (/etc/pve), chickening out..\n";
89 for my $f (sort keys %$observed) {
90 next if $f !~ m!^(.*)/[^/]+$!;
91 my $dir = "$basedir/$1";
92 next if -e
$dir; # can also be a link, so just use -e xist check
93 print "creating directory '$dir' for observerd files\n";
106 sub check_cfs_quorum
{
109 # note: -w filename always return 1 for root, so wee need
110 # to use File::lstat here
111 my $st = File
::stat::lstat("$basedir/local");
112 my $quorate = ($st && (($st->mode & 0200) != 0));
114 die "cluster not ready - no quorum?\n" if !$quorate && !$noerr;
119 sub check_cfs_is_mounted
{
122 my $res = -l
"$basedir/local";
124 die "pve configuration filesystem (pmxcfs) not mounted\n" if !$res && !$noerr;
133 my $ipcc_send_rec = sub {
134 my ($msgid, $data) = @_;
136 my $res = PVE
::IPCC
::ipcc_send_rec
($msgid, $data);
138 die "ipcc_send_rec[$msgid] failed: $!\n" if !defined($res) && ($! != 0);
143 my $ipcc_send_rec_json = sub {
144 my ($msgid, $data) = @_;
146 my $res = PVE
::IPCC
::ipcc_send_rec
($msgid, $data);
148 die "ipcc_send_rec[$msgid] failed: $!\n" if !defined($res) && ($! != 0);
150 return decode_json
($res);
153 my $ipcc_get_config = sub {
156 my $bindata = pack "Z*", $path;
157 my $res = PVE
::IPCC
::ipcc_send_rec
(CFS_IPC_GET_CONFIG
, $bindata);
158 if (!defined($res)) {
160 return undef if $! == ENOENT
;
169 my $ipcc_get_status = sub {
170 my ($name, $nodename) = @_;
172 my $bindata = pack "Z[256]Z[256]", $name, ($nodename || "");
173 return PVE
::IPCC
::ipcc_send_rec
(CFS_IPC_GET_STATUS
, $bindata);
176 my $ipcc_remove_status = sub {
178 # we just omit the data payload, pmxcfs takes this as hint and removes this
179 # key from the status hashtable
180 my $bindata = pack "Z[256]", $name;
181 return &$ipcc_send_rec(CFS_IPC_SET_STATUS
, $bindata);
184 my $ipcc_update_status = sub {
185 my ($name, $data) = @_;
187 my $raw = ref($data) ? encode_json
($data) : $data;
189 my $bindata = pack "Z[256]Z*", $name, $raw;
191 return &$ipcc_send_rec(CFS_IPC_SET_STATUS
, $bindata);
195 my ($priority, $ident, $tag, $msg) = @_;
197 my $bindata = pack "CCCZ*Z*Z*", $priority, bytes
::length($ident) + 1,
198 bytes
::length($tag) + 1, $ident, $tag, $msg;
200 return &$ipcc_send_rec(CFS_IPC_LOG_CLUSTER_MSG
, $bindata);
203 my $ipcc_get_cluster_log = sub {
204 my ($user, $max) = @_;
206 $max = 0 if !defined($max);
208 my $bindata = pack "VVVVZ*", $max, 0, 0, 0, ($user || "");
209 return &$ipcc_send_rec(CFS_IPC_GET_CLUSTER_LOG
, $bindata);
212 my $ipcc_verify_token = sub {
213 my ($full_token) = @_;
215 my $bindata = pack "Z*", $full_token;
216 my $res = PVE
::IPCC
::ipcc_send_rec
(CFS_IPC_VERIFY_TOKEN
, $bindata);
219 return 0 if $! == ENOENT
;
229 my $res = &$ipcc_send_rec_json(CFS_IPC_GET_FS_VERSION
);
230 die "no starttime\n" if !$res->{starttime
};
232 if (!$res->{starttime
} || !$versions->{starttime
} ||
233 $res->{starttime
} != $versions->{starttime
}) {
234 #print "detected changed starttime\n";
253 if (!$clinfo->{version
} || $clinfo->{version
} != $versions->{clinfo
}) {
254 #warn "detected new clinfo\n";
255 $clinfo = &$ipcc_send_rec_json(CFS_IPC_GET_CLUSTER_INFO
);
266 if (!$vmlist->{version
} || $vmlist->{version
} != $versions->{vmlist
}) {
267 #warn "detected new vmlist1\n";
268 $vmlist = &$ipcc_send_rec_json(CFS_IPC_GET_GUEST_LIST
);
288 return $clinfo->{nodelist
};
292 my $nodelist = $clinfo->{nodelist
};
294 my $nodename = PVE
::INotify
::nodename
();
296 if (!$nodelist || !$nodelist->{$nodename}) {
297 return [ $nodename ];
300 return [ keys %$nodelist ];
303 # only stored in a in-memory hashtable inside pmxcfs, local data is gone after
304 # a restart (of pmxcfs or the node), peer data is still available then
305 # best used for status data, like running (ceph) services, package versions, ...
306 sub broadcast_node_kv
{
307 my ($key, $data) = @_;
309 if (!defined($data)) {
310 eval { $ipcc_remove_status->("kv/$key") };
312 die "cannot send a reference\n" if ref($data);
313 my $size = length($data);
314 die "data for '$key' too big\n" if $size >= (32 * 1024); # limit from pmxfs
316 eval { $ipcc_update_status->("kv/$key", $data) };
321 # nodename is optional
323 my ($key, $nodename) = @_;
326 my $get_node_data = sub {
328 my $raw = $ipcc_get_status->("kv/$key", $node);
329 $res->{$node} = unpack("Z*", $raw) if $raw;
333 $get_node_data->($nodename);
335 for my $node (get_nodelist
()->@*) {
336 $get_node_data->($node);
343 # properties: an array-ref of config properties you want to get, e.g., this
344 # is perfect to get multiple properties of a guest _fast_
345 # (>100 faster than manual parsing here)
346 # vmid: optional, if a valid is passed we only check that one, else return all
347 # NOTE: does *not* searches snapshot and PENDING entries sections!
348 # NOTE: returns the guest config lines (excluding trailing whitespace) as is,
349 # so for non-trivial properties, checking the validity must be done
350 # NOTE: no permission check is done, that is the responsibilty of the caller
351 sub get_guest_config_properties
{
352 my ($properties, $vmid) = @_;
354 die "properties required" if !defined($properties);
356 my $num_props = scalar(@$properties);
357 die "only up to 255 properties supported" if $num_props > 255;
358 my $bindata = pack "VC", $vmid // 0, $num_props;
359 for my $property (@$properties) {
360 $bindata .= pack "Z*", $property;
362 my $res = $ipcc_send_rec_json->(CFS_IPC_GET_GUEST_CONFIG_PROPERTIES
, $bindata);
367 # property: a config property you want to get, e.g., this is perfect to get
368 # the 'lock' entry of a guest _fast_ (>100 faster than manual parsing here)
369 # vmid: optional, if a valid is passed we only check that one, else return all
370 # NOTE: does *not* searches snapshot and PENDING entries sections!
371 # NOTE: returns the guest config lines (excluding trailing whitespace) as is,
372 # so for non-trivial properties, checking the validity must be done
373 # NOTE: no permission check is done, that is the responsibilty of the caller
374 sub get_guest_config_property
{
375 my ($property, $vmid) = @_;
377 die "property is required" if !defined($property);
379 my $bindata = pack "VZ*", $vmid // 0, $property;
380 my $res = $ipcc_send_rec_json->(CFS_IPC_GET_GUEST_CONFIG_PROPERTY
, $bindata);
385 # $data must be a chronological descending ordered array of tasks
386 sub broadcast_tasklist
{
389 # the serialized list may not get bigger than 128 KiB (CFS_MAX_STATUS_SIZE from pmxcfs)
390 # drop older items until we satisfy this constraint
391 my $size = length(encode_json
($data));
392 while ($size >= (32 * 1024)) { # TODO: update to 128 KiB in PVE 8.x
394 $size = length(encode_json
($data));
397 eval { $ipcc_update_status->("tasklist", $data) };
401 my $tasklistcache = {};
406 my $kvstore = $versions->{kvstore
} || {};
408 my $nodelist = get_nodelist
();
411 foreach my $node (@$nodelist) {
412 next if $nodename && ($nodename ne $node);
414 my $ver = exists $kvstore->{$node} ?
$kvstore->{$node}->{tasklist
} : undef;
415 my $cache = $tasklistcache->{$node};
416 if (!$cache || !$ver || !$cache->{version
} || ($cache->{version
} != $ver)) {
418 if (my $raw = $ipcc_get_status->("tasklist", $node)) {
419 my $json_str = unpack("Z*", $raw);
420 $tasks = decode_json
($json_str);
423 $tasklistcache->{$node} = {
427 } elsif ($cache && $cache->{data
}) {
428 push @$res, $cache->{data
}->@*;
432 syslog
('err', $err) if $err;
439 my ($rrdid, $data) = @_;
442 &$ipcc_update_status("rrd/$rrdid", $data);
449 my $last_rrd_dump = 0;
450 my $last_rrd_data = "";
456 my $diff = $ctime - $last_rrd_dump;
458 return $last_rrd_data;
463 $raw = &$ipcc_send_rec(CFS_IPC_GET_RRD_DUMP
);
475 while ($raw =~ s/^(.*)\n//) {
476 my ($key, @ela) = split(/:/, $1);
478 next if !(scalar(@ela) > 1);
479 $res->{$key} = [ map { $_ eq 'U' ?
undef : $_ } @ela ];
483 $last_rrd_dump = $ctime;
484 $last_rrd_data = $res;
490 # a fast way to read files (avoid fuse overhead)
494 return &$ipcc_get_config($path);
497 sub get_cluster_log
{
498 my ($user, $max) = @_;
500 return &$ipcc_get_cluster_log($user, $max);
504 my ($userid, $token) = @_;
506 return &$ipcc_verify_token("$userid $token");
511 sub cfs_register_file
{
512 my ($filename, $parser, $writer) = @_;
514 $observed->{$filename} || die "unknown file '$filename'";
516 die "file '$filename' already registered" if $file_info->{$filename};
518 $file_info->{$filename} = {
524 my $ccache_read = sub {
525 my ($filename, $parser, $version) = @_;
527 $ccache->{$filename} = {} if !$ccache->{$filename};
529 my $ci = $ccache->{$filename};
531 if (!$ci->{version
} || !$version || $ci->{version
} != $version) {
532 # we always call the parser, even when the file does not exist
533 # (in that case $data is undef)
534 my $data = get_config
($filename);
535 $ci->{data
} = &$parser("/etc/pve/$filename", $data);
536 $ci->{version
} = $version;
539 my $res = ref($ci->{data
}) ? dclone
($ci->{data
}) : $ci->{data
};
544 sub cfs_file_version
{
549 if ($filename =~ m!^nodes/[^/]+/(openvz|lxc|qemu-server)/(\d+)\.conf$!) {
550 my ($type, $vmid) = ($1, $2);
551 if ($vmlist && $vmlist->{ids
} && $vmlist->{ids
}->{$vmid}) {
552 $version = $vmlist->{ids
}->{$vmid}->{version
};
554 $infotag = "/$type/";
556 $infotag = $filename;
557 $version = $versions->{$filename};
560 my $info = $file_info->{$infotag} ||
561 die "unknown file type '$filename'\n";
563 return wantarray ?
($version, $info) : $version;
569 my ($version, $info) = cfs_file_version
($filename);
570 my $parser = $info->{parser
};
572 return &$ccache_read($filename, $parser, $version);
576 my ($filename, $data) = @_;
578 my ($version, $info) = cfs_file_version
($filename);
580 my $writer = $info->{writer
} || die "no writer defined";
582 my $fsname = "/etc/pve/$filename";
584 my $raw = &$writer($fsname, $data);
586 if (my $ci = $ccache->{$filename}) {
587 $ci->{version
} = undef;
590 PVE
::Tools
::file_set_contents
($fsname, $raw);
594 my ($lockid, $timeout, $code, @param) = @_;
596 my $prev_alarm = alarm(0); # suspend outer alarm early
601 # this timeout is for acquire the lock
602 $timeout = 10 if !$timeout;
604 my $filename = "$lockdir/$lockid";
612 die "pve cluster filesystem not online.\n";
615 my $timeout_err = sub { die "got lock request timeout\n"; };
616 local $SIG{ALRM
} = $timeout_err;
620 $got_lock = mkdir($filename);
621 $timeout = alarm(0) - 1; # we'll sleep for 1s, see down below
625 $timeout_err->() if $timeout <= 0;
627 print STDERR
"trying to acquire cfs lock '$lockid' ...\n";
628 utime (0, 0, $filename); # cfs unlock request
632 # fixed command timeout: cfs locks have a timeout of 120
633 # using 60 gives us another 60 seconds to abort the task
634 local $SIG{ALRM
} = sub { die "'$lockid'-locked command timed out - aborting\n"; };
637 cfs_update
(); # make sure we read latest versions inside code()
639 $is_code_err = 1; # allows to differ between locking and actual-work errors
641 $res = &$code(@param);
648 $err = "no quorum!\n" if !$got_lock && !check_cfs_quorum
(1);
650 rmdir $filename if $got_lock; # if we held the lock always unlock again
655 if (ref($err) eq 'PVE::Exception' || $is_code_err) {
656 # re-raise defined exceptions
659 # add lock info for plain errors comming from the locking itself
660 $@ = "cfs-lock '$lockid' error: $err";
671 my ($filename, $timeout, $code, @param) = @_;
673 my $info = $observed->{$filename} || die "unknown file '$filename'";
675 my $lockid = "file-$filename";
676 $lockid =~ s/[.\/]/_
/g
;
678 &$cfs_lock($lockid, $timeout, $code, @param);
681 sub cfs_lock_storage
{
682 my ($storeid, $timeout, $code, @param) = @_;
684 my $lockid = "storage-$storeid";
686 &$cfs_lock($lockid, $timeout, $code, @param);
689 sub cfs_lock_domain
{
690 my ($domainname, $timeout, $code, @param) = @_;
692 my $lockid = "domain-$domainname";
694 &$cfs_lock($lockid, $timeout, $code, @param);
698 my ($account, $timeout, $code, @param) = @_;
700 my $lockid = "acme-$account";
702 &$cfs_lock($lockid, $timeout, $code, @param);
705 sub cfs_lock_authkey
{
706 my ($timeout, $code, @param) = @_;
708 $cfs_lock->('authkey', $timeout, $code, @param);
711 sub cfs_lock_firewall
{
712 my ($scope, $timeout, $code, @param) = @_;
714 my $lockid = "firewall-$scope";
716 $cfs_lock->($lockid, $timeout, $code, @param);
734 my ($priority, $ident, $msg) = @_;
736 if (my $tmp = $log_levels->{$priority}) {
740 die "need numeric log priority" if $priority !~ /^\d+$/;
742 my $tag = PVE
::SafeSyslog
::tag
();
744 $msg = "empty message" if !$msg;
746 $ident = "" if !$ident;
747 $ident = encode
("ascii", $ident,
748 sub { sprintf "\\u%04x", shift });
750 my $ascii = encode
("ascii", $msg, sub { sprintf "\\u%04x", shift });
753 syslog
($priority, "<%s> %s", $ident, $ascii);
755 syslog
($priority, "%s", $ascii);
758 eval { &$ipcc_log($priority, $ident, $tag, $ascii); };
760 syslog
("err", "writing cluster log failed: $@") if $@;
763 sub check_vmid_unused
{
764 my ($vmid, $noerr) = @_;
766 my $vmlist = get_vmlist
();
768 my $d = $vmlist->{ids
}->{$vmid};
769 return 1 if !defined($d);
771 return undef if $noerr;
773 my $vmtypestr = $d->{type
} eq 'qemu' ?
'VM' : 'CT';
774 die "$vmtypestr $vmid already exists on node '$d->{node}'\n";
777 sub check_node_exists
{
778 my ($nodename, $noerr) = @_;
780 my $nodelist = $clinfo->{nodelist
};
781 return 1 if $nodelist && $nodelist->{$nodename};
783 return undef if $noerr;
785 die "no such cluster node '$nodename'\n";
788 # this is also used to get the IP of the local node
790 my ($nodename, $noerr) = @_;
792 my $nodelist = $clinfo->{nodelist
};
793 if ($nodelist && $nodelist->{$nodename}) {
794 if (my $ip = $nodelist->{$nodename}->{ip
}) {
795 return $ip if !wantarray;
796 my $family = $nodelist->{$nodename}->{address_family
};
798 $nodelist->{$nodename}->{address_family
} =
800 PVE
::Tools
::get_host_address_family
($ip);
802 return wantarray ?
($ip, $family) : $ip;
806 # fallback: try to get IP by other means
807 return PVE
::Network
::get_ip_from_hostname
($nodename, $noerr);
810 sub get_node_fingerprint
{
813 my $cert_path = "/etc/pve/nodes/$node/pve-ssl.pem";
814 my $custom_cert_path = "/etc/pve/nodes/$node/pveproxy-ssl.pem";
816 $cert_path = $custom_cert_path if -f
$custom_cert_path;
818 return PVE
::Certificate
::get_certificate_fingerprint
($cert_path);
821 # bash completion helpers
823 sub complete_next_vmid
{
825 my $vmlist = get_vmlist
() || {};
826 my $idlist = $vmlist->{ids
} || {};
828 for (my $i = 100; $i < 10000; $i++) {
829 return [$i] if !defined($idlist->{$i});
837 my $vmlist = get_vmlist
();
838 my $ids = $vmlist->{ids
} || {};
840 return [ keys %$ids ];
843 sub complete_local_vmid
{
845 my $vmlist = get_vmlist
();
846 my $ids = $vmlist->{ids
} || {};
848 my $nodename = PVE
::INotify
::nodename
();
851 foreach my $vmid (keys %$ids) {
852 my $d = $ids->{$vmid};
853 next if !$d->{node
} || $d->{node
} ne $nodename;
860 sub complete_migration_target
{
864 my $nodename = PVE
::INotify
::nodename
();
866 my $nodelist = get_nodelist
();
867 foreach my $node (@$nodelist) {
868 next if $node eq $nodename;
876 # NOTE: filesystem must be offline here, no DB changes allowed
877 sub cfs_backup_database
{
881 my $backup_fn = "$dbbackupdir/config-$ctime.sql.gz";
883 print "backup old database to '$backup_fn'\n";
885 my $cmd = [ ['sqlite3', $dbfile, '.dump'], ['gzip', '-', \
">${backup_fn}"] ];
886 run_command
($cmd, 'errmsg' => "cannot backup old database\n");
888 my $maxfiles = 10; # purge older backup
889 my $backups = [ sort { $b cmp $a } <$dbbackupdir/config-*.sql
.gz
> ];
891 if ((my $count = scalar(@$backups)) > $maxfiles) {
892 foreach my $f (@$backups[$maxfiles..$count-1]) {
893 next if $f !~ m/^(\S+)$/; # untaint
894 print "delete old backup '$1'\n";