16 use Time
::Local
qw(timelocal);
18 use PVE
::Tools
qw(run_command file_read_firstline dir_glob_foreach $IPV6RE);
19 use PVE
::Cluster
qw(cfs_read_file cfs_write_file cfs_lock_file);
20 use PVE
::DataCenterConfig
;
21 use PVE
::Exception
qw(raise_param_exc raise);
24 use PVE
::RPCEnvironment
;
27 use PVE
::Storage
::Plugin
;
28 use PVE
::Storage
::DirPlugin
;
29 use PVE
::Storage
::LVMPlugin
;
30 use PVE
::Storage
::LvmThinPlugin
;
31 use PVE
::Storage
::NFSPlugin
;
32 use PVE
::Storage
::CIFSPlugin
;
33 use PVE
::Storage
::ISCSIPlugin
;
34 use PVE
::Storage
::RBDPlugin
;
35 use PVE
::Storage
::CephFSPlugin
;
36 use PVE
::Storage
::ISCSIDirectPlugin
;
37 use PVE
::Storage
::GlusterfsPlugin
;
38 use PVE
::Storage
::ZFSPoolPlugin
;
39 use PVE
::Storage
::ZFSPlugin
;
40 use PVE
::Storage
::PBSPlugin
;
41 use PVE
::Storage
::BTRFSPlugin
;
43 # Storage API version. Increment it on changes in storage API interface.
44 use constant APIVER
=> 9;
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
=> 0;
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
::PBSPlugin-
>register();
64 PVE
::Storage
::BTRFSPlugin-
>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" if !$modname->isa('PVE::Storage::Plugin');
79 die "does not provide an api() method\n" if !$modname->can('api');
80 # Check storage API version and that file is really storage plugin.
81 my $version = $modname->api();
82 die "implements an API version newer than current ($version > " . APIVER
. ")\n"
84 my $min_version = (APIVER
- APIAGE
);
85 die "API version too old, please update the plugin ($version < $min_version)\n"
86 if $version < $min_version;
87 # all OK, do import and register (i.e., "use")
91 # If we got this far and the API version is not the same, make some noise:
92 warn "Plugin \"$modname\" is implementing an older storage API
, an upgrade
is recommended
\n"
93 if $version != APIVER;
96 warn "Error loading storage plugin
\"$modname\": $@";
101 # initialize all plugins
102 PVE
::Storage
::Plugin-
>init();
104 our $iso_extension_re = qr/\.(?:iso|img)/i;
106 our $vztmpl_extension_re = qr/\.tar\.(gz|xz|zst)/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 8.0 or PVE 9.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 allocated 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/([^/]+$vztmpl_extension_re)$!) {
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, $allow_blockdev) = @_;
615 if (parse_volume_id
($volid, 1)) {
616 activate_volumes
($cfg, [ $volid ]);
617 $path = PVE
::Storage
::path
($cfg, $volid);
619 if (-f
$volid || ($allow_blockdev && -b
$volid)) {
620 my $abspath = abs_path
($volid);
621 if ($abspath && $abspath =~ m
|^(/.+)$|) {
622 $path = $1; # untaint any path
626 die "can't find file '$volid'\n"
627 if !($path && (-f
$path || ($allow_blockdev && -b
$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' || $scfg->{type
} eq 'btrfs') {
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;
720 push @$recv, '-snapshot', $snapshot;
722 if ($migration_snapshot) {
723 push @$recv, '-delete-snapshot', $snapshot;
725 push @$recv, '-allow-rename', $allow_rename if $target_apiver >= 5;
727 if (defined($base_snapshot)) {
728 # Check if the snapshot exists on the remote side:
729 push @$send, '-base', $base_snapshot;
730 push @$recv, '-base', $base_snapshot if $target_apiver >= 9;
734 my $pattern = volume_imported_message
(undef, 1);
735 my $match_volid_and_log = sub {
738 $new_volid = $1 if ($line =~ $pattern);
746 volume_snapshot
($cfg, $volid, $snapshot) if $migration_snapshot;
748 if (defined($snapshot)) {
749 activate_volumes
($cfg, [$volid], $snapshot);
751 activate_volumes
($cfg, [$volid]);
756 my $input = IO
::File-
>new();
757 my $info = IO
::File-
>new();
758 open3
($input, $info, $info, @{$recv})
759 or die "receive command failed: $!\n";
762 my $try_ip = <$info> // '';
763 my ($ip) = $try_ip =~ /^($PVE::Tools::IPRE)$/ # untaint
764 or die "no tunnel IP received, got '$try_ip'\n";
766 my $try_port = <$info> // '';
767 my ($port) = $try_port =~ /^(\d+)$/ # untaint
768 or die "no tunnel port received, got '$try_port'\n";
770 my $socket = IO
::Socket
::IP-
>new(PeerHost
=> $ip, PeerPort
=> $port, Type
=> SOCK_STREAM
)
771 or die "failed to connect to tunnel at $ip:$port\n";
772 # we won't be reading from the socket
773 shutdown($socket, 0);
775 eval { run_command
([$send, @cstream], output
=> '>&'.fileno($socket), errfunc
=> $logfunc); };
778 # don't close the connection entirely otherwise the receiving end
779 # might not get all buffered data (and fails with 'connection reset by peer')
780 shutdown($socket, 1);
782 # wait for the remote process to finish
783 while (my $line = <$info>) {
784 $match_volid_and_log->("[$target_sshinfo->{name}] $line");
787 # now close the socket
789 if (!close($info)) { # does waitpid()
790 die "import failed: $!\n" if $!;
791 die "import failed: exit code ".($?>>8)."\n";
794 die $send_error if $send_error;
796 run_command
([$send, @cstream, $recv], logfunc
=> $match_volid_and_log);
799 die "unable to get ID of the migrated volume\n"
800 if !defined($new_volid) && $target_apiver >= 5;
803 warn "send/receive failed, cleaning up snapshot(s)..\n" if $err;
804 if ($migration_snapshot) {
805 eval { volume_snapshot_delete
($cfg, $volid, $snapshot, 0) };
806 warn "could not remove source snapshot: $@\n" if $@;
810 return $new_volid // $target_volid;
814 my ($cfg, $volid, $vmid, $snap) = @_;
816 my ($storeid, $volname) = parse_volume_id
($volid);
818 my $scfg = storage_config
($cfg, $storeid);
820 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
822 activate_storage
($cfg, $storeid);
824 # lock shared storage
825 return $plugin->cluster_lock_storage($storeid, $scfg->{shared
}, undef, sub {
826 my $volname = $plugin->clone_image($scfg, $storeid, $volname, $vmid, $snap);
827 return "$storeid:$volname";
831 sub vdisk_create_base
{
832 my ($cfg, $volid) = @_;
834 my ($storeid, $volname) = parse_volume_id
($volid);
836 my $scfg = storage_config
($cfg, $storeid);
838 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
840 activate_storage
($cfg, $storeid);
842 # lock shared storage
843 return $plugin->cluster_lock_storage($storeid, $scfg->{shared
}, undef, sub {
844 my $volname = $plugin->create_base($storeid, $scfg, $volname);
845 return "$storeid:$volname";
850 my ($cfg, $volid, $snapname) = @_;
852 my ($storeid, $volname) = parse_volume_id
($volid);
854 my $scfg = storage_config
($cfg, $storeid);
856 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
858 return $plugin->map_volume($storeid, $scfg, $volname, $snapname);
862 my ($cfg, $volid, $snapname) = @_;
864 my ($storeid, $volname) = parse_volume_id
($volid);
866 my $scfg = storage_config
($cfg, $storeid);
868 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
870 return $plugin->unmap_volume($storeid, $scfg, $volname, $snapname);
874 my ($cfg, $storeid, $vmid, $fmt, $name, $size) = @_;
876 die "no storage ID specified\n" if !$storeid;
878 PVE
::JSONSchema
::parse_storage_id
($storeid);
880 my $scfg = storage_config
($cfg, $storeid);
882 die "no VMID specified\n" if !$vmid;
884 $vmid = parse_vmid
($vmid);
886 my $defformat = PVE
::Storage
::Plugin
::default_format
($scfg);
888 $fmt = $defformat if !$fmt;
890 activate_storage
($cfg, $storeid);
892 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
894 # lock shared storage
895 return $plugin->cluster_lock_storage($storeid, $scfg->{shared
}, undef, sub {
896 my $old_umask = umask(umask|0037);
897 my $volname = eval { $plugin->alloc_image($storeid, $scfg, $vmid, $fmt, $name, $size) };
901 return "$storeid:$volname";
906 my ($cfg, $volid) = @_;
908 my ($storeid, $volname) = parse_volume_id
($volid);
909 my $scfg = storage_config
($cfg, $storeid);
910 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
912 activate_storage
($cfg, $storeid);
916 # lock shared storage
917 $plugin->cluster_lock_storage($storeid, $scfg->{shared
}, undef, sub {
918 # LVM-thin allows deletion of still referenced base volumes!
919 die "base volume '$volname' is still in use by linked clones\n"
920 if volume_is_base_and_used
($cfg, $volid);
922 my (undef, undef, undef, undef, undef, $isBase, $format) =
923 $plugin->parse_volname($volname);
924 $cleanup_worker = $plugin->free_image($storeid, $scfg, $volname, $isBase, $format);
927 return if !$cleanup_worker;
929 my $rpcenv = PVE
::RPCEnvironment
::get
();
930 my $authuser = $rpcenv->get_user();
932 $rpcenv->fork_worker('imgdel', undef, $authuser, $cleanup_worker);
936 my ($cfg, $storeid, $vmid, $vollist, $ctype) = @_;
938 my $ids = $cfg->{ids
};
940 storage_check_enabled
($cfg, $storeid) if ($storeid);
942 my $res = $storeid ?
{ $storeid => [] } : {};
944 # prepare/activate/refresh all storages
946 my $storage_list = [];
948 foreach my $volid (@$vollist) {
949 my ($sid, undef) = parse_volume_id
($volid);
950 next if !defined($ids->{$sid});
951 next if !storage_check_enabled
($cfg, $sid, undef, 1);
952 push @$storage_list, $sid;
955 foreach my $sid (keys %$ids) {
956 next if $storeid && $storeid ne $sid;
957 next if !storage_check_enabled
($cfg, $sid, undef, 1);
958 my $content = $ids->{$sid}->{content
};
959 next if defined($ctype) && !$content->{$ctype};
960 next if !($content->{rootdir
} || $content->{images
});
961 push @$storage_list, $sid;
967 activate_storage_list
($cfg, $storage_list, $cache);
969 for my $sid ($storage_list->@*) {
970 next if $storeid && $storeid ne $sid;
972 my $scfg = $ids->{$sid};
973 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
974 $res->{$sid} = $plugin->list_images($sid, $scfg, $vmid, $vollist, $cache);
975 @{$res->{$sid}} = sort {lc($a->{volid
}) cmp lc ($b->{volid
}) } @{$res->{$sid}} if $res->{$sid};
982 my ($cfg, $storeid, $tt) = @_;
984 die "unknown template type '$tt'\n"
985 if !($tt eq 'iso' || $tt eq 'vztmpl' || $tt eq 'backup' || $tt eq 'snippets');
987 my $ids = $cfg->{ids
};
989 storage_check_enabled
($cfg, $storeid) if ($storeid);
994 foreach my $sid (keys %$ids) {
995 next if $storeid && $storeid ne $sid;
997 my $scfg = $ids->{$sid};
998 my $type = $scfg->{type
};
1000 next if !$scfg->{content
}->{$tt};
1002 next if !storage_check_enabled
($cfg, $sid, undef, 1);
1004 $res->{$sid} = volume_list
($cfg, $sid, undef, $tt);
1011 my ($cfg, $storeid, $vmid, $content) = @_;
1013 my @ctypes = qw(rootdir images vztmpl iso backup snippets);
1015 my $cts = $content ?
[ $content ] : [ @ctypes ];
1017 my $scfg = PVE
::Storage
::storage_config
($cfg, $storeid);
1019 $cts = [ grep { defined($scfg->{content
}->{$_}) } @$cts ];
1021 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1023 activate_storage
($cfg, $storeid);
1025 my $res = $plugin->list_volumes($storeid, $scfg, $vmid, $cts);
1027 @$res = sort {lc($a->{volid
}) cmp lc ($b->{volid
}) } @$res;
1034 my $filename = "/sys/kernel/uevent_seqnum";
1037 if (my $fh = IO
::File-
>new($filename, "r")) {
1039 if ($line =~ m/^(\d+)$/) {
1047 sub activate_storage
{
1048 my ($cfg, $storeid, $cache) = @_;
1050 $cache = {} if !$cache;
1052 my $scfg = storage_check_enabled
($cfg, $storeid);
1054 return if $cache->{activated
}->{$storeid};
1056 $cache->{uevent_seqnum
} = uevent_seqnum
() if !$cache->{uevent_seqnum
};
1058 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1060 if ($scfg->{base
}) {
1061 my ($baseid, undef) = parse_volume_id
($scfg->{base
});
1062 activate_storage
($cfg, $baseid, $cache);
1065 if (!$plugin->check_connection($storeid, $scfg)) {
1066 die "storage '$storeid' is not online\n";
1069 $plugin->activate_storage($storeid, $scfg, $cache);
1071 my $newseq = uevent_seqnum
();
1073 # only call udevsettle if there are events
1074 if ($newseq > $cache->{uevent_seqnum
}) {
1075 system ("udevadm settle --timeout=30"); # ignore errors
1076 $cache->{uevent_seqnum
} = $newseq;
1079 $cache->{activated
}->{$storeid} = 1;
1082 sub activate_storage_list
{
1083 my ($cfg, $storeid_list, $cache) = @_;
1085 $cache = {} if !$cache;
1087 foreach my $storeid (@$storeid_list) {
1088 activate_storage
($cfg, $storeid, $cache);
1092 sub deactivate_storage
{
1093 my ($cfg, $storeid) = @_;
1095 my $scfg = storage_config
($cfg, $storeid);
1096 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1099 $plugin->deactivate_storage($storeid, $scfg, $cache);
1102 sub activate_volumes
{
1103 my ($cfg, $vollist, $snapname) = @_;
1105 return if !($vollist && scalar(@$vollist));
1107 my $storagehash = {};
1108 foreach my $volid (@$vollist) {
1109 my ($storeid, undef) = parse_volume_id
($volid);
1110 $storagehash->{$storeid} = 1;
1115 activate_storage_list
($cfg, [keys %$storagehash], $cache);
1117 foreach my $volid (@$vollist) {
1118 my ($storeid, $volname) = parse_volume_id
($volid);
1119 my $scfg = storage_config
($cfg, $storeid);
1120 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1121 $plugin->activate_volume($storeid, $scfg, $volname, $snapname, $cache);
1125 sub deactivate_volumes
{
1126 my ($cfg, $vollist, $snapname) = @_;
1128 return if !($vollist && scalar(@$vollist));
1133 foreach my $volid (@$vollist) {
1134 my ($storeid, $volname) = parse_volume_id
($volid);
1136 my $scfg = storage_config
($cfg, $storeid);
1137 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1140 $plugin->deactivate_volume($storeid, $scfg, $volname, $snapname, $cache);
1144 push @errlist, $volid;
1148 die "volume deactivation failed: " . join(' ', @errlist)
1149 if scalar(@errlist);
1153 my ($cfg, $content, $includeformat) = @_;
1155 my $ids = $cfg->{ids
};
1159 my @ctypes = PVE
::Tools
::split_list
($content);
1162 foreach my $storeid (keys %$ids) {
1163 my $storage_enabled = defined(storage_check_enabled
($cfg, $storeid, undef, 1));
1165 if (defined($content)) {
1167 foreach my $ctype (@ctypes) {
1168 if ($ids->{$storeid}->{content
}->{$ctype}) {
1173 next if !$want_ctype || !$storage_enabled;
1176 my $type = $ids->{$storeid}->{type
};
1178 $info->{$storeid} = {
1183 shared
=> $ids->{$storeid}->{shared
} ?
1 : 0,
1184 content
=> PVE
::Storage
::Plugin
::content_hash_to_string
($ids->{$storeid}->{content
}),
1186 enabled
=> $storage_enabled ?
1 : 0,
1189 push @$slist, $storeid;
1194 foreach my $storeid (keys %$ids) {
1195 my $scfg = $ids->{$storeid};
1197 next if !$info->{$storeid};
1198 next if !$info->{$storeid}->{enabled
};
1200 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1201 if ($includeformat) {
1202 my $pd = $plugin->plugindata();
1203 $info->{$storeid}->{format
} = $pd->{format
}
1205 $info->{$storeid}->{select_existing
} = $pd->{select_existing
}
1206 if $pd->{select_existing
};
1209 eval { activate_storage
($cfg, $storeid, $cache); };
1215 my ($total, $avail, $used, $active) = eval { $plugin->status($storeid, $scfg, $cache); };
1218 $info->{$storeid}->{total
} = int($total);
1219 $info->{$storeid}->{avail
} = int($avail);
1220 $info->{$storeid}->{used
} = int($used);
1221 $info->{$storeid}->{active
} = $active;
1230 my ($packed_ip, $family);
1232 my @res = PVE
::Tools
::getaddrinfo_all
($server);
1233 $family = $res[0]->{family
};
1234 $packed_ip = (PVE
::Tools
::unpack_sockaddr_in46
($res[0]->{addr
}))[2];
1236 if (defined $packed_ip) {
1237 return Socket
::inet_ntop
($family, $packed_ip);
1243 my ($server_in) = @_;
1246 if (!($server = resolv_server
($server_in))) {
1247 die "unable to resolve address for server '${server_in}'\n";
1250 my $cmd = ['/sbin/showmount', '--no-headers', '--exports', $server];
1253 run_command
($cmd, outfunc
=> sub {
1256 # note: howto handle white spaces in export path??
1257 if ($line =~ m!^(/\S+)\s+(.+)$!) {
1266 my ($server_in, $user, $password, $domain) = @_;
1268 my $server = resolv_server
($server_in);
1269 die "unable to resolve address for server '${server_in}'\n" if !$server;
1271 # we only support Windows 2012 and newer, so just use smb3
1272 my $cmd = ['/usr/bin/smbclient', '-m', 'smb3', '-d', '0', '-L', $server];
1273 push @$cmd, '-W', $domain if defined($domain);
1275 push @$cmd, '-N' if !defined($password);
1276 local $ENV{USER
} = $user if defined($user);
1277 local $ENV{PASSWD
} = $password if defined($password);
1288 if ($line =~ m/(\S+)\s*Disk\s*(\S*)/) {
1290 } elsif ($line =~ m/(NT_STATUS_(\S+))/) {
1292 $err .= "unexpected status: $1\n" if uc($1) ne 'SUCCESS';
1296 # only die if we got no share, else it's just some followup check error
1297 # (like workgroup querying)
1298 raise
($err) if $err && !%$res;
1305 my $cmd = ['zfs', 'list', '-t', 'filesystem', '-Hp', '-o', 'name,avail,used'];
1308 run_command
($cmd, outfunc
=> sub {
1311 if ($line =~m/^(\S+)\s+(\S+)\s+(\S+)$/) {
1312 my ($pool, $size_str, $used_str) = ($1, $2, $3);
1313 my $size = $size_str + 0;
1314 my $used = $used_str + 0;
1315 # ignore subvolumes generated by our ZFSPoolPlugin
1316 return if $pool =~ m!/subvol-\d+-[^/]+$!;
1317 return if $pool =~ m!/basevol-\d+-[^/]+$!;
1318 push @$res, { pool
=> $pool, size
=> $size, free
=> $size-$used };
1326 my ($portal, $noerr) = @_;
1328 my ($server, $port) = PVE
::Tools
::parse_host_and_port
($portal);
1330 if (my $ip = resolv_server
($server)) {
1332 $server = "[$server]" if $server =~ /^$IPV6RE$/;
1333 return $port ?
"$server:$port" : $server;
1336 return undef if $noerr;
1338 raise_param_exc
({ portal
=> "unable to resolve portal address '$portal'" });
1343 my ($portal_in) = @_;
1346 if (!($portal = resolv_portal
($portal_in))) {
1347 die "unable to parse/resolve portal address '${portal_in}'\n";
1350 return PVE
::Storage
::ISCSIPlugin
::iscsi_discovery
($portal);
1353 sub storage_default_format
{
1354 my ($cfg, $storeid) = @_;
1356 my $scfg = storage_config
($cfg, $storeid);
1358 return PVE
::Storage
::Plugin
::default_format
($scfg);
1361 sub vgroup_is_used
{
1362 my ($cfg, $vgname) = @_;
1364 foreach my $storeid (keys %{$cfg->{ids
}}) {
1365 my $scfg = storage_config
($cfg, $storeid);
1366 if ($scfg->{type
} eq 'lvm' && $scfg->{vgname
} eq $vgname) {
1374 sub target_is_used
{
1375 my ($cfg, $target) = @_;
1377 foreach my $storeid (keys %{$cfg->{ids
}}) {
1378 my $scfg = storage_config
($cfg, $storeid);
1379 if ($scfg->{type
} eq 'iscsi' && $scfg->{target
} eq $target) {
1387 sub volume_is_used
{
1388 my ($cfg, $volid) = @_;
1390 foreach my $storeid (keys %{$cfg->{ids
}}) {
1391 my $scfg = storage_config
($cfg, $storeid);
1392 if ($scfg->{base
} && $scfg->{base
} eq $volid) {
1400 sub storage_is_used
{
1401 my ($cfg, $storeid) = @_;
1403 foreach my $sid (keys %{$cfg->{ids
}}) {
1404 my $scfg = storage_config
($cfg, $sid);
1405 next if !$scfg->{base
};
1406 my ($st) = parse_volume_id
($scfg->{base
});
1407 return 1 if $st && $st eq $storeid;
1414 my ($list, $func) = @_;
1418 foreach my $sid (keys %$list) {
1419 foreach my $info (@{$list->{$sid}}) {
1420 my $volid = $info->{volid
};
1421 my ($sid1, $volname) = parse_volume_id
($volid, 1);
1422 if ($sid1 && $sid1 eq $sid) {
1423 &$func ($volid, $sid, $info);
1425 warn "detected strange volid '$volid' in volume list for '$sid'\n";
1431 sub decompressor_info
{
1432 my ($format, $comp) = @_;
1434 if ($format eq 'tgz' && !defined($comp)) {
1435 ($format, $comp) = ('tar', 'gz');
1438 my $decompressor = {
1440 gz
=> ['tar', '-z'],
1441 lzo
=> ['tar', '--lzop'],
1442 zst
=> ['tar', '--zstd'],
1446 lzo
=> ['lzop', '-d', '-c'],
1447 zst
=> ['zstd', '-q', '-d', '-c'],
1451 die "ERROR: archive format not defined\n"
1452 if !defined($decompressor->{$format});
1455 $decomp = $decompressor->{$format}->{$comp} if $comp;
1459 compression
=> $comp,
1460 decompressor
=> $decomp,
1467 my ($archive) = shift;
1470 my $volid = basename
($archive);
1471 if ($volid =~ /^(vzdump-(lxc|openvz|qemu)-.+\.(tgz$|tar|vma)(?:\.(${\PVE::Storage::Plugin::COMPRESSOR_RE}))?)$/) {
1472 my $filename = "$1"; # untaint
1473 my ($type, $format, $comp) = ($2, $3, $4);
1474 my $format_re = defined($comp) ?
"$format.$comp" : "$format";
1475 $info = decompressor_info
($format, $comp);
1476 $info->{filename
} = $filename;
1477 $info->{type
} = $type;
1479 if ($volid =~ /^(vzdump-${type}-([1-9][0-9]{2,8})-(\d{4})_(\d{2})_(\d{2})-(\d{2})_(\d{2})_(\d{2}))\.${format_re}$/) {
1480 $info->{logfilename
} = "$1.log";
1481 $info->{vmid
} = int($2);
1482 $info->{ctime
} = timelocal
($8, $7, $6, $5, $4 - 1, $3);
1483 $info->{is_std_name
} = 1;
1485 $info->{is_std_name
} = 0;
1488 die "ERROR: couldn't determine archive info from '$archive'\n";
1494 sub archive_remove
{
1495 my ($archive_path) = @_;
1497 my $dirname = dirname
($archive_path);
1498 my $archive_info = eval { archive_info
($archive_path) } // {};
1499 my $logfn = $archive_info->{logfilename
};
1501 unlink $archive_path or die "removing archive $archive_path failed: $!\n";
1503 if (defined($logfn)) {
1504 my $logpath = "$dirname/$logfn";
1506 unlink $logpath or warn "removing log file $logpath failed: $!\n";
1511 sub extract_vzdump_config_tar
{
1512 my ($archive, $conf_re) = @_;
1514 die "ERROR: file '$archive' does not exist\n" if ! -f
$archive;
1516 my $pid = open(my $fh, '-|', 'tar', 'tf', $archive) ||
1517 die "unable to open file '$archive'\n";
1520 while (defined($file = <$fh>)) {
1521 if ($file =~ $conf_re) {
1522 $file = $1; # untaint
1531 die "ERROR: archive contains no configuration file\n" if !$file;
1537 $raw .= "$output\n";
1540 run_command
(['tar', '-xpOf', $archive, $file, '--occurrence'], outfunc
=> $out);
1542 return wantarray ?
($raw, $file) : $raw;
1545 sub extract_vzdump_config_vma
{
1546 my ($archive, $comp) = @_;
1549 my $out = sub { $raw .= "$_[0]\n"; };
1551 my $info = archive_info
($archive);
1552 $comp //= $info->{compression
};
1553 my $decompressor = $info->{decompressor
};
1556 my $cmd = [ [@$decompressor, $archive], ["vma", "config", "-"] ];
1558 # lzop/zcat exits with 1 when the pipe is closed early by vma, detect this and ignore the exit code later
1563 if ($output =~ m/lzop: Broken pipe: <stdout>/ || $output =~ m/gzip: stdout: Broken pipe/ || $output =~ m/zstd: error 70 : Write error.*Broken pipe/) {
1565 } elsif (!defined ($errstring) && $output !~ m/^\s*$/) {
1566 $errstring = "Failed to extract config from VMA archive: $output\n";
1570 my $rc = eval { run_command
($cmd, outfunc
=> $out, errfunc
=> $err, noerr
=> 1) };
1573 $broken_pipe ||= $rc == 141; # broken pipe from vma POV
1575 if (!$errstring && !$broken_pipe && $rc != 0) {
1576 die "$rerr\n" if $rerr;
1577 die "config extraction failed with exit code $rc\n";
1579 die "$errstring\n" if $errstring;
1581 run_command
(["vma", "config", $archive], outfunc
=> $out);
1584 return wantarray ?
($raw, undef) : $raw;
1587 sub extract_vzdump_config
{
1588 my ($cfg, $volid) = @_;
1590 my ($storeid, $volname) = parse_volume_id
($volid);
1591 if (defined($storeid)) {
1592 my $scfg = storage_config
($cfg, $storeid);
1593 if ($scfg->{type
} eq 'pbs') {
1594 storage_check_enabled
($cfg, $storeid);
1595 return PVE
::Storage
::PBSPlugin-
>extract_vzdump_config($scfg, $volname, $storeid);
1599 my $archive = abs_filesystem_path
($cfg, $volid);
1600 my $info = archive_info
($archive);
1601 my $format = $info->{format
};
1602 my $comp = $info->{compression
};
1603 my $type = $info->{type
};
1605 if ($type eq 'lxc' || $type eq 'openvz') {
1606 return extract_vzdump_config_tar
($archive, qr!^(\./etc/vzdump/(pct|vps)\.conf)$!);
1607 } elsif ($type eq 'qemu') {
1608 if ($format eq 'tar') {
1609 return extract_vzdump_config_tar
($archive, qr!\(\./qemu-server\.conf\)!);
1611 return extract_vzdump_config_vma
($archive, $comp);
1614 die "cannot determine backup guest type for backup archive '$volid'\n";
1619 my ($cfg, $storeid, $keep, $vmid, $type, $dryrun, $logfunc) = @_;
1621 my $scfg = storage_config
($cfg, $storeid);
1622 die "storage '$storeid' does not support backups\n" if !$scfg->{content
}->{backup
};
1624 if (!defined($keep)) {
1625 die "no prune-backups options configured for storage '$storeid'\n"
1626 if !defined($scfg->{'prune-backups'});
1627 $keep = PVE
::JSONSchema
::parse_property_string
('prune-backups', $scfg->{'prune-backups'});
1630 activate_storage
($cfg, $storeid);
1632 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1633 return $plugin->prune_backups($scfg, $storeid, $keep, $vmid, $type, $dryrun, $logfunc);
1636 my $prune_mark = sub {
1637 my ($prune_entries, $keep_count, $id_func) = @_;
1639 return if !$keep_count;
1641 my $already_included = {};
1642 my $newly_included = {};
1644 foreach my $prune_entry (@{$prune_entries}) {
1645 my $mark = $prune_entry->{mark
};
1646 my $id = $id_func->($prune_entry->{ctime
});
1647 $already_included->{$id} = 1 if defined($mark) && $mark eq 'keep';
1650 foreach my $prune_entry (@{$prune_entries}) {
1651 my $mark = $prune_entry->{mark
};
1652 my $id = $id_func->($prune_entry->{ctime
});
1654 next if defined($mark) || $already_included->{$id};
1656 if (!$newly_included->{$id}) {
1657 last if scalar(keys %{$newly_included}) >= $keep_count;
1658 $newly_included->{$id} = 1;
1659 $prune_entry->{mark
} = 'keep';
1661 $prune_entry->{mark
} = 'remove';
1666 sub prune_mark_backup_group
{
1667 my ($backup_group, $keep) = @_;
1669 my @positive_opts = grep { $_ ne 'keep-all' && $keep->{$_} > 0 } keys $keep->%*;
1671 if ($keep->{'keep-all'} || scalar(@positive_opts) == 0) {
1672 foreach my $prune_entry (@{$backup_group}) {
1673 $prune_entry->{mark
} = 'keep';
1678 my $prune_list = [ sort { $b->{ctime
} <=> $a->{ctime
} } @{$backup_group} ];
1680 $prune_mark->($prune_list, $keep->{'keep-last'}, sub {
1684 $prune_mark->($prune_list, $keep->{'keep-hourly'}, sub {
1686 my (undef, undef, $hour, $day, $month, $year) = localtime($ctime);
1687 return "$hour/$day/$month/$year";
1689 $prune_mark->($prune_list, $keep->{'keep-daily'}, sub {
1691 my (undef, undef, undef, $day, $month, $year) = localtime($ctime);
1692 return "$day/$month/$year";
1694 $prune_mark->($prune_list, $keep->{'keep-weekly'}, sub {
1696 my ($sec, $min, $hour, $day, $month, $year) = localtime($ctime);
1697 my $iso_week = int(strftime
("%V", $sec, $min, $hour, $day, $month, $year));
1698 my $iso_week_year = int(strftime
("%G", $sec, $min, $hour, $day, $month, $year));
1699 return "$iso_week/$iso_week_year";
1701 $prune_mark->($prune_list, $keep->{'keep-monthly'}, sub {
1703 my (undef, undef, undef, undef, $month, $year) = localtime($ctime);
1704 return "$month/$year";
1706 $prune_mark->($prune_list, $keep->{'keep-yearly'}, sub {
1708 my $year = (localtime($ctime))[5];
1712 foreach my $prune_entry (@{$prune_list}) {
1713 $prune_entry->{mark
} //= 'remove';
1717 sub volume_export
: prototype($$$$$$$) {
1718 my ($cfg, $fh, $volid, $format, $snapshot, $base_snapshot, $with_snapshots) = @_;
1720 my ($storeid, $volname) = parse_volume_id
($volid, 1);
1721 die "cannot export volume '$volid'\n" if !$storeid;
1722 my $scfg = storage_config
($cfg, $storeid);
1723 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1724 return $plugin->volume_export($scfg, $storeid, $fh, $volname, $format,
1725 $snapshot, $base_snapshot, $with_snapshots);
1728 sub volume_import
: prototype($$$$$$$$) {
1729 my ($cfg, $fh, $volid, $format, $snapshot, $base_snapshot, $with_snapshots, $allow_rename) = @_;
1731 my ($storeid, $volname) = parse_volume_id
($volid, 1);
1732 die "cannot import into volume '$volid'\n" if !$storeid;
1733 my $scfg = storage_config
($cfg, $storeid);
1734 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1735 return $plugin->volume_import(
1748 sub volume_export_formats
: prototype($$$$$) {
1749 my ($cfg, $volid, $snapshot, $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_export_formats($scfg, $storeid, $volname,
1756 $snapshot, $base_snapshot,
1760 sub volume_import_formats
: prototype($$$$$) {
1761 my ($cfg, $volid, $snapshot, $base_snapshot, $with_snapshots) = @_;
1763 my ($storeid, $volname) = parse_volume_id
($volid, 1);
1764 return if !$storeid;
1765 my $scfg = storage_config
($cfg, $storeid);
1766 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1767 return $plugin->volume_import_formats(
1777 sub volume_transfer_formats
{
1778 my ($cfg, $src_volid, $dst_volid, $snapshot, $base_snapshot, $with_snapshots) = @_;
1779 my @export_formats = volume_export_formats
($cfg, $src_volid, $snapshot, $base_snapshot, $with_snapshots);
1780 my @import_formats = volume_import_formats
($cfg, $dst_volid, $snapshot, $base_snapshot, $with_snapshots);
1781 my %import_hash = map { $_ => 1 } @import_formats;
1782 my @common = grep { $import_hash{$_} } @export_formats;
1786 sub volume_imported_message
{
1787 my ($volid, $want_pattern) = @_;
1789 if ($want_pattern) {
1790 return qr/successfully imported '([^']*)'$/;
1792 return "successfully imported '$volid'\n";
1796 # bash completion helper
1798 sub complete_storage
{
1799 my ($cmdname, $pname, $cvalue) = @_;
1801 my $cfg = PVE
::Storage
::config
();
1803 return $cmdname eq 'add' ?
[] : [ PVE
::Storage
::storage_ids
($cfg) ];
1806 sub complete_storage_enabled
{
1807 my ($cmdname, $pname, $cvalue) = @_;
1811 my $cfg = PVE
::Storage
::config
();
1812 foreach my $sid (keys %{$cfg->{ids
}}) {
1813 next if !storage_check_enabled
($cfg, $sid, undef, 1);
1819 sub complete_content_type
{
1820 my ($cmdname, $pname, $cvalue) = @_;
1822 return [qw(rootdir images vztmpl iso backup snippets)];
1825 sub complete_volume
{
1826 my ($cmdname, $pname, $cvalue) = @_;
1830 my $storage_list = complete_storage_enabled
();
1832 if ($cvalue =~ m/^([^:]+):/) {
1833 $storage_list = [ $1 ];
1835 if (scalar(@$storage_list) > 1) {
1836 # only list storage IDs to avoid large listings
1838 foreach my $storeid (@$storage_list) {
1839 # Hack: simply return 2 artificial values, so that
1840 # completions does not finish
1841 push @$res, "$storeid:volname", "$storeid:...";
1848 foreach my $storeid (@$storage_list) {
1849 my $vollist = PVE
::Storage
::volume_list
($cfg, $storeid);
1851 foreach my $item (@$vollist) {
1852 push @$res, $item->{volid
};
1859 # Various io-heavy operations require io/bandwidth limits which can be
1860 # configured on multiple levels: The global defaults in datacenter.cfg, and
1861 # per-storage overrides. When we want to do a restore from storage A to storage
1862 # B, we should take the smaller limit defined for storages A and B, and if no
1863 # such limit was specified, use the one from datacenter.cfg.
1864 sub get_bandwidth_limit
{
1865 my ($operation, $storage_list, $override) = @_;
1867 # called for each limit (global, per-storage) with the 'default' and the
1868 # $operation limit and should update $override for every limit affecting
1870 my $use_global_limits = 0;
1871 my $apply_limit = sub {
1873 if (defined($bwlimit)) {
1874 my $limits = PVE
::JSONSchema
::parse_property_string
('bwlimit', $bwlimit);
1875 my $limit = $limits->{$operation} // $limits->{default};
1876 if (defined($limit)) {
1877 if (!$override || $limit < $override) {
1883 # If there was no applicable limit, try to apply the global ones.
1884 $use_global_limits = 1;
1887 my ($rpcenv, $authuser);
1888 if (defined($override)) {
1889 $rpcenv = PVE
::RPCEnvironment-
>get();
1890 $authuser = $rpcenv->get_user();
1893 # Apply per-storage limits - if there are storages involved.
1894 if (defined($storage_list) && @$storage_list) {
1895 my $config = config
();
1897 # The Datastore.Allocate permission allows us to modify the per-storage
1898 # limits, therefore it also allows us to override them.
1899 # Since we have most likely multiple storages to check, do a quick check on
1900 # the general '/storage' path to see if we can skip the checks entirely:
1901 return $override if $rpcenv && $rpcenv->check($authuser, '/storage', ['Datastore.Allocate'], 1);
1904 foreach my $storage (@$storage_list) {
1905 next if !defined($storage);
1906 # Avoid duplicate checks:
1907 next if $done{$storage};
1908 $done{$storage} = 1;
1910 # Otherwise we may still have individual /storage/$ID permissions:
1911 if (!$rpcenv || !$rpcenv->check($authuser, "/storage/$storage", ['Datastore.Allocate'], 1)) {
1912 # And if not: apply the limits.
1913 my $storecfg = storage_config
($config, $storage);
1914 $apply_limit->($storecfg->{bwlimit
});
1918 # Storage limits take precedence over the datacenter defaults, so if
1919 # a limit was applied:
1920 return $override if !$use_global_limits;
1923 # Sys.Modify on '/' means we can change datacenter.cfg which contains the
1924 # global default limits.
1925 if (!$rpcenv || !$rpcenv->check($authuser, '/', ['Sys.Modify'], 1)) {
1926 # So if we cannot modify global limits, apply them to our currently
1927 # requested override.
1928 my $dc = cfs_read_file
('datacenter.cfg');
1929 $apply_limit->($dc->{bwlimit
});
1935 # checks if the storage id is available and dies if not
1936 sub assert_sid_unused
{
1940 if (my $scfg = storage_config
($cfg, $sid, 1)) {
1941 die "storage ID '$sid' already defined\n";
1947 # removes leading/trailing spaces and (back)slashes completely
1948 # substitutes every non-ASCII-alphanumerical char with '_', except '_.-'
1949 sub normalize_content_filename
{
1950 my ($filename) = @_;
1953 $filename =~ s/^.*[\/\\]//;
1954 $filename =~ s/[^a-zA-Z0-9_.-]/_/g;