]> git.proxmox.com Git - pve-storage.git/blame - PVE/Storage/RBDPlugin.pm
cifs: use empty string instead of / as default directory
[pve-storage.git] / PVE / Storage / RBDPlugin.pm
CommitLineData
0509010d
AD
1package PVE::Storage::RBDPlugin;
2
3use strict;
4use warnings;
5102900d 5
a1528ffe 6use Cwd qw(abs_path);
0509010d 7use IO::File;
5102900d 8use JSON;
e858048f 9use Net::IP;
5102900d
TL
10
11use PVE::CephConfig;
cfe46e2d 12use PVE::Cluster qw(cfs_read_file);;
0509010d 13use PVE::JSONSchema qw(get_standard_option);
0ef8fb9d 14use PVE::ProcFSTools;
41aacc6c 15use PVE::RADOS;
6a44cc41 16use PVE::RPCEnvironment;
5102900d 17use PVE::Storage::Plugin;
a1528ffe 18use PVE::Tools qw(run_command trim file_read_firstline);
0509010d
AD
19
20use base qw(PVE::Storage::Plugin);
21
89a8800b
DC
22my $get_parent_image_name = sub {
23 my ($parent) = @_;
24 return undef if !$parent;
25 return $parent->{image} . "@" . $parent->{snapshot};
26};
27
cfe46e2d
AL
28my $librados_connect = sub {
29 my ($scfg, $storeid, $options) = @_;
30
6a44cc41
FE
31 $options->{timeout} = 60
32 if !defined($options->{timeout}) && PVE::RPCEnvironment->is_worker();
33
2be327ab 34 my $librados_config = PVE::CephConfig::ceph_connect_option($scfg, $storeid, $options->%*);
cfe46e2d
AL
35
36 my $rados = PVE::RADOS->new(%$librados_config);
37
38 return $rados;
39};
40
4cf696f6 41my sub get_rbd_path {
aeb007cb 42 my ($scfg, $volume) = @_;
c27fe648
TL
43 my $path = $scfg->{pool} ? $scfg->{pool} : 'rbd';
44 $path .= "/$scfg->{namespace}" if defined($scfg->{namespace});
45 $path .= "/$volume" if defined($volume);
46 return $path;
8897f5dc
SP
47};
48
cfe46e2d
AL
49my sub get_rbd_dev_path {
50 my ($scfg, $storeid, $volume) = @_;
51
52 my $cluster_id = '';
78638b3d
TL
53 if ($scfg->{fsid}) {
54 # NOTE: the config doesn't support this currently (but it could!), hack for qemu-server tests
55 $cluster_id = $scfg->{fsid};
56 } elsif ($scfg->{monhost}) {
cfe46e2d
AL
57 my $rados = $librados_connect->($scfg, $storeid);
58 $cluster_id = $rados->mon_command({ prefix => 'fsid', format => 'json' })->{fsid};
59 } else {
60 $cluster_id = cfs_read_file('ceph.conf')->{global}->{fsid};
61 }
62
63 my $uuid_pattern = "([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})";
64 if ($cluster_id =~ qr/^${uuid_pattern}$/is) {
65 $cluster_id = $1; # use untained value
66 } else {
67 die "cluster fsid has invalid format\n";
68 }
69
70 my $rbd_path = get_rbd_path($scfg, $volume);
71 my $pve_path = "/dev/rbd-pve/${cluster_id}/${rbd_path}";
72 my $path = "/dev/rbd/${rbd_path}";
73
a1528ffe
AL
74 if (!-e $pve_path && -e $path) {
75 # possibly mapped before rbd-pve rule existed
76 my $real_dev = abs_path($path);
77 my ($rbd_id) = ($real_dev =~ m|/dev/rbd([0-9]+)$|);
78 my $dev_cluster_id = file_read_firstline("/sys/devices/rbd/${rbd_id}/cluster_fsid");
79 return $path if $cluster_id eq $dev_cluster_id;
80 }
cfe46e2d
AL
81 return $pve_path;
82}
83
6cc88e8e
AA
84my $build_cmd = sub {
85 my ($binary, $scfg, $storeid, $op, @options) = @_;
86
4050fcc1 87 my $cmd_option = PVE::CephConfig::ceph_connect_option($scfg, $storeid);
6cc88e8e
AA
88 my $pool = $scfg->{pool} ? $scfg->{pool} : 'rbd';
89
90 my $cmd = [$binary, '-p', $pool];
91
92a7826f
TL
92 if (defined(my $namespace = $scfg->{namespace})) {
93 # some subcommands will fail if the --namespace parameter is present
94 my $no_namespace_parameter = {
95 unmap => 1,
96 };
97 push @$cmd, '--namespace', "$namespace" if !$no_namespace_parameter->{$op};
98 }
6cc88e8e
AA
99 push @$cmd, '-c', $cmd_option->{ceph_conf} if ($cmd_option->{ceph_conf});
100 push @$cmd, '-m', $cmd_option->{mon_host} if ($cmd_option->{mon_host});
101 push @$cmd, '--auth_supported', $cmd_option->{auth_supported} if ($cmd_option->{auth_supported});
102 push @$cmd, '-n', "client.$cmd_option->{userid}" if ($cmd_option->{userid});
103 push @$cmd, '--keyring', $cmd_option->{keyring} if ($cmd_option->{keyring});
104
105 push @$cmd, $op;
106
107 push @$cmd, @options if scalar(@options);
108
109 return $cmd;
110};
111
112my $rbd_cmd = sub {
113 my ($scfg, $storeid, $op, @options) = @_;
114
115 return $build_cmd->('/usr/bin/rbd', $scfg, $storeid, $op, @options);
116};
117
118my $rados_cmd = sub {
119 my ($scfg, $storeid, $op, @options) = @_;
120
121 return $build_cmd->('/usr/bin/rados', $scfg, $storeid, $op, @options);
122};
123
d86fd0a4 124# needed for volumes created using ceph jewel (or higher)
0ef8fb9d 125my $krbd_feature_update = sub {
d86fd0a4
FG
126 my ($scfg, $storeid, $name) = @_;
127
0ef8fb9d
TL
128 my (@disable, @enable);
129 my ($kmajor, $kminor) = PVE::ProcFSTools::kernel_version();
4c3b3085 130
0ef8fb9d
TL
131 if ($kmajor > 5 || $kmajor == 5 && $kminor >= 3) {
132 # 'deep-flatten' can only be disabled, not enabled after image creation
133 push @enable, 'fast-diff', 'object-map';
134 } else {
135 push @disable, 'fast-diff', 'object-map', 'deep-flatten';
136 }
137
138 if ($kmajor >= 5) {
139 push @enable, 'exclusive-lock';
140 } else {
141 push @disable, 'exclusive-lock';
142 }
4c3b3085 143
0ef8fb9d
TL
144 my $active_features_list = (rbd_volume_info($scfg, $storeid, $name))[4];
145 my $active_features = { map { $_ => 1 } @$active_features_list };
146
147 my $to_disable = join(',', grep { $active_features->{$_} } @disable);
148 my $to_enable = join(',', grep { !$active_features->{$_} } @enable );
149
150 if ($to_disable) {
151 print "disable RBD image features this kernel RBD drivers is not compatible with: $to_disable\n";
152 my $cmd = $rbd_cmd->($scfg, $storeid, 'feature', 'disable', $name, $to_disable);
153 run_rbd_command(
154 $cmd,
155 errmsg => "could not disable krbd-incompatible image features '$to_disable' for rbd image: $name",
156 );
157 }
158 if ($to_enable) {
159 print "enable RBD image features this kernel RBD drivers supports: $to_enable\n";
160 eval {
161 my $cmd = $rbd_cmd->($scfg, $storeid, 'feature', 'enable', $name, $to_enable);
162 run_rbd_command(
163 $cmd,
164 errmsg => "could not enable krbd-compatible image features '$to_enable' for rbd image: $name",
165 );
166 };
167 warn "$@" if $@;
4c3b3085 168 }
d86fd0a4
FG
169};
170
c693f749
SP
171sub run_rbd_command {
172 my ($cmd, %args) = @_;
173
174 my $lasterr;
175 my $errmsg = $args{errmsg} . ": " || "";
c97c5b3b 176 if (!exists($args{errfunc})) {
c693f749
SP
177 # ' error: 2014-02-06 11:51:59.839135 7f09f94d0760 -1 librbd: snap_unprotect: can't unprotect;
178 # at least 1 child(ren) in pool cephstor1
179 $args{errfunc} = sub {
c97c5b3b
DM
180 my $line = shift;
181 if ($line =~ m/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\.\d+ [0-9a-f]+ [\-\d]+ librbd: (.*)$/) {
182 $lasterr = "$1\n";
183 } else {
184 $lasterr = $line;
185 }
186 print STDERR $lasterr;
187 *STDERR->flush();
188 };
189 }
6d0d0a97 190
c97c5b3b
DM
191 eval { run_command($cmd, %args); };
192 if (my $err = $@) {
193 die $errmsg . $lasterr if length($lasterr);
194 die $err;
c693f749
SP
195 }
196
c97c5b3b 197 return undef;
c693f749
SP
198}
199
411476cd
DM
200sub rbd_ls {
201 my ($scfg, $storeid) = @_;
d70e7f6c 202
1440604a 203 my $pool = $scfg->{pool} ? $scfg->{pool} : 'rbd';
e9bc9931 204 $pool .= "/$scfg->{namespace}" if defined($scfg->{namespace});
d70e7f6c 205
89a8800b 206 my $raw = '';
1be93fe2 207 my $parser = sub { $raw .= shift };
8c3abf12 208
72bbd8a6 209 my $cmd = $rbd_cmd->($scfg, $storeid, 'ls', '-l', '--format', 'json');
8c3abf12 210 eval {
c693f749 211 run_rbd_command($cmd, errmsg => "rbd error", errfunc => sub {}, outfunc => $parser);
8c3abf12
DM
212 };
213 my $err = $@;
214
215 die $err if $err && $err !~ m/doesn't contain rbd images/ ;
89a8800b 216
00571710
DM
217 my $result;
218 if ($raw eq '') {
219 $result = [];
220 } elsif ($raw =~ m/^(\[.*\])$/s) { # untaint
221 $result = JSON::decode_json($1);
222 } else {
223 die "got unexpected data from rbd ls: '$raw'\n";
224 }
89a8800b
DC
225
226 my $list = {};
227
228 foreach my $el (@$result) {
229 next if defined($el->{snapshot});
230
231 my $image = $el->{image};
232
233 my ($owner) = $image =~ m/^(?:vm|base)-(\d+)-/;
aa14def4 234 next if !defined($owner);
89a8800b
DC
235
236 $list->{$pool}->{$image} = {
237 name => $image,
238 size => $el->{size},
239 parent => $get_parent_image_name->($el->{parent}),
240 vmid => $owner
241 };
242 }
243
411476cd 244 return $list;
0509010d
AD
245}
246
a573f66a
FG
247sub rbd_ls_snap {
248 my ($scfg, $storeid, $name) = @_;
249
72bbd8a6 250 my $cmd = $rbd_cmd->($scfg, $storeid, 'snap', 'ls', $name, '--format', 'json');
a573f66a
FG
251
252 my $raw = '';
253 run_rbd_command($cmd, errmsg => "rbd error", errfunc => sub {}, outfunc => sub { $raw .= shift; });
254
255 my $list;
256 if ($raw =~ m/^(\[.*\])$/s) { # untaint
257 $list = eval { JSON::decode_json($1) };
258 die "invalid JSON output from 'rbd snap ls $name': $@\n" if $@;
259 } else {
260 die "got unexpected data from 'rbd snap ls $name': '$raw'\n";
261 }
262
263 $list = [] if !defined($list);
264
265 my $res = {};
266 foreach my $el (@$list) {
267 my $snap = $el->{name};
268 my $protected = defined($el->{protected}) && $el->{protected} eq "true" ? 1 : undef;
269 $res->{$snap} = {
270 name => $snap,
271 id => $el->{id} // undef,
272 size => $el->{size} // 0,
273 protected => $protected,
274 };
275 }
276 return $res;
277}
278
62b98a65 279sub rbd_volume_info {
992e6835
AD
280 my ($scfg, $storeid, $volname, $snap) = @_;
281
282 my $cmd = undef;
283
89a8800b 284 my @options = ('info', $volname, '--format', 'json');
1be93fe2 285 if ($snap) {
89a8800b 286 push @options, '--snap', $snap;
992e6835 287 }
e110213e 288
72bbd8a6 289 $cmd = $rbd_cmd->($scfg, $storeid, @options);
89a8800b 290
89a8800b 291 my $raw = '';
1be93fe2 292 my $parser = sub { $raw .= shift };
e110213e 293
c693f749 294 run_rbd_command($cmd, errmsg => "rbd error", errfunc => sub {}, outfunc => $parser);
1be93fe2 295
00571710
DM
296 my $volume;
297 if ($raw eq '') {
298 $volume = {};
299 } elsif ($raw =~ m/^(\{.*\})$/s) { # untaint
300 $volume = JSON::decode_json($1);
301 } else {
302 die "got unexpected data from rbd info: '$raw'\n";
303 }
1be93fe2 304
89a8800b 305 $volume->{parent} = $get_parent_image_name->($volume->{parent});
1be93fe2 306 $volume->{protected} = defined($volume->{protected}) && $volume->{protected} eq "true" ? 1 : undef;
e110213e 307
89a8800b 308 return $volume->@{qw(size parent format protected features)};
e110213e
AD
309}
310
d70d814c
CE
311sub rbd_volume_du {
312 my ($scfg, $storeid, $volname) = @_;
313
314 my @options = ('du', $volname, '--format', 'json');
315 my $cmd = $rbd_cmd->($scfg, $storeid, @options);
316
317 my $raw = '';
318 my $parser = sub { $raw .= shift };
319
320 run_rbd_command($cmd, errmsg => "rbd error", errfunc => sub {}, outfunc => $parser);
321
322 my $volume;
323 if ($raw eq '') {
324 $volume = {};
325 } elsif ($raw =~ m/^(\{.*\})$/s) { # untaint
326 $volume = JSON::decode_json($1);
327 } else {
328 die "got unexpected data from rbd du: '$raw'\n";
329 }
330
331 if (!defined($volume->{images})) {
332 die "got no images from rbd du\n";
333 }
334
335 # `rbd du` returns array of images for name matching `volname`,
336 # including snapshots.
337 my $images = $volume->{images};
338 foreach my $image (@$images) {
339 next if defined($image->{snapshot});
340 next if !defined($image->{used_size}) || !defined($image->{name});
341
342 # Return `used_size` of first volume with matching name which
343 # is not a snapshot.
344 return $image->{used_size} if $image->{name} eq $volname;
345 }
346
347 die "got no matching image from rbd du\n";
348}
349
e5427b00 350# Configuration
0509010d 351
0509010d
AD
352sub type {
353 return 'rbd';
354}
355
356sub plugindata {
357 return {
1f79bb07 358 content => [ {images => 1, rootdir => 1}, { images => 1 }],
0509010d
AD
359 };
360}
361
362sub properties {
363 return {
e5427b00 364 monhost => {
0b9ef02e 365 description => "IP addresses of monitors (for external clusters).",
e858048f 366 type => 'string', format => 'pve-storage-portal-dns-list',
0509010d 367 },
e5427b00
AD
368 pool => {
369 description => "Pool.",
0509010d
AD
370 type => 'string',
371 },
ef2afce7
AL
372 'data-pool' => {
373 description => "Data Pool (for erasure coding only)",
374 type => 'string',
375 },
6d0d0a97 376 namespace => {
78eac5ba 377 description => "Namespace.",
e9bc9931
AL
378 type => 'string',
379 },
e5427b00
AD
380 username => {
381 description => "RBD Id.",
0509010d
AD
382 type => 'string',
383 },
e5427b00 384 authsupported => {
0509010d
AD
385 description => "Authsupported.",
386 type => 'string',
387 },
9f20a8a6 388 krbd => {
40d69893 389 description => "Always access rbd through krbd kernel module.",
9f20a8a6
AD
390 type => 'boolean',
391 },
22b68016
AL
392 keyring => {
393 description => "Client keyring contents (for external clusters).",
394 type => 'string',
395 },
0509010d
AD
396 };
397}
398
399sub options {
400 return {
35d6dfaf
AD
401 nodes => { optional => 1 },
402 disable => { optional => 1 },
0b9ef02e 403 monhost => { optional => 1},
1440604a 404 pool => { optional => 1 },
ef2afce7 405 'data-pool' => { optional => 1 },
e9bc9931 406 namespace => { optional => 1 },
1440604a 407 username => { optional => 1 },
0509010d 408 content => { optional => 1 },
9f20a8a6 409 krbd => { optional => 1 },
22b68016 410 keyring => { optional => 1 },
9edb99a5 411 bwlimit => { optional => 1 },
0509010d
AD
412 };
413}
414
415# Storage implementation
416
2e109b4b
TL
417sub on_add_hook {
418 my ($class, $storeid, $scfg, %param) = @_;
419
22b68016
AL
420 my $secret = $param{keyring} if defined $param{keyring} // undef;
421 PVE::CephConfig::ceph_create_keyfile($scfg->{type}, $storeid, $secret);
422
423 return;
424}
2e109b4b 425
22b68016
AL
426sub on_update_hook {
427 my ($class, $storeid, $scfg, %param) = @_;
428
429 if (exists($param{keyring})) {
430 if (defined($param{keyring})) {
431 PVE::CephConfig::ceph_create_keyfile($scfg->{type}, $storeid, $param{keyring});
432 } else {
433 PVE::CephConfig::ceph_remove_keyfile($scfg->{type}, $storeid);
434 }
435 }
f3ccd0ef
FE
436
437 return;
2e109b4b
TL
438}
439
440sub on_delete_hook {
441 my ($class, $storeid, $scfg) = @_;
4050fcc1 442 PVE::CephConfig::ceph_remove_keyfile($scfg->{type}, $storeid);
f3ccd0ef 443 return;
2e109b4b
TL
444}
445
0509010d
AD
446sub parse_volname {
447 my ($class, $volname) = @_;
448
d04c7e55 449 if ($volname =~ m/^((base-(\d+)-\S+)\/)?((base)?(vm)?-(\d+)-\S+)$/) {
7800e84d 450 return ('images', $4, $7, $2, $3, $5, 'raw');
0509010d
AD
451 }
452
453 die "unable to parse rbd volume name '$volname'\n";
454}
455
456sub path {
38e6ec3f 457 my ($class, $scfg, $volname, $storeid, $snapname) = @_;
0509010d 458
4050fcc1 459 my $cmd_option = PVE::CephConfig::ceph_connect_option($scfg, $storeid);
0509010d 460 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
38e6ec3f 461 $name .= '@'.$snapname if $snapname;
0509010d 462
e8e47711
FE
463 if ($scfg->{krbd}) {
464 my $rbd_dev_path = get_rbd_dev_path($scfg, $storeid, $name);
465 return ($rbd_dev_path, $vmid, $vtype);
466 }
33cef4c8 467
cfe46e2d 468 my $rbd_path = get_rbd_path($scfg, $name);
aeb007cb 469 my $path = "rbd:${rbd_path}";
6eebc4a7 470
5fc02afb
FG
471 $path .= ":conf=$cmd_option->{ceph_conf}" if $cmd_option->{ceph_conf};
472 if (defined($scfg->{monhost})) {
4050fcc1 473 my $monhost = PVE::CephConfig::hostlist($scfg->{monhost}, ';');
6eebc4a7
FG
474 $monhost =~ s/:/\\:/g;
475 $path .= ":mon_host=$monhost";
6cc88e8e 476 $path .= ":auth_supported=$cmd_option->{auth_supported}";
6eebc4a7
FG
477 }
478
6cc88e8e 479 $path .= ":id=$cmd_option->{userid}:keyring=$cmd_option->{keyring}" if ($cmd_option->{keyring});
13417225 480
0509010d
AD
481 return ($path, $vmid, $vtype);
482}
483
a44c0147
FE
484sub find_free_diskname {
485 my ($class, $storeid, $scfg, $vmid, $fmt, $add_fmt_suffix) = @_;
5b9b9b14 486
72bbd8a6 487 my $cmd = $rbd_cmd->($scfg, $storeid, 'ls');
e9bc9931 488
c4a29df4 489 my $disk_list = [];
5b9b9b14 490
53a236f2
FG
491 my $parser = sub {
492 my $line = shift;
dd9e97ed 493 if ($line =~ m/^(.*)$/) { # untaint
00571710
DM
494 push @$disk_list, $1;
495 }
53a236f2
FG
496 };
497
498 eval {
499 run_rbd_command($cmd, errmsg => "rbd error", errfunc => sub {}, outfunc => $parser);
500 };
501 my $err = $@;
502
503 die $err if $err && $err !~ m/doesn't contain rbd images/;
504
c4a29df4 505 return PVE::Storage::Plugin::get_next_vm_diskname($disk_list, $storeid, $vmid, undef, $scfg);
a44c0147 506}
5b9b9b14 507
5eab0272
DM
508sub create_base {
509 my ($class, $storeid, $scfg, $volname) = @_;
510
992e6835
AD
511 my $snap = '__base__';
512
513 my ($vtype, $name, $vmid, $basename, $basevmid, $isBase) =
514 $class->parse_volname($volname);
515
516 die "create_base not possible with base image\n" if $isBase;
517
518 my ($size, $parent, $format, undef) = rbd_volume_info($scfg, $storeid, $name);
519 die "rbd volume info on '$name' failed\n" if !($size);
520
521 die "rbd image must be at format V2" if $format ne "2";
522
523 die "volname '$volname' contains wrong information about parent $parent $basename\n"
524 if $basename && (!$parent || $parent ne $basename."@".$snap);
525
526 my $newname = $name;
527 $newname =~ s/^vm-/base-/;
528
529 my $newvolname = $basename ? "$basename/$newname" : "$newname";
530
72bbd8a6 531 my $cmd = $rbd_cmd->(
aeb007cb
AL
532 $scfg,
533 $storeid,
534 'rename',
4cf696f6
TL
535 get_rbd_path($scfg, $name),
536 get_rbd_path($scfg, $newname),
aeb007cb 537 );
c693f749 538 run_rbd_command($cmd, errmsg => "rbd rename '$name' error");
992e6835 539
95947178
FE
540 eval { $class->unmap_volume($storeid, $scfg, $volname); };
541 warn $@ if $@;
542
992e6835
AD
543 my $running = undef; #fixme : is create_base always offline ?
544
545 $class->volume_snapshot($scfg, $storeid, $newname, $snap, $running);
546
547 my (undef, undef, undef, $protected) = rbd_volume_info($scfg, $storeid, $newname, $snap);
548
549 if (!$protected){
72bbd8a6 550 my $cmd = $rbd_cmd->($scfg, $storeid, 'snap', 'protect', $newname, '--snap', $snap);
2362bc87 551 run_rbd_command($cmd, errmsg => "rbd protect $newname snap '$snap' error");
992e6835
AD
552 }
553
554 return $newvolname;
555
5eab0272
DM
556}
557
558sub clone_image {
f236eaf8 559 my ($class, $scfg, $storeid, $volname, $vmid, $snapname) = @_;
5eab0272 560
f2708285 561 my $snap = '__base__';
f236eaf8 562 $snap = $snapname if length $snapname;
f2708285
AD
563
564 my ($vtype, $basename, $basevmid, undef, undef, $isBase) =
565 $class->parse_volname($volname);
566
63da6d79
DM
567 die "$volname is not a base image and snapname is not provided\n"
568 if !$isBase && !length($snapname);
f2708285 569
a44c0147 570 my $name = $class->find_free_diskname($storeid, $scfg, $vmid);
f2708285 571
f236eaf8
SP
572 warn "clone $volname: $basename snapname $snap to $name\n";
573
63da6d79 574 if (length($snapname)) {
f236eaf8
SP
575 my (undef, undef, undef, $protected) = rbd_volume_info($scfg, $storeid, $volname, $snapname);
576
63da6d79 577 if (!$protected) {
72bbd8a6 578 my $cmd = $rbd_cmd->($scfg, $storeid, 'snap', 'protect', $volname, '--snap', $snapname);
f236eaf8
SP
579 run_rbd_command($cmd, errmsg => "rbd protect $volname snap $snapname error");
580 }
581 }
f2708285
AD
582
583 my $newvol = "$basename/$name";
63da6d79
DM
584 $newvol = $name if length($snapname);
585
c915afca
TL
586 my @options = (
587 get_rbd_path($scfg, $basename),
588 '--snap', $snap,
589 );
ef2afce7 590 push @options, ('--data-pool', $scfg->{'data-pool'}) if $scfg->{'data-pool'};
f2708285 591
c915afca 592 my $cmd = $rbd_cmd->($scfg, $storeid, 'clone', @options, get_rbd_path($scfg, $name));
c693f749 593 run_rbd_command($cmd, errmsg => "rbd clone '$basename' error");
f2708285
AD
594
595 return $newvol;
5eab0272
DM
596}
597
0509010d
AD
598sub alloc_image {
599 my ($class, $storeid, $scfg, $vmid, $fmt, $name, $size) = @_;
600
601
292a33fd 602 die "illegal name '$name' - should be 'vm-$vmid-*'\n"
0509010d 603 if $name && $name !~ m/^vm-$vmid-/;
0509010d 604
a44c0147 605 $name = $class->find_free_diskname($storeid, $scfg, $vmid) if !$name;
0509010d 606
c915afca
TL
607 my @options = (
608 '--image-format' , 2,
609 '--size', int(($size + 1023) / 1024),
610 );
ef2afce7 611 push @options, ('--data-pool', $scfg->{'data-pool'}) if $scfg->{'data-pool'};
c915afca
TL
612
613 my $cmd = $rbd_cmd->($scfg, $storeid, 'create', @options, $name);
3c931155 614 run_rbd_command($cmd, errmsg => "rbd create '$name' error");
0509010d
AD
615
616 return $name;
617}
618
619sub free_image {
32437ed2 620 my ($class, $storeid, $scfg, $volname, $isBase) = @_;
0509010d 621
42d07b9a
AD
622 my ($vtype, $name, $vmid, undef, undef, undef) =
623 $class->parse_volname($volname);
624
e9bc9931 625
a573f66a
FG
626 my $snaps = rbd_ls_snap($scfg, $storeid, $name);
627 foreach my $snap (keys %$snaps) {
628 if ($snaps->{$snap}->{protected}) {
72bbd8a6 629 my $cmd = $rbd_cmd->($scfg, $storeid, 'snap', 'unprotect', $name, '--snap', $snap);
2362bc87 630 run_rbd_command($cmd, errmsg => "rbd unprotect $name snap '$snap' error");
42d07b9a
AD
631 }
632 }
633
515ef80b
WL
634 $class->deactivate_volume($storeid, $scfg, $volname);
635
72bbd8a6 636 my $cmd = $rbd_cmd->($scfg, $storeid, 'snap', 'purge', $name);
85043c01 637 run_rbd_command($cmd, errmsg => "rbd snap purge '$name' error");
c30470a3 638
72bbd8a6 639 $cmd = $rbd_cmd->($scfg, $storeid, 'rm', $name);
85043c01 640 run_rbd_command($cmd, errmsg => "rbd rm '$name' error");
0509010d
AD
641
642 return undef;
643}
644
645sub list_images {
646 my ($class, $storeid, $scfg, $vmid, $vollist, $cache) = @_;
647
e5427b00 648 $cache->{rbd} = rbd_ls($scfg, $storeid) if !$cache->{rbd};
ed7ea5a3 649
c27fe648 650 my $dat = $cache->{rbd}->{get_rbd_path($scfg)};
ed7ea5a3 651 return [] if !$dat; # nothing found
cfd58f1f 652
ed7ea5a3
TL
653 my $res = [];
654 for my $image (sort keys %$dat) {
655 my $info = $dat->{$image};
656 my ($volname, $parent, $owner) = $info->@{'name', 'parent', 'vmid'};
657
658 if ($parent && $parent =~ m/^(base-\d+-\S+)\@__base__$/) {
659 $info->{volid} = "$storeid:$1/$volname";
660 } else {
661 $info->{volid} = "$storeid:$volname";
662 }
0509010d 663
ed7ea5a3
TL
664 if ($vollist) {
665 my $found = grep { $_ eq $info->{volid} } @$vollist;
666 next if !$found;
667 } else {
668 next if defined ($vmid) && ($owner ne $vmid);
669 }
0509010d 670
ed7ea5a3 671 $info->{format} = 'raw';
0509010d 672
ed7ea5a3 673 push @$res, $info;
0509010d 674 }
ed7ea5a3 675
411476cd 676 return $res;
0509010d
AD
677}
678
0509010d
AD
679sub status {
680 my ($class, $storeid, $scfg, $cache) = @_;
681
72bbd8a6 682 my $rados = $librados_connect->($scfg, $storeid);
41aacc6c 683 my $df = $rados->mon_command({ prefix => 'df', format => 'json' });
69589444 684
e4671f73 685 my $pool = $scfg->{'data-pool'} // $scfg->{pool} // 'rbd';
0c317c6c
SI
686
687 my ($d) = grep { $_->{name} eq $pool } @{$df->{pools}};
69589444 688
ae931633
SI
689 if (!defined($d)) {
690 warn "could not get usage stats for pool '$pool'\n";
691 return;
692 }
693
41aacc6c
AA
694 # max_avail -> max available space for data w/o replication in the pool
695 # bytes_used -> data w/o replication in the pool
696 my $free = $d->{stats}->{max_avail};
e79ab52c 697 my $used = $d->{stats}->{stored} // $d->{stats}->{bytes_used};
41aacc6c 698 my $total = $used + $free;
0509010d 699 my $active = 1;
0509010d 700
411476cd 701 return ($total, $free, $used, $active);
0509010d
AD
702}
703
704sub activate_storage {
705 my ($class, $storeid, $scfg, $cache) = @_;
706 return 1;
707}
708
709sub deactivate_storage {
710 my ($class, $storeid, $scfg, $cache) = @_;
711 return 1;
712}
713
40d69893
DM
714sub map_volume {
715 my ($class, $storeid, $scfg, $volname, $snapname) = @_;
9f20a8a6 716
518f3908
FG
717 my ($vtype, $img_name, $vmid) = $class->parse_volname($volname);
718
719 my $name = $img_name;
40d69893
DM
720 $name .= '@'.$snapname if $snapname;
721
cc682faa 722 my $kerneldev = get_rbd_dev_path($scfg, $storeid, $name);
40d69893
DM
723
724 return $kerneldev if -b $kerneldev; # already mapped
725
518f3908
FG
726 # features can only be enabled/disabled for image, not for snapshot!
727 $krbd_feature_update->($scfg, $storeid, $img_name);
9f20a8a6 728
72bbd8a6 729 my $cmd = $rbd_cmd->($scfg, $storeid, 'map', $name);
40d69893
DM
730 run_rbd_command($cmd, errmsg => "can't map rbd volume $name");
731
732 return $kerneldev;
733}
734
735sub unmap_volume {
736 my ($class, $storeid, $scfg, $volname, $snapname) = @_;
737
738 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
739 $name .= '@'.$snapname if $snapname;
740
cc682faa 741 my $kerneldev = get_rbd_dev_path($scfg, $storeid, $name);
40d69893
DM
742
743 if (-b $kerneldev) {
72bbd8a6 744 my $cmd = $rbd_cmd->($scfg, $storeid, 'unmap', $kerneldev);
40d69893
DM
745 run_rbd_command($cmd, errmsg => "can't unmap rbd device $kerneldev");
746 }
9f20a8a6 747
0509010d
AD
748 return 1;
749}
750
40d69893 751sub activate_volume {
02e797b8 752 my ($class, $storeid, $scfg, $volname, $snapname, $cache) = @_;
9f20a8a6 753
40d69893 754 $class->map_volume($storeid, $scfg, $volname, $snapname) if $scfg->{krbd};
9f20a8a6 755
40d69893
DM
756 return 1;
757}
9f20a8a6 758
40d69893
DM
759sub deactivate_volume {
760 my ($class, $storeid, $scfg, $volname, $snapname, $cache) = @_;
b50812f9 761
40d69893 762 $class->unmap_volume($storeid, $scfg, $volname, $snapname);
9f20a8a6 763
0509010d
AD
764 return 1;
765}
766
0002d9cc
AD
767sub volume_size_info {
768 my ($class, $scfg, $storeid, $volname, $timeout) = @_;
769
81d1d017 770 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
d70d814c
CE
771 my ($size, $parent) = rbd_volume_info($scfg, $storeid, $name);
772 my $used = wantarray ? rbd_volume_du($scfg, $storeid, $name) : 0;
773 return wantarray ? ($size, 'raw', $used, $parent) : $size;
0002d9cc
AD
774}
775
e7a42a76
AD
776sub volume_resize {
777 my ($class, $scfg, $storeid, $volname, $size, $running) = @_;
778
40d69893 779 return 1 if $running && !$scfg->{krbd}; # FIXME???
e7a42a76 780
478fc06c
AD
781 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
782
72bbd8a6 783 my $cmd = $rbd_cmd->($scfg, $storeid, 'resize', '--allow-shrink', '--size', ($size/1024/1024), $name);
c693f749 784 run_rbd_command($cmd, errmsg => "rbd resize '$volname' error");
e7a42a76
AD
785 return undef;
786}
787
788dd8e1 788sub volume_snapshot {
f5640e7d 789 my ($class, $scfg, $storeid, $volname, $snap) = @_;
788dd8e1 790
9af33ed0
AD
791 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
792
72bbd8a6 793 my $cmd = $rbd_cmd->($scfg, $storeid, 'snap', 'create', '--snap', $snap, $name);
c693f749 794 run_rbd_command($cmd, errmsg => "rbd snapshot '$volname' error");
788dd8e1
AD
795 return undef;
796}
797
5a2b2e2f
AD
798sub volume_snapshot_rollback {
799 my ($class, $scfg, $storeid, $volname, $snap) = @_;
800
c6ce2cc8
AD
801 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
802
72bbd8a6 803 my $cmd = $rbd_cmd->($scfg, $storeid, 'snap', 'rollback', '--snap', $snap, $name);
2362bc87 804 run_rbd_command($cmd, errmsg => "rbd snapshot $volname to '$snap' error");
5a2b2e2f
AD
805}
806
cce29bcd
AD
807sub volume_snapshot_delete {
808 my ($class, $scfg, $storeid, $volname, $snap, $running) = @_;
809
399581a2
WB
810 $class->deactivate_volume($storeid, $scfg, $volname, $snap, {});
811
c78cb110
AD
812 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
813
f90a0a20
SP
814 my (undef, undef, undef, $protected) = rbd_volume_info($scfg, $storeid, $name, $snap);
815 if ($protected){
72bbd8a6 816 my $cmd = $rbd_cmd->($scfg, $storeid, 'snap', 'unprotect', $name, '--snap', $snap);
f90a0a20
SP
817 run_rbd_command($cmd, errmsg => "rbd unprotect $name snap '$snap' error");
818 }
819
72bbd8a6 820 my $cmd = $rbd_cmd->($scfg, $storeid, 'snap', 'rm', '--snap', $snap, $name);
c693f749
SP
821
822 run_rbd_command($cmd, errmsg => "rbd snapshot '$volname' error");
823
cce29bcd
AD
824 return undef;
825}
826
2c036838 827sub volume_snapshot_needs_fsfreeze {
2c036838
SI
828 return 1;
829}
830
774f21b9
AD
831sub volume_has_feature {
832 my ($class, $scfg, $feature, $storeid, $volname, $snapname, $running) = @_;
833
834 my $features = {
5649ccfe 835 snapshot => { current => 1, snap => 1},
44c3689a 836 clone => { base => 1, snap => 1},
5649ccfe
AD
837 template => { current => 1},
838 copy => { base => 1, current => 1, snap => 1},
baafddbd 839 sparseinit => { base => 1, current => 1},
95dfa44c 840 rename => {current => 1},
774f21b9
AD
841 };
842
6d0d0a97 843 my ($vtype, $name, $vmid, $basename, $basevmid, $isBase) = $class->parse_volname($volname);
1e7ae581
AD
844
845 my $key = undef;
6d0d0a97 846 if ($snapname){
2c5a7097 847 $key = 'snap';
6d0d0a97
TL
848 } else {
849 $key = $isBase ? 'base' : 'current';
1e7ae581
AD
850 }
851 return 1 if $features->{$feature}->{$key};
774f21b9
AD
852
853 return undef;
854}
855
95dfa44c
AL
856sub rename_volume {
857 my ($class, $scfg, $storeid, $source_volname, $target_vmid, $target_volname) = @_;
858
859 my (
860 undef,
861 $source_image,
862 $source_vmid,
863 $base_name,
864 $base_vmid,
865 undef,
866 $format
867 ) = $class->parse_volname($source_volname);
868 $target_volname = $class->find_free_diskname($storeid, $scfg, $target_vmid, $format)
869 if !$target_volname;
870
871 eval {
872 my $cmd = $rbd_cmd->($scfg, $storeid, 'info', $target_volname);
873 run_rbd_command($cmd, errmsg => "exist check", quiet => 1);
874 };
875 die "target volume '${target_volname}' already exists\n" if !$@;
876
877 my $cmd = $rbd_cmd->($scfg, $storeid, 'rename', $source_image, $target_volname);
878
879 run_rbd_command(
880 $cmd,
881 errmsg => "could not rename image '${source_image}' to '${target_volname}'",
882 );
883
95947178
FE
884 eval { $class->unmap_volume($storeid, $scfg, $source_volname); };
885 warn $@ if $@;
886
95dfa44c
AL
887 $base_name = $base_name ? "${base_name}/" : '';
888
889 return "${storeid}:${base_name}${target_volname}";
890}
891
0509010d 8921;