]>
git.proxmox.com Git - pve-storage.git/blob - PVE/Storage/LVMPlugin.pm
1 package PVE
::Storage
::LVMPlugin
;
8 use PVE
::Tools
qw(run_command trim);
9 use PVE
::Storage
::Plugin
;
10 use PVE
::JSONSchema
qw(get_standard_option);
12 use base
qw(PVE::Storage::Plugin);
14 # lvm helper functions
16 my $ignore_no_medium_warnings = sub {
18 # ignore those, most of the time they're from (virtual) IPMI/iKVM devices
19 # and just spam the log..
20 if ($line !~ /open failed: No medium found/) {
21 print STDERR
"$line\n";
28 die "no device specified" if !$device;
32 my $cmd = ['/usr/bin/file', '-L', '-s', $device];
33 run_command
($cmd, outfunc
=> sub {
35 $has_label = 1 if $line =~ m/LVM2/;
38 return undef if !$has_label;
40 $cmd = ['/sbin/pvs', '--separator', ':', '--noheadings', '--units', 'k',
41 '--unbuffered', '--nosuffix', '--options',
42 'pv_name,pv_size,vg_name,pv_uuid', $device];
45 run_command
($cmd, outfunc
=> sub {
50 my ($pvname, $size, $vgname, $uuid) = split(':', $line);
52 die "found multiple pvs entries for device '$device'\n"
66 sub clear_first_sector
{
69 if (my $fh = IO
::File-
>new($dev, "w")) {
76 sub lvm_create_volume_group
{
77 my ($device, $vgname, $shared) = @_;
79 my $res = lvm_pv_info
($device);
82 return if $res->{vgname
} eq $vgname; # already created
83 die "device '$device' is already used by volume group '$res->{vgname}'\n";
86 clear_first_sector
($device); # else pvcreate fails
88 # we use --metadatasize 250k, which reseults in "pe_start = 512"
89 # so pe_start is aligned on a 128k boundary (advantage for SSDs)
90 my $cmd = ['/sbin/pvcreate', '--metadatasize', '250k', $device];
92 run_command
($cmd, errmsg
=> "pvcreate '$device' error");
94 $cmd = ['/sbin/vgcreate', $vgname, $device];
95 # push @$cmd, '-c', 'y' if $shared; # we do not use this yet
97 run_command
($cmd, errmsg
=> "vgcreate $vgname $device error", errfunc
=> $ignore_no_medium_warnings, outfunc
=> $ignore_no_medium_warnings);
101 my ($includepvs) = @_;
103 my $cmd = ['/sbin/vgs', '--separator', ':', '--noheadings', '--units', 'b',
104 '--unbuffered', '--nosuffix', '--options'];
106 my $cols = [qw(vg_name vg_size vg_free lv_count)];
109 push @$cols, qw(pv_name pv_size pv_free);
112 push @$cmd, join(',', @$cols);
116 run_command
($cmd, outfunc
=> sub {
120 my ($name, $size, $free, $lvcount, $pvname, $pvsize, $pvfree) = split (':', $line);
125 lvcount
=> int($lvcount)
128 if (defined($pvname) && defined($pvsize) && defined($pvfree)) {
129 push @{$vgs->{$name}->{pvs
}}, {
131 size
=> int($pvsize),
132 free
=> int($pvfree),
136 errfunc
=> $ignore_no_medium_warnings,
141 # just warn (vgs return error code 5 if clvmd does not run)
142 # but output is still OK (list without clustered VGs)
148 sub lvm_list_volumes
{
151 my $option_list = 'vg_name,lv_name,lv_size,lv_attr,pool_lv,data_percent,metadata_percent,snap_percent,uuid,tags,metadata_size,time';
154 '/sbin/lvs', '--separator', ':', '--noheadings', '--units', 'b',
155 '--unbuffered', '--nosuffix',
156 '--config', 'report/time_format="%s"',
157 '--options', $option_list,
160 push @$cmd, $vgname if $vgname;
163 run_command
($cmd, outfunc
=> sub {
168 my ($vg_name, $lv_name, $lv_size, $lv_attr, $pool_lv, $data_percent, $meta_percent, $snap_percent, $uuid, $tags, $meta_size, $ctime) = split(':', $line);
172 my $lv_type = substr($lv_attr, 0, 1);
175 lv_size
=> int($lv_size),
178 $d->{pool_lv
} = $pool_lv if $pool_lv;
179 $d->{tags
} = $tags if $tags;
180 $d->{ctime
} = $ctime;
182 if ($lv_type eq 't') {
186 $d->{metadata_size
} = int($meta_size);
187 $d->{metadata_used
} = int(($meta_percent * $meta_size)/100);
188 $d->{used
} = int(($data_percent * $lv_size)/100);
190 $lvs->{$vg_name}->{$lv_name} = $d;
192 errfunc
=> $ignore_no_medium_warnings,
206 content
=> [ {images
=> 1, rootdir
=> 1}, { images
=> 1 }],
213 description
=> "Volume group name.",
214 type
=> 'string', format
=> 'pve-storage-vgname',
217 description
=> "Base volume. This volume is automatically activated.",
218 type
=> 'string', format
=> 'pve-volume-id',
221 description
=> "Zero-out data when removing LVs.",
224 saferemove_throughput
=> {
225 description
=> "Wipe throughput (cstream -t parameter value).",
229 description
=> "Only use logical volumes tagged with 'pve-vm-ID'.",
237 vgname
=> { fixed
=> 1 },
238 nodes
=> { optional
=> 1 },
239 shared
=> { optional
=> 1 },
240 disable
=> { optional
=> 1 },
241 saferemove
=> { optional
=> 1 },
242 saferemove_throughput
=> { optional
=> 1 },
243 content
=> { optional
=> 1 },
244 base
=> { fixed
=> 1, optional
=> 1 },
245 tagged_only
=> { optional
=> 1 },
246 bwlimit
=> { optional
=> 1 },
250 # Storage implementation
253 my ($class, $storeid, $scfg, %param) = @_;
255 if (my $base = $scfg->{base
}) {
256 my ($baseid, $volname) = PVE
::Storage
::parse_volume_id
($base);
258 my $cfg = PVE
::Storage
::config
();
259 my $basecfg = PVE
::Storage
::storage_config
($cfg, $baseid, 1);
260 die "base storage ID '$baseid' does not exist\n" if !$basecfg;
262 # we only support iscsi for now
263 die "unsupported base type '$basecfg->{type}'"
264 if $basecfg->{type
} ne 'iscsi';
266 my $path = PVE
::Storage
::path
($cfg, $base);
268 PVE
::Storage
::activate_storage
($cfg, $baseid);
270 lvm_create_volume_group
($path, $scfg->{vgname
}, $scfg->{shared
});
277 my ($class, $volname) = @_;
279 PVE
::Storage
::Plugin
::parse_lvm_name
($volname);
281 if ($volname =~ m/^(vm-(\d+)-\S+)$/) {
282 return ('images', $1, $2, undef, undef, undef, 'raw');
285 die "unable to parse lvm volume name '$volname'\n";
288 sub filesystem_path
{
289 my ($class, $scfg, $volname, $snapname) = @_;
291 die "lvm snapshot is not implemented"if defined($snapname);
293 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
295 my $vg = $scfg->{vgname
};
297 my $path = "/dev/$vg/$name";
299 return wantarray ?
($path, $vmid, $vtype) : $path;
303 my ($class, $storeid, $scfg, $volname) = @_;
305 die "can't create base images in lvm storage\n";
309 my ($class, $scfg, $storeid, $volname, $vmid, $snap) = @_;
311 die "can't clone images in lvm storage\n";
314 sub find_free_diskname
{
315 my ($class, $storeid, $scfg, $vmid, $fmt, $add_fmt_suffix) = @_;
317 my $vg = $scfg->{vgname
};
319 my $lvs = lvm_list_volumes
($vg);
321 my $disk_list = [ keys %{$lvs->{$vg}} ];
323 return PVE
::Storage
::Plugin
::get_next_vm_diskname
($disk_list, $storeid, $vmid, undef, $scfg);
327 my ($vg, $name, $size, $tags) = @_;
329 if ($size =~ m/\d$/) { # no unit is given
330 $size .= "k"; # default to kilobytes
333 my $cmd = ['/sbin/lvcreate', '-aly', '--size', $size, '--name', $name];
334 for my $tag (@$tags) {
335 push @$cmd, '--addtag', $tag;
339 run_command
($cmd, errmsg
=> "lvcreate '$vg/$name' error");
343 my ($class, $storeid, $scfg, $vmid, $fmt, $name, $size) = @_;
345 die "unsupported format '$fmt'" if $fmt ne 'raw';
347 die "illegal name '$name' - should be 'vm-$vmid-*'\n"
348 if $name && $name !~ m/^vm-$vmid-/;
352 my $vg = $scfg->{vgname
};
354 die "no such volume group '$vg'\n" if !defined ($vgs->{$vg});
356 my $free = int($vgs->{$vg}->{free
});
358 die "not enough free space ($free < $size)\n" if $free < $size;
360 $name = $class->find_free_diskname($storeid, $scfg, $vmid)
363 lvcreate
($vg, $name, $size, ["pve-vm-$vmid"]);
369 my ($class, $storeid, $scfg, $volname, $isBase) = @_;
371 my $vg = $scfg->{vgname
};
373 # we need to zero out LVM data for security reasons
374 # and to allow thin provisioning
376 my $zero_out_worker = sub {
377 print "zero-out data on image $volname (/dev/$vg/del-$volname)\n";
379 # wipe throughput up to 10MB/s by default; may be overwritten with saferemove_throughput
380 my $throughput = '-10485760';
381 if ($scfg->{saferemove_throughput
}) {
382 $throughput = $scfg->{saferemove_throughput
};
388 '-o', "/dev/$vg/del-$volname",
394 eval { run_command
($cmd, errmsg
=> "zero out finished (note: 'No space left on device' is ok here)"); };
397 $class->cluster_lock_storage($storeid, $scfg->{shared
}, undef, sub {
398 my $cmd = ['/sbin/lvremove', '-f', "$vg/del-$volname"];
399 run_command
($cmd, errmsg
=> "lvremove '$vg/del-$volname' error");
401 print "successfully removed volume $volname ($vg/del-$volname)\n";
404 my $cmd = ['/sbin/lvchange', '-aly', "$vg/$volname"];
405 run_command
($cmd, errmsg
=> "can't activate LV '$vg/$volname' to zero-out its data");
406 $cmd = ['/sbin/lvchange', '--refresh', "$vg/$volname"];
407 run_command
($cmd, errmsg
=> "can't refresh LV '$vg/$volname' to zero-out its data");
409 if ($scfg->{saferemove
}) {
410 # avoid long running task, so we only rename here
411 $cmd = ['/sbin/lvrename', $vg, $volname, "del-$volname"];
412 run_command
($cmd, errmsg
=> "lvrename '$vg/$volname' error");
413 return $zero_out_worker;
415 my $tmpvg = $scfg->{vgname
};
416 $cmd = ['/sbin/lvremove', '-f', "$tmpvg/$volname"];
417 run_command
($cmd, errmsg
=> "lvremove '$tmpvg/$volname' error");
423 my $check_tags = sub {
426 return defined($tags) && $tags =~ /(^|,)pve-vm-\d+(,|$)/;
430 my ($class, $storeid, $scfg, $vmid, $vollist, $cache) = @_;
432 my $vgname = $scfg->{vgname
};
434 $cache->{lvs
} = lvm_list_volumes
() if !$cache->{lvs
};
438 if (my $dat = $cache->{lvs
}->{$vgname}) {
440 foreach my $volname (keys %$dat) {
442 next if $volname !~ m/^vm-(\d+)-/;
445 my $info = $dat->{$volname};
447 next if $scfg->{tagged_only
} && !&$check_tags($info->{tags
});
449 # Allow mirrored and RAID LVs
450 next if $info->{lv_type
} !~ m/^[-mMrR]$/;
452 my $volid = "$storeid:$volname";
455 my $found = grep { $_ eq $volid } @$vollist;
458 next if defined($vmid) && ($owner ne $vmid);
462 volid
=> $volid, format
=> 'raw', size
=> $info->{lv_size
}, vmid
=> $owner,
463 ctime
=> $info->{ctime
},
472 my ($class, $storeid, $scfg, $cache) = @_;
474 $cache->{vgs
} = lvm_vgs
() if !$cache->{vgs
};
476 my $vgname = $scfg->{vgname
};
478 if (my $info = $cache->{vgs
}->{$vgname}) {
479 return ($info->{size
}, $info->{free
}, $info->{size
} - $info->{free
}, 1);
485 sub activate_storage
{
486 my ($class, $storeid, $scfg, $cache) = @_;
488 $cache->{vgs
} = lvm_vgs
() if !$cache->{vgs
};
490 # In LVM2, vgscans take place automatically;
491 # this is just to be sure
492 if ($cache->{vgs
} && !$cache->{vgscaned
} &&
493 !$cache->{vgs
}->{$scfg->{vgname
}}) {
494 $cache->{vgscaned
} = 1;
495 my $cmd = ['/sbin/vgscan', '--ignorelockingfailure', '--mknodes'];
496 eval { run_command
($cmd, outfunc
=> sub {}); };
500 # we do not acticate any volumes here ('vgchange -aly')
501 # instead, volumes are activate individually later
504 sub deactivate_storage
{
505 my ($class, $storeid, $scfg, $cache) = @_;
507 my $cmd = ['/sbin/vgchange', '-aln', $scfg->{vgname
}];
508 run_command
($cmd, errmsg
=> "can't deactivate VG '$scfg->{vgname}'");
511 sub activate_volume
{
512 my ($class, $storeid, $scfg, $volname, $snapname, $cache) = @_;
513 #fix me lvmchange is not provided on
514 my $path = $class->path($scfg, $volname, $snapname);
516 my $lvm_activate_mode = 'ey';
518 my $cmd = ['/sbin/lvchange', "-a$lvm_activate_mode", $path];
519 run_command
($cmd, errmsg
=> "can't activate LV '$path'");
520 $cmd = ['/sbin/lvchange', '--refresh', $path];
521 run_command
($cmd, errmsg
=> "can't refresh LV '$path' for activation");
524 sub deactivate_volume
{
525 my ($class, $storeid, $scfg, $volname, $snapname, $cache) = @_;
527 my $path = $class->path($scfg, $volname, $snapname);
528 return if ! -b
$path;
530 my $cmd = ['/sbin/lvchange', '-aln', $path];
531 run_command
($cmd, errmsg
=> "can't deactivate LV '$path'");
535 my ($class, $scfg, $storeid, $volname, $size, $running) = @_;
537 $size = ($size/1024/1024) . "M";
539 my $path = $class->path($scfg, $volname);
540 my $cmd = ['/sbin/lvextend', '-L', $size, $path];
542 $class->cluster_lock_storage($storeid, $scfg->{shared
}, undef, sub {
543 run_command
($cmd, errmsg
=> "error resizing volume '$path'");
549 sub volume_size_info
{
550 my ($class, $scfg, $storeid, $volname, $timeout) = @_;
551 my $path = $class->filesystem_path($scfg, $volname);
553 my $cmd = ['/sbin/lvs', '--separator', ':', '--noheadings', '--units', 'b',
554 '--unbuffered', '--nosuffix', '--options', 'lv_size', $path];
557 run_command
($cmd, timeout
=> $timeout, errmsg
=> "can't get size of '$path'",
561 return wantarray ?
($size, 'raw', 0, undef) : $size;
564 sub volume_snapshot
{
565 my ($class, $scfg, $storeid, $volname, $snap) = @_;
567 die "lvm snapshot is not implemented";
570 sub volume_snapshot_rollback
{
571 my ($class, $scfg, $storeid, $volname, $snap) = @_;
573 die "lvm snapshot rollback is not implemented";
576 sub volume_snapshot_delete
{
577 my ($class, $scfg, $storeid, $volname, $snap) = @_;
579 die "lvm snapshot delete is not implemented";
582 sub volume_has_feature
{
583 my ($class, $scfg, $feature, $storeid, $volname, $snapname, $running) = @_;
586 copy
=> { base
=> 1, current
=> 1},
589 my ($vtype, $name, $vmid, $basename, $basevmid, $isBase) =
590 $class->parse_volname($volname);
596 $key = $isBase ?
'base' : 'current';
598 return 1 if $features->{$feature}->{$key};
603 sub volume_export_formats
{
604 my ($class, $scfg, $storeid, $volname, $snapshot, $base_snapshot, $with_snapshots) = @_;
605 return () if defined($snapshot); # lvm-thin only
606 return volume_import_formats
($class, $scfg, $storeid, $volname, $base_snapshot, $with_snapshots);
610 my ($class, $scfg, $storeid, $fh, $volname, $format, $snapshot, $base_snapshot, $with_snapshots) = @_;
611 die "volume export format $format not available for $class\n"
612 if $format ne 'raw+size';
613 die "cannot export volumes together with their snapshots in $class\n"
615 die "cannot export a snapshot in $class\n" if defined($snapshot);
616 die "cannot export an incremental stream in $class\n" if defined($base_snapshot);
617 my $file = $class->path($scfg, $volname, $storeid);
619 # should be faster than querying LVM, also checks for the device file's availability
620 run_command
(['/sbin/blockdev', '--getsize64', $file], outfunc
=> sub {
622 die "unexpected output from /sbin/blockdev: $line\n" if $line !~ /^(\d+)$/;
625 PVE
::Storage
::Plugin
::write_common_header
($fh, $size);
626 run_command
(['dd', "if=$file", "bs=64k"], output
=> '>&'.fileno($fh));
629 sub volume_import_formats
{
630 my ($class, $scfg, $storeid, $volname, $base_snapshot, $with_snapshots) = @_;
631 return () if $with_snapshots; # not supported
632 return () if defined($base_snapshot); # not supported
637 my ($class, $scfg, $storeid, $fh, $volname, $format, $base_snapshot, $with_snapshots, $allow_rename) = @_;
638 die "volume import format $format not available for $class\n"
639 if $format ne 'raw+size';
640 die "cannot import volumes together with their snapshots in $class\n"
642 die "cannot import an incremental stream in $class\n" if defined($base_snapshot);
644 my ($vtype, $name, $vmid, $basename, $basevmid, $isBase, $file_format) =
645 $class->parse_volname($volname);
646 die "cannot import format $format into a file of format $file_format\n"
647 if $file_format ne 'raw';
649 my $vg = $scfg->{vgname
};
650 my $lvs = lvm_list_volumes
($vg);
651 if ($lvs->{$vg}->{$volname}) {
652 die "volume $vg/$volname already exists\n" if !$allow_rename;
653 warn "volume $vg/$volname already exists - importing with a different name\n";
657 my ($size) = PVE
::Storage
::Plugin
::read_common_header
($fh);
658 $size = int($size/1024);
661 my $allocname = $class->alloc_image($storeid, $scfg, $vmid, 'raw', $name, $size);
662 my $oldname = $volname;
663 $volname = $allocname;
664 if (defined($name) && $allocname ne $oldname) {
665 die "internal error: unexpected allocated name: '$allocname' != '$oldname'\n";
667 my $file = $class->path($scfg, $volname, $storeid)
668 or die "internal error: failed to get path to newly allocated volume $volname\n";
670 $class->volume_import_write($fh, $file);
673 my $cleanup_worker = eval { $class->free_image($storeid, $scfg, $volname, 0) };
676 if ($cleanup_worker) {
677 my $rpcenv = PVE
::RPCEnvironment
::get
();
678 my $authuser = $rpcenv->get_user();
680 $rpcenv->fork_worker('imgdel', undef, $authuser, $cleanup_worker);
686 return "$storeid:$volname";
689 sub volume_import_write
{
690 my ($class, $input_fh, $output_file) = @_;
691 run_command
(['dd', "of=$output_file", 'bs=64k'],
692 input
=> '<&'.fileno($input_fh));