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 def generate_command_decl(name, args, ret_type):
  19     arglist=""
  20     if args:
  21         for memb in args.members:
  22             argtype = memb.type.c_type(is_param=True)
  23             if memb.optional:
  24                 arglist += "bool has_%s, " % c_name(memb.name)
  25             arglist += "%s %s, " % (argtype, c_name(memb.name))
  26     return mcgen('''
  27 %(ret_type)s qmp_%(name)s(%(args)sError **errp);
  28 ''',
  29                  ret_type=(ret_type and ret_type.c_type()) or 'void',
  30                  name=c_name(name),
  31                  args=arglist)
  32
  33 def gen_err_check(err):
  34     if not err:
  35         return ''
  36     return mcgen('''
  37 if (%(err)s) {
  38     goto out;
  39 }
  40 ''',
  41                  err=err)
  42
  43 def gen_sync_call(name, args, ret_type):
  44     ret = ""
  45     arglist=""
  46     retval=""
  47     if ret_type:
  48         retval = "retval = "
  49     if args:
  50         for memb in args.members:
  51             if memb.optional:
  52                 arglist += "has_%s, " % c_name(memb.name)
  53             arglist += "%s, " % c_name(memb.name)
  54     push_indent()
  55     ret = mcgen('''
  56 %(retval)sqmp_%(name)s(%(args)s&local_err);
  57 ''',
  58                 name=c_name(name), args=arglist, retval=retval)
  59     if ret_type:
  60         ret += gen_err_check('local_err')
  61         ret += mcgen('''
  62
  63 qmp_marshal_output_%(c_name)s(retval, ret, &local_err);
  64 ''',
  65                             c_name=c_name(name))
  66     pop_indent()
  67     return ret
  68
  69 def gen_visitor_input_containers_decl(args):
  70     ret = ""
  71
  72     push_indent()
  73     if args:
  74         ret += mcgen('''
  75 QmpInputVisitor *mi = qmp_input_visitor_new_strict(QOBJECT(args));
  76 QapiDeallocVisitor *md;
  77 Visitor *v;
  78 ''')
  79     pop_indent()
  80
  81     return ret
  82
  83 def gen_visitor_input_vars_decl(args):
  84     ret = ""
  85     push_indent()
  86
  87     if args:
  88         for memb in args.members:
  89             if memb.optional:
  90                 ret += mcgen('''
  91 bool has_%(argname)s = false;
  92 ''',
  93                              argname=c_name(memb.name))
  94             if is_c_ptr(memb.type.c_type()):
  95                 ret += mcgen('''
  96 %(argtype)s %(argname)s = NULL;
  97 ''',
  98                              argname=c_name(memb.name),
  99                              argtype=memb.type.c_type())
 100             else:
 101                 ret += mcgen('''
 102 %(argtype)s %(argname)s = {0};
 103 ''',
 104                              argname=c_name(memb.name),
 105                              argtype=memb.type.c_type())
 106
 107     pop_indent()
 108     return ret
 109
 110 def gen_visitor_input_block(args, dealloc=False):
 111     ret = ""
 112     errparg = '&local_err'
 113     errarg = 'local_err'
 114
 115     if not args:
 116         return ret
 117
 118     push_indent()
 119
 120     if dealloc:
 121         errparg = 'NULL'
 122         errarg = None;
 123         ret += mcgen('''
 124 qmp_input_visitor_cleanup(mi);
 125 md = qapi_dealloc_visitor_new();
 126 v = qapi_dealloc_get_visitor(md);
 127 ''')
 128     else:
 129         ret += mcgen('''
 130 v = qmp_input_get_visitor(mi);
 131 ''')
 132
 133     for memb in args.members:
 134         if memb.optional:
 135             ret += mcgen('''
 136 visit_optional(v, &has_%(c_name)s, "%(name)s", %(errp)s);
 137 ''',
 138                          c_name=c_name(memb.name), name=memb.name,
 139                          errp=errparg)
 140             ret += gen_err_check(errarg)
 141             ret += mcgen('''
 142 if (has_%(c_name)s) {
 143 ''',
 144                          c_name=c_name(memb.name))
 145             push_indent()
 146         ret += mcgen('''
 147 visit_type_%(visitor)s(v, &%(c_name)s, "%(name)s", %(errp)s);
 148 ''',
 149                      c_name=c_name(memb.name), name=memb.name,
 150                      visitor=memb.type.c_name(), errp=errparg)
 151         ret += gen_err_check(errarg)
 152         if memb.optional:
 153             pop_indent()
 154             ret += mcgen('''
 155 }
 156 ''')
 157
 158     if dealloc:
 159         ret += mcgen('''
 160 qapi_dealloc_visitor_cleanup(md);
 161 ''')
 162     pop_indent()
 163     return ret
 164
 165 def gen_marshal_output(name, ret_type):
 166     if not ret_type:
 167         return ""
 168
 169     ret = mcgen('''
 170
 171 static void qmp_marshal_output_%(c_name)s(%(c_ret_type)s ret_in, QObject **ret_out, Error **errp)
 172 {
 173     Error *local_err = NULL;
 174     QmpOutputVisitor *mo = qmp_output_visitor_new();
 175     QapiDeallocVisitor *md;
 176     Visitor *v;
 177
 178     v = qmp_output_get_visitor(mo);
 179     visit_type_%(visitor)s(v, &ret_in, "unused", &local_err);
 180     if (local_err) {
 181         goto out;
 182     }
 183     *ret_out = qmp_output_get_qobject(mo);
 184
 185 out:
 186     error_propagate(errp, local_err);
 187     qmp_output_visitor_cleanup(mo);
 188     md = qapi_dealloc_visitor_new();
 189     v = qapi_dealloc_get_visitor(md);
 190     visit_type_%(visitor)s(v, &ret_in, "unused", NULL);
 191     qapi_dealloc_visitor_cleanup(md);
 192 }
 193 ''',
 194                 c_ret_type=ret_type.c_type(), c_name=c_name(name),
 195                 visitor=ret_type.c_name())
 196
 197     return ret
 198
 199 def gen_marshal_input_decl(name, middle_mode):
 200     ret = 'void qmp_marshal_input_%s(QDict *args, QObject **ret, Error **errp)' % c_name(name)
 201     if not middle_mode:
 202         ret = "static " + ret
 203     return ret
 204
 205 def gen_marshal_input(name, args, ret_type, middle_mode):
 206     hdr = gen_marshal_input_decl(name, middle_mode)
 207
 208     ret = mcgen('''
 209
 210 %(header)s
 211 {
 212     Error *local_err = NULL;
 213 ''',
 214                 header=hdr)
 215
 216     if ret_type:
 217         ret += mcgen('''
 218     %(c_type)s retval;
 219 ''',
 220                      c_type=ret_type.c_type())
 221
 222     if args:
 223         ret += gen_visitor_input_containers_decl(args)
 224         ret += gen_visitor_input_vars_decl(args) + '\n'
 225         ret += gen_visitor_input_block(args) + '\n'
 226     else:
 227         ret += mcgen('''
 228
 229     (void)args;
 230
 231 ''')
 232
 233     ret += gen_sync_call(name, args, ret_type)
 234
 235     if re.search('^ *goto out\\;', ret, re.MULTILINE):
 236         ret += mcgen('''
 237
 238 out:
 239 ''')
 240     ret += mcgen('''
 241     error_propagate(errp, local_err);
 242 ''')
 243     ret += gen_visitor_input_block(args, dealloc=True)
 244     ret += mcgen('''
 245 }
 246 ''')
 247     return ret
 248
 249 def gen_register_command(name, success_response):
 250     push_indent()
 251     options = 'QCO_NO_OPTIONS'
 252     if not success_response:
 253         options = 'QCO_NO_SUCCESS_RESP'
 254
 255     ret = mcgen('''
 256 qmp_register_command("%(name)s", qmp_marshal_input_%(c_name)s, %(opts)s);
 257 ''',
 258                      name=name, c_name=c_name(name),
 259                      opts=options)
 260     pop_indent()
 261     return ret
 262
 263 def gen_registry(registry):
 264     ret = mcgen('''
 265
 266 static void qmp_init_marshal(void)
 267 {
 268 ''')
 269     ret += registry
 270     ret += mcgen('''
 271 }
 272
 273 qapi_init(qmp_init_marshal);
 274 ''')
 275     return ret
 276
 277
 278 class QAPISchemaGenCommandVisitor(QAPISchemaVisitor):
 279     def __init__(self):
 280         self.decl = None
 281         self.defn = None
 282         self._regy = None
 283
 284     def visit_begin(self, schema):
 285         self.decl = ''
 286         self.defn = ''
 287         self._regy = ''
 288
 289     def visit_end(self):
 290         if not middle_mode:
 291             self.defn += gen_registry(self._regy)
 292         self._regy = None
 293
 294     def visit_command(self, name, info, arg_type, ret_type,
 295                       gen, success_response):
 296         if not gen:
 297             return
 298         self.decl += generate_command_decl(name, arg_type, ret_type)
 299         if ret_type:
 300             self.defn += gen_marshal_output(name, ret_type)
 301         if middle_mode:
 302             self.decl += gen_marshal_input_decl(name, middle_mode) + ';\n'
 303         self.defn += gen_marshal_input(name, arg_type, ret_type, middle_mode)
 304         if not middle_mode:
 305             self._regy += gen_register_command(name, success_response)
 306
 307
 308 middle_mode = False
 309
 310 (input_file, output_dir, do_c, do_h, prefix, opts) = \
 311     parse_command_line("m", ["middle"])
 312
 313 for o, a in opts:
 314     if o in ("-m", "--middle"):
 315         middle_mode = True
 316
 317 c_comment = '''
 318 /*
 319  * schema-defined QMP->QAPI command dispatch
 320  *
 321  * Copyright IBM, Corp. 2011
 322  *
 323  * Authors:
 324  *  Anthony Liguori   <aliguori@us.ibm.com>
 325  *
 326  * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
 327  * See the COPYING.LIB file in the top-level directory.
 328  *
 329  */
 330 '''
 331 h_comment = '''
 332 /*
 333  * schema-defined QAPI function prototypes
 334  *
 335  * Copyright IBM, Corp. 2011
 336  *
 337  * Authors:
 338  *  Anthony Liguori   <aliguori@us.ibm.com>
 339  *
 340  * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
 341  * See the COPYING.LIB file in the top-level directory.
 342  *
 343  */
 344 '''
 345
 346 (fdef, fdecl) = open_output(output_dir, do_c, do_h, prefix,
 347                             'qmp-marshal.c', 'qmp-commands.h',
 348                             c_comment, h_comment)
 349
 350 fdef.write(mcgen('''
 351 #include "qemu-common.h"
 352 #include "qemu/module.h"
 353 #include "qapi/qmp/types.h"
 354 #include "qapi/qmp/dispatch.h"
 355 #include "qapi/visitor.h"
 356 #include "qapi/qmp-output-visitor.h"
 357 #include "qapi/qmp-input-visitor.h"
 358 #include "qapi/dealloc-visitor.h"
 359 #include "%(prefix)sqapi-types.h"
 360 #include "%(prefix)sqapi-visit.h"
 361 #include "%(prefix)sqmp-commands.h"
 362
 363 ''',
 364                 prefix=prefix))
 365
 366 fdecl.write(mcgen('''
 367 #include "%(prefix)sqapi-types.h"
 368 #include "qapi/qmp/qdict.h"
 369 #include "qapi/error.h"
 370
 371 ''',
 372                   prefix=prefix))
 373
 374 schema = QAPISchema(input_file)
 375 gen = QAPISchemaGenCommandVisitor()
 376 schema.visit(gen)
 377 fdef.write(gen.defn)
 378 fdecl.write(gen.decl)
 379
 380 close_output(fdef, fdecl)