]> git.proxmox.com Git - qemu-server.git/blobdiff - PVE/VZDump/QemuServer.pm
avoid backup command timeout with pbs
[qemu-server.git] / PVE / VZDump / QemuServer.pm
index 3b79b15d7451657b211a9f7809a7d8d7fec157a1..8513d89743ccefbb1c875af1a2f5d30607cfcd82 100644 (file)
@@ -19,6 +19,7 @@ use PVE::Storage;
 use PVE::Tools;
 use PVE::VZDump;
 
+use PVE::QemuConfig;
 use PVE::QemuServer;
 use PVE::QemuServer::Machine;
 use PVE::QemuServer::Monitor qw(mon_cmd);
@@ -68,37 +69,34 @@ sub prepare {
 
     my $vollist = [];
     my $drivehash = {};
-    PVE::QemuServer::foreach_drive($conf, sub {
-       my ($ds, $drive) = @_;
+    my $backup_volumes = PVE::QemuConfig->get_backup_volumes($conf);
 
-       return if PVE::QemuServer::drive_is_cdrom($drive);
+    foreach my $volume (@{$backup_volumes}) {
+       my $name = $volume->{key};
+       my $volume_config = $volume->{volume_config};
+       my $volid = $volume_config->{file};
 
-       my $volid = $drive->{file};
-
-       if (defined($drive->{backup}) && !$drive->{backup}) {
-           $self->loginfo("exclude disk '$ds' '$volid' (backup=no)");
-           return;
-       } elsif ($self->{vm_was_running} && $drive->{iothread}) {
+       if (!$volume->{included}) {
+           $self->loginfo("exclude disk '$name' '$volid' ($volume->{reason})");
+           next;
+       } elsif ($self->{vm_was_running} && $volume_config->{iothread}) {
            if (!PVE::QemuServer::Machine::runs_at_least_qemu_version($vmid, 4, 0, 1)) {
-               die "disk '$ds' '$volid' (iothread=on) can't use backup feature with running QEMU " .
+               die "disk '$name' '$volid' (iothread=on) can't use backup feature with running QEMU " .
                    "version < 4.0.1! Either set backup=no for this drive or upgrade QEMU and restart VM\n";
            }
-       } elsif ($ds =~ m/^efidisk/ && (!defined($conf->{bios}) || $conf->{bios} ne 'ovmf')) {
-           $self->loginfo("excluding '$ds' (efidisks can only be backed up when BIOS is set to 'ovmf')");
-           return;
        } else {
-           my $log = "include disk '$ds' '$volid'";
-          if (defined $drive->{size}) {
-               my $readable_size = PVE::JSONSchema::format_size($drive->{size});
+           my $log = "include disk '$name' '$volid'";
+           if (defined(my $size = $volume_config->{size})) {
+               my $readable_size = PVE::JSONSchema::format_size($size);
                $log .= " $readable_size";
-          }
+           }
            $self->loginfo($log);
        }
 
        my ($storeid, $volname) = PVE::Storage::parse_volume_id($volid, 1);
        push @$vollist, $volid if $storeid;
-       $drivehash->{$ds} = $drive;
-    });
+       $drivehash->{$name} = $volume->{volume_config};
+    }
 
     PVE::Storage::activate_volumes($self->{storecfg}, $vollist);
 
@@ -209,8 +207,8 @@ sub assemble {
            } else {
                $found_snapshot = 1;
            }
-           next; # skip all snapshots and pending changes config data
        }
+       next if $found_snapshot || $found_pending; # skip all snapshots and pending changes config data
 
        if ($line =~ m/^unused\d+:\s*(\S+)\s*/) {
            $self->loginfo("skip unused drive '$1' (not included into backup)");
@@ -247,7 +245,7 @@ sub archive {
     my $opts = $self->{vzdump}->{opts};
     my $scfg = $opts->{scfg};
 
-    if ($scfg->{type} eq 'pbs') {
+    if ($self->{vzdump}->{opts}->{pbs}) {
        $self->archive_pbs($task, $vmid);
     } else {
        $self->archive_vma($task, $vmid, $filename, $comp);
@@ -327,13 +325,10 @@ sub archive_pbs {
     my $firewall = "$task->{tmpdir}/qemu-server.fw";
 
     my $opts = $self->{vzdump}->{opts};
-
     my $scfg = $opts->{scfg};
 
     my $starttime = time();
 
-    my $diskcount = scalar(@{$task->{disks}});
-
     my $server = $scfg->{server};
     my $datastore = $scfg->{datastore};
     my $username = $scfg->{username} // 'root@pam';
@@ -342,13 +337,14 @@ sub archive_pbs {
     my $repo = "$username\@$server:$datastore";
     my $password = PVE::Storage::PBSPlugin::pbs_get_password($scfg, $opts->{storage});
 
+    my $diskcount = scalar(@{$task->{disks}});
     if (PVE::QemuConfig->is_template($self->{vmlist}->{$vmid}) || !$diskcount) {
        my @pathlist;
        foreach my $di (@{$task->{disks}}) {
            if ($di->{type} eq 'block' || $di->{type} eq 'file') {
                push @pathlist, "$di->{qmdevice}.img:$di->{path}";
            } else {
-               die "implement me";
+               die "implement me (type $di->{type})";
            }
        }
 
@@ -357,6 +353,7 @@ sub archive_pbs {
        }
 
        local $ENV{PBS_PASSWORD} = $password;
+       local $ENV{PBS_FINGERPRINT} = $fingerprint if defined($fingerprint);
        my $cmd = [
            '/usr/bin/proxmox-backup-client',
            'backup',
@@ -364,9 +361,7 @@ sub archive_pbs {
            '--backup-type', 'vm',
            '--backup-id', "$vmid",
            '--backup-time', $task->{backup_time},
-           ];
-
-       push @$cmd, '--fingerprint', $fingerprint if defined($fingerprint);
+       ];
 
        push @$cmd, "qemu-server.conf:$conffile";
        push @$cmd, "fw.conf:$firewall" if -e $firewall;
@@ -383,120 +378,53 @@ sub archive_pbs {
     # get list early so we die on unkown drive types before doing anything
     my $devlist = _get_task_devlist($task);
 
-    my $stop_after_backup;
-    my $resume_on_backup;
-
-    my $skiplock = 1;
-    my $vm_is_running = PVE::QemuServer::check_running($vmid);
-    if (!$vm_is_running) {
-       eval {
-           $self->loginfo("starting kvm to execute backup task");
-           PVE::QemuServer::vm_start($self->{storecfg}, $vmid, undef,
-                                     $skiplock, undef, 1);
-           if ($self->{vm_was_running}) {
-               $resume_on_backup = 1;
-           } else {
-               $stop_after_backup = 1;
-           }
-       };
-       if (my $err = $@) {
-           die $err;
-       }
-    }
+    $self->enforce_vm_running_for_backup($vmid);
 
     my $backup_job_uuid;
-
-    my $interrupt_msg = "interrupted by signal\n";
     eval {
        $SIG{INT} = $SIG{TERM} = $SIG{QUIT} = $SIG{HUP} = $SIG{PIPE} = sub {
-           die $interrupt_msg;
+           die "interrupted by signal\n";
        };
 
-       my $agent_running = 0;
-
-       if ($self->{vmlist}->{$vmid}->{agent} && $vm_is_running) {
-           $agent_running = PVE::QemuServer::qga_check_running($vmid);
-       }
-
-       if ($agent_running){
-           eval { mon_cmd($vmid, "guest-fsfreeze-freeze"); };
-           if (my $err = $@) {
-               $self->logerr($err);
-           }
-       }
-
-       eval {
+       my $fs_frozen = $self->qga_fs_freeze($task, $vmid);
 
-           my $params = {
-               format => "pbs",
-               'backup-file' => $repo,
-               'backup-id' => "$vmid",
-               'backup-time' => $task->{backup_time},
-               password => $password,
-               devlist => $devlist,
-               'config-file' => $conffile,
-           };
-           $params->{fingerprint} = $fingerprint if defined($fingerprint);
-           $params->{'firewall-file'} = $firewall if -e $firewall;
-           my $res = mon_cmd($vmid, "backup", %$params);
-           $backup_job_uuid = $res->{UUID};
+       my $params = {
+           format => "pbs",
+           'backup-file' => $repo,
+           'backup-id' => "$vmid",
+           'backup-time' => $task->{backup_time},
+           password => $password,
+           devlist => $devlist,
+           'config-file' => $conffile,
        };
+       $params->{fingerprint} = $fingerprint if defined($fingerprint);
+       $params->{'firewall-file'} = $firewall if -e $firewall;
 
+       $params->{timeout} = 60; # give some time to connect to the backup server
+
+       my $res = eval { mon_cmd($vmid, "backup", %$params) };
        my $qmperr = $@;
+       $backup_job_uuid = $res->{UUID} if $res;
 
-       if ($agent_running){
-           eval { mon_cmd($vmid, "guest-fsfreeze-thaw"); };
-           if (my $err = $@) {
-               $self->logerr($err);
-           }
+       if ($fs_frozen) {
+           $self->qga_fs_thaw($vmid);
        }
 
        die $qmperr if $qmperr;
-
        die "got no uuid for backup task\n" if !defined($backup_job_uuid);
 
        $self->loginfo("started backup task '$backup_job_uuid'");
 
-       if ($resume_on_backup) {
-           if (my $stoptime = $task->{vmstoptime}) {
-               my $delay = time() - $task->{vmstoptime};
-               $task->{vmstoptime} = undef; # avoid printing 'online after ..' twice
-               $self->loginfo("resuming VM again after $delay seconds");
-           } else {
-               $self->loginfo("resuming VM again");
-           }
-           mon_cmd($vmid, 'cont');
-       }
+       $self->resume_vm_after_job_start($task, $vmid);
 
        $query_backup_status_loop->($self, $vmid, $backup_job_uuid);
     };
     my $err = $@;
-
     if ($err) {
        $self->logerr($err);
-       if (defined($backup_job_uuid)) {
-           $self->loginfo("aborting backup job");
-           eval { mon_cmd($vmid, 'backup-cancel'); };
-           if (my $err1 = $@) {
-               $self->logerr($err1);
-           }
-       }
-    }
-
-    if ($stop_after_backup) {
-       # stop if not running
-       eval {
-           my $resp = mon_cmd($vmid, 'query-status');
-           my $status = $resp && $resp->{status} ?  $resp->{status} : 'unknown';
-           if ($status eq 'prelaunch') {
-               $self->loginfo("stopping kvm after backup task");
-               PVE::QemuServer::vm_stop($self->{storecfg}, $vmid, $skiplock);
-           } else {
-               $self->loginfo("kvm status changed after backup ('$status')" .
-                              " - keep VM running");
-           }
-       }
+       $self->mon_backup_cancel($vmid) if defined($backup_job_uuid);
     }
+    $self->restore_vm_power_state($vmid);
 
     die $err if $err;
 }
@@ -558,7 +486,6 @@ sub archive_vma {
     }
 
     my $diskcount = scalar(@{$task->{disks}});
-
     if (PVE::QemuConfig->is_template($self->{vmlist}->{$vmid}) || !$diskcount) {
        my @pathlist;
        foreach my $di (@{$task->{disks}}) {
@@ -590,7 +517,7 @@ sub archive_vma {
        $self->loginfo(join(' ', @$cmd));
 
        if ($opts->{stdout}) {
-           $self->cmd($cmd, output => ">&=" . fileno($opts->{stdout}));
+           $self->cmd($cmd, output => ">&" . fileno($opts->{stdout}));
        } else {
            $self->cmd($cmd);
        }
@@ -600,41 +527,14 @@ sub archive_vma {
 
     my $devlist = _get_task_devlist($task);
 
-    my $stop_after_backup;
-    my $resume_on_backup;
-
-    my $skiplock = 1;
-    my $vm_is_running = PVE::QemuServer::check_running($vmid);
-    if (!$vm_is_running) {
-       eval {
-           $self->loginfo("starting kvm to execute backup task");
-           PVE::QemuServer::vm_start($self->{storecfg}, $vmid, undef,
-                                     $skiplock, undef, 1);
-           if ($self->{vm_was_running}) {
-               $resume_on_backup = 1;
-           } else {
-               $stop_after_backup = 1;
-           }
-       };
-       if (my $err = $@) {
-           die $err;
-       }
-    }
+    $self->enforce_vm_running_for_backup($vmid);
 
     my $cpid;
     my $backup_job_uuid;
 
-    my $interrupt_msg = "interrupted by signal\n";
     eval {
        $SIG{INT} = $SIG{TERM} = $SIG{QUIT} = $SIG{HUP} = $SIG{PIPE} = sub {
-           die $interrupt_msg;
-       };
-
-       my $qmpclient = PVE::QMPClient->new();
-
-       my $backup_cb = sub {
-           my ($vmid, $resp) = @_;
-           $backup_job_uuid = $resp->{return}->{UUID};
+           die "interrupted by signal\n";
        };
 
        my $outfh;
@@ -650,7 +550,12 @@ sub archive_vma {
            ($cpid, $outfileno) = $fork_compressor_pipe->($self, $comp, $outfileno);
        }
 
-       my $add_fd_cb = sub {
+       my $qmpclient = PVE::QMPClient->new();
+       my $backup_cb = sub {
+           my ($vmid, $resp) = @_;
+           $backup_job_uuid = $resp->{return}->{UUID};
+       };
+       my $add_fd_cb = sub {
            my ($vmid, $resp) = @_;
 
            my $params = {
@@ -659,40 +564,22 @@ sub archive_vma {
                'config-file' => $conffile,
                devlist => $devlist
            };
-
            $params->{'firewall-file'} = $firewall if -e $firewall;
+
            $qmpclient->queue_cmd($vmid, $backup_cb, 'backup', %$params);
        };
 
-       $qmpclient->queue_cmd($vmid, $add_fd_cb, 'getfd',
-                             fd => $outfileno, fdname => "backup");
+       $qmpclient->queue_cmd($vmid, $add_fd_cb, 'getfd', fd => $outfileno, fdname => "backup");
 
-       my $agent_running = 0;
-
-       if ($self->{vmlist}->{$vmid}->{agent} && $vm_is_running) {
-           $agent_running = PVE::QemuServer::qga_check_running($vmid);
-           $self->loginfo("skipping guest-agent 'fs-freeze', agent configured but not running?")
-               if !$agent_running;
-       }
-
-       if ($agent_running){
-           $self->loginfo("issuing guest-agent 'fs-freeze' command");
-           eval { mon_cmd($vmid, "guest-fsfreeze-freeze"); };
-           if (my $err = $@) {
-               $self->logerr($err);
-           }
-       }
+       my $fs_frozen = $self->qga_fs_freeze($task, $vmid);
 
        eval { $qmpclient->queue_execute(30) };
        my $qmperr = $@;
 
-       if ($agent_running){
-           $self->loginfo("issuing guest-agent 'fs-thaw' command");
-           eval { mon_cmd($vmid, "guest-fsfreeze-thaw"); };
-           if (my $err = $@) {
-               $self->logerr($err);
-           }
+       if ($fs_frozen) {
+           $self->qga_fs_thaw($vmid);
        }
+
        die $qmperr if $qmperr;
        die $qmpclient->{errors}->{$vmid} if $qmpclient->{errors}->{$vmid};
 
@@ -705,46 +592,17 @@ sub archive_vma {
 
        $self->loginfo("started backup task '$backup_job_uuid'");
 
-       if ($resume_on_backup) {
-           if (my $stoptime = $task->{vmstoptime}) {
-               my $delay = time() - $task->{vmstoptime};
-               $task->{vmstoptime} = undef; # avoid printing 'online after ..' twice
-               $self->loginfo("resuming VM again after $delay seconds");
-           } else {
-               $self->loginfo("resuming VM again");
-           }
-           mon_cmd($vmid, 'cont');
-       }
+       $self->resume_vm_after_job_start($task, $vmid);
 
        $query_backup_status_loop->($self, $vmid, $backup_job_uuid);
     };
     my $err = $@;
-
     if ($err) {
        $self->logerr($err);
-       if (defined($backup_job_uuid)) {
-           $self->loginfo("aborting backup job");
-           eval { mon_cmd($vmid, 'backup-cancel'); };
-           if (my $err1 = $@) {
-               $self->logerr($err1);
-           }
-       }
+       $self->mon_backup_cancel($vmid) if defined($backup_job_uuid);
     }
 
-    if ($stop_after_backup) {
-       # stop if not running
-       eval {
-           my $resp = mon_cmd($vmid, 'query-status');
-           my $status = $resp && $resp->{status} ?  $resp->{status} : 'unknown';
-           if ($status eq 'prelaunch') {
-               $self->loginfo("stopping kvm after backup task");
-               PVE::QemuServer::vm_stop($self->{storecfg}, $vmid, $skiplock);
-           } else {
-               $self->loginfo("kvm status changed after backup ('$status')" .
-                              " - keep VM running");
-           }
-       }
-    }
+    $self->restore_vm_power_state($vmid);
 
     if ($err) {
        if ($cpid) {
@@ -780,6 +638,97 @@ sub _get_task_devlist {
     return $devlist;
 }
 
+sub qga_fs_freeze {
+    my ($self, $task, $vmid) = @_;
+    return if !$self->{vmlist}->{$vmid}->{agent} || $task->{mode} eq 'stop' || !$self->{vm_was_running};
+
+    if (!PVE::QemuServer::qga_check_running($vmid, 1)) {
+       $self->loginfo("skipping guest-agent 'fs-freeze', agent configured but not running?");
+       return;
+    }
+
+    $self->loginfo("issuing guest-agent 'fs-freeze' command");
+    eval { mon_cmd($vmid, "guest-fsfreeze-freeze") };
+    $self->logerr($@) if $@;
+
+    return 1; # even on mon command error, ensure we always thaw again
+}
+
+# only call if fs_freeze return 1
+sub qga_fs_thaw {
+    my ($self, $vmid) = @_;
+
+    $self->loginfo("issuing guest-agent 'fs-thaw' command");
+    eval { mon_cmd($vmid, "guest-fsfreeze-thaw") };
+    $self->logerr($@) if $@;
+}
+
+# we need a running QEMU/KVM process for backup, starts a paused (prelaunch)
+# one if VM isn't already running
+sub enforce_vm_running_for_backup {
+    my ($self, $vmid) = @_;
+
+    if (PVE::QemuServer::check_running($vmid)) {
+       $self->{vm_was_running} = 1;
+       return;
+    }
+
+    eval {
+       $self->loginfo("starting kvm to execute backup task");
+       # start with skiplock
+       my $params = {
+           skiplock => 1,
+           paused => 1,
+       };
+       PVE::QemuServer::vm_start($self->{storecfg}, $vmid, $params);
+    };
+    die $@ if $@;
+}
+
+# resume VM againe once we got in a clear state (stop mode backup of running VM)
+sub resume_vm_after_job_start {
+    my ($self, $task, $vmid) = @_;
+
+    return if !$self->{vm_was_running};
+
+    if (my $stoptime = $task->{vmstoptime}) {
+       my $delay = time() - $task->{vmstoptime};
+       $task->{vmstoptime} = undef; # avoid printing 'online after ..' twice
+       $self->loginfo("resuming VM again after $delay seconds");
+    } else {
+       $self->loginfo("resuming VM again");
+    }
+    mon_cmd($vmid, 'cont');
+}
+
+# stop again if VM was not running before
+sub restore_vm_power_state {
+    my ($self, $vmid) = @_;
+
+    # we always let VMs keep running
+    return if $self->{vm_was_running};
+
+    eval {
+       my $resp = mon_cmd($vmid, 'query-status');
+       my $status = $resp && $resp->{status} ?  $resp->{status} : 'unknown';
+       if ($status eq 'prelaunch') {
+           $self->loginfo("stopping kvm after backup task");
+           PVE::QemuServer::vm_stop($self->{storecfg}, $vmid, 1);
+       } else {
+           $self->loginfo("kvm status changed after backup ('$status') - keep VM running");
+       }
+    };
+    warn $@ if $@;
+}
+
+sub mon_backup_cancel {
+    my ($self, $vmid) = @_;
+
+    $self->loginfo("aborting backup job");
+    eval { mon_cmd($vmid, 'backup-cancel') };
+    $self->logerr($@) if $@;
+}
+
 sub snapshot {
     my ($self, $task, $vmid) = @_;