X-Git-Url: https://git.proxmox.com/?p=pve-common.git;a=blobdiff_plain;f=src%2FPVE%2FTools.pm;h=da7da5d36146a51a5d95276faaa822284ecaf91d;hp=0fb7f3c0b15b6a47a4c7d33a29b2f8db60e3339b;hb=a0ecb15991e5faf6aeaa221a7502d60f9eb45d51;hpb=123921731abd556c038c746973fee1a1c87b6920 diff --git a/src/PVE/Tools.pm b/src/PVE/Tools.pm index 0fb7f3c..da7da5d 100644 --- a/src/PVE/Tools.pm +++ b/src/PVE/Tools.pm @@ -2,9 +2,10 @@ package PVE::Tools; use strict; use warnings; -use POSIX qw(EINTR); +use POSIX qw(EINTR EEXIST EOPNOTSUPP); use IO::Socket::IP; -use Socket qw(AF_INET AF_INET6 AI_ALL AI_V4MAPPED); +use Socket qw(AF_INET AF_INET6 AI_ALL AI_V4MAPPED AI_CANONNAME SOCK_DGRAM + IPPROTO_TCP); use IO::Select; use File::Basename; use File::Path qw(make_path); @@ -25,6 +26,8 @@ use Time::HiRes qw(usleep gettimeofday tv_interval alarm); use Net::DBus qw(dbus_uint32 dbus_uint64); use Net::DBus::Callback; use Net::DBus::Reactor; +use Scalar::Util 'weaken'; +use PVE::Syscall; # avoid warning when parsing long hex values with hex() no warnings 'portable'; # Support for 64-bit ints required @@ -32,10 +35,10 @@ no warnings 'portable'; # Support for 64-bit ints required our @EXPORT_OK = qw( $IPV6RE $IPV4RE -lock_file +lock_file lock_file_full -run_command -file_set_contents +run_command +file_set_contents file_get_contents file_read_firstline dir_glob_regex @@ -122,7 +125,12 @@ sub run_with_timeout { } # flock: we use one file handle per process, so lock file -# can be called multiple times and succeeds for the same process. +# can be nested multiple times and succeeds for the same process. +# +# Since this is the only way we lock now and we don't have the old +# 'lock(); code(); unlock();' pattern anymore we do not actually need to +# count how deep we're nesting. Therefore this hash now stores a weak reference +# to a boolean telling us whether we already have a lock. my $lock_handles = {}; @@ -133,58 +141,67 @@ sub lock_file_full { my $mode = $shared ? LOCK_SH : LOCK_EX; - my $lock_func = sub { - if (!$lock_handles->{$$}->{$filename}) { - my $fh = new IO::File(">>$filename") || - die "can't open file - $!\n"; - $lock_handles->{$$}->{$filename} = { fh => $fh, refcount => 0}; - } + my $lockhash = ($lock_handles->{$$} //= {}); + + # Returns a locked file handle. + my $get_locked_file = sub { + my $fh = IO::File->new(">>$filename") + or die "can't open file - $!\n"; - if (!flock($lock_handles->{$$}->{$filename}->{fh}, $mode|LOCK_NB)) { - print STDERR "trying to acquire lock..."; + if (!flock($fh, $mode|LOCK_NB)) { + print STDERR "trying to acquire lock..."; my $success; while(1) { - $success = flock($lock_handles->{$$}->{$filename}->{fh}, $mode); + $success = flock($fh, $mode); # try again on EINTR (see bug #273) if ($success || ($! != EINTR)) { last; } } - if (!$success) { - print STDERR " failed\n"; - die "can't acquire lock '$filename' - $!\n"; - } - print STDERR " OK\n"; - } - $lock_handles->{$$}->{$filename}->{refcount}++; + if (!$success) { + print STDERR " failed\n"; + die "can't acquire lock '$filename' - $!\n"; + } + print STDERR " OK\n"; + } + + return $fh; }; my $res; - - eval { run_with_timeout($timeout, $lock_func); }; - my $err = $@; - if ($err) { - $err = "can't lock file '$filename' - $err"; - } else { - eval { $res = &$code(@param) }; - $err = $@; - } - - if (my $fh = $lock_handles->{$$}->{$filename}->{fh}) { - my $refcount = --$lock_handles->{$$}->{$filename}->{refcount}; - if ($refcount <= 0) { - $lock_handles->{$$}->{$filename} = undef; - close ($fh); + my $checkptr = $lockhash->{$filename}; + my $check = 0; # This must not go out of scope before running the code. + my $local_fh; # This must stay local + if (!$checkptr || !$$checkptr) { + # We cannot create a weak reference in a single atomic step, so we first + # create a false-value, then create a reference to it, then weaken it, + # and after successfully locking the file we change the boolean value. + # + # The reason for this is that if an outer SIGALRM throws an exception + # between creating the reference and weakening it, a subsequent call to + # lock_file_full() will see a leftover full reference to a valid + # variable. This variable must be 0 in order for said call to attempt to + # lock the file anew. + # + # An externally triggered exception elsewhere in the code will cause the + # weak reference to become 'undef', and since the file handle is only + # stored in the local scope in $local_fh, the file will be closed by + # perl's cleanup routines as well. + # + # This still assumes that an IO::File handle can properly deal with such + # exceptions thrown during its own destruction, but that's up to perls + # guts now. + $lockhash->{$filename} = \$check; + weaken $lockhash->{$filename}; + $local_fh = eval { run_with_timeout($timeout, $get_locked_file) }; + if ($@) { + $@ = "can't lock file '$filename' - $@"; + return undef; } + $check = 1; } - - if ($err) { - $@ = $err; - return undef; - } - - $@ = undef; - + $res = eval { &$code(@param); }; + return undef if $@; return $res; } @@ -203,7 +220,13 @@ sub file_set_contents { my $tmpname = "$filename.tmp.$$"; eval { - my $fh = IO::File->new($tmpname, O_WRONLY|O_CREAT, $perm); + my ($fh, $tries) = (undef, 0); + while (!$fh && $tries++ < 3) { + $fh = IO::File->new($tmpname, O_WRONLY|O_CREAT|O_EXCL, $perm); + if (!$fh && $! == EEXIST) { + unlink($tmpname) or die "unable to delete old temp file: $!\n"; + } + } die "unable to open file '$tmpname' - $!\n" if !$fh; die "unable to write '$tmpname' - $!\n" unless print $fh $data; die "closing file '$tmpname' failed - $!\n" unless close $fh; @@ -218,7 +241,7 @@ sub file_set_contents { if (!rename($tmpname, $filename)) { my $msg = "close (rename) atomic file '$filename' failed: $!\n"; unlink $tmpname; - die $msg; + die $msg; } } @@ -228,7 +251,7 @@ sub file_get_contents { my $fh = IO::File->new($filename, "r") || die "can't open '$filename' - $!\n"; - my $content = safe_read_from($fh, $max); + my $content = safe_read_from($fh, $max, 0, $filename); close $fh; @@ -253,22 +276,24 @@ sub file_read_firstline { } sub safe_read_from { - my ($fh, $max, $oneline) = @_; + my ($fh, $max, $oneline, $filename) = @_; $max = 32768 if !$max; + my $subject = defined($filename) ? "file '$filename'" : 'input'; + my $br = 0; my $input = ''; my $count; while ($count = sysread($fh, $input, 8192, $br)) { $br += $count; - die "input too long - aborting\n" if $br > $max; + die "$subject too long - aborting\n" if $br > $max; if ($oneline && $input =~ m/^(.*)\n/) { $input = $1; last; } - } - die "unable to read input - $!\n" if !defined($count); + } + die "unable to read $subject - $!\n" if !defined($count); return $input; } @@ -333,7 +358,7 @@ sub run_command { my $timeout; my $oldtimeout; my $pid; - my $exitcode; + my $exitcode = -1; my $outfunc; my $errfunc; @@ -342,6 +367,7 @@ sub run_command { my $output; my $afterfork; my $noerr; + my $keeplocale; eval { @@ -366,6 +392,8 @@ sub run_command { $afterfork = $param{$p}; } elsif ($p eq 'noerr') { $noerr = $param{$p}; + } elsif ($p eq 'keeplocale') { + $keeplocale = $param{$p}; } else { die "got unknown parameter '$p' for run_command\n"; } @@ -381,7 +409,7 @@ sub run_command { print STDERR "$laststderr\n" if $laststderr; } } - $laststderr = shift; + $laststderr = shift; }; } @@ -389,13 +417,10 @@ sub run_command { my $writer = $input && $input =~ m/^<&/ ? $input : IO::File->new(); my $error = IO::File->new(); - # try to avoid locale related issues/warnings - my $lang = $param{lang} || 'C'; - my $orig_pid = $$; eval { - local $ENV{LC_ALL} = $lang; + local $ENV{LC_ALL} = 'C' if !$keeplocale; # suppress LVM warnings like: "File descriptor 3 left open"; local $ENV{LVM_SUPPRESS_FD_WARNINGS} = "1"; @@ -417,8 +442,8 @@ sub run_command { # catch exec errors if ($orig_pid != $$) { warn "ERROR: $err"; - POSIX::_exit (1); - kill ('KILL', $$); + POSIX::_exit (1); + kill ('KILL', $$); } die $err if $err; @@ -506,7 +531,7 @@ sub run_command { &$logfunc($errlog) if $logfunc && $errlog; waitpid ($pid, 0); - + if ($? == -1) { die "failed to execute\n"; } elsif (my $sig = ($? & 127)) { @@ -559,7 +584,7 @@ sub split_list { my $listtxt = shift || ''; return split (/\0/, $listtxt) if $listtxt =~ m/\0/; - + $listtxt =~ s/[,;]/ /g; $listtxt =~ s/^\s+//; @@ -575,7 +600,7 @@ sub trim { $txt =~ s/^\s+//; $txt =~ s/\s+$//; - + return $txt; } @@ -584,7 +609,7 @@ sub template_replace { my ($tmpl, $data) = @_; return $tmpl if !$tmpl; - + my $res = ''; while ($tmpl =~ m/([^{]+)?({([^}]+)})?/g) { $res .= $1 if $1; @@ -651,7 +676,7 @@ sub debmirrors { my $keymaphash = { 'dk' => ['Danish', 'da', 'qwerty/dk-latin1.kmap.gz', 'dk', 'nodeadkeys'], 'de' => ['German', 'de', 'qwertz/de-latin1-nodeadkeys.kmap.gz', 'de', 'nodeadkeys' ], - 'de-ch' => ['Swiss-German', 'de-ch', 'qwertz/sg-latin1.kmap.gz', 'ch', 'de_nodeadkeys' ], + 'de-ch' => ['Swiss-German', 'de-ch', 'qwertz/sg-latin1.kmap.gz', 'ch', 'de_nodeadkeys' ], 'en-gb' => ['United Kingdom', 'en-gb', 'qwerty/uk.kmap.gz' , 'gb', undef], 'en-us' => ['U.S. English', 'en-us', 'qwerty/us-latin1.kmap.gz', 'us', undef ], 'es' => ['Spanish', 'es', 'qwerty/es.kmap.gz', 'es', 'nodeadkeys'], @@ -672,7 +697,7 @@ my $keymaphash = { 'mk' => ['Macedonian', 'mk', 'qwerty/mk.kmap.gz', 'mk', 'nodeadkeys'], 'nl' => ['Dutch', 'nl', 'qwerty/nl.kmap.gz', 'nl', undef], #'nl-be' => ['Belgium-Dutch', 'nl-be', ?, ?, ?], - 'no' => ['Norwegian', 'no', 'qwerty/no-latin1.kmap.gz', 'no', 'nodeadkeys'], + 'no' => ['Norwegian', 'no', 'qwerty/no-latin1.kmap.gz', 'no', 'nodeadkeys'], 'pl' => ['Polish', 'pl', 'qwerty/pl.kmap.gz', 'pl', undef], 'pt' => ['Portuguese', 'pt', 'qwerty/pt-latin1.kmap.gz', 'pt', 'nodeadkeys'], 'pt-br' => ['Brazil-Portuguese', 'pt-br', 'qwerty/br-latin1.kmap.gz', 'br', 'nodeadkeys'], @@ -734,7 +759,7 @@ sub wait_for_vnc_port { } sub next_unused_port { - my ($range_start, $range_end, $family) = @_; + my ($range_start, $range_end, $family, $address) = @_; # We use a file to register allocated ports. # Those registrations expires after $expiretime. @@ -756,22 +781,24 @@ sub next_unused_port { my ($port, $timestamp) = ($1, $2); if (($timestamp + $expiretime) > $ctime) { $ports->{$port} = $timestamp; # not expired - } + } } } } - + my $newport; + my %sockargs = (Listen => 5, + ReuseAddr => 1, + Family => $family, + Proto => IPPROTO_TCP, + GetAddrInfoFlags => 0); + $sockargs{LocalAddr} = $address if defined($address); for (my $p = $range_start; $p < $range_end; $p++) { next if $ports->{$p}; # reserved - my $sock = IO::Socket::IP->new(Listen => 5, - LocalPort => $p, - ReuseAddr => 1, - Family => $family, - Proto => 0, - GetAddrInfoFlags => 0); + $sockargs{LocalPort} = $p; + my $sock = IO::Socket::IP->new(%sockargs); if ($sock) { close($sock); @@ -780,41 +807,41 @@ sub next_unused_port { last; } } - + my $data = ""; foreach my $p (keys %$ports) { $data .= "$p $ports->{$p}\n"; } - + file_set_contents($filename, $data); return $newport; }; - my $p = lock_file($filename, 10, $code); + my $p = lock_file('/var/lock/pve-ports.lck', 10, $code); die $@ if $@; - + die "unable to find free port (${range_start}-${range_end})\n" if !$p; return $p; } sub next_migrate_port { - my ($family) = @_; - return next_unused_port(60000, 60050, $family); + my ($family, $address) = @_; + return next_unused_port(60000, 60050, $family, $address); } sub next_vnc_port { - my ($family) = @_; - return next_unused_port(5900, 6000, $family); + my ($family, $address) = @_; + return next_unused_port(5900, 6000, $family, $address); } sub next_spice_port { - my ($family) = @_; - return next_unused_port(61000, 61099, $family); + my ($family, $address) = @_; + return next_unused_port(61000, 61099, $family, $address); } -# NOTE: NFS syscall can't be interrupted, so alarm does +# NOTE: NFS syscall can't be interrupted, so alarm does # not work to provide timeouts. # from 'man nfs': "Only SIGKILL can interrupt a pending NFS operation" # So fork() before using Filesys::Df @@ -867,7 +894,7 @@ sub df { # UPID helper # We use this to uniquely identify a process. -# An 'Unique Process ID' has the following format: +# An 'Unique Process ID' has the following format: # "UPID:$node:$pid:$pstart:$startime:$dtype:$id:$user" sub upid_encode { @@ -875,8 +902,8 @@ sub upid_encode { # Note: pstart can be > 32bit if uptime > 497 days, so this can result in # more that 8 characters for pstart - return sprintf("UPID:%s:%08X:%08X:%08X:%s:%s:%s:", $d->{node}, $d->{pid}, - $d->{pstart}, $d->{starttime}, $d->{type}, $d->{id}, + return sprintf("UPID:%s:%08X:%08X:%08X:%s:%s:%s:", $d->{node}, $d->{pid}, + $d->{pstart}, $d->{starttime}, $d->{type}, $d->{id}, $d->{user}); } @@ -911,7 +938,7 @@ sub upid_decode { sub upid_open { my ($upid) = @_; - my ($task, $filename) = upid_decode($upid); + my ($task, $filename) = upid_decode($upid); my $dirname = dirname($filename); make_path($dirname); @@ -920,7 +947,7 @@ sub upid_open { die "getpwnam failed"; my $perm = 0640; - + my $outfh = IO::File->new ($filename, O_WRONLY|O_CREAT|O_EXCL, $perm) || die "unable to create output file '$filename' - $!\n"; chown $wwwid, -1, $outfh; @@ -954,7 +981,7 @@ sub upid_read_status { return "unable to read tail (got $br bytes)"; } -# useful functions to store comments in config files +# useful functions to store comments in config files sub encode_text { my ($text) = @_; @@ -969,6 +996,8 @@ sub decode_text { return Encode::decode("utf8", uri_unescape($data)); } +# depreciated - do not use! +# we now decode all parameters by default sub decode_utf8_parameters { my ($param) = @_; @@ -1029,7 +1058,7 @@ sub dump_logfile { my $count = 0; my $fh = IO::File->new($filename, "r"); - if (!$fh) { + if (!$fh) { $count++; push @$lines, { n => $count, t => "unable to open file - $!"}; return ($count, $lines); @@ -1073,11 +1102,11 @@ sub dump_logfile { } sub dump_journal { - my ($start, $limit, $since, $until) = @_; + my ($start, $limit, $since, $until, $service) = @_; my $lines = []; my $count = 0; - + $start = 0 if !$start; $limit = 50 if !$limit; @@ -1092,6 +1121,7 @@ sub dump_journal { my $cmd = ['journalctl', '-o', 'short', '--no-pager']; + push @$cmd, '--unit', $service if $service; push @$cmd, '--since', $since if $since; push @$cmd, '--until', $until if $until; run_command($cmd, outfunc => $parser); @@ -1111,8 +1141,8 @@ sub dir_glob_regex { my $dh = IO::Dir->new ($dir); return wantarray ? () : undef if !$dh; - - while (defined(my $tmp = $dh->read)) { + + while (defined(my $tmp = $dh->read)) { if (my @res = $tmp =~ m/^($regex)$/) { $dh->close; return wantarray ? @res : $tmp; @@ -1133,7 +1163,7 @@ sub dir_glob_foreach { &$func (@res); } } - } + } } sub assert_if_modified { @@ -1189,6 +1219,24 @@ sub get_host_address_family { return $res[0]->{family}; } +# get the fully qualified domain name of a host +# same logic as hostname(1): The FQDN is the name getaddrinfo(3) returns, +# given a nodename as a parameter +sub get_fqdn { + my ($nodename) = @_; + + my $hints = { + flags => AI_CANONNAME, + socktype => SOCK_DGRAM + }; + + my ($err, @addrs) = Socket::getaddrinfo($nodename, undef, $hints); + + die "getaddrinfo: $err" if $err; + + return $addrs[0]->{canonname}; +} + # Parses any sane kind of host, or host+port pair: # The port is always optional and thus may be undef. sub parse_host_and_port { @@ -1204,17 +1252,17 @@ sub parse_host_and_port { sub unshare($) { my ($flags) = @_; - return 0 == syscall(272, $flags); + return 0 == syscall(PVE::Syscall::unshare, $flags); } sub setns($$) { my ($fileno, $nstype) = @_; - return 0 == syscall(308, $fileno, $nstype); + return 0 == syscall(PVE::Syscall::setns, $fileno, $nstype); } sub syncfs($) { my ($fileno) = @_; - return 0 == syscall(306, $fileno); + return 0 == syscall(PVE::Syscall::syncfs, $fileno); } sub sync_mountpoint { @@ -1298,12 +1346,18 @@ sub tempfile { # default permissions are stricter than with file_set_contents $perm = 0600 if !defined($perm); - my $dir = $opts{dir} // '/tmp'; + my $dir = $opts{dir} // '/run'; my $mode = $opts{mode} // O_RDWR; $mode |= O_EXCL if !$opts{allow_links}; - my $fh = IO::File->new($dir, $mode | O_TMPFILE, $perm) - or die "failed to create tempfile: $!\n"; + my $fh = IO::File->new($dir, $mode | O_TMPFILE, $perm); + if (!$fh && $! == EOPNOTSUPP) { + $dir = '/tmp' if !defined($opts{dir}); + $dir .= "/.tmpfile.$$"; + $fh = IO::File->new($dir, $mode | O_CREAT | O_EXCL, $perm); + unlink($dir) if $fh; + } + die "failed to create tempfile: $!\n" if !$fh; return $fh; } @@ -1340,7 +1394,7 @@ sub validate_ssh_public_keys { sub openat($$$;$) { my ($dirfd, $pathname, $flags, $mode) = @_; - my $fd = syscall(257, $dirfd, $pathname, $flags, $mode//0); + my $fd = syscall(PVE::Syscall::openat, $dirfd, $pathname, $flags, $mode//0); return undef if $fd < 0; # sysopen() doesn't deal with numeric file descriptors apparently # so we need to convert to a mode string for IO::Handle->new_from_fd @@ -1348,14 +1402,14 @@ sub openat($$$;$) { my $handle = IO::Handle->new_from_fd($fd, $flagstr); return $handle if $handle; my $err = $!; # save error before closing the raw fd - syscall(3, $fd); # close + syscall(PVE::Syscall::close, $fd); # close $! = $err; return undef; } sub mkdirat($$$) { my ($dirfd, $name, $mode) = @_; - return syscall(258, $dirfd, $name, $mode) == 0; + return syscall(PVE::Syscall::mkdirat, $dirfd, $name, $mode) == 0; } # NOTE: This calls the dbus main loop and must not be used when another dbus @@ -1429,4 +1483,18 @@ sub enter_systemd_scope { die "systemd job never completed\n" if !$done; } +my $salt_starter = time(); + +sub encrypt_pw { + my ($pw) = @_; + + $salt_starter++; + my $salt = substr(Digest::SHA::sha1_base64(time() + $salt_starter + $$), 0, 8); + + # crypt does not want '+' in salt (see 'man crypt') + $salt =~ s/\+/X/g; + + return crypt(encode("utf8", $pw), "\$5\$$salt\$"); +} + 1;