xref: /openbmc/qemu/scripts/qapi/commands.py (revision fb0bc835e56b894cbc7236294921e5393c786ad8) 
1"""
2QAPI command marshaller generator
3
4Copyright IBM, Corp. 2011
5Copyright (C) 2014-2018 Red Hat, Inc.
6
7Authors:
8 Anthony Liguori <aliguori@us.ibm.com>
9 Michael Roth <mdroth@linux.vnet.ibm.com>
10 Markus Armbruster <armbru@redhat.com>
11
12This work is licensed under the terms of the GNU GPL, version 2.
13See the COPYING file in the top-level directory.
14"""
15
16from qapi.common import *
17
18
19def gen_command_decl(name, arg_type, boxed, ret_type):
20    return mcgen('''
21%(c_type)s qmp_%(c_name)s(%(params)s);
22''',
23                 c_type=(ret_type and ret_type.c_type()) or 'void',
24                 c_name=c_name(name),
25                 params=build_params(arg_type, boxed, 'Error **errp'))
26
27
28def gen_call(name, arg_type, boxed, ret_type):
29    ret = ''
30
31    argstr = ''
32    if boxed:
33        assert arg_type and not arg_type.is_empty()
34        argstr = '&arg, '
35    elif arg_type:
36        assert not arg_type.variants
37        for memb in arg_type.members:
38            if memb.optional:
39                argstr += 'arg.has_%s, ' % c_name(memb.name)
40            argstr += 'arg.%s, ' % c_name(memb.name)
41
42    lhs = ''
43    if ret_type:
44        lhs = 'retval = '
45
46    ret = mcgen('''
47
48    %(lhs)sqmp_%(c_name)s(%(args)s&err);
49''',
50                c_name=c_name(name), args=argstr, lhs=lhs)
51    if ret_type:
52        ret += mcgen('''
53    if (err) {
54        goto out;
55    }
56
57    qmp_marshal_output_%(c_name)s(retval, ret, &err);
58''',
59                     c_name=ret_type.c_name())
60    return ret
61
62
63def gen_marshal_output(ret_type):
64    return mcgen('''
65
66static void qmp_marshal_output_%(c_name)s(%(c_type)s ret_in, QObject **ret_out, Error **errp)
67{
68    Error *err = NULL;
69    Visitor *v;
70
71    v = qobject_output_visitor_new(ret_out);
72    visit_type_%(c_name)s(v, "unused", &ret_in, &err);
73    if (!err) {
74        visit_complete(v, ret_out);
75    }
76    error_propagate(errp, err);
77    visit_free(v);
78    v = qapi_dealloc_visitor_new();
79    visit_type_%(c_name)s(v, "unused", &ret_in, NULL);
80    visit_free(v);
81}
82''',
83                 c_type=ret_type.c_type(), c_name=ret_type.c_name())
84
85
86def build_marshal_proto(name):
87    return ('void qmp_marshal_%s(QDict *args, QObject **ret, Error **errp)'
88            % c_name(name))
89
90
91def gen_marshal_decl(name):
92    return mcgen('''
93%(proto)s;
94''',
95                 proto=build_marshal_proto(name))
96
97
98def gen_marshal(name, arg_type, boxed, ret_type):
99    have_args = arg_type and not arg_type.is_empty()
100
101    ret = mcgen('''
102
103%(proto)s
104{
105    Error *err = NULL;
106''',
107                proto=build_marshal_proto(name))
108
109    if ret_type:
110        ret += mcgen('''
111    %(c_type)s retval;
112''',
113                     c_type=ret_type.c_type())
114
115    if have_args:
116        visit_members = ('visit_type_%s_members(v, &arg, &err);'
117                         % arg_type.c_name())
118        ret += mcgen('''
119    Visitor *v;
120    %(c_name)s arg = {0};
121
122''',
123                     c_name=arg_type.c_name())
124    else:
125        visit_members = ''
126        ret += mcgen('''
127    Visitor *v = NULL;
128
129    if (args) {
130''')
131        push_indent()
132
133    ret += mcgen('''
134    v = qobject_input_visitor_new(QOBJECT(args));
135    visit_start_struct(v, NULL, NULL, 0, &err);
136    if (err) {
137        goto out;
138    }
139    %(visit_members)s
140    if (!err) {
141        visit_check_struct(v, &err);
142    }
143    visit_end_struct(v, NULL);
144    if (err) {
145        goto out;
146    }
147''',
148                 visit_members=visit_members)
149
150    if not have_args:
151        pop_indent()
152        ret += mcgen('''
153    }
154''')
155
156    ret += gen_call(name, arg_type, boxed, ret_type)
157
158    ret += mcgen('''
159
160out:
161    error_propagate(errp, err);
162    visit_free(v);
163''')
164
165    if have_args:
166        visit_members = ('visit_type_%s_members(v, &arg, NULL);'
167                         % arg_type.c_name())
168    else:
169        visit_members = ''
170        ret += mcgen('''
171    if (args) {
172''')
173        push_indent()
174
175    ret += mcgen('''
176    v = qapi_dealloc_visitor_new();
177    visit_start_struct(v, NULL, NULL, 0, NULL);
178    %(visit_members)s
179    visit_end_struct(v, NULL);
180    visit_free(v);
181''',
182                 visit_members=visit_members)
183
184    if not have_args:
185        pop_indent()
186        ret += mcgen('''
187    }
188''')
189
190    ret += mcgen('''
191}
192''')
193    return ret
194
195
196def gen_register_command(name, success_response):
197    options = 'QCO_NO_OPTIONS'
198    if not success_response:
199        options = 'QCO_NO_SUCCESS_RESP'
200
201    ret = mcgen('''
202    qmp_register_command(cmds, "%(name)s",
203                         qmp_marshal_%(c_name)s, %(opts)s);
204''',
205                name=name, c_name=c_name(name),
206                opts=options)
207    return ret
208
209
210def gen_registry(registry, prefix):
211    ret = mcgen('''
212
213void %(c_prefix)sqmp_init_marshal(QmpCommandList *cmds)
214{
215    QTAILQ_INIT(cmds);
216
217''',
218                c_prefix=c_name(prefix, protect=False))
219    ret += registry
220    ret += mcgen('''
221}
222''')
223    return ret
224
225
226class QAPISchemaGenCommandVisitor(QAPISchemaVisitor):
227    def __init__(self, prefix):
228        self._prefix = prefix
229        self.decl = None
230        self.defn = None
231        self._regy = None
232        self._visited_ret_types = None
233
234    def visit_begin(self, schema):
235        self.decl = ''
236        self.defn = ''
237        self._regy = ''
238        self._visited_ret_types = set()
239
240    def visit_end(self):
241        self.defn += gen_registry(self._regy, self._prefix)
242        self._regy = None
243        self._visited_ret_types = None
244
245    def visit_command(self, name, info, arg_type, ret_type,
246                      gen, success_response, boxed):
247        if not gen:
248            return
249        self.decl += gen_command_decl(name, arg_type, boxed, ret_type)
250        if ret_type and ret_type not in self._visited_ret_types:
251            self._visited_ret_types.add(ret_type)
252            self.defn += gen_marshal_output(ret_type)
253        self.decl += gen_marshal_decl(name)
254        self.defn += gen_marshal(name, arg_type, boxed, ret_type)
255        self._regy += gen_register_command(name, success_response)
256
257
258def gen_commands(schema, output_dir, prefix):
259    blurb = ' * Schema-defined QAPI/QMP commands'
260    genc = QAPIGenC(blurb, __doc__)
261    genh = QAPIGenH(blurb, __doc__)
262
263    genc.add(mcgen('''
264#include "qemu/osdep.h"
265#include "qemu-common.h"
266#include "qemu/module.h"
267#include "qapi/visitor.h"
268#include "qapi/qmp/qdict.h"
269#include "qapi/qobject-output-visitor.h"
270#include "qapi/qobject-input-visitor.h"
271#include "qapi/dealloc-visitor.h"
272#include "qapi/error.h"
273#include "%(prefix)sqapi-types.h"
274#include "%(prefix)sqapi-visit.h"
275#include "%(prefix)sqmp-commands.h"
276
277''',
278                   prefix=prefix))
279
280    genh.add(mcgen('''
281#include "%(prefix)sqapi-types.h"
282#include "qapi/qmp/dispatch.h"
283
284void %(c_prefix)sqmp_init_marshal(QmpCommandList *cmds);
285''',
286                   prefix=prefix, c_prefix=c_name(prefix, protect=False)))
287
288    vis = QAPISchemaGenCommandVisitor(prefix)
289    schema.visit(vis)
290    genc.add(vis.defn)
291    genh.add(vis.decl)
292    genc.write(output_dir, prefix + 'qmp-marshal.c')
293    genh.write(output_dir, prefix + 'qmp-commands.h')
294