]>
git.proxmox.com Git - pve-storage.git/blob - PVE/Storage/RBDPlugin.pm
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 $add_pool_to_disk = sub {
26 my ($scfg, $disk) = @_;
28 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
34 my ($binary, $scfg, $storeid, $op, @options) = @_;
36 my $cmd_option = PVE
::CephConfig
::ceph_connect_option
($scfg, $storeid);
37 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
39 my $cmd = [$binary, '-p', $pool];
41 push @$cmd, '-c', $cmd_option->{ceph_conf
} if ($cmd_option->{ceph_conf
});
42 push @$cmd, '-m', $cmd_option->{mon_host
} if ($cmd_option->{mon_host
});
43 push @$cmd, '--auth_supported', $cmd_option->{auth_supported
} if ($cmd_option->{auth_supported
});
44 push @$cmd, '-n', "client.$cmd_option->{userid}" if ($cmd_option->{userid
});
45 push @$cmd, '--keyring', $cmd_option->{keyring
} if ($cmd_option->{keyring
});
49 push @$cmd, @options if scalar(@options);
55 my ($scfg, $storeid, $op, @options) = @_;
57 return $build_cmd->('/usr/bin/rbd', $scfg, $storeid, $op, @options);
61 my ($scfg, $storeid, $op, @options) = @_;
63 return $build_cmd->('/usr/bin/rados', $scfg, $storeid, $op, @options);
66 my $librados_connect = sub {
67 my ($scfg, $storeid, $options) = @_;
69 my $librados_config = PVE
::CephConfig
::ceph_connect_option
($scfg, $storeid);
71 my $rados = PVE
::RADOS-
>new(%$librados_config);
76 # needed for volumes created using ceph jewel (or higher)
77 my $krbd_feature_update = sub {
78 my ($scfg, $storeid, $name) = @_;
80 my ($versionparts) = ceph_version
();
81 return 1 if $versionparts->[0] < 10;
83 my (@disable, @enable);
84 my ($kmajor, $kminor) = PVE
::ProcFSTools
::kernel_version
();
86 if ($kmajor > 5 || $kmajor == 5 && $kminor >= 3) {
87 # 'deep-flatten' can only be disabled, not enabled after image creation
88 push @enable, 'fast-diff', 'object-map';
90 push @disable, 'fast-diff', 'object-map', 'deep-flatten';
94 push @enable, 'exclusive-lock';
96 push @disable, 'exclusive-lock';
99 my $active_features_list = (rbd_volume_info
($scfg, $storeid, $name))[4];
100 my $active_features = { map { $_ => 1 } @$active_features_list };
102 my $to_disable = join(',', grep { $active_features->{$_} } @disable);
103 my $to_enable = join(',', grep { !$active_features->{$_} } @enable );
106 print "disable RBD image features this kernel RBD drivers is not compatible with: $to_disable\n";
107 my $cmd = $rbd_cmd->($scfg, $storeid, 'feature', 'disable', $name, $to_disable);
110 errmsg
=> "could not disable krbd-incompatible image features '$to_disable' for rbd image: $name",
114 print "enable RBD image features this kernel RBD drivers supports: $to_enable\n";
116 my $cmd = $rbd_cmd->($scfg, $storeid, 'feature', 'enable', $name, $to_enable);
119 errmsg
=> "could not enable krbd-compatible image features '$to_enable' for rbd image: $name",
126 my $ceph_version_parser = sub {
127 my $ceph_version = shift;
128 # FIXME this is the same as pve-manager PVE::Ceph::Tools get_local_version
129 if ($ceph_version =~ /^ceph.*\s(\d+(?:\.\d+)+(?:-pve\d+)?)\s+(?:\(([a-zA-Z0-9]+)\))?/) {
130 my ($version, $buildcommit) = ($1, $2);
131 my $subversions = [ split(/\.|-/, $version) ];
133 return ($subversions, $version, $buildcommit);
135 warn "Could not parse Ceph version: '$ceph_version'\n";
141 my $version_string = $cache;
142 if (!defined($version_string)) {
143 run_command
('ceph --version', outfunc
=> sub {
144 $version_string = shift;
147 return undef if !defined($version_string);
148 # subversion is an array ref. with the version parts from major to minor
149 # version is the filtered version string
150 my ($subversions, $version) = $ceph_version_parser->($version_string);
152 return wantarray ?
($subversions, $version) : $version;
155 sub run_rbd_command
{
156 my ($cmd, %args) = @_;
159 my $errmsg = $args{errmsg
} . ": " || "";
160 if (!exists($args{errfunc
})) {
161 # ' error: 2014-02-06 11:51:59.839135 7f09f94d0760 -1 librbd: snap_unprotect: can't unprotect;
162 # at least 1 child(ren) in pool cephstor1
163 $args{errfunc
} = sub {
165 if ($line =~ m/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\.\d+ [0-9a-f]+ [\-\d]+ librbd: (.*)$/) {
170 print STDERR
$lasterr;
175 eval { run_command
($cmd, %args); };
177 die $errmsg . $lasterr if length($lasterr);
185 my ($scfg, $storeid) = @_;
187 my $cmd = &$rbd_cmd($scfg, $storeid, 'ls', '-l', '--format', 'json');
188 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
191 my $parser = sub { $raw .= shift };
194 run_rbd_command
($cmd, errmsg
=> "rbd error", errfunc
=> sub {}, outfunc
=> $parser);
198 die $err if $err && $err !~ m/doesn't contain rbd images/ ;
203 } elsif ($raw =~ m/^(\[.*\])$/s) { # untaint
204 $result = JSON
::decode_json
($1);
206 die "got unexpected data from rbd ls: '$raw'\n";
211 foreach my $el (@$result) {
212 next if defined($el->{snapshot
});
214 my $image = $el->{image
};
216 my ($owner) = $image =~ m/^(?:vm|base)-(\d+)-/;
217 next if !defined($owner);
219 $list->{$pool}->{$image} = {
222 parent
=> $get_parent_image_name->($el->{parent
}),
231 my ($scfg, $storeid, $name) = @_;
233 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'ls', $name, '--format', 'json');
236 run_rbd_command
($cmd, errmsg
=> "rbd error", errfunc
=> sub {}, outfunc
=> sub { $raw .= shift; });
239 if ($raw =~ m/^(\[.*\])$/s) { # untaint
240 $list = eval { JSON
::decode_json
($1) };
241 die "invalid JSON output from 'rbd snap ls $name': $@\n" if $@;
243 die "got unexpected data from 'rbd snap ls $name': '$raw'\n";
246 $list = [] if !defined($list);
249 foreach my $el (@$list) {
250 my $snap = $el->{name
};
251 my $protected = defined($el->{protected
}) && $el->{protected
} eq "true" ?
1 : undef;
254 id
=> $el->{id
} // undef,
255 size
=> $el->{size
} // 0,
256 protected
=> $protected,
262 sub rbd_volume_info
{
263 my ($scfg, $storeid, $volname, $snap) = @_;
267 my @options = ('info', $volname, '--format', 'json');
269 push @options, '--snap', $snap;
272 $cmd = &$rbd_cmd($scfg, $storeid, @options);
275 my $parser = sub { $raw .= shift };
277 run_rbd_command
($cmd, errmsg
=> "rbd error", errfunc
=> sub {}, outfunc
=> $parser);
282 } elsif ($raw =~ m/^(\{.*\})$/s) { # untaint
283 $volume = JSON
::decode_json
($1);
285 die "got unexpected data from rbd info: '$raw'\n";
288 $volume->{parent
} = $get_parent_image_name->($volume->{parent
});
289 $volume->{protected
} = defined($volume->{protected
}) && $volume->{protected
} eq "true" ?
1 : undef;
291 return $volume->@{qw(size parent format protected features)};
302 content
=> [ {images
=> 1, rootdir
=> 1}, { images
=> 1 }],
309 description
=> "IP addresses of monitors (for external clusters).",
310 type
=> 'string', format
=> 'pve-storage-portal-dns-list',
313 description
=> "Pool.",
317 description
=> "RBD Id.",
321 description
=> "Authsupported.",
325 description
=> "Always access rbd through krbd kernel module.",
333 nodes
=> { optional
=> 1 },
334 disable
=> { optional
=> 1 },
335 monhost
=> { optional
=> 1},
336 pool
=> { optional
=> 1 },
337 username
=> { optional
=> 1 },
338 content
=> { optional
=> 1 },
339 krbd
=> { optional
=> 1 },
340 bwlimit
=> { optional
=> 1 },
344 # Storage implementation
347 my ($class, $storeid, $scfg, %param) = @_;
349 return if defined($scfg->{monhost
}); # nothing to do if not pve managed ceph
351 PVE
::CephConfig
::ceph_create_keyfile
($scfg->{type
}, $storeid);
355 my ($class, $storeid, $scfg) = @_;
357 return if defined($scfg->{monhost
}); # nothing to do if not pve managed ceph
359 PVE
::CephConfig
::ceph_remove_keyfile
($scfg->{type
}, $storeid);
363 my ($class, $volname) = @_;
365 if ($volname =~ m/^((base-(\d+)-\S+)\/)?
((base
)?
(vm
)?
-(\d
+)-\S
+)$/) {
366 return ('images', $4, $7, $2, $3, $5, 'raw');
369 die "unable to parse rbd volume name '$volname'\n";
373 my ($class, $scfg, $volname, $storeid, $snapname) = @_;
375 my $cmd_option = PVE
::CephConfig
::ceph_connect_option
($scfg, $storeid);
376 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
377 $name .= '@'.$snapname if $snapname;
379 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
380 return ("/dev/rbd/$pool/$name", $vmid, $vtype) if $scfg->{krbd
};
382 my $path = "rbd:$pool/$name";
384 $path .= ":conf=$cmd_option->{ceph_conf}" if $cmd_option->{ceph_conf
};
385 if (defined($scfg->{monhost
})) {
386 my $monhost = PVE
::CephConfig
::hostlist
($scfg->{monhost
}, ';');
387 $monhost =~ s/:/\\:/g;
388 $path .= ":mon_host=$monhost";
389 $path .= ":auth_supported=$cmd_option->{auth_supported}";
392 $path .= ":id=$cmd_option->{userid}:keyring=$cmd_option->{keyring}" if ($cmd_option->{keyring
});
394 return ($path, $vmid, $vtype);
397 sub find_free_diskname
{
398 my ($class, $storeid, $scfg, $vmid, $fmt, $add_fmt_suffix) = @_;
400 my $cmd = &$rbd_cmd($scfg, $storeid, 'ls');
405 if ($line =~ m/^(.*)$/) { # untaint
406 push @$disk_list, $1;
411 run_rbd_command
($cmd, errmsg
=> "rbd error", errfunc
=> sub {}, outfunc
=> $parser);
415 die $err if $err && $err !~ m/doesn't contain rbd images/;
417 return PVE
::Storage
::Plugin
::get_next_vm_diskname
($disk_list, $storeid, $vmid, undef, $scfg);
421 my ($class, $storeid, $scfg, $volname) = @_;
423 my $snap = '__base__';
425 my ($vtype, $name, $vmid, $basename, $basevmid, $isBase) =
426 $class->parse_volname($volname);
428 die "create_base not possible with base image\n" if $isBase;
430 my ($size, $parent, $format, undef) = rbd_volume_info
($scfg, $storeid, $name);
431 die "rbd volume info on '$name' failed\n" if !($size);
433 die "rbd image must be at format V2" if $format ne "2";
435 die "volname '$volname' contains wrong information about parent $parent $basename\n"
436 if $basename && (!$parent || $parent ne $basename."@".$snap);
439 $newname =~ s/^vm-/base-/;
441 my $newvolname = $basename ?
"$basename/$newname" : "$newname";
443 my $cmd = &$rbd_cmd($scfg, $storeid, 'rename', &$add_pool_to_disk($scfg, $name), &$add_pool_to_disk($scfg, $newname));
444 run_rbd_command
($cmd, errmsg
=> "rbd rename '$name' error");
446 my $running = undef; #fixme : is create_base always offline ?
448 $class->volume_snapshot($scfg, $storeid, $newname, $snap, $running);
450 my (undef, undef, undef, $protected) = rbd_volume_info
($scfg, $storeid, $newname, $snap);
453 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'protect', $newname, '--snap', $snap);
454 run_rbd_command
($cmd, errmsg
=> "rbd protect $newname snap '$snap' error");
462 my ($class, $scfg, $storeid, $volname, $vmid, $snapname) = @_;
464 my $snap = '__base__';
465 $snap = $snapname if length $snapname;
467 my ($vtype, $basename, $basevmid, undef, undef, $isBase) =
468 $class->parse_volname($volname);
470 die "$volname is not a base image and snapname is not provided\n"
471 if !$isBase && !length($snapname);
473 my $name = $class->find_free_diskname($storeid, $scfg, $vmid);
475 warn "clone $volname: $basename snapname $snap to $name\n";
477 if (length($snapname)) {
478 my (undef, undef, undef, $protected) = rbd_volume_info
($scfg, $storeid, $volname, $snapname);
481 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'protect', $volname, '--snap', $snapname);
482 run_rbd_command
($cmd, errmsg
=> "rbd protect $volname snap $snapname error");
486 my $newvol = "$basename/$name";
487 $newvol = $name if length($snapname);
489 my $cmd = &$rbd_cmd($scfg, $storeid, 'clone', &$add_pool_to_disk($scfg, $basename),
490 '--snap', $snap, &$add_pool_to_disk($scfg, $name));
492 run_rbd_command
($cmd, errmsg
=> "rbd clone '$basename' error");
498 my ($class, $storeid, $scfg, $vmid, $fmt, $name, $size) = @_;
501 die "illegal name '$name' - should be 'vm-$vmid-*'\n"
502 if $name && $name !~ m/^vm-$vmid-/;
504 $name = $class->find_free_diskname($storeid, $scfg, $vmid) if !$name;
506 my $cmd = &$rbd_cmd($scfg, $storeid, 'create', '--image-format' , 2, '--size', int(($size+1023)/1024), $name);
507 run_rbd_command
($cmd, errmsg
=> "rbd create $name' error");
513 my ($class, $storeid, $scfg, $volname, $isBase) = @_;
515 my ($vtype, $name, $vmid, undef, undef, undef) =
516 $class->parse_volname($volname);
518 my $snaps = rbd_ls_snap
($scfg, $storeid, $name);
519 foreach my $snap (keys %$snaps) {
520 if ($snaps->{$snap}->{protected
}) {
521 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'unprotect', $name, '--snap', $snap);
522 run_rbd_command
($cmd, errmsg
=> "rbd unprotect $name snap '$snap' error");
526 $class->deactivate_volume($storeid, $scfg, $volname);
528 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'purge', $name);
529 run_rbd_command
($cmd, errmsg
=> "rbd snap purge '$volname' error");
531 $cmd = &$rbd_cmd($scfg, $storeid, 'rm', $name);
532 run_rbd_command
($cmd, errmsg
=> "rbd rm '$volname' error");
538 my ($class, $storeid, $scfg, $vmid, $vollist, $cache) = @_;
540 $cache->{rbd
} = rbd_ls
($scfg, $storeid) if !$cache->{rbd
};
541 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
545 if (my $dat = $cache->{rbd
}->{$pool}) {
546 foreach my $image (keys %$dat) {
548 my $info = $dat->{$image};
550 my $volname = $info->{name
};
551 my $parent = $info->{parent
};
552 my $owner = $info->{vmid
};
554 if ($parent && $parent =~ m/^(base-\d+-\S+)\@__base__$/) {
555 $info->{volid
} = "$storeid:$1/$volname";
557 $info->{volid
} = "$storeid:$volname";
561 my $found = grep { $_ eq $info->{volid
} } @$vollist;
564 next if defined ($vmid) && ($owner ne $vmid);
567 $info->{format
} = 'raw';
577 my ($class, $storeid, $scfg, $cache) = @_;
580 my $rados = &$librados_connect($scfg, $storeid);
581 my $df = $rados->mon_command({ prefix
=> 'df', format
=> 'json' });
583 my ($d) = grep { $_->{name
} eq $scfg->{pool
} } @{$df->{pools
}};
585 # max_avail -> max available space for data w/o replication in the pool
586 # bytes_used -> data w/o replication in the pool
587 my $free = $d->{stats
}->{max_avail
};
588 my $used = $d->{stats
}->{stored
} // $d->{stats
}->{bytes_used
};
589 my $total = $used + $free;
592 return ($total, $free, $used, $active);
595 sub activate_storage
{
596 my ($class, $storeid, $scfg, $cache) = @_;
600 sub deactivate_storage
{
601 my ($class, $storeid, $scfg, $cache) = @_;
605 my $get_kernel_device_name = sub {
606 my ($pool, $name) = @_;
608 return "/dev/rbd/$pool/$name";
612 my ($class, $storeid, $scfg, $volname, $snapname) = @_;
614 my ($vtype, $img_name, $vmid) = $class->parse_volname($volname);
616 my $name = $img_name;
617 $name .= '@'.$snapname if $snapname;
619 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
621 my $kerneldev = $get_kernel_device_name->($pool, $name);
623 return $kerneldev if -b
$kerneldev; # already mapped
625 # features can only be enabled/disabled for image, not for snapshot!
626 $krbd_feature_update->($scfg, $storeid, $img_name);
628 my $cmd = &$rbd_cmd($scfg, $storeid, 'map', $name);
629 run_rbd_command
($cmd, errmsg
=> "can't map rbd volume $name");
635 my ($class, $storeid, $scfg, $volname, $snapname) = @_;
637 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
638 $name .= '@'.$snapname if $snapname;
640 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
642 my $kerneldev = $get_kernel_device_name->($pool, $name);
645 my $cmd = &$rbd_cmd($scfg, $storeid, 'unmap', $kerneldev);
646 run_rbd_command
($cmd, errmsg
=> "can't unmap rbd device $kerneldev");
652 sub activate_volume
{
653 my ($class, $storeid, $scfg, $volname, $snapname, $cache) = @_;
655 $class->map_volume($storeid, $scfg, $volname, $snapname) if $scfg->{krbd
};
660 sub deactivate_volume
{
661 my ($class, $storeid, $scfg, $volname, $snapname, $cache) = @_;
663 $class->unmap_volume($storeid, $scfg, $volname, $snapname);
668 sub volume_size_info
{
669 my ($class, $scfg, $storeid, $volname, $timeout) = @_;
671 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
672 my ($size, undef) = rbd_volume_info
($scfg, $storeid, $name);
677 my ($class, $scfg, $storeid, $volname, $size, $running) = @_;
679 return 1 if $running && !$scfg->{krbd
}; # FIXME???
681 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
683 my $cmd = &$rbd_cmd($scfg, $storeid, 'resize', '--allow-shrink', '--size', ($size/1024/1024), $name);
684 run_rbd_command
($cmd, errmsg
=> "rbd resize '$volname' error");
688 sub volume_snapshot
{
689 my ($class, $scfg, $storeid, $volname, $snap) = @_;
691 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
693 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'create', '--snap', $snap, $name);
694 run_rbd_command
($cmd, errmsg
=> "rbd snapshot '$volname' error");
698 sub volume_snapshot_rollback
{
699 my ($class, $scfg, $storeid, $volname, $snap) = @_;
701 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
703 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'rollback', '--snap', $snap, $name);
704 run_rbd_command
($cmd, errmsg
=> "rbd snapshot $volname to '$snap' error");
707 sub volume_snapshot_delete
{
708 my ($class, $scfg, $storeid, $volname, $snap, $running) = @_;
710 return 1 if $running && !$scfg->{krbd
}; # FIXME: ????
712 $class->deactivate_volume($storeid, $scfg, $volname, $snap, {});
714 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
716 my (undef, undef, undef, $protected) = rbd_volume_info
($scfg, $storeid, $name, $snap);
718 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'unprotect', $name, '--snap', $snap);
719 run_rbd_command
($cmd, errmsg
=> "rbd unprotect $name snap '$snap' error");
722 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'rm', '--snap', $snap, $name);
724 run_rbd_command
($cmd, errmsg
=> "rbd snapshot '$volname' error");
729 sub volume_has_feature
{
730 my ($class, $scfg, $feature, $storeid, $volname, $snapname, $running) = @_;
733 snapshot
=> { current
=> 1, snap
=> 1},
734 clone
=> { base
=> 1, snap
=> 1},
735 template
=> { current
=> 1},
736 copy
=> { base
=> 1, current
=> 1, snap
=> 1},
737 sparseinit
=> { base
=> 1, current
=> 1},
740 my ($vtype, $name, $vmid, $basename, $basevmid, $isBase) =
741 $class->parse_volname($volname);
747 $key = $isBase ?
'base' : 'current';
749 return 1 if $features->{$feature}->{$key};