[pve-storage.git] / PVE / Storage / ZFSDirPlugin.pm

package PVE::Storage::ZFSDirPlugin;

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 'zfsdir';
}

sub plugindata {
    return {
	content => [ { images => 1, rootdir => 1, vztmpl => 1, iso => 1, backup => 1},
		     { images => 1 }],
    };
}   

sub properties {
    return {
	blocksize => {
	    description => "block size",
	    type => 'string',
	},
	sparse => {
	    description => "use sparse volumes",
	    type => 'boolean',
	},
    };
}

sub options {
    return {
	path => { fixed => 1 },
	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 @parts = split /\//, $1;
	    my $name = pop @parts;
	    my $pool = join('/', @parts);

	    if ($pool !~ /^rpool$/) {
		next unless $name =~ m!^(\w+)-(\d+)-(\w+)-(\d+)$!;
		$name = $pool . '/' . $name;
	    } else {
		next;
	    }

	    $zvol->{pool} = $pool;
	    $zvol->{name} = $name;
	    $zvol->{size} = zfs_parse_size($2);
	    if ($3 !~ /^-$/) {
		$zvol->{origin} = $3;
	    }
	    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 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-/;

    $name = $class->zfs_find_free_diskname($storeid, $scfg, $vmid) if !$name;
    
    $class->zfs_create_zvol($scfg, $name, $size);

    return $name;
}

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 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");
}


1;
Commit	Line	Data
5bb8e010 DM	1	package PVE::Storage::ZFSDirPlugin;
	2
	3	use strict;
	4	use warnings;
	5	use IO::File;
	6	use POSIX;
	7	use PVE::Tools qw(run_command);
	8	use PVE::Storage::Plugin;
	9
	10
	11	use base qw(PVE::Storage::Plugin);
	12
5bb8e010 DM	13	sub type {
	14	return 'zfsdir';
	15	}
	16
	17	sub plugindata {
	18	return {
	19	content => [ { images => 1, rootdir => 1, vztmpl => 1, iso => 1, backup => 1},
	20	{ images => 1 }],
	21	};
	22	}
	23
7730694e DM	24	sub properties {
	25	return {
	26	blocksize => {
	27	description => "block size",
	28	type => 'string',
	29	},
	30	sparse => {
	31	description => "use sparse volumes",
	32	type => 'boolean',
	33	},
	34	};
	35	}
	36
5bb8e010 DM	37	sub options {
	38	return {
	39	path => { fixed => 1 },
7730694e DM	40	pool => { fixed => 1 },
	41	blocksize => { optional => 1 },
	42	sparse => { optional => 1 },
	43	nodes => { optional => 1 },
5bb8e010 DM	44	disable => { optional => 1 },
	45	maxfiles => { optional => 1 },
	46	content => { optional => 1 },
	47	};
	48	}
	49
7730694e DM	50	# static zfs helper methods
7730694e DM	51
060ef890 DM	52	sub zfs_parse_size {
	53	my ($text) = @_;
	54
	55	return 0 if !$text;
	56
	57	if ($text =~ m/^(\d+(\.\d+)?)([TGMK])?$/) {
	58
	59	my ($size, $reminder, $unit) = ($1, $2, $3);
	60
	61	if ($unit) {
	62	if ($unit eq 'K') {
	63	$size *= 1024;
	64	} elsif ($unit eq 'M') {
	65	$size = 10241024;
	66	} elsif ($unit eq 'G') {
	67	$size = 10241024*1024;
	68	} elsif ($unit eq 'T') {
	69	$size = 1024102410241024;
	70	} else {
	71	die "got unknown zfs size unit '$unit'\n";
	72	}
	73	}
	74
	75	if ($reminder) {
	76	$size = ceil($size);
	77	}
	78
	79	return $size;
	80
	81	}
	82
	83	warn "unable to parse zfs size '$text'\n";
	84
	85	return 0;
	86	}
	87
7730694e DM	88	sub zfs_parse_zvol_list {
	89	my ($text) = @_;
	90
	91	my $list = ();
	92
	93	return $list if !$text;
	94
	95	my @lines = split /\n/, $text;
	96	foreach my $line (@lines) {
	97	if ($line =~ /^(.+)\s+([a-zA-Z0-9\.]+\|\-)\s+(.+)$/) {
	98	my $zvol = {};
	99	my @parts = split /\//, $1;
	100	my $name = pop @parts;
	101	my $pool = join('/', @parts);
	102
	103	if ($pool !~ /^rpool$/) {
	104	next unless $name =~ m!^(\w+)-(\d+)-(\w+)-(\d+)$!;
	105	$name = $pool . '/' . $name;
	106	} else {
	107	next;
	108	}
	109
	110	$zvol->{pool} = $pool;
	111	$zvol->{name} = $name;
	112	$zvol->{size} = zfs_parse_size($2);
	113	if ($3 !~ /^-$/) {
	114	$zvol->{origin} = $3;
	115	}
	116	push @$list, $zvol;
	117	}
	118	}
	119
	120	return $list;
	121	}
	122
cc80ed9c WL	123	sub parse_volname {
	124	my ($class, $volname) = @_;
	125
	126	if ($volname =~ m/^(((base\|vm)-(\d+)-\S+)\/)?((base)?(vm)?-(\d+)-\S+)$/) {
	127	return ('images', $5, $8, $2, $4, $6);
	128	}
	129
	130	die "unable to parse zfs volume name '$volname'\n";
	131	}
	132
7730694e DM	133	# virtual zfs methods (subclass can overwrite them)
	134
	135	sub zfs_request {
	136	my ($class, $scfg, $timeout, $method, @params) = @_;
	137
	138	$timeout = 5 if !$timeout;
	139
	140	my $cmd = [];
	141
	142	if ($method eq 'zpool_list') {
	143	push @$cmd = 'zpool', 'list';
	144	} else {
	145	push @$cmd, 'zfs', $method;
	146	}
	147
	148	push @$cmd, @params;
	149
	150	my $msg = '';
	151
	152	my $output = sub {
	153	my $line = shift;
	154	$msg .= "$line\n";
	155	};
	156
	157	run_command($cmd, outfunc => $output, timeout => $timeout);
	158
	159	return $msg;
	160	}
	161
b3ba95e4 WL	162	sub alloc_image {
	163	my ($class, $storeid, $scfg, $vmid, $fmt, $name, $size) = @_;
	164
	165	die "unsupported format '$fmt'" if $fmt ne 'raw';
	166
	167	die "illegal name '$name' - sould be 'vm-$vmid-*'\n"
	168	if $name && $name !~ m/^vm-$vmid-/;
	169
	170	$name = $class->zfs_find_free_diskname($storeid, $scfg, $vmid) if !$name;
	171
	172	$class->zfs_create_zvol($scfg, $name, $size);
	173
	174	return $name;
	175	}
	176
e9565df5 WL	177	sub free_image {
	178	my ($class, $storeid, $scfg, $volname, $isBase) = @_;
	179
	180	my (undef, $name, undef) = $class->parse_volname($volname);
	181
	182	$class->zfs_delete_zvol($scfg, $name);
	183
	184	return undef;
	185	}
	186
ca04180f WL	187	sub list_images {
	188	my ($class, $storeid, $scfg, $vmid, $vollist, $cache) = @_;
	189
	190	$cache->{zfs} = $class->zfs_list_zvol($scfg) if !$cache->{zfs};
	191	my $zfspool = $scfg->{pool};
	192	my $res = [];
	193
	194	if (my $dat = $cache->{zfs}->{$zfspool}) {
	195
	196	foreach my $image (keys %$dat) {
	197
	198	my $volname = $dat->{$image}->{name};
	199	my $parent = $dat->{$image}->{parent};
	200
	201	my $volid = undef;
	202	if ($parent && $parent =~ m/^(\S+)@(\S+)$/) {
	203	my ($basename) = ($1);
	204	$volid = "$storeid:$basename/$volname";
	205	} else {
	206	$volid = "$storeid:$volname";
	207	}
	208
	209	my $owner = $dat->{$volname}->{vmid};
	210	if ($vollist) {
	211	my $found = grep { $_ eq $volid } @$vollist;
	212	next if !$found;
	213	} else {
	214	next if defined ($vmid) && ($owner ne $vmid);
	215	}
	216
	217	my $info = $dat->{$volname};
	218	$info->{volid} = $volid;
	219	push @$res, $info;
	220	}
	221	}
	222
	223	return $res;
	224	}
	225
7730694e DM	226	sub zfs_get_pool_stats {
	227	my ($class, $scfg) = @_;
	228
	229	my $available = 0;
	230	my $used = 0;
	231
	232	my $text = $class->zfs_request($scfg, undef, 'get', '-o', 'value', '-Hp',
	233	'available,used', $scfg->{pool});
	234
	235	my @lines = split /\n/, $text;
	236
	237	if($lines[0] =~ /^(\d+)$/) {
	238	$available = $1;
	239	}
	240
	241	if($lines[1] =~ /^(\d+)$/) {
	242	$used = $1;
	243	}
	244
	245	return ($available, $used);
	246	}
	247
	248	sub zfs_get_zvol_size {
	249	my ($class, $scfg, $zvol) = @_;
	250
	251	my $text = $class->zfs_request($scfg, undef, 'get', '-Hp', 'volsize', "$scfg->{pool}/$zvol");
	252
	253	if ($text =~ /volsize\s(\d+)/) {
	254	return $1;
	255	}
	256
	257	die "Could not get zvol size";
	258	}
	259
	260	sub zfs_create_zvol {
	261	my ($class, $scfg, $zvol, $size) = @_;
	262
	263	my $cmd = ['create'];
	264
	265	push @$cmd, '-s' if $scfg->{sparse};
	266
	267	push @$cmd, '-b', $scfg->{blocksize} if $scfg->{blocksize};
	268
	269	push @$cmd, '-V', "${size}k", "$scfg->{pool}/$zvol";
	270
	271	$class->zfs_request($scfg, undef, @$cmd);
	272	}
	273
	274	sub zfs_delete_zvol {
	275	my ($class, $scfg, $zvol) = @_;
	276
	277	$class->zfs_request($scfg, undef, 'destroy', '-r', "$scfg->{pool}/$zvol");
	278	}
	279
	280	sub zfs_list_zvol {
	281	my ($class, $scfg) = @_;
	282
	283	my $text = $class->zfs_request($scfg, 10, 'list', '-o', 'name,volsize,origin', '-t', 'volume', '-Hr');
	284	my $zvols = zfs_parse_zvol_list($text);
	285	return undef if !$zvols;
	286
	287	my $list = ();
	288	foreach my $zvol (@$zvols) {
	289	my @values = split('/', $zvol->{name});
290
291	my $image = pop @values;
292	my $pool = join('/', @values);
293
294	next if $image !~ m/^((vm\|base)-(\d+)-\S+)$/;
295	my $owner = $3;
296
297	my $parent = $zvol->{origin};
298	if($zvol->{origin} && $zvol->{origin} =~ m/^$scfg->{pool}\/(\S+)$/){
299	$parent = $1;
300	}
301
302	$list->{$pool}->{$image} = {
303	name => $image,
304	size => $zvol->{size},
305	parent => $parent,
306	format => 'raw',
307	vmid => $owner
308	};
309	}
310
311	return $list;
312	}
313
314	sub zfs_find_free_diskname {
315	my ($class, $storeid, $scfg, $vmid) = @_;
316
317	my $name = undef;
318	my $volumes = $class->zfs_list_zvol($scfg);
319
320	my $disk_ids = {};
321	my $dat = $volumes->{$scfg->{pool}};
322
323	foreach my $image (keys %$dat) {
324	my $volname = $dat->{$image}->{name};
325	if ($volname =~ m/(vm\|base)-$vmid-disk-(\d+)/){
326	$disk_ids->{$2} = 1;
327	}
328	}
329
330	for (my $i = 1; $i < 100; $i++) {
331	if (!$disk_ids->{$i}) {
332	return "vm-$vmid-disk-$i";
333	}
334	}
335
336	die "unable to allocate an image name for VM $vmid in storage '$storeid'\n";
337	}
338
b5e5f7e3 DM	339	sub status {
	340	my ($class, $storeid, $scfg, $cache) = @_;
	341
	342	my $total = 0;
	343	my $free = 0;
	344	my $used = 0;
	345	my $active = 0;
	346
	347	eval {
	348	($free, $used) = $class->zfs_get_pool_stats($scfg);
	349	$active = 1;
	350	$total = $free + $used;
	351	};
	352	warn $@ if $@;
	353
	354	return ($total, $free, $used, $active);
	355	}
	356
	357	sub volume_size_info {
	358	my ($class, $scfg, $storeid, $volname, $timeout) = @_;
	359
	360	return $class->zfs_get_zvol_size($scfg, $volname);
	361	}
	362
	363	sub volume_snapshot {
	364	my ($class, $scfg, $storeid, $volname, $snap, $running) = @_;
	365
	366	$class->zfs_request($scfg, undef, 'snapshot', "$scfg->{pool}/$volname\@$snap");
	367	}
	368
	369	sub volume_snapshot_delete {
	370	my ($class, $scfg, $storeid, $volname, $snap, $running) = @_;
	371
	372	$class->zfs_request($scfg, undef, 'destroy', "$scfg->{pool}/$volname\@$snap");
	373	}
	374
5bb8e010 DM	375
5bb8e010 DM	376	1;