scripts/qapi-commands.py

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