pve-manager/PVE/VZDump.pm
2015-04-29 09:11:44 +02:00

1312 lines
32 KiB
Perl

package PVE::VZDump;
use strict;
use warnings;
use Fcntl ':flock';
use PVE::Exception qw(raise_param_exc);
use PVE::SafeSyslog;
use IO::File;
use IO::Select;
use IPC::Open3;
use POSIX qw(strftime);
use File::Path;
use PVE::RPCEnvironment;
use PVE::Storage;
use PVE::Cluster qw(cfs_read_file);
use Time::localtime;
use Time::Local;
use PVE::JSONSchema qw(get_standard_option);
my @posix_filesystems = qw(ext3 ext4 nfs nfs4 reiserfs xfs);
my $lockfile = '/var/run/vzdump.lock';
my $pidfile = '/var/run/vzdump.pid';
my $logdir = '/var/log/vzdump';
my @plugins = qw();
# Load available plugins
my @pve_vzdump_classes = qw(PVE::VZDump::QemuServer PVE::VZDump::LXC);
foreach my $plug (@pve_vzdump_classes) {
my $filename = "/usr/share/perl5/$plug.pm";
$filename =~ s!::!/!g;
if (-f $filename) {
eval { require $filename; };
if (!$@) {
$plug->import ();
push @plugins, $plug;
} else {
warn $@;
}
}
}
# helper functions
my $debugstattxt = {
err => 'ERROR:',
info => 'INFO:',
warn => 'WARN:',
};
sub debugmsg {
my ($mtype, $msg, $logfd, $syslog) = @_;
chomp $msg;
return if !$msg;
my $pre = $debugstattxt->{$mtype} || $debugstattxt->{'err'};
my $timestr = strftime ("%b %d %H:%M:%S", CORE::localtime);
syslog ($mtype eq 'info' ? 'info' : 'err', "$pre $msg") if $syslog;
foreach my $line (split (/\n/, $msg)) {
print STDERR "$pre $line\n";
print $logfd "$timestr $pre $line\n" if $logfd;
}
}
sub run_command {
my ($logfd, $cmdstr, %param) = @_;
my $logfunc = sub {
my $line = shift;
debugmsg ('info', $line, $logfd);
};
PVE::Tools::run_command($cmdstr, %param, logfunc => $logfunc);
}
sub storage_info {
my $storage = shift;
my $cfg = cfs_read_file('storage.cfg');
my $scfg = PVE::Storage::storage_config($cfg, $storage);
my $type = $scfg->{type};
die "can't use storage type '$type' for backup\n"
if (!($type eq 'dir' || $type eq 'nfs' || $type eq 'glusterfs'));
die "can't use storage '$storage' for backups - wrong content type\n"
if (!$scfg->{content}->{backup});
PVE::Storage::activate_storage($cfg, $storage);
return {
dumpdir => PVE::Storage::get_backup_dir($cfg, $storage),
maxfiles => $scfg->{maxfiles},
};
}
sub format_size {
my $size = shift;
my $kb = $size / 1024;
if ($kb < 1024) {
return int ($kb) . "KB";
}
my $mb = $size / (1024*1024);
if ($mb < 1024) {
return int ($mb) . "MB";
} else {
my $gb = $mb / 1024;
return sprintf ("%.2fGB", $gb);
}
}
sub format_time {
my $seconds = shift;
my $hours = int ($seconds/3600);
$seconds = $seconds - $hours*3600;
my $min = int ($seconds/60);
$seconds = $seconds - $min*60;
return sprintf ("%02d:%02d:%02d", $hours, $min, $seconds);
}
sub encode8bit {
my ($str) = @_;
$str =~ s/^(.{990})/$1\n/mg; # reduce line length
return $str;
}
sub escape_html {
my ($str) = @_;
$str =~ s/&/&amp;/g;
$str =~ s/</&lt;/g;
$str =~ s/>/&gt;/g;
return $str;
}
sub check_bin {
my ($bin) = @_;
foreach my $p (split (/:/, $ENV{PATH})) {
my $fn = "$p/$bin";
if (-x $fn) {
return $fn;
}
}
die "unable to find command '$bin'\n";
}
sub check_vmids {
my (@vmids) = @_;
my $res = [];
foreach my $vmid (@vmids) {
die "ERROR: strange VM ID '${vmid}'\n" if $vmid !~ m/^\d+$/;
$vmid = int ($vmid); # remove leading zeros
next if !$vmid;
push @$res, $vmid;
}
return $res;
}
sub read_vzdump_defaults {
my $fn = "/etc/vzdump.conf";
my $res = {
bwlimit => 0,
ionice => 7,
size => 1024,
lockwait => 3*60, # 3 hours
stopwait => 10, # 10 minutes
mode => 'snapshot',
maxfiles => 1,
};
my $fh = IO::File->new ("<$fn");
return $res if !$fh;
my $line;
while (defined ($line = <$fh>)) {
next if $line =~ m/^\s*$/;
next if $line =~ m/^\#/;
if ($line =~ m/tmpdir:\s*(.*\S)\s*$/) {
$res->{tmpdir} = $1;
} elsif ($line =~ m/dumpdir:\s*(.*\S)\s*$/) {
$res->{dumpdir} = $1;
} elsif ($line =~ m/storage:\s*(\S+)\s*$/) {
$res->{storage} = $1;
} elsif ($line =~ m/script:\s*(.*\S)\s*$/) {
$res->{script} = $1;
} elsif ($line =~ m/bwlimit:\s*(\d+)\s*$/) {
$res->{bwlimit} = int($1);
} elsif ($line =~ m/ionice:\s*([0-8])\s*$/) {
$res->{ionice} = int($1);
} elsif ($line =~ m/lockwait:\s*(\d+)\s*$/) {
$res->{lockwait} = int($1);
} elsif ($line =~ m/stopwait:\s*(\d+)\s*$/) {
$res->{stopwait} = int($1);
} elsif ($line =~ m/stop:\s*(\d+)\s*$/) {
$res->{stop} = int($1);
} elsif ($line =~ m/size:\s*(\d+)\s*$/) {
$res->{size} = int($1);
} elsif ($line =~ m/maxfiles:\s*(\d+)\s*$/) {
$res->{maxfiles} = int($1);
} elsif ($line =~ m/exclude-path:\s*(.*)\s*$/) {
$res->{'exclude-path'} = PVE::Tools::split_args($1);
} elsif ($line =~ m/mode:\s*(stop|snapshot|suspend)\s*$/) {
$res->{mode} = $1;
} else {
debugmsg ('warn', "unable to parse configuration file '$fn' - error at line " . $., undef, 1);
}
}
close ($fh);
return $res;
}
sub find_add_exclude {
my ($self, $excltype, $value) = @_;
if (($excltype eq '-regex') || ($excltype eq '-files')) {
$value = "\.$value";
}
if ($excltype eq '-files') {
push @{$self->{findexcl}}, "'('", '-not', '-type', 'd', '-regex' , "'$value'", "')'", '-o';
} else {
push @{$self->{findexcl}}, "'('", $excltype , "'$value'", '-prune', "')'", '-o';
}
}
sub sendmail {
my ($self, $tasklist, $totaltime, $err) = @_;
my $opts = $self->{opts};
my $mailto = $opts->{mailto};
return if !($mailto && scalar(@$mailto));
my $cmdline = $self->{cmdline};
my $ecount = 0;
foreach my $task (@$tasklist) {
$ecount++ if $task->{state} ne 'ok';
chomp $task->{msg} if $task->{msg};
$task->{backuptime} = 0 if !$task->{backuptime};
$task->{size} = 0 if !$task->{size};
$task->{tarfile} = 'unknown' if !$task->{tarfile};
$task->{hostname} = "VM $task->{vmid}" if !$task->{hostname};
if ($task->{state} eq 'todo') {
$task->{msg} = 'aborted';
}
}
my $notify = $opts->{mailnotification} || 'always';
return if (!$ecount && !$err && ($notify eq 'failure'));
my $stat = ($ecount || $err) ? 'backup failed' : 'backup successful';
$stat .= ": $err" if $err;
my $hostname = `hostname -f` || PVE::INotify::nodename();
chomp $hostname;
my $boundary = "----_=_NextPart_001_".int(time).$$;
my $rcvrarg = '';
foreach my $r (@$mailto) {
$rcvrarg .= " '$r'";
}
my $dcconf = PVE::Cluster::cfs_read_file('datacenter.cfg');
my $mailfrom = $dcconf->{email_from} || "root";
open (MAIL,"|sendmail -B 8BITMIME -f $mailfrom $rcvrarg") ||
die "unable to open 'sendmail' - $!";
my $rcvrtxt = join (', ', @$mailto);
print MAIL "Content-Type: multipart/alternative;\n";
print MAIL "\tboundary=\"$boundary\"\n";
print MAIL "MIME-Version: 1.0\n";
print MAIL "FROM: vzdump backup tool <$mailfrom>\n";
print MAIL "TO: $rcvrtxt\n";
print MAIL "SUBJECT: vzdump backup status ($hostname) : $stat\n";
print MAIL "\n";
print MAIL "This is a multi-part message in MIME format.\n\n";
print MAIL "--$boundary\n";
print MAIL "Content-Type: text/plain;\n";
print MAIL "\tcharset=\"UTF8\"\n";
print MAIL "Content-Transfer-Encoding: 8bit\n";
print MAIL "\n";
# text part
my $fill = ' '; # Avoid The Remove Extra Line Breaks Issue (MS Outlook)
print MAIL sprintf ("${fill}%-10s %-6s %10s %10s %s\n", qw(VMID STATUS TIME SIZE FILENAME));
foreach my $task (@$tasklist) {
my $vmid = $task->{vmid};
if ($task->{state} eq 'ok') {
print MAIL sprintf ("${fill}%-10s %-6s %10s %10s %s\n", $vmid,
$task->{state},
format_time($task->{backuptime}),
format_size ($task->{size}),
$task->{tarfile});
} else {
print MAIL sprintf ("${fill}%-10s %-6s %10s %8.2fMB %s\n", $vmid,
$task->{state},
format_time($task->{backuptime}),
0, '-');
}
}
print MAIL "${fill}\n";
print MAIL "${fill}Detailed backup logs:\n";
print MAIL "${fill}\n";
print MAIL "$fill$cmdline\n";
print MAIL "${fill}\n";
foreach my $task (@$tasklist) {
my $vmid = $task->{vmid};
my $log = $task->{tmplog};
if (!$log) {
print MAIL "${fill}$vmid: no log available\n\n";
next;
}
open (TMP, "$log");
while (my $line = <TMP>) { print MAIL encode8bit ("${fill}$vmid: $line"); }
close (TMP);
print MAIL "${fill}\n";
}
# end text part
print MAIL "\n--$boundary\n";
print MAIL "Content-Type: text/html;\n";
print MAIL "\tcharset=\"UTF8\"\n";
print MAIL "Content-Transfer-Encoding: 8bit\n";
print MAIL "\n";
# html part
print MAIL "<html><body>\n";
print MAIL "<table border=1 cellpadding=3>\n";
print MAIL "<tr><td>VMID<td>NAME<td>STATUS<td>TIME<td>SIZE<td>FILENAME</tr>\n";
my $ssize = 0;
foreach my $task (@$tasklist) {
my $vmid = $task->{vmid};
my $name = $task->{hostname};
if ($task->{state} eq 'ok') {
$ssize += $task->{size};
print MAIL sprintf ("<tr><td>%s<td>%s<td>OK<td>%s<td align=right>%s<td>%s</tr>\n",
$vmid, $name,
format_time($task->{backuptime}),
format_size ($task->{size}),
escape_html ($task->{tarfile}));
} else {
print MAIL sprintf ("<tr><td>%s<td>%s<td><font color=red>FAILED<td>%s<td colspan=2>%s</tr>\n",
$vmid, $name, format_time($task->{backuptime}),
escape_html ($task->{msg}));
}
}
print MAIL sprintf ("<tr><td align=left colspan=3>TOTAL<td>%s<td>%s<td></tr>",
format_time ($totaltime), format_size ($ssize));
print MAIL "</table><br><br>\n";
print MAIL "Detailed backup logs:<br>\n";
print MAIL "<br>\n";
print MAIL "<pre>\n";
print MAIL escape_html($cmdline) . "\n";
print MAIL "\n";
foreach my $task (@$tasklist) {
my $vmid = $task->{vmid};
my $log = $task->{tmplog};
if (!$log) {
print MAIL "$vmid: no log available\n\n";
next;
}
open (TMP, "$log");
while (my $line = <TMP>) {
if ($line =~ m/^\S+\s\d+\s+\d+:\d+:\d+\s+(ERROR|WARN):/) {
print MAIL encode8bit ("$vmid: <font color=red>".
escape_html ($line) . "</font>");
} else {
print MAIL encode8bit ("$vmid: " . escape_html ($line));
}
}
close (TMP);
print MAIL "\n";
}
print MAIL "</pre>\n";
print MAIL "</body></html>\n";
# end html part
print MAIL "\n--$boundary--\n";
close(MAIL);
};
sub new {
my ($class, $cmdline, $opts, $skiplist) = @_;
mkpath $logdir;
check_bin ('cp');
check_bin ('df');
check_bin ('sendmail');
check_bin ('rsync');
check_bin ('tar');
check_bin ('mount');
check_bin ('umount');
check_bin ('cstream');
check_bin ('ionice');
if ($opts->{mode} && $opts->{mode} eq 'snapshot') {
check_bin ('lvcreate');
check_bin ('lvs');
check_bin ('lvremove');
}
my $defaults = read_vzdump_defaults();
my $maxfiles = $opts->{maxfiles}; # save here, because we overwrite with default
$opts->{remove} = 1 if !defined($opts->{remove});
foreach my $k (keys %$defaults) {
if ($k eq 'dumpdir' || $k eq 'storage') {
$opts->{$k} = $defaults->{$k} if !defined ($opts->{dumpdir}) &&
!defined ($opts->{storage});
} else {
$opts->{$k} = $defaults->{$k} if !defined ($opts->{$k});
}
}
$opts->{dumpdir} =~ s|/+$|| if ($opts->{dumpdir});
$opts->{tmpdir} =~ s|/+$|| if ($opts->{tmpdir});
$skiplist = [] if !$skiplist;
my $self = bless { cmdline => $cmdline, opts => $opts, skiplist => $skiplist };
#always skip '.'
push @{$self->{findexcl}}, "'('", '-regex' , "'^\\.\$'", "')'", '-o';
$self->find_add_exclude ('-type', 's'); # skip sockets
if ($defaults->{'exclude-path'}) {
foreach my $path (@{$defaults->{'exclude-path'}}) {
$self->find_add_exclude ('-regex', $path);
}
}
if ($opts->{'exclude-path'}) {
foreach my $path (@{$opts->{'exclude-path'}}) {
$self->find_add_exclude ('-regex', $path);
}
}
if ($opts->{stdexcludes}) {
$self->find_add_exclude ('-files', '/var/log/.+');
$self->find_add_exclude ('-regex', '/tmp/.+');
$self->find_add_exclude ('-regex', '/var/tmp/.+');
$self->find_add_exclude ('-regex', '/var/run/.+pid');
}
foreach my $p (@plugins) {
my $pd = $p->new ($self);
push @{$self->{plugins}}, $pd;
}
if (!$opts->{dumpdir} && !$opts->{storage}) {
$opts->{storage} = 'local';
}
if ($opts->{storage}) {
my $info = storage_info ($opts->{storage});
$opts->{dumpdir} = $info->{dumpdir};
$maxfiles = $info->{maxfiles} if !defined($maxfiles) && defined($info->{maxfiles});
} elsif ($opts->{dumpdir}) {
die "dumpdir '$opts->{dumpdir}' does not exist\n"
if ! -d $opts->{dumpdir};
} else {
die "internal error";
}
if ($opts->{tmpdir} && ! -d $opts->{tmpdir}) {
die "tmpdir '$opts->{tmpdir}' does not exist\n";
}
$opts->{maxfiles} = $maxfiles if defined($maxfiles);
return $self;
}
sub get_lvm_mapping {
my $devmapper;
my $cmd = ['lvs', '--units', 'm', '--separator', ':', '--noheadings',
'-o', 'vg_name,lv_name,lv_size' ];
my $parser = sub {
my $line = shift;
if ($line =~ m|^\s*(\S+):(\S+):(\d+(\.\d+))[Mm]$|) {
my $vg = $1;
my $lv = $2;
$devmapper->{"/dev/$vg/$lv"} = [$vg, $lv];
my $qlv = $lv;
$qlv =~ s/-/--/g;
my $qvg = $vg;
$qvg =~ s/-/--/g;
$devmapper->{"/dev/mapper/$qvg-$qlv"} = [$vg, $lv];
}
};
eval { PVE::Tools::run_command($cmd, errfunc => sub {}, outfunc => $parser); };
warn $@ if $@;
return $devmapper;
}
sub get_mount_info {
my ($dir) = @_;
# Note: df 'available' can be negative, and percentage set to '-'
my $cmd = [ 'df', '-P', '-T', '-B', '1', $dir];
my $res;
my $parser = sub {
my $line = shift;
if (my ($fsid, $fstype, undef, $mp) = $line =~
m!(\S+.*)\s+(\S+)\s+\d+\s+\-?\d+\s+\d+\s+(\d+%|-)\s+(/.*)$!) {
$res = {
device => $fsid,
fstype => $fstype,
mountpoint => $mp,
};
}
};
eval { PVE::Tools::run_command($cmd, errfunc => sub {}, outfunc => $parser); };
warn $@ if $@;
return $res;
}
sub get_lvm_device {
my ($dir, $mapping) = @_;
my $info = get_mount_info($dir);
return undef if !$info;
my $dev = $info->{device};
my ($vg, $lv);
($vg, $lv) = @{$mapping->{$dev}} if defined $mapping->{$dev};
return wantarray ? ($dev, $info->{mountpoint}, $vg, $lv, $info->{fstype}) : $dev;
}
sub getlock {
my ($self, $upid) = @_;
my $fh;
my $maxwait = $self->{opts}->{lockwait} || $self->{lockwait};
die "missimg UPID" if !$upid; # should not happen
if (!open (SERVER_FLCK, ">>$lockfile")) {
debugmsg ('err', "can't open lock on file '$lockfile' - $!", undef, 1);
die "can't open lock on file '$lockfile' - $!";
}
if (!flock (SERVER_FLCK, LOCK_EX|LOCK_NB)) {
if (!$maxwait) {
debugmsg ('err', "can't aquire lock '$lockfile' (wait = 0)", undef, 1);
die "can't aquire lock '$lockfile' (wait = 0)";
}
debugmsg('info', "trying to get global lock - waiting...", undef, 1);
eval {
alarm ($maxwait * 60);
local $SIG{ALRM} = sub { alarm (0); die "got timeout\n"; };
if (!flock (SERVER_FLCK, LOCK_EX)) {
my $err = $!;
close (SERVER_FLCK);
alarm (0);
die "$err\n";
}
alarm (0);
};
alarm (0);
my $err = $@;
if ($err) {
debugmsg ('err', "can't aquire lock '$lockfile' - $err", undef, 1);
die "can't aquire lock '$lockfile' - $err";
}
debugmsg('info', "got global lock", undef, 1);
}
PVE::Tools::file_set_contents($pidfile, $upid);
}
sub run_hook_script {
my ($self, $phase, $task, $logfd) = @_;
my $opts = $self->{opts};
my $script = $opts->{script};
return if !$script;
my $cmd = "$script $phase";
$cmd .= " $task->{mode} $task->{vmid}" if ($task);
local %ENV;
# set immutable opts directly (so they are available in all phases)
$ENV{STOREID} = $opts->{storage} if $opts->{storage};
$ENV{DUMPDIR} = $opts->{dumpdir} if $opts->{dumpdir};
foreach my $ek (qw(vmtype hostname tarfile logfile)) {
$ENV{uc($ek)} = $task->{$ek} if $task->{$ek};
}
run_command ($logfd, $cmd);
}
sub compressor_info {
my ($opt_compress) = @_;
if (!$opt_compress || $opt_compress eq '0') {
return undef;
} elsif ($opt_compress eq '1' || $opt_compress eq 'lzo') {
return ('lzop', 'lzo');
} elsif ($opt_compress eq 'gzip') {
return ('gzip', 'gz');
} else {
die "internal error - unknown compression option '$opt_compress'";
}
}
sub get_backup_file_list {
my ($dir, $bkname, $exclude_fn) = @_;
my $bklist = [];
foreach my $fn (<$dir/${bkname}-*>) {
next if $exclude_fn && $fn eq $exclude_fn;
if ($fn =~ m!/(${bkname}-(\d{4})_(\d{2})_(\d{2})-(\d{2})_(\d{2})_(\d{2})\.(tgz|((tar|vma)(\.(gz|lzo))?)))$!) {
$fn = "$dir/$1"; # untaint
my $t = timelocal ($7, $6, $5, $4, $3 - 1, $2 - 1900);
push @$bklist, [$fn, $t];
}
}
return $bklist;
}
sub exec_backup_task {
my ($self, $task) = @_;
my $opts = $self->{opts};
my $vmid = $task->{vmid};
my $plugin = $task->{plugin};
my $vmstarttime = time ();
my $logfd;
my $cleanup = {};
my $vmstoptime = 0;
eval {
die "unable to find VM '$vmid'\n" if !$plugin;
my $vmtype = $plugin->type();
my $tmplog = "$logdir/$vmtype-$vmid.log";
my $lt = localtime();
my $bkname = "vzdump-$vmtype-$vmid";
my $basename = sprintf "${bkname}-%04d_%02d_%02d-%02d_%02d_%02d",
$lt->year + 1900, $lt->mon + 1, $lt->mday,
$lt->hour, $lt->min, $lt->sec;
my $maxfiles = $opts->{maxfiles};
if ($maxfiles && !$opts->{remove}) {
my $bklist = get_backup_file_list($opts->{dumpdir}, $bkname);
die "only $maxfiles backup(s) allowed - please consider to remove old backup files.\n"
if scalar(@$bklist) >= $maxfiles;
}
my $logfile = $task->{logfile} = "$opts->{dumpdir}/$basename.log";
my $ext = $vmtype eq 'qemu' ? '.vma' : '.tar';
my ($comp, $comp_ext) = compressor_info($opts->{compress});
if ($comp && $comp_ext) {
$ext .= ".${comp_ext}";
}
if ($opts->{stdout}) {
$task->{tarfile} = '-';
} else {
my $tarfile = $task->{tarfile} = "$opts->{dumpdir}/$basename$ext";
$task->{tmptar} = $task->{tarfile};
$task->{tmptar} =~ s/\.[^\.]+$/\.dat/;
unlink $task->{tmptar};
}
$task->{vmtype} = $vmtype;
if ($opts->{tmpdir}) {
$task->{tmpdir} = "$opts->{tmpdir}/vzdumptmp$$";
} else {
# dumpdir is posix? then use it as temporary dir
my $info = get_mount_info($opts->{dumpdir});
if ($vmtype eq 'qemu' ||
grep ($_ eq $info->{fstype}, @posix_filesystems)) {
$task->{tmpdir} = "$opts->{dumpdir}/$basename.tmp";
} else {
$task->{tmpdir} = "/var/tmp/vzdumptmp$$";
debugmsg ('info', "filesystem type on dumpdir is '$info->{fstype}' -" .
"using $task->{tmpdir} for temporary files", $logfd);
}
}
rmtree $task->{tmpdir};
mkdir $task->{tmpdir};
-d $task->{tmpdir} ||
die "unable to create temporary directory '$task->{tmpdir}'";
$logfd = IO::File->new (">$tmplog") ||
die "unable to create log file '$tmplog'";
$task->{dumpdir} = $opts->{dumpdir};
$task->{storeid} = $opts->{storage};
$task->{tmplog} = $tmplog;
unlink $logfile;
debugmsg ('info', "Starting Backup of VM $vmid ($vmtype)", $logfd, 1);
$plugin->set_logfd ($logfd);
# test is VM is running
my ($running, $status_text) = $plugin->vm_status ($vmid);
debugmsg ('info', "status = ${status_text}", $logfd);
# lock VM (prevent config changes)
$plugin->lock_vm ($vmid);
$cleanup->{unlock} = 1;
# prepare
my $mode = $running ? $opts->{mode} : 'stop';
if ($mode eq 'snapshot') {
my %saved_task = %$task;
eval { $plugin->prepare ($task, $vmid, $mode); };
if (my $err = $@) {
die $err if $err !~ m/^mode failure/;
debugmsg ('info', $err, $logfd);
debugmsg ('info', "trying 'suspend' mode instead", $logfd);
$mode = 'suspend'; # so prepare is called again below
%$task = %saved_task;
}
}
$task->{mode} = $mode;
debugmsg ('info', "backup mode: $mode", $logfd);
debugmsg ('info', "bandwidth limit: $opts->{bwlimit} KB/s", $logfd)
if $opts->{bwlimit};
debugmsg ('info', "ionice priority: $opts->{ionice}", $logfd);
if ($mode eq 'stop') {
$plugin->prepare ($task, $vmid, $mode);
$self->run_hook_script ('backup-start', $task, $logfd);
if ($running) {
debugmsg ('info', "stopping vm", $logfd);
$vmstoptime = time ();
$self->run_hook_script ('pre-stop', $task, $logfd);
$plugin->stop_vm ($task, $vmid);
$cleanup->{restart} = 1;
}
} elsif ($mode eq 'suspend') {
$plugin->prepare ($task, $vmid, $mode);
$self->run_hook_script ('backup-start', $task, $logfd);
if ($vmtype eq 'lxc') {
# pre-suspend rsync
$plugin->copy_data_phase1($task, $vmid);
}
debugmsg ('info', "suspend vm", $logfd);
$vmstoptime = time ();
$self->run_hook_script ('pre-stop', $task, $logfd);
$plugin->suspend_vm ($task, $vmid);
$cleanup->{resume} = 1;
if ($vmtype eq 'lxc') {
# post-suspend rsync
$plugin->copy_data_phase2($task, $vmid);
debugmsg ('info', "resume vm", $logfd);
$cleanup->{resume} = 0;
$self->run_hook_script('pre-restart', $task, $logfd);
$plugin->resume_vm($task, $vmid);
my $delay = time () - $vmstoptime;
debugmsg('info', "vm is online again after $delay seconds", $logfd);
}
} elsif ($mode eq 'snapshot') {
$self->run_hook_script ('backup-start', $task, $logfd);
my $snapshot_count = $task->{snapshot_count} || 0;
$self->run_hook_script ('pre-stop', $task, $logfd);
if ($snapshot_count > 1) {
debugmsg ('info', "suspend vm to make snapshot", $logfd);
$vmstoptime = time ();
$plugin->suspend_vm ($task, $vmid);
$cleanup->{resume} = 1;
}
$plugin->snapshot ($task, $vmid);
$self->run_hook_script ('pre-restart', $task, $logfd);
if ($snapshot_count > 1) {
debugmsg ('info', "resume vm", $logfd);
$cleanup->{resume} = 0;
$plugin->resume_vm ($task, $vmid);
my $delay = time () - $vmstoptime;
debugmsg ('info', "vm is online again after $delay seconds", $logfd);
}
} else {
die "internal error - unknown mode '$mode'\n";
}
# assemble archive image
$plugin->assemble ($task, $vmid);
# produce archive
if ($opts->{stdout}) {
debugmsg ('info', "sending archive to stdout", $logfd);
$plugin->archive($task, $vmid, $task->{tmptar}, $comp);
$self->run_hook_script ('backup-end', $task, $logfd);
return;
}
debugmsg ('info', "creating archive '$task->{tarfile}'", $logfd);
$plugin->archive($task, $vmid, $task->{tmptar}, $comp);
rename ($task->{tmptar}, $task->{tarfile}) ||
die "unable to rename '$task->{tmptar}' to '$task->{tarfile}'\n";
# determine size
$task->{size} = (-s $task->{tarfile}) || 0;
my $cs = format_size ($task->{size});
debugmsg ('info', "archive file size: $cs", $logfd);
# purge older backup
if ($maxfiles && $opts->{remove}) {
my $bklist = get_backup_file_list($opts->{dumpdir}, $bkname, $task->{tarfile});
$bklist = [ sort { $b->[1] <=> $a->[1] } @$bklist ];
while (scalar (@$bklist) >= $maxfiles) {
my $d = pop @$bklist;
debugmsg ('info', "delete old backup '$d->[0]'", $logfd);
unlink $d->[0];
my $logfn = $d->[0];
$logfn =~ s/\.(tgz|((tar|vma)(\.(gz|lzo))?))$/\.log/;
unlink $logfn;
}
}
$self->run_hook_script ('backup-end', $task, $logfd);
};
my $err = $@;
if ($plugin) {
# clean-up
if ($cleanup->{unlock}) {
eval { $plugin->unlock_vm ($vmid); };
warn $@ if $@;
}
eval { $plugin->cleanup ($task, $vmid) };
warn $@ if $@;
eval { $plugin->set_logfd (undef); };
warn $@ if $@;
if ($cleanup->{resume} || $cleanup->{restart}) {
eval {
$self->run_hook_script ('pre-restart', $task, $logfd);
if ($cleanup->{resume}) {
debugmsg ('info', "resume vm", $logfd);
$plugin->resume_vm ($task, $vmid);
} else {
my $running = $plugin->vm_status($vmid);
if (!$running) {
debugmsg ('info', "restarting vm", $logfd);
$plugin->start_vm ($task, $vmid);
}
}
};
my $err = $@;
if ($err) {
warn $err;
} else {
my $delay = time () - $vmstoptime;
debugmsg ('info', "vm is online again after $delay seconds", $logfd);
}
}
}
eval { unlink $task->{tmptar} if $task->{tmptar} && -f $task->{tmptar}; };
warn $@ if $@;
eval { rmtree $task->{tmpdir} if $task->{tmpdir} && -d $task->{tmpdir}; };
warn $@ if $@;
my $delay = $task->{backuptime} = time () - $vmstarttime;
if ($err) {
$task->{state} = 'err';
$task->{msg} = $err;
debugmsg ('err', "Backup of VM $vmid failed - $err", $logfd, 1);
eval { $self->run_hook_script ('backup-abort', $task, $logfd); };
} else {
$task->{state} = 'ok';
my $tstr = format_time ($delay);
debugmsg ('info', "Finished Backup of VM $vmid ($tstr)", $logfd, 1);
}
close ($logfd) if $logfd;
if ($task->{tmplog} && $task->{logfile}) {
system ("cp '$task->{tmplog}' '$task->{logfile}'");
}
eval { $self->run_hook_script ('log-end', $task); };
die $err if $err && $err =~ m/^interrupted by signal$/;
}
sub exec_backup {
my ($self, $rpcenv, $authuser) = @_;
my $opts = $self->{opts};
debugmsg ('info', "starting new backup job: $self->{cmdline}", undef, 1);
debugmsg ('info', "skip external VMs: " . join(', ', @{$self->{skiplist}}))
if scalar(@{$self->{skiplist}});
my $tasklist = [];
if ($opts->{all}) {
foreach my $plugin (@{$self->{plugins}}) {
my $vmlist = $plugin->vmlist();
foreach my $vmid (sort @$vmlist) {
next if grep { $_ eq $vmid } @{$opts->{exclude}};
next if !$rpcenv->check($authuser, "/vms/$vmid", [ 'VM.Backup' ], 1);
push @$tasklist, { vmid => $vmid, state => 'todo', plugin => $plugin };
}
}
} else {
foreach my $vmid (sort @{$opts->{vmids}}) {
my $plugin;
foreach my $pg (@{$self->{plugins}}) {
my $vmlist = $pg->vmlist();
if (grep { $_ eq $vmid } @$vmlist) {
$plugin = $pg;
last;
}
}
$rpcenv->check($authuser, "/vms/$vmid", [ 'VM.Backup' ]);
push @$tasklist, { vmid => $vmid, state => 'todo', plugin => $plugin };
}
}
my $starttime = time();
my $errcount = 0;
eval {
$self->run_hook_script ('job-start');
foreach my $task (@$tasklist) {
$self->exec_backup_task ($task);
$errcount += 1 if $task->{state} ne 'ok';
}
$self->run_hook_script ('job-end');
};
my $err = $@;
$self->run_hook_script ('job-abort') if $err;
if ($err) {
debugmsg ('err', "Backup job failed - $err", undef, 1);
} else {
if ($errcount) {
debugmsg ('info', "Backup job finished with errors", undef, 1);
} else {
debugmsg ('info', "Backup job finished successfully", undef, 1);
}
}
my $totaltime = time() - $starttime;
eval { $self->sendmail ($tasklist, $totaltime); };
debugmsg ('err', $@) if $@;
die $err if $err;
die "job errors\n" if $errcount;
unlink $pidfile;
}
my $confdesc = {
vmid => {
type => 'string', format => 'pve-vmid-list',
description => "The ID of the VM you want to backup.",
optional => 1,
},
node => get_standard_option('pve-node', {
description => "Only run if executed on this node.",
optional => 1,
}),
all => {
type => 'boolean',
description => "Backup all known VMs on this host.",
optional => 1,
default => 0,
},
stdexcludes => {
type => 'boolean',
description => "Exclude temorary files and logs.",
optional => 1,
default => 1,
},
compress => {
type => 'string',
description => "Compress dump file.",
optional => 1,
enum => ['0', '1', 'gzip', 'lzo'],
default => 'lzo',
},
quiet => {
type => 'boolean',
description => "Be quiet.",
optional => 1,
default => 0,
},
mode => {
type => 'string',
description => "Backup mode.",
optional => 1,
default => 'stop',
enum => [ 'snapshot', 'suspend', 'stop' ],
},
exclude => {
type => 'string', format => 'pve-vmid-list',
description => "exclude specified VMs (assumes --all)",
optional => 1,
},
'exclude-path' => {
type => 'string', format => 'string-alist',
description => "exclude certain files/directories (regex).",
optional => 1,
},
mailto => {
type => 'string', format => 'string-list',
description => "",
optional => 1,
},
mailnotification => {
type => 'string',
description => "Specify when to send an email",
optional => 1,
enum => [ 'always', 'failure' ],
default => 'always',
},
tmpdir => {
type => 'string',
description => "Store temporary files to specified directory.",
optional => 1,
},
dumpdir => {
type => 'string',
description => "Store resulting files to specified directory.",
optional => 1,
},
script => {
type => 'string',
description => "Use specified hook script.",
optional => 1,
},
storage => get_standard_option('pve-storage-id', {
description => "Store resulting file to this storage.",
optional => 1,
}),
stop => {
type => 'boolean',
description => "Stop runnig backup jobs on this host.",
optional => 1,
default => 0,
},
size => {
type => 'integer',
description => "LVM snapshot size in MB.",
optional => 1,
minimum => 500,
},
bwlimit => {
type => 'integer',
description => "Limit I/O bandwidth (KBytes per second).",
optional => 1,
minimum => 0,
},
ionice => {
type => 'integer',
description => "Set CFQ ionice priority.",
optional => 1,
minimum => 0,
maximum => 8,
},
lockwait => {
type => 'integer',
description => "Maximal time to wait for the global lock (minutes).",
optional => 1,
minimum => 0,
},
stopwait => {
type => 'integer',
description => "Maximal time to wait until a VM is stopped (minutes).",
optional => 1,
minimum => 0,
},
maxfiles => {
type => 'integer',
description => "Maximal number of backup files per VM.",
optional => 1,
minimum => 1,
},
remove => {
type => 'boolean',
description => "Remove old backup files if there are more than 'maxfiles' backup files.",
optional => 1,
default => 1,
},
};
sub option_exists {
my $key = shift;
return defined($confdesc->{$key});
}
# add JSON properties for create and set function
sub json_config_properties {
my $prop = shift;
foreach my $opt (keys %$confdesc) {
$prop->{$opt} = $confdesc->{$opt};
}
return $prop;
}
sub verify_vzdump_parameters {
my ($param, $check_missing) = @_;
raise_param_exc({ all => "option conflicts with option 'vmid'"})
if $param->{all} && $param->{vmid};
raise_param_exc({ exclude => "option conflicts with option 'vmid'"})
if $param->{exclude} && $param->{vmid};
$param->{all} = 1 if defined($param->{exclude});
return if !$check_missing;
raise_param_exc({ vmid => "property is missing"})
if !($param->{all} || $param->{stop}) && !$param->{vmid};
}
sub stop_running_backups {
my($self) = @_;
my $upid = PVE::Tools::file_read_firstline($pidfile);
return if !$upid;
my $task = PVE::Tools::upid_decode($upid);
if (PVE::ProcFSTools::check_process_running($task->{pid}, $task->{pstart}) &&
PVE::ProcFSTools::read_proc_starttime($task->{pid}) == $task->{pstart}) {
kill(15, $task->{pid});
# wait max 15 seconds to shut down (else, do nothing for now)
my $i;
for ($i = 15; $i > 0; $i--) {
last if !PVE::ProcFSTools::check_process_running(($task->{pid}, $task->{pstart}));
sleep (1);
}
die "stoping backup process $task->{pid} failed\n" if $i == 0;
}
}
sub command_line {
my ($param) = @_;
my $cmd = "vzdump";
if ($param->{vmid}) {
$cmd .= " " . join(' ', PVE::Tools::split_list($param->{vmid}));
}
foreach my $p (keys %$param) {
next if $p eq 'id' || $p eq 'vmid' || $p eq 'starttime' || $p eq 'dow' || $p eq 'stdout';
my $v = $param->{$p};
my $pd = $confdesc->{$p} || die "no such vzdump option '$p'\n";
if ($p eq 'exclude-path') {
foreach my $path (split(/\0/, $v || '')) {
$cmd .= " --$p " . PVE::Tools::shellquote($path);
}
} else {
$cmd .= " --$p " . PVE::Tools::shellquote($v) if defined($v) && $v ne '';
}
}
return $cmd;
}
1;