]> git.proxmox.com Git - pve-storage.git/blame - PVE/Storage.pm
migrate: snapshot parameter for incremental transfer
[pve-storage.git] / PVE / Storage.pm
CommitLineData
b6cf0a66
DM
1package PVE::Storage;
2
3use strict;
ffd6f2f3 4use warnings;
dec97937 5use Data::Dumper;
ffd6f2f3 6
b6cf0a66
DM
7use POSIX;
8use IO::Select;
b6cf0a66 9use IO::File;
b6cf0a66
DM
10use File::Basename;
11use File::Path;
b6cf0a66 12use Cwd 'abs_path';
7a2d5c1a 13use Socket;
b6cf0a66 14
4dee23d3 15use PVE::Tools qw(run_command file_read_firstline dir_glob_foreach $IPV6RE);
83d7192f 16use PVE::Cluster qw(cfs_read_file cfs_write_file cfs_lock_file);
b6cf0a66
DM
17use PVE::Exception qw(raise_param_exc);
18use PVE::JSONSchema;
19use PVE::INotify;
88c3abaf 20use PVE::RPCEnvironment;
b6cf0a66 21
1dc01b9f
DM
22use PVE::Storage::Plugin;
23use PVE::Storage::DirPlugin;
24use PVE::Storage::LVMPlugin;
610798bc 25use PVE::Storage::LvmThinPlugin;
1dc01b9f
DM
26use PVE::Storage::NFSPlugin;
27use PVE::Storage::ISCSIPlugin;
0509010d 28use PVE::Storage::RBDPlugin;
caf1960c 29use PVE::Storage::SheepdogPlugin;
86616554 30use PVE::Storage::ISCSIDirectPlugin;
f4648aef 31use PVE::Storage::GlusterfsPlugin;
85fda4dd 32use PVE::Storage::ZFSPoolPlugin;
4f914e6e 33use PVE::Storage::ZFSPlugin;
14770890 34use PVE::Storage::DRBDPlugin;
b6cf0a66 35
4dee23d3
DP
36# Storage API version. Icrement it on changes in storage API interface.
37use constant APIVER => 1;
38
39# load standard plugins
1dc01b9f
DM
40PVE::Storage::DirPlugin->register();
41PVE::Storage::LVMPlugin->register();
610798bc 42PVE::Storage::LvmThinPlugin->register();
1dc01b9f
DM
43PVE::Storage::NFSPlugin->register();
44PVE::Storage::ISCSIPlugin->register();
0509010d 45PVE::Storage::RBDPlugin->register();
caf1960c 46PVE::Storage::SheepdogPlugin->register();
86616554 47PVE::Storage::ISCSIDirectPlugin->register();
f4648aef 48PVE::Storage::GlusterfsPlugin->register();
85fda4dd 49PVE::Storage::ZFSPoolPlugin->register();
4f914e6e 50PVE::Storage::ZFSPlugin->register();
14770890 51PVE::Storage::DRBDPlugin->register();
4dee23d3
DP
52
53# load third-party plugins
54if ( -d '/usr/share/perl5/PVE/Storage/Custom' ) {
55 dir_glob_foreach('/usr/share/perl5/PVE/Storage/Custom', '.*\.pm$', sub {
56 my ($file) = @_;
57 my $modname = 'PVE::Storage::Custom::' . $file;
58 $modname =~ s!\.pm$!!;
59 $file = 'PVE/Storage/Custom/' . $file;
60
61 eval {
62 require $file;
63 };
64 if ($@) {
65 warn $@;
66 # Check storage API version and that file is really storage plugin.
67 } elsif ($modname->isa('PVE::Storage::Plugin') && $modname->can('api') && $modname->api() == APIVER) {
68 eval {
69 import $file;
70 $modname->register();
71 };
72 warn $@ if $@;
73 } else {
74 warn "Error loading storage plugin \"$modname\" because of API version mismatch. Please, update it.\n"
75 }
76 });
77}
78
79# initialize all plugins
1dc01b9f 80PVE::Storage::Plugin->init();
b6cf0a66 81
1dc01b9f 82my $UDEVADM = '/sbin/udevadm';
b6cf0a66 83
1dc01b9f 84# PVE::Storage utility functions
b6cf0a66
DM
85
86sub config {
87 return cfs_read_file("storage.cfg");
88}
89
83d7192f
FG
90sub write_config {
91 my ($cfg) = @_;
92
93 cfs_write_file('storage.cfg', $cfg);
94}
95
b6cf0a66
DM
96sub lock_storage_config {
97 my ($code, $errmsg) = @_;
98
99 cfs_lock_file("storage.cfg", undef, $code);
100 my $err = $@;
101 if ($err) {
102 $errmsg ? die "$errmsg: $err" : die $err;
103 }
104}
105
b6cf0a66
DM
106sub storage_config {
107 my ($cfg, $storeid, $noerr) = @_;
108
82fc923f 109 die "no storage ID specified\n" if !$storeid;
1a3459ac 110
b6cf0a66
DM
111 my $scfg = $cfg->{ids}->{$storeid};
112
113 die "storage '$storeid' does not exists\n" if (!$noerr && !$scfg);
114
115 return $scfg;
116}
117
118sub storage_check_node {
119 my ($cfg, $storeid, $node, $noerr) = @_;
120
1dc01b9f 121 my $scfg = storage_config($cfg, $storeid);
b6cf0a66
DM
122
123 if ($scfg->{nodes}) {
124 $node = PVE::INotify::nodename() if !$node || ($node eq 'localhost');
125 if (!$scfg->{nodes}->{$node}) {
da156fb3 126 die "storage '$storeid' is not available on node '$node'\n" if !$noerr;
b6cf0a66
DM
127 return undef;
128 }
129 }
130
131 return $scfg;
132}
133
134sub storage_check_enabled {
135 my ($cfg, $storeid, $node, $noerr) = @_;
136
1dc01b9f 137 my $scfg = storage_config($cfg, $storeid);
b6cf0a66
DM
138
139 if ($scfg->{disable}) {
140 die "storage '$storeid' is disabled\n" if !$noerr;
141 return undef;
142 }
143
144 return storage_check_node($cfg, $storeid, $node, $noerr);
145}
146
147sub storage_ids {
148 my ($cfg) = @_;
149
1dc01b9f 150 return keys %{$cfg->{ids}};
b6cf0a66
DM
151}
152
1dc01b9f
DM
153sub file_size_info {
154 my ($filename, $timeout) = @_;
b6cf0a66 155
1dc01b9f 156 return PVE::Storage::Plugin::file_size_info($filename, $timeout);
b6cf0a66
DM
157}
158
20ccac1b
AD
159sub volume_size_info {
160 my ($cfg, $volid, $timeout) = @_;
161
f18199e5
DM
162 my ($storeid, $volname) = parse_volume_id($volid, 1);
163 if ($storeid) {
164 my $scfg = storage_config($cfg, $storeid);
165 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
166 return $plugin->volume_size_info($scfg, $storeid, $volname, $timeout);
167 } elsif ($volid =~ m|^(/.+)$| && -e $volid) {
168 return file_size_info($volid, $timeout);
169 } else {
170 return 0;
171 }
20ccac1b
AD
172}
173
7e6c05dc
AD
174sub volume_resize {
175 my ($cfg, $volid, $size, $running) = @_;
176
177 my ($storeid, $volname) = parse_volume_id($volid, 1);
178 if ($storeid) {
179 my $scfg = storage_config($cfg, $storeid);
180 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
181 return $plugin->volume_resize($scfg, $storeid, $volname, $size, $running);
182 } elsif ($volid =~ m|^(/.+)$| && -e $volid) {
f824c722 183 die "resize file/device '$volid' is not possible\n";
7e6c05dc 184 } else {
f824c722 185 die "unable to parse volume ID '$volid'\n";
7e6c05dc
AD
186 }
187}
188
1597f1f9
WL
189sub volume_rollback_is_possible {
190 my ($cfg, $volid, $snap) = @_;
e0852ba7 191
1597f1f9
WL
192 my ($storeid, $volname) = parse_volume_id($volid, 1);
193 if ($storeid) {
194 my $scfg = storage_config($cfg, $storeid);
195 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
196 return $plugin->volume_rollback_is_possible($scfg, $storeid, $volname, $snap);
197 } elsif ($volid =~ m|^(/.+)$| && -e $volid) {
f824c722 198 die "snapshot rollback file/device '$volid' is not possible\n";
1597f1f9 199 } else {
f824c722 200 die "unable to parse volume ID '$volid'\n";
1597f1f9
WL
201 }
202}
203
db60719c 204sub volume_snapshot {
f5640e7d 205 my ($cfg, $volid, $snap) = @_;
db60719c
AD
206
207 my ($storeid, $volname) = parse_volume_id($volid, 1);
208 if ($storeid) {
209 my $scfg = storage_config($cfg, $storeid);
210 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
f5640e7d 211 return $plugin->volume_snapshot($scfg, $storeid, $volname, $snap);
db60719c 212 } elsif ($volid =~ m|^(/.+)$| && -e $volid) {
f824c722 213 die "snapshot file/device '$volid' is not possible\n";
db60719c 214 } else {
f824c722 215 die "unable to parse volume ID '$volid'\n";
db60719c
AD
216 }
217}
218
22a2a633
AD
219sub volume_snapshot_rollback {
220 my ($cfg, $volid, $snap) = @_;
221
222 my ($storeid, $volname) = parse_volume_id($volid, 1);
223 if ($storeid) {
224 my $scfg = storage_config($cfg, $storeid);
225 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
b3f302c6 226 $plugin->volume_rollback_is_possible($scfg, $storeid, $volname, $snap);
22a2a633
AD
227 return $plugin->volume_snapshot_rollback($scfg, $storeid, $volname, $snap);
228 } elsif ($volid =~ m|^(/.+)$| && -e $volid) {
f824c722 229 die "snapshot rollback file/device '$volid' is not possible\n";
22a2a633 230 } else {
f824c722 231 die "unable to parse volume ID '$volid'\n";
22a2a633
AD
232 }
233}
234
5753c9d1
AD
235sub volume_snapshot_delete {
236 my ($cfg, $volid, $snap, $running) = @_;
237
238 my ($storeid, $volname) = parse_volume_id($volid, 1);
239 if ($storeid) {
240 my $scfg = storage_config($cfg, $storeid);
241 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
27cc55d4 242 return $plugin->volume_snapshot_delete($scfg, $storeid, $volname, $snap, $running);
5753c9d1 243 } elsif ($volid =~ m|^(/.+)$| && -e $volid) {
f824c722 244 die "snapshot delete file/device '$volid' is not possible\n";
5753c9d1 245 } else {
f824c722 246 die "unable to parse volume ID '$volid'\n";
5753c9d1
AD
247 }
248}
249
99473759
AD
250sub volume_has_feature {
251 my ($cfg, $feature, $volid, $snap, $running) = @_;
252
253 my ($storeid, $volname) = parse_volume_id($volid, 1);
254 if ($storeid) {
255 my $scfg = storage_config($cfg, $storeid);
256 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
257 return $plugin->volume_has_feature($scfg, $feature, $storeid, $volname, $snap, $running);
258 } elsif ($volid =~ m|^(/.+)$| && -e $volid) {
259 return undef;
260 } else {
261 return undef;
262 }
263}
264
aefe82ea 265sub volume_snapshot_list {
17be2e9a 266 my ($cfg, $volid, $prefix) = @_;
aefe82ea
WL
267
268 my ($storeid, $volname) = parse_volume_id($volid, 1);
269 if ($storeid) {
270 my $scfg = storage_config($cfg, $storeid);
271 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
17be2e9a 272 return $plugin->volume_snapshot_list($scfg, $storeid, $volname, $prefix);
aefe82ea
WL
273 } elsif ($volid =~ m|^(/.+)$| && -e $volid) {
274 die "send file/device '$volid' is not possible\n";
275 } else {
276 die "unable to parse volume ID '$volid'\n";
277 }
278 # return an empty array if dataset does not exist.
279 # youngest snap first
280}
281
1dc01b9f
DM
282sub get_image_dir {
283 my ($cfg, $storeid, $vmid) = @_;
b6cf0a66 284
1dc01b9f
DM
285 my $scfg = storage_config($cfg, $storeid);
286 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
b6cf0a66 287
1dc01b9f 288 my $path = $plugin->get_subdir($scfg, 'images');
b6cf0a66 289
1dc01b9f 290 return $vmid ? "$path/$vmid" : $path;
b6cf0a66
DM
291}
292
1dc01b9f 293sub get_private_dir {
b6cf0a66
DM
294 my ($cfg, $storeid, $vmid) = @_;
295
1dc01b9f
DM
296 my $scfg = storage_config($cfg, $storeid);
297 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
b6cf0a66 298
1dc01b9f 299 my $path = $plugin->get_subdir($scfg, 'rootdir');
d22a6133 300
1dc01b9f 301 return $vmid ? "$path/$vmid" : $path;
d22a6133
DM
302}
303
b6cf0a66
DM
304sub get_iso_dir {
305 my ($cfg, $storeid) = @_;
306
1dc01b9f
DM
307 my $scfg = storage_config($cfg, $storeid);
308 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
b6cf0a66 309
1dc01b9f 310 return $plugin->get_subdir($scfg, 'iso');
b6cf0a66
DM
311}
312
313sub get_vztmpl_dir {
314 my ($cfg, $storeid) = @_;
315
1dc01b9f
DM
316 my $scfg = storage_config($cfg, $storeid);
317 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
b6cf0a66 318
1dc01b9f 319 return $plugin->get_subdir($scfg, 'vztmpl');
b6cf0a66
DM
320}
321
568de3d1
DM
322sub get_backup_dir {
323 my ($cfg, $storeid) = @_;
324
1dc01b9f
DM
325 my $scfg = storage_config($cfg, $storeid);
326 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
b6cf0a66 327
1dc01b9f 328 return $plugin->get_subdir($scfg, 'backup');
b6cf0a66
DM
329}
330
331# library implementation
332
b6cf0a66
DM
333sub parse_vmid {
334 my $vmid = shift;
335
336 die "VMID '$vmid' contains illegal characters\n" if $vmid !~ m/^\d+$/;
337
338 return int($vmid);
339}
340
787624df
FG
341# NOTE: basename and basevmid are always undef for LVM-thin, where the
342# clone -> base reference is not encoded in the volume ID.
343# see note in PVE::Storage::LvmThinPlugin for details.
ec4b0dc7
AD
344sub parse_volname {
345 my ($cfg, $volid) = @_;
346
347 my ($storeid, $volname) = parse_volume_id($volid);
348
349 my $scfg = storage_config($cfg, $storeid);
350
351 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
a6f12626
DM
352
353 # returns ($vtype, $name, $vmid, $basename, $basevmid, $isBase, $format)
354
ec4b0dc7
AD
355 return $plugin->parse_volname($volname);
356}
357
b6cf0a66
DM
358sub parse_volume_id {
359 my ($volid, $noerr) = @_;
360
a7f3d909 361 return PVE::Storage::Plugin::parse_volume_id($volid, $noerr);
b6cf0a66
DM
362}
363
04a13668
DM
364# test if we have read access to volid
365sub check_volume_access {
366 my ($rpcenv, $user, $cfg, $vmid, $volid) = @_;
367
368 my ($sid, $volname) = parse_volume_id($volid, 1);
369 if ($sid) {
370 my ($vtype, undef, $ownervm) = parse_volname($cfg, $volid);
371 if ($vtype eq 'iso' || $vtype eq 'vztmpl') {
372 # we simply allow access
373 } elsif (defined($ownervm) && defined($vmid) && ($ownervm == $vmid)) {
374 # we are owner - allow access
375 } elsif ($vtype eq 'backup' && $ownervm) {
376 $rpcenv->check($user, "/storage/$sid", ['Datastore.AllocateSpace']);
377 $rpcenv->check($user, "/vms/$ownervm", ['VM.Backup']);
378 } else {
379 # allow if we are Datastore administrator
380 $rpcenv->check($user, "/storage/$sid", ['Datastore.Allocate']);
381 }
382 } else {
383 die "Only root can pass arbitrary filesystem paths."
384 if $user ne 'root@pam';
385 }
386
387 return undef;
388}
389
17fb7e42
FG
390my $volume_is_base_and_used__no_lock = sub {
391 my ($scfg, $storeid, $plugin, $volname) = @_;
392
393 my ($vtype, $name, $vmid, undef, undef, $isBase, undef) =
394 $plugin->parse_volname($volname);
395
396 if ($isBase) {
397 my $vollist = $plugin->list_images($storeid, $scfg);
398 foreach my $info (@$vollist) {
399 my (undef, $tmpvolname) = parse_volume_id($info->{volid});
400 my $basename = undef;
401 my $basevmid = undef;
402
403 eval{
404 (undef, undef, undef, $basename, $basevmid) =
405 $plugin->parse_volname($tmpvolname);
406 };
407
408 if ($basename && defined($basevmid) && $basevmid == $vmid && $basename eq $name) {
409 return 1;
410 }
411 }
412 }
413 return 0;
414};
415
787624df
FG
416# NOTE: this check does not work for LVM-thin, where the clone -> base
417# reference is not encoded in the volume ID.
418# see note in PVE::Storage::LvmThinPlugin for details.
17fb7e42
FG
419sub volume_is_base_and_used {
420 my ($cfg, $volid) = @_;
421
422 my ($storeid, $volname) = parse_volume_id($volid);
423 my $scfg = storage_config($cfg, $storeid);
424 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
425
426 $plugin->cluster_lock_storage($storeid, $scfg->{shared}, undef, sub {
427 return &$volume_is_base_and_used__no_lock($scfg, $storeid, $plugin, $volname);
428 });
429}
430
b6cf0a66
DM
431# try to map a filesystem path to a volume identifier
432sub path_to_volume_id {
433 my ($cfg, $path) = @_;
434
435 my $ids = $cfg->{ids};
436
1dc01b9f 437 my ($sid, $volname) = parse_volume_id($path, 1);
b6cf0a66 438 if ($sid) {
1dc01b9f 439 if (my $scfg = $ids->{$sid}) {
188aca38 440 if ($scfg->{path}) {
1dc01b9f
DM
441 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
442 my ($vtype, $name, $vmid) = $plugin->parse_volname($volname);
b6cf0a66
DM
443 return ($vtype, $path);
444 }
445 }
446 return ('');
447 }
448
1a3459ac 449 # Note: abs_path() return undef if $path doesn not exist
75d75990
DM
450 # for example when nfs storage is not mounted
451 $path = abs_path($path) || $path;
b6cf0a66
DM
452
453 foreach my $sid (keys %$ids) {
1dc01b9f
DM
454 my $scfg = $ids->{$sid};
455 next if !$scfg->{path};
456 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
457 my $imagedir = $plugin->get_subdir($scfg, 'images');
458 my $isodir = $plugin->get_subdir($scfg, 'iso');
459 my $tmpldir = $plugin->get_subdir($scfg, 'vztmpl');
460 my $backupdir = $plugin->get_subdir($scfg, 'backup');
461 my $privatedir = $plugin->get_subdir($scfg, 'rootdir');
b6cf0a66
DM
462
463 if ($path =~ m!^$imagedir/(\d+)/([^/\s]+)$!) {
464 my $vmid = $1;
465 my $name = $2;
fcbec654
DM
466
467 my $vollist = $plugin->list_images($sid, $scfg, $vmid);
468 foreach my $info (@$vollist) {
469 my ($storeid, $volname) = parse_volume_id($info->{volid});
470 my $volpath = $plugin->path($scfg, $volname, $storeid);
471 if ($volpath eq $path) {
472 return ('images', $info->{volid});
473 }
474 }
b6cf0a66
DM
475 } elsif ($path =~ m!^$isodir/([^/]+\.[Ii][Ss][Oo])$!) {
476 my $name = $1;
1a3459ac 477 return ('iso', "$sid:iso/$name");
b6cf0a66
DM
478 } elsif ($path =~ m!^$tmpldir/([^/]+\.tar\.gz)$!) {
479 my $name = $1;
480 return ('vztmpl', "$sid:vztmpl/$name");
1ac17c74
DM
481 } elsif ($path =~ m!^$privatedir/(\d+)$!) {
482 my $vmid = $1;
483 return ('rootdir', "$sid:rootdir/$vmid");
a22854e5 484 } elsif ($path =~ m!^$backupdir/([^/]+\.(tar|tar\.gz|tar\.lzo|tgz|vma|vma\.gz|vma\.lzo))$!) {
568de3d1 485 my $name = $1;
1a3459ac 486 return ('iso', "$sid:backup/$name");
b6cf0a66
DM
487 }
488 }
489
490 # can't map path to volume id
491 return ('');
492}
493
494sub path {
207ea852 495 my ($cfg, $volid, $snapname) = @_;
b6cf0a66 496
1dc01b9f 497 my ($storeid, $volname) = parse_volume_id($volid);
b6cf0a66 498
1dc01b9f 499 my $scfg = storage_config($cfg, $storeid);
b6cf0a66 500
1dc01b9f 501 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
207ea852 502 my ($path, $owner, $vtype) = $plugin->path($scfg, $volname, $storeid, $snapname);
2494896a 503 return wantarray ? ($path, $owner, $vtype) : $path;
b6cf0a66
DM
504}
505
35fbb2e6
DM
506sub abs_filesystem_path {
507 my ($cfg, $volid) = @_;
508
509 my $path;
510 if (PVE::Storage::parse_volume_id ($volid, 1)) {
511 PVE::Storage::activate_volumes($cfg, [ $volid ]);
512 $path = PVE::Storage::path($cfg, $volid);
513 } else {
514 if (-f $volid) {
515 my $abspath = abs_path($volid);
516 if ($abspath && $abspath =~ m|^(/.+)$|) {
517 $path = $1; # untaint any path
518 }
519 }
520 }
521
522 die "can't find file '$volid'\n" if !($path && -f $path);
523
524 return $path;
525}
526
b6cf0a66 527sub storage_migrate {
ac191ec7 528 my ($cfg, $volid, $target_host, $target_storeid, $target_volname, $base_snapshot) = @_;
b6cf0a66 529
6bf56298 530 my ($storeid, $volname) = parse_volume_id($volid);
b6cf0a66
DM
531 $target_volname = $volname if !$target_volname;
532
6bf56298 533 my $scfg = storage_config($cfg, $storeid);
b6cf0a66
DM
534
535 # no need to migrate shared content
536 return if $storeid eq $target_storeid && $scfg->{shared};
537
6bf56298 538 my $tcfg = storage_config($cfg, $target_storeid);
b6cf0a66
DM
539
540 my $target_volid = "${target_storeid}:${target_volname}";
541
542 my $errstr = "unable to migrate '$volid' to '${target_volid}' on host '$target_host'";
543
45c2ee35 544 my $sshoptions = "-o 'BatchMode=yes'";
b6cf0a66
DM
545 my $ssh = "/usr/bin/ssh $sshoptions";
546
547 local $ENV{RSYNC_RSH} = $ssh;
548
ac191ec7
WB
549 my $no_incremental = sub {
550 my ($type) = @_;
551 die "incremental migration not supported on storage type $type\n"
552 if defined($base_snapshot);
553 };
554
1dc01b9f
DM
555 # only implemented for file system based storage
556 if ($scfg->{path}) {
ac191ec7 557 $no_incremental->($scfg->{type});
b6cf0a66 558
ac191ec7 559 if ($tcfg->{path}) {
1dc01b9f
DM
560 my $src_plugin = PVE::Storage::Plugin->lookup($scfg->{type});
561 my $dst_plugin = PVE::Storage::Plugin->lookup($tcfg->{type});
6bf56298
DM
562 my $src = $src_plugin->path($scfg, $volname, $storeid);
563 my $dst = $dst_plugin->path($tcfg, $target_volname, $target_storeid);
b6cf0a66 564
1dc01b9f 565 my $dirname = dirname($dst);
b6cf0a66
DM
566
567 if ($tcfg->{shared}) { # we can do a local copy
1a3459ac 568
f81372ac 569 run_command(['/bin/mkdir', '-p', $dirname]);
b6cf0a66 570
1dc01b9f 571 run_command(['/bin/cp', $src, $dst]);
b6cf0a66 572
1dc01b9f 573 } else {
1a3459ac 574 run_command(['/usr/bin/ssh', "root\@${target_host}",
1dc01b9f 575 '/bin/mkdir', '-p', $dirname]);
b6cf0a66 576
1dc01b9f
DM
577 # we use rsync with --sparse, so we can't use --inplace,
578 # so we remove file on the target if it already exists to
579 # save space
580 my ($size, $format) = PVE::Storage::Plugin::file_size_info($src);
581 if ($format && ($format eq 'raw') && $size) {
1a3459ac 582 run_command(['/usr/bin/ssh', "root\@${target_host}",
1dc01b9f
DM
583 'rm', '-f', $dst],
584 outfunc => sub {});
585 }
b6cf0a66 586
986303ca
WL
587 my $cmd;
588 if ($format eq 'subvol') {
589 $cmd = ['/usr/bin/rsync', '--progress', '-X', '-A', '--numeric-ids',
590 '-aH', '--delete', '--no-whole-file', '--inplace',
591 '--one-file-system', "$src/", "[root\@${target_host}]:$dst"];
592 } else {
593 $cmd = ['/usr/bin/rsync', '--progress', '--sparse', '--whole-file',
594 $src, "[root\@${target_host}]:$dst"];
595 }
b6cf0a66 596
1dc01b9f 597 my $percent = -1;
b6cf0a66 598
1dc01b9f
DM
599 run_command($cmd, outfunc => sub {
600 my $line = shift;
b6cf0a66 601
1dc01b9f
DM
602 if ($line =~ m/^\s*(\d+\s+(\d+)%\s.*)$/) {
603 if ($2 > $percent) {
604 $percent = $2;
605 print "rsync status: $1\n";
606 *STDOUT->flush();
607 }
608 } else {
609 print "$line\n";
610 *STDOUT->flush();
611 }
612 });
613 }
614 } else {
615 die "$errstr - target type '$tcfg->{type}' not implemented\n";
616 }
e0852ba7 617
3d621977
WL
618 } elsif ($scfg->{type} eq 'zfspool') {
619
e0852ba7 620 if ($tcfg->{type} eq 'zfspool') {
3d621977 621
82fc923f 622 die "$errstr - pool on target does not have the same name as on source!"
e0852ba7 623 if $tcfg->{pool} ne $scfg->{pool};
3d621977 624
e0852ba7 625 my (undef, $volname) = parse_volname($cfg, $volid);
3d621977
WL
626 my $zfspath = "$scfg->{pool}\/$volname";
627
865710f4
WB
628 my $send = ['pvesm', 'export', $volid, 'zfs', '-', '-snapshot', '__migration__', '-with-snapshots', '1'];
629 my $recv = ['ssh', "root\@$target_host", '--', 'pvesm', 'import', $volid, 'zfs', '-', '-with-snapshots', '1'];
630 my $free = ['ssh', "root\@$target_host", '--', 'pvesm', 'free', $volid, '-snapshot', '__migration__'];
3d621977 631
ac191ec7
WB
632 if (defined($base_snapshot)) {
633 # Check if the snapshot exists on the remote side:
634 push @$send, '-snapshot', $base_snapshot;
635 push @$recv, '-base', $base_snapshot;
636 }
637
865710f4 638 volume_snapshot($cfg, $volid, '__migration__');
e0852ba7 639 eval{
865710f4 640 run_command([$send, $recv]);
3d621977 641 };
afd0afe4 642 my $err = $@;
865710f4
WB
643 warn "send/receive failed, cleaning up snapshot(s)..\n" if $err;
644 eval { volume_snapshot_delete($cfg, $volid, '__migration__', 0) };
afd0afe4 645 warn "could not remove source snapshot: $@\n" if $@;
865710f4 646 eval { run_command($free) };
afd0afe4
FG
647 warn "could not remove target snapshot: $@\n" if $@;
648 die $err if $err;
3d621977
WL
649 } else {
650 die "$errstr - target type $tcfg->{type} is not valid\n";
651 }
0a29ad61
WL
652
653 } elsif ($scfg->{type} eq 'lvmthin' || $scfg->{type} eq 'lvm') {
ac191ec7 654 $no_incremental->($scfg->{type});
0a29ad61 655
76f13c9e
DM
656 if (($scfg->{type} eq $tcfg->{type}) &&
657 ($tcfg->{type} eq 'lvmthin' || $tcfg->{type} eq 'lvm')) {
0a29ad61 658
84252f67 659 my (undef, $volname, $vmid) = parse_volname($cfg, $volid);
0a29ad61 660 my $size = volume_size_info($cfg, $volid, 5);
84252f67
DM
661 my $src = path($cfg, $volid);
662 my $dst = path($cfg, $target_volid);
0a29ad61
WL
663
664 run_command(['/usr/bin/ssh', "root\@${target_host}",
665 'pvesm', 'alloc', $target_storeid, $vmid,
84252f67 666 $target_volname, int($size/1024)]);
0a29ad61
WL
667
668 eval {
e83f7b40 669 if ($tcfg->{type} eq 'lvmthin') {
46f114a5
DM
670 run_command([["dd", "if=$src", "bs=4k"],["/usr/bin/ssh", "root\@${target_host}",
671 "dd", 'conv=sparse', "of=$dst", "bs=4k"]]);
e83f7b40 672 } else {
46f114a5
DM
673 run_command([["dd", "if=$src", "bs=4k"],["/usr/bin/ssh", "root\@${target_host}",
674 "dd", "of=$dst", "bs=4k"]]);
e83f7b40 675 }
0a29ad61
WL
676 };
677 if (my $err = $@) {
678 run_command(['/usr/bin/ssh', "root\@${target_host}",
84252f67 679 'pvesm', 'free', $target_volid]);
966ecef2 680 die $err;
0a29ad61
WL
681 }
682 } else {
76f13c9e 683 die "$errstr - migrate from source type '$scfg->{type}' to '$tcfg->{type}' not implemented\n";
0a29ad61 684 }
1dc01b9f
DM
685 } else {
686 die "$errstr - source type '$scfg->{type}' not implemented\n";
b6cf0a66
DM
687 }
688}
689
2502b33b 690sub vdisk_clone {
7bbc4004 691 my ($cfg, $volid, $vmid, $snap) = @_;
1a3459ac 692
2502b33b
DM
693 my ($storeid, $volname) = parse_volume_id($volid);
694
695 my $scfg = storage_config($cfg, $storeid);
696
697 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
1a3459ac 698
2502b33b
DM
699 activate_storage($cfg, $storeid);
700
701 # lock shared storage
702 return $plugin->cluster_lock_storage($storeid, $scfg->{shared}, undef, sub {
7bbc4004 703 my $volname = $plugin->clone_image($scfg, $storeid, $volname, $vmid, $snap);
2502b33b
DM
704 return "$storeid:$volname";
705 });
706}
707
708sub vdisk_create_base {
709 my ($cfg, $volid) = @_;
710
711 my ($storeid, $volname) = parse_volume_id($volid);
712
713 my $scfg = storage_config($cfg, $storeid);
714
715 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
1a3459ac 716
2502b33b
DM
717 activate_storage($cfg, $storeid);
718
719 # lock shared storage
720 return $plugin->cluster_lock_storage($storeid, $scfg->{shared}, undef, sub {
721 my $volname = $plugin->create_base($storeid, $scfg, $volname);
722 return "$storeid:$volname";
723 });
724}
725
1dc01b9f
DM
726sub vdisk_alloc {
727 my ($cfg, $storeid, $vmid, $fmt, $name, $size) = @_;
b6cf0a66 728
82fc923f 729 die "no storage ID specified\n" if !$storeid;
b6cf0a66 730
1dc01b9f 731 PVE::JSONSchema::parse_storage_id($storeid);
b6cf0a66 732
1dc01b9f 733 my $scfg = storage_config($cfg, $storeid);
b6cf0a66 734
1dc01b9f 735 die "no VMID specified\n" if !$vmid;
b6cf0a66 736
1dc01b9f 737 $vmid = parse_vmid($vmid);
b6cf0a66 738
1dc01b9f 739 my $defformat = PVE::Storage::Plugin::default_format($scfg);
b6cf0a66 740
1dc01b9f 741 $fmt = $defformat if !$fmt;
b6cf0a66 742
1dc01b9f 743 activate_storage($cfg, $storeid);
3af60e62 744
1dc01b9f 745 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
b6cf0a66 746
1dc01b9f
DM
747 # lock shared storage
748 return $plugin->cluster_lock_storage($storeid, $scfg->{shared}, undef, sub {
afdfbe55
WB
749 my $old_umask = umask(umask|0037);
750 my $volname = eval { $plugin->alloc_image($storeid, $scfg, $vmid, $fmt, $name, $size) };
751 my $err = $@;
752 umask $old_umask;
753 die $err if $err;
1dc01b9f
DM
754 return "$storeid:$volname";
755 });
b6cf0a66
DM
756}
757
1dc01b9f
DM
758sub vdisk_free {
759 my ($cfg, $volid) = @_;
b6cf0a66 760
1dc01b9f 761 my ($storeid, $volname) = parse_volume_id($volid);
1dc01b9f 762 my $scfg = storage_config($cfg, $storeid);
1dc01b9f 763 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
1a3459ac 764
1dc01b9f 765 activate_storage($cfg, $storeid);
b6cf0a66 766
1dc01b9f 767 my $cleanup_worker;
b6cf0a66 768
1dc01b9f
DM
769 # lock shared storage
770 $plugin->cluster_lock_storage($storeid, $scfg->{shared}, undef, sub {
787624df 771 # LVM-thin allows deletion of still referenced base volumes!
17fb7e42
FG
772 die "base volume '$volname' is still in use by linked clones\n"
773 if &$volume_is_base_and_used__no_lock($scfg, $storeid, $plugin, $volname);
32437ed2 774
17fb7e42 775 my (undef, undef, undef, undef, undef, $isBase, $format) =
32437ed2 776 $plugin->parse_volname($volname);
35533c68 777 $cleanup_worker = $plugin->free_image($storeid, $scfg, $volname, $isBase, $format);
1dc01b9f 778 });
b6cf0a66 779
1dc01b9f 780 return if !$cleanup_worker;
b6cf0a66 781
1dc01b9f
DM
782 my $rpcenv = PVE::RPCEnvironment::get();
783 my $authuser = $rpcenv->get_user();
b6cf0a66 784
1dc01b9f 785 $rpcenv->fork_worker('imgdel', undef, $authuser, $cleanup_worker);
b6cf0a66
DM
786}
787
b6cf0a66
DM
788#list iso or openvz template ($tt = <iso|vztmpl|backup>)
789sub template_list {
790 my ($cfg, $storeid, $tt) = @_;
791
1a3459ac
DM
792 die "unknown template type '$tt'\n"
793 if !($tt eq 'iso' || $tt eq 'vztmpl' || $tt eq 'backup');
b6cf0a66
DM
794
795 my $ids = $cfg->{ids};
796
797 storage_check_enabled($cfg, $storeid) if ($storeid);
798
799 my $res = {};
800
801 # query the storage
802
803 foreach my $sid (keys %$ids) {
804 next if $storeid && $storeid ne $sid;
805
806 my $scfg = $ids->{$sid};
807 my $type = $scfg->{type};
808
809 next if !storage_check_enabled($cfg, $sid, undef, 1);
810
811 next if $tt eq 'iso' && !$scfg->{content}->{iso};
812 next if $tt eq 'vztmpl' && !$scfg->{content}->{vztmpl};
813 next if $tt eq 'backup' && !$scfg->{content}->{backup};
814
1dc01b9f 815 activate_storage($cfg, $sid);
b6cf0a66 816
1dc01b9f
DM
817 if ($scfg->{path}) {
818 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
b6cf0a66 819
1dc01b9f 820 my $path = $plugin->get_subdir($scfg, $tt);
b6cf0a66
DM
821
822 foreach my $fn (<$path/*>) {
823
824 my $info;
825
826 if ($tt eq 'iso') {
827 next if $fn !~ m!/([^/]+\.[Ii][Ss][Oo])$!;
828
829 $info = { volid => "$sid:iso/$1", format => 'iso' };
830
831 } elsif ($tt eq 'vztmpl') {
13d2cb79 832 next if $fn !~ m!/([^/]+\.tar\.([gx]z))$!;
b6cf0a66 833
13d2cb79 834 $info = { volid => "$sid:vztmpl/$1", format => "t$2" };
b6cf0a66
DM
835
836 } elsif ($tt eq 'backup') {
a22854e5 837 next if $fn !~ m!/([^/]+\.(tar|tar\.gz|tar\.lzo|tgz|vma|vma\.gz|vma\.lzo))$!;
1a3459ac 838
b6cf0a66
DM
839 $info = { volid => "$sid:backup/$1", format => $2 };
840 }
841
842 $info->{size} = -s $fn;
843
844 push @{$res->{$sid}}, $info;
845 }
846
847 }
848
849 @{$res->{$sid}} = sort {lc($a->{volid}) cmp lc ($b->{volid}) } @{$res->{$sid}} if $res->{$sid};
850 }
851
852 return $res;
853}
854
20ccac1b 855
b6cf0a66
DM
856sub vdisk_list {
857 my ($cfg, $storeid, $vmid, $vollist) = @_;
858
859 my $ids = $cfg->{ids};
860
861 storage_check_enabled($cfg, $storeid) if ($storeid);
862
863 my $res = {};
864
865 # prepare/activate/refresh all storages
866
b6cf0a66
DM
867 my $storage_list = [];
868 if ($vollist) {
869 foreach my $volid (@$vollist) {
1dc01b9f
DM
870 my ($sid, undef) = parse_volume_id($volid);
871 next if !defined($ids->{$sid});
b6cf0a66
DM
872 next if !storage_check_enabled($cfg, $sid, undef, 1);
873 push @$storage_list, $sid;
b6cf0a66
DM
874 }
875 } else {
876 foreach my $sid (keys %$ids) {
877 next if $storeid && $storeid ne $sid;
878 next if !storage_check_enabled($cfg, $sid, undef, 1);
879 push @$storage_list, $sid;
b6cf0a66
DM
880 }
881 }
882
1dc01b9f 883 my $cache = {};
b6cf0a66 884
1dc01b9f 885 activate_storage_list($cfg, $storage_list, $cache);
b6cf0a66
DM
886
887 foreach my $sid (keys %$ids) {
1dc01b9f
DM
888 next if $storeid && $storeid ne $sid;
889 next if !storage_check_enabled($cfg, $sid, undef, 1);
b6cf0a66 890
1dc01b9f
DM
891 my $scfg = $ids->{$sid};
892 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
893 $res->{$sid} = $plugin->list_images($sid, $scfg, $vmid, $vollist, $cache);
b6cf0a66
DM
894 @{$res->{$sid}} = sort {lc($a->{volid}) cmp lc ($b->{volid}) } @{$res->{$sid}} if $res->{$sid};
895 }
896
897 return $res;
898}
899
37ba0aea
DM
900sub volume_list {
901 my ($cfg, $storeid, $vmid, $content) = @_;
902
903 my @ctypes = qw(images vztmpl iso backup);
904
905 my $cts = $content ? [ $content ] : [ @ctypes ];
906
907 my $scfg = PVE::Storage::storage_config($cfg, $storeid);
908
909 my $res = [];
910 foreach my $ct (@$cts) {
911 my $data;
912 if ($ct eq 'images') {
913 $data = vdisk_list($cfg, $storeid, $vmid);
914 } elsif ($ct eq 'iso' && !defined($vmid)) {
915 $data = template_list($cfg, $storeid, 'iso');
916 } elsif ($ct eq 'vztmpl'&& !defined($vmid)) {
917 $data = template_list ($cfg, $storeid, 'vztmpl');
918 } elsif ($ct eq 'backup') {
919 $data = template_list ($cfg, $storeid, 'backup');
920 foreach my $item (@{$data->{$storeid}}) {
921 if (defined($vmid)) {
922 @{$data->{$storeid}} = grep { $_->{volid} =~ m/\S+-$vmid-\S+/ } @{$data->{$storeid}};
923 }
924 }
925 }
926
927 next if !$data || !$data->{$storeid};
928
929 foreach my $item (@{$data->{$storeid}}) {
930 $item->{content} = $ct;
931 push @$res, $item;
932 }
933 }
934
935 return $res;
936}
937
b6cf0a66
DM
938sub uevent_seqnum {
939
940 my $filename = "/sys/kernel/uevent_seqnum";
941
942 my $seqnum = 0;
1dc01b9f 943 if (my $fh = IO::File->new($filename, "r")) {
b6cf0a66
DM
944 my $line = <$fh>;
945 if ($line =~ m/^(\d+)$/) {
1dc01b9f 946 $seqnum = int($1);
b6cf0a66
DM
947 }
948 close ($fh);
949 }
950 return $seqnum;
951}
952
f3d4ef46 953sub activate_storage {
1dc01b9f 954 my ($cfg, $storeid, $cache) = @_;
b6cf0a66 955
f3d4ef46
DM
956 $cache = {} if !$cache;
957
b6cf0a66
DM
958 my $scfg = storage_check_enabled($cfg, $storeid);
959
1dc01b9f 960 return if $cache->{activated}->{$storeid};
b6cf0a66 961
1dc01b9f 962 $cache->{uevent_seqnum} = uevent_seqnum() if !$cache->{uevent_seqnum};
b6cf0a66 963
1dc01b9f 964 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
b6cf0a66 965
1dc01b9f
DM
966 if ($scfg->{base}) {
967 my ($baseid, undef) = parse_volume_id ($scfg->{base});
f3d4ef46
DM
968 activate_storage($cfg, $baseid, $cache);
969 }
970
971 if (!$plugin->check_connection($storeid, $scfg)) {
972 die "storage '$storeid' is not online\n";
b6cf0a66
DM
973 }
974
1dc01b9f
DM
975 $plugin->activate_storage($storeid, $scfg, $cache);
976
b6cf0a66
DM
977 my $newseq = uevent_seqnum ();
978
979 # only call udevsettle if there are events
1dc01b9f 980 if ($newseq > $cache->{uevent_seqnum}) {
b6cf0a66
DM
981 my $timeout = 30;
982 system ("$UDEVADM settle --timeout=$timeout"); # ignore errors
1dc01b9f 983 $cache->{uevent_seqnum} = $newseq;
b6cf0a66
DM
984 }
985
1dc01b9f 986 $cache->{activated}->{$storeid} = 1;
b6cf0a66
DM
987}
988
989sub activate_storage_list {
1dc01b9f 990 my ($cfg, $storeid_list, $cache) = @_;
b6cf0a66 991
1dc01b9f 992 $cache = {} if !$cache;
b6cf0a66
DM
993
994 foreach my $storeid (@$storeid_list) {
f3d4ef46 995 activate_storage($cfg, $storeid, $cache);
b6cf0a66
DM
996 }
997}
998
1dc01b9f
DM
999sub deactivate_storage {
1000 my ($cfg, $storeid) = @_;
1001
1002 my $scfg = storage_config ($cfg, $storeid);
1003 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
b6cf0a66 1004
1dc01b9f
DM
1005 my $cache = {};
1006 $plugin->deactivate_storage($storeid, $scfg, $cache);
b6cf0a66
DM
1007}
1008
1009sub activate_volumes {
02e797b8 1010 my ($cfg, $vollist, $snapname) = @_;
6703353b
DM
1011
1012 return if !($vollist && scalar(@$vollist));
1013
b6cf0a66
DM
1014 my $storagehash = {};
1015 foreach my $volid (@$vollist) {
1dc01b9f 1016 my ($storeid, undef) = parse_volume_id($volid);
b6cf0a66
DM
1017 $storagehash->{$storeid} = 1;
1018 }
1019
1dc01b9f
DM
1020 my $cache = {};
1021
1022 activate_storage_list($cfg, [keys %$storagehash], $cache);
b6cf0a66
DM
1023
1024 foreach my $volid (@$vollist) {
5521b580 1025 my ($storeid, $volname) = parse_volume_id($volid);
1dc01b9f
DM
1026 my $scfg = storage_config($cfg, $storeid);
1027 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
02e797b8 1028 $plugin->activate_volume($storeid, $scfg, $volname, $snapname, $cache);
b6cf0a66
DM
1029 }
1030}
1031
1032sub deactivate_volumes {
02e797b8 1033 my ($cfg, $vollist, $snapname) = @_;
b6cf0a66 1034
6703353b
DM
1035 return if !($vollist && scalar(@$vollist));
1036
1dc01b9f
DM
1037 my $cache = {};
1038
6703353b 1039 my @errlist = ();
b6cf0a66 1040 foreach my $volid (@$vollist) {
1dc01b9f 1041 my ($storeid, $volname) = parse_volume_id($volid);
b6cf0a66 1042
1dc01b9f
DM
1043 my $scfg = storage_config($cfg, $storeid);
1044 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
1a3459ac 1045
1dc01b9f 1046 eval {
02e797b8 1047 $plugin->deactivate_volume($storeid, $scfg, $volname, $snapname, $cache);
1dc01b9f
DM
1048 };
1049 if (my $err = $@) {
1050 warn $err;
1051 push @errlist, $volid;
b6cf0a66
DM
1052 }
1053 }
6703353b 1054
82fc923f 1055 die "volume deactivation failed: " . join(' ', @errlist)
6703353b 1056 if scalar(@errlist);
b6cf0a66
DM
1057}
1058
1a3459ac 1059sub storage_info {
b6cf0a66
DM
1060 my ($cfg, $content) = @_;
1061
1062 my $ids = $cfg->{ids};
1063
1064 my $info = {};
ff3badd8 1065
583c2802 1066 my @ctypes = PVE::Tools::split_list($content);
ff3badd8 1067
b6cf0a66
DM
1068 my $slist = [];
1069 foreach my $storeid (keys %$ids) {
1070
b6cf0a66
DM
1071 next if !storage_check_enabled($cfg, $storeid, undef, 1);
1072
d73060be
DM
1073 if (defined($content)) {
1074 my $want_ctype = 0;
1075 foreach my $ctype (@ctypes) {
1076 if ($ids->{$storeid}->{content}->{$ctype}) {
1077 $want_ctype = 1;
1078 last;
1079 }
583c2802 1080 }
d73060be 1081 next if !$want_ctype;
583c2802 1082 }
ff3badd8 1083
b6cf0a66
DM
1084 my $type = $ids->{$storeid}->{type};
1085
1a3459ac 1086 $info->{$storeid} = {
b6cf0a66 1087 type => $type,
1a3459ac
DM
1088 total => 0,
1089 avail => 0,
1090 used => 0,
04a2e4f3 1091 shared => $ids->{$storeid}->{shared} ? 1 : 0,
1dc01b9f 1092 content => PVE::Storage::Plugin::content_hash_to_string($ids->{$storeid}->{content}),
b6cf0a66
DM
1093 active => 0,
1094 };
1095
b6cf0a66
DM
1096 push @$slist, $storeid;
1097 }
1098
1dc01b9f 1099 my $cache = {};
b6cf0a66 1100
b6cf0a66
DM
1101 foreach my $storeid (keys %$ids) {
1102 my $scfg = $ids->{$storeid};
b6cf0a66
DM
1103 next if !$info->{$storeid};
1104
f3d4ef46
DM
1105 eval { activate_storage($cfg, $storeid, $cache); };
1106 if (my $err = $@) {
1107 warn $err;
1108 next;
1109 }
1110
1dc01b9f 1111 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
7028645e
DM
1112 my ($total, $avail, $used, $active);
1113 eval { ($total, $avail, $used, $active) = $plugin->status($storeid, $scfg, $cache); };
1114 warn $@ if $@;
1dc01b9f 1115 next if !$active;
ff3badd8
DM
1116 $info->{$storeid}->{total} = int($total);
1117 $info->{$storeid}->{avail} = int($avail);
1118 $info->{$storeid}->{used} = int($used);
1dc01b9f 1119 $info->{$storeid}->{active} = $active;
b6cf0a66
DM
1120 }
1121
1122 return $info;
1123}
1124
1125sub resolv_server {
1126 my ($server) = @_;
1a3459ac 1127
c67daeac
WB
1128 my ($packed_ip, $family);
1129 eval {
1130 my @res = PVE::Tools::getaddrinfo_all($server);
1131 $family = $res[0]->{family};
1132 $packed_ip = (PVE::Tools::unpack_sockaddr_in46($res[0]->{addr}))[2];
1133 };
b6cf0a66 1134 if (defined $packed_ip) {
ee302b1c 1135 return Socket::inet_ntop($family, $packed_ip);
b6cf0a66
DM
1136 }
1137 return undef;
1138}
1139
1140sub scan_nfs {
1141 my ($server_in) = @_;
1142
1143 my $server;
1144 if (!($server = resolv_server ($server_in))) {
1145 die "unable to resolve address for server '${server_in}'\n";
1146 }
1147
1148 my $cmd = ['/sbin/showmount', '--no-headers', '--exports', $server];
1149
1150 my $res = {};
f81372ac 1151 run_command($cmd, outfunc => sub {
b6cf0a66
DM
1152 my $line = shift;
1153
1154 # note: howto handle white spaces in export path??
1155 if ($line =~ m!^(/\S+)\s+(.+)$!) {
1156 $res->{$1} = $2;
1157 }
1158 });
1159
1160 return $res;
1161}
1162
584d97f6
DM
1163sub scan_zfs {
1164
3932390b 1165 my $cmd = ['zfs', 'list', '-t', 'filesystem', '-H', '-o', 'name,avail,used'];
584d97f6
DM
1166
1167 my $res = [];
1168 run_command($cmd, outfunc => sub {
1169 my $line = shift;
1170
1171 if ($line =~m/^(\S+)\s+(\S+)\s+(\S+)$/) {
3932390b 1172 my ($pool, $size_str, $used_str) = ($1, $2, $3);
584d97f6 1173 my $size = PVE::Storage::ZFSPoolPlugin::zfs_parse_size($size_str);
3932390b 1174 my $used = PVE::Storage::ZFSPoolPlugin::zfs_parse_size($used_str);
48e27f79 1175 # ignore subvolumes generated by our ZFSPoolPlugin
851658c3
WL
1176 return if $pool =~ m!/subvol-\d+-[^/]+$!;
1177 return if $pool =~ m!/basevol-\d+-[^/]+$!;
3932390b 1178 push @$res, { pool => $pool, size => $size, free => $size-$used };
584d97f6
DM
1179 }
1180 });
1181
1182 return $res;
1183}
1184
b6cf0a66
DM
1185sub resolv_portal {
1186 my ($portal, $noerr) = @_;
1187
1689e627
WB
1188 my ($server, $port) = PVE::Tools::parse_host_and_port($portal);
1189 if ($server) {
b6cf0a66
DM
1190 if (my $ip = resolv_server($server)) {
1191 $server = $ip;
1689e627 1192 $server = "[$server]" if $server =~ /^$IPV6RE$/;
b6cf0a66
DM
1193 return $port ? "$server:$port" : $server;
1194 }
1195 }
1196 return undef if $noerr;
1197
1198 raise_param_exc({ portal => "unable to resolve portal address '$portal'" });
1199}
1200
1201# idea is from usbutils package (/usr/bin/usb-devices) script
1202sub __scan_usb_device {
1203 my ($res, $devpath, $parent, $level) = @_;
1204
1205 return if ! -d $devpath;
1206 return if $level && $devpath !~ m/^.*[-.](\d+)$/;
1207 my $port = $level ? int($1 - 1) : 0;
1208
1209 my $busnum = int(file_read_firstline("$devpath/busnum"));
1210 my $devnum = int(file_read_firstline("$devpath/devnum"));
1211
1212 my $d = {
1213 port => $port,
1214 level => $level,
1215 busnum => $busnum,
1216 devnum => $devnum,
1217 speed => file_read_firstline("$devpath/speed"),
1218 class => hex(file_read_firstline("$devpath/bDeviceClass")),
1219 vendid => file_read_firstline("$devpath/idVendor"),
1220 prodid => file_read_firstline("$devpath/idProduct"),
1221 };
1222
1223 if ($level) {
1224 my $usbpath = $devpath;
1225 $usbpath =~ s|^.*/\d+\-||;
1226 $d->{usbpath} = $usbpath;
1227 }
1228
1229 my $product = file_read_firstline("$devpath/product");
1230 $d->{product} = $product if $product;
1a3459ac 1231
b6cf0a66
DM
1232 my $manu = file_read_firstline("$devpath/manufacturer");
1233 $d->{manufacturer} = $manu if $manu;
1234
1235 my $serial => file_read_firstline("$devpath/serial");
1236 $d->{serial} = $serial if $serial;
1237
1238 push @$res, $d;
1239
1240 foreach my $subdev (<$devpath/$busnum-*>) {
1241 next if $subdev !~ m|/$busnum-[0-9]+(\.[0-9]+)*$|;
1242 __scan_usb_device($res, $subdev, $devnum, $level + 1);
1243 }
1244
1245};
1246
1247sub scan_usb {
1248
1249 my $devlist = [];
1250
1251 foreach my $device (</sys/bus/usb/devices/usb*>) {
1252 __scan_usb_device($devlist, $device, 0, 0);
1253 }
1254
1255 return $devlist;
1256}
1257
1258sub scan_iscsi {
1259 my ($portal_in) = @_;
1260
1261 my $portal;
1dc01b9f 1262 if (!($portal = resolv_portal($portal_in))) {
b6cf0a66
DM
1263 die "unable to parse/resolve portal address '${portal_in}'\n";
1264 }
1265
1dc01b9f 1266 return PVE::Storage::ISCSIPlugin::iscsi_discovery($portal);
b6cf0a66
DM
1267}
1268
1269sub storage_default_format {
1270 my ($cfg, $storeid) = @_;
1271
1272 my $scfg = storage_config ($cfg, $storeid);
1273
1dc01b9f 1274 return PVE::Storage::Plugin::default_format($scfg);
b6cf0a66
DM
1275}
1276
1277sub vgroup_is_used {
1278 my ($cfg, $vgname) = @_;
1279
1280 foreach my $storeid (keys %{$cfg->{ids}}) {
1dc01b9f 1281 my $scfg = storage_config($cfg, $storeid);
b6cf0a66
DM
1282 if ($scfg->{type} eq 'lvm' && $scfg->{vgname} eq $vgname) {
1283 return 1;
1284 }
1285 }
1286
1287 return undef;
1288}
1289
1290sub target_is_used {
1291 my ($cfg, $target) = @_;
1292
1293 foreach my $storeid (keys %{$cfg->{ids}}) {
1dc01b9f 1294 my $scfg = storage_config($cfg, $storeid);
b6cf0a66
DM
1295 if ($scfg->{type} eq 'iscsi' && $scfg->{target} eq $target) {
1296 return 1;
1297 }
1298 }
1299
1300 return undef;
1301}
1302
1303sub volume_is_used {
1304 my ($cfg, $volid) = @_;
1305
1306 foreach my $storeid (keys %{$cfg->{ids}}) {
1dc01b9f 1307 my $scfg = storage_config($cfg, $storeid);
b6cf0a66
DM
1308 if ($scfg->{base} && $scfg->{base} eq $volid) {
1309 return 1;
1310 }
1311 }
1312
1313 return undef;
1314}
1315
1316sub storage_is_used {
1317 my ($cfg, $storeid) = @_;
1318
1319 foreach my $sid (keys %{$cfg->{ids}}) {
1dc01b9f 1320 my $scfg = storage_config($cfg, $sid);
b6cf0a66 1321 next if !$scfg->{base};
1dc01b9f 1322 my ($st) = parse_volume_id($scfg->{base});
b6cf0a66
DM
1323 return 1 if $st && $st eq $storeid;
1324 }
1325
1326 return undef;
1327}
1328
1329sub foreach_volid {
1330 my ($list, $func) = @_;
1331
1332 return if !$list;
1333
1334 foreach my $sid (keys %$list) {
1335 foreach my $info (@{$list->{$sid}}) {
1336 my $volid = $info->{volid};
1dc01b9f 1337 my ($sid1, $volname) = parse_volume_id($volid, 1);
b6cf0a66
DM
1338 if ($sid1 && $sid1 eq $sid) {
1339 &$func ($volid, $sid, $info);
1340 } else {
1341 warn "detected strange volid '$volid' in volume list for '$sid'\n";
1342 }
1343 }
1344 }
1345}
1346
8898dd7b
FG
1347sub extract_vzdump_config_tar {
1348 my ($archive, $conf_re) = @_;
1349
1350 die "ERROR: file '$archive' does not exist\n" if ! -f $archive;
1351
1352 my $pid = open(my $fh, '-|', 'tar', 'tf', $archive) ||
1353 die "unable to open file '$archive'\n";
1354
1355 my $file;
1356 while (defined($file = <$fh>)) {
086c4bf1 1357 if ($file =~ $conf_re) {
8898dd7b
FG
1358 $file = $1; # untaint
1359 last;
1360 }
1361 }
1362
1363 kill 15, $pid;
1364 waitpid $pid, 0;
1365 close $fh;
1366
1367 die "ERROR: archive contains no configuration file\n" if !$file;
1368 chomp $file;
1369
1370 my $raw = '';
1371 my $out = sub {
1372 my $output = shift;
1373 $raw .= "$output\n";
1374 };
1375
1376 PVE::Tools::run_command(['tar', '-xpOf', $archive, $file, '--occurrence'], outfunc => $out);
1377
1378 return wantarray ? ($raw, $file) : $raw;
1379}
1380
1381sub extract_vzdump_config_vma {
1382 my ($archive, $comp) = @_;
1383
1384 my $cmd;
1385 my $raw = '';
1386 my $out = sub {
1387 my $output = shift;
1388 $raw .= "$output\n";
1389 };
1390
1391
1392 if ($comp) {
1393 my $uncomp;
1394 if ($comp eq 'gz') {
1395 $uncomp = ["zcat", $archive];
1396 } elsif ($comp eq 'lzo') {
1397 $uncomp = ["lzop", "-d", "-c", $archive];
1398 } else {
1399 die "unknown compression method '$comp'\n";
1400 }
1401 $cmd = [$uncomp, ["vma", "config", "-"]];
1402
1403 # in some cases, lzop/zcat exits with 1 when its stdout pipe is
1404 # closed early by vma, detect this and ignore the exit code later
1405 my $broken_pipe;
1406 my $errstring;
1407 my $err = sub {
1408 my $output = shift;
1409 if ($output =~ m/lzop: Broken pipe: <stdout>/ || $output =~ m/gzip: stdout: Broken pipe/) {
1410 $broken_pipe = 1;
1411 } elsif (!defined ($errstring) && $output !~ m/^\s*$/) {
1412 $errstring = "Failed to extract config from VMA archive: $output\n";
1413 }
1414 };
1415
1416 # in other cases, the pipeline will exit with exit code 141
1417 # because of the broken pipe, handle / ignore this as well
1418 my $rc;
1419 eval {
1420 $rc = PVE::Tools::run_command($cmd, outfunc => $out, errfunc => $err, noerr => 1);
1421 };
1422 my $rerr = $@;
1423
1424 # use exit code if no stderr output and not just broken pipe
fc1089fc 1425 if (!$errstring && !$broken_pipe && $rc != 0 && $rc != 141) {
8898dd7b
FG
1426 die "$rerr\n" if $rerr;
1427 die "config extraction failed with exit code $rc\n";
1428 }
1429 die "$errstring\n" if $errstring;
1430 } else {
1431 # simple case without compression and weird piping behaviour
1432 PVE::Tools::run_command(["vma", "config", $archive], outfunc => $out);
1433 }
1434
1435 return wantarray ? ($raw, undef) : $raw;
1436}
1437
1438sub extract_vzdump_config {
1439 my ($cfg, $volid) = @_;
1440
1441 my $archive = abs_filesystem_path($cfg, $volid);
1442
89443394 1443 if ($volid =~ /vzdump-(lxc|openvz)-\d+-(\d{4})_(\d{2})_(\d{2})-(\d{2})_(\d{2})_(\d{2})\.(tgz|(tar(\.(gz|lzo))?))$/) {
086c4bf1 1444 return extract_vzdump_config_tar($archive, qr!^(\./etc/vzdump/(pct|vps)\.conf)$!);
89443394 1445 } elsif ($volid =~ /vzdump-qemu-\d+-(\d{4})_(\d{2})_(\d{2})-(\d{2})_(\d{2})_(\d{2})\.(tgz|((tar|vma)(\.(gz|lzo))?))$/) {
8898dd7b
FG
1446 my $format;
1447 my $comp;
1448 if ($7 eq 'tgz') {
1449 $format = 'tar';
1450 $comp = 'gz';
1451 } else {
1452 $format = $9;
1453 $comp = $11 if defined($11);
1454 }
1455
1456 if ($format eq 'tar') {
1457 return extract_vzdump_config_tar($archive, qr!\(\./qemu-server\.conf\)!);
1458 } else {
1459 return extract_vzdump_config_vma($archive, $comp);
1460 }
1461 } else {
1462 die "cannot determine backup guest type for backup archive '$volid'\n";
1463 }
1464}
1465
47f37b53
WB
1466sub volume_export {
1467 my ($cfg, $fh, $volid, $format, $snapshot, $base_snapshot, $with_snapshots) = @_;
1468
1469 my ($storeid, $volname) = parse_volume_id($volid, 1);
1470 die "cannot export volume '$volid'\n" if !$storeid;
1471 my $scfg = storage_config($cfg, $storeid);
1472 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
1473 return $plugin->volume_export($scfg, $storeid, $fh, $volname, $format,
1474 $snapshot, $base_snapshot, $with_snapshots);
1475}
1476
1477sub volume_import {
1478 my ($cfg, $fh, $volid, $format, $base_snapshot, $with_snapshots) = @_;
1479
1480 my ($storeid, $volname) = parse_volume_id($volid, 1);
1481 die "cannot import into volume '$volid'\n" if !$storeid;
1482 my $scfg = storage_config($cfg, $storeid);
1483 my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
1484 return $plugin->volume_import($scfg, $storeid, $fh, $volname, $format,
1485 $base_snapshot, $with_snapshots);
1486}
1487
f7621c01
DM
1488# bash completion helper
1489
1490sub complete_storage {
746e530f 1491 my ($cmdname, $pname, $cvalue) = @_;
f7621c01 1492
746e530f 1493 my $cfg = PVE::Storage::config();
180c8b02 1494
746e530f 1495 return $cmdname eq 'add' ? [] : [ PVE::Storage::storage_ids($cfg) ];
f7621c01
DM
1496}
1497
1498sub complete_storage_enabled {
746e530f 1499 my ($cmdname, $pname, $cvalue) = @_;
f7621c01 1500
746e530f 1501 my $res = [];
f7621c01 1502
746e530f
DM
1503 my $cfg = PVE::Storage::config();
1504 foreach my $sid (keys %{$cfg->{ids}}) {
1505 next if !storage_check_enabled($cfg, $sid, undef, 1);
1506 push @$res, $sid;
1507 }
1508 return $res;
f7621c01
DM
1509}
1510
98437f4c
DM
1511sub complete_content_type {
1512 my ($cmdname, $pname, $cvalue) = @_;
1513
1514 return [qw(rootdir images vztmpl iso backup)];
1515}
1516
bf7aed26
DM
1517sub complete_volume {
1518 my ($cmdname, $pname, $cvalue) = @_;
1519
1520 my $cfg = config();
1521
1522 my $storage_list = complete_storage_enabled();
1523
b70b0c58
DM
1524 if ($cvalue =~ m/^([^:]+):/) {
1525 $storage_list = [ $1 ];
1526 } else {
1527 if (scalar(@$storage_list) > 1) {
1528 # only list storage IDs to avoid large listings
1529 my $res = [];
1530 foreach my $storeid (@$storage_list) {
1531 # Hack: simply return 2 artificial values, so that
1532 # completions does not finish
1533 push @$res, "$storeid:volname", "$storeid:...";
1534 }
1535 return $res;
1536 }
1537 }
1538
bf7aed26
DM
1539 my $res = [];
1540 foreach my $storeid (@$storage_list) {
1541 my $vollist = PVE::Storage::volume_list($cfg, $storeid);
1542
1543 foreach my $item (@$vollist) {
1544 push @$res, $item->{volid};
1545 }
1546 }
1547
1548 return $res;
1549}
1550
b6cf0a66 15511;