2011-10-05 17:31:54 +00:00
|
|
|
/*
|
|
|
|
* qemu_agent.h: interaction with QEMU guest agent
|
|
|
|
*
|
|
|
|
* Copyright (C) 2006-2012 Red Hat, Inc.
|
|
|
|
* Copyright (C) 2006 Daniel P. Berrange
|
|
|
|
*
|
|
|
|
* This library is free software; you can redistribute it and/or
|
|
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
|
|
* License as published by the Free Software Foundation; either
|
|
|
|
* version 2.1 of the License, or (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This library is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
|
* Lesser General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU Lesser General Public
|
2012-09-20 22:30:55 +00:00
|
|
|
* License along with this library. If not, see
|
2012-07-21 10:06:23 +00:00
|
|
|
* <http://www.gnu.org/licenses/>.
|
2011-10-05 17:31:54 +00:00
|
|
|
*/
|
|
|
|
|
2019-06-18 16:12:37 +00:00
|
|
|
#pragma once
|
2011-10-05 17:31:54 +00:00
|
|
|
|
2019-06-18 16:12:37 +00:00
|
|
|
#include "internal.h"
|
|
|
|
#include "domain_conf.h"
|
2011-10-05 17:31:54 +00:00
|
|
|
|
|
|
|
typedef struct _qemuAgent qemuAgent;
|
|
|
|
typedef qemuAgent *qemuAgentPtr;
|
|
|
|
|
|
|
|
typedef struct _qemuAgentCallbacks qemuAgentCallbacks;
|
|
|
|
typedef qemuAgentCallbacks *qemuAgentCallbacksPtr;
|
|
|
|
struct _qemuAgentCallbacks {
|
|
|
|
void (*destroy)(qemuAgentPtr mon,
|
|
|
|
virDomainObjPtr vm);
|
|
|
|
void (*eofNotify)(qemuAgentPtr mon,
|
|
|
|
virDomainObjPtr vm);
|
|
|
|
void (*errorNotify)(qemuAgentPtr mon,
|
|
|
|
virDomainObjPtr vm);
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
qemuAgentPtr qemuAgentOpen(virDomainObjPtr vm,
|
2016-01-08 15:21:30 +00:00
|
|
|
const virDomainChrSourceDef *config,
|
2020-02-12 14:54:19 +00:00
|
|
|
GMainContext *context,
|
2020-03-05 14:47:01 +00:00
|
|
|
qemuAgentCallbacksPtr cb,
|
|
|
|
bool singleSync);
|
2011-10-05 17:31:54 +00:00
|
|
|
|
|
|
|
void qemuAgentClose(qemuAgentPtr mon);
|
|
|
|
|
processSerialChangedEvent: Close agent monitor early
https://bugzilla.redhat.com/show_bug.cgi?id=890648
So, imagine you've issued an API that involves guest agent. For
instance, you want to query guest's IP addresses. So the API acquires
QUERY_JOB, locks the guest agent and issues the agent command.
However, for some reason, guest agent replies to initial ping
correctly, but then crashes tragically while executing real command
(in this case guest-network-get-interfaces). Since initial ping went
well, libvirt thinks guest agent is accessible and awaits reply to the
real command. But it will never come. What will is a monitor event.
Our handler (processSerialChangedEvent) will try to acquire
MODIFY_JOB, which will fail obviously because the other thread that's
executing the API already holds a job. So the event handler exits
early, and the QUERY_JOB is never released nor ended.
The way how to solve this is to put flag somewhere in the monitor
internals. The flag is called @running and agent commands are issued
iff the flag is set. The flag itself is set when we connect to the
agent socket. And unset whenever we see DISCONNECT event from the
agent. Moreover, we must wake up all the threads waiting for the
agent. This is done by signalizing the condition they're waiting on.
Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
2015-05-07 09:19:38 +00:00
|
|
|
void qemuAgentNotifyClose(qemuAgentPtr mon);
|
|
|
|
|
2012-06-15 16:00:13 +00:00
|
|
|
typedef enum {
|
|
|
|
QEMU_AGENT_EVENT_NONE = 0,
|
|
|
|
QEMU_AGENT_EVENT_SHUTDOWN,
|
2012-09-04 10:01:43 +00:00
|
|
|
QEMU_AGENT_EVENT_SUSPEND,
|
|
|
|
QEMU_AGENT_EVENT_RESET,
|
2012-06-15 16:00:13 +00:00
|
|
|
} qemuAgentEvent;
|
|
|
|
|
|
|
|
void qemuAgentNotifyEvent(qemuAgentPtr mon,
|
|
|
|
qemuAgentEvent event);
|
|
|
|
|
2011-10-05 17:31:54 +00:00
|
|
|
typedef enum {
|
|
|
|
QEMU_AGENT_SHUTDOWN_POWERDOWN,
|
|
|
|
QEMU_AGENT_SHUTDOWN_REBOOT,
|
|
|
|
QEMU_AGENT_SHUTDOWN_HALT,
|
|
|
|
|
|
|
|
QEMU_AGENT_SHUTDOWN_LAST,
|
|
|
|
} qemuAgentShutdownMode;
|
|
|
|
|
2020-01-10 23:32:13 +00:00
|
|
|
typedef struct _qemuAgentDiskInfo qemuAgentDiskInfo;
|
|
|
|
typedef qemuAgentDiskInfo *qemuAgentDiskInfoPtr;
|
|
|
|
struct _qemuAgentDiskInfo {
|
|
|
|
char *serial;
|
|
|
|
virPCIDeviceAddress pci_controller;
|
|
|
|
char *bus_type;
|
|
|
|
unsigned int bus;
|
|
|
|
unsigned int target;
|
|
|
|
unsigned int unit;
|
|
|
|
char *devnode;
|
|
|
|
};
|
|
|
|
|
|
|
|
typedef struct _qemuAgentFSInfo qemuAgentFSInfo;
|
|
|
|
typedef qemuAgentFSInfo *qemuAgentFSInfoPtr;
|
|
|
|
struct _qemuAgentFSInfo {
|
|
|
|
char *mountpoint; /* path to mount point */
|
|
|
|
char *name; /* device name in the guest (e.g. "sda1") */
|
|
|
|
char *fstype; /* filesystem type */
|
|
|
|
long long total_bytes;
|
|
|
|
long long used_bytes;
|
|
|
|
size_t ndisks;
|
|
|
|
qemuAgentDiskInfoPtr *disks;
|
|
|
|
};
|
|
|
|
void qemuAgentFSInfoFree(qemuAgentFSInfoPtr info);
|
|
|
|
|
2011-10-05 17:31:54 +00:00
|
|
|
int qemuAgentShutdown(qemuAgentPtr mon,
|
|
|
|
qemuAgentShutdownMode mode);
|
|
|
|
|
2014-05-02 00:06:19 +00:00
|
|
|
int qemuAgentFSFreeze(qemuAgentPtr mon,
|
|
|
|
const char **mountpoints, unsigned int nmountpoints);
|
2012-01-24 20:13:40 +00:00
|
|
|
int qemuAgentFSThaw(qemuAgentPtr mon);
|
2020-03-16 07:37:13 +00:00
|
|
|
int qemuAgentGetFSInfo(qemuAgentPtr mon,
|
|
|
|
qemuAgentFSInfoPtr **info,
|
|
|
|
bool report_unsupported);
|
2019-08-23 16:31:21 +00:00
|
|
|
|
2012-02-13 11:27:25 +00:00
|
|
|
int qemuAgentSuspend(qemuAgentPtr mon,
|
|
|
|
unsigned int target);
|
2012-08-23 03:29:22 +00:00
|
|
|
|
|
|
|
int qemuAgentArbitraryCommand(qemuAgentPtr mon,
|
|
|
|
const char *cmd,
|
|
|
|
char **result,
|
|
|
|
int timeout);
|
2012-11-20 16:10:29 +00:00
|
|
|
int qemuAgentFSTrim(qemuAgentPtr mon,
|
|
|
|
unsigned long long minimum);
|
2013-04-12 10:14:02 +00:00
|
|
|
|
|
|
|
|
|
|
|
typedef struct _qemuAgentCPUInfo qemuAgentCPUInfo;
|
|
|
|
typedef qemuAgentCPUInfo *qemuAgentCPUInfoPtr;
|
|
|
|
struct _qemuAgentCPUInfo {
|
|
|
|
unsigned int id; /* logical cpu ID */
|
|
|
|
bool online; /* true if the CPU is activated */
|
|
|
|
bool offlinable; /* true if the CPU can be offlined */
|
2016-06-20 12:15:50 +00:00
|
|
|
|
|
|
|
bool modified; /* set to true if the vcpu state needs to be changed */
|
2013-04-12 10:14:02 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
int qemuAgentGetVCPUs(qemuAgentPtr mon, qemuAgentCPUInfoPtr *info);
|
|
|
|
int qemuAgentSetVCPUs(qemuAgentPtr mon, qemuAgentCPUInfoPtr cpus, size_t ncpus);
|
2013-07-30 10:04:21 +00:00
|
|
|
int qemuAgentUpdateCPUInfo(unsigned int nvcpus,
|
|
|
|
qemuAgentCPUInfoPtr cpuinfo,
|
|
|
|
int ncpuinfo);
|
2014-04-02 17:05:42 +00:00
|
|
|
|
2018-09-05 04:20:53 +00:00
|
|
|
int
|
|
|
|
qemuAgentGetHostname(qemuAgentPtr mon,
|
2020-03-16 07:26:34 +00:00
|
|
|
char **hostname,
|
|
|
|
bool report_unsupported);
|
2018-09-05 04:20:53 +00:00
|
|
|
|
2014-04-02 17:05:42 +00:00
|
|
|
int qemuAgentGetTime(qemuAgentPtr mon,
|
|
|
|
long long *seconds,
|
|
|
|
unsigned int *nseconds);
|
|
|
|
int qemuAgentSetTime(qemuAgentPtr mon,
|
|
|
|
long long seconds,
|
|
|
|
unsigned int nseconds,
|
|
|
|
bool sync);
|
2015-01-25 18:38:48 +00:00
|
|
|
|
|
|
|
int qemuAgentGetInterfaces(qemuAgentPtr mon,
|
|
|
|
virDomainInterfacePtr **ifaces);
|
|
|
|
|
2015-05-18 10:42:07 +00:00
|
|
|
int qemuAgentSetUserPassword(qemuAgentPtr mon,
|
|
|
|
const char *user,
|
|
|
|
const char *password,
|
|
|
|
bool crypted);
|
2019-08-23 16:31:17 +00:00
|
|
|
|
|
|
|
int qemuAgentGetUsers(qemuAgentPtr mon,
|
|
|
|
virTypedParameterPtr *params,
|
|
|
|
int *nparams,
|
2020-03-16 07:37:13 +00:00
|
|
|
int *maxparams,
|
|
|
|
bool report_unsupported);
|
2019-08-23 16:31:18 +00:00
|
|
|
|
|
|
|
int qemuAgentGetOSInfo(qemuAgentPtr mon,
|
|
|
|
virTypedParameterPtr *params,
|
|
|
|
int *nparams,
|
2020-03-16 07:37:13 +00:00
|
|
|
int *maxparams,
|
|
|
|
bool report_unsupported);
|
2019-08-23 16:31:19 +00:00
|
|
|
|
|
|
|
int qemuAgentGetTimezone(qemuAgentPtr mon,
|
|
|
|
virTypedParameterPtr *params,
|
|
|
|
int *nparams,
|
2020-03-16 07:37:13 +00:00
|
|
|
int *maxparams,
|
|
|
|
bool report_unsupported);
|
Add API to change qemu agent response timeout
Some layered products such as oVirt have requested a way to avoid being
blocked by guest agent commands when querying a loaded vm. For example,
many guest agent commands are polled periodically to monitor changes,
and rather than blocking the calling process, they'd prefer to simply
time out when an agent query is taking too long.
This patch adds a way for the user to specify a custom agent timeout
that is applied to all agent commands.
One special case to note here is the 'guest-sync' command. 'guest-sync'
is issued internally prior to calling any other command. (For example,
when libvirt wants to call 'guest-get-fsinfo', we first call
'guest-sync' and then call 'guest-get-fsinfo').
Previously, the 'guest-sync' command used a 5-second timeout
(VIR_DOMAIN_QEMU_AGENT_COMMAND_DEFAULT), whereas the actual command that
followed always blocked indefinitely
(VIR_DOMAIN_QEMU_AGENT_COMMAND_BLOCK). As part of this patch, if a
custom timeout is specified that is shorter than
5 seconds, this new timeout is also used for 'guest-sync'. If there is
no custom timeout or if the custom timeout is longer than 5 seconds, we
will continue to use the 5-second timeout.
Signed-off-by: Jonathon Jongsma <jjongsma@redhat.com>
Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
2019-11-13 22:06:09 +00:00
|
|
|
|
|
|
|
void qemuAgentSetResponseTimeout(qemuAgentPtr mon,
|
|
|
|
int timeout);
|