X-Git-Url: https://git.proxmox.com/?p=pve-common.git;a=blobdiff_plain;f=src%2FPVE%2FTools.pm;h=039c9fb8dae5e2d10cb492b9f41ecf4f08397a91;hp=64a57e9596dcbdcc15dff98d38161be38cbdf91e;hb=a712bf6e378dc0ab56647bfe7649072eb4ee394f;hpb=b148e99f3ffce61317f1b8100f3e6709a34860c0 diff --git a/src/PVE/Tools.pm b/src/PVE/Tools.pm index 64a57e9..039c9fb 100644 --- a/src/PVE/Tools.pm +++ b/src/PVE/Tools.pm @@ -12,6 +12,7 @@ use Filesys::Df (); # don't overwrite our df() use IO::Pipe; use IO::File; use IO::Dir; +use IO::Handle; use IPC::Open3; use Fcntl qw(:DEFAULT :flock); use base 'Exporter'; @@ -21,6 +22,9 @@ use Digest::SHA; 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; # avoid warning when parsing long hex values with hex() no warnings 'portable'; # Support for 64-bit ints required @@ -42,6 +46,8 @@ safe_print trim extract_param file_copy +O_PATH +O_TMPFILE ); my $pvelogdir = "/var/log/pve"; @@ -75,6 +81,9 @@ use constant {CLONE_NEWNS => 0x00020000, CLONE_NEWPID => 0x20000000, CLONE_NEWNET => 0x40000000}; +use constant {O_PATH => 0x00200000, + O_TMPFILE => 0x00410000}; # This includes O_DIRECTORY + sub run_with_timeout { my ($timeout, $code, @param) = @_; @@ -126,15 +135,16 @@ sub lock_file_full { my $lock_func = sub { if (!$lock_handles->{$$}->{$filename}) { - $lock_handles->{$$}->{$filename} = new IO::File (">>$filename") || - die "can't open file - $!\n"; + my $fh = new IO::File(">>$filename") || + die "can't open file - $!\n"; + $lock_handles->{$$}->{$filename} = { fh => $fh, refcount => 0}; } - if (!flock ($lock_handles->{$$}->{$filename}, $mode|LOCK_NB)) { + if (!flock($lock_handles->{$$}->{$filename}->{fh}, $mode|LOCK_NB)) { print STDERR "trying to acquire lock..."; my $success; while(1) { - $success = flock($lock_handles->{$$}->{$filename}, $mode); + $success = flock($lock_handles->{$$}->{$filename}->{fh}, $mode); # try again on EINTR (see bug #273) if ($success || ($! != EINTR)) { last; @@ -146,6 +156,7 @@ sub lock_file_full { } print STDERR " OK\n"; } + $lock_handles->{$$}->{$filename}->{refcount}++; }; my $res; @@ -159,9 +170,12 @@ sub lock_file_full { $err = $@; } - if (my $fh = $lock_handles->{$$}->{$filename}) { - $lock_handles->{$$}->{$filename} = undef; - close ($fh); + if (my $fh = $lock_handles->{$$}->{$filename}->{fh}) { + my $refcount = --$lock_handles->{$$}->{$filename}->{refcount}; + if ($refcount <= 0) { + $lock_handles->{$$}->{$filename} = undef; + close ($fh); + } } if ($err) { @@ -300,7 +314,7 @@ sub run_command { $cmdstr .= $pipe . join(' ', map { ref($_) ? $$_ : shellquote($_) } @$command); $pipe = ' | '; } - $cmd = [ '/bin/bash', '-c', "set -o pipefail && $cmdstr" ]; + $cmd = [ '/bin/bash', '-c', "$cmdstr" ]; } else { $cmdstr = cmd2string($cmd); } @@ -670,7 +684,7 @@ my $keymaphash = { }; my $kvmkeymaparray = []; -foreach my $lc (keys %$keymaphash) { +foreach my $lc (sort keys %$keymaphash) { push @$kvmkeymaparray, $keymaphash->{$lc}->[1]; } @@ -1054,7 +1068,7 @@ sub dump_logfile { } sub dump_journal { - my ($start, $limit, $filter) = @_; + my ($start, $limit, $since, $until) = @_; my $lines = []; my $count = 0; @@ -1072,6 +1086,9 @@ sub dump_journal { }; my $cmd = ['journalctl', '-o', 'short', '--no-pager']; + + push @$cmd, '--since', $since if $since; + push @$cmd, '--until', $until if $until; run_command($cmd, outfunc => $parser); # HACK: ExtJS store.guaranteeRange() does not like empty array @@ -1185,4 +1202,226 @@ sub unshare($) { return 0 == syscall(272, $flags); } +sub setns($$) { + my ($fileno, $nstype) = @_; + return 0 == syscall(308, $fileno, $nstype); +} + +sub syncfs($) { + my ($fileno) = @_; + return 0 == syscall(306, $fileno); +} + +sub sync_mountpoint { + my ($path) = @_; + sysopen my $fd, $path, O_PATH or die "failed to open $path: $!\n"; + my $result = syncfs(fileno($fd)); + close($fd); + return $result; +} + +# support sending multi-part mail messages with a text and or a HTML part +# mailto may be a single email string or an array of receivers +sub sendmail { + my ($mailto, $subject, $text, $html, $mailfrom, $author) = @_; + my $mail_re = qr/[^-a-zA-Z0-9+._@]/; + + $mailto = [ $mailto ] if !ref($mailto); + + foreach (@$mailto) { + die "illegal character in mailto address\n" + if ($_ =~ $mail_re); + } + + my $rcvrtxt = join (', ', @$mailto); + + $mailfrom = $mailfrom || "root"; + die "illegal character in mailfrom address\n" + if $mailfrom =~ $mail_re; + + $author = $author || 'Proxmox VE'; + + open (MAIL, "|-", "sendmail", "-B", "8BITMIME", "-f", $mailfrom, @$mailto) || + die "unable to open 'sendmail' - $!"; + + # multipart spec see https://www.ietf.org/rfc/rfc1521.txt + my $boundary = "----_=_NextPart_001_".int(time).$$; + + print MAIL "Content-Type: multipart/alternative;\n"; + print MAIL "\tboundary=\"$boundary\"\n"; + print MAIL "MIME-Version: 1.0\n"; + + print MAIL "FROM: $author <$mailfrom>\n"; + print MAIL "TO: $rcvrtxt\n"; + print MAIL "SUBJECT: $subject\n"; + print MAIL "\n"; + print MAIL "This is a multi-part message in MIME format.\n\n"; + print MAIL "--$boundary\n"; + + if (defined($text)) { + print MAIL "Content-Type: text/plain;\n"; + print MAIL "\tcharset=\"UTF8\"\n"; + print MAIL "Content-Transfer-Encoding: 8bit\n"; + print MAIL "\n"; + + # avoid 'remove extra line breaks' issue (MS Outlook) + my $fill = ' '; + $text =~ s/^/$fill/gm; + + print MAIL $text; + + print MAIL "\n--$boundary\n"; + } + + if (defined($html)) { + print MAIL "Content-Type: text/html;\n"; + print MAIL "\tcharset=\"UTF8\"\n"; + print MAIL "Content-Transfer-Encoding: 8bit\n"; + print MAIL "\n"; + + print MAIL $html; + + print MAIL "\n--$boundary--\n"; + } + + close(MAIL); +} + +sub tempfile { + my ($perm, %opts) = @_; + + # default permissions are stricter than with file_set_contents + $perm = 0600 if !defined($perm); + + my $dir = $opts{dir} // '/tmp'; + 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"; + return $fh; +} + +sub tempfile_contents { + my ($data, $perm, %opts) = @_; + + my $fh = tempfile($perm, %opts); + eval { + die "unable to write to tempfile: $!\n" if !print {$fh} $data; + die "unable to flush to tempfile: $!\n" if !defined($fh->flush()); + }; + if (my $err = $@) { + close $fh; + die $err; + } + + return ("/proc/$$/fd/".$fh->fileno, $fh); +} + +sub validate_ssh_public_keys { + my ($raw) = @_; + my @lines = split(/\n/, $raw); + + foreach my $line (@lines) { + next if $line =~ m/^\s*$/; + eval { + my ($filename, $handle) = tempfile_contents($line); + run_command(["ssh-keygen", "-l", "-f", $filename], + outfunc => sub {}, errfunc => sub {}); + }; + die "SSH public key validation error\n" if $@; + } +} + +sub openat($$$;$) { + my ($dirfd, $pathname, $flags, $mode) = @_; + my $fd = syscall(257, $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 + my $flagstr = ($flags & O_RDWR) ? 'rw' : ($flags & O_WRONLY) ? 'w' : 'r'; + 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 + $! = $err; + return undef; +} + +sub mkdirat($$$) { + my ($dirfd, $name, $mode) = @_; + return syscall(258, $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; +} + 1;