]>
git.proxmox.com Git - pve-storage.git/blob - PVE/Storage/RBDPlugin.pm
1 package PVE
::Storage
::RBDPlugin
;
7 use PVE
::Tools
qw(run_command trim);
8 use PVE
::Storage
::Plugin
;
9 use PVE
::JSONSchema
qw(get_standard_option);
11 use PVE
::Storage
::CephTools
;
14 use base
qw(PVE::Storage::Plugin);
16 my $rbd_unittobytes = {
19 "G" => 1024*1024*1024,
20 "T" => 1024*1024*1024*1024,
23 my $get_parent_image_name = sub {
25 return undef if !$parent;
26 return $parent->{image
} . "@" . $parent->{snapshot
};
29 my $add_pool_to_disk = sub {
30 my ($scfg, $disk) = @_;
32 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
38 my ($binary, $scfg, $storeid, $op, @options) = @_;
40 my $cmd_option = PVE
::Storage
::CephTools
::ceph_connect_option
($scfg, $storeid);
41 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
43 my $cmd = [$binary, '-p', $pool];
45 push @$cmd, '-c', $cmd_option->{ceph_conf
} if ($cmd_option->{ceph_conf
});
46 push @$cmd, '-m', $cmd_option->{mon_host
} if ($cmd_option->{mon_host
});
47 push @$cmd, '--auth_supported', $cmd_option->{auth_supported
} if ($cmd_option->{auth_supported
});
48 push @$cmd, '-n', "client.$cmd_option->{userid}" if ($cmd_option->{userid
});
49 push @$cmd, '--keyring', $cmd_option->{keyring
} if ($cmd_option->{keyring
});
53 push @$cmd, @options if scalar(@options);
59 my ($scfg, $storeid, $op, @options) = @_;
61 return $build_cmd->('/usr/bin/rbd', $scfg, $storeid, $op, @options);
65 my ($scfg, $storeid, $op, @options) = @_;
67 return $build_cmd->('/usr/bin/rados', $scfg, $storeid, $op, @options);
70 my $librados_connect = sub {
71 my ($scfg, $storeid, $options) = @_;
73 my $librados_config = PVE
::Storage
::CephTools
::ceph_connect_option
($scfg, $storeid);
75 my $rados = PVE
::RADOS-
>new(%$librados_config);
80 # needed for volumes created using ceph jewel (or higher)
81 my $krbd_feature_disable = sub {
82 my ($scfg, $storeid, $name) = @_;
84 return 1 if !$scfg->{krbd
};
86 my ($major, undef, undef, undef) = ceph_version
();
87 return 1 if $major < 10;
89 my $krbd_feature_blacklist = ['deep-flatten', 'fast-diff', 'object-map', 'exclusive-lock'];
90 my (undef, undef, undef, undef, $features) = rbd_volume_info
($scfg, $storeid, $name);
92 my $active_features = { map { $_ => 1 } $features };
93 my $incompatible_features = join(',', grep { %$active_features{$_} } @$krbd_feature_blacklist);
95 if ($incompatible_features) {
96 my $feature_cmd = &$rbd_cmd($scfg, $storeid, 'feature', 'disable', $name, $incompatible_features);
97 run_rbd_command
($feature_cmd, errmsg
=> "could not disable krbd-incompatible image features of rbd volume $name");
101 my $ceph_version_parser = sub {
103 if ($line =~ m/^ceph version ((\d+)\.(\d+)\.(\d+))(?: \([a-fA-F0-9]+\))/) {
104 return ($2, $3, $4, $1);
106 warn "Could not parse Ceph version: '$line'\n";
113 my $version_string = $cache;
119 if (defined($version_string)) {
120 ($major, $minor, $bugfix, $version_string) = &$ceph_version_parser($version_string);
122 run_command
('ceph --version', outfunc
=> sub {
124 ($major, $minor, $bugfix, $version_string) = &$ceph_version_parser($line);
127 return undef if !defined($version_string);
128 return wantarray ?
($major, $minor, $bugfix, $version_string) : $version_string;
131 sub run_rbd_command
{
132 my ($cmd, %args) = @_;
135 my $errmsg = $args{errmsg
} . ": " || "";
136 if (!exists($args{errfunc
})) {
137 # ' error: 2014-02-06 11:51:59.839135 7f09f94d0760 -1 librbd: snap_unprotect: can't unprotect;
138 # at least 1 child(ren) in pool cephstor1
139 $args{errfunc
} = sub {
141 if ($line =~ m/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\.\d+ [0-9a-f]+ [\-\d]+ librbd: (.*)$/) {
146 print STDERR
$lasterr;
151 eval { run_command
($cmd, %args); };
153 die $errmsg . $lasterr if length($lasterr);
161 my ($scfg, $storeid) = @_;
163 my $cmd = &$rbd_cmd($scfg, $storeid, 'ls', '-l', '--format', 'json');
164 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
173 run_rbd_command
($cmd, errmsg
=> "rbd error", errfunc
=> sub {}, outfunc
=> $parser);
177 die $err if $err && $err !~ m/doesn't contain rbd images/ ;
179 my $result = $raw ne '' ? JSON
::decode_json
($raw) : [];
183 foreach my $el (@$result) {
184 next if defined($el->{snapshot
});
186 my $image = $el->{image
};
188 my ($owner) = $image =~ m/^(?:vm|base)-(\d+)-/;
190 $list->{$pool}->{$image} = {
193 parent
=> $get_parent_image_name->($el->{parent
}),
201 sub rbd_volume_info
{
202 my ($scfg, $storeid, $volname, $snap) = @_;
206 my @options = ('info', $volname, '--format', 'json');
208 push @options, '--snap', $snap;
211 $cmd = &$rbd_cmd($scfg, $storeid, @options);
216 my $protected = undef;
217 my $features = undef;
224 run_rbd_command
($cmd, errmsg
=> "rbd error", errfunc
=> sub {}, outfunc
=> $parser);
225 my $volume = $raw ne '' ? JSON
::decode_json
($raw) : {};
226 $volume->{parent
} = $get_parent_image_name->($volume->{parent
});
227 if (defined($volume->{protected
})) {
228 $volume->{protected
} = $volume->{protected
} eq "true" ?
1 : undef;
231 return $volume->@{qw(size parent format protected features)};
242 content
=> [ {images
=> 1, rootdir
=> 1}, { images
=> 1 }],
249 description
=> "IP addresses of monitors (for external clusters).",
250 type
=> 'string', format
=> 'pve-storage-portal-dns-list',
253 description
=> "Pool.",
257 description
=> "RBD Id.",
261 description
=> "Authsupported.",
265 description
=> "Access rbd through krbd kernel module.",
273 nodes
=> { optional
=> 1 },
274 disable
=> { optional
=> 1 },
275 monhost
=> { optional
=> 1},
276 pool
=> { optional
=> 1 },
277 username
=> { optional
=> 1 },
278 content
=> { optional
=> 1 },
279 krbd
=> { optional
=> 1 },
280 bwlimit
=> { optional
=> 1 },
284 # Storage implementation
287 my ($class, $storeid, $scfg, %param) = @_;
289 return if defined($scfg->{monhost
}); # nothing to do if not pve managed ceph
291 PVE
::Storage
::CephTools
::ceph_create_keyfile
($scfg->{type
}, $storeid);
295 my ($class, $storeid, $scfg) = @_;
297 return if defined($scfg->{monhost
}); # nothing to do if not pve managed ceph
299 PVE
::Storage
::CephTools
::ceph_remove_keyfile
($scfg->{type
}, $storeid);
303 my ($class, $volname) = @_;
305 if ($volname =~ m/^((base-(\d+)-\S+)\/)?
((base
)?
(vm
)?
-(\d
+)-\S
+)$/) {
306 return ('images', $4, $7, $2, $3, $5, 'raw');
309 die "unable to parse rbd volume name '$volname'\n";
313 my ($class, $scfg, $volname, $storeid, $snapname) = @_;
315 my $cmd_option = PVE
::Storage
::CephTools
::ceph_connect_option
($scfg, $storeid);
316 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
317 $name .= '@'.$snapname if $snapname;
319 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
320 return ("/dev/rbd/$pool/$name", $vmid, $vtype) if $scfg->{krbd
};
322 my $path = "rbd:$pool/$name";
324 $path .= ":conf=$cmd_option->{ceph_conf}" if $cmd_option->{ceph_conf
};
325 if (defined($scfg->{monhost
})) {
326 my $monhost = PVE
::Storage
::CephTools
::hostlist
($scfg->{monhost
}, ';');
327 $monhost =~ s/:/\\:/g;
328 $path .= ":mon_host=$monhost";
329 $path .= ":auth_supported=$cmd_option->{auth_supported}";
332 $path .= ":id=$cmd_option->{userid}:keyring=$cmd_option->{keyring}" if ($cmd_option->{keyring
});
334 return ($path, $vmid, $vtype);
337 my $find_free_diskname = sub {
338 my ($storeid, $scfg, $vmid) = @_;
340 my $cmd = &$rbd_cmd($scfg, $storeid, 'ls');
346 if ($line =~ m/^(vm|base)-\Q$vmid\E+-disk-(\d+)$/) {
352 run_rbd_command
($cmd, errmsg
=> "rbd error", errfunc
=> sub {}, outfunc
=> $parser);
356 die $err if $err && $err !~ m/doesn't contain rbd images/;
358 #fix: can we search in $rbd hash key with a regex to find (vm|base) ?
359 for (my $i = 1; $i < 100; $i++) {
360 if (!$disk_ids->{$i}) {
361 return "vm-$vmid-disk-$i";
365 die "unable to allocate an image name for VM $vmid in storage '$storeid'\n";
369 my ($class, $storeid, $scfg, $volname) = @_;
371 my $snap = '__base__';
373 my ($vtype, $name, $vmid, $basename, $basevmid, $isBase) =
374 $class->parse_volname($volname);
376 die "create_base not possible with base image\n" if $isBase;
378 my ($size, $parent, $format, undef) = rbd_volume_info
($scfg, $storeid, $name);
379 die "rbd volume info on '$name' failed\n" if !($size);
381 die "rbd image must be at format V2" if $format ne "2";
383 die "volname '$volname' contains wrong information about parent $parent $basename\n"
384 if $basename && (!$parent || $parent ne $basename."@".$snap);
387 $newname =~ s/^vm-/base-/;
389 my $newvolname = $basename ?
"$basename/$newname" : "$newname";
391 my $cmd = &$rbd_cmd($scfg, $storeid, 'rename', &$add_pool_to_disk($scfg, $name), &$add_pool_to_disk($scfg, $newname));
392 run_rbd_command
($cmd, errmsg
=> "rbd rename '$name' error");
394 my $running = undef; #fixme : is create_base always offline ?
396 $class->volume_snapshot($scfg, $storeid, $newname, $snap, $running);
398 my (undef, undef, undef, $protected) = rbd_volume_info
($scfg, $storeid, $newname, $snap);
401 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'protect', $newname, '--snap', $snap);
402 run_rbd_command
($cmd, errmsg
=> "rbd protect $newname snap '$snap' error");
410 my ($class, $scfg, $storeid, $volname, $vmid, $snapname) = @_;
412 my $snap = '__base__';
413 $snap = $snapname if length $snapname;
415 my ($vtype, $basename, $basevmid, undef, undef, $isBase) =
416 $class->parse_volname($volname);
418 die "$volname is not a base image and snapname is not provided\n"
419 if !$isBase && !length($snapname);
421 my $name = &$find_free_diskname($storeid, $scfg, $vmid);
423 warn "clone $volname: $basename snapname $snap to $name\n";
425 if (length($snapname)) {
426 my (undef, undef, undef, $protected) = rbd_volume_info
($scfg, $storeid, $volname, $snapname);
429 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'protect', $volname, '--snap', $snapname);
430 run_rbd_command
($cmd, errmsg
=> "rbd protect $volname snap $snapname error");
434 my $newvol = "$basename/$name";
435 $newvol = $name if length($snapname);
437 my $cmd = &$rbd_cmd($scfg, $storeid, 'clone', &$add_pool_to_disk($scfg, $basename),
438 '--snap', $snap, &$add_pool_to_disk($scfg, $name));
440 run_rbd_command
($cmd, errmsg
=> "rbd clone '$basename' error");
442 &$krbd_feature_disable($scfg, $storeid, $name);
448 my ($class, $storeid, $scfg, $vmid, $fmt, $name, $size) = @_;
451 die "illegal name '$name' - should be 'vm-$vmid-*'\n"
452 if $name && $name !~ m/^vm-$vmid-/;
454 $name = &$find_free_diskname($storeid, $scfg, $vmid) if !$name;
456 my $cmd = &$rbd_cmd($scfg, $storeid, 'create', '--image-format' , 2, '--size', int(($size+1023)/1024), $name);
457 run_rbd_command
($cmd, errmsg
=> "rbd create $name' error");
459 &$krbd_feature_disable($scfg, $storeid, $name);
465 my ($class, $storeid, $scfg, $volname, $isBase) = @_;
467 my ($vtype, $name, $vmid, undef, undef, undef) =
468 $class->parse_volname($volname);
471 my $snap = '__base__';
472 my (undef, undef, undef, $protected) = rbd_volume_info
($scfg, $storeid, $name, $snap);
474 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'unprotect', $name, '--snap', $snap);
475 run_rbd_command
($cmd, errmsg
=> "rbd unprotect $name snap '$snap' error");
479 $class->deactivate_volume($storeid, $scfg, $volname);
481 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'purge', $name);
482 run_rbd_command
($cmd, errmsg
=> "rbd snap purge '$volname' error");
484 $cmd = &$rbd_cmd($scfg, $storeid, 'rm', $name);
485 run_rbd_command
($cmd, errmsg
=> "rbd rm '$volname' error");
491 my ($class, $storeid, $scfg, $vmid, $vollist, $cache) = @_;
493 $cache->{rbd
} = rbd_ls
($scfg, $storeid) if !$cache->{rbd
};
494 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
498 if (my $dat = $cache->{rbd
}->{$pool}) {
499 foreach my $image (keys %$dat) {
501 my $info = $dat->{$image};
503 my $volname = $info->{name
};
504 my $parent = $info->{parent
};
505 my $owner = $info->{vmid
};
507 if ($parent && $parent =~ m/^(base-\d+-\S+)\@__base__$/) {
508 $info->{volid
} = "$storeid:$1/$volname";
510 $info->{volid
} = "$storeid:$volname";
514 my $found = grep { $_ eq $info->{volid
} } @$vollist;
517 next if defined ($vmid) && ($owner ne $vmid);
520 $info->{format
} = 'raw';
530 my ($class, $storeid, $scfg, $cache) = @_;
533 my $rados = &$librados_connect($scfg, $storeid);
534 my $df = $rados->mon_command({ prefix
=> 'df', format
=> 'json' });
536 my ($d) = grep { $_->{name
} eq $scfg->{pool
} } @{$df->{pools
}};
538 # max_avail -> max available space for data w/o replication in the pool
539 # bytes_used -> data w/o replication in the pool
540 my $free = $d->{stats
}->{max_avail
};
541 my $used = $d->{stats
}->{bytes_used
};
542 my $total = $used + $free;
545 return ($total, $free, $used, $active);
548 sub activate_storage
{
549 my ($class, $storeid, $scfg, $cache) = @_;
553 sub deactivate_storage
{
554 my ($class, $storeid, $scfg, $cache) = @_;
558 sub activate_volume
{
559 my ($class, $storeid, $scfg, $volname, $snapname, $cache) = @_;
561 return 1 if !$scfg->{krbd
};
563 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
564 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
566 my $path = "/dev/rbd/$pool/$name";
567 $path .= '@'.$snapname if $snapname;
570 $name .= '@'.$snapname if $snapname;
571 my $cmd = &$rbd_cmd($scfg, $storeid, 'map', $name);
572 run_rbd_command
($cmd, errmsg
=> "can't mount rbd volume $name");
577 sub deactivate_volume
{
578 my ($class, $storeid, $scfg, $volname, $snapname, $cache) = @_;
580 return 1 if !$scfg->{krbd
};
582 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
583 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
585 my $path = "/dev/rbd/$pool/$name";
586 $path .= '@'.$snapname if $snapname;
587 return if ! -b
$path;
589 my $cmd = &$rbd_cmd($scfg, $storeid, 'unmap', $path);
590 run_rbd_command
($cmd, errmsg
=> "can't unmap rbd volume $name");
595 sub volume_size_info
{
596 my ($class, $scfg, $storeid, $volname, $timeout) = @_;
598 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
599 my ($size, undef) = rbd_volume_info
($scfg, $storeid, $name);
604 my ($class, $scfg, $storeid, $volname, $size, $running) = @_;
606 return 1 if $running && !$scfg->{krbd
};
608 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
610 my $cmd = &$rbd_cmd($scfg, $storeid, 'resize', '--allow-shrink', '--size', ($size/1024/1024), $name);
611 run_rbd_command
($cmd, errmsg
=> "rbd resize '$volname' error");
615 sub volume_snapshot
{
616 my ($class, $scfg, $storeid, $volname, $snap) = @_;
618 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
620 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'create', '--snap', $snap, $name);
621 run_rbd_command
($cmd, errmsg
=> "rbd snapshot '$volname' error");
625 sub volume_snapshot_rollback
{
626 my ($class, $scfg, $storeid, $volname, $snap) = @_;
628 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
630 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'rollback', '--snap', $snap, $name);
631 run_rbd_command
($cmd, errmsg
=> "rbd snapshot $volname to '$snap' error");
634 sub volume_snapshot_delete
{
635 my ($class, $scfg, $storeid, $volname, $snap, $running) = @_;
637 return 1 if $running && !$scfg->{krbd
};
639 $class->deactivate_volume($storeid, $scfg, $volname, $snap, {});
641 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
643 my (undef, undef, undef, $protected) = rbd_volume_info
($scfg, $storeid, $name, $snap);
645 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'unprotect', $name, '--snap', $snap);
646 run_rbd_command
($cmd, errmsg
=> "rbd unprotect $name snap '$snap' error");
649 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'rm', '--snap', $snap, $name);
651 run_rbd_command
($cmd, errmsg
=> "rbd snapshot '$volname' error");
656 sub volume_has_feature
{
657 my ($class, $scfg, $feature, $storeid, $volname, $snapname, $running) = @_;
660 snapshot
=> { current
=> 1, snap
=> 1},
661 clone
=> { base
=> 1, snap
=> 1},
662 template
=> { current
=> 1},
663 copy
=> { base
=> 1, current
=> 1, snap
=> 1},
664 sparseinit
=> { base
=> 1, current
=> 1},
667 my ($vtype, $name, $vmid, $basename, $basevmid, $isBase) =
668 $class->parse_volname($volname);
674 $key = $isBase ?
'base' : 'current';
676 return 1 if $features->{$feature}->{$key};