1 package PVE
::Storage
::Plugin
;
9 use PVE
::Tools
qw(run_command);
10 use PVE
::JSONSchema
qw(get_standard_option);
11 use PVE
::Cluster
qw(cfs_register_file);
13 use base
qw(PVE::SectionConfig);
15 our @COMMON_TAR_FLAGS = qw(
17 -p --sparse --numeric-owner --acls
18 --xattrs --xattrs-include=user.* --xattrs-include=security.capability
19 --warning=no-file-ignored --warning=no-xattr-write
22 our @SHARED_STORAGE = (
34 our $MAX_VOLUMES_PER_GUEST = 1024;
36 cfs_register_file
('storage.cfg',
37 sub { __PACKAGE__-
>parse_config(@_); },
38 sub { __PACKAGE__-
>write_config(@_); });
43 type
=> { description
=> "Storage type." },
44 storage
=> get_standard_option
('pve-storage-id',
45 { completion
=> \
&PVE
::Storage
::complete_storage
}),
46 nodes
=> get_standard_option
('pve-node-list', { optional
=> 1 }),
48 description
=> "Allowed content types.\n\nNOTE: the value " .
49 "'rootdir' is used for Containers, and value 'images' for VMs.\n",
50 type
=> 'string', format
=> 'pve-storage-content-list',
52 completion
=> \
&PVE
::Storage
::complete_content_type
,
55 description
=> "Flag to disable the storage.",
60 description
=> "Maximal number of backup files per VM. Use '0' for unlimted.",
66 description
=> "Mark storage as shared.",
71 description
=> "Default image format.",
72 type
=> 'string', format
=> 'pve-storage-format',
78 sub content_hash_to_string
{
82 foreach my $ct (keys %$hash) {
83 push @cta, $ct if $hash->{$ct};
86 return join(',', @cta);
89 sub valid_content_types
{
92 my $def = $defaultData->{plugindata
}->{$type};
96 return $def->{content
}->[0];
102 my $type = $scfg->{type
};
103 my $def = $defaultData->{plugindata
}->{$type};
105 my $def_format = 'raw';
106 my $valid_formats = [ $def_format ];
108 if (defined($def->{format
})) {
109 $def_format = $scfg->{format
} || $def->{format
}->[1];
110 $valid_formats = [ sort keys %{$def->{format
}->[0]} ];
113 return wantarray ?
($def_format, $valid_formats) : $def_format;
116 PVE
::JSONSchema
::register_format
('pve-storage-path', \
&verify_path
);
118 my ($path, $noerr) = @_;
120 # fixme: exclude more shell meta characters?
121 # we need absolute paths
122 if ($path !~ m
|^/[^;\
(\
)]+|) {
123 return undef if $noerr;
124 die "value does not look like a valid absolute path\n";
129 PVE
::JSONSchema
::register_format
('pve-storage-server', \
&verify_server
);
131 my ($server, $noerr) = @_;
133 if (!(PVE
::JSONSchema
::pve_verify_ip
($server, 1) ||
134 PVE
::JSONSchema
::pve_verify_dns_name
($server, 1)))
136 return undef if $noerr;
137 die "value does not look like a valid server name or IP address\n";
142 PVE
::JSONSchema
::register_format
('pve-storage-vgname', \
&parse_lvm_name
);
144 my ($name, $noerr) = @_;
146 if ($name !~ m/^[a-z][a-z0-9\-\_\.]*[a-z0-9]$/i) {
147 return undef if $noerr;
148 die "lvm name '$name' contains illegal characters\n";
154 # fixme: do we need this
155 #PVE::JSONSchema::register_format('pve-storage-portal', \&verify_portal);
157 # my ($portal, $noerr) = @_;
159 # # IP with optional port
160 # if ($portal !~ m/^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}(:\d+)?$/) {
161 # return undef if $noerr;
162 # die "value does not look like a valid portal address\n";
167 PVE
::JSONSchema
::register_format
('pve-storage-portal-dns', \
&verify_portal_dns
);
168 sub verify_portal_dns
{
169 my ($portal, $noerr) = @_;
171 # IP or DNS name with optional port
172 if (!PVE
::Tools
::parse_host_and_port
($portal)) {
173 return undef if $noerr;
174 die "value does not look like a valid portal address\n";
179 PVE
::JSONSchema
::register_format
('pve-storage-content', \
&verify_content
);
181 my ($ct, $noerr) = @_;
183 my $valid_content = valid_content_types
('dir'); # dir includes all types
185 if (!$valid_content->{$ct}) {
186 return undef if $noerr;
187 die "invalid content type '$ct'\n";
193 PVE
::JSONSchema
::register_format
('pve-storage-format', \
&verify_format
);
195 my ($fmt, $noerr) = @_;
197 if ($fmt !~ m/(raw|qcow2|vmdk|subvol)/) {
198 return undef if $noerr;
199 die "invalid format '$fmt'\n";
205 PVE
::JSONSchema
::register_format
('pve-storage-options', \
&verify_options
);
207 my ($value, $noerr) = @_;
209 # mount options (see man fstab)
210 if ($value !~ m/^\S+$/) {
211 return undef if $noerr;
212 die "invalid options '$value'\n";
218 PVE
::JSONSchema
::register_format
('pve-volume-id', \
&parse_volume_id
);
219 sub parse_volume_id
{
220 my ($volid, $noerr) = @_;
222 if ($volid =~ m/^([a-z][a-z0-9\-\_\.]*[a-z0-9]):(.+)$/i) {
223 return wantarray ?
($1, $2) : $1;
225 return undef if $noerr;
226 die "unable to parse volume ID '$volid'\n";
234 sub parse_section_header
{
235 my ($class, $line) = @_;
237 if ($line =~ m/^(\S+):\s*(\S+)\s*$/) {
238 my ($type, $storeid) = (lc($1), $2);
239 my $errmsg = undef; # set if you want to skip whole section
240 eval { PVE
::JSONSchema
::parse_storage_id
($storeid); };
242 my $config = {}; # to return additional attributes
243 return ($type, $storeid, $errmsg, $config);
249 my ($class, $type, $key, $value) = @_;
251 my $def = $defaultData->{plugindata
}->{$type};
253 if ($key eq 'content') {
254 my $valid_content = $def->{content
}->[0];
258 foreach my $c (PVE
::Tools
::split_list
($value)) {
259 if (!$valid_content->{$c}) {
260 warn "storage does not support content type '$c'\n";
266 if ($res->{none
} && scalar (keys %$res) > 1) {
267 die "unable to combine 'none' with other content types\n";
271 } elsif ($key eq 'format') {
272 my $valid_formats = $def->{format
}->[0];
274 if (!$valid_formats->{$value}) {
275 warn "storage does not support format '$value'\n";
280 } elsif ($key eq 'nodes') {
283 foreach my $node (PVE
::Tools
::split_list
($value)) {
284 if (PVE
::JSONSchema
::pve_verify_node_name
($node)) {
290 # no node restrictions for local storage
291 #if ($storeid && $storeid eq 'local' && scalar(keys(%$res))) {
292 # die "storage '$storeid' does not allow node restrictions\n";
302 my ($class, $type, $key, $value) = @_;
304 if ($key eq 'nodes') {
305 return join(',', keys(%$value));
306 } elsif ($key eq 'content') {
307 my $res = content_hash_to_string
($value) || 'none';
315 my ($class, $filename, $raw) = @_;
317 my $cfg = $class->SUPER::parse_config
($filename, $raw);
318 my $ids = $cfg->{ids
};
320 # make sure we have a reasonable 'local:' storage
321 # we want 'local' to be always the same 'type' (on all cluster nodes)
322 if (!$ids->{local} || $ids->{local}->{type
} ne 'dir' ||
323 ($ids->{local}->{path
} && $ids->{local}->{path
} ne '/var/lib/vz')) {
326 priority
=> 0, # force first entry
327 path
=> '/var/lib/vz',
329 content
=> { images
=> 1, rootdir
=> 1, vztmpl
=> 1, iso
=> 1},
333 # make sure we have a path
334 $ids->{local}->{path
} = '/var/lib/vz' if !$ids->{local}->{path
};
336 # remove node restrictions for local storage
337 delete($ids->{local}->{nodes
});
339 foreach my $storeid (keys %$ids) {
340 my $d = $ids->{$storeid};
341 my $type = $d->{type
};
343 my $def = $defaultData->{plugindata
}->{$type};
345 if ($def->{content
}) {
346 $d->{content
} = $def->{content
}->[1] if !$d->{content
};
348 if (grep { $_ eq $type } @SHARED_STORAGE) {
356 # Storage implementation
358 # called during addition of storage (before the new storage config got written)
359 # die to abort additon if there are (grave) problems
360 # NOTE: runs in a storage config *locked* context
362 my ($class, $storeid, $scfg, %param) = @_;
364 # do nothing by default
367 # called during deletion of storage (before the new storage config got written)
368 # and if the activate check on addition fails, to cleanup all storage traces
369 # which on_add_hook may have created.
370 # die to abort deletion if there are (very grave) problems
371 # NOTE: runs in a storage config *locked* context
373 my ($class, $storeid, $scfg) = @_;
375 # do nothing by default
378 sub cluster_lock_storage
{
379 my ($class, $storeid, $shared, $timeout, $func, @param) = @_;
383 my $lockid = "pve-storage-$storeid";
384 my $lockdir = "/var/lock/pve-manager";
386 $res = PVE
::Tools
::lock_file
("$lockdir/$lockid", $timeout, $func, @param);
389 $res = PVE
::Cluster
::cfs_lock_storage
($storeid, $timeout, $func, @param);
398 if ($name =~ m!^((base-)?[^/\s]+\.(raw|qcow2|vmdk|subvol))$!) {
399 return ($1, $3, $2); # (name, format, isBase)
402 die "unable to parse volume filename '$name'\n";
406 my ($class, $volname) = @_;
408 if ($volname =~ m!^(\d+)/(\S+)/(\d+)/(\S+)$!) {
409 my ($basedvmid, $basename) = ($1, $2);
410 parse_name_dir
($basename);
411 my ($vmid, $name) = ($3, $4);
412 my (undef, $format, $isBase) = parse_name_dir
($name);
413 return ('images', $name, $vmid, $basename, $basedvmid, $isBase, $format);
414 } elsif ($volname =~ m!^(\d+)/(\S+)$!) {
415 my ($vmid, $name) = ($1, $2);
416 my (undef, $format, $isBase) = parse_name_dir
($name);
417 return ('images', $name, $vmid, undef, undef, $isBase, $format);
418 } elsif ($volname =~ m!^iso/([^/]+\.[Ii][Ss][Oo])$!) {
420 } elsif ($volname =~ m!^vztmpl/([^/]+\.tar\.[gx]z)$!) {
421 return ('vztmpl', $1);
422 } elsif ($volname =~ m!^rootdir/(\d+)$!) {
423 return ('rootdir', $1, $1);
424 } elsif ($volname =~ m!^backup/([^/]+(\.(tar|tar\.gz|tar\.lzo|tgz|vma|vma\.gz|vma\.lzo)))$!) {
426 if ($fn =~ m/^vzdump-(openvz|lxc|qemu)-(\d+)-.+/) {
427 return ('backup', $fn, $2);
429 return ('backup', $fn);
432 die "unable to parse directory volume name '$volname'\n";
435 my $vtype_subdirs = {
437 rootdir
=> 'private',
438 iso
=> 'template/iso',
439 vztmpl
=> 'template/cache',
444 my ($class, $scfg, $vtype) = @_;
446 my $path = $scfg->{path
};
448 die "storage definintion has no path\n" if !$path;
450 my $subdir = $vtype_subdirs->{$vtype};
452 die "unknown vtype '$vtype'\n" if !defined($subdir);
454 return "$path/$subdir";
457 sub filesystem_path
{
458 my ($class, $scfg, $volname, $snapname) = @_;
460 my ($vtype, $name, $vmid, undef, undef, $isBase, $format) =
461 $class->parse_volname($volname);
463 # Note: qcow2/qed has internal snapshot, so path is always
464 # the same (with or without snapshot => same file).
465 die "can't snapshot this image format\n"
466 if defined($snapname) && $format !~ m/^(qcow2|qed)$/;
468 my $dir = $class->get_subdir($scfg, $vtype);
470 $dir .= "/$vmid" if $vtype eq 'images';
472 my $path = "$dir/$name";
474 return wantarray ?
($path, $vmid, $vtype) : $path;
478 my ($class, $scfg, $volname, $storeid, $snapname) = @_;
480 return $class->filesystem_path($scfg, $volname, $snapname);
484 my ($class, $storeid, $scfg, $volname) = @_;
486 # this only works for file based storage types
487 die "storage definition has no path\n" if !$scfg->{path
};
489 my ($vtype, $name, $vmid, $basename, $basevmid, $isBase, $format) =
490 $class->parse_volname($volname);
492 die "create_base on wrong vtype '$vtype'\n" if $vtype ne 'images';
494 die "create_base not possible with base image\n" if $isBase;
496 my $path = $class->filesystem_path($scfg, $volname);
498 my ($size, undef, $used, $parent) = file_size_info
($path);
499 die "file_size_info on '$volname' failed\n" if !($format && defined($size));
501 die "volname '$volname' contains wrong information about parent\n"
502 if $basename && (!$parent || $parent ne "../$basevmid/$basename");
505 $newname =~ s/^vm-/base-/;
507 my $newvolname = $basename ?
"$basevmid/$basename/$vmid/$newname" :
510 my $newpath = $class->filesystem_path($scfg, $newvolname);
512 die "file '$newpath' already exists\n" if -f
$newpath;
514 rename($path, $newpath) ||
515 die "rename '$path' to '$newpath' failed - $!\n";
517 # We try to protect base volume
519 chmod(0444, $newpath); # nobody should write anything
521 # also try to set immutable flag
522 eval { run_command
(['/usr/bin/chattr', '+i', $newpath]); };
528 my $get_vm_disk_number = sub {
529 my ($disk_name, $scfg, $vmid, $suffix) = @_;
531 my $disk_regex = qr/(vm|base)-$vmid-disk-(\d+)$suffix/;
533 my $type = $scfg->{type
};
534 my $def = { %{$defaultData->{plugindata
}->{$type}} };
536 my $valid = $def->{format
}[0];
537 if ($valid->{subvol
}) {
538 $disk_regex = qr/(vm|base|subvol|basevol)-$vmid-disk-(\d+)/;
541 if ($disk_name =~ m/$disk_regex/) {
548 sub get_next_vm_diskname
{
549 my ($disk_list, $storeid, $vmid, $fmt, $scfg, $add_fmt_suffix) = @_;
552 my $prefix = ($fmt eq 'subvol') ?
'subvol' : 'vm';
553 my $suffix = $add_fmt_suffix ?
".$fmt" : '';
556 foreach my $disk (@$disk_list) {
557 my $disknum = $get_vm_disk_number->($disk, $scfg, $vmid, $suffix);
558 $disk_ids->{$disknum} = 1 if defined($disknum);
561 for (my $i = 0; $i < $MAX_VOLUMES_PER_GUEST; $i++) {
562 if (!$disk_ids->{$i}) {
563 return "$prefix-$vmid-disk-$i$suffix";
567 die "unable to allocate an image name for VM $vmid in storage '$storeid'\n"
570 my $find_free_diskname = sub {
571 my ($imgdir, $vmid, $fmt, $scfg) = @_;
575 if (defined(my $dh = IO
::Dir-
>new($imgdir))) {
576 @$disk_list = $dh->read();
580 return get_next_vm_diskname
($disk_list, $imgdir, $vmid, $fmt, $scfg, 1);
584 my ($class, $scfg, $storeid, $volname, $vmid, $snap) = @_;
586 # this only works for file based storage types
587 die "storage definintion has no path\n" if !$scfg->{path
};
589 my ($vtype, $basename, $basevmid, undef, undef, $isBase, $format) =
590 $class->parse_volname($volname);
592 die "clone_image on wrong vtype '$vtype'\n" if $vtype ne 'images';
594 die "this storage type does not support clone_image on snapshot\n" if $snap;
596 die "this storage type does not support clone_image on subvolumes\n" if $format eq 'subvol';
598 die "clone_image only works on base images\n" if !$isBase;
600 my $imagedir = $class->get_subdir($scfg, 'images');
601 $imagedir .= "/$vmid";
605 my $name = $find_free_diskname->($imagedir, $vmid, "qcow2", $scfg);
607 warn "clone $volname: $vtype, $name, $vmid to $name (base=../$basevmid/$basename)\n";
609 my $newvol = "$basevmid/$basename/$vmid/$name";
611 my $path = $class->filesystem_path($scfg, $newvol);
613 # Note: we use relative paths, so we need to call chdir before qemu-img
615 local $CWD = $imagedir;
617 my $cmd = ['/usr/bin/qemu-img', 'create', '-b', "../$basevmid/$basename",
618 '-f', 'qcow2', $path];
630 my ($class, $storeid, $scfg, $vmid, $fmt, $name, $size) = @_;
632 my $imagedir = $class->get_subdir($scfg, 'images');
633 $imagedir .= "/$vmid";
637 $name = $find_free_diskname->($imagedir, $vmid, $fmt, $scfg) if !$name;
639 my (undef, $tmpfmt) = parse_name_dir
($name);
641 die "illegal name '$name' - wrong extension for format ('$tmpfmt != '$fmt')\n"
644 my $path = "$imagedir/$name";
646 die "disk image '$path' already exists\n" if -e
$path;
648 if ($fmt eq 'subvol') {
649 # only allow this if size = 0, so that user knows what he is doing
650 die "storage does not support subvol quotas\n" if $size != 0;
652 my $old_umask = umask(0022);
654 mkdir($path) or $err = "unable to create subvol '$path' - $!\n";
658 my $cmd = ['/usr/bin/qemu-img', 'create'];
660 push @$cmd, '-o', 'preallocation=metadata' if $fmt eq 'qcow2';
662 push @$cmd, '-f', $fmt, $path, "${size}K";
664 run_command
($cmd, errmsg
=> "unable to create image");
667 return "$vmid/$name";
671 my ($class, $storeid, $scfg, $volname, $isBase, $format) = @_;
673 my $path = $class->filesystem_path($scfg, $volname);
676 # try to remove immutable flag
677 eval { run_command
(['/usr/bin/chattr', '-i', $path]); };
681 if (defined($format) && ($format eq 'subvol')) {
682 File
::Path
::remove_tree
($path);
686 warn "disk image '$path' does not exists\n";
690 unlink($path) || die "unlink '$path' failed - $!\n";
697 my ($filename, $timeout) = @_;
700 return wantarray ?
(0, 'subvol', 0, undef) : 1;
703 my $cmd = ['/usr/bin/qemu-img', 'info', $filename];
711 run_command
($cmd, timeout
=> $timeout, outfunc
=> sub {
713 if ($line =~ m/^file format:\s+(\S+)\s*$/) {
715 } elsif ($line =~ m/^backing file:\s(\S+)\s/) {
717 } elsif ($line =~ m/^virtual size:\s\S+\s+\((\d+)\s+bytes\)$/) {
719 } elsif ($line =~ m/^disk size:\s+(\d+(.\d+)?)([KMGT])\s*$/) {
723 $used *= 1024 if $u eq 'K';
724 $used *= (1024*1024) if $u eq 'M';
725 $used *= (1024*1024*1024) if $u eq 'G';
726 $used *= (1024*1024*1024*1024) if $u eq 'T';
733 return wantarray ?
($size, $format, $used, $parent) : $size;
736 sub volume_size_info
{
737 my ($class, $scfg, $storeid, $volname, $timeout) = @_;
738 my $path = $class->filesystem_path($scfg, $volname);
739 return file_size_info
($path, $timeout);
744 my ($class, $scfg, $storeid, $volname, $size, $running) = @_;
746 die "can't resize this image format\n" if $volname !~ m/\.(raw|qcow2)$/;
748 return 1 if $running;
750 my $path = $class->filesystem_path($scfg, $volname);
752 my $format = ($class->parse_volname($volname))[6];
754 my $cmd = ['/usr/bin/qemu-img', 'resize', '-f', $format, $path , $size];
756 run_command
($cmd, timeout
=> 10);
761 sub volume_snapshot
{
762 my ($class, $scfg, $storeid, $volname, $snap) = @_;
764 die "can't snapshot this image format\n" if $volname !~ m/\.(qcow2|qed)$/;
766 my $path = $class->filesystem_path($scfg, $volname);
768 my $cmd = ['/usr/bin/qemu-img', 'snapshot','-c', $snap, $path];
775 sub volume_rollback_is_possible
{
776 my ($class, $scfg, $storeid, $volname, $snap) = @_;
781 sub volume_snapshot_rollback
{
782 my ($class, $scfg, $storeid, $volname, $snap) = @_;
784 die "can't rollback snapshot this image format\n" if $volname !~ m/\.(qcow2|qed)$/;
786 my $path = $class->filesystem_path($scfg, $volname);
788 my $cmd = ['/usr/bin/qemu-img', 'snapshot','-a', $snap, $path];
795 sub volume_snapshot_delete
{
796 my ($class, $scfg, $storeid, $volname, $snap, $running) = @_;
798 die "can't delete snapshot for this image format\n" if $volname !~ m/\.(qcow2|qed)$/;
800 return 1 if $running;
802 my $path = $class->filesystem_path($scfg, $volname);
804 $class->deactivate_volume($storeid, $scfg, $volname, $snap, {});
806 my $cmd = ['/usr/bin/qemu-img', 'snapshot','-d', $snap, $path];
813 sub storage_can_replicate
{
814 my ($class, $scfg, $storeid, $format) = @_;
819 sub volume_has_feature
{
820 my ($class, $scfg, $feature, $storeid, $volname, $snapname, $running) = @_;
823 snapshot
=> { current
=> { qcow2
=> 1}, snap
=> { qcow2
=> 1} },
824 clone
=> { base
=> {qcow2
=> 1, raw
=> 1, vmdk
=> 1} },
825 template
=> { current
=> {qcow2
=> 1, raw
=> 1, vmdk
=> 1, subvol
=> 1} },
826 copy
=> { base
=> {qcow2
=> 1, raw
=> 1, vmdk
=> 1},
827 current
=> {qcow2
=> 1, raw
=> 1, vmdk
=> 1},
828 snap
=> {qcow2
=> 1} },
829 sparseinit
=> { base
=> {qcow2
=> 1, raw
=> 1, vmdk
=> 1},
830 current
=> {qcow2
=> 1, raw
=> 1, vmdk
=> 1} },
833 my ($vtype, $name, $vmid, $basename, $basevmid, $isBase, $format) =
834 $class->parse_volname($volname);
840 $key = $isBase ?
'base' : 'current';
843 return 1 if defined($features->{$feature}->{$key}->{$format});
849 my ($class, $storeid, $scfg, $vmid, $vollist, $cache) = @_;
851 my $imagedir = $class->get_subdir($scfg, 'images');
853 my ($defFmt, $vaidFmts) = default_format
($scfg);
854 my $fmts = join ('|', @$vaidFmts);
858 foreach my $fn (<$imagedir/[0-9][0-9]*/*>) {
860 next if $fn !~ m!^(/.+/(\d+)/([^/]+\.($fmts)))$!;
866 next if !$vollist && defined($vmid) && ($owner ne $vmid);
868 my ($size, $format, $used, $parent) = file_size_info
($fn);
869 next if !($format && defined($size));
872 if ($parent && $parent =~ m!^../(\d+)/([^/]+\.($fmts))$!) {
873 my ($basevmid, $basename) = ($1, $2);
874 $volid = "$storeid:$basevmid/$basename/$owner/$name";
876 $volid = "$storeid:$owner/$name";
880 my $found = grep { $_ eq $volid } @$vollist;
885 volid
=> $volid, format
=> $format,
886 size
=> $size, vmid
=> $owner, used
=> $used, parent
=> $parent
894 my ($class, $storeid, $scfg, $cache) = @_;
896 my $path = $scfg->{path
};
898 die "storage definintion has no path\n" if !$path;
901 my $res = PVE
::Tools
::df
($path, $timeout);
903 return undef if !$res || !$res->{total
};
905 return ($res->{total
}, $res->{avail
}, $res->{used
}, 1);
908 sub volume_snapshot_list
{
909 my ($class, $scfg, $storeid, $volname) = @_;
911 # implement in subclass
912 die "Volume_snapshot_list is not implemented for $class";
914 # return an empty array if dataset does not exist.
917 sub activate_storage
{
918 my ($class, $storeid, $scfg, $cache) = @_;
920 my $path = $scfg->{path
};
922 die "storage definintion has no path\n" if !$path;
924 # this path test may hang indefinitely on unresponsive mounts
926 if (! PVE
::Tools
::run_fork_with_timeout
($timeout, sub {-d
$path})) {
927 die "unable to activate storage '$storeid' - " .
928 "directory '$path' does not exist or is unreachable\n";
932 return if defined($scfg->{mkdir}) && !$scfg->{mkdir};
934 if (defined($scfg->{content
})) {
935 foreach my $vtype (keys %$vtype_subdirs) {
936 # OpenVZMigrate uses backup (dump) dir
937 if (defined($scfg->{content
}->{$vtype}) ||
938 ($vtype eq 'backup' && defined($scfg->{content
}->{'rootdir'}))) {
939 my $subdir = $class->get_subdir($scfg, $vtype);
940 mkpath
$subdir if $subdir ne $path;
946 sub deactivate_storage
{
947 my ($class, $storeid, $scfg, $cache) = @_;
949 # do nothing by default
953 my ($class, $storeid, $scfg, $volname, $snapname) = @_;
959 my ($class, $storeid, $scfg, $volname, $snapname) = @_;
964 sub activate_volume
{
965 my ($class, $storeid, $scfg, $volname, $snapname, $cache) = @_;
967 my $path = $class->filesystem_path($scfg, $volname, $snapname);
969 # check is volume exists
971 die "volume '$storeid:$volname' does not exist\n" if ! -e
$path;
973 die "volume '$storeid:$volname' does not exist\n" if ! -b
$path;
977 sub deactivate_volume
{
978 my ($class, $storeid, $scfg, $volname, $snapname, $cache) = @_;
980 # do nothing by default
983 sub check_connection
{
984 my ($class, $storeid, $scfg) = @_;
985 # do nothing by default
989 # Import/Export interface:
990 # Any path based storage is assumed to support 'raw' and 'tar' streams, so
991 # the default implementations will return this if $scfg->{path} is set,
992 # mimicking the old PVE::Storage::storage_migrate() function.
994 # Plugins may fall back to PVE::Storage::Plugin::volume_{export,import}...
995 # functions in case the format doesn't match their specialized
996 # implementations to reuse the raw/tar code.
998 # Format specification:
999 # The following formats are all prefixed with image information in the form
1000 # of a 64 bit little endian unsigned integer (pack('Q<')) in order to be able
1001 # to preallocate the image on storages which require it.
1003 # raw+size: (image files only)
1004 # A raw binary data stream such as produced via `dd if=TheImageFile`.
1005 # qcow2+size, vmdk: (image files only)
1006 # A raw qcow2/vmdk/... file such as produced via `dd if=some.qcow2` for
1007 # files which are already in qcow2 format, or via `qemu-img convert`.
1008 # Note that these formats are only valid with $with_snapshots being true.
1009 # tar+size: (subvolumes only)
1010 # A GNU tar stream containing just the inner contents of the subvolume.
1011 # This does not distinguish between the contents of a privileged or
1012 # unprivileged container. In other words, this is from the root user
1013 # namespace's point of view with no uid-mapping in effect.
1014 # As produced via `tar -C vm-100-disk-1.subvol -cpf TheOutputFile.dat .`
1016 # Plugins may reuse these helpers. Changes to the header format should be
1017 # reflected by changes to the function prototypes.
1018 sub write_common_header
($$) {
1019 my ($fh, $image_size_in_bytes) = @_;
1020 syswrite($fh, pack("Q<", $image_size_in_bytes), 8);
1023 sub read_common_header
($) {
1025 sysread($fh, my $size, 8);
1026 $size = unpack('Q<', $size);
1027 die "got a bad size (not a multiple of 1K)\n" if ($size&1023);
1032 # Export a volume into a file handle as a stream of desired format.
1034 my ($class, $scfg, $storeid, $fh, $volname, $format, $snapshot, $base_snapshot, $with_snapshots) = @_;
1035 if ($scfg->{path
} && !defined($snapshot) && !defined($base_snapshot)) {
1036 my $file = $class->path($scfg, $volname, $storeid)
1037 or goto unsupported
;
1038 my ($size, $file_format) = file_size_info
($file);
1040 if ($format eq 'raw+size') {
1041 goto unsupported
if $with_snapshots || $file_format eq 'subvol';
1042 write_common_header
($fh, $size);
1043 if ($file_format eq 'raw') {
1044 run_command
(['dd', "if=$file", "bs=4k"], output
=> '>&'.fileno($fh));
1046 run_command
(['qemu-img', 'convert', '-f', $file_format, '-O', 'raw', $file, '/dev/stdout'],
1047 output
=> '>&'.fileno($fh));
1050 } elsif ($format =~ /^(qcow2|vmdk)\+size$/) {
1051 my $data_format = $1;
1052 goto unsupported
if !$with_snapshots || $file_format ne $data_format;
1053 write_common_header
($fh, $size);
1054 run_command
(['dd', "if=$file", "bs=4k"], output
=> '>&'.fileno($fh));
1056 } elsif ($format eq 'tar+size') {
1057 goto unsupported
if $file_format ne 'subvol';
1058 write_common_header
($fh, $size);
1059 run_command
(['tar', @COMMON_TAR_FLAGS, '-cf', '-', '-C', $file, '.'],
1060 output
=> '>&'.fileno($fh));
1065 die "volume export format $format not available for $class";
1068 sub volume_export_formats
{
1069 my ($class, $scfg, $storeid, $volname, $snapshot, $base_snapshot, $with_snapshots) = @_;
1070 if ($scfg->{path
} && !defined($snapshot) && !defined($base_snapshot)) {
1071 my $file = $class->path($scfg, $volname, $storeid)
1073 my ($size, $format) = file_size_info
($file);
1075 if ($with_snapshots) {
1076 return ($format.'+size') if ($format eq 'qcow2' || $format eq 'vmdk');
1079 return ('tar+size') if $format eq 'subvol';
1080 return ('raw+size');
1085 # Import data from a stream, creating a new or replacing or adding to an existing volume.
1087 my ($class, $scfg, $storeid, $fh, $volname, $format, $base_snapshot, $with_snapshots) = @_;
1089 die "volume import format '$format' not available for $class\n"
1090 if $format !~ /^(raw|tar|qcow2|vmdk)\+size$/;
1091 my $data_format = $1;
1093 die "format $format cannot be imported without snapshots\n"
1094 if !$with_snapshots && ($data_format eq 'qcow2' || $data_format eq 'vmdk');
1095 die "format $format cannot be imported with snapshots\n"
1096 if $with_snapshots && ($data_format eq 'raw' || $data_format eq 'tar');
1098 my ($vtype, $name, $vmid, $basename, $basevmid, $isBase, $file_format) =
1099 $class->parse_volname($volname);
1101 # XXX: Should we bother with conversion routines at this level? This won't
1102 # happen without manual CLI usage, so for now we just error out...
1103 die "cannot import format $format into a file of format $file_format\n"
1104 if $data_format ne $file_format && !($data_format eq 'tar' && $file_format eq 'subvol');
1106 # Check for an existing file first since interrupting alloc_image doesn't
1108 my $file = $class->path($scfg, $volname, $storeid);
1109 die "file '$file' already exists\n" if -e
$file;
1111 my ($size) = read_common_header
($fh);
1112 $size = int($size/1024);
1115 my $allocname = $class->alloc_image($storeid, $scfg, $vmid, $file_format, $name, $size);
1116 if ($allocname ne $volname) {
1117 my $oldname = $volname;
1118 $volname = $allocname; # Let the cleanup code know what to free
1119 die "internal error: unexpected allocated name: '$allocname' != '$oldname'\n";
1121 my $file = $class->path($scfg, $volname, $storeid)
1122 or die "internal error: failed to get path to newly allocated volume $volname\n";
1123 if ($data_format eq 'raw' || $data_format eq 'qcow2' || $data_format eq 'vmdk') {
1124 run_command
(['dd', "of=$file", 'conv=sparse', 'bs=64k'],
1125 input
=> '<&'.fileno($fh));
1126 } elsif ($data_format eq 'tar') {
1127 run_command
(['tar', @COMMON_TAR_FLAGS, '-C', $file, '-xf', '-'],
1128 input
=> '<&'.fileno($fh));
1130 die "volume import format '$format' not available for $class";
1134 eval { $class->free_image($storeid, $scfg, $volname, 0, $file_format) };
1140 sub volume_import_formats
{
1141 my ($class, $scfg, $storeid, $volname, $base_snapshot, $with_snapshots) = @_;
1142 if ($scfg->{path
} && !defined($base_snapshot)) {
1143 my $format = ($class->parse_volname($volname))[6];
1144 if ($with_snapshots) {
1145 return ($format.'+size') if ($format eq 'qcow2' || $format eq 'vmdk');
1148 return ('tar+size') if $format eq 'subvol';
1149 return ('raw+size');