]> git.proxmox.com Git - pve-storage.git/blame - PVE/Storage/LVMPlugin.pm
rbd: make activate_volume idempotent
[pve-storage.git] / PVE / Storage / LVMPlugin.pm
CommitLineData
1dc01b9f
DM
1package PVE::Storage::LVMPlugin;
2
3use strict;
4use warnings;
5use IO::File;
6use PVE::Tools qw(run_command trim);
7use PVE::Storage::Plugin;
8use PVE::JSONSchema qw(get_standard_option);
9
10use base qw(PVE::Storage::Plugin);
11
12# lvm helper functions
13
14sub lvm_pv_info {
15 my ($device) = @_;
16
17 die "no device specified" if !$device;
18
19 my $has_label = 0;
20
21 my $cmd = ['/usr/bin/file', '-L', '-s', $device];
22 run_command($cmd, outfunc => sub {
23 my $line = shift;
24 $has_label = 1 if $line =~ m/LVM2/;
25 });
26
27 return undef if !$has_label;
28
29 $cmd = ['/sbin/pvs', '--separator', ':', '--noheadings', '--units', 'k',
30 '--unbuffered', '--nosuffix', '--options',
31 'pv_name,pv_size,vg_name,pv_uuid', $device];
32
33 my $pvinfo;
34 run_command($cmd, outfunc => sub {
35 my $line = shift;
36
37 $line = trim($line);
38
39 my ($pvname, $size, $vgname, $uuid) = split(':', $line);
40
41 die "found multiple pvs entries for device '$device'\n"
42 if $pvinfo;
43
44 $pvinfo = {
45 pvname => $pvname,
46 size => $size,
47 vgname => $vgname,
48 uuid => $uuid,
49 };
50 });
51
52 return $pvinfo;
53}
54
55sub clear_first_sector {
56 my ($dev) = shift;
57
58 if (my $fh = IO::File->new($dev, "w")) {
59 my $buf = 0 x 512;
60 syswrite $fh, $buf;
61 $fh->close();
62 }
63}
64
65sub lvm_create_volume_group {
66 my ($device, $vgname, $shared) = @_;
67
68 my $res = lvm_pv_info($device);
69
70 if ($res->{vgname}) {
71 return if $res->{vgname} eq $vgname; # already created
72 die "device '$device' is already used by volume group '$res->{vgname}'\n";
73 }
74
75 clear_first_sector($device); # else pvcreate fails
76
77 # we use --metadatasize 250k, which reseults in "pe_start = 512"
78 # so pe_start is aligned on a 128k boundary (advantage for SSDs)
79 my $cmd = ['/sbin/pvcreate', '--metadatasize', '250k', $device];
80
81 run_command($cmd, errmsg => "pvcreate '$device' error");
82
83 $cmd = ['/sbin/vgcreate', $vgname, $device];
84 # push @$cmd, '-c', 'y' if $shared; # we do not use this yet
85
86 run_command($cmd, errmsg => "vgcreate $vgname $device error");
87}
88
89sub lvm_vgs {
90
91 my $cmd = ['/sbin/vgs', '--separator', ':', '--noheadings', '--units', 'b',
92 '--unbuffered', '--nosuffix', '--options',
93 'vg_name,vg_size,vg_free'];
94
95 my $vgs = {};
96 eval {
97 run_command($cmd, outfunc => sub {
98 my $line = shift;
99
100 $line = trim($line);
101
102 my ($name, $size, $free) = split (':', $line);
103
104 $vgs->{$name} = { size => int ($size), free => int ($free) };
105 });
106 };
107 my $err = $@;
108
109 # just warn (vgs return error code 5 if clvmd does not run)
110 # but output is still OK (list without clustered VGs)
111 warn $err if $err;
112
113 return $vgs;
114}
115
116sub lvm_lvs {
117 my ($vgname) = @_;
118
119 my $cmd = ['/sbin/lvs', '--separator', ':', '--noheadings', '--units', 'b',
120 '--unbuffered', '--nosuffix', '--options',
121 'vg_name,lv_name,lv_size,uuid,tags'];
122
123 push @$cmd, $vgname if $vgname;
124
125 my $lvs = {};
126 run_command($cmd, outfunc => sub {
127 my $line = shift;
128
129 $line = trim($line);
130
131 my ($vg, $name, $size, $uuid, $tags) = split(':', $line);
132
133 return if $name !~ m/^vm-(\d+)-/;
134 my $nid = $1;
135
136 my $owner;
137 foreach my $tag (split (/,/, $tags)) {
138 if ($tag =~ m/^pve-vm-(\d+)$/) {
139 $owner = $1;
140 last;
141 }
142 }
143
144 if ($owner) {
145 if ($owner ne $nid) {
146 warn "owner mismatch name = $name, owner = $owner\n";
147 }
148
149 $lvs->{$vg}->{$name} = { format => 'raw', size => $size,
150 uuid => $uuid, tags => $tags,
151 vmid => $owner };
152 }
153 });
154
155 return $lvs;
156}
157
158# Configuration
159
160PVE::JSONSchema::register_format('pve-storage-vgname', \&parse_lvm_name);
161sub parse_lvm_name {
162 my ($name, $noerr) = @_;
163
164 if ($name !~ m/^[a-z][a-z0-9\-\_\.]*[a-z0-9]$/i) {
165 return undef if $noerr;
166 die "lvm name '$name' contains illegal characters\n";
167 }
168
169 return $name;
170}
171
172sub type {
173 return 'lvm';
174}
175
176sub plugindata {
177 return {
178 content => [ {images => 1}, { images => 1 }],
179 };
180}
181
182sub properties {
183 return {
184 vgname => {
185 description => "Volume group name.",
186 type => 'string', format => 'pve-storage-vgname',
187 },
188 base => {
189 description => "Base volume. This volume is automatically activated.",
190 type => 'string', format => 'pve-volume-id',
191 },
192 saferemove => {
193 description => "Zero-out data when removing LVs.",
194 type => 'boolean',
195 },
399ab2b6
PB
196 saferemove_throughput => {
197 description => "Wipe throughput (cstream -t parameter value).",
198 type => 'string',
199 },
1dc01b9f
DM
200 };
201}
202
203sub options {
204 return {
205 vgname => { fixed => 1 },
206 nodes => { optional => 1 },
207 shared => { optional => 1 },
208 disable => { optional => 1 },
209 saferemove => { optional => 1 },
399ab2b6 210 saferemove_throughput => { optional => 1 },
1dc01b9f
DM
211 content => { optional => 1 },
212 base => { fixed => 1, optional => 1 },
213 };
214}
215
216# Storage implementation
217
218sub parse_volname {
219 my ($class, $volname) = @_;
220
221 parse_lvm_name($volname);
222
223 if ($volname =~ m/^(vm-(\d+)-\S+)$/) {
7800e84d 224 return ('images', $1, $2, undef, undef, undef, 'raw');
1dc01b9f
DM
225 }
226
227 die "unable to parse lvm volume name '$volname'\n";
228}
229
452e3ee7 230sub filesystem_path {
e67069eb
DM
231 my ($class, $scfg, $volname, $snapname) = @_;
232
233 die "lvm snapshot is not implemented"if defined($snapname);
1dc01b9f
DM
234
235 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
236
237 my $vg = $scfg->{vgname};
238
239 my $path = "/dev/$vg/$name";
240
5521b580 241 return wantarray ? ($path, $vmid, $vtype) : $path;
1dc01b9f
DM
242}
243
5eab0272
DM
244sub create_base {
245 my ($class, $storeid, $scfg, $volname) = @_;
246
247 die "can't create base images in lvm storage\n";
248}
249
250sub clone_image {
f236eaf8 251 my ($class, $scfg, $storeid, $volname, $vmid, $snap) = @_;
5eab0272
DM
252
253 die "can't clone images in lvm storage\n";
254}
255
1dc01b9f
DM
256sub alloc_image {
257 my ($class, $storeid, $scfg, $vmid, $fmt, $name, $size) = @_;
258
259 die "unsupported format '$fmt'" if $fmt ne 'raw';
260
261 die "illegal name '$name' - sould be 'vm-$vmid-*'\n"
262 if $name && $name !~ m/^vm-$vmid-/;
263
264 my $vgs = lvm_vgs();
265
266 my $vg = $scfg->{vgname};
267
e8acaa3c 268 die "no such volume group '$vg'\n" if !defined ($vgs->{$vg});
1dc01b9f
DM
269
270 my $free = int($vgs->{$vg}->{free});
271
272 die "not enough free space ($free < $size)\n" if $free < $size;
273
274 if (!$name) {
275 my $lvs = lvm_lvs($vg);
276
277 for (my $i = 1; $i < 100; $i++) {
278 my $tn = "vm-$vmid-disk-$i";
279 if (!defined ($lvs->{$vg}->{$tn})) {
280 $name = $tn;
281 last;
282 }
283 }
284 }
285
286 die "unable to allocate an image name for VM $vmid in storage '$storeid'\n"
287 if !$name;
288
289 my $cmd = ['/sbin/lvcreate', '-aly', '--addtag', "pve-vm-$vmid", '--size', "${size}k", '--name', $name, $vg];
290
291 run_command($cmd, errmsg => "lvcreate '$vg/pve-vm-$vmid' error");
292
293 return $name;
294}
295
296sub free_image {
32437ed2 297 my ($class, $storeid, $scfg, $volname, $isBase) = @_;
1dc01b9f
DM
298
299 my $vg = $scfg->{vgname};
399ab2b6 300
1dc01b9f
DM
301 # we need to zero out LVM data for security reasons
302 # and to allow thin provisioning
303
304 my $zero_out_worker = sub {
399ab2b6
PB
305 print "zero-out data on image $volname (/dev/$vg/del-$volname)\n";
306
307 # wipe throughput up to 10MB/s by default; may be overwritten with saferemove_throughput
308 my $throughput = '-10485760';
309 if ($scfg->{saferemove_throughput}) {
310 $throughput = $scfg->{saferemove_throughput};
311 }
312
313 my $cmd = [
314 '/usr/bin/cstream',
315 '-i', '/dev/zero',
316 '-o', "/dev/$vg/del-$volname",
317 '-T', '10',
318 '-v', '1',
319 '-b', '1048576',
320 '-t', "$throughput"
321 ];
322 eval { run_command($cmd, errmsg => "zero out finished (note: 'No space left on device' is ok here)"); };
1dc01b9f
DM
323 warn $@ if $@;
324
325 $class->cluster_lock_storage($storeid, $scfg->{shared}, undef, sub {
326 my $cmd = ['/sbin/lvremove', '-f', "$vg/del-$volname"];
327 run_command($cmd, errmsg => "lvremove '$vg/del-$volname' error");
328 });
399ab2b6 329 print "successfully removed volume $volname ($vg/del-$volname)\n";
1dc01b9f
DM
330 };
331
399ab2b6
PB
332 my $cmd = ['/sbin/lvchange', '-aly', "$vg/$volname"];
333 run_command($cmd, errmsg => "can't activate LV '$vg/$volname' to zero-out its data");
334
1dc01b9f
DM
335 if ($scfg->{saferemove}) {
336 # avoid long running task, so we only rename here
399ab2b6 337 $cmd = ['/sbin/lvrename', $vg, $volname, "del-$volname"];
1dc01b9f
DM
338 run_command($cmd, errmsg => "lvrename '$vg/$volname' error");
339 return $zero_out_worker;
340 } else {
341 my $tmpvg = $scfg->{vgname};
399ab2b6 342 $cmd = ['/sbin/lvremove', '-f', "$tmpvg/$volname"];
1dc01b9f
DM
343 run_command($cmd, errmsg => "lvremove '$tmpvg/$volname' error");
344 }
345
346 return undef;
347}
348
349sub list_images {
350 my ($class, $storeid, $scfg, $vmid, $vollist, $cache) = @_;
351
352 my $vgname = $scfg->{vgname};
353
354 $cache->{lvs} = lvm_lvs() if !$cache->{lvs};
355
356 my $res = [];
357
358 if (my $dat = $cache->{lvs}->{$vgname}) {
359
360 foreach my $volname (keys %$dat) {
361
362 my $owner = $dat->{$volname}->{vmid};
363
364 my $volid = "$storeid:$volname";
365
366 if ($vollist) {
367 my $found = grep { $_ eq $volid } @$vollist;
368 next if !$found;
369 } else {
370 next if defined ($vmid) && ($owner ne $vmid);
371 }
372
373 my $info = $dat->{$volname};
374 $info->{volid} = $volid;
375
376 push @$res, $info;
377 }
378 }
379
380 return $res;
381}
382
383sub status {
384 my ($class, $storeid, $scfg, $cache) = @_;
385
386 $cache->{vgs} = lvm_vgs() if !$cache->{vgs};
387
388 my $vgname = $scfg->{vgname};
389
390 my $total = 0;
391 my $free = 0;
392 my $used = 0;
393
394 if (my $info = $cache->{vgs}->{$vgname}) {
395 return ($info->{size}, $info->{free}, $total - $free, 1);
396 }
397
398 return undef;
399}
400
401sub activate_storage {
402 my ($class, $storeid, $scfg, $cache) = @_;
403
404 $cache->{vgs} = lvm_vgs() if !$cache->{vgs};
405
406 # In LVM2, vgscans take place automatically;
407 # this is just to be sure
408 if ($cache->{vgs} && !$cache->{vgscaned} &&
409 !$cache->{vgs}->{$scfg->{vgname}}) {
410 $cache->{vgscaned} = 1;
411 my $cmd = ['/sbin/vgscan', '--ignorelockingfailure', '--mknodes'];
412 eval { run_command($cmd, outfunc => sub {}); };
413 warn $@ if $@;
414 }
415
416 # we do not acticate any volumes here ('vgchange -aly')
417 # instead, volumes are activate individually later
418}
419
420sub deactivate_storage {
421 my ($class, $storeid, $scfg, $cache) = @_;
422
423 my $cmd = ['/sbin/vgchange', '-aln', $scfg->{vgname}];
424 run_command($cmd, errmsg => "can't deactivate VG '$scfg->{vgname}'");
425}
426
427sub activate_volume {
428 my ($class, $storeid, $scfg, $volname, $exclusive, $cache) = @_;
429
430 my $path = $class->path($scfg, $volname);
431
432 my $lvm_activate_mode = $exclusive ? 'ey' : 'ly';
433
434 my $cmd = ['/sbin/lvchange', "-a$lvm_activate_mode", $path];
435 run_command($cmd, errmsg => "can't activate LV '$path'");
436}
437
438sub deactivate_volume {
439 my ($class, $storeid, $scfg, $volname, $cache) = @_;
440
441 my $path = $class->path($scfg, $volname);
442 return if ! -b $path;
443
444 my $cmd = ['/sbin/lvchange', '-aln', $path];
445 run_command($cmd, errmsg => "can't deactivate LV '$path'");
446}
447
530defb6
AD
448sub volume_resize {
449 my ($class, $scfg, $storeid, $volname, $size, $running) = @_;
450
451 $size = ($size/1024/1024) . "M";
452
453 my $path = $class->path($scfg, $volname);
454 my $cmd = ['/sbin/lvextend', '-L', $size, $path];
455 run_command($cmd, errmsg => "error resizing volume '$path'");
456
457 return 1;
458}
459
33818d16 460sub volume_snapshot {
f5640e7d 461 my ($class, $scfg, $storeid, $volname, $snap) = @_;
33818d16
AD
462
463 die "lvm snapshot is not implemented";
464}
465
051e85b8
AD
466sub volume_snapshot_rollback {
467 my ($class, $scfg, $storeid, $volname, $snap) = @_;
468
469 die "lvm snapshot rollback is not implemented";
470}
471
f57e796b
AD
472sub volume_snapshot_delete {
473 my ($class, $scfg, $storeid, $volname, $snap) = @_;
474
475 die "lvm snapshot delete is not implemented";
476}
477
f7d4064f
AD
478sub volume_has_feature {
479 my ($class, $scfg, $feature, $storeid, $volname, $snapname, $running) = @_;
480
9bb4abf6
AD
481 my $features = {
482 copy => { base => 1, current => 1},
483 };
484
485 my ($vtype, $name, $vmid, $basename, $basevmid, $isBase) =
486 $class->parse_volname($volname);
487
488 my $key = undef;
489 if($snapname){
2c5a7097 490 $key = 'snap';
9bb4abf6
AD
491 }else{
492 $key = $isBase ? 'base' : 'current';
493 }
494 return 1 if $features->{$feature}->{$key};
495
f7d4064f
AD
496 return undef;
497}
498
1dc01b9f 4991;