1 package PVE
::Storage
::RBDPlugin
;
11 use PVE
::JSONSchema
qw(get_standard_option);
14 use PVE
::Storage
::Plugin
;
15 use PVE
::Tools
qw(run_command trim);
17 use base
qw(PVE::Storage::Plugin);
19 my $get_parent_image_name = sub {
21 return undef if !$parent;
22 return $parent->{image
} . "@" . $parent->{snapshot
};
25 my $get_rbd_path = sub {
26 my ($scfg, $volume) = @_;
27 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
28 return "${pool}/${volume}";
32 my ($binary, $scfg, $storeid, $op, @options) = @_;
34 my $cmd_option = PVE
::CephConfig
::ceph_connect_option
($scfg, $storeid);
35 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
37 my $cmd = [$binary, '-p', $pool];
39 push @$cmd, '-c', $cmd_option->{ceph_conf
} if ($cmd_option->{ceph_conf
});
40 push @$cmd, '-m', $cmd_option->{mon_host
} if ($cmd_option->{mon_host
});
41 push @$cmd, '--auth_supported', $cmd_option->{auth_supported
} if ($cmd_option->{auth_supported
});
42 push @$cmd, '-n', "client.$cmd_option->{userid}" if ($cmd_option->{userid
});
43 push @$cmd, '--keyring', $cmd_option->{keyring
} if ($cmd_option->{keyring
});
47 push @$cmd, @options if scalar(@options);
53 my ($scfg, $storeid, $op, @options) = @_;
55 return $build_cmd->('/usr/bin/rbd', $scfg, $storeid, $op, @options);
59 my ($scfg, $storeid, $op, @options) = @_;
61 return $build_cmd->('/usr/bin/rados', $scfg, $storeid, $op, @options);
64 my $librados_connect = sub {
65 my ($scfg, $storeid, $options) = @_;
67 my $librados_config = PVE
::CephConfig
::ceph_connect_option
($scfg, $storeid);
69 my $rados = PVE
::RADOS-
>new(%$librados_config);
74 # needed for volumes created using ceph jewel (or higher)
75 my $krbd_feature_update = sub {
76 my ($scfg, $storeid, $name) = @_;
78 my (@disable, @enable);
79 my ($kmajor, $kminor) = PVE
::ProcFSTools
::kernel_version
();
81 if ($kmajor > 5 || $kmajor == 5 && $kminor >= 3) {
82 # 'deep-flatten' can only be disabled, not enabled after image creation
83 push @enable, 'fast-diff', 'object-map';
85 push @disable, 'fast-diff', 'object-map', 'deep-flatten';
89 push @enable, 'exclusive-lock';
91 push @disable, 'exclusive-lock';
94 my $active_features_list = (rbd_volume_info
($scfg, $storeid, $name))[4];
95 my $active_features = { map { $_ => 1 } @$active_features_list };
97 my $to_disable = join(',', grep { $active_features->{$_} } @disable);
98 my $to_enable = join(',', grep { !$active_features->{$_} } @enable );
101 print "disable RBD image features this kernel RBD drivers is not compatible with: $to_disable\n";
102 my $cmd = $rbd_cmd->($scfg, $storeid, 'feature', 'disable', $name, $to_disable);
105 errmsg
=> "could not disable krbd-incompatible image features '$to_disable' for rbd image: $name",
109 print "enable RBD image features this kernel RBD drivers supports: $to_enable\n";
111 my $cmd = $rbd_cmd->($scfg, $storeid, 'feature', 'enable', $name, $to_enable);
114 errmsg
=> "could not enable krbd-compatible image features '$to_enable' for rbd image: $name",
121 sub run_rbd_command
{
122 my ($cmd, %args) = @_;
125 my $errmsg = $args{errmsg
} . ": " || "";
126 if (!exists($args{errfunc
})) {
127 # ' error: 2014-02-06 11:51:59.839135 7f09f94d0760 -1 librbd: snap_unprotect: can't unprotect;
128 # at least 1 child(ren) in pool cephstor1
129 $args{errfunc
} = sub {
131 if ($line =~ m/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\.\d+ [0-9a-f]+ [\-\d]+ librbd: (.*)$/) {
136 print STDERR
$lasterr;
141 eval { run_command
($cmd, %args); };
143 die $errmsg . $lasterr if length($lasterr);
151 my ($scfg, $storeid) = @_;
153 my $cmd = &$rbd_cmd($scfg, $storeid, 'ls', '-l', '--format', 'json');
154 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
157 my $parser = sub { $raw .= shift };
160 run_rbd_command
($cmd, errmsg
=> "rbd error", errfunc
=> sub {}, outfunc
=> $parser);
164 die $err if $err && $err !~ m/doesn't contain rbd images/ ;
169 } elsif ($raw =~ m/^(\[.*\])$/s) { # untaint
170 $result = JSON
::decode_json
($1);
172 die "got unexpected data from rbd ls: '$raw'\n";
177 foreach my $el (@$result) {
178 next if defined($el->{snapshot
});
180 my $image = $el->{image
};
182 my ($owner) = $image =~ m/^(?:vm|base)-(\d+)-/;
183 next if !defined($owner);
185 $list->{$pool}->{$image} = {
188 parent
=> $get_parent_image_name->($el->{parent
}),
197 my ($scfg, $storeid, $name) = @_;
199 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'ls', $name, '--format', 'json');
202 run_rbd_command
($cmd, errmsg
=> "rbd error", errfunc
=> sub {}, outfunc
=> sub { $raw .= shift; });
205 if ($raw =~ m/^(\[.*\])$/s) { # untaint
206 $list = eval { JSON
::decode_json
($1) };
207 die "invalid JSON output from 'rbd snap ls $name': $@\n" if $@;
209 die "got unexpected data from 'rbd snap ls $name': '$raw'\n";
212 $list = [] if !defined($list);
215 foreach my $el (@$list) {
216 my $snap = $el->{name
};
217 my $protected = defined($el->{protected
}) && $el->{protected
} eq "true" ?
1 : undef;
220 id
=> $el->{id
} // undef,
221 size
=> $el->{size
} // 0,
222 protected
=> $protected,
228 sub rbd_volume_info
{
229 my ($scfg, $storeid, $volname, $snap) = @_;
233 my @options = ('info', $volname, '--format', 'json');
235 push @options, '--snap', $snap;
238 $cmd = &$rbd_cmd($scfg, $storeid, @options);
241 my $parser = sub { $raw .= shift };
243 run_rbd_command
($cmd, errmsg
=> "rbd error", errfunc
=> sub {}, outfunc
=> $parser);
248 } elsif ($raw =~ m/^(\{.*\})$/s) { # untaint
249 $volume = JSON
::decode_json
($1);
251 die "got unexpected data from rbd info: '$raw'\n";
254 $volume->{parent
} = $get_parent_image_name->($volume->{parent
});
255 $volume->{protected
} = defined($volume->{protected
}) && $volume->{protected
} eq "true" ?
1 : undef;
257 return $volume->@{qw(size parent format protected features)};
268 content
=> [ {images
=> 1, rootdir
=> 1}, { images
=> 1 }],
275 description
=> "IP addresses of monitors (for external clusters).",
276 type
=> 'string', format
=> 'pve-storage-portal-dns-list',
279 description
=> "Pool.",
283 description
=> "RBD Id.",
287 description
=> "Authsupported.",
291 description
=> "Always access rbd through krbd kernel module.",
299 nodes
=> { optional
=> 1 },
300 disable
=> { optional
=> 1 },
301 monhost
=> { optional
=> 1},
302 pool
=> { optional
=> 1 },
303 username
=> { optional
=> 1 },
304 content
=> { optional
=> 1 },
305 krbd
=> { optional
=> 1 },
306 bwlimit
=> { optional
=> 1 },
310 # Storage implementation
313 my ($class, $storeid, $scfg, %param) = @_;
315 return if defined($scfg->{monhost
}); # nothing to do if not pve managed ceph
317 PVE
::CephConfig
::ceph_create_keyfile
($scfg->{type
}, $storeid);
323 my ($class, $storeid, $scfg) = @_;
325 return if defined($scfg->{monhost
}); # nothing to do if not pve managed ceph
327 PVE
::CephConfig
::ceph_remove_keyfile
($scfg->{type
}, $storeid);
333 my ($class, $volname) = @_;
335 if ($volname =~ m/^((base-(\d+)-\S+)\/)?
((base
)?
(vm
)?
-(\d
+)-\S
+)$/) {
336 return ('images', $4, $7, $2, $3, $5, 'raw');
339 die "unable to parse rbd volume name '$volname'\n";
343 my ($class, $scfg, $volname, $storeid, $snapname) = @_;
345 my $cmd_option = PVE
::CephConfig
::ceph_connect_option
($scfg, $storeid);
346 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
347 $name .= '@'.$snapname if $snapname;
349 my $rbd_path = &$get_rbd_path($scfg, $name);
350 return ("/dev/rbd/${rbd_path}", $vmid, $vtype) if $scfg->{krbd
};
352 my $path = "rbd:${rbd_path}";
354 $path .= ":conf=$cmd_option->{ceph_conf}" if $cmd_option->{ceph_conf
};
355 if (defined($scfg->{monhost
})) {
356 my $monhost = PVE
::CephConfig
::hostlist
($scfg->{monhost
}, ';');
357 $monhost =~ s/:/\\:/g;
358 $path .= ":mon_host=$monhost";
359 $path .= ":auth_supported=$cmd_option->{auth_supported}";
362 $path .= ":id=$cmd_option->{userid}:keyring=$cmd_option->{keyring}" if ($cmd_option->{keyring
});
364 return ($path, $vmid, $vtype);
367 sub find_free_diskname
{
368 my ($class, $storeid, $scfg, $vmid, $fmt, $add_fmt_suffix) = @_;
370 my $cmd = &$rbd_cmd($scfg, $storeid, 'ls');
375 if ($line =~ m/^(.*)$/) { # untaint
376 push @$disk_list, $1;
381 run_rbd_command
($cmd, errmsg
=> "rbd error", errfunc
=> sub {}, outfunc
=> $parser);
385 die $err if $err && $err !~ m/doesn't contain rbd images/;
387 return PVE
::Storage
::Plugin
::get_next_vm_diskname
($disk_list, $storeid, $vmid, undef, $scfg);
391 my ($class, $storeid, $scfg, $volname) = @_;
393 my $snap = '__base__';
395 my ($vtype, $name, $vmid, $basename, $basevmid, $isBase) =
396 $class->parse_volname($volname);
398 die "create_base not possible with base image\n" if $isBase;
400 my ($size, $parent, $format, undef) = rbd_volume_info
($scfg, $storeid, $name);
401 die "rbd volume info on '$name' failed\n" if !($size);
403 die "rbd image must be at format V2" if $format ne "2";
405 die "volname '$volname' contains wrong information about parent $parent $basename\n"
406 if $basename && (!$parent || $parent ne $basename."@".$snap);
409 $newname =~ s/^vm-/base-/;
411 my $newvolname = $basename ?
"$basename/$newname" : "$newname";
417 &$get_rbd_path($scfg, $name),
418 &$get_rbd_path($scfg, $newname),
420 run_rbd_command
($cmd, errmsg
=> "rbd rename '$name' error");
422 my $running = undef; #fixme : is create_base always offline ?
424 $class->volume_snapshot($scfg, $storeid, $newname, $snap, $running);
426 my (undef, undef, undef, $protected) = rbd_volume_info
($scfg, $storeid, $newname, $snap);
429 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'protect', $newname, '--snap', $snap);
430 run_rbd_command
($cmd, errmsg
=> "rbd protect $newname snap '$snap' error");
438 my ($class, $scfg, $storeid, $volname, $vmid, $snapname) = @_;
440 my $snap = '__base__';
441 $snap = $snapname if length $snapname;
443 my ($vtype, $basename, $basevmid, undef, undef, $isBase) =
444 $class->parse_volname($volname);
446 die "$volname is not a base image and snapname is not provided\n"
447 if !$isBase && !length($snapname);
449 my $name = $class->find_free_diskname($storeid, $scfg, $vmid);
451 warn "clone $volname: $basename snapname $snap to $name\n";
453 if (length($snapname)) {
454 my (undef, undef, undef, $protected) = rbd_volume_info
($scfg, $storeid, $volname, $snapname);
457 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'protect', $volname, '--snap', $snapname);
458 run_rbd_command
($cmd, errmsg
=> "rbd protect $volname snap $snapname error");
462 my $newvol = "$basename/$name";
463 $newvol = $name if length($snapname);
469 &$get_rbd_path($scfg, $basename),
472 &$get_rbd_path($scfg, $name),
475 run_rbd_command
($cmd, errmsg
=> "rbd clone '$basename' error");
481 my ($class, $storeid, $scfg, $vmid, $fmt, $name, $size) = @_;
484 die "illegal name '$name' - should be 'vm-$vmid-*'\n"
485 if $name && $name !~ m/^vm-$vmid-/;
487 $name = $class->find_free_diskname($storeid, $scfg, $vmid) if !$name;
489 my $cmd = &$rbd_cmd($scfg, $storeid, 'create', '--image-format' , 2, '--size', int(($size+1023)/1024), $name);
490 run_rbd_command
($cmd, errmsg
=> "rbd create $name' error");
496 my ($class, $storeid, $scfg, $volname, $isBase) = @_;
498 my ($vtype, $name, $vmid, undef, undef, undef) =
499 $class->parse_volname($volname);
501 my $snaps = rbd_ls_snap
($scfg, $storeid, $name);
502 foreach my $snap (keys %$snaps) {
503 if ($snaps->{$snap}->{protected
}) {
504 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'unprotect', $name, '--snap', $snap);
505 run_rbd_command
($cmd, errmsg
=> "rbd unprotect $name snap '$snap' error");
509 $class->deactivate_volume($storeid, $scfg, $volname);
511 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'purge', $name);
512 run_rbd_command
($cmd, errmsg
=> "rbd snap purge '$volname' error");
514 $cmd = &$rbd_cmd($scfg, $storeid, 'rm', $name);
515 run_rbd_command
($cmd, errmsg
=> "rbd rm '$volname' error");
521 my ($class, $storeid, $scfg, $vmid, $vollist, $cache) = @_;
523 $cache->{rbd
} = rbd_ls
($scfg, $storeid) if !$cache->{rbd
};
524 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
528 if (my $dat = $cache->{rbd
}->{$pool}) {
529 foreach my $image (keys %$dat) {
531 my $info = $dat->{$image};
533 my $volname = $info->{name
};
534 my $parent = $info->{parent
};
535 my $owner = $info->{vmid
};
537 if ($parent && $parent =~ m/^(base-\d+-\S+)\@__base__$/) {
538 $info->{volid
} = "$storeid:$1/$volname";
540 $info->{volid
} = "$storeid:$volname";
544 my $found = grep { $_ eq $info->{volid
} } @$vollist;
547 next if defined ($vmid) && ($owner ne $vmid);
550 $info->{format
} = 'raw';
560 my ($class, $storeid, $scfg, $cache) = @_;
563 my $rados = &$librados_connect($scfg, $storeid);
564 my $df = $rados->mon_command({ prefix
=> 'df', format
=> 'json' });
566 my ($d) = grep { $_->{name
} eq $scfg->{pool
} } @{$df->{pools
}};
568 # max_avail -> max available space for data w/o replication in the pool
569 # bytes_used -> data w/o replication in the pool
570 my $free = $d->{stats
}->{max_avail
};
571 my $used = $d->{stats
}->{stored
} // $d->{stats
}->{bytes_used
};
572 my $total = $used + $free;
575 return ($total, $free, $used, $active);
578 sub activate_storage
{
579 my ($class, $storeid, $scfg, $cache) = @_;
583 sub deactivate_storage
{
584 my ($class, $storeid, $scfg, $cache) = @_;
588 my $get_kernel_device_name = sub {
589 my ($scfg, $name) = @_;
591 my $rbd_path = &$get_rbd_path($scfg, $name);
592 return "/dev/rbd/${rbd_path}";
596 my ($class, $storeid, $scfg, $volname, $snapname) = @_;
598 my ($vtype, $img_name, $vmid) = $class->parse_volname($volname);
600 my $name = $img_name;
601 $name .= '@'.$snapname if $snapname;
603 my $kerneldev = $get_kernel_device_name->($scfg, $name);
605 return $kerneldev if -b
$kerneldev; # already mapped
607 # features can only be enabled/disabled for image, not for snapshot!
608 $krbd_feature_update->($scfg, $storeid, $img_name);
610 my $cmd = &$rbd_cmd($scfg, $storeid, 'map', $name);
611 run_rbd_command
($cmd, errmsg
=> "can't map rbd volume $name");
617 my ($class, $storeid, $scfg, $volname, $snapname) = @_;
619 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
620 $name .= '@'.$snapname if $snapname;
622 my $kerneldev = $get_kernel_device_name->($scfg, $name);
625 my $cmd = &$rbd_cmd($scfg, $storeid, 'unmap', $kerneldev);
626 run_rbd_command
($cmd, errmsg
=> "can't unmap rbd device $kerneldev");
632 sub activate_volume
{
633 my ($class, $storeid, $scfg, $volname, $snapname, $cache) = @_;
635 $class->map_volume($storeid, $scfg, $volname, $snapname) if $scfg->{krbd
};
640 sub deactivate_volume
{
641 my ($class, $storeid, $scfg, $volname, $snapname, $cache) = @_;
643 $class->unmap_volume($storeid, $scfg, $volname, $snapname);
648 sub volume_size_info
{
649 my ($class, $scfg, $storeid, $volname, $timeout) = @_;
651 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
652 my ($size, undef) = rbd_volume_info
($scfg, $storeid, $name);
657 my ($class, $scfg, $storeid, $volname, $size, $running) = @_;
659 return 1 if $running && !$scfg->{krbd
}; # FIXME???
661 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
663 my $cmd = &$rbd_cmd($scfg, $storeid, 'resize', '--allow-shrink', '--size', ($size/1024/1024), $name);
664 run_rbd_command
($cmd, errmsg
=> "rbd resize '$volname' error");
668 sub volume_snapshot
{
669 my ($class, $scfg, $storeid, $volname, $snap) = @_;
671 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
673 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'create', '--snap', $snap, $name);
674 run_rbd_command
($cmd, errmsg
=> "rbd snapshot '$volname' error");
678 sub volume_snapshot_rollback
{
679 my ($class, $scfg, $storeid, $volname, $snap) = @_;
681 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
683 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'rollback', '--snap', $snap, $name);
684 run_rbd_command
($cmd, errmsg
=> "rbd snapshot $volname to '$snap' error");
687 sub volume_snapshot_delete
{
688 my ($class, $scfg, $storeid, $volname, $snap, $running) = @_;
690 return 1 if $running && !$scfg->{krbd
}; # FIXME: ????
692 $class->deactivate_volume($storeid, $scfg, $volname, $snap, {});
694 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
696 my (undef, undef, undef, $protected) = rbd_volume_info
($scfg, $storeid, $name, $snap);
698 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'unprotect', $name, '--snap', $snap);
699 run_rbd_command
($cmd, errmsg
=> "rbd unprotect $name snap '$snap' error");
702 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'rm', '--snap', $snap, $name);
704 run_rbd_command
($cmd, errmsg
=> "rbd snapshot '$volname' error");
709 sub volume_snapshot_needs_fsfreeze
{
714 sub volume_has_feature
{
715 my ($class, $scfg, $feature, $storeid, $volname, $snapname, $running) = @_;
718 snapshot
=> { current
=> 1, snap
=> 1},
719 clone
=> { base
=> 1, snap
=> 1},
720 template
=> { current
=> 1},
721 copy
=> { base
=> 1, current
=> 1, snap
=> 1},
722 sparseinit
=> { base
=> 1, current
=> 1},
725 my ($vtype, $name, $vmid, $basename, $basevmid, $isBase) =
726 $class->parse_volname($volname);
732 $key = $isBase ?
'base' : 'current';
734 return 1 if $features->{$feature}->{$key};