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);
+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';
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;
# avoid warning when parsing long hex values with hex()
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
safe_print
trim
extract_param
+file_copy
+O_PATH
+O_TMPFILE
);
my $pvelogdir = "/var/log/pve";
mkdir $pvelogdir;
mkdir $pvetaskdir;
-my $IPV4OCTET = "(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])";
+my $IPV4OCTET = "(?:25[0-5]|(?:2[0-4]|1[0-9]|[1-9])?[0-9])";
our $IPV4RE = "(?:(?:$IPV4OCTET\\.){3}$IPV4OCTET)";
my $IPV6H16 = "(?:[0-9a-fA-F]{1,4})";
my $IPV6LS32 = "(?:(?:$IPV4RE|$IPV6H16:$IPV6H16))";
"(?:(?:(?:(?:$IPV6H16:){0,5}$IPV6H16)?::" . ")$IPV6H16)|" .
"(?:(?:(?:(?:$IPV6H16:){0,6}$IPV6H16)?::" . ")))";
+our $IPRE = "(?:$IPV4RE|$IPV6RE)";
+
+use constant {CLONE_NEWNS => 0x00020000,
+ CLONE_NEWUTS => 0x04000000,
+ CLONE_NEWIPC => 0x08000000,
+ CLONE_NEWUSER => 0x10000000,
+ 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) = @_;
}
# 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 = {};
my $mode = $shared ? LOCK_SH : LOCK_EX;
- my $lock_func = sub {
- if (!$lock_handles->{$$}->{$filename}) {
- $lock_handles->{$$}->{$filename} = new IO::File (">>$filename") ||
- die "can't open file - $!\n";
- }
+ my $lockhash = ($lock_handles->{$$} //= {});
- if (!flock ($lock_handles->{$$}->{$filename}, $mode|LOCK_NB)) {
- print STDERR "trying to aquire lock...";
+ # 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($fh, $mode|LOCK_NB)) {
+ print STDERR "trying to acquire lock...\n";
my $success;
while(1) {
- $success = flock($lock_handles->{$$}->{$filename}, $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 aquire lock - $!\n";
- }
- print STDERR " OK\n";
- }
+ 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}) {
- $lock_handles->{$$}->{$filename} = undef;
- close ($fh);
- }
-
- if ($err) {
- $@ = $err;
- return undef;
+ 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;
}
-
- $@ = undef;
-
+ $res = eval { &$code(@param); };
+ return undef if $@;
return $res;
}
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;
if (!rename($tmpname, $filename)) {
my $msg = "close (rename) atomic file '$filename' failed: $!\n";
unlink $tmpname;
- die $msg;
+ die $msg;
}
}
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;
return $content;
}
+sub file_copy {
+ my ($filename, $dst, $max, $perm) = @_;
+
+ file_set_contents ($dst, file_get_contents($filename, $max), $perm);
+}
+
sub file_read_firstline {
my ($filename) = @_;
}
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;
}
# -) an array of arguments (strings)
# Will be executed without interference from a shell. (Parameters are passed
# as is, no escape sequences of strings will be touched.)
+# -) an array of arrays
+# Each array represents a command, and each command's output is piped into
+# the following command's standard input.
+# For this a shell command string is created with pipe symbols between each
+# command.
+# Each command is a list of strings meant to end up in the final command
+# unchanged. In order to achieve this, every argument is shell-quoted.
+# Quoting can be disabled for a particular argument by turning it into a
+# reference, this allows inserting arbitrary shell options.
+# For instance: the $cmd [ [ 'echo', 'hello', \'>/dev/null' ] ] will not
+# produce any output, while the $cmd [ [ 'echo', 'hello', '>/dev/null' ] ]
+# will literally print: hello >/dev/null
sub run_command {
my ($cmd, %param) = @_;
my $old_umask;
my $cmdstr;
- if (!ref($cmd)) {
+ if (my $ref = ref($cmd)) {
+ if (ref($cmd->[0])) {
+ $cmdstr = 'set -o pipefail && ';
+ my $pipe = '';
+ foreach my $command (@$cmd) {
+ # concatenate quoted parameters
+ # strings which are passed by reference are NOT shell quoted
+ $cmdstr .= $pipe . join(' ', map { ref($_) ? $$_ : shellquote($_) } @$command);
+ $pipe = ' | ';
+ }
+ $cmd = [ '/bin/bash', '-c', "$cmdstr" ];
+ } else {
+ $cmdstr = cmd2string($cmd);
+ }
+ } else {
$cmdstr = $cmd;
if ($cmd =~ m/\|/) {
# see 'man bash' for option pipefail
} else {
$cmd = [ $cmd ];
}
- } else {
- $cmdstr = cmd2string($cmd);
}
my $errmsg;
my $timeout;
my $oldtimeout;
my $pid;
+ my $exitcode = -1;
my $outfunc;
my $errfunc;
my $input;
my $output;
my $afterfork;
+ my $noerr;
+ my $keeplocale;
eval {
$logfunc = $param{$p};
} elsif ($p eq 'afterfork') {
$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";
}
print STDERR "$laststderr\n" if $laststderr;
}
}
- $laststderr = shift;
+ $laststderr = shift;
};
}
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";
# catch exec errors
if ($orig_pid != $$) {
warn "ERROR: $err";
- POSIX::_exit (1);
- kill ('KILL', $$);
+ POSIX::_exit (1);
+ kill ('KILL', $$);
}
die $err if $err;
&$logfunc($errlog) if $logfunc && $errlog;
waitpid ($pid, 0);
-
+
if ($? == -1) {
die "failed to execute\n";
} elsif (my $sig = ($? & 127)) {
die "got signal $sig\n";
- } elsif (my $ec = ($? >> 8)) {
- if (!($ec == 24 && ($cmdstr =~ m|^(\S+/)?rsync\s|))) {
+ } elsif ($exitcode = ($? >> 8)) {
+ if (!($exitcode == 24 && ($cmdstr =~ m|^(\S+/)?rsync\s|))) {
if ($errmsg && $laststderr) {
my $lerr = $laststderr;
$laststderr = undef;
die "$lerr\n";
}
- die "exit code $ec\n";
+ die "exit code $exitcode\n";
}
}
if ($errmsg) {
$err =~ s/^usermod:\s*// if $cmdstr =~ m|^(\S+/)?usermod\s|;
die "$errmsg: $err";
- } else {
+ } elsif(!$noerr) {
die "command '$cmdstr' failed: $err";
}
}
+ return $exitcode;
+}
+
+# Run a command with a tcp socket as standard input.
+sub pipe_socket_to_command {
+ my ($cmd, $ip, $port) = @_;
+
+ my $params = {
+ Listen => 1,
+ ReuseAddr => 1,
+ Proto => &Socket::IPPROTO_TCP,
+ GetAddrInfoFlags => 0,
+ LocalAddr => $ip,
+ LocalPort => $port,
+ };
+ my $socket = IO::Socket::IP->new(%$params) or die "failed to open socket: $!\n";
+
+ print "$ip\n$port\n"; # tell remote where to connect
+ *STDOUT->flush();
+
+ alarm 0;
+ local $SIG{ALRM} = sub { die "timed out waiting for client\n" };
+ alarm 30;
+ my $client = $socket->accept; # Wait for a client
+ alarm 0;
+ close($socket);
+
+ # We want that the command talks over the TCP socket and takes
+ # ownership of it, so that when it closes it the connection is
+ # terminated, so we need to be able to close the socket. So we
+ # can't really use PVE::Tools::run_command().
+ my $pid = fork() // die "fork failed: $!\n";
+ if (!$pid) {
+ POSIX::dup2(fileno($client), 0);
+ POSIX::dup2(fileno($client), 1);
+ close($client);
+ exec {$cmd->[0]} @$cmd or do {
+ warn "exec failed: $!\n";
+ POSIX::_exit(1);
+ };
+ }
+
+ close($client);
+ if (waitpid($pid, 0) != $pid) {
+ kill(15 => $pid); # if we got interrupted terminate the child
+ my $count = 0;
+ while (waitpid($pid, POSIX::WNOHANG) != $pid) {
+ usleep(100000);
+ $count++;
+ kill(9 => $pid), last if $count > 300; # 30 second timeout
+ }
+ }
+ if (my $sig = ($? & 127)) {
+ die "got signal $sig\n";
+ } elsif (my $exitcode = ($? >> 8)) {
+ die "exit code $exitcode\n";
+ }
+
return undef;
}
my $listtxt = shift || '';
return split (/\0/, $listtxt) if $listtxt =~ m/\0/;
-
+
$listtxt =~ s/[,;]/ /g;
$listtxt =~ s/^\s+//;
$txt =~ s/^\s+//;
$txt =~ s/\s+$//;
-
+
return $txt;
}
my ($tmpl, $data) = @_;
return $tmpl if !$tmpl;
-
+
my $res = '';
while ($tmpl =~ m/([^{]+)?({([^}]+)})?/g) {
$res .= $1 if $1;
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'],
'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'],
};
my $kvmkeymaparray = [];
-foreach my $lc (keys %$keymaphash) {
+foreach my $lc (sort keys %$keymaphash) {
push @$kvmkeymaparray, $keymaphash->{$lc}->[1];
}
my $starttime = [gettimeofday];
my $elapsed;
+ my $found;
while (($elapsed = tv_interval($starttime)) < $timeout) {
- if (my $fh = IO::File->new ("/proc/net/tcp", "r")) {
- while (defined (my $line = <$fh>)) {
- if ($line =~ m/^\s*\d+:\s+([0-9A-Fa-f]{8}):([0-9A-Fa-f]{4})\s/) {
- if ($port == hex($2)) {
- close($fh);
- return 1;
- }
- }
+ # -Htln = don't print header, tcp, listening sockets only, numeric ports
+ run_command(['/bin/ss', '-Htln', "sport = :$port"], outfunc => sub {
+ my $line = shift;
+ if ($line =~ m/^LISTEN\s+\d+\s+\d+\s+\S+:(\d+)\s/) {
+ $found = 1 if ($port == $1);
}
- close($fh);
- }
+ });
+ return 1 if $found;
$sleeptime += 100000 if $sleeptime < 1000000;
usleep($sleeptime);
}
}
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.
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);
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);
+}
+
+# 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 {
+ my ($timeout, $sub) = @_;
+
+ my $res;
+ my $error;
+ my $pipe_out = IO::Pipe->new();
+
+ # disable pending alarms, save their remaining time
+ my $prev_alarm = alarm 0;
+
+ # avoid leaving a zombie if the parent gets interrupted
+ my $sig_received;
+ local $SIG{INT} = sub { $sig_received++; };
+
+ my $child = fork();
+ if (!defined($child)) {
+ die "fork failed: $!\n";
+ return $res;
+ }
+
+ if (!$child) {
+ $pipe_out->writer();
+
+ eval {
+ $res = $sub->();
+ print {$pipe_out} encode_json({ result => $res });
+ $pipe_out->flush();
+ };
+ if (my $err = $@) {
+ print {$pipe_out} encode_json({ error => $err });
+ $pipe_out->flush();
+ POSIX::_exit(1);
+ }
+ POSIX::_exit(0);
+ }
+
+ $pipe_out->reader();
+
+ my $readvalues = sub {
+ local $/ = undef;
+ my $child_res = decode_json(scalar<$pipe_out>);
+ $res = $child_res->{result};
+ $error = $child_res->{error};
+ };
+ eval {
+ if (defined($timeout)) {
+ run_with_timeout($timeout, $readvalues);
+ } else {
+ $readvalues->();
+ }
+ };
+ warn $@ if $@;
+ $pipe_out->close();
+ kill('KILL', $child);
+ waitpid($child, 0);
+
+ alarm $prev_alarm;
+ die "interrupted by unexpected signal\n" if $sig_received;
+
+ die $error if $error;
+ return $res;
+}
+
+sub run_fork {
+ my ($code) = @_;
+ return run_fork_with_timeout(undef, $code);
}
-# 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 the spawn external 'df' process instead of using
-# Filesys::Df (which uses statfs syscall)
+# So fork() before using Filesys::Df
sub df {
my ($path, $timeout) = @_;
- my $cmd = [ 'df', '-P', '-B', '1', $path];
-
my $res = {
total => 0,
used => 0,
avail => 0,
};
- my $parser = sub {
- my $line = shift;
- if (my ($fsid, $total, $used, $avail) = $line =~
- m/^(\S+.*)\s+(\d+)\s+(\d+)\s+(\d+)\s+\d+%\s.*$/) {
- $res = {
- total => $total,
- used => $used,
- avail => $avail,
- };
+ my $pipe = IO::Pipe->new();
+ my $child = fork();
+ if (!defined($child)) {
+ warn "fork failed: $!\n";
+ return $res;
+ }
+
+ 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);
+ }
+
+ $pipe->reader();
+
+ 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);
};
- eval { run_command($cmd, timeout => $timeout, outfunc => $parser); };
warn $@ if $@;
-
+ $pipe->close();
+ kill('KILL', $child);
+ waitpid($child, 0);
return $res;
}
# 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 {
# 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});
}
sub upid_open {
my ($upid) = @_;
- my ($task, $filename) = upid_decode($upid);
+ my ($task, $filename) = upid_decode($upid);
my $dirname = dirname($filename);
make_path($dirname);
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;
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) = @_;
return Encode::decode("utf8", uri_unescape($data));
}
+# depreciated - do not use!
+# we now decode all parameters by default
sub decode_utf8_parameters {
my ($param) = @_;
}
sub random_ether_addr {
+ my ($prefix) = @_;
my ($seconds, $microseconds) = gettimeofday;
- my $rand = Digest::SHA::sha1_hex($$, rand(), $seconds, $microseconds);
+ my $rand = Digest::SHA::sha1($$, rand(), $seconds, $microseconds);
- my $mac = '';
- for (my $i = 0; $i < 6; $i++) {
- my $ss = hex(substr($rand, $i*2, 2));
- if (!$i) {
- $ss &= 0xfe; # clear multicast
- $ss |= 2; # set local id
- }
- $ss = sprintf("%02X", $ss);
+ # clear multicast, set local id
+ vec($rand, 0, 8) = (vec($rand, 0, 8) & 0xfe) | 2;
- if (!$i) {
- $mac .= "$ss";
- } else {
- $mac .= ":$ss";
- }
+ my $addr = sprintf("%02X:%02X:%02X:%02X:%02X:%02X", unpack("C6", $rand));
+ if (defined($prefix)) {
+ $addr = uc($prefix) . substr($addr, length($prefix));
}
-
- return $mac;
+ return $addr;
}
sub shellquote {
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);
}
sub dump_journal {
- my ($start, $limit, $filter) = @_;
+ my ($start, $limit, $since, $until, $service) = @_;
my $lines = [];
my $count = 0;
-
+
$start = 0 if !$start;
$limit = 50 if !$limit;
};
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);
# HACK: ExtJS store.guaranteeRange() does not like empty array
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;
&$func (@res);
}
}
- }
+ }
}
sub assert_if_modified {
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 {
return; # nothing
}
+sub unshare($) {
+ my ($flags) = @_;
+ return 0 == syscall(PVE::Syscall::unshare, $flags);
+}
+
+sub setns($$) {
+ my ($fileno, $nstype) = @_;
+ return 0 == syscall(PVE::Syscall::setns, $fileno, $nstype);
+}
+
+sub syncfs($) {
+ my ($fileno) = @_;
+ return 0 == syscall(PVE::Syscall::syncfs, $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} // '/run';
+ my $mode = $opts{mode} // O_RDWR;
+ $mode |= O_EXCL if !$opts{allow_links};
+
+ 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;
+}
+
+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(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
+ 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(PVE::Syscall::close, $fd); # close
+ $! = $err;
+ return undef;
+}
+
+sub mkdirat($$$) {
+ my ($dirfd, $name, $mode) = @_;
+ 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 {
+ 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\$");
+}
+
+# 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
+# use $no_round_up to switch this off, above example would then return 0
+sub convert_size {
+ my ($value, $from, $to, $no_round_up) = @_;
+
+ my $units = {
+ b => 0,
+ kb => 1,
+ mb => 2,
+ gb => 3,
+ tb => 4,
+ pb => 5,
+ };
+
+ $from = lc($from); $to = lc($to);
+ die "unknown 'from' and/or 'to' units ($from => $to)"
+ if !(defined($units->{$from}) && defined($units->{$to}));
+
+ my $shift_amount = $units->{$from} - $units->{$to};
+
+ 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;
+ }
+
+ return $value;
+}
+
1;
projects / pve-common.git / blobdiff