scripts/qapi-commands.py

   1 #
   2 # QAPI command marshaller generator
   3 #
   4 # Copyright IBM, Corp. 2011
   5 # Copyright (C) 2014-2015 Red Hat, Inc.
   6 #
   7 # Authors:
   8 #  Anthony Liguori <aliguori@us.ibm.com>
   9 #  Michael Roth    <mdroth@linux.vnet.ibm.com>
  10 #  Markus Armbruster <armbru@redhat.com>
  11 #
  12 # This work is licensed under the terms of the GNU GPL, version 2.
  13 # See the COPYING file in the top-level directory.
  14
  15 from qapi import *
  16 import re
  17
  18
  19 def gen_command_decl(name, arg_type, 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=gen_params(arg_type, 'Error **errp'))
  26
  27
  28 def gen_call(name, arg_type, ret_type):
  29     ret = ''
  30
  31     argstr = ''
  32     if arg_type:
  33         for memb in arg_type.members:
  34             if memb.optional:
  35                 argstr += 'has_%s, ' % c_name(memb.name)
  36             argstr += '%s, ' % c_name(memb.name)
  37
  38     lhs = ''
  39     if ret_type:
  40         lhs = 'retval = '
  41
  42     ret = mcgen('''
  43
  44     %(lhs)sqmp_%(c_name)s(%(args)s&err);
  45 ''',
  46                 c_name=c_name(name), args=argstr, lhs=lhs)
  47     if ret_type:
  48         ret += gen_err_check()
  49         ret += mcgen('''
  50
  51     qmp_marshal_output_%(c_name)s(retval, ret, &err);
  52 ''',
  53                      c_name=ret_type.c_name())
  54     return ret
  55
  56
  57 def gen_marshal_vars(arg_type, ret_type):
  58     ret = mcgen('''
  59     Error *err = NULL;
  60 ''')
  61
  62     if ret_type:
  63         ret += mcgen('''
  64     %(c_type)s retval;
  65 ''',
  66                      c_type=ret_type.c_type())
  67
  68     if arg_type:
  69         ret += mcgen('''
  70     QmpInputVisitor *qiv = qmp_input_visitor_new_strict(QOBJECT(args));
  71     QapiDeallocVisitor *qdv;
  72     Visitor *v;
  73 ''')
  74
  75         for memb in arg_type.members:
  76             if memb.optional:
  77                 ret += mcgen('''
  78     bool has_%(c_name)s = false;
  79 ''',
  80                              c_name=c_name(memb.name))
  81             ret += mcgen('''
  82     %(c_type)s %(c_name)s = %(c_null)s;
  83 ''',
  84                          c_name=c_name(memb.name),
  85                          c_type=memb.type.c_type(),
  86                          c_null=memb.type.c_null())
  87         ret += '\n'
  88     else:
  89         ret += mcgen('''
  90
  91     (void)args;
  92 ''')
  93
  94     return ret
  95
  96
  97 def gen_marshal_input_visit(arg_type, dealloc=False):
  98     ret = ''
  99
 100     if not arg_type:
 101         return ret
 102
 103     if dealloc:
 104         ret += mcgen('''
 105     qmp_input_visitor_cleanup(qiv);
 106     qdv = qapi_dealloc_visitor_new();
 107     v = qapi_dealloc_get_visitor(qdv);
 108 ''')
 109     else:
 110         ret += mcgen('''
 111     v = qmp_input_get_visitor(qiv);
 112 ''')
 113
 114     ret += gen_visit_fields(arg_type.members, skiperr=dealloc)
 115
 116     if dealloc:
 117         ret += mcgen('''
 118     qapi_dealloc_visitor_cleanup(qdv);
 119 ''')
 120     return ret
 121
 122
 123 def gen_marshal_output(ret_type):
 124     return mcgen('''
 125
 126 static void qmp_marshal_output_%(c_name)s(%(c_type)s ret_in, QObject **ret_out, Error **errp)
 127 {
 128     Error *err = NULL;
 129     QmpOutputVisitor *qov = qmp_output_visitor_new();
 130     QapiDeallocVisitor *qdv;
 131     Visitor *v;
 132
 133     v = qmp_output_get_visitor(qov);
 134     visit_type_%(c_name)s(v, &ret_in, "unused", &err);
 135     if (err) {
 136         goto out;
 137     }
 138     *ret_out = qmp_output_get_qobject(qov);
 139
 140 out:
 141     error_propagate(errp, err);
 142     qmp_output_visitor_cleanup(qov);
 143     qdv = qapi_dealloc_visitor_new();
 144     v = qapi_dealloc_get_visitor(qdv);
 145     visit_type_%(c_name)s(v, &ret_in, "unused", NULL);
 146     qapi_dealloc_visitor_cleanup(qdv);
 147 }
 148 ''',
 149                  c_type=ret_type.c_type(), c_name=ret_type.c_name())
 150
 151
 152 def gen_marshal_proto(name):
 153     ret = 'void qmp_marshal_%s(QDict *args, QObject **ret, Error **errp)' % c_name(name)
 154     if not middle_mode:
 155         ret = 'static ' + ret
 156     return ret
 157
 158
 159 def gen_marshal_decl(name):
 160     return mcgen('''
 161 %(proto)s;
 162 ''',
 163                  proto=gen_marshal_proto(name))
 164
 165
 166 def gen_marshal(name, arg_type, ret_type):
 167     ret = mcgen('''
 168
 169 %(proto)s
 170 {
 171 ''',
 172                 proto=gen_marshal_proto(name))
 173
 174     ret += gen_marshal_vars(arg_type, ret_type)
 175     ret += gen_marshal_input_visit(arg_type)
 176     ret += gen_call(name, arg_type, ret_type)
 177
 178     if re.search('^ *goto out;', ret, re.MULTILINE):
 179         ret += mcgen('''
 180
 181 out:
 182 ''')
 183     ret += mcgen('''
 184     error_propagate(errp, err);
 185 ''')
 186     ret += gen_marshal_input_visit(arg_type, dealloc=True)
 187     ret += mcgen('''
 188 }
 189 ''')
 190     return ret
 191
 192
 193 def gen_register_command(name, success_response):
 194     options = 'QCO_NO_OPTIONS'
 195     if not success_response:
 196         options = 'QCO_NO_SUCCESS_RESP'
 197
 198     ret = mcgen('''
 199     qmp_register_command("%(name)s", qmp_marshal_%(c_name)s, %(opts)s);
 200 ''',
 201                 name=name, c_name=c_name(name),
 202                 opts=options)
 203     return ret
 204
 205
 206 def gen_registry(registry):
 207     ret = mcgen('''
 208
 209 static void qmp_init_marshal(void)
 210 {
 211 ''')
 212     ret += registry
 213     ret += mcgen('''
 214 }
 215
 216 qapi_init(qmp_init_marshal);
 217 ''')
 218     return ret
 219
 220
 221 class QAPISchemaGenCommandVisitor(QAPISchemaVisitor):
 222     def __init__(self):
 223         self.decl = None
 224         self.defn = None
 225         self._regy = None
 226         self._visited_ret_types = None
 227
 228     def visit_begin(self, schema):
 229         self.decl = ''
 230         self.defn = ''
 231         self._regy = ''
 232         self._visited_ret_types = set()
 233
 234     def visit_end(self):
 235         if not middle_mode:
 236             self.defn += gen_registry(self._regy)
 237         self._regy = None
 238         self._visited_ret_types = None
 239
 240     def visit_command(self, name, info, arg_type, ret_type,
 241                       gen, success_response):
 242         if not gen:
 243             return
 244         self.decl += gen_command_decl(name, arg_type, ret_type)
 245         if ret_type and ret_type not in self._visited_ret_types:
 246             self._visited_ret_types.add(ret_type)
 247             self.defn += gen_marshal_output(ret_type)
 248         if middle_mode:
 249             self.decl += gen_marshal_decl(name)
 250         self.defn += gen_marshal(name, arg_type, ret_type)
 251         if not middle_mode:
 252             self._regy += gen_register_command(name, success_response)
 253
 254
 255 middle_mode = False
 256
 257 (input_file, output_dir, do_c, do_h, prefix, opts) = \
 258     parse_command_line("m", ["middle"])
 259
 260 for o, a in opts:
 261     if o in ("-m", "--middle"):
 262         middle_mode = True
 263
 264 c_comment = '''
 265 /*
 266  * schema-defined QMP->QAPI command dispatch
 267  *
 268  * Copyright IBM, Corp. 2011
 269  *
 270  * Authors:
 271  *  Anthony Liguori   <aliguori@us.ibm.com>
 272  *
 273  * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
 274  * See the COPYING.LIB file in the top-level directory.
 275  *
 276  */
 277 '''
 278 h_comment = '''
 279 /*
 280  * schema-defined QAPI function prototypes
 281  *
 282  * Copyright IBM, Corp. 2011
 283  *
 284  * Authors:
 285  *  Anthony Liguori   <aliguori@us.ibm.com>
 286  *
 287  * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
 288  * See the COPYING.LIB file in the top-level directory.
 289  *
 290  */
 291 '''
 292
 293 (fdef, fdecl) = open_output(output_dir, do_c, do_h, prefix,
 294                             'qmp-marshal.c', 'qmp-commands.h',
 295                             c_comment, h_comment)
 296
 297 fdef.write(mcgen('''
 298 #include "qemu-common.h"
 299 #include "qemu/module.h"
 300 #include "qapi/qmp/types.h"
 301 #include "qapi/qmp/dispatch.h"
 302 #include "qapi/visitor.h"
 303 #include "qapi/qmp-output-visitor.h"
 304 #include "qapi/qmp-input-visitor.h"
 305 #include "qapi/dealloc-visitor.h"
 306 #include "%(prefix)sqapi-types.h"
 307 #include "%(prefix)sqapi-visit.h"
 308 #include "%(prefix)sqmp-commands.h"
 309
 310 ''',
 311                  prefix=prefix))
 312
 313 fdecl.write(mcgen('''
 314 #include "%(prefix)sqapi-types.h"
 315 #include "qapi/qmp/qdict.h"
 316 #include "qapi/error.h"
 317
 318 ''',
 319                   prefix=prefix))
 320
 321 schema = QAPISchema(input_file)
 322 gen = QAPISchemaGenCommandVisitor()
 323 schema.visit(gen)
 324 fdef.write(gen.defn)
 325 fdecl.write(gen.decl)
 326
 327 close_output(fdef, fdecl)