]>
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 $get_parent_image_name = sub {
18 return undef if !$parent;
19 return $parent->{image
} . "@" . $parent->{snapshot
};
22 my $add_pool_to_disk = sub {
23 my ($scfg, $disk) = @_;
25 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
31 my ($binary, $scfg, $storeid, $op, @options) = @_;
33 my $cmd_option = PVE
::Storage
::CephTools
::ceph_connect_option
($scfg, $storeid);
34 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
36 my $cmd = [$binary, '-p', $pool];
38 push @$cmd, '-c', $cmd_option->{ceph_conf
} if ($cmd_option->{ceph_conf
});
39 push @$cmd, '-m', $cmd_option->{mon_host
} if ($cmd_option->{mon_host
});
40 push @$cmd, '--auth_supported', $cmd_option->{auth_supported
} if ($cmd_option->{auth_supported
});
41 push @$cmd, '-n', "client.$cmd_option->{userid}" if ($cmd_option->{userid
});
42 push @$cmd, '--keyring', $cmd_option->{keyring
} if ($cmd_option->{keyring
});
46 push @$cmd, @options if scalar(@options);
52 my ($scfg, $storeid, $op, @options) = @_;
54 return $build_cmd->('/usr/bin/rbd', $scfg, $storeid, $op, @options);
58 my ($scfg, $storeid, $op, @options) = @_;
60 return $build_cmd->('/usr/bin/rados', $scfg, $storeid, $op, @options);
63 my $librados_connect = sub {
64 my ($scfg, $storeid, $options) = @_;
66 my $librados_config = PVE
::Storage
::CephTools
::ceph_connect_option
($scfg, $storeid);
68 my $rados = PVE
::RADOS-
>new(%$librados_config);
73 # needed for volumes created using ceph jewel (or higher)
74 my $krbd_feature_disable = sub {
75 my ($scfg, $storeid, $name) = @_;
77 my ($major, undef, undef, undef) = ceph_version
();
78 return 1 if $major < 10;
80 my $krbd_feature_blacklist = ['deep-flatten', 'fast-diff', 'object-map', 'exclusive-lock'];
81 my (undef, undef, undef, undef, $features) = rbd_volume_info
($scfg, $storeid, $name);
83 my $active_features = { map { $_ => 1 } @$features };
84 my $incompatible_features = join(',', grep { %$active_features{$_} } @$krbd_feature_blacklist);
86 if ($incompatible_features) {
87 my $feature_cmd = &$rbd_cmd($scfg, $storeid, 'feature', 'disable', $name, $incompatible_features);
88 run_rbd_command
($feature_cmd, errmsg
=> "could not disable krbd-incompatible image features of rbd volume $name");
92 my $ceph_version_parser = sub {
94 if ($line =~ m/^ceph version ((\d+)\.(\d+)\.(\d+))(?: \([a-fA-F0-9]+\))/) {
95 return ($2, $3, $4, $1);
97 warn "Could not parse Ceph version: '$line'\n";
104 my $version_string = $cache;
110 if (defined($version_string)) {
111 ($major, $minor, $bugfix, $version_string) = &$ceph_version_parser($version_string);
113 run_command
('ceph --version', outfunc
=> sub {
115 ($major, $minor, $bugfix, $version_string) = &$ceph_version_parser($line);
118 return undef if !defined($version_string);
119 return wantarray ?
($major, $minor, $bugfix, $version_string) : $version_string;
122 sub run_rbd_command
{
123 my ($cmd, %args) = @_;
126 my $errmsg = $args{errmsg
} . ": " || "";
127 if (!exists($args{errfunc
})) {
128 # ' error: 2014-02-06 11:51:59.839135 7f09f94d0760 -1 librbd: snap_unprotect: can't unprotect;
129 # at least 1 child(ren) in pool cephstor1
130 $args{errfunc
} = sub {
132 if ($line =~ m/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\.\d+ [0-9a-f]+ [\-\d]+ librbd: (.*)$/) {
137 print STDERR
$lasterr;
142 eval { run_command
($cmd, %args); };
144 die $errmsg . $lasterr if length($lasterr);
152 my ($scfg, $storeid) = @_;
154 my $cmd = &$rbd_cmd($scfg, $storeid, 'ls', '-l', '--format', 'json');
155 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
158 my $parser = sub { $raw .= shift };
161 run_rbd_command
($cmd, errmsg
=> "rbd error", errfunc
=> sub {}, outfunc
=> $parser);
165 die $err if $err && $err !~ m/doesn't contain rbd images/ ;
170 } elsif ($raw =~ m/^(\[.*\])$/s) { # untaint
171 $result = JSON
::decode_json
($1);
173 die "got unexpected data from rbd ls: '$raw'\n";
178 foreach my $el (@$result) {
179 next if defined($el->{snapshot
});
181 my $image = $el->{image
};
183 my ($owner) = $image =~ m/^(?:vm|base)-(\d+)-/;
184 next if !defined($owner);
186 $list->{$pool}->{$image} = {
189 parent
=> $get_parent_image_name->($el->{parent
}),
197 sub rbd_volume_info
{
198 my ($scfg, $storeid, $volname, $snap) = @_;
202 my @options = ('info', $volname, '--format', 'json');
204 push @options, '--snap', $snap;
207 $cmd = &$rbd_cmd($scfg, $storeid, @options);
210 my $parser = sub { $raw .= shift };
212 run_rbd_command
($cmd, errmsg
=> "rbd error", errfunc
=> sub {}, outfunc
=> $parser);
217 } elsif ($raw =~ m/^(\{.*\})$/s) { # untaint
218 $volume = JSON
::decode_json
($1);
220 die "got unexpected data from rbd info: '$raw'\n";
223 $volume->{parent
} = $get_parent_image_name->($volume->{parent
});
224 $volume->{protected
} = defined($volume->{protected
}) && $volume->{protected
} eq "true" ?
1 : undef;
226 return $volume->@{qw(size parent format protected features)};
237 content
=> [ {images
=> 1, rootdir
=> 1}, { images
=> 1 }],
244 description
=> "IP addresses of monitors (for external clusters).",
245 type
=> 'string', format
=> 'pve-storage-portal-dns-list',
248 description
=> "Pool.",
252 description
=> "RBD Id.",
256 description
=> "Authsupported.",
260 description
=> "Always access rbd through krbd kernel module.",
268 nodes
=> { optional
=> 1 },
269 disable
=> { optional
=> 1 },
270 monhost
=> { optional
=> 1},
271 pool
=> { optional
=> 1 },
272 username
=> { optional
=> 1 },
273 content
=> { optional
=> 1 },
274 krbd
=> { optional
=> 1 },
275 bwlimit
=> { optional
=> 1 },
279 # Storage implementation
282 my ($class, $storeid, $scfg, %param) = @_;
284 return if defined($scfg->{monhost
}); # nothing to do if not pve managed ceph
286 PVE
::Storage
::CephTools
::ceph_create_keyfile
($scfg->{type
}, $storeid);
290 my ($class, $storeid, $scfg) = @_;
292 return if defined($scfg->{monhost
}); # nothing to do if not pve managed ceph
294 PVE
::Storage
::CephTools
::ceph_remove_keyfile
($scfg->{type
}, $storeid);
298 my ($class, $volname) = @_;
300 if ($volname =~ m/^((base-(\d+)-\S+)\/)?
((base
)?
(vm
)?
-(\d
+)-\S
+)$/) {
301 return ('images', $4, $7, $2, $3, $5, 'raw');
304 die "unable to parse rbd volume name '$volname'\n";
308 my ($class, $scfg, $volname, $storeid, $snapname) = @_;
310 my $cmd_option = PVE
::Storage
::CephTools
::ceph_connect_option
($scfg, $storeid);
311 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
312 $name .= '@'.$snapname if $snapname;
314 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
315 return ("/dev/rbd/$pool/$name", $vmid, $vtype) if $scfg->{krbd
};
317 my $path = "rbd:$pool/$name";
319 $path .= ":conf=$cmd_option->{ceph_conf}" if $cmd_option->{ceph_conf
};
320 if (defined($scfg->{monhost
})) {
321 my $monhost = PVE
::Storage
::CephTools
::hostlist
($scfg->{monhost
}, ';');
322 $monhost =~ s/:/\\:/g;
323 $path .= ":mon_host=$monhost";
324 $path .= ":auth_supported=$cmd_option->{auth_supported}";
327 $path .= ":id=$cmd_option->{userid}:keyring=$cmd_option->{keyring}" if ($cmd_option->{keyring
});
329 return ($path, $vmid, $vtype);
332 my $find_free_diskname = sub {
333 my ($storeid, $scfg, $vmid) = @_;
335 my $cmd = &$rbd_cmd($scfg, $storeid, 'ls');
340 if ($line =~ m/^(.*)$/) { # untaint
341 push @$disk_list, $1;
346 run_rbd_command
($cmd, errmsg
=> "rbd error", errfunc
=> sub {}, outfunc
=> $parser);
350 die $err if $err && $err !~ m/doesn't contain rbd images/;
352 return PVE
::Storage
::Plugin
::get_next_vm_diskname
($disk_list, $storeid, $vmid, undef, $scfg);
356 my ($class, $storeid, $scfg, $volname) = @_;
358 my $snap = '__base__';
360 my ($vtype, $name, $vmid, $basename, $basevmid, $isBase) =
361 $class->parse_volname($volname);
363 die "create_base not possible with base image\n" if $isBase;
365 my ($size, $parent, $format, undef) = rbd_volume_info
($scfg, $storeid, $name);
366 die "rbd volume info on '$name' failed\n" if !($size);
368 die "rbd image must be at format V2" if $format ne "2";
370 die "volname '$volname' contains wrong information about parent $parent $basename\n"
371 if $basename && (!$parent || $parent ne $basename."@".$snap);
374 $newname =~ s/^vm-/base-/;
376 my $newvolname = $basename ?
"$basename/$newname" : "$newname";
378 my $cmd = &$rbd_cmd($scfg, $storeid, 'rename', &$add_pool_to_disk($scfg, $name), &$add_pool_to_disk($scfg, $newname));
379 run_rbd_command
($cmd, errmsg
=> "rbd rename '$name' error");
381 my $running = undef; #fixme : is create_base always offline ?
383 $class->volume_snapshot($scfg, $storeid, $newname, $snap, $running);
385 my (undef, undef, undef, $protected) = rbd_volume_info
($scfg, $storeid, $newname, $snap);
388 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'protect', $newname, '--snap', $snap);
389 run_rbd_command
($cmd, errmsg
=> "rbd protect $newname snap '$snap' error");
397 my ($class, $scfg, $storeid, $volname, $vmid, $snapname) = @_;
399 my $snap = '__base__';
400 $snap = $snapname if length $snapname;
402 my ($vtype, $basename, $basevmid, undef, undef, $isBase) =
403 $class->parse_volname($volname);
405 die "$volname is not a base image and snapname is not provided\n"
406 if !$isBase && !length($snapname);
408 my $name = $find_free_diskname->($storeid, $scfg, $vmid);
410 warn "clone $volname: $basename snapname $snap to $name\n";
412 if (length($snapname)) {
413 my (undef, undef, undef, $protected) = rbd_volume_info
($scfg, $storeid, $volname, $snapname);
416 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'protect', $volname, '--snap', $snapname);
417 run_rbd_command
($cmd, errmsg
=> "rbd protect $volname snap $snapname error");
421 my $newvol = "$basename/$name";
422 $newvol = $name if length($snapname);
424 my $cmd = &$rbd_cmd($scfg, $storeid, 'clone', &$add_pool_to_disk($scfg, $basename),
425 '--snap', $snap, &$add_pool_to_disk($scfg, $name));
427 run_rbd_command
($cmd, errmsg
=> "rbd clone '$basename' error");
433 my ($class, $storeid, $scfg, $vmid, $fmt, $name, $size) = @_;
436 die "illegal name '$name' - should be 'vm-$vmid-*'\n"
437 if $name && $name !~ m/^vm-$vmid-/;
439 $name = $find_free_diskname->($storeid, $scfg, $vmid) if !$name;
441 my $cmd = &$rbd_cmd($scfg, $storeid, 'create', '--image-format' , 2, '--size', int(($size+1023)/1024), $name);
442 run_rbd_command
($cmd, errmsg
=> "rbd create $name' error");
448 my ($class, $storeid, $scfg, $volname, $isBase) = @_;
450 my ($vtype, $name, $vmid, undef, undef, undef) =
451 $class->parse_volname($volname);
454 my $snap = '__base__';
455 my (undef, undef, undef, $protected) = rbd_volume_info
($scfg, $storeid, $name, $snap);
457 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'unprotect', $name, '--snap', $snap);
458 run_rbd_command
($cmd, errmsg
=> "rbd unprotect $name snap '$snap' error");
462 $class->deactivate_volume($storeid, $scfg, $volname);
464 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'purge', $name);
465 run_rbd_command
($cmd, errmsg
=> "rbd snap purge '$volname' error");
467 $cmd = &$rbd_cmd($scfg, $storeid, 'rm', $name);
468 run_rbd_command
($cmd, errmsg
=> "rbd rm '$volname' error");
474 my ($class, $storeid, $scfg, $vmid, $vollist, $cache) = @_;
476 $cache->{rbd
} = rbd_ls
($scfg, $storeid) if !$cache->{rbd
};
477 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
481 if (my $dat = $cache->{rbd
}->{$pool}) {
482 foreach my $image (keys %$dat) {
484 my $info = $dat->{$image};
486 my $volname = $info->{name
};
487 my $parent = $info->{parent
};
488 my $owner = $info->{vmid
};
490 if ($parent && $parent =~ m/^(base-\d+-\S+)\@__base__$/) {
491 $info->{volid
} = "$storeid:$1/$volname";
493 $info->{volid
} = "$storeid:$volname";
497 my $found = grep { $_ eq $info->{volid
} } @$vollist;
500 next if defined ($vmid) && ($owner ne $vmid);
503 $info->{format
} = 'raw';
513 my ($class, $storeid, $scfg, $cache) = @_;
516 my $rados = &$librados_connect($scfg, $storeid);
517 my $df = $rados->mon_command({ prefix
=> 'df', format
=> 'json' });
519 my ($d) = grep { $_->{name
} eq $scfg->{pool
} } @{$df->{pools
}};
521 # max_avail -> max available space for data w/o replication in the pool
522 # bytes_used -> data w/o replication in the pool
523 my $free = $d->{stats
}->{max_avail
};
524 my $used = $d->{stats
}->{bytes_used
};
525 my $total = $used + $free;
528 return ($total, $free, $used, $active);
531 sub activate_storage
{
532 my ($class, $storeid, $scfg, $cache) = @_;
536 sub deactivate_storage
{
537 my ($class, $storeid, $scfg, $cache) = @_;
541 my $get_kernel_device_name = sub {
542 my ($pool, $name) = @_;
544 return "/dev/rbd/$pool/$name";
548 my ($class, $storeid, $scfg, $volname, $snapname) = @_;
550 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
551 $name .= '@'.$snapname if $snapname;
553 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
555 my $kerneldev = $get_kernel_device_name->($pool, $name);
557 return $kerneldev if -b
$kerneldev; # already mapped
559 &$krbd_feature_disable($scfg, $storeid, $name);
561 my $cmd = &$rbd_cmd($scfg, $storeid, 'map', $name);
562 run_rbd_command
($cmd, errmsg
=> "can't map rbd volume $name");
568 my ($class, $storeid, $scfg, $volname, $snapname) = @_;
570 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
571 $name .= '@'.$snapname if $snapname;
573 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
575 my $kerneldev = $get_kernel_device_name->($pool, $name);
578 my $cmd = &$rbd_cmd($scfg, $storeid, 'unmap', $kerneldev);
579 run_rbd_command
($cmd, errmsg
=> "can't unmap rbd device $kerneldev");
585 sub activate_volume
{
586 my ($class, $storeid, $scfg, $volname, $snapname, $cache) = @_;
588 $class->map_volume($storeid, $scfg, $volname, $snapname) if $scfg->{krbd
};
593 sub deactivate_volume
{
594 my ($class, $storeid, $scfg, $volname, $snapname, $cache) = @_;
596 $class->unmap_volume($storeid, $scfg, $volname, $snapname);
601 sub volume_size_info
{
602 my ($class, $scfg, $storeid, $volname, $timeout) = @_;
604 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
605 my ($size, undef) = rbd_volume_info
($scfg, $storeid, $name);
610 my ($class, $scfg, $storeid, $volname, $size, $running) = @_;
612 return 1 if $running && !$scfg->{krbd
}; # FIXME???
614 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
616 my $cmd = &$rbd_cmd($scfg, $storeid, 'resize', '--allow-shrink', '--size', ($size/1024/1024), $name);
617 run_rbd_command
($cmd, errmsg
=> "rbd resize '$volname' error");
621 sub volume_snapshot
{
622 my ($class, $scfg, $storeid, $volname, $snap) = @_;
624 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
626 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'create', '--snap', $snap, $name);
627 run_rbd_command
($cmd, errmsg
=> "rbd snapshot '$volname' error");
631 sub volume_snapshot_rollback
{
632 my ($class, $scfg, $storeid, $volname, $snap) = @_;
634 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
636 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'rollback', '--snap', $snap, $name);
637 run_rbd_command
($cmd, errmsg
=> "rbd snapshot $volname to '$snap' error");
640 sub volume_snapshot_delete
{
641 my ($class, $scfg, $storeid, $volname, $snap, $running) = @_;
643 return 1 if $running && !$scfg->{krbd
}; # FIXME: ????
645 $class->deactivate_volume($storeid, $scfg, $volname, $snap, {});
647 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
649 my (undef, undef, undef, $protected) = rbd_volume_info
($scfg, $storeid, $name, $snap);
651 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'unprotect', $name, '--snap', $snap);
652 run_rbd_command
($cmd, errmsg
=> "rbd unprotect $name snap '$snap' error");
655 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'rm', '--snap', $snap, $name);
657 run_rbd_command
($cmd, errmsg
=> "rbd snapshot '$volname' error");
662 sub volume_has_feature
{
663 my ($class, $scfg, $feature, $storeid, $volname, $snapname, $running) = @_;
666 snapshot
=> { current
=> 1, snap
=> 1},
667 clone
=> { base
=> 1, snap
=> 1},
668 template
=> { current
=> 1},
669 copy
=> { base
=> 1, current
=> 1, snap
=> 1},
670 sparseinit
=> { base
=> 1, current
=> 1},
673 my ($vtype, $name, $vmid, $basename, $basevmid, $isBase) =
674 $class->parse_volname($volname);
680 $key = $isBase ?
'base' : 'current';
682 return 1 if $features->{$feature}->{$key};