]>
Commit | Line | Data |
---|---|---|
85fda4dd | 1 | package PVE::Storage::ZFSPoolPlugin; |
5bb8e010 DM |
2 | |
3 | use strict; | |
4 | use warnings; | |
e3eb131e | 5 | |
5bb8e010 | 6 | use IO::File; |
e3eb131e | 7 | use Net::IP; |
5bb8e010 | 8 | use POSIX; |
e3eb131e | 9 | |
56a7637a | 10 | use PVE::ProcFSTools; |
21430e50 | 11 | use PVE::RPCEnvironment; |
e3eb131e TL |
12 | use PVE::Storage::Plugin; |
13 | use PVE::Tools qw(run_command); | |
5bb8e010 DM |
14 | |
15 | use base qw(PVE::Storage::Plugin); | |
16 | ||
5bb8e010 | 17 | sub type { |
85fda4dd | 18 | return 'zfspool'; |
5bb8e010 DM |
19 | } |
20 | ||
21 | sub plugindata { | |
22 | return { | |
1ccae449 DM |
23 | content => [ {images => 1, rootdir => 1}, {images => 1 , rootdir => 1}], |
24 | format => [ { raw => 1, subvol => 1 } , 'raw' ], | |
5bb8e010 | 25 | }; |
85fda4dd | 26 | } |
5bb8e010 | 27 | |
7730694e DM |
28 | sub properties { |
29 | return { | |
30 | blocksize => { | |
31 | description => "block size", | |
32 | type => 'string', | |
33 | }, | |
34 | sparse => { | |
35 | description => "use sparse volumes", | |
36 | type => 'boolean', | |
37 | }, | |
dcefd9dd FE |
38 | mountpoint => { |
39 | description => "mount point", | |
40 | type => 'string', format => 'pve-storage-path', | |
41 | }, | |
7730694e DM |
42 | }; |
43 | } | |
44 | ||
5bb8e010 DM |
45 | sub options { |
46 | return { | |
7730694e DM |
47 | pool => { fixed => 1 }, |
48 | blocksize => { optional => 1 }, | |
49 | sparse => { optional => 1 }, | |
50 | nodes => { optional => 1 }, | |
5bb8e010 | 51 | disable => { optional => 1 }, |
5bb8e010 | 52 | content => { optional => 1 }, |
9edb99a5 | 53 | bwlimit => { optional => 1 }, |
dcefd9dd | 54 | mountpoint => { optional => 1 }, |
5bb8e010 DM |
55 | }; |
56 | } | |
57 | ||
7730694e DM |
58 | # static zfs helper methods |
59 | ||
7730694e | 60 | sub zfs_parse_zvol_list { |
4c82e7b6 | 61 | my ($text, $pool) = @_; |
7730694e DM |
62 | |
63 | my $list = (); | |
64 | ||
65 | return $list if !$text; | |
66 | ||
67 | my @lines = split /\n/, $text; | |
68 | foreach my $line (@lines) { | |
1ccae449 DM |
69 | my ($dataset, $size, $origin, $type, $refquota) = split(/\s+/, $line); |
70 | next if !($type eq 'volume' || $type eq 'filesystem'); | |
71 | ||
72 | my $zvol = {}; | |
73 | my @parts = split /\//, $dataset; | |
dec97937 | 74 | next if scalar(@parts) < 2; # we need pool/name |
1ccae449 | 75 | my $name = pop @parts; |
4c82e7b6 FE |
76 | my $parsed_pool = join('/', @parts); |
77 | next if $parsed_pool ne $pool; | |
1ccae449 | 78 | |
851658c3 | 79 | next unless $name =~ m!^(vm|base|subvol|basevol)-(\d+)-(\S+)$!; |
1ccae449 DM |
80 | $zvol->{owner} = $2; |
81 | ||
1ccae449 DM |
82 | $zvol->{name} = $name; |
83 | if ($type eq 'filesystem') { | |
84 | if ($refquota eq 'none') { | |
85 | $zvol->{size} = 0; | |
86 | } else { | |
3881e680 | 87 | $zvol->{size} = $refquota + 0; |
7730694e | 88 | } |
1ccae449 DM |
89 | $zvol->{format} = 'subvol'; |
90 | } else { | |
3881e680 | 91 | $zvol->{size} = $size + 0; |
1ccae449 | 92 | $zvol->{format} = 'raw'; |
7730694e | 93 | } |
1ccae449 DM |
94 | if ($origin !~ /^-$/) { |
95 | $zvol->{origin} = $origin; | |
96 | } | |
97 | push @$list, $zvol; | |
7730694e DM |
98 | } |
99 | ||
100 | return $list; | |
101 | } | |
102 | ||
cc80ed9c WL |
103 | sub parse_volname { |
104 | my ($class, $volname) = @_; | |
105 | ||
8e5b96ca DM |
106 | if ($volname =~ m/^(((base|basevol)-(\d+)-\S+)\/)?((base|basevol|vm|subvol)-(\d+)-\S+)$/) { |
107 | my $format = ($6 eq 'subvol' || $6 eq 'basevol') ? 'subvol' : 'raw'; | |
108 | my $isBase = ($6 eq 'base' || $6 eq 'basevol'); | |
109 | return ('images', $5, $7, $2, $4, $isBase, $format); | |
cc80ed9c WL |
110 | } |
111 | ||
112 | die "unable to parse zfs volume name '$volname'\n"; | |
113 | } | |
114 | ||
7730694e DM |
115 | # virtual zfs methods (subclass can overwrite them) |
116 | ||
dcefd9dd FE |
117 | sub on_add_hook { |
118 | my ($class, $storeid, $scfg, %param) = @_; | |
119 | ||
120 | my $cfg_mountpoint = $scfg->{mountpoint}; | |
dcefd9dd FE |
121 | |
122 | # ignore failure, pool might currently not be imported | |
75815bf5 FE |
123 | my $mountpoint; |
124 | eval { | |
125 | my $res = $class->zfs_get_properties($scfg, 'mountpoint', $scfg->{pool}, 1); | |
126 | $mountpoint = PVE::Storage::Plugin::verify_path($res, 1) if defined($res); | |
dcefd9dd FE |
127 | }; |
128 | ||
129 | if (defined($cfg_mountpoint)) { | |
130 | if (defined($mountpoint) && !($cfg_mountpoint =~ m|^\Q$mountpoint\E/?$|)) { | |
131 | warn "warning for $storeid - mountpoint: $cfg_mountpoint " . | |
132 | "does not match current mount point: $mountpoint\n"; | |
133 | } | |
134 | } else { | |
135 | $scfg->{mountpoint} = $mountpoint; | |
136 | } | |
f3ccd0ef FE |
137 | |
138 | return; | |
dcefd9dd FE |
139 | } |
140 | ||
f3e632d0 | 141 | sub path { |
e67069eb | 142 | my ($class, $scfg, $volname, $storeid, $snapname) = @_; |
f3e632d0 WL |
143 | |
144 | my ($vtype, $name, $vmid) = $class->parse_volname($volname); | |
145 | ||
146 | my $path = ''; | |
dcefd9dd | 147 | my $mountpoint = $scfg->{mountpoint} // "/$scfg->{pool}"; |
f3e632d0 | 148 | |
1ccae449 | 149 | if ($vtype eq "images") { |
74b724a6 | 150 | if ($name =~ m/^subvol-/ || $name =~ m/^basevol-/) { |
dcefd9dd | 151 | $path = "$mountpoint/$name"; |
1ccae449 | 152 | } else { |
851658c3 | 153 | $path = "/dev/zvol/$scfg->{pool}/$name"; |
1ccae449 | 154 | } |
f482231e | 155 | $path .= "\@$snapname" if defined($snapname); |
f3e632d0 | 156 | } else { |
85fda4dd | 157 | die "$vtype is not allowed in ZFSPool!"; |
f3e632d0 WL |
158 | } |
159 | ||
160 | return ($path, $vmid, $vtype); | |
161 | } | |
162 | ||
7730694e | 163 | sub zfs_request { |
44257d2e | 164 | my ($class, $scfg, $timeout, $method, @params) = @_; |
7730694e | 165 | |
7730694e DM |
166 | my $cmd = []; |
167 | ||
168 | if ($method eq 'zpool_list') { | |
86d47239 | 169 | push @$cmd, 'zpool', 'list'; |
e2e63801 FG |
170 | } elsif ($method eq 'zpool_import') { |
171 | push @$cmd, 'zpool', 'import'; | |
e9ab8ea3 | 172 | $timeout = 15 if !$timeout || $timeout < 15; |
7730694e DM |
173 | } else { |
174 | push @$cmd, 'zfs', $method; | |
175 | } | |
7730694e | 176 | push @$cmd, @params; |
7730694e | 177 | |
a10695b4 TL |
178 | my $msg = ''; |
179 | my $output = sub { $msg .= "$_[0]\n" }; | |
7730694e | 180 | |
4cd9b85d DC |
181 | if (PVE::RPCEnvironment->is_worker()) { |
182 | $timeout = 60*60 if !$timeout; | |
183 | $timeout = 60*5 if $timeout < 60*5; | |
184 | } else { | |
7a8751a2 | 185 | $timeout = 10 if !$timeout; |
4cd9b85d | 186 | } |
72bdeea1 | 187 | |
1f390a30 | 188 | run_command($cmd, errmsg => "zfs error", outfunc => $output, timeout => $timeout); |
7730694e DM |
189 | |
190 | return $msg; | |
191 | } | |
192 | ||
56362cfb FG |
193 | sub zfs_wait_for_zvol_link { |
194 | my ($class, $scfg, $volname, $timeout) = @_; | |
195 | ||
196 | my $default_timeout = PVE::RPCEnvironment->is_worker() ? 60*5 : 10; | |
197 | $timeout = $default_timeout if !defined($timeout); | |
198 | ||
199 | my ($devname, undef, undef) = $class->path($scfg, $volname); | |
200 | ||
201 | for (my $i = 1; $i <= $timeout; $i++) { | |
202 | last if -b $devname; | |
203 | die "timeout: no zvol device link for '$volname' found after $timeout sec found.\n" | |
204 | if $i == $timeout; | |
205 | ||
206 | sleep(1); | |
207 | } | |
208 | } | |
209 | ||
b3ba95e4 WL |
210 | sub alloc_image { |
211 | my ($class, $storeid, $scfg, $vmid, $fmt, $name, $size) = @_; | |
212 | ||
1ccae449 | 213 | my $volname = $name; |
3824ba88 | 214 | |
1ccae449 | 215 | if ($fmt eq 'raw') { |
b3ba95e4 | 216 | |
fc05c9a0 | 217 | die "illegal name '$volname' - should be 'vm-$vmid-*'\n" |
1ccae449 | 218 | if $volname && $volname !~ m/^vm-$vmid-/; |
a44c0147 | 219 | $volname = $class->find_free_diskname($storeid, $scfg, $vmid, $fmt) |
1ccae449 | 220 | if !$volname; |
b3ba95e4 | 221 | |
1ccae449 | 222 | $class->zfs_create_zvol($scfg, $volname, $size); |
56362cfb | 223 | $class->zfs_wait_for_zvol_link($scfg, $volname); |
82e08809 | 224 | |
1ccae449 | 225 | } elsif ( $fmt eq 'subvol') { |
55525ad2 | 226 | |
fc05c9a0 | 227 | die "illegal name '$volname' - should be 'subvol-$vmid-*'\n" |
55525ad2 | 228 | if $volname && $volname !~ m/^subvol-$vmid-/; |
a44c0147 | 229 | $volname = $class->find_free_diskname($storeid, $scfg, $vmid, $fmt) |
55525ad2 DM |
230 | if !$volname; |
231 | ||
fc05c9a0 | 232 | die "illegal name '$volname' - should be 'subvol-$vmid-*'\n" |
1ccae449 | 233 | if $volname !~ m/^subvol-$vmid-/; |
76fd7dc7 | 234 | |
3824ba88 FE |
235 | $class->zfs_create_subvol($scfg, $volname, $size); |
236 | ||
1ccae449 DM |
237 | } else { |
238 | die "unsupported format '$fmt'"; | |
239 | } | |
b3ba95e4 | 240 | |
82e08809 | 241 | return $volname; |
b3ba95e4 WL |
242 | } |
243 | ||
e9565df5 WL |
244 | sub free_image { |
245 | my ($class, $storeid, $scfg, $volname, $isBase) = @_; | |
246 | ||
247 | my (undef, $name, undef) = $class->parse_volname($volname); | |
248 | ||
249 | $class->zfs_delete_zvol($scfg, $name); | |
250 | ||
251 | return undef; | |
252 | } | |
253 | ||
ca04180f WL |
254 | sub list_images { |
255 | my ($class, $storeid, $scfg, $vmid, $vollist, $cache) = @_; | |
256 | ||
ebcb12ee | 257 | my $zfs_list = $class->zfs_list_zvol($scfg); |
c2e6a90d | 258 | |
ca04180f WL |
259 | my $res = []; |
260 | ||
39eb2686 FE |
261 | for my $info (values $zfs_list->%*) { |
262 | my $volname = $info->{name}; | |
263 | my $parent = $info->{parent}; | |
264 | my $owner = $info->{vmid}; | |
ca04180f | 265 | |
39eb2686 FE |
266 | if ($parent && $parent =~ m/^(\S+)\@__base__$/) { |
267 | my ($basename) = ($1); | |
268 | $info->{volid} = "$storeid:$basename/$volname"; | |
269 | } else { | |
270 | $info->{volid} = "$storeid:$volname"; | |
271 | } | |
ca04180f | 272 | |
39eb2686 FE |
273 | if ($vollist) { |
274 | my $found = grep { $_ eq $info->{volid} } @$vollist; | |
275 | next if !$found; | |
276 | } else { | |
277 | next if defined ($vmid) && ($owner ne $vmid); | |
ca04180f | 278 | } |
39eb2686 FE |
279 | |
280 | push @$res, $info; | |
ca04180f | 281 | } |
ca04180f WL |
282 | return $res; |
283 | } | |
284 | ||
4966c886 FE |
285 | sub zfs_get_properties { |
286 | my ($class, $scfg, $properties, $dataset, $timeout) = @_; | |
287 | ||
288 | my $result = $class->zfs_request($scfg, $timeout, 'get', '-o', 'value', | |
289 | '-Hp', $properties, $dataset); | |
290 | my @values = split /\n/, $result; | |
291 | return wantarray ? @values : $values[0]; | |
292 | } | |
293 | ||
7730694e DM |
294 | sub zfs_get_pool_stats { |
295 | my ($class, $scfg) = @_; | |
296 | ||
297 | my $available = 0; | |
298 | my $used = 0; | |
299 | ||
4966c886 | 300 | my @lines = $class->zfs_get_properties($scfg, 'available,used', $scfg->{pool}); |
7730694e DM |
301 | |
302 | if($lines[0] =~ /^(\d+)$/) { | |
303 | $available = $1; | |
304 | } | |
305 | ||
306 | if($lines[1] =~ /^(\d+)$/) { | |
307 | $used = $1; | |
308 | } | |
309 | ||
310 | return ($available, $used); | |
311 | } | |
312 | ||
7730694e DM |
313 | sub zfs_create_zvol { |
314 | my ($class, $scfg, $zvol, $size) = @_; | |
cdef3abb ML |
315 | |
316 | # always align size to 1M as workaround until | |
317 | # https://github.com/zfsonlinux/zfs/issues/8541 is solved | |
318 | my $padding = (1024 - $size % 1024) % 1024; | |
319 | $size = $size + $padding; | |
320 | ||
7730694e DM |
321 | my $cmd = ['create']; |
322 | ||
323 | push @$cmd, '-s' if $scfg->{sparse}; | |
324 | ||
325 | push @$cmd, '-b', $scfg->{blocksize} if $scfg->{blocksize}; | |
326 | ||
327 | push @$cmd, '-V', "${size}k", "$scfg->{pool}/$zvol"; | |
328 | ||
44257d2e | 329 | $class->zfs_request($scfg, undef, @$cmd); |
7730694e DM |
330 | } |
331 | ||
1ccae449 DM |
332 | sub zfs_create_subvol { |
333 | my ($class, $scfg, $volname, $size) = @_; | |
334 | ||
335 | my $dataset = "$scfg->{pool}/$volname"; | |
8c858f7e | 336 | my $quota = $size ? "${size}k" : "none"; |
3824ba88 | 337 | |
efaf4017 | 338 | my $cmd = ['create', '-o', 'acltype=posixacl', '-o', 'xattr=sa', |
8c858f7e | 339 | '-o', "refquota=${quota}", $dataset]; |
1ccae449 | 340 | |
44257d2e | 341 | $class->zfs_request($scfg, undef, @$cmd); |
1ccae449 DM |
342 | } |
343 | ||
7730694e DM |
344 | sub zfs_delete_zvol { |
345 | my ($class, $scfg, $zvol) = @_; | |
346 | ||
1f390a30 WL |
347 | my $err; |
348 | ||
349 | for (my $i = 0; $i < 6; $i++) { | |
350 | ||
44257d2e | 351 | eval { $class->zfs_request($scfg, undef, 'destroy', '-r', "$scfg->{pool}/$zvol"); }; |
1f390a30 WL |
352 | if ($err = $@) { |
353 | if ($err =~ m/^zfs error:(.*): dataset is busy.*/) { | |
354 | sleep(1); | |
27ff0e99 WL |
355 | } elsif ($err =~ m/^zfs error:.*: dataset does not exist.*$/) { |
356 | $err = undef; | |
357 | last; | |
1f390a30 WL |
358 | } else { |
359 | die $err; | |
360 | } | |
361 | } else { | |
362 | last; | |
363 | } | |
364 | } | |
365 | ||
366 | die $err if $err; | |
7730694e DM |
367 | } |
368 | ||
369 | sub zfs_list_zvol { | |
370 | my ($class, $scfg) = @_; | |
371 | ||
c2e6a90d FE |
372 | my $text = $class->zfs_request( |
373 | $scfg, | |
374 | 10, | |
375 | 'list', | |
376 | '-o', | |
377 | 'name,volsize,origin,type,refquota', | |
378 | '-t', | |
379 | 'volume,filesystem', | |
d05015f8 FE |
380 | '-d1', |
381 | '-Hp', | |
c2e6a90d FE |
382 | $scfg->{pool}, |
383 | ); | |
d05015f8 FE |
384 | # It's still required to have zfs_parse_zvol_list filter by pool, because -d1 lists |
385 | # $scfg->{pool} too and while unlikely, it could be named to be mistaken for a volume. | |
4c82e7b6 | 386 | my $zvols = zfs_parse_zvol_list($text, $scfg->{pool}); |
ebcb12ee | 387 | return {} if !$zvols; |
7730694e | 388 | |
ebcb12ee | 389 | my $list = {}; |
7730694e | 390 | foreach my $zvol (@$zvols) { |
1ccae449 | 391 | my $name = $zvol->{name}; |
7730694e DM |
392 | my $parent = $zvol->{origin}; |
393 | if($zvol->{origin} && $zvol->{origin} =~ m/^$scfg->{pool}\/(\S+)$/){ | |
394 | $parent = $1; | |
395 | } | |
396 | ||
c2e6a90d | 397 | $list->{$name} = { |
1ccae449 | 398 | name => $name, |
7730694e DM |
399 | size => $zvol->{size}, |
400 | parent => $parent, | |
1ccae449 DM |
401 | format => $zvol->{format}, |
402 | vmid => $zvol->{owner}, | |
7730694e DM |
403 | }; |
404 | } | |
405 | ||
406 | return $list; | |
407 | } | |
408 | ||
ac5c1af5 FE |
409 | sub zfs_get_sorted_snapshot_list { |
410 | my ($class, $scfg, $volname, $sort_params) = @_; | |
2fc59177 | 411 | |
73dfe360 FE |
412 | my @params = ('-H', '-r', '-t', 'snapshot', '-o', 'name', $sort_params->@*); |
413 | ||
851658c3 | 414 | my $vname = ($class->parse_volname($volname))[1]; |
73dfe360 | 415 | push @params, "$scfg->{pool}\/$vname"; |
851658c3 | 416 | |
44257d2e | 417 | my $text = $class->zfs_request($scfg, undef, 'list', @params); |
2fc59177 DM |
418 | my @snapshots = split(/\n/, $text); |
419 | ||
ac5c1af5 FE |
420 | my $snap_names = []; |
421 | for my $snapshot (@snapshots) { | |
422 | (my $snap_name = $snapshot) =~ s/^.*@//; | |
423 | push $snap_names->@*, $snap_name; | |
2fc59177 | 424 | } |
ac5c1af5 | 425 | return $snap_names; |
2fc59177 DM |
426 | } |
427 | ||
b5e5f7e3 DM |
428 | sub status { |
429 | my ($class, $storeid, $scfg, $cache) = @_; | |
430 | ||
431 | my $total = 0; | |
432 | my $free = 0; | |
433 | my $used = 0; | |
434 | my $active = 0; | |
435 | ||
436 | eval { | |
437 | ($free, $used) = $class->zfs_get_pool_stats($scfg); | |
438 | $active = 1; | |
439 | $total = $free + $used; | |
440 | }; | |
441 | warn $@ if $@; | |
442 | ||
443 | return ($total, $free, $used, $active); | |
444 | } | |
445 | ||
446 | sub volume_size_info { | |
447 | my ($class, $scfg, $storeid, $volname, $timeout) = @_; | |
448 | ||
851658c3 | 449 | my (undef, $vname, undef, undef, undef, undef, $format) = |
79f2b938 DM |
450 | $class->parse_volname($volname); |
451 | ||
452 | my $attr = $format eq 'subvol' ? 'refquota' : 'volsize'; | |
4966c886 FE |
453 | my $value = $class->zfs_get_properties($scfg, $attr, "$scfg->{pool}/$vname"); |
454 | if ($value =~ /^(\d+)$/) { | |
79f2b938 DM |
455 | return $1; |
456 | } | |
457 | ||
458 | die "Could not get zfs volume size\n"; | |
b5e5f7e3 DM |
459 | } |
460 | ||
461 | sub volume_snapshot { | |
f5640e7d | 462 | my ($class, $scfg, $storeid, $volname, $snap) = @_; |
b5e5f7e3 | 463 | |
851658c3 WL |
464 | my $vname = ($class->parse_volname($volname))[1]; |
465 | ||
44257d2e | 466 | $class->zfs_request($scfg, undef, 'snapshot', "$scfg->{pool}/$vname\@$snap"); |
b5e5f7e3 DM |
467 | } |
468 | ||
469 | sub volume_snapshot_delete { | |
470 | my ($class, $scfg, $storeid, $volname, $snap, $running) = @_; | |
471 | ||
851658c3 WL |
472 | my $vname = ($class->parse_volname($volname))[1]; |
473 | ||
474 | $class->deactivate_volume($storeid, $scfg, $vname, $snap, {}); | |
44257d2e | 475 | $class->zfs_request($scfg, undef, 'destroy', "$scfg->{pool}/$vname\@$snap"); |
b5e5f7e3 DM |
476 | } |
477 | ||
2b40ffae WL |
478 | sub volume_snapshot_rollback { |
479 | my ($class, $scfg, $storeid, $volname, $snap) = @_; | |
480 | ||
26a8f21a DC |
481 | my (undef, $vname, undef, undef, undef, undef, $format) = $class->parse_volname($volname); |
482 | ||
483 | my $msg = $class->zfs_request($scfg, undef, 'rollback', "$scfg->{pool}/$vname\@$snap"); | |
851658c3 | 484 | |
26a8f21a DC |
485 | # we have to unmount rollbacked subvols, to invalidate wrong kernel |
486 | # caches, they get mounted in activate volume again | |
487 | # see zfs bug #10931 https://github.com/openzfs/zfs/issues/10931 | |
488 | if ($format eq 'subvol') { | |
ab3516a6 FE |
489 | eval { $class->zfs_request($scfg, undef, 'unmount', "$scfg->{pool}/$vname"); }; |
490 | if (my $err = $@) { | |
491 | die $err if $err !~ m/not currently mounted$/; | |
492 | } | |
26a8f21a DC |
493 | } |
494 | ||
495 | return $msg; | |
1597f1f9 WL |
496 | } |
497 | ||
498 | sub volume_rollback_is_possible { | |
9a5d5095 | 499 | my ($class, $scfg, $storeid, $volname, $snap, $blockers) = @_; |
3824ba88 | 500 | |
ac5c1af5 FE |
501 | # can't use '-S creation', because zfs list won't reverse the order when the |
502 | # creation time is the same second, breaking at least our tests. | |
503 | my $snapshots = $class->zfs_get_sorted_snapshot_list($scfg, $volname, ['-s', 'creation']); | |
c8eb0178 | 504 | |
9a5d5095 FE |
505 | my $found; |
506 | $blockers //= []; # not guaranteed to be set by caller | |
507 | for my $snapshot ($snapshots->@*) { | |
508 | if ($snapshot eq $snap) { | |
509 | $found = 1; | |
510 | } elsif ($found) { | |
511 | push $blockers->@*, $snapshot; | |
512 | } | |
513 | } | |
514 | ||
515 | my $volid = "${storeid}:${volname}"; | |
516 | ||
517 | die "can't rollback, snapshot '$snap' does not exist on '$volid'\n" | |
518 | if !$found; | |
c8eb0178 | 519 | |
9a5d5095 FE |
520 | die "can't rollback, '$snap' is not most recent snapshot on '$volid'\n" |
521 | if scalar($blockers->@*) > 0; | |
2b40ffae | 522 | |
3824ba88 | 523 | return 1; |
2b40ffae WL |
524 | } |
525 | ||
8c20d8af FE |
526 | sub volume_snapshot_info { |
527 | my ($class, $scfg, $storeid, $volname) = @_; | |
528 | ||
73dfe360 FE |
529 | my @params = ('-Hp', '-r', '-t', 'snapshot', '-o', 'name,guid,creation'); |
530 | ||
8c20d8af | 531 | my $vname = ($class->parse_volname($volname))[1]; |
73dfe360 | 532 | push @params, "$scfg->{pool}\/$vname"; |
8c20d8af | 533 | |
8c20d8af FE |
534 | my $text = $class->zfs_request($scfg, undef, 'list', @params); |
535 | my @lines = split(/\n/, $text); | |
536 | ||
537 | my $info = {}; | |
538 | for my $line (@lines) { | |
539 | my ($snapshot, $guid, $creation) = split(/\s+/, $line); | |
540 | (my $snap_name = $snapshot) =~ s/^.*@//; | |
541 | ||
542 | $info->{$snap_name} = { | |
543 | id => $guid, | |
544 | timestamp => $creation, | |
545 | }; | |
546 | } | |
547 | return $info; | |
548 | } | |
549 | ||
26de022b TL |
550 | my sub dataset_mounted_heuristic { |
551 | my ($dataset) = @_; | |
552 | ||
553 | my $mounts = PVE::ProcFSTools::parse_proc_mounts(); | |
554 | for my $mp (@$mounts) { | |
555 | my ($what, $dir, $fs) = $mp->@*; | |
556 | next if $fs ne 'zfs'; | |
557 | # check for root-dataset or any child-dataset (root-dataset could have 'canmount=off') | |
558 | # If any child is mounted heuristically assume that `zfs mount -a` was successful | |
559 | next if $what !~ m!^$dataset(?:/|$)!; | |
560 | return 1; | |
561 | } | |
562 | return 0; | |
563 | } | |
564 | ||
0a3d992f DM |
565 | sub activate_storage { |
566 | my ($class, $storeid, $scfg, $cache) = @_; | |
86d47239 | 567 | |
93124ef4 | 568 | # Note: $scfg->{pool} can include dataset <pool>/<dataset> |
56a7637a SI |
569 | my $dataset = $scfg->{pool}; |
570 | my $pool = ($dataset =~ s!/.*$!!r); | |
571 | ||
26de022b | 572 | return 1 if dataset_mounted_heuristic($dataset); # early return |
93124ef4 | 573 | |
b5c8278a | 574 | my $pool_imported = sub { |
a2d747a1 | 575 | my @param = ('-o', 'name', '-H', $pool); |
b5c8278a | 576 | my $res = eval { $class->zfs_request($scfg, undef, 'zpool_list', @param) }; |
a2d747a1 SI |
577 | warn "$@\n" if $@; |
578 | ||
b5c8278a TL |
579 | return defined($res) && $res =~ m/$pool/; |
580 | }; | |
581 | ||
26de022b TL |
582 | if (!$pool_imported->()) { |
583 | # import can only be done if not yet imported! | |
584 | my @param = ('-d', '/dev/disk/by-id/', '-o', 'cachefile=none', $pool); | |
585 | eval { $class->zfs_request($scfg, undef, 'zpool_import', @param) }; | |
586 | if (my $err = $@) { | |
587 | # just could've raced with another import, so recheck if it is imported | |
588 | die "could not activate storage '$storeid', $err\n" if !$pool_imported->(); | |
dc18abe0 | 589 | } |
86d47239 | 590 | } |
26de022b TL |
591 | eval { $class->zfs_request($scfg, undef, 'mount', '-a') }; |
592 | die "could not activate storage '$storeid', $@\n" if $@; | |
0a3d992f DM |
593 | return 1; |
594 | } | |
595 | ||
596 | sub deactivate_storage { | |
597 | my ($class, $storeid, $scfg, $cache) = @_; | |
598 | return 1; | |
599 | } | |
600 | ||
d4c63dc1 | 601 | sub activate_volume { |
02e797b8 | 602 | my ($class, $storeid, $scfg, $volname, $snapname, $cache) = @_; |
56362cfb FG |
603 | |
604 | return 1 if defined($snapname); | |
605 | ||
3893d275 | 606 | my (undef, $dataset, undef, undef, undef, undef, $format) = $class->parse_volname($volname); |
56362cfb | 607 | |
815df2dd FE |
608 | if ($format eq 'raw') { |
609 | $class->zfs_wait_for_zvol_link($scfg, $volname); | |
610 | } elsif ($format eq 'subvol') { | |
3893d275 | 611 | my $mounted = $class->zfs_get_properties($scfg, 'mounted', "$scfg->{pool}/$dataset"); |
815df2dd | 612 | if ($mounted !~ m/^yes$/) { |
3893d275 | 613 | $class->zfs_request($scfg, undef, 'mount', "$scfg->{pool}/$dataset"); |
815df2dd FE |
614 | } |
615 | } | |
56362cfb | 616 | |
d4c63dc1 WL |
617 | return 1; |
618 | } | |
619 | ||
620 | sub deactivate_volume { | |
02e797b8 | 621 | my ($class, $storeid, $scfg, $volname, $snapname, $cache) = @_; |
d4c63dc1 WL |
622 | return 1; |
623 | } | |
5bb8e010 | 624 | |
d3a282e8 WL |
625 | sub clone_image { |
626 | my ($class, $scfg, $storeid, $volname, $vmid, $snap) = @_; | |
627 | ||
628 | $snap ||= '__base__'; | |
629 | ||
55525ad2 | 630 | my ($vtype, $basename, $basevmid, undef, undef, $isBase, $format) = |
d3a282e8 WL |
631 | $class->parse_volname($volname); |
632 | ||
633 | die "clone_image only works on base images\n" if !$isBase; | |
634 | ||
a44c0147 | 635 | my $name = $class->find_free_diskname($storeid, $scfg, $vmid, $format); |
d3a282e8 | 636 | |
851658c3 | 637 | if ($format eq 'subvol') { |
e05113fb | 638 | my $size = $class->zfs_request($scfg, undef, 'list', '-Hp', '-o', 'refquota', "$scfg->{pool}/$basename"); |
851658c3 | 639 | chomp($size); |
44257d2e | 640 | $class->zfs_request($scfg, undef, 'clone', "$scfg->{pool}/$basename\@$snap", "$scfg->{pool}/$name", '-o', "refquota=$size"); |
851658c3 | 641 | } else { |
44257d2e | 642 | $class->zfs_request($scfg, undef, 'clone', "$scfg->{pool}/$basename\@$snap", "$scfg->{pool}/$name"); |
851658c3 | 643 | } |
d3a282e8 | 644 | |
851658c3 | 645 | return "$basename/$name"; |
d3a282e8 WL |
646 | } |
647 | ||
648 | sub create_base { | |
649 | my ($class, $storeid, $scfg, $volname) = @_; | |
650 | ||
651 | my $snap = '__base__'; | |
652 | ||
851658c3 | 653 | my ($vtype, $name, $vmid, $basename, $basevmid, $isBase, $format) = |
d3a282e8 WL |
654 | $class->parse_volname($volname); |
655 | ||
656 | die "create_base not possible with base image\n" if $isBase; | |
657 | ||
658 | my $newname = $name; | |
851658c3 WL |
659 | if ( $format eq 'subvol' ) { |
660 | $newname =~ s/^subvol-/basevol-/; | |
661 | } else { | |
662 | $newname =~ s/^vm-/base-/; | |
663 | } | |
d3a282e8 WL |
664 | my $newvolname = $basename ? "$basename/$newname" : "$newname"; |
665 | ||
44257d2e | 666 | $class->zfs_request($scfg, undef, 'rename', "$scfg->{pool}/$name", "$scfg->{pool}/$newname"); |
d3a282e8 WL |
667 | |
668 | my $running = undef; #fixme : is create_base always offline ? | |
669 | ||
670 | $class->volume_snapshot($scfg, $storeid, $newname, $snap, $running); | |
671 | ||
672 | return $newvolname; | |
673 | } | |
674 | ||
a4034b9f WL |
675 | sub volume_resize { |
676 | my ($class, $scfg, $storeid, $volname, $size, $running) = @_; | |
677 | ||
79f2b938 DM |
678 | my $new_size = int($size/1024); |
679 | ||
851658c3 | 680 | my (undef, $vname, undef, undef, undef, undef, $format) = |
79f2b938 DM |
681 | $class->parse_volname($volname); |
682 | ||
683 | my $attr = $format eq 'subvol' ? 'refquota' : 'volsize'; | |
a4034b9f | 684 | |
d3e3e5d6 FE |
685 | # align size to 1M so we always have a valid multiple of the volume block size |
686 | if ($format eq 'raw') { | |
687 | my $padding = (1024 - $new_size % 1024) % 1024; | |
688 | $new_size = $new_size + $padding; | |
689 | } | |
690 | ||
44257d2e | 691 | $class->zfs_request($scfg, undef, 'set', "$attr=${new_size}k", "$scfg->{pool}/$vname"); |
a4034b9f WL |
692 | |
693 | return $new_size; | |
694 | } | |
695 | ||
7118dd91 DM |
696 | sub storage_can_replicate { |
697 | my ($class, $scfg, $storeid, $format) = @_; | |
698 | ||
699 | return 1 if $format eq 'raw' || $format eq 'subvol'; | |
700 | ||
701 | return 0; | |
702 | } | |
703 | ||
2b40ffae WL |
704 | sub volume_has_feature { |
705 | my ($class, $scfg, $feature, $storeid, $volname, $snapname, $running) = @_; | |
706 | ||
707 | my $features = { | |
708 | snapshot => { current => 1, snap => 1}, | |
709 | clone => { base => 1}, | |
710 | template => { current => 1}, | |
711 | copy => { base => 1, current => 1}, | |
baafddbd | 712 | sparseinit => { base => 1, current => 1}, |
f189504c | 713 | replicate => { base => 1, current => 1}, |
95dfa44c | 714 | rename => {current => 1}, |
2b40ffae WL |
715 | }; |
716 | ||
717 | my ($vtype, $name, $vmid, $basename, $basevmid, $isBase) = | |
718 | $class->parse_volname($volname); | |
719 | ||
720 | my $key = undef; | |
721 | ||
722 | if ($snapname) { | |
723 | $key = 'snap'; | |
724 | } else { | |
725 | $key = $isBase ? 'base' : 'current'; | |
726 | } | |
727 | ||
728 | return 1 if $features->{$feature}->{$key}; | |
729 | ||
730 | return undef; | |
731 | } | |
732 | ||
47f37b53 WB |
733 | sub volume_export { |
734 | my ($class, $scfg, $storeid, $fh, $volname, $format, $snapshot, $base_snapshot, $with_snapshots) = @_; | |
735 | ||
736 | die "unsupported export stream format for $class: $format\n" | |
737 | if $format ne 'zfs'; | |
738 | ||
739 | die "$class storage can only export snapshots\n" | |
740 | if !defined($snapshot); | |
741 | ||
9a75947b WL |
742 | my $dataset = ($class->parse_volname($volname))[1]; |
743 | ||
47f37b53 WB |
744 | my $fd = fileno($fh); |
745 | die "internal error: invalid file handle for volume_export\n" | |
746 | if !defined($fd); | |
747 | $fd = ">&$fd"; | |
748 | ||
749 | # For zfs we always create a replication stream (-R) which means the remote | |
750 | # side will always delete non-existing source snapshots. This should work | |
751 | # for all our use cases. | |
752 | my $cmd = ['zfs', 'send', '-Rpv']; | |
753 | if (defined($base_snapshot)) { | |
754 | my $arg = $with_snapshots ? '-I' : '-i'; | |
755 | push @$cmd, $arg, $base_snapshot; | |
756 | } | |
9a75947b | 757 | push @$cmd, '--', "$scfg->{pool}/$dataset\@$snapshot"; |
47f37b53 WB |
758 | |
759 | run_command($cmd, output => $fd); | |
760 | ||
761 | return; | |
762 | } | |
763 | ||
d390328b WB |
764 | sub volume_export_formats { |
765 | my ($class, $scfg, $storeid, $volname, $snapshot, $base_snapshot, $with_snapshots) = @_; | |
766 | ||
767 | my @formats = ('zfs'); | |
768 | # TODOs: | |
769 | # push @formats, 'fies' if $volname !~ /^(?:basevol|subvol)-/; | |
770 | # push @formats, 'raw' if !$base_snapshot && !$with_snapshots; | |
771 | return @formats; | |
772 | } | |
773 | ||
47f37b53 | 774 | sub volume_import { |
3cc29a04 | 775 | my ($class, $scfg, $storeid, $fh, $volname, $format, $snapshot, $base_snapshot, $with_snapshots, $allow_rename) = @_; |
47f37b53 WB |
776 | |
777 | die "unsupported import stream format for $class: $format\n" | |
778 | if $format ne 'zfs'; | |
779 | ||
780 | my $fd = fileno($fh); | |
781 | die "internal error: invalid file handle for volume_import\n" | |
782 | if !defined($fd); | |
783 | ||
726c4329 FE |
784 | my (undef, $dataset, $vmid, undef, undef, undef, $volume_format) = |
785 | $class->parse_volname($volname); | |
786 | ||
9a75947b | 787 | my $zfspath = "$scfg->{pool}/$dataset"; |
47f37b53 WB |
788 | my $suffix = defined($base_snapshot) ? "\@$base_snapshot" : ''; |
789 | my $exists = 0 == run_command(['zfs', 'get', '-H', 'name', $zfspath.$suffix], | |
0fd0a627 | 790 | noerr => 1, quiet => 1); |
47f37b53 WB |
791 | if (defined($base_snapshot)) { |
792 | die "base snapshot '$zfspath\@$base_snapshot' doesn't exist\n" if !$exists; | |
a97d3ee4 FE |
793 | } elsif ($exists) { |
794 | die "volume '$zfspath' already exists\n" if !$allow_rename; | |
795 | warn "volume '$zfspath' already exists - importing with a different name\n"; | |
726c4329 | 796 | $dataset = $class->find_free_diskname($storeid, $scfg, $vmid, $volume_format); |
a97d3ee4 | 797 | $zfspath = "$scfg->{pool}/$dataset"; |
47f37b53 WB |
798 | } |
799 | ||
800 | eval { run_command(['zfs', 'recv', '-F', '--', $zfspath], input => "<&$fd") }; | |
801 | if (my $err = $@) { | |
802 | if (defined($base_snapshot)) { | |
803 | eval { run_command(['zfs', 'rollback', '-r', '--', "$zfspath\@$base_snapshot"]) }; | |
804 | } else { | |
805 | eval { run_command(['zfs', 'destroy', '-r', '--', $zfspath]) }; | |
806 | } | |
807 | die $err; | |
808 | } | |
809 | ||
a97d3ee4 | 810 | return "$storeid:$dataset"; |
47f37b53 WB |
811 | } |
812 | ||
d390328b | 813 | sub volume_import_formats { |
3cc29a04 | 814 | my ($class, $scfg, $storeid, $volname, $snapshot, $base_snapshot, $with_snapshots) = @_; |
d390328b | 815 | |
3cc29a04 | 816 | return $class->volume_export_formats($scfg, $storeid, $volname, $snapshot, $base_snapshot, $with_snapshots); |
d390328b WB |
817 | } |
818 | ||
95dfa44c AL |
819 | sub rename_volume { |
820 | my ($class, $scfg, $storeid, $source_volname, $target_vmid, $target_volname) = @_; | |
821 | ||
822 | my ( | |
823 | undef, | |
824 | $source_image, | |
825 | $source_vmid, | |
826 | $base_name, | |
827 | $base_vmid, | |
828 | undef, | |
829 | $format | |
830 | ) = $class->parse_volname($source_volname); | |
831 | $target_volname = $class->find_free_diskname($storeid, $scfg, $target_vmid, $format) | |
832 | if !$target_volname; | |
833 | ||
834 | my $pool = $scfg->{pool}; | |
835 | my $source_zfspath = "${pool}/${source_image}"; | |
836 | my $target_zfspath = "${pool}/${target_volname}"; | |
837 | ||
838 | my $exists = 0 == run_command(['zfs', 'get', '-H', 'name', $target_zfspath], | |
839 | noerr => 1, quiet => 1); | |
840 | die "target volume '${target_volname}' already exists\n" if $exists; | |
841 | ||
842 | $class->zfs_request($scfg, 5, 'rename', ${source_zfspath}, ${target_zfspath}); | |
843 | ||
844 | $base_name = $base_name ? "${base_name}/" : ''; | |
845 | ||
846 | return "${storeid}:${base_name}${target_volname}"; | |
847 | } | |
848 | ||
5bb8e010 | 849 | 1; |