]> git.proxmox.com Git - qemu-server.git/blame - PVE/VZDump/QemuServer.pm
vzdump: improve logging output with dirty bitmaps
[qemu-server.git] / PVE / VZDump / QemuServer.pm
CommitLineData
1e3baf05
DM
1package PVE::VZDump::QemuServer;
2
1e3baf05
DM
3use strict;
4use warnings;
d610b145 5
1e3baf05 6use File::Basename;
d610b145
TL
7use File::Path;
8use IO::File;
9use IPC::Open3;
69e62894 10use JSON;
d610b145
TL
11
12use PVE::Cluster qw(cfs_read_file);
66ab1d91 13use PVE::INotify;
91bd6c90 14use PVE::IPCC;
d610b145 15use PVE::JSONSchema;
0a13e08e 16use PVE::QMPClient;
f5bdefa4 17use PVE::Storage::Plugin;
c5983223 18use PVE::Storage::PBSPlugin;
1e3baf05 19use PVE::Storage;
d610b145
TL
20use PVE::Tools;
21use PVE::VZDump;
22
912792e2 23use PVE::QemuConfig;
1e3baf05 24use PVE::QemuServer;
3392d6ca 25use PVE::QemuServer::Machine;
0a13e08e 26use PVE::QemuServer::Monitor qw(mon_cmd);
1e3baf05
DM
27
28use base qw (PVE::VZDump::Plugin);
29
30sub new {
31 my ($class, $vzdump) = @_;
874a096e 32
66ab1d91 33 PVE::VZDump::check_bin('qm');
1e3baf05 34
e2812738 35 my $self = bless { vzdump => $vzdump }, $class;
1e3baf05
DM
36
37 $self->{vmlist} = PVE::QemuServer::vzlist();
38 $self->{storecfg} = PVE::Storage::config();
39
40 return $self;
41};
42
1e3baf05
DM
43sub type {
44 return 'qemu';
45}
46
47sub vmlist {
48 my ($self) = @_;
1e3baf05
DM
49 return [ keys %{$self->{vmlist}} ];
50}
51
52sub prepare {
53 my ($self, $task, $vmid, $mode) = @_;
54
55 $task->{disks} = [];
56
ffda963f 57 my $conf = $self->{vmlist}->{$vmid} = PVE::QemuConfig->load_config($vmid);
1e3baf05 58
85b84b7b
WL
59 $self->loginfo("VM Name: $conf->{name}")
60 if defined($conf->{name});
61
91bd6c90
DM
62 $self->{vm_was_running} = 1;
63 if (!PVE::QemuServer::check_running($vmid)) {
64 $self->{vm_was_running} = 0;
585b6e28
DM
65 }
66
1e3baf05
DM
67 $task->{hostname} = $conf->{name};
68
874a096e 69 my $hostname = PVE::INotify::nodename();
1e3baf05 70
b969cc68
DM
71 my $vollist = [];
72 my $drivehash = {};
185df962 73 my $backup_volumes = PVE::QemuConfig->get_backup_volumes($conf);
1e3baf05 74
185df962
AL
75 foreach my $volume (@{$backup_volumes}) {
76 my $name = $volume->{key};
5a92276e 77 my $volume_config = $volume->{volume_config};
185df962 78 my $volid = $volume_config->{file};
1e3baf05 79
185df962
AL
80 if (!$volume->{included}) {
81 $self->loginfo("exclude disk '$name' '$volid' ($volume->{reason})");
82 next;
83 } elsif ($self->{vm_was_running} && $volume_config->{iothread}) {
3392d6ca 84 if (!PVE::QemuServer::Machine::runs_at_least_qemu_version($vmid, 4, 0, 1)) {
185df962 85 die "disk '$name' '$volid' (iothread=on) can't use backup feature with running QEMU " .
48343b3f
TL
86 "version < 4.0.1! Either set backup=no for this drive or upgrade QEMU and restart VM\n";
87 }
b53b958b 88 } else {
185df962
AL
89 my $log = "include disk '$name' '$volid'";
90 if (defined(my $size = $volume_config->{size})) {
91 my $readable_size = PVE::JSONSchema::format_size($size);
0db93c2d 92 $log .= " $readable_size";
185df962 93 }
0db93c2d 94 $self->loginfo($log);
874a096e 95 }
b969cc68 96
f5bdefa4 97 my ($storeid, $volname) = PVE::Storage::parse_volume_id($volid, 1);
b969cc68 98 push @$vollist, $volid if $storeid;
185df962
AL
99 $drivehash->{$name} = $volume->{volume_config};
100 }
b969cc68
DM
101
102 PVE::Storage::activate_volumes($self->{storecfg}, $vollist);
103
075b417a
DM
104 foreach my $ds (sort keys %$drivehash) {
105 my $drive = $drivehash->{$ds};
874a096e 106
1e3baf05 107 my $volid = $drive->{file};
f5bdefa4 108 my ($storeid, $volname) = PVE::Storage::parse_volume_id($volid, 1);
a113a58a
TL
109
110 my $path = $volid;
1e3baf05 111 if ($storeid) {
b969cc68 112 $path = PVE::Storage::path($self->{storecfg}, $volid);
1e3baf05 113 }
b969cc68 114 next if !$path;
1e3baf05 115
a113a58a 116 my ($size, $format) = eval { PVE::Storage::volume_size_info($self->{storecfg}, $volid, 5) };
daca220d 117 die "no such volume '$volid'\n" if $@;
91bd6c90 118
a113a58a
TL
119 my $diskinfo = {
120 path => $path,
121 volid => $volid,
122 storeid => $storeid,
123 format => $format,
124 virtdev => $ds,
125 qmdevice => "drive-$ds",
126 };
1e3baf05
DM
127
128 if (-b $path) {
1e3baf05 129 $diskinfo->{type} = 'block';
1e3baf05 130 } else {
1e3baf05 131 $diskinfo->{type} = 'file';
1e3baf05
DM
132 }
133
134 push @{$task->{disks}}, $diskinfo;
b969cc68 135 }
1e3baf05
DM
136}
137
138sub vm_status {
139 my ($self, $vmid) = @_;
140
66ab1d91 141 my $running = PVE::QemuServer::check_running($vmid) ? 1 : 0;
874a096e
DM
142
143 return wantarray ? ($running, $running ? 'running' : 'stopped') : $running;
1e3baf05
DM
144}
145
146sub lock_vm {
147 my ($self, $vmid) = @_;
148
f301bc0d 149 PVE::QemuConfig->set_lock($vmid, 'backup');
1e3baf05
DM
150}
151
152sub unlock_vm {
153 my ($self, $vmid) = @_;
154
f301bc0d 155 PVE::QemuConfig->remove_lock($vmid, 'backup');
1e3baf05
DM
156}
157
158sub stop_vm {
159 my ($self, $task, $vmid) = @_;
160
161 my $opts = $self->{vzdump}->{opts};
162
163 my $wait = $opts->{stopwait} * 60;
164 # send shutdown and wait
254575e9 165 $self->cmd ("qm shutdown $vmid --skiplock --keepActive --timeout $wait");
1e3baf05
DM
166}
167
168sub start_vm {
169 my ($self, $task, $vmid) = @_;
170
66ab1d91 171 $self->cmd ("qm start $vmid --skiplock");
1e3baf05
DM
172}
173
174sub suspend_vm {
175 my ($self, $task, $vmid) = @_;
176
66ab1d91 177 $self->cmd ("qm suspend $vmid --skiplock");
1e3baf05
DM
178}
179
180sub resume_vm {
181 my ($self, $task, $vmid) = @_;
182
66ab1d91 183 $self->cmd ("qm resume $vmid --skiplock");
1e3baf05
DM
184}
185
1e3baf05
DM
186sub assemble {
187 my ($self, $task, $vmid) = @_;
188
04096e7b 189 my $conffile = PVE::QemuConfig->config_file($vmid);
1e3baf05
DM
190
191 my $outfile = "$task->{tmpdir}/qemu-server.conf";
c05f7f3f
WL
192 my $firewall_src = "/etc/pve/firewall/$vmid.fw";
193 my $firewall_dest = "$task->{tmpdir}/qemu-server.fw";
194
195 my $outfd = IO::File->new (">$outfile") ||
196 die "unable to open '$outfile'";
197 my $conffd = IO::File->new ($conffile, 'r') ||
198 die "unable open '$conffile'";
199
200 my $found_snapshot;
391c2230 201 my $found_pending;
c05f7f3f
WL
202 while (defined (my $line = <$conffd>)) {
203 next if $line =~ m/^\#vzdump\#/; # just to be sure
204 next if $line =~ m/^\#qmdump\#/; # just to be sure
391c2230
FG
205 if ($line =~ m/^\[(.*)\]\s*$/) {
206 if ($1 =~ m/PENDING/i) {
207 $found_pending = 1;
208 } else {
209 $found_snapshot = 1;
210 }
1e3baf05 211 }
1bd6fe13 212 next if $found_snapshot || $found_pending; # skip all snapshots and pending changes config data
391c2230 213
c05f7f3f
WL
214 if ($line =~ m/^unused\d+:\s*(\S+)\s*/) {
215 $self->loginfo("skip unused drive '$1' (not included into backup)");
216 next;
1e3baf05 217 }
c05f7f3f 218 next if $line =~ m/^lock:/ || $line =~ m/^parent:/;
91bd6c90 219
c05f7f3f
WL
220 print $outfd $line;
221 }
222
223 foreach my $di (@{$task->{disks}}) {
224 if ($di->{type} eq 'block' || $di->{type} eq 'file') {
225 my $storeid = $di->{storeid} || '';
226 my $format = $di->{format} || '';
227 print $outfd "#qmdump#map:$di->{virtdev}:$di->{qmdevice}:$storeid:$format:\n";
228 } else {
229 die "internal error";
91bd6c90 230 }
c05f7f3f 231 }
1e3baf05 232
c05f7f3f
WL
233 if ($found_snapshot) {
234 $self->loginfo("snapshots found (not included into backup)");
235 }
391c2230
FG
236 if ($found_pending) {
237 $self->loginfo("pending configuration changes found (not included into backup)");
238 }
239
c05f7f3f 240 PVE::Tools::file_copy($firewall_src, $firewall_dest) if -f $firewall_src;
1e3baf05
DM
241}
242
243sub archive {
fad02a16 244 my ($self, $task, $vmid, $filename, $comp) = @_;
1e3baf05 245
c5983223 246 my $opts = $self->{vzdump}->{opts};
c5983223
DM
247 my $scfg = $opts->{scfg};
248
69074863 249 if ($self->{vzdump}->{opts}->{pbs}) {
c5983223
DM
250 $self->archive_pbs($task, $vmid);
251 } else {
252 $self->archive_vma($task, $vmid, $filename, $comp);
253 }
254}
255
4d159c24
TL
256# number, [precision=1]
257my $num2str = sub {
258 return sprintf( "%." . ( $_[1] || 1 ) . "f", $_[0] );
259};
260sub bytes_to_human {
261 my ($bytes, $precission) = @_;
262
263 return $num2str->($bytes, $precission) . ' B' if $bytes < 1024;
264 my $kb = $bytes/1024;
265
266 return $num2str->($kb, $precission) . " KiB" if $kb < 1024;
267 my $mb = $kb/1024;
268
269 return $num2str->($mb, $precission) . " MiB" if $mb < 1024;
270 my $gb = $mb/1024;
271
272 return $num2str->($gb, $precission) . " GiB" if $gb < 1024;
273 my $tb = $gb/1024;
274
275 return $num2str->($tb, $precission) . " TiB";
276};
277
3a44897f
SR
278my $bitmap_action_to_human = sub {
279 my ($info) = @_;
280
281 my $action = $info->{action};
282
283 if ($action eq "not-used") {
284 return "disabled";
285 } elsif ($action eq "not-used-removed") {
286 return "disabled (old bitmap cleared)";
287 } elsif ($action eq "new") {
288 return "created new bitmap";
289 } elsif ($action eq "used") {
290 if ($info->{dirty} == 0) {
291 return "OK, drive clean";
292 } else {
293 my $size = bytes_to_human($info->{size});
294 my $dirty = bytes_to_human($info->{dirty});
295 return "OK, $dirty of $size dirty";
296 }
297 } elsif ($action eq "invalid") {
298 return "existing bitmap was invalid and has been cleared";
299 } else {
300 return "unknown";
301 }
302};
303
c5983223 304my $query_backup_status_loop = sub {
3a44897f 305 my ($self, $vmid, $job_uuid, $pbs_features) = @_;
c5983223 306
c5983223 307 my $starttime = time ();
09eb196b 308 my $last_time = $starttime;
4d159c24
TL
309 my ($last_percent, $last_total, $last_target, $last_zero, $last_transferred) = (-1, 0, 0, 0, 0);
310 my ($transferred, $reused);
c5983223 311
09eb196b
TL
312 my $get_mbps = sub {
313 my ($mb, $delta) = @_;
4d159c24
TL
314 return "0 B/s" if $mb <= 0;
315 my $bw = int(($mb / $delta));
316 return bytes_to_human($bw) . "/s";
09eb196b
TL
317 };
318
3a44897f
SR
319 my $target = 0;
320 my $has_query_bitmap = 0;
321 if (defined($pbs_features) && $pbs_features->{'query-bitmap-info'}) {
322 $has_query_bitmap = 1;
323 my $bitmap_info = mon_cmd($vmid, 'query-pbs-bitmap-info');
324 $self->loginfo("Fast incremental status:");
325 foreach my $info (@$bitmap_info) {
326 my $text = $bitmap_action_to_human->($info);
327 my $drive = $info->{drive};
328 $drive =~ s/^drive-//; # for consistency
329 $self->loginfo("$drive: $text");
330 $target += $info->{dirty};
331 }
332 }
333
c5983223 334 while(1) {
09eb196b
TL
335 my $status = mon_cmd($vmid, 'query-backup');
336
c5983223 337 my $total = $status->{total} || 0;
3a44897f 338 $target = $total if !$has_query_bitmap;
c5983223 339 $transferred = $status->{transferred} || 0;
4d159c24
TL
340 $reused = $status->{reused};
341 my $percent = $target ? int(($transferred * 100)/$target) : 0;
c5983223 342 my $zero = $status->{'zero-bytes'} || 0;
c5983223
DM
343
344 die "got unexpected uuid\n" if !$status->{uuid} || ($status->{uuid} ne $job_uuid);
345
346 my $ctime = time();
347 my $duration = $ctime - $starttime;
348
349 my $rbytes = $transferred - $last_transferred;
350 my $wbytes = $rbytes - ($zero - $last_zero);
351
352 my $timediff = ($ctime - $last_time) || 1; # fixme
09eb196b
TL
353 my $mbps_read = $get_mbps->($rbytes, $timediff);
354 my $mbps_write = $get_mbps->($wbytes, $timediff);
4d159c24
TL
355 my $target_h = bytes_to_human($target);
356 my $transferred_h = bytes_to_human($transferred);
357
4d159c24
TL
358 my $statusline = "status: $percent% ($transferred_h of $target_h), duration $duration"
359 .", read: $mbps_read, write: $mbps_write";
09eb196b 360
c5983223
DM
361 my $res = $status->{status} || 'unknown';
362 if ($res ne 'active') {
363 $self->loginfo($statusline);
09eb196b
TL
364 if ($res ne 'done') {
365 die (($status->{errmsg} || "unknown error") . "\n") if $res eq 'error';
366 die "got unexpected status '$res'\n";
09eb196b 367 }
6cdb568c
TL
368 $last_target = $target if $target;
369 $last_total = $total if $total;
370 $last_zero = $zero if $zero;
371 $last_transferred = $transferred if $transferred;
c5983223
DM
372 last;
373 }
09eb196b 374 if ($percent != $last_percent && ($timediff > 2)) {
c5983223 375 $self->loginfo($statusline);
09eb196b 376 $last_percent = $percent;
4d159c24 377 $last_target = $target if $target;
c5983223
DM
378 $last_total = $total if $total;
379 $last_zero = $zero if $zero;
380 $last_transferred = $transferred if $transferred;
381 $last_time = $ctime;
382 }
383 sleep(1);
384 }
385
386 my $duration = time() - $starttime;
387 if ($transferred && $duration) {
4d159c24 388 my $transferred_h = bytes_to_human($transferred, 2);
09eb196b 389 my $mbps = $get_mbps->($transferred, $duration);
4d159c24
TL
390 if ($reused) {
391 my $reused_h = bytes_to_human($reused, 2);
392 my $reuse_per = int($reused * 100 / $last_total);
91c9f3b0 393 $self->loginfo("backup was done incrementally, reused $reused_h (${reuse_per}%)");
4d159c24 394 }
91c9f3b0 395 $self->loginfo("transferred $transferred_h in $duration seconds ($mbps)");
4d159c24
TL
396 }
397
3a44897f 398 if (!defined($pbs_features) && $last_zero) {
4d159c24
TL
399 my $zero_per = $last_target ? int(($last_zero * 100)/$last_target) : 0;
400 my $zero_h = bytes_to_human($last_zero, 2);
401 $self->loginfo("Backup is sparse: ${zero_per}% ($zero_h) zero data");
c5983223 402 }
b4be9c02
TL
403
404 return {
405 total => $last_total,
406 reused => $reused,
407 };
c5983223
DM
408};
409
410sub archive_pbs {
411 my ($self, $task, $vmid) = @_;
412
1e3baf05 413 my $conffile = "$task->{tmpdir}/qemu-server.conf";
c05f7f3f 414 my $firewall = "$task->{tmpdir}/qemu-server.fw";
1e3baf05
DM
415
416 my $opts = $self->{vzdump}->{opts};
c5983223
DM
417 my $scfg = $opts->{scfg};
418
419 my $starttime = time();
420
c5983223
DM
421 my $server = $scfg->{server};
422 my $datastore = $scfg->{datastore};
423 my $username = $scfg->{username} // 'root@pam';
424 my $fingerprint = $scfg->{fingerprint};
425
426 my $repo = "$username\@$server:$datastore";
427 my $password = PVE::Storage::PBSPlugin::pbs_get_password($scfg, $opts->{storage});
ece74030 428 my $keyfile = PVE::Storage::PBSPlugin::pbs_encryption_key_file_name($scfg, $opts->{storage});
c5983223 429
d11e91d2 430 my $diskcount = scalar(@{$task->{disks}});
c5983223
DM
431 if (PVE::QemuConfig->is_template($self->{vmlist}->{$vmid}) || !$diskcount) {
432 my @pathlist;
b4be9c02 433 # FIXME: accumulate disk sizes to use for backup job (email) log
c5983223
DM
434 foreach my $di (@{$task->{disks}}) {
435 if ($di->{type} eq 'block' || $di->{type} eq 'file') {
436 push @pathlist, "$di->{qmdevice}.img:$di->{path}";
437 } else {
d11e91d2 438 die "implement me (type $di->{type})";
c5983223
DM
439 }
440 }
441
442 if (!$diskcount) {
443 $self->loginfo("backup contains no disks");
444 }
445
446 local $ENV{PBS_PASSWORD} = $password;
77b24c62 447 local $ENV{PBS_FINGERPRINT} = $fingerprint if defined($fingerprint);
c5983223
DM
448 my $cmd = [
449 '/usr/bin/proxmox-backup-client',
450 'backup',
451 '--repository', $repo,
452 '--backup-type', 'vm',
453 '--backup-id', "$vmid",
454 '--backup-time', $task->{backup_time},
d11e91d2 455 ];
c5983223
DM
456
457 push @$cmd, "qemu-server.conf:$conffile";
458 push @$cmd, "fw.conf:$firewall" if -e $firewall;
459 push @$cmd, @pathlist if scalar(@pathlist);
460
461 $self->loginfo("starting template backup");
462 $self->loginfo(join(' ', @$cmd));
463
464 $self->cmd($cmd);
465
466 return;
467 }
468
81dcd479
TL
469 # get list early so we die on unkown drive types before doing anything
470 my $devlist = _get_task_devlist($task);
c5983223 471
0b2f574b 472 $self->enforce_vm_running_for_backup($vmid);
c5983223 473
f6168f1a 474 my $backup_job_uuid;
c5983223
DM
475 eval {
476 $SIG{INT} = $SIG{TERM} = $SIG{QUIT} = $SIG{HUP} = $SIG{PIPE} = sub {
d11e91d2 477 die "interrupted by signal\n";
c5983223
DM
478 };
479
fb9f512c
SR
480 my $qemu_support = eval { mon_cmd($vmid, "query-proxmox-support") };
481 if (!$qemu_support) {
482 die "PBS backups are not supported by the running QEMU version. Please make "
483 . "sure you've installed the latest version and the VM has been restarted.\n";
484 }
485
cb521f2d 486 my $fs_frozen = $self->qga_fs_freeze($task, $vmid);
c5983223 487
d11e91d2
TL
488 my $params = {
489 format => "pbs",
490 'backup-file' => $repo,
491 'backup-id' => "$vmid",
492 'backup-time' => $task->{backup_time},
493 password => $password,
494 devlist => $devlist,
495 'config-file' => $conffile,
c5983223 496 };
d11e91d2
TL
497 $params->{fingerprint} = $fingerprint if defined($fingerprint);
498 $params->{'firewall-file'} = $firewall if -e $firewall;
ece74030
WB
499 if (-e $keyfile) {
500 $self->loginfo("enabling encryption");
501 $params->{keyfile} = $keyfile;
502 $params->{encrypt} = JSON::true;
503 } else {
504 $params->{encrypt} = JSON::false;
505 }
c5983223 506
fb9f512c
SR
507 $params->{'use-dirty-bitmap'} = JSON::true if $qemu_support->{'pbs-dirty-bitmap'};
508
f57666e9
DM
509 $params->{timeout} = 60; # give some time to connect to the backup server
510
d11e91d2 511 my $res = eval { mon_cmd($vmid, "backup", %$params) };
c5983223 512 my $qmperr = $@;
d11e91d2 513 $backup_job_uuid = $res->{UUID} if $res;
c5983223 514
1ece829a
TL
515 if ($fs_frozen) {
516 $self->qga_fs_thaw($vmid);
c5983223
DM
517 }
518
519 die $qmperr if $qmperr;
f6168f1a 520 die "got no uuid for backup task\n" if !defined($backup_job_uuid);
c5983223 521
f6168f1a 522 $self->loginfo("started backup task '$backup_job_uuid'");
c5983223 523
0b2f574b 524 $self->resume_vm_after_job_start($task, $vmid);
c5983223 525
3a44897f 526 my $stat = $query_backup_status_loop->($self, $vmid, $backup_job_uuid, $qemu_support);
2098f2ff 527 $task->{size} = $stat->{total};
c5983223
DM
528 };
529 my $err = $@;
c5983223
DM
530 if ($err) {
531 $self->logerr($err);
0b2f574b 532 $self->mon_backup_cancel($vmid) if defined($backup_job_uuid);
c5983223 533 }
0b2f574b 534 $self->restore_vm_power_state($vmid);
c5983223
DM
535
536 die $err if $err;
537}
538
02da0c65
TL
539my $fork_compressor_pipe = sub {
540 my ($self, $comp, $outfileno) = @_;
541
542 my @pipefd = POSIX::pipe();
543 my $cpid = fork();
544 die "unable to fork worker - $!" if !defined($cpid) || $cpid < 0;
545 if ($cpid == 0) {
546 eval {
547 POSIX::close($pipefd[1]);
548 # redirect STDIN
549 my $fd = fileno(STDIN);
550 close STDIN;
551 POSIX::close(0) if $fd != 0;
552 die "unable to redirect STDIN - $!"
553 if !open(STDIN, "<&", $pipefd[0]);
554
555 # redirect STDOUT
556 $fd = fileno(STDOUT);
557 close STDOUT;
558 POSIX::close (1) if $fd != 1;
559
560 die "unable to redirect STDOUT - $!"
561 if !open(STDOUT, ">&", $outfileno);
562
563 exec($comp);
564 die "fork compressor '$comp' failed\n";
565 };
566 if (my $err = $@) {
567 $self->logerr($err);
568 POSIX::_exit(1);
569 }
570 POSIX::_exit(0);
571 kill(-9, $$);
572 } else {
573 POSIX::close($pipefd[0]);
574 $outfileno = $pipefd[1];
575 }
576
577 return ($cpid, $outfileno);
578};
579
c5983223
DM
580sub archive_vma {
581 my ($self, $task, $vmid, $filename, $comp) = @_;
582
583 my $conffile = "$task->{tmpdir}/qemu-server.conf";
584 my $firewall = "$task->{tmpdir}/qemu-server.fw";
585
586 my $opts = $self->{vzdump}->{opts};
587
588 my $starttime = time();
1e3baf05 589
91bd6c90
DM
590 my $speed = 0;
591 if ($opts->{bwlimit}) {
874a096e 592 $speed = $opts->{bwlimit}*1024;
91bd6c90 593 }
1e3baf05 594
c82935e9 595 my $diskcount = scalar(@{$task->{disks}});
ffda963f 596 if (PVE::QemuConfig->is_template($self->{vmlist}->{$vmid}) || !$diskcount) {
23b4120b
DM
597 my @pathlist;
598 foreach my $di (@{$task->{disks}}) {
599 if ($di->{type} eq 'block' || $di->{type} eq 'file') {
600 push @pathlist, "$di->{qmdevice}=$di->{path}";
601 } else {
602 die "implement me";
603 }
604 }
605
c82935e9
DM
606 if (!$diskcount) {
607 $self->loginfo("backup contains no disks");
608 }
609
23b4120b
DM
610 my $outcmd;
611 if ($comp) {
874a096e 612 $outcmd = "exec:$comp";
23b4120b 613 } else {
874a096e 614 $outcmd = "exec:cat";
23b4120b
DM
615 }
616
a2fab11a 617 $outcmd .= " > $filename" if !$opts->{stdout};
23b4120b 618
c05f7f3f
WL
619 my $cmd = ['/usr/bin/vma', 'create', '-v', '-c', $conffile];
620 push @$cmd, '-c', $firewall if -e $firewall;
621 push @$cmd, $outcmd, @pathlist;
23b4120b
DM
622
623 $self->loginfo("starting template backup");
624 $self->loginfo(join(' ', @$cmd));
625
626 if ($opts->{stdout}) {
6bb12239 627 $self->cmd($cmd, output => ">&" . fileno($opts->{stdout}));
23b4120b
DM
628 } else {
629 $self->cmd($cmd);
630 }
631
632 return;
633 }
634
81dcd479 635 my $devlist = _get_task_devlist($task);
1e3baf05 636
0b2f574b 637 $self->enforce_vm_running_for_backup($vmid);
91bd6c90
DM
638
639 my $cpid;
d2cc2cbe
DM
640 my $backup_job_uuid;
641
91bd6c90
DM
642 eval {
643 $SIG{INT} = $SIG{TERM} = $SIG{QUIT} = $SIG{HUP} = $SIG{PIPE} = sub {
d11e91d2 644 die "interrupted by signal\n";
91bd6c90
DM
645 };
646
91bd6c90
DM
647 my $outfh;
648 if ($opts->{stdout}) {
649 $outfh = $opts->{stdout};
650 } else {
651 $outfh = IO::File->new($filename, "w") ||
652 die "unable to open file '$filename' - $!\n";
653 }
02da0c65 654 my $outfileno = fileno($outfh);
91bd6c90 655
91bd6c90 656 if ($comp) {
02da0c65 657 ($cpid, $outfileno) = $fork_compressor_pipe->($self, $comp, $outfileno);
91bd6c90
DM
658 }
659
e8705fc5
TL
660 my $qmpclient = PVE::QMPClient->new();
661 my $backup_cb = sub {
662 my ($vmid, $resp) = @_;
663 $backup_job_uuid = $resp->{return}->{UUID};
664 };
665 my $add_fd_cb = sub {
91bd6c90
DM
666 my ($vmid, $resp) = @_;
667
c05f7f3f
WL
668 my $params = {
669 'backup-file' => "/dev/fdname/backup",
670 speed => $speed,
671 'config-file' => $conffile,
672 devlist => $devlist
673 };
c05f7f3f 674 $params->{'firewall-file'} = $firewall if -e $firewall;
d11e91d2 675
c05f7f3f 676 $qmpclient->queue_cmd($vmid, $backup_cb, 'backup', %$params);
91bd6c90
DM
677 };
678
d11e91d2 679 $qmpclient->queue_cmd($vmid, $add_fd_cb, 'getfd', fd => $outfileno, fdname => "backup");
ab6a9a0c 680
cb521f2d 681 my $fs_frozen = $self->qga_fs_freeze($task, $vmid);
874a096e 682
c5983223 683 eval { $qmpclient->queue_execute(30) };
f0f30448 684 my $qmperr = $@;
91bd6c90 685
1ece829a
TL
686 if ($fs_frozen) {
687 $self->qga_fs_thaw($vmid);
ab6a9a0c 688 }
d11e91d2 689
f0f30448 690 die $qmperr if $qmperr;
874a096e 691 die $qmpclient->{errors}->{$vmid} if $qmpclient->{errors}->{$vmid};
91bd6c90
DM
692
693 if ($cpid) {
874a096e 694 POSIX::close($outfileno) == 0 ||
91bd6c90
DM
695 die "close output file handle failed\n";
696 }
697
d2cc2cbe 698 die "got no uuid for backup task\n" if !defined($backup_job_uuid);
91bd6c90 699
d2cc2cbe 700 $self->loginfo("started backup task '$backup_job_uuid'");
91bd6c90 701
0b2f574b 702 $self->resume_vm_after_job_start($task, $vmid);
91bd6c90 703
d2cc2cbe 704 $query_backup_status_loop->($self, $vmid, $backup_job_uuid);
91bd6c90
DM
705 };
706 my $err = $@;
19599cd9 707 if ($err) {
60635a57 708 $self->logerr($err);
0b2f574b 709 $self->mon_backup_cancel($vmid) if defined($backup_job_uuid);
19599cd9
DM
710 }
711
0b2f574b 712 $self->restore_vm_power_state($vmid);
91bd6c90
DM
713
714 if ($err) {
874a096e
DM
715 if ($cpid) {
716 kill(9, $cpid);
91bd6c90
DM
717 waitpid($cpid, 0);
718 }
719 die $err;
720 }
721
722 if ($cpid && (waitpid($cpid, 0) > 0)) {
723 my $stat = $?;
724 my $ec = $stat >> 8;
725 my $signal = $stat & 127;
726 if ($ec || $signal) {
874a096e 727 die "$comp failed - wrong exit status $ec" .
91bd6c90
DM
728 ($signal ? " (signal $signal)\n" : "\n");
729 }
730 }
731}
732
81dcd479
TL
733sub _get_task_devlist {
734 my ($task) = @_;
735
736 my $devlist = '';
737 foreach my $di (@{$task->{disks}}) {
738 if ($di->{type} eq 'block' || $di->{type} eq 'file') {
739 $devlist .= ',' if $devlist;
740 $devlist .= $di->{qmdevice};
741 } else {
742 die "implement me (type '$di->{type}')";
743 }
744 }
745 return $devlist;
746}
747
1ece829a 748sub qga_fs_freeze {
cb521f2d
TL
749 my ($self, $task, $vmid) = @_;
750 return if !$self->{vmlist}->{$vmid}->{agent} || $task->{mode} eq 'stop' || !$self->{vm_was_running};
1ece829a
TL
751
752 if (!PVE::QemuServer::qga_check_running($vmid, 1)) {
753 $self->loginfo("skipping guest-agent 'fs-freeze', agent configured but not running?");
754 return;
755 }
756
757 $self->loginfo("issuing guest-agent 'fs-freeze' command");
758 eval { mon_cmd($vmid, "guest-fsfreeze-freeze") };
759 $self->logerr($@) if $@;
760
761 return 1; # even on mon command error, ensure we always thaw again
762}
763
764# only call if fs_freeze return 1
765sub qga_fs_thaw {
766 my ($self, $vmid) = @_;
767
768 $self->loginfo("issuing guest-agent 'fs-thaw' command");
769 eval { mon_cmd($vmid, "guest-fsfreeze-thaw") };
770 $self->logerr($@) if $@;
771}
772
0b2f574b
TL
773# we need a running QEMU/KVM process for backup, starts a paused (prelaunch)
774# one if VM isn't already running
775sub enforce_vm_running_for_backup {
776 my ($self, $vmid) = @_;
777
778 if (PVE::QemuServer::check_running($vmid)) {
779 $self->{vm_was_running} = 1;
780 return;
781 }
782
783 eval {
784 $self->loginfo("starting kvm to execute backup task");
785 # start with skiplock
0c498cca
FG
786 my $params = {
787 skiplock => 1,
788 paused => 1,
789 };
790 PVE::QemuServer::vm_start($self->{storecfg}, $vmid, $params);
0b2f574b
TL
791 };
792 die $@ if $@;
793}
794
795# resume VM againe once we got in a clear state (stop mode backup of running VM)
796sub resume_vm_after_job_start {
797 my ($self, $task, $vmid) = @_;
798
799 return if !$self->{vm_was_running};
800
801 if (my $stoptime = $task->{vmstoptime}) {
802 my $delay = time() - $task->{vmstoptime};
803 $task->{vmstoptime} = undef; # avoid printing 'online after ..' twice
804 $self->loginfo("resuming VM again after $delay seconds");
805 } else {
806 $self->loginfo("resuming VM again");
807 }
808 mon_cmd($vmid, 'cont');
809}
810
811# stop again if VM was not running before
812sub restore_vm_power_state {
813 my ($self, $vmid) = @_;
814
815 # we always let VMs keep running
816 return if $self->{vm_was_running};
817
818 eval {
819 my $resp = mon_cmd($vmid, 'query-status');
820 my $status = $resp && $resp->{status} ? $resp->{status} : 'unknown';
821 if ($status eq 'prelaunch') {
822 $self->loginfo("stopping kvm after backup task");
823 PVE::QemuServer::vm_stop($self->{storecfg}, $vmid, 1);
824 } else {
825 $self->loginfo("kvm status changed after backup ('$status') - keep VM running");
826 }
827 };
828 warn $@ if $@;
829}
830
831sub mon_backup_cancel {
832 my ($self, $vmid) = @_;
833
834 $self->loginfo("aborting backup job");
835 eval { mon_cmd($vmid, 'backup-cancel') };
836 $self->logerr($@) if $@;
837}
838
91bd6c90
DM
839sub snapshot {
840 my ($self, $task, $vmid) = @_;
841
842 # nothing to do
1e3baf05
DM
843}
844
845sub cleanup {
846 my ($self, $task, $vmid) = @_;
847
91bd6c90 848 # nothing to do ?
1e3baf05
DM
849}
850
8511;