16 use PVE
::Tools
qw(run_command file_read_firstline dir_glob_foreach $IPV6RE);
17 use PVE
::Cluster
qw(cfs_read_file cfs_write_file cfs_lock_file);
18 use PVE
::Exception
qw(raise_param_exc);
21 use PVE
::RPCEnvironment
;
23 use PVE
::Storage
::Plugin
;
24 use PVE
::Storage
::DirPlugin
;
25 use PVE
::Storage
::LVMPlugin
;
26 use PVE
::Storage
::LvmThinPlugin
;
27 use PVE
::Storage
::NFSPlugin
;
28 use PVE
::Storage
::CIFSPlugin
;
29 use PVE
::Storage
::ISCSIPlugin
;
30 use PVE
::Storage
::RBDPlugin
;
31 use PVE
::Storage
::CephFSPlugin
;
32 use PVE
::Storage
::ISCSIDirectPlugin
;
33 use PVE
::Storage
::GlusterfsPlugin
;
34 use PVE
::Storage
::ZFSPoolPlugin
;
35 use PVE
::Storage
::ZFSPlugin
;
36 use PVE
::Storage
::DRBDPlugin
;
38 # Storage API version. Icrement it on changes in storage API interface.
39 use constant APIVER
=> 2;
40 # Age is the number of versions we're backward compatible with.
41 # This is like having 'current=APIVER' and age='APIAGE' in libtool,
42 # see https://www.gnu.org/software/libtool/manual/html_node/Libtool-versioning.html
43 use constant APIAGE
=> 1;
45 # load standard plugins
46 PVE
::Storage
::DirPlugin-
>register();
47 PVE
::Storage
::LVMPlugin-
>register();
48 PVE
::Storage
::LvmThinPlugin-
>register();
49 PVE
::Storage
::NFSPlugin-
>register();
50 PVE
::Storage
::CIFSPlugin-
>register();
51 PVE
::Storage
::ISCSIPlugin-
>register();
52 PVE
::Storage
::RBDPlugin-
>register();
53 PVE
::Storage
::CephFSPlugin-
>register();
54 PVE
::Storage
::ISCSIDirectPlugin-
>register();
55 PVE
::Storage
::GlusterfsPlugin-
>register();
56 PVE
::Storage
::ZFSPoolPlugin-
>register();
57 PVE
::Storage
::ZFSPlugin-
>register();
58 PVE
::Storage
::DRBDPlugin-
>register();
60 # load third-party plugins
61 if ( -d
'/usr/share/perl5/PVE/Storage/Custom' ) {
62 dir_glob_foreach
('/usr/share/perl5/PVE/Storage/Custom', '.*\.pm$', sub {
64 my $modname = 'PVE::Storage::Custom::' . $file;
65 $modname =~ s!\.pm$!!;
66 $file = 'PVE/Storage/Custom/' . $file;
71 # Check perl interface:
72 die "not derived from PVE::Storage::Plugin\n"
73 if !$modname->isa('PVE::Storage::Plugin');
74 die "does not provide an api() method\n"
75 if !$modname->can('api');
76 # Check storage API version and that file is really storage plugin.
77 my $version = $modname->api();
78 die "implements an API version newer than current ($version > " . APIVER
. ")\n"
80 my $min_version = (APIVER
- APIAGE
);
81 die "API version too old, please update the plugin ($version < $min_version)\n"
82 if $version < $min_version;
86 # If we got this far and the API version is not the same, make some
88 warn "Plugin \"$modname\" is implementing an older storage API
, an upgrade
is recommended
\n"
89 if $version != APIVER;
92 warn "Error loading storage plugin
\"$modname\": $@";
97 # initialize all plugins
98 PVE
::Storage
::Plugin-
>init();
100 my $UDEVADM = '/sbin/udevadm';
102 # PVE::Storage utility functions
105 return cfs_read_file
("storage.cfg");
111 cfs_write_file
('storage.cfg', $cfg);
114 sub lock_storage_config
{
115 my ($code, $errmsg) = @_;
117 cfs_lock_file
("storage.cfg", undef, $code);
120 $errmsg ?
die "$errmsg: $err" : die $err;
125 my ($cfg, $storeid, $noerr) = @_;
127 die "no storage ID specified\n" if !$storeid;
129 my $scfg = $cfg->{ids
}->{$storeid};
131 die "storage '$storeid' does not exists\n" if (!$noerr && !$scfg);
136 sub storage_check_node
{
137 my ($cfg, $storeid, $node, $noerr) = @_;
139 my $scfg = storage_config
($cfg, $storeid);
141 if ($scfg->{nodes
}) {
142 $node = PVE
::INotify
::nodename
() if !$node || ($node eq 'localhost');
143 if (!$scfg->{nodes
}->{$node}) {
144 die "storage '$storeid' is not available on node '$node'\n" if !$noerr;
152 sub storage_check_enabled
{
153 my ($cfg, $storeid, $node, $noerr) = @_;
155 my $scfg = storage_config
($cfg, $storeid);
157 if ($scfg->{disable
}) {
158 die "storage '$storeid' is disabled\n" if !$noerr;
162 return storage_check_node
($cfg, $storeid, $node, $noerr);
165 # storage_can_replicate:
166 # return true if storage supports replication
167 # (volumes alocated with vdisk_alloc() has replication feature)
168 sub storage_can_replicate
{
169 my ($cfg, $storeid, $format) = @_;
171 my $scfg = storage_config
($cfg, $storeid);
172 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
173 return $plugin->storage_can_replicate($scfg, $storeid, $format);
179 return keys %{$cfg->{ids
}};
183 my ($filename, $timeout) = @_;
185 return PVE
::Storage
::Plugin
::file_size_info
($filename, $timeout);
188 sub volume_size_info
{
189 my ($cfg, $volid, $timeout) = @_;
191 my ($storeid, $volname) = parse_volume_id
($volid, 1);
193 my $scfg = storage_config
($cfg, $storeid);
194 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
195 return $plugin->volume_size_info($scfg, $storeid, $volname, $timeout);
196 } elsif ($volid =~ m
|^(/.+)$| && -e
$volid) {
197 return file_size_info
($volid, $timeout);
204 my ($cfg, $volid, $size, $running) = @_;
206 my ($storeid, $volname) = parse_volume_id
($volid, 1);
208 my $scfg = storage_config
($cfg, $storeid);
209 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
210 return $plugin->volume_resize($scfg, $storeid, $volname, $size, $running);
211 } elsif ($volid =~ m
|^(/.+)$| && -e
$volid) {
212 die "resize file/device '$volid' is not possible\n";
214 die "unable to parse volume ID '$volid'\n";
218 sub volume_rollback_is_possible
{
219 my ($cfg, $volid, $snap) = @_;
221 my ($storeid, $volname) = parse_volume_id
($volid, 1);
223 my $scfg = storage_config
($cfg, $storeid);
224 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
225 return $plugin->volume_rollback_is_possible($scfg, $storeid, $volname, $snap);
226 } elsif ($volid =~ m
|^(/.+)$| && -e
$volid) {
227 die "snapshot rollback file/device '$volid' is not possible\n";
229 die "unable to parse volume ID '$volid'\n";
233 sub volume_snapshot
{
234 my ($cfg, $volid, $snap) = @_;
236 my ($storeid, $volname) = parse_volume_id
($volid, 1);
238 my $scfg = storage_config
($cfg, $storeid);
239 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
240 return $plugin->volume_snapshot($scfg, $storeid, $volname, $snap);
241 } elsif ($volid =~ m
|^(/.+)$| && -e
$volid) {
242 die "snapshot file/device '$volid' is not possible\n";
244 die "unable to parse volume ID '$volid'\n";
248 sub volume_snapshot_rollback
{
249 my ($cfg, $volid, $snap) = @_;
251 my ($storeid, $volname) = parse_volume_id
($volid, 1);
253 my $scfg = storage_config
($cfg, $storeid);
254 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
255 $plugin->volume_rollback_is_possible($scfg, $storeid, $volname, $snap);
256 return $plugin->volume_snapshot_rollback($scfg, $storeid, $volname, $snap);
257 } elsif ($volid =~ m
|^(/.+)$| && -e
$volid) {
258 die "snapshot rollback file/device '$volid' is not possible\n";
260 die "unable to parse volume ID '$volid'\n";
264 sub volume_snapshot_delete
{
265 my ($cfg, $volid, $snap, $running) = @_;
267 my ($storeid, $volname) = parse_volume_id
($volid, 1);
269 my $scfg = storage_config
($cfg, $storeid);
270 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
271 return $plugin->volume_snapshot_delete($scfg, $storeid, $volname, $snap, $running);
272 } elsif ($volid =~ m
|^(/.+)$| && -e
$volid) {
273 die "snapshot delete file/device '$volid' is not possible\n";
275 die "unable to parse volume ID '$volid'\n";
279 sub volume_has_feature
{
280 my ($cfg, $feature, $volid, $snap, $running) = @_;
282 my ($storeid, $volname) = parse_volume_id
($volid, 1);
284 my $scfg = storage_config
($cfg, $storeid);
285 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
286 return $plugin->volume_has_feature($scfg, $feature, $storeid, $volname, $snap, $running);
287 } elsif ($volid =~ m
|^(/.+)$| && -e
$volid) {
294 sub volume_snapshot_list
{
295 my ($cfg, $volid) = @_;
297 my ($storeid, $volname) = parse_volume_id
($volid, 1);
299 my $scfg = storage_config
($cfg, $storeid);
300 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
301 return $plugin->volume_snapshot_list($scfg, $storeid, $volname);
302 } elsif ($volid =~ m
|^(/.+)$| && -e
$volid) {
303 die "send file/device '$volid' is not possible\n";
305 die "unable to parse volume ID '$volid'\n";
307 # return an empty array if dataset does not exist.
311 my ($cfg, $storeid, $vmid) = @_;
313 my $scfg = storage_config
($cfg, $storeid);
314 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
316 my $path = $plugin->get_subdir($scfg, 'images');
318 return $vmid ?
"$path/$vmid" : $path;
321 sub get_private_dir
{
322 my ($cfg, $storeid, $vmid) = @_;
324 my $scfg = storage_config
($cfg, $storeid);
325 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
327 my $path = $plugin->get_subdir($scfg, 'rootdir');
329 return $vmid ?
"$path/$vmid" : $path;
333 my ($cfg, $storeid) = @_;
335 my $scfg = storage_config
($cfg, $storeid);
336 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
338 return $plugin->get_subdir($scfg, 'iso');
342 my ($cfg, $storeid) = @_;
344 my $scfg = storage_config
($cfg, $storeid);
345 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
347 return $plugin->get_subdir($scfg, 'vztmpl');
351 my ($cfg, $storeid) = @_;
353 my $scfg = storage_config
($cfg, $storeid);
354 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
356 return $plugin->get_subdir($scfg, 'backup');
359 # library implementation
364 die "VMID '$vmid' contains illegal characters\n" if $vmid !~ m/^\d+$/;
369 # NOTE: basename and basevmid are always undef for LVM-thin, where the
370 # clone -> base reference is not encoded in the volume ID.
371 # see note in PVE::Storage::LvmThinPlugin for details.
373 my ($cfg, $volid) = @_;
375 my ($storeid, $volname) = parse_volume_id
($volid);
377 my $scfg = storage_config
($cfg, $storeid);
379 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
381 # returns ($vtype, $name, $vmid, $basename, $basevmid, $isBase, $format)
383 return $plugin->parse_volname($volname);
386 sub parse_volume_id
{
387 my ($volid, $noerr) = @_;
389 return PVE
::Storage
::Plugin
::parse_volume_id
($volid, $noerr);
392 # test if we have read access to volid
393 sub check_volume_access
{
394 my ($rpcenv, $user, $cfg, $vmid, $volid) = @_;
396 my ($sid, $volname) = parse_volume_id
($volid, 1);
398 my ($vtype, undef, $ownervm) = parse_volname
($cfg, $volid);
399 if ($vtype eq 'iso' || $vtype eq 'vztmpl') {
400 # require at least read access to storage, (custom) templates/ISOs could be sensitive
401 $rpcenv->check_any($user, "/storage/$sid", ['Datastore.AllocateSpace', 'Datastore.Audit']);
402 } elsif (defined($ownervm) && defined($vmid) && ($ownervm == $vmid)) {
403 # we are owner - allow access
404 } elsif ($vtype eq 'backup' && $ownervm) {
405 $rpcenv->check($user, "/storage/$sid", ['Datastore.AllocateSpace']);
406 $rpcenv->check($user, "/vms/$ownervm", ['VM.Backup']);
408 # allow if we are Datastore administrator
409 $rpcenv->check($user, "/storage/$sid", ['Datastore.Allocate']);
412 die "Only root can pass arbitrary filesystem paths."
413 if $user ne 'root@pam';
419 my $volume_is_base_and_used__no_lock = sub {
420 my ($scfg, $storeid, $plugin, $volname) = @_;
422 my ($vtype, $name, $vmid, undef, undef, $isBase, undef) =
423 $plugin->parse_volname($volname);
426 my $vollist = $plugin->list_images($storeid, $scfg);
427 foreach my $info (@$vollist) {
428 my (undef, $tmpvolname) = parse_volume_id
($info->{volid
});
429 my $basename = undef;
430 my $basevmid = undef;
433 (undef, undef, undef, $basename, $basevmid) =
434 $plugin->parse_volname($tmpvolname);
437 if ($basename && defined($basevmid) && $basevmid == $vmid && $basename eq $name) {
445 # NOTE: this check does not work for LVM-thin, where the clone -> base
446 # reference is not encoded in the volume ID.
447 # see note in PVE::Storage::LvmThinPlugin for details.
448 sub volume_is_base_and_used
{
449 my ($cfg, $volid) = @_;
451 my ($storeid, $volname) = parse_volume_id
($volid);
452 my $scfg = storage_config
($cfg, $storeid);
453 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
455 $plugin->cluster_lock_storage($storeid, $scfg->{shared
}, undef, sub {
456 return &$volume_is_base_and_used__no_lock($scfg, $storeid, $plugin, $volname);
460 # try to map a filesystem path to a volume identifier
461 sub path_to_volume_id
{
462 my ($cfg, $path) = @_;
464 my $ids = $cfg->{ids
};
466 my ($sid, $volname) = parse_volume_id
($path, 1);
468 if (my $scfg = $ids->{$sid}) {
470 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
471 my ($vtype, $name, $vmid) = $plugin->parse_volname($volname);
472 return ($vtype, $path);
478 # Note: abs_path() return undef if $path doesn not exist
479 # for example when nfs storage is not mounted
480 $path = abs_path
($path) || $path;
482 foreach my $sid (keys %$ids) {
483 my $scfg = $ids->{$sid};
484 next if !$scfg->{path
};
485 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
486 my $imagedir = $plugin->get_subdir($scfg, 'images');
487 my $isodir = $plugin->get_subdir($scfg, 'iso');
488 my $tmpldir = $plugin->get_subdir($scfg, 'vztmpl');
489 my $backupdir = $plugin->get_subdir($scfg, 'backup');
490 my $privatedir = $plugin->get_subdir($scfg, 'rootdir');
492 if ($path =~ m!^$imagedir/(\d+)/([^/\s]+)$!) {
496 my $vollist = $plugin->list_images($sid, $scfg, $vmid);
497 foreach my $info (@$vollist) {
498 my ($storeid, $volname) = parse_volume_id
($info->{volid
});
499 my $volpath = $plugin->path($scfg, $volname, $storeid);
500 if ($volpath eq $path) {
501 return ('images', $info->{volid
});
504 } elsif ($path =~ m!^$isodir/([^/]+\.[Ii][Ss][Oo])$!) {
506 return ('iso', "$sid:iso/$name");
507 } elsif ($path =~ m!^$tmpldir/([^/]+\.tar\.gz)$!) {
509 return ('vztmpl', "$sid:vztmpl/$name");
510 } elsif ($path =~ m!^$privatedir/(\d+)$!) {
512 return ('rootdir', "$sid:rootdir/$vmid");
513 } elsif ($path =~ m!^$backupdir/([^/]+\.(tar|tar\.gz|tar\.lzo|tgz|vma|vma\.gz|vma\.lzo))$!) {
515 return ('iso', "$sid:backup/$name");
519 # can't map path to volume id
524 my ($cfg, $volid, $snapname) = @_;
526 my ($storeid, $volname) = parse_volume_id
($volid);
528 my $scfg = storage_config
($cfg, $storeid);
530 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
531 my ($path, $owner, $vtype) = $plugin->path($scfg, $volname, $storeid, $snapname);
532 return wantarray ?
($path, $owner, $vtype) : $path;
535 sub abs_filesystem_path
{
536 my ($cfg, $volid) = @_;
539 if (PVE
::Storage
::parse_volume_id
($volid, 1)) {
540 PVE
::Storage
::activate_volumes
($cfg, [ $volid ]);
541 $path = PVE
::Storage
::path
($cfg, $volid);
544 my $abspath = abs_path
($volid);
545 if ($abspath && $abspath =~ m
|^(/.+)$|) {
546 $path = $1; # untaint any path
551 die "can't find file '$volid'\n" if !($path && -f
$path);
556 sub storage_migrate
{
557 my ($cfg, $volid, $target_sshinfo, $target_storeid, $target_volname, $base_snapshot, $snapshot, $ratelimit_bps, $insecure, $with_snapshots, $logfunc) = @_;
559 my ($storeid, $volname) = parse_volume_id
($volid);
560 $target_volname = $volname if !$target_volname;
562 my $scfg = storage_config
($cfg, $storeid);
564 # no need to migrate shared content
565 return if $storeid eq $target_storeid && $scfg->{shared
};
567 my $tcfg = storage_config
($cfg, $target_storeid);
569 my $target_volid = "${target_storeid}:${target_volname}";
571 my $target_ip = $target_sshinfo->{ip
};
572 my $errstr = "unable to migrate '$volid' to '${target_volid}' on host '$target_sshinfo->{name}'";
574 my $ssh = PVE
::Cluster
::ssh_info_to_command
($target_sshinfo);
575 my $ssh_base = PVE
::Cluster
::ssh_info_to_command_base
($target_sshinfo);
576 local $ENV{RSYNC_RSH
} = PVE
::Tools
::cmd2string
($ssh_base);
578 my @cstream = ([ '/usr/bin/cstream', '-t', $ratelimit_bps ])
579 if defined($ratelimit_bps);
581 my $migration_snapshot;
582 if (!defined($snapshot)) {
583 if ($scfg->{type
} eq 'zfspool') {
584 $migration_snapshot = 1;
585 $snapshot = '__migration__';
589 my @formats = volume_transfer_formats
($cfg, $volid, $volid, $snapshot, $base_snapshot, $with_snapshots);
590 die "cannot migrate from storage type '$scfg->{type}' to '$tcfg->{type}'\n" if !@formats;
591 my $format = $formats[0];
595 @insecurecmd = ('pvecm', 'mtunnel', '-run-command', 1);
596 if (my $network = $target_sshinfo->{network
}) {
597 push @insecurecmd, '-migration_network', $network;
601 $with_snapshots = $with_snapshots ?
1 : 0; # sanitize for passing as cli parameter
602 my $send = ['pvesm', 'export', $volid, $format, '-', '-with-snapshots', $with_snapshots];
603 my $recv = [@$ssh, @insecurecmd, '--', 'pvesm', 'import', $volid, $format, '-', '-with-snapshots', $with_snapshots];
604 if (defined($snapshot)) {
605 push @$send, '-snapshot', $snapshot
607 if ($migration_snapshot) {
608 push @$recv, '-delete-snapshot', $snapshot;
611 if (defined($base_snapshot)) {
612 # Check if the snapshot exists on the remote side:
613 push @$send, '-base', $base_snapshot;
614 push @$recv, '-base', $base_snapshot;
617 volume_snapshot
($cfg, $volid, $snapshot) if $migration_snapshot;
620 open(my $info, '-|', @$recv)
621 or die "receive command failed: $!\n";
622 my ($ip) = <$info> =~ /^($PVE::Tools::IPRE)$/ or die "no tunnel IP received\n";
623 my ($port) = <$info> =~ /^(\d+)$/ or die "no tunnel port received\n";
624 my $socket = IO
::Socket
::IP-
>new(PeerHost
=> $ip, PeerPort
=> $port, Type
=> SOCK_STREAM
)
625 or die "failed to connect to tunnel at $ip:$port\n";
626 # we won't be reading from the socket
627 shutdown($socket, 0);
628 run_command
([$send, @cstream], output
=> '>&'.fileno($socket));
629 # don't close the connection entirely otherwise the receiving end
630 # might not get all buffered data (and fails with 'connection reset by peer')
631 shutdown($socket, 1);
632 1 while <$info>; # wait for the remote process to finish
633 # now close the socket
635 if (!close($info)) { # does waitpid()
636 die "import failed: $!\n" if $!;
637 die "import failed: exit code ".($?>>8)."\n";
640 run_command
([$send, @cstream, $recv], logfunc
=> $logfunc);
644 warn "send/receive failed, cleaning up snapshot(s)..\n" if $err;
645 if ($migration_snapshot) {
646 eval { volume_snapshot_delete
($cfg, $volid, $snapshot, 0) };
647 warn "could not remove source snapshot: $@\n" if $@;
653 my ($cfg, $volid, $vmid, $snap) = @_;
655 my ($storeid, $volname) = parse_volume_id
($volid);
657 my $scfg = storage_config
($cfg, $storeid);
659 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
661 activate_storage
($cfg, $storeid);
663 # lock shared storage
664 return $plugin->cluster_lock_storage($storeid, $scfg->{shared
}, undef, sub {
665 my $volname = $plugin->clone_image($scfg, $storeid, $volname, $vmid, $snap);
666 return "$storeid:$volname";
670 sub vdisk_create_base
{
671 my ($cfg, $volid) = @_;
673 my ($storeid, $volname) = parse_volume_id
($volid);
675 my $scfg = storage_config
($cfg, $storeid);
677 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
679 activate_storage
($cfg, $storeid);
681 # lock shared storage
682 return $plugin->cluster_lock_storage($storeid, $scfg->{shared
}, undef, sub {
683 my $volname = $plugin->create_base($storeid, $scfg, $volname);
684 return "$storeid:$volname";
689 my ($cfg, $volid, $snapname) = @_;
691 my ($storeid, $volname) = parse_volume_id
($volid);
693 my $scfg = storage_config
($cfg, $storeid);
695 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
697 return $plugin->map_volume($storeid, $scfg, $volname, $snapname);
701 my ($cfg, $volid, $snapname) = @_;
703 my ($storeid, $volname) = parse_volume_id
($volid);
705 my $scfg = storage_config
($cfg, $storeid);
707 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
709 return $plugin->unmap_volume($storeid, $scfg, $volname, $snapname);
713 my ($cfg, $storeid, $vmid, $fmt, $name, $size) = @_;
715 die "no storage ID specified\n" if !$storeid;
717 PVE
::JSONSchema
::parse_storage_id
($storeid);
719 my $scfg = storage_config
($cfg, $storeid);
721 die "no VMID specified\n" if !$vmid;
723 $vmid = parse_vmid
($vmid);
725 my $defformat = PVE
::Storage
::Plugin
::default_format
($scfg);
727 $fmt = $defformat if !$fmt;
729 activate_storage
($cfg, $storeid);
731 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
733 # lock shared storage
734 return $plugin->cluster_lock_storage($storeid, $scfg->{shared
}, undef, sub {
735 my $old_umask = umask(umask|0037);
736 my $volname = eval { $plugin->alloc_image($storeid, $scfg, $vmid, $fmt, $name, $size) };
740 return "$storeid:$volname";
745 my ($cfg, $volid) = @_;
747 my ($storeid, $volname) = parse_volume_id
($volid);
748 my $scfg = storage_config
($cfg, $storeid);
749 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
751 activate_storage
($cfg, $storeid);
755 # lock shared storage
756 $plugin->cluster_lock_storage($storeid, $scfg->{shared
}, undef, sub {
757 # LVM-thin allows deletion of still referenced base volumes!
758 die "base volume '$volname' is still in use by linked clones\n"
759 if &$volume_is_base_and_used__no_lock($scfg, $storeid, $plugin, $volname);
761 my (undef, undef, undef, undef, undef, $isBase, $format) =
762 $plugin->parse_volname($volname);
763 $cleanup_worker = $plugin->free_image($storeid, $scfg, $volname, $isBase, $format);
766 return if !$cleanup_worker;
768 my $rpcenv = PVE
::RPCEnvironment
::get
();
769 my $authuser = $rpcenv->get_user();
771 $rpcenv->fork_worker('imgdel', undef, $authuser, $cleanup_worker);
774 # lists all files in the snippets directory
776 my ($cfg, $storeid) = @_;
778 my $ids = $cfg->{ids
};
780 storage_check_enabled
($cfg, $storeid) if ($storeid);
784 foreach my $sid (keys %$ids) {
785 next if $storeid && $storeid ne $sid;
786 next if !storage_check_enabled
($cfg, $sid, undef, 1);
788 my $scfg = $ids->{$sid};
789 next if !$scfg->{content
}->{snippets
};
791 activate_storage
($cfg, $sid);
794 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
795 my $path = $plugin->get_subdir($scfg, 'snippets');
797 foreach my $fn (<$path/*>) {
800 push @{$res->{$sid}}, {
801 volid
=> "$sid:snippets/". basename
($fn),
809 @{$res->{$sid}} = sort {$a->{volid
} cmp $b->{volid
} } @{$res->{$sid}};
816 #list iso or openvz template ($tt = <iso|vztmpl|backup>)
818 my ($cfg, $storeid, $tt) = @_;
820 die "unknown template type '$tt'\n"
821 if !($tt eq 'iso' || $tt eq 'vztmpl' || $tt eq 'backup');
823 my $ids = $cfg->{ids
};
825 storage_check_enabled
($cfg, $storeid) if ($storeid);
831 foreach my $sid (keys %$ids) {
832 next if $storeid && $storeid ne $sid;
834 my $scfg = $ids->{$sid};
835 my $type = $scfg->{type
};
837 next if !storage_check_enabled
($cfg, $sid, undef, 1);
839 next if $tt eq 'iso' && !$scfg->{content
}->{iso
};
840 next if $tt eq 'vztmpl' && !$scfg->{content
}->{vztmpl
};
841 next if $tt eq 'backup' && !$scfg->{content
}->{backup
};
843 activate_storage
($cfg, $sid);
846 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
848 my $path = $plugin->get_subdir($scfg, $tt);
850 foreach my $fn (<$path/*>) {
855 next if $fn !~ m!/([^/]+\.[Ii][Ss][Oo])$!;
857 $info = { volid
=> "$sid:iso/$1", format
=> 'iso' };
859 } elsif ($tt eq 'vztmpl') {
860 next if $fn !~ m!/([^/]+\.tar\.([gx]z))$!;
862 $info = { volid
=> "$sid:vztmpl/$1", format
=> "t$2" };
864 } elsif ($tt eq 'backup') {
865 next if $fn !~ m!/([^/]+\.(tar|tar\.gz|tar\.lzo|tgz|vma|vma\.gz|vma\.lzo))$!;
867 $info = { volid
=> "$sid:backup/$1", format
=> $2 };
870 $info->{size
} = -s
$fn;
872 push @{$res->{$sid}}, $info;
877 @{$res->{$sid}} = sort {lc($a->{volid
}) cmp lc ($b->{volid
}) } @{$res->{$sid}} if $res->{$sid};
885 my ($cfg, $storeid, $vmid, $vollist) = @_;
887 my $ids = $cfg->{ids
};
889 storage_check_enabled
($cfg, $storeid) if ($storeid);
893 # prepare/activate/refresh all storages
895 my $storage_list = [];
897 foreach my $volid (@$vollist) {
898 my ($sid, undef) = parse_volume_id
($volid);
899 next if !defined($ids->{$sid});
900 next if !storage_check_enabled
($cfg, $sid, undef, 1);
901 push @$storage_list, $sid;
904 foreach my $sid (keys %$ids) {
905 next if $storeid && $storeid ne $sid;
906 next if !storage_check_enabled
($cfg, $sid, undef, 1);
907 push @$storage_list, $sid;
913 activate_storage_list
($cfg, $storage_list, $cache);
915 foreach my $sid (keys %$ids) {
916 next if $storeid && $storeid ne $sid;
917 next if !storage_check_enabled
($cfg, $sid, undef, 1);
919 my $scfg = $ids->{$sid};
920 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
921 $res->{$sid} = $plugin->list_images($sid, $scfg, $vmid, $vollist, $cache);
922 @{$res->{$sid}} = sort {lc($a->{volid
}) cmp lc ($b->{volid
}) } @{$res->{$sid}} if $res->{$sid};
929 my ($cfg, $storeid, $vmid, $content) = @_;
931 my @ctypes = qw(images vztmpl iso backup snippets);
933 my $cts = $content ?
[ $content ] : [ @ctypes ];
935 my $scfg = PVE
::Storage
::storage_config
($cfg, $storeid);
938 foreach my $ct (@$cts) {
940 if ($ct eq 'images') {
941 $data = vdisk_list
($cfg, $storeid, $vmid);
942 } elsif ($ct eq 'iso' && !defined($vmid)) {
943 $data = template_list
($cfg, $storeid, 'iso');
944 } elsif ($ct eq 'vztmpl'&& !defined($vmid)) {
945 $data = template_list
($cfg, $storeid, 'vztmpl');
946 } elsif ($ct eq 'backup') {
947 $data = template_list
($cfg, $storeid, 'backup');
948 foreach my $item (@{$data->{$storeid}}) {
949 if (defined($vmid)) {
950 @{$data->{$storeid}} = grep { $_->{volid
} =~ m/\S+-$vmid-\S+/ } @{$data->{$storeid}};
953 } elsif ($ct eq 'snippets') {
954 $data = snippets_list
($cfg, $storeid);
957 next if !$data || !$data->{$storeid};
959 foreach my $item (@{$data->{$storeid}}) {
960 $item->{content
} = $ct;
970 my $filename = "/sys/kernel/uevent_seqnum";
973 if (my $fh = IO
::File-
>new($filename, "r")) {
975 if ($line =~ m/^(\d+)$/) {
983 sub activate_storage
{
984 my ($cfg, $storeid, $cache) = @_;
986 $cache = {} if !$cache;
988 my $scfg = storage_check_enabled
($cfg, $storeid);
990 return if $cache->{activated
}->{$storeid};
992 $cache->{uevent_seqnum
} = uevent_seqnum
() if !$cache->{uevent_seqnum
};
994 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
997 my ($baseid, undef) = parse_volume_id
($scfg->{base
});
998 activate_storage
($cfg, $baseid, $cache);
1001 if (!$plugin->check_connection($storeid, $scfg)) {
1002 die "storage '$storeid' is not online\n";
1005 $plugin->activate_storage($storeid, $scfg, $cache);
1007 my $newseq = uevent_seqnum
();
1009 # only call udevsettle if there are events
1010 if ($newseq > $cache->{uevent_seqnum
}) {
1012 system ("$UDEVADM settle --timeout=$timeout"); # ignore errors
1013 $cache->{uevent_seqnum
} = $newseq;
1016 $cache->{activated
}->{$storeid} = 1;
1019 sub activate_storage_list
{
1020 my ($cfg, $storeid_list, $cache) = @_;
1022 $cache = {} if !$cache;
1024 foreach my $storeid (@$storeid_list) {
1025 activate_storage
($cfg, $storeid, $cache);
1029 sub deactivate_storage
{
1030 my ($cfg, $storeid) = @_;
1032 my $scfg = storage_config
($cfg, $storeid);
1033 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1036 $plugin->deactivate_storage($storeid, $scfg, $cache);
1039 sub activate_volumes
{
1040 my ($cfg, $vollist, $snapname) = @_;
1042 return if !($vollist && scalar(@$vollist));
1044 my $storagehash = {};
1045 foreach my $volid (@$vollist) {
1046 my ($storeid, undef) = parse_volume_id
($volid);
1047 $storagehash->{$storeid} = 1;
1052 activate_storage_list
($cfg, [keys %$storagehash], $cache);
1054 foreach my $volid (@$vollist) {
1055 my ($storeid, $volname) = parse_volume_id
($volid);
1056 my $scfg = storage_config
($cfg, $storeid);
1057 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1058 $plugin->activate_volume($storeid, $scfg, $volname, $snapname, $cache);
1062 sub deactivate_volumes
{
1063 my ($cfg, $vollist, $snapname) = @_;
1065 return if !($vollist && scalar(@$vollist));
1070 foreach my $volid (@$vollist) {
1071 my ($storeid, $volname) = parse_volume_id
($volid);
1073 my $scfg = storage_config
($cfg, $storeid);
1074 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1077 $plugin->deactivate_volume($storeid, $scfg, $volname, $snapname, $cache);
1081 push @errlist, $volid;
1085 die "volume deactivation failed: " . join(' ', @errlist)
1086 if scalar(@errlist);
1090 my ($cfg, $content, $includeformat) = @_;
1092 my $ids = $cfg->{ids
};
1096 my @ctypes = PVE
::Tools
::split_list
($content);
1099 foreach my $storeid (keys %$ids) {
1100 my $storage_enabled = defined(storage_check_enabled
($cfg, $storeid, undef, 1));
1102 if (defined($content)) {
1104 foreach my $ctype (@ctypes) {
1105 if ($ids->{$storeid}->{content
}->{$ctype}) {
1110 next if !$want_ctype || !$storage_enabled;
1113 my $type = $ids->{$storeid}->{type
};
1115 $info->{$storeid} = {
1120 shared
=> $ids->{$storeid}->{shared
} ?
1 : 0,
1121 content
=> PVE
::Storage
::Plugin
::content_hash_to_string
($ids->{$storeid}->{content
}),
1123 enabled
=> $storage_enabled ?
1 : 0,
1126 push @$slist, $storeid;
1131 foreach my $storeid (keys %$ids) {
1132 my $scfg = $ids->{$storeid};
1134 next if !$info->{$storeid};
1135 next if !$info->{$storeid}->{enabled
};
1137 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1138 if ($includeformat) {
1139 my $pd = $plugin->plugindata();
1140 $info->{$storeid}->{format
} = $pd->{format
}
1142 $info->{$storeid}->{select_existing
} = $pd->{select_existing
}
1143 if $pd->{select_existing
};
1146 eval { activate_storage
($cfg, $storeid, $cache); };
1152 my ($total, $avail, $used, $active) = eval { $plugin->status($storeid, $scfg, $cache); };
1155 $info->{$storeid}->{total
} = int($total);
1156 $info->{$storeid}->{avail
} = int($avail);
1157 $info->{$storeid}->{used
} = int($used);
1158 $info->{$storeid}->{active
} = $active;
1167 my ($packed_ip, $family);
1169 my @res = PVE
::Tools
::getaddrinfo_all
($server);
1170 $family = $res[0]->{family
};
1171 $packed_ip = (PVE
::Tools
::unpack_sockaddr_in46
($res[0]->{addr
}))[2];
1173 if (defined $packed_ip) {
1174 return Socket
::inet_ntop
($family, $packed_ip);
1180 my ($server_in) = @_;
1183 if (!($server = resolv_server
($server_in))) {
1184 die "unable to resolve address for server '${server_in}'\n";
1187 my $cmd = ['/sbin/showmount', '--no-headers', '--exports', $server];
1190 run_command
($cmd, outfunc
=> sub {
1193 # note: howto handle white spaces in export path??
1194 if ($line =~ m!^(/\S+)\s+(.+)$!) {
1203 my ($server_in, $user, $password, $domain) = @_;
1206 if (!($server = resolv_server
($server_in))) {
1207 die "unable to resolve address for server '${server_in}'\n";
1210 # we support only Windows grater than 2012 cifsscan so use smb3
1211 my $cmd = ['/usr/bin/smbclient', '-m', 'smb3', '-d', '0', '-L', $server];
1212 if (defined($user)) {
1213 die "password is required" if !defined($password);
1214 push @$cmd, '-U', "$user\%$password";
1215 push @$cmd, '-W', $domain if defined($domain);
1224 if ($line =~ m/(\S+)\s*Disk\s*(\S*)/) {
1226 } elsif ($line =~ m/(NT_STATUS_(\S*))/) {
1239 my $cmd = ['zfs', 'list', '-t', 'filesystem', '-H', '-o', 'name,avail,used'];
1242 run_command
($cmd, outfunc
=> sub {
1245 if ($line =~m/^(\S+)\s+(\S+)\s+(\S+)$/) {
1246 my ($pool, $size_str, $used_str) = ($1, $2, $3);
1247 my $size = PVE
::Storage
::ZFSPoolPlugin
::zfs_parse_size
($size_str);
1248 my $used = PVE
::Storage
::ZFSPoolPlugin
::zfs_parse_size
($used_str);
1249 # ignore subvolumes generated by our ZFSPoolPlugin
1250 return if $pool =~ m!/subvol-\d+-[^/]+$!;
1251 return if $pool =~ m!/basevol-\d+-[^/]+$!;
1252 push @$res, { pool
=> $pool, size
=> $size, free
=> $size-$used };
1260 my ($portal, $noerr) = @_;
1262 my ($server, $port) = PVE
::Tools
::parse_host_and_port
($portal);
1264 if (my $ip = resolv_server
($server)) {
1266 $server = "[$server]" if $server =~ /^$IPV6RE$/;
1267 return $port ?
"$server:$port" : $server;
1270 return undef if $noerr;
1272 raise_param_exc
({ portal
=> "unable to resolve portal address '$portal'" });
1277 my ($portal_in) = @_;
1280 if (!($portal = resolv_portal
($portal_in))) {
1281 die "unable to parse/resolve portal address '${portal_in}'\n";
1284 return PVE
::Storage
::ISCSIPlugin
::iscsi_discovery
($portal);
1287 sub storage_default_format
{
1288 my ($cfg, $storeid) = @_;
1290 my $scfg = storage_config
($cfg, $storeid);
1292 return PVE
::Storage
::Plugin
::default_format
($scfg);
1295 sub vgroup_is_used
{
1296 my ($cfg, $vgname) = @_;
1298 foreach my $storeid (keys %{$cfg->{ids
}}) {
1299 my $scfg = storage_config
($cfg, $storeid);
1300 if ($scfg->{type
} eq 'lvm' && $scfg->{vgname
} eq $vgname) {
1308 sub target_is_used
{
1309 my ($cfg, $target) = @_;
1311 foreach my $storeid (keys %{$cfg->{ids
}}) {
1312 my $scfg = storage_config
($cfg, $storeid);
1313 if ($scfg->{type
} eq 'iscsi' && $scfg->{target
} eq $target) {
1321 sub volume_is_used
{
1322 my ($cfg, $volid) = @_;
1324 foreach my $storeid (keys %{$cfg->{ids
}}) {
1325 my $scfg = storage_config
($cfg, $storeid);
1326 if ($scfg->{base
} && $scfg->{base
} eq $volid) {
1334 sub storage_is_used
{
1335 my ($cfg, $storeid) = @_;
1337 foreach my $sid (keys %{$cfg->{ids
}}) {
1338 my $scfg = storage_config
($cfg, $sid);
1339 next if !$scfg->{base
};
1340 my ($st) = parse_volume_id
($scfg->{base
});
1341 return 1 if $st && $st eq $storeid;
1348 my ($list, $func) = @_;
1352 foreach my $sid (keys %$list) {
1353 foreach my $info (@{$list->{$sid}}) {
1354 my $volid = $info->{volid
};
1355 my ($sid1, $volname) = parse_volume_id
($volid, 1);
1356 if ($sid1 && $sid1 eq $sid) {
1357 &$func ($volid, $sid, $info);
1359 warn "detected strange volid '$volid' in volume list for '$sid'\n";
1365 sub extract_vzdump_config_tar
{
1366 my ($archive, $conf_re) = @_;
1368 die "ERROR: file '$archive' does not exist\n" if ! -f
$archive;
1370 my $pid = open(my $fh, '-|', 'tar', 'tf', $archive) ||
1371 die "unable to open file '$archive'\n";
1374 while (defined($file = <$fh>)) {
1375 if ($file =~ $conf_re) {
1376 $file = $1; # untaint
1385 die "ERROR: archive contains no configuration file\n" if !$file;
1391 $raw .= "$output\n";
1394 PVE
::Tools
::run_command
(['tar', '-xpOf', $archive, $file, '--occurrence'], outfunc
=> $out);
1396 return wantarray ?
($raw, $file) : $raw;
1399 sub extract_vzdump_config_vma
{
1400 my ($archive, $comp) = @_;
1406 $raw .= "$output\n";
1412 if ($comp eq 'gz') {
1413 $uncomp = ["zcat", $archive];
1414 } elsif ($comp eq 'lzo') {
1415 $uncomp = ["lzop", "-d", "-c", $archive];
1417 die "unknown compression method '$comp'\n";
1419 $cmd = [$uncomp, ["vma", "config", "-"]];
1421 # in some cases, lzop/zcat exits with 1 when its stdout pipe is
1422 # closed early by vma, detect this and ignore the exit code later
1427 if ($output =~ m/lzop: Broken pipe: <stdout>/ || $output =~ m/gzip: stdout: Broken pipe/) {
1429 } elsif (!defined ($errstring) && $output !~ m/^\s*$/) {
1430 $errstring = "Failed to extract config from VMA archive: $output\n";
1434 # in other cases, the pipeline will exit with exit code 141
1435 # because of the broken pipe, handle / ignore this as well
1438 $rc = PVE
::Tools
::run_command
($cmd, outfunc
=> $out, errfunc
=> $err, noerr
=> 1);
1442 # use exit code if no stderr output and not just broken pipe
1443 if (!$errstring && !$broken_pipe && $rc != 0 && $rc != 141) {
1444 die "$rerr\n" if $rerr;
1445 die "config extraction failed with exit code $rc\n";
1447 die "$errstring\n" if $errstring;
1449 # simple case without compression and weird piping behaviour
1450 PVE
::Tools
::run_command
(["vma", "config", $archive], outfunc
=> $out);
1453 return wantarray ?
($raw, undef) : $raw;
1456 sub extract_vzdump_config
{
1457 my ($cfg, $volid) = @_;
1459 my $archive = abs_filesystem_path
($cfg, $volid);
1461 if ($volid =~ /vzdump-(lxc|openvz)-\d+-(\d{4})_(\d{2})_(\d{2})-(\d{2})_(\d{2})_(\d{2})\.(tgz|(tar(\.(gz|lzo))?))$/) {
1462 return extract_vzdump_config_tar
($archive, qr!^(\./etc/vzdump/(pct|vps)\.conf)$!);
1463 } elsif ($volid =~ /vzdump-qemu-\d+-(\d{4})_(\d{2})_(\d{2})-(\d{2})_(\d{2})_(\d{2})\.(tgz|((tar|vma)(\.(gz|lzo))?))$/) {
1471 $comp = $11 if defined($11);
1474 if ($format eq 'tar') {
1475 return extract_vzdump_config_tar
($archive, qr!\(\./qemu-server\.conf\)!);
1477 return extract_vzdump_config_vma
($archive, $comp);
1480 die "cannot determine backup guest type for backup archive '$volid'\n";
1485 my ($cfg, $fh, $volid, $format, $snapshot, $base_snapshot, $with_snapshots) = @_;
1487 my ($storeid, $volname) = parse_volume_id
($volid, 1);
1488 die "cannot export volume '$volid'\n" if !$storeid;
1489 my $scfg = storage_config
($cfg, $storeid);
1490 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1491 return $plugin->volume_export($scfg, $storeid, $fh, $volname, $format,
1492 $snapshot, $base_snapshot, $with_snapshots);
1496 my ($cfg, $fh, $volid, $format, $base_snapshot, $with_snapshots) = @_;
1498 my ($storeid, $volname) = parse_volume_id
($volid, 1);
1499 die "cannot import into volume '$volid'\n" if !$storeid;
1500 my $scfg = storage_config
($cfg, $storeid);
1501 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1502 return $plugin->volume_import($scfg, $storeid, $fh, $volname, $format,
1503 $base_snapshot, $with_snapshots);
1506 sub volume_export_formats
{
1507 my ($cfg, $volid, $snapshot, $base_snapshot, $with_snapshots) = @_;
1509 my ($storeid, $volname) = parse_volume_id
($volid, 1);
1510 return if !$storeid;
1511 my $scfg = storage_config
($cfg, $storeid);
1512 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1513 return $plugin->volume_export_formats($scfg, $storeid, $volname,
1514 $snapshot, $base_snapshot,
1518 sub volume_import_formats
{
1519 my ($cfg, $volid, $base_snapshot, $with_snapshots) = @_;
1521 my ($storeid, $volname) = parse_volume_id
($volid, 1);
1522 return if !$storeid;
1523 my $scfg = storage_config
($cfg, $storeid);
1524 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1525 return $plugin->volume_import_formats($scfg, $storeid, $volname,
1526 $base_snapshot, $with_snapshots);
1529 sub volume_transfer_formats
{
1530 my ($cfg, $src_volid, $dst_volid, $snapshot, $base_snapshot, $with_snapshots) = @_;
1531 my @export_formats = volume_export_formats
($cfg, $src_volid, $snapshot, $base_snapshot, $with_snapshots);
1532 my @import_formats = volume_import_formats
($cfg, $dst_volid, $base_snapshot, $with_snapshots);
1533 my %import_hash = map { $_ => 1 } @import_formats;
1534 my @common = grep { $import_hash{$_} } @export_formats;
1538 # bash completion helper
1540 sub complete_storage
{
1541 my ($cmdname, $pname, $cvalue) = @_;
1543 my $cfg = PVE
::Storage
::config
();
1545 return $cmdname eq 'add' ?
[] : [ PVE
::Storage
::storage_ids
($cfg) ];
1548 sub complete_storage_enabled
{
1549 my ($cmdname, $pname, $cvalue) = @_;
1553 my $cfg = PVE
::Storage
::config
();
1554 foreach my $sid (keys %{$cfg->{ids
}}) {
1555 next if !storage_check_enabled
($cfg, $sid, undef, 1);
1561 sub complete_content_type
{
1562 my ($cmdname, $pname, $cvalue) = @_;
1564 return [qw(rootdir images vztmpl iso backup snippets)];
1567 sub complete_volume
{
1568 my ($cmdname, $pname, $cvalue) = @_;
1572 my $storage_list = complete_storage_enabled
();
1574 if ($cvalue =~ m/^([^:]+):/) {
1575 $storage_list = [ $1 ];
1577 if (scalar(@$storage_list) > 1) {
1578 # only list storage IDs to avoid large listings
1580 foreach my $storeid (@$storage_list) {
1581 # Hack: simply return 2 artificial values, so that
1582 # completions does not finish
1583 push @$res, "$storeid:volname", "$storeid:...";
1590 foreach my $storeid (@$storage_list) {
1591 my $vollist = PVE
::Storage
::volume_list
($cfg, $storeid);
1593 foreach my $item (@$vollist) {
1594 push @$res, $item->{volid
};
1601 # Various io-heavy operations require io/bandwidth limits which can be
1602 # configured on multiple levels: The global defaults in datacenter.cfg, and
1603 # per-storage overrides. When we want to do a restore from storage A to storage
1604 # B, we should take the smaller limit defined for storages A and B, and if no
1605 # such limit was specified, use the one from datacenter.cfg.
1606 sub get_bandwidth_limit
{
1607 my ($operation, $storage_list, $override) = @_;
1609 # called for each limit (global, per-storage) with the 'default' and the
1610 # $operation limit and should udpate $override for every limit affecting
1612 my $use_global_limits = 0;
1613 my $apply_limit = sub {
1615 if (defined($bwlimit)) {
1616 my $limits = PVE
::JSONSchema
::parse_property_string
('bwlimit', $bwlimit);
1617 my $limit = $limits->{$operation} // $limits->{default};
1618 if (defined($limit)) {
1619 if (!$override || $limit < $override) {
1625 # If there was no applicable limit, try to apply the global ones.
1626 $use_global_limits = 1;
1629 my ($rpcenv, $authuser);
1630 if (defined($override)) {
1631 $rpcenv = PVE
::RPCEnvironment-
>get();
1632 $authuser = $rpcenv->get_user();
1635 # Apply per-storage limits - if there are storages involved.
1636 if (defined($storage_list) && @$storage_list) {
1637 my $config = config
();
1639 # The Datastore.Allocate permission allows us to modify the per-storage
1640 # limits, therefore it also allows us to override them.
1641 # Since we have most likely multiple storages to check, do a quick check on
1642 # the general '/storage' path to see if we can skip the checks entirely:
1643 return $override if $rpcenv && $rpcenv->check($authuser, '/storage', ['Datastore.Allocate'], 1);
1646 foreach my $storage (@$storage_list) {
1647 next if !defined($storage);
1648 # Avoid duplicate checks:
1649 next if $done{$storage};
1650 $done{$storage} = 1;
1652 # Otherwise we may still have individual /storage/$ID permissions:
1653 if (!$rpcenv || !$rpcenv->check($authuser, "/storage/$storage", ['Datastore.Allocate'], 1)) {
1654 # And if not: apply the limits.
1655 my $storecfg = storage_config
($config, $storage);
1656 $apply_limit->($storecfg->{bwlimit
});
1660 # Storage limits take precedence over the datacenter defaults, so if
1661 # a limit was applied:
1662 return $override if !$use_global_limits;
1665 # Sys.Modify on '/' means we can change datacenter.cfg which contains the
1666 # global default limits.
1667 if (!$rpcenv || !$rpcenv->check($authuser, '/', ['Sys.Modify'], 1)) {
1668 # So if we cannot modify global limits, apply them to our currently
1669 # requested override.
1670 my $dc = cfs_read_file
('datacenter.cfg');
1671 $apply_limit->($dc->{bwlimit
});
1677 # checks if the storage id is available and dies if not
1678 sub assert_sid_unused
{
1682 if (my $scfg = storage_config
($cfg, $sid, 1)) {
1683 die "storage ID '$sid' already defined\n";