]>
Commit | Line | Data |
---|---|---|
aaeeeebe DM |
1 | package PVE::VZDump; |
2 | ||
aaeeeebe DM |
3 | use strict; |
4 | use warnings; | |
5 | use Fcntl ':flock'; | |
31aef761 | 6 | use PVE::Exception qw(raise_param_exc); |
4a4051d8 | 7 | use PVE::SafeSyslog; |
aaeeeebe DM |
8 | use IO::File; |
9 | use IO::Select; | |
10 | use IPC::Open3; | |
11 | use POSIX qw(strftime); | |
12 | use File::Path; | |
98e84b16 | 13 | use PVE::RPCEnvironment; |
4a4051d8 DM |
14 | use PVE::Storage; |
15 | use PVE::Cluster qw(cfs_read_file); | |
aaeeeebe DM |
16 | use Time::localtime; |
17 | use Time::Local; | |
ac27b58d | 18 | use PVE::JSONSchema qw(get_standard_option); |
10a9a736 | 19 | use PVE::HA::Env::PVE2; |
2de3ee58 | 20 | use PVE::HA::Config; |
aaeeeebe DM |
21 | |
22 | my @posix_filesystems = qw(ext3 ext4 nfs nfs4 reiserfs xfs); | |
23 | ||
24 | my $lockfile = '/var/run/vzdump.lock'; | |
25 | ||
8682f6fc WL |
26 | my $pidfile = '/var/run/vzdump.pid'; |
27 | ||
aaeeeebe DM |
28 | my $logdir = '/var/log/vzdump'; |
29 | ||
dafb6246 | 30 | my @plugins = qw(); |
aaeeeebe | 31 | |
cc61ea36 TL |
32 | my $confdesc = { |
33 | vmid => { | |
34 | type => 'string', format => 'pve-vmid-list', | |
2fcb9347 | 35 | description => "The ID of the guest system you want to backup.", |
e1bde280 | 36 | completion => \&PVE::Cluster::complete_local_vmid, |
cc61ea36 TL |
37 | optional => 1, |
38 | }, | |
39 | node => get_standard_option('pve-node', { | |
40 | description => "Only run if executed on this node.", | |
e1bde280 | 41 | completion => \&PVE::Cluster::get_nodelist, |
cc61ea36 TL |
42 | optional => 1, |
43 | }), | |
44 | all => { | |
45 | type => 'boolean', | |
2fcb9347 | 46 | description => "Backup all known guest systems on this host.", |
cc61ea36 TL |
47 | optional => 1, |
48 | default => 0, | |
49 | }, | |
50 | stdexcludes => { | |
51 | type => 'boolean', | |
af77c164 | 52 | description => "Exclude temporary files and logs.", |
cc61ea36 TL |
53 | optional => 1, |
54 | default => 1, | |
55 | }, | |
56 | compress => { | |
57 | type => 'string', | |
58 | description => "Compress dump file.", | |
59 | optional => 1, | |
60 | enum => ['0', '1', 'gzip', 'lzo'], | |
d1918d1b | 61 | default => '0', |
cc61ea36 TL |
62 | }, |
63 | pigz=> { | |
64 | type => "integer", | |
af77c164 | 65 | description => "Use pigz instead of gzip when N>0.". |
cc61ea36 TL |
66 | " N=1 uses half of cores, N>1 uses N as thread count.", |
67 | optional => 1, | |
68 | default => 0, | |
69 | }, | |
70 | quiet => { | |
71 | type => 'boolean', | |
72 | description => "Be quiet.", | |
73 | optional => 1, | |
74 | default => 0, | |
75 | }, | |
76 | mode => { | |
77 | type => 'string', | |
78 | description => "Backup mode.", | |
79 | optional => 1, | |
1ab98f05 | 80 | default => 'snapshot', |
cc61ea36 TL |
81 | enum => [ 'snapshot', 'suspend', 'stop' ], |
82 | }, | |
83 | exclude => { | |
84 | type => 'string', format => 'pve-vmid-list', | |
2fcb9347 | 85 | description => "Exclude specified guest systems (assumes --all)", |
cc61ea36 TL |
86 | optional => 1, |
87 | }, | |
88 | 'exclude-path' => { | |
89 | type => 'string', format => 'string-alist', | |
af77c164 | 90 | description => "Exclude certain files/directories (shell globs).", |
cc61ea36 TL |
91 | optional => 1, |
92 | }, | |
93 | mailto => { | |
94 | type => 'string', format => 'string-list', | |
4f367c19 FG |
95 | description => "Comma-separated list of email addresses that should" . |
96 | " receive email notifications.", | |
cc61ea36 TL |
97 | optional => 1, |
98 | }, | |
99 | mailnotification => { | |
100 | type => 'string', | |
101 | description => "Specify when to send an email", | |
102 | optional => 1, | |
103 | enum => [ 'always', 'failure' ], | |
104 | default => 'always', | |
105 | }, | |
106 | tmpdir => { | |
107 | type => 'string', | |
108 | description => "Store temporary files to specified directory.", | |
109 | optional => 1, | |
110 | }, | |
111 | dumpdir => { | |
112 | type => 'string', | |
113 | description => "Store resulting files to specified directory.", | |
114 | optional => 1, | |
115 | }, | |
116 | script => { | |
117 | type => 'string', | |
118 | description => "Use specified hook script.", | |
119 | optional => 1, | |
120 | }, | |
121 | storage => get_standard_option('pve-storage-id', { | |
122 | description => "Store resulting file to this storage.", | |
e1bde280 | 123 | completion => \&complete_backup_storage, |
cc61ea36 TL |
124 | optional => 1, |
125 | }), | |
126 | stop => { | |
127 | type => 'boolean', | |
128 | description => "Stop runnig backup jobs on this host.", | |
129 | optional => 1, | |
130 | default => 0, | |
131 | }, | |
132 | size => { | |
133 | type => 'integer', | |
e2a2525e | 134 | description => "Unused, will be removed in a future release.", |
cc61ea36 TL |
135 | optional => 1, |
136 | minimum => 500, | |
1ab98f05 | 137 | default => 1024, |
cc61ea36 TL |
138 | }, |
139 | bwlimit => { | |
140 | type => 'integer', | |
141 | description => "Limit I/O bandwidth (KBytes per second).", | |
142 | optional => 1, | |
143 | minimum => 0, | |
1ab98f05 | 144 | default => 0, |
cc61ea36 TL |
145 | }, |
146 | ionice => { | |
147 | type => 'integer', | |
148 | description => "Set CFQ ionice priority.", | |
149 | optional => 1, | |
150 | minimum => 0, | |
151 | maximum => 8, | |
1ab98f05 | 152 | default => 7, |
cc61ea36 TL |
153 | }, |
154 | lockwait => { | |
155 | type => 'integer', | |
156 | description => "Maximal time to wait for the global lock (minutes).", | |
157 | optional => 1, | |
158 | minimum => 0, | |
1ab98f05 | 159 | default => 3*60, # 3 hours |
cc61ea36 TL |
160 | }, |
161 | stopwait => { | |
162 | type => 'integer', | |
2fcb9347 | 163 | description => "Maximal time to wait until a guest system is stopped (minutes).", |
cc61ea36 TL |
164 | optional => 1, |
165 | minimum => 0, | |
1ab98f05 | 166 | default => 10, # 10 minutes |
cc61ea36 TL |
167 | }, |
168 | maxfiles => { | |
169 | type => 'integer', | |
2fcb9347 | 170 | description => "Maximal number of backup files per guest system.", |
cc61ea36 TL |
171 | optional => 1, |
172 | minimum => 1, | |
1ab98f05 | 173 | default => 1, |
cc61ea36 TL |
174 | }, |
175 | remove => { | |
176 | type => 'boolean', | |
177 | description => "Remove old backup files if there are more than 'maxfiles' backup files.", | |
178 | optional => 1, | |
179 | default => 1, | |
180 | }, | |
181 | }; | |
182 | ||
aaeeeebe | 183 | # Load available plugins |
8187f6b0 DM |
184 | my @pve_vzdump_classes = qw(PVE::VZDump::QemuServer PVE::VZDump::LXC); |
185 | foreach my $plug (@pve_vzdump_classes) { | |
186 | my $filename = "/usr/share/perl5/$plug.pm"; | |
187 | $filename =~ s!::!/!g; | |
188 | if (-f $filename) { | |
189 | eval { require $filename; }; | |
190 | if (!$@) { | |
191 | $plug->import (); | |
192 | push @plugins, $plug; | |
193 | } else { | |
194 | warn $@; | |
195 | } | |
196 | } | |
aaeeeebe DM |
197 | } |
198 | ||
199 | # helper functions | |
200 | ||
201 | my $debugstattxt = { | |
202 | err => 'ERROR:', | |
203 | info => 'INFO:', | |
204 | warn => 'WARN:', | |
205 | }; | |
206 | ||
207 | sub debugmsg { | |
208 | my ($mtype, $msg, $logfd, $syslog) = @_; | |
209 | ||
210 | chomp $msg; | |
211 | ||
212 | return if !$msg; | |
213 | ||
214 | my $pre = $debugstattxt->{$mtype} || $debugstattxt->{'err'}; | |
215 | ||
216 | my $timestr = strftime ("%b %d %H:%M:%S", CORE::localtime); | |
217 | ||
218 | syslog ($mtype eq 'info' ? 'info' : 'err', "$pre $msg") if $syslog; | |
219 | ||
220 | foreach my $line (split (/\n/, $msg)) { | |
221 | print STDERR "$pre $line\n"; | |
222 | print $logfd "$timestr $pre $line\n" if $logfd; | |
223 | } | |
224 | } | |
225 | ||
226 | sub run_command { | |
227 | my ($logfd, $cmdstr, %param) = @_; | |
228 | ||
7f910306 | 229 | my $logfunc = sub { |
4a4051d8 | 230 | my $line = shift; |
4a4051d8 | 231 | debugmsg ('info', $line, $logfd); |
aaeeeebe DM |
232 | }; |
233 | ||
7f910306 | 234 | PVE::Tools::run_command($cmdstr, %param, logfunc => $logfunc); |
aaeeeebe DM |
235 | } |
236 | ||
237 | sub storage_info { | |
238 | my $storage = shift; | |
239 | ||
bbcfdc08 | 240 | my $cfg = PVE::Storage::config(); |
4a4051d8 | 241 | my $scfg = PVE::Storage::storage_config($cfg, $storage); |
aaeeeebe DM |
242 | my $type = $scfg->{type}; |
243 | ||
244 | die "can't use storage type '$type' for backup\n" | |
8f3315e1 | 245 | if (!($type eq 'dir' || $type eq 'nfs' || $type eq 'glusterfs')); |
b13a7a31 | 246 | die "can't use storage '$storage' for backups - wrong content type\n" |
aaeeeebe DM |
247 | if (!$scfg->{content}->{backup}); |
248 | ||
4a4051d8 | 249 | PVE::Storage::activate_storage($cfg, $storage); |
aaeeeebe DM |
250 | |
251 | return { | |
30edfad9 | 252 | dumpdir => PVE::Storage::get_backup_dir($cfg, $storage), |
19d5c0f2 | 253 | maxfiles => $scfg->{maxfiles}, |
aaeeeebe DM |
254 | }; |
255 | } | |
256 | ||
257 | sub format_size { | |
258 | my $size = shift; | |
259 | ||
260 | my $kb = $size / 1024; | |
261 | ||
262 | if ($kb < 1024) { | |
263 | return int ($kb) . "KB"; | |
264 | } | |
265 | ||
266 | my $mb = $size / (1024*1024); | |
267 | ||
268 | if ($mb < 1024) { | |
269 | return int ($mb) . "MB"; | |
270 | } else { | |
271 | my $gb = $mb / 1024; | |
272 | return sprintf ("%.2fGB", $gb); | |
273 | } | |
274 | } | |
275 | ||
276 | sub format_time { | |
277 | my $seconds = shift; | |
278 | ||
279 | my $hours = int ($seconds/3600); | |
280 | $seconds = $seconds - $hours*3600; | |
281 | my $min = int ($seconds/60); | |
282 | $seconds = $seconds - $min*60; | |
283 | ||
284 | return sprintf ("%02d:%02d:%02d", $hours, $min, $seconds); | |
285 | } | |
286 | ||
287 | sub encode8bit { | |
288 | my ($str) = @_; | |
289 | ||
290 | $str =~ s/^(.{990})/$1\n/mg; # reduce line length | |
291 | ||
292 | return $str; | |
293 | } | |
294 | ||
295 | sub escape_html { | |
296 | my ($str) = @_; | |
297 | ||
298 | $str =~ s/&/&/g; | |
299 | $str =~ s/</</g; | |
300 | $str =~ s/>/>/g; | |
301 | ||
302 | return $str; | |
303 | } | |
304 | ||
305 | sub check_bin { | |
306 | my ($bin) = @_; | |
307 | ||
308 | foreach my $p (split (/:/, $ENV{PATH})) { | |
309 | my $fn = "$p/$bin"; | |
310 | if (-x $fn) { | |
311 | return $fn; | |
312 | } | |
313 | } | |
314 | ||
315 | die "unable to find command '$bin'\n"; | |
316 | } | |
317 | ||
318 | sub check_vmids { | |
319 | my (@vmids) = @_; | |
320 | ||
321 | my $res = []; | |
322 | foreach my $vmid (@vmids) { | |
323 | die "ERROR: strange VM ID '${vmid}'\n" if $vmid !~ m/^\d+$/; | |
324 | $vmid = int ($vmid); # remove leading zeros | |
4a4051d8 | 325 | next if !$vmid; |
aaeeeebe DM |
326 | push @$res, $vmid; |
327 | } | |
328 | ||
329 | return $res; | |
330 | } | |
331 | ||
332 | ||
333 | sub read_vzdump_defaults { | |
334 | ||
335 | my $fn = "/etc/vzdump.conf"; | |
336 | ||
cc61ea36 | 337 | my $defaults = { |
1ab98f05 WB |
338 | map { |
339 | my $default = $confdesc->{$_}->{default}; | |
340 | defined($default) ? ($_ => $default) : () | |
341 | } keys %$confdesc | |
aaeeeebe DM |
342 | }; |
343 | ||
cc61ea36 TL |
344 | my $raw; |
345 | eval { $raw = PVE::Tools::file_get_contents($fn); }; | |
346 | return $defaults if $@; | |
aaeeeebe | 347 | |
cc61ea36 TL |
348 | my $conf_schema = { type => 'object', properties => $confdesc, }; |
349 | my $res = PVE::JSONSchema::parse_config($conf_schema, $fn, $raw); | |
6368bbd4 WB |
350 | if (my $excludes = $res->{'exclude-path'}) { |
351 | $res->{'exclude-path'} = PVE::Tools::split_args($excludes); | |
352 | } | |
74b47fd8 FG |
353 | if (defined($res->{mailto})) { |
354 | my @mailto = PVE::Tools::split_list($res->{mailto}); | |
355 | $res->{mailto} = [ @mailto ]; | |
356 | } | |
cc61ea36 TL |
357 | |
358 | foreach my $key (keys %$defaults) { | |
e94fa5cb | 359 | $res->{$key} = $defaults->{$key} if !defined($res->{$key}); |
aaeeeebe | 360 | } |
aaeeeebe DM |
361 | |
362 | return $res; | |
363 | } | |
364 | ||
6ec9de44 | 365 | sub sendmail { |
44b21574 | 366 | my ($self, $tasklist, $totaltime, $err, $detail_pre, $detail_post) = @_; |
aaeeeebe DM |
367 | |
368 | my $opts = $self->{opts}; | |
369 | ||
370 | my $mailto = $opts->{mailto}; | |
371 | ||
4a4051d8 | 372 | return if !($mailto && scalar(@$mailto)); |
aaeeeebe DM |
373 | |
374 | my $cmdline = $self->{cmdline}; | |
375 | ||
376 | my $ecount = 0; | |
377 | foreach my $task (@$tasklist) { | |
378 | $ecount++ if $task->{state} ne 'ok'; | |
379 | chomp $task->{msg} if $task->{msg}; | |
380 | $task->{backuptime} = 0 if !$task->{backuptime}; | |
381 | $task->{size} = 0 if !$task->{size}; | |
382 | $task->{tarfile} = 'unknown' if !$task->{tarfile}; | |
383 | $task->{hostname} = "VM $task->{vmid}" if !$task->{hostname}; | |
384 | ||
385 | if ($task->{state} eq 'todo') { | |
386 | $task->{msg} = 'aborted'; | |
387 | } | |
388 | } | |
389 | ||
02e59759 DM |
390 | my $notify = $opts->{mailnotification} || 'always'; |
391 | return if (!$ecount && !$err && ($notify eq 'failure')); | |
8b4b4860 | 392 | |
6ec9de44 | 393 | my $stat = ($ecount || $err) ? 'backup failed' : 'backup successful'; |
403761c4 WB |
394 | if ($err) { |
395 | if ($err =~ /\n/) { | |
396 | $stat .= ": multiple problems"; | |
397 | } else { | |
398 | $stat .= ": $err"; | |
399 | $err = undef; | |
400 | } | |
401 | } | |
aaeeeebe | 402 | |
4a4051d8 | 403 | my $hostname = `hostname -f` || PVE::INotify::nodename(); |
aaeeeebe DM |
404 | chomp $hostname; |
405 | ||
aaeeeebe | 406 | # text part |
403761c4 WB |
407 | my $text = $err ? "$err\n\n" : ''; |
408 | $text .= sprintf ("%-10s %-6s %10s %10s %s\n", qw(VMID STATUS TIME SIZE FILENAME)); | |
aaeeeebe DM |
409 | foreach my $task (@$tasklist) { |
410 | my $vmid = $task->{vmid}; | |
411 | if ($task->{state} eq 'ok') { | |
412 | ||
7a0a8e67 TL |
413 | $text .= sprintf ("%-10s %-6s %10s %10s %s\n", $vmid, |
414 | $task->{state}, | |
aaeeeebe DM |
415 | format_time($task->{backuptime}), |
416 | format_size ($task->{size}), | |
417 | $task->{tarfile}); | |
418 | } else { | |
7a0a8e67 TL |
419 | $text .= sprintf ("%-10s %-6s %10s %8.2fMB %s\n", $vmid, |
420 | $task->{state}, | |
aaeeeebe DM |
421 | format_time($task->{backuptime}), |
422 | 0, '-'); | |
423 | } | |
424 | } | |
7a0a8e67 | 425 | |
0da2260f | 426 | $text .= "\nDetailed backup logs:\n\n"; |
7a0a8e67 | 427 | $text .= "$cmdline\n\n"; |
aaeeeebe | 428 | |
44b21574 | 429 | $text .= $detail_pre . "\n" if defined($detail_pre); |
aaeeeebe DM |
430 | foreach my $task (@$tasklist) { |
431 | my $vmid = $task->{vmid}; | |
432 | my $log = $task->{tmplog}; | |
433 | if (!$log) { | |
7a0a8e67 | 434 | $text .= "$vmid: no log available\n\n"; |
aaeeeebe DM |
435 | next; |
436 | } | |
437 | open (TMP, "$log"); | |
7a0a8e67 | 438 | while (my $line = <TMP>) { $text .= encode8bit ("$vmid: $line"); } |
aaeeeebe | 439 | close (TMP); |
7a0a8e67 | 440 | $text .= "\n"; |
aaeeeebe | 441 | } |
44b21574 | 442 | $text .= $detail_post if defined($detail_post); |
aaeeeebe | 443 | |
aaeeeebe | 444 | # html part |
7a0a8e67 | 445 | my $html = "<html><body>\n"; |
403761c4 | 446 | $html .= "<p>" . (escape_html($err) =~ s/\n/<br>/gr) . "</p>\n" if $err; |
7a0a8e67 TL |
447 | $html .= "<table border=1 cellpadding=3>\n"; |
448 | $html .= "<tr><td>VMID<td>NAME<td>STATUS<td>TIME<td>SIZE<td>FILENAME</tr>\n"; | |
aaeeeebe DM |
449 | |
450 | my $ssize = 0; | |
451 | ||
452 | foreach my $task (@$tasklist) { | |
453 | my $vmid = $task->{vmid}; | |
454 | my $name = $task->{hostname}; | |
455 | ||
456 | if ($task->{state} eq 'ok') { | |
457 | ||
458 | $ssize += $task->{size}; | |
459 | ||
7a0a8e67 | 460 | $html .= sprintf ("<tr><td>%s<td>%s<td>OK<td>%s<td align=right>%s<td>%s</tr>\n", |
aaeeeebe DM |
461 | $vmid, $name, |
462 | format_time($task->{backuptime}), | |
463 | format_size ($task->{size}), | |
464 | escape_html ($task->{tarfile})); | |
465 | } else { | |
7a0a8e67 TL |
466 | $html .= sprintf ("<tr><td>%s<td>%s<td><font color=red>FAILED<td>%s<td colspan=2>%s</tr>\n", |
467 | $vmid, $name, format_time($task->{backuptime}), | |
aaeeeebe DM |
468 | escape_html ($task->{msg})); |
469 | } | |
470 | } | |
471 | ||
7a0a8e67 | 472 | $html .= sprintf ("<tr><td align=left colspan=3>TOTAL<td>%s<td>%s<td></tr>", |
aaeeeebe DM |
473 | format_time ($totaltime), format_size ($ssize)); |
474 | ||
7a0a8e67 TL |
475 | $html .= "</table><br><br>\n"; |
476 | $html .= "Detailed backup logs:<br /><br />\n"; | |
477 | $html .= "<pre>\n"; | |
478 | $html .= escape_html($cmdline) . "\n\n"; | |
aaeeeebe | 479 | |
44b21574 | 480 | $html .= escape_html($detail_pre) . "\n" if defined($detail_pre); |
aaeeeebe DM |
481 | foreach my $task (@$tasklist) { |
482 | my $vmid = $task->{vmid}; | |
483 | my $log = $task->{tmplog}; | |
484 | if (!$log) { | |
7a0a8e67 | 485 | $html .= "$vmid: no log available\n\n"; |
aaeeeebe DM |
486 | next; |
487 | } | |
488 | open (TMP, "$log"); | |
489 | while (my $line = <TMP>) { | |
490 | if ($line =~ m/^\S+\s\d+\s+\d+:\d+:\d+\s+(ERROR|WARN):/) { | |
7a0a8e67 TL |
491 | $html .= encode8bit ("$vmid: <font color=red>". |
492 | escape_html ($line) . "</font>"); | |
aaeeeebe | 493 | } else { |
7a0a8e67 | 494 | $html .= encode8bit ("$vmid: " . escape_html ($line)); |
aaeeeebe DM |
495 | } |
496 | } | |
497 | close (TMP); | |
7a0a8e67 | 498 | $html .= "\n"; |
aaeeeebe | 499 | } |
44b21574 | 500 | $html .= escape_html($detail_post) if defined($detail_post); |
7a0a8e67 TL |
501 | $html .= "</pre></body></html>\n"; |
502 | # end html part | |
aaeeeebe | 503 | |
7a0a8e67 | 504 | my $subject = "vzdump backup status ($hostname) : $stat"; |
aaeeeebe | 505 | |
7a0a8e67 TL |
506 | my $dcconf = PVE::Cluster::cfs_read_file('datacenter.cfg'); |
507 | my $mailfrom = $dcconf->{email_from} || "root"; | |
aaeeeebe | 508 | |
7a0a8e67 | 509 | PVE::Tools::sendmail($mailto, $subject, $text, $html, $mailfrom, "vzdump backup tool"); |
aaeeeebe DM |
510 | }; |
511 | ||
512 | sub new { | |
a7e42354 | 513 | my ($class, $cmdline, $opts, $skiplist) = @_; |
aaeeeebe DM |
514 | |
515 | mkpath $logdir; | |
516 | ||
517 | check_bin ('cp'); | |
518 | check_bin ('df'); | |
519 | check_bin ('sendmail'); | |
520 | check_bin ('rsync'); | |
521 | check_bin ('tar'); | |
522 | check_bin ('mount'); | |
523 | check_bin ('umount'); | |
524 | check_bin ('cstream'); | |
525 | check_bin ('ionice'); | |
526 | ||
47664cbe | 527 | if ($opts->{mode} && $opts->{mode} eq 'snapshot') { |
aaeeeebe DM |
528 | check_bin ('lvcreate'); |
529 | check_bin ('lvs'); | |
530 | check_bin ('lvremove'); | |
531 | } | |
532 | ||
533 | my $defaults = read_vzdump_defaults(); | |
534 | ||
84ad4385 DM |
535 | my $maxfiles = $opts->{maxfiles}; # save here, because we overwrite with default |
536 | ||
899b8373 DM |
537 | $opts->{remove} = 1 if !defined($opts->{remove}); |
538 | ||
aaeeeebe | 539 | foreach my $k (keys %$defaults) { |
b1f09117 | 540 | next if $k eq 'exclude-path'; # dealt with separately |
aaeeeebe DM |
541 | if ($k eq 'dumpdir' || $k eq 'storage') { |
542 | $opts->{$k} = $defaults->{$k} if !defined ($opts->{dumpdir}) && | |
543 | !defined ($opts->{storage}); | |
544 | } else { | |
545 | $opts->{$k} = $defaults->{$k} if !defined ($opts->{$k}); | |
546 | } | |
547 | } | |
548 | ||
aaeeeebe DM |
549 | $opts->{dumpdir} =~ s|/+$|| if ($opts->{dumpdir}); |
550 | $opts->{tmpdir} =~ s|/+$|| if ($opts->{tmpdir}); | |
551 | ||
a7e42354 DM |
552 | $skiplist = [] if !$skiplist; |
553 | my $self = bless { cmdline => $cmdline, opts => $opts, skiplist => $skiplist }; | |
aaeeeebe | 554 | |
45f16a06 | 555 | my $findexcl = $self->{findexcl} = []; |
f4a8bab4 | 556 | if ($defaults->{'exclude-path'}) { |
45f16a06 | 557 | push @$findexcl, @{$defaults->{'exclude-path'}}; |
f4a8bab4 DM |
558 | } |
559 | ||
aaeeeebe | 560 | if ($opts->{'exclude-path'}) { |
45f16a06 | 561 | push @$findexcl, @{$opts->{'exclude-path'}}; |
aaeeeebe DM |
562 | } |
563 | ||
564 | if ($opts->{stdexcludes}) { | |
e42ae622 | 565 | push @$findexcl, '/tmp/?*', |
45f16a06 | 566 | '/var/tmp/?*', |
0568e342 | 567 | '/var/run/?*.pid'; |
aaeeeebe DM |
568 | } |
569 | ||
570 | foreach my $p (@plugins) { | |
571 | ||
572 | my $pd = $p->new ($self); | |
573 | ||
574 | push @{$self->{plugins}}, $pd; | |
aaeeeebe DM |
575 | } |
576 | ||
577 | if (!$opts->{dumpdir} && !$opts->{storage}) { | |
19d5c0f2 | 578 | $opts->{storage} = 'local'; |
aaeeeebe DM |
579 | } |
580 | ||
403761c4 WB |
581 | my $errors = ''; |
582 | ||
aaeeeebe DM |
583 | if ($opts->{storage}) { |
584 | my $info = storage_info ($opts->{storage}); | |
585 | $opts->{dumpdir} = $info->{dumpdir}; | |
84ad4385 | 586 | $maxfiles = $info->{maxfiles} if !defined($maxfiles) && defined($info->{maxfiles}); |
aaeeeebe | 587 | } elsif ($opts->{dumpdir}) { |
403761c4 | 588 | $errors .= "dumpdir '$opts->{dumpdir}' does not exist" |
aaeeeebe DM |
589 | if ! -d $opts->{dumpdir}; |
590 | } else { | |
591 | die "internal error"; | |
592 | } | |
593 | ||
594 | if ($opts->{tmpdir} && ! -d $opts->{tmpdir}) { | |
403761c4 WB |
595 | $errors .= "\n" if $errors; |
596 | $errors .= "tmpdir '$opts->{tmpdir}' does not exist"; | |
597 | } | |
598 | ||
599 | if ($errors) { | |
600 | eval { $self->sendmail([], 0, $errors); }; | |
601 | debugmsg ('err', $@) if $@; | |
602 | die "$errors\n"; | |
aaeeeebe DM |
603 | } |
604 | ||
84ad4385 | 605 | $opts->{maxfiles} = $maxfiles if defined($maxfiles); |
899b8373 | 606 | |
aaeeeebe DM |
607 | return $self; |
608 | ||
609 | } | |
610 | ||
aaeeeebe DM |
611 | sub get_mount_info { |
612 | my ($dir) = @_; | |
613 | ||
8572d646 DM |
614 | # Note: df 'available' can be negative, and percentage set to '-' |
615 | ||
d93d0459 | 616 | my $cmd = [ 'df', '-P', '-T', '-B', '1', $dir]; |
aaeeeebe | 617 | |
d93d0459 | 618 | my $res; |
aaeeeebe | 619 | |
d93d0459 DM |
620 | my $parser = sub { |
621 | my $line = shift; | |
8572d646 DM |
622 | if (my ($fsid, $fstype, undef, $mp) = $line =~ |
623 | m!(\S+.*)\s+(\S+)\s+\d+\s+\-?\d+\s+\d+\s+(\d+%|-)\s+(/.*)$!) { | |
d93d0459 DM |
624 | $res = { |
625 | device => $fsid, | |
626 | fstype => $fstype, | |
627 | mountpoint => $mp, | |
628 | }; | |
629 | } | |
aaeeeebe | 630 | }; |
d93d0459 DM |
631 | |
632 | eval { PVE::Tools::run_command($cmd, errfunc => sub {}, outfunc => $parser); }; | |
633 | warn $@ if $@; | |
634 | ||
635 | return $res; | |
aaeeeebe DM |
636 | } |
637 | ||
aaeeeebe | 638 | sub getlock { |
eab837c4 | 639 | my ($self, $upid) = @_; |
aaeeeebe | 640 | |
8682f6fc WL |
641 | my $fh; |
642 | ||
aaeeeebe DM |
643 | my $maxwait = $self->{opts}->{lockwait} || $self->{lockwait}; |
644 | ||
eab837c4 DM |
645 | die "missimg UPID" if !$upid; # should not happen |
646 | ||
aaeeeebe DM |
647 | if (!open (SERVER_FLCK, ">>$lockfile")) { |
648 | debugmsg ('err', "can't open lock on file '$lockfile' - $!", undef, 1); | |
6ec9de44 | 649 | die "can't open lock on file '$lockfile' - $!"; |
aaeeeebe DM |
650 | } |
651 | ||
eab837c4 | 652 | if (!flock (SERVER_FLCK, LOCK_EX|LOCK_NB)) { |
aaeeeebe | 653 | |
eab837c4 DM |
654 | if (!$maxwait) { |
655 | debugmsg ('err', "can't aquire lock '$lockfile' (wait = 0)", undef, 1); | |
656 | die "can't aquire lock '$lockfile' (wait = 0)"; | |
657 | } | |
aaeeeebe | 658 | |
eab837c4 | 659 | debugmsg('info', "trying to get global lock - waiting...", undef, 1); |
aaeeeebe | 660 | |
eab837c4 DM |
661 | eval { |
662 | alarm ($maxwait * 60); | |
aaeeeebe | 663 | |
eab837c4 | 664 | local $SIG{ALRM} = sub { alarm (0); die "got timeout\n"; }; |
aaeeeebe | 665 | |
eab837c4 DM |
666 | if (!flock (SERVER_FLCK, LOCK_EX)) { |
667 | my $err = $!; | |
668 | close (SERVER_FLCK); | |
669 | alarm (0); | |
670 | die "$err\n"; | |
671 | } | |
aaeeeebe | 672 | alarm (0); |
eab837c4 | 673 | }; |
aaeeeebe | 674 | alarm (0); |
aaeeeebe | 675 | |
eab837c4 DM |
676 | my $err = $@; |
677 | ||
678 | if ($err) { | |
679 | debugmsg ('err', "can't aquire lock '$lockfile' - $err", undef, 1); | |
680 | die "can't aquire lock '$lockfile' - $err"; | |
681 | } | |
aaeeeebe | 682 | |
eab837c4 | 683 | debugmsg('info', "got global lock", undef, 1); |
aaeeeebe DM |
684 | } |
685 | ||
eab837c4 | 686 | PVE::Tools::file_set_contents($pidfile, $upid); |
aaeeeebe DM |
687 | } |
688 | ||
689 | sub run_hook_script { | |
690 | my ($self, $phase, $task, $logfd) = @_; | |
691 | ||
692 | my $opts = $self->{opts}; | |
693 | ||
694 | my $script = $opts->{script}; | |
695 | ||
696 | return if !$script; | |
697 | ||
698 | my $cmd = "$script $phase"; | |
699 | ||
700 | $cmd .= " $task->{mode} $task->{vmid}" if ($task); | |
701 | ||
702 | local %ENV; | |
703 | ||
28272ca2 DM |
704 | # set immutable opts directly (so they are available in all phases) |
705 | $ENV{STOREID} = $opts->{storage} if $opts->{storage}; | |
706 | $ENV{DUMPDIR} = $opts->{dumpdir} if $opts->{dumpdir}; | |
707 | ||
708 | foreach my $ek (qw(vmtype hostname tarfile logfile)) { | |
aaeeeebe DM |
709 | $ENV{uc($ek)} = $task->{$ek} if $task->{$ek}; |
710 | } | |
711 | ||
712 | run_command ($logfd, $cmd); | |
713 | } | |
714 | ||
d7550e09 | 715 | sub compressor_info { |
778d5b6d TL |
716 | my ($opts) = @_; |
717 | my $opt_compress = $opts->{compress}; | |
d7550e09 DM |
718 | |
719 | if (!$opt_compress || $opt_compress eq '0') { | |
720 | return undef; | |
721 | } elsif ($opt_compress eq '1' || $opt_compress eq 'lzo') { | |
722 | return ('lzop', 'lzo'); | |
723 | } elsif ($opt_compress eq 'gzip') { | |
778d5b6d TL |
724 | if ($opts->{pigz} > 0) { |
725 | # As default use int((#cores + 1)/2), we need #cores+1 for the case that #cores = 1 | |
726 | my $cores = POSIX::sysconf(84); | |
727 | my $pigz_threads = ($opts->{pigz} > 1) ? $opts->{pigz} : int(($cores + 1)/2); | |
728 | return ("pigz -p ${pigz_threads}", 'gz'); | |
729 | } else { | |
730 | return ('gzip', 'gz'); | |
731 | } | |
d7550e09 DM |
732 | } else { |
733 | die "internal error - unknown compression option '$opt_compress'"; | |
734 | } | |
735 | } | |
899b8373 DM |
736 | |
737 | sub get_backup_file_list { | |
738 | my ($dir, $bkname, $exclude_fn) = @_; | |
739 | ||
740 | my $bklist = []; | |
741 | foreach my $fn (<$dir/${bkname}-*>) { | |
742 | next if $exclude_fn && $fn eq $exclude_fn; | |
757fd3d5 | 743 | if ($fn =~ m!/(${bkname}-(\d{4})_(\d{2})_(\d{2})-(\d{2})_(\d{2})_(\d{2})\.(tgz|((tar|vma)(\.(gz|lzo))?)))$!) { |
899b8373 DM |
744 | $fn = "$dir/$1"; # untaint |
745 | my $t = timelocal ($7, $6, $5, $4, $3 - 1, $2 - 1900); | |
746 | push @$bklist, [$fn, $t]; | |
747 | } | |
748 | } | |
749 | ||
750 | return $bklist; | |
751 | } | |
d7550e09 | 752 | |
aaeeeebe DM |
753 | sub exec_backup_task { |
754 | my ($self, $task) = @_; | |
755 | ||
756 | my $opts = $self->{opts}; | |
757 | ||
758 | my $vmid = $task->{vmid}; | |
759 | my $plugin = $task->{plugin}; | |
760 | ||
761 | my $vmstarttime = time (); | |
762 | ||
763 | my $logfd; | |
764 | ||
765 | my $cleanup = {}; | |
766 | ||
767 | my $vmstoptime = 0; | |
768 | ||
769 | eval { | |
770 | die "unable to find VM '$vmid'\n" if !$plugin; | |
771 | ||
2de3ee58 TL |
772 | # for now we deny backups of a running ha managed service in *stop* mode |
773 | # as it interferes with the HA stack (enabled services should not stop). | |
774 | if ($opts->{mode} eq 'stop' && | |
775 | PVE::HA::Config::vm_is_ha_managed($vmid, 'enabled')) | |
776 | { | |
777 | die "Cannot execute a backup with stop mode on a HA managed and". | |
778 | " enabled Service. Use snapshot mode or disable the Service.\n"; | |
779 | } | |
780 | ||
aaeeeebe DM |
781 | my $vmtype = $plugin->type(); |
782 | ||
783 | my $tmplog = "$logdir/$vmtype-$vmid.log"; | |
784 | ||
785 | my $lt = localtime(); | |
786 | ||
787 | my $bkname = "vzdump-$vmtype-$vmid"; | |
788 | my $basename = sprintf "${bkname}-%04d_%02d_%02d-%02d_%02d_%02d", | |
789 | $lt->year + 1900, $lt->mon + 1, $lt->mday, | |
790 | $lt->hour, $lt->min, $lt->sec; | |
791 | ||
899b8373 DM |
792 | my $maxfiles = $opts->{maxfiles}; |
793 | ||
794 | if ($maxfiles && !$opts->{remove}) { | |
795 | my $bklist = get_backup_file_list($opts->{dumpdir}, $bkname); | |
796 | die "only $maxfiles backup(s) allowed - please consider to remove old backup files.\n" | |
797 | if scalar(@$bklist) >= $maxfiles; | |
798 | } | |
799 | ||
aaeeeebe DM |
800 | my $logfile = $task->{logfile} = "$opts->{dumpdir}/$basename.log"; |
801 | ||
757fd3d5 | 802 | my $ext = $vmtype eq 'qemu' ? '.vma' : '.tar'; |
778d5b6d | 803 | my ($comp, $comp_ext) = compressor_info($opts); |
d7550e09 DM |
804 | if ($comp && $comp_ext) { |
805 | $ext .= ".${comp_ext}"; | |
806 | } | |
aaeeeebe DM |
807 | |
808 | if ($opts->{stdout}) { | |
809 | $task->{tarfile} = '-'; | |
810 | } else { | |
811 | my $tarfile = $task->{tarfile} = "$opts->{dumpdir}/$basename$ext"; | |
812 | $task->{tmptar} = $task->{tarfile}; | |
813 | $task->{tmptar} =~ s/\.[^\.]+$/\.dat/; | |
814 | unlink $task->{tmptar}; | |
815 | } | |
816 | ||
817 | $task->{vmtype} = $vmtype; | |
818 | ||
819 | if ($opts->{tmpdir}) { | |
820 | $task->{tmpdir} = "$opts->{tmpdir}/vzdumptmp$$"; | |
821 | } else { | |
822 | # dumpdir is posix? then use it as temporary dir | |
5dc86eb8 | 823 | my $info = get_mount_info($opts->{dumpdir}); |
aaeeeebe DM |
824 | if ($vmtype eq 'qemu' || |
825 | grep ($_ eq $info->{fstype}, @posix_filesystems)) { | |
826 | $task->{tmpdir} = "$opts->{dumpdir}/$basename.tmp"; | |
827 | } else { | |
828 | $task->{tmpdir} = "/var/tmp/vzdumptmp$$"; | |
829 | debugmsg ('info', "filesystem type on dumpdir is '$info->{fstype}' -" . | |
830 | "using $task->{tmpdir} for temporary files", $logfd); | |
831 | } | |
832 | } | |
833 | ||
834 | rmtree $task->{tmpdir}; | |
835 | mkdir $task->{tmpdir}; | |
836 | -d $task->{tmpdir} || | |
837 | die "unable to create temporary directory '$task->{tmpdir}'"; | |
838 | ||
839 | $logfd = IO::File->new (">$tmplog") || | |
840 | die "unable to create log file '$tmplog'"; | |
841 | ||
842 | $task->{dumpdir} = $opts->{dumpdir}; | |
ff00abe6 | 843 | $task->{storeid} = $opts->{storage}; |
aaeeeebe DM |
844 | $task->{tmplog} = $tmplog; |
845 | ||
846 | unlink $logfile; | |
847 | ||
848 | debugmsg ('info', "Starting Backup of VM $vmid ($vmtype)", $logfd, 1); | |
849 | ||
850 | $plugin->set_logfd ($logfd); | |
851 | ||
852 | # test is VM is running | |
853 | my ($running, $status_text) = $plugin->vm_status ($vmid); | |
854 | ||
855 | debugmsg ('info', "status = ${status_text}", $logfd); | |
856 | ||
857 | # lock VM (prevent config changes) | |
858 | $plugin->lock_vm ($vmid); | |
859 | ||
860 | $cleanup->{unlock} = 1; | |
861 | ||
862 | # prepare | |
863 | ||
864 | my $mode = $running ? $opts->{mode} : 'stop'; | |
865 | ||
866 | if ($mode eq 'snapshot') { | |
867 | my %saved_task = %$task; | |
868 | eval { $plugin->prepare ($task, $vmid, $mode); }; | |
869 | if (my $err = $@) { | |
870 | die $err if $err !~ m/^mode failure/; | |
871 | debugmsg ('info', $err, $logfd); | |
872 | debugmsg ('info', "trying 'suspend' mode instead", $logfd); | |
873 | $mode = 'suspend'; # so prepare is called again below | |
874 | %$task = %saved_task; | |
875 | } | |
876 | } | |
877 | ||
878 | $task->{mode} = $mode; | |
879 | ||
880 | debugmsg ('info', "backup mode: $mode", $logfd); | |
881 | ||
882 | debugmsg ('info', "bandwidth limit: $opts->{bwlimit} KB/s", $logfd) | |
883 | if $opts->{bwlimit}; | |
884 | ||
885 | debugmsg ('info', "ionice priority: $opts->{ionice}", $logfd); | |
886 | ||
887 | if ($mode eq 'stop') { | |
888 | ||
889 | $plugin->prepare ($task, $vmid, $mode); | |
890 | ||
891 | $self->run_hook_script ('backup-start', $task, $logfd); | |
892 | ||
893 | if ($running) { | |
894 | debugmsg ('info', "stopping vm", $logfd); | |
895 | $vmstoptime = time (); | |
896 | $self->run_hook_script ('pre-stop', $task, $logfd); | |
897 | $plugin->stop_vm ($task, $vmid); | |
898 | $cleanup->{restart} = 1; | |
899 | } | |
900 | ||
901 | ||
902 | } elsif ($mode eq 'suspend') { | |
903 | ||
904 | $plugin->prepare ($task, $vmid, $mode); | |
905 | ||
906 | $self->run_hook_script ('backup-start', $task, $logfd); | |
907 | ||
8187f6b0 DM |
908 | if ($vmtype eq 'lxc') { |
909 | # pre-suspend rsync | |
910 | $plugin->copy_data_phase1($task, $vmid); | |
911 | } | |
912 | ||
aaeeeebe DM |
913 | debugmsg ('info', "suspend vm", $logfd); |
914 | $vmstoptime = time (); | |
915 | $self->run_hook_script ('pre-stop', $task, $logfd); | |
916 | $plugin->suspend_vm ($task, $vmid); | |
917 | $cleanup->{resume} = 1; | |
918 | ||
8187f6b0 DM |
919 | if ($vmtype eq 'lxc') { |
920 | # post-suspend rsync | |
921 | $plugin->copy_data_phase2($task, $vmid); | |
922 | ||
923 | debugmsg ('info', "resume vm", $logfd); | |
924 | $cleanup->{resume} = 0; | |
925 | $self->run_hook_script('pre-restart', $task, $logfd); | |
926 | $plugin->resume_vm($task, $vmid); | |
d5047243 | 927 | $self->run_hook_script('post-restart', $task, $logfd); |
8187f6b0 DM |
928 | my $delay = time () - $vmstoptime; |
929 | debugmsg('info', "vm is online again after $delay seconds", $logfd); | |
930 | } | |
931 | ||
aaeeeebe DM |
932 | } elsif ($mode eq 'snapshot') { |
933 | ||
c5be0f8c DM |
934 | $self->run_hook_script ('backup-start', $task, $logfd); |
935 | ||
aaeeeebe DM |
936 | my $snapshot_count = $task->{snapshot_count} || 0; |
937 | ||
938 | $self->run_hook_script ('pre-stop', $task, $logfd); | |
939 | ||
940 | if ($snapshot_count > 1) { | |
941 | debugmsg ('info', "suspend vm to make snapshot", $logfd); | |
942 | $vmstoptime = time (); | |
943 | $plugin->suspend_vm ($task, $vmid); | |
944 | $cleanup->{resume} = 1; | |
945 | } | |
946 | ||
947 | $plugin->snapshot ($task, $vmid); | |
948 | ||
949 | $self->run_hook_script ('pre-restart', $task, $logfd); | |
950 | ||
951 | if ($snapshot_count > 1) { | |
952 | debugmsg ('info', "resume vm", $logfd); | |
953 | $cleanup->{resume} = 0; | |
954 | $plugin->resume_vm ($task, $vmid); | |
955 | my $delay = time () - $vmstoptime; | |
956 | debugmsg ('info', "vm is online again after $delay seconds", $logfd); | |
957 | } | |
958 | ||
d5047243 FG |
959 | $self->run_hook_script ('post-restart', $task, $logfd); |
960 | ||
aaeeeebe DM |
961 | } else { |
962 | die "internal error - unknown mode '$mode'\n"; | |
963 | } | |
964 | ||
965 | # assemble archive image | |
966 | $plugin->assemble ($task, $vmid); | |
967 | ||
968 | # produce archive | |
969 | ||
970 | if ($opts->{stdout}) { | |
971 | debugmsg ('info', "sending archive to stdout", $logfd); | |
d7550e09 | 972 | $plugin->archive($task, $vmid, $task->{tmptar}, $comp); |
aaeeeebe DM |
973 | $self->run_hook_script ('backup-end', $task, $logfd); |
974 | return; | |
975 | } | |
976 | ||
977 | debugmsg ('info', "creating archive '$task->{tarfile}'", $logfd); | |
d7550e09 | 978 | $plugin->archive($task, $vmid, $task->{tmptar}, $comp); |
aaeeeebe DM |
979 | |
980 | rename ($task->{tmptar}, $task->{tarfile}) || | |
981 | die "unable to rename '$task->{tmptar}' to '$task->{tarfile}'\n"; | |
982 | ||
983 | # determine size | |
984 | $task->{size} = (-s $task->{tarfile}) || 0; | |
985 | my $cs = format_size ($task->{size}); | |
986 | debugmsg ('info', "archive file size: $cs", $logfd); | |
987 | ||
988 | # purge older backup | |
989 | ||
899b8373 DM |
990 | if ($maxfiles && $opts->{remove}) { |
991 | my $bklist = get_backup_file_list($opts->{dumpdir}, $bkname, $task->{tarfile}); | |
992 | $bklist = [ sort { $b->[1] <=> $a->[1] } @$bklist ]; | |
aaeeeebe | 993 | |
899b8373 DM |
994 | while (scalar (@$bklist) >= $maxfiles) { |
995 | my $d = pop @$bklist; | |
aaeeeebe DM |
996 | debugmsg ('info', "delete old backup '$d->[0]'", $logfd); |
997 | unlink $d->[0]; | |
998 | my $logfn = $d->[0]; | |
757fd3d5 | 999 | $logfn =~ s/\.(tgz|((tar|vma)(\.(gz|lzo))?))$/\.log/; |
aaeeeebe DM |
1000 | unlink $logfn; |
1001 | } | |
1002 | } | |
1003 | ||
1004 | $self->run_hook_script ('backup-end', $task, $logfd); | |
1005 | }; | |
1006 | my $err = $@; | |
1007 | ||
1008 | if ($plugin) { | |
1009 | # clean-up | |
1010 | ||
1011 | if ($cleanup->{unlock}) { | |
1012 | eval { $plugin->unlock_vm ($vmid); }; | |
1013 | warn $@ if $@; | |
1014 | } | |
1015 | ||
ca2605e7 DM |
1016 | if (defined($task->{mode})) { |
1017 | # only call cleanup when necessary (when prepare was executed) | |
1018 | eval { $plugin->cleanup ($task, $vmid) }; | |
1019 | warn $@ if $@; | |
1020 | } | |
aaeeeebe DM |
1021 | |
1022 | eval { $plugin->set_logfd (undef); }; | |
1023 | warn $@ if $@; | |
1024 | ||
1025 | if ($cleanup->{resume} || $cleanup->{restart}) { | |
1026 | eval { | |
1027 | $self->run_hook_script ('pre-restart', $task, $logfd); | |
1028 | if ($cleanup->{resume}) { | |
1029 | debugmsg ('info', "resume vm", $logfd); | |
1030 | $plugin->resume_vm ($task, $vmid); | |
1031 | } else { | |
757fd3d5 DM |
1032 | my $running = $plugin->vm_status($vmid); |
1033 | if (!$running) { | |
1034 | debugmsg ('info', "restarting vm", $logfd); | |
1035 | $plugin->start_vm ($task, $vmid); | |
1036 | } | |
d5047243 FG |
1037 | } |
1038 | $self->run_hook_script ('post-restart', $task, $logfd); | |
aaeeeebe DM |
1039 | }; |
1040 | my $err = $@; | |
1041 | if ($err) { | |
1042 | warn $err; | |
1043 | } else { | |
1044 | my $delay = time () - $vmstoptime; | |
1045 | debugmsg ('info', "vm is online again after $delay seconds", $logfd); | |
1046 | } | |
1047 | } | |
1048 | } | |
1049 | ||
1050 | eval { unlink $task->{tmptar} if $task->{tmptar} && -f $task->{tmptar}; }; | |
1051 | warn $@ if $@; | |
1052 | ||
fe6643b6 | 1053 | eval { rmtree $task->{tmpdir} if $task->{tmpdir} && -d $task->{tmpdir}; }; |
aaeeeebe DM |
1054 | warn $@ if $@; |
1055 | ||
1056 | my $delay = $task->{backuptime} = time () - $vmstarttime; | |
1057 | ||
1058 | if ($err) { | |
1059 | $task->{state} = 'err'; | |
1060 | $task->{msg} = $err; | |
1061 | debugmsg ('err', "Backup of VM $vmid failed - $err", $logfd, 1); | |
1062 | ||
1063 | eval { $self->run_hook_script ('backup-abort', $task, $logfd); }; | |
1064 | ||
1065 | } else { | |
1066 | $task->{state} = 'ok'; | |
1067 | my $tstr = format_time ($delay); | |
1068 | debugmsg ('info', "Finished Backup of VM $vmid ($tstr)", $logfd, 1); | |
1069 | } | |
1070 | ||
1071 | close ($logfd) if $logfd; | |
1072 | ||
1073 | if ($task->{tmplog} && $task->{logfile}) { | |
6cd97500 | 1074 | system {'cp'} 'cp', $task->{tmplog}, $task->{logfile}; |
aaeeeebe DM |
1075 | } |
1076 | ||
1077 | eval { $self->run_hook_script ('log-end', $task); }; | |
1078 | ||
1079 | die $err if $err && $err =~ m/^interrupted by signal$/; | |
1080 | } | |
1081 | ||
1082 | sub exec_backup { | |
d7550e09 | 1083 | my ($self, $rpcenv, $authuser) = @_; |
aaeeeebe DM |
1084 | |
1085 | my $opts = $self->{opts}; | |
1086 | ||
1087 | debugmsg ('info', "starting new backup job: $self->{cmdline}", undef, 1); | |
a7e42354 DM |
1088 | debugmsg ('info', "skip external VMs: " . join(', ', @{$self->{skiplist}})) |
1089 | if scalar(@{$self->{skiplist}}); | |
1090 | ||
aaeeeebe DM |
1091 | my $tasklist = []; |
1092 | ||
1093 | if ($opts->{all}) { | |
1094 | foreach my $plugin (@{$self->{plugins}}) { | |
1095 | my $vmlist = $plugin->vmlist(); | |
1096 | foreach my $vmid (sort @$vmlist) { | |
1097 | next if grep { $_ eq $vmid } @{$opts->{exclude}}; | |
98e84b16 | 1098 | next if !$rpcenv->check($authuser, "/vms/$vmid", [ 'VM.Backup' ], 1); |
aaeeeebe DM |
1099 | push @$tasklist, { vmid => $vmid, state => 'todo', plugin => $plugin }; |
1100 | } | |
1101 | } | |
1102 | } else { | |
1103 | foreach my $vmid (sort @{$opts->{vmids}}) { | |
1104 | my $plugin; | |
1105 | foreach my $pg (@{$self->{plugins}}) { | |
1106 | my $vmlist = $pg->vmlist(); | |
1107 | if (grep { $_ eq $vmid } @$vmlist) { | |
1108 | $plugin = $pg; | |
1109 | last; | |
1110 | } | |
1111 | } | |
98e84b16 | 1112 | $rpcenv->check($authuser, "/vms/$vmid", [ 'VM.Backup' ]); |
aaeeeebe DM |
1113 | push @$tasklist, { vmid => $vmid, state => 'todo', plugin => $plugin }; |
1114 | } | |
1115 | } | |
1116 | ||
44b21574 WB |
1117 | # Use in-memory files for the outer hook logs to pass them to sendmail. |
1118 | my $job_start_log = ''; | |
1119 | my $job_end_log = ''; | |
1120 | open my $job_start_fd, '>', \$job_start_log; | |
1121 | open my $job_end_fd, '>', \$job_end_log; | |
1122 | ||
aaeeeebe DM |
1123 | my $starttime = time(); |
1124 | my $errcount = 0; | |
1125 | eval { | |
1126 | ||
44b21574 | 1127 | $self->run_hook_script ('job-start', undef, $job_start_fd); |
aaeeeebe DM |
1128 | |
1129 | foreach my $task (@$tasklist) { | |
1130 | $self->exec_backup_task ($task); | |
1131 | $errcount += 1 if $task->{state} ne 'ok'; | |
1132 | } | |
1133 | ||
44b21574 | 1134 | $self->run_hook_script ('job-end', undef, $job_end_fd); |
aaeeeebe DM |
1135 | }; |
1136 | my $err = $@; | |
1137 | ||
44b21574 | 1138 | $self->run_hook_script ('job-abort', undef, $job_end_fd) if $err; |
aaeeeebe DM |
1139 | |
1140 | if ($err) { | |
1141 | debugmsg ('err', "Backup job failed - $err", undef, 1); | |
1142 | } else { | |
1143 | if ($errcount) { | |
1144 | debugmsg ('info', "Backup job finished with errors", undef, 1); | |
1145 | } else { | |
61ca4432 | 1146 | debugmsg ('info', "Backup job finished successfully", undef, 1); |
aaeeeebe DM |
1147 | } |
1148 | } | |
1149 | ||
44b21574 WB |
1150 | close $job_start_fd; |
1151 | close $job_end_fd; | |
1152 | ||
aaeeeebe DM |
1153 | my $totaltime = time() - $starttime; |
1154 | ||
44b21574 | 1155 | eval { $self->sendmail ($tasklist, $totaltime, undef, $job_start_log, $job_end_log); }; |
aaeeeebe | 1156 | debugmsg ('err', $@) if $@; |
4a4051d8 DM |
1157 | |
1158 | die $err if $err; | |
1159 | ||
1160 | die "job errors\n" if $errcount; | |
8682f6fc WL |
1161 | |
1162 | unlink $pidfile; | |
aaeeeebe DM |
1163 | } |
1164 | ||
ac27b58d | 1165 | |
47664cbe DM |
1166 | sub option_exists { |
1167 | my $key = shift; | |
1168 | return defined($confdesc->{$key}); | |
1169 | } | |
1170 | ||
ac27b58d DM |
1171 | # add JSON properties for create and set function |
1172 | sub json_config_properties { | |
1173 | my $prop = shift; | |
1174 | ||
1175 | foreach my $opt (keys %$confdesc) { | |
1176 | $prop->{$opt} = $confdesc->{$opt}; | |
1177 | } | |
1178 | ||
1179 | return $prop; | |
1180 | } | |
1181 | ||
31aef761 DM |
1182 | sub verify_vzdump_parameters { |
1183 | my ($param, $check_missing) = @_; | |
1184 | ||
1185 | raise_param_exc({ all => "option conflicts with option 'vmid'"}) | |
eab837c4 | 1186 | if $param->{all} && $param->{vmid}; |
31aef761 DM |
1187 | |
1188 | raise_param_exc({ exclude => "option conflicts with option 'vmid'"}) | |
1189 | if $param->{exclude} && $param->{vmid}; | |
1190 | ||
1191 | $param->{all} = 1 if defined($param->{exclude}); | |
1192 | ||
e2a2525e FG |
1193 | warn "option 'size' is deprecated and will be removed in a future " . |
1194 | "release, please update your script/configuration!\n" | |
1195 | if defined($param->{size}); | |
1196 | ||
31aef761 DM |
1197 | return if !$check_missing; |
1198 | ||
1199 | raise_param_exc({ vmid => "property is missing"}) | |
8682f6fc WL |
1200 | if !($param->{all} || $param->{stop}) && !$param->{vmid}; |
1201 | ||
1202 | } | |
1203 | ||
eab837c4 | 1204 | sub stop_running_backups { |
8682f6fc WL |
1205 | my($self) = @_; |
1206 | ||
eab837c4 DM |
1207 | my $upid = PVE::Tools::file_read_firstline($pidfile); |
1208 | return if !$upid; | |
8682f6fc | 1209 | |
eab837c4 | 1210 | my $task = PVE::Tools::upid_decode($upid); |
8682f6fc | 1211 | |
eab837c4 DM |
1212 | if (PVE::ProcFSTools::check_process_running($task->{pid}, $task->{pstart}) && |
1213 | PVE::ProcFSTools::read_proc_starttime($task->{pid}) == $task->{pstart}) { | |
1214 | kill(15, $task->{pid}); | |
1215 | # wait max 15 seconds to shut down (else, do nothing for now) | |
1216 | my $i; | |
1217 | for ($i = 15; $i > 0; $i--) { | |
1218 | last if !PVE::ProcFSTools::check_process_running(($task->{pid}, $task->{pstart})); | |
1219 | sleep (1); | |
1220 | } | |
1221 | die "stoping backup process $task->{pid} failed\n" if $i == 0; | |
8682f6fc | 1222 | } |
31aef761 DM |
1223 | } |
1224 | ||
1225 | sub command_line { | |
1226 | my ($param) = @_; | |
1227 | ||
1228 | my $cmd = "vzdump"; | |
1229 | ||
1230 | if ($param->{vmid}) { | |
1daa9380 | 1231 | $cmd .= " " . join(' ', PVE::Tools::split_list($param->{vmid})); |
31aef761 DM |
1232 | } |
1233 | ||
1234 | foreach my $p (keys %$param) { | |
4341db1d TL |
1235 | next if $p eq 'id' || $p eq 'vmid' || $p eq 'starttime' || |
1236 | $p eq 'dow' || $p eq 'stdout' || $p eq 'enabled'; | |
31aef761 DM |
1237 | my $v = $param->{$p}; |
1238 | my $pd = $confdesc->{$p} || die "no such vzdump option '$p'\n"; | |
f4a8bab4 DM |
1239 | if ($p eq 'exclude-path') { |
1240 | foreach my $path (split(/\0/, $v || '')) { | |
1241 | $cmd .= " --$p " . PVE::Tools::shellquote($path); | |
1242 | } | |
1243 | } else { | |
1244 | $cmd .= " --$p " . PVE::Tools::shellquote($v) if defined($v) && $v ne ''; | |
1245 | } | |
31aef761 DM |
1246 | } |
1247 | ||
1248 | return $cmd; | |
1249 | } | |
1250 | ||
e1bde280 DM |
1251 | # bash completion helpers |
1252 | sub complete_backup_storage { | |
1253 | ||
1254 | my $cfg = PVE::Storage::config(); | |
1255 | my $ids = $cfg->{ids}; | |
1256 | ||
1257 | my $nodename = PVE::INotify::nodename(); | |
1258 | ||
1259 | my $res = []; | |
1260 | foreach my $sid (keys %$ids) { | |
1261 | my $scfg = $ids->{$sid}; | |
1262 | next if !PVE::Storage::storage_check_enabled($cfg, $sid, $nodename, 1); | |
1263 | next if !$scfg->{content}->{backup}; | |
1264 | push @$res, $sid; | |
1265 | } | |
1266 | ||
1267 | return $res; | |
1268 | } | |
1269 | ||
aaeeeebe | 1270 | 1; |