Files
pve-storage/PVE/Storage/ZFSPoolPlugin.pm
Wolfgang Link 82e08809fd change var name to prevent side effects.
Signed-off-by: Wolfgang Link <w.link@proxmox.com>
2015-02-16 11:35:13 +01:00

536 lines
11 KiB
Perl

package PVE::Storage::ZFSPoolPlugin;
use strict;
use warnings;
use IO::File;
use POSIX;
use PVE::Tools qw(run_command);
use PVE::Storage::Plugin;
use base qw(PVE::Storage::Plugin);
sub type {
return 'zfspool';
}
sub plugindata {
return {
content => [ {images => 1}, { images => 1 }],
};
}
sub properties {
return {
blocksize => {
description => "block size",
type => 'string',
},
sparse => {
description => "use sparse volumes",
type => 'boolean',
},
};
}
sub options {
return {
pool => { fixed => 1 },
blocksize => { optional => 1 },
sparse => { optional => 1 },
nodes => { optional => 1 },
disable => { optional => 1 },
maxfiles => { optional => 1 },
content => { 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) = @_;
my $list = ();
return $list if !$text;
my @lines = split /\n/, $text;
foreach my $line (@lines) {
if ($line =~ /^(.+)\s+([a-zA-Z0-9\.]+|\-)\s+(.+)$/) {
my $zvol = {};
my $size = $2;
my $origin = $3;
my @parts = split /\//, $1;
my $name = pop @parts;
my $pool = join('/', @parts);
next unless $name =~ m!^(\w+)-(\d+)-(\w+)-(\d+)$!;
$name = $pool . '/' . $name;
$zvol->{pool} = $pool;
$zvol->{name} = $name;
$zvol->{size} = zfs_parse_size($size);
if ($3 !~ /^-$/) {
$zvol->{origin} = $origin;
}
push @$list, $zvol;
}
}
return $list;
}
sub parse_volname {
my ($class, $volname) = @_;
if ($volname =~ m/^(((base|vm)-(\d+)-\S+)\/)?((base)?(vm)?-(\d+)-\S+)$/) {
return ('images', $5, $8, $2, $4, $6);
}
die "unable to parse zfs volume name '$volname'\n";
}
# virtual zfs methods (subclass can overwrite them)
sub path {
my ($class, $scfg, $volname) = @_;
my ($vtype, $name, $vmid) = $class->parse_volname($volname);
my $path = '';
if($vtype eq "images"){
$path = "/dev/zvol/$scfg->{pool}/$volname";
} else {
die "$vtype is not allowed in ZFSPool!";
}
return ($path, $vmid, $vtype);
}
sub zfs_request {
my ($class, $scfg, $timeout, $method, @params) = @_;
$timeout = 5 if !$timeout;
my $cmd = [];
if ($method eq 'zpool_list') {
push @$cmd, 'zpool', 'list';
} else {
push @$cmd, 'zfs', $method;
}
push @$cmd, @params;
my $msg = '';
my $output = sub {
my $line = shift;
$msg .= "$line\n";
};
run_command($cmd, outfunc => $output, timeout => $timeout);
return $msg;
}
sub alloc_image {
my ($class, $storeid, $scfg, $vmid, $fmt, $name, $size) = @_;
die "unsupported format '$fmt'" if $fmt ne 'raw';
die "illegal name '$name' - sould be 'vm-$vmid-*'\n"
if $name && $name !~ m/^vm-$vmid-/;
my $volname = $name;
$volname = $class->zfs_find_free_diskname($storeid, $scfg, $vmid) if !$volname;
$class->zfs_create_zvol($scfg, $volname, $size);
my $devname = "/dev/zvol/$scfg->{pool}/$volname";
run_command("udevadm trigger --subsystem-match block");
system("udevadm settle --timeout 10 --exit-if-exists=${devname}");
return $volname;
}
sub free_image {
my ($class, $storeid, $scfg, $volname, $isBase) = @_;
my (undef, $name, undef) = $class->parse_volname($volname);
$class->zfs_delete_zvol($scfg, $name);
return undef;
}
sub list_images {
my ($class, $storeid, $scfg, $vmid, $vollist, $cache) = @_;
$cache->{zfs} = $class->zfs_list_zvol($scfg) if !$cache->{zfs};
my $zfspool = $scfg->{pool};
my $res = [];
if (my $dat = $cache->{zfs}->{$zfspool}) {
foreach my $image (keys %$dat) {
my $volname = $dat->{$image}->{name};
my $parent = $dat->{$image}->{parent};
my $volid = undef;
if ($parent && $parent =~ m/^(\S+)@(\S+)$/) {
my ($basename) = ($1);
$volid = "$storeid:$basename/$volname";
} else {
$volid = "$storeid:$volname";
}
my $owner = $dat->{$volname}->{vmid};
if ($vollist) {
my $found = grep { $_ eq $volid } @$vollist;
next if !$found;
} else {
next if defined ($vmid) && ($owner ne $vmid);
}
my $info = $dat->{$volname};
$info->{volid} = $volid;
push @$res, $info;
}
}
return $res;
}
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;
if($lines[0] =~ /^(\d+)$/) {
$available = $1;
}
if($lines[1] =~ /^(\d+)$/) {
$used = $1;
}
return ($available, $used);
}
sub zfs_get_zvol_size {
my ($class, $scfg, $zvol) = @_;
my $text = $class->zfs_request($scfg, undef, 'get', '-Hp', 'volsize', "$scfg->{pool}/$zvol");
if ($text =~ /volsize\s(\d+)/) {
return $1;
}
die "Could not get zvol size";
}
sub zfs_create_zvol {
my ($class, $scfg, $zvol, $size) = @_;
my $cmd = ['create'];
push @$cmd, '-s' if $scfg->{sparse};
push @$cmd, '-b', $scfg->{blocksize} if $scfg->{blocksize};
push @$cmd, '-V', "${size}k", "$scfg->{pool}/$zvol";
$class->zfs_request($scfg, undef, @$cmd);
}
sub zfs_delete_zvol {
my ($class, $scfg, $zvol) = @_;
$class->zfs_request($scfg, undef, 'destroy', '-r', "$scfg->{pool}/$zvol");
}
sub zfs_list_zvol {
my ($class, $scfg) = @_;
my $text = $class->zfs_request($scfg, 10, 'list', '-o', 'name,volsize,origin', '-t', 'volume', '-Hr');
my $zvols = zfs_parse_zvol_list($text);
return undef if !$zvols;
my $list = ();
foreach my $zvol (@$zvols) {
my @values = split('/', $zvol->{name});
my $image = pop @values;
my $pool = join('/', @values);
next if $image !~ m/^((vm|base)-(\d+)-\S+)$/;
my $owner = $3;
my $parent = $zvol->{origin};
if($zvol->{origin} && $zvol->{origin} =~ m/^$scfg->{pool}\/(\S+)$/){
$parent = $1;
}
$list->{$pool}->{$image} = {
name => $image,
size => $zvol->{size},
parent => $parent,
format => 'raw',
vmid => $owner
};
}
return $list;
}
sub zfs_find_free_diskname {
my ($class, $storeid, $scfg, $vmid) = @_;
my $name = undef;
my $volumes = $class->zfs_list_zvol($scfg);
my $disk_ids = {};
my $dat = $volumes->{$scfg->{pool}};
foreach my $image (keys %$dat) {
my $volname = $dat->{$image}->{name};
if ($volname =~ m/(vm|base)-$vmid-disk-(\d+)/){
$disk_ids->{$2} = 1;
}
}
for (my $i = 1; $i < 100; $i++) {
if (!$disk_ids->{$i}) {
return "vm-$vmid-disk-$i";
}
}
die "unable to allocate an image name for VM $vmid in storage '$storeid'\n";
}
sub zfs_get_latest_snapshot {
my ($class, $scfg, $volname) = @_;
# abort rollback if snapshot is not the latest
my @params = ('-t', 'snapshot', '-o', 'name', '-s', 'creation');
my $text = zfs_request($class, $scfg, undef, 'list', @params);
my @snapshots = split(/\n/, $text);
my $recentsnap;
foreach (@snapshots) {
if (/$scfg->{pool}\/$volname/) {
s/^.*@//;
$recentsnap = $_;
}
}
return $recentsnap;
}
sub status {
my ($class, $storeid, $scfg, $cache) = @_;
my $total = 0;
my $free = 0;
my $used = 0;
my $active = 0;
eval {
($free, $used) = $class->zfs_get_pool_stats($scfg);
$active = 1;
$total = $free + $used;
};
warn $@ if $@;
return ($total, $free, $used, $active);
}
sub volume_size_info {
my ($class, $scfg, $storeid, $volname, $timeout) = @_;
return $class->zfs_get_zvol_size($scfg, $volname);
}
sub volume_snapshot {
my ($class, $scfg, $storeid, $volname, $snap, $running) = @_;
$class->zfs_request($scfg, undef, 'snapshot', "$scfg->{pool}/$volname\@$snap");
}
sub volume_snapshot_delete {
my ($class, $scfg, $storeid, $volname, $snap, $running) = @_;
$class->zfs_request($scfg, undef, 'destroy', "$scfg->{pool}/$volname\@$snap");
}
sub volume_snapshot_rollback {
my ($class, $scfg, $storeid, $volname, $snap) = @_;
zfs_request($class, $scfg, undef, 'rollback', "$scfg->{pool}/$volname\@$snap");
}
sub volume_rollback_is_possible {
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;
}
sub activate_storage {
my ($class, $storeid, $scfg, $cache) = @_;
my @param = ('-o', 'name', '-H');
my $text = zfs_request($class, $scfg, undef, 'zpool_list', @param);
if ($text !~ $scfg->{pool}) {
run_command("zpool import -d /dev/disk/by-id/ -a");
}
return 1;
}
sub deactivate_storage {
my ($class, $storeid, $scfg, $cache) = @_;
return 1;
}
sub activate_volume {
my ($class, $storeid, $scfg, $volname, $exclusive, $cache) = @_;
return 1;
}
sub deactivate_volume {
my ($class, $storeid, $scfg, $volname, $exclusive, $cache) = @_;
return 1;
}
sub clone_image {
my ($class, $scfg, $storeid, $volname, $vmid, $snap) = @_;
$snap ||= '__base__';
my ($vtype, $basename, $basevmid, undef, undef, $isBase) =
$class->parse_volname($volname);
die "clone_image only works on base images\n" if !$isBase;
my $name = $class->zfs_find_free_diskname($storeid, $scfg, $vmid);
$class->zfs_request($scfg, undef, 'clone', "$scfg->{pool}/$basename\@$snap", "$scfg->{pool}/$name");
return $name;
}
sub create_base {
my ($class, $storeid, $scfg, $volname) = @_;
my $snap = '__base__';
my ($vtype, $name, $vmid, $basename, $basevmid, $isBase) =
$class->parse_volname($volname);
die "create_base not possible with base image\n" if $isBase;
my $newname = $name;
$newname =~ s/^vm-/base-/;
my $newvolname = $basename ? "$basename/$newname" : "$newname";
$class->zfs_request($scfg, undef, 'rename', "$scfg->{pool}/$name", "$scfg->{pool}/$newname");
my $running = undef; #fixme : is create_base always offline ?
$class->volume_snapshot($scfg, $storeid, $newname, $snap, $running);
return $newvolname;
}
sub volume_resize {
my ($class, $scfg, $storeid, $volname, $size, $running) = @_;
my $new_size = ($size/1024);
$class->zfs_request($scfg, undef, 'set', 'volsize=' . $new_size . 'k', "$scfg->{pool}/$volname");
return $new_size;
}
sub volume_has_feature {
my ($class, $scfg, $feature, $storeid, $volname, $snapname, $running) = @_;
my $features = {
snapshot => { current => 1, snap => 1},
clone => { base => 1},
template => { current => 1},
copy => { base => 1, current => 1},
};
my ($vtype, $name, $vmid, $basename, $basevmid, $isBase) =
$class->parse_volname($volname);
my $key = undef;
if ($snapname) {
$key = 'snap';
} else {
$key = $isBase ? 'base' : 'current';
}
return 1 if $features->{$feature}->{$key};
return undef;
}
1;