X-Git-Url: https://git.proxmox.com/?p=pve-common.git;a=blobdiff_plain;f=src%2FPVE%2FTools.pm;h=550da09a609ddcf39f7999cc384bb312515192ed;hp=2525e55ceb95ed1b9fccf41b9e8defa03db81dd9;hb=6cf6b40469e5cbd63c04f075ce1399f3a1ad3574;hpb=a2d049afde002df646af4eed4b2c5ec22a251400 diff --git a/src/PVE/Tools.pm b/src/PVE/Tools.pm index 2525e55..550da09 100644 --- a/src/PVE/Tools.pm +++ b/src/PVE/Tools.pm @@ -24,9 +24,6 @@ use JSON; use Text::ParseWords; use String::ShellQuote; 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; @@ -88,6 +85,8 @@ use constant {CLONE_NEWNS => 0x00020000, use constant {O_PATH => 0x00200000, O_TMPFILE => 0x00410000}; # This includes O_DIRECTORY +use constant {AT_EMPTY_PATH => 0x1000}; + sub run_with_timeout { my ($timeout, $code, @param) = @_; @@ -150,7 +149,7 @@ sub lock_file_full { or die "can't open file - $!\n"; if (!flock($fh, $mode|LOCK_NB)) { - print STDERR "trying to acquire lock..."; + print STDERR "trying to acquire lock...\n"; my $success; while(1) { $success = flock($fh, $mode); @@ -369,6 +368,7 @@ sub run_command { my $afterfork; my $noerr; my $keeplocale; + my $quiet; eval { @@ -395,6 +395,8 @@ sub run_command { $noerr = $param{$p}; } elsif ($p eq 'keeplocale') { $keeplocale = $param{$p}; + } elsif ($p eq 'quiet') { + $quiet = $param{$p}; } else { die "got unknown parameter '$p' for run_command\n"; } @@ -497,7 +499,7 @@ sub run_command { waitpid ($pid, 0); die $err; } - } else { + } elsif (!$quiet) { print $buf; *STDOUT->flush(); } @@ -517,7 +519,7 @@ sub run_command { waitpid ($pid, 0); die $err; } - } else { + } elsif (!$quiet) { print STDERR $buf; *STDERR->flush(); } @@ -640,7 +642,7 @@ sub pipe_socket_to_command { } sub split_list { - my $listtxt = shift || ''; + my $listtxt = shift // ''; return split (/\0/, $listtxt) if $listtxt =~ m/\0/; @@ -670,7 +672,7 @@ sub template_replace { return $tmpl if !$tmpl; my $res = ''; - while ($tmpl =~ m/([^{]+)?({([^}]+)})?/g) { + while ($tmpl =~ m/([^{]+)?(\{([^}]+)\})?/g) { $res .= $1 if $1; $res .= ($data->{$3} || '-') if $2; } @@ -760,7 +762,7 @@ my $keymaphash = { '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'], - #'ru' => ['Russian', 'ru', 'qwerty/ru.kmap.gz', 'ru', undef], # dont know? + #'ru' => ['Russian', 'ru', 'qwerty/ru.kmap.gz', 'ru', undef], # don't know? 'si' => ['Slovenian', 'sl', 'qwertz/slovene.kmap.gz', 'si', undef], 'se' => ['Swedish', 'sv', 'qwerty/se-latin1.kmap.gz', 'se', 'nodeadkeys'], #'th' => [], @@ -791,17 +793,20 @@ sub extract_param { # Note: we use this to wait until vncterm/spiceterm is ready sub wait_for_vnc_port { - my ($port, $timeout) = @_; + my ($port, $family, $timeout) = @_; $timeout = 5 if !$timeout; my $sleeptime = 0; my $starttime = [gettimeofday]; my $elapsed; + my $cmd = ['/bin/ss', '-Htln', "sport = :$port"]; + push @$cmd, $family == AF_INET6 ? '-6' : '-4' if defined($family); + my $found; while (($elapsed = tv_interval($starttime)) < $timeout) { # -Htln = don't print header, tcp, listening sockets only, numeric ports - run_command(['/bin/ss', '-Htln', "sport = :$port"], outfunc => sub { + run_command($cmd, outfunc => sub { my $line = shift; if ($line =~ m/^LISTEN\s+\d+\s+\d+\s+\S+:(\d+)\s/) { $found = 1 if ($port == $1); @@ -812,7 +817,7 @@ sub wait_for_vnc_port { usleep($sleeptime); } - return undef; + die "Timeout while waiting for port '$port' to get ready!\n"; } sub next_unused_port { @@ -898,6 +903,13 @@ sub next_spice_port { return next_unused_port(61000, 61099, $family, $address); } +sub must_stringify { + my ($value) = @_; + eval { $value = "$value" }; + return "error turning value into a string: $@" if $@; + return $value; +} + # sigkill after $timeout a $sub running in a fork if it can't write a pipe # the $sub has to return a single scalar sub run_fork_with_timeout { @@ -912,7 +924,6 @@ sub run_fork_with_timeout { # avoid leaving a zombie if the parent gets interrupted my $sig_received; - local $SIG{INT} = sub { $sig_received++; }; my $child = fork(); if (!defined($child)) { @@ -929,18 +940,24 @@ sub run_fork_with_timeout { $pipe_out->flush(); }; if (my $err = $@) { - print {$pipe_out} encode_json({ error => $err }); + print {$pipe_out} encode_json({ error => must_stringify($err) }); $pipe_out->flush(); POSIX::_exit(1); } POSIX::_exit(0); } + local $SIG{INT} = sub { $sig_received++; }; + local $SIG{TERM} = sub { + $error //= "interrupted by unexpected signal\n"; + kill('TERM', $child); + }; + $pipe_out->reader(); my $readvalues = sub { local $/ = undef; - my $child_res = decode_json(scalar<$pipe_out>); + my $child_res = decode_json(readline_nointr($pipe_out)); $res = $child_res->{result}; $error = $child_res->{error}; }; @@ -975,49 +992,40 @@ sub run_fork { sub df { my ($path, $timeout) = @_; - my $res = { - total => 0, - used => 0, - avail => 0, + my $df = sub { return Filesys::Df::df($path, 1) }; + + my $res = eval { run_fork_with_timeout($timeout, $df) } // {}; + warn $@ if $@; + + # untaint the values + my ($blocks, $used, $bavail) = map { defined($_) ? (/^(\d+)$/) : 0 } + $res->@{qw(blocks used bavail)}; + + return { + total => $blocks, + used => $used, + avail => $bavail, }; +} - my $pipe = IO::Pipe->new(); - my $child = fork(); - if (!defined($child)) { - warn "fork failed: $!\n"; - return $res; - } +sub du { + my ($path, $timeout) = @_; - if (!$child) { - $pipe->writer(); - eval { - my $df = Filesys::Df::df($path, 1); - print {$pipe} "$df->{blocks}\n$df->{used}\n$df->{bavail}\n" - if defined($df); - $pipe->close(); - }; - if (my $err = $@) { - warn $err; - POSIX::_exit(1); - } - POSIX::_exit(0); - } + my $size; - $pipe->reader(); + $timeout //= 10; - my $readvalues = sub { - $res->{total} = int(((<$pipe> // 0) =~ /^(\d*)$/)[0]); - $res->{used} = int(((<$pipe> // 0) =~ /^(\d*)$/)[0]); - $res->{avail} = int(((<$pipe> // 0) =~ /^(\d*)$/)[0]); - }; - eval { - run_with_timeout($timeout, $readvalues); + my $parser = sub { + my $line = shift; + + if ($line =~ m/^(\d+)\s+total$/) { + $size = $1; + } }; - warn $@ if $@; - $pipe->close(); - kill('KILL', $child); - waitpid($child, 0); - return $res; + + run_command(['du', '-scb', $path], outfunc => $parser, timeout => $timeout); + + return $size; } # UPID helper @@ -1378,6 +1386,11 @@ sub parse_host_and_port { return; # nothing } +sub setresuid($$$) { + my ($ruid, $euid, $suid) = @_; + return 0 == syscall(PVE::Syscall::setresuid, $ruid, $euid, $suid); +} + sub unshare($) { my ($flags) = @_; return 0 == syscall(PVE::Syscall::unshare, $flags); @@ -1393,6 +1406,11 @@ sub syncfs($) { return 0 == syscall(PVE::Syscall::syncfs, $fileno); } +sub fsync($) { + my ($fileno) = @_; + return 0 == syscall(PVE::Syscall::fsync, $fileno); +} + sub sync_mountpoint { my ($path) = @_; sysopen my $fd, $path, O_PATH or die "failed to open $path: $!\n"; @@ -1540,75 +1558,9 @@ sub mkdirat($$$) { return syscall(PVE::Syscall::mkdirat, $dirfd, $name, $mode) == 0; } -# NOTE: This calls the dbus main loop and must not be used when another dbus -# main loop is being used as we need to wait for the JobRemoved signal. -# Polling the job status instead doesn't work because this doesn't give us the -# distinction between success and failure. -# -# Note that the description is mandatory for security reasons. -sub enter_systemd_scope { - my ($unit, $description, %extra) = @_; - die "missing description\n" if !defined($description); - - my $timeout = delete $extra{timeout}; - - $unit .= '.scope'; - my $properties = [ [PIDs => [dbus_uint32($$)]] ]; - - foreach my $key (keys %extra) { - if ($key eq 'Slice' || $key eq 'KillMode') { - push @$properties, [$key, $extra{$key}]; - } elsif ($key eq 'CPUShares') { - push @$properties, [$key, dbus_uint64($extra{$key})]; - } elsif ($key eq 'CPUQuota') { - push @$properties, ['CPUQuotaPerSecUSec', - dbus_uint64($extra{$key} * 10000)]; - } else { - die "Don't know how to encode $key for systemd scope\n"; - } - } - - my $job; - my $done = 0; - - my $bus = Net::DBus->system(); - my $reactor = Net::DBus::Reactor->main(); - - my $service = $bus->get_service('org.freedesktop.systemd1'); - my $if = $service->get_object('/org/freedesktop/systemd1', 'org.freedesktop.systemd1.Manager'); - # Connect to the JobRemoved signal since we want to wait for it to finish - my $sigid; - my $timer; - my $cleanup = sub { - my ($no_shutdown) = @_; - $if->disconnect_from_signal('JobRemoved', $sigid) if defined($if); - $if = undef; - $sigid = undef; - $reactor->remove_timeout($timer) if defined($timer); - $timer = undef; - return if $no_shutdown; - $reactor->shutdown(); - }; - - $sigid = $if->connect_to_signal('JobRemoved', sub { - my ($id, $removed_job, $signaled_unit, $result) = @_; - return if $signaled_unit ne $unit || $removed_job ne $job; - $cleanup->(0); - die "systemd job failed\n" if $result ne 'done'; - $done = 1; - }); - - my $on_timeout = sub { - $cleanup->(0); - die "systemd job timed out\n"; - }; - - $timer = $reactor->add_timeout($timeout * 1000, Net::DBus::Callback->new(method => $on_timeout)) - if defined($timeout); - $job = $if->StartTransientUnit($unit, 'fail', $properties, []); - $reactor->run(); - $cleanup->(1); - die "systemd job never completed\n" if !$done; +sub fchownat($$$$$) { + my ($dirfd, $pathname, $owner, $group, $flags) = @_; + return syscall(PVE::Syscall::fchownat, $dirfd, $pathname, $owner, $group, $flags) == 0; } my $salt_starter = time(); @@ -1626,9 +1578,16 @@ sub encrypt_pw { } # intended usage: convert_size($val, "kb" => "gb") -# on reduction (converting to a bigger unit) we round up by default if -# information got lost. E.g. `convert_size(1023, "b" => "kb")` returns 1 +# we round up to the next integer by default +# E.g. `convert_size(1023, "b" => "kb")` returns 1 # use $no_round_up to switch this off, above example would then return 0 +# this is also true for converting down e.g. 0.0005 gb to mb returns 1 +# (0 if $no_round_up is true) +# allowed formats for value: +# 1234 +# 1234. +# 1234.1234 +# .1234 sub convert_size { my ($value, $from, $to, $no_round_up) = @_; @@ -1641,21 +1600,99 @@ sub convert_size { pb => 5, }; - $from = lc($from); $to = lc($to); + die "no value given" + if !defined($value) || $value eq ""; + + $from = lc($from // ''); $to = lc($to // ''); die "unknown 'from' and/or 'to' units ($from => $to)" - if !(defined($units->{$from}) && defined($units->{$to})); + if !defined($units->{$from}) || !defined($units->{$to}); + + die "value '$value' is not a valid, positive number" + if $value !~ m/^(?:[0-9]+\.?[0-9]*|[0-9]*\.[0-9]+)$/; + + my $shift_amount = ($units->{$from} - $units->{$to}) * 10; + + $value *= 2**$shift_amount; + $value++ if !$no_round_up && ($value - int($value)) > 0.0; + + return int($value); +} + +# uninterruptible readline +# retries on EINTR +sub readline_nointr { + my ($fh) = @_; + my $line; + while (1) { + $line = <$fh>; + last if defined($line) || ($! != EINTR); + } + return $line; +} - my $shift_amount = $units->{$from} - $units->{$to}; +sub get_host_arch { - if ($shift_amount > 0) { - $value <<= ($shift_amount * 10); - } elsif ($shift_amount < 0) { - my $remainder = ($value & (1 << abs($shift_amount)*10) - 1); - $value >>= abs($shift_amount) * 10; - $value++ if $remainder && !$no_round_up; + my @uname = POSIX::uname(); + my $machine = $uname[4]; + + if ($machine eq 'x86_64') { + return 'amd64'; + } elsif ($machine eq 'aarch64') { + return 'arm64'; + } else { + die "unsupported host architecture '$machine'\n"; } +} - return $value; +# Devices are: [ (12 bits minor) (12 bits major) (8 bits minor) ] +sub dev_t_major($) { + my ($dev_t) = @_; + return (int($dev_t) & 0xfff00) >> 8; } +sub dev_t_minor($) { + my ($dev_t) = @_; + $dev_t = int($dev_t); + return (($dev_t >> 12) & 0xfff00) | ($dev_t & 0xff); +} + +# Given an array of array refs [ \[a b c], \[a b b], \[e b a] ] +# Returns the intersection of elements as a single array [a b] +sub array_intersect { + my ($arrays) = @_; + + if (!ref($arrays->[0])) { + $arrays = [ grep { ref($_) eq 'ARRAY' } @_ ]; + } + + return [] if scalar(@$arrays) == 0; + return $arrays->[0] if scalar(@$arrays) == 1; + + my $array_unique = sub { + my %seen = (); + return grep { ! $seen{ $_ }++ } @_; + }; + + # base idea is to get all unique members from the first array, then + # check the common elements with the next (uniquely made) one, only keep + # those. Repeat for every array and at the end we only have those left + # which exist in all arrays + my $return_arr = [ $array_unique->(@{$arrays->[0]}) ]; + for my $i (1 .. $#$arrays) { + my %count = (); + # $return_arr is already unique, explicit at before the loop, implicit below. + foreach my $element (@$return_arr, $array_unique->(@{$arrays->[$i]})) { + $count{$element}++; + } + $return_arr = []; + foreach my $element (keys %count) { + push @$return_arr, $element if $count{$element} > 1; + } + last if scalar(@$return_arr) == 0; # empty intersection, early exit + } + + return $return_arr; +} + + 1;