]> git.proxmox.com Git - pve-storage.git/blobdiff - PVE/Storage.pm
api: add import/export format querying
[pve-storage.git] / PVE / Storage.pm
index 907e3b39903dd9d9b0c7650fa7cb1eba0c39abdf..26215f1264d98e61337f76f64ac8e36c8519547b 100755 (executable)
@@ -12,7 +12,7 @@ use File::Path;
 use Cwd 'abs_path';
 use Socket;
 
-use PVE::Tools qw(run_command file_read_firstline $IPV6RE);
+use PVE::Tools qw(run_command file_read_firstline dir_glob_foreach $IPV6RE);
 use PVE::Cluster qw(cfs_read_file cfs_write_file cfs_lock_file);
 use PVE::Exception qw(raise_param_exc);
 use PVE::JSONSchema;
@@ -33,7 +33,10 @@ use PVE::Storage::ZFSPoolPlugin;
 use PVE::Storage::ZFSPlugin;
 use PVE::Storage::DRBDPlugin;
 
-# load and initialize all plugins
+# Storage API version. Icrement it on changes in storage API interface.
+use constant APIVER => 1;
+
+# load standard plugins
 PVE::Storage::DirPlugin->register();
 PVE::Storage::LVMPlugin->register();
 PVE::Storage::LvmThinPlugin->register();
@@ -46,6 +49,34 @@ PVE::Storage::GlusterfsPlugin->register();
 PVE::Storage::ZFSPoolPlugin->register();
 PVE::Storage::ZFSPlugin->register();
 PVE::Storage::DRBDPlugin->register();
+
+# load third-party plugins
+if ( -d '/usr/share/perl5/PVE/Storage/Custom' ) {
+    dir_glob_foreach('/usr/share/perl5/PVE/Storage/Custom', '.*\.pm$', sub {
+       my ($file) = @_;
+       my $modname = 'PVE::Storage::Custom::' . $file;
+       $modname =~ s!\.pm$!!;
+       $file = 'PVE/Storage/Custom/' . $file;
+
+       eval {
+           require $file;
+       };
+       if ($@) {
+           warn $@;
+       # Check storage API version and that file is really storage plugin.
+       } elsif ($modname->isa('PVE::Storage::Plugin') && $modname->can('api') && $modname->api() == APIVER) {
+            eval {
+               import $file;
+               $modname->register();
+            };
+            warn $@ if $@;
+       } else {
+           warn "Error loading storage plugin \"$modname\" because of API version mismatch. Please, update it.\n"
+       }
+    });
+}
+
+# initialize all plugins
 PVE::Storage::Plugin->init();
 
 my $UDEVADM = '/sbin/udevadm';
@@ -75,7 +106,7 @@ sub lock_storage_config {
 sub storage_config {
     my ($cfg, $storeid, $noerr) = @_;
 
-    die "no storage id specified\n" if !$storeid;
+    die "no storage ID specified\n" if !$storeid;
 
     my $scfg = $cfg->{ids}->{$storeid};
 
@@ -231,6 +262,23 @@ sub volume_has_feature {
     }
 }
 
+sub volume_snapshot_list {
+    my ($cfg, $volid, $prefix) = @_;
+
+    my ($storeid, $volname) = parse_volume_id($volid, 1);
+    if ($storeid) {
+       my $scfg = storage_config($cfg, $storeid);
+       my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
+       return $plugin->volume_snapshot_list($scfg, $storeid, $volname, $prefix);
+    } elsif ($volid =~ m|^(/.+)$| && -e $volid) {
+       die "send file/device '$volid' is not possible\n";
+    } else {
+       die "unable to parse volume ID '$volid'\n";
+    }
+    # return an empty array if dataset does not exist.
+    # youngest snap first
+}
+
 sub get_image_dir {
     my ($cfg, $storeid, $vmid) = @_;
 
@@ -290,6 +338,9 @@ sub parse_vmid {
     return int($vmid);
 }
 
+# NOTE: basename and basevmid are always undef for LVM-thin, where the
+# clone -> base reference is not encoded in the volume ID.
+# see note in PVE::Storage::LvmThinPlugin for details.
 sub parse_volname {
     my ($cfg, $volid) = @_;
 
@@ -310,25 +361,71 @@ sub parse_volume_id {
     return PVE::Storage::Plugin::parse_volume_id($volid, $noerr);
 }
 
-sub volume_is_base {
-    my ($cfg, $volid) = @_;
+# test if we have read access to volid
+sub check_volume_access {
+    my ($rpcenv, $user, $cfg, $vmid, $volid) = @_;
 
     my ($sid, $volname) = parse_volume_id($volid, 1);
-    return 0 if !$sid;
-
-    if (my $scfg = $cfg->{ids}->{$sid}) {
-       my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
-       my ($vtype, $name, $vmid, $basename, $basevmid, $isBase) =
-           $plugin->parse_volname($volname);
-       return $isBase ? 1 : 0;
-    } else {
-       # stale volid with undefined storage - so we can just guess
-       if ($volid =~ m/base-/) {
-           return 1;
+    if ($sid) {
+       my ($vtype, undef, $ownervm) = parse_volname($cfg, $volid);
+       if ($vtype eq 'iso' || $vtype eq 'vztmpl') {
+           # we simply allow access
+       } elsif (defined($ownervm) && defined($vmid) && ($ownervm == $vmid)) {
+           # we are owner - allow access
+       } elsif ($vtype eq 'backup' && $ownervm) {
+           $rpcenv->check($user, "/storage/$sid", ['Datastore.AllocateSpace']);
+           $rpcenv->check($user, "/vms/$ownervm", ['VM.Backup']);
+       } else {
+           # allow if we are Datastore administrator
+           $rpcenv->check($user, "/storage/$sid", ['Datastore.Allocate']);
        }
+    } else {
+       die "Only root can pass arbitrary filesystem paths."
+           if $user ne 'root@pam';
     }
 
+    return undef;
+}
+
+my $volume_is_base_and_used__no_lock = sub {
+    my ($scfg, $storeid, $plugin, $volname) = @_;
+
+    my ($vtype, $name, $vmid, undef, undef, $isBase, undef) =
+       $plugin->parse_volname($volname);
+
+    if ($isBase) {
+       my $vollist = $plugin->list_images($storeid, $scfg);
+       foreach my $info (@$vollist) {
+           my (undef, $tmpvolname) = parse_volume_id($info->{volid});
+           my $basename = undef;
+           my $basevmid = undef;
+
+           eval{
+               (undef, undef, undef, $basename, $basevmid) =
+                   $plugin->parse_volname($tmpvolname);
+           };
+
+           if ($basename && defined($basevmid) && $basevmid == $vmid && $basename eq $name) {
+               return 1;
+           }
+       }
+    }
     return 0;
+};
+
+# NOTE: this check does not work for LVM-thin, where the clone -> base
+# reference is not encoded in the volume ID.
+# see note in PVE::Storage::LvmThinPlugin for details.
+sub volume_is_base_and_used {
+    my ($cfg, $volid) = @_;
+
+    my ($storeid, $volname) = parse_volume_id($volid);
+    my $scfg = storage_config($cfg, $storeid);
+    my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
+
+    $plugin->cluster_lock_storage($storeid, $scfg->{shared}, undef, sub {
+       return &$volume_is_base_and_used__no_lock($scfg, $storeid, $plugin, $volname);
+    });
 }
 
 # try to map a filesystem path to a volume identifier
@@ -428,7 +525,7 @@ sub abs_filesystem_path {
 }
 
 sub storage_migrate {
-    my ($cfg, $volid, $target_host, $target_storeid, $target_volname) = @_;
+    my ($cfg, $volid, $target_host, $target_storeid, $target_volname, $base_snapshot) = @_;
 
     my ($storeid, $volname) = parse_volume_id($volid);
     $target_volname = $volname if !$target_volname;
@@ -449,10 +546,17 @@ sub storage_migrate {
 
     local $ENV{RSYNC_RSH} = $ssh;
 
+    my $no_incremental = sub {
+       my ($type) = @_;
+       die "incremental migration not supported on storage type $type\n"
+           if defined($base_snapshot);
+    };
+
     # only implemented for file system based storage
     if ($scfg->{path}) {
-       if ($tcfg->{path}) {
+       $no_incremental->($scfg->{type});
 
+       if ($tcfg->{path}) {
            my $src_plugin = PVE::Storage::Plugin->lookup($scfg->{type});
            my $dst_plugin = PVE::Storage::Plugin->lookup($tcfg->{type});
            my $src = $src_plugin->path($scfg, $volname, $storeid);
@@ -515,65 +619,68 @@ sub storage_migrate {
 
        if ($tcfg->{type} eq 'zfspool') {
 
-           die "$errstr - pool on target has not same name as source!"
+           die "$errstr - pool on target does not have the same name as on source!"
                if $tcfg->{pool} ne $scfg->{pool};
 
            my (undef, $volname) = parse_volname($cfg, $volid);
-
            my $zfspath = "$scfg->{pool}\/$volname";
 
-           my $snap = ['zfs', 'snapshot', "$zfspath\@__migration__"];
+           my $send = ['pvesm', 'export', $volid, 'zfs', '-', '-snapshot', '__migration__', '-with-snapshots', '1'];
+           my $recv = ['ssh', "root\@$target_host", '--', 'pvesm', 'import', $volid, 'zfs', '-', '-with-snapshots', '1'];
+           my $free = ['ssh', "root\@$target_host", '--', 'pvesm', 'free', $volid, '-snapshot', '__migration__'];
 
-           my $send = [['zfs', 'send', '-Rpv', "$zfspath\@__migration__"], ['ssh', "root\@$target_host",
-                       'zfs', 'recv', $zfspath]];
+           if (defined($base_snapshot)) {
+               # Check if the snapshot exists on the remote side:
+               push @$send, '-snapshot', $base_snapshot;
+               push @$recv, '-base', $base_snapshot;
+           }
 
-           my $destroy_target = ['ssh', "root\@$target_host", 'zfs', 'destroy', "$zfspath\@__migration__"];
-           run_command($snap);
+           volume_snapshot($cfg, $volid, '__migration__');
            eval{
-               run_command($send);
+               run_command([$send, $recv]);
            };
-           my $err;
-           if ($err = $@){
-               run_command(['zfs', 'destroy', "$zfspath\@__migration__"]);
-               die $err;
-           }
-           run_command($destroy_target);
-
+           my $err = $@;
+           warn "send/receive failed, cleaning up snapshot(s)..\n" if $err;
+           eval { volume_snapshot_delete($cfg, $volid, '__migration__', 0) };
+           warn "could not remove source snapshot: $@\n" if $@;
+           eval { run_command($free) };
+           warn "could not remove target snapshot: $@\n" if $@;
+           die $err if $err;
        } else {
            die "$errstr - target type $tcfg->{type} is not valid\n";
        }
 
     } elsif ($scfg->{type} eq 'lvmthin' || $scfg->{type} eq 'lvm') {
+       $no_incremental->($scfg->{type});
 
-       if ($tcfg->{type} eq 'lvmthin' || $tcfg->{type} eq 'lvm') {
-
-           die "$errstr - pool on target has not same name as source!"
-               if $tcfg->{type} ne $scfg->{type};
+       if (($scfg->{type} eq $tcfg->{type}) &&
+           ($tcfg->{type} eq 'lvmthin' || $tcfg->{type} eq 'lvm')) {
 
-           my (undef, $volname) = parse_volname($cfg, $volid);
+           my (undef, $volname, $vmid) = parse_volname($cfg, $volid);
            my $size = volume_size_info($cfg, $volid, 5);
-           my $path = path($cfg, $volid);
-
-           $volname =~ m/^vm-(\d+)-/;
-           my $vmid = $1;
+           my $src = path($cfg, $volid);
+           my $dst = path($cfg, $target_volid);
 
            run_command(['/usr/bin/ssh', "root\@${target_host}",
                         'pvesm', 'alloc', $target_storeid, $vmid,
-                        $volname, $size/1024]);
+                         $target_volname, int($size/1024)]);
 
            eval {
-               run_command([["dd", "if=$path"],
-                            ["/usr/bin/ssh", "root\@${target_host}", "-C",
-                             "dd", 'conv=sparse', "of=$path"]]);
+               if ($tcfg->{type} eq 'lvmthin') {
+                   run_command([["dd", "if=$src", "bs=4k"],["/usr/bin/ssh", "root\@${target_host}",
+                             "dd", 'conv=sparse', "of=$dst", "bs=4k"]]);
+               } else {
+                   run_command([["dd", "if=$src", "bs=4k"],["/usr/bin/ssh", "root\@${target_host}",
+                             "dd", "of=$dst", "bs=4k"]]);
+               }
            };
            if (my $err = $@) {
                run_command(['/usr/bin/ssh', "root\@${target_host}",
-                        'pvesm', 'free', $volid]);
-           } else {
-               vdisk_free($cfg, $volid);
+                        'pvesm', 'free', $target_volid]);
+               die $err;
            }
        } else {
-           die "$errstr - target type $tcfg->{type} is not valid\n";
+           die "$errstr - migrate from source type '$scfg->{type}' to '$tcfg->{type}' not implemented\n";
        }
     } else {
        die "$errstr - source type '$scfg->{type}' not implemented\n";
@@ -619,7 +726,7 @@ sub vdisk_create_base {
 sub vdisk_alloc {
     my ($cfg, $storeid, $vmid, $fmt, $name, $size) = @_;
 
-    die "no storage id specified\n" if !$storeid;
+    die "no storage ID specified\n" if !$storeid;
 
     PVE::JSONSchema::parse_storage_id($storeid);
 
@@ -652,9 +759,7 @@ sub vdisk_free {
     my ($cfg, $volid) = @_;
 
     my ($storeid, $volname) = parse_volume_id($volid);
-
     my $scfg = storage_config($cfg, $storeid);
-
     my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
 
     activate_storage($cfg, $storeid);
@@ -663,27 +768,12 @@ sub vdisk_free {
 
     # lock shared storage
     $plugin->cluster_lock_storage($storeid, $scfg->{shared}, undef, sub {
+       # LVM-thin allows deletion of still referenced base volumes!
+       die "base volume '$volname' is still in use by linked clones\n"
+           if &$volume_is_base_and_used__no_lock($scfg, $storeid, $plugin, $volname);
 
-       my ($vtype, $name, $vmid, undef, undef, $isBase, $format) =
+       my (undef, undef, undef, undef, undef, $isBase, $format) =
            $plugin->parse_volname($volname);
-       if ($isBase) {
-           my $vollist = $plugin->list_images($storeid, $scfg);
-           foreach my $info (@$vollist) {
-               my (undef, $tmpvolname) = parse_volume_id($info->{volid});
-               my $basename = undef;
-               my $basevmid = undef;
-
-               eval{
-                   (undef, undef, undef, $basename, $basevmid) =
-                       $plugin->parse_volname($tmpvolname);
-               };
-
-               if ($basename && defined($basevmid) && $basevmid == $vmid && $basename eq $name) {
-                   die "base volume '$volname' is still in use " .
-                       "(use by '$tmpvolname')\n";
-               }
-           }
-       }
        $cleanup_worker = $plugin->free_image($storeid, $scfg, $volname, $isBase, $format);
     });
 
@@ -962,7 +1052,7 @@ sub deactivate_volumes {
        }
     }
 
-    die "volume deativation failed: " . join(' ', @errlist)
+    die "volume deactivation failed: " . join(' ', @errlist)
        if scalar(@errlist);
 }
 
@@ -972,9 +1062,9 @@ sub storage_info {
     my $ids = $cfg->{ids};
 
     my $info = {};
-    
+
     my @ctypes = PVE::Tools::split_list($content);
-    
+
     my $slist = [];
     foreach my $storeid (keys %$ids) {
 
@@ -990,7 +1080,7 @@ sub storage_info {
            }
            next if !$want_ctype;
        }
-       
+
        my $type = $ids->{$storeid}->{type};
 
        $info->{$storeid} = {
@@ -1023,9 +1113,9 @@ sub storage_info {
        eval { ($total, $avail, $used, $active) = $plugin->status($storeid, $scfg, $cache); };
        warn $@ if $@;
        next if !$active;
-       $info->{$storeid}->{total} = $total;
-       $info->{$storeid}->{avail} = $avail;
-       $info->{$storeid}->{used} = $used;
+       $info->{$storeid}->{total} = int($total);
+       $info->{$storeid}->{avail} = int($avail);
+       $info->{$storeid}->{used} = int($used);
        $info->{$storeid}->{active} = $active;
     }
 
@@ -1264,7 +1354,7 @@ sub extract_vzdump_config_tar {
 
     my $file;
     while (defined($file = <$fh>)) {
-       if ($file =~ m!$conf_re!) {
+       if ($file =~ $conf_re) {
            $file = $1; # untaint
            last;
        }
@@ -1332,7 +1422,7 @@ sub extract_vzdump_config_vma {
        my $rerr = $@;
 
        # use exit code if no stderr output and not just broken pipe
-       if (!$errstring && !$broken_pipe && $rc > 0 && $rc != 141) {
+       if (!$errstring && !$broken_pipe && $rc != 0 && $rc != 141) {
            die "$rerr\n" if $rerr;
            die "config extraction failed with exit code $rc\n";
        }
@@ -1350,9 +1440,9 @@ sub extract_vzdump_config {
 
     my $archive = abs_filesystem_path($cfg, $volid);
 
-    if ($volid =~ /\/vzdump-(lxc|openvz)-\d+-(\d{4})_(\d{2})_(\d{2})-(\d{2})_(\d{2})_(\d{2})\.(tgz|(tar(\.(gz|lzo))?))$/) {
-       return extract_vzdump_config_tar($archive,'^(\./etc/vzdump/(pct|vps)\.conf)$');
-    } elsif ($volid =~ /\/vzdump-qemu-\d+-(\d{4})_(\d{2})_(\d{2})-(\d{2})_(\d{2})_(\d{2})\.(tgz|((tar|vma)(\.(gz|lzo))?))$/) {
+    if ($volid =~ /vzdump-(lxc|openvz)-\d+-(\d{4})_(\d{2})_(\d{2})-(\d{2})_(\d{2})_(\d{2})\.(tgz|(tar(\.(gz|lzo))?))$/) {
+       return extract_vzdump_config_tar($archive, qr!^(\./etc/vzdump/(pct|vps)\.conf)$!);
+    } elsif ($volid =~ /vzdump-qemu-\d+-(\d{4})_(\d{2})_(\d{2})-(\d{2})_(\d{2})_(\d{2})\.(tgz|((tar|vma)(\.(gz|lzo))?))$/) {
        my $format;
        my $comp;
        if ($7 eq 'tgz') {
@@ -1373,6 +1463,59 @@ sub extract_vzdump_config {
     }
 }
 
+sub volume_export {
+    my ($cfg, $fh, $volid, $format, $snapshot, $base_snapshot, $with_snapshots) = @_;
+
+    my ($storeid, $volname) = parse_volume_id($volid, 1);
+    die "cannot export volume '$volid'\n" if !$storeid;
+    my $scfg = storage_config($cfg, $storeid);
+    my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
+    return $plugin->volume_export($scfg, $storeid, $fh, $volname, $format,
+                                  $snapshot, $base_snapshot, $with_snapshots);
+}
+
+sub volume_import {
+    my ($cfg, $fh, $volid, $format, $base_snapshot, $with_snapshots) = @_;
+
+    my ($storeid, $volname) = parse_volume_id($volid, 1);
+    die "cannot import into volume '$volid'\n" if !$storeid;
+    my $scfg = storage_config($cfg, $storeid);
+    my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
+    return $plugin->volume_import($scfg, $storeid, $fh, $volname, $format,
+                                  $base_snapshot, $with_snapshots);
+}
+
+sub volume_export_formats {
+    my ($cfg, $volid, $snapshot, $base_snapshot, $with_snapshots) = @_;
+
+    my ($storeid, $volname) = parse_volume_id($volid, 1);
+    return if !$storeid;
+    my $scfg = storage_config($cfg, $storeid);
+    my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
+    return $plugin->volume_export_formats($scfg, $storeid, $volname,
+                                          $base_snapshot, $with_snapshots);
+}
+
+sub volume_import_formats {
+    my ($cfg, $volid, $base_snapshot, $with_snapshots) = @_;
+
+    my ($storeid, $volname) = parse_volume_id($volid, 1);
+    return if !$storeid;
+    my $scfg = storage_config($cfg, $storeid);
+    my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
+    return $plugin->volume_import_formats($scfg, $storeid, $volname,
+                                          $base_snapshot, $with_snapshots);
+}
+
+sub volume_transfer_formats {
+    my ($cfg, $src_volid, $dst_volid, $snapshot, $base_snapshot, $with_snapshots) = @_;
+    my @export_formats = volume_export_formats($cfg, $src_volid, $snapshot, $base_snapshot, $with_snapshots);
+    my @import_formats = volume_import_formats($cfg, $dst_volid, $base_snapshot, $with_snapshots);
+    my %import_hash = map { $_ => 1 } @import_formats;
+    my @common = grep { $import_hash{$_} } @export_formats;
+    return @common;
+}
+
 # bash completion helper
 
 sub complete_storage {