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 (@disable, @enable);
81 my ($kmajor, $kminor) = PVE
::ProcFSTools
::kernel_version
();
83 if ($kmajor > 5 || $kmajor == 5 && $kminor >= 3) {
84 # 'deep-flatten' can only be disabled, not enabled after image creation
85 push @enable, 'fast-diff', 'object-map';
87 push @disable, 'fast-diff', 'object-map', 'deep-flatten';
91 push @enable, 'exclusive-lock';
93 push @disable, 'exclusive-lock';
96 my $active_features_list = (rbd_volume_info
($scfg, $storeid, $name))[4];
97 my $active_features = { map { $_ => 1 } @$active_features_list };
99 my $to_disable = join(',', grep { $active_features->{$_} } @disable);
100 my $to_enable = join(',', grep { !$active_features->{$_} } @enable );
103 print "disable RBD image features this kernel RBD drivers is not compatible with: $to_disable\n";
104 my $cmd = $rbd_cmd->($scfg, $storeid, 'feature', 'disable', $name, $to_disable);
107 errmsg
=> "could not disable krbd-incompatible image features '$to_disable' for rbd image: $name",
111 print "enable RBD image features this kernel RBD drivers supports: $to_enable\n";
113 my $cmd = $rbd_cmd->($scfg, $storeid, 'feature', 'enable', $name, $to_enable);
116 errmsg
=> "could not enable krbd-compatible image features '$to_enable' for rbd image: $name",
123 sub run_rbd_command
{
124 my ($cmd, %args) = @_;
127 my $errmsg = $args{errmsg
} . ": " || "";
128 if (!exists($args{errfunc
})) {
129 # ' error: 2014-02-06 11:51:59.839135 7f09f94d0760 -1 librbd: snap_unprotect: can't unprotect;
130 # at least 1 child(ren) in pool cephstor1
131 $args{errfunc
} = sub {
133 if ($line =~ m/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\.\d+ [0-9a-f]+ [\-\d]+ librbd: (.*)$/) {
138 print STDERR
$lasterr;
143 eval { run_command
($cmd, %args); };
145 die $errmsg . $lasterr if length($lasterr);
153 my ($scfg, $storeid) = @_;
155 my $cmd = &$rbd_cmd($scfg, $storeid, 'ls', '-l', '--format', 'json');
156 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
159 my $parser = sub { $raw .= shift };
162 run_rbd_command
($cmd, errmsg
=> "rbd error", errfunc
=> sub {}, outfunc
=> $parser);
166 die $err if $err && $err !~ m/doesn't contain rbd images/ ;
171 } elsif ($raw =~ m/^(\[.*\])$/s) { # untaint
172 $result = JSON
::decode_json
($1);
174 die "got unexpected data from rbd ls: '$raw'\n";
179 foreach my $el (@$result) {
180 next if defined($el->{snapshot
});
182 my $image = $el->{image
};
184 my ($owner) = $image =~ m/^(?:vm|base)-(\d+)-/;
185 next if !defined($owner);
187 $list->{$pool}->{$image} = {
190 parent
=> $get_parent_image_name->($el->{parent
}),
199 my ($scfg, $storeid, $name) = @_;
201 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'ls', $name, '--format', 'json');
204 run_rbd_command
($cmd, errmsg
=> "rbd error", errfunc
=> sub {}, outfunc
=> sub { $raw .= shift; });
207 if ($raw =~ m/^(\[.*\])$/s) { # untaint
208 $list = eval { JSON
::decode_json
($1) };
209 die "invalid JSON output from 'rbd snap ls $name': $@\n" if $@;
211 die "got unexpected data from 'rbd snap ls $name': '$raw'\n";
214 $list = [] if !defined($list);
217 foreach my $el (@$list) {
218 my $snap = $el->{name
};
219 my $protected = defined($el->{protected
}) && $el->{protected
} eq "true" ?
1 : undef;
222 id
=> $el->{id
} // undef,
223 size
=> $el->{size
} // 0,
224 protected
=> $protected,
230 sub rbd_volume_info
{
231 my ($scfg, $storeid, $volname, $snap) = @_;
235 my @options = ('info', $volname, '--format', 'json');
237 push @options, '--snap', $snap;
240 $cmd = &$rbd_cmd($scfg, $storeid, @options);
243 my $parser = sub { $raw .= shift };
245 run_rbd_command
($cmd, errmsg
=> "rbd error", errfunc
=> sub {}, outfunc
=> $parser);
250 } elsif ($raw =~ m/^(\{.*\})$/s) { # untaint
251 $volume = JSON
::decode_json
($1);
253 die "got unexpected data from rbd info: '$raw'\n";
256 $volume->{parent
} = $get_parent_image_name->($volume->{parent
});
257 $volume->{protected
} = defined($volume->{protected
}) && $volume->{protected
} eq "true" ?
1 : undef;
259 return $volume->@{qw(size parent format protected features)};
270 content
=> [ {images
=> 1, rootdir
=> 1}, { images
=> 1 }],
277 description
=> "IP addresses of monitors (for external clusters).",
278 type
=> 'string', format
=> 'pve-storage-portal-dns-list',
281 description
=> "Pool.",
285 description
=> "RBD Id.",
289 description
=> "Authsupported.",
293 description
=> "Always access rbd through krbd kernel module.",
301 nodes
=> { optional
=> 1 },
302 disable
=> { optional
=> 1 },
303 monhost
=> { optional
=> 1},
304 pool
=> { optional
=> 1 },
305 username
=> { optional
=> 1 },
306 content
=> { optional
=> 1 },
307 krbd
=> { optional
=> 1 },
308 bwlimit
=> { optional
=> 1 },
312 # Storage implementation
315 my ($class, $storeid, $scfg, %param) = @_;
317 return if defined($scfg->{monhost
}); # nothing to do if not pve managed ceph
319 PVE
::CephConfig
::ceph_create_keyfile
($scfg->{type
}, $storeid);
325 my ($class, $storeid, $scfg) = @_;
327 return if defined($scfg->{monhost
}); # nothing to do if not pve managed ceph
329 PVE
::CephConfig
::ceph_remove_keyfile
($scfg->{type
}, $storeid);
335 my ($class, $volname) = @_;
337 if ($volname =~ m/^((base-(\d+)-\S+)\/)?
((base
)?
(vm
)?
-(\d
+)-\S
+)$/) {
338 return ('images', $4, $7, $2, $3, $5, 'raw');
341 die "unable to parse rbd volume name '$volname'\n";
345 my ($class, $scfg, $volname, $storeid, $snapname) = @_;
347 my $cmd_option = PVE
::CephConfig
::ceph_connect_option
($scfg, $storeid);
348 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
349 $name .= '@'.$snapname if $snapname;
351 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
352 return ("/dev/rbd/$pool/$name", $vmid, $vtype) if $scfg->{krbd
};
354 my $path = "rbd:$pool/$name";
356 $path .= ":conf=$cmd_option->{ceph_conf}" if $cmd_option->{ceph_conf
};
357 if (defined($scfg->{monhost
})) {
358 my $monhost = PVE
::CephConfig
::hostlist
($scfg->{monhost
}, ';');
359 $monhost =~ s/:/\\:/g;
360 $path .= ":mon_host=$monhost";
361 $path .= ":auth_supported=$cmd_option->{auth_supported}";
364 $path .= ":id=$cmd_option->{userid}:keyring=$cmd_option->{keyring}" if ($cmd_option->{keyring
});
366 return ($path, $vmid, $vtype);
369 sub find_free_diskname
{
370 my ($class, $storeid, $scfg, $vmid, $fmt, $add_fmt_suffix) = @_;
372 my $cmd = &$rbd_cmd($scfg, $storeid, 'ls');
377 if ($line =~ m/^(.*)$/) { # untaint
378 push @$disk_list, $1;
383 run_rbd_command
($cmd, errmsg
=> "rbd error", errfunc
=> sub {}, outfunc
=> $parser);
387 die $err if $err && $err !~ m/doesn't contain rbd images/;
389 return PVE
::Storage
::Plugin
::get_next_vm_diskname
($disk_list, $storeid, $vmid, undef, $scfg);
393 my ($class, $storeid, $scfg, $volname) = @_;
395 my $snap = '__base__';
397 my ($vtype, $name, $vmid, $basename, $basevmid, $isBase) =
398 $class->parse_volname($volname);
400 die "create_base not possible with base image\n" if $isBase;
402 my ($size, $parent, $format, undef) = rbd_volume_info
($scfg, $storeid, $name);
403 die "rbd volume info on '$name' failed\n" if !($size);
405 die "rbd image must be at format V2" if $format ne "2";
407 die "volname '$volname' contains wrong information about parent $parent $basename\n"
408 if $basename && (!$parent || $parent ne $basename."@".$snap);
411 $newname =~ s/^vm-/base-/;
413 my $newvolname = $basename ?
"$basename/$newname" : "$newname";
415 my $cmd = &$rbd_cmd($scfg, $storeid, 'rename', &$add_pool_to_disk($scfg, $name), &$add_pool_to_disk($scfg, $newname));
416 run_rbd_command
($cmd, errmsg
=> "rbd rename '$name' error");
418 my $running = undef; #fixme : is create_base always offline ?
420 $class->volume_snapshot($scfg, $storeid, $newname, $snap, $running);
422 my (undef, undef, undef, $protected) = rbd_volume_info
($scfg, $storeid, $newname, $snap);
425 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'protect', $newname, '--snap', $snap);
426 run_rbd_command
($cmd, errmsg
=> "rbd protect $newname snap '$snap' error");
434 my ($class, $scfg, $storeid, $volname, $vmid, $snapname) = @_;
436 my $snap = '__base__';
437 $snap = $snapname if length $snapname;
439 my ($vtype, $basename, $basevmid, undef, undef, $isBase) =
440 $class->parse_volname($volname);
442 die "$volname is not a base image and snapname is not provided\n"
443 if !$isBase && !length($snapname);
445 my $name = $class->find_free_diskname($storeid, $scfg, $vmid);
447 warn "clone $volname: $basename snapname $snap to $name\n";
449 if (length($snapname)) {
450 my (undef, undef, undef, $protected) = rbd_volume_info
($scfg, $storeid, $volname, $snapname);
453 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'protect', $volname, '--snap', $snapname);
454 run_rbd_command
($cmd, errmsg
=> "rbd protect $volname snap $snapname error");
458 my $newvol = "$basename/$name";
459 $newvol = $name if length($snapname);
461 my $cmd = &$rbd_cmd($scfg, $storeid, 'clone', &$add_pool_to_disk($scfg, $basename),
462 '--snap', $snap, &$add_pool_to_disk($scfg, $name));
464 run_rbd_command
($cmd, errmsg
=> "rbd clone '$basename' error");
470 my ($class, $storeid, $scfg, $vmid, $fmt, $name, $size) = @_;
473 die "illegal name '$name' - should be 'vm-$vmid-*'\n"
474 if $name && $name !~ m/^vm-$vmid-/;
476 $name = $class->find_free_diskname($storeid, $scfg, $vmid) if !$name;
478 my $cmd = &$rbd_cmd($scfg, $storeid, 'create', '--image-format' , 2, '--size', int(($size+1023)/1024), $name);
479 run_rbd_command
($cmd, errmsg
=> "rbd create $name' error");
485 my ($class, $storeid, $scfg, $volname, $isBase) = @_;
487 my ($vtype, $name, $vmid, undef, undef, undef) =
488 $class->parse_volname($volname);
490 my $snaps = rbd_ls_snap
($scfg, $storeid, $name);
491 foreach my $snap (keys %$snaps) {
492 if ($snaps->{$snap}->{protected
}) {
493 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'unprotect', $name, '--snap', $snap);
494 run_rbd_command
($cmd, errmsg
=> "rbd unprotect $name snap '$snap' error");
498 $class->deactivate_volume($storeid, $scfg, $volname);
500 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'purge', $name);
501 run_rbd_command
($cmd, errmsg
=> "rbd snap purge '$volname' error");
503 $cmd = &$rbd_cmd($scfg, $storeid, 'rm', $name);
504 run_rbd_command
($cmd, errmsg
=> "rbd rm '$volname' error");
510 my ($class, $storeid, $scfg, $vmid, $vollist, $cache) = @_;
512 $cache->{rbd
} = rbd_ls
($scfg, $storeid) if !$cache->{rbd
};
513 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
517 if (my $dat = $cache->{rbd
}->{$pool}) {
518 foreach my $image (keys %$dat) {
520 my $info = $dat->{$image};
522 my $volname = $info->{name
};
523 my $parent = $info->{parent
};
524 my $owner = $info->{vmid
};
526 if ($parent && $parent =~ m/^(base-\d+-\S+)\@__base__$/) {
527 $info->{volid
} = "$storeid:$1/$volname";
529 $info->{volid
} = "$storeid:$volname";
533 my $found = grep { $_ eq $info->{volid
} } @$vollist;
536 next if defined ($vmid) && ($owner ne $vmid);
539 $info->{format
} = 'raw';
549 my ($class, $storeid, $scfg, $cache) = @_;
552 my $rados = &$librados_connect($scfg, $storeid);
553 my $df = $rados->mon_command({ prefix
=> 'df', format
=> 'json' });
555 my ($d) = grep { $_->{name
} eq $scfg->{pool
} } @{$df->{pools
}};
557 # max_avail -> max available space for data w/o replication in the pool
558 # bytes_used -> data w/o replication in the pool
559 my $free = $d->{stats
}->{max_avail
};
560 my $used = $d->{stats
}->{stored
} // $d->{stats
}->{bytes_used
};
561 my $total = $used + $free;
564 return ($total, $free, $used, $active);
567 sub activate_storage
{
568 my ($class, $storeid, $scfg, $cache) = @_;
572 sub deactivate_storage
{
573 my ($class, $storeid, $scfg, $cache) = @_;
577 my $get_kernel_device_name = sub {
578 my ($pool, $name) = @_;
580 return "/dev/rbd/$pool/$name";
584 my ($class, $storeid, $scfg, $volname, $snapname) = @_;
586 my ($vtype, $img_name, $vmid) = $class->parse_volname($volname);
588 my $name = $img_name;
589 $name .= '@'.$snapname if $snapname;
591 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
593 my $kerneldev = $get_kernel_device_name->($pool, $name);
595 return $kerneldev if -b
$kerneldev; # already mapped
597 # features can only be enabled/disabled for image, not for snapshot!
598 $krbd_feature_update->($scfg, $storeid, $img_name);
600 my $cmd = &$rbd_cmd($scfg, $storeid, 'map', $name);
601 run_rbd_command
($cmd, errmsg
=> "can't map rbd volume $name");
607 my ($class, $storeid, $scfg, $volname, $snapname) = @_;
609 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
610 $name .= '@'.$snapname if $snapname;
612 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
614 my $kerneldev = $get_kernel_device_name->($pool, $name);
617 my $cmd = &$rbd_cmd($scfg, $storeid, 'unmap', $kerneldev);
618 run_rbd_command
($cmd, errmsg
=> "can't unmap rbd device $kerneldev");
624 sub activate_volume
{
625 my ($class, $storeid, $scfg, $volname, $snapname, $cache) = @_;
627 $class->map_volume($storeid, $scfg, $volname, $snapname) if $scfg->{krbd
};
632 sub deactivate_volume
{
633 my ($class, $storeid, $scfg, $volname, $snapname, $cache) = @_;
635 $class->unmap_volume($storeid, $scfg, $volname, $snapname);
640 sub volume_size_info
{
641 my ($class, $scfg, $storeid, $volname, $timeout) = @_;
643 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
644 my ($size, undef) = rbd_volume_info
($scfg, $storeid, $name);
649 my ($class, $scfg, $storeid, $volname, $size, $running) = @_;
651 return 1 if $running && !$scfg->{krbd
}; # FIXME???
653 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
655 my $cmd = &$rbd_cmd($scfg, $storeid, 'resize', '--allow-shrink', '--size', ($size/1024/1024), $name);
656 run_rbd_command
($cmd, errmsg
=> "rbd resize '$volname' error");
660 sub volume_snapshot
{
661 my ($class, $scfg, $storeid, $volname, $snap) = @_;
663 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
665 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'create', '--snap', $snap, $name);
666 run_rbd_command
($cmd, errmsg
=> "rbd snapshot '$volname' error");
670 sub volume_snapshot_rollback
{
671 my ($class, $scfg, $storeid, $volname, $snap) = @_;
673 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
675 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'rollback', '--snap', $snap, $name);
676 run_rbd_command
($cmd, errmsg
=> "rbd snapshot $volname to '$snap' error");
679 sub volume_snapshot_delete
{
680 my ($class, $scfg, $storeid, $volname, $snap, $running) = @_;
682 return 1 if $running && !$scfg->{krbd
}; # FIXME: ????
684 $class->deactivate_volume($storeid, $scfg, $volname, $snap, {});
686 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
688 my (undef, undef, undef, $protected) = rbd_volume_info
($scfg, $storeid, $name, $snap);
690 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'unprotect', $name, '--snap', $snap);
691 run_rbd_command
($cmd, errmsg
=> "rbd unprotect $name snap '$snap' error");
694 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'rm', '--snap', $snap, $name);
696 run_rbd_command
($cmd, errmsg
=> "rbd snapshot '$volname' error");
701 sub volume_snapshot_needs_fsfreeze
{
706 sub volume_has_feature
{
707 my ($class, $scfg, $feature, $storeid, $volname, $snapname, $running) = @_;
710 snapshot
=> { current
=> 1, snap
=> 1},
711 clone
=> { base
=> 1, snap
=> 1},
712 template
=> { current
=> 1},
713 copy
=> { base
=> 1, current
=> 1, snap
=> 1},
714 sparseinit
=> { base
=> 1, current
=> 1},
717 my ($vtype, $name, $vmid, $basename, $basevmid, $isBase) =
718 $class->parse_volname($volname);
724 $key = $isBase ?
'base' : 'current';
726 return 1 if $features->{$feature}->{$key};