11 use POSIX
qw(strftime);
14 use PVE
::Cluster
qw(cfs_read_file);
15 use PVE
::DataCenterConfig
;
16 use PVE
::Exception
qw(raise_param_exc);
18 use PVE
::HA
::Env
::PVE2
;
19 use PVE
::JSONSchema
qw(get_standard_option);
20 use PVE
::RPCEnvironment
;
22 use PVE
::VZDump
::Common
;
23 use PVE
::VZDump
::Plugin
;
24 use PVE
::Tools
qw(extract_param split_list);
27 my @posix_filesystems = qw(ext3 ext4 nfs nfs4 reiserfs xfs);
29 my $lockfile = '/var/run/vzdump.lock';
30 my $pidfile = '/var/run/vzdump.pid';
31 my $logdir = '/var/log/vzdump';
35 my $confdesc = PVE
::VZDump
::Common
::get_confdesc
();
37 # Load available plugins
38 my @pve_vzdump_classes = qw(PVE::VZDump::QemuServer PVE::VZDump::LXC);
39 foreach my $plug (@pve_vzdump_classes) {
40 my $filename = "/usr/share/perl5/$plug.pm";
41 $filename =~ s!::!/!g;
43 eval { require $filename; };
56 my ($mtype, $msg, $logfd, $syslog) = @_;
58 PVE
::VZDump
::Plugin
::debugmsg
(@_);
62 my ($logfd, $cmdstr, %param) = @_;
66 debugmsg
('info', $line, $logfd);
69 PVE
::Tools
::run_command
($cmdstr, %param, logfunc
=> $logfunc);
72 my $parse_prune_backups_maxfiles = sub {
73 my ($param, $kind) = @_;
75 my $maxfiles = delete $param->{maxfiles
};
76 my $prune_backups = $param->{'prune-backups'};
78 debugmsg
('warn', "both 'maxfiles' and 'prune-backups' defined as ${kind} - ignoring 'maxfiles'")
79 if defined($maxfiles) && defined($prune_backups);
81 if (defined($prune_backups)) {
82 return if ref($prune_backups) eq 'HASH'; # already parsed
83 $param->{'prune-backups'} = PVE
::JSONSchema
::parse_property_string
(
87 } elsif (defined($maxfiles)) {
89 $param->{'prune-backups'} = { 'keep-last' => $maxfiles };
91 $param->{'prune-backups'} = { 'keep-all' => 1 };
99 my $cfg = PVE
::Storage
::config
();
100 my $scfg = PVE
::Storage
::storage_config
($cfg, $storage);
101 my $type = $scfg->{type
};
103 die "can't use storage type '$type' for backup\n"
104 if (!($type eq 'dir' || $type eq 'nfs' || $type eq 'glusterfs'
105 || $type eq 'cifs' || $type eq 'cephfs' || $type eq 'pbs'));
106 die "can't use storage '$storage' for backups - wrong content type\n"
107 if (!$scfg->{content
}->{backup
});
113 $info->{'prune-backups'} = PVE
::JSONSchema
::parse_property_string
('prune-backups', $scfg->{'prune-backups'})
114 if defined($scfg->{'prune-backups'});
116 if ($type eq 'pbs') {
119 $info->{dumpdir
} = PVE
::Storage
::get_backup_dir
($cfg, $storage);
128 my $kb = $size / 1024;
131 return int ($kb) . "KB";
134 my $mb = $size / (1024*1024);
136 return int ($mb) . "MB";
140 return sprintf ("%.2fGB", $gb);
143 return sprintf ("%.2fTB", $tb);
149 my $hours = int ($seconds/3600);
150 $seconds = $seconds - $hours*3600;
151 my $min = int ($seconds/60);
152 $seconds = $seconds - $min*60;
154 return sprintf ("%02d:%02d:%02d", $hours, $min, $seconds);
160 $str =~ s/^(.{990})/$1\n/mg; # reduce line length
178 foreach my $p (split (/:/, $ENV{PATH
})) {
185 die "unable to find command '$bin'\n";
192 for my $vmid (sort {$a <=> $b} @vmids) {
193 die "ERROR: strange VM ID '${vmid}'\n" if $vmid !~ m/^\d+$/;
194 $vmid = int ($vmid); # remove leading zeros
203 sub read_vzdump_defaults
{
205 my $fn = "/etc/vzdump.conf";
209 my $default = $confdesc->{$_}->{default};
210 defined($default) ?
($_ => $default) : ()
213 $parse_prune_backups_maxfiles->($defaults, "defaults in VZDump schema");
216 eval { $raw = PVE
::Tools
::file_get_contents
($fn); };
217 return $defaults if $@;
219 my $conf_schema = { type
=> 'object', properties
=> $confdesc, };
220 my $res = PVE
::JSONSchema
::parse_config
($conf_schema, $fn, $raw);
221 if (my $excludes = $res->{'exclude-path'}) {
222 $res->{'exclude-path'} = PVE
::Tools
::split_args
($excludes);
224 if (defined($res->{mailto
})) {
225 my @mailto = split_list
($res->{mailto
});
226 $res->{mailto
} = [ @mailto ];
228 $parse_prune_backups_maxfiles->($res, "options in '$fn'");
230 foreach my $key (keys %$defaults) {
231 $res->{$key} = $defaults->{$key} if !defined($res->{$key});
234 if (defined($res->{storage
}) && defined($res->{dumpdir
})) {
235 debugmsg
('warn', "both 'storage' and 'dumpdir' defined in '$fn' - ignoring 'dumpdir'");
236 delete $res->{dumpdir
};
242 use constant MAX_MAIL_SIZE
=> 1024*1024;
244 my ($self, $tasklist, $totaltime, $err, $detail_pre, $detail_post) = @_;
246 my $opts = $self->{opts
};
248 my $mailto = $opts->{mailto
};
250 return if !($mailto && scalar(@$mailto));
252 my $cmdline = $self->{cmdline
};
255 foreach my $task (@$tasklist) {
256 $ecount++ if $task->{state} ne 'ok';
257 chomp $task->{msg
} if $task->{msg
};
258 $task->{backuptime
} = 0 if !$task->{backuptime
};
259 $task->{size
} = 0 if !$task->{size
};
260 $task->{target
} = 'unknown' if !$task->{target
};
261 $task->{hostname
} = "VM $task->{vmid}" if !$task->{hostname
};
263 if ($task->{state} eq 'todo') {
264 $task->{msg
} = 'aborted';
268 my $notify = $opts->{mailnotification
} || 'always';
269 return if (!$ecount && !$err && ($notify eq 'failure'));
271 my $stat = ($ecount || $err) ?
'backup failed' : 'backup successful';
274 $stat .= ": multiple problems";
281 my $hostname = `hostname -f` || PVE
::INotify
::nodename
();
285 my $text = $err ?
"$err\n\n" : '';
288 "%-10s %-${namelength}s %-6s %10s %10s %s\n",
289 qw(VMID NAME STATUS TIME SIZE FILENAME)
291 foreach my $task (@$tasklist) {
292 my $name = substr($task->{hostname
}, 0, $namelength);
293 my $successful = $task->{state} eq 'ok';
294 my $size = $successful ? format_size
($task->{size
}) : 0;
295 my $filename = $successful ?
$task->{target
} : '-';
296 my $size_fmt = $successful ?
"%10s": "%8.2fMB";
298 "%-10s %-${namelength}s %-6s %10s $size_fmt %s\n",
302 format_time
($task->{backuptime
}),
309 $text_log_part .= "\nDetailed backup logs:\n\n";
310 $text_log_part .= "$cmdline\n\n";
312 $text_log_part .= $detail_pre . "\n" if defined($detail_pre);
313 foreach my $task (@$tasklist) {
314 my $vmid = $task->{vmid
};
315 my $log = $task->{tmplog
};
317 $text_log_part .= "$vmid: no log available\n\n";
320 if (open (my $TMP, '<', "$log")) {
321 while (my $line = <$TMP>) {
322 next if $line =~ /^status: \d+/; # not useful in mails
323 $text_log_part .= encode8bit
("$vmid: $line");
327 $text_log_part .= "$vmid: Could not open log file\n\n";
329 $text_log_part .= "\n";
331 $text_log_part .= $detail_post if defined($detail_post);
334 my $html = "<html><body>\n";
335 $html .= "<p>" . (escape_html
($err) =~ s/\n/<br>/gr) . "</p>\n" if $err;
336 $html .= "<table border=1 cellpadding=3>\n";
337 $html .= "<tr><td>VMID<td>NAME<td>STATUS<td>TIME<td>SIZE<td>FILENAME</tr>\n";
340 foreach my $task (@$tasklist) {
341 my $vmid = $task->{vmid
};
342 my $name = $task->{hostname
};
344 if ($task->{state} eq 'ok') {
345 $ssize += $task->{size
};
348 "<tr><td>%s<td>%s<td>OK<td>%s<td align=right>%s<td>%s</tr>\n",
351 format_time
($task->{backuptime
}),
352 format_size
($task->{size
}),
353 escape_html
($task->{target
}),
357 "<tr><td>%s<td>%s<td><font color=red>FAILED<td>%s<td colspan=2>%s</tr>\n",
360 format_time
($task->{backuptime
}),
361 escape_html
($task->{msg
}),
366 $html .= sprintf ("<tr><td align=left colspan=3>TOTAL<td>%s<td>%s<td></tr>",
367 format_time
($totaltime), format_size
($ssize));
369 $html .= "\n</table><br><br>\n";
371 $html_log_part .= "Detailed backup logs:<br /><br />\n";
372 $html_log_part .= "<pre>\n";
373 $html_log_part .= escape_html
($cmdline) . "\n\n";
375 $html_log_part .= escape_html
($detail_pre) . "\n" if defined($detail_pre);
376 foreach my $task (@$tasklist) {
377 my $vmid = $task->{vmid
};
378 my $log = $task->{tmplog
};
380 $html_log_part .= "$vmid: no log available\n\n";
383 if (open (my $TMP, '<', "$log")) {
384 while (my $line = <$TMP>) {
385 next if $line =~ /^status: \d+/; # not useful in mails
386 if ($line =~ m/^\S+\s\d+\s+\d+:\d+:\d+\s+(ERROR|WARN):/) {
387 $html_log_part .= encode8bit
("$vmid: <font color=red>".
388 escape_html
($line) . "</font>");
390 $html_log_part .= encode8bit
("$vmid: " . escape_html
($line));
395 $html_log_part .= "$vmid: Could not open log file\n\n";
397 $html_log_part .= "\n";
399 $html_log_part .= escape_html
($detail_post) if defined($detail_post);
400 $html_log_part .= "</pre>";
401 my $html_end = "\n</body></html>\n";
404 if (length($text) + length($text_log_part) +
405 length($html) + length($html_log_part) +
406 length($html_end) < MAX_MAIL_SIZE
)
408 $html .= $html_log_part;
410 $text .= $text_log_part;
412 my $msg = "Log output was too long to be sent by mail. ".
413 "See Task History for details!\n";
415 $html .= "<p>$msg</p>";
419 my $subject = "vzdump backup status ($hostname) : $stat";
421 my $dcconf = PVE
::Cluster
::cfs_read_file
('datacenter.cfg');
422 my $mailfrom = $dcconf->{email_from
} || "root";
424 PVE
::Tools
::sendmail
($mailto, $subject, $text, $html, $mailfrom, "vzdump backup tool");
428 my ($class, $cmdline, $opts, $skiplist) = @_;
434 check_bin
('sendmail');
438 check_bin
('umount');
439 check_bin
('cstream');
440 check_bin
('ionice');
442 if ($opts->{mode
} && $opts->{mode
} eq 'snapshot') {
443 check_bin
('lvcreate');
445 check_bin
('lvremove');
448 my $defaults = read_vzdump_defaults
();
450 foreach my $k (keys %$defaults) {
451 next if $k eq 'exclude-path' || $k eq 'prune-backups'; # dealt with separately
452 if ($k eq 'dumpdir' || $k eq 'storage') {
453 $opts->{$k} = $defaults->{$k} if !defined ($opts->{dumpdir
}) &&
454 !defined ($opts->{storage
});
456 $opts->{$k} = $defaults->{$k} if !defined ($opts->{$k});
460 $opts->{dumpdir
} =~ s
|/+$|| if ($opts->{dumpdir
});
461 $opts->{tmpdir
} =~ s
|/+$|| if ($opts->{tmpdir
});
463 $skiplist = [] if !$skiplist;
467 skiplist
=> $skiplist,
470 my $findexcl = $self->{findexcl
} = [];
471 if ($defaults->{'exclude-path'}) {
472 push @$findexcl, @{$defaults->{'exclude-path'}};
475 if ($opts->{'exclude-path'}) {
476 push @$findexcl, @{$opts->{'exclude-path'}};
479 if ($opts->{stdexcludes
}) {
487 foreach my $p (@plugins) {
488 my $pd = $p->new($self);
490 push @{$self->{plugins
}}, $pd;
493 if (defined($opts->{storage
}) && $opts->{stdout
}) {
494 die "cannot use options 'storage' and 'stdout' at the same time\n";
495 } elsif (defined($opts->{storage
}) && defined($opts->{dumpdir
})) {
496 die "cannot use options 'storage' and 'dumpdir' at the same time\n";
499 if (!$opts->{dumpdir
} && !$opts->{storage
}) {
500 $opts->{storage
} = 'local';
505 if ($opts->{storage
}) {
506 my $storage_cfg = PVE
::Storage
::config
();
507 eval { PVE
::Storage
::activate_storage
($storage_cfg, $opts->{storage
}) };
510 $errors .= "could not activate storage '$opts->{storage}': $err";
513 my $info = eval { storage_info
($opts->{storage
}) };
516 $errors .= "could not get storage information for '$opts->{storage}': $err";
518 $opts->{dumpdir
} = $info->{dumpdir
};
519 $opts->{scfg
} = $info->{scfg
};
520 $opts->{pbs
} = $info->{pbs
};
521 $opts->{'prune-backups'} //= $info->{'prune-backups'};
523 } elsif ($opts->{dumpdir
}) {
524 $errors .= "dumpdir '$opts->{dumpdir}' does not exist"
525 if ! -d
$opts->{dumpdir
};
527 die "internal error";
530 $opts->{'prune-backups'} //= $defaults->{'prune-backups'};
532 # avoid triggering any remove code path if keep-all is set
533 $opts->{remove
} = 0 if $opts->{'prune-backups'}->{'keep-all'};
535 if ($opts->{tmpdir
} && ! -d
$opts->{tmpdir
}) {
536 $errors .= "\n" if $errors;
537 $errors .= "tmpdir '$opts->{tmpdir}' does not exist";
541 eval { $self->sendmail([], 0, $errors); };
542 debugmsg
('err', $@) if $@;
552 # Note: df 'available' can be negative, and percentage set to '-'
554 my $cmd = [ 'df', '-P', '-T', '-B', '1', $dir];
560 if (my ($fsid, $fstype, undef, $mp) = $line =~
561 m!(\S+.*)\s+(\S+)\s+\d+\s+\-?\d+\s+\d+\s+(\d+%|-)\s+(/.*)$!) {
570 eval { PVE
::Tools
::run_command
($cmd, errfunc
=> sub {}, outfunc
=> $parser); };
577 my ($self, $upid) = @_;
581 my $maxwait = $self->{opts
}->{lockwait
} || $self->{lockwait
};
583 die "missing UPID" if !$upid; # should not happen
586 if (!open ($SERVER_FLCK, '>>', "$lockfile")) {
587 debugmsg
('err', "can't open lock on file '$lockfile' - $!", undef, 1);
588 die "can't open lock on file '$lockfile' - $!";
591 if (!flock ($SERVER_FLCK, LOCK_EX
|LOCK_NB
)) {
593 debugmsg
('err', "can't acquire lock '$lockfile' (wait = 0)", undef, 1);
594 die "can't acquire lock '$lockfile' (wait = 0)";
597 debugmsg
('info', "trying to get global lock - waiting...", undef, 1);
599 alarm ($maxwait * 60);
601 local $SIG{ALRM
} = sub { alarm (0); die "got timeout\n"; };
603 if (!flock ($SERVER_FLCK, LOCK_EX
)) {
605 close ($SERVER_FLCK);
616 debugmsg
('err', "can't acquire lock '$lockfile' - $err", undef, 1);
617 die "can't acquire lock '$lockfile' - $err";
620 debugmsg
('info', "got global lock", undef, 1);
623 PVE
::Tools
::file_set_contents
($pidfile, $upid);
626 sub run_hook_script
{
627 my ($self, $phase, $task, $logfd) = @_;
629 my $opts = $self->{opts
};
631 my $script = $opts->{script
};
635 die "The hook script '$script' is not executable.\n";
638 my $cmd = "$script $phase";
640 $cmd .= " $task->{mode} $task->{vmid}" if ($task);
643 # set immutable opts directly (so they are available in all phases)
644 $ENV{STOREID
} = $opts->{storage
} if $opts->{storage
};
645 $ENV{DUMPDIR
} = $opts->{dumpdir
} if $opts->{dumpdir
};
647 foreach my $ek (qw(vmtype hostname target logfile)) {
648 $ENV{uc($ek)} = $task->{$ek} if $task->{$ek};
650 # FIXME: for backwards compatibility - drop with PVE 7.0
651 $ENV{TARFILE
} = $task->{target
} if $task->{target
};
653 run_command
($logfd, $cmd);
656 sub compressor_info
{
658 my $opt_compress = $opts->{compress
};
660 if (!$opt_compress || $opt_compress eq '0') {
662 } elsif ($opt_compress eq '1' || $opt_compress eq 'lzo') {
663 return ('lzop', 'lzo');
664 } elsif ($opt_compress eq 'gzip') {
665 if ($opts->{pigz
} > 0) {
666 my $pigz_threads = $opts->{pigz
};
667 if ($pigz_threads == 1) {
668 my $cpuinfo = PVE
::ProcFSTools
::read_cpuinfo
();
669 $pigz_threads = int(($cpuinfo->{cpus
} + 1)/2);
671 return ("pigz -p ${pigz_threads} --rsyncable", 'gz');
673 return ('gzip --rsyncable', 'gz');
675 } elsif ($opt_compress eq 'zstd') {
676 my $zstd_threads = $opts->{zstd
} // 1;
677 if ($zstd_threads == 0) {
678 my $cpuinfo = PVE
::ProcFSTools
::read_cpuinfo
();
679 $zstd_threads = int(($cpuinfo->{cpus
} + 1)/2);
681 return ("zstd --rsyncable --threads=${zstd_threads}", 'zst');
683 die "internal error - unknown compression option '$opt_compress'";
687 sub get_backup_file_list
{
688 my ($dir, $bkname, $exclude_fn) = @_;
691 foreach my $fn (<$dir/${bkname
}-*>) {
692 next if $exclude_fn && $fn eq $exclude_fn;
694 my $archive_info = eval { PVE
::Storage
::archive_info
($fn) } // {};
695 if ($archive_info->{is_std_name
}) {
696 my $filename = $archive_info->{filename
};
698 'path' => "$dir/$filename",
699 'ctime' => $archive_info->{ctime
},
701 push @{$bklist}, $backup;
708 sub exec_backup_task
{
709 my ($self, $task) = @_;
711 my $opts = $self->{opts
};
713 my $cfg = PVE
::Storage
::config
();
714 my $vmid = $task->{vmid
};
715 my $plugin = $task->{plugin
};
717 $task->{backup_time
} = time();
720 my $pbs_snapshot_name;
722 my $vmstarttime = time ();
728 my $log_vm_online_again = sub {
729 return if !defined($task->{vmstoptime
});
730 $task->{vmconttime
} //= time();
731 my $delay = $task->{vmconttime
} - $task->{vmstoptime
};
732 $delay = '<1' if $delay < 1;
733 debugmsg
('info', "guest is online again after $delay seconds", $logfd);
737 die "unable to find VM '$vmid'\n" if !$plugin;
739 my $vmtype = $plugin->type();
741 if ($self->{opts
}->{pbs
}) {
742 if ($vmtype eq 'lxc') {
743 $pbs_group_name = "ct/$vmid";
744 } elsif ($vmtype eq 'qemu') {
745 $pbs_group_name = "vm/$vmid";
747 die "pbs backup not implemented for plugin type '$vmtype'\n";
749 my $btime = strftime
("%FT%TZ", gmtime($task->{backup_time
}));
750 $pbs_snapshot_name = "$pbs_group_name/$btime";
753 # for now we deny backups of a running ha managed service in *stop* mode
754 # as it interferes with the HA stack (started services should not stop).
755 if ($opts->{mode
} eq 'stop' &&
756 PVE
::HA
::Config
::vm_is_ha_managed
($vmid, 'started'))
758 die "Cannot execute a backup with stop mode on a HA managed and".
759 " enabled Service. Use snapshot mode or disable the Service.\n";
762 my $tmplog = "$logdir/$vmtype-$vmid.log";
764 my $bkname = "vzdump-$vmtype-$vmid";
765 my $basename = $bkname . strftime
("-%Y_%m_%d-%H_%M_%S", localtime($task->{backup_time
}));
767 my $prune_options = $opts->{'prune-backups'};
769 my $backup_limit = 0;
770 if (!$prune_options->{'keep-all'}) {
771 foreach my $keep (values %{$prune_options}) {
772 $backup_limit += $keep;
776 if ($backup_limit && !$opts->{remove
}) {
778 if ($self->{opts
}->{pbs
}) {
779 my $res = PVE
::Storage
::PBSPlugin
::run_client_cmd
($opts->{scfg
}, $opts->{storage
}, 'snapshots', $pbs_group_name);
780 $count = scalar(@$res);
782 my $bklist = get_backup_file_list
($opts->{dumpdir
}, $bkname);
783 $count = scalar(@$bklist);
785 die "There is a max backup limit of $backup_limit enforced by the".
786 " target storage or the vzdump parameters.".
787 " Either increase the limit or delete old backup(s).\n"
788 if $count >= $backup_limit;
791 if (!$self->{opts
}->{pbs
}) {
792 $task->{logfile
} = "$opts->{dumpdir}/$basename.log";
795 my $ext = $vmtype eq 'qemu' ?
'.vma' : '.tar';
796 my ($comp, $comp_ext) = compressor_info
($opts);
797 if ($comp && $comp_ext) {
798 $ext .= ".${comp_ext}";
801 if ($self->{opts
}->{pbs
}) {
802 die "unable to pipe backup to stdout\n" if $opts->{stdout
};
803 $task->{target
} = $pbs_snapshot_name;
805 if ($opts->{stdout
}) {
806 $task->{target
} = '-';
808 $task->{target
} = $task->{tmptar
} = "$opts->{dumpdir}/$basename$ext";
809 $task->{tmptar
} =~ s/\.[^\.]+$/\.dat/;
810 unlink $task->{tmptar
};
814 $task->{vmtype
} = $vmtype;
817 if ($opts->{tmpdir
}) {
818 $task->{tmpdir
} = "$opts->{tmpdir}/vzdumptmp${pid}_$vmid/";
819 } elsif ($self->{opts
}->{pbs
}) {
820 $task->{tmpdir
} = "/var/tmp/vzdumptmp${pid}_$vmid";
822 # dumpdir is posix? then use it as temporary dir
823 my $info = get_mount_info
($opts->{dumpdir
});
824 if ($vmtype eq 'qemu' ||
825 grep ($_ eq $info->{fstype
}, @posix_filesystems)) {
826 $task->{tmpdir
} = "$opts->{dumpdir}/$basename.tmp";
828 $task->{tmpdir
} = "/var/tmp/vzdumptmp${pid}_$vmid";
829 debugmsg
('info', "filesystem type on dumpdir is '$info->{fstype}' -" .
830 "using $task->{tmpdir} for temporary files", $logfd);
834 rmtree
$task->{tmpdir
};
835 mkdir $task->{tmpdir
};
836 -d
$task->{tmpdir
} ||
837 die "unable to create temporary directory '$task->{tmpdir}'";
839 $logfd = IO
::File-
>new (">$tmplog") ||
840 die "unable to create log file '$tmplog'";
842 $task->{dumpdir
} = $opts->{dumpdir
};
843 $task->{storeid
} = $opts->{storage
};
844 $task->{scfg
} = $opts->{scfg
};
845 $task->{tmplog
} = $tmplog;
847 unlink $task->{logfile
} if defined($task->{logfile
});
849 debugmsg
('info', "Starting Backup of VM $vmid ($vmtype)", $logfd, 1);
850 debugmsg
('info', "Backup started at " . strftime
("%F %H:%M:%S", localtime()));
852 $plugin->set_logfd ($logfd);
854 # test is VM is running
855 my ($running, $status_text) = $plugin->vm_status ($vmid);
857 debugmsg
('info', "status = ${status_text}", $logfd);
859 # lock VM (prevent config changes)
860 $plugin->lock_vm ($vmid);
862 $cleanup->{unlock
} = 1;
866 my $mode = $running ?
$task->{mode
} : 'stop';
868 if ($mode eq 'snapshot') {
869 my %saved_task = %$task;
870 eval { $plugin->prepare ($task, $vmid, $mode); };
872 die $err if $err !~ m/^mode failure/;
873 debugmsg
('info', $err, $logfd);
874 debugmsg
('info', "trying 'suspend' mode instead", $logfd);
875 $mode = 'suspend'; # so prepare is called again below
876 %$task = %saved_task;
880 $cleanup->{prepared
} = 1;
882 $task->{mode
} = $mode;
884 debugmsg
('info', "backup mode: $mode", $logfd);
886 debugmsg
('info', "bandwidth limit: $opts->{bwlimit} KB/s", $logfd)
889 debugmsg
('info', "ionice priority: $opts->{ionice}", $logfd);
891 if ($mode eq 'stop') {
893 $plugin->prepare ($task, $vmid, $mode);
895 $self->run_hook_script ('backup-start', $task, $logfd);
898 debugmsg
('info', "stopping vm", $logfd);
899 $task->{vmstoptime
} = time();
900 $self->run_hook_script ('pre-stop', $task, $logfd);
901 $plugin->stop_vm ($task, $vmid);
902 $cleanup->{restart
} = 1;
906 } elsif ($mode eq 'suspend') {
908 $plugin->prepare ($task, $vmid, $mode);
910 $self->run_hook_script ('backup-start', $task, $logfd);
912 if ($vmtype eq 'lxc') {
914 $plugin->copy_data_phase1($task, $vmid);
917 debugmsg
('info', "suspending guest", $logfd);
918 $task->{vmstoptime
} = time ();
919 $self->run_hook_script ('pre-stop', $task, $logfd);
920 $plugin->suspend_vm ($task, $vmid);
921 $cleanup->{resume
} = 1;
923 if ($vmtype eq 'lxc') {
925 $plugin->copy_data_phase2($task, $vmid);
927 debugmsg
('info', "resuming guest", $logfd);
928 $cleanup->{resume
} = 0;
929 $self->run_hook_script('pre-restart', $task, $logfd);
930 $plugin->resume_vm($task, $vmid);
931 $self->run_hook_script('post-restart', $task, $logfd);
932 $log_vm_online_again->();
935 } elsif ($mode eq 'snapshot') {
937 $self->run_hook_script ('backup-start', $task, $logfd);
939 my $snapshot_count = $task->{snapshot_count
} || 0;
941 $self->run_hook_script ('pre-stop', $task, $logfd);
943 if ($snapshot_count > 1) {
944 debugmsg
('info', "suspend vm to make snapshot", $logfd);
945 $task->{vmstoptime
} = time ();
946 $plugin->suspend_vm ($task, $vmid);
947 $cleanup->{resume
} = 1;
950 $plugin->snapshot ($task, $vmid);
952 $self->run_hook_script ('pre-restart', $task, $logfd);
954 if ($snapshot_count > 1) {
955 debugmsg
('info', "resume vm", $logfd);
956 $cleanup->{resume
} = 0;
957 $plugin->resume_vm ($task, $vmid);
958 $log_vm_online_again->();
961 $self->run_hook_script ('post-restart', $task, $logfd);
964 die "internal error - unknown mode '$mode'\n";
967 # assemble archive image
968 $plugin->assemble ($task, $vmid);
972 if ($opts->{stdout
}) {
973 debugmsg
('info', "sending archive to stdout", $logfd);
974 $plugin->archive($task, $vmid, $task->{tmptar
}, $comp);
975 $self->run_hook_script ('backup-end', $task, $logfd);
979 my $archive_txt = $self->{opts
}->{pbs
} ?
'Proxmox Backup Server' : 'vzdump';
980 debugmsg
('info', "creating $archive_txt archive '$task->{target}'", $logfd);
981 $plugin->archive($task, $vmid, $task->{tmptar
}, $comp);
983 if ($self->{opts
}->{pbs
}) {
984 # size is added to task struct in guest vzdump plugins
986 rename ($task->{tmptar
}, $task->{target
}) ||
987 die "unable to rename '$task->{tmptar}' to '$task->{target}'\n";
990 $task->{size
} = (-s
$task->{target
}) || 0;
991 my $cs = format_size
($task->{size
});
992 debugmsg
('info', "archive file size: $cs", $logfd);
996 if ($opts->{remove
}) {
997 if (!defined($opts->{storage
})) {
998 my $bklist = get_backup_file_list
($opts->{dumpdir
}, $bkname, $task->{target
});
999 PVE
::Storage
::prune_mark_backup_group
($bklist, $prune_options);
1001 foreach my $prune_entry (@{$bklist}) {
1002 next if $prune_entry->{mark
} ne 'remove';
1004 my $archive_path = $prune_entry->{path
};
1005 debugmsg
('info', "delete old backup '$archive_path'", $logfd);
1006 PVE
::Storage
::archive_remove
($archive_path);
1009 my $logfunc = sub { debugmsg
($_[0], $_[1], $logfd) };
1010 PVE
::Storage
::prune_backups
($cfg, $opts->{storage
}, $prune_options, $vmid, $vmtype, 0, $logfunc);
1014 $self->run_hook_script ('backup-end', $task, $logfd);
1021 if ($cleanup->{unlock
}) {
1022 eval { $plugin->unlock_vm ($vmid); };
1026 if ($cleanup->{prepared
}) {
1027 # only call cleanup when necessary (when prepare was executed)
1028 eval { $plugin->cleanup ($task, $vmid) };
1032 eval { $plugin->set_logfd (undef); };
1035 if ($cleanup->{resume
} || $cleanup->{restart
}) {
1037 $self->run_hook_script ('pre-restart', $task, $logfd);
1038 if ($cleanup->{resume
}) {
1039 debugmsg
('info', "resume vm", $logfd);
1040 $plugin->resume_vm ($task, $vmid);
1042 my $running = $plugin->vm_status($vmid);
1044 debugmsg
('info', "restarting vm", $logfd);
1045 $plugin->start_vm ($task, $vmid);
1048 $self->run_hook_script ('post-restart', $task, $logfd);
1054 $log_vm_online_again->();
1059 eval { unlink $task->{tmptar
} if $task->{tmptar
} && -f
$task->{tmptar
}; };
1062 eval { rmtree
$task->{tmpdir
} if $task->{tmpdir
} && -d
$task->{tmpdir
}; };
1065 my $delay = $task->{backuptime
} = time () - $vmstarttime;
1068 $task->{state} = 'err';
1069 $task->{msg
} = $err;
1070 debugmsg
('err', "Backup of VM $vmid failed - $err", $logfd, 1);
1071 debugmsg
('info', "Failed at " . strftime
("%F %H:%M:%S", localtime()));
1073 eval { $self->run_hook_script ('backup-abort', $task, $logfd); };
1076 $task->{state} = 'ok';
1077 my $tstr = format_time
($delay);
1078 debugmsg
('info', "Finished Backup of VM $vmid ($tstr)", $logfd, 1);
1079 debugmsg
('info', "Backup finished at " . strftime
("%F %H:%M:%S", localtime()));
1082 close ($logfd) if $logfd;
1084 if ($task->{tmplog
}) {
1085 if ($self->{opts
}->{pbs
}) {
1086 if ($task->{state} eq 'ok') {
1088 PVE
::Storage
::PBSPlugin
::run_raw_client_cmd
(
1092 [ $pbs_snapshot_name, $task->{tmplog
} ],
1093 errmsg
=> "uploading backup task log failed",
1096 debugmsg
('warn', "$@") if $@; # $@ contains already error prefix
1098 } elsif ($task->{logfile
}) {
1099 system {'cp'} 'cp', $task->{tmplog
}, $task->{logfile
};
1103 eval { $self->run_hook_script ('log-end', $task); };
1105 die $err if $err && $err =~ m/^interrupted by signal$/;
1109 my ($self, $rpcenv, $authuser) = @_;
1111 my $opts = $self->{opts
};
1113 debugmsg
('info', "starting new backup job: $self->{cmdline}", undef, 1);
1115 if (scalar(@{$self->{skiplist
}})) {
1116 my $skip_string = join(', ', sort { $a <=> $b } @{$self->{skiplist
}});
1117 debugmsg
('info', "skip external VMs: $skip_string");
1121 my $vzdump_plugins = {};
1122 foreach my $plugin (@{$self->{plugins
}}) {
1123 my $type = $plugin->type();
1124 next if exists $vzdump_plugins->{$type};
1125 $vzdump_plugins->{$type} = $plugin;
1128 my $vmlist = PVE
::Cluster
::get_vmlist
();
1129 my $vmids = [ sort { $a <=> $b } @{$opts->{vmids
}} ];
1130 foreach my $vmid (@{$vmids}) {
1132 if (defined($vmlist->{ids
}->{$vmid})) {
1133 my $guest_type = $vmlist->{ids
}->{$vmid}->{type
};
1134 $plugin = $vzdump_plugins->{$guest_type};
1135 next if !$rpcenv->check($authuser, "/vms/$vmid", [ 'VM.Backup' ], $opts->{all
});
1138 mode
=> $opts->{mode
},
1145 # Use in-memory files for the outer hook logs to pass them to sendmail.
1146 my $job_start_log = '';
1147 my $job_end_log = '';
1148 open my $job_start_fd, '>', \
$job_start_log;
1149 open my $job_end_fd, '>', \
$job_end_log;
1151 my $starttime = time();
1155 $self->run_hook_script ('job-start', undef, $job_start_fd);
1157 foreach my $task (@$tasklist) {
1158 $self->exec_backup_task ($task);
1159 $errcount += 1 if $task->{state} ne 'ok';
1162 $self->run_hook_script ('job-end', undef, $job_end_fd);
1166 $self->run_hook_script ('job-abort', undef, $job_end_fd) if $err;
1169 debugmsg
('err', "Backup job failed - $err", undef, 1);
1172 debugmsg
('info', "Backup job finished with errors", undef, 1);
1174 debugmsg
('info', "Backup job finished successfully", undef, 1);
1178 close $job_start_fd;
1181 my $totaltime = time() - $starttime;
1183 eval { $self->sendmail ($tasklist, $totaltime, undef, $job_start_log, $job_end_log); };
1184 debugmsg
('err', $@) if $@;
1188 die "job errors\n" if $errcount;
1196 return defined($confdesc->{$key});
1199 # NOTE it might make sense to merge this and verify_vzdump_parameters(), but one
1200 # needs to adapt command_line() in guest-common's PVE/VZDump/Common.pm and detect
1201 # a second parsing attempt, because verify_vzdump_parameters() is called twice
1202 # during the update_job API call.
1203 sub parse_mailto_exclude_path
{
1206 # exclude-path list need to be 0 separated
1207 if (defined($param->{'exclude-path'})) {
1208 my @expaths = split(/\0/, $param->{'exclude-path'} || '');
1209 $param->{'exclude-path'} = [ @expaths ];
1212 if (defined($param->{mailto
})) {
1213 my @mailto = PVE
::Tools
::split_list
(extract_param
($param, 'mailto'));
1214 $param->{mailto
} = [ @mailto ];
1220 sub verify_vzdump_parameters
{
1221 my ($param, $check_missing) = @_;
1223 raise_param_exc
({ all
=> "option conflicts with option 'vmid'"})
1224 if $param->{all
} && $param->{vmid
};
1226 raise_param_exc
({ exclude
=> "option conflicts with option 'vmid'"})
1227 if $param->{exclude
} && $param->{vmid
};
1229 raise_param_exc
({ pool
=> "option conflicts with option 'vmid'"})
1230 if $param->{pool
} && $param->{vmid
};
1232 raise_param_exc
({ 'prune-backups' => "option conflicts with option 'maxfiles'"})
1233 if defined($param->{'prune-backups'}) && defined($param->{maxfiles
});
1235 $parse_prune_backups_maxfiles->($param, 'CLI parameters');
1237 $param->{all
} = 1 if (defined($param->{exclude
}) && !$param->{pool
});
1239 warn "option 'size' is deprecated and will be removed in a future " .
1240 "release, please update your script/configuration!\n"
1241 if defined($param->{size
});
1243 return if !$check_missing;
1245 raise_param_exc
({ vmid
=> "property is missing"})
1246 if !($param->{all
} || $param->{stop
} || $param->{pool
}) && !$param->{vmid
};
1250 sub stop_running_backups
{
1253 my $upid = PVE
::Tools
::file_read_firstline
($pidfile);
1256 my $task = PVE
::Tools
::upid_decode
($upid);
1258 if (PVE
::ProcFSTools
::check_process_running
($task->{pid
}, $task->{pstart
}) &&
1259 PVE
::ProcFSTools
::read_proc_starttime
($task->{pid
}) == $task->{pstart
}) {
1260 kill(15, $task->{pid
});
1261 # wait max 15 seconds to shut down (else, do nothing for now)
1263 for ($i = 15; $i > 0; $i--) {
1264 last if !PVE
::ProcFSTools
::check_process_running
(($task->{pid
}, $task->{pstart
}));
1267 die "stopping backup process $task->{pid} failed\n" if $i == 0;
1271 sub get_included_guests
{
1275 my $vmids_per_node = {};
1277 my $vmlist = PVE
::Cluster
::get_vmlist
();
1280 $vmids = PVE
::API2Tools
::get_resource_pool_guest_members
($job->{pool
});
1281 } elsif ($job->{vmid
}) {
1282 $vmids = [ split_list
($job->{vmid
}) ];
1283 } elsif ($job->{all
}) {
1285 my $exclude = check_vmids
(split_list
($job->{exclude
}));
1286 my $excludehash = { map { $_ => 1 } @$exclude };
1288 for my $id (keys %{$vmlist->{ids
}}) {
1289 next if $excludehash->{$id};
1293 return $vmids_per_node;
1295 $vmids = check_vmids
(@$vmids);
1297 for my $vmid (@$vmids) {
1298 if (defined($vmlist->{ids
}->{$vmid})) {
1299 my $node = $vmlist->{ids
}->{$vmid}->{node
};
1300 next if (defined $job->{node
} && $job->{node
} ne $node);
1302 push @{$vmids_per_node->{$node}}, $vmid;
1304 push @{$vmids_per_node->{''}}, $vmid;
1308 return $vmids_per_node;