]> git.proxmox.com Git - qemu-server.git/blobdiff - PVE/VZDump/QemuServer.pm
vzdump prepare: refactor and code cleanup
[qemu-server.git] / PVE / VZDump / QemuServer.pm
index ccf4944190007a55d5408b2918f14a7859126bcf..b7d0d1725ddd54bdc69461b9de83bb75d536a2cb 100644 (file)
@@ -2,18 +2,26 @@ package PVE::VZDump::QemuServer;
 
 use strict;
 use warnings;
-use File::Path;
+
 use File::Basename;
+use File::Path;
+use IO::File;
+use IPC::Open3;
+
+use PVE::Cluster qw(cfs_read_file);
 use PVE::INotify;
-use PVE::VZDump;
 use PVE::IPCC;
-use PVE::Cluster qw(cfs_read_file);
-use PVE::Tools;
+use PVE::JSONSchema;
+use PVE::QMPClient;
 use PVE::Storage::Plugin;
+use PVE::Storage::PBSPlugin;
 use PVE::Storage;
+use PVE::Tools;
+use PVE::VZDump;
+
 use PVE::QemuServer;
-use IO::File;
-use IPC::Open3;
+use PVE::QemuServer::Machine;
+use PVE::QemuServer::Monitor qw(mon_cmd);
 
 use base qw (PVE::VZDump::Plugin);
 
@@ -22,7 +30,7 @@ sub new {
 
     PVE::VZDump::check_bin('qm');
 
-    my $self = bless { vzdump => $vzdump };
+    my $self = bless { vzdump => $vzdump }, $class;
 
     $self->{vmlist} = PVE::QemuServer::vzlist();
     $self->{storecfg} = PVE::Storage::config();
@@ -46,7 +54,10 @@ sub prepare {
 
     $task->{disks} = [];
 
-    my $conf = $self->{vmlist}->{$vmid} = PVE::QemuServer::load_config($vmid);
+    my $conf = $self->{vmlist}->{$vmid} = PVE::QemuConfig->load_config($vmid);
+
+    $self->loginfo("VM Name: $conf->{name}")
+       if defined($conf->{name});
 
     $self->{vm_was_running} = 1;
     if (!PVE::QemuServer::check_running($vmid)) {
@@ -64,15 +75,28 @@ sub prepare {
 
        return if PVE::QemuServer::drive_is_cdrom($drive);
 
-       if (defined($drive->{backup}) && $drive->{backup} eq "no") {
-           $self->loginfo("exclude disk '$ds' (backup=no)");
+       my $volid = $drive->{file};
+
+       if (defined($drive->{backup}) && !$drive->{backup}) {
+           $self->loginfo("exclude disk '$ds' '$volid' (backup=no)");
            return;
-       } elsif (defined($drive->{iothread}) && $drive->{iothread} eq "on") {
-           die "disk '$ds' (iothread=on) can't use backup feature currently. Please set backup=no for this drive";
+       } elsif ($self->{vm_was_running} && $drive->{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 " .
+                   "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});
+               $log .= " $readable_size";
+          }
+           $self->loginfo($log);
        }
 
-       my $volid = $drive->{file};
-
        my ($storeid, $volname) = PVE::Storage::parse_volume_id($volid, 1);
        push @$vollist, $volid if $storeid;
        $drivehash->{$ds} = $drive;
@@ -84,28 +108,25 @@ sub prepare {
        my $drive = $drivehash->{$ds};
 
        my $volid = $drive->{file};
-
-       my $path;
-
        my ($storeid, $volname) = PVE::Storage::parse_volume_id($volid, 1);
+
+       my $path = $volid;
        if ($storeid) {
            $path = PVE::Storage::path($self->{storecfg}, $volid);
-       } else {
-           $path = $volid;
        }
-
        next if !$path;
 
-       my $format = undef;
-       my $size = undef;
-
-       eval{
-           ($size, $format) = PVE::Storage::volume_size_info($self->{storecfg}, $volid, 5);
-       };
+       my ($size, $format) = eval { PVE::Storage::volume_size_info($self->{storecfg}, $volid, 5) };
        die "no such volume '$volid'\n" if $@;
 
-       my $diskinfo = { path => $path , volid => $volid, storeid => $storeid,
-                        format => $format, virtdev => $ds, qmdevice => "drive-$ds" };
+       my $diskinfo = {
+           path => $path,
+           volid => $volid,
+           storeid => $storeid,
+           format => $format,
+           virtdev => $ds,
+           qmdevice => "drive-$ds",
+       };
 
        if (-b $path) {
            $diskinfo->{type} = 'block';
@@ -168,7 +189,7 @@ sub resume_vm {
 sub assemble {
     my ($self, $task, $vmid) = @_;
 
-    my $conffile = PVE::QemuServer::config_file ($vmid);
+    my $conffile = PVE::QemuConfig->config_file($vmid);
 
     my $outfile = "$task->{tmpdir}/qemu-server.conf";
     my $firewall_src = "/etc/pve/firewall/$vmid.fw";
@@ -180,13 +201,21 @@ sub assemble {
        die "unable open '$conffile'";
 
     my $found_snapshot;
+    my $found_pending;
     while (defined (my $line = <$conffd>)) {
        next if $line =~ m/^\#vzdump\#/; # just to be sure
        next if $line =~ m/^\#qmdump\#/; # just to be sure
-       if ($line =~ m/^\[.*\]\s*$/) {
-           $found_snapshot = 1;
+       if ($line =~ m/^\[(.*)\]\s*$/) {
+           if ($1 =~ m/PENDING/i) {
+               $found_pending = 1;
+           } else {
+               $found_snapshot = 1;
+           }
        }
+
        next if $found_snapshot; # skip all snapshots data
+       next if $found_pending; # skip all pending changes
+
        if ($line =~ m/^unused\d+:\s*(\S+)\s*/) {
            $self->loginfo("skip unused drive '$1' (not included into backup)");
            next;
@@ -210,18 +239,291 @@ sub assemble {
        $self->loginfo("snapshots found (not included into backup)");
     }
 
+    if ($found_pending) {
+       $self->loginfo("pending configuration changes found (not included into backup)");
+    }
+
     PVE::Tools::file_copy($firewall_src, $firewall_dest) if -f $firewall_src;
 }
 
 sub archive {
     my ($self, $task, $vmid, $filename, $comp) = @_;
 
+    my $opts = $self->{vzdump}->{opts};
+
+    my $scfg = $opts->{scfg};
+
+    if ($scfg->{type} eq 'pbs') {
+       $self->archive_pbs($task, $vmid);
+    } else {
+       $self->archive_vma($task, $vmid, $filename, $comp);
+    }
+}
+
+my $query_backup_status_loop = sub {
+    my ($self, $vmid, $job_uuid) = @_;
+
+    my $status;
+    my $starttime = time ();
+    my $last_per = -1;
+    my $last_total = 0;
+    my $last_zero = 0;
+    my $last_transferred = 0;
+    my $last_time = time();
+    my $transferred;
+
+    while(1) {
+       $status = mon_cmd($vmid, 'query-backup');
+       my $total = $status->{total} || 0;
+       $transferred = $status->{transferred} || 0;
+       my $per = $total ? int(($transferred * 100)/$total) : 0;
+       my $zero = $status->{'zero-bytes'} || 0;
+       my $zero_per = $total ? int(($zero * 100)/$total) : 0;
+
+       die "got unexpected uuid\n" if !$status->{uuid} || ($status->{uuid} ne $job_uuid);
+
+       my $ctime = time();
+       my $duration = $ctime - $starttime;
+
+       my $rbytes = $transferred - $last_transferred;
+       my $wbytes = $rbytes - ($zero - $last_zero);
+
+       my $timediff = ($ctime - $last_time) || 1; # fixme
+       my $mbps_read = ($rbytes > 0) ?
+           int(($rbytes/$timediff)/(1000*1000)) : 0;
+       my $mbps_write = ($wbytes > 0) ?
+           int(($wbytes/$timediff)/(1000*1000)) : 0;
+
+       my $statusline = "status: $per% ($transferred/$total), " .
+           "sparse ${zero_per}% ($zero), duration $duration, " .
+           "read/write $mbps_read/$mbps_write MB/s";
+       my $res = $status->{status} || 'unknown';
+       if ($res ne 'active') {
+           $self->loginfo($statusline);
+           die(($status->{errmsg} || "unknown error") . "\n")
+               if $res eq 'error';
+           die "got unexpected status '$res'\n"
+               if $res ne 'done';
+           die "got wrong number of transfered bytes ($total != $transferred)\n"
+               if ($res eq 'done') && ($total != $transferred);
+
+           last;
+       }
+       if ($per != $last_per && ($timediff > 2)) {
+           $self->loginfo($statusline);
+           $last_per = $per;
+           $last_total = $total if $total;
+           $last_zero = $zero if $zero;
+           $last_transferred = $transferred if $transferred;
+           $last_time = $ctime;
+       }
+       sleep(1);
+    }
+
+    my $duration = time() - $starttime;
+    if ($transferred && $duration) {
+       my $mb = int($transferred/(1000*1000));
+       my $mbps = int(($transferred/$duration)/(1000*1000));
+       $self->loginfo("transferred $mb MB in $duration seconds ($mbps MB/s)");
+    }
+};
+
+sub archive_pbs {
+    my ($self, $task, $vmid) = @_;
+
     my $conffile = "$task->{tmpdir}/qemu-server.conf";
     my $firewall = "$task->{tmpdir}/qemu-server.fw";
 
     my $opts = $self->{vzdump}->{opts};
 
-    my $starttime = time ();
+    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';
+    my $fingerprint = $scfg->{fingerprint};
+
+    my $repo = "$username\@$server:$datastore";
+    my $password = PVE::Storage::PBSPlugin::pbs_get_password($scfg, $opts->{storage});
+
+    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";
+           }
+       }
+
+       if (!$diskcount) {
+           $self->loginfo("backup contains no disks");
+       }
+
+       local $ENV{PBS_PASSWORD} = $password;
+       my $cmd = [
+           '/usr/bin/proxmox-backup-client',
+           'backup',
+           '--repository', $repo,
+           '--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;
+       push @$cmd, @pathlist if scalar(@pathlist);
+
+       $self->loginfo("starting template backup");
+       $self->loginfo(join(' ', @$cmd));
+
+       $self->cmd($cmd);
+
+       return;
+    }
+
+    my $devlist = '';
+    foreach my $di (@{$task->{disks}}) {
+       if ($di->{type} eq 'block' || $di->{type} eq 'file') {
+           $devlist .= $devlist ? ",$di->{qmdevice}" : $di->{qmdevice};
+       } else {
+           die "implement me";
+       }
+    }
+
+    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;
+       }
+    }
+
+    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 $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 $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 $qmperr = $@;
+
+       if ($agent_running){
+           eval { mon_cmd($vmid, "guest-fsfreeze-thaw"); };
+           if (my $err = $@) {
+               $self->logerr($err);
+           }
+       }
+
+       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');
+       }
+
+       $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");
+           }
+       }
+    }
+
+    die $err if $err;
+}
+
+sub archive_vma {
+    my ($self, $task, $vmid, $filename, $comp) = @_;
+
+    my $conffile = "$task->{tmpdir}/qemu-server.conf";
+    my $firewall = "$task->{tmpdir}/qemu-server.fw";
+
+    my $opts = $self->{vzdump}->{opts};
+
+    my $starttime = time();
 
     my $speed = 0;
     if ($opts->{bwlimit}) {
@@ -230,7 +532,7 @@ sub archive {
 
     my $diskcount = scalar(@{$task->{disks}});
 
-    if (PVE::QemuServer::is_template($self->{vmlist}->{$vmid}) || !$diskcount) {
+    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') {
@@ -251,7 +553,7 @@ sub archive {
            $outcmd = "exec:cat";
        }
 
-       $outcmd .= ">$filename" if !$opts->{stdout};
+       $outcmd .= " > $filename" if !$opts->{stdout};
 
        my $cmd = ['/usr/bin/vma', 'create', '-v', '-c', $conffile];
        push @$cmd, '-c', $firewall if -e $firewall;
@@ -301,6 +603,8 @@ sub archive {
     }
 
     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 {
@@ -309,11 +613,9 @@ sub archive {
 
        my $qmpclient = PVE::QMPClient->new();
 
-       my $uuid;
-
        my $backup_cb = sub {
            my ($vmid, $resp) = @_;
-           $uuid = $resp->{return}->{UUID};
+           $backup_job_uuid = $resp->{return}->{UUID};
        };
 
        my $outfh;
@@ -373,7 +675,7 @@ sub archive {
                'config-file' => $conffile,
                devlist => $devlist
            };
-           
+
            $params->{'firewall-file'} = $firewall if -e $firewall;
            $qmpclient->queue_cmd($vmid, $backup_cb, 'backup', %$params);
        };
@@ -381,21 +683,33 @@ sub archive {
        $qmpclient->queue_cmd($vmid, $add_fd_cb, 'getfd',
                              fd => $outfileno, fdname => "backup");
 
-       if ($self->{vmlist}->{$vmid}->{agent} && $vm_is_running){
-           eval { PVE::QemuServer::vm_mon_cmd($vmid, "guest-fsfreeze-freeze"); };
+       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);
            }
        }
 
-       $qmpclient->queue_execute();
+       eval { $qmpclient->queue_execute(30) };
+       my $qmperr = $@;
 
-       if ($self->{vmlist}->{$vmid}->{agent} && $vm_is_running ){
-           eval { PVE::QemuServer::vm_mon_cmd($vmid, "guest-fsfreeze-thaw"); };
+       if ($agent_running){
+           $self->loginfo("issuing guest-agent 'fs-thaw' command");
+           eval { mon_cmd($vmid, "guest-fsfreeze-thaw"); };
            if (my $err = $@) {
                $self->logerr($err);
            }
        }
+       die $qmperr if $qmperr;
        die $qmpclient->{errors}->{$vmid} if $qmpclient->{errors}->{$vmid};
 
        if ($cpid) {
@@ -403,94 +717,40 @@ sub archive {
                die "close output file handle failed\n";
        }
 
-       die "got no uuid for backup task\n" if !$uuid;
+       die "got no uuid for backup task\n" if !defined($backup_job_uuid);
 
-       $self->loginfo("started backup task '$uuid'");
+       $self->loginfo("started backup task '$backup_job_uuid'");
 
        if ($resume_on_backup) {
-           $self->loginfo("resume VM");
-           PVE::QemuServer::vm_mon_cmd($vmid, 'cont');
-       }
-
-       my $status;
-       my $starttime = time ();
-       my $last_per = -1;
-       my $last_total = 0;
-       my $last_zero = 0;
-       my $last_transferred = 0;
-       my $last_time = time();
-       my $transferred;
-
-       while(1) {
-           $status = PVE::QemuServer::vm_mon_cmd($vmid, 'query-backup');
-           my $total = $status->{total} || 0;
-           $transferred = $status->{transferred} || 0;
-           my $per = $total ? int(($transferred * 100)/$total) : 0;
-           my $zero = $status->{'zero-bytes'} || 0;
-           my $zero_per = $total ? int(($zero * 100)/$total) : 0;
-
-           die "got unexpected uuid\n" if !$status->{uuid} || ($status->{uuid} ne $uuid);
-
-           my $ctime = time();
-           my $duration = $ctime - $starttime;
-
-           my $rbytes = $transferred - $last_transferred;
-           my $wbytes = $rbytes - ($zero - $last_zero);
-
-           my $timediff = ($ctime - $last_time) || 1; # fixme
-           my $mbps_read = ($rbytes > 0) ?
-               int(($rbytes/$timediff)/(1000*1000)) : 0;
-           my $mbps_write = ($wbytes > 0) ?
-               int(($wbytes/$timediff)/(1000*1000)) : 0;
-
-           my $statusline = "status: $per% ($transferred/$total), " .
-               "sparse ${zero_per}% ($zero), duration $duration, " .
-               "$mbps_read/$mbps_write MB/s";
-           my $res = $status->{status} || 'unknown';
-           if ($res ne 'active') {
-               $self->loginfo($statusline);
-               die(($status->{errmsg} || "unknown error") . "\n")
-                   if $res eq 'error';
-               die "got unexpected status '$res'\n"
-                   if $res ne 'done';
-               die "got wrong number of transfered bytes ($total != $transferred)\n"
-                   if ($res eq 'done') && ($total != $transferred);
-
-               last;
-           }
-           if ($per != $last_per && ($timediff > 2)) {
-               $self->loginfo($statusline);
-               $last_per = $per;
-               $last_total = $total if $total;
-               $last_zero = $zero if $zero;
-               $last_transferred = $transferred if $transferred;
-               $last_time = $ctime;
+           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");
            }
-           sleep(1);
+           mon_cmd($vmid, 'cont');
        }
 
-       my $duration = time() - $starttime;
-       if ($transferred && $duration) {
-           my $mb = int($transferred/(1000*1000));
-           my $mbps = int(($transferred/$duration)/(1000*1000));
-           $self->loginfo("transferred $mb MB in $duration seconds ($mbps MB/s)");
-       }
+       $query_backup_status_loop->($self, $vmid, $backup_job_uuid);
     };
     my $err = $@;
 
     if ($err) {
        $self->logerr($err);
-       $self->loginfo("aborting backup job");
-       eval { PVE::QemuServer::vm_mon_cmd($vmid, 'backup-cancel'); };
-       if (my $err1 = $@) {
-           $self->logerr($err1);
+       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 = PVE::QemuServer::vm_mon_cmd($vmid, 'query-status');
+           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");