PVE/Storage/RBDPlugin.pm

   1 package PVE::Storage::RBDPlugin;
   2
   3 use strict;
   4 use warnings;
   5 use IO::File;
   6 use PVE::Tools qw(run_command trim);
   7 use PVE::Storage::Plugin;
   8 use PVE::JSONSchema qw(get_standard_option);
   9
  10 use base qw(PVE::Storage::Plugin);
  11
  12 sub rbd_unittobytes {
  13   {
  14        "M"  => 1024*1024,
  15        "G"  => 1024*1024*1024,
  16        "T"  => 1024*1024*1024*1024,
  17   }
  18 }
  19
  20 my $add_pool_to_disk = sub {
  21     my ($scfg, $disk) = @_;
  22
  23     my $pool =  $scfg->{pool} ? $scfg->{pool} : 'rbd';
  24
  25     return "$pool/$disk";
  26 };
  27
  28 my $rbd_cmd = sub {
  29     my ($scfg, $storeid, $op, @options) = @_;
  30
  31     my $monhost = $scfg->{monhost};
  32     $monhost =~ s/;/,/g;
  33
  34     my $keyring = "/etc/pve/priv/ceph/${storeid}.keyring";
  35     my $pool =  $scfg->{pool} ? $scfg->{pool} : 'rbd';
  36     my $username =  $scfg->{username} ? $scfg->{username} : 'admin';
  37
  38     my $cmd = ['/usr/bin/rbd', '-p', $pool, '-m', $monhost];
  39
  40     if(-e $keyring){
  41         push @$cmd, '-n', "client.$username";
  42         push @$cmd, '--keyring', $keyring;
  43         push @$cmd, '--auth_supported', 'cephx';
  44     }else{
  45         push @$cmd, '--auth_supported', 'none';
  46     }
  47
  48     push @$cmd, $op;
  49
  50     push @$cmd, @options if scalar(@options);
  51
  52     return $cmd;
  53 };
  54
  55 my $rados_cmd = sub {
  56     my ($scfg, $storeid, $op, @options) = @_;
  57
  58     my $monhost = $scfg->{monhost};
  59     $monhost =~ s/;/,/g;
  60
  61     my $keyring = "/etc/pve/priv/ceph/${storeid}.keyring";
  62     my $pool =  $scfg->{pool} ? $scfg->{pool} : 'rbd';
  63     my $username =  $scfg->{username} ? $scfg->{username} : 'admin';
  64
  65     my $cmd = ['/usr/bin/rados', '-p', $pool, '-m', $monhost];
  66
  67     if(-e $keyring){
  68         push @$cmd, '-n', "client.$username";
  69         push @$cmd, '--keyring', $keyring;
  70         push @$cmd, '--auth_supported', 'cephx';
  71     }else{
  72         push @$cmd, '--auth_supported', 'none';
  73     }
  74
  75     push @$cmd, $op;
  76
  77     push @$cmd, @options if scalar(@options);
  78
  79     return $cmd;
  80 };
  81
  82 my $ceph_version_parser = sub {
  83         my $line = shift;
  84         if ($line =~ m/^ceph version ((\d+)\.(\d+)\.(\d+))(?: \([a-fA-F0-9]+\))?$/) {
  85             return ($2, $3, $4, $1);
  86         } else {
  87             warn "Could not parse Ceph version: '$line'\n";
  88         }
  89 };
  90
  91 sub ceph_version {
  92     my ($cache) = @_;
  93
  94     my $version_string = $cache;
  95
  96     my $major;
  97     my $minor;
  98     my $bugfix;
  99
 100     if (defined($version_string)) {
 101         ($major, $minor, $bugfix, $version_string) = &$version_parser($version_string);
 102     } else {
 103         run_command('ceph version', outfunc => sub {
 104             my $line = shift;
 105             ($major, $minor, $bugfix, $version_string) = &$version_parser($line);
 106         });
 107     }
 108     return undef if !defined($version_string);
 109     return wantarray ? ($major, $minor, $bugfix, $version_string) : $version_string;
 110 }
 111
 112 sub run_rbd_command {
 113     my ($cmd, %args) = @_;
 114
 115     my $lasterr;
 116     my $errmsg = $args{errmsg} . ": " || "";
 117     if (!exists($args{errfunc})) {
 118         # ' error: 2014-02-06 11:51:59.839135 7f09f94d0760 -1 librbd: snap_unprotect: can't unprotect;
 119         # at least 1 child(ren) in pool cephstor1
 120         $args{errfunc} = sub {
 121             my $line = shift;
 122             if ($line =~ m/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\.\d+ [0-9a-f]+ [\-\d]+ librbd: (.*)$/) {
 123                 $lasterr = "$1\n";
 124             } else {
 125                 $lasterr = $line;
 126             }
 127             print STDERR $lasterr;
 128             *STDERR->flush();
 129         };
 130     }
 131
 132     eval { run_command($cmd, %args); };
 133     if (my $err = $@) {
 134         die $errmsg . $lasterr if length($lasterr);
 135         die $err;
 136     }
 137
 138     return undef;
 139 }
 140
 141 sub rbd_ls {
 142     my ($scfg, $storeid) = @_;
 143
 144     my $cmd = &$rbd_cmd($scfg, $storeid, 'ls', '-l');
 145     my $pool =  $scfg->{pool} ? $scfg->{pool} : 'rbd';
 146
 147     my $list = {};
 148
 149     my $parser = sub {
 150         my $line = shift;
 151
 152         if ($line =~  m/^((vm|base)-(\d+)-disk-\d+)\s+(\d+)(M|G|T)\s((\S+)\/((vm|base)-\d+-\S+@\S+))?/) {
 153             my ($image, $owner, $size, $unit, $parent) = ($1, $3, $4, $5, $8);
 154
 155             $list->{$pool}->{$image} = {
 156                 name => $image,
 157                 size => $size*rbd_unittobytes()->{$unit},
 158                 parent => $parent,
 159                 vmid => $owner
 160             };
 161         }
 162     };
 163
 164     eval {
 165         run_rbd_command($cmd, errmsg => "rbd error", errfunc => sub {}, outfunc => $parser);
 166     };
 167     my $err = $@;
 168
 169     die $err if $err && $err !~ m/doesn't contain rbd images/ ;
 170
 171     return $list;
 172 }
 173
 174 sub rbd_volume_info {
 175     my ($scfg, $storeid, $volname, $snap) = @_;
 176
 177     my $cmd = undef;
 178
 179     if($snap){
 180        $cmd = &$rbd_cmd($scfg, $storeid, 'info', $volname, '--snap', $snap);
 181     }else{
 182        $cmd = &$rbd_cmd($scfg, $storeid, 'info', $volname);
 183     }
 184
 185     my $size = undef;
 186     my $parent = undef;
 187     my $format = undef;
 188     my $protected = undef;
 189
 190     my $parser = sub {
 191         my $line = shift;
 192
 193         if ($line =~ m/size (\d+) (M|G|T)B in (\d+) objects/) {
 194             $size = $1 * rbd_unittobytes()->{$2} if ($1);
 195         } elsif ($line =~ m/parent:\s(\S+)\/(\S+)/) {
 196             $parent = $2;
 197         } elsif ($line =~ m/format:\s(\d+)/) {
 198             $format = $1;
 199         } elsif ($line =~ m/protected:\s(\S+)/) {
 200             $protected = 1 if $1 eq "True";
 201         }
 202
 203     };
 204
 205     run_rbd_command($cmd, errmsg => "rbd error", errfunc => sub {}, outfunc => $parser);
 206
 207     return ($size, $parent, $format, $protected);
 208 }
 209
 210 # Configuration
 211
 212 PVE::JSONSchema::register_format('pve-storage-monhost', \&parse_monhost);
 213 sub parse_monhost {
 214     my ($name, $noerr) = @_;
 215
 216     if ($name !~ m/^[a-z][a-z0-9\-\_\.]*[a-z0-9]$/i) {
 217         return undef if $noerr;
 218         die "lvm name '$name' contains illegal characters\n";
 219     }
 220
 221     return $name;
 222 }
 223
 224 sub type {
 225     return 'rbd';
 226 }
 227
 228 sub plugindata {
 229     return {
 230         content => [ {images => 1, rootdir => 1}, { images => 1 }],
 231     };
 232 }
 233
 234 sub properties {
 235     return {
 236         monhost => {
 237             description => "Monitors daemon ips.",
 238             type => 'string',
 239         },
 240         pool => {
 241             description => "Pool.",
 242             type => 'string',
 243         },
 244         username => {
 245             description => "RBD Id.",
 246             type => 'string',
 247         },
 248         authsupported => {
 249             description => "Authsupported.",
 250             type => 'string',
 251         },
 252         krbd => {
 253             description => "Access rbd through krbd kernel module.",
 254             type => 'boolean',
 255         },
 256     };
 257 }
 258
 259 sub options {
 260     return {
 261         nodes => { optional => 1 },
 262         disable => { optional => 1 },
 263         monhost => { fixed => 1 },
 264         pool => { optional => 1 },
 265         username => { optional => 1 },
 266         content => { optional => 1 },
 267         krbd => { optional => 1 },
 268     };
 269 }
 270
 271 # Storage implementation
 272
 273 sub parse_volname {
 274     my ($class, $volname) = @_;
 275
 276     if ($volname =~ m/^((base-(\d+)-\S+)\/)?((base)?(vm)?-(\d+)-\S+)$/) {
 277         return ('images', $4, $7, $2, $3, $5, 'raw');
 278     }
 279
 280     die "unable to parse rbd volume name '$volname'\n";
 281 }
 282
 283 sub path {
 284     my ($class, $scfg, $volname, $storeid, $snapname) = @_;
 285
 286     my ($vtype, $name, $vmid) = $class->parse_volname($volname);
 287     $name .= '@'.$snapname if $snapname;
 288
 289     my $monhost = $scfg->{monhost};
 290     $monhost =~ s/:/\\:/g;
 291
 292     my $pool =  $scfg->{pool} ? $scfg->{pool} : 'rbd';
 293     my $username =  $scfg->{username} ? $scfg->{username} : 'admin';
 294
 295     my $path = "rbd:$pool/$name:mon_host=$monhost";
 296     my $keyring = "/etc/pve/priv/ceph/${storeid}.keyring";
 297
 298     if(-e $keyring ){
 299         $path .= ":id=$username:auth_supported=cephx:keyring=$keyring";
 300     }else{
 301         $path .= ":auth_supported=none";
 302     }
 303
 304     $path = "/dev/rbd/$pool/$name" if $scfg->{krbd};
 305
 306     return ($path, $vmid, $vtype);
 307 }
 308
 309 my $find_free_diskname = sub {
 310     my ($storeid, $scfg, $vmid) = @_;
 311
 312     my $rbd = rbd_ls($scfg, $storeid);
 313     my $pool =  $scfg->{pool} ? $scfg->{pool} : 'rbd';
 314     my $disk_ids = {};
 315     my $dat = $rbd->{$pool};
 316
 317     foreach my $image (keys %$dat) {
 318         my $volname = $dat->{$image}->{name};
 319         if ($volname =~ m/(vm|base)-$vmid-disk-(\d+)/){
 320             $disk_ids->{$2} = 1;
 321         }
 322     }
 323     #fix: can we search in $rbd hash key with a regex to find (vm|base) ?
 324     for (my $i = 1; $i < 100; $i++) {
 325         if (!$disk_ids->{$i}) {
 326             return "vm-$vmid-disk-$i";
 327         }
 328     }
 329
 330     die "unable to allocate an image name for VM $vmid in storage '$storeid'\n";
 331 };
 332
 333 sub create_base {
 334     my ($class, $storeid, $scfg, $volname) = @_;
 335
 336     my $snap = '__base__';
 337
 338     my ($vtype, $name, $vmid, $basename, $basevmid, $isBase) =
 339         $class->parse_volname($volname);
 340
 341     die "create_base not possible with base image\n" if $isBase;
 342
 343     my ($size, $parent, $format, undef) = rbd_volume_info($scfg, $storeid, $name);
 344     die "rbd volume info on '$name' failed\n" if !($size);
 345
 346     die "rbd image must be at format V2" if $format ne "2";
 347
 348     die "volname '$volname' contains wrong information about parent $parent $basename\n"
 349         if $basename && (!$parent || $parent ne $basename."@".$snap);
 350
 351     my $newname = $name;
 352     $newname =~ s/^vm-/base-/;
 353
 354     my $newvolname = $basename ? "$basename/$newname" : "$newname";
 355
 356     my $cmd = &$rbd_cmd($scfg, $storeid, 'rename', &$add_pool_to_disk($scfg, $name), &$add_pool_to_disk($scfg, $newname));
 357     run_rbd_command($cmd, errmsg => "rbd rename '$name' error");
 358
 359     my $running  = undef; #fixme : is create_base always offline ?
 360
 361     $class->volume_snapshot($scfg, $storeid, $newname, $snap, $running);
 362
 363     my (undef, undef, undef, $protected) = rbd_volume_info($scfg, $storeid, $newname, $snap);
 364
 365     if (!$protected){
 366         my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'protect', $newname, '--snap', $snap);
 367         run_rbd_command($cmd, errmsg => "rbd protect $newname snap '$snap' error");
 368     }
 369
 370     return $newvolname;
 371
 372 }
 373
 374 sub clone_image {
 375     my ($class, $scfg, $storeid, $volname, $vmid, $snapname) = @_;
 376
 377     my $snap = '__base__';
 378     $snap = $snapname if length $snapname;
 379
 380     my ($vtype, $basename, $basevmid, undef, undef, $isBase) =
 381         $class->parse_volname($volname);
 382
 383     die "$volname is not a base image and snapname is not provided\n"
 384         if !$isBase && !length($snapname);
 385
 386     my $name = &$find_free_diskname($storeid, $scfg, $vmid);
 387
 388     warn "clone $volname: $basename snapname $snap to $name\n";
 389
 390     if (length($snapname)) {
 391         my (undef, undef, undef, $protected) = rbd_volume_info($scfg, $storeid, $volname, $snapname);
 392
 393         if (!$protected) {
 394             my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'protect', $volname, '--snap', $snapname);
 395             run_rbd_command($cmd, errmsg => "rbd protect $volname snap $snapname error");
 396         }
 397     }
 398
 399     my $newvol = "$basename/$name";
 400     $newvol = $name if length($snapname);
 401
 402     my $cmd = &$rbd_cmd($scfg, $storeid, 'clone', &$add_pool_to_disk($scfg, $basename),
 403                         '--snap', $snap, &$add_pool_to_disk($scfg, $name));
 404
 405     run_rbd_command($cmd, errmsg => "rbd clone '$basename' error");
 406
 407     return $newvol;
 408 }
 409
 410 sub alloc_image {
 411     my ($class, $storeid, $scfg, $vmid, $fmt, $name, $size) = @_;
 412
 413
 414     die "illegal name '$name' - sould be 'vm-$vmid-*'\n"
 415         if  $name && $name !~ m/^vm-$vmid-/;
 416
 417     $name = &$find_free_diskname($storeid, $scfg, $vmid) if !$name;
 418
 419     my $cmd = &$rbd_cmd($scfg, $storeid, 'create', '--image-format' , 2, '--size', int(($size+1023)/1024), $name);
 420     run_rbd_command($cmd, errmsg => "rbd create $name' error");
 421
 422     return $name;
 423 }
 424
 425 sub free_image {
 426     my ($class, $storeid, $scfg, $volname, $isBase) = @_;
 427
 428     my ($vtype, $name, $vmid, undef, undef, undef) =
 429         $class->parse_volname($volname);
 430
 431     if ($isBase) {
 432         my $snap = '__base__';
 433         my (undef, undef, undef, $protected) = rbd_volume_info($scfg, $storeid, $name, $snap);
 434         if ($protected){
 435             my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'unprotect', $name, '--snap', $snap);
 436             run_rbd_command($cmd, errmsg => "rbd unprotect $name snap '$snap' error");
 437         }
 438     }
 439
 440     $class->deactivate_volume($storeid, $scfg, $volname);
 441
 442     my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'purge',  $name);
 443     run_rbd_command($cmd, errmsg => "rbd snap purge '$volname' error");
 444
 445     $cmd = &$rbd_cmd($scfg, $storeid, 'rm', $name);
 446     run_rbd_command($cmd, errmsg => "rbd rm '$volname' error");
 447
 448     return undef;
 449 }
 450
 451 sub list_images {
 452     my ($class, $storeid, $scfg, $vmid, $vollist, $cache) = @_;
 453
 454     $cache->{rbd} = rbd_ls($scfg, $storeid) if !$cache->{rbd};
 455     my $pool =  $scfg->{pool} ? $scfg->{pool} : 'rbd';
 456
 457     my $res = [];
 458
 459     if (my $dat = $cache->{rbd}->{$pool}) {
 460         foreach my $image (keys %$dat) {
 461
 462             my $volname = $dat->{$image}->{name};
 463
 464             my $volid = "$storeid:$volname";
 465
 466             my $owner = $dat->{$volname}->{vmid};
 467             if ($vollist) {
 468                 my $found = grep { $_ eq $volid } @$vollist;
 469                 next if !$found;
 470             } else {
 471                 next if defined ($vmid) && ($owner ne $vmid);
 472             }
 473
 474             my $info = $dat->{$volname};
 475             $info->{volid} = $volid;
 476             $info->{format} = 'raw';
 477
 478             push @$res, $info;
 479         }
 480     }
 481
 482     return $res;
 483 }
 484
 485 sub status {
 486     my ($class, $storeid, $scfg, $cache) = @_;
 487
 488     my $cmd = &$rados_cmd($scfg, $storeid, 'df');
 489
 490     my $stats = {};
 491
 492     my $parser = sub {
 493         my $line = shift;
 494         if ($line =~ m/^\s+total\s(\S+)\s+(\d+)/) {
 495             $stats->{$1} = $2;
 496         }
 497     };
 498
 499     eval {
 500         run_rbd_command($cmd, errmsg => "rados error", errfunc => sub {}, outfunc => $parser);
 501     };
 502
 503     my $total = $stats->{space} ? $stats->{space}*1024 : 0;
 504     my $free = $stats->{avail} ? $stats->{avail}*1024 : 0;
 505     my $used = $stats->{used} ? $stats->{used}*1024: 0;
 506     my $active = 1;
 507
 508     return ($total, $free, $used, $active);
 509 }
 510
 511 sub activate_storage {
 512     my ($class, $storeid, $scfg, $cache) = @_;
 513     return 1;
 514 }
 515
 516 sub deactivate_storage {
 517     my ($class, $storeid, $scfg, $cache) = @_;
 518     return 1;
 519 }
 520
 521 sub activate_volume {
 522     my ($class, $storeid, $scfg, $volname, $snapname, $cache) = @_;
 523
 524     return 1 if !$scfg->{krbd};
 525
 526     my ($vtype, $name, $vmid) = $class->parse_volname($volname);
 527     my $pool =  $scfg->{pool} ? $scfg->{pool} : 'rbd';
 528
 529     my $path = "/dev/rbd/$pool/$name";
 530     $path .= '@'.$snapname if $snapname;
 531     return if -b $path;
 532
 533     $name .= '@'.$snapname if $snapname;
 534     my $cmd = &$rbd_cmd($scfg, $storeid, 'map', $name);
 535     run_rbd_command($cmd, errmsg => "can't mount rbd volume $name");
 536
 537     return 1;
 538 }
 539
 540 sub deactivate_volume {
 541     my ($class, $storeid, $scfg, $volname, $snapname, $cache) = @_;
 542
 543     return 1 if !$scfg->{krbd};
 544
 545     my ($vtype, $name, $vmid) = $class->parse_volname($volname);
 546     my $pool =  $scfg->{pool} ? $scfg->{pool} : 'rbd';
 547
 548     my $path = "/dev/rbd/$pool/$name";
 549     $path .= '@'.$snapname if $snapname;
 550     return if ! -b $path;
 551
 552     my $cmd = &$rbd_cmd($scfg, $storeid, 'unmap', $path);
 553     run_rbd_command($cmd, errmsg => "can't unmap rbd volume $name");
 554
 555     return 1;
 556 }
 557
 558 sub volume_size_info {
 559     my ($class, $scfg, $storeid, $volname, $timeout) = @_;
 560
 561     my ($vtype, $name, $vmid) = $class->parse_volname($volname);
 562     my ($size, undef) = rbd_volume_info($scfg, $storeid, $name);
 563     return $size;
 564 }
 565
 566 sub volume_resize {
 567     my ($class, $scfg, $storeid, $volname, $size, $running) = @_;
 568
 569     return 1 if $running;
 570
 571     my ($vtype, $name, $vmid) = $class->parse_volname($volname);
 572
 573     my $cmd = &$rbd_cmd($scfg, $storeid, 'resize', '--size', ($size/1024/1024), $name);
 574     run_rbd_command($cmd, errmsg => "rbd resize '$volname' error");
 575     return undef;
 576 }
 577
 578 sub volume_snapshot {
 579     my ($class, $scfg, $storeid, $volname, $snap) = @_;
 580
 581     my ($vtype, $name, $vmid) = $class->parse_volname($volname);
 582
 583     my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'create', '--snap', $snap, $name);
 584     run_rbd_command($cmd, errmsg => "rbd snapshot '$volname' error");
 585     return undef;
 586 }
 587
 588 sub volume_snapshot_rollback {
 589     my ($class, $scfg, $storeid, $volname, $snap) = @_;
 590
 591     my ($vtype, $name, $vmid) = $class->parse_volname($volname);
 592
 593     my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'rollback', '--snap', $snap, $name);
 594     run_rbd_command($cmd, errmsg => "rbd snapshot $volname to '$snap' error");
 595 }
 596
 597 sub volume_snapshot_delete {
 598     my ($class, $scfg, $storeid, $volname, $snap, $running) = @_;
 599
 600     return 1 if $running;
 601
 602     $class->deactivate_volume($storeid, $scfg, $volname, $snap, {});
 603
 604     my ($vtype, $name, $vmid) = $class->parse_volname($volname);
 605
 606     my (undef, undef, undef, $protected) = rbd_volume_info($scfg, $storeid, $name, $snap);
 607     if ($protected){
 608         my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'unprotect', $name, '--snap', $snap);
 609         run_rbd_command($cmd, errmsg => "rbd unprotect $name snap '$snap' error");
 610     }
 611
 612     my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'rm', '--snap', $snap, $name);
 613
 614     run_rbd_command($cmd, errmsg => "rbd snapshot '$volname' error");
 615
 616     return undef;
 617 }
 618
 619 sub volume_has_feature {
 620     my ($class, $scfg, $feature, $storeid, $volname, $snapname, $running) = @_;
 621
 622    my $features = {
 623         snapshot => { current => 1, snap => 1},
 624         clone => { base => 1, snap => 1},
 625         template => { current => 1},
 626         copy => { base => 1, current => 1, snap => 1},
 627         sparseinit => { base => 1, current => 1},
 628     };
 629
 630     my ($vtype, $name, $vmid, $basename, $basevmid, $isBase) =
 631         $class->parse_volname($volname);
 632
 633     my $key = undef;
 634     if($snapname){
 635         $key = 'snap';
 636     }else{
 637         $key =  $isBase ? 'base' : 'current';
 638     }
 639     return 1 if $features->{$feature}->{$key};
 640
 641     return undef;
 642 }
 643
 644 1;