]>
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 return 1 if !$scfg->{krbd
};
79 my ($major, undef, undef, undef) = ceph_version
();
80 return 1 if $major < 10;
82 my $krbd_feature_blacklist = ['deep-flatten', 'fast-diff', 'object-map', 'exclusive-lock'];
83 my (undef, undef, undef, undef, $features) = rbd_volume_info
($scfg, $storeid, $name);
85 my $active_features = { map { $_ => 1 } @$features };
86 my $incompatible_features = join(',', grep { %$active_features{$_} } @$krbd_feature_blacklist);
88 if ($incompatible_features) {
89 my $feature_cmd = &$rbd_cmd($scfg, $storeid, 'feature', 'disable', $name, $incompatible_features);
90 run_rbd_command
($feature_cmd, errmsg
=> "could not disable krbd-incompatible image features of rbd volume $name");
94 my $ceph_version_parser = sub {
96 if ($line =~ m/^ceph version ((\d+)\.(\d+)\.(\d+))(?: \([a-fA-F0-9]+\))/) {
97 return ($2, $3, $4, $1);
99 warn "Could not parse Ceph version: '$line'\n";
106 my $version_string = $cache;
112 if (defined($version_string)) {
113 ($major, $minor, $bugfix, $version_string) = &$ceph_version_parser($version_string);
115 run_command
('ceph --version', outfunc
=> sub {
117 ($major, $minor, $bugfix, $version_string) = &$ceph_version_parser($line);
120 return undef if !defined($version_string);
121 return wantarray ?
($major, $minor, $bugfix, $version_string) : $version_string;
124 sub run_rbd_command
{
125 my ($cmd, %args) = @_;
128 my $errmsg = $args{errmsg
} . ": " || "";
129 if (!exists($args{errfunc
})) {
130 # ' error: 2014-02-06 11:51:59.839135 7f09f94d0760 -1 librbd: snap_unprotect: can't unprotect;
131 # at least 1 child(ren) in pool cephstor1
132 $args{errfunc
} = sub {
134 if ($line =~ m/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\.\d+ [0-9a-f]+ [\-\d]+ librbd: (.*)$/) {
139 print STDERR
$lasterr;
144 eval { run_command
($cmd, %args); };
146 die $errmsg . $lasterr if length($lasterr);
154 my ($scfg, $storeid) = @_;
156 my $cmd = &$rbd_cmd($scfg, $storeid, 'ls', '-l', '--format', 'json');
157 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
160 my $parser = sub { $raw .= shift };
163 run_rbd_command
($cmd, errmsg
=> "rbd error", errfunc
=> sub {}, outfunc
=> $parser);
167 die $err if $err && $err !~ m/doesn't contain rbd images/ ;
172 } elsif ($raw =~ m/^(\[.*\])$/s) { # untaint
173 $result = JSON
::decode_json
($1);
175 die "got unexpected data from rbd ls: '$raw'\n";
180 foreach my $el (@$result) {
181 next if defined($el->{snapshot
});
183 my $image = $el->{image
};
185 my ($owner) = $image =~ m/^(?:vm|base)-(\d+)-/;
186 next if !defined($owner);
188 $list->{$pool}->{$image} = {
191 parent
=> $get_parent_image_name->($el->{parent
}),
199 sub rbd_volume_info
{
200 my ($scfg, $storeid, $volname, $snap) = @_;
204 my @options = ('info', $volname, '--format', 'json');
206 push @options, '--snap', $snap;
209 $cmd = &$rbd_cmd($scfg, $storeid, @options);
212 my $parser = sub { $raw .= shift };
214 run_rbd_command
($cmd, errmsg
=> "rbd error", errfunc
=> sub {}, outfunc
=> $parser);
219 } elsif ($raw =~ m/^(\{.*\})$/s) { # untaint
220 $volume = JSON
::decode_json
($1);
222 die "got unexpected data from rbd info: '$raw'\n";
225 $volume->{parent
} = $get_parent_image_name->($volume->{parent
});
226 $volume->{protected
} = defined($volume->{protected
}) && $volume->{protected
} eq "true" ?
1 : undef;
228 return $volume->@{qw(size parent format protected features)};
239 content
=> [ {images
=> 1, rootdir
=> 1}, { images
=> 1 }],
246 description
=> "IP addresses of monitors (for external clusters).",
247 type
=> 'string', format
=> 'pve-storage-portal-dns-list',
250 description
=> "Pool.",
254 description
=> "RBD Id.",
258 description
=> "Authsupported.",
262 description
=> "Access rbd through krbd kernel module.",
270 nodes
=> { optional
=> 1 },
271 disable
=> { optional
=> 1 },
272 monhost
=> { optional
=> 1},
273 pool
=> { optional
=> 1 },
274 username
=> { optional
=> 1 },
275 content
=> { optional
=> 1 },
276 krbd
=> { optional
=> 1 },
277 bwlimit
=> { optional
=> 1 },
281 # Storage implementation
284 my ($class, $storeid, $scfg, %param) = @_;
286 return if defined($scfg->{monhost
}); # nothing to do if not pve managed ceph
288 PVE
::Storage
::CephTools
::ceph_create_keyfile
($scfg->{type
}, $storeid);
292 my ($class, $storeid, $scfg) = @_;
294 return if defined($scfg->{monhost
}); # nothing to do if not pve managed ceph
296 PVE
::Storage
::CephTools
::ceph_remove_keyfile
($scfg->{type
}, $storeid);
300 my ($class, $volname) = @_;
302 if ($volname =~ m/^((base-(\d+)-\S+)\/)?
((base
)?
(vm
)?
-(\d
+)-\S
+)$/) {
303 return ('images', $4, $7, $2, $3, $5, 'raw');
306 die "unable to parse rbd volume name '$volname'\n";
310 my ($class, $scfg, $volname, $storeid, $snapname) = @_;
312 my $cmd_option = PVE
::Storage
::CephTools
::ceph_connect_option
($scfg, $storeid);
313 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
314 $name .= '@'.$snapname if $snapname;
316 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
317 return ("/dev/rbd/$pool/$name", $vmid, $vtype) if $scfg->{krbd
};
319 my $path = "rbd:$pool/$name";
321 $path .= ":conf=$cmd_option->{ceph_conf}" if $cmd_option->{ceph_conf
};
322 if (defined($scfg->{monhost
})) {
323 my $monhost = PVE
::Storage
::CephTools
::hostlist
($scfg->{monhost
}, ';');
324 $monhost =~ s/:/\\:/g;
325 $path .= ":mon_host=$monhost";
326 $path .= ":auth_supported=$cmd_option->{auth_supported}";
329 $path .= ":id=$cmd_option->{userid}:keyring=$cmd_option->{keyring}" if ($cmd_option->{keyring
});
331 return ($path, $vmid, $vtype);
334 my $find_free_diskname = sub {
335 my ($storeid, $scfg, $vmid) = @_;
337 my $cmd = &$rbd_cmd($scfg, $storeid, 'ls');
342 if ($line = m/^(.*)$/) { # untaint
343 push @$disk_list, $1;
348 run_rbd_command
($cmd, errmsg
=> "rbd error", errfunc
=> sub {}, outfunc
=> $parser);
352 die $err if $err && $err !~ m/doesn't contain rbd images/;
354 return PVE
::Storage
::Plugin
::get_next_vm_diskname
($disk_list, $storeid, $vmid, undef, $scfg);
358 my ($class, $storeid, $scfg, $volname) = @_;
360 my $snap = '__base__';
362 my ($vtype, $name, $vmid, $basename, $basevmid, $isBase) =
363 $class->parse_volname($volname);
365 die "create_base not possible with base image\n" if $isBase;
367 my ($size, $parent, $format, undef) = rbd_volume_info
($scfg, $storeid, $name);
368 die "rbd volume info on '$name' failed\n" if !($size);
370 die "rbd image must be at format V2" if $format ne "2";
372 die "volname '$volname' contains wrong information about parent $parent $basename\n"
373 if $basename && (!$parent || $parent ne $basename."@".$snap);
376 $newname =~ s/^vm-/base-/;
378 my $newvolname = $basename ?
"$basename/$newname" : "$newname";
380 my $cmd = &$rbd_cmd($scfg, $storeid, 'rename', &$add_pool_to_disk($scfg, $name), &$add_pool_to_disk($scfg, $newname));
381 run_rbd_command
($cmd, errmsg
=> "rbd rename '$name' error");
383 my $running = undef; #fixme : is create_base always offline ?
385 $class->volume_snapshot($scfg, $storeid, $newname, $snap, $running);
387 my (undef, undef, undef, $protected) = rbd_volume_info
($scfg, $storeid, $newname, $snap);
390 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'protect', $newname, '--snap', $snap);
391 run_rbd_command
($cmd, errmsg
=> "rbd protect $newname snap '$snap' error");
399 my ($class, $scfg, $storeid, $volname, $vmid, $snapname) = @_;
401 my $snap = '__base__';
402 $snap = $snapname if length $snapname;
404 my ($vtype, $basename, $basevmid, undef, undef, $isBase) =
405 $class->parse_volname($volname);
407 die "$volname is not a base image and snapname is not provided\n"
408 if !$isBase && !length($snapname);
410 my $name = $find_free_diskname->($storeid, $scfg, $vmid);
412 warn "clone $volname: $basename snapname $snap to $name\n";
414 if (length($snapname)) {
415 my (undef, undef, undef, $protected) = rbd_volume_info
($scfg, $storeid, $volname, $snapname);
418 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'protect', $volname, '--snap', $snapname);
419 run_rbd_command
($cmd, errmsg
=> "rbd protect $volname snap $snapname error");
423 my $newvol = "$basename/$name";
424 $newvol = $name if length($snapname);
426 my $cmd = &$rbd_cmd($scfg, $storeid, 'clone', &$add_pool_to_disk($scfg, $basename),
427 '--snap', $snap, &$add_pool_to_disk($scfg, $name));
429 run_rbd_command
($cmd, errmsg
=> "rbd clone '$basename' error");
431 &$krbd_feature_disable($scfg, $storeid, $name);
437 my ($class, $storeid, $scfg, $vmid, $fmt, $name, $size) = @_;
440 die "illegal name '$name' - should be 'vm-$vmid-*'\n"
441 if $name && $name !~ m/^vm-$vmid-/;
443 $name = $find_free_diskname->($storeid, $scfg, $vmid) if !$name;
445 my $cmd = &$rbd_cmd($scfg, $storeid, 'create', '--image-format' , 2, '--size', int(($size+1023)/1024), $name);
446 run_rbd_command
($cmd, errmsg
=> "rbd create $name' error");
448 &$krbd_feature_disable($scfg, $storeid, $name);
454 my ($class, $storeid, $scfg, $volname, $isBase) = @_;
456 my ($vtype, $name, $vmid, undef, undef, undef) =
457 $class->parse_volname($volname);
460 my $snap = '__base__';
461 my (undef, undef, undef, $protected) = rbd_volume_info
($scfg, $storeid, $name, $snap);
463 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'unprotect', $name, '--snap', $snap);
464 run_rbd_command
($cmd, errmsg
=> "rbd unprotect $name snap '$snap' error");
468 $class->deactivate_volume($storeid, $scfg, $volname);
470 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'purge', $name);
471 run_rbd_command
($cmd, errmsg
=> "rbd snap purge '$volname' error");
473 $cmd = &$rbd_cmd($scfg, $storeid, 'rm', $name);
474 run_rbd_command
($cmd, errmsg
=> "rbd rm '$volname' error");
480 my ($class, $storeid, $scfg, $vmid, $vollist, $cache) = @_;
482 $cache->{rbd
} = rbd_ls
($scfg, $storeid) if !$cache->{rbd
};
483 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
487 if (my $dat = $cache->{rbd
}->{$pool}) {
488 foreach my $image (keys %$dat) {
490 my $info = $dat->{$image};
492 my $volname = $info->{name
};
493 my $parent = $info->{parent
};
494 my $owner = $info->{vmid
};
496 if ($parent && $parent =~ m/^(base-\d+-\S+)\@__base__$/) {
497 $info->{volid
} = "$storeid:$1/$volname";
499 $info->{volid
} = "$storeid:$volname";
503 my $found = grep { $_ eq $info->{volid
} } @$vollist;
506 next if defined ($vmid) && ($owner ne $vmid);
509 $info->{format
} = 'raw';
519 my ($class, $storeid, $scfg, $cache) = @_;
522 my $rados = &$librados_connect($scfg, $storeid);
523 my $df = $rados->mon_command({ prefix
=> 'df', format
=> 'json' });
525 my ($d) = grep { $_->{name
} eq $scfg->{pool
} } @{$df->{pools
}};
527 # max_avail -> max available space for data w/o replication in the pool
528 # bytes_used -> data w/o replication in the pool
529 my $free = $d->{stats
}->{max_avail
};
530 my $used = $d->{stats
}->{bytes_used
};
531 my $total = $used + $free;
534 return ($total, $free, $used, $active);
537 sub activate_storage
{
538 my ($class, $storeid, $scfg, $cache) = @_;
542 sub deactivate_storage
{
543 my ($class, $storeid, $scfg, $cache) = @_;
547 sub activate_volume
{
548 my ($class, $storeid, $scfg, $volname, $snapname, $cache) = @_;
550 return 1 if !$scfg->{krbd
};
552 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
553 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
555 my $path = "/dev/rbd/$pool/$name";
556 $path .= '@'.$snapname if $snapname;
559 $name .= '@'.$snapname if $snapname;
560 my $cmd = &$rbd_cmd($scfg, $storeid, 'map', $name);
561 run_rbd_command
($cmd, errmsg
=> "can't mount rbd volume $name");
566 sub deactivate_volume
{
567 my ($class, $storeid, $scfg, $volname, $snapname, $cache) = @_;
569 return 1 if !$scfg->{krbd
};
571 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
572 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
574 my $path = "/dev/rbd/$pool/$name";
575 $path .= '@'.$snapname if $snapname;
576 return if ! -b
$path;
578 my $cmd = &$rbd_cmd($scfg, $storeid, 'unmap', $path);
579 run_rbd_command
($cmd, errmsg
=> "can't unmap rbd volume $name");
584 sub volume_size_info
{
585 my ($class, $scfg, $storeid, $volname, $timeout) = @_;
587 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
588 my ($size, undef) = rbd_volume_info
($scfg, $storeid, $name);
593 my ($class, $scfg, $storeid, $volname, $size, $running) = @_;
595 return 1 if $running && !$scfg->{krbd
};
597 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
599 my $cmd = &$rbd_cmd($scfg, $storeid, 'resize', '--allow-shrink', '--size', ($size/1024/1024), $name);
600 run_rbd_command
($cmd, errmsg
=> "rbd resize '$volname' error");
604 sub volume_snapshot
{
605 my ($class, $scfg, $storeid, $volname, $snap) = @_;
607 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
609 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'create', '--snap', $snap, $name);
610 run_rbd_command
($cmd, errmsg
=> "rbd snapshot '$volname' error");
614 sub volume_snapshot_rollback
{
615 my ($class, $scfg, $storeid, $volname, $snap) = @_;
617 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
619 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'rollback', '--snap', $snap, $name);
620 run_rbd_command
($cmd, errmsg
=> "rbd snapshot $volname to '$snap' error");
623 sub volume_snapshot_delete
{
624 my ($class, $scfg, $storeid, $volname, $snap, $running) = @_;
626 return 1 if $running && !$scfg->{krbd
};
628 $class->deactivate_volume($storeid, $scfg, $volname, $snap, {});
630 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
632 my (undef, undef, undef, $protected) = rbd_volume_info
($scfg, $storeid, $name, $snap);
634 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'unprotect', $name, '--snap', $snap);
635 run_rbd_command
($cmd, errmsg
=> "rbd unprotect $name snap '$snap' error");
638 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'rm', '--snap', $snap, $name);
640 run_rbd_command
($cmd, errmsg
=> "rbd snapshot '$volname' error");
645 sub volume_has_feature
{
646 my ($class, $scfg, $feature, $storeid, $volname, $snapname, $running) = @_;
649 snapshot
=> { current
=> 1, snap
=> 1},
650 clone
=> { base
=> 1, snap
=> 1},
651 template
=> { current
=> 1},
652 copy
=> { base
=> 1, current
=> 1, snap
=> 1},
653 sparseinit
=> { base
=> 1, current
=> 1},
656 my ($vtype, $name, $vmid, $basename, $basevmid, $isBase) =
657 $class->parse_volname($volname);
663 $key = $isBase ?
'base' : 'current';
665 return 1 if $features->{$feature}->{$key};