]> git.proxmox.com Git - pve-storage.git/blobdiff - PVE/Storage/ZFSPoolPlugin.pm
pbs: allow setting up a master key
[pve-storage.git] / PVE / Storage / ZFSPoolPlugin.pm
index 4bf6d50c03c379a3afcdb27c515d71d13a5fad6b..2e2abe35ac092a2f60ea1959ab97a0d68799551d 100644 (file)
@@ -2,12 +2,15 @@ package PVE::Storage::ZFSPoolPlugin;
 
 use strict;
 use warnings;
+
 use IO::File;
+use Net::IP;
 use POSIX;
-use PVE::Tools qw(run_command);
-use PVE::Storage::Plugin;
+
+use PVE::ProcFSTools;
 use PVE::RPCEnvironment;
-use Net::IP;
+use PVE::Storage::Plugin;
+use PVE::Tools qw(run_command);
 
 use base qw(PVE::Storage::Plugin);
 
@@ -32,6 +35,10 @@ sub properties {
            description => "use sparse volumes",
            type => 'boolean',
        },
+       mountpoint => {
+           description => "mount point",
+           type => 'string', format => 'pve-storage-path',
+       },
     };
 }
 
@@ -44,47 +51,12 @@ sub options {
        disable => { optional => 1 },
        content => { optional => 1 },
        bwlimit => { optional => 1 },
+       mountpoint => { optional => 1 },
     };
 }
 
 # static zfs helper methods
 
-sub zfs_parse_size {
-    my ($text) = @_;
-
-    return 0 if !$text;
-    
-    if ($text =~ m/^(\d+(\.\d+)?)([TGMK])?$/) {
-
-       my ($size, $reminder, $unit) = ($1, $2, $3);
-       
-       if ($unit) {
-           if ($unit eq 'K') {
-               $size *= 1024;
-           } elsif ($unit eq 'M') {
-               $size *= 1024*1024;
-           } elsif ($unit eq 'G') {
-               $size *= 1024*1024*1024;
-           } elsif ($unit eq 'T') {
-               $size *= 1024*1024*1024*1024;
-           } else {
-               die "got unknown zfs size unit '$unit'\n";
-           }
-       }
-
-       if ($reminder) {
-           $size = ceil($size);
-       }
-       
-       return $size;
-    
-    }
-
-    warn "unable to parse zfs size '$text'\n";
-
-    return 0;
-}
-
 sub zfs_parse_zvol_list {
     my ($text) = @_;
 
@@ -112,11 +84,11 @@ sub zfs_parse_zvol_list {
            if ($refquota eq 'none') {
                $zvol->{size} = 0;
            } else {
-               $zvol->{size} = zfs_parse_size($refquota);
+               $zvol->{size} = $refquota + 0;
            }
            $zvol->{format} = 'subvol';
        } else {
-           $zvol->{size} = zfs_parse_size($size);
+           $zvol->{size} = $size + 0;
            $zvol->{format} = 'raw';
        }
        if ($origin !~ /^-$/) {
@@ -142,17 +114,41 @@ sub parse_volname {
 
 # virtual zfs methods (subclass can overwrite them)
 
+sub on_add_hook {
+    my ($class, $storeid, $scfg, %param) = @_;
+
+    my $cfg_mountpoint = $scfg->{mountpoint};
+
+    # ignore failure, pool might currently not be imported
+    my $mountpoint;
+    eval {
+       my $res = $class->zfs_get_properties($scfg, 'mountpoint', $scfg->{pool}, 1);
+       $mountpoint = PVE::Storage::Plugin::verify_path($res, 1) if defined($res);
+    };
+
+    if (defined($cfg_mountpoint)) {
+       if (defined($mountpoint) && !($cfg_mountpoint =~ m|^\Q$mountpoint\E/?$|)) {
+           warn "warning for $storeid - mountpoint: $cfg_mountpoint " .
+                "does not match current mount point: $mountpoint\n";
+       }
+    } else {
+       $scfg->{mountpoint} = $mountpoint;
+    }
+
+    return;
+}
+
 sub path {
     my ($class, $scfg, $volname, $storeid, $snapname) = @_;
 
     my ($vtype, $name, $vmid) = $class->parse_volname($volname);
 
     my $path = '';
+    my $mountpoint = $scfg->{mountpoint} // "/$scfg->{pool}";
 
     if ($vtype eq "images") {
        if ($name =~ m/^subvol-/ || $name =~ m/^basevol-/) {
-           # fixme: we currently assume standard mount point?!
-           $path = "/$scfg->{pool}/$name";
+           $path = "$mountpoint/$name";
        } else {
            $path = "/dev/zvol/$scfg->{pool}/$name";
        }
@@ -167,70 +163,72 @@ sub path {
 sub zfs_request {
     my ($class, $scfg, $timeout, $method, @params) = @_;
 
-    my $default_timeout = PVE::RPCEnvironment->is_worker() ? 60*60 : 5;
-
     my $cmd = [];
 
     if ($method eq 'zpool_list') {
        push @$cmd, 'zpool', 'list';
     } elsif ($method eq 'zpool_import') {
        push @$cmd, 'zpool', 'import';
-       $default_timeout = 15 if $default_timeout < 15;
+       $timeout = 15 if !$timeout || $timeout < 15;
     } else {
        push @$cmd, 'zfs', $method;
     }
-
     push @$cmd, @params;
-    my $msg = '';
 
-    my $output = sub {
-        my $line = shift;
-        $msg .= "$line\n";
-    };
+    my $msg = '';
+    my $output = sub { $msg .= "$_[0]\n" };
 
-    $timeout =  $default_timeout if !$timeout;
+    $timeout = PVE::RPCEnvironment->is_worker() ? 60*60 : 5 if !$timeout;
 
     run_command($cmd, errmsg => "zfs error", outfunc => $output, timeout => $timeout);
 
     return $msg;
 }
 
+sub zfs_wait_for_zvol_link {
+    my ($class, $scfg, $volname, $timeout) = @_;
+
+    my $default_timeout = PVE::RPCEnvironment->is_worker() ? 60*5 : 10;
+    $timeout = $default_timeout if !defined($timeout);
+
+    my ($devname, undef, undef) = $class->path($scfg, $volname);
+
+    for (my $i = 1; $i <= $timeout; $i++) {
+       last if -b $devname;
+       die "timeout: no zvol device link for '$volname' found after $timeout sec found.\n"
+           if $i == $timeout;
+
+       sleep(1);
+    }
+}
+
 sub alloc_image {
     my ($class, $storeid, $scfg, $vmid, $fmt, $name, $size) = @_;
 
     my $volname = $name;
-    
+
     if ($fmt eq 'raw') {
 
        die "illegal name '$volname' - should be 'vm-$vmid-*'\n"
            if $volname && $volname !~ m/^vm-$vmid-/;
-       $volname = $class->zfs_find_free_diskname($storeid, $scfg, $vmid, $fmt) 
+       $volname = $class->find_free_diskname($storeid, $scfg, $vmid, $fmt)
            if !$volname;
 
        $class->zfs_create_zvol($scfg, $volname, $size);
-       my $devname = "/dev/zvol/$scfg->{pool}/$volname";
-
-       my $timeout = PVE::RPCEnvironment->is_worker() ? 60*5 : 10;
-       for (my $i = 1; $i <= $timeout; $i++) {
-           last if -b $devname;
-           die "Timeout: no zvol after $timeout sec found.\n"
-               if $i == $timeout;
+       $class->zfs_wait_for_zvol_link($scfg, $volname);
 
-           sleep(1);
-       }
     } elsif ( $fmt eq 'subvol') {
 
        die "illegal name '$volname' - should be 'subvol-$vmid-*'\n"
            if $volname && $volname !~ m/^subvol-$vmid-/;
-       $volname = $class->zfs_find_free_diskname($storeid, $scfg, $vmid, $fmt) 
+       $volname = $class->find_free_diskname($storeid, $scfg, $vmid, $fmt)
            if !$volname;
 
        die "illegal name '$volname' - should be 'subvol-$vmid-*'\n"
            if $volname !~ m/^subvol-$vmid-/;
 
-       $class->zfs_create_subvol($scfg, $volname, $size);      
-       
+       $class->zfs_create_subvol($scfg, $volname, $size);
+
     } else {
        die "unsupported format '$fmt'";
     }
@@ -285,16 +283,22 @@ sub list_images {
     return $res;
 }
 
+sub zfs_get_properties {
+    my ($class, $scfg, $properties, $dataset, $timeout) = @_;
+
+    my $result = $class->zfs_request($scfg, $timeout, 'get', '-o', 'value',
+                                    '-Hp', $properties, $dataset);
+    my @values = split /\n/, $result;
+    return wantarray ? @values : $values[0];
+}
+
 sub zfs_get_pool_stats {
     my ($class, $scfg) = @_;
 
     my $available = 0;
     my $used = 0;
 
-    my $text = $class->zfs_request($scfg, undef, 'get', '-o', 'value', '-Hp',
-               'available,used', $scfg->{pool});
-
-    my @lines = split /\n/, $text;
+    my @lines = $class->zfs_get_properties($scfg, 'available,used', $scfg->{pool});
 
     if($lines[0] =~ /^(\d+)$/) {
        $available = $1;
@@ -330,9 +334,10 @@ sub zfs_create_subvol {
     my ($class, $scfg, $volname, $size) = @_;
 
     my $dataset = "$scfg->{pool}/$volname";
-    
+    my $quota = $size ? "${size}k" : "none";
+
     my $cmd = ['create', '-o', 'acltype=posixacl', '-o', 'xattr=sa',
-              '-o', "refquota=${size}k", $dataset];
+              '-o', "refquota=${quota}", $dataset];
 
     $class->zfs_request($scfg, undef, @$cmd);
 }
@@ -365,7 +370,7 @@ sub zfs_delete_zvol {
 sub zfs_list_zvol {
     my ($class, $scfg) = @_;
 
-    my $text = $class->zfs_request($scfg, 10, 'list', '-o', 'name,volsize,origin,type,refquota', '-t', 'volume,filesystem', '-Hr');
+    my $text = $class->zfs_request($scfg, 10, 'list', '-o', 'name,volsize,origin,type,refquota', '-t', 'volume,filesystem', '-Hrp');
     my $zvols = zfs_parse_zvol_list($text);
     return undef if !$zvols;
 
@@ -390,16 +395,6 @@ sub zfs_list_zvol {
     return $list;
 }
 
-sub zfs_find_free_diskname {
-    my ($class, $storeid, $scfg, $vmid, $format) = @_;
-
-    my $volumes = $class->zfs_list_zvol($scfg);
-    my $dat = $volumes->{$scfg->{pool}};
-
-    my $disk_list = [ keys %$dat ];
-    return PVE::Storage::Plugin::get_next_vm_diskname($disk_list, $storeid, $vmid, $format, $scfg);
-}
-
 sub zfs_get_latest_snapshot {
     my ($class, $scfg, $volname) = @_;
 
@@ -446,8 +441,8 @@ sub volume_size_info {
         $class->parse_volname($volname);
 
     my $attr = $format eq 'subvol' ? 'refquota' : 'volsize';
-    my $text = $class->zfs_request($scfg, undef, 'get', '-Hp', $attr, "$scfg->{pool}/$vname");
-    if ($text =~ /\s$attr\s(\d+)\s/) {
+    my $value = $class->zfs_get_properties($scfg, $attr, "$scfg->{pool}/$vname");
+    if ($value =~ /^(\d+)$/) {
        return $1;
     }
 
@@ -474,20 +469,32 @@ sub volume_snapshot_delete {
 sub volume_snapshot_rollback {
     my ($class, $scfg, $storeid, $volname, $snap) = @_;
 
-    my $vname = ($class->parse_volname($volname))[1];
+    my (undef, $vname, undef, undef, undef, undef, $format) = $class->parse_volname($volname);
 
-    $class->zfs_request($scfg, undef, 'rollback', "$scfg->{pool}/$vname\@$snap");
+    my $msg = $class->zfs_request($scfg, undef, 'rollback', "$scfg->{pool}/$vname\@$snap");
+
+    # we have to unmount rollbacked subvols, to invalidate wrong kernel
+    # caches, they get mounted in activate volume again
+    # see zfs bug #10931 https://github.com/openzfs/zfs/issues/10931
+    if ($format eq 'subvol') {
+       $class->zfs_request($scfg, undef, 'unmount', "$scfg->{pool}/$vname");
+    }
+
+    return $msg;
 }
 
 sub volume_rollback_is_possible {
-    my ($class, $scfg, $storeid, $volname, $snap) = @_; 
-    
+    my ($class, $scfg, $storeid, $volname, $snap) = @_;
+
     my $recentsnap = $class->zfs_get_latest_snapshot($scfg, $volname);
-    if ($snap ne $recentsnap) {
-       die "can't rollback, more recent snapshots exist\n";
-    }
 
-    return 1; 
+    die "can't rollback, no snapshots exist at all\n"
+       if !defined($recentsnap);
+
+    die "can't rollback, '$snap' is not most recent snapshot\n"
+       if $snap ne $recentsnap;
+
+    return 1;
 }
 
 sub volume_snapshot_list {
@@ -516,26 +523,49 @@ sub volume_snapshot_list {
     return $snaps;
 }
 
+my sub dataset_mounted_heuristic {
+    my ($dataset) = @_;
+
+    my $mounts = PVE::ProcFSTools::parse_proc_mounts();
+    for my $mp (@$mounts) {
+       my ($what, $dir, $fs) = $mp->@*;
+       next if $fs ne 'zfs';
+       # check for root-dataset or any child-dataset (root-dataset could have 'canmount=off')
+       # If any child is mounted heuristically assume that `zfs mount -a` was successful
+       next if $what !~ m!^$dataset(?:/|$)!;
+       return 1;
+    }
+    return 0;
+}
+
 sub activate_storage {
     my ($class, $storeid, $scfg, $cache) = @_;
 
     # Note: $scfg->{pool} can include dataset <pool>/<dataset>
-    my $pool = $scfg->{pool};
-    $pool =~ s!/.*$!!;
+    my $dataset = $scfg->{pool};
+    my $pool = ($dataset =~ s!/.*$!!r);
 
-    my @param = ('-o', 'name', '-H', "$pool");
-    my $res;
-    eval {
-       $res = $class->zfs_request($scfg, undef, 'zpool_list', @param);
+    return 1 if dataset_mounted_heuristic($dataset); # early return
+
+    my $pool_imported = sub {
+       my @param = ('-o', 'name', '-H', $pool);
+       my $res = eval { $class->zfs_request($scfg, undef, 'zpool_list', @param) };
+       warn "$@\n" if $@;
+
+       return defined($res) && $res =~ m/$pool/;
     };
 
-    if ($@ || !defined($res) || $res !~ $pool) {
-       eval {
-           @param = ('-d', '/dev/disk/by-id/', "$pool");
-           $class->zfs_request($scfg, undef, 'zpool_import', @param);
-       };
-       die "could not activate storage '$storeid', $@\n" if $@;
+    if (!$pool_imported->()) {
+       # import can only be done if not yet imported!
+       my @param = ('-d', '/dev/disk/by-id/', '-o', 'cachefile=none', $pool);
+       eval { $class->zfs_request($scfg, undef, 'zpool_import', @param) };
+       if (my $err = $@) {
+           # just could've raced with another import, so recheck if it is imported
+           die "could not activate storage '$storeid', $err\n" if !$pool_imported->();
+       }
     }
+    eval { $class->zfs_request($scfg, undef, 'mount', '-a') };
+    die "could not activate storage '$storeid', $@\n" if $@;
     return 1;
 }
 
@@ -546,6 +576,20 @@ sub deactivate_storage {
 
 sub activate_volume {
     my ($class, $storeid, $scfg, $volname, $snapname, $cache) = @_;
+
+    return 1 if defined($snapname);
+
+    my (undef, $dataset, undef, undef, undef, undef, $format) = $class->parse_volname($volname);
+
+    if ($format eq 'raw') {
+       $class->zfs_wait_for_zvol_link($scfg, $volname);
+    } elsif ($format eq 'subvol') {
+       my $mounted = $class->zfs_get_properties($scfg, 'mounted', "$scfg->{pool}/$dataset");
+       if ($mounted !~ m/^yes$/) {
+           $class->zfs_request($scfg, undef, 'mount', "$scfg->{pool}/$dataset");
+       }
+    }
+
     return 1;
 }
 
@@ -564,10 +608,10 @@ sub clone_image {
 
     die "clone_image only works on base images\n" if !$isBase;
 
-    my $name = $class->zfs_find_free_diskname($storeid, $scfg, $vmid, $format);
+    my $name = $class->find_free_diskname($storeid, $scfg, $vmid, $format);
 
     if ($format eq 'subvol') {
-       my $size = $class->zfs_request($scfg, undef, 'list', '-H', '-o', 'refquota', "$scfg->{pool}/$basename");
+       my $size = $class->zfs_request($scfg, undef, 'list', '-Hp', '-o', 'refquota', "$scfg->{pool}/$basename");
        chomp($size);
        $class->zfs_request($scfg, undef, 'clone', "$scfg->{pool}/$basename\@$snap", "$scfg->{pool}/$name", '-o', "refquota=$size");
     } else {
@@ -614,6 +658,12 @@ sub volume_resize {
 
     my $attr = $format eq 'subvol' ? 'refquota' : 'volsize';
 
+    # align size to 1M so we always have a valid multiple of the volume block size
+    if ($format eq 'raw') {
+       my $padding = (1024 - $new_size % 1024) % 1024;
+       $new_size = $new_size + $padding;
+    }
+
     $class->zfs_request($scfg, undef, 'set', "$attr=${new_size}k", "$scfg->{pool}/$vname");
 
     return $new_size;
@@ -697,7 +747,7 @@ sub volume_export_formats {
 }
 
 sub volume_import {
-    my ($class, $scfg, $storeid, $fh, $volname, $format, $base_snapshot, $with_snapshots) = @_;
+    my ($class, $scfg, $storeid, $fh, $volname, $format, $base_snapshot, $with_snapshots, $allow_rename) = @_;
 
     die "unsupported import stream format for $class: $format\n"
        if $format ne 'zfs';
@@ -706,15 +756,18 @@ sub volume_import {
     die "internal error: invalid file handle for volume_import\n"
        if !defined($fd);
 
-    my $dataset = ($class->parse_volname($volname))[1];
+    my (undef, $dataset, $vmid) = $class->parse_volname($volname);
     my $zfspath = "$scfg->{pool}/$dataset";
     my $suffix = defined($base_snapshot) ? "\@$base_snapshot" : '';
     my $exists = 0 == run_command(['zfs', 'get', '-H', 'name', $zfspath.$suffix],
-                            noerr => 1, errfunc => sub {});
+                                 noerr => 1, quiet => 1);
     if (defined($base_snapshot)) {
        die "base snapshot '$zfspath\@$base_snapshot' doesn't exist\n" if !$exists;
-    } else {
-       die "volume '$zfspath' already exists\n" if $exists;
+    } elsif ($exists) {
+       die "volume '$zfspath' already exists\n" if !$allow_rename;
+       warn "volume '$zfspath' already exists - importing with a different name\n";
+       $dataset = $class->find_free_diskname($storeid, $scfg, $vmid, $format);
+       $zfspath = "$scfg->{pool}/$dataset";
     }
 
     eval { run_command(['zfs', 'recv', '-F', '--', $zfspath], input => "<&$fd") };
@@ -727,7 +780,7 @@ sub volume_import {
        die $err;
     }
 
-    return;
+    return "$storeid:$dataset";
 }
 
 sub volume_import_formats {