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
::DRBDPlugin
;
41 use PVE
::Storage
::PBSPlugin
;
43 # Storage API version. Increment it on changes in storage API interface.
44 use constant APIVER
=> 8;
45 # Age is the number of versions we're backward compatible with.
46 # This is like having 'current=APIVER' and age='APIAGE' in libtool,
47 # see https://www.gnu.org/software/libtool/manual/html_node/Libtool-versioning.html
48 use constant APIAGE
=> 7;
50 # load standard plugins
51 PVE
::Storage
::DirPlugin-
>register();
52 PVE
::Storage
::LVMPlugin-
>register();
53 PVE
::Storage
::LvmThinPlugin-
>register();
54 PVE
::Storage
::NFSPlugin-
>register();
55 PVE
::Storage
::CIFSPlugin-
>register();
56 PVE
::Storage
::ISCSIPlugin-
>register();
57 PVE
::Storage
::RBDPlugin-
>register();
58 PVE
::Storage
::CephFSPlugin-
>register();
59 PVE
::Storage
::ISCSIDirectPlugin-
>register();
60 PVE
::Storage
::GlusterfsPlugin-
>register();
61 PVE
::Storage
::ZFSPoolPlugin-
>register();
62 PVE
::Storage
::ZFSPlugin-
>register();
63 PVE
::Storage
::DRBDPlugin-
>register();
64 PVE
::Storage
::PBSPlugin-
>register();
66 # load third-party plugins
67 if ( -d
'/usr/share/perl5/PVE/Storage/Custom' ) {
68 dir_glob_foreach
('/usr/share/perl5/PVE/Storage/Custom', '.*\.pm$', sub {
70 my $modname = 'PVE::Storage::Custom::' . $file;
71 $modname =~ s!\.pm$!!;
72 $file = 'PVE/Storage/Custom/' . $file;
77 # Check perl interface:
78 die "not derived from PVE::Storage::Plugin\n"
79 if !$modname->isa('PVE::Storage::Plugin');
80 die "does not provide an api() method\n"
81 if !$modname->can('api');
82 # Check storage API version and that file is really storage plugin.
83 my $version = $modname->api();
84 die "implements an API version newer than current ($version > " . APIVER
. ")\n"
86 my $min_version = (APIVER
- APIAGE
);
87 die "API version too old, please update the plugin ($version < $min_version)\n"
88 if $version < $min_version;
92 # If we got this far and the API version is not the same, make some
94 warn "Plugin \"$modname\" is implementing an older storage API
, an upgrade
is recommended
\n"
95 if $version != APIVER;
98 warn "Error loading storage plugin
\"$modname\": $@";
103 # initialize all plugins
104 PVE
::Storage
::Plugin-
>init();
106 our $iso_extension_re = qr/\.(?:iso|img)/i;
108 # PVE::Storage utility functions
111 return cfs_read_file
("storage.cfg");
117 cfs_write_file
('storage.cfg', $cfg);
120 sub lock_storage_config
{
121 my ($code, $errmsg) = @_;
123 cfs_lock_file
("storage.cfg", undef, $code);
126 $errmsg ?
die "$errmsg: $err" : die $err;
130 # FIXME remove maxfiles for PVE 7.0
131 my $convert_maxfiles_to_prune_backups = sub {
136 my $maxfiles = delete $scfg->{maxfiles
};
138 if (!defined($scfg->{'prune-backups'}) && defined($maxfiles)) {
141 $prune_backups = { 'keep-last' => $maxfiles };
142 } else { # maxfiles 0 means no limit
143 $prune_backups = { 'keep-all' => 1 };
145 $scfg->{'prune-backups'} = PVE
::JSONSchema
::print_property_string
(
153 my ($cfg, $storeid, $noerr) = @_;
155 die "no storage ID specified\n" if !$storeid;
157 my $scfg = $cfg->{ids
}->{$storeid};
159 die "storage '$storeid' does not exist\n" if (!$noerr && !$scfg);
161 $convert_maxfiles_to_prune_backups->($scfg);
166 sub storage_check_node
{
167 my ($cfg, $storeid, $node, $noerr) = @_;
169 my $scfg = storage_config
($cfg, $storeid);
171 if ($scfg->{nodes
}) {
172 $node = PVE
::INotify
::nodename
() if !$node || ($node eq 'localhost');
173 if (!$scfg->{nodes
}->{$node}) {
174 die "storage '$storeid' is not available on node '$node'\n" if !$noerr;
182 sub storage_check_enabled
{
183 my ($cfg, $storeid, $node, $noerr) = @_;
185 my $scfg = storage_config
($cfg, $storeid);
187 if ($scfg->{disable
}) {
188 die "storage '$storeid' is disabled\n" if !$noerr;
192 return storage_check_node
($cfg, $storeid, $node, $noerr);
195 # storage_can_replicate:
196 # return true if storage supports replication
197 # (volumes alocated with vdisk_alloc() has replication feature)
198 sub storage_can_replicate
{
199 my ($cfg, $storeid, $format) = @_;
201 my $scfg = storage_config
($cfg, $storeid);
202 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
203 return $plugin->storage_can_replicate($scfg, $storeid, $format);
209 return keys %{$cfg->{ids
}};
213 my ($filename, $timeout) = @_;
215 return PVE
::Storage
::Plugin
::file_size_info
($filename, $timeout);
218 sub get_volume_notes
{
219 my ($cfg, $volid, $timeout) = @_;
221 my ($storeid, $volname) = parse_volume_id
($volid);
222 my $scfg = storage_config
($cfg, $storeid);
223 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
225 return $plugin->get_volume_notes($scfg, $storeid, $volname, $timeout);
228 sub update_volume_notes
{
229 my ($cfg, $volid, $notes, $timeout) = @_;
231 my ($storeid, $volname) = parse_volume_id
($volid);
232 my $scfg = storage_config
($cfg, $storeid);
233 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
235 $plugin->update_volume_notes($scfg, $storeid, $volname, $notes, $timeout);
238 sub volume_size_info
{
239 my ($cfg, $volid, $timeout) = @_;
241 my ($storeid, $volname) = parse_volume_id
($volid, 1);
243 my $scfg = storage_config
($cfg, $storeid);
244 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
245 return $plugin->volume_size_info($scfg, $storeid, $volname, $timeout);
246 } elsif ($volid =~ m
|^(/.+)$| && -e
$volid) {
247 return file_size_info
($volid, $timeout);
254 my ($cfg, $volid, $size, $running) = @_;
256 my $padding = (1024 - $size % 1024) % 1024;
257 $size = $size + $padding;
259 my ($storeid, $volname) = parse_volume_id
($volid, 1);
261 my $scfg = storage_config
($cfg, $storeid);
262 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
263 return $plugin->volume_resize($scfg, $storeid, $volname, $size, $running);
264 } elsif ($volid =~ m
|^(/.+)$| && -e
$volid) {
265 die "resize file/device '$volid' is not possible\n";
267 die "unable to parse volume ID '$volid'\n";
271 sub volume_rollback_is_possible
{
272 my ($cfg, $volid, $snap) = @_;
274 my ($storeid, $volname) = parse_volume_id
($volid, 1);
276 my $scfg = storage_config
($cfg, $storeid);
277 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
278 return $plugin->volume_rollback_is_possible($scfg, $storeid, $volname, $snap);
279 } elsif ($volid =~ m
|^(/.+)$| && -e
$volid) {
280 die "snapshot rollback file/device '$volid' is not possible\n";
282 die "unable to parse volume ID '$volid'\n";
286 sub volume_snapshot
{
287 my ($cfg, $volid, $snap) = @_;
289 my ($storeid, $volname) = parse_volume_id
($volid, 1);
291 my $scfg = storage_config
($cfg, $storeid);
292 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
293 return $plugin->volume_snapshot($scfg, $storeid, $volname, $snap);
294 } elsif ($volid =~ m
|^(/.+)$| && -e
$volid) {
295 die "snapshot file/device '$volid' is not possible\n";
297 die "unable to parse volume ID '$volid'\n";
301 sub volume_snapshot_rollback
{
302 my ($cfg, $volid, $snap) = @_;
304 my ($storeid, $volname) = parse_volume_id
($volid, 1);
306 my $scfg = storage_config
($cfg, $storeid);
307 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
308 $plugin->volume_rollback_is_possible($scfg, $storeid, $volname, $snap);
309 return $plugin->volume_snapshot_rollback($scfg, $storeid, $volname, $snap);
310 } elsif ($volid =~ m
|^(/.+)$| && -e
$volid) {
311 die "snapshot rollback file/device '$volid' is not possible\n";
313 die "unable to parse volume ID '$volid'\n";
317 sub volume_snapshot_delete
{
318 my ($cfg, $volid, $snap, $running) = @_;
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_snapshot_delete($scfg, $storeid, $volname, $snap, $running);
325 } elsif ($volid =~ m
|^(/.+)$| && -e
$volid) {
326 die "snapshot delete file/device '$volid' is not possible\n";
328 die "unable to parse volume ID '$volid'\n";
332 # check if a filesystem on top of a volume needs to flush its journal for
333 # consistency (see fsfreeze(8)) before a snapshot is taken - needed for
334 # container mountpoints
335 sub volume_snapshot_needs_fsfreeze
{
336 my ($cfg, $volid) = @_;
338 my ($storeid, $volname) = parse_volume_id
($volid);
339 my $scfg = storage_config
($cfg, $storeid);
340 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
341 return $plugin->volume_snapshot_needs_fsfreeze();
344 # check if a volume or snapshot supports a given feature
346 # clone - linked clone is possible
347 # copy - full clone is possible
348 # replicate - replication is possible
349 # snapshot - taking a snapshot is possible
350 # sparseinit - volume is sparsely initialized
351 # template - conversion to base image is possible
352 # $snap - check if the feature is supported for a given snapshot
353 # $running - if the guest owning the volume is running
354 # $opts - hash with further options:
355 # valid_target_formats - list of formats for the target of a copy/clone
356 # operation that the caller could work with. The
357 # format of $volid is always considered valid and if
358 # no list is specified, all formats are considered valid.
359 sub volume_has_feature
{
360 my ($cfg, $feature, $volid, $snap, $running, $opts) = @_;
362 my ($storeid, $volname) = parse_volume_id
($volid, 1);
364 my $scfg = storage_config
($cfg, $storeid);
365 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
366 return $plugin->volume_has_feature($scfg, $feature, $storeid, $volname, $snap, $running, $opts);
367 } elsif ($volid =~ m
|^(/.+)$| && -e
$volid) {
374 sub volume_snapshot_list
{
375 my ($cfg, $volid) = @_;
377 my ($storeid, $volname) = parse_volume_id
($volid, 1);
379 my $scfg = storage_config
($cfg, $storeid);
380 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
381 return $plugin->volume_snapshot_list($scfg, $storeid, $volname);
382 } elsif ($volid =~ m
|^(/.+)$| && -e
$volid) {
383 die "send file/device '$volid' is not possible\n";
385 die "unable to parse volume ID '$volid'\n";
387 # return an empty array if dataset does not exist.
391 my ($cfg, $storeid, $vmid) = @_;
393 my $scfg = storage_config
($cfg, $storeid);
394 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
396 my $path = $plugin->get_subdir($scfg, 'images');
398 return $vmid ?
"$path/$vmid" : $path;
401 sub get_private_dir
{
402 my ($cfg, $storeid, $vmid) = @_;
404 my $scfg = storage_config
($cfg, $storeid);
405 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
407 my $path = $plugin->get_subdir($scfg, 'rootdir');
409 return $vmid ?
"$path/$vmid" : $path;
413 my ($cfg, $storeid) = @_;
415 my $scfg = storage_config
($cfg, $storeid);
416 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
418 return $plugin->get_subdir($scfg, 'iso');
422 my ($cfg, $storeid) = @_;
424 my $scfg = storage_config
($cfg, $storeid);
425 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
427 return $plugin->get_subdir($scfg, 'vztmpl');
431 my ($cfg, $storeid) = @_;
433 my $scfg = storage_config
($cfg, $storeid);
434 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
436 return $plugin->get_subdir($scfg, 'backup');
439 # library implementation
444 die "VMID '$vmid' contains illegal characters\n" if $vmid !~ m/^\d+$/;
449 # NOTE: basename and basevmid are always undef for LVM-thin, where the
450 # clone -> base reference is not encoded in the volume ID.
451 # see note in PVE::Storage::LvmThinPlugin for details.
453 my ($cfg, $volid) = @_;
455 my ($storeid, $volname) = parse_volume_id
($volid);
457 my $scfg = storage_config
($cfg, $storeid);
459 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
461 # returns ($vtype, $name, $vmid, $basename, $basevmid, $isBase, $format)
463 return $plugin->parse_volname($volname);
466 sub parse_volume_id
{
467 my ($volid, $noerr) = @_;
469 return PVE
::Storage
::Plugin
::parse_volume_id
($volid, $noerr);
472 # test if we have read access to volid
473 sub check_volume_access
{
474 my ($rpcenv, $user, $cfg, $vmid, $volid) = @_;
476 my ($sid, $volname) = parse_volume_id
($volid, 1);
478 my ($vtype, undef, $ownervm) = parse_volname
($cfg, $volid);
479 if ($vtype eq 'iso' || $vtype eq 'vztmpl') {
480 # require at least read access to storage, (custom) templates/ISOs could be sensitive
481 $rpcenv->check_any($user, "/storage/$sid", ['Datastore.AllocateSpace', 'Datastore.Audit']);
482 } elsif (defined($ownervm) && defined($vmid) && ($ownervm == $vmid)) {
483 # we are owner - allow access
484 } elsif ($vtype eq 'backup' && $ownervm) {
485 $rpcenv->check($user, "/storage/$sid", ['Datastore.AllocateSpace']);
486 $rpcenv->check($user, "/vms/$ownervm", ['VM.Backup']);
488 # allow if we are Datastore administrator
489 $rpcenv->check($user, "/storage/$sid", ['Datastore.Allocate']);
492 die "Only root can pass arbitrary filesystem paths."
493 if $user ne 'root@pam';
499 # NOTE: this check does not work for LVM-thin, where the clone -> base
500 # reference is not encoded in the volume ID.
501 # see note in PVE::Storage::LvmThinPlugin for details.
502 sub volume_is_base_and_used
{
503 my ($cfg, $volid) = @_;
505 my ($storeid, $volname) = parse_volume_id
($volid);
506 my $scfg = storage_config
($cfg, $storeid);
507 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
509 my ($vtype, $name, $vmid, undef, undef, $isBase, undef) =
510 $plugin->parse_volname($volname);
513 my $vollist = $plugin->list_images($storeid, $scfg);
514 foreach my $info (@$vollist) {
515 my (undef, $tmpvolname) = parse_volume_id
($info->{volid
});
516 my $basename = undef;
517 my $basevmid = undef;
520 (undef, undef, undef, $basename, $basevmid) =
521 $plugin->parse_volname($tmpvolname);
524 if ($basename && defined($basevmid) && $basevmid == $vmid && $basename eq $name) {
532 # try to map a filesystem path to a volume identifier
533 sub path_to_volume_id
{
534 my ($cfg, $path) = @_;
536 my $ids = $cfg->{ids
};
538 my ($sid, $volname) = parse_volume_id
($path, 1);
540 if (my $scfg = $ids->{$sid}) {
542 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
543 my ($vtype, $name, $vmid) = $plugin->parse_volname($volname);
544 return ($vtype, $path);
550 # Note: abs_path() return undef if $path doesn not exist
551 # for example when nfs storage is not mounted
552 $path = abs_path
($path) || $path;
554 foreach my $sid (keys %$ids) {
555 my $scfg = $ids->{$sid};
556 next if !$scfg->{path
};
557 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
558 my $imagedir = $plugin->get_subdir($scfg, 'images');
559 my $isodir = $plugin->get_subdir($scfg, 'iso');
560 my $tmpldir = $plugin->get_subdir($scfg, 'vztmpl');
561 my $backupdir = $plugin->get_subdir($scfg, 'backup');
562 my $privatedir = $plugin->get_subdir($scfg, 'rootdir');
563 my $snippetsdir = $plugin->get_subdir($scfg, 'snippets');
565 if ($path =~ m!^$imagedir/(\d+)/([^/\s]+)$!) {
569 my $vollist = $plugin->list_images($sid, $scfg, $vmid);
570 foreach my $info (@$vollist) {
571 my ($storeid, $volname) = parse_volume_id
($info->{volid
});
572 my $volpath = $plugin->path($scfg, $volname, $storeid);
573 if ($volpath eq $path) {
574 return ('images', $info->{volid
});
577 } elsif ($path =~ m!^$isodir/([^/]+$iso_extension_re)$!) {
579 return ('iso', "$sid:iso/$name");
580 } elsif ($path =~ m!^$tmpldir/([^/]+\.tar\.gz)$!) {
582 return ('vztmpl', "$sid:vztmpl/$name");
583 } elsif ($path =~ m!^$privatedir/(\d+)$!) {
585 return ('rootdir', "$sid:rootdir/$vmid");
586 } elsif ($path =~ m!^$backupdir/([^/]+\.(?:tgz|(?:(?:tar|vma)(?:\.(?:${\PVE::Storage::Plugin::COMPRESSOR_RE}))?)))$!) {
588 return ('backup', "$sid:backup/$name");
589 } elsif ($path =~ m!^$snippetsdir/([^/]+)$!) {
591 return ('snippets', "$sid:snippets/$name");
595 # can't map path to volume id
600 my ($cfg, $volid, $snapname) = @_;
602 my ($storeid, $volname) = parse_volume_id
($volid);
604 my $scfg = storage_config
($cfg, $storeid);
606 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
607 my ($path, $owner, $vtype) = $plugin->path($scfg, $volname, $storeid, $snapname);
608 return wantarray ?
($path, $owner, $vtype) : $path;
611 sub abs_filesystem_path
{
612 my ($cfg, $volid) = @_;
615 if (parse_volume_id
($volid, 1)) {
616 activate_volumes
($cfg, [ $volid ]);
617 $path = PVE
::Storage
::path
($cfg, $volid);
620 my $abspath = abs_path
($volid);
621 if ($abspath && $abspath =~ m
|^(/.+)$|) {
622 $path = $1; # untaint any path
627 die "can't find file '$volid'\n" if !($path && -f
$path);
632 my $volname_for_storage = sub {
633 my ($cfg, $volid, $target_storeid) = @_;
635 my (undef, $name, $vmid, undef, undef, undef, $format) = parse_volname
($cfg, $volid);
636 my $target_scfg = storage_config
($cfg, $target_storeid);
638 my (undef, $valid_formats) = PVE
::Storage
::Plugin
::default_format
($target_scfg);
639 my $format_is_valid = grep { $_ eq $format } @$valid_formats;
640 die "unsupported format '$format' for storage type $target_scfg->{type}\n" if !$format_is_valid;
642 (my $name_without_extension = $name) =~ s/\.$format$//;
644 if ($target_scfg->{path
}) {
645 return "$vmid/$name_without_extension.$format";
647 return "$name_without_extension";
651 sub storage_migrate
{
652 my ($cfg, $volid, $target_sshinfo, $target_storeid, $opts, $logfunc) = @_;
654 my $base_snapshot = $opts->{base_snapshot
};
655 my $snapshot = $opts->{snapshot
};
656 my $ratelimit_bps = $opts->{ratelimit_bps
};
657 my $insecure = $opts->{insecure
};
658 my $with_snapshots = $opts->{with_snapshots
} ?
1 : 0;
659 my $allow_rename = $opts->{allow_rename
} ?
1 : 0;
661 my ($storeid, $volname) = parse_volume_id
($volid);
663 my $scfg = storage_config
($cfg, $storeid);
665 # no need to migrate shared content
666 return $volid if $storeid eq $target_storeid && $scfg->{shared
};
668 my $tcfg = storage_config
($cfg, $target_storeid);
671 if ($opts->{target_volname
}) {
672 $target_volname = $opts->{target_volname
};
673 } elsif ($scfg->{type
} eq $tcfg->{type
}) {
674 $target_volname = $volname;
676 $target_volname = $volname_for_storage->($cfg, $volid, $target_storeid);
679 my $target_volid = "${target_storeid}:${target_volname}";
681 my $target_ip = $target_sshinfo->{ip
};
683 my $ssh = PVE
::SSHInfo
::ssh_info_to_command
($target_sshinfo);
684 my $ssh_base = PVE
::SSHInfo
::ssh_info_to_command_base
($target_sshinfo);
685 local $ENV{RSYNC_RSH
} = PVE
::Tools
::cmd2string
($ssh_base);
688 if (defined($ratelimit_bps)) {
689 @cstream = ([ '/usr/bin/cstream', '-t', $ratelimit_bps ]);
690 $logfunc->("using a bandwidth limit of $ratelimit_bps bps for transferring '$volid'") if $logfunc;
693 my $migration_snapshot;
694 if (!defined($snapshot)) {
695 if ($scfg->{type
} eq 'zfspool') {
696 $migration_snapshot = 1;
697 $snapshot = '__migration__';
701 my @formats = volume_transfer_formats
($cfg, $volid, $target_volid, $snapshot, $base_snapshot, $with_snapshots);
702 die "cannot migrate from storage type '$scfg->{type}' to '$tcfg->{type}'\n" if !@formats;
703 my $format = $formats[0];
705 my $import_fn = '-'; # let pvesm import read from stdin per default
707 my $net = $target_sshinfo->{network
} // $target_sshinfo->{ip
};
708 $import_fn = "tcp://$net";
711 my $target_apiver = 1; # if there is no apiinfo call, assume 1
712 my $get_api_version = [@$ssh, 'pvesm', 'apiinfo'];
713 my $match_api_version = sub { $target_apiver = $1 if $_[0] =~ m!^APIVER (\d+)$!; };
714 eval { run_command
($get_api_version, logfunc
=> $match_api_version); };
716 my $send = ['pvesm', 'export', $volid, $format, '-', '-with-snapshots', $with_snapshots];
717 my $recv = [@$ssh, '--', 'pvesm', 'import', $target_volid, $format, $import_fn, '-with-snapshots', $with_snapshots];
718 if (defined($snapshot)) {
719 push @$send, '-snapshot', $snapshot
721 if ($migration_snapshot) {
722 push @$recv, '-delete-snapshot', $snapshot;
724 push @$recv, '-allow-rename', $allow_rename if $target_apiver >= 5;
726 if (defined($base_snapshot)) {
727 # Check if the snapshot exists on the remote side:
728 push @$send, '-base', $base_snapshot;
729 push @$recv, '-base', $base_snapshot;
733 my $pattern = volume_imported_message
(undef, 1);
734 my $match_volid_and_log = sub {
737 $new_volid = $1 if ($line =~ $pattern);
745 volume_snapshot
($cfg, $volid, $snapshot) if $migration_snapshot;
747 if (defined($snapshot)) {
748 activate_volumes
($cfg, [$volid], $snapshot);
750 activate_volumes
($cfg, [$volid]);
755 my $input = IO
::File-
>new();
756 my $info = IO
::File-
>new();
757 open3
($input, $info, $info, @{$recv})
758 or die "receive command failed: $!\n";
761 my $try_ip = <$info> // '';
762 my ($ip) = $try_ip =~ /^($PVE::Tools::IPRE)$/ # untaint
763 or die "no tunnel IP received, got '$try_ip'\n";
765 my $try_port = <$info> // '';
766 my ($port) = $try_port =~ /^(\d+)$/ # untaint
767 or die "no tunnel port received, got '$try_port'\n";
769 my $socket = IO
::Socket
::IP-
>new(PeerHost
=> $ip, PeerPort
=> $port, Type
=> SOCK_STREAM
)
770 or die "failed to connect to tunnel at $ip:$port\n";
771 # we won't be reading from the socket
772 shutdown($socket, 0);
774 eval { run_command
([$send, @cstream], output
=> '>&'.fileno($socket), errfunc
=> $logfunc); };
777 # don't close the connection entirely otherwise the receiving end
778 # might not get all buffered data (and fails with 'connection reset by peer')
779 shutdown($socket, 1);
781 # wait for the remote process to finish
782 while (my $line = <$info>) {
783 $match_volid_and_log->("[$target_sshinfo->{name}] $line");
786 # now close the socket
788 if (!close($info)) { # does waitpid()
789 die "import failed: $!\n" if $!;
790 die "import failed: exit code ".($?>>8)."\n";
793 die $send_error if $send_error;
795 run_command
([$send, @cstream, $recv], logfunc
=> $match_volid_and_log);
798 die "unable to get ID of the migrated volume\n"
799 if !defined($new_volid) && $target_apiver >= 5;
802 warn "send/receive failed, cleaning up snapshot(s)..\n" if $err;
803 if ($migration_snapshot) {
804 eval { volume_snapshot_delete
($cfg, $volid, $snapshot, 0) };
805 warn "could not remove source snapshot: $@\n" if $@;
809 return $new_volid // $target_volid;
813 my ($cfg, $volid, $vmid, $snap) = @_;
815 my ($storeid, $volname) = parse_volume_id
($volid);
817 my $scfg = storage_config
($cfg, $storeid);
819 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
821 activate_storage
($cfg, $storeid);
823 # lock shared storage
824 return $plugin->cluster_lock_storage($storeid, $scfg->{shared
}, undef, sub {
825 my $volname = $plugin->clone_image($scfg, $storeid, $volname, $vmid, $snap);
826 return "$storeid:$volname";
830 sub vdisk_create_base
{
831 my ($cfg, $volid) = @_;
833 my ($storeid, $volname) = parse_volume_id
($volid);
835 my $scfg = storage_config
($cfg, $storeid);
837 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
839 activate_storage
($cfg, $storeid);
841 # lock shared storage
842 return $plugin->cluster_lock_storage($storeid, $scfg->{shared
}, undef, sub {
843 my $volname = $plugin->create_base($storeid, $scfg, $volname);
844 return "$storeid:$volname";
849 my ($cfg, $volid, $snapname) = @_;
851 my ($storeid, $volname) = parse_volume_id
($volid);
853 my $scfg = storage_config
($cfg, $storeid);
855 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
857 return $plugin->map_volume($storeid, $scfg, $volname, $snapname);
861 my ($cfg, $volid, $snapname) = @_;
863 my ($storeid, $volname) = parse_volume_id
($volid);
865 my $scfg = storage_config
($cfg, $storeid);
867 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
869 return $plugin->unmap_volume($storeid, $scfg, $volname, $snapname);
873 my ($cfg, $storeid, $vmid, $fmt, $name, $size) = @_;
875 die "no storage ID specified\n" if !$storeid;
877 PVE
::JSONSchema
::parse_storage_id
($storeid);
879 my $scfg = storage_config
($cfg, $storeid);
881 die "no VMID specified\n" if !$vmid;
883 $vmid = parse_vmid
($vmid);
885 my $defformat = PVE
::Storage
::Plugin
::default_format
($scfg);
887 $fmt = $defformat if !$fmt;
889 activate_storage
($cfg, $storeid);
891 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
893 # lock shared storage
894 return $plugin->cluster_lock_storage($storeid, $scfg->{shared
}, undef, sub {
895 my $old_umask = umask(umask|0037);
896 my $volname = eval { $plugin->alloc_image($storeid, $scfg, $vmid, $fmt, $name, $size) };
900 return "$storeid:$volname";
905 my ($cfg, $volid) = @_;
907 my ($storeid, $volname) = parse_volume_id
($volid);
908 my $scfg = storage_config
($cfg, $storeid);
909 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
911 activate_storage
($cfg, $storeid);
915 # lock shared storage
916 $plugin->cluster_lock_storage($storeid, $scfg->{shared
}, undef, sub {
917 # LVM-thin allows deletion of still referenced base volumes!
918 die "base volume '$volname' is still in use by linked clones\n"
919 if volume_is_base_and_used
($cfg, $volid);
921 my (undef, undef, undef, undef, undef, $isBase, $format) =
922 $plugin->parse_volname($volname);
923 $cleanup_worker = $plugin->free_image($storeid, $scfg, $volname, $isBase, $format);
926 return if !$cleanup_worker;
928 my $rpcenv = PVE
::RPCEnvironment
::get
();
929 my $authuser = $rpcenv->get_user();
931 $rpcenv->fork_worker('imgdel', undef, $authuser, $cleanup_worker);
935 my ($cfg, $storeid, $vmid, $vollist) = @_;
937 my $ids = $cfg->{ids
};
939 storage_check_enabled
($cfg, $storeid) if ($storeid);
941 my $res = { map { $_ => [] } keys %{$ids} };
943 # prepare/activate/refresh all storages
945 my $storage_list = [];
947 foreach my $volid (@$vollist) {
948 my ($sid, undef) = parse_volume_id
($volid);
949 next if !defined($ids->{$sid});
950 next if !storage_check_enabled
($cfg, $sid, undef, 1);
951 push @$storage_list, $sid;
954 foreach my $sid (keys %$ids) {
955 next if $storeid && $storeid ne $sid;
956 next if !storage_check_enabled
($cfg, $sid, undef, 1);
957 my $content = $ids->{$sid}->{content
};
958 next if !($content->{rootdir
} || $content->{images
});
959 push @$storage_list, $sid;
965 activate_storage_list
($cfg, $storage_list, $cache);
967 foreach my $sid (@{$storage_list}) {
968 next if $storeid && $storeid ne $sid;
970 my $scfg = $ids->{$sid};
971 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
972 $res->{$sid} = $plugin->list_images($sid, $scfg, $vmid, $vollist, $cache);
973 @{$res->{$sid}} = sort {lc($a->{volid
}) cmp lc ($b->{volid
}) } @{$res->{$sid}} if $res->{$sid};
980 my ($cfg, $storeid, $tt) = @_;
982 die "unknown template type '$tt'\n"
983 if !($tt eq 'iso' || $tt eq 'vztmpl' || $tt eq 'backup' || $tt eq 'snippets');
985 my $ids = $cfg->{ids
};
987 storage_check_enabled
($cfg, $storeid) if ($storeid);
992 foreach my $sid (keys %$ids) {
993 next if $storeid && $storeid ne $sid;
995 my $scfg = $ids->{$sid};
996 my $type = $scfg->{type
};
998 next if !$scfg->{content
}->{$tt};
1000 next if !storage_check_enabled
($cfg, $sid, undef, 1);
1002 $res->{$sid} = volume_list
($cfg, $sid, undef, $tt);
1009 my ($cfg, $storeid, $vmid, $content) = @_;
1011 my @ctypes = qw(rootdir images vztmpl iso backup snippets);
1013 my $cts = $content ?
[ $content ] : [ @ctypes ];
1015 my $scfg = PVE
::Storage
::storage_config
($cfg, $storeid);
1017 $cts = [ grep { defined($scfg->{content
}->{$_}) } @$cts ];
1019 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1021 activate_storage
($cfg, $storeid);
1023 my $res = $plugin->list_volumes($storeid, $scfg, $vmid, $cts);
1025 @$res = sort {lc($a->{volid
}) cmp lc ($b->{volid
}) } @$res;
1032 my $filename = "/sys/kernel/uevent_seqnum";
1035 if (my $fh = IO
::File-
>new($filename, "r")) {
1037 if ($line =~ m/^(\d+)$/) {
1045 sub activate_storage
{
1046 my ($cfg, $storeid, $cache) = @_;
1048 $cache = {} if !$cache;
1050 my $scfg = storage_check_enabled
($cfg, $storeid);
1052 return if $cache->{activated
}->{$storeid};
1054 $cache->{uevent_seqnum
} = uevent_seqnum
() if !$cache->{uevent_seqnum
};
1056 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1058 if ($scfg->{base
}) {
1059 my ($baseid, undef) = parse_volume_id
($scfg->{base
});
1060 activate_storage
($cfg, $baseid, $cache);
1063 if (!$plugin->check_connection($storeid, $scfg)) {
1064 die "storage '$storeid' is not online\n";
1067 $plugin->activate_storage($storeid, $scfg, $cache);
1069 my $newseq = uevent_seqnum
();
1071 # only call udevsettle if there are events
1072 if ($newseq > $cache->{uevent_seqnum
}) {
1073 system ("udevadm settle --timeout=30"); # ignore errors
1074 $cache->{uevent_seqnum
} = $newseq;
1077 $cache->{activated
}->{$storeid} = 1;
1080 sub activate_storage_list
{
1081 my ($cfg, $storeid_list, $cache) = @_;
1083 $cache = {} if !$cache;
1085 foreach my $storeid (@$storeid_list) {
1086 activate_storage
($cfg, $storeid, $cache);
1090 sub deactivate_storage
{
1091 my ($cfg, $storeid) = @_;
1093 my $scfg = storage_config
($cfg, $storeid);
1094 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1097 $plugin->deactivate_storage($storeid, $scfg, $cache);
1100 sub activate_volumes
{
1101 my ($cfg, $vollist, $snapname) = @_;
1103 return if !($vollist && scalar(@$vollist));
1105 my $storagehash = {};
1106 foreach my $volid (@$vollist) {
1107 my ($storeid, undef) = parse_volume_id
($volid);
1108 $storagehash->{$storeid} = 1;
1113 activate_storage_list
($cfg, [keys %$storagehash], $cache);
1115 foreach my $volid (@$vollist) {
1116 my ($storeid, $volname) = parse_volume_id
($volid);
1117 my $scfg = storage_config
($cfg, $storeid);
1118 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1119 $plugin->activate_volume($storeid, $scfg, $volname, $snapname, $cache);
1123 sub deactivate_volumes
{
1124 my ($cfg, $vollist, $snapname) = @_;
1126 return if !($vollist && scalar(@$vollist));
1131 foreach my $volid (@$vollist) {
1132 my ($storeid, $volname) = parse_volume_id
($volid);
1134 my $scfg = storage_config
($cfg, $storeid);
1135 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1138 $plugin->deactivate_volume($storeid, $scfg, $volname, $snapname, $cache);
1142 push @errlist, $volid;
1146 die "volume deactivation failed: " . join(' ', @errlist)
1147 if scalar(@errlist);
1151 my ($cfg, $content, $includeformat) = @_;
1153 my $ids = $cfg->{ids
};
1157 my @ctypes = PVE
::Tools
::split_list
($content);
1160 foreach my $storeid (keys %$ids) {
1161 my $storage_enabled = defined(storage_check_enabled
($cfg, $storeid, undef, 1));
1163 if (defined($content)) {
1165 foreach my $ctype (@ctypes) {
1166 if ($ids->{$storeid}->{content
}->{$ctype}) {
1171 next if !$want_ctype || !$storage_enabled;
1174 my $type = $ids->{$storeid}->{type
};
1176 $info->{$storeid} = {
1181 shared
=> $ids->{$storeid}->{shared
} ?
1 : 0,
1182 content
=> PVE
::Storage
::Plugin
::content_hash_to_string
($ids->{$storeid}->{content
}),
1184 enabled
=> $storage_enabled ?
1 : 0,
1187 push @$slist, $storeid;
1192 foreach my $storeid (keys %$ids) {
1193 my $scfg = $ids->{$storeid};
1195 next if !$info->{$storeid};
1196 next if !$info->{$storeid}->{enabled
};
1198 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1199 if ($includeformat) {
1200 my $pd = $plugin->plugindata();
1201 $info->{$storeid}->{format
} = $pd->{format
}
1203 $info->{$storeid}->{select_existing
} = $pd->{select_existing
}
1204 if $pd->{select_existing
};
1207 eval { activate_storage
($cfg, $storeid, $cache); };
1213 my ($total, $avail, $used, $active) = eval { $plugin->status($storeid, $scfg, $cache); };
1216 $info->{$storeid}->{total
} = int($total);
1217 $info->{$storeid}->{avail
} = int($avail);
1218 $info->{$storeid}->{used
} = int($used);
1219 $info->{$storeid}->{active
} = $active;
1228 my ($packed_ip, $family);
1230 my @res = PVE
::Tools
::getaddrinfo_all
($server);
1231 $family = $res[0]->{family
};
1232 $packed_ip = (PVE
::Tools
::unpack_sockaddr_in46
($res[0]->{addr
}))[2];
1234 if (defined $packed_ip) {
1235 return Socket
::inet_ntop
($family, $packed_ip);
1241 my ($server_in) = @_;
1244 if (!($server = resolv_server
($server_in))) {
1245 die "unable to resolve address for server '${server_in}'\n";
1248 my $cmd = ['/sbin/showmount', '--no-headers', '--exports', $server];
1251 run_command
($cmd, outfunc
=> sub {
1254 # note: howto handle white spaces in export path??
1255 if ($line =~ m!^(/\S+)\s+(.+)$!) {
1264 my ($server_in, $user, $password, $domain) = @_;
1266 my $server = resolv_server
($server_in);
1267 die "unable to resolve address for server '${server_in}'\n" if !$server;
1269 # we only support Windows 2012 and newer, so just use smb3
1270 my $cmd = ['/usr/bin/smbclient', '-m', 'smb3', '-d', '0', '-L', $server];
1271 push @$cmd, '-W', $domain if defined($domain);
1273 push @$cmd, '-N' if !defined($password);
1274 local $ENV{USER
} = $user if defined($user);
1275 local $ENV{PASSWD
} = $password if defined($password);
1286 if ($line =~ m/(\S+)\s*Disk\s*(\S*)/) {
1288 } elsif ($line =~ m/(NT_STATUS_(\S+))/) {
1290 $err .= "unexpected status: $1\n" if uc($1) ne 'SUCCESS';
1294 # only die if we got no share, else it's just some followup check error
1295 # (like workgroup querying)
1296 raise
($err) if $err && !%$res;
1303 my $cmd = ['zfs', 'list', '-t', 'filesystem', '-Hp', '-o', 'name,avail,used'];
1306 run_command
($cmd, outfunc
=> sub {
1309 if ($line =~m/^(\S+)\s+(\S+)\s+(\S+)$/) {
1310 my ($pool, $size_str, $used_str) = ($1, $2, $3);
1311 my $size = $size_str + 0;
1312 my $used = $used_str + 0;
1313 # ignore subvolumes generated by our ZFSPoolPlugin
1314 return if $pool =~ m!/subvol-\d+-[^/]+$!;
1315 return if $pool =~ m!/basevol-\d+-[^/]+$!;
1316 push @$res, { pool
=> $pool, size
=> $size, free
=> $size-$used };
1324 my ($portal, $noerr) = @_;
1326 my ($server, $port) = PVE
::Tools
::parse_host_and_port
($portal);
1328 if (my $ip = resolv_server
($server)) {
1330 $server = "[$server]" if $server =~ /^$IPV6RE$/;
1331 return $port ?
"$server:$port" : $server;
1334 return undef if $noerr;
1336 raise_param_exc
({ portal
=> "unable to resolve portal address '$portal'" });
1341 my ($portal_in) = @_;
1344 if (!($portal = resolv_portal
($portal_in))) {
1345 die "unable to parse/resolve portal address '${portal_in}'\n";
1348 return PVE
::Storage
::ISCSIPlugin
::iscsi_discovery
($portal);
1351 sub storage_default_format
{
1352 my ($cfg, $storeid) = @_;
1354 my $scfg = storage_config
($cfg, $storeid);
1356 return PVE
::Storage
::Plugin
::default_format
($scfg);
1359 sub vgroup_is_used
{
1360 my ($cfg, $vgname) = @_;
1362 foreach my $storeid (keys %{$cfg->{ids
}}) {
1363 my $scfg = storage_config
($cfg, $storeid);
1364 if ($scfg->{type
} eq 'lvm' && $scfg->{vgname
} eq $vgname) {
1372 sub target_is_used
{
1373 my ($cfg, $target) = @_;
1375 foreach my $storeid (keys %{$cfg->{ids
}}) {
1376 my $scfg = storage_config
($cfg, $storeid);
1377 if ($scfg->{type
} eq 'iscsi' && $scfg->{target
} eq $target) {
1385 sub volume_is_used
{
1386 my ($cfg, $volid) = @_;
1388 foreach my $storeid (keys %{$cfg->{ids
}}) {
1389 my $scfg = storage_config
($cfg, $storeid);
1390 if ($scfg->{base
} && $scfg->{base
} eq $volid) {
1398 sub storage_is_used
{
1399 my ($cfg, $storeid) = @_;
1401 foreach my $sid (keys %{$cfg->{ids
}}) {
1402 my $scfg = storage_config
($cfg, $sid);
1403 next if !$scfg->{base
};
1404 my ($st) = parse_volume_id
($scfg->{base
});
1405 return 1 if $st && $st eq $storeid;
1412 my ($list, $func) = @_;
1416 foreach my $sid (keys %$list) {
1417 foreach my $info (@{$list->{$sid}}) {
1418 my $volid = $info->{volid
};
1419 my ($sid1, $volname) = parse_volume_id
($volid, 1);
1420 if ($sid1 && $sid1 eq $sid) {
1421 &$func ($volid, $sid, $info);
1423 warn "detected strange volid '$volid' in volume list for '$sid'\n";
1429 sub decompressor_info
{
1430 my ($format, $comp) = @_;
1432 if ($format eq 'tgz' && !defined($comp)) {
1433 ($format, $comp) = ('tar', 'gz');
1436 my $decompressor = {
1438 gz
=> ['tar', '-z'],
1439 lzo
=> ['tar', '--lzop'],
1440 zst
=> ['tar', '--zstd'],
1444 lzo
=> ['lzop', '-d', '-c'],
1445 zst
=> ['zstd', '-q', '-d', '-c'],
1449 die "ERROR: archive format not defined\n"
1450 if !defined($decompressor->{$format});
1453 $decomp = $decompressor->{$format}->{$comp} if $comp;
1457 compression
=> $comp,
1458 decompressor
=> $decomp,
1465 my ($archive) = shift;
1468 my $volid = basename
($archive);
1469 if ($volid =~ /^(vzdump-(lxc|openvz|qemu)-.+\.(tgz$|tar|vma)(?:\.(${\PVE::Storage::Plugin::COMPRESSOR_RE}))?)$/) {
1470 my $filename = "$1"; # untaint
1471 my ($type, $format, $comp) = ($2, $3, $4);
1472 my $format_re = defined($comp) ?
"$format.$comp" : "$format";
1473 $info = decompressor_info
($format, $comp);
1474 $info->{filename
} = $filename;
1475 $info->{type
} = $type;
1477 if ($volid =~ /^(vzdump-${type}-([1-9][0-9]{2,8})-(\d{4})_(\d{2})_(\d{2})-(\d{2})_(\d{2})_(\d{2}))\.${format_re}$/) {
1478 $info->{logfilename
} = "$1.log";
1479 $info->{vmid
} = int($2);
1480 $info->{ctime
} = timelocal
($8, $7, $6, $5, $4 - 1, $3);
1481 $info->{is_std_name
} = 1;
1483 $info->{is_std_name
} = 0;
1486 die "ERROR: couldn't determine archive info from '$archive'\n";
1492 sub archive_remove
{
1493 my ($archive_path) = @_;
1495 my $dirname = dirname
($archive_path);
1496 my $archive_info = eval { archive_info
($archive_path) } // {};
1497 my $logfn = $archive_info->{logfilename
};
1499 unlink $archive_path or die "removing archive $archive_path failed: $!\n";
1501 if (defined($logfn)) {
1502 my $logpath = "$dirname/$logfn";
1504 unlink $logpath or warn "removing log file $logpath failed: $!\n";
1509 sub extract_vzdump_config_tar
{
1510 my ($archive, $conf_re) = @_;
1512 die "ERROR: file '$archive' does not exist\n" if ! -f
$archive;
1514 my $pid = open(my $fh, '-|', 'tar', 'tf', $archive) ||
1515 die "unable to open file '$archive'\n";
1518 while (defined($file = <$fh>)) {
1519 if ($file =~ $conf_re) {
1520 $file = $1; # untaint
1529 die "ERROR: archive contains no configuration file\n" if !$file;
1535 $raw .= "$output\n";
1538 run_command
(['tar', '-xpOf', $archive, $file, '--occurrence'], outfunc
=> $out);
1540 return wantarray ?
($raw, $file) : $raw;
1543 sub extract_vzdump_config_vma
{
1544 my ($archive, $comp) = @_;
1547 my $out = sub { $raw .= "$_[0]\n"; };
1549 my $info = archive_info
($archive);
1550 $comp //= $info->{compression
};
1551 my $decompressor = $info->{decompressor
};
1554 my $cmd = [ [@$decompressor, $archive], ["vma", "config", "-"] ];
1556 # lzop/zcat exits with 1 when the pipe is closed early by vma, detect this and ignore the exit code later
1561 if ($output =~ m/lzop: Broken pipe: <stdout>/ || $output =~ m/gzip: stdout: Broken pipe/ || $output =~ m/zstd: error 70 : Write error : Broken pipe/) {
1563 } elsif (!defined ($errstring) && $output !~ m/^\s*$/) {
1564 $errstring = "Failed to extract config from VMA archive: $output\n";
1568 my $rc = eval { run_command
($cmd, outfunc
=> $out, errfunc
=> $err, noerr
=> 1) };
1571 $broken_pipe ||= $rc == 141; # broken pipe from vma POV
1573 if (!$errstring && !$broken_pipe && $rc != 0) {
1574 die "$rerr\n" if $rerr;
1575 die "config extraction failed with exit code $rc\n";
1577 die "$errstring\n" if $errstring;
1579 run_command
(["vma", "config", $archive], outfunc
=> $out);
1582 return wantarray ?
($raw, undef) : $raw;
1585 sub extract_vzdump_config
{
1586 my ($cfg, $volid) = @_;
1588 my ($storeid, $volname) = parse_volume_id
($volid);
1589 if (defined($storeid)) {
1590 my $scfg = storage_config
($cfg, $storeid);
1591 if ($scfg->{type
} eq 'pbs') {
1592 storage_check_enabled
($cfg, $storeid);
1593 return PVE
::Storage
::PBSPlugin-
>extract_vzdump_config($scfg, $volname, $storeid);
1597 my $archive = abs_filesystem_path
($cfg, $volid);
1598 my $info = archive_info
($archive);
1599 my $format = $info->{format
};
1600 my $comp = $info->{compression
};
1601 my $type = $info->{type
};
1603 if ($type eq 'lxc' || $type eq 'openvz') {
1604 return extract_vzdump_config_tar
($archive, qr!^(\./etc/vzdump/(pct|vps)\.conf)$!);
1605 } elsif ($type eq 'qemu') {
1606 if ($format eq 'tar') {
1607 return extract_vzdump_config_tar
($archive, qr!\(\./qemu-server\.conf\)!);
1609 return extract_vzdump_config_vma
($archive, $comp);
1612 die "cannot determine backup guest type for backup archive '$volid'\n";
1617 my ($cfg, $storeid, $keep, $vmid, $type, $dryrun, $logfunc) = @_;
1619 my $scfg = storage_config
($cfg, $storeid);
1620 die "storage '$storeid' does not support backups\n" if !$scfg->{content
}->{backup
};
1622 if (!defined($keep)) {
1623 die "no prune-backups options configured for storage '$storeid'\n"
1624 if !defined($scfg->{'prune-backups'});
1625 $keep = PVE
::JSONSchema
::parse_property_string
('prune-backups', $scfg->{'prune-backups'});
1628 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1629 return $plugin->prune_backups($scfg, $storeid, $keep, $vmid, $type, $dryrun, $logfunc);
1632 my $prune_mark = sub {
1633 my ($prune_entries, $keep_count, $id_func) = @_;
1635 return if !$keep_count;
1637 my $already_included = {};
1638 my $newly_included = {};
1640 foreach my $prune_entry (@{$prune_entries}) {
1641 my $mark = $prune_entry->{mark
};
1642 my $id = $id_func->($prune_entry->{ctime
});
1643 $already_included->{$id} = 1 if defined($mark) && $mark eq 'keep';
1646 foreach my $prune_entry (@{$prune_entries}) {
1647 my $mark = $prune_entry->{mark
};
1648 my $id = $id_func->($prune_entry->{ctime
});
1650 next if defined($mark) || $already_included->{$id};
1652 if (!$newly_included->{$id}) {
1653 last if scalar(keys %{$newly_included}) >= $keep_count;
1654 $newly_included->{$id} = 1;
1655 $prune_entry->{mark
} = 'keep';
1657 $prune_entry->{mark
} = 'remove';
1662 sub prune_mark_backup_group
{
1663 my ($backup_group, $keep) = @_;
1665 my $keep_all = delete $keep->{'keep-all'};
1667 if ($keep_all || !scalar(grep {$_ > 0} values %{$keep})) {
1668 $keep = { 'keep-all' => 1 } if $keep_all;
1669 foreach my $prune_entry (@{$backup_group}) {
1670 $prune_entry->{mark
} = 'keep';
1675 my $prune_list = [ sort { $b->{ctime
} <=> $a->{ctime
} } @{$backup_group} ];
1677 $prune_mark->($prune_list, $keep->{'keep-last'}, sub {
1681 $prune_mark->($prune_list, $keep->{'keep-hourly'}, sub {
1683 my (undef, undef, $hour, $day, $month, $year) = localtime($ctime);
1684 return "$hour/$day/$month/$year";
1686 $prune_mark->($prune_list, $keep->{'keep-daily'}, sub {
1688 my (undef, undef, undef, $day, $month, $year) = localtime($ctime);
1689 return "$day/$month/$year";
1691 $prune_mark->($prune_list, $keep->{'keep-weekly'}, sub {
1693 my ($sec, $min, $hour, $day, $month, $year) = localtime($ctime);
1694 my $iso_week = int(strftime
("%V", $sec, $min, $hour, $day, $month, $year));
1695 my $iso_week_year = int(strftime
("%G", $sec, $min, $hour, $day, $month, $year));
1696 return "$iso_week/$iso_week_year";
1698 $prune_mark->($prune_list, $keep->{'keep-monthly'}, sub {
1700 my (undef, undef, undef, undef, $month, $year) = localtime($ctime);
1701 return "$month/$year";
1703 $prune_mark->($prune_list, $keep->{'keep-yearly'}, sub {
1705 my $year = (localtime($ctime))[5];
1709 foreach my $prune_entry (@{$prune_list}) {
1710 $prune_entry->{mark
} //= 'remove';
1715 my ($cfg, $fh, $volid, $format, $snapshot, $base_snapshot, $with_snapshots) = @_;
1717 my ($storeid, $volname) = parse_volume_id
($volid, 1);
1718 die "cannot export volume '$volid'\n" if !$storeid;
1719 my $scfg = storage_config
($cfg, $storeid);
1720 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1721 return $plugin->volume_export($scfg, $storeid, $fh, $volname, $format,
1722 $snapshot, $base_snapshot, $with_snapshots);
1726 my ($cfg, $fh, $volid, $format, $base_snapshot, $with_snapshots, $allow_rename) = @_;
1728 my ($storeid, $volname) = parse_volume_id
($volid, 1);
1729 die "cannot import into volume '$volid'\n" if !$storeid;
1730 my $scfg = storage_config
($cfg, $storeid);
1731 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1732 return $plugin->volume_import($scfg, $storeid, $fh, $volname, $format,
1733 $base_snapshot, $with_snapshots, $allow_rename) // $volid;
1736 sub volume_export_formats
{
1737 my ($cfg, $volid, $snapshot, $base_snapshot, $with_snapshots) = @_;
1739 my ($storeid, $volname) = parse_volume_id
($volid, 1);
1740 return if !$storeid;
1741 my $scfg = storage_config
($cfg, $storeid);
1742 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1743 return $plugin->volume_export_formats($scfg, $storeid, $volname,
1744 $snapshot, $base_snapshot,
1748 sub volume_import_formats
{
1749 my ($cfg, $volid, $base_snapshot, $with_snapshots) = @_;
1751 my ($storeid, $volname) = parse_volume_id
($volid, 1);
1752 return if !$storeid;
1753 my $scfg = storage_config
($cfg, $storeid);
1754 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1755 return $plugin->volume_import_formats($scfg, $storeid, $volname,
1756 $base_snapshot, $with_snapshots);
1759 sub volume_transfer_formats
{
1760 my ($cfg, $src_volid, $dst_volid, $snapshot, $base_snapshot, $with_snapshots) = @_;
1761 my @export_formats = volume_export_formats
($cfg, $src_volid, $snapshot, $base_snapshot, $with_snapshots);
1762 my @import_formats = volume_import_formats
($cfg, $dst_volid, $base_snapshot, $with_snapshots);
1763 my %import_hash = map { $_ => 1 } @import_formats;
1764 my @common = grep { $import_hash{$_} } @export_formats;
1768 sub volume_imported_message
{
1769 my ($volid, $want_pattern) = @_;
1771 if ($want_pattern) {
1772 return qr/successfully imported '([^']*)'$/;
1774 return "successfully imported '$volid'\n";
1778 # bash completion helper
1780 sub complete_storage
{
1781 my ($cmdname, $pname, $cvalue) = @_;
1783 my $cfg = PVE
::Storage
::config
();
1785 return $cmdname eq 'add' ?
[] : [ PVE
::Storage
::storage_ids
($cfg) ];
1788 sub complete_storage_enabled
{
1789 my ($cmdname, $pname, $cvalue) = @_;
1793 my $cfg = PVE
::Storage
::config
();
1794 foreach my $sid (keys %{$cfg->{ids
}}) {
1795 next if !storage_check_enabled
($cfg, $sid, undef, 1);
1801 sub complete_content_type
{
1802 my ($cmdname, $pname, $cvalue) = @_;
1804 return [qw(rootdir images vztmpl iso backup snippets)];
1807 sub complete_volume
{
1808 my ($cmdname, $pname, $cvalue) = @_;
1812 my $storage_list = complete_storage_enabled
();
1814 if ($cvalue =~ m/^([^:]+):/) {
1815 $storage_list = [ $1 ];
1817 if (scalar(@$storage_list) > 1) {
1818 # only list storage IDs to avoid large listings
1820 foreach my $storeid (@$storage_list) {
1821 # Hack: simply return 2 artificial values, so that
1822 # completions does not finish
1823 push @$res, "$storeid:volname", "$storeid:...";
1830 foreach my $storeid (@$storage_list) {
1831 my $vollist = PVE
::Storage
::volume_list
($cfg, $storeid);
1833 foreach my $item (@$vollist) {
1834 push @$res, $item->{volid
};
1841 # Various io-heavy operations require io/bandwidth limits which can be
1842 # configured on multiple levels: The global defaults in datacenter.cfg, and
1843 # per-storage overrides. When we want to do a restore from storage A to storage
1844 # B, we should take the smaller limit defined for storages A and B, and if no
1845 # such limit was specified, use the one from datacenter.cfg.
1846 sub get_bandwidth_limit
{
1847 my ($operation, $storage_list, $override) = @_;
1849 # called for each limit (global, per-storage) with the 'default' and the
1850 # $operation limit and should udpate $override for every limit affecting
1852 my $use_global_limits = 0;
1853 my $apply_limit = sub {
1855 if (defined($bwlimit)) {
1856 my $limits = PVE
::JSONSchema
::parse_property_string
('bwlimit', $bwlimit);
1857 my $limit = $limits->{$operation} // $limits->{default};
1858 if (defined($limit)) {
1859 if (!$override || $limit < $override) {
1865 # If there was no applicable limit, try to apply the global ones.
1866 $use_global_limits = 1;
1869 my ($rpcenv, $authuser);
1870 if (defined($override)) {
1871 $rpcenv = PVE
::RPCEnvironment-
>get();
1872 $authuser = $rpcenv->get_user();
1875 # Apply per-storage limits - if there are storages involved.
1876 if (defined($storage_list) && @$storage_list) {
1877 my $config = config
();
1879 # The Datastore.Allocate permission allows us to modify the per-storage
1880 # limits, therefore it also allows us to override them.
1881 # Since we have most likely multiple storages to check, do a quick check on
1882 # the general '/storage' path to see if we can skip the checks entirely:
1883 return $override if $rpcenv && $rpcenv->check($authuser, '/storage', ['Datastore.Allocate'], 1);
1886 foreach my $storage (@$storage_list) {
1887 next if !defined($storage);
1888 # Avoid duplicate checks:
1889 next if $done{$storage};
1890 $done{$storage} = 1;
1892 # Otherwise we may still have individual /storage/$ID permissions:
1893 if (!$rpcenv || !$rpcenv->check($authuser, "/storage/$storage", ['Datastore.Allocate'], 1)) {
1894 # And if not: apply the limits.
1895 my $storecfg = storage_config
($config, $storage);
1896 $apply_limit->($storecfg->{bwlimit
});
1900 # Storage limits take precedence over the datacenter defaults, so if
1901 # a limit was applied:
1902 return $override if !$use_global_limits;
1905 # Sys.Modify on '/' means we can change datacenter.cfg which contains the
1906 # global default limits.
1907 if (!$rpcenv || !$rpcenv->check($authuser, '/', ['Sys.Modify'], 1)) {
1908 # So if we cannot modify global limits, apply them to our currently
1909 # requested override.
1910 my $dc = cfs_read_file
('datacenter.cfg');
1911 $apply_limit->($dc->{bwlimit
});
1917 # checks if the storage id is available and dies if not
1918 sub assert_sid_unused
{
1922 if (my $scfg = storage_config
($cfg, $sid, 1)) {
1923 die "storage ID '$sid' already defined\n";