]> git.proxmox.com Git - pve-storage.git/blame - PVE/Storage.pm
storage_info: fix content filter
[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 {
afdfbe55
WB
590 my $old_umask = umask(umask|0037);
591 my $volname = eval { $plugin->alloc_image($storeid, $scfg, $vmid, $fmt, $name, $size) };
592 my $err = $@;
593 umask $old_umask;
594 die $err if $err;
1dc01b9f
DM
595 return "$storeid:$volname";
596 });
b6cf0a66
DM
597}
598
1dc01b9f
DM
599sub vdisk_free {
600 my ($cfg, $volid) = @_;
b6cf0a66 601
1dc01b9f 602 my ($storeid, $volname) = parse_volume_id($volid);
b6cf0a66 603
1dc01b9f 604 my $scfg = storage_config($cfg, $storeid);
b6cf0a66 605
1dc01b9f 606 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
1a3459ac 607
1dc01b9f 608 activate_storage($cfg, $storeid);
b6cf0a66 609
1dc01b9f 610 my $cleanup_worker;
b6cf0a66 611
1dc01b9f
DM
612 # lock shared storage
613 $plugin->cluster_lock_storage($storeid, $scfg->{shared}, undef, sub {
32437ed2 614
1a3459ac 615 my ($vtype, $name, $vmid, undef, undef, $isBase) =
32437ed2 616 $plugin->parse_volname($volname);
32437ed2
DM
617 if ($isBase) {
618 my $vollist = $plugin->list_images($storeid, $scfg);
619 foreach my $info (@$vollist) {
620 my (undef, $tmpvolname) = parse_volume_id($info->{volid});
f104d1dd
AD
621 my $basename = undef;
622 my $basevmid = undef;
32437ed2 623
f104d1dd 624 eval{
1a3459ac 625 (undef, undef, undef, $basename, $basevmid) =
f104d1dd
AD
626 $plugin->parse_volname($tmpvolname);
627 };
32437ed2 628
ff00afd7 629 if ($basename && defined($basevmid) && $basevmid == $vmid && $basename eq $name) {
32437ed2
DM
630 die "base volume '$volname' is still in use " .
631 "(use by '$tmpvolname')\n";
632 }
633 }
634 }
399ab2b6 635 $cleanup_worker = $plugin->free_image($storeid, $scfg, $volname, $isBase);
1dc01b9f 636 });
b6cf0a66 637
1dc01b9f 638 return if !$cleanup_worker;
b6cf0a66 639
1dc01b9f
DM
640 my $rpcenv = PVE::RPCEnvironment::get();
641 my $authuser = $rpcenv->get_user();
b6cf0a66 642
1dc01b9f 643 $rpcenv->fork_worker('imgdel', undef, $authuser, $cleanup_worker);
b6cf0a66
DM
644}
645
b6cf0a66
DM
646#list iso or openvz template ($tt = <iso|vztmpl|backup>)
647sub template_list {
648 my ($cfg, $storeid, $tt) = @_;
649
1a3459ac
DM
650 die "unknown template type '$tt'\n"
651 if !($tt eq 'iso' || $tt eq 'vztmpl' || $tt eq 'backup');
b6cf0a66
DM
652
653 my $ids = $cfg->{ids};
654
655 storage_check_enabled($cfg, $storeid) if ($storeid);
656
657 my $res = {};
658
659 # query the storage
660
661 foreach my $sid (keys %$ids) {
662 next if $storeid && $storeid ne $sid;
663
664 my $scfg = $ids->{$sid};
665 my $type = $scfg->{type};
666
667 next if !storage_check_enabled($cfg, $sid, undef, 1);
668
669 next if $tt eq 'iso' && !$scfg->{content}->{iso};
670 next if $tt eq 'vztmpl' && !$scfg->{content}->{vztmpl};
671 next if $tt eq 'backup' && !$scfg->{content}->{backup};
672
1dc01b9f 673 activate_storage($cfg, $sid);
b6cf0a66 674
1dc01b9f
DM
675 if ($scfg->{path}) {
676 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
b6cf0a66 677
1dc01b9f 678 my $path = $plugin->get_subdir($scfg, $tt);
b6cf0a66
DM
679
680 foreach my $fn (<$path/*>) {
681
682 my $info;
683
684 if ($tt eq 'iso') {
685 next if $fn !~ m!/([^/]+\.[Ii][Ss][Oo])$!;
686
687 $info = { volid => "$sid:iso/$1", format => 'iso' };
688
689 } elsif ($tt eq 'vztmpl') {
13d2cb79 690 next if $fn !~ m!/([^/]+\.tar\.([gx]z))$!;
b6cf0a66 691
13d2cb79 692 $info = { volid => "$sid:vztmpl/$1", format => "t$2" };
b6cf0a66
DM
693
694 } elsif ($tt eq 'backup') {
a22854e5 695 next if $fn !~ m!/([^/]+\.(tar|tar\.gz|tar\.lzo|tgz|vma|vma\.gz|vma\.lzo))$!;
1a3459ac 696
b6cf0a66
DM
697 $info = { volid => "$sid:backup/$1", format => $2 };
698 }
699
700 $info->{size} = -s $fn;
701
702 push @{$res->{$sid}}, $info;
703 }
704
705 }
706
707 @{$res->{$sid}} = sort {lc($a->{volid}) cmp lc ($b->{volid}) } @{$res->{$sid}} if $res->{$sid};
708 }
709
710 return $res;
711}
712
20ccac1b 713
b6cf0a66
DM
714sub vdisk_list {
715 my ($cfg, $storeid, $vmid, $vollist) = @_;
716
717 my $ids = $cfg->{ids};
718
719 storage_check_enabled($cfg, $storeid) if ($storeid);
720
721 my $res = {};
722
723 # prepare/activate/refresh all storages
724
b6cf0a66
DM
725 my $storage_list = [];
726 if ($vollist) {
727 foreach my $volid (@$vollist) {
1dc01b9f
DM
728 my ($sid, undef) = parse_volume_id($volid);
729 next if !defined($ids->{$sid});
b6cf0a66
DM
730 next if !storage_check_enabled($cfg, $sid, undef, 1);
731 push @$storage_list, $sid;
b6cf0a66
DM
732 }
733 } else {
734 foreach my $sid (keys %$ids) {
735 next if $storeid && $storeid ne $sid;
736 next if !storage_check_enabled($cfg, $sid, undef, 1);
737 push @$storage_list, $sid;
b6cf0a66
DM
738 }
739 }
740
1dc01b9f 741 my $cache = {};
b6cf0a66 742
1dc01b9f 743 activate_storage_list($cfg, $storage_list, $cache);
b6cf0a66
DM
744
745 foreach my $sid (keys %$ids) {
1dc01b9f
DM
746 next if $storeid && $storeid ne $sid;
747 next if !storage_check_enabled($cfg, $sid, undef, 1);
b6cf0a66 748
1dc01b9f
DM
749 my $scfg = $ids->{$sid};
750 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
751 $res->{$sid} = $plugin->list_images($sid, $scfg, $vmid, $vollist, $cache);
b6cf0a66
DM
752 @{$res->{$sid}} = sort {lc($a->{volid}) cmp lc ($b->{volid}) } @{$res->{$sid}} if $res->{$sid};
753 }
754
755 return $res;
756}
757
b6cf0a66
DM
758sub uevent_seqnum {
759
760 my $filename = "/sys/kernel/uevent_seqnum";
761
762 my $seqnum = 0;
1dc01b9f 763 if (my $fh = IO::File->new($filename, "r")) {
b6cf0a66
DM
764 my $line = <$fh>;
765 if ($line =~ m/^(\d+)$/) {
1dc01b9f 766 $seqnum = int($1);
b6cf0a66
DM
767 }
768 close ($fh);
769 }
770 return $seqnum;
771}
772
f3d4ef46 773sub activate_storage {
1dc01b9f 774 my ($cfg, $storeid, $cache) = @_;
b6cf0a66 775
f3d4ef46
DM
776 $cache = {} if !$cache;
777
b6cf0a66
DM
778 my $scfg = storage_check_enabled($cfg, $storeid);
779
1dc01b9f 780 return if $cache->{activated}->{$storeid};
b6cf0a66 781
1dc01b9f 782 $cache->{uevent_seqnum} = uevent_seqnum() if !$cache->{uevent_seqnum};
b6cf0a66 783
1dc01b9f 784 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
b6cf0a66 785
1dc01b9f
DM
786 if ($scfg->{base}) {
787 my ($baseid, undef) = parse_volume_id ($scfg->{base});
f3d4ef46
DM
788 activate_storage($cfg, $baseid, $cache);
789 }
790
791 if (!$plugin->check_connection($storeid, $scfg)) {
792 die "storage '$storeid' is not online\n";
b6cf0a66
DM
793 }
794
1dc01b9f
DM
795 $plugin->activate_storage($storeid, $scfg, $cache);
796
b6cf0a66
DM
797 my $newseq = uevent_seqnum ();
798
799 # only call udevsettle if there are events
1dc01b9f 800 if ($newseq > $cache->{uevent_seqnum}) {
b6cf0a66
DM
801 my $timeout = 30;
802 system ("$UDEVADM settle --timeout=$timeout"); # ignore errors
1dc01b9f 803 $cache->{uevent_seqnum} = $newseq;
b6cf0a66
DM
804 }
805
1dc01b9f 806 $cache->{activated}->{$storeid} = 1;
b6cf0a66
DM
807}
808
809sub activate_storage_list {
1dc01b9f 810 my ($cfg, $storeid_list, $cache) = @_;
b6cf0a66 811
1dc01b9f 812 $cache = {} if !$cache;
b6cf0a66
DM
813
814 foreach my $storeid (@$storeid_list) {
f3d4ef46 815 activate_storage($cfg, $storeid, $cache);
b6cf0a66
DM
816 }
817}
818
1dc01b9f
DM
819sub deactivate_storage {
820 my ($cfg, $storeid) = @_;
821
822 my $scfg = storage_config ($cfg, $storeid);
823 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
b6cf0a66 824
1dc01b9f
DM
825 my $cache = {};
826 $plugin->deactivate_storage($storeid, $scfg, $cache);
b6cf0a66
DM
827}
828
829sub activate_volumes {
6703353b
DM
830 my ($cfg, $vollist, $exclusive) = @_;
831
832 return if !($vollist && scalar(@$vollist));
833
b6cf0a66
DM
834 my $storagehash = {};
835 foreach my $volid (@$vollist) {
1dc01b9f 836 my ($storeid, undef) = parse_volume_id($volid);
b6cf0a66
DM
837 $storagehash->{$storeid} = 1;
838 }
839
1dc01b9f
DM
840 my $cache = {};
841
842 activate_storage_list($cfg, [keys %$storagehash], $cache);
b6cf0a66
DM
843
844 foreach my $volid (@$vollist) {
5521b580 845 my ($storeid, $volname) = parse_volume_id($volid);
1dc01b9f
DM
846 my $scfg = storage_config($cfg, $storeid);
847 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
848 $plugin->activate_volume($storeid, $scfg, $volname, $exclusive, $cache);
b6cf0a66
DM
849 }
850}
851
852sub deactivate_volumes {
853 my ($cfg, $vollist) = @_;
854
6703353b
DM
855 return if !($vollist && scalar(@$vollist));
856
1dc01b9f
DM
857 my $cache = {};
858
6703353b 859 my @errlist = ();
b6cf0a66 860 foreach my $volid (@$vollist) {
1dc01b9f 861 my ($storeid, $volname) = parse_volume_id($volid);
b6cf0a66 862
1dc01b9f
DM
863 my $scfg = storage_config($cfg, $storeid);
864 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
1a3459ac 865
1dc01b9f
DM
866 eval {
867 $plugin->deactivate_volume($storeid, $scfg, $volname, $cache);
868 };
869 if (my $err = $@) {
870 warn $err;
871 push @errlist, $volid;
b6cf0a66
DM
872 }
873 }
6703353b
DM
874
875 die "volume deativation failed: " . join(' ', @errlist)
876 if scalar(@errlist);
b6cf0a66
DM
877}
878
1a3459ac 879sub storage_info {
b6cf0a66
DM
880 my ($cfg, $content) = @_;
881
882 my $ids = $cfg->{ids};
883
884 my $info = {};
583c2802
DM
885
886 my @ctypes = PVE::Tools::split_list($content);
887
b6cf0a66
DM
888 my $slist = [];
889 foreach my $storeid (keys %$ids) {
890
b6cf0a66
DM
891 next if !storage_check_enabled($cfg, $storeid, undef, 1);
892
d73060be
DM
893 if (defined($content)) {
894 my $want_ctype = 0;
895 foreach my $ctype (@ctypes) {
896 if ($ids->{$storeid}->{content}->{$ctype}) {
897 $want_ctype = 1;
898 last;
899 }
583c2802 900 }
d73060be 901 next if !$want_ctype;
583c2802 902 }
d73060be 903
b6cf0a66
DM
904 my $type = $ids->{$storeid}->{type};
905
1a3459ac 906 $info->{$storeid} = {
b6cf0a66 907 type => $type,
1a3459ac
DM
908 total => 0,
909 avail => 0,
910 used => 0,
04a2e4f3 911 shared => $ids->{$storeid}->{shared} ? 1 : 0,
1dc01b9f 912 content => PVE::Storage::Plugin::content_hash_to_string($ids->{$storeid}->{content}),
b6cf0a66
DM
913 active => 0,
914 };
915
b6cf0a66
DM
916 push @$slist, $storeid;
917 }
918
1dc01b9f 919 my $cache = {};
b6cf0a66 920
b6cf0a66
DM
921 foreach my $storeid (keys %$ids) {
922 my $scfg = $ids->{$storeid};
b6cf0a66
DM
923 next if !$info->{$storeid};
924
f3d4ef46
DM
925 eval { activate_storage($cfg, $storeid, $cache); };
926 if (my $err = $@) {
927 warn $err;
928 next;
929 }
930
1dc01b9f 931 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
7028645e
DM
932 my ($total, $avail, $used, $active);
933 eval { ($total, $avail, $used, $active) = $plugin->status($storeid, $scfg, $cache); };
934 warn $@ if $@;
1dc01b9f 935 next if !$active;
1a3459ac
DM
936 $info->{$storeid}->{total} = $total;
937 $info->{$storeid}->{avail} = $avail;
938 $info->{$storeid}->{used} = $used;
1dc01b9f 939 $info->{$storeid}->{active} = $active;
b6cf0a66
DM
940 }
941
942 return $info;
943}
944
945sub resolv_server {
946 my ($server) = @_;
1a3459ac 947
c67daeac
WB
948 my ($packed_ip, $family);
949 eval {
950 my @res = PVE::Tools::getaddrinfo_all($server);
951 $family = $res[0]->{family};
952 $packed_ip = (PVE::Tools::unpack_sockaddr_in46($res[0]->{addr}))[2];
953 };
b6cf0a66 954 if (defined $packed_ip) {
ee302b1c 955 return Socket::inet_ntop($family, $packed_ip);
b6cf0a66
DM
956 }
957 return undef;
958}
959
960sub scan_nfs {
961 my ($server_in) = @_;
962
963 my $server;
964 if (!($server = resolv_server ($server_in))) {
965 die "unable to resolve address for server '${server_in}'\n";
966 }
967
968 my $cmd = ['/sbin/showmount', '--no-headers', '--exports', $server];
969
970 my $res = {};
f81372ac 971 run_command($cmd, outfunc => sub {
b6cf0a66
DM
972 my $line = shift;
973
974 # note: howto handle white spaces in export path??
975 if ($line =~ m!^(/\S+)\s+(.+)$!) {
976 $res->{$1} = $2;
977 }
978 });
979
980 return $res;
981}
982
584d97f6
DM
983sub scan_zfs {
984
985 my $cmd = ['zpool', 'list', '-H', '-o', 'name,size,free'];
986
987 my $res = [];
988 run_command($cmd, outfunc => sub {
989 my $line = shift;
990
991 if ($line =~m/^(\S+)\s+(\S+)\s+(\S+)$/) {
992 my ($pool, $size_str, $free_str) = ($1, $2, $3);
993 my $size = PVE::Storage::ZFSPoolPlugin::zfs_parse_size($size_str);
994 my $free = PVE::Storage::ZFSPoolPlugin::zfs_parse_size($free_str);
995 push @$res, { pool => $pool, size => $size, free => $free };
996 }
997 });
998
999 return $res;
1000}
1001
b6cf0a66
DM
1002sub resolv_portal {
1003 my ($portal, $noerr) = @_;
1004
1005 if ($portal =~ m/^([^:]+)(:(\d+))?$/) {
1006 my $server = $1;
1007 my $port = $3;
1008
1009 if (my $ip = resolv_server($server)) {
1010 $server = $ip;
1011 return $port ? "$server:$port" : $server;
1012 }
1013 }
1014 return undef if $noerr;
1015
1016 raise_param_exc({ portal => "unable to resolve portal address '$portal'" });
1017}
1018
1019# idea is from usbutils package (/usr/bin/usb-devices) script
1020sub __scan_usb_device {
1021 my ($res, $devpath, $parent, $level) = @_;
1022
1023 return if ! -d $devpath;
1024 return if $level && $devpath !~ m/^.*[-.](\d+)$/;
1025 my $port = $level ? int($1 - 1) : 0;
1026
1027 my $busnum = int(file_read_firstline("$devpath/busnum"));
1028 my $devnum = int(file_read_firstline("$devpath/devnum"));
1029
1030 my $d = {
1031 port => $port,
1032 level => $level,
1033 busnum => $busnum,
1034 devnum => $devnum,
1035 speed => file_read_firstline("$devpath/speed"),
1036 class => hex(file_read_firstline("$devpath/bDeviceClass")),
1037 vendid => file_read_firstline("$devpath/idVendor"),
1038 prodid => file_read_firstline("$devpath/idProduct"),
1039 };
1040
1041 if ($level) {
1042 my $usbpath = $devpath;
1043 $usbpath =~ s|^.*/\d+\-||;
1044 $d->{usbpath} = $usbpath;
1045 }
1046
1047 my $product = file_read_firstline("$devpath/product");
1048 $d->{product} = $product if $product;
1a3459ac 1049
b6cf0a66
DM
1050 my $manu = file_read_firstline("$devpath/manufacturer");
1051 $d->{manufacturer} = $manu if $manu;
1052
1053 my $serial => file_read_firstline("$devpath/serial");
1054 $d->{serial} = $serial if $serial;
1055
1056 push @$res, $d;
1057
1058 foreach my $subdev (<$devpath/$busnum-*>) {
1059 next if $subdev !~ m|/$busnum-[0-9]+(\.[0-9]+)*$|;
1060 __scan_usb_device($res, $subdev, $devnum, $level + 1);
1061 }
1062
1063};
1064
1065sub scan_usb {
1066
1067 my $devlist = [];
1068
1069 foreach my $device (</sys/bus/usb/devices/usb*>) {
1070 __scan_usb_device($devlist, $device, 0, 0);
1071 }
1072
1073 return $devlist;
1074}
1075
1076sub scan_iscsi {
1077 my ($portal_in) = @_;
1078
1079 my $portal;
1dc01b9f 1080 if (!($portal = resolv_portal($portal_in))) {
b6cf0a66
DM
1081 die "unable to parse/resolve portal address '${portal_in}'\n";
1082 }
1083
1dc01b9f 1084 return PVE::Storage::ISCSIPlugin::iscsi_discovery($portal);
b6cf0a66
DM
1085}
1086
1087sub storage_default_format {
1088 my ($cfg, $storeid) = @_;
1089
1090 my $scfg = storage_config ($cfg, $storeid);
1091
1dc01b9f 1092 return PVE::Storage::Plugin::default_format($scfg);
b6cf0a66
DM
1093}
1094
1095sub vgroup_is_used {
1096 my ($cfg, $vgname) = @_;
1097
1098 foreach my $storeid (keys %{$cfg->{ids}}) {
1dc01b9f 1099 my $scfg = storage_config($cfg, $storeid);
b6cf0a66
DM
1100 if ($scfg->{type} eq 'lvm' && $scfg->{vgname} eq $vgname) {
1101 return 1;
1102 }
1103 }
1104
1105 return undef;
1106}
1107
1108sub target_is_used {
1109 my ($cfg, $target) = @_;
1110
1111 foreach my $storeid (keys %{$cfg->{ids}}) {
1dc01b9f 1112 my $scfg = storage_config($cfg, $storeid);
b6cf0a66
DM
1113 if ($scfg->{type} eq 'iscsi' && $scfg->{target} eq $target) {
1114 return 1;
1115 }
1116 }
1117
1118 return undef;
1119}
1120
1121sub volume_is_used {
1122 my ($cfg, $volid) = @_;
1123
1124 foreach my $storeid (keys %{$cfg->{ids}}) {
1dc01b9f 1125 my $scfg = storage_config($cfg, $storeid);
b6cf0a66
DM
1126 if ($scfg->{base} && $scfg->{base} eq $volid) {
1127 return 1;
1128 }
1129 }
1130
1131 return undef;
1132}
1133
1134sub storage_is_used {
1135 my ($cfg, $storeid) = @_;
1136
1137 foreach my $sid (keys %{$cfg->{ids}}) {
1dc01b9f 1138 my $scfg = storage_config($cfg, $sid);
b6cf0a66 1139 next if !$scfg->{base};
1dc01b9f 1140 my ($st) = parse_volume_id($scfg->{base});
b6cf0a66
DM
1141 return 1 if $st && $st eq $storeid;
1142 }
1143
1144 return undef;
1145}
1146
1147sub foreach_volid {
1148 my ($list, $func) = @_;
1149
1150 return if !$list;
1151
1152 foreach my $sid (keys %$list) {
1153 foreach my $info (@{$list->{$sid}}) {
1154 my $volid = $info->{volid};
1dc01b9f 1155 my ($sid1, $volname) = parse_volume_id($volid, 1);
b6cf0a66
DM
1156 if ($sid1 && $sid1 eq $sid) {
1157 &$func ($volid, $sid, $info);
1158 } else {
1159 warn "detected strange volid '$volid' in volume list for '$sid'\n";
1160 }
1161 }
1162 }
1163}
1164
11651;