15 use PVE
::Tools
qw(run_command file_read_firstline dir_glob_foreach $IPV6RE);
16 use PVE
::Cluster
qw(cfs_read_file cfs_write_file cfs_lock_file);
17 use PVE
::Exception
qw(raise_param_exc);
20 use PVE
::RPCEnvironment
;
22 use PVE
::Storage
::Plugin
;
23 use PVE
::Storage
::DirPlugin
;
24 use PVE
::Storage
::LVMPlugin
;
25 use PVE
::Storage
::LvmThinPlugin
;
26 use PVE
::Storage
::NFSPlugin
;
27 use PVE
::Storage
::ISCSIPlugin
;
28 use PVE
::Storage
::RBDPlugin
;
29 use PVE
::Storage
::SheepdogPlugin
;
30 use PVE
::Storage
::ISCSIDirectPlugin
;
31 use PVE
::Storage
::GlusterfsPlugin
;
32 use PVE
::Storage
::ZFSPoolPlugin
;
33 use PVE
::Storage
::ZFSPlugin
;
34 use PVE
::Storage
::DRBDPlugin
;
36 # Storage API version. Icrement it on changes in storage API interface.
37 use constant APIVER
=> 1;
39 # load standard plugins
40 PVE
::Storage
::DirPlugin-
>register();
41 PVE
::Storage
::LVMPlugin-
>register();
42 PVE
::Storage
::LvmThinPlugin-
>register();
43 PVE
::Storage
::NFSPlugin-
>register();
44 PVE
::Storage
::ISCSIPlugin-
>register();
45 PVE
::Storage
::RBDPlugin-
>register();
46 PVE
::Storage
::SheepdogPlugin-
>register();
47 PVE
::Storage
::ISCSIDirectPlugin-
>register();
48 PVE
::Storage
::GlusterfsPlugin-
>register();
49 PVE
::Storage
::ZFSPoolPlugin-
>register();
50 PVE
::Storage
::ZFSPlugin-
>register();
51 PVE
::Storage
::DRBDPlugin-
>register();
53 # load third-party plugins
54 if ( -d
'/usr/share/perl5/PVE/Storage/Custom' ) {
55 dir_glob_foreach
('/usr/share/perl5/PVE/Storage/Custom', '.*\.pm$', sub {
57 my $modname = 'PVE::Storage::Custom::' . $file;
58 $modname =~ s!\.pm$!!;
59 $file = 'PVE/Storage/Custom/' . $file;
66 # Check storage API version and that file is really storage plugin.
67 } elsif ($modname->isa('PVE::Storage::Plugin') && $modname->can('api') && $modname->api() == APIVER
) {
74 warn "Error loading storage plugin \"$modname\" because of API version mismatch
. Please
, update it
.\n"
79 # initialize all plugins
80 PVE::Storage::Plugin->init();
82 my $UDEVADM = '/sbin/udevadm';
84 # PVE::Storage utility functions
87 return cfs_read_file("storage
.cfg
");
93 cfs_write_file('storage.cfg', $cfg);
96 sub lock_storage_config {
97 my ($code, $errmsg) = @_;
99 cfs_lock_file("storage
.cfg
", undef, $code);
102 $errmsg ? die "$errmsg: $err" : die $err;
107 my ($cfg, $storeid, $noerr) = @_;
109 die "no storage ID specified
\n" if !$storeid;
111 my $scfg = $cfg->{ids}->{$storeid};
113 die "storage
'$storeid' does not exists\n" if (!$noerr && !$scfg);
118 sub storage_check_node {
119 my ($cfg, $storeid, $node, $noerr) = @_;
121 my $scfg = storage_config($cfg, $storeid);
123 if ($scfg->{nodes}) {
124 $node = PVE::INotify::nodename() if !$node || ($node eq 'localhost');
125 if (!$scfg->{nodes}->{$node}) {
126 die "storage
'$storeid' is not available on node
'$node'\n" if !$noerr;
134 sub storage_check_enabled {
135 my ($cfg, $storeid, $node, $noerr) = @_;
137 my $scfg = storage_config($cfg, $storeid);
139 if ($scfg->{disable}) {
140 die "storage
'$storeid' is disabled
\n" if !$noerr;
144 return storage_check_node($cfg, $storeid, $node, $noerr);
150 return keys %{$cfg->{ids}};
154 my ($filename, $timeout) = @_;
156 return PVE::Storage::Plugin::file_size_info($filename, $timeout);
159 sub volume_size_info {
160 my ($cfg, $volid, $timeout) = @_;
162 my ($storeid, $volname) = parse_volume_id($volid, 1);
164 my $scfg = storage_config($cfg, $storeid);
165 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
166 return $plugin->volume_size_info($scfg, $storeid, $volname, $timeout);
167 } elsif ($volid =~ m|^(/.+)$| && -e $volid) {
168 return file_size_info($volid, $timeout);
175 my ($cfg, $volid, $size, $running) = @_;
177 my ($storeid, $volname) = parse_volume_id($volid, 1);
179 my $scfg = storage_config($cfg, $storeid);
180 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
181 return $plugin->volume_resize($scfg, $storeid, $volname, $size, $running);
182 } elsif ($volid =~ m|^(/.+)$| && -e $volid) {
183 die "resize file
/device
'$volid' is not possible
\n";
185 die "unable to parse volume ID
'$volid'\n";
189 sub volume_rollback_is_possible {
190 my ($cfg, $volid, $snap) = @_;
192 my ($storeid, $volname) = parse_volume_id($volid, 1);
194 my $scfg = storage_config($cfg, $storeid);
195 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
196 return $plugin->volume_rollback_is_possible($scfg, $storeid, $volname, $snap);
197 } elsif ($volid =~ m|^(/.+)$| && -e $volid) {
198 die "snapshot rollback file
/device
'$volid' is not possible
\n";
200 die "unable to parse volume ID
'$volid'\n";
204 sub volume_snapshot {
205 my ($cfg, $volid, $snap) = @_;
207 my ($storeid, $volname) = parse_volume_id($volid, 1);
209 my $scfg = storage_config($cfg, $storeid);
210 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
211 return $plugin->volume_snapshot($scfg, $storeid, $volname, $snap);
212 } elsif ($volid =~ m|^(/.+)$| && -e $volid) {
213 die "snapshot file
/device
'$volid' is not possible
\n";
215 die "unable to parse volume ID
'$volid'\n";
219 sub volume_snapshot_rollback {
220 my ($cfg, $volid, $snap) = @_;
222 my ($storeid, $volname) = parse_volume_id($volid, 1);
224 my $scfg = storage_config($cfg, $storeid);
225 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
226 $plugin->volume_rollback_is_possible($scfg, $storeid, $volname, $snap);
227 return $plugin->volume_snapshot_rollback($scfg, $storeid, $volname, $snap);
228 } elsif ($volid =~ m|^(/.+)$| && -e $volid) {
229 die "snapshot rollback file
/device
'$volid' is not possible
\n";
231 die "unable to parse volume ID
'$volid'\n";
235 sub volume_snapshot_delete {
236 my ($cfg, $volid, $snap, $running) = @_;
238 my ($storeid, $volname) = parse_volume_id($volid, 1);
240 my $scfg = storage_config($cfg, $storeid);
241 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
242 return $plugin->volume_snapshot_delete($scfg, $storeid, $volname, $snap, $running);
243 } elsif ($volid =~ m|^(/.+)$| && -e $volid) {
244 die "snapshot
delete file
/device
'$volid' is not possible
\n";
246 die "unable to parse volume ID
'$volid'\n";
250 sub volume_has_feature {
251 my ($cfg, $feature, $volid, $snap, $running) = @_;
253 my ($storeid, $volname) = parse_volume_id($volid, 1);
255 my $scfg = storage_config($cfg, $storeid);
256 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
257 return $plugin->volume_has_feature($scfg, $feature, $storeid, $volname, $snap, $running);
258 } elsif ($volid =~ m|^(/.+)$| && -e $volid) {
265 sub volume_snapshot_list {
266 my ($cfg, $volid, $prefix) = @_;
268 my ($storeid, $volname) = parse_volume_id($volid, 1);
270 my $scfg = storage_config($cfg, $storeid);
271 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
272 return $plugin->volume_snapshot_list($scfg, $storeid, $volname, $prefix);
273 } elsif ($volid =~ m|^(/.+)$| && -e $volid) {
274 die "send file
/device
'$volid' is not possible
\n";
276 die "unable to parse volume ID
'$volid'\n";
278 # return an empty array if dataset does not exist.
279 # youngest snap first
283 my ($cfg, $storeid, $vmid) = @_;
285 my $scfg = storage_config($cfg, $storeid);
286 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
288 my $path = $plugin->get_subdir($scfg, 'images');
290 return $vmid ? "$path/$vmid" : $path;
293 sub get_private_dir {
294 my ($cfg, $storeid, $vmid) = @_;
296 my $scfg = storage_config($cfg, $storeid);
297 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
299 my $path = $plugin->get_subdir($scfg, 'rootdir');
301 return $vmid ? "$path/$vmid" : $path;
305 my ($cfg, $storeid) = @_;
307 my $scfg = storage_config($cfg, $storeid);
308 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
310 return $plugin->get_subdir($scfg, 'iso');
314 my ($cfg, $storeid) = @_;
316 my $scfg = storage_config($cfg, $storeid);
317 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
319 return $plugin->get_subdir($scfg, 'vztmpl');
323 my ($cfg, $storeid) = @_;
325 my $scfg = storage_config($cfg, $storeid);
326 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
328 return $plugin->get_subdir($scfg, 'backup');
331 # library implementation
336 die "VMID
'$vmid' contains illegal characters
\n" if $vmid !~ m/^\d+$/;
341 # NOTE: basename and basevmid are always undef for LVM-thin, where the
342 # clone -> base reference is not encoded in the volume ID.
343 # see note in PVE::Storage::LvmThinPlugin for details.
345 my ($cfg, $volid) = @_;
347 my ($storeid, $volname) = parse_volume_id($volid);
349 my $scfg = storage_config($cfg, $storeid);
351 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
353 # returns ($vtype, $name, $vmid, $basename, $basevmid, $isBase, $format)
355 return $plugin->parse_volname($volname);
358 sub parse_volume_id {
359 my ($volid, $noerr) = @_;
361 return PVE::Storage::Plugin::parse_volume_id($volid, $noerr);
364 # test if we have read access to volid
365 sub check_volume_access {
366 my ($rpcenv, $user, $cfg, $vmid, $volid) = @_;
368 my ($sid, $volname) = parse_volume_id($volid, 1);
370 my ($vtype, undef, $ownervm) = parse_volname($cfg, $volid);
371 if ($vtype eq 'iso' || $vtype eq 'vztmpl') {
372 # we simply allow access
373 } elsif (defined($ownervm) && defined($vmid) && ($ownervm == $vmid)) {
374 # we are owner - allow access
375 } elsif ($vtype eq 'backup' && $ownervm) {
376 $rpcenv->check($user, "/storage/$sid", ['Datastore.AllocateSpace']);
377 $rpcenv->check($user, "/vms/$ownervm", ['VM.Backup']);
379 # allow if we are Datastore administrator
380 $rpcenv->check($user, "/storage/$sid", ['Datastore.Allocate']);
383 die "Only root can pass arbitrary filesystem paths
."
384 if $user ne 'root@pam';
390 my $volume_is_base_and_used__no_lock = sub {
391 my ($scfg, $storeid, $plugin, $volname) = @_;
393 my ($vtype, $name, $vmid, undef, undef, $isBase, undef) =
394 $plugin->parse_volname($volname);
397 my $vollist = $plugin->list_images($storeid, $scfg);
398 foreach my $info (@$vollist) {
399 my (undef, $tmpvolname) = parse_volume_id($info->{volid});
400 my $basename = undef;
401 my $basevmid = undef;
404 (undef, undef, undef, $basename, $basevmid) =
405 $plugin->parse_volname($tmpvolname);
408 if ($basename && defined($basevmid) && $basevmid == $vmid && $basename eq $name) {
416 # NOTE: this check does not work for LVM-thin, where the clone -> base
417 # reference is not encoded in the volume ID.
418 # see note in PVE::Storage::LvmThinPlugin for details.
419 sub volume_is_base_and_used {
420 my ($cfg, $volid) = @_;
422 my ($storeid, $volname) = parse_volume_id($volid);
423 my $scfg = storage_config($cfg, $storeid);
424 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
426 $plugin->cluster_lock_storage($storeid, $scfg->{shared}, undef, sub {
427 return &$volume_is_base_and_used__no_lock($scfg, $storeid, $plugin, $volname);
431 # try to map a filesystem path to a volume identifier
432 sub path_to_volume_id {
433 my ($cfg, $path) = @_;
435 my $ids = $cfg->{ids};
437 my ($sid, $volname) = parse_volume_id($path, 1);
439 if (my $scfg = $ids->{$sid}) {
441 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
442 my ($vtype, $name, $vmid) = $plugin->parse_volname($volname);
443 return ($vtype, $path);
449 # Note: abs_path() return undef if $path doesn not exist
450 # for example when nfs storage is not mounted
451 $path = abs_path($path) || $path;
453 foreach my $sid (keys %$ids) {
454 my $scfg = $ids->{$sid};
455 next if !$scfg->{path};
456 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
457 my $imagedir = $plugin->get_subdir($scfg, 'images');
458 my $isodir = $plugin->get_subdir($scfg, 'iso');
459 my $tmpldir = $plugin->get_subdir($scfg, 'vztmpl');
460 my $backupdir = $plugin->get_subdir($scfg, 'backup');
461 my $privatedir = $plugin->get_subdir($scfg, 'rootdir');
463 if ($path =~ m!^$imagedir/(\d+)/([^/\s]+)$!) {
467 my $vollist = $plugin->list_images($sid, $scfg, $vmid);
468 foreach my $info (@$vollist) {
469 my ($storeid, $volname) = parse_volume_id($info->{volid});
470 my $volpath = $plugin->path($scfg, $volname, $storeid);
471 if ($volpath eq $path) {
472 return ('images', $info->{volid});
475 } elsif ($path =~ m!^$isodir/([^/]+\.[Ii][Ss][Oo])$!) {
477 return ('iso', "$sid:iso
/$name");
478 } elsif ($path =~ m!^$tmpldir/([^/]+\.tar\.gz)$!) {
480 return ('vztmpl', "$sid:vztmpl
/$name");
481 } elsif ($path =~ m!^$privatedir/(\d+)$!) {
483 return ('rootdir', "$sid:rootdir
/$vmid");
484 } elsif ($path =~ m!^$backupdir/([^/]+\.(tar|tar\.gz|tar\.lzo|tgz|vma|vma\.gz|vma\.lzo))$!) {
486 return ('iso', "$sid:backup
/$name");
490 # can't map path to volume id
495 my ($cfg, $volid, $snapname) = @_;
497 my ($storeid, $volname) = parse_volume_id($volid);
499 my $scfg = storage_config($cfg, $storeid);
501 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
502 my ($path, $owner, $vtype) = $plugin->path($scfg, $volname, $storeid, $snapname);
503 return wantarray ? ($path, $owner, $vtype) : $path;
506 sub abs_filesystem_path {
507 my ($cfg, $volid) = @_;
510 if (PVE::Storage::parse_volume_id ($volid, 1)) {
511 PVE::Storage::activate_volumes($cfg, [ $volid ]);
512 $path = PVE::Storage::path($cfg, $volid);
515 my $abspath = abs_path($volid);
516 if ($abspath && $abspath =~ m|^(/.+)$|) {
517 $path = $1; # untaint any path
522 die "can
't find file '$volid'\n" if !($path && -f $path);
527 sub storage_migrate {
528 my ($cfg, $volid, $target_host, $target_storeid, $target_volname, $base_snapshot) = @_;
530 my ($storeid, $volname) = parse_volume_id($volid);
531 $target_volname = $volname if !$target_volname;
533 my $scfg = storage_config($cfg, $storeid);
535 # no need to migrate shared content
536 return if $storeid eq $target_storeid && $scfg->{shared};
538 my $tcfg = storage_config($cfg, $target_storeid);
540 my $target_volid = "${target_storeid}:${target_volname}";
542 my $errstr = "unable to migrate '$volid' to '${target_volid
}' on host '$target_host'";
544 my $sshoptions = "-o 'BatchMode
=yes
'";
545 my $ssh = "/usr/bin/ssh $sshoptions";
547 local $ENV{RSYNC_RSH} = $ssh;
549 my $no_incremental = sub {
551 die "incremental migration not supported on storage type $type\n"
552 if defined($base_snapshot);
555 # only implemented for file system based storage
557 $no_incremental->($scfg->{type});
560 my $src_plugin = PVE::Storage::Plugin->lookup($scfg->{type});
561 my $dst_plugin = PVE::Storage::Plugin->lookup($tcfg->{type});
562 my $src = $src_plugin->path($scfg, $volname, $storeid);
563 my $dst = $dst_plugin->path($tcfg, $target_volname, $target_storeid);
565 my $dirname = dirname($dst);
567 if ($tcfg->{shared}) { # we can do a local copy
569 run_command(['/bin/mkdir
', '-p
', $dirname]);
571 run_command(['/bin/cp', $src, $dst]);
574 run_command(['/usr/bin
/ssh
', "root\@${target_host}",
575 '/bin/mkdir
', '-p
', $dirname]);
577 # we use rsync with --sparse, so we can't
use --inplace
,
578 # so we remove file on the target if it already exists to
580 my ($size, $format) = PVE
::Storage
::Plugin
::file_size_info
($src);
581 if ($format && ($format eq 'raw') && $size) {
582 run_command
(['/usr/bin/ssh', "root\@${target_host}",
588 if ($format eq 'subvol') {
589 $cmd = ['/usr/bin/rsync', '--progress', '-X', '-A', '--numeric-ids',
590 '-aH', '--delete', '--no-whole-file', '--inplace',
591 '--one-file-system', "$src/", "[root\@${target_host}]:$dst"];
593 $cmd = ['/usr/bin/rsync', '--progress', '--sparse', '--whole-file',
594 $src, "[root\@${target_host}]:$dst"];
599 run_command
($cmd, outfunc
=> sub {
602 if ($line =~ m/^\s*(\d+\s+(\d+)%\s.*)$/) {
605 print "rsync status: $1\n";
615 die "$errstr - target type '$tcfg->{type}' not implemented\n";
618 } elsif ($scfg->{type
} eq 'zfspool') {
620 if ($tcfg->{type
} eq 'zfspool') {
622 die "$errstr - pool on target does not have the same name as on source!"
623 if $tcfg->{pool
} ne $scfg->{pool
};
625 my (undef, $volname) = parse_volname
($cfg, $volid);
626 my $zfspath = "$scfg->{pool}\/$volname";
628 my @formats = volume_transfer_formats
($cfg, $volid, $volid, '__migration__', $base_snapshot, 1);
629 die "cannot migrate from storage type '$scfg->{type}' to '$tcfg->{type}'\n" if !@formats;
630 my $format = $formats[0];
632 my $send = ['pvesm', 'export', $volid, $format, '-', '-snapshot', '__migration__', '-with-snapshots', '1'];
633 my $recv = ['ssh', "root\@$target_host", '--', 'pvesm', 'import', $volid, $format, '-', '-with-snapshots', '1'];
634 my $free = ['ssh', "root\@$target_host", '--', 'pvesm', 'free', $volid, '-snapshot', '__migration__'];
636 if (defined($base_snapshot)) {
637 # Check if the snapshot exists on the remote side:
638 push @$send, '-base', $base_snapshot;
639 push @$recv, '-base', $base_snapshot;
642 volume_snapshot
($cfg, $volid, '__migration__');
644 run_command
([$send, $recv]);
647 warn "send/receive failed, cleaning up snapshot(s)..\n" if $err;
648 eval { volume_snapshot_delete
($cfg, $volid, '__migration__', 0) };
649 warn "could not remove source snapshot: $@\n" if $@;
650 eval { run_command
($free) };
651 warn "could not remove target snapshot: $@\n" if $@;
654 die "$errstr - target type $tcfg->{type} is not valid\n";
657 } elsif ($scfg->{type
} eq 'lvmthin' || $scfg->{type
} eq 'lvm') {
658 $no_incremental->($scfg->{type
});
660 if (($scfg->{type
} eq $tcfg->{type
}) &&
661 ($tcfg->{type
} eq 'lvmthin' || $tcfg->{type
} eq 'lvm')) {
663 my (undef, $volname, $vmid) = parse_volname
($cfg, $volid);
664 my $size = volume_size_info
($cfg, $volid, 5);
665 my $src = path
($cfg, $volid);
666 my $dst = path
($cfg, $target_volid);
668 run_command
(['/usr/bin/ssh', "root\@${target_host}",
669 'pvesm', 'alloc', $target_storeid, $vmid,
670 $target_volname, int($size/1024)]);
673 if ($tcfg->{type
} eq 'lvmthin') {
674 run_command
([["dd", "if=$src", "bs=4k"],["/usr/bin/ssh", "root\@${target_host}",
675 "dd", 'conv=sparse', "of=$dst", "bs=4k"]]);
677 run_command
([["dd", "if=$src", "bs=4k"],["/usr/bin/ssh", "root\@${target_host}",
678 "dd", "of=$dst", "bs=4k"]]);
682 run_command
(['/usr/bin/ssh', "root\@${target_host}",
683 'pvesm', 'free', $target_volid]);
687 die "$errstr - migrate from source type '$scfg->{type}' to '$tcfg->{type}' not implemented\n";
690 die "$errstr - source type '$scfg->{type}' not implemented\n";
695 my ($cfg, $volid, $vmid, $snap) = @_;
697 my ($storeid, $volname) = parse_volume_id
($volid);
699 my $scfg = storage_config
($cfg, $storeid);
701 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
703 activate_storage
($cfg, $storeid);
705 # lock shared storage
706 return $plugin->cluster_lock_storage($storeid, $scfg->{shared
}, undef, sub {
707 my $volname = $plugin->clone_image($scfg, $storeid, $volname, $vmid, $snap);
708 return "$storeid:$volname";
712 sub vdisk_create_base
{
713 my ($cfg, $volid) = @_;
715 my ($storeid, $volname) = parse_volume_id
($volid);
717 my $scfg = storage_config
($cfg, $storeid);
719 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
721 activate_storage
($cfg, $storeid);
723 # lock shared storage
724 return $plugin->cluster_lock_storage($storeid, $scfg->{shared
}, undef, sub {
725 my $volname = $plugin->create_base($storeid, $scfg, $volname);
726 return "$storeid:$volname";
731 my ($cfg, $storeid, $vmid, $fmt, $name, $size) = @_;
733 die "no storage ID specified\n" if !$storeid;
735 PVE
::JSONSchema
::parse_storage_id
($storeid);
737 my $scfg = storage_config
($cfg, $storeid);
739 die "no VMID specified\n" if !$vmid;
741 $vmid = parse_vmid
($vmid);
743 my $defformat = PVE
::Storage
::Plugin
::default_format
($scfg);
745 $fmt = $defformat if !$fmt;
747 activate_storage
($cfg, $storeid);
749 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
751 # lock shared storage
752 return $plugin->cluster_lock_storage($storeid, $scfg->{shared
}, undef, sub {
753 my $old_umask = umask(umask|0037);
754 my $volname = eval { $plugin->alloc_image($storeid, $scfg, $vmid, $fmt, $name, $size) };
758 return "$storeid:$volname";
763 my ($cfg, $volid) = @_;
765 my ($storeid, $volname) = parse_volume_id
($volid);
766 my $scfg = storage_config
($cfg, $storeid);
767 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
769 activate_storage
($cfg, $storeid);
773 # lock shared storage
774 $plugin->cluster_lock_storage($storeid, $scfg->{shared
}, undef, sub {
775 # LVM-thin allows deletion of still referenced base volumes!
776 die "base volume '$volname' is still in use by linked clones\n"
777 if &$volume_is_base_and_used__no_lock($scfg, $storeid, $plugin, $volname);
779 my (undef, undef, undef, undef, undef, $isBase, $format) =
780 $plugin->parse_volname($volname);
781 $cleanup_worker = $plugin->free_image($storeid, $scfg, $volname, $isBase, $format);
784 return if !$cleanup_worker;
786 my $rpcenv = PVE
::RPCEnvironment
::get
();
787 my $authuser = $rpcenv->get_user();
789 $rpcenv->fork_worker('imgdel', undef, $authuser, $cleanup_worker);
792 #list iso or openvz template ($tt = <iso|vztmpl|backup>)
794 my ($cfg, $storeid, $tt) = @_;
796 die "unknown template type '$tt'\n"
797 if !($tt eq 'iso' || $tt eq 'vztmpl' || $tt eq 'backup');
799 my $ids = $cfg->{ids
};
801 storage_check_enabled
($cfg, $storeid) if ($storeid);
807 foreach my $sid (keys %$ids) {
808 next if $storeid && $storeid ne $sid;
810 my $scfg = $ids->{$sid};
811 my $type = $scfg->{type
};
813 next if !storage_check_enabled
($cfg, $sid, undef, 1);
815 next if $tt eq 'iso' && !$scfg->{content
}->{iso
};
816 next if $tt eq 'vztmpl' && !$scfg->{content
}->{vztmpl
};
817 next if $tt eq 'backup' && !$scfg->{content
}->{backup
};
819 activate_storage
($cfg, $sid);
822 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
824 my $path = $plugin->get_subdir($scfg, $tt);
826 foreach my $fn (<$path/*>) {
831 next if $fn !~ m!/([^/]+\.[Ii][Ss][Oo])$!;
833 $info = { volid
=> "$sid:iso/$1", format
=> 'iso' };
835 } elsif ($tt eq 'vztmpl') {
836 next if $fn !~ m!/([^/]+\.tar\.([gx]z))$!;
838 $info = { volid
=> "$sid:vztmpl/$1", format
=> "t$2" };
840 } elsif ($tt eq 'backup') {
841 next if $fn !~ m!/([^/]+\.(tar|tar\.gz|tar\.lzo|tgz|vma|vma\.gz|vma\.lzo))$!;
843 $info = { volid
=> "$sid:backup/$1", format
=> $2 };
846 $info->{size
} = -s
$fn;
848 push @{$res->{$sid}}, $info;
853 @{$res->{$sid}} = sort {lc($a->{volid
}) cmp lc ($b->{volid
}) } @{$res->{$sid}} if $res->{$sid};
861 my ($cfg, $storeid, $vmid, $vollist) = @_;
863 my $ids = $cfg->{ids
};
865 storage_check_enabled
($cfg, $storeid) if ($storeid);
869 # prepare/activate/refresh all storages
871 my $storage_list = [];
873 foreach my $volid (@$vollist) {
874 my ($sid, undef) = parse_volume_id
($volid);
875 next if !defined($ids->{$sid});
876 next if !storage_check_enabled
($cfg, $sid, undef, 1);
877 push @$storage_list, $sid;
880 foreach my $sid (keys %$ids) {
881 next if $storeid && $storeid ne $sid;
882 next if !storage_check_enabled
($cfg, $sid, undef, 1);
883 push @$storage_list, $sid;
889 activate_storage_list
($cfg, $storage_list, $cache);
891 foreach my $sid (keys %$ids) {
892 next if $storeid && $storeid ne $sid;
893 next if !storage_check_enabled
($cfg, $sid, undef, 1);
895 my $scfg = $ids->{$sid};
896 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
897 $res->{$sid} = $plugin->list_images($sid, $scfg, $vmid, $vollist, $cache);
898 @{$res->{$sid}} = sort {lc($a->{volid
}) cmp lc ($b->{volid
}) } @{$res->{$sid}} if $res->{$sid};
905 my ($cfg, $storeid, $vmid, $content) = @_;
907 my @ctypes = qw(images vztmpl iso backup);
909 my $cts = $content ?
[ $content ] : [ @ctypes ];
911 my $scfg = PVE
::Storage
::storage_config
($cfg, $storeid);
914 foreach my $ct (@$cts) {
916 if ($ct eq 'images') {
917 $data = vdisk_list
($cfg, $storeid, $vmid);
918 } elsif ($ct eq 'iso' && !defined($vmid)) {
919 $data = template_list
($cfg, $storeid, 'iso');
920 } elsif ($ct eq 'vztmpl'&& !defined($vmid)) {
921 $data = template_list
($cfg, $storeid, 'vztmpl');
922 } elsif ($ct eq 'backup') {
923 $data = template_list
($cfg, $storeid, 'backup');
924 foreach my $item (@{$data->{$storeid}}) {
925 if (defined($vmid)) {
926 @{$data->{$storeid}} = grep { $_->{volid
} =~ m/\S+-$vmid-\S+/ } @{$data->{$storeid}};
931 next if !$data || !$data->{$storeid};
933 foreach my $item (@{$data->{$storeid}}) {
934 $item->{content
} = $ct;
944 my $filename = "/sys/kernel/uevent_seqnum";
947 if (my $fh = IO
::File-
>new($filename, "r")) {
949 if ($line =~ m/^(\d+)$/) {
957 sub activate_storage
{
958 my ($cfg, $storeid, $cache) = @_;
960 $cache = {} if !$cache;
962 my $scfg = storage_check_enabled
($cfg, $storeid);
964 return if $cache->{activated
}->{$storeid};
966 $cache->{uevent_seqnum
} = uevent_seqnum
() if !$cache->{uevent_seqnum
};
968 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
971 my ($baseid, undef) = parse_volume_id
($scfg->{base
});
972 activate_storage
($cfg, $baseid, $cache);
975 if (!$plugin->check_connection($storeid, $scfg)) {
976 die "storage '$storeid' is not online\n";
979 $plugin->activate_storage($storeid, $scfg, $cache);
981 my $newseq = uevent_seqnum
();
983 # only call udevsettle if there are events
984 if ($newseq > $cache->{uevent_seqnum
}) {
986 system ("$UDEVADM settle --timeout=$timeout"); # ignore errors
987 $cache->{uevent_seqnum
} = $newseq;
990 $cache->{activated
}->{$storeid} = 1;
993 sub activate_storage_list
{
994 my ($cfg, $storeid_list, $cache) = @_;
996 $cache = {} if !$cache;
998 foreach my $storeid (@$storeid_list) {
999 activate_storage
($cfg, $storeid, $cache);
1003 sub deactivate_storage
{
1004 my ($cfg, $storeid) = @_;
1006 my $scfg = storage_config
($cfg, $storeid);
1007 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1010 $plugin->deactivate_storage($storeid, $scfg, $cache);
1013 sub activate_volumes
{
1014 my ($cfg, $vollist, $snapname) = @_;
1016 return if !($vollist && scalar(@$vollist));
1018 my $storagehash = {};
1019 foreach my $volid (@$vollist) {
1020 my ($storeid, undef) = parse_volume_id
($volid);
1021 $storagehash->{$storeid} = 1;
1026 activate_storage_list
($cfg, [keys %$storagehash], $cache);
1028 foreach my $volid (@$vollist) {
1029 my ($storeid, $volname) = parse_volume_id
($volid);
1030 my $scfg = storage_config
($cfg, $storeid);
1031 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1032 $plugin->activate_volume($storeid, $scfg, $volname, $snapname, $cache);
1036 sub deactivate_volumes
{
1037 my ($cfg, $vollist, $snapname) = @_;
1039 return if !($vollist && scalar(@$vollist));
1044 foreach my $volid (@$vollist) {
1045 my ($storeid, $volname) = parse_volume_id
($volid);
1047 my $scfg = storage_config
($cfg, $storeid);
1048 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1051 $plugin->deactivate_volume($storeid, $scfg, $volname, $snapname, $cache);
1055 push @errlist, $volid;
1059 die "volume deactivation failed: " . join(' ', @errlist)
1060 if scalar(@errlist);
1064 my ($cfg, $content) = @_;
1066 my $ids = $cfg->{ids
};
1070 my @ctypes = PVE
::Tools
::split_list
($content);
1073 foreach my $storeid (keys %$ids) {
1075 next if !storage_check_enabled
($cfg, $storeid, undef, 1);
1077 if (defined($content)) {
1079 foreach my $ctype (@ctypes) {
1080 if ($ids->{$storeid}->{content
}->{$ctype}) {
1085 next if !$want_ctype;
1088 my $type = $ids->{$storeid}->{type
};
1090 $info->{$storeid} = {
1095 shared
=> $ids->{$storeid}->{shared
} ?
1 : 0,
1096 content
=> PVE
::Storage
::Plugin
::content_hash_to_string
($ids->{$storeid}->{content
}),
1100 push @$slist, $storeid;
1105 foreach my $storeid (keys %$ids) {
1106 my $scfg = $ids->{$storeid};
1107 next if !$info->{$storeid};
1109 eval { activate_storage
($cfg, $storeid, $cache); };
1115 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1116 my ($total, $avail, $used, $active);
1117 eval { ($total, $avail, $used, $active) = $plugin->status($storeid, $scfg, $cache); };
1120 $info->{$storeid}->{total
} = int($total);
1121 $info->{$storeid}->{avail
} = int($avail);
1122 $info->{$storeid}->{used
} = int($used);
1123 $info->{$storeid}->{active
} = $active;
1132 my ($packed_ip, $family);
1134 my @res = PVE
::Tools
::getaddrinfo_all
($server);
1135 $family = $res[0]->{family
};
1136 $packed_ip = (PVE
::Tools
::unpack_sockaddr_in46
($res[0]->{addr
}))[2];
1138 if (defined $packed_ip) {
1139 return Socket
::inet_ntop
($family, $packed_ip);
1145 my ($server_in) = @_;
1148 if (!($server = resolv_server
($server_in))) {
1149 die "unable to resolve address for server '${server_in}'\n";
1152 my $cmd = ['/sbin/showmount', '--no-headers', '--exports', $server];
1155 run_command
($cmd, outfunc
=> sub {
1158 # note: howto handle white spaces in export path??
1159 if ($line =~ m!^(/\S+)\s+(.+)$!) {
1169 my $cmd = ['zfs', 'list', '-t', 'filesystem', '-H', '-o', 'name,avail,used'];
1172 run_command
($cmd, outfunc
=> sub {
1175 if ($line =~m/^(\S+)\s+(\S+)\s+(\S+)$/) {
1176 my ($pool, $size_str, $used_str) = ($1, $2, $3);
1177 my $size = PVE
::Storage
::ZFSPoolPlugin
::zfs_parse_size
($size_str);
1178 my $used = PVE
::Storage
::ZFSPoolPlugin
::zfs_parse_size
($used_str);
1179 # ignore subvolumes generated by our ZFSPoolPlugin
1180 return if $pool =~ m!/subvol-\d+-[^/]+$!;
1181 return if $pool =~ m!/basevol-\d+-[^/]+$!;
1182 push @$res, { pool
=> $pool, size
=> $size, free
=> $size-$used };
1190 my ($portal, $noerr) = @_;
1192 my ($server, $port) = PVE
::Tools
::parse_host_and_port
($portal);
1194 if (my $ip = resolv_server
($server)) {
1196 $server = "[$server]" if $server =~ /^$IPV6RE$/;
1197 return $port ?
"$server:$port" : $server;
1200 return undef if $noerr;
1202 raise_param_exc
({ portal
=> "unable to resolve portal address '$portal'" });
1205 # idea is from usbutils package (/usr/bin/usb-devices) script
1206 sub __scan_usb_device
{
1207 my ($res, $devpath, $parent, $level) = @_;
1209 return if ! -d
$devpath;
1210 return if $level && $devpath !~ m/^.*[-.](\d+)$/;
1211 my $port = $level ?
int($1 - 1) : 0;
1213 my $busnum = int(file_read_firstline
("$devpath/busnum"));
1214 my $devnum = int(file_read_firstline
("$devpath/devnum"));
1221 speed
=> file_read_firstline
("$devpath/speed"),
1222 class => hex(file_read_firstline
("$devpath/bDeviceClass")),
1223 vendid
=> file_read_firstline
("$devpath/idVendor"),
1224 prodid
=> file_read_firstline
("$devpath/idProduct"),
1228 my $usbpath = $devpath;
1229 $usbpath =~ s
|^.*/\d
+\
-||;
1230 $d->{usbpath
} = $usbpath;
1233 my $product = file_read_firstline
("$devpath/product");
1234 $d->{product
} = $product if $product;
1236 my $manu = file_read_firstline
("$devpath/manufacturer");
1237 $d->{manufacturer
} = $manu if $manu;
1239 my $serial => file_read_firstline
("$devpath/serial");
1240 $d->{serial
} = $serial if $serial;
1244 foreach my $subdev (<$devpath/$busnum-*>) {
1245 next if $subdev !~ m
|/$busnum-[0-9]+(\
.[0-9]+)*$|;
1246 __scan_usb_device
($res, $subdev, $devnum, $level + 1);
1255 foreach my $device (</sys/bus
/usb
/devices
/usb
*>) {
1256 __scan_usb_device
($devlist, $device, 0, 0);
1263 my ($portal_in) = @_;
1266 if (!($portal = resolv_portal
($portal_in))) {
1267 die "unable to parse/resolve portal address '${portal_in}'\n";
1270 return PVE
::Storage
::ISCSIPlugin
::iscsi_discovery
($portal);
1273 sub storage_default_format
{
1274 my ($cfg, $storeid) = @_;
1276 my $scfg = storage_config
($cfg, $storeid);
1278 return PVE
::Storage
::Plugin
::default_format
($scfg);
1281 sub vgroup_is_used
{
1282 my ($cfg, $vgname) = @_;
1284 foreach my $storeid (keys %{$cfg->{ids
}}) {
1285 my $scfg = storage_config
($cfg, $storeid);
1286 if ($scfg->{type
} eq 'lvm' && $scfg->{vgname
} eq $vgname) {
1294 sub target_is_used
{
1295 my ($cfg, $target) = @_;
1297 foreach my $storeid (keys %{$cfg->{ids
}}) {
1298 my $scfg = storage_config
($cfg, $storeid);
1299 if ($scfg->{type
} eq 'iscsi' && $scfg->{target
} eq $target) {
1307 sub volume_is_used
{
1308 my ($cfg, $volid) = @_;
1310 foreach my $storeid (keys %{$cfg->{ids
}}) {
1311 my $scfg = storage_config
($cfg, $storeid);
1312 if ($scfg->{base
} && $scfg->{base
} eq $volid) {
1320 sub storage_is_used
{
1321 my ($cfg, $storeid) = @_;
1323 foreach my $sid (keys %{$cfg->{ids
}}) {
1324 my $scfg = storage_config
($cfg, $sid);
1325 next if !$scfg->{base
};
1326 my ($st) = parse_volume_id
($scfg->{base
});
1327 return 1 if $st && $st eq $storeid;
1334 my ($list, $func) = @_;
1338 foreach my $sid (keys %$list) {
1339 foreach my $info (@{$list->{$sid}}) {
1340 my $volid = $info->{volid
};
1341 my ($sid1, $volname) = parse_volume_id
($volid, 1);
1342 if ($sid1 && $sid1 eq $sid) {
1343 &$func ($volid, $sid, $info);
1345 warn "detected strange volid '$volid' in volume list for '$sid'\n";
1351 sub extract_vzdump_config_tar
{
1352 my ($archive, $conf_re) = @_;
1354 die "ERROR: file '$archive' does not exist\n" if ! -f
$archive;
1356 my $pid = open(my $fh, '-|', 'tar', 'tf', $archive) ||
1357 die "unable to open file '$archive'\n";
1360 while (defined($file = <$fh>)) {
1361 if ($file =~ $conf_re) {
1362 $file = $1; # untaint
1371 die "ERROR: archive contains no configuration file\n" if !$file;
1377 $raw .= "$output\n";
1380 PVE
::Tools
::run_command
(['tar', '-xpOf', $archive, $file, '--occurrence'], outfunc
=> $out);
1382 return wantarray ?
($raw, $file) : $raw;
1385 sub extract_vzdump_config_vma
{
1386 my ($archive, $comp) = @_;
1392 $raw .= "$output\n";
1398 if ($comp eq 'gz') {
1399 $uncomp = ["zcat", $archive];
1400 } elsif ($comp eq 'lzo') {
1401 $uncomp = ["lzop", "-d", "-c", $archive];
1403 die "unknown compression method '$comp'\n";
1405 $cmd = [$uncomp, ["vma", "config", "-"]];
1407 # in some cases, lzop/zcat exits with 1 when its stdout pipe is
1408 # closed early by vma, detect this and ignore the exit code later
1413 if ($output =~ m/lzop: Broken pipe: <stdout>/ || $output =~ m/gzip: stdout: Broken pipe/) {
1415 } elsif (!defined ($errstring) && $output !~ m/^\s*$/) {
1416 $errstring = "Failed to extract config from VMA archive: $output\n";
1420 # in other cases, the pipeline will exit with exit code 141
1421 # because of the broken pipe, handle / ignore this as well
1424 $rc = PVE
::Tools
::run_command
($cmd, outfunc
=> $out, errfunc
=> $err, noerr
=> 1);
1428 # use exit code if no stderr output and not just broken pipe
1429 if (!$errstring && !$broken_pipe && $rc != 0 && $rc != 141) {
1430 die "$rerr\n" if $rerr;
1431 die "config extraction failed with exit code $rc\n";
1433 die "$errstring\n" if $errstring;
1435 # simple case without compression and weird piping behaviour
1436 PVE
::Tools
::run_command
(["vma", "config", $archive], outfunc
=> $out);
1439 return wantarray ?
($raw, undef) : $raw;
1442 sub extract_vzdump_config
{
1443 my ($cfg, $volid) = @_;
1445 my $archive = abs_filesystem_path
($cfg, $volid);
1447 if ($volid =~ /vzdump-(lxc|openvz)-\d+-(\d{4})_(\d{2})_(\d{2})-(\d{2})_(\d{2})_(\d{2})\.(tgz|(tar(\.(gz|lzo))?))$/) {
1448 return extract_vzdump_config_tar
($archive, qr!^(\./etc/vzdump/(pct|vps)\.conf)$!);
1449 } elsif ($volid =~ /vzdump-qemu-\d+-(\d{4})_(\d{2})_(\d{2})-(\d{2})_(\d{2})_(\d{2})\.(tgz|((tar|vma)(\.(gz|lzo))?))$/) {
1457 $comp = $11 if defined($11);
1460 if ($format eq 'tar') {
1461 return extract_vzdump_config_tar
($archive, qr!\(\./qemu-server\.conf\)!);
1463 return extract_vzdump_config_vma
($archive, $comp);
1466 die "cannot determine backup guest type for backup archive '$volid'\n";
1471 my ($cfg, $fh, $volid, $format, $snapshot, $base_snapshot, $with_snapshots) = @_;
1473 my ($storeid, $volname) = parse_volume_id
($volid, 1);
1474 die "cannot export volume '$volid'\n" if !$storeid;
1475 my $scfg = storage_config
($cfg, $storeid);
1476 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1477 return $plugin->volume_export($scfg, $storeid, $fh, $volname, $format,
1478 $snapshot, $base_snapshot, $with_snapshots);
1482 my ($cfg, $fh, $volid, $format, $base_snapshot, $with_snapshots) = @_;
1484 my ($storeid, $volname) = parse_volume_id
($volid, 1);
1485 die "cannot import into volume '$volid'\n" if !$storeid;
1486 my $scfg = storage_config
($cfg, $storeid);
1487 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1488 return $plugin->volume_import($scfg, $storeid, $fh, $volname, $format,
1489 $base_snapshot, $with_snapshots);
1492 sub volume_export_formats
{
1493 my ($cfg, $volid, $snapshot, $base_snapshot, $with_snapshots) = @_;
1495 my ($storeid, $volname) = parse_volume_id
($volid, 1);
1496 return if !$storeid;
1497 my $scfg = storage_config
($cfg, $storeid);
1498 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1499 return $plugin->volume_export_formats($scfg, $storeid, $volname,
1500 $base_snapshot, $with_snapshots);
1503 sub volume_import_formats
{
1504 my ($cfg, $volid, $base_snapshot, $with_snapshots) = @_;
1506 my ($storeid, $volname) = parse_volume_id
($volid, 1);
1507 return if !$storeid;
1508 my $scfg = storage_config
($cfg, $storeid);
1509 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
1510 return $plugin->volume_import_formats($scfg, $storeid, $volname,
1511 $base_snapshot, $with_snapshots);
1514 sub volume_transfer_formats
{
1515 my ($cfg, $src_volid, $dst_volid, $snapshot, $base_snapshot, $with_snapshots) = @_;
1516 my @export_formats = volume_export_formats
($cfg, $src_volid, $snapshot, $base_snapshot, $with_snapshots);
1517 my @import_formats = volume_import_formats
($cfg, $dst_volid, $base_snapshot, $with_snapshots);
1518 my %import_hash = map { $_ => 1 } @import_formats;
1519 my @common = grep { $import_hash{$_} } @export_formats;
1523 # bash completion helper
1525 sub complete_storage
{
1526 my ($cmdname, $pname, $cvalue) = @_;
1528 my $cfg = PVE
::Storage
::config
();
1530 return $cmdname eq 'add' ?
[] : [ PVE
::Storage
::storage_ids
($cfg) ];
1533 sub complete_storage_enabled
{
1534 my ($cmdname, $pname, $cvalue) = @_;
1538 my $cfg = PVE
::Storage
::config
();
1539 foreach my $sid (keys %{$cfg->{ids
}}) {
1540 next if !storage_check_enabled
($cfg, $sid, undef, 1);
1546 sub complete_content_type
{
1547 my ($cmdname, $pname, $cvalue) = @_;
1549 return [qw(rootdir images vztmpl iso backup)];
1552 sub complete_volume
{
1553 my ($cmdname, $pname, $cvalue) = @_;
1557 my $storage_list = complete_storage_enabled
();
1559 if ($cvalue =~ m/^([^:]+):/) {
1560 $storage_list = [ $1 ];
1562 if (scalar(@$storage_list) > 1) {
1563 # only list storage IDs to avoid large listings
1565 foreach my $storeid (@$storage_list) {
1566 # Hack: simply return 2 artificial values, so that
1567 # completions does not finish
1568 push @$res, "$storeid:volname", "$storeid:...";
1575 foreach my $storeid (@$storage_list) {
1576 my $vollist = PVE
::Storage
::volume_list
($cfg, $storeid);
1578 foreach my $item (@$vollist) {
1579 push @$res, $item->{volid
};