1 package PVE
::Storage
::ZFSPoolPlugin
;
7 use PVE
::Tools
qw(run_command);
8 use PVE
::Storage
::Plugin
;
9 use PVE
::RPCEnvironment
;
12 use base
qw(PVE::Storage::Plugin);
20 content
=> [ {images
=> 1, rootdir
=> 1}, {images
=> 1 , rootdir
=> 1}],
21 format
=> [ { raw
=> 1, subvol
=> 1 } , 'raw' ],
28 description
=> "block size",
32 description
=> "use sparse volumes",
40 pool
=> { fixed
=> 1 },
41 blocksize
=> { optional
=> 1 },
42 sparse
=> { optional
=> 1 },
43 nodes
=> { optional
=> 1 },
44 disable
=> { optional
=> 1 },
45 content
=> { optional
=> 1 },
46 bwlimit
=> { optional
=> 1 },
50 # static zfs helper methods
57 if ($text =~ m/^(\d+(\.\d+)?)([TGMK])?$/) {
59 my ($size, $reminder, $unit) = ($1, $2, $3);
64 } elsif ($unit eq 'M') {
66 } elsif ($unit eq 'G') {
67 $size *= 1024*1024*1024;
68 } elsif ($unit eq 'T') {
69 $size *= 1024*1024*1024*1024;
71 die "got unknown zfs size unit '$unit'\n";
83 warn "unable to parse zfs size '$text'\n";
88 sub zfs_parse_zvol_list
{
93 return $list if !$text;
95 my @lines = split /\n/, $text;
96 foreach my $line (@lines) {
97 my ($dataset, $size, $origin, $type, $refquota) = split(/\s+/, $line);
98 next if !($type eq 'volume' || $type eq 'filesystem');
101 my @parts = split /\//, $dataset;
102 next if scalar(@parts) < 2; # we need pool/name
103 my $name = pop @parts;
104 my $pool = join('/', @parts);
106 next unless $name =~ m!^(vm|base|subvol|basevol)-(\d+)-(\S+)$!;
109 $zvol->{pool
} = $pool;
110 $zvol->{name
} = $name;
111 if ($type eq 'filesystem') {
112 if ($refquota eq 'none') {
115 $zvol->{size
} = zfs_parse_size
($refquota);
117 $zvol->{format
} = 'subvol';
119 $zvol->{size
} = zfs_parse_size
($size);
120 $zvol->{format
} = 'raw';
122 if ($origin !~ /^-$/) {
123 $zvol->{origin
} = $origin;
132 my ($class, $volname) = @_;
134 if ($volname =~ m/^(((base|basevol)-(\d+)-\S+)\/)?
((base
|basevol
|vm
|subvol
)-(\d
+)-\S
+)$/) {
135 my $format = ($6 eq 'subvol' || $6 eq 'basevol') ?
'subvol' : 'raw';
136 my $isBase = ($6 eq 'base' || $6 eq 'basevol');
137 return ('images', $5, $7, $2, $4, $isBase, $format);
140 die "unable to parse zfs volume name '$volname'\n";
143 # virtual zfs methods (subclass can overwrite them)
146 my ($class, $scfg, $volname, $storeid, $snapname) = @_;
148 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
152 if ($vtype eq "images") {
153 if ($name =~ m/^subvol-/ || $name =~ m/^basevol-/) {
154 # fixme: we currently assume standard mount point?!
155 $path = "/$scfg->{pool}/$name";
157 $path = "/dev/zvol/$scfg->{pool}/$name";
159 $path .= "\@$snapname" if defined($snapname);
161 die "$vtype is not allowed in ZFSPool!";
164 return ($path, $vmid, $vtype);
168 my ($class, $scfg, $timeout, $method, @params) = @_;
172 if ($method eq 'zpool_list') {
173 push @$cmd, 'zpool', 'list';
174 } elsif ($method eq 'zpool_import') {
175 push @$cmd, 'zpool', 'import';
176 $timeout = 15 if !$timeout || $timeout < 15;
178 push @$cmd, 'zfs', $method;
183 my $output = sub { $msg .= "$_[0]\n" };
185 $timeout = PVE
::RPCEnvironment-
>is_worker() ?
60*60 : 5 if !$timeout;
187 run_command
($cmd, errmsg
=> "zfs error", outfunc
=> $output, timeout
=> $timeout);
192 sub zfs_wait_for_zvol_link
{
193 my ($class, $scfg, $volname, $timeout) = @_;
195 my $default_timeout = PVE
::RPCEnvironment-
>is_worker() ?
60*5 : 10;
196 $timeout = $default_timeout if !defined($timeout);
198 my ($devname, undef, undef) = $class->path($scfg, $volname);
200 for (my $i = 1; $i <= $timeout; $i++) {
202 die "timeout: no zvol device link for '$volname' found after $timeout sec found.\n"
210 my ($class, $storeid, $scfg, $vmid, $fmt, $name, $size) = @_;
216 die "illegal name '$volname' - should be 'vm-$vmid-*'\n"
217 if $volname && $volname !~ m/^vm-$vmid-/;
218 $volname = $class->zfs_find_free_diskname($storeid, $scfg, $vmid, $fmt)
221 $class->zfs_create_zvol($scfg, $volname, $size);
222 $class->zfs_wait_for_zvol_link($scfg, $volname);
224 } elsif ( $fmt eq 'subvol') {
226 die "illegal name '$volname' - should be 'subvol-$vmid-*'\n"
227 if $volname && $volname !~ m/^subvol-$vmid-/;
228 $volname = $class->zfs_find_free_diskname($storeid, $scfg, $vmid, $fmt)
231 die "illegal name '$volname' - should be 'subvol-$vmid-*'\n"
232 if $volname !~ m/^subvol-$vmid-/;
234 $class->zfs_create_subvol($scfg, $volname, $size);
237 die "unsupported format '$fmt'";
244 my ($class, $storeid, $scfg, $volname, $isBase) = @_;
246 my (undef, $name, undef) = $class->parse_volname($volname);
248 $class->zfs_delete_zvol($scfg, $name);
254 my ($class, $storeid, $scfg, $vmid, $vollist, $cache) = @_;
256 $cache->{zfs
} = $class->zfs_list_zvol($scfg) if !$cache->{zfs
};
257 my $zfspool = $scfg->{pool
};
260 if (my $dat = $cache->{zfs
}->{$zfspool}) {
262 foreach my $image (keys %$dat) {
264 my $info = $dat->{$image};
266 my $volname = $info->{name
};
267 my $parent = $info->{parent
};
268 my $owner = $info->{vmid
};
270 if ($parent && $parent =~ m/^(\S+)\@__base__$/) {
271 my ($basename) = ($1);
272 $info->{volid
} = "$storeid:$basename/$volname";
274 $info->{volid
} = "$storeid:$volname";
278 my $found = grep { $_ eq $info->{volid
} } @$vollist;
281 next if defined ($vmid) && ($owner ne $vmid);
290 sub zfs_get_pool_stats
{
291 my ($class, $scfg) = @_;
296 my $text = $class->zfs_request($scfg, undef, 'get', '-o', 'value', '-Hp',
297 'available,used', $scfg->{pool
});
299 my @lines = split /\n/, $text;
301 if($lines[0] =~ /^(\d+)$/) {
305 if($lines[1] =~ /^(\d+)$/) {
309 return ($available, $used);
312 sub zfs_create_zvol
{
313 my ($class, $scfg, $zvol, $size) = @_;
315 # always align size to 1M as workaround until
316 # https://github.com/zfsonlinux/zfs/issues/8541 is solved
317 my $padding = (1024 - $size % 1024) % 1024;
318 $size = $size + $padding;
320 my $cmd = ['create'];
322 push @$cmd, '-s' if $scfg->{sparse
};
324 push @$cmd, '-b', $scfg->{blocksize
} if $scfg->{blocksize
};
326 push @$cmd, '-V', "${size}k", "$scfg->{pool}/$zvol";
328 $class->zfs_request($scfg, undef, @$cmd);
331 sub zfs_create_subvol
{
332 my ($class, $scfg, $volname, $size) = @_;
334 my $dataset = "$scfg->{pool}/$volname";
336 my $cmd = ['create', '-o', 'acltype=posixacl', '-o', 'xattr=sa',
337 '-o', "refquota=${size}k", $dataset];
339 $class->zfs_request($scfg, undef, @$cmd);
342 sub zfs_delete_zvol
{
343 my ($class, $scfg, $zvol) = @_;
347 for (my $i = 0; $i < 6; $i++) {
349 eval { $class->zfs_request($scfg, undef, 'destroy', '-r', "$scfg->{pool}/$zvol"); };
351 if ($err =~ m/^zfs error:(.*): dataset is busy.*/) {
353 } elsif ($err =~ m/^zfs error:.*: dataset does not exist.*$/) {
368 my ($class, $scfg) = @_;
370 my $text = $class->zfs_request($scfg, 10, 'list', '-o', 'name,volsize,origin,type,refquota', '-t', 'volume,filesystem', '-Hr');
371 my $zvols = zfs_parse_zvol_list
($text);
372 return undef if !$zvols;
375 foreach my $zvol (@$zvols) {
376 my $pool = $zvol->{pool
};
377 my $name = $zvol->{name
};
378 my $parent = $zvol->{origin
};
379 if($zvol->{origin
} && $zvol->{origin
} =~ m/^$scfg->{pool}\/(\S
+)$/){
383 $list->{$pool}->{$name} = {
385 size
=> $zvol->{size
},
387 format
=> $zvol->{format
},
388 vmid
=> $zvol->{owner
},
395 sub zfs_find_free_diskname
{
396 my ($class, $storeid, $scfg, $vmid, $format) = @_;
398 my $volumes = $class->zfs_list_zvol($scfg);
399 my $dat = $volumes->{$scfg->{pool
}};
401 my $disk_list = [ keys %$dat ];
402 return PVE
::Storage
::Plugin
::get_next_vm_diskname
($disk_list, $storeid, $vmid, $format, $scfg);
405 sub zfs_get_latest_snapshot
{
406 my ($class, $scfg, $volname) = @_;
408 my $vname = ($class->parse_volname($volname))[1];
410 # abort rollback if snapshot is not the latest
411 my @params = ('-t', 'snapshot', '-o', 'name', '-s', 'creation');
412 my $text = $class->zfs_request($scfg, undef, 'list', @params);
413 my @snapshots = split(/\n/, $text);
416 foreach (@snapshots) {
417 if (/$scfg->{pool}\/$vname/) {
427 my ($class, $storeid, $scfg, $cache) = @_;
435 ($free, $used) = $class->zfs_get_pool_stats($scfg);
437 $total = $free + $used;
441 return ($total, $free, $used, $active);
444 sub volume_size_info
{
445 my ($class, $scfg, $storeid, $volname, $timeout) = @_;
447 my (undef, $vname, undef, undef, undef, undef, $format) =
448 $class->parse_volname($volname);
450 my $attr = $format eq 'subvol' ?
'refquota' : 'volsize';
451 my $text = $class->zfs_request($scfg, undef, 'get', '-Hp', $attr, "$scfg->{pool}/$vname");
452 if ($text =~ /\s$attr\s(\d+)\s/) {
456 die "Could not get zfs volume size\n";
459 sub volume_snapshot
{
460 my ($class, $scfg, $storeid, $volname, $snap) = @_;
462 my $vname = ($class->parse_volname($volname))[1];
464 $class->zfs_request($scfg, undef, 'snapshot', "$scfg->{pool}/$vname\@$snap");
467 sub volume_snapshot_delete
{
468 my ($class, $scfg, $storeid, $volname, $snap, $running) = @_;
470 my $vname = ($class->parse_volname($volname))[1];
472 $class->deactivate_volume($storeid, $scfg, $vname, $snap, {});
473 $class->zfs_request($scfg, undef, 'destroy', "$scfg->{pool}/$vname\@$snap");
476 sub volume_snapshot_rollback
{
477 my ($class, $scfg, $storeid, $volname, $snap) = @_;
479 my $vname = ($class->parse_volname($volname))[1];
481 $class->zfs_request($scfg, undef, 'rollback', "$scfg->{pool}/$vname\@$snap");
484 sub volume_rollback_is_possible
{
485 my ($class, $scfg, $storeid, $volname, $snap) = @_;
487 my $recentsnap = $class->zfs_get_latest_snapshot($scfg, $volname);
488 if ($snap ne $recentsnap) {
489 die "can't rollback, more recent snapshots exist\n";
495 sub volume_snapshot_list
{
496 my ($class, $scfg, $storeid, $volname) = @_;
498 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
500 my $zpath = "$scfg->{pool}/$name";
504 my $cmd = ['zfs', 'list', '-r', '-H', '-S', 'name', '-t', 'snap', '-o',
510 if ($line =~ m/^\Q$zpath\E@(.*)$/) {
515 eval { run_command
( [$cmd], outfunc
=> $outfunc , errfunc
=> sub{}); };
517 # return an empty array if dataset does not exist.
521 sub activate_storage
{
522 my ($class, $storeid, $scfg, $cache) = @_;
524 # Note: $scfg->{pool} can include dataset <pool>/<dataset>
525 my $pool = $scfg->{pool
};
528 my $pool_imported = sub {
529 my @param = ('-o', 'name', '-H', "$pool");
530 my $res = eval { $class->zfs_request($scfg, undef, 'zpool_list', @param) };
535 return defined($res) && $res =~ m/$pool/;
538 if (!$pool_imported->()) {
539 # import can only be done if not yet imported!
540 my @param = ('-d', '/dev/disk/by-id/', '-o', 'cachefile=none', "$pool");
541 eval { $class->zfs_request($scfg, undef, 'zpool_import', @param) };
543 # just could've raced with another import, so recheck if it is imported
544 die "could not activate storage '$storeid', $@\n" if !$pool_imported->();
550 sub deactivate_storage
{
551 my ($class, $storeid, $scfg, $cache) = @_;
555 sub activate_volume
{
556 my ($class, $storeid, $scfg, $volname, $snapname, $cache) = @_;
558 return 1 if defined($snapname);
560 my (undef, undef, undef, undef, undef, undef, $format) = $class->parse_volname($volname);
562 return 1 if $format ne 'raw';
564 $class->zfs_wait_for_zvol_link($scfg, $volname);
569 sub deactivate_volume
{
570 my ($class, $storeid, $scfg, $volname, $snapname, $cache) = @_;
575 my ($class, $scfg, $storeid, $volname, $vmid, $snap) = @_;
577 $snap ||= '__base__';
579 my ($vtype, $basename, $basevmid, undef, undef, $isBase, $format) =
580 $class->parse_volname($volname);
582 die "clone_image only works on base images\n" if !$isBase;
584 my $name = $class->zfs_find_free_diskname($storeid, $scfg, $vmid, $format);
586 if ($format eq 'subvol') {
587 my $size = $class->zfs_request($scfg, undef, 'list', '-H', '-o', 'refquota', "$scfg->{pool}/$basename");
589 $class->zfs_request($scfg, undef, 'clone', "$scfg->{pool}/$basename\@$snap", "$scfg->{pool}/$name", '-o', "refquota=$size");
591 $class->zfs_request($scfg, undef, 'clone', "$scfg->{pool}/$basename\@$snap", "$scfg->{pool}/$name");
594 return "$basename/$name";
598 my ($class, $storeid, $scfg, $volname) = @_;
600 my $snap = '__base__';
602 my ($vtype, $name, $vmid, $basename, $basevmid, $isBase, $format) =
603 $class->parse_volname($volname);
605 die "create_base not possible with base image\n" if $isBase;
608 if ( $format eq 'subvol' ) {
609 $newname =~ s/^subvol-/basevol-/;
611 $newname =~ s/^vm-/base-/;
613 my $newvolname = $basename ?
"$basename/$newname" : "$newname";
615 $class->zfs_request($scfg, undef, 'rename', "$scfg->{pool}/$name", "$scfg->{pool}/$newname");
617 my $running = undef; #fixme : is create_base always offline ?
619 $class->volume_snapshot($scfg, $storeid, $newname, $snap, $running);
625 my ($class, $scfg, $storeid, $volname, $size, $running) = @_;
627 my $new_size = int($size/1024);
629 my (undef, $vname, undef, undef, undef, undef, $format) =
630 $class->parse_volname($volname);
632 my $attr = $format eq 'subvol' ?
'refquota' : 'volsize';
634 $class->zfs_request($scfg, undef, 'set', "$attr=${new_size}k", "$scfg->{pool}/$vname");
639 sub storage_can_replicate
{
640 my ($class, $scfg, $storeid, $format) = @_;
642 return 1 if $format eq 'raw' || $format eq 'subvol';
647 sub volume_has_feature
{
648 my ($class, $scfg, $feature, $storeid, $volname, $snapname, $running) = @_;
651 snapshot
=> { current
=> 1, snap
=> 1},
652 clone
=> { base
=> 1},
653 template
=> { current
=> 1},
654 copy
=> { base
=> 1, current
=> 1},
655 sparseinit
=> { base
=> 1, current
=> 1},
656 replicate
=> { base
=> 1, current
=> 1},
659 my ($vtype, $name, $vmid, $basename, $basevmid, $isBase) =
660 $class->parse_volname($volname);
667 $key = $isBase ?
'base' : 'current';
670 return 1 if $features->{$feature}->{$key};
676 my ($class, $scfg, $storeid, $fh, $volname, $format, $snapshot, $base_snapshot, $with_snapshots) = @_;
678 die "unsupported export stream format for $class: $format\n"
681 die "$class storage can only export snapshots\n"
682 if !defined($snapshot);
684 my $dataset = ($class->parse_volname($volname))[1];
686 my $fd = fileno($fh);
687 die "internal error: invalid file handle for volume_export\n"
691 # For zfs we always create a replication stream (-R) which means the remote
692 # side will always delete non-existing source snapshots. This should work
693 # for all our use cases.
694 my $cmd = ['zfs', 'send', '-Rpv'];
695 if (defined($base_snapshot)) {
696 my $arg = $with_snapshots ?
'-I' : '-i';
697 push @$cmd, $arg, $base_snapshot;
699 push @$cmd, '--', "$scfg->{pool}/$dataset\@$snapshot";
701 run_command
($cmd, output
=> $fd);
706 sub volume_export_formats
{
707 my ($class, $scfg, $storeid, $volname, $snapshot, $base_snapshot, $with_snapshots) = @_;
709 my @formats = ('zfs');
711 # push @formats, 'fies' if $volname !~ /^(?:basevol|subvol)-/;
712 # push @formats, 'raw' if !$base_snapshot && !$with_snapshots;
717 my ($class, $scfg, $storeid, $fh, $volname, $format, $base_snapshot, $with_snapshots) = @_;
719 die "unsupported import stream format for $class: $format\n"
722 my $fd = fileno($fh);
723 die "internal error: invalid file handle for volume_import\n"
726 my $dataset = ($class->parse_volname($volname))[1];
727 my $zfspath = "$scfg->{pool}/$dataset";
728 my $suffix = defined($base_snapshot) ?
"\@$base_snapshot" : '';
729 my $exists = 0 == run_command
(['zfs', 'get', '-H', 'name', $zfspath.$suffix],
730 noerr
=> 1, errfunc
=> sub {});
731 if (defined($base_snapshot)) {
732 die "base snapshot '$zfspath\@$base_snapshot' doesn't exist\n" if !$exists;
734 die "volume '$zfspath' already exists\n" if $exists;
737 eval { run_command
(['zfs', 'recv', '-F', '--', $zfspath], input
=> "<&$fd") };
739 if (defined($base_snapshot)) {
740 eval { run_command
(['zfs', 'rollback', '-r', '--', "$zfspath\@$base_snapshot"]) };
742 eval { run_command
(['zfs', 'destroy', '-r', '--', $zfspath]) };
750 sub volume_import_formats
{
751 my ($class, $scfg, $storeid, $volname, $base_snapshot, $with_snapshots) = @_;
753 return $class->volume_export_formats($scfg, $storeid, $volname, undef, $base_snapshot, $with_snapshots);