16 use Time
::Local
qw(timelocal);
18 use PVE
::Tools
qw(run_command file_read_firstline dir_glob_foreach $IPV6RE);
19 use PVE
::Cluster
qw(cfs_read_file cfs_write_file cfs_lock_file);
20 use PVE
::DataCenterConfig
;
21 use PVE
::Exception
qw(raise_param_exc raise);
24 use PVE
::RPCEnvironment
;
27 use PVE
::Storage
::Plugin
;
28 use PVE
::Storage
::DirPlugin
;
29 use PVE
::Storage
::LVMPlugin
;
30 use PVE
::Storage
::LvmThinPlugin
;
31 use PVE
::Storage
::NFSPlugin
;
32 use PVE
::Storage
::CIFSPlugin
;
33 use PVE
::Storage
::ISCSIPlugin
;
34 use PVE
::Storage
::RBDPlugin
;
35 use PVE
::Storage
::CephFSPlugin
;
36 use PVE
::Storage
::ISCSIDirectPlugin
;
37 use PVE
::Storage
::GlusterfsPlugin
;
38 use PVE
::Storage
::ZFSPoolPlugin
;
39 use PVE
::Storage
::ZFSPlugin
;
40 use PVE
::Storage
::PBSPlugin
;
42 # Storage API version. Increment it on changes in storage API interface.
43 use constant APIVER
=> 8;
44 # Age is the number of versions we're backward compatible with.
45 # This is like having 'current=APIVER' and age='APIAGE' in libtool,
46 # see https://www.gnu.org/software/libtool/manual/html_node/Libtool-versioning.html
47 use constant APIAGE
=> 7;
49 # load standard plugins
50 PVE
::Storage
::DirPlugin-
>register();
51 PVE
::Storage
::LVMPlugin-
>register();
52 PVE
::Storage
::LvmThinPlugin-
>register();
53 PVE
::Storage
::NFSPlugin-
>register();
54 PVE
::Storage
::CIFSPlugin-
>register();
55 PVE
::Storage
::ISCSIPlugin-
>register();
56 PVE
::Storage
::RBDPlugin-
>register();
57 PVE
::Storage
::CephFSPlugin-
>register();
58 PVE
::Storage
::ISCSIDirectPlugin-
>register();
59 PVE
::Storage
::GlusterfsPlugin-
>register();
60 PVE
::Storage
::ZFSPoolPlugin-
>register();
61 PVE
::Storage
::ZFSPlugin-
>register();
62 PVE
::Storage
::PBSPlugin-
>register();
64 # load third-party plugins
65 if ( -d
'/usr/share/perl5/PVE/Storage/Custom' ) {
66 dir_glob_foreach
('/usr/share/perl5/PVE/Storage/Custom', '.*\.pm$', sub {
68 my $modname = 'PVE::Storage::Custom::' . $file;
69 $modname =~ s!\.pm$!!;
70 $file = 'PVE/Storage/Custom/' . $file;
75 # Check perl interface:
76 die "not derived from PVE::Storage::Plugin\n"
77 if !$modname->isa('PVE::Storage::Plugin');
78 die "does not provide an api() method\n"
79 if !$modname->can('api');
80 # Check storage API version and that file is really storage plugin.
81 my $version = $modname->api();
82 die "implements an API version newer than current ($version > " . APIVER
. ")\n"
84 my $min_version = (APIVER
- APIAGE
);
85 die "API version too old, please update the plugin ($version < $min_version)\n"
86 if $version < $min_version;
90 # If we got this far and the API version is not the same, make some
92 warn "Plugin \"$modname\" is implementing an older storage API
, an upgrade
is recommended
\n"
93 if $version != APIVER;
96 warn "Error loading storage plugin
\"$modname\": $@";
101 # initialize all plugins
102 PVE
::Storage
::Plugin-
>init();
104 our $iso_extension_re = qr/\.(?:iso|img)/i;
106 # PVE::Storage utility functions
109 return cfs_read_file
("storage.cfg");
115 cfs_write_file
('storage.cfg', $cfg);
118 sub lock_storage_config
{
119 my ($code, $errmsg) = @_;
121 cfs_lock_file
("storage.cfg", undef, $code);
124 $errmsg ?
die "$errmsg: $err" : die $err;
128 # FIXME remove maxfiles for PVE 7.0
129 my $convert_maxfiles_to_prune_backups = sub {
134 my $maxfiles = delete $scfg->{maxfiles
};
136 if (!defined($scfg->{'prune-backups'}) && defined($maxfiles)) {
139 $prune_backups = { 'keep-last' => $maxfiles };
140 } else { # maxfiles 0 means no limit
141 $prune_backups = { 'keep-all' => 1 };
143 $scfg->{'prune-backups'} = PVE
::JSONSchema
::print_property_string
(
151 my ($cfg, $storeid, $noerr) = @_;
153 die "no storage ID specified\n" if !$storeid;
155 my $scfg = $cfg->{ids
}->{$storeid};
157 die "storage '$storeid' does not exist\n" if (!$noerr && !$scfg);
159 $convert_maxfiles_to_prune_backups->($scfg);
164 sub storage_check_node
{
165 my ($cfg, $storeid, $node, $noerr) = @_;
167 my $scfg = storage_config
($cfg, $storeid);
169 if ($scfg->{nodes
}) {
170 $node = PVE
::INotify
::nodename
() if !$node || ($node eq 'localhost');
171 if (!$scfg->{nodes
}->{$node}) {
172 die "storage '$storeid' is not available on node '$node'\n" if !$noerr;
180 sub storage_check_enabled
{
181 my ($cfg, $storeid, $node, $noerr) = @_;
183 my $scfg = storage_config
($cfg, $storeid);
185 if ($scfg->{disable
}) {
186 die "storage '$storeid' is disabled\n" if !$noerr;
190 return storage_check_node
($cfg, $storeid, $node, $noerr);
193 # storage_can_replicate:
194 # return true if storage supports replication
195 # (volumes alocated with vdisk_alloc() has replication feature)
196 sub storage_can_replicate
{
197 my ($cfg, $storeid, $format) = @_;
199 my $scfg = storage_config
($cfg, $storeid);
200 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
201 return $plugin->storage_can_replicate($scfg, $storeid, $format);
207 return keys %{$cfg->{ids
}};
211 my ($filename, $timeout) = @_;
213 return PVE
::Storage
::Plugin
::file_size_info
($filename, $timeout);
216 sub get_volume_notes
{
217 my ($cfg, $volid, $timeout) = @_;
219 my ($storeid, $volname) = parse_volume_id
($volid);
220 my $scfg = storage_config
($cfg, $storeid);
221 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
223 return $plugin->get_volume_notes($scfg, $storeid, $volname, $timeout);
226 sub update_volume_notes
{
227 my ($cfg, $volid, $notes, $timeout) = @_;
229 my ($storeid, $volname) = parse_volume_id
($volid);
230 my $scfg = storage_config
($cfg, $storeid);
231 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
233 $plugin->update_volume_notes($scfg, $storeid, $volname, $notes, $timeout);
236 sub volume_size_info
{
237 my ($cfg, $volid, $timeout) = @_;
239 my ($storeid, $volname) = parse_volume_id
($volid, 1);
241 my $scfg = storage_config
($cfg, $storeid);
242 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
243 return $plugin->volume_size_info($scfg, $storeid, $volname, $timeout);
244 } elsif ($volid =~ m
|^(/.+)$| && -e
$volid) {
245 return file_size_info
($volid, $timeout);
252 my ($cfg, $volid, $size, $running) = @_;
254 my $padding = (1024 - $size % 1024) % 1024;
255 $size = $size + $padding;
257 my ($storeid, $volname) = parse_volume_id
($volid, 1);
259 my $scfg = storage_config
($cfg, $storeid);
260 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
261 return $plugin->volume_resize($scfg, $storeid, $volname, $size, $running);
262 } elsif ($volid =~ m
|^(/.+)$| && -e
$volid) {
263 die "resize file/device '$volid' is not possible\n";
265 die "unable to parse volume ID '$volid'\n";
269 sub volume_rollback_is_possible
{
270 my ($cfg, $volid, $snap) = @_;
272 my ($storeid, $volname) = parse_volume_id
($volid, 1);
274 my $scfg = storage_config
($cfg, $storeid);
275 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
276 return $plugin->volume_rollback_is_possible($scfg, $storeid, $volname, $snap);
277 } elsif ($volid =~ m
|^(/.+)$| && -e
$volid) {
278 die "snapshot rollback file/device '$volid' is not possible\n";
280 die "unable to parse volume ID '$volid'\n";
284 sub volume_snapshot
{
285 my ($cfg, $volid, $snap) = @_;
287 my ($storeid, $volname) = parse_volume_id
($volid, 1);
289 my $scfg = storage_config
($cfg, $storeid);
290 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
291 return $plugin->volume_snapshot($scfg, $storeid, $volname, $snap);
292 } elsif ($volid =~ m
|^(/.+)$| && -e
$volid) {
293 die "snapshot file/device '$volid' is not possible\n";
295 die "unable to parse volume ID '$volid'\n";
299 sub volume_snapshot_rollback
{
300 my ($cfg, $volid, $snap) = @_;
302 my ($storeid, $volname) = parse_volume_id
($volid, 1);
304 my $scfg = storage_config
($cfg, $storeid);
305 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
306 $plugin->volume_rollback_is_possible($scfg, $storeid, $volname, $snap);
307 return $plugin->volume_snapshot_rollback($scfg, $storeid, $volname, $snap);
308 } elsif ($volid =~ m
|^(/.+)$| && -e
$volid) {
309 die "snapshot rollback file/device '$volid' is not possible\n";
311 die "unable to parse volume ID '$volid'\n";
315 sub volume_snapshot_delete
{
316 my ($cfg, $volid, $snap, $running) = @_;
318 my ($storeid, $volname) = parse_volume_id
($volid, 1);
320 my $scfg = storage_config
($cfg, $storeid);
321 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
322 return $plugin->volume_snapshot_delete($scfg, $storeid, $volname, $snap, $running);
323 } elsif ($volid =~ m
|^(/.+)$| && -e
$volid) {
324 die "snapshot delete file/device '$volid' is not possible\n";
326 die "unable to parse volume ID '$volid'\n";
330 # check if a filesystem on top of a volume needs to flush its journal for
331 # consistency (see fsfreeze(8)) before a snapshot is taken - needed for
332 # container mountpoints
333 sub volume_snapshot_needs_fsfreeze
{
334 my ($cfg, $volid) = @_;
336 my ($storeid, $volname) = parse_volume_id
($volid);
337 my $scfg = storage_config
($cfg, $storeid);
338 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
339 return $plugin->volume_snapshot_needs_fsfreeze();
342 # check if a volume or snapshot supports a given feature
344 # clone - linked clone is possible
345 # copy - full clone is possible
346 # replicate - replication is possible
347 # snapshot - taking a snapshot is possible
348 # sparseinit - volume is sparsely initialized
349 # template - conversion to base image is possible
350 # $snap - check if the feature is supported for a given snapshot
351 # $running - if the guest owning the volume is running
352 # $opts - hash with further options:
353 # valid_target_formats - list of formats for the target of a copy/clone
354 # operation that the caller could work with. The
355 # format of $volid is always considered valid and if
356 # no list is specified, all formats are considered valid.
357 sub volume_has_feature
{
358 my ($cfg, $feature, $volid, $snap, $running, $opts) = @_;
360 my ($storeid, $volname) = parse_volume_id
($volid, 1);
362 my $scfg = storage_config
($cfg, $storeid);
363 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
364 return $plugin->volume_has_feature($scfg, $feature, $storeid, $volname, $snap, $running, $opts);
365 } elsif ($volid =~ m
|^(/.+)$| && -e
$volid) {
372 sub volume_snapshot_list
{
373 my ($cfg, $volid) = @_;
375 my ($storeid, $volname) = parse_volume_id
($volid, 1);
377 my $scfg = storage_config
($cfg, $storeid);
378 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
379 return $plugin->volume_snapshot_list($scfg, $storeid, $volname);
380 } elsif ($volid =~ m
|^(/.+)$| && -e
$volid) {
381 die "send file/device '$volid' is not possible\n";
383 die "unable to parse volume ID '$volid'\n";
385 # return an empty array if dataset does not exist.
389 my ($cfg, $storeid, $vmid) = @_;
391 my $scfg = storage_config
($cfg, $storeid);
392 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
394 my $path = $plugin->get_subdir($scfg, 'images');
396 return $vmid ?
"$path/$vmid" : $path;
399 sub get_private_dir
{
400 my ($cfg, $storeid, $vmid) = @_;
402 my $scfg = storage_config
($cfg, $storeid);
403 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
405 my $path = $plugin->get_subdir($scfg, 'rootdir');
407 return $vmid ?
"$path/$vmid" : $path;
411 my ($cfg, $storeid) = @_;
413 my $scfg = storage_config
($cfg, $storeid);
414 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
416 return $plugin->get_subdir($scfg, 'iso');
420 my ($cfg, $storeid) = @_;
422 my $scfg = storage_config
($cfg, $storeid);
423 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
425 return $plugin->get_subdir($scfg, 'vztmpl');
429 my ($cfg, $storeid) = @_;
431 my $scfg = storage_config
($cfg, $storeid);
432 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
434 return $plugin->get_subdir($scfg, 'backup');
437 # library implementation
442 die "VMID '$vmid' contains illegal characters\n" if $vmid !~ m/^\d+$/;
447 # NOTE: basename and basevmid are always undef for LVM-thin, where the
448 # clone -> base reference is not encoded in the volume ID.
449 # see note in PVE::Storage::LvmThinPlugin for details.
451 my ($cfg, $volid) = @_;
453 my ($storeid, $volname) = parse_volume_id
($volid);
455 my $scfg = storage_config
($cfg, $storeid);
457 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
459 # returns ($vtype, $name, $vmid, $basename, $basevmid, $isBase, $format)
461 return $plugin->parse_volname($volname);
464 sub parse_volume_id
{
465 my ($volid, $noerr) = @_;
467 return PVE
::Storage
::Plugin
::parse_volume_id
($volid, $noerr);
470 # test if we have read access to volid
471 sub check_volume_access
{
472 my ($rpcenv, $user, $cfg, $vmid, $volid) = @_;
474 my ($sid, $volname) = parse_volume_id
($volid, 1);
476 my ($vtype, undef, $ownervm) = parse_volname
($cfg, $volid);
477 if ($vtype eq 'iso' || $vtype eq 'vztmpl') {
478 # require at least read access to storage, (custom) templates/ISOs could be sensitive
479 $rpcenv->check_any($user, "/storage/$sid", ['Datastore.AllocateSpace', 'Datastore.Audit']);
480 } elsif (defined($ownervm) && defined($vmid) && ($ownervm == $vmid)) {
481 # we are owner - allow access
482 } elsif ($vtype eq 'backup' && $ownervm) {
483 $rpcenv->check($user, "/storage/$sid", ['Datastore.AllocateSpace']);
484 $rpcenv->check($user, "/vms/$ownervm", ['VM.Backup']);
486 # allow if we are Datastore administrator
487 $rpcenv->check($user, "/storage/$sid", ['Datastore.Allocate']);
490 die "Only root can pass arbitrary filesystem paths."
491 if $user ne 'root@pam';
497 # NOTE: this check does not work for LVM-thin, where the clone -> base
498 # reference is not encoded in the volume ID.
499 # see note in PVE::Storage::LvmThinPlugin for details.
500 sub volume_is_base_and_used
{
501 my ($cfg, $volid) = @_;
503 my ($storeid, $volname) = parse_volume_id
($volid);
504 my $scfg = storage_config
($cfg, $storeid);
505 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
507 my ($vtype, $name, $vmid, undef, undef, $isBase, undef) =
508 $plugin->parse_volname($volname);
511 my $vollist = $plugin->list_images($storeid, $scfg);
512 foreach my $info (@$vollist) {
513 my (undef, $tmpvolname) = parse_volume_id
($info->{volid
});
514 my $basename = undef;
515 my $basevmid = undef;
518 (undef, undef, undef, $basename, $basevmid) =
519 $plugin->parse_volname($tmpvolname);
522 if ($basename && defined($basevmid) && $basevmid == $vmid && $basename eq $name) {
530 # try to map a filesystem path to a volume identifier
531 sub path_to_volume_id
{
532 my ($cfg, $path) = @_;
534 my $ids = $cfg->{ids
};
536 my ($sid, $volname) = parse_volume_id
($path, 1);
538 if (my $scfg = $ids->{$sid}) {
540 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
541 my ($vtype, $name, $vmid) = $plugin->parse_volname($volname);
542 return ($vtype, $path);
548 # Note: abs_path() return undef if $path doesn not exist
549 # for example when nfs storage is not mounted
550 $path = abs_path
($path) || $path;
552 foreach my $sid (keys %$ids) {
553 my $scfg = $ids->{$sid};
554 next if !$scfg->{path
};
555 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
556 my $imagedir = $plugin->get_subdir($scfg, 'images');
557 my $isodir = $plugin->get_subdir($scfg, 'iso');
558 my $tmpldir = $plugin->get_subdir($scfg, 'vztmpl');
559 my $backupdir = $plugin->get_subdir($scfg, 'backup');
560 my $privatedir = $plugin->get_subdir($scfg, 'rootdir');
561 my $snippetsdir = $plugin->get_subdir($scfg, 'snippets');
563 if ($path =~ m!^$imagedir/(\d+)/([^/\s]+)$!) {
567 my $vollist = $plugin->list_images($sid, $scfg, $vmid);
568 foreach my $info (@$vollist) {
569 my ($storeid, $volname) = parse_volume_id
($info->{volid
});
570 my $volpath = $plugin->path($scfg, $volname, $storeid);
571 if ($volpath eq $path) {
572 return ('images', $info->{volid
});
575 } elsif ($path =~ m!^$isodir/([^/]+$iso_extension_re)$!) {
577 return ('iso', "$sid:iso/$name");
578 } elsif ($path =~ m!^$tmpldir/([^/]+\.tar\.gz)$!) {
580 return ('vztmpl', "$sid:vztmpl/$name");
581 } elsif ($path =~ m!^$privatedir/(\d+)$!) {
583 return ('rootdir', "$sid:rootdir/$vmid");
584 } elsif ($path =~ m!^$backupdir/([^/]+\.(?:tgz|(?:(?:tar|vma)(?:\.(?:${\PVE::Storage::Plugin::COMPRESSOR_RE}))?)))$!) {
586 return ('backup', "$sid:backup/$name");
587 } elsif ($path =~ m!^$snippetsdir/([^/]+)$!) {
589 return ('snippets', "$sid:snippets/$name");
593 # can't map path to volume id
598 my ($cfg, $volid, $snapname) = @_;
600 my ($storeid, $volname) = parse_volume_id
($volid);
602 my $scfg = storage_config
($cfg, $storeid);
604 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
605 my ($path, $owner, $vtype) = $plugin->path($scfg, $volname, $storeid, $snapname);
606 return wantarray ?
($path, $owner, $vtype) : $path;
609 sub abs_filesystem_path
{
610 my ($cfg, $volid, $allow_blockdev) = @_;
613 if (parse_volume_id
($volid, 1)) {
614 activate_volumes
($cfg, [ $volid ]);
615 $path = PVE
::Storage
::path
($cfg, $volid);
617 if (-f
$volid || ($allow_blockdev && -b
$volid)) {
618 my $abspath = abs_path
($volid);
619 if ($abspath && $abspath =~ m
|^(/.+)$|) {
620 $path = $1; # untaint any path
624 die "can't find file '$volid'\n"
625 if !($path && (-f
$path || ($allow_blockdev && -b
$path)));
630 my $volname_for_storage = sub {
631 my ($cfg, $volid, $target_storeid) = @_;
633 my (undef, $name, $vmid, undef, undef, undef, $format) = parse_volname
($cfg, $volid);
634 my $target_scfg = storage_config
($cfg, $target_storeid);
636 my (undef, $valid_formats) = PVE
::Storage
::Plugin
::default_format
($target_scfg);
637 my $format_is_valid = grep { $_ eq $format } @$valid_formats;
638 die "unsupported format '$format' for storage type $target_scfg->{type}\n" if !$format_is_valid;
640 (my $name_without_extension = $name) =~ s/\.$format$//;
642 if ($target_scfg->{path
}) {
643 return "$vmid/$name_without_extension.$format";
645 return "$name_without_extension";
649 sub storage_migrate
{
650 my ($cfg, $volid, $target_sshinfo, $target_storeid, $opts, $logfunc) = @_;
652 my $base_snapshot = $opts->{base_snapshot
};
653 my $snapshot = $opts->{snapshot
};
654 my $ratelimit_bps = $opts->{ratelimit_bps
};
655 my $insecure = $opts->{insecure
};
656 my $with_snapshots = $opts->{with_snapshots
} ?
1 : 0;
657 my $allow_rename = $opts->{allow_rename
} ?
1 : 0;
659 my ($storeid, $volname) = parse_volume_id
($volid);
661 my $scfg = storage_config
($cfg, $storeid);
663 # no need to migrate shared content
664 return $volid if $storeid eq $target_storeid && $scfg->{shared
};
666 my $tcfg = storage_config
($cfg, $target_storeid);
669 if ($opts->{target_volname
}) {
670 $target_volname = $opts->{target_volname
};
671 } elsif ($scfg->{type
} eq $tcfg->{type
}) {
672 $target_volname = $volname;
674 $target_volname = $volname_for_storage->($cfg, $volid, $target_storeid);
677 my $target_volid = "${target_storeid}:${target_volname}";
679 my $target_ip = $target_sshinfo->{ip
};
681 my $ssh = PVE
::SSHInfo
::ssh_info_to_command
($target_sshinfo);
682 my $ssh_base = PVE
::SSHInfo
::ssh_info_to_command_base
($target_sshinfo);
683 local $ENV{RSYNC_RSH
} = PVE
::Tools
::cmd2string
($ssh_base);
686 if (defined($ratelimit_bps)) {
687 @cstream = ([ '/usr/bin/cstream', '-t', $ratelimit_bps ]);
688 $logfunc->("using a bandwidth limit of $ratelimit_bps bps for transferring '$volid'") if $logfunc;
691 my $migration_snapshot;
692 if (!defined($snapshot)) {
693 if ($scfg->{type
} eq 'zfspool') {
694 $migration_snapshot = 1;
695 $snapshot = '__migration__';
699 my @formats = volume_transfer_formats
($cfg, $volid, $target_volid, $snapshot, $base_snapshot, $with_snapshots);
700 die "cannot migrate from storage type '$scfg->{type}' to '$tcfg->{type}'\n" if !@formats;
701 my $format = $formats[0];
703 my $import_fn = '-'; # let pvesm import read from stdin per default
705 my $net = $target_sshinfo->{network
} // $target_sshinfo->{ip
};
706 $import_fn = "tcp://$net";
709 my $target_apiver = 1; # if there is no apiinfo call, assume 1
710 my $get_api_version = [@$ssh, 'pvesm', 'apiinfo'];
711 my $match_api_version = sub { $target_apiver = $1 if $_[0] =~ m!^APIVER (\d+)$!; };
712 eval { run_command
($get_api_version, logfunc
=> $match_api_version); };
714 my $send = ['pvesm', 'export', $volid, $format, '-', '-with-snapshots', $with_snapshots];
715 my $recv = [@$ssh, '--', 'pvesm', 'import', $target_volid, $format, $import_fn, '-with-snapshots', $with_snapshots];
716 if (defined($snapshot)) {
717 push @$send, '-snapshot', $snapshot
719 if ($migration_snapshot) {
720 push @$recv, '-delete-snapshot', $snapshot;
722 push @$recv, '-allow-rename', $allow_rename if $target_apiver >= 5;
724 if (defined($base_snapshot)) {
725 # Check if the snapshot exists on the remote side:
726 push @$send, '-base', $base_snapshot;
727 push @$recv, '-base', $base_snapshot;
731 my $pattern = volume_imported_message
(undef, 1);
732 my $match_volid_and_log = sub {
735 $new_volid = $1 if ($line =~ $pattern);
743 volume_snapshot
($cfg, $volid, $snapshot) if $migration_snapshot;
745 if (defined($snapshot)) {
746 activate_volumes
($cfg, [$volid], $snapshot);
748 activate_volumes
($cfg, [$volid]);
753 my $input = IO
::File-
>new();
754 my $info = IO
::File-
>new();
755 open3
($input, $info, $info, @{$recv})
756 or die "receive command failed: $!\n";
759 my $try_ip = <$info> // '';
760 my ($ip) = $try_ip =~ /^($PVE::Tools::IPRE)$/ # untaint
761 or die "no tunnel IP received, got '$try_ip'\n";
763 my $try_port = <$info> // '';
764 my ($port) = $try_port =~ /^(\d+)$/ # untaint
765 or die "no tunnel port received, got '$try_port'\n";
767 my $socket = IO
::Socket
::IP-
>new(PeerHost
=> $ip, PeerPort
=> $port, Type
=> SOCK_STREAM
)
768 or die "failed to connect to tunnel at $ip:$port\n";
769 # we won't be reading from the socket
770 shutdown($socket, 0);
772 eval { run_command
([$send, @cstream], output
=> '>&'.fileno($socket), errfunc
=> $logfunc); };
775 # don't close the connection entirely otherwise the receiving end
776 # might not get all buffered data (and fails with 'connection reset by peer')
777 shutdown($socket, 1);
779 # wait for the remote process to finish
780 while (my $line = <$info>) {
781 $match_volid_and_log->("[$target_sshinfo->{name}] $line");
784 # now close the socket
786 if (!close($info)) { # does waitpid()
787 die "import failed: $!\n" if $!;
788 die "import failed: exit code ".($?>>8)."\n";
791 die $send_error if $send_error;
793 run_command
([$send, @cstream, $recv], logfunc
=> $match_volid_and_log);
796 die "unable to get ID of the migrated volume\n"
797 if !defined($new_volid) && $target_apiver >= 5;
800 warn "send/receive failed, cleaning up snapshot(s)..\n" if $err;
801 if ($migration_snapshot) {
802 eval { volume_snapshot_delete
($cfg, $volid, $snapshot, 0) };
803 warn "could not remove source snapshot: $@\n" if $@;
807 return $new_volid // $target_volid;
811 my ($cfg, $volid, $vmid, $snap) = @_;
813 my ($storeid, $volname) = parse_volume_id
($volid);
815 my $scfg = storage_config
($cfg, $storeid);
817 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
819 activate_storage
($cfg, $storeid);
821 # lock shared storage
822 return $plugin->cluster_lock_storage($storeid, $scfg->{shared
}, undef, sub {
823 my $volname = $plugin->clone_image($scfg, $storeid, $volname, $vmid, $snap);
824 return "$storeid:$volname";
828 sub vdisk_create_base
{
829 my ($cfg, $volid) = @_;
831 my ($storeid, $volname) = parse_volume_id
($volid);
833 my $scfg = storage_config
($cfg, $storeid);
835 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
837 activate_storage
($cfg, $storeid);
839 # lock shared storage
840 return $plugin->cluster_lock_storage($storeid, $scfg->{shared
}, undef, sub {
841 my $volname = $plugin->create_base($storeid, $scfg, $volname);
842 return "$storeid:$volname";
847 my ($cfg, $volid, $snapname) = @_;
849 my ($storeid, $volname) = parse_volume_id
($volid);
851 my $scfg = storage_config
($cfg, $storeid);
853 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
855 return $plugin->map_volume($storeid, $scfg, $volname, $snapname);
859 my ($cfg, $volid, $snapname) = @_;
861 my ($storeid, $volname) = parse_volume_id
($volid);
863 my $scfg = storage_config
($cfg, $storeid);
865 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
867 return $plugin->unmap_volume($storeid, $scfg, $volname, $snapname);
871 my ($cfg, $storeid, $vmid, $fmt, $name, $size) = @_;
873 die "no storage ID specified\n" if !$storeid;
875 PVE
::JSONSchema
::parse_storage_id
($storeid);
877 my $scfg = storage_config
($cfg, $storeid);
879 die "no VMID specified\n" if !$vmid;
881 $vmid = parse_vmid
($vmid);
883 my $defformat = PVE
::Storage
::Plugin
::default_format
($scfg);
885 $fmt = $defformat if !$fmt;
887 activate_storage
($cfg, $storeid);
889 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
891 # lock shared storage
892 return $plugin->cluster_lock_storage($storeid, $scfg->{shared
}, undef, sub {
893 my $old_umask = umask(umask|0037);
894 my $volname = eval { $plugin->alloc_image($storeid, $scfg, $vmid, $fmt, $name, $size) };
898 return "$storeid:$volname";
903 my ($cfg, $volid) = @_;
905 my ($storeid, $volname) = parse_volume_id
($volid);
906 my $scfg = storage_config
($cfg, $storeid);
907 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
909 activate_storage
($cfg, $storeid);
913 # lock shared storage
914 $plugin->cluster_lock_storage($storeid, $scfg->{shared
}, undef, sub {
915 # LVM-thin allows deletion of still referenced base volumes!
916 die "base volume '$volname' is still in use by linked clones\n"
917 if volume_is_base_and_used
($cfg, $volid);
919 my (undef, undef, undef, undef, undef, $isBase, $format) =
920 $plugin->parse_volname($volname);
921 $cleanup_worker = $plugin->free_image($storeid, $scfg, $volname, $isBase, $format);
924 return if !$cleanup_worker;
926 my $rpcenv = PVE
::RPCEnvironment
::get
();
927 my $authuser = $rpcenv->get_user();
929 $rpcenv->fork_worker('imgdel', undef, $authuser, $cleanup_worker);
933 my ($cfg, $storeid, $vmid, $vollist, $ctype) = @_;
935 my $ids = $cfg->{ids
};
937 storage_check_enabled
($cfg, $storeid) if ($storeid);
941 # prepare/activate/refresh all storages
943 my $storage_list = [];
945 foreach my $volid (@$vollist) {
946 my ($sid, undef) = parse_volume_id
($volid);
947 next if !defined($ids->{$sid});
948 next if !storage_check_enabled
($cfg, $sid, undef, 1);
949 push @$storage_list, $sid;
952 foreach my $sid (keys %$ids) {
953 next if $storeid && $storeid ne $sid;
954 next if !storage_check_enabled
($cfg, $sid, undef, 1);
955 my $content = $ids->{$sid}->{content
};
956 next if defined($ctype) && !$content->{$ctype};
957 next if !($content->{rootdir
} || $content->{images
});
958 push @$storage_list, $sid;
964 activate_storage_list
($cfg, $storage_list, $cache);
966 # FIXME PVE 7.0: only scan storages with the correct content types
967 my $scan = defined($ctype) ?
$storage_list : [ keys %{$ids} ];
969 foreach my $sid (@{$scan}) {
970 next if $storeid && $storeid ne $sid;
971 next if !storage_check_enabled
($cfg, $sid, undef, 1);
973 my $scfg = $ids->{$sid};
974 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
975 $res->{$sid} = $plugin->list_images($sid, $scfg, $vmid, $vollist, $cache);
976 @{$res->{$sid}} = sort {lc($a->{volid
}) cmp lc ($b->{volid
}) } @{$res->{$sid}} if $res->{$sid};
983 my ($cfg, $storeid, $tt) = @_;
985 die "unknown template type '$tt'\n"
986 if !($tt eq 'iso' || $tt eq 'vztmpl' || $tt eq 'backup' || $tt eq 'snippets');
988 my $ids = $cfg->{ids
};
990 storage_check_enabled
($cfg, $storeid) if ($storeid);
995 foreach my $sid (keys %$ids) {
996 next if $storeid && $storeid ne $sid;
998 my $scfg = $ids->{$sid};
999 my $type = $scfg->{type
};
1001 next if !$scfg->{content
}->{$tt};
1003 next if !storage_check_enabled
($cfg, $sid, undef, 1);
1005 $res->{$sid} = volume_list
($cfg, $sid, undef, $tt);
1012 my ($cfg, $storeid, $vmid, $content) = @_;
1014 my @ctypes = qw(rootdir images vztmpl iso backup snippets);
1016 my $cts = $content ?
[ $content ] : [ @ctypes ];
1018 my $scfg = PVE
::Storage
::storage_config
($cfg, $storeid);
1020 $cts = [ grep { defined($scfg->{content
}->{$_}) } @$cts ];
1022 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1024 activate_storage
($cfg, $storeid);
1026 my $res = $plugin->list_volumes($storeid, $scfg, $vmid, $cts);
1028 @$res = sort {lc($a->{volid
}) cmp lc ($b->{volid
}) } @$res;
1035 my $filename = "/sys/kernel/uevent_seqnum";
1038 if (my $fh = IO
::File-
>new($filename, "r")) {
1040 if ($line =~ m/^(\d+)$/) {
1048 sub activate_storage
{
1049 my ($cfg, $storeid, $cache) = @_;
1051 $cache = {} if !$cache;
1053 my $scfg = storage_check_enabled
($cfg, $storeid);
1055 return if $cache->{activated
}->{$storeid};
1057 $cache->{uevent_seqnum
} = uevent_seqnum
() if !$cache->{uevent_seqnum
};
1059 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1061 if ($scfg->{base
}) {
1062 my ($baseid, undef) = parse_volume_id
($scfg->{base
});
1063 activate_storage
($cfg, $baseid, $cache);
1066 if (!$plugin->check_connection($storeid, $scfg)) {
1067 die "storage '$storeid' is not online\n";
1070 $plugin->activate_storage($storeid, $scfg, $cache);
1072 my $newseq = uevent_seqnum
();
1074 # only call udevsettle if there are events
1075 if ($newseq > $cache->{uevent_seqnum
}) {
1076 system ("udevadm settle --timeout=30"); # ignore errors
1077 $cache->{uevent_seqnum
} = $newseq;
1080 $cache->{activated
}->{$storeid} = 1;
1083 sub activate_storage_list
{
1084 my ($cfg, $storeid_list, $cache) = @_;
1086 $cache = {} if !$cache;
1088 foreach my $storeid (@$storeid_list) {
1089 activate_storage
($cfg, $storeid, $cache);
1093 sub deactivate_storage
{
1094 my ($cfg, $storeid) = @_;
1096 my $scfg = storage_config
($cfg, $storeid);
1097 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1100 $plugin->deactivate_storage($storeid, $scfg, $cache);
1103 sub activate_volumes
{
1104 my ($cfg, $vollist, $snapname) = @_;
1106 return if !($vollist && scalar(@$vollist));
1108 my $storagehash = {};
1109 foreach my $volid (@$vollist) {
1110 my ($storeid, undef) = parse_volume_id
($volid);
1111 $storagehash->{$storeid} = 1;
1116 activate_storage_list
($cfg, [keys %$storagehash], $cache);
1118 foreach my $volid (@$vollist) {
1119 my ($storeid, $volname) = parse_volume_id
($volid);
1120 my $scfg = storage_config
($cfg, $storeid);
1121 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1122 $plugin->activate_volume($storeid, $scfg, $volname, $snapname, $cache);
1126 sub deactivate_volumes
{
1127 my ($cfg, $vollist, $snapname) = @_;
1129 return if !($vollist && scalar(@$vollist));
1134 foreach my $volid (@$vollist) {
1135 my ($storeid, $volname) = parse_volume_id
($volid);
1137 my $scfg = storage_config
($cfg, $storeid);
1138 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1141 $plugin->deactivate_volume($storeid, $scfg, $volname, $snapname, $cache);
1145 push @errlist, $volid;
1149 die "volume deactivation failed: " . join(' ', @errlist)
1150 if scalar(@errlist);
1154 my ($cfg, $content, $includeformat) = @_;
1156 my $ids = $cfg->{ids
};
1160 my @ctypes = PVE
::Tools
::split_list
($content);
1163 foreach my $storeid (keys %$ids) {
1164 my $storage_enabled = defined(storage_check_enabled
($cfg, $storeid, undef, 1));
1166 if (defined($content)) {
1168 foreach my $ctype (@ctypes) {
1169 if ($ids->{$storeid}->{content
}->{$ctype}) {
1174 next if !$want_ctype || !$storage_enabled;
1177 my $type = $ids->{$storeid}->{type
};
1179 $info->{$storeid} = {
1184 shared
=> $ids->{$storeid}->{shared
} ?
1 : 0,
1185 content
=> PVE
::Storage
::Plugin
::content_hash_to_string
($ids->{$storeid}->{content
}),
1187 enabled
=> $storage_enabled ?
1 : 0,
1190 push @$slist, $storeid;
1195 foreach my $storeid (keys %$ids) {
1196 my $scfg = $ids->{$storeid};
1198 next if !$info->{$storeid};
1199 next if !$info->{$storeid}->{enabled
};
1201 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1202 if ($includeformat) {
1203 my $pd = $plugin->plugindata();
1204 $info->{$storeid}->{format
} = $pd->{format
}
1206 $info->{$storeid}->{select_existing
} = $pd->{select_existing
}
1207 if $pd->{select_existing
};
1210 eval { activate_storage
($cfg, $storeid, $cache); };
1216 my ($total, $avail, $used, $active) = eval { $plugin->status($storeid, $scfg, $cache); };
1219 $info->{$storeid}->{total
} = int($total);
1220 $info->{$storeid}->{avail
} = int($avail);
1221 $info->{$storeid}->{used
} = int($used);
1222 $info->{$storeid}->{active
} = $active;
1231 my ($packed_ip, $family);
1233 my @res = PVE
::Tools
::getaddrinfo_all
($server);
1234 $family = $res[0]->{family
};
1235 $packed_ip = (PVE
::Tools
::unpack_sockaddr_in46
($res[0]->{addr
}))[2];
1237 if (defined $packed_ip) {
1238 return Socket
::inet_ntop
($family, $packed_ip);
1244 my ($server_in) = @_;
1247 if (!($server = resolv_server
($server_in))) {
1248 die "unable to resolve address for server '${server_in}'\n";
1251 my $cmd = ['/sbin/showmount', '--no-headers', '--exports', $server];
1254 run_command
($cmd, outfunc
=> sub {
1257 # note: howto handle white spaces in export path??
1258 if ($line =~ m!^(/\S+)\s+(.+)$!) {
1267 my ($server_in, $user, $password, $domain) = @_;
1269 my $server = resolv_server
($server_in);
1270 die "unable to resolve address for server '${server_in}'\n" if !$server;
1272 # we only support Windows 2012 and newer, so just use smb3
1273 my $cmd = ['/usr/bin/smbclient', '-m', 'smb3', '-d', '0', '-L', $server];
1274 push @$cmd, '-W', $domain if defined($domain);
1276 push @$cmd, '-N' if !defined($password);
1277 local $ENV{USER
} = $user if defined($user);
1278 local $ENV{PASSWD
} = $password if defined($password);
1289 if ($line =~ m/(\S+)\s*Disk\s*(\S*)/) {
1291 } elsif ($line =~ m/(NT_STATUS_(\S+))/) {
1293 $err .= "unexpected status: $1\n" if uc($1) ne 'SUCCESS';
1297 # only die if we got no share, else it's just some followup check error
1298 # (like workgroup querying)
1299 raise
($err) if $err && !%$res;
1306 my $cmd = ['zfs', 'list', '-t', 'filesystem', '-Hp', '-o', 'name,avail,used'];
1309 run_command
($cmd, outfunc
=> sub {
1312 if ($line =~m/^(\S+)\s+(\S+)\s+(\S+)$/) {
1313 my ($pool, $size_str, $used_str) = ($1, $2, $3);
1314 my $size = $size_str + 0;
1315 my $used = $used_str + 0;
1316 # ignore subvolumes generated by our ZFSPoolPlugin
1317 return if $pool =~ m!/subvol-\d+-[^/]+$!;
1318 return if $pool =~ m!/basevol-\d+-[^/]+$!;
1319 push @$res, { pool
=> $pool, size
=> $size, free
=> $size-$used };
1327 my ($portal, $noerr) = @_;
1329 my ($server, $port) = PVE
::Tools
::parse_host_and_port
($portal);
1331 if (my $ip = resolv_server
($server)) {
1333 $server = "[$server]" if $server =~ /^$IPV6RE$/;
1334 return $port ?
"$server:$port" : $server;
1337 return undef if $noerr;
1339 raise_param_exc
({ portal
=> "unable to resolve portal address '$portal'" });
1344 my ($portal_in) = @_;
1347 if (!($portal = resolv_portal
($portal_in))) {
1348 die "unable to parse/resolve portal address '${portal_in}'\n";
1351 return PVE
::Storage
::ISCSIPlugin
::iscsi_discovery
($portal);
1354 sub storage_default_format
{
1355 my ($cfg, $storeid) = @_;
1357 my $scfg = storage_config
($cfg, $storeid);
1359 return PVE
::Storage
::Plugin
::default_format
($scfg);
1362 sub vgroup_is_used
{
1363 my ($cfg, $vgname) = @_;
1365 foreach my $storeid (keys %{$cfg->{ids
}}) {
1366 my $scfg = storage_config
($cfg, $storeid);
1367 if ($scfg->{type
} eq 'lvm' && $scfg->{vgname
} eq $vgname) {
1375 sub target_is_used
{
1376 my ($cfg, $target) = @_;
1378 foreach my $storeid (keys %{$cfg->{ids
}}) {
1379 my $scfg = storage_config
($cfg, $storeid);
1380 if ($scfg->{type
} eq 'iscsi' && $scfg->{target
} eq $target) {
1388 sub volume_is_used
{
1389 my ($cfg, $volid) = @_;
1391 foreach my $storeid (keys %{$cfg->{ids
}}) {
1392 my $scfg = storage_config
($cfg, $storeid);
1393 if ($scfg->{base
} && $scfg->{base
} eq $volid) {
1401 sub storage_is_used
{
1402 my ($cfg, $storeid) = @_;
1404 foreach my $sid (keys %{$cfg->{ids
}}) {
1405 my $scfg = storage_config
($cfg, $sid);
1406 next if !$scfg->{base
};
1407 my ($st) = parse_volume_id
($scfg->{base
});
1408 return 1 if $st && $st eq $storeid;
1415 my ($list, $func) = @_;
1419 foreach my $sid (keys %$list) {
1420 foreach my $info (@{$list->{$sid}}) {
1421 my $volid = $info->{volid
};
1422 my ($sid1, $volname) = parse_volume_id
($volid, 1);
1423 if ($sid1 && $sid1 eq $sid) {
1424 &$func ($volid, $sid, $info);
1426 warn "detected strange volid '$volid' in volume list for '$sid'\n";
1432 sub decompressor_info
{
1433 my ($format, $comp) = @_;
1435 if ($format eq 'tgz' && !defined($comp)) {
1436 ($format, $comp) = ('tar', 'gz');
1439 my $decompressor = {
1441 gz
=> ['tar', '-z'],
1442 lzo
=> ['tar', '--lzop'],
1443 zst
=> ['tar', '--zstd'],
1447 lzo
=> ['lzop', '-d', '-c'],
1448 zst
=> ['zstd', '-q', '-d', '-c'],
1452 die "ERROR: archive format not defined\n"
1453 if !defined($decompressor->{$format});
1456 $decomp = $decompressor->{$format}->{$comp} if $comp;
1460 compression
=> $comp,
1461 decompressor
=> $decomp,
1468 my ($archive) = shift;
1471 my $volid = basename
($archive);
1472 if ($volid =~ /^(vzdump-(lxc|openvz|qemu)-.+\.(tgz$|tar|vma)(?:\.(${\PVE::Storage::Plugin::COMPRESSOR_RE}))?)$/) {
1473 my $filename = "$1"; # untaint
1474 my ($type, $format, $comp) = ($2, $3, $4);
1475 my $format_re = defined($comp) ?
"$format.$comp" : "$format";
1476 $info = decompressor_info
($format, $comp);
1477 $info->{filename
} = $filename;
1478 $info->{type
} = $type;
1480 if ($volid =~ /^(vzdump-${type}-([1-9][0-9]{2,8})-(\d{4})_(\d{2})_(\d{2})-(\d{2})_(\d{2})_(\d{2}))\.${format_re}$/) {
1481 $info->{logfilename
} = "$1.log";
1482 $info->{vmid
} = int($2);
1483 $info->{ctime
} = timelocal
($8, $7, $6, $5, $4 - 1, $3);
1484 $info->{is_std_name
} = 1;
1486 $info->{is_std_name
} = 0;
1489 die "ERROR: couldn't determine archive info from '$archive'\n";
1495 sub archive_remove
{
1496 my ($archive_path) = @_;
1498 my $dirname = dirname
($archive_path);
1499 my $archive_info = eval { archive_info
($archive_path) } // {};
1500 my $logfn = $archive_info->{logfilename
};
1502 unlink $archive_path or die "removing archive $archive_path failed: $!\n";
1504 if (defined($logfn)) {
1505 my $logpath = "$dirname/$logfn";
1507 unlink $logpath or warn "removing log file $logpath failed: $!\n";
1512 sub extract_vzdump_config_tar
{
1513 my ($archive, $conf_re) = @_;
1515 die "ERROR: file '$archive' does not exist\n" if ! -f
$archive;
1517 my $pid = open(my $fh, '-|', 'tar', 'tf', $archive) ||
1518 die "unable to open file '$archive'\n";
1521 while (defined($file = <$fh>)) {
1522 if ($file =~ $conf_re) {
1523 $file = $1; # untaint
1532 die "ERROR: archive contains no configuration file\n" if !$file;
1538 $raw .= "$output\n";
1541 run_command
(['tar', '-xpOf', $archive, $file, '--occurrence'], outfunc
=> $out);
1543 return wantarray ?
($raw, $file) : $raw;
1546 sub extract_vzdump_config_vma
{
1547 my ($archive, $comp) = @_;
1550 my $out = sub { $raw .= "$_[0]\n"; };
1552 my $info = archive_info
($archive);
1553 $comp //= $info->{compression
};
1554 my $decompressor = $info->{decompressor
};
1557 my $cmd = [ [@$decompressor, $archive], ["vma", "config", "-"] ];
1559 # lzop/zcat exits with 1 when the pipe is closed early by vma, detect this and ignore the exit code later
1564 if ($output =~ m/lzop: Broken pipe: <stdout>/ || $output =~ m/gzip: stdout: Broken pipe/ || $output =~ m/zstd: error 70 : Write error : Broken pipe/) {
1566 } elsif (!defined ($errstring) && $output !~ m/^\s*$/) {
1567 $errstring = "Failed to extract config from VMA archive: $output\n";
1571 my $rc = eval { run_command
($cmd, outfunc
=> $out, errfunc
=> $err, noerr
=> 1) };
1574 $broken_pipe ||= $rc == 141; # broken pipe from vma POV
1576 if (!$errstring && !$broken_pipe && $rc != 0) {
1577 die "$rerr\n" if $rerr;
1578 die "config extraction failed with exit code $rc\n";
1580 die "$errstring\n" if $errstring;
1582 run_command
(["vma", "config", $archive], outfunc
=> $out);
1585 return wantarray ?
($raw, undef) : $raw;
1588 sub extract_vzdump_config
{
1589 my ($cfg, $volid) = @_;
1591 my ($storeid, $volname) = parse_volume_id
($volid);
1592 if (defined($storeid)) {
1593 my $scfg = storage_config
($cfg, $storeid);
1594 if ($scfg->{type
} eq 'pbs') {
1595 storage_check_enabled
($cfg, $storeid);
1596 return PVE
::Storage
::PBSPlugin-
>extract_vzdump_config($scfg, $volname, $storeid);
1600 my $archive = abs_filesystem_path
($cfg, $volid);
1601 my $info = archive_info
($archive);
1602 my $format = $info->{format
};
1603 my $comp = $info->{compression
};
1604 my $type = $info->{type
};
1606 if ($type eq 'lxc' || $type eq 'openvz') {
1607 return extract_vzdump_config_tar
($archive, qr!^(\./etc/vzdump/(pct|vps)\.conf)$!);
1608 } elsif ($type eq 'qemu') {
1609 if ($format eq 'tar') {
1610 return extract_vzdump_config_tar
($archive, qr!\(\./qemu-server\.conf\)!);
1612 return extract_vzdump_config_vma
($archive, $comp);
1615 die "cannot determine backup guest type for backup archive '$volid'\n";
1620 my ($cfg, $storeid, $keep, $vmid, $type, $dryrun, $logfunc) = @_;
1622 my $scfg = storage_config
($cfg, $storeid);
1623 die "storage '$storeid' does not support backups\n" if !$scfg->{content
}->{backup
};
1625 if (!defined($keep)) {
1626 die "no prune-backups options configured for storage '$storeid'\n"
1627 if !defined($scfg->{'prune-backups'});
1628 $keep = PVE
::JSONSchema
::parse_property_string
('prune-backups', $scfg->{'prune-backups'});
1631 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1632 return $plugin->prune_backups($scfg, $storeid, $keep, $vmid, $type, $dryrun, $logfunc);
1635 my $prune_mark = sub {
1636 my ($prune_entries, $keep_count, $id_func) = @_;
1638 return if !$keep_count;
1640 my $already_included = {};
1641 my $newly_included = {};
1643 foreach my $prune_entry (@{$prune_entries}) {
1644 my $mark = $prune_entry->{mark
};
1645 my $id = $id_func->($prune_entry->{ctime
});
1646 $already_included->{$id} = 1 if defined($mark) && $mark eq 'keep';
1649 foreach my $prune_entry (@{$prune_entries}) {
1650 my $mark = $prune_entry->{mark
};
1651 my $id = $id_func->($prune_entry->{ctime
});
1653 next if defined($mark) || $already_included->{$id};
1655 if (!$newly_included->{$id}) {
1656 last if scalar(keys %{$newly_included}) >= $keep_count;
1657 $newly_included->{$id} = 1;
1658 $prune_entry->{mark
} = 'keep';
1660 $prune_entry->{mark
} = 'remove';
1665 sub prune_mark_backup_group
{
1666 my ($backup_group, $keep) = @_;
1668 my $keep_all = delete $keep->{'keep-all'};
1670 if ($keep_all || !scalar(grep {$_ > 0} values %{$keep})) {
1671 $keep = { 'keep-all' => 1 } if $keep_all;
1672 foreach my $prune_entry (@{$backup_group}) {
1673 $prune_entry->{mark
} = 'keep';
1678 my $prune_list = [ sort { $b->{ctime
} <=> $a->{ctime
} } @{$backup_group} ];
1680 $prune_mark->($prune_list, $keep->{'keep-last'}, sub {
1684 $prune_mark->($prune_list, $keep->{'keep-hourly'}, sub {
1686 my (undef, undef, $hour, $day, $month, $year) = localtime($ctime);
1687 return "$hour/$day/$month/$year";
1689 $prune_mark->($prune_list, $keep->{'keep-daily'}, sub {
1691 my (undef, undef, undef, $day, $month, $year) = localtime($ctime);
1692 return "$day/$month/$year";
1694 $prune_mark->($prune_list, $keep->{'keep-weekly'}, sub {
1696 my ($sec, $min, $hour, $day, $month, $year) = localtime($ctime);
1697 my $iso_week = int(strftime
("%V", $sec, $min, $hour, $day, $month, $year));
1698 my $iso_week_year = int(strftime
("%G", $sec, $min, $hour, $day, $month, $year));
1699 return "$iso_week/$iso_week_year";
1701 $prune_mark->($prune_list, $keep->{'keep-monthly'}, sub {
1703 my (undef, undef, undef, undef, $month, $year) = localtime($ctime);
1704 return "$month/$year";
1706 $prune_mark->($prune_list, $keep->{'keep-yearly'}, sub {
1708 my $year = (localtime($ctime))[5];
1712 foreach my $prune_entry (@{$prune_list}) {
1713 $prune_entry->{mark
} //= 'remove';
1718 my ($cfg, $fh, $volid, $format, $snapshot, $base_snapshot, $with_snapshots) = @_;
1720 my ($storeid, $volname) = parse_volume_id
($volid, 1);
1721 die "cannot export volume '$volid'\n" if !$storeid;
1722 my $scfg = storage_config
($cfg, $storeid);
1723 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1724 return $plugin->volume_export($scfg, $storeid, $fh, $volname, $format,
1725 $snapshot, $base_snapshot, $with_snapshots);
1729 my ($cfg, $fh, $volid, $format, $base_snapshot, $with_snapshots, $allow_rename) = @_;
1731 my ($storeid, $volname) = parse_volume_id
($volid, 1);
1732 die "cannot import into volume '$volid'\n" if !$storeid;
1733 my $scfg = storage_config
($cfg, $storeid);
1734 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1735 return $plugin->volume_import($scfg, $storeid, $fh, $volname, $format,
1736 $base_snapshot, $with_snapshots, $allow_rename) // $volid;
1739 sub volume_export_formats
{
1740 my ($cfg, $volid, $snapshot, $base_snapshot, $with_snapshots) = @_;
1742 my ($storeid, $volname) = parse_volume_id
($volid, 1);
1743 return if !$storeid;
1744 my $scfg = storage_config
($cfg, $storeid);
1745 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1746 return $plugin->volume_export_formats($scfg, $storeid, $volname,
1747 $snapshot, $base_snapshot,
1751 sub volume_import_formats
{
1752 my ($cfg, $volid, $base_snapshot, $with_snapshots) = @_;
1754 my ($storeid, $volname) = parse_volume_id
($volid, 1);
1755 return if !$storeid;
1756 my $scfg = storage_config
($cfg, $storeid);
1757 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1758 return $plugin->volume_import_formats($scfg, $storeid, $volname,
1759 $base_snapshot, $with_snapshots);
1762 sub volume_transfer_formats
{
1763 my ($cfg, $src_volid, $dst_volid, $snapshot, $base_snapshot, $with_snapshots) = @_;
1764 my @export_formats = volume_export_formats
($cfg, $src_volid, $snapshot, $base_snapshot, $with_snapshots);
1765 my @import_formats = volume_import_formats
($cfg, $dst_volid, $base_snapshot, $with_snapshots);
1766 my %import_hash = map { $_ => 1 } @import_formats;
1767 my @common = grep { $import_hash{$_} } @export_formats;
1771 sub volume_imported_message
{
1772 my ($volid, $want_pattern) = @_;
1774 if ($want_pattern) {
1775 return qr/successfully imported '([^']*)'$/;
1777 return "successfully imported '$volid'\n";
1781 # bash completion helper
1783 sub complete_storage
{
1784 my ($cmdname, $pname, $cvalue) = @_;
1786 my $cfg = PVE
::Storage
::config
();
1788 return $cmdname eq 'add' ?
[] : [ PVE
::Storage
::storage_ids
($cfg) ];
1791 sub complete_storage_enabled
{
1792 my ($cmdname, $pname, $cvalue) = @_;
1796 my $cfg = PVE
::Storage
::config
();
1797 foreach my $sid (keys %{$cfg->{ids
}}) {
1798 next if !storage_check_enabled
($cfg, $sid, undef, 1);
1804 sub complete_content_type
{
1805 my ($cmdname, $pname, $cvalue) = @_;
1807 return [qw(rootdir images vztmpl iso backup snippets)];
1810 sub complete_volume
{
1811 my ($cmdname, $pname, $cvalue) = @_;
1815 my $storage_list = complete_storage_enabled
();
1817 if ($cvalue =~ m/^([^:]+):/) {
1818 $storage_list = [ $1 ];
1820 if (scalar(@$storage_list) > 1) {
1821 # only list storage IDs to avoid large listings
1823 foreach my $storeid (@$storage_list) {
1824 # Hack: simply return 2 artificial values, so that
1825 # completions does not finish
1826 push @$res, "$storeid:volname", "$storeid:...";
1833 foreach my $storeid (@$storage_list) {
1834 my $vollist = PVE
::Storage
::volume_list
($cfg, $storeid);
1836 foreach my $item (@$vollist) {
1837 push @$res, $item->{volid
};
1844 # Various io-heavy operations require io/bandwidth limits which can be
1845 # configured on multiple levels: The global defaults in datacenter.cfg, and
1846 # per-storage overrides. When we want to do a restore from storage A to storage
1847 # B, we should take the smaller limit defined for storages A and B, and if no
1848 # such limit was specified, use the one from datacenter.cfg.
1849 sub get_bandwidth_limit
{
1850 my ($operation, $storage_list, $override) = @_;
1852 # called for each limit (global, per-storage) with the 'default' and the
1853 # $operation limit and should udpate $override for every limit affecting
1855 my $use_global_limits = 0;
1856 my $apply_limit = sub {
1858 if (defined($bwlimit)) {
1859 my $limits = PVE
::JSONSchema
::parse_property_string
('bwlimit', $bwlimit);
1860 my $limit = $limits->{$operation} // $limits->{default};
1861 if (defined($limit)) {
1862 if (!$override || $limit < $override) {
1868 # If there was no applicable limit, try to apply the global ones.
1869 $use_global_limits = 1;
1872 my ($rpcenv, $authuser);
1873 if (defined($override)) {
1874 $rpcenv = PVE
::RPCEnvironment-
>get();
1875 $authuser = $rpcenv->get_user();
1878 # Apply per-storage limits - if there are storages involved.
1879 if (defined($storage_list) && @$storage_list) {
1880 my $config = config
();
1882 # The Datastore.Allocate permission allows us to modify the per-storage
1883 # limits, therefore it also allows us to override them.
1884 # Since we have most likely multiple storages to check, do a quick check on
1885 # the general '/storage' path to see if we can skip the checks entirely:
1886 return $override if $rpcenv && $rpcenv->check($authuser, '/storage', ['Datastore.Allocate'], 1);
1889 foreach my $storage (@$storage_list) {
1890 next if !defined($storage);
1891 # Avoid duplicate checks:
1892 next if $done{$storage};
1893 $done{$storage} = 1;
1895 # Otherwise we may still have individual /storage/$ID permissions:
1896 if (!$rpcenv || !$rpcenv->check($authuser, "/storage/$storage", ['Datastore.Allocate'], 1)) {
1897 # And if not: apply the limits.
1898 my $storecfg = storage_config
($config, $storage);
1899 $apply_limit->($storecfg->{bwlimit
});
1903 # Storage limits take precedence over the datacenter defaults, so if
1904 # a limit was applied:
1905 return $override if !$use_global_limits;
1908 # Sys.Modify on '/' means we can change datacenter.cfg which contains the
1909 # global default limits.
1910 if (!$rpcenv || !$rpcenv->check($authuser, '/', ['Sys.Modify'], 1)) {
1911 # So if we cannot modify global limits, apply them to our currently
1912 # requested override.
1913 my $dc = cfs_read_file
('datacenter.cfg');
1914 $apply_limit->($dc->{bwlimit
});
1920 # checks if the storage id is available and dies if not
1921 sub assert_sid_unused
{
1925 if (my $scfg = storage_config
($cfg, $sid, 1)) {
1926 die "storage ID '$sid' already defined\n";