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 PVE::VZDump::OpenVZ;
-use Time::localtime;
+use POSIX qw(strftime);
use Time::Local;
use PVE::JSONSchema qw(get_standard_option);
+use PVE::HA::Env::PVE2;
+use PVE::HA::Config;
+use PVE::VZDump::Plugin;
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 (PVE::VZDump::OpenVZ);
+my @plugins = qw();
+
+my $confdesc = {
+ vmid => {
+ type => 'string', format => 'pve-vmid-list',
+ description => "The ID of the guest system you want to backup.",
+ completion => \&PVE::Cluster::complete_local_vmid,
+ optional => 1,
+ },
+ node => get_standard_option('pve-node', {
+ description => "Only run if executed on this node.",
+ completion => \&PVE::Cluster::get_nodelist,
+ optional => 1,
+ }),
+ all => {
+ type => 'boolean',
+ description => "Backup all known guest systems on this host.",
+ optional => 1,
+ default => 0,
+ },
+ stdexcludes => {
+ type => 'boolean',
+ description => "Exclude temporary files and logs.",
+ optional => 1,
+ default => 1,
+ },
+ compress => {
+ type => 'string',
+ description => "Compress dump file.",
+ optional => 1,
+ enum => ['0', '1', 'gzip', 'lzo'],
+ default => '0',
+ },
+ pigz=> {
+ type => "integer",
+ description => "Use pigz instead of gzip when N>0.".
+ " N=1 uses half of cores, N>1 uses N as thread count.",
+ optional => 1,
+ default => 0,
+ },
+ quiet => {
+ type => 'boolean',
+ description => "Be quiet.",
+ optional => 1,
+ default => 0,
+ },
+ mode => {
+ type => 'string',
+ description => "Backup mode.",
+ optional => 1,
+ default => 'snapshot',
+ enum => [ 'snapshot', 'suspend', 'stop' ],
+ },
+ exclude => {
+ type => 'string', format => 'pve-vmid-list',
+ description => "Exclude specified guest systems (assumes --all)",
+ optional => 1,
+ },
+ 'exclude-path' => {
+ type => 'string', format => 'string-alist',
+ description => "Exclude certain files/directories (shell globs).",
+ optional => 1,
+ },
+ mailto => {
+ type => 'string', format => 'string-list',
+ description => "Comma-separated list of email addresses that should" .
+ " receive email notifications.",
+ 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.",
+ completion => \&complete_backup_storage,
+ optional => 1,
+ }),
+ stop => {
+ type => 'boolean',
+ description => "Stop running backup jobs on this host.",
+ optional => 1,
+ default => 0,
+ },
+ size => {
+ type => 'integer',
+ description => "Unused, will be removed in a future release.",
+ optional => 1,
+ minimum => 500,
+ default => 1024,
+ },
+ bwlimit => {
+ type => 'integer',
+ description => "Limit I/O bandwidth (KBytes per second).",
+ optional => 1,
+ minimum => 0,
+ default => 0,
+ },
+ ionice => {
+ type => 'integer',
+ description => "Set CFQ ionice priority.",
+ optional => 1,
+ minimum => 0,
+ maximum => 8,
+ default => 7,
+ },
+ lockwait => {
+ type => 'integer',
+ description => "Maximal time to wait for the global lock (minutes).",
+ optional => 1,
+ minimum => 0,
+ default => 3*60, # 3 hours
+ },
+ stopwait => {
+ type => 'integer',
+ description => "Maximal time to wait until a guest system is stopped (minutes).",
+ optional => 1,
+ minimum => 0,
+ default => 10, # 10 minutes
+ },
+ maxfiles => {
+ type => 'integer',
+ description => "Maximal number of backup files per guest system.",
+ optional => 1,
+ minimum => 1,
+ default => 1,
+ },
+ remove => {
+ type => 'boolean',
+ description => "Remove old backup files if there are more than 'maxfiles' backup files.",
+ optional => 1,
+ default => 1,
+ },
+ pool => {
+ type => 'string',
+ description => 'Backup all known guest systems included in the specified pool.',
+ optional => 1,
+ }
+};
# Load available plugins
-my $pveplug = "/usr/share/perl5/PVE/VZDump/QemuServer.pm";
-if (-f $pveplug) {
- eval { require $pveplug; };
- if (!$@) {
- PVE::VZDump::QemuServer->import ();
- push @plugins, "PVE::VZDump::QemuServer";
- } else {
- warn $@;
- }
+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 {
+ die $@;
+ }
+ }
}
# 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;
- }
+ PVE::VZDump::Plugin::debugmsg(@_);
}
sub run_command {
sub storage_info {
my $storage = shift;
- my $cfg = cfs_read_file('storage.cfg');
+ my $cfg = PVE::Storage::config();
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 for backups - wrong content type\n"
+
+ die "can't use storage type '$type' for backup\n"
+ if (!($type eq 'dir' || $type eq 'nfs' || $type eq 'glusterfs'
+ || $type eq 'cifs' || $type eq 'cephfs'));
+ die "can't use storage '$storage' for backups - wrong content type\n"
if (!$scfg->{content}->{backup});
PVE::Storage::activate_storage($cfg, $storage);
} else {
my $gb = $mb / 1024;
return sprintf ("%.2fGB", $gb);
- }
+ }
}
sub format_time {
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 $defaults = {
+ map {
+ my $default = $confdesc->{$_}->{default};
+ defined($default) ? ($_ => $default) : ()
+ } keys %$confdesc
};
- 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/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);
- }
+ my $raw;
+ eval { $raw = PVE::Tools::file_get_contents($fn); };
+ return $defaults if $@;
+ my $conf_schema = { type => 'object', properties => $confdesc, };
+ my $res = PVE::JSONSchema::parse_config($conf_schema, $fn, $raw);
+ if (my $excludes = $res->{'exclude-path'}) {
+ $res->{'exclude-path'} = PVE::Tools::split_args($excludes);
}
- close ($fh);
-
- return $res;
-}
-
-
-sub find_add_exclude {
- my ($self, $excltype, $value) = @_;
-
- if (($excltype eq '-regex') || ($excltype eq '-files')) {
- $value = "\.$value";
+ if (defined($res->{mailto})) {
+ my @mailto = PVE::Tools::split_list($res->{mailto});
+ $res->{mailto} = [ @mailto ];
}
- if ($excltype eq '-files') {
- push @{$self->{findexcl}}, "'('", '-not', '-type', 'd', '-regex' , "'$value'", "')'", '-o';
- } else {
- push @{$self->{findexcl}}, "'('", $excltype , "'$value'", '-prune', "')'", '-o';
+ foreach my $key (keys %$defaults) {
+ $res->{$key} = $defaults->{$key} if !defined($res->{$key});
}
+
+ return $res;
}
sub sendmail {
- my ($self, $tasklist, $totaltime, $err) = @_;
+ my ($self, $tasklist, $totaltime, $err, $detail_pre, $detail_post) = @_;
my $opts = $self->{opts};
return if (!$ecount && !$err && ($notify eq 'failure'));
my $stat = ($ecount || $err) ? 'backup failed' : 'backup successful';
- $stat .= ": $err" if $err;
+ if ($err) {
+ if ($err =~ /\n/) {
+ $stat .= ": multiple problems";
+ } else {
+ $stat .= ": $err";
+ $err = undef;
+ }
+ }
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));
+ my $text = $err ? "$err\n\n" : '';
+ $text .= sprintf ("%-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},
+ $text .= sprintf ("%-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},
+ $text .= sprintf ("%-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";
+ $text .= "\nDetailed backup logs:\n\n";
+ $text .= "$cmdline\n\n";
+
+ $text .= $detail_pre . "\n" if defined($detail_pre);
foreach my $task (@$tasklist) {
my $vmid = $task->{vmid};
my $log = $task->{tmplog};
if (!$log) {
- print MAIL "${fill}$vmid: no log available\n\n";
+ $text .= "$vmid: no log available\n\n";
next;
}
open (TMP, "$log");
- while (my $line = <TMP>) { print MAIL encode8bit ("${fill}$vmid: $line"); }
+ while (my $line = <TMP>) { $text .= encode8bit ("$vmid: $line"); }
close (TMP);
- print MAIL "${fill}\n";
+ $text .= "\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";
+ $text .= $detail_post if defined($detail_post);
# 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 $html = "<html><body>\n";
+ $html .= "<p>" . (escape_html($err) =~ s/\n/<br>/gr) . "</p>\n" if $err;
+ $html .= "<table border=1 cellpadding=3>\n";
+ $html .= "<tr><td>VMID<td>NAME<td>STATUS<td>TIME<td>SIZE<td>FILENAME</tr>\n";
my $ssize = 0;
$ssize += $task->{size};
- print MAIL sprintf ("<tr><td>%s<td>%s<td>OK<td>%s<td align=right>%s<td>%s</tr>\n",
+ $html .= 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}),
+ $html .= 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>",
+ $html .= 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";
+ $html .= "</table><br><br>\n";
+ $html .= "Detailed backup logs:<br /><br />\n";
+ $html .= "<pre>\n";
+ $html .= escape_html($cmdline) . "\n\n";
+ $html .= escape_html($detail_pre) . "\n" if defined($detail_pre);
foreach my $task (@$tasklist) {
my $vmid = $task->{vmid};
my $log = $task->{tmplog};
if (!$log) {
- print MAIL "$vmid: no log available\n\n";
+ $html .= "$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>");
+ $html .= encode8bit ("$vmid: <font color=red>".
+ escape_html ($line) . "</font>");
} else {
- print MAIL encode8bit ("$vmid: " . escape_html ($line));
+ $html .= encode8bit ("$vmid: " . escape_html ($line));
}
}
close (TMP);
- print MAIL "\n";
+ $html .= "\n";
}
- print MAIL "</pre>\n";
+ $html .= escape_html($detail_post) if defined($detail_post);
+ $html .= "</pre></body></html>\n";
+ # end html part
- print MAIL "</body></html>\n";
+ my $subject = "vzdump backup status ($hostname) : $stat";
- # end html part
- print MAIL "\n--$boundary--\n";
+ my $dcconf = PVE::Cluster::cfs_read_file('datacenter.cfg');
+ my $mailfrom = $dcconf->{email_from} || "root";
- close(MAIL);
+ PVE::Tools::sendmail($mailto, $subject, $text, $html, $mailfrom, "vzdump backup tool");
};
sub new {
$opts->{remove} = 1 if !defined($opts->{remove});
foreach my $k (keys %$defaults) {
+ next if $k eq 'exclude-path'; # dealt with separately
if ($k eq 'dumpdir' || $k eq 'storage') {
$opts->{$k} = $defaults->{$k} if !defined ($opts->{dumpdir}) &&
!defined ($opts->{storage});
$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
-
+ my $findexcl = $self->{findexcl} = [];
if ($defaults->{'exclude-path'}) {
- foreach my $path (@{$defaults->{'exclude-path'}}) {
- $self->find_add_exclude ('-regex', $path);
- }
+ push @$findexcl, @{$defaults->{'exclude-path'}};
}
if ($opts->{'exclude-path'}) {
- foreach my $path (@{$opts->{'exclude-path'}}) {
- $self->find_add_exclude ('-regex', $path);
- }
+ push @$findexcl, @{$opts->{'exclude-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');
+ push @$findexcl, '/tmp/?*',
+ '/var/tmp/?*',
+ '/var/run/?*.pid';
}
foreach my $p (@plugins) {
$opts->{storage} = 'local';
}
+ my $errors = '';
+
if ($opts->{storage}) {
- my $info = storage_info ($opts->{storage});
+ my $info = eval { storage_info ($opts->{storage}) };
+ $errors .= "could not get storage information for '$opts->{storage}': $@"
+ if ($@);
$opts->{dumpdir} = $info->{dumpdir};
- $maxfiles = $info->{maxfiles} if !defined($maxfiles) && defined($info->{maxfiles});
+ $maxfiles //= $info->{maxfiles};
} elsif ($opts->{dumpdir}) {
- die "dumpdir '$opts->{dumpdir}' does not exist\n"
+ $errors .= "dumpdir '$opts->{dumpdir}' does not exist"
if ! -d $opts->{dumpdir};
} else {
- die "internal error";
+ die "internal error";
}
if ($opts->{tmpdir} && ! -d $opts->{tmpdir}) {
- die "tmpdir '$opts->{tmpdir}' does not exist\n";
+ $errors .= "\n" if $errors;
+ $errors .= "tmpdir '$opts->{tmpdir}' does not exist";
+ }
+
+ if ($errors) {
+ eval { $self->sendmail([], 0, $errors); };
+ debugmsg ('err', $@) if $@;
+ die "$errors\n";
}
$opts->{maxfiles} = $maxfiles if defined($maxfiles);
}
-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) = @_;
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);
+sub getlock {
+ my ($self, $upid) = @_;
- ($vg, $lv) = @{$mapping->{$dev}} if defined $mapping->{$dev};
+ my $fh;
- return wantarray ? ($dev, $info->{mountpoint}, $vg, $lv, $info->{fstype}) : $dev;
-}
+ my $maxwait = $self->{opts}->{lockwait} || $self->{lockwait};
-sub getlock {
- my ($self) = @_;
+ die "missimg UPID" if !$upid; # should not happen
- my $maxwait = $self->{opts}->{lockwait} || $self->{lockwait};
-
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)) {
- return;
- }
+ 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)";
- }
+ if (!$maxwait) {
+ debugmsg ('err', "can't acquire lock '$lockfile' (wait = 0)", undef, 1);
+ die "can't acquire lock '$lockfile' (wait = 0)";
+ }
- debugmsg('info', "trying to get global lock - waiting...", undef, 1);
+ debugmsg('info', "trying to get global lock - waiting...", undef, 1);
- eval {
- alarm ($maxwait * 60);
-
- local $SIG{ALRM} = sub { alarm (0); die "got timeout\n"; };
+ eval {
+ alarm ($maxwait * 60);
- if (!flock (SERVER_FLCK, LOCK_EX)) {
- my $err = $!;
- close (SERVER_FLCK);
+ 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);
- 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";
+ my $err = $@;
+
+ if ($err) {
+ debugmsg ('err', "can't acquire lock '$lockfile' - $err", undef, 1);
+ die "can't acquire lock '$lockfile' - $err";
+ }
+
+ debugmsg('info', "got global lock", undef, 1);
}
- debugmsg('info', "got global lock", undef, 1);
+ PVE::Tools::file_set_contents($pidfile, $upid);
}
sub run_hook_script {
}
sub compressor_info {
- my ($opt_compress) = @_;
+ my ($opts) = @_;
+ my $opt_compress = $opts->{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');
+ if ($opts->{pigz} > 0) {
+ my $pigz_threads = $opts->{pigz};
+ if ($pigz_threads == 1) {
+ my $cpuinfo = PVE::ProcFSTools::read_cpuinfo();
+ $pigz_threads = int(($cpuinfo->{cpus} + 1)/2);
+ }
+ return ("pigz -p ${pigz_threads}", 'gz');
+ } else {
+ return ('gzip --rsyncable', 'gz');
+ }
} else {
die "internal error - unknown compression option '$opt_compress'";
}
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);
+ my $t = timelocal ($7, $6, $5, $4, $3 - 1, $2);
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;
+ my $log_vm_online_again = sub {
+ return if !defined($task->{vmstoptime});
+ $task->{vmconttime} //= time();
+ my $delay = $task->{vmconttime} - $task->{vmstoptime};
+ debugmsg ('info', "guest is online again after $delay seconds", $logfd);
+ };
eval {
die "unable to find VM '$vmid'\n" if !$plugin;
+ # for now we deny backups of a running ha managed service in *stop* mode
+ # as it interferes with the HA stack (started services should not stop).
+ if ($opts->{mode} eq 'stop' &&
+ PVE::HA::Config::vm_is_ha_managed($vmid, 'started'))
+ {
+ die "Cannot execute a backup with stop mode on a HA managed and".
+ " enabled Service. Use snapshot mode or disable the Service.\n";
+ }
+
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 $basename = $bkname . strftime("-%Y_%m_%d-%H_%M_%S", localtime());
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"
+ die "There is a max backup limit of ($maxfiles) enforced by the".
+ " target storage or the vzdump parameters.".
+ " Either increase the limit or delete old backup(s).\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});
+ my ($comp, $comp_ext) = compressor_info($opts);
if ($comp && $comp_ext) {
$ext .= ".${comp_ext}";
}
$task->{vmtype} = $vmtype;
if ($opts->{tmpdir}) {
- $task->{tmpdir} = "$opts->{tmpdir}/vzdumptmp$$";
+ $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' ||
+ if ($vmtype eq 'qemu' ||
grep ($_ eq $info->{fstype}, @posix_filesystems)) {
$task->{tmpdir} = "$opts->{dumpdir}/$basename.tmp";
} else {
unlink $logfile;
- debugmsg ('info', "Starting Backup of VM $vmid ($vmtype)", $logfd, 1);
+ debugmsg ('info', "Starting Backup of VM $vmid ($vmtype)", $logfd, 1);
+ debugmsg ('info', "Backup started at " . strftime("%F %H:%M:%S", localtime()));
$plugin->set_logfd ($logfd);
# prepare
- my $mode = $running ? $opts->{mode} : 'stop';
+ my $mode = $running ? $task->{mode} : 'stop';
if ($mode eq 'snapshot') {
my %saved_task = %$task;
debugmsg ('info', $err, $logfd);
debugmsg ('info', "trying 'suspend' mode instead", $logfd);
$mode = 'suspend'; # so prepare is called again below
- %$task = %saved_task;
+ %$task = %saved_task;
}
}
+ $cleanup->{prepared} = 1;
+
$task->{mode} = $mode;
debugmsg ('info', "backup mode: $mode", $logfd);
if ($running) {
debugmsg ('info', "stopping vm", $logfd);
- $vmstoptime = time ();
+ $task->{vmstoptime} = time();
$self->run_hook_script ('pre-stop', $task, $logfd);
$plugin->stop_vm ($task, $vmid);
$cleanup->{restart} = 1;
}
-
+
} elsif ($mode eq 'suspend') {
$self->run_hook_script ('backup-start', $task, $logfd);
- if ($vmtype eq 'openvz') {
+ if ($vmtype eq 'lxc') {
# pre-suspend rsync
- $plugin->copy_data_phase1 ($task, $vmid);
+ $plugin->copy_data_phase1($task, $vmid);
}
debugmsg ('info', "suspend vm", $logfd);
- $vmstoptime = time ();
+ $task->{vmstoptime} = time ();
$self->run_hook_script ('pre-stop', $task, $logfd);
$plugin->suspend_vm ($task, $vmid);
$cleanup->{resume} = 1;
- if ($vmtype eq 'openvz') {
+ if ($vmtype eq 'lxc') {
# post-suspend rsync
- $plugin->copy_data_phase2 ($task, $vmid);
+ $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);
+ $self->run_hook_script('pre-restart', $task, $logfd);
+ $plugin->resume_vm($task, $vmid);
+ $self->run_hook_script('post-restart', $task, $logfd);
+ $log_vm_online_again->();
}
} elsif ($mode eq 'snapshot') {
if ($snapshot_count > 1) {
debugmsg ('info', "suspend vm to make snapshot", $logfd);
- $vmstoptime = time ();
+ $task->{vmstoptime} = time ();
$plugin->suspend_vm ($task, $vmid);
$cleanup->{resume} = 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);
+ $log_vm_online_again->();
}
+ $self->run_hook_script ('post-restart', $task, $logfd);
+
} else {
die "internal error - unknown mode '$mode'\n";
}
# assemble archive image
$plugin->assemble ($task, $vmid);
-
- # produce archive
+
+ # produce archive
if ($opts->{stdout}) {
debugmsg ('info', "sending archive to stdout", $logfd);
# determine size
$task->{size} = (-s $task->{tarfile}) || 0;
- my $cs = format_size ($task->{size});
+ my $cs = format_size ($task->{size});
debugmsg ('info', "archive file size: $cs", $logfd);
# purge older backup
warn $@ if $@;
}
- eval { $plugin->cleanup ($task, $vmid) };
- warn $@ if $@;
+ if ($cleanup->{prepared}) {
+ # only call cleanup when necessary (when prepare was executed)
+ eval { $plugin->cleanup ($task, $vmid) };
+ warn $@ if $@;
+ }
eval { $plugin->set_logfd (undef); };
warn $@ if $@;
- if ($cleanup->{resume} || $cleanup->{restart}) {
- eval {
+ if ($cleanup->{resume} || $cleanup->{restart}) {
+ eval {
$self->run_hook_script ('pre-restart', $task, $logfd);
if ($cleanup->{resume}) {
debugmsg ('info', "resume vm", $logfd);
debugmsg ('info', "restarting vm", $logfd);
$plugin->start_vm ($task, $vmid);
}
- }
+ }
+ $self->run_hook_script ('post-restart', $task, $logfd);
};
my $err = $@;
if ($err) {
warn $err;
} else {
- my $delay = time () - $vmstoptime;
- debugmsg ('info', "vm is online again after $delay seconds", $logfd);
+ $log_vm_online_again->();
}
}
}
$task->{state} = 'err';
$task->{msg} = $err;
debugmsg ('err', "Backup of VM $vmid failed - $err", $logfd, 1);
+ debugmsg ('info', "Failed at " . strftime("%F %H:%M:%S", localtime()));
eval { $self->run_hook_script ('backup-abort', $task, $logfd); };
$task->{state} = 'ok';
my $tstr = format_time ($delay);
debugmsg ('info', "Finished Backup of VM $vmid ($tstr)", $logfd, 1);
+ debugmsg ('info', "Backup finished at " . strftime("%F %H:%M:%S", localtime()));
}
close ($logfd) if $logfd;
-
+
if ($task->{tmplog} && $task->{logfile}) {
- system ("cp '$task->{tmplog}' '$task->{logfile}'");
+ system {'cp'} 'cp', $task->{tmplog}, $task->{logfile};
}
eval { $self->run_hook_script ('log-end', $task); };
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 $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 };
+ push @$tasklist, { vmid => $vmid, state => 'todo', plugin => $plugin, mode => $opts->{mode} };
}
}
} else {
}
}
$rpcenv->check($authuser, "/vms/$vmid", [ 'VM.Backup' ]);
- push @$tasklist, { vmid => $vmid, state => 'todo', plugin => $plugin };
+ push @$tasklist, { vmid => $vmid, state => 'todo', plugin => $plugin, mode => $opts->{mode} };
}
}
+ # Use in-memory files for the outer hook logs to pass them to sendmail.
+ my $job_start_log = '';
+ my $job_end_log = '';
+ open my $job_start_fd, '>', \$job_start_log;
+ open my $job_end_fd, '>', \$job_end_log;
+
my $starttime = time();
my $errcount = 0;
eval {
- $self->run_hook_script ('job-start');
+ $self->run_hook_script ('job-start', undef, $job_start_fd);
foreach my $task (@$tasklist) {
$self->exec_backup_task ($task);
$errcount += 1 if $task->{state} ne 'ok';
}
- $self->run_hook_script ('job-end');
+ $self->run_hook_script ('job-end', undef, $job_end_fd);
};
my $err = $@;
- $self->run_hook_script ('job-abort') if $err;
+ $self->run_hook_script ('job-abort', undef, $job_end_fd) if $err;
if ($err) {
debugmsg ('err', "Backup job failed - $err", undef, 1);
}
}
+ close $job_start_fd;
+ close $job_end_fd;
+
my $totaltime = time() - $starttime;
- eval { $self->sendmail ($tasklist, $totaltime); };
+ eval { $self->sendmail ($tasklist, $totaltime, undef, $job_start_log, $job_end_log); };
debugmsg ('err', $@) if $@;
die $err if $err;
- die "job errors\n" if $errcount;
+ 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,
- }),
- 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;
raise_param_exc({ exclude => "option conflicts with option 'vmid'"})
if $param->{exclude} && $param->{vmid};
- $param->{all} = 1 if defined($param->{exclude});
+ raise_param_exc({ pool => "option conflicts with option 'vmid'"})
+ if $param->{pool} && $param->{vmid};
+
+ $param->{all} = 1 if (defined($param->{exclude}) && !$param->{pool});
+
+ warn "option 'size' is deprecated and will be removed in a future " .
+ "release, please update your script/configuration!\n"
+ if defined($param->{size});
return if !$check_missing;
raise_param_exc({ vmid => "property is missing"})
- if !$param->{all} && !$param->{vmid};
+ if !($param->{all} || $param->{stop} || $param->{pool}) && !$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 "stopping backup process $task->{pid} failed\n" if $i == 0;
+ }
+}
+
sub command_line {
my ($param) = @_;
}
foreach my $p (keys %$param) {
- next if $p eq 'id' || $p eq 'vmid' || $p eq 'starttime' || $p eq 'dow' || $p eq 'stdout';
+ next if $p eq 'id' || $p eq 'vmid' || $p eq 'starttime' ||
+ $p eq 'dow' || $p eq 'stdout' || $p eq 'enabled';
my $v = $param->{$p};
my $pd = $confdesc->{$p} || die "no such vzdump option '$p'\n";
if ($p eq 'exclude-path') {
return $cmd;
}
+# bash completion helpers
+sub complete_backup_storage {
+
+ my $cfg = PVE::Storage::config();
+ my $ids = $cfg->{ids};
+
+ my $nodename = PVE::INotify::nodename();
+
+ my $res = [];
+ foreach my $sid (keys %$ids) {
+ my $scfg = $ids->{$sid};
+ next if !PVE::Storage::storage_check_enabled($cfg, $sid, $nodename, 1);
+ next if !$scfg->{content}->{backup};
+ push @$res, $sid;
+ }
+
+ return $res;
+}
+
1;
projects / pve-manager.git / blobdiff