libvirt/src/remote/qemu_protocol.x

157 lines
4.1 KiB
Plaintext
Raw Normal View History

/* -*- c -*-
* qemu_protocol.x: private protocol for communicating between
* remote_internal driver and libvirtd. This protocol is
* internal and may change at any time.
*
* Copyright (C) 2010-2014 Red Hat, Inc.
*
* 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
* License along with this library. If not, see
* <http://www.gnu.org/licenses/>.
*/
%#include "internal.h"
%#include "remote_protocol.h"
%#include <arpa/inet.h>
/*----- Protocol. -----*/
struct qemu_domain_monitor_command_args {
remote_nonnull_domain dom;
remote_nonnull_string cmd;
unsigned int flags;
};
struct qemu_domain_monitor_command_ret {
remote_nonnull_string result;
};
struct qemu_domain_attach_args {
build: use correct type for pid and similar types No thanks to 64-bit windows, with 64-bit pid_t, we have to avoid constructs like 'int pid'. Our API in libvirt-qemu cannot be changed without breaking ABI; but then again, libvirt-qemu can only be used on systems that support UNIX sockets, which rules out Windows (even if qemu could be compiled there) - so for all points on the call chain that interact with this API decision, we require a different variable name to make it clear that we audited the use for safety. Adding a syntax-check rule only solves half the battle; anywhere that uses printf on a pid_t still needs to be converted, but that will be a separate patch. * cfg.mk (sc_correct_id_types): New syntax check. * src/libvirt-qemu.c (virDomainQemuAttach): Document why we didn't use pid_t for pid, and validate for overflow. * include/libvirt/libvirt-qemu.h (virDomainQemuAttach): Tweak name for syntax check. * src/vmware/vmware_conf.c (vmwareExtractPid): Likewise. * src/driver.h (virDrvDomainQemuAttach): Likewise. * tools/virsh.c (cmdQemuAttach): Likewise. * src/remote/qemu_protocol.x (qemu_domain_attach_args): Likewise. * src/qemu_protocol-structs (qemu_domain_attach_args): Likewise. * src/util/cgroup.c (virCgroupPidCode, virCgroupKillInternal): Likewise. * src/qemu/qemu_command.c(qemuParseProcFileStrings): Likewise. (qemuParseCommandLinePid): Use pid_t for pid. * daemon/libvirtd.c (daemonForkIntoBackground): Likewise. * src/conf/domain_conf.h (_virDomainObj): Likewise. * src/probes.d (rpc_socket_new): Likewise. * src/qemu/qemu_command.h (qemuParseCommandLinePid): Likewise. * src/qemu/qemu_driver.c (qemudGetProcessInfo, qemuDomainAttach): Likewise. * src/qemu/qemu_process.c (qemuProcessAttach): Likewise. * src/qemu/qemu_process.h (qemuProcessAttach): Likewise. * src/uml/uml_driver.c (umlGetProcessInfo): Likewise. * src/util/virnetdev.h (virNetDevSetNamespace): Likewise. * src/util/virnetdev.c (virNetDevSetNamespace): Likewise. * tests/testutils.c (virtTestCaptureProgramOutput): Likewise. * src/conf/storage_conf.h (_virStoragePerms): Use mode_t, uid_t, and gid_t rather than int. * src/security/security_dac.c (virSecurityDACSetOwnership): Likewise. * src/conf/storage_conf.c (virStorageDefParsePerms): Avoid compiler warning.
2012-02-10 23:08:11 +00:00
unsigned int pid_value;
unsigned int flags;
};
struct qemu_domain_attach_ret {
remote_nonnull_domain dom;
};
struct qemu_domain_agent_command_args {
remote_nonnull_domain dom;
remote_nonnull_string cmd;
int timeout;
unsigned int flags;
};
struct qemu_domain_agent_command_ret {
remote_string result;
};
struct qemu_connect_domain_monitor_event_register_args {
remote_domain dom;
remote_string event;
unsigned int flags;
};
struct qemu_connect_domain_monitor_event_register_ret {
int callbackID;
};
struct qemu_connect_domain_monitor_event_deregister_args {
int callbackID;
};
struct qemu_domain_monitor_event_msg {
int callbackID;
remote_nonnull_domain dom;
remote_nonnull_string event;
hyper seconds;
unsigned int micros;
remote_string details;
};
/* Define the program number, protocol version and procedure numbers here. */
const QEMU_PROGRAM = 0x20008087;
const QEMU_PROTOCOL_VERSION = 1;
enum qemu_procedure {
/* Each function must be preceded by a comment providing one or
* more annotations:
*
* - @generate: none|client|server|both
*
* Whether to generate the dispatch stubs for the server
* and/or client code.
*
* - @readstream: paramnumber
* - @writestream: paramnumber
*
* The @readstream or @writestream annotations let daemon and src/remote
* create a stream. The direction is defined from the src/remote point
* of view. A readstream transfers data from daemon to src/remote. The
* <paramnumber> specifies at which offset the stream parameter is inserted
* in the function parameter list.
*
* - @priority: low|high
*
* Each API that might eventually access hypervisor's monitor (and thus
* block) MUST fall into low priority. However, there are some exceptions
* to this rule, e.g. domainDestroy. Other APIs MAY be marked as high
* priority. If in doubt, it's safe to choose low. Low is taken as default,
* and thus can be left out.
*/
/**
* @generate: none
* @priority: low
* @acl: domain:write
*/
QEMU_PROC_DOMAIN_MONITOR_COMMAND = 1,
/**
* @generate: both
* @priority: low
* @acl: domain:start
* @acl: domain:write
*/
QEMU_PROC_DOMAIN_ATTACH = 2,
/**
* @generate: both
* @priority: low
* @acl: domain:write
*/
QEMU_PROC_DOMAIN_AGENT_COMMAND = 3,
/**
* @generate: none
* @priority: high
* @acl: connect:search_domains
* @acl: connect:write
* @aclfilter: domain:getattr
*/
QEMU_PROC_CONNECT_DOMAIN_MONITOR_EVENT_REGISTER = 4,
/**
* @generate: none
* @priority: high
* @acl: connect:write
*/
QEMU_PROC_CONNECT_DOMAIN_MONITOR_EVENT_DEREGISTER = 5,
/**
* @generate: both
* @acl: none
*/
QEMU_PROC_DOMAIN_MONITOR_EVENT = 6
};