summaryrefslogtreecommitdiff
path: root/src/remote/qemu_protocol.x
blob: c7f3abfcbf84bc80345889e410fd1980814e2470 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
/* -*- 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"

/*----- 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 {
    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;
};

struct qemu_domain_monitor_command_with_files_args {
    remote_nonnull_domain dom;
    remote_nonnull_string cmd;
    unsigned int flags;
};

struct qemu_domain_monitor_command_with_files_ret {
    remote_nonnull_string result;
};


/* 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,

    /**
     * @generate: none
     * @priority: low
     * @acl: domain:write
     */
    QEMU_PROC_DOMAIN_MONITOR_COMMAND_WITH_FILES = 7
};