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
;
26 use PVE
::RESTEnvironment
qw(log_warn);
28 use PVE
::Storage
::Plugin
;
29 use PVE
::Storage
::DirPlugin
;
30 use PVE
::Storage
::LVMPlugin
;
31 use PVE
::Storage
::LvmThinPlugin
;
32 use PVE
::Storage
::NFSPlugin
;
33 use PVE
::Storage
::CIFSPlugin
;
34 use PVE
::Storage
::ISCSIPlugin
;
35 use PVE
::Storage
::RBDPlugin
;
36 use PVE
::Storage
::CephFSPlugin
;
37 use PVE
::Storage
::ISCSIDirectPlugin
;
38 use PVE
::Storage
::GlusterfsPlugin
;
39 use PVE
::Storage
::ZFSPoolPlugin
;
40 use PVE
::Storage
::ZFSPlugin
;
41 use PVE
::Storage
::PBSPlugin
;
42 use PVE
::Storage
::BTRFSPlugin
;
44 # Storage API version. Increment it on changes in storage API interface.
45 use constant APIVER
=> 10;
46 # Age is the number of versions we're backward compatible with.
47 # This is like having 'current=APIVER' and age='APIAGE' in libtool,
48 # see https://www.gnu.org/software/libtool/manual/html_node/Libtool-versioning.html
49 use constant APIAGE
=> 1;
51 our $KNOWN_EXPORT_FORMATS = ['raw+size', 'tar+size', 'qcow2+size', 'vmdk+size', 'zfs', 'btrfs'];
53 # load standard plugins
54 PVE
::Storage
::DirPlugin-
>register();
55 PVE
::Storage
::LVMPlugin-
>register();
56 PVE
::Storage
::LvmThinPlugin-
>register();
57 PVE
::Storage
::NFSPlugin-
>register();
58 PVE
::Storage
::CIFSPlugin-
>register();
59 PVE
::Storage
::ISCSIPlugin-
>register();
60 PVE
::Storage
::RBDPlugin-
>register();
61 PVE
::Storage
::CephFSPlugin-
>register();
62 PVE
::Storage
::ISCSIDirectPlugin-
>register();
63 PVE
::Storage
::GlusterfsPlugin-
>register();
64 PVE
::Storage
::ZFSPoolPlugin-
>register();
65 PVE
::Storage
::ZFSPlugin-
>register();
66 PVE
::Storage
::PBSPlugin-
>register();
67 PVE
::Storage
::BTRFSPlugin-
>register();
69 # load third-party plugins
70 if ( -d
'/usr/share/perl5/PVE/Storage/Custom' ) {
71 dir_glob_foreach
('/usr/share/perl5/PVE/Storage/Custom', '.*\.pm$', sub {
73 my $modname = 'PVE::Storage::Custom::' . $file;
74 $modname =~ s!\.pm$!!;
75 $file = 'PVE/Storage/Custom/' . $file;
80 # Check perl interface:
81 die "not derived from PVE::Storage::Plugin\n" if !$modname->isa('PVE::Storage::Plugin');
82 die "does not provide an api() method\n" if !$modname->can('api');
83 # Check storage API version and that file is really storage plugin.
84 my $version = $modname->api();
85 die "implements an API version newer than current ($version > " . APIVER
. ")\n"
87 my $min_version = (APIVER
- APIAGE
);
88 die "API version too old, please update the plugin ($version < $min_version)\n"
89 if $version < $min_version;
90 # all OK, do import and register (i.e., "use")
94 # If we got this far and the API version is not the same, make some noise:
95 warn "Plugin \"$modname\" is implementing an older storage API
, an upgrade
is recommended
\n"
96 if $version != APIVER;
99 warn "Error loading storage plugin
\"$modname\": $@";
104 # initialize all plugins
105 PVE
::Storage
::Plugin-
>init();
107 # the following REs indicate the number or capture groups via the trailing digit
108 # CAUTION don't forget to update the digits accordingly after messing with the capture groups
110 our $ISO_EXT_RE_0 = qr/\.(?:iso|img)/i;
112 our $VZTMPL_EXT_RE_1 = qr/\.tar\.(gz|xz|zst)/i;
114 our $BACKUP_EXT_RE_2 = qr/\.(tgz|(?:tar|vma)(?:\.(${\PVE::Storage::Plugin::COMPRESSOR_RE}))?)/;
116 # FIXME remove with PVE 8.0, add versioned breaks for pve-manager
117 our $vztmpl_extension_re = $VZTMPL_EXT_RE_1;
119 # PVE::Storage utility functions
122 return cfs_read_file
("storage.cfg");
128 cfs_write_file
('storage.cfg', $cfg);
131 sub lock_storage_config
{
132 my ($code, $errmsg) = @_;
134 cfs_lock_file
("storage.cfg", undef, $code);
137 $errmsg ?
die "$errmsg: $err" : die $err;
141 # FIXME remove maxfiles for PVE 8.0 or PVE 9.0
142 my $convert_maxfiles_to_prune_backups = sub {
147 my $maxfiles = delete $scfg->{maxfiles
};
149 if (!defined($scfg->{'prune-backups'}) && defined($maxfiles)) {
152 $prune_backups = { 'keep-last' => $maxfiles };
153 } else { # maxfiles 0 means no limit
154 $prune_backups = { 'keep-all' => 1 };
156 $scfg->{'prune-backups'} = PVE
::JSONSchema
::print_property_string
(
164 my ($cfg, $storeid, $noerr) = @_;
166 die "no storage ID specified\n" if !$storeid;
168 my $scfg = $cfg->{ids
}->{$storeid};
170 die "storage '$storeid' does not exist\n" if (!$noerr && !$scfg);
172 $convert_maxfiles_to_prune_backups->($scfg);
177 sub storage_check_node
{
178 my ($cfg, $storeid, $node, $noerr) = @_;
180 my $scfg = storage_config
($cfg, $storeid);
182 if ($scfg->{nodes
}) {
183 $node = PVE
::INotify
::nodename
() if !$node || ($node eq 'localhost');
184 if (!$scfg->{nodes
}->{$node}) {
185 die "storage '$storeid' is not available on node '$node'\n" if !$noerr;
193 sub storage_check_enabled
{
194 my ($cfg, $storeid, $node, $noerr) = @_;
196 my $scfg = storage_config
($cfg, $storeid);
198 if ($scfg->{disable
}) {
199 die "storage '$storeid' is disabled\n" if !$noerr;
203 return storage_check_node
($cfg, $storeid, $node, $noerr);
206 # storage_can_replicate:
207 # return true if storage supports replication
208 # (volumes allocated with vdisk_alloc() has replication feature)
209 sub storage_can_replicate
{
210 my ($cfg, $storeid, $format) = @_;
212 my $scfg = storage_config
($cfg, $storeid);
213 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
214 return $plugin->storage_can_replicate($scfg, $storeid, $format);
217 sub get_max_protected_backups
{
218 my ($scfg, $storeid) = @_;
220 return $scfg->{'max-protected-backups'} if defined($scfg->{'max-protected-backups'});
222 my $rpcenv = PVE
::RPCEnvironment
::get
();
223 my $authuser = $rpcenv->get_user();
225 return $rpcenv->check($authuser, "/storage/$storeid", ['Datastore.Allocate'], 1) ?
-1 : 5;
231 return keys %{$cfg->{ids
}};
235 my ($filename, $timeout) = @_;
237 return PVE
::Storage
::Plugin
::file_size_info
($filename, $timeout);
240 sub get_volume_attribute
{
241 my ($cfg, $volid, $attribute) = @_;
243 my ($storeid, $volname) = parse_volume_id
($volid);
244 my $scfg = storage_config
($cfg, $storeid);
245 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
247 return $plugin->get_volume_attribute($scfg, $storeid, $volname, $attribute);
250 sub update_volume_attribute
{
251 my ($cfg, $volid, $attribute, $value) = @_;
253 my ($storeid, $volname) = parse_volume_id
($volid);
254 my $scfg = storage_config
($cfg, $storeid);
255 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
257 my ($vtype, undef, $vmid) = $plugin->parse_volname($volname);
258 my $max_protected_backups = get_max_protected_backups
($scfg, $storeid);
263 && $attribute eq 'protected'
265 && !$plugin->get_volume_attribute($scfg, $storeid, $volname, 'protected')
266 && $max_protected_backups > -1 # -1 is unlimited
268 my $backups = $plugin->list_volumes($storeid, $scfg, $vmid, ['backup']);
269 my ($backup_type) = map { $_->{subtype
} } grep { $_->{volid
} eq $volid } $backups->@*;
271 my $protected_count = grep {
272 $_->{protected
} && (!$backup_type || ($_->{subtype
} && $_->{subtype
} eq $backup_type))
275 if ($max_protected_backups <= $protected_count) {
276 die "The number of protected backups per guest is limited to $max_protected_backups ".
277 "on storage '$storeid'\n";
281 return $plugin->update_volume_attribute($scfg, $storeid, $volname, $attribute, $value);
284 sub volume_size_info
{
285 my ($cfg, $volid, $timeout) = @_;
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_size_info($scfg, $storeid, $volname, $timeout);
292 } elsif ($volid =~ m
|^(/.+)$| && -e
$volid) {
293 return file_size_info
($volid, $timeout);
300 my ($cfg, $volid, $size, $running) = @_;
302 my $padding = (1024 - $size % 1024) % 1024;
303 $size = $size + $padding;
305 my ($storeid, $volname) = parse_volume_id
($volid, 1);
307 my $scfg = storage_config
($cfg, $storeid);
308 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
309 return $plugin->volume_resize($scfg, $storeid, $volname, $size, $running);
310 } elsif ($volid =~ m
|^(/.+)$| && -e
$volid) {
311 die "resize file/device '$volid' is not possible\n";
313 die "unable to parse volume ID '$volid'\n";
317 sub volume_rollback_is_possible
{
318 my ($cfg, $volid, $snap, $blockers) = @_;
320 my ($storeid, $volname) = parse_volume_id
($volid, 1);
322 my $scfg = storage_config
($cfg, $storeid);
323 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
324 return $plugin->volume_rollback_is_possible($scfg, $storeid, $volname, $snap, $blockers);
325 } elsif ($volid =~ m
|^(/.+)$| && -e
$volid) {
326 die "snapshot rollback file/device '$volid' is not possible\n";
328 die "unable to parse volume ID '$volid'\n";
332 sub volume_snapshot
{
333 my ($cfg, $volid, $snap) = @_;
335 my ($storeid, $volname) = parse_volume_id
($volid, 1);
337 my $scfg = storage_config
($cfg, $storeid);
338 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
339 return $plugin->volume_snapshot($scfg, $storeid, $volname, $snap);
340 } elsif ($volid =~ m
|^(/.+)$| && -e
$volid) {
341 die "snapshot file/device '$volid' is not possible\n";
343 die "unable to parse volume ID '$volid'\n";
347 sub volume_snapshot_rollback
{
348 my ($cfg, $volid, $snap) = @_;
350 my ($storeid, $volname) = parse_volume_id
($volid, 1);
352 my $scfg = storage_config
($cfg, $storeid);
353 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
354 $plugin->volume_rollback_is_possible($scfg, $storeid, $volname, $snap);
355 return $plugin->volume_snapshot_rollback($scfg, $storeid, $volname, $snap);
356 } elsif ($volid =~ m
|^(/.+)$| && -e
$volid) {
357 die "snapshot rollback file/device '$volid' is not possible\n";
359 die "unable to parse volume ID '$volid'\n";
363 # FIXME PVE 8.x remove $running parameter (needs APIAGE reset)
364 sub volume_snapshot_delete
{
365 my ($cfg, $volid, $snap, $running) = @_;
367 my ($storeid, $volname) = parse_volume_id
($volid, 1);
369 my $scfg = storage_config
($cfg, $storeid);
370 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
371 return $plugin->volume_snapshot_delete($scfg, $storeid, $volname, $snap, $running);
372 } elsif ($volid =~ m
|^(/.+)$| && -e
$volid) {
373 die "snapshot delete file/device '$volid' is not possible\n";
375 die "unable to parse volume ID '$volid'\n";
379 # check if a filesystem on top of a volume needs to flush its journal for
380 # consistency (see fsfreeze(8)) before a snapshot is taken - needed for
381 # container mountpoints
382 sub volume_snapshot_needs_fsfreeze
{
383 my ($cfg, $volid) = @_;
385 my ($storeid, $volname) = parse_volume_id
($volid);
386 my $scfg = storage_config
($cfg, $storeid);
387 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
388 return $plugin->volume_snapshot_needs_fsfreeze();
391 # check if a volume or snapshot supports a given feature
393 # clone - linked clone is possible
394 # copy - full clone is possible
395 # replicate - replication is possible
396 # snapshot - taking a snapshot is possible
397 # sparseinit - volume is sparsely initialized
398 # template - conversion to base image is possible
399 # rename - renaming volumes is possible
400 # $snap - check if the feature is supported for a given snapshot
401 # $running - if the guest owning the volume is running
402 # $opts - hash with further options:
403 # valid_target_formats - list of formats for the target of a copy/clone
404 # operation that the caller could work with. The
405 # format of $volid is always considered valid and if
406 # no list is specified, all formats are considered valid.
407 sub volume_has_feature
{
408 my ($cfg, $feature, $volid, $snap, $running, $opts) = @_;
410 my ($storeid, $volname) = parse_volume_id
($volid, 1);
412 my $scfg = storage_config
($cfg, $storeid);
413 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
414 return $plugin->volume_has_feature($scfg, $feature, $storeid, $volname, $snap, $running, $opts);
415 } elsif ($volid =~ m
|^(/.+)$| && -e
$volid) {
422 sub volume_snapshot_info
{
423 my ($cfg, $volid) = @_;
425 my ($storeid, $volname) = parse_volume_id
($volid);
426 my $scfg = storage_config
($cfg, $storeid);
427 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
428 return $plugin->volume_snapshot_info($scfg, $storeid, $volname);
432 my ($cfg, $storeid, $vmid) = @_;
434 my $scfg = storage_config
($cfg, $storeid);
435 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
437 my $path = $plugin->get_subdir($scfg, 'images');
439 return $vmid ?
"$path/$vmid" : $path;
442 sub get_private_dir
{
443 my ($cfg, $storeid, $vmid) = @_;
445 my $scfg = storage_config
($cfg, $storeid);
446 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
448 my $path = $plugin->get_subdir($scfg, 'rootdir');
450 return $vmid ?
"$path/$vmid" : $path;
454 my ($cfg, $storeid) = @_;
456 my $scfg = storage_config
($cfg, $storeid);
457 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
459 return $plugin->get_subdir($scfg, 'iso');
463 my ($cfg, $storeid) = @_;
465 my $scfg = storage_config
($cfg, $storeid);
466 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
468 return $plugin->get_subdir($scfg, 'vztmpl');
472 my ($cfg, $storeid) = @_;
474 my $scfg = storage_config
($cfg, $storeid);
475 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
477 return $plugin->get_subdir($scfg, 'backup');
480 # library implementation
485 die "VMID '$vmid' contains illegal characters\n" if $vmid !~ m/^\d+$/;
490 # NOTE: basename and basevmid are always undef for LVM-thin, where the
491 # clone -> base reference is not encoded in the volume ID.
492 # see note in PVE::Storage::LvmThinPlugin for details.
494 my ($cfg, $volid) = @_;
496 my ($storeid, $volname) = parse_volume_id
($volid);
498 my $scfg = storage_config
($cfg, $storeid);
500 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
502 # returns ($vtype, $name, $vmid, $basename, $basevmid, $isBase, $format)
504 return $plugin->parse_volname($volname);
507 sub parse_volume_id
{
508 my ($volid, $noerr) = @_;
510 return PVE
::Storage
::Plugin
::parse_volume_id
($volid, $noerr);
513 # test if we have read access to volid
514 sub check_volume_access
{
515 my ($rpcenv, $user, $cfg, $vmid, $volid, $type) = @_;
517 my ($sid, $volname) = parse_volume_id
($volid, 1);
519 my ($vtype, undef, $ownervm) = parse_volname
($cfg, $volid);
521 # Need to allow 'images' when expecting 'rootdir' too - not cleanly separated in plugins.
522 die "unable to use volume $volid - content type needs to be '$type'\n"
523 if defined($type) && $vtype ne $type && ($type ne 'rootdir' || $vtype ne 'images');
525 return if $rpcenv->check($user, "/storage/$sid", ['Datastore.Allocate'], 1);
527 if ($vtype eq 'iso' || $vtype eq 'vztmpl') {
528 # require at least read access to storage, (custom) templates/ISOs could be sensitive
529 $rpcenv->check_any($user, "/storage/$sid", ['Datastore.AllocateSpace', 'Datastore.Audit']);
530 } elsif (defined($ownervm) && defined($vmid) && ($ownervm == $vmid)) {
531 # we are owner - allow access
532 } elsif ($vtype eq 'backup' && $ownervm) {
533 $rpcenv->check($user, "/storage/$sid", ['Datastore.AllocateSpace']);
534 $rpcenv->check($user, "/vms/$ownervm", ['VM.Backup']);
535 } elsif (($vtype eq 'images' || $vtype eq 'rootdir') && $ownervm) {
536 $rpcenv->check($user, "/storage/$sid", ['Datastore.Audit']);
537 $rpcenv->check($user, "/vms/$ownervm", ['VM.Config.Disk']);
539 die "missing privileges to access $volid\n";
542 die "Only root can pass arbitrary filesystem paths."
543 if $user ne 'root@pam';
549 # NOTE: this check does not work for LVM-thin, where the clone -> base
550 # reference is not encoded in the volume ID.
551 # see note in PVE::Storage::LvmThinPlugin for details.
552 sub volume_is_base_and_used
{
553 my ($cfg, $volid) = @_;
555 my ($storeid, $volname) = parse_volume_id
($volid);
556 my $scfg = storage_config
($cfg, $storeid);
557 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
559 my ($vtype, $name, $vmid, undef, undef, $isBase, undef) =
560 $plugin->parse_volname($volname);
563 my $vollist = $plugin->list_images($storeid, $scfg);
564 foreach my $info (@$vollist) {
565 my (undef, $tmpvolname) = parse_volume_id
($info->{volid
});
566 my $basename = undef;
567 my $basevmid = undef;
570 (undef, undef, undef, $basename, $basevmid) =
571 $plugin->parse_volname($tmpvolname);
574 if ($basename && defined($basevmid) && $basevmid == $vmid && $basename eq $name) {
582 # try to map a filesystem path to a volume identifier
583 sub path_to_volume_id
{
584 my ($cfg, $path) = @_;
586 my $ids = $cfg->{ids
};
588 my ($sid, $volname) = parse_volume_id
($path, 1);
590 if (my $scfg = $ids->{$sid}) {
592 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
593 my ($vtype, $name, $vmid) = $plugin->parse_volname($volname);
594 return ($vtype, $path);
600 # Note: abs_path() return undef if $path doesn not exist
601 # for example when nfs storage is not mounted
602 $path = abs_path
($path) || $path;
604 foreach my $sid (keys %$ids) {
605 my $scfg = $ids->{$sid};
606 next if !$scfg->{path
};
607 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
608 my $imagedir = $plugin->get_subdir($scfg, 'images');
609 my $isodir = $plugin->get_subdir($scfg, 'iso');
610 my $tmpldir = $plugin->get_subdir($scfg, 'vztmpl');
611 my $backupdir = $plugin->get_subdir($scfg, 'backup');
612 my $privatedir = $plugin->get_subdir($scfg, 'rootdir');
613 my $snippetsdir = $plugin->get_subdir($scfg, 'snippets');
615 if ($path =~ m!^$imagedir/(\d+)/([^/\s]+)$!) {
619 my $vollist = $plugin->list_images($sid, $scfg, $vmid);
620 foreach my $info (@$vollist) {
621 my ($storeid, $volname) = parse_volume_id
($info->{volid
});
622 my $volpath = $plugin->path($scfg, $volname, $storeid);
623 if ($volpath eq $path) {
624 return ('images', $info->{volid
});
627 } elsif ($path =~ m!^$isodir/([^/]+$ISO_EXT_RE_0)$!) {
629 return ('iso', "$sid:iso/$name");
630 } elsif ($path =~ m!^$tmpldir/([^/]+$VZTMPL_EXT_RE_1)$!) {
632 return ('vztmpl', "$sid:vztmpl/$name");
633 } elsif ($path =~ m!^$privatedir/(\d+)$!) {
635 return ('rootdir', "$sid:rootdir/$vmid");
636 } elsif ($path =~ m!^$backupdir/([^/]+$BACKUP_EXT_RE_2)$!) {
638 return ('backup', "$sid:backup/$name");
639 } elsif ($path =~ m!^$snippetsdir/([^/]+)$!) {
641 return ('snippets', "$sid:snippets/$name");
645 # can't map path to volume id
650 my ($cfg, $volid, $snapname) = @_;
652 my ($storeid, $volname) = parse_volume_id
($volid);
654 my $scfg = storage_config
($cfg, $storeid);
656 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
657 my ($path, $owner, $vtype) = $plugin->path($scfg, $volname, $storeid, $snapname);
658 return wantarray ?
($path, $owner, $vtype) : $path;
661 sub abs_filesystem_path
{
662 my ($cfg, $volid, $allow_blockdev) = @_;
665 if (parse_volume_id
($volid, 1)) {
666 activate_volumes
($cfg, [ $volid ]);
667 $path = PVE
::Storage
::path
($cfg, $volid);
669 if (-f
$volid || ($allow_blockdev && -b
$volid)) {
670 my $abspath = abs_path
($volid);
671 if ($abspath && $abspath =~ m
|^(/.+)$|) {
672 $path = $1; # untaint any path
676 die "can't find file '$volid'\n"
677 if !($path && (-f
$path || ($allow_blockdev && -b
$path)));
682 # used as last resort to adapt volnames when migrating
683 my $volname_for_storage = sub {
684 my ($cfg, $storeid, $name, $vmid, $format) = @_;
686 my $scfg = storage_config
($cfg, $storeid);
688 my (undef, $valid_formats) = PVE
::Storage
::Plugin
::default_format
($scfg);
689 my $format_is_valid = grep { $_ eq $format } @$valid_formats;
690 die "unsupported format '$format' for storage type $scfg->{type}\n"
691 if !$format_is_valid;
693 (my $name_without_extension = $name) =~ s/\.$format$//;
696 return "$vmid/$name_without_extension.$format";
698 return "$name_without_extension";
702 # whether a migration snapshot is needed for a given storage
703 sub storage_migrate_snapshot
{
704 my ($cfg, $storeid, $existing_snapshots) = @_;
705 my $scfg = storage_config
($cfg, $storeid);
707 return $scfg->{type
} eq 'zfspool' || ($scfg->{type
} eq 'btrfs' && $existing_snapshots);
710 my $volume_import_prepare = sub {
711 my ($volid, $format, $path, $apiver, $opts) = @_;
713 my $base_snapshot = $opts->{base_snapshot
};
714 my $snapshot = $opts->{snapshot
};
715 my $with_snapshots = $opts->{with_snapshots
} ?
1 : 0;
716 my $migration_snapshot = $opts->{migration_snapshot
} ?
1 : 0;
717 my $allow_rename = $opts->{allow_rename
} ?
1 : 0;
719 my $recv = ['pvesm', 'import', $volid, $format, $path, '-with-snapshots', $with_snapshots];
720 if (defined($snapshot)) {
721 push @$recv, '-snapshot', $snapshot;
723 if ($migration_snapshot) {
724 push @$recv, '-delete-snapshot', $snapshot;
726 push @$recv, '-allow-rename', $allow_rename if $apiver >= 5;
728 if (defined($base_snapshot)) {
729 # Check if the snapshot exists on the remote side:
730 push @$recv, '-base', $base_snapshot if $apiver >= 9;
736 my $volume_export_prepare = sub {
737 my ($cfg, $volid, $format, $logfunc, $opts) = @_;
738 my $base_snapshot = $opts->{base_snapshot
};
739 my $snapshot = $opts->{snapshot
};
740 my $with_snapshots = $opts->{with_snapshots
} ?
1 : 0;
741 my $migration_snapshot = $opts->{migration_snapshot
} ?
1 : 0;
742 my $ratelimit_bps = $opts->{ratelimit_bps
};
744 my $send = ['pvesm', 'export', $volid, $format, '-', '-with-snapshots', $with_snapshots];
745 if (defined($snapshot)) {
746 push @$send, '-snapshot', $snapshot;
748 if (defined($base_snapshot)) {
749 push @$send, '-base', $base_snapshot;
753 if (defined($ratelimit_bps)) {
754 $cstream = [ '/usr/bin/cstream', '-t', $ratelimit_bps ];
755 $logfunc->("using a bandwidth limit of $ratelimit_bps bps for transferring '$volid'") if $logfunc;
758 volume_snapshot
($cfg, $volid, $snapshot) if $migration_snapshot;
760 if (defined($snapshot)) {
761 activate_volumes
($cfg, [$volid], $snapshot);
763 activate_volumes
($cfg, [$volid]);
766 return $cstream ?
[ $send, $cstream ] : [ $send ];
769 sub storage_migrate
{
770 my ($cfg, $volid, $target_sshinfo, $target_storeid, $opts, $logfunc) = @_;
772 my $insecure = $opts->{insecure
};
774 my ($storeid, $volname) = parse_volume_id
($volid);
776 my $scfg = storage_config
($cfg, $storeid);
778 # no need to migrate shared content
779 return $volid if $storeid eq $target_storeid && $scfg->{shared
};
781 my $tcfg = storage_config
($cfg, $target_storeid);
784 if ($opts->{target_volname
}) {
785 $target_volname = $opts->{target_volname
};
786 } elsif ($scfg->{type
} eq $tcfg->{type
}) {
787 $target_volname = $volname;
789 my (undef, $name, $vmid, undef, undef, undef, $format) = parse_volname
($cfg, $volid);
790 $target_volname = $volname_for_storage->($cfg, $target_storeid, $name, $vmid, $format);
793 my $target_volid = "${target_storeid}:${target_volname}";
795 my $target_ip = $target_sshinfo->{ip
};
797 my $ssh = PVE
::SSHInfo
::ssh_info_to_command
($target_sshinfo);
798 my $ssh_base = PVE
::SSHInfo
::ssh_info_to_command_base
($target_sshinfo);
799 local $ENV{RSYNC_RSH
} = PVE
::Tools
::cmd2string
($ssh_base);
801 if (!defined($opts->{snapshot
})) {
802 $opts->{migration_snapshot
} = storage_migrate_snapshot
($cfg, $storeid, $opts->{with_snapshots
});
803 $opts->{snapshot
} = '__migration__' if $opts->{migration_snapshot
};
806 my @formats = volume_transfer_formats
($cfg, $volid, $target_volid, $opts->{snapshot
}, $opts->{base_snapshot
}, $opts->{with_snapshots
});
807 die "cannot migrate from storage type '$scfg->{type}' to '$tcfg->{type}'\n" if !@formats;
808 my $format = $formats[0];
810 my $import_fn = '-'; # let pvesm import read from stdin per default
812 my $net = $target_sshinfo->{network
} // $target_sshinfo->{ip
};
813 $import_fn = "tcp://$net";
816 my $target_apiver = 1; # if there is no apiinfo call, assume 1
817 my $get_api_version = [@$ssh, 'pvesm', 'apiinfo'];
818 my $match_api_version = sub { $target_apiver = $1 if $_[0] =~ m!^APIVER (\d+)$!; };
819 eval { run_command
($get_api_version, logfunc
=> $match_api_version); };
821 my $recv = [ @$ssh, '--', $volume_import_prepare->($target_volid, $format, $import_fn, $target_apiver, $opts)->@* ];
824 my $pattern = volume_imported_message
(undef, 1);
825 my $match_volid_and_log = sub {
828 $new_volid = $1 if ($line =~ $pattern);
836 my $cmds = $volume_export_prepare->($cfg, $volid, $format, $logfunc, $opts);
840 my $input = IO
::File-
>new();
841 my $info = IO
::File-
>new();
842 open3
($input, $info, $info, @$recv)
843 or die "receive command failed: $!\n";
846 my $try_ip = <$info> // '';
847 my ($ip) = $try_ip =~ /^($PVE::Tools::IPRE)$/ # untaint
848 or die "no tunnel IP received, got '$try_ip'\n";
850 my $try_port = <$info> // '';
851 my ($port) = $try_port =~ /^(\d+)$/ # untaint
852 or die "no tunnel port received, got '$try_port'\n";
854 my $socket = IO
::Socket
::IP-
>new(PeerHost
=> $ip, PeerPort
=> $port, Type
=> SOCK_STREAM
)
855 or die "failed to connect to tunnel at $ip:$port\n";
856 # we won't be reading from the socket
857 shutdown($socket, 0);
859 eval { run_command
($cmds, output
=> '>&'.fileno($socket), errfunc
=> $logfunc); };
862 # don't close the connection entirely otherwise the receiving end
863 # might not get all buffered data (and fails with 'connection reset by peer')
864 shutdown($socket, 1);
866 # wait for the remote process to finish
867 while (my $line = <$info>) {
868 $match_volid_and_log->("[$target_sshinfo->{name}] $line");
871 # now close the socket
873 if (!close($info)) { # does waitpid()
874 die "import failed: $!\n" if $!;
875 die "import failed: exit code ".($?>>8)."\n";
878 die $send_error if $send_error;
881 run_command
($cmds, logfunc
=> $match_volid_and_log);
884 die "unable to get ID of the migrated volume\n"
885 if !defined($new_volid) && $target_apiver >= 5;
888 warn "send/receive failed, cleaning up snapshot(s)..\n" if $err;
889 if ($opts->{migration_snapshot
}) {
890 eval { volume_snapshot_delete
($cfg, $volid, $opts->{snapshot
}, 0) };
891 warn "could not remove source snapshot: $@\n" if $@;
895 return $new_volid // $target_volid;
899 my ($cfg, $volid, $vmid, $snap) = @_;
901 my ($storeid, $volname) = parse_volume_id
($volid);
903 my $scfg = storage_config
($cfg, $storeid);
905 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
907 activate_storage
($cfg, $storeid);
909 # lock shared storage
910 return $plugin->cluster_lock_storage($storeid, $scfg->{shared
}, undef, sub {
911 my $volname = $plugin->clone_image($scfg, $storeid, $volname, $vmid, $snap);
912 return "$storeid:$volname";
916 sub vdisk_create_base
{
917 my ($cfg, $volid) = @_;
919 my ($storeid, $volname) = parse_volume_id
($volid);
921 my $scfg = storage_config
($cfg, $storeid);
923 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
925 activate_storage
($cfg, $storeid);
927 # lock shared storage
928 return $plugin->cluster_lock_storage($storeid, $scfg->{shared
}, undef, sub {
929 my $volname = $plugin->create_base($storeid, $scfg, $volname);
930 return "$storeid:$volname";
935 my ($cfg, $volid, $snapname) = @_;
937 my ($storeid, $volname) = parse_volume_id
($volid);
939 my $scfg = storage_config
($cfg, $storeid);
941 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
943 return $plugin->map_volume($storeid, $scfg, $volname, $snapname);
947 my ($cfg, $volid, $snapname) = @_;
949 my ($storeid, $volname) = parse_volume_id
($volid);
951 my $scfg = storage_config
($cfg, $storeid);
953 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
955 return $plugin->unmap_volume($storeid, $scfg, $volname, $snapname);
959 my ($cfg, $storeid, $vmid, $fmt, $name, $size) = @_;
961 die "no storage ID specified\n" if !$storeid;
963 PVE
::JSONSchema
::parse_storage_id
($storeid);
965 my $scfg = storage_config
($cfg, $storeid);
967 die "no VMID specified\n" if !$vmid;
969 $vmid = parse_vmid
($vmid);
971 my $defformat = PVE
::Storage
::Plugin
::default_format
($scfg);
973 $fmt = $defformat if !$fmt;
975 activate_storage
($cfg, $storeid);
977 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
979 # lock shared storage
980 return $plugin->cluster_lock_storage($storeid, $scfg->{shared
}, undef, sub {
981 my $old_umask = umask(umask|0037);
982 my $volname = eval { $plugin->alloc_image($storeid, $scfg, $vmid, $fmt, $name, $size) };
986 return "$storeid:$volname";
991 my ($cfg, $volid) = @_;
993 my ($storeid, $volname) = parse_volume_id
($volid);
994 my $scfg = storage_config
($cfg, $storeid);
995 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
997 activate_storage
($cfg, $storeid);
1001 # lock shared storage
1002 $plugin->cluster_lock_storage($storeid, $scfg->{shared
}, undef, sub {
1003 # LVM-thin allows deletion of still referenced base volumes!
1004 die "base volume '$volname' is still in use by linked clones\n"
1005 if volume_is_base_and_used
($cfg, $volid);
1007 my (undef, undef, undef, undef, undef, $isBase, $format) =
1008 $plugin->parse_volname($volname);
1009 $cleanup_worker = $plugin->free_image($storeid, $scfg, $volname, $isBase, $format);
1012 return if !$cleanup_worker;
1014 my $rpcenv = PVE
::RPCEnvironment
::get
();
1015 my $authuser = $rpcenv->get_user();
1017 $rpcenv->fork_worker('imgdel', undef, $authuser, $cleanup_worker);
1021 my ($cfg, $storeid, $vmid, $vollist, $ctype) = @_;
1023 my $ids = $cfg->{ids
};
1025 storage_check_enabled
($cfg, $storeid) if ($storeid);
1027 my $res = $storeid ?
{ $storeid => [] } : {};
1029 # prepare/activate/refresh all storages
1031 my $storage_list = [];
1033 foreach my $volid (@$vollist) {
1034 my ($sid, undef) = parse_volume_id
($volid);
1035 next if !defined($ids->{$sid});
1036 next if !storage_check_enabled
($cfg, $sid, undef, 1);
1037 push @$storage_list, $sid;
1040 foreach my $sid (keys %$ids) {
1041 next if $storeid && $storeid ne $sid;
1042 next if !storage_check_enabled
($cfg, $sid, undef, 1);
1043 my $content = $ids->{$sid}->{content
};
1044 next if defined($ctype) && !$content->{$ctype};
1045 next if !($content->{rootdir
} || $content->{images
});
1046 push @$storage_list, $sid;
1052 activate_storage_list
($cfg, $storage_list, $cache);
1054 for my $sid ($storage_list->@*) {
1055 next if $storeid && $storeid ne $sid;
1057 my $scfg = $ids->{$sid};
1058 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1059 $res->{$sid} = $plugin->list_images($sid, $scfg, $vmid, $vollist, $cache);
1060 @{$res->{$sid}} = sort {lc($a->{volid
}) cmp lc ($b->{volid
}) } @{$res->{$sid}} if $res->{$sid};
1067 my ($cfg, $storeid, $tt) = @_;
1069 die "unknown template type '$tt'\n"
1070 if !($tt eq 'iso' || $tt eq 'vztmpl' || $tt eq 'backup' || $tt eq 'snippets');
1072 my $ids = $cfg->{ids
};
1074 storage_check_enabled
($cfg, $storeid) if ($storeid);
1079 foreach my $sid (keys %$ids) {
1080 next if $storeid && $storeid ne $sid;
1082 my $scfg = $ids->{$sid};
1083 my $type = $scfg->{type
};
1085 next if !$scfg->{content
}->{$tt};
1087 next if !storage_check_enabled
($cfg, $sid, undef, 1);
1089 $res->{$sid} = volume_list
($cfg, $sid, undef, $tt);
1096 my ($cfg, $storeid, $vmid, $content) = @_;
1098 my @ctypes = qw(rootdir images vztmpl iso backup snippets);
1100 my $cts = $content ?
[ $content ] : [ @ctypes ];
1102 my $scfg = PVE
::Storage
::storage_config
($cfg, $storeid);
1104 $cts = [ grep { defined($scfg->{content
}->{$_}) } @$cts ];
1106 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1108 activate_storage
($cfg, $storeid);
1110 my $res = $plugin->list_volumes($storeid, $scfg, $vmid, $cts);
1112 @$res = sort {lc($a->{volid
}) cmp lc ($b->{volid
}) } @$res;
1119 my $filename = "/sys/kernel/uevent_seqnum";
1122 if (my $fh = IO
::File-
>new($filename, "r")) {
1124 if ($line =~ m/^(\d+)$/) {
1132 sub activate_storage
{
1133 my ($cfg, $storeid, $cache) = @_;
1135 $cache = {} if !$cache;
1137 my $scfg = storage_check_enabled
($cfg, $storeid);
1139 return if $cache->{activated
}->{$storeid};
1141 $cache->{uevent_seqnum
} = uevent_seqnum
() if !$cache->{uevent_seqnum
};
1143 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1145 if ($scfg->{base
}) {
1146 my ($baseid, undef) = parse_volume_id
($scfg->{base
});
1147 activate_storage
($cfg, $baseid, $cache);
1150 if (! eval { $plugin->check_connection($storeid, $scfg) }) {
1151 die "connection check for storage '$storeid' failed - $@\n" if $@;
1152 die "storage '$storeid' is not online\n";
1155 $plugin->activate_storage($storeid, $scfg, $cache);
1157 my $newseq = uevent_seqnum
();
1159 # only call udevsettle if there are events
1160 if ($newseq > $cache->{uevent_seqnum
}) {
1161 system ("udevadm settle --timeout=30"); # ignore errors
1162 $cache->{uevent_seqnum
} = $newseq;
1165 $cache->{activated
}->{$storeid} = 1;
1168 sub activate_storage_list
{
1169 my ($cfg, $storeid_list, $cache) = @_;
1171 $cache = {} if !$cache;
1173 foreach my $storeid (@$storeid_list) {
1174 activate_storage
($cfg, $storeid, $cache);
1178 sub deactivate_storage
{
1179 my ($cfg, $storeid) = @_;
1181 my $scfg = storage_config
($cfg, $storeid);
1182 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1185 $plugin->deactivate_storage($storeid, $scfg, $cache);
1188 sub activate_volumes
{
1189 my ($cfg, $vollist, $snapname) = @_;
1191 return if !($vollist && scalar(@$vollist));
1193 my $storagehash = {};
1194 foreach my $volid (@$vollist) {
1195 my ($storeid, undef) = parse_volume_id
($volid);
1196 $storagehash->{$storeid} = 1;
1201 activate_storage_list
($cfg, [keys %$storagehash], $cache);
1203 foreach my $volid (@$vollist) {
1204 my ($storeid, $volname) = parse_volume_id
($volid);
1205 my $scfg = storage_config
($cfg, $storeid);
1206 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1207 $plugin->activate_volume($storeid, $scfg, $volname, $snapname, $cache);
1211 sub deactivate_volumes
{
1212 my ($cfg, $vollist, $snapname) = @_;
1214 return if !($vollist && scalar(@$vollist));
1219 foreach my $volid (@$vollist) {
1220 my ($storeid, $volname) = parse_volume_id
($volid);
1222 my $scfg = storage_config
($cfg, $storeid);
1223 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1226 $plugin->deactivate_volume($storeid, $scfg, $volname, $snapname, $cache);
1230 push @errlist, $volid;
1234 die "volume deactivation failed: " . join(' ', @errlist)
1235 if scalar(@errlist);
1239 my ($cfg, $content, $includeformat) = @_;
1241 my $ids = $cfg->{ids
};
1245 my @ctypes = PVE
::Tools
::split_list
($content);
1248 foreach my $storeid (keys %$ids) {
1249 my $storage_enabled = defined(storage_check_enabled
($cfg, $storeid, undef, 1));
1251 if (defined($content)) {
1253 foreach my $ctype (@ctypes) {
1254 if ($ids->{$storeid}->{content
}->{$ctype}) {
1259 next if !$want_ctype || !$storage_enabled;
1262 my $type = $ids->{$storeid}->{type
};
1264 $info->{$storeid} = {
1269 shared
=> $ids->{$storeid}->{shared
} ?
1 : 0,
1270 content
=> PVE
::Storage
::Plugin
::content_hash_to_string
($ids->{$storeid}->{content
}),
1272 enabled
=> $storage_enabled ?
1 : 0,
1275 push @$slist, $storeid;
1280 foreach my $storeid (keys %$ids) {
1281 my $scfg = $ids->{$storeid};
1283 next if !$info->{$storeid};
1284 next if !$info->{$storeid}->{enabled
};
1286 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1287 if ($includeformat) {
1288 my $pd = $plugin->plugindata();
1289 $info->{$storeid}->{format
} = $pd->{format
}
1291 $info->{$storeid}->{select_existing
} = $pd->{select_existing
}
1292 if $pd->{select_existing
};
1295 eval { activate_storage
($cfg, $storeid, $cache); };
1301 my ($total, $avail, $used, $active) = eval { $plugin->status($storeid, $scfg, $cache); };
1304 $info->{$storeid}->{total
} = int($total);
1305 $info->{$storeid}->{avail
} = int($avail);
1306 $info->{$storeid}->{used
} = int($used);
1307 $info->{$storeid}->{active
} = $active;
1316 my ($packed_ip, $family);
1318 my @res = PVE
::Tools
::getaddrinfo_all
($server);
1319 $family = $res[0]->{family
};
1320 $packed_ip = (PVE
::Tools
::unpack_sockaddr_in46
($res[0]->{addr
}))[2];
1322 if (defined $packed_ip) {
1323 return Socket
::inet_ntop
($family, $packed_ip);
1329 my ($server_in) = @_;
1332 if (!($server = resolv_server
($server_in))) {
1333 die "unable to resolve address for server '${server_in}'\n";
1336 my $cmd = ['/sbin/showmount', '--no-headers', '--exports', $server];
1339 run_command
($cmd, outfunc
=> sub {
1342 # note: howto handle white spaces in export path??
1343 if ($line =~ m!^(/\S+)\s+(.+)$!) {
1352 my ($server_in, $user, $password, $domain) = @_;
1354 my $server = resolv_server
($server_in);
1355 die "unable to resolve address for server '${server_in}'\n" if !$server;
1357 # we only support Windows 2012 and newer, so just use smb3
1358 my $cmd = ['/usr/bin/smbclient', '-m', 'smb3', '-d', '0', '-L', $server];
1359 push @$cmd, '-W', $domain if defined($domain);
1361 push @$cmd, '-N' if !defined($password);
1362 local $ENV{USER
} = $user if defined($user);
1363 local $ENV{PASSWD
} = $password if defined($password);
1374 if ($line =~ m/(\S+)\s*Disk\s*(\S*)/) {
1376 } elsif ($line =~ m/(NT_STATUS_(\S+))/) {
1378 $err .= "unexpected status: $1\n" if uc($1) ne 'SUCCESS';
1382 # only die if we got no share, else it's just some followup check error
1383 # (like workgroup querying)
1384 raise
($err) if $err && !%$res;
1391 my $cmd = ['zfs', 'list', '-t', 'filesystem', '-Hp', '-o', 'name,avail,used'];
1394 run_command
($cmd, outfunc
=> sub {
1397 if ($line =~m/^(\S+)\s+(\S+)\s+(\S+)$/) {
1398 my ($pool, $size_str, $used_str) = ($1, $2, $3);
1399 my $size = $size_str + 0;
1400 my $used = $used_str + 0;
1401 # ignore subvolumes generated by our ZFSPoolPlugin
1402 return if $pool =~ m!/subvol-\d+-[^/]+$!;
1403 return if $pool =~ m!/basevol-\d+-[^/]+$!;
1404 push @$res, { pool
=> $pool, size
=> $size, free
=> $size-$used };
1412 my ($portal, $noerr) = @_;
1414 my ($server, $port) = PVE
::Tools
::parse_host_and_port
($portal);
1416 if (my $ip = resolv_server
($server)) {
1418 $server = "[$server]" if $server =~ /^$IPV6RE$/;
1419 return $port ?
"$server:$port" : $server;
1422 return undef if $noerr;
1424 raise_param_exc
({ portal
=> "unable to resolve portal address '$portal'" });
1429 my ($portal_in) = @_;
1432 if (!($portal = resolv_portal
($portal_in))) {
1433 die "unable to parse/resolve portal address '${portal_in}'\n";
1436 return PVE
::Storage
::ISCSIPlugin
::iscsi_discovery
($portal);
1439 sub storage_default_format
{
1440 my ($cfg, $storeid) = @_;
1442 my $scfg = storage_config
($cfg, $storeid);
1444 return PVE
::Storage
::Plugin
::default_format
($scfg);
1447 sub vgroup_is_used
{
1448 my ($cfg, $vgname) = @_;
1450 foreach my $storeid (keys %{$cfg->{ids
}}) {
1451 my $scfg = storage_config
($cfg, $storeid);
1452 if ($scfg->{type
} eq 'lvm' && $scfg->{vgname
} eq $vgname) {
1460 sub target_is_used
{
1461 my ($cfg, $target) = @_;
1463 foreach my $storeid (keys %{$cfg->{ids
}}) {
1464 my $scfg = storage_config
($cfg, $storeid);
1465 if ($scfg->{type
} eq 'iscsi' && $scfg->{target
} eq $target) {
1473 sub volume_is_used
{
1474 my ($cfg, $volid) = @_;
1476 foreach my $storeid (keys %{$cfg->{ids
}}) {
1477 my $scfg = storage_config
($cfg, $storeid);
1478 if ($scfg->{base
} && $scfg->{base
} eq $volid) {
1486 sub storage_is_used
{
1487 my ($cfg, $storeid) = @_;
1489 foreach my $sid (keys %{$cfg->{ids
}}) {
1490 my $scfg = storage_config
($cfg, $sid);
1491 next if !$scfg->{base
};
1492 my ($st) = parse_volume_id
($scfg->{base
});
1493 return 1 if $st && $st eq $storeid;
1500 my ($list, $func) = @_;
1504 foreach my $sid (keys %$list) {
1505 foreach my $info (@{$list->{$sid}}) {
1506 my $volid = $info->{volid
};
1507 my ($sid1, $volname) = parse_volume_id
($volid, 1);
1508 if ($sid1 && $sid1 eq $sid) {
1509 &$func ($volid, $sid, $info);
1511 warn "detected strange volid '$volid' in volume list for '$sid'\n";
1517 sub decompressor_info
{
1518 my ($format, $comp) = @_;
1520 if ($format eq 'tgz' && !defined($comp)) {
1521 ($format, $comp) = ('tar', 'gz');
1524 my $decompressor = {
1526 gz
=> ['tar', '-z'],
1527 lzo
=> ['tar', '--lzop'],
1528 zst
=> ['tar', '--zstd'],
1532 lzo
=> ['lzop', '-d', '-c'],
1533 zst
=> ['zstd', '-q', '-d', '-c'],
1537 die "ERROR: archive format not defined\n"
1538 if !defined($decompressor->{$format});
1541 $decomp = $decompressor->{$format}->{$comp} if $comp;
1545 compression
=> $comp,
1546 decompressor
=> $decomp,
1552 sub protection_file_path
{
1555 return "${path}.protected";
1559 my ($archive) = shift;
1562 my $volid = basename
($archive);
1563 if ($volid =~ /^(vzdump-(lxc|openvz|qemu)-.+$BACKUP_EXT_RE_2)$/) {
1564 my $filename = "$1"; # untaint
1565 my ($type, $extension, $comp) = ($2, $3, $4);
1566 (my $format = $extension) =~ s/\..*//;
1567 $info = decompressor_info
($format, $comp);
1568 $info->{filename
} = $filename;
1569 $info->{type
} = $type;
1571 if ($volid =~ /^(vzdump-${type}-([1-9][0-9]{2,8})-(\d{4})_(\d{2})_(\d{2})-(\d{2})_(\d{2})_(\d{2}))\.${extension}$/) {
1572 $info->{logfilename
} = "$1".PVE
::Storage
::Plugin
::LOG_EXT
;
1573 $info->{notesfilename
} = "$filename".PVE
::Storage
::Plugin
::NOTES_EXT
;
1574 $info->{vmid
} = int($2);
1575 $info->{ctime
} = timelocal
($8, $7, $6, $5, $4 - 1, $3);
1576 $info->{is_std_name
} = 1;
1578 $info->{is_std_name
} = 0;
1581 die "ERROR: couldn't determine archive info from '$archive'\n";
1587 sub archive_remove
{
1588 my ($archive_path) = @_;
1590 die "cannot remove protected archive '$archive_path'\n"
1591 if -e protection_file_path
($archive_path);
1593 unlink $archive_path or $! == ENOENT
or die "removing archive $archive_path failed: $!\n";
1595 archive_auxiliaries_remove
($archive_path);
1598 sub archive_auxiliaries_remove
{
1599 my ($archive_path) = @_;
1601 my $dirname = dirname
($archive_path);
1602 my $archive_info = eval { archive_info
($archive_path) } // {};
1604 for my $type (qw(log notes)) {
1605 my $filename = $archive_info->{"${type}filename"} or next;
1606 my $path = "$dirname/$filename";
1609 unlink $path or $! == ENOENT
or log_warn
("Removing $type file failed: $!");
1614 sub extract_vzdump_config_tar
{
1615 my ($archive, $conf_re) = @_;
1617 die "ERROR: file '$archive' does not exist\n" if ! -f
$archive;
1619 my $pid = open(my $fh, '-|', 'tar', 'tf', $archive) ||
1620 die "unable to open file '$archive'\n";
1623 while (defined($file = <$fh>)) {
1624 if ($file =~ $conf_re) {
1625 $file = $1; # untaint
1634 die "ERROR: archive contains no configuration file\n" if !$file;
1640 $raw .= "$output\n";
1643 run_command
(['tar', '-xpOf', $archive, $file, '--occurrence'], outfunc
=> $out);
1645 return wantarray ?
($raw, $file) : $raw;
1648 sub extract_vzdump_config_vma
{
1649 my ($archive, $comp) = @_;
1652 my $out = sub { $raw .= "$_[0]\n"; };
1654 my $info = archive_info
($archive);
1655 $comp //= $info->{compression
};
1656 my $decompressor = $info->{decompressor
};
1659 my $cmd = [ [@$decompressor, $archive], ["vma", "config", "-"] ];
1661 # lzop/zcat exits with 1 when the pipe is closed early by vma, detect this and ignore the exit code later
1666 if ($output =~ m/lzop: Broken pipe: <stdout>/ || $output =~ m/gzip: stdout: Broken pipe/ || $output =~ m/zstd: error 70 : Write error.*Broken pipe/) {
1668 } elsif (!defined ($errstring) && $output !~ m/^\s*$/) {
1669 $errstring = "Failed to extract config from VMA archive: $output\n";
1673 my $rc = eval { run_command
($cmd, outfunc
=> $out, errfunc
=> $err, noerr
=> 1) };
1676 $broken_pipe ||= $rc == 141; # broken pipe from vma POV
1678 if (!$errstring && !$broken_pipe && $rc != 0) {
1679 die "$rerr\n" if $rerr;
1680 die "config extraction failed with exit code $rc\n";
1682 die "$errstring\n" if $errstring;
1684 run_command
(["vma", "config", $archive], outfunc
=> $out);
1687 return wantarray ?
($raw, undef) : $raw;
1690 sub extract_vzdump_config
{
1691 my ($cfg, $volid) = @_;
1693 my ($storeid, $volname) = parse_volume_id
($volid);
1694 if (defined($storeid)) {
1695 my $scfg = storage_config
($cfg, $storeid);
1696 if ($scfg->{type
} eq 'pbs') {
1697 storage_check_enabled
($cfg, $storeid);
1698 return PVE
::Storage
::PBSPlugin-
>extract_vzdump_config($scfg, $volname, $storeid);
1702 my $archive = abs_filesystem_path
($cfg, $volid);
1703 my $info = archive_info
($archive);
1704 my $format = $info->{format
};
1705 my $comp = $info->{compression
};
1706 my $type = $info->{type
};
1708 if ($type eq 'lxc' || $type eq 'openvz') {
1709 return extract_vzdump_config_tar
($archive, qr!^(\./etc/vzdump/(pct|vps)\.conf)$!);
1710 } elsif ($type eq 'qemu') {
1711 if ($format eq 'tar') {
1712 return extract_vzdump_config_tar
($archive, qr!\(\./qemu-server\.conf\)!);
1714 return extract_vzdump_config_vma
($archive, $comp);
1717 die "cannot determine backup guest type for backup archive '$volid'\n";
1722 my ($cfg, $storeid, $keep, $vmid, $type, $dryrun, $logfunc) = @_;
1724 my $scfg = storage_config
($cfg, $storeid);
1725 die "storage '$storeid' does not support backups\n" if !$scfg->{content
}->{backup
};
1727 if (!defined($keep)) {
1728 die "no prune-backups options configured for storage '$storeid'\n"
1729 if !defined($scfg->{'prune-backups'});
1730 $keep = PVE
::JSONSchema
::parse_property_string
('prune-backups', $scfg->{'prune-backups'});
1733 activate_storage
($cfg, $storeid);
1735 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1736 return $plugin->prune_backups($scfg, $storeid, $keep, $vmid, $type, $dryrun, $logfunc);
1739 my $prune_mark = sub {
1740 my ($prune_entries, $keep_count, $id_func) = @_;
1742 return if !$keep_count;
1744 my $already_included = {};
1745 my $newly_included = {};
1747 foreach my $prune_entry (@{$prune_entries}) {
1748 my $mark = $prune_entry->{mark
};
1749 my $id = $id_func->($prune_entry->{ctime
});
1750 $already_included->{$id} = 1 if defined($mark) && $mark eq 'keep';
1753 foreach my $prune_entry (@{$prune_entries}) {
1754 my $mark = $prune_entry->{mark
};
1755 my $id = $id_func->($prune_entry->{ctime
});
1757 next if defined($mark) || $already_included->{$id};
1759 if (!$newly_included->{$id}) {
1760 last if scalar(keys %{$newly_included}) >= $keep_count;
1761 $newly_included->{$id} = 1;
1762 $prune_entry->{mark
} = 'keep';
1764 $prune_entry->{mark
} = 'remove';
1769 sub prune_mark_backup_group
{
1770 my ($backup_group, $keep) = @_;
1772 my @positive_opts = grep { $_ ne 'keep-all' && $keep->{$_} > 0 } keys $keep->%*;
1774 if ($keep->{'keep-all'} || scalar(@positive_opts) == 0) {
1775 foreach my $prune_entry (@{$backup_group}) {
1776 # preserve additional information like 'protected'
1777 next if $prune_entry->{mark
} && $prune_entry->{mark
} ne 'remove';
1778 $prune_entry->{mark
} = 'keep';
1783 my $prune_list = [ sort { $b->{ctime
} <=> $a->{ctime
} } @{$backup_group} ];
1785 $prune_mark->($prune_list, $keep->{'keep-last'}, sub {
1789 $prune_mark->($prune_list, $keep->{'keep-hourly'}, sub {
1791 my (undef, undef, $hour, $day, $month, $year) = localtime($ctime);
1792 return "$hour/$day/$month/$year";
1794 $prune_mark->($prune_list, $keep->{'keep-daily'}, sub {
1796 my (undef, undef, undef, $day, $month, $year) = localtime($ctime);
1797 return "$day/$month/$year";
1799 $prune_mark->($prune_list, $keep->{'keep-weekly'}, sub {
1801 my ($sec, $min, $hour, $day, $month, $year) = localtime($ctime);
1802 my $iso_week = int(strftime
("%V", $sec, $min, $hour, $day, $month, $year));
1803 my $iso_week_year = int(strftime
("%G", $sec, $min, $hour, $day, $month, $year));
1804 return "$iso_week/$iso_week_year";
1806 $prune_mark->($prune_list, $keep->{'keep-monthly'}, sub {
1808 my (undef, undef, undef, undef, $month, $year) = localtime($ctime);
1809 return "$month/$year";
1811 $prune_mark->($prune_list, $keep->{'keep-yearly'}, sub {
1813 my $year = (localtime($ctime))[5];
1817 foreach my $prune_entry (@{$prune_list}) {
1818 $prune_entry->{mark
} //= 'remove';
1822 sub volume_export
: prototype($$$$$$$) {
1823 my ($cfg, $fh, $volid, $format, $snapshot, $base_snapshot, $with_snapshots) = @_;
1825 my ($storeid, $volname) = parse_volume_id
($volid, 1);
1826 die "cannot export volume '$volid'\n" if !$storeid;
1827 my $scfg = storage_config
($cfg, $storeid);
1828 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1829 return $plugin->volume_export($scfg, $storeid, $fh, $volname, $format,
1830 $snapshot, $base_snapshot, $with_snapshots);
1833 sub volume_import
: prototype($$$$$$$$) {
1834 my ($cfg, $fh, $volid, $format, $snapshot, $base_snapshot, $with_snapshots, $allow_rename) = @_;
1836 my ($storeid, $volname) = parse_volume_id
($volid, 1);
1837 die "cannot import into volume '$volid'\n" if !$storeid;
1838 my $scfg = storage_config
($cfg, $storeid);
1839 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1840 return $plugin->volume_import(
1853 sub volume_export_formats
: prototype($$$$$) {
1854 my ($cfg, $volid, $snapshot, $base_snapshot, $with_snapshots) = @_;
1856 my ($storeid, $volname) = parse_volume_id
($volid, 1);
1857 return if !$storeid;
1858 my $scfg = storage_config
($cfg, $storeid);
1859 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1860 return $plugin->volume_export_formats($scfg, $storeid, $volname,
1861 $snapshot, $base_snapshot,
1865 sub volume_import_formats
: prototype($$$$$) {
1866 my ($cfg, $volid, $snapshot, $base_snapshot, $with_snapshots) = @_;
1868 my ($storeid, $volname) = parse_volume_id
($volid, 1);
1869 return if !$storeid;
1870 my $scfg = storage_config
($cfg, $storeid);
1871 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1872 return $plugin->volume_import_formats(
1882 sub volume_transfer_formats
{
1883 my ($cfg, $src_volid, $dst_volid, $snapshot, $base_snapshot, $with_snapshots) = @_;
1884 my @export_formats = volume_export_formats
($cfg, $src_volid, $snapshot, $base_snapshot, $with_snapshots);
1885 my @import_formats = volume_import_formats
($cfg, $dst_volid, $snapshot, $base_snapshot, $with_snapshots);
1886 my %import_hash = map { $_ => 1 } @import_formats;
1887 my @common = grep { $import_hash{$_} } @export_formats;
1891 sub volume_imported_message
{
1892 my ($volid, $want_pattern) = @_;
1894 if ($want_pattern) {
1895 return qr/successfully imported '([^']*)'$/;
1897 return "successfully imported '$volid'\n";
1901 # $format and $volname are requests and might be overruled depending on $opts
1903 # - with_snapshots: passed to `pvesm import` and used to select import format
1904 # - allow_rename: passed to `pvesm import`
1905 # - export_formats: used to select common transport format
1906 # - unix: unix socket path
1907 sub volume_import_start
{
1908 my ($cfg, $storeid, $volname, $format, $vmid, $opts) = @_;
1910 my $with_snapshots = $opts->{'with_snapshots'} ?
1 : 0;
1912 $volname = $volname_for_storage->($cfg, $storeid, $volname, $vmid, $format);
1914 my $volid = "$storeid:$volname";
1916 # find common import/export format, like volume_transfer_formats
1917 my @import_formats = PVE
::Storage
::volume_import_formats
($cfg, $volid, $opts->{snapshot
}, undef, $with_snapshots);
1918 my @export_formats = PVE
::Tools
::split_list
($opts->{export_formats
});
1919 my %import_hash = map { $_ => 1 } @import_formats;
1920 my @common = grep { $import_hash{$_} } @export_formats;
1921 die "no matching import/export format found for storage '$storeid'\n"
1923 $format = $common[0];
1925 my $input = IO
::File-
>new();
1926 my $info = IO
::File-
>new();
1928 my $unix = $opts->{unix
} // "/run/pve/storage-migrate-$vmid.$$.unix";
1929 my $import = $volume_import_prepare->($volid, $format, "unix://$unix", APIVER
, $opts);
1932 my $cpid = open3
($input, $info, $info, @$import)
1933 or die "failed to spawn disk-import child - $!\n";
1937 PVE
::Tools
::run_with_timeout
(5, sub { $ready = <$info>; });
1940 die "failed to read readyness from disk import child: $@\n" if $@;
1952 sub volume_export_start
{
1953 my ($cfg, $volid, $format, $log, $opts) = @_;
1955 my $known_format = [ grep { $_ eq $format } $KNOWN_EXPORT_FORMATS->@* ];
1956 if (!$known_format->@*) {
1957 die "Cannot export '$volid' using unknown export format '$format'\n";
1959 $format = $known_format->[0];
1961 my $run_command_params = delete $opts->{cmd
} // {};
1963 my $cmds = $volume_export_prepare->($cfg, $volid, $format, $log, $opts);
1965 PVE
::Tools
::run_command
($cmds, %$run_command_params);
1968 # bash completion helper
1970 sub complete_storage
{
1971 my ($cmdname, $pname, $cvalue) = @_;
1973 my $cfg = PVE
::Storage
::config
();
1975 return $cmdname eq 'add' ?
[] : [ PVE
::Storage
::storage_ids
($cfg) ];
1978 sub complete_storage_enabled
{
1979 my ($cmdname, $pname, $cvalue) = @_;
1983 my $cfg = PVE
::Storage
::config
();
1984 foreach my $sid (keys %{$cfg->{ids
}}) {
1985 next if !storage_check_enabled
($cfg, $sid, undef, 1);
1991 sub complete_content_type
{
1992 my ($cmdname, $pname, $cvalue) = @_;
1994 return [qw(rootdir images vztmpl iso backup snippets)];
1997 sub complete_volume
{
1998 my ($cmdname, $pname, $cvalue) = @_;
2002 my $storage_list = complete_storage_enabled
();
2004 if ($cvalue =~ m/^([^:]+):/) {
2005 $storage_list = [ $1 ];
2007 if (scalar(@$storage_list) > 1) {
2008 # only list storage IDs to avoid large listings
2010 foreach my $storeid (@$storage_list) {
2011 # Hack: simply return 2 artificial values, so that
2012 # completions does not finish
2013 push @$res, "$storeid:volname", "$storeid:...";
2020 foreach my $storeid (@$storage_list) {
2021 my $vollist = PVE
::Storage
::volume_list
($cfg, $storeid);
2023 foreach my $item (@$vollist) {
2024 push @$res, $item->{volid
};
2032 my ($cfg, $source_volid, $target_vmid, $target_volname) = @_;
2034 die "no source volid provided\n" if !$source_volid;
2035 die "no target VMID or target volname provided\n" if !$target_vmid && !$target_volname;
2037 my ($storeid, $source_volname) = parse_volume_id
($source_volid);
2039 activate_storage
($cfg, $storeid);
2041 my $scfg = storage_config
($cfg, $storeid);
2042 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
2044 $target_vmid = ($plugin->parse_volname($source_volname))[3] if !$target_vmid;
2046 return $plugin->cluster_lock_storage($storeid, $scfg->{shared
}, undef, sub {
2047 return $plugin->rename_volume($scfg, $storeid, $source_volname, $target_vmid, $target_volname);
2051 # Various io-heavy operations require io/bandwidth limits which can be
2052 # configured on multiple levels: The global defaults in datacenter.cfg, and
2053 # per-storage overrides. When we want to do a restore from storage A to storage
2054 # B, we should take the smaller limit defined for storages A and B, and if no
2055 # such limit was specified, use the one from datacenter.cfg.
2056 sub get_bandwidth_limit
{
2057 my ($operation, $storage_list, $override) = @_;
2059 # called for each limit (global, per-storage) with the 'default' and the
2060 # $operation limit and should update $override for every limit affecting
2062 my $use_global_limits = 0;
2063 my $apply_limit = sub {
2065 if (defined($bwlimit)) {
2066 my $limits = PVE
::JSONSchema
::parse_property_string
('bwlimit', $bwlimit);
2067 my $limit = $limits->{$operation} // $limits->{default};
2068 if (defined($limit)) {
2069 if (!$override || $limit < $override) {
2075 # If there was no applicable limit, try to apply the global ones.
2076 $use_global_limits = 1;
2079 my ($rpcenv, $authuser);
2080 if (defined($override)) {
2081 $rpcenv = PVE
::RPCEnvironment-
>get();
2082 $authuser = $rpcenv->get_user();
2085 # Apply per-storage limits - if there are storages involved.
2086 if (defined($storage_list) && grep { defined($_) } $storage_list->@*) {
2087 my $config = config
();
2089 # The Datastore.Allocate permission allows us to modify the per-storage
2090 # limits, therefore it also allows us to override them.
2091 # Since we have most likely multiple storages to check, do a quick check on
2092 # the general '/storage' path to see if we can skip the checks entirely:
2093 return $override if $rpcenv && $rpcenv->check($authuser, '/storage', ['Datastore.Allocate'], 1);
2096 foreach my $storage (@$storage_list) {
2097 next if !defined($storage);
2098 # Avoid duplicate checks:
2099 next if $done{$storage};
2100 $done{$storage} = 1;
2102 # Otherwise we may still have individual /storage/$ID permissions:
2103 if (!$rpcenv || !$rpcenv->check($authuser, "/storage/$storage", ['Datastore.Allocate'], 1)) {
2104 # And if not: apply the limits.
2105 my $storecfg = storage_config
($config, $storage);
2106 $apply_limit->($storecfg->{bwlimit
});
2110 # Storage limits take precedence over the datacenter defaults, so if
2111 # a limit was applied:
2112 return $override if !$use_global_limits;
2115 # Sys.Modify on '/' means we can change datacenter.cfg which contains the
2116 # global default limits.
2117 if (!$rpcenv || !$rpcenv->check($authuser, '/', ['Sys.Modify'], 1)) {
2118 # So if we cannot modify global limits, apply them to our currently
2119 # requested override.
2120 my $dc = cfs_read_file
('datacenter.cfg');
2121 $apply_limit->($dc->{bwlimit
});
2127 # checks if the storage id is available and dies if not
2128 sub assert_sid_unused
{
2132 if (my $scfg = storage_config
($cfg, $sid, 1)) {
2133 die "storage ID '$sid' already defined\n";
2139 # removes leading/trailing spaces and (back)slashes completely
2140 # substitutes every non-ASCII-alphanumerical char with '_', except '_.-'
2141 sub normalize_content_filename
{
2142 my ($filename) = @_;
2145 $filename =~ s/^.*[\/\\]//;
2146 $filename =~ s/[^a-zA-Z0-9_.-]/_/g;