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
};
26 my ($scfg, $volume) = @_;
27 my $path = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
28 $path .= "/$scfg->{namespace}" if defined($scfg->{namespace
});
29 $path .= "/$volume" if defined($volume);
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 if (defined(my $namespace = $scfg->{namespace
})) {
42 # some subcommands will fail if the --namespace parameter is present
43 my $no_namespace_parameter = {
46 push @$cmd, '--namespace', "$namespace" if !$no_namespace_parameter->{$op};
48 push @$cmd, '-c', $cmd_option->{ceph_conf
} if ($cmd_option->{ceph_conf
});
49 push @$cmd, '-m', $cmd_option->{mon_host
} if ($cmd_option->{mon_host
});
50 push @$cmd, '--auth_supported', $cmd_option->{auth_supported
} if ($cmd_option->{auth_supported
});
51 push @$cmd, '-n', "client.$cmd_option->{userid}" if ($cmd_option->{userid
});
52 push @$cmd, '--keyring', $cmd_option->{keyring
} if ($cmd_option->{keyring
});
56 push @$cmd, @options if scalar(@options);
62 my ($scfg, $storeid, $op, @options) = @_;
64 return $build_cmd->('/usr/bin/rbd', $scfg, $storeid, $op, @options);
68 my ($scfg, $storeid, $op, @options) = @_;
70 return $build_cmd->('/usr/bin/rados', $scfg, $storeid, $op, @options);
73 my $librados_connect = sub {
74 my ($scfg, $storeid, $options) = @_;
76 my $librados_config = PVE
::CephConfig
::ceph_connect_option
($scfg, $storeid);
78 my $rados = PVE
::RADOS-
>new(%$librados_config);
83 # needed for volumes created using ceph jewel (or higher)
84 my $krbd_feature_update = sub {
85 my ($scfg, $storeid, $name) = @_;
87 my (@disable, @enable);
88 my ($kmajor, $kminor) = PVE
::ProcFSTools
::kernel_version
();
90 if ($kmajor > 5 || $kmajor == 5 && $kminor >= 3) {
91 # 'deep-flatten' can only be disabled, not enabled after image creation
92 push @enable, 'fast-diff', 'object-map';
94 push @disable, 'fast-diff', 'object-map', 'deep-flatten';
98 push @enable, 'exclusive-lock';
100 push @disable, 'exclusive-lock';
103 my $active_features_list = (rbd_volume_info
($scfg, $storeid, $name))[4];
104 my $active_features = { map { $_ => 1 } @$active_features_list };
106 my $to_disable = join(',', grep { $active_features->{$_} } @disable);
107 my $to_enable = join(',', grep { !$active_features->{$_} } @enable );
110 print "disable RBD image features this kernel RBD drivers is not compatible with: $to_disable\n";
111 my $cmd = $rbd_cmd->($scfg, $storeid, 'feature', 'disable', $name, $to_disable);
114 errmsg
=> "could not disable krbd-incompatible image features '$to_disable' for rbd image: $name",
118 print "enable RBD image features this kernel RBD drivers supports: $to_enable\n";
120 my $cmd = $rbd_cmd->($scfg, $storeid, 'feature', 'enable', $name, $to_enable);
123 errmsg
=> "could not enable krbd-compatible image features '$to_enable' for rbd image: $name",
130 sub run_rbd_command
{
131 my ($cmd, %args) = @_;
134 my $errmsg = $args{errmsg
} . ": " || "";
135 if (!exists($args{errfunc
})) {
136 # ' error: 2014-02-06 11:51:59.839135 7f09f94d0760 -1 librbd: snap_unprotect: can't unprotect;
137 # at least 1 child(ren) in pool cephstor1
138 $args{errfunc
} = sub {
140 if ($line =~ m/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\.\d+ [0-9a-f]+ [\-\d]+ librbd: (.*)$/) {
145 print STDERR
$lasterr;
150 eval { run_command
($cmd, %args); };
152 die $errmsg . $lasterr if length($lasterr);
160 my ($scfg, $storeid) = @_;
162 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
163 $pool .= "/$scfg->{namespace}" if defined($scfg->{namespace
});
166 my $parser = sub { $raw .= shift };
168 my $cmd = $rbd_cmd->($scfg, $storeid, 'ls', '-l', '--format', 'json');
170 run_rbd_command
($cmd, errmsg
=> "rbd error", errfunc
=> sub {}, outfunc
=> $parser);
174 die $err if $err && $err !~ m/doesn't contain rbd images/ ;
179 } elsif ($raw =~ m/^(\[.*\])$/s) { # untaint
180 $result = JSON
::decode_json
($1);
182 die "got unexpected data from rbd ls: '$raw'\n";
187 foreach my $el (@$result) {
188 next if defined($el->{snapshot
});
190 my $image = $el->{image
};
192 my ($owner) = $image =~ m/^(?:vm|base)-(\d+)-/;
193 next if !defined($owner);
195 $list->{$pool}->{$image} = {
198 parent
=> $get_parent_image_name->($el->{parent
}),
207 my ($scfg, $storeid, $name) = @_;
209 my $cmd = $rbd_cmd->($scfg, $storeid, 'snap', 'ls', $name, '--format', 'json');
212 run_rbd_command
($cmd, errmsg
=> "rbd error", errfunc
=> sub {}, outfunc
=> sub { $raw .= shift; });
215 if ($raw =~ m/^(\[.*\])$/s) { # untaint
216 $list = eval { JSON
::decode_json
($1) };
217 die "invalid JSON output from 'rbd snap ls $name': $@\n" if $@;
219 die "got unexpected data from 'rbd snap ls $name': '$raw'\n";
222 $list = [] if !defined($list);
225 foreach my $el (@$list) {
226 my $snap = $el->{name
};
227 my $protected = defined($el->{protected
}) && $el->{protected
} eq "true" ?
1 : undef;
230 id
=> $el->{id
} // undef,
231 size
=> $el->{size
} // 0,
232 protected
=> $protected,
238 sub rbd_volume_info
{
239 my ($scfg, $storeid, $volname, $snap) = @_;
243 my @options = ('info', $volname, '--format', 'json');
245 push @options, '--snap', $snap;
248 $cmd = $rbd_cmd->($scfg, $storeid, @options);
251 my $parser = sub { $raw .= shift };
253 run_rbd_command
($cmd, errmsg
=> "rbd error", errfunc
=> sub {}, outfunc
=> $parser);
258 } elsif ($raw =~ m/^(\{.*\})$/s) { # untaint
259 $volume = JSON
::decode_json
($1);
261 die "got unexpected data from rbd info: '$raw'\n";
264 $volume->{parent
} = $get_parent_image_name->($volume->{parent
});
265 $volume->{protected
} = defined($volume->{protected
}) && $volume->{protected
} eq "true" ?
1 : undef;
267 return $volume->@{qw(size parent format protected features)};
278 content
=> [ {images
=> 1, rootdir
=> 1}, { images
=> 1 }],
285 description
=> "IP addresses of monitors (for external clusters).",
286 type
=> 'string', format
=> 'pve-storage-portal-dns-list',
289 description
=> "Pool.",
293 description
=> "RBD Namespace.",
297 description
=> "RBD Id.",
301 description
=> "Authsupported.",
305 description
=> "Always access rbd through krbd kernel module.",
309 description
=> "Client keyring contents (for external clusters).",
317 nodes
=> { optional
=> 1 },
318 disable
=> { optional
=> 1 },
319 monhost
=> { optional
=> 1},
320 pool
=> { optional
=> 1 },
321 namespace
=> { optional
=> 1 },
322 username
=> { optional
=> 1 },
323 content
=> { optional
=> 1 },
324 krbd
=> { optional
=> 1 },
325 keyring
=> { optional
=> 1 },
326 bwlimit
=> { optional
=> 1 },
330 # Storage implementation
333 my ($class, $storeid, $scfg, %param) = @_;
335 my $secret = $param{keyring
} if defined $param{keyring
} // undef;
336 PVE
::CephConfig
::ceph_create_keyfile
($scfg->{type
}, $storeid, $secret);
342 my ($class, $storeid, $scfg, %param) = @_;
344 if (exists($param{keyring
})) {
345 if (defined($param{keyring
})) {
346 PVE
::CephConfig
::ceph_create_keyfile
($scfg->{type
}, $storeid, $param{keyring
});
348 PVE
::CephConfig
::ceph_remove_keyfile
($scfg->{type
}, $storeid);
356 my ($class, $storeid, $scfg) = @_;
357 PVE
::CephConfig
::ceph_remove_keyfile
($scfg->{type
}, $storeid);
362 my ($class, $volname) = @_;
364 if ($volname =~ m/^((base-(\d+)-\S+)\/)?
((base
)?
(vm
)?
-(\d
+)-\S
+)$/) {
365 return ('images', $4, $7, $2, $3, $5, 'raw');
368 die "unable to parse rbd volume name '$volname'\n";
372 my ($class, $scfg, $volname, $storeid, $snapname) = @_;
374 my $cmd_option = PVE
::CephConfig
::ceph_connect_option
($scfg, $storeid);
375 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
376 $name .= '@'.$snapname if $snapname;
378 my $rbd_path = get_rbd_path
($scfg, $name);
379 return ("/dev/rbd/${rbd_path}", $vmid, $vtype) if $scfg->{krbd
};
381 my $path = "rbd:${rbd_path}";
383 $path .= ":conf=$cmd_option->{ceph_conf}" if $cmd_option->{ceph_conf
};
384 if (defined($scfg->{monhost
})) {
385 my $monhost = PVE
::CephConfig
::hostlist
($scfg->{monhost
}, ';');
386 $monhost =~ s/:/\\:/g;
387 $path .= ":mon_host=$monhost";
388 $path .= ":auth_supported=$cmd_option->{auth_supported}";
391 $path .= ":id=$cmd_option->{userid}:keyring=$cmd_option->{keyring}" if ($cmd_option->{keyring
});
393 return ($path, $vmid, $vtype);
396 sub find_free_diskname
{
397 my ($class, $storeid, $scfg, $vmid, $fmt, $add_fmt_suffix) = @_;
399 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->(
447 get_rbd_path
($scfg, $name),
448 get_rbd_path
($scfg, $newname),
450 run_rbd_command
($cmd, errmsg
=> "rbd rename '$name' error");
452 my $running = undef; #fixme : is create_base always offline ?
454 $class->volume_snapshot($scfg, $storeid, $newname, $snap, $running);
456 my (undef, undef, undef, $protected) = rbd_volume_info
($scfg, $storeid, $newname, $snap);
459 my $cmd = $rbd_cmd->($scfg, $storeid, 'snap', 'protect', $newname, '--snap', $snap);
460 run_rbd_command
($cmd, errmsg
=> "rbd protect $newname snap '$snap' error");
468 my ($class, $scfg, $storeid, $volname, $vmid, $snapname) = @_;
470 my $snap = '__base__';
471 $snap = $snapname if length $snapname;
473 my ($vtype, $basename, $basevmid, undef, undef, $isBase) =
474 $class->parse_volname($volname);
476 die "$volname is not a base image and snapname is not provided\n"
477 if !$isBase && !length($snapname);
479 my $name = $class->find_free_diskname($storeid, $scfg, $vmid);
481 warn "clone $volname: $basename snapname $snap to $name\n";
483 if (length($snapname)) {
484 my (undef, undef, undef, $protected) = rbd_volume_info
($scfg, $storeid, $volname, $snapname);
487 my $cmd = $rbd_cmd->($scfg, $storeid, 'snap', 'protect', $volname, '--snap', $snapname);
488 run_rbd_command
($cmd, errmsg
=> "rbd protect $volname snap $snapname error");
492 my $newvol = "$basename/$name";
493 $newvol = $name if length($snapname);
495 my $cmd = $rbd_cmd->(
499 get_rbd_path
($scfg, $basename),
502 get_rbd_path
($scfg, $name),
505 run_rbd_command
($cmd, errmsg
=> "rbd clone '$basename' error");
511 my ($class, $storeid, $scfg, $vmid, $fmt, $name, $size) = @_;
514 die "illegal name '$name' - should be 'vm-$vmid-*'\n"
515 if $name && $name !~ m/^vm-$vmid-/;
517 $name = $class->find_free_diskname($storeid, $scfg, $vmid) if !$name;
519 my $cmd = $rbd_cmd->($scfg, $storeid, 'create', '--image-format' , 2, '--size', int(($size+1023)/1024), $name);
520 run_rbd_command
($cmd, errmsg
=> "rbd create '$name' error");
526 my ($class, $storeid, $scfg, $volname, $isBase) = @_;
528 my ($vtype, $name, $vmid, undef, undef, undef) =
529 $class->parse_volname($volname);
532 my $snaps = rbd_ls_snap
($scfg, $storeid, $name);
533 foreach my $snap (keys %$snaps) {
534 if ($snaps->{$snap}->{protected
}) {
535 my $cmd = $rbd_cmd->($scfg, $storeid, 'snap', 'unprotect', $name, '--snap', $snap);
536 run_rbd_command
($cmd, errmsg
=> "rbd unprotect $name snap '$snap' error");
540 $class->deactivate_volume($storeid, $scfg, $volname);
542 my $cmd = $rbd_cmd->($scfg, $storeid, 'snap', 'purge', $name);
543 run_rbd_command
($cmd, errmsg
=> "rbd snap purge '$name' error");
545 $cmd = $rbd_cmd->($scfg, $storeid, 'rm', $name);
546 run_rbd_command
($cmd, errmsg
=> "rbd rm '$name' error");
552 my ($class, $storeid, $scfg, $vmid, $vollist, $cache) = @_;
554 $cache->{rbd
} = rbd_ls
($scfg, $storeid) if !$cache->{rbd
};
556 my $dat = $cache->{rbd
}->{get_rbd_path
($scfg)};
557 return [] if !$dat; # nothing found
560 for my $image (sort keys %$dat) {
561 my $info = $dat->{$image};
562 my ($volname, $parent, $owner) = $info->@{'name', 'parent', 'vmid'};
564 if ($parent && $parent =~ m/^(base-\d+-\S+)\@__base__$/) {
565 $info->{volid
} = "$storeid:$1/$volname";
567 $info->{volid
} = "$storeid:$volname";
571 my $found = grep { $_ eq $info->{volid
} } @$vollist;
574 next if defined ($vmid) && ($owner ne $vmid);
577 $info->{format
} = 'raw';
586 my ($class, $storeid, $scfg, $cache) = @_;
588 my $rados = $librados_connect->($scfg, $storeid);
589 my $df = $rados->mon_command({ prefix
=> 'df', format
=> 'json' });
591 my ($d) = grep { $_->{name
} eq $scfg->{pool
} } @{$df->{pools
}};
593 # max_avail -> max available space for data w/o replication in the pool
594 # bytes_used -> data w/o replication in the pool
595 my $free = $d->{stats
}->{max_avail
};
596 my $used = $d->{stats
}->{stored
} // $d->{stats
}->{bytes_used
};
597 my $total = $used + $free;
600 return ($total, $free, $used, $active);
603 sub activate_storage
{
604 my ($class, $storeid, $scfg, $cache) = @_;
608 sub deactivate_storage
{
609 my ($class, $storeid, $scfg, $cache) = @_;
613 my sub get_kernel_device_path
{
614 my ($scfg, $name) = @_;
615 return "/dev/rbd/" . get_rbd_path
($scfg, $name);
619 my ($class, $storeid, $scfg, $volname, $snapname) = @_;
621 my ($vtype, $img_name, $vmid) = $class->parse_volname($volname);
623 my $name = $img_name;
624 $name .= '@'.$snapname if $snapname;
626 my $kerneldev = get_kernel_device_path
($scfg, $name);
628 return $kerneldev if -b
$kerneldev; # already mapped
630 # features can only be enabled/disabled for image, not for snapshot!
631 $krbd_feature_update->($scfg, $storeid, $img_name);
633 my $cmd = $rbd_cmd->($scfg, $storeid, 'map', $name);
634 run_rbd_command
($cmd, errmsg
=> "can't map rbd volume $name");
640 my ($class, $storeid, $scfg, $volname, $snapname) = @_;
642 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
643 $name .= '@'.$snapname if $snapname;
645 my $kerneldev = get_kernel_device_path
($scfg, $name);
648 my $cmd = $rbd_cmd->($scfg, $storeid, 'unmap', $kerneldev);
649 run_rbd_command
($cmd, errmsg
=> "can't unmap rbd device $kerneldev");
655 sub activate_volume
{
656 my ($class, $storeid, $scfg, $volname, $snapname, $cache) = @_;
658 $class->map_volume($storeid, $scfg, $volname, $snapname) if $scfg->{krbd
};
663 sub deactivate_volume
{
664 my ($class, $storeid, $scfg, $volname, $snapname, $cache) = @_;
666 $class->unmap_volume($storeid, $scfg, $volname, $snapname);
671 sub volume_size_info
{
672 my ($class, $scfg, $storeid, $volname, $timeout) = @_;
674 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
675 my ($size, undef) = rbd_volume_info
($scfg, $storeid, $name);
680 my ($class, $scfg, $storeid, $volname, $size, $running) = @_;
682 return 1 if $running && !$scfg->{krbd
}; # FIXME???
684 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
686 my $cmd = $rbd_cmd->($scfg, $storeid, 'resize', '--allow-shrink', '--size', ($size/1024/1024), $name);
687 run_rbd_command
($cmd, errmsg
=> "rbd resize '$volname' error");
691 sub volume_snapshot
{
692 my ($class, $scfg, $storeid, $volname, $snap) = @_;
694 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
696 my $cmd = $rbd_cmd->($scfg, $storeid, 'snap', 'create', '--snap', $snap, $name);
697 run_rbd_command
($cmd, errmsg
=> "rbd snapshot '$volname' error");
701 sub volume_snapshot_rollback
{
702 my ($class, $scfg, $storeid, $volname, $snap) = @_;
704 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
706 my $cmd = $rbd_cmd->($scfg, $storeid, 'snap', 'rollback', '--snap', $snap, $name);
707 run_rbd_command
($cmd, errmsg
=> "rbd snapshot $volname to '$snap' error");
710 sub volume_snapshot_delete
{
711 my ($class, $scfg, $storeid, $volname, $snap, $running) = @_;
713 return 1 if $running && !$scfg->{krbd
}; # FIXME: ????
715 $class->deactivate_volume($storeid, $scfg, $volname, $snap, {});
717 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
719 my (undef, undef, undef, $protected) = rbd_volume_info
($scfg, $storeid, $name, $snap);
721 my $cmd = $rbd_cmd->($scfg, $storeid, 'snap', 'unprotect', $name, '--snap', $snap);
722 run_rbd_command
($cmd, errmsg
=> "rbd unprotect $name snap '$snap' error");
725 my $cmd = $rbd_cmd->($scfg, $storeid, 'snap', 'rm', '--snap', $snap, $name);
727 run_rbd_command
($cmd, errmsg
=> "rbd snapshot '$volname' error");
732 sub volume_snapshot_needs_fsfreeze
{
736 sub volume_has_feature
{
737 my ($class, $scfg, $feature, $storeid, $volname, $snapname, $running) = @_;
740 snapshot
=> { current
=> 1, snap
=> 1},
741 clone
=> { base
=> 1, snap
=> 1},
742 template
=> { current
=> 1},
743 copy
=> { base
=> 1, current
=> 1, snap
=> 1},
744 sparseinit
=> { base
=> 1, current
=> 1},
745 rename => {current
=> 1},
748 my ($vtype, $name, $vmid, $basename, $basevmid, $isBase) = $class->parse_volname($volname);
754 $key = $isBase ?
'base' : 'current';
756 return 1 if $features->{$feature}->{$key};
762 my ($class, $scfg, $storeid, $source_volname, $target_vmid, $target_volname) = @_;
772 ) = $class->parse_volname($source_volname);
773 $target_volname = $class->find_free_diskname($storeid, $scfg, $target_vmid, $format)
777 my $cmd = $rbd_cmd->($scfg, $storeid, 'info', $target_volname);
778 run_rbd_command
($cmd, errmsg
=> "exist check", quiet
=> 1);
780 die "target volume '${target_volname}' already exists\n" if !$@;
782 my $cmd = $rbd_cmd->($scfg, $storeid, 'rename', $source_image, $target_volname);
786 errmsg
=> "could not rename image '${source_image}' to '${target_volname}'",
789 $base_name = $base_name ?
"${base_name}/" : '';
791 return "${storeid}:${base_name}${target_volname}";