5 use POSIX
qw(EINTR EEXIST EOPNOTSUPP);
7 use Socket
qw(AF_INET AF_INET6 AI_ALL AI_V4MAPPED AI_CANONNAME SOCK_DGRAM
11 use File
::Path
qw(make_path);
12 use Filesys
::Df
(); # don't overwrite our df()
18 use Fcntl
qw(:DEFAULT :flock);
25 use String
::ShellQuote
;
26 use Time
::HiRes
qw(usleep gettimeofday tv_interval alarm);
27 use Net
::DBus
qw(dbus_uint32 dbus_uint64);
28 use Net
::DBus
::Callback
;
29 use Net
::DBus
::Reactor
;
30 use Scalar
::Util
'weaken';
33 # avoid warning when parsing long hex values with hex()
34 no warnings
'portable'; # Support for 64-bit ints required
57 my $pvelogdir = "/var/log/pve";
58 my $pvetaskdir = "$pvelogdir/tasks";
63 my $IPV4OCTET = "(?:25[0-5]|(?:2[0-4]|1[0-9]|[1-9])?[0-9])";
64 our $IPV4RE = "(?:(?:$IPV4OCTET\\.){3}$IPV4OCTET)";
65 my $IPV6H16 = "(?:[0-9a-fA-F]{1,4})";
66 my $IPV6LS32 = "(?:(?:$IPV4RE|$IPV6H16:$IPV6H16))";
69 "(?:(?:" . "(?:$IPV6H16:){6})$IPV6LS32)|" .
70 "(?:(?:" . "::(?:$IPV6H16:){5})$IPV6LS32)|" .
71 "(?:(?:(?:" . "$IPV6H16)?::(?:$IPV6H16:){4})$IPV6LS32)|" .
72 "(?:(?:(?:(?:$IPV6H16:){0,1}$IPV6H16)?::(?:$IPV6H16:){3})$IPV6LS32)|" .
73 "(?:(?:(?:(?:$IPV6H16:){0,2}$IPV6H16)?::(?:$IPV6H16:){2})$IPV6LS32)|" .
74 "(?:(?:(?:(?:$IPV6H16:){0,3}$IPV6H16)?::(?:$IPV6H16:){1})$IPV6LS32)|" .
75 "(?:(?:(?:(?:$IPV6H16:){0,4}$IPV6H16)?::" . ")$IPV6LS32)|" .
76 "(?:(?:(?:(?:$IPV6H16:){0,5}$IPV6H16)?::" . ")$IPV6H16)|" .
77 "(?:(?:(?:(?:$IPV6H16:){0,6}$IPV6H16)?::" . ")))";
79 our $IPRE = "(?:$IPV4RE|$IPV6RE)";
81 use constant {CLONE_NEWNS
=> 0x00020000,
82 CLONE_NEWUTS
=> 0x04000000,
83 CLONE_NEWIPC
=> 0x08000000,
84 CLONE_NEWUSER
=> 0x10000000,
85 CLONE_NEWPID
=> 0x20000000,
86 CLONE_NEWNET
=> 0x40000000};
88 use constant {O_PATH
=> 0x00200000,
89 O_TMPFILE
=> 0x00410000}; # This includes O_DIRECTORY
91 sub run_with_timeout
{
92 my ($timeout, $code, @param) = @_;
94 die "got timeout\n" if $timeout <= 0;
96 my $prev_alarm = alarm 0; # suspend outer alarm early
103 local $SIG{ALRM
} = sub { $sigcount++; die "got timeout\n"; };
104 local $SIG{PIPE
} = sub { $sigcount++; die "broken pipe\n" };
105 local $SIG{__DIE__
}; # see SA bug 4631
109 eval { $res = &$code(@param); };
111 alarm(0); # avoid race conditions
120 # this shouldn't happen anymore?
121 die "unknown error" if $sigcount && !$err; # seems to happen sometimes
128 # flock: we use one file handle per process, so lock file
129 # can be nested multiple times and succeeds for the same process.
131 # Since this is the only way we lock now and we don't have the old
132 # 'lock(); code(); unlock();' pattern anymore we do not actually need to
133 # count how deep we're nesting. Therefore this hash now stores a weak reference
134 # to a boolean telling us whether we already have a lock.
136 my $lock_handles = {};
139 my ($filename, $timeout, $shared, $code, @param) = @_;
141 $timeout = 10 if !$timeout;
143 my $mode = $shared ? LOCK_SH
: LOCK_EX
;
145 my $lockhash = ($lock_handles->{$$} //= {});
147 # Returns a locked file handle.
148 my $get_locked_file = sub {
149 my $fh = IO
::File-
>new(">>$filename")
150 or die "can't open file - $!\n";
152 if (!flock($fh, $mode|LOCK_NB
)) {
153 print STDERR
"trying to acquire lock...\n";
156 $success = flock($fh, $mode);
157 # try again on EINTR (see bug #273)
158 if ($success || ($! != EINTR
)) {
163 print STDERR
" failed\n";
164 die "can't acquire lock '$filename' - $!\n";
166 print STDERR
" OK\n";
173 my $checkptr = $lockhash->{$filename};
174 my $check = 0; # This must not go out of scope before running the code.
175 my $local_fh; # This must stay local
176 if (!$checkptr || !$$checkptr) {
177 # We cannot create a weak reference in a single atomic step, so we first
178 # create a false-value, then create a reference to it, then weaken it,
179 # and after successfully locking the file we change the boolean value.
181 # The reason for this is that if an outer SIGALRM throws an exception
182 # between creating the reference and weakening it, a subsequent call to
183 # lock_file_full() will see a leftover full reference to a valid
184 # variable. This variable must be 0 in order for said call to attempt to
185 # lock the file anew.
187 # An externally triggered exception elsewhere in the code will cause the
188 # weak reference to become 'undef', and since the file handle is only
189 # stored in the local scope in $local_fh, the file will be closed by
190 # perl's cleanup routines as well.
192 # This still assumes that an IO::File handle can properly deal with such
193 # exceptions thrown during its own destruction, but that's up to perls
195 $lockhash->{$filename} = \
$check;
196 weaken
$lockhash->{$filename};
197 $local_fh = eval { run_with_timeout
($timeout, $get_locked_file) };
199 $@ = "can't lock file '$filename' - $@";
204 $res = eval { &$code(@param); };
211 my ($filename, $timeout, $code, @param) = @_;
213 return lock_file_full
($filename, $timeout, 0, $code, @param);
216 sub file_set_contents
{
217 my ($filename, $data, $perm) = @_;
219 $perm = 0644 if !defined($perm);
221 my $tmpname = "$filename.tmp.$$";
224 my ($fh, $tries) = (undef, 0);
225 while (!$fh && $tries++ < 3) {
226 $fh = IO
::File-
>new($tmpname, O_WRONLY
|O_CREAT
|O_EXCL
, $perm);
227 if (!$fh && $! == EEXIST
) {
228 unlink($tmpname) or die "unable to delete old temp file: $!\n";
231 die "unable to open file '$tmpname' - $!\n" if !$fh;
232 die "unable to write '$tmpname' - $!\n" unless print $fh $data;
233 die "closing file '$tmpname' failed - $!\n" unless close $fh;
242 if (!rename($tmpname, $filename)) {
243 my $msg = "close (rename) atomic file '$filename' failed: $!\n";
249 sub file_get_contents
{
250 my ($filename, $max) = @_;
252 my $fh = IO
::File-
>new($filename, "r") ||
253 die "can't open '$filename' - $!\n";
255 my $content = safe_read_from
($fh, $max, 0, $filename);
263 my ($filename, $dst, $max, $perm) = @_;
265 file_set_contents
($dst, file_get_contents
($filename, $max), $perm);
268 sub file_read_firstline
{
271 my $fh = IO
::File-
>new ($filename, "r");
272 return undef if !$fh;
280 my ($fh, $max, $oneline, $filename) = @_;
282 $max = 32768 if !$max;
284 my $subject = defined($filename) ?
"file '$filename'" : 'input';
289 while ($count = sysread($fh, $input, 8192, $br)) {
291 die "$subject too long - aborting\n" if $br > $max;
292 if ($oneline && $input =~ m/^(.*)\n/) {
297 die "unable to read $subject - $!\n" if !defined($count);
302 # The $cmd parameter can be:
304 # This is generally executed by passing it to the shell with the -c option.
305 # However, it can be executed in one of two ways, depending on whether
306 # there's a pipe involved:
307 # *) with pipe: passed explicitly to bash -c, prefixed with:
309 # *) without a pipe: passed to perl's open3 which uses 'sh -c'
310 # (Note that this may result in two different syntax requirements!)
312 # -) an array of arguments (strings)
313 # Will be executed without interference from a shell. (Parameters are passed
314 # as is, no escape sequences of strings will be touched.)
315 # -) an array of arrays
316 # Each array represents a command, and each command's output is piped into
317 # the following command's standard input.
318 # For this a shell command string is created with pipe symbols between each
320 # Each command is a list of strings meant to end up in the final command
321 # unchanged. In order to achieve this, every argument is shell-quoted.
322 # Quoting can be disabled for a particular argument by turning it into a
323 # reference, this allows inserting arbitrary shell options.
324 # For instance: the $cmd [ [ 'echo', 'hello', \'>/dev/null' ] ] will not
325 # produce any output, while the $cmd [ [ 'echo', 'hello', '>/dev/null' ] ]
326 # will literally print: hello >/dev/null
328 my ($cmd, %param) = @_;
333 if (my $ref = ref($cmd)) {
334 if (ref($cmd->[0])) {
335 $cmdstr = 'set -o pipefail && ';
337 foreach my $command (@$cmd) {
338 # concatenate quoted parameters
339 # strings which are passed by reference are NOT shell quoted
340 $cmdstr .= $pipe . join(' ', map { ref($_) ?
$$_ : shellquote
($_) } @$command);
343 $cmd = [ '/bin/bash', '-c', "$cmdstr" ];
345 $cmdstr = cmd2string
($cmd);
350 # see 'man bash' for option pipefail
351 $cmd = [ '/bin/bash', '-c', "set -o pipefail && $cmd" ];
376 foreach my $p (keys %param) {
377 if ($p eq 'timeout') {
378 $timeout = $param{$p};
379 } elsif ($p eq 'umask') {
380 $old_umask = umask($param{$p});
381 } elsif ($p eq 'errmsg') {
382 $errmsg = $param{$p};
383 } elsif ($p eq 'input') {
385 } elsif ($p eq 'output') {
386 $output = $param{$p};
387 } elsif ($p eq 'outfunc') {
388 $outfunc = $param{$p};
389 } elsif ($p eq 'errfunc') {
390 $errfunc = $param{$p};
391 } elsif ($p eq 'logfunc') {
392 $logfunc = $param{$p};
393 } elsif ($p eq 'afterfork') {
394 $afterfork = $param{$p};
395 } elsif ($p eq 'noerr') {
397 } elsif ($p eq 'keeplocale') {
398 $keeplocale = $param{$p};
399 } elsif ($p eq 'quiet') {
402 die "got unknown parameter '$p' for run_command\n";
407 my $origerrfunc = $errfunc;
411 &$origerrfunc("$laststderr\n");
413 print STDERR
"$laststderr\n" if $laststderr;
420 my $reader = $output && $output =~ m/^>&/ ?
$output : IO
::File-
>new();
421 my $writer = $input && $input =~ m/^<&/ ?
$input : IO
::File-
>new();
422 my $error = IO
::File-
>new();
427 local $ENV{LC_ALL
} = 'C' if !$keeplocale;
429 # suppress LVM warnings like: "File descriptor 3 left open";
430 local $ENV{LVM_SUPPRESS_FD_WARNINGS
} = "1";
432 $pid = open3
($writer, $reader, $error, @$cmd) || die $!;
434 # if we pipe fron STDIN, open3 closes STDIN, so we we
435 # a perl warning "Filehandle STDIN reopened as GENXYZ .. "
436 # as soon as we open a new file.
437 # to avoid that we open /dev/null
438 if (!ref($writer) && !defined(fileno(STDIN
))) {
440 open(STDIN
, "</dev/null");
447 if ($orig_pid != $$) {
455 local $SIG{ALRM
} = sub { die "got timeout\n"; } if $timeout;
456 $oldtimeout = alarm($timeout) if $timeout;
458 &$afterfork() if $afterfork;
461 print $writer $input if defined $input;
465 my $select = new IO
::Select
;
466 $select->add($reader) if ref($reader);
467 $select->add($error);
472 my $starttime = time();
474 while ($select->count) {
475 my @handles = $select->can_read(1);
477 foreach my $h (@handles) {
479 my $count = sysread ($h, $buf, 4096);
480 if (!defined ($count)) {
486 $select->remove ($h) if !$count;
488 if ($outfunc || $logfunc) {
491 while ($outlog =~ s/^([^\010\r\n]*)(\r|\n|(\010)+|\r\n)//s) {
493 &$outfunc($line) if $outfunc;
494 &$logfunc($line) if $logfunc;
507 } elsif ($h eq $error) {
508 if ($errfunc || $logfunc) {
511 while ($errlog =~ s/^([^\010\r\n]*)(\r|\n|(\010)+|\r\n)//s) {
513 &$errfunc($line) if $errfunc;
514 &$logfunc($line) if $logfunc;
531 &$outfunc($outlog) if $outfunc && $outlog;
532 &$logfunc($outlog) if $logfunc && $outlog;
534 &$errfunc($errlog) if $errfunc && $errlog;
535 &$logfunc($errlog) if $logfunc && $errlog;
540 die "failed to execute\n";
541 } elsif (my $sig = ($? & 127)) {
542 die "got signal $sig\n";
543 } elsif ($exitcode = ($? >> 8)) {
544 if (!($exitcode == 24 && ($cmdstr =~ m
|^(\S
+/)?rsync\s
|))) {
545 if ($errmsg && $laststderr) {
546 my $lerr = $laststderr;
550 die "exit code $exitcode\n";
561 if ($errmsg && $laststderr) {
562 &$errfunc(undef); # flush laststderr
565 umask ($old_umask) if defined($old_umask);
567 alarm($oldtimeout) if $oldtimeout;
570 if ($pid && ($err eq "got timeout\n")) {
573 die "command '$cmdstr' failed: $err";
577 $err =~ s/^usermod:\s*// if $cmdstr =~ m
|^(\S
+/)?usermod\s
|;
580 die "command '$cmdstr' failed: $err";
587 # Run a command with a tcp socket as standard input.
588 sub pipe_socket_to_command
{
589 my ($cmd, $ip, $port) = @_;
594 Proto
=> &Socket
::IPPROTO_TCP
,
595 GetAddrInfoFlags
=> 0,
599 my $socket = IO
::Socket
::IP-
>new(%$params) or die "failed to open socket: $!\n";
601 print "$ip\n$port\n"; # tell remote where to connect
605 local $SIG{ALRM
} = sub { die "timed out waiting for client\n" };
607 my $client = $socket->accept; # Wait for a client
611 # We want that the command talks over the TCP socket and takes
612 # ownership of it, so that when it closes it the connection is
613 # terminated, so we need to be able to close the socket. So we
614 # can't really use PVE::Tools::run_command().
615 my $pid = fork() // die "fork failed: $!\n";
617 POSIX
::dup2
(fileno($client), 0);
618 POSIX
::dup2
(fileno($client), 1);
620 exec {$cmd->[0]} @$cmd or do {
621 warn "exec failed: $!\n";
627 if (waitpid($pid, 0) != $pid) {
628 kill(15 => $pid); # if we got interrupted terminate the child
630 while (waitpid($pid, POSIX
::WNOHANG
) != $pid) {
633 kill(9 => $pid), last if $count > 300; # 30 second timeout
636 if (my $sig = ($? & 127)) {
637 die "got signal $sig\n";
638 } elsif (my $exitcode = ($? >> 8)) {
639 die "exit code $exitcode\n";
646 my $listtxt = shift || '';
648 return split (/\0/, $listtxt) if $listtxt =~ m/\0/;
650 $listtxt =~ s/[,;]/ /g;
651 $listtxt =~ s/^\s+//;
653 my @data = split (/\s+/, $listtxt);
661 return $txt if !defined($txt);
669 # simple uri templates like "/vms/{vmid}"
670 sub template_replace
{
671 my ($tmpl, $data) = @_;
673 return $tmpl if !$tmpl;
676 while ($tmpl =~ m/([^{]+)?({([^}]+)})?/g) {
678 $res .= ($data->{$3} || '-') if $2;
684 my ($filename, $fh, $data) = @_;
688 my $res = print $fh $data;
690 die "write to '$filename' failed\n" if !$res;
696 'at' => 'ftp.at.debian.org',
697 'au' => 'ftp.au.debian.org',
698 'be' => 'ftp.be.debian.org',
699 'bg' => 'ftp.bg.debian.org',
700 'br' => 'ftp.br.debian.org',
701 'ca' => 'ftp.ca.debian.org',
702 'ch' => 'ftp.ch.debian.org',
703 'cl' => 'ftp.cl.debian.org',
704 'cz' => 'ftp.cz.debian.org',
705 'de' => 'ftp.de.debian.org',
706 'dk' => 'ftp.dk.debian.org',
707 'ee' => 'ftp.ee.debian.org',
708 'es' => 'ftp.es.debian.org',
709 'fi' => 'ftp.fi.debian.org',
710 'fr' => 'ftp.fr.debian.org',
711 'gr' => 'ftp.gr.debian.org',
712 'hk' => 'ftp.hk.debian.org',
713 'hr' => 'ftp.hr.debian.org',
714 'hu' => 'ftp.hu.debian.org',
715 'ie' => 'ftp.ie.debian.org',
716 'is' => 'ftp.is.debian.org',
717 'it' => 'ftp.it.debian.org',
718 'jp' => 'ftp.jp.debian.org',
719 'kr' => 'ftp.kr.debian.org',
720 'mx' => 'ftp.mx.debian.org',
721 'nl' => 'ftp.nl.debian.org',
722 'no' => 'ftp.no.debian.org',
723 'nz' => 'ftp.nz.debian.org',
724 'pl' => 'ftp.pl.debian.org',
725 'pt' => 'ftp.pt.debian.org',
726 'ro' => 'ftp.ro.debian.org',
727 'ru' => 'ftp.ru.debian.org',
728 'se' => 'ftp.se.debian.org',
729 'si' => 'ftp.si.debian.org',
730 'sk' => 'ftp.sk.debian.org',
731 'tr' => 'ftp.tr.debian.org',
732 'tw' => 'ftp.tw.debian.org',
733 'gb' => 'ftp.uk.debian.org',
734 'us' => 'ftp.us.debian.org',
739 'dk' => ['Danish', 'da', 'qwerty/dk-latin1.kmap.gz', 'dk', 'nodeadkeys'],
740 'de' => ['German', 'de', 'qwertz/de-latin1-nodeadkeys.kmap.gz', 'de', 'nodeadkeys' ],
741 'de-ch' => ['Swiss-German', 'de-ch', 'qwertz/sg-latin1.kmap.gz', 'ch', 'de_nodeadkeys' ],
742 'en-gb' => ['United Kingdom', 'en-gb', 'qwerty/uk.kmap.gz' , 'gb', undef],
743 'en-us' => ['U.S. English', 'en-us', 'qwerty/us-latin1.kmap.gz', 'us', undef ],
744 'es' => ['Spanish', 'es', 'qwerty/es.kmap.gz', 'es', 'nodeadkeys'],
745 #'et' => [], # Ethopia or Estonia ??
746 'fi' => ['Finnish', 'fi', 'qwerty/fi-latin1.kmap.gz', 'fi', 'nodeadkeys'],
747 #'fo' => ['Faroe Islands', 'fo', ???, 'fo', 'nodeadkeys'],
748 'fr' => ['French', 'fr', 'azerty/fr-latin1.kmap.gz', 'fr', 'nodeadkeys'],
749 'fr-be' => ['Belgium-French', 'fr-be', 'azerty/be2-latin1.kmap.gz', 'be', 'nodeadkeys'],
750 'fr-ca' => ['Canada-French', 'fr-ca', 'qwerty/cf.kmap.gz', 'ca', 'fr-legacy'],
751 'fr-ch' => ['Swiss-French', 'fr-ch', 'qwertz/fr_CH-latin1.kmap.gz', 'ch', 'fr_nodeadkeys'],
752 #'hr' => ['Croatia', 'hr', 'qwertz/croat.kmap.gz', 'hr', ??], # latin2?
753 'hu' => ['Hungarian', 'hu', 'qwertz/hu.kmap.gz', 'hu', undef],
754 'is' => ['Icelandic', 'is', 'qwerty/is-latin1.kmap.gz', 'is', 'nodeadkeys'],
755 'it' => ['Italian', 'it', 'qwerty/it2.kmap.gz', 'it', 'nodeadkeys'],
756 'jp' => ['Japanese', 'ja', 'qwerty/jp106.kmap.gz', 'jp', undef],
757 'lt' => ['Lithuanian', 'lt', 'qwerty/lt.kmap.gz', 'lt', 'std'],
758 #'lv' => ['Latvian', 'lv', 'qwerty/lv-latin4.kmap.gz', 'lv', ??], # latin4 or latin7?
759 'mk' => ['Macedonian', 'mk', 'qwerty/mk.kmap.gz', 'mk', 'nodeadkeys'],
760 'nl' => ['Dutch', 'nl', 'qwerty/nl.kmap.gz', 'nl', undef],
761 #'nl-be' => ['Belgium-Dutch', 'nl-be', ?, ?, ?],
762 'no' => ['Norwegian', 'no', 'qwerty/no-latin1.kmap.gz', 'no', 'nodeadkeys'],
763 'pl' => ['Polish', 'pl', 'qwerty/pl.kmap.gz', 'pl', undef],
764 'pt' => ['Portuguese', 'pt', 'qwerty/pt-latin1.kmap.gz', 'pt', 'nodeadkeys'],
765 'pt-br' => ['Brazil-Portuguese', 'pt-br', 'qwerty/br-latin1.kmap.gz', 'br', 'nodeadkeys'],
766 #'ru' => ['Russian', 'ru', 'qwerty/ru.kmap.gz', 'ru', undef], # dont know?
767 'si' => ['Slovenian', 'sl', 'qwertz/slovene.kmap.gz', 'si', undef],
768 'se' => ['Swedish', 'sv', 'qwerty/se-latin1.kmap.gz', 'se', 'nodeadkeys'],
770 'tr' => ['Turkish', 'tr', 'qwerty/trq.kmap.gz', 'tr', undef],
773 my $kvmkeymaparray = [];
774 foreach my $lc (sort keys %$keymaphash) {
775 push @$kvmkeymaparray, $keymaphash->{$lc}->[1];
783 return $kvmkeymaparray;
787 my ($param, $key) = @_;
789 my $res = $param->{$key};
790 delete $param->{$key};
795 # Note: we use this to wait until vncterm/spiceterm is ready
796 sub wait_for_vnc_port
{
797 my ($port, $family, $timeout) = @_;
799 $timeout = 5 if !$timeout;
801 my $starttime = [gettimeofday
];
804 my $cmd = ['/bin/ss', '-Htln', "sport = :$port"];
805 push @$cmd, $family == AF_INET6 ?
'-6' : '-4' if defined($family);
808 while (($elapsed = tv_interval
($starttime)) < $timeout) {
809 # -Htln = don't print header, tcp, listening sockets only, numeric ports
810 run_command
($cmd, outfunc
=> sub {
812 if ($line =~ m/^LISTEN\s+\d+\s+\d+\s+\S+:(\d+)\s/) {
813 $found = 1 if ($port == $1);
817 $sleeptime += 100000 if $sleeptime < 1000000;
821 die "Timeout while waiting for port '$port' to get ready!\n";
824 sub next_unused_port
{
825 my ($range_start, $range_end, $family, $address) = @_;
827 # We use a file to register allocated ports.
828 # Those registrations expires after $expiretime.
829 # We use this to avoid race conditions between
830 # allocation and use of ports.
832 my $filename = "/var/tmp/pve-reserved-ports";
841 if (my $fh = IO
::File-
>new ($filename, "r")) {
842 while (my $line = <$fh>) {
843 if ($line =~ m/^(\d+)\s(\d+)$/) {
844 my ($port, $timestamp) = ($1, $2);
845 if (($timestamp + $expiretime) > $ctime) {
846 $ports->{$port} = $timestamp; # not expired
853 my %sockargs = (Listen
=> 5,
856 Proto
=> IPPROTO_TCP
,
857 GetAddrInfoFlags
=> 0);
858 $sockargs{LocalAddr
} = $address if defined($address);
860 for (my $p = $range_start; $p < $range_end; $p++) {
861 next if $ports->{$p}; # reserved
863 $sockargs{LocalPort
} = $p;
864 my $sock = IO
::Socket
::IP-
>new(%sockargs);
869 $ports->{$p} = $ctime;
875 foreach my $p (keys %$ports) {
876 $data .= "$p $ports->{$p}\n";
879 file_set_contents
($filename, $data);
884 my $p = lock_file
('/var/lock/pve-ports.lck', 10, $code);
887 die "unable to find free port (${range_start}-${range_end})\n" if !$p;
892 sub next_migrate_port
{
893 my ($family, $address) = @_;
894 return next_unused_port
(60000, 60050, $family, $address);
898 my ($family, $address) = @_;
899 return next_unused_port
(5900, 6000, $family, $address);
902 sub next_spice_port
{
903 my ($family, $address) = @_;
904 return next_unused_port
(61000, 61099, $family, $address);
907 # sigkill after $timeout a $sub running in a fork if it can't write a pipe
908 # the $sub has to return a single scalar
909 sub run_fork_with_timeout
{
910 my ($timeout, $sub) = @_;
914 my $pipe_out = IO
::Pipe-
>new();
916 # disable pending alarms, save their remaining time
917 my $prev_alarm = alarm 0;
919 # avoid leaving a zombie if the parent gets interrupted
921 local $SIG{INT
} = sub { $sig_received++; };
924 if (!defined($child)) {
925 die "fork failed: $!\n";
934 print {$pipe_out} encode_json
({ result
=> $res });
938 print {$pipe_out} encode_json
({ error
=> $err });
947 my $readvalues = sub {
949 my $child_res = decode_json
(scalar<$pipe_out>);
950 $res = $child_res->{result
};
951 $error = $child_res->{error
};
954 if (defined($timeout)) {
955 run_with_timeout
($timeout, $readvalues);
962 kill('KILL', $child);
966 die "interrupted by unexpected signal\n" if $sig_received;
968 die $error if $error;
974 return run_fork_with_timeout
(undef, $code);
977 # NOTE: NFS syscall can't be interrupted, so alarm does
978 # not work to provide timeouts.
979 # from 'man nfs': "Only SIGKILL can interrupt a pending NFS operation"
980 # So fork() before using Filesys::Df
982 my ($path, $timeout) = @_;
990 my $pipe = IO
::Pipe-
>new();
992 if (!defined($child)) {
993 warn "fork failed: $!\n";
1000 my $df = Filesys
::Df
::df
($path, 1);
1001 print {$pipe} "$df->{blocks}\n$df->{used}\n$df->{bavail}\n"
1014 my $readvalues = sub {
1015 $res->{total
} = int(((<$pipe> // 0) =~ /^(\d*)$/)[0]);
1016 $res->{used
} = int(((<$pipe> // 0) =~ /^(\d*)$/)[0]);
1017 $res->{avail
} = int(((<$pipe> // 0) =~ /^(\d*)$/)[0]);
1020 run_with_timeout
($timeout, $readvalues);
1024 kill('KILL', $child);
1030 # We use this to uniquely identify a process.
1031 # An 'Unique Process ID' has the following format:
1032 # "UPID:$node:$pid:$pstart:$startime:$dtype:$id:$user"
1037 # Note: pstart can be > 32bit if uptime > 497 days, so this can result in
1038 # more that 8 characters for pstart
1039 return sprintf("UPID:%s:%08X:%08X:%08X:%s:%s:%s:", $d->{node
}, $d->{pid
},
1040 $d->{pstart
}, $d->{starttime
}, $d->{type
}, $d->{id
},
1045 my ($upid, $noerr) = @_;
1050 # "UPID:$node:$pid:$pstart:$startime:$dtype:$id:$user"
1051 # Note: allow up to 9 characters for pstart (work until 20 years uptime)
1052 if ($upid =~ m/^UPID:([a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?):([0-9A-Fa-f]{8}):([0-9A-Fa-f]{8,9}):([0-9A-Fa-f]{8}):([^:\s]+):([^:\s]*):([^:\s]+):$/) {
1054 $res->{pid
} = hex($3);
1055 $res->{pstart
} = hex($4);
1056 $res->{starttime
} = hex($5);
1061 my $subdir = substr($5, 7, 8);
1062 $filename = "$pvetaskdir/$subdir/$upid";
1065 return undef if $noerr;
1066 die "unable to parse worker upid '$upid'\n";
1069 return wantarray ?
($res, $filename) : $res;
1075 my ($task, $filename) = upid_decode
($upid);
1077 my $dirname = dirname
($filename);
1078 make_path
($dirname);
1080 my $wwwid = getpwnam('www-data') ||
1081 die "getpwnam failed";
1085 my $outfh = IO
::File-
>new ($filename, O_WRONLY
|O_CREAT
|O_EXCL
, $perm) ||
1086 die "unable to create output file '$filename' - $!\n";
1087 chown $wwwid, -1, $outfh;
1092 sub upid_read_status
{
1095 my ($task, $filename) = upid_decode
($upid);
1096 my $fh = IO
::File-
>new($filename, "r");
1097 return "unable to open file - $!" if !$fh;
1099 sysseek($fh, -$maxlen, 2);
1101 my $br = sysread($fh, $readbuf, $maxlen);
1104 return "unable to extract last line"
1105 if $readbuf !~ m/\n?(.+)$/;
1107 if ($line =~ m/^TASK OK$/) {
1109 } elsif ($line =~ m/^TASK ERROR: (.+)$/) {
1112 return "unexpected status";
1115 return "unable to read tail (got $br bytes)";
1118 # useful functions to store comments in config files
1122 # all control and hi-bit characters, and ':'
1123 my $unsafe = "^\x20-\x39\x3b-\x7e";
1124 return uri_escape
(Encode
::encode
("utf8", $text), $unsafe);
1130 return Encode
::decode
("utf8", uri_unescape
($data));
1133 # depreciated - do not use!
1134 # we now decode all parameters by default
1135 sub decode_utf8_parameters
{
1138 foreach my $p (qw(comment description firstname lastname)) {
1139 $param->{$p} = decode
('utf8', $param->{$p}) if $param->{$p};
1145 sub random_ether_addr
{
1148 my ($seconds, $microseconds) = gettimeofday
;
1150 my $rand = Digest
::SHA
::sha1
($$, rand(), $seconds, $microseconds);
1152 # clear multicast, set local id
1153 vec($rand, 0, 8) = (vec($rand, 0, 8) & 0xfe) | 2;
1155 my $addr = sprintf("%02X:%02X:%02X:%02X:%02X:%02X", unpack("C6", $rand));
1156 if (defined($prefix)) {
1157 $addr = uc($prefix) . substr($addr, length($prefix));
1165 return String
::ShellQuote
::shell_quote
($str);
1171 die "no arguments" if !$cmd;
1173 return $cmd if !ref($cmd);
1176 foreach my $arg (@$cmd) { push @qa, shellquote
($arg); }
1178 return join (' ', @qa);
1181 # split an shell argument string into an array,
1185 return $str ?
[ Text
::ParseWords
::shellwords
($str) ] : [];
1189 my ($filename, $start, $limit, $filter) = @_;
1194 my $fh = IO
::File-
>new($filename, "r");
1197 push @$lines, { n
=> $count, t
=> "unable to open file - $!"};
1198 return ($count, $lines);
1201 $start = 0 if !$start;
1202 $limit = 50 if !$limit;
1207 # duplicate code, so that we do not slow down normal path
1208 while (defined($line = <$fh>)) {
1209 next if $line !~ m/$filter/;
1210 next if $count++ < $start;
1211 next if $limit <= 0;
1213 push @$lines, { n
=> $count, t
=> $line};
1217 while (defined($line = <$fh>)) {
1218 next if $count++ < $start;
1219 next if $limit <= 0;
1221 push @$lines, { n
=> $count, t
=> $line};
1228 # HACK: ExtJS store.guaranteeRange() does not like empty array
1232 push @$lines, { n
=> $count, t
=> "no content"};
1235 return ($count, $lines);
1239 my ($start, $limit, $since, $until, $service) = @_;
1244 $start = 0 if !$start;
1245 $limit = 50 if !$limit;
1250 return if $count++ < $start;
1251 return if $limit <= 0;
1252 push @$lines, { n
=> int($count), t
=> $line};
1256 my $cmd = ['journalctl', '-o', 'short', '--no-pager'];
1258 push @$cmd, '--unit', $service if $service;
1259 push @$cmd, '--since', $since if $since;
1260 push @$cmd, '--until', $until if $until;
1261 run_command
($cmd, outfunc
=> $parser);
1263 # HACK: ExtJS store.guaranteeRange() does not like empty array
1267 push @$lines, { n
=> $count, t
=> "no content"};
1270 return ($count, $lines);
1273 sub dir_glob_regex
{
1274 my ($dir, $regex) = @_;
1276 my $dh = IO
::Dir-
>new ($dir);
1277 return wantarray ?
() : undef if !$dh;
1279 while (defined(my $tmp = $dh->read)) {
1280 if (my @res = $tmp =~ m/^($regex)$/) {
1282 return wantarray ?
@res : $tmp;
1287 return wantarray ?
() : undef;
1290 sub dir_glob_foreach
{
1291 my ($dir, $regex, $func) = @_;
1293 my $dh = IO
::Dir-
>new ($dir);
1295 while (defined(my $tmp = $dh->read)) {
1296 if (my @res = $tmp =~ m/^($regex)$/) {
1303 sub assert_if_modified
{
1304 my ($digest1, $digest2) = @_;
1306 if ($digest1 && $digest2 && ($digest1 ne $digest2)) {
1307 die "detected modified configuration - file changed by other user? Try again.\n";
1311 # Digest for short strings
1312 # like FNV32a, but we only return 31 bits (positive numbers)
1316 my $hval = 0x811c9dc5;
1318 foreach my $c (unpack('C*', $string)) {
1326 $hval = $hval & 0xffffffff;
1328 return $hval & 0x7fffffff;
1331 sub fnv31a_hex
{ return sprintf("%X", fnv31a
(@_)); }
1333 sub unpack_sockaddr_in46
{
1335 my $family = Socket
::sockaddr_family
($sin);
1336 my ($port, $host) = ($family == AF_INET6 ? Socket
::unpack_sockaddr_in6
($sin)
1337 : Socket
::unpack_sockaddr_in
($sin));
1338 return ($family, $port, $host);
1341 sub getaddrinfo_all
{
1342 my ($hostname, @opts) = @_;
1343 my %hints = ( flags
=> AI_V4MAPPED
| AI_ALL
,
1345 my ($err, @res) = Socket
::getaddrinfo
($hostname, '0', \
%hints);
1346 die "failed to get address info for: $hostname: $err\n" if $err;
1350 sub get_host_address_family
{
1351 my ($hostname, $socktype) = @_;
1352 my @res = getaddrinfo_all
($hostname, socktype
=> $socktype);
1353 return $res[0]->{family
};
1356 # get the fully qualified domain name of a host
1357 # same logic as hostname(1): The FQDN is the name getaddrinfo(3) returns,
1358 # given a nodename as a parameter
1360 my ($nodename) = @_;
1363 flags
=> AI_CANONNAME
,
1364 socktype
=> SOCK_DGRAM
1367 my ($err, @addrs) = Socket
::getaddrinfo
($nodename, undef, $hints);
1369 die "getaddrinfo: $err" if $err;
1371 return $addrs[0]->{canonname
};
1374 # Parses any sane kind of host, or host+port pair:
1375 # The port is always optional and thus may be undef.
1376 sub parse_host_and_port
{
1378 if ($address =~ /^($IPV4RE|[[:alnum:]\-.]+)(?::(\d+))?$/ || # ipv4 or host with optional ':port'
1379 $address =~ /^\[($IPV6RE|$IPV4RE|[[:alnum:]\-.]+)\](?::(\d+))?$/ || # anything in brackets with optional ':port'
1380 $address =~ /^($IPV6RE)(?:\.(\d+))?$/) # ipv6 with optional port separated by dot
1382 return ($1, $2, 1); # end with 1 to support simple if(parse...) tests
1389 return 0 == syscall(PVE
::Syscall
::unshare
, $flags);
1393 my ($fileno, $nstype) = @_;
1394 return 0 == syscall(PVE
::Syscall
::setns
, $fileno, $nstype);
1399 return 0 == syscall(PVE
::Syscall
::syncfs
, $fileno);
1402 sub sync_mountpoint
{
1404 sysopen my $fd, $path, O_PATH
or die "failed to open $path: $!\n";
1405 my $result = syncfs
(fileno($fd));
1410 # support sending multi-part mail messages with a text and or a HTML part
1411 # mailto may be a single email string or an array of receivers
1413 my ($mailto, $subject, $text, $html, $mailfrom, $author) = @_;
1414 my $mail_re = qr/[^-a-zA-Z0-9+._@]/;
1416 $mailto = [ $mailto ] if !ref($mailto);
1418 foreach (@$mailto) {
1419 die "illegal character in mailto address\n"
1420 if ($_ =~ $mail_re);
1423 my $rcvrtxt = join (', ', @$mailto);
1425 $mailfrom = $mailfrom || "root";
1426 die "illegal character in mailfrom address\n"
1427 if $mailfrom =~ $mail_re;
1429 $author = $author || 'Proxmox VE';
1431 open (MAIL
, "|-", "sendmail", "-B", "8BITMIME", "-f", $mailfrom, @$mailto) ||
1432 die "unable to open 'sendmail' - $!";
1434 # multipart spec see https://www.ietf.org/rfc/rfc1521.txt
1435 my $boundary = "----_=_NextPart_001_".int(time).$$;
1437 print MAIL
"Content-Type: multipart/alternative;\n";
1438 print MAIL
"\tboundary=\"$boundary\"\n";
1439 print MAIL "MIME-Version
: 1.0\n";
1441 print MAIL "FROM
: $author <$mailfrom>\n";
1442 print MAIL "TO
: $rcvrtxt\n";
1443 print MAIL "SUBJECT
: $subject\n";
1445 print MAIL "This
is a multi-part message
in MIME format
.\n\n";
1446 print MAIL "--$boundary\n";
1448 if (defined($text)) {
1449 print MAIL "Content-Type
: text
/plain
;\n";
1450 print MAIL "\tcharset
=\"UTF8
\"\n";
1451 print MAIL "Content-Transfer-Encoding
: 8bit
\n";
1454 # avoid 'remove extra line breaks' issue (MS Outlook)
1456 $text =~ s/^/$fill/gm;
1460 print MAIL "\n--$boundary\n";
1463 if (defined($html)) {
1464 print MAIL "Content-Type
: text
/html
;\n";
1465 print MAIL "\tcharset
=\"UTF8
\"\n";
1466 print MAIL "Content-Transfer-Encoding
: 8bit
\n";
1471 print MAIL "\n--$boundary--\n";
1478 my ($perm, %opts) = @_;
1480 # default permissions are stricter than with file_set_contents
1481 $perm = 0600 if !defined($perm);
1483 my $dir = $opts{dir} // '/run';
1484 my $mode = $opts{mode} // O_RDWR;
1485 $mode |= O_EXCL if !$opts{allow_links};
1487 my $fh = IO::File->new($dir, $mode | O_TMPFILE, $perm);
1488 if (!$fh && $! == EOPNOTSUPP) {
1489 $dir = '/tmp' if !defined($opts{dir});
1490 $dir .= "/.tmpfile
.$$";
1491 $fh = IO::File->new($dir, $mode | O_CREAT | O_EXCL, $perm);
1492 unlink($dir) if $fh;
1494 die "failed to create tempfile
: $!\n" if !$fh;
1498 sub tempfile_contents {
1499 my ($data, $perm, %opts) = @_;
1501 my $fh = tempfile($perm, %opts);
1503 die "unable to
write to tempfile
: $!\n" if !print {$fh} $data;
1504 die "unable to flush to tempfile
: $!\n" if !defined($fh->flush());
1511 return ("/proc/$$/fd/".$fh->fileno, $fh);
1514 sub validate_ssh_public_keys {
1516 my @lines = split(/\n/, $raw);
1518 foreach my $line (@lines) {
1519 next if $line =~ m/^\s*$/;
1521 my ($filename, $handle) = tempfile_contents($line);
1522 run_command(["ssh-keygen
", "-l
", "-f
", $filename],
1523 outfunc => sub {}, errfunc => sub {});
1525 die "SSH public key validation error
\n" if $@;
1530 my ($dirfd, $pathname, $flags, $mode) = @_;
1531 my $fd = syscall(PVE::Syscall::openat, $dirfd, $pathname, $flags, $mode//0);
1532 return undef if $fd < 0;
1533 # sysopen() doesn't deal with numeric file descriptors apparently
1534 # so we need to convert to a mode string for IO::Handle->new_from_fd
1535 my $flagstr = ($flags & O_RDWR) ? 'rw' : ($flags & O_WRONLY) ? 'w' : 'r';
1536 my $handle = IO::Handle->new_from_fd($fd, $flagstr);
1537 return $handle if $handle;
1538 my $err = $!; # save error before closing the raw fd
1539 syscall(PVE::Syscall::close, $fd); # close
1545 my ($dirfd, $name, $mode) = @_;
1546 return syscall(PVE::Syscall::mkdirat, $dirfd, $name, $mode) == 0;
1549 # NOTE: This calls the dbus main loop and must not be used when another dbus
1550 # main loop is being used as we need to wait for the JobRemoved signal.
1551 # Polling the job status instead doesn't work because this doesn't give us the
1552 # distinction between success and failure.
1554 # Note that the description is mandatory for security reasons.
1555 sub enter_systemd_scope {
1556 my ($unit, $description, %extra) = @_;
1557 die "missing description
\n" if !defined($description);
1559 my $timeout = delete $extra{timeout};
1562 my $properties = [ [PIDs => [dbus_uint32($$)]] ];
1564 foreach my $key (keys %extra) {
1565 if ($key eq 'Slice' || $key eq 'KillMode') {
1566 push @$properties, [$key, $extra{$key}];
1567 } elsif ($key eq 'CPUShares') {
1568 push @$properties, [$key, dbus_uint64($extra{$key})];
1569 } elsif ($key eq 'CPUQuota') {
1570 push @$properties, ['CPUQuotaPerSecUSec',
1571 dbus_uint64($extra{$key} * 10000)];
1573 die "Don
't know how to encode $key for systemd scope\n";
1580 my $bus = Net::DBus->system();
1581 my $reactor = Net::DBus::Reactor->main();
1583 my $service = $bus->get_service('org
.freedesktop
.systemd1
');
1584 my $if = $service->get_object('/org/freedesktop
/systemd1
', 'org
.freedesktop
.systemd1
.Manager
');
1585 # Connect to the JobRemoved signal since we want to wait for it to finish
1589 my ($no_shutdown) = @_;
1590 $if->disconnect_from_signal('JobRemoved
', $sigid) if defined($if);
1593 $reactor->remove_timeout($timer) if defined($timer);
1595 return if $no_shutdown;
1596 $reactor->shutdown();
1599 $sigid = $if->connect_to_signal('JobRemoved
', sub {
1600 my ($id, $removed_job, $signaled_unit, $result) = @_;
1601 return if $signaled_unit ne $unit || $removed_job ne $job;
1603 die "systemd job failed\n" if $result ne 'done
';
1607 my $on_timeout = sub {
1609 die "systemd job timed out\n";
1612 $timer = $reactor->add_timeout($timeout * 1000, Net::DBus::Callback->new(method => $on_timeout))
1613 if defined($timeout);
1614 $job = $if->StartTransientUnit($unit, 'fail
', $properties, []);
1617 die "systemd job never completed\n" if !$done;
1620 my $salt_starter = time();
1626 my $salt = substr(Digest::SHA::sha1_base64(time() + $salt_starter + $$), 0, 8);
1628 # crypt does not want '+' in salt (see 'man
crypt')
1631 return crypt(encode("utf8", $pw), "\$5\$$salt\$");
1634 # intended usage: convert_size($val, "kb" => "gb")
1635 # we round up to the next integer by default
1636 # E.g. `convert_size(1023, "b" => "kb")` returns 1
1637 # use $no_round_up to switch this off, above example would then return 0
1638 # this is also true for converting down e.g. 0.0005 gb to mb returns 1
1639 # (0 if $no_round_up is true)
1640 # allowed formats for value:
1646 my ($value, $from, $to, $no_round_up) = @_;
1657 die "no value given"
1658 if !defined($value) || $value eq "";
1660 $from = lc($from // ''); $to = lc($to // '');
1661 die "unknown 'from
' and/or 'to
' units ($from => $to)"
1662 if !defined($units->{$from}) || !defined($units->{$to});
1664 die "value '$value' is not a valid, positive number"
1665 if $value !~ m/^(?:[0-9]+\.?[0-9]*|[0-9]*\.[0-9]+)$/;
1667 my $shift_amount = ($units->{$from} - $units->{$to}) * 10;
1669 $value *= 2**$shift_amount;
1670 $value++ if !$no_round_up && ($value - int($value)) > 0.0;