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 '$storage' for backups - wrong content type\n"
104 if (!$scfg->{content
}->{backup
});
110 $info->{'prune-backups'} = PVE
::JSONSchema
::parse_property_string
('prune-backups', $scfg->{'prune-backups'})
111 if defined($scfg->{'prune-backups'});
113 if ($type eq 'pbs') {
116 $info->{dumpdir
} = PVE
::Storage
::get_backup_dir
($cfg, $storage);
125 my $kb = $size / 1024;
128 return int ($kb) . "KB";
131 my $mb = $size / (1024*1024);
133 return int ($mb) . "MB";
137 return sprintf ("%.2fGB", $gb);
140 return sprintf ("%.2fTB", $tb);
146 my $hours = int ($seconds/3600);
147 $seconds = $seconds - $hours*3600;
148 my $min = int ($seconds/60);
149 $seconds = $seconds - $min*60;
151 return sprintf ("%02d:%02d:%02d", $hours, $min, $seconds);
157 $str =~ s/^(.{990})/$1\n/mg; # reduce line length
175 foreach my $p (split (/:/, $ENV{PATH
})) {
182 die "unable to find command '$bin'\n";
189 for my $vmid (sort {$a <=> $b} @vmids) {
190 die "ERROR: strange VM ID '${vmid}'\n" if $vmid !~ m/^\d+$/;
191 $vmid = int ($vmid); # remove leading zeros
200 sub read_vzdump_defaults
{
202 my $fn = "/etc/vzdump.conf";
206 my $default = $confdesc->{$_}->{default};
207 defined($default) ?
($_ => $default) : ()
210 $parse_prune_backups_maxfiles->($defaults, "defaults in VZDump schema");
213 eval { $raw = PVE
::Tools
::file_get_contents
($fn); };
214 return $defaults if $@;
216 my $conf_schema = { type
=> 'object', properties
=> $confdesc, };
217 my $res = PVE
::JSONSchema
::parse_config
($conf_schema, $fn, $raw);
218 if (my $excludes = $res->{'exclude-path'}) {
219 $res->{'exclude-path'} = PVE
::Tools
::split_args
($excludes);
221 if (defined($res->{mailto
})) {
222 my @mailto = split_list
($res->{mailto
});
223 $res->{mailto
} = [ @mailto ];
225 $parse_prune_backups_maxfiles->($res, "options in '$fn'");
227 foreach my $key (keys %$defaults) {
228 $res->{$key} = $defaults->{$key} if !defined($res->{$key});
231 if (defined($res->{storage
}) && defined($res->{dumpdir
})) {
232 debugmsg
('warn', "both 'storage' and 'dumpdir' defined in '$fn' - ignoring 'dumpdir'");
233 delete $res->{dumpdir
};
239 use constant MAX_MAIL_SIZE
=> 1024*1024;
241 my ($self, $tasklist, $totaltime, $err, $detail_pre, $detail_post) = @_;
243 my $opts = $self->{opts
};
245 my $mailto = $opts->{mailto
};
247 return if !($mailto && scalar(@$mailto));
249 my $cmdline = $self->{cmdline
};
252 foreach my $task (@$tasklist) {
253 $ecount++ if $task->{state} ne 'ok';
254 chomp $task->{msg
} if $task->{msg
};
255 $task->{backuptime
} = 0 if !$task->{backuptime
};
256 $task->{size
} = 0 if !$task->{size
};
257 $task->{target
} = 'unknown' if !$task->{target
};
258 $task->{hostname
} = "VM $task->{vmid}" if !$task->{hostname
};
260 if ($task->{state} eq 'todo') {
261 $task->{msg
} = 'aborted';
265 my $notify = $opts->{mailnotification
} || 'always';
266 return if (!$ecount && !$err && ($notify eq 'failure'));
268 my $stat = ($ecount || $err) ?
'backup failed' : 'backup successful';
271 $stat .= ": multiple problems";
278 my $hostname = `hostname -f` || PVE
::INotify
::nodename
();
282 my $text = $err ?
"$err\n\n" : '';
285 "%-10s %-${namelength}s %-6s %10s %10s %s\n",
286 qw(VMID NAME STATUS TIME SIZE FILENAME)
288 foreach my $task (@$tasklist) {
289 my $name = substr($task->{hostname
}, 0, $namelength);
290 my $successful = $task->{state} eq 'ok';
291 my $size = $successful ? format_size
($task->{size
}) : 0;
292 my $filename = $successful ?
$task->{target
} : '-';
293 my $size_fmt = $successful ?
"%10s": "%8.2fMB";
295 "%-10s %-${namelength}s %-6s %10s $size_fmt %s\n",
299 format_time
($task->{backuptime
}),
306 $text_log_part .= "\nDetailed backup logs:\n\n";
307 $text_log_part .= "$cmdline\n\n";
309 $text_log_part .= $detail_pre . "\n" if defined($detail_pre);
310 foreach my $task (@$tasklist) {
311 my $vmid = $task->{vmid
};
312 my $log = $task->{tmplog
};
314 $text_log_part .= "$vmid: no log available\n\n";
317 if (open (my $TMP, '<', "$log")) {
318 while (my $line = <$TMP>) {
319 next if $line =~ /^status: \d+/; # not useful in mails
320 $text_log_part .= encode8bit
("$vmid: $line");
324 $text_log_part .= "$vmid: Could not open log file\n\n";
326 $text_log_part .= "\n";
328 $text_log_part .= $detail_post if defined($detail_post);
331 my $html = "<html><body>\n";
332 $html .= "<p>" . (escape_html
($err) =~ s/\n/<br>/gr) . "</p>\n" if $err;
333 $html .= "<table border=1 cellpadding=3>\n";
334 $html .= "<tr><td>VMID<td>NAME<td>STATUS<td>TIME<td>SIZE<td>FILENAME</tr>\n";
337 foreach my $task (@$tasklist) {
338 my $vmid = $task->{vmid
};
339 my $name = $task->{hostname
};
341 if ($task->{state} eq 'ok') {
342 $ssize += $task->{size
};
345 "<tr><td>%s<td>%s<td>OK<td>%s<td align=right>%s<td>%s</tr>\n",
348 format_time
($task->{backuptime
}),
349 format_size
($task->{size
}),
350 escape_html
($task->{target
}),
354 "<tr><td>%s<td>%s<td><font color=red>FAILED<td>%s<td colspan=2>%s</tr>\n",
357 format_time
($task->{backuptime
}),
358 escape_html
($task->{msg
}),
363 $html .= sprintf ("<tr><td align=left colspan=3>TOTAL<td>%s<td>%s<td></tr>",
364 format_time
($totaltime), format_size
($ssize));
366 $html .= "\n</table><br><br>\n";
368 $html_log_part .= "Detailed backup logs:<br /><br />\n";
369 $html_log_part .= "<pre>\n";
370 $html_log_part .= escape_html
($cmdline) . "\n\n";
372 $html_log_part .= escape_html
($detail_pre) . "\n" if defined($detail_pre);
373 foreach my $task (@$tasklist) {
374 my $vmid = $task->{vmid
};
375 my $log = $task->{tmplog
};
377 $html_log_part .= "$vmid: no log available\n\n";
380 if (open (my $TMP, '<', "$log")) {
381 while (my $line = <$TMP>) {
382 next if $line =~ /^status: \d+/; # not useful in mails
383 if ($line =~ m/^\S+\s\d+\s+\d+:\d+:\d+\s+(ERROR|WARN):/) {
384 $html_log_part .= encode8bit
("$vmid: <font color=red>".
385 escape_html
($line) . "</font>");
387 $html_log_part .= encode8bit
("$vmid: " . escape_html
($line));
392 $html_log_part .= "$vmid: Could not open log file\n\n";
394 $html_log_part .= "\n";
396 $html_log_part .= escape_html
($detail_post) if defined($detail_post);
397 $html_log_part .= "</pre>";
398 my $html_end = "\n</body></html>\n";
401 if (length($text) + length($text_log_part) +
402 length($html) + length($html_log_part) +
403 length($html_end) < MAX_MAIL_SIZE
)
405 $html .= $html_log_part;
407 $text .= $text_log_part;
409 my $msg = "Log output was too long to be sent by mail. ".
410 "See Task History for details!\n";
412 $html .= "<p>$msg</p>";
416 my $subject = "vzdump backup status ($hostname) : $stat";
418 my $dcconf = PVE
::Cluster
::cfs_read_file
('datacenter.cfg');
419 my $mailfrom = $dcconf->{email_from
} || "root";
421 PVE
::Tools
::sendmail
($mailto, $subject, $text, $html, $mailfrom, "vzdump backup tool");
425 my ($class, $cmdline, $opts, $skiplist) = @_;
431 check_bin
('sendmail');
435 check_bin
('umount');
436 check_bin
('cstream');
437 check_bin
('ionice');
439 if ($opts->{mode
} && $opts->{mode
} eq 'snapshot') {
440 check_bin
('lvcreate');
442 check_bin
('lvremove');
445 my $defaults = read_vzdump_defaults
();
447 foreach my $k (keys %$defaults) {
448 next if $k eq 'exclude-path' || $k eq 'prune-backups'; # dealt with separately
449 if ($k eq 'dumpdir' || $k eq 'storage') {
450 $opts->{$k} = $defaults->{$k} if !defined ($opts->{dumpdir
}) &&
451 !defined ($opts->{storage
});
453 $opts->{$k} = $defaults->{$k} if !defined ($opts->{$k});
457 $opts->{dumpdir
} =~ s
|/+$|| if ($opts->{dumpdir
});
458 $opts->{tmpdir
} =~ s
|/+$|| if ($opts->{tmpdir
});
460 $skiplist = [] if !$skiplist;
464 skiplist
=> $skiplist,
467 my $findexcl = $self->{findexcl
} = [];
468 if ($defaults->{'exclude-path'}) {
469 push @$findexcl, @{$defaults->{'exclude-path'}};
472 if ($opts->{'exclude-path'}) {
473 push @$findexcl, @{$opts->{'exclude-path'}};
476 if ($opts->{stdexcludes
}) {
484 foreach my $p (@plugins) {
485 my $pd = $p->new($self);
487 push @{$self->{plugins
}}, $pd;
490 if (defined($opts->{storage
}) && $opts->{stdout
}) {
491 die "cannot use options 'storage' and 'stdout' at the same time\n";
492 } elsif (defined($opts->{storage
}) && defined($opts->{dumpdir
})) {
493 die "cannot use options 'storage' and 'dumpdir' at the same time\n";
496 if (!$opts->{dumpdir
} && !$opts->{storage
}) {
497 $opts->{storage
} = 'local';
500 $self->{job_init_log
} = '';
501 open my $job_init_fd, '>', \
$self->{job_init_log
};
502 $self->run_hook_script('job-init', undef, $job_init_fd);
505 PVE
::Cluster
::cfs_update
(); # Pick up possible changes made by the hook script.
509 if ($opts->{storage
}) {
510 my $storage_cfg = PVE
::Storage
::config
();
511 eval { PVE
::Storage
::activate_storage
($storage_cfg, $opts->{storage
}) };
514 $errors .= "could not activate storage '$opts->{storage}': $err";
517 my $info = eval { storage_info
($opts->{storage
}) };
520 $errors .= "could not get storage information for '$opts->{storage}': $err";
522 $opts->{dumpdir
} = $info->{dumpdir
};
523 $opts->{scfg
} = $info->{scfg
};
524 $opts->{pbs
} = $info->{pbs
};
525 $opts->{'prune-backups'} //= $info->{'prune-backups'};
527 } elsif ($opts->{dumpdir
}) {
528 $errors .= "dumpdir '$opts->{dumpdir}' does not exist"
529 if ! -d
$opts->{dumpdir
};
531 die "internal error";
534 $opts->{'prune-backups'} //= $defaults->{'prune-backups'};
536 # avoid triggering any remove code path if keep-all is set
537 $opts->{remove
} = 0 if $opts->{'prune-backups'}->{'keep-all'};
539 if ($opts->{tmpdir
} && ! -d
$opts->{tmpdir
}) {
540 $errors .= "\n" if $errors;
541 $errors .= "tmpdir '$opts->{tmpdir}' does not exist";
545 eval { $self->sendmail([], 0, $errors); };
546 debugmsg
('err', $@) if $@;
556 # Note: df 'available' can be negative, and percentage set to '-'
558 my $cmd = [ 'df', '-P', '-T', '-B', '1', $dir];
564 if (my ($fsid, $fstype, undef, $mp) = $line =~
565 m!(\S+.*)\s+(\S+)\s+\d+\s+\-?\d+\s+\d+\s+(\d+%|-)\s+(/.*)$!) {
574 eval { PVE
::Tools
::run_command
($cmd, errfunc
=> sub {}, outfunc
=> $parser); };
581 my ($self, $upid) = @_;
585 my $maxwait = $self->{opts
}->{lockwait
} || $self->{lockwait
};
587 die "missing UPID" if !$upid; # should not happen
590 if (!open ($SERVER_FLCK, '>>', "$lockfile")) {
591 debugmsg
('err', "can't open lock on file '$lockfile' - $!", undef, 1);
592 die "can't open lock on file '$lockfile' - $!";
595 if (!flock ($SERVER_FLCK, LOCK_EX
|LOCK_NB
)) {
597 debugmsg
('err', "can't acquire lock '$lockfile' (wait = 0)", undef, 1);
598 die "can't acquire lock '$lockfile' (wait = 0)";
601 debugmsg
('info', "trying to get global lock - waiting...", undef, 1);
603 alarm ($maxwait * 60);
605 local $SIG{ALRM
} = sub { alarm (0); die "got timeout\n"; };
607 if (!flock ($SERVER_FLCK, LOCK_EX
)) {
609 close ($SERVER_FLCK);
620 debugmsg
('err', "can't acquire lock '$lockfile' - $err", undef, 1);
621 die "can't acquire lock '$lockfile' - $err";
624 debugmsg
('info', "got global lock", undef, 1);
627 PVE
::Tools
::file_set_contents
($pidfile, $upid);
632 sub run_hook_script
{
633 my ($self, $phase, $task, $logfd) = @_;
635 my $opts = $self->{opts
};
637 my $script = $opts->{script
};
641 die "The hook script '$script' is not executable.\n";
644 my $cmd = [$script, $phase];
647 push @$cmd, $task->{mode
};
648 push @$cmd, $task->{vmid
};
652 # set immutable opts directly (so they are available in all phases)
653 $ENV{STOREID
} = $opts->{storage
} if $opts->{storage
};
654 $ENV{DUMPDIR
} = $opts->{dumpdir
} if $opts->{dumpdir
};
656 foreach my $ek (qw(vmtype hostname target logfile)) {
657 $ENV{uc($ek)} = $task->{$ek} if $task->{$ek};
660 run_command
($logfd, $cmd);
663 sub compressor_info
{
665 my $opt_compress = $opts->{compress
};
667 if (!$opt_compress || $opt_compress eq '0') {
669 } elsif ($opt_compress eq '1' || $opt_compress eq 'lzo') {
670 return ('lzop', 'lzo');
671 } elsif ($opt_compress eq 'gzip') {
672 if ($opts->{pigz
} > 0) {
673 my $pigz_threads = $opts->{pigz
};
674 if ($pigz_threads == 1) {
675 my $cpuinfo = PVE
::ProcFSTools
::read_cpuinfo
();
676 $pigz_threads = int(($cpuinfo->{cpus
} + 1)/2);
678 return ("pigz -p ${pigz_threads} --rsyncable", 'gz');
680 return ('gzip --rsyncable', 'gz');
682 } elsif ($opt_compress eq 'zstd') {
683 my $zstd_threads = $opts->{zstd
} // 1;
684 if ($zstd_threads == 0) {
685 my $cpuinfo = PVE
::ProcFSTools
::read_cpuinfo
();
686 $zstd_threads = int(($cpuinfo->{cpus
} + 1)/2);
688 return ("zstd --rsyncable --threads=${zstd_threads}", 'zst');
690 die "internal error - unknown compression option '$opt_compress'";
694 sub get_unprotected_backup_file_list
{
695 my ($dir, $bkname) = @_;
698 foreach my $fn (<$dir/${bkname
}-*>) {
699 my $archive_info = eval { PVE
::Storage
::archive_info
($fn) } // {};
700 if ($archive_info->{is_std_name
}) {
701 my $path = "$dir/$archive_info->{filename}";
702 next if -e PVE
::Storage
::protection_file_path
($path);
705 'ctime' => $archive_info->{ctime
},
707 push @{$bklist}, $backup;
714 sub exec_backup_task
{
715 my ($self, $task) = @_;
717 my $opts = $self->{opts
};
719 my $cfg = PVE
::Storage
::config
();
720 my $vmid = $task->{vmid
};
721 my $plugin = $task->{plugin
};
723 $task->{backup_time
} = time();
726 my $pbs_snapshot_name;
728 my $vmstarttime = time ();
734 my $log_vm_online_again = sub {
735 return if !defined($task->{vmstoptime
});
736 $task->{vmconttime
} //= time();
737 my $delay = $task->{vmconttime
} - $task->{vmstoptime
};
738 $delay = '<1' if $delay < 1;
739 debugmsg
('info', "guest is online again after $delay seconds", $logfd);
743 die "unable to find VM '$vmid'\n" if !$plugin;
745 my $vmtype = $plugin->type();
747 if ($self->{opts
}->{pbs
}) {
748 if ($vmtype eq 'lxc') {
749 $pbs_group_name = "ct/$vmid";
750 } elsif ($vmtype eq 'qemu') {
751 $pbs_group_name = "vm/$vmid";
753 die "pbs backup not implemented for plugin type '$vmtype'\n";
755 my $btime = strftime
("%FT%TZ", gmtime($task->{backup_time
}));
756 $pbs_snapshot_name = "$pbs_group_name/$btime";
759 # for now we deny backups of a running ha managed service in *stop* mode
760 # as it interferes with the HA stack (started services should not stop).
761 if ($opts->{mode
} eq 'stop' &&
762 PVE
::HA
::Config
::vm_is_ha_managed
($vmid, 'started'))
764 die "Cannot execute a backup with stop mode on a HA managed and".
765 " enabled Service. Use snapshot mode or disable the Service.\n";
768 my $tmplog = "$logdir/$vmtype-$vmid.log";
770 my $bkname = "vzdump-$vmtype-$vmid";
771 my $basename = $bkname . strftime
("-%Y_%m_%d-%H_%M_%S", localtime($task->{backup_time
}));
773 my $prune_options = $opts->{'prune-backups'};
775 my $backup_limit = 0;
776 if (!$prune_options->{'keep-all'}) {
777 foreach my $keep (values %{$prune_options}) {
778 $backup_limit += $keep;
782 if ($backup_limit && !$opts->{remove
}) {
784 if (my $storeid = $opts->{storage
}) {
785 my $backups = PVE
::Storage
::volume_list
($cfg, $storeid, $vmid, 'backup');
787 !$_->{protected
} && (!$_->{subtype
} || $_->{subtype
} eq $vmtype)
790 $count = scalar(get_unprotected_backup_file_list
($opts->{dumpdir
}, $bkname)->@*);
793 die "There is a max backup limit of $backup_limit enforced by the".
794 " target storage or the vzdump parameters.".
795 " Either increase the limit or delete old backup(s).\n"
796 if $count >= $backup_limit;
799 if (!$self->{opts
}->{pbs
}) {
800 $task->{logfile
} = "$opts->{dumpdir}/$basename.log";
803 my $ext = $vmtype eq 'qemu' ?
'.vma' : '.tar';
804 my ($comp, $comp_ext) = compressor_info
($opts);
805 if ($comp && $comp_ext) {
806 $ext .= ".${comp_ext}";
809 if ($self->{opts
}->{pbs
}) {
810 die "unable to pipe backup to stdout\n" if $opts->{stdout
};
811 $task->{target
} = $pbs_snapshot_name;
813 if ($opts->{stdout
}) {
814 $task->{target
} = '-';
816 $task->{target
} = $task->{tmptar
} = "$opts->{dumpdir}/$basename$ext";
817 $task->{tmptar
} =~ s/\.[^\.]+$/\.dat/;
818 unlink $task->{tmptar
};
822 $task->{vmtype
} = $vmtype;
825 if ($opts->{tmpdir
}) {
826 $task->{tmpdir
} = "$opts->{tmpdir}/vzdumptmp${pid}_$vmid/";
827 } elsif ($self->{opts
}->{pbs
}) {
828 $task->{tmpdir
} = "/var/tmp/vzdumptmp${pid}_$vmid";
830 # dumpdir is posix? then use it as temporary dir
831 my $info = get_mount_info
($opts->{dumpdir
});
832 if ($vmtype eq 'qemu' ||
833 grep ($_ eq $info->{fstype
}, @posix_filesystems)) {
834 $task->{tmpdir
} = "$opts->{dumpdir}/$basename.tmp";
836 $task->{tmpdir
} = "/var/tmp/vzdumptmp${pid}_$vmid";
837 debugmsg
('info', "filesystem type on dumpdir is '$info->{fstype}' -" .
838 "using $task->{tmpdir} for temporary files", $logfd);
842 rmtree
$task->{tmpdir
};
843 mkdir $task->{tmpdir
};
844 -d
$task->{tmpdir
} ||
845 die "unable to create temporary directory '$task->{tmpdir}'";
847 $logfd = IO
::File-
>new (">$tmplog") ||
848 die "unable to create log file '$tmplog'";
850 $task->{dumpdir
} = $opts->{dumpdir
};
851 $task->{storeid
} = $opts->{storage
};
852 $task->{scfg
} = $opts->{scfg
};
853 $task->{tmplog
} = $tmplog;
855 unlink $task->{logfile
} if defined($task->{logfile
});
857 debugmsg
('info', "Starting Backup of VM $vmid ($vmtype)", $logfd, 1);
858 debugmsg
('info', "Backup started at " . strftime
("%F %H:%M:%S", localtime()));
860 $plugin->set_logfd ($logfd);
862 # test is VM is running
863 my ($running, $status_text) = $plugin->vm_status ($vmid);
865 debugmsg
('info', "status = ${status_text}", $logfd);
867 # lock VM (prevent config changes)
868 $plugin->lock_vm ($vmid);
870 $cleanup->{unlock
} = 1;
874 my $mode = $running ?
$task->{mode
} : 'stop';
876 if ($mode eq 'snapshot') {
877 my %saved_task = %$task;
878 eval { $plugin->prepare ($task, $vmid, $mode); };
880 die $err if $err !~ m/^mode failure/;
881 debugmsg
('info', $err, $logfd);
882 debugmsg
('info', "trying 'suspend' mode instead", $logfd);
883 $mode = 'suspend'; # so prepare is called again below
884 %$task = %saved_task;
888 $cleanup->{prepared
} = 1;
890 $task->{mode
} = $mode;
892 debugmsg
('info', "backup mode: $mode", $logfd);
893 debugmsg
('info', "bandwidth limit: $opts->{bwlimit} KB/s", $logfd) if $opts->{bwlimit
};
894 debugmsg
('info', "ionice priority: $opts->{ionice}", $logfd);
896 if ($mode eq 'stop') {
897 $plugin->prepare ($task, $vmid, $mode);
899 $self->run_hook_script ('backup-start', $task, $logfd);
902 debugmsg
('info', "stopping virtual guest", $logfd);
903 $task->{vmstoptime
} = time();
904 $self->run_hook_script ('pre-stop', $task, $logfd);
905 $plugin->stop_vm ($task, $vmid);
906 $cleanup->{restart
} = 1;
910 } elsif ($mode eq 'suspend') {
911 $plugin->prepare ($task, $vmid, $mode);
913 $self->run_hook_script ('backup-start', $task, $logfd);
915 if ($vmtype eq 'lxc') {
917 $plugin->copy_data_phase1($task, $vmid);
920 debugmsg
('info', "suspending guest", $logfd);
921 $task->{vmstoptime
} = time ();
922 $self->run_hook_script ('pre-stop', $task, $logfd);
923 $plugin->suspend_vm ($task, $vmid);
924 $cleanup->{resume
} = 1;
926 if ($vmtype eq 'lxc') {
928 $plugin->copy_data_phase2($task, $vmid);
930 debugmsg
('info', "resuming guest", $logfd);
931 $cleanup->{resume
} = 0;
932 $self->run_hook_script('pre-restart', $task, $logfd);
933 $plugin->resume_vm($task, $vmid);
934 $self->run_hook_script('post-restart', $task, $logfd);
935 $log_vm_online_again->();
938 } elsif ($mode eq 'snapshot') {
939 $self->run_hook_script ('backup-start', $task, $logfd);
941 my $snapshot_count = $task->{snapshot_count
} || 0;
943 $self->run_hook_script ('pre-stop', $task, $logfd);
945 if ($snapshot_count > 1) {
946 debugmsg
('info', "suspend vm to make snapshot", $logfd);
947 $task->{vmstoptime
} = time ();
948 $plugin->suspend_vm ($task, $vmid);
949 $cleanup->{resume
} = 1;
952 $plugin->snapshot ($task, $vmid);
954 $self->run_hook_script ('pre-restart', $task, $logfd);
956 if ($snapshot_count > 1) {
957 debugmsg
('info', "resume vm", $logfd);
958 $cleanup->{resume
} = 0;
959 $plugin->resume_vm ($task, $vmid);
960 $log_vm_online_again->();
963 $self->run_hook_script ('post-restart', $task, $logfd);
966 die "internal error - unknown mode '$mode'\n";
969 # assemble archive image
970 $plugin->assemble ($task, $vmid);
974 if ($opts->{stdout
}) {
975 debugmsg
('info', "sending archive to stdout", $logfd);
976 $plugin->archive($task, $vmid, $task->{tmptar
}, $comp);
977 $self->run_hook_script ('backup-end', $task, $logfd);
981 my $archive_txt = $self->{opts
}->{pbs
} ?
'Proxmox Backup Server' : 'vzdump';
982 debugmsg
('info', "creating $archive_txt archive '$task->{target}'", $logfd);
983 $plugin->archive($task, $vmid, $task->{tmptar
}, $comp);
985 if ($self->{opts
}->{pbs
}) {
986 # size is added to task struct in guest vzdump plugins
988 rename ($task->{tmptar
}, $task->{target
}) ||
989 die "unable to rename '$task->{tmptar}' to '$task->{target}'\n";
992 $task->{size
} = (-s
$task->{target
}) || 0;
993 my $cs = format_size
($task->{size
});
994 debugmsg
('info', "archive file size: $cs", $logfd);
997 if ($opts->{remove
}) {
998 my $keepstr = join(', ', map { "$_=$prune_options->{$_}" } sort keys %$prune_options);
999 debugmsg
('info', "prune older backups with retention: $keepstr", $logfd);
1001 if (!defined($opts->{storage
})) {
1002 my $bklist = get_unprotected_backup_file_list
($opts->{dumpdir
}, $bkname);
1004 PVE
::Storage
::prune_mark_backup_group
($bklist, $prune_options);
1006 foreach my $prune_entry (@{$bklist}) {
1007 next if $prune_entry->{mark
} ne 'remove';
1009 my $archive_path = $prune_entry->{path
};
1010 debugmsg
('info', "delete old backup '$archive_path'", $logfd);
1011 PVE
::Storage
::archive_remove
($archive_path);
1014 my $pruned_list = PVE
::Storage
::prune_backups
(
1021 sub { debugmsg
($_[0], $_[1], $logfd) },
1023 $pruned = scalar(grep { $_->{mark
} eq 'remove' } $pruned_list->@*);
1025 my $log_pruned_extra = $pruned > 0 ?
" not covered by keep-retention policy" : "";
1026 debugmsg
('info', "pruned $pruned backup(s)${log_pruned_extra}", $logfd);
1029 $self->run_hook_script ('backup-end', $task, $logfd);
1036 if ($cleanup->{unlock
}) {
1037 eval { $plugin->unlock_vm ($vmid); };
1041 if ($cleanup->{prepared
}) {
1042 # only call cleanup when necessary (when prepare was executed)
1043 eval { $plugin->cleanup ($task, $vmid) };
1047 eval { $plugin->set_logfd (undef); };
1050 if ($cleanup->{resume
} || $cleanup->{restart
}) {
1052 $self->run_hook_script ('pre-restart', $task, $logfd);
1053 if ($cleanup->{resume
}) {
1054 debugmsg
('info', "resume vm", $logfd);
1055 $plugin->resume_vm ($task, $vmid);
1057 my $running = $plugin->vm_status($vmid);
1059 debugmsg
('info', "restarting vm", $logfd);
1060 $plugin->start_vm ($task, $vmid);
1063 $self->run_hook_script ('post-restart', $task, $logfd);
1069 $log_vm_online_again->();
1074 eval { unlink $task->{tmptar
} if $task->{tmptar
} && -f
$task->{tmptar
}; };
1077 eval { rmtree
$task->{tmpdir
} if $task->{tmpdir
} && -d
$task->{tmpdir
}; };
1080 my $delay = $task->{backuptime
} = time () - $vmstarttime;
1083 $task->{state} = 'err';
1084 $task->{msg
} = $err;
1085 debugmsg
('err', "Backup of VM $vmid failed - $err", $logfd, 1);
1086 debugmsg
('info', "Failed at " . strftime
("%F %H:%M:%S", localtime()));
1088 eval { $self->run_hook_script ('backup-abort', $task, $logfd); };
1091 $task->{state} = 'ok';
1092 my $tstr = format_time
($delay);
1093 debugmsg
('info', "Finished Backup of VM $vmid ($tstr)", $logfd, 1);
1094 debugmsg
('info', "Backup finished at " . strftime
("%F %H:%M:%S", localtime()));
1097 close ($logfd) if $logfd;
1099 if ($task->{tmplog
}) {
1100 if ($self->{opts
}->{pbs
}) {
1101 if ($task->{state} eq 'ok') {
1103 PVE
::Storage
::PBSPlugin
::run_raw_client_cmd
(
1107 [ $pbs_snapshot_name, $task->{tmplog
} ],
1108 errmsg
=> "uploading backup task log failed",
1112 debugmsg
('warn', "$@") if $@; # $@ contains already error prefix
1114 } elsif ($task->{logfile
}) {
1115 system {'cp'} 'cp', $task->{tmplog
}, $task->{logfile
};
1119 eval { $self->run_hook_script ('log-end', $task); };
1121 die $err if $err && $err =~ m/^interrupted by signal$/;
1125 my ($self, $rpcenv, $authuser) = @_;
1127 my $opts = $self->{opts
};
1129 debugmsg
('info', "starting new backup job: $self->{cmdline}", undef, 1);
1131 if (scalar(@{$self->{skiplist
}})) {
1132 my $skip_string = join(', ', sort { $a <=> $b } @{$self->{skiplist
}});
1133 debugmsg
('info', "skip external VMs: $skip_string");
1137 my $vzdump_plugins = {};
1138 foreach my $plugin (@{$self->{plugins
}}) {
1139 my $type = $plugin->type();
1140 next if exists $vzdump_plugins->{$type};
1141 $vzdump_plugins->{$type} = $plugin;
1144 my $vmlist = PVE
::Cluster
::get_vmlist
();
1145 my $vmids = [ sort { $a <=> $b } @{$opts->{vmids
}} ];
1146 foreach my $vmid (@{$vmids}) {
1148 if (defined($vmlist->{ids
}->{$vmid})) {
1149 my $guest_type = $vmlist->{ids
}->{$vmid}->{type
};
1150 $plugin = $vzdump_plugins->{$guest_type};
1151 next if !$rpcenv->check($authuser, "/vms/$vmid", [ 'VM.Backup' ], $opts->{all
});
1154 mode
=> $opts->{mode
},
1161 # Use in-memory files for the outer hook logs to pass them to sendmail.
1162 my $job_start_log = '';
1163 my $job_end_log = '';
1164 open my $job_start_fd, '>', \
$job_start_log;
1165 open my $job_end_fd, '>', \
$job_end_log;
1167 my $starttime = time();
1171 $self->run_hook_script ('job-start', undef, $job_start_fd);
1173 foreach my $task (@$tasklist) {
1174 $self->exec_backup_task ($task);
1175 $errcount += 1 if $task->{state} ne 'ok';
1178 $self->run_hook_script ('job-end', undef, $job_end_fd);
1182 $self->run_hook_script ('job-abort', undef, $job_end_fd) if $err;
1185 debugmsg
('err', "Backup job failed - $err", undef, 1);
1188 debugmsg
('info', "Backup job finished with errors", undef, 1);
1190 debugmsg
('info', "Backup job finished successfully", undef, 1);
1194 close $job_start_fd;
1197 my $totaltime = time() - $starttime;
1204 $self->{job_init_log
} . $job_start_log,
1208 debugmsg
('err', $@) if $@;
1212 die "job errors\n" if $errcount;
1220 return defined($confdesc->{$key});
1223 # NOTE it might make sense to merge this and verify_vzdump_parameters(), but one
1224 # needs to adapt command_line() in guest-common's PVE/VZDump/Common.pm and detect
1225 # a second parsing attempt, because verify_vzdump_parameters() is called twice
1226 # during the update_job API call.
1227 sub parse_mailto_exclude_path
{
1230 # exclude-path list need to be 0 separated
1231 if (defined($param->{'exclude-path'})) {
1232 my @expaths = split(/\0/, $param->{'exclude-path'} || '');
1233 $param->{'exclude-path'} = [ @expaths ];
1236 if (defined($param->{mailto
})) {
1237 my @mailto = PVE
::Tools
::split_list
(extract_param
($param, 'mailto'));
1238 $param->{mailto
} = [ @mailto ];
1244 sub verify_vzdump_parameters
{
1245 my ($param, $check_missing) = @_;
1247 raise_param_exc
({ all
=> "option conflicts with option 'vmid'"})
1248 if $param->{all
} && $param->{vmid
};
1250 raise_param_exc
({ exclude
=> "option conflicts with option 'vmid'"})
1251 if $param->{exclude
} && $param->{vmid
};
1253 raise_param_exc
({ pool
=> "option conflicts with option 'vmid'"})
1254 if $param->{pool
} && $param->{vmid
};
1256 raise_param_exc
({ 'prune-backups' => "option conflicts with option 'maxfiles'"})
1257 if defined($param->{'prune-backups'}) && defined($param->{maxfiles
});
1259 $parse_prune_backups_maxfiles->($param, 'CLI parameters');
1261 $param->{all
} = 1 if (defined($param->{exclude
}) && !$param->{pool
});
1263 return if !$check_missing;
1265 raise_param_exc
({ vmid
=> "property is missing"})
1266 if !($param->{all
} || $param->{stop
} || $param->{pool
}) && !$param->{vmid
};
1270 sub stop_running_backups
{
1273 my $upid = PVE
::Tools
::file_read_firstline
($pidfile);
1276 my $task = PVE
::Tools
::upid_decode
($upid);
1278 if (PVE
::ProcFSTools
::check_process_running
($task->{pid
}, $task->{pstart
}) &&
1279 PVE
::ProcFSTools
::read_proc_starttime
($task->{pid
}) == $task->{pstart
}) {
1280 kill(15, $task->{pid
});
1281 # wait max 15 seconds to shut down (else, do nothing for now)
1283 for ($i = 15; $i > 0; $i--) {
1284 last if !PVE
::ProcFSTools
::check_process_running
(($task->{pid
}, $task->{pstart
}));
1287 die "stopping backup process $task->{pid} failed\n" if $i == 0;
1291 sub get_included_guests
{
1295 my $vmids_per_node = {};
1297 my $vmlist = PVE
::Cluster
::get_vmlist
();
1300 $vmids = PVE
::API2Tools
::get_resource_pool_guest_members
($job->{pool
});
1301 } elsif ($job->{vmid
}) {
1302 $vmids = [ split_list
($job->{vmid
}) ];
1303 } elsif ($job->{all
}) {
1305 my $exclude = check_vmids
(split_list
($job->{exclude
}));
1306 my $excludehash = { map { $_ => 1 } @$exclude };
1308 for my $id (keys %{$vmlist->{ids
}}) {
1309 next if $excludehash->{$id};
1313 return $vmids_per_node;
1315 $vmids = check_vmids
(@$vmids);
1317 for my $vmid (@$vmids) {
1318 if (defined($vmlist->{ids
}->{$vmid})) {
1319 my $node = $vmlist->{ids
}->{$vmid}->{node
};
1320 next if (defined $job->{node
} && $job->{node
} ne $node);
1322 push @{$vmids_per_node->{$node}}, $vmid;
1324 push @{$vmids_per_node->{''}}, $vmid;
1328 return $vmids_per_node;