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 Scalar
::Util
'weaken';
30 # avoid warning when parsing long hex values with hex()
31 no warnings
'portable'; # Support for 64-bit ints required
63 my $pvelogdir = "/var/log/pve";
64 my $pvetaskdir = "$pvelogdir/tasks";
69 my $IPV4OCTET = "(?:25[0-5]|(?:2[0-4]|1[0-9]|[1-9])?[0-9])";
70 our $IPV4RE = "(?:(?:$IPV4OCTET\\.){3}$IPV4OCTET)";
71 my $IPV6H16 = "(?:[0-9a-fA-F]{1,4})";
72 my $IPV6LS32 = "(?:(?:$IPV4RE|$IPV6H16:$IPV6H16))";
75 "(?:(?:" . "(?:$IPV6H16:){6})$IPV6LS32)|" .
76 "(?:(?:" . "::(?:$IPV6H16:){5})$IPV6LS32)|" .
77 "(?:(?:(?:" . "$IPV6H16)?::(?:$IPV6H16:){4})$IPV6LS32)|" .
78 "(?:(?:(?:(?:$IPV6H16:){0,1}$IPV6H16)?::(?:$IPV6H16:){3})$IPV6LS32)|" .
79 "(?:(?:(?:(?:$IPV6H16:){0,2}$IPV6H16)?::(?:$IPV6H16:){2})$IPV6LS32)|" .
80 "(?:(?:(?:(?:$IPV6H16:){0,3}$IPV6H16)?::(?:$IPV6H16:){1})$IPV6LS32)|" .
81 "(?:(?:(?:(?:$IPV6H16:){0,4}$IPV6H16)?::" . ")$IPV6LS32)|" .
82 "(?:(?:(?:(?:$IPV6H16:){0,5}$IPV6H16)?::" . ")$IPV6H16)|" .
83 "(?:(?:(?:(?:$IPV6H16:){0,6}$IPV6H16)?::" . ")))";
85 our $IPRE = "(?:$IPV4RE|$IPV6RE)";
87 use constant {CLONE_NEWNS
=> 0x00020000,
88 CLONE_NEWUTS
=> 0x04000000,
89 CLONE_NEWIPC
=> 0x08000000,
90 CLONE_NEWUSER
=> 0x10000000,
91 CLONE_NEWPID
=> 0x20000000,
92 CLONE_NEWNET
=> 0x40000000};
94 use constant {O_PATH
=> 0x00200000,
95 O_TMPFILE
=> 0x00410000}; # This includes O_DIRECTORY
97 use constant {AT_EMPTY_PATH
=> 0x1000,
100 sub run_with_timeout
{
101 my ($timeout, $code, @param) = @_;
103 die "got timeout\n" if $timeout <= 0;
105 my $prev_alarm = alarm 0; # suspend outer alarm early
112 local $SIG{ALRM
} = sub { $sigcount++; die "got timeout\n"; };
113 local $SIG{PIPE
} = sub { $sigcount++; die "broken pipe\n" };
114 local $SIG{__DIE__
}; # see SA bug 4631
118 eval { $res = &$code(@param); };
120 alarm(0); # avoid race conditions
129 # this shouldn't happen anymore?
130 die "unknown error" if $sigcount && !$err; # seems to happen sometimes
137 # flock: we use one file handle per process, so lock file
138 # can be nested multiple times and succeeds for the same process.
140 # Since this is the only way we lock now and we don't have the old
141 # 'lock(); code(); unlock();' pattern anymore we do not actually need to
142 # count how deep we're nesting. Therefore this hash now stores a weak reference
143 # to a boolean telling us whether we already have a lock.
145 my $lock_handles = {};
148 my ($filename, $timeout, $shared, $code, @param) = @_;
150 $timeout = 10 if !$timeout;
152 my $mode = $shared ? LOCK_SH
: LOCK_EX
;
154 my $lockhash = ($lock_handles->{$$} //= {});
156 # Returns a locked file handle.
157 my $get_locked_file = sub {
158 my $fh = IO
::File-
>new(">>$filename")
159 or die "can't open file - $!\n";
161 if (!flock($fh, $mode|LOCK_NB
)) {
162 print STDERR
"trying to acquire lock...\n";
165 $success = flock($fh, $mode);
166 # try again on EINTR (see bug #273)
167 if ($success || ($! != EINTR
)) {
172 print STDERR
" failed\n";
173 die "can't acquire lock '$filename' - $!\n";
175 print STDERR
" OK\n";
182 my $checkptr = $lockhash->{$filename};
183 my $check = 0; # This must not go out of scope before running the code.
184 my $local_fh; # This must stay local
185 if (!$checkptr || !$$checkptr) {
186 # We cannot create a weak reference in a single atomic step, so we first
187 # create a false-value, then create a reference to it, then weaken it,
188 # and after successfully locking the file we change the boolean value.
190 # The reason for this is that if an outer SIGALRM throws an exception
191 # between creating the reference and weakening it, a subsequent call to
192 # lock_file_full() will see a leftover full reference to a valid
193 # variable. This variable must be 0 in order for said call to attempt to
194 # lock the file anew.
196 # An externally triggered exception elsewhere in the code will cause the
197 # weak reference to become 'undef', and since the file handle is only
198 # stored in the local scope in $local_fh, the file will be closed by
199 # perl's cleanup routines as well.
201 # This still assumes that an IO::File handle can properly deal with such
202 # exceptions thrown during its own destruction, but that's up to perls
204 $lockhash->{$filename} = \
$check;
205 weaken
$lockhash->{$filename};
206 $local_fh = eval { run_with_timeout
($timeout, $get_locked_file) };
208 $@ = "can't lock file '$filename' - $@";
213 $res = eval { &$code(@param); };
220 my ($filename, $timeout, $code, @param) = @_;
222 return lock_file_full
($filename, $timeout, 0, $code, @param);
225 sub file_set_contents
{
226 my ($filename, $data, $perm) = @_;
228 $perm = 0644 if !defined($perm);
230 my $tmpname = "$filename.tmp.$$";
233 my ($fh, $tries) = (undef, 0);
234 while (!$fh && $tries++ < 3) {
235 $fh = IO
::File-
>new($tmpname, O_WRONLY
|O_CREAT
|O_EXCL
, $perm);
236 if (!$fh && $! == EEXIST
) {
237 unlink($tmpname) or die "unable to delete old temp file: $!\n";
240 die "unable to open file '$tmpname' - $!\n" if !$fh;
241 die "unable to write '$tmpname' - $!\n" unless print $fh $data;
242 die "closing file '$tmpname' failed - $!\n" unless close $fh;
251 if (!rename($tmpname, $filename)) {
252 my $msg = "close (rename) atomic file '$filename' failed: $!\n";
258 sub file_get_contents
{
259 my ($filename, $max) = @_;
261 my $fh = IO
::File-
>new($filename, "r") ||
262 die "can't open '$filename' - $!\n";
264 my $content = safe_read_from
($fh, $max, 0, $filename);
272 my ($filename, $dst, $max, $perm) = @_;
274 file_set_contents
($dst, file_get_contents
($filename, $max), $perm);
277 sub file_read_firstline
{
280 my $fh = IO
::File-
>new ($filename, "r");
281 return undef if !$fh;
289 my ($fh, $max, $oneline, $filename) = @_;
291 $max = 32768 if !$max;
293 my $subject = defined($filename) ?
"file '$filename'" : 'input';
298 while ($count = sysread($fh, $input, 8192, $br)) {
300 die "$subject too long - aborting\n" if $br > $max;
301 if ($oneline && $input =~ m/^(.*)\n/) {
306 die "unable to read $subject - $!\n" if !defined($count);
311 # The $cmd parameter can be:
313 # This is generally executed by passing it to the shell with the -c option.
314 # However, it can be executed in one of two ways, depending on whether
315 # there's a pipe involved:
316 # *) with pipe: passed explicitly to bash -c, prefixed with:
318 # *) without a pipe: passed to perl's open3 which uses 'sh -c'
319 # (Note that this may result in two different syntax requirements!)
321 # -) an array of arguments (strings)
322 # Will be executed without interference from a shell. (Parameters are passed
323 # as is, no escape sequences of strings will be touched.)
324 # -) an array of arrays
325 # Each array represents a command, and each command's output is piped into
326 # the following command's standard input.
327 # For this a shell command string is created with pipe symbols between each
329 # Each command is a list of strings meant to end up in the final command
330 # unchanged. In order to achieve this, every argument is shell-quoted.
331 # Quoting can be disabled for a particular argument by turning it into a
332 # reference, this allows inserting arbitrary shell options.
333 # For instance: the $cmd [ [ 'echo', 'hello', \'>/dev/null' ] ] will not
334 # produce any output, while the $cmd [ [ 'echo', 'hello', '>/dev/null' ] ]
335 # will literally print: hello >/dev/null
337 my ($cmd, %param) = @_;
342 if (my $ref = ref($cmd)) {
343 if (ref($cmd->[0])) {
344 $cmdstr = 'set -o pipefail && ';
346 foreach my $command (@$cmd) {
347 # concatenate quoted parameters
348 # strings which are passed by reference are NOT shell quoted
349 $cmdstr .= $pipe . join(' ', map { ref($_) ?
$$_ : shellquote
($_) } @$command);
352 $cmd = [ '/bin/bash', '-c', "$cmdstr" ];
354 $cmdstr = cmd2string
($cmd);
359 # see 'man bash' for option pipefail
360 $cmd = [ '/bin/bash', '-c', "set -o pipefail && $cmd" ];
385 foreach my $p (keys %param) {
386 if ($p eq 'timeout') {
387 $timeout = $param{$p};
388 } elsif ($p eq 'umask') {
389 $old_umask = umask($param{$p});
390 } elsif ($p eq 'errmsg') {
391 $errmsg = $param{$p};
392 } elsif ($p eq 'input') {
394 } elsif ($p eq 'output') {
395 $output = $param{$p};
396 } elsif ($p eq 'outfunc') {
397 $outfunc = $param{$p};
398 } elsif ($p eq 'errfunc') {
399 $errfunc = $param{$p};
400 } elsif ($p eq 'logfunc') {
401 $logfunc = $param{$p};
402 } elsif ($p eq 'afterfork') {
403 $afterfork = $param{$p};
404 } elsif ($p eq 'noerr') {
406 } elsif ($p eq 'keeplocale') {
407 $keeplocale = $param{$p};
408 } elsif ($p eq 'quiet') {
411 die "got unknown parameter '$p' for run_command\n";
416 my $origerrfunc = $errfunc;
420 &$origerrfunc("$laststderr\n");
422 print STDERR
"$laststderr\n" if $laststderr;
429 my $reader = $output && $output =~ m/^>&/ ?
$output : IO
::File-
>new();
430 my $writer = $input && $input =~ m/^<&/ ?
$input : IO
::File-
>new();
431 my $error = IO
::File-
>new();
436 local $ENV{LC_ALL
} = 'C' if !$keeplocale;
438 # suppress LVM warnings like: "File descriptor 3 left open";
439 local $ENV{LVM_SUPPRESS_FD_WARNINGS
} = "1";
441 $pid = open3
($writer, $reader, $error, @$cmd) || die $!;
443 # if we pipe fron STDIN, open3 closes STDIN, so we we
444 # a perl warning "Filehandle STDIN reopened as GENXYZ .. "
445 # as soon as we open a new file.
446 # to avoid that we open /dev/null
447 if (!ref($writer) && !defined(fileno(STDIN
))) {
449 open(STDIN
, "</dev/null");
456 if ($orig_pid != $$) {
464 local $SIG{ALRM
} = sub { die "got timeout\n"; } if $timeout;
465 $oldtimeout = alarm($timeout) if $timeout;
467 &$afterfork() if $afterfork;
470 print $writer $input if defined $input;
474 my $select = new IO
::Select
;
475 $select->add($reader) if ref($reader);
476 $select->add($error);
481 my $starttime = time();
483 while ($select->count) {
484 my @handles = $select->can_read(1);
486 foreach my $h (@handles) {
488 my $count = sysread ($h, $buf, 4096);
489 if (!defined ($count)) {
495 $select->remove ($h) if !$count;
497 if ($outfunc || $logfunc) {
500 while ($outlog =~ s/^([^\010\r\n]*)(\r|\n|(\010)+|\r\n)//s) {
502 &$outfunc($line) if $outfunc;
503 &$logfunc($line) if $logfunc;
516 } elsif ($h eq $error) {
517 if ($errfunc || $logfunc) {
520 while ($errlog =~ s/^([^\010\r\n]*)(\r|\n|(\010)+|\r\n)//s) {
522 &$errfunc($line) if $errfunc;
523 &$logfunc($line) if $logfunc;
540 &$outfunc($outlog) if $outfunc && $outlog;
541 &$logfunc($outlog) if $logfunc && $outlog;
543 &$errfunc($errlog) if $errfunc && $errlog;
544 &$logfunc($errlog) if $logfunc && $errlog;
549 die "failed to execute\n";
550 } elsif (my $sig = ($? & 127)) {
551 die "got signal $sig\n";
552 } elsif ($exitcode = ($? >> 8)) {
553 if (!($exitcode == 24 && ($cmdstr =~ m
|^(\S
+/)?rsync\s
|))) {
554 if ($errmsg && $laststderr) {
555 my $lerr = $laststderr;
559 die "exit code $exitcode\n";
570 if ($errmsg && $laststderr) {
571 &$errfunc(undef); # flush laststderr
574 umask ($old_umask) if defined($old_umask);
576 alarm($oldtimeout) if $oldtimeout;
579 if ($pid && ($err eq "got timeout\n")) {
582 die "command '$cmdstr' failed: $err";
586 $err =~ s/^usermod:\s*// if $cmdstr =~ m
|^(\S
+/)?usermod\s
|;
589 die "command '$cmdstr' failed: $err";
596 # Run a command with a tcp socket as standard input.
597 sub pipe_socket_to_command
{
598 my ($cmd, $ip, $port) = @_;
603 Proto
=> &Socket
::IPPROTO_TCP
,
604 GetAddrInfoFlags
=> 0,
608 my $socket = IO
::Socket
::IP-
>new(%$params) or die "failed to open socket: $!\n";
610 print "$ip\n$port\n"; # tell remote where to connect
614 local $SIG{ALRM
} = sub { die "timed out waiting for client\n" };
616 my $client = $socket->accept; # Wait for a client
620 # We want that the command talks over the TCP socket and takes
621 # ownership of it, so that when it closes it the connection is
622 # terminated, so we need to be able to close the socket. So we
623 # can't really use PVE::Tools::run_command().
624 my $pid = fork() // die "fork failed: $!\n";
626 POSIX
::dup2
(fileno($client), 0);
627 POSIX
::dup2
(fileno($client), 1);
629 exec {$cmd->[0]} @$cmd or do {
630 warn "exec failed: $!\n";
636 if (waitpid($pid, 0) != $pid) {
637 kill(15 => $pid); # if we got interrupted terminate the child
639 while (waitpid($pid, POSIX
::WNOHANG
) != $pid) {
642 kill(9 => $pid), last if $count > 300; # 30 second timeout
645 if (my $sig = ($? & 127)) {
646 die "got signal $sig\n";
647 } elsif (my $exitcode = ($? >> 8)) {
648 die "exit code $exitcode\n";
655 my $listtxt = shift // '';
657 return split (/\0/, $listtxt) if $listtxt =~ m/\0/;
659 $listtxt =~ s/[,;]/ /g;
660 $listtxt =~ s/^\s+//;
662 my @data = split (/\s+/, $listtxt);
670 return $txt if !defined($txt);
678 # simple uri templates like "/vms/{vmid}"
679 sub template_replace
{
680 my ($tmpl, $data) = @_;
682 return $tmpl if !$tmpl;
685 while ($tmpl =~ m/([^{]+)?(\{([^}]+)\})?/g) {
687 $res .= ($data->{$3} || '-') if $2;
693 my ($filename, $fh, $data) = @_;
697 my $res = print $fh $data;
699 die "write to '$filename' failed\n" if !$res;
705 'at' => 'ftp.at.debian.org',
706 'au' => 'ftp.au.debian.org',
707 'be' => 'ftp.be.debian.org',
708 'bg' => 'ftp.bg.debian.org',
709 'br' => 'ftp.br.debian.org',
710 'ca' => 'ftp.ca.debian.org',
711 'ch' => 'ftp.ch.debian.org',
712 'cl' => 'ftp.cl.debian.org',
713 'cz' => 'ftp.cz.debian.org',
714 'de' => 'ftp.de.debian.org',
715 'dk' => 'ftp.dk.debian.org',
716 'ee' => 'ftp.ee.debian.org',
717 'es' => 'ftp.es.debian.org',
718 'fi' => 'ftp.fi.debian.org',
719 'fr' => 'ftp.fr.debian.org',
720 'gr' => 'ftp.gr.debian.org',
721 'hk' => 'ftp.hk.debian.org',
722 'hr' => 'ftp.hr.debian.org',
723 'hu' => 'ftp.hu.debian.org',
724 'ie' => 'ftp.ie.debian.org',
725 'is' => 'ftp.is.debian.org',
726 'it' => 'ftp.it.debian.org',
727 'jp' => 'ftp.jp.debian.org',
728 'kr' => 'ftp.kr.debian.org',
729 'mx' => 'ftp.mx.debian.org',
730 'nl' => 'ftp.nl.debian.org',
731 'no' => 'ftp.no.debian.org',
732 'nz' => 'ftp.nz.debian.org',
733 'pl' => 'ftp.pl.debian.org',
734 'pt' => 'ftp.pt.debian.org',
735 'ro' => 'ftp.ro.debian.org',
736 'ru' => 'ftp.ru.debian.org',
737 'se' => 'ftp.se.debian.org',
738 'si' => 'ftp.si.debian.org',
739 'sk' => 'ftp.sk.debian.org',
740 'tr' => 'ftp.tr.debian.org',
741 'tw' => 'ftp.tw.debian.org',
742 'gb' => 'ftp.uk.debian.org',
743 'us' => 'ftp.us.debian.org',
748 'dk' => ['Danish', 'da', 'qwerty/dk-latin1.kmap.gz', 'dk', 'nodeadkeys'],
749 'de' => ['German', 'de', 'qwertz/de-latin1-nodeadkeys.kmap.gz', 'de', 'nodeadkeys' ],
750 'de-ch' => ['Swiss-German', 'de-ch', 'qwertz/sg-latin1.kmap.gz', 'ch', 'de_nodeadkeys' ],
751 'en-gb' => ['United Kingdom', 'en-gb', 'qwerty/uk.kmap.gz' , 'gb', undef],
752 'en-us' => ['U.S. English', 'en-us', 'qwerty/us-latin1.kmap.gz', 'us', undef ],
753 'es' => ['Spanish', 'es', 'qwerty/es.kmap.gz', 'es', 'nodeadkeys'],
754 #'et' => [], # Ethopia or Estonia ??
755 'fi' => ['Finnish', 'fi', 'qwerty/fi-latin1.kmap.gz', 'fi', 'nodeadkeys'],
756 #'fo' => ['Faroe Islands', 'fo', ???, 'fo', 'nodeadkeys'],
757 'fr' => ['French', 'fr', 'azerty/fr-latin1.kmap.gz', 'fr', 'nodeadkeys'],
758 'fr-be' => ['Belgium-French', 'fr-be', 'azerty/be2-latin1.kmap.gz', 'be', 'nodeadkeys'],
759 'fr-ca' => ['Canada-French', 'fr-ca', 'qwerty/cf.kmap.gz', 'ca', 'fr-legacy'],
760 'fr-ch' => ['Swiss-French', 'fr-ch', 'qwertz/fr_CH-latin1.kmap.gz', 'ch', 'fr_nodeadkeys'],
761 #'hr' => ['Croatia', 'hr', 'qwertz/croat.kmap.gz', 'hr', ??], # latin2?
762 'hu' => ['Hungarian', 'hu', 'qwertz/hu.kmap.gz', 'hu', undef],
763 'is' => ['Icelandic', 'is', 'qwerty/is-latin1.kmap.gz', 'is', 'nodeadkeys'],
764 'it' => ['Italian', 'it', 'qwerty/it2.kmap.gz', 'it', 'nodeadkeys'],
765 'jp' => ['Japanese', 'ja', 'qwerty/jp106.kmap.gz', 'jp', undef],
766 'lt' => ['Lithuanian', 'lt', 'qwerty/lt.kmap.gz', 'lt', 'std'],
767 #'lv' => ['Latvian', 'lv', 'qwerty/lv-latin4.kmap.gz', 'lv', ??], # latin4 or latin7?
768 'mk' => ['Macedonian', 'mk', 'qwerty/mk.kmap.gz', 'mk', 'nodeadkeys'],
769 'nl' => ['Dutch', 'nl', 'qwerty/nl.kmap.gz', 'nl', undef],
770 #'nl-be' => ['Belgium-Dutch', 'nl-be', ?, ?, ?],
771 'no' => ['Norwegian', 'no', 'qwerty/no-latin1.kmap.gz', 'no', 'nodeadkeys'],
772 'pl' => ['Polish', 'pl', 'qwerty/pl.kmap.gz', 'pl', undef],
773 'pt' => ['Portuguese', 'pt', 'qwerty/pt-latin1.kmap.gz', 'pt', 'nodeadkeys'],
774 'pt-br' => ['Brazil-Portuguese', 'pt-br', 'qwerty/br-latin1.kmap.gz', 'br', 'nodeadkeys'],
775 #'ru' => ['Russian', 'ru', 'qwerty/ru.kmap.gz', 'ru', undef], # don't know?
776 'si' => ['Slovenian', 'sl', 'qwertz/slovene.kmap.gz', 'si', undef],
777 'se' => ['Swedish', 'sv', 'qwerty/se-latin1.kmap.gz', 'se', 'nodeadkeys'],
779 'tr' => ['Turkish', 'tr', 'qwerty/trq.kmap.gz', 'tr', undef],
782 my $kvmkeymaparray = [];
783 foreach my $lc (sort keys %$keymaphash) {
784 push @$kvmkeymaparray, $keymaphash->{$lc}->[1];
792 return $kvmkeymaparray;
796 my ($param, $key) = @_;
798 my $res = $param->{$key};
799 delete $param->{$key};
804 # Note: we use this to wait until vncterm/spiceterm is ready
805 sub wait_for_vnc_port
{
806 my ($port, $family, $timeout) = @_;
808 $timeout = 5 if !$timeout;
810 my $starttime = [gettimeofday
];
813 my $cmd = ['/bin/ss', '-Htln', "sport = :$port"];
814 push @$cmd, $family == AF_INET6 ?
'-6' : '-4' if defined($family);
817 while (($elapsed = tv_interval
($starttime)) < $timeout) {
818 # -Htln = don't print header, tcp, listening sockets only, numeric ports
819 run_command
($cmd, outfunc
=> sub {
821 if ($line =~ m/^LISTEN\s+\d+\s+\d+\s+\S+:(\d+)\s/) {
822 $found = 1 if ($port == $1);
826 $sleeptime += 100000 if $sleeptime < 1000000;
830 die "Timeout while waiting for port '$port' to get ready!\n";
833 sub next_unused_port
{
834 my ($range_start, $range_end, $family, $address) = @_;
836 # We use a file to register allocated ports.
837 # Those registrations expires after $expiretime.
838 # We use this to avoid race conditions between
839 # allocation and use of ports.
841 my $filename = "/var/tmp/pve-reserved-ports";
850 if (my $fh = IO
::File-
>new ($filename, "r")) {
851 while (my $line = <$fh>) {
852 if ($line =~ m/^(\d+)\s(\d+)$/) {
853 my ($port, $timestamp) = ($1, $2);
854 if (($timestamp + $expiretime) > $ctime) {
855 $ports->{$port} = $timestamp; # not expired
862 my %sockargs = (Listen
=> 5,
865 Proto
=> IPPROTO_TCP
,
866 GetAddrInfoFlags
=> 0);
867 $sockargs{LocalAddr
} = $address if defined($address);
869 for (my $p = $range_start; $p < $range_end; $p++) {
870 next if $ports->{$p}; # reserved
872 $sockargs{LocalPort
} = $p;
873 my $sock = IO
::Socket
::IP-
>new(%sockargs);
878 $ports->{$p} = $ctime;
884 foreach my $p (keys %$ports) {
885 $data .= "$p $ports->{$p}\n";
888 file_set_contents
($filename, $data);
893 my $p = lock_file
('/var/lock/pve-ports.lck', 10, $code);
896 die "unable to find free port (${range_start}-${range_end})\n" if !$p;
901 sub next_migrate_port
{
902 my ($family, $address) = @_;
903 return next_unused_port
(60000, 60050, $family, $address);
907 my ($family, $address) = @_;
908 return next_unused_port
(5900, 6000, $family, $address);
911 sub spice_port_range
{
912 return (61000, 61999);
915 sub next_spice_port
{
916 my ($family, $address) = @_;
917 return next_unused_port
(spice_port_range
(), $family, $address);
922 eval { $value = "$value" };
923 return "error turning value into a string: $@" if $@;
927 # sigkill after $timeout a $sub running in a fork if it can't write a pipe
928 # the $sub has to return a single scalar
929 sub run_fork_with_timeout
{
930 my ($timeout, $sub) = @_;
934 my $pipe_out = IO
::Pipe-
>new();
936 # disable pending alarms, save their remaining time
937 my $prev_alarm = alarm 0;
939 # avoid leaving a zombie if the parent gets interrupted
943 if (!defined($child)) {
944 die "fork failed: $!\n";
953 print {$pipe_out} encode_json
({ result
=> $res });
957 print {$pipe_out} encode_json
({ error
=> must_stringify
($err) });
964 local $SIG{INT
} = sub { $sig_received++; };
965 local $SIG{TERM
} = sub {
966 $error //= "interrupted by unexpected signal\n";
967 kill('TERM', $child);
972 my $readvalues = sub {
974 my $child_res = decode_json
(readline_nointr
($pipe_out));
975 $res = $child_res->{result
};
976 $error = $child_res->{error
};
979 if (defined($timeout)) {
980 run_with_timeout
($timeout, $readvalues);
987 kill('KILL', $child);
991 die "interrupted by unexpected signal\n" if $sig_received;
993 die $error if $error;
999 return run_fork_with_timeout
(undef, $code);
1002 # NOTE: NFS syscall can't be interrupted, so alarm does
1003 # not work to provide timeouts.
1004 # from 'man nfs': "Only SIGKILL can interrupt a pending NFS operation"
1005 # So fork() before using Filesys::Df
1007 my ($path, $timeout) = @_;
1009 my $df = sub { return Filesys
::Df
::df
($path, 1) };
1011 my $res = eval { run_fork_with_timeout
($timeout, $df) } // {};
1014 # untaint, but be flexible: PB usage can result in scientific notation
1015 my ($blocks, $used, $bavail) = map { defined($_) ?
(/^([\d\.e\-+]+)$/) : 0 }
1016 $res->@{qw(blocks used bavail)};
1026 my ($path, $timeout) = @_;
1035 if ($line =~ m/^(\d+)\s+total$/) {
1040 run_command
(['du', '-scb', $path], outfunc
=> $parser, timeout
=> $timeout);
1046 # We use this to uniquely identify a process.
1047 # An 'Unique Process ID' has the following format:
1048 # "UPID:$node:$pid:$pstart:$startime:$dtype:$id:$user"
1053 # Note: pstart can be > 32bit if uptime > 497 days, so this can result in
1054 # more that 8 characters for pstart
1055 return sprintf("UPID:%s:%08X:%08X:%08X:%s:%s:%s:", $d->{node
}, $d->{pid
},
1056 $d->{pstart
}, $d->{starttime
}, $d->{type
}, $d->{id
},
1061 my ($upid, $noerr) = @_;
1066 # "UPID:$node:$pid:$pstart:$startime:$dtype:$id:$user"
1067 # Note: allow up to 9 characters for pstart (work until 20 years uptime)
1068 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]+):$/) {
1070 $res->{pid
} = hex($3);
1071 $res->{pstart
} = hex($4);
1072 $res->{starttime
} = hex($5);
1077 my $subdir = substr($5, 7, 8);
1078 $filename = "$pvetaskdir/$subdir/$upid";
1081 return undef if $noerr;
1082 die "unable to parse worker upid '$upid'\n";
1085 return wantarray ?
($res, $filename) : $res;
1091 my ($task, $filename) = upid_decode
($upid);
1093 my $dirname = dirname
($filename);
1094 make_path
($dirname);
1096 my $wwwid = getpwnam('www-data') ||
1097 die "getpwnam failed";
1101 my $outfh = IO
::File-
>new ($filename, O_WRONLY
|O_CREAT
|O_EXCL
, $perm) ||
1102 die "unable to create output file '$filename' - $!\n";
1103 chown $wwwid, -1, $outfh;
1108 sub upid_read_status
{
1111 my ($task, $filename) = upid_decode
($upid);
1112 my $fh = IO
::File-
>new($filename, "r");
1113 return "unable to open file - $!" if !$fh;
1115 sysseek($fh, -$maxlen, 2);
1117 my $br = sysread($fh, $readbuf, $maxlen);
1120 return "unable to extract last line"
1121 if $readbuf !~ m/\n?(.+)$/;
1123 if ($line =~ m/^TASK OK$/) {
1125 } elsif ($line =~ m/^TASK ERROR: (.+)$/) {
1128 return "unexpected status";
1131 return "unable to read tail (got $br bytes)";
1134 # useful functions to store comments in config files
1138 # all control and hi-bit characters, and ':'
1139 my $unsafe = "^\x20-\x39\x3b-\x7e";
1140 return uri_escape
(Encode
::encode
("utf8", $text), $unsafe);
1146 return Encode
::decode
("utf8", uri_unescape
($data));
1149 # depreciated - do not use!
1150 # we now decode all parameters by default
1151 sub decode_utf8_parameters
{
1154 foreach my $p (qw(comment description firstname lastname)) {
1155 $param->{$p} = decode
('utf8', $param->{$p}) if $param->{$p};
1161 sub random_ether_addr
{
1164 my ($seconds, $microseconds) = gettimeofday
;
1166 my $rand = Digest
::SHA
::sha1
($$, rand(), $seconds, $microseconds);
1168 # clear multicast, set local id
1169 vec($rand, 0, 8) = (vec($rand, 0, 8) & 0xfe) | 2;
1171 my $addr = sprintf("%02X:%02X:%02X:%02X:%02X:%02X", unpack("C6", $rand));
1172 if (defined($prefix)) {
1173 $addr = uc($prefix) . substr($addr, length($prefix));
1181 return String
::ShellQuote
::shell_quote
($str);
1187 die "no arguments" if !$cmd;
1189 return $cmd if !ref($cmd);
1192 foreach my $arg (@$cmd) { push @qa, shellquote
($arg); }
1194 return join (' ', @qa);
1197 # split an shell argument string into an array,
1201 return $str ?
[ Text
::ParseWords
::shellwords
($str) ] : [];
1205 my ($filename, $start, $limit, $filter) = @_;
1210 my $fh = IO
::File-
>new($filename, "r");
1213 push @$lines, { n
=> $count, t
=> "unable to open file - $!"};
1214 return ($count, $lines);
1217 $start = 0 if !$start;
1218 $limit = 50 if !$limit;
1223 # duplicate code, so that we do not slow down normal path
1224 while (defined($line = <$fh>)) {
1225 next if $line !~ m/$filter/;
1226 next if $count++ < $start;
1227 next if $limit <= 0;
1229 push @$lines, { n
=> $count, t
=> $line};
1233 while (defined($line = <$fh>)) {
1234 next if $count++ < $start;
1235 next if $limit <= 0;
1237 push @$lines, { n
=> $count, t
=> $line};
1244 # HACK: ExtJS store.guaranteeRange() does not like empty array
1248 push @$lines, { n
=> $count, t
=> "no content"};
1251 return ($count, $lines);
1255 my ($start, $limit, $since, $until, $service) = @_;
1260 $start = 0 if !$start;
1261 $limit = 50 if !$limit;
1266 return if $count++ < $start;
1267 return if $limit <= 0;
1268 push @$lines, { n
=> int($count), t
=> $line};
1272 my $cmd = ['journalctl', '-o', 'short', '--no-pager'];
1274 push @$cmd, '--unit', $service if $service;
1275 push @$cmd, '--since', $since if $since;
1276 push @$cmd, '--until', $until if $until;
1277 run_command
($cmd, outfunc
=> $parser);
1279 # HACK: ExtJS store.guaranteeRange() does not like empty array
1283 push @$lines, { n
=> $count, t
=> "no content"};
1286 return ($count, $lines);
1289 sub dir_glob_regex
{
1290 my ($dir, $regex) = @_;
1292 my $dh = IO
::Dir-
>new ($dir);
1293 return wantarray ?
() : undef if !$dh;
1295 while (defined(my $tmp = $dh->read)) {
1296 if (my @res = $tmp =~ m/^($regex)$/) {
1298 return wantarray ?
@res : $tmp;
1303 return wantarray ?
() : undef;
1306 sub dir_glob_foreach
{
1307 my ($dir, $regex, $func) = @_;
1309 my $dh = IO
::Dir-
>new ($dir);
1311 while (defined(my $tmp = $dh->read)) {
1312 if (my @res = $tmp =~ m/^($regex)$/) {
1319 sub assert_if_modified
{
1320 my ($digest1, $digest2) = @_;
1322 if ($digest1 && $digest2 && ($digest1 ne $digest2)) {
1323 die "detected modified configuration - file changed by other user? Try again.\n";
1327 # Digest for short strings
1328 # like FNV32a, but we only return 31 bits (positive numbers)
1332 my $hval = 0x811c9dc5;
1334 foreach my $c (unpack('C*', $string)) {
1342 $hval = $hval & 0xffffffff;
1344 return $hval & 0x7fffffff;
1347 sub fnv31a_hex
{ return sprintf("%X", fnv31a
(@_)); }
1349 sub unpack_sockaddr_in46
{
1351 my $family = Socket
::sockaddr_family
($sin);
1352 my ($port, $host) = ($family == AF_INET6 ? Socket
::unpack_sockaddr_in6
($sin)
1353 : Socket
::unpack_sockaddr_in
($sin));
1354 return ($family, $port, $host);
1357 sub getaddrinfo_all
{
1358 my ($hostname, @opts) = @_;
1359 my %hints = ( flags
=> AI_V4MAPPED
| AI_ALL
,
1361 my ($err, @res) = Socket
::getaddrinfo
($hostname, '0', \
%hints);
1362 die "failed to get address info for: $hostname: $err\n" if $err;
1366 sub get_host_address_family
{
1367 my ($hostname, $socktype) = @_;
1368 my @res = getaddrinfo_all
($hostname, socktype
=> $socktype);
1369 return $res[0]->{family
};
1372 # get the fully qualified domain name of a host
1373 # same logic as hostname(1): The FQDN is the name getaddrinfo(3) returns,
1374 # given a nodename as a parameter
1376 my ($nodename) = @_;
1379 flags
=> AI_CANONNAME
,
1380 socktype
=> SOCK_DGRAM
1383 my ($err, @addrs) = Socket
::getaddrinfo
($nodename, undef, $hints);
1385 die "getaddrinfo: $err" if $err;
1387 return $addrs[0]->{canonname
};
1390 # Parses any sane kind of host, or host+port pair:
1391 # The port is always optional and thus may be undef.
1392 sub parse_host_and_port
{
1394 if ($address =~ /^($IPV4RE|[[:alnum:]\-.]+)(?::(\d+))?$/ || # ipv4 or host with optional ':port'
1395 $address =~ /^\[($IPV6RE|$IPV4RE|[[:alnum:]\-.]+)\](?::(\d+))?$/ || # anything in brackets with optional ':port'
1396 $address =~ /^($IPV6RE)(?:\.(\d+))?$/) # ipv6 with optional port separated by dot
1398 return ($1, $2, 1); # end with 1 to support simple if(parse...) tests
1403 sub setresuid
($$$) {
1404 my ($ruid, $euid, $suid) = @_;
1405 return 0 == syscall(PVE
::Syscall
::setresuid
, $ruid, $euid, $suid);
1410 return 0 == syscall(PVE
::Syscall
::unshare
, $flags);
1414 my ($fileno, $nstype) = @_;
1415 return 0 == syscall(PVE
::Syscall
::setns
, $fileno, $nstype);
1420 return 0 == syscall(PVE
::Syscall
::syncfs
, $fileno);
1425 return 0 == syscall(PVE
::Syscall
::fsync
, $fileno);
1428 sub sync_mountpoint
{
1430 sysopen my $fd, $path, O_PATH
or die "failed to open $path: $!\n";
1431 my $result = syncfs
(fileno($fd));
1436 # support sending multi-part mail messages with a text and or a HTML part
1437 # mailto may be a single email string or an array of receivers
1439 my ($mailto, $subject, $text, $html, $mailfrom, $author) = @_;
1440 my $mail_re = qr/[^-a-zA-Z0-9+._@]/;
1442 $mailto = [ $mailto ] if !ref($mailto);
1444 foreach (@$mailto) {
1445 die "illegal character in mailto address\n"
1446 if ($_ =~ $mail_re);
1449 my $rcvrtxt = join (', ', @$mailto);
1451 $mailfrom = $mailfrom || "root";
1452 die "illegal character in mailfrom address\n"
1453 if $mailfrom =~ $mail_re;
1455 $author = $author || 'Proxmox VE';
1457 open (MAIL
, "|-", "sendmail", "-B", "8BITMIME", "-f", $mailfrom, @$mailto) ||
1458 die "unable to open 'sendmail' - $!";
1460 # multipart spec see https://www.ietf.org/rfc/rfc1521.txt
1461 my $boundary = "----_=_NextPart_001_".int(time).$$;
1463 print MAIL
"Content-Type: multipart/alternative;\n";
1464 print MAIL
"\tboundary=\"$boundary\"\n";
1465 print MAIL "MIME-Version
: 1.0\n";
1467 print MAIL "FROM
: $author <$mailfrom>\n";
1468 print MAIL "TO
: $rcvrtxt\n";
1469 print MAIL "SUBJECT
: $subject\n";
1471 print MAIL "This
is a multi-part message
in MIME format
.\n\n";
1472 print MAIL "--$boundary\n";
1474 if (defined($text)) {
1475 print MAIL "Content-Type
: text
/plain
;\n";
1476 print MAIL "\tcharset
=\"UTF8
\"\n";
1477 print MAIL "Content-Transfer-Encoding
: 8bit
\n";
1480 # avoid 'remove extra line breaks' issue (MS Outlook)
1482 $text =~ s/^/$fill/gm;
1486 print MAIL "\n--$boundary\n";
1489 if (defined($html)) {
1490 print MAIL "Content-Type
: text
/html
;\n";
1491 print MAIL "\tcharset
=\"UTF8
\"\n";
1492 print MAIL "Content-Transfer-Encoding
: 8bit
\n";
1497 print MAIL "\n--$boundary--\n";
1504 my ($perm, %opts) = @_;
1506 # default permissions are stricter than with file_set_contents
1507 $perm = 0600 if !defined($perm);
1509 my $dir = $opts{dir} // '/run';
1510 my $mode = $opts{mode} // O_RDWR;
1511 $mode |= O_EXCL if !$opts{allow_links};
1513 my $fh = IO::File->new($dir, $mode | O_TMPFILE, $perm);
1514 if (!$fh && $! == EOPNOTSUPP) {
1515 $dir = '/tmp' if !defined($opts{dir});
1516 $dir .= "/.tmpfile
.$$";
1517 $fh = IO::File->new($dir, $mode | O_CREAT | O_EXCL, $perm);
1518 unlink($dir) if $fh;
1520 die "failed to create tempfile
: $!\n" if !$fh;
1524 sub tempfile_contents {
1525 my ($data, $perm, %opts) = @_;
1527 my $fh = tempfile($perm, %opts);
1529 die "unable to
write to tempfile
: $!\n" if !print {$fh} $data;
1530 die "unable to flush to tempfile
: $!\n" if !defined($fh->flush());
1537 return ("/proc/$$/fd/".$fh->fileno, $fh);
1540 sub validate_ssh_public_keys {
1542 my @lines = split(/\n/, $raw);
1544 foreach my $line (@lines) {
1545 next if $line =~ m/^\s*$/;
1547 my ($filename, $handle) = tempfile_contents($line);
1548 run_command(["ssh-keygen
", "-l
", "-f
", $filename],
1549 outfunc => sub {}, errfunc => sub {});
1551 die "SSH public key validation error
\n" if $@;
1556 my ($dirfd, $pathname, $flags, $mode) = @_;
1557 my $fd = syscall(PVE::Syscall::openat, $dirfd, $pathname, $flags, $mode//0);
1558 return undef if $fd < 0;
1559 # sysopen() doesn't deal with numeric file descriptors apparently
1560 # so we need to convert to a mode string for IO::Handle->new_from_fd
1561 my $flagstr = ($flags & O_RDWR) ? 'rw' : ($flags & O_WRONLY) ? 'w' : 'r';
1562 my $handle = IO::Handle->new_from_fd($fd, $flagstr);
1563 return $handle if $handle;
1564 my $err = $!; # save error before closing the raw fd
1565 syscall(PVE::Syscall::close, $fd); # close
1571 my ($dirfd, $name, $mode) = @_;
1572 return syscall(PVE::Syscall::mkdirat, $dirfd, $name, $mode) == 0;
1575 sub fchownat($$$$$) {
1576 my ($dirfd, $pathname, $owner, $group, $flags) = @_;
1577 return syscall(PVE::Syscall::fchownat, $dirfd, $pathname, $owner, $group, $flags) == 0;
1580 my $salt_starter = time();
1586 my $salt = substr(Digest::SHA::sha1_base64(time() + $salt_starter + $$), 0, 8);
1588 # crypt does not want '+' in salt (see 'man crypt')
1591 return crypt(encode("utf8
", $pw), "\
$5\$$salt\$");
1594 # intended usage: convert_size($val, "kb
" => "gb
")
1595 # we round up to the next integer by default
1596 # E.g. `convert_size(1023, "b
" => "kb
")` returns 1
1597 # use $no_round_up to switch this off, above example would then return 0
1598 # this is also true for converting down e.g. 0.0005 gb to mb returns 1
1599 # (0 if $no_round_up is true)
1600 # allowed formats for value:
1606 my ($value, $from, $to, $no_round_up) = @_;
1617 die "no value
given"
1618 if !defined($value) || $value eq "";
1620 $from = lc($from // ''); $to = lc($to // '');
1621 die "unknown
'from' and/or 'to' units
($from => $to)"
1622 if !defined($units->{$from}) || !defined($units->{$to});
1624 die "value
'$value' is not a valid
, positive number
"
1625 if $value !~ m/^(?:[0-9]+\.?[0-9]*|[0-9]*\.[0-9]+)$/;
1627 my $shift_amount = ($units->{$from} - $units->{$to}) * 10;
1629 $value *= 2**$shift_amount;
1630 $value++ if !$no_round_up && ($value - int($value)) > 0.0;
1635 # uninterruptible readline
1637 sub readline_nointr {
1642 last if defined($line) || ($! != EINTR);
1649 $host_arch = (POSIX::uname())[4] if !$host_arch;
1653 # Devices are: [ (12 bits minor) (12 bits major) (8 bits minor) ]
1654 sub dev_t_major($) {
1656 return (int($dev_t) & 0xfff00) >> 8;
1659 sub dev_t_minor($) {
1661 $dev_t = int($dev_t);
1662 return (($dev_t >> 12) & 0xfff00) | ($dev_t & 0xff);
1665 # Given an array of array refs [ \[a b c], \[a b b], \[e b a] ]
1666 # Returns the intersection of elements as a single array [a b]
1667 sub array_intersect {
1670 if (!ref($arrays->[0])) {
1671 $arrays = [ grep { ref($_) eq 'ARRAY' } @_ ];
1674 return [] if scalar(@$arrays) == 0;
1675 return $arrays->[0] if scalar(@$arrays) == 1;
1677 my $array_unique = sub {
1679 return grep { ! $seen{ $_ }++ } @_;
1682 # base idea is to get all unique members from the first array, then
1683 # check the common elements with the next (uniquely made) one, only keep
1684 # those. Repeat for every array and at the end we only have those left
1685 # which exist in all arrays
1686 my $return_arr = [ $array_unique->(@{$arrays->[0]}) ];
1687 for my $i (1 .. $#$arrays) {
1689 # $return_arr is already unique, explicit at before the loop, implicit below.
1690 foreach my $element (@$return_arr, $array_unique->(@{$arrays->[$i]})) {
1694 foreach my $element (keys %count) {
1695 push @$return_arr, $element if $count{$element} > 1;
1697 last if scalar(@$return_arr) == 0; # empty intersection, early exit
1703 sub open_tree($$$) {
1704 my ($dfd, $pathname, $flags) = @_;
1705 return PVE::Syscall::file_handle_result(syscall(
1706 &PVE::Syscall::open_tree,
1713 sub move_mount($$$$$) {
1714 my ($from_dirfd, $from_pathname, $to_dirfd, $to_pathname, $flags) = @_;
1715 return 0 == syscall(
1716 &PVE::Syscall::move_mount,
1726 my ($fsname, $flags) = @_;
1727 return PVE::Syscall::file_handle_result(syscall(&PVE::Syscall::fsopen, $fsname, $flags));
1731 my ($fd, $flags, $mount_attrs) = @_;
1732 return PVE::Syscall::file_handle_result(syscall(
1733 &PVE::Syscall::fsmount,
1741 my ($dirfd, $pathname, $flags) = @_;
1742 return PVE::Syscall::file_handle_result(syscall(
1743 &PVE::Syscall::fspick,
1750 sub fsconfig($$$$$) {
1751 my ($fd, $command, $key, $value, $aux) = @_;
1752 return 0 == syscall(&PVE::Syscall::fsconfig, $fd, $command, $key, $value, $aux);
1755 # "raw
" mount, old api, not for generic use (as it does not invoke any helpers).
1756 # use for lower level stuff such as bind/remount/... or simple tmpfs mounts
1758 my ($source, $target, $filesystemtype, $mountflags, $data) = @_;
1759 return 0 == syscall(
1760 &PVE::Syscall::mount,