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);
75 my $cfg = PVE
::Storage
::config
();
76 my $scfg = PVE
::Storage
::storage_config
($cfg, $storage);
77 my $type = $scfg->{type
};
79 die "can't use storage type '$type' for backup\n"
80 if (!($type eq 'dir' || $type eq 'nfs' || $type eq 'glusterfs'
81 || $type eq 'cifs' || $type eq 'cephfs' || $type eq 'pbs'));
82 die "can't use storage '$storage' for backups - wrong content type\n"
83 if (!$scfg->{content
}->{backup
});
85 PVE
::Storage
::activate_storage
($cfg, $storage);
89 maxfiles
=> $scfg->{maxfiles
},
95 $info->{dumpdir
} = PVE
::Storage
::get_backup_dir
($cfg, $storage);
104 my $kb = $size / 1024;
107 return int ($kb) . "KB";
110 my $mb = $size / (1024*1024);
112 return int ($mb) . "MB";
116 return sprintf ("%.2fGB", $gb);
119 return sprintf ("%.2fTB", $tb);
125 my $hours = int ($seconds/3600);
126 $seconds = $seconds - $hours*3600;
127 my $min = int ($seconds/60);
128 $seconds = $seconds - $min*60;
130 return sprintf ("%02d:%02d:%02d", $hours, $min, $seconds);
136 $str =~ s/^(.{990})/$1\n/mg; # reduce line length
154 foreach my $p (split (/:/, $ENV{PATH
})) {
161 die "unable to find command '$bin'\n";
168 for my $vmid (sort {$a <=> $b} @vmids) {
169 die "ERROR: strange VM ID '${vmid}'\n" if $vmid !~ m/^\d+$/;
170 $vmid = int ($vmid); # remove leading zeros
179 sub read_vzdump_defaults
{
181 my $fn = "/etc/vzdump.conf";
185 my $default = $confdesc->{$_}->{default};
186 defined($default) ?
($_ => $default) : ()
191 eval { $raw = PVE
::Tools
::file_get_contents
($fn); };
192 return $defaults if $@;
194 my $conf_schema = { type
=> 'object', properties
=> $confdesc, };
195 my $res = PVE
::JSONSchema
::parse_config
($conf_schema, $fn, $raw);
196 if (my $excludes = $res->{'exclude-path'}) {
197 $res->{'exclude-path'} = PVE
::Tools
::split_args
($excludes);
199 if (defined($res->{mailto
})) {
200 my @mailto = split_list
($res->{mailto
});
201 $res->{mailto
} = [ @mailto ];
204 foreach my $key (keys %$defaults) {
205 $res->{$key} = $defaults->{$key} if !defined($res->{$key});
211 use constant MAX_MAIL_SIZE
=> 1024*1024;
213 my ($self, $tasklist, $totaltime, $err, $detail_pre, $detail_post) = @_;
215 my $opts = $self->{opts
};
217 my $mailto = $opts->{mailto
};
219 return if !($mailto && scalar(@$mailto));
221 my $cmdline = $self->{cmdline
};
224 foreach my $task (@$tasklist) {
225 $ecount++ if $task->{state} ne 'ok';
226 chomp $task->{msg
} if $task->{msg
};
227 $task->{backuptime
} = 0 if !$task->{backuptime
};
228 $task->{size
} = 0 if !$task->{size
};
229 $task->{target
} = 'unknown' if !$task->{target
};
230 $task->{hostname
} = "VM $task->{vmid}" if !$task->{hostname
};
232 if ($task->{state} eq 'todo') {
233 $task->{msg
} = 'aborted';
237 my $notify = $opts->{mailnotification
} || 'always';
238 return if (!$ecount && !$err && ($notify eq 'failure'));
240 my $stat = ($ecount || $err) ?
'backup failed' : 'backup successful';
243 $stat .= ": multiple problems";
250 my $hostname = `hostname -f` || PVE
::INotify
::nodename
();
254 my $text = $err ?
"$err\n\n" : '';
255 $text .= sprintf ("%-10s %-6s %10s %10s %s\n", qw(VMID STATUS TIME SIZE FILENAME));
256 foreach my $task (@$tasklist) {
257 my $vmid = $task->{vmid
};
258 if ($task->{state} eq 'ok') {
260 $text .= sprintf ("%-10s %-6s %10s %10s %s\n", $vmid,
262 format_time
($task->{backuptime
}),
263 format_size
($task->{size
}),
266 $text .= sprintf ("%-10s %-6s %10s %8.2fMB %s\n", $vmid,
268 format_time
($task->{backuptime
}),
274 $text_log_part .= "\nDetailed backup logs:\n\n";
275 $text_log_part .= "$cmdline\n\n";
277 $text_log_part .= $detail_pre . "\n" if defined($detail_pre);
278 foreach my $task (@$tasklist) {
279 my $vmid = $task->{vmid
};
280 my $log = $task->{tmplog
};
282 $text_log_part .= "$vmid: no log available\n\n";
285 if (open (TMP
, "$log")) {
286 while (my $line = <TMP
>) {
287 next if $line =~ /^status: \d+/; # not useful in mails
288 $text_log_part .= encode8bit
("$vmid: $line");
291 $text_log_part .= "$vmid: Could not open log file\n\n";
294 $text_log_part .= "\n";
296 $text_log_part .= $detail_post if defined($detail_post);
299 my $html = "<html><body>\n";
300 $html .= "<p>" . (escape_html
($err) =~ s/\n/<br>/gr) . "</p>\n" if $err;
301 $html .= "<table border=1 cellpadding=3>\n";
302 $html .= "<tr><td>VMID<td>NAME<td>STATUS<td>TIME<td>SIZE<td>FILENAME</tr>\n";
306 foreach my $task (@$tasklist) {
307 my $vmid = $task->{vmid
};
308 my $name = $task->{hostname
};
310 if ($task->{state} eq 'ok') {
312 $ssize += $task->{size
};
314 $html .= sprintf ("<tr><td>%s<td>%s<td>OK<td>%s<td align=right>%s<td>%s</tr>\n",
316 format_time
($task->{backuptime
}),
317 format_size
($task->{size
}),
318 escape_html
($task->{target
}));
320 $html .= sprintf ("<tr><td>%s<td>%s<td><font color=red>FAILED<td>%s<td colspan=2>%s</tr>\n",
321 $vmid, $name, format_time
($task->{backuptime
}),
322 escape_html
($task->{msg
}));
326 $html .= sprintf ("<tr><td align=left colspan=3>TOTAL<td>%s<td>%s<td></tr>",
327 format_time
($totaltime), format_size
($ssize));
329 $html .= "\n</table><br><br>\n";
331 $html_log_part .= "Detailed backup logs:<br /><br />\n";
332 $html_log_part .= "<pre>\n";
333 $html_log_part .= escape_html
($cmdline) . "\n\n";
335 $html_log_part .= escape_html
($detail_pre) . "\n" if defined($detail_pre);
336 foreach my $task (@$tasklist) {
337 my $vmid = $task->{vmid
};
338 my $log = $task->{tmplog
};
340 $html_log_part .= "$vmid: no log available\n\n";
343 if (open (TMP
, "$log")) {
344 while (my $line = <TMP
>) {
345 next if $line =~ /^status: \d+/; # not useful in mails
346 if ($line =~ m/^\S+\s\d+\s+\d+:\d+:\d+\s+(ERROR|WARN):/) {
347 $html_log_part .= encode8bit
("$vmid: <font color=red>".
348 escape_html
($line) . "</font>");
350 $html_log_part .= encode8bit
("$vmid: " . escape_html
($line));
354 $html_log_part .= "$vmid: Could not open log file\n\n";
357 $html_log_part .= "\n";
359 $html_log_part .= escape_html
($detail_post) if defined($detail_post);
360 $html_log_part .= "</pre>";
361 my $html_end .= "\n</body></html>\n";
364 if (length($text) + length($text_log_part) +
365 length($html) + length($html_log_part) < MAX_MAIL_SIZE
)
367 $html .= $html_log_part;
368 $text .= $text_log_part;
370 my $msg = "Log output was too long to be sent by mail. ".
371 "See Task History for details!\n";
373 $html .= "<p>$msg</p>";
377 my $subject = "vzdump backup status ($hostname) : $stat";
379 my $dcconf = PVE
::Cluster
::cfs_read_file
('datacenter.cfg');
380 my $mailfrom = $dcconf->{email_from
} || "root";
382 PVE
::Tools
::sendmail
($mailto, $subject, $text, $html, $mailfrom, "vzdump backup tool");
386 my ($class, $cmdline, $opts, $skiplist) = @_;
392 check_bin
('sendmail');
396 check_bin
('umount');
397 check_bin
('cstream');
398 check_bin
('ionice');
400 if ($opts->{mode
} && $opts->{mode
} eq 'snapshot') {
401 check_bin
('lvcreate');
403 check_bin
('lvremove');
406 my $defaults = read_vzdump_defaults
();
408 $opts->{remove
} = 1 if !defined($opts->{remove
});
410 foreach my $k (keys %$defaults) {
411 next if $k eq 'exclude-path' || $k eq 'maxfiles'; # dealt with separately
412 if ($k eq 'dumpdir' || $k eq 'storage') {
413 $opts->{$k} = $defaults->{$k} if !defined ($opts->{dumpdir
}) &&
414 !defined ($opts->{storage
});
416 $opts->{$k} = $defaults->{$k} if !defined ($opts->{$k});
420 $opts->{dumpdir
} =~ s
|/+$|| if ($opts->{dumpdir
});
421 $opts->{tmpdir
} =~ s
|/+$|| if ($opts->{tmpdir
});
423 $skiplist = [] if !$skiplist;
424 my $self = bless { cmdline
=> $cmdline, opts
=> $opts, skiplist
=> $skiplist };
426 my $findexcl = $self->{findexcl
} = [];
427 if ($defaults->{'exclude-path'}) {
428 push @$findexcl, @{$defaults->{'exclude-path'}};
431 if ($opts->{'exclude-path'}) {
432 push @$findexcl, @{$opts->{'exclude-path'}};
435 if ($opts->{stdexcludes
}) {
436 push @$findexcl, '/tmp/?*',
441 foreach my $p (@plugins) {
443 my $pd = $p->new ($self);
445 push @{$self->{plugins
}}, $pd;
448 if (defined($opts->{storage
}) && $opts->{stdout
}) {
449 die "cannot use options 'storage' and 'stdout' at the same time\n";
450 } elsif (defined($opts->{storage
}) && defined($opts->{dumpdir
})) {
451 die "cannot use options 'storage' and 'dumpdir' at the same time\n";
454 if (!$opts->{dumpdir
} && !$opts->{storage
}) {
455 $opts->{storage
} = 'local';
460 if ($opts->{storage
}) {
461 my $info = eval { storage_info
($opts->{storage
}) };
462 $errors .= "could not get storage information for '$opts->{storage}': $@"
464 $opts->{dumpdir
} = $info->{dumpdir
};
465 $opts->{scfg
} = $info->{scfg
};
466 $opts->{pbs
} = $info->{pbs
};
467 $opts->{maxfiles
} //= $info->{maxfiles
};
468 } elsif ($opts->{dumpdir
}) {
469 $errors .= "dumpdir '$opts->{dumpdir}' does not exist"
470 if ! -d
$opts->{dumpdir
};
472 die "internal error";
475 $opts->{maxfiles
} //= $defaults->{maxfiles
};
477 if ($opts->{tmpdir
} && ! -d
$opts->{tmpdir
}) {
478 $errors .= "\n" if $errors;
479 $errors .= "tmpdir '$opts->{tmpdir}' does not exist";
483 eval { $self->sendmail([], 0, $errors); };
484 debugmsg
('err', $@) if $@;
494 # Note: df 'available' can be negative, and percentage set to '-'
496 my $cmd = [ 'df', '-P', '-T', '-B', '1', $dir];
502 if (my ($fsid, $fstype, undef, $mp) = $line =~
503 m!(\S+.*)\s+(\S+)\s+\d+\s+\-?\d+\s+\d+\s+(\d+%|-)\s+(/.*)$!) {
512 eval { PVE
::Tools
::run_command
($cmd, errfunc
=> sub {}, outfunc
=> $parser); };
519 my ($self, $upid) = @_;
523 my $maxwait = $self->{opts
}->{lockwait
} || $self->{lockwait
};
525 die "missimg UPID" if !$upid; # should not happen
527 if (!open (SERVER_FLCK
, ">>$lockfile")) {
528 debugmsg
('err', "can't open lock on file '$lockfile' - $!", undef, 1);
529 die "can't open lock on file '$lockfile' - $!";
532 if (!flock (SERVER_FLCK
, LOCK_EX
|LOCK_NB
)) {
535 debugmsg
('err', "can't acquire lock '$lockfile' (wait = 0)", undef, 1);
536 die "can't acquire lock '$lockfile' (wait = 0)";
539 debugmsg
('info', "trying to get global lock - waiting...", undef, 1);
542 alarm ($maxwait * 60);
544 local $SIG{ALRM
} = sub { alarm (0); die "got timeout\n"; };
546 if (!flock (SERVER_FLCK
, LOCK_EX
)) {
559 debugmsg
('err', "can't acquire lock '$lockfile' - $err", undef, 1);
560 die "can't acquire lock '$lockfile' - $err";
563 debugmsg
('info', "got global lock", undef, 1);
566 PVE
::Tools
::file_set_contents
($pidfile, $upid);
569 sub run_hook_script
{
570 my ($self, $phase, $task, $logfd) = @_;
572 my $opts = $self->{opts
};
574 my $script = $opts->{script
};
578 die "The hook script '$script' is not executable.\n";
581 my $cmd = "$script $phase";
583 $cmd .= " $task->{mode} $task->{vmid}" if ($task);
586 # set immutable opts directly (so they are available in all phases)
587 $ENV{STOREID
} = $opts->{storage
} if $opts->{storage
};
588 $ENV{DUMPDIR
} = $opts->{dumpdir
} if $opts->{dumpdir
};
590 foreach my $ek (qw(vmtype hostname target logfile)) {
591 $ENV{uc($ek)} = $task->{$ek} if $task->{$ek};
594 run_command
($logfd, $cmd);
597 sub compressor_info
{
599 my $opt_compress = $opts->{compress
};
601 if (!$opt_compress || $opt_compress eq '0') {
603 } elsif ($opt_compress eq '1' || $opt_compress eq 'lzo') {
604 return ('lzop', 'lzo');
605 } elsif ($opt_compress eq 'gzip') {
606 if ($opts->{pigz
} > 0) {
607 my $pigz_threads = $opts->{pigz
};
608 if ($pigz_threads == 1) {
609 my $cpuinfo = PVE
::ProcFSTools
::read_cpuinfo
();
610 $pigz_threads = int(($cpuinfo->{cpus
} + 1)/2);
612 return ("pigz -p ${pigz_threads} --rsyncable", 'gz');
614 return ('gzip --rsyncable', 'gz');
616 } elsif ($opt_compress eq 'zstd') {
617 my $zstd_threads = $opts->{zstd
} // 1;
618 if ($zstd_threads == 0) {
619 my $cpuinfo = PVE
::ProcFSTools
::read_cpuinfo
();
620 $zstd_threads = int(($cpuinfo->{cpus
} + 1)/2);
622 return ("zstd --rsyncable --threads=${zstd_threads}", 'zst');
624 die "internal error - unknown compression option '$opt_compress'";
628 sub get_backup_file_list
{
629 my ($dir, $bkname, $exclude_fn) = @_;
632 foreach my $fn (<$dir/${bkname
}-*>) {
633 next if $exclude_fn && $fn eq $exclude_fn;
634 if ($fn =~ m!/(${bkname}-(\d{4})_(\d{2})_(\d{2})-(\d{2})_(\d{2})_(\d{2})\.(tgz|((tar|vma)(\.(${\PVE::Storage::Plugin::COMPRESSOR_RE}))?)))$!) {
635 $fn = "$dir/$1"; # untaint
636 my $t = timelocal
($7, $6, $5, $4, $3 - 1, $2);
637 push @$bklist, [$fn, $t];
644 sub exec_backup_task
{
645 my ($self, $task) = @_;
647 my $opts = $self->{opts
};
649 my $vmid = $task->{vmid
};
650 my $plugin = $task->{plugin
};
651 my $vmtype = $plugin->type();
653 $task->{backup_time
} = time();
656 my $pbs_snapshot_name;
658 if ($self->{opts
}->{pbs
}) {
659 if ($vmtype eq 'lxc') {
660 $pbs_group_name = "ct/$vmid";
661 } elsif ($vmtype eq 'qemu') {
662 $pbs_group_name = "vm/$vmid";
664 die "pbs backup not implemented for plugin type '$vmtype'\n";
666 my $btime = strftime
("%FT%TZ", gmtime($task->{backup_time
}));
667 $pbs_snapshot_name = "$pbs_group_name/$btime";
670 my $vmstarttime = time ();
676 my $log_vm_online_again = sub {
677 return if !defined($task->{vmstoptime
});
678 $task->{vmconttime
} //= time();
679 my $delay = $task->{vmconttime
} - $task->{vmstoptime
};
680 debugmsg
('info', "guest is online again after $delay seconds", $logfd);
684 die "unable to find VM '$vmid'\n" if !$plugin;
686 # for now we deny backups of a running ha managed service in *stop* mode
687 # as it interferes with the HA stack (started services should not stop).
688 if ($opts->{mode
} eq 'stop' &&
689 PVE
::HA
::Config
::vm_is_ha_managed
($vmid, 'started'))
691 die "Cannot execute a backup with stop mode on a HA managed and".
692 " enabled Service. Use snapshot mode or disable the Service.\n";
695 my $tmplog = "$logdir/$vmtype-$vmid.log";
697 my $bkname = "vzdump-$vmtype-$vmid";
698 my $basename = $bkname . strftime
("-%Y_%m_%d-%H_%M_%S", localtime($task->{backup_time
}));
700 my $maxfiles = $opts->{maxfiles
};
702 if ($maxfiles && !$opts->{remove
}) {
704 if ($self->{opts
}->{pbs
}) {
705 my $res = PVE
::Storage
::PBSPlugin
::run_client_cmd
($opts->{scfg
}, $opts->{storage
}, 'snapshots', $pbs_group_name);
706 $count = scalar(@$res);
708 my $bklist = get_backup_file_list
($opts->{dumpdir
}, $bkname);
709 $count = scalar(@$bklist);
711 die "There is a max backup limit of ($maxfiles) enforced by the".
712 " target storage or the vzdump parameters.".
713 " Either increase the limit or delete old backup(s).\n"
714 if $count >= $maxfiles;
717 if (!$self->{opts
}->{pbs
}) {
718 $task->{logfile
} = "$opts->{dumpdir}/$basename.log";
721 my $ext = $vmtype eq 'qemu' ?
'.vma' : '.tar';
722 my ($comp, $comp_ext) = compressor_info
($opts);
723 if ($comp && $comp_ext) {
724 $ext .= ".${comp_ext}";
727 if ($self->{opts
}->{pbs
}) {
728 die "unable to pipe backup to stdout\n" if $opts->{stdout
};
729 $task->{target
} = $pbs_snapshot_name;
731 if ($opts->{stdout
}) {
732 $task->{target
} = '-';
734 $task->{target
} = $task->{tmptar
} = "$opts->{dumpdir}/$basename$ext";
735 $task->{tmptar
} =~ s/\.[^\.]+$/\.dat/;
736 unlink $task->{tmptar
};
740 $task->{vmtype
} = $vmtype;
742 if ($self->{opts
}->{pbs
}) {
743 $task->{tmpdir
} = "/var/tmp/vzdumptmp$$"; #fixme
744 } elsif ($opts->{tmpdir
}) {
745 $task->{tmpdir
} = "$opts->{tmpdir}/vzdumptmp$$";
747 # dumpdir is posix? then use it as temporary dir
748 my $info = get_mount_info
($opts->{dumpdir
});
749 if ($vmtype eq 'qemu' ||
750 grep ($_ eq $info->{fstype
}, @posix_filesystems)) {
751 $task->{tmpdir
} = "$opts->{dumpdir}/$basename.tmp";
753 $task->{tmpdir
} = "/var/tmp/vzdumptmp$$";
754 debugmsg
('info', "filesystem type on dumpdir is '$info->{fstype}' -" .
755 "using $task->{tmpdir} for temporary files", $logfd);
759 rmtree
$task->{tmpdir
};
760 mkdir $task->{tmpdir
};
761 -d
$task->{tmpdir
} ||
762 die "unable to create temporary directory '$task->{tmpdir}'";
764 $logfd = IO
::File-
>new (">$tmplog") ||
765 die "unable to create log file '$tmplog'";
767 $task->{dumpdir
} = $opts->{dumpdir
};
768 $task->{storeid
} = $opts->{storage
};
769 $task->{scfg
} = $opts->{scfg
};
770 $task->{tmplog
} = $tmplog;
772 unlink $task->{logfile
} if defined($task->{logfile
});
774 debugmsg
('info', "Starting Backup of VM $vmid ($vmtype)", $logfd, 1);
775 debugmsg
('info', "Backup started at " . strftime
("%F %H:%M:%S", localtime()));
777 $plugin->set_logfd ($logfd);
779 # test is VM is running
780 my ($running, $status_text) = $plugin->vm_status ($vmid);
782 debugmsg
('info', "status = ${status_text}", $logfd);
784 # lock VM (prevent config changes)
785 $plugin->lock_vm ($vmid);
787 $cleanup->{unlock
} = 1;
791 my $mode = $running ?
$task->{mode
} : 'stop';
793 if ($mode eq 'snapshot') {
794 my %saved_task = %$task;
795 eval { $plugin->prepare ($task, $vmid, $mode); };
797 die $err if $err !~ m/^mode failure/;
798 debugmsg
('info', $err, $logfd);
799 debugmsg
('info', "trying 'suspend' mode instead", $logfd);
800 $mode = 'suspend'; # so prepare is called again below
801 %$task = %saved_task;
805 $cleanup->{prepared
} = 1;
807 $task->{mode
} = $mode;
809 debugmsg
('info', "backup mode: $mode", $logfd);
811 debugmsg
('info', "bandwidth limit: $opts->{bwlimit} KB/s", $logfd)
814 debugmsg
('info', "ionice priority: $opts->{ionice}", $logfd);
816 if ($mode eq 'stop') {
818 $plugin->prepare ($task, $vmid, $mode);
820 $self->run_hook_script ('backup-start', $task, $logfd);
823 debugmsg
('info', "stopping vm", $logfd);
824 $task->{vmstoptime
} = time();
825 $self->run_hook_script ('pre-stop', $task, $logfd);
826 $plugin->stop_vm ($task, $vmid);
827 $cleanup->{restart
} = 1;
831 } elsif ($mode eq 'suspend') {
833 $plugin->prepare ($task, $vmid, $mode);
835 $self->run_hook_script ('backup-start', $task, $logfd);
837 if ($vmtype eq 'lxc') {
839 $plugin->copy_data_phase1($task, $vmid);
842 debugmsg
('info', "suspend vm", $logfd);
843 $task->{vmstoptime
} = time ();
844 $self->run_hook_script ('pre-stop', $task, $logfd);
845 $plugin->suspend_vm ($task, $vmid);
846 $cleanup->{resume
} = 1;
848 if ($vmtype eq 'lxc') {
850 $plugin->copy_data_phase2($task, $vmid);
852 debugmsg
('info', "resume vm", $logfd);
853 $cleanup->{resume
} = 0;
854 $self->run_hook_script('pre-restart', $task, $logfd);
855 $plugin->resume_vm($task, $vmid);
856 $self->run_hook_script('post-restart', $task, $logfd);
857 $log_vm_online_again->();
860 } elsif ($mode eq 'snapshot') {
862 $self->run_hook_script ('backup-start', $task, $logfd);
864 my $snapshot_count = $task->{snapshot_count
} || 0;
866 $self->run_hook_script ('pre-stop', $task, $logfd);
868 if ($snapshot_count > 1) {
869 debugmsg
('info', "suspend vm to make snapshot", $logfd);
870 $task->{vmstoptime
} = time ();
871 $plugin->suspend_vm ($task, $vmid);
872 $cleanup->{resume
} = 1;
875 $plugin->snapshot ($task, $vmid);
877 $self->run_hook_script ('pre-restart', $task, $logfd);
879 if ($snapshot_count > 1) {
880 debugmsg
('info', "resume vm", $logfd);
881 $cleanup->{resume
} = 0;
882 $plugin->resume_vm ($task, $vmid);
883 $log_vm_online_again->();
886 $self->run_hook_script ('post-restart', $task, $logfd);
889 die "internal error - unknown mode '$mode'\n";
892 # assemble archive image
893 $plugin->assemble ($task, $vmid);
897 if ($opts->{stdout
}) {
898 debugmsg
('info', "sending archive to stdout", $logfd);
899 $plugin->archive($task, $vmid, $task->{tmptar
}, $comp);
900 $self->run_hook_script ('backup-end', $task, $logfd);
904 my $archive_txt = $self->{opts
}->{pbs
} ?
'Proxmox Backup Server' : 'vzdump';
905 debugmsg
('info', "creating $archive_txt archive '$task->{target}'", $logfd);
906 $plugin->archive($task, $vmid, $task->{tmptar
}, $comp);
908 if ($self->{opts
}->{pbs
}) {
910 debugmsg
('info', "pbs upload finished", $logfd);
912 rename ($task->{tmptar
}, $task->{target
}) ||
913 die "unable to rename '$task->{tmptar}' to '$task->{target}'\n";
916 $task->{size
} = (-s
$task->{target
}) || 0;
917 my $cs = format_size
($task->{size
});
918 debugmsg
('info', "archive file size: $cs", $logfd);
922 if ($maxfiles && $opts->{remove
}) {
924 if ($self->{opts
}->{pbs
}) {
925 my $args = [$pbs_group_name, '--quiet', '1', '--keep-last', $maxfiles];
926 my $logfunc = sub { my $line = shift; debugmsg
('info', $line, $logfd); };
927 PVE
::Storage
::PBSPlugin
::run_raw_client_cmd
(
928 $opts->{scfg
}, $opts->{storage
}, 'prune', $args, logfunc
=> $logfunc);
930 my $bklist = get_backup_file_list
($opts->{dumpdir
}, $bkname, $task->{target
});
931 $bklist = [ sort { $b->[1] <=> $a->[1] } @$bklist ];
933 while (scalar (@$bklist) >= $maxfiles) {
934 my $d = pop @$bklist;
935 debugmsg
('info', "delete old backup '$d->[0]'", $logfd);
938 $logfn =~ s/\.(tgz|((tar|vma)(\.(${\PVE::Storage::Plugin::COMPRESSOR_RE}))?))$/\.log/;
944 $self->run_hook_script ('backup-end', $task, $logfd);
951 if ($cleanup->{unlock
}) {
952 eval { $plugin->unlock_vm ($vmid); };
956 if ($cleanup->{prepared
}) {
957 # only call cleanup when necessary (when prepare was executed)
958 eval { $plugin->cleanup ($task, $vmid) };
962 eval { $plugin->set_logfd (undef); };
965 if ($cleanup->{resume
} || $cleanup->{restart
}) {
967 $self->run_hook_script ('pre-restart', $task, $logfd);
968 if ($cleanup->{resume
}) {
969 debugmsg
('info', "resume vm", $logfd);
970 $plugin->resume_vm ($task, $vmid);
972 my $running = $plugin->vm_status($vmid);
974 debugmsg
('info', "restarting vm", $logfd);
975 $plugin->start_vm ($task, $vmid);
978 $self->run_hook_script ('post-restart', $task, $logfd);
984 $log_vm_online_again->();
989 eval { unlink $task->{tmptar
} if $task->{tmptar
} && -f
$task->{tmptar
}; };
992 eval { rmtree
$task->{tmpdir
} if $task->{tmpdir
} && -d
$task->{tmpdir
}; };
995 my $delay = $task->{backuptime
} = time () - $vmstarttime;
998 $task->{state} = 'err';
1000 debugmsg
('err', "Backup of VM $vmid failed - $err", $logfd, 1);
1001 debugmsg
('info', "Failed at " . strftime
("%F %H:%M:%S", localtime()));
1003 eval { $self->run_hook_script ('backup-abort', $task, $logfd); };
1006 $task->{state} = 'ok';
1007 my $tstr = format_time
($delay);
1008 debugmsg
('info', "Finished Backup of VM $vmid ($tstr)", $logfd, 1);
1009 debugmsg
('info', "Backup finished at " . strftime
("%F %H:%M:%S", localtime()));
1012 close ($logfd) if $logfd;
1014 if ($task->{tmplog
}) {
1015 if ($self->{opts
}->{pbs
}) {
1016 if ($task->{state} eq 'ok') {
1017 my $param = [$pbs_snapshot_name, $task->{tmplog
}];
1018 PVE
::Storage
::PBSPlugin
::run_raw_client_cmd
(
1019 $opts->{scfg
}, $opts->{storage
}, 'upload-log', $param, errmsg
=> "upload log failed");
1021 } elsif ($task->{logfile
}) {
1022 system {'cp'} 'cp', $task->{tmplog
}, $task->{logfile
};
1026 eval { $self->run_hook_script ('log-end', $task); };
1028 die $err if $err && $err =~ m/^interrupted by signal$/;
1032 my ($self, $rpcenv, $authuser) = @_;
1034 my $opts = $self->{opts
};
1036 debugmsg
('info', "starting new backup job: $self->{cmdline}", undef, 1);
1037 debugmsg
('info', "skip external VMs: " . join(', ', @{$self->{skiplist
}}))
1038 if scalar(@{$self->{skiplist
}});
1041 my $vzdump_plugins = {};
1042 foreach my $plugin (@{$self->{plugins
}}) {
1043 my $type = $plugin->type();
1044 next if exists $vzdump_plugins->{$type};
1045 $vzdump_plugins->{$type} = $plugin;
1048 my $vmlist = PVE
::Cluster
::get_vmlist
();
1049 foreach my $vmid (sort @{$opts->{vmids
}}) {
1050 my $guest_type = $vmlist->{ids
}->{$vmid}->{type
};
1051 my $plugin = $vzdump_plugins->{$guest_type};
1052 next if !$rpcenv->check($authuser, "/vms/$vmid", [ 'VM.Backup' ], $opts->{all
});
1054 mode
=> $opts->{mode
},
1061 # Use in-memory files for the outer hook logs to pass them to sendmail.
1062 my $job_start_log = '';
1063 my $job_end_log = '';
1064 open my $job_start_fd, '>', \
$job_start_log;
1065 open my $job_end_fd, '>', \
$job_end_log;
1067 my $starttime = time();
1071 $self->run_hook_script ('job-start', undef, $job_start_fd);
1073 foreach my $task (@$tasklist) {
1074 $self->exec_backup_task ($task);
1075 $errcount += 1 if $task->{state} ne 'ok';
1078 $self->run_hook_script ('job-end', undef, $job_end_fd);
1082 $self->run_hook_script ('job-abort', undef, $job_end_fd) if $err;
1085 debugmsg
('err', "Backup job failed - $err", undef, 1);
1088 debugmsg
('info', "Backup job finished with errors", undef, 1);
1090 debugmsg
('info', "Backup job finished successfully", undef, 1);
1094 close $job_start_fd;
1097 my $totaltime = time() - $starttime;
1099 eval { $self->sendmail ($tasklist, $totaltime, undef, $job_start_log, $job_end_log); };
1100 debugmsg
('err', $@) if $@;
1104 die "job errors\n" if $errcount;
1112 return defined($confdesc->{$key});
1115 sub verify_vzdump_parameters
{
1116 my ($param, $check_missing) = @_;
1118 raise_param_exc
({ all
=> "option conflicts with option 'vmid'"})
1119 if $param->{all
} && $param->{vmid
};
1121 raise_param_exc
({ exclude
=> "option conflicts with option 'vmid'"})
1122 if $param->{exclude
} && $param->{vmid
};
1124 raise_param_exc
({ pool
=> "option conflicts with option 'vmid'"})
1125 if $param->{pool
} && $param->{vmid
};
1127 $param->{all
} = 1 if (defined($param->{exclude
}) && !$param->{pool
});
1129 warn "option 'size' is deprecated and will be removed in a future " .
1130 "release, please update your script/configuration!\n"
1131 if defined($param->{size
});
1133 return if !$check_missing;
1135 raise_param_exc
({ vmid
=> "property is missing"})
1136 if !($param->{all
} || $param->{stop
} || $param->{pool
}) && !$param->{vmid
};
1140 sub stop_running_backups
{
1143 my $upid = PVE
::Tools
::file_read_firstline
($pidfile);
1146 my $task = PVE
::Tools
::upid_decode
($upid);
1148 if (PVE
::ProcFSTools
::check_process_running
($task->{pid
}, $task->{pstart
}) &&
1149 PVE
::ProcFSTools
::read_proc_starttime
($task->{pid
}) == $task->{pstart
}) {
1150 kill(15, $task->{pid
});
1151 # wait max 15 seconds to shut down (else, do nothing for now)
1153 for ($i = 15; $i > 0; $i--) {
1154 last if !PVE
::ProcFSTools
::check_process_running
(($task->{pid
}, $task->{pstart
}));
1157 die "stopping backup process $task->{pid} failed\n" if $i == 0;
1161 sub get_included_guests
{
1164 my $nodename = PVE
::INotify
::nodename
();
1166 my $vmids_per_node = {};
1168 my $vmlist = PVE
::Cluster
::get_vmlist
();
1171 $vmids = PVE
::API2Tools
::get_resource_pool_guest_members
($job->{pool
});
1172 } elsif ($job->{vmid
}) {
1173 $vmids = [ split_list
($job->{vmid
}) ];
1176 my $exclude = check_vmids
(split_list
($job->{exclude
}));
1177 my $excludehash = { map { $_ => 1 } @$exclude };
1179 for my $id (keys %{$vmlist->{ids
}}) {
1180 next if $excludehash->{$id};
1184 $vmids = check_vmids
(@$vmids);
1186 for my $vmid (@$vmids) {
1187 my $node = $vmlist->{ids
}->{$vmid}->{node
};
1188 next if (defined $job->{node
} && $job->{node
} ne $node);
1190 push @{$vmids_per_node->{$node}}, $vmid;
1193 return $vmids_per_node;