xref: /qemu/scripts/qapi/visit.py (revision b9c4b48d50057b6aee7c70879b240ff76f39c85b) 
1#
2# QAPI visitor generator
3#
4# Copyright IBM, Corp. 2011
5#
6# Authors:
7#  Anthony Liguori <aliguori@us.ibm.com>
8#  Michael Roth    <mdroth@linux.vnet.ibm.com>
9#
10# This work is licensed under the terms of the GNU GPLv2.
11# See the COPYING.LIB file in the top-level directory.
12
13from ordereddict import OrderedDict
14from qapi import *
15import sys
16import os
17import getopt
18import errno
19
20def generate_visit_struct_body(field_prefix, name, members):
21    ret = mcgen('''
22if (!error_is_set(errp)) {
23''')
24    push_indent()
25
26    if len(field_prefix):
27        field_prefix = field_prefix + "."
28        ret += mcgen('''
29Error **errp = &err; /* from outer scope */
30Error *err = NULL;
31visit_start_struct(m, NULL, "", "%(name)s", 0, &err);
32''',
33                name=name)
34    else:
35        ret += mcgen('''
36Error *err = NULL;
37visit_start_struct(m, (void **)obj, "%(name)s", name, sizeof(%(name)s), &err);
38''',
39                name=name)
40
41    ret += mcgen('''
42if (!err) {
43    if (!obj || *obj) {
44''')
45
46    push_indent()
47    push_indent()
48    for argname, argentry, optional, structured in parse_args(members):
49        if optional:
50            ret += mcgen('''
51visit_start_optional(m, obj ? &(*obj)->%(c_prefix)shas_%(c_name)s : NULL, "%(name)s", &err);
52if (obj && (*obj)->%(prefix)shas_%(c_name)s) {
53''',
54                         c_prefix=c_var(field_prefix), prefix=field_prefix,
55                         c_name=c_var(argname), name=argname)
56            push_indent()
57
58        if structured:
59            ret += generate_visit_struct_body(field_prefix + argname, argname, argentry)
60        else:
61            ret += mcgen('''
62visit_type_%(type)s(m, obj ? &(*obj)->%(c_prefix)s%(c_name)s : NULL, "%(name)s", &err);
63''',
64                         c_prefix=c_var(field_prefix), prefix=field_prefix,
65                         type=type_name(argentry), c_name=c_var(argname),
66                         name=argname)
67
68        if optional:
69            pop_indent()
70            ret += mcgen('''
71}
72visit_end_optional(m, &err);
73''')
74
75    pop_indent()
76    ret += mcgen('''
77
78    error_propagate(errp, err);
79    err = NULL;
80}
81''')
82
83    pop_indent()
84    pop_indent()
85    ret += mcgen('''
86        /* Always call end_struct if start_struct succeeded.  */
87        visit_end_struct(m, &err);
88    }
89    error_propagate(errp, err);
90}
91''')
92    return ret
93
94def generate_visit_struct(name, members):
95    ret = mcgen('''
96
97void visit_type_%(name)s(Visitor *m, %(name)s ** obj, const char *name, Error **errp)
98{
99''',
100                name=name)
101
102    push_indent()
103    ret += generate_visit_struct_body("", name, members)
104    pop_indent()
105
106    ret += mcgen('''
107}
108''')
109    return ret
110
111def generate_visit_list(name, members):
112    return mcgen('''
113
114void visit_type_%(name)sList(Visitor *m, %(name)sList ** obj, const char *name, Error **errp)
115{
116    GenericList *i, **prev = (GenericList **)obj;
117    Error *err = NULL;
118
119    if (!error_is_set(errp)) {
120        visit_start_list(m, name, &err);
121        if (!err) {
122            for (; (i = visit_next_list(m, prev, &err)) != NULL; prev = &i) {
123                %(name)sList *native_i = (%(name)sList *)i;
124                visit_type_%(name)s(m, &native_i->value, NULL, &err);
125            }
126            error_propagate(errp, err);
127            err = NULL;
128
129            /* Always call end_list if start_list succeeded.  */
130            visit_end_list(m, &err);
131        }
132        error_propagate(errp, err);
133    }
134}
135''',
136                name=name)
137
138def generate_visit_enum(name, members):
139    return mcgen('''
140
141void visit_type_%(name)s(Visitor *m, %(name)s * obj, const char *name, Error **errp)
142{
143    visit_type_enum(m, (int *)obj, %(name)s_lookup, "%(name)s", name, errp);
144}
145''',
146                 name=name)
147
148def generate_visit_union(name, members):
149    ret = generate_visit_enum('%sKind' % name, members.keys())
150
151    ret += mcgen('''
152
153void visit_type_%(name)s(Visitor *m, %(name)s ** obj, const char *name, Error **errp)
154{
155    Error *err = NULL;
156
157    if (!error_is_set(errp)) {
158        visit_start_struct(m, (void **)obj, "%(name)s", name, sizeof(%(name)s), &err);
159        if (!err) {
160            if (!obj || *obj) {
161                visit_type_%(name)sKind(m, &(*obj)->kind, "type", &err);
162                if (!err) {
163                    switch ((*obj)->kind) {
164''',
165                 name=name)
166
167    push_indent()
168    push_indent()
169    for key in members:
170        ret += mcgen('''
171            case %(abbrev)s_KIND_%(enum)s:
172                visit_type_%(c_type)s(m, &(*obj)->%(c_name)s, "data", &err);
173                break;
174''',
175                abbrev = de_camel_case(name).upper(),
176                enum = c_fun(de_camel_case(key)).upper(),
177                c_type=members[key],
178                c_name=c_fun(key))
179
180    ret += mcgen('''
181            default:
182                abort();
183            }
184        }
185        error_propagate(errp, err);
186        err = NULL;
187    }
188''')
189    pop_indent()
190    ret += mcgen('''
191        /* Always call end_struct if start_struct succeeded.  */
192        visit_end_struct(m, &err);
193    }
194    error_propagate(errp, err);
195}
196''')
197
198    pop_indent();
199    ret += mcgen('''
200}
201''')
202
203    return ret
204
205def generate_declaration(name, members, genlist=True):
206    ret = mcgen('''
207
208void visit_type_%(name)s(Visitor *m, %(name)s ** obj, const char *name, Error **errp);
209''',
210                name=name)
211
212    if genlist:
213        ret += mcgen('''
214void visit_type_%(name)sList(Visitor *m, %(name)sList ** obj, const char *name, Error **errp);
215''',
216                 name=name)
217
218    return ret
219
220def generate_enum_declaration(name, members, genlist=True):
221    ret = ""
222    if genlist:
223        ret += mcgen('''
224void visit_type_%(name)sList(Visitor *m, %(name)sList ** obj, const char *name, Error **errp);
225''',
226                     name=name)
227
228    return ret
229
230def generate_decl_enum(name, members, genlist=True):
231    return mcgen('''
232
233void visit_type_%(name)s(Visitor *m, %(name)s * obj, const char *name, Error **errp);
234''',
235                name=name)
236
237try:
238    opts, args = getopt.gnu_getopt(sys.argv[1:], "chp:o:",
239                                   ["source", "header", "prefix=", "output-dir="])
240except getopt.GetoptError, err:
241    print str(err)
242    sys.exit(1)
243
244output_dir = ""
245prefix = ""
246c_file = 'qapi-visit.c'
247h_file = 'qapi-visit.h'
248
249do_c = False
250do_h = False
251
252for o, a in opts:
253    if o in ("-p", "--prefix"):
254        prefix = a
255    elif o in ("-o", "--output-dir"):
256        output_dir = a + "/"
257    elif o in ("-c", "--source"):
258        do_c = True
259    elif o in ("-h", "--header"):
260        do_h = True
261
262if not do_c and not do_h:
263    do_c = True
264    do_h = True
265
266c_file = output_dir + prefix + c_file
267h_file = output_dir + prefix + h_file
268
269try:
270    os.makedirs(output_dir)
271except os.error, e:
272    if e.errno != errno.EEXIST:
273        raise
274
275def maybe_open(really, name, opt):
276    if really:
277        return open(name, opt)
278    else:
279        import StringIO
280        return StringIO.StringIO()
281
282fdef = maybe_open(do_c, c_file, 'w')
283fdecl = maybe_open(do_h, h_file, 'w')
284
285fdef.write(mcgen('''
286/* THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY */
287
288/*
289 * schema-defined QAPI visitor functions
290 *
291 * Copyright IBM, Corp. 2011
292 *
293 * Authors:
294 *  Anthony Liguori   <aliguori@us.ibm.com>
295 *
296 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
297 * See the COPYING.LIB file in the top-level directory.
298 *
299 */
300
301#include "%(header)s"
302''',
303                 header=basename(h_file)))
304
305fdecl.write(mcgen('''
306/* THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY */
307
308/*
309 * schema-defined QAPI visitor function
310 *
311 * Copyright IBM, Corp. 2011
312 *
313 * Authors:
314 *  Anthony Liguori   <aliguori@us.ibm.com>
315 *
316 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
317 * See the COPYING.LIB file in the top-level directory.
318 *
319 */
320
321#ifndef %(guard)s
322#define %(guard)s
323
324#include "qapi/qapi-visit-core.h"
325#include "%(prefix)sqapi-types.h"
326''',
327                  prefix=prefix, guard=guardname(h_file)))
328
329exprs = parse_schema(sys.stdin)
330
331for expr in exprs:
332    if expr.has_key('type'):
333        ret = generate_visit_struct(expr['type'], expr['data'])
334        ret += generate_visit_list(expr['type'], expr['data'])
335        fdef.write(ret)
336
337        ret = generate_declaration(expr['type'], expr['data'])
338        fdecl.write(ret)
339    elif expr.has_key('union'):
340        ret = generate_visit_union(expr['union'], expr['data'])
341        ret += generate_visit_list(expr['union'], expr['data'])
342        fdef.write(ret)
343
344        ret = generate_decl_enum('%sKind' % expr['union'], expr['data'].keys())
345        ret += generate_declaration(expr['union'], expr['data'])
346        fdecl.write(ret)
347    elif expr.has_key('enum'):
348        ret = generate_visit_list(expr['enum'], expr['data'])
349        ret += generate_visit_enum(expr['enum'], expr['data'])
350        fdef.write(ret)
351
352        ret = generate_decl_enum(expr['enum'], expr['data'])
353        ret += generate_enum_declaration(expr['enum'], expr['data'])
354        fdecl.write(ret)
355
356fdecl.write('''
357#endif
358''')
359
360fdecl.flush()
361fdecl.close()
362
363fdef.flush()
364fdef.close()
365