qemu-server/PVE/QemuServer/Agent.pm
Stefan Reiter 0a13e08ec2 refactor: create QemuServer::Monitor for high-level QMP access
QMP and monitor helpers are moved from QemuServer.pm.

By using only vm_running_locally instead of check_running, a cyclic
dependency to QemuConfig is avoided. This also means that the $nocheck
parameter serves no more purpose, and has thus been removed along with
vm_mon_cmd_nocheck.

Care has been taken to avoid errors resulting from this, and
occasionally a manual check for a VM's existance inserted on the
callsite.

Methods have been renamed to avoid redundant naming:
* vm_qmp_command -> qmp_cmd
* vm_mon_cmd -> mon_cmd
* vm_human_monitor_command -> hmp_cmd

mon_cmd is exported since it has many users. This patch also changes all
non-package users of vm_qmp_command to use the mon_cmd helper. Includes
mocking for tests.

Signed-off-by: Stefan Reiter <s.reiter@proxmox.com>
2019-11-20 16:29:23 +01:00

118 lines
2.4 KiB
Perl

package PVE::QemuServer::Agent;
use strict;
use warnings;
use PVE::QemuServer;
use PVE::QemuServer::Monitor;
use MIME::Base64 qw(decode_base64);
use JSON;
use base 'Exporter';
our @EXPORT_OK = qw(
check_agent_error
agent_available
agent_cmd
);
sub check_agent_error {
my ($result, $errmsg, $noerr) = @_;
$errmsg //= '';
my $error = '';
if (ref($result) eq 'HASH' && $result->{error} && $result->{error}->{desc}) {
$error = "Agent error: $result->{error}->{desc}\n";
} elsif (!defined($result)) {
$error = "Agent error: $errmsg\n";
}
if ($error) {
die $error if !$noerr;
warn $error;
return undef;
}
return 1;
}
sub agent_available {
my ($vmid, $conf, $noerr) = @_;
eval {
die "No QEMU guest agent configured\n" if !defined($conf->{agent});
die "VM $vmid is not running\n" if !PVE::QemuServer::check_running($vmid);
die "QEMU guest agent is not running\n" if !PVE::QemuServer::qga_check_running($vmid, 1);
};
if (my $err = $@) {
die $err if !$noerr;
return undef;
}
return 1;
}
# loads config, checks if available, executes command, checks for errors
sub agent_cmd {
my ($vmid, $cmd, $params, $errormsg, $noerr) = @_;
my $conf = PVE::QemuConfig->load_config($vmid); # also checks if VM exists
agent_available($vmid, $conf, $noerr);
my $res = PVE::QemuServer::Monitor::mon_cmd($vmid, "guest-$cmd", %$params);
check_agent_error($res, $errormsg, $noerr);
return $res;
}
sub qemu_exec {
my ($vmid, $cmd) = @_;
my $path = shift @$cmd;
my $arguments = $cmd;
my $args = {
path => $path,
arg => $arguments,
'capture-output' => JSON::true,
};
my $res = agent_cmd($vmid, "exec", $args, "can't execute command '$path $arguments'");
return $res;
}
sub qemu_exec_status {
my ($vmid, $pid) = @_;
my $res = agent_cmd($vmid, "exec-status", { pid => $pid }, "can't get exec status for '$pid'");
if ($res->{'out-data'}) {
my $decoded = eval { decode_base64($res->{'out-data'}) };
warn $@ if $@;
if (defined($decoded)) {
$res->{'out-data'} = $decoded;
}
}
if ($res->{'err-data'}) {
my $decoded = eval { decode_base64($res->{'err-data'}) };
warn $@ if $@;
if (defined($decoded)) {
$res->{'err-data'} = $decoded;
}
}
# convert JSON::Boolean to 1/0
foreach my $d (keys %$res) {
if (JSON::is_bool($res->{$d})) {
$res->{$d} = ($res->{$d})? 1 : 0;
}
}
return $res;
}
1;