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 <[email protected]>
   9 #  Michael Roth    <[email protected]>
  10 #  Markus Armbruster <[email protected]>
  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 ordereddict import OrderedDict
  16 from qapi import *
  17 import re
  18 import os
  19 import errno
  20
  21 def generate_command_decl(name, args, ret_type):
  22     arglist=""
  23     for argname, argtype, optional in parse_args(args):
  24         argtype = c_type(argtype, is_param=True)
  25         if optional:
  26             arglist += "bool has_%s, " % c_name(argname)
  27         arglist += "%s %s, " % (argtype, c_name(argname))
  28     return mcgen('''
  29 %(ret_type)s qmp_%(name)s(%(args)sError **errp);
  30 ''',
  31                  ret_type=c_type(ret_type), name=c_name(name),
  32                  args=arglist).strip()
  33
  34 def gen_err_check(errvar):
  35     if errvar:
  36         return mcgen('''
  37 if (local_err) {
  38     goto out;
  39 }
  40 ''')
  41     return ''
  42
  43 def gen_sync_call(name, args, ret_type, indent=0):
  44     ret = ""
  45     arglist=""
  46     retval=""
  47     if ret_type:
  48         retval = "retval = "
  49     for argname, argtype, optional in parse_args(args):
  50         if optional:
  51             arglist += "has_%s, " % c_name(argname)
  52         arglist += "%s, " % (c_name(argname))
  53     push_indent(indent)
  54     ret = mcgen('''
  55 %(retval)sqmp_%(name)s(%(args)s&local_err);
  56
  57 ''',
  58                 name=c_name(name), args=arglist, retval=retval).rstrip()
  59     if ret_type:
  60         ret += "\n" + gen_err_check('local_err')
  61         ret += "\n" + mcgen(''''
  62 %(marshal_output_call)s
  63 ''',
  64                             marshal_output_call=gen_marshal_output_call(name, ret_type)).rstrip()
  65     pop_indent(indent)
  66     return ret.rstrip()
  67
  68
  69 def gen_marshal_output_call(name, ret_type):
  70     if not ret_type:
  71         return ""
  72     return "qmp_marshal_output_%s(retval, ret, &local_err);" % c_name(name)
  73
  74 def gen_visitor_input_containers_decl(args, obj):
  75     ret = ""
  76
  77     push_indent()
  78     if len(args) > 0:
  79         ret += mcgen('''
  80 QmpInputVisitor *mi = qmp_input_visitor_new_strict(%(obj)s);
  81 QapiDeallocVisitor *md;
  82 Visitor *v;
  83 ''',
  84                      obj=obj)
  85     pop_indent()
  86
  87     return ret.rstrip()
  88
  89 def gen_visitor_input_vars_decl(args):
  90     ret = ""
  91     push_indent()
  92     for argname, argtype, optional in parse_args(args):
  93         if optional:
  94             ret += mcgen('''
  95 bool has_%(argname)s = false;
  96 ''',
  97                          argname=c_name(argname))
  98         if is_c_ptr(argtype):
  99             ret += mcgen('''
 100 %(argtype)s %(argname)s = NULL;
 101 ''',
 102                          argname=c_name(argname), argtype=c_type(argtype))
 103         else:
 104             ret += mcgen('''
 105 %(argtype)s %(argname)s = {0};
 106 ''',
 107                          argname=c_name(argname), argtype=c_type(argtype))
 108
 109     pop_indent()
 110     return ret.rstrip()
 111
 112 def gen_visitor_input_block(args, dealloc=False):
 113     ret = ""
 114     errparg = '&local_err'
 115     errarg = 'local_err'
 116
 117     if len(args) == 0:
 118         return ret
 119
 120     push_indent()
 121
 122     if dealloc:
 123         errparg = 'NULL'
 124         errarg = None;
 125         ret += mcgen('''
 126 qmp_input_visitor_cleanup(mi);
 127 md = qapi_dealloc_visitor_new();
 128 v = qapi_dealloc_get_visitor(md);
 129 ''')
 130     else:
 131         ret += mcgen('''
 132 v = qmp_input_get_visitor(mi);
 133 ''')
 134
 135     for argname, argtype, optional in parse_args(args):
 136         if optional:
 137             ret += mcgen('''
 138 visit_optional(v, &has_%(c_name)s, "%(name)s", %(errp)s);
 139 ''',
 140                          c_name=c_name(argname), name=argname, errp=errparg)
 141             ret += gen_err_check(errarg)
 142             ret += mcgen('''
 143 if (has_%(c_name)s) {
 144 ''',
 145                          c_name=c_name(argname))
 146             push_indent()
 147         ret += mcgen('''
 148 visit_type_%(visitor)s(v, &%(c_name)s, "%(name)s", %(errp)s);
 149 ''',
 150                      c_name=c_name(argname), name=argname, argtype=argtype,
 151                      visitor=type_name(argtype), errp=errparg)
 152         ret += gen_err_check(errarg)
 153         if optional:
 154             pop_indent()
 155             ret += mcgen('''
 156 }
 157 ''')
 158
 159     if dealloc:
 160         ret += mcgen('''
 161 qapi_dealloc_visitor_cleanup(md);
 162 ''')
 163     pop_indent()
 164     return ret.rstrip()
 165
 166 def gen_marshal_output(name, args, ret_type, middle_mode):
 167     if not ret_type:
 168         return ""
 169
 170     ret = mcgen('''
 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=c_type(ret_type), c_name=c_name(name),
 195                 visitor=type_name(ret_type))
 196
 197     return ret
 198
 199 def gen_marshal_input_decl(name, args, ret_type, middle_mode):
 200     if middle_mode:
 201         return 'int qmp_marshal_input_%s(Monitor *mon, const QDict *qdict, QObject **ret)' % c_name(name)
 202     else:
 203         return 'static void qmp_marshal_input_%s(QDict *args, QObject **ret, Error **errp)' % c_name(name)
 204
 205
 206
 207 def gen_marshal_input(name, args, ret_type, middle_mode):
 208     hdr = gen_marshal_input_decl(name, args, ret_type, middle_mode)
 209
 210     ret = mcgen('''
 211 %(header)s
 212 {
 213     Error *local_err = NULL;
 214 ''',
 215                 header=hdr)
 216
 217     if middle_mode:
 218         ret += mcgen('''
 219     QDict *args = (QDict *)qdict;
 220 ''')
 221
 222     if ret_type:
 223         if is_c_ptr(ret_type):
 224             retval = "    %s retval = NULL;" % c_type(ret_type)
 225         else:
 226             retval = "    %s retval;" % c_type(ret_type)
 227         ret += mcgen('''
 228 %(retval)s
 229 ''',
 230                      retval=retval)
 231
 232     if len(args) > 0:
 233         ret += mcgen('''
 234 %(visitor_input_containers_decl)s
 235 %(visitor_input_vars_decl)s
 236
 237 %(visitor_input_block)s
 238
 239 ''',
 240                      visitor_input_containers_decl=gen_visitor_input_containers_decl(args, "QOBJECT(args)"),
 241                      visitor_input_vars_decl=gen_visitor_input_vars_decl(args),
 242                      visitor_input_block=gen_visitor_input_block(args))
 243     else:
 244         ret += mcgen('''
 245
 246     (void)args;
 247 ''')
 248
 249     ret += mcgen('''
 250 %(sync_call)s
 251 ''',
 252                  sync_call=gen_sync_call(name, args, ret_type, indent=4))
 253     if re.search('^ *goto out\\;', ret, re.MULTILINE):
 254         ret += mcgen('''
 255
 256 out:
 257 ''')
 258     if not middle_mode:
 259         ret += mcgen('''
 260     error_propagate(errp, local_err);
 261 ''')
 262     ret += mcgen('''
 263 %(visitor_input_block_cleanup)s
 264 ''',
 265                  visitor_input_block_cleanup=gen_visitor_input_block(args,
 266                                                                      dealloc=True))
 267
 268     if middle_mode:
 269         ret += mcgen('''
 270
 271     if (local_err) {
 272         qerror_report_err(local_err);
 273         error_free(local_err);
 274         return -1;
 275     }
 276     return 0;
 277 ''')
 278     else:
 279         ret += mcgen('''
 280     return;
 281 ''')
 282
 283     ret += mcgen('''
 284 }
 285 ''')
 286
 287     return ret
 288
 289 def gen_registry(commands):
 290     registry=""
 291     push_indent()
 292     for cmd in commands:
 293         options = 'QCO_NO_OPTIONS'
 294         if not cmd.get('success-response', True):
 295             options = 'QCO_NO_SUCCESS_RESP'
 296
 297         registry += mcgen('''
 298 qmp_register_command("%(name)s", qmp_marshal_input_%(c_name)s, %(opts)s);
 299 ''',
 300                      name=cmd['command'], c_name=c_name(cmd['command']),
 301                      opts=options)
 302     pop_indent()
 303     ret = mcgen('''
 304 static void qmp_init_marshal(void)
 305 {
 306 %(registry)s
 307 }
 308
 309 qapi_init(qmp_init_marshal);
 310 ''',
 311                 registry=registry.rstrip())
 312     return ret
 313
 314 def gen_command_decl_prologue(header, guard, prefix=""):
 315     ret = mcgen('''
 316 /* THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY */
 317
 318 /*
 319  * schema-defined QAPI function prototypes
 320  *
 321  * Copyright IBM, Corp. 2011
 322  *
 323  * Authors:
 324  *  Anthony Liguori   <[email protected]>
 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 #ifndef %(guard)s
 332 #define %(guard)s
 333
 334 #include "%(prefix)sqapi-types.h"
 335 #include "qapi/qmp/qdict.h"
 336 #include "qapi/error.h"
 337
 338 ''',
 339                  header=basename(header), guard=guardname(header), prefix=prefix)
 340     return ret
 341
 342 def gen_command_def_prologue(prefix="", proxy=False):
 343     ret = mcgen('''
 344 /* THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY */
 345
 346 /*
 347  * schema-defined QMP->QAPI command dispatch
 348  *
 349  * Copyright IBM, Corp. 2011
 350  *
 351  * Authors:
 352  *  Anthony Liguori   <[email protected]>
 353  *
 354  * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
 355  * See the COPYING.LIB file in the top-level directory.
 356  *
 357  */
 358
 359 #include "qemu-common.h"
 360 #include "qemu/module.h"
 361 #include "qapi/qmp/qerror.h"
 362 #include "qapi/qmp/types.h"
 363 #include "qapi/qmp/dispatch.h"
 364 #include "qapi/visitor.h"
 365 #include "qapi/qmp-output-visitor.h"
 366 #include "qapi/qmp-input-visitor.h"
 367 #include "qapi/dealloc-visitor.h"
 368 #include "%(prefix)sqapi-types.h"
 369 #include "%(prefix)sqapi-visit.h"
 370
 371 ''',
 372                 prefix=prefix)
 373     if not proxy:
 374         ret += '#include "%sqmp-commands.h"' % prefix
 375     return ret + "\n\n"
 376
 377 c_file = 'qmp-marshal.c'
 378 h_file = 'qmp-commands.h'
 379 middle_mode = False
 380
 381 (input_file, output_dir, do_c, do_h, prefix, opts) = \
 382     parse_command_line("m", ["middle"])
 383
 384 for o, a in opts:
 385     if o in ("-m", "--middle"):
 386         middle_mode = True
 387
 388 c_file = output_dir + prefix + c_file
 389 h_file = output_dir + prefix + h_file
 390
 391 def maybe_open(really, name, opt):
 392     if really:
 393         return open(name, opt)
 394     else:
 395         import StringIO
 396         return StringIO.StringIO()
 397
 398 try:
 399     os.makedirs(output_dir)
 400 except os.error, e:
 401     if e.errno != errno.EEXIST:
 402         raise
 403
 404 exprs = parse_schema(input_file)
 405 commands = filter(lambda expr: expr.has_key('command'), exprs)
 406 commands = filter(lambda expr: not expr.has_key('gen'), commands)
 407
 408 fdecl = maybe_open(do_h, h_file, 'w')
 409 fdef = maybe_open(do_c, c_file, 'w')
 410 ret = gen_command_decl_prologue(header=basename(h_file), guard=guardname(h_file), prefix=prefix)
 411 fdecl.write(ret)
 412 ret = gen_command_def_prologue(prefix=prefix)
 413 fdef.write(ret)
 414
 415 for cmd in commands:
 416     arglist = []
 417     ret_type = None
 418     if cmd.has_key('data'):
 419         arglist = cmd['data']
 420     if cmd.has_key('returns'):
 421         ret_type = cmd['returns']
 422     ret = generate_command_decl(cmd['command'], arglist, ret_type) + "\n"
 423     fdecl.write(ret)
 424     if ret_type:
 425         ret = gen_marshal_output(cmd['command'], arglist, ret_type, middle_mode) + "\n"
 426         fdef.write(ret)
 427
 428     if middle_mode:
 429         fdecl.write('%s;\n' % gen_marshal_input_decl(cmd['command'], arglist, ret_type, middle_mode))
 430
 431     ret = gen_marshal_input(cmd['command'], arglist, ret_type, middle_mode) + "\n"
 432     fdef.write(ret)
 433
 434 fdecl.write("\n#endif\n");
 435
 436 if not middle_mode:
 437     ret = gen_registry(commands)
 438     fdef.write(ret)
 439
 440 fdef.flush()
 441 fdef.close()
 442 fdecl.flush()
 443 fdecl.close()