X-Git-Url: https://git.proxmox.com/?p=pve-common.git;a=blobdiff_plain;f=src%2FPVE%2FTools.pm;h=accf6539da94d2b5d5b6f4539310fe5c4d526c7e;hp=9818f636a03dadeaee6329370f2349c6173ff767;hb=0a3de87e0f68078652ca3293c1bd1cc377c27f9d;hpb=2d38b8a1b941a93a3db3c8ce29a46b8de819202b diff --git a/src/PVE/Tools.pm b/src/PVE/Tools.pm index 9818f63..accf653 100644 --- a/src/PVE/Tools.pm +++ b/src/PVE/Tools.pm @@ -20,12 +20,10 @@ use base 'Exporter'; use URI::Escape; use Encode; use Digest::SHA; +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; @@ -149,7 +147,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); @@ -368,6 +366,7 @@ sub run_command { my $afterfork; my $noerr; my $keeplocale; + my $quiet; eval { @@ -394,6 +393,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"; } @@ -496,7 +497,7 @@ sub run_command { waitpid ($pid, 0); die $err; } - } else { + } elsif (!$quiet) { print $buf; *STDOUT->flush(); } @@ -516,7 +517,7 @@ sub run_command { waitpid ($pid, 0); die $err; } - } else { + } elsif (!$quiet) { print STDERR $buf; *STDERR->flush(); } @@ -639,7 +640,7 @@ sub pipe_socket_to_command { } sub split_list { - my $listtxt = shift || ''; + my $listtxt = shift // ''; return split (/\0/, $listtxt) if $listtxt =~ m/\0/; @@ -669,7 +670,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; } @@ -759,7 +760,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' => [], @@ -790,17 +791,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); @@ -811,7 +815,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 { @@ -897,6 +901,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 { @@ -905,16 +916,12 @@ sub run_fork_with_timeout { my $res; my $error; my $pipe_out = IO::Pipe->new(); - my $pipe_err = IO::Pipe->new(); # disable pending alarms, save their remaining time my $prev_alarm = alarm 0; - # trap before forking to avoid leaving a zombie if the parent get killed + # avoid leaving a zombie if the parent gets interrupted my $sig_received; - local $SIG{INT} = $SIG{TERM} = $SIG{QUIT} = $SIG{HUP} = $SIG{PIPE} = sub { - $sig_received++; - }; my $child = fork(); if (!defined($child)) { @@ -924,35 +931,43 @@ sub run_fork_with_timeout { if (!$child) { $pipe_out->writer(); - $pipe_err->writer(); eval { $res = $sub->(); - print {$pipe_out} "$res"; + print {$pipe_out} encode_json({ result => $res }); $pipe_out->flush(); }; if (my $err = $@) { - print {$pipe_err} "$err"; - $pipe_err->flush(); + 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(); - $pipe_err->reader(); my $readvalues = sub { local $/ = undef; - $res = <$pipe_out>; - $error = <$pipe_err>; + my $child_res = decode_json(readline_nointr($pipe_out)); + $res = $child_res->{result}; + $error = $child_res->{error}; }; eval { - run_with_timeout($timeout, $readvalues); + if (defined($timeout)) { + run_with_timeout($timeout, $readvalues); + } else { + $readvalues->(); + } }; warn $@ if $@; $pipe_out->close(); - $pipe_err->close(); kill('KILL', $child); waitpid($child, 0); @@ -963,6 +978,11 @@ sub run_fork_with_timeout { return $res; } +sub run_fork { + my ($code) = @_; + return run_fork_with_timeout(undef, $code); +} + # 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" @@ -970,48 +990,40 @@ sub run_fork_with_timeout { 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"; - $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> =~ /^(\d*)$/)[0]); - $res->{used} = int((<$pipe> =~ /^(\d*)$/)[0]); - $res->{avail} = int((<$pipe> =~ /^(\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 @@ -1534,77 +1546,6 @@ 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; -} - my $salt_starter = time(); sub encrypt_pw { @@ -1619,4 +1560,71 @@ sub encrypt_pw { return crypt(encode("utf8", $pw), "\$5\$$salt\$"); } +# intended usage: convert_size($val, "kb" => "gb") +# 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) = @_; + + my $units = { + b => 0, + kb => 1, + mb => 2, + gb => 3, + tb => 4, + pb => 5, + }; + + 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}); + + 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; +} + +sub get_host_arch { + + 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"; + } +} + 1;