use strict;
use warnings;
+
use File::chdir;
use File::Path;
+
use PVE::Tools qw(run_command);
use PVE::JSONSchema qw(get_standard_option);
use PVE::Cluster qw(cfs_register_file);
-use Data::Dumper;
-
use base qw(PVE::SectionConfig);
+our @COMMON_TAR_FLAGS = qw(
+ --one-file-system
+ -p --sparse --numeric-owner --acls
+ --xattrs --xattrs-include=user.* --xattrs-include=security.capability
+ --warning=no-file-ignored --warning=no-xattr-write
+);
+
+our @SHARED_STORAGE = (
+ 'iscsi',
+ 'nfs',
+ 'cifs',
+ 'rbd',
+ 'cephfs',
+ 'sheepdog',
+ 'iscsidirect',
+ 'glusterfs',
+ 'zfs',
+ 'drbd');
+
+our $MAX_VOLUMES_PER_GUEST = 1024;
+
cfs_register_file ('storage.cfg',
sub { __PACKAGE__->parse_config(@_); },
sub { __PACKAGE__->write_config(@_); });
{ completion => \&PVE::Storage::complete_storage }),
nodes => get_standard_option('pve-node-list', { optional => 1 }),
content => {
- description => "Allowed content types. Note: value 'rootdir' is used for Containers, and value 'images' for KVM-Qemu VM's.\n",
+ description => "Allowed content types.\n\nNOTE: the value " .
+ "'rootdir' is used for Containers, and value 'images' for VMs.\n",
type => 'string', format => 'pve-storage-content-list',
optional => 1,
completion => \&PVE::Storage::complete_content_type,
optional => 1,
},
'format' => {
- description => "Default Image format.",
+ description => "Default image format.",
type => 'string', format => 'pve-storage-format',
optional => 1,
},
if ($def->{content}) {
$d->{content} = $def->{content}->[1] if !$d->{content};
}
-
- if ($type eq 'iscsi' || $type eq 'nfs' || $type eq 'rbd' || $type eq 'sheepdog' || $type eq 'iscsidirect' || $type eq 'glusterfs' || $type eq 'zfs' || $type eq 'drbd') {
+ if (grep { $_ eq $type } @SHARED_STORAGE) {
$d->{shared} = 1;
}
}
# Storage implementation
+# called during addition of storage (before the new storage config got written)
+# die to abort additon if there are (grave) problems
+# NOTE: runs in a storage config *locked* context
+sub on_add_hook {
+ my ($class, $storeid, $scfg, %param) = @_;
+
+ # do nothing by default
+}
+
+# called during deletion of storage (before the new storage config got written)
+# and if the activate check on addition fails, to cleanup all storage traces
+# which on_add_hook may have created.
+# die to abort deletion if there are (very grave) problems
+# NOTE: runs in a storage config *locked* context
+sub on_delete_hook {
+ my ($class, $storeid, $scfg) = @_;
+
+ # do nothing by default
+}
+
sub cluster_lock_storage {
my ($class, $storeid, $shared, $timeout, $func, @param) = @_;
my ($class, $storeid, $scfg, $volname) = @_;
# this only works for file based storage types
- die "storage definintion has no path\n" if !$scfg->{path};
+ die "storage definition has no path\n" if !$scfg->{path};
my ($vtype, $name, $vmid, $basename, $basevmid, $isBase, $format) =
$class->parse_volname($volname);
return $newvolname;
}
-my $find_free_diskname = sub {
- my ($imgdir, $vmid, $fmt) = @_;
+sub is_valid_vm_diskname {
+ my ($disk_name, $scfg, $vmid, $fmt, $add_fmt_suffix) = @_;
+
+ $vmid = qr/\d+/ if !defined($vmid);
+
+ my $suffix = (defined($fmt) && $add_fmt_suffix) ? ".$fmt" : '';
+
+ my $type = $scfg->{type};
+ my $def = $defaultData->{plugindata}->{$type};
+ my $valid_formats = $def->{format}[0];
+
+ my $disk_regex = qr/(vm|base)-$vmid-disk-(\d+)$suffix/;
+ $disk_regex = qr/(vm|base|subvol|basevol)-$vmid-disk-(\d+)/
+ if $valid_formats->{subvol};
+
+ if($disk_name =~ m/$disk_regex/){
+ return wantarray ? (1, $2) : 1;
+ }
+}
+
+sub get_next_vm_diskname {
+ my ($disk_list, $storeid, $vmid, $fmt, $scfg, $add_fmt_suffix) = @_;
my $disk_ids = {};
- PVE::Tools::dir_glob_foreach($imgdir,
- qr!(vm|base)-$vmid-disk-(\d+)\..*!,
- sub {
- my ($fn, $type, $disk) = @_;
- $disk_ids->{$disk} = 1;
- });
-
- for (my $i = 1; $i < 100; $i++) {
+ my ($match, $disknum);
+ foreach my $disk (@$disk_list) {
+ ($match, $disknum) = is_valid_vm_diskname($disk, $scfg, $vmid, $fmt, $add_fmt_suffix);
+ $disk_ids->{$disknum} = 1 if $match;
+ }
+
+ $fmt //= '';
+ my $prefix = ($fmt eq 'subvol') ? 'subvol' : 'vm';
+ my $suffix = $add_fmt_suffix ? ".$fmt" : '';
+
+ for (my $i = 0; $i < $MAX_VOLUMES_PER_GUEST; $i++) {
if (!$disk_ids->{$i}) {
- return "vm-$vmid-disk-$i.$fmt";
+ return "$prefix-$vmid-disk-$i$suffix";
}
}
- die "unable to allocate a new image name for VM $vmid in '$imgdir'\n";
+ die "unable to allocate an image name for VM $vmid in storage '$storeid'\n"
+}
+
+my $find_free_diskname = sub {
+ my ($imgdir, $vmid, $fmt, $scfg) = @_;
+
+ my $disk_list = [];
+
+ if (defined(my $dh = IO::Dir->new($imgdir))) {
+ @$disk_list = $dh->read();
+ $dh->close();
+ }
+
+ return get_next_vm_diskname($disk_list, $imgdir, $vmid, $fmt, $scfg, 1);
};
sub clone_image {
mkpath $imagedir;
- my $name = &$find_free_diskname($imagedir, $vmid, "qcow2");
+ my $name = $find_free_diskname->($imagedir, $vmid, "qcow2", $scfg);
warn "clone $volname: $vtype, $name, $vmid to $name (base=../$basevmid/$basename)\n";
mkpath $imagedir;
- $name = &$find_free_diskname($imagedir, $vmid, $fmt) if !$name;
+ $name = $find_free_diskname->($imagedir, $vmid, $fmt, $scfg) if !$name;
my (undef, $tmpfmt) = parse_name_dir($name);
my $path = $class->filesystem_path($scfg, $volname);
- if ($format eq 'subvol') {
+ if ($isBase) {
+ # try to remove immutable flag
+ eval { run_command(['/usr/bin/chattr', '-i', $path]); };
+ warn $@ if $@;
+ }
+
+ if (defined($format) && ($format eq 'subvol')) {
File::Path::remove_tree($path);
} else {
return undef;
}
- if ($isBase) {
- # try to remove immutable flag
- eval { run_command(['/usr/bin/chattr', '-i', $path]); };
- warn $@ if $@;
- }
-
unlink($path) || die "unlink '$path' failed - $!\n";
}
return undef;
}
+sub storage_can_replicate {
+ my ($class, $scfg, $storeid, $format) = @_;
+
+ return 0;
+}
+
sub volume_has_feature {
my ($class, $scfg, $feature, $storeid, $volname, $snapname, $running) = @_;
return ($res->{total}, $res->{avail}, $res->{used}, 1);
}
+sub volume_snapshot_list {
+ my ($class, $scfg, $storeid, $volname) = @_;
+
+ # implement in subclass
+ die "Volume_snapshot_list is not implemented for $class";
+
+ # return an empty array if dataset does not exist.
+}
+
sub activate_storage {
my ($class, $storeid, $scfg, $cache) = @_;
die "storage definintion has no path\n" if !$path;
- die "unable to activate storage '$storeid' - " .
- "directory '$path' does not exist\n" if ! -d $path;
+ # this path test may hang indefinitely on unresponsive mounts
+ my $timeout = 2;
+ if (! PVE::Tools::run_fork_with_timeout($timeout, sub {-d $path})) {
+ die "unable to activate storage '$storeid' - " .
+ "directory '$path' does not exist or is unreachable\n";
+ }
+
+
+ return if defined($scfg->{mkdir}) && !$scfg->{mkdir};
if (defined($scfg->{content})) {
foreach my $vtype (keys %$vtype_subdirs) {
return 1;
}
+# Import/Export interface:
+# Any path based storage is assumed to support 'raw' and 'tar' streams, so
+# the default implementations will return this if $scfg->{path} is set,
+# mimicking the old PVE::Storage::storage_migrate() function.
+#
+# Plugins may fall back to PVE::Storage::Plugin::volume_{export,import}...
+# functions in case the format doesn't match their specialized
+# implementations to reuse the raw/tar code.
+#
+# Format specification:
+# The following formats are all prefixed with image information in the form
+# of a 64 bit little endian unsigned integer (pack('Q<')) in order to be able
+# to preallocate the image on storages which require it.
+#
+# raw+size: (image files only)
+# A raw binary data stream such as produced via `dd if=TheImageFile`.
+# qcow2+size, vmdk: (image files only)
+# A raw qcow2/vmdk/... file such as produced via `dd if=some.qcow2` for
+# files which are already in qcow2 format, or via `qemu-img convert`.
+# Note that these formats are only valid with $with_snapshots being true.
+# tar+size: (subvolumes only)
+# A GNU tar stream containing just the inner contents of the subvolume.
+# This does not distinguish between the contents of a privileged or
+# unprivileged container. In other words, this is from the root user
+# namespace's point of view with no uid-mapping in effect.
+# As produced via `tar -C vm-100-disk-1.subvol -cpf TheOutputFile.dat .`
+
+# Plugins may reuse these helpers. Changes to the header format should be
+# reflected by changes to the function prototypes.
+sub write_common_header($$) {
+ my ($fh, $image_size_in_bytes) = @_;
+ syswrite($fh, pack("Q<", $image_size_in_bytes), 8);
+}
+
+sub read_common_header($) {
+ my ($fh) = @_;
+ sysread($fh, my $size, 8);
+ $size = unpack('Q<', $size);
+ die "got a bad size (not a multiple of 1K)\n" if ($size&1023);
+ # Size is in bytes!
+ return $size;
+}
+
+# Export a volume into a file handle as a stream of desired format.
+sub volume_export {
+ my ($class, $scfg, $storeid, $fh, $volname, $format, $snapshot, $base_snapshot, $with_snapshots) = @_;
+ if ($scfg->{path} && !defined($snapshot) && !defined($base_snapshot)) {
+ my $file = $class->path($scfg, $volname, $storeid)
+ or goto unsupported;
+ my ($size, $file_format) = file_size_info($file);
+
+ if ($format eq 'raw+size') {
+ goto unsupported if $with_snapshots || $file_format eq 'subvol';
+ write_common_header($fh, $size);
+ if ($file_format eq 'raw') {
+ run_command(['dd', "if=$file", "bs=4k"], output => '>&'.fileno($fh));
+ } else {
+ run_command(['qemu-img', 'convert', '-f', $file_format, '-O', 'raw', $file, '/dev/stdout'],
+ output => '>&'.fileno($fh));
+ }
+ return;
+ } elsif ($format =~ /^(qcow2|vmdk)\+size$/) {
+ my $data_format = $1;
+ goto unsupported if !$with_snapshots || $file_format ne $data_format;
+ write_common_header($fh, $size);
+ run_command(['dd', "if=$file", "bs=4k"], output => '>&'.fileno($fh));
+ return;
+ } elsif ($format eq 'tar+size') {
+ goto unsupported if $file_format ne 'subvol';
+ write_common_header($fh, $size);
+ run_command(['tar', @COMMON_TAR_FLAGS, '-cf', '-', '-C', $file, '.'],
+ output => '>&'.fileno($fh));
+ return;
+ }
+ }
+ unsupported:
+ die "volume export format $format not available for $class";
+}
+
+sub volume_export_formats {
+ my ($class, $scfg, $storeid, $volname, $snapshot, $base_snapshot, $with_snapshots) = @_;
+ if ($scfg->{path} && !defined($snapshot) && !defined($base_snapshot)) {
+ my $file = $class->path($scfg, $volname, $storeid)
+ or return;
+ my ($size, $format) = file_size_info($file);
+
+ if ($with_snapshots) {
+ return ($format.'+size') if ($format eq 'qcow2' || $format eq 'vmdk');
+ return ();
+ }
+ return ('tar+size') if $format eq 'subvol';
+ return ('raw+size');
+ }
+ return ();
+}
+
+# Import data from a stream, creating a new or replacing or adding to an existing volume.
+sub volume_import {
+ my ($class, $scfg, $storeid, $fh, $volname, $format, $base_snapshot, $with_snapshots) = @_;
+
+ die "volume import format '$format' not available for $class\n"
+ if $format !~ /^(raw|tar|qcow2|vmdk)\+size$/;
+ my $data_format = $1;
+
+ die "format $format cannot be imported without snapshots\n"
+ if !$with_snapshots && ($data_format eq 'qcow2' || $data_format eq 'vmdk');
+ die "format $format cannot be imported with snapshots\n"
+ if $with_snapshots && ($data_format eq 'raw' || $data_format eq 'tar');
+
+ my ($vtype, $name, $vmid, $basename, $basevmid, $isBase, $file_format) =
+ $class->parse_volname($volname);
+
+ # XXX: Should we bother with conversion routines at this level? This won't
+ # happen without manual CLI usage, so for now we just error out...
+ die "cannot import format $format into a file of format $file_format\n"
+ if $data_format ne $file_format && !($data_format eq 'tar' && $file_format eq 'subvol');
+
+ # Check for an existing file first since interrupting alloc_image doesn't
+ # free it.
+ my $file = $class->path($scfg, $volname, $storeid);
+ die "file '$file' already exists\n" if -e $file;
+
+ my ($size) = read_common_header($fh);
+ $size = int($size/1024);
+
+ eval {
+ my $allocname = $class->alloc_image($storeid, $scfg, $vmid, $file_format, $name, $size);
+ if ($allocname ne $volname) {
+ my $oldname = $volname;
+ $volname = $allocname; # Let the cleanup code know what to free
+ die "internal error: unexpected allocated name: '$allocname' != '$oldname'\n";
+ }
+ my $file = $class->path($scfg, $volname, $storeid)
+ or die "internal error: failed to get path to newly allocated volume $volname\n";
+ if ($data_format eq 'raw' || $data_format eq 'qcow2' || $data_format eq 'vmdk') {
+ run_command(['dd', "of=$file", 'conv=sparse', 'bs=64k'],
+ input => '<&'.fileno($fh));
+ } elsif ($data_format eq 'tar') {
+ run_command(['tar', @COMMON_TAR_FLAGS, '-C', $file, '-xf', '-'],
+ input => '<&'.fileno($fh));
+ } else {
+ die "volume import format '$format' not available for $class";
+ }
+ };
+ if (my $err = $@) {
+ eval { $class->free_image($storeid, $scfg, $volname, 0, $file_format) };
+ warn $@ if $@;
+ die $err;
+ }
+}
+
+sub volume_import_formats {
+ my ($class, $scfg, $storeid, $volname, $base_snapshot, $with_snapshots) = @_;
+ if ($scfg->{path} && !defined($base_snapshot)) {
+ my $format = ($class->parse_volname($volname))[6];
+ if ($with_snapshots) {
+ return ($format.'+size') if ($format eq 'qcow2' || $format eq 'vmdk');
+ return ();
+ }
+ return ('tar+size') if $format eq 'subvol';
+ return ('raw+size');
+ }
+ return ();
+}
1;
projects / pve-storage.git / blobdiff