Archipelago » qemu

# *-*- Mode: Python -*-*

##

#

# Echo back a unique integer value, and prepend to response a

# leading sentinel byte (0xFF) the client can check scan for.

#

# This is used by clients talking to the guest agent over the

# wire to ensure the stream is in sync and doesn't contain stale

# data from previous client. It must be issued upon initial

# connection, and after any client-side timeouts (including

# timeouts on receiving a response to this command).

#

# After issuing this request, all guest agent responses should be

# ignored until the response containing the unique integer value

# the client passed in is returned. Receival of the 0xFF sentinel

# byte must be handled as an indication that the client's

# lexer/tokenizer/parser state should be flushed/reset in

# preparation for reliably receiving the subsequent response. As

# an optimization, clients may opt to ignore all data until a

# sentinel value is receiving to avoid unnecessary processing of

# stale data.

#

# Similarly, clients should also precede this *request*

# with a 0xFF byte to make sure the guest agent flushes any

# partially read JSON data from a previous client connection.

#

# @id: randomly generated 64-bit integer

#

# Returns: The unique integer id passed in by the client

#

# Since: 1.1

# ##

{ 'command': 'guest-sync-delimited'

  'data':    { 'id': 'int' },

  'returns': 'int' }

##

# @guest-sync:

#

# Echo back a unique integer value

#

# This is used by clients talking to the guest agent over the

# wire to ensure the stream is in sync and doesn't contain stale

# data from previous client. All guest agent responses should be

# ignored until the provided unique integer value is returned,

# and it is up to the client to handle stale whole or

# partially-delivered JSON text in such a way that this response

# can be obtained.

#

# In cases where a partial stale response was previously

# received by the client, this cannot always be done reliably.

# One particular scenario being if qemu-ga responses are fed

# character-by-character into a JSON parser. In these situations,

# using guest-sync-delimited may be optimal.

#

# For clients that fetch responses line by line and convert them

# to JSON objects, guest-sync should be sufficient, but note that

# in cases where the channel is dirty some attempts at parsing the

# response may result in a parser error.

#

# Such clients should also precede this command

# with a 0xFF byte to make sure the guest agent flushes any

# partially read JSON data from a previous session.

#

# @id: randomly generated 64-bit integer

#

# Returns: The unique integer id passed in by the client

#

# Since: 0.15.0

##

{ 'command': 'guest-sync'

  'data':    { 'id': 'int' },

  'returns': 'int' }

##

# @guest-ping:

#

# Ping the guest agent, a non-error return implies success

#

# Since: 0.15.0

##

{ 'command': 'guest-ping' }

##

# @GuestAgentCommandInfo:

#

# Information about guest agent commands.

#

# @name: name of the command

#

# @enabled: whether command is currently enabled by guest admin

#

# Since 1.1.0

##

{ 'type': 'GuestAgentCommandInfo',

  'data': { 'name': 'str', 'enabled': 'bool' } }

##

# @GuestAgentInfo

#

# Information about guest agent.

#

# @version: guest agent version

#

# @supported_commands: Information about guest agent commands

#

# Since 0.15.0

##

{ 'type': 'GuestAgentInfo',

  'data': { 'version': 'str',

            'supported_commands': ['GuestAgentCommandInfo'] } }

##

# @guest-info:

#

# Get some information about the guest agent.

#

# Returns: @GuestAgentInfo

#

# Since: 0.15.0

##

{ 'command': 'guest-info',

  'returns': 'GuestAgentInfo' }

##

# @guest-shutdown:

#

# Initiate guest-activated shutdown. Note: this is an asynchronous

# shutdown request, with no guarantee of successful shutdown.

#

# @mode: #optional "halt", "powerdown" (default), or "reboot"

#

# This command does NOT return a response on success. Success condition

# is indicated by the VM exiting with a zero exit status or, when

# running with --no-shutdown, by issuing the query-status QMP command

# to confirm the VM status is "shutdown".

#

# Since: 0.15.0

##

{ 'command': 'guest-shutdown', 'data': { '*mode': 'str' },

  'success-response': 'no' }

##

# @guest-file-open:

#

# Open a file in the guest and retrieve a file handle for it

#

# @filepath: Full path to the file in the guest to open.

#

# @mode: #optional open mode, as per fopen(), "r" is the default.

#

# Returns: Guest file handle on success.

#

# Since: 0.15.0

##

{ 'command': 'guest-file-open',

  'data':    { 'path': 'str', '*mode': 'str' },

  'returns': 'int' }

##

# @guest-file-close:

#

# Close an open file in the guest

#

# @handle: filehandle returned by guest-file-open

#

# Returns: Nothing on success.

#

# Since: 0.15.0

##

{ 'command': 'guest-file-close',

  'data': { 'handle': 'int' } }

##

# @GuestFileRead

#

# Result of guest agent file-read operation

#

# @count: number of bytes read (note: count is *before*

#         base64-encoding is applied)

#

# @buf-b64: base64-encoded bytes read

#

# @eof: whether EOF was encountered during read operation.

#

# Since: 0.15.0

##

{ 'type': 'GuestFileRead',

  'data': { 'count': 'int', 'buf-b64': 'str', 'eof': 'bool' } }

##

# @guest-file-read:

#

# Read from an open file in the guest. Data will be base64-encoded

#

# @handle: filehandle returned by guest-file-open

#

# @count: #optional maximum number of bytes to read (default is 4KB)

#

# Returns: @GuestFileRead on success.

#

# Since: 0.15.0

##

{ 'command': 'guest-file-read',

  'data':    { 'handle': 'int', '*count': 'int' },

  'returns': 'GuestFileRead' }

##

# @GuestFileWrite

#

# Result of guest agent file-write operation

#

# @count: number of bytes written (note: count is actual bytes

#         written, after base64-decoding of provided buffer)

#

# @eof: whether EOF was encountered during write operation.

#

# Since: 0.15.0

##

{ 'type': 'GuestFileWrite',

  'data': { 'count': 'int', 'eof': 'bool' } }

##

# @guest-file-write:

#

# Write to an open file in the guest.

#

# @handle: filehandle returned by guest-file-open

#

# @buf-b64: base64-encoded string representing data to be written

#

# @count: #optional bytes to write (actual bytes, after base64-decode),

#         default is all content in buf-b64 buffer after base64 decoding

#

# Returns: @GuestFileWrite on success.

#

# Since: 0.15.0

##

{ 'command': 'guest-file-write',

  'data':    { 'handle': 'int', 'buf-b64': 'str', '*count': 'int' },

  'returns': 'GuestFileWrite' }

##

# @GuestFileSeek

#

# Result of guest agent file-seek operation

#

# @position: current file position

#

# @eof: whether EOF was encountered during file seek

#

# Since: 0.15.0

##

{ 'type': 'GuestFileSeek',

  'data': { 'position': 'int', 'eof': 'bool' } }

##

# @guest-file-seek:

#

# Seek to a position in the file, as with fseek(), and return the

# current file position afterward. Also encapsulates ftell()'s

# functionality, just Set offset=0, whence=SEEK_CUR.

#

# @handle: filehandle returned by guest-file-open

#

# @offset: bytes to skip over in the file stream

#

# @whence: SEEK_SET, SEEK_CUR, or SEEK_END, as with fseek()

#

# Returns: @GuestFileSeek on success.

#

# Since: 0.15.0

##

{ 'command': 'guest-file-seek',

  'data':    { 'handle': 'int', 'offset': 'int', 'whence': 'int' },

  'returns': 'GuestFileSeek' }

##

# @guest-file-flush:

#

# Write file changes bufferred in userspace to disk/kernel buffers