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
54 my $pvelogdir = "/var/log/pve";
55 my $pvetaskdir = "$pvelogdir/tasks";
60 my $IPV4OCTET = "(?:25[0-5]|(?:2[0-4]|1[0-9]|[1-9])?[0-9])";
61 our $IPV4RE = "(?:(?:$IPV4OCTET\\.){3}$IPV4OCTET)";
62 my $IPV6H16 = "(?:[0-9a-fA-F]{1,4})";
63 my $IPV6LS32 = "(?:(?:$IPV4RE|$IPV6H16:$IPV6H16))";
66 "(?:(?:" . "(?:$IPV6H16:){6})$IPV6LS32)|" .
67 "(?:(?:" . "::(?:$IPV6H16:){5})$IPV6LS32)|" .
68 "(?:(?:(?:" . "$IPV6H16)?::(?:$IPV6H16:){4})$IPV6LS32)|" .
69 "(?:(?:(?:(?:$IPV6H16:){0,1}$IPV6H16)?::(?:$IPV6H16:){3})$IPV6LS32)|" .
70 "(?:(?:(?:(?:$IPV6H16:){0,2}$IPV6H16)?::(?:$IPV6H16:){2})$IPV6LS32)|" .
71 "(?:(?:(?:(?:$IPV6H16:){0,3}$IPV6H16)?::(?:$IPV6H16:){1})$IPV6LS32)|" .
72 "(?:(?:(?:(?:$IPV6H16:){0,4}$IPV6H16)?::" . ")$IPV6LS32)|" .
73 "(?:(?:(?:(?:$IPV6H16:){0,5}$IPV6H16)?::" . ")$IPV6H16)|" .
74 "(?:(?:(?:(?:$IPV6H16:){0,6}$IPV6H16)?::" . ")))";
76 our $IPRE = "(?:$IPV4RE|$IPV6RE)";
78 use constant {CLONE_NEWNS
=> 0x00020000,
79 CLONE_NEWUTS
=> 0x04000000,
80 CLONE_NEWIPC
=> 0x08000000,
81 CLONE_NEWUSER
=> 0x10000000,
82 CLONE_NEWPID
=> 0x20000000,
83 CLONE_NEWNET
=> 0x40000000};
85 use constant {O_PATH
=> 0x00200000,
86 O_TMPFILE
=> 0x00410000}; # This includes O_DIRECTORY
88 sub run_with_timeout
{
89 my ($timeout, $code, @param) = @_;
91 die "got timeout\n" if $timeout <= 0;
93 my $prev_alarm = alarm 0; # suspend outer alarm early
100 local $SIG{ALRM
} = sub { $sigcount++; die "got timeout\n"; };
101 local $SIG{PIPE
} = sub { $sigcount++; die "broken pipe\n" };
102 local $SIG{__DIE__
}; # see SA bug 4631
106 eval { $res = &$code(@param); };
108 alarm(0); # avoid race conditions
117 # this shouldn't happen anymore?
118 die "unknown error" if $sigcount && !$err; # seems to happen sometimes
125 # flock: we use one file handle per process, so lock file
126 # can be nested multiple times and succeeds for the same process.
128 # Since this is the only way we lock now and we don't have the old
129 # 'lock(); code(); unlock();' pattern anymore we do not actually need to
130 # count how deep we're nesting. Therefore this hash now stores a weak reference
131 # to a boolean telling us whether we already have a lock.
133 my $lock_handles = {};
136 my ($filename, $timeout, $shared, $code, @param) = @_;
138 $timeout = 10 if !$timeout;
140 my $mode = $shared ? LOCK_SH
: LOCK_EX
;
142 my $lockhash = ($lock_handles->{$$} //= {});
144 # Returns a locked file handle.
145 my $get_locked_file = sub {
146 my $fh = IO
::File-
>new(">>$filename")
147 or die "can't open file - $!\n";
149 if (!flock($fh, $mode|LOCK_NB
)) {
150 print STDERR
"trying to acquire lock...\n";
153 $success = flock($fh, $mode);
154 # try again on EINTR (see bug #273)
155 if ($success || ($! != EINTR
)) {
160 print STDERR
" failed\n";
161 die "can't acquire lock '$filename' - $!\n";
163 print STDERR
" OK\n";
170 my $checkptr = $lockhash->{$filename};
171 my $check = 0; # This must not go out of scope before running the code.
172 my $local_fh; # This must stay local
173 if (!$checkptr || !$$checkptr) {
174 # We cannot create a weak reference in a single atomic step, so we first
175 # create a false-value, then create a reference to it, then weaken it,
176 # and after successfully locking the file we change the boolean value.
178 # The reason for this is that if an outer SIGALRM throws an exception
179 # between creating the reference and weakening it, a subsequent call to
180 # lock_file_full() will see a leftover full reference to a valid
181 # variable. This variable must be 0 in order for said call to attempt to
182 # lock the file anew.
184 # An externally triggered exception elsewhere in the code will cause the
185 # weak reference to become 'undef', and since the file handle is only
186 # stored in the local scope in $local_fh, the file will be closed by
187 # perl's cleanup routines as well.
189 # This still assumes that an IO::File handle can properly deal with such
190 # exceptions thrown during its own destruction, but that's up to perls
192 $lockhash->{$filename} = \
$check;
193 weaken
$lockhash->{$filename};
194 $local_fh = eval { run_with_timeout
($timeout, $get_locked_file) };
196 $@ = "can't lock file '$filename' - $@";
201 $res = eval { &$code(@param); };
208 my ($filename, $timeout, $code, @param) = @_;
210 return lock_file_full
($filename, $timeout, 0, $code, @param);
213 sub file_set_contents
{
214 my ($filename, $data, $perm) = @_;
216 $perm = 0644 if !defined($perm);
218 my $tmpname = "$filename.tmp.$$";
221 my ($fh, $tries) = (undef, 0);
222 while (!$fh && $tries++ < 3) {
223 $fh = IO
::File-
>new($tmpname, O_WRONLY
|O_CREAT
|O_EXCL
, $perm);
224 if (!$fh && $! == EEXIST
) {
225 unlink($tmpname) or die "unable to delete old temp file: $!\n";
228 die "unable to open file '$tmpname' - $!\n" if !$fh;
229 die "unable to write '$tmpname' - $!\n" unless print $fh $data;
230 die "closing file '$tmpname' failed - $!\n" unless close $fh;
239 if (!rename($tmpname, $filename)) {
240 my $msg = "close (rename) atomic file '$filename' failed: $!\n";
246 sub file_get_contents
{
247 my ($filename, $max) = @_;
249 my $fh = IO
::File-
>new($filename, "r") ||
250 die "can't open '$filename' - $!\n";
252 my $content = safe_read_from
($fh, $max, 0, $filename);
260 my ($filename, $dst, $max, $perm) = @_;
262 file_set_contents
($dst, file_get_contents
($filename, $max), $perm);
265 sub file_read_firstline
{
268 my $fh = IO
::File-
>new ($filename, "r");
269 return undef if !$fh;
277 my ($fh, $max, $oneline, $filename) = @_;
279 $max = 32768 if !$max;
281 my $subject = defined($filename) ?
"file '$filename'" : 'input';
286 while ($count = sysread($fh, $input, 8192, $br)) {
288 die "$subject too long - aborting\n" if $br > $max;
289 if ($oneline && $input =~ m/^(.*)\n/) {
294 die "unable to read $subject - $!\n" if !defined($count);
299 # The $cmd parameter can be:
301 # This is generally executed by passing it to the shell with the -c option.
302 # However, it can be executed in one of two ways, depending on whether
303 # there's a pipe involved:
304 # *) with pipe: passed explicitly to bash -c, prefixed with:
306 # *) without a pipe: passed to perl's open3 which uses 'sh -c'
307 # (Note that this may result in two different syntax requirements!)
309 # -) an array of arguments (strings)
310 # Will be executed without interference from a shell. (Parameters are passed
311 # as is, no escape sequences of strings will be touched.)
312 # -) an array of arrays
313 # Each array represents a command, and each command's output is piped into
314 # the following command's standard input.
315 # For this a shell command string is created with pipe symbols between each
317 # Each command is a list of strings meant to end up in the final command
318 # unchanged. In order to achieve this, every argument is shell-quoted.
319 # Quoting can be disabled for a particular argument by turning it into a
320 # reference, this allows inserting arbitrary shell options.
321 # For instance: the $cmd [ [ 'echo', 'hello', \'>/dev/null' ] ] will not
322 # produce any output, while the $cmd [ [ 'echo', 'hello', '>/dev/null' ] ]
323 # will literally print: hello >/dev/null
325 my ($cmd, %param) = @_;
330 if (my $ref = ref($cmd)) {
331 if (ref($cmd->[0])) {
332 $cmdstr = 'set -o pipefail && ';
334 foreach my $command (@$cmd) {
335 # concatenate quoted parameters
336 # strings which are passed by reference are NOT shell quoted
337 $cmdstr .= $pipe . join(' ', map { ref($_) ?
$$_ : shellquote
($_) } @$command);
340 $cmd = [ '/bin/bash', '-c', "$cmdstr" ];
342 $cmdstr = cmd2string
($cmd);
347 # see 'man bash' for option pipefail
348 $cmd = [ '/bin/bash', '-c', "set -o pipefail && $cmd" ];
373 foreach my $p (keys %param) {
374 if ($p eq 'timeout') {
375 $timeout = $param{$p};
376 } elsif ($p eq 'umask') {
377 $old_umask = umask($param{$p});
378 } elsif ($p eq 'errmsg') {
379 $errmsg = $param{$p};
380 } elsif ($p eq 'input') {
382 } elsif ($p eq 'output') {
383 $output = $param{$p};
384 } elsif ($p eq 'outfunc') {
385 $outfunc = $param{$p};
386 } elsif ($p eq 'errfunc') {
387 $errfunc = $param{$p};
388 } elsif ($p eq 'logfunc') {
389 $logfunc = $param{$p};
390 } elsif ($p eq 'afterfork') {
391 $afterfork = $param{$p};
392 } elsif ($p eq 'noerr') {
394 } elsif ($p eq 'keeplocale') {
395 $keeplocale = $param{$p};
396 } elsif ($p eq 'quiet') {
399 die "got unknown parameter '$p' for run_command\n";
404 my $origerrfunc = $errfunc;
408 &$origerrfunc("$laststderr\n");
410 print STDERR
"$laststderr\n" if $laststderr;
417 my $reader = $output && $output =~ m/^>&/ ?
$output : IO
::File-
>new();
418 my $writer = $input && $input =~ m/^<&/ ?
$input : IO
::File-
>new();
419 my $error = IO
::File-
>new();
424 local $ENV{LC_ALL
} = 'C' if !$keeplocale;
426 # suppress LVM warnings like: "File descriptor 3 left open";
427 local $ENV{LVM_SUPPRESS_FD_WARNINGS
} = "1";
429 $pid = open3
($writer, $reader, $error, @$cmd) || die $!;
431 # if we pipe fron STDIN, open3 closes STDIN, so we we
432 # a perl warning "Filehandle STDIN reopened as GENXYZ .. "
433 # as soon as we open a new file.
434 # to avoid that we open /dev/null
435 if (!ref($writer) && !defined(fileno(STDIN
))) {
437 open(STDIN
, "</dev/null");
444 if ($orig_pid != $$) {
452 local $SIG{ALRM
} = sub { die "got timeout\n"; } if $timeout;
453 $oldtimeout = alarm($timeout) if $timeout;
455 &$afterfork() if $afterfork;
458 print $writer $input if defined $input;
462 my $select = new IO
::Select
;
463 $select->add($reader) if ref($reader);
464 $select->add($error);
469 my $starttime = time();
471 while ($select->count) {
472 my @handles = $select->can_read(1);
474 foreach my $h (@handles) {
476 my $count = sysread ($h, $buf, 4096);
477 if (!defined ($count)) {
483 $select->remove ($h) if !$count;
485 if ($outfunc || $logfunc) {
488 while ($outlog =~ s/^([^\010\r\n]*)(\r|\n|(\010)+|\r\n)//s) {
490 &$outfunc($line) if $outfunc;
491 &$logfunc($line) if $logfunc;
504 } elsif ($h eq $error) {
505 if ($errfunc || $logfunc) {
508 while ($errlog =~ s/^([^\010\r\n]*)(\r|\n|(\010)+|\r\n)//s) {
510 &$errfunc($line) if $errfunc;
511 &$logfunc($line) if $logfunc;
528 &$outfunc($outlog) if $outfunc && $outlog;
529 &$logfunc($outlog) if $logfunc && $outlog;
531 &$errfunc($errlog) if $errfunc && $errlog;
532 &$logfunc($errlog) if $logfunc && $errlog;
537 die "failed to execute\n";
538 } elsif (my $sig = ($? & 127)) {
539 die "got signal $sig\n";
540 } elsif ($exitcode = ($? >> 8)) {
541 if (!($exitcode == 24 && ($cmdstr =~ m
|^(\S
+/)?rsync\s
|))) {
542 if ($errmsg && $laststderr) {
543 my $lerr = $laststderr;
547 die "exit code $exitcode\n";
558 if ($errmsg && $laststderr) {
559 &$errfunc(undef); # flush laststderr
562 umask ($old_umask) if defined($old_umask);
564 alarm($oldtimeout) if $oldtimeout;
567 if ($pid && ($err eq "got timeout\n")) {
570 die "command '$cmdstr' failed: $err";
574 $err =~ s/^usermod:\s*// if $cmdstr =~ m
|^(\S
+/)?usermod\s
|;
577 die "command '$cmdstr' failed: $err";
584 # Run a command with a tcp socket as standard input.
585 sub pipe_socket_to_command
{
586 my ($cmd, $ip, $port) = @_;
591 Proto
=> &Socket
::IPPROTO_TCP
,
592 GetAddrInfoFlags
=> 0,
596 my $socket = IO
::Socket
::IP-
>new(%$params) or die "failed to open socket: $!\n";
598 print "$ip\n$port\n"; # tell remote where to connect
602 local $SIG{ALRM
} = sub { die "timed out waiting for client\n" };
604 my $client = $socket->accept; # Wait for a client
608 # We want that the command talks over the TCP socket and takes
609 # ownership of it, so that when it closes it the connection is
610 # terminated, so we need to be able to close the socket. So we
611 # can't really use PVE::Tools::run_command().
612 my $pid = fork() // die "fork failed: $!\n";
614 POSIX
::dup2
(fileno($client), 0);
615 POSIX
::dup2
(fileno($client), 1);
617 exec {$cmd->[0]} @$cmd or do {
618 warn "exec failed: $!\n";
624 if (waitpid($pid, 0) != $pid) {
625 kill(15 => $pid); # if we got interrupted terminate the child
627 while (waitpid($pid, POSIX
::WNOHANG
) != $pid) {
630 kill(9 => $pid), last if $count > 300; # 30 second timeout
633 if (my $sig = ($? & 127)) {
634 die "got signal $sig\n";
635 } elsif (my $exitcode = ($? >> 8)) {
636 die "exit code $exitcode\n";
643 my $listtxt = shift // '';
645 return split (/\0/, $listtxt) if $listtxt =~ m/\0/;
647 $listtxt =~ s/[,;]/ /g;
648 $listtxt =~ s/^\s+//;
650 my @data = split (/\s+/, $listtxt);
658 return $txt if !defined($txt);
666 # simple uri templates like "/vms/{vmid}"
667 sub template_replace
{
668 my ($tmpl, $data) = @_;
670 return $tmpl if !$tmpl;
673 while ($tmpl =~ m/([^{]+)?(\{([^}]+)\})?/g) {
675 $res .= ($data->{$3} || '-') if $2;
681 my ($filename, $fh, $data) = @_;
685 my $res = print $fh $data;
687 die "write to '$filename' failed\n" if !$res;
693 'at' => 'ftp.at.debian.org',
694 'au' => 'ftp.au.debian.org',
695 'be' => 'ftp.be.debian.org',
696 'bg' => 'ftp.bg.debian.org',
697 'br' => 'ftp.br.debian.org',
698 'ca' => 'ftp.ca.debian.org',
699 'ch' => 'ftp.ch.debian.org',
700 'cl' => 'ftp.cl.debian.org',
701 'cz' => 'ftp.cz.debian.org',
702 'de' => 'ftp.de.debian.org',
703 'dk' => 'ftp.dk.debian.org',
704 'ee' => 'ftp.ee.debian.org',
705 'es' => 'ftp.es.debian.org',
706 'fi' => 'ftp.fi.debian.org',
707 'fr' => 'ftp.fr.debian.org',
708 'gr' => 'ftp.gr.debian.org',
709 'hk' => 'ftp.hk.debian.org',
710 'hr' => 'ftp.hr.debian.org',
711 'hu' => 'ftp.hu.debian.org',
712 'ie' => 'ftp.ie.debian.org',
713 'is' => 'ftp.is.debian.org',
714 'it' => 'ftp.it.debian.org',
715 'jp' => 'ftp.jp.debian.org',
716 'kr' => 'ftp.kr.debian.org',
717 'mx' => 'ftp.mx.debian.org',
718 'nl' => 'ftp.nl.debian.org',
719 'no' => 'ftp.no.debian.org',
720 'nz' => 'ftp.nz.debian.org',
721 'pl' => 'ftp.pl.debian.org',
722 'pt' => 'ftp.pt.debian.org',
723 'ro' => 'ftp.ro.debian.org',
724 'ru' => 'ftp.ru.debian.org',
725 'se' => 'ftp.se.debian.org',
726 'si' => 'ftp.si.debian.org',
727 'sk' => 'ftp.sk.debian.org',
728 'tr' => 'ftp.tr.debian.org',
729 'tw' => 'ftp.tw.debian.org',
730 'gb' => 'ftp.uk.debian.org',
731 'us' => 'ftp.us.debian.org',
736 'dk' => ['Danish', 'da', 'qwerty/dk-latin1.kmap.gz', 'dk', 'nodeadkeys'],
737 'de' => ['German', 'de', 'qwertz/de-latin1-nodeadkeys.kmap.gz', 'de', 'nodeadkeys' ],
738 'de-ch' => ['Swiss-German', 'de-ch', 'qwertz/sg-latin1.kmap.gz', 'ch', 'de_nodeadkeys' ],
739 'en-gb' => ['United Kingdom', 'en-gb', 'qwerty/uk.kmap.gz' , 'gb', undef],
740 'en-us' => ['U.S. English', 'en-us', 'qwerty/us-latin1.kmap.gz', 'us', undef ],
741 'es' => ['Spanish', 'es', 'qwerty/es.kmap.gz', 'es', 'nodeadkeys'],
742 #'et' => [], # Ethopia or Estonia ??
743 'fi' => ['Finnish', 'fi', 'qwerty/fi-latin1.kmap.gz', 'fi', 'nodeadkeys'],
744 #'fo' => ['Faroe Islands', 'fo', ???, 'fo', 'nodeadkeys'],
745 'fr' => ['French', 'fr', 'azerty/fr-latin1.kmap.gz', 'fr', 'nodeadkeys'],
746 'fr-be' => ['Belgium-French', 'fr-be', 'azerty/be2-latin1.kmap.gz', 'be', 'nodeadkeys'],
747 'fr-ca' => ['Canada-French', 'fr-ca', 'qwerty/cf.kmap.gz', 'ca', 'fr-legacy'],
748 'fr-ch' => ['Swiss-French', 'fr-ch', 'qwertz/fr_CH-latin1.kmap.gz', 'ch', 'fr_nodeadkeys'],
749 #'hr' => ['Croatia', 'hr', 'qwertz/croat.kmap.gz', 'hr', ??], # latin2?
750 'hu' => ['Hungarian', 'hu', 'qwertz/hu.kmap.gz', 'hu', undef],
751 'is' => ['Icelandic', 'is', 'qwerty/is-latin1.kmap.gz', 'is', 'nodeadkeys'],
752 'it' => ['Italian', 'it', 'qwerty/it2.kmap.gz', 'it', 'nodeadkeys'],
753 'jp' => ['Japanese', 'ja', 'qwerty/jp106.kmap.gz', 'jp', undef],
754 'lt' => ['Lithuanian', 'lt', 'qwerty/lt.kmap.gz', 'lt', 'std'],
755 #'lv' => ['Latvian', 'lv', 'qwerty/lv-latin4.kmap.gz', 'lv', ??], # latin4 or latin7?
756 'mk' => ['Macedonian', 'mk', 'qwerty/mk.kmap.gz', 'mk', 'nodeadkeys'],
757 'nl' => ['Dutch', 'nl', 'qwerty/nl.kmap.gz', 'nl', undef],
758 #'nl-be' => ['Belgium-Dutch', 'nl-be', ?, ?, ?],
759 'no' => ['Norwegian', 'no', 'qwerty/no-latin1.kmap.gz', 'no', 'nodeadkeys'],
760 'pl' => ['Polish', 'pl', 'qwerty/pl.kmap.gz', 'pl', undef],
761 'pt' => ['Portuguese', 'pt', 'qwerty/pt-latin1.kmap.gz', 'pt', 'nodeadkeys'],
762 'pt-br' => ['Brazil-Portuguese', 'pt-br', 'qwerty/br-latin1.kmap.gz', 'br', 'nodeadkeys'],
763 #'ru' => ['Russian', 'ru', 'qwerty/ru.kmap.gz', 'ru', undef], # don't know?
764 'si' => ['Slovenian', 'sl', 'qwertz/slovene.kmap.gz', 'si', undef],
765 'se' => ['Swedish', 'sv', 'qwerty/se-latin1.kmap.gz', 'se', 'nodeadkeys'],
767 'tr' => ['Turkish', 'tr', 'qwerty/trq.kmap.gz', 'tr', undef],
770 my $kvmkeymaparray = [];
771 foreach my $lc (sort keys %$keymaphash) {
772 push @$kvmkeymaparray, $keymaphash->{$lc}->[1];
780 return $kvmkeymaparray;
784 my ($param, $key) = @_;
786 my $res = $param->{$key};
787 delete $param->{$key};
792 # Note: we use this to wait until vncterm/spiceterm is ready
793 sub wait_for_vnc_port
{
794 my ($port, $family, $timeout) = @_;
796 $timeout = 5 if !$timeout;
798 my $starttime = [gettimeofday
];
801 my $cmd = ['/bin/ss', '-Htln', "sport = :$port"];
802 push @$cmd, $family == AF_INET6 ?
'-6' : '-4' if defined($family);
805 while (($elapsed = tv_interval
($starttime)) < $timeout) {
806 # -Htln = don't print header, tcp, listening sockets only, numeric ports
807 run_command
($cmd, outfunc
=> sub {
809 if ($line =~ m/^LISTEN\s+\d+\s+\d+\s+\S+:(\d+)\s/) {
810 $found = 1 if ($port == $1);
814 $sleeptime += 100000 if $sleeptime < 1000000;
818 die "Timeout while waiting for port '$port' to get ready!\n";
821 sub next_unused_port
{
822 my ($range_start, $range_end, $family, $address) = @_;
824 # We use a file to register allocated ports.
825 # Those registrations expires after $expiretime.
826 # We use this to avoid race conditions between
827 # allocation and use of ports.
829 my $filename = "/var/tmp/pve-reserved-ports";
838 if (my $fh = IO
::File-
>new ($filename, "r")) {
839 while (my $line = <$fh>) {
840 if ($line =~ m/^(\d+)\s(\d+)$/) {
841 my ($port, $timestamp) = ($1, $2);
842 if (($timestamp + $expiretime) > $ctime) {
843 $ports->{$port} = $timestamp; # not expired
850 my %sockargs = (Listen
=> 5,
853 Proto
=> IPPROTO_TCP
,
854 GetAddrInfoFlags
=> 0);
855 $sockargs{LocalAddr
} = $address if defined($address);
857 for (my $p = $range_start; $p < $range_end; $p++) {
858 next if $ports->{$p}; # reserved
860 $sockargs{LocalPort
} = $p;
861 my $sock = IO
::Socket
::IP-
>new(%sockargs);
866 $ports->{$p} = $ctime;
872 foreach my $p (keys %$ports) {
873 $data .= "$p $ports->{$p}\n";
876 file_set_contents
($filename, $data);
881 my $p = lock_file
('/var/lock/pve-ports.lck', 10, $code);
884 die "unable to find free port (${range_start}-${range_end})\n" if !$p;
889 sub next_migrate_port
{
890 my ($family, $address) = @_;
891 return next_unused_port
(60000, 60050, $family, $address);
895 my ($family, $address) = @_;
896 return next_unused_port
(5900, 6000, $family, $address);
899 sub next_spice_port
{
900 my ($family, $address) = @_;
901 return next_unused_port
(61000, 61099, $family, $address);
906 eval { $value = "$value" };
907 return "error turning value into a string: $@" if $@;
911 # sigkill after $timeout a $sub running in a fork if it can't write a pipe
912 # the $sub has to return a single scalar
913 sub run_fork_with_timeout
{
914 my ($timeout, $sub) = @_;
918 my $pipe_out = IO
::Pipe-
>new();
920 # disable pending alarms, save their remaining time
921 my $prev_alarm = alarm 0;
923 # avoid leaving a zombie if the parent gets interrupted
927 if (!defined($child)) {
928 die "fork failed: $!\n";
937 print {$pipe_out} encode_json
({ result
=> $res });
941 print {$pipe_out} encode_json
({ error
=> must_stringify
($err) });
948 local $SIG{INT
} = sub { $sig_received++; };
949 local $SIG{TERM
} = sub {
950 $error //= "interrupted by unexpected signal\n";
951 kill('TERM', $child);
956 my $readvalues = sub {
958 my $child_res = decode_json
(readline_nointr
($pipe_out));
959 $res = $child_res->{result
};
960 $error = $child_res->{error
};
963 if (defined($timeout)) {
964 run_with_timeout
($timeout, $readvalues);
971 kill('KILL', $child);
975 die "interrupted by unexpected signal\n" if $sig_received;
977 die $error if $error;
983 return run_fork_with_timeout
(undef, $code);
986 # NOTE: NFS syscall can't be interrupted, so alarm does
987 # not work to provide timeouts.
988 # from 'man nfs': "Only SIGKILL can interrupt a pending NFS operation"
989 # So fork() before using Filesys::Df
991 my ($path, $timeout) = @_;
993 my $df = sub { return Filesys
::Df
::df
($path, 1) };
995 my $res = eval { run_fork_with_timeout
($timeout, $df) } // {};
999 my ($blocks, $used, $bavail) = map { defined($_) ?
(/^(\d+)$/) : 0 }
1000 $res->@{qw(blocks used bavail)};
1010 my ($path, $timeout) = @_;
1019 if ($line =~ m/^(\d+)\s+total$/) {
1024 run_command
(['du', '-scb', $path], outfunc
=> $parser, timeout
=> $timeout);
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
1387 sub setresuid
($$$) {
1388 my ($ruid, $euid, $suid) = @_;
1389 return 0 == syscall(PVE
::Syscall
::setresuid
, $ruid, $euid, $suid);
1394 return 0 == syscall(PVE
::Syscall
::unshare
, $flags);
1398 my ($fileno, $nstype) = @_;
1399 return 0 == syscall(PVE
::Syscall
::setns
, $fileno, $nstype);
1404 return 0 == syscall(PVE
::Syscall
::syncfs
, $fileno);
1409 return 0 == syscall(PVE
::Syscall
::fsync
, $fileno);
1412 sub sync_mountpoint
{
1414 sysopen my $fd, $path, O_PATH
or die "failed to open $path: $!\n";
1415 my $result = syncfs
(fileno($fd));
1420 # support sending multi-part mail messages with a text and or a HTML part
1421 # mailto may be a single email string or an array of receivers
1423 my ($mailto, $subject, $text, $html, $mailfrom, $author) = @_;
1424 my $mail_re = qr/[^-a-zA-Z0-9+._@]/;
1426 $mailto = [ $mailto ] if !ref($mailto);
1428 foreach (@$mailto) {
1429 die "illegal character in mailto address\n"
1430 if ($_ =~ $mail_re);
1433 my $rcvrtxt = join (', ', @$mailto);
1435 $mailfrom = $mailfrom || "root";
1436 die "illegal character in mailfrom address\n"
1437 if $mailfrom =~ $mail_re;
1439 $author = $author || 'Proxmox VE';
1441 open (MAIL
, "|-", "sendmail", "-B", "8BITMIME", "-f", $mailfrom, @$mailto) ||
1442 die "unable to open 'sendmail' - $!";
1444 # multipart spec see https://www.ietf.org/rfc/rfc1521.txt
1445 my $boundary = "----_=_NextPart_001_".int(time).$$;
1447 print MAIL
"Content-Type: multipart/alternative;\n";
1448 print MAIL
"\tboundary=\"$boundary\"\n";
1449 print MAIL "MIME-Version
: 1.0\n";
1451 print MAIL "FROM
: $author <$mailfrom>\n";
1452 print MAIL "TO
: $rcvrtxt\n";
1453 print MAIL "SUBJECT
: $subject\n";
1455 print MAIL "This
is a multi-part message
in MIME format
.\n\n";
1456 print MAIL "--$boundary\n";
1458 if (defined($text)) {
1459 print MAIL "Content-Type
: text
/plain
;\n";
1460 print MAIL "\tcharset
=\"UTF8
\"\n";
1461 print MAIL "Content-Transfer-Encoding
: 8bit
\n";
1464 # avoid 'remove extra line breaks' issue (MS Outlook)
1466 $text =~ s/^/$fill/gm;
1470 print MAIL "\n--$boundary\n";
1473 if (defined($html)) {
1474 print MAIL "Content-Type
: text
/html
;\n";
1475 print MAIL "\tcharset
=\"UTF8
\"\n";
1476 print MAIL "Content-Transfer-Encoding
: 8bit
\n";
1481 print MAIL "\n--$boundary--\n";
1488 my ($perm, %opts) = @_;
1490 # default permissions are stricter than with file_set_contents
1491 $perm = 0600 if !defined($perm);
1493 my $dir = $opts{dir} // '/run';
1494 my $mode = $opts{mode} // O_RDWR;
1495 $mode |= O_EXCL if !$opts{allow_links};
1497 my $fh = IO::File->new($dir, $mode | O_TMPFILE, $perm);
1498 if (!$fh && $! == EOPNOTSUPP) {
1499 $dir = '/tmp' if !defined($opts{dir});
1500 $dir .= "/.tmpfile
.$$";
1501 $fh = IO::File->new($dir, $mode | O_CREAT | O_EXCL, $perm);
1502 unlink($dir) if $fh;
1504 die "failed to create tempfile
: $!\n" if !$fh;
1508 sub tempfile_contents {
1509 my ($data, $perm, %opts) = @_;
1511 my $fh = tempfile($perm, %opts);
1513 die "unable to
write to tempfile
: $!\n" if !print {$fh} $data;
1514 die "unable to flush to tempfile
: $!\n" if !defined($fh->flush());
1521 return ("/proc/$$/fd/".$fh->fileno, $fh);
1524 sub validate_ssh_public_keys {
1526 my @lines = split(/\n/, $raw);
1528 foreach my $line (@lines) {
1529 next if $line =~ m/^\s*$/;
1531 my ($filename, $handle) = tempfile_contents($line);
1532 run_command(["ssh-keygen
", "-l
", "-f
", $filename],
1533 outfunc => sub {}, errfunc => sub {});
1535 die "SSH public key validation error
\n" if $@;
1540 my ($dirfd, $pathname, $flags, $mode) = @_;
1541 my $fd = syscall(PVE::Syscall::openat, $dirfd, $pathname, $flags, $mode//0);
1542 return undef if $fd < 0;
1543 # sysopen() doesn't deal with numeric file descriptors apparently
1544 # so we need to convert to a mode string for IO::Handle->new_from_fd
1545 my $flagstr = ($flags & O_RDWR) ? 'rw' : ($flags & O_WRONLY) ? 'w' : 'r';
1546 my $handle = IO::Handle->new_from_fd($fd, $flagstr);
1547 return $handle if $handle;
1548 my $err = $!; # save error before closing the raw fd
1549 syscall(PVE::Syscall::close, $fd); # close
1555 my ($dirfd, $name, $mode) = @_;
1556 return syscall(PVE::Syscall::mkdirat, $dirfd, $name, $mode) == 0;
1559 my $salt_starter = time();
1565 my $salt = substr(Digest::SHA::sha1_base64(time() + $salt_starter + $$), 0, 8);
1567 # crypt does not want '+' in salt (see 'man crypt')
1570 return crypt(encode("utf8
", $pw), "\
$5\$$salt\$");
1573 # intended usage: convert_size($val, "kb
" => "gb
")
1574 # we round up to the next integer by default
1575 # E.g. `convert_size(1023, "b
" => "kb
")` returns 1
1576 # use $no_round_up to switch this off, above example would then return 0
1577 # this is also true for converting down e.g. 0.0005 gb to mb returns 1
1578 # (0 if $no_round_up is true)
1579 # allowed formats for value:
1585 my ($value, $from, $to, $no_round_up) = @_;
1596 die "no value
given"
1597 if !defined($value) || $value eq "";
1599 $from = lc($from // ''); $to = lc($to // '');
1600 die "unknown
'from' and/or 'to' units
($from => $to)"
1601 if !defined($units->{$from}) || !defined($units->{$to});
1603 die "value
'$value' is not a valid
, positive number
"
1604 if $value !~ m/^(?:[0-9]+\.?[0-9]*|[0-9]*\.[0-9]+)$/;
1606 my $shift_amount = ($units->{$from} - $units->{$to}) * 10;
1608 $value *= 2**$shift_amount;
1609 $value++ if !$no_round_up && ($value - int($value)) > 0.0;
1614 # uninterruptible readline
1616 sub readline_nointr {
1621 last if defined($line) || ($! != EINTR);
1628 my @uname = POSIX::uname();
1629 my $machine = $uname[4];
1631 if ($machine eq 'x86_64') {
1633 } elsif ($machine eq 'aarch64') {
1636 die "unsupported host architecture
'$machine'\n";
1640 # Devices are: [ (12 bits minor) (12 bits major) (8 bits minor) ]
1641 sub dev_t_major($) {
1643 return (int($dev_t) & 0xfff00) >> 8;
1646 sub dev_t_minor($) {
1648 $dev_t = int($dev_t);
1649 return (($dev_t >> 12) & 0xfff00) | ($dev_t & 0xff);
1652 # Given an array of array refs [ \[a b c], \[a b b], \[e b a] ]
1653 # Returns the intersection of elements as a single array [a b]
1654 sub array_intersect {
1657 return [] if @$arrays == 0;
1658 return $arrays->[0] if @$arrays == 1;
1661 @$return_arr = array_unique(@{$arrays->[0]});
1662 for my $i (1 .. $#$arrays) {
1664 foreach my $element (@$return_arr, array_unique(@{$arrays->[$i]})) {
1668 foreach my $element (keys %count) {
1669 push @$return_arr, $element if $count{$element} > 1;
1678 return grep { ! $seen{ $_ }++ } @_;