]> git.proxmox.com Git - pve-storage.git/blame - PVE/Storage.pm
bump version to 4.0-12
[pve-storage.git] / PVE / Storage.pm
CommitLineData
b6cf0a66
DM
1package PVE::Storage;
2
3use strict;
ffd6f2f3
DM
4use warnings;
5
b6cf0a66
DM
6use POSIX;
7use IO::Select;
b6cf0a66 8use IO::File;
b6cf0a66
DM
9use File::Basename;
10use File::Path;
b6cf0a66 11use Cwd 'abs_path';
7a2d5c1a 12use Socket;
b6cf0a66 13
1dc01b9f
DM
14use PVE::Tools qw(run_command file_read_firstline);
15use PVE::Cluster qw(cfs_read_file cfs_lock_file);
b6cf0a66
DM
16use PVE::Exception qw(raise_param_exc);
17use PVE::JSONSchema;
18use PVE::INotify;
88c3abaf 19use PVE::RPCEnvironment;
b6cf0a66 20
1dc01b9f
DM
21use PVE::Storage::Plugin;
22use PVE::Storage::DirPlugin;
23use PVE::Storage::LVMPlugin;
24use PVE::Storage::NFSPlugin;
25use PVE::Storage::ISCSIPlugin;
0509010d 26use PVE::Storage::RBDPlugin;
caf1960c 27use PVE::Storage::SheepdogPlugin;
86616554 28use PVE::Storage::ISCSIDirectPlugin;
f4648aef 29use PVE::Storage::GlusterfsPlugin;
85fda4dd 30use PVE::Storage::ZFSPoolPlugin;
4f914e6e 31use PVE::Storage::ZFSPlugin;
14770890 32use PVE::Storage::DRBDPlugin;
b6cf0a66 33
1dc01b9f
DM
34# load and initialize all plugins
35PVE::Storage::DirPlugin->register();
36PVE::Storage::LVMPlugin->register();
37PVE::Storage::NFSPlugin->register();
38PVE::Storage::ISCSIPlugin->register();
0509010d 39PVE::Storage::RBDPlugin->register();
caf1960c 40PVE::Storage::SheepdogPlugin->register();
86616554 41PVE::Storage::ISCSIDirectPlugin->register();
f4648aef 42PVE::Storage::GlusterfsPlugin->register();
85fda4dd 43PVE::Storage::ZFSPoolPlugin->register();
4f914e6e 44PVE::Storage::ZFSPlugin->register();
14770890 45PVE::Storage::DRBDPlugin->register();
1dc01b9f 46PVE::Storage::Plugin->init();
b6cf0a66 47
1dc01b9f 48my $UDEVADM = '/sbin/udevadm';
b6cf0a66 49
1dc01b9f 50# PVE::Storage utility functions
b6cf0a66
DM
51
52sub config {
53 return cfs_read_file("storage.cfg");
54}
55
b6cf0a66
DM
56sub lock_storage_config {
57 my ($code, $errmsg) = @_;
58
59 cfs_lock_file("storage.cfg", undef, $code);
60 my $err = $@;
61 if ($err) {
62 $errmsg ? die "$errmsg: $err" : die $err;
63 }
64}
65
b6cf0a66
DM
66sub storage_config {
67 my ($cfg, $storeid, $noerr) = @_;
68
69 die "no storage id specified\n" if !$storeid;
1a3459ac 70
b6cf0a66
DM
71 my $scfg = $cfg->{ids}->{$storeid};
72
73 die "storage '$storeid' does not exists\n" if (!$noerr && !$scfg);
74
75 return $scfg;
76}
77
78sub storage_check_node {
79 my ($cfg, $storeid, $node, $noerr) = @_;
80
1dc01b9f 81 my $scfg = storage_config($cfg, $storeid);
b6cf0a66
DM
82
83 if ($scfg->{nodes}) {
84 $node = PVE::INotify::nodename() if !$node || ($node eq 'localhost');
85 if (!$scfg->{nodes}->{$node}) {
da156fb3 86 die "storage '$storeid' is not available on node '$node'\n" if !$noerr;
b6cf0a66
DM
87 return undef;
88 }
89 }
90
91 return $scfg;
92}
93
94sub storage_check_enabled {
95 my ($cfg, $storeid, $node, $noerr) = @_;
96
1dc01b9f 97 my $scfg = storage_config($cfg, $storeid);
b6cf0a66
DM
98
99 if ($scfg->{disable}) {
100 die "storage '$storeid' is disabled\n" if !$noerr;
101 return undef;
102 }
103
104 return storage_check_node($cfg, $storeid, $node, $noerr);
105}
106
107sub storage_ids {
108 my ($cfg) = @_;
109
1dc01b9f 110 return keys %{$cfg->{ids}};
b6cf0a66
DM
111}
112
1dc01b9f
DM
113sub file_size_info {
114 my ($filename, $timeout) = @_;
b6cf0a66 115
1dc01b9f 116 return PVE::Storage::Plugin::file_size_info($filename, $timeout);
b6cf0a66
DM
117}
118
20ccac1b
AD
119sub volume_size_info {
120 my ($cfg, $volid, $timeout) = @_;
121
f18199e5
DM
122 my ($storeid, $volname) = parse_volume_id($volid, 1);
123 if ($storeid) {
124 my $scfg = storage_config($cfg, $storeid);
125 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
126 return $plugin->volume_size_info($scfg, $storeid, $volname, $timeout);
127 } elsif ($volid =~ m|^(/.+)$| && -e $volid) {
128 return file_size_info($volid, $timeout);
129 } else {
130 return 0;
131 }
20ccac1b
AD
132}
133
7e6c05dc
AD
134sub volume_resize {
135 my ($cfg, $volid, $size, $running) = @_;
136
137 my ($storeid, $volname) = parse_volume_id($volid, 1);
138 if ($storeid) {
139 my $scfg = storage_config($cfg, $storeid);
140 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
141 return $plugin->volume_resize($scfg, $storeid, $volname, $size, $running);
142 } elsif ($volid =~ m|^(/.+)$| && -e $volid) {
f824c722 143 die "resize file/device '$volid' is not possible\n";
7e6c05dc 144 } else {
f824c722 145 die "unable to parse volume ID '$volid'\n";
7e6c05dc
AD
146 }
147}
148
1597f1f9
WL
149sub volume_rollback_is_possible {
150 my ($cfg, $volid, $snap) = @_;
e0852ba7 151
1597f1f9
WL
152 my ($storeid, $volname) = parse_volume_id($volid, 1);
153 if ($storeid) {
154 my $scfg = storage_config($cfg, $storeid);
155 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
156 return $plugin->volume_rollback_is_possible($scfg, $storeid, $volname, $snap);
157 } elsif ($volid =~ m|^(/.+)$| && -e $volid) {
f824c722 158 die "snapshot rollback file/device '$volid' is not possible\n";
1597f1f9 159 } else {
f824c722 160 die "unable to parse volume ID '$volid'\n";
1597f1f9
WL
161 }
162}
163
db60719c 164sub volume_snapshot {
f5640e7d 165 my ($cfg, $volid, $snap) = @_;
db60719c
AD
166
167 my ($storeid, $volname) = parse_volume_id($volid, 1);
168 if ($storeid) {
169 my $scfg = storage_config($cfg, $storeid);
170 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
f5640e7d 171 return $plugin->volume_snapshot($scfg, $storeid, $volname, $snap);
db60719c 172 } elsif ($volid =~ m|^(/.+)$| && -e $volid) {
f824c722 173 die "snapshot file/device '$volid' is not possible\n";
db60719c 174 } else {
f824c722 175 die "unable to parse volume ID '$volid'\n";
db60719c
AD
176 }
177}
178
22a2a633
AD
179sub volume_snapshot_rollback {
180 my ($cfg, $volid, $snap) = @_;
181
182 my ($storeid, $volname) = parse_volume_id($volid, 1);
183 if ($storeid) {
184 my $scfg = storage_config($cfg, $storeid);
185 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
b3f302c6 186 $plugin->volume_rollback_is_possible($scfg, $storeid, $volname, $snap);
22a2a633
AD
187 return $plugin->volume_snapshot_rollback($scfg, $storeid, $volname, $snap);
188 } elsif ($volid =~ m|^(/.+)$| && -e $volid) {
f824c722 189 die "snapshot rollback file/device '$volid' is not possible\n";
22a2a633 190 } else {
f824c722 191 die "unable to parse volume ID '$volid'\n";
22a2a633
AD
192 }
193}
194
5753c9d1
AD
195sub volume_snapshot_delete {
196 my ($cfg, $volid, $snap, $running) = @_;
197
198 my ($storeid, $volname) = parse_volume_id($volid, 1);
199 if ($storeid) {
200 my $scfg = storage_config($cfg, $storeid);
201 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
27cc55d4 202 return $plugin->volume_snapshot_delete($scfg, $storeid, $volname, $snap, $running);
5753c9d1 203 } elsif ($volid =~ m|^(/.+)$| && -e $volid) {
f824c722 204 die "snapshot delete file/device '$volid' is not possible\n";
5753c9d1 205 } else {
f824c722 206 die "unable to parse volume ID '$volid'\n";
5753c9d1
AD
207 }
208}
209
99473759
AD
210sub volume_has_feature {
211 my ($cfg, $feature, $volid, $snap, $running) = @_;
212
213 my ($storeid, $volname) = parse_volume_id($volid, 1);
214 if ($storeid) {
215 my $scfg = storage_config($cfg, $storeid);
216 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
217 return $plugin->volume_has_feature($scfg, $feature, $storeid, $volname, $snap, $running);
218 } elsif ($volid =~ m|^(/.+)$| && -e $volid) {
219 return undef;
220 } else {
221 return undef;
222 }
223}
224
1dc01b9f
DM
225sub get_image_dir {
226 my ($cfg, $storeid, $vmid) = @_;
b6cf0a66 227
1dc01b9f
DM
228 my $scfg = storage_config($cfg, $storeid);
229 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
b6cf0a66 230
1dc01b9f 231 my $path = $plugin->get_subdir($scfg, 'images');
b6cf0a66 232
1dc01b9f 233 return $vmid ? "$path/$vmid" : $path;
b6cf0a66
DM
234}
235
1dc01b9f 236sub get_private_dir {
b6cf0a66
DM
237 my ($cfg, $storeid, $vmid) = @_;
238
1dc01b9f
DM
239 my $scfg = storage_config($cfg, $storeid);
240 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
b6cf0a66 241
1dc01b9f 242 my $path = $plugin->get_subdir($scfg, 'rootdir');
d22a6133 243
1dc01b9f 244 return $vmid ? "$path/$vmid" : $path;
d22a6133
DM
245}
246
b6cf0a66
DM
247sub get_iso_dir {
248 my ($cfg, $storeid) = @_;
249
1dc01b9f
DM
250 my $scfg = storage_config($cfg, $storeid);
251 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
b6cf0a66 252
1dc01b9f 253 return $plugin->get_subdir($scfg, 'iso');
b6cf0a66
DM
254}
255
256sub get_vztmpl_dir {
257 my ($cfg, $storeid) = @_;
258
1dc01b9f
DM
259 my $scfg = storage_config($cfg, $storeid);
260 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
b6cf0a66 261
1dc01b9f 262 return $plugin->get_subdir($scfg, 'vztmpl');
b6cf0a66
DM
263}
264
568de3d1
DM
265sub get_backup_dir {
266 my ($cfg, $storeid) = @_;
267
1dc01b9f
DM
268 my $scfg = storage_config($cfg, $storeid);
269 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
b6cf0a66 270
1dc01b9f 271 return $plugin->get_subdir($scfg, 'backup');
b6cf0a66
DM
272}
273
274# library implementation
275
b6cf0a66
DM
276sub parse_vmid {
277 my $vmid = shift;
278
279 die "VMID '$vmid' contains illegal characters\n" if $vmid !~ m/^\d+$/;
280
281 return int($vmid);
282}
283
ec4b0dc7
AD
284sub parse_volname {
285 my ($cfg, $volid) = @_;
286
287 my ($storeid, $volname) = parse_volume_id($volid);
288
289 my $scfg = storage_config($cfg, $storeid);
290
291 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
292 return $plugin->parse_volname($volname);
293}
294
b6cf0a66
DM
295sub parse_volume_id {
296 my ($volid, $noerr) = @_;
297
a7f3d909 298 return PVE::Storage::Plugin::parse_volume_id($volid, $noerr);
b6cf0a66
DM
299}
300
ad27ee3e
DM
301sub volume_is_base {
302 my ($cfg, $volid) = @_;
303
304 my ($sid, $volname) = parse_volume_id($volid, 1);
305 return 0 if !$sid;
306
307 if (my $scfg = $cfg->{ids}->{$sid}) {
308 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
1a3459ac 309 my ($vtype, $name, $vmid, $basename, $basevmid, $isBase) =
ad27ee3e
DM
310 $plugin->parse_volname($volname);
311 return $isBase ? 1 : 0;
312 } else {
313 # stale volid with undefined storage - so we can just guess
314 if ($volid =~ m/base-/) {
315 return 1;
316 }
317 }
318
319 return 0;
320}
321
b6cf0a66
DM
322# try to map a filesystem path to a volume identifier
323sub path_to_volume_id {
324 my ($cfg, $path) = @_;
325
326 my $ids = $cfg->{ids};
327
1dc01b9f 328 my ($sid, $volname) = parse_volume_id($path, 1);
b6cf0a66 329 if ($sid) {
1dc01b9f 330 if (my $scfg = $ids->{$sid}) {
188aca38 331 if ($scfg->{path}) {
1dc01b9f
DM
332 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
333 my ($vtype, $name, $vmid) = $plugin->parse_volname($volname);
b6cf0a66
DM
334 return ($vtype, $path);
335 }
336 }
337 return ('');
338 }
339
1a3459ac 340 # Note: abs_path() return undef if $path doesn not exist
75d75990
DM
341 # for example when nfs storage is not mounted
342 $path = abs_path($path) || $path;
b6cf0a66
DM
343
344 foreach my $sid (keys %$ids) {
1dc01b9f
DM
345 my $scfg = $ids->{$sid};
346 next if !$scfg->{path};
347 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
348 my $imagedir = $plugin->get_subdir($scfg, 'images');
349 my $isodir = $plugin->get_subdir($scfg, 'iso');
350 my $tmpldir = $plugin->get_subdir($scfg, 'vztmpl');
351 my $backupdir = $plugin->get_subdir($scfg, 'backup');
352 my $privatedir = $plugin->get_subdir($scfg, 'rootdir');
b6cf0a66
DM
353
354 if ($path =~ m!^$imagedir/(\d+)/([^/\s]+)$!) {
355 my $vmid = $1;
356 my $name = $2;
fcbec654
DM
357
358 my $vollist = $plugin->list_images($sid, $scfg, $vmid);
359 foreach my $info (@$vollist) {
360 my ($storeid, $volname) = parse_volume_id($info->{volid});
361 my $volpath = $plugin->path($scfg, $volname, $storeid);
362 if ($volpath eq $path) {
363 return ('images', $info->{volid});
364 }
365 }
b6cf0a66
DM
366 } elsif ($path =~ m!^$isodir/([^/]+\.[Ii][Ss][Oo])$!) {
367 my $name = $1;
1a3459ac 368 return ('iso', "$sid:iso/$name");
b6cf0a66
DM
369 } elsif ($path =~ m!^$tmpldir/([^/]+\.tar\.gz)$!) {
370 my $name = $1;
371 return ('vztmpl', "$sid:vztmpl/$name");
1ac17c74
DM
372 } elsif ($path =~ m!^$privatedir/(\d+)$!) {
373 my $vmid = $1;
374 return ('rootdir', "$sid:rootdir/$vmid");
a22854e5 375 } elsif ($path =~ m!^$backupdir/([^/]+\.(tar|tar\.gz|tar\.lzo|tgz|vma|vma\.gz|vma\.lzo))$!) {
568de3d1 376 my $name = $1;
1a3459ac 377 return ('iso', "$sid:backup/$name");
b6cf0a66
DM
378 }
379 }
380
381 # can't map path to volume id
382 return ('');
383}
384
385sub path {
207ea852 386 my ($cfg, $volid, $snapname) = @_;
b6cf0a66 387
1dc01b9f 388 my ($storeid, $volname) = parse_volume_id($volid);
b6cf0a66 389
1dc01b9f 390 my $scfg = storage_config($cfg, $storeid);
b6cf0a66 391
1dc01b9f 392 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
207ea852 393 my ($path, $owner, $vtype) = $plugin->path($scfg, $volname, $storeid, $snapname);
2494896a 394 return wantarray ? ($path, $owner, $vtype) : $path;
b6cf0a66
DM
395}
396
35fbb2e6
DM
397sub abs_filesystem_path {
398 my ($cfg, $volid) = @_;
399
400 my $path;
401 if (PVE::Storage::parse_volume_id ($volid, 1)) {
402 PVE::Storage::activate_volumes($cfg, [ $volid ]);
403 $path = PVE::Storage::path($cfg, $volid);
404 } else {
405 if (-f $volid) {
406 my $abspath = abs_path($volid);
407 if ($abspath && $abspath =~ m|^(/.+)$|) {
408 $path = $1; # untaint any path
409 }
410 }
411 }
412
413 die "can't find file '$volid'\n" if !($path && -f $path);
414
415 return $path;
416}
417
b6cf0a66
DM
418sub storage_migrate {
419 my ($cfg, $volid, $target_host, $target_storeid, $target_volname) = @_;
420
6bf56298 421 my ($storeid, $volname) = parse_volume_id($volid);
b6cf0a66
DM
422 $target_volname = $volname if !$target_volname;
423
6bf56298 424 my $scfg = storage_config($cfg, $storeid);
b6cf0a66
DM
425
426 # no need to migrate shared content
427 return if $storeid eq $target_storeid && $scfg->{shared};
428
6bf56298 429 my $tcfg = storage_config($cfg, $target_storeid);
b6cf0a66
DM
430
431 my $target_volid = "${target_storeid}:${target_volname}";
432
433 my $errstr = "unable to migrate '$volid' to '${target_volid}' on host '$target_host'";
434
45c2ee35 435 my $sshoptions = "-o 'BatchMode=yes'";
b6cf0a66
DM
436 my $ssh = "/usr/bin/ssh $sshoptions";
437
438 local $ENV{RSYNC_RSH} = $ssh;
439
1dc01b9f
DM
440 # only implemented for file system based storage
441 if ($scfg->{path}) {
442 if ($tcfg->{path}) {
b6cf0a66 443
1dc01b9f
DM
444 my $src_plugin = PVE::Storage::Plugin->lookup($scfg->{type});
445 my $dst_plugin = PVE::Storage::Plugin->lookup($tcfg->{type});
6bf56298
DM
446 my $src = $src_plugin->path($scfg, $volname, $storeid);
447 my $dst = $dst_plugin->path($tcfg, $target_volname, $target_storeid);
b6cf0a66 448
1dc01b9f 449 my $dirname = dirname($dst);
b6cf0a66
DM
450
451 if ($tcfg->{shared}) { # we can do a local copy
1a3459ac 452
f81372ac 453 run_command(['/bin/mkdir', '-p', $dirname]);
b6cf0a66 454
1dc01b9f 455 run_command(['/bin/cp', $src, $dst]);
b6cf0a66 456
1dc01b9f 457 } else {
b6cf0a66 458
1a3459ac 459 run_command(['/usr/bin/ssh', "root\@${target_host}",
1dc01b9f 460 '/bin/mkdir', '-p', $dirname]);
b6cf0a66 461
1dc01b9f
DM
462 # we use rsync with --sparse, so we can't use --inplace,
463 # so we remove file on the target if it already exists to
464 # save space
465 my ($size, $format) = PVE::Storage::Plugin::file_size_info($src);
466 if ($format && ($format eq 'raw') && $size) {
1a3459ac 467 run_command(['/usr/bin/ssh', "root\@${target_host}",
1dc01b9f
DM
468 'rm', '-f', $dst],
469 outfunc => sub {});
470 }
b6cf0a66 471
1a3459ac 472 my $cmd = ['/usr/bin/rsync', '--progress', '--sparse', '--whole-file',
1dc01b9f 473 $src, "root\@${target_host}:$dst"];
b6cf0a66 474
1dc01b9f 475 my $percent = -1;
b6cf0a66 476
1dc01b9f
DM
477 run_command($cmd, outfunc => sub {
478 my $line = shift;
b6cf0a66 479
1dc01b9f
DM
480 if ($line =~ m/^\s*(\d+\s+(\d+)%\s.*)$/) {
481 if ($2 > $percent) {
482 $percent = $2;
483 print "rsync status: $1\n";
484 *STDOUT->flush();
485 }
486 } else {
487 print "$line\n";
488 *STDOUT->flush();
489 }
490 });
491 }
492 } else {
493 die "$errstr - target type '$tcfg->{type}' not implemented\n";
494 }
e0852ba7 495
3d621977
WL
496 } elsif ($scfg->{type} eq 'zfspool') {
497
e0852ba7 498 if ($tcfg->{type} eq 'zfspool') {
3d621977 499
e0852ba7
DM
500 die "$errstr - pool on target has not same name as source!"
501 if $tcfg->{pool} ne $scfg->{pool};
3d621977 502
e0852ba7 503 my (undef, $volname) = parse_volname($cfg, $volid);
3d621977
WL
504
505 my $zfspath = "$scfg->{pool}\/$volname";
506
e0852ba7 507 my $snap = "zfs snapshot $zfspath\@__migration__";
3d621977 508
e0852ba7 509 my $send = "zfs send -v $zfspath\@__migration__ \| ssh root\@$target_host zfs recv $zfspath";
3d621977 510
e0852ba7 511 my $destroy_target = "ssh root\@$target_host zfs destroy $zfspath\@__migration__";
3d621977 512 run_command($snap);
e0852ba7 513 eval{
3d621977
WL
514 run_command($send);
515 };
516 my $err;
517 if ($err = $@){
518 run_command("zfs destroy $zfspath\@__migration__");
519 die $err;
e0852ba7
DM
520 }
521 run_command($destroy_target);
3d621977
WL
522
523 } else {
524 die "$errstr - target type $tcfg->{type} is not valid\n";
525 }
1dc01b9f
DM
526 } else {
527 die "$errstr - source type '$scfg->{type}' not implemented\n";
b6cf0a66
DM
528 }
529}
530
2502b33b 531sub vdisk_clone {
7bbc4004 532 my ($cfg, $volid, $vmid, $snap) = @_;
1a3459ac 533
2502b33b
DM
534 my ($storeid, $volname) = parse_volume_id($volid);
535
536 my $scfg = storage_config($cfg, $storeid);
537
538 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
1a3459ac 539
2502b33b
DM
540 activate_storage($cfg, $storeid);
541
542 # lock shared storage
543 return $plugin->cluster_lock_storage($storeid, $scfg->{shared}, undef, sub {
7bbc4004 544 my $volname = $plugin->clone_image($scfg, $storeid, $volname, $vmid, $snap);
2502b33b
DM
545 return "$storeid:$volname";
546 });
547}
548
549sub vdisk_create_base {
550 my ($cfg, $volid) = @_;
551
552 my ($storeid, $volname) = parse_volume_id($volid);
553
554 my $scfg = storage_config($cfg, $storeid);
555
556 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
1a3459ac 557
2502b33b
DM
558 activate_storage($cfg, $storeid);
559
560 # lock shared storage
561 return $plugin->cluster_lock_storage($storeid, $scfg->{shared}, undef, sub {
562 my $volname = $plugin->create_base($storeid, $scfg, $volname);
563 return "$storeid:$volname";
564 });
565}
566
1dc01b9f
DM
567sub vdisk_alloc {
568 my ($cfg, $storeid, $vmid, $fmt, $name, $size) = @_;
b6cf0a66 569
1dc01b9f 570 die "no storage id specified\n" if !$storeid;
b6cf0a66 571
1dc01b9f 572 PVE::JSONSchema::parse_storage_id($storeid);
b6cf0a66 573
1dc01b9f 574 my $scfg = storage_config($cfg, $storeid);
b6cf0a66 575
1dc01b9f 576 die "no VMID specified\n" if !$vmid;
b6cf0a66 577
1dc01b9f 578 $vmid = parse_vmid($vmid);
b6cf0a66 579
1dc01b9f 580 my $defformat = PVE::Storage::Plugin::default_format($scfg);
b6cf0a66 581
1dc01b9f 582 $fmt = $defformat if !$fmt;
b6cf0a66 583
1dc01b9f 584 activate_storage($cfg, $storeid);
3af60e62 585
1dc01b9f 586 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
b6cf0a66 587
1dc01b9f
DM
588 # lock shared storage
589 return $plugin->cluster_lock_storage($storeid, $scfg->{shared}, undef, sub {
590 my $volname = $plugin->alloc_image($storeid, $scfg, $vmid, $fmt, $name, $size);
591 return "$storeid:$volname";
592 });
b6cf0a66
DM
593}
594
1dc01b9f
DM
595sub vdisk_free {
596 my ($cfg, $volid) = @_;
b6cf0a66 597
1dc01b9f 598 my ($storeid, $volname) = parse_volume_id($volid);
b6cf0a66 599
1dc01b9f 600 my $scfg = storage_config($cfg, $storeid);
b6cf0a66 601
1dc01b9f 602 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
1a3459ac 603
1dc01b9f 604 activate_storage($cfg, $storeid);
b6cf0a66 605
1dc01b9f 606 my $cleanup_worker;
b6cf0a66 607
1dc01b9f
DM
608 # lock shared storage
609 $plugin->cluster_lock_storage($storeid, $scfg->{shared}, undef, sub {
32437ed2 610
1a3459ac 611 my ($vtype, $name, $vmid, undef, undef, $isBase) =
32437ed2 612 $plugin->parse_volname($volname);
32437ed2
DM
613 if ($isBase) {
614 my $vollist = $plugin->list_images($storeid, $scfg);
615 foreach my $info (@$vollist) {
616 my (undef, $tmpvolname) = parse_volume_id($info->{volid});
f104d1dd
AD
617 my $basename = undef;
618 my $basevmid = undef;
32437ed2 619
f104d1dd 620 eval{
1a3459ac 621 (undef, undef, undef, $basename, $basevmid) =
f104d1dd
AD
622 $plugin->parse_volname($tmpvolname);
623 };
32437ed2 624
ff00afd7 625 if ($basename && defined($basevmid) && $basevmid == $vmid && $basename eq $name) {
32437ed2
DM
626 die "base volume '$volname' is still in use " .
627 "(use by '$tmpvolname')\n";
628 }
629 }
630 }
399ab2b6 631 $cleanup_worker = $plugin->free_image($storeid, $scfg, $volname, $isBase);
1dc01b9f 632 });
b6cf0a66 633
1dc01b9f 634 return if !$cleanup_worker;
b6cf0a66 635
1dc01b9f
DM
636 my $rpcenv = PVE::RPCEnvironment::get();
637 my $authuser = $rpcenv->get_user();
b6cf0a66 638
1dc01b9f 639 $rpcenv->fork_worker('imgdel', undef, $authuser, $cleanup_worker);
b6cf0a66
DM
640}
641
b6cf0a66
DM
642#list iso or openvz template ($tt = <iso|vztmpl|backup>)
643sub template_list {
644 my ($cfg, $storeid, $tt) = @_;
645
1a3459ac
DM
646 die "unknown template type '$tt'\n"
647 if !($tt eq 'iso' || $tt eq 'vztmpl' || $tt eq 'backup');
b6cf0a66
DM
648
649 my $ids = $cfg->{ids};
650
651 storage_check_enabled($cfg, $storeid) if ($storeid);
652
653 my $res = {};
654
655 # query the storage
656
657 foreach my $sid (keys %$ids) {
658 next if $storeid && $storeid ne $sid;
659
660 my $scfg = $ids->{$sid};
661 my $type = $scfg->{type};
662
663 next if !storage_check_enabled($cfg, $sid, undef, 1);
664
665 next if $tt eq 'iso' && !$scfg->{content}->{iso};
666 next if $tt eq 'vztmpl' && !$scfg->{content}->{vztmpl};
667 next if $tt eq 'backup' && !$scfg->{content}->{backup};
668
1dc01b9f 669 activate_storage($cfg, $sid);
b6cf0a66 670
1dc01b9f
DM
671 if ($scfg->{path}) {
672 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
b6cf0a66 673
1dc01b9f 674 my $path = $plugin->get_subdir($scfg, $tt);
b6cf0a66
DM
675
676 foreach my $fn (<$path/*>) {
677
678 my $info;
679
680 if ($tt eq 'iso') {
681 next if $fn !~ m!/([^/]+\.[Ii][Ss][Oo])$!;
682
683 $info = { volid => "$sid:iso/$1", format => 'iso' };
684
685 } elsif ($tt eq 'vztmpl') {
13d2cb79 686 next if $fn !~ m!/([^/]+\.tar\.([gx]z))$!;
b6cf0a66 687
13d2cb79 688 $info = { volid => "$sid:vztmpl/$1", format => "t$2" };
b6cf0a66
DM
689
690 } elsif ($tt eq 'backup') {
a22854e5 691 next if $fn !~ m!/([^/]+\.(tar|tar\.gz|tar\.lzo|tgz|vma|vma\.gz|vma\.lzo))$!;
1a3459ac 692
b6cf0a66
DM
693 $info = { volid => "$sid:backup/$1", format => $2 };
694 }
695
696 $info->{size} = -s $fn;
697
698 push @{$res->{$sid}}, $info;
699 }
700
701 }
702
703 @{$res->{$sid}} = sort {lc($a->{volid}) cmp lc ($b->{volid}) } @{$res->{$sid}} if $res->{$sid};
704 }
705
706 return $res;
707}
708
20ccac1b 709
b6cf0a66
DM
710sub vdisk_list {
711 my ($cfg, $storeid, $vmid, $vollist) = @_;
712
713 my $ids = $cfg->{ids};
714
715 storage_check_enabled($cfg, $storeid) if ($storeid);
716
717 my $res = {};
718
719 # prepare/activate/refresh all storages
720
b6cf0a66
DM
721 my $storage_list = [];
722 if ($vollist) {
723 foreach my $volid (@$vollist) {
1dc01b9f
DM
724 my ($sid, undef) = parse_volume_id($volid);
725 next if !defined($ids->{$sid});
b6cf0a66
DM
726 next if !storage_check_enabled($cfg, $sid, undef, 1);
727 push @$storage_list, $sid;
b6cf0a66
DM
728 }
729 } else {
730 foreach my $sid (keys %$ids) {
731 next if $storeid && $storeid ne $sid;
732 next if !storage_check_enabled($cfg, $sid, undef, 1);
733 push @$storage_list, $sid;
b6cf0a66
DM
734 }
735 }
736
1dc01b9f 737 my $cache = {};
b6cf0a66 738
1dc01b9f 739 activate_storage_list($cfg, $storage_list, $cache);
b6cf0a66
DM
740
741 foreach my $sid (keys %$ids) {
1dc01b9f
DM
742 next if $storeid && $storeid ne $sid;
743 next if !storage_check_enabled($cfg, $sid, undef, 1);
b6cf0a66 744
1dc01b9f
DM
745 my $scfg = $ids->{$sid};
746 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
747 $res->{$sid} = $plugin->list_images($sid, $scfg, $vmid, $vollist, $cache);
b6cf0a66
DM
748 @{$res->{$sid}} = sort {lc($a->{volid}) cmp lc ($b->{volid}) } @{$res->{$sid}} if $res->{$sid};
749 }
750
751 return $res;
752}
753
b6cf0a66
DM
754sub uevent_seqnum {
755
756 my $filename = "/sys/kernel/uevent_seqnum";
757
758 my $seqnum = 0;
1dc01b9f 759 if (my $fh = IO::File->new($filename, "r")) {
b6cf0a66
DM
760 my $line = <$fh>;
761 if ($line =~ m/^(\d+)$/) {
1dc01b9f 762 $seqnum = int($1);
b6cf0a66
DM
763 }
764 close ($fh);
765 }
766 return $seqnum;
767}
768
f3d4ef46 769sub activate_storage {
1dc01b9f 770 my ($cfg, $storeid, $cache) = @_;
b6cf0a66 771
f3d4ef46
DM
772 $cache = {} if !$cache;
773
b6cf0a66
DM
774 my $scfg = storage_check_enabled($cfg, $storeid);
775
1dc01b9f 776 return if $cache->{activated}->{$storeid};
b6cf0a66 777
1dc01b9f 778 $cache->{uevent_seqnum} = uevent_seqnum() if !$cache->{uevent_seqnum};
b6cf0a66 779
1dc01b9f 780 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
b6cf0a66 781
1dc01b9f
DM
782 if ($scfg->{base}) {
783 my ($baseid, undef) = parse_volume_id ($scfg->{base});
f3d4ef46
DM
784 activate_storage($cfg, $baseid, $cache);
785 }
786
787 if (!$plugin->check_connection($storeid, $scfg)) {
788 die "storage '$storeid' is not online\n";
b6cf0a66
DM
789 }
790
1dc01b9f
DM
791 $plugin->activate_storage($storeid, $scfg, $cache);
792
b6cf0a66
DM
793 my $newseq = uevent_seqnum ();
794
795 # only call udevsettle if there are events
1dc01b9f 796 if ($newseq > $cache->{uevent_seqnum}) {
b6cf0a66
DM
797 my $timeout = 30;
798 system ("$UDEVADM settle --timeout=$timeout"); # ignore errors
1dc01b9f 799 $cache->{uevent_seqnum} = $newseq;
b6cf0a66
DM
800 }
801
1dc01b9f 802 $cache->{activated}->{$storeid} = 1;
b6cf0a66
DM
803}
804
805sub activate_storage_list {
1dc01b9f 806 my ($cfg, $storeid_list, $cache) = @_;
b6cf0a66 807
1dc01b9f 808 $cache = {} if !$cache;
b6cf0a66
DM
809
810 foreach my $storeid (@$storeid_list) {
f3d4ef46 811 activate_storage($cfg, $storeid, $cache);
b6cf0a66
DM
812 }
813}
814
1dc01b9f
DM
815sub deactivate_storage {
816 my ($cfg, $storeid) = @_;
817
818 my $scfg = storage_config ($cfg, $storeid);
819 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
b6cf0a66 820
1dc01b9f
DM
821 my $cache = {};
822 $plugin->deactivate_storage($storeid, $scfg, $cache);
b6cf0a66
DM
823}
824
825sub activate_volumes {
6703353b
DM
826 my ($cfg, $vollist, $exclusive) = @_;
827
828 return if !($vollist && scalar(@$vollist));
829
b6cf0a66
DM
830 my $storagehash = {};
831 foreach my $volid (@$vollist) {
1dc01b9f 832 my ($storeid, undef) = parse_volume_id($volid);
b6cf0a66
DM
833 $storagehash->{$storeid} = 1;
834 }
835
1dc01b9f
DM
836 my $cache = {};
837
838 activate_storage_list($cfg, [keys %$storagehash], $cache);
b6cf0a66
DM
839
840 foreach my $volid (@$vollist) {
5521b580 841 my ($storeid, $volname) = parse_volume_id($volid);
1dc01b9f
DM
842 my $scfg = storage_config($cfg, $storeid);
843 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
844 $plugin->activate_volume($storeid, $scfg, $volname, $exclusive, $cache);
b6cf0a66
DM
845 }
846}
847
848sub deactivate_volumes {
849 my ($cfg, $vollist) = @_;
850
6703353b
DM
851 return if !($vollist && scalar(@$vollist));
852
1dc01b9f
DM
853 my $cache = {};
854
6703353b 855 my @errlist = ();
b6cf0a66 856 foreach my $volid (@$vollist) {
1dc01b9f 857 my ($storeid, $volname) = parse_volume_id($volid);
b6cf0a66 858
1dc01b9f
DM
859 my $scfg = storage_config($cfg, $storeid);
860 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
1a3459ac 861
1dc01b9f
DM
862 eval {
863 $plugin->deactivate_volume($storeid, $scfg, $volname, $cache);
864 };
865 if (my $err = $@) {
866 warn $err;
867 push @errlist, $volid;
b6cf0a66
DM
868 }
869 }
6703353b
DM
870
871 die "volume deativation failed: " . join(' ', @errlist)
872 if scalar(@errlist);
b6cf0a66
DM
873}
874
1a3459ac 875sub storage_info {
b6cf0a66
DM
876 my ($cfg, $content) = @_;
877
878 my $ids = $cfg->{ids};
879
880 my $info = {};
b6cf0a66
DM
881
882 my $slist = [];
883 foreach my $storeid (keys %$ids) {
884
885 next if $content && !$ids->{$storeid}->{content}->{$content};
886
887 next if !storage_check_enabled($cfg, $storeid, undef, 1);
888
889 my $type = $ids->{$storeid}->{type};
890
1a3459ac 891 $info->{$storeid} = {
b6cf0a66 892 type => $type,
1a3459ac
DM
893 total => 0,
894 avail => 0,
895 used => 0,
04a2e4f3 896 shared => $ids->{$storeid}->{shared} ? 1 : 0,
1dc01b9f 897 content => PVE::Storage::Plugin::content_hash_to_string($ids->{$storeid}->{content}),
b6cf0a66
DM
898 active => 0,
899 };
900
b6cf0a66
DM
901 push @$slist, $storeid;
902 }
903
1dc01b9f 904 my $cache = {};
b6cf0a66 905
b6cf0a66
DM
906 foreach my $storeid (keys %$ids) {
907 my $scfg = $ids->{$storeid};
b6cf0a66
DM
908 next if !$info->{$storeid};
909
f3d4ef46
DM
910 eval { activate_storage($cfg, $storeid, $cache); };
911 if (my $err = $@) {
912 warn $err;
913 next;
914 }
915
1dc01b9f 916 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
7028645e
DM
917 my ($total, $avail, $used, $active);
918 eval { ($total, $avail, $used, $active) = $plugin->status($storeid, $scfg, $cache); };
919 warn $@ if $@;
1dc01b9f 920 next if !$active;
1a3459ac
DM
921 $info->{$storeid}->{total} = $total;
922 $info->{$storeid}->{avail} = $avail;
923 $info->{$storeid}->{used} = $used;
1dc01b9f 924 $info->{$storeid}->{active} = $active;
b6cf0a66
DM
925 }
926
927 return $info;
928}
929
930sub resolv_server {
931 my ($server) = @_;
1a3459ac 932
c67daeac
WB
933 my ($packed_ip, $family);
934 eval {
935 my @res = PVE::Tools::getaddrinfo_all($server);
936 $family = $res[0]->{family};
937 $packed_ip = (PVE::Tools::unpack_sockaddr_in46($res[0]->{addr}))[2];
938 };
b6cf0a66 939 if (defined $packed_ip) {
ee302b1c 940 return Socket::inet_ntop($family, $packed_ip);
b6cf0a66
DM
941 }
942 return undef;
943}
944
945sub scan_nfs {
946 my ($server_in) = @_;
947
948 my $server;
949 if (!($server = resolv_server ($server_in))) {
950 die "unable to resolve address for server '${server_in}'\n";
951 }
952
953 my $cmd = ['/sbin/showmount', '--no-headers', '--exports', $server];
954
955 my $res = {};
f81372ac 956 run_command($cmd, outfunc => sub {
b6cf0a66
DM
957 my $line = shift;
958
959 # note: howto handle white spaces in export path??
960 if ($line =~ m!^(/\S+)\s+(.+)$!) {
961 $res->{$1} = $2;
962 }
963 });
964
965 return $res;
966}
967
584d97f6
DM
968sub scan_zfs {
969
970 my $cmd = ['zpool', 'list', '-H', '-o', 'name,size,free'];
971
972 my $res = [];
973 run_command($cmd, outfunc => sub {
974 my $line = shift;
975
976 if ($line =~m/^(\S+)\s+(\S+)\s+(\S+)$/) {
977 my ($pool, $size_str, $free_str) = ($1, $2, $3);
978 my $size = PVE::Storage::ZFSPoolPlugin::zfs_parse_size($size_str);
979 my $free = PVE::Storage::ZFSPoolPlugin::zfs_parse_size($free_str);
980 push @$res, { pool => $pool, size => $size, free => $free };
981 }
982 });
983
984 return $res;
985}
986
b6cf0a66
DM
987sub resolv_portal {
988 my ($portal, $noerr) = @_;
989
990 if ($portal =~ m/^([^:]+)(:(\d+))?$/) {
991 my $server = $1;
992 my $port = $3;
993
994 if (my $ip = resolv_server($server)) {
995 $server = $ip;
996 return $port ? "$server:$port" : $server;
997 }
998 }
999 return undef if $noerr;
1000
1001 raise_param_exc({ portal => "unable to resolve portal address '$portal'" });
1002}
1003
1004# idea is from usbutils package (/usr/bin/usb-devices) script
1005sub __scan_usb_device {
1006 my ($res, $devpath, $parent, $level) = @_;
1007
1008 return if ! -d $devpath;
1009 return if $level && $devpath !~ m/^.*[-.](\d+)$/;
1010 my $port = $level ? int($1 - 1) : 0;
1011
1012 my $busnum = int(file_read_firstline("$devpath/busnum"));
1013 my $devnum = int(file_read_firstline("$devpath/devnum"));
1014
1015 my $d = {
1016 port => $port,
1017 level => $level,
1018 busnum => $busnum,
1019 devnum => $devnum,
1020 speed => file_read_firstline("$devpath/speed"),
1021 class => hex(file_read_firstline("$devpath/bDeviceClass")),
1022 vendid => file_read_firstline("$devpath/idVendor"),
1023 prodid => file_read_firstline("$devpath/idProduct"),
1024 };
1025
1026 if ($level) {
1027 my $usbpath = $devpath;
1028 $usbpath =~ s|^.*/\d+\-||;
1029 $d->{usbpath} = $usbpath;
1030 }
1031
1032 my $product = file_read_firstline("$devpath/product");
1033 $d->{product} = $product if $product;
1a3459ac 1034
b6cf0a66
DM
1035 my $manu = file_read_firstline("$devpath/manufacturer");
1036 $d->{manufacturer} = $manu if $manu;
1037
1038 my $serial => file_read_firstline("$devpath/serial");
1039 $d->{serial} = $serial if $serial;
1040
1041 push @$res, $d;
1042
1043 foreach my $subdev (<$devpath/$busnum-*>) {
1044 next if $subdev !~ m|/$busnum-[0-9]+(\.[0-9]+)*$|;
1045 __scan_usb_device($res, $subdev, $devnum, $level + 1);
1046 }
1047
1048};
1049
1050sub scan_usb {
1051
1052 my $devlist = [];
1053
1054 foreach my $device (</sys/bus/usb/devices/usb*>) {
1055 __scan_usb_device($devlist, $device, 0, 0);
1056 }
1057
1058 return $devlist;
1059}
1060
1061sub scan_iscsi {
1062 my ($portal_in) = @_;
1063
1064 my $portal;
1dc01b9f 1065 if (!($portal = resolv_portal($portal_in))) {
b6cf0a66
DM
1066 die "unable to parse/resolve portal address '${portal_in}'\n";
1067 }
1068
1dc01b9f 1069 return PVE::Storage::ISCSIPlugin::iscsi_discovery($portal);
b6cf0a66
DM
1070}
1071
1072sub storage_default_format {
1073 my ($cfg, $storeid) = @_;
1074
1075 my $scfg = storage_config ($cfg, $storeid);
1076
1dc01b9f 1077 return PVE::Storage::Plugin::default_format($scfg);
b6cf0a66
DM
1078}
1079
1080sub vgroup_is_used {
1081 my ($cfg, $vgname) = @_;
1082
1083 foreach my $storeid (keys %{$cfg->{ids}}) {
1dc01b9f 1084 my $scfg = storage_config($cfg, $storeid);
b6cf0a66
DM
1085 if ($scfg->{type} eq 'lvm' && $scfg->{vgname} eq $vgname) {
1086 return 1;
1087 }
1088 }
1089
1090 return undef;
1091}
1092
1093sub target_is_used {
1094 my ($cfg, $target) = @_;
1095
1096 foreach my $storeid (keys %{$cfg->{ids}}) {
1dc01b9f 1097 my $scfg = storage_config($cfg, $storeid);
b6cf0a66
DM
1098 if ($scfg->{type} eq 'iscsi' && $scfg->{target} eq $target) {
1099 return 1;
1100 }
1101 }
1102
1103 return undef;
1104}
1105
1106sub volume_is_used {
1107 my ($cfg, $volid) = @_;
1108
1109 foreach my $storeid (keys %{$cfg->{ids}}) {
1dc01b9f 1110 my $scfg = storage_config($cfg, $storeid);
b6cf0a66
DM
1111 if ($scfg->{base} && $scfg->{base} eq $volid) {
1112 return 1;
1113 }
1114 }
1115
1116 return undef;
1117}
1118
1119sub storage_is_used {
1120 my ($cfg, $storeid) = @_;
1121
1122 foreach my $sid (keys %{$cfg->{ids}}) {
1dc01b9f 1123 my $scfg = storage_config($cfg, $sid);
b6cf0a66 1124 next if !$scfg->{base};
1dc01b9f 1125 my ($st) = parse_volume_id($scfg->{base});
b6cf0a66
DM
1126 return 1 if $st && $st eq $storeid;
1127 }
1128
1129 return undef;
1130}
1131
1132sub foreach_volid {
1133 my ($list, $func) = @_;
1134
1135 return if !$list;
1136
1137 foreach my $sid (keys %$list) {
1138 foreach my $info (@{$list->{$sid}}) {
1139 my $volid = $info->{volid};
1dc01b9f 1140 my ($sid1, $volname) = parse_volume_id($volid, 1);
b6cf0a66
DM
1141 if ($sid1 && $sid1 eq $sid) {
1142 &$func ($volid, $sid, $info);
1143 } else {
1144 warn "detected strange volid '$volid' in volume list for '$sid'\n";
1145 }
1146 }
1147 }
1148}
1149
11501;