]> git.proxmox.com Git - mirror_qemu.git/commit - qga/qapi-schema.json
qemu-ga: add guest-sync-delimited
authorMichael Roth <mdroth@linux.vnet.ibm.com>
Tue, 7 Feb 2012 19:56:48 +0000 (13:56 -0600)
committerMichael Roth <mdroth@linux.vnet.ibm.com>
Mon, 12 Mar 2012 20:09:23 +0000 (15:09 -0500)
commit3cf0bed8369267184e5dc5b58882811519d67437
treea9c32d61d08ec7ab795b1b2cc4d74252087e1130
parent3424fc9f16a1e7d1c48eb6d605eb0ca63e199ec2
qemu-ga: add guest-sync-delimited

guest-sync leaves it as an exercise to the user as to how to reliably
obtain the response to guest-sync if the client had previously read in a
partial response (due qemu-ga previously being restarted mid-"sentence"
due to reboot, forced restart, etc).

qemu-ga handles this situation on its end by having a client precede
their guest-sync request with a 0xFF byte (invalid UTF-8), which
qemu-ga/QEMU JSON parsers will treat as a flush event. Thus we can
reliably flush the qemu-ga parser state in preparation for receiving
the guest-sync request.

guest-sync-delimited provides the same functionality for a client: when
a guest-sync-delimited is issued, qemu-ga will precede it's response
with a 0xFF byte that the client can use as an indicator to flush its
buffer/parser state in preparation for reliably receiving the
guest-sync-delimited response.

It is also useful as an optimization for clients, since, after issuing a
guest-sync-delimited, clients can safely discard all stale data read
from the channel until the 0xFF is found.

More information available on the wiki:

http://wiki.qemu.org/Features/QAPI/GuestAgent#QEMU_Guest_Agent_Protocol

Signed-off-by: Michael Roth <mdroth@linux.vnet.ibm.com>
qapi-schema-guest.json
qemu-ga.c
qga/commands-posix.c
qga/commands.c
qga/guest-agent-core.h