# QAPI command marshaller generator
#
# Copyright IBM, Corp. 2011
-# Copyright (C) 2014-2015 Red Hat, Inc.
+# Copyright (C) 2014-2016 Red Hat, Inc.
#
# Authors:
# This work is licensed under the terms of the GNU GPL, version 2.
# See the COPYING file in the top-level directory.
-from ordereddict import OrderedDict
from qapi import *
-import re
-
-def generate_command_decl(name, args, ret_type):
- arglist=""
- for argname, argtype, optional in parse_args(args):
- argtype = c_type(argtype, is_param=True)
- if optional:
- arglist += "bool has_%s, " % c_name(argname)
- arglist += "%s %s, " % (argtype, c_name(argname))
- return mcgen('''
-%(ret_type)s qmp_%(name)s(%(args)sError **errp);
-''',
- ret_type=c_type(ret_type), name=c_name(name),
- args=arglist)
-def gen_err_check(err):
- if not err:
- return ''
+
+def gen_command_decl(name, arg_type, boxed, ret_type):
return mcgen('''
-if (%(err)s) {
- goto out;
-}
+%(c_type)s qmp_%(c_name)s(%(params)s);
''',
- err=err)
-
-def gen_sync_call(name, args, ret_type):
- ret = ""
- arglist=""
- retval=""
+ c_type=(ret_type and ret_type.c_type()) or 'void',
+ c_name=c_name(name),
+ params=gen_params(arg_type, boxed, 'Error **errp'))
+
+
+def gen_call(name, arg_type, boxed, ret_type):
+ ret = ''
+
+ argstr = ''
+ if boxed:
+ assert arg_type and not arg_type.is_empty()
+ argstr = '&arg, '
+ elif arg_type:
+ assert not arg_type.variants
+ for memb in arg_type.members:
+ if memb.optional:
+ argstr += 'arg.has_%s, ' % c_name(memb.name)
+ argstr += 'arg.%s, ' % c_name(memb.name)
+
+ lhs = ''
if ret_type:
- retval = "retval = "
- for argname, argtype, optional in parse_args(args):
- if optional:
- arglist += "has_%s, " % c_name(argname)
- arglist += "%s, " % (c_name(argname))
- push_indent()
+ lhs = 'retval = '
+
ret = mcgen('''
-%(retval)sqmp_%(name)s(%(args)s&local_err);
+
+ %(lhs)sqmp_%(c_name)s(%(args)s&err);
''',
- name=c_name(name), args=arglist, retval=retval)
+ c_name=c_name(name), args=argstr, lhs=lhs)
if ret_type:
- ret += gen_err_check('local_err')
ret += mcgen('''
+ if (err) {
+ goto out;
+ }
-qmp_marshal_output_%(c_name)s(retval, ret, &local_err);
+ qmp_marshal_output_%(c_name)s(retval, ret, &err);
''',
- c_name=c_name(name))
- pop_indent()
+ c_name=ret_type.c_name())
return ret
-def gen_visitor_input_containers_decl(args):
- ret = ""
- push_indent()
- if len(args) > 0:
- ret += mcgen('''
-QmpInputVisitor *mi = qmp_input_visitor_new_strict(QOBJECT(args));
-QapiDeallocVisitor *md;
-Visitor *v;
-''')
- pop_indent()
+def gen_marshal_output(ret_type):
+ return mcgen('''
- return ret
+static void qmp_marshal_output_%(c_name)s(%(c_type)s ret_in, QObject **ret_out, Error **errp)
+{
+ Error *err = NULL;
+ Visitor *v;
-def gen_visitor_input_vars_decl(args):
- ret = ""
- push_indent()
- for argname, argtype, optional in parse_args(args):
- if optional:
- ret += mcgen('''
-bool has_%(argname)s = false;
-''',
- argname=c_name(argname))
- if is_c_ptr(argtype):
- ret += mcgen('''
-%(argtype)s %(argname)s = NULL;
-''',
- argname=c_name(argname), argtype=c_type(argtype))
- else:
- ret += mcgen('''
-%(argtype)s %(argname)s = {0};
+ v = qobject_output_visitor_new(ret_out);
+ visit_type_%(c_name)s(v, "unused", &ret_in, &err);
+ if (!err) {
+ visit_complete(v, ret_out);
+ }
+ error_propagate(errp, err);
+ visit_free(v);
+ v = qapi_dealloc_visitor_new();
+ visit_type_%(c_name)s(v, "unused", &ret_in, NULL);
+ visit_free(v);
+}
''',
- argname=c_name(argname), argtype=c_type(argtype))
+ c_type=ret_type.c_type(), c_name=ret_type.c_name())
- pop_indent()
- return ret
-
-def gen_visitor_input_block(args, dealloc=False):
- ret = ""
- errparg = '&local_err'
- errarg = 'local_err'
- if len(args) == 0:
- return ret
+def gen_marshal_proto(name):
+ return ('void qmp_marshal_%s(QDict *args, QObject **ret, Error **errp)'
+ % c_name(name))
- push_indent()
- if dealloc:
- errparg = 'NULL'
- errarg = None;
- ret += mcgen('''
-qmp_input_visitor_cleanup(mi);
-md = qapi_dealloc_visitor_new();
-v = qapi_dealloc_get_visitor(md);
-''')
- else:
- ret += mcgen('''
-v = qmp_input_get_visitor(mi);
-''')
-
- for argname, argtype, optional in parse_args(args):
- if optional:
- ret += mcgen('''
-visit_optional(v, &has_%(c_name)s, "%(name)s", %(errp)s);
-''',
- c_name=c_name(argname), name=argname, errp=errparg)
- ret += gen_err_check(errarg)
- ret += mcgen('''
-if (has_%(c_name)s) {
-''',
- c_name=c_name(argname))
- push_indent()
- ret += mcgen('''
-visit_type_%(visitor)s(v, &%(c_name)s, "%(name)s", %(errp)s);
+def gen_marshal_decl(name):
+ return mcgen('''
+%(proto)s;
''',
- c_name=c_name(argname), name=argname, argtype=argtype,
- visitor=type_name(argtype), errp=errparg)
- ret += gen_err_check(errarg)
- if optional:
- pop_indent()
- ret += mcgen('''
-}
-''')
+ proto=gen_marshal_proto(name))
- if dealloc:
- ret += mcgen('''
-qapi_dealloc_visitor_cleanup(md);
-''')
- pop_indent()
- return ret
-def gen_marshal_output(name, ret_type):
- if not ret_type:
- return ""
+def gen_marshal(name, arg_type, boxed, ret_type):
+ have_args = arg_type and not arg_type.is_empty()
ret = mcgen('''
-static void qmp_marshal_output_%(c_name)s(%(c_ret_type)s ret_in, QObject **ret_out, Error **errp)
-{
- Error *local_err = NULL;
- QmpOutputVisitor *mo = qmp_output_visitor_new();
- QapiDeallocVisitor *md;
- Visitor *v;
-
- v = qmp_output_get_visitor(mo);
- visit_type_%(visitor)s(v, &ret_in, "unused", &local_err);
- if (local_err) {
- goto out;
- }
- *ret_out = qmp_output_get_qobject(mo);
-
-out:
- error_propagate(errp, local_err);
- qmp_output_visitor_cleanup(mo);
- md = qapi_dealloc_visitor_new();
- v = qapi_dealloc_get_visitor(md);
- visit_type_%(visitor)s(v, &ret_in, "unused", NULL);
- qapi_dealloc_visitor_cleanup(md);
-}
-''',
- c_ret_type=c_type(ret_type), c_name=c_name(name),
- visitor=type_name(ret_type))
-
- return ret
-
-def gen_marshal_input_decl(name, middle_mode):
- ret = 'void qmp_marshal_input_%s(QDict *args, QObject **ret, Error **errp)' % c_name(name)
- if not middle_mode:
- ret = "static " + ret
- return ret
-def gen_marshal_input(name, args, ret_type, middle_mode):
- hdr = gen_marshal_input_decl(name, middle_mode)
-
- ret = mcgen('''
-%(header)s
+%(proto)s
{
- Error *local_err = NULL;
+ Error *err = NULL;
''',
- header=hdr)
+ proto=gen_marshal_proto(name))
if ret_type:
ret += mcgen('''
%(c_type)s retval;
''',
- c_type=c_type(ret_type))
+ c_type=ret_type.c_type())
- if len(args) > 0:
- ret += gen_visitor_input_containers_decl(args)
- ret += gen_visitor_input_vars_decl(args) + '\n'
- ret += gen_visitor_input_block(args) + '\n'
+ if have_args:
+ visit_members = ('visit_type_%s_members(v, &arg, &err);'
+ % arg_type.c_name())
+ ret += mcgen('''
+ Visitor *v;
+ %(c_name)s arg = {0};
+
+''',
+ c_name=arg_type.c_name())
else:
+ visit_members = ''
ret += mcgen('''
+ Visitor *v = NULL;
- (void)args;
+ if (args) {
''')
+ push_indent()
- ret += gen_sync_call(name, args, ret_type)
+ ret += mcgen('''
+ v = qobject_input_visitor_new(QOBJECT(args));
+ visit_start_struct(v, NULL, NULL, 0, &err);
+ if (err) {
+ goto out;
+ }
+ %(visit_members)s
+ if (!err) {
+ visit_check_struct(v, &err);
+ }
+ visit_end_struct(v, NULL);
+ if (err) {
+ goto out;
+ }
+''',
+ visit_members=visit_members)
- if re.search('^ *goto out\\;', ret, re.MULTILINE):
+ if not have_args:
+ pop_indent()
ret += mcgen('''
+ }
+''')
+
+ ret += gen_call(name, arg_type, boxed, ret_type)
+
+ ret += mcgen('''
out:
+ error_propagate(errp, err);
+ visit_free(v);
+''')
+
+ if have_args:
+ visit_members = ('visit_type_%s_members(v, &arg, NULL);'
+ % arg_type.c_name())
+ else:
+ visit_members = ''
+ ret += mcgen('''
+ if (args) {
''')
+ push_indent()
+
ret += mcgen('''
- error_propagate(errp, local_err);
+ v = qapi_dealloc_visitor_new();
+ visit_start_struct(v, NULL, NULL, 0, NULL);
+ %(visit_members)s
+ visit_end_struct(v, NULL);
+ visit_free(v);
+''',
+ visit_members=visit_members)
+
+ if not have_args:
+ pop_indent()
+ ret += mcgen('''
+ }
''')
- ret += gen_visitor_input_block(args, dealloc=True)
+
ret += mcgen('''
}
''')
return ret
-def gen_registry(commands):
- registry=""
- push_indent()
- for cmd in commands:
- options = 'QCO_NO_OPTIONS'
- if not cmd.get('success-response', True):
- options = 'QCO_NO_SUCCESS_RESP'
- registry += mcgen('''
-qmp_register_command("%(name)s", qmp_marshal_input_%(c_name)s, %(opts)s);
+def gen_register_command(name, success_response):
+ options = 'QCO_NO_OPTIONS'
+ if not success_response:
+ options = 'QCO_NO_SUCCESS_RESP'
+
+ ret = mcgen('''
+ qmp_register_command(cmds, "%(name)s",
+ qmp_marshal_%(c_name)s, %(opts)s);
''',
- name=cmd['command'], c_name=c_name(cmd['command']),
- opts=options)
- pop_indent()
+ name=name, c_name=c_name(name),
+ opts=options)
+ return ret
+
+
+def gen_registry(registry):
ret = mcgen('''
-static void qmp_init_marshal(void)
+
+void %(c_prefix)sqmp_init_marshal(QmpCommandList *cmds)
{
-''')
+ QTAILQ_INIT(cmds);
+
+''',
+ c_prefix=c_name(prefix, protect=False))
ret += registry
ret += mcgen('''
}
-
-qapi_init(qmp_init_marshal);
''')
return ret
-middle_mode = False
-(input_file, output_dir, do_c, do_h, prefix, opts) = \
- parse_command_line("m", ["middle"])
+class QAPISchemaGenCommandVisitor(QAPISchemaVisitor):
+ def __init__(self):
+ self.decl = None
+ self.defn = None
+ self._regy = None
+ self._visited_ret_types = None
+
+ def visit_begin(self, schema):
+ self.decl = ''
+ self.defn = ''
+ self._regy = ''
+ self._visited_ret_types = set()
+
+ def visit_end(self):
+ self.defn += gen_registry(self._regy)
+ self._regy = None
+ self._visited_ret_types = None
-for o, a in opts:
- if o in ("-m", "--middle"):
- middle_mode = True
+ def visit_command(self, name, info, arg_type, ret_type,
+ gen, success_response, boxed):
+ if not gen:
+ return
+ self.decl += gen_command_decl(name, arg_type, boxed, ret_type)
+ if ret_type and ret_type not in self._visited_ret_types:
+ self._visited_ret_types.add(ret_type)
+ self.defn += gen_marshal_output(ret_type)
+ self.decl += gen_marshal_decl(name)
+ self.defn += gen_marshal(name, arg_type, boxed, ret_type)
+ self._regy += gen_register_command(name, success_response)
-exprs = parse_schema(input_file)
-commands = filter(lambda expr: expr.has_key('command'), exprs)
-commands = filter(lambda expr: not expr.has_key('gen'), commands)
+
+(input_file, output_dir, do_c, do_h, prefix, opts) = parse_command_line()
c_comment = '''
/*
c_comment, h_comment)
fdef.write(mcgen('''
+#include "qemu/osdep.h"
#include "qemu-common.h"
#include "qemu/module.h"
#include "qapi/qmp/types.h"
-#include "qapi/qmp/dispatch.h"
#include "qapi/visitor.h"
-#include "qapi/qmp-output-visitor.h"
-#include "qapi/qmp-input-visitor.h"
+#include "qapi/qobject-output-visitor.h"
+#include "qapi/qobject-input-visitor.h"
#include "qapi/dealloc-visitor.h"
#include "%(prefix)sqapi-types.h"
#include "%(prefix)sqapi-visit.h"
#include "%(prefix)sqmp-commands.h"
''',
- prefix=prefix))
+ prefix=prefix))
fdecl.write(mcgen('''
#include "%(prefix)sqapi-types.h"
#include "qapi/qmp/qdict.h"
+#include "qapi/qmp/dispatch.h"
#include "qapi/error.h"
+void %(c_prefix)sqmp_init_marshal(QmpCommandList *cmds);
''',
- prefix=prefix))
-
-for cmd in commands:
- arglist = []
- ret_type = None
- if cmd.has_key('data'):
- arglist = cmd['data']
- if cmd.has_key('returns'):
- ret_type = cmd['returns']
- ret = generate_command_decl(cmd['command'], arglist, ret_type)
- fdecl.write(ret)
- if ret_type:
- ret = gen_marshal_output(cmd['command'], ret_type) + "\n"
- fdef.write(ret)
-
- if middle_mode:
- fdecl.write('%s;\n' % gen_marshal_input_decl(cmd['command'], middle_mode))
-
- ret = gen_marshal_input(cmd['command'], arglist, ret_type, middle_mode) + "\n"
- fdef.write(ret)
+ prefix=prefix, c_prefix=c_name(prefix, protect=False)))
-if not middle_mode:
- ret = gen_registry(commands)
- fdef.write(ret)
+schema = QAPISchema(input_file)
+gen = QAPISchemaGenCommandVisitor()
+schema.visit(gen)
+fdef.write(gen.defn)
+fdecl.write(gen.decl)
close_output(fdef, fdecl)
projects / qemu.git / blobdiff