pve-common/src/PVE/Systemd.pm

package PVE::Systemd;

use strict;
use warnings;

use Net::DBus qw(dbus_uint32 dbus_uint64);
use Net::DBus::Callback;
use Net::DBus::Reactor;

use PVE::Tools qw(file_set_contents file_get_contents trim);

sub escape_unit {
    my ($val, $is_path) = @_;

    # NOTE: this is not complete, but enough for our needs. normally all
    # characters which are not alpha-numerical, '.' or '_' would need escaping
    $val =~ s/\-/\\x2d/g;

    if ($is_path) {
	$val =~ s/^\///g;
	$val =~ s/\/$//g;
    }
    $val =~ s/\//-/g;

    return $val;
}

sub unescape_unit {
    my ($val) = @_;

    $val =~ s/-/\//g;
    $val =~ s/\\x([a-fA-F0-9]{2})/chr(hex($1))/eg;

    return $val;
}

# $code should take the parameters ($interface, $reactor, $finish_callback).
#
# $finish_callback can be used by dbus-signal-handlers to stop the reactor.
#
# In order to even start waiting on the reactor, $code needs to return undef, if it returns a
# defined value instead, it is assumed that this is the result already and we can stop.
# 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 signals.
sub systemd_call($;$) {
    my ($code, $timeout) = @_;

    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');

    my ($finished, $current_result, $timer);
    my $finish_callback = sub {
	my ($result) = @_;

	$current_result = $result;

	$finished = 1;

	if (defined($timer)) {
	    $reactor->remove_timeout($timer);
	    $timer = undef;
	}

	if (defined($reactor)) {
	    $reactor->shutdown();
	    $reactor = undef;
	}
    };

    my $result = $code->($if, $reactor, $finish_callback);
    # Are we done immediately?
    return $result if defined $result;

    # Alterantively $finish_callback may have been called already?
    return $current_result if $finished;

    # Otherwise wait:
    my $on_timeout = sub {
	$finish_callback->(undef);
	die "timeout waiting on systemd\n";
    };
    $timer = $reactor->add_timeout($timeout * 1000, Net::DBus::Callback->new(method => $on_timeout))
	if defined($timeout);

    $reactor->run();
    $reactor->shutdown() if defined($reactor); # $finish_callback clears it

    return $current_result;
}

# 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} * 10_000)];
	} else {
	    die "Don't know how to encode $key for systemd scope\n";
	}
    }

    systemd_call(sub {
	my ($if, $reactor, $finish_cb) = @_;

	my $job;

	$if->connect_to_signal('JobRemoved', sub {
	    my ($id, $removed_job, $signaled_unit, $result) = @_;
	    return if $signaled_unit ne $unit || $removed_job ne $job;
	    if ($result ne 'done') {
		# I seem to remember $reactor->run() catching die() at some point?
		# so better call finish to be sure...:
		$finish_cb->(0);
		die "systemd job failed\n";
	    } else {
		$finish_cb->(1);
	    }
	});

	$job = $if->StartTransientUnit($unit, 'fail', $properties, []);

	return undef;
    }, $timeout);
}

sub wait_for_unit_removed($;$) {
    my ($unit, $timeout) = @_;

    systemd_call(sub {
	my ($if, $reactor, $finish_cb) = @_;

	my $unit_obj = eval { $if->GetUnit($unit) };
	return 1 if !$unit_obj;

	$if->connect_to_signal('UnitRemoved', sub {
	    my ($id, $removed_unit) = @_;
	    $finish_cb->(1) if $removed_unit eq $unit_obj;
	});

	# Deal with what we lost between GetUnit() and connecting to UnitRemoved:
	my $unit_obj_new = eval { $if->GetUnit($unit) };
	if (!$unit_obj_new) {
	    return 1;
	}

	return undef;
    }, $timeout);
}

sub read_ini {
    my ($filename) = @_;

    my $content = file_get_contents($filename);
    my @lines = split /\n/, $content;

    my $result = {};
    my $section;

    foreach my $line (@lines) {
	$line = trim($line);
	if ($line =~ m/^\[([^\]]+)\]/) {
	    $section = $1;
	    if (!defined($result->{$section})) {
		$result->{$section} = {};
	    }
	} elsif ($line =~ m/^(.*?)=(.*)$/) {
	    my ($key, $val) = ($1, $2);
	    if (!$section) {
		warn "key value pair found without section, skipping\n";
		next;
	    }

	    if ($result->{$section}->{$key}) {
		# make duplicate properties to arrays to keep the order
		my $prop = $result->{$section}->{$key};
		if (ref($prop) eq 'ARRAY') {
		    push @$prop, $val;
		} else {
		    $result->{$section}->{$key} = [$prop, $val];
		}
	    } else {
		$result->{$section}->{$key} = $val;
	    }
	}
	# ignore everything else
    }

    return $result;
};

sub write_ini {
    my ($ini, $filename) = @_;

    my $content = "";

    foreach my $sname (sort keys %$ini) {
	my $section = $ini->{$sname};

	$content .= "[$sname]\n";

	foreach my $pname (sort keys %$section) {
	    my $prop = $section->{$pname};

	    if (!ref($prop)) {
		$content .= "$pname=$prop\n";
	    } elsif (ref($prop) eq 'ARRAY') {
		foreach my $val (@$prop) {
		    $content .= "$pname=$val\n";
		}
	    } else {
		die "invalid property '$pname'\n";
	    }
	}
	$content .= "\n";
    }

    file_set_contents($filename, $content);
};

1;