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