]> git.proxmox.com Git - pve-storage.git/blobdiff - PVE/Storage/Plugin.pm
Allow passing options to volume_has_feature
[pve-storage.git] / PVE / Storage / Plugin.pm
index 7bde330c6a0a96a4e0c6fa234ccf0299ebb576f2..8c0dae1e09222426e12239e26a6551222465536f 100644 (file)
@@ -2,16 +2,41 @@ package PVE::Storage::Plugin;
 
 use strict;
 use warnings;
+
+use Fcntl ':mode';
 use File::chdir;
 use File::Path;
+use File::Basename;
+use Time::Local qw(timelocal);
+
 use PVE::Tools qw(run_command);
 use PVE::JSONSchema qw(get_standard_option);
 use PVE::Cluster qw(cfs_register_file);
 
-use Data::Dumper;
+use JSON;
 
 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',
+    'iscsidirect',
+    'glusterfs',
+    'zfs',
+    'drbd');
+
+our $MAX_VOLUMES_PER_GUEST = 1024;
+
 cfs_register_file ('storage.cfg',
                   sub { __PACKAGE__->parse_config(@_); },
                   sub { __PACKAGE__->write_config(@_); });
@@ -122,7 +147,7 @@ PVE::JSONSchema::register_format('pve-storage-vgname', \&parse_lvm_name);
 sub parse_lvm_name {
     my ($name, $noerr) = @_;
 
-    if ($name !~ m/^[a-z][a-z0-9\-\_\.]*[a-z0-9]$/i) {
+    if ($name !~ m/^[a-z0-9][a-z0-9\-\_\.]*[a-z0-9]$/i) {
        return undef if $noerr;
        die "lvm name '$name' contains illegal characters\n";
     }
@@ -305,7 +330,7 @@ sub parse_config {
            priority => 0, # force first entry
            path => '/var/lib/vz',
            maxfiles => 0,
-           content => { images => 1, rootdir => 1, vztmpl => 1, iso => 1},
+           content => { images => 1, rootdir => 1, vztmpl => 1, iso => 1, snippets => 1},
        };
     }
 
@@ -324,8 +349,7 @@ sub parse_config {
        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;
        }
     }
@@ -335,6 +359,35 @@ sub parse_config {
 
 # 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 storage configuration update (before the updated storage config got written)
+# die to abort the update if there are (grave) problems
+# NOTE: runs in a storage config *locked* context
+sub on_update_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) = @_;
 
@@ -375,7 +428,7 @@ sub parse_volname {
        my ($vmid, $name) = ($1, $2);
        my (undef, $format, $isBase) = parse_name_dir($name);
        return ('images', $name, $vmid, undef, undef, $isBase, $format);
-    } elsif ($volname =~ m!^iso/([^/]+\.[Ii][Ss][Oo])$!) {
+    } elsif ($volname =~ m!^iso/([^/]+$PVE::Storage::iso_extension_re)$!) {
        return ('iso', $1);
     } elsif ($volname =~ m!^vztmpl/([^/]+\.tar\.[gx]z)$!) {
        return ('vztmpl', $1);
@@ -387,6 +440,8 @@ sub parse_volname {
            return ('backup', $fn, $2);
        }
        return ('backup', $fn);
+    } elsif ($volname =~ m!^snippets/([^/]+)$!) {
+       return ('snippets', $1);
     }
 
     die "unable to parse directory volume name '$volname'\n";
@@ -398,6 +453,7 @@ my $vtype_subdirs = {
     iso => 'template/iso',
     vztmpl => 'template/cache',
     backup => 'dump',
+    snippets => 'snippets',
 };
 
 sub get_subdir {
@@ -485,25 +541,57 @@ sub create_base {
     return $newvolname;
 }
 
-my $find_free_diskname = sub {
-    my ($imgdir, $vmid, $fmt) = @_;
+my $get_vm_disk_number = sub {
+    my ($disk_name, $scfg, $vmid, $suffix) = @_;
+
+    my $disk_regex = qr/(vm|base)-$vmid-disk-(\d+)$suffix/;
+
+    my $type = $scfg->{type};
+    my $def = { %{$defaultData->{plugindata}->{$type}} };
+
+    my $valid = $def->{format}[0];
+    if ($valid->{subvol}) {
+       $disk_regex = qr/(vm|base|subvol|basevol)-$vmid-disk-(\d+)/;
+    }
+
+    if ($disk_name =~ m/$disk_regex/) {
+       return $2;
+    }
+
+    return undef;
+};
+
+sub get_next_vm_diskname {
+    my ($disk_list, $storeid, $vmid, $fmt, $scfg, $add_fmt_suffix) = @_;
+
+    $fmt //= '';
+    my $prefix = ($fmt eq 'subvol') ? 'subvol' : 'vm';
+    my $suffix = $add_fmt_suffix ? ".$fmt" : '';
 
     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++) {
+    foreach my $disk (@$disk_list) {
+       my $disknum = $get_vm_disk_number->($disk, $scfg, $vmid, $suffix);
+       $disk_ids->{$disknum} = 1 if defined($disknum);
+    }
+
+    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"
+}
+
+sub find_free_diskname {
+    my ($class, $storeid, $scfg, $vmid, $fmt, $add_fmt_suffix) = @_;
+
+    my $disks = $class->list_images($storeid, $scfg, $vmid);
+
+    my $disk_list = [ map { $_->{volid} } @$disks ];
+
+    return get_next_vm_diskname($disk_list, $storeid, $vmid, $fmt, $scfg, $add_fmt_suffix);
+}
 
 sub clone_image {
     my ($class, $scfg, $storeid, $volname, $vmid, $snap) = @_;
@@ -527,7 +615,7 @@ sub clone_image {
 
     mkpath $imagedir;
 
-    my $name = &$find_free_diskname($imagedir, $vmid, "qcow2");
+    my $name = $class->find_free_diskname($imagedir, $scfg, $vmid, "qcow2", 1);
 
     warn "clone $volname: $vtype, $name, $vmid to $name (base=../$basevmid/$basename)\n";
 
@@ -559,7 +647,7 @@ sub alloc_image {
 
     mkpath $imagedir;
 
-    $name = &$find_free_diskname($imagedir, $vmid, $fmt) if !$name;
+    $name = $class->find_free_diskname($imagedir, $scfg, $vmid, $fmt, 1) if !$name;
 
     my (undef, $tmpfmt) = parse_name_dir($name);
 
@@ -573,7 +661,7 @@ sub alloc_image {
     if ($fmt eq 'subvol') {
        # only allow this if size = 0, so that user knows what he is doing
        die "storage does not support subvol quotas\n" if $size != 0;
-       
+
        my $old_umask = umask(0022);
        my $err;
        mkdir($path) or $err = "unable to create subvol '$path' - $!\n";
@@ -583,12 +671,17 @@ sub alloc_image {
        my $cmd = ['/usr/bin/qemu-img', 'create'];
 
        push @$cmd, '-o', 'preallocation=metadata' if $fmt eq 'qcow2';
-       
+
        push @$cmd, '-f', $fmt, $path, "${size}K";
 
-       run_command($cmd, errmsg => "unable to create image");
+       eval { run_command($cmd, errmsg => "unable to create image"); };
+       if ($@) {
+           unlink $path;
+           rmdir $imagedir;
+           die "$@";
+       }
     }
-    
+
     return "$vmid/$name";
 }
 
@@ -606,56 +699,49 @@ sub free_image {
     if (defined($format) && ($format eq 'subvol')) {
        File::Path::remove_tree($path);
     } else {
-    
-       if (! -f $path) {
-           warn "disk image '$path' does not exists\n";
+       if (!(-f $path || -l $path)) {
+           warn "disk image '$path' does not exist\n";
            return undef;
        }
 
        unlink($path) || die "unlink '$path' failed - $!\n";
     }
-    
+
+    # try to cleanup directory to not clutter storage with empty $vmid dirs if
+    # all images from a guest got deleted
+    my $dir = dirname($path);
+    rmdir($dir);
+
     return undef;
 }
 
 sub file_size_info {
     my ($filename, $timeout) = @_;
 
-    if (-d $filename) {
-       return wantarray ? (0, 'subvol', 0, undef) : 1;
-    }
-    
-    my $cmd = ['/usr/bin/qemu-img', 'info', $filename];
+    my @fs = stat($filename);
+    my $mode = $fs[2];
+    my $ctime = $fs[10];
 
-    my $format;
-    my $parent;
-    my $size = 0;
-    my $used = 0;
+    if (S_ISDIR($mode)) {
+       return wantarray ? (0, 'subvol', 0, undef, $ctime) : 1;
+    }
 
+    my $json = '';
     eval {
-       run_command($cmd, timeout => $timeout, outfunc => sub {
-           my $line = shift;
-           if ($line =~ m/^file format:\s+(\S+)\s*$/) {
-               $format = $1;
-           } elsif ($line =~ m/^backing file:\s(\S+)\s/) {
-               $parent = $1;
-           } elsif ($line =~ m/^virtual size:\s\S+\s+\((\d+)\s+bytes\)$/) {
-               $size = int($1);
-           } elsif ($line =~ m/^disk size:\s+(\d+(.\d+)?)([KMGT])\s*$/) {
-               $used = $1;
-               my $u = $3;
-
-               $used *= 1024 if $u eq 'K';
-               $used *= (1024*1024) if $u eq 'M';
-               $used *= (1024*1024*1024) if $u eq 'G';
-               $used *= (1024*1024*1024*1024) if $u eq 'T';
-
-               $used = int($used);
-           }
-       });
+       run_command(['/usr/bin/qemu-img', 'info', '--output=json', $filename],
+           timeout => $timeout,
+           outfunc => sub { $json .= shift },
+           errfunc => sub { warn "$_[0]\n" }
+       );
     };
+    warn $@ if $@;
+
+    my $info = eval { decode_json($json) };
+    warn "could not parse qemu-img info command output for '$filename'\n" if $@;
 
-    return wantarray ? ($size, $format, $used, $parent) : $size;
+    my ($size, $format, $used, $parent) = $info->@{qw(virtual-size format actual-size backing-filename)};
+
+    return wantarray ? ($size, $format, $used, $parent, $ctime) : $size;
 }
 
 sub volume_size_info {
@@ -698,9 +784,9 @@ sub volume_snapshot {
 }
 
 sub volume_rollback_is_possible {
-    my ($class, $scfg, $storeid, $volname, $snap) = @_; 
+    my ($class, $scfg, $storeid, $volname, $snap) = @_;
 
-    return 1; 
+    return 1;
 }
 
 sub volume_snapshot_rollback {
@@ -735,8 +821,14 @@ sub volume_snapshot_delete {
     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) = @_;
+    my ($class, $scfg, $feature, $storeid, $volname, $snapname, $running, $opts) = @_;
 
     my $features = {
        snapshot => { current => { qcow2 => 1}, snap => { qcow2 => 1} },
@@ -749,6 +841,11 @@ sub volume_has_feature {
                        current => {qcow2 => 1, raw => 1, vmdk => 1} },
     };
 
+    # clone_image creates a qcow2 volume
+    return 0 if $feature eq 'clone' &&
+               defined($opts->{valid_target_formats}) &&
+               !(grep { $_ eq 'qcow2' } @{$opts->{valid_target_formats}});
+
     my ($vtype, $name, $vmid, $basename, $basevmid, $isBase, $format) =
        $class->parse_volname($volname);
 
@@ -784,7 +881,7 @@ sub list_images {
 
        next if !$vollist && defined($vmid) && ($owner ne $vmid);
 
-       my ($size, $format, $used, $parent) = file_size_info($fn);
+       my ($size, $format, $used, $parent, $ctime) = file_size_info($fn);
        next if !($format && defined($size));
 
        my $volid;
@@ -800,10 +897,135 @@ sub list_images {
            next if !$found;
        }
 
-       push @$res, {
+        my $info = {
            volid => $volid, format => $format,
            size => $size, vmid => $owner, used => $used, parent => $parent
        };
+
+        $info->{ctime} = $ctime if $ctime;
+
+        push @$res, $info;
+    }
+
+    return $res;
+}
+
+# list templates ($tt = <iso|vztmpl|backup|snippets>)
+my $get_subdir_files = sub {
+    my ($sid, $path, $tt, $vmid) = @_;
+
+    my $res = [];
+
+    foreach my $fn (<$path/*>) {
+
+       my ($dev,
+           $ino,
+           $mode,
+           $nlink,
+           $uid,
+           $gid,
+           $rdev,
+           $size,
+           $atime,
+           $mtime,
+           $ctime,
+           $blksize,
+           $blocks
+       ) = stat($fn);
+
+       next if S_ISDIR($mode);
+
+       my $info;
+
+       if ($tt eq 'iso') {
+           next if $fn !~ m!/([^/]+$PVE::Storage::iso_extension_re)$!i;
+
+           $info = { volid => "$sid:iso/$1", format => 'iso' };
+
+       } elsif ($tt eq 'vztmpl') {
+           next if $fn !~ m!/([^/]+\.tar\.([gx]z))$!;
+
+           $info = { volid => "$sid:vztmpl/$1", format => "t$2" };
+
+       } elsif ($tt eq 'backup') {
+           next if defined($vmid) && $fn !~  m/\S+-$vmid-\S+/;
+           next if $fn !~ m!/([^/]+\.(tar|tar\.gz|tar\.lzo|tgz|vma|vma\.gz|vma\.lzo))$!;
+
+           my $format = $2;
+           $info = { volid => "$sid:backup/$1", format => $format };
+
+           if ($fn =~ m!^vzdump\-(?:lxc|qemu)\-(?:[1-9][0-9]{2,8})\-(\d{4})_(\d{2})_(\d{2})\-(\d{2})_(\d{2})_(\d{2})\.${format}$!) {
+               my $epoch = timelocal($6, $5, $4, $3, $2-1, $1 - 1900);
+               $info->{ctime} = $epoch;
+           }
+
+           if (defined($vmid) || $fn =~ m!\-([1-9][0-9]{2,8})\-[^/]+\.${format}$!) {
+               $info->{vmid} = $vmid // $1;
+           }
+
+
+       } elsif ($tt eq 'snippets') {
+
+           $info = {
+               volid => "$sid:snippets/". basename($fn),
+               format => 'snippet',
+           };
+       }
+
+       $info->{size} = $size;
+       $info->{ctime} //= $ctime;
+
+       push @$res, $info;
+    }
+
+    return $res;
+};
+
+sub list_volumes {
+    my ($class, $storeid, $scfg, $vmid, $content_types) = @_;
+
+    my $res = [];
+    my $vmlist = PVE::Cluster::get_vmlist();
+    foreach my $type (@$content_types) {
+       my $data;
+
+       if ($type eq 'images' || $type eq 'rootdir') {
+           $data = $class->list_images($storeid, $scfg, $vmid);
+       } elsif ($scfg->{path}) {
+           my $path = $class->get_subdir($scfg, $type);
+
+           if ($type eq 'iso' && !defined($vmid)) {
+               $data = $get_subdir_files->($storeid, $path, 'iso');
+           } elsif ($type eq 'vztmpl'&& !defined($vmid)) {
+               $data = $get_subdir_files->($storeid, $path, 'vztmpl');
+           } elsif ($type eq 'backup') {
+               $data = $get_subdir_files->($storeid, $path, 'backup', $vmid);
+           } elsif ($type eq 'snippets') {
+               $data = $get_subdir_files->($storeid, $path, 'snippets');
+           }
+       }
+
+       next if !$data;
+
+       foreach my $item (@$data) {
+           if ($type eq 'images' || $type eq 'rootdir') {
+               my $vminfo = $vmlist->{ids}->{$item->{vmid}};
+               my $vmtype;
+               if (defined($vminfo)) {
+                   $vmtype = $vminfo->{type};
+               }
+               if (defined($vmtype) && $vmtype eq 'lxc') {
+                   $item->{content} = 'rootdir';
+               } else {
+                   $item->{content} = 'images';
+               }
+               next if $type ne $item->{content};
+           } else {
+               $item->{content} = $type;
+           }
+
+           push @$res, $item;
+       }
     }
 
     return $res;
@@ -840,8 +1062,13 @@ sub activate_storage {
 
     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};
 
@@ -863,6 +1090,19 @@ sub deactivate_storage {
     # do nothing by default
 }
 
+sub map_volume {
+    my ($class, $storeid, $scfg, $volname, $snapname) = @_;
+
+    my ($path) = $class->path($scfg, $volname, $storeid, $snapname);
+    return $path;
+}
+
+sub unmap_volume {
+    my ($class, $storeid, $scfg, $volname, $snapname) = @_;
+
+    return 1;
+}
+
 sub activate_volume {
     my ($class, $storeid, $scfg, $volname, $snapname, $cache) = @_;
 
@@ -909,8 +1149,11 @@ sub check_connection {
 #     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 with the inner contents of the subvolume put into the
-#     'subvol/' directory.
+#     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.
@@ -923,7 +1166,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);
+    die "import: no size found in export header, aborting.\n" if !defined($size);
+    die "import: got a bad size (not a multiple of 1K), aborting.\n" if ($size&1023);
     # Size is in bytes!
     return $size;
 }
@@ -955,7 +1199,7 @@ sub volume_export {
        } elsif ($format eq 'tar+size') {
            goto unsupported if $file_format ne 'subvol';
            write_common_header($fh, $size);
-           run_command(['tar', '--xform=s,^\./,subvol/,S', '-cf', '-', '-C', $file, '.'],
+           run_command(['tar', @COMMON_TAR_FLAGS, '-cf', '-', '-C', $file, '.'],
                        output => '>&'.fileno($fh));
            return;
        }
@@ -1023,7 +1267,7 @@ sub volume_import {
            run_command(['dd', "of=$file", 'conv=sparse', 'bs=64k'],
                        input => '<&'.fileno($fh));
        } elsif ($data_format eq 'tar') {
-           run_command(['tar', '-C', $file, '--xform=s,^subvol/,./,S', '-xf', '-'],
+           run_command(['tar', @COMMON_TAR_FLAGS, '-C', $file, '-xf', '-'],
                        input => '<&'.fileno($fh));
        } else {
            die "volume import format '$format' not available for $class";