package PVE::VZDump::QemuServer; use strict; use warnings; use File::Basename; use File::Path; use IO::File; use IPC::Open3; use JSON; use PVE::Cluster qw(cfs_read_file); use PVE::INotify; use PVE::IPCC; 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::QemuConfig; use PVE::QemuServer; use PVE::QemuServer::Machine; use PVE::QemuServer::Monitor qw(mon_cmd); use base qw (PVE::VZDump::Plugin); sub new { my ($class, $vzdump) = @_; PVE::VZDump::check_bin('qm'); my $self = bless { vzdump => $vzdump }, $class; $self->{vmlist} = PVE::QemuServer::vzlist(); $self->{storecfg} = PVE::Storage::config(); return $self; }; sub type { return 'qemu'; } sub vmlist { my ($self) = @_; return [ keys %{$self->{vmlist}} ]; } sub prepare { my ($self, $task, $vmid, $mode) = @_; $task->{disks} = []; 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)) { $self->{vm_was_running} = 0; } $task->{hostname} = $conf->{name}; my $hostname = PVE::INotify::nodename(); my $vollist = []; my $drivehash = {}; my $backup_volumes = PVE::QemuConfig->get_backup_volumes($conf); foreach my $volume (@{$backup_volumes}) { my $name = $volume->{key}; my $volume_config = $volume->{volume_config}; my $volid = $volume_config->{file}; 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 '$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"; } } else { 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->{$name} = $volume->{volume_config}; } PVE::Storage::activate_volumes($self->{storecfg}, $vollist); foreach my $ds (sort keys %$drivehash) { my $drive = $drivehash->{$ds}; my $volid = $drive->{file}; my ($storeid, $volname) = PVE::Storage::parse_volume_id($volid, 1); my $path = $volid; if ($storeid) { $path = PVE::Storage::path($self->{storecfg}, $volid); } next if !$path; 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", }; if (-b $path) { $diskinfo->{type} = 'block'; } else { $diskinfo->{type} = 'file'; } push @{$task->{disks}}, $diskinfo; } } sub vm_status { my ($self, $vmid) = @_; my $running = PVE::QemuServer::check_running($vmid) ? 1 : 0; return wantarray ? ($running, $running ? 'running' : 'stopped') : $running; } sub lock_vm { my ($self, $vmid) = @_; PVE::QemuConfig->set_lock($vmid, 'backup'); } sub unlock_vm { my ($self, $vmid) = @_; PVE::QemuConfig->remove_lock($vmid, 'backup'); } sub stop_vm { my ($self, $task, $vmid) = @_; my $opts = $self->{vzdump}->{opts}; my $wait = $opts->{stopwait} * 60; # send shutdown and wait $self->cmd ("qm shutdown $vmid --skiplock --keepActive --timeout $wait"); } sub start_vm { my ($self, $task, $vmid) = @_; $self->cmd ("qm start $vmid --skiplock"); } sub suspend_vm { my ($self, $task, $vmid) = @_; $self->cmd ("qm suspend $vmid --skiplock"); } sub resume_vm { my ($self, $task, $vmid) = @_; $self->cmd ("qm resume $vmid --skiplock"); } sub assemble { my ($self, $task, $vmid) = @_; my $conffile = PVE::QemuConfig->config_file($vmid); my $outfile = "$task->{tmpdir}/qemu-server.conf"; my $firewall_src = "/etc/pve/firewall/$vmid.fw"; my $firewall_dest = "$task->{tmpdir}/qemu-server.fw"; my $outfd = IO::File->new (">$outfile") || die "unable to open '$outfile'"; my $conffd = IO::File->new ($conffile, 'r') || 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*$/) { if ($1 =~ m/PENDING/i) { $found_pending = 1; } else { $found_snapshot = 1; } } 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)"); next; } next if $line =~ m/^lock:/ || $line =~ m/^parent:/; print $outfd $line; } foreach my $di (@{$task->{disks}}) { if ($di->{type} eq 'block' || $di->{type} eq 'file') { my $storeid = $di->{storeid} || ''; my $format = $di->{format} || ''; print $outfd "#qmdump#map:$di->{virtdev}:$di->{qmdevice}:$storeid:$format:\n"; } else { die "internal error"; } } if ($found_snapshot) { $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 ($self->{vzdump}->{opts}->{pbs}) { $self->archive_pbs($task, $vmid); } else { $self->archive_vma($task, $vmid, $filename, $comp); } } # number, [precision=1] my $num2str = sub { return sprintf( "%." . ( $_[1] || 1 ) . "f", $_[0] ); }; sub bytes_to_human { my ($bytes, $precission) = @_; return $num2str->($bytes, $precission) . ' B' if $bytes < 1024; my $kb = $bytes/1024; return $num2str->($kb, $precission) . " KiB" if $kb < 1024; my $mb = $kb/1024; return $num2str->($mb, $precission) . " MiB" if $mb < 1024; my $gb = $mb/1024; return $num2str->($gb, $precission) . " GiB" if $gb < 1024; my $tb = $gb/1024; return $num2str->($tb, $precission) . " TiB"; }; my $bitmap_action_to_human = sub { my ($info) = @_; my $action = $info->{action}; if ($action eq "not-used") { return "disabled"; } elsif ($action eq "not-used-removed") { return "disabled (old bitmap cleared)"; } elsif ($action eq "new") { return "created new bitmap"; } elsif ($action eq "used") { if ($info->{dirty} == 0) { return "OK, drive clean"; } else { my $size = bytes_to_human($info->{size}); my $dirty = bytes_to_human($info->{dirty}); return "OK, $dirty of $size dirty"; } } elsif ($action eq "invalid") { return "existing bitmap was invalid and has been cleared"; } else { return "unknown"; } }; my $query_backup_status_loop = sub { my ($self, $vmid, $job_uuid, $pbs_features) = @_; my $starttime = time (); my $last_time = $starttime; my ($last_percent, $last_total, $last_target, $last_zero, $last_transferred) = (-1, 0, 0, 0, 0); my ($transferred, $reused); my $get_mbps = sub { my ($mb, $delta) = @_; return "0 B/s" if $mb <= 0; my $bw = int(($mb / $delta)); return bytes_to_human($bw) . "/s"; }; my $target = 0; my $has_query_bitmap = 0; if (defined($pbs_features) && $pbs_features->{'query-bitmap-info'}) { $has_query_bitmap = 1; my $bitmap_info = mon_cmd($vmid, 'query-pbs-bitmap-info'); $self->loginfo("Fast incremental status:"); foreach my $info (@$bitmap_info) { my $text = $bitmap_action_to_human->($info); my $drive = $info->{drive}; $drive =~ s/^drive-//; # for consistency $self->loginfo("$drive: $text"); $target += $info->{dirty}; } } while(1) { my $status = mon_cmd($vmid, 'query-backup'); my $total = $status->{total} || 0; $target = $total if !$has_query_bitmap; $transferred = $status->{transferred} || 0; $reused = $status->{reused}; my $percent = $target ? int(($transferred * 100)/$target) : 0; my $zero = $status->{'zero-bytes'} || 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 = $get_mbps->($rbytes, $timediff); my $mbps_write = $get_mbps->($wbytes, $timediff); my $target_h = bytes_to_human($target); my $transferred_h = bytes_to_human($transferred); my $statusline = "status: $percent% ($transferred_h of $target_h), duration $duration" .", read: $mbps_read, write: $mbps_write"; my $res = $status->{status} || 'unknown'; if ($res ne 'active') { $self->loginfo($statusline); if ($res ne 'done') { die (($status->{errmsg} || "unknown error") . "\n") if $res eq 'error'; die "got unexpected status '$res'\n"; } $last_target = $target if $target; $last_total = $total if $total; $last_zero = $zero if $zero; $last_transferred = $transferred if $transferred; last; } if ($percent != $last_percent && ($timediff > 2)) { $self->loginfo($statusline); $last_percent = $percent; $last_target = $target if $target; $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 $transferred_h = bytes_to_human($transferred, 2); my $mbps = $get_mbps->($transferred, $duration); if ($reused) { my $reused_h = bytes_to_human($reused, 2); my $reuse_per = int($reused * 100 / $last_total); $self->loginfo("backup was done incrementally, reused $reused_h (${reuse_per}%)"); } $self->loginfo("transferred $transferred_h in $duration seconds ($mbps)"); } if (!defined($pbs_features) && $last_zero) { my $zero_per = $last_target ? int(($last_zero * 100)/$last_target) : 0; my $zero_h = bytes_to_human($last_zero, 2); $self->loginfo("Backup is sparse: ${zero_per}% ($zero_h) zero data"); } return { total => $last_total, reused => $reused, }; }; 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 $scfg = $opts->{scfg}; my $starttime = time(); 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}); my $keyfile = PVE::Storage::PBSPlugin::pbs_encryption_key_file_name($scfg, $opts->{storage}); my $diskcount = scalar(@{$task->{disks}}); if (PVE::QemuConfig->is_template($self->{vmlist}->{$vmid}) || !$diskcount) { my @pathlist; # FIXME: accumulate disk sizes to use for backup job (email) log 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 (type $di->{type})"; } } if (!$diskcount) { $self->loginfo("backup contains no disks"); } local $ENV{PBS_PASSWORD} = $password; local $ENV{PBS_FINGERPRINT} = $fingerprint if defined($fingerprint); my $cmd = [ '/usr/bin/proxmox-backup-client', 'backup', '--repository', $repo, '--backup-type', 'vm', '--backup-id', "$vmid", '--backup-time', $task->{backup_time}, ]; 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; } # get list early so we die on unkown drive types before doing anything my $devlist = _get_task_devlist($task); $self->enforce_vm_running_for_backup($vmid); my $backup_job_uuid; eval { $SIG{INT} = $SIG{TERM} = $SIG{QUIT} = $SIG{HUP} = $SIG{PIPE} = sub { die "interrupted by signal\n"; }; my $qemu_support = eval { mon_cmd($vmid, "query-proxmox-support") }; if (!$qemu_support) { die "PBS backups are not supported by the running QEMU version. Please make " . "sure you've installed the latest version and the VM has been restarted.\n"; } 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; if (-e $keyfile) { $self->loginfo("enabling encryption"); $params->{keyfile} = $keyfile; $params->{encrypt} = JSON::true; } else { $params->{encrypt} = JSON::false; } $params->{'use-dirty-bitmap'} = JSON::true if $qemu_support->{'pbs-dirty-bitmap'}; $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 ($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'"); $self->resume_vm_after_job_start($task, $vmid); my $stat = $query_backup_status_loop->($self, $vmid, $backup_job_uuid, $qemu_support); $task->{size} = $stat->{total}; }; my $err = $@; if ($err) { $self->logerr($err); $self->mon_backup_cancel($vmid) if defined($backup_job_uuid); } $self->restore_vm_power_state($vmid); die $err if $err; } my $fork_compressor_pipe = sub { my ($self, $comp, $outfileno) = @_; my @pipefd = POSIX::pipe(); my $cpid = fork(); die "unable to fork worker - $!" if !defined($cpid) || $cpid < 0; if ($cpid == 0) { eval { POSIX::close($pipefd[1]); # redirect STDIN my $fd = fileno(STDIN); close STDIN; POSIX::close(0) if $fd != 0; die "unable to redirect STDIN - $!" if !open(STDIN, "<&", $pipefd[0]); # redirect STDOUT $fd = fileno(STDOUT); close STDOUT; POSIX::close (1) if $fd != 1; die "unable to redirect STDOUT - $!" if !open(STDOUT, ">&", $outfileno); exec($comp); die "fork compressor '$comp' failed\n"; }; if (my $err = $@) { $self->logerr($err); POSIX::_exit(1); } POSIX::_exit(0); kill(-9, $$); } else { POSIX::close($pipefd[0]); $outfileno = $pipefd[1]; } return ($cpid, $outfileno); }; 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}) { $speed = $opts->{bwlimit}*1024; } 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}=$di->{path}"; } else { die "implement me"; } } if (!$diskcount) { $self->loginfo("backup contains no disks"); } my $outcmd; if ($comp) { $outcmd = "exec:$comp"; } else { $outcmd = "exec:cat"; } $outcmd .= " > $filename" if !$opts->{stdout}; my $cmd = ['/usr/bin/vma', 'create', '-v', '-c', $conffile]; push @$cmd, '-c', $firewall if -e $firewall; push @$cmd, $outcmd, @pathlist; $self->loginfo("starting template backup"); $self->loginfo(join(' ', @$cmd)); if ($opts->{stdout}) { $self->cmd($cmd, output => ">&" . fileno($opts->{stdout})); } else { $self->cmd($cmd); } return; } my $devlist = _get_task_devlist($task); $self->enforce_vm_running_for_backup($vmid); my $cpid; my $backup_job_uuid; eval { $SIG{INT} = $SIG{TERM} = $SIG{QUIT} = $SIG{HUP} = $SIG{PIPE} = sub { die "interrupted by signal\n"; }; my $outfh; if ($opts->{stdout}) { $outfh = $opts->{stdout}; } else { $outfh = IO::File->new($filename, "w") || die "unable to open file '$filename' - $!\n"; } my $outfileno = fileno($outfh); if ($comp) { ($cpid, $outfileno) = $fork_compressor_pipe->($self, $comp, $outfileno); } 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 = { 'backup-file' => "/dev/fdname/backup", speed => $speed, '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"); my $fs_frozen = $self->qga_fs_freeze($task, $vmid); eval { $qmpclient->queue_execute(30) }; my $qmperr = $@; if ($fs_frozen) { $self->qga_fs_thaw($vmid); } die $qmperr if $qmperr; die $qmpclient->{errors}->{$vmid} if $qmpclient->{errors}->{$vmid}; if ($cpid) { POSIX::close($outfileno) == 0 || die "close output file handle failed\n"; } die "got no uuid for backup task\n" if !defined($backup_job_uuid); $self->loginfo("started backup task '$backup_job_uuid'"); $self->resume_vm_after_job_start($task, $vmid); $query_backup_status_loop->($self, $vmid, $backup_job_uuid); }; my $err = $@; if ($err) { $self->logerr($err); $self->mon_backup_cancel($vmid) if defined($backup_job_uuid); } $self->restore_vm_power_state($vmid); if ($err) { if ($cpid) { kill(9, $cpid); waitpid($cpid, 0); } die $err; } if ($cpid && (waitpid($cpid, 0) > 0)) { my $stat = $?; my $ec = $stat >> 8; my $signal = $stat & 127; if ($ec || $signal) { die "$comp failed - wrong exit status $ec" . ($signal ? " (signal $signal)\n" : "\n"); } } } sub _get_task_devlist { my ($task) = @_; my $devlist = ''; foreach my $di (@{$task->{disks}}) { if ($di->{type} eq 'block' || $di->{type} eq 'file') { $devlist .= ',' if $devlist; $devlist .= $di->{qmdevice}; } else { die "implement me (type '$di->{type}')"; } } 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) = @_; # nothing to do } sub cleanup { my ($self, $task, $vmid) = @_; # nothing to do ? } 1;